Mercurial > prosody-wiki

comparison mod_adhoc.wiki @ 157:84cd497e50ff

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix typos, some better wording
author florob@babelmonkeys.de
date Sat, 16 Oct 2010 19:04:27 +0000
parents 15b9d9ce4ce3
children c929df198f10
comparison
equal deleted inserted replaced
156:15b9d9ce4ce3 157:84cd497e50ff
33 33
34 The data table has 4 fields: 34 The data table has 4 fields:
35 ||to||The to attribute of the stanza to be handled|| 35 ||to||The to attribute of the stanza to be handled||
36 ||from||The from attribute of the stanza to be handled|| 36 ||from||The from attribute of the stanza to be handled||
37 ||action||The action to be performed as specified in the stanza to be handled|| 37 ||action||The action to be performed as specified in the stanza to be handled||
38 ||form||If the to be handled stanza contains a form this will contains the form element|| 38 ||form||If the to be handled stanza contains a form this will contain the form element||
39 39
40 The handler should return to items. A data table and a state. 40 The handler should return two items. A data table and a state.
41 The state will be saved and passed to the handler on any adhoc stanza with the same sessionid. 41 The state will be saved and passed to the handler on invocation for any adhoc stanza with the same sessionid. If a session has ended the state returned should be nil.
42 42
43 The returned table can have the following fields: 43 The returned table can have the following fields:
44 ||*Name*||*Explanation*||*Required?*|| 44 ||*Name*||*Explanation*||*Required?*||
45 ||status||Status of the command (One of: completed, canceled, error)||yes|| 45 ||status||Status of the command (One of: "completed", "canceled", "error")||yes||
46 ||error||A table with the fields "type", "condition" and "message"||if status is "error"|| 46 ||error||A table with the fields "type", "condition" and "message"||when status is "error"||
47 ||info||Informational info for the user||no|| 47 ||info||Informational text for display to the user||no||
48 ||warn||A warning for the user||no|| 48 ||warn||A warning for the user||no||
49 ||actions||The actions avaiable to the client||no|| 49 ||actions||The actions avaiable to the client||no||
50 ||form||A form to be filled out by the user||no|| 50 ||form||A dataform to be filled out by the user||no||
51 ||result||A form of type result to be presented to the user||no|| 51 ||result||A dataform of type result to be presented to the user||no||
52 ||other||Any other XML to be included in the response to the user||no|| 52 ||other||Any other XML to be included in the response to the user||no||
53 53
54 For a simple module and details have a look at mod_adhoc_cmd_ping. 54 For a simple module and details have a look at mod_adhoc_cmd_ping.
55 55
56 = Compatibility = 56 = Compatibility =