class ZoomUs::Models::AccountSettingsScheduleMeting

Account Settings: Schedule Meeting.

Attributes

audio_type[RW]

Determine how participants can join the audio portion of the meeting.
`both` - Telephony and VoIP.
`telephony` - Audio PSTN telephony only.
`voip` - VoIP only.
`thirdParty` - 3rd party audio conference.

enforce_login[RW]

Only Zoom users who are signed in can join meetings.

enforce_login_domains[RW]

Only signed in users with a specified domain can join the meeting.

enforce_login_with_domains[RW]

Only signed in users with a specific domain can join meetings.

force_pmi_jbh_password[RW]

Require a password for Personal Meetings if attendees can join before host.

host_video[RW]

Start meetings with the host video on.

join_before_host[RW]

Allow participants to join the meeting before the host arrives.

not_store_meeting_topic[RW]

Always display "Zoom Meeting" as the meeting topic.

participant_video[RW]

Start meetings with the participant video on. Participants can change this setting during the meeting.

require_password_for_instant_meetings[RW]

Require a password for instant meetings. If you use PMI for your instant meetings, this option will be disabled.

require_password_for_pmi_meetings[RW]

Require a password for a meeting held using Personal Meeting ID (PMI)

require_password_for_scheduled_meetings[RW]

Require a password for meetings which have already been scheduled

require_password_for_scheduling_new_meetings[RW]

Require a password when scheduling new meetings. This setting applies for regular meetings that do not use PMI. If enabled, a password will be generated while a host schedules a new meeting and participants will be required to enter the password before they can join the meeting.

use_pmi_for_instant_meetings[RW]

Use Personal Meeting ID (PMI) when starting an instant meeting

use_pmi_for_scheduled_meetings[RW]

Use Personal Meeting ID (PMI) when scheduling a meeting

Public Class Methods

attribute_map() click to toggle source

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

# File lib/zoom_us/models/account_settings_schedule_meting.rb, line 87
def self.attribute_map
  {
    :'host_video' => :'host_video',
    :'participant_video' => :'participant_video',
    :'audio_type' => :'audio_type',
    :'join_before_host' => :'join_before_host',
    :'enforce_login' => :'enforce_login',
    :'enforce_login_with_domains' => :'enforce_login_with_domains',
    :'enforce_login_domains' => :'enforce_login_domains',
    :'not_store_meeting_topic' => :'not_store_meeting_topic',
    :'force_pmi_jbh_password' => :'force_pmi_jbh_password',
    :'use_pmi_for_scheduled_meetings' => :'use_pmi_for_scheduled_meetings',
    :'use_pmi_for_instant_meetings' => :'use_pmi_for_instant_meetings',
    :'require_password_for_scheduling_new_meetings' => :'require_password_for_scheduling_new_meetings',
    :'require_password_for_scheduled_meetings' => :'require_password_for_scheduled_meetings',
    :'require_password_for_instant_meetings' => :'require_password_for_instant_meetings',
    :'require_password_for_pmi_meetings' => :'require_password_for_pmi_meetings'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/zoom_us/models/account_settings_schedule_meting.rb, line 130
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?(:'participant_video')
    self.participant_video = attributes[:'participant_video']
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'require_password_for_pmi_meetings')
    self.require_password_for_pmi_meetings = attributes[:'require_password_for_pmi_meetings']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/zoom_us/models/account_settings_schedule_meting.rb, line 108
