node-nim 7.8.3 → 9.1.0-rc.1

package/types/api/friend.d.ts

@@ -0,0 +1,82 @@
+/// <reference types="node" />
+import ev from 'events';
+import { DeleteFriendOption, FriendProfile, NIMFriendAPI, FriendOptCallback, GetFriendProfileCallback, GetFriendsListCallback, NIMVerifyType } from '../def/friend_def';
+export declare interface NIMFriend {
+    on(event: 'change', listener: () => void): this;
+    once(event: 'change', listener: () => void): this;
+}
+export declare class NIMFriend extends ev.EventEmitter {
+    friend: NIMFriendAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** 添加、验证好友
+       * @param accid	对方帐号
+       * @param verify_type 好友验证类型
+       * @param msg 接口扩展字段
+       * @param cb	好友请求回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 404:用户不存在
+       * 500:未知错误
+       * </pre>
+       */
+    request(accid: string, verify_type: NIMVerifyType, msg: string, cb: FriendOptCallback, jsonExtension: string): boolean;
+    /** 删除好友
+       * @param accid	对方帐号
+       * @param option 删除好友选项，目前仅有是否删除备注信息选项
+       * @param cb	删除好友回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 404:用户不存在
+       * 500:未知错误
+       * </pre>
+       */
+    delete(accid: string, option: DeleteFriendOption, cb: FriendOptCallback): boolean;
+    /** 更新好友资料
+       * @param profile 好友资料
+       * @param cb	更新好友资料回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 404:用户不存在
+       * 500:未知错误
+       * </pre>
+       */
+    update(profile: FriendProfile, cb: FriendOptCallback, jsonExtension: string): boolean;
+    /** 增量获取好友列表
+       * @param cb	获取好友列表回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    getList(cb: GetFriendsListCallback, jsonExtension: string): void;
+    /** 获取好友信息
+       * @param accid	对方帐号
+       * @param cb	获取好友信息回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void 无返回值
+       */
+    getFriendProfile(accid: string, cb: GetFriendProfileCallback, jsonExtension: string): void;
+    /** 增量获取好友列表
+       * @param keyword 要查询的关键字
+       * @param cb	获取好友列表回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 返回 true 表示发送查询请求成功，返回 false 表示关键字为空
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    queryFriendListByKeyword(keyword: string, cb: GetFriendsListCallback, jsonExtension: string): boolean;
+}

package/types/api/global.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="node" />
+import ev from 'events';
+import { DeleteCachedFileCallback, DetectProxyCallback, ExceptionCallback, GetCachedFileInfoCallback, NIMCachedFileType, NIMGlobalAPI, NIMProxyType, SDKFeedbackCallback, UploadSDKLogCallback } from '../def/global_def';
+export declare interface NIMGlobal {
+    on(event: 'dbError', listener: () => void): this;
+    once(event: 'dbError', listener: () => void): this;
+}
+export declare class NIMGlobal extends ev.EventEmitter {
+    global: NIMGlobalAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** 注册输出系统环境异常的回调
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb
+       * @return void 无返回值
+       */
+    setExceptionReportCallback(jsonExtension: string, cb: ExceptionCallback): void;
+    /** 设置SDK统一的网络代理。不需要代理时，type设置为kNIMProxyNone，其余参数都传空字符串（端口设为0）。有些代理不需要用户名和密码，相应参数也传空字符串。
+       * @param type 代理类型，见NIMProxyType定义
+       * @param host 代理地址
+       * @param port 代理端口
+       * @param user 代理用户名
+       * @param password 代理密码
+       * @return void 无返回值
+       */
+    setProxy(type: NIMProxyType, host: string, port: number, user: string, password: string): void;
+    /** 测试代理
+       * @param type 代理类型，见NIMProxyType定义
+       * @param host 代理地址
+       * @param port 代理端口
+       * @param user 代理用户名
+       * @param password 代理密码
+       * @param cb 回调函数
+       * @return void 无返回值
+       */
+    detectProxy(type: NIMProxyType, host: string, port: number, user: string, password: string, cb: DetectProxyCallback): void;
+    /** 获取sdk缓存文件信息
+       * @param loginId 查询的账号ID
+       * @param fileType 文件类型，常量定义见NIMCachedFileType
+       * @param endTimestamp  查询时间截止点（查询全部填0）
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb
+       * @return void 无返回值
+       */
+    getSDKCachedFileInfoAsync(loginId: string, fileType: NIMCachedFileType, endTimestamp: number, jsonExtension: string, cb: GetCachedFileInfoCallback): void;
+    /** 删除sdk缓存文件
+       * @param loginId 查询的账号ID
+       * @param fileType 文件类型，常量定义见NIMCachedFileType
+       * @param endTimestamp  删除时间截止点（查询全部填0）
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb
+       * @return void 无返回值
+       */
+    deleteSDKCachedFileAsync(loginId: string, fileType: NIMCachedFileType, endTimestamp: number, jsonExtension: string, cb: DeleteCachedFileCallback): void;
+    /** SDK 反馈
+       * @param url 开发者需将所需要反馈的文件（dump，应用日志等）上传至nos。
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb
+       * @return void 无返回值
+       */
+    sdkFeedbackAsync(url: string, jsonExtension: string, cb: SDKFeedbackCallback): void;
+    /** 上传SDK日志到服务器
+       * @param feedbackStr 反馈信息
+       * @param cb 操作结果的回调函数
+       * @return void
+       */
+    uploadSDKLog(feedbackStr: string, cb: UploadSDKLogCallback): void;
+}

