Class: Google::Apis::PlusDomainsV1::Person

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/plus_domains_v1/classes.rb,
generated/google/apis/plus_domains_v1/representations.rb,
generated/google/apis/plus_domains_v1/representations.rb

Defined Under Namespace

Classes: Cover, Email, Image, Name, Organization, PlacesLived, Url

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Person

Returns a new instance of Person



2075
2076
2077
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2075

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#about_me ⇒ String

A short biography for this person. Corresponds to the JSON property aboutMe

Returns:

  • (String) 


1912
1913
1914
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1912

def about_me
  @about_me
end

#birthday ⇒ String

The person's date of birth, represented as YYYY-MM-DD. Corresponds to the JSON property birthday

Returns:

  • (String) 


1917
1918
1919
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1917

def birthday
  @birthday
end

#bragging_rights ⇒ String

The "bragging rights" line of this person. Corresponds to the JSON property braggingRights

Returns:

  • (String) 


1922
1923
1924
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1922

def bragging_rights
  @bragging_rights
end

#circled_by_count ⇒ Fixnum

For followers who are visible, the number of people who have added this person or page to a circle. Corresponds to the JSON property circledByCount

Returns:

  • (Fixnum) 


1928
1929
1930
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1928

def circled_by_count
  @circled_by_count
end

#cover ⇒ Google::Apis::PlusDomainsV1::Person::Cover

The cover photo content. Corresponds to the JSON property cover

Returns:



1933
1934
1935
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1933

def cover
  @cover
end

#current_location ⇒ String

(this field is not currently used) Corresponds to the JSON property currentLocation

Returns:

  • (String) 


1938
1939
1940
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1938

def current_location
  @current_location
end

#display_name ⇒ String

The name of this person, which is suitable for display. Corresponds to the JSON property displayName

Returns:

  • (String) 


1943
1944
1945
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1943

def display_name
  @display_name
end

#domain ⇒ String

The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name. Corresponds to the JSON property domain

Returns:

  • (String) 


1950
1951
1952
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1950

def domain
  @domain
end

#emails ⇒ Array<Google::Apis::PlusDomainsV1::Person::Email>

A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address. Corresponds to the JSON property emails

Returns:



1959
1960
1961
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1959

def emails
  @emails
end

#etag ⇒ String

ETag of this response for caching purposes. Corresponds to the JSON property etag

Returns:

  • (String) 


1964
1965
1966
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1964

def etag
  @etag
end

#gender ⇒ String

The person's gender. Possible values include, but are not limited to, the following values:

  • "male" - Male gender.
  • "female" - Female gender.
  • "other" - Other. Corresponds to the JSON property gender

Returns:

  • (String) 


1973
1974
1975
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1973

def gender
  @gender
end

#id ⇒ String

The ID of this person. Corresponds to the JSON property id

Returns:

  • (String) 


1978
1979
1980
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1978

def id
  @id
end

#image ⇒ Google::Apis::PlusDomainsV1::Person::Image

The representation of the person's profile photo. Corresponds to the JSON property image

Returns:



1983
1984
1985
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1983

def image
  @image
end

#is_plus_user ⇒ Boolean Also known as: is_plus_user?

Whether this user has signed up for Google+. Corresponds to the JSON property isPlusUser

Returns:

  • (Boolean) 


1988
1989
1990
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1988

def is_plus_user
  @is_plus_user
end

#kind ⇒ String

Identifies this resource as a person. Value: "plus#person". Corresponds to the JSON property kind

Returns:

  • (String) 


1994
1995
1996
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1994

def kind
  @kind
end

#name ⇒ Google::Apis::PlusDomainsV1::Person::Name

An object representation of the individual components of a person's name. Corresponds to the JSON property name

Returns:



1999
2000
2001
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 1999

def name
  @name
end

#nickname ⇒ String

The nickname of this person. Corresponds to the JSON property nickname

Returns:

  • (String) 


2004
2005
2006
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2004

def nickname
  @nickname
end

#object_type ⇒ String

Type of person within Google+. Possible values include, but are not limited to, the following values:

  • "person" - represents an actual person.
  • "page" - represents a page. Corresponds to the JSON property objectType

Returns:

  • (String) 


2012
2013
2014
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2012

def object_type
  @object_type
end

#occupation ⇒ String

