系统消息接口；主要包括查询系统消息、删除系统消息等功能 More...

#include <nim_cpp_sysmsg.h>

Public Types
typedef std::function< void(const SysMessage &)>	ReceiveSysmsgCallback

typedef std::function< void(const SendMessageArc &)>	SendCustomSysmsgCallback

typedef std::function< void(int count, int unread_count, const std::list< SysMessage > &result)>	QueryMsgCallback

typedef std::function< void(nim::NIMResCode res_code, int unread_count)>	NotifySysmsgResCallback

typedef NotifySysmsgResCallback	QuerySysmsgUnreadCallback

typedef NotifySysmsgResCallback	ReadAllCallback

typedef NotifySysmsgResCallback	DeleteAllCallback

typedef NotifySysmsgResCallback	BatchSetCallback

typedef std::function< void(nim::NIMResCode res_code, int64_t msg_id, int unread_count)>	NotifySingleSysmsgCallback

typedef NotifySingleSysmsgCallback	SetStatusCallback

typedef NotifySingleSysmsgCallback	DeleteCallback

Static Public Member Functions
static void	RegSysmsgCb (const ReceiveSysmsgCallback &cb, const std::string &json_extension="")

static void	RegSendCustomSysmsgCb (const SendCustomSysmsgCallback &cb, const std::string &json_extension="")

static void	SendCustomNotificationMsg (const std::string &json_msg)

static std::string	CreateCustomNotificationMsg (const std::string &receiver_id, const NIMSysMsgType type, const std::string &client_msg_id, const std::string &content, const SysMessageSetting &msg_setting, int64_t timetag=0)

static bool	QueryMsgAsync (int limit_count, int64_t last_time, const QueryMsgCallback &cb, const std::string &json_extension="")

static void	QueryUnreadCount (const QuerySysmsgUnreadCallback &cb, const std::string &json_extension="")

static bool	SetStatusAsync (int64_t msg_id, nim::NIMSysMsgStatus status, const SetStatusCallback &cb, const std::string &json_extension="")

static void	ReadAllAsync (const ReadAllCallback &cb, const std::string &json_extension="")

static bool	DeleteAsync (int64_t msg_id, const DeleteCallback &cb, const std::string &json_extension="")

static void	DeleteAllAsync (const DeleteAllCallback &cb, const std::string &json_extension="")

static void	SetStatusByTypeAsync (NIMSysMsgType type, NIMSysMsgStatus status, const BatchSetCallback &cb, const std::string &json_extension="")

static void	DeleteByTypeAsync (NIMSysMsgType type, const BatchSetCallback &cb, const std::string &json_extension="")

static void	UnregSysmsgCb ()

Detailed Description

系统消息接口；主要包括查询系统消息、删除系统消息等功能

Member Typedef Documentation

◆ BatchSetCallback

typedef NotifySysmsgResCallback nim::SystemMsg::BatchSetCallback

批量调整系统消息自定义通知回调模板

◆ DeleteAllCallback

typedef NotifySysmsgResCallback nim::SystemMsg::DeleteAllCallback

删除全部系统消息自定义通知回调模板

◆ DeleteCallback

typedef NotifySingleSysmsgCallback nim::SystemMsg::DeleteCallback

删除系统消息自定义通知回调模板

◆ NotifySingleSysmsgCallback

typedef std::function<void(nim::NIMResCode res_code, int64_t msg_id, int unread_count)> nim::SystemMsg::NotifySingleSysmsgCallback

修改（单条）系统消息自定义通知回调模板

◆ NotifySysmsgResCallback

typedef std::function<void(nim::NIMResCode res_code, int unread_count)> nim::SystemMsg::NotifySysmsgResCallback

修改系统消息自定义通知回调模板

◆ QueryMsgCallback

typedef std::function<void(int count, int unread_count, const std::list<SysMessage>& result)> nim::SystemMsg::QueryMsgCallback

查询系统消息自定义通知回调模板

◆ QuerySysmsgUnreadCallback

typedef NotifySysmsgResCallback nim::SystemMsg::QuerySysmsgUnreadCallback

查询系统消息自定义通知未读数回调模板

◆ ReadAllCallback

typedef NotifySysmsgResCallback nim::SystemMsg::ReadAllCallback

设置系统消息自定义通知已读状态回调模板

◆ ReceiveSysmsgCallback

typedef std::function<void(const SysMessage&)> nim::SystemMsg::ReceiveSysmsgCallback

收到自定义通知回执回调模板

◆ SendCustomSysmsgCallback

typedef std::function<void(const SendMessageArc&)> nim::SystemMsg::SendCustomSysmsgCallback

发送自定义通知回调模板

◆ SetStatusCallback

typedef NotifySingleSysmsgCallback nim::SystemMsg::SetStatusCallback

设置系统消息自定义通知状态回调模板

Member Function Documentation

◆ CreateCustomNotificationMsg()

std::string nim::SystemMsg::CreateCustomNotificationMsg	(	const std::string &	receiver_id,
		const NIMSysMsgType	type,
		const std::string &	client_msg_id,
		const std::string &	content,
		const SysMessageSetting &	msg_setting,
		int64_t	timetag = `0`
	)

