Update Pickup application documentation. (Even better)

........

Merged revisions 363875 from http://svn.asterisk.org/svn/asterisk/branches/1.8
........

Merged revisions 363876 from http://svn.asterisk.org/svn/asterisk/branches/10


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@363877 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Richard Mudgett 2012-04-26 03:12:44 +00:00
parent e736a4fed3
commit 9d655bd0e8
1 changed files with 20 additions and 11 deletions

View File

@ -57,26 +57,35 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</synopsis> </synopsis>
<syntax> <syntax>
<parameter name="targets" argsep="&amp;"> <parameter name="targets" argsep="&amp;">
<argument name="exten" argsep="@" required="true"> <argument name="extension" argsep="@" required="true">
<para>Specification of the pickup target.</para>
<argument name="extension" required="true"/> <argument name="extension" required="true"/>
<argument name="context" /> <argument name="context" />
</argument> </argument>
<argument name="exten2" argsep="@" multiple="true"> <argument name="extension2" argsep="@" multiple="true">
<para>Additional specifications of pickup targets.</para>
<argument name="extension2" required="true"/> <argument name="extension2" required="true"/>
<argument name="context2"/> <argument name="context2"/>
</argument> </argument>
</parameter> </parameter>
</syntax> </syntax>
<description> <description>
<para>This application can pickup any ringing channel that is calling <para>This application can pickup a specified ringing channel. The channel
the specified dialplan <replaceable>extension</replaceable>. If no dialplan to pickup can be specified in the following ways.</para>
<replaceable>context</replaceable> is specified, the current context will be <para>1) If no <replaceable>extension</replaceable> targets are specified,
used. If you use the special string <literal>PICKUPMARK</literal> the application will pickup a channel matching the pickup group of the
for the context, for example 10@PICKUPMARK, this application tries to find a requesting channel.</para>
channel which has defined a channel variable <variable>PICKUPMARK</variable> <para>2) If the <replaceable>extension</replaceable> is specified with a
with the same value as <replaceable>extension</replaceable> (in this example, <replaceable>context</replaceable> of the special string
<literal>10</literal>). When no parameter is specified, the application will <literal>PICKUPMARK</literal> (for example 10@PICKUPMARK), the application
pickup a channel matching the pickup group of the active channel.</para> will pickup a channel which has defined a channel variable
<variable>PICKUPMARK</variable> with the same value as
<replaceable>extension</replaceable> (in this example,
<literal>10</literal>).</para>
<para>3) If the <replaceable>extension</replaceable> is specified
with a <replaceable>context</replaceable>, the channel executing at that
dialplan location will be picked up. If no <replaceable>context</replaceable>
is specified, the current context will be used.</para>
</description> </description>
</application> </application>
<application name="PickupChan" language="en_US"> <application name="PickupChan" language="en_US">