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/participant.rb,
lib/twilio-ruby/rest/video/v1/room/room_recording.rb,
lib/twilio-ruby/rest/video/v1/room/transcriptions.rb,
lib/twilio-ruby/rest/video/v1/room/recording_rules.rb,
lib/twilio-ruby/rest/video/v1/room/participant/anonymize.rb,
lib/twilio-ruby/rest/video/v1/room/participant/published_track.rb,
lib/twilio-ruby/rest/video/v1/room/participant/subscribe_rules.rb,
lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb

Defined Under Namespace

Classes: ParticipantContext, ParticipantInstance, ParticipantList, ParticipantPage, RecordingRulesInstance, RecordingRulesList, RecordingRulesPage, RoomRecordingContext, RoomRecordingInstance, RoomRecordingList, RoomRecordingPage, TranscriptionsContext, TranscriptionsInstance, TranscriptionsList, TranscriptionsPage

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 of the Room resource to update.



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# 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
    @recording_rules = nil
    @participants = nil
    @transcriptions = nil
    @recordings = nil
end

Instance Method Details

#fetch ⇒ RoomInstance

Fetch the RoomInstance

Returns:



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

def fetch

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



369
370
371
372
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 369

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

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

Access the participants

Returns:

Raises:

  • (ArgumentError) 


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 306

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

#recording_rules ⇒ RecordingRulesList, RecordingRulesContext

Access the recording_rules

Returns:



295
296
297
298
299
300
301
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 295

def recording_rules
  unless @recording_rules
    @recording_rules = RecordingRulesList.new(
            @version, room_sid: @solution[:sid], )
  end
  @recording_rules
end

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

Access the recordings

Returns:

Raises:

  • (ArgumentError) 


344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 344

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



362
363
364
365
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 362

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

#transcriptions(ttid = :unset) ⇒ TranscriptionsList, TranscriptionsContext

Access the transcriptions

Returns:

Raises:

  • (ArgumentError) 


325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 325

def transcriptions(ttid=:unset)

    raise ArgumentError, 'ttid cannot be nil' if ttid.nil?

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

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

 @transcriptions
end

#update(status: nil) ⇒ RoomInstance

Update the RoomInstance

Parameters:

  • status (RoomStatus) (defaults to: nil)

Returns:



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 269

def update(
    status: nil
)

    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)
    RoomInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end