--- a/libpurple/protocols/msn/user.h Tue Jun 22 01:40:18 2010 +0000
+++ b/libpurple/protocols/msn/user.h Mon Jul 19 21:05:06 2010 +0000
@@ -79,10 +79,13 @@
{
MsnUserList *userlist;
+ guint8 refcount; /**< The reference count of this object */
+
char *passport; /**< The passport account. */
char *friendly_name; /**< The friendly name. */
char *uid; /*< User ID */
+ GSList *endpoints; /*< Endpoint-specific data */
const char *status; /**< The state of the user. */
char *statusline; /**< The state of the user. */
@@ -102,6 +105,7 @@
GHashTable *clientcaps; /**< The client's capabilities. */
guint clientid; /**< The client's ID */
+ guint extcaps; /**< The client's extended capabilities */
MsnNetwork networkid; /**< The user's network */
@@ -116,6 +120,18 @@
char *invite_message; /**< Invite message of user request */
};
+/**
+ * A specific user endpoint.
+ */
+typedef struct MsnUserEndpoint {
+ char *id; /**< The client's endpoint ID */
+ char *name; /**< The client's endpoint's name */
+ int type; /**< The client's endpoint type */
+ guint clientid; /**< The client's ID */
+ guint extcaps; /**< The client's extended capabilites */
+
+} MsnUserEndpoint;
+
/**************************************************************************
** @name User API *
**************************************************************************/
@@ -134,12 +150,20 @@
const char *friendly_name);
/**
- * Destroys a user structure.
+ * Increment the reference count.
+ *
+ * @param user The user.
*
- * @param user The user to destroy.
+ * @return user.
*/
-void msn_user_destroy(MsnUser *user);
+MsnUser *msn_user_ref(MsnUser *user);
+/**
+ * Decrement the reference count.
+ *
+ * @param user The user
+ */
+void msn_user_unref(MsnUser *user);
/**
* Updates the user.
@@ -252,6 +276,16 @@
void msn_user_set_uid(MsnUser *user, const char *uid);
/**
+ * Sets endpoint data for a user.
+ *
+ * @param user The user.
+ * @param endpoint The endpoint.
+ * @param data The endpoint data.
+ */
+void
+msn_user_set_endpoint_data(MsnUser *user, const char *endpoint, MsnUserEndpoint *data);
+
+/**
* Sets the client id for a user.
*
* @param user The user.
@@ -260,6 +294,14 @@
void msn_user_set_clientid(MsnUser *user, guint clientid);
/**
+ * Sets the client id for a user.
+ *
+ * @param user The user.
+ * @param extcaps The client's extended capabilities.
+ */
+void msn_user_set_extcaps(MsnUser *user, guint extcaps);
+
+/**
* Sets the network id for a user.
*
* @param user The user.
@@ -346,6 +388,17 @@
const char *msn_user_get_mobile_phone(const MsnUser *user);
/**
+ * Gets endpoint data for a user.
+ *
+ * @param user The user.
+ * @param endpoint The endpoint.
+ *
+ * @return The user's endpoint data.
+ */
+MsnUserEndpoint *
+msn_user_get_endpoint_data(MsnUser *user, const char *endpoint);
+
+/**
* Returns the client id for a user.
*
* @param user The user.
@@ -355,6 +408,39 @@
guint msn_user_get_clientid(const MsnUser *user);
/**
+ * Returns the extended capabilities for a user.
+ *
+ * @param user The user.
+ *
+ * @return The user's extended capabilities.
+ */
+guint msn_user_get_extcaps(const MsnUser *user);
+
+/**************************************************************************
+ * Utility functions
+ **************************************************************************/
+
+
+/**
+ * Check if the user is part of the group.
+ *
+ * @param user The user we are asking group membership.
+ * @param group_id The group where the user may be in.
+ *
+ * @return TRUE if user is part of the group. Otherwise, FALSE.
+ */
+gboolean msn_user_is_in_group(MsnUser *user, const char * group_id);
+
+/**
+ * Check if user is on list.
+ *
+ * @param user The user we are asking list membership.
+ * @param list_id The list where the user may be in.
+ *
+ * @return TRUE if the user is on the list, else FALSE.
+ */
+gboolean msn_user_is_in_list(MsnUser *user, MsnListId list_id);
+/**
* Returns the network id for a user.
*
* @param user The user.
@@ -398,11 +484,36 @@
/**
* check to see if user is Yahoo User
*/
-gboolean msn_user_is_yahoo(PurpleAccount *account ,const char *name);
+gboolean msn_user_is_yahoo(PurpleAccount *account, const char *name);
void msn_user_set_op(MsnUser *user, MsnListOp list_op);
void msn_user_unset_op(MsnUser *user, MsnListOp list_op);
+/**
+ * Compare the given passport with the one of the user
+ *
+ * @param user User to compare.
+ * @oaran passport Passport to compare.
+ *
+ * @return Zero if the passport match with the one of the user, otherwise
+ * a positive integer if the user passport is greather than the one given
+ * and a negative integer if it is less.
+ */
+int msn_user_passport_cmp(MsnUser *user, const char *passport);
+
+/**
+ * Checks whether a user is capable of some task.
+ *
+ * @param user The user.
+ * @param endpoint The endpoint. Can be @NULL to check overall capabilities.
+ * @param capability The capability (including client version).
+ * @param extcap The extended capability.
+ *
+ * @return Whether the user supports the capability.
+ */
+gboolean
+msn_user_is_capable(MsnUser *user, char *endpoint, guint capability, guint extcap);
+
/*@}*/
#endif /* MSN_USER_H */