Plum DEV Documentation
voicexml:tags:return

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

voicexml:tags:return [2014/05/30 10:54]
jennifer added meta description
voicexml:tags:return [2019/09/17 12:29]
Line 1: Line 1:
-{{description>​‹return› VoiceXML tag details, attributes and VXML code example | return ends execution of a subdialog returning control/​data to the calling dialog.}} 
-=====<​return>​===== 
- 
-The <​return>​ element ends execution of a subdialog and returns control and data to a calling dialog. 
-====Attributes==== 
-| namelist | Variable names to be returned to calling dialog. The default is to return no variables; this means the caller will receive an empty ECMAScript object. | 
-| event | Return, then throw this event. | 
-| eventexpr | This attribute is not supported. | 
-| message | This attribute is not supported. | 
-| messageexpr | This attribute is not supported. | 
- 
-====Notes==== 
- 
-None 
- 
-====Example==== 
-<​code>​ 
-<?xml version="​1.0"?>​ 
-<vxml version="​2.0">​ 
-  <!-- form dialog that calls a subdialog --> 
-  <var name="​myname"​ expr="'​Jane Doe'"/>​ 
-  <​form>​ 
-    <​subdialog name="​result"​ src="#​getdriverslicense"​ namelist="​myname">​ 
-      <param name="​birthday"​ expr="'​February 10th, 1970'"/>​ 
-      <​filled>​ 
-        <!-- Reference returned variables as ECMAscript --> 
-        <!-- member variables of the field name "​result"​. --> 
-        You entered <value expr="​result.drivelicense"/>​. 
-        <submit next="​http://​nonexistent.domain.com/​process.pl"​ 
-          method="​post"​ 
-          namelist="​result.drivelicense birthday"/>​ 
-      </​filled>​ 
-    </​subdialog>​ 
-  </​form>​ 
- 
-  <!-- subdialog to get drivers license --> 
-  <form id="​getdriverslicense">​ 
-    <var name="​birthday"/>​ 
-    <field name="​drivelicense"​ type="​digits">​ 
-      <​prompt>​ 
-        <value expr="​myname"/>,​ 
-        your birthdate is: <value expr="​birthday"/>​. 
-        Please say your driver'​s license number. 
-      </​prompt>​ 
-      <​filled>​ 
-        <!-- All variables specified in the "​return"​ tag's --> 
-        <!-- "​namelist"​ attribute will be returned to the --> 
-        <!-- calling dialog. --> 
-        <return namelist="​drivelicense"/>​ 
-      </​filled>​ 
-    </​field>​ 
-  </​form>​ 
-</​vxml>​ 
-</​code>​ 
-The output of the above script would be: 
- 
-Computer: Jane Doe, your birthdate is: February 10th, 1970. \\ 
-Computer: Please say your driver'​s license number. \\ 
-Human: One two three four five six seven eight nine. \\ 
-Computer: You entered one hundred twenty-three million, four hundred fifty-six thousand, seven hundred eighty-nine. \\ 
-(continues on to processing form…) 
- 
- 
-====Child Tags==== 
- 
-None 
- 
- 
-====Parent Tags==== 
- 
-[[voicexml:​tags:​block|<​block>​]],​ [[voicexml:​tags:​catch|<​catch>​]],​ [[voicexml:​tags:​error|<​error>​]],​ [[voicexml:​tags:​filled|<​filled>​]],​ [[voicexml:​tags:​foreach|<​foreach>​]],​ [[voicexml:​tags:​help|<​help>​]],​ [[voicexml:​tags:​if|<​if>​]],​ [[voicexml:​tags:​noinput|<​noinput>​]],​ [[voicexml:​tags:​nomatch|<​nomatch>​]]