Package com.vonage.client.insight

Class AdvancedInsightRequest.Builder

java.lang.Object

com.vonage.client.insight.AdvancedInsightRequest.Builder

Enclosing class:

AdvancedInsightRequest

public static class AdvancedInsightRequest.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	async
protected String	callback
protected Boolean	cnam
protected String	country
protected String	number
protected Boolean	realTimeData

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()
protected	Builder(String number)

Method Summary

Modifier and Type	Method	Description
AdvancedInsightRequest.Builder	async(boolean async)
AdvancedInsightRequest	build()
AdvancedInsightRequest.Builder	callback(String url)
AdvancedInsightRequest.Builder	cnam(boolean cnam)
AdvancedInsightRequest.Builder	country(String country)
AdvancedInsightRequest.Builder	number(String number)
AdvancedInsightRequest.Builder	realTimeData(boolean realTimeData)

Methods inherited from class java.lang.Object

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

Field Details

async

protected boolean async

cnam

protected Boolean cnam

realTimeData

protected Boolean realTimeData

number

protected String number

country

protected String country

callback

protected String callback

Constructor Details

Builder

protected Builder(String number)

Builder

protected Builder()

Method Details

number

public AdvancedInsightRequest.Builder number(String number)

Parameters:

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

Returns:

This builder.

country

public AdvancedInsightRequest.Builder country(String country)

Parameters:

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

Returns:

This builder.

cnam

public AdvancedInsightRequest.Builder cnam(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:

This builder.

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:

This builder.

callback

public AdvancedInsightRequest.Builder callback(String url)

Parameters:

url - The URL that Vonage will send a request to when the insight lookup is finished. This only takes effect when async(boolean) is true.

Returns:

This builder.

realTimeData

public AdvancedInsightRequest.Builder realTimeData(boolean realTimeData)

Parameters:

realTimeData - A boolean to choose whether to get real time data back in the response. This only applies when async(boolean) is false.

Returns:

This builder.

build

public AdvancedInsightRequest build()

Returns:

A new AdvancedInsightRequest object from the stored builder options.