From c8874cd2e0c7a62eff66cb19acd40e36750d1b50 Mon Sep 17 00:00:00 2001 From: James Booth Date: Fri, 20 Jan 2017 21:03:55 +0000 Subject: Allow chat prefix char to be set by plugins --- apidocs/python/src/prof.py | 62 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) (limited to 'apidocs/python') diff --git a/apidocs/python/src/prof.py b/apidocs/python/src/prof.py index 64468eb0..d65aa580 100644 --- a/apidocs/python/src/prof.py +++ b/apidocs/python/src/prof.py @@ -662,3 +662,65 @@ def chat_unset_titlebar_enctext(barejid): prof.chat_unset_titlebar_enctext("bob@chat.org") """ + +def chat_set_incoming_char(barejid, ch): + """Set the incoming message prefix character for specified contact. + + :param barejid: Jabber ID of the recipient + :param enctext: The character to display + :type barejid: str or unicode + :type enctext: str or unicode + :return: ``True`` if the character was set successfully, ``False`` otherwise + :rtype: boolean + + + Example: + :: + prof.chat_set_incoming_char("kristine@chat.org", "*") + """ + + +def chat_unset_incoming_char(barejid): + """Reset the incoming message prefix character for specified contact. + + :param barejid: Jabber ID of the recipient + :type barejid: str or unicode + :return: ``True`` if the char was unset successfully, ``False`` otherwise + :rtype: boolean + + Example: + :: + prof.chat_unset_incoming_char("kristine@chat.org") + """ + + +def chat_set_outgoing_char(barejid, ch): + """Set the outgoing message prefix character for specified contact. + + :param barejid: Jabber ID of the recipient + :param enctext: The character to display + :type barejid: str or unicode + :type enctext: str or unicode + :return: ``True`` if the character was set successfully, ``False`` otherwise + :rtype: boolean + + + Example: + :: + prof.chat_set_outgoing_char("david@chat.org", "+") + """ + + +def chat_unset_outgoing_char(barejid): + """Reset the outgoing message prefix character for specified contact. + + :param barejid: Jabber ID of the recipient + :type barejid: str or unicode + :return: ``True`` if the char was unset successfully, ``False`` otherwise + :rtype: boolean + + Example: + :: + prof.chat_unset_outgoing_char("david@chat.org") + """ + -- cgit