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](www.twilio.com/docs/iam/api/account) that created the Recording resource.

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

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



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

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 SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#add_on_results ⇒ add_on_results

Access the add_on_results

Returns:



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

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.



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

def api_version
  @properties['api_version']
end

#call_sid ⇒ String

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

Returns:

  • (String) —

    The SID of the Call the resource is associated with



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

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.



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

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.



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

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:



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

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

#date_created ⇒ Time

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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#duration ⇒ String

Returns The length of the recording in seconds.

Returns:

  • (String) —

    The length of the recording in seconds.



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

def duration
  @properties['duration']
end

#encryption_details ⇒ Hash

Returns How to decrypt the recording.

Returns:

  • (Hash) —

    How to decrypt the recording.



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

def encryption_details
  @properties['encryption_details']
end

#error_code ⇒ String

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



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

def error_code
  @properties['error_code']
end

#fetch ⇒ RecordingInstance

Fetch a RecordingInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

Returns:

  • (String) —

    The one-time cost of creating the recording.



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

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.



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

def price_unit
  @properties['price_unit']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#source ⇒ recording.Source

Returns How the recording was created.

Returns:

  • (recording.Source) —

    How the recording was created



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

def source
  @properties['source']
end

#start_time ⇒ Time

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



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

def start_time
  @properties['start_time']
end

#status ⇒ recording.Status

Returns The status of the recording.

Returns:

  • (recording.Status) —

    The status of the recording.



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

def status
  @properties['status']
end

#subresource_uris ⇒ String

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

Returns:

  • (String) —

    A list of related resources identified by their relative URIs



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

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#transcriptions ⇒ transcriptions

Access the transcriptions

Returns:



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

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`



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

def uri
  @properties['uri']
end