NIM SDK提供的用户相关接口更多...

#include <nim_cpp_user.h>

Public 类型
typedef std::function< void(const SpecialRelationshipChangeEvent &)>	SpecialRelationshipChangedCallback
	黑名单\静音列表变更事件通知回调模板

typedef std::function< void(NIMResCode res_code, const std::string &accid, bool set_opt)>	SetRelationCallback
	设置黑名单\静音列表回调模板

typedef SetRelationCallback	SetBlackCallback
	设置黑名单回调模板

typedef SetRelationCallback	SetMuteCallback
	设置静音列表回调模板

typedef std::function< void(NIMResCode res_code, const std::list< BlackMuteListInfo > &)>	GetMuteListCallback
	获取静音列表回调模板

typedef std::function< void(NIMResCode res_code, const std::list< BlackMuteListInfo > &)>	GetBlackListCallback
	设置黑名单列表回调模板

typedef std::function< void(const std::list< UserNameCard > &)>	UserNameCardChangedCallback
	用户名片变更通知回调模板

typedef std::function< void(const std::list< UserNameCard > &)>	GetUserNameCardCallback
	获取用户名片回调模板

typedef std::function< void(NIMResCode res_code)>	UpdateMyUserNameCardCallback
	更新自己的名片回调模板

静态 Public 成员函数
static void	RegSpecialRelationshipChangedCb (const SpecialRelationshipChangedCallback &cb, const std::string &json_extension="")

static bool	SetBlack (const std::string &accid, bool set_black, const SetBlackCallback &cb, const std::string &json_extension="")

static bool	SetMute (const std::string &accid, bool set_mute, const SetMuteCallback &cb, const std::string &json_extension="")

static void	GetMutelist (const GetMuteListCallback &cb, const std::string &json_extension="")

static void	GetBlacklist (const GetBlackListCallback &cb, const std::string &json_extension="")

static void	RegUserNameCardChangedCb (const UserNameCardChangedCallback &cb, const std::string &json_extension="")

static bool	GetUserNameCard (const std::list< std::string > &accids, const GetUserNameCardCallback &cb, const std::string &json_extension="")

static bool	GetUserNameCardOnline (const std::list< std::string > &accids, const GetUserNameCardCallback &cb, const std::string &json_extension="")

static bool	UpdateMyUserNameCard (const UserNameCard &namecard, const UpdateMyUserNameCardCallback &cb, const std::string &json_extension="")

static bool	QueryUserListByKeyword (const std::string &keyword, const GetUserNameCardCallback &cb, const std::string &json_extension="")

static bool	ParseBlackListInfoChange (const SpecialRelationshipChangeEvent &change_event, BlackMuteListInfo &info)

static bool	ParseMuteListInfoChange (const SpecialRelationshipChangeEvent &change_event, BlackMuteListInfo &info)

static bool	ParseSyncSpecialRelationshipChange (const SpecialRelationshipChangeEvent &change_event, std::list< BlackMuteListInfo > &black_mute_list)

static void	UpdatePushToken (const std::string &cer_name, const std::string &token, int type)

static void	UnregUserCb ()

详细描述

NIM SDK提供的用户相关接口

版权所有: (c) 2015-2017, NetEase Inc. All rights reserved

日期: 2015/8/17

成员类型定义说明

◆ GetBlackListCallback

typedef std::function<void(NIMResCode res_code, const std::list<BlackMuteListInfo>&)> nim::User::GetBlackListCallback

设置黑名单列表回调模板

◆ GetMuteListCallback

typedef std::function<void(NIMResCode res_code, const std::list<BlackMuteListInfo>&)> nim::User::GetMuteListCallback

获取静音列表回调模板

◆ GetUserNameCardCallback

typedef std::function<void(const std::list<UserNameCard>&)> nim::User::GetUserNameCardCallback

获取用户名片回调模板

◆ SetBlackCallback

typedef SetRelationCallback nim::User::SetBlackCallback

设置黑名单回调模板

◆ SetMuteCallback

typedef SetRelationCallback nim::User::SetMuteCallback

设置静音列表回调模板

◆ SetRelationCallback

typedef std::function<void(NIMResCode res_code, const std::string& accid, bool set_opt)> nim::User::SetRelationCallback

设置黑名单\静音列表回调模板

◆ SpecialRelationshipChangedCallback

typedef std::function<void(const SpecialRelationshipChangeEvent&)> nim::User::SpecialRelationshipChangedCallback

黑名单\静音列表变更事件通知回调模板

◆ UpdateMyUserNameCardCallback

typedef std::function<void(NIMResCode res_code)> nim::User::UpdateMyUserNameCardCallback

更新自己的名片回调模板

◆ UserNameCardChangedCallback

typedef std::function<void(const std::list<UserNameCard>&)> nim::User::UserNameCardChangedCallback

用户名片变更通知回调模板

成员函数说明

◆ GetBlacklist()

static void nim::User::GetBlacklist	(	const GetBlackListCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

获得黑名单名单

参数

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb

返回: void 无返回值

◆ GetMutelist()

static void nim::User::GetMutelist	(	const GetMuteListCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

获得静音名单列表

参数

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb

返回: bool 检查参数如果不符合要求则返回失败

注解: 错误码 200:成功

◆ GetUserNameCard()

static bool nim::User::GetUserNameCard	(	const std::list< std::string > &	accids,
		const GetUserNameCardCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

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

参数

[in]	accids
[in]	cb	操作结果回调
[in]	json_extension	json扩展参数（备用，目前不需要）

返回: void 无返回值

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

◆ GetUserNameCardOnline()

static bool nim::User::GetUserNameCardOnline	(	const std::list< std::string > &	accids,
		const GetUserNameCardCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

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

参数

[in]	accids
[in]	cb	操作结果回调
[in]	json_extension	json扩展参数（备用，目前不需要）

返回: bool 检查参数如果不符合要求则返回失败

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

◆ ParseBlackListInfoChange()

static bool nim::User::ParseBlackListInfoChange	(	const SpecialRelationshipChangeEvent &	change_event,
		BlackMuteListInfo &	info
	)

static

解析黑名单变更通知

参数

[in]	change_event	特殊关系变更通知
[out]	info	解析结果

返回: bool 解析是否成功

◆ ParseMuteListInfoChange()

static bool nim::User::ParseMuteListInfoChange	(	const SpecialRelationshipChangeEvent &	change_event,
		BlackMuteListInfo &	info
	)

static

解析静音名单变更通知

参数

[in]	change_event	特殊关系变更通知
[out]	info	解析结果

返回: bool 解析是否成功

◆ ParseSyncSpecialRelationshipChange()

static bool nim::User::ParseSyncSpecialRelationshipChange	(	const SpecialRelationshipChangeEvent &	change_event,
		std::list< BlackMuteListInfo > &	black_mute_list
	)

static

解析多端同步特殊关系通知

参数

[in]	change_event	特殊关系变更通知
[out]	black_mute_list	黑名单/静音列表

返回: bool 解析是否成功

◆ QueryUserListByKeyword()

static bool nim::User::QueryUserListByKeyword	(	const std::string &	keyword,
		const GetUserNameCardCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

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

参数

[in]	keyword	要查询的关键字
[in]	cb	操作结果回调
[in]	json_extension	json扩展参数（备用，目前不需要）

返回: bool 检查参数如果不符合要求则返回失败

◆ RegSpecialRelationshipChangedCb()

static void nim::User::RegSpecialRelationshipChangedCb	(	const SpecialRelationshipChangedCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

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

参数

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb

返回: void 无返回值

◆ RegUserNameCardChangedCb()

static void nim::User::RegUserNameCardChangedCb	(	const UserNameCardChangedCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

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

参数

[in]	cb	操作结果回调
[in]	json_extension	json扩展参数（备用，目前不需要）

返回: void 无返回值

◆ SetBlack()

static bool nim::User::SetBlack	(	const std::string &	accid,
		bool	set_black,
		const SetBlackCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

设置、取消设置黑名单

参数

[in]	accid	好友id
[in]	set_black	取消或设置
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb

返回: bool 检查参数如果不符合要求则返回失败

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

◆ SetMute()

static bool nim::User::SetMute	(	const std::string &	accid,
		bool	set_mute,
		const SetMuteCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

设置、取消设置静音名单

参数

[in]	accid	好友id
[in]	set_mute	取消或设置
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb

返回: bool 检查参数如果不符合要求则返回失败

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

◆ UnregUserCb()

void nim::User::UnregUserCb ( )

static

反注册User提供的所有回调

返回: void 无返回值

◆ UpdateMyUserNameCard()

static bool nim::User::UpdateMyUserNameCard	(	const UserNameCard &	namecard,
		const UpdateMyUserNameCardCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

更新自己的用户名片

参数

[in]	namecard	用户名片内容
[in]	cb	操作结果回调
[in]	json_extension	json扩展参数目前可用于配置反垃圾相关参数，格式{"anti_spam_business_id":"{\"textbid\":\"xxxx\",\"picbid\":\"xxxx\"}"}

返回: bool 检查参数如果不符合要求则返回失败

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

◆ UpdatePushToken()

void nim::User::UpdatePushToken	(	const std::string &	cer_name,
		const std::string &	token,
		int	type
	)

static

该类的文档由以下文件生成:

D:/GitLab/builds/5sbaxrcd/0/nim-pc/california/nim-cross-platform-sdk/exports/wrapper/nim_cpp_wrapper/api/nim_cpp_user.h
D:/GitLab/builds/5sbaxrcd/0/nim-pc/california/nim-cross-platform-sdk/exports/wrapper/nim_cpp_wrapper/api/nim_cpp_user.cpp

Public 类型

静态 Public 成员函数

详细描述

成员类型定义说明

◆ GetBlackListCallback

◆ GetMuteListCallback

◆ GetUserNameCardCallback

◆ SetBlackCallback

◆ SetMuteCallback

◆ SetRelationCallback

◆ SpecialRelationshipChangedCallback

◆ UpdateMyUserNameCardCallback

◆ UserNameCardChangedCallback

成员函数说明

◆ GetBlacklist()

◆ GetMutelist()

◆ GetUserNameCard()

◆ GetUserNameCardOnline()

◆ ParseBlackListInfoChange()

◆ ParseMuteListInfoChange()

◆ ParseSyncSpecialRelationshipChange()

◆ QueryUserListByKeyword()

◆ RegSpecialRelationshipChangedCb()

◆ RegUserNameCardChangedCb()

◆ SetBlack()

◆ SetMute()

◆ UnregUserCb()

◆ UpdateMyUserNameCard()

◆ UpdatePushToken()