class ZoomUs::Models::AccountSettingsInMeeting

Account Settings: In Meeting.

Attributes

alert_guest_join[RW]

Identify guest participants in a meeting or webinar.

allow_live_streaming[RW]

Allow live streaming.

allow_show_zoom_windows[RW]

Show the Zoom desktop application when sharing screens.

annotation[RW]

Allow participants to use annotation tools to add information to shared screens.

anonymous_question_answer[RW]

Allow an anonymous Q&A in a webinar.

attendee_on_hold[RW]

Allow hosts to temporarily remove an attendee from a meeting.

attention_tracking[RW]

Allows the host to see an indicator in the participant panel if a meeting or webinar attendee does not have Zoom in focus while screen sharing.

auto_answer[RW]

Enable users to see and add contacts to the "auto-answer group" in the chat contact list. Any call from members of this group will automatically be answered.

auto_saving_chat[RW]

Automatically save all in-meeting chats so that the host does not need to manually save the chat transcript after the meeting starts.

breakout_room[RW]

Allow host to split meeting participants into separate, smaller rooms.

chat[RW]

Allow meeting participants to send a message that is visible to all participants.

closed_caption[RW]

Allow a host to type closed captions. Enable a host to assign a participant or third party device to add closed captions.

co_host[RW]

Allow the host to add co-hosts.

custom_live_streaming[RW]

Custom live streaming.

custom_service_instructions[RW]

Custom service instructions.

dscp_audio[RW]

DSCP audio.

dscp_marking[RW]

DSCP marking.

dscp_video[RW]

DSCP video.

e2e_encryption[RW]

Require that all meetings are encrypted using AES.

entry_exit_chime[RW]

Play sound when participants join or leave.
`host` - Heard by host only.
`all` - Heard by host and all attendees.
`none` - Disable.

far_end_camera_control[RW]

Allow another user to take control of your camera during a meeting.

feedback[RW]

Add a "Feedback" tab to the Windows Settings or Mac Preferences dialog. Enable users to provide feedback to Zoom at the end of the meeting.

file_transfer[RW]

Hosts and participants can send files through the in-meeting chat.

group_hd[RW]

Activate higher quality video for host and participants. Please note: This will use more bandwidth.

original_audio[RW]

Allow users to select original sound in their client settings.

p2p_connetion[RW]

Peer to peer connection while only two people are in a meeting.

p2p_ports[RW]

Peer to peer listening ports range.

polling[RW]

Add "Polls" to the meeting controls.

ports_range[RW]

The listening ports range, separated by a comma (ex 55,56). The ports range must be between 1 to 65535.

post_meeting_feedback[RW]

Display a thumbs up or down survey at the end of each meeting.

private_chat[RW]

Allow a meeting participant to send a private message to another participant.

record_play_own_voice[RW]

Record and play their own voice.

remote_control[RW]

Allow users to request remote control.

screen_sharing[RW]

Allow screen sharing.

sending_default_email_invites[RW]

Only show the default email when sending email invites.

show_meeting_control_toolbar[RW]

Always show the meeting control toolbar.

stereo_audio[RW]

Allow users to select stereo audio in their client settings.

use_html_format_email[RW]

Use HTML formatted email for the Outlook plugin.

virtual_background[RW]

Allow users to replace their background with any selected image. Choose or upload an image in the Zoom desktop application settings.

watermark[RW]

Add a watermark when viewing a shared screen.

webinar_question_answer[RW]

Allow a Q&A in a webinar.

whiteboard[RW]

Allow participants to share a whiteboard that includes annotation tools.

workplace_by_facebook[RW]

