summaryrefslogtreecommitdiff
path: root/doc/en/plugins.txt
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2011-11-09 23:17:20 +0100
committermathieui <mathieui@mathieui.net>2011-11-09 23:17:20 +0100
commitb43a2ff4a23ae0bc032ac704e504db44daa76022 (patch)
tree70ac4fd11af5abf74e53f716d2877e8239d5c111 /doc/en/plugins.txt
parent4e0c1b0820432460750ea69c5bdeb47670f4c013 (diff)
downloadpoezio-b43a2ff4a23ae0bc032ac704e504db44daa76022.tar.gz
poezio-b43a2ff4a23ae0bc032ac704e504db44daa76022.tar.bz2
poezio-b43a2ff4a23ae0bc032ac704e504db44daa76022.tar.xz
poezio-b43a2ff4a23ae0bc032ac704e504db44daa76022.zip
Doc for the new events
Diffstat (limited to 'doc/en/plugins.txt')
-rw-r--r--doc/en/plugins.txt60
1 files changed, 48 insertions, 12 deletions
diff --git a/doc/en/plugins.txt b/doc/en/plugins.txt
index 6e829d5f..32fe45c3 100644
--- a/doc/en/plugins.txt
+++ b/doc/en/plugins.txt
@@ -123,45 +123,81 @@ The handlers for this event are called whenever you say something in a MUC
(through the /say command or by direct input). The parameters given to the
handlers are:
-* _message_: Message to be sent
-* _tab_: Tab in which the message will be sent
+* _message_: Message to be sent.
+* _tab_: Tab in which the message will be sent.
*private_say*:: +message+, +tab+ +
The handlers for this event are called whenever you say something in a private
conversaton in a MUC (through the /say command or by direct input). The
parameters given to the handlers are:
-* _message_: Message to be sent
-* _tab_: Tab in which the message will be sent
+* _message_: Message to be sent.
+* _tab_: Tab in which the message will be sent.
*conversation_say*:: +message+, +tab+ +
The handlers for this event are called whenever you say something in direct
conversation (through the /say command or by direct input). The parameters
given to the handler are:
-* _message_: Message to be sent
-* _tab_: Tab in which the message will be sent
+* _message_: Message to be sent.
+* _tab_: Tab in which the message will be sent.
*muc_msg*:: +message+, +tab+ +
The handlers for this event are called whenever you receive a message in a MUC.
The parameters given to the handler are:
-* _message_: Message received
-* _tab_: Tab in which the message was received
+* _message_: Message received.
+* _tab_: Tab in which the message was received.
*private_msg*:: +message+, +tab+ +
The handlers for this event are called whenever you receive a message in a
private conversation in a MUC. The parameters given to the handler are:
-* _message_: Message received
-* _tab_: Tab in which the message was received
+* _message_: Message received.
+* _tab_: Tab in which the message was received.
*conversation_msg*:: +message+, +tab+ +
The handlers for this event are called whenever you receive a message in a
direct conversation. The parameters given to the handler are:
-* _message_: Message received
-* _tab_: Tab in which the message was received
+* _message_: Message received.
+* _tab_: Tab in which the message was received.
+
+*normal_chatstate*:: +message+, +tab+ +
+The handlers for this events are called whenever you receive a chatstate in a
+ direct conversation. The parameters given to this handler are:
+
+* _message_: Chatstate received.
+* _tab_: Tab of the concerned conversation
+
+*muc_chatstate*:: +message+, +tab+ +
+The handlers for this events are called whenever you receive a chatstate in a
+ MUC. The parameters given to this handler are:
+
+* _message_: Chatstate received.
+* _tab_: Tab of the concerned MUC.
+
+*private_chatstate*:: +message+, +tab+ +
+The handlers for this events are called whenever you receive a chatstate in a
+ private conversation in a MUC. The parameters given to this handler are:
+
+* _message_: Chatstate received.
+* _tab_: Tab of the concerned conversation.
+
+*normal_presence*:: +presence+, +resource+ +
+The handlers for this events are called whenever you receive a presence from
+ one of your contacts. The parameters given to this handler are:
+
+* _presence_: Presence received.
+* _resource_: The resource that emitted the presence.
+
+*muc_presence*:: +presence+, +tab+ +
+The handlers for this events are called whenever you receive a presence from
+ someone in a MUC. The parameters given to this handler are:
+
+* _presence_: Presence received.
+* _tab_: Tab of the concerned MUC.
+
CAUTION: Plugins are in an experimental state and this API might change
slightly in a near future. You have to be aware of that while making a plugin.