Developer's Guide

0 THE VOICE FOUNDATION CLASSES VOICEXML PROGRAMMING GUIDE

FOR CISCO UNIFIED CUSTOMER VOICE PORTAL RELEASE 4.0(1)

com.audium.core.vfc.form.VMenuField. This class is used when a menu is desired in the

VoiceXML document. The class produces <field> tags with <option> tags defining

each menu option. The <menu> and <choice> tags in VoiceXML are just shortcuts for

this and cannot be produced with the VFCs.

com.audium.core.vfc.form.VListField. This class is a special kind of menu that is used by

the

VList class when it is configured to act as a traverse list. The menu is pre-built to

support options to go forwards and backwards.

com.audium.core.vfc.util.VAction. This VFC class encapsulates multiple VoiceXML tags that

represent taking certain actions. All the VoiceXML tags produced by this class have the same

parent tags and so can be used in the same locations. Combining these tags into one class

reduces the complexity of the VFCs since special handlers are not needed for each tag. The

following lists the actions that the VAction tag encapsulates and the corresponding

VoiceXML tag: variable declarations (<var>), variable assignment (<assign>), gotos

(<goto>), HTTP submits (<submit>), clearing forms and fields (<clear>), scripts

(<script>), logging (<log>), throwing events (<throw>), reprompting (<reprompt>),

returning from subdialogs (<return>), disconnects (<disconnect>) and exits (<exit>).

com.audium.core.vfc.audio.VAudio. This class deals with audio, both TTS and through audio

files. A single VAudio object can contain any number of audio items (so an entire voice

element audio group can be encapsulated in one VAudio object). The class also deals with

playing back a recording, managing bargein, adding pauses to the playback. Note that SSML

(Speech Synthesis Markup Language) that is entered by the application designer in Unified

CVP VoiceXML Studio is handled correctly by this class.

com.audium.core.vfc.util.VEvent. This class handles VoiceXML events and what to do when

they occur. Events may be user-triggered such as nomatch or noinput events, or custom

events thrown by the developer or voice browser. Hotevents are basically VEvent classes that

Unified CVP VoiceXML Server adds to the VoiceXML root document. It is a direct mapping

of the <catch> tag. Note that the <noinput>, <nomatch>, and <help> tags are all shortcuts

for variations of the <catch> tag so are not produced by the VFCs.

com.audium.core.vfc.util.VGrammar. This class deals with specifying either an inline or

external DTMF or speech grammar. It is a direct mapping of the <grammar> tag.

com.audium.core.vfc.util.VIfGroup. This class deals with producing an if statement within

VoiceXML. It is a direct mapping of the <if>, <elseif>, and <else> tags.

com.audium.core.vfc.util.VLink. This class deals with creating an utterance-activated link

within the VoiceXML page. It is a direct mapping of the <link> tag.

com.audium.core.vfc.util.VProperty. This class deals with including VoiceXML properties in

the VoiceXML page. It is a direct mapping of the

<property> tag.

com.audium.core.vfc.VException. This exception class is thrown when a VFC class

encounters an error.

Utility Classes. These classes are used by the VFCs to aid in the organization of data they

require. The following lists those classes: