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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 228

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



266
267
268
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 266

def 
  @properties['account_sid']
end

#codec ⇒ recording.Codec

Returns The codec.

Returns:

  • (recording.Codec) —

    The codec



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

def codec
  @properties['codec']
end

#container_format ⇒ recording.Format

Returns The container_format.

Returns:

  • (recording.Format) —

    The container_format



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

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:



257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 257

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



278
279
280
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 278

def date_created
  @properties['date_created']
end

#delete ⇒ Boolean

Deletes the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#duration ⇒ String

Returns The duration.

Returns:

  • (String) —

    The duration



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

def duration
  @properties['duration']
end

#fetch ⇒ RecordingInstance

Fetch a RecordingInstance

Returns:



345
346
347
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 345

def fetch
  context.fetch
end

#grouping_sids ⇒ Hash

Returns The grouping_sids.

Returns:

  • (Hash) —

    The grouping_sids



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

def grouping_sids
  @properties['grouping_sids']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



365
366
367
368
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 365

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



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

def links
  @properties['links']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#size ⇒ String

Returns The size.

Returns:

  • (String) —

    The size



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

def size
  @properties['size']
end

#source_sid ⇒ String

Returns The source_sid.

Returns:

  • (String) —

    The source_sid



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

def source_sid
  @properties['source_sid']
end

#status ⇒ recording.Status

Returns The status.

Returns:

  • (recording.Status) —

    The status



272
273
274
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 272

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



358
359
360
361
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 358

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



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

def type
  @properties['type']
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end