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 SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Conference Recording resource to update.

  • conference_sid (String) —

    The Conference SID that identifies the conference associated with the recording to update.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Conference Recording resource to update. Use ‘Twilio.CURRENT` to reference the current active recording.



155
156
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 155

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

Delete the RecordingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



167
168
169
170
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 167

def delete

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

#fetch ⇒ RecordingInstance

Fetch the RecordingInstance

Returns:



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 175

def fetch

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



222
223
224
225
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 222

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

#to_s ⇒ Object

Provide a user friendly representation



215
216
217
218
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 215

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:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb', line 192

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