node-nim 10.5.2 → 10.6.0

package/types/v2/v2_nim_message_service.d.ts

@@ -1,7 +1,7 @@
 import { V2NIMMessage, V2NIMSendMessageParams, V2NIMSendMessageResult, V2NIMMessageRevokeParams, V2NIMMessageListOption, V2NIMMessageRefer, V2NIMThreadMessageListOption, V2NIMThreadMessageListResult, V2NIMClearHistoryMessageOption, V2NIMMessagePin, V2NIMMessageQuickCommentPushConfig, V2NIMMessageQuickComment, V2NIMAddCollectionParams, V2NIMCollection, V2NIMCollectionOption, V2NIMP2PMessageReadReceipt, V2NIMTeamMessageReadReceipt, V2NIMTeamMessageReadReceiptDetail, V2NIMVoiceToTextParams, V2NIMMessageSearchParams, V2NIMClearHistoryNotification, V2NIMMessageDeletedNotification, V2NIMMessagePinNotification, V2NIMMessageQuickCommentNotification, V2NIMMessageRevokeNotification, V2NIMModifyMessageParams, V2NIMModifyMessageResult } from 'ts/v2_def/v2_nim_struct_def';
 import { EventEmitter } from 'eventemitter3';
 import { V2NIMProgressCallback } from 'ts/v2_def/v2_nim_callback_def';
