Class: PureCloud::UserPresence

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/user_presence.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserPresence

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 72

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}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'source')
    self.source = attributes[:'source']
  end

  if attributes.has_key?(:'primary')
    self.primary = attributes[:'primary']
  end

  if attributes.has_key?(:'presenceDefinition')
    self.presence_definition = attributes[:'presenceDefinition']
  end

  if attributes.has_key?(:'message')
    self.message = attributes[:'message']
  end

  if attributes.has_key?(:'modifiedDate')
    self.modified_date = attributes[:'modifiedDate']
  end

  if attributes.has_key?(:'selfUri')
    self.self_uri = attributes[:'selfUri']
  end

end

Instance Attribute Details

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 22

def id
  @id
end

#message ⇒ Object

Returns the value of attribute message.



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 34

def message
  @message
end

#modified_date ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 37

def modified_date
  @modified_date
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 24

def name
  @name
end

#presence_definition ⇒ Object

Returns the value of attribute presence_definition.



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 32

def presence_definition
  @presence_definition
end

#primary ⇒ Object

A boolean used to tell whether or not to set this presence source as the primary on a PATCH



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 30

def primary
  @primary
end

#self_uri ⇒ Object

The URI for this object



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 40

def self_uri
  @self_uri
end

#source ⇒ Object

Represents the source where the Presence was set. Some examples are: PURECLOUD, LYNC, OUTLOOK, etc.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 27

def source
  @source
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 43

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'source' => :'source',
    :'primary' => :'primary',
    :'presence_definition' => :'presenceDefinition',
    :'message' => :'message',
    :'modified_date' => :'modifiedDate',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 57

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'source' => :'String',
    :'primary' => :'BOOLEAN',
    :'presence_definition' => :'OrganizationPresence',
    :'message' => :'String',
    :'modified_date' => :'DateTime',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 126

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      source == o.source &&
      primary == o.primary &&
      presence_definition == o.presence_definition &&
      message == o.message &&
      modified_date == o.modified_date &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 171

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 231

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

build the object from hash



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 152

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
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


141
142
143
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 141

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 147

def hash
  [id, name, source, primary, presence_definition, message, modified_date, self_uri].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



114
115
116
117
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 114

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



214
215
216
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 214

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



219
220
221
222
223
224
225
226
227
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 219

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



209
210
211
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 209

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



121
122
 
# File 'lib/purecloudplatformclientv2/models/user_presence.rb', line 121

def valid?
end