Class: DiasporaFederation::Entities::StatusMessage

Inherits:

DiasporaFederation::Entity

• Object
• DiasporaFederation::Entity
• DiasporaFederation::Entities::StatusMessage

Includes:

Post

Defined in:

lib/diaspora_federation/entities/status_message.rb

Overview

This entity represents a status message sent by a user.

See Also:

• Validators::StatusMessageValidator

Constant Summary

Constants inherited from DiasporaFederation::Entity

DiasporaFederation::Entity::ENTITY_NAME_REGEX, DiasporaFederation::Entity::INVALID_XML_REGEX

Instance Attribute Summary

• #edited_at ⇒ Time readonly

  The timestamp when the status message was edited.

• #embed ⇒ Entities::Embed readonly

  Optional embed information of an URL that should be embedded in the status message.

• #event ⇒ Entities::Event readonly

  Optional event attached to the status message.

• #location ⇒ Entities::Location readonly

  Optional location attached to the status message.

• #photos ⇒ [Entities::Photo] readonly

  Optional photos attached to the status message.

• #poll ⇒ Entities::Poll readonly

  Optional poll attached to the status message.

• #text ⇒ String readonly

  Text of the status message composed by the user.

Attributes included from Post

#author, #created_at, #guid, #provider_display_name, #public

Method Summary

Methods included from Post

included

Methods inherited from DiasporaFederation::Entity

class_name, entity_class, entity_name, from_hash, from_json, from_xml, #initialize, #to_h, #to_json, #to_s, #to_xml

Methods included from PropertiesDSL

#class_props, #default_values, #entity, #find_property_for_xml_name, #missing_props, #optional_props, #property, #resolv_aliases, #xml_names

Methods included from Logging

included

Constructor Details

This class inherits a constructor from DiasporaFederation::Entity

Instance Attribute Details

#edited_at ⇒ Time (readonly)

The timestamp when the status message was edited

Returns:

• (Time) —

  edited time

# File 'lib/diaspora_federation/entities/status_message.rb', line 17

property :edited_at, :timestamp, optional: true

#embed ⇒ Entities::Embed (readonly)

Optional embed information of an URL that should be embedded in the status message

Returns:

• (Entities::Embed) —

  embed

# File 'lib/diaspora_federation/entities/status_message.rb', line 42

entity :embed, Entities::Embed, optional: true

#event ⇒ Entities::Event (readonly)

Optional event attached to the status message

Returns:

• (Entities::Event) —

  event

# File 'lib/diaspora_federation/entities/status_message.rb', line 37

entity :event, Entities::Event, optional: true

#location ⇒ Entities::Location (readonly)

Optional location attached to the status message

Returns:

• (Entities::Location) —

  location

# File 'lib/diaspora_federation/entities/status_message.rb', line 27

entity :location, Entities::Location, optional: true

#photos ⇒ [Entities::Photo] (readonly)

Optional photos attached to the status message

Returns:

• ([Entities::Photo]) —

  photos

# File 'lib/diaspora_federation/entities/status_message.rb', line 22

entity :photos, [Entities::Photo], optional: true, default: []

#poll ⇒ Entities::Poll (readonly)

Optional poll attached to the status message

Returns:

• (Entities::Poll) —

  poll

# File 'lib/diaspora_federation/entities/status_message.rb', line 32

entity :poll, Entities::Poll, optional: true

#text ⇒ String (readonly)

Text of the status message composed by the user

Returns:

• (String) —

  text of the status message

# File 'lib/diaspora_federation/entities/status_message.rb', line 12

property :text, :string, xml_name: :raw_message