Class: Twilio::REST::Video::V1::RoomList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ RoomList

Initialize the RoomList

Parameters:

  • version (Version)

    Version that contains the resource


18
19
20
21
22
23
24
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Rooms"
end

Instance Method Details

#create(enable_turn: :unset, type: :unset, unique_name: :unset, status_callback: :unset, status_callback_method: :unset, max_participants: :unset, record_participants_on_connect: :unset, video_codecs: :unset, media_region: :unset, recording_rules: :unset) ⇒ RoomInstance

Create the RoomInstance

Parameters:

  • enable_turn (Boolean) (defaults to: :unset)

    Deprecated, now always considered to be true.

  • type (room.RoomType) (defaults to: :unset)

    The type of room. Can be: `go`, `peer-to-peer`, `group-small`, or `group`. The default value is `group`.

  • unique_name (String) (defaults to: :unset)

    An application-defined string that uniquely identifies the resource. It can be used as a `room_sid` in place of the resource's `sid` in the URL to address the resource. This value is unique for `in-progress` rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is `in-progress`.

  • status_callback (String) (defaults to: :unset)

    The URL we should call using the `status_callback_method` to send status information to your application on every room event. See Status Callbacks for more info.

  • status_callback_method (String) (defaults to: :unset)

    The HTTP method we should use to call `status_callback`. Can be `POST` or `GET`.

  • max_participants (String) (defaults to: :unset)

    The maximum number of concurrent Participants allowed in the room. Peer-to-peer rooms can have up to 10 Participants. Small Group rooms can have up to 4 Participants. Group rooms can have up to 50 Participants.

  • record_participants_on_connect (Boolean) (defaults to: :unset)

    Whether to start recording when Participants connect. ***This feature is not available in `peer-to-peer` rooms.***

  • video_codecs (Array[room.VideoCodec]) (defaults to: :unset)

    An array of the video codecs that are supported when publishing a track in the room. Can be: `VP8` and `H264`. ***This feature is not available in `peer-to-peer` rooms***

  • media_region (String) (defaults to: :unset)

    The region for the media server in Group Rooms. Can be: one of the available Media Regions. ***This feature is not available in `peer-to-peer` rooms.***

  • recording_rules (Hash) (defaults to: :unset)

    A collection of Recording Rules that describe how to include or exclude matching tracks for recording

Returns:


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 61

def create(enable_turn: :unset, type: :unset, unique_name: :unset, status_callback: :unset, status_callback_method: :unset, max_participants: :unset, record_participants_on_connect: :unset, video_codecs: :unset, media_region: :unset, recording_rules: :unset)
  data = Twilio::Values.of({
      'EnableTurn' => enable_turn,
      'Type' => type,
      'UniqueName' => unique_name,
      'StatusCallback' => status_callback,
      'StatusCallbackMethod' => status_callback_method,
      'MaxParticipants' => max_participants,
      'RecordParticipantsOnConnect' => record_participants_on_connect,
      'VideoCodecs' => Twilio.serialize_list(video_codecs) { |e| e },
      'MediaRegion' => media_region,
      'RecordingRules' => Twilio.serialize_object(recording_rules),
  })

  payload = @version.create('POST', @uri, data: data)

  RoomInstance.new(@version, payload, )
end

#eachObject

When passed a block, yields RoomInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.


145
146
147
148
149
150
151
152
153
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 145

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of RoomInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of RoomInstance


190
191
192
193
194
195
196
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 190

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  RoomPage.new(@version, response, @solution)
end

#list(status: :unset, unique_name: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil) ⇒ Array

Lists RoomInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

  • status (room.RoomStatus) (defaults to: :unset)

    Read only the rooms with this status. Can be: `in-progress` (default) or `completed`

  • unique_name (String) (defaults to: :unset)

    Read only rooms with the this `unique_name`.

  • date_created_after (Time) (defaults to: :unset)

    Read only rooms that started on or after this date, given as `YYYY-MM-DD`.

  • date_created_before (Time) (defaults to: :unset)

    Read only rooms that started before this date, given as `YYYY-MM-DD`.

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array)

    Array of up to limit results


98
99
100
101
102
103
104
105
106
107
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 98

def list(status: :unset, unique_name: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil)
  self.stream(
      status: status,
      unique_name: unique_name,
      date_created_after: date_created_after,
      date_created_before: date_created_before,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(status: :unset, unique_name: :unset, date_created_after: :unset, date_created_before: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of RoomInstance records from the API. Request is executed immediately.

Parameters:

  • status (room.RoomStatus) (defaults to: :unset)

    Read only the rooms with this status. Can be: `in-progress` (default) or `completed`

  • unique_name (String) (defaults to: :unset)

    Read only rooms with the this `unique_name`.

  • date_created_after (Time) (defaults to: :unset)

    Read only rooms that started on or after this date, given as `YYYY-MM-DD`.

  • date_created_before (Time) (defaults to: :unset)

    Read only rooms that started before this date, given as `YYYY-MM-DD`.

  • page_token (String) (defaults to: :unset)

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset)

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • (Page)

    Page of RoomInstance


169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 169

def page(status: :unset, unique_name: :unset, date_created_after: :unset, date_created_before: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Status' => status,
      'UniqueName' => unique_name,
      'DateCreatedAfter' => Twilio.serialize_iso8601_datetime(date_created_after),
      'DateCreatedBefore' => Twilio.serialize_iso8601_datetime(date_created_before),
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  RoomPage.new(@version, response, @solution)
end

#stream(status: :unset, unique_name: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams RoomInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • status (room.RoomStatus) (defaults to: :unset)

    Read only the rooms with this status. Can be: `in-progress` (default) or `completed`

  • unique_name (String) (defaults to: :unset)

    Read only rooms with the this `unique_name`.

  • date_created_after (Time) (defaults to: :unset)

    Read only rooms that started on or after this date, given as `YYYY-MM-DD`.

  • date_created_before (Time) (defaults to: :unset)

    Read only rooms that started before this date, given as `YYYY-MM-DD`.

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable)

    Enumerable that will yield up to limit results


127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 127

def stream(status: :unset, unique_name: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      status: status,
      unique_name: unique_name,
      date_created_after: date_created_after,
      date_created_before: date_created_before,
      page_size: limits[:page_size],
  )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_sObject

Provide a user friendly representation


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

def to_s
  '#<Twilio.Video.V1.RoomList>'
end