node-nim 10.5.2 → 10.6.0

package/dist/v2/v2_nim_message_service.js

@@ -12,10 +12,17 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
         super();
         this.instance = new loader_1.default.V2NIMMessageService({ emit: this.emit.bind(this) });
     }
-    /** @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, conversationId, params, progressCallback) {
         return new Promise((resolve, reject) => {
             this.instance.sendMessage(message, conversationId, params, (result) => {
@@ -29,10 +36,18 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @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, replyMessage, params, progressCallback) {
         return new Promise((resolve, reject) => {
             this.instance.replyMessage(message, replyMessage, params, (result) => {
@@ -44,9 +59,18 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @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, params) {
         return new Promise((resolve, reject) => {
             this.instance.modifyMessage(message, params, (result) => {
@@ -56,8 +80,16 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 撤回消息 */
-    /** @param message 要撤回的消息 */
+    /**
+     * @brief 撤回消息
+     * @param message 要撤回的消息
+     * @param params 撤回参数
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.revokeMessage(message, {})
+     * ```
+     */
     revokeMessage(message, params) {
         return new Promise((resolve, reject) => {
             this.instance.revokeMessage(message, params, () => {
@@ -67,8 +99,17 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 查询消息 */
-    /** @param option 查询消息配置选项 */
+    /**
+     * @brief 查询消息
+     * @param option 查询消息配置选项
+     * @returns Array<V2NIMMessage>
+     * @example
+     * ```javascript
+     * const messages = await v2.messageService.getMessageList({
+     *     conversationId: 'conversationId'
+     * })
+     * ```
+     */
     getMessageList(option) {
         return new Promise((resolve, reject) => {
             this.instance.getMessageList(option, (result) => {
@@ -78,8 +119,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 根据 ID 列表查询消息 */
-    /** @param messageClientIds 消息客户端 ID 列表 */
+    /**
+     * @brief 根据 ID 列表查询消息
+     * @param messageClientIds 消息客户端 ID 列表
+     * @returns Array<V2NIMMessage>
+     * @example
+     * ```javascript
+     * const messages = await v2.messageService.getMessageListByIds(messageClientIds)
+     * ```
+     */
     getMessageListByIds(messageClientIds) {
         return new Promise((resolve, reject) => {
             this.instance.getMessageListByIds(messageClientIds, (result) => {
@@ -89,8 +137,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 根据消息引用列表查询消息 */
-    /** @param messageRefers 消息引用列表 */
+    /**
+     * @brief 根据消息引用列表查询消息
+     * @param messageRefers 消息引用列表
+     * @returns Array<V2NIMMessage>
+     * @example
+     * ```javascript
+     * const messages = await v2.messageService.getMessageListByRefers(messageRefers)
+     * ```
+     */
     getMessageListByRefers(messageRefers) {
         return new Promise((resolve, reject) => {
             this.instance.getMessageListByRefers(messageRefers, (result) => {
@@ -100,8 +155,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 查询 thread 聊天云端消息列表 */
-    /** @param threadMessageListOption threadMessageListOption 消息查询选项 */
+    /**
+     * @brief 查询 thread 聊天云端消息列表
+     * @param threadMessageListOption threadMessageListOption 消息查询选项
+     * @returns V2NIMThreadMessageListResult
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getThreadMessageList(threadMessageListOption)
+     * ```
+     */
     getThreadMessageList(threadMessageListOption) {
         return new Promise((resolve, reject) => {
             this.instance.getThreadMessageList(threadMessageListOption, (result) => {
@@ -111,8 +173,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 查询 thread 聊天本地消息列表 */
-    /** @param V2NIMMessageRefer messageRefer 消息查询选项 */
+    /**
+     * @brief 查询 thread 聊天本地消息列表
+     * @param messageRefer 消息查询选项
+     * @returns V2NIMThreadMessageListResult
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getLocalThreadMessageList(messageRefer)
+     * ```
+     */
     getLocalThreadMessageList(messageRefer) {
         return new Promise((resolve, reject) => {
             this.instance.getLocalThreadMessageList(messageRefer, (result) => {
@@ -122,10 +191,17 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @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, serverExtension, onlyDeleteLocal) {
         return new Promise((resolve, reject) => {
             this.instance.deleteMessage(message, serverExtension, onlyDeleteLocal, () => {
@@ -135,10 +211,17 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @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, serverExtension, onlyDeleteLocal) {
         return new Promise((resolve, reject) => {
             this.instance.deleteMessages(messages, serverExtension, onlyDeleteLocal, () => {
@@ -148,8 +231,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 清空历史消息 */
-    /** @param option 清空历史消息配置选项 */
+    /**
+     * @brief 清空历史消息
+     * @param option 清空历史消息配置选项
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.clearHistoryMessage(option)
+     * ```
+     */
     clearHistoryMessage(option) {
         return new Promise((resolve, reject) => {
             this.instance.clearHistoryMessage(option, () => {
@@ -159,9 +249,16 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 更新消息本地扩展 */
-    /** @param message 要更新的消息 */
-    /** @param localExtension 本地扩展字段 */
+    /**
+     * @brief 更新消息本地扩展
+     * @param message 要更新的消息
+     * @param localExtension 本地扩展字段
+     * @returns V2NIMMessage
+     * @example
+     * ```javascript
+     * const message = await v2.messageService.updateMessageLocalExtension(message, 'localExtension')
+     * ```
+     */
     updateMessageLocalExtension(message, localExtension) {
         return new Promise((resolve, reject) => {
             this.instance.updateMessageLocalExtension(message, localExtension, (result) => {
@@ -171,11 +268,18 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @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, conversationId, senderId, createTime) {
         return new Promise((resolve, reject) => {
             this.instance.insertMessageToLocal(message, conversationId, senderId, createTime, (result) => {
@@ -185,9 +289,16 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @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, serverExtension) {
         return new Promise((resolve, reject) => {
             this.instance.pinMessage(message, serverExtension, () => {
@@ -197,9 +308,16 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @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, serverExtension) {
         return new Promise((resolve, reject) => {
             this.instance.unpinMessage(messageRefer, serverExtension, () => {
@@ -209,9 +327,16 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @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, serverExtension) {
         return new Promise((resolve, reject) => {
             this.instance.updatePinMessage(message, serverExtension, () => {
@@ -221,8 +346,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 获取 pin 消息列表 */
-    /** @param conversationId 会话 ID */
+    /**
+     * @brief 获取 PIN 消息列表
+     * @param conversationId 会话 ID
+     * @returns Array<V2NIMMessagePin>
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getPinnedMessageList(conversationId)
+     * ```
+     */
     getPinnedMessageList(conversationId) {
         return new Promise((resolve, reject) => {
             this.instance.getPinnedMessageList(conversationId, (result) => {
@@ -232,11 +364,18 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @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, index, serverExtension, pushConfig) {
         return new Promise((resolve, reject) => {
             this.instance.addQuickComment(message, index, serverExtension, pushConfig, () => {
@@ -246,10 +385,17 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @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, index, serverExtension) {
         return new Promise((resolve, reject) => {
             this.instance.removeQuickComment(messageRefer, index, serverExtension, () => {
@@ -259,9 +405,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @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) {
         return new Promise((resolve, reject) => {
             this.instance.getQuickCommentList(messages, (result) => {
@@ -271,8 +423,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 添加收藏 */
-    /** @param params 添加收藏相关参数 */
+    /**
+     * @brief 添加收藏
+     * @param params 添加收藏相关参数
+     * @returns V2NIMCollection
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.addCollection(params)
+     * ```
+     */
     addCollection(params) {
         return new Promise((resolve, reject) => {
             this.instance.addCollection(params, (result) => {
@@ -282,8 +441,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 移除收藏 */
-    /** @param collections 要移除的收藏列表 */
+    /**
+     * @brief 移除收藏
+     * @param collections 要移除的收藏列表
+     * @returns number
+     * @example
+     * ```javascript
+     * const count = await v2.messageService.removeCollections(collections)
+     * ```
+     */
     removeCollections(collections) {
         return new Promise((resolve, reject) => {
             this.instance.removeCollections(collections, (count) => {
@@ -293,9 +459,16 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 更新收藏扩展字段 */
-    /** @param collection 要更新的收藏 */
-    /** @param serverExtension 服务器扩展字段, 传空表示删除扩展字段 */
+    /**
+     * @brief 更新收藏扩展字段
+     * @param collection 要更新的收藏
+     * @param serverExtension 服务器扩展字段, 传空表示删除扩展字段
+     * @returns V2NIMCollection
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.updateCollectionExtension(collection, 'serverExtension')
+     * ```
+     */
     updateCollectionExtension(collection, serverExtension) {
         return new Promise((resolve, reject) => {
             this.instance.updateCollectionExtension(collection, serverExtension, (result) => {
@@ -305,8 +478,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 分页获取收藏列表 */
-    /** @param option 获取收藏列表查询参数 */
+    /**
+     * @brief 分页获取收藏列表
+     * @param option 获取收藏列表查询参数
+     * @returns Array<V2NIMCollection>
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getCollectionListByOption(option)
+     * ```
+     */
     getCollectionListByOption(option) {
         return new Promise((resolve, reject) => {
             this.instance.getCollectionListByOption(option, (result) => {
@@ -316,8 +496,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 发送 P2P 消息已读回执 */
-    /** @param message 要发送已读回执的消息 */
+    /**
+     * @brief 发送 P2P 消息已读回执
+     * @param message 要发送已读回执的消息
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.sendP2PMessageReceipt(message)
+     * ```
+     */
     sendP2PMessageReceipt(message) {
         return new Promise((resolve, reject) => {
             this.instance.sendP2PMessageReceipt(message, () => {
@@ -327,8 +514,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 查询 P2P 消息已读回执状态 */
-    /** @param conversationId 会话 ID */
+    /**
+     * @brief 查询 P2P 消息已读回执状态
+     * @param conversationId 会话 ID
+     * @returns V2NIMP2PMessageReadReceipt
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getP2PMessageReceipt(conversationId)
+     * ```
+     */
     getP2PMessageReceipt(conversationId) {
         return new Promise((resolve, reject) => {
             this.instance.getP2PMessageReceipt(conversationId, (result) => {
@@ -338,14 +532,27 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 查询 P2P 消息对方是否已读 */
-    /** @param message 要查询的消息 */
-    /** @return boolean 是否已读 */
+    /**
+     * @brief 查询 P2P 消息对方是否已读
+     * @param message 要查询的消息
+     * @returns boolean 是否已读
+     * @example
+     * ```javascript
+     * const result = v2.messageService.isPeerRead(message)
+     * ```
+     */
     isPeerRead(message) {
         return this.instance.isPeerRead(message);
     }
-    /** @brief 发送群消息已读回执 */
-    /** @param messages 要发送已读回执的消息列表 */
+    /**
+     * @brief 发送群消息已读回执
+     * @param messages 要发送已读回执的消息列表
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.sendTeamMessageReceipts(messages)
+     * ```
+     */
     sendTeamMessageReceipts(messages) {
         return new Promise((resolve, reject) => {
             this.instance.sendTeamMessageReceipts(messages, () => {
@@ -355,8 +562,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 获取群消息已读回执状态 */
-    /** @param messages 要查询的消息列表 */
+    /**
+     * @brief 获取群消息已读回执状态
+     * @param messages 要查询的消息列表
+     * @returns Array<V2NIMTeamMessageReadReceipt>
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getTeamMessageReceipts(messages)
+     * ```
+     */
     getTeamMessageReceipts(messages) {
         return new Promise((resolve, reject) => {
             this.instance.getTeamMessageReceipts(messages, (result) => {
@@ -366,9 +580,16 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 获取群消息已读回执详情 */
-    /** @param message 要查询的消息 */
-    /** @param memberAccountIds 指定的账号列表, 为空表示查询全部 */
+    /**
+     * @brief 获取群消息已读回执详情
+     * @param message 要查询的消息
+     * @param memberAccountIds 指定的账号列表, 为空表示查询全部
+     * @returns V2NIMTeamMessageReadReceiptDetail
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.getTeamMessageReceiptDetail(message, memberAccountIds)
+     * ```
+     */
     getTeamMessageReceiptDetail(message, memberAccountIds) {
         return new Promise((resolve, reject) => {
             this.instance.getTeamMessageReceiptDetail(message, memberAccountIds, (result) => {
@@ -378,8 +599,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 语音转文字 */
-    /** @param params 语音转文字参数 */
+    /**
+     * @brief 语音转文字
+     * @param params 语音转文字参数
+     * @returns string
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.voiceToText(params)
+     * ```
+     */
     voiceToText(params) {
         return new Promise((resolve, reject) => {
             this.instance.voiceToText(params, (result) => {
@@ -389,8 +617,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 取消文件消息附件上传 */
-    /** @param message 要取消上传的文件消息 */
+    /**
+     * @brief 取消文件消息附件上传
+     * @param message 要取消上传的文件消息
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.messageService.cancelMessageAttachmentUpload(message)
+     * ```
+     */
     cancelMessageAttachmentUpload(message) {
         return new Promise((resolve, reject) => {
             this.instance.cancelMessageAttachmentUpload(message, () => {
@@ -400,8 +635,15 @@ class V2NIMMessageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 搜索云端消息 */
-    /** @param params 消息检索参数 */
+    /**
+     * @brief 搜索云端消息
+     * @param params 消息检索参数
+     * @returns Array<V2NIMMessage>
+     * @example
+     * ```javascript
+     * const result = await v2.messageService.searchCloudMessages(params)
+     * ```
+     */
     searchCloudMessages(params) {
         return new Promise((resolve, reject) => {
             this.instance.searchCloudMessages(params, (result) => {