[Asterisk-doc] docs appendix03.xml,1.12,1.13
websmith
asterisk-doc@lists.digium.com
Sat, 20 Dec 2003 18:35:13 +0000
Comments:
Update of /cvsroot/asterisk/docs
In directory sc8-pr-cvs1:/tmp/cvs-serv32255
Modified Files:
appendix03.xml
Log Message:
More fixups on Appendix 3
Index: appendix03.xml
===================================================================
RCS file: /cvsroot/asterisk/docs/appendix03.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -d -r1.12 -r1.13
*** appendix03.xml 19 Dec 2003 23:50:24 -0000 1.12
--- appendix03.xml 20 Dec 2003 18:35:08 -0000 1.13
***************
*** 14,18 ****
<programlisting>
exten=>5551234,1,SetAbsoluteTimeout(600) <lineannotation>;limit calls to ex-girlfriend to 600 seconds</lineannotation>
! exten=>5551234,2,Dial(Zap/1/5551212)
</programlisting>
</informalexample>
--- 14,18 ----
<programlisting>
exten=>5551234,1,SetAbsoluteTimeout(600) <lineannotation>;limit calls to ex-girlfriend to 600 seconds</lineannotation>
! exten=>5551234,2,Dial(Zap/1/5551234)
</programlisting>
</informalexample>
***************
*** 40,45 ****
<para>
Programs an ADSI Phone with the given script.
! If none is specified, the default is used. Returns 0 unless CPE
! is hungup.
</para>
--- 40,47 ----
<para>
Programs an ADSI Phone with the given script.
! If none is specified, the default is used.
! </para>
! <para>
! Returns 0 unless CPE is hungup.
</para>
***************
*** 48,58 ****
<!-- TODO: Is this really right? Can you call it without any arguments? -->
<!-- According to anthm on IRC, the only way it works is AgentCallbackLogin(|@callback) -->
! <function>AgentCallbackLogin(<replaceable>[AgentNo]</replaceable>[|[<replaceable>options</replaceable>][<replaceable>exten</replaceable>]@<replaceable>context</replaceable>])</function>
</para>
</formalpara>
<para>
! Asks the agent to login to the system with callback. Always returns -1.
The agent's callback extension is called (optionally with the specified
! context.
</para>
--- 50,64 ----
<!-- TODO: Is this really right? Can you call it without any arguments? -->
<!-- According to anthm on IRC, the only way it works is AgentCallbackLogin(|@callback) -->
! <!-- The options sure aren't documented! -->
! <function>AgentCallbackLogin([<replaceable>AgentNo</replaceable>][|[<replaceable>options</replaceable>][<replaceable>exten</replaceable>]@<replaceable>context</replaceable>])</function>
</para>
</formalpara>
<para>
! Asks the agent to login to the system with callback.
The agent's callback extension is called (optionally with the specified
! <replaceable>context</replaceable>).
! </para>
! <para>
! Always returns -1.
</para>
***************
*** 88,92 ****
and stdout. Returns -1 on hangup or if application requested hangup, or
0 on non-hangup exit. Using 'EAGI' provides enhanced AGI, with audio
! available out of band on file descriptor 3
</para>
<formalpara><title>Answer: Answer a channel if ringing</title>
--- 94,98 ----
and stdout. Returns -1 on hangup or if application requested hangup, or
0 on non-hangup exit. Using 'EAGI' provides enhanced AGI, with audio
! available out of band on file descriptor 3.
</para>
<formalpara><title>Answer: Answer a channel if ringing</title>
***************
*** 97,100 ****
--- 103,108 ----
<para>
If the channel is ringing, answer it, otherwise do nothing.
+ </para>
+ <para>
Returns 0 unless it tries to answer the channel and fails.
</para>
***************
*** 127,131 ****
Plays a given file, while simultaneously waiting for
the user to begin typing an extension. The timeouts do not count until the
! last BackGround application as ended. Always returns 0.
</para>
--- 135,142 ----
Plays a given file, while simultaneously waiting for
the user to begin typing an extension. The timeouts do not count until the
! last BackGround application as ended.
! </para>
! <para>
! Always returns 0.
</para>
***************
*** 137,144 ****
<para>
Requests that the channel indicate busy condition and then waits
! for the user to hang up. Always returns -1.
</para>
! <formalpara><title>CallingPres: Change the presentation for the callerid</title>
<para>
<function>CallingPres(<replaceable>number</replaceable>)</function>
--- 148,158 ----
<para>
Requests that the channel indicate busy condition and then waits
! for the user to hang up.
! </para>
! <para>
! Always returns -1.
</para>
! <formalpara><title>CallingPres: Change the presentation for the Caller*ID</title>
<para>
<function>CallingPres(<replaceable>number</replaceable>)</function>
***************
*** 146,151 ****
</formalpara>
<para>
! Changes the presentation for the callerid. Should be called
! before placing an outgoing call
</para>
--- 160,165 ----
</formalpara>
<para>
! Changes the presentation for the Caller*ID. Should be called
! before placing an outgoing call.
</para>
***************
*** 160,164 ****
The option string may contain the following:
<simplelist>
! <member>filename_base -- if set, changes the filename used to the one specified.</member>
</simplelist>
</para>
--- 174,178 ----
The option string may contain the following:
<simplelist>
! <member><replaceable>filename_base</replaceable> -- if set, changes the filename used to the one specified.</member>
</simplelist>
</para>
***************
*** 186,190 ****
<para>
Requests that the channel indicate congestion and then
! waits for the user to hang up. Always returns -1.
</para>
--- 200,207 ----
<para>
Requests that the channel indicate congestion and then
! waits for the user to hang up.
! </para>
! <para>
! Always returns -1.
</para>
***************
*** 224,227 ****
--- 241,245 ----
</para>
<para>
+ <!-- Can't we word this better? -->
Returns 0 or -1 on hangup or error.
</para>
***************
*** 284,348 ****
</formalpara>
<para>
! Requests one or more channels and places specified outgoing calls on them.
! As soon as a channel answers, the Dial app will answer the originating
! channel (if it needs to be answered) and will bridge a call with the channel
! hich first answered. All other calls placed by the Dial app will be hunp up
! If a timeout is not specified, the Dial application will wait indefinitely
! until either one of the called channels answers, the user hangs up, or all
! channels return busy or error. In general, the dialler will return 0 if it
! was unable to place the call, or the timeout expired. However, if all
! channels were busy, and there exists an extension with priority n+101 (where
! n is the priority of the dialler instance), then it will be the next
! executed extension (this allows you to setup different behavior on busy from
! no-answer).
</para>
<para>
! This application returns -1 if the originating channel hangs up, or if the
call is bridged and either of the parties in the bridge terminate the call.
The option string may contain zero or more of the following characters:
<variablelist>
! <varlistentry><term><emphasis>t</emphasis></term>
<listitem>
<para>allow the called user transfer the calling user</para>
</listitem>
</varlistentry>
! <varlistentry><term><emphasis>T</emphasis></term>
<listitem>
<para>to allow the calling user to transfer the call.</para>
</listitem>
</varlistentry>
! <varlistentry><term><emphasis>r</emphasis></term>
<listitem>
<para>indicate ringing to the calling party, pass no audio until answered.</para>
</listitem>
</varlistentry>
! <varlistentry><term><emphasis>m</emphasis></term>
<listitem>
<para>provide hold music to the calling party until answered.</para>
</listitem>
</varlistentry>
! <varlistentry><term><emphasis>H</emphasis></term>
<listitem>
<para>allow caller to hang up by hitting *.</para>
</listitem>
</varlistentry>
! <varlistentry><term><emphasis>C</emphasis></term>
<listitem>
<para>reset call detail record for this call.</para>
</listitem>
</varlistentry>
! <varlistentry><term><emphasis>P[(x)]</emphasis></term>
<listitem>
! <para>privacy mode, using 'x' as database if provided.</para>
</listitem>
</varlistentry>
! <varlistentry><term><emphasis>g</emphasis></term>
<listitem>
<para>goes on in context if the destination channel hangs up</para>
</listitem>
</varlistentry>
! <varlistentry><term><emphasis>A(x)</emphasis></term>
<listitem>
! <para>play an announcement to the called party, using x as file</para>
</listitem>
</varlistentry>
--- 302,370 ----
</formalpara>
<para>
! Requests one or more channels and places specified outgoing
! calls on them. As soon as a channel answers, the Dial app
! will answer the originating channel (if it needs to be answered)
! and will bridge a call with the channel which first answered.
! All other calls placed by the Dial app will be hung up.
! If a timeout is not specified, the Dial application will wait
! indefinitely until either one of the called channels answers,
! the user hangs up, or all channels return busy or error.
</para>
<para>
! In general, the dialler will return 0 if it was unable to place
! the call, or the timeout expired. However, if all channels were
! busy, and there exists an extension with priority n+101
! (where n is the priority of the dialler instance), then it will
! be the next executed extension (this allows you to setup different
! behavior on busy from no-answer).
! </para>
! <para>
! This application returns -1 if the originating channel hangs up, or if the
call is bridged and either of the parties in the bridge terminate the call.
The option string may contain zero or more of the following characters:
<variablelist>
! <varlistentry><term>t</term>
<listitem>
<para>allow the called user transfer the calling user</para>
</listitem>
</varlistentry>
! <varlistentry><term>T</term>
<listitem>
<para>to allow the calling user to transfer the call.</para>
</listitem>
</varlistentry>
! <varlistentry><term>r</term>
<listitem>
<para>indicate ringing to the calling party, pass no audio until answered.</para>
</listitem>
</varlistentry>
! <varlistentry><term>m</term>
<listitem>
<para>provide hold music to the calling party until answered.</para>
</listitem>
</varlistentry>
! <varlistentry><term>H</term>
<listitem>
<para>allow caller to hang up by hitting *.</para>
</listitem>
</varlistentry>
! <varlistentry><term>C</term>
<listitem>
<para>reset call detail record for this call.</para>
</listitem>
</varlistentry>
! <varlistentry><term>P[(<replaceable>x</replaceable>)]</term>
<listitem>
! <para>privacy mode, using <replaceable>x</replaceable> as database if provided.</para>
</listitem>
</varlistentry>
! <varlistentry><term>g</term>
<listitem>
<para>goes on in context if the destination channel hangs up</para>
</listitem>
</varlistentry>
! <varlistentry><term>A(<replaceable>x</replaceable>)</term>
<listitem>
! <para>play an announcement to the called party, using <replaceable>x</replaceable> as file</para>
</listitem>
</varlistentry>