node-nim 9.14.2 → 10.2.0

package/types/nim/nos.d.ts

@@ -1,118 +1,118 @@
-import { EventEmitter } from 'eventemitter3';
-import { DownloadMediaCallback, DownloadMediaExCallback, DownloadMediaResult, InitNosConfigParam, InitNosResult, InitNosResultCallback, NIMNOSAPI, NOSParams, ProgressCallback, ProgressExCallback, SafeURLToOriginURLCallback, SpeedCallback, TransferInfoCallback, UploadMediaExCallback, UploadMediaResult } from '../nim_def/nos_def';
-import { IMMessage } from '../nim_def/msglog_def';
-import { NIMResCode } from '../nim_def/client_def';
-export declare interface NIMNOSEvents {
-    /** 下载回调 */
-    downloadComplete: [number, string, string, string];
-    /** 上传回调 */
-    uploadComplete: [number, UploadMediaResult];
-}
-export declare class NIMNOS extends EventEmitter<NIMNOSEvents> {
-    nos: NIMNOSAPI;
-    constructor();
-    /** 注册全局回调 */
-    initEventHandlers(): void;
-    /** Nos模块初始化接口，对上传资源时使用的各场景资源生命周期进行初始化，开发者最多可自定义10个场景，并指定场景资源的生命周期，并可以对缺省场景（kNIMNosDefaultTagResource、kNIMNosDefaultTagIM）进行覆盖（重新指定生命周期）
-     * @param param 初始化参数
-     * @param cb 结果回调函数
-     * @return void 无返回值
-     */
-    initConfig(param: InitNosConfigParam, cb: InitNosResultCallback | null): Promise<[InitNosResult]>;
-    /** 获取资源
-     * @param msg 消息内容
-     * @param jsonExtension json扩展参数
-     * @param res_cb 下载的回调函数
-     * @param prg_cb 下载进度的回调函数
-     * @param speed_cb 下载速度的回调函数
-     * @param transfer_cb 最终下载信息的回调函数
-     * @return boolean 检查参数如果不符合要求则返回失败
-     * @note
-     * <pre>
-     * 200:成功
-     * 10206:下载暂停
-     * 408:请求过程超时
-     * 其他:参见HTTP协议或CURL错误码
-     * </pre>
-     */
-    fetchMedia(msg: IMMessage, jsonExtension: string, res_cb: DownloadMediaCallback | null, prg_cb: ProgressCallback | null, speed_cb: SpeedCallback | null, transfer_cb: TransferInfoCallback | null): Promise<[NIMResCode, string, string, string] | null>;
-    /** 停止获取资源（目前仅对文件消息类型有效）
-     * @param msg 消息内容
-     * @return boolean 检查参数如果不符合要求则返回失败
-     * @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 boolean 检查参数如果不符合要求则返回失败
-     * @note
-     * <pre>
-     * 200:成功
-     * 10200:上传暂停
-     * 408:请求过程超时
-     * 其他:参见HTTP协议或CURL错误码
-     * </pre>
-     */
-    uploadResource(local_file: string, tag: string, param: NOSParams, res_cb: UploadMediaExCallback | null, prg_cb: ProgressExCallback | null, speed_cb: SpeedCallback | null, transfer_cb: TransferInfoCallback | null): Promise<[NIMResCode, UploadMediaResult] | null>;
-    /** 停止上传资源(只能用于调用了UploadResource接口的上传任务)
-     * @param task_id 停止上传任务的ID
-     * @param jsonExtension json扩展参数
-     * @return boolean 检查参数如果不符合要求则返回失败
-     * @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 boolean 检查参数如果不符合要求则返回失败
-     * @note
-     * <pre>
-     * 200:成功
-     * 10200:上传暂停
-     * 408:请求过程超时
-     * 其他:参见HTTP协议或CURL错误码
-     * </pre>
-     */
-    downloadResource(nosUrl: string, param: NOSParams, res_cb: DownloadMediaExCallback | null, prg_cb: ProgressExCallback | null, speed_cb: SpeedCallback | null, transfer_cb: TransferInfoCallback | null): Promise<[NIMResCode, DownloadMediaResult] | null>;
-    /** 停止下载资源(只能用于调用了DownloadResourceEx接口的下载任务)
-     * @param task_id 停止下载任务的ID
-     * @param jsonExtension json扩展参数
-     * @return boolean 检查参数如果不符合要求则返回失败
-     * @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 | null, jsonExtension: string): Promise<[NIMResCode, string]>;
-    /** 打开或关闭文件快传开关
-     * @param quick 是否打开 true:打开 false:关闭
-     * @return void
-     */
-    setSupportQuickTrans(quick: boolean): void;
-}
+import { EventEmitter } from 'eventemitter3';
+import { DownloadMediaCallback, DownloadMediaExCallback, DownloadMediaResult, InitNosConfigParam, InitNosResult, InitNosResultCallback, NIMNOSAPI, NOSParams, ProgressCallback, ProgressExCallback, SafeURLToOriginURLCallback, SpeedCallback, TransferInfoCallback, UploadMediaExCallback, UploadMediaResult } from '../nim_def/nos_def';
+import { IMMessage } from '../nim_def/msglog_def';
+import { NIMResCode } from '../nim_def/client_def';
+export declare interface NIMNOSEvents {
+    /** 下载回调 */
+    downloadComplete: [number, string, string, string];
+    /** 上传回调 */
+    uploadComplete: [number, UploadMediaResult];
+}
+export declare class NIMNOS extends EventEmitter<NIMNOSEvents> {
+    nos: NIMNOSAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** Nos模块初始化接口，对上传资源时使用的各场景资源生命周期进行初始化，开发者最多可自定义10个场景，并指定场景资源的生命周期，并可以对缺省场景（kNIMNosDefaultTagResource、kNIMNosDefaultTagIM）进行覆盖（重新指定生命周期）
+     * @param param 初始化参数
+     * @param cb 结果回调函数
+     * @return void 无返回值
+     */
+    initConfig(param: InitNosConfigParam, cb: InitNosResultCallback | null): Promise<[InitNosResult]>;
+    /** 获取资源
+     * @param msg 消息内容
+     * @param jsonExtension json扩展参数
+     * @param res_cb 下载的回调函数
+     * @param prg_cb 下载进度的回调函数
+     * @param speed_cb 下载速度的回调函数
+     * @param transfer_cb 最终下载信息的回调函数
+     * @return boolean 检查参数如果不符合要求则返回失败
+     * @note
+     * <pre>
+     * 200:成功
+     * 10206:下载暂停
+     * 408:请求过程超时
+     * 其他:参见HTTP协议或CURL错误码
+     * </pre>
+     */
+    fetchMedia(msg: IMMessage, jsonExtension: string, res_cb: DownloadMediaCallback | null, prg_cb: ProgressCallback | null, speed_cb: SpeedCallback | null, transfer_cb: TransferInfoCallback | null): Promise<[NIMResCode, string, string, string] | null>;
+    /** 停止获取资源（目前仅对文件消息类型有效）
+     * @param msg 消息内容
+     * @return boolean 检查参数如果不符合要求则返回失败
+     * @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 boolean 检查参数如果不符合要求则返回失败
+     * @note
+     * <pre>
+     * 200:成功
+     * 10200:上传暂停
+     * 408:请求过程超时
+     * 其他:参见HTTP协议或CURL错误码
+     * </pre>
+     */
+    uploadResource(local_file: string, tag: string, param: NOSParams, res_cb: UploadMediaExCallback | null, prg_cb: ProgressExCallback | null, speed_cb: SpeedCallback | null, transfer_cb: TransferInfoCallback | null): Promise<[NIMResCode, UploadMediaResult] | null>;
+    /** 停止上传资源(只能用于调用了UploadResource接口的上传任务)
+     * @param task_id 停止上传任务的ID
+     * @param jsonExtension json扩展参数
+     * @return boolean 检查参数如果不符合要求则返回失败
+     * @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 boolean 检查参数如果不符合要求则返回失败
+     * @note
+     * <pre>
+     * 200:成功
+     * 10200:上传暂停
+     * 408:请求过程超时
+     * 其他:参见HTTP协议或CURL错误码
+     * </pre>
+     */
+    downloadResource(nosUrl: string, param: NOSParams, res_cb: DownloadMediaExCallback | null, prg_cb: ProgressExCallback | null, speed_cb: SpeedCallback | null, transfer_cb: TransferInfoCallback | null): Promise<[NIMResCode, DownloadMediaResult] | null>;
+    /** 停止下载资源(只能用于调用了DownloadResourceEx接口的下载任务)
+     * @param task_id 停止下载任务的ID
+     * @param jsonExtension json扩展参数
+     * @return boolean 检查参数如果不符合要求则返回失败
+     * @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 | null, jsonExtension: string): Promise<[NIMResCode, string]>;
+    /** 打开或关闭文件快传开关
+     * @param quick 是否打开 true:打开 false:关闭
+     * @return void
+     */
+    setSupportQuickTrans(quick: boolean): void;
+}

