Class: Twilio::REST::Api::V2010::AccountContext::CallContext::RecordingInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::CallContext::RecordingInstance
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/call/recording.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the Account that created the resource.
-
#api_version ⇒ String
The API version used to make the recording.
-
#call_sid ⇒ String
The SID of the Call the resource is associated with.
-
#channels ⇒ String
The number of channels in the final recording file.
-
#conference_sid ⇒ String
The Conference SID that identifies the conference associated with the recording.
-
#context ⇒ RecordingContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The RFC 2822 date and time in GMT that the resource was created.
-
#date_updated ⇒ Time
The RFC 2822 date and time in GMT that the resource was last updated.
-
#delete ⇒ Boolean
Delete the RecordingInstance.
-
#duration ⇒ String
The length of the recording in seconds.
-
#encryption_details ⇒ Hash
How to decrypt the recording.
-
#error_code ⇒ String
More information about why the recording is missing, if status is `absent`.
-
#fetch ⇒ RecordingInstance
Fetch the RecordingInstance.
-
#initialize(version, payload, account_sid: nil, call_sid: nil, sid: nil) ⇒ RecordingInstance
constructor
Initialize the RecordingInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#price ⇒ String
The one-time cost of creating the recording.
-
#price_unit ⇒ String
The currency used in the price property.
-
#sid ⇒ String
The unique string that identifies the resource.
-
#source ⇒ recording.Source
How the recording was created.
-
#start_time ⇒ Time
The start time of the recording, given in RFC 2822 format.
-
#status ⇒ recording.Status
The status of the recording.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#track ⇒ String
The recorded track.
-
#update(status: nil, pause_behavior: :unset) ⇒ RecordingInstance
Update the RecordingInstance.
-
#uri ⇒ String
The URI of the resource, relative to `api.twilio.com`.
Constructor Details
#initialize(version, payload, account_sid: nil, call_sid: nil, sid: nil) ⇒ RecordingInstance
Initialize the RecordingInstance
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' => 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.
369 370 371 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 369 def account_sid @properties['account_sid'] end |
#api_version ⇒ String
Returns 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_sid ⇒ String
Returns 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 |
#channels ⇒ String
Returns 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_sid ⇒ String
Returns 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 |
#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
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_created ⇒ Time
Returns 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_updated ⇒ Time
Returns 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 |
#delete ⇒ Boolean
Delete the RecordingInstance
499 500 501 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 499 def delete context.delete end |
#duration ⇒ String
Returns 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_details ⇒ Hash
Returns 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_code ⇒ String
Returns 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 |
#fetch ⇒ RecordingInstance
Fetch the RecordingInstance
492 493 494 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 492 def fetch context.fetch end |
#inspect ⇒ Object
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 |
#price ⇒ String
Returns 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_unit ⇒ String
Returns 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 |
#sid ⇒ String
Returns 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 |
#source ⇒ recording.Source
Returns 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_time ⇒ Time
Returns 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 |
#status ⇒ recording.Status
Returns 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_s ⇒ Object
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 |
#track ⇒ String
Returns 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
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 |
#uri ⇒ String
Returns The URI of the resource, relative to `api.twilio.com`.
429 430 431 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 429 def uri @properties['uri'] end |