Class: ZoomUs::Models::UserSettingsRecording

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/models/user_settings_recording.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserSettingsRecording

Initializes the object



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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 115

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

  if attributes.has_key?(:'cloud_recording')
    self.cloud_recording = attributes[:'cloud_recording']
  else
    self.cloud_recording = false
  end

  if attributes.has_key?(:'record_speaker_view')
    self.record_speaker_view = attributes[:'record_speaker_view']
  else
    self.record_speaker_view = false
  end

  if attributes.has_key?(:'record_gallery_view')
    self.record_gallery_view = attributes[:'record_gallery_view']
  else
    self.record_gallery_view = false
  end

  if attributes.has_key?(:'record_audio_file')
    self.record_audio_file = attributes[:'record_audio_file']
  else
    self.record_audio_file = false
  end

  if attributes.has_key?(:'save_chat_text')
    self.save_chat_text = attributes[:'save_chat_text']
  else
    self.save_chat_text = false
  end

  if attributes.has_key?(:'show_timestamp')
    self.show_timestamp = attributes[:'show_timestamp']
  else
    self.show_timestamp = false
  end

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

  if attributes.has_key?(:'auto_recording')
    self.auto_recording = attributes[:'auto_recording']
  else
    self.auto_recording = 'local'
  end

  if attributes.has_key?(:'host_pause_stop_recording')
    self.host_pause_stop_recording = attributes[:'host_pause_stop_recording']
  else
    self.host_pause_stop_recording = false
  end

  if attributes.has_key?(:'auto_delete_cmr')
    self.auto_delete_cmr = attributes[:'auto_delete_cmr']
  else
    self.auto_delete_cmr = false
  end

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

Instance Attribute Details

#auto_delete_cmr ⇒ Object

Auto delete cloud recordings.



50
51
52
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 50

def auto_delete_cmr
  @auto_delete_cmr
end

#auto_delete_cmr_days ⇒ Object

A specified number of days of auto delete cloud recordings.



53
54
55
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 53

def auto_delete_cmr_days
  @auto_delete_cmr_days
end

#auto_recording ⇒ Object

Automatic recording:
‘local` - Record on local.
`cloud` - Record on cloud.
`none` - Disabled.



44
45
46
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 44

def auto_recording
  @auto_recording
end

#cloud_recording ⇒ Object

Cloud recording.



23
24
25
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 23

def cloud_recording
  @cloud_recording
end

#host_pause_stop_recording ⇒ Object

Host can pause/stop the auto recording in the cloud.



47
48
49
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 47

def host_pause_stop_recording
  @host_pause_stop_recording
end

#local_recording ⇒ Object

Local recording.



20
21
22
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 20

def local_recording
  @local_recording
end

#record_audio_file ⇒ Object

Record an audio only file.



32
33
34
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 32

def record_audio_file
  @record_audio_file
end

#record_gallery_view ⇒ Object

Record the gallery view.



29
30
31
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 29

def record_gallery_view
  @record_gallery_view
end

#record_speaker_view ⇒ Object

Record the active speaker view.



26
27
28
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 26

def record_speaker_view
  @record_speaker_view
end

#recording_audio_transcript ⇒ Object

Audio transcript.



41
42
43
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 41

def recording_audio_transcript
  @recording_audio_transcript
end

#save_chat_text ⇒ Object

Save chat text from the meeting.



35
36
37
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 35

def save_chat_text
  @save_chat_text
end

#show_timestamp ⇒ Object

Show timestamp on video.



38
39
40
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 38

def show_timestamp
  @show_timestamp
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 78

def self.attribute_map
  {
    :'local_recording' => :'local_recording',
    :'cloud_recording' => :'cloud_recording',
    :'record_speaker_view' => :'record_speaker_view',
    :'record_gallery_view' => :'record_gallery_view',
    :'record_audio_file' => :'record_audio_file',
    :'save_chat_text' => :'save_chat_text',
    :'show_timestamp' => :'show_timestamp',
    :'recording_audio_transcript' => :'recording_audio_transcript',
    :'auto_recording' => :'auto_recording',
    :'host_pause_stop_recording' => :'host_pause_stop_recording',
    :'auto_delete_cmr' => :'auto_delete_cmr',
    :'auto_delete_cmr_days' => :'auto_delete_cmr_days'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 96

def self.swagger_types
  {
    :'local_recording' => :'BOOLEAN',
    :'cloud_recording' => :'BOOLEAN',
    :'record_speaker_view' => :'BOOLEAN',
    :'record_gallery_view' => :'BOOLEAN',
    :'record_audio_file' => :'BOOLEAN',
    :'save_chat_text' => :'BOOLEAN',
    :'show_timestamp' => :'BOOLEAN',
    :'recording_audio_transcript' => :'BOOLEAN',
    :'auto_recording' => :'String',
    :'host_pause_stop_recording' => :'BOOLEAN',
    :'auto_delete_cmr' => :'BOOLEAN',
    :'auto_delete_cmr_days' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    local_recording == o.local_recording &&
    cloud_recording == o.cloud_recording &&
    record_speaker_view == o.record_speaker_view &&
    record_gallery_view == o.record_gallery_view &&
    record_audio_file == o.record_audio_file &&
    save_chat_text == o.save_chat_text &&
    show_timestamp == o.show_timestamp &&
    recording_audio_transcript == o.recording_audio_transcript &&
    auto_recording == o.auto_recording &&
    host_pause_stop_recording == o.host_pause_stop_recording &&
    auto_delete_cmr == o.auto_delete_cmr &&
    auto_delete_cmr_days == o.auto_delete_cmr_days
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 292

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 =~ /\A(true|t|yes|y|1)\z/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
    temp_model = Models.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 358

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

Builds the object from hash



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 271

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


258
259
260
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 258

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



264
265
266
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 264

def hash
  [local_recording, cloud_recording, record_speaker_view, record_gallery_view, record_audio_file, save_chat_text, show_timestamp, recording_audio_transcript, auto_recording, host_pause_stop_recording, auto_delete_cmr, auto_delete_cmr_days].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 190

def list_invalid_properties
  invalid_properties = Array.new
  if !@auto_delete_cmr_days.nil? && @auto_delete_cmr_days > 60
    invalid_properties.push('invalid value for "auto_delete_cmr_days", must be smaller than or equal to 60.')
  end

  if !@auto_delete_cmr_days.nil? && @auto_delete_cmr_days < 1
    invalid_properties.push('invalid value for "auto_delete_cmr_days", must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



338
339
340
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 338

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



344
345
346
347
348
349
350
351
352
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 344

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 ⇒ String

Returns the string representation of the object



332
333
334
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 332

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



205
206
207
208
209
210
211
 
# File 'lib/zoom_us/models/user_settings_recording.rb', line 205

def valid?
  auto_recording_validator = EnumAttributeValidator.new('String', ['local', 'cloud', 'none'])
  return false unless auto_recording_validator.valid?(@auto_recording)
  return false if !@auto_delete_cmr_days.nil? && @auto_delete_cmr_days > 60
  return false if !@auto_delete_cmr_days.nil? && @auto_delete_cmr_days < 1
  true
end