aboutsummaryrefslogtreecommitdiffstats
path: root/apidocs
diff options
context:
space:
mode:
Diffstat (limited to 'apidocs')
-rw-r--r--apidocs/c/profhooks.h6
-rw-r--r--apidocs/python/src/plugin.py6
2 files changed, 6 insertions, 6 deletions
diff --git a/apidocs/c/profhooks.h b/apidocs/c/profhooks.h
index d0beed28..cb14e794 100644
--- a/apidocs/c/profhooks.h
+++ b/apidocs/c/profhooks.h
@@ -61,7 +61,7 @@ void prof_post_chat_message_display(const char * const barejid, const char *cons
Called before a chat message is sent
@param barejid Jabber ID of the message recipient
@param message the message to be sent
-@return the new message to send, or NULL to preserve the original message
+@return the modified or original message to send, or NULL to cancel sending of the message
*/
char* prof_pre_chat_message_send(const char * const barejid, const char *message);
@@ -93,7 +93,7 @@ void prof_post_room_message_display(const char * const barejid, const char * con
Called before a chat room message is sent
@param barejid Jabber ID of the room
@param message the message to be sent
-@return the new message to send, or NULL to preserve the original message
+@return the modified or original message to send, or NULL to cancel sending of the message
*/
char* prof_pre_room_message_send(const char * const barejid, const char *message);
@@ -135,7 +135,7 @@ Called before a private chat room message is sent
@param barejid Jabber ID of the room
@param nick nickname of message recipient
@param message the message to be sent
-@return the new message to send, or NULL to preserve the original message
+@return the modified or original message to send, or NULL to cancel sending of the message
*/
char* prof_pre_priv_message_send(const char * const barejid, const char * const nick, const char *message);
diff --git a/apidocs/python/src/plugin.py b/apidocs/python/src/plugin.py
index 7e22d5e5..6e200bad 100644
--- a/apidocs/python/src/plugin.py
+++ b/apidocs/python/src/plugin.py
@@ -106,7 +106,7 @@ def prof_pre_chat_message_send(barejid, message):
:param message: the message to be sent
:type barejid: str or unicode
:type message: str or unicode
- :return: the new message to send, or ``None`` to preserve the original message
+ :return: the modified or original message to send, or ``None`` to cancel sending of the message
:rtype: str or unicode
"""
pass
@@ -158,7 +158,7 @@ def prof_pre_room_message_send(barejid, message):
:param message: the message to be sent
:type barejid: str or unicode
:type message: str or unicode
- :return: the new message to send, or ``None`` to preserve the original message
+ :return: the modified or original message to send, or ``None`` to cancel sending of the message
:rtype: str or unicode
"""
pass
@@ -227,7 +227,7 @@ def prof_pre_priv_message_send(barejid, nick, message):
:type barejid: str or unicode
:type nick: str or unicode
:type message: str or unicode
- :return: the new message to send, or ``None`` to preserve the original message
+ :return: the modified or original message to send, or ``None`` to cancel sending of the message
:rtype: str or unicode
"""
pass