From a308f5e4f11d2c30109a2587f4f7a2d5d487f01a Mon Sep 17 00:00:00 2001
From: James Booth <boothj5@gmail.com>
Date: Fri, 29 Jul 2016 00:27:14 +0100
Subject: Add python plugin hook docs

---
 apidocs/python/src/plugin.py | 119 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 119 insertions(+)
 create mode 100644 apidocs/python/src/plugin.py

(limited to 'apidocs/python/src/plugin.py')

diff --git a/apidocs/python/src/plugin.py b/apidocs/python/src/plugin.py
new file mode 100644
index 00000000..ab7df146
--- /dev/null
+++ b/apidocs/python/src/plugin.py
@@ -0,0 +1,119 @@
+"""
+Profanity plugin Hooks
+"""
+
+def prof_init(version, status, account_name, fulljid):
+    pass
+
+
+def prof_on_start():
+    pass
+
+
+def prof_on_shutdown():
+    pass
+
+
+def prof_on_unload():
+    pass
+
+
+def prof_on_connect(account_name, fulljid):
+    pass
+
+
+def prof_on_disconnect(account_name, fulljid):
+    pass
+
+
+def prof_pre_chat_message_display(jid, message):
+    pass
+
+
+def prof_post_chat_message_display(jid, message):
+    pass
+
+
+def prof_pre_chat_message_send(jid, message):
+    pass
+
+
+def prof_post_chat_message_send(jid, message):
+    pass
+
+
+def prof_pre_room_message_display(room, nick, message):
+    pass
+
+
+def prof_post_room_message_display(room, nick, message):
+    pass
+
+
+def prof_pre_room_message_send(room, message):
+    pass
+
+
+def prof_post_room_message_send(room, message):
+    pass
+
+
+def prof_on_room_history_message(room, nick, message, timestamp):
+    pass
+
+
+def prof_pre_priv_message_display(room, nick, message):
+    pass
+
+
+def prof_post_priv_message_display(room, nick, message):
+    pass
+
+
+def prof_pre_priv_message_send(room, nick, message):
+    pass
+
+
+def prof_post_priv_message_send(room, nick, message):
+    pass
+
+
+def prof_on_message_stanza_send(stanza):
+    pass
+
+
+def prof_on_message_stanza_receive(stanza):
+    pass
+
+
+def prof_on_presence_stanza_send(stanza):
+    pass
+
+
+def prof_on_presence_stanza_receive(stanza):
+    pass
+
+
+def prof_on_iq_stanza_send(stanza):
+    pass
+
+
+def prof_on_iq_stanza_receive(stanza):
+    pass
+
+
+def prof_on_contact_offline(barejid, resource, status):
+    pass
+
+
+def prof_on_contact_presence(barejid, resource, presence, status, priority):
+    pass
+
+
+def prof_on_chat_win_focus(barejid):
+    pass
+
+
+def prof_on_room_win_focus(roomjid):
+    pass
+
-- 
cgit 1.4.1-2-gfad0