annotate doc/account-signals.dox @ 29181:bcea7c92d3f1

Oops, don't break things for successfully receiving of a file. Refs #6523.
author Elliott Sales de Andrade <qulogic@pidgin.im>
date Mon, 14 Dec 2009 06:10:28 +0000
parents 76a1598ecf1c
children 0417d6bc47cd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1 /** @page account-signals Account Signals
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 @signals
26845
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
4 @signal account-created
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
5 @signal account-destroying
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
6 @signal account-added
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
7 @signal account-connecting
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
8 @signal account-removed
12127
944c97d11bb1 [gaim-migrate @ 14427]
Richard Laager <rlaager@wiktel.com>
parents: 12070
diff changeset
9 @signal account-disabled
944c97d11bb1 [gaim-migrate @ 14427]
Richard Laager <rlaager@wiktel.com>
parents: 12070
diff changeset
10 @signal account-enabled
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
11 @signal account-setting-info
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
12 @signal account-set-info
11628
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
13 @signal account-status-changed
26776
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
14 @signal account-actions-changed
21064
1aaa6e9881b9 Add the account-alias-changed signal to the summary at the top.
Etan Reisner <pidgin@unreliablesource.net>
parents: 20807
diff changeset
15 @signal account-alias-changed
21221
e98c08afb706 Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 21220
diff changeset
16 @signal account-authorization-requested
e98c08afb706 Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 21220
diff changeset
17 @signal account-authorization-denied
e98c08afb706 Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 21220
diff changeset
18 @signal account-authorization-granted
21366
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
19 @signal account-error-changed
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20 @endsignals
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
22 @see account.h
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
23
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 <hr>
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25
26845
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
26 @signaldef account-created
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
27 @signalproto
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
28 void (*account_created)(PurpleAccount *account);
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
29 @endsignalproto
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
30 @signaldesc
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
31 Emitted when an account is created by calling purple_account_new.
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
32 @param account The account.
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
33 @since 2.6.0
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
34 @endsignaldef
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
35
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
36 @signaldef account-destroying
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
37 @signalproto
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
38 void (*account_destroying)(PurpleAccount *account);
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
39 @endsignalproto
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
40 @signaldesc
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
41 Emitted when an account is about to be destroyed.
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
42 @param account The account.
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
43 @since 2.6.0
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
44 @endsignaldef
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
45
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
46 @signaldef account-added
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
47 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
48 void (*account_added)(PurpleAccount *account);
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
49 @endsignalproto
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
50 @signaldesc
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
51 Emitted when an account is added.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
52 @param account The account that was added.
26845
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
53 @see purple_accounts_add
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
54 @endsignaldef
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
55
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
56 @signaldef account-connecting
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
57 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
58 void (*account_connecting)(PurpleAccount *account);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
59 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
60 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
61 This is called when an account is in the process of connecting.
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
62 @param account The account in the process of connecting.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
63 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
64
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
65 @signaldef account-removed
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
66 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
67 void (*account_removed)(PurpleAccount *account);
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
68 @endsignalproto
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
69 @signaldesc
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
70 Emitted when an account is removed.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
71 @param account The account that was removed.
26845
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
72 @see purple_accounts_remove
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
73 @endsignaldef
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
74
12070
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
75 @signaldef account-disabled
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
76 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
77 void (*account_disabled)(PurpleAccount *account);
12070
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
78 @endsignalproto
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
79 @signaldesc
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
80 Emitted when an account is disabled.
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
81 @param account The account that was disabled.
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
82 @endsignaldef
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
83
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
84 @signaldef account-enabled
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
85 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
86 void (*account_enabled)(PurpleAccount *account);
12070
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
87 @endsignalproto
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
88 @signaldesc
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
89 Emitted when an account is enabled.
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
90 @param account The account that was enabled.
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
91 @endsignaldef
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
92
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
93 @signaldef account-setting-info
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
94 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
95 void (*account_setting_info)(PurpleAccount *account, const char *new_info);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
96 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
97 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
98 Emitted when a user is about to send his new user info, or
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
99 profile, to the server.
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
100 @param account The account that the info will be set on.
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
101 @param new_info The new information to set.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
102 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
103
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
104 @signaldef account-set-info
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
105 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
106 void (*account_set_info)(PurpleAccount *account, const char *new_info);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
107 @endsignalproto
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
108 @signaldesc
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
109 Emitted when a user sent his new user info, or profile, to the server.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
110 @param account The account that the info was set on.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
111 @param new_info The new information set.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
112 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
113
11628
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
114 @signaldef account-status-changed
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
115 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
116 void (*account_status_changed)(PurpleAccount *account, PurpleStatus *old, PurpleStatus *new);
11628
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
117 @endsignalproto
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
118 @signaldesc
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
119 Emitted when the status of an account changes (after the change).
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
120 @param account The account that changed status.
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
121 @param old The status before change.
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
122 @param new The status after change.
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
123 @endsignaldef
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
124
26776
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
125 @signaldef account-actions-changed
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
126 @signalproto
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
127 void (*account_actions_changed)(PurpleAccount *account);
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
128 @endsignalproto
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
129 @signaldesc
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
130 Emitted when the account actions are changed after initial connection.
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
131 @param account The account whose actions changed.
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
132 @endsignaldef
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
133
13281
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
134 @signaldef account-alias-changed
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
135 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
136 void (*account_alias_changed)(PurpleAccount *account, const char *old);
13281
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
137 @endsignalproto
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
138 @signaldesc
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
139 Emitted when the alias of an account changes (after the change).
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
140 @param account The account for which the alias was changed.
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
141 @param old The alias before change.
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
142 @endsignaldef
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
143
20178
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
144 @signaldef account-authorization-requested
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
145 @signalproto
26327
5b522d6e04ca Update the documentation for the account-authorization-requested signal, as
Richard Laager <rlaager@wiktel.com>
parents: 22300
diff changeset
146 int (*account_authorization_requested)(PurpleAccount *account, const char *user);
20178
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
147 @endsignalproto
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
148 @signaldesc
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
149 Emitted when a user requests authorization.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
150 @param account The account.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
151 @param user The name of the user requesting authorization.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
152 @return Less than zero to deny the request without prompting, greater
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
153 than zero if the request should be granted. If zero is returned,
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
154 then the user will be prompted with the request.
21221
e98c08afb706 Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 21220
diff changeset
155 @since 2.3.0
20178
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
156 @endsignaldef
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
157
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
158 @signaldef account-authorization-denied
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
159 @signalproto
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
160 void (*account_authorization_denied)(PurpleAccount *account, const char *user);
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
161 @endsignalproto
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
162 @signaldesc
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
163 Emitted when the authorization request for a buddy is denied.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
164 @param account The account.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
165 @param user The name of the user requesting authorization.
21221
e98c08afb706 Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 21220
diff changeset
166 @since 2.3.0
20178
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
167 @endsignaldef
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
168
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
169 @signaldef account-authorization-granted
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
170 @signalproto
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
171 void (*account_authorization_granted)(PurpleAccount *account, const char *user);
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
172 @endsignalproto
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
173 @signaldesc
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
174 Emitted when the authorization request for a buddy is granted.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
175 @param account The account.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
176 @param user The name of the user requesting authorization.
21221
e98c08afb706 Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 21220
diff changeset
177 @since 2.3.0
20178
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
178 @endsignaldef
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
179
21366
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
180 @signaldef account-error-changed
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
181 @signalproto
21377
872068d10eab Mark pointed out that PurpleConnectionErrorPair is not a very good name for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 21374
diff changeset
182 void (*account_error_changed)(PurpleAccount *account, const PurpleConnectionErrorInfo *old_error, const PurpleConnectionErrorInfo *current_error);
21366
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
183 @endsignalproto
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
184 @signaldesc
22300
cccdcc7e5642 I think it's reasonable to just say "don't do this".
Will Thompson <will.thompson@collabora.co.uk>
parents: 21597
diff changeset
185 Emitted when @a account's error changes. You should not call
cccdcc7e5642 I think it's reasonable to just say "don't do this".
Will Thompson <will.thompson@collabora.co.uk>
parents: 21597
diff changeset
186 purple_account_clear_current_error() while this signal is being emitted.
21373
cbf197042bad Add the old error to the account-error-changed signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 21366
diff changeset
187 @param account The account whose error has changed.
cbf197042bad Add the old error to the account-error-changed signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 21366
diff changeset
188 @param old_error The account's previous error, or @c NULL if it had no
21379
30a532b14003 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents: 21377
diff changeset
189 error. After this signal is emitted, @a old_error is
30a532b14003 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents: 21377
diff changeset
190 not guaranteed to be a valid pointer.
21373
cbf197042bad Add the old error to the account-error-changed signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 21366
diff changeset
191 @param new_error The account's new error, or @c NULL if it has no error.
21379
30a532b14003 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents: 21377
diff changeset
192 If not @c NULL, @a new_error will remain a valid until
30a532b14003 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents: 21377
diff changeset
193 pointer just after the next time this signal is emitted
30a532b14003 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents: 21377
diff changeset
194 for this @a account.
21366
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
195 @see purple_account_get_current_error()
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
196 @since 2.3.0
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
197 @endsignaldef
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
198
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
199 */
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
200 // vim: syntax=c.doxygen tw=75 et