Class: PureCloud::ChatMessage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChatMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 118

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?(:'body')
    
    
    self.body = attributes[:'body']
    
  
  end

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#body ⇒ Object

The message body



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

def body
  @body
end

#body_type ⇒ Object

Type of the message body (v2 chats only)



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 43

def body_type
  @body_type
end

#chat ⇒ Object

The interaction id (if available)



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 35

def chat
  @chat
end

#from ⇒ Object

The message sender



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

def from
  @from
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#message ⇒ Object

The message id



38
39
40
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 38

def message
  @message
end

#participant_purpose ⇒ Object

Participant purpose of sender (v2 chats only)



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 49

def participant_purpose
  @participant_purpose
end

#sender_communication_id ⇒ Object

Communication of sender (v2 chats only)



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 46

def sender_communication_id
  @sender_communication_id
end

#to ⇒ Object

The message recipient



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

def to
  @to
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#user ⇒ Object

The user information for the sender (if available)



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 52

def user
  @user
end

#utc ⇒ Object

Returns the value of attribute utc.



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

def utc
  @utc
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 55

def self.attribute_map
  {
    
    :'body' => :'body',
    
    :'id' => :'id',
    
    :'to' => :'to',
    
    :'from' => :'from',
    
    :'utc' => :'utc',
    
    :'chat' => :'chat',
    
    :'message' => :'message',
    
    :'type' => :'type',
    
    :'body_type' => :'bodyType',
    
    :'sender_communication_id' => :'senderCommunicationId',
    
    :'participant_purpose' => :'participantPurpose',
    
    :'user' => :'user'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
111
112
113
114
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 86

def self.swagger_types
  {
    
    :'body' => :'String',
    
    :'id' => :'String',
    
    :'to' => :'String',
    
    :'from' => :'String',
    
    :'utc' => :'String',
    
    :'chat' => :'String',
    
    :'message' => :'String',
    
    :'type' => :'String',
    
    :'body_type' => :'String',
    
    :'sender_communication_id' => :'String',
    
    :'participant_purpose' => :'String',
    
    :'user' => :'ChatMessageUser'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 375

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      body == o.body &&
      id == o.id &&
      to == o.to &&
      from == o.from &&
      utc == o.utc &&
      chat == o.chat &&
      message == o.message &&
      type == o.type &&
      body_type == o.body_type &&
      sender_communication_id == o.sender_communication_id &&
      participant_purpose == o.participant_purpose &&
      user == o.user
end

#_deserialize(type, value) ⇒ Object 



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 424

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



484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 484

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



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 405

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


394
395
396
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 394

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



400
401
402
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 400

def hash
  [body, id, to, from, utc, chat, message, type, body_type, sender_communication_id, participant_purpose, user].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



237
238
239
240
241
242
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 237

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



467
468
469
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 467

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



472
473
474
475
476
477
478
479
480
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 472

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 



462
463
464
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 462

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/purecloudplatformclientv2/models/chat_message.rb', line 246

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["STANDARD", "ACTIVITY", "TYPING", "NOTICE", "MEMBERJOIN", "MEMBERLEAVE", "MEDIAREQUEST"]
  if @body_type && !allowed_values.include?(@body_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end