public abstract class SupervisedTransfer extends Transfer
SupervisedTransfer
is a Transfer
where the outcome is
monitored and where a transfer failure can be handled gracefully.
Recognition can optionally be activated to cancel a supervised transfer.
BridgeTransfer
,
ConsultationTransfer
Modifier and Type | Class and Description |
---|---|
static class |
SupervisedTransfer.Builder
Builder used to ease the creation of instances of
SupervisedTransfer |
Constructor and Description |
---|
SupervisedTransfer(String name,
String destination) |
Modifier and Type | Method and Description |
---|---|
protected void |
addTurnProperties(javax.json.JsonObjectBuilder builder) |
protected void |
customizeTransferElement(Element transferElement)
Allows the customization of the generated transfer element
|
boolean |
equals(Object obj) |
Duration |
getConnectTimeout() |
DtmfRecognition |
getDtmfRecognition() |
SpeechRecognition |
getSpeechRecognition() |
String |
getTransferAudio() |
int |
hashCode() |
void |
setConnectTimeout(Duration connectTimeout) |
void |
setDtmfRecognition(DtmfRecognition dtmfRecognition) |
void |
setSpeechRecognition(SpeechRecognition speechRecognition) |
void |
setTransferAudio(String transferAudio) |
fillVoiceXmlDocument, getApplicationToApplicationInformation, getDestination, getOuputTurnType, getTransferType, setApplicationToApplicationInformation
addEventHandlerScript, addTopLevelProperties, createVoiceXmlDocument
addAdapter, asJson, getName, getVoiceXmlDocument, toString
public SupervisedTransfer(String name, String destination)
name
- The name of this turn. Not empty.destination
- The URI of the destination (telephone, IP telephony
address). Not empty.public final void setDtmfRecognition(DtmfRecognition dtmfRecognition)
dtmfRecognition
- The active DTMF recognition configuration during
the transfer.public final void setSpeechRecognition(SpeechRecognition speechRecognition)
speechRecognition
- The active speech recognition configuration
during the transfer.public final void setTransferAudio(String transferAudio)
transferAudio
- The location (URI or path) of audio source to play
while the transfer attempt is in progress.public final void setConnectTimeout(Duration connectTimeout)
connectTimeout
- The time to wait while trying to connect the call
before returning with TransferStatus.NO_ANSWER
.
null
to use the VoiceXML platform default.public final String getTransferAudio()
public final Duration getConnectTimeout()
public final DtmfRecognition getDtmfRecognition()
public final SpeechRecognition getSpeechRecognition()
protected void customizeTransferElement(Element transferElement) throws VoiceXmlDocumentRenderingException
Transfer
customizeTransferElement
in class Transfer
transferElement
- The transfer element to customize.VoiceXmlDocumentRenderingException
- when an error occurs while
rendering the VoiceXml documentprotected void addTurnProperties(javax.json.JsonObjectBuilder builder)
addTurnProperties
in class Transfer
Copyright © 2019 Nu Echo Inc..