node-nim 10.5.2 → 10.6.0

package/types/v2/v2_nim_chatroom_service.d.ts

@@ -1,7 +1,7 @@
 import EventEmitter from 'eventemitter3';
 import { V2NIMChatroomMessage, V2NIMChatroomMember, V2NIMChatroomInfo, V2NIMSendChatroomMessageParams, V2NIMSendChatroomMessageResult, V2NIMChatroomMemberQueryOption, V2NIMChatroomMemberListResult, V2NIMChatroomMessageListOption, V2NIMChatroomMemberRoleUpdateParams, V2NIMChatroomUpdateParams, V2NIMAntispamConfig, V2NIMChatroomSelfMemberUpdateParams, V2NIMChatroomTagTempChatBannedParams, V2NIMChatroomTagMemberOption, V2NIMChatroomLocationConfig, V2NIMChatroomTagsUpdateParams, V2NIMChatroomTagMessageOption } from 'ts/v2_def/v2_nim_struct_def';
 import { V2NIMChatroomMemberRole } from 'ts/v2_def/v2_nim_enum_def';
-export declare interface V2NIMChatroomServiceEvents {
+export declare interface V2NIMChatroomListener {
     /** 收到新消息 */
     receiveMessages: [V2NIMChatroomMessage[]];
     /** 聊天室成员进入 */
@@ -28,90 +28,226 @@ export declare interface V2NIMChatroomServiceEvents {
     sendMessage: [V2NIMChatroomMessage];
 }
 /** @brief 聊天室服务 */
-export declare class V2NIMChatroomService extends EventEmitter<V2NIMChatroomServiceEvents> {
+export declare class V2NIMChatroomService extends EventEmitter<V2NIMChatroomListener> {
     instance: any;
     constructor(instanceId: number);
-    /** @brief 发送消息 */
-    /** @param message 需要发送的消息体 */
-    /** @param params 发送消息相关配置参数 */
-    /** @return void */
+    /**
+     * @brief 发送消息
+     * @param message 需要发送的消息体
+     * @param params 发送消息相关配置参数
+     * @returns void
+     * @example
+     * ```javascript
+     * const message = V2NIMChatroomMessageCreator.createTextMessage('Hello NTES IM')
+     * await chatroomService.sendMessage(message, {})
+     * ```
+     */
     sendMessage(message: V2NIMChatroomMessage, params: V2NIMSendChatroomMessageParams): Promise<V2NIMSendChatroomMessageResult>;
-    /** @brief 取消文件消息附件上传 */
-    /** @param message 要取消上传的文件消息 */
+    /**
+     * @brief 取消上传消息附件
+     * @param message 要取消上传的文件消息
+     * @returns void
+     * @example
+     * ```javascript
+     * await chatroomService.cancelMessageAttachmentUpload(message)
+     * ```
+     */
     cancelMessageAttachmentUpload(message: V2NIMChatroomMessage): Promise<void>;
-    /** @brief 分页获取聊天室成员列表 */
-    /** @param queryOption 查询选项 */
-    /** @return void */
+    /**
+     * @brief 查询聊天室成员列表
+     * @param queryOption 查询选项
+     * @returns V2NIMChatroomMemberListResult
+     * @example
+     * ```javascript
+     * const result = await chatroomService.getMemberListByOption({
+     *     limit: 10
+     * })
+     * console.log(result)
+     * ```
+     */
     getMemberListByOption(queryOption: V2NIMChatroomMemberQueryOption): Promise<V2NIMChatroomMemberListResult>;
-    /** @brief 查询历史消息 */
-    /** @param option 查询选项 */
-    /** @return void */
+    /**
+     * @brief 查询聊天室消息列表
+     * @param option 查询选项
+     * @returns Array<V2NIMChatroomMessage>
+     * @example
+     * ```javascript
+     * const result = await chatroomService.getMessageList({
+     *     limit: 10
+     * })
+     * console.log(result)
+     * ```
+     */
     getMessageList(option: V2NIMChatroomMessageListOption): Promise<Array<V2NIMChatroomMessage>>;
-    /** @brief 更新聊天室成员角色 */
-    /** @param accountId 聊天室成员 id */
-    /** @param upadateParams 更新参数 */
-    /** @return void */
+    /**
+     * @brief 更新聊天室成员角色
+     * @param accountId 聊天室成员 id
+     * @param upadateParams 更新参数
+     * @returns void
+     * @example
+     * ```javascript
+     * await chatroomService.updateMemberRole('accountId', {
+     *     memberRole: 2
+     * })
+     * ```
+     */
     updateMemberRole(accountId: string, upadateParams: V2NIMChatroomMemberRoleUpdateParams): Promise<void>;
-    /** @brief 设置聊天室成员黑名单状态 */
-    /** @param accountId 聊天室成员 id */
-    /** @param blocked 黑名单状态 */
-    /** @param notificationExtension 通知扩展字段 */
-    /** @return void */
+    /**
+     * @brief 设置聊天室成员黑名单状态
+     * @param accountId 聊天室成员 id
+     * @param blocked 黑名单状态
+     * @param notificationExtension 通知扩展字段
+     * @returns void
+     * @example
+     * ```javascript
+     * await chatroomService.setMemberBlockedStatus('accountId', true, 'your notification extension')
+     * ```
+     */
     setMemberBlockedStatus(accountId: string, blocked: boolean, notificationExtension: string): Promise<void>;
-    /** @brief 设置聊天室成员禁言状态 */
-    /** @param accountId 聊天室成员 id */
-    /** @param chatBanned 禁言状态 */
-    /** @param notificationExtension 通知扩展字段 */
-    /** @return void */
+    /**
+     * @brief 设置聊天室成员禁言状态
+     * @param accountId 聊天室成员 id
+     * @param chatBanned 禁言状态
+     * @param notificationExtension 通知扩展字段
+     * @returns void
+     * @example
+     * ```javascript
+     * await chatroomService.setMemberChatBannedStatus('accountId', true, 'your notification extension')
+     * ```
+     */
     setMemberChatBannedStatus(accountId: string, chatBanned: boolean, notificationExtension: string): Promise<void>;
-    /** @brief 设置聊天室成员临时禁言状态 */
-    /** @param accountId 聊天室成员 id */
-    /** @param tempChatBannedDuration 临时禁言时长, 单位秒, 0 表示取消临时禁言 */
-    /** @param notificationEnabled 是否发送通知 */
-    /** @param notificationExtension 通知扩展字段 */
-    /** @return void */
+    /**
+     * @brief 设置聊天室成员临时禁言状态
+     * @param accountId 聊天室成员 id
+     * @param tempChatBannedDuration 临时禁言时长, 单位秒, 0 表示取消临时禁言
+     * @param notificationEnabled 是否发送通知
+     * @param notificationExtension 通知扩展字段
+     * @returns void
+     * @example
+     * ```javascript
+     * await chatroomService.setMemberTempChatBanned('accountId', 10, true, 'your notification extension')
+     * ```
+     */
     setMemberTempChatBanned(accountId: string, tempChatBannedDuration: number, notificationEnabled: boolean, notificationExtension: string): Promise<void>;
-    /** @brief 更新聊天室信息 */
-    /** @param updateParams 更新参数 */
-    /** @param antispamConfig 反垃圾配置 */
-    /** @return void */
+    /**
+     * @brief 更新聊天室信息
+     * @param updateParams 更新参数
+     * @param antispamConfig 反垃圾配置
+     * @returns void
+     * @example
+     * ```javascript
+     * await chatroomService.updateChatroomInfo({
+     *     roomName: 'new room name'
+     * }, {})
+     * ```
+     */
     updateChatroomInfo(updateParams: V2NIMChatroomUpdateParams, antispamConfig: V2NIMAntispamConfig): Promise<void>;
-    /** @brief 更新自己在聊天室的成员信息 */
-    /** @param updateParams 更新参数 */
-    /** @param antispamConfig 反垃圾配置 */
-    /** @return void */
+    /**
+     * @brief 更新自己在聊天室的成员信息
+     * @param updateParams 更新参数
+     * @param antispamConfig 反垃圾配置
+     * @returns void
+     * @example
+     * ```javascript
+     * await chatroomService.updateSelfMemberInfo({
+     *     roomNick: 'new room nickname'
+     * }, {})
+     * ```
+     */
     updateSelfMemberInfo(updateParams: V2NIMChatroomSelfMemberUpdateParams, antispamConfig: V2NIMAntispamConfig): Promise<void>;
-    /** @brief 根据账号列表查询成员信息 */
-    /** @param accountIds 账号列表 */
-    /** @return void */
+    /**
+     * @param accountIds 账号列表
+     * @returns Array<V2NIMChatroomMember>
+     * @example
+     * ```javascript
+     * const result = await chatroomService.getMemberByIds(['accountId1', 'accountId2'])
+     * console.log(result)
+     * ```
+     */
     getMemberByIds(accountIds: Array<string>): Promise<Array<V2NIMChatroomMember>>;
-    /** @brief 踢出聊天室成员 */
-    /** @param accountId 聊天室成员 id */
-    /** @param notificationExtension 通知扩展字段 */
-    /** @return void */
+    /**
+     * @brief 踢出聊天室成员
+     * @param accountId 聊天室成员 id
+     * @param notificationExtension 通知扩展字段
+     * @returns void
+     * @example
+     * ```javascript
+     * await chatroomService.kickMember('accountId', 'your notification extension')
+     * ```
+     */
     kickMember(accountId: string, notificationExtension: string): Promise<void>;
-    /** @brief 按聊天室标签临时禁言 */
-    /** @param params 设置标签禁言的参数 */
-    /** @return void */
+    /**
+     * @brief 按聊天室标签临时禁言
+     * @param params 设置标签禁言的参数
+     * @returns void
+     * @example
+     * ```javascript
+     * await chatroomService.setTempChatBannedByTag({
+     *     targetTag: 'tag',
+     *     duration: 10
+     * })
+     * ```
+     */
     setTempChatBannedByTag(params: V2NIMChatroomTagTempChatBannedParams): Promise<void>;
-    /** @brief 根据标签查询成员列表 */
-    /** @param option 查询成员列表的参数 */
-    /** @return void */
+    /**
+     * @brief 根据标签查询成员列表
+     * @param option 查询成员列表的参数
+     * @returns V2NIMChatroomMemberListResult
+     * @example
+     * ```javascript
+     * const result = await chatroomService.getMemberListByTag({
+     *     tag: 'tag',
+     *     limit: 10
+     * })
+     * ```
+     */
     getMemberListByTag(option: V2NIMChatroomTagMemberOption): Promise<V2NIMChatroomMemberListResult>;
-    /** @brief 查询某个标签下的成员人数 */
-    /** @param tag 标签 */
-    /** @return void */
+    /**
+     * @brief 查询某个标签下的成员人数
+     * @param tag 标签
+     * @returns number
+     * @example
+     * ```javascript
+     * const count = await chatroomService.getMemberCountByTag('tag')
+     * ```
+     */
     getMemberCountByTag(tag: string): Promise<number>;
-    /** @brief 更新坐标信息 */
-    /** @param locationConfig 坐标信息 */
-    /** @return void */
+    /**
+     * @brief 更新坐标信息
+     * @param locationConfig 坐标信息
+     * @returns void
+     * @example
+     * ```javascript
+     * await chatroomService.updateChatroomLocationInfo({
+     *     latitude: 30.5,
+     *     longitude: 120.5
+     * })
+     * ```
+     */
     updateChatroomLocationInfo(locationConfig: V2NIMChatroomLocationConfig): Promise<void>;
-    /** @brief 更新聊天室 tag 信息 */
-    /** @param updateParams tag 更新的参数 */
-    /** @return void */
+    /**
+     * @brief 更新聊天室 tag 信息
+     * @param updateParams tag 更新的参数
+     * @returns void
+     * @example
+     * ```javascript
+     * await chatroomService.updateChatroomTags({
+     *     tags: ['tag1', 'tag2']
+     * })
+     * ```
+     */
     updateChatroomTags(updateParams: V2NIMChatroomTagsUpdateParams): Promise<void>;
-    /** @brief 根据标签查询消息列表 */
-    /** @param messageOption 查询参数 */
-    /** @return void */
+    /**
+     * @brief 根据标签查询消息列表
+     * @param messageOption 查询参数
+     * @returns Array<V2NIMChatroomMessage>
+     * @example
+     * ```javascript
+     * const result = await chatroomService.getMessageListByTag({
+     *     tags: ['tag1', 'tag2'],
+     *     limit: 10
+     * })
+     * ```
+     */
     getMessageListByTag(messageOption: V2NIMChatroomTagMessageOption): Promise<Array<V2NIMChatroomMessage>>;
 }

package/types/v2/v2_nim_client.d.ts

@@ -10,13 +10,14 @@ 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 { 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 V2NIMClientEvents {
+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;
@@ -37,68 +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 更新 appKey
      * @param appKey - 新的 App key
-     * @return V2NIMError | null
+     * @returns V2NIMError | null
+     * @example
+     * ```javascript
+     * await client.updateAppKey('your new app key')
+     * if (error) {
+     *     console.error(error)
+     * }
+     * ```
      */
     updateAppKey(appKey: string): V2NIMError | null;
-    /** @brief 获取登录服务
-     * @return V2NIMLoginService
+    /**
+     * @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>>;
 }