public class SubdialogueCall extends VoiceXmlOutputTurn
SubdialogueCall
is a VoiceXmlOutputTurn
that invokes
another external dialogue.
Parameters may be passed to the subdialogue and return values may be
retrieved if the invoked subdialogue ends with a <return>
instruction.
Modifier and Type | Class and Description |
---|---|
static class |
SubdialogueCall.Builder
Builder used to ease the creation of instances of
SubdialogueCall
. |
static class |
SubdialogueCall.Parameter
SubdialogueCall parameter, can be created with a string value, a
JsonValue or an expression. |
Modifier and Type | Field and Description |
---|---|
static String |
SUBDIALOGUE_RESULT_VARIABLE_NAME |
Constructor and Description |
---|
SubdialogueCall(String name,
String uri) |
Modifier and Type | Method and Description |
---|---|
protected void |
addTurnProperties(javax.json.JsonObjectBuilder builder) |
boolean |
equals(Object obj) |
protected void |
fillVoiceXmlDocument(Document document,
Element formElement,
VoiceXmlDialogueContext dialogueContext) |
DocumentFetchConfiguration |
getFetchConfiguration() |
SubmitMethod |
getMethod() |
protected String |
getOuputTurnType() |
String |
getPostDialogueScript() |
VariableList |
getSubmitParameters() |
String |
getUri() |
Collection<SubdialogueCall.Parameter> |
getVoiceXmlParameters() |
int |
hashCode() |
void |
setFetchConfiguration(DocumentFetchConfiguration fetchConfiguration) |
void |
setMethod(SubmitMethod method) |
void |
setPostDialogueScript(String postDialogueScript) |
void |
setSubdialogueParameters(Collection<SubdialogueCall.Parameter> parameters) |
void |
setSubdialogueParameters(SubdialogueCall.Parameter... subdialogueParameters) |
void |
setSubmitParameters(VariableList submitParameters) |
addEventHandlerScript, addTopLevelProperties, createVoiceXmlDocument
addAdapter, asJson, getName, getVoiceXmlDocument, toString
public static final String SUBDIALOGUE_RESULT_VARIABLE_NAME
public SubdialogueCall(String name, String uri)
name
- The name of this turn. Not empty.uri
- The URI of the subdialogue. Not empty.public final void setSubdialogueParameters(Collection<SubdialogueCall.Parameter> parameters)
parameters
- A list of SubdialogueCall.Parameter
that will be passed to the
subdialogue. Not null.public final void setSubdialogueParameters(SubdialogueCall.Parameter... subdialogueParameters)
subdialogueParameters
- A list of SubdialogueCall.Parameter
that will be
passed to the subdialogue. Not null.public final void setSubmitParameters(VariableList submitParameters)
submitParameters
- A list of variable to submit when invoking the
URI. Not null.public final void setMethod(SubmitMethod method)
method
- The HTTP method used to invoke the subdialogue (GET or
POST). null
to use the VoiceXML platform defaultSubmitMethod
public final void setFetchConfiguration(DocumentFetchConfiguration fetchConfiguration)
fetchConfiguration
- The DocumentFetchConfiguration
.
null
to use the VoiceXML platform default.public final void setPostDialogueScript(String postDialogueScript)
postDialogueScript
- The ECMAScript script to execute after
subdialogue invocation.public final Collection<SubdialogueCall.Parameter> getVoiceXmlParameters()
public final VariableList getSubmitParameters()
public final SubmitMethod getMethod()
public final String getPostDialogueScript()
public final DocumentFetchConfiguration getFetchConfiguration()
protected final String getOuputTurnType()
getOuputTurnType
in class VoiceXmlOutputTurn
protected void addTurnProperties(javax.json.JsonObjectBuilder builder)
addTurnProperties
in class VoiceXmlDocumentTurn
protected void fillVoiceXmlDocument(Document document, Element formElement, VoiceXmlDialogueContext dialogueContext) throws VoiceXmlDocumentRenderingException
fillVoiceXmlDocument
in class VoiceXmlOutputTurn
VoiceXmlDocumentRenderingException
public int hashCode()
hashCode
in class VoiceXmlDocumentTurn
public boolean equals(Object obj)
equals
in class VoiceXmlDocumentTurn
Copyright © 2019 Nu Echo Inc..