node-nim 10.4.0-beta.1 → 10.6.0-beta.0

package/types/v2/v2_nim_client.d.ts

@@ -10,17 +10,19 @@ import { V2NIMTeamService } from './v2_nim_team_service';
 import { V2NIMSettingService } from './v2_nim_setting_service';
 import { V2NIMFriendService } from './v2_nim_friend_service';
 import { V2NIMUserService } from './v2_nim_user_service';
-import { V2NIMAIService } from "./v2_nim_ai_service";
-import { V2NIMSignallingService } from "./v2_nim_signalling_service";
-import { V2NIMSubscriptionService } from "./v2_nim_subscription_service";
-import { V2NIMConversationIdUtil, V2NIMMessageCreator, V2NIMMessageConverter, V2NIMClientAntispamUtil, V2NIMStorageUtil } from './v2_nim_utilities';
-export declare interface V2NIMClientEvents {
+import { V2NIMAIService } from './v2_nim_ai_service';
+import { V2NIMSignallingService } from './v2_nim_signalling_service';
+import { V2NIMSubscriptionService } from './v2_nim_subscription_service';
+import { V2NIMPassthroughService } from './v2_nim_passthrough_service';
+import { V2NIMConversationIdUtil, V2NIMMessageCreator, V2NIMMessageConverter, V2NIMClientAntispamUtil, V2NIMStorageUtil, V2NIMMessageAttachmentCreator } from './v2_nim_utilities';
+export declare interface V2NIMClientListener {
 }
-export declare class V2NIMClient extends EventEmitter<V2NIMClientEvents> {
+export declare class V2NIMClient extends EventEmitter<V2NIMClientListener> {
     instance: any;
     conversationIdUtil: V2NIMConversationIdUtil | null;
     messageCreator: V2NIMMessageCreator | null;
     messageConverter: V2NIMMessageConverter | null;
+    messageAttachmentCreator: V2NIMMessageAttachmentCreator | null;
     clientAntispamUtil: V2NIMClientAntispamUtil | null;
     storageUtil: V2NIMStorageUtil | null;
     loginService: V2NIMLoginService | null;
@@ -36,62 +38,154 @@ export declare class V2NIMClient extends EventEmitter<V2NIMClientEvents> {
     aiService: V2NIMAIService | null;
     signallingService: V2NIMSignallingService | null;
     subscriptionService: V2NIMSubscriptionService | null;
+    passthroughService: V2NIMPassthroughService | null;
     constructor();
     /**
-     * 初始化
+     * @brief 初始化
      * @param option - 初始化选项
      * @returns V2NIMError | null
      * @example
+     * ```javascript
+     * await client.init({
+     *     appkey: 'your app key'
+     * })
+     * if (error) {
+     *     console.error(error)
+     * }
+     * ```
      */
     init(option: V2NIMInitOption): V2NIMError | null;
-    /**  @brief 反初始化
-     * @return V2NIMError | null
+    /**
+     * @brief 反初始化
+     * @returns V2NIMError | null
+     * @example
+     * ```javascript
+     * await client.uninit()
+     * if (error) {
+     *     console.error(error)
+     * }
+     * ```
      */
     uninit(): V2NIMError | null;
-    /** @brief 获取登录服务
-     * @return V2NIMLoginService
+    /**
+     * @brief 更新 appKey
+     * @param appKey - 新的 App key
+     * @returns V2NIMError | null
+     * @example
+     * ```javascript
+     * await client.updateAppKey('your new app key')
+     * if (error) {
+     *     console.error(error)
+     * }
+     * ```
+     */
+    updateAppKey(appKey: string): V2NIMError | null;
+    /**
+     * @brief 获取登录服务
+     * @returns V2NIMLoginService
+     * @example
+     * ```javascript
+     * const loginService = client.getLoginService()
+     * ```
      */
     getLoginService(): V2NIMLoginService | null;
-    /** @brief 获取会话服务
-    /* @return V2NIMConversationService
-    */
+    /**
+     * @brief 获取会话服务
+     * @returns V2NIMConversationService
+     * @example
+     * ```javascript
+     * const conversationService = client.getConversationService()
+     * ```
+     */
     getConversationService(): V2NIMConversationService | null;
-    /** @brief 获取会话分组服务
-     * @return V2NIMConversationGroupService
+    /**
+     * @brief 获取会话分组服务
+     * @returns V2NIMConversationGroupService
+     * @example
+     * ```javascript
+     * const conversationGroupService = client.getConversationGroupService()
+     * ```
      */
     getConversationGroupService(): V2NIMConversationGroupService | null;
-    /** @brief 获取消息服务
-     * @return V2NIMMessageService
+    /**
+     * @brief 获取消息服务
+     * @returns V2NIMMessageService
+     * @example
+     * ```javascript
+     * const messageService = client.getMessageService()
+     * ```
      */
     getMessageService(): V2NIMMessageService | null;
-    /** @brief 获取ai服务
-     * @return V2NIMAIService
+    /**
+     * @brief 获取ai服务
+     * @returns V2NIMAIService
+     * @example
+     * ```javascript
+     * const aiService = client.getAIService()
+     * ```
      */
     getAIService(): V2NIMAIService | null;
-    /** @brief 获取通知服务
-     * @return V2NIMNotificationService
+    /**
+     * @brief 获取通知服务
+     * @returns V2NIMNotificationService
+     * @example
+     * ```javascript
+     * const notificationService = client.getNotificationService()
+     * ```
      */
     getNotificationService(): V2NIMNotificationService | null;
-    /** @brief 获取存储服务
-     * @return V2NIMStorageService
+    /**
+     * @brief 获取存储服务
+     * @returns V2NIMStorageService
+     * @example
+     * ```javascript
+     * const storageService = client.getStorageService()
+     * ```
      */
     getStorageService(): V2NIMStorageService | null;
-    /** @brief 获取群组服务
-     * @return V2NIMTeamService
+    /**
+     * @brief 获取群组服务
+     * @returns V2NIMTeamService
+     * @example
+     * ```javascript
+     * const teamService = client.getTeamService()
+     * ```
      */
     getTeamService(): V2NIMTeamService | null;
-    /** @brief 获取设置服务
-     * @return V2NIMSettingService
+    /**
+     * @brief 获取设置服务
+     * @returns V2NIMSettingService
+     * @example
+     * ```javascript
+     * const settingService = client.getSettingService()
+     * ```
      */
     getSettingService(): V2NIMSettingService | null;
     /**
      * @brief 获取独立信令服务
-     * @return V2NIMSignallingService
+     * @returns V2NIMSignallingService
+     * @example
+     * ```javascript
+     * const signallingService = client.getSignallingService()
+     * ```
      */
     getSignallingService(): V2NIMSignallingService | null;
     /**
      * @brief 获取订阅服务
-     * @return V2NIMSubscriptionService
+     * @returns V2NIMSubscriptionService
+     * @example
+     * ```javascript
+     * const subscriptionService = client.getSubscriptionService()
+     * ```
      */
     getSubscriptionService(): V2NIMSubscriptionService | null;
+    /**
+     * @brief 获取透传服务
+     * @returns V2NIMPassthroughService
+     * @example
+     * ```javascript
+     * const passthroughService = client.getPasseThroughService()
+     * ```
+     */
+    getPasseThroughService(): V2NIMPassthroughService | null;
 }

package/types/v2/v2_nim_conversation_group_service.d.ts

@@ -1,6 +1,6 @@
 import { V2NIMConversationGroup, V2NIMConversation, V2NIMConversationGroupResult, V2NIMConversationOperationResult } from 'ts/v2_def/v2_nim_struct_def';
 import { EventEmitter } from 'eventemitter3';
-export declare interface V2NIMConversationGroupServiceEvents {
+export declare interface V2NIMConversationGroupListener {
     /** 会话分组创建通知 */
     conversationGroupCreated: [V2NIMConversationGroup];
     /** 会话分组删除通知 */
@@ -12,43 +12,91 @@ export declare interface V2NIMConversationGroupServiceEvents {
     /** 会话移出会话分组通知 */
     conversationsRemovedFromGroup: [string, string[]];
 }
-export declare class V2NIMConversationGroupService extends EventEmitter<V2NIMConversationGroupServiceEvents> {
+export declare class V2NIMConversationGroupService extends EventEmitter<V2NIMConversationGroupListener> {
     instance: any;
     constructor();
-    /** @brief 创建会话分组
+    /**
+     * @brief 创建会话分组
      * @param name 会话分组名称
      * @param conversationIds 会话 ID 列表
+     * @returns V2NIMConversationGroupResult
+     * @example
+     * ```javascript
+     * const result = await v2.conversationGroupService.createConversationGroup('group1', 'extension', ['conversation1', 'conversation2'])
+     * ```
      */
     createConversationGroup(name: string, serverExtension?: string, conversationIds?: string[]): Promise<V2NIMConversationGroupResult>;
-    /** @brief 删除会话分组
+    /**
+     * @brief 删除会话分组
      * @param groupId 会话分组 ID
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationGroupService.deleteConversationGroup('group1')
+     * ```
      */
     deleteConversationGroup(groupId: string): Promise<void>;
-    /** @brief 更新会话分组
+    /**
+     * @brief 更新会话分组
      * @param groupId 会话分组 ID
      * @param name 新的会话分组名称
      * @param serverExtension 扩展字段
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationGroupService.updateConversationGroup('group1', 'newName', 'newExtension')
+     * ```
      */
     updateConversationGroup(groupId: string, name?: string, serverExtension?: string): Promise<void>;
-    /** @brief 添加会话到会话分组
+    /**
+     * @brief 添加会话到会话分组
      * @param groupId 会话分组 ID
      * @param conversationIds 会话 ID 列表
+     * @returns Array<V2NIMConversationOperationResult>
+     * @example
+     * ```javascript
+     * const result = await v2.conversationGroupService.addConversationsToGroup('group1', ['conversation1', 'conversation2'])
+     * ```
      */
     addConversationsToGroup(groupId: string, conversationIds: string[]): Promise<Array<V2NIMConversationOperationResult>>;
-    /** @brief 从会话分组中移除会话
+    /**
+     * @brief 从会话分组中移除会话
      * @param groupId 会话分组 ID
      * @param conversationIds 会话 ID 列表
+     * @returns Array<V2NIMConversationOperationResult>
+     * @example
+     * ```javascript
+     * const result = await v2.conversationGroupService.removeConversationsFromGroup('group1', ['conversation1', 'conversation2'])
+     * ```
      */
     removeConversationsFromGroup(groupId: string, conversationIds: string[]): Promise<Array<V2NIMConversationOperationResult>>;
-    /** @brief 获取会话分组信息
+    /**
+     * @brief 获取会话分组信息
      * @param groupId 会话分组 ID
+     * @returns V2NIMConversationGroup
+     * @example
+     * ```javascript
+     * const group = await v2.conversationGroupService.getConversationGroup('group1')
+     * ```
      */
     getConversationGroup(groupId: string): Promise<V2NIMConversationGroup>;
-    /** @brief 获取会话分组列表
+    /**
+     * @brief 获取会话分组列表
+     * @returns Array<V2NIMConversationGroup>
+     * @example
+     * ```javascript
+     * const list = await v2.conversationGroupService.getConversationGroupList()
+     * ```
      */
     getConversationGroupList(): Promise<Array<V2NIMConversationGroup>>;
-    /** @brief 根据会话分组 ID 获取会话分组
-     * @param groupId 会话分组 ID
+    /**
+     * @brief 根据会话分组 ID 获取会话分组
+     * @param groupIds 会话分组 ID 列表
+     * @returns Array<V2NIMConversationGroup>
+     * @example
+     * ```javascript
+     * const list = await v2.conversationGroupService.getConversationGroupListByIds(['group1', 'group2'])
+     * ```
      */
     getConversationGroupListByIds(groupIds: string[]): Promise<Array<V2NIMConversationGroup>>;
 }

package/types/v2/v2_nim_conversation_service.d.ts

@@ -1,6 +1,7 @@
 import { V2NIMError, V2NIMConversation, V2NIMConversationFilter, V2NIMConversationOperationResult, V2NIMConversationUpdate, V2NIMConversationResult, V2NIMConversationOption } from 'ts/v2_def/v2_nim_struct_def';
 import { EventEmitter } from 'eventemitter3';
-export declare interface V2NIMConversationServiceEvents {
+import { V2NIMConversationType } from 'ts/v2_def/v2_nim_enum_def';
+export declare interface V2NIMConversationListener {
     /** 会话同步开始通知 */
     syncStarted: [];
     /** 会话同步完成通知 */
@@ -20,101 +21,223 @@ export declare interface V2NIMConversationServiceEvents {
     /** 同账号多端标记会话 ACK 通知时间戳变更 */
     conversationReadTimeUpdated: [string, number];
 }
-export declare class V2NIMConversationService extends EventEmitter<V2NIMConversationServiceEvents> {
+export declare class V2NIMConversationService extends EventEmitter<V2NIMConversationListener> {
     instance: any;
     constructor();
-    /** @brief 创建空会话
+    /**
+     * @brief 创建空会话
      * @param conversationId 会话 ID
+     * @returns V2NIMConversation
+     * @example
+     * ```javascript
+     * const conversation = await v2.conversationService.createConversation('conversation1')
+     * ```
      */
     createConversation(conversationId: string): Promise<V2NIMConversation>;
-    /** @brief 删除会话
+    /**
+     * @brief 删除会话
      * @param conversationId 会话 ID
      * @param clearMessage 是否清除会话消息
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.deleteConversation('conversation1', true)
+     * ```
      */
     deleteConversation(conversationId: string, clearMessage: boolean): Promise<void>;
-    /** @brief 批量删除会话
+    /**
+     * @brief 批量删除会话
      * @param conversationIds 会话ID列表
      * @param clearMessage 是否清除会话消息
+     * @returns Array<V2NIMConversationOperationResult>
+     * @example
+     * ```javascript
+     * const result = await v2.conversationService.deleteConversationListByIds(['conversation1', 'conversation2'], true)
+     * ```
      */
     deleteConversationListByIds(conversationIds: string[], clearMessage: boolean): Promise<Array<V2NIMConversationOperationResult>>;
-    /** @brief 置顶会话
+    /**
+     * @brief 置顶会话
      * @param conversationId 会话 ID
      * @param stickTop 是否置顶
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.stickTopConversation('conversation1', true)
+     * ```
      */
     stickTopConversation(conversationId: string, stickTop: boolean): Promise<void>;
-    /** @brief 更新会话
+    /**
+     * @brief 更新会话
      * @param conversationId 会话 ID
      * @param updateInfo 更新参数
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.updateConversation('conversation1', { name: 'newName' })
+     * ```
      */
     updateConversation(conversationId: string, updateInfo: V2NIMConversationUpdate): Promise<void>;
-    /** @brief 更新会话本地扩展
+    /**
+     * @brief 更新会话本地扩展
      * @param conversationId 会话 ID
      * @param localExtension 本地扩展
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.updateConversationLocalExtension('conversation1', 'newExtension')
+     * ```
      */
     updateConversationLocalExtension(conversationId: string, localExtension: string): Promise<void>;
     /** @brief 获取会话
      * @param conversationId 会话 ID
+     * @returns V2NIMConversation
+     * @example
+     * ```javascript
+     * const conversation = await v2.conversationService.getConversation('conversation1')
+     * ```
      */
     getConversation(conversationId: string): Promise<V2NIMConversation>;
-    /** @brief 分页获取会话列表
+    /**
+     * @brief 分页获取会话列表
      * @param offset 分页偏移, 首页传 0, 后续拉取采用上一次返还的 offset
      * @param limit 分页数量
+     * @returns V2NIMConversationResult
+     * @example
+     * ```javascript
+     * const result = await v2.conversationService.getConversationList(0, 10)
+     * ```
      */
     getConversationList(offset: number, limit: number): Promise<V2NIMConversationResult>;
-    /** @brief 根据会话ID获取会话列表
+    /**
+     * @brief 根据会话ID获取会话列表
      * @param conversationIds 会话ID列表
+     * @returns Array<V2NIMConversation>
+     * @example
+     * ```javascript
+     * const list = await v2.conversationService.getConversationListByIds(['conversation1', 'conversation2'])
+     * ```
      */
     getConversationListByIds(conversationIds: string[]): Promise<Array<V2NIMConversation>>;
-    /** @brief 根据条件筛选分页获取会话列表
+    /**
+     * @brief 根据条件筛选分页获取会话列表
      * @param offset 分页偏移, 首页传 0, 后续拉取采用上一次返还的 offset
      * @param limit 分页数量
      * @param option 查询参数
+     * @returns V2NIMConversationResult
+     * @example
+     * ```javascript
+     * const result = await v2.conversationService.getConversationListByOption(0, 10, {
+     *   conversationTypes: [1, 2]
+     * })
+     * ```
      */
     getConversationListByOption(offset: number, limit: number, option: V2NIMConversationOption): Promise<V2NIMConversationResult>;
-    /** @brief 获取会话未读总数
-     * @param conversationId 会话 ID
-     * @return uint32_t 未读总数
+    /**
+     * @brief 获取会话未读总数
+     * @returns number
+     * @example
+     * ```javascript
+     * const count = await v2.conversationService.getTotalUnreadCount()
+     * ```
      */
     getTotalUnreadCount(): number;
     /** @brief 根据会话 ID 列表获取未读总数
      * @param conversationIds 会话 ID 列表
+     * @returns number
+     * @example
+     * ```javascript
+     * const count = await v2.conversationService.getUnreadCountByIds(['conversation1', 'conversation2'])
+     * ```
      */
     getUnreadCountByIds(conversationIds: string[]): Promise<number>;
-    /** @brief 根据过滤条件获取会话未读总数
+    /**
+     * @brief 根据过滤条件获取会话未读总数
      * @param filter 过滤条件
+     * @returns number
+     * @example
+     * ```javascript
+     * const count = await v2.conversationService.getUnreadCountByFilter({ conversationTypes: [1, 2] })
+     * ```
      */
     getUnreadCountByFilter(filter: V2NIMConversationFilter): Promise<number>;
-    /** @brief 清除会话总未读数
+    /**
+     * @brief 清除会话总未读数
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.clearTotalUnreadCount()
+     * ```
      */
     clearTotalUnreadCount(): Promise<void>;
-    /** @brief 根据会话 ID 列表清除会话未读数
+    /**
+     * @brief 根据会话 ID 列表清除会话未读数
      * @param conversationIds 会话 ID 列表
+     * @returns Array<V2NIMConversationOperationResult>
+     * @example
+     * ```javascript
+     * const result = await v2.conversationService.clearUnreadCountByIds(['conversation1', 'conversation2'])
+     * ```
      */
     clearUnreadCountByIds(conversationIds: string[]): Promise<Array<V2NIMConversationOperationResult>>;
-    /** @brief 根据会话类型清除会话未读数
+    /**
+     * @brief 根据会话类型清除会话未读数
      * @param conversationTypes 会话类型列表
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.clearUnreadCountByTypes([1, 2])
+     * ```
      */
     clearUnreadCountByTypes(conversationTypes: V2NIMConversationType[]): Promise<void>;
-    /** @brief 根据会话分组清除会话未读数
+    /**
+     * @brief 根据会话分组清除会话未读数
      * @param groupId 会话分组ID
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.clearUnreadCountByGroupId('groupId')
+     * ```
      */
     clearUnreadCountByGroupId(groupId: string): Promise<void>;
-    /** @brief 标记会话已读时间戳 */
-    /** @param conversationId 要标记的会话 ID */
-    /** @return void */
+    /**
+     * @brief 标记会话已读时间戳
+     * @param conversationId 要标记的会话 ID
+     * @returns number
+     * @example
+     * ```javascript
+     * const time = await v2.conversationService.markConversationRead('conversation1')
+     * ```
+     */
     markConversationRead(conversationId: string): Promise<number>;
-    /** 获取会话已读时间戳 */
-    /** @param conversationId 会话 ID */
-    /** @return Promise<number> 时间戳 */
+    /**
+     * @brief 获取会话已读时间戳
+     * @param conversationId 会话 ID
+     * @returns Promise<number> 时间戳
+     * @example
+     * ```javascript
+     * const time = await v2.conversationService.getConversationReadTime('conversation1')
+     * ```
+     */
     getConversationReadTime(conversationId: string): Promise<number>;
-    /** @brief 订阅指定过滤条件的会话未读数
+    /**
+     * @brief 订阅指定过滤条件的会话未读数
      * @param filter 过滤条件
-     * @return void
+     * @returns null | V2NIMError
+     * @example
+     * ```javascript
+     * await v2.conversationService.subscribeUnreadCountByFilter({ conversationTypes: [1, 2] })
+     * ```
      */
     subscribeUnreadCountByFilter(filter: V2NIMConversationFilter): null | V2NIMError;
-    /** @brief 取消订阅指定过滤条件的会话未读数
+    /**
+     * @brief 取消订阅指定过滤条件的会话未读数
      * @param filter 过滤条件
-     * @return void
+     * @returns null | V2NIMError
+     * @example
+     * ```javascript
+     * await v2.conversationService.unsubscribeUnreadCountByFilter({ conversationTypes: [1, 2] })
+     * ```
      */
     unsubscribeUnreadCountByFilter(filter: V2NIMConversationFilter): null | V2NIMError;
 }