public static final class Interaction.Builder extends Object
Interaction
.
Building an Interaction
implies the following steps:
At any time, it is possible to change the current language used for prompts (relevant to speech synthesis) and the barge-in type, i.e. speech or hotword.
This can be translated to:
Builder builder = new Builder(); builder.addPrompt(...); builder.addPrompt(...); //... repeat as needed Interaction interaction = builder.build(...);
Modifier and Type | Method and Description |
---|---|
Interaction.Builder |
addPrompt(AudioItem... audioItems)
Adds a prompt without any DTMF nor speech recognition (no barge-in).
|
Interaction.Builder |
addPrompt(DtmfRecognition dtmfRecognition,
AudioItem... audioItems)
Adds a prompt with DTMF recognition only.
|
Interaction.Builder |
addPrompt(DtmfRecognition dtmfRecognition,
List<? extends AudioItem> audioItems)
Adds a prompt with DTMF recognition only.
|
Interaction.Builder |
addPrompt(DtmfRecognition dtmfRecognition,
SpeechRecognition speechRecognition,
AudioItem... audioItems)
Adds a prompt with both DTMF and speech recognition.
|
Interaction.Builder |
addPrompt(DtmfRecognition dtmfRecognition,
SpeechRecognition speechRecognition,
List<? extends AudioItem> audioItems)
Adds a prompt with both DTMF and speech recognition.
|
Interaction.Builder |
addPrompt(List<? extends AudioItem> audioItems)
Adds a prompt without any DTMF nor speech recognition (no barge-in).
|
Interaction.Builder |
addPrompt(SpeechRecognition speechRecognition,
AudioItem... audioItems)
Adds a prompt with speech recognition only.
|
Interaction.Builder |
addPrompt(SpeechRecognition speechRecognition,
List<? extends AudioItem> audioItems)
Adds a prompt with speech recognition only.
|
Interaction |
build()
Builds the interaction.
|
Interaction |
build(DtmfRecognition dtmfRecognition,
Duration noinputTimeout,
AudioItem... acknowledgeAudioItems)
Builds the interaction.
|
Interaction |
build(DtmfRecognition dtmfRecognition,
Duration noinputTimeout,
List<? extends AudioItem> acknowledgeAudioItems)
Builds the interaction.
|
Interaction |
build(DtmfRecognition dtmfRecognition,
SpeechRecognition speechRecognition,
Duration noinputTimeout,
AudioItem... acknowledgeAudioItems)
Builds the interaction.
|
Interaction |
build(DtmfRecognition dtmfRecognition,
SpeechRecognition speechRecognition,
Duration noinputTimeout,
List<? extends AudioItem> acknowledgeAudioItems)
Builds the interaction.
|
Interaction |
build(Recording recording,
Duration noinputTimeout,
AudioItem... acknowledgeAudioItems)
Builds the interaction.
|
Interaction |
build(Recording recording,
Duration noinputTimeout,
List<? extends AudioItem> acknowledgeAudioItems)
Builds the interaction.
|
Interaction |
build(SpeechRecognition speechRecognition,
Duration noinputTimeout,
AudioItem... acknowledgeAudioItems)
Builds the interaction.
|
Interaction |
build(SpeechRecognition speechRecognition,
Duration noinputTimeout,
List<? extends AudioItem> acknowledgeAudioItems)
Builds the interaction.
|
Interaction.Builder |
setBargeInType(Interaction.BargeInType bargeInType)
Sets the barge-in type to either
Interaction.BargeInType.speech or
Interaction.BargeInType.hotword for the prompts that will be added using
one of the addPrompt(...) methods. |
Interaction.Builder |
setLanguage(String language)
Sets the language code for the prompts that will be added using one
of the
addPrompt(...) methods. |
public Interaction.Builder setBargeInType(Interaction.BargeInType bargeInType)
Interaction.BargeInType.speech
or
Interaction.BargeInType.hotword
for the prompts that will be added using
one of the addPrompt(...)
methods.
Note: When a Interaction.Builder
is created, the default value for this
flag is null
, meaning the barge-in type will be
platform-dependant.
bargeInType
- Interaction.BargeInType.speech
Interaction.BargeInType.hotword
null
reverts to platform default value
public Interaction.Builder setLanguage(String language)
addPrompt(...)
methods.
Note: When a @{link Builder} is created, the default value for this
property is null
, i.e. no explicit language code will be
generated in the VoiceXML thus relying on the platform-specific
default language code.
language
- language code for this prompt. null
if
language should be reset to platform-specific default
value for the prompts to be added.public Interaction.Builder addPrompt(DtmfRecognition dtmfRecognition, AudioItem... audioItems)
dtmfRecognition
- configuration for the DTMF recognitionaudioItems
- audio items to be played during this prompt.public Interaction.Builder addPrompt(DtmfRecognition dtmfRecognition, List<? extends AudioItem> audioItems)
dtmfRecognition
- configuration for the DTMF recognitionaudioItems
- audio items to be played during this prompt.public Interaction.Builder addPrompt(SpeechRecognition speechRecognition, AudioItem... audioItems)
speechRecognition
- configuration for the speech recognitionaudioItems
- audio items to be played during this prompt.public Interaction.Builder addPrompt(SpeechRecognition speechRecognition, List<? extends AudioItem> audioItems)
speechRecognition
- configuration for the speech recognitionaudioItems
- audio items to be played during this prompt.public Interaction.Builder addPrompt(DtmfRecognition dtmfRecognition, SpeechRecognition speechRecognition, AudioItem... audioItems)
speechRecognition
- configuration for the speech recognition or
null
to disable DTMF recognition.dtmfRecognition
- configuration for the DTMF recognition or
null
to disable DTMF recognition.audioItems
- audio items to be played during this prompt.public Interaction.Builder addPrompt(DtmfRecognition dtmfRecognition, SpeechRecognition speechRecognition, List<? extends AudioItem> audioItems)
speechRecognition
- configuration for the speech recognition or
null
to disable DTMF recognition.dtmfRecognition
- configuration for the DTMF recognition or
null
to disable DTMF recognition.audioItems
- audio items to be played during this prompt.public Interaction.Builder addPrompt(AudioItem... audioItems)
audioItems
- audio items to be played during this prompt.public Interaction.Builder addPrompt(List<? extends AudioItem> audioItems)
audioItems
- audio items to be played during this prompt.public Interaction build(DtmfRecognition dtmfRecognition, Duration noinputTimeout, AudioItem... acknowledgeAudioItems)
dtmfRecognition
- configuration for the DTMF recognitionnoinputTimeout
- timeout value before a noinput
is
generated.acknowledgeAudioItems
- audioItems to be played upon recognitionpublic Interaction build(SpeechRecognition speechRecognition, Duration noinputTimeout, AudioItem... acknowledgeAudioItems)
speechRecognition
- configuration for the speech recognitionnoinputTimeout
- timeout value before a noinput
is
generated.acknowledgeAudioItems
- audioItems to be played upon recognitionpublic Interaction build(DtmfRecognition dtmfRecognition, Duration noinputTimeout, List<? extends AudioItem> acknowledgeAudioItems)
dtmfRecognition
- configuration for the DTMF recognitionnoinputTimeout
- timeout value before a noinput
is
generated.acknowledgeAudioItems
- audioItems to be played upon recognitionpublic Interaction build(SpeechRecognition speechRecognition, Duration noinputTimeout, List<? extends AudioItem> acknowledgeAudioItems)
speechRecognition
- configuration for the speech recognitionnoinputTimeout
- timeout value before a noinput
is
generated.acknowledgeAudioItems
- audioItems to be played upon recognitionpublic Interaction build(DtmfRecognition dtmfRecognition, SpeechRecognition speechRecognition, Duration noinputTimeout, AudioItem... acknowledgeAudioItems)
speechRecognition
- configuration for the speech recognitiondtmfRecognition
- configuration for the DTMF recognitionnoinputTimeout
- timeout value before a noinput
is
generated.acknowledgeAudioItems
- audioItems to be played upon recognitionpublic Interaction build(DtmfRecognition dtmfRecognition, SpeechRecognition speechRecognition, Duration noinputTimeout, List<? extends AudioItem> acknowledgeAudioItems)
speechRecognition
- configuration for the speech recognitiondtmfRecognition
- configuration for the DTMF recognitionnoinputTimeout
- timeout value before a noinput
is
generated.acknowledgeAudioItems
- audioItems to be played upon recognitionpublic Interaction build(Recording recording, Duration noinputTimeout, AudioItem... acknowledgeAudioItems)
recording
- configuration for the recordingnoinputTimeout
- timeout value before a noinput
is
generated.acknowledgeAudioItems
- audioItems to be played upon recording
completionpublic Interaction build(Recording recording, Duration noinputTimeout, List<? extends AudioItem> acknowledgeAudioItems)
recording
- configuration for the recordingnoinputTimeout
- timeout value before a noinput
is
generated.acknowledgeAudioItems
- audioItems to be played upon recording
completionpublic Interaction build()
Copyright © 2019 Nu Echo Inc..