- call(URI) - Method in class org.jvoicexml.interpreter.JVoiceXmlSession
-
Handles a call request.
- call(URI) - Method in interface org.jvoicexml.Session
-
Handles a call request.
- CallControl - Interface in org.jvoicexml
-
Call control.
- CallControlProperties - Class in org.jvoicexml
-
Generic telephony properties.
- CallControlProperties() - Constructor for class org.jvoicexml.CallControlProperties
-
- CallManager - Interface in org.jvoicexml
-
Manager for telephony integration to allow for real client-server
scenarios.
- CallParameters - Class in org.jvoicexml.callmanager
-
Container for call parameters.
- CallParameters() - Constructor for class org.jvoicexml.callmanager.CallParameters
-
- CancelEvent - Class in org.jvoicexml.event.plain
-
The user has requested to cancel playing of the current prompt.
- CancelEvent() - Constructor for class org.jvoicexml.event.plain.CancelEvent
-
Constructs a new event with the event type as its detail message.
- CancelEvent(String) - Constructor for class org.jvoicexml.event.plain.CancelEvent
-
Constructs a new event with the specified detail message. the given
detail message is expanded to the form
<EVENT_TYPE>: <message>.
- CancelEvent(Throwable) - Constructor for class org.jvoicexml.event.plain.CancelEvent
-
Constructs a new event with the specified cause and a detail message of
(cause==null ?
- CancelEvent(String, Throwable) - Constructor for class org.jvoicexml.event.plain.CancelEvent
-
Constructs a new event with the specified detail message and cause.
- cancelOutput(BargeInType) - Method in interface org.jvoicexml.implementation.OutputDevice
-
Cancels the current output from the TTS engine and queued audio
for all entries in the queue that allow barge-in of the given type.
- cancelOutput(BargeInType) - Method in interface org.jvoicexml.SystemOutput
-
Cancels the current output from the TTS engine and queued audio
for all entries in the queue that allow barge-in.
- CatchContainer - Interface in org.jvoicexml.interpreter
-
Form items that can have nested catches and are thus able to process events.
- ChoiceConverter - Interface in org.jvoicexml.interpreter.dialog
-
Converts a given <choice> node into a grammar.
- clean(FormItem) - Method in class org.jvoicexml.interpreter.event.JVoiceXmlEventHandler
-
Removes all event handlers that were collected for the given form item.
- clean(FormItem) - Method in interface org.jvoicexml.interpreter.EventHandler
-
Removes all event handlers that were collected for the given form item.
- clear(String) - Method in class org.jvoicexml.documentserver.jetty.DocumentStorage
-
Clears all documents associated with the given session.
- clear() - Method in class org.jvoicexml.interpreter.scope.ScopedCollection
- clear() - Method in class org.jvoicexml.interpreter.scope.ScopedMap
-
Removes all mappings from this map (optional operation).
- clear() - Method in class org.jvoicexml.interpreter.scope.ScopedSet
- clearEvent() - Method in class org.jvoicexml.interpreter.event.JVoiceXmlEventHandler
-
Removes all cached events that have been received.
- clearEvent() - Method in interface org.jvoicexml.interpreter.EventHandler
-
Removes all cached events that have been received.
- clone() - Method in interface org.jvoicexml.interpreter.Dialog
-
Creates a clone of this dialog.
- clone() - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
- clone() - Method in class org.jvoicexml.interpreter.dialog.ExecutableMenuForm
-
Creates a clone of this dialog.
- clone() - Method in class org.jvoicexml.interpreter.dialog.ExecutablePlainForm
-
Creates a clone of this dialog.
- clone() - Method in interface org.jvoicexml.profile.SsmlParsingStrategy
-
Creates a new instance of this strategy.
- cloneNode(SsmlParser, DataModel, SsmlDocument, SsmlNode, VoiceXmlNode) - Method in interface org.jvoicexml.profile.SsmlParsingStrategy
-
Creates a clone of this node in the given document.
- close() - Method in class org.jvoicexml.implementation.dtmf.BufferedDtmfInput
-
Closes and releases the acquired resources.
- close() - Method in interface org.jvoicexml.implementation.ExternalResource
-
Closes and releases the acquired resources.
- close() - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupport
-
Closes and releases the acquired resources.
- close() - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatform
-
Closes all open resources.
- close() - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatformFactory
-
Closes all implementation platforms.
- close() - Method in class org.jvoicexml.implementation.pool.KeyedResourcePool
-
Closes all pools for all keys.
- close() - Method in interface org.jvoicexml.ImplementationPlatform
-
Closes all open resources.
- close() - Method in interface org.jvoicexml.ImplementationPlatformFactory
-
Closes all implementation platforms.
- close() - Method in class org.jvoicexml.interpreter.scope.ScopedCollection
-
- close() - Method in class org.jvoicexml.interpreter.scope.ScopedMap
-
Unsubscribe this scoped container from the ScopePublisher.
- close() - Method in class org.jvoicexml.interpreter.scope.ScopedSet
-
- close() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Closes all open resources.
- collect(VoiceXmlInterpreterContext, VoiceXmlInterpreter, VoiceXmlDocument) - Method in class org.jvoicexml.interpreter.event.JVoiceXmlEventHandler
-
Adds all event handlers defined in the given document.
- collect(VoiceXmlInterpreterContext, VoiceXmlInterpreter, Dialog) - Method in class org.jvoicexml.interpreter.event.JVoiceXmlEventHandler
-
Adds all event handlers defined in the given dialog.
- collect(VoiceXmlInterpreterContext, VoiceXmlInterpreter, FormInterpretationAlgorithm, CatchContainer) - Method in class org.jvoicexml.interpreter.event.JVoiceXmlEventHandler
-
Adds all event handlers defined in the given input item.
- collect(VoiceXmlInterpreterContext, VoiceXmlInterpreter, VoiceXmlDocument) - Method in interface org.jvoicexml.interpreter.EventHandler
-
Adds all event handlers defined in the given document.
- collect(VoiceXmlInterpreterContext, VoiceXmlInterpreter, Dialog) - Method in interface org.jvoicexml.interpreter.EventHandler
-
Adds all event handlers defined in the given dialog.
- collect(VoiceXmlInterpreterContext, VoiceXmlInterpreter, FormInterpretationAlgorithm, CatchContainer) - Method in interface org.jvoicexml.interpreter.EventHandler
-
Adds all event handlers defined in the given input item.
- Configurable - Interface in org.jvoicexml
-
A component that requires further configuration.
- Configuration - Interface in org.jvoicexml
-
JVoiceXML configuration.
- ConfigurationException - Exception in org.jvoicexml
-
Error configuring a component.
- ConfigurationException() - Constructor for exception org.jvoicexml.ConfigurationException
-
Constructs a new object.
- ConfigurationException(String) - Constructor for exception org.jvoicexml.ConfigurationException
-
Constructs a new object with the specified detail message.
- ConfigurationException(Throwable) - Constructor for exception org.jvoicexml.ConfigurationException
-
Constructs a new object with the specified cause and a detail message.
- ConfigurationException(String, Throwable) - Constructor for exception org.jvoicexml.ConfigurationException
-
Constructs a new event with the specified detail message and cause.
- ConfiguredApplication - Class in org.jvoicexml.callmanager
-
Application configuration settings.
- ConfiguredApplication() - Constructor for class org.jvoicexml.callmanager.ConfiguredApplication
-
Constructs a new object.
- connect(ConnectionInformation) - Method in class org.jvoicexml.implementation.dtmf.BufferedDtmfInput
-
- connect(ConnectionInformation) - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupport
-
- connect(ConnectionInformation) - Method in interface org.jvoicexml.RemoteConnectable
-
- Connection - Class in org.jvoicexml.interpreter.datamodel
-
A variable container to hold the connection information.
- Connection(ConnectionInformation) - Constructor for class org.jvoicexml.interpreter.datamodel.Connection
-
Constructs a new object.
- ConnectionDisconnectHangupEvent - Class in org.jvoicexml.event.plain
-
The user has hung up.
- ConnectionDisconnectHangupEvent() - Constructor for class org.jvoicexml.event.plain.ConnectionDisconnectHangupEvent
-
Constructs a new event with the event type as its detail message.
- ConnectionDisconnectHangupEvent(String) - Constructor for class org.jvoicexml.event.plain.ConnectionDisconnectHangupEvent
-
Constructs a new event with the specified detail message. the given
detail message is expanded to the form
<EVENT_TYPE>: <message>.
- ConnectionDisconnectHangupEvent(Throwable) - Constructor for class org.jvoicexml.event.plain.ConnectionDisconnectHangupEvent
-
Constructs a new event with the specified cause and a detail message of
(cause==null ?
- ConnectionDisconnectHangupEvent(String, Throwable) - Constructor for class org.jvoicexml.event.plain.ConnectionDisconnectHangupEvent
-
Constructs a new event with the specified detail message and cause.
- ConnectionDisconnectTransferEvent - Class in org.jvoicexml.event.plain
-
The user has been transferred unconditionally to another line and will not
return.
- ConnectionDisconnectTransferEvent() - Constructor for class org.jvoicexml.event.plain.ConnectionDisconnectTransferEvent
-
Constructs a new event with the event type as its detail message.
- ConnectionDisconnectTransferEvent(String) - Constructor for class org.jvoicexml.event.plain.ConnectionDisconnectTransferEvent
-
Constructs a new event with the specified detail message. the given
detail message is expanded to the form
<EVENT_TYPE>: <message>.
- ConnectionDisconnectTransferEvent(Throwable) - Constructor for class org.jvoicexml.event.plain.ConnectionDisconnectTransferEvent
-
Constructs a new event with the specified cause and a detail message of
(cause==null ?
- ConnectionDisconnectTransferEvent(String, Throwable) - Constructor for class org.jvoicexml.event.plain.ConnectionDisconnectTransferEvent
-
Constructs a new event with the specified detail message and cause.
- ConnectionInformation - Interface in org.jvoicexml
-
- ConnectionInformationCreationException - Exception in org.jvoicexml.callmanager
-
- ConnectionInformationCreationException() - Constructor for exception org.jvoicexml.callmanager.ConnectionInformationCreationException
-
Constructs a new event with the object type as its detail message.
- ConnectionInformationCreationException(String) - Constructor for exception org.jvoicexml.callmanager.ConnectionInformationCreationException
-
Constructs a new object with the specified detail message.
- ConnectionInformationCreationException(Throwable) - Constructor for exception org.jvoicexml.callmanager.ConnectionInformationCreationException
-
Constructs a new object with the specified cause and a detail message of
(cause==null ?
- ConnectionInformationCreationException(String, Throwable) - Constructor for exception org.jvoicexml.callmanager.ConnectionInformationCreationException
-
Constructs a new object with the specified detail message and cause.
- ConnectionLocal - Class in org.jvoicexml.interpreter.datamodel
-
A variable container to hold the local connection information.
- ConnectionLocal(URI) - Constructor for class org.jvoicexml.interpreter.datamodel.ConnectionLocal
-
Constructs a new object.
- ConnectionProtocol - Class in org.jvoicexml.interpreter.datamodel
-
A standard variable container to hold the protocol information.
- ConnectionProtocol(String, String) - Constructor for class org.jvoicexml.interpreter.datamodel.ConnectionProtocol
-
Constructs a new object.
- ConnectionRemote - Class in org.jvoicexml.interpreter.datamodel
-
A variable container to hold the local connection information.
- ConnectionRemote(URI) - Constructor for class org.jvoicexml.interpreter.datamodel.ConnectionRemote
-
Constructs a new object.
- contains(GrammarDocument) - Method in class org.jvoicexml.implementation.grammar.GrammarCache
-
Checks if the active grammar set contains the given grammar document.
- contains(GrammarImplementation<?>) - Method in class org.jvoicexml.implementation.grammar.GrammarCache
-
Checks if the active grammar set contains the given grammar
implementation.
- contains(GrammarDocument) - Method in class org.jvoicexml.interpreter.ActiveGrammarSet
-
Checks if the active grammar set contains the given grammar document.
- contains(Object) - Method in class org.jvoicexml.interpreter.scope.ScopedCollection
- contains(Object) - Method in class org.jvoicexml.interpreter.scope.ScopedSet
- containsAll(Collection<?>) - Method in class org.jvoicexml.interpreter.scope.ScopedCollection
- containsAll(Collection<?>) - Method in class org.jvoicexml.interpreter.scope.ScopedSet
- containsKey(Object) - Method in class org.jvoicexml.interpreter.scope.ScopedMap
-
Returns true if this map contains a mapping for the specified
key.
- containsValue(Object) - Method in class org.jvoicexml.interpreter.scope.ScopedMap
-
Returns true if this map maps one or more keys to the
specified value.
- CONTEXT_PATH - Static variable in class org.jvoicexml.documentserver.jetty.BuiltinGrammarHandler
-
The context path of this handler.
- ControlItem - Interface in org.jvoicexml.interpreter
-
Implementation of a control item.
- convertChoice(Choice, ModeType, ConvertedChoiceOption) - Method in interface org.jvoicexml.interpreter.dialog.ChoiceConverter
-
Converts the given choice into a grammar.
- convertChoice(Choice, ModeType, ConvertedChoiceOption) - Method in class org.jvoicexml.interpreter.dialog.SrgsXmlChoiceConverter
-
Converts the given choice into a grammar.
- ConvertedChoiceOption - Class in org.jvoicexml.interpreter.dialog
-
A converted choice option.
- ConvertedChoiceOption(Field) - Constructor for class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Constructs a new object.
- createArray(String, int) - Method in interface org.jvoicexml.interpreter.datamodel.DataModel
-
Creates an array with the given dimension on top most scope on the scope
stack.
- createArray(String, int, Scope) - Method in interface org.jvoicexml.interpreter.datamodel.DataModel
-
Creates an array with the given dimension at the specified scope.
- createConnectionInformation(CallManager, ConfiguredApplication, CallParameters) - Method in interface org.jvoicexml.callmanager.TerminalConnectionInformationFactory
-
- createDtmfGrammar(Collection<Option>) - Method in interface org.jvoicexml.interpreter.formitem.OptionConverter
-
Creates a DTMF grammar from the given options.
- createDtmfGrammar(Collection<Option>) - Method in class org.jvoicexml.interpreter.formitem.SrgsXmlOptionConverter
-
Creates a DTMF grammar from the given options.
- createGrammar(URI) - Method in class org.jvoicexml.documentserver.schemestrategy.builtin.BooleanGrammarCreator
-
Creates the built-in grammar.
- createGrammar(URI) - Method in class org.jvoicexml.documentserver.schemestrategy.builtin.DigitsGrammarCreator
-
Creates the built-in grammar.
- createGrammar(URI) - Method in interface org.jvoicexml.documentserver.schemestrategy.builtin.GrammarCreator
-
Creates the built-in grammar.
- createGrammarNode() - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Creates an empty grammar node within the field.
- createNewObject() - Method in interface org.jvoicexml.interpreter.datamodel.DataModel
-
Retrieves a new empty object for this data model.
- createResource() - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupportFactory
-
Factory method to create a resource.
- createResource() - Method in interface org.jvoicexml.implementation.ResourceFactory
-
Factory method to create a resource.
- createScope(Scope) - Method in interface org.jvoicexml.interpreter.datamodel.DataModel
-
Creates a new scope object and pushes it on top of the scope stack.
- createScope() - Method in interface org.jvoicexml.interpreter.datamodel.DataModel
-
Creates a new scope object and pushes it on top of the scope stack.
- createSession(Terminal, CallParameters) - Method in class org.jvoicexml.callmanager.BaseCallManager
-
Creates a session for the given terminal and initiates a call at
JVoiceXml.
- createSession(ConnectionInformation) - Method in interface org.jvoicexml.JVoiceXml
-
Creates a new session.
- createSession(ConnectionInformation) - Method in class org.jvoicexml.JVoiceXmlMain
-
Creates a new session.
- createSessionIdentifier(String) - Method in interface org.jvoicexml.documentserver.schemestrategy.SessionIdentifierFactory
-
Creates a new session identifier.
- createTerminals() - Method in class org.jvoicexml.callmanager.BaseCallManager
-
Creates all terminals without starting them.
- createVariable(String) - Method in interface org.jvoicexml.interpreter.datamodel.DataModel
-
Creates a variable with the default value specified by the underlying
datamodel retrieved via
DataModel.getUndefinedValue() at the topmost scope
on the scope stack.
- createVariable(String, Object) - Method in interface org.jvoicexml.interpreter.datamodel.DataModel
-
Creates a variable with the given initial value on top most scope on the
scope stack.
- createVariable(String, Object, Scope) - Method in interface org.jvoicexml.interpreter.datamodel.DataModel
-
Creates a variable.
- createVariableFor(Object, String) - Method in interface org.jvoicexml.interpreter.datamodel.DataModel
-
Creates a variable as a nested property in the specified variable
container with the default value specified by the underlying datamodel
retrieved via
DataModel.getUndefinedValue() at the topmost scope on the
scope stack.
- createVariableFor(Object, String, Object) - Method in interface org.jvoicexml.interpreter.datamodel.DataModel
-
Creates a variable as a nested property in the given container with the
given initial value on top most scope on the scope stack.
- createVoiceGrammar(Collection<Option>, Locale) - Method in interface org.jvoicexml.interpreter.formitem.OptionConverter
-
Creates a voice grammar from the given options.
- createVoiceGrammar(Collection<Option>, Locale) - Method in class org.jvoicexml.interpreter.formitem.SrgsXmlOptionConverter
-
Creates a voice grammar from the given options.
- currentScope() - Method in class org.jvoicexml.interpreter.scope.ScopeObserver
-
Retrieve the current scope.
- GenericVoiceXmlEvent - Class in org.jvoicexml.event
-
Generic VoiceXmlEvent that is thrown from a
<throw> tag.
- GenericVoiceXmlEvent(String) - Constructor for class org.jvoicexml.event.GenericVoiceXmlEvent
-
Constructs a new event with the given event type as its detail message.
- GenericVoiceXmlEvent(String, String) - Constructor for class org.jvoicexml.event.GenericVoiceXmlEvent
-
Constructs a new event with the specified detail message. the given
detail message is expanded to the form
<EVENT_TYPE>: <message>.
- get(GrammarDocument) - Method in class org.jvoicexml.implementation.grammar.GrammarCache
-
Retrieves the processed grammar for the given document.
- get(Object) - Method in class org.jvoicexml.interpreter.scope.ScopedMap
-
Returns the value to which this map maps the specified key.
- getAccept() - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Retrieves the accept type.
- getAcceptedInputs() - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Retrieves the accepted inputs.
- getActiveGrammarSet() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Retrieves the active grammar set.
- getApplication() - Method in interface org.jvoicexml.Application
-
Retrieves the URI of the application.
- getApplication(String) - Method in class org.jvoicexml.callmanager.BaseCallManager
-
Retrieves the application for the given terminal.
- getApplication() - Method in class org.jvoicexml.interpreter.JVoiceXmlApplication
-
Retrieves the URI of the application.
- getApplication() - Method in class org.jvoicexml.interpreter.JVoiceXmlSession
-
Retrieves the application that is currently being processed.
- getApplication() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Retrieves the application.
- getApplication() - Method in interface org.jvoicexml.Session
-
Retrieves the application that is currently being processed.
- getApplications() - Method in class org.jvoicexml.callmanager.BaseCallManager
-
Retrieves all configured applications.
- getAttributes() - Method in class org.jvoicexml.DocumentDescriptor
-
Retrieve the fetch attributes.
- getAttributes(VoiceXmlInterpreterContext, FormInterpretationAlgorithm, VoiceXmlNode) - Method in interface org.jvoicexml.profile.SsmlParsingStrategy
-
Retrieves all attributes specified by the given node or by a
<property> tag and stores their values in the working
copy of this strategy.
- getAttributes(VoiceXmlInterpreterContext, FormInterpretationAlgorithm, VoiceXmlNode) - Method in interface org.jvoicexml.profile.TagStrategy
-
Retrieves all attributes specified by the given node or by a
<property> tag and stores their values in the working
copy of this strategy.
- getAudioFormat() - Method in interface org.jvoicexml.implementation.AudioSink
-
Retrieves the audio format that this sink is consuming.
- getAudioFormat() - Method in interface org.jvoicexml.implementation.AudioSource
-
Retrieves the audio format that this source is delivering.
- getAudioInputStream(String, URI) - Method in interface org.jvoicexml.DocumentServer
-
Retrieves an AudioStream to the audio file with the given
URI.
- getAudioInputStream(String, URI) - Method in class org.jvoicexml.documentserver.JVoiceXmlDocumentServer
-
Retrieves an AudioStream to the audio file with the given
URI.
- getAvailableIdentifier(GrammarType) - Method in class org.jvoicexml.interpreter.grammar.GrammarIdentifierCentral
-
Returns a List of identifiers, that have been registered and
are supporting the given type.
- getBargeInType() - Method in class org.jvoicexml.SpeakableSsmlText
-
Retrieves the barge-in type.
- getBaseUri() - Method in class org.jvoicexml.documentserver.VariableEncoder
-
Get the base URI without any parameters.
- getBuffer() - Method in class org.jvoicexml.documentserver.ExternalGrammarDocument
-
Retrieves the document's byte array.
- getBuffer() - Method in class org.jvoicexml.documentserver.ExternalReferenceGrammarDocument
-
Retrieves the document's byte array.
- getBuffer() - Method in interface org.jvoicexml.GrammarDocument
-
Retrieves the document's byte array.
- getBuffer() - Method in class org.jvoicexml.interpreter.grammar.InternalGrammarDocument
-
Retrieves the document's byte array.
- getBytes() - Method in class org.jvoicexml.documentserver.ReadBuffer
-
Retrieves the read buffer.
- getBytes(SrgsXmlDocument) - Method in class org.jvoicexml.documentserver.schemestrategy.builtin.AbstractGrammarCreator
-
Retrieves a byte representation of the given document.
- getCallControl() - Method in interface org.jvoicexml.ConnectionInformation
-
Retrieves a unique identifier for the
CallControl to use.
- getCallControl() - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatform
-
Retrieves the calling device.
- getCallControl() - Method in interface org.jvoicexml.ImplementationPlatform
-
Retrieves the calling device.
- getCallControlProperties(FormInterpretationAlgorithm) - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Loads the speech recognizer properties.
- getCalledDevice() - Method in interface org.jvoicexml.ConnectionInformation
-
Retrieves the URI of the caller device.
- getCalledId() - Method in class org.jvoicexml.callmanager.CallParameters
-
Retrieves the called id.
- getCallerId() - Method in class org.jvoicexml.callmanager.CallParameters
-
Retrieves the id of the caller.
- getCallingDevice() - Method in interface org.jvoicexml.ConnectionInformation
-
Retrieves the URI of the calling device.
- getCatchElements() - Method in interface org.jvoicexml.interpreter.CatchContainer
-
Get all nested <catch> elements.
- getCatchElements() - Method in class org.jvoicexml.interpreter.dialog.ExecutableMenuForm
-
Gets all nested <catch> elements.
- getCatchElements() - Method in class org.jvoicexml.interpreter.dialog.ExecutablePlainForm
-
Gets all nested <catch> elements.
- getCatchElements() - Method in interface org.jvoicexml.interpreter.Dialog
-
Gets all nested <catch> elements.
- getCatchElements() - Method in class org.jvoicexml.interpreter.formitem.BlockFormItem
-
Retrieves all nested catch elements.
- getCharacterInput() - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatform
-
Retrieves the DTMF input device.
- getCharacterInput() - Method in interface org.jvoicexml.ImplementationPlatform
-
Retrieves the DTMF input device.
- getCharset() - Method in class org.jvoicexml.documentserver.ReadBuffer
-
Retrieves the determined charset if the contents of the buffer is
plain text.
- getChildNodes() - Method in class org.jvoicexml.interpreter.dialog.ExecutableMenuForm
-
Retrieves the child nodes of this executable form.
- getChildNodes() - Method in class org.jvoicexml.interpreter.dialog.ExecutablePlainForm
-
Retrieves the child nodes of this executable form.
- getChildNodes() - Method in interface org.jvoicexml.interpreter.Dialog
-
Retrieves the child nodes of this executable form.
- getCompletetimeoutAsMsec() - Method in class org.jvoicexml.SpeechRecognizerProperties
-
Retrieves the length of silence required following user speech before the
speech recognizer finalizes a result.
- getConfidence() - Method in class org.jvoicexml.LastResult
-
Retrieves the utterance.
- getConfidence() - Method in interface org.jvoicexml.RecognitionResult
-
Retrieves the whole utterance confidence level for this interpretation
from 0.0 - 1.0.
- getConfidencelevel() - Method in class org.jvoicexml.SpeechRecognizerProperties
-
Retrieves the confidence level.
- getConfiguration() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Retrieves the configuration.
- getConfiguration() - Method in interface org.jvoicexml.JVoiceXmlCore
-
Retrieves the configuration object if any.
- getConfiguration() - Method in class org.jvoicexml.JVoiceXmlMain
-
Retrieves the configuration object if any.
- getCount() - Method in interface org.jvoicexml.interpreter.EventStrategy
-
- getCurrentDocument() - Method in interface org.jvoicexml.Application
-
Retrieves the current document.
- getCurrentDocument() - Method in class org.jvoicexml.interpreter.JVoiceXmlApplication
-
Retrieves the current document.
- getDataModel() - Method in class org.jvoicexml.interpreter.JVoiceXmlSession
-
Retrieves the data model.
- getDataModel() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Lazy instantiation of the data model.
- getDest() - Method in class org.jvoicexml.interpreter.formitem.TransferFormItem
-
Retrieves the destination of this transfer by evaluating the
dest and the destexpr attributes.
- getDestination() - Method in class org.jvoicexml.event.plain.jvxml.TransferEvent
-
Retrieves the destination of the transfer.
- getDialog() - Method in class org.jvoicexml.interpreter.FormInterpretationAlgorithm
-
Retrieves the current dialog.
- getDialog(String) - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreter
-
Retrieves the dialog with the given id.
- getDialogs(Vxml) - Method in class org.jvoicexml.interpreter.dialog.JVoiceXmlDialogFactory
-
Retrieves a collection of all
Dialogs in the
given VoiceXML document with the help of the given configuration.
- getDialogs(Vxml) - Method in interface org.jvoicexml.interpreter.DialogFactory
-
Retrieves a collection of all
Dialogs in the
given VoiceXML document with the help of the given configuration.
- getDocument() - Method in class org.jvoicexml.documentserver.ExternalGrammarDocument
-
Retrieves the document as a string.
- getDocument() - Method in class org.jvoicexml.documentserver.ExternalReferenceGrammarDocument
-
Retrieves the document as a string.
- getDocument(String, DocumentDescriptor) - Method in interface org.jvoicexml.DocumentServer
-
Gets the document with the given URI.
- getDocument(URI) - Method in class org.jvoicexml.documentserver.jetty.DocumentStorage
-
Retrieves the content of the document.
- getDocument(String, DocumentDescriptor) - Method in class org.jvoicexml.documentserver.JVoiceXmlDocumentServer
-
Gets the document with the given URI.
- getDocument(URI) - Method in class org.jvoicexml.documentserver.schemestrategy.DocumentMap
-
Gets the document with the given URI.
- getDocument() - Method in class org.jvoicexml.event.plain.jvxml.GotoNextDocumentEvent
-
Retrieves the next document.
- getDocument() - Method in interface org.jvoicexml.GrammarDocument
-
Retrieves the document as a string.
- getDocument() - Method in class org.jvoicexml.implementation.grammar.LoadedGrammar
-
Retrieves the grammar document.
- getDocument() - Method in class org.jvoicexml.interpreter.grammar.InternalGrammarDocument
-
Retrieves the document as a string.
- getDocument() - Method in interface org.jvoicexml.profile.SsmlParser
-
Retrieves the parsed SSML document.
- getDocument() - Method in class org.jvoicexml.SpeakableSsmlText
-
Retrieves the SSML document to speak.
- getDocumentDescriptor() - Method in class org.jvoicexml.event.plain.jvxml.SubmitEvent
-
Retrieves the descriptor of the next document.
- getDocumentServer() - Method in class org.jvoicexml.interpreter.JVoiceXmlSession
-
Retrieves a reference to the document server.
- getDocumentServer() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Retrieves a reference to the document server.
- getDocumentServer() - Method in interface org.jvoicexml.JVoiceXmlCore
-
Retrieves a reference to the document server.
- getDocumentServer() - Method in class org.jvoicexml.JVoiceXmlMain
-
Retrieves a reference to the document server.
- getDtmf() - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Retrieves the DTMF sequence of a choice node.
- getDtmfInput() - Method in class org.jvoicexml.interpreter.JVoiceXmlSession
-
Retrieves the DTMF input device.
- getDtmfInput() - Method in interface org.jvoicexml.Session
-
Retrieves the DTMF input device.
- getDtmfRecognizerProperties(FormInterpretationAlgorithm) - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Loads the DTMF recognizer properties.
- getDuration() - Method in class org.jvoicexml.interpreter.formitem.TransferShadowVarContainer
-
Gets the duration.
- getElement() - Method in class org.jvoicexml.event.error.UnsupportedElementError
-
Retrieve the name of the unsupported element.
- getEvalAttributes() - Method in interface org.jvoicexml.profile.SsmlParsingStrategy
-
Retrieves the names of all attributes, which have to be evaluated by the
scripting environment.
- getEvalAttributes() - Method in interface org.jvoicexml.profile.TagStrategy
-
Retrieves the names of all attributes, which have to be evaluated by the
scripting environment.
- getEvent() - Method in class org.jvoicexml.implementation.TelephonyEvent
-
Retrieves the event type.
- getEvent() - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Retrieves the event to be thrwon instead of a next.
- getEvent() - Method in class org.jvoicexml.interpreter.event.JVoiceXmlEventHandler
-
Retrieves the event.
- getEvent() - Method in interface org.jvoicexml.interpreter.EventHandler
-
Retrieves the event.
- getEventBus() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Retrieves the event bus.
- getEventCount(String) - Method in interface org.jvoicexml.interpreter.EventCountable
-
Retrieve the counter for the given event type.
- getEventCount(String) - Method in class org.jvoicexml.interpreter.formitem.InitialFormItem
-
Retrieve the counter for the given event type.
- getEventHandler() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Retrieves the event handler to use in this context.
- getEventType() - Method in class org.jvoicexml.event.error.BadFetchError
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.error.jvxml.ExceptionWrapper
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.error.jvxml.RemoteException
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.error.NoauthorizationError
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.error.NoresourceError
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.error.SemanticError
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.error.UnsupportedElementError
-
Constructs an event type with the event type as specification.
- getEventType() - Method in class org.jvoicexml.event.GenericVoiceXmlEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.JVoiceXMLEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.CancelEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.ConnectionDisconnectHangupEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.ConnectionDisconnectTransferEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.ExitEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.HelpEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.implementation.NomatchEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.implementation.RecognitionEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.implementation.RecordingStartedEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.implementation.RecordingStoppedEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.implementation.SpokenInputEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.implementation.SynthesizedOutputEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.jvxml.GotoNextDocumentEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.jvxml.GotoNextFormEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.jvxml.GotoNextFormItemEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.jvxml.InternalExitEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.jvxml.ObjectTagResultEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.jvxml.RecordingEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.jvxml.ReturnEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.jvxml.SubdialogResultEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.jvxml.SubmitEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.jvxml.TransferEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.MaxspeechtimeoutEvent
-
Get the event type of this event.
- getEventType() - Method in class org.jvoicexml.event.plain.NoinputEvent
-
Get the event type of this event.
- getEventType() - Method in interface org.jvoicexml.interpreter.EventStrategy
-
Retrieves the event type.
- getFetchAudio() - Method in class org.jvoicexml.FetchAttributes
-
Retrieve the fetchAudio attribute.
- getFetchHint() - Method in class org.jvoicexml.FetchAttributes
-
Set the fetchhint attribute.
- getFetchTimeout() - Method in class org.jvoicexml.FetchAttributes
-
Set the fetchtimeout attribute.
- getFilledElements() - Method in class org.jvoicexml.interpreter.dialog.ExecutableMenuForm
-
Gets all nested <filled> elements.
- getFilledElements() - Method in class org.jvoicexml.interpreter.dialog.ExecutablePlainForm
-
Gets all nested <filled> elements.
- getFilledElements() - Method in interface org.jvoicexml.interpreter.Dialog
-
Gets all nested <filled> elements.
- getFilledElements() - Method in interface org.jvoicexml.interpreter.InputItem
-
Gets all nested <filled> elements.
- getForm() - Method in class org.jvoicexml.event.plain.jvxml.GotoNextFormEvent
-
Retrieves the name of the next form.
- getFormInterpretationAlgorithm() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreter
-
Retrieves the current FIA.
- getFormItem(String) - Method in class org.jvoicexml.interpreter.FormInterpretationAlgorithm
-
Retrieves the
FormItem with the given name.
- getFormItem() - Method in class org.jvoicexml.interpreter.FormInterpretationAlgorithm
-
Retrieves the currently processed
FormItem.
- getFormItem(VoiceXmlInterpreterContext, VoiceXmlNode) - Static method in class org.jvoicexml.interpreter.formitem.FormItemFactory
-
Factory method to get a
FormItem
for a
VoiceXmlNode.
- getFormItems(VoiceXmlInterpreterContext) - Method in class org.jvoicexml.interpreter.dialog.ExecutableMenuForm
-
Retrieves all
FormItems, defined in this form.
- getFormItems(VoiceXmlInterpreterContext) - Method in class org.jvoicexml.interpreter.dialog.ExecutablePlainForm
-
Retrieves all
FormItems, defined in this form.
- getFormItems(VoiceXmlInterpreterContext) - Method in interface org.jvoicexml.interpreter.Dialog
-
Retrieves all
FormItems, defined in this form.
- getFormItems() - Method in class org.jvoicexml.interpreter.FormInterpretationAlgorithm
-
Retrieves all
FormItems of the current dialog of the current
dialog.
- getFormItemVariable() - Method in interface org.jvoicexml.interpreter.FormItem
-
Retrieves the form item variable.
- getGrammar() - Method in class org.jvoicexml.implementation.BinaryGrammar
-
Retrieves the contents of the binary grammar.
- getGrammar() - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Retrieves the grammar object.
- getGrammarDocument(String, URI, FetchAttributes) - Method in interface org.jvoicexml.DocumentServer
-
Returns the external Grammar referenced by URI.
- getGrammarDocument(String, URI, FetchAttributes) - Method in class org.jvoicexml.documentserver.JVoiceXmlDocumentServer
-
Returns the external Grammar referenced by URI.
- getGrammarDocument() - Method in class org.jvoicexml.implementation.DocumentGrammarImplementation
-
Retrieves the grammar document.
- getGrammarDocument() - Method in interface org.jvoicexml.implementation.GrammarImplementation
-
Retrieves the grammar document.
- getGrammarDocument() - Method in class org.jvoicexml.implementation.NuanceDynagramBinaryGrammarImplementation
-
Retrieves the grammar document.
- getGrammarDocument() - Method in class org.jvoicexml.implementation.SrgsXmlGrammarImplementation
-
Retrieves the grammar document.
- getGrammarDocuments() - Method in interface org.jvoicexml.interpreter.GrammarContainer
-
Retrieves the list of converted grammars.
- getGrammarProcessor() - Method in class org.jvoicexml.interpreter.JVoiceXmlSession
-
Retrieves a reference to the grammar processor.
- getGrammarProcessor() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Retrieves a reference to the grammar processor.
- getGrammarProcessor() - Method in interface org.jvoicexml.JVoiceXmlCore
-
Retrieves a reference to the grammar processor.
- getGrammarProcessor() - Method in class org.jvoicexml.JVoiceXmlMain
-
Retrieves a reference to the grammar processor.
- getGrammars() - Method in class org.jvoicexml.interpreter.ActiveGrammarSet
-
Retrieves the grammars that are currently contained in the set.
- getGrammars() - Method in interface org.jvoicexml.interpreter.GrammarContainer
-
Gets all nested definitions of a <grammar>.
- getGrammarTypes() - Method in class org.jvoicexml.interpreter.ActiveGrammarSet
-
Retrieves the grammar types in the active grammar set.
- getId() - Method in class org.jvoicexml.interpreter.dialog.ExecutableMenuForm
-
Retrieves the identifier of this dialog.
- getId() - Method in class org.jvoicexml.interpreter.dialog.ExecutablePlainForm
-
Retrieves the identifier of this dialog.
- getId() - Method in interface org.jvoicexml.interpreter.Dialog
-
Retrieves the identifier of this dialog.
- getImplementation(GrammarDocument) - Method in class org.jvoicexml.implementation.grammar.GrammarCache
-
Retrieves the cached implementation of the give grammar document.
- getImplementation() - Method in class org.jvoicexml.implementation.grammar.LoadedGrammar
-
Retrieves the grammar implementation.
- getImplementationPlatform(ConnectionInformation) - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatformFactory
-
Factory method to retrieve an implementation platform for the given
connection information.
- getImplementationPlatform(ConnectionInformation) - Method in interface org.jvoicexml.ImplementationPlatformFactory
-
Factory method to retrieve an implementation platform for the given
connection information.
- getImplementationPlatform() - Method in class org.jvoicexml.interpreter.JVoiceXmlSession
-
Retrieves a reference to the used implementation platform.
- getImplementationPlatform() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Retrieves a reference to the used implementation platform.
- getImplementations() - Method in class org.jvoicexml.implementation.grammar.GrammarCache
-
Retrieves the set of active grammar implementations.
- getIncompletetimeoutAsMsec() - Method in class org.jvoicexml.SpeechRecognizerProperties
-
Retrieves the required length of silence following user speech after
which a recognizer finalizes a result.
- getInitializationTagStrategyFactory() - Method in interface org.jvoicexml.profile.Profile
-
Retrieves the tag strategy factory Factory for
TagStrategys that
are to be executed before executing the form items.
- getInputmode() - Method in class org.jvoicexml.interpreter.formitem.TransferShadowVarContainer
-
Gets the current inputmode.
- getInputmode() - Method in class org.jvoicexml.LastResult
-
Retrieves the utterance.
- getInputResult() - Method in class org.jvoicexml.event.plain.implementation.NomatchEvent
-
Retrieves the result of the input process.
- getInputResult() - Method in class org.jvoicexml.event.plain.implementation.RecognitionEvent
-
Retrieves the result of the input process.
- getInputResult() - Method in interface org.jvoicexml.event.plain.jvxml.InputEvent
-
Retrieves the result of the input process.
- getInputResult() - Method in class org.jvoicexml.event.plain.jvxml.ObjectTagResultEvent
-
Retrieves the result of the input process.
- getInputResult() - Method in class org.jvoicexml.event.plain.jvxml.RecordingEvent
-
Retrieves the result of the input process.
- getInputResult() - Method in class org.jvoicexml.event.plain.jvxml.SubdialogResultEvent
-
Retrieves the result of the input process.
- getInputResult() - Method in class org.jvoicexml.event.plain.jvxml.TransferEvent
-
Retrieves the result of the input process.
- getInputStream() - Method in class org.jvoicexml.documentserver.ReadBuffer
-
Obtain an input stream for the buffer.
- getInputStream(String, URI, RequestMethod, long, Collection<KeyValuePair>) - Method in class org.jvoicexml.documentserver.schemestrategy.builtin.BuiltinSchemeStrategy
-
Opens the external URI and returns an InputStream to the
referenced object.
- getInputStream(String, URI, RequestMethod, long, Collection<KeyValuePair>) - Method in class org.jvoicexml.documentserver.schemestrategy.FileSchemeStrategy
-
Opens the external URI and returns an InputStream to the
referenced object.
- getInputStream(String, URI, RequestMethod, long, Collection<KeyValuePair>) - Method in interface org.jvoicexml.documentserver.SchemeStrategy
-
Opens the external URI and returns an InputStream to the
referenced object.
- getInputStream(String, URI, RequestMethod, long, Collection<KeyValuePair>) - Method in class org.jvoicexml.documentserver.schemestrategy.HttpSchemeStrategy
-
Opens the external URI and returns an InputStream to the
referenced object.
- getInputStream(String, URI, RequestMethod, long, Collection<KeyValuePair>) - Method in class org.jvoicexml.documentserver.schemestrategy.MappedDocumentStrategy
-
Opens the external URI and returns an InputStream to the
referenced object.
- getInputType() - Method in class org.jvoicexml.callmanager.ConfiguredApplication
-
Retrieves the input type that will be used for the application.
- getInstance() - Static method in class org.jvoicexml.documentserver.schemestrategy.DocumentMap
-
Gets the singleton.
- getInstances() - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupportFactory
-
- getInstances() - Method in interface org.jvoicexml.implementation.ResourceFactory
-
- getInterdigittimeoutAsMsec() - Method in class org.jvoicexml.DtmfRecognizerProperties
-
Retrieves the inter-digit timeout value to use when recognizing DTMF
input.
- getInterpretation() - Method in class org.jvoicexml.LastResult
-
Retrieves the semantic interpretation.
- getItem() - Method in class org.jvoicexml.event.plain.jvxml.GotoNextFormItemEvent
-
Retrieves the name of the next form item.
- getJVoiceXml() - Method in class org.jvoicexml.callmanager.BaseCallManager
-
Retrieves the reference to the interpreter.
- getKey() - Method in class org.jvoicexml.interpreter.datamodel.KeyValuePair
-
Retrieves the key.
- getKeys() - Method in class org.jvoicexml.implementation.pool.KeyedResourcePool
-
Retrieves the available keys of this pool.
- getLanguage() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreter
-
Retrieves the language of the current VoiceXML document.
- getLastError() - Method in class org.jvoicexml.interpreter.JVoiceXmlSession
-
Retrieves an error, if any, that happened during call processing.
- getLastError() - Method in interface org.jvoicexml.Session
-
Retrieves an error, if any, that happened during call processing.
- getLastResult() - Method in interface org.jvoicexml.Application
-
Retrieves information about the last recognition to occur within this
application.
- getLastResult() - Method in class org.jvoicexml.interpreter.JVoiceXmlApplication
-
Retrieves information about the last recognition to occur within this
application.
- getLocal() - Method in class org.jvoicexml.interpreter.datamodel.Connection
-
Retrieves the local attribute.
- getLocalExecutableTags() - Method in interface org.jvoicexml.interpreter.FormItemLocalExecutableTagContainer
-
Retrieves the nested tags that have to be executed locally.
- getLocalProperty(String) - Method in class org.jvoicexml.interpreter.FormInterpretationAlgorithm
-
Retrieves the value of the given property.
- getMark() - Method in class org.jvoicexml.event.plain.implementation.MarkerReachedEvent
-
Returns the name of the mark that has been reached.
- getMark() - Method in interface org.jvoicexml.RecognitionResult
-
Retrieves the name of the mark, that has been reached while playing back
an SSML formatted document.
- getMaxage() - Method in class org.jvoicexml.FetchAttributes
-
Set the maxage attribute.
- getMaxspeechtimeoutAsMsec() - Method in class org.jvoicexml.SpeechRecognizerProperties
-
/* Retrieves the maximum duration of user speech.
- getMaxstale() - Method in class org.jvoicexml.FetchAttributes
-
Set the maxstale attribute.
- getMaxtime() - Method in class org.jvoicexml.interpreter.formitem.RecordFormItem
-
Retrieves the record's maxtime attribute as msec.
- getMediaType() - Method in class org.jvoicexml.documentserver.ExternalGrammarDocument
-
Returns the declared media type of the grammar.
- getMediaType() - Method in class org.jvoicexml.documentserver.ExternalReferenceGrammarDocument
-
Returns the declared media type of the grammar.
- getMediaType() - Method in interface org.jvoicexml.GrammarDocument
-
Returns the declared media type of the grammar.
- getMediaType() - Method in class org.jvoicexml.implementation.DocumentGrammarImplementation
-
Returns the declared media type of the external grammar.
- getMediaType() - Method in interface org.jvoicexml.implementation.GrammarImplementation
-
Returns the declared media type of the external grammar.
- getMediaType() - Method in class org.jvoicexml.implementation.NuanceDynagramBinaryGrammarImplementation
-
Returns the declared media type of the external grammar.
- getMediaType() - Method in class org.jvoicexml.implementation.SrgsXmlGrammarImplementation
-
Returns the declared media type of the external grammar.
- getMediaType() - Method in class org.jvoicexml.interpreter.grammar.InternalGrammarDocument
-
Returns the declared media type of the grammar.
- getMessage() - Method in class org.jvoicexml.event.JVoiceXMLEvent
-
Preceed the type to the original message.
- getMethod() - Method in class org.jvoicexml.DocumentDescriptor
-
Retrieves the request method.
- getMode(URI) - Method in class org.jvoicexml.documentserver.schemestrategy.builtin.AbstractGrammarCreator
-
Retrieves the mode of the grammar.
- getMode() - Method in class org.jvoicexml.event.plain.implementation.InputStartedEvent
-
Retrieves the mode type.
- getMode() - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Sets the mode type.
- getMode() - Method in interface org.jvoicexml.RecognitionResult
-
Retrieves the mode in which user input was provided: dtmf or voice.
- getModeType() - Method in class org.jvoicexml.documentserver.ExternalGrammarDocument
-
Returns the mode type of the grammar.
- getModeType() - Method in class org.jvoicexml.documentserver.ExternalReferenceGrammarDocument
-
Returns the mode type of the grammar.
- getModeType() - Method in interface org.jvoicexml.GrammarDocument
-
Returns the mode type of the grammar.
- getModeType() - Method in class org.jvoicexml.implementation.DocumentGrammarImplementation
-
Returns the mode type of the grammar.
- getModeType() - Method in interface org.jvoicexml.implementation.GrammarImplementation
-
Returns the mode type of the grammar.
- getModeType() - Method in class org.jvoicexml.implementation.NuanceDynagramBinaryGrammarImplementation
-
Returns the mode type of the grammar.
- getModeType() - Method in class org.jvoicexml.implementation.SrgsXmlGrammarImplementation
-
Returns the mode type of the grammar.
- getModeType() - Method in class org.jvoicexml.interpreter.grammar.InternalGrammarDocument
-
Returns the mode type of the grammar.
- getModeTypes() - Method in class org.jvoicexml.interpreter.ActiveGrammarSet
-
Retrieves the mode types in the active grammar set.
- getName() - Method in interface org.jvoicexml.callmanager.Terminal
-
Retrieves the name of a terminal.
- getName() - Method in class org.jvoicexml.interpreter.datamodel.ConnectionProtocol
-
Retrieves the name attribute.
- getName(VoiceXmlNode) - Static method in class org.jvoicexml.interpreter.formitem.FormItemNameFactory
-
Get a name for the given node using the ATTRIBUTE_NAME
attribute.
- getName() - Method in interface org.jvoicexml.interpreter.FormItem
-
Retrieves the name of this FormItem..
- getName() - Method in interface org.jvoicexml.interpreter.PromptCountable
-
Retrieves the name.
- getName() - Method in enum org.jvoicexml.interpreter.scope.Scope
-
Retrieve the scope's name.
- getName() - Method in interface org.jvoicexml.profile.Profile
-
Retrieves the name of this profile.
- getNext() - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Retrieves the URI of next dialog or document.
- getNextDialog() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreter
-
Retrieves the next dialog to process.
- getNode() - Method in interface org.jvoicexml.interpreter.FormItem
-
Retrieves the encapsulated VoiceXmlNode.
- getNode() - Method in interface org.jvoicexml.interpreter.PromptCountable
-
Retrieves the corresponding node in the VoiceXML document.
- getNodeTagName() - Method in interface org.jvoicexml.interpreter.FormItem
-
Retrieves the tag name of the encapsulated node.
- getNumActive() - Method in class org.jvoicexml.implementation.pool.KeyedResourcePool
-
Retrieves the number of active resources in all pools.
- getNumActive(String) - Method in class org.jvoicexml.implementation.pool.KeyedResourcePool
-
Retrieves the number of active resources in the pool for the given key.
- getNumIdle() - Method in class org.jvoicexml.implementation.pool.KeyedResourcePool
-
Retrieves the number of idle resources in all pools.
- getNumIdle(String) - Method in class org.jvoicexml.implementation.pool.KeyedResourcePool
-
Retrieves the number of idle resources in the pool for the given key.
- getObject(String, DocumentDescriptor, String) - Method in interface org.jvoicexml.DocumentServer
-
Retrieves an object of the given type from the given URI.
- getObject(String, DocumentDescriptor, String) - Method in class org.jvoicexml.documentserver.JVoiceXmlDocumentServer
-
Retrieves an object of the given type from the given URI.
- getOutputType() - Method in class org.jvoicexml.callmanager.ConfiguredApplication
-
Retrieves the output type that will be used for the application.
- getParam() - Method in class org.jvoicexml.implementation.TelephonyEvent
-
Retrieves the parameter.
- getParameters() - Method in class org.jvoicexml.DocumentDescriptor
-
Retrieves the known parameter.
- getParameters(URI) - Method in class org.jvoicexml.documentserver.schemestrategy.builtin.AbstractGrammarCreator
-
Retrieves the query parameters from the URI.
- getParsingStrategy(VoiceXmlNode) - Method in interface org.jvoicexml.profile.SsmlParsingStrategyFactory
-
Factory method to get a strategy to clone the given node.
- getProfile() - Method in interface org.jvoicexml.ConnectionInformation
-
Retrieves the profile to use.
- getProfile() - Method in class org.jvoicexml.interpreter.JVoiceXmlSession
-
Retrieves the profile.
- getProfile() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Retrieves the active profile.
- getPromptCount() - Method in class org.jvoicexml.interpreter.formitem.InitialFormItem
-
Retrieves the value of the prompt counter.
- getPromptCount() - Method in interface org.jvoicexml.interpreter.PromptCountable
-
Retrieves the value of the prompt counter.
- getProperty(String) - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Retrieves the value of the given property.
- getProperty(String, String) - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Retrieves the value of the given property.
- getProtocol() - Method in class org.jvoicexml.event.error.BadFetchProtocolResponsecodeError
-
Retrieve the protocol.
- getProtocol() - Method in class org.jvoicexml.interpreter.datamodel.Connection
-
Retrieves the protocol attribute.
- getProtocolName() - Method in interface org.jvoicexml.ConnectionInformation
-
Retrieves the name of the connection protocol.
- getProtocolVersion() - Method in interface org.jvoicexml.ConnectionInformation
-
Retrieves the version of the connection protocol.
- getRecognitionResult() - Method in class org.jvoicexml.event.plain.implementation.NomatchEvent
-
Retrieves the result of the recognition process.
- getRecognitionResult() - Method in class org.jvoicexml.event.plain.implementation.RecognitionEvent
-
Retrieves the result of the recognition process.
- getRecordingAudioFormat() - Method in interface org.jvoicexml.CallControl
-
Retrieves the audio format that should be used for file recording.
- getRecordingAudioFormat() - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupport
-
Retrieves the audio format that should be used for file recording.
- getRecordingAudioFormat() - Method in interface org.jvoicexml.implementation.Telephony
-
Retrieves the audio format that should be used for file recording.
- getRecordingBuffer() - Method in class org.jvoicexml.event.plain.jvxml.RecordingEvent
-
Retrieves the buffer of the recording.
- getRemote() - Method in class org.jvoicexml.interpreter.datamodel.Connection
-
Retrieves the remote attribute.
- getResourceType() - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupportFactory
-
Returns the class type of the resource to create.
- getResourceType() - Method in interface org.jvoicexml.implementation.ResourceFactory
-
Returns the class type of the resource to create.
- getResponseCode() - Method in class org.jvoicexml.event.error.BadFetchProtocolResponsecodeError
-
Retrieve the protocol-specific response code.
- getReturnValue() - Method in class org.jvoicexml.event.plain.jvxml.InternalExitEvent
-
Retrieves the return value.
- getScheme() - Method in class org.jvoicexml.documentserver.schemestrategy.builtin.BuiltinSchemeStrategy
-
Get the scheme that is handled by this strategy.
- getScheme() - Method in class org.jvoicexml.documentserver.schemestrategy.FileSchemeStrategy
-
Get the scheme that is handled by this strategy.
- getScheme() - Method in interface org.jvoicexml.documentserver.SchemeStrategy
-
Get the scheme that is handled by this strategy.
- getScheme() - Method in class org.jvoicexml.documentserver.schemestrategy.HttpSchemeStrategy
-
Get the scheme that is handled by this strategy.
- getScheme() - Method in class org.jvoicexml.documentserver.schemestrategy.MappedDocumentStrategy
-
Get the scheme that is handled by this strategy.
- getScopeObserver() - Method in class org.jvoicexml.interpreter.JVoiceXmlSession
-
Retrieves the scope observer for this session.
- getScopeObserver() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Retrieves the scope observer for this session.
- getSemanticInterpretation(DataModel, String) - Method in interface org.jvoicexml.implementation.grammar.GrammarEvaluator
-
Processes the given utterance and retrieves the corresponding semantic
interpretation.
- getSemanticInterpretation(DataModel) - Method in interface org.jvoicexml.RecognitionResult
-
Retrieves the semantic interpretation of the utterance.
- getSensitivity() - Method in class org.jvoicexml.SpeechRecognizerProperties
-
Retrieves the sensitivity.
- getSerializer() - Method in interface org.jvoicexml.interpreter.datamodel.DataModel
-
Retrieves the Serializer for objects when submitting.
- getSession() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Retrieves the current session.
- getSessionId() - Method in class org.jvoicexml.event.plain.implementation.RecordingStartedEvent
-
Retrieves the session id.
- getSessionId() - Method in class org.jvoicexml.event.plain.implementation.RecordingStoppedEvent
-
Retrieves the session id.
- getSessionId() - Method in class org.jvoicexml.event.plain.implementation.SpokenInputEvent
-
Retrieves the session id.
- getSessionId() - Method in class org.jvoicexml.event.plain.implementation.SynthesizedOutputEvent
-
Retrieves the session id.
- getSessionId() - Method in class org.jvoicexml.interpreter.JVoiceXmlSession
-
Retrieves the universal unique identifier for this session.
- getSessionId() - Method in interface org.jvoicexml.Session
-
Retrieves the universal unique identifier for this session.
- getSessionIdentifier(String) - Method in class org.jvoicexml.documentserver.schemestrategy.SessionStorage
-
Retrieves the identifier for the given session.If no identifier exists
a new identifier is created using the
SessionIdentifierFactory.
- getSlot() - Method in class org.jvoicexml.interpreter.formitem.FieldFormItem
-
Retrieves the slot of the related field in mixed initiative dialogs.
- getSource() - Method in class org.jvoicexml.event.plain.implementation.SpokenInputEvent
-
Retrieves the object that caused the event.
- getSource() - Method in class org.jvoicexml.event.plain.implementation.SynthesizedOutputEvent
-
Retrieves the object that caused the event.
- getSource() - Method in class org.jvoicexml.implementation.TelephonyEvent
-
Retrieves the object that caused the event.
- getSpeakable() - Method in class org.jvoicexml.event.plain.implementation.OutputEndedEvent
-
Retrieves the speakable.
- getSpeakable() - Method in class org.jvoicexml.event.plain.implementation.OutputStartedEvent
-
Retrieves the speakable.
- getSpeakableText() - Method in class org.jvoicexml.SpeakableSsmlText
-
Retrieves the text to be passed to the TTS Engine.
- getSpeakableText() - Method in interface org.jvoicexml.SpeakableText
-
Retrieves the text to be passed to the TTS Engine.
- getSpeechRecognizerProperties(FormInterpretationAlgorithm) - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Loads the speech recognizer properties.
- getSpeedvsaccuracy() - Method in class org.jvoicexml.SpeechRecognizerProperties
-
Retrieves a hint specifying the desired balance between speed vs.
- getSpokeninput() - Method in class org.jvoicexml.implementation.Platform
-
Retrieves the spoken input implementation.
- getSpokeninput() - Method in interface org.jvoicexml.implementation.PlatformFactory
-
Retrieves the spoken input implementation.
- getSpokenInput() - Method in interface org.jvoicexml.implementation.SpokenInputProvider
-
Retrieves the spoken input device.
- getSsmlParsingStrategyFactory() - Method in interface org.jvoicexml.profile.Profile
-
Retrieves the parsing strategy to parse nodes into SSML document.
- getState() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreter
-
Retrieves the interpreter state.
- getStateName() - Method in enum org.jvoicexml.interpreter.InterpreterState
-
Retrieves the name of this state.
- getSubdialigUri() - Method in class org.jvoicexml.interpreter.formitem.SubdialogFormItem
-
Retrieves the URI of the subdialog to execute.
- getSupportedBargeInTypes() - Method in class org.jvoicexml.implementation.dtmf.BufferedDtmfInput
-
Retrieves the barge-in types supported by this UserInput.
- getSupportedBargeInTypes() - Method in interface org.jvoicexml.implementation.SpokenInput
-
Retrieves the barge-in types supported by this UserInput.
- getSupportedBargeInTypes() - Method in interface org.jvoicexml.UserInput
-
Retrieves the barge-in types supported by this UserInput.
- getSupportedGrammarTypes() - Method in class org.jvoicexml.implementation.dtmf.BufferedDtmfInput
-
Retrieves the grammar types that are supported by this implementation.
- getSupportedGrammarTypes() - Method in interface org.jvoicexml.implementation.SpokenInput
-
Retrieves the grammar types that are supported by this implementation.
- getSupportedGrammarTypes(ModeType) - Method in interface org.jvoicexml.UserInput
-
Retrieves the grammar types that are supported by this implementation for
the given mode.
- getSupportedType() - Method in interface org.jvoicexml.interpreter.grammar.GrammarIdentifier
-
Returns the supported media type.
- getSupportedType() - Method in class org.jvoicexml.interpreter.grammar.identifier.GslGrammarIdentifier
-
Returns the supported media type.
- getSupportedType() - Method in class org.jvoicexml.interpreter.grammar.identifier.JsgfGrammarIdentifier
-
Returns the supported media type.
- getSupportedType() - Method in class org.jvoicexml.interpreter.grammar.identifier.NuanceDynagramBinaryGrammarIdentifier
-
Returns the supported media type.
- getSupportedType() - Method in class org.jvoicexml.interpreter.grammar.identifier.SrgsAbnfGrammarIdentifier
-
Returns the supported media type.
- getSupportedType() - Method in class org.jvoicexml.interpreter.grammar.identifier.SrgsXmlGrammarIdentifier
-
Returns the supported media type.
- getSynthesizedoutput() - Method in class org.jvoicexml.implementation.Platform
-
Retrieves the synthesized output implementation.
- getSynthesizedoutput() - Method in interface org.jvoicexml.implementation.PlatformFactory
-
Retrieves the synthesized output implementation.
- getSynthesizedOutput() - Method in interface org.jvoicexml.implementation.SynthesizedOutputProvider
-
Retrieves the synthesized output device.
- getSystemOutput() - Method in interface org.jvoicexml.ConnectionInformation
-
- getSystemOutput() - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatform
-
Retrieves the audio output device.
- getSystemOutput() - Method in interface org.jvoicexml.ImplementationPlatform
-
Retrieves the audio output device.
- getTagNamespace() - Method in interface org.jvoicexml.profile.TagStrategyFactory
-
Retrieves the namespace of the tags that are returned by this factory.
- getTagStrategy(Node) - Method in interface org.jvoicexml.profile.TagStrategyFactory
-
Factory method to get a strategy to process the given node.
- getTagStrategy(String) - Method in interface org.jvoicexml.profile.TagStrategyFactory
-
Factory method to get a strategy to process a node with the given name.
- getTagStrategyExecutor() - Method in class org.jvoicexml.interpreter.FormInterpretationAlgorithm
-
Retrieves the tag strategy executor.
- getTagStrategyFactory() - Method in interface org.jvoicexml.profile.Profile
-
Retrieves the tag strategy factory.
- getTelephony() - Method in class org.jvoicexml.implementation.Platform
-
Retrieves the telephonyFactory implementation.
- getTelephony() - Method in interface org.jvoicexml.implementation.PlatformFactory
-
Retrieves the telephonyFactory implementation.
- getTelephony() - Method in interface org.jvoicexml.implementation.TelephonyProvider
-
Retrieves the synthesized output device.
- getTermchar() - Method in class org.jvoicexml.DtmfRecognizerProperties
-
Retrieves the terminating DTMF character for DTMF input recognition.
- getTerminal() - Method in class org.jvoicexml.callmanager.CallParameters
-
Retrieves the terminal.
- getTerminal() - Method in class org.jvoicexml.callmanager.ConfiguredApplication
-
Retrieves the name of the SIP user.
- getTermtimeoutAsMsec() - Method in class org.jvoicexml.DtmfRecognizerProperties
-
Retrieves the terminating timeout to use when recognizing DTMF input.
- getText() - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Retrieves the text within the choice node.
- getTextContent() - Method in class org.jvoicexml.documentserver.ExternalGrammarDocument
-
Retrieves the document as a string.
- getTextContent() - Method in class org.jvoicexml.documentserver.ExternalReferenceGrammarDocument
-
Retrieves the document as a string.
- getTextContent() - Method in interface org.jvoicexml.GrammarDocument
-
Retrieves the document as a string.
- getTextContent() - Method in class org.jvoicexml.interpreter.grammar.InternalGrammarDocument
-
Retrieves the document as a string.
- getTimeout() - Method in class org.jvoicexml.SpeakableSsmlText
-
Retrieves the timeout of this speakable to wait before a
noinput event is generated.
- getType() - Method in class org.jvoicexml.implementation.dtmf.BufferedDtmfInput
-
Retrieves a unique identifier for this external resource.
- getType() - Method in interface org.jvoicexml.implementation.ExternalResource
-
Retrieves a unique identifier for this external resource.
- getType() - Method in interface org.jvoicexml.implementation.grammar.GrammarParser
-
Retrieves the grammar type that this parser will process.
- getType() - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupport
-
Retrieves a unique identifier for this external resource.
- getType() - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupportFactory
-
Retrieves the type of the resources that are created by this
factory.
- getType() - Method in interface org.jvoicexml.implementation.ResourceFactory
-
Retrieves the type of the resources that are created by this
factory.
- getTypeName() - Method in class org.jvoicexml.documentserver.schemestrategy.builtin.BooleanGrammarCreator
-
Retrieves the type name of this grammar creator.
- getTypeName() - Method in class org.jvoicexml.documentserver.schemestrategy.builtin.DigitsGrammarCreator
-
Retrieves the type name of this grammar creator.
- getTypeName() - Method in interface org.jvoicexml.documentserver.schemestrategy.builtin.GrammarCreator
-
Retrieves the type name of this grammar creator.
- getUndefinedValue() - Method in interface org.jvoicexml.interpreter.datamodel.DataModel
-
Retrieves the value for undefined.
- getUri() - Method in class org.jvoicexml.callmanager.ConfiguredApplication
-
Retrieves the URI of the application to call.
- getUri() - Method in class org.jvoicexml.DocumentDescriptor
-
Retrieves the URI of the document to fetch.
- getURI() - Method in class org.jvoicexml.documentserver.ExternalGrammarDocument
-
Retrieves the URI of the source grammar.
- getURI() - Method in class org.jvoicexml.documentserver.ExternalReferenceGrammarDocument
-
Retrieves the URI of the source grammar.
- getUri(String) - Method in class org.jvoicexml.documentserver.schemestrategy.DocumentMap
-
Gets an URI that can be evaluated by this scheme strategy for the
given path.
- getUri(String) - Method in interface org.jvoicexml.documentserver.schemestrategy.MappedDocumentRepository
-
Gets an URI that can be evaluated by this scheme strategy for the
given path.
- getUri() - Method in class org.jvoicexml.event.plain.implementation.RecordingStoppedEvent
-
Retrieves the URI where the audio is stored.
- getUri() - Method in class org.jvoicexml.event.plain.jvxml.GotoNextDocumentEvent
-
Retrieves the URI of the next document.
- getURI() - Method in interface org.jvoicexml.GrammarDocument
-
Retrieves the URI of the source grammar.
- getUri() - Method in class org.jvoicexml.implementation.BinaryGrammar
-
Retrieves the URI of the grammar.
- getURI() - Method in class org.jvoicexml.implementation.DocumentGrammarImplementation
-
Retrieves the URI of the grammar.
- getURI() - Method in interface org.jvoicexml.implementation.grammar.GrammarEvaluator
-
Retrieves the base URI of this grammar.
- getURI() - Method in interface org.jvoicexml.implementation.GrammarImplementation
-
Retrieves the URI of the grammar.
- getURI() - Method in class org.jvoicexml.implementation.NuanceDynagramBinaryGrammarImplementation
-
Retrieves the URI of the grammar.
- getURI() - Method in class org.jvoicexml.implementation.SrgsXmlGrammarImplementation
-
Retrieves the URI of the grammar.
- getUri() - Method in class org.jvoicexml.interpreter.datamodel.ConnectionLocal
-
Retrieves the URI.
- getUri() - Method in class org.jvoicexml.interpreter.datamodel.ConnectionRemote
-
Retrieves the URI.
- getURI() - Method in class org.jvoicexml.interpreter.grammar.InternalGrammarDocument
-
Retrieves the URI of the source grammar.
- getUriObject() - Method in class org.jvoicexml.callmanager.ConfiguredApplication
-
Retrieves the URI of the application to call.
- getUserInput() - Method in interface org.jvoicexml.ConnectionInformation
-
Retrieves a unique identifier for the
UserInput to use.
- getUserInput() - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatform
-
Retrieves the user input device.
- getUserInput() - Method in interface org.jvoicexml.ImplementationPlatform
-
Retrieves the user input device.
- getUtterance() - Method in class org.jvoicexml.interpreter.formitem.TransferShadowVarContainer
-
Gets the current utterance.
- getUtterance() - Method in class org.jvoicexml.LastResult
-
Retrieves the utterance.
- getUtterance() - Method in interface org.jvoicexml.RecognitionResult
-
Retrieves the result as a single string.
- getValue() - Method in class org.jvoicexml.interpreter.datamodel.KeyValuePair
-
Retrieves the value.
- getVariables() - Method in class org.jvoicexml.documentserver.VariableEncoder
-
Gets the currently defined variables and their values.
- getVariables() - Method in class org.jvoicexml.event.plain.jvxml.InternalExitEvent
-
Retrieves the variable names to be passed to the interpreter context.
- getVariables() - Method in class org.jvoicexml.event.plain.jvxml.ReturnEvent
-
Retrieves the variable names to be passed to the interpreter context.
- getVersion() - Method in class org.jvoicexml.interpreter.datamodel.ConnectionProtocol
-
Retrieves the version attribute.
- getVersion() - Method in interface org.jvoicexml.JVoiceXml
-
Retrieves the version information of JVoiceXml.
- getVersion() - Method in class org.jvoicexml.JVoiceXmlMain
-
Retrieves the version information of JVoiceXml.
- getVoiceXmlInterpreterContext() - Method in class org.jvoicexml.interpreter.FormInterpretationAlgorithm
-
Retrieves the current VoiceXmlInterpreterContext.
- getVoiceXmlInterpreterContext() - Method in class org.jvoicexml.interpreter.JVoiceXmlSession
-
Retrieve the VoiceXmlInterpreterContext related to this
session.
- getWords() - Method in interface org.jvoicexml.RecognitionResult
-
- getWordsConfidence() - Method in interface org.jvoicexml.RecognitionResult
-
Retrieves the vector with the confidence level of each word for this
interpretation from 0.0 - 1.0.
- getXmlBase() - Method in interface org.jvoicexml.Application
-
Retrieves the base URI.
- getXmlBase() - Method in class org.jvoicexml.interpreter.JVoiceXmlApplication
-
Retrieves the base URI.
- GotoNextDocumentEvent - Class in org.jvoicexml.event.plain.jvxml
-
The FIA processed a <goto> event.
- GotoNextDocumentEvent(URI, VoiceXmlDocument) - Constructor for class org.jvoicexml.event.plain.jvxml.GotoNextDocumentEvent
-
Constructs a new object.
- GotoNextFormEvent - Class in org.jvoicexml.event.plain.jvxml
-
The FIA processed a <goto> event to another form.
- GotoNextFormEvent(String) - Constructor for class org.jvoicexml.event.plain.jvxml.GotoNextFormEvent
-
Construct a new object.
- GotoNextFormItemEvent - Class in org.jvoicexml.event.plain.jvxml
-
The FIA processed a <goto> event to another form item.
- GotoNextFormItemEvent(String) - Constructor for class org.jvoicexml.event.plain.jvxml.GotoNextFormItemEvent
-
Construct a new object.
- GrammarCache - Class in org.jvoicexml.implementation.grammar
-
The grammars that have been processed by the grammar processor.
- GrammarCache() - Constructor for class org.jvoicexml.implementation.grammar.GrammarCache
-
Constructs a new object.
- GrammarContainer - Interface in org.jvoicexml.interpreter
-
An input item that can have nested grammar tags.
- GrammarCreator - Interface in org.jvoicexml.documentserver.schemestrategy.builtin
-
A creator for a built-in grammar.
- GrammarDocument - Interface in org.jvoicexml
-
- GrammarEvaluator - Interface in org.jvoicexml.implementation.grammar
-
A grammar evaluator processes a given utterance into a recognition result.
- GrammarIdentifier - Interface in org.jvoicexml.interpreter.grammar
-
The GrammarIdentifier interface declares
a couple of methods to identify a certain grammar document.
- GrammarIdentifierCentral - Class in org.jvoicexml.interpreter.grammar
-
The GrammarIdentifierCentral takes control over the
process of identifying a grammar.
- GrammarIdentifierCentral() - Constructor for class org.jvoicexml.interpreter.grammar.GrammarIdentifierCentral
-
Constructs a new object.
- GrammarImplementation<T> - Interface in org.jvoicexml.implementation
-
Implementation of a grammar that is accessed by the VoiceXML interpreter and
passed to the
ImplementationPlatform if the grammar is
activated or deactivated.
- GrammarManager - Interface in org.jvoicexml.implementation.grammar
-
- GrammarParser<T> - Interface in org.jvoicexml.implementation.grammar
-
A grammar processor is able to parse any
GrammarDocument into
something that can be evaluated later to retrieve semantic interpretation
from a given utterance .
- GrammarProcessor - Interface in org.jvoicexml.interpreter
-
The GrammarProcessor is the main entry point for
grammar processing.
- GslGrammarIdentifier - Class in org.jvoicexml.interpreter.grammar.identifier
-
Grammar identifier for Nuance GSL grammars.
- GslGrammarIdentifier() - Constructor for class org.jvoicexml.interpreter.grammar.identifier.GslGrammarIdentifier
-
- identify(GrammarDocument) - Method in interface org.jvoicexml.interpreter.grammar.GrammarIdentifier
-
Identifies the grammar specified by grammar.
- identify(GrammarDocument) - Method in class org.jvoicexml.interpreter.grammar.identifier.GslGrammarIdentifier
-
Identifies the grammar specified by grammar.
- identify(GrammarDocument) - Method in class org.jvoicexml.interpreter.grammar.identifier.JsgfGrammarIdentifier
-
Identifies the grammar specified by grammar.
- identify(GrammarDocument) - Method in class org.jvoicexml.interpreter.grammar.identifier.NuanceDynagramBinaryGrammarIdentifier
-
Identifies the grammar specified by grammar.
- identify(GrammarDocument) - Method in class org.jvoicexml.interpreter.grammar.identifier.SrgsAbnfGrammarIdentifier
-
Identifies the grammar specified by grammar.
- identify(GrammarDocument) - Method in class org.jvoicexml.interpreter.grammar.identifier.SrgsXmlGrammarIdentifier
-
Identifies the grammar specified by grammar.
- identifyGrammar(GrammarDocument, GrammarType) - Method in class org.jvoicexml.interpreter.grammar.GrammarIdentifierCentral
-
Identifies the given grammar.
- ImplementationPlatform - Interface in org.jvoicexml
-
The implementation platform is controlled by the VoiceXML
interpreter context and by the VoiceXML interpreter.
- ImplementationPlatformFactory - Interface in org.jvoicexml
-
- incrementEventCounter(JVoiceXMLEvent) - Method in interface org.jvoicexml.interpreter.EventCountable
-
Increment counters for all events that have the same name as the
given event or have a name that is a prefix of the given event.
- incrementEventCounter(JVoiceXMLEvent) - Method in class org.jvoicexml.interpreter.formitem.InitialFormItem
-
Increment counters for all events that have the same name as the given
event or have a name that is a prefix of the given event.
- incrementPromptCount() - Method in class org.jvoicexml.interpreter.formitem.InitialFormItem
-
Increments the prompt counter.
- incrementPromptCount() - Method in interface org.jvoicexml.interpreter.PromptCountable
-
Increments the prompt counter.
- init(Configuration) - Method in interface org.jvoicexml.Configurable
-
Initializes this component with data from the given configuration object.
- init(Configuration) - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatform
-
Initializes this component with data from the given configuration object.
- init(Configuration) - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatformFactory
-
Initializes this component with data from the given configuration object.
- init(DataModel) - Method in class org.jvoicexml.interpreter.formitem.BlockFormItem
-
Initializes this form item.
- init(DataModel) - Method in interface org.jvoicexml.interpreter.FormItem
-
Initializes this form item.
- init(DataModel) - Method in class org.jvoicexml.interpreter.formitem.InitialFormItem
-
Initializes this form item.
- init(Configuration) - Method in class org.jvoicexml.interpreter.grammar.JVoiceXmlGrammarProcessor
-
Initializes this component with data from the given configuration object.
- InitialFormItem - Class in org.jvoicexml.interpreter.formitem
-
This element controls the initial interaction in a mixed initiative form.
- InitialFormItem() - Constructor for class org.jvoicexml.interpreter.formitem.InitialFormItem
-
Constructs a new object as a template.
- InitialFormItem(VoiceXmlInterpreterContext, VoiceXmlNode) - Constructor for class org.jvoicexml.interpreter.formitem.InitialFormItem
-
Create a new initial form item.
- initialize(Profile, Map<String, Object>) - Method in class org.jvoicexml.interpreter.FormInterpretationAlgorithm
-
Implementation of the initialization phase.
- initialize(VoiceXmlInterpreterContext) - Method in interface org.jvoicexml.profile.Profile
-
Initialized this profile once a session is created.
- INPUT_STARTED - Static variable in class org.jvoicexml.event.plain.implementation.SpokenInputEvent
-
The user has started to speak.
- InputDevice - Interface in org.jvoicexml.implementation
-
An input device for spoken or character input.
- inputError(ErrorEvent) - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatform
-
An error occured while an output processes an input.
- inputError(ErrorEvent) - Method in interface org.jvoicexml.implementation.SpokenInputListener
-
An error occured while an output processes an input.
- InputEvent - Interface in org.jvoicexml.event.plain.jvxml
-
Basic methods for all events that propagate input events.
- InputItem - Interface in org.jvoicexml.interpreter
-
Implementation of a input item.
- InputStartedEvent - Class in org.jvoicexml.event.plain.implementation
-
Notification that the the user started to speak.
- InputStartedEvent(SpokenInput, String, ModeType) - Constructor for class org.jvoicexml.event.plain.implementation.InputStartedEvent
-
Constructs a new event with the event type as its detail message.
- inputStatusChanged(SpokenInputEvent) - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatform
-
- inputStatusChanged(SpokenInputEvent) - Method in interface org.jvoicexml.implementation.SpokenInputListener
-
- InternalExitEvent - Class in org.jvoicexml.event.plain.jvxml
-
The FIA processed a <exit> event.
- InternalExitEvent(Object) - Constructor for class org.jvoicexml.event.plain.jvxml.InternalExitEvent
-
Constructs a new object with the given return value.
- InternalExitEvent(Map<String, Object>) - Constructor for class org.jvoicexml.event.plain.jvxml.InternalExitEvent
-
Constructs a new object with the given namelist as return value.
- InternalGrammarDocument - Class in org.jvoicexml.interpreter.grammar
-
- InternalGrammarDocument(Grammar) - Constructor for class org.jvoicexml.interpreter.grammar.InternalGrammarDocument
-
Constructs a new object from a grammar node.
- InterpreterState - Enum in org.jvoicexml.interpreter
-
A VoiceXML interpreter is at all times in one of two states:
waiting for input in an input item (such as
<field>, <record>, or
<transfer>), or
transitioning between input items in response to an input (including
spoken utterances, dtmf key presses, and input-related events such as a
noinput or nomatch event) received while in the waiting state.
- InterpreterState - Enum in org.jvoicexml
-
States of JVoiceXML that are passed throughout the lifecycle.
- isAccepted(RecognitionResult) - Method in class org.jvoicexml.implementation.dtmf.BufferedDtmfInput
-
Checks if one of the active grammars accepts the current recognition
result.
- isAccepted() - Method in interface org.jvoicexml.RecognitionResult
-
Checks if this result is accepted.
- isActive() - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupport
-
Checks if this instance can actively be used to play back output or
record input.
- isActive() - Method in interface org.jvoicexml.implementation.Telephony
-
Checks if this instance can actively be used to play back output or
record input.
- isActive() - Method in interface org.jvoicexml.interpreter.EventStrategy
-
Checks if this event strategy is active by evaluating the
cond attribute of the corresponding catch node and
special enabling conditions.
- isAscii() - Method in class org.jvoicexml.documentserver.ExternalGrammarDocument
-
Checks if the underlying document is an ASCII document.
- isAscii() - Method in class org.jvoicexml.documentserver.ExternalReferenceGrammarDocument
-
Checks if the underlying document is an ASCII document.
- isAscii() - Method in class org.jvoicexml.documentserver.ReadBuffer
-
Checks if the contents of the read buffer was plain text.
- isAscii() - Method in interface org.jvoicexml.GrammarDocument
-
Checks if the underlying document is an ASCII document.
- isAscii() - Method in class org.jvoicexml.interpreter.grammar.InternalGrammarDocument
-
Checks if the underlying document is an ASCII document.
- isBargeInEnabled(BargeInType) - Method in class org.jvoicexml.SpeakableSsmlText
-
Checks is barge-in is enabled for this speakable and the given bargein
type.
- isBargeInEnabled(BargeInType) - Method in interface org.jvoicexml.SpeakableText
-
Checks is barge-in is enabled for this speakable and the given bargein
type.
- isBridged() - Method in class org.jvoicexml.interpreter.formitem.TransferFormItem
-
Checks if the requested transfer is a bridge transfer.
- isBusy() - Method in class org.jvoicexml.implementation.dtmf.BufferedDtmfInput
-
Checks if this device is busy.
- isBusy() - Method in interface org.jvoicexml.implementation.ExternalResource
-
Checks if this device is busy.
- isBusy() - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupport
-
Checks if this device is busy.
- isBusy() - Method in interface org.jvoicexml.implementation.OutputDevice
-
Checks if this device is busy with output.
- isCacheable() - Method in class org.jvoicexml.documentserver.ExternalGrammarDocument
-
Checks, if this grammar document can be cached or should be retrieved
anew.
- isCacheable() - Method in class org.jvoicexml.documentserver.ExternalReferenceGrammarDocument
-
Checks, if this grammar document can be cached or should be retrieved
anew.
- isCacheable() - Method in interface org.jvoicexml.GrammarDocument
-
Checks, if this grammar document can be cached or should be retrieved
anew.
- isCacheable() - Method in class org.jvoicexml.interpreter.grammar.InternalGrammarDocument
-
Checks, if this grammar document can be cached or should be retrieved
anew.
- isCallActive() - Method in interface org.jvoicexml.CallControl
-
Checks if the call is currently active and outputs can be sent and inputs
can be retrieved.
- isConnected(Terminal) - Method in class org.jvoicexml.callmanager.BaseCallManager
-
Checks if the given terminal is connected.
- isEmpty() - Method in class org.jvoicexml.interpreter.scope.ScopedCollection
- isEmpty() - Method in class org.jvoicexml.interpreter.scope.ScopedMap
-
Returns true if this map contains no key-value mappings.
- isEmpty() - Method in class org.jvoicexml.interpreter.scope.ScopedSet
- isFetchintPrefetch() - Method in class org.jvoicexml.FetchAttributes
-
- isFetchintSafe() - Method in class org.jvoicexml.FetchAttributes
-
- isForceLoad() - Method in class org.jvoicexml.DocumentDescriptor
-
Checks if the document has to be retrieved although the document is in
the cache.
- isInFinalProcessingState() - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreter
-
Checks, if the interpreter is in the final processing state.
- isJustFilled(InputItem) - Method in class org.jvoicexml.interpreter.FormInterpretationAlgorithm
-
Checks, if the just_filled flag is set for the given input
item.
- isLoaded(URI) - Method in interface org.jvoicexml.Application
-
Checks, if the document with the given uri is loaded.
- isLoaded(URI) - Method in class org.jvoicexml.interpreter.JVoiceXmlApplication
-
Checks, if the document with the given uri is loaded.
- isModal() - Method in class org.jvoicexml.interpreter.formitem.BlockFormItem
-
Checks if this form item is modal.
- isModal() - Method in class org.jvoicexml.interpreter.formitem.FieldFormItem
-
Checks if this form item is modal.
- isModal() - Method in class org.jvoicexml.interpreter.formitem.InitialFormItem
-
Checks if this form item is modal.
- isModal() - Method in interface org.jvoicexml.interpreter.FormItem
-
Checks if this form item is modal.
- isModal() - Method in class org.jvoicexml.interpreter.formitem.ObjectFormItem
-
Checks if this form item is modal.
- isModal() - Method in class org.jvoicexml.interpreter.formitem.RecordFormItem
-
Checks if this form item is modal.
- isModal() - Method in class org.jvoicexml.interpreter.formitem.SubdialogFormItem
-
Checks if this form item is modal.
- isModal() - Method in class org.jvoicexml.interpreter.formitem.TransferFormItem
-
Checks if this form item is modal.
- isQueuingPrompts() - Method in class org.jvoicexml.interpreter.FormInterpretationAlgorithm
-
Checks if the FIA is currently queuing prompts.
- isSelectable() - Method in interface org.jvoicexml.interpreter.FormItem
-
Guard conditions, which governs whether or not this form item can be
selected by the form interpretation algorithm.
- isSpeakableTextEmpty() - Method in class org.jvoicexml.SpeakableSsmlText
-
Checks if this speakable contains any text to be passed to the
TTS engine.
- isSpeakableTextEmpty() - Method in interface org.jvoicexml.SpeakableText
-
Checks if this speakable contains any text to be passed to the
TTS engine.
- isType(String) - Method in class org.jvoicexml.event.JVoiceXMLEvent
-
Checks if the type of this event matches the given type.
- isUserInputActive() - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatform
-
Checks, if there is an acquired user input device.
- isUserInputActive() - Method in interface org.jvoicexml.ImplementationPlatform
-
Checks, if there is an acquired user input device.
- iterator() - Method in class org.jvoicexml.interpreter.scope.ScopedCollection
- iterator() - Method in class org.jvoicexml.interpreter.scope.ScopedSet
- SCHEME_NAME - Static variable in class org.jvoicexml.documentserver.schemestrategy.builtin.BuiltinSchemeStrategy
-
Scheme for which this scheme strategy is responsible.
- SCHEME_NAME - Static variable in class org.jvoicexml.documentserver.schemestrategy.FileSchemeStrategy
-
Scheme for which this scheme strategy is responsible.
- SCHEME_NAME - Static variable in class org.jvoicexml.documentserver.schemestrategy.MappedDocumentStrategy
-
Scheme for which this scheme strategy is responsible.
- SchemeStrategy - Interface in org.jvoicexml.documentserver
-
Strategy to get a VoiceXML document from a repository for a given URI scheme.
- Scope - Enum in org.jvoicexml.interpreter.scope
-
Scope.
- ScopedCollection<E> - Class in org.jvoicexml.interpreter.scope
-
A simple Collection which is scope aware.
- ScopedCollection(ScopeObserver) - Constructor for class org.jvoicexml.interpreter.scope.ScopedCollection
-
Constructs a new object.
- ScopedMap<K,V> - Class in org.jvoicexml.interpreter.scope
-
A simple Map which is scope aware.
- ScopedMap(ScopeObserver) - Constructor for class org.jvoicexml.interpreter.scope.ScopedMap
-
Constructs a new object.
- ScopedSet<E> - Class in org.jvoicexml.interpreter.scope
-
A simple Set which is scope aware.
- ScopedSet(ScopeObserver) - Constructor for class org.jvoicexml.interpreter.scope.ScopedSet
-
Constructs a new object.
- scopedSetChange(ScopedSet<GrammarDocument>, Collection<GrammarDocument>) - Method in class org.jvoicexml.interpreter.ActiveGrammarSet
-
The given set changed due to a scope change.
- scopedSetChange(ScopedSet<E>, Collection<E>) - Method in interface org.jvoicexml.interpreter.scope.ScopedSetObserver
-
The given set changed due to a scope change.
- ScopedSetObserver<E> - Interface in org.jvoicexml.interpreter.scope
-
An observer for scope related changes to a
ScopedSet.
- ScopeObserver - Class in org.jvoicexml.interpreter.scope
-
Central that gets notified about scope changes.
- ScopeObserver() - Constructor for class org.jvoicexml.interpreter.scope.ScopeObserver
-
Constructs a new object.
- ScopePublisher - Interface in org.jvoicexml.interpreter.scope
-
A publisher to propagate
Scope changes.
- ScopeSubscriber - Interface in org.jvoicexml.interpreter.scope
-
A listener for scope changes.
- SemanticError - Class in org.jvoicexml.event.error
-
A run-time error was found in the VoiceXML document, e.g. substring bounds
error, or an undefined variable was referenced.
- SemanticError() - Constructor for class org.jvoicexml.event.error.SemanticError
-
Constructs a new event with the event type as its detail message.
- SemanticError(String) - Constructor for class org.jvoicexml.event.error.SemanticError
-
Constructs a new event with the specified detail message. the given
detail message is expanded to the form
<EVENT_TYPE>: <message>.
- SemanticError(Throwable) - Constructor for class org.jvoicexml.event.error.SemanticError
-
Constructs a new event with the specified cause and a detail message of
(cause==null ?
- SemanticError(String, Throwable) - Constructor for class org.jvoicexml.event.error.SemanticError
-
Constructs a new event with the specified detail message and cause.
- serialize(DataModel, String, Object) - Method in interface org.jvoicexml.interpreter.datamodel.DataModelObjectSerializer
-
Serializes the given
Object that has been retrieved from the
DataModel.
- Session - Interface in org.jvoicexml
-
A session begins when the user starts to interact with a VoiceXML interpreter
context, continues as documents are loaded and processed, and ends when
requested by the user, a document, or the interpreter context.
- SESSION_STORAGE - Static variable in class org.jvoicexml.documentserver.schemestrategy.HttpSchemeStrategy
-
the storage of session identifiers.
- sessionClosed(String) - Method in class org.jvoicexml.documentserver.JVoiceXmlDocumentServer
-
Notification that the given session is closed.
- sessionClosed(String) - Method in class org.jvoicexml.documentserver.schemestrategy.builtin.BuiltinSchemeStrategy
-
Notification that the given session is closed.
- sessionClosed(String) - Method in class org.jvoicexml.documentserver.schemestrategy.FileSchemeStrategy
-
Notification that the given session is closed.
- sessionClosed(String) - Method in class org.jvoicexml.documentserver.schemestrategy.HttpSchemeStrategy
-
Notification that the given session is closed.
- sessionClosed(String) - Method in class org.jvoicexml.documentserver.schemestrategy.MappedDocumentStrategy
-
Notification that the given session is closed.
- sessionClosed(String) - Method in interface org.jvoicexml.documentserver.SchemeStrategy
-
Notification that the given session is closed.
- sessionClosed(String) - Method in interface org.jvoicexml.DocumentServer
-
Notification that the given session is closed.
- sessionEnded(Session) - Method in interface org.jvoicexml.interpreter.DetailedSessionListener
-
The session has ended.
- sessionEnded(Session) - Method in interface org.jvoicexml.SessionListener
-
Notification that the session has ended.
- sessionEvent(Session, JVoiceXMLEvent) - Method in interface org.jvoicexml.interpreter.DetailedSessionListener
-
- SessionIdentifierFactory<T> - Interface in org.jvoicexml.documentserver.schemestrategy
-
- SessionListener - Interface in org.jvoicexml
-
- sessionStarted(Session) - Method in interface org.jvoicexml.interpreter.DetailedSessionListener
-
The session has started.
- sessionStarted(Session) - Method in interface org.jvoicexml.SessionListener
-
Notification that the session has been started.
- SessionStorage<T> - Class in org.jvoicexml.documentserver.schemestrategy
-
Container that associates a JVoiceXML session to a custom strategy object,
Identifying the session with the repository.
- SessionStorage(SessionIdentifierFactory<T>) - Constructor for class org.jvoicexml.documentserver.schemestrategy.SessionStorage
-
Constructs a new object.
- setAccept(AcceptType) - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Sets the accept type.
- setAcceptedInputs(Collection<String>) - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Set the accepted inputs of the grammar.
- setApplication(Application) - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Sets the current application.
- setApplications(Collection<ConfiguredApplication>) - Method in class org.jvoicexml.callmanager.BaseCallManager
-
Adds the given list of applications.
- setAttributes(FetchAttributes) - Method in class org.jvoicexml.DocumentDescriptor
-
Sets the fetch attributes.
- setCalledId(URI) - Method in class org.jvoicexml.callmanager.CallParameters
-
Sets the called id.
- setCallerId(URI) - Method in class org.jvoicexml.callmanager.CallParameters
-
Sets the caller id.
- setCallManager(Collection<CallManager>) - Method in class org.jvoicexml.JVoiceXmlMain
-
Set the call managers to use.
- setChoiceConverter(ChoiceConverter) - Method in class org.jvoicexml.interpreter.dialog.ExecutableMenuForm
-
Sets the choice converter to use.
- setCompletetimeout(String) - Method in class org.jvoicexml.SpeechRecognizerProperties
-
Sets the length of silence required following user speech before the
speech recognizer finalizes a result.
- setConfidencelevel(float) - Method in class org.jvoicexml.SpeechRecognizerProperties
-
Sets the confidence level.
- setConnectionInformationFactory(TerminalConnectionInformationFactory) - Method in class org.jvoicexml.callmanager.BaseCallManager
-
Sets the connection information factory.
- setDialogs(Map<String, Dialog>) - Method in class org.jvoicexml.interpreter.dialog.JVoiceXmlDialogFactory
-
Adds the given mappings of dialogs to tag names.
- setDocument(GrammarDocument) - Method in class org.jvoicexml.implementation.grammar.LoadedGrammar
-
Sets the grammar document.
- setDocumentStorage(DocumentStorage) - Method in class org.jvoicexml.documentserver.JVoiceXmlDocumentServer
-
Sets the document storage
- setDtmf(String) - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Sets the DTMF sequence that is set in the choice node.
- setDuration(long) - Method in class org.jvoicexml.interpreter.formitem.TransferShadowVarContainer
-
Sets the duration.
- setEnhancedProperties(Map<String, String>) - Method in class org.jvoicexml.CallControlProperties
-
May be used to set custom properties if this class is extended.
- setEnhancedProperties(Map<String, String>) - Method in class org.jvoicexml.DtmfRecognizerProperties
-
May be used to set custom properties if this class is extended.
- setEnhancedProperties(Map<String, String>) - Method in class org.jvoicexml.SpeechRecognizerProperties
-
May be used to set custom properties if this class is extended.
- setEvent(JVoiceXMLEvent) - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Sets the event to be thrown instead of a next.
- setEventBus(EventBus) - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatform
-
Sets the event bus to communicate events back to the interpreter.
- setEventBus(EventBus) - Method in interface org.jvoicexml.ImplementationPlatform
-
Sets the event bus to communicate events back to the interpreter.
- setFetchAttributes(FetchAttributes) - Method in class org.jvoicexml.documentserver.JVoiceXmlDocumentServer
-
Sets the default fetch attributes.
- setFetchAudio(URI) - Method in class org.jvoicexml.FetchAttributes
-
Set the fetchAudio attribute.
- setFetchHint(String) - Method in class org.jvoicexml.FetchAttributes
-
Retrieve the fetchhint attribute.
- setFetchTimeout(int) - Method in class org.jvoicexml.documentserver.schemestrategy.HttpSchemeStrategy
-
Sets the default fetch timeout.
- setFetchTimeout(long) - Method in class org.jvoicexml.FetchAttributes
-
Retrieve the fetchtimeout attribute.
- setFormItemVariable(RecognitionResult) - Method in class org.jvoicexml.interpreter.formitem.FieldFormItem
-
Sets the form item variable with values from the given recognition
result.
- setFormItemVariable(String) - Method in class org.jvoicexml.interpreter.formitem.FieldFormItem
-
Sets the form item variable with values from the given utterance.
- setFormItemVariable(Object) - Method in class org.jvoicexml.interpreter.formitem.FieldFormItem
-
Sets the value of the form item variable.
- setFormItemVariable(Object) - Method in interface org.jvoicexml.interpreter.FormItem
-
Sets the value of the form item variable.
- setGrammar(Grammar) - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Sets the grammar object.
- setGrammarCreators(Collection<GrammarCreator>) - Method in class org.jvoicexml.documentserver.jetty.BuiltinGrammarHandler
-
Adds the specified grammar creators to the list of known grammar
creators.
- setGrammarCreators(Collection<GrammarCreator>) - Method in class org.jvoicexml.documentserver.jetty.DocumentStorage
-
Adds the specified grammar creators to the list of known grammar
creators.
- setGrammarCreators(Collection<GrammarCreator>) - Method in class org.jvoicexml.documentserver.schemestrategy.builtin.BuiltinSchemeStrategy
-
Adds the specified grammar creators to the list of known grammar
creators.
- setGrammaridentifier(GrammarIdentifierCentral) - Method in class org.jvoicexml.interpreter.grammar.JVoiceXmlGrammarProcessor
-
Sets the central to identify grammars.
- setGrammarParsers(List<GrammarParser<?>>) - Method in class org.jvoicexml.implementation.dtmf.BufferedDtmfInput
-
Sets the grammar parsers to use.
- setGrammarProcessor(GrammarProcessor) - Method in class org.jvoicexml.JVoiceXmlMain
-
Sets the grammar processor.
- setIdentifier(List<GrammarIdentifier>) - Method in class org.jvoicexml.interpreter.grammar.GrammarIdentifierCentral
-
Adds the given list of idententifiers.
- setImplementation(GrammarImplementation<?>) - Method in class org.jvoicexml.implementation.grammar.LoadedGrammar
-
Sets the grammar implementation.
- setImplementationPlatformFactory(ImplementationPlatformFactory) - Method in class org.jvoicexml.JVoiceXmlMain
-
Sets the implementation platform factory.
- setIncompletetimeout(String) - Method in class org.jvoicexml.SpeechRecognizerProperties
-
Sets the required length of silence following user speech after
which a recognizer finalizes a result.
- setInputmode(String) - Method in class org.jvoicexml.interpreter.formitem.TransferShadowVarContainer
-
Sets the current inputmode.
- setInputResult(Object) - Method in class org.jvoicexml.event.plain.jvxml.RecordingEvent
-
Sets the input result.
- setInputStream(InputStream) - Method in interface org.jvoicexml.implementation.AudioSink
-
Sets the stream to send audio data.
- setInputType(String) - Method in class org.jvoicexml.callmanager.ConfiguredApplication
-
Sets the input type of this application.
- setInstances(int) - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupportFactory
-
Sets the number of instances that this factory will create.
- setInterdigittimeout(String) - Method in class org.jvoicexml.DtmfRecognizerProperties
-
Sets the inter-digit timeout value to use when recognizing DTMF
input.
- setJustFilled(InputItem) - Method in class org.jvoicexml.interpreter.FormInterpretationAlgorithm
-
Sets the just_filled flag for the given input item.
- setJVoiceXml(JVoiceXml) - Method in class org.jvoicexml.callmanager.BaseCallManager
-
Sets a reference to JVoiceXml.
- setJVoiceXml(JVoiceXml) - Method in interface org.jvoicexml.CallManager
-
Sets a reference to JVoiceXml.
- setJVoiceXml(JVoiceXml) - Method in interface org.jvoicexml.JndiSupport
-
Sets the reference to the interpreter.
- setLastResult(List<LastResult>) - Method in interface org.jvoicexml.Application
-
Sets the last result.
- setLastResult(List<LastResult>) - Method in class org.jvoicexml.interpreter.JVoiceXmlApplication
-
Sets the last result.
- setLocalCallerDevice(URI) - Method in class org.jvoicexml.interpreter.datamodel.Connection
-
Sets the remote caller device.
- setLocalProperty(String, String) - Method in class org.jvoicexml.interpreter.FormInterpretationAlgorithm
-
Sets the property with the given name to the given value.
- setMark(String) - Method in interface org.jvoicexml.RecognitionResult
-
Sets the mark reached that is reached while playing back an SSML
formatted document.
- setMaxage(long) - Method in class org.jvoicexml.FetchAttributes
-
Retrieve the maxage attribute.
- setMaxspeechtimeout(String) - Method in class org.jvoicexml.SpeechRecognizerProperties
-
/* Sets the maximum duration of user speech.
- setMaxstale(long) - Method in class org.jvoicexml.FetchAttributes
-
Retrieve the maxstale attribute.
- setMediaType(GrammarType) - Method in class org.jvoicexml.documentserver.ExternalGrammarDocument
-
Sets the media type of this document.
- setMediaType(GrammarType) - Method in class org.jvoicexml.documentserver.ExternalReferenceGrammarDocument
-
Sets the media type of this document.
- setMediaType(GrammarType) - Method in interface org.jvoicexml.GrammarDocument
-
Sets the media type of this document.
- setMediaType(GrammarType) - Method in class org.jvoicexml.interpreter.grammar.InternalGrammarDocument
-
Sets the media type of this document.
- setMode(ModeType) - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Retrieves the mode type.
- setModeType(ModeType) - Method in class org.jvoicexml.documentserver.ExternalGrammarDocument
-
Sets the mode type.
- setModeType(ModeType) - Method in class org.jvoicexml.documentserver.ExternalReferenceGrammarDocument
-
Sets the mode type.
- setModeType(ModeType) - Method in interface org.jvoicexml.GrammarDocument
-
Sets the mode type.
- setModeType(ModeType) - Method in class org.jvoicexml.interpreter.grammar.InternalGrammarDocument
-
Sets the mode type.
- setNext(URI) - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Sets the URI of next dialog or document.
- setNode(XmlNode) - Method in class org.jvoicexml.interpreter.dialog.ExecutableMenuForm
-
Associates the dialog with the given node.
- setNode(XmlNode) - Method in class org.jvoicexml.interpreter.dialog.ExecutablePlainForm
-
Associates the dialog with the given node.
- setNode(XmlNode) - Method in interface org.jvoicexml.interpreter.Dialog
-
Associates the dialog with the given node.
- setOptionConverter(OptionConverter) - Method in class org.jvoicexml.interpreter.formitem.FieldFormItem
-
Sets the option converter to use for the conversion of
<option tags into a grammar.
- setOutputStream(OutputStream) - Method in interface org.jvoicexml.implementation.AudioSource
-
Sets the stream to write audio data to.
- setOutputType(String) - Method in class org.jvoicexml.callmanager.ConfiguredApplication
-
Sets the output type of this application.
- setPromptTimeout(long) - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatform
-
Sets the default timeout to use.
- setPromptTimeout(long) - Method in interface org.jvoicexml.PromptAccumulator
-
Sets the default timeout to use.
- setProperties(Map<String, String>) - Method in class org.jvoicexml.CallControlProperties
-
Retrieves the call control recognizer properties from the given map.
- setProperties(Map<String, String>) - Method in class org.jvoicexml.DtmfRecognizerProperties
-
Retrieves the DTMF recognizer properties from the given map.
- setProperties(Map<String, String>) - Method in class org.jvoicexml.SpeechRecognizerProperties
-
Retrieves the speech recognizer properties from the given map.
- setProperty(String, String) - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreterContext
-
Sets the property with the given name to the given value.
- setRecordingAudioFormat(AudioFormat) - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupportFactory
-
Sets the audio format to use for recording.
- setRemoteCallerDevice(URI) - Method in class org.jvoicexml.interpreter.datamodel.Connection
-
Sets the remote caller device.
- setReprompt(boolean) - Method in class org.jvoicexml.interpreter.FormInterpretationAlgorithm
-
Set if the last loop iteration ended with a <catch>
that had no <reprompt>.
- setRootDocument(VoiceXmlDocument) - Method in interface org.jvoicexml.Application
-
Sets the new root document.
- setRootDocument(VoiceXmlDocument) - Method in class org.jvoicexml.interpreter.JVoiceXmlApplication
-
Sets the new root document.
- setScheme(String) - Method in class org.jvoicexml.documentserver.schemestrategy.HttpSchemeStrategy
-
Sets the scheme for this strategy.
- setSchemeStrategies(List<SchemeStrategy>) - Method in class org.jvoicexml.documentserver.JVoiceXmlDocumentServer
-
Adds the given list of strategies for schemes to the supported schemes.
- setSensitivity(float) - Method in class org.jvoicexml.SpeechRecognizerProperties
-
Sets the sensitivity.
- setSession(Session) - Method in class org.jvoicexml.implementation.jvxml.JVoiceXmlImplementationPlatform
-
Sets the current session.
- setSession(Session) - Method in interface org.jvoicexml.ImplementationPlatform
-
Sets the current session.
- setSpeedvsaccuracy(float) - Method in class org.jvoicexml.SpeechRecognizerProperties
-
Sets the hint specifying the desired balance between speed vs.
- setSpokeninput(ResourceFactory<SpokenInput>) - Method in class org.jvoicexml.implementation.Platform
-
Sets the spoken input implementation.
- setState(InterpreterState) - Method in class org.jvoicexml.interpreter.VoiceXmlInterpreter
-
Sets the interpreter state.
- setStoragePort(int) - Method in class org.jvoicexml.documentserver.jetty.DocumentStorage
-
Sets the storage port.
- setSynthesizedoutput(ResourceFactory<SynthesizedOutput>) - Method in class org.jvoicexml.implementation.Platform
-
Sets the synthesized output implementation.
- setTelephony(ResourceFactory<Telephony>) - Method in class org.jvoicexml.implementation.Platform
-
Sets the telephonyFactory implementation.
- setTermchar(char) - Method in class org.jvoicexml.DtmfRecognizerProperties
-
Sets the terminating DTMF character for DTMF input recognition.
- setTerminal(Terminal) - Method in class org.jvoicexml.callmanager.CallParameters
-
Sets the terminal.
- setTerminal(String) - Method in class org.jvoicexml.callmanager.ConfiguredApplication
-
Sets the name of the terminal.
- setTermtimeout(String) - Method in class org.jvoicexml.DtmfRecognizerProperties
-
Sets the terminating timeout to use when recognizing DTMF input.
- setText(String) - Method in class org.jvoicexml.interpreter.dialog.ConvertedChoiceOption
-
Sets the text that is contained in the choice node.
- setTimeout(long) - Method in class org.jvoicexml.SpeakableSsmlText
-
Sets the timeout that will be used for the following user input.
- setUri(String) - Method in class org.jvoicexml.callmanager.ConfiguredApplication
-
Sets the URI of the application to call.
- setURI(URI) - Method in class org.jvoicexml.DocumentDescriptor
-
Sets the URI of the document.
- setURI(URI) - Method in class org.jvoicexml.documentserver.ExternalGrammarDocument
-
Sets the URI of this grammar document.
- setURI(URI) - Method in class org.jvoicexml.documentserver.ExternalReferenceGrammarDocument
-
Sets the URI of this grammar document.
- setURI(URI) - Method in interface org.jvoicexml.GrammarDocument
-
Sets the URI of this grammar document.
- setURI(URI) - Method in class org.jvoicexml.interpreter.grammar.InternalGrammarDocument
-
Sets the URI of this grammar document.
- setUtterance(String) - Method in class org.jvoicexml.interpreter.formitem.TransferShadowVarContainer
-
Sets the utterance.
- setVisited() - Method in class org.jvoicexml.interpreter.formitem.BlockFormItem
-
Mark this form item visited by setting the form item variable to
true.
- shutdown() - Method in interface org.jvoicexml.JndiSupport
-
Stops the service.
- shutdown() - Method in interface org.jvoicexml.JVoiceXml
-
Shuts down the interpreter and frees all resources.
- shutdown() - Method in class org.jvoicexml.JVoiceXmlMain
-
Shuts down the interpreter and frees all resources.
- shutdown() - Method in interface org.jvoicexml.startup.RemoteShutdown
-
Shutdown JVoiceXML.
- Shutdown - Class in org.jvoicexml.startup
-
Shutdown of the JVoiceXML browser using the configured JNDI implementation.
- size() - Method in class org.jvoicexml.implementation.grammar.GrammarCache
-
Retrieves the number of active grammars.
- size() - Method in class org.jvoicexml.interpreter.ActiveGrammarSet
-
Retrieves the number of active grammars.
- size() - Method in class org.jvoicexml.interpreter.scope.ScopedCollection
- size() - Method in class org.jvoicexml.interpreter.scope.ScopedMap
-
Returns the number of key-value mappings in this map.
- size() - Method in class org.jvoicexml.interpreter.scope.ScopedSet
- SpeakableSsmlText - Class in org.jvoicexml
-
Text to be passed to the TTS engine.
- SpeakableSsmlText(String, Locale) - Constructor for class org.jvoicexml.SpeakableSsmlText
-
Constructs a new object.
- SpeakableSsmlText(SsmlDocument) - Constructor for class org.jvoicexml.SpeakableSsmlText
-
Constructs a new object.
- SpeakableSsmlText(SsmlDocument, boolean, BargeInType) - Constructor for class org.jvoicexml.SpeakableSsmlText
-
Constructs a new object.
- SpeakableText - Interface in org.jvoicexml
-
Objects that implement this interface contain some text, that is
passed to the TTS engine.
- SpeechRecognizerProperties - Class in org.jvoicexml
-
- SpeechRecognizerProperties() - Constructor for class org.jvoicexml.SpeechRecognizerProperties
-
Constructs a new object.
- SpokenInput - Interface in org.jvoicexml.implementation
-
Facade for easy control and monitoring of the user's speech input as an
external resource.
- SpokenInputEvent - Class in org.jvoicexml.event.plain.implementation
-
- SpokenInputEvent(SpokenInput, String, String) - Constructor for class org.jvoicexml.event.plain.implementation.SpokenInputEvent
-
Constructs a new object.
- SpokenInputEvent(SpokenInput, String) - Constructor for class org.jvoicexml.event.plain.implementation.SpokenInputEvent
-
Constructs a new object.
- SpokenInputListener - Interface in org.jvoicexml.implementation
-
Listener for events from the
SpokenInput implementation.
- SpokenInputProvider - Interface in org.jvoicexml.implementation
-
Objects that implement this class have an association to a
SpokenInput device which can be retrieved by the corresponding
method.
- SrgsAbnfGrammarIdentifier - Class in org.jvoicexml.interpreter.grammar.identifier
-
This class implements the GrammarIdentifier interface.
- SrgsAbnfGrammarIdentifier() - Constructor for class org.jvoicexml.interpreter.grammar.identifier.SrgsAbnfGrammarIdentifier
-
- SrgsXmlChoiceConverter - Class in org.jvoicexml.interpreter.dialog
-
A <choice> converter for the SRGS XML grammar.
- SrgsXmlChoiceConverter() - Constructor for class org.jvoicexml.interpreter.dialog.SrgsXmlChoiceConverter
-
- SrgsXmlGrammarIdentifier - Class in org.jvoicexml.interpreter.grammar.identifier
-
This class implements the GrammarIdentifier interface.
- SrgsXmlGrammarIdentifier() - Constructor for class org.jvoicexml.interpreter.grammar.identifier.SrgsXmlGrammarIdentifier
-
- SrgsXmlGrammarImplementation - Class in org.jvoicexml.implementation
-
Implementation of a SRGS XML grammar.
- SrgsXmlGrammarImplementation(SrgsXmlDocument, URI) - Constructor for class org.jvoicexml.implementation.SrgsXmlGrammarImplementation
-
Constructs a new object.
- SrgsXmlOptionConverter - Class in org.jvoicexml.interpreter.formitem
-
An option converter for SRGS XML grammars.
- SrgsXmlOptionConverter() - Constructor for class org.jvoicexml.interpreter.formitem.SrgsXmlOptionConverter
-
- SsmlParser - Interface in org.jvoicexml.profile
-
Parser to transform the contents of a outputting nodes into an SSML document.
- SsmlParsingStrategy - Interface in org.jvoicexml.profile
-
Strategy to evaluate the contents of a VoiceXML tag within a
<prompt> tag into an SSML document that can be sent to the
speech synthesizer.
- SsmlParsingStrategyFactory - Interface in org.jvoicexml.profile
-
- start() - Method in class org.jvoicexml.callmanager.BaseCallManager
-
Starts the call manager asynchronously.
- start() - Method in interface org.jvoicexml.CallManager
-
Starts the call manager asynchronously.
- start() - Method in class org.jvoicexml.documentserver.jetty.DocumentStorage
-
Starts the document storage.
- start() - Method in class org.jvoicexml.documentserver.JVoiceXmlDocumentServer
-
Starts this document server.
- start() - Method in interface org.jvoicexml.DocumentServer
-
Starts this document server.
- startRecognition(DataModel, SpeechRecognizerProperties, DtmfRecognizerProperties) - Method in class org.jvoicexml.implementation.dtmf.BufferedDtmfInput
-
Detects and reports character and/or spoken input simultaneously.
- startRecognition(DataModel, SpeechRecognizerProperties, DtmfRecognizerProperties) - Method in interface org.jvoicexml.implementation.InputDevice
-
Detects and reports character and/or spoken input simultaneously.
- startRecognition(DataModel, Collection<ModeType>, SpeechRecognizerProperties, DtmfRecognizerProperties) - Method in interface org.jvoicexml.UserInput
-
Detects and reports character and/or spoken input simultaneously.
- startRecording(UserInput, OutputStream, CallControlProperties) - Method in interface org.jvoicexml.CallControl
-
Starts recording to the given output stream.
- startRecording(SpokenInput, OutputStream, CallControlProperties) - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupport
-
Starts recording to the given output stream.
- startRecording(SpokenInput, OutputStream, CallControlProperties) - Method in interface org.jvoicexml.implementation.Telephony
-
Starts recording to the given output stream.
- startup() - Method in interface org.jvoicexml.JndiSupport
-
Starts the service.
- Startup - Class in org.jvoicexml.startup
-
Startup the JVoiceXML voice browser.
- stop() - Method in class org.jvoicexml.callmanager.BaseCallManager
-
Stops the call manager and all terminals.
- stop() - Method in interface org.jvoicexml.CallManager
-
Stops the call manager and all terminals.
- stop() - Method in class org.jvoicexml.documentserver.jetty.DocumentStorage
-
Stops the storage.
- stop() - Method in class org.jvoicexml.documentserver.JVoiceXmlDocumentServer
-
- stop() - Method in interface org.jvoicexml.DocumentServer
-
Stops this document server.
- stopPlay() - Method in interface org.jvoicexml.CallControl
-
Stops a previously started play.
- stopPlay() - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupport
-
Stops a previously started play.
- stopPlay() - Method in interface org.jvoicexml.implementation.Telephony
-
Stops a previously started play.
- stopRecognition() - Method in class org.jvoicexml.implementation.dtmf.BufferedDtmfInput
-
Stops a previously started recognition.
- stopRecognition() - Method in interface org.jvoicexml.implementation.InputDevice
-
Stops a previously started recognition.
- stopRecognition(Collection<ModeType>) - Method in interface org.jvoicexml.UserInput
-
Stops a previously started recognition.
- stopRecord() - Method in interface org.jvoicexml.CallControl
-
Stops a previously started recording.
- stopRecording() - Method in class org.jvoicexml.implementation.jvxml.DesktopTelephonySupport
-
Stops a previously started recording, e.g. after a recognition process
has been stopped.
- stopRecording() - Method in interface org.jvoicexml.implementation.Telephony
-
Stops a previously started recording, e.g. after a recognition process
has been stopped.
- stopWaiting() - Method in interface org.jvoicexml.callmanager.Terminal
-
Stops waiting for incoming connections.
- storeAudio(AudioInputStream) - Method in class org.jvoicexml.documentserver.JVoiceXmlDocumentServer
-
Stores the audio from the given stream.
- storeAudio(AudioInputStream) - Method in interface org.jvoicexml.DocumentServer
-
Stores the audio from the given stream.
- SubdialogFormItem - Class in org.jvoicexml.interpreter.formitem
-
A <subdialog> input item is roughly like a function call.
- SubdialogFormItem() - Constructor for class org.jvoicexml.interpreter.formitem.SubdialogFormItem
-
Constructs a new object as a template.
- SubdialogFormItem(VoiceXmlInterpreterContext, VoiceXmlNode) - Constructor for class org.jvoicexml.interpreter.formitem.SubdialogFormItem
-
Create a new subdialog input item.
- SubdialogResultEvent - Class in org.jvoicexml.event.plain.jvxml
-
Result of an <subdialog> call..
- SubdialogResultEvent(Object) - Constructor for class org.jvoicexml.event.plain.jvxml.SubdialogResultEvent
-
Constructs a new object.
- SubmitEvent - Class in org.jvoicexml.event.plain.jvxml
-
The FIA processed a <submit> event.
- SubmitEvent(DocumentDescriptor) - Constructor for class org.jvoicexml.event.plain.jvxml.SubmitEvent
-
Constructs a new object.
- subscribe(String, EventSubscriber) - Method in class org.jvoicexml.event.EventBus
-
Subscribes the given subscriber for the given event type or subtypes.
- supportsBargeIn() - Method in interface org.jvoicexml.implementation.OutputDevice
-
Checks if this implementation platform supports barge-in.
- SynthesizedOutput - Interface in org.jvoicexml.implementation
-
Facade for easy access to the system output as an external resource.
- SynthesizedOutputEvent - Class in org.jvoicexml.event.plain.implementation
-
- SynthesizedOutputEvent(SynthesizedOutput, String, String) - Constructor for class org.jvoicexml.event.plain.implementation.SynthesizedOutputEvent
-
Constructs a new object.
- SynthesizedOutputListener - Interface in org.jvoicexml.implementation
-
- SynthesizedOutputProvider - Interface in org.jvoicexml.implementation
-
Objects that implement this class have an association to a
SynthesizedOutput device which can be retrieved by the corresponding
method
- SystemOutput - Interface in org.jvoicexml
-
Facade for easy access to the system output.