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
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 332 333 334 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 305 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
349 350 351 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 349 def account_sid @properties['account_sid'] end |
#add_on_results ⇒ add_on_results
Access the add_on_results
485 486 487 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 485 def add_on_results context.add_on_results end |
#api_version ⇒ String
355 356 357 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 355 def api_version @properties['api_version'] end |
#call_sid ⇒ String
361 362 363 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 361 def call_sid @properties['call_sid'] end |
#channels ⇒ String
421 422 423 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 421 def channels @properties['channels'] end |
#conference_sid ⇒ String
367 368 369 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 367 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
340 341 342 343 344 345 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 340 def context unless @instance_context @instance_context = RecordingContext.new(@version , @params['account_sid'], @params['sid']) end @instance_context end |
#date_created ⇒ Time
373 374 375 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 373 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
379 380 381 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 379 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the RecordingInstance
464 465 466 467 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 464 def delete context.delete end |
#duration ⇒ String
391 392 393 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 391 def duration @properties['duration'] end |
#encryption_details ⇒ Hash
445 446 447 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 445 def encryption_details @properties['encryption_details'] end |
#error_code ⇒ String
433 434 435 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 433 def error_code @properties['error_code'] end |
#fetch(include_soft_deleted: :unset) ⇒ RecordingInstance
Fetch the RecordingInstance
473 474 475 476 477 478 479 480 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 473 def fetch( include_soft_deleted: :unset ) context.fetch( include_soft_deleted: include_soft_deleted, ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
505 506 507 508 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 505 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.RecordingInstance #{values}>" end |
#media_url ⇒ String
457 458 459 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 457 def media_url @properties['media_url'] end |
#price ⇒ String
403 404 405 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 403 def price @properties['price'] end |
#price_unit ⇒ String
409 410 411 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 409 def price_unit @properties['price_unit'] end |
#sid ⇒ String
397 398 399 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 397 def sid @properties['sid'] end |
#source ⇒ Source
427 428 429 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 427 def source @properties['source'] end |
#start_time ⇒ Time
385 386 387 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 385 def start_time @properties['start_time'] end |
#status ⇒ Status
415 416 417 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 415 def status @properties['status'] end |
#subresource_uris ⇒ Hash
451 452 453 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 451 def subresource_uris @properties['subresource_uris'] end |
#to_s ⇒ Object
Provide a user friendly representation
498 499 500 501 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 498 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.RecordingInstance #{values}>" end |
#transcriptions ⇒ transcriptions
Access the transcriptions
492 493 494 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 492 def transcriptions context.transcriptions end |
#uri ⇒ String
439 440 441 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 439 def uri @properties['uri'] end |