Class: ZoomUs::Models::CreateWebinarSettings

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

Overview

Create Webinar settings.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateWebinarSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
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
 
# File 'lib/zoom_us/models/create_webinar_settings.rb', line 180

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

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

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

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

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

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

  if attributes.has_key?(:'audio')
    self.audio = attributes[:'audio']
  else
    self.audio = 'both'
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allow_multiple_devices ⇒ Object

Allow attendees to join from multiple devices.



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

def allow_multiple_devices
  @allow_multiple_devices
end

#alternative_hosts ⇒ Object

Alternative host emails or IDs. Multiple values separated by comma.



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

def alternative_hosts
  @alternative_hosts
end

#approval_type ⇒ Object

‘0` - Automatically approve.
`1` - Manually approve.
`2` - No registration required.



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

def approval_type
  @approval_type
end

#audio ⇒ Object

Determine how participants can join the audio portion of the meeting.



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

def audio
  @audio
end

#authentication_domains ⇒ Object

Meeting authentication domains. This option, allows you to specify the rule so that Zoom users, whose email address contains a certain domain, can join the Webinar. You can either provide multiple domains, using a comma in between and/or use a wildcard for listing domains.



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

def authentication_domains
  @authentication_domains
end

#authentication_option ⇒ Object

Specify the authentication type for users to join a Webinar with`meeting_authentication` setting set to ‘true`. The value of this field can be retrieved from the `id` field within `authentication_options` array in the response of [Get User Settings API](marketplace.zoom.us/docs/api-reference/zoom-api/users/usersettings).



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

def authentication_option
  @authentication_option
end

#auto_recording ⇒ Object

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



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

def auto_recording
  @auto_recording
end

#close_registration ⇒ Object

Close registration after event date.



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

def close_registration
  @close_registration
end

#contact_email ⇒ Object

Contact email for registration



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

def contact_email
  @contact_email
end

#contact_name ⇒ Object

Contact name for registration



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

def contact_name
  @contact_name
end

#enforce_login ⇒ Object

Only signed-in users can join this meeting.



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

def 
  @enforce_login
end

#enforce_login_domains ⇒ Object

Only signed-in users with specified domains can join meetings.



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

def 
  @enforce_login_domains
end

#global_dial_in_countries ⇒ Object

List of global dial-in countries



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

def global_dial_in_countries
  @global_dial_in_countries
end

#hd_video ⇒ Object

Default to HD video.



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

def hd_video
  @hd_video
end

#host_video ⇒ Object

Start video when host joins webinar.



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

def host_video
  @host_video
end

#meeting_authentication ⇒ Object

Only [authenticated](support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) users can join meeting if the value of this field is set to ‘true`.



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

def meeting_authentication
  @meeting_authentication
end

#on_demand ⇒ Object

Make the webinar on-demand



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

def on_demand
  @on_demand
end

#panelists_video ⇒ Object

Start video when panelists join webinar.



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

def panelists_video
  @panelists_video
end

#post_webinar_survey ⇒ Object

Zoom will open a survey page in attendees’ browsers after leaving the webinar



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

def post_webinar_survey
  @post_webinar_survey
end

#practice_session ⇒ Object

Enable practice session.



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

def practice_session
  @practice_session
end

#registrants_email_notification ⇒ Object

registrants email notification



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

def registrants_email_notification
  @registrants_email_notification
end

#registrants_restrict_number ⇒ Object

Restrict number of registrants for a webinar. By default, it is set to ‘0`. A `0` value means that the restriction option is disabled. Provide a number higher than 0 to restrict the webinar registrants by the that number.



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

def registrants_restrict_number
  @registrants_restrict_number
end

#registration_type ⇒ Object

