annotate libpurple/prpl.h @ 28617:b6374abb0510

Finish making this change that I started earlier today. This doesn't change the string freeze. The reason for doing it this way is so that translators don't have to deal with the HTML--less room for error
author Mark Doliner <mark@kingant.net>
date Sun, 22 Nov 2009 22:39:51 +0000
parents e37f85160784
children 45a94940c122 a538cb73f897
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 prpl.h Protocol Plugin functions
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: 19703
diff changeset
4 */
6bf32c9e15a7 remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents: 19703
diff changeset
5
6bf32c9e15a7 remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents: 19703
diff changeset
6 /* purple
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
7 *
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
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: 19463
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 */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
26
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
27 /* this file should be all that prpls need to include. therefore, by including
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
28 * this file, they should get glib, proxy, purple_connection, prpl, etc. */
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
29
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
30 #ifndef _PURPLE_PRPL_H_
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
31 #define _PURPLE_PRPL_H_
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
32
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
33 typedef struct _PurplePluginProtocolInfo PurplePluginProtocolInfo;
23371
3f92fd48d19a document PurpleAttentionType slightly
Will Thompson <will.thompson@collabora.co.uk>
parents: 23208
diff changeset
34 /** @copydoc _PurpleAttentionType */
19426
6395c2e96bc2 Attention API for nudges/buzzes/zaps of various protocols.
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19289
diff changeset
35 typedef struct _PurpleAttentionType PurpleAttentionType;
15373
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 /** @name Basic Protocol Information */
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
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
41 typedef enum {
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
42 PURPLE_ICON_SCALE_DISPLAY = 0x01, /**< We scale the icon when we display it */
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
43 PURPLE_ICON_SCALE_SEND = 0x02 /**< We scale the icon before we send it to the server */
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
44 } PurpleIconScaleRules;
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
45
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
46
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
47 /**
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
48 * A description of a Buddy Icon specification. This tells Purple what kind of image file
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
49 * it should give this prpl, and what kind of image file it should expect back.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
50 * Dimensions less than 1 should be ignored and the image not scaled.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
51 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
52 typedef struct _PurpleBuddyIconSpec PurpleBuddyIconSpec;
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
53
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
54 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
55 * This \#define exists just to make it easier to fill out the buddy icon
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
56 * field in the prpl info struct for protocols that couldn't care less.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
57 */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
58 #define NO_BUDDY_ICONS {NULL, 0, 0, 0, 0, 0, 0}
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
59
17343
8c056932bcc2 Don't include unistd.h if HAVE_UNISTD_H isn't defined.
Daniel Atallah <daniel.atallah@gmail.com>
parents: 16904
diff changeset
60 #ifdef HAVE_UNISTD_H
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
61 #include <unistd.h>
17343
8c056932bcc2 Don't include unistd.h if HAVE_UNISTD_H isn't defined.
Daniel Atallah <daniel.atallah@gmail.com>
parents: 16904
diff changeset
62 #endif
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
63
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
64 #include "blist.h"
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
65 #include "conversation.h"
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
66 #include "ft.h"
16390
4fc51a87ce42 Updates for the account buddy icon stuff. This doesn't yet work fully (and maybe not even partly), but it compiles.
Richard Laager <rlaager@wiktel.com>
parents: 15822
diff changeset
67 #include "imgstore.h"
23759
315151da0dc6 Basic Google Talk voice call support. No UI; receiving a call auto-accepts it.
Sean Egan <seanegan@gmail.com>
parents: 19463
diff changeset
68 #include "media.h"
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
69 #include "notify.h"
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
70 #include "proxy.h"
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
71 #include "plugin.h"
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
72 #include "roomlist.h"
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
73 #include "status.h"
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
74 #include "whiteboard.h"
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
75
23208
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
76
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
77 /** @copydoc PurpleBuddyIconSpec */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
78 struct _PurpleBuddyIconSpec {
23208
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
79 /** This is a comma-delimited list of image formats or @c NULL if icons
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
80 * are not supported. Neither the core nor the prpl will actually
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
81 * check to see if the data it's given matches this; it's entirely up
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
82 * to the UI to do what it wants
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
83 */
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
84 char *format;
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
85
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
86 int min_width; /**< Minimum width of this icon */
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
87 int min_height; /**< Minimum height of this icon */
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
88 int max_width; /**< Maximum width of this icon */
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
89 int max_height; /**< Maximum height of this icon */
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
90 size_t max_filesize; /**< Maximum size in bytes */
d3fb9d9b57e2 Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
Will Thompson <will.thompson@collabora.co.uk>
parents: 23114
diff changeset
91 PurpleIconScaleRules scale_rules; /**< How to stretch this icon */
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
92 };
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
93
28598
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
94 /** Represents an entry containing information that must be supplied by the
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
95 * user when joining a chat.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
96 */
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
97 struct proto_chat_entry {
28598
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
98 const char *label; /**< User-friendly name of the entry */
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
99 const char *identifier; /**< Used by the PRPL to identify the option */
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
100 gboolean required; /**< True if it's required */
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
101 gboolean is_int; /**< True if the entry expects an integer */
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
102 int min; /**< Minimum value in case of integer */
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
103 int max; /**< Maximum value in case of integer */
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
104 gboolean secret; /**< True if the entry is secret (password) */
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
105 };
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
106
23371
3f92fd48d19a document PurpleAttentionType slightly
Will Thompson <will.thompson@collabora.co.uk>
parents: 23208
diff changeset
107 /** Represents "nudges" and "buzzes" that you may send to a buddy to attract
3f92fd48d19a document PurpleAttentionType slightly
Will Thompson <will.thompson@collabora.co.uk>
parents: 23208
diff changeset
108 * their attention (or vice-versa).
3f92fd48d19a document PurpleAttentionType slightly
Will Thompson <will.thompson@collabora.co.uk>
parents: 23208
diff changeset
109 */
19426
6395c2e96bc2 Attention API for nudges/buzzes/zaps of various protocols.
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19289
diff changeset
110 struct _PurpleAttentionType
6395c2e96bc2 Attention API for nudges/buzzes/zaps of various protocols.
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19289
diff changeset
111 {
6395c2e96bc2 Attention API for nudges/buzzes/zaps of various protocols.
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19289
diff changeset
112 const char *name; /**< Shown in GUI elements */
6395c2e96bc2 Attention API for nudges/buzzes/zaps of various protocols.
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19289
diff changeset
113 const char *incoming_description; /**< Shown when sent */
6395c2e96bc2 Attention API for nudges/buzzes/zaps of various protocols.
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19289
diff changeset
114 const char *outgoing_description; /**< Shown when receied */
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
115 const char *icon_name; /**< Icon to display (optional) */
22097
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
116 const char *unlocalized_name; /**< Unlocalized name for UIs needing it */
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
117
1b5e786d137a In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19426
diff changeset
118 /* Reserved fields for future purposes */
1b5e786d137a In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19426
diff changeset
119 gpointer _reserved2;
1b5e786d137a In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19426
diff changeset
120 gpointer _reserved3;
1b5e786d137a In the attention API, use the PURPLE_NOTIFY_MESSAGE flag to serv_got_im()
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19426
diff changeset
121 gpointer _reserved4;
19426
6395c2e96bc2 Attention API for nudges/buzzes/zaps of various protocols.
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19289
diff changeset
122 };
6395c2e96bc2 Attention API for nudges/buzzes/zaps of various protocols.
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19289
diff changeset
123
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
124 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
125 * Protocol options
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
126 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
127 * These should all be stuff that some plugins can do and others can't.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
128 */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
129 typedef enum
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
130 {
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
131 /**
26903
cda10ae89918 Clarify (hopefully) the usage of OPT_PROTO_UNIQUE_CHATNAME; arose in a discussion in #pidgin.
Paul Aurich <paul@darkrain42.org>
parents: 26694
diff changeset
132 * User names are unique to a chat and are not shared between rooms.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
133 *
26903
cda10ae89918 Clarify (hopefully) the usage of OPT_PROTO_UNIQUE_CHATNAME; arose in a discussion in #pidgin.
Paul Aurich <paul@darkrain42.org>
parents: 26694
diff changeset
134 * XMPP lets you choose what name you want in chats, so it shouldn't
cda10ae89918 Clarify (hopefully) the usage of OPT_PROTO_UNIQUE_CHATNAME; arose in a discussion in #pidgin.
Paul Aurich <paul@darkrain42.org>
parents: 26694
diff changeset
135 * be pulling the aliases from the buddy list for the chat list;
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
136 * it gets annoying.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
137 */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
138 OPT_PROTO_UNIQUE_CHATNAME = 0x00000004,
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
139
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
140 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
141 * Chat rooms have topics.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
142 *
16904
56042b2f8b64 s/Jabber/XMPP in user-visible places.
Richard Laager <rlaager@wiktel.com>
parents: 16719
diff changeset
143 * IRC and XMPP support this.
15373
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 OPT_PROTO_CHAT_TOPIC = 0x00000008,
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
146
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
147 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
148 * Don't require passwords for sign-in.
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 * Zephyr doesn't require passwords, so there's no
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
151 * need for a password prompt.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
152 */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
153 OPT_PROTO_NO_PASSWORD = 0x00000010,
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
154
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 * Notify on new mail.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
157 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
158 * MSN and Yahoo notify you when you have new mail.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
159 */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
160 OPT_PROTO_MAIL_CHECK = 0x00000020,
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
161
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
162 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
163 * Images in IMs.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
164 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
165 * Oscar lets you send images in direct IMs.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
166 */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
167 OPT_PROTO_IM_IMAGE = 0x00000040,
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
168
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
169 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
170 * Allow passwords to be optional.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
171 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
172 * Passwords in IRC are optional, and are needed for certain
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
173 * functionality.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
174 */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
175 OPT_PROTO_PASSWORD_OPTIONAL = 0x00000080,
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
176
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
177 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
178 * Allows font size to be specified in sane point size
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
179 *
16904
56042b2f8b64 s/Jabber/XMPP in user-visible places.
Richard Laager <rlaager@wiktel.com>
parents: 16719
diff changeset
180 * Probably just XMPP and Y!M
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
181 */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
182 OPT_PROTO_USE_POINTSIZE = 0x00000100,
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
183
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
184 /**
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
185 * Set the Register button active even when the username has not
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
186 * been specified.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
187 *
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
188 * Gadu-Gadu doesn't need a username to register new account (because
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
189 * usernames are assigned by the server).
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
190 */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
191 OPT_PROTO_REGISTER_NOSCREENNAME = 0x00000200,
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
192
18030
62a71bb085ef Mostly taken from the patch on ticket #410, don't send unknown slash
Stu Tomlinson <stu@nosnilmot.com>
parents: 17343
diff changeset
193 /**
62a71bb085ef Mostly taken from the patch on ticket #410, don't send unknown slash
Stu Tomlinson <stu@nosnilmot.com>
parents: 17343
diff changeset
194 * Indicates that slash commands are native to this protocol.
62a71bb085ef Mostly taken from the patch on ticket #410, don't send unknown slash
Stu Tomlinson <stu@nosnilmot.com>
parents: 17343
diff changeset
195 * Used as a hint that unknown commands should not be sent as messages.
22898
3d7e9eff04d0 Assorted cleanups, mostly to the Doxygen comments. I added a few missing
Richard Laager <rlaager@wiktel.com>
parents: 22762
diff changeset
196 * @since 2.1.0
18030
62a71bb085ef Mostly taken from the patch on ticket #410, don't send unknown slash
Stu Tomlinson <stu@nosnilmot.com>
parents: 17343
diff changeset
197 */
24687
d8452c0bec7b Remove the commas at the end of enumerator lists. This resolves warnings
Florian Quèze <florian@instantbird.org>
parents: 24589
diff changeset
198 OPT_PROTO_SLASH_COMMANDS_NATIVE = 0x00000400
18030
62a71bb085ef Mostly taken from the patch on ticket #410, don't send unknown slash
Stu Tomlinson <stu@nosnilmot.com>
parents: 17343
diff changeset
199
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
200 } PurpleProtocolOptions;
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
201
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
202 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
203 * A protocol plugin information structure.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
204 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
205 * Every protocol plugin initializes this structure. It is the gateway
22762
20053e2484f8 Fix a typo in a doc comment.
Richard Laager <rlaager@wiktel.com>
parents: 22122
diff changeset
206 * between purple and the protocol plugin. Many of these callbacks can be
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
207 * NULL. If a callback must be implemented, it has a comment indicating so.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
208 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
209 struct _PurplePluginProtocolInfo
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
210 {
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
211 PurpleProtocolOptions options; /**< Protocol options. */
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
212
19289
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
213 GList *user_splits; /**< A GList of PurpleAccountUserSplit */
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
214 GList *protocol_options; /**< A GList of PurpleAccountOption */
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
215
19289
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
216 PurpleBuddyIconSpec icon_spec; /**< The icon spec. */
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
217
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
218 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
219 * Returns the base icon name for the given buddy and account.
25924
584063555949 Remove trailing whitespace
Mark Doliner <mark@kingant.net>
parents: 24797
diff changeset
220 * If buddy is NULL and the account is non-NULL, it will return the
16392
c85fa74f7e50 Document prpl_info->list_icon(NULL, NULL), and add my name to COPYRIGHT.
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 15822
diff changeset
221 * name to use for the account's icon. If both are NULL, it will
c85fa74f7e50 Document prpl_info->list_icon(NULL, NULL), and add my name to COPYRIGHT.
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 15822
diff changeset
222 * return the name to use for the protocol's icon.
c85fa74f7e50 Document prpl_info->list_icon(NULL, NULL), and add my name to COPYRIGHT.
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 15822
diff changeset
223 *
c85fa74f7e50 Document prpl_info->list_icon(NULL, NULL), and add my name to COPYRIGHT.
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 15822
diff changeset
224 * This must be implemented.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
225 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
226 const char *(*list_icon)(PurpleAccount *account, PurpleBuddy *buddy);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
227
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
228 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
229 * Fills the four char**'s with string identifiers for "emblems"
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
230 * that the UI will interpret and display as relevant
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
231 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
232 const char *(*list_emblem)(PurpleBuddy *buddy);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
233
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
234 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
235 * Gets a short string representing this buddy's status. This will
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
236 * be shown on the buddy list.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
237 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
238 char *(*status_text)(PurpleBuddy *buddy);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
239
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
240 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
241 * Allows the prpl to add text to a buddy's tooltip.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
242 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
243 void (*tooltip_text)(PurpleBuddy *buddy, PurpleNotifyUserInfo *user_info, gboolean full);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
244
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
245 /**
20903
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
246 * Returns a list of #PurpleStatusType which exist for this account;
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
247 * this must be implemented, and must add at least the offline and
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
248 * online states.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
249 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
250 GList *(*status_types)(PurpleAccount *account);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
251
20903
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
252 /**
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
253 * Returns a list of #PurpleMenuAction structs, which represent extra
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
254 * actions to be shown in (for example) the right-click menu for @a
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
255 * node.
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
256 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
257 GList *(*blist_node_menu)(PurpleBlistNode *node);
28598
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
258
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
259 /**
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
260 * Returns a list of #proto_chat_entry structs, which represent
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
261 * information required by the PRPL to join a chat. libpurple will
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
262 * call join_chat along with the information filled by the user.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
263 *
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
264 * @return A list of #proto_chat_entry structs
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
265 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
266 GList *(*chat_info)(PurpleConnection *);
28598
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
267
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
268 /**
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
269 * Returns a hashtable which maps #proto_chat_entry struct identifiers
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
270 * to default options as strings based on chat_name. The resulting
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
271 * hashtable should be created with g_hash_table_new_full(g_str_hash,
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
272 * g_str_equal, NULL, g_free);. Use #get_chat_name if you instead need
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
273 * to extract a chat name from a hashtable.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
274 *
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
275 * @param chat_name The chat name to be turned into components
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
276 * @return Hashtable containing the information extracted from chat_name
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
277 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
278 GHashTable *(*chat_info_defaults)(PurpleConnection *, const char *chat_name);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
279
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
280 /* All the server-related functions */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
281
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
282 /** This must be implemented. */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
283 void (*login)(PurpleAccount *);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
284
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
285 /** This must be implemented. */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
286 void (*close)(PurpleConnection *);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
287
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
288 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
289 * This PRPL function should return a positive value on success.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
290 * If the message is too big to be sent, return -E2BIG. If
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
291 * the account is not connected, return -ENOTCONN. If the
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
292 * PRPL is unable to send the message for another reason, return
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
293 * some other negative value. You can use one of the valid
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
294 * errno values, or just big something. If the message should
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
295 * not be echoed to the conversation window, return 0.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
296 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
297 int (*send_im)(PurpleConnection *, const char *who,
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
298 const char *message,
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
299 PurpleMessageFlags flags);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
300
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
301 void (*set_info)(PurpleConnection *, const char *info);
24588
23170794f9f5 Add a comment for the meaning of the return value of this function,
Mark Doliner <mark@kingant.net>
parents: 23571
diff changeset
302
23170794f9f5 Add a comment for the meaning of the return value of this function,
Mark Doliner <mark@kingant.net>
parents: 23571
diff changeset
303 /**
23170794f9f5 Add a comment for the meaning of the return value of this function,
Mark Doliner <mark@kingant.net>
parents: 23571
diff changeset
304 * @return If this protocol requires the PURPLE_TYPING message to
24589
64c74659b6eb Fix a typo in Mark's new comment.
Richard Laager <rlaager@wiktel.com>
parents: 24588
diff changeset
305 * be sent repeatedly to signify that the user is still
24588
23170794f9f5 Add a comment for the meaning of the return value of this function,
Mark Doliner <mark@kingant.net>
parents: 23571
diff changeset
306 * typing, then the PRPL should return the number of
23170794f9f5 Add a comment for the meaning of the return value of this function,
Mark Doliner <mark@kingant.net>
parents: 23571
diff changeset
307 * seconds to wait before sending a subsequent notification.
23170794f9f5 Add a comment for the meaning of the return value of this function,
Mark Doliner <mark@kingant.net>
parents: 23571
diff changeset
308 * Otherwise the PRPL should return 0.
23170794f9f5 Add a comment for the meaning of the return value of this function,
Mark Doliner <mark@kingant.net>
parents: 23571
diff changeset
309 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
310 unsigned int (*send_typing)(PurpleConnection *, const char *name, PurpleTypingState state);
24588
23170794f9f5 Add a comment for the meaning of the return value of this function,
Mark Doliner <mark@kingant.net>
parents: 23571
diff changeset
311
20903
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
312 /**
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
313 * Should arrange for purple_notify_userinfo() to be called with
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
314 * @a who's user info.
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
315 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
316 void (*get_info)(PurpleConnection *, const char *who);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
317 void (*set_status)(PurpleAccount *account, PurpleStatus *status);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
318
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
319 void (*set_idle)(PurpleConnection *, int idletime);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
320 void (*change_passwd)(PurpleConnection *, const char *old_pass,
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
321 const char *new_pass);
25240
a4d6e2c1e73b Update the comment for add_buddy in prpl.h to note it may be called to mean 'request authorization'
Paul Aurich <paul@darkrain42.org>
parents: 24797
diff changeset
322 /**
a4d6e2c1e73b Update the comment for add_buddy in prpl.h to note it may be called to mean 'request authorization'
Paul Aurich <paul@darkrain42.org>
parents: 24797
diff changeset
323 * Add a buddy to a group on the server.
a4d6e2c1e73b Update the comment for add_buddy in prpl.h to note it may be called to mean 'request authorization'
Paul Aurich <paul@darkrain42.org>
parents: 24797
diff changeset
324 *
a4d6e2c1e73b Update the comment for add_buddy in prpl.h to note it may be called to mean 'request authorization'
Paul Aurich <paul@darkrain42.org>
parents: 24797
diff changeset
325 * This PRPL function may be called in situations in which the buddy is
a4d6e2c1e73b Update the comment for add_buddy in prpl.h to note it may be called to mean 'request authorization'
Paul Aurich <paul@darkrain42.org>
parents: 24797
diff changeset
326 * already in the specified group. If the protocol supports
a4d6e2c1e73b Update the comment for add_buddy in prpl.h to note it may be called to mean 'request authorization'
Paul Aurich <paul@darkrain42.org>
parents: 24797
diff changeset
327 * authorization and the user is not already authorized to see the
a4d6e2c1e73b Update the comment for add_buddy in prpl.h to note it may be called to mean 'request authorization'
Paul Aurich <paul@darkrain42.org>
parents: 24797
diff changeset
328 * status of \a buddy, \a add_buddy should request authorization.
a4d6e2c1e73b Update the comment for add_buddy in prpl.h to note it may be called to mean 'request authorization'
Paul Aurich <paul@darkrain42.org>
parents: 24797
diff changeset
329 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
330 void (*add_buddy)(PurpleConnection *, PurpleBuddy *buddy, PurpleGroup *group);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
331 void (*add_buddies)(PurpleConnection *, GList *buddies, GList *groups);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
332 void (*remove_buddy)(PurpleConnection *, PurpleBuddy *buddy, PurpleGroup *group);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
333 void (*remove_buddies)(PurpleConnection *, GList *buddies, GList *groups);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
334 void (*add_permit)(PurpleConnection *, const char *name);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
335 void (*add_deny)(PurpleConnection *, const char *name);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
336 void (*rem_permit)(PurpleConnection *, const char *name);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
337 void (*rem_deny)(PurpleConnection *, const char *name);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
338 void (*set_permit_deny)(PurpleConnection *);
28598
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
339
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
340 /**
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
341 * Called when the user requests joining a chat. Should arrange for
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
342 * #serv_got_joined_chat to be called.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
343 *
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
344 * @param components A hashtable containing information required to
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
345 * join the chat as described by the entries returned
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
346 * by #chat_info. It may also be called when accepting
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
347 * an invitation, in which case this matches the
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
348 * data parameter passed to #serv_got_chat_invite.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
349 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
350 void (*join_chat)(PurpleConnection *, GHashTable *components);
28598
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
351
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
352 /**
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
353 * Called when the user refuses a chat invitation.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
354 *
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
355 * @param components A hashtable containing information required to
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
356 * join the chat as passed to #serv_got_chat_invite.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
357 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
358 void (*reject_chat)(PurpleConnection *, GHashTable *components);
28598
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
359
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
360 /**
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
361 * Returns a chat name based on the information in components. Use
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
362 * #chat_info_defaults if you instead need to generate a hashtable
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
363 * from a chat name.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
364 *
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
365 * @param components A hashtable containing information about the chat.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
366 */
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
367 char *(*get_chat_name)(GHashTable *components);
28598
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
368
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
369 /**
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
370 * Invite a user to join a chat.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
371 *
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
372 * @param id The id of the chat to invite the user to.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
373 * @param message A message displayed to the user when the invitation
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
374 * is received.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
375 * @param who The name of the user to send the invation to.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
376 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
377 void (*chat_invite)(PurpleConnection *, int id,
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
378 const char *message, const char *who);
28598
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
379 /**
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
380 * Called when the user requests leaving a chat.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
381 *
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
382 * @param id The id of the chat to leave
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
383 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
384 void (*chat_leave)(PurpleConnection *, int id);
28598
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
385
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
386 /**
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
387 * Send a whisper to a user in a chat.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
388 *
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
389 * @param id The id of the chat.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
390 * @param who The name of the user to send the whisper to.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
391 * @param message The message of the whisper.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
392 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
393 void (*chat_whisper)(PurpleConnection *, int id,
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
394 const char *who, const char *message);
28598
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
395
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
396 /**
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
397 * Send a message to a chat.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
398 * This PRPL function should return a positive value on success.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
399 * If the message is too big to be sent, return -E2BIG. If
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
400 * the account is not connected, return -ENOTCONN. If the
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
401 * PRPL is unable to send the message for another reason, return
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
402 * some other negative value. You can use one of the valid
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
403 * errno values, or just big something. If the message should
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
404 * not be echoed to the conversation window, return 0.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
405 *
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
406 * @param id The id of the chat to send the message to.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
407 * @param message The message to send to the chat.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
408 * @param flags A bitwise OR of #PurpleMessageFlags representing
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
409 * message flags.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
410 * @return A positive number or 0 in case of succes,
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
411 * a negative error number in case of failure.
e37f85160784 Documented chat API. References #10605
sttwister@gmail.com
parents: 26903
diff changeset
412 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
413 int (*chat_send)(PurpleConnection *, int id, const char *message, PurpleMessageFlags flags);
21750
fb8ab2490ac4 De-magic number the prpl_info->keepalive interval, and document it.
Will Thompson <will.thompson@collabora.co.uk>
parents: 21457
diff changeset
414
fb8ab2490ac4 De-magic number the prpl_info->keepalive interval, and document it.
Will Thompson <will.thompson@collabora.co.uk>
parents: 21457
diff changeset
415 /** If implemented, this will be called regularly for this prpl's
fb8ab2490ac4 De-magic number the prpl_info->keepalive interval, and document it.
Will Thompson <will.thompson@collabora.co.uk>
parents: 21457
diff changeset
416 * active connections. You'd want to do this if you need to repeatedly
fb8ab2490ac4 De-magic number the prpl_info->keepalive interval, and document it.
Will Thompson <will.thompson@collabora.co.uk>
parents: 21457
diff changeset
417 * send some kind of keepalive packet to the server to avoid being
fb8ab2490ac4 De-magic number the prpl_info->keepalive interval, and document it.
Will Thompson <will.thompson@collabora.co.uk>
parents: 21457
diff changeset
418 * disconnected. ("Regularly" is defined by
fb8ab2490ac4 De-magic number the prpl_info->keepalive interval, and document it.
Will Thompson <will.thompson@collabora.co.uk>
parents: 21457
diff changeset
419 * <code>KEEPALIVE_INTERVAL</code> in <tt>libpurple/connection.c</tt>.)
fb8ab2490ac4 De-magic number the prpl_info->keepalive interval, and document it.
Will Thompson <will.thompson@collabora.co.uk>
parents: 21457
diff changeset
420 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
421 void (*keepalive)(PurpleConnection *);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
422
19289
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
423 /** new user registration */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
424 void (*register_user)(PurpleAccount *);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
425
20928
ed40911613a0 Try my hardest to get rid of some Doxygen warnings. One is left and I don't know why.
Richard Laager <rlaager@wiktel.com>
parents: 20903
diff changeset
426 /**
ed40911613a0 Try my hardest to get rid of some Doxygen warnings. One is left and I don't know why.
Richard Laager <rlaager@wiktel.com>
parents: 20903
diff changeset
427 * @deprecated Use #PurplePluginProtocolInfo.get_info instead.
20903
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
428 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
429 void (*get_cb_info)(PurpleConnection *, int, const char *who);
20928
ed40911613a0 Try my hardest to get rid of some Doxygen warnings. One is left and I don't know why.
Richard Laager <rlaager@wiktel.com>
parents: 20903
diff changeset
430 /**
ed40911613a0 Try my hardest to get rid of some Doxygen warnings. One is left and I don't know why.
Richard Laager <rlaager@wiktel.com>
parents: 20903
diff changeset
431 * @deprecated Use #PurplePluginProtocolInfo.get_cb_real_name and
ed40911613a0 Try my hardest to get rid of some Doxygen warnings. One is left and I don't know why.
Richard Laager <rlaager@wiktel.com>
parents: 20903
diff changeset
432 * #PurplePluginProtocolInfo.status_text instead.
20903
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
433 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
434 void (*get_cb_away)(PurpleConnection *, int, const char *who);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
435
19289
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
436 /** save/store buddy's alias on server list/roster */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
437 void (*alias_buddy)(PurpleConnection *, const char *who,
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
438 const char *alias);
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
439
19289
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
440 /** change a buddy's group on a server list/roster */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
441 void (*group_buddy)(PurpleConnection *, const char *who,
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
442 const char *old_group, const char *new_group);
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
443
19289
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
444 /** rename a group on a server list/roster */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
445 void (*rename_group)(PurpleConnection *, const char *old_name,
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
446 PurpleGroup *group, GList *moved_buddies);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
447
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
448 void (*buddy_free)(PurpleBuddy *);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
449
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
450 void (*convo_closed)(PurpleConnection *, const char *who);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
451
19289
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
452 /**
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
453 * Convert the username @a who to its canonical form. (For example,
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
454 * AIM treats "fOo BaR" and "foobar" as the same user; this function
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
455 * should return the same normalized string for both of those.)
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
456 */
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
457 const char *(*normalize)(const PurpleAccount *, const char *who);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
458
19289
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
459 /**
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
460 * Set the buddy icon for the given connection to @a img. The prpl
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
461 * does NOT own a reference to @a img; if it needs one, it must
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
462 * #purple_imgstore_ref(@a img) itself.
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
463 */
16390
4fc51a87ce42 Updates for the account buddy icon stuff. This doesn't yet work fully (and maybe not even partly), but it compiles.
Richard Laager <rlaager@wiktel.com>
parents: 15822
diff changeset
464 void (*set_buddy_icon)(PurpleConnection *, PurpleStoredImage *img);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
465
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
466 void (*remove_group)(PurpleConnection *gc, PurpleGroup *group);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
467
21039
5af17c5a4a12 Document PurplePluginProtocolInfo.get_cb_real_name
Will Thompson <will.thompson@collabora.co.uk>
parents: 21023
diff changeset
468 /** Gets the real name of a participant in a chat. For example, on
5af17c5a4a12 Document PurplePluginProtocolInfo.get_cb_real_name
Will Thompson <will.thompson@collabora.co.uk>
parents: 21023
diff changeset
469 * XMPP this turns a chat room nick <tt>foo</tt> into
21457
eb0f36c3a58f Get rid of a few silly doxygen warnings
Mark Doliner <mark@kingant.net>
parents: 21039
diff changeset
470 * <tt>room\@server/foo</tt>
21039
5af17c5a4a12 Document PurplePluginProtocolInfo.get_cb_real_name
Will Thompson <will.thompson@collabora.co.uk>
parents: 21023
diff changeset
471 * @param gc the connection on which the room is.
5af17c5a4a12 Document PurplePluginProtocolInfo.get_cb_real_name
Will Thompson <will.thompson@collabora.co.uk>
parents: 21023
diff changeset
472 * @param id the ID of the chat room.
5af17c5a4a12 Document PurplePluginProtocolInfo.get_cb_real_name
Will Thompson <will.thompson@collabora.co.uk>
parents: 21023
diff changeset
473 * @param who the nickname of the chat participant.
5af17c5a4a12 Document PurplePluginProtocolInfo.get_cb_real_name
Will Thompson <will.thompson@collabora.co.uk>
parents: 21023
diff changeset
474 * @return the real name of the participant. This string must be
5af17c5a4a12 Document PurplePluginProtocolInfo.get_cb_real_name
Will Thompson <will.thompson@collabora.co.uk>
parents: 21023
diff changeset
475 * freed by the caller.
5af17c5a4a12 Document PurplePluginProtocolInfo.get_cb_real_name
Will Thompson <will.thompson@collabora.co.uk>
parents: 21023
diff changeset
476 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
477 char *(*get_cb_real_name)(PurpleConnection *gc, int id, const char *who);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
478
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
479 void (*set_chat_topic)(PurpleConnection *gc, int id, const char *topic);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
480
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
481 PurpleChat *(*find_blist_chat)(PurpleAccount *account, const char *name);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
482
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
483 /* room listing prpl callbacks */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
484 PurpleRoomlist *(*roomlist_get_list)(PurpleConnection *gc);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
485 void (*roomlist_cancel)(PurpleRoomlist *list);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
486 void (*roomlist_expand_category)(PurpleRoomlist *list, PurpleRoomlistRoom *category);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
487
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
488 /* file transfer callbacks */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
489 gboolean (*can_receive_file)(PurpleConnection *, const char *who);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
490 void (*send_file)(PurpleConnection *, const char *who, const char *filename);
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
491 PurpleXfer *(*new_xfer)(PurpleConnection *, const char *who);
21023
42ecde230f91 Documentation tweaks for the write_conv uiop and for prpl_info.offline_message.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20928
diff changeset
492
42ecde230f91 Documentation tweaks for the write_conv uiop and for prpl_info.offline_message.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20928
diff changeset
493 /** Checks whether offline messages to @a buddy are supported.
42ecde230f91 Documentation tweaks for the write_conv uiop and for prpl_info.offline_message.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20928
diff changeset
494 * @return @c TRUE if @a buddy can be sent messages while they are
42ecde230f91 Documentation tweaks for the write_conv uiop and for prpl_info.offline_message.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20928
diff changeset
495 * offline, or @c FALSE if not.
42ecde230f91 Documentation tweaks for the write_conv uiop and for prpl_info.offline_message.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20928
diff changeset
496 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
497 gboolean (*offline_message)(const PurpleBuddy *buddy);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
498
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
499 PurpleWhiteboardPrplOps *whiteboard_prpl_ops;
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
500
19289
f12bf92d64ec Add marginally better doxygen magic to PurplePluginProtocolInfo
Will Thompson <will.thompson@collabora.co.uk>
parents: 18179
diff changeset
501 /** For use in plugins that may understand the underlying protocol */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
502 int (*send_raw)(PurpleConnection *gc, const char *buf, int len);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
503
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
504 /* room list serialize */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
505 char *(*roomlist_room_serialize)(PurpleRoomlistRoom *room);
16664
516f14bef90e Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents: 16471
diff changeset
506
20903
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
507 /** Remove the user from the server. The account can either be
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
508 * connected or disconnected. After the removal is finished, the
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
509 * connection will stay open and has to be closed!
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
510 */
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
511 /* This is here rather than next to register_user for API compatibility
3375d44ccad7 Add some (but not much!) documentation to PurplePluginProtocolInfo.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20074
diff changeset
512 * reasons.
18703
033b128f7c21 Added unregistering XMPP accounts. This requires a new prpl-struct entry, but I got an ok for that on the mailing list.
Andreas Monitzer <pidgin@monitzer.com>
parents: 18684
diff changeset
513 */
18920
2a9d60d7af82 Implemented a callback for unregistering, mirroring the registration callback. Since this is a new API, I can do it properly by passing it right in the unregister function call, instead of having a separate function for setting it.
Andreas Monitzer <pidgin@monitzer.com>
parents: 18703
diff changeset
514 void (*unregister_user)(PurpleAccount *, PurpleAccountUnregistrationCb cb, void *user_data);
25924
584063555949 Remove trailing whitespace
Mark Doliner <mark@kingant.net>
parents: 24797
diff changeset
515
19426
6395c2e96bc2 Attention API for nudges/buzzes/zaps of various protocols.
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19289
diff changeset
516 /* Attention API for sending & receiving zaps/nudges/buzzes etc. */
19463
3f6f84d11ce2 Change serv_send_attention() to call prpl_info->send_attention(), and
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19461
diff changeset
517 gboolean (*send_attention)(PurpleConnection *gc, const char *username, guint type);
19703
45d028a68774 - Rename attention_types to get_attention_types, which seems more standard.
Richard Laager <rlaager@wiktel.com>
parents: 19697
diff changeset
518 GList *(*get_attention_types)(PurpleAccount *acct);
19463
3f6f84d11ce2 Change serv_send_attention() to call prpl_info->send_attention(), and
Jeffrey Connelly <jaconnel@calpoly.edu>
parents: 19461
diff changeset
519
23109
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
520 /**
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
521 * The size of the PurplePluginProtocolInfo. This should always be sizeof(PurplePluginProtocolInfo).
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
522 * This allows adding more functions to this struct without requiring a major version bump.
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
523 */
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
524 unsigned long struct_size;
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
525
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
526 /* NOTE:
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
527 * If more functions are added, they should accessed using the following syntax:
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
528 *
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
529 * if (PURPLE_PROTOCOL_PLUGIN_HAS_FUNC(prpl, new_function))
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
530 * prpl->new_function(...);
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
531 *
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
532 * instead of
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
533 *
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
534 * if (prpl->new_function != NULL)
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
535 * prpl->new_function(...);
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
536 *
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
537 * The PURPLE_PROTOCOL_PLUGIN_HAS_FUNC macro can be used for the older member
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
538 * functions (e.g. login, send_im etc.) too.
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
539 */
23110
bb41bdce8981 Patch from Jaywalker to let prpls add some helpful text for some account
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23109
diff changeset
540
bb41bdce8981 Patch from Jaywalker to let prpls add some helpful text for some account
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23109
diff changeset
541 /** This allows protocols to specify additional strings to be used for
bb41bdce8981 Patch from Jaywalker to let prpls add some helpful text for some account
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23109
diff changeset
542 * various purposes. The idea is to stuff a bunch of strings in this hash
bb41bdce8981 Patch from Jaywalker to let prpls add some helpful text for some account
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23109
diff changeset
543 * table instead of expanding the struct for every addition. This hash
bb41bdce8981 Patch from Jaywalker to let prpls add some helpful text for some account
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23109
diff changeset
544 * table is allocated every call and MUST be unrefed by the caller.
bb41bdce8981 Patch from Jaywalker to let prpls add some helpful text for some account
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23109
diff changeset
545 *
bb41bdce8981 Patch from Jaywalker to let prpls add some helpful text for some account
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23109
diff changeset
546 * @param account The account to specify. This can be NULL.
bb41bdce8981 Patch from Jaywalker to let prpls add some helpful text for some account
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23109
diff changeset
547 * @return The protocol's string hash table. The hash table should be
bb41bdce8981 Patch from Jaywalker to let prpls add some helpful text for some account
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23109
diff changeset
548 * destroyed by the caller when it's no longer needed.
bb41bdce8981 Patch from Jaywalker to let prpls add some helpful text for some account
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23109
diff changeset
549 */
bb41bdce8981 Patch from Jaywalker to let prpls add some helpful text for some account
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23109
diff changeset
550 GHashTable *(*get_account_text_table)(PurpleAccount *account);
23772
750d700098c1 Fix the prplinfo structs and get rid of some compile warnings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23769
diff changeset
551
23868
1aa383ee5fc8 Fixed up media functions in prpl.c and prpl.h, adding more documentation and
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23867
diff changeset
552 /**
1aa383ee5fc8 Fixed up media functions in prpl.c and prpl.h, adding more documentation and
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23867
diff changeset
553 * Initiate a media session with the given contact.
1aa383ee5fc8 Fixed up media functions in prpl.c and prpl.h, adding more documentation and
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23867
diff changeset
554 *
26524
df9042312063 Switch media to store accounts rather than connections.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 26397
diff changeset
555 * @param account The account to initiate the media session on.
23868
1aa383ee5fc8 Fixed up media functions in prpl.c and prpl.h, adding more documentation and
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23867
diff changeset
556 * @param who The remote user to initiate the session with.
1aa383ee5fc8 Fixed up media functions in prpl.c and prpl.h, adding more documentation and
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23867
diff changeset
557 * @param type The type of media session to initiate.
26365
34eb898478b4 Don't assume a PurpleMedia instance will be created immediately.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 26352
diff changeset
558 * @return TRUE if the call succeeded else FALSE. (Doesn't imply the media session or stream will be successfully created)
23868
1aa383ee5fc8 Fixed up media functions in prpl.c and prpl.h, adding more documentation and
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23867
diff changeset
559 */
26524
df9042312063 Switch media to store accounts rather than connections.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 26397
diff changeset
560 gboolean (*initiate_media)(PurpleAccount *account, const char *who,
23869
551a462b346a Changed PurpleMediaStreamType to PurpleMediaSessionType.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23868
diff changeset
561 PurpleMediaSessionType type);
23807
ff29208e03ef propagate from branch 'im.pidgin.pidgin' (head 75f0460d3679231b61d572e76fe02534a597c6b5)
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23208 23787
diff changeset
562
23868
1aa383ee5fc8 Fixed up media functions in prpl.c and prpl.h, adding more documentation and
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23867
diff changeset
563 /**
1aa383ee5fc8 Fixed up media functions in prpl.c and prpl.h, adding more documentation and
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23867
diff changeset
564 * Checks to see if the given contact supports the given type of media session.
1aa383ee5fc8 Fixed up media functions in prpl.c and prpl.h, adding more documentation and
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23867
diff changeset
565 *
26524
df9042312063 Switch media to store accounts rather than connections.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 26397
diff changeset
566 * @param account The account the contact is on.
23868
1aa383ee5fc8 Fixed up media functions in prpl.c and prpl.h, adding more documentation and
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23867
diff changeset
567 * @param who The remote user to check for media capability with.
26108
d6e23439b77c Change purple_prpl_can_do_media to purple_prpl_get_media_caps.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 24986
diff changeset
568 * @return The media caps the contact supports.
23868
1aa383ee5fc8 Fixed up media functions in prpl.c and prpl.h, adding more documentation and
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23867
diff changeset
569 */
26524
df9042312063 Switch media to store accounts rather than connections.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 26397
diff changeset
570 PurpleMediaCaps (*get_media_caps)(PurpleAccount *account,
26108
d6e23439b77c Change purple_prpl_can_do_media to purple_prpl_get_media_caps.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 24986
diff changeset
571 const char *who);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
572 };
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
573
23109
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
574 #define PURPLE_PROTOCOL_PLUGIN_HAS_FUNC(prpl, member) \
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
575 (((G_STRUCT_OFFSET(PurplePluginProtocolInfo, member) < G_STRUCT_OFFSET(PurplePluginProtocolInfo, struct_size)) \
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
576 || (G_STRUCT_OFFSET(PurplePluginProtocolInfo, member) < prpl->struct_size)) && \
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
577 prpl->member != NULL)
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
578
718a9c287839 Use up the last padding for PurplePluginProtocolInfo in a way that allows
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23105
diff changeset
579
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
580 #define PURPLE_IS_PROTOCOL_PLUGIN(plugin) \
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
581 ((plugin)->info->type == PURPLE_PLUGIN_PROTOCOL)
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
582
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
583 #define PURPLE_PLUGIN_PROTOCOL_INFO(plugin) \
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
584 ((PurplePluginProtocolInfo *)(plugin)->info->extra_info)
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
585
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
586 #ifdef __cplusplus
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
587 extern "C" {
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
588 #endif
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
589
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
590 /**************************************************************************/
22097
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
591 /** @name Attention Type API */
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
592 /**************************************************************************/
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
593 /*@{*/
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
594
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
595 /**
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
596 * Creates a new #PurpleAttentionType object and sets its mandatory parameters.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
597 *
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
598 * @param ulname A non-localized string that can be used by UIs in need of such
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
599 * non-localized strings. This should be the same as @a name,
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
600 * without localization.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
601 * @param name A localized string that the UI may display for the event. This
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
602 * should be the same string as @a ulname, with localization.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
603 * @param inc_desc A localized description shown when the event is received.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
604 * @param out_desc A localized description shown when the event is sent.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
605 * @return A pointer to the new object.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
606 * @since 2.4.0
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
607 */
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
608 PurpleAttentionType *purple_attention_type_new(const char *ulname, const char *name,
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
609 const char *inc_desc, const char *out_desc);
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
610
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
611 /**
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
612 * Sets the displayed name of the attention-demanding event.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
613 *
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
614 * @param type The attention type.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
615 * @param name The localized name that will be displayed by UIs. This should be
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
616 * the same string given as the unlocalized name, but with
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
617 * localization.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
618 * @since 2.4.0
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
619 */
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
620 void purple_attention_type_set_name(PurpleAttentionType *type, const char *name);
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
621
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
622 /**
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
623 * Sets the description of the attention-demanding event shown in conversations
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
624 * when the event is received.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
625 *
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
626 * @param type The attention type.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
627 * @param desc The localized description for incoming events.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
628 * @since 2.4.0
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
629 */
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
630 void purple_attention_type_set_incoming_desc(PurpleAttentionType *type, const char *desc);
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
631
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
632 /**
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
633 * Sets the description of the attention-demanding event shown in conversations
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
634 * when the event is sent.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
635 *
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
636 * @param type The attention type.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
637 * @param desc The localized description for outgoing events.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
638 * @since 2.4.0
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
639 */
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
640 void purple_attention_type_set_outgoing_desc(PurpleAttentionType *type, const char *desc);
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
641
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
642 /**
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
643 * Sets the name of the icon to display for the attention event; this is optional.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
644 *
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
645 * @param type The attention type.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
646 * @param name The icon's name.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
647 * @note Icons are optional for attention events.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
648 * @since 2.4.0
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
649 */
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
650 void purple_attention_type_set_icon_name(PurpleAttentionType *type, const char *name);
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
651
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
652 /**
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
653 * Sets the unlocalized name of the attention event; some UIs may need this,
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
654 * thus it is required.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
655 *
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
656 * @param type The attention type.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
657 * @param ulname The unlocalized name. This should be the same string given as
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
658 * the localized name, but without localization.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
659 * @since 2.4.0
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
660 */
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
661 void purple_attention_type_set_unlocalized_name(PurpleAttentionType *type, const char *ulname);
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
662
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
663 /**
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
664 * Get the attention type's name as displayed by the UI.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
665 *
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
666 * @param type The attention type.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
667 * @return The name.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
668 * @since 2.4.0
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
669 */
22122
f55f84a1e3f7 const-ify paramteters to some of the new API I added. I thought I did this already.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 22097
diff changeset
670 const char *purple_attention_type_get_name(const PurpleAttentionType *type);
22097
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
671
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
672 /**
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
673 * Get the attention type's description shown when the event is received.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
674 *
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
675 * @param type The attention type.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
676 * @return The description.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
677 * @since 2.4.0
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
678 */
22122
f55f84a1e3f7 const-ify paramteters to some of the new API I added. I thought I did this already.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 22097
diff changeset
679 const char *purple_attention_type_get_incoming_desc(const PurpleAttentionType *type);
22097
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
680
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
681 /**
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
682 * Get the attention type's description shown when the event is sent.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
683 *
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
684 * @param type The attention type.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
685 * @return The description.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
686 * @since 2.4.0
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
687 */
22122
f55f84a1e3f7 const-ify paramteters to some of the new API I added. I thought I did this already.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 22097
diff changeset
688 const char *purple_attention_type_get_outgoing_desc(const PurpleAttentionType *type);
22097
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
689
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
690 /**
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
691 * Get the attention type's icon name.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
692 *
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
693 * @param type The attention type.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
694 * @return The icon name or @c NULL if unset/empty.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
695 * @note Icons are optional for attention events.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
696 * @since 2.4.0
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
697 */
22122
f55f84a1e3f7 const-ify paramteters to some of the new API I added. I thought I did this already.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 22097
diff changeset
698 const char *purple_attention_type_get_icon_name(const PurpleAttentionType *type);
22097
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
699
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
700 /**
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
701 * Get the attention type's unlocalized name; this is useful for some UIs.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
702 *
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
703 * @param type The attention type
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
704 * @return The unlocalized name.
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
705 * @since 2.4.0
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
706 */
22122
f55f84a1e3f7 const-ify paramteters to some of the new API I added. I thought I did this already.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 22097
diff changeset
707 const char *purple_attention_type_get_unlocalized_name(const PurpleAttentionType *type);
22097
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
708
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
709 /*@}*/
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
710
eab7d03edfcb This adds accessor and mutator API for the PurpleAttentionType struct.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 21750
diff changeset
711 /**************************************************************************/
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
712 /** @name Protocol Plugin API */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
713 /**************************************************************************/
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
714 /*@{*/
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
715
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
716 /**
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
717 * Notifies Purple that our account's idle state and time have changed.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
718 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
719 * This is meant to be called from protocol plugins.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
720 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
721 * @param account The account.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
722 * @param idle The user's idle state.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
723 * @param idle_time The user's idle time.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
724 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
725 void purple_prpl_got_account_idle(PurpleAccount *account, gboolean idle,
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
726 time_t idle_time);
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
727
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
728 /**
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
729 * Notifies Purple of our account's log-in time.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
730 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
731 * This is meant to be called from protocol plugins.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
732 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
733 * @param account The account the user is on.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
734 * @param login_time The user's log-in time.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
735 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
736 void purple_prpl_got_account_login_time(PurpleAccount *account, time_t login_time);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
737
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
738 /**
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
739 * Notifies Purple that our account's status has changed.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
740 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
741 * This is meant to be called from protocol plugins.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
742 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
743 * @param account The account the user is on.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
744 * @param status_id The status ID.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
745 * @param ... A NULL-terminated list of attribute IDs and values,
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
746 * beginning with the value for @a attr_id.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
747 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
748 void purple_prpl_got_account_status(PurpleAccount *account,
18179
72906c5ac037 Add G_GNUC_NULL_TERMINATED to a few functions that expect a NULL terminated
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18030
diff changeset
749 const char *status_id, ...) G_GNUC_NULL_TERMINATED;
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
750
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
751 /**
26694
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
752 * Notifies Purple that our account's actions have changed. This is only
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
753 * called after the initial connection. Emits the account-actions-changed
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
754 * signal.
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
755 *
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
756 * This is meant to be called from protocol plugins.
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
757 *
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
758 * @param account The account.
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
759 *
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
760 * @see account-actions-changed
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
761 * @since 2.6.0
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
762 */
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
763 void purple_prpl_got_account_actions(PurpleAccount *account);
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
764
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26524
diff changeset
765 /**
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
766 * Notifies Purple that a buddy's idle state and time have changed.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
767 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
768 * This is meant to be called from protocol plugins.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
769 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
770 * @param account The account the user is on.
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
771 * @param name The name of the buddy.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
772 * @param idle The user's idle state.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
773 * @param idle_time The user's idle time. This is the time at
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
774 * which the user became idle, in seconds since
24797
9216da5184a2 Add a comment that 0 should be used when a buddies idle time is unknown
Mark Doliner <mark@kingant.net>
parents: 24687
diff changeset
775 * the epoch. If the PRPL does not know this value
9216da5184a2 Add a comment that 0 should be used when a buddies idle time is unknown
Mark Doliner <mark@kingant.net>
parents: 24687
diff changeset
776 * then it should pass 0.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
777 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
778 void purple_prpl_got_user_idle(PurpleAccount *account, const char *name,
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
779 gboolean idle, time_t idle_time);
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
780
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
781 /**
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
782 * Notifies Purple of a buddy's log-in time.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
783 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
784 * This is meant to be called from protocol plugins.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
785 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
786 * @param account The account the user is on.
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
787 * @param name The name of the buddy.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
788 * @param login_time The user's log-in time.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
789 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
790 void purple_prpl_got_user_login_time(PurpleAccount *account, const char *name,
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
791 time_t login_time);
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
792
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
793 /**
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
794 * Notifies Purple that a buddy's status has been activated.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
795 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
796 * This is meant to be called from protocol plugins.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
797 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
798 * @param account The account the user is on.
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
799 * @param name The name of the buddy.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
800 * @param status_id The status ID.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
801 * @param ... A NULL-terminated list of attribute IDs and values,
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
802 * beginning with the value for @a attr_id.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
803 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
804 void purple_prpl_got_user_status(PurpleAccount *account, const char *name,
18179
72906c5ac037 Add G_GNUC_NULL_TERMINATED to a few functions that expect a NULL terminated
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18030
diff changeset
805 const char *status_id, ...) G_GNUC_NULL_TERMINATED;
15523
84b3ab83df35 Use the status API to handle mobileness, and convert AIM to use it. This makes mobile buddies prioritze lower in Perons, and ensures the UI is notified of changes in mobileness. Other protocols to follow.
Sean Egan <seanegan@gmail.com>
parents: 15462
diff changeset
806
84b3ab83df35 Use the status API to handle mobileness, and convert AIM to use it. This makes mobile buddies prioritze lower in Perons, and ensures the UI is notified of changes in mobileness. Other protocols to follow.
Sean Egan <seanegan@gmail.com>
parents: 15462
diff changeset
807 /**
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
808 * Notifies libpurple that a buddy's status has been deactivated
15523
84b3ab83df35 Use the status API to handle mobileness, and convert AIM to use it. This makes mobile buddies prioritze lower in Perons, and ensures the UI is notified of changes in mobileness. Other protocols to follow.
Sean Egan <seanegan@gmail.com>
parents: 15462
diff changeset
809 *
84b3ab83df35 Use the status API to handle mobileness, and convert AIM to use it. This makes mobile buddies prioritze lower in Perons, and ensures the UI is notified of changes in mobileness. Other protocols to follow.
Sean Egan <seanegan@gmail.com>
parents: 15462
diff changeset
810 * This is meant to be called from protocol plugins.
84b3ab83df35 Use the status API to handle mobileness, and convert AIM to use it. This makes mobile buddies prioritze lower in Perons, and ensures the UI is notified of changes in mobileness. Other protocols to follow.
Sean Egan <seanegan@gmail.com>
parents: 15462
diff changeset
811 *
84b3ab83df35 Use the status API to handle mobileness, and convert AIM to use it. This makes mobile buddies prioritze lower in Perons, and ensures the UI is notified of changes in mobileness. Other protocols to follow.
Sean Egan <seanegan@gmail.com>
parents: 15462
diff changeset
812 * @param account The account the user is on.
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
813 * @param name The name of the buddy.
15523
84b3ab83df35 Use the status API to handle mobileness, and convert AIM to use it. This makes mobile buddies prioritze lower in Perons, and ensures the UI is notified of changes in mobileness. Other protocols to follow.
Sean Egan <seanegan@gmail.com>
parents: 15462
diff changeset
814 * @param status_id The status ID.
84b3ab83df35 Use the status API to handle mobileness, and convert AIM to use it. This makes mobile buddies prioritze lower in Perons, and ensures the UI is notified of changes in mobileness. Other protocols to follow.
Sean Egan <seanegan@gmail.com>
parents: 15462
diff changeset
815 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
816 void purple_prpl_got_user_status_deactive(PurpleAccount *account, const char *name,
15523
84b3ab83df35 Use the status API to handle mobileness, and convert AIM to use it. This makes mobile buddies prioritze lower in Perons, and ensures the UI is notified of changes in mobileness. Other protocols to follow.
Sean Egan <seanegan@gmail.com>
parents: 15462
diff changeset
817 const char *status_id);
25924
584063555949 Remove trailing whitespace
Mark Doliner <mark@kingant.net>
parents: 24797
diff changeset
818
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
819 /**
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
820 * Informs the server that our account's status changed.
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
821 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
822 * @param account The account the user is on.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
823 * @param old_status The previous status.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
824 * @param new_status The status that was activated, or deactivated
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
825 * (in the case of independent statuses).
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
826 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
827 void purple_prpl_change_account_status(PurpleAccount *account,
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
828 PurpleStatus *old_status,
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
829 PurpleStatus *new_status);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
830
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
831 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
832 * Retrieves the list of stock status types from a prpl.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
833 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
834 * @param account The account the user is on.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
835 * @param presence The presence for which we're going to get statuses
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
836 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
837 * @return List of statuses
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
838 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
839 GList *purple_prpl_get_statuses(PurpleAccount *account, PurplePresence *presence);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
840
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
841 /**
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
842 * Send an attention request message.
23571
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
843 *
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
844 * @param gc The connection to send the message on.
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
845 * @param who Whose attention to request.
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
846 * @param type_code An index into the prpl's attention_types list determining the type
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
847 * of the attention request command to send. 0 if prpl only defines one
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
848 * (for example, Yahoo and MSN), but some protocols define more (MySpaceIM).
23571
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
849 *
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
850 * Note that you can't send arbitrary PurpleAttentionType's, because there is
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
851 * only a fixed set of attention commands.
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
852 *
23571
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
853 * @since 2.5.0
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
854 */
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
855 void purple_prpl_send_attention(PurpleConnection *gc, const char *who, guint type_code);
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
856
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
857 /**
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
858 * Process an incoming attention message.
23571
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
859 *
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
860 * @param gc The connection that received the attention message.
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
861 * @param who Who requested your attention.
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
862 * @param type_code An index into the prpl's attention_types list determining the type
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
863 * of the attention request command to send.
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
864 *
23571
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
865 * @since 2.5.0
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
866 */
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
867 void purple_prpl_got_attention(PurpleConnection *gc, const char *who, guint type_code);
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
868
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
869 /**
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
870 * Process an incoming attention message in a chat.
23571
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
871 *
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
872 * @param gc The connection that received the attention message.
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
873 * @param id The chat id.
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
874 * @param who Who requested your attention.
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
875 * @param type_code An index into the prpl's attention_types list determining the type
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
876 * of the attention request command to send.
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 25924
diff changeset
877 *
23571
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
878 * @since 2.5.0
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
879 */
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
880 void purple_prpl_got_attention_in_chat(PurpleConnection *gc, int id, const char *who, guint type_code);
49850f7ca393 Add purple_prpl_got_attention_in_chat, then deprecate
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23371
diff changeset
881
23859
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
882 /**
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
883 * Determines if the contact supports the given media session type.
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
884 *
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
885 * @param account The account the user is on.
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
886 * @param who The name of the contact to check capabilities for.
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
887 *
26108
d6e23439b77c Change purple_prpl_can_do_media to purple_prpl_get_media_caps.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 24986
diff changeset
888 * @return The media caps the contact supports.
23859
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
889 */
26108
d6e23439b77c Change purple_prpl_can_do_media to purple_prpl_get_media_caps.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 24986
diff changeset
890 PurpleMediaCaps purple_prpl_get_media_caps(PurpleAccount *account,
d6e23439b77c Change purple_prpl_can_do_media to purple_prpl_get_media_caps.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 24986
diff changeset
891 const char *who);
23859
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
892
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
893 /**
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
894 * Initiates a media session with the given contact.
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
895 *
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
896 * @param account The account the user is on.
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
897 * @param who The name of the contact to start a session with.
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
898 * @param type The type of media session to start.
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
899 *
26365
34eb898478b4 Don't assume a PurpleMedia instance will be created immediately.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 26352
diff changeset
900 * @return TRUE if the call succeeded else FALSE. (Doesn't imply the media session or stream will be successfully created)
23859
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
901 */
26365
34eb898478b4 Don't assume a PurpleMedia instance will be created immediately.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 26352
diff changeset
902 gboolean purple_prpl_initiate_media(PurpleAccount *account,
23859
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
903 const char *who,
23869
551a462b346a Changed PurpleMediaStreamType to PurpleMediaSessionType.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23868
diff changeset
904 PurpleMediaSessionType type);
23859
eb8c8a926589 Convert serv_* media functions to purple_prpl_* functions.
Mike Ruprecht <maiku@soc.pidgin.im>
parents: 23840
diff changeset
905
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
906 /*@}*/
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
907
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
908 /**************************************************************************/
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
909 /** @name Protocol Plugin Subsystem API */
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
910 /**************************************************************************/
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
911 /*@{*/
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
912
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
913 /**
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
914 * Finds a protocol plugin structure of the specified type.
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
915 *
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
916 * @param id The protocol plugin;
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
917 */
15822
32c366eeeb99 sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@gmail.com>
parents: 15523
diff changeset
918 PurplePlugin *purple_find_prpl(const char *id);
15373
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
919
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
920 /*@}*/
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
921
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
922 #ifdef __cplusplus
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
923 }
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
924 #endif
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
925
5fe8042783c1 Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
926 #endif /* _PRPL_H_ */