Package 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>

Constructor Summary

Constructors

Constructor	Description
DocumentReader(String pathServiceSid)

Method Summary

Modifier and Type	Method	Description
Page<Document>	firstPage(TwilioRestClient client)	Fetch the first page of resources using specified client.
Page<Document>	getPage(String targetUrl, TwilioRestClient client)	Retrieve the target page of resources.
Page<Document>	nextPage(Page<Document> page, TwilioRestClient client)	Fetch the following page of resources using specified client.
Page<Document>	previousPage(Page<Document> page, TwilioRestClient client)	Fetch the prior page of resources using specified client.
ResourceSet<Document>	read(TwilioRestClient client)	Execute a request using specified client.
DocumentReader	setPageSize(Integer pageSize)

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)

Method Detail

setPageSize

public DocumentReader setPageSize(Integer pageSize)

read

public ResourceSet<Document> read(TwilioRestClient client)

Description copied from class: Reader

Execute a request using specified client.

Specified by:

read in class Reader<Document>

Parameters:

client - client used to make request

Returns:

ResourceSet of objects

firstPage

public Page<Document> firstPage(TwilioRestClient client)

Description copied from class: Reader

Fetch the first page of resources using specified client.

Specified by:

firstPage in class Reader<Document>

Parameters:

client - client used to fetch

Returns:

Page containing the first pageSize of resources

previousPage

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

Description copied from class: Reader

Fetch the prior page of resources using specified client.

Specified by:

previousPage in class Reader<Document>

Parameters:

page - current page of resources

client - client used to fetch

Returns:

Page containing the previous pageSize of resources

nextPage

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

Description copied from class: Reader

Fetch the following page of resources using specified client.

Specified by:

nextPage in class Reader<Document>

Parameters:

page - current page of resources

client - client used to fetch

Returns:

Page containing the next pageSize of resources

getPage

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

Description copied from class: Reader

Retrieve the target page of resources.

Specified by:

getPage in class Reader<Document>

Parameters:

targetUrl - API-generated URL for the requested results page

client - client used to fetch

Returns:

Page containing the target pageSize of resources