From be4798f0b3afd2c8732b6766a5832cf94ef7617a Mon Sep 17 00:00:00 2001 From: "Eliel C. Sardanons" Date: Sat, 23 May 2009 21:11:31 +0000 Subject: Move static AGI commands documentation to XML. Move AGI commands ('say datetime', 'send image', 'send text', 'set autohangup', 'set callerid', 'set context', 'set extension') documentation to the AstXML form. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@196554 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- res/res_agi.c | 162 ++++++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 111 insertions(+), 51 deletions(-) diff --git a/res/res_agi.c b/res/res_agi.c index adf42651c..207befb7e 100644 --- a/res/res_agi.c +++ b/res/res_agi.c @@ -443,6 +443,110 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") one was pressed or -1 on error/hangup. + + + Says a given time as specfied by the format given. + + + + Is number of seconds elapsed since 00:00:00 + on January 1, 1970, Coordinated Universal Time (UTC) + + + + Is the format the time should be said in. See + voicemail.conf (defaults to ABdY + 'digits/at' IMp). + + + Acceptable values can be found in /usr/share/zoneinfo + Defaults to machine default. + + + + Say a given time, returning early if any of the given DTMF digits are + received on the channel. Returns 0 if playback + completes without a digit being pressed, or the ASCII numerical value of the + digit if one was pressed or -1 on error/hangup. + + + + + Sends images to channels supporting it. + + + + + + Sends the given image on a channel. Most channels do not support the + transmission of images. Returns 0 if image is sent, or if + the channel does not support image transmission. Returns -1 + only on error/hangup. Image names should not include extensions. + + + + + Sends text to channels supporting it. + + + + Text consisting of greater than one word should be placed + in quotes since the command only accepts a single argument. + + + + Sends the given text on a channel. Most channels do not support the + transmission of text. Returns 0 if text is sent, or if the + channel does not support text transmission. Returns -1 only + on error/hangup. + + + + + Autohangup channel in some time. + + + + + + Cause the channel to automatically hangup at time + seconds in the future. Of course it can be hungup before then as well. Setting to + 0 will cause the autohangup feature to be disabled on this channel. + + + + + Sets callerid for the current channel. + + + + + + Changes the callerid of the current channel. + + + + + Sets channel context. + + + + + + Sets the context for continuation upon exiting the application. + + + + + Changes channel extension. + + + + + + Changes the extension for continuation upon exiting the application. + + Enable/Disable Music on hold generator @@ -2462,10 +2566,6 @@ static const char usage_verbose[] = static const char usage_setvariable[] = " Usage: SET VARIABLE \n"; -static const char usage_setcallerid[] = -" Usage: SET CALLERID \n" -" Changes the callerid of the current channel.\n"; - static const char usage_waitfordigit[] = " Usage: WAIT FOR DIGIT \n" " Waits up to 'timeout' milliseconds for channel to receive a DTMF digit.\n" @@ -2473,26 +2573,11 @@ static const char usage_waitfordigit[] = " the numerical value of the ascii of the digit if one is received. Use -1\n" " for the timeout value if you desire the call to block indefinitely.\n"; -static const char usage_sendtext[] = -" Usage: SEND TEXT \"\"\n" -" Sends the given text on a channel. Most channels do not support the\n" -" transmission of text. Returns 0 if text is sent, or if the channel does not\n" -" support text transmission. Returns -1 only on error/hangup. Text\n" -" consisting of greater than one word should be placed in quotes since the\n" -" command only accepts a single argument.\n"; - static const char usage_tddmode[] = " Usage: TDD MODE \n" " Enable/Disable TDD transmission/reception on a channel. Returns 1 if\n" " successful, or 0 if channel is not TDD-capable.\n"; -static const char usage_sendimage[] = -" Usage: SEND IMAGE \n" -" Sends the given image on a channel. Most channels do not support the\n" -" transmission of images. Returns 0 if image is sent, or if the channel does not\n" -" support image transmission. Returns -1 only on error/hangup. Image names\n" -" should not include extensions.\n"; - static const char usage_streamfile[] = " Usage: STREAM FILE [sample offset]\n" " Send the given file, allowing playback to be interrupted by the given\n" @@ -2513,36 +2598,11 @@ static const char usage_controlstreamfile[] = " extension must not be included in the filename.\n\n" " Note: ffchar and rewchar default to * and # respectively.\n"; -static const char usage_saydatetime[] = -" Usage: SAY DATETIME