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

Public Class Methods

new(version, account_sid, conference_sid, sid) click to toggle source

Initialize the RecordingContext @param [Version] version Version that contains the resource @param [String] account_sid The SID of the

{Account}[https://www.twilio.com/docs/iam/api/account] that created the
Conference Recording resource to fetch.

@param [String] conference_sid The Conference SID that identifies the conference

associated with the recording to fetch.

@param [String] sid The Twilio-provided string that uniquely identifies the

Conference Recording resource to fetch.

@return [RecordingContext] RecordingContext

Calls superclass method Twilio::REST::InstanceContext::new
    # File lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb
189 def initialize(version, account_sid, conference_sid, sid)
190   super(version)
191 
192   # Path Solution
193   @solution = {account_sid: account_sid, conference_sid: conference_sid, sid: sid, }
194   @uri = "/Accounts/#{@solution[:account_sid]}/Conferences/#{@solution[:conference_sid]}/Recordings/#{@solution[:sid]}.json"
195 end

Public Instance Methods

delete() click to toggle source

Delete the RecordingInstance @return [Boolean] true if delete succeeds, false otherwise

    # File lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb
239 def delete
240    @version.delete('DELETE', @uri)
241 end
fetch() click to toggle source

Fetch the RecordingInstance @return [RecordingInstance] Fetched RecordingInstance

    # File lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb
224 def fetch
225   payload = @version.fetch('GET', @uri)
226 
227   RecordingInstance.new(
228       @version,
229       payload,
230       account_sid: @solution[:account_sid],
231       conference_sid: @solution[:conference_sid],
232       sid: @solution[:sid],
233   )
234 end
inspect() click to toggle source

Provide a detailed, user friendly representation

    # File lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb
252 def inspect
253   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
254   "#<Twilio.Api.V2010.RecordingContext #{context}>"
255 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb
245 def to_s
246   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
247   "#<Twilio.Api.V2010.RecordingContext #{context}>"
248 end
update(status: nil, pause_behavior: :unset) click to toggle source

Update the RecordingInstance @param [recording.Status] status The new status of the recording. Can be:

`stopped`, `paused`, `in-progress`.

@param [String] pause_behavior 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`.

@return [RecordingInstance] Updated RecordingInstance

    # File lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb
207 def update(status: nil, pause_behavior: :unset)
208   data = Twilio::Values.of({'Status' => status, 'PauseBehavior' => pause_behavior, })
209 
210   payload = @version.update('POST', @uri, data: data)
211 
212   RecordingInstance.new(
213       @version,
214       payload,
215       account_sid: @solution[:account_sid],
216       conference_sid: @solution[:conference_sid],
217       sid: @solution[:sid],
218   )
219 end