Package com.vonage.client.voice.ncco

Class InputAction.Builder

java.lang.Object

com.vonage.client.voice.ncco.InputAction.Builder

Enclosing class:

InputAction

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InputAction	build()
InputAction.Builder	eventMethod(EventMethod eventMethod)
InputAction.Builder	eventUrl(java.lang.String... eventUrl)
InputAction.Builder	eventUrl(java.util.Collection<java.lang.String> eventUrl)
InputAction.Builder	maxDigits(java.lang.Integer maxDigits)
InputAction.Builder	submitOnHash(java.lang.Boolean submitOnHash)
InputAction.Builder	timeOut(java.lang.Integer timeOut)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

timeOut

public InputAction.Builder timeOut(java.lang.Integer timeOut)

Parameters:

timeOut - The result of the callee's activity is sent to the eventUrl webhook endpoint timeOut seconds after the last action. The default value is 3. Max is 10.

Returns:

The InputAction.Builder to keep building.

maxDigits

public InputAction.Builder maxDigits(java.lang.Integer maxDigits)

Parameters:

maxDigits - The number of digits the user can press. The maximum value is 20, the default is 4 digits.

Returns:

The InputAction.Builder to keep building.

submitOnHash

public InputAction.Builder submitOnHash(java.lang.Boolean submitOnHash)

Parameters:

submitOnHash - Set to true so the callee's activity is sent to your webhook endpoint at eventUrl after he or she presses #. If # is not pressed the result is submitted after timeOut seconds. The default value is false. That is, the result is sent to your webhook endpoint after timeOut seconds.

Returns:

The InputAction.Builder to keep building.

eventUrl

public InputAction.Builder eventUrl(java.util.Collection<java.lang.String> eventUrl)

Parameters:

eventUrl - Vonage sends the digits pressed by the callee to this URL after timeOut pause in activity or when # is pressed.

Returns:

The InputAction.Builder to keep building.

eventUrl

public InputAction.Builder eventUrl(java.lang.String... eventUrl)

Parameters:

eventUrl - Vonage sends the digits pressed by the callee to this URL after timeOut pause in activity or when # is pressed.

Returns:

The InputAction.Builder to keep building.

eventMethod

public InputAction.Builder eventMethod(EventMethod eventMethod)

Parameters:

eventMethod - The HTTP method used to send event information to event_url The default value is POST.

Returns:

The InputAction.Builder to keep building.

build

public InputAction build()

Returns:

A new InputAction object from the stored builder options.