NationalReader (Twilio Java)

java.lang.Object
- com.twilio.base.Reader<National>
- - com.twilio.rest.api.v2010.account.availablephonenumbercountry.NationalReader

public class NationalReader
extends Reader<National>

Constructor Summary

Constructors
Constructor and Description
`NationalReader(String pathCountryCode)` Construct a new NationalReader.
`NationalReader(String pathAccountSid, String pathCountryCode)` Construct a new NationalReader.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Page<National>`	`firstPage(TwilioRestClient client)` Make the request to the Twilio API to perform the read.
`Page<National>`	`getPage(String targetUrl, TwilioRestClient client)` Retrieve the target page from the Twilio API.
`Page<National>`	`nextPage(Page<National> page, TwilioRestClient client)` Retrieve the next page from the Twilio API.
`Page<National>`	`previousPage(Page<National> page, TwilioRestClient client)` Retrieve the previous page from the Twilio API.
`ResourceSet<National>`	`read(TwilioRestClient client)` Make the request to the Twilio API to perform the read.
`NationalReader`	`setAreaCode(Integer areaCode)` The area code of the phone numbers to read.
`NationalReader`	`setBeta(Boolean beta)` Whether to read phone numbers that are new to the Twilio platform.
`NationalReader`	`setContains(String contains)` The pattern on which to match phone numbers.
`NationalReader`	`setDistance(Integer distance)` The search radius, in miles, for a `near_` query.
`NationalReader`	`setExcludeAllAddressRequired(Boolean excludeAllAddressRequired)` Whether to exclude phone numbers that require an Address.
`NationalReader`	`setExcludeForeignAddressRequired(Boolean excludeForeignAddressRequired)` Whether to exclude phone numbers that require a foreign Address.
`NationalReader`	`setExcludeLocalAddressRequired(Boolean excludeLocalAddressRequired)` Whether to exclude phone numbers that require a local Address.
`NationalReader`	`setFaxEnabled(Boolean faxEnabled)` Whether the phone numbers can receive faxes.
`NationalReader`	`setInLata(String inLata)` Limit results to a specific local access and transport area (LATA).
`NationalReader`	`setInLocality(String inLocality)` Limit results to a particular locality or city.
`NationalReader`	`setInPostalCode(String inPostalCode)` Limit results to a particular postal code.
`NationalReader`	`setInRateCenter(String inRateCenter)` Limit results to a specific rate center, or given a phone number search within the same rate center as that number.
`NationalReader`	`setInRegion(String inRegion)` Limit results to a particular region, state, or province.
`NationalReader`	`setMmsEnabled(Boolean mmsEnabled)` Whether the phone numbers can receive MMS messages.
`NationalReader`	`setNearLatLong(String nearLatLong)` Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles.
`NationalReader`	`setNearNumber(PhoneNumber nearNumber)` Given a phone number, find a geographically close number within `distance` miles.
`NationalReader`	`setNearNumber(String nearNumber)` Given a phone number, find a geographically close number within `distance` miles.
`NationalReader`	`setSmsEnabled(Boolean smsEnabled)` Whether the phone numbers can receive text messages.
`NationalReader`	`setVoiceEnabled(Boolean voiceEnabled)` Whether the phone numbers can receive calls.

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
  - NationalReader
```
public NationalReader(String pathCountryCode)
```
    Construct a new NationalReader.
    
    Parameters:
    
    pathCountryCode - The ISO Country code of the country from which to read phone numbers
  - NationalReader
```
public NationalReader(String pathAccountSid,
                      String pathCountryCode)
```
    Construct a new NationalReader.
    
    Parameters:
    
    pathAccountSid - The SID of the Account requesting the AvailablePhoneNumber resources
    
    pathCountryCode - The ISO Country code of the country from which to read phone numbers
- Method Detail
  - setAreaCode
```
public NationalReader setAreaCode(Integer areaCode)
```
    The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada..
    
    Parameters:
    
    areaCode - The area code of the phone numbers to read
    
    Returns:
    
    this
  - setContains
```
public NationalReader setContains(String contains)
```
    The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters..
    
    Parameters:
    
    contains - The pattern on which to match phone numbers
    
    Returns:
    
    this
  - setSmsEnabled
```
public NationalReader setSmsEnabled(Boolean smsEnabled)
```
    Whether the phone numbers can receive text messages. Can be: `true` or `false`..
    
    Parameters:
    
    smsEnabled - Whether the phone numbers can receive text messages
    
    Returns:
    
    this
  - setMmsEnabled
```
public NationalReader setMmsEnabled(Boolean mmsEnabled)
```
    Whether the phone numbers can receive MMS messages. Can be: `true` or `false`..
    
    Parameters:
    
    mmsEnabled - Whether the phone numbers can receive MMS messages
    
    Returns:
    
    this
  - setVoiceEnabled
```
public NationalReader setVoiceEnabled(Boolean voiceEnabled)
```
    Whether the phone numbers can receive calls. Can be: `true` or `false`..
    
    Parameters:
    
    voiceEnabled - Whether the phone numbers can receive calls.
    
    Returns:
    
    this
  - setExcludeAllAddressRequired
```
public NationalReader setExcludeAllAddressRequired(Boolean excludeAllAddressRequired)
```
    Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`..
    
    Parameters:
    
    excludeAllAddressRequired - Whether to exclude phone numbers that require an Address
    
    Returns:
    
    this
  - setExcludeLocalAddressRequired
