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

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/video/v1/room.rb,
lib/twilio-ruby/rest/video/v1/room/recording.rb

Defined Under Namespace

Classes: RoomRecordingContext, RoomRecordingInstance, RoomRecordingList, RoomRecordingPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ RoomContext

Initialize the RoomContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The sid



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

def initialize(version, sid)
  super(version)

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

  # Dependents
  @recordings = nil
end

Instance Method Details

#fetch ⇒ RoomInstance

Fetch a RoomInstance

Returns:



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

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

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

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

#recordings(sid = :unset) ⇒ RoomRecordingList, RoomRecordingContext

Access the recordings

Returns:

Raises:

  • (ArgumentError) 


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

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

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

  unless @recordings
    @recordings = RoomRecordingList.new(
        @version,
        room_sid: @solution[:sid],
    )
  end

  @recordings
end

#to_s ⇒ Object

Provide a user friendly representation



302
303
304
305
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 302

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

#update(status: nil) ⇒ RoomInstance

Update the RoomInstance

Parameters:

  • status (room.RoomStatus) (defaults to: nil) —

    The status

Returns:



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

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

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

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