Class: Google::Apis::PeopleV1::SipAddress

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 SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

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

Returns a new instance of SipAddress



1936
1937
1938
 
# File 'generated/google/apis/people_v1/classes.rb', line 1936

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

Instance Attribute Details

#formatted_type ⇒ String

The read-only type of the SIP 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) 


1912
1913
1914
 
# File 'generated/google/apis/people_v1/classes.rb', line 1912

def formatted_type
  @formatted_type
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



1917
1918
1919
 
# File 'generated/google/apis/people_v1/classes.rb', line 1917

def metadata
  @metadata
end

#type ⇒ String

The type of the SIP address. The type can be custom or or one of these predefined values:

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

Returns:

  • (String) 


1927
1928
1929
 
# File 'generated/google/apis/people_v1/classes.rb', line 1927

def type
  @type
end

#value ⇒ String

The SIP address in the RFC 3261 19.1 SIP URI format. Corresponds to the JSON property value

Returns:

  • (String) 


1934
1935
1936
 
# File 'generated/google/apis/people_v1/classes.rb', line 1934

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1941
1942
1943
1944
1945
1946
 
# File 'generated/google/apis/people_v1/classes.rb', line 1941

def update!(**args)
  @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