comparison libpurple/prpl.h @ 24534:23170794f9f5

Add a comment for the meaning of the return value of this function, because I had no idea.
author Mark Doliner <mark@kingant.net>
date Thu, 04 Dec 2008 01:20:37 +0000
parents 49850f7ca393
children 64c74659b6eb
comparison
equal deleted inserted replaced
24533:1ede190e518b 24534:23170794f9f5
272 int (*send_im)(PurpleConnection *, const char *who, 272 int (*send_im)(PurpleConnection *, const char *who,
273 const char *message, 273 const char *message,
274 PurpleMessageFlags flags); 274 PurpleMessageFlags flags);
275 275
276 void (*set_info)(PurpleConnection *, const char *info); 276 void (*set_info)(PurpleConnection *, const char *info);
277
278 /**
279 * @return If this protocol requires the PURPLE_TYPING message to
280 * be sent repeatedly to signfiy that the user is still
281 * typing, then the PRPL should return the number of
282 * seconds to wait before sending a subsequent notification.
283 * Otherwise the PRPL should return 0.
284 */
277 unsigned int (*send_typing)(PurpleConnection *, const char *name, PurpleTypingState state); 285 unsigned int (*send_typing)(PurpleConnection *, const char *name, PurpleTypingState state);
286
278 /** 287 /**
279 * Should arrange for purple_notify_userinfo() to be called with 288 * Should arrange for purple_notify_userinfo() to be called with
280 * @a who's user info. 289 * @a who's user info.
281 */ 290 */
282 void (*get_info)(PurpleConnection *, const char *who); 291 void (*get_info)(PurpleConnection *, const char *who);