NIM PC Cross Platform SDK
载入中...
搜索中...
未找到
函数
nim_sysmsg.h 文件参考

系统（自定义）消息 接口头文件 更多...

#include "nim_sysmsg_def.h"

浏览源代码.

函数

NIM_SDK_DLL_API void nim_sysmsg_reg_sysmsg_cb (const char *json_extension, nim_sysmsg_receive_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_sysmsg_send_custom_notification (const char *json_msg, const char *json_extension)
 
NIM_SDK_DLL_API void nim_sysmsg_reg_custom_notification_ack_cb (const char *json_extension, nim_custom_sysmsg_ack_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_sysmsg_query_msg_async (int limit_count, int64_t last_time, const char *json_extension, nim_sysmsg_query_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_sysmsg_query_unread_count (const char *json_extension, nim_sysmsg_res_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_sysmsg_set_status_async (int64_t msg_id, enum NIMSysMsgStatus status, const char *json_extension, nim_sysmsg_res_ex_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_sysmsg_read_all_async (const char *json_extension, nim_sysmsg_res_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_sysmsg_delete_async (int64_t msg_id, const char *json_extension, nim_sysmsg_res_ex_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_sysmsg_delete_all_async (const char *json_extension, nim_sysmsg_res_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_sysmsg_set_logs_status_by_type_async (enum NIMSysMsgType type, enum NIMSysMsgStatus status, const char *json_extension, nim_sysmsg_res_cb_func cb, const void *user_data)
 
NIM_SDK_DLL_API void nim_sysmsg_delete_logs_by_type_async (enum NIMSysMsgType type, const char *json_extension, nim_sysmsg_res_cb_func cb, const void *user_data)
 

详细描述

系统（自定义）消息 接口头文件

版权所有
(c) 2015-2017, NetEase Inc. All rights reserved
作者
Oleg
日期
2015/2/1

函数说明

◆ nim_sysmsg_delete_all_async()

void nim_sysmsg_delete_all_async ( const char *  json_extension,
nim_sysmsg_res_cb_func  cb,
const void *  user_data 
)

全部删除

参数
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb删除消息的回调函数， nim_sysmsg_res_cb_func回调函数定义见nim_msglog_def.h
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
返回
void 无返回值
注解
错误码 200:成功 0:失败

◆ nim_sysmsg_delete_async()

void nim_sysmsg_delete_async ( int64_t  msg_id,
const char *  json_extension,
nim_sysmsg_res_ex_cb_func  cb,
const void *  user_data 
)

删除消息

参数
[in]msg_id消息id
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb删除消息的回调函数， nim_sysmsg_res_ex_cb_func回调函数定义见nim_msglog_def.h
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
返回
void 无返回值
注解
错误码 200:成功 0:失败

◆ nim_sysmsg_delete_logs_by_type_async()

void nim_sysmsg_delete_logs_by_type_async ( enum NIMSysMsgType  type,
const char *  json_extension,
nim_sysmsg_res_cb_func  cb,
const void *  user_data 
)

按消息类型批量删除消息

参数
[in]type消息类型
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb回调函数， nim_sysmsg_res_cb_func回调函数定义见nim_msglog_def.h
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
返回
void 无返回值
注解
错误码 200:成功 0:失败

◆ nim_sysmsg_query_msg_async()

void nim_sysmsg_query_msg_async ( int  limit_count,
int64_t  last_time,
const char *  json_extension,
nim_sysmsg_query_cb_func  cb,
const void *  user_data 
)

查询本地系统消息（按时间逆序起查，逆序排列）

参数
[in]limit_count一次查询数量，建议20
[in]last_time上次查询最后一条消息的时间戳（按时间逆序起查，即最小的时间戳）
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb查询本地系统消息的回调函数， nim_sysmsg_query_cb_func回调函数定义见nim_msglog_def.h
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
返回
void 无返回值

◆ nim_sysmsg_query_unread_count()

void nim_sysmsg_query_unread_count ( const char *  json_extension,
nim_sysmsg_res_cb_func  cb,
const void *  user_data 
)

查询未读消息数

参数
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb查询未读消息数的回调函数， nim_sysmsg_res_cb_func回调函数定义见nim_msglog_def.h
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
返回
void 无返回值
注解
错误码 200:成功

◆ nim_sysmsg_read_all_async()

void nim_sysmsg_read_all_async ( const char *  json_extension,
nim_sysmsg_res_cb_func  cb,
const void *  user_data 
)

设置全部消息为已读

参数
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb设置全部消息为已读的回调函数， nim_sysmsg_res_cb_func回调函数定义见nim_msglog_def.h
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
返回
void 无返回值
注解
错误码 200:成功 0:失败

◆ nim_sysmsg_reg_custom_notification_ack_cb()

void nim_sysmsg_reg_custom_notification_ack_cb ( const char *  json_extension,
nim_custom_sysmsg_ack_cb_func  cb,
const void *  user_data 
)

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

参数
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb发送透传消息的回调函数, nim_custom_sysmsg_ack_cb_func回调函数定义见nim_sysmsg_def.h
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
返回
void 无返回值
注解
错误码 200:成功

◆ nim_sysmsg_reg_sysmsg_cb()

void nim_sysmsg_reg_sysmsg_cb ( const char *  json_extension,
nim_sysmsg_receive_cb_func  cb,
const void *  user_data 
)

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

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

◆ nim_sysmsg_send_custom_notification()

void nim_sysmsg_send_custom_notification ( const char *  json_msg,
const char *  json_extension 
)

发送自定义通知

参数
[in]json_msg消息体Json string (Keys SEE MORE nim_sysmsg_def.h 『系统消息结构 Json Keys』)
[in]json_extensionjson扩展参数（备用，目前不需要）
返回
void 无返回值

◆ nim_sysmsg_set_logs_status_by_type_async()

void nim_sysmsg_set_logs_status_by_type_async ( enum NIMSysMsgType  type,
enum NIMSysMsgStatus  status,
const char *  json_extension,
nim_sysmsg_res_cb_func  cb,
const void *  user_data 
)

按消息类型批量设置消息状态

参数
[in]type消息类型
[in]status消息状态,见NIMSysMsgStatus
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb回调函数， nim_sysmsg_res_cb_func回调函数定义见nim_msglog_def.h
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
返回
void 无返回值
注解
错误码 200:成功 0:失败

◆ nim_sysmsg_set_status_async()

void nim_sysmsg_set_status_async ( int64_t  msg_id,
enum NIMSysMsgStatus  status,
const char *  json_extension,
nim_sysmsg_res_ex_cb_func  cb,
const void *  user_data 
)

设置消息状态

参数
[in]msg_id消息id
[in]status消息状态
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb设置消息状态的回调函数， nim_sysmsg_res_ex_cb_func回调函数定义见nim_msglog_def.h
[in]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
返回
void 无返回值
注解
错误码 200:成功 0:失败