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

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

Instance Method Summary collapse

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 account_sid

  • call_sid (String) —

    The call Sid that uniquely identifies this resource

  • sid (String) —

    The recording Sid that uniquely identifies this resource



231
232
233
234
235
236
237
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 231

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

  # Path Solution
  @solution = {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

Deletes the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

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

#fetch ⇒ RecordingInstance

Fetch a RecordingInstance

Returns:



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 269

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  RecordingInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      call_sid: @solution[:call_sid],
      sid: @solution[:sid],
  )
end

#to_s ⇒ Object

Provide a user friendly representation



296
297
298
299
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 296

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 (recording.Status) (defaults to: nil) —

    The status to change the recording to. Possible values: ‘stopped`, `paused`, `in-progress`

  • pause_behavior (String) (defaults to: :unset) —

    Only applicable when setting Status parameter to ‘paused`. Possible values: `skip` or `silence`. `skip` will result in no recording at all during the pause period. `silence` will replace the actual audio of the call with silence during the pause period. Defaults to `silence`

Returns:



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 248

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