com.twilio.rest.fax.v1

Class FaxReader

java.lang.Object

com.twilio.base.Reader<Fax>

com.twilio.rest.fax.v1.FaxReader

public class FaxReader
extends Reader<Fax>

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Constructor Summary

Constructors

Constructor and Description
FaxReader()

Method Summary

Modifier and Type	Method and Description
Page<Fax>	firstPage(TwilioRestClient client) Make the request to the Twilio API to perform the read.
Page<Fax>	getPage(String targetUrl, TwilioRestClient client) Retrieve the target page from the Twilio API.
Page<Fax>	nextPage(Page<Fax> page, TwilioRestClient client) Retrieve the next page from the Twilio API.
Page<Fax>	previousPage(Page<Fax> page, TwilioRestClient client) Retrieve the previous page from the Twilio API.
ResourceSet<Fax>	read(TwilioRestClient client) Make the request to the Twilio API to perform the read.
FaxReader	setDateCreatedAfter(org.joda.time.DateTime dateCreatedAfter) Filters the returned list to only include faxes created after the supplied date, given in ISO 8601 format..
FaxReader	setDateCreatedOnOrBefore(org.joda.time.DateTime dateCreatedOnOrBefore) Filters the returned list to only include faxes created on or before the supplied date, given in ISO 8601 format..
FaxReader	setFrom(String from) Filters the returned list to only include faxes sent from the supplied number, given in E.164 format..
FaxReader	setTo(String to) Filters the returned list to only include faxes sent to the supplied number, given in E.164 format..

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

FaxReader

public FaxReader()

Method Detail

setFrom

public FaxReader setFrom(String from)

Filters the returned list to only include faxes sent from the supplied number, given in E.164 format..

Parameters:

from - Include only faxes sent from

Returns:

this

setTo

public FaxReader setTo(String to)

Filters the returned list to only include faxes sent to the supplied number, given in E.164 format..

Parameters:

to - Include only faxes sent to

Returns:

this

setDateCreatedOnOrBefore

public FaxReader setDateCreatedOnOrBefore(org.joda.time.DateTime dateCreatedOnOrBefore)

Filters the returned list to only include faxes created on or before the supplied date, given in ISO 8601 format..

Parameters:

dateCreatedOnOrBefore - Include only faxes created on or before

Returns:

this

setDateCreatedAfter

public FaxReader setDateCreatedAfter(org.joda.time.DateTime dateCreatedAfter)

Filters the returned list to only include faxes created after the supplied date, given in ISO 8601 format..

Parameters:

dateCreatedAfter - Include only faxes created after

Returns:

this

read

public ResourceSet<Fax> read(TwilioRestClient client)

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

Specified by:

read in class Reader<Fax>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Fax ResourceSet

firstPage

public Page<Fax> firstPage(TwilioRestClient client)

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

Specified by:

firstPage in class Reader<Fax>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Fax ResourceSet

getPage

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

Retrieve the target page from the Twilio API.

Specified by:

getPage in class Reader<Fax>

Parameters:

targetUrl - API-generated URL for the requested results page

client - TwilioRestClient with which to make the request

Returns:

Fax ResourceSet

nextPage

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

Retrieve the next page from the Twilio API.

Specified by:

nextPage in class Reader<Fax>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Next Page

previousPage

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

Retrieve the previous page from the Twilio API.

Specified by:

previousPage in class Reader<Fax>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Previous Page