Mercurial > pidgin
annotate libpurple/server.h @ 29774:2140074fa387
Wordsmith 'to' => 'from' and 80-wide-wrap with an 8-char tab
author | Paul Aurich <paul@darkrain42.org> |
---|---|
date | Thu, 22 Apr 2010 05:18:52 +0000 |
parents | e37f85160784 |
children | 44f53d3fc54f |
rev | line source |
---|---|
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
2 * @file server.h Server API |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
3 * @ingroup core |
20074
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19685
diff
changeset
|
4 */ |
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19685
diff
changeset
|
5 |
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19685
diff
changeset
|
6 /* purple |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
7 * |
15822 | 8 * Purple is the legal property of its developers, whose names are too numerous |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
9 * to list here. Please refer to the COPYRIGHT file distributed with this |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
10 * source distribution. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
11 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
12 * This program is free software; you can redistribute it and/or modify |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
13 * it under the terms of the GNU General Public License as published by |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
14 * the Free Software Foundation; either version 2 of the License, or |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
15 * (at your option) any later version. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
16 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
17 * This program is distributed in the hope that it will be useful, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
20 * GNU General Public License for more details. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
21 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
22 * You should have received a copy of the GNU General Public License |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
23 * along with this program; if not, write to the Free Software |
19681
44b4e8bd759b
The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
19461
diff
changeset
|
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
25 */ |
15822 | 26 #ifndef _PURPLE_SERVER_H_ |
27 #define _PURPLE_SERVER_H_ | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
28 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
29 #include "account.h" |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
30 #include "conversation.h" |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
31 #include "prpl.h" |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
32 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
33 #ifdef __cplusplus |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
34 extern "C" { |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
35 #endif |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
36 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
37 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
38 * Send a typing message to a given user over a given connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
39 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
40 * TODO: Could probably move this into the conversation API. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
41 * |
16201
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
42 * @param gc The connection over which to send the typing notification. |
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
43 * @param name The user to send the typing notification to. |
15933
b449dc6b8a20
A little doxygen love and some tiny gaim->purpleisms
Mark Doliner <mark@kingant.net>
parents:
15822
diff
changeset
|
44 * @param state One of PURPLE_TYPING, PURPLE_TYPED, or PURPLE_NOT_TYPING. |
15822 | 45 * @return A quiet-period, specified in seconds, where Purple will not |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
46 * send any additional typing notification messages. Most |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
47 * protocols should return 0, which means that no additional |
15822 | 48 * PURPLE_TYPING messages need to be sent. If this is 5, for |
49 * example, then Purple will wait five seconds, and if the Purple | |
50 * user is still typing then Purple will send another PURPLE_TYPING | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
51 * message. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
52 */ |
15822 | 53 unsigned int serv_send_typing(PurpleConnection *gc, const char *name, PurpleTypingState state); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
54 |
15822 | 55 void serv_move_buddy(PurpleBuddy *, PurpleGroup *, PurpleGroup *); |
56 int serv_send_im(PurpleConnection *, const char *, const char *, PurpleMessageFlags flags); | |
19461
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
57 |
25924
584063555949
Remove trailing whitespace
Mark Doliner <mark@kingant.net>
parents:
23571
diff
changeset
|
58 /** Get information about an account's attention commands, from the prpl. |
584063555949
Remove trailing whitespace
Mark Doliner <mark@kingant.net>
parents:
23571
diff
changeset
|
59 * |
19461
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
60 * @return The attention command numbered 'code' from the prpl's attention_types, or NULL. |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
61 */ |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
62 PurpleAttentionType *purple_get_attention_type_from_code(PurpleAccount *account, guint type_code); |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
63 |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
64 /** Send an attention request message. |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
65 * |
23571
49850f7ca393
Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
23103
diff
changeset
|
66 * @deprecated Use purple_prpl_send_attention() instead. |
49850f7ca393
Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
23103
diff
changeset
|
67 * |
19461
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
68 * @param gc The connection to send the message on. |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
69 * @param who Whose attention to request. |
19685
f3e0b1221765
This will silence a few warnings when building the Doxygen docs.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
19681
diff
changeset
|
70 * @param type_code An index into the prpl's attention_types list determining the type |
19461
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
71 * of the attention request command to send. 0 if prpl only defines one |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
72 * (for example, Yahoo and MSN), but some protocols define more (MySpaceIM). |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
73 * |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
74 * Note that you can't send arbitrary PurpleAttentionType's, because there is |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
75 * only a fixed set of attention commands. |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
76 */ |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
77 void serv_send_attention(PurpleConnection *gc, const char *who, guint type_code); |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
78 |
25924
584063555949
Remove trailing whitespace
Mark Doliner <mark@kingant.net>
parents:
23571
diff
changeset
|
79 /** Process an incoming attention message. |
19461
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
80 * |
23571
49850f7ca393
Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
23103
diff
changeset
|
81 * @deprecated Use purple_prpl_got_attention() instead. |
49850f7ca393
Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
23103
diff
changeset
|
82 * |
19461
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
83 * @param gc The connection that received the attention message. |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
84 * @param who Who requested your attention. |
19685
f3e0b1221765
This will silence a few warnings when building the Doxygen docs.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
19681
diff
changeset
|
85 * @param type_code An index into the prpl's attention_types list determining the type |
25924
584063555949
Remove trailing whitespace
Mark Doliner <mark@kingant.net>
parents:
23571
diff
changeset
|
86 * of the attention request command to send. |
19461
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
87 */ |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
88 void serv_got_attention(PurpleConnection *gc, const char *who, guint type_code); |
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
89 |
15822 | 90 void serv_get_info(PurpleConnection *, const char *); |
91 void serv_set_info(PurpleConnection *, const char *); | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
92 |
15822 | 93 void serv_add_permit(PurpleConnection *, const char *); |
94 void serv_add_deny(PurpleConnection *, const char *); | |
95 void serv_rem_permit(PurpleConnection *, const char *); | |
96 void serv_rem_deny(PurpleConnection *, const char *); | |
97 void serv_set_permit_deny(PurpleConnection *); | |
98 void serv_chat_invite(PurpleConnection *, int, const char *, const char *); | |
99 void serv_chat_leave(PurpleConnection *, int); | |
100 void serv_chat_whisper(PurpleConnection *, int, const char *, const char *); | |
101 int serv_chat_send(PurpleConnection *, int, const char *, PurpleMessageFlags flags); | |
102 void serv_alias_buddy(PurpleBuddy *); | |
103 void serv_got_alias(PurpleConnection *gc, const char *who, const char *alias); | |
19461
1b5e786d137a
In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents:
19426
diff
changeset
|
104 |
22342
3232cc79fa51
This is part of a patch from felipec, also known as shx, that adds
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20074
diff
changeset
|
105 /** |
3232cc79fa51
This is part of a patch from felipec, also known as shx, that adds
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20074
diff
changeset
|
106 * A protocol plugin should call this when it retrieves a private alias from |
3232cc79fa51
This is part of a patch from felipec, also known as shx, that adds
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20074
diff
changeset
|
107 * the server. Private aliases are the aliases the user sets, while public |
3232cc79fa51
This is part of a patch from felipec, also known as shx, that adds
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20074
diff
changeset
|
108 * aliases are the aliases or display names that buddies set for themselves. |
3232cc79fa51
This is part of a patch from felipec, also known as shx, that adds
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20074
diff
changeset
|
109 * |
3232cc79fa51
This is part of a patch from felipec, also known as shx, that adds
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20074
diff
changeset
|
110 * @param gc The connection on which the alias was received. |
25925
6e1967b0f90b
Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents:
25924
diff
changeset
|
111 * @param who The name of the buddy whose alias was received. |
22342
3232cc79fa51
This is part of a patch from felipec, also known as shx, that adds
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20074
diff
changeset
|
112 * @param alias The alias that was received. |
3232cc79fa51
This is part of a patch from felipec, also known as shx, that adds
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20074
diff
changeset
|
113 */ |
3232cc79fa51
This is part of a patch from felipec, also known as shx, that adds
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20074
diff
changeset
|
114 void purple_serv_got_private_alias(PurpleConnection *gc, const char *who, const char *alias); |
3232cc79fa51
This is part of a patch from felipec, also known as shx, that adds
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20074
diff
changeset
|
115 |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
116 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
117 /** |
15822 | 118 * Receive a typing message from a remote user. Either PURPLE_TYPING |
119 * or PURPLE_TYPED. If the user has stopped typing then use | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
120 * serv_got_typing_stopped instead. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
121 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
122 * TODO: Could probably move this into the conversation API. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
123 * |
16201
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
124 * @param gc The connection on which the typing message was received. |
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
125 * @param name The name of the remote user. |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
126 * @param timeout If this is a number greater than 0, then |
15822 | 127 * Purple will wait this number of seconds and then |
128 * set this buddy to the PURPLE_NOT_TYPING state. This | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
129 * is used by protocols that send repeated typing messages |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
130 * while the user is composing the message. |
16201
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
131 * @param state The typing state received |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
132 */ |
15822 | 133 void serv_got_typing(PurpleConnection *gc, const char *name, int timeout, |
134 PurpleTypingState state); | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
135 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
136 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
137 * TODO: Could probably move this into the conversation API. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
138 */ |
15822 | 139 void serv_got_typing_stopped(PurpleConnection *gc, const char *name); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
140 |
15822 | 141 void serv_got_im(PurpleConnection *gc, const char *who, const char *msg, |
142 PurpleMessageFlags flags, time_t mtime); | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
143 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
144 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
145 * @param data The hash function should be g_str_hash() and the equal |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
146 * function should be g_str_equal(). |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
147 */ |
15933
b449dc6b8a20
A little doxygen love and some tiny gaim->purpleisms
Mark Doliner <mark@kingant.net>
parents:
15822
diff
changeset
|
148 void serv_join_chat(PurpleConnection *, GHashTable *data); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
149 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
150 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
151 * @param data The hash function should be g_str_hash() and the equal |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
152 * function should be g_str_equal(). |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
153 */ |
15933
b449dc6b8a20
A little doxygen love and some tiny gaim->purpleisms
Mark Doliner <mark@kingant.net>
parents:
15822
diff
changeset
|
154 void serv_reject_chat(PurpleConnection *, GHashTable *data); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
155 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
156 /** |
16201
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
157 * Called by a prpl when an account is invited into a chat. |
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
158 * |
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
159 * @param gc The connection on which the invite arrived. |
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
160 * @param name The name of the chat you're being invited to. |
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
161 * @param who The username of the person inviting the account. |
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
162 * @param message The optional invite message. |
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
163 * @param data The components necessary if you want to call serv_join_chat(). |
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
164 * The hash function should be g_str_hash() and the equal |
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
15933
diff
changeset
|
165 * function should be g_str_equal(). |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
166 */ |
15822 | 167 void serv_got_chat_invite(PurpleConnection *gc, const char *name, |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
168 const char *who, const char *message, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
169 GHashTable *data); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
170 |
28598
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
171 /** |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
172 * Called by a prpl when an account has joined a chat. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
173 * |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
174 * @param gc The connection on which the chat was joined. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
175 * @param id The id of the chat, assigned by the prpl. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
176 * @param name The name of the chat. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
177 * @return The resulting conversation |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
178 */ |
15822 | 179 PurpleConversation *serv_got_joined_chat(PurpleConnection *gc, |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
180 int id, const char *name); |
22771
43233dc1d40b
applied changes from 4c5110037671f84e3e775214c32692b5b23c11e1
Evan Schoenberg <evan.s@dreskin.net>
parents:
22770
diff
changeset
|
181 /** |
43233dc1d40b
applied changes from 4c5110037671f84e3e775214c32692b5b23c11e1
Evan Schoenberg <evan.s@dreskin.net>
parents:
22770
diff
changeset
|
182 * Called by a prpl when an attempt to join a chat via serv_join_chat() |
43233dc1d40b
applied changes from 4c5110037671f84e3e775214c32692b5b23c11e1
Evan Schoenberg <evan.s@dreskin.net>
parents:
22770
diff
changeset
|
183 * fails. |
43233dc1d40b
applied changes from 4c5110037671f84e3e775214c32692b5b23c11e1
Evan Schoenberg <evan.s@dreskin.net>
parents:
22770
diff
changeset
|
184 * |
43233dc1d40b
applied changes from 4c5110037671f84e3e775214c32692b5b23c11e1
Evan Schoenberg <evan.s@dreskin.net>
parents:
22770
diff
changeset
|
185 * @param gc The connection on which chat joining failed |
23103
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22771
diff
changeset
|
186 * @param data The components passed to serv_join_chat() originally. |
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22771
diff
changeset
|
187 * The hash function should be g_str_hash() and the equal |
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22771
diff
changeset
|
188 * function should be g_str_equal(). |
22771
43233dc1d40b
applied changes from 4c5110037671f84e3e775214c32692b5b23c11e1
Evan Schoenberg <evan.s@dreskin.net>
parents:
22770
diff
changeset
|
189 */ |
23103
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22771
diff
changeset
|
190 void purple_serv_got_join_chat_failed(PurpleConnection *gc, GHashTable *data); |
25924
584063555949
Remove trailing whitespace
Mark Doliner <mark@kingant.net>
parents:
23571
diff
changeset
|
191 |
28598
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
192 /** |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
193 * Called by a prpl when an account has left a chat. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
194 * |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
195 * @param g The connection on which the chat was left. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
196 * @param id The id of the chat, as assigned by the prpl. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
197 */ |
15822 | 198 void serv_got_chat_left(PurpleConnection *g, int id); |
28598
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
199 |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
200 /** |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
201 * Called by a prpl when a message has been received in a chat. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
202 * |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
203 * @param g The connection on which the message was received. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
204 * @param id The id of the chat, as assigned by the prpl. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
205 * @param who The name of the user who sent the message. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
206 * @param flags The flags of the message. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
207 * @param message The message received in the chat. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
208 * @param mtime The time when the message was received. |
e37f85160784
Documented chat API. References #10605
sttwister@gmail.com
parents:
25925
diff
changeset
|
209 */ |
15822 | 210 void serv_got_chat_in(PurpleConnection *g, int id, const char *who, |
211 PurpleMessageFlags flags, const char *message, time_t mtime); | |
212 void serv_send_file(PurpleConnection *gc, const char *who, const char *file); | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
213 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
214 #ifdef __cplusplus |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
215 } |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
216 #endif |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
217 |
15822 | 218 #endif /* _PURPLE_SERVER_H_ */ |