package/types/api/msglog.d.ts

@@ -0,0 +1,388 @@
+/// <reference types="node" />
+import ev from 'events';
+import { NIMSessionType } from '../def/session_def';
+import { IMMessage, QueryMsgByKeywordOnlineParam, QueryMsgOnlineAsyncParam } from '../def/msglog_def';
+import { NIMMsgLogAPI, QuerySingleMsgCallback, QueryMsgCallback, NIMMessageType, NIMMsgLogQueryRange, ModifyMultipleMsglogCallback, NIMMsgLogStatus, ModifySingleMsglogCallback, NIMMsgLogSubStatus, DBFunctionCallback, ImportDbPrgCallback, MessageStatusChangedCallback, LogsBackupExportInfo, LogsBackupImportInfo, DeleteHistoryOnLineAsyncCallback, DeleteHistoryOnLineAsyncExCallback, DeleteMessageSelfAsyncCallback, QueryMessageIsThreadRootCallback, QueryMsgAsyncParam, QueryMessageOnlineCallback, QueryThreadHistoryMsgAsyncParam, QueryThreadHistoryMsgCallback, FullTextSearchOnlineAsyncParam, FullTextSearchOnlineAsyncCallback } from '../def/msglog_def';
+export declare interface NIMMsgLog {
+    on(event: 'localMsgDeleted', listener: () => void): this;
+    on(event: 'onlineMsgDeleted', listener: () => void): this;
+    on(event: 'msgStatusChanged', listener: () => void): this;
+    once(event: 'localMsgDeleted', listener: () => void): this;
+    once(event: 'onlineMsgDeleted', listener: () => void): this;
+    once(event: 'msgStatusChanged', listener: () => void): this;
+}
+export declare class NIMMsgLog extends ev.EventEmitter {
+    msglog: NIMMsgLogAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** 根据消息ID查询本地（单条）消息
+       * @param clientMsgId		客户端消息ID
+       * @param jsonExtension	json扩展参数（备用，目前不需要）
+       * @param cb				查询本地消息的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    queryMsgByIDAysnc(clientMsgId: string, cb: QuerySingleMsgCallback, jsonExtension: string): boolean;
+    /** 查询本地消息
+       * @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			查询本地消息的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    queryMsgAsync(accid: string, to_type: NIMSessionType, limit_count: number, anchor_msg_time: number, cb: QueryMsgCallback, jsonExtension: string): boolean;
+    /** 在线查询消息（不包括系统消息）
+       * @param param			查询参数
+       * @param cb				在线查询消息的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 403:禁止访问(不在该群,只针对群组会话)
+       * 414:参数错误
+       * </pre>
+       */
+    queryMsgOnlineAsync(param: QueryMsgOnlineAsyncParam, cb: QueryMsgCallback): boolean;
+    /** 在线查询消息（不包括系统消息）
+       * @param param			查询参数
+       * @param cb				在线查询消息的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 403:禁止访问(不在该群,只针对群组会话)
+       * 414:参数错误
+       * </pre>
+       */
+    queryMsgByKeywordOnlineAsync(param: QueryMsgByKeywordOnlineParam, cb: QueryMsgCallback): boolean;
+    /** 根据指定条件在一个会话中查询指定单个或多个类型的本地消息
+       * @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 bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    queryMsgOfSpecifiedTypeInASessionAsync(to_type: NIMSessionType, id: string, limit_count: number, fromTime: number, endTime: number, endClientMsgId: string, reverse: boolean, msgType: Array<NIMMessageType>, cb: QueryMsgCallback, jsonExtension: string): boolean;
+    /** 根据指定条件查询本地消息,使用此接口可以完成全局搜索等功能,具体请参阅开发手册
+       * @param queryRange	消息历史的检索范围（目前暂不支持某些范围的组合检索，详见NIMMsgLogQueryRange说明）
+       * @param ids			会话id（对方的account id或者群组tid）的集合，目前暂不支持多个的组合检索，详见NIMMsgLogQueryRange说明
+       * @param limit_count	本次查询的消息条数上限(最多100条)
+       * @param fromTime		起始时间点，单位：毫秒
+       * @param endTime		结束时间点，单位：毫秒
+       * @param endClientMsgId		结束查询的最后一条消息的end_client_msg_id(不包含在查询结果中)
+       * @param reverse		true：反向查询(按时间正序起查，正序排列)，false：按时间逆序起查，逆序排列（建议默认为false）
+       * @param msgType		检索的消息类型（目前只支持kNIMMessageTypeText、kNIMMessageTypeImage和kNIMMessageTypeFile这三种类型消息）
+       * @param searchContent
+       * 检索文本（目前只支持kNIMMessageTypeText和kNIMMessageTypeFile这两种类型消息的文本关键字检索，即支持文字消息和文件名的检索。如果合并检索，需使用未知类型消息kNIMMessageTypeUnknown）
+       * @param cb				在线查询消息的回调函数
+       * @param jsonExtension	json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    queryMsgByOptionsAsync(queryRange: NIMMsgLogQueryRange, ids: Array<string>, limit_count: number, fromTime: number, endTime: number, endClientMsgId: string, reverse: boolean, msgType: NIMMessageType, searchContent: string, cb: QueryMsgCallback, jsonExtension: string): boolean;
+    /** 批量设置已读状态
+       * @param accid	查询id，account_id/uid或者tid
+       * @param to_type	    会话类型，双人0，群组1 (见nim_msglog_def.h)
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			操作结果的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    batchStatusReadAsync(accid: string, to_type: NIMSessionType, cb: ModifyMultipleMsglogCallback, jsonExtension: string): boolean;
+    /** 删除某个会话的全部聊天记录
+       * @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 bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    batchStatusDeleteAsync(accid: string, to_type: NIMSessionType, revert_by_query_online: boolean, cb: ModifyMultipleMsglogCallback, jsonExtension: string): boolean;
+    /** 设置消息状态
+       * @param msg_id		消息id
+       * @param status 消息状态枚举值
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			操作结果的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    setStatusAsync(msg_id: string, status: NIMMsgLogStatus, cb: ModifySingleMsglogCallback, jsonExtension: string): boolean;
+    /** 设置消息子状态
+       * @param msg_id		消息id
+       * @param status 消息子状态枚举值
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			操作结果的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    setSubStatusAsync(msg_id: string, status: NIMMsgLogSubStatus, cb: ModifySingleMsglogCallback, jsonExtension: string): boolean;
+    /** 只往本地消息历史数据库里写入一条消息（如果已存在这条消息，则更新。通常是APP的本地自定义消息，并不会发给服务器）
+       * @param talkId               会话id，对方的account id或者群组tid
+       * @param msg                   消息内容
+       * @param needUpdateSession   是否更新会话列表（一般最新一条消息有这个需求）
+       * @param composeLastMsg      如果消息历史中有该会话的消息，是否将该会话最后一条消息随会话变更上报，true 为携带，否则不携带
+       * @param excludeMsgType      如果 compose_last_msg = true，则可根据需要排除指定最后一条消息的类型
+       * @param cb                    操作结果的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    writeMsglogToLocalAsync(talkId: string, msg: IMMessage, needUpdateSession: boolean, composeLastMsg: boolean, excludeMsgType: Array<number>, cb: ModifySingleMsglogCallback): boolean;
+    /** 删除指定会话类型的所有消息
+       * @param delSessions	    是否删除会话
+       * @param to_type	    会话类型
+       * @param revert_by_query_online	是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			操作结果的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    deleteBySessionTypeAsync(delSessions: boolean, to_type: NIMSessionType, revert_by_query_online: boolean, cb: ModifyMultipleMsglogCallback, jsonExtension: string): boolean;
+    /** 删除指定一条消息
+       * @param session_id	会话id，对方的account id或者群组tid
+       * @param to_type	    会话类型
+       * @param msg_id		消息id
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			操作结果的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    deleteAsync(session_id: string, to_type: NIMSessionType, msg_id: string, cb: ModifySingleMsglogCallback, jsonExtension: string): boolean;
+    /** 删除全部消息历史
+       * @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 bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    deleteAllAsync(del_session: boolean, revert_by_query_online: boolean, cb: DBFunctionCallback, jsonExtension: string): boolean;
+    /** 根据时间段删除部分会话的历史消息
+       * @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			操作结果的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    deleteMsgByTimeAsync(session_id: string, to_type: NIMSessionType, revert_by_query_online: boolean, timestamp1: number, timestamp2: number, cb: DBFunctionCallback, jsonExtension: string): boolean;
+    /** 导出整个消息历史DB文件（不包括系统消息历史）
+       * @param dst_path		导出时保存的目标全路径（UTF-8编码）。
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			操作结果的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    exportDbAsync(dst_path: string, cb: DBFunctionCallback, jsonExtension: string): boolean;
+    /** 导入消息历史DB文件（不包括系统消息历史）。先验证是否自己的消息历史文件和DB加密密钥(见nim_client_def.h里的kNIMDataBaseEncryptKey），如果验证不通过，则不导入。
+       * @param src_path			导入源文件的全路径（UTF-8编码）。
+       * @param jsonExtension	json扩展参数（备用，目前不需要）
+       * @param cb			操作结果的回调函数
+       * @param prg_cb			导入进度的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 10600:导入消息历史时验证身份和加密密钥不通过
+       * 10601:导入消息历史时写记录失败
+       * </pre>
+       */
+    importDbAsync(src_path: string, cb: DBFunctionCallback, prg_cb: ImportDbPrgCallback, jsonExtension: string): boolean;
+    /** 发送消息已读回执
+       * @param msg			已读消息
+       * @param cb			操作结果的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * 403:服务器关闭此功能，或者应用没权限
+       * 404:请求的目标（用户或对象）不存在
+       * 10414:本地错误码，参数错误
+       * </pre>
+       */
+    sendReceiptAsync(msg: IMMessage, cb: MessageStatusChangedCallback): void;
+    /** 查询自己发送的消息是否被对方已读
+       * @param msg			消息。
+       * @return bool 是否被已读
+       */
+    querySentMessageBeReaded(msg: IMMessage): boolean;
+    /** 查询收到的消息是否已经发送过已读回执
+       * @param msg			消息。
+       * @return bool 是否已发送过
+       */
+    queryReceivedMsgReceiptSent(msg: IMMessage): boolean;
+    /** 更新本地消息扩展字段内容
+       * @param msg_id		消息id
+       * @param local_ext  本地扩展字段内容
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			操作结果的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    updateLocalExtAsync(msg_id: string, local_ext: string, cb: ModifySingleMsglogCallback, jsonExtension: string): boolean;
+    /** 全部未读消息历史标记为已读
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			操作结果的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    readAllAsync(cb: DBFunctionCallback, jsonExtension: string): boolean;
+    /** 导出本地消息记录到云端
+     * @param export_info 导出需要的参数参考LogsBackupExportInfo定义
+     * @return bool false : 当前有导入/导出操作正在进行中
+     */
+    exportBackupToRemote(export_info: LogsBackupExportInfo): boolean;
+    /** 导入已备份在云端的消息记录
+     * @param import_info 导入需要的参数参考LogsBackupImportInfo定义
+     * @return bool false : 当前有导入/导出操作正在进行中
+     */
+    importBackupToRemote(export_info: LogsBackupImportInfo): boolean;
+    /** 取消导入已备份在云端的消息记录
+     * @return void
+     */
+    cancelImportBackupFromRemote(): void;
+    /** 取消导出本地消息记录到云端
+     * @return void
+     */
+    cancelExportBackupToRemote(): void;
+    /** 删除与某账号的所有云端历史记录与漫游消息(p2p)
+       * @param accid 对方的accid
+       * @param del_remote 是否同时删除所有的漫游消息 true : 是 false : 否
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb	 操作结果的回调函数
+       * @return void
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    deleteHistoryOnlineAsync(accid: string, del_remote: boolean, jsonExtension: string, cb: DeleteHistoryOnLineAsyncCallback): void;
+    /** 删除某一会话的云端的历史记录[v8.0.0]
+       * @param accid 对方的accid(p2p:accid team:tid)
+       * @param to_type 会话类型，双人0，群组1 (见nim_msglog_def.h)
+       * @param needs_notify_self 是否通知其它终端
+       * @param jsonExtension 扩展字段
+       * @param cb	 操作结果的回调函数
+       * @return void
+       * @note 错误码	200:成功
+       */
+    deleteHistoryOnlineAsyncEx(accid: string, to_type: number, needs_notify_self: boolean, jsonExtension: string, cb: DeleteHistoryOnLineAsyncExCallback): void;
+    /** 单向删除某条消息记录(同时删除本地与云端)
+       * @param msg 要删除的消息
+       * @param exts 用户自定义扩展字段
+       * @param cb	操作结果的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    deleteMessageSelfAsync(msg: IMMessage, ext: string, cb: DeleteMessageSelfAsyncCallback): void;
+    /** 查询某条消息是否为thread聊天的根消息
+       * @param client_id 要查询的消息的客户端ID
+       * @param cb			操作结果的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    queryMessageIsThreadRoot(client_id: string, cb: QueryMessageIsThreadRootCallback): void;
+    /** 查询某条消息的具体内容一般用在thread talk 场景中
+       * @param param 要查询的消息的相关参数，可以在msglog.threadinfo中得到
+       * @param cb			查询结果的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    queryMessageOnline(param: QueryMsgAsyncParam, cb: QueryMessageOnlineCallback): void;
+    /** 分页查询thread talk消息历史
+       * @param msg 要查询的消息
+       * @param param 要查询的消息的相关参数，可以在msglog.threadinfo中得到
+       * @param cb			查询结果的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    queryThreadHistoryMsg(msg: IMMessage, param: QueryThreadHistoryMsgAsyncParam, cb: QueryThreadHistoryMsgCallback): void;
+    /** 在线全文检索
+       * @param param 全文检索参数
+       * @param cb    全文检索结果回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    fullTextSearchOnlineAsync(param: FullTextSearchOnlineAsyncParam, cb: FullTextSearchOnlineAsyncCallback): void;
+}

package/types/api/nos.d.ts

@@ -0,0 +1,118 @@
+/// <reference types="node" />
+import ev from 'events';
+import { DownloadMediaCallback, DownloadMediaExCallback, InitNosConfigParam, InitNosResultCallback, NIMNOSAPI, NOSParams, ProgressCallback, ProgressExCallback, SafeURLToOriginURLCallback, SpeedCallback, TransferInfoCallback, UploadMediaExCallback } from '../def/nos_def';
+import { IMMessage } from '../def/msglog_def';
+export declare interface NIMNOS {
+    on(event: 'downloadComplete', listener: () => void): this;
+    on(event: 'uploadComplete', listener: () => void): this;
+    once(event: 'downloadComplete', listener: () => void): this;
+    once(event: 'uploadComplete', listener: () => void): this;
+}
+export declare class NIMNOS extends ev.EventEmitter {
+    nos: NIMNOSAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** Nos模块初始化接口，对上传资源时使用的各场景资源生命周期进行初始化，开发者最多可自定义10个场景，并指定场景资源的生命周期，并可以对缺省场景（kNIMNosDefaultTagResource、kNIMNosDefaultTagIM）进行覆盖（重新指定生命周期）
+       * @param param 初始化参数
+       * @param cb 结果回调函数
+       * @return void 无返回值
+       */
+    initConfig(param: InitNosConfigParam, cb: InitNosResultCallback): void;
+    /** 获取资源
+       * @param msg 消息内容
+       * @param jsonExtension json扩展参数
+       * @param res_cb 下载的回调函数
+       * @param prg_cb 下载进度的回调函数
+       * @param speed_cb 下载速度的回调函数
+       * @param transfer_cb 最终下载信息的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 10206:下载暂停
+       * 408:请求过程超时
+       * 其他:参见HTTP协议或CURL错误码
+       * </pre>
+       */
+    fetchMedia(msg: IMMessage, jsonExtension: string, res_cb: DownloadMediaCallback, prg_cb: ProgressCallback, speed_cb: SpeedCallback, transfer_cb: TransferInfoCallback): boolean;
+    /** 停止获取资源（目前仅对文件消息类型有效）
+       * @param msg 消息内容
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note 错误码	10206:成功
+       */
+    stopFetchMedia(msg: IMMessage): boolean;
+    /** 上传资源
+       * @param local_file 本地文件的完整路径，路径名必须是utf-8
+       * @param tag 场景标签，主要用于确定文件的保存时间
+       * @param param NOS扩展上传\下载接口参数
+       *nim_nos_download_ex"
+       * @param res_cb 扩展上传的回调函数
+       * @param prg_cb 扩展上传进度的回调函数
+       * @param speed_cb 上传速度的回调函数
+       * @param transfer_cb 最终上传信息的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 10200:上传暂停
+       * 408:请求过程超时
+       * 其他:参见HTTP协议或CURL错误码
+       * </pre>
+       */
+    uploadResource(local_file: string, tag: string, param: NOSParams, res_cb: UploadMediaExCallback, prg_cb: ProgressExCallback, speed_cb: SpeedCallback, transfer_cb: TransferInfoCallback): boolean;
+    /** 停止上传资源(只能用于调用了UploadResource接口的上传任务)
+       * @param task_id 停止上传任务的ID
+       * @param jsonExtension json扩展参数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 10200:成功
+       * </pre>
+       */
+    stopUploadResource(task_id: string, jsonExtension: string): boolean;
+    /** 下载资源
+       * @param nosUrl 下载资源的URL
+       * @param param NOS扩展上传\下载接口参数
+       * @param res_cb 扩展下载的回调函数
+       * @param prg_cb 扩展下载进度的回调函数
+       * @param speed_cb 下载速度的回调函数
+       * @param transfer_cb 最终下载信息的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 10200:上传暂停
+       * 408:请求过程超时
+       * 其他:参见HTTP协议或CURL错误码
+       * </pre>
+       */
+    downloadResource(nosUrl: string, param: NOSParams, res_cb: DownloadMediaExCallback, prg_cb: ProgressExCallback, speed_cb: SpeedCallback, transfer_cb: TransferInfoCallback): boolean;
+    /** 停止下载资源(只能用于调用了DownloadResourceEx接口的下载任务)
+       * @param task_id 停止下载任务的ID
+       * @param jsonExtension json扩展参数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 10206:成功
+       * </pre>
+       */
+    stopDownloadResource(task_id: string, jsonExtension: string): boolean;
+    /** 根据安全链接(短链)换取源链接
+       * @param safe_url 安全链接(短链)
+       * @param cb 结果回调
+       * @param jsonExtension json扩展参数
+       * @return void
+       * @note
+       * <pre>
+       * 200:成功
+       * 414 不存在该短链或 safe_url 不是一个有效的短链
+       * </pre>
+       */
+    safeURLToOriginURL(safe_url: string, cb: SafeURLToOriginURLCallback, jsonExtension: string): void;
+    /** 打开或关闭文件快传开关
+       * @param quick 是否打开 true:打开 false:关闭
+       * @return void
+       */
+    setSupportQuickTrans(quick: boolean): void;
+}