Class: Twilio::REST::Api::V2010::AccountContext::RecordingInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/recording.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_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 this Recording resource.

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

    The SID of the Call resource to fetch.



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

Returns:



557
558
559
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 557

def 
    @properties['account_sid']
end

#add_on_results ⇒ add_on_results

Access the add_on_results

Returns:



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

Returns The API version used during the recording.

Returns:

  • (String) —

    The API version used during the recording.



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

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.

Returns:



569
570
571
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 569

def call_sid
    @properties['call_sid']
end

#channels ⇒ String

Returns The number of channels in the recording resource. For information on specifying the number of channels in the downloaded recording file, check out [Fetch a Recording’s media file](www.twilio.com/docs/voice/api/recording#download-dual-channel-media-file).

Returns:



629
630
631
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 629

def channels
    @properties['channels']
end

#conference_sid ⇒ String

Returns The Conference SID that identifies the conference associated with the recording, if a conference recording.

Returns:

  • (String) —

    The Conference SID that identifies the conference associated with the recording, if a conference recording.



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

Returns:



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

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



672
673
674
675
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 672

def delete

    context.delete
end

#duration ⇒ String

Returns The length of the recording in seconds.

Returns:

  • (String) —

    The length of the recording in seconds.



599
600
601
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 599

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.

Returns:



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

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.

Returns:

  • (String) —

    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.



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

Parameters:

  • include_soft_deleted (Boolean) (defaults to: :unset) —

    A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.

Returns:



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

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.

Returns:

  • (String) —

    The URL of the media file associated with this recording resource. When stored externally, this is the full URL location of the media file.



665
666
667
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 665

def media_url
    @properties['media_url']
end

#price ⇒ String

Returns The one-time cost of creating the recording in the price_unit currency.

Returns:

  • (String) —

    The one-time cost of creating the recording in the price_unit currency.



611
612
613
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 611

def price
    @properties['price']
end

#price_unit ⇒ String

Returns The currency used in the price property. Example: USD.

Returns:

  • (String) —

    The currency used in the price property. Example: USD.



617
618
619
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 617

def price_unit
    @properties['price_unit']
end

#sid ⇒ String

Returns The unique string that that we created to identify the Recording resource.

Returns:

  • (String) —

    The unique string that that we created to identify the Recording resource.



605
606
607
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 605

def sid
    @properties['sid']
end

#source ⇒ Source

Returns:

  • (Source) 


635
636
637
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 635

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.

Returns:



593
594
595
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 593

def start_time
    @properties['start_time']
end

#status ⇒ Status

Returns:

  • (Status) 


623
624
625
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 623

def status
    @properties['status']
end

#subresource_uris ⇒ Hash

Returns A list of related resources identified by their relative URIs.

Returns:

  • (Hash) —

    A list of related resources identified by their relative URIs.



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

Returns:



700
701
702
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 700

def transcriptions
    context.transcriptions
end

#uri ⇒ String

Returns The URI of the resource, relative to https://api.twilio.com.

Returns:

  • (String) —

    The URI of the resource, relative to https://api.twilio.com.



647
648
649
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 647

def uri
    @properties['uri']
end