Workplace by facebook.

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_in_meeting.rb, line 171
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_own_voice' => :'record_play_own_voice',
    :'file_transfer' => :'file_transfer',
    :'feedback' => :'feedback',
    :'post_meeting_feedback' => :'post_meeting_feedback',
    :'co_host' => :'co_host',
    :'polling' => :'polling',
    :'attendee_on_hold' => :'attendee_on_hold',
    :'show_meeting_control_toolbar' => :'show_meeting_control_toolbar',
    :'allow_show_zoom_windows' => :'allow_show_zoom_windows',
    :'annotation' => :'annotation',
    :'whiteboard' => :'whiteboard',
    :'webinar_question_answer' => :'webinar_question_answer',
    :'anonymous_question_answer' => :'anonymous_question_answer',
    :'breakout_room' => :'breakout_room',
    :'closed_caption' => :'closed_caption',
    :'far_end_camera_control' => :'far_end_camera_control',
    :'group_hd' => :'group_hd',
    :'virtual_background' => :'virtual_background',
    :'watermark' => :'watermark',
    :'alert_guest_join' => :'alert_guest_join',
    :'auto_answer' => :'auto_answer',
    :'p2p_connetion' => :'p2p_connetion',
    :'p2p_ports' => :'p2p_ports',
    :'ports_range' => :'ports_range',
    :'sending_default_email_invites' => :'sending_default_email_invites',
    :'use_html_format_email' => :'use_html_format_email',
    :'dscp_marking' => :'dscp_marking',
    :'dscp_audio' => :'dscp_audio',
    :'dscp_video' => :'dscp_video',
    :'stereo_audio' => :'stereo_audio',
    :'original_audio' => :'original_audio',
    :'screen_sharing' => :'screen_sharing',
    :'remote_control' => :'remote_control',
    :'attention_tracking' => :'attention_tracking',
    :'allow_live_streaming' => :'allow_live_streaming',
    :'workplace_by_facebook' => :'workplace_by_facebook',
    :'custom_live_streaming' => :'custom_live_streaming',
    :'custom_service_instructions' => :'custom_service_instructions'
  }
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_in_meeting.rb, line 270
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']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'attention_tracking')
    self.attention_tracking = attributes[:'attention_tracking']
  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
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/zoom_us/models/account_settings_in_meeting.rb, line 220
def self.swagger_types
  {
    :'e2e_encryption' => :'BOOLEAN',
    :'chat' => :'BOOLEAN',
    :'private_chat' => :'BOOLEAN',
    :'auto_saving_chat' => :'BOOLEAN',
    :'entry_exit_chime' => :'String',
    :'record_play_own_voice' => :'BOOLEAN',
    :'file_transfer' => :'BOOLEAN',
    :'feedback' => :'BOOLEAN',
    :'post_meeting_feedback' => :'BOOLEAN',
    :'co_host' => :'BOOLEAN',
    :'polling' => :'BOOLEAN',
    :'attendee_on_hold' => :'BOOLEAN',
    :'show_meeting_control_toolbar' => :'BOOLEAN',
    :'allow_show_zoom_windows' => :'BOOLEAN',
    :'annotation' => :'BOOLEAN',
    :'whiteboard' => :'BOOLEAN',
    :'webinar_question_answer' => :'BOOLEAN',
    :'anonymous_question_answer' => :'BOOLEAN',
    :'breakout_room' => :'BOOLEAN',
    :'closed_caption' => :'BOOLEAN',
    :'far_end_camera_control' => :'BOOLEAN',
    :'group_hd' => :'BOOLEAN',
    :'virtual_background' => :'BOOLEAN',
    :'watermark' => :'BOOLEAN',
    :'alert_guest_join' => :'BOOLEAN',
    :'auto_answer' => :'BOOLEAN',
    :'p2p_connetion' => :'BOOLEAN',
    :'p2p_ports' => :'BOOLEAN',
    :'ports_range' => :'String',
    :'sending_default_email_invites' => :'BOOLEAN',
    :'use_html_format_email' => :'BOOLEAN',
    :'dscp_marking' => :'BOOLEAN',
    :'dscp_audio' => :'Integer',
    :'dscp_video' => :'Integer',
    :'stereo_audio' => :'BOOLEAN',
    :'original_audio' => :'BOOLEAN',
    :'screen_sharing' => :'BOOLEAN',
    :'remote_control' => :'BOOLEAN',
    :'attention_tracking' => :'BOOLEAN',
    :'allow_live_streaming' => :'BOOLEAN',
    :'workplace_by_facebook' => :'BOOLEAN',
    :'custom_live_streaming' => :'BOOLEAN',
    :'custom_service_instructions' => :'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_in_meeting.rb, line 526
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_own_voice == o.record_play_own_voice &&
    file_transfer == o.file_transfer &&
    feedback == o.feedback &&
    post_meeting_feedback == o.post_meeting_feedback &&
    co_host == o.co_host &&
    polling == o.polling &&
    attendee_on_hold == o.attendee_on_hold &&
    show_meeting_control_toolbar == o.show_meeting_control_toolbar &&
    allow_show_zoom_windows == o.allow_show_zoom_windows &&
    annotation == o.annotation &&
    whiteboard == o.whiteboard &&
    webinar_question_answer == o.webinar_question_answer &&
    anonymous_question_answer == o.anonymous_question_answer &&
    breakout_room == o.breakout_room &&
    closed_caption == o.closed_caption &&
    far_end_camera_control == o.far_end_camera_control &&
    group_hd == o.group_hd &&
    virtual_background == o.virtual_background &&
    watermark == o.watermark &&
    alert_guest_join == o.alert_guest_join &&
    auto_answer == o.auto_answer &&
    p2p_connetion == o.p2p_connetion &&
    p2p_ports == o.p2p_ports &&
    ports_range == o.ports_range &&
    sending_default_email_invites == o.sending_default_email_invites &&
    use_html_format_email == o.use_html_format_email &&
    dscp_marking == o.dscp_marking &&
    dscp_audio == o.dscp_audio &&
    dscp_video == o.dscp_video &&
    stereo_audio == o.stereo_audio &&
    original_audio == o.original_audio &&
    screen_sharing == o.screen_sharing &&
    remote_control == o.remote_control &&
    attention_tracking == o.attention_tracking &&
    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
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_in_meeting.rb, line 610
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_in_meeting.rb, line 676
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) 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_in_meeting.rb, line 589
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
dscp_audio=(dscp_audio) click to toggle source

