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/iam/api/account) that created the Recording resource.

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

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

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

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



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

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



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

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



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

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



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

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



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

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



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

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:



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

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#duration ⇒ String

Returns The length of the recording in seconds.

Returns:

  • (String) —

    The length of the recording in seconds



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

def duration
  @properties['duration']
end

#encryption_details ⇒ Hash

Returns How to decrypt the recording.

Returns:

  • (Hash) —

    How to decrypt the recording.



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

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



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

def error_code
  @properties['error_code']
end

#fetch ⇒ RecordingInstance

Fetch the RecordingInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



500
501
502
503
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 500

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.



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

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.



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

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



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

def sid
  @properties['sid']
end

#source ⇒ recording.Source

Returns How the recording was created.

Returns:

  • (recording.Source) —

    How the recording was created



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

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



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

def start_time
  @properties['start_time']
end

#status ⇒ recording.Status

Returns The status of the recording.

Returns:

  • (recording.Status) —

    The status of the recording



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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`



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

def uri
  @properties['uri']
end