package/types/nim/online_session.d.ts

@@ -1,44 +1,44 @@
-import { EventEmitter } from 'eventemitter3';
-import { NIMSessionType } from '../nim_def/session_def';
-import { DeleteOnlineSessionInfoCallback, DeleteSessionParam, NIMOnlineSessionAPI, QueryOnlineSessionInfoCallback, QueryOnlineSessionListCallback, QuerySessionListResult, SessionInfo, UpdateOnlineSessionInfoCallback } from '../nim_def/online_session_def';
-import { NIMResCode } from '../nim_def/client_def';
-export declare interface NIMOnlineSessionEvents {
-    /** 会话变更 */
-    change: [SessionInfo];
-}
-export declare class NIMOnlineSession extends EventEmitter<NIMOnlineSessionEvents> {
-    session: NIMOnlineSessionAPI;
-    constructor();
-    /** 注册全局回调 */
-    initEventHandlers(): void;
-    /** 会话服务 查询会话列表
-     * @param minTime 最小时间戳,未知可以填0,表示到最早时间
-     * @param maxTime 最大时间戳,未知可以填0,表示从当前时间
-     * @param needLastMsg 是否需要返回lastMsg，默认true
-     * @param limit 结果集limit，最大100，缺省值100
-     * @param cb 结果回调  可查看NIMQueryOnlineSessionListCallback定义
-     * @return void 无返回值
-     */
-    querySessionList(minTime: number, maxTime: number, needLastMsg: boolean, limit: number, cb: QueryOnlineSessionListCallback | null): Promise<[QuerySessionListResult]>;
-    /** 会话服务 查询会话
-     * @param to_type 会话类型
-     * @param session_id 会话ID
-     * @param cb 结果回调  可查看NIMQuerySessionInfoCallback定义
-     * @return void 无返回值
-     */
-    querySession(to_type: NIMSessionType, session_id: string, cb: QueryOnlineSessionInfoCallback | null): Promise<[NIMResCode, SessionInfo]>;
-    /** 会话服务 更新会话
-     * @param to_type 会话类型
-     * @param session_id 会话ID
-     * @param ext 会话的扩展字段
-     * @param cb 结果回调  可查看NIMUpdateSessionInfoCallback定义
-     * @return void 无返回值
-     */
-    updateSession(to_type: NIMSessionType, session_id: string, ext: string, cb: UpdateOnlineSessionInfoCallback | null): Promise<[NIMResCode]>;
-    /** 会话服务 删除会话
-     * @param param 要删除的会话列
-     * @param cb 结果回调  可查看DeleteSessionInfoCallback定义
-     * @return void 无返回值
-     */
-    deleteSession(param: DeleteSessionParam, cb: DeleteOnlineSessionInfoCallback | null): Promise<[NIMResCode]>;
-}
+import { EventEmitter } from 'eventemitter3';
+import { NIMSessionType } from '../nim_def/session_def';
+import { DeleteOnlineSessionInfoCallback, DeleteSessionParam, NIMOnlineSessionAPI, QueryOnlineSessionInfoCallback, QueryOnlineSessionListCallback, QuerySessionListResult, SessionInfo, UpdateOnlineSessionInfoCallback } from '../nim_def/online_session_def';
+import { NIMResCode } from '../nim_def/client_def';
+export declare interface NIMOnlineSessionEvents {
+    /** 会话变更 */
+    change: [SessionInfo];
+}
+export declare class NIMOnlineSession extends EventEmitter<NIMOnlineSessionEvents> {
+    session: NIMOnlineSessionAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** 会话服务 查询会话列表
+     * @param minTime 最小时间戳,未知可以填0,表示到最早时间
+     * @param maxTime 最大时间戳,未知可以填0,表示从当前时间
+     * @param needLastMsg 是否需要返回lastMsg，默认true
+     * @param limit 结果集limit，最大100，缺省值100
+     * @param cb 结果回调  可查看NIMQueryOnlineSessionListCallback定义
+     * @return void 无返回值
+     */
+    querySessionList(minTime: number, maxTime: number, needLastMsg: boolean, limit: number, cb: QueryOnlineSessionListCallback | null): Promise<[QuerySessionListResult]>;
+    /** 会话服务 查询会话
+     * @param to_type 会话类型
+     * @param session_id 会话ID
+     * @param cb 结果回调  可查看NIMQuerySessionInfoCallback定义
+     * @return void 无返回值
+     */
+    querySession(to_type: NIMSessionType, session_id: string, cb: QueryOnlineSessionInfoCallback | null): Promise<[NIMResCode, SessionInfo]>;
+    /** 会话服务 更新会话
+     * @param to_type 会话类型
+     * @param session_id 会话ID
+     * @param ext 会话的扩展字段
+     * @param cb 结果回调  可查看NIMUpdateSessionInfoCallback定义
+     * @return void 无返回值
+     */
+    updateSession(to_type: NIMSessionType, session_id: string, ext: string, cb: UpdateOnlineSessionInfoCallback | null): Promise<[NIMResCode]>;
+    /** 会话服务 删除会话
+     * @param param 要删除的会话列
+     * @param cb 结果回调  可查看DeleteSessionInfoCallback定义
+     * @return void 无返回值
+     */
+    deleteSession(param: DeleteSessionParam, cb: DeleteOnlineSessionInfoCallback | null): Promise<[NIMResCode]>;
+}

