libfetion.h

linux-下的fetion-0.8.1。包括所有源代码

 * \brief modify the group which account was belonged. 
 *
 * \param account The account which you want to move.
 * \param group_id The group is id.
 * \param func The operate's callback function's address, and the operate result will pass to this function.
 * \param args The operate's callback function's args. 
 *
 * \return 0 if fail immediately, or can get the result from func.
 */
FX_EXPORT int fx_move_group_buddy(const Fetion_Account *account, int group_id, EventListener func, void *args);

/**
  * \fn BOOL fx_is_on_line_by_id(long id)
  * \brief judge this id is OnLine or not
  *
  * \return TRUE if id is OnLine, otherwise return FALSE..
*/
FX_EXPORT BOOL fx_is_on_line_by_id(long id);

/**
  * \fn BOOL fx_is_on_line_by_account(const Fetion_Account *account)
  * \brief judge this account is OnLine or not
  *
  * \return TRUE if id is OnLine, otherwise return FALSE..
*/
FX_EXPORT BOOL fx_is_on_line_by_account(const Fetion_Account *account);

/**
  * \fn int fx_get_online_status_by_id(const long uid)
  * \brief return fetion uid 's online status.  
  *
  * \return -1 if the fetion uid is mobile user, or return the states of fetion .
*/
FX_EXPORT int fx_get_online_status_by_id(const long uid);

/**
  * \fn int fx_get_online_status_by_account(const Fetion_Account * account)
  * \brief return fetion account's online status.  
  *
  * \return -1 if the fetion uid is mobile user, or return the states of fetion .
  *
*/
FX_EXPORT int fx_get_online_status_by_account(const Fetion_Account * account);

/**
  * \fn int fx_get_refuse_sms_day(const Fetion_Account *account)
  * \brief return fetion account's refuse_sms_day.  
  *
  * \return the numbers of refuse_sms_day.  
  *
*/
FX_EXPORT int fx_get_refuse_sms_day(const Fetion_Account *account);

/**
  * \fn fx_updata_account_info_by_id(long id)
  * \brief updata the account info which uid 's the gived id
  *
  * \sa 
  *
  * \after invoke this function, if updata OK, you will receice a message of ..
*/
FX_EXPORT void fx_updata_account_info_by_id(long id);


/**
  * \fn fx_updata_account_info_all()
  * \brief updata all the account info
  *
  * \sa 
  *
  * \after invoke this function, if updata OK, you will receice a message of ..
*/
FX_EXPORT void fx_updata_account_info_all();


/**
  * \fn char *fx_get_account_show_name(const Fetion_Account *account, BOOL needImpresa)
  * \brief get the show name of the account
  *
  * note: this function maybe modify at late version....
  *
  * \param account The Fetion_Account which you want to get showname. 
  * \param needImpresa Is need the impresa in showname 
  *
  * \sa Fetion_Account
  *
  * \return the show name of account
*/
FX_EXPORT char *fx_get_account_show_name(const Fetion_Account *account, BOOL needImpresa);

/**
  * \fn char *fx_get_qun_show_name(Fetion_Qun *qun)
  * \brief get the show name of the qun 
  *
  * note: this function maybe modify at late version....
  *
  * \param qun The Fetion_Qun which you want to getinfo
  *
  * \sa Fetion_Qun
  *
  * \return the show name of qun
*/
FX_EXPORT char *fx_get_qun_show_name(Fetion_Qun *qun);

/**
  * \fn int fx_get_account_group_id(const Fetion_Account *account)
  * \brief get the group id of the account
  *
  * note: group_id is started by 0,
  *
  * \param account The Fetion_Account which you want to getinfo
  *
  * \sa Fetion_Account
  *
  * \return the id of account's group if successfully, otherwise return -1..
*/
FX_EXPORT int fx_get_account_group_id(const Fetion_Account *account);


/** @} end of get_contact_info */


/**
 * \addtogroup simple_fetion_group_opt 
 * @{
 */

/**
 * \fn BOOL fs_rename_buddylist(int id, const char* name)
 * \brief rename the group. 
 *
 * \param uid The group which you want to rename.
 * \param name The name which you want to set.
 *
 * \return TRUE if success, or will return FALSE.
 */
