Constructor and Description |
---|
TollFreeReader(String pathCountryCode)
Construct a new TollFreeReader.
|
TollFreeReader(String pathAccountSid,
String pathCountryCode)
Construct a new TollFreeReader.
|
Modifier and Type | Method and Description |
---|---|
Page<TollFree> |
firstPage(TwilioRestClient client)
Make the request to the Twilio API to perform the read.
|
Page<TollFree> |
getPage(String targetUrl,
TwilioRestClient client)
Retrieve the target page from the Twilio API.
|
Page<TollFree> |
nextPage(Page<TollFree> page,
TwilioRestClient client)
Retrieve the next page from the Twilio API.
|
Page<TollFree> |
previousPage(Page<TollFree> page,
TwilioRestClient client)
Retrieve the previous page from the Twilio API.
|
ResourceSet<TollFree> |
read(TwilioRestClient client)
Make the request to the Twilio API to perform the read.
|
TollFreeReader |
setAreaCode(Integer areaCode)
The area code of the phone numbers to read.
|
TollFreeReader |
setBeta(Boolean beta)
Whether to read phone numbers that are new to the Twilio platform.
|
TollFreeReader |
setContains(String contains)
The pattern on which to match phone numbers.
|
TollFreeReader |
setDistance(Integer distance)
The search radius, in miles, for a `near_` query.
|
TollFreeReader |
setExcludeAllAddressRequired(Boolean excludeAllAddressRequired)
Whether to exclude phone numbers that require an Address.
|
TollFreeReader |
setExcludeForeignAddressRequired(Boolean excludeForeignAddressRequired)
Whether to exclude phone numbers that require a foreign Address.
|
TollFreeReader |
setExcludeLocalAddressRequired(Boolean excludeLocalAddressRequired)
Whether to exclude phone numbers that require a local Address.
|
TollFreeReader |
setFaxEnabled(Boolean faxEnabled)
Whether the phone numbers can receive faxes.
|
TollFreeReader |
setInLata(String inLata)
Limit results to a specific local access and transport area (LATA).
|
TollFreeReader |
setInLocality(String inLocality)
Limit results to a particular locality or city.
|
TollFreeReader |
setInPostalCode(String inPostalCode)
Limit results to a particular postal code.
|
TollFreeReader |
setInRateCenter(String inRateCenter)
Limit results to a specific rate center, or given a phone number search
within the same rate center as that number.
|
TollFreeReader |
setInRegion(String inRegion)
Limit results to a particular region, state, or province.
|
TollFreeReader |
setMmsEnabled(Boolean mmsEnabled)
Whether the phone numbers can receive MMS messages.
|
TollFreeReader |
setNearLatLong(String nearLatLong)
Given a latitude/longitude pair `lat,long` find geographically close numbers
within `distance` miles.
|
TollFreeReader |
setNearNumber(PhoneNumber nearNumber)
Given a phone number, find a geographically close number within `distance`
miles.
|
TollFreeReader |
setNearNumber(String nearNumber)
Given a phone number, find a geographically close number within `distance`
miles.
|
TollFreeReader |
setSmsEnabled(Boolean smsEnabled)
Whether the phone numbers can receive text messages.
|
TollFreeReader |
setVoiceEnabled(Boolean voiceEnabled)
Whether the phone numbers can receive calls.
|
public TollFreeReader(String pathCountryCode)
pathCountryCode
- The ISO Country code of the country from which to
read phone numberspublic TollFreeReader(String pathAccountSid, String pathCountryCode)
pathAccountSid
- The SID of the Account requesting the
AvailablePhoneNumber resourcespathCountryCode
- The ISO Country code of the country from which to
read phone numberspublic TollFreeReader setAreaCode(Integer areaCode)
areaCode
- The area code of the phone numbers to readpublic TollFreeReader setContains(String contains)
contains
- The pattern on which to match phone numberspublic TollFreeReader setSmsEnabled(Boolean smsEnabled)
smsEnabled
- Whether the phone numbers can receive text messagespublic TollFreeReader setMmsEnabled(Boolean mmsEnabled)
mmsEnabled
- Whether the phone numbers can receive MMS messagespublic TollFreeReader setVoiceEnabled(Boolean voiceEnabled)
voiceEnabled
- Whether the phone numbers can receive calls.public TollFreeReader setExcludeAllAddressRequired(Boolean excludeAllAddressRequired)
excludeAllAddressRequired
- Whether to exclude phone numbers that
require an Addresspublic TollFreeReader setExcludeLocalAddressRequired(Boolean excludeLocalAddressRequired)
excludeLocalAddressRequired
- Whether to exclude phone numbers that
require a local addresspublic TollFreeReader setExcludeForeignAddressRequired(Boolean excludeForeignAddressRequired)
excludeForeignAddressRequired
- Whether to exclude phone numbers that
require a foreign addresspublic TollFreeReader setBeta(Boolean beta)
beta
- Whether to read phone numbers new to the Twilio platformpublic TollFreeReader setNearNumber(PhoneNumber nearNumber)
nearNumber
- Given a phone number, find a geographically close number
within distance miles. (US/Canada only)public TollFreeReader setNearNumber(String nearNumber)
nearNumber
- Given a phone number, find a geographically close number
within distance miles. (US/Canada only)public TollFreeReader setNearLatLong(String nearLatLong)
nearLatLong
- Given a latitude/longitude pair lat,long find
geographically close numbers within distance miles.
(US/Canada only)public TollFreeReader setDistance(Integer distance)
distance
- The search radius, in miles, for a near_ query. (US/Canada
only)public TollFreeReader setInPostalCode(String inPostalCode)
inPostalCode
- Limit results to a particular postal code. (US/Canada
only)public TollFreeReader setInRegion(String inRegion)
inRegion
- Limit results to a particular region. (US/Canada only)public TollFreeReader setInRateCenter(String inRateCenter)
inRateCenter
- Limit results to a specific rate center, or given a
phone number search within the same rate center as that
number. (US/Canada only)public TollFreeReader setInLata(String inLata)
inLata
- Limit results to a specific local access and transport area.
(US/Canada only)public TollFreeReader setInLocality(String inLocality)
inLocality
- Limit results to a particular localitypublic TollFreeReader setFaxEnabled(Boolean faxEnabled)
faxEnabled
- Whether the phone numbers can receive faxespublic ResourceSet<TollFree> read(TwilioRestClient client)
public Page<TollFree> firstPage(TwilioRestClient client)
public Page<TollFree> getPage(String targetUrl, TwilioRestClient client)
public Page<TollFree> nextPage(Page<TollFree> page, TwilioRestClient client)
public Page<TollFree> previousPage(Page<TollFree> page, TwilioRestClient client)
previousPage
in class Reader<TollFree>
page
- current pageclient
- TwilioRestClient with which to make the requestCopyright © 2019 Twilio, Inc. All Rights Reserved.