Class: DiasporaFederation::Entities::Event

Inherits:

DiasporaFederation::Entity

• Object
• DiasporaFederation::Entity
• DiasporaFederation::Entities::Event

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.

See Also:

• Validators::EventValidator

Constant Summary

Constants inherited from DiasporaFederation::Entity

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

Instance Attribute Summary

• #all_day ⇒ Boolean readonly

  Points if the event is an all day event.

• #author ⇒ String readonly

  The diaspora* ID of the person who created the event.

• #description ⇒ String readonly

  Description of the event.

• #edited_at ⇒ Time readonly

  The timestamp when the event was edited.

• #end ⇒ String readonly

  The end time of the event.

• #guid ⇒ String readonly

  A random string of at least 16 chars.

• #location ⇒ Entities::Location readonly

  Location of the event.

• #start ⇒ String readonly

  The start time of the event.

• #summary ⇒ String readonly

  The summary of the event.

• #timezone ⇒ String readonly

  Timezone to which the event is fixed to.

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, #missing_props, #optional_props, #property, #resolv_aliases

Methods included from Logging

included

Constructor Details

This class inherits a constructor from DiasporaFederation::Entity

Instance Attribute Details

#all_day ⇒ Boolean (readonly)

Points if the event is an all day event

Returns:

• (Boolean) —

  is it an all day event

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

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

#author ⇒ String (readonly)

The diaspora* ID of the person who created the event

Returns:

• (String) —

  author diaspora* ID

See Also:

• Person#author

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

property :author, :string

#description ⇒ String (readonly)

Description of the event

Returns:

• (String) —

  event description

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

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

#edited_at ⇒ Time (readonly)

The timestamp when the event was edited

Returns:

• (Time) —

  edited time

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

property :edited_at, :timestamp, optional: true

#end ⇒ String (readonly)

The end time of the event

Returns:

• (String) —

  event end

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

property :end, :timestamp, optional: true

#guid ⇒ String (readonly)

A random string of at least 16 chars

Returns:

• (String) —

  guid

See Also:

• Validation::Rule::Guid

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

property :guid, :string

#location ⇒ Entities::Location (readonly)

Location of the event

Returns:

• (Entities::Location) —

  location

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

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

#start ⇒ String (readonly)

The start time of the event

Returns:

• (String) —

  event start

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

property :start, :timestamp

#summary ⇒ String (readonly)

The summary of the event

Returns:

• (String) —

  event summary

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

property :summary, :string

#timezone ⇒ String (readonly)

Timezone to which the event is fixed to

Returns:

• (String) —

  timezone

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

property :timezone, :string, optional: true