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



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

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, transcribe_participants_on_connect: :unset, video_codecs: :unset, media_region: :unset, recording_rules: :unset, transcriptions_configuration: :unset, audio_only: :unset, max_participant_duration: :unset, empty_room_timeout: :unset, unused_room_timeout: :unset, large_room: :unset) ⇒ RoomInstance

Create the RoomInstance



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
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 53

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, 
    transcribe_participants_on_connect: :unset, 
    video_codecs: :unset, 
    media_region: :unset, 
    recording_rules: :unset, 
    transcriptions_configuration: :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,
        'TranscribeParticipantsOnConnect' => transcribe_participants_on_connect,
        'VideoCodecs' => Twilio.serialize_list(video_codecs) { |e| e },
        'MediaRegion' => media_region,
        'RecordingRules' => Twilio.serialize_object(recording_rules),
        'TranscriptionsConfiguration' => Twilio.serialize_object(transcriptions_configuration),
        'AudioOnly' => audio_only,
        'MaxParticipantDuration' => max_participant_duration,
        'EmptyRoomTimeout' => empty_room_timeout,
        'UnusedRoomTimeout' => unused_room_timeout,
        'LargeRoom' => large_room,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    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.



165
166
167
168
169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 165

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.



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

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.



122
123
124
125
126
127
128
129
130
131
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 122

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.



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 186

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,
    })
    headers = Twilio::Values.of({})
    
    

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

    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.



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

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



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

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