com.twilio.rest.video.v1

Class RoomReader

java.lang.Object

com.twilio.base.Reader<Room>

com.twilio.rest.video.v1.RoomReader

public class RoomReader
extends Reader<Room>

Constructor Summary

Constructors

Constructor and Description
RoomReader()

Method Summary

Modifier and Type	Method and Description
Page<Room>	firstPage(TwilioRestClient client) Make the request to the Twilio API to perform the read.
Page<Room>	getPage(String targetUrl, TwilioRestClient client) Retrieve the target page from the Twilio API.
Page<Room>	nextPage(Page<Room> page, TwilioRestClient client) Retrieve the next page from the Twilio API.
Page<Room>	previousPage(Page<Room> page, TwilioRestClient client) Retrieve the previous page from the Twilio API.
ResourceSet<Room>	read(TwilioRestClient client) Make the request to the Twilio API to perform the read.
RoomReader	setDateCreatedAfter(ZonedDateTime dateCreatedAfter) Read only rooms that started on or after this date, given as `YYYY-MM-DD`..
RoomReader	setDateCreatedBefore(ZonedDateTime dateCreatedBefore) Read only rooms that started before this date, given as `YYYY-MM-DD`..
RoomReader	setStatus(Room.RoomStatus status) Read only the rooms with this status.
RoomReader	setUniqueName(String uniqueName) Read only rooms with the this `unique_name`..

Methods inherited from class com.twilio.base.Reader

firstPage, getLimit, getPage, getPageSize, limit, nextPage, pageSize, previousPage, read, readAsync, readAsync

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RoomReader

public RoomReader()

Method Detail

setStatus

public RoomReader setStatus(Room.RoomStatus status)

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

Parameters:

status - Read only the rooms with this status

Returns:

this

setUniqueName

public RoomReader setUniqueName(String uniqueName)

Read only rooms with the this `unique_name`..

Parameters:

uniqueName - Read only rooms with this unique_name

Returns:

this

setDateCreatedAfter

public RoomReader setDateCreatedAfter(ZonedDateTime dateCreatedAfter)

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

Parameters:

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

Returns:

this

setDateCreatedBefore

public RoomReader setDateCreatedBefore(ZonedDateTime dateCreatedBefore)

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

Parameters:

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

Returns:

this

read

public ResourceSet<Room> read(TwilioRestClient client)

Make the request to the Twilio API to perform the read.

Specified by:

read in class Reader<Room>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Room ResourceSet

firstPage

public Page<Room> firstPage(TwilioRestClient client)

Make the request to the Twilio API to perform the read.

Specified by:

firstPage in class Reader<Room>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Room ResourceSet

getPage

public Page<Room> getPage(String targetUrl,
                          TwilioRestClient client)

Retrieve the target page from the Twilio API.

Specified by:

getPage in class Reader<Room>

Parameters:

targetUrl - API-generated URL for the requested results page

client - TwilioRestClient with which to make the request

Returns:

Room ResourceSet

nextPage

public Page<Room> nextPage(Page<Room> page,
                           TwilioRestClient client)

Retrieve the next page from the Twilio API.

Specified by:

nextPage in class Reader<Room>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Next Page

previousPage

public Page<Room> previousPage(Page<Room> page,
                               TwilioRestClient client)

Retrieve the previous page from the Twilio API.

Specified by:

previousPage in class Reader<Room>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Previous Page