nim_user.h 文件参考

用户数据 接口头文件 更多...

#include "nim_user_def.h"

浏览源代码.

函数
NIM_SDK_DLL_API void	nim_user_reg_special_relationship_changed_cb (const char *json_extension, nim_user_special_relationship_change_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_user_set_black (const char *accid, bool set_black, const char *json_extension, nim_user_opt_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_user_set_mute (const char *accid, bool set_mute, const char *json_extension, nim_user_opt_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_user_get_mute_blacklist (const char *json_extension, nim_user_sync_muteandblacklist_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_user_reg_user_name_card_changed_cb (const char *json_extension, nim_user_name_card_change_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_user_get_user_name_card (const char *accids, const char *json_extension, nim_user_get_user_name_card_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_user_get_user_name_card_online (const char *accids, const char *json_extension, nim_user_get_user_name_card_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_user_update_my_user_name_card (const char *info_json, const char *json_extension, nim_user_update_my_name_card_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_user_update_push_token (const char *cer_name, const char *token, int type)
NIM_SDK_DLL_API void	nim_user_query_by_keyword (const char *keyword, const char *json_extension, nim_user_get_user_name_card_cb_func cb, const void *user_data)

详细描述

用户数据 接口头文件

版权所有

(c) 2015-2017, NetEase Inc. All rights reserved

作者

Harrison

日期

2015/2/1

函数说明

nim_user_get_mute_blacklist()

void nim_user_get_mute_blacklist	(	const char *	json_extension,
		nim_user_sync_muteandblacklist_cb_func	cb,
		const void *	user_data
	)

获得黑名单/静音名单

参数

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果回调
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

返回

void 无返回值

注解

错误码 200:成功

nim_user_get_user_name_card()

void nim_user_get_user_name_card	(	const char *	accids,
		const char *	json_extension,
		nim_user_get_user_name_card_cb_func	cb,
		const void *	user_data
	)

获取本地的指定帐号的用户名片

参数

[in]	accids	例 ["litianyi01", "litianyi02", ...]
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果回调
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

返回

void 无返回值

注解

错误码 200:成功 414:参数错误 20000:还未初始化或初始化未正常完成 20001:还未登陆或登录未完成

nim_user_get_user_name_card_online()

void nim_user_get_user_name_card_online	(	const char *	accids,
		const char *	json_extension,
		nim_user_get_user_name_card_cb_func	cb,
		const void *	user_data
	)

在线查询指定帐号的用户名片

参数

[in]	accids	例 ["litianyi01", "litianyi02", ...]
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果回调
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

返回

void 无返回值

注解

错误码 200:成功 414:参数错误 419:超限 20000:还未初始化或初始化未正常完成 20001:还未登陆或登录未完成

nim_user_query_by_keyword()

void nim_user_query_by_keyword	(	const char *	keyword,
		const char *	json_extension,
		nim_user_get_user_name_card_cb_func	cb,
		const void *	user_data
	)

获取本地的指定帐号的用户名片

参数

[in]	keyword	要查询的关键字
[in]	query_type	查询条件，见：NIMUserQueryType
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果回调
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

返回

void 无返回值

nim_user_reg_special_relationship_changed_cb()

void nim_user_reg_special_relationship_changed_cb	(	const char *	json_extension,
		nim_user_special_relationship_change_cb_func	cb,
		const void *	user_data
	)

(全局回调)统一注册用户属性变更通知回调函数（本地、多端同步黑名单、静音名单变更）

参数

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果回调
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

返回

void 无返回值

nim_user_reg_user_name_card_changed_cb()

void nim_user_reg_user_name_card_changed_cb	(	const char *	json_extension,
		nim_user_name_card_change_cb_func	cb,
		const void *	user_data
	)

(全局回调)统一注册用户名片变更通知回调函数

参数

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果回调
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

返回

void 无返回值

nim_user_set_black()

void nim_user_set_black	(	const char *	accid,
		bool	set_black,
		const char *	json_extension,
		nim_user_opt_cb_func	cb,
		const void *	user_data
	)

设置、取消设置黑名单

参数

[in]	accid	好友id
[in]	set_black	取消或设置
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果回调
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

返回

void 无返回值

注解

错误码 200:成功 419:黑名单数量超过上限

nim_user_set_mute()

void nim_user_set_mute	(	const char *	accid,
		bool	set_mute,
		const char *	json_extension,
		nim_user_opt_cb_func	cb,
		const void *	user_data
	)

设置、取消设置静音名单

参数

[in]	accid	好友id
[in]	set_mute	取消或设置
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	操作结果回调
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

返回

void 无返回值

注解

错误码 200:成功 419:静音列表数量超过上限

nim_user_update_my_user_name_card()

void nim_user_update_my_user_name_card	(	const char *	info_json,
		const char *	json_extension,
		nim_user_update_my_name_card_cb_func	cb,
		const void *	user_data
	)

更新自己的用户名片

参数

[in]	info_json	用户信息json
[in]	json_extension	json扩展参数 目前可用于配置反垃圾相关参数，格式{"anti_spam_business_id":"{\"textbid\":\"xxxx\",\"picbid\":\"xxxx\"}"}
[in]	cb	操作结果回调
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

返回

void 无返回值

注解

错误码 200:成功 400:非法参数

nim_user_update_push_token()

void nim_user_update_push_token	(	const char *	cer_name,
		const char *	token,
		int	type
	)

更新推送证书和Token (Andorid/iOS)

参数

[in]	cer_name	在云信管理后台配置的推送证书名
[in]	token	推送Token
[in]	type	1表示pushkit,0表示apns

返回

void 无返回值