package/types/nim/pass_through_proxy.d.ts

@@ -1,24 +1,24 @@
-import { NIMPassThroughProxyAPI, NIMSendHttpRequestMethods, SendHttpRequestCallback } from '../nim_def/pass_through_proxy_def';
-import { EventEmitter } from 'eventemitter3';
-import { NIMResCode } from '../nim_def/client_def';
-export declare interface NIMPassThroughProxyEvents {
-    /** 接受到 HTTP 透传消息 */
-    receiveHttpMsg: [string, string, number];
-}
-export declare class NIMPassThroughProxy extends EventEmitter<NIMPassThroughProxyEvents> {
-    proxy: NIMPassThroughProxyAPI;
-    constructor();
-    /** 注册全局回调 */
-    initEventHandlers(): void;
-    /** 发送一个透传 HTTP 请求
-     * @param host		要发送的 HTTP 请求 Host 地址
-     * @param path		URL 中除了 Host 的 Path
-     * @param method	要发送的 HTTP 请求方式
-     * @param header	要发送的 HTTP 请求 Header 内容
-     * @param body		要发送的 HTTP 请求 Body 内容
-     * @param jsonExtension	拓展字段，暂时无用
-     * @param cb	    发送请求后的数据回调函数
-     * @return void 无返回值
-     */
-    sendHttpRequest(host: string, path: string, method: NIMSendHttpRequestMethods, headers: string, body: string, jsonExtension: string, cb: SendHttpRequestCallback | null): Promise<[NIMResCode, string, string, string]>;
-}
+import { NIMPassThroughProxyAPI, NIMSendHttpRequestMethods, SendHttpRequestCallback } from '../nim_def/pass_through_proxy_def';
+import { EventEmitter } from 'eventemitter3';
+import { NIMResCode } from '../nim_def/client_def';
+export declare interface NIMPassThroughProxyEvents {
+    /** 接受到 HTTP 透传消息 */
+    receiveHttpMsg: [string, string, number];
+}
+export declare class NIMPassThroughProxy extends EventEmitter<NIMPassThroughProxyEvents> {
+    proxy: NIMPassThroughProxyAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** 发送一个透传 HTTP 请求
+     * @param host		要发送的 HTTP 请求 Host 地址
+     * @param path		URL 中除了 Host 的 Path
+     * @param method	要发送的 HTTP 请求方式
+     * @param header	要发送的 HTTP 请求 Header 内容
+     * @param body		要发送的 HTTP 请求 Body 内容
+     * @param jsonExtension	拓展字段，暂时无用
+     * @param cb	    发送请求后的数据回调函数
+     * @return void 无返回值
+     */
+    sendHttpRequest(host: string, path: string, method: NIMSendHttpRequestMethods, headers: string, body: string, jsonExtension: string, cb: SendHttpRequestCallback | null): Promise<[NIMResCode, string, string, string]>;
+}

