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.



220
221
222
223
224
225
226
227
228
229
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 220

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:



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 233

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:



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 253

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



346
347
348
349
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 346

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

#to_s ⇒ Object

Provide a user friendly representation



339
340
341
342
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 339

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

#update(status: :unset) ⇒ TranscriptionsInstance

Update the TranscriptionsInstance

Parameters:

  • status (Status) (defaults to: :unset)

Returns:



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 280

def update(
    status: :unset
)

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

    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) ⇒ TranscriptionsInstance

Update the TranscriptionsInstanceMetadata

Parameters:

  • status (Status) (defaults to: :unset)

Returns:



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 307

def update_with_metadata(
  status: :unset
)

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

    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