FX_EXPORT BOOL fs_rename_buddylist(int id, const char* name);

/**
 * \fn BOOL fs_delete_buddylist(int id)
 * \brief delete a group. 
 *
 * \param id The group which you want to delete.
 *
 * \return TRUE if success, or will return FALSE.
 */
FX_EXPORT BOOL fs_delete_buddylist(int id);

/** @} end of simple_fetion_group_opt */

/**
 * \addtogroup generic_fetion_group_opt  
 * @{
 */
/**
 * \fn int fx_rename_buddylist(int id, const char* name, EventListener func, void *args)
 * \brief rename the group. 
 *
 * \param uid The group which you want to rename.
 * \param name The name which you want to set.
 * \param func The send sms operate's callback function's address, and the operate result will pass to this function.
 * \param args The send_sms operate's callback function's args. 
 *
 * \return 0 if fail immediately, or can get the result from func.
 */
FX_EXPORT int fx_rename_buddylist(int id, const char* name, EventListener func, void *args);

/**
 * \fn int fx_add_buddylist(const char* name, EventListener func, void *args)
 * \brief rename the group. 
 *
 * \param name The group name which you want to add.
 * \param func The send sms operate's callback function's address, and the operate result will pass to this function.
 * \param args The send_sms operate's callback function's args. 
 *
 * \return 0 if fail immediately, or can get the result from func.
 */
FX_EXPORT int fx_add_buddylist(const char* name, EventListener func, void *args);

/**
 * \fn int fx_add_buddy_by_uid(const char* uid, const char* local_name, int groupid, const char* desc, EventListener func, void *args)
 * \brief add a account by fetion id. 
 *
 * \param uid The uid of account which you want to add.
 * \param loacl_name The name of account which you want to add.
 * \param groupid The groupid of account which you want to add.
 * \param desc The name of you send to the user see.
 * \param func The operate's callback function's address, and the operate result will pass to this function.
 * \param args The operate's callback function's args. 
 *
 * \return 0 if fail immediately, or can get the result from func.
 */
FX_EXPORT int fx_add_buddy_by_uid(const char* uid, const char* local_name, int groupid, const char* desc, EventListener func, void *args);


/**
 * \fn int fx_add_buddy_by_mobile(const char* mobile, const char* local_name, int groupid, const char* desc, EventListener func, void *args)
 * \brief add a account by mobile number. 
 *
 * \param uid The uid of account which you want to add.
 * \param loacl_name The name of account which you want to add.
 * \param groupid The groupid of account which you want to add.
 * \param desc The name of you send to the user see.
 * \param func The operate's callback function's address, and the operate result will pass to this function.
 * \param args The operate's callback function's args. 
 *
 * \return 0 if fail immediately, or can get the result from func.
 */
FX_EXPORT int fx_add_buddy_by_mobile(const char* mobile, const char* local_name, int groupid, const char* desc, EventListener func, void *args);


/**
 * \fn int fx_handleContactRequest(const char *uri, int isPassed, int group, const char* local_name)
 *
 * \brief handle a request of addaccount. 
 *
 * \param uri The uri of account which want to add with you.
 * \param isPassed  
 * \param group The groupid of account which you want to add.
 * \param local_name The name of you send to the user see.
 * \return 0 if fail immediately.
 */
FX_EXPORT int fx_handleContactRequest(const char *uri, int isPassed, int group, const char* local_name);

/**
 * \fn int fx_delete_buddylist(int id, EventListener func, void *args)
 * \brief delete a  group. 
 *
 * \param id The group id which you want to delete.
 * \param func The send sms operate's callback function's address, and the operate result will pass to this function.
 * \param args The send_sms operate's callback function's args. 
 *
 * \return 0 if fail immediately, or can get the result from func.
 */
FX_EXPORT int fx_delete_buddylist(int id, EventListener func, void *args);


/** @} end of generic_fetion_group_opt */

/**
* \addtogroup simple_fetion_buddy_opt  
* @{
*/

/**
  * \fn BOOL fs_set_buddyinfo(long uid, const char* localname)
  * \brief set the local name of the account. 
  *
  * \param uid The account which you want to set.
  * \param localname The local name which you want to set.
  * \return TRUE if success, or will return FALSE.
*/
FX_EXPORT BOOL fs_set_buddyinfo(long uid, const char* localname);


