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

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

    The recording Sid that uniquely identifies this resource



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
332
333
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 305

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'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      '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'],
      'uri' => payload['uri'],
      'encryption_details' => payload['encryption_details'],
      'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
  }

  # 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



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

def 
  @properties['account_sid']
end

#add_on_results ⇒ add_on_results

Access the add_on_results

Returns:



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

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.



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

def api_version
  @properties['api_version']
end

#call_sid ⇒ String

Returns The call during which the recording was made.

Returns:

  • (String) —

    The call during which the recording was made.



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

def call_sid
  @properties['call_sid']
end

#channels ⇒ String

Returns The channels.

Returns:

  • (String) —

    The channels



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

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



339
340
341
342
343
344
345
346
347
348
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 339

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



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 date this resource was last updated.

Returns:

  • (Time) —

    The date this 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



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

def delete
  context.delete
end

#duration ⇒ String

Returns The length of the recording, in seconds.

Returns:

  • (String) —

    The length of the recording, in seconds.



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

def duration
  @properties['duration']
end

#encryption_details ⇒ Hash

Returns The encryption_details.

Returns:

  • (Hash) —

    The encryption_details



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

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.



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

def error_code
  @properties['error_code']
end

#fetch ⇒ RecordingInstance

Fetch a RecordingInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#price ⇒ String

Returns The price.

Returns:

  • (String) —

    The price



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

def price
  @properties['price']
end

#price_unit ⇒ String

Returns The price_unit.

Returns:

  • (String) —

    The price_unit



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

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



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

def sid
  @properties['sid']
end

#source ⇒ recording.Source

Returns The source.

Returns:

  • (recording.Source) —

    The source



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

def source
  @properties['source']
end

#status ⇒ transcription.Status

Returns The status.

Returns:

  • (transcription.Status) —

    The status



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#transcriptions ⇒ transcriptions

Access the transcriptions

Returns:



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

def transcriptions
  context.transcriptions
end

#uri ⇒ String

Returns The URI for this resource.

Returns:

  • (String) —

    The URI for this resource



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

def uri
  @properties['uri']
end