Class: Twilio::REST::Video::V1::RoomContext::RoomRecordingContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, room_sid, sid) ⇒ RoomRecordingContext

Initialize the RoomRecordingContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • room_sid (String) —

    The SID of the Room resource with the recording to fetch.

  • sid (String) —

    The SID of the RoomRecording resource to fetch.



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 194

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

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

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the RoomRecordingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



207
208
209
210
211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 207

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

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

#delete_with_metadata ⇒ Boolean

Delete the RoomRecordingInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 220

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      roomRecording_instance = RoomRecordingInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      RoomRecordingInstanceMetadata.new(@version, roomRecording_instance, response.headers, response.status_code)
end

#fetch ⇒ RoomRecordingInstance

Fetch the RoomRecordingInstance

Returns:



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

def fetch

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

#fetch_with_metadata ⇒ RoomRecordingInstance

Fetch the RoomRecordingInstanceMetadata

Returns:



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

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



292
293
294
295
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 292

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

#to_s ⇒ Object

Provide a user friendly representation



285
286
287
288
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 285

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