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

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

Defined Under Namespace

Classes: AddOnResultContext, AddOnResultInstance, AddOnResultList, AddOnResultPage, TranscriptionContext, TranscriptionInstance, TranscriptionList, TranscriptionPage

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ RecordingContext

Initialize the RecordingContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The account_sid

  • sid (String) —

    The recording Sid that uniquely identifies this resource



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

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

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

  # Dependents
  @transcriptions = nil
  @add_on_results = nil
end

Instance Method Details

#add_on_results(sid = :unset) ⇒ AddOnResultList, AddOnResultContext

Access the add_on_results

Returns:

Raises:

  • (ArgumentError) 


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

def add_on_results(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return AddOnResultContext.new(
        @version,
        @solution[:account_sid],
        @solution[:sid],
        sid,
    )
  end

  unless @add_on_results
    @add_on_results = AddOnResultList.new(
        @version,
        account_sid: @solution[:account_sid],
        reference_sid: @solution[:sid],
    )
  end

  @add_on_results
end

#delete ⇒ Boolean

Deletes the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



230
231
232
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 230

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

#fetch ⇒ RecordingInstance

Fetch a RecordingInstance

Returns:



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 210

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

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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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

#transcriptions(sid = :unset) ⇒ TranscriptionList, TranscriptionContext

Access the transcriptions

Returns:

Raises:

  • (ArgumentError) 


238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 238

def transcriptions(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return TranscriptionContext.new(
        @version,
        @solution[:account_sid],
        @solution[:sid],
        sid,
    )
  end

  unless @transcriptions
    @transcriptions = TranscriptionList.new(
        @version,
        account_sid: @solution[:account_sid],
        recording_sid: @solution[:sid],
    )
  end

  @transcriptions
end