Asterisk
/
asterisk
mirror of https://github.com/asterisk/asterisk
1
0
Fork 0
Code Issues Releases Wiki Activity

app_dial/app_queue: Update application option documentation

Browse Source 
* Update the post-answer documentation and example.  The Dial example was
incorrect and misleading for the post-answer subroutine useage.

* Fix note and warning paragraphs in option descriptions.  They don't show
up in the wiki.

Change-Id: I81019a1fd75d5b9151f76b52c38e2a90da682d14
16.1
Richard Mudgett 7 years ago
parent 718ccd51a3
commit 00284352b3
2 changed files with 44 additions and 67 deletions
Show Stats Download Patch File Download Diff File

63
apps/app_dial.c
Unescape View File

@ -142,11 +142,9 @@
a call to be answered. Exit to that extension if it exists in the a call to be answered. Exit to that extension if it exists in the
current context, or the context defined in the <variable>EXITCONTEXT</variable> variable, current context, or the context defined in the <variable>EXITCONTEXT</variable> variable,
if it exists.</para> if it exists.</para>
<note> <para>NOTE: Many SIP and ISDN phones cannot send DTMF digits until the call is
<para>Many SIP and ISDN phones cannot send DTMF digits until the call is
connected. If you wish to use this option with these phones, you connected. If you wish to use this option with these phones, you
can use the <literal>Answer</literal> application before dialing.</para> can use the <literal>Answer</literal> application before dialing.</para>
</note>
</option> </option>
<option name="D" argsep=":"> <option name="D" argsep=":">
<argument name="called" /> <argument name="called" />
@ -177,21 +175,15 @@
<argument name="priority" required="true" /> <argument name="priority" required="true" />
<para>When the caller hangs up, transfer the <emphasis>called</emphasis> party <para>When the caller hangs up, transfer the <emphasis>called</emphasis> party
to the specified destination and <emphasis>start</emphasis> execution at that location.</para> to the specified destination and <emphasis>start</emphasis> execution at that location.</para>
<note> <para>NOTE: Any channel variables you want the called channel to inherit from the caller channel must be
<para>Any channel variables you want the called channel to inherit from the caller channel must be
prefixed with one or two underbars ('_').</para> prefixed with one or two underbars ('_').</para>
</note>
</option> </option>
<option name="F"> <option name="F">
<para>When the caller hangs up, transfer the <emphasis>called</emphasis> party to the next priority of the current extension <para>When the caller hangs up, transfer the <emphasis>called</emphasis> party to the next priority of the current extension
and <emphasis>start</emphasis> execution at that location.</para> and <emphasis>start</emphasis> execution at that location.</para>
<note> <para>NOTE: Any channel variables you want the called channel to inherit from the caller channel must be
<para>Any channel variables you want the called channel to inherit from the caller channel must be
prefixed with one or two underbars ('_').</para> prefixed with one or two underbars ('_').</para>
</note> <para>NOTE: Using this option from a Macro() or GoSub() might not make sense as there would be no return points.</para>
<note>
<para>Using this option from a Macro() or GoSub() might not make sense as there would be no return points.</para>
</note>
</option> </option>
<option name="g"> <option name="g">
<para>Proceed with dialplan execution at the next priority in the current extension if the <para>Proceed with dialplan execution at the next priority in the current extension if the
@ -204,9 +196,7 @@
<para>If the call is answered, transfer the calling party to <para>If the call is answered, transfer the calling party to
the specified <replaceable>priority</replaceable> and the called party to the specified the specified <replaceable>priority</replaceable> and the called party to the specified
<replaceable>priority</replaceable> plus one.</para> <replaceable>priority</replaceable> plus one.</para>
<note> <para>NOTE: You cannot use any additional action post answer options in conjunction with this option.</para>
<para>You cannot use any additional action post answer options in conjunction with this option.</para>
</note>
</option> </option>
<option name="h"> <option name="h">
<para>Allow the called party to hang up by sending the DTMF sequence <para>Allow the called party to hang up by sending the DTMF sequence
@ -215,12 +205,10 @@
<option name="H"> <option name="H">
<para>Allow the calling party to hang up by sending the DTMF sequence <para>Allow the calling party to hang up by sending the DTMF sequence
defined for disconnect in <filename>features.conf</filename>.</para> defined for disconnect in <filename>features.conf</filename>.</para>
<note> <para>NOTE: Many SIP and ISDN phones cannot send DTMF digits until the call is
<para>Many SIP and ISDN phones cannot send DTMF digits until the call is
connected. If you wish to allow DTMF disconnect before the dialed connected. If you wish to allow DTMF disconnect before the dialed
party answers with these phones, you can use the <literal>Answer</literal> party answers with these phones, you can use the <literal>Answer</literal>
application before dialing.</para> application before dialing.</para>
</note>
</option> </option>
<option name="i"> <option name="i">
<para>Asterisk will ignore any forwarding requests it may receive on this dial attempt.</para> <para>Asterisk will ignore any forwarding requests it may receive on this dial attempt.</para>
@ -316,18 +304,14 @@
</value> </value>
</variable> </variable>
</variablelist> </variablelist>
<note> <para>NOTE: You cannot use any additional action post answer options in conjunction
<para>You cannot use any additional action post answer options in conjunction
with this option. Also, pbx services are run on the peer (called) channel, with this option. Also, pbx services are run on the peer (called) channel,
so you will not be able to set timeouts via the <literal>TIMEOUT()</literal> function in this macro.</para> so you will not be able to set timeouts via the <literal>TIMEOUT()</literal> function in this macro.</para>
</note> <para>WARNING: Be aware of the limitations that macros have, specifically with regards to use of
<warning><para>Be aware of the limitations that macros have, specifically with regards to use of
the <literal>WaitExten</literal> application. For more information, see the documentation for the <literal>WaitExten</literal> application. For more information, see the documentation for
<literal>Macro()</literal>.</para></warning> <literal>Macro()</literal>.</para>
<note> <para>NOTE: Macros are deprecated, GoSub should be used instead,
<para>Macros are deprecated, GoSub should be used instead,
see the <literal>U</literal> option.</para> see the <literal>U</literal> option.</para>
</note>
</option> </option>
<option name="n"> <option name="n">
<argument name="delete"> <argument name="delete">
@ -392,10 +376,8 @@
to send no cause. See the <filename>causes.h</filename> file for the to send no cause. See the <filename>causes.h</filename> file for the
full list of valid causes and names. full list of valid causes and names.
</para> </para>
<note> <para>NOTE: chan_sip does not support setting the cause on a CANCEL to anything
<para>chan_sip does not support setting the cause on a CANCEL to anything
other than ANSWERED_ELSEWHERE.</para> other than ANSWERED_ELSEWHERE.</para>
</note>
</option> </option>
<option name="r"> <option name="r">
<para>Default: Indicate ringing to the calling party, even if the called party isn't actually ringing. Pass no audio to the calling <para>Default: Indicate ringing to the calling party, even if the called party isn't actually ringing. Pass no audio to the calling
@ -430,7 +412,8 @@
</option> </option>
<option name="U" argsep="^"> <option name="U" argsep="^">
<argument name="x" required="true"> <argument name="x" required="true">
<para>Name of the subroutine to execute via <literal>Gosub</literal></para> <para>Name of the subroutine context to execute via <literal>Gosub</literal>.
The subroutine execution starts in the named context at the s exten and priority 1.</para>
</argument> </argument>
<argument name="arg" multiple="true" required="false"> <argument name="arg" multiple="true" required="false">
<para>Arguments for the <literal>Gosub</literal> routine</para> <para>Arguments for the <literal>Gosub</literal> routine</para>
@ -459,11 +442,9 @@
</value> </value>
</variable> </variable>
</variablelist> </variablelist>
<note> <para>NOTE: You cannot use any additional action post answer options in conjunction
<para>You cannot use any additional action post answer options in conjunction with this option. Also, pbx services are run on the <emphasis>called</emphasis> channel,
with this option. Also, pbx services are run on the peer (called) channel,
so you will not be able to set timeouts via the <literal>TIMEOUT()</literal> function in this routine.</para> so you will not be able to set timeouts via the <literal>TIMEOUT()</literal> function in this routine.</para>
</note>
</option> </option>
<option name="u"> <option name="u">
<argument name = "x" required="true"> <argument name = "x" required="true">
@ -548,27 +529,29 @@
<example title="Dial with pre-dial subroutines"> <example title="Dial with pre-dial subroutines">
[default] [default]
exten => callee_channel,1,NoOp() exten => callee_channel,1,NoOp(ARG1=${ARG1} ARG2=${ARG2})
same => n,Log(NOTICE, I'm called on channel ${CHANNEL} prior to it starting the dial attempt) same => n,Log(NOTICE, I'm called on channel ${CHANNEL} prior to it starting the dial attempt)
same => n,Return() same => n,Return()
exten => called_channel,1,NoOp() exten => called_channel,1,NoOp(ARG1=${ARG1} ARG2=${ARG2})
same => n,Log(NOTICE, I'm called on outbound channel ${CHANNEL} prior to it being used to dial someone) same => n,Log(NOTICE, I'm called on outbound channel ${CHANNEL} prior to it being used to dial someone)
same => n,Return() same => n,Return()
exten => _X.,1,NoOp() exten => _X.,1,NoOp()
same => n,Dial(PJSIP/alice,,b(default^called_channel^1)B(default^callee_channel^1)) same => n,Dial(PJSIP/alice,,b(default^called_channel^1(my_gosub_arg1^my_gosub_arg2))B(default^callee_channel^1(my_gosub_arg1^my_gosub_arg2)))
same => n,Hangup() same => n,Hangup()
</example> </example>
<example title="Dial with post-answer subroutine executed on outbound channel"> <example title="Dial with post-answer subroutine executed on outbound channel">
[default] [my_gosub_routine]
exten => called_channel,1,NoOp() exten => s,1,NoOp(ARG1=${ARG1} ARG2=${ARG2})
same => n,Playback(hello) same => n,Playback(hello)
same => n,Return() same => n,Return()
[default]
exten => _X.,1,NoOp() exten => _X.,1,NoOp()
same => n,Dial(PJSIP/alice,,U(default^called_channel^1)) same => n,Dial(PJSIP/alice,,U(my_gosub_routine^my_gosub_arg1^my_gosub_arg2))
same => n,Hangup() same => n,Hangup()
</example> </example>
<example title="Dial into ConfBridge using 'G' option"> <example title="Dial into ConfBridge using 'G' option">

