Mercurial > pidgin

comparison libpurple/server.h @ 15822:32c366eeeb99

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
sed -ie 's/gaim/purple/g'
author Sean Egan <seanegan@gmail.com>
date Mon, 19 Mar 2007 07:01:17 +0000
parents 5fe8042783c1
children b449dc6b8a20
comparison
equal deleted inserted replaced
15821:84b0f9b23ede 15822:32c366eeeb99
1 /** 1 /**
2 * @file server.h Server API 2 * @file server.h Server API
3 * @ingroup core 3 * @ingroup core
4 * 4 *
5 * gaim 5 * purple
6 * 6 *
7 * Gaim is the legal property of its developers, whose names are too numerous 7 * Purple is the legal property of its developers, whose names are too numerous
8 * to list here. Please refer to the COPYRIGHT file distributed with this 8 * to list here. Please refer to the COPYRIGHT file distributed with this
9 * source distribution. 9 * source distribution.
10 * 10 *
11 * This program is free software; you can redistribute it and/or modify 11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by 12 * it under the terms of the GNU General Public License as published by
20 * 20 *
21 * You should have received a copy of the GNU General Public License 21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software 22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 */ 24 */
25 #ifndef _GAIM_SERVER_H_ 25 #ifndef _PURPLE_SERVER_H_
26 #define _GAIM_SERVER_H_ 26 #define _PURPLE_SERVER_H_
27 27
28 #include "account.h" 28 #include "account.h"
29 #include "conversation.h" 29 #include "conversation.h"
30 #include "prpl.h" 30 #include "prpl.h"
31 31
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 typing One of GAIM_TYPING, GAIM_TYPED, or GAIM_NOT_TYPING. 41 * @param typing One of PURPLE_TYPING, PURPLE_TYPED, or PURPLE_NOT_TYPING.
42 * @return A quiet-period, specified in seconds, where Gaim will not 42 * @return A quiet-period, specified in seconds, where Purple will not
43 * send any additional typing notification messages. Most 43 * send any additional typing notification messages. Most
44 * protocols should return 0, which means that no additional 44 * protocols should return 0, which means that no additional
45 * GAIM_TYPING messages need to be sent. If this is 5, for 45 * PURPLE_TYPING messages need to be sent. If this is 5, for
46 * example, then Gaim will wait five seconds, and if the Gaim 46 * example, then Purple will wait five seconds, and if the Purple
47 * user is still typing then Gaim will send another GAIM_TYPING 47 * user is still typing then Purple will send another PURPLE_TYPING
48 * message. 48 * message.
49 */ 49 */
50 unsigned int serv_send_typing(GaimConnection *gc, const char *name, GaimTypingState state); 50 unsigned int serv_send_typing(PurpleConnection *gc, const char *name, PurpleTypingState state);
51 51
52 void serv_move_buddy(GaimBuddy *, GaimGroup *, GaimGroup *); 52 void serv_move_buddy(PurpleBuddy *, PurpleGroup *, PurpleGroup *);
53 int serv_send_im(GaimConnection *, const char *, const char *, GaimMessageFlags flags); 53 int serv_send_im(PurpleConnection *, const char *, const char *, PurpleMessageFlags flags);
54 void serv_get_info(GaimConnection *, const char *); 54 void serv_get_info(PurpleConnection *, const char *);
55 void serv_set_info(GaimConnection *, const char *); 55 void serv_set_info(PurpleConnection *, const char *);
56 56
57 void serv_add_permit(GaimConnection *, const char *); 57 void serv_add_permit(PurpleConnection *, const char *);
58 void serv_add_deny(GaimConnection *, const char *); 58 void serv_add_deny(PurpleConnection *, const char *);
59 void serv_rem_permit(GaimConnection *, const char *); 59 void serv_rem_permit(PurpleConnection *, const char *);
60 void serv_rem_deny(GaimConnection *, const char *); 60 void serv_rem_deny(PurpleConnection *, const char *);
61 void serv_set_permit_deny(GaimConnection *); 61 void serv_set_permit_deny(PurpleConnection *);
62 void serv_chat_invite(GaimConnection *, int, const char *, const char *); 62 void serv_chat_invite(PurpleConnection *, int, const char *, const char *);
63 void serv_chat_leave(GaimConnection *, int); 63 void serv_chat_leave(PurpleConnection *, int);
64 void serv_chat_whisper(GaimConnection *, int, const char *, const char *); 64 void serv_chat_whisper(PurpleConnection *, int, const char *, const char *);
65 int serv_chat_send(GaimConnection *, int, const char *, GaimMessageFlags flags); 65 int serv_chat_send(PurpleConnection *, int, const char *, PurpleMessageFlags flags);
66 void serv_alias_buddy(GaimBuddy *); 66 void serv_alias_buddy(PurpleBuddy *);
67 void serv_got_alias(GaimConnection *gc, const char *who, const char *alias); 67 void serv_got_alias(PurpleConnection *gc, const char *who, const char *alias);
68 68
69 /** 69 /**
70 * Receive a typing message from a remote user. Either GAIM_TYPING 70 * Receive a typing message from a remote user. Either PURPLE_TYPING
71 * or GAIM_TYPED. If the user has stopped typing then use 71 * or PURPLE_TYPED. If the user has stopped typing then use
72 * serv_got_typing_stopped instead. 72 * serv_got_typing_stopped instead.
73 * 73 *
74 * TODO: Could probably move this into the conversation API. 74 * TODO: Could probably move this into the conversation API.
75 * 75 *
76 * @param timeout If this is a number greater than 0, then 76 * @param timeout If this is a number greater than 0, then
77 * Gaim will wait this number of seconds and then 77 * Purple will wait this number of seconds and then
78 * set this buddy to the GAIM_NOT_TYPING state. This 78 * set this buddy to the PURPLE_NOT_TYPING state. This
79 * is used by protocols that send repeated typing messages 79 * is used by protocols that send repeated typing messages
80 * while the user is composing the message. 80 * while the user is composing the message.
81 */ 81 */
82 void serv_got_typing(GaimConnection *gc, const char *name, int timeout, 82 void serv_got_typing(PurpleConnection *gc, const char *name, int timeout,
83 GaimTypingState state); 83 PurpleTypingState state);
84 84
85 /** 85 /**
86 * TODO: Could probably move this into the conversation API. 86 * TODO: Could probably move this into the conversation API.
87 */ 87 */
88 void serv_got_typing_stopped(GaimConnection *gc, const char *name); 88 void serv_got_typing_stopped(PurpleConnection *gc, const char *name);
89 89
90 void serv_got_im(GaimConnection *gc, const char *who, const char *msg, 90 void serv_got_im(PurpleConnection *gc, const char *who, const char *msg,
91 GaimMessageFlags flags, time_t mtime); 91 PurpleMessageFlags flags, time_t mtime);
92 92
93 /** 93 /**
94 * @param data The hash function should be g_str_hash() and the equal 94 * @param data The hash function should be g_str_hash() and the equal
95 * function should be g_str_equal(). 95 * function should be g_str_equal().
96 */ 96 */
97 void serv_join_chat(GaimConnection *, GHashTable *); 97 void serv_join_chat(PurpleConnection *, GHashTable *);
98 98
99 /** 99 /**
100 * @param data The hash function should be g_str_hash() and the equal 100 * @param data The hash function should be g_str_hash() and the equal
101 * function should be g_str_equal(). 101 * function should be g_str_equal().
102 */ 102 */
103 void serv_reject_chat(GaimConnection *, GHashTable *); 103 void serv_reject_chat(PurpleConnection *, GHashTable *);
104 104
105 /** 105 /**
106 * @param data The hash function should be g_str_hash() and the equal 106 * @param data The hash function should be g_str_hash() and the equal
107 * function should be g_str_equal(). 107 * function should be g_str_equal().
108 */ 108 */
109 void serv_got_chat_invite(GaimConnection *gc, const char *name, 109 void serv_got_chat_invite(PurpleConnection *gc, const char *name,
110 const char *who, const char *message, 110 const char *who, const char *message,
111 GHashTable *data); 111 GHashTable *data);
112 112
113 GaimConversation *serv_got_joined_chat(GaimConnection *gc, 113 PurpleConversation *serv_got_joined_chat(PurpleConnection *gc,
114 int id, const char *name); 114 int id, const char *name);
115 void serv_got_chat_left(GaimConnection *g, int id); 115 void serv_got_chat_left(PurpleConnection *g, int id);
116 void serv_got_chat_in(GaimConnection *g, int id, const char *who, 116 void serv_got_chat_in(PurpleConnection *g, int id, const char *who,
117 GaimMessageFlags flags, const char *message, time_t mtime); 117 PurpleMessageFlags flags, const char *message, time_t mtime);
118 void serv_send_file(GaimConnection *gc, const char *who, const char *file); 118 void serv_send_file(PurpleConnection *gc, const char *who, const char *file);
119 119
120 #ifdef __cplusplus 120 #ifdef __cplusplus
121 } 121 }
122 #endif 122 #endif
123 123
124 #endif /* _GAIM_SERVER_H_ */ 124 #endif /* _PURPLE_SERVER_H_ */