Class: Google::Apis::PeopleV1::Person

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

Overview

Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with metadata.primary set to true.

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.



180
181
182
 
# File 'generated/google/apis/people_v1/classes.rb', line 180

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

Instance Attribute Details

#addresses ⇒ Array<Google::Apis::PeopleV1::Address>

The person's street addresses. Corresponds to the JSON property addresses

Returns:



98
99
100
 
# File 'generated/google/apis/people_v1/classes.rb', line 98

def addresses
  @addresses
end

#age_range ⇒ String

The person's age range. Corresponds to the JSON property ageRange

Returns:

  • (String) 


83
84
85
 
# File 'generated/google/apis/people_v1/classes.rb', line 83

def age_range
  @age_range
end

#biographies ⇒ Array<Google::Apis::PeopleV1::Biography>

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

Returns:



128
129
130
 
# File 'generated/google/apis/people_v1/classes.rb', line 128

def biographies
  @biographies
end

#birthdays ⇒ Array<Google::Apis::PeopleV1::Birthday>

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

Returns:



88
89
90
 
# File 'generated/google/apis/people_v1/classes.rb', line 88

def birthdays
  @birthdays
end

#bragging_rights ⇒ Array<Google::Apis::PeopleV1::BraggingRights>

The person's bragging rights. Corresponds to the JSON property braggingRights

Returns:



158
159
160
 
# File 'generated/google/apis/people_v1/classes.rb', line 158

def bragging_rights
  @bragging_rights
end

#cover_photos ⇒ Array<Google::Apis::PeopleV1::CoverPhoto>

The person's cover photos. Corresponds to the JSON property coverPhotos

Returns:



68
69
70
 
# File 'generated/google/apis/people_v1/classes.rb', line 68

def cover_photos
  @cover_photos
end

#email_addresses ⇒ Array<Google::Apis::PeopleV1::EmailAddress>

The person's email addresses. Corresponds to the JSON property emailAddresses

Returns:



108
109
110
 
# File 'generated/google/apis/people_v1/classes.rb', line 108

def email_addresses
  @email_addresses
end

#etag ⇒ String

The HTTP entity tag of the resource. Used for web cache validation. Corresponds to the JSON property etag

Returns:

  • (String) 


43
44
45
 
# File 'generated/google/apis/people_v1/classes.rb', line 43

def etag
  @etag
end

#events ⇒ Array<Google::Apis::PeopleV1::Event>

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

Returns:



93
94
95
 
# File 'generated/google/apis/people_v1/classes.rb', line 93

def events
  @events
end

#genders ⇒ Array<Google::Apis::PeopleV1::Gender>

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

Returns:



78
79
80
 
# File 'generated/google/apis/people_v1/classes.rb', line 78

def genders
  @genders
end

#im_clients ⇒ Array<Google::Apis::PeopleV1::ImClient>

The person's instant messaging clients. Corresponds to the JSON property imClients

Returns:



118
119
120
 
# File 'generated/google/apis/people_v1/classes.rb', line 118

def im_clients
  @im_clients
end

#interests ⇒ Array<Google::Apis::PeopleV1::Interest>

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

Returns:



148
149
150
 
# File 'generated/google/apis/people_v1/classes.rb', line 148

def interests
  @interests
end

#locales ⇒ Array<Google::Apis::PeopleV1::Locale>

The person's locale preferences. Corresponds to the JSON property locales

Returns:



53
54
55
 
# File 'generated/google/apis/people_v1/classes.rb', line 53

def locales
  @locales
end

#memberships ⇒ Array<Google::Apis::PeopleV1::Membership>

The person's group memberships. Corresponds to the JSON property memberships

Returns:



178
179
180
 
# File 'generated/google/apis/people_v1/classes.rb', line 178

def memberships
  @memberships
end

#metadata ⇒ Google::Apis::PeopleV1::PersonMetadata

Metadata about a person. Corresponds to the JSON property metadata

Returns:



48
49
50
 
# File 'generated/google/apis/people_v1/classes.rb', line 48

def metadata
  @metadata
end

#names ⇒ Array<Google::Apis::PeopleV1::Name>

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

Returns:



58
59
60
 
# File 'generated/google/apis/people_v1/classes.rb', line 58

def names
  @names
end

#nicknames ⇒ Array<Google::Apis::PeopleV1::Nickname>

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

Returns:



63
64
65
 
# File 'generated/google/apis/people_v1/classes.rb', line 63

def nicknames
  @nicknames
end

#occupations ⇒ Array<Google::Apis::PeopleV1::Occupation>

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

Returns:



143
144
145
 
# File 'generated/google/apis/people_v1/classes.rb', line 143

def occupations
  @occupations
end

