Conversation Signals

Signals:

writing-im-msg

gboolean (*writing_im_msg)(GaimAccount *account, GaimConversation *conv, char **message);
Description:
Emitted before a message is displayed in an IM conversation or sent to a remote user. message is a pointer to a string, so the plugin can replace the message that will be displayed along with the message that will be sent. This can also be used to cancel an outgoing message by returning TRUE.
Note:
Make sure to free *message before you replace it!
Parameters:
account The account the message is being displayed and sent on.
conv The conversation the message is being displayed and sent on.
message A pointer to the message that will be displayed and sent.
Returns:
TRUE if the message should be canceled, or FALSE otherwise.

wrote-im-msg

void (*wrote_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
Description:
Emitted after a message is entered by the user, but before it is sent and displyed. When sending an IM, the order that the im-msg callbacks will be called is: writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg, and finally sent-im-msg.
Parameters:
account The account the message was displayed on.
conv The conversation the message was displayed on.
message The message that was displayed.

displaying-im-msg

gboolean (*displaying_im_msg)(GaimAccount *account, GaimConversation *conv, char **message);
Description:
Emitted just before a message is displayed in an IM conversation. message is a pointer to a string, so the plugin can replace the message that will be displayed. This can also be used to cancel displaying a message by returning TRUE.
Note:
Make sure to free *message before you replace it!
Parameters:
account The account the message is being displayed on.
conv The conversation the message is being displayed on.
message A pointer to the message that will be displayed.
Returns:
TRUE if the message should be canceled, or FALSE otherwise.

displayed-im-msg

void (*displayed_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
Description:
Emitted after a message is displayed in an IM conversation.
Parameters:
account The account the message was displayed on.
conv The conversation the message was displayed on.
message The message that was displayed.

sending-im-msg

void (*sending_im_msg)(GaimAccount *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:
account The account the message is being sent on.
receiver The username of the receiver.
message A pointer to the outgoing message. This can be modified.

sent-im-msg

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

receiving-im-msg

gboolean (*receiving_im_msg)(GaimAccount *account, char **sender,
                            char **message, int *flags);
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:
account The account the message was received on.
sender A pointer to the username of the sender.
message A pointer to the message that was sent.
flags The message flags.

received-im-msg

void (*received_im_msg)(GaimAccount *account, char *sender,
                            char *message, int flags);
Description:
Emitted after an IM is received.
Parameters:
account The account the message was received on.
sender The username of the sender.
message The message that was sent.
flags The message flags.

writing-chat-msg

gboolean (*writing_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message);
Description:
Emitted before a message is displayed in a chat conversation or sent to a remote chat. message is a pointer to a string, so the plugin can replace the message that will be displayed along with the message that will be sent. This can also be used to cancel an outgoing message by returning TRUE.
Note:
Make sure to free *message before you replace it!
Parameters:
account The account the message is being displayed and sent on.
conv The conversation the message is being displayed and sent on.
message A pointer to the message that will be displayed and sent.
Returns:
TRUE if the message should be canceled, or FALSE otherwise.

wrote-chat-msg

void (*wrote_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
Description:
Emitted after a message is entered by the user, but before it is sent and displyed. When sending an IM, the order that the im-msg callbacks will be called is: writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg, and finally sent-im-msg.
Parameters:
account The account the message was displayed on.
conv The conversation the message was displayed on.
message The message that was displayed.

displaying-chat-msg

gboolean (*displaying_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message);
Description:
Emitted just before a message is displayed in a chat. message is a pointer to a string, so the plugin can replace the message that will be displayed. This can also be used to cancel displaying a message by returning TRUE.
Note:
Make sure to free *message before you replace it!
Parameters:
account The account the message is being displayed on.
conv The conversation the message is being displayed on.
message A pointer to the message that will be displayed.
Returns:
TRUE if the message should be canceled, or FALSE otherwise.

displayed-chat-msg

void (*displayed_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
Description:
Emitted after a message is displayed in a chat conversation.
Parameters:
account The account the message was displayed on.
conv The conversation the message was displayed on.
message The message that was displayed.

sending-chat-msg

void (*sending_chat_msg)(GaimAccount *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:
account The account the message is being sent on.
message A pointer to the message that will be sent.
id The ID of the chat.

sent-chat-msg

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

receiving-chat-msg

gboolean (*receiving_chat_msg)(GaimAccount *account, char **sender,
                              char **message, GaimConversation *conv);
Description:
Emitted when a chat message is received. The callback can replace the name of the sender or the messageby 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:
account The account the message was received on.
sender A pointer to the username of the sender.
message A pointer to the message that was sent.
conv The chat conversation.

received-chat-msg

void (*received_chat_msg)(GaimAccount *account, char *sender,
                              char *message, GaimConversation *conv);
Description:
Emitted after a chat message is received.
Parameters:
account The account the message was received on.
sender The username of the sender.
message The message that was sent.
conv The chat conversation.

conversation-switching

void (*conversation_switching)(GaimConversation *old_conv,
                               GaimConversation *new_conv);
Description:
Emitted when a window is about to switch from one conversation to another.
Parameters:
old_conv The old active conversation.
new_conv The soon-to-be active conversation

conversation-switched

void (*conversation_switched)(GaimConversation *old_conv,
                              GaimConversation *new_conv);
Description:
Emitted when a window switched from one conversation to another.
Parameters:
old_conv The old active conversation.
new_conv The now active conversation.

conversation-created

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

deleting-conversation

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

buddy-typing

void (*buddy_typing)(GaimConversation *conv);
Description:
Emitted when a buddy starts typing in a conversation window.
Parameters:
conv The IM conversation a buddy is typing in.

buddy-typing-stopped

void (*buddy_typing)(GaimConversation *conv);
Description:
Emitted when a buddy stops typing in a conversation window.
Parameters:
conv The IM conversation a buddy is typing in.

chat-buddy-joining

gboolean (*chat_buddy_joining)(GaimConversation *conv, const char *name,
                           GaimConvChatBuddyFlags flags);
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:
conv The chat conversation.
name The name of the user that is joining the conversation.
flags The flags of the user that is joining the conversation.

chat-buddy-joined

void (*chat_buddy_joined)(GaimConversation *conv, const char *name,
                          GaimConvChatBuddyFlags flags);
Description:
Emitted when a buddy joined a chat, after the users list is updated.
Parameters:
conv The chat conversation.
name The name of the user that has joined the conversation.
flags The flags of the user that has joined the conversation.

chat-buddy-flags

void (*chat_buddy_flags)(GaimConversation *conv, const char *name,
                         GaimConvChatBuddyFlags oldflags,
                         GaimConvChatBuddyFlags newflags);
Description:
Emitted when a user in a chat changes flags.
Parameters:
conv The chat conversation.
name The name of the user.
oldflags The old flags.
newflags The new flags.

chat-buddy-leaving

gboolean (*chat_buddy_leaving)(GaimConversation *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:
conv The chat conversation.
name The name of the user that is leaving the chat.
reason The optional reason why the user is leaving.

chat-buddy-left

void (*chat_buddy_left)(GaimConversation *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:
conv The chat conversation.
name The name of the user that left the chat.
reason The optional reason why the user left the chat.

chat-inviting-user

void (*chat_inviting_user)(GaimConversation *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:
conv The chat conversation.
name The name of the user being invited.
invite_message A pointer to the reason why a user is being invited.

chat-invited-user

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

chat-invited

void (*chat_invited)(GaimAccount *account, const char *inviter,
                     const char *chat, const char *invite_message
                     const GHastTable *components);
Description:
Emitted when an account was invited to a chat.
Parameters:
account The account being invited.
inviter The username of the person inviting the account.
chat The name of the chat you're being invited to.
invite_message The optional invite message.
components The components necessary if you want to call serv_join_chat

chat-joined

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

chat-left

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

chat-topic-changed

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

Generated on Sun Feb 18 08:38:52 2007 for gaim by  doxygen 1.5.1