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, ParticipantInstanceMetadata, ParticipantList, ParticipantListResponse, ParticipantPage, ParticipantPageMetadata, RecordingRulesInstance, RecordingRulesList, RecordingRulesListResponse, RecordingRulesPage, RecordingRulesPageMetadata, RoomRecordingContext, RoomRecordingInstance, RoomRecordingInstanceMetadata, RoomRecordingList, RoomRecordingListResponse, RoomRecordingPage, RoomRecordingPageMetadata, TranscriptionsContext, TranscriptionsInstance, TranscriptionsInstanceMetadata, TranscriptionsList, TranscriptionsListResponse, TranscriptionsPage, TranscriptionsPageMetadata

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.



351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 351

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:



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 368

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

#fetch_with_metadata ⇒ RoomInstance

Fetch the RoomInstanceMetadata

Returns:



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 387

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_instance = RoomInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    RoomInstanceMetadata.new(
        @version,
        room_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



545
546
547
548
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 545

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) 


482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 482

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:



471
472
473
474
475
476
477
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 471

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) 


520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 520

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



538
539
540
541
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 538

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) 


501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 501

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:



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 413

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

#update_with_metadata(status: nil) ⇒ RoomInstance

Update the RoomInstanceMetadata

Parameters:

  • status (RoomStatus) (defaults to: nil)

Returns:



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 439

def update_with_metadata(
  status: nil
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    room_instance = RoomInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    RoomInstanceMetadata.new(
        @version,
        room_instance,
        response.headers,
        response.status_code
    )
end