comparison: libpurple/internal.h
libpurple/internal.h
- branch
- soc.2013.gobjectification.plugins
- changeset 37023
- d9bcdc9a91e6
- parent 37021
- 04c99b24db84
- child 37025
- 12d925ea1e2f
equal
deleted
inserted
replaced
| 37022:d891503c8aa6 | 37023:d9bcdc9a91e6 |
|---|---|
| 159 #include "connection.h" | 159 #include "connection.h" |
| 160 | 160 |
| 161 /** | 161 /** |
| 162 * Sets an error for an account. | 162 * Sets an error for an account. |
| 163 * | 163 * |
| 164 * @account: The account to set the error for. | 164 * @param account The account to set the error for. |
| 165 * @new_err: The #PurpleConnectionErrorInfo instance representing the | 165 * @param new_err The #PurpleConnectionErrorInfo instance representing the |
| 166 * error. | 166 * error. |
| 167 */ | 167 */ |
| 168 void _purple_account_set_current_error(PurpleAccount *account, | 168 void _purple_account_set_current_error(PurpleAccount *account, |
| 169 PurpleConnectionErrorInfo *new_err); | 169 PurpleConnectionErrorInfo *new_err); |
| 170 | 170 |
| 171 /** | 171 /** |
| 172 * Get an XML description of an account. | 172 * Get an XML description of an account. |
| 173 * | 173 * |
| 174 * @account: The account | 174 * @param account The account |
| 175 * Returns: The XML description of the account. | 175 * @return The XML description of the account. |
| 176 */ | 176 */ |
| 177 PurpleXmlNode *_purple_account_to_xmlnode(PurpleAccount *account); | 177 PurpleXmlNode *_purple_account_to_xmlnode(PurpleAccount *account); |
| 178 | 178 |
| 179 /** | 179 /** |
| 180 * Returns the last child of a particular node. | 180 * Returns the last child of a particular node. |
| 181 * | 181 * |
| 182 * @node: The node whose last child is to be retrieved. | 182 * @param node The node whose last child is to be retrieved. |
| 183 * | 183 * |
| 184 * Returns: The last child of the node. | 184 * @return The last child of the node. |
| 185 */ | 185 */ |
| 186 PurpleBlistNode *_purple_blist_get_last_child(PurpleBlistNode *node); | 186 PurpleBlistNode *_purple_blist_get_last_child(PurpleBlistNode *node); |
| 187 | 187 |
| 188 /* This is for the accounts code to notify the buddy icon code that | 188 /* This is for the accounts code to notify the buddy icon code that |
| 189 * it's done loading. We may want to replace this with a signal. */ | 189 * it's done loading. We may want to replace this with a signal. */ |
| 201 * the connection uses the current active status for this account. | 201 * the connection uses the current active status for this account. |
| 202 * So if you want to sign on as "away," for example, you need to | 202 * So if you want to sign on as "away," for example, you need to |
| 203 * have called purple_account_set_status(account, "away"). | 203 * have called purple_account_set_status(account, "away"). |
| 204 * (And this will call purple_account_connect() automatically). | 204 * (And this will call purple_account_connect() automatically). |
| 205 * | 205 * |
| 206 * Note: This function should only be called by purple_account_connect() | 206 * @note This function should only be called by purple_account_connect() |
| 207 * in account.c. If you're trying to sign on an account, use that | 207 * in account.c. If you're trying to sign on an account, use that |
| 208 * function instead. | 208 * function instead. |
| 209 * | 209 * |
| 210 * @account: The account the connection should be connecting to. | 210 * @param account The account the connection should be connecting to. |
| 211 * @regist: Whether we are registering a new account or just | 211 * @param regist Whether we are registering a new account or just |
| 212 * trying to do a normal signon. | 212 * trying to do a normal signon. |
| 213 * @password: The password to use. | 213 * @param password The password to use. |
| 214 */ | 214 */ |
| 215 void _purple_connection_new(PurpleAccount *account, gboolean regist, | 215 void _purple_connection_new(PurpleAccount *account, gboolean regist, |
| 216 const char *password); | 216 const char *password); |
| 217 /** | 217 /** |
| 218 * Tries to unregister the account on the server. If the account is not | 218 * Tries to unregister the account on the server. If the account is not |
| 219 * connected, also creates a new connection. | 219 * connected, also creates a new connection. |
| 220 * | 220 * |
| 221 * Note: This function should only be called by purple_account_unregister() | 221 * @note This function should only be called by purple_account_unregister() |
| 222 * in account.c. | 222 * in account.c. |
| 223 * | 223 * |
| 224 * @account: The account to unregister | 224 * @param account The account to unregister |
| 225 * @password: The password to use. | 225 * @param password The password to use. |
| 226 * @cb: Optional callback to be called when unregistration is complete | 226 * @param cb Optional callback to be called when unregistration is complete |
| 227 * @user_data: user data to pass to the callback | 227 * @param user_data user data to pass to the callback |
| 228 */ | 228 */ |
| 229 void _purple_connection_new_unregister(PurpleAccount *account, const char *password, | 229 void _purple_connection_new_unregister(PurpleAccount *account, const char *password, |
| 230 PurpleAccountUnregistrationCb cb, void *user_data); | 230 PurpleAccountUnregistrationCb cb, void *user_data); |
| 231 /** | 231 /** |
| 232 * Checks if a connection is disconnecting, and should not attempt to reconnect. | 232 * Checks if a connection is disconnecting, and should not attempt to reconnect. |
| 233 * | 233 * |
| 234 * Note: This function should only be called by purple_account_set_enabled() | 234 * @note This function should only be called by purple_account_set_enabled() |
| 235 * in account.c. | 235 * in account.c. |
| 236 * | 236 * |
| 237 * @gc: The connection to check | 237 * @param gc The connection to check |
| 238 */ | 238 */ |
| 239 gboolean _purple_connection_wants_to_die(const PurpleConnection *gc); | 239 gboolean _purple_connection_wants_to_die(const PurpleConnection *gc); |
| 240 | 240 |
| 241 /** | 241 /** |
| 242 * Adds a chat to the active chats list of a connection | 242 * Adds a chat to the active chats list of a connection |
| 243 * | 243 * |
| 244 * Note: This function should only be called by serv_got_joined_chat() | 244 * @note This function should only be called by serv_got_joined_chat() |
| 245 * in server.c. | 245 * in server.c. |
| 246 * | 246 * |
| 247 * @gc: The connection | 247 * @param gc The connection |
| 248 * @chat: The chat conversation to add | 248 * @param chat The chat conversation to add |
| 249 */ | 249 */ |
| 250 void _purple_connection_add_active_chat(PurpleConnection *gc, | 250 void _purple_connection_add_active_chat(PurpleConnection *gc, |
| 251 PurpleChatConversation *chat); | 251 PurpleChatConversation *chat); |
| 252 /** | 252 /** |
| 253 * Removes a chat from the active chats list of a connection | 253 * Removes a chat from the active chats list of a connection |
| 254 * | 254 * |
| 255 * Note: This function should only be called by serv_got_chat_left() | 255 * @note This function should only be called by serv_got_chat_left() |
| 256 * in server.c. | 256 * in server.c. |
| 257 * | 257 * |
| 258 * @gc: The connection | 258 * @param gc The connection |
| 259 * @chat: The chat conversation to remove | 259 * @param chat The chat conversation to remove |
| 260 */ | 260 */ |
| 261 void _purple_connection_remove_active_chat(PurpleConnection *gc, | 261 void _purple_connection_remove_active_chat(PurpleConnection *gc, |
| 262 PurpleChatConversation *chat); | 262 PurpleChatConversation *chat); |
| 263 | 263 |
| 264 /** | 264 /** |
| 265 * Returns the primitive scores array from status.c. | 265 * Returns the primitive scores array from status.c. |
| 266 * | 266 * |
| 267 * Note: This function should only be called by | 267 * @note This function should only be called by |
| 268 * purple_buddy_presence_compute_score() in presence.c. | 268 * purple_buddy_presence_compute_score() in presence.c. |
| 269 */ | 269 */ |
| 270 int *_purple_statuses_get_primitive_scores(void); | 270 int *_purple_statuses_get_primitive_scores(void); |
| 271 | 271 |
| 272 #endif /* _PURPLE_INTERNAL_H_ */ | 272 #endif /* _PURPLE_INTERNAL_H_ */ |
