Class: Twilio::REST::Api::V2010::AccountContext::RecordingInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::RecordingInstance
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/recording.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Recording resource.
-
#add_on_results ⇒ add_on_results
Access the add_on_results.
-
#api_version ⇒ String
The API version used during the recording.
-
#call_sid ⇒ String
The SID of the [Call](www.twilio.com/docs/voice/api/call-resource) the Recording 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, if a conference recording.
-
#context ⇒ RecordingContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#delete ⇒ Boolean
Delete the RecordingInstance.
-
#duration ⇒ String
The length of the recording in seconds.
-
#encryption_details ⇒ Hash
How to decrypt the recording if it was encrypted using [Call Recording Encryption](www.twilio.com/docs/voice/tutorials/voice-recording-encryption) feature.
-
#error_code ⇒ String
The error code that describes why the recording is ‘absent`.
-
#fetch(include_soft_deleted: :unset) ⇒ RecordingInstance
Fetch the RecordingInstance.
-
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ RecordingInstance
constructor
Initialize the RecordingInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#media_url ⇒ String
The URL of the media file associated with this recording resource.
-
#price ⇒ String
The one-time cost of creating the recording in the ‘price_unit` currency.
-
#price_unit ⇒ String
The currency used in the ‘price` property.
-
#sid ⇒ String
The unique string that that we created to identify the Recording resource.
- #source ⇒ Source
-
#start_time ⇒ Time
The start time of the recording in GMT and in [RFC 2822](www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.
- #status ⇒ Status
-
#subresource_uris ⇒ Hash
A list of related resources identified by their relative URIs.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#transcriptions ⇒ transcriptions
Access the transcriptions.
-
#uri ⇒ String
The URI of the resource, relative to ‘api.twilio.com`.
Constructor Details
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ RecordingInstance
Initialize the RecordingInstance
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 302 def initialize(version, payload , account_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, 'uri' => payload['uri'], 'encryption_details' => payload['encryption_details'], 'subresource_uris' => payload['subresource_uris'], 'media_url' => payload['media_url'], } # Context @instance_context = nil @params = { 'account_sid' => account_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 Recording resource.
346 347 348 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 346 def account_sid @properties['account_sid'] end |
#add_on_results ⇒ add_on_results
Access the add_on_results
482 483 484 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 482 def add_on_results context.add_on_results end |
#api_version ⇒ String
Returns The API version used during the recording.
352 353 354 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 352 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 Recording resource is associated with. This will always refer to the parent leg of a two-leg call.
358 359 360 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 358 def call_sid @properties['call_sid'] end |
#channels ⇒ String
Returns The number of channels in the final recording file. Can be: ‘1` or `2`. You can split a call with two legs into two separate recording channels if you record using [TwiML Dial](www.twilio.com/docs/voice/twiml/dial#record) or the [Outbound Rest API](www.twilio.com/docs/voice/make-calls#manage-your-outbound-call).
418 419 420 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 418 def channels @properties['channels'] end |
#conference_sid ⇒ String
Returns The Conference SID that identifies the conference associated with the recording, if a conference recording.
364 365 366 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 364 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
337 338 339 340 341 342 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 337 def context unless @instance_context @instance_context = RecordingContext.new(@version , @params['account_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.
370 371 372 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 370 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.
376 377 378 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 376 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the RecordingInstance
461 462 463 464 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 461 def delete context.delete end |
#duration ⇒ String
Returns The length of the recording in seconds.
388 389 390 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 388 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.
442 443 444 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 442 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`.
430 431 432 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 430 def error_code @properties['error_code'] end |
#fetch(include_soft_deleted: :unset) ⇒ RecordingInstance
Fetch the RecordingInstance
470 471 472 473 474 475 476 477 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 470 def fetch( include_soft_deleted: :unset ) context.fetch( include_soft_deleted: include_soft_deleted, ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
502 503 504 505 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 502 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.RecordingInstance #{values}>" end |
#media_url ⇒ String
Returns The URL of the media file associated with this recording resource. When stored externally, this is the full URL location of the media file.
454 455 456 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 454 def media_url @properties['media_url'] end |
#price ⇒ String
Returns The one-time cost of creating the recording in the ‘price_unit` currency.
400 401 402 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 400 def price @properties['price'] end |
#price_unit ⇒ String
Returns The currency used in the ‘price` property. Example: `USD`.
406 407 408 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 406 def price_unit @properties['price_unit'] end |
#sid ⇒ String
Returns The unique string that that we created to identify the Recording resource.
394 395 396 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 394 def sid @properties['sid'] end |
#source ⇒ Source
424 425 426 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 424 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.
382 383 384 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 382 def start_time @properties['start_time'] end |
#status ⇒ Status
412 413 414 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 412 def status @properties['status'] end |
#subresource_uris ⇒ Hash
Returns A list of related resources identified by their relative URIs.
448 449 450 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 448 def subresource_uris @properties['subresource_uris'] end |
#to_s ⇒ Object
Provide a user friendly representation
495 496 497 498 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 495 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.RecordingInstance #{values}>" end |
#transcriptions ⇒ transcriptions
Access the transcriptions
489 490 491 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 489 def transcriptions context.transcriptions end |
#uri ⇒ String
Returns The URI of the resource, relative to ‘api.twilio.com`.
436 437 438 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 436 def uri @properties['uri'] end |