Class: PureCloud::Video

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Video

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

  if attributes.has_key?(:'disconnectType')
    self.disconnect_type = attributes[:'disconnectType']
  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

end

Instance Attribute Details

#audio_muted ⇒ Object

Indicates whether this participant has muted their outgoing audio.



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

def audio_muted
  @audio_muted
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



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

def connected_time
  @connected_time
end

#context ⇒ Object

The room id context (xmpp jid) for the conference session.



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

def context
  @context
end

#disconnect_type ⇒ Object

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



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

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



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

def disconnected_time
  @disconnected_time
end

#id ⇒ Object

A globally unique identifier for this communication.



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

def id
  @id
end

#peer_count ⇒ Object

The number of peer participants from the perspective of the participant in the conference.



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

def peer_count
  @peer_count
end

#provider ⇒ Object

The source provider for the video.



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

def provider
  @provider
end

#sharing_screen ⇒ Object

Indicates whether this participant is sharing their screen to the session.



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

def sharing_screen
  @sharing_screen
end

#state ⇒ Object

The connection state of this communication.



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

def state
  @state
end

#video_muted ⇒ Object

Indicates whether this participant has muted/paused their outgoing video.



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

def video_muted
  @video_muted
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
 
# File 'lib/purecloudplatformclientv2/models/video.rb', line 55

def self.attribute_map
  {
    :'state' => :'state',
    :'id' => :'id',
    :'context' => :'context',
    :'audio_muted' => :'audioMuted',
    :'video_muted' => :'videoMuted',
    :'sharing_screen' => :'sharingScreen',
    :'peer_count' => :'peerCount',
    :'disconnect_type' => :'disconnectType',
    :'connected_time' => :'connectedTime',
    :'disconnected_time' => :'disconnectedTime',
    :'provider' => :'provider'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/purecloudplatformclientv2/models/video.rb', line 72

def self.swagger_types
  {
    :'state' => :'String',
    :'id' => :'String',
    :'context' => :'String',
    :'audio_muted' => :'BOOLEAN',
    :'video_muted' => :'BOOLEAN',
    :'sharing_screen' => :'BOOLEAN',
    :'peer_count' => :'Integer',
    :'disconnect_type' => :'String',
    :'connected_time' => :'DateTime',
    :'disconnected_time' => :'DateTime',
    :'provider' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/purecloudplatformclientv2/models/video.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      id == o.id &&
      context == o.context &&
      audio_muted == o.audio_muted &&
      video_muted == o.video_muted &&
      sharing_screen == o.sharing_screen &&
      peer_count == o.peer_count &&
      disconnect_type == o.disconnect_type &&
      connected_time == o.connected_time &&
      disconnected_time == o.disconnected_time &&
      provider == o.provider
end

#_deserialize(type, value) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/purecloudplatformclientv2/models/video.rb', line 232

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/purecloudplatformclientv2/models/video.rb', line 292

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/purecloudplatformclientv2/models/video.rb', line 213

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


202
203
204
 
# File 'lib/purecloudplatformclientv2/models/video.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



208
209
210
 
# File 'lib/purecloudplatformclientv2/models/video.rb', line 208

def hash
  [state, id, context, audio_muted, video_muted, sharing_screen, peer_count, disconnect_type, connected_time, disconnected_time, provider].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



144
145
146
147
 
# File 'lib/purecloudplatformclientv2/models/video.rb', line 144

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



275
276
277
 
# File 'lib/purecloudplatformclientv2/models/video.rb', line 275

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



280
281
282
283
284
285
286
287
288
 
# File 'lib/purecloudplatformclientv2/models/video.rb', line 280

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 



270
271
272
 
# File 'lib/purecloudplatformclientv2/models/video.rb', line 270

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



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/purecloudplatformclientv2/models/video.rb', line 151

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