comparison libpurple/account.h @ 32827:4a34689eeb33 default tip

merged from im.pidgin.pidgin
author Yoshiki Yazawa <yaz@honeyplanet.jp>
date Sat, 19 Nov 2011 14:42:54 +0900
parents ec6371d4cae8
children
comparison
equal deleted inserted replaced
32692:0f94ec89f0bc 32827:4a34689eeb33
166 166
167 void *ui_data; /**< The UI can put data here. */ 167 void *ui_data; /**< The UI can put data here. */
168 PurpleAccountRegistrationCb registration_cb; 168 PurpleAccountRegistrationCb registration_cb;
169 void *registration_cb_user_data; 169 void *registration_cb_user_data;
170 170
171 gpointer priv; /**< Pointer to opaque private data. */ 171 PurpleConnectionErrorInfo *current_error; /**< Errors */
172 }; 172 };
173 173
174 #ifdef __cplusplus 174 #ifdef __cplusplus
175 extern "C" { 175 extern "C" {
176 #endif 176 #endif
219 * @param account The account to register. 219 * @param account The account to register.
220 */ 220 */
221 void purple_account_register(PurpleAccount *account); 221 void purple_account_register(PurpleAccount *account);
222 222
223 /** 223 /**
224 * Registration of the account was completed.
225 * Calls the registration call-back set with purple_account_set_register_callback().
226 *
227 * @param account The account being registered.
228 * @param succeeded Was the account registration successful?
229 */
230 void purple_account_register_completed(PurpleAccount *account, gboolean succeeded);
231
232 /**
224 * Unregisters an account (deleting it from the server). 233 * Unregisters an account (deleting it from the server).
225 * 234 *
226 * @param account The account to unregister. 235 * @param account The account to unregister.
227 * @param cb Optional callback to be called when unregistration is complete 236 * @param cb Optional callback to be called when unregistration is complete
228 * @param user_data user data to pass to the callback 237 * @param user_data user data to pass to the callback
233 * Disconnects from an account. 242 * Disconnects from an account.
234 * 243 *
235 * @param account The account to disconnect from. 244 * @param account The account to disconnect from.
236 */ 245 */
237 void purple_account_disconnect(PurpleAccount *account); 246 void purple_account_disconnect(PurpleAccount *account);
247
248 /**
249 * Indicates if the account is currently being disconnected.
250 *
251 * @param account The account
252 *
253 * @return TRUE if the account is being disconnected.
254 */
255 gboolean purple_account_is_disconnecting(const PurpleAccount *account);
238 256
239 /** 257 /**
240 * Notifies the user that the account was added to a remote user's 258 * Notifies the user that the account was added to a remote user's
241 * buddy list. 259 * buddy list.
242 * 260 *
601 */ 619 */
602 void purple_account_set_ui_bool(PurpleAccount *account, const char *ui, 620 void purple_account_set_ui_bool(PurpleAccount *account, const char *ui,
603 const char *name, gboolean value); 621 const char *name, gboolean value);
604 622
605 /** 623 /**
624 * Returns the UI data associated with this account.
625 *
626 * @param account The account.
627 *
628 * @return The UI data associated with this object. This is a
629 * convenience field provided to the UIs--it is not
630 * used by the libuprple core.
631 */
632 gpointer purple_account_get_ui_data(const PurpleAccount *account);
633
634 /**
635 * Set the UI data associated with this account.
636 *
637 * @param account The account.
638 * @param ui_data A pointer to associate with this object.
639 */
640 void purple_account_set_ui_data(PurpleAccount *account, gpointer ui_data);
641
642 /**
606 * Returns whether or not the account is connected. 643 * Returns whether or not the account is connected.
607 * 644 *
608 * @param account The account. 645 * @param account The account.
609 * 646 *
610 * @return @c TRUE if connected, or @c FALSE otherwise. 647 * @return @c TRUE if connected, or @c FALSE otherwise.