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

package/types/v2/v2_nim_chatroom_client.d.ts

@@ -2,7 +2,8 @@ import { V2NIMInitOption, V2NIMError, V2NIMChatroomEnterParams, V2NIMChatroomEnt
 import { EventEmitter } from 'eventemitter3';
 import { V2NIMChatroomService } from './v2_nim_chatroom_service';
 import { V2NIMStorageService } from './v2_nim_storage_service';
-export declare interface V2NIMChatroomClientEvents {
+import { V2NIMChatroomQueueService } from './v2_nim_chatroom_queue_service';
+export declare interface V2NIMChatroomClientListener {
     /** @brief 聊天室状态 */
     chatroomStatus: (status: number, error: V2NIMError) => void;
     /** @brief 进入聊天室 */
@@ -12,62 +13,178 @@ export declare interface V2NIMChatroomClientEvents {
     /** @brief 自己被踢出聊天室 */
     chatroomKicked: (kickedInfo: V2NIMChatroomKickedInfo) => void;
 }
-export declare class V2NIMChatroomClient extends EventEmitter<V2NIMChatroomClientEvents> {
+export declare class V2NIMChatroomClient extends EventEmitter<V2NIMChatroomClientListener> {
     instance: any;
     chatroomService: V2NIMChatroomService;
+    chatroomQueueService: V2NIMChatroomQueueService;
     storageService: V2NIMStorageService;
     static chatroomSdk: any;
     constructor(instanceId?: number);
-    /** @brief 初始化 */
-    /** @param option 初始化选项 */
-    /** @return V2NIMError */
+    /**
+     * @brief 初始化
+     * @param option 初始化选项
+     * @returns V2NIMError
+     * @example
+     * ```javascript
+     * const result = await V2NIMChatroomClient.init({
+     *     appKey: 'your app key'
+     * })
+     * if (result) {
+     *     console.error(result)
+     * }
+     * ```
+     */
     static init(option: V2NIMInitOption): V2NIMError | null;
-    /** @brief 反初始化 */
-    /** @return void */
-    /** @warning 请在退出程序前调用此方法 */
+    /**
+     * @brief 反初始化
+     * @returns void
+     * @warning 请在退出程序前调用此方法
+     * @example
+     * ```javascript
+     * V2NIMChatroomClient.uninit()
+     * ```
+     */
     static uninit(): void;
-    /** @brief 创建聊天室客户端实例 */
-    /** @return V2NIMChatroomClient */
-    /** @pre 必须在调用此方法前调用 V2NIMChatroomClient::init */
-    /** @note 建议保存持有实例 ID 而不是实例本身 */
+    /**
+     * @brief 创建聊天室客户端实例
+     * @returns V2NIMChatroomClient
+     * @pre 必须在调用此方法前调用 V2NIMChatroomClient::init
+     * @note 建议保存持有实例 ID 而不是实例本身
+     * @example
+     * ```javascript
+     * const chatroomClient = V2NIMChatroomClient.newInstance()
+     * ```
+     */
     static newInstance(): V2NIMChatroomClient;
-    /** @brief 销毁聊天室客户端实例 */
-    /** @param instanceId 聊天室客户端实例 ID */
-    /** @return void */
-    /** @pre 必须在调用此方法前调用 V2NIMChatroomClient::init */
-    /** @warning 严禁在调用此方法后访问对应的聊天室客户端实例 */
+    /**
+     * @brief 销毁聊天室客户端实例
+     * @param instanceId 聊天室客户端实例 ID
+     * @returns void
+     * @pre 必须在调用此方法前调用 V2NIMChatroomClient::init
+     * @warning 严禁在调用此方法后访问对应的聊天室客户端实例
+     * @example
+     * ```javascript
+     * V2NIMChatroomClient.destroyInstance(instanceId)
+     * ```
+     */
     static destroyInstance(instanceId: number): void;
-    /** @brief 获取聊天室客户端实例 */
-    /** @return V2NIMChatroomClient */
-    /** @pre 必须在调用此方法前调用 V2NIMChatroomClient::init */
+    /**
+     * @param instanceId 聊天室客户端实例 ID
+     * @returns V2NIMChatroomClient
+     * @pre 必须在调用此方法前调用 V2NIMChatroomClient::init
+     * @example
+     * ```javascript
+     * const chatroomClient = V2NIMChatroomClient.getInstance(instanceId)
+     * ```
+     */
     static getInstance(instanceId: number): V2NIMChatroomClient | null;
-    /** @brief 获取聊天室实例列表 */
-    /** @return Array<V2NIMChatroomClient> */
-    /** @pre 必须在调用此方法前调用 V2NIMChatroomClient::init */
+    /**
+     * @brief 获取聊天室实例列表
+     * @returns Array<V2NIMChatroomClient>
+     * @pre 必须在调用此方法前调用 V2NIMChatroomClient::init
+     * @example
+     * ```javascript
+     * const instanceList = V2NIMChatroomClient.getInstanceList()
+     * ```
+     */
     static getInstanceList(): Array<V2NIMChatroomClient>;
-    /** @brief 销毁所有聊天室客户端实例 */
-    /** @return void */
-    /** @pre 必须在调用此方法前调用 V2NIMChatroomClient::init */
-    /** @warning 严禁在调用此方法后访问任何聊天室客户端实例, 此方法会退出聊天室, 耗时可能较长 */
+    /**
+     * @brief 销毁所有聊天室客户端实例
+     * @returns void
+     * @pre 必须在调用此方法前调用 V2NIMChatroomClient::init
+     * @warning 严禁在调用此方法后访问任何聊天室客户端实例, 此方法会退出聊天室, 耗时可能较长
+     * @example
+     * ```javascript
+     * V2NIMChatroomClient.destroyAll()
+     * ```
+     */
     static destroyAll(): void;
-    /** @brief 获取聊天室客户端实例 ID */
-    /** @return size_t */
+    /**
+     * @brief 获取聊天室客户端实例 ID
+     * @returns size_t
+     * @example
+     * ```javascript
+     * const instanceId = chatroomClient.getInstanceId()
+     * ```
+     */
     getInstanceId(): number;
-    /** @brief 进入聊天室 */
-    /** @param roomId 聊天室 ID */
-    /** @param enterParams 进入聊天室相关参数 */
-    /** @return void */
+    /**
+     * @brief 更新 appKey
+     * @param appKey - 新的 App key
+     * @returns V2NIMError | null
+     * @example
+     * ```javascript
+     * const result = chatroomClient.updateAppKey('your new app key')
+     * if (result) {
+     *     console.error(result)
+     * }
+     * ```
+     */
+    updateAppKey(appKey: string): V2NIMError | null;
+    /**
+     * @brief 进入聊天室
+     * @param roomId 聊天室 ID
+     * @param enterParams 进入聊天室相关参数
+     * @returns Promise<V2NIMChatroomEnterResult>
+     * @example
+     * ```javascript
+     * const result = await chatroomClient.enter('your room id', {
+     *     accountId: 'your account id',
+     *     token: 'your token',
+     *     roomNick: 'your room nick',
+     *     linkProvider: (roomId, account) => {
+     *         return ['chatroom link...']
+     *     }
+     * })
+     * if (result) {
+     *     console.error(result)
+     * }
+     * ```
+     */
     enter(roomId: string, enterParams: V2NIMChatroomEnterParams): Promise<V2NIMChatroomEnterResult>;
-    /** @brief 退出聊天室 */
-    /** @return void */
+    /**
+     * @brief 退出聊天室
+     * @returns void
+     * @example
+     * ```javascript
+     * chatroomClient.exit()
+     * ```
+     */
     exit(): void;
-    /** @brief 查询聊天室信息 */
-    /** @return V2NIMChatroomInfo */
+    /**
+     * @brief 查询聊天室信息
+     * @returns V2NIMChatroomInfo
+     * @example
+     * ```javascript
+     * const chatroomInfo = chatroomClient.getChatroomInfo()
+     * ```
+     */
     getChatroomInfo(): V2NIMChatroomInfo;
-    /** @brief 获取聊天室服务 */
-    /** @return V2NIMChatroomService */
+    /**
+     * @brief 获取聊天室服务
+     * @returns V2NIMChatroomService
+     * @example
+     * ```javascript
+     * const chatroomService = chatroomClient.getChatroomService()
+     * ```
+     */
     getChatroomService(): V2NIMChatroomService;
-    /** @brief 获取存储服务 */
-    /** @return V2NIMStorageService */
+    /**
+     * @brief 获取聊天室队列服务
+     * @returns V2NIMChatroomQueueService
+     * @example
+     * ```javascript
+     * const chatroomQueueService = chatroomClient.getChatroomQueueService()
+     * ```
+     */
+    getChatroomQueueService(): V2NIMChatroomQueueService;
+    /**
+     * @brief 获取存储服务
+     * @returns V2NIMStorageService
+     * @example
+     * ```javascript
+     * const storageService = chatroomClient.getStorageService()
+     * ```
+     */
     getStorageService(): V2NIMStorageService;
 }

package/types/v2/v2_nim_chatroom_queue_service.d.ts

@@ -0,0 +1,96 @@
+import { EventEmitter } from 'eventemitter3';
+import { V2NIMChatroomQueueElement, V2NIMChatroomQueueOfferParams } from 'ts/v2_def/v2_nim_struct_def';
+export declare interface V2NIMChatroomQueueListener {
+    /** 聊天室新增队列元素 */
+    chatroomQueueOffered: [V2NIMChatroomQueueElement];
+    /** 聊天室移除队列元素 */
+    chatroomQueuePolled: [V2NIMChatroomQueueElement];
+    /** 聊天室清空队列元素 */
+    chatroomQueueDropped: [];
+    /** 聊天室清理部分队列元素 */
+    chatroomQueuePartCleared: [Array<V2NIMChatroomQueueElement>];
+    /** 聊天室批量更新队列元素 */
+    chatroomQueueBatchUpdated: [Array<V2NIMChatroomQueueElement>];
+    /** 聊天室批量添加队列元素 */
+    chatroomQueueBatchOffered: [Array<V2NIMChatroomQueueElement>];
+}
+export declare class V2NIMChatroomQueueService extends EventEmitter<V2NIMChatroomQueueListener> {
+    instance: any;
+    constructor(instanceId: number);
+    /**
+     * @brief 初始化队列
+     * @param size 初始化队列的长度，长度限制：0~1000
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await chatroomQueueService.queueInit(100)
+     * ```
+     */
+    queueInit(size: number): Promise<void>;
+    /**
+     * @brief 清空队列，仅管理员/创建者可以操作
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await chatroomQueueService.queueDrop()
+     * ```
+     */
+    queueDrop(): Promise<void>;
+    /**
+     * @brief 聊天室队列新增或更新元素
+     * @param params 新增或更新元素参数
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await chatroomQueueService.queueOffer({
+     *     elementKey: 'your element key',
+     *     elementValue: 'your element value'
+     * })
+     * ```
+     */
+    queueOffer(params: V2NIMChatroomQueueOfferParams): Promise<void>;
+    /**
+     * @brief 取出头元素或者指定的元素
+     * @param elementKey 指定的元素 key
+     * @returns Promise<V2NIMChatroomQueueElement>
+     * @example
+     * ```javascript
+     * const element = await chatroomQueueService.queuePoll('your element key')
+     * ```
+     */
+    queuePoll(elementKey: string): Promise<V2NIMChatroomQueueElement>;
+    /**
+     * @brief 查看队头元素， 不删除
+     * @returns Promise<V2NIMChatroomQueueElement>
+     * @example
+     * ```javascript
+     * const element = await chatroomQueueService.queuePeek()
+     * ```
+     */
+    queuePeek(): Promise<V2NIMChatroomQueueElement>;
+    /**
+     * @brief 排序列出所有元素
+     * @return Promise<Array<V2NIMChatroomQueueElement>>
+     * @example
+     * ```javascript
+     * const elements = await chatroomQueueService.queueList()
+     * console.log(elements)
+     * ```
+     */
+    queueList(): Promise<Array<V2NIMChatroomQueueElement>>;
+    /**
+     * @brief 批量更新队列元素
+     * @param elements 需要更新的元素列表
+     * @param notificationEnabled 是否发送通知
+     * @param notificationExtension 通知扩展字段
+     * @return Promise<string[]>
+     * @example
+     * ```javascript
+     * const elementKeys = await chatroomQueueService.queueBatchUpdate([{
+     *     elementKey: 'your element key',
+     *     elementValue: 'your element value'
+     * }], true, 'your notification extension')
+     * ```
+     */
+    queueBatchUpdate(elements: any[], notificationEnabled: boolean, notificationExtension: string): Promise<string[]>;
+}

package/types/v2/v2_nim_chatroom_service.d.ts

@@ -1,6 +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';
-export declare interface V2NIMChatroomServiceEvents {
+import { V2NIMChatroomMemberRole } from 'ts/v2_def/v2_nim_enum_def';
+export declare interface V2NIMChatroomListener {
     /** 收到新消息 */
     receiveMessages: [V2NIMChatroomMessage[]];
     /** 聊天室成员进入 */
@@ -27,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>>;
 }