Class: Twilio::REST::Video::V1::RecordingInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/video/v1/recording.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ RecordingInstance

Initialize the RecordingInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • sid (String) (defaults to: nil) —

    The sid



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 239

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'status' => payload['status'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'sid' => payload['sid'],
      'source_sid' => payload['source_sid'],
      'size' => payload['size'] == nil ? payload['size'] : payload['size'].to_i,
      'url' => payload['url'],
      'type' => payload['type'],
      'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
      'container_format' => payload['container_format'],
      'codec' => payload['codec'],
      'grouping_sids' => payload['grouping_sids'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



282
283
284
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 282

def 
  @properties['account_sid']
end

#codec ⇒ recording.Codec

Returns The codec.

Returns:

  • (recording.Codec) —

    The codec



342
343
344
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 342

def codec
  @properties['codec']
end

#container_format ⇒ recording.Format

Returns The container_format.

Returns:

  • (recording.Format) —

    The container_format



336
337
338
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 336

def container_format
  @properties['container_format']
end

#context ⇒ RecordingContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



270
271
272
273
274
275
276
277
278
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 270

def context
  unless @instance_context
    @instance_context = RecordingContext.new(
        @version,
        @params['sid'],
    )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



294
295
296
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 294

def date_created
  @properties['date_created']
end

#delete ⇒ Boolean

Deletes the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



368
369
370
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 368

def delete
  context.delete
end

#duration ⇒ String

Returns The duration.

Returns:

  • (String) —

    The duration



330
331
332
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 330

def duration
  @properties['duration']
end

#fetch ⇒ RecordingInstance

Fetch a RecordingInstance

Returns:



361
362
363
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 361

def fetch
  context.fetch
end

#grouping_sids ⇒ Hash

Returns The grouping_sids.

Returns:

  • (Hash) —

    The grouping_sids



348
349
350
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 348

def grouping_sids
  @properties['grouping_sids']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



381
382
383
384
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 381

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Video.V1.RecordingInstance #{values}>"
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



354
355
356
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 354

def links
  @properties['links']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



300
301
302
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 300

def sid
  @properties['sid']
end

#size ⇒ String

Returns The size.

Returns:

  • (String) —

    The size



312
313
314
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 312

def size
  @properties['size']
end

#source_sid ⇒ String

Returns The source_sid.

Returns:

  • (String) —

    The source_sid



306
307
308
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 306

def source_sid
  @properties['source_sid']
end

#status ⇒ recording.Status

Returns The status.

Returns:

  • (recording.Status) —

    The status



288
289
290
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 288

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



374
375
376
377
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 374

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Video.V1.RecordingInstance #{values}>"
end

#type ⇒ recording.Type

Returns The type.

Returns:

  • (recording.Type) —

    The type



324
325
326
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 324

def type
  @properties['type']
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



318
319
320
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 318

def url
  @properties['url']
end