<subdialog>

Subdialogs are a mechanism for reusing common dialogs and building libraries of reusable applications.

Attributes

name The result returned from the subdialog, an ECMAScript object whose properties are the ones defined in the namelist attribute of the <return> element.
cond (defaults to true) An expression that must evaluate to true after conversion to Boolean in order for the event to be caught.
expr The initial value of the form item variable; default is ECMAScript undefined. If initialized to a value, then the form item will not be visited unless the form item variable is cleared.
src The URI of the subdialog.
srcexpr An ECMAScript expression yielding the URI of the subdialog.
fetchhint This attribute is not supported.
fetchtimeout (defaults to "fetchtimeout" global property value) The timeout for fetches. Must be specified with the appropriate time units (e.g., "120s" for 120 seconds).
maxage (defaults to "documentmaxage" global property value) Tells the platform the maximum acceptable age, in seconds, of cached documents.
maxstale (defaults to "documentmaxstale" global property value) Tells the platform the maximum acceptable staleness, in seconds, of expired cached documents.
fetchaudio (defaults to "fetchaudio" global property value) The URI of the audio clip to play while the fetch is being done.
method (defaults to "get") The request method: get, post, or raw.
enctype (defaults to "application/x-www-form-urlencoded") The media encoding type of the submitted document. The other permissible choices are "multipart/form-data", which is the encoding method used by the platform when binary data is being submitted, "application/xml", when fetching raw XML, and "application/json", when fetching raw JSON.
rawexpr The raw XML or JSON string to submit to the URI. You can only use this attribute when using the "raw" method and either the "application/xml" or "application/json" enctype.
namelist The list of variables to submit. The default is to submit no variables. If a namelist is supplied, it may contain individual variable references that are submitted with the same qualification used in the namelist. Declared VoiceXML and ECMAScript variables can be referenced.

Notes

Exactly one of "src" and "srcexpr" must be specified. NOTE: When setting the "method" attribute to "post", the platform does a normal POST with the variables passed in the namelist encoded as "application/x-www-form-urlencoded" or "multipart/form-data". After encoding the namelist, the platform passes the data and tells the server that the data is encoded with whatever format it used to encode. However, when setting the "method" attribute to "raw", the "raw" type is still a POST request, but does two things to change the default behavior, allowing control over both the data and the encoding type reported to the server: 1) Rather than encoding the namelist to create the "data", the platform instead executes the rawexpr javascript expression and uses the result for the data. 2) It passes the encoding that was provided in the "enctype" attribute as the encoding to the web server.


Example

subdialog.vxml
<?xml version="1.0"?>
<vxml version="2.1">
  <form>
    <subdialog name="blah" src="subdialog.php"/>
    <block>
      Hello <value expr="blah.stuff"/>.
    </block>
  </form>
</vxml>
subdialog.php
<?php
     header("Content-type: text/xml");
     echo("<?xml version=\"1.0\"?>\n");
     $somevar = "World";
?>
<vxml version="2.0">
       <form>
         <block>
           <var name="stuff" expr="'<?php echo($somevar)?>'"/>
           <return namelist="stuff"/>
         </block>
       </form>
</vxml>

The output of the above script would be:

Computer: Hello World.



Child Tags

<audio>, <catch>, <enumerate>, <error>, <filled>, <help>, <noinput>, <nomatch>, <param>, <prompt>, <property>, <value>



Parent Tags

<form>