Add Python API docs

1 files changed, 83 insertions, 0 deletions

diff --git a/apidocs/python/src/prof.py b/apidocs/python/src/prof.py
new file mode 100644
index 00000000..0fa478fb
--- /dev/null
+++ b/apidocs/python/src/prof.py
@@ -0,0 +1,83 @@
+"""
+Profanity plugin API
+"""
+
+def cons_alert(): 
+    """
+    Highlights the console window in the status bar.
+    """
+    pass
+
+def cons_show(message): 
+    """
+    Show a message in the console.\n
+    *message*: The message to print\n 
+    Return: True on success, False on failure
+    """
+    pass
+
+def cons_show_themed(): 
+    """\n	
+    Show a message in the console, using the specified theme.
+    | Themes can be must be specified in ~/.local/share/profanity/plugin_themes\n
+    *group* The group name in the themes file, or NULL\n
+    *item* The item name within the group, or NULL\n
+    *def* A default colour if the theme cannot be found, or NULL\n
+    *message* the message to print\n
+    Return: True on success, False on failure
+    """
+    pass
+
+def cons_bad_cmd_usage(): 
+	pass
+
+def register_command(): 
+	pass
+
+def register_timed(): 
+	pass
+
+def register_ac(): 
+	pass
+
+def send_line(): 
+	pass
+
+def notify(): 
+	pass
+
+def get_current_recipient(): 
+	pass
+
+def get_current_muc(): 
+	pass
+
+def current_win_is_console(): 
+	pass
+
+def log_debug(): 
+	pass
+
+def log_info(): 
+	pass
+
+def log_warning(): 
+	pass
+
+def log_error(): 
+	pass
+
+def win_exists(): 
+	pass
+
+def win_create(): 
+	pass
+
+def win_focus(): 
+	pass
+
+def win_show(): 
+	pass
+
+def win_show_themed(): 
+	pass
\ No newline at end of file