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 that created the Recording resource.

  • call_sid (String) (defaults to: nil)

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

  • sid (String) (defaults to: nil)

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


321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 321

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,
      'track' => payload['track'],
  }

  # Context
  @instance_context = nil
  @params = {'account_sid' => , 'call_sid' => call_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#api_versionString

Returns The API version used to make the recording.

Returns:

  • (String)

    The API version used to make the recording


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

def api_version
  @properties['api_version']
end

#call_sidString

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

Returns:

  • (String)

    The SID of the Call the resource is associated with


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

def call_sid
  @properties['call_sid']
end

#channelsString

Returns The number of channels in the final recording file.

Returns:

  • (String)

    The number of channels in the final recording file


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

def channels
  @properties['channels']
end

#conference_sidString

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


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

def conference_sid
  @properties['conference_sid']
end

#contextRecordingContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


355
356
357
358
359
360
361
362
363
364
365
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 355

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

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#date_updatedTime

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


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the RecordingInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#durationString

Returns The length of the recording in seconds.

Returns:

  • (String)

    The length of the recording in seconds


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

def duration
  @properties['duration']
end

#encryption_detailsHash

Returns How to decrypt the recording.

Returns:

  • (Hash)

    How to decrypt the recording.


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

def encryption_details
  @properties['encryption_details']
end

#error_codeString

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


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

def error_code
  @properties['error_code']
end

#fetchRecordingInstance

Fetch the RecordingInstance

Returns:


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

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


512
513
514
515
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 512

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

#priceString

Returns The one-time cost of creating the recording.

Returns:

  • (String)

    The one-time cost of creating the recording.


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

def price
  @properties['price']
end

#price_unitString

Returns The currency used in the price property.

Returns:

  • (String)

    The currency used in the price property.


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

def price_unit
  @properties['price_unit']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#sourcerecording.Source

Returns How the recording was created.

Returns:

  • (recording.Source)

    How the recording was created


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

def source
  @properties['source']
end

#start_timeTime

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


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

def start_time
  @properties['start_time']
end

#statusrecording.Status

Returns The status of the recording.

Returns:

  • (recording.Status)

    The status of the recording


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

def status
  @properties['status']
end

#to_sObject

Provide a user friendly representation


505
506
507
508
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 505

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

#trackString

Returns The recorded track. Can be: `inbound`, `outbound`, or `both`.

Returns:

  • (String)

    The recorded track. Can be: `inbound`, `outbound`, or `both`.


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

def track
  @properties['track']
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:


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

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

#uriString

Returns The URI of the resource, relative to `api.twilio.com`.

Returns:


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

def uri
  @properties['uri']
end