Class: Twilio::REST::Video::V1::RoomInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ RoomInstance

Initialize the RoomInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • sid (String) (defaults to: nil) —

    The Room Sid or name that uniquely identifies this resource.



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 337

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'status' => payload['status'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'account_sid' => payload['account_sid'],
      'enable_turn' => payload['enable_turn'],
      'unique_name' => payload['unique_name'],
      'status_callback' => payload['status_callback'],
      'status_callback_method' => payload['status_callback_method'],
      'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
      'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
      'type' => payload['type'],
      'max_participants' => payload['max_participants'].to_i,
      'record_participants_on_connect' => payload['record_participants_on_connect'],
      'video_codecs' => payload['video_codecs'],
      'media_region' => payload['media_region'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the Account associated with this Room.

Returns:

  • (String) —

    The unique ID of the Account associated with this Room.



404
405
406
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 404

def 
  @properties['account_sid']
end

#context ⇒ RoomContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



371
372
373
374
375
376
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 371

def context
  unless @instance_context
    @instance_context = RoomContext.new(@version, @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The date that this resource was created, given as a UTC ISO 8601 Timestamp.

Returns:

  • (Time) —

    The date that this resource was created, given as a UTC ISO 8601 Timestamp.



392
393
394
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 392

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated, given as a UTC ISO 8601 Timestamp.

Returns:

  • (Time) —

    The date that this resource was last updated, given as a UTC ISO 8601 Timestamp.



398
399
400
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 398

def date_updated
  @properties['date_updated']
end

#duration ⇒ String

Returns The duration of the Room in seconds.

Returns:

  • (String) —

    The duration of the Room in seconds.



440
441
442
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 440

def duration
  @properties['duration']
end

#enable_turn ⇒ Boolean

Returns Enable Twilio’s Network Traversal TURN service.

Returns:

  • (Boolean) —

    Enable Twilio’s Network Traversal TURN service.



410
411
412
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 410

def enable_turn
  @properties['enable_turn']
end

#end_time ⇒ Time

Returns The end time of the Room, given as a UTC ISO 8601 Timestamp.

Returns:

  • (Time) —

    The end time of the Room, given as a UTC ISO 8601 Timestamp.



434
435
436
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 434

def end_time
  @properties['end_time']
end

#fetch ⇒ RoomInstance

Fetch a RoomInstance

Returns:



489
490
491
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 489

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



524
525
526
527
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 524

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Video.V1.RoomInstance #{values}>"
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



482
483
484
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 482

def links
  @properties['links']
end

#max_participants ⇒ String

Returns Maximum number of concurrent Participants allowed in the Room.

Returns:

  • (String) —

    Maximum number of concurrent Participants allowed in the Room.



452
453
454
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 452

def max_participants
  @properties['max_participants']
end

#media_region ⇒ String

Returns Region for the media server in Group Rooms.

Returns:

  • (String) —

    Region for the media server in Group Rooms.



470
471
472
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 470

def media_region
  @properties['media_region']
end

#participants ⇒ participants

Access the participants

Returns:



511
512
513
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 511

def participants
  context.participants
end

#record_participants_on_connect ⇒ Boolean

Returns Start recording when Participants connect.

Returns:

  • (Boolean) —

    Start recording when Participants connect.



458
459
460
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 458

def record_participants_on_connect
  @properties['record_participants_on_connect']
end

#recordings ⇒ recordings

Access the recordings

Returns:



504
505
506
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 504

def recordings
  context.recordings
end

#sid ⇒ String

Returns A system-generated 34-character string that uniquely identifies this resource.

Returns:

  • (String) —

    A system-generated 34-character string that uniquely identifies this resource.



380
381
382
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 380

def sid
  @properties['sid']
end

#status ⇒ room.RoomStatus

Returns A string representing the status of the Room.

Returns:

  • (room.RoomStatus) —

    A string representing the status of the Room.



386
387
388
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 386

def status
  @properties['status']
end

#status_callback ⇒ String

Returns A URL that Twilio sends asynchronous webhook requests to on every Room event.

Returns:

  • (String) —

    A URL that Twilio sends asynchronous webhook requests to on every Room event.



422
423
424
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 422

def status_callback
  @properties['status_callback']
end

#status_callback_method ⇒ String

Returns HTTP method Twilio should use when requesting the above URL.

Returns:

  • (String) —

    HTTP method Twilio should use when requesting the above URL.



428
429
430
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 428

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



517
518
519
520
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 517

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Video.V1.RoomInstance #{values}>"
end

#type ⇒ room.RoomType

Returns Type of Room, either peer-to-peer, group-small or group.

Returns:

  • (room.RoomType) —

    Type of Room, either peer-to-peer, group-small or group.



446
447
448
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 446

def type
  @properties['type']
end

#unique_name ⇒ String

Returns A developer-supplied Name of the Room.

Returns:

  • (String) —

    A developer-supplied Name of the Room.



416
417
418
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 416

def unique_name
  @properties['unique_name']
end

#update(status: nil) ⇒ RoomInstance

Update the RoomInstance

Parameters:

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

    Set to ‘completed` to end the Room.

Returns:



497
498
499
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 497

def update(status: nil)
  context.update(status: status, )
end

#url ⇒ String

Returns The absolute URL for this resource.

Returns:

  • (String) —

    The absolute URL for this resource.



476
477
478
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 476

def url
  @properties['url']
end

#video_codecs ⇒ room.VideoCodec

Returns The video_codecs.

Returns:

  • (room.VideoCodec) —

    The video_codecs



464
465
466
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 464

def video_codecs
  @properties['video_codecs']
end