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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the RecordingContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The account_sid

  • conference_sid (String) —

    The conference Sid that uniquely identifies this resource

  • sid (String) —

    The recording Sid that uniquely identifies this resource



188
189
190
191
192
193
194
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 188

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

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

Instance Method Details

#delete ⇒ Boolean

Deletes the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



247
248
249
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 247

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

#fetch ⇒ RecordingInstance

Fetch a RecordingInstance

Returns:



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 226

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

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

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

#to_s ⇒ Object

Provide a user friendly representation



253
254
255
256
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 253

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:



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 205

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],
      conference_sid: @solution[:conference_sid],
      sid: @solution[:sid],
  )
end