diff options
| author | Matthew Jordan <mjordan@digium.com> | 2012-07-19 22:17:13 +0000 |
|---|---|---|
| committer | Matthew Jordan <mjordan@digium.com> | 2012-07-19 22:17:13 +0000 |
| commit | 86ff5585fd4de538c65bcbdce54cd9ef74b4e784 (patch) | |
| tree | ec6bdea2bbe0e590e472ef43d47fd51bd15d39d6 /main/message.c | |
| parent | f80278792480fe432a32608773f172576dc84839 (diff) | |
Add the ability to specify technology specific documentation
A number of applications/AMI commands in Asterisk have specific behavioral
differences depending on the resource or channel technology those
applications are executed on. For example, the MessageSend application/
command is technology agnostic, but how the channel drivers that support
that functionality behave is dependant on the protocols and channel
driver implementation. Prior to this patch, those details were either
documented in the application/command documentation itself, or were left
undocumented.
This patch adds a new element to the documentation schema, <info/>. An info
node is essentially a piece of technology specific reference information that
can be included by any top level XML documentation node. For example, the
MessageSend application can now include XMPP/SIP specific information, where
that technology specific information can be defined in chan_motif/res_xmpp/
chan_sip. Likewise, that information can also be included in the MessageSend
AMI command.
Review: https://reviewboard.asterisk.org/r/2049
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@370278 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'main/message.c')
| -rw-r--r-- | main/message.c | 19 |
1 files changed, 9 insertions, 10 deletions
diff --git a/main/message.c b/main/message.c index b79ec0d6b..1ac9231e3 100644 --- a/main/message.c +++ b/main/message.c @@ -122,20 +122,20 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <syntax> <parameter name="to" required="true"> <para>A To URI for the message.</para> + <xi:include xpointer="xpointer(/docs/info[@name='SIPMessageToInfo'])" /> + <xi:include xpointer="xpointer(/docs/info[@name='XMPPMessageToInfo'])" /> </parameter> <parameter name="from" required="false"> <para>A From URI for the message if needed for the message technology being used to send this message.</para> - <note> - <para>For SIP the from parameter can be a configured peer name - or in the form of "display-name" <URI>.</para> - </note> + <xi:include xpointer="xpointer(/docs/info[@name='SIPMessageFromInfo'])" /> </parameter> </syntax> <description> <para>Send a text message. The body of the message that will be - sent is what is currently set to <literal>MESSAGE(body)</literal>.</para> - + sent is what is currently set to <literal>MESSAGE(body)</literal>. + The technology chosen for sending the message is determined + based on a prefix to the <literal>to</literal> parameter.</para> <para>This application sets the following channel variables:</para> <variablelist> <variable name="MESSAGE_SEND_STATUS"> @@ -164,14 +164,13 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> <parameter name="To" required="true"> <para>The URI the message is to be sent to.</para> + <xi:include xpointer="xpointer(/docs/info[@name='SIPMessageToInfo'])" /> + <xi:include xpointer="xpointer(/docs/info[@name='XMPPMessageToInfo'])" /> </parameter> <parameter name="From"> <para>A From URI for the message if needed for the message technology being used to send this message.</para> - <note> - <para>For SIP the from parameter can be a configured peer name - or in the form of "display-name" <URI>.</para> - </note> + <xi:include xpointer="xpointer(/docs/info[@name='SIPMessageFromInfo'])" /> </parameter> <parameter name="Body"> <para>The message body text. This must not contain any newlines as that |