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.



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 326

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.



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

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:



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

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.



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

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.



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

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.



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

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.



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

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.



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

def end_time
  @properties['end_time']
end

#fetch ⇒ RoomInstance

Fetch a RoomInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



513
514
515
516
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 513

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



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

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.



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

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.



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

def media_region
  @properties['media_region']
end

#participants ⇒ participants

Access the participants

Returns:



500
501
502
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 500

def participants
  context.participants
end

#record_participants_on_connect ⇒ Boolean

Returns Start recording when Participants connect.

Returns:

  • (Boolean) —

    Start recording when Participants connect.



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

def record_participants_on_connect
  @properties['record_participants_on_connect']
end

#recordings ⇒ recordings

Access the recordings

Returns:



493
494
495
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 493

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.



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

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.



375
376
377
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 375

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.



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

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.



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

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



506
507
508
509
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 506

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.



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

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.



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

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:



486
487
488
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 486

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.



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

def url
  @properties['url']
end

#video_codecs ⇒ room.VideoCodec

Returns The video_codecs.

Returns:

  • (room.VideoCodec) —

    The video_codecs



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

def video_codecs
  @properties['video_codecs']
end