Class: PureCloud::Cobrowsesession

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Cobrowsesession

Initializes the object

Parameters:

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

    Model attributes in the form of hash



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 100

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

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

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

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

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

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

  if attributes.has_key?(:'controlling')
    if (value = attributes[:'controlling']).is_a?(Array)
      self.controlling = value
    end
  end

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

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

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

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

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

  if attributes.has_key?(:'segments')
    if (value = attributes[:'segments']).is_a?(Array)
      self.segments = value
    end
  end

end

Instance Attribute Details

#_self ⇒ Object

Address and name data for a call endpoint.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 31

def _self
  @_self
end

#cobrowse_role ⇒ Object

This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer).



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

def cobrowse_role
  @cobrowse_role
end

#cobrowse_session_id ⇒ Object

The co-browse session ID.



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

def cobrowse_session_id
  @cobrowse_session_id
end

#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



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

def connected_time
  @connected_time
end

#controlling ⇒ Object

ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).



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

def controlling
  @controlling
end

#disconnect_type ⇒ Object

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



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 28

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



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

def disconnected_time
  @disconnected_time
end

#id ⇒ Object

A globally unique identifier for this communication.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 25

def id
  @id
end

#provider ⇒ Object

The source provider for the co-browse session.



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 55

def provider
  @provider
end

#provider_event_time ⇒ Object

The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def provider_event_time
  @provider_event_time
end

#segments ⇒ Object

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



58
59
60
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 58

def segments
  @segments
end

#state ⇒ Object

The connection state of this communication.



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

def state
  @state
end

#viewer_url ⇒ Object

The URL that can be used to open co-browse session in web browser.



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

def viewer_url
  @viewer_url
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 61

def self.attribute_map
  {
    :'state' => :'state',
    :'id' => :'id',
    :'disconnect_type' => :'disconnectType',
    :'_self' => :'self',
    :'cobrowse_session_id' => :'cobrowseSessionId',
    :'cobrowse_role' => :'cobrowseRole',
    :'controlling' => :'controlling',
    :'viewer_url' => :'viewerUrl',
    :'provider_event_time' => :'providerEventTime',
    :'connected_time' => :'connectedTime',
    :'disconnected_time' => :'disconnectedTime',
    :'provider' => :'provider',
    :'segments' => :'segments'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 80

def self.swagger_types
  {
    :'state' => :'String',
    :'id' => :'String',
    :'disconnect_type' => :'String',
    :'_self' => :'Address',
    :'cobrowse_session_id' => :'String',
    :'cobrowse_role' => :'String',
    :'controlling' => :'Array<String>',
    :'viewer_url' => :'String',
    :'provider_event_time' => :'DateTime',
    :'connected_time' => :'DateTime',
    :'disconnected_time' => :'DateTime',
    :'provider' => :'String',
    :'segments' => :'Array<Segment>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      id == o.id &&
      disconnect_type == o.disconnect_type &&
      _self == o._self &&
      cobrowse_session_id == o.cobrowse_session_id &&
      cobrowse_role == o.cobrowse_role &&
      controlling == o.controlling &&
      viewer_url == o.viewer_url &&
      provider_event_time == o.provider_event_time &&
      connected_time == o.connected_time &&
      disconnected_time == o.disconnected_time &&
      provider == o.provider &&
      segments == o.segments
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 256

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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 316

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 237

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


226
227
228
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



232
233
234
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 232

def hash
  [state, id, disconnect_type, _self, cobrowse_session_id, cobrowse_role, controlling, viewer_url, provider_event_time, connected_time, disconnected_time, provider, segments].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



166
167
168
169
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 166

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



299
300
301
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 299

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



304
305
306
307
308
309
310
311
312
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 304

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 



294
295
296
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 294

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



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/purecloudplatformclientv2/models/cobrowsesession.rb', line 173

def valid?
  allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "scheduled", "none"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  allowed_values = ["endpoint", "client", "system", "timeout", "transfer", "transfer.conference", "transfer.consult", "transfer.forward", "transport.failure", "error", "peer", "other", "spam", "uncallable"]
  if @disconnect_type && !allowed_values.include?(@disconnect_type)
    return false
  end
end