Class: DiasporaFederation::Entities::Profile

Inherits:

DiasporaFederation::Entity

• Object
• DiasporaFederation::Entity
• DiasporaFederation::Entities::Profile

Defined in:

lib/diaspora_federation/entities/profile.rb

Overview

This entity contains all the profile data of a person.

See Also:

• Validators::ProfileValidator

Constant Summary

Constants inherited from DiasporaFederation::Entity

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

Instance Attribute Summary

• #author ⇒ String readonly

  The diaspora* ID of the person.

• #bio ⇒ String readonly

  Bio of the person.

• #diaspora_id ⇒ String readonly

  Alias for author.

• #edited_at ⇒ Time readonly

  The timestamp when the profile was edited.

• #first_name ⇒ String readonly deprecated Deprecated.

  We decided to only use one name field, these should be removed in later iterations (will affect older diaspora* installations).

• #full_name ⇒ String readonly

  Display name of the user.

• #image_url ⇒ String readonly

  Url to the big avatar (300x300).

• #image_url_medium ⇒ String readonly

  Url to the medium avatar (100x100).

• #image_url_small ⇒ String readonly

  Url to the small avatar (50x50).

• #last_name ⇒ String readonly deprecated Deprecated.

  We decided to only use one name field, these should be removed in later iterations (will affect older diaspora* installations).

• #public ⇒ Boolean readonly

  Shows whether the profile is visible to everyone or only to contacts.

• #searchable ⇒ Boolean readonly

  Searchable flag.

Instance Method Summary

• #to_s ⇒ String

  String representation of this object.

Methods inherited from DiasporaFederation::Entity

class_name, entity_class, entity_name, from_hash, from_json, from_xml, #initialize, #to_h, #to_json, #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

#author ⇒ String (readonly)

The diaspora* ID of the person

Returns:

• (String) —

  diaspora* ID

See Also:

• DiasporaFederation::Entities::Person#author

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

property :author, :string, alias: :diaspora_id

#bio ⇒ String (readonly)

Returns bio of the person.

Returns:

• (String) —

  bio of the person

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

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

#diaspora_id ⇒ String (readonly)

Alias for author

Returns:

• (String) —

  diaspora* ID

See Also:

• #author

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

property :author, :string, alias: :diaspora_id

#edited_at ⇒ Time (readonly)

The timestamp when the profile was edited

Returns:

• (Time) —

  edited time

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

property :edited_at, :timestamp, optional: true

#first_name ⇒ String (readonly)

Deprecated.

We decided to only use one name field, these should be removed in later iterations (will affect older diaspora* installations).

Returns first name.

Returns:

• (String) —

  first name

See Also:

• #full_name
• Discovery::HCard#first_name

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

property :first_name, :string, optional: true

#full_name ⇒ String (readonly)

Returns display name of the user.

Returns:

• (String) —

  display name of the user

# File 'lib/diaspora_federation/entities/profile.rb', line 26

property :full_name, :string, optional: true

#image_url ⇒ String (readonly)

Returns url to the big avatar (300x300).

Returns:

• (String) —

  url to the big avatar (300x300)

See Also:

• Discovery::HCard#photo_large_url

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

property :image_url, :string, optional: true

#image_url_medium ⇒ String (readonly)

Returns url to the medium avatar (100x100).

Returns:

• (String) —

  url to the medium avatar (100x100)

See Also:

• Discovery::HCard#photo_medium_url

# File 'lib/diaspora_federation/entities/profile.rb', line 51

property :image_url_medium, :string, optional: true

#image_url_small ⇒ String (readonly)

Returns url to the small avatar (50x50).

Returns:

• (String) —

  url to the small avatar (50x50)

See Also:

• Discovery::HCard#photo_small_url

# File 'lib/diaspora_federation/entities/profile.rb', line 55

property :image_url_small, :string, optional: true

#last_name ⇒ String (readonly)

Deprecated.

We decided to only use one name field, these should be removed in later iterations (will affect older diaspora* installations).

Returns last name.

Returns:

• (String) —

  last name

See Also:

• #full_name
• Discovery::HCard#last_name

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

property :last_name, :string, optional: true

#public ⇒ Boolean (readonly)

Shows whether the profile is visible to everyone or only to contacts

Returns:

• (Boolean) —

  is it public

# File 'lib/diaspora_federation/entities/profile.rb', line 73

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

#searchable ⇒ Boolean (readonly)

Returns searchable flag.

Returns:

• (Boolean) —

  searchable flag

See Also:

• Discovery::HCard#searchable

# File 'lib/diaspora_federation/entities/profile.rb', line 68

property :searchable, :boolean, optional: true, default: true

Instance Method Details

#to_s ⇒ String

Returns string representation of this object.

Returns:

• (String) —

  string representation of this object

# File 'lib/diaspora_federation/entities/profile.rb', line 79

def to_s
  "Profile:#{author}"
end