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,
lib/twilio-ruby/rest/video/v1/room/room_participant.rb,
lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb,
lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb

Defined Under Namespace

Classes: ParticipantContext, ParticipantInstance, ParticipantList, ParticipantPage, 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 Room Sid or name that uniquely identifies this resource.



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

def initialize(version, sid)
  super(version)

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

  # Dependents
  @recordings = nil
  @participants = nil
end

Instance Method Details

#fetch ⇒ RoomInstance

Fetch a RoomInstance

Returns:



248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 248

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

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

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

#participants(sid = :unset) ⇒ ParticipantList, ParticipantContext

Access the participants

Returns:

Raises:

  • (ArgumentError) 


298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 298

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

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

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

  @participants
end

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

Access the recordings

Returns:

Raises:

  • (ArgumentError) 


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

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



314
315
316
317
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 314

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) —

    Set to ‘completed` to end the Room.

Returns:



264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 264

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