class ZoomUs::Models::MeetingInfoGet

Meeting object.

Attributes

agenda[RW]

Agenda.

created_at[RW]

Time of creation.

duration[RW]

Meeting duration.

encrypted_password[RW]

Encrypted password for third party endpoints (H323/SIP).

h323_password[RW]

H.323/SIP room system password.

join_url[RW]

Join URL.

occurrences[RW]

Array of occurrence objects.

password[RW]

Meeting password.

pmi[RW]

Personal Meeting Id. Only used for scheduled meetings and recurring meetings with no fixed time.

recurrence[RW]
settings[RW]
start_time[RW]

Meeting start time.

start_url[RW]


<aside>The start_url of a Meeting is a URL using which a host or an alternative host can start the Meeting. The expiration time for the start_url field listed in the response of [Create a Meeting API](marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate) is two hours for all regular users. For users created using the custCreate option via the [Create Users](marketplace.zoom.us/docs/api-reference/zoom-api/users/usercreate) API, the expiration time of the start_url field is 90 days. For security reasons, to retrieve the updated value for the start_url field programmatically (after the expiry time), you must call the [Retrieve a Meeting API](marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meeting) and refer to the value of the start_url field in the response.</aside>

status[RW]

Meeting status

timezone[RW]

Timezone to format the meeting start time.

topic[RW]

Meeting topic.

tracking_fields[RW]

Tracking fields

type[RW]

Meeting Types:
`1` - Instant meeting.
`2` - Scheduled meeting.
`3` - Recurring meeting with no fixed time.
`8` - Recurring meeting with a fixed time.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/zoom_us/models/meeting_info_get.rb, line 94
def self.attribute_map
  {
    :'topic' => :'topic',
    :'type' => :'type',
    :'status' => :'status',
    :'start_time' => :'start_time',
    :'duration' => :'duration',
    :'timezone' => :'timezone',
    :'created_at' => :'created_at',
    :'agenda' => :'agenda',
    :'start_url' => :'start_url',
    :'join_url' => :'join_url',
    :'password' => :'password',
    :'h323_password' => :'h323_password',
    :'encrypted_password' => :'encrypted_password',
    :'pmi' => :'pmi',
    :'tracking_fields' => :'tracking_fields',
    :'occurrences' => :'occurrences',
    :'settings' => :'settings',
    :'recurrence' => :'recurrence'
  }
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/meeting_info_get.rb, line 143
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?(:'topic')
    self.topic = attributes[:'topic']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/zoom_us/models/meeting_info_get.rb, line 118
def self.swagger_types
  {
    :'topic' => :'String',
    :'type' => :'Integer',
    :'status' => :'String',
    :'start_time' => :'DateTime',
    :'duration' => :'Integer',
    :'timezone' => :'String',
    :'created_at' => :'DateTime',
    :'agenda' => :'String',
    :'start_url' => :'String',
    :'join_url' => :'String',
    :'password' => :'String',
    :'h323_password' => :'String',
    :'encrypted_password' => :'String',
    :'pmi' => :'Integer',
    :'tracking_fields' => :'Array<UsersuserIdmeetingsTrackingFields>',
    :'occurrences' => :'Array<InlineResponse20110Occurrences>',
    :'settings' => :'InlineResponse20110Settings',
    :'recurrence' => :'UsersuserIdmeetingsRecurrence'
  }
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/meeting_info_get.rb, line 253
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    topic == o.topic &&
    type == o.type &&
    status == o.status &&
    start_time == o.start_time &&
    duration == o.duration &&
    timezone == o.timezone &&
    created_at == o.created_at &&
    agenda == o.agenda &&
    start_url == o.start_url &&
    join_url == o.join_url &&
    password == o.password &&
    h323_password == o.h323_password &&
    encrypted_password == o.encrypted_password &&
    pmi == o.pmi &&
    tracking_fields == o.tracking_fields &&
    occurrences == o.occurrences &&
    settings == o.settings &&
    recurrence == o.recurrence
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/meeting_info_get.rb, line 312
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/meeting_info_get.rb, line 378
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/meeting_info_get.rb, line 291
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/meeting_info_get.rb, line 278
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/meeting_info_get.rb, line 284
def hash
  [topic, type, status, start_time, duration, timezone, created_at, agenda, start_url, join_url, password, h323_password, encrypted_password, pmi, tracking_fields, occurrences, settings, recurrence].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/meeting_info_get.rb, line 228
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
status=(status) click to toggle source

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

# File lib/zoom_us/models/meeting_info_get.rb, line 243
def status=(status)
  validator = EnumAttributeValidator.new('String', ['waiting', 'started', 'finished'])
  unless validator.valid?(status)
    fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
  end
  @status = status
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/meeting_info_get.rb, line 358
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/meeting_info_get.rb, line 364
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/meeting_info_get.rb, line 352
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/meeting_info_get.rb, line 235
def valid?
  status_validator = EnumAttributeValidator.new('String', ['waiting', 'started', 'finished'])
  return false unless status_validator.valid?(@status)
  true
end