Package com.vonage.client.numbers

Class ListNumbersFilter.Builder

java.lang.Object

com.vonage.client.numbers.BaseNumbersFilter.Builder<ListNumbersFilter,ListNumbersFilter.Builder>

com.vonage.client.numbers.ListNumbersFilter.Builder

Enclosing class:

ListNumbersFilter

public static final class ListNumbersFilter.Builder
extends com.vonage.client.numbers.BaseNumbersFilter.Builder<ListNumbersFilter,ListNumbersFilter.Builder>

Builder for setting the parameters of ListNumbersFilter.

Since:

8.10.0

Method Summary

Modifier and Type	Method	Description
ListNumbersFilter.Builder	applicationId(String applicationId)	Set this to only return numbers assigned to a specific application.
ListNumbersFilter.Builder	applicationId(UUID applicationId)	Set this to only return numbers assigned to a specific application.
ListNumbersFilter	build()	Builds the filter request parameters.
ListNumbersFilter.Builder	hasApplication(boolean hasApplication)	Set this optional field to true to restrict your results to numbers associated with any application.

Methods inherited from class com.vonage.client.numbers.BaseNumbersFilter.Builder

country, index, pattern, size

Methods inherited from class java.lang.Object

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

Method Details

applicationId

public ListNumbersFilter.Builder applicationId(String applicationId)

Set this to only return numbers assigned to a specific application.

Parameters:

applicationId - The application ID to return numbers for as a string.

Returns:

This builder.

applicationId

public ListNumbersFilter.Builder applicationId(UUID applicationId)

Set this to only return numbers assigned to a specific application.

Parameters:

applicationId - The application ID to return numbers for.

Returns:

This builder.

hasApplication

public ListNumbersFilter.Builder hasApplication(boolean hasApplication)

Set this optional field to true to restrict your results to numbers associated with any application. Set to false to find all numbers not associated with an application. Omit the field to avoid filtering on whether or not the number is assigned to an application.

Parameters:

hasApplication - Whether to return only numbers that are assigned to an application.

Returns:

This builder.

build

public ListNumbersFilter build()

Description copied from class: com.vonage.client.numbers.BaseNumbersFilter.Builder

Builds the filter request parameters.

Specified by:

build in class com.vonage.client.numbers.BaseNumbersFilter.Builder<ListNumbersFilter,ListNumbersFilter.Builder>

Returns:

A new number filter with this builder's properties.