node-nim 9.2.8-rc.1 → 9.3.0-rc.2

package/types/{api → nim}/session.d.ts

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

package/types/{api → nim}/subscribe_event.d.ts

@@ -1,13 +1,13 @@
-/// <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: (rescode: number, result: EventData) => void): this;
-    on(event: 'batchPush', listener: (rescode: number, result: Array<EventData>) => void): this;
-    once(event: 'push', listener: (rescode: number, result: EventData) => void): this;
-    once(event: 'batchPush', listener: (rescode: number, result: Array<EventData>) => void): this;
+import { EventEmitter } from 'eventemitter3';
+import { NIMSubscribeEventAPI, EventData, PublishEventCallback, NIMEventType, NIMEventSubscribeSyncEventType, SubscribeEventCallback, UnSubscribeEventCallback, BatchUnSubscribeEventCallback, QuerySubscribeEventCallback, EventSubscribeData } from '../nim_def/subscribe_event_def';
+import { NIMResCode } from 'ts/nim_def/client_def';
+export declare interface NIMSubscribeEventEvents {
+    /** 订阅的事件 */
+    push: [number, EventData];
+    /** 批量接收订阅的事件 */
+    batchPush: [number, Array<EventData>];
 }
-export declare class NIMSubscribeEvent extends ev.EventEmitter {
+export declare class NIMSubscribeEvent extends EventEmitter<NIMSubscribeEventEvents> {
     subscribeEvent: NIMSubscribeEventAPI;
     constructor();
     /** 注册全局回调 */
@@ -16,7 +16,7 @@ export declare class NIMSubscribeEvent extends ev.EventEmitter {
      * @param event_data	事件
      * @param cb			发布事件回调函数
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @return bool 检查参数如果不符合要求则返回失败
+     * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
      * 200:成功
@@ -26,7 +26,7 @@ export declare class NIMSubscribeEvent extends ev.EventEmitter {
      * 500:未知错误
      * </pre>
      */
-    publish(data: EventData, cb: PublishEventCallback, jsonExtension: string): boolean;
+    publish(data: EventData, cb: PublishEventCallback, jsonExtension: string): Promise<[NIMResCode, number, EventData] | null>;
     /** 订阅事件
      * @param event_type		事件类型
      * @param ttl			订阅有效期，单位：秒，范围：60s到30天
@@ -34,7 +34,7 @@ export declare class NIMSubscribeEvent extends ev.EventEmitter {
      * @param accid_list		要订阅的用户列表
      * @param cb				订阅事件回调函数
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @return bool 检查参数如果不符合要求则返回失败
+     * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
      * 200:成功
@@ -42,13 +42,13 @@ export declare class NIMSubscribeEvent extends ev.EventEmitter {
      * 500:未知错误
      * </pre>
      */
-    subscribe(eventType: NIMEventType, ttl: number, syncType: NIMEventSubscribeSyncEventType, accids: Array<string>, cb: SubscribeEventCallback, jsonExtension: string): boolean;
+    subscribe(eventType: NIMEventType, ttl: number, syncType: NIMEventSubscribeSyncEventType, accids: Array<string>, cb: SubscribeEventCallback, jsonExtension: string): Promise<[NIMResCode, number, Array<string>] | null>;
     /** 按账号取消指定事件的订阅关系
      * @param event_type		事件类型
      * @param accid_list		要取消订阅的用户列表
      * @param cb				取消订阅事件回调函数
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @return bool 检查参数如果不符合要求则返回失败
+     * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
      * 200:成功
@@ -56,12 +56,12 @@ export declare class NIMSubscribeEvent extends ev.EventEmitter {
      * 500:未知错误
      * </pre>
      */
-    unSubscribe(eventType: NIMEventType, accids: Array<string>, cb: UnSubscribeEventCallback, jsonExtension: string): boolean;
+    unSubscribe(eventType: NIMEventType, accids: Array<string>, cb: UnSubscribeEventCallback, jsonExtension: string): Promise<[NIMResCode, number, Array<string>] | null>;
     /** 取消指定事件的全部订阅关系
      * @param event_type		事件类型
      * @param cb				取消订阅事件回调函数
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @return bool 检查参数如果不符合要求则返回失败
+     * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
      * 200:成功
@@ -69,13 +69,13 @@ export declare class NIMSubscribeEvent extends ev.EventEmitter {
      * 500:未知错误
      * </pre>
      */
-    batchUnSubscribe(eventType: NIMEventType, cb: BatchUnSubscribeEventCallback, jsonExtension: string): boolean;
+    batchUnSubscribe(eventType: NIMEventType, cb: BatchUnSubscribeEventCallback, jsonExtension: string): Promise<[NIMResCode, number] | null>;
     /** 按账号查询指定事件订阅关系
      * @param event_type		事件类型
      * @param accid_list		要查询订阅关系的用户列表
      * @param cb				查询订阅关系回调函数
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @return bool 检查参数如果不符合要求则返回失败
+     * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
      * 200:成功
@@ -83,5 +83,5 @@ export declare class NIMSubscribeEvent extends ev.EventEmitter {
      * 500:未知错误
      * </pre>
      */
-    querySubscribe(eventType: NIMEventType, accids: Array<string>, cb: QuerySubscribeEventCallback, jsonExtension: string): void;
+    querySubscribe(eventType: NIMEventType, accids: Array<string>, cb: QuerySubscribeEventCallback, jsonExtension: string): Promise<[NIMResCode, number, Array<EventSubscribeData>]>;
 }