Class: Google::Apis::PeopleV1::EmailAddress

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 email address.

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

Returns a new instance of EmailAddress



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

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

Instance Attribute Details

#display_name ⇒ String

The display name of the email. Corresponds to the JSON property displayName

Returns:

  • (String) 


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

def display_name
  @display_name
end

#formatted_type ⇒ String

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

Returns:

  • (String) 


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

def formatted_type
  @formatted_type
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



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

def metadata
  @metadata
end

#type ⇒ String

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

  • home
  • work
  • other Corresponds to the JSON property type

Returns:

  • (String) 


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

def type
  @type
end

#value ⇒ String

The email address. Corresponds to the JSON property value

Returns:

  • (String) 


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

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @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