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



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

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 SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

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:



376
377
378
379
380
381
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 376

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

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



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

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



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

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



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

def enable_turn
  @properties['enable_turn']
end

#end_time ⇒ Time

Returns The UTC end time of the room in UTC ISO 8601 format.

Returns:

  • (Time) —

    The UTC end time of the room in UTC ISO 8601 format



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

def end_time
  @properties['end_time']
end

#fetch ⇒ RoomInstance

Fetch the RoomInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources



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

def links
  @properties['links']
end

#max_participants ⇒ String

Returns The maximum number of concurrent Participants allowed in the room.

Returns:

  • (String) —

    The maximum number of concurrent Participants allowed in the room



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

def max_participants
  @properties['max_participants']
end

#media_region ⇒ String

Returns The region for the media server in Group Rooms.

Returns:

  • (String) —

    The region for the media server in Group Rooms



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

def media_region
  @properties['media_region']
end

#participants ⇒ participants

Access the participants

Returns:



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

def participants
  context.participants
end

#record_participants_on_connect ⇒ Boolean

Returns Whether to start recording when Participants connect.

Returns:

  • (Boolean) —

    Whether to start recording when Participants connect



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

def record_participants_on_connect
  @properties['record_participants_on_connect']
end

#recording_rules ⇒ recording_rules

Access the recording_rules

Returns:



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

def recording_rules
  context.recording_rules
end

#recordings ⇒ recordings

Access the recordings

Returns:



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

def recordings
  context.recordings
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#status ⇒ room.RoomStatus

Returns The status of the room.

Returns:

  • (room.RoomStatus) —

    The status of the room



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

def status
  @properties['status']
end

#status_callback ⇒ String

Returns The URL to send status information to your application.

Returns:

  • (String) —

    The URL to send status information to your application



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

def status_callback
  @properties['status_callback']
end

#status_callback_method ⇒ String

Returns The HTTP method we use to call status_callback.

Returns:

  • (String) —

    The HTTP method we use to call status_callback



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

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



530
531
532
533
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 530

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

#type ⇒ room.RoomType

Returns The type of room.

Returns:

  • (room.RoomType) —

    The type of room



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

def type
  @properties['type']
end

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource



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

def unique_name
  @properties['unique_name']
end

#update(status: nil) ⇒ RoomInstance

Update the RoomInstance

Parameters:

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

    The new status of the resource. Set to ‘completed` to end the room.

Returns:



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

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



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

def url
  @properties['url']
end

#video_codecs ⇒ room.VideoCodec

Returns An array of the video codecs that are supported when publishing a track in the room.

Returns:

  • (room.VideoCodec) —

    An array of the video codecs that are supported when publishing a track in the room



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

def video_codecs
  @properties['video_codecs']
end