Mercurial > pidgin
annotate src/prpl.h @ 12767:53218d758ba9
[gaim-migrate @ 15114]
Make the dns lookup for udp connecting asynchronous. Thomas pointed out that it should be instantaneous anyway because the SRV lookup that has just been done, but this'll avoid blocking if the SRV lookup failed or something.
committer: Tailor Script <tailor@pidgin.im>
author | Daniel Atallah <daniel.atallah@gmail.com> |
---|---|
date | Sun, 08 Jan 2006 22:09:28 +0000 |
parents | fc28451f5d96 |
children | 82e918444965 |
rev | line source |
---|---|
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
1 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
2 * @file prpl.h Protocol Plugin functions |
5034
4691c5936c01
[gaim-migrate @ 5377]
Christian Hammond <chipx86@chipx86.com>
parents:
4966
diff
changeset
|
3 * @ingroup core |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
4 * |
981 | 5 * gaim |
6 * | |
8046 | 7 * Gaim 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. | |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
10 * |
981 | 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 | |
2417
5473c8c5378d
[gaim-migrate @ 2430]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2411
diff
changeset
|
26 /* this file should be all that prpls need to include. therefore, by including |
5473c8c5378d
[gaim-migrate @ 2430]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2411
diff
changeset
|
27 * this file, they should get glib, proxy, gaim_connection, prpl, etc. */ |
981 | 28 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
29 #ifndef _GAIM_PRPL_H_ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
30 #define _GAIM_PRPL_H_ |
2417
5473c8c5378d
[gaim-migrate @ 2430]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2411
diff
changeset
|
31 |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
32 typedef struct _GaimPluginProtocolInfo GaimPluginProtocolInfo; |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
33 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
34 /**************************************************************************/ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
35 /** @name Basic Protocol Information */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
36 /**************************************************************************/ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
37 |
9318 | 38 typedef enum { |
39 GAIM_ICON_SCALE_DISPLAY = 0x01, /**< We scale the icon when we display it */ | |
40 GAIM_ICON_SCALE_SEND = 0x02 /**< We scale the icon before we send it to the server */ | |
41 } GaimIconScaleRules; | |
42 | |
43 | |
9308 | 44 /** |
45 * A description of a Buddy Icon specification. This tells Gaim what kind of image file | |
46 * it should give this prpl, and what kind of image file it should expect back. | |
9316 | 47 * Dimensions less than 1 should be ignored and the image not scaled. |
9308 | 48 */ |
49 typedef struct { | |
50 char *format; /**< This is a comma-delimited list of image formats or NULL if icons are not supported. | |
51 * The core nor the prpl will actually check to see if the data it's given matches this, it's entirely | |
52 * up to the UI to do what it wants */ | |
9318 | 53 int min_width; /**< The minimum width of this icon */ |
54 int min_height; /**< The minimum height of this icon */ | |
55 int max_width; /**< The maximum width of this icon */ | |
56 int max_height; /**< The maximum height of this icon */ | |
57 GaimIconScaleRules scale_rules; /**< How to stretch this icon */ | |
9308 | 58 } GaimBuddyIconSpec; |
59 | |
9999 | 60 /** |
11035
11e465b55fe6
[gaim-migrate @ 12922]
Gary Kramlich <grim@reaperworld.com>
parents:
10870
diff
changeset
|
61 * This \#define exists just to make it easier to fill out the buddy icon |
9999 | 62 * field in the prpl info struct for protocols that couldn't care less. |
63 */ | |
9318 | 64 #define NO_BUDDY_ICONS {NULL, 0, 0, 0, 0, 0} |
9308 | 65 |
8573 | 66 #include "blist.h" |
12216 | 67 #include "conversation.h" |
12143
cbebda5f019c
[gaim-migrate @ 14444]
Richard Laager <rlaager@wiktel.com>
parents:
12024
diff
changeset
|
68 #include "ft.h" |
8573 | 69 #include "proxy.h" |
70 #include "plugin.h" | |
12024 | 71 #include "media.h" |
9999 | 72 #include "roomlist.h" |
9944 | 73 #include "status.h" |
11475
7fab28c991f3
[gaim-migrate @ 13717]
Gary Kramlich <grim@reaperworld.com>
parents:
11462
diff
changeset
|
74 #include "whiteboard.h" |
8573 | 75 |
9713 | 76 struct proto_chat_entry { |
77 char *label; | |
78 char *identifier; | |
10475 | 79 gboolean required; |
9713 | 80 gboolean is_int; |
81 int min; | |
82 int max; | |
83 gboolean secret; | |
84 }; | |
85 | |
6622 | 86 /** |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
87 * Protocol options |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
88 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
89 * These should all be stuff that some plugins can do and others can't. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
90 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
91 typedef enum |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
92 { |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
93 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
94 * Use a unique name, not an alias, for chat rooms. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
95 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
96 * Jabber lets you choose what name you want for chat. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
97 * So it shouldn't be pulling the alias for when you're in chat; |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
98 * it gets annoying. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
99 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
100 OPT_PROTO_UNIQUE_CHATNAME = 0x00000004, |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
101 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
102 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
103 * Chat rooms have topics. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
104 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
105 * IRC and Jabber support this. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
106 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
107 OPT_PROTO_CHAT_TOPIC = 0x00000008, |
1370
776bb4c6c0b8
[gaim-migrate @ 1380]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
1355
diff
changeset
|
108 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
109 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
110 * Don't require passwords for sign-in. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
111 * |
9999 | 112 * Zephyr doesn't require passwords, so there's no |
113 * need for a password prompt. | |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
114 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
115 OPT_PROTO_NO_PASSWORD = 0x00000010, |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
116 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
117 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
118 * Notify on new mail. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
119 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
120 * MSN and Yahoo notify you when you have new mail. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
121 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
122 OPT_PROTO_MAIL_CHECK = 0x00000020, |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
123 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
124 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
125 * Images in IMs. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
126 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
127 * Oscar lets you send images in direct IMs. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
128 */ |
9999 | 129 OPT_PROTO_IM_IMAGE = 0x00000040, |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
130 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
131 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
132 * Allow passwords to be optional. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
133 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
134 * Passwords in IRC are optional, and are needed for certain |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
135 * functionality. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
136 */ |
9999 | 137 OPT_PROTO_PASSWORD_OPTIONAL = 0x00000080, |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
138 |
5367 | 139 /** |
140 * Allows font size to be specified in sane point size | |
141 * | |
142 * Probably just Jabber and Y!M | |
143 */ | |
11358 | 144 OPT_PROTO_USE_POINTSIZE = 0x00000100, |
145 | |
146 /** | |
147 * Set the Register button active when screenname is not given. | |
148 * | |
149 * Gadu-Gadu doesn't need a screenname to register new account. | |
150 */ | |
151 OPT_PROTO_REGISTER_NOSCREENNAME = 0x00000200, | |
5367 | 152 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
153 } GaimProtocolOptions; |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
154 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
155 /** |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
156 * A protocol plugin information structure. |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
157 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
158 * Every protocol plugin initializes this structure. It is the gateway |
10160 | 159 * between gaim and the protocol plugin. Many of this callbacks can be |
10162 | 160 * NULL. If a callback must be implemented, it has a comment indicating so. |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
161 */ |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
162 struct _GaimPluginProtocolInfo |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
163 { |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
164 GaimProtocolOptions options; /**< Protocol options. */ |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
165 |
5638
0bdfa28c678e
[gaim-migrate @ 6047]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
166 GList *user_splits; /* A GList of GaimAccountUserSplit */ |
0bdfa28c678e
[gaim-migrate @ 6047]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
167 GList *protocol_options; /* A GList of GaimAccountOption */ |
10160 | 168 |
9308 | 169 GaimBuddyIconSpec icon_spec; /* The icon spec. */ |
10160 | 170 |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
171 /** |
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
172 * Returns the base icon name for the given buddy and account. |
10160 | 173 * If buddy is NULL, it will return the name to use for the account's |
174 * icon. This must be implemented. | |
4687 | 175 */ |
6695 | 176 const char *(*list_icon)(GaimAccount *account, GaimBuddy *buddy); |
4687 | 177 |
178 /** | |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
179 * Fills the four char**'s with string identifiers for "emblems" |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
180 * that the UI will interpret and display as relevant |
4687 | 181 */ |
9952 | 182 void (*list_emblems)(GaimBuddy *buddy, const char **se, const char **sw, |
183 const char **nw, const char **ne); | |
4722 | 184 |
185 /** | |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
186 * Gets a short string representing this buddy's status. This will |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
187 * be shown on the buddy list. |
4722 | 188 */ |
6695 | 189 char *(*status_text)(GaimBuddy *buddy); |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
190 |
4724 | 191 /** |
192 * Gets a string to put in the buddy list tooltip. | |
193 */ | |
6695 | 194 char *(*tooltip_text)(GaimBuddy *buddy); |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
195 |
10200 | 196 /** |
197 * This must be implemented, and must add at least the offline | |
198 * and online states. | |
199 */ | |
9950 | 200 GList *(*status_types)(GaimAccount *account); |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
201 |
9030 | 202 GList *(*blist_node_menu)(GaimBlistNode *node); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
203 GList *(*chat_info)(GaimConnection *); |
9754 | 204 GHashTable *(*chat_info_defaults)(GaimConnection *, const char *chat_name); |
1333
b332d8f46b84
[gaim-migrate @ 1343]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
1318
diff
changeset
|
205 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
206 /* All the server-related functions */ |
10160 | 207 |
208 /** This must be implemented. */ | |
11837 | 209 void (*login)(GaimAccount *); |
10160 | 210 |
211 /** This must be implemented. */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
212 void (*close)(GaimConnection *); |
11693 | 213 |
214 /** | |
215 * This PRPL function should return a positive value on success. | |
216 * If the message is too big to be sent, return -E2BIG. If | |
217 * the account is not connected, return -ENOTCONN. If the | |
218 * PRPL is unable to send the message for another reason, return | |
219 * some other negative value. You can use one of the valid | |
220 * errno values, or just big something. If the message should | |
221 * not be echoed to the conversation window, return 0. | |
222 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
223 int (*send_im)(GaimConnection *, const char *who, |
6982 | 224 const char *message, |
12216 | 225 GaimMessageFlags flags); |
11693 | 226 |
5954 | 227 void (*set_info)(GaimConnection *, const char *info); |
6059 | 228 int (*send_typing)(GaimConnection *, const char *name, int typing); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
229 void (*get_info)(GaimConnection *, const char *who); |
9949 | 230 void (*set_status)(GaimAccount *account, GaimStatus *status); |
231 | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
232 void (*set_idle)(GaimConnection *, int idletime); |
5946
209cae24a51d
[gaim-migrate @ 6387]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
233 void (*change_passwd)(GaimConnection *, const char *old_pass, |
209cae24a51d
[gaim-migrate @ 6387]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
234 const char *new_pass); |
9285 | 235 void (*add_buddy)(GaimConnection *, GaimBuddy *buddy, GaimGroup *group); |
236 void (*add_buddies)(GaimConnection *, GList *buddies, GList *groups); | |
237 void (*remove_buddy)(GaimConnection *, GaimBuddy *buddy, GaimGroup *group); | |
238 void (*remove_buddies)(GaimConnection *, GList *buddies, GList *groups); | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
239 void (*add_permit)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
240 void (*add_deny)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
241 void (*rem_permit)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
242 void (*rem_deny)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
243 void (*set_permit_deny)(GaimConnection *); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
244 void (*join_chat)(GaimConnection *, GHashTable *components); |
8562 | 245 void (*reject_chat)(GaimConnection *, GHashTable *components); |
9917 | 246 char *(*get_chat_name)(GHashTable *components); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
247 void (*chat_invite)(GaimConnection *, int id, |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
248 const char *who, const char *message); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
249 void (*chat_leave)(GaimConnection *, int id); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
250 void (*chat_whisper)(GaimConnection *, int id, |
6059 | 251 const char *who, const char *message); |
12216 | 252 int (*chat_send)(GaimConnection *, int id, const char *message, GaimMessageFlags flags); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
253 void (*keepalive)(GaimConnection *); |
1713
14caa7df478c
[gaim-migrate @ 1723]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
1626
diff
changeset
|
254 |
2827
51999a36c0b1
[gaim-migrate @ 2840]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2773
diff
changeset
|
255 /* new user registration */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
256 void (*register_user)(GaimAccount *); |
2956 | 257 |
258 /* get "chat buddy" info and away message */ | |
6059 | 259 void (*get_cb_info)(GaimConnection *, int, const char *who); |
260 void (*get_cb_away)(GaimConnection *, int, const char *who); | |
2827
51999a36c0b1
[gaim-migrate @ 2840]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2773
diff
changeset
|
261 |
3136 | 262 /* save/store buddy's alias on server list/roster */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
263 void (*alias_buddy)(GaimConnection *, const char *who, |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
264 const char *alias); |
3136 | 265 |
266 /* change a buddy's group on a server list/roster */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
267 void (*group_buddy)(GaimConnection *, const char *who, |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
268 const char *old_group, const char *new_group); |
3136 | 269 |
3348 | 270 /* rename a group on a server list/roster */ |
9285 | 271 void (*rename_group)(GaimConnection *, const char *old_name, |
272 GaimGroup *group, GList *moved_buddies); | |
3348 | 273 |
6695 | 274 void (*buddy_free)(GaimBuddy *); |
2607
e0d4a23aac89
[gaim-migrate @ 2620]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2582
diff
changeset
|
275 |
6059 | 276 void (*convo_closed)(GaimConnection *, const char *who); |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
277 |
7322 | 278 const char *(*normalize)(const GaimAccount *, const char *); |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
279 |
5842 | 280 void (*set_buddy_icon)(GaimConnection *, const char *filename); |
6885
66dd420d3d23
[gaim-migrate @ 7431]
Christian Hammond <chipx86@chipx86.com>
parents:
6846
diff
changeset
|
281 |
9285 | 282 void (*remove_group)(GaimConnection *gc, GaimGroup *group); |
7398 | 283 |
284 char *(*get_cb_real_name)(GaimConnection *gc, int id, const char *who); | |
7971 | 285 |
286 void (*set_chat_topic)(GaimConnection *gc, int id, const char *topic); | |
7999 | 287 |
288 GaimChat *(*find_blist_chat)(GaimAccount *account, const char *name); | |
8113 | 289 |
290 /* room listing prpl callbacks */ | |
9999 | 291 GaimRoomlist *(*roomlist_get_list)(GaimConnection *gc); |
292 void (*roomlist_cancel)(GaimRoomlist *list); | |
293 void (*roomlist_expand_category)(GaimRoomlist *list, GaimRoomlistRoom *category); | |
9466 | 294 |
295 /* file transfer callbacks */ | |
296 gboolean (*can_receive_file)(GaimConnection *, const char *who); | |
297 void (*send_file)(GaimConnection *, const char *who, const char *filename); | |
12143
cbebda5f019c
[gaim-migrate @ 14444]
Richard Laager <rlaager@wiktel.com>
parents:
12024
diff
changeset
|
298 GaimXfer *(*new_xfer)(GaimConnection *, const char *who); |
12645
fc28451f5d96
[gaim-migrate @ 14983]
Richard Laager <rlaager@wiktel.com>
parents:
12216
diff
changeset
|
299 gboolean (*offline_message)(const GaimBuddy *buddy); |
12143
cbebda5f019c
[gaim-migrate @ 14444]
Richard Laager <rlaager@wiktel.com>
parents:
12024
diff
changeset
|
300 |
11475
7fab28c991f3
[gaim-migrate @ 13717]
Gary Kramlich <grim@reaperworld.com>
parents:
11462
diff
changeset
|
301 GaimWhiteboardPrplOps *whiteboard_prpl_ops; |
12024 | 302 GaimMediaPrplOps *media_prpl_ops; |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
303 }; |
2246
933346315b9b
[gaim-migrate @ 2256]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2232
diff
changeset
|
304 |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
305 #define GAIM_IS_PROTOCOL_PLUGIN(plugin) \ |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
306 ((plugin)->info->type == GAIM_PLUGIN_PROTOCOL) |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
307 |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
308 #define GAIM_PLUGIN_PROTOCOL_INFO(plugin) \ |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
309 ((GaimPluginProtocolInfo *)(plugin)->info->extra_info) |
981 | 310 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
311 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
312 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
313 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
314 |
9944 | 315 /**************************************************************************/ |
316 /** @name Protocol Plugin API */ | |
317 /**************************************************************************/ | |
318 /*@{*/ | |
319 | |
320 /** | |
321 * Notifies Gaim that an account's idle state and time have changed. | |
322 * | |
323 * This is meant to be called from protocol plugins. | |
324 * | |
325 * @param account The account. | |
326 * @param idle The user's idle state. | |
327 * @param idle_time The user's idle time. | |
328 */ | |
329 void gaim_prpl_got_account_idle(GaimAccount *account, gboolean idle, | |
330 time_t idle_time); | |
331 | |
332 /** | |
333 * Notifies Gaim of an account's log-in time. | |
334 * | |
335 * This is meant to be called from protocol plugins. | |
336 * | |
337 * @param account The account the user is on. | |
338 * @param login_time The user's log-in time. | |
339 */ | |
10870 | 340 void gaim_prpl_got_account_login_time(GaimAccount *account, time_t login_time); |
9944 | 341 |
342 /** | |
343 * Notifies Gaim that an account's status has changed. | |
344 * | |
345 * This is meant to be called from protocol plugins. | |
346 * | |
347 * @param account The account the user is on. | |
348 * @param status_id The status ID. | |
349 * @param attr_id The first attribute ID, or NULL for no attribute updates. | |
350 * @param ... A NULL-terminated list of attribute IDs and values, | |
351 * beginning with the value for @a attr_id. | |
352 */ | |
353 void gaim_prpl_got_account_status(GaimAccount *account, | |
354 const char *status_id, const char *attr_id, | |
355 ...); | |
356 /** | |
357 * Notifies Gaim that a user's idle state and time have changed. | |
358 * | |
359 * This is meant to be called from protocol plugins. | |
360 * | |
361 * @param account The account the user is on. | |
362 * @param name The screen name of the user. | |
363 * @param idle The user's idle state. | |
10860 | 364 * @param idle_time The user's idle time. This is the time at |
365 * which the user became idle, in seconds since | |
366 * the epoch. | |
9944 | 367 */ |
368 void gaim_prpl_got_user_idle(GaimAccount *account, const char *name, | |
369 gboolean idle, time_t idle_time); | |
370 | |
371 /** | |
372 * Notifies Gaim of a user's log-in time. | |
373 * | |
374 * This is meant to be called from protocol plugins. | |
375 * | |
376 * @param account The account the user is on. | |
377 * @param name The screen name of the user. | |
378 * @param login_time The user's log-in time. | |
379 */ | |
380 void gaim_prpl_got_user_login_time(GaimAccount *account, const char *name, | |
381 time_t login_time); | |
382 | |
383 /** | |
384 * Notifies Gaim that a user's status has changed. | |
385 * | |
386 * This is meant to be called from protocol plugins. | |
387 * | |
388 * @param account The account the user is on. | |
389 * @param name The screen name of the user. | |
390 * @param status_id The status ID. | |
391 * @param attr_id The first attribute ID, or NULL for no attribute updates. | |
392 * @param ... A NULL-terminated list of attribute IDs and values, | |
393 * beginning with the value for @a attr_id. | |
394 */ | |
395 void gaim_prpl_got_user_status(GaimAccount *account, const char *name, | |
396 const char *status_id, const char *attr_id, ...); | |
397 /** | |
398 * Informs the server that an account's status changed. | |
399 * | |
10447 | 400 * @param account The account the user is on. |
401 * @param old_status The previous status. | |
402 * @param new_status The status that was activated, or deactivated | |
403 * (in the case of independent statuses). | |
9944 | 404 */ |
10447 | 405 void gaim_prpl_change_account_status(GaimAccount *account, |
406 GaimStatus *old_status, | |
407 GaimStatus *new_status); | |
9944 | 408 |
10006 | 409 /** |
410 * Retrieves the list of stock status types from a prpl. | |
411 * | |
412 * @param account The account the user is on. | |
413 * @param presence The presence for which we're going to get statuses | |
414 * | |
415 * @return List of statuses | |
416 */ | |
417 GList *gaim_prpl_get_statuses(GaimAccount *account, GaimPresence *presence); | |
418 | |
9944 | 419 /*@}*/ |
420 | |
421 /**************************************************************************/ | |
422 /** @name Protocol Plugin Subsystem API */ | |
423 /**************************************************************************/ | |
424 /*@{*/ | |
425 | |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
426 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
427 * Finds a protocol plugin structure of the specified type. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
428 * |
9000 | 429 * @param id The protocol plugin; |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
430 */ |
7956 | 431 GaimPlugin *gaim_find_prpl(const char *id); |
981 | 432 |
9944 | 433 /*@}*/ |
434 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
435 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
436 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
437 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
438 |
2417
5473c8c5378d
[gaim-migrate @ 2430]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2411
diff
changeset
|
439 #endif /* _PRPL_H_ */ |