Class: Google::Apis::PeopleV1::ImClient

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 instant messaging client.

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

Returns a new instance of ImClient



214
215
216
 
# File 'generated/google/apis/people_v1/classes.rb', line 214

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

Instance Attribute Details

#formatted_protocol ⇒ String

The read-only protocol of the IM client formatted in the viewer's account locale or the Accept-Language HTTP header locale. Corresponds to the JSON property formattedProtocol

Returns:

  • (String) 


206
207
208
 
# File 'generated/google/apis/people_v1/classes.rb', line 206

def formatted_protocol
  @formatted_protocol
end

#formatted_type ⇒ String

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

Returns:

  • (String) 


212
213
214
 
# File 'generated/google/apis/people_v1/classes.rb', line 212

def formatted_type
  @formatted_type
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



171
172
173
 
# File 'generated/google/apis/people_v1/classes.rb', line 171

def metadata
  @metadata
end

#protocol ⇒ String

The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, the following:

  • aim
  • msn
  • yahoo
  • skype
  • qq
  • googleTalk
  • icq
  • jabber
  • netMeeting Corresponds to the JSON property protocol

Returns:

  • (String) 


195
196
197
 
# File 'generated/google/apis/people_v1/classes.rb', line 195

def protocol
  @protocol
end

#type ⇒ String

The type of the IM client. 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) 


180
181
182
 
# File 'generated/google/apis/people_v1/classes.rb', line 180

def type
  @type
end

#username ⇒ String

The user name used in the IM client. Corresponds to the JSON property username

Returns:

  • (String) 


200
201
202
 
# File 'generated/google/apis/people_v1/classes.rb', line 200

def username
  @username
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



219
220
221
222
223
224
225
226
 
# File 'generated/google/apis/people_v1/classes.rb', line 219

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