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



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

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) ⇒ RoomInstance

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

Parameters:

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

    The enable_turn

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

    The type

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

    The unique_name

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

    The status_callback

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

    The status_callback_method

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

    The max_participants

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

    The record_participants_on_connect

  • video_codecs (room.VideoCodec) (defaults to: :unset) —

    The video_codecs

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

    The media_region

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 38

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)
  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,
  })

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

  RoomInstance.new(@version, payload, )
end

#each ⇒ Object

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



119
120
121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 119

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



163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 163

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) —

    The status

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

    The unique_name

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

    The date_created_after

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

    The date_created_before

  • 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



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 75

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) —

    The status

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

    The unique_name

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

    The date_created_after

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

    The date_created_before

  • 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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 140

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
  )
  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) —

    The status

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

    The unique_name

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

    The date_created_after

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

    The date_created_before

  • 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



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 101

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_s ⇒ Object

Provide a user friendly representation



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

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