diaspora_federation/lib/diaspora_federation/entities/profile.rb
2015-12-07 04:10:17 +01:00

56 lines
2 KiB
Ruby

module DiasporaFederation
module Entities
# this entity contains all the profile data of a person
#
# @see Validators::ProfileValidator
class Profile < Entity
# @!attribute [r] diaspora_id
# The diaspora ID of the person
# @see Person#diaspora_id
# @return [String] diaspora ID
property :diaspora_id, xml_name: :diaspora_handle
# @!attribute [r] first_name
# @deprecated We decided to only use one name field, these should be removed
# in later iterations (will affect older Diaspora* installations).
# @see #full_name
# @see Discovery::HCard#first_name
# @return [String] first name
property :first_name, default: nil
# @!attribute [r] last_name
# @deprecated We decided to only use one name field, these should be removed
# in later iterations (will affect older Diaspora* installations).
# @see #full_name
# @see Discovery::HCard#last_name
# @return [String] last name
property :last_name, default: nil
# @!attribute [r] image_url
# @see Discovery::HCard#photo_large_url
# @return [String] url to the big avatar (300x300)
property :image_url, default: nil
# @!attribute [r] image_url_medium
# @see Discovery::HCard#photo_medium_url
# @return [String] url to the medium avatar (100x100)
property :image_url_medium, default: nil
# @!attribute [r] image_url_small
# @see Discovery::HCard#photo_small_url
# @return [String] url to the small avatar (50x50)
property :image_url_small, default: nil
property :birthday, default: nil
property :gender, default: nil
property :bio, default: nil
property :location, default: nil
# @!attribute [r] searchable
# @see Discovery::HCard#searchable
# @return [Boolean] searchable flag
property :searchable, default: true
property :nsfw, default: false
property :tag_string, default: nil
end
end
end