-export declare interface V2NIMMessageServiceEvents {
+export declare interface V2NIMMessageListener {
     /** 收到一条新消息 */
     receiveMessages: [Array<V2NIMMessage>];
     /** 点对点已读回执 */
@@ -24,134 +24,376 @@ export declare interface V2NIMMessageServiceEvents {
     receiveMessagesModified: [Array<V2NIMMessage>];
 }
 /** @brief 消息服务 */
-export declare class V2NIMMessageService extends EventEmitter<V2NIMMessageServiceEvents> {
+export declare class V2NIMMessageService extends EventEmitter<V2NIMMessageListener> {
     instance: any;
     constructor();
-    /** @brief 发送消息 */
-    /** @param message 要发送的消息 */
-    /** @param conversationId 发送目标会话 */
-    /** @param params 发送参数 */
+    /**
+     * @brief 发送消息
+     * @param message 要发送的消息
+     * @param conversationId 发送目标会话
+     * @returns V2NIMSendMessageResult
+     * @example
+     * ```javascript
+     * const message = v2.messageCreator.createTextMessage('Hello NTES IM')
+     * const result = await v2.messageService.sendMessage(message, conversationId, params, progressCallback)
+     * ```
+     */
     sendMessage(message: V2NIMMessage, conversationId: string, params: V2NIMSendMessageParams, progressCallback: V2NIMProgressCallback): Promise<V2NIMSendMessageResult>;
-    /** @brief 回复消息 */
-    /** @param message 要发送的消息 */
-    /** @param replyMessage 被回复的消息 */
-    /** @param params 发送参数 */
+    /**
+     * @param message 要发送的消息
+     * @param replyMessage 被回复的消息
+     * @param params 发送参数
+     * @param progressCallback 发送进度回调
+     * @returns V2NIMSendMessageResult
+     * @example
+     * ```javascript
+     * const replyMessage = v2.messageCreator.createTextMessage('Hello NTES IM')
+     * const result = await v2.messageService.replyMessage(message, replyMessage, params, progressCallback)
+     * ```
+     */
     replyMessage(message: V2NIMMessage, replyMessage: V2NIMMessage, params: V2NIMSendMessageParams, progressCallback: V2NIMProgressCallback): Promise<V2NIMSendMessageResult>;
-    /** @brief 更新消息 */
-    /** @param message 要更新的消息 */
-    /** @param params 发送参数 */
+    /**
+     * @brief 更新消息
+     * @param message 要更新的消息
+     * @param params 发送参数
+     * @returns V2NIMModifyMessageResult
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.modifyMessage(message, {
+     *     text: 'Hello NTES IM'
+     * })
+     * ```
+     */
     modifyMessage(message: V2NIMMessage, params: V2NIMModifyMessageParams): Promise<V2NIMModifyMessageResult>;
-    /** @brief 撤回消息 */
-    /** @param message 要撤回的消息 */
+    /**
+     * @brief 撤回消息
+     * @param message 要撤回的消息
+     * @param params 撤回参数
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.revokeMessage(message, {})
+     * ```
+     */
     revokeMessage(message: V2NIMMessage, params: V2NIMMessageRevokeParams): Promise<void>;
-    /** @brief 查询消息 */
-    /** @param option 查询消息配置选项 */
+    /**
+     * @brief 查询消息
+     * @param option 查询消息配置选项
+     * @returns Array<V2NIMMessage>
+     * @example
+     * ```javascript
+     * const messages = await v2.messageService.getMessageList({
+     *     conversationId: 'conversationId'
+     * })
+     * ```
+     */
     getMessageList(option: V2NIMMessageListOption): Promise<Array<V2NIMMessage>>;
-    /** @brief 根据 ID 列表查询消息 */
-    /** @param messageClientIds 消息客户端 ID 列表 */
+    /**
+     * @brief 根据 ID 列表查询消息
+     * @param messageClientIds 消息客户端 ID 列表
+     * @returns Array<V2NIMMessage>
+     * @example
+     * ```javascript
+     * const messages = await v2.messageService.getMessageListByIds(messageClientIds)
+     * ```
+     */
     getMessageListByIds(messageClientIds: Array<string>): Promise<Array<V2NIMMessage>>;
-    /** @brief 根据消息引用列表查询消息 */
-    /** @param messageRefers 消息引用列表 */
+    /**
+     * @brief 根据消息引用列表查询消息
+     * @param messageRefers 消息引用列表
+     * @returns Array<V2NIMMessage>
+     * @example
+     * ```javascript
+     * const messages = await v2.messageService.getMessageListByRefers(messageRefers)
+     * ```
+     */
     getMessageListByRefers(messageRefers: Array<V2NIMMessageRefer>): Promise<Array<V2NIMMessage>>;
-    /** @brief 查询 thread 聊天云端消息列表 */
-    /** @param threadMessageListOption threadMessageListOption 消息查询选项 */
+    /**
+     * @brief 查询 thread 聊天云端消息列表
+     * @param threadMessageListOption threadMessageListOption 消息查询选项
+     * @returns V2NIMThreadMessageListResult
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getThreadMessageList(threadMessageListOption)
+     * ```
+     */
     getThreadMessageList(threadMessageListOption: V2NIMThreadMessageListOption): Promise<V2NIMThreadMessageListResult>;
-    /** @brief 查询 thread 聊天本地消息列表 */
-    /** @param V2NIMMessageRefer messageRefer 消息查询选项 */
+    /**
+     * @brief 查询 thread 聊天本地消息列表
+     * @param messageRefer 消息查询选项
+     * @returns V2NIMThreadMessageListResult
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getLocalThreadMessageList(messageRefer)
+     * ```
+     */
     getLocalThreadMessageList(messageRefer: V2NIMMessageRefer): Promise<V2NIMThreadMessageListResult>;
-    /** @brief 删除消息 */
-    /** @param message 需要删除的消息 */
-    /** @param serverExtension 服务器扩展字段 */
-    /** @param onlyDeleteLocal 是否只删除本地消息 */
+    /**
+     * @brief 删除消息
+     * @param message 需要删除的消息
+     * @param serverExtension 服务器扩展字段
+     * @param onlyDeleteLocal 是否只删除本地消息
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.deleteMessage(message, 'serverExtension', true)
+     * ```
+     */
     deleteMessage(message: V2NIMMessage, serverExtension: string, onlyDeleteLocal: boolean): Promise<void>;
-    /** @brief 批量删除消息 */
-    /** @param messages 需要删除的消息列表 */
-    /** @param serverExtension 服务器扩展字段 */
-    /** @param onlyDeleteLocal 是否只删除本地消息 */
+    /**
+     * @brief 批量删除消息
+     * @param messages 需要删除的消息列表
+     * @param serverExtension 服务器扩展字段
+     * @param onlyDeleteLocal 是否只删除本地消息
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.deleteMessages(messages, 'serverExtension', true)
+     * ```
+     */
     deleteMessages(messages: Array<V2NIMMessage>, serverExtension: string, onlyDeleteLocal: boolean): Promise<void>;
-    /** @brief 清空历史消息 */
-    /** @param option 清空历史消息配置选项 */
+    /**
+     * @brief 清空历史消息
+     * @param option 清空历史消息配置选项
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.clearHistoryMessage(option)
+     * ```
+     */
     clearHistoryMessage(option: V2NIMClearHistoryMessageOption): Promise<void>;
-    /** @brief 更新消息本地扩展 */
-    /** @param message 要更新的消息 */
-    /** @param localExtension 本地扩展字段 */
+    /**
+     * @brief 更新消息本地扩展
+     * @param message 要更新的消息
+     * @param localExtension 本地扩展字段
+     * @returns V2NIMMessage
+     * @example
+     * ```javascript
+     * const message = await v2.messageService.updateMessageLocalExtension(message, 'localExtension')
+     * ```
+     */
     updateMessageLocalExtension(message: V2NIMMessage, localExtension: string): Promise<V2NIMMessage>;
-    /** @brief 插入本地消息 */
-    /** @param message 要插入的消息 */
-    /** @param conversationId 会话 ID */
-    /** @param senderId 发送者 ID, 传空表示当前用户 */
-    /** @param createTime 消息创建时间, 0 表示使用当前时间 */
+    /**
+     * @brief 插入本地消息
+     * @param message 要插入的消息
+     * @param conversationId 会话 ID
+     * @param senderId 发送者 ID, 传空表示当前用户
+     * @param createTime 消息创建时间, 0 表示使用当前时间
+     * @returns V2NIMMessage
+     * @example
+     * ```javascript
+     * const message = await v2.messageService.insertMessageToLocal(message, conversationId, senderId, createTime)
+     * ```
+     */
     insertMessageToLocal(message: V2NIMMessage, conversationId: string, senderId: string, createTime: number): Promise<V2NIMMessage>;
-    /** @brief pin 消息 */
-    /** @param message 要 pin 的消息 */
-    /** @param serverExtension 扩展字段 */
+    /**
+     * @brief PIN 消息
+     * @param message 要 PIN 的消息
+     * @param serverExtension 扩展字段
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.pinMessage(message, 'serverExtension')
+     * ```
+     */
     pinMessage(message: V2NIMMessage, serverExtension: string): Promise<void>;
-    /** @brief 取消 pin 消息 */
-    /** @param message 要 unpin 的消息引用 */
-    /** @param serverExtension 扩展字段 */
+    /**
+     * @brief 取消 PIN 消息
+     * @param messageRefer 要取消 PIN 的消息引用
+     * @param serverExtension 扩展字段
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.unpinMessage(messageRefer, 'serverExtension')
+     * ```
+     */
     unpinMessage(messageRefer: V2NIMMessageRefer, serverExtension: string): Promise<void>;
-    /** @brief 更新 pin 消息 */
-    /** @param message 要更新的 pin 消息 */
-    /** @param serverExtension 扩展字段 */
+    /**
+     * @brief 更新 PIN 消息
+     * @param message 要更新的 PIN 消息
+     * @param serverExtension 扩展字段
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.updatePinMessage(message, 'serverExtension')
+     * ```
+     */
     updatePinMessage(message: V2NIMMessage, serverExtension: string): Promise<void>;
-    /** @brief 获取 pin 消息列表 */
-    /** @param conversationId 会话 ID */
+    /**
+     * @brief 获取 PIN 消息列表
+     * @param conversationId 会话 ID
+     * @returns Array<V2NIMMessagePin>
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getPinnedMessageList(conversationId)
+     * ```
+     */
     getPinnedMessageList(conversationId: string): Promise<Array<V2NIMMessagePin>>;
-    /** @brief 添加快捷评论 */
-    /** @param message 要添加快捷评论的消息 */
-    /** @param index 快捷评论索引 */
-    /** @param serverExtension 服务器扩展字段 */
-    /** @param pushConfig 推送配置 */
+    /**
+     * @brief 添加快捷评论
+     * @param message 要添加快捷评论的消息
+     * @param index 快捷评论索引
+     * @param serverExtension 服务器扩展字段
+     * @param pushConfig 推送配置
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.addQuickComment(message, index, 'serverExtension', pushConfig)
+     * ```
+     */
     addQuickComment(message: V2NIMMessage, index: string, serverExtension: string, pushConfig: V2NIMMessageQuickCommentPushConfig): Promise<void>;
-    /** @brief 移除快捷评论 */
-    /** @param messageRefer 要移除快捷评论的消息引用 */
-    /** @param index 快捷评论索引 */
-    /** @param serverExtension 服务器扩展字段 */
+    /**
+     * @brief 移除快捷评论
+     * @param messageRefer 要移除快捷评论的消息引用
+     * @param index 快捷评论索引
+     * @param serverExtension 服务器扩展字段
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.removeQuickComment(messageRefer, index, 'serverExtension')
+     * ```
+     */
     removeQuickComment(messageRefer: V2NIMMessageRefer, index: number, serverExtension: string): Promise<void>;
-    /** @brief 获取快捷评论列表 */
-    /** @param messages 要获取快捷评论的消息列表 */
-    /** @note return result, key: clientMessasgeId */
+    /**
+     * @brief 获取快捷评论列表
+     * @param messages 要获取快捷评论的消息列表
+     * @returns Map<string, Array<V2NIMMessageQuickComment>>
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getQuickCommentList(messages)
+     * ```
+     */
     getQuickCommentList(messages: Array<V2NIMMessage>): Promise<Map<string, Array<V2NIMMessageQuickComment>>>;
-    /** @brief 添加收藏 */
-    /** @param params 添加收藏相关参数 */
+    /**
+     * @brief 添加收藏
+     * @param params 添加收藏相关参数
+     * @returns V2NIMCollection
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.addCollection(params)
+     * ```
+     */
     addCollection(params: V2NIMAddCollectionParams): Promise<V2NIMCollection>;
-    /** @brief 移除收藏 */
-    /** @param collections 要移除的收藏列表 */
+    /**
+     * @brief 移除收藏
+     * @param collections 要移除的收藏列表
+     * @returns number
+     * @example
+     * ```javascript
+     * const count = await v2.messageService.removeCollections(collections)
+     * ```
+     */
     removeCollections(collections: Array<V2NIMCollection>): Promise<number>;
-    /** @brief 更新收藏扩展字段 */
-    /** @param collection 要更新的收藏 */
-    /** @param serverExtension 服务器扩展字段, 传空表示删除扩展字段 */
+    /**
+     * @brief 更新收藏扩展字段
+     * @param collection 要更新的收藏
+     * @param serverExtension 服务器扩展字段, 传空表示删除扩展字段
+     * @returns V2NIMCollection
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.updateCollectionExtension(collection, 'serverExtension')
+     * ```
+     */
     updateCollectionExtension(collection: V2NIMCollection, serverExtension: string): Promise<V2NIMCollection>;
-    /** @brief 分页获取收藏列表 */
-    /** @param option 获取收藏列表查询参数 */
+    /**
+     * @brief 分页获取收藏列表
+     * @param option 获取收藏列表查询参数
+     * @returns Array<V2NIMCollection>
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getCollectionListByOption(option)
+     * ```
+     */
     getCollectionListByOption(option: V2NIMCollectionOption): Promise<Array<V2NIMCollection>>;
-    /** @brief 发送 P2P 消息已读回执 */
-    /** @param message 要发送已读回执的消息 */
+    /**
+     * @brief 发送 P2P 消息已读回执
+     * @param message 要发送已读回执的消息
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.sendP2PMessageReceipt(message)
+     * ```
+     */
     sendP2PMessageReceipt(message: V2NIMMessage): Promise<void>;
-    /** @brief 查询 P2P 消息已读回执状态 */
-    /** @param conversationId 会话 ID */
+    /**
+     * @brief 查询 P2P 消息已读回执状态
+     * @param conversationId 会话 ID
+     * @returns V2NIMP2PMessageReadReceipt
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getP2PMessageReceipt(conversationId)
+     * ```
+     */
     getP2PMessageReceipt(conversationId: string): Promise<V2NIMP2PMessageReadReceipt>;
-    /** @brief 查询 P2P 消息对方是否已读 */
-    /** @param message 要查询的消息 */
-    /** @return boolean 是否已读 */
+    /**
+     * @brief 查询 P2P 消息对方是否已读
+     * @param message 要查询的消息
+     * @returns boolean 是否已读
+     * @example
+     * ```javascript
+     * const result = v2.messageService.isPeerRead(message)
+     * ```
+     */
     isPeerRead(message: V2NIMMessage): boolean;
-    /** @brief 发送群消息已读回执 */
-    /** @param messages 要发送已读回执的消息列表 */
+    /**
+     * @brief 发送群消息已读回执
+     * @param messages 要发送已读回执的消息列表
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.sendTeamMessageReceipts(messages)
+     * ```
+     */
     sendTeamMessageReceipts(messages: Array<V2NIMMessage>): Promise<void>;
-    /** @brief 获取群消息已读回执状态 */
-    /** @param messages 要查询的消息列表 */
+    /**
+     * @brief 获取群消息已读回执状态
+     * @param messages 要查询的消息列表
+     * @returns Array<V2NIMTeamMessageReadReceipt>
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getTeamMessageReceipts(messages)
+     * ```
+     */
     getTeamMessageReceipts(messages: Array<V2NIMMessage>): Promise<Array<V2NIMTeamMessageReadReceipt>>;
-    /** @brief 获取群消息已读回执详情 */
-    /** @param message 要查询的消息 */
-    /** @param memberAccountIds 指定的账号列表, 为空表示查询全部 */
+    /**
+     * @brief 获取群消息已读回执详情
+     * @param message 要查询的消息
+     * @param memberAccountIds 指定的账号列表, 为空表示查询全部
+     * @returns V2NIMTeamMessageReadReceiptDetail
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getTeamMessageReceiptDetail(message, memberAccountIds)
+     * ```
+     */
     getTeamMessageReceiptDetail(message: V2NIMMessage, memberAccountIds: Array<string>): Promise<V2NIMTeamMessageReadReceiptDetail>;
-    /** @brief 语音转文字 */
-    /** @param params 语音转文字参数 */
+    /**
+     * @brief 语音转文字
+     * @param params 语音转文字参数
+     * @returns string
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.voiceToText(params)
+     * ```
+     */
     voiceToText(params: V2NIMVoiceToTextParams): Promise<string>;
-    /** @brief 取消文件消息附件上传 */
-    /** @param message 要取消上传的文件消息 */
+    /**
+     * @brief 取消文件消息附件上传
+     * @param message 要取消上传的文件消息
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.cancelMessageAttachmentUpload(message)
+     * ```
+     */
     cancelMessageAttachmentUpload(message: V2NIMMessage): Promise<void>;
-    /** @brief 搜索云端消息 */
-    /** @param params 消息检索参数 */
+    /**
+     * @brief 搜索云端消息
+     * @param params 消息检索参数
+     * @returns Array<V2NIMMessage>
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.searchCloudMessages(params)
+     * ```
+     */
     searchCloudMessages(params: V2NIMMessageSearchParams): Promise<Array<V2NIMMessage>>;
 }

package/types/v2/v2_nim_notification_service.d.ts

@@ -1,18 +1,25 @@
 import { V2NIMBroadcastNotification, V2NIMCustomNotification, V2NIMSendCustomNotificationParams } from 'ts/v2_def/v2_nim_struct_def';
 import { EventEmitter } from 'eventemitter3';
-export declare interface V2NIMNotificationServiceEvents {
+export declare interface V2NIMNotificationListener {
     /** 收到自定义通知 */
     receiveCustomNotifications: [Array<V2NIMCustomNotification>];
     /** 收到广播通知 */
     receiveBroadcastNotifications: [Array<V2NIMBroadcastNotification>];
 }
 /** @brief 通知服务 */
-export declare class V2NIMNotificationService extends EventEmitter<V2NIMNotificationServiceEvents> {
+export declare class V2NIMNotificationService extends EventEmitter<V2NIMNotificationListener> {
     instance: any;
     constructor();
-    /** @brief 发送自定义通知 */
-    /** @param conversationId 会话 ID */
-    /** @param content 通知内容 */
-    /** @param params 发送通知相关配置参数 */
+    /**
+     * @brief 发送自定义通知
+     * @param conversationId 会话 ID
+     * @param content 通知内容
+     * @param params 发送通知相关配置参数
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.notificationService.sendCustomNotification(conversationId, content, params)
+     * ```
+     */
     sendCustomNotification(conversationId: string, content: string, params: V2NIMSendCustomNotificationParams): Promise<void>;
 }

package/types/v2/v2_nim_passthrough_service.d.ts

@@ -0,0 +1,25 @@
+import { EventEmitter } from 'eventemitter3';
+import { V2NIMProxyRequest, V2NIMProxyResponse, V2NIMProxyNotify } from '../v2_def/v2_nim_struct_def';
+export declare interface V2NIMPassthroughListener {
+    /** 收到透传消息 */
+    onProxyNotify: [V2NIMProxyNotify];
+}
+export declare class V2NIMPassthroughService extends EventEmitter<V2NIMPassthroughListener> {
+    instance: any;
+    constructor();
+    /**
+     * @brief 发送 HTTP 代理请求，该请求将通过服务器透传给目标地址
+     * @param request 请求参数
+     * @returns Promise<V2NIMProxyResponse>
+     * @example
+     * ```javascript
+     * const response = await v2.passthroughService.httpProxy({
+     *     path: '/',
+     *     method: '1',
+     *     header: '{"Content-Type": "application/json"}',
+     *     body: 'body'
+     * })
+     * ```
+     */
+    httpProxy(request: V2NIMProxyRequest): Promise<V2NIMProxyResponse>;
+}