Class: ZoomUs::Models::MeetingMetrics

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/models/meeting_metrics.rb

Overview

Meeting metric details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MeetingMetrics

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# 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

Instance Attribute Details

#dept ⇒ Object

Department of the host.



74
75
76
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 74

def dept
  @dept
end

#duration ⇒ Object

Meeting duration.



44
45
46
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 44

def duration
  @duration
end

#email ⇒ Object

Email address of the host.



32
33
34
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 32

def email
  @email
end

#end_time ⇒ Object

Meeting end time.



41
42
43
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 41

def end_time
  @end_time
end

#has_3rd_party_audio ⇒ Object

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



56
57
58
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 56

def has_3rd_party_audio
  @has_3rd_party_audio
end

#has_pstn ⇒ Object

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



50
51
52
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 50

def has_pstn
  @has_pstn
end

#has_recording ⇒ Object

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



65
66
67
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 65

def has_recording
  @has_recording
end

#has_screen_share ⇒ Object

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



62
63
64
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 62

def has_screen_share
  @has_screen_share
end

#has_sip ⇒ Object

Indicates whether or not someone joined the meeting using SIP.



68
69
70
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 68

def has_sip
  @has_sip
end

#has_video ⇒ Object

Indicates whether or not video was used in the meeting.



59
60
61
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 59

def has_video
  @has_video
end

#has_voip ⇒ Object

Indicates whether or not VoIP was used in the meeting.



53
54
55
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 53

def has_voip
  @has_voip
end

#host ⇒ Object

Host display name.



29
30
31
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 29

def host
  @host
end

#id ⇒ Object

Meeting ID.



23
24
25
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 23

def id
  @id
end

#in_room_participants ⇒ Object

The number of Zoom Room participants in the meeting.



71
72
73
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 71

def in_room_participants
  @in_room_participants
end

#participants ⇒ Object

Meeting participant count.



47
48
49
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 47

def participants
  @participants
end

#start_time ⇒ Object

Meeting start time.



38
39
40
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 38

def start_time
  @start_time
end

#topic ⇒ Object

Meeting topic.



26
27
28
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 26

def topic
  @topic
end

#user_type ⇒ Object

License type of the user.



35
36
37
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 35

def user_type
  @user_type
end

#uuid ⇒ Object

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



20
21
22
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 20

def uuid
  @uuid
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# 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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


252
253
254
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 252

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



258
259
260
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



213
214
215
216
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 213

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



332
333
334
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 332

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



338
339
340
341
342
343
344
345
346
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



326
327
328
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 326

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



220
221
222
 
# File 'lib/zoom_us/models/meeting_metrics.rb', line 220

def valid?
  true
end