aniani/profanity
0
1
Fork 0
mirror of https://github.com/profanity-im/profanity.git synced 2025-10-28 14:17:26 -04:00
Code Activity

Allow chat prefix char to be set by plugins

Browse Source
This commit is contained in:
James Booth
2017-01-20 21:03:55 +00:00
parent ab1441a25c
commit c8874cd2e0
13 changed files with 373 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
apidocs/python/src/prof.py
View File

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