Class: ZoomUs::Models::UserSettingsInMeeting

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserSettingsInMeeting

Initializes the object

Parameters:

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

    Model attributes in the form of hash



195
196
197
198
199
200
201
202
203
204
205
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
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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 195

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

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

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

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

  if attributes.has_key?(:'entry_exit_chime')
    self.entry_exit_chime = attributes[:'entry_exit_chime']
  else
    self.entry_exit_chime = 'all'
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allow_live_streaming ⇒ Object

Allow live streaming.



89
90
91
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 89

def allow_live_streaming
  @allow_live_streaming
end

#annotation ⇒ Object

Allow participants to use annotation tools.



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

def annotation
  @annotation
end

#attendee_on_hold ⇒ Object

Allow host to put attendee on hold.



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

def attendee_on_hold
  @attendee_on_hold
end

#attention_tracking ⇒ Object

Allow host to see if a participant does not have Zoom in focus during screen sharing.



83
84
85
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 83

def attention_tracking
  @attention_tracking
end

#auto_saving_chat ⇒ Object

Auto save all in-meeting chats.



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

def auto_saving_chat
  @auto_saving_chat
end

#breakout_room ⇒ Object

Allow host to split meeting participants into separate breakout rooms.



62
63
64
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 62

def breakout_room
  @breakout_room
end

#chat ⇒ Object

Enable chat during meeting for all participants.



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

def chat
  @chat
end

#closed_caption ⇒ Object

Enable closed captions.



68
69
70
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 68

def closed_caption
  @closed_caption
end

#co_host ⇒ Object

Allow the host to add co-hosts.



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

def co_host
  @co_host
end

#custom_live_streaming ⇒ Object

Allow custom live streaming.



95
96
97
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 95

def custom_live_streaming
  @custom_live_streaming
end

#custom_service_instructions ⇒ Object

Custom service instructions.



98
99
100
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 98

def custom_service_instructions
  @custom_service_instructions
end

#e2e_encryption ⇒ Object

End-to-end encryption required for all meetings.



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

def e2e_encryption
  @e2e_encryption
end

#entry_exit_chime ⇒ Object

