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 that created this Recording resource.

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

    The SID of the Call resource to fetch.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 309

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'] == nil ? payload['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'],
        'media_url' => payload['media_url'],
    }

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

Instance Method Details

#account_sid ⇒ String

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

Returns:



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

def 
    @properties['account_sid']
end

#add_on_results ⇒ add_on_results

Access the add_on_results

Returns:



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

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.



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

def api_version
    @properties['api_version']
end

#call_sid ⇒ String

Returns The SID of the [Call](www.twilio.com/docs/voice/api/call-resource) the Recording resource is associated with. This will always refer to the parent leg of a two-leg call.

Returns:



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

def call_sid
    @properties['call_sid']
end

#channels ⇒ String

Returns The number of channels in the final recording file. Can be: ‘1` or `2`. You can split a call with two legs into two separate recording channels if you record using [TwiML Dial](www.twilio.com/docs/voice/twiml/dial#record) or the [Outbound Rest API](www.twilio.com/docs/voice/make-calls#manage-your-outbound-call).

Returns:



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

def channels
    @properties['channels']
end

#conference_sid ⇒ String

Returns The Conference SID that identifies the conference associated with the recording, if a conference recording.

Returns:

  • (String) —

    The Conference SID that identifies the conference associated with the recording, if a conference recording.



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

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:



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

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

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RecordingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#duration ⇒ String

Returns The length of the recording in seconds.

Returns:

  • (String) —

    The length of the recording in seconds.



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

def duration
    @properties['duration']
end

#encryption_details ⇒ Hash

Returns How to decrypt the recording if it was encrypted using [Call Recording Encryption](www.twilio.com/docs/voice/tutorials/voice-recording-encryption) feature.

Returns:



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

def encryption_details
    @properties['encryption_details']
end

#error_code ⇒ String

Returns The error code that describes why the recording is ‘absent`. The error code is described in our [Error Dictionary](www.twilio.com/docs/api/errors). This value is null if the recording `status` is not `absent`.

Returns:

  • (String) —

    The error code that describes why the recording is ‘absent`. The error code is described in our [Error Dictionary](www.twilio.com/docs/api/errors). This value is null if the recording `status` is not `absent`.



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

def error_code
    @properties['error_code']
end

#fetch(include_soft_deleted: :unset) ⇒ RecordingInstance

Fetch the RecordingInstance

Parameters:

  • include_soft_deleted (Boolean) (defaults to: :unset) —

    A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.

Returns:



477
478
479
480
481
482
483
484
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 477

def fetch(
    include_soft_deleted: :unset
)

    context.fetch(
        include_soft_deleted: include_soft_deleted, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



509
510
511
512
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 509

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

#media_url ⇒ String

Returns The URL of the media file associated with this recording resource. When stored externally, this is the full URL location of the media file.

Returns:

  • (String) —

    The URL of the media file associated with this recording resource. When stored externally, this is the full URL location of the media file.



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

def media_url
    @properties['media_url']
end

#price ⇒ String

Returns The one-time cost of creating the recording in the ‘price_unit` currency.

Returns:

  • (String) —

    The one-time cost of creating the recording in the ‘price_unit` currency.



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

def price
    @properties['price']
end

#price_unit ⇒ String

Returns The currency used in the ‘price` property. Example: `USD`.

Returns:

  • (String) —

    The currency used in the ‘price` property. Example: `USD`.



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

def price_unit
    @properties['price_unit']
end

#sid ⇒ String

Returns The unique string that that we created to identify the Recording resource.

Returns:

  • (String) —

    The unique string that that we created to identify the Recording resource.



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

def sid
    @properties['sid']
end

#source ⇒ Source

Returns:

  • (Source) 


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

def source
    @properties['source']
end

#start_time ⇒ Time

Returns The start time of the recording in GMT and in [RFC 2822](www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.

Returns:



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

def start_time
    @properties['start_time']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#subresource_uris ⇒ Hash

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

Returns:

  • (Hash) —

    A list of related resources identified by their relative URIs.



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

def subresource_uris
    @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



502
503
504
505
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 502

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

#transcriptions ⇒ transcriptions

Access the transcriptions

Returns:



496
497
498
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 496

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`.



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

def uri
    @properties['uri']
end