Class: DiasporaFederation::Entities::Event

Inherits:
DiasporaFederation::Entity show all
Defined in:
lib/diaspora_federation/entities/event.rb

Overview

This entity represents an event and it is federated as a part of a status message.

Constant Summary

Constants inherited from DiasporaFederation::Entity

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

Instance Attribute Summary collapse

Method Summary

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

#all_dayBoolean (readonly)

Points if the event is an all day event


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

property :all_day, :boolean, optional: true, default: false

#authorString (readonly)

The diaspora* ID of the person who created the event

See Also:


11
# File 'lib/diaspora_federation/entities/event.rb', line 11

property :author, :string

#descriptionString (readonly)

Description of the event


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

property :description, :string, alias: :text, optional: true

#endString (readonly)

The end time of the event


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

property :end, :timestamp, optional: true

#guidString (readonly)

A random string of at least 16 chars


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

property :guid, :string

#locationEntities::Location (readonly)

Location of the event


52
# File 'lib/diaspora_federation/entities/event.rb', line 52

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

#startString (readonly)

The start time of the event


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

property :start, :timestamp

#summaryString (readonly)

The summary of the event


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

property :summary, :string

#timezoneString (readonly)

Timezone to which the event is fixed to


47
# File 'lib/diaspora_federation/entities/event.rb', line 47

property :timezone, :string, optional: true