/** @} end of simple_fetion_buddy_opt */

/**
* \addtogroup generic_fetion_buddy_opt  
* @{
*/

/**
  * \fn int fx_set_buddyinfo(long uid, const char* localname, EventListener func, void *args)
  * \brief set the local name of the account. 
  *
  * \param uid The account which you want to set.
  * \param localname The local name which you want to set.
  * \param func The send sms operate's callback function's address, and the operate result will pass to this function.
  * \param args The send_sms operate's callback function's args. 
  *
  * \return 0 if set buddyinfo fail immediately, or can get the result from func.
*/
FX_EXPORT int fx_set_buddyinfo(long uid, const char* localname, EventListener func, void *args);

/**
  * \fn int fx_delete_buddy_by_id(long uid, EventListener func, void *args)
  * \brief delete the account. 
  *
  * \param uid The account which you want to delete.
  * \param func The send sms operate's callback function's address, and the operate result will pass to this function.
  * \param args The send_sms operate's callback function's args. 
  *
  * \return 0 if fail immediately, or can get the result from func.
*/
FX_EXPORT int fx_delete_buddy_by_id(long uid, EventListener func, void *args);

/**
  * \fn int fx_delete_buddy_by_account(Fetion_Account *account, EventListener func, void *args)
  * \brief delete the account. 
  *
  * \param account The account which you want to delete.
  * \param func The send sms operate's callback function's address, and the operate result will pass to this function.
  * \param args The send_sms operate's callback function's args. 
  *
  * \return 0 if fail immediately, or can get the result from func.
*/
FX_EXPORT int fx_delete_buddy_by_account(Fetion_Account *account, EventListener func, void *args);

/**
  * \fn int fx_addto_blacklist_by_id(const long uid, EventListener func, void *args)
  * \brief add the user to blacklist 
  *
  * \param uid The id which you want to add to blacklist.
  * \param func The send sms operate's callback function's address, and the operate result will pass to this function.
  * \param args The send_sms operate's callback function's args. 
  *
  * \return 0 if fail immediately, or can get the result from func.
*/
FX_EXPORT int fx_addto_blacklist_by_id(const long uid, EventListener func, void *args);

/**
  * \fn int fx_addto_blacklist_by_account(Fetion_Account *account, EventListener func, void *args)
  * \brief add the uri user to blacklist 
  *
  * \param account The account which you want to add to blacklist.
  * \param func The send sms operate's callback function's address, and the operate result will pass to this function.
  * \param args The send_sms operate's callback function's args. 
  *
  * \return 0 if fail immediately, or can get the result from func.
*/
FX_EXPORT int fx_addto_blacklist_by_account(Fetion_Account *account, EventListener func, void *args);

/**
  * \fn int fx_addto_blacklist_by_uri(const char* uri, EventListener func, void *args)
  * \brief add the uri user to blacklist 
  *
  * \param uri The account's uri which you want to add to blacklist.
  * \param func The send sms operate's callback function's address, and the operate result will pass to this function.
  * \param args The send_sms operate's callback function's args. 
  *
  * \return 0 if fail immediately, or can get the result from func.
*/
FX_EXPORT int fx_addto_blacklist_by_uri(const char* uri, EventListener func, void *args);


/**
  * \fn int fx_removefrom_blacklist_by_id(const long uid, EventListener func, void *args)
  * \brief remove the uri user frome blacklist 
  *
  * \param uid The id of account which you want to remove.
  *
  * \return 0 if fail immediately, or can get the result from func.
*/
FX_EXPORT int fx_removefrom_blacklist_by_id(const long uid, EventListener func, void *args);
/**
  * \fn int fx_removefrom_blacklist_by_account(Fetion_Account *account, EventListener func, void *args)
  * \brief remove the uri user frome blacklist 
  *
  * \param account The account which you want to remove.
  *
  * \return 0 if fail immediately, or can get the result from func.
*/
FX_EXPORT int fx_removefrom_blacklist_by_account(Fetion_Account *account, EventListener func, void *args);
/**
  * \fn int fx_removefrom_blacklist_by_uri(const char* uri, EventListener func, void *args)
  * \brief remove the uri user frome blacklist 
  *
  * \param uri The uri of account which you want to remove.
  *
  * \return 0 if fail immediately, or can get the result from func.
*/
FX_EXPORT int fx_removefrom_blacklist_by_uri(const char* uri, EventListener func, void *args);