Play sound when participants join or leave:
‘host` - When host joins or leaves.
`all` - When any participant joins or leaves.
`none` - No join or leave sound.



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

def entry_exit_chime
  @entry_exit_chime
end

#far_end_camera_control ⇒ Object

Allow another user to take control of the camera.



77
78
79
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 77

def far_end_camera_control
  @far_end_camera_control
end

#feedback ⇒ Object

Enable option to send feedback to Zoom at the end of the meeting.



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

def feedback
  @feedback
end

#file_transfer ⇒ Object

Enable file transfer through in-meeting chat.



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

def file_transfer
  @file_transfer
end

#group_hd ⇒ Object

Enable group HD video.



71
72
73
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 71

def group_hd
  @group_hd
end

#non_verbal_feedback ⇒ Object

Enable non-verbal feedback through screens.



59
60
61
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 59

def non_verbal_feedback
  @non_verbal_feedback
end

#polling ⇒ Object

Add polls to the meeting controls.



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

def polling
  @polling
end

#private_chat ⇒ Object

Enable 1:1 private chat between participants during meetings.



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

def private_chat
  @private_chat
end

#record_play_voice ⇒ Object

Record and play their own voice.



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

def record_play_voice
  @record_play_voice
end

#remote_control ⇒ Object

Enable remote control during screensharing.



56
57
58
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 56

def remote_control
  @remote_control
end

#remote_support ⇒ Object

Allow host to provide 1:1 remote support to a participant.



65
66
67
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 65

def remote_support
  @remote_support
end

#share_dual_camera ⇒ Object

Share dual camera (deprecated).



80
81
82
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 80

def share_dual_camera
  @share_dual_camera
end

#show_meeting_control_toolbar ⇒ Object

Always show meeting controls during a meeting.



101
102
103
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 101

def show_meeting_control_toolbar
  @show_meeting_control_toolbar
end

#virtual_background ⇒ Object

Enable virtual background.



74
75
76
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 74

def virtual_background
  @virtual_background
end

#waiting_room ⇒ Object

Enable Waiting room - if enabled, attendees can only join after host approves.



86
87
88
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 86

def waiting_room
  @waiting_room
end

#workplace_by_facebook ⇒ Object

Allow livestreaming by host through Workplace by Facebook.



92
93
94
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 92

def workplace_by_facebook
  @workplace_by_facebook
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 126

def self.attribute_map
  {
    :'e2e_encryption' => :'e2e_encryption',
    :'chat' => :'chat',
    :'private_chat' => :'private_chat',
    :'auto_saving_chat' => :'auto_saving_chat',
    :'entry_exit_chime' => :'entry_exit_chime',
    :'record_play_voice' => :'record_play_voice',
    :'file_transfer' => :'file_transfer',
    :'feedback' => :'feedback',
    :'co_host' => :'co_host',
    :'polling' => :'polling',
    :'attendee_on_hold' => :'attendee_on_hold',
    :'annotation' => :'annotation',
    :'remote_control' => :'remote_control',
    :'non_verbal_feedback' => :'non_verbal_feedback',
    :'breakout_room' => :'breakout_room',
    :'remote_support' => :'remote_support',
    :'closed_caption' => :'closed_caption',
    :'group_hd' => :'group_hd',
    :'virtual_background' => :'virtual_background',
    :'far_end_camera_control' => :'far_end_camera_control',
    :'share_dual_camera' => :'share_dual_camera',
    :'attention_tracking' => :'attention_tracking',
    :'waiting_room' => :'waiting_room',
    :'allow_live_streaming' => :'allow_live_streaming',
    :'workplace_by_facebook' => :'workplace_by_facebook',
    :'custom_live_streaming' => :'custom_live_streaming',
    :'custom_service_instructions' => :'custom_service_instructions',
    :'show_meeting_control_toolbar' => :'show_meeting_control_toolbar'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
187
188
189
190
191
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 160

def self.swagger_types
  {
    :'e2e_encryption' => :'BOOLEAN',
    :'chat' => :'BOOLEAN',
    :'private_chat' => :'BOOLEAN',
    :'auto_saving_chat' => :'BOOLEAN',
    :'entry_exit_chime' => :'String',
    :'record_play_voice' => :'BOOLEAN',
    :'file_transfer' => :'BOOLEAN',
    :'feedback' => :'BOOLEAN',
    :'co_host' => :'BOOLEAN',
    :'polling' => :'BOOLEAN',
    :'attendee_on_hold' => :'BOOLEAN',
    :'annotation' => :'BOOLEAN',
    :'remote_control' => :'BOOLEAN',
    :'non_verbal_feedback' => :'BOOLEAN',
    :'breakout_room' => :'BOOLEAN',
    :'remote_support' => :'BOOLEAN',
    :'closed_caption' => :'BOOLEAN',
    :'group_hd' => :'BOOLEAN',
    :'virtual_background' => :'BOOLEAN',
    :'far_end_camera_control' => :'BOOLEAN',
    :'share_dual_camera' => :'BOOLEAN',
    :'attention_tracking' => :'BOOLEAN',
    :'waiting_room' => :'BOOLEAN',
    :'allow_live_streaming' => :'BOOLEAN',
    :'workplace_by_facebook' => :'BOOLEAN',
    :'custom_live_streaming' => :'BOOLEAN',
    :'custom_service_instructions' => :'String',
    :'show_meeting_control_toolbar' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 383

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    e2e_encryption == o.e2e_encryption &&
    chat == o.chat &&
    private_chat == o.private_chat &&
    auto_saving_chat == o.auto_saving_chat &&
    entry_exit_chime == o.entry_exit_chime &&
    record_play_voice == o.record_play_voice &&
    file_transfer == o.file_transfer &&
    feedback == o.feedback &&
    co_host == o.co_host &&
    polling == o.polling &&
    attendee_on_hold == o.attendee_on_hold &&
    annotation == o.annotation &&
    remote_control == o.remote_control &&
    non_verbal_feedback == o.non_verbal_feedback &&
    breakout_room == o.breakout_room &&
    remote_support == o.remote_support &&
    closed_caption == o.closed_caption &&
    group_hd == o.group_hd &&
    virtual_background == o.virtual_background &&
    far_end_camera_control == o.far_end_camera_control &&
    share_dual_camera == o.share_dual_camera &&
    attention_tracking == o.attention_tracking &&
    waiting_room == o.waiting_room &&
    allow_live_streaming == o.allow_live_streaming &&
    workplace_by_facebook == o.workplace_by_facebook &&
    custom_live_streaming == o.custom_live_streaming &&
    custom_service_instructions == o.custom_service_instructions &&
    show_meeting_control_toolbar == o.show_meeting_control_toolbar
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 452

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 518

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 431

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


418
419
420
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 418

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



424
425
426
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 424

def hash
  [e2e_encryption, chat, private_chat, auto_saving_chat, entry_exit_chime, record_play_voice, file_transfer, feedback, co_host, polling, attendee_on_hold, annotation, remote_control, non_verbal_feedback, breakout_room, remote_support, closed_caption, group_hd, virtual_background, far_end_camera_control, share_dual_camera, attention_tracking, waiting_room, allow_live_streaming, workplace_by_facebook, custom_live_streaming, custom_service_instructions, show_meeting_control_toolbar].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



358
359
360
361
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 358

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



498
499
500
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 498

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



504
505
506
507
508
509
510
511
512
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 504

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

Returns:

  • (String) —

    String presentation of the object



492
493
494
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 492

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



365
366
367
368
369
 
# File 'lib/zoom_us/models/user_settings_in_meeting.rb', line 365

def valid?
  entry_exit_chime_validator = EnumAttributeValidator.new('String', ['host', 'all', 'none'])
  return false unless entry_exit_chime_validator.valid?(@entry_exit_chime)
  true
end