Mercurial > pidgin
view libpurple/protocols/msn/user.h @ 15808:b0d74443fa2a
Protection against missing SHA1C
author | Stu Tomlinson <stu@nosnilmot.com> |
---|---|
date | Sat, 17 Mar 2007 17:38:12 +0000 |
parents | 5fe8042783c1 |
children | 32c366eeeb99 |
line wrap: on
line source
/** * @file user.h User functions * * gaim * * Gaim 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _MSN_USER_H_ #define _MSN_USER_H_ typedef struct _MsnUser MsnUser; #include "session.h" #include "object.h" #include "userlist.h" /** * A user. */ struct _MsnUser { #if 0 MsnSession *session; /**< The MSN session. */ #endif MsnUserList *userlist; char *passport; /**< The passport account. */ char *store_name; /**< The name stored in the server. */ char *friendly_name; /**< The friendly name. */ const char *status; /**< The state 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. */ MsnObject *msnobj; /**< The user's MSN Object. */ GHashTable *clientcaps; /**< The client's capabilities. */ int list_op; }; /**************************************************************************/ /** @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 *store_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 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. */ void msn_user_set_friendly_name(MsnUser *user, const char *name); /** * Sets the store name for a user. * * @param user The user. * @param name The store name. */ void msn_user_set_store_name(MsnUser *user, const char *name); /** * Sets the buddy icon for a local user. * * @param user The user. * @param filename The path to the buddy icon. */ void msn_user_set_buddy_icon(MsnUser *user, const char *filename); /** * 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, int 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, int id); /** * 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); /** * 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); /** * 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 store name for a user. * * @param user The user. * * @return The store name. */ const char *msn_user_get_store_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 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); /*@}*/ #endif /* _MSN_USER_H_ */