Class: DiasporaFederation::Entities::Location

Inherits:

DiasporaFederation::Entity

• Object
• DiasporaFederation::Entity
• DiasporaFederation::Entities::Location

Defined in:

lib/diaspora_federation/entities/location.rb

Overview

This entity is used to specify location data and used embedded in a status message.

See Also:

• Validators::LocationValidator

Constant Summary

Constants inherited from DiasporaFederation::Entity

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

Instance Attribute Summary

• #address ⇒ String readonly

  A string describing your location, e.g.

• #lat ⇒ String readonly

  Geographical latitude of your location.

• #lng ⇒ String readonly

  Geographical longitude of your location.

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

#address ⇒ String (readonly)

A string describing your location, e.g. a city name, a street name, etc

Returns:

• (String) —

  address

# File 'lib/diaspora_federation/entities/location.rb', line 10

property :address, :string

#lat ⇒ String (readonly)

Geographical latitude of your location

Returns:

• (String) —

  latitude

# File 'lib/diaspora_federation/entities/location.rb', line 15

property :lat, :string

#lng ⇒ String (readonly)

Geographical longitude of your location

Returns:

• (String) —

  longitude

# File 'lib/diaspora_federation/entities/location.rb', line 20

property :lng, :string