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 recording resource.
-
#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_unitcurrency. -
#price_unit ⇒ String
The currency used in the
priceproperty. -
#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
https://api.twilio.com.
Constructor Details
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ RecordingInstance
Initialize the RecordingInstance
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 512 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
557 558 559 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 557 def account_sid @properties['account_sid'] end |
#add_on_results ⇒ add_on_results
Access the add_on_results
693 694 695 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 693 def add_on_results context.add_on_results end |
#api_version ⇒ String
563 564 565 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 563 def api_version @properties['api_version'] end |
#call_sid ⇒ String
569 570 571 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 569 def call_sid @properties['call_sid'] end |
#channels ⇒ String
629 630 631 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 629 def channels @properties['channels'] end |
#conference_sid ⇒ String
575 576 577 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 575 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
548 549 550 551 552 553 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 548 def context unless @instance_context @instance_context = RecordingContext.new(@version , @params['account_sid'], @params['sid']) end @instance_context end |
#date_created ⇒ Time
581 582 583 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 581 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
587 588 589 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 587 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the RecordingInstance
672 673 674 675 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 672 def delete context.delete end |
#duration ⇒ String
599 600 601 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 599 def duration @properties['duration'] end |
#encryption_details ⇒ Hash
653 654 655 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 653 def encryption_details @properties['encryption_details'] end |
#error_code ⇒ String
641 642 643 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 641 def error_code @properties['error_code'] end |
#fetch(include_soft_deleted: :unset) ⇒ RecordingInstance
Fetch the RecordingInstance
681 682 683 684 685 686 687 688 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 681 def fetch( include_soft_deleted: :unset ) context.fetch( include_soft_deleted: include_soft_deleted, ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
713 714 715 716 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 713 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.RecordingInstance #{values}>" end |
#media_url ⇒ String
665 666 667 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 665 def media_url @properties['media_url'] end |
#price ⇒ String
611 612 613 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 611 def price @properties['price'] end |
#price_unit ⇒ String
617 618 619 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 617 def price_unit @properties['price_unit'] end |
#sid ⇒ String
605 606 607 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 605 def sid @properties['sid'] end |
#source ⇒ Source
635 636 637 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 635 def source @properties['source'] end |
#start_time ⇒ Time
593 594 595 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 593 def start_time @properties['start_time'] end |
#status ⇒ Status
623 624 625 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 623 def status @properties['status'] end |
#subresource_uris ⇒ Hash
659 660 661 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 659 def subresource_uris @properties['subresource_uris'] end |
#to_s ⇒ Object
Provide a user friendly representation
706 707 708 709 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 706 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.RecordingInstance #{values}>" end |
#transcriptions ⇒ transcriptions
Access the transcriptions
700 701 702 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 700 def transcriptions context.transcriptions end |
#uri ⇒ String
647 648 649 |
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 647 def uri @properties['uri'] end |