com.twilio.rest.preview.sync.service

Class DocumentReader

java.lang.Object

com.twilio.base.Reader<Document>

com.twilio.rest.preview.sync.service.DocumentReader

public class DocumentReader
extends Reader<Document>

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Constructor Summary

Constructors

Constructor and Description
DocumentReader(String pathServiceSid) Construct a new DocumentReader.

Method Summary

Modifier and Type	Method and Description
Page<Document>	firstPage(TwilioRestClient client) Make the request to the Twilio API to perform the read.
Page<Document>	getPage(String targetUrl, TwilioRestClient client) Retrieve the target page from the Twilio API.
Page<Document>	nextPage(Page<Document> page, TwilioRestClient client) Retrieve the next page from the Twilio API.
Page<Document>	previousPage(Page<Document> page, TwilioRestClient client) Retrieve the previous page from the Twilio API.
ResourceSet<Document>	read(TwilioRestClient client) Make the request to the Twilio API to perform the read.

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

DocumentReader

public DocumentReader(String pathServiceSid)

Construct a new DocumentReader.

Parameters:

pathServiceSid - The service_sid

Method Detail

read

public ResourceSet<Document> read(TwilioRestClient client)

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

Specified by:

read in class Reader<Document>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Document ResourceSet

firstPage

public Page<Document> firstPage(TwilioRestClient client)

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

Specified by:

firstPage in class Reader<Document>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Document ResourceSet

getPage

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

Retrieve the target page from the Twilio API.

Specified by:

getPage in class Reader<Document>

Parameters:

targetUrl - API-generated URL for the requested results page

client - TwilioRestClient with which to make the request

Returns:

Document ResourceSet

nextPage

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

Retrieve the next page from the Twilio API.

Specified by:

nextPage in class Reader<Document>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Next Page

previousPage

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

Retrieve the previous page from the Twilio API.

Specified by:

previousPage in class Reader<Document>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Previous Page