Package org.jvoicexml.xml.vxml

This package contains the classes to handle VoiceXML 2.0 and VoiceXML 2.1 documents and related tags.

See:
          Description

Class Summary
AbstractCatchElement The <catch> element associates a catch with a document, dialog, or form item (except for blocks).
Assign The <assign> element assigns a value to a variable: <assign name="flavor" expr="'chocolate'"/>
<assign name="document.mycost" expr="document.mycost+14"/>
It is illegal to make an assignment to a variable that has not been explicitly declared using a <var> element or a var statement within a <script>.
Block This element is a form item.
Catch The <catch> element associates a catch with a document, dialog, or form item (except for blocks).
Choice Define a menu item.
Clear The <clear> element resets one or more variables, including form items.
Data  
Disconnect Causes the interpreter context to disconnect from the user.
Else The <else> element is used for conditional logic.
Elseif The <elseif> element is used for conditional logic.
Enumerate Shorthand for enumerating the choices in a menu.
Error Catch an error event.
Exit Exit a session.
Field A <field> specifies an form input item to be gathered from the user.
Filled An action executed when fields are filled.
Foreach  
Form Forms are the key concept of VoiceXML documents.
Goto Go to another dialog in the same or different document.
Help Catch a help event.
If The <if> element is used for conditional logic.
Initial Declares initial logic upon entry into a (mixed initiative) form.
Link Specify a transition common to all dialogs in the link's scope.
Log Generate a debug message.
Menu A dialog for choosing amongst alternative destinations.
Meta Define a metadata item as a name/value pair.
Metadata Define metadata information using a metadata schema.
Noinput Catch a noinput event.
Nomatch Catch a nomatch event.
ObjectTag Interact with a custom extension.
Option Specify an option in a <field>.
Param The <param> element is used to specify values that are passed to <subdialog>s or <object>s.
Prompt A <prompt> element controls the output of synthesized speech and prerecorded audio.
Property Control implementation platform settings.
Record The <record> element is an input item that collects a recording from the user.
Reprompt Play a field prompt when a field is re-visited after an event.
Return <return> ends execution of a subdialog and returns control and data to a calling dialog.
Script Specify a block of ECMAScript client-side scripting logic.
Subdialog Invoke another dialog as a subdialog of the current one.
Submit Submit values to a document server.
Throw Throw an event.
Transfer Transfer the caller to another destination.
Value Insert the value of an expression in a prompt.
Var This element declares a variable.
VoiceXml20DocumentType The DOCTYPE of a VoiceXML 2.0 document.
VoiceXml21DocumentType The DOCTYPE of a VoiceXML 2.1 document.
VoiceXmlComment Implementation of a Comment node.
VoiceXmlDocument A VoiceXML 2.0 or VoiceXML 2.1 document according to the specification in specified at http://www.w3.org/TR/voicexml20/ and http://www.w3.org/TR/voicexml21/.
Vxml A VoiceXML document is primarily composed of top-level elements called dialogs.
 

Enum Summary
AcceptType Accept mode of a choice.
BargeInType When bargein is enabled, the bargeintype attribute can be used to suggest the type of bargein the platform will perform in response to voice or DTMF input.
FilledMode Filled mode of the <filled> tag.
ParamValueType Valuetype attribute of the <param> tag.
RequestMethod Type of the request method.
 

Package org.jvoicexml.xml.vxml Description

This package contains the classes to handle VoiceXML 2.0 and VoiceXML 2.1 documents and related tags.

VoiceXML 2.0 is specified at http://www.w3.org/TR/voicexml20/, VoiceXML 2.1 is specified at http://www.w3.org/TR/voicexml21/ as an extension to VoiceXML 2.0.

The document type of VoiceXML documents can be controlled via the jvoicexml.vxml.version system property. A value of 2.0 sets the document type to VoiceXml20DocumentType and a value of 2.1 sets the document type to VoiceXml21DocumentType. There is no document type by default.

It is possible to provide own document types via the method VoiceXmlDocument.setDocumentTypeFactory(DocumentTypeFactory).



Copyright © 2005-2009JVoiceXML group.