Class: PureCloud::ChatMessage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChatMessage

Returns a new instance of ChatMessage.



64
65
66
67
68
69
70
71
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
# File 'lib/purecloud/models/chat_message.rb', line 64

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

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

  
  if attributes[:'body']
    self.body = attributes[:'body']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'to']
    self.to = attributes[:'to']
  end
  
  if attributes[:'from']
    self.from = attributes[:'from']
  end
  
  if attributes[:'utc']
    self.utc = attributes[:'utc']
  end
  
  if attributes[:'chat']
    self.chat = attributes[:'chat']
  end
  
  if attributes[:'message']
    self.message = attributes[:'message']
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'user']
    self.user = attributes[:'user']
  end
  
end

Instance Attribute Details

#bodyObject

Returns the value of attribute body.



5
6
7
# File 'lib/purecloud/models/chat_message.rb', line 5

def body
  @body
end

#chatObject

Returns the value of attribute chat.



15
16
17
# File 'lib/purecloud/models/chat_message.rb', line 15

def chat
  @chat
end

#fromObject

Returns the value of attribute from.



11
12
13
# File 'lib/purecloud/models/chat_message.rb', line 11

def from
  @from
end

#idObject

Returns the value of attribute id.



7
8
9
# File 'lib/purecloud/models/chat_message.rb', line 7

def id
  @id
end

#messageObject

Returns the value of attribute message.



17
18
19
# File 'lib/purecloud/models/chat_message.rb', line 17

def message
  @message
end

#toObject

Returns the value of attribute to.



9
10
11
# File 'lib/purecloud/models/chat_message.rb', line 9

def to
  @to
end

#typeObject

Returns the value of attribute type.



19
20
21
# File 'lib/purecloud/models/chat_message.rb', line 19

def type
  @type
end

#userObject

Returns the value of attribute user.



21
22
23
# File 'lib/purecloud/models/chat_message.rb', line 21

def user
  @user
end

#utcObject

Returns the value of attribute utc.



13
14
15
# File 'lib/purecloud/models/chat_message.rb', line 13

def utc
  @utc
end

Class Method Details

.attribute_mapObject

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



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/purecloud/models/chat_message.rb', line 24

def self.attribute_map
  {
    
    :'body' => :'body',
    
    :'id' => :'id',
    
    :'to' => :'to',
    
    :'from' => :'from',
    
    :'utc' => :'utc',
    
    :'chat' => :'chat',
    
    :'message' => :'message',
    
    :'type' => :'type',
    
    :'user' => :'user'
    
  }
end

.swagger_typesObject

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/purecloud/models/chat_message.rb', line 49

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

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/purecloud/models/chat_message.rb', line 110

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 &&
      user == o.user
end

#_deserialize(type, value) ⇒ Object



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
# File 'lib/purecloud/models/chat_message.rb', line 154

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/purecloud/models/chat_message.rb', line 211

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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/purecloud/models/chat_message.rb', line 135

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

Returns:

  • (Boolean)

See Also:

  • `==` method


125
126
127
# File 'lib/purecloud/models/chat_message.rb', line 125

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



130
131
132
# File 'lib/purecloud/models/chat_message.rb', line 130

def hash
  [body, id, to, from, utc, chat, message, type, user].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



194
195
196
# File 'lib/purecloud/models/chat_message.rb', line 194

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



199
200
201
202
203
204
205
206
207
# File 'lib/purecloud/models/chat_message.rb', line 199

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_sObject



189
190
191
# File 'lib/purecloud/models/chat_message.rb', line 189

def to_s
  to_hash.to_s
end