doc/account-signals.dox

   1 /** @page account-signals Account Signals
   2
   3  @signals
   4   @signal account-created
   5   @signal account-destroying
   6   @signal account-added
   7   @signal account-connecting
   8   @signal account-removed
   9   @signal account-disabled
  10   @signal account-enabled
  11   @signal account-setting-info
  12   @signal account-set-info
  13   @signal account-status-changed
  14   @signal account-actions-changed
  15   @signal account-alias-changed
  16   @signal account-authorization-requested
  17   @signal account-authorization-requested-with-message
  18   @signal account-authorization-denied
  19   @signal account-authorization-granted
  20   @signal account-error-changed
  21   @signal account-signed-on
  22   @signal account-signed-off
  23   @signal account-connection-error
  24  @endsignals
  25
  26  @see account.h
  27
  28  <hr>
  29
  30  @signaldef account-created
  31   @signalproto
  32 void (*account_created)(PurpleAccount *account);
  33   @endsignalproto
  34   @signaldesc
  35    Emitted when an account is created by calling purple_account_new.
  36   @param account The account.
  37   @since 2.6.0
  38  @endsignaldef
  39
  40  @signaldef account-destroying
  41   @signalproto
  42 void (*account_destroying)(PurpleAccount *account);
  43   @endsignalproto
  44   @signaldesc
  45    Emitted when an account is about to be destroyed.
  46   @param account The account.
  47   @since 2.6.0
  48  @endsignaldef
  49
  50  @signaldef account-added
  51   @signalproto
  52 void (*account_added)(PurpleAccount *account);
  53   @endsignalproto
  54   @signaldesc
  55    Emitted when an account is added.
  56   @param account The account that was added.
  57   @see purple_accounts_add
  58  @endsignaldef
  59
  60  @signaldef account-connecting
  61   @signalproto
  62 void (*account_connecting)(PurpleAccount *account);
  63   @endsignalproto
  64   @signaldesc
  65    This is called when an account is in the process of connecting.
  66   @param account The account in the process of connecting.
  67  @endsignaldef
  68
  69  @signaldef account-removed
  70   @signalproto
  71 void (*account_removed)(PurpleAccount *account);
  72   @endsignalproto
  73   @signaldesc
  74    Emitted when an account is removed.
  75   @param account The account that was removed.
  76   @see purple_accounts_remove
  77  @endsignaldef
  78
  79  @signaldef account-disabled
  80   @signalproto
  81 void (*account_disabled)(PurpleAccount *account);
  82   @endsignalproto
  83   @signaldesc
  84    Emitted when an account is disabled.
  85   @param account The account that was disabled.
  86  @endsignaldef
  87
  88  @signaldef account-enabled
  89   @signalproto
  90 void (*account_enabled)(PurpleAccount *account);
  91   @endsignalproto
  92   @signaldesc
  93    Emitted when an account is enabled.
  94   @param account The account that was enabled.
  95  @endsignaldef
  96
  97  @signaldef account-setting-info
  98   @signalproto
  99 void (*account_setting_info)(PurpleAccount *account, const char *new_info);
 100   @endsignalproto
 101   @signaldesc
 102    Emitted when a user is about to send his new user info, or
 103    profile, to the server.
 104   @param account  The account that the info will be set on.
 105   @param new_info The new information to set.
 106  @endsignaldef
 107
 108  @signaldef account-set-info
 109   @signalproto
 110 void (*account_set_info)(PurpleAccount *account, const char *new_info);
 111   @endsignalproto
 112   @signaldesc
 113    Emitted when a user sent his new user info, or profile, to the server.
 114   @param account  The account that the info was set on.
 115   @param new_info The new information set.
 116  @endsignaldef
 117
 118  @signaldef account-status-changed
 119   @signalproto
 120 void (*account_status_changed)(PurpleAccount *account, PurpleStatus *old, PurpleStatus *new);
 121   @endsignalproto
 122   @signaldesc
 123    Emitted when the status of an account changes (after the change).
 124   @param account The account that changed status.
 125   @param old     The status before change.
 126   @param new     The status after change.
 127  @endsignaldef
 128
 129  @signaldef account-actions-changed
 130   @signalproto
 131 void (*account_actions_changed)(PurpleAccount *account);
 132   @endsignalproto
 133   @signaldesc
 134    Emitted when the account actions are changed after initial connection.
 135   @param account The account whose actions changed.
 136  @endsignaldef
 137
 138  @signaldef account-alias-changed
 139   @signalproto
 140 void (*account_alias_changed)(PurpleAccount *account, const char *old);
 141   @endsignalproto
 142   @signaldesc
 143    Emitted when the alias of an account changes (after the change).
 144   @param account The account for which the alias was changed.
 145   @param old     The alias before change.
 146  @endsignaldef
 147
 148  @signaldef account-authorization-requested
 149   @signalproto
 150 int (*account_authorization_requested)(PurpleAccount *account, const char *user);
 151   @endsignalproto
 152   @signaldesc
 153    Emitted when a user requests authorization.
 154   @param account The account.
 155   @param user    The name of the user requesting authorization.
 156   @return Less than zero to deny the request without prompting, greater
 157           than zero if the request should be granted. If zero is returned,
 158           then the user will be prompted with the request.
 159   @since 2.3.0
 160  @endsignaldef
 161
 162  @signaldef account-authorization-requested-with-message
 163   @signalproto
 164 int (*account_authorization_requested)(PurpleAccount *account, const char *user, const char *message);
 165   @endsignalproto
 166   @signaldesc
 167    Emitted when a user requests authorization.
 168   @param account The account.
 169   @param user    The name of the user requesting authorization.
 170   @param message The authorization request message
 171   @return PURPLE_ACCOUNT_RESPONSE_IGNORE to silently ignore the request,
 172           PURPLE_ACCOUNT_RESPONSE_DENY to block the request (the sender might
 173           get informed, PURPLE_ACCOUNT_RESPONSE_ACCEPT if the request should be
 174           granted. If PURPLE_ACCOUNT_RESPONSE_PASS is returned, then the user
 175           will be prompted with the request.
 176   @since 2.8.0
 177  @endsignaldef
 178
 179  @signaldef account-authorization-denied
 180   @signalproto
 181 void (*account_authorization_denied)(PurpleAccount *account, const char *user);
 182   @endsignalproto
 183   @signaldesc
 184    Emitted when the authorization request for a buddy is denied.
 185   @param account The account.
 186   @param user    The name of the user requesting authorization.
 187   @since 2.3.0
 188  @endsignaldef
 189
 190  @signaldef account-authorization-granted
 191   @signalproto
 192 void (*account_authorization_granted)(PurpleAccount *account, const char *user);
 193   @endsignalproto
 194   @signaldesc
 195    Emitted when the authorization request for a buddy is granted.
 196   @param account The account.
 197   @param user    The name of the user requesting authorization.
 198   @since 2.3.0
 199  @endsignaldef
 200
 201  @signaldef account-error-changed
 202   @signalproto
 203 void (*account_error_changed)(PurpleAccount *account, const PurpleConnectionErrorInfo *old_error, const PurpleConnectionErrorInfo *current_error);
 204   @endsignalproto
 205   @signaldesc
 206    Emitted when @a account's error changes.  You should not call
 207    purple_account_clear_current_error() while this signal is being emitted.
 208   @param account   The account whose error has changed.
 209   @param old_error The account's previous error, or @c NULL if it had no
 210                    error.  After this signal is emitted, @a old_error is
 211                    not guaranteed to be a valid pointer.
 212   @param new_error The account's new error, or @c NULL if it has no error.
 213                    If not @c NULL, @a new_error will remain a valid until
 214                    pointer just after the next time this signal is emitted
 215                    for this @a account.
 216   @see purple_account_get_current_error()
 217   @since 2.3.0
 218  @endsignaldef
 219
 220  @signaldef account-signed-on
 221   @signalproto
 222 void (*signed_on)(PurpleAccount *account);
 223   @endsignalproto
 224   @signaldesc
 225    Emitted when an account has signed on.
 226   @param account The account that has signed on.
 227   @since 2.7.0
 228  @endsignaldef
 229
 230  @signaldef account-signed-off
 231   @signalproto
 232 void (*signed_off)(PurpleAccount *account);
 233   @endsignalproto
 234   @signaldesc
 235    Emitted when an account has signed off.
 236   @param account The account that has signed off.
 237   @since 2.7.0
 238  @endsignaldef
 239
 240  @signaldef account-connection-error
 241   @signalproto
 242 void (*connection_error)(PurpleAccount *gc, PurpleConnectionError err, const gchar *desc)
 243   @endsignalproto
 244   @signaldesc
 245    Emitted when a connection error occurs, before @ref signed-off.
 246    @param account The account on which the error has occurred
 247    @param err     The error that occurred
 248    @param desc    A description of the error, giving more information.
 249   @since 2.7.0
 250  @endsignaldef
 251  */
 252 // vim: syntax=c.doxygen tw=75 et