#organizations ⇒ Array<Google::Apis::PeopleV1::Organization>

The person's past or current organizations. Corresponds to the JSON property organizations

Returns:



138
139
140
 
# File 'generated/google/apis/people_v1/classes.rb', line 138

def organizations
  @organizations
end

#phone_numbers ⇒ Array<Google::Apis::PeopleV1::PhoneNumber>

The person's phone numbers. Corresponds to the JSON property phoneNumbers

Returns:



113
114
115
 
# File 'generated/google/apis/people_v1/classes.rb', line 113

def phone_numbers
  @phone_numbers
end

#photos ⇒ Array<Google::Apis::PeopleV1::Photo>

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

Returns:



73
74
75
 
# File 'generated/google/apis/people_v1/classes.rb', line 73

def photos
  @photos
end

#relations ⇒ Array<Google::Apis::PeopleV1::Relation>

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

Returns:



163
164
165
 
# File 'generated/google/apis/people_v1/classes.rb', line 163

def relations
  @relations
end

#relationship_interests ⇒ Array<Google::Apis::PeopleV1::RelationshipInterest>

The kind of relationship the person is looking for. Corresponds to the JSON property relationshipInterests

Returns:



168
169
170
 
# File 'generated/google/apis/people_v1/classes.rb', line 168

def relationship_interests
  @relationship_interests
end

#relationship_statuses ⇒ Array<Google::Apis::PeopleV1::RelationshipStatus>

The person's relationship statuses. Corresponds to the JSON property relationshipStatuses

Returns:



173
174
175
 
# File 'generated/google/apis/people_v1/classes.rb', line 173

def relationship_statuses
  @relationship_statuses
end

#residences ⇒ Array<Google::Apis::PeopleV1::Residence>

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

Returns:



103
104
105
 
# File 'generated/google/apis/people_v1/classes.rb', line 103

def residences
  @residences
end

#resource_name ⇒ String

The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters. Always starts with people/. Corresponds to the JSON property resourceName

Returns:

  • (String) 


37
38
39
 
# File 'generated/google/apis/people_v1/classes.rb', line 37

def resource_name
  @resource_name
end

#skills ⇒ Array<Google::Apis::PeopleV1::Skill>

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

Returns:



153
154
155
 
# File 'generated/google/apis/people_v1/classes.rb', line 153

def skills
  @skills
end

#taglines ⇒ Array<Google::Apis::PeopleV1::Tagline>

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

Returns:



123
124
125
 
# File 'generated/google/apis/people_v1/classes.rb', line 123

def taglines
  @taglines
end

#urls ⇒ Array<Google::Apis::PeopleV1::Url>

The person's associated URLs. Corresponds to the JSON property urls

Returns:



133
134
135
 
# File 'generated/google/apis/people_v1/classes.rb', line 133

def urls
  @urls
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'generated/google/apis/people_v1/classes.rb', line 185

def update!(**args)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @etag = args[:etag] if args.key?(:etag)
  @metadata = args[:metadata] if args.key?(:metadata)
  @locales = args[:locales] if args.key?(:locales)
  @names = args[:names] if args.key?(:names)
  @nicknames = args[:nicknames] if args.key?(:nicknames)
  @cover_photos = args[:cover_photos] if args.key?(:cover_photos)
  @photos = args[:photos] if args.key?(:photos)
  @genders = args[:genders] if args.key?(:genders)
  @age_range = args[:age_range] if args.key?(:age_range)
  @birthdays = args[:birthdays] if args.key?(:birthdays)
  @events = args[:events] if args.key?(:events)
  @addresses = args[:addresses] if args.key?(:addresses)
  @residences = args[:residences] if args.key?(:residences)
  @email_addresses = args[:email_addresses] if args.key?(:email_addresses)
  @phone_numbers = args[:phone_numbers] if args.key?(:phone_numbers)
  @im_clients = args[:im_clients] if args.key?(:im_clients)
  @taglines = args[:taglines] if args.key?(:taglines)
  @biographies = args[:biographies] if args.key?(:biographies)
  @urls = args[:urls] if args.key?(:urls)
  @organizations = args[:organizations] if args.key?(:organizations)
  @occupations = args[:occupations] if args.key?(:occupations)
  @interests = args[:interests] if args.key?(:interests)
  @skills = args[:skills] if args.key?(:skills)
  @bragging_rights = args[:bragging_rights] if args.key?(:bragging_rights)
  @relations = args[:relations] if args.key?(:relations)
  @relationship_interests = args[:relationship_interests] if args.key?(:relationship_interests)
  @relationship_statuses = args[:relationship_statuses] if args.key?(:relationship_statuses)
  @memberships = args[:memberships] if args.key?(:memberships)
end