20
apps/app_queue.c
Unescape View File

@ -169,21 +169,15 @@
<argument name="priority" required="true" /> <argument name="priority" required="true" />
<para>When the caller hangs up, transfer the <emphasis>called member</emphasis> <para>When the caller hangs up, transfer the <emphasis>called member</emphasis>
to the specified destination and <emphasis>start</emphasis> execution at that location.</para> to the specified destination and <emphasis>start</emphasis> execution at that location.</para>
<note> <para>NOTE: Any channel variables you want the called channel to inherit from the caller channel must be
<para>Any channel variables you want the called channel to inherit from the caller channel must be
prefixed with one or two underbars ('_').</para> prefixed with one or two underbars ('_').</para>
</note>
</option> </option>
<option name="F"> <option name="F">
<para>When the caller hangs up, transfer the <emphasis>called member</emphasis> to the next priority of <para>When the caller hangs up, transfer the <emphasis>called member</emphasis> to the next priority of
the current extension and <emphasis>start</emphasis> execution at that location.</para> the current extension and <emphasis>start</emphasis> execution at that location.</para>
<note> <para>NOTE: Any channel variables you want the called channel to inherit from the caller channel must be
<para>Any channel variables you want the called channel to inherit from the caller channel must be
prefixed with one or two underbars ('_').</para> prefixed with one or two underbars ('_').</para>
</note> <para>NOTE: Using this option from a Macro() or GoSub() might not make sense as there would be no return points.</para>
<note>
<para>Using this option from a Macro() or GoSub() might not make sense as there would be no return points.</para>
</note>
</option> </option>
<option name="h"> <option name="h">
<para>Allow <emphasis>callee</emphasis> to hang up by pressing <literal>*</literal>.</para> <para>Allow <emphasis>callee</emphasis> to hang up by pressing <literal>*</literal>.</para>
@ -256,12 +250,12 @@
</parameter> </parameter>
<parameter name="macro"> <parameter name="macro">
<para>Will run a macro on the called party's channel (the queue member) once the parties are connected.</para> <para>Will run a macro on the called party's channel (the queue member) once the parties are connected.</para>
<note> <para>NOTE: Macros are deprecated, GoSub should be used instead.</para>
<para>Macros are deprecated, GoSub should be used instead.</para>
</note>
</parameter> </parameter>
<parameter name="gosub"> <parameter name="gosub">
<para>Will run a gosub on the called party's channel (the queue member) once the parties are connected.</para> <para>Will run a gosub on the called party's channel (the queue member)
once the parties are connected. The subroutine execution starts in the
named context at the s exten and priority 1.</para>
</parameter> </parameter>
<parameter name="rule"> <parameter name="rule">
<para>Will cause the queue's defaultrule to be overridden by the rule specified.</para> <para>Will cause the queue's defaultrule to be overridden by the rule specified.</para>

Write Preview
Loading…
Cancel
Save