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.



165
166
167
168
169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 165

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:



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 177

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



231
232
233
234
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 231

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

#to_s ⇒ Object

Provide a user friendly representation



224
225
226
227
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 224

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:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/twilio-ruby/rest/video/v1/room/transcriptions.rb', line 198

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