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

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

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

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

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


271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 271

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'].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,
      '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


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

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


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

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


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

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


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

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


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

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:


308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 308

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


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

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


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#duration ⇒ String

Returns The length of the recording in seconds.

Returns:

  • (String) —

    The length of the recording in seconds


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

def duration
  @properties['duration']
end

#encryption_details ⇒ Hash

Returns How to decrypt the recording.

Returns:

  • (Hash) —

    How to decrypt the recording.


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

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


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

def error_code
  @properties['error_code']
end

#fetch ⇒ RecordingInstance

Fetch the RecordingInstance

Returns:


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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


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

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.


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

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.


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

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


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

def sid
  @properties['sid']
end

#source ⇒ recording.Source

Returns How the recording was created.

Returns:

  • (recording.Source) —

    How the recording was created


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

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


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

def start_time
  @properties['start_time']
end

#status ⇒ recording.Status

Returns The status of the recording.

Returns:

  • (recording.Status) —

    The status of the recording


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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation


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

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:


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

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:


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

def uri
  @properties['uri']
end