class ZoomUs::Models::AccountSettingsRecording

Account Settings: Recording.

Attributes

account_user_access_recording[RW]

Cloud recordings are only accessible to account members. People outside of your organization cannot open links that provide access to cloud recordings.

auto_delete_cmr[RW]

Allow Zoom to permanantly delete recordings automatically after a specified number of days.

auto_delete_cmr_days[RW]

When `auto_delete_cmr` function is 'true' this value will set the number of days before the auto deletion of cloud recordings.

auto_recording[RW]

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

cloud_recording[RW]

Allow hosts to record and save the meeting in the cloud.

cloud_recording_download[RW]

Cloud recording downloads.

cloud_recording_download_host[RW]

Only the host can download cloud recordings.

local_recording[RW]

Allow hosts and participants to record the meeting using a local file.

record_audio_file[RW]

Record an audio only file.

record_speaker_view[RW]

Record the active speaker with a shared screen.

recording_audio_transcript[RW]

Automatically transcribe the audio of the meeting or webinar to the cloud.

save_chat_text[RW]

Save the chat text from the meeting.

show_timestamp[RW]

Add a timestamp to the recording.

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_recording.rb, line 84
def self.attribute_map
  {
    :'local_recording' => :'local_recording',
    :'cloud_recording' => :'cloud_recording',
    :'record_speaker_view' => :'record_speaker_view',
    :'record_gallery_view' => :'record_gallery_view',
    :'record_audio_file' => :'record_audio_file',
    :'save_chat_text' => :'save_chat_text',
    :'show_timestamp' => :'show_timestamp',
    :'recording_audio_transcript' => :'recording_audio_transcript',
    :'auto_recording' => :'auto_recording',
    :'cloud_recording_download' => :'cloud_recording_download',
    :'cloud_recording_download_host' => :'cloud_recording_download_host',
    :'account_user_access_recording' => :'account_user_access_recording',
    :'auto_delete_cmr' => :'auto_delete_cmr',
    :'auto_delete_cmr_days' => :'auto_delete_cmr_days'
  }
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_recording.rb, line 125
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?(:'local_recording')
    self.local_recording = attributes[:'local_recording']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/zoom_us/models/account_settings_recording.rb, line 104
def self.swagger_types
  {
    :'local_recording' => :'BOOLEAN',
    :'cloud_recording' => :'BOOLEAN',
    :'record_speaker_view' => :'BOOLEAN',
    :'record_gallery_view' => :'BOOLEAN',
    :'record_audio_file' => :'BOOLEAN',
    :'save_chat_text' => :'BOOLEAN',
    :'show_timestamp' => :'BOOLEAN',
    :'recording_audio_transcript' => :'BOOLEAN',
    :'auto_recording' => :'String',
    :'cloud_recording_download' => :'BOOLEAN',
    :'cloud_recording_download_host' => :'BOOLEAN',
    :'account_user_access_recording' => :'BOOLEAN',
    :'auto_delete_cmr' => :'BOOLEAN',
    :'auto_delete_cmr_days' => :'Integer'
  }
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_recording.rb, line 215
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    local_recording == o.local_recording &&
    cloud_recording == o.cloud_recording &&
    record_speaker_view == o.record_speaker_view &&
    record_gallery_view == o.record_gallery_view &&
    record_audio_file == o.record_audio_file &&
    save_chat_text == o.save_chat_text &&
    show_timestamp == o.show_timestamp &&
    recording_audio_transcript == o.recording_audio_transcript &&
    auto_recording == o.auto_recording &&
    cloud_recording_download == o.cloud_recording_download &&
    cloud_recording_download_host == o.cloud_recording_download_host &&
    account_user_access_recording == o.account_user_access_recording &&
    auto_delete_cmr == o.auto_delete_cmr &&
    auto_delete_cmr_days == o.auto_delete_cmr_days
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_recording.rb, line 270
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_recording.rb, line 336
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
auto_recording=(auto_recording) click to toggle source

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

# File lib/zoom_us/models/account_settings_recording.rb, line 205
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
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_recording.rb, line 249
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_recording.rb, line 236
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_recording.rb, line 242
def hash
  [local_recording, cloud_recording, record_speaker_view, record_gallery_view, record_audio_file, save_chat_text, show_timestamp, recording_audio_transcript, auto_recording, cloud_recording_download, cloud_recording_download_host, account_user_access_recording, auto_delete_cmr, auto_delete_cmr_days].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_recording.rb, line 190
def list_invalid_properties
  invalid_properties = Array.new
  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_recording.rb, line 316
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_recording.rb, line 322
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_recording.rb, line 310
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_recording.rb, line 197
def valid?
  auto_recording_validator = EnumAttributeValidator.new('String', ['local', 'cloud', 'none'])
  return false unless auto_recording_validator.valid?(@auto_recording)
  true
end