The occupation of this person. Corresponds to the JSON property occupation

Returns:

  • (String) 


2017
2018
2019
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2017

def occupation
  @occupation
end

#organizations ⇒ Array<Google::Apis::PlusDomainsV1::Person::Organization>

A list of current or past organizations with which this person is associated. Corresponds to the JSON property organizations

Returns:



2022
2023
2024
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2022

def organizations
  @organizations
end

#places_lived ⇒ Array<Google::Apis::PlusDomainsV1::Person::PlacesLived>

A list of places where this person has lived. Corresponds to the JSON property placesLived

Returns:



2027
2028
2029
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2027

def places_lived
  @places_lived
end

#plus_one_count ⇒ Fixnum

If a Google+ Page, the number of people who have +1'd this page. Corresponds to the JSON property plusOneCount

Returns:

  • (Fixnum) 


2032
2033
2034
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2032

def plus_one_count
  @plus_one_count
end

#relationship_status ⇒ String

The person's relationship status. Possible values include, but are not limited to, the following values:

  • "single" - Person is single.
  • "in_a_relationship" - Person is in a relationship.
  • "engaged" - Person is engaged.
  • "married" - Person is married.
  • "its_complicated" - The relationship is complicated.
  • "open_relationship" - Person is in an open relationship.
  • "widowed" - Person is widowed.
  • "in_domestic_partnership" - Person is in a domestic partnership.
  • "in_civil_union" - Person is in a civil union. Corresponds to the JSON property relationshipStatus

Returns:

  • (String) 


2047
2048
2049
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2047

def relationship_status
  @relationship_status
end

#skills ⇒ String

The person's skills. Corresponds to the JSON property skills

Returns:

  • (String) 


2052
2053
2054
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2052

def skills
  @skills
end

#tagline ⇒ String

The brief description (tagline) of this person. Corresponds to the JSON property tagline

Returns:

  • (String) 


2057
2058
2059
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2057

def tagline
  @tagline
end

#url ⇒ String

The URL of this person's profile. Corresponds to the JSON property url

Returns:

  • (String) 


2062
2063
2064
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2062

def url
  @url
end

#urls ⇒ Array<Google::Apis::PlusDomainsV1::Person::Url>

A list of URLs for this person. Corresponds to the JSON property urls

Returns:



2067
2068
2069
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2067

def urls
  @urls
end

#verified ⇒ Boolean Also known as: verified?

Whether the person or Google+ Page has been verified. Corresponds to the JSON property verified

Returns:

  • (Boolean) 


2072
2073
2074
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2072

def verified
  @verified
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
 
# File 'generated/google/apis/plus_domains_v1/classes.rb', line 2080

def update!(**args)
  @about_me = args[:about_me] if args.key?(:about_me)
  @birthday = args[:birthday] if args.key?(:birthday)
  @bragging_rights = args[:bragging_rights] if args.key?(:bragging_rights)
  @circled_by_count = args[:circled_by_count] if args.key?(:circled_by_count)
  @cover = args[:cover] if args.key?(:cover)
  @current_location = args[:current_location] if args.key?(:current_location)
  @display_name = args[:display_name] if args.key?(:display_name)
  @domain = args[:domain] if args.key?(:domain)
  @emails = args[:emails] if args.key?(:emails)
  @etag = args[:etag] if args.key?(:etag)
  @gender = args[:gender] if args.key?(:gender)
  @id = args[:id] if args.key?(:id)
  @image = args[:image] if args.key?(:image)
  @is_plus_user = args[:is_plus_user] if args.key?(:is_plus_user)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @nickname = args[:nickname] if args.key?(:nickname)
  @object_type = args[:object_type] if args.key?(:object_type)
  @occupation = args[:occupation] if args.key?(:occupation)
  @organizations = args[:organizations] if args.key?(:organizations)
  @places_lived = args[:places_lived] if args.key?(:places_lived)
  @plus_one_count = args[:plus_one_count] if args.key?(:plus_one_count)
  @relationship_status = args[:relationship_status] if args.key?(:relationship_status)
  @skills = args[:skills] if args.key?(:skills)
  @tagline = args[:tagline] if args.key?(:tagline)
  @url = args[:url] if args.key?(:url)
  @urls = args[:urls] if args.key?(:urls)
  @verified = args[:verified] if args.key?(:verified)
end