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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, conference_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 this Recording resource.

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

    The SID of the Call resource to fetch.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 266

def initialize(version, payload , account_sid: nil, conference_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'] == nil ? payload['channels'] : payload['channels'].to_i,
        'source' => payload['source'],
        'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
        'encryption_details' => payload['encryption_details'],
        'uri' => payload['uri'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Conference Recording resource.

Returns:



308
309
310
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 308

def 
    @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used to create the recording.

Returns:

  • (String) —

    The API version used to create the recording.



314
315
316
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 314

def api_version
    @properties['api_version']
end

#call_sid ⇒ String

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

Returns:



320
321
322
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 320

def call_sid
    @properties['call_sid']
end

#channels ⇒ String

Returns The number of channels in the final recording file. Can be: ‘1`, or `2`. Separating a two leg call into two separate channels of the recording file is supported in [Dial](www.twilio.com/docs/voice/twiml/dial#attributes-record) and [Outbound Rest API](www.twilio.com/docs/voice/make-calls) record options.

Returns:



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

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.



326
327
328
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 326

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:



299
300
301
302
303
304
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 299

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

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



332
333
334
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 332

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated, specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



338
339
340
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 338

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RecordingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#duration ⇒ String

Returns The length of the recording in seconds.

Returns:

  • (String) —

    The length of the recording in seconds.



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

def duration
    @properties['duration']
end

#encryption_details ⇒ Hash

Returns How to decrypt the recording if it was encrypted using [Call Recording Encryption](www.twilio.com/docs/voice/tutorials/voice-recording-encryption) feature.

Returns:



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

def encryption_details
    @properties['encryption_details']
end

#error_code ⇒ String

Returns The error code that describes why the recording is ‘absent`. The error code is described in our [Error Dictionary](www.twilio.com/docs/api/errors). This value is null if the recording `status` is not `absent`.

Returns:

  • (String) —

    The error code that describes why the recording is ‘absent`. The error code is described in our [Error Dictionary](www.twilio.com/docs/api/errors). This value is null if the recording `status` is not `absent`.



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

def error_code
    @properties['error_code']
end

#fetch ⇒ RecordingInstance

Fetch the RecordingInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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 in the ‘price_unit` currency.

Returns:

  • (String) —

    The one-time cost of creating the recording in the ‘price_unit` currency.



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

def price
    @properties['price']
end

#price_unit ⇒ String

Returns The currency used in the ‘price` property. Example: `USD`.

Returns:

  • (String) —

    The currency used in the ‘price` property. Example: `USD`.



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

def price_unit
    @properties['price_unit']
end

#sid ⇒ String

Returns The unique string that that we created to identify the Conference Recording resource.

Returns:

  • (String) —

    The unique string that that we created to identify the Conference Recording resource.



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

def sid
    @properties['sid']
end

#source ⇒ Source

Returns:

  • (Source) 


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

def source
    @properties['source']
end

#start_time ⇒ Time

Returns The start time of the recording in GMT and in [RFC 2822](www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.

Returns:



344
345
346
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 344

def start_time
    @properties['start_time']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



442
443
444
445
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 442

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 (Status) (defaults to: nil)
  • 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:



429
430
431
432
433
434
435
436
437
438
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 429

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



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

def uri
    @properties['uri']
end