/** @} end of generic_fetion_buddy_opt */

/**
* \addtogroup fetion_ext  
* @{
*/

/**
  * \fn BOOL fx_send_nudge(long who)
  * \brief send a nudge 
  *
  * 
  * this function should send by 5 minute pre time . or it will return FALSE, and the receicer must be online.
  *
  * \param who which one you want to send.
  *
  * \return TRUE when success, FALSE when send fail .
*/
FX_EXPORT BOOL fx_send_nudge(long who);

/**
  * \fn BOOL fx_set_serve_address(const char *serve_address)
  * \brief set the fetion proxy ip and port, the proxy format is  ip:port(192.168.0.1:8080). 
  *
  *
  * This function should used before invoke login function
  *
  * \param proxy The fetion proxy string.
  *
  * \return TRUE when set success, FALSE when set fail of the proxy format is wrong.
*/
FX_EXPORT BOOL fx_set_serve_address(const char *serve_address);

/**
  * \fn void fx_set_unknow_serve_address(void)
  * \brief let the fetion get the serve_address ip and port by it self. 
  *
  *
  * This function tell libfetion to get serve_address ip and port by it self. 
  * ****this function will be removed in later version****.
  *
  *
*/
FX_EXPORT void fx_set_unknow_serve_address(void);

/**
  * \fn char* fx_get_serve_address(void)
  * \brief get the current fetion id 's proxy sever ip. the ip format is  ip:port(192.168.0.1:8080).
  *
  * This function can use just after login success. 
  *
  * \return the the current fetion id 's proxy sever ip, if no will return NULL.
*/
FX_EXPORT char* fx_get_serve_address(void);

/**
 * \fn BOOL fx_set_proxy(PROXY_ITEM *item)
 * \brief Set the proxy when you use proxy to connnect the network.
 *
 * \param item The proxy information.
 * \return TRUE on success, FALSE on error.
 *
 * \sa fetion_get_proxy
 */
FX_EXPORT BOOL fx_set_proxy(PROXY_ITEM *item);

/**
 * \fn const PROXY_ITEM * fx_get_proxy()
 * \brief Get the proxy information.
 *
 * \return no NULL if have proxy info, or return NULL.
 *
 * \sa fetion_set_proxy
 */
FX_EXPORT const PROXY_ITEM * fx_get_proxy();

/**
 * \fn void fetion_setProxyEnabled(BOOL status)
 * \brief Set the proxy isEnabled.
 *
 * \param status Active proxy.
 *
 * \sa fetion_proxyEnabled
 */
FX_EXPORT void fx_setProxyEnabled(BOOL status);

/**
 * \fn BOOL fetion_proxyEnabled()
 * \brief Get the proxy isEnabled.
 *
 * \return TRUE on Enabled, or return FALSE .
 *
 * \sa fetion_set_proxy
 */
FX_EXPORT BOOL fx_proxyEnabled();


/**
 * \fn int fx_test_network(PROXY_ITEM *item, EventListener func, void *args)
 * \brief Get the fetion network is working of proxy_item.
 *
 * if item is NULL, will test direct connect to net is working.
 *
  * \return 0 if fail immediately, or can get the result from func.
 *
 * \sa fetion_set_proxy
 */
FX_EXPORT int fx_test_network(PROXY_ITEM *item, EventListener func, void *args);
/** @} end of fetion_ext */

/**
* \addtogroup fetion_misc  
* @{
*/

/**
  * \fn char* fx_simple_paser_msg(const char * msg)
  * \brief simple paser the msg, filter the <Font></Font> tags. 
  *
  * \param msg The original msg.
  *
  * \return the no format message, return NULL if the msg is wrong format.
*/
FX_EXPORT char* fx_simple_paser_msg(const char * msg);

/** @} end of fetion_misc */

#ifdef __cplusplus 
}
#endif

#endif