Conversation Signals

Signals:

See Also
conversation.h

writing-im-msg

gboolean (*writing_im_msg)(PurpleAccount *account, const char *who,
char **message, PurpleConversation *conv,
Description:
Emitted before a message is written in an IM conversation. If the message is changed, then the changed message is displayed and logged instead of the original message.
Note
Make sure to free *message before you replace it!
Parameters
accountThe account.
whoThe name of the user.
messageA pointer to the message.
convThe conversation.
flagsFlags for this message.
Returns
TRUE if the message should be canceled, or FALSE otherwise.

wrote-im-msg

void (*wrote_im_msg)(PurpleAccount *account, const char *who,
char *message, PurpleConversation *conv,
Description:
Emitted after a message is written and possibly displayed in a conversation.
Parameters
accountThe account.
whoThe name of the user.
messageThe message.
convThe conversation.
flagsFlags for this message.

sending-im-msg

void (*sending_im_msg)(PurpleAccount *account, const char *receiver,
char **message);
Description:
Emitted before sending an IM to a user. message is a pointer to the message string, so the plugin can replace the message before being sent.
Note
Make sure to free *message before you replace it!
Parameters
accountThe account the message is being sent on.
receiverThe username of the receiver.
messageA pointer to the outgoing message. This can be modified.

sent-im-msg

void (*sent_im_msg)(PurpleAccount *account, const char *receiver,
const char *message);
Description:
Emitted after sending an IM to a user.
Parameters
accountThe account the message was sent on.
receiverThe username of the receiver.
messageThe message that was sent.

receiving-im-msg

gboolean (*receiving_im_msg)(PurpleAccount *account, char **sender,
char **message, PurpleConversation *conv,
Description:
Emitted when an IM is received. The callback can replace the name of the sender, the message, or the flags by modifying the pointer to the strings and integer. This can also be used to cancel a message by returning TRUE.
Note
Make sure to free *sender and *message before you replace them!
Returns
TRUE if the message should be canceled, or FALSE otherwise.
Parameters
accountThe account the message was received on.
senderA pointer to the username of the sender.
messageA pointer to the message that was sent.
convThe IM conversation.
flagsA pointer to the IM message flags.

received-im-msg

void (*received_im_msg)(PurpleAccount *account, char *sender, char *message,
Description:
Emitted after an IM is received.
Parameters
accountThe account the message was received on.
senderThe username of the sender.
messageThe message that was sent.
convThe IM conversation.
flagsThe IM message flags.

blocked-im-msg

void (*blocked_im_msg)(PurpleAccount *account, const char *sender,
const char *message, PurpleMessageFlags flags, time_t when);
Description:
Emitted after an IM is blocked due to privacy settings.
Parameters
accountThe account the message was received on.
senderThe username of the sender.
messageThe message that was blocked.
flagsThe IM message flags.
whenThe time the message was sent.
Since
2.5.0

writing-chat-msg

gboolean (*writing_chat_msg)(PurpleAccount *account, const char *who,
char **message, PurpleConversation *conv,
Description:
Emitted before a message is written in a chat conversation. If the message is changed, then the changed message is displayed and logged instead of the original message.
Note
Make sure to free *message before you replace it!
Parameters
accountThe account.
whoThe name of the user.
messageA pointer to the message.
convThe conversation.
flagsFlags for this message.
Returns
TRUE if the message should be canceled, or FALSE otherwise.

wrote-chat-msg

void (*wrote_chat_msg)(PurpleAccount *account, const char *who,
char *message, PurpleConversation *conv,
Description:
Emitted after a message is written and possibly displayed in a chat.
Parameters
accountThe account.
whoThe name of the user.
messageThe message.
convThe conversation.
flagsFlags for this message.

sending-chat-msg

void (*sending_chat_msg)(PurpleAccount *account, char **message, int id);
Description:
Emitted before sending a message to a chat. message is a pointer to the message string, so the plugin can replace the message before being sent.
Note
Make sure to free *message before you replace it!
Parameters
accountThe account the message is being sent on.
messageA pointer to the message that will be sent.
idThe ID of the chat.

sent-chat-msg

void (*sent_chat_msg)(PurpleAccount *account, const char *message, int id);
Description:
Emitted after sending a message to a chat.
Parameters
accountThe account the message was sent on.
messageThe message that was sent.
idThe ID of the chat.

receiving-chat-msg

gboolean (*receiving_chat_msg)(PurpleAccount *account, char **sender,
char **message, PurpleConversation *conv, int *flags);
Description:
Emitted when a chat message is received. The callback can replace the name of the sender, the message, or the flags by modifying the pointer to the strings. This can also be used to cancel displaying a message by returning TRUE.
Note
Make sure to free *sender and *message before you replace them!
Returns
TRUE if the message should be canceled, or FALSE otherwise.
Parameters
accountThe account the message was received on.
senderA pointer to the username of the sender.
messageA pointer to the message that was sent.
convThe chat conversation.
flagsA pointer to the chat message flags

received-chat-msg

void (*received_chat_msg)(PurpleAccount *account, char *sender, char *message,
Description:
Emitted after a chat message is received.
Parameters
accountThe account the message was received on.
senderThe username of the sender.
messageThe message that was sent.
convThe chat conversation.
flagsThe chat message flags.

conversation-created

void (*conversation_created)(PurpleConversation *conv);
Description:
Emitted when a new conversation is created.
Parameters
convThe new conversation.

conversation-updated

void (*conversation_updated)(PurpleConversation *conv,
Description:
Emitted when a conversation is updated.
Parameters
convThe conversation that was updated.
typeThe type of update that was made.

deleting-conversation

void (*deleting_conversation)(PurpleConversation *conv);
Description:
Emitted just before a conversation is to be destroyed.
Parameters
convThe conversation that's about to be destroyed.

buddy-typing

void (*buddy_typing)(PurpleAccount *account, const char *name);
Description:
Emitted when a buddy starts typing in a conversation window.
Parameters
accountThe account of the user which is typing.
nameThe name of the user which is typing.

buddy-typing-stopped

void (*buddy_typing_stopped)(PurpleAccount *account, const char *name);
Description:
Emitted when a buddy stops typing in a conversation window.
Parameters
accountThe account of the user which stopped typing.
nameThe name of the user which stopped typing.

chat-buddy-joining

gboolean (*chat_buddy_joining)(PurpleConversation *conv, const char *name,
Description:
Emitted when a buddy is joining a chat, before the list of users in the chat updates to include the new user.
Returns
TRUE if the join should be hidden, or FALSE otherwise.
Parameters
convThe chat conversation.
nameThe name of the user that is joining the conversation.
flagsThe flags of the user that is joining the conversation.

chat-buddy-joined

void (*chat_buddy_joined)(PurpleConversation *conv, const char *name,
gboolean new_arrival);
Description:
Emitted when a buddy joined a chat, after the users list is updated.
Parameters
convThe chat conversation.
nameThe name of the user that has joined the conversation.
flagsThe flags of the user that has joined the conversation.
new_arrivalIf the buddy is a new arrival.

chat-join-failed

void (*chat_join_failed)(PurpleConnection *gc, GHashTable *components);
Description:
Emitted when an account fails to join a chat room
Parameters
gcThe PurpleConnection of the account which failed to join the chat.
dataThe components passed to serv_join_chat() originally. The hash function should be g_str_hash() and the equal function should be g_str_equal().

chat-buddy-flags

void (*chat_buddy_flags)(PurpleConversation *conv, const char *name,
Description:
Emitted when a user in a chat changes flags.
Parameters
convThe chat conversation.
nameThe name of the user.
oldflagsThe old flags.
newflagsThe new flags.

chat-buddy-leaving

gboolean (*chat_buddy_leaving)(PurpleConversation *conv, const char *name,
const char *reason);
Description:
Emitted when a user is leaving a chat, before the user list is updated. This may include an optional reason why the user is leaving.
Returns
TRUE if the leave should be hidden, or FALSE otherwise.
Parameters
convThe chat conversation.
nameThe name of the user that is leaving the chat.
reasonThe optional reason why the user is leaving.

chat-buddy-left

void (*chat_buddy_left)(PurpleConversation *conv, const char *name,
const char *reason);
Description:
Emitted when a user leaves a chat, after the user list is updated. This may include an optional reason why the user is leaving.
Parameters
convThe chat conversation.
nameThe name of the user that left the chat.
reasonThe optional reason why the user left the chat.

chat-inviting-user

void (*chat_inviting_user)(PurpleConversation *conv, const char *name,
char **invite_message);
Description:
Emitted when a user is being invited to the chat. The callback can replace the invite message to the invitee by modifying the pointer to the invite message.
Note
Make sure to free *invite_message before you replace it!
Parameters
convThe chat conversation.
nameThe name of the user being invited.
invite_messageA pointer to the reason why a user is being invited.

chat-invited-user

void (*chat_invited_user)(PurpleConversation *conv, const char *name,
const char *invite_message);
Description:
Emitted when a user invited another user to a chat.
Parameters
convThe chat conversation.
convThe name of the user that was invited.
invite_messageThe message to be sent to the user when invited.

chat-invited

gint (*chat_invited)(PurpleAccount *account, const char *inviter,
const char *chat, const char *invite_message
const GHashTable *components);
Description:
Emitted when an account was invited to a chat.
Parameters
accountThe account being invited.
inviterThe username of the person inviting the account.
chatThe name of the chat you're being invited to.
invite_messageThe optional invite message.
componentsThe components necessary if you want to call serv_join_chat()
Returns
Less than zero if the invitation should be rejected, greater than zero if the invitation should be accepted. If zero is returned, the default behavior will be maintained: the user will be prompted.

chat-invite-blocked

void (*chat_invite_blocked)(PurpleAccount *account, const char *inviter,
const char *name, const char *message, GHashTable *data);
Description:
Emitted when an invitation to join a chat is blocked.
Parameters
accountThe account the invitation was sent to.
inviterThe name of the person sending the invitation.
nameThe name of the chat invited to.
messageThe invitation message sent.
dataHashtable containing data about the invited chat.
Since
2.5.0

chat-joined

void (*chat_joined)(PurpleConversation *conv);
Description:
Emitted when an account joins a chat room.
Parameters
convThe conversation that joined the chat room.

chat-left

void (*chat_left)(PurpleConversation *conv);
Description:
Emitted when an account leaves a chat room.
Parameters
convThe conversation that left the chat room.

chat-topic-changed

void (*chat_topic_changed)(PurpleConversation *conv, const char *who, const char *topic);
Description:
Emitted when the topic is changed in a chat.
Parameters
convThe conversation whose topic changed.
whoThe name of the person that changed the topic.
topicThe new topic.

conversation-extended-menu

void (*conversation_extended_menu)(PurpleConversation *conv, GList **list);
Description:
Emitted when the UI requests a list of plugin actions for a conversation.
Parameters
convThe conversation.
listA pointer to the list of actions.
Since
2.1.0

cleared-message-history

void (*cleared_message_history)(PurpleConversation *conv);
Description:
Emitted when the conversation history is cleared.
Parameters
convThe conversation.
Since
2.8.0

sent-attention

void (*got_attention)(PurpleAccount *account, const char *who,
PurpleConversation *conv, guint type)
Description:
Emitted when receiving an attention message (buzz, nudge, etc.).
Parameters
accountThe account
whoThe name of the person receiving the attention
convThe conversation
typeThe attention type (an index starting at 0)
Since
2.7.0

got-attention

void (*got_attention)(PurpleAccount *account, const char *who,
PurpleConversation *conv, guint type)
Description:
Emitted when receiving an attention message (buzz, nudge, etc.).
Parameters
accountThe account
whoThe name of the person sending the attention
convThe conversation
typeThe attention type (an index starting at 0)
Since
2.7.0
All information, including names and email addresses, entered onto this website or sent to mailing lists affiliated with this website will be public. Do not post confidential information, especially passwords!