class ZoomUs::Models::MeetingMetrics

Meeting metric details.

Attributes

dept[RW]

Department of the host.

duration[RW]

Meeting duration.

email[RW]

Email address of the host.

end_time[RW]

Meeting end time.

has_3rd_party_audio[RW]

Indicates whether or not [third party audio](support.zoom.us/hc/en-us/articles/202470795-3rd-Party-Audio-Conference) was used in the meeting.

has_pstn[RW]

Indicates whether or not the PSTN was used in the meeting.

has_recording[RW]

Indicates whether or not the recording feature was used in the meeting.

has_screen_share[RW]

Indicates whether or not screenshare feature was used in the meeting.

has_sip[RW]

Indicates whether or not someone joined the meeting using SIP.

has_video[RW]

Indicates whether or not video was used in the meeting.

has_voip[RW]

Indicates whether or not VoIP was used in the meeting.

host[RW]

Host display name.

id[RW]

Meeting ID.

in_room_participants[RW]

The number of Zoom Room participants in the meeting.

participants[RW]

Meeting participant count.

start_time[RW]

Meeting start time.

topic[RW]

Meeting topic.

user_type[RW]

License type of the user.

uuid[RW]

Meeting UUID. Please double encode your UUID when using it for API calls if the UUID begins with a '/'or contains '//' in it.

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_metrics.rb, line 77
def self.attribute_map
  {
    :'uuid' => :'uuid',
    :'id' => :'id',
    :'topic' => :'topic',
    :'host' => :'host',
    :'email' => :'email',
    :'user_type' => :'user_type',
    :'start_time' => :'start_time',
    :'end_time' => :'end_time',
    :'duration' => :'duration',
    :'participants' => :'participants',
    :'has_pstn' => :'has_pstn',
    :'has_voip' => :'has_voip',
    :'has_3rd_party_audio' => :'has_3rd_party_audio',
    :'has_video' => :'has_video',
    :'has_screen_share' => :'has_screen_share',
    :'has_recording' => :'has_recording',
    :'has_sip' => :'has_sip',
    :'in_room_participants' => :'in_room_participants',
    :'dept' => :'dept'
  }
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_metrics.rb, line 128
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?(:'uuid')
    self.uuid = attributes[:'uuid']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/zoom_us/models/meeting_metrics.rb, line 102
def self.swagger_types
  {
    :'uuid' => :'String',
    :'id' => :'Integer',
    :'topic' => :'String',
    :'host' => :'String',
    :'email' => :'String',
    :'user_type' => :'String',
    :'start_time' => :'DateTime',
    :'end_time' => :'DateTime',
    :'duration' => :'String',
    :'participants' => :'Integer',
    :'has_pstn' => :'BOOLEAN',
    :'has_voip' => :'BOOLEAN',
    :'has_3rd_party_audio' => :'BOOLEAN',
    :'has_video' => :'BOOLEAN',
    :'has_screen_share' => :'BOOLEAN',
    :'has_recording' => :'BOOLEAN',
    :'has_sip' => :'BOOLEAN',
    :'in_room_participants' => :'Integer',
    :'dept' => :'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/meeting_metrics.rb, line 226
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    uuid == o.uuid &&
    id == o.id &&
    topic == o.topic &&
    host == o.host &&
    email == o.email &&
    user_type == o.user_type &&
    start_time == o.start_time &&
    end_time == o.end_time &&
    duration == o.duration &&
    participants == o.participants &&
    has_pstn == o.has_pstn &&
    has_voip == o.has_voip &&
    has_3rd_party_audio == o.has_3rd_party_audio &&
    has_video == o.has_video &&
    has_screen_share == o.has_screen_share &&
    has_recording == o.has_recording &&
    has_sip == o.has_sip &&
    in_room_participants == o.in_room_participants &&
    dept == o.dept
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_metrics.rb, line 286
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_metrics.rb, line 352
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_metrics.rb, line 265
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_metrics.rb, line 252
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_metrics.rb, line 258
def hash
  [uuid, id, topic, host, email, user_type, start_time, end_time, duration, participants, has_pstn, has_voip, has_3rd_party_audio, has_video, has_screen_share, has_recording, has_sip, in_room_participants, dept].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_metrics.rb, line 213
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/meeting_metrics.rb, line 332
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_metrics.rb, line 338
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_metrics.rb, line 326
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_metrics.rb, line 220
def valid?
  true
end