class ZoomUs::Models::WebinarSettings
Webinar
settings.
Attributes
Allow attendees to join from multiple devices.
Alternative host emails or IDs. Multiple values separated by comma.
`0` - Automatically approve.
`1` - Manually approve.
`2` - No registration required.
Determine how participants can join the audio portion of the webinar.
Meeting
authentication domains
Meeting
authentication option id
Automatic recording:
`local` - Record on local.
`cloud` - Record on cloud.
`none` - Disabled.
Close registration after event date.
Contact email for registration
Contact name for registration
Only signed-in users can join this webinar.
Only signed-in users with specified domains can join webinars.
List of global dial-in countries
Default to HD video.
Start video when host joins webinar.
Only authenticated users can join meetings
Send notification email to registrants when the host updates a webinar.
Make the webinar on-demand
Start video when panelists join webinar.
Zoom will open a survey page in attendees' browsers after leaving the webinar
Enable practice session.
Send confirmation email to registrants
registrants email notification
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.
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.
Survey url for post webinar survey
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/zoom_us/models/webinar_settings.rb, line 123 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_confirmation_email' => :'registrants_confirmation_email', :'registrants_restrict_number' => :'registrants_restrict_number', :'notify_registrants' => :'notify_registrants', :'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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/zoom_us/models/webinar_settings.rb, line 190 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.enforce_login = attributes[:'enforce_login'] end if attributes.has_key?(:'enforce_login_domains') self.enforce_login_domains = 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_confirmation_email') self.registrants_confirmation_email = attributes[:'registrants_confirmation_email'] end if attributes.has_key?(:'registrants_restrict_number') self.registrants_restrict_number = attributes[:'registrants_restrict_number'] end if attributes.has_key?(:'notify_registrants') self.notify_registrants = attributes[:'notify_registrants'] 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
Attribute type mapping.
# File lib/zoom_us/models/webinar_settings.rb, line 156 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_confirmation_email' => :'BOOLEAN', :'registrants_restrict_number' => :'Integer', :'notify_registrants' => :'BOOLEAN', :'post_webinar_survey' => :'BOOLEAN', :'survey_url' => :'String', :'registrants_email_notification' => :'BOOLEAN', :'meeting_authentication' => :'BOOLEAN', :'authentication_option' => :'String', :'authentication_domains' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/zoom_us/models/webinar_settings.rb, line 380 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 && enforce_login == o.enforce_login && enforce_login_domains == o.enforce_login_domains && 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_confirmation_email == o.registrants_confirmation_email && registrants_restrict_number == o.registrants_restrict_number && notify_registrants == o.notify_registrants && 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/zoom_us/models/webinar_settings.rb, line 448 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/zoom_us/models/webinar_settings.rb, line 514 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
Custom attribute writer method checking allowed values (enum). @param [Object] audio Object to be assigned
# File lib/zoom_us/models/webinar_settings.rb, line 346 def audio=(audio) validator = EnumAttributeValidator.new('String', ['both', 'telephony', 'voip']) unless validator.valid?(audio) fail ArgumentError, 'invalid value for "audio", must be one of #{validator.allowable_values}.' end @audio = audio end
Custom attribute writer method checking allowed values (enum). @param [Object] auto_recording
Object to be assigned
# File lib/zoom_us/models/webinar_settings.rb, line 356 def auto_recording=(auto_recording) validator = EnumAttributeValidator.new('String', ['local', 'cloud', 'none']) unless validator.valid?(auto_recording) fail ArgumentError, 'invalid value for "auto_recording", must be one of #{validator.allowable_values}.' end @auto_recording = auto_recording end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/zoom_us/models/webinar_settings.rb, line 427 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
@see the `==` method @param [Object] Object to be compared
# File lib/zoom_us/models/webinar_settings.rb, line 414 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/zoom_us/models/webinar_settings.rb, line 420 def hash [host_video, panelists_video, practice_session, hd_video, approval_type, registration_type, audio, auto_recording, enforce_login, enforce_login_domains, alternative_hosts, close_registration, show_share_button, allow_multiple_devices, on_demand, global_dial_in_countries, contact_name, contact_email, registrants_confirmation_email, registrants_restrict_number, notify_registrants, post_webinar_survey, survey_url, registrants_email_notification, meeting_authentication, authentication_option, authentication_domains].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/zoom_us/models/webinar_settings.rb, line 319 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
Custom attribute writer method with validation @param [Object] registrants_restrict_number
Value to be assigned
# File lib/zoom_us/models/webinar_settings.rb, line 366 def registrants_restrict_number=(registrants_restrict_number) if !registrants_restrict_number.nil? && registrants_restrict_number > 20000 fail ArgumentError, 'invalid value for "registrants_restrict_number", must be smaller than or equal to 20000.' end if !registrants_restrict_number.nil? && registrants_restrict_number < 0 fail ArgumentError, 'invalid value for "registrants_restrict_number", must be greater than or equal to 0.' end @registrants_restrict_number = registrants_restrict_number end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/zoom_us/models/webinar_settings.rb, line 500 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/zoom_us/models/webinar_settings.rb, line 488 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/zoom_us/models/webinar_settings.rb, line 334 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