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. NEXT_ID: 31

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



622
623
624
 
# File 'generated/google/apis/people_v1/classes.rb', line 622

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:



570
571
572
 
# File 'generated/google/apis/people_v1/classes.rb', line 570

def addresses
  @addresses
end

#age_range ⇒ String

DEPRECATED(Please read person.age_ranges instead). The person's age range. Corresponds to the JSON property ageRange

Returns:

  • (String) 


555
556
557
 
# File 'generated/google/apis/people_v1/classes.rb', line 555

def age_range
  @age_range
end

#age_ranges ⇒ Array<Google::Apis::PeopleV1::AgeRangeType>

The person's age ranges. Corresponds to the JSON property ageRanges

Returns:



565
566
567
 
# File 'generated/google/apis/people_v1/classes.rb', line 565

def age_ranges
  @age_ranges
end

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

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

Returns:



535
536
537
 
# File 'generated/google/apis/people_v1/classes.rb', line 535

def biographies
  @biographies
end

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

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

Returns:



600
601
602
 
# File 'generated/google/apis/people_v1/classes.rb', line 600

def birthdays
  @birthdays
end

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

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

Returns:



504
505
506
 
# File 'generated/google/apis/people_v1/classes.rb', line 504

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:



590
591
592
 
# File 'generated/google/apis/people_v1/classes.rb', line 590

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:



488
489
490
 
# File 'generated/google/apis/people_v1/classes.rb', line 488

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) 


499
500
501
 
# File 'generated/google/apis/people_v1/classes.rb', line 499

def etag
  @etag
end

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

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

Returns:



575
576
577
 
# File 'generated/google/apis/people_v1/classes.rb', line 575

def events
  @events
end

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

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

Returns:



519
520
521
 
# File 'generated/google/apis/people_v1/classes.rb', line 519

def genders
  @genders
end

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

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

Returns:



595
596
597
 
# File 'generated/google/apis/people_v1/classes.rb', line 595

def im_clients
  @im_clients
end

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

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

Returns:



530
531
532
 
# File 'generated/google/apis/people_v1/classes.rb', line 530

def interests
  @interests
end

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

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

Returns:



605
606
607
 
# File 'generated/google/apis/people_v1/classes.rb', line 605

def locales
  @locales
end

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

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

Returns:



580
581
582
 
# File 'generated/google/apis/people_v1/classes.rb', line 580

def memberships
  @memberships
end

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

The read-only metadata about a person. Corresponds to the JSON property metadata

Returns:



509
510
511
 
# File 'generated/google/apis/people_v1/classes.rb', line 509

def metadata
  @metadata
end

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

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

Returns:



478
479
480
 
# File 'generated/google/apis/people_v1/classes.rb', line 478

def names
  @names
end

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

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

Returns:



620
621
622
 
# File 'generated/google/apis/people_v1/classes.rb', line 620

def nicknames
  @nicknames
end

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

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

Returns:



483
484
485
 
# File 'generated/google/apis/people_v1/classes.rb', line 483

def occupations
  @occupations
end

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

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

Returns:



493
494
495
 
# File 'generated/google/apis/people_v1/classes.rb', line 493

def organizations
  @organizations
end

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

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

Returns:



585
586
587
 
# File 'generated/google/apis/people_v1/classes.rb', line 585

def phone_numbers
  @phone_numbers
end

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

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

Returns:



550
551
552
 
# File 'generated/google/apis/people_v1/classes.rb', line 550

def photos
  @photos
end

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

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

Returns:



473
474
475
 
# File 'generated/google/apis/people_v1/classes.rb', line 473

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:



610
611
612
 
# File 'generated/google/apis/people_v1/classes.rb', line 610

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:



545
546
547
 
# File 'generated/google/apis/people_v1/classes.rb', line 545

def relationship_statuses
  @relationship_statuses
end

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

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

Returns:



514
515
516
 
# File 'generated/google/apis/people_v1/classes.rb', line 514

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) 


525
526
527
 
# File 'generated/google/apis/people_v1/classes.rb', line 525

def resource_name
  @resource_name
end

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

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

Returns:



540
541
542
 
# File 'generated/google/apis/people_v1/classes.rb', line 540

def skills
  @skills
end

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

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

Returns:



560
561
562
 
# File 'generated/google/apis/people_v1/classes.rb', line 560

def taglines
  @taglines
end

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

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

Returns:



615
616
617
 
# File 'generated/google/apis/people_v1/classes.rb', line 615

def urls
  @urls
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'generated/google/apis/people_v1/classes.rb', line 627

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