com.nexmo.client.insight

Class AdvancedInsightRequest.Builder

java.lang.Object

com.nexmo.client.insight.AdvancedInsightRequest.Builder

Enclosing class:

AdvancedInsightRequest

public static class AdvancedInsightRequest.Builder
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	async
protected java.lang.String	callback
protected java.lang.Boolean	cnam
protected java.lang.String	country
protected java.lang.String	ipAddress
protected java.lang.String	number

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String number)

Method Summary

Modifier and Type	Method and Description
AdvancedInsightRequest.Builder	async(boolean async)
AdvancedInsightRequest	build()
AdvancedInsightRequest.Builder	callback(java.lang.String url)
AdvancedInsightRequest.Builder	cnam(java.lang.Boolean cnam)
AdvancedInsightRequest.Builder	country(java.lang.String country)
AdvancedInsightRequest.Builder	ipAddress(java.lang.String ipAddress)
AdvancedInsightRequest.Builder	number(java.lang.String number)

Methods inherited from class java.lang.Object

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

Field Detail

number

protected java.lang.String number

country

protected java.lang.String country

cnam

protected java.lang.Boolean cnam

ipAddress

protected java.lang.String ipAddress

async

protected boolean async

callback

protected java.lang.String callback

Constructor Detail

Builder

public Builder(java.lang.String number)

Parameters:

number - A single phone number that you need insight about in national or international format.

Method Detail

number

public AdvancedInsightRequest.Builder number(java.lang.String number)

Parameters:

number - A single phone number that you need insight about in national or international format.

Returns:

The AdvancedInsightRequest.Builder to keep building.

country

public AdvancedInsightRequest.Builder country(java.lang.String country)

Parameters:

country - If a number does not have a country code or it is uncertain, set the two-character country code.

Returns:

The AdvancedInsightRequest.Builder to keep building.

cnam

public AdvancedInsightRequest.Builder cnam(java.lang.Boolean cnam)

Parameters:

cnam - Indicates if the name of the person who owns the phone number should also be looked up and returned. Set to true to receive phone number owner name in the response. This is only available for US numbers and incurs an additional charge.

Returns:

The AdvancedInsightRequest.Builder to keep building.

ipAddress

public AdvancedInsightRequest.Builder ipAddress(java.lang.String ipAddress)

Parameters:

ipAddress - The IP address of the user. If supplied, we will compare this to the country the user's phone is located in and return an error if it does not match.

Returns:

The AdvancedInsightRequest.Builder to keep building.

async

public AdvancedInsightRequest.Builder async(boolean async)

Parameters:

async - True if the call should be done asynchronously. When setting this value to true, the callback(String) parameter must also be set.

Returns:

The AdvancedInsightRequest.Builder to keep building.

callback

public AdvancedInsightRequest.Builder callback(java.lang.String url)

Parameters:

url - The URL that Nexmo will send a request to when the insight lookup is finished.

Returns:

The AdvancedInsightRequest.Builder to keep building.

build

public AdvancedInsightRequest build()

Returns:

A new AdvancedInsightRequest object from the stored builder options.