Class: Twilio::REST::Insights::V1::RoomList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ RoomList

Initialize the RoomList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 26

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/Video/Rooms"
    
end

Instance Method Details

#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.



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

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



180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 180

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

#list(room_type: :unset, codec: :unset, room_name: :unset, created_after: :unset, 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:

  • room_type (Array[RoomType]) (defaults to: :unset) —

    Type of room. Can be go, peer_to_peer, group, or group_small.

  • codec (Array[Codec]) (defaults to: :unset) —

    Codecs used by participants in the room. Can be VP8, H264, or VP9.

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

    Room friendly name.

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

    Only read rooms that started on or after this ISO 8601 timestamp.

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

    Only read rooms that started before this ISO 8601 timestamp.

  • 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



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 51

def list(room_type: :unset, codec: :unset, room_name: :unset, created_after: :unset, created_before: :unset, limit: nil, page_size: nil)
    self.stream(
        room_type: room_type,
        codec: codec,
        room_name: room_name,
        created_after: created_after,
        created_before: created_before,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(room_type: :unset, codec: :unset, room_name: :unset, created_after: :unset, created_before: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • 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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 107

def list_with_metadata(room_type: :unset, codec: :unset, room_name: :unset, created_after: :unset, created_before: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        
        'RoomType' =>  Twilio.serialize_list(room_type) { |e| e },
        
        'Codec' =>  Twilio.serialize_list(codec) { |e| e },
        'RoomName' => room_name,
        'CreatedAfter' =>  Twilio.serialize_iso8601_datetime(created_after),
        'CreatedBefore' =>  Twilio.serialize_iso8601_datetime(created_before),
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    RoomPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(room_type: :unset, codec: :unset, room_name: :unset, created_after: :unset, 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:

  • room_type (Array[RoomType]) (defaults to: :unset) —

    Type of room. Can be go, peer_to_peer, group, or group_small.

  • codec (Array[Codec]) (defaults to: :unset) —

    Codecs used by participants in the room. Can be VP8, H264, or VP9.

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

    Room friendly name.

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

    Only read rooms that started on or after this ISO 8601 timestamp.

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

    Only read rooms that started before this ISO 8601 timestamp.

  • 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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 153

def page(room_type: :unset, codec: :unset, room_name: :unset, created_after: :unset, created_before: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        
        'RoomType' =>  Twilio.serialize_list(room_type) { |e| e },
        
        'Codec' =>  Twilio.serialize_list(codec) { |e| e },
        'RoomName' => room_name,
        'CreatedAfter' =>  Twilio.serialize_iso8601_datetime(created_after),
        'CreatedBefore' =>  Twilio.serialize_iso8601_datetime(created_before),
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(room_type: :unset, codec: :unset, room_name: :unset, created_after: :unset, created_before: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • room_type (Array[RoomType]) (defaults to: :unset) —

    Type of room. Can be go, peer_to_peer, group, or group_small.

  • codec (Array[Codec]) (defaults to: :unset) —

    Codecs used by participants in the room. Can be VP8, H264, or VP9.

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

    Room friendly name.

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

    Only read rooms that started on or after this ISO 8601 timestamp.

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

    Only read rooms that started before this ISO 8601 timestamp.

  • 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



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 79

def stream(room_type: :unset, codec: :unset, room_name: :unset, created_after: :unset, created_before: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        room_type: room_type,
        codec: codec,
        room_name: room_name,
        created_after: created_after,
        created_before: 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



191
192
193
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 191

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