annotate mod_adhoc.wiki @ 9:8739493ced0d

Created wiki page through web user interface.
author t.ephraim
date Fri, 25 Sep 2009 14:42:33 +0000
parents
children eabbd329830c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
1 #summary mod_adhoc
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
2
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
3 = Introduction =
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
4
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
5 implementation of [http://xmpp.org/extensions/xep-0050.html XEP-0050: Ad-Hoc Commands].
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
6
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
7
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
8
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
9 = Details =
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
10
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
11 It will offer any adhoc command which is registered with "module:add_item("adhoc", ....".
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
12
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
13
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
14
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
15 = Usage =
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
16 Load mod_adhoc and then any module which provides an adhoc command, such as
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
17 mod_adhoc_cmd_ping.
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
18
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
19 If you want to build your own adhoc command, just register your adhoc command module with
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
20 module:add_item and a dictonary with name, node and a handler.
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
21
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
22 e.g.
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
23 {{{
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
24 module:add_item ("adhoc", { name="Ping", node="ping", handler=ping_command_handler });
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
25 }}}
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
26
8739493ced0d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
27 Or have a look into mod_adhoc_cmd_ping for better details.