class Twilio::REST::Video::V1::RoomContext

Public Class Methods

new(version, sid) click to toggle source

Initialize the RoomContext @param [Version] version Version that contains the resource @param [String] sid The SID of the Room resource to fetch. @return [RoomContext] RoomContext

Calls superclass method Twilio::REST::InstanceContext::new
    # File lib/twilio-ruby/rest/video/v1/room.rb
240 def initialize(version, sid)
241   super(version)
242 
243   # Path Solution
244   @solution = {sid: sid, }
245   @uri = "/Rooms/#{@solution[:sid]}"
246 
247   # Dependents
248   @recordings = nil
249   @participants = nil
250   @recording_rules = nil
251 end

Public Instance Methods

fetch() click to toggle source

Fetch the RoomInstance @return [RoomInstance] Fetched RoomInstance

    # File lib/twilio-ruby/rest/video/v1/room.rb
256 def fetch
257   payload = @version.fetch('GET', @uri)
258 
259   RoomInstance.new(@version, payload, sid: @solution[:sid], )
260 end
inspect() click to toggle source

Provide a detailed, user friendly representation

    # File lib/twilio-ruby/rest/video/v1/room.rb
332 def inspect
333   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
334   "#<Twilio.Video.V1.RoomContext #{context}>"
335 end
participants(sid=:unset) click to toggle source

Access the participants @return [ParticipantList] @return [ParticipantContext] if sid was passed.

    # File lib/twilio-ruby/rest/video/v1/room.rb
297 def participants(sid=:unset)
298   raise ArgumentError, 'sid cannot be nil' if sid.nil?
299 
300   if sid != :unset
301     return ParticipantContext.new(@version, @solution[:sid], sid, )
302   end
303 
304   unless @participants
305     @participants = ParticipantList.new(@version, room_sid: @solution[:sid], )
306   end
307 
308   @participants
309 end
recording_rules() click to toggle source

Access the recording_rules @return [RecordingRulesList] @return [RecordingRulesContext]

    # File lib/twilio-ruby/rest/video/v1/room.rb
315 def recording_rules
316   unless @recording_rules
317     @recording_rules = RecordingRulesList.new(@version, room_sid: @solution[:sid], )
318   end
319 
320   @recording_rules
321 end
recordings(sid=:unset) click to toggle source

Access the recordings @return [RoomRecordingList] @return [RoomRecordingContext] if sid was passed.

    # File lib/twilio-ruby/rest/video/v1/room.rb
279 def recordings(sid=:unset)
280   raise ArgumentError, 'sid cannot be nil' if sid.nil?
281 
282   if sid != :unset
283     return RoomRecordingContext.new(@version, @solution[:sid], sid, )
284   end
285 
286   unless @recordings
287     @recordings = RoomRecordingList.new(@version, room_sid: @solution[:sid], )
288   end
289 
290   @recordings
291 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/video/v1/room.rb
325 def to_s
326   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
327   "#<Twilio.Video.V1.RoomContext #{context}>"
328 end
update(status: nil) click to toggle source

Update the RoomInstance @param [room.RoomStatus] status The new status of the resource. Set to

`completed` to end the room.

@return [RoomInstance] Updated RoomInstance

    # File lib/twilio-ruby/rest/video/v1/room.rb
267 def update(status: nil)
268   data = Twilio::Values.of({'Status' => status, })
269 
270   payload = @version.update('POST', @uri, data: data)
271 
272   RoomInstance.new(@version, payload, sid: @solution[:sid], )
273 end