Class: PureCloud::Video

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Video

Returns a new instance of Video.



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
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/purecloud/models/video.rb', line 87

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[:'context']
    self.context = attributes[:'context']
  end
  
  if attributes[:'audioMuted']
    self.audio_muted = attributes[:'audioMuted']
  else
    self.audio_muted = false
  end
  
  if attributes[:'videoMuted']
    self.video_muted = attributes[:'videoMuted']
  else
    self.video_muted = false
  end
  
  if attributes[:'sharingScreen']
    self.sharing_screen = attributes[:'sharingScreen']
  else
    self.sharing_screen = false
  end
  
  if attributes[:'peerCount']
    self.peer_count = attributes[:'peerCount']
  end
  
  if attributes[:'disconnectType']
    self.disconnect_type = attributes[:'disconnectType']
  end
  
  if attributes[:'connectedTime']
    self.connected_time = attributes[:'connectedTime']
  end
  
  if attributes[:'disconnectedTime']
    self.disconnected_time = attributes[:'disconnectedTime']
  end
  
end

Instance Attribute Details

#audio_muted ⇒ Object

Returns the value of attribute audio_muted.



27
28
29
 
# File 'lib/purecloud/models/video.rb', line 27

def audio_muted
  @audio_muted
end

#connected_time ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



38
39
40
 
# File 'lib/purecloud/models/video.rb', line 38

def connected_time
  @connected_time
end

#context ⇒ Object

Returns the value of attribute context.



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

def context
  @context
end

#disconnect_type ⇒ Object

Returns the value of attribute disconnect_type.



35
36
37
 
# File 'lib/purecloud/models/video.rb', line 35

def disconnect_type
  @disconnect_type
end

#disconnected_time ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



41
42
43
 
# File 'lib/purecloud/models/video.rb', line 41

def disconnected_time
  @disconnected_time
end

#id ⇒ Object

Returns the value of attribute id.



23
24
25
 
# File 'lib/purecloud/models/video.rb', line 23

def id
  @id
end

#peer_count ⇒ Object

Returns the value of attribute peer_count.



33
34
35
 
# File 'lib/purecloud/models/video.rb', line 33

def peer_count
  @peer_count
end

#sharing_screen ⇒ Object

Returns the value of attribute sharing_screen.



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

def sharing_screen
  @sharing_screen
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#video_muted ⇒ Object

Returns the value of attribute video_muted.



29
30
31
 
# File 'lib/purecloud/models/video.rb', line 29

def video_muted
  @video_muted
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/purecloud/models/video.rb', line 44

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'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/purecloud/models/video.rb', line 161

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
end

#_deserialize(type, value) ⇒ Object 



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
234
235
236
237
238
239
240
241
242
 
# File 'lib/purecloud/models/video.rb', line 206

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



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/purecloud/models/video.rb', line 266

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/purecloud/models/video.rb', line 187

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


177
178
179
 
# File 'lib/purecloud/models/video.rb', line 177

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



182
183
184
 
# File 'lib/purecloud/models/video.rb', line 182

def hash
  [state, id, context, audio_muted, video_muted, sharing_screen, peer_count, disconnect_type, connected_time, disconnected_time].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



249
250
251
 
# File 'lib/purecloud/models/video.rb', line 249

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



254
255
256
257
258
259
260
261
262
 
# File 'lib/purecloud/models/video.rb', line 254

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 



244
245
246
 
# File 'lib/purecloud/models/video.rb', line 244

def to_s
  to_hash.to_s
end