From 1b25aa84cb17fd52d1983701553de27e38ebf3eb Mon Sep 17 00:00:00 2001 From: James Booth Date: Thu, 19 Jan 2017 22:33:29 +0000 Subject: Add titlebar encryption text to plugins api --- apidocs/python/src/prof.py | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) (limited to 'apidocs/python') 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") + """ + -- cgit 1.4.1-2-gfad0