<help>

<help>

The <help> element is an abbreviation for <catch event=“help”>.

Attributes

NameData typeDescription

count

Integer

(defaults to 1) The occurrence of the event. The count allows you to handle different occurrences of the same event differently.

Each <form>, <menu>, and form item maintains a counter for each event that occurs while it is being visited. These counters are reset each time the <menu> or form item's <form> is re-entered. The form-level counters are used in the selection of an event handler for events thrown in a form-level <filled>.

Counters are incremented against the full event name and every prefix matching event name. For example, occurrence of the event “event.foo.1” increments the counters associated with handlers for “event.foo.1” plus “event.foo” and “event”.

cond

String

(defaults to true) An expression that must evaluate to true after conversion to Boolean in order for the event to be caught.

Notes

None

Example

<?xml version="1.0"?>
<vxml version="2.0">
  <form>
    <block>
      <throw event="help" message="help help help."/>
    </block>
    <!-- The "help" tag is shorthand for a "catch" tag that catches an -->
    <!-- event named "help". -->
    <help>
      <prompt>
        Caught my help event with the following message:
        <break time="1s"/>
        <value expr="_message"/>
      </prompt>
    </help>
  </form>
</vxml>

The output of the above script would be:

Computer: Caught my help event with the following message: Computer: help help help.

Child Tags

<assign>, <audio>, <clear>, <data>, <disconnect>, <enumerate>, <exit>, <foreach>, <goto>, <if>, <log>, <prompt>, <reprompt>, <return>, <script>, <submit>, <throw>, <value>, <var>

Parent Tags

<field>, <form>, <initial>, <menu>, <record>, <subdialog>, <transfer>, <vxml>

Last updated