Class: DiasporaFederation::Entities::Poll

Inherits:

DiasporaFederation::Entity

• Object
• DiasporaFederation::Entity
• DiasporaFederation::Entities::Poll

Defined in:

lib/diaspora_federation/entities/poll.rb

Overview

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

See Also:

• Validators::PollValidator

Constant Summary

Constants inherited from DiasporaFederation::Entity

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

Instance Attribute Summary

• #guid ⇒ String readonly

  A random string of at least 16 chars.

• #poll_answers ⇒ [Entities::PollAnswer] readonly

  Array of possible answers for the poll.

• #question ⇒ String readonly

  Text of the question posed by a user.

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

#guid ⇒ String (readonly)

A random string of at least 16 chars

Returns:

• (String) —

  poll guid

See Also:

• Validation::Rule::Guid

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

property :guid, :string

#poll_answers ⇒ [Entities::PollAnswer] (readonly)

Array of possible answers for the poll

Returns:

• ([Entities::PollAnswer]) —

  poll answers

# File 'lib/diaspora_federation/entities/poll.rb', line 23

entity :poll_answers, [Entities::PollAnswer]

#question ⇒ String (readonly)

Text of the question posed by a user

Returns:

• (String) —

  question

# File 'lib/diaspora_federation/entities/poll.rb', line 18

property :question, :string