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

Inherits:

InstanceResource

Object
InstanceResource
Twilio::REST::Video::V1::RoomInstance

show all

Defined in:: lib/twilio-ruby/rest/video/v1/room.rb

Instance Method Summary collapse

#account_sid ⇒ String

The SID of the Account that created the resource.
#context ⇒ RoomContext

Generate an instance context for the instance, the context is capable of performing various actions.
#date_created ⇒ Time

The ISO 8601 date and time in GMT when the resource was created.
#date_updated ⇒ Time

The ISO 8601 date and time in GMT when the resource was last updated.
#duration ⇒ String

The duration of the room in seconds.
#enable_turn ⇒ Boolean

Enable Twilio’s Network Traversal TURN service.
#end_time ⇒ Time

The UTC end time of the room in UTC ISO 8601 format.
#fetch ⇒ RoomInstance

Fetch the RoomInstance.
#initialize(version, payload, sid: nil) ⇒ RoomInstance constructor

Initialize the RoomInstance.
#inspect ⇒ Object

Provide a detailed, user friendly representation.
#links ⇒ String

The URLs of related resources.
#max_participants ⇒ String

The maximum number of concurrent Participants allowed in the room.
#media_region ⇒ String

The region for the media server in Group Rooms.
#participants ⇒ participants

Access the participants.
#record_participants_on_connect ⇒ Boolean

Whether to start recording when Participants connect.
#recordings ⇒ recordings

Access the recordings.
#sid ⇒ String

The unique string that identifies the resource.
#status ⇒ room.RoomStatus

The status of the room.
#status_callback ⇒ String

The URL to send status information to your application.
#status_callback_method ⇒ String

The HTTP method we use to call status_callback.
#to_s ⇒ Object

Provide a user friendly representation.
#type ⇒ room.RoomType

The type of room.
#unique_name ⇒ String

An application-defined string that uniquely identifies the resource.
#update(status: nil) ⇒ RoomInstance

Update the RoomInstance.
#url ⇒ String

The absolute URL of the resource.
#video_codecs ⇒ room.VideoCodec

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

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.

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

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



398
399
400

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

def account_sid
  @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:

(RoomContext) —

RoomContext for this RoomInstance

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

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



386
387
388

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

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



392
393
394

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

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



434
435
436

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

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



404
405
406

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

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



428
429
430

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

def end_time
  @properties['end_time']
end

#fetch ⇒ `RoomInstance`

Fetch the RoomInstance

Returns:

(RoomInstance) —

Fetched RoomInstance



483
484
485

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

def fetch
  context.fetch
end

#inspect ⇒ `Object`

Provide a detailed, user friendly representation

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

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



476
477
478

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

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



446
447
448

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

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



464
465
466

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

def media_region
  @properties['media_region']
end

#participants ⇒ `participants`

Access the participants

Returns:

(participants) —

participants



506
507
508

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

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



452
453
454

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

def record_participants_on_connect
  @properties['record_participants_on_connect']
end

#recordings ⇒ `recordings`

Access the recordings

Returns:

(recordings) —

recordings



499
500
501

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

def recordings
  context.recordings
end

#sid ⇒ `String`

Returns The unique string that identifies the resource.

Returns:

(String) —

The unique string that identifies the resource



374
375
376

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

def sid
  @properties['sid']
end

#status ⇒ `room.RoomStatus`

Returns The status of the room.

Returns:

(room.RoomStatus) —

The status of the room



380
381
382

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

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



416
417
418

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

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



422
423
424

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

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ `Object`

Provide a user friendly representation

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

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



440
441
442

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

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



410
411
412

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

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:

(RoomInstance) —

Updated RoomInstance



492
493
494

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

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



470
471
472

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

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



458
459
460

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

def video_codecs
  @properties['video_codecs']
end

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

Instance Method Summary collapse

Constructor Details

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

Instance Method Details

#account_sid ⇒ String

#context ⇒ RoomContext

#date_created ⇒ Time

#date_updated ⇒ Time

#duration ⇒ String

#enable_turn ⇒ Boolean

#end_time ⇒ Time

#fetch ⇒ RoomInstance

#inspect ⇒ Object

#links ⇒ String

#max_participants ⇒ String

#media_region ⇒ String

#participants ⇒ participants

#record_participants_on_connect ⇒ Boolean

#recordings ⇒ recordings

#sid ⇒ String

#status ⇒ room.RoomStatus

#status_callback ⇒ String

#status_callback_method ⇒ String

#to_s ⇒ Object

#type ⇒ room.RoomType

#unique_name ⇒ String

#update(status: nil) ⇒ RoomInstance

#url ⇒ String

#video_codecs ⇒ room.VideoCodec

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

#account_sid ⇒ `String`

#context ⇒ `RoomContext`

#date_created ⇒ `Time`

#date_updated ⇒ `Time`

#duration ⇒ `String`

#enable_turn ⇒ `Boolean`

#end_time ⇒ `Time`

#fetch ⇒ `RoomInstance`

#inspect ⇒ `Object`

#links ⇒ `String`

#max_participants ⇒ `String`

#media_region ⇒ `String`

#participants ⇒ `participants`

#record_participants_on_connect ⇒ `Boolean`

#recordings ⇒ `recordings`

#sid ⇒ `String`

#status ⇒ `room.RoomStatus`

#status_callback ⇒ `String`

#status_callback_method ⇒ `String`

#to_s ⇒ `Object`

#type ⇒ `room.RoomType`

#unique_name ⇒ `String`

#update(status: nil) ⇒ `RoomInstance`

#url ⇒ `String`

#video_codecs ⇒ `room.VideoCodec`