Class: OCI::IdentityDomains::Models::UserIms

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/user_ims.rb

Overview

User's instant messaging addresses

Constant Summary collapse

TYPE_ENUM =
[
  TYPE_AIM = 'aim'.freeze,
  TYPE_GTALK = 'gtalk'.freeze,
  TYPE_ICQ = 'icq'.freeze,
  TYPE_XMPP = 'xmpp'.freeze,
  TYPE_MSN = 'msn'.freeze,
  TYPE_SKYPE = 'skype'.freeze,
  TYPE_QQ = 'qq'.freeze,
  TYPE_YAHOO = 'yahoo'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserIms

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):

  • :value (String)

    The value to assign to the #value property

  • :display (String)

    The value to assign to the #display property

  • :type (String)

    The value to assign to the #type property

  • :primary (BOOLEAN)

    The value to assign to the #primary property



114
115
116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/oci/identity_domains/models/user_ims.rb', line 114

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.value = attributes[:'value'] if attributes[:'value']

  self.display = attributes[:'display'] if attributes[:'display']

  self.type = attributes[:'type'] if attributes[:'type']

  self.primary = attributes[:'primary'] unless attributes[:'primary'].nil?
end

Instance Attribute Details

#displayString

A human-readable name, primarily used for display purposes

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String)


50
51
52
# File 'lib/oci/identity_domains/models/user_ims.rb', line 50

def display
  @display
end

#primaryBOOLEAN

A Boolean value that indicates the 'primary' or preferred attribute value for this attribute–for example, the preferred messenger or primary messenger. The primary attribute value 'true' MUST appear no more than once.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN)


78
79
80
# File 'lib/oci/identity_domains/models/user_ims.rb', line 78

def primary
  @primary
end

#typeString

[Required] A label that indicates the attribute's function–for example, 'aim', 'gtalk', or 'mobile'

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String)


64
65
66
# File 'lib/oci/identity_domains/models/user_ims.rb', line 64

def type
  @type
end

#valueString

[Required] User's instant messaging address

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String)


36
37
38
# File 'lib/oci/identity_domains/models/user_ims.rb', line 36

def value
  @value
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



81
82
83
84
85
86
87
88
89
90
# File 'lib/oci/identity_domains/models/user_ims.rb', line 81

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'value',
    'display': :'display',
    'type': :'type',
    'primary': :'primary'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
# File 'lib/oci/identity_domains/models/user_ims.rb', line 93

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'String',
    'display': :'String',
    'type': :'String',
    'primary': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



149
150
151
152
153
154
155
156
157
# File 'lib/oci/identity_domains/models/user_ims.rb', line 149

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    value == other.value &&
    display == other.display &&
    type == other.type &&
    primary == other.primary
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
# File 'lib/oci/identity_domains/models/user_ims.rb', line 182

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


162
163
164
# File 'lib/oci/identity_domains/models/user_ims.rb', line 162

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



171
172
173
# File 'lib/oci/identity_domains/models/user_ims.rb', line 171

def hash
  [value, display, type, primary].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



215
216
217
218
219
220
221
222
223
224
# File 'lib/oci/identity_domains/models/user_ims.rb', line 215

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



209
210
211
# File 'lib/oci/identity_domains/models/user_ims.rb', line 209

def to_s
  to_hash.to_s
end