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 the Recording resource.

  • sid (String) (defaults to: nil)

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


315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 315

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

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

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#add_on_resultsadd_on_results

Access the add_on_results

Returns:


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

def add_on_results
  context.add_on_results
end

#api_versionString

Returns The API version used during the recording.

Returns:

  • (String)

    The API version used during the recording.


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

def api_version
  @properties['api_version']
end

#call_sidString

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

Returns:

  • (String)

    The SID of the Call the resource is associated with


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

def call_sid
  @properties['call_sid']
end

#channelsString

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.


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

def channels
  @properties['channels']
end

#conference_sidString

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

Returns:

  • (String)

    The unique ID for the conference associated with the recording.


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

def conference_sid
  @properties['conference_sid']
end

#contextRecordingContext

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

Returns:


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

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

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#date_updatedTime

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


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the RecordingInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#durationString

Returns The length of the recording in seconds.

Returns:

  • (String)

    The length of the recording in seconds.


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

def duration
  @properties['duration']
end

#encryption_detailsHash

Returns How to decrypt the recording.

Returns:

  • (Hash)

    How to decrypt the recording.


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

def encryption_details
  @properties['encryption_details']
end

#error_codeString

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


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

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
# 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

#inspectObject

Provide a detailed, user friendly representation


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

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

#media_urlString

Returns The URL of the media file.

Returns:

  • (String)

    The URL of the media file.


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

def media_url
  @properties['media_url']
end

#priceString

Returns The one-time cost of creating the recording.

Returns:

  • (String)

    The one-time cost of creating the recording.


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

def price
  @properties['price']
end

#price_unitString

Returns The currency used in the price property.

Returns:

  • (String)

    The currency used in the price property.


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

def price_unit
  @properties['price_unit']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#sourcerecording.Source

Returns How the recording was created.

Returns:

  • (recording.Source)

    How the recording was created


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

def source
  @properties['source']
end

#start_timeTime

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


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

def start_time
  @properties['start_time']
end

#statusrecording.Status

Returns The status of the recording.

Returns:

  • (recording.Status)

    The status of the recording.


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

def status
  @properties['status']
end

#subresource_urisString

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

Returns:

  • (String)

    A list of related resources identified by their relative URIs


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

def subresource_uris
  @properties['subresource_uris']
end

#to_sObject

Provide a user friendly representation


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

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

#transcriptionstranscriptions

Access the transcriptions

Returns:


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

def transcriptions
  context.transcriptions
end

#uriString

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

Returns:


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

def uri
  @properties['uri']
end