Class: Google::Apis::PeopleV1::PhoneNumber

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

A person's phone number.

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) ⇒ PhoneNumber

Returns a new instance of PhoneNumber



1712
1713
1714
 
# File 'generated/google/apis/people_v1/classes.rb', line 1712

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

Instance Attribute Details

#canonical_form ⇒ String

The read-only canonicalized ITU-T E.164 form of the phone number. Corresponds to the JSON property canonicalForm

Returns:

  • (String) 


1676
1677
1678
 
# File 'generated/google/apis/people_v1/classes.rb', line 1676

def canonical_form
  @canonical_form
end

#formatted_type ⇒ String

The read-only type of the phone number translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale. Corresponds to the JSON property formattedType

Returns:

  • (String) 


1682
1683
1684
 
# File 'generated/google/apis/people_v1/classes.rb', line 1682

def formatted_type
  @formatted_type
end

#metadata ⇒ Google::Apis::PeopleV1::FieldMetadata

Metadata about a field. Corresponds to the JSON property metadata

Returns:



1687
1688
1689
 
# File 'generated/google/apis/people_v1/classes.rb', line 1687

def metadata
  @metadata
end

#type ⇒ String

The type of the phone number. The type can be custom or predefined. Possible values include, but are not limited to, the following:

  • home
  • work
  • mobile
  • homeFax
  • workFax
  • otherFax
  • pager
  • workMobile
  • workPager
  • main
  • googleVoice
  • other Corresponds to the JSON property type

Returns:

  • (String) 


1705
1706
1707
 
# File 'generated/google/apis/people_v1/classes.rb', line 1705

def type
  @type
end

#value ⇒ String

The phone number. Corresponds to the JSON property value

Returns:

  • (String) 


1710
1711
1712
 
# File 'generated/google/apis/people_v1/classes.rb', line 1710

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1717
1718
1719
1720
1721
1722
1723
 
# File 'generated/google/apis/people_v1/classes.rb', line 1717

def update!(**args)
  @canonical_form = args[:canonical_form] if args.key?(:canonical_form)
  @formatted_type = args[:formatted_type] if args.key?(:formatted_type)
  @metadata = args[:metadata] if args.key?(:metadata)
  @type = args[:type] if args.key?(:type)
  @value = args[:value] if args.key?(:value)
end