Registration types. Only used for recurring webinars with a fixed time.
‘1` - Attendees register once and can attend any of the webinar sessions.
`2` - Attendees need to register for each session in order to attend.
`3` - Attendees register once and can choose one or more sessions to attend.



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

def registration_type
  @registration_type
end

#show_share_button ⇒ Object

Show social share buttons on the registration page.



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

def show_share_button
  @show_share_button
end

#survey_url ⇒ Object

Survey url for post webinar survey



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

def survey_url
  @survey_url
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'host_video' => :'host_video',
    :'panelists_video' => :'panelists_video',
    :'practice_session' => :'practice_session',
    :'hd_video' => :'hd_video',
    :'approval_type' => :'approval_type',
    :'registration_type' => :'registration_type',
    :'audio' => :'audio',
    :'auto_recording' => :'auto_recording',
    :'enforce_login' => :'enforce_login',
    :'enforce_login_domains' => :'enforce_login_domains',
    :'alternative_hosts' => :'alternative_hosts',
    :'close_registration' => :'close_registration',
    :'show_share_button' => :'show_share_button',
    :'allow_multiple_devices' => :'allow_multiple_devices',
    :'on_demand' => :'on_demand',
    :'global_dial_in_countries' => :'global_dial_in_countries',
    :'contact_name' => :'contact_name',
    :'contact_email' => :'contact_email',
    :'registrants_restrict_number' => :'registrants_restrict_number',
    :'post_webinar_survey' => :'post_webinar_survey',
    :'survey_url' => :'survey_url',
    :'registrants_email_notification' => :'registrants_email_notification',
    :'meeting_authentication' => :'meeting_authentication',
    :'authentication_option' => :'authentication_option',
    :'authentication_domains' => :'authentication_domains'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'host_video' => :'BOOLEAN',
    :'panelists_video' => :'BOOLEAN',
    :'practice_session' => :'BOOLEAN',
    :'hd_video' => :'BOOLEAN',
    :'approval_type' => :'Integer',
    :'registration_type' => :'Integer',
    :'audio' => :'String',
    :'auto_recording' => :'String',
    :'enforce_login' => :'BOOLEAN',
    :'enforce_login_domains' => :'String',
    :'alternative_hosts' => :'String',
    :'close_registration' => :'BOOLEAN',
    :'show_share_button' => :'BOOLEAN',
    :'allow_multiple_devices' => :'BOOLEAN',
    :'on_demand' => :'BOOLEAN',
    :'global_dial_in_countries' => :'Array<String>',
    :'contact_name' => :'String',
    :'contact_email' => :'String',
    :'registrants_restrict_number' => :'Integer',
    :'post_webinar_survey' => :'BOOLEAN',
    :'survey_url' => :'String',
    :'registrants_email_notification' => :'BOOLEAN',
    :'meeting_authentication' => :'BOOLEAN',
    :'authentication_option' => :'String',
    :'authentication_domains' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/zoom_us/models/create_webinar_settings.rb', line 362

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    host_video == o.host_video &&
    panelists_video == o.panelists_video &&
    practice_session == o.practice_session &&
    hd_video == o.hd_video &&
    approval_type == o.approval_type &&
    registration_type == o.registration_type &&
    audio == o.audio &&
    auto_recording == o.auto_recording &&
     == o. &&
     == o. &&
    alternative_hosts == o.alternative_hosts &&
    close_registration == o.close_registration &&
    show_share_button == o.show_share_button &&
    allow_multiple_devices == o.allow_multiple_devices &&
    on_demand == o.on_demand &&
    global_dial_in_countries == o.global_dial_in_countries &&
    contact_name == o.contact_name &&
    contact_email == o.contact_email &&
    registrants_restrict_number == o.registrants_restrict_number &&
    post_webinar_survey == o.post_webinar_survey &&
    survey_url == o.survey_url &&
    registrants_email_notification == o.registrants_email_notification &&
    meeting_authentication == o.meeting_authentication &&
    authentication_option == o.authentication_option &&
    authentication_domains == o.authentication_domains
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



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/zoom_us/models/create_webinar_settings.rb', line 428

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



494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/zoom_us/models/create_webinar_settings.rb', line 494

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



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/zoom_us/models/create_webinar_settings.rb', line 407

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


394
395
396
 
# File 'lib/zoom_us/models/create_webinar_settings.rb', line 394

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



400
401
402
 
# File 'lib/zoom_us/models/create_webinar_settings.rb', line 400

def hash
  [host_video, panelists_video, practice_session, hd_video, approval_type, registration_type, audio, auto_recording, , , alternative_hosts, close_registration, show_share_button, allow_multiple_devices, on_demand, global_dial_in_countries, contact_name, contact_email, registrants_restrict_number, post_webinar_survey, survey_url, registrants_email_notification, meeting_authentication, authentication_option, authentication_domains].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



301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/zoom_us/models/create_webinar_settings.rb', line 301

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

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

  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



474
475
476
 
# File 'lib/zoom_us/models/create_webinar_settings.rb', line 474

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



480
481
482
483
484
485
486
487
488
 
# File 'lib/zoom_us/models/create_webinar_settings.rb', line 480

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



468
469
470
 
# File 'lib/zoom_us/models/create_webinar_settings.rb', line 468

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



316
317
318
319
320
321
322
323
324
 
# File 'lib/zoom_us/models/create_webinar_settings.rb', line 316

def valid?
  audio_validator = EnumAttributeValidator.new('String', ['both', 'telephony', 'voip'])
  return false unless audio_validator.valid?(@audio)
  auto_recording_validator = EnumAttributeValidator.new('String', ['local', 'cloud', 'none'])
  return false unless auto_recording_validator.valid?(@auto_recording)
  return false if !@registrants_restrict_number.nil? && @registrants_restrict_number > 20000
  return false if !@registrants_restrict_number.nil? && @registrants_restrict_number < 0
  true
end