#include <prpl.h>
Collaboration diagram for _PurplePluginProtocolInfo:
Data Fields | |
void(* | _purple_reserved1 )(void) |
void(* | _purple_reserved2 )(void) |
void(* | _purple_reserved3 )(void) |
void(* | _purple_reserved4 )(void) |
void(* | add_buddies )(PurpleConnection *, GList *buddies, GList *groups) |
void(* | add_buddy )(PurpleConnection *, PurpleBuddy *buddy, PurpleGroup *group) |
void(* | add_deny )(PurpleConnection *, const char *name) |
void(* | add_permit )(PurpleConnection *, const char *name) |
void(* | alias_buddy )(PurpleConnection *, const char *who, const char *alias) |
GList *(* | blist_node_menu )(PurpleBlistNode *node) |
void(* | buddy_free )(PurpleBuddy *) |
gboolean(* | can_receive_file )(PurpleConnection *, const char *who) |
void(* | change_passwd )(PurpleConnection *, const char *old_pass, const char *new_pass) |
GList *(* | chat_info )(PurpleConnection *) |
GHashTable *(* | chat_info_defaults )(PurpleConnection *, const char *chat_name) |
void(* | chat_invite )(PurpleConnection *, int id, const char *message, const char *who) |
void(* | chat_leave )(PurpleConnection *, int id) |
int(* | chat_send )(PurpleConnection *, int id, const char *message, PurpleMessageFlags flags) |
void(* | chat_whisper )(PurpleConnection *, int id, const char *who, const char *message) |
void(* | close )(PurpleConnection *) |
This must be implemented. | |
void(* | convo_closed )(PurpleConnection *, const char *who) |
PurpleChat *(* | find_blist_chat )(PurpleAccount *account, const char *name) |
void(* | get_cb_away )(PurpleConnection *, int, const char *who) |
void(* | get_cb_info )(PurpleConnection *, int, const char *who) |
char *(* | get_cb_real_name )(PurpleConnection *gc, int id, const char *who) |
char *(* | get_chat_name )(GHashTable *components) |
void(* | get_info )(PurpleConnection *, const char *who) |
void(* | group_buddy )(PurpleConnection *, const char *who, const char *old_group, const char *new_group) |
PurpleBuddyIconSpec | icon_spec |
void(* | join_chat )(PurpleConnection *, GHashTable *components) |
void(* | keepalive )(PurpleConnection *) |
const char *(* | list_emblem )(PurpleBuddy *buddy) |
Fills the four char**'s with string identifiers for "emblems" that the UI will interpret and display as relevant. | |
const char *(* | list_icon )(PurpleAccount *account, PurpleBuddy *buddy) |
Returns the base icon name for the given buddy and account. | |
void(* | login )(PurpleAccount *) |
This must be implemented. | |
PurpleXfer *(* | new_xfer )(PurpleConnection *, const char *who) |
const char *(* | normalize )(const PurpleAccount *, const char *) |
gboolean(* | offline_message )(const PurpleBuddy *buddy) |
PurpleProtocolOptions | options |
Protocol options. | |
GList * | protocol_options |
void(* | register_user )(PurpleAccount *) |
void(* | reject_chat )(PurpleConnection *, GHashTable *components) |
void(* | rem_deny )(PurpleConnection *, const char *name) |
void(* | rem_permit )(PurpleConnection *, const char *name) |
void(* | remove_buddies )(PurpleConnection *, GList *buddies, GList *groups) |
void(* | remove_buddy )(PurpleConnection *, PurpleBuddy *buddy, PurpleGroup *group) |
void(* | remove_group )(PurpleConnection *gc, PurpleGroup *group) |
void(* | rename_group )(PurpleConnection *, const char *old_name, PurpleGroup *group, GList *moved_buddies) |
void(* | roomlist_cancel )(PurpleRoomlist *list) |
void(* | roomlist_expand_category )(PurpleRoomlist *list, PurpleRoomlistRoom *category) |
PurpleRoomlist *(* | roomlist_get_list )(PurpleConnection *gc) |
char *(* | roomlist_room_serialize )(PurpleRoomlistRoom *room) |
void(* | send_file )(PurpleConnection *, const char *who, const char *filename) |
int(* | send_im )(PurpleConnection *, const char *who, const char *message, PurpleMessageFlags flags) |
This PRPL function should return a positive value on success. | |
int(* | send_raw )(PurpleConnection *gc, const char *buf, int len) |
unsigned int(* | send_typing )(PurpleConnection *, const char *name, PurpleTypingState state) |
void(* | set_buddy_icon )(PurpleConnection *, PurpleStoredImage *img) |
void(* | set_chat_topic )(PurpleConnection *gc, int id, const char *topic) |
void(* | set_idle )(PurpleConnection *, int idletime) |
void(* | set_info )(PurpleConnection *, const char *info) |
void(* | set_permit_deny )(PurpleConnection *) |
void(* | set_status )(PurpleAccount *account, PurpleStatus *status) |
char *(* | status_text )(PurpleBuddy *buddy) |
Gets a short string representing this buddy's status. | |
GList *(* | status_types )(PurpleAccount *account) |
This must be implemented, and must add at least the offline and online states. | |
void(* | tooltip_text )(PurpleBuddy *buddy, PurpleNotifyUserInfo *user_info, gboolean full) |
Allows the prpl to add text to a buddy's tooltip. | |
GList * | user_splits |
PurpleWhiteboardPrplOps * | whiteboard_prpl_ops |
Every protocol plugin initializes this structure. It is the gateway between purple and the protocol plugin. Many of this callbacks can be NULL. If a callback must be implemented, it has a comment indicating so.
Definition at line 170 of file prpl.h.
void(* _PurplePluginProtocolInfo::close)(PurpleConnection *) |
This must be implemented.
const char*(* _PurplePluginProtocolInfo::list_icon)(PurpleAccount *account, PurpleBuddy *buddy) |
Returns the base icon name for the given buddy and account.
If buddy is NULL and the account is non-NULL, it will return the name to use for the account's icon. If both are NULL, it will return the name to use for the protocol's icon.
This must be implemented.
void(* _PurplePluginProtocolInfo::login)(PurpleAccount *) |
This must be implemented.
int(* _PurplePluginProtocolInfo::send_im)(PurpleConnection *, const char *who, const char *message, PurpleMessageFlags flags) |
This PRPL function should return a positive value on success.
If the message is too big to be sent, return -E2BIG. If the account is not connected, return -ENOTCONN. If the PRPL is unable to send the message for another reason, return some other negative value. You can use one of the valid errno values, or just big something. If the message should not be echoed to the conversation window, return 0.
char*(* _PurplePluginProtocolInfo::status_text)(PurpleBuddy *buddy) |
Gets a short string representing this buddy's status.
This will be shown on the buddy list.