Class: Twilio::REST::Api::V2010::AccountContext::CallContext::RecordingContext

Inherits:

InstanceContext

• Object
• InstanceContext
• Twilio::REST::Api::V2010::AccountContext::CallContext::RecordingContext

Defined in:

lib/twilio-ruby/rest/api/v2010/account/call/recording.rb

Instance Method Summary

• #delete ⇒ Boolean

  Delete the RecordingInstance.

• #fetch ⇒ RecordingInstance

  Fetch the RecordingInstance.

• #initialize(version, account_sid, call_sid, sid) ⇒ RecordingContext constructor

  Initialize the RecordingContext.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(status: nil, pause_behavior: :unset) ⇒ RecordingInstance

  Update the RecordingInstance.

Constructor Details

#initialize(version, account_sid, call_sid, sid) ⇒ RecordingContext

Initialize the RecordingContext

Parameters:

• version (Version) —

  Version that contains the resource

• account_sid (String) —

  The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Recording resource to update.

• call_sid (String) —

  The [Call](www.twilio.com/docs/voice/api/call-resource) SID of the resource to update.

• sid (String) —

  The Twilio-provided string that uniquely identifies the Recording resource to update.

# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 191

def initialize(version, account_sid, call_sid, sid)
    super(version)

    # Path Solution
    @solution = { account_sid: account_sid, call_sid: call_sid, sid: sid,  }
    @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Recordings/#{@solution[:sid]}.json"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the RecordingInstance

Returns:

• (Boolean) —

  True if delete succeeds, false otherwise

# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 203

def delete

    @version.delete('DELETE', @uri)
end

#fetch ⇒ RecordingInstance

Fetch the RecordingInstance

Returns:

• (RecordingInstance) —

  Fetched RecordingInstance

# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 211

def fetch

    payload = @version.fetch('GET', @uri)
    RecordingInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        call_sid: @solution[:call_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 258

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.RecordingContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 251

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.RecordingContext #{context}>"
end

#update(status: nil, pause_behavior: :unset) ⇒ RecordingInstance

Update the RecordingInstance

Parameters:

• status (Status) (defaults to: nil)
• pause_behavior (String) (defaults to: :unset) —

  Whether to record during a pause. Can be: ‘skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`.

Returns:

• (RecordingInstance) —

  Updated RecordingInstance

# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 228

def update(
    status: nil, 
    pause_behavior: :unset
)

    data = Twilio::Values.of({
        'Status' => status,
        'PauseBehavior' => pause_behavior,
    })

    payload = @version.update('POST', @uri, data: data)
    RecordingInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        call_sid: @solution[:call_sid],
        sid: @solution[:sid],
    )
end