node-nim 10.2.0 → 10.3.0-beta.1

package/types/nim/msglog.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'eventemitter3';
 import { NIMSessionType } from '../nim_def/session_def';
-import { NIMMsgLogAPI, QuerySingleMsgCallback, QueryMsgCallback, NIMMessageType, ModifyMultipleMsglogCallback, NIMMsgLogStatus, ModifySingleMsglogCallback, NIMMsgLogSubStatus, DBFunctionCallback, ImportDbPrgCallback, MessageStatusChangedCallback, LogsBackupExportInfo, LogsBackupImportInfo, DeleteHistoryOnLineAsyncCallback, DeleteHistoryOnLineAsyncExCallback, DeleteMessageSelfAsyncCallback, QueryMessageIsThreadRootCallback, QueryMsgAsyncParam, QueryMessageOnlineCallback, QueryThreadHistoryMsgAsyncParam, QueryThreadHistoryMsgCallback, FullTextSearchOnlineAsyncParam, FullTextSearchOnlineAsyncCallback, IMMessage, QueryMsgByKeywordOnlineParam, QueryMsgOnlineAsyncParam, DeleteMsglogSelfNotifyItemInfo, DeleteMsglogSelfNotifyParam, MessageStatusChangedResult, QueryMsgByOptionsAsyncParam, QueryMsglogResult, NIMMsglogSearchDirection, GetMessagesDynamicallyCallback, GetMessagesResult } from '../nim_def/msglog_def';
+import { NIMMsgLogAPI, QuerySingleMsgCallback, QueryMsgCallback, NIMMessageType, ModifyMultipleMsglogCallback, NIMMsgLogStatus, ModifySingleMsglogCallback, NIMMsgLogSubStatus, DBFunctionCallback, ImportDbPrgCallback, MessageStatusChangedCallback, LogsBackupExportInfo, LogsBackupImportInfo, DeleteHistoryOnLineAsyncCallback, DeleteHistoryOnLineAsyncExCallback, DeleteMessageSelfAsyncCallback, QueryMessageIsThreadRootCallback, QueryMsgAsyncParam, QueryMessageOnlineCallback, QueryThreadHistoryMsgAsyncParam, QueryThreadHistoryMsgCallback, FullTextSearchOnlineAsyncParam, FullTextSearchOnlineAsyncCallback, IMMessage, QueryMsgByKeywordOnlineParam, QueryMsgOnlineAsyncParam, DeleteMsglogSelfNotifyItemInfo, DeleteMsglogSelfNotifyParam, MessageStatusChangedResult, QueryMsgByOptionsAsyncParam, QueryMsglogResult, NIMMsglogSearchDirection, GetMessagesDynamicallyCallback, GetMessagesResult, NIMBuildingMsglogIndexesCompleteReason, QueryMsgByKeywordParam, IsMessageIndexEstablishedCallback, BuildMsglogIndexesProgress, BuildMsglogIndexesComplete } from '../nim_def/msglog_def';
 import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMMsgLogEvents {
     /** 单向删除消息记录通知 */
@@ -16,9 +16,9 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
     /** 注册全局回调 */
     initEventHandlers(): void;
     /** 根据消息ID查询本地（单条）消息
-     * @param clientMsgId		客户端消息ID
-     * @param jsonExtension	json扩展参数（备用，目前不需要）
-     * @param cb				查询本地消息的回调函数
+     * @param clientMsgId        客户端消息ID
+     * @param jsonExtension    json扩展参数（备用，目前不需要）
+     * @param cb                查询本地消息的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -27,13 +27,13 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     queryMsgByIDAysnc(clientMsgId: string, cb: QuerySingleMsgCallback | null, jsonExtension: string): Promise<[NIMResCode, string, IMMessage] | null>;
     /** 查询本地消息
-     * @param accid	查询id，account_id/uid或者tid
-     * @param to_type	    会话类型，双人0，群组1 (见nim_msglog_def.h)
-     * @param limit_count	一次查询数量，建议20
+     * @param accid    查询id，account_id/uid或者tid
+     * @param to_type        会话类型，双人0，群组1 (见nim_msglog_def.h)
+     * @param limit_count    一次查询数量，建议20
      * @param anchor_msg_time
      * 作为此次查询的定位点的消息历史的消息时间戳（上次查询最后一条消息的时间戳，按指定的时间的顺序起查，默认为逆序，2.4.0之前命名为last_name）
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			查询本地消息的回调函数
+     * @param cb            查询本地消息的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -57,8 +57,8 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     getMessagesDynamically(session_id: string, to_type: NIMSessionType, from_time: number, to_time: number, limit_count: number, anchor_client_msg_id: string, anchor_server_msg_id: string, direction: NIMMsglogSearchDirection, cb: GetMessagesDynamicallyCallback | null, jsonExtension: string): Promise<[GetMessagesResult] | null>;
     /** 在线查询消息（不包括系统消息）
-     * @param param			查询参数
-     * @param cb				在线查询消息的回调函数
+     * @param param            查询参数
+     * @param cb                在线查询消息的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -69,8 +69,8 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     queryMsgOnlineAsync(param: QueryMsgOnlineAsyncParam, cb: QueryMsgCallback | null): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
     /** 在线查询消息（不包括系统消息）
-     * @param param			查询参数
-     * @param cb				在线查询消息的回调函数
+     * @param param            查询参数
+     * @param cb                在线查询消息的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -81,17 +81,17 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     queryMsgByKeywordOnlineAsync(param: QueryMsgByKeywordOnlineParam, cb: QueryMsgCallback | null): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
     /** 根据指定条件在一个会话中查询指定单个或多个类型的本地消息
-     * @param to_type			会话类型，双人0，群组1 (nim_msglog_def.h)
-     * @param id				查询id，对方的account id或者群组tid。
-     * @param limit_count	本次查询的消息条数上限(最多100条)
-     * @param fromTime		起始时间点，单位：毫秒
-     * @param endTime		结束时间点，单位：毫秒
-     * @param endClientMsgId		结束查询的最后一条消息的end_client_msg_id(不包含在查询结果中)
-     * @param reverse		true：反向查询(按时间正序起查，正序排列)，false：按时间逆序起查，逆序排列（建议默认为false）
-     * @param msgType		检索的消息类型
-     * @param jsonExtension	json扩展参数（备用，目前不需要）
-     * @param cb				在线查询消息的回调函数
-     * @return boolean 检查参数如果不符合要求则返回失败
+     * @param to_type               会话类型，双人0，群组1 (nim_msglog_def.h)
+     * @param id                    查询id，对方的account id或者群组tid。
+     * @param limit_count           本次查询的消息条数上限(最多100条)
+     * @param from_time             起始时间点，单位：毫秒，当为 0 时将不作为过滤条件
+     * @param end_time              结束时间点，单位：毫秒，当为 0 时将不作为过滤条件
+     * @param end_client_msg_id     作为查询结果的过滤条件，无论正向、反向查询，当遇到此消息 ID 时均跳过后续的消息，且不将该 ID 对应的消息包含在查询结果中
+     * @param reverse               查询方向，为 true 时对时间段内的消息从新到旧查询，查询结果按消息时间降序排列，为 false 时对时间段内的消息从旧到新查询，查询结果按消息时间升序排列
+     * @param msg_type              检索的消息类型
+     * @param json_extension        json 扩展参数（备用，目前不需要）
+     * @param cb                    在线查询消息的回调函数
+     * @return bool 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
      * 200:成功
@@ -100,7 +100,7 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
     queryMsgOfSpecifiedTypeInASessionAsync(to_type: NIMSessionType, id: string, limit_count: number, fromTime: number, endTime: number, endClientMsgId: string, reverse: boolean, msgType: Array<NIMMessageType>, cb: QueryMsgCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
     /** 根据指定条件查询本地消息,使用此接口可以完成全局搜索等功能,具体请参阅开发手册
      * @param param  查询参数
-     * @param cb	 在线查询消息的回调函数
+     * @param cb     在线查询消息的回调函数
      * @return boolean  检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -109,10 +109,10 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     queryMsgByOptionsAsync(param: QueryMsgByOptionsAsyncParam, cb: QueryMsgCallback | null): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
     /** 批量设置已读状态
-     * @param accid	查询id，account_id/uid或者tid
-     * @param to_type	    会话类型，双人0，群组1 (见nim_msglog_def.h)
+     * @param accid    查询id，account_id/uid或者tid
+     * @param to_type        会话类型，双人0，群组1 (见nim_msglog_def.h)
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			操作结果的回调函数
+     * @param cb            操作结果的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -121,10 +121,10 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     batchStatusReadAsync(accid: string, to_type: NIMSessionType, cb: ModifyMultipleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType] | null>;
     /** 删除某个会话的全部聊天记录
-     * @param accid	要删除会话的id，account_id/uid或者tid
-     * @param to_type	    会话类型，双人0，群组1 (见nim_msglog_def.h)
-     * @param revert_by_query_online	是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
-     * @param cb			操作结果的回调函数
+     * @param accid    要删除会话的id，account_id/uid或者tid
+     * @param to_type        会话类型，双人0，群组1 (见nim_msglog_def.h)
+     * @param revert_by_query_online    是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
+     * @param cb            操作结果的回调函数
      * @param jsonExtension json扩展参数（备用，目前不需要）
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
@@ -134,10 +134,10 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     batchStatusDeleteAsync(accid: string, to_type: NIMSessionType, revert_by_query_online: boolean, cb: ModifyMultipleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType] | null>;
     /** 设置消息状态
-     * @param msg_id		消息id
+     * @param msg_id        消息id
      * @param status 消息状态枚举值
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			操作结果的回调函数
+     * @param cb            操作结果的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -146,10 +146,10 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     setStatusAsync(msg_id: string, status: NIMMsgLogStatus, cb: ModifySingleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string] | null>;
     /** 设置消息子状态
-     * @param msg_id		消息id
+     * @param msg_id        消息id
      * @param status 消息子状态枚举值
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			操作结果的回调函数
+     * @param cb            操作结果的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -172,11 +172,11 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     writeMsglogToLocalAsync(talkId: string, msg: IMMessage, needUpdateSession: boolean, composeLastMsg: boolean, excludeMsgType: Array<number>, cb: ModifySingleMsglogCallback | null): Promise<[NIMResCode, string] | null>;
     /** 删除指定会话类型的所有消息
-     * @param delSessions	    是否删除会话
-     * @param to_type	    会话类型
-     * @param revert_by_query_online	是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
+     * @param delSessions        是否删除会话
+     * @param to_type        会话类型
+     * @param revert_by_query_online    是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			操作结果的回调函数
+     * @param cb            操作结果的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -185,11 +185,11 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     deleteBySessionTypeAsync(delSessions: boolean, to_type: NIMSessionType, revert_by_query_online: boolean, cb: ModifyMultipleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType] | null>;
     /** 删除指定一条消息
-     * @param session_id	会话id，对方的account id或者群组tid
-     * @param to_type	    会话类型
-     * @param msg_id		消息id
+     * @param session_id    会话id，对方的account id或者群组tid
+     * @param to_type        会话类型
+     * @param msg_id        消息id
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			操作结果的回调函数
+     * @param cb            操作结果的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -198,28 +198,28 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     deleteAsync(session_id: string, to_type: NIMSessionType, msg_id: string, cb: ModifySingleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string] | null>;
     /** 删除全部消息历史
-       * @param del_session 是否删除所有会话列表项（即全部最近联系人）。
-         ture则删除，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSessionCommandRemoveAll事件（不会触发每个会话项的kNIMSessionCommandRemove事件）；
-         false则不删除，并将所有会话项的最后一条消息的状态kNIMSessionMsgStatus设置为已删除状态，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSession
-           CommandAllMsgDeleted事件（不会触发每个会话项的kNIMSessionCommandUpdate事件，避免频繁通知上层）。
-       * @param revert_by_query_online	是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
-       * @param jsonExtension json扩展参数（备用，目前不需要）
-       * @param cb			操作结果的回调函数
-       * @return boolean 检查参数如果不符合要求则返回失败
-       * @note
-       * <pre>
-       * 200:成功
-       * </pre>
-       */
+     * @param del_session 是否删除所有会话列表项（即全部最近联系人）。
+     ture则删除，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSessionCommandRemoveAll事件（不会触发每个会话项的kNIMSessionCommandRemove事件）；
+     false则不删除，并将所有会话项的最后一条消息的状态kNIMSessionMsgStatus设置为已删除状态，并通过nim_session_reg_change_cb注册的回调通知上层kNIMSession
+     CommandAllMsgDeleted事件（不会触发每个会话项的kNIMSessionCommandUpdate事件，避免频繁通知上层）。
+     * @param revert_by_query_online    是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
+     * @param jsonExtension json扩展参数（备用，目前不需要）
+     * @param cb            操作结果的回调函数
+     * @return boolean 检查参数如果不符合要求则返回失败
+     * @note
+     * <pre>
+     * 200:成功
+     * </pre>
+     */
     deleteAllAsync(del_session: boolean, revert_by_query_online: boolean, cb: DBFunctionCallback | null, jsonExtension: string): Promise<[NIMResCode] | null>;
     /** 根据时间段删除部分会话的历史消息
-     * @param session_id	要删除消息的会话ID
-     * @param to_type	要删除消息的会话类型
-     * @param revert_by_query_online	是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
+     * @param session_id    要删除消息的会话ID
+     * @param to_type    要删除消息的会话类型
+     * @param revert_by_query_online    是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
      * @param timestamp1 单位ms timestamp1	与 timestamp2 组成一个时间段，SDK 内部会判断大小调整入参顺序
      * @param timestamp2 单位ms timestamp2	与 timestamp1 组成一个时间段，SDK 内部会判断大小调整入参顺序
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			操作结果的回调函数
+     * @param cb            操作结果的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -228,9 +228,9 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     deleteMsgByTimeAsync(session_id: string, to_type: NIMSessionType, revert_by_query_online: boolean, timestamp1: number, timestamp2: number, cb: DBFunctionCallback | null, jsonExtension: string): Promise<[NIMResCode] | null>;
     /** 导出整个消息历史DB文件（不包括系统消息历史）
-     * @param dst_path		导出时保存的目标全路径（UTF-8编码）。
+     * @param dst_path        导出时保存的目标全路径（UTF-8编码）。
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			操作结果的回调函数
+     * @param cb            操作结果的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -239,10 +239,10 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     exportDbAsync(dst_path: string, cb: DBFunctionCallback | null, jsonExtension: string): Promise<[NIMResCode]>;
     /** 导入消息历史DB文件（不包括系统消息历史）。先验证是否自己的消息历史文件和DB加密密钥(见nim_client_def.h里的kNIMDataBaseEncryptKey），如果验证不通过，则不导入。
-     * @param src_path			导入源文件的全路径（UTF-8编码）。
-     * @param jsonExtension	json扩展参数（备用，目前不需要）
-     * @param cb			操作结果的回调函数
-     * @param prg_cb			导入进度的回调函数
+     * @param src_path            导入源文件的全路径（UTF-8编码）。
+     * @param jsonExtension    json扩展参数（备用，目前不需要）
+     * @param cb            操作结果的回调函数
+     * @param prg_cb            导入进度的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -253,8 +253,8 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     importDbAsync(src_path: string, cb: DBFunctionCallback, prg_cb: ImportDbPrgCallback | null, jsonExtension: string): Promise<[NIMResCode]>;
     /** 发送消息已读回执
-     * @param msg			已读消息
-     * @param cb			操作结果的回调函数
+     * @param msg            已读消息
+     * @param cb            操作结果的回调函数
      * @return void 无返回值
      * @note
      * <pre>
@@ -266,20 +266,20 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      */
     sendReceiptAsync(msg: IMMessage, cb: MessageStatusChangedCallback | null): Promise<[MessageStatusChangedResult]>;
     /** 查询自己发送的消息是否被对方已读
-     * @param msg			消息。
+     * @param msg            消息。
      * @return boolean 是否被已读
      */
     querySentMessageBeReaded(msg: IMMessage): boolean;
     /** 查询收到的消息是否已经发送过已读回执
-     * @param msg			消息。
+     * @param msg            消息。
      * @return boolean 是否已发送过
      */
     queryReceivedMsgReceiptSent(msg: IMMessage): boolean;
     /** 更新本地消息扩展字段内容
-     * @param msg_id		消息id
+     * @param msg_id        消息id
      * @param local_ext  本地扩展字段内容
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			操作结果的回调函数
+     * @param cb            操作结果的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -289,7 +289,7 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
     updateLocalExtAsync(msg_id: string, local_ext: string, cb: ModifySingleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string]>;
     /** 全部未读消息历史标记为已读
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			操作结果的回调函数
+     * @param cb            操作结果的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -319,7 +319,7 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      * @param accid 对方的accid
      * @param del_remote 是否同时删除所有的漫游消息 true : 是 false : 否
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb	 操作结果的回调函数
+     * @param cb     操作结果的回调函数
      * @return void
      * @note
      * <pre>
@@ -332,7 +332,7 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      * @param to_type 会话类型，双人0，群组1 (见nim_msglog_def.h)
      * @param needs_notify_self 是否通知其它终端
      * @param jsonExtension 扩展字段
-     * @param cb	 操作结果的回调函数
+     * @param cb     操作结果的回调函数
      * @return void
      * @note 错误码	200:成功
      */
@@ -340,7 +340,7 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
     /** 单向删除某条消息记录(同时删除本地与云端)
      * @param msg 要删除的消息
      * @param exts 用户自定义扩展字段
-     * @param cb	操作结果的回调函数
+     * @param cb    操作结果的回调函数
      * @return void 无返回值
      * @note
      * <pre>
@@ -350,17 +350,17 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
     deleteMessageSelfAsync(msg: IMMessage, ext: string, cb: DeleteMessageSelfAsyncCallback | null): Promise<[NIMResCode]>;
     /** 查询某条消息是否为thread聊天的根消息
      * @param client_id 要查询的消息的客户端ID
-     * @param cb			操作结果的回调函数
+     * @param cb            操作结果的回调函数
      * @return void 无返回值
      * @note
      * <pre>
      * 200:成功
      * </pre>
      */
-    queryMessageIsThreadRoot(client_id: string, cb: QueryMessageIsThreadRootCallback | null): Promise<[NIMResCode, string, boolean]>;
+    queryMessageIsThreadRoot(client_id: string, cb: QueryMessageIsThreadRootCallback | null): Promise<[NIMResCode, string, boolean, number]>;
     /** 查询某条消息的具体内容一般用在thread talk 场景中
      * @param param 要查询的消息的相关参数，可以在msglog.threadinfo中得到
-     * @param cb			查询结果的回调函数
+     * @param cb            查询结果的回调函数
      * @return void 无返回值
      * @note
      * <pre>
@@ -371,7 +371,7 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
     /** 分页查询thread talk消息历史
      * @param msg 要查询的消息
      * @param param 要查询的消息的相关参数，可以在msglog.threadinfo中得到
-     * @param cb			查询结果的回调函数
+     * @param cb            查询结果的回调函数
      * @return void 无返回值
      * @note
      * <pre>
@@ -379,6 +379,17 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      * </pre>
      */
     queryThreadHistoryMsg(msg: IMMessage, param: QueryThreadHistoryMsgAsyncParam, cb: QueryThreadHistoryMsgCallback | null): Promise<[NIMResCode, IMMessage, number, number, Array<IMMessage>]>;
+    /** 查询本地 thread talk 消息历史
+     * @param msg 根消息消息体
+     * @param cb 查询结果的回调函数
+     * @return void 无返回值
+     * @note
+     * <pre>
+     *     200:成功
+     *     414:参数错误
+     * </pre>
+     */
+    queryLocalThreadHistoryMsg(msg: IMMessage, cb: QueryMsgCallback | null): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult]>;
     /** 在线全文检索
      * @param param 全文检索参数
      * @param cb    全文检索结果回调函数
@@ -389,4 +400,37 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
      * </pre>
      */
     fullTextSearchOnlineAsync(param: FullTextSearchOnlineAsyncParam, cb: FullTextSearchOnlineAsyncCallback | null): Promise<[NIMResCode, QueryMsglogResult]>;
+    /**
+     * @brief 根据关键字在本地查询关联消息的内容，与其他关键字查询接口不同，本接口使用全文检索引擎进行查询
+     * 如果您有历史数据，请先调用 IsMessageIndexEstablished 判断是否已经同步完成所有旧消息索引
+     * 如果尚未同步完成，可使用 BuildingMsglogIndexes 来构建历史消息索引，以提供全文检索接口快速查询内容
+     * @param param 查询参数 @see QueryMsgByKeywordParam
+     * @param cb 查询消息的回调函数
+     * @return bool 检查参数如果不符合要求则返回失败
+     * @note
+     * <pre>
+     *     200:成功
+     *     414:参数错误
+ *     </pre>
+     */
+    queryMessagesByKeywordAsync(param: QueryMsgByKeywordParam, cb: QueryMsgCallback | null): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult]>;
+    /**
+     * @brief 判断消息索引是否已经建立完成，如果已经建立完成，则可以使用 QueryMessagesByKeywordAsync 接口通过关键字全文检索
+     * @param cb 是否已经建立完成的回调函数
+     * @return void
+     */
+    isMessageIndexEstablished(cb: IsMessageIndexEstablishedCallback): Promise<boolean>;
+    /**
+     * @brief 对旧的历史消息构建消息索引表
+     * @param page_size 每页同步多少条消息，建议最小不低于 1000，最大不超过 5000
+     * @param progress 构建消息索引表进度回调 @see BuildMsglogIndexesProgress
+     * @param completion 构建消息索引表完成回调 @see BuildMsglogIndexesComplete
+     * @return void
+     */
+    buildMsglogIndexes(page_size: number, progress: BuildMsglogIndexesProgress | null, complete: BuildMsglogIndexesComplete | null): Promise<[NIMBuildingMsglogIndexesCompleteReason, string]>;
+    /**
+     * @brief 取消构建消息索引表
+     * @return void
+     */
+    cancelMsglogIndexesBuilding(): void;
 }

package/types/nim/session.d.ts

@@ -74,7 +74,7 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
      * @param jsonExtension json扩展参数（备用，目前不需要）
      * @return void 无返回值
      */
-    queryAllRecentSessionAsync(msg_excluded_type_list: Array<NIMMessageType>, cb: QuerySessionListCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionDataList]>;
+    queryAllRecentSessionAsync(msg_excluded_type_list: Array<NIMMessageType>, cb: QuerySessionListCallback | null, jsonExtension: string): Promise<[number, SessionDataList]>;
     /** 删除最近联系人
      * @param to_type		会话类型，双人0，群组1 (nim_msglog_def.h)
      * @param id			对方的account id或者群组tid。

package/types/nim/super_team.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from 'eventemitter3';
-import { QuerySuperTeamMyAllMemberInfosCallback, NIMSuperTeamAPI, SuperTeamEventCallback, SuperTeamInfo, SuperTeamMemberProperty, QueryAllMySuperTeamsCallback, QueryAllMySuperTeamsInfoCallback, QuerySuperTeamMembersCallback, QuerySuperTeamMemberCallback, QuerySuperTeamInfoCallback, SuperTeamEvent } from '../nim_def/super_team_def';
+import { QuerySuperTeamMyAllMemberInfosCallback, NIMSuperTeamAPI, SuperTeamEventCallback, SuperTeamInfo, SuperTeamMemberProperty, QueryAllMySuperTeamsCallback, QueryAllMySuperTeamsInfoCallback, QuerySuperTeamMembersCallback, QuerySuperTeamMemberCallback, QuerySuperTeamInfoCallback, SuperTeamEvent, SuperTeamMemberKeywordSearchOption, SuperTeamMemberSerachResult, SuperTeamMemberRoleTypeSearchOption } from '../nim_def/super_team_def';
 export declare interface NIMSuperTeamEvents {
     /** 超大群事件 */
     superTeamEvent: [SuperTeamEvent];
@@ -187,6 +187,20 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
      * </pre>
      */
     updateMyPropertyAsync(prop: SuperTeamMemberProperty, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
+    /** @fn boolean addTeamMembersFollow(tid: string, account_ids: Array<string>, cb: SuperTeamEventCallback)
+     * 添加群成员特别通知
+     * @param[in] tid    群组id
+     * @param[in] account_ids    群成员id
+     * @param[in] cb        添加群成员特别通知的回调函数
+     */
+    addTeamMembersFollow(tid: string, account_ids: Array<string>, cb: SuperTeamEventCallback): Promise<[SuperTeamEvent] | null>;
+    /** @fn boolean removeTeamMembersFollow(tid: string, account_ids: Array<string>, SuperTeamEventCallback
+     * cb) 移除群成员特别通知
+     * @param[in] tid    群组id
+     * @param[in] account_ids    群成员id
+     * @param[in] cb        移除群成员特别通知的回调函数
+     */
+    removeTeamMembersFollow(tid: string, account_ids: Array<string>, cb: SuperTeamEventCallback): Promise<[SuperTeamEvent] | null>;
     /** 修改别人的群昵称
      * @param prop	群成员属性
      * @param jsonExtension json扩展参数（备用，目前不需要）
@@ -328,4 +342,15 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
      * @return boolean 检查参数如果不符合要求则返回失败
      */
     querySuperTeamsInfoByKeywordAsync(keyword: string, cb: QueryAllMySuperTeamsInfoCallback | null, jsonExtension: string): Promise<[number, Array<SuperTeamInfo>]>;
+    /** 搜索群成员
+     * @param option 搜索群成员选项
+     * @return boolean 检查参数如果不符合要求则返回失败
+     */
+    searchTeamMembers(option: SuperTeamMemberKeywordSearchOption): Promise<[SuperTeamMemberSerachResult]>;
+    /** 根据成员类型获取群成员
+     * @param tid		群组id
+     * @param option 获取群成员选项
+     * @return boolean 检查参数如果不符合要求则返回失败
+     */
+    getTeamMemberList(tid: string, option: SuperTeamMemberRoleTypeSearchOption): Promise<[SuperTeamMemberSerachResult]>;
 }

package/types/nim/talk.d.ts

@@ -73,12 +73,12 @@ export declare class NIMTalk extends EventEmitter<NIMTalkEvents> {
      */
     getAttachmentPathFromMsg(msg: IMMessage): string;
     /** 回复消息thread 聊天场景
-     * @param msg	被回复消息的消息体
-     * @param json_reply_msg	回复消息的消息体,可通过各种createxxxmessage接口创建
-     * @param prg_cb		传进度的回调函数, 如果发送的消息里包含了文件资源,则通过此回调函数通知上传进度
+     * @param formerMsg	    被回复消息的消息体
+     * @param replyMsg	    回复消息的消息体,可通过各种createxxxmessage接口创建
+     * @param progressCb		传进度的回调函数, 如果发送的消息里包含了文件资源,则通过此回调函数通知上传进度
      * @return void 无返回值
      */
-    replyMessage(msg: IMMessage, json_reply_msg: string): void;
+    replyMessage(formerMsg: IMMessage, replyMsg: IMMessage, progressCb: FileUpPrgCallback): void;
     /** (全局回调)注册消息过滤接口 （堵塞线程，谨慎使用，避免耗时行为）
      * @param[in] filter    过滤接口
      * @param[in] json_extension json扩展参数（备用,目前不需要）

package/types/nim/team.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'eventemitter3';
 import { IMMessage } from '../nim_def/msglog_def';
-import { NIMTeamAPI, TeamInfo, TeamEventCallback, QueryAllMyTeamsCallback, QueryAllMyTeamsInfoCallback, QueryTeamMyAllMemberInfosCallback, QueryTeamMembersCallback, QueryTeamMemberCallback, QueryTeamInfoCallback, QueryTeamMembersOnlineCallback, TeamMsgAckReadCallback, QueryTeamMembersInvitorCallback, QueryTeamsInfoCallback, UpdateTInfoLocalCallback, GetTeamInfoBatchSFTransCallback, GetTeamInfoListCallback, TeamMemberProperty, TeamEvent } from '../nim_def/team_def';
+import { NIMTeamAPI, TeamInfo, TeamEventCallback, QueryAllMyTeamsCallback, QueryAllMyTeamsInfoCallback, QueryTeamMyAllMemberInfosCallback, QueryTeamMembersCallback, QueryTeamMemberCallback, QueryTeamInfoCallback, QueryTeamMembersOnlineCallback, TeamMsgAckReadCallback, QueryTeamMembersInvitorCallback, QueryTeamsInfoCallback, UpdateTInfoLocalCallback, GetTeamInfoBatchSFTransCallback, GetTeamInfoListCallback, TeamMemberProperty, TeamEvent, TeamMemberRoleTypeSearchOption, TeamMemberSerachResult } from '../nim_def/team_def';
 import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMTeamEvents {
     /** 群事件 */
@@ -238,6 +238,20 @@ export declare class NIMTeam extends EventEmitter<NIMTeamEvents> {
      * </pre>
      */
     updateMyPropertyAsync(prop: TeamMemberProperty, cb: TeamEventCallback | null, jsonExtension: string): Promise<[TeamEvent] | null>;
+    /** @fn boolean addTeamMembersFollow(tid: string, account_ids: Array<string>, cb: TeamEventCallback)
+     * 添加群成员特别通知
+     * @param[in] tid    群组id
+     * @param[in] account_ids    群成员id
+     * @param[in] cb        添加群成员特别通知的回调函数
+     */
+    addTeamMembersFollow(tid: string, account_ids: Array<string>, cb: TeamEventCallback): Promise<[TeamEvent] | null>;
+    /** @fn boolean removeTeamMembersFollow(tid: string, account_ids: Array<string>, TeamEventCallback
+     * cb) 移除群成员特别通知
+     * @param[in] tid    群组id
+     * @param[in] account_ids    群成员id
+     * @param[in] cb        移除群成员特别通知的回调函数
+     */
+    removeTeamMembersFollow(tid: string, account_ids: Array<string>, cb: TeamEventCallback): Promise<[TeamEvent] | null>;
     /** 修改别人的群昵称
      * @param prop	群成员属性
      * @param jsonExtension json扩展参数（备用，目前不需要）
@@ -458,4 +472,10 @@ export declare class NIMTeam extends EventEmitter<NIMTeamEvents> {
      * </pre>
      */
     getTeaminfoList(tids: Array<string>, cb: GetTeamInfoListCallback | null): Promise<[NIMResCode, Array<TeamInfo>, Array<string>]>;
+    /** 根据成员类型获取群成员
+     * @param tid		群组id
+     * @param option 获取群成员选项
+     * @return boolean 检查参数如果不符合要求则返回失败
+     */
+    getTeamMemberList(tid: string, option: TeamMemberRoleTypeSearchOption): Promise<[TeamMemberSerachResult]>;
 }

package/types/nim/tool.d.ts

@@ -74,4 +74,5 @@ export declare class NIMTool extends EventEmitter<NIMToolEvents> {
      * </pre>
      */
     filterClientAntispam(text: string, replaceString: string, libName: string, cb: FilterClientAntispamCallback | null): Promise<[boolean, NIMResCode, string]>;
+    parseStringToJsonObject(jsonString: string): object;
 }

package/types/nim_def/client_def.d.ts

@@ -26,7 +26,8 @@ export declare enum NIMClientType {
     kNIMClientTypePCWindows = 4 /** < PC Windows*/,
     kNIMClientTypeWeb = 16 /** < Web*/,
     kNIMClientTypeRestAPI = 32 /** < RestAPI*/,
-    kNIMClientTypeMacOS = 64 /** < Mac*/
+    kNIMClientTypeMacOS = 64 /** < Mac*/,
+    kNIMClientTypeHarmonyOS = 65 /** < HarmonyOS */
 }
 /** @enum NIMResCode 返回的错误号（只定义需要客户端处理的） */
 export declare enum NIMResCode {
@@ -165,6 +166,8 @@ export interface SDKConfig {
                                                ，默认为false,开启后获取的缩略图为原格式，关闭后获取的缩略图为第一帧静态图 */
     client_antispam_?: boolean; /**< boolean 客户端反垃圾，默认为false，如需开启请提前咨询技术支持或销售 */
     team_msg_ack_?: boolean; /**< boolean 群消息已读功能开关， 默认为false，如需开启请提前咨询技术支持或销售  */
+    team_query_tinfo_override_by_local_?: boolean; /**< boolean 在线查询群组信息时是否使用本地数据对 member_valid 字段进行覆盖 */
+    team_sync_tlist_limit_?: number; /**< int 同步群列表数量限制，范围 100-2000，默认 2000 */
     need_update_lbs_befor_relogin_?: boolean; /**< boolean 在进行重新登录前是否先刷新一下lbs,对于切换网络的场景适用  */
     custom_client_type_?: number; /**< int, 自定义客户端类型字段,大于0 */
     /***********消息“已接收回执”发送配置 begin************/

package/types/nim_def/msglog_def.d.ts

@@ -116,6 +116,22 @@ export declare enum NIMMsglogSearchDirection {
     kForward = 0 /** < 以时间点为准向前搜索 */,
     kBackward = 1 /** < 以时间点为准向后搜索 */
 }
+export declare enum NIMMsglogSearchSegmentEngine {
+    kSegmentEngineDefault = 0,
+    kSegmentEngineSimple = 1,
+    kSegmentEngineJiebaCutWithHMM = 2,
+    kSegmentEngineJiebaCutWithoutHMM = 3,
+    kSegmentEngineJiebaCutAll = 4,
+    kSegmentEngineJiebaCutForSearch = 5,
+    kSegmentEngineJiebaCutHMM = 6
+}
+export declare enum NIMBuildingMsglogIndexesCompleteReason {
+    kBuildingMsglogIndexesCompleted = 0,
+    kBuildingMsglogIndexesCanceled = 1,
+    kBuildingMsglogIndexesError = 2,
+    kBuildingMsglogIndexesFullDisk = 3,
+    kBuildingMsglogIndexesInProgress = 4
+}
 /** @enum NIMMsglogQuerySource 消息历史查询来源 */
 export declare enum NIMMsglogQuerySource {
     kNIMMsglogQuerySourceLocal = 0 /** < 本地查询*/,
@@ -317,6 +333,17 @@ export interface GetMessagesResult {
     reliable_?: boolean; /**< 结果是否可信：例如当查询范围不在可信时间段内, 但远端请求失败时, 返回的本地结果可能不完整 */
     messages_?: Array<IMMessage>; /**< 历史消息列表 */
 }
+export interface QueryMsgByKeywordParam {
+    keyword_: string; /**< 要查询的关键字 */
+    account_id_?: string; /**< 查询id，对方的account id或者群组tid */
+    to_type_?: NIMSessionType; /**< enum 会话类型，双人0，群组1 (nim_msglog_def.h) */
+    type_: Array<NIMMessageType>; /**< array 要获取的消息类型，默认只有文本类消息，可自行扩充其他类型消息，除通知类消息不受支持外，其他类型消息（包括自定义消息）均可检索 */
+    limit_count_?: number; /**< number 本次查询的消息条数上限 */
+    from_time_?: number; /**< number 起始时间点，单位：毫秒 */
+    end_time_?: number; /**< number 结束时间点，单位：毫秒 */
+    direction_?: NIMMsglogSearchDirection; /**< enum 查询方向 */
+    segment_engine_?: NIMMsglogSearchSegmentEngine; /**< enum 分段引擎 */
+}
 export type QueryMsgCallback = (rescode: NIMResCode, id: string, to_type: NIMSessionType, result: QueryMsglogResult) => void;
 export type GetMessagesDynamicallyCallback = (result: GetMessagesResult) => void;
 export type QuerySingleMsgCallback = (rescode: NIMResCode, id: string, msg: IMMessage) => void;
@@ -330,10 +357,13 @@ export type MessageStatusChangedCallback = (result: MessageStatusChangedResult)
 export type ImportDbPrgCallback = (importedCount: number, totalCount: number) => void;
 export type DeleteHistoryOnLineAsyncCallback = (rescode: NIMResCode, accid: string) => void;
 export type DeleteHistoryOnLineAsyncExCallback = (rescode: NIMResCode, accid: string, to_type: number, timestamp: number, jsonExtension: string) => void;
-export type QueryMessageIsThreadRootCallback = (rescode: NIMResCode, client_id: string, is_root: boolean) => void;
+export type QueryMessageIsThreadRootCallback = (rescode: NIMResCode, client_id: string, is_root: boolean, reply_count: number) => void;
 export type QueryMessageOnlineCallback = (rescode: NIMResCode, client_id: string, msg: IMMessage) => void;
 export type QueryThreadHistoryMsgCallback = (rescode: NIMResCode, root_msg: IMMessage, total: number, last_msg_time: number, msg_array: Array<IMMessage>) => void;
 export type FullTextSearchOnlineAsyncCallback = (rescode: NIMResCode, result: QueryMsglogResult) => void;
+export type IsMessageIndexEstablishedCallback = (is_established: boolean) => void;
+export type BuildMsglogIndexesProgress = (total: number, built_count: number) => void;
+export type BuildMsglogIndexesComplete = (reason: NIMBuildingMsglogIndexesCompleteReason, message: string) => void;
 export interface NIMMsgLogAPI {
     InitEventHandlers(): void;
     QueryMsgByIDAysnc(clientMsgId: string, cb: QuerySingleMsgCallback | null, jsonExtension: string): boolean;
@@ -369,5 +399,10 @@ export interface NIMMsgLogAPI {
     QueryMessageIsThreadRoot(client_id: string, cb: QueryMessageIsThreadRootCallback | null): void;
     QueryMessageOnline(param: QueryMsgAsyncParam, cb: QueryMessageOnlineCallback | null): void;
     QueryThreadHistoryMsg(msg: IMMessage, param: QueryThreadHistoryMsgAsyncParam, cb: QueryThreadHistoryMsgCallback | null): void;
+    QueryLocalThreadHistoryMsg(msg: IMMessage, cb: QueryMsgCallback | null): void;
     FullTextSearchOnlineAsync(param: FullTextSearchOnlineAsyncParam, cb: FullTextSearchOnlineAsyncCallback | null): void;
+    QueryMessagesByKeywordAsync(param: QueryMsgByKeywordParam, cb: QueryMsgCallback | null): void;
+    IsMessageIndexEstablished(cb: IsMessageIndexEstablishedCallback | null): void;
+    BuildMsglogIndexes(page_size: number, progress: BuildMsglogIndexesProgress | null, complete: BuildMsglogIndexesComplete | null): void;
+    CancelMsglogIndexesBuilding(): void;
 }