diff options
author | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2009-05-22 17:52:35 +0000 |
---|---|---|
committer | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2009-05-22 17:52:35 +0000 |
commit | cbbfdc573c6f071b12dc665273c0063a0c69ad69 (patch) | |
tree | e1c6ca80d913c0e0aa3166a40d7b8e4461cd62d1 /apps/app_meetme.c | |
parent | c208610d90db5a241e187413c831309cd5f13f32 (diff) |
Implement a new element in AstXML for AMI actions documentation.
A new xml element was created to manage the AMI actions documentation,
using AstXML.
To register a manager action using XML documentation it is now possible
using ast_manager_register_xml().
The CLI command 'manager show command' can be used to show the parsed
documentation.
Example manager xml documentation:
<manager name="ami action name" language="en_US">
<synopsis>
AMI action synopsis.
</synopsis>
<syntax>
<xi:include xpointer="xpointer(...)" /> <-- for ActionID
<parameter name="header1" required="true">
<para>Description</para>
</parameter>
...
</syntax>
<description>
<para>AMI action description</para>
</description>
<see-also>
...
</see-also>
</manager>
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@196308 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'apps/app_meetme.c')
-rw-r--r-- | apps/app_meetme.c | 57 |
1 files changed, 43 insertions, 14 deletions
diff --git a/apps/app_meetme.c b/apps/app_meetme.c index ba278ba76..db5c39103 100644 --- a/apps/app_meetme.c +++ b/apps/app_meetme.c @@ -420,6 +420,46 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") </variablelist> </description> </application> + <manager name="MeetmeMute" language="en_US"> + <synopsis> + Mute a Meetme user. + </synopsis> + <syntax> + <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> + <parameter name="Meetme" required="true" /> + <parameter name="Usernum" required="true" /> + </syntax> + <description> + </description> + </manager> + <manager name="MeetmeUnmute" language="en_US"> + <synopsis> + Unmute a Meetme user. + </synopsis> + <syntax> + <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> + <parameter name="Meetme" required="true" /> + <parameter name="Usernum" required="true" /> + </syntax> + <description> + </description> + </manager> + <manager name="MeetmeList" language="en_US"> + <synopsis> + List participants in a conference. + </synopsis> + <syntax> + <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> + <parameter name="Conference" required="true"> + <para>Conference number.</para> + </parameter> + </syntax> + <description> + <para>Lists all users in a particular MeetMe conference. + MeetmeList will follow as separate events, followed by a final event called + MeetmeListComplete.</para> + </description> + </manager> ***/ #define CONFIG_FILE_NAME "meetme.conf" @@ -4236,14 +4276,6 @@ static int action_meetmeunmute(struct mansession *s, const struct message *m) return meetmemute(s, m, 0); } -static const char mandescr_meetmelist[] = -"Description: Lists all users in a particular MeetMe conference.\n" -"MeetmeList will follow as separate events, followed by a final event called\n" -"MeetmeListComplete.\n" -"Variables:\n" -" *ActionId: <id>\n" -" *Conference: <confno>\n"; - static int action_meetmelist(struct mansession *s, const struct message *m) { const char *actionid = astman_get_header(m, "ActionID"); @@ -6418,12 +6450,9 @@ static int load_module(void) res |= load_config(0); ast_cli_register_multiple(cli_meetme, ARRAY_LEN(cli_meetme)); - res |= ast_manager_register("MeetmeMute", EVENT_FLAG_CALL, - action_meetmemute, "Mute a Meetme user"); - res |= ast_manager_register("MeetmeUnmute", EVENT_FLAG_CALL, - action_meetmeunmute, "Unmute a Meetme user"); - res |= ast_manager_register2("MeetmeList", EVENT_FLAG_REPORTING, - action_meetmelist, "List participants in a conference", mandescr_meetmelist); + res |= ast_manager_register_xml("MeetmeMute", EVENT_FLAG_CALL, action_meetmemute); + res |= ast_manager_register_xml("MeetmeUnmute", EVENT_FLAG_CALL, action_meetmeunmute); + res |= ast_manager_register_xml("MeetmeList", EVENT_FLAG_REPORTING, action_meetmelist); res |= ast_register_application_xml(app4, channel_admin_exec); res |= ast_register_application_xml(app3, admin_exec); res |= ast_register_application_xml(app2, count_exec); |