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

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

    A unique identifier for the call associated with the recording. This will always refer to the parent leg of a two leg call.

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

    The recording Sid that uniquely identifies this resource



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 314

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

Returns:

  • (String) —

    The unique sid that identifies this account



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

def 
  @properties['account_sid']
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.



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

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.



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

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.



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

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.



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

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:



347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 347

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

Returns:

  • (Time) —

    The date this resource was created



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#duration ⇒ String

Returns The length of the recording, in seconds.

Returns:

  • (String) —

    The length of the recording, in seconds.



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

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.



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

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.



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

def error_code
  @properties['error_code']
end

#fetch ⇒ RecordingInstance

Fetch a RecordingInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

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.



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

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



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

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.



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

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.



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

def start_time
  @properties['start_time']
end

#status ⇒ recording.Status

Returns The status of the recording.

Returns:

  • (recording.Status) —

    The status of the recording.



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 status to change the recording to. Possible values: ‘stopped`, `paused`, `in-progress`

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

    Only applicable when setting Status parameter to ‘paused`. Possible values: `skip` or `silence`. `skip` will result in no recording at all during the pause period. `silence` will replace the actual audio of the call with silence during the pause period. Defaults to `silence`

Returns:



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

def update(status: nil, pause_behavior: :unset)
  context.update(status: status, pause_behavior: pause_behavior, )
end

#uri ⇒ String

Returns The URI for this resource.

Returns:

  • (String) —

    The URI for this resource



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

def uri
  @properties['uri']
end