about summary refs log tree commit diff stats
path: root/apidocs/python
diff options
context:
space:
mode:
authorJames Booth <boothj5@gmail.com>2017-01-19 22:33:29 +0000
committerJames Booth <boothj5@gmail.com>2017-01-19 22:33:29 +0000
commit1b25aa84cb17fd52d1983701553de27e38ebf3eb (patch)
tree7e578e98be237b37ac76f3186a0bdd11543d9452 /apidocs/python
parent68496db0b427a18c09c00fb47264c3aea352393e (diff)
downloadprofani-tty-1b25aa84cb17fd52d1983701553de27e38ebf3eb.tar.gz
Add titlebar encryption text to plugins api
Diffstat (limited to 'apidocs/python')
-rw-r--r--apidocs/python/src/prof.py32
1 files changed, 32 insertions, 0 deletions
diff --git a/apidocs/python/src/prof.py b/apidocs/python/src/prof.py
index 22488f4b..64468eb0 100644
--- a/apidocs/python/src/prof.py
+++ b/apidocs/python/src/prof.py
@@ -630,3 +630,35 @@ def encryption_reset(barejid):
     ::
         prof.encryption_reset("alice@server.org")
     """
+
+
+def chat_set_titlebar_enctext(barejid, enctext):
+    """Set the text to display in the titlebar encryption indicator.
+
+    :param barejid: Jabber ID of the recipient
+    :param enctext: The text to display
+    :type barejid: str or unicode
+    :type enctext: str or unicode
+    :return: ``True`` if the text was set successfully, ``False`` otherwise
+    :rtype: boolean
+
+    
+    Example:
+    ::
+        prof.chat_set_titlebar_enctext("bob@chat.org", "safe")
+    """
+
+
+def chat_unset_titlebar_enctext(barejid):
+    """Let profanity decide what to show in the titlebar encryption indicator.
+
+    :param barejid: Jabber ID of the recipient
+    :type barejid: str or unicode
+    :return: ``True`` if the text was unset successfully, ``False`` otherwise
+    :rtype: boolean
+
+    Example:
+    ::
+        prof.chat_unset_titlebar_enctext("bob@chat.org")
+    """
+