Differences

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

Link to this comparison view

developer_guide:voicexml_references:elements:enumerate [2015/10/27 11:16] (current)
borja created
Line 1: Line 1:
 +====== < enumerate > ======
  
 +===== Description =====
 +
 +The < enumerate > element is an automatically generated description of the choices available for the user.  It specifies a template that is applied to each choice in the order they appear in the < menu > element, or in the < field > element that contains < option > elements.
 +
 +===== Syntax =====
 +
 +<​code>​
 +<​enumerate>​
 +child elements
 +</​enumerate>​
 +</​code>​
 +
 +===== Anonymous Variables =====
 +
 +If <​enumerate>​ is used with no content, it lists all choices. ​ You can customize the content using the two anonymous variables that are available within the scope of the <​enumerate>​ element:
 +* _prompt – the prompt for the current choice.
 +* _dtmf – the assigned DTMF sequence for the current choice.
 +
 +===== Parents =====
 +
 +<​code>​
 +<​audio>,​ <​catch>,​ <​error>,​ <​field>,​ <​filled>,​ <​help>,​ <if>, <​menu>,​ <​noinput>,​ <​nomatch>,​ <​prompt>​
 +</​code>​
 +
 +===== Children =====
 +
 +<​code>​
 +<​audio>,​ <​value>,​ Speech Markup (SSML)
 +</​code>​
 +
 +===== Extensions =====
 +
 +<​code>​
 +None.
 +</​code>​
 +
 +===== Limitations/​Restrictions =====
 +
 +<​code>​
 +The dtmf attributes in the <​choice>​ tags must be specified.
 +</​code>​
 +
 +===== Example Code =====
 +
 +<​code>​
 +<?xml version="​1.0"?>​
 +<vxml version="​2.0"​ xmlns="​http://​www.w3.org/​2001/​vxml">​
 + <​menu dtmf="​true">​
 +  <​prompt>​
 +   ​Welcome home.
 +   <​enumerate>​
 +    For <value expr="​_prompt"/>,​ press <value expr="​_dtmf"/>​.
 +   </​enumerate>​
 +  </​prompt>​
 +  <choice dtmf="​1"​ next="​http://​www.example.com/​vxml/​sports.vxml">​
 +   ​sports
 +  </​choice>​
 +  <choice dtmf="​2"​ next="​http://​www.example.com/​weather.vxml">​
 +   ​weather
 +  </​choice>​
 +  <choice dtmf="​3"​ next="​http://​www.example.com/​news.vxml">​
 +   news
 +  </​choice>​
 + </​menu>​
 +</​vxml>​
 +</​code>​