Class: Twilio::REST::Api::V2010::AccountContext::RecordingInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/recording.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the RecordingInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the [Account](www.twilio.com/docs/api/rest/account) that created the Recording resource.

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

    The Twilio-provided string that uniquely identifies the Recording resource to fetch.



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 303

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'api_version' => payload['api_version'],
      'call_sid' => payload['call_sid'],
      'conference_sid' => payload['conference_sid'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'start_time' => Twilio.deserialize_rfc2822(payload['start_time']),
      'duration' => payload['duration'],
      'sid' => payload['sid'],
      'price' => payload['price'],
      'price_unit' => payload['price_unit'],
      'status' => payload['status'],
      'channels' => payload['channels'].to_i,
      'source' => payload['source'],
      'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
      'uri' => payload['uri'],
      'encryption_details' => payload['encryption_details'],
      'subresource_uris' => payload['subresource_uris'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



346
347
348
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 346

def 
  @properties['account_sid']
end

#add_on_results ⇒ add_on_results

Access the add_on_results

Returns:



476
477
478
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 476

def add_on_results
  context.add_on_results
end

#api_version ⇒ String

Returns The API version used during the recording.

Returns:

  • (String) —

    The API version used during the recording.



352
353
354
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 352

def api_version
  @properties['api_version']
end

#call_sid ⇒ String

Returns The SID of the Call the resource is associated with.

Returns:

  • (String) —

    The SID of the Call the resource is associated with



358
359
360
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 358

def call_sid
  @properties['call_sid']
end

#channels ⇒ String

Returns The number of channels in the final recording file as an integer.

Returns:

  • (String) —

    The number of channels in the final recording file as an integer.



418
419
420
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 418

def channels
  @properties['channels']
end

#conference_sid ⇒ String

Returns The unique ID for the conference associated with the recording.

Returns:

  • (String) —

    The unique ID for the conference associated with the recording.



364
365
366
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 364

def conference_sid
  @properties['conference_sid']
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:



337
338
339
340
341
342
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 337

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

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was created



370
371
372
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 370

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was last updated



376
377
378
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 376

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



462
463
464
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 462

def delete
  context.delete
end

#duration ⇒ String

Returns The length of the recording in seconds.

Returns:

  • (String) —

    The length of the recording in seconds.



388
389
390
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 388

def duration
  @properties['duration']
end

#encryption_details ⇒ Hash

Returns How to decrypt the recording.

Returns:

  • (Hash) —

    How to decrypt the recording.



442
443
444
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 442

def encryption_details
  @properties['encryption_details']
end

#error_code ⇒ String

Returns More information about why the recording is missing, if status is ‘absent`.

Returns:

  • (String) —

    More information about why the recording is missing, if status is ‘absent`.



430
431
432
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 430

def error_code
  @properties['error_code']
end

#fetch ⇒ RecordingInstance

Fetch a RecordingInstance

Returns:



455
456
457
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 455

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



489
490
491
492
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 489

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

#price ⇒ String

Returns The one-time cost of creating the recording.

Returns:

  • (String) —

    The one-time cost of creating the recording.



400
401
402
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 400

def price
  @properties['price']
end

#price_unit ⇒ String

Returns The currency used in the price property.

Returns:

  • (String) —

    The currency used in the price property.



406
407
408
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 406

def price_unit
  @properties['price_unit']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



394
395
396
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 394

def sid
  @properties['sid']
end

#source ⇒ recording.Source

Returns How the recording was created.

Returns:

  • (recording.Source) —

    How the recording was created



424
425
426
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 424

def source
  @properties['source']
end

#start_time ⇒ Time

Returns The start time of the recording, given in RFC 2822 format.

Returns:

  • (Time) —

    The start time of the recording, given in RFC 2822 format



382
383
384
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 382

def start_time
  @properties['start_time']
end

#status ⇒ recording.Status

Returns The status of the recording.

Returns:

  • (recording.Status) —

    The status of the recording.



412
413
414
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 412

def status
  @properties['status']
end

#subresource_uris ⇒ String

Returns A list of related resources identified by their relative URIs.

Returns:

  • (String) —

    A list of related resources identified by their relative URIs



448
449
450
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 448

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



482
483
484
485
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 482

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

#transcriptions ⇒ transcriptions

Access the transcriptions

Returns:



469
470
471
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 469

def transcriptions
  context.transcriptions
end

#uri ⇒ String

Returns The URI of the resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of the resource, relative to ‘api.twilio.com`



436
437
438
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 436

def uri
  @properties['uri']
end