package/types/nim/plugin.d.ts

@@ -1,39 +1,39 @@
-import { NIMPluginAPI, ChatRoomRequestEnterCallback, QChatRequestLinkAddressCallback } from '../nim_def/plugin_def';
-import { EventEmitter } from 'eventemitter3';
-import { NIMResCode } from '../nim_def/client_def';
-export declare interface NIMPluginEvents {
-}
-export declare class NIMPlugin extends EventEmitter<NIMPluginEvents> {
-    plugin: NIMPluginAPI;
-    constructor();
-    /** 注册全局回调 */
-    initEventHandlers(): void;
-    /** 异步获取聊天室登录信息
-     * @param roomId				聊天室ID
-     * @param cb				回调函数
-     * @param ext		json扩展参数（备用，目前不需要）
-     * @return void 无返回值
-     * @note
-     * <pre>
-     * 200:成功
-     * 414:参数错误
-     * 404:聊天室不存在
-     * 403:不允许进入该聊天室
-     * 415:服务不可用，没有聊天室服务器可分配
-     * 13003:在黑名单中
-     * </pre>
-     */
-    chatRoomRequestEnterAsync(roomId: number, cb: ChatRoomRequestEnterCallback | null, ext: string): Promise<[NIMResCode, string]>;
-    /** 异步获取圈组link地址
-     * @param[in] ip_version              ip协议, 0:ipv4, 1:ipv6, 2:all
-     * @param[in] callback                回调函数
-     * @param[in] jsonExtension        json扩展参数（备用，目前不需要）
-     * @return void 无返回值
-     * @note
-     * <pre>
-     * 200:成功
-     * 414:参数错误
-     * </pre>
-     */
-    qchatRequestLinkAddress(ip_version: number, cb: QChatRequestLinkAddressCallback | null, ext: string): Promise<[NIMResCode, Array<string>]>;
-}
+import { NIMPluginAPI, ChatRoomRequestEnterCallback, QChatRequestLinkAddressCallback } from '../nim_def/plugin_def';
+import { EventEmitter } from 'eventemitter3';
+import { NIMResCode } from '../nim_def/client_def';
+export declare interface NIMPluginEvents {
+}
+export declare class NIMPlugin extends EventEmitter<NIMPluginEvents> {
+    plugin: NIMPluginAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** 异步获取聊天室登录信息
+     * @param roomId				聊天室ID
+     * @param cb				回调函数
+     * @param ext		json扩展参数（备用，目前不需要）
+     * @return void 无返回值
+     * @note
+     * <pre>
+     * 200:成功
+     * 414:参数错误
+     * 404:聊天室不存在
+     * 403:不允许进入该聊天室
+     * 415:服务不可用，没有聊天室服务器可分配
+     * 13003:在黑名单中
+     * </pre>
+     */
+    chatRoomRequestEnterAsync(roomId: number, cb: ChatRoomRequestEnterCallback | null, ext: string): Promise<[NIMResCode, string]>;
+    /** 异步获取圈组link地址
+     * @param[in] ip_version              ip协议, 0:ipv4, 1:ipv6, 2:all
+     * @param[in] callback                回调函数
+     * @param[in] jsonExtension        json扩展参数（备用，目前不需要）
+     * @return void 无返回值
+     * @note
+     * <pre>
+     * 200:成功
+     * 414:参数错误
+     * </pre>
+     */
+    qchatRequestLinkAddress(ip_version: number, cb: QChatRequestLinkAddressCallback | null, ext: string): Promise<[NIMResCode, Array<string>]>;
+}