Mercurial > pidgin.yaz

comparison libpurple/server.h @ 16201:36b09c6f7957

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Doxygen updates. This eliminated all the warnings from Doxygen.
author Richard Laager <rlaager@wiktel.com>
date Mon, 16 Apr 2007 05:07:21 +0000
parents b449dc6b8a20
children 0f46f13c0805 6395c2e96bc2
comparison
equal deleted inserted replaced
16200:470caa5fe675 16201:36b09c6f7957
36 /** 36 /**
37 * Send a typing message to a given user over a given connection. 37 * Send a typing message to a given user over a given connection.
38 * 38 *
39 * TODO: Could probably move this into the conversation API. 39 * TODO: Could probably move this into the conversation API.
40 * 40 *
41 * @param gc The connection over which to send the typing notification.
42 * @param name The user to send the typing notification to.
41 * @param state One of PURPLE_TYPING, PURPLE_TYPED, or PURPLE_NOT_TYPING. 43 * @param state One of PURPLE_TYPING, PURPLE_TYPED, or PURPLE_NOT_TYPING.
42 * @return A quiet-period, specified in seconds, where Purple will not 44 * @return A quiet-period, specified in seconds, where Purple will not
43 * send any additional typing notification messages. Most 45 * send any additional typing notification messages. Most
44 * protocols should return 0, which means that no additional 46 * protocols should return 0, which means that no additional
45 * PURPLE_TYPING messages need to be sent. If this is 5, for 47 * PURPLE_TYPING messages need to be sent. If this is 5, for
71 * or PURPLE_TYPED. If the user has stopped typing then use 73 * or PURPLE_TYPED. If the user has stopped typing then use
72 * serv_got_typing_stopped instead. 74 * serv_got_typing_stopped instead.
73 * 75 *
74 * TODO: Could probably move this into the conversation API. 76 * TODO: Could probably move this into the conversation API.
75 * 77 *
78 * @param gc The connection on which the typing message was received.
79 * @param name The name of the remote user.
76 * @param timeout If this is a number greater than 0, then 80 * @param timeout If this is a number greater than 0, then
77 * Purple will wait this number of seconds and then 81 * Purple will wait this number of seconds and then
78 * set this buddy to the PURPLE_NOT_TYPING state. This 82 * set this buddy to the PURPLE_NOT_TYPING state. This
79 * is used by protocols that send repeated typing messages 83 * is used by protocols that send repeated typing messages
80 * while the user is composing the message. 84 * while the user is composing the message.
85 * @param state The typing state received
81 */ 86 */
82 void serv_got_typing(PurpleConnection *gc, const char *name, int timeout, 87 void serv_got_typing(PurpleConnection *gc, const char *name, int timeout,
83 PurpleTypingState state); 88 PurpleTypingState state);
84 89
85 /** 90 /**
101 * function should be g_str_equal(). 106 * function should be g_str_equal().
102 */ 107 */
103 void serv_reject_chat(PurpleConnection *, GHashTable *data); 108 void serv_reject_chat(PurpleConnection *, GHashTable *data);
104 109
105 /** 110 /**
106 * @param data The hash function should be g_str_hash() and the equal 111 * Called by a prpl when an account is invited into a chat.
107 * function should be g_str_equal(). 112 *
113 * @param gc The connection on which the invite arrived.
114 * @param name The name of the chat you're being invited to.
115 * @param who The username of the person inviting the account.
116 * @param message The optional invite message.
117 * @param data The components necessary if you want to call serv_join_chat().
118 * The hash function should be g_str_hash() and the equal
119 * function should be g_str_equal().
108 */ 120 */
109 void serv_got_chat_invite(PurpleConnection *gc, const char *name, 121 void serv_got_chat_invite(PurpleConnection *gc, const char *name,
110 const char *who, const char *message, 122 const char *who, const char *message,
111 GHashTable *data); 123 GHashTable *data);
112 124