voicexml elements

VoiceXML 2.1 Development Guide

<return> element

The return element is used to terminate a subdialog and return control to the main dialog. This element will throw a fatal error.semantic if encountered outside the context of a subdialog call. Exactly one namelist, event, or eventexpr must be specified, else a fatal error.badfetch will be thrown in the logger.

usage

<return event="NMTOKEN" eventexpr="CDATA" message="CDATA" messageexpr="CDATA" namelist="NMTOKEN">

attributes

event	Data Type: NMTOKEN	Default: Optional
	The event attribute specifies the event to be thrown immediately after returning to the invoking application. Either an event or a namelist may be used in the return element, but not both.
eventexpr	Data Type: CDATA	Default: Optional
	The eventexpr attribute specifies an ECMAScript expression that evaluates to the event being thrown to the application. As mentioned, either platform defined events, or user-defined events may be indicated in this attribute. Please note that either event or eventexpr may be used within the parent element, but not both.
message	Data Type: CDATA	Default: Optional
	The message attribute allows the developer to include a descriptive message along with the event that is being thrown. The message being thrown is accessible in the catch elements shadow variable _message.
messageexpr	Data Type: CDATA	Default: Optional
	The messageexpr attribute allows the developer to include an ECMAScript expression resolving to the message being thrown to the application. The messageexpr being thrown is accessible in the catch elements shadow variable _message.
namelist	Data Type: NMTOKEN	Default: Optional
	The namelist attribute specifies a space-separated list of variables to send to the subdialog back to the invoking application. Either a namelist or an event may be specified for the return element, but not both.

shadow variables

none

parents

<block> <catch> <error> <filled> <help> <if> <noinput> <nomatch>

children

none

code samples

<Return namelist> sample

<?xml version="1.0" encoding="UTF-8"?>

<vxml version = "2.1">

<meta name="author" content="Matthew Henry"/>
<meta name="copyright" content="2005 voxeo corporation"/>
<meta name="maintainer" content="YOUR_EMAIL@HERE.COM"/>

<form id="F1">
<subdialog name="SubD_1" src="MySubD.vxml">
<param name="confirm_prompt"
expr="'is there a chance in hell that nick cage will ever
be taken seriously as a dramatic actor? '"/>

<filled>
<prompt> yeah, you are probably right. </prompt>
</filled>

</subdialog>

</form>
</vxml>

<MySubD.vxml>

<?xml version="1.0" encoding="UTF-8"?>

<vxml version = "2.1">

<meta name="author" content="Matthew Henry"/>
<meta name="copyright" content="2005 voxeo corporation"/>
<meta name="maintainer" content="YOUR_EMAIL@HERE.COM"/>

<form id="F1">

<var name="confirm_prompt"/>
<var name="response"/>

<field name="field_confirm" type="boolean">
<prompt>
<value expr="confirm_prompt"/>
</prompt>

<filled>
<if cond="field_confirm == true">
<assign name="response" expr="'yes'"/>
<else/>
<assign name="response" expr="'no'"/>
</if>
<return namelist="response"/>
</filled>

</field>
</form>

</vxml>

<Return event> sample

<?xml version="1.0" encoding="UTF-8"?>

<vxml version = "2.1">

<meta name="author" content="Matthew Henry"/>
<meta name="copyright" content="2005 voxeo corporation"/>
<meta name="maintainer" content="YOUR_EMAIL@HERE.COM"/>

<catch event="MyEvent">
<prompt> Of course. Just look at Vanilla Ice, little buddy. </prompt>
</catch>

<form id="F1">
<subdialog name="SubD_1" src="MySubD_2.vxml">
<param name="confirm_prompt"
expr="'admit it. suburban white kids trying to be gangster rappers
have no credibility whatsoever, yes?'"/>

<filled>
<prompt> I thought so. </prompt>
</filled>

</subdialog>

</form>
</vxml>

<MySubD_2.vxml>

<?xml version="1.0" encoding="UTF-8"?>

<vxml version = "2.1">

<meta name="author" content="Matthew Henry"/>
<meta name="copyright" content="2005 voxeo corporation"/>
<meta name="maintainer" content="YOUR_EMAIL@HERE.COM"/>

<form id="F1">

<var name="confirm_prompt"/>
<var name="response"/>

<field name="field_confirm" type="boolean">
<prompt>
<value expr="confirm_prompt"/>
</prompt>

<filled>
<if cond="field_confirm == true">
<assign name="response" expr="'yes'"/>
<else/>
<assign name="response" expr="'no'"/>
</if>
<return event="MyEvent"/>
</filled>

</field>

</form>

</vxml>

additional links

W3C 2.0 Specification

ANNOTATIONS: EXISTING POSTS

safarishane

3/16/2006 11:34 AM (EST)

In the valid children section of <return> is it implied that because <catch> can be a parent, that <nomatch> and <noinput> are automatically included as catch handlers?

Thanks,
Shane

steve.sax

3/16/2006 11:59 AM (EST)

Hello Shane,

You are correct in this understanding; I'll see that our documentation folks correct this oversight.

Steve Sax