kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-05 20:20:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

- Add ParkAndAnnounce() application XML documentation.

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@154615 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Eliel C. Sardanons
2008-11-05 13:51:16 +00:00
parent f18699be24
commit cb4ef23b12
1 changed files with 41 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
apps/app_parkandannounce.c
View File

@@ -43,29 +43,48 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/utils.h"
#include "asterisk/app.h"
/*** DOCUMENTATION
<application name="ParkAndAnnounce" language="en_US">
<synopsis>
Park and Announce.
</synopsis>
<syntax>
<parameter name="announce_template" required="true" argsep=":">
<argument name="announce" required="true">
<para>Colon-separated list of files to announce. The word
<literal>PARKED</literal> will be replaced by a say_digits of the extension in which
the call is parked.</para>
</argument>
<argument name="announce1" multiple="true" />
</parameter>
<parameter name="timeout" required="true">
<para>Time in seconds before the call returns into the return
context.</para>
</parameter>
<parameter name="dial" required="true">
<para>The app_dial style resource to call to make the
announcement. Console/dsp calls the console.</para>
</parameter>
<parameter name="return_context">
<para>The goto-style label to jump the call back into after
timeout. Default <literal>priority+1</literal>.</para>
</parameter>
</syntax>
<description>
<para>Park a call into the parkinglot and announce the call to another channel.</para>
<para>The variable <variable>PARKEDAT</variable> will contain the parking extension
into which the call was placed. Use with the Local channel to allow the dialplan to make
use of this information.</para>
</description>
<see-also>
<ref type="application">Park</ref>
<ref type="application">ParkedCall</ref>
</see-also>
</application>
***/
static char *app = "ParkAndAnnounce";
static char *synopsis = "Park and Announce";
static char *descrip =
" ParkAndAnnounce(announce:template,timeout,dial[,return_context]):\n"
"Park a call into the parkinglot and announce the call to another channel.\n"
"\n"
"announce template: Colon-separated list of files to announce. The word PARKED\n"
" will be replaced by a say_digits of the extension in which\n"
" the call is parked.\n"
"timeout: Time in seconds before the call returns into the return\n"
" context.\n"
"dial: The app_dial style resource to call to make the\n"
" announcement. Console/dsp calls the console.\n"
"return_context: The goto-style label to jump the call back into after\n"
" timeout. Default <priority+1>.\n"
"\n"
"The variable ${PARKEDAT} will contain the parking extension into which the\n"
"call was placed. Use with the Local channel to allow the dialplan to make\n"
"use of this information.\n";
static int parkandannounce_exec(struct ast_channel *chan, void *data)
{
int res = -1;
@@ -182,7 +201,7 @@ static int unload_module(void)
static int load_module(void)
{
/* return ast_register_application(app, park_exec); */
return ast_register_application(app, parkandannounce_exec, synopsis, descrip);
return ast_register_application_xml(app, parkandannounce_exec);
}
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Call Parking and Announce Application");