NIM PC Cross Platform SDK
Functions
nim_friend.h File Reference

好友 接口头文件 More...

#include "nim_friend_def.h"
#include "public_defines.h"

Go to the source code of this file.

Functions

NIM_SDK_DLL_API void nim_friend_reg_changed_cb (const char *json_extension, nim_friend_change_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_friend_request (const char *accid, enum NIMVerifyType verify_type, const char *msg, const char *json_extension, nim_friend_opt_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_friend_delete (const char *accid, const char *json_extension, nim_friend_opt_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_friend_update (const char *friend_json, const char *json_extension, nim_friend_opt_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_friend_get_list (const char *json_extension, nim_friend_get_list_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_friend_get_profile (const char *accid, const char *json_extension, nim_friend_get_profile_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API bool nim_friend_query_friendship_block (const char *accid, const char *json_extension)
 
NIM_SDK_DLL_API void nim_friend_query_by_keyword (const char *keyword, const char *json_extension, nim_friend_get_list_cb_func cb, const void *user_data)
 

Detailed Description

好友 接口头文件

Copyright
(c) 2015-2017, NetEase Inc. All rights reserved
Author
Oleg
Date
2015/08/13

Function Documentation

◆ nim_friend_delete()

void nim_friend_delete ( const char *  accid,
const char *  json_extension,
nim_friend_opt_cb_func  cb,
const void *  user_data 
)

删除好友

Parameters
[in]accid对方帐号
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb操作结果回调
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
Returns
void 无返回值
Note
错误码 200:成功 404:用户不存在 500:未知错误

◆ nim_friend_get_list()

void nim_friend_get_list ( const char *  json_extension,
nim_friend_get_list_cb_func  cb,
const void *  user_data 
)

获取缓存好友列表

Parameters
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb操作结果回调
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
Returns
void 无返回值
Note
错误码 200:成功

◆ nim_friend_get_profile()

void nim_friend_get_profile ( const char *  accid,
const char *  json_extension,
nim_friend_get_profile_cb_func  cb,
const void *  user_data 
)

获取缓存好友信息

Parameters
[in]accid对方帐号
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb操作结果回调
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
Returns
void 无返回值

◆ nim_friend_query_by_keyword()

bool nim_friend_query_by_keyword ( const char *  keyword,
const char *  json_extension,
nim_friend_get_list_cb_func  cb,
const void *  user_data 
)

根据指定条件查询好友信息

Parameters
[in]keyword要查询的关键字
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb操作结果回调
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
Returns
void 无返回值

◆ nim_friend_query_friendship_block()

bool nim_friend_query_friendship_block ( const char *  accid,
const char *  json_extension 
)

在本地缓存数据中查询accid是否为自己的好友(同步接口，堵塞NIM内部线程，谨慎使用)

Parameters
[in]accid对方帐号
[in]json_extensionjson扩展参数（备用，目前不需要）
Returns
bool 当正向和反向好友关系都为好友时返回true

◆ nim_friend_reg_changed_cb()

void nim_friend_reg_changed_cb ( const char *  json_extension,
nim_friend_change_cb_func  cb,
const void *  user_data 
)

(全局回调)统一注册好友变更通知回调函数（多端同步添加、删除、更新，好友列表同步）

Parameters
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb好友变更通知回调函数, nim_friend_change_cb_func回调函数定义见nim_friend_def.h
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
Returns
void 无返回值
Note
错误码 200:成功 404:用户不存在 500:未知错误

◆ nim_friend_request()

void nim_friend_request ( const char *  accid,
enum NIMVerifyType  verify_type,
const char *  msg,
const char *  json_extension,
nim_friend_opt_cb_func  cb,
const void *  user_data 
)

添加、验证好友

Parameters
[in]accid对方帐号
[in]verify_type好友验证类型
[in]msg接口扩展字段
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb操作结果回调
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
Returns
void 无返回值
Note
错误码 200:成功 404:用户不存在 500:未知错误

◆ nim_friend_update()

void nim_friend_update ( const char *  friend_json,
const char *  json_extension,
nim_friend_opt_cb_func  cb,
const void *  user_data 
)

更新好友资料

Parameters
[in]friend_json好友资料json字符串
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb操作结果回调
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
Returns
void 无返回值
Note
错误码 200:成功 404:用户不存在 500:未知错误