Class: PureCloud::SocialExpression

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SocialExpression

Returns a new instance of SocialExpression.



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

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[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'socialMediaId']
    self.social_media_id = attributes[:'socialMediaId']
  end
  
  if attributes[:'socialMediaHub']
    self.social_media_hub = attributes[:'socialMediaHub']
  end
  
  if attributes[:'socialUserName']
    self.social_user_name = attributes[:'socialUserName']
  end
  
  if attributes[:'previewText']
    self.preview_text = attributes[:'previewText']
  end
  
  if attributes[:'recordingId']
    self.recording_id = attributes[:'recordingId']
  end
  
  if attributes[:'segments']
    if (value = attributes[:'segments']).is_a?(Array)
      self.segments = value
    end
  end
  
  if attributes[:'held']
    self.held = attributes[:'held']
  end
  
  if attributes[:'disconnectType']
    self.disconnect_type = attributes[:'disconnectType']
  end
  
  if attributes[:'startHoldTime']
    self.start_hold_time = attributes[:'startHoldTime']
  end
  
  if attributes[:'connectedTime']
    self.connected_time = attributes[:'connectedTime']
  end
  
  if attributes[:'disconnectedTime']
    self.disconnected_time = attributes[:'disconnectedTime']
  end
  
  if attributes[:'provider']
    self.provider = attributes[:'provider']
  end
  
end

Instance Attribute Details

#connected_time ⇒ Object

The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



55
56
57
 
# File 'lib/purecloud/models/social_expression.rb', line 55

def connected_time
  @connected_time
end

#disconnect_type ⇒ Object

System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.



49
50
51
 
# File 'lib/purecloud/models/social_expression.rb', line 49

def disconnect_type
  @disconnect_type
end

#disconnected_time ⇒ Object

The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



58
59
60
 
# File 'lib/purecloud/models/social_expression.rb', line 58

def disconnected_time
  @disconnected_time
end

#held ⇒ Object

True if this call is held and the person on this side hears silence.



46
47
48
 
# File 'lib/purecloud/models/social_expression.rb', line 46

def held
  @held
end

#id ⇒ Object

A globally unique identifier for this communication.



25
26
27
 
# File 'lib/purecloud/models/social_expression.rb', line 25

def id
  @id
end

#preview_text ⇒ Object

The text preview of the communication contents



37
38
39
 
# File 'lib/purecloud/models/social_expression.rb', line 37

def preview_text
  @preview_text
end

#provider ⇒ Object

The source provider for the social expression.



61
62
63
 
# File 'lib/purecloud/models/social_expression.rb', line 61

def provider
  @provider
end

#recording_id ⇒ Object

A globally unique identifier for the recording associated with this chat.



40
41
42
 
# File 'lib/purecloud/models/social_expression.rb', line 40

def recording_id
  @recording_id
end

#segments ⇒ Object

The time line of the participant’s chat, divided into activity segments.



43
44
45
 
# File 'lib/purecloud/models/social_expression.rb', line 43

def segments
  @segments
end

#social_media_hub ⇒ Object

The social network of the communication



31
32
33
 
# File 'lib/purecloud/models/social_expression.rb', line 31

def social_media_hub
  @social_media_hub
end

#social_media_id ⇒ Object

A globally unique identifier for the social media.



28
29
30
 
# File 'lib/purecloud/models/social_expression.rb', line 28

def social_media_id
  @social_media_id
end

#social_user_name ⇒ Object

The user name for the communication.



34
35
36
 
# File 'lib/purecloud/models/social_expression.rb', line 34

def social_user_name
  @social_user_name
end

#start_hold_time ⇒ Object

The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



52
53
54
 
# File 'lib/purecloud/models/social_expression.rb', line 52

def start_hold_time
  @start_hold_time
end

#state ⇒ Object

The connection state of this communication.



22
23
24
 
# File 'lib/purecloud/models/social_expression.rb', line 22

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'state' => :'state',
    
    :'id' => :'id',
    
    :'social_media_id' => :'socialMediaId',
    
    :'social_media_hub' => :'socialMediaHub',
    
    :'social_user_name' => :'socialUserName',
    
    :'preview_text' => :'previewText',
    
    :'recording_id' => :'recordingId',
    
    :'segments' => :'segments',
    
    :'held' => :'held',
    
    :'disconnect_type' => :'disconnectType',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'connected_time' => :'connectedTime',
    
    :'disconnected_time' => :'disconnectedTime',
    
    :'provider' => :'provider'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/purecloud/models/social_expression.rb', line 99

def self.swagger_types
  {
    :'state' => :'String',
    :'id' => :'String',
    :'social_media_id' => :'String',
    :'social_media_hub' => :'String',
    :'social_user_name' => :'String',
    :'preview_text' => :'String',
    :'recording_id' => :'String',
    :'segments' => :'Array<Segment>',
    :'held' => :'BOOLEAN',
    :'disconnect_type' => :'String',
    :'start_hold_time' => :'DateTime',
    :'connected_time' => :'DateTime',
    :'disconnected_time' => :'DateTime',
    :'provider' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/purecloud/models/social_expression.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      id == o.id &&
      social_media_id == o.social_media_id &&
      social_media_hub == o.social_media_hub &&
      social_user_name == o.social_user_name &&
      preview_text == o.preview_text &&
      recording_id == o.recording_id &&
      segments == o.segments &&
      held == o.held &&
      disconnect_type == o.disconnect_type &&
      start_hold_time == o.start_hold_time &&
      connected_time == o.connected_time &&
      disconnected_time == o.disconnected_time &&
      provider == o.provider
end

#_deserialize(type, value) ⇒ Object 



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

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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/purecloud/models/social_expression.rb', line 314

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/purecloud/models/social_expression.rb', line 235

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


225
226
227
 
# File 'lib/purecloud/models/social_expression.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



230
231
232
 
# File 'lib/purecloud/models/social_expression.rb', line 230

def hash
  [state, id, social_media_id, social_media_hub, social_user_name, preview_text, recording_id, segments, held, disconnect_type, start_hold_time, connected_time, disconnected_time, provider].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



297
298
299
 
# File 'lib/purecloud/models/social_expression.rb', line 297

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



302
303
304
305
306
307
308
309
310
 
# File 'lib/purecloud/models/social_expression.rb', line 302

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 



292
293
294
 
# File 'lib/purecloud/models/social_expression.rb', line 292

def to_s
  to_hash.to_s
end