340 lines
24 KiB
C
340 lines
24 KiB
C
|
/** @file nim_msglog.h
|
|||
|
|
* @brief 消息历史 接口头文件
|
|||
|
|
* @copyright (c) 2015-2017, NetEase Inc. All rights reserved
|
|||
|
|
* @author Oleg
|
|||
|
|
* @date 2015/2/1
|
|||
|
|
*/
|
|||
|
|
#ifndef NIM_SDK_DLL_API_NIM_MSGLOG_H_
|
|||
|
|
#define NIM_SDK_DLL_API_NIM_MSGLOG_H_
|
|||
|
|
|
|||
|
|
#include "nim_sdk_dll.h"
|
|||
|
|
#include "../export_headers/nim_msglog_def.h"
|
|||
|
|
|
|||
|
|
#ifdef __cplusplus
|
|||
|
|
extern"C"
|
|||
|
|
{
|
|||
|
|
#endif
|
|||
|
|
/** @fn void nim_msglog_query_msg_by_id_async(const char *client_msg_id, const char *json_extension, nim_msglog_query_single_cb_func cb, const void *user_data)
|
|||
|
|
* 根据消息ID查询本地（单条）消息
|
|||
|
|
* @param[in] client_msg_id 客户端消息ID
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 查询本地消息的回调函数， nim_msglog_query_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 0:失败
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_query_msg_by_id_async(const char *client_msg_id, const char *json_extension, nim_msglog_query_single_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_query_msg_async(const char *account_id, enum NIMSessionType to_type, int limit_count, int64_t anchor_msg_time, const char *json_extension, nim_msglog_query_cb_func cb, const void *user_data)
|
|||
|
|
* 查询本地消息（默认为从定位点的消息历史时间开始向前查找）
|
|||
|
|
* @param[in] account_id 会话id，对方的account id或者群组tid
|
|||
|
|
* @param[in] to_type 会话类型
|
|||
|
|
* @param[in] limit_count 一次查询数量，建议20
|
|||
|
|
* @param[in] anchor_msg_time 作为此次查询的定位点的消息历史的消息时间戳（上次查询最后一条消息的时间戳，按指定的时间的顺序起查，默认为逆序，2.4.0之前命名为last_name）
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 查询本地消息的回调函数， nim_msglog_query_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_query_msg_async(const char *account_id, enum NIMSessionType to_type, int limit_count, int64_t anchor_msg_time, const char *json_extension, nim_msglog_query_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_query_msg_online_async(const char *id, enum NIMSessionType to_type, int limit_count, int64_t from_time, int64_t end_time, int64_t end_msg_id, bool reverse, bool need_save_to_local, const char *json_extension, nim_msglog_query_cb_func cb, const void *user_data)
|
|||
|
|
* 在线查询消息
|
|||
|
|
* @param[in] id 会话id，对方的account id或者群组tid
|
|||
|
|
* @param[in] to_type 会话类型
|
|||
|
|
* @param[in] limit_count 本次查询的消息条数上限(最多100条)
|
|||
|
|
* @param[in] from_time 起始时间点，单位：毫秒
|
|||
|
|
* @param[in] end_time 结束时间点，单位：毫秒
|
|||
|
|
* @param[in] end_msg_id 结束查询的最后一条消息的server_msg_id(不包含在查询结果中)
|
|||
|
|
* @param[in] reverse true：反向查询(按时间正序起查，正序排列)，false：按时间逆序起查，逆序排列（建议默认为false）
|
|||
|
|
* @param[in] need_save_to_local true: 将在线查询结果保存到本地，false: 不保存
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 在线查询消息的回调函数， nim_msglog_query_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 403:禁止访问(不在该群,只针对群组会话)
|
|||
|
|
* 414:参数错误
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_query_msg_online_async(const char *id,
|
|||
|
|
enum NIMSessionType to_type,
|
|||
|
|
int limit_count,
|
|||
|
|
int64_t from_time,
|
|||
|
|
int64_t end_time,
|
|||
|
|
int64_t end_msg_id,
|
|||
|
|
bool reverse,
|
|||
|
|
bool need_save_to_local,
|
|||
|
|
const char *json_extension,
|
|||
|
|
nim_msglog_query_cb_func cb,
|
|||
|
|
const void *user_data);
|
|||
|
|
#if NIMAPI_UNDER_WIN_DESKTOP_ONLY
|
|||
|
|
/** @fn void nim_msglog_query_the_message_of_the_specified_type_async(enum NIMSessionType to_type, const char *id, int limit_count, int64_t from_time, int64_t end_time, const char *end_client_msg_id, bool reverse, const char *msg_types, const char *json_extension, nim_msglog_query_cb_func cb, const void *user_data)
|
|||
|
|
* 根据指定条件在一个会话中查询指定单个或多个类型的本地消息
|
|||
|
|
* @param[in] to_type 会话类型
|
|||
|
|
* @param[in] id 会话id，对方的account id或者群组tid
|
|||
|
|
* @param[in] limit_count 本次查询的消息条数上限(默认100条)
|
|||
|
|
* @param[in] from_time 起始时间点，单位：毫秒
|
|||
|
|
* @param[in] end_time 结束时间点，单位：毫秒
|
|||
|
|
* @param[in] end_client_msg_id 结束查询的最后一条消息的client_msg_id(不包含在查询结果中)（暂不启用）
|
|||
|
|
* @param[in] reverse true：反向查询(按时间正序起查，正序排列)，false：按时间逆序起查，逆序排列（建议默认为false）
|
|||
|
|
* @param[in] msg_types 检索的消息类型,Json array
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 本地查询消息的回调函数， nim_msglog_query_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_query_the_message_of_the_specified_type_async(enum NIMSessionType to_type,
|
|||
|
|
const char *id,
|
|||
|
|
int limit_count,
|
|||
|
|
int64_t from_time,
|
|||
|
|
int64_t end_time,
|
|||
|
|
const char *end_client_msg_id,
|
|||
|
|
bool reverse,
|
|||
|
|
const char *msg_types,
|
|||
|
|
const char *json_extension,
|
|||
|
|
nim_msglog_query_cb_func cb,
|
|||
|
|
const void *user_data);
|
|||
|
|
#endif
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_query_msg_by_options_async(enum NIMMsgLogQueryRange query_range, const char *ids, int limit_count, int64_t from_time, int64_t end_time, const char *end_client_msg_id, bool reverse, enum NIMMessageType msg_type, const char *search_content, const char *json_extension, nim_msglog_query_cb_func cb, const void *user_data)
|
|||
|
|
* 根据指定条件查询本地消息,使用此接口可以完成全局搜索等功能,具体请参阅开发手册 http://dev.netease.im/docs/product/IM%E5%8D%B3%E6%97%B6%E9%80%9A%E8%AE%AF/SDK%E5%BC%80%E5%8F%91%E9%9B%86%E6%88%90/Windows%E5%BC%80%E5%8F%91%E9%9B%86%E6%88%90/%E5%8E%86%E5%8F%B2%E8%AE%B0%E5%BD%95
|
|||
|
|
* @param[in] query_range 消息历史的检索范围（目前暂不支持某些范围的组合检索，详见NIMMsgLogQueryRange说明）
|
|||
|
|
* @param[in] ids 会话id（对方的account id或者群组tid）的集合，格式为string array json（目前暂不支持多个的组合检索，详见NIMMsgLogQueryRange说明）
|
|||
|
|
* @param[in] limit_count 本次查询的消息条数上限(默认100条)
|
|||
|
|
* @param[in] from_time 起始时间点，单位：毫秒
|
|||
|
|
* @param[in] end_time 结束时间点，单位：毫秒
|
|||
|
|
* @param[in] end_client_msg_id 结束查询的最后一条消息的client_msg_id(不包含在查询结果中)（暂不启用）
|
|||
|
|
* @param[in] reverse true：反向查询(按时间正序起查，正序排列)，false：按时间逆序起查，逆序排列（建议默认为false）
|
|||
|
|
* @param[in] msg_type 检索的消息类型（目前只支持kNIMMessageTypeText、kNIMMessageTypeImage和kNIMMessageTypeFile这三种类型消息）
|
|||
|
|
* @param[in] search_content 检索文本（目前只支持kNIMMessageTypeText和kNIMMessageTypeFile这两种类型消息的文本关键字检索，即支持文字消息和文件名的检索。如果合并检索，需使用未知类型消息kNIMMessageTypeUnknown）
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 本地查询消息的回调函数， nim_msglog_query_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_query_msg_by_options_async(enum NIMMsgLogQueryRange query_range,
|
|||
|
|
const char *ids,
|
|||
|
|
int limit_count,
|
|||
|
|
int64_t from_time,
|
|||
|
|
int64_t end_time,
|
|||
|
|
const char *end_client_msg_id,
|
|||
|
|
bool reverse,
|
|||
|
|
enum NIMMessageType msg_type,
|
|||
|
|
const char *search_content,
|
|||
|
|
const char *json_extension,
|
|||
|
|
nim_msglog_query_cb_func cb,
|
|||
|
|
const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_batch_status_read_async(const char *account_id, enum NIMSessionType to_type, const char *json_extension, nim_msglog_res_ex_cb_func cb, const void *user_data)
|
|||
|
|
* 批量设置未读状态为已读消息状态
|
|||
|
|
* @param[in] account_id 会话id，对方的account id或者群组tid
|
|||
|
|
* @param[in] to_type 会话类型
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 操作结果的回调函数， nim_msglog_res_ex_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 0:失败
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_batch_status_read_async(const char *account_id, enum NIMSessionType to_type, const char *json_extension, nim_msglog_res_ex_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_set_status_async(const char *msg_id, enum NIMMsgLogStatus msglog_status, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data)
|
|||
|
|
* 设置消息状态
|
|||
|
|
* @param[in] msg_id 消息id
|
|||
|
|
* @param[in] msglog_status 消息状态枚举值
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 操作结果的回调函数， nim_msglog_res_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 0:失败
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_set_status_async(const char *msg_id, enum NIMMsgLogStatus msglog_status, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_set_sub_status_async(const char *msg_id, enum NIMMsgLogSubStatus msglog_sub_status, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data)
|
|||
|
|
* 设置消息子状态
|
|||
|
|
* @param[in] msg_id 消息id
|
|||
|
|
* @param[in] msglog_sub_status 消息子状态枚举值
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 操作结果的回调函数， nim_msglog_res_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 0:失败
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_set_sub_status_async(const char *msg_id, enum NIMMsgLogSubStatus msglog_sub_status, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_insert_msglog_async(const char *talk_id, const char *json_msg, bool need_update_session, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data)
|
|||
|
|
* 往本地消息历史数据库里写入一条消息（如果已存在这条消息，则更新。通常是APP的本地自定义消息，并不会发给服务器）
|
|||
|
|
* @param[in] talk_id 会话id，对方的account id或者群组tid
|
|||
|
|
* @param[in] json_msg 消息体Json string (Keys SEE MORE `nim_talk_def.h` 『消息结构 Json Keys』)
|
|||
|
|
* @param[in] need_update_session 是否更新会话列表（一般最新一条消息会有更新的需求）
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 操作结果的回调函数， nim_msglog_res_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 0:失败
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_insert_msglog_async(const char *talk_id, const char *json_msg, bool need_update_session, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_batch_status_delete_async(const char *account_id, enum NIMSessionType to_type, const char *json_extension, nim_msglog_res_ex_cb_func cb, const void *user_data)
|
|||
|
|
* 批量删除指定对话的消息。删除成功后，将相应会话项的最后一条消息的状态kNIMSessionMsgStatus设置为已删除状态，并通过nim_session_reg_change_cb注册的回调通知上层相应会话项的kNIMSessionCommandMsgDeleted事件。
|
|||
|
|
* @param[in] account_id 会话id，对方的account id或者群组tid
|
|||
|
|
* @param[in] to_type 会话类型
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 操作结果的回调函数， nim_msglog_res_ex_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 0:失败
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_batch_status_delete_async(const char *account_id, enum NIMSessionType to_type, const char *json_extension, nim_msglog_res_ex_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_delete_by_session_type_async(bool delete_sessions, enum NIMSessionType to_type, const char *json_extension, nim_msglog_res_ex_cb_func cb, const void *user_data)
|
|||
|
|
* 删除指定会话类型的所有消息
|
|||
|
|
* @param[in] delete_sessions 是否删除指定会话类型的所有会话列表项。
|
|||
|
|
* ture则删除，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSessionCommandRemoveAllP2P或kNIMSessionCommandRemoveAllTeam事件（不会触发每个会话项的kNIMSessionCommandRemove事件）；
|
|||
|
|
* false则不删除，并将指定会话类型的所有会话项的最后一条消息的状态kNIMSessionMsgStatus设置为已删除状态，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSessionCommandAllP2PMsgDeleted或kNIMSessionCommandAllTeamMsgDeleted事件（不会触发每个会话项的kNIMSessionCommandUpdate事件，避免频繁通知上层）。
|
|||
|
|
* @param[in] to_type 会话类型
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 操作结果的回调函数， nim_msglog_res_ex_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 0:失败
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_delete_by_session_type_async(bool delete_sessions, enum NIMSessionType to_type, const char *json_extension, nim_msglog_res_ex_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_delete_async(const char *account_id, enum NIMSessionType to_type, const char *msg_id, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data)
|
|||
|
|
* 删除指定一条消息
|
|||
|
|
* @param[in] account_id 会话id，对方的account id或者群组tid
|
|||
|
|
* @param[in] to_type 会话类型
|
|||
|
|
* @param[in] msg_id 消息id
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 操作结果的回调函数， nim_msglog_res_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 0:失败
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_delete_async(const char *account_id, enum NIMSessionType to_type, const char *msg_id, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_delete_all_async(bool delete_sessions, const char *json_extension, nim_msglog_modify_res_cb_func cb, const void *user_data)
|
|||
|
|
* 删除全部消息历史
|
|||
|
|
* @param[in] delete_sessions 是否删除所有会话列表项（即全部最近联系人）。
|
|||
|
|
* ture则删除，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSessionCommandRemoveAll事件（不会触发每个会话项的kNIMSessionCommandRemove事件）；
|
|||
|
|
* false则不删除，并将所有会话项的最后一条消息的状态kNIMSessionMsgStatus设置为已删除状态，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSessionCommandAllMsgDeleted事件（不会触发每个会话项的kNIMSessionCommandUpdate事件，避免频繁通知上层）。
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 操作结果的回调函数， nim_msglog_modify_res_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 0:失败
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_delete_all_async(bool delete_sessions, const char *json_extension, nim_msglog_modify_res_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_export_db_async(const char *dst_path, const char *json_extension, nim_msglog_modify_res_cb_func cb, const void *user_data)
|
|||
|
|
* 导出整个消息历史DB文件（不包括系统消息历史）。直接拷贝DB文件即可，SDK层不返回进度给APP层。
|
|||
|
|
* @param[in] dst_path 导出时保存的目标全路径（UTF-8编码）。
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 操作结果的回调函数， nim_msglog_modify_res_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 0:失败
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_export_db_async(const char *dst_path, const char *json_extension, nim_msglog_modify_res_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_import_db_async(const char *src_path, const char *json_extension, nim_msglog_modify_res_cb_func res_cb, const void *res_user_data, nim_msglog_import_prg_cb_func prg_cb, const void *prg_user_data)
|
|||
|
|
* 导入消息历史DB文件（不包括系统消息历史）。先验证是否自己的消息历史文件和DB加密密钥(见nim_client_def.h里的kNIMDataBaseEncryptKey），如果验证不通过，则不导入。
|
|||
|
|
* @param[in] src_path 导入源文件的全路径（UTF-8编码）。
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] res_cb 操作结果的回调函数， nim_msglog_modify_res_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] res_user_data APP的自定义用户数据，SDK只负责传回给回调函数res_cb，不做任何处理！
|
|||
|
|
* @param[in] prg_cb 导入进度的回调函数， nim_msglog_import_prg_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] prg_user_data APP的自定义用户数据，SDK只负责传回给回调函数prg_cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 10600:导入消息历史时验证身份和加密密钥不通过
|
|||
|
|
* 10601:导入消息历史时写记录失败
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_import_db_async(const char *src_path, const char *json_extension, nim_msglog_modify_res_cb_func res_cb, const void *res_user_data, nim_msglog_import_prg_cb_func prg_cb, const void *prg_user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_send_receipt_async(const char *json_msg, const char *json_extension, nim_msglog_status_changed_cb_func cb, const void *user_data)
|
|||
|
|
* 发送消息已读回执
|
|||
|
|
* @param[in] json_msg 已读消息json string。
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 操作结果的回调函数， nim_msglog_status_changed_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 403:服务器关闭此功能，或者应用没权限
|
|||
|
|
* 404:请求的目标（用户或对象）不存在
|
|||
|
|
* 10414:本地错误码，参数错误
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_send_receipt_async(const char *json_msg, const char *json_extension, nim_msglog_status_changed_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn bool nim_msglog_query_be_readed(const char *json_msg, const char *json_extension)
|
|||
|
|
* 查询自己发送的消息是否被对方已读
|
|||
|
|
* @param[in] json_msg 消息json string。
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @return bool 是否被已读
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API bool nim_msglog_query_be_readed(const char *json_msg, const char *json_extension);
|
|||
|
|
|
|||
|
|
#if NIMAPI_UNDER_WIN_DESKTOP_ONLY
|
|||
|
|
/** @fn bool nim_msglog_query_receipt_sent(const char *json_msg, const char *json_extension)
|
|||
|
|
* 查询收到的消息是否已经发送过已读回执
|
|||
|
|
* @param[in] json_msg 消息json string。
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @return bool 是否已发送过
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API bool nim_msglog_query_receipt_sent(const char *json_msg, const char *json_extension);
|
|||
|
|
#endif
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_reg_status_changed_cb(const char *json_extension, nim_msglog_status_changed_cb_func cb, const void *user_data)
|
|||
|
|
* (全局回调)注册全局的消息状态变更通知（目前只支持已读状态的通知）
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 回调函数， nim_msglog_status_changed_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_reg_status_changed_cb(const char *json_extension, nim_msglog_status_changed_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
/** @fn void nim_msglog_update_localext_async(const char *msg_id, const char *local_ext, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data)
|
|||
|
|
* 更新本地扩展字段内容
|
|||
|
|
* @param[in] msg_id 消息id
|
|||
|
|
* @param[in] local_ext 消息本地扩展字段内容
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 操作结果的回调函数， nim_msglog_res_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 0:失败
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_update_localext_async(const char *msg_id, const char *local_ext, const char *json_extension, nim_msglog_res_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
#if NIMAPI_UNDER_WIN_DESKTOP_ONLY
|
|||
|
|
/** @fn void nim_msglog_read_all_async(const char *json_extension, nim_msglog_modify_res_cb_func cb, const void *user_data)
|
|||
|
|
* 全部未读消息历史标记为已读
|
|||
|
|
* @param[in] json_extension json扩展参数（备用，目前不需要）
|
|||
|
|
* @param[in] cb 操作结果的回调函数， nim_msglog_modify_res_cb_func回调函数定义见nim_msglog_def.h
|
|||
|
|
* @param[in] user_data APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！
|
|||
|
|
* @return void 无返回值
|
|||
|
|
* @note 错误码 200:成功
|
|||
|
|
* 0:失败
|
|||
|
|
*/
|
|||
|
|
NIM_SDK_DLL_API void nim_msglog_read_all_async(const char *json_extension, nim_msglog_modify_res_cb_func cb, const void *user_data);
|
|||
|
|
|
|||
|
|
#endif
|
|||
|
|
#ifdef __cplusplus
|
|||
|
|
};
|
|||
|
|
#endif //__cplusplus
|
|||
|
|
#endif //NIM_SDK_DLL_API_NIM_MSGLOG_H_
|