Add titlebar encryption text to plugins api

This commit is contained in:
James Booth
2017-01-19 22:33:29 +00:00
parent 68496db0b4
commit 1b25aa84cb
14 changed files with 219 additions and 14 deletions

View File

@@ -339,3 +339,19 @@ End any encrypted session with the specified user.
@param barejid Jabber ID of the recipient
*/
void prof_encryption_reset(char *barejid);
/**
Set the text to display in the titlebar encryption indicator.
@param barejid Jabber ID of the recipient
@param enctext The text to display
@return 1 on success, 0 on failure
*/
int prof_chat_set_titlebar_enctext(char *barejid, char *enctext);
/**
Let profanity decide what to show in the titlebar encryption indicator
@param barejid Jabber ID of the recipient
@return 1 on success, 0 on failure
*/
int prof_chat_unset_titlebar_enctext(char *barejid);

View File

@@ -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")
"""