Mercurial > pidgin.yaz
comparison libpurple/server.h @ 20400:ea9a5566a156
propagate from branch 'im.pidgin.rlaager.merging.msnp13-and-sf-1621854-4' (head 36b8a3e05397b5918f311a046fa580c5bb8846e0)
to branch 'im.pidgin.cpw.khc.msnp14' (head 39ac2e1b7754245b292605b0e3055ebb1b954c5d)
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Sun, 15 Apr 2007 05:00:56 +0000 |
parents | b449dc6b8a20 |
children | 36b09c6f7957 |
comparison
equal
deleted
inserted
replaced
20395:bb940f08c820 | 20400:ea9a5566a156 |
---|---|
1 /** | |
2 * @file server.h Server API | |
3 * @ingroup core | |
4 * | |
5 * purple | |
6 * | |
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 | |
9 * source distribution. | |
10 * | |
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 | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
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 | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
25 #ifndef _PURPLE_SERVER_H_ | |
26 #define _PURPLE_SERVER_H_ | |
27 | |
28 #include "account.h" | |
29 #include "conversation.h" | |
30 #include "prpl.h" | |
31 | |
32 #ifdef __cplusplus | |
33 extern "C" { | |
34 #endif | |
35 | |
36 /** | |
37 * Send a typing message to a given user over a given connection. | |
38 * | |
39 * TODO: Could probably move this into the conversation API. | |
40 * | |
41 * @param state One of PURPLE_TYPING, PURPLE_TYPED, or PURPLE_NOT_TYPING. | |
42 * @return A quiet-period, specified in seconds, where Purple will not | |
43 * send any additional typing notification messages. Most | |
44 * protocols should return 0, which means that no additional | |
45 * PURPLE_TYPING messages need to be sent. If this is 5, for | |
46 * example, then Purple will wait five seconds, and if the Purple | |
47 * user is still typing then Purple will send another PURPLE_TYPING | |
48 * message. | |
49 */ | |
50 unsigned int serv_send_typing(PurpleConnection *gc, const char *name, PurpleTypingState state); | |
51 | |
52 void serv_move_buddy(PurpleBuddy *, PurpleGroup *, PurpleGroup *); | |
53 int serv_send_im(PurpleConnection *, const char *, const char *, PurpleMessageFlags flags); | |
54 void serv_get_info(PurpleConnection *, const char *); | |
55 void serv_set_info(PurpleConnection *, const char *); | |
56 | |
57 void serv_add_permit(PurpleConnection *, const char *); | |
58 void serv_add_deny(PurpleConnection *, const char *); | |
59 void serv_rem_permit(PurpleConnection *, const char *); | |
60 void serv_rem_deny(PurpleConnection *, const char *); | |
61 void serv_set_permit_deny(PurpleConnection *); | |
62 void serv_chat_invite(PurpleConnection *, int, const char *, const char *); | |
63 void serv_chat_leave(PurpleConnection *, int); | |
64 void serv_chat_whisper(PurpleConnection *, int, const char *, const char *); | |
65 int serv_chat_send(PurpleConnection *, int, const char *, PurpleMessageFlags flags); | |
66 void serv_alias_buddy(PurpleBuddy *); | |
67 void serv_got_alias(PurpleConnection *gc, const char *who, const char *alias); | |
68 | |
69 /** | |
70 * Receive a typing message from a remote user. Either PURPLE_TYPING | |
71 * or PURPLE_TYPED. If the user has stopped typing then use | |
72 * serv_got_typing_stopped instead. | |
73 * | |
74 * TODO: Could probably move this into the conversation API. | |
75 * | |
76 * @param timeout If this is a number greater than 0, then | |
77 * Purple will wait this number of seconds and then | |
78 * set this buddy to the PURPLE_NOT_TYPING state. This | |
79 * is used by protocols that send repeated typing messages | |
80 * while the user is composing the message. | |
81 */ | |
82 void serv_got_typing(PurpleConnection *gc, const char *name, int timeout, | |
83 PurpleTypingState state); | |
84 | |
85 /** | |
86 * TODO: Could probably move this into the conversation API. | |
87 */ | |
88 void serv_got_typing_stopped(PurpleConnection *gc, const char *name); | |
89 | |
90 void serv_got_im(PurpleConnection *gc, const char *who, const char *msg, | |
91 PurpleMessageFlags flags, time_t mtime); | |
92 | |
93 /** | |
94 * @param data The hash function should be g_str_hash() and the equal | |
95 * function should be g_str_equal(). | |
96 */ | |
97 void serv_join_chat(PurpleConnection *, GHashTable *data); | |
98 | |
99 /** | |
100 * @param data The hash function should be g_str_hash() and the equal | |
101 * function should be g_str_equal(). | |
102 */ | |
103 void serv_reject_chat(PurpleConnection *, GHashTable *data); | |
104 | |
105 /** | |
106 * @param data The hash function should be g_str_hash() and the equal | |
107 * function should be g_str_equal(). | |
108 */ | |
109 void serv_got_chat_invite(PurpleConnection *gc, const char *name, | |
110 const char *who, const char *message, | |
111 GHashTable *data); | |
112 | |
113 PurpleConversation *serv_got_joined_chat(PurpleConnection *gc, | |
114 int id, const char *name); | |
115 void serv_got_chat_left(PurpleConnection *g, int id); | |
116 void serv_got_chat_in(PurpleConnection *g, int id, const char *who, | |
117 PurpleMessageFlags flags, const char *message, time_t mtime); | |
118 void serv_send_file(PurpleConnection *gc, const char *who, const char *file); | |
119 | |
120 #ifdef __cplusplus | |
121 } | |
122 #endif | |
123 | |
124 #endif /* _PURPLE_SERVER_H_ */ |