com.twilio.rest.lookups.v1

Class PhoneNumberFetcher

java.lang.Object

com.twilio.base.Fetcher<PhoneNumber>

com.twilio.rest.lookups.v1.PhoneNumberFetcher

public class PhoneNumberFetcher
extends Fetcher<PhoneNumber>

Constructor Summary

Constructors

Constructor and Description
PhoneNumberFetcher(PhoneNumber pathPhoneNumber) Construct a new PhoneNumberFetcher.

Method Summary

Modifier and Type	Method and Description
PhoneNumber	fetch(TwilioRestClient client) Make the request to the Twilio API to perform the fetch.
PhoneNumberFetcher	setAddOns(List<String> addOns) The `unique_name` of an Add-on you would like to invoke.
PhoneNumberFetcher	setAddOns(String addOns) The `unique_name` of an Add-on you would like to invoke.
PhoneNumberFetcher	setAddOnsData(Map<String,Object> addOnsData) Data specific to the add-on you would like to invoke.
PhoneNumberFetcher	setCountryCode(String countryCode) The ISO country code of the phone number to fetch.
PhoneNumberFetcher	setType(List<String> type) The type of information to return.
PhoneNumberFetcher	setType(String type) The type of information to return.

Methods inherited from class com.twilio.base.Fetcher

fetch, fetchAsync, fetchAsync

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PhoneNumberFetcher

public PhoneNumberFetcher(PhoneNumber pathPhoneNumber)

Construct a new PhoneNumberFetcher.

Parameters:

pathPhoneNumber - The phone number to fetch in E.164 format

Method Detail

setCountryCode

public PhoneNumberFetcher setCountryCode(String countryCode)

The ISO country code of the phone number to fetch. This is used to specify the country when the phone number is provided in a national format..

Parameters:

countryCode - The ISO country code of the phone number

Returns:

this

setType

public PhoneNumberFetcher setType(List<String> type)

The type of information to return. Can be: `carrier` or `caller-name`. The default is null. Carrier information costs $0.005 per phone number looked up. Caller Name information is currently available only in the US and costs $0.01 per phone number looked up. To retrieve both types on information, specify this parameter twice; once with `carrier` and once with `caller-name` as the value..

Parameters:

type - The type of information to return

Returns:

this

setType

public PhoneNumberFetcher setType(String type)

The type of information to return. Can be: `carrier` or `caller-name`. The default is null. Carrier information costs $0.005 per phone number looked up. Caller Name information is currently available only in the US and costs $0.01 per phone number looked up. To retrieve both types on information, specify this parameter twice; once with `carrier` and once with `caller-name` as the value..

Parameters:

type - The type of information to return

Returns:

this

setAddOns

public PhoneNumberFetcher setAddOns(List<String> addOns)

The `unique_name` of an Add-on you would like to invoke. Can be the `unique_name` of an Add-on that is installed on your account. You can specify multiple instances of this parameter to invoke multiple Add-ons. For more information about Add-ons, see the Add-ons documentation..

Parameters:

addOns - The unique_name of an Add-on you would like to invoke

Returns:

this

setAddOns

public PhoneNumberFetcher setAddOns(String addOns)

The `unique_name` of an Add-on you would like to invoke. Can be the `unique_name` of an Add-on that is installed on your account. You can specify multiple instances of this parameter to invoke multiple Add-ons. For more information about Add-ons, see the Add-ons documentation..

Parameters:

addOns - The unique_name of an Add-on you would like to invoke

Returns:

this

setAddOnsData

public PhoneNumberFetcher setAddOnsData(Map<String,Object> addOnsData)

Data specific to the add-on you would like to invoke. The content and format of this value depends on the add-on..

Parameters:

addOnsData - Data specific to the add-on you would like to invoke

Returns:

this

fetch

public PhoneNumber fetch(TwilioRestClient client)

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

Specified by:

fetch in class Fetcher<PhoneNumber>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Fetched PhoneNumber