def self.swagger_types
  {
    :'host_video' => :'BOOLEAN',
    :'participant_video' => :'BOOLEAN',
    :'audio_type' => :'String',
    :'join_before_host' => :'BOOLEAN',
    :'enforce_login' => :'BOOLEAN',
    :'enforce_login_with_domains' => :'BOOLEAN',
    :'enforce_login_domains' => :'String',
    :'not_store_meeting_topic' => :'BOOLEAN',
    :'force_pmi_jbh_password' => :'BOOLEAN',
    :'use_pmi_for_scheduled_meetings' => :'BOOLEAN',
    :'use_pmi_for_instant_meetings' => :'BOOLEAN',
    :'require_password_for_scheduling_new_meetings' => :'BOOLEAN',
    :'require_password_for_scheduled_meetings' => :'BOOLEAN',
    :'require_password_for_instant_meetings' => :'BOOLEAN',
    :'require_password_for_pmi_meetings' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/zoom_us/models/account_settings_schedule_meting.rb, line 238
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    host_video == o.host_video &&
    participant_video == o.participant_video &&
    audio_type == o.audio_type &&
    join_before_host == o.join_before_host &&
    enforce_login == o.enforce_login &&
    enforce_login_with_domains == o.enforce_login_with_domains &&
    enforce_login_domains == o.enforce_login_domains &&
    not_store_meeting_topic == o.not_store_meeting_topic &&
    force_pmi_jbh_password == o.force_pmi_jbh_password &&
    use_pmi_for_scheduled_meetings == o.use_pmi_for_scheduled_meetings &&
    use_pmi_for_instant_meetings == o.use_pmi_for_instant_meetings &&
    require_password_for_scheduling_new_meetings == o.require_password_for_scheduling_new_meetings &&
    require_password_for_scheduled_meetings == o.require_password_for_scheduled_meetings &&
    require_password_for_instant_meetings == o.require_password_for_instant_meetings &&
    require_password_for_pmi_meetings == o.require_password_for_pmi_meetings
end
_deserialize(type, value) click to toggle source

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/account_settings_schedule_meting.rb, line 294
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) click to toggle source

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/account_settings_schedule_meting.rb, line 360
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
audio_type=(audio_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] audio_type Object to be assigned

# File lib/zoom_us/models/account_settings_schedule_meting.rb, line 218
def audio_type=(audio_type)
  validator = EnumAttributeValidator.new('String', ['both', 'telephony', 'voip', 'thirdParty'])
  unless validator.valid?(audio_type)
    fail ArgumentError, 'invalid value for "audio_type", must be one of #{validator.allowable_values}.'
  end
  @audio_type = audio_type
end
build_from_hash(attributes) click to toggle source

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/account_settings_schedule_meting.rb, line 273
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/zoom_us/models/account_settings_schedule_meting.rb, line 260
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/zoom_us/models/account_settings_schedule_meting.rb, line 266
def hash
  [host_video, participant_video, audio_type, join_before_host, enforce_login, enforce_login_with_domains, enforce_login_domains, not_store_meeting_topic, force_pmi_jbh_password, use_pmi_for_scheduled_meetings, use_pmi_for_instant_meetings, require_password_for_scheduling_new_meetings, require_password_for_scheduled_meetings, require_password_for_instant_meetings, require_password_for_pmi_meetings].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/zoom_us/models/account_settings_schedule_meting.rb, line 201
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
require_password_for_pmi_meetings=(require_password_for_pmi_meetings) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] require_password_for_pmi_meetings Object to be assigned

# File lib/zoom_us/models/account_settings_schedule_meting.rb, line 228
def require_password_for_pmi_meetings=(require_password_for_pmi_meetings)
  validator = EnumAttributeValidator.new('String', ['jbh_only', 'all', 'none'])
  unless validator.valid?(require_password_for_pmi_meetings)
    fail ArgumentError, 'invalid value for "require_password_for_pmi_meetings", must be one of #{validator.allowable_values}.'
  end
  @require_password_for_pmi_meetings = require_password_for_pmi_meetings
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/zoom_us/models/account_settings_schedule_meting.rb, line 340
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/zoom_us/models/account_settings_schedule_meting.rb, line 346
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/zoom_us/models/account_settings_schedule_meting.rb, line 334
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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/account_settings_schedule_meting.rb, line 208
def valid?
  audio_type_validator = EnumAttributeValidator.new('String', ['both', 'telephony', 'voip', 'thirdParty'])
  return false unless audio_type_validator.valid?(@audio_type)
  require_password_for_pmi_meetings_validator = EnumAttributeValidator.new('String', ['jbh_only', 'all', 'none'])
  return false unless require_password_for_pmi_meetings_validator.valid?(@require_password_for_pmi_meetings)
  true
end