Custom attribute writer method with validation @param [Object] dscp_audio Value to be assigned

# File lib/zoom_us/models/account_settings_in_meeting.rb, line 498
def dscp_audio=(dscp_audio)
  if !dscp_audio.nil? && dscp_audio > 63
    fail ArgumentError, 'invalid value for "dscp_audio", must be smaller than or equal to 63.'
  end

  if !dscp_audio.nil? && dscp_audio < 1
    fail ArgumentError, 'invalid value for "dscp_audio", must be greater than or equal to 1.'
  end

  @dscp_audio = dscp_audio
end
dscp_video=(dscp_video) click to toggle source

Custom attribute writer method with validation @param [Object] dscp_video Value to be assigned

# File lib/zoom_us/models/account_settings_in_meeting.rb, line 512
def dscp_video=(dscp_video)
  if !dscp_video.nil? && dscp_video > 63
    fail ArgumentError, 'invalid value for "dscp_video", must be smaller than or equal to 63.'
  end

  if !dscp_video.nil? && dscp_video < 1
    fail ArgumentError, 'invalid value for "dscp_video", must be greater than or equal to 1.'
  end

  @dscp_video = dscp_video
end
entry_exit_chime=(entry_exit_chime) click to toggle source

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

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

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

# File lib/zoom_us/models/account_settings_in_meeting.rb, line 576
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_in_meeting.rb, line 582
def hash
  [e2e_encryption, chat, private_chat, auto_saving_chat, entry_exit_chime, record_play_own_voice, file_transfer, feedback, post_meeting_feedback, co_host, polling, attendee_on_hold, show_meeting_control_toolbar, allow_show_zoom_windows, annotation, whiteboard, webinar_question_answer, anonymous_question_answer, breakout_room, closed_caption, far_end_camera_control, group_hd, virtual_background, watermark, alert_guest_join, auto_answer, p2p_connetion, p2p_ports, ports_range, sending_default_email_invites, use_html_format_email, dscp_marking, dscp_audio, dscp_video, stereo_audio, original_audio, screen_sharing, remote_control, attention_tracking, allow_live_streaming, workplace_by_facebook, custom_live_streaming, custom_service_instructions].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_in_meeting.rb, line 453
def list_invalid_properties
  invalid_properties = Array.new
  if !@dscp_audio.nil? && @dscp_audio > 63
    invalid_properties.push('invalid value for "dscp_audio", must be smaller than or equal to 63.')
  end

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

  if !@dscp_video.nil? && @dscp_video > 63
    invalid_properties.push('invalid value for "dscp_video", must be smaller than or equal to 63.')
  end

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

  invalid_properties
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_in_meeting.rb, line 656
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_in_meeting.rb, line 662
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_in_meeting.rb, line 650
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_in_meeting.rb, line 476
def valid?
  entry_exit_chime_validator = EnumAttributeValidator.new('String', ['host', 'all', 'none'])
  return false unless entry_exit_chime_validator.valid?(@entry_exit_chime)
  return false if !@dscp_audio.nil? && @dscp_audio > 63
  return false if !@dscp_audio.nil? && @dscp_audio < 1
  return false if !@dscp_video.nil? && @dscp_video > 63
  return false if !@dscp_video.nil? && @dscp_video < 1
  true
end