Mercurial > pidgin
comparison libpurple/prpl.h @ 20903:3375d44ccad7
Add some (but not much!) documentation to PurplePluginProtocolInfo.
| author | Will Thompson <will.thompson@collabora.co.uk> |
|---|---|
| date | Fri, 12 Oct 2007 16:27:41 +0000 |
| parents | 6bf32c9e15a7 |
| children | ed40911613a0 |
comparison
equal
deleted
inserted
replaced
| 20901:a5aa5a835c94 | 20903:3375d44ccad7 |
|---|---|
| 224 * Allows the prpl to add text to a buddy's tooltip. | 224 * Allows the prpl to add text to a buddy's tooltip. |
| 225 */ | 225 */ |
| 226 void (*tooltip_text)(PurpleBuddy *buddy, PurpleNotifyUserInfo *user_info, gboolean full); | 226 void (*tooltip_text)(PurpleBuddy *buddy, PurpleNotifyUserInfo *user_info, gboolean full); |
| 227 | 227 |
| 228 /** | 228 /** |
| 229 * This must be implemented, and must add at least the offline | 229 * Returns a list of #PurpleStatusType which exist for this account; |
| 230 * and online states. | 230 * this must be implemented, and must add at least the offline and |
| 231 * online states. | |
| 231 */ | 232 */ |
| 232 GList *(*status_types)(PurpleAccount *account); | 233 GList *(*status_types)(PurpleAccount *account); |
| 233 | 234 |
| 235 /** | |
| 236 * Returns a list of #PurpleMenuAction structs, which represent extra | |
| 237 * actions to be shown in (for example) the right-click menu for @a | |
| 238 * node. | |
| 239 */ | |
| 234 GList *(*blist_node_menu)(PurpleBlistNode *node); | 240 GList *(*blist_node_menu)(PurpleBlistNode *node); |
| 235 GList *(*chat_info)(PurpleConnection *); | 241 GList *(*chat_info)(PurpleConnection *); |
| 236 GHashTable *(*chat_info_defaults)(PurpleConnection *, const char *chat_name); | 242 GHashTable *(*chat_info_defaults)(PurpleConnection *, const char *chat_name); |
| 237 | 243 |
| 238 /* All the server-related functions */ | 244 /* All the server-related functions */ |
| 256 const char *message, | 262 const char *message, |
| 257 PurpleMessageFlags flags); | 263 PurpleMessageFlags flags); |
| 258 | 264 |
| 259 void (*set_info)(PurpleConnection *, const char *info); | 265 void (*set_info)(PurpleConnection *, const char *info); |
| 260 unsigned int (*send_typing)(PurpleConnection *, const char *name, PurpleTypingState state); | 266 unsigned int (*send_typing)(PurpleConnection *, const char *name, PurpleTypingState state); |
| 267 /** | |
| 268 * Should arrange for purple_notify_userinfo() to be called with | |
| 269 * @a who's user info. | |
| 270 */ | |
| 261 void (*get_info)(PurpleConnection *, const char *who); | 271 void (*get_info)(PurpleConnection *, const char *who); |
| 262 void (*set_status)(PurpleAccount *account, PurpleStatus *status); | 272 void (*set_status)(PurpleAccount *account, PurpleStatus *status); |
| 263 | 273 |
| 264 void (*set_idle)(PurpleConnection *, int idletime); | 274 void (*set_idle)(PurpleConnection *, int idletime); |
| 265 void (*change_passwd)(PurpleConnection *, const char *old_pass, | 275 void (*change_passwd)(PurpleConnection *, const char *old_pass, |
| 285 void (*keepalive)(PurpleConnection *); | 295 void (*keepalive)(PurpleConnection *); |
| 286 | 296 |
| 287 /** new user registration */ | 297 /** new user registration */ |
| 288 void (*register_user)(PurpleAccount *); | 298 void (*register_user)(PurpleAccount *); |
| 289 | 299 |
| 290 /* get "chat buddy" info and away message */ | 300 /** Deprecated and vestigal; use #get_cb_real_name and #get_info |
| 301 * instead. | |
| 302 */ | |
| 291 void (*get_cb_info)(PurpleConnection *, int, const char *who); | 303 void (*get_cb_info)(PurpleConnection *, int, const char *who); |
| 304 /** Also deprecated and vestigal; use #get_cb_real_name and | |
| 305 * #status_text instead. | |
| 306 */ | |
| 292 void (*get_cb_away)(PurpleConnection *, int, const char *who); | 307 void (*get_cb_away)(PurpleConnection *, int, const char *who); |
| 293 | 308 |
| 294 /** save/store buddy's alias on server list/roster */ | 309 /** save/store buddy's alias on server list/roster */ |
| 295 void (*alias_buddy)(PurpleConnection *, const char *who, | 310 void (*alias_buddy)(PurpleConnection *, const char *who, |
| 296 const char *alias); | 311 const char *alias); |
| 346 int (*send_raw)(PurpleConnection *gc, const char *buf, int len); | 361 int (*send_raw)(PurpleConnection *gc, const char *buf, int len); |
| 347 | 362 |
| 348 /* room list serialize */ | 363 /* room list serialize */ |
| 349 char *(*roomlist_room_serialize)(PurpleRoomlistRoom *room); | 364 char *(*roomlist_room_serialize)(PurpleRoomlistRoom *room); |
| 350 | 365 |
| 351 /* Remove the user from the server. (This is only at the bottom to keep binary compatibility.) | 366 /** Remove the user from the server. The account can either be |
| 352 * The account can either be connected or disconnected. After the removal is finished, | 367 * connected or disconnected. After the removal is finished, the |
| 353 * the connection will stay open and has to be closed! | 368 * connection will stay open and has to be closed! |
| 369 */ | |
| 370 /* This is here rather than next to register_user for API compatibility | |
| 371 * reasons. | |
| 354 */ | 372 */ |
| 355 void (*unregister_user)(PurpleAccount *, PurpleAccountUnregistrationCb cb, void *user_data); | 373 void (*unregister_user)(PurpleAccount *, PurpleAccountUnregistrationCb cb, void *user_data); |
| 356 | 374 |
| 357 /* Attention API for sending & receiving zaps/nudges/buzzes etc. */ | 375 /* Attention API for sending & receiving zaps/nudges/buzzes etc. */ |
| 358 gboolean (*send_attention)(PurpleConnection *gc, const char *username, guint type); | 376 gboolean (*send_attention)(PurpleConnection *gc, const char *username, guint type); |