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



820
821
822
 
# File 'generated/google/apis/people_v1/classes.rb', line 820

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) 


778
779
780
 
# File 'generated/google/apis/people_v1/classes.rb', line 778

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) 


784
785
786
 
# File 'generated/google/apis/people_v1/classes.rb', line 784

def formatted_type
  @formatted_type
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



789
790
791
 
# File 'generated/google/apis/people_v1/classes.rb', line 789

def metadata
  @metadata
end

#protocol ⇒ String

The protocol of the IM client. The protocol can be custom or one of these predefined values:

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

Returns:

  • (String) 


804
805
806
 
# File 'generated/google/apis/people_v1/classes.rb', line 804

def protocol
  @protocol
end

#type ⇒ String

The type of the IM client. The type can be custom or one of these predefined values:

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

Returns:

  • (String) 


813
814
815
 
# File 'generated/google/apis/people_v1/classes.rb', line 813

def type
  @type
end

#username ⇒ String

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

Returns:

  • (String) 


818
819
820
 
# File 'generated/google/apis/people_v1/classes.rb', line 818

def username
  @username
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



825
826
827
828
829
830
831
832
 
# File 'generated/google/apis/people_v1/classes.rb', line 825

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