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



1992
1993
1994
 
# File 'generated/google/apis/people_v1/classes.rb', line 1992

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) 


1968
1969
1970
 
# File 'generated/google/apis/people_v1/classes.rb', line 1968

def formatted_type
  @formatted_type
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



1973
1974
1975
 
# File 'generated/google/apis/people_v1/classes.rb', line 1973

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) 


1983
1984
1985
 
# File 'generated/google/apis/people_v1/classes.rb', line 1983

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) 


1990
1991
1992
 
# File 'generated/google/apis/people_v1/classes.rb', line 1990

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1997
1998
1999
2000
2001
2002
 
# File 'generated/google/apis/people_v1/classes.rb', line 1997

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