```
public NationalReader setExcludeLocalAddressRequired(Boolean excludeLocalAddressRequired)
```
    Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`..
    
    Parameters:
    
    excludeLocalAddressRequired - Whether to exclude phone numbers that require a local address
    
    Returns:
    
    this
  - setExcludeForeignAddressRequired
```
public NationalReader setExcludeForeignAddressRequired(Boolean excludeForeignAddressRequired)
```
    Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`..
    
    Parameters:
    
    excludeForeignAddressRequired - Whether to exclude phone numbers that require a foreign address
    
    Returns:
    
    this
  - setBeta
```
public NationalReader setBeta(Boolean beta)
```
    Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`..
    
    Parameters:
    
    beta - Whether to read phone numbers new to the Twilio platform
    
    Returns:
    
    this
  - setNearNumber
```
public NationalReader setNearNumber(PhoneNumber nearNumber)
```
    Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada..
    
    Parameters:
    
    nearNumber - Given a phone number, find a geographically close number within distance miles. (US/Canada only)
    
    Returns:
    
    this
  - setNearNumber
```
public NationalReader setNearNumber(String nearNumber)
```
    Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada..
    
    Parameters:
    
    nearNumber - Given a phone number, find a geographically close number within distance miles. (US/Canada only)
    
    Returns:
    
    this
  - setNearLatLong
```
public NationalReader setNearLatLong(String nearLatLong)
```
    Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada..
    
    Parameters:
    
    nearLatLong - Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. (US/Canada only)
    
    Returns:
    
    this
  - setDistance
```
public NationalReader setDistance(Integer distance)
```
    The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada..
    
    Parameters:
    
    distance - The search radius, in miles, for a near_ query. (US/Canada only)
    
    Returns:
    
    this
  - setInPostalCode
```
public NationalReader setInPostalCode(String inPostalCode)
```
    Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada..
    
    Parameters:
    
    inPostalCode - Limit results to a particular postal code. (US/Canada only)
    
    Returns:
    
    this
  - setInRegion
```
public NationalReader setInRegion(String inRegion)
```
    Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada..
    
    Parameters:
    
    inRegion - Limit results to a particular region. (US/Canada only)
    
    Returns:
    
    this
  - setInRateCenter
```
public NationalReader setInRateCenter(String inRateCenter)
```
    Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada..
    
    Parameters:
    
    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)
    
    Returns:
    
    this
  - setInLata
```
public NationalReader setInLata(String inLata)
```
    Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada..
    
    Parameters:
    
    inLata - Limit results to a specific local access and transport area. (US/Canada only)
    
    Returns:
    
    this
  - setInLocality
```
public NationalReader setInLocality(String inLocality)
```
    Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number..
    
    Parameters:
    
    inLocality - Limit results to a particular locality
    
    Returns:
    
    this
  - setFaxEnabled
```
public NationalReader setFaxEnabled(Boolean faxEnabled)
```
    Whether the phone numbers can receive faxes. Can be: `true` or `false`..
    
    Parameters:
    
    faxEnabled - Whether the phone numbers can receive faxes
    
    Returns:
    
    this
  - read
```
public ResourceSet<National> read(TwilioRestClient client)
```
    Make the request to the Twilio API to perform the read.
    
    Specified by:
    
    read in class Reader<National>
    
    Parameters:
    
    client - TwilioRestClient with which to make the request
    
    Returns:
    
    National ResourceSet
  - firstPage
```
public Page<National> firstPage(TwilioRestClient client)
```
    Make the request to the Twilio API to perform the read.
    
    Specified by:
    
    firstPage in class Reader<National>
    
    Parameters:
    
    client - TwilioRestClient with which to make the request
    
    Returns:
    
    National ResourceSet
  - getPage
```
public Page<National> getPage(String targetUrl,
                              TwilioRestClient client)
```
    Retrieve the target page from the Twilio API.
    
    Specified by:
    
    getPage in class Reader<National>
    
    Parameters:
    
    targetUrl - API-generated URL for the requested results page
    
    client - TwilioRestClient with which to make the request
    
    Returns:
    
    National ResourceSet
  - nextPage
```
public Page<National> nextPage(Page<National> page,
                               TwilioRestClient client)
```
    Retrieve the next page from the Twilio API.
    
    Specified by:
    
    nextPage in class Reader<National>
    
    Parameters:
    
    page - current page
    
    client - TwilioRestClient with which to make the request
    
    Returns:
    
    Next Page
  - previousPage
```
public Page<National> previousPage(Page<National> page,
                                   TwilioRestClient client)
```
    Retrieve the previous page from the Twilio API.
    
    Specified by:
    
    previousPage in class Reader<National>
    
    Parameters:
    
    page - current page
    
    client - TwilioRestClient with which to make the request
    
    Returns:
    
    Previous Page

Class NationalReader

Constructor Summary

Method Summary

Methods inherited from class com.twilio.base.Reader

Methods inherited from class java.lang.Object

Constructor Detail

NationalReader

NationalReader

Method Detail

setAreaCode

setContains

setSmsEnabled

setMmsEnabled

setVoiceEnabled

setExcludeAllAddressRequired

setExcludeLocalAddressRequired

setExcludeForeignAddressRequired

setBeta

setNearNumber

setNearNumber

setNearLatLong

setDistance

setInPostalCode

setInRegion

setInRateCenter

setInLata

setInLocality

setFaxEnabled

read

firstPage

getPage

nextPage

previousPage