static

生成自定义通知消息

Parameters

[in]	receiver_id	接收者id
[in]	type	通知类型
[in]	client_msg_id	本地消息id
[in]	content	通知内容
[in]	msg_setting	通知属性
[in]	timetag	消息时间

Returns: std::string 生成自定义通知消息Json字符串

◆ DeleteAllAsync()

static void nim::SystemMsg::DeleteAllAsync	(	const DeleteAllCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

全部删除

Parameters

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	删除消息的回调函数

Returns: void 无返回值

Note: 错误码 200:成功 0:失败

◆ DeleteAsync()

static bool nim::SystemMsg::DeleteAsync	(	int64_t	msg_id,
		const DeleteCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

删除消息

Parameters

[in]	msg_id	消息id
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	删除消息的回调函数

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

Note: 错误码 200:成功 0:失败

◆ DeleteByTypeAsync()

static void nim::SystemMsg::DeleteByTypeAsync	(	NIMSysMsgType	type,
		const BatchSetCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

按类型删除系统通知

Parameters

[in]	type	类型
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	回调函数

Returns: void 无返回值

Note: 错误码 200:成功 0:失败

◆ QueryMsgAsync()

static bool nim::SystemMsg::QueryMsgAsync	(	int	limit_count,
		int64_t	last_time,
		const QueryMsgCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

查询本地系统消息

Parameters

[in]	limit_count	一次查询数量，建议20
[in]	last_time	上次查询最后一条消息的时间戳
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	查询本地系统消息的回调函数

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

◆ QueryUnreadCount()

static void nim::SystemMsg::QueryUnreadCount	(	const QuerySysmsgUnreadCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

查询未读消息数

Parameters

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	查询未读消息数的回调函数

Returns: void 无返回值

Note: 错误码 200:成功

◆ ReadAllAsync()

static void nim::SystemMsg::ReadAllAsync	(	const ReadAllCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

设置全部消息为已读

Parameters

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	设置全部消息为已读的回调函数

Returns: void 无返回值

Note: 错误码 200:成功 0:失败

◆ RegSendCustomSysmsgCb()

static void nim::SystemMsg::RegSendCustomSysmsgCb	(	const SendCustomSysmsgCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

(全局回调)注册发送透传消息回调函数（必须全局注册，统一接受回调后分发消息到具体的会话。注意：客户端发包之后，服务器不一定会返回！！！）

Parameters

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	发送透传消息的回调函数

Returns: void 无返回值

Note: 错误码 200:成功

◆ RegSysmsgCb()

static void nim::SystemMsg::RegSysmsgCb	(	const ReceiveSysmsgCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

(全局回调)注册接收系统通知回调接口

Parameters

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

Returns: void 无返回值

Note: 错误码 200:成功

◆ SendCustomNotificationMsg()

static void nim::SystemMsg::SendCustomNotificationMsg ( const std::string & json_msg )

static

发送自定义通知消息

Parameters

[in] json_msg 消息体Json, 可以通过CreateCustomNotificationMsg方法自动创建

Returns: void 无返回值

◆ SetStatusAsync()

static bool nim::SystemMsg::SetStatusAsync	(	int64_t	msg_id,
		nim::NIMSysMsgStatus	status,
		const SetStatusCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

设置消息状态

Parameters

[in]	msg_id	消息id
[in]	status	消息状态
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	设置消息状态的回调函数

Returns: void 无返回值

Note: 错误码 200:成功 0:失败

◆ SetStatusByTypeAsync()

static void nim::SystemMsg::SetStatusByTypeAsync	(	NIMSysMsgType	type,
		NIMSysMsgStatus	status,
		const BatchSetCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

按类型设置系统通知状态

Parameters

[in]	type	类型
[in]	status	状态
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	回调函数

Returns: void 无返回值

Note: 错误码 200:成功 0:失败

◆ UnregSysmsgCb()

void nim::SystemMsg::UnregSysmsgCb ( )

static

反注册SysMsg提供的所有回调

Returns: void 无返回值

The documentation for this class was generated from the following file:

nim_cpp_sysmsg.h

Public Types

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ BatchSetCallback

◆ DeleteAllCallback

◆ DeleteCallback

◆ NotifySingleSysmsgCallback

◆ NotifySysmsgResCallback

◆ QueryMsgCallback

◆ QuerySysmsgUnreadCallback

◆ ReadAllCallback

◆ ReceiveSysmsgCallback

◆ SendCustomSysmsgCallback

◆ SetStatusCallback

Member Function Documentation

◆ CreateCustomNotificationMsg()

◆ DeleteAllAsync()

◆ DeleteAsync()

◆ DeleteByTypeAsync()

◆ QueryMsgAsync()

◆ QueryUnreadCount()

◆ ReadAllAsync()

◆ RegSendCustomSysmsgCb()

◆ RegSysmsgCb()

◆ SendCustomNotificationMsg()

◆ SetStatusAsync()

◆ SetStatusByTypeAsync()

◆ UnregSysmsgCb()