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



288
289
290
 
# File 'generated/google/apis/people_v1/classes.rb', line 288

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) 


272
273
274
 
# File 'generated/google/apis/people_v1/classes.rb', line 272

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) 


267
268
269
 
# File 'generated/google/apis/people_v1/classes.rb', line 267

def formatted_type
  @formatted_type
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



286
287
288
 
# File 'generated/google/apis/people_v1/classes.rb', line 286

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) 


281
282
283
 
# File 'generated/google/apis/people_v1/classes.rb', line 281

def type
  @type
end

#value ⇒ String

The email address. Corresponds to the JSON property value

Returns:

  • (String) 


261
262
263
 
# File 'generated/google/apis/people_v1/classes.rb', line 261

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



293
294
295
296
297
298
299
 
# File 'generated/google/apis/people_v1/classes.rb', line 293

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