doc/account-signals.dox

Mon, 16 Jun 2008 02:29:33 +0000

author
Elliott Sales de Andrade <qulogic@pidgin.im>
date
Mon, 16 Jun 2008 02:29:33 +0000
branch
cpw.qulogic.msn
changeset 23796
026ffb2e4fb3
parent 22430
9a2ae22bf043
child 26581
669b448a46e5
permissions
-rw-r--r--

Fix up a typo between the declaration and definition of msn_got_photo.

References #5982.

6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1 /** @page account-signals Account Signals
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 @signals
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
4 @signal account-added
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
5 @signal account-connecting
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
6 @signal account-removed
12127
0ff56edeaaaf [gaim-migrate @ 14427]
Casey Harkins <charkins@pidgin.im>
parents: 12070
diff changeset
7 @signal account-disabled
0ff56edeaaaf [gaim-migrate @ 14427]
Casey Harkins <charkins@pidgin.im>
parents: 12070
diff changeset
8 @signal account-enabled
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
9 @signal account-setting-info
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
10 @signal account-set-info
11628
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
11 @signal account-status-changed
21140
26ad90b1ead5 Add the account-alias-changed signal to the summary at the top.
Etan Reisner <deryni@pidgin.im>
parents: 20897
diff changeset
12 @signal account-alias-changed
21205
af0ebfad2b43 Changelog some of the stuff.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 21204
diff changeset
13 @signal account-authorization-requested
af0ebfad2b43 Changelog some of the stuff.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 21204
diff changeset
14 @signal account-authorization-denied
af0ebfad2b43 Changelog some of the stuff.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 21204
diff changeset
15 @signal account-authorization-granted
21287
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
16 @signal account-error-changed
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
17 @endsignals
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
19 @see account.h
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
20
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 <hr>
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
23 @signaldef account-added
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
24 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
25 void (*account_added)(PurpleAccount *account);
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
26 @endsignalproto
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
27 @signaldesc
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
28 Emitted when an account is added.
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
29 @param account The account that was added.
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
30 @endsignaldef
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
31
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32 @signaldef account-connecting
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
33 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
34 void (*account_connecting)(PurpleAccount *account);
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
35 @endsignalproto
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
36 @signaldesc
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
37 This is called when an account is in the process of connecting.
6606
1387777368c7 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
38 @param account The account in the process of connecting.
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
39 @endsignaldef
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
40
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
41 @signaldef account-removed
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
42 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
43 void (*account_removed)(PurpleAccount *account);
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
44 @endsignalproto
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
45 @signaldesc
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
46 Emitted when an account is removed.
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
47 @param account The account that was removed.
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
48 @endsignaldef
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
49
12070
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
50 @signaldef account-disabled
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
51 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
52 void (*account_disabled)(PurpleAccount *account);
12070
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
53 @endsignalproto
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
54 @signaldesc
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
55 Emitted when an account is disabled.
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
56 @param account The account that was disabled.
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
57 @endsignaldef
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
58
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
59 @signaldef account-enabled
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
60 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
61 void (*account_enabled)(PurpleAccount *account);
12070
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
62 @endsignalproto
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
63 @signaldesc
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
64 Emitted when an account is enabled.
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
65 @param account The account that was enabled.
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
66 @endsignaldef
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
67
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
68 @signaldef account-setting-info
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
69 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
70 void (*account_setting_info)(PurpleAccount *account, const char *new_info);
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
71 @endsignalproto
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
72 @signaldesc
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
73 Emitted when a user is about to send his new user info, or
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
74 profile, to the server.
6606
1387777368c7 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
75 @param account The account that the info will be set on.
1387777368c7 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
76 @param new_info The new information to set.
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
77 @endsignaldef
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
78
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
79 @signaldef account-set-info
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
80 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
81 void (*account_set_info)(PurpleAccount *account, const char *new_info);
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
82 @endsignalproto
6606
1387777368c7 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
83 @signaldesc
1387777368c7 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
84 Emitted when a user sent his new user info, or profile, to the server.
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
85 @param account The account that the info was set on.
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
86 @param new_info The new information set.
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
87 @endsignaldef
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
88
11628
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
89 @signaldef account-status-changed
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
90 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
91 void (*account_status_changed)(PurpleAccount *account, PurpleStatus *old, PurpleStatus *new);
11628
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
92 @endsignalproto
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
93 @signaldesc
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
94 Emitted when the status of an account changes (after the change).
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
95 @param account The account that changed status.
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
96 @param old The status before change.
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
97 @param new The status after change.
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
98 @endsignaldef
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
99
13282
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
100 @signaldef account-alias-changed
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
101 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
102 void (*account_alias_changed)(PurpleAccount *account, const char *old);
13282
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
103 @endsignalproto
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
104 @signaldesc
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
105 Emitted when the alias of an account changes (after the change).
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
106 @param account The account for which the alias was changed.
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
107 @param old The alias before change.
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
108 @endsignaldef
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
109
20421
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
110 @signaldef account-authorization-requested
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
111 @signalproto
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
112 void (*account_authorization_requested)(PurpleAccount *account, const char *user);
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
113 @endsignalproto
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
114 @signaldesc
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
115 Emitted when a user requests authorization.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
116 @param account The account.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
117 @param user The name of the user requesting authorization.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
118 @return Less than zero to deny the request without prompting, greater
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
119 than zero if the request should be granted. If zero is returned,
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
120 then the user will be prompted with the request.
21205
af0ebfad2b43 Changelog some of the stuff.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 21204
diff changeset
121 @since 2.3.0
20421
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
122 @endsignaldef
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
123
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
124 @signaldef account-authorization-denied
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
125 @signalproto
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
126 void (*account_authorization_denied)(PurpleAccount *account, const char *user);
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
127 @endsignalproto
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
128 @signaldesc
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
129 Emitted when the authorization request for a buddy is denied.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
130 @param account The account.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
131 @param user The name of the user requesting authorization.
21205
af0ebfad2b43 Changelog some of the stuff.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 21204
diff changeset
132 @since 2.3.0
20421
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
133 @endsignaldef
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
134
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
135 @signaldef account-authorization-granted
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
136 @signalproto
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
137 void (*account_authorization_granted)(PurpleAccount *account, const char *user);
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
138 @endsignalproto
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
139 @signaldesc
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
140 Emitted when the authorization request for a buddy is granted.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
141 @param account The account.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
142 @param user The name of the user requesting authorization.
21205
af0ebfad2b43 Changelog some of the stuff.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 21204
diff changeset
143 @since 2.3.0
20421
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
144 @endsignaldef
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
145
21287
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
146 @signaldef account-error-changed
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
147 @signalproto
21298
d0d9cfaf3fe7 Mark pointed out that PurpleConnectionErrorPair is not a very good name for the
Will Thompson <resiak@pidgin.im>
parents: 21295
diff changeset
148 void (*account_error_changed)(PurpleAccount *account, const PurpleConnectionErrorInfo *old_error, const PurpleConnectionErrorInfo *current_error);
21287
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
149 @endsignalproto
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
150 @signaldesc
22430
9a2ae22bf043 I think it's reasonable to just say "don't do this".
Will Thompson <resiak@pidgin.im>
parents: 21682
diff changeset
151 Emitted when @a account's error changes. You should not call
9a2ae22bf043 I think it's reasonable to just say "don't do this".
Will Thompson <resiak@pidgin.im>
parents: 21682
diff changeset
152 purple_account_clear_current_error() while this signal is being emitted.
21294
1fe885468da2 Add the old error to the account-error-changed signal.
Will Thompson <resiak@pidgin.im>
parents: 21287
diff changeset
153 @param account The account whose error has changed.
1fe885468da2 Add the old error to the account-error-changed signal.
Will Thompson <resiak@pidgin.im>
parents: 21287
diff changeset
154 @param old_error The account's previous error, or @c NULL if it had no
21300
1c23e08cb824 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <resiak@pidgin.im>
parents: 21298
diff changeset
155 error. After this signal is emitted, @a old_error is
1c23e08cb824 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <resiak@pidgin.im>
parents: 21298
diff changeset
156 not guaranteed to be a valid pointer.
21294
1fe885468da2 Add the old error to the account-error-changed signal.
Will Thompson <resiak@pidgin.im>
parents: 21287
diff changeset
157 @param new_error The account's new error, or @c NULL if it has no error.
21300
1c23e08cb824 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <resiak@pidgin.im>
parents: 21298
diff changeset
158 If not @c NULL, @a new_error will remain a valid until
1c23e08cb824 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <resiak@pidgin.im>
parents: 21298
diff changeset
159 pointer just after the next time this signal is emitted
1c23e08cb824 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <resiak@pidgin.im>
parents: 21298
diff changeset
160 for this @a account.
21287
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
161 @see purple_account_get_current_error()
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
162 @since 2.3.0
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
163 @endsignaldef
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
164
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
165 */
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
166 // vim: syntax=c.doxygen tw=75 et

mercurial