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/api/rest/account) responsible for this recording.

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

    The recording Sid that uniquely 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
 
# 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']),
      '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



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

def 
  @properties['account_sid']
end

#add_on_results ⇒ add_on_results

Access the add_on_results

Returns:



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

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.



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

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.



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

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.



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

def channels
  @properties['channels']
end

#conference_sid ⇒ String

Returns The unique id for the conference associated with the recording, if a conference recording.

Returns:

  • (String) —

    The unique id for the conference associated with the recording, if a conference recording.



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

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:



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

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#duration ⇒ String

Returns The length of the recording, in seconds.

Returns:

  • (String) —

    The length of the recording, in seconds.



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

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.



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

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.



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

def error_code
  @properties['error_code']
end

#fetch ⇒ RecordingInstance

Fetch a RecordingInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

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.



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

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



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

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.



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

def source
  @properties['source']
end

#status ⇒ recording.Status

Returns The status of the recording.

Returns:

  • (recording.Status) —

    The status of the recording.



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

def status
  @properties['status']
end

#subresource_uris ⇒ String

Returns The subresource_uris.

Returns:

  • (String) —

    The subresource_uris



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

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#transcriptions ⇒ transcriptions

Access the transcriptions

Returns:



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

def transcriptions
  context.transcriptions
end

#uri ⇒ String

Returns The URI for this resource.

Returns:

  • (String) —

    The URI for this resource



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

def uri
  @properties['uri']
end