node-nim 7.8.3 → 9.1.0-rc.1

package/types/api/online_session.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="node" />
+import ev from 'events';
+import { NIMSessionType } from '../def/session_def';
+import { DeleteOnlineSessionInfoCallback, DeleteSessionParam, NIMOnlineSessionAPI, QueryOnlineSessionInfoCallback, QueryOnlineSessionListCallback, UpdateOnlineSessionInfoCallback } from '../def/online_session_def';
+export declare interface NIMOnlineSession {
+    on(event: 'change', listener: () => void): this;
+    once(event: 'change', listener: () => void): this;
+}
+export declare class NIMOnlineSession extends ev.EventEmitter {
+    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): void;
+    /** 会话服务 查询会话
+       * @param to_type 会话类型
+       * @param session_id 会话ID
+       * @param cb 结果回调  可查看NIMQuerySessionInfoCallback定义
+       * @return void 无返回值
+       */
+    querySession(to_type: NIMSessionType, session_id: string, cb: QueryOnlineSessionInfoCallback): void;
+    /** 会话服务 更新会话
+       * @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): void;
+    /** 会话服务 删除会话
+       * @param param 要删除的会话列
+       * @param cb 结果回调  可查看DeleteSessionInfoCallback定义
+       * @return void 无返回值
+       */
+    deleteSession(param: DeleteSessionParam, cb: DeleteOnlineSessionInfoCallback): void;
+}

package/types/api/pass_through_proxy.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+import { NIMPassThroughProxyAPI, NIMSendHttpRequestMethods, SendHttpRequestCallback } from '../def/pass_through_proxy_def';
+import ev from 'events';
+export declare interface NIMPassThroughProxy {
+    on(event: 'receiveHttpMsg', listener: () => void): this;
+    once(event: 'receiveHttpMsg', listener: () => void): this;
+}
+export declare class NIMPassThroughProxy extends ev.EventEmitter {
+    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): void;
+}

package/types/api/plugin.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="node" />
+import { NIMPluginAPI, ChatRoomRequestEnterCallback, QChatRequestLinkAddressCallback } from '../def/plugin_def';
+import ev from 'events';
+export declare class NIMPlugin extends ev.EventEmitter {
+    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, ext: string): void;
+    /** 异步获取圈组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, ext: string): void;
+}

package/types/api/session.d.ts

@@ -0,0 +1,212 @@
+/// <reference types="node" />
+import ev from 'events';
+import { IMMessage, NIMMessageType } from '../def/msglog_def';
+import { CancelToStickTopSessionCallback, DeleteHasmoreRoammsgCallback, DeleteSessionRoamingMessageCallback, MultiUnreadCountZeroInfo, NIMSessionAPI, NIMSessionType, QueryAllHasmoreRoammsgCallback, QueryHasmoreRoammsgCallback, QuerySessionDataCallback, QuerySessionListCallback, QueryStickTopSessionListCallback, SessionChangeCallback, SetMultiUnreadCountZeroAsyncCallback, SetToStickTopSessionCallback, UpdateHasmoreRoammsgCallback, UpdateStickTopSessionCallback } from '../def/session_def';
+export declare interface NIMSession {
+    on(event: 'change', listener: () => void): this;
+    on(event: 'stickTop', listener: () => void): this;
+    on(event: 'cancelStickTop', listener: () => void): this;
+    on(event: 'updateTtickTop', listener: () => void): this;
+    once(event: 'change', listener: () => void): this;
+    once(event: 'stickTop', listener: () => void): this;
+    once(event: 'cancelStickTop', listener: () => void): this;
+    once(event: 'updateTtickTop', listener: () => void): this;
+}
+export declare class NIMSession extends ev.EventEmitter {
+    session: NIMSessionAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** 查询置顶会话列表
+       * @param cb			置顶会话列表查询结果的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    queryStickTopSessionList(cb: QueryStickTopSessionListCallback): void;
+    /** 设置置顶会话
+       * @param session_id			会话id
+       * @param to_type			    会话类型
+       * @param ext			        扩展字段
+       * @param cb			        置顶会话设置结果的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    setToStickTopSession(session_id: string, to_type: number, ext: string, cb: SetToStickTopSessionCallback): void;
+    /** 更新置顶会话列表
+       * @param session_id			会话id
+       * @param to_type			    会话类型
+       * @param ext			        扩展字段
+       * @param cb			        更新置顶会话设置结果的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    updateToStickTopSession(session_id: string, to_type: number, ext: string, cb: UpdateStickTopSessionCallback): void;
+    /** 取消置顶会话列表
+       * @param session_id			会话id
+       * @param to_type			会话类型
+       * @param cb			取消置顶会话设置结果的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    cancelToStickTopSession(session_id: string, to_type: number, cb: CancelToStickTopSessionCallback): void;
+    /** 查询指定数量的最后会话数据
+       * @param limit		要返回的最大数量
+       * @param cb			查询会话列表的回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void 无返回值
+       */
+    queryLastFewSessionAsync(limit: number, cb: QuerySessionListCallback, jsonExtension: string): void;
+    /** 查询会话列表,可指定最后一条会话消息要排除掉的类型(列表)
+       * @param msg_excluded_type_list 最后一条会话消息要排除掉的类型(列表),如果不排除任何消息,传入空列表
+       * @param cb			查询会话列表的回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void 无返回值
+       */
+    queryAllRecentSessionAsync(msg_excluded_type_list: Array<NIMMessageType>, cb: QuerySessionListCallback, jsonExtension: string): void;
+    /** 删除最近联系人
+       * @param to_type		会话类型，双人0，群组1 (nim_msglog_def.h)
+       * @param id			对方的account id或者群组tid。
+       * @param delete_roaming 是否同时删除漫游消息
+       * @param cb			最近会话列表项变更的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    deleteRecentSession(type: NIMSessionType, id: string, cb: SessionChangeCallback, delete_roaming: boolean): void;
+    /** 删除全部最近联系人
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			最近会话列表项变更的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    deleteAllRecentSession(cb: SessionChangeCallback, jsonExtension: string): void;
+    /** 删除某会话的漫游消息
+       * @param to_type		会话类型，双人0，群组1 (nim_msglog_def.h)
+       * @param id			对方的account id或者群组tid。
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			删除结果 回调回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    deleteSessionRoamingMessage(to_type: number, session_id: string, cb: DeleteSessionRoamingMessageCallback, ext: string): boolean;
+    /** 最近联系人项未读数清零
+       * @param to_type		会话类型，双人0，群组1 (nim_msglog_def.h)
+       * @param id			对方的account id或者群组tid。
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			最近会话列表项变更的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    setUnreadCountZeroAsync(type: NIMSessionType, id: string, cb: SessionChangeCallback, jsonExtension: string): boolean;
+    /** 最近联系人项未读数清零
+       * @param is_super_team	会话列表中的会话是否是超大群会话
+       * @param zero_list	清零的会话信息列表。
+       * @param cb			最近会话列表项变更的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    setMultiUnreadCountZeroAsync(is_super_team: boolean, zero_list: Array<MultiUnreadCountZeroInfo>, cb: SetMultiUnreadCountZeroAsyncCallback): boolean;
+    /** 设置会话项是否置顶(置顶属性只保存在本地)
+       * @param to_type		会话类型
+       * @param id			对方的account id或者群组tid。
+       * @param top			true - 置顶 false - 取消置顶
+       * @param cb			回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    setSessionTop(type: NIMSessionType, id: string, top: boolean, cb: SessionChangeCallback, jsonExtension: string): boolean;
+    /** 设置会话项扩展数据(扩展数据只保存在本地)
+       * @param to_type		会话类型
+       * @param id			对方的account id或者群组tid。
+       * @param data			扩展数据,建议使用灵活可扩展的数据结构,例如Json
+       * @param cb			回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    setSessionExtendData(type: NIMSessionType, id: string, data: string, cb: SessionChangeCallback, jsonExtension: string): boolean;
+    /** 最近联系人项全部未读数清零
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			最近会话列表项变更的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    setAllUnreadCountZeroAsync(cb: SessionChangeCallback, jsonExtension: string): boolean;
+    /** 根据给定的id查询相应会话的信息
+       * @param to_type		会话类型
+       * @param id			对方的account id或者群组tid。
+       * @param cb			会话信息查询结果的回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    querySessionDataById(type: NIMSessionType, id: string, cb: QuerySessionDataCallback, jsonExtension: string): void;
+    /** 查询会话是漫游消息未拉取信息
+       * @param session_id		会话id
+       * @param to_type			会话类型
+       * @param cb			    查询会话是漫游消息未拉取信息回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    queryHasmoreRoammsg(session_id: string, to_type: number, cb: QueryHasmoreRoammsgCallback): void;
+    /** 查询所有漫游消息未拉取完全的会话
+       * @param cb	结果回调
+       * @return void 无返回值
+       */
+    queryAllHasmoreRoammsg(cb: QueryAllHasmoreRoammsgCallback): void;
+    /** 更新会话是漫游消息未拉取信息
+       * @param msg	对应的消息内容
+       * @param cb	结果回调
+       * @return void 无返回值
+       */
+    updateHasmoreRoammsg(msg: IMMessage, cb: UpdateHasmoreRoammsgCallback): void;
+    /** 删除会话是漫游消息未拉取信息
+       * @param session_id			会话id
+       * @param to_type			    会话类型
+       * @param cb	结果回调
+       * @return void 无返回值
+       */
+    deleteHasmoreRoammsg(session_id: string, to_type: NIMSessionType, cb: DeleteHasmoreRoammsgCallback): void;
+}

package/types/api/subscribe_event.d.ts

@@ -0,0 +1,87 @@
+/// <reference types="node" />
+import ev from 'events';
+import { NIMSubscribeEventAPI, EventData, PublishEventCallback, NIMEventType, NIMEventSubscribeSyncEventType, SubscribeEventCallback, UnSubscribeEventCallback, BatchUnSubscribeEventCallback, QuerySubscribeEventCallback } from '../def/subscribe_event_def';
+export declare interface NIMSubscribeEvent {
+    on(event: 'push', listener: () => void): this;
+    on(event: 'batchPush', listener: () => void): this;
+    once(event: 'push', listener: () => void): this;
+    once(event: 'batchPush', listener: () => void): this;
+}
+export declare class NIMSubscribeEvent extends ev.EventEmitter {
+    subscribeEvent: NIMSubscribeEventAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** 发布事件
+       * @param event_data	事件
+       * @param cb			发布事件回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 403:应用没开通事件服务
+       * 404:禁用了特定事件
+       * 414:参数错误
+       * 500:未知错误
+       * </pre>
+       */
+    publish(data: EventData, cb: PublishEventCallback, jsonExtension: string): boolean;
+    /** 订阅事件
+       * @param event_type		事件类型
+       * @param ttl			订阅有效期，单位：秒，范围：60s到30天
+       * @param sync_type		订阅后是否立即同步最新事件
+       * @param accid_list		要订阅的用户列表
+       * @param cb				订阅事件回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 414:参数错误
+       * 500:未知错误
+       * </pre>
+       */
+    subscribe(eventType: NIMEventType, ttl: number, syncType: NIMEventSubscribeSyncEventType, accids: Array<string>, cb: SubscribeEventCallback, jsonExtension: string): boolean;
+    /** 按账号取消指定事件的订阅关系
+       * @param event_type		事件类型
+       * @param accid_list		要取消订阅的用户列表
+       * @param cb				取消订阅事件回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 414:参数错误
+       * 500:未知错误
+       * </pre>
+       */
+    unSubscribe(eventType: NIMEventType, accids: Array<string>, cb: UnSubscribeEventCallback, jsonExtension: string): boolean;
+    /** 取消指定事件的全部订阅关系
+       * @param event_type		事件类型
+       * @param cb				取消订阅事件回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 414:参数错误
+       * 500:未知错误
+       * </pre>
+       */
+    batchUnSubscribe(eventType: NIMEventType, cb: BatchUnSubscribeEventCallback, jsonExtension: string): boolean;
+    /** 按账号查询指定事件订阅关系
+       * @param event_type		事件类型
+       * @param accid_list		要查询订阅关系的用户列表
+       * @param cb				查询订阅关系回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 414:参数错误
+       * 500:未知错误
+       * </pre>
+       */
+    querySubscribe(eventType: NIMEventType, accids: Array<string>, cb: QuerySubscribeEventCallback, jsonExtension: string): void;
+}