com.twilio.rest.api.v2010.account

Class ShortCodeReader

java.lang.Object

com.twilio.base.Reader<ShortCode>

com.twilio.rest.api.v2010.account.ShortCodeReader

public class ShortCodeReader
extends Reader<ShortCode>

Constructor Summary

Constructors

Constructor and Description
ShortCodeReader() Construct a new ShortCodeReader.
ShortCodeReader(String pathAccountSid) Construct a new ShortCodeReader.

Method Summary

Modifier and Type	Method and Description
Page<ShortCode>	firstPage(TwilioRestClient client) Make the request to the Twilio API to perform the read.
Page<ShortCode>	getPage(String targetUrl, TwilioRestClient client) Retrieve the target page from the Twilio API.
Page<ShortCode>	nextPage(Page<ShortCode> page, TwilioRestClient client) Retrieve the next page from the Twilio API.
Page<ShortCode>	previousPage(Page<ShortCode> page, TwilioRestClient client) Retrieve the previous page from the Twilio API.
ResourceSet<ShortCode>	read(TwilioRestClient client) Make the request to the Twilio API to perform the read.
ShortCodeReader	setFriendlyName(String friendlyName) Only show the ShortCode resources with friendly names that exactly match this name.
ShortCodeReader	setShortCode(String shortCode) Only show the ShortCode resources that match this pattern.

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

ShortCodeReader

public ShortCodeReader()

Construct a new ShortCodeReader.

ShortCodeReader

public ShortCodeReader(String pathAccountSid)

Construct a new ShortCodeReader.

Parameters:

pathAccountSid - The account_sid

Method Detail

setFriendlyName

public ShortCodeReader setFriendlyName(String friendlyName)

Only show the ShortCode resources with friendly names that exactly match this name.

Parameters:

friendlyName - Filter by friendly name

Returns:

this

setShortCode

public ShortCodeReader setShortCode(String shortCode)

Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit.

Parameters:

shortCode - Filter by ShortCode

Returns:

this

read

public ResourceSet<ShortCode> read(TwilioRestClient client)

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

Specified by:

read in class Reader<ShortCode>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

ShortCode ResourceSet

firstPage

public Page<ShortCode> firstPage(TwilioRestClient client)

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

Specified by:

firstPage in class Reader<ShortCode>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

ShortCode ResourceSet

getPage

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

Retrieve the target page from the Twilio API.

Specified by:

getPage in class Reader<ShortCode>

Parameters:

targetUrl - API-generated URL for the requested results page

client - TwilioRestClient with which to make the request

Returns:

ShortCode ResourceSet

nextPage

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

Retrieve the next page from the Twilio API.

Specified by:

nextPage in class Reader<ShortCode>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Next Page

previousPage

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

Retrieve the previous page from the Twilio API.

Specified by:

previousPage in class Reader<ShortCode>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Previous Page