[asterisk-doc] r5 - /en/reference/flowcontrol/
/en/reference/flowcontrol/functions/ /entities/
commits at digium.com
commits at digium.com
Mon May 8 09:48:55 MST 2006
Author: beckman
Date: Mon May 8 11:48:55 2006
New Revision: 5
URL: http://svncommunity.digium.com/view/asterisk-docs?rev=5&view=rev
Log:
Adding
- Wait
- WaitExten
- WaitForRing
- WaitForSilence
- WaitMusicOnHold
Added:
en/reference/flowcontrol/functions/wait.xml
en/reference/flowcontrol/functions/waitexten.xml
en/reference/flowcontrol/functions/waitforring.xml
en/reference/flowcontrol/functions/waitforsilence.xml
en/reference/flowcontrol/functions/waitmusiconhold.xml
Modified:
en/reference/flowcontrol/functions.xml
entities/file-entities.ent
entities/version.ent
Modified: en/reference/flowcontrol/functions.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/flowcontrol/functions.xml?rev=5&r1=4&r2=5&view=diff
==============================================================================
--- en/reference/flowcontrol/functions.xml (original)
+++ en/reference/flowcontrol/functions.xml Mon May 8 11:48:55 2006
@@ -1,2 +1,7 @@
&reference.flowcontrol.functions.goto;
&reference.flowcontrol.functions.gotoif;
+&reference.flowcontrol.functions.wait;
+&reference.flowcontrol.functions.waitexten;
+&reference.flowcontrol.functions.waitforring;
+&reference.flowcontrol.functions.waitforsilence;
+&reference.flowcontrol.functions.waitmusiconhold;
Added: en/reference/flowcontrol/functions/wait.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/flowcontrol/functions/wait.xml?rev=5&view=auto
==============================================================================
--- en/reference/flowcontrol/functions/wait.xml (added)
+++ en/reference/flowcontrol/functions/wait.xml Mon May 8 11:48:55 2006
@@ -1,0 +1,80 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+
+<refentry id="function.wait">
+ <refnamediv>
+ <refname>Wait</refname>
+ <refpurpose>
+ Waits for some time
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Description</title>
+ <methodsynopsis>
+ <methodname>Wait</methodname>
+ <methodparam><type>int</type><parameter>seconds</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ This application waits for a specified number of seconds. Then, dialplan
+ execution will continue at the next priority.
+ </para>
+
+ <para>
+ During the time waited, all sound input received on the channel, including
+ DTMF tones, are silently ignored. Wait is typically used before answering a
+ channel.
+ </para>
+
+ <para>
+ <note>
+ <para>
+ <parameter>seconds</parameter> can be passed with fractions of a second.
+ For example, '1.5' will ask the application to wait for 1.5 seconds.
+ </para>
+ </note>
+ </para>
+
+ <para>
+ <example>
+ <title>Wait before Answer</title>
+ <programlisting role="astconf">
+<![CDATA[
+; Wait 30 seconds (about 6-7 rings) before answering the channel
+exten => s,1,Wait(30)
+exten => s,2,Answer
+]]>
+ </programlisting>
+ </example>
+ </para>
+
+ <para>
+ See also <function>WaitExten</function>,
+ <function>WaitForRing</function>,
+ <function>WaitForSilence</function>,
+ <function>WaitMusicOnHold</function>.
+ </para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Added: en/reference/flowcontrol/functions/waitexten.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/flowcontrol/functions/waitexten.xml?rev=5&view=auto
==============================================================================
--- en/reference/flowcontrol/functions/waitexten.xml (added)
+++ en/reference/flowcontrol/functions/waitexten.xml Mon May 8 11:48:55 2006
@@ -1,0 +1,79 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+
+<refentry id="function.waitexten">
+ <refnamediv>
+ <refname>WaitExten</refname>
+ <refpurpose>
+ Waits for an extension to be entered
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Description</title>
+ <methodsynopsis>
+ <methodname>WaitExten</methodname>
+ <methodparam choice="opt"><type>int</type><parameter>seconds</parameter></methodparam>
+ <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ This application waits for the user to enter a new extension for a
+ specified number of seconds.
+ </para>
+
+ <para>
+ <parameter>options</parameter> can be one or more of the following:
+ <itemizedlist>
+ <listitem>
+ <simpara>
+ <literal>m</literal> - Provide music on hold to the caller while waiting for an extension.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <literal>m(x)</literal> - Same as <literal>m</literal> above, specifying
+ the class (x) for Music On Hold within parenthesis
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ <note>
+ <para>
+ <parameter>seconds</parameter> can be passed with fractions of a second.
+ For example, '1.5' will ask the application to wait for 1.5 seconds.
+ </para>
+ </note>
+ </para>
+
+ <para>
+ See also <function>Wait</function>,
+ <function>WaitForRing</function>,
+ <function>WaitForSilence</function>,
+ <function>WaitMusicOnHold</function>.
+ </para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Added: en/reference/flowcontrol/functions/waitforring.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/flowcontrol/functions/waitforring.xml?rev=5&view=auto
==============================================================================
--- en/reference/flowcontrol/functions/waitforring.xml (added)
+++ en/reference/flowcontrol/functions/waitforring.xml Mon May 8 11:48:55 2006
@@ -1,0 +1,57 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+
+<refentry id="function.waitforring">
+ <refnamediv>
+ <refname>WaitForRing</refname>
+ <refpurpose>
+ Wait for Ring Application
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Description</title>
+ <methodsynopsis>
+ <methodname>WaitForRing</methodname>
+ <methodparam><type>int</type><parameter>seconds</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Waits for ringing on a channel.
+ </para>
+
+ <para>
+ Returns 0 after waiting at least timeout seconds. and
+ only after the next ring has completed. Returns 0 on
+ success or -1 on hangup
+ </para>
+
+ <para>
+ See also <function>Wait</function>,
+ <function>WaitExten</function>,
+ <function>WaitForSilence</function>,
+ <function>WaitMusicOnHold</function>.
+ </para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Added: en/reference/flowcontrol/functions/waitforsilence.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/flowcontrol/functions/waitforsilence.xml?rev=5&view=auto
==============================================================================
--- en/reference/flowcontrol/functions/waitforsilence.xml (added)
+++ en/reference/flowcontrol/functions/waitforsilence.xml Mon May 8 11:48:55 2006
@@ -1,0 +1,86 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+
+<refentry id="function.waitforsilence">
+ <refnamediv>
+ <refname>WaitForSilence</refname>
+ <refpurpose>
+ Waits for a specified amount of silence
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Description</title>
+ <methodsynopsis>
+ <methodname>WaitForSilence</methodname>
+ <methodparam><type>int</type><parameter>milliseconds</parameter></methodparam>
+ <methodparam choice="opt"><type>int</type><parameter>times</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Waits for up to <parameter>milliseconds</parameter> milliseconds of silence
+ <parameter>times</parameter> times, defaulting to 1.
+ </para>
+
+ <para>
+ SendText sets the channel variable $WAITSTATUS to one of the
+ following upon completion:
+ <itemizedlist>
+ <listitem>
+ <simpara>
+ <literal>SILENCE</literal> - <parameter>milliseconds</parameter> ms of
+ silence was detected.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <literal>TIMEOUT</literal> - Specified silence was not detected.
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ <example>
+ <title>Simple Usage</title>
+ <programlisting role="astconf">
+<![CDATA[
+; Wait for 1/2 second of silence, twice
+exten => s,1,WaitForSilence(500|2)
+
+; Wait for 1 second of silence, once
+exten => s,2,WaitForSilence(1000)
+]]>
+ </programlisting>
+ </example>
+ </para>
+
+ <para>
+ See also <function>Wait</function>,
+ <function>WaitExten</function>,
+ <function>WaitForRing</function>,
+ <function>WaitMusicOnHold</function>.
+ </para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Added: en/reference/flowcontrol/functions/waitmusiconhold.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/flowcontrol/functions/waitmusiconhold.xml?rev=5&view=auto
==============================================================================
--- en/reference/flowcontrol/functions/waitmusiconhold.xml (added)
+++ en/reference/flowcontrol/functions/waitmusiconhold.xml Mon May 8 11:48:55 2006
@@ -1,0 +1,56 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+
+<refentry id="function.waitmusiconhold">
+ <refnamediv>
+ <refname>WaitMusicOnHold</refname>
+ <refpurpose>
+ Wait, playing Music On Hold
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Description</title>
+ <methodsynopsis>
+ <methodname>WaitMusicOnHold</methodname>
+ <methodparam><type>int</type><parameter>seconds</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Plays hold music specified number of seconds. If no hold music is
+ available, the delay will still occur with no sound.
+ </para>
+
+ <para>
+ Returns 0 when done, or -1 on hangup.
+ </para>
+
+ <para>
+ See also <function>Wait</function>,
+ <function>WaitExten</function>,
+ <function>WaitForRing</function>,
+ <function>WaitForSilence</function>.
+ </para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Modified: entities/file-entities.ent
URL: http://svncommunity.digium.com/view/asterisk-docs/entities/file-entities.ent?rev=5&r1=4&r2=5&view=diff
==============================================================================
--- entities/file-entities.ent (original)
+++ entities/file-entities.ent Mon May 8 11:48:55 2006
@@ -28,8 +28,13 @@
<!ENTITY reference.voicemail.functions.vmauthenticate SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/voicemail/functions/vmauthenticate.xml'>
<!ENTITY reference.voicemail.functions SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/voicemail/functions.xml'>
<!ENTITY reference.flowcontrol.functions SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/flowcontrol/functions.xml'>
+<!ENTITY reference.flowcontrol.functions.wait SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/flowcontrol/functions/wait.xml'>
<!ENTITY reference.flowcontrol.functions.goto SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/flowcontrol/functions/goto.xml'>
<!ENTITY reference.flowcontrol.functions.gotoif SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/flowcontrol/functions/gotoif.xml'>
+<!ENTITY reference.flowcontrol.functions.waitforsilence SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/flowcontrol/functions/waitforsilence.xml'>
+<!ENTITY reference.flowcontrol.functions.waitforring SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/flowcontrol/functions/waitforring.xml'>
+<!ENTITY reference.flowcontrol.functions.waitexten SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/flowcontrol/functions/waitexten.xml'>
+<!ENTITY reference.flowcontrol.functions.waitmusiconhold SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/flowcontrol/functions/waitmusiconhold.xml'>
<!ENTITY reference.flowcontrol.reference SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/flowcontrol/reference.xml'>
<!ENTITY reference.flowcontrol.functions SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/flowcontrol/functions.xml'>
<!ENTITY reference.callmgmt.functions SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/callmgmt/functions.xml'>
Modified: entities/version.ent
URL: http://svncommunity.digium.com/view/asterisk-docs/entities/version.ent?rev=5&r1=4&r2=5&view=diff
==============================================================================
--- entities/version.ent (original)
+++ entities/version.ent Mon May 8 11:48:55 2006
@@ -1,1 +1,1 @@
-<!ENTITY php.build-date "2006-05-04">
+<!ENTITY php.build-date "2006-05-08">
More information about the asterisk-doc
mailing list