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.


697
698
699
# File 'generated/google/apis/people_v1/classes.rb', line 697

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

Instance Attribute Details

#display_nameString

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

Returns:

  • (String)

673
674
675
# File 'generated/google/apis/people_v1/classes.rb', line 673

def display_name
  @display_name
end

#formatted_typeString

Output only. The 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)

679
680
681
# File 'generated/google/apis/people_v1/classes.rb', line 679

def formatted_type
  @formatted_type
end

#metadataGoogle::Apis::PeopleV1::FieldMetadata

Metadata about a field. Corresponds to the JSON property metadata


684
685
686
# File 'generated/google/apis/people_v1/classes.rb', line 684

def 
  @metadata
end

#typeString

The type of the email address. The type can be custom or one of these predefined values: * home * work * other Corresponds to the JSON property type

Returns:

  • (String)

690
691
692
# File 'generated/google/apis/people_v1/classes.rb', line 690

def type
  @type
end

#valueString

The email address. Corresponds to the JSON property value

Returns:

  • (String)

695
696
697
# File 'generated/google/apis/people_v1/classes.rb', line 695

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


702
703
704
705
706
707
708
# File 'generated/google/apis/people_v1/classes.rb', line 702

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