com.twilio.rest.notify.v1.service

Class BindingReader

java.lang.Object

com.twilio.base.Reader<Binding>

com.twilio.rest.notify.v1.service.BindingReader

public class BindingReader
extends Reader<Binding>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Page<Binding>	firstPage(TwilioRestClient client) Make the request to the Twilio API to perform the read.
Page<Binding>	getPage(String targetUrl, TwilioRestClient client) Retrieve the target page from the Twilio API.
Page<Binding>	nextPage(Page<Binding> page, TwilioRestClient client) Retrieve the next page from the Twilio API.
Page<Binding>	previousPage(Page<Binding> page, TwilioRestClient client) Retrieve the previous page from the Twilio API.
ResourceSet<Binding>	read(TwilioRestClient client) Make the request to the Twilio API to perform the read.
BindingReader	setEndDate(LocalDate endDate) Only include usage that occurred on or before this date.
BindingReader	setIdentity(List<String> identity) The User's `identity` value of the resources to read..
BindingReader	setIdentity(String identity) The User's `identity` value of the resources to read..
BindingReader	setStartDate(LocalDate startDate) Only include usage that has occurred on or after this date.
BindingReader	setTag(List<String> tag) Only list Bindings that have all of the specified Tags.
BindingReader	setTag(String tag) Only list Bindings that have all of the specified Tags.

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

BindingReader

public BindingReader(String pathServiceSid)

Construct a new BindingReader.

Parameters:

pathServiceSid - The SID of the Service to read the resource from

Method Detail

setStartDate

public BindingReader setStartDate(LocalDate startDate)

Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`..

Parameters:

startDate - Only include usage that has occurred on or after this date

Returns:

this

setEndDate

public BindingReader setEndDate(LocalDate endDate)

Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`..

Parameters:

endDate - Only include usage that occurred on or before this date

Returns:

this

setIdentity

public BindingReader setIdentity(List<String> identity)

The User's `identity` value of the resources to read..

Parameters:

identity - The `identity` value of the resources to read

Returns:

this

setIdentity

public BindingReader setIdentity(String identity)

The User's `identity` value of the resources to read..

Parameters:

identity - The `identity` value of the resources to read

Returns:

this

setTag

public BindingReader setTag(List<String> tag)

Only list Bindings that have all of the specified Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`, `facebook-messenger`. Up to 5 tags are allowed..

Parameters:

tag - Only list Bindings that have all of the specified Tags

Returns:

this

setTag

public BindingReader setTag(String tag)

Only list Bindings that have all of the specified Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`, `facebook-messenger`. Up to 5 tags are allowed..

Parameters:

tag - Only list Bindings that have all of the specified Tags

Returns:

this

read

public ResourceSet<Binding> read(TwilioRestClient client)

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

Specified by:

read in class Reader<Binding>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Binding ResourceSet

firstPage

public Page<Binding> firstPage(TwilioRestClient client)

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

Specified by:

firstPage in class Reader<Binding>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Binding ResourceSet

getPage

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

Retrieve the target page from the Twilio API.

Specified by:

getPage in class Reader<Binding>

Parameters:

targetUrl - API-generated URL for the requested results page

client - TwilioRestClient with which to make the request

Returns:

Binding ResourceSet

nextPage

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

Retrieve the next page from the Twilio API.

Specified by:

nextPage in class Reader<Binding>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Next Page

previousPage

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

Retrieve the previous page from the Twilio API.

Specified by:

previousPage in class Reader<Binding>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Previous Page