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



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

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, audio_only: :unset, max_participant_duration: :unset, empty_room_timeout: :unset, unused_room_timeout: :unset, large_room: :unset) ⇒ RoomInstance

Create the RoomInstance



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 50

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, 
    audio_only: :unset, 
    max_participant_duration: :unset, 
    empty_room_timeout: :unset, 
    unused_room_timeout: :unset, 
    large_room: :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),
        'AudioOnly' => audio_only,
        'MaxParticipantDuration' => max_participant_duration,
        'EmptyRoomTimeout' => empty_room_timeout,
        'UnusedRoomTimeout' => unused_room_timeout,
        'LargeRoom' => large_room,
    })

    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.



152
153
154
155
156
157
158
159
160
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 152

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.



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

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.



109
110
111
112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 109

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.



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 173

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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 135

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



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

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