Class: Twilio::REST::Video::V1::RoomContext::TranscriptionsContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/video/v1/room/transcriptions.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, room_sid, ttid) ⇒ TranscriptionsContext

Initialize the TranscriptionsContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • room_sid (String) —

    The SID of the room with the transcriptions resource to update.

  • ttid (String) —

    The Twilio type id of the transcriptions resource to update.



228
229
230
231
232
233
234
235
236
237
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 228

def initialize(version, room_sid, ttid)
    super(version)
    

    # Path Solution
    @solution = { room_sid: room_sid, ttid: ttid,  }
    @uri = "/Rooms/#{@solution[:room_sid]}/Transcriptions/#{@solution[:ttid]}"

    
end

Instance Method Details

#fetch ⇒ TranscriptionsInstance

Fetch the TranscriptionsInstance

Returns:



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 241

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    TranscriptionsInstance.new(
        @version,
        payload,
        room_sid: @solution[:room_sid],
        ttid: @solution[:ttid],
    )
end

#fetch_with_metadata ⇒ TranscriptionsInstance

Fetch the TranscriptionsInstanceMetadata

Returns:



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 261

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    transcriptions_instance = TranscriptionsInstance.new(
        @version,
        response.body,
        room_sid: @solution[:room_sid],
        ttid: @solution[:ttid],
    )
    TranscriptionsInstanceMetadata.new(
        @version,
        transcriptions_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



360
361
362
363
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 360

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

#to_s ⇒ Object

Provide a user friendly representation



353
354
355
356
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 353

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

#update(status: :unset, configuration: :unset) ⇒ TranscriptionsInstance

Update the TranscriptionsInstance

Parameters:

  • status (Status) (defaults to: :unset)
  • configuration (Object) (defaults to: :unset) —

    A collection of properties that describe transcription behaviour.

Returns:



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 289

def update(
  status: :unset, 
  configuration: :unset
)

    data = Twilio::Values.of({
        'Status' => status,
        'Configuration' => Twilio.serialize_object(configuration),
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    TranscriptionsInstance.new(
        @version,
        payload,
        room_sid: @solution[:room_sid],
        ttid: @solution[:ttid],
    )
end

#update_with_metadata(status: :unset, configuration: :unset) ⇒ TranscriptionsInstance

Update the TranscriptionsInstanceMetadata

Parameters:

  • status (Status) (defaults to: :unset)
  • configuration (Object) (defaults to: :unset) —

    A collection of properties that describe transcription behaviour.

Returns:



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 319

def update_with_metadata(
  status: :unset, 
  configuration: :unset
)

    data = Twilio::Values.of({
        'Status' => status,
        'Configuration' => Twilio.serialize_object(configuration),
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    transcriptions_instance = TranscriptionsInstance.new(
        @version,
        response.body,
        room_sid: @solution[:room_sid],
        ttid: @solution[:ttid],
    )
    TranscriptionsInstanceMetadata.new(
        @version,
        transcriptions_instance,
        response.headers,
        response.status_code
    )
end