com.twilio.rest.video.v1.RoomReader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of twilio Show documentation
Show all versions of twilio Show documentation
Twilio Java Helper Library
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
package com.twilio.rest.video.v1;
import com.twilio.base.Page;
import com.twilio.base.Reader;
import com.twilio.base.ResourceSet;
import com.twilio.converter.DateConverter;
import com.twilio.exception.ApiConnectionException;
import com.twilio.exception.ApiException;
import com.twilio.exception.RestException;
import com.twilio.http.HttpMethod;
import com.twilio.http.Request;
import com.twilio.http.Response;
import com.twilio.http.TwilioRestClient;
import com.twilio.rest.Domains;
import java.time.ZonedDateTime;
public class RoomReader extends Reader {
private Room.RoomStatus status;
private String uniqueName;
private ZonedDateTime dateCreatedAfter;
private ZonedDateTime dateCreatedBefore;
/**
* Read only the rooms with this status. Can be: `in-progress` (default) or
* `completed`.
*
* @param status Read only the rooms with this status
* @return this
*/
public RoomReader setStatus(final Room.RoomStatus status) {
this.status = status;
return this;
}
/**
* Read only rooms with the this `unique_name`..
*
* @param uniqueName Read only rooms with this unique_name
* @return this
*/
public RoomReader setUniqueName(final String uniqueName) {
this.uniqueName = uniqueName;
return this;
}
/**
* Read only rooms that started on or after this date, given as `YYYY-MM-DD`..
*
* @param dateCreatedAfter Read only rooms that started on or after this date,
* given as YYYY-MM-DD
* @return this
*/
public RoomReader setDateCreatedAfter(final ZonedDateTime dateCreatedAfter) {
this.dateCreatedAfter = dateCreatedAfter;
return this;
}
/**
* Read only rooms that started before this date, given as `YYYY-MM-DD`..
*
* @param dateCreatedBefore Read only rooms that started before this date,
* given as YYYY-MM-DD
* @return this
*/
public RoomReader setDateCreatedBefore(final ZonedDateTime dateCreatedBefore) {
this.dateCreatedBefore = dateCreatedBefore;
return this;
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return Room ResourceSet
*/
@Override
public ResourceSet read(final TwilioRestClient client) {
return new ResourceSet<>(this, client, firstPage(client));
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return Room ResourceSet
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Page firstPage(final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
Domains.VIDEO.toString(),
"/v1/Rooms"
);
addQueryParams(request);
return pageForRequest(client, request);
}
/**
* Retrieve the target page from the Twilio API.
*
* @param targetUrl API-generated URL for the requested results page
* @param client TwilioRestClient with which to make the request
* @return Room ResourceSet
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Page getPage(final String targetUrl, final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
targetUrl
);
return pageForRequest(client, request);
}
/**
* Retrieve the next page from the Twilio API.
*
* @param page current page
* @param client TwilioRestClient with which to make the request
* @return Next Page
*/
@Override
public Page nextPage(final Page page,
final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
page.getNextPageUrl(Domains.VIDEO.toString())
);
return pageForRequest(client, request);
}
/**
* Retrieve the previous page from the Twilio API.
*
* @param page current page
* @param client TwilioRestClient with which to make the request
* @return Previous Page
*/
@Override
public Page previousPage(final Page page,
final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
page.getPreviousPageUrl(Domains.VIDEO.toString())
);
return pageForRequest(client, request);
}
/**
* Generate a Page of Room Resources for a given request.
*
* @param client TwilioRestClient with which to make the request
* @param request Request to generate a page for
* @return Page for the Request
*/
private Page pageForRequest(final TwilioRestClient client, final Request request) {
Response response = client.request(request);
if (response == null) {
throw new ApiConnectionException("Room read failed: Unable to connect to server");
} else if (!TwilioRestClient.SUCCESS.test(response.getStatusCode())) {
RestException restException = RestException.fromJson(response.getStream(), client.getObjectMapper());
if (restException == null) {
throw new ApiException("Server Error, no content");
}
throw new ApiException(restException);
}
return Page.fromJson(
"rooms",
response.getContent(),
Room.class,
client.getObjectMapper()
);
}
/**
* Add the requested query string arguments to the Request.
*
* @param request Request to add query string arguments to
*/
private void addQueryParams(final Request request) {
if (status != null) {
request.addQueryParam("Status", status.toString());
}
if (uniqueName != null) {
request.addQueryParam("UniqueName", uniqueName);
}
if (dateCreatedAfter != null) {
request.addQueryParam("DateCreatedAfter", dateCreatedAfter.toString());
}
if (dateCreatedBefore != null) {
request.addQueryParam("DateCreatedBefore", dateCreatedBefore.toString());
}
if (getPageSize() != null) {
request.addQueryParam("PageSize", Integer.toString(getPageSize()));
}
}
}