Package com.vonage.client.voice.ncco

Class DtmfSettings

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.voice.ncco.DtmfSettings

All Implemented Interfaces:

Jsonable

public class DtmfSettings
extends JsonableBaseObject

DTMF (Dial Tone Multi Frequency) settings for Input Actions that will be added to a NCCO object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DtmfSettings.Builder	Builder for specifying DTMF settings.

Constructor Summary

Constructors

Constructor	Description
DtmfSettings()	Deprecated. Use builder().

Method Summary

Modifier and Type	Method	Description
static DtmfSettings.Builder	builder()	Entrypoint for constructing an instance of this class.
Integer	getMaxDigits()	The number of digits the user can press.
Integer	getTimeOut()	Time to wait in seconds before submitting the event.
Boolean	isSubmitOnHash()	Determines if the callee's activity is sent to your webhook endpoint after pressing the hash key.
void	setMaxDigits(Integer maxDigits)	Deprecated. Use the builder().
void	setSubmitOnHash(Boolean submitOnHash)	Deprecated. Use the builder().
void	setTimeOut(Integer timeOut)	Deprecated. Use the builder().

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Constructor Details

DtmfSettings

@Deprecated
public DtmfSettings()

Deprecated.

Use builder(). This will be made package-private in the next major release.

Constructor.

Method Details

getTimeOut

public Integer getTimeOut()

Time to wait in seconds before submitting the event. Default value is 3.

Returns:

The DTMF input timeout in seconds as an integer, or null if unspecified.

setTimeOut

@Deprecated
public void setTimeOut(Integer timeOut)

Deprecated.

Use the builder(). This will be removed in the next major release.

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.

Parameters:

timeOut - The DTMF input timeout in seconds as an int.

getMaxDigits

public Integer getMaxDigits()

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

Returns:

The number of digits as an integer, or null if unspecified.

setMaxDigits

@Deprecated
public void setMaxDigits(Integer maxDigits)

Deprecated.

Use the builder(). This will be removed in the next major release.

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

Parameters:

maxDigits - The number of digits as an int.

isSubmitOnHash

public Boolean isSubmitOnHash()

Determines if the callee's activity is sent to your webhook endpoint after pressing the hash key.

Returns:

true if the input is submitted on #, or null if unspecified.

setSubmitOnHash

@Deprecated
public void setSubmitOnHash(Boolean submitOnHash)

Deprecated.

Use the builder(). This will be removed in the next major release.

Set to true so the callee's activity is sent to your webhook endpoint at eventUrl after they press #. 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.

Parameters:

submitOnHash - Whether to submit the input after pressing the hash key.

builder

public static DtmfSettings.Builder builder()

Entrypoint for constructing an instance of this class.

Returns:

A new Builder.

Since:

8.9.4