Class: Twilio::REST::Api::V2010::AccountContext::CallContext::RecordingInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/call/recording.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, call_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/api/rest/account) that created the Recording resource.

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

    The SID of the [Call](www.twilio.com/docs/api/voice/call) the Recording resource is associated with.

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

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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 332

def initialize(version, payload, account_sid: nil, call_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'].to_f,
      'uri' => payload['uri'],
      'encryption_details' => payload['encryption_details'],
      '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,
  }

  # Context
  @instance_context = nil
  @params = {'account_sid' => , 'call_sid' => call_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



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

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used to make the recording.

Returns:

  • (String) —

    The API version used to make the recording



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

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



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

def call_sid
  @properties['call_sid']
end

#channels ⇒ String

Returns The number of channels in the final recording file.

Returns:

  • (String) —

    The number of channels in the final recording file



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

def channels
  @properties['channels']
end

#conference_sid ⇒ String

Returns The Conference SID that identifies the conference associated with the recording.

Returns:

  • (String) —

    The Conference SID that identifies the conference associated with the recording



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

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:



365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 365

def context
  unless @instance_context
    @instance_context = RecordingContext.new(
        @version,
        @params['account_sid'],
        @params['call_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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#duration ⇒ String

Returns The length of the recording in seconds.

Returns:

  • (String) —

    The length of the recording in seconds



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

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



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

def error_code
  @properties['error_code']
end

#fetch ⇒ RecordingInstance

Fetch a RecordingInstance

Returns:



496
497
498
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 496

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



516
517
518
519
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 516

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.



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

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.



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

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



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

def sid
  @properties['sid']
end

#source ⇒ recording.Source

Returns How the recording was created.

Returns:

  • (recording.Source) —

    How the recording was created



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

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



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

def start_time
  @properties['start_time']
end

#status ⇒ recording.Status

Returns The status of the recording.

Returns:

  • (recording.Status) —

    The status of the recording



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



509
510
511
512
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 509

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

#update(status: nil, pause_behavior: :unset) ⇒ RecordingInstance

Update the RecordingInstance

Parameters:

  • status (recording.Status) (defaults to: nil) —

    The new status of the recording. Can be: ‘stopped`, `paused`, `in-progress`.

  • pause_behavior (String) (defaults to: :unset) —

    Whether to record during a pause. Can be: ‘skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`.

Returns:



489
490
491
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 489

def update(status: nil, pause_behavior: :unset)
  context.update(status: status, pause_behavior: pause_behavior, )
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/call/recording.rb', line 439

def uri
  @properties['uri']
end