Class: Google::Apis::AdminDirectoryV1::UserIm

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/admin_directory_v1/classes.rb,
generated/google/apis/admin_directory_v1/representations.rb,
generated/google/apis/admin_directory_v1/representations.rb

Overview

JSON template for instant messenger of an user.

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

Returns a new instance of UserIm.


2770
2771
2772
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2770

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

Instance Attribute Details

#custom_protocolString

Custom protocol. Corresponds to the JSON property customProtocol

Returns:

  • (String)

2737
2738
2739
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2737

def custom_protocol
  @custom_protocol
end

#custom_typeString

Custom type. Corresponds to the JSON property customType

Returns:

  • (String)

2742
2743
2744
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2742

def custom_type
  @custom_type
end

#imString

Instant messenger id. Corresponds to the JSON property im

Returns:

  • (String)

2747
2748
2749
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2747

def im
  @im
end

#primaryBoolean Also known as: primary?

If this is user's primary im. Only one entry could be marked as primary. Corresponds to the JSON property primary

Returns:

  • (Boolean)

2752
2753
2754
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2752

def primary
  @primary
end

#protocolString

Protocol used in the instant messenger. It should be one of the values from ImProtocolTypes map. Similar to type, it can take a CUSTOM value and specify the custom name in customProtocol field. Corresponds to the JSON property protocol

Returns:

  • (String)

2760
2761
2762
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2760

def protocol
  @protocol
end

#typeString

Each entry can have a type which indicates standard types of that entry. For example instant messengers could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value. Such types should have the CUSTOM value as type and also have a customType value. Corresponds to the JSON property type

Returns:

  • (String)

2768
2769
2770
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2768

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2775
2776
2777
2778
2779
2780
2781
2782
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2775

def update!(**args)
  @custom_protocol = args[:custom_protocol] if args.key?(:custom_protocol)
  @custom_type = args[:custom_type] if args.key?(:custom_type)
  @im = args[:im] if args.key?(:im)
  @primary = args[:primary] if args.key?(:primary)
  @protocol = args[:protocol] if args.key?(:protocol)
  @type = args[:type] if args.key?(:type)
end