Class: ZoomUs::Models::InlineResponse20073RecordingFiles

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineResponse20073RecordingFiles

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 82

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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#download_urlObject

The URL using which the recording can be downloaded



37
38
39
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 37

def download_url
  @download_url
end

#file_sizeObject

The size of the recording file in bytes.



31
32
33
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 31

def file_size
  @file_size
end

#file_typeObject

The recording file type. The value of this field could be one of the following:
‘MP4`: Video file of the recording.
`M4A` Audio-only file of the recording.
`TIMELINE`: Timestamp file of the recording.
`TRANSCRIPT`: Transcription file of the recording.
`CHAT`: A TXT file containing in-meeting chat messages that were sent during the meeting.
`CC`: File containing closed captions of the recording.
A recording file object with file type of either `CC` or `TIMELINE` **does not have** the following properties:
`id`, `status`, `file_size`, `recording_type`, and `play_url`.



28
29
30
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 28

def file_type
  @file_type
end

#idObject

Recording ID. Identifier for the recording.



19
20
21
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 19

def id
  @id
end

#meeting_idObject

Universally unique identifier of the meeting instance that was being recorded.



46
47
48
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 46

def meeting_id
  @meeting_id
end

#play_urlObject

The URL using which recording can be played.



34
35
36
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 34

def play_url
  @play_url
end

#recording_endObject

The date and time at which the recording ended.



25
26
27
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 25

def recording_end
  @recording_end
end

#recording_startObject

The date and time at which the recording started.



22
23
24
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 22

def recording_start
  @recording_start
end

#recording_typeObject

The recording type. The value of this field can be one of the following:
‘shared_screen_with_speaker_view(CC)`
`shared_screen_with_speaker_view`
`shared_screen_with_gallery_view`
`speaker_view`
`gallery_view`
`shared_screen`
`audio_only`
`audio_transcript`
`chat_file`
`TIMELINE`



43
44
45
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 43

def recording_type
  @recording_type
end

#statusObject

The status of the recording.



40
41
42
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 40

def status
  @status
end

Class Method Details

.attribute_mapObject

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 49

def self.attribute_map
  {
    :'id' => :'id',
    :'recording_start' => :'recording_start',
    :'recording_end' => :'recording_end',
    :'file_type' => :'file_type',
    :'file_size' => :'file_size',
    :'play_url' => :'play_url',
    :'download_url' => :'download_url',
    :'status' => :'status',
    :'recording_type' => :'recording_type',
    :'meeting_id' => :'meeting_id'
  }
end

.swagger_typesObject

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 65

def self.swagger_types
  {
    :'id' => :'String',
    :'recording_start' => :'String',
    :'recording_end' => :'String',
    :'file_type' => :'String',
    :'file_size' => :'Float',
    :'play_url' => :'String',
    :'download_url' => :'String',
    :'status' => :'String',
    :'recording_type' => :'String',
    :'meeting_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



144
145
146
147
148
149
150
151
152
153
154
155
156
157
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    id == o.id &&
    recording_start == o.recording_start &&
    recording_end == o.recording_end &&
    file_type == o.file_type &&
    file_size == o.file_size &&
    play_url == o.play_url &&
    download_url == o.download_url &&
    status == o.status &&
    recording_type == o.recording_type &&
    meeting_id == o.meeting_id
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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 195

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



261
262
263
264
265
266
267
268
269
270
271
272
273
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 261

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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 174

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


161
162
163
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 161

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



167
168
169
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 167

def hash
  [id, recording_start, recording_end, file_type, file_size, play_url, download_url, status, recording_type, meeting_id].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



131
132
133
134
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 131

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



241
242
243
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 241

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



247
248
249
250
251
252
253
254
255
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 247

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



235
236
237
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 235

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



138
139
140
# File 'lib/zoom_us/models/inline_response_200_73_recording_files.rb', line 138

def valid?
  true
end