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 unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this recording.

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

    The unique recording SID that identifies this resource



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 289

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 unique SID that identifies this account.

Returns:

  • (String) —

    The unique SID that identifies this account



332
333
334
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 332

def 
  @properties['account_sid']
end

#add_on_results ⇒ add_on_results

Access the add_on_results

Returns:



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

def add_on_results
  context.add_on_results
end

#api_version ⇒ String

Returns The version of the API in use during the recording.

Returns:

  • (String) —

    The version of the API in use during the recording.



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

def api_version
  @properties['api_version']
end

#call_sid ⇒ String

Returns The unique ID for the call leg that corresponds to the recording.

Returns:

  • (String) —

    The unique ID for the call leg that corresponds to the recording.



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

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.



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

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.



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

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:



323
324
325
326
327
328
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 323

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

Returns:

  • (Time) —

    The date this resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this resource was last updated.

Returns:

  • (Time) —

    The date this resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#duration ⇒ String

Returns The length of the recording in seconds.

Returns:

  • (String) —

    The length of the recording in seconds.



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

def duration
  @properties['duration']
end

#encryption_details ⇒ Hash

Returns Details for how to decrypt the recording.

Returns:

  • (Hash) —

    Details for how to decrypt the recording.



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

def encryption_details
  @properties['encryption_details']
end

#error_code ⇒ String

Returns More information about the recording failure, if Status is failed.

Returns:

  • (String) —

    More information about the recording failure, if Status is failed.



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

def error_code
  @properties['error_code']
end

#fetch ⇒ RecordingInstance

Fetch a RecordingInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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 this recording.

Returns:

  • (String) —

    The one-time cost of creating this recording.



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

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.



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

def price_unit
  @properties['price_unit']
end

#sid ⇒ String

Returns A string that uniquely identifies this recording.

Returns:

  • (String) —

    A string that uniquely identifies this recording



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

def sid
  @properties['sid']
end

#source ⇒ recording.Source

Returns The way in which this recording was created.

Returns:

  • (recording.Source) —

    The way in which this recording was created.



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

def source
  @properties['source']
end

#start_time ⇒ Time

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

Returns:

  • (Time) —

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



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

def start_time
  @properties['start_time']
end

#status ⇒ recording.Status

Returns The status of the recording.

Returns:

  • (recording.Status) —

    The status of the recording.



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

def status
  @properties['status']
end

#subresource_uris ⇒ String

Returns The subresource_uris.

Returns:

  • (String) —

    The subresource_uris



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

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#transcriptions ⇒ transcriptions

Access the transcriptions

Returns:



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

def transcriptions
  context.transcriptions
end

#uri ⇒ String

Returns The URI for this resource.

Returns:

  • (String) —

    The URI for this resource



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

def uri
  @properties['uri']
end