/**

  * @file user.h User functions

  *

  * purple

  *

  * Purple is the legal property of its developers, whose names are too numerous

  * to list here.  Please refer to the COPYRIGHT file distributed with this

  * source distribution.

  *

  * This program is free software; you can redistribute it and/or modify

  * it under the terms of the GNU General Public License as published by

  * the Free Software Foundation; either version 2 of the License, or

  * (at your option) any later version.

  *

  * This program is distributed in the hope that it will be useful,

  * but WITHOUT ANY WARRANTY; without even the implied warranty of

  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  * GNU General Public License for more details.

  *

  * You should have received a copy of the GNU General Public License

  * along with this program; if not, write to the Free Software

  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA

  */

 #ifndef _MSN_USER_H_

 #define _MSN_USER_H_

 typedef struct _MsnUser  MsnUser;

 #include "session.h"

 #include "object.h"

 #include "userlist.h"

 typedef enum

 {

 	MSN_NETWORK_UNKNOWN      = 0x00,

 	MSN_NETWORK_PASSPORT     = 0x01,

 	MSN_NETWORK_COMMUNICATOR = 0x02,

 	MSN_NETWORK_MOBILE       = 0x04,

 	MSN_NETWORK_MNI          = 0x08,

 	MSN_NETWORK_SMTP         = 0x10,

 	MSN_NETWORK_YAHOO        = 0x20

 } MsnNetwork;

 /**

  * Current media.

  */

 typedef enum

 {

 	CURRENT_MEDIA_UNKNOWN,

 	CURRENT_MEDIA_MUSIC,

 	CURRENT_MEDIA_GAMES,

 	CURRENT_MEDIA_OFFICE

 } CurrentMediaType;

 typedef struct _CurrentMedia

 {

 	CurrentMediaType type;     /**< Type.   */

 	char *title;    /**< Title.  */

 	char *artist;   /**< Artist. */

 	char *album;    /**< Album.  */

 } CurrentMedia;

 /**

  * A user.

  */

 struct _MsnUser

 {

 	MsnUserList *userlist;

 	char *passport;         /**< The passport account.          */

 	char *friendly_name;    /**< The friendly name.             */

 	char * uid;				/*< User Id							*/

 	const char *status;     /**< The state of the user.         */

 	char *statusline;       /**< The state of the user.         */

 	CurrentMedia media;     /**< Current media of the user.     */

 	gboolean idle;          /**< The idle state of the user.    */

 	struct

 	{

 		char *home;         /**< Home phone number.             */

 		char *work;         /**< Work phone number.             */

 		char *mobile;       /**< Mobile phone number.           */

 	} phone;

 	gboolean authorized;    /**< Authorized to add this user.   */

 	gboolean mobile;        /**< Signed up with MSN Mobile.     */

 	GList *group_ids;       /**< The group IDs.                 */

 	char *pending_group;    /**< A pending group to add.        */

 	MsnObject *msnobj;      /**< The user's MSN Object.         */

 	GHashTable *clientcaps; /**< The client's capabilities.     */

 	guint clientid;         /**< The client's ID                */

 	MsnNetwork networkid;   /**< The user's network             */

 	int list_op;            /**< Which lists the user is in     */

 	guint membership_id[5];	/**< The membershipId sent by the contacts server,

 				     indexed by the list it belongs to		*/

 	char *invite_message;   /**< Invite message of user request */

 };

 /**************************************************************************

  ** @name User API                                                        *

  **************************************************************************/

 /*@{*/

 /**

  * Creates a new user structure.

  *

  * @param session      The MSN session.

  * @param passport     The initial passport.

  * @param stored_name  The initial stored name.

  *

  * @return A new user structure.

  */

 MsnUser *msn_user_new(MsnUserList *userlist, const char *passport,

 					  const char *friendly_name);

 /**

  * Destroys a user structure.

  *

  * @param user The user to destroy.

  */

 void msn_user_destroy(MsnUser *user);

 /**

  * Updates the user.

  *

  * Communicates with the core to update the ui, etc.

  *

  * @param user The user to update.

  */

 void msn_user_update(MsnUser *user);

  /**

   *  Sets the new statusline of user.

   *

   *  @param user The user.

   *  @param state The statusline string.

   */

 void msn_user_set_statusline(MsnUser *user, const char *statusline);

  /**

   *  Sets the current media of user.

   *

   *  @param user   The user.

   *  @param cmedia Current media.

   */

 void msn_user_set_currentmedia(MsnUser *user, const CurrentMedia *cmedia);

 /**

  * Sets the new state of user.

  *

  * @param user The user.

  * @param state The state string.

  */

 void msn_user_set_state(MsnUser *user, const char *state);

 /**

  * Sets the passport account for a user.

  *

  * @param user     The user.

  * @param passport The passport account.

  */

 void msn_user_set_passport(MsnUser *user, const char *passport);

 /**

  * Sets the friendly name for a user.

  *

  * @param user The user.

  * @param name The friendly name.

  *

  * @returns TRUE is name actually changed, FALSE otherwise.

  */

 gboolean msn_user_set_friendly_name(MsnUser *user, const char *name);

 /**

  * Sets the buddy icon for a local user.

  *

  * @param user     The user.

  * @param img      The buddy icon image

  */

 void msn_user_set_buddy_icon(MsnUser *user, PurpleStoredImage *img);

 /**

  * Sets the group ID list for a user.

  *

  * @param user The user.

  * @param ids  The group ID list.

  */

 void msn_user_set_group_ids(MsnUser *user, GList *ids);

 /**

  * Adds the group ID for a user.

  *

  * @param user The user.

  * @param id   The group ID.

  */

 void msn_user_add_group_id(MsnUser *user, const char * id);

 /**

  * Removes the group ID from a user.

  *

  * @param user The user.

  * @param id   The group ID.

  */

 void msn_user_remove_group_id(MsnUser *user, const char * id);

 /**

  * Sets the pending group for a user.

  *

  * @param user  The user.

  * @param group The group name.

  */

 void msn_user_set_pending_group(MsnUser *user, const char *group);

 /**

  * Removes the pending group from a user.

  *

  * @param user The user.

  *

  * @return Returns the pending group name.

  */

 char *msn_user_remove_pending_group(MsnUser *user);

 /**

  * Sets the home phone number for a user.

  *

  * @param user   The user.

  * @param number The home phone number.

  */

 void msn_user_set_home_phone(MsnUser *user, const char *number);

 /**

  * Sets the work phone number for a user.

  *

  * @param user   The user.

  * @param number The work phone number.

  */

 void msn_user_set_work_phone(MsnUser *user, const char *number);

 void msn_user_set_uid(MsnUser *user, const char *uid);

 /**

  * Sets the client id for a user.

  *

  * @param user     The user.

  * @param clientid The client id.

  */

 void msn_user_set_clientid(MsnUser *user, guint clientid);

 /**

  * Sets the network id for a user.

  *

  * @param user    The user.

  * @param network The network id.

  */

 void msn_user_set_network(MsnUser *user, MsnNetwork network);

 /**

  * Sets the mobile phone number for a user.

  *

  * @param user   The user.

  * @param number The mobile phone number.

  */

 void msn_user_set_mobile_phone(MsnUser *user, const char *number);

 /**

  * Sets the MSNObject for a user.

  *

  * @param user The user.

  * @param obj  The MSNObject.

  */

 void msn_user_set_object(MsnUser *user, MsnObject *obj);

 /**

  * Sets the client information for a user.

  *

  * @param user The user.

  * @param info The client information.

  */

 void msn_user_set_client_caps(MsnUser *user, GHashTable *info);

 /**

  * Sets the invite message for a user.

  *

  * @param user    The user.

  * @param message The invite message for a user.

  */

 void msn_user_set_invite_message(MsnUser *user, const char *message);

 /**

  * Returns the passport account for a user.

  *

  * @param user The user.

  *

  * @return The passport account.

  */

 const char *msn_user_get_passport(const MsnUser *user);

 /**

  * Returns the friendly name for a user.

  *

  * @param user The user.

  *

  * @return The friendly name.

  */

 const char *msn_user_get_friendly_name(const MsnUser *user);

 /**

  * Returns the home phone number for a user.

  *

  * @param user The user.

  *

  * @return The user's home phone number.

  */

 const char *msn_user_get_home_phone(const MsnUser *user);

 /**

  * Returns the work phone number for a user.

  *

  * @param user The user.

  *

  * @return The user's work phone number.

  */

 const char *msn_user_get_work_phone(const MsnUser *user);

 /**

  * Returns the mobile phone number for a user.

  *

  * @param user The user.

  *

  * @return The user's mobile phone number.

  */

 const char *msn_user_get_mobile_phone(const MsnUser *user);

 /**

  * Returns the client id for a user.

  *

  * @param user    The user.

  *

  * @return The user's client id.

  */

 guint msn_user_get_clientid(const MsnUser *user);

 /**

  * Returns the network id for a user.

  *

  * @param user    The user.

  *

  * @return The user's network id.

  */

 MsnNetwork msn_user_get_network(const MsnUser *user);

 /**

  * Returns the MSNObject for a user.

  *

  * @param user The user.

  *

  * @return The MSNObject.

  */

 MsnObject *msn_user_get_object(const MsnUser *user);

 /**

  * Returns the client information for a user.

  *

  * @param user The user.

  *

  * @return The client information.

  */

 GHashTable *msn_user_get_client_caps(const MsnUser *user);

 /**

  * Returns the invite message for a user.

  *

  * @param user The user.

  *

  * @return The user's invite message.

  */

 const char *msn_user_get_invite_message(const MsnUser *user);

 /**

  * check to see if user is online

  */

 gboolean

 msn_user_is_online(PurpleAccount *account, const char *name);

 /**

  * check to see if user is Yahoo User

  */

 gboolean

 msn_user_is_yahoo(PurpleAccount *account ,const char *name);

 void msn_user_set_op(MsnUser *user, int list_op);

 void msn_user_unset_op(MsnUser *user, int list_op);

 /*@}*/

 #endif /* _MSN_USER_H_ */