@rongcloud/imlib-next 5.9.9 → 5.10.1

package/index.d.ts

@@ -1,12 +1,31 @@
-import { FileType, APIContext, LogLevel, EnableLogL, IRuntime, AreaCode, ConversationType, MessageDirection, ReceivedStatus, IReceivedStatusInfo, SentStatus, IReadReceiptResponseInfo, IReadReceiptInfo, IPushConfig, UltraGroupChannelType, RCConnectionStatus, IPluginGenerator, IAsyncRes, NotificationStatus, NotificationLevel, IUltraUnreadMsg, IUserProfile, IConversationOption, ITypingMessage, IUpdateItem, ErrorCode, IChatroomListenerData, IExpansionListenerData, IBlockedMessageInfo, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUserGroupStatusInfo, IMessageDeliver, IGroupMessageDeliverStatus, IReadReceiptData, ISyncReadStatusData, ISubscribeUserStatusInfo, ISubscribeRelationInfo, IBaseConversationInfo, IConversationState as IConversationState$1, IGetUltraGroupListOption, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraGroupUnreadInfo, IChatroomJoinResponse, IChatroomInfo, IChatRoomEntry, IChatroomEntries, IRemoveChatRoomEntry, IRTCRoomBindOption, MentionedInfoBody, ICombineV2MessageContent, IMessageReadReceiptV4Response, IGroupReadReceiptData, IClearMessageOption, IMessageReaderResponse, IFirstUnreadMessageInfo, IReceivedMessage, IReceivedConversation, ITagParam, ITagInfo, IConversationTag, IUploadAuth, IDownloadAuth, UploadMethod, IInsertMessage, IGroupMessageDeliverInfo, IProxy, IPromiseResult, IResponse, SubscribeType } from '@rongcloud/engine';
-export { AreaCode, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, ConnectionStatus, ConversationType, EnableLogL, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IClearMessageOption, ICombineV2MessageContent, ICombinedMessage, IConversationIdentifier, IConversationOption, IConversationTag, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEventListener, IExpansionListenerData, IFirstUnreadMessageInfo, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupReadReceiptData, IInsertMessage, IMessageDeliver, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPrivateReadReceiptData, IPromiseResult, IProxy, IPushConfig, IRTCRoomBindOption, IReadReceiptData, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IResponse, ISubscribeRelationInfo, ISubscribeStatusDetail, ISubscribeUserStatusInfo, ISyncReadStatusData, ITagInfo, ITagParam, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IiOSPushConfig, InterruptionLevel, LogL, LogLevel, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, NotificationLevel, NotificationStatus, OnlineStatus, OperateStatus, PlatformInfo, PushImportanceHonor, RCConnectionStatus, ReceivedStatus, SentStatus, SubscribeOperationType, SubscribeType, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod } from '@rongcloud/engine';
+import { FileType, APIContext, LogLevel, EnableLogL, IRuntime, AreaCode, ConversationType, MessageDirection, ReceivedStatus, IReceivedStatusInfo, SentStatus, IReadReceiptResponseInfo, IReadReceiptInfo, IPushConfig, UltraGroupChannelType, RCConnectionStatus, IPluginGenerator, IAsyncRes, NotificationStatus, NotificationLevel, IUltraUnreadMsg, IUserProfile, IConversationOption, ITypingMessage, IUpdateItem, ErrorCode, IChatroomListenerData, IExpansionListenerData, IBlockedMessageInfo, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUserGroupStatusInfo, IMessageDeliver, IGroupMessageDeliverStatus, IReadReceiptData, ISyncReadStatusData, ISubscribeUserStatusInfo, ISubscribeRelationInfo, SubscribeType, IUserProfileInfo, IBaseConversationInfo, IConversationState as IConversationState$1, IGetUltraGroupListOption, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraGroupUnreadInfo, IChatroomJoinResponse, IChatroomInfo, IChatroomEntry, IChatroomEntries, IRemoveChatroomEntry, IRTCRoomBindOption, MentionedInfoBody, ICombineV2MessageContent, IMessageReadReceiptV4Response, IGroupReadReceiptData, IClearMessageOption, IMessageReaderResponse, IFirstUnreadMessageInfo, IReceivedMessage, IReceivedConversation, ITagParam, ITagInfo, IConversationTag, IUploadAuth, IDownloadAuth, UploadMethod, IInsertMessage, IGroupMessageDeliverInfo, IProxy, IPromiseResult, IResponse, UserProfileVisibility } from '@rongcloud/engine';
+export { AreaCode, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, ConnectionStatus, ConversationType, EnableLogL, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IClearMessageOption, ICombineV2MessageContent, ICombinedMessage, IConversationIdentifier, IConversationOption, IConversationTag, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEventListener, IExpansionListenerData, IFirstUnreadMessageInfo, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupReadReceiptData, IInsertMessage, IMessageDeliver, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPrivateReadReceiptData, IPromiseResult, IProxy, IPushConfig, IRTCRoomBindOption, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IResponse, ISubscribeRelationInfo, ISubscribeStatusDetail, ISubscribeUserStatusInfo, ISyncReadStatusData, ITagInfo, ITagParam, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IUserProfileInfo, IiOSPushConfig, InterruptionLevel, LogL, LogLevel, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, NotificationLevel, NotificationStatus, OnlineStatus, OperateStatus, PlatformInfo, PushImportanceHonor, RCConnectionStatus, ReceivedStatus, SentStatus, SubscribeOperationType, SubscribeType, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod, UserProfileVisibility } from '@rongcloud/engine';
 
+/**
+ * 缩略图配置
+ * @category Interface
+ */
 interface IThumbnailConfig {
+    /**
+     * 最大高度
+     */
     maxHeight?: number;
+    /**
+     * 最大宽度
+     */
     maxWidth?: number;
+    /**
+     * 图片质量
+     */
     quality?: number;
+    /**
+     * 缩放比例
+     */
     scale?: number;
 }
+/**
+ * @hidden
+ */
 interface IUploadConfig {
     getFileToken: TGetFileToken;
     getFileUrl: TGetFileUrl;
@@ -16,6 +35,9 @@ interface IUploadConfig {
     uploadServer?: string;
     bosAddr?: string;
 }
+/**
+ * @hidden
+ */
 interface IUploadInfo {
     file: File;
     onProgress?: (loaded: number, total: number) => void;
@@ -23,6 +45,9 @@ interface IUploadInfo {
     contentDisposition?: 'inline' | 'attachment';
     thumbnailConfig?: IThumbnailConfig;
 }
+/**
+ * @hidden
+ */
 interface IUploadResult {
     name: string;
     downloadUrl: string;
@@ -50,6 +75,10 @@ interface IUploadResult {
 declare type TGetFileToken = typeof APIContext.prototype.getFileToken;
 declare type TGetFileUrl = typeof APIContext.prototype.getFileUrl;
 
+/**
+ * 初始化配置项
+ * @category Type
+ */
 declare type IInitOption = {
     /**
      * 应用 appkey 标识
@@ -195,12 +224,12 @@ interface IAReceivedMessage {
     messageDirection: MessageDirection;
     /**
      * 是否存储
-     * @default true
+     * @defaultValue true
      */
     isPersited: boolean;
     /**
      * 是否计数
-     * @default true
+     * @defaultValue true
      */
     isCounted: boolean;
     /**
@@ -275,6 +304,10 @@ interface IAReceivedMessage {
      */
     directedUserIds?: string[];
 }
+/**
+ * 获取历史消息配置项
+ * @category Type
+ */
 declare type GetHistoryMessageOption = {
     /**
      * 获取此时间之前的消息，0 为从当前时间拉取
@@ -293,6 +326,7 @@ declare type GetHistoryMessageOption = {
     order?: 0 | 1;
 };
 /**
+ * 通过消息类型获取历史消息配置项
  * @category Interface
  */
 interface IGetHistoryMessagesByTypesOption extends GetHistoryMessageOption {
@@ -301,68 +335,142 @@ interface IGetHistoryMessagesByTypesOption extends GetHistoryMessageOption {
      */
     messageTypes: string[];
 }
+/**
+ * 获取历史消息返回结构
+ * @category Type
+ */
 declare type GetHistoryMessageResult = {
     list: IAReceivedMessage[];
     hasMore: boolean;
 };
 
+/**
+ * 初始化
+ * @description 初始化 IM SDK，传入 Appkey 及相关配置信息
+ * @category 基础
+ * @param options 初始化参数，类型为 {@link IInitOption}
+ * @example
+ * 初始化示例：
+ * ```ts
+ * RongIMLib.init({ appkey: 'appkey' });
+ * console.log('初始化完成');
+ * ```
+ */
 declare function init(options: IInitOption): void;
 /**
  * 反初始化
+ * @description 反初始化，清空所有监听及计时器，停止日志上报等业务
+ * * **适用场景**：
+ * 1. 应用退出时，推荐使用此方法
+ * 2. 需要更换 appkey 时，需要调用此方法后，重新使用新 Appkey 在次调用 {@link init} 方法
+ * @category 基础
+ * @example
+ * 反初始化示例：
+ * ```ts
+ * await RongIMLib.destroy();
+ * console.log('反初始化完成');
+ * ```
  */
 declare function destroy(): Promise<void>;
 /**
  * 获取 IM 连接状态
  * @category 基础
+ * @example
+ * 获取 IM 连接状态示例：
+ * ```ts
+ * const status = RongIMLib.getConnectionStatus();
+ * console.log('获取 IM 连接状态：', status);
+ * ```
  */
 declare function getConnectionStatus(): RCConnectionStatus;
 /**
  * 当前服务器时间
  * 校准时间，可能存在误差
  * @category 基础
+ * @hidden
  */
 declare function getServerTime(): number;
 /**
-  * 获取 IM 连接用户的 id
+ * 获取 IM 连接用户的 id
  * @category 基础
-  */
+ * @example
+ * 获取当前用户 id 示例：
+ * ```ts
+ * const userId = RongIMLib.getCurrentUserId();
+ * console.log('获取当前用户 id：', userId);
+ * ```
+ */
 declare function getCurrentUserId(): string;
 /**
  * （内部方法）用于统计各组件版本信息
  * @param name
  * @param version
+ * @hidden
  */
 declare function __addSDKVersion(name: string, version: string): void;
 /**
  * 获取 deviceId
+ * @description 获取当前设备的唯一标识
  * @category 基础
+ * @example
+ * 获取 deviceId 示例：
+ * ```ts
+ * const deviceId = RongIMLib.getDeviceId();
+ * console.log('获取 deviceId：', deviceId);
+ * ```
  */
 declare function getDeviceId(): string;
 
 /**
- * 装载 plugin 插件，并返回相应的插件实例，需在调用 `connect` 方法之前使用
+ * 装载 plugin 插件
+ * @description 装载 plugin 插件，需在调用 `connect` 方法之前使用，并返回相应的插件实例
  * @category 基础
- * @param plugins
+ * @param plugins 插件生成器
+ * @param options 插件配置
  */
 declare function installPlugin<T, O>(plugin: IPluginGenerator<T, O>, options: O): T | null;
 
 /**
  * 建立 IM 连接
+ * @description 传入从用户身份令牌（Token），向融云聊天服务器发起连接请求。
+ * * **注意**：
+ * 1. 必须在 SDK 初始化 {@link init} 之后，调用 connect() 方法进行连接。否则可能没有回调。
+ * 2. SDK 本身有重连机制，在一个应用生命周期内不须多次调用connect()
+ * 3. 在应用生命周期调用一次即可。
  * @category 基础
  * @param token
- * @param reconnectKickEnable 设置断线重连时是否踢出当前正在重连的设备 (仅 Electron 环境有效)
+ * @param reconnectKickEnable 设置断线重连时是否踢出当前正在重连的设备 (仅 `Electron` 环境有效)
+ * 默认仅允许同一用户账号在单台桌面端设备上登录。后登录的 Electron 设备一旦连接成功，则自动踢出之前登录的设备。在部分情况下，SDK 的重连机制可能会导致后登录设备无法正常在线
+ * @example
+ * 建立 IM 连接示例：
+ * ```ts
+ * const token = '<Your-token>';
+ * const res = await RongIMLib.connect(token);
+ * console.info('建立 IM 连接结果：', res);
+ * ```
  */
 declare function connect(token: string, reconnectKickEnable?: boolean): Promise<IAsyncRes<{
     userId: string;
 }>>;
 /**
- * 断开当前用户的连接
- * @param closeDB 是否关闭数据库，默认为 true，仅 Electron 平台有效
- * @category 基础
+ * 断开连接
  * @description 调用后将不再接收消息，不可发送消息，不可获取历史消息，不可获取会话列表
+ * * **适用场景**：注销账号，切换账号时，推荐使用此方法
+ * @category 基础
+ * @param closeDB 是否关闭数据库，默认为 true，仅 Electron 平台有效
+ * @example
+ * 断开连接示例：
+ * ```ts
+ * await RongIMLib.disconnect();
+ * console.info('成功断开');
+ * ```
  */
 declare function disconnect(closeDB?: boolean): Promise<void>;
 
+/**
+ * 事件监听名称
+ * @category Enum
+ */
 declare enum Events {
     /**
      * 连接中
@@ -512,7 +620,16 @@ declare enum Events {
      * 订阅用户状态同步完成
      * @since 5.9.8
      */
-    SYNC_SUBSCRIBED_USER_STATUS_FINISHED = "SYNC_SUBSCRIBED_USER_STATUS_FINISHED"
+    SYNC_SUBSCRIBED_USER_STATUS_FINISHED = "SYNC_SUBSCRIBED_USER_STATUS_FINISHED",
+    /**
+     * 订阅关系同步完成
+     * @since 5.9.8
+     */
+    /**
+     * 我的用户信息变更通知
+     * @since 5.10.1
+     */
+    OWN_USER_PROFILE_CHANGED = "OWN_USER_PROFILE_CHANGED"
 }
 /**
  * 消息审核状态
@@ -525,6 +642,7 @@ declare enum MessageAuditType {
 
 /**
  * 上传任务
+ * @hidden
  */
 declare class UploadTask {
     private readonly _promise;
@@ -548,15 +666,30 @@ declare class BaseMessage<T = any> {
     readonly isCounted: boolean;
     constructor(messageType: string, content: T, isPersited?: boolean, isCounted?: boolean);
 }
+/**
+ * 消息类型构造函数
+ * @category Type
+ */
 declare type MessageConstructor<T> = new (content: T) => BaseMessage<T>;
 
 /**
+ * 会话更新项结构
  * @category Interface
  */
 interface IConversationUpdateItem {
+    /**
+     * 时间
+     */
     time: number;
+    /**
+     * 更新数据
+     */
     val: any;
 }
+/**
+ * @ 类型
+ * @category Type
+ */
 declare type MentionedInfo = {
     /**
      * `@ 类型，其中 1 为 @ 所有人，2 为 @ 部分人`
@@ -568,20 +701,59 @@ declare type MentionedInfo = {
     userIdList?: Array<string>;
 };
 /**
+ * 会话数据更新结构
  * @category Interface
  */
 interface IReceivedUpdateConversation {
+    /**
+     * 会话更新项
+     */
     updatedItems: {
         [key: string]: IConversationUpdateItem;
     };
+    /**
+     * 会话类型
+     * * 1: 单聊
+     * * 3: 群聊
+     * * 4: 聊天室
+     * * 5: 客服会话
+     * * 6: 系统消息
+     * * 7: 默认关注的公众号
+     * * 8: 手动关注的公众号
+     * * 9: RTCLib 房间
+     */
     conversationType: number;
+    /**
+     * 会话 id
+     */
     targetId: string;
+    /**
+     * 会话最后一条消息
+     */
     latestMessage?: IAReceivedMessage;
+    /**
+     * 未读数
+     */
     unreadMessageCount?: number;
+    /**
+     * 是否是 @ 消息
+     */
     hasMentioned?: boolean;
+    /**
+     * @ 信息
+     */
     mentionedInfo?: MentionedInfo;
+    /**
+     * 消息最后阅读时间
+     */
     lastUnreadTime?: number;
+    /**
+     * 免打扰状态
+     */
     notificationStatus?: NotificationStatus;
+    /**
+     * 是否制定
+     */
     isTop?: boolean;
 }
 /**
@@ -672,15 +844,20 @@ interface IAReceivedConversation {
     draft?: string;
 }
 /**
+ * 分页获取标签下会话数据结构
  * @category Interface
  */
 interface IAReceivedConversationByTag extends IAReceivedConversation {
     isTopInTag: boolean;
 }
 /**
+ * 超级群会话数据结构
  * @category Interface
  */
 interface IAUltraGroupReceivedConversation extends IAReceivedConversation {
+    /**
+     * 超级群频道类型，只有 ConversationType 为超级群时该字段有效
+     */
     channelType?: UltraGroupChannelType;
     /**
      * 第一条未读消息
@@ -688,6 +865,7 @@ interface IAUltraGroupReceivedConversation extends IAReceivedConversation {
     firstUnreadMessage?: IUltraUnreadMsg | null;
 }
 /**
+ * 发送消息参数结构
  * @category Interface
  */
 interface ISendMessageOptions {
@@ -791,6 +969,7 @@ interface IImageMessageOption extends IUploadMessageOption {
     thumbnailConfig?: IThumbnailConfig;
 }
 /**
+ * 插入消息配置项结构
  * @category Interface
  */
 interface IInsertOptions {
@@ -804,6 +983,7 @@ interface IInsertOptions {
     searchContent?: string;
 }
 /**
+ * 用户信息结构
  * @category Interface
  */
 interface IUserInfo {
@@ -836,6 +1016,7 @@ interface IUserInfo {
     };
 }
 /**
+ * 消息扩展结构
  * @category Interface
  */
 interface IExtraData {
@@ -845,8 +1026,8 @@ interface IExtraData {
     extra?: string;
 }
 /**
+ * 消息审核配置结构
  * @category Interface
- * 消息审核配置
  */
 interface IAuditInfo {
     audit?: {
@@ -865,10 +1046,17 @@ interface IAuditInfo {
     };
 }
 /**
+ * 消息关键信息结构
  * @category Interface
  */
 interface IMessageDesc {
+    /**
+     * 消息唯一标识
+     */
     messageUId: string;
+    /**
+     * 消息发送时间
+     */
     sendTime: number;
 }
 /**
@@ -932,18 +1120,41 @@ interface IUploadHooks {
  * @category Interface
  */
 interface ISearchMessageInTimeRangeOption {
+    /**
+     *搜索关键字
+     */
     keyword: string;
+    /**
+     * 开始时间
+     */
     startTime: number;
+    /**
+     * 截止时间
+     */
     endTime: number;
+    /**
+     * 分页搜索时的偏移量, 默认为0
+     */
     offset?: number;
+    /**
+     * 每页的数量， 默认为 5
+     */
     limit?: number;
 }
+/**
+ * 消息监听数据结构
+ * @category Interface
+ */
 interface IMessagesEvent {
     /**
      * 接收的消息数据
      */
     messages: IAReceivedMessage[];
 }
+/**
+ * 收到已读回执（单聊）数据结构
+ * @category Interface
+ */
 interface IReadReceiptReceivedEvent {
     /**
      * 会话信息，包含会话属性
@@ -962,6 +1173,10 @@ interface IReadReceiptReceivedEvent {
      */
     sendUserId: string;
 }
+/**
+ * 收到已读回执请求（群聊）数据结构
+ * @category Interface
+ */
 interface IMessageReceiptRequestEvent {
     /**
      * 会话信息，包含会话属性
@@ -976,6 +1191,10 @@ interface IMessageReceiptRequestEvent {
      */
     senderUserId: string;
 }
+/**
+ * 收到已读回执响应（群聊）数据结构
+ * @category Interface
+ */
 interface IMessageReceiptResponseEvent {
     /**
      * 会话信息，包含会话属性
@@ -990,16 +1209,34 @@ interface IMessageReceiptResponseEvent {
      */
     messageUIdList: string[];
 }
+/**
+ * 正在输入状态事件数据结构
+ * @category Interface
+ */
 interface ITypingStatusEvent {
     /**
      * typing 状态
      */
     status: ITypingMessage[];
 }
+/**
+ * 会话变更数据结构
+ * @category Interface
+ */
 interface IConversationState {
+    /**
+     * 会话结构
+     */
     conversation: IAReceivedConversation;
+    /**
+     * 更新项
+     */
     updatedItems?: IUpdateItem;
 }
+/**
+ * 会话变更监听数据结构
+ * @category Interface
+ */
 interface IConversationEvent {
     /**
      * 会话信息数组
@@ -1007,6 +1244,10 @@ interface IConversationEvent {
     conversationList: IConversationState[];
 }
 
+/**
+ * 事件监听器
+ * @category Type
+ */
 declare type EventListeners = {
     [Events.CONNECTING]: () => void;
     [Events.CONNECTED]: () => void;
@@ -1048,42 +1289,95 @@ declare type EventListeners = {
     [Events.SYNC_READ_STATUS]: (list: ISyncReadStatusData) => void;
     [Events.SUBSCRIBED_USER_STATUS_CHANGE]: (data: ISubscribeUserStatusInfo[]) => void;
     [Events.SUBSCRIBED_RELATION_CHANGE]: (data: ISubscribeRelationInfo[]) => void;
-    [Events.SYNC_SUBSCRIBED_USER_STATUS_FINISHED]: () => void;
+    [Events.SYNC_SUBSCRIBED_USER_STATUS_FINISHED]: (type: SubscribeType) => void;
+    [Events.OWN_USER_PROFILE_CHANGED]: (data: IUserProfileInfo) => void;
 };
 
 /**
- * 绑定事件
+ * 添加监听器
+ * @description 用来接收来自于 IMLib 内的各种事件通知，同类型事件可以多次添加不同的监听函数。绑定仅执行一次的事件可以使用 {@link onceEventListener}
  * @category 基础
- * @param eventType
- * @param listener
- * @param target
+ * @param eventType 事件名称
+ * @param listener 事件监听函数
+ * @example
+ * 添加监听器示例：
+ * ```ts
+ * RongIMLib.addEventListener(RongIMLib.Events.CONNECTED, () => {
+ *  console.log('连接成功');
+ * });
+ * ```
  */
 declare function addEventListener<T extends Events>(eventType: T, listener: EventListeners[T], target?: any): void;
 /**
- * 绑定仅执行一次的事件
+ * 添加监听器(仅执行一次)
+ * @description 用来接收来自于 IMLib 内的各种事件通知
  * @category 基础
+ * @param eventType 事件名称
+ * @param listener 事件监听函数
+ * @example
+ * 添加监听器示例：
+ * ```ts
+ * RongIMLib.onceEventListener(RongIMLib.Events.CONNECTED, () => {
+ *  console.log('连接成功');
+ * });
+ * ```
  */
 declare function onceEventListener<T extends Events>(eventType: T, listener: EventListeners[T], target?: any): void;
 /**
  * 移除事件
+ * @description 业务层需注意在必要时使用 {@link removeEventListener} 或 {@link removeEventListeners} 移除对指定事件的监听函数，以免造成内存泄露
  * @category 基础
+ * @param eventType 事件名称
+ * @param listener 事件监听函数
+ * @example
+ * 移除事件示例：
+ * ```ts
+ * const listener = (evt) => console.log(evt.messages)
+ * RongIMLib.removeEventListener(Events.MESSAGES, listener);
+ * ```
  */
 declare function removeEventListener<T extends Events>(eventType: T, listener: EventListeners[T], target?: any): void;
 /**
  * 移除同一类型下的所有事件
+ * @description 将移除对某一特定事件的所有监听函数
  * @category 基础
+ * @param eventType 事件名称
+ * @example
+ * 移除事件示例：
+ * ```ts
+ * RongIMLib.removeEventListeners(Events.MESSAGES);
+ * ```
  */
 declare function removeEventListeners(eventType: string): void;
 /**
  * 清理所有事件
  * @category 基础
+ * @example
+ * 清理所有事件示例：
+ * ```ts
+ * RongIMLib.clearEventListeners();
+ * ```
  */
 declare function clearEventListeners(): void;
 
 /**
  * 获取会话列表
+ *
+ * @description 获取会话列表接口需要开通单群聊消息云存储之后才可以从服务端获取到数据，服务端会话列表存储上限为 1000
+ * * **注意**：
+ * Electron 平台调用时会忽略参数传值，固定返回所有会话列表。建议 Electron 平台客户考虑使用其他获取会话列表的接口
+ * 超过 1000 会根据最后一条消息时间排序，删除最早的会话
  * @category 会话
- * @param options
+ * @param options 获取会话列表参数配置
+ * @defaultValues count: 20, startTime: 0, order: 0
+ *
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedConversation} 类型数组
+ * @example
+ * 获取会话列表示例：
+ * ```ts
+ * const conversationList = await RongIMLib.getConversationList();
+ * console.info('获取会话列表结果：', conversationList);
+ * ```
  */
 declare function getConversationList$1(options?: {
     /**
@@ -1108,12 +1402,39 @@ declare function getConversationList$1(options?: {
  * 获取指定会话数据
  * @description 通过该方法获取的会话可能并不存在于当前的会话列表中，此处只作为功能性封装语法糖
  * @category 会话
- * @param options
+ * @param options 需要获取会话参数，类型为 {@link IConversationOption}
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedConversation} 类型
+ *
+ * @example
+ * 获取指定会话数据示例：
+ * ```ts
+ * const options = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const conversation = await RongIMLib.getConversation(options);
+ * console.info('获取指定会话数据结果：', conversation);
+ * ```
  */
 declare function getConversation(options: IConversationOption): Promise<IAsyncRes<IAReceivedConversation | null | undefined>>;
 /**
- * 移除指定的会话实例
+ * 移除指定的会话
  * @category 会话
+ * @description 移除指定的会话，不会删除会话内的消息
+ * * **注意**：
+ * 1. 删除会话不会删除会话的未读数，推荐在删除会话前先调用清除指定会话未读数 {@link clearMessagesUnreadStatus}接口，以防止未读数异常
+ * 2. 会话是有消息生成，如会话中在产生新消息会重新生成会话
+ * @param options 会话信息
+ * @example
+ * 移除指定的会话示例：
+ * ```ts
+ * const options = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const conversation = await RongIMLib.removeConversation(options);
+ * console.info('移除指定的会话结果：', conversation);
+ * ```
  */
 declare function removeConversation(options: IConversationOption): Promise<IAsyncRes<void>>;
 /**
@@ -1146,23 +1467,53 @@ declare function batchRemoveConversation(conversations: IConversationOption[]):
 /**
  * 获取会话文本草稿
  * @category 草稿
- * @params conversationType 会话类型
- * @params targetId 目标 ID
+ * @description Web 端草稿为内存态保存，如刷新浏览器会导致已经设置的草稿丢失
+ * @param options 会话信息
+ * @example
+ * 获取会话文本草稿示例：
+ * ```ts
+ * const options = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const conversation = await RongIMLib.getTextMessageDraft(options);
+ * console.info('获取会话文本草稿结果：', conversation);
+ * ```
 */
 declare function getTextMessageDraft(options: IConversationOption): Promise<IAsyncRes<string>>;
 /**
  * 设置会话文本草稿
  * @category 草稿
- * @params conversationType 会话类型
- * @params targetId 目标 ID
- * @params draft 草稿内容
+ * @description Web 端草稿为内存态保存，如刷新浏览器会导致已经设置的草稿丢失
+ * @param options 会话信息
+ * @param draft 草稿内容
+ * @example
+ * 设置会话文本草稿示例：
+ * ```ts
+ * const options = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const draft = '这是草稿信息';
+ * const conversation = await RongIMLib.saveTextMessageDraft(options, draft);
+ * console.info('设置会话文本草稿结果：', conversation);
+ * ```
 */
 declare function saveTextMessageDraft(options: IConversationOption, draft: string): Promise<IAsyncRes<void>>;
 /**
  * 删除会话文本草稿
  * @category 草稿
- * @params conversationType 会话类型
- * @params targetId 目标 ID
+ * @param options 会话信息
+ * @example
+ * 删除会话文本草稿示例：
+ * ```ts
+ * const options = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const conversation = await RongIMLib.clearTextMessageDraft(options);
+ * console.info('删除会话文本草稿结果：', conversation);
+ * ```
 */
 declare function clearTextMessageDraft(options: IConversationOption): Promise<IAsyncRes<void>>;
 /**
@@ -1174,45 +1525,110 @@ declare function clearTextMessageDraft(options: IConversationOption): Promise<IA
  * 3. 其他端删除会话可能会导致会话未读数不准确
  * @param includeMuted 是否包含免打扰会话
  * @param conversationTypes 要获取未读数的会话类型，若为空，则默认获取单聊、群聊及系统消息未读数
+ * @defaultValues includeMuted: false
+ * @return 返回一个 {@link IAsyncRes} 类型 Promise，data 中返回会话未读数
+ * @example
+ * 获取当前所有会话的消息未读数示例：
+ * ```ts
+ * const totalUnreadCount = await RongIMLib.getTotalUnreadCount();
+ * console.info('获取当前所有会话的消息未读数结果：', totalUnreadCount);
+ * ```
  */
 declare function getTotalUnreadCount(includeMuted?: boolean, conversationTypes?: ConversationType[]): Promise<IAsyncRes<number>>;
 /**
  * 获取会话指定免打扰级别的未读数
+ * @description 查找免打扰配置符合传入的免打扰级别的会话，返回所有会话中未读消息的总数
+ * * **注意**：
+ * 1. 聊天室会话类型不存储未读数，故不支持获取聊天室会话的未读数
  * @category 会话未读数
- * @param conversationTypes 会话类型列表
- * @param levels 免打扰级别列表，传空数组则获取全部免打扰级别未读数
- * @return number 未读总数
+ * @since 5.5.1 暂不支持 Electron 平台
+ * @param conversationTypes 会话类型列表，
+ * @param levels 需要获取的会话的免打扰级别，传空数组则统计全部支持会话未读数的会话类型的免打扰级别的未读数
+ * @return 返回一个 {@link IAsyncRes} 类型 Promise，data 中返回会话未读数
+ *
+ * @example
+ * 获取会话指定免打扰级别的未读数示例：
+ * ```ts
+ * const conversationTypes = [RongIMLib.ConversationType.PRIVATE];
+ * const levels = [RongIMLib.NotificationLevel.ALL_MESSAGE];
+ * const totalUnreadCount = await RongIMLib.getTotalUnreadCountByLevels(conversationTypes, levels);
+ * console.info('获取会话指定免打扰级别的未读数结果：', totalUnreadCount);
+ * ```
  */
 declare function getTotalUnreadCountByLevels(conversationTypes: ConversationType[], levels: NotificationLevel[]): Promise<IAsyncRes<number>>;
 /**
  * 获取会话指定免打扰级别未读 @ 消息数
+ * @description 查找免打扰配置符合传入的免打扰级别的会话，返回所有会话中所有未读 @ 消息的总数
  * @category 会话未读数
+ * @since 5.5.1 暂不支持 Electron 平台
  * @param conversationTypes 会话类型列表
  * @param levels 免打扰级别列表，传空数组则获取全部免打扰级别未读数
- * @return number 未读总数
+ * @return 返回一个 {@link IAsyncRes} 类型 Promise，data 中返回会话未读数
+ *
+ * @example
+ * 获取会话指定免打扰级别未读 @ 消息数示例：
+ * ```ts
+ * const conversationTypes = [RongIMLib.ConversationType.PRIVATE];
+ * const levels = [RongIMLib.NotificationLevel.ALL_MESSAGE];
+ * const totalUnreadCount = await RongIMLib.getTotalUnreadMentionedCountByLevels(conversationTypes, levels);
+ * console.info('获取会话指定免打扰级别未读 @ 消息数结果：', totalUnreadCount);
+ * ```
  */
 declare function getTotalUnreadMentionedCountByLevels(conversationTypes: ConversationType[], levels: NotificationLevel[]): Promise<IAsyncRes<number>>;
 /**
- * 获取单个会话的未读数
+ * 获取指定会话的未读数
+ * @description 获取指定会话的未读数，Web 端会话未读数保存在 localstorage 中，如清除浏览器缓存会导致会话未读数不准确
  * @category 会话未读数
+ * @param options 会话信息
+ *
+ * @example
+ * 获取指定会话的未读数示例：
+ * ```ts
+ * const options = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const unreadCount = await RongIMLib.getUnreadCount(options);
+ * console.info('获取指定会话的未读数结果：', unreadCount);
+ * ```
  */
 declare function getUnreadCount(options: IConversationOption): Promise<IAsyncRes<number>>;
 /**
- * 清除会话未读数
- * 原：clearUnreadCount
+ * 清除指定会话未读数
+ * @description 清除指定会话的未读数（不含聊天室会话类型）
+ * * **注意**：
+ * 1. Web 端会话未读数保存在 localstorage 中，如清除浏览器缓存会导致会话未读数不准确
+ * 2. 聊天室会话类型不存储未读数，故不支持清除聊天室会话的未读数
+ * 3. 未读数为本地为本地存储，清除后不可恢复，如用户多端未读数不会主动做多端同步，如需要多端同步需要通过 {@link sendSyncReadStatusMessage} 接口进行同步
  * @category 会话未读数
+ * @param options 会话信息
+ * @example
+ * 清除指定会话未读数示例：
+ * ```ts
+ * const options = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const clearRes = await RongIMLib.clearMessagesUnreadStatus(options);
+ * console.info('清除指定会话未读数结果：', clearRes);
+ * ```
  */
 declare function clearMessagesUnreadStatus(options: IConversationOption): Promise<IAsyncRes<void>>;
 /**
  * 清理全部未读数
  * @category 会话未读数
- * @returns
+ * @since 5.0.2
+ * @example
+ * 清理全部未读数示例：
+ * ```ts
+ * const clearRes = await RongIMLib.clearAllMessagesUnreadStatus();
+ * console.info('清除指定会话未读数结果：', clearRes);
+ * ```
  */
 declare function clearAllMessagesUnreadStatus(): Promise<IAsyncRes<ErrorCode>>;
 /**
  * 设置会话免打扰
- * 原： setConversationNotificationStatus 已废弃
- * 是否免打扰
+ * @description 支持按照 {@link NotificationLevel} 类型进行免打扰级别设置，级别描述如下：
  * * -1: 全部消息通知（接收全部消息通知 -- 显示指定关闭免打扰功能）
  * * 0: 未设置（向上查询群或者APP级别设置）//存量数据中0表示未设置
  * * 1: 群聊超级群仅@消息通知（现在通知）单聊代表全部消息通知
@@ -1220,7 +1636,20 @@ declare function clearAllMessagesUnreadStatus(): Promise<IAsyncRes<ErrorCode>>;
  * * 3: @ 群用户组通知，通知用户组暂未实现，暂不暴露出去
  * * 4: @ 群全员通知
  * * 5: 消息通知被屏蔽，即不接收消息通知
+ * @since 5.3.0
+ * @param options 会话信息
+ * @param notificationLevel 需要设置的免打扰级别，类型为 {@link NotificationLevel}
  * @category 会话
+ * @example
+ * 设置会话免打扰示例：
+ * ```ts
+ * const options = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const notificationLevel = RongIMLib.NotificationLevel.NOT_MESSAGE_NOTIFICATION;
+ * const res = await RongIMLib.setConversationNotificationLevel(options, notificationLevel);
+ * console.info('设置会话免打扰结果：', res);
  */
 declare function setConversationNotificationLevel(options: IConversationOption, notificationLevel: NotificationLevel): Promise<IAsyncRes<void>>;
 /**
@@ -1252,51 +1681,82 @@ declare function setConversationNotificationLevel(options: IConversationOption,
 declare function batchSetConversationNotificationLevel(conversations: IConversationOption[], notificationLevel: NotificationLevel): Promise<IAsyncRes<void>>;
 /**
  * 设置会话免打扰
- * @deprecated 已废弃，请使用 setConversationNotificationLevel
- * 原： setConversationStatus，免打扰和置顶一体的
- * 是否免打扰
- * * 1: 开启免打扰
- * * 2: 关闭免打扰
+ * @deprecated @since 5.3.0 已废弃，请使用 {@link setConversationNotificationLevel}
  * @category 会话
  */
 declare function setConversationNotificationStatus(options: IConversationOption, notificationStatus: NotificationStatus): Promise<IAsyncRes<void>>;
 /**
  * 查询指定会话和频道免打扰
- * 原： getConversationNotificationStatus 已废弃
+ * @deprecated 查询通过 {@link setConversationNotificationLevel} 接口设置的指定会话和频道免打扰
+ * 1. Electron 平台，从 5.8.4 版本开始支持 {@link setConversationNotificationLevel} 接口。
  * @category 会话
+ * @since 5.3.0
+ * @param options 会话信息
+ * @example
+ * 查询指定会话和频道免打扰示例：
+ * ```ts
+ * const options = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const conversation = await RongIMLib.getConversationNotificationLevel(options);
+ * console.info('查询指定会话和频道免打扰结果：', conversation);
+ * ```
  */
 declare function getConversationNotificationLevel(options: IConversationOption): Promise<IAsyncRes<NotificationLevel | undefined>>;
 /**
  * 获取免打扰状态
- * getConversationNotificationStatus
  * @category 会话
- * @deprecated 已废弃，请使用 getConversationNotificationLevel
+ * @deprecated 已废弃 @since 5.3.0,  5.3.0以上版本请使用 {@link getConversationNotificationLevel} 接口
  */
 declare function getConversationNotificationStatus(options: IConversationOption): Promise<IAsyncRes<NotificationStatus | undefined>>;
 /**
  * 获取免打扰状态列表
- * getBlockedConversationList
+ * @description 获取已设置免打扰状态的所有会话，接口仅 Web 端支持
+ * @since 5.1.1
  * @category 会话
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 {@link IBaseConversationInfo} 类型数组
+ * @example
+ * 获取免打扰状态列表示例：
+ * ```ts
+ * const list =  await RongIMLib.getBlockedConversationList();
+ * console.info('获取免打扰状态列表结果：', list);
+ * ```
  */
 declare function getBlockedConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
 /**
  * 设置指定会话类型的免打扰级别
+ * @description 私有云功能，暂未公有云暴露
+ * @hidden
  * @param conversationType 会话类型
  * @param level 免打扰级别
  */
 declare function setConversationTypeNotificationLevel(conversationType: ConversationType, level: NotificationLevel): Promise<IAsyncRes<void>>;
 /**
  * 获取指定会话类型的免打扰级别
+ * @description 私有云功能，暂未公有云暴露
+ * @hidden
  * @param conversationType 会话类型
  */
 declare function getConversationTypeNotificationLevel(conversationType: ConversationType): Promise<IAsyncRes<NotificationLevel>>;
 /**
  * 设置会话是否置顶
  * @category 会话
- * @param options 回话信息
+ * @param options 会话信息
  * @param isTop 置顶状态
  * @param isUpdateTime 是否更新会话操作时间，默认为更新，仅私有云环境有效
- * @returns
+ * @defaultValue isUpdateTime 默认为 true
+ * @example
+ * 设置会话是否置顶示例：
+ * ```ts
+ * const isTop = true
+ * const options = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const res = await RongIMLib.setConversationToTop(options, isTop);
+ * console.info('设置会话是否置顶结果：', res);
+ * ```
  */
 declare function setConversationToTop(options: IConversationOption, isTop?: boolean, isUpdateTime?: boolean): Promise<IAsyncRes<void>>;
 /**
@@ -1329,150 +1789,390 @@ declare function setConversationToTop(options: IConversationOption, isTop?: bool
  */
 declare function batchSetConversationToTop(conversations: IConversationOption[], isTop: boolean, isCreateConversation?: boolean): Promise<IAsyncRes<void>>;
 /**
- * 获取置顶会话
+ * 获取置顶会话列表
+ * @description 注意：该接口在 Web 平台返回数据中将不包含 latestMessage 字段。
  * @category 会话
- * @param conversationTypes 会话类型
+ * @since 5.6.0
+ * @param conversationTypes 需要传递 {@link ConversationType} 类型数组
  * @param channelId 不传或传 undefined 时获取全部 channelId 类型的置顶会话
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 {@link IAReceivedConversation} 类型数组
+ * @example
+ * 获取置顶会话列表示例：
+ * ```ts
+ * const res = await RongIMLib.getTopConversationList();
+ * console.info('获取置顶会话列表数结果：', res);
+ * ```
  */
 declare function getTopConversationList(conversationTypes?: ConversationType[], channelId?: string): Promise<IAsyncRes<IAReceivedConversation[]>>;
 /**
  * 获取未读会话列表
+ * @description 注意：该接口在 Web 平台返回数据中将不包含 latestMessage 字段。
  * @category 会话
+ * @since 5.7.0
  * @param conversationTypes 会话类型
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 {@link IAReceivedConversation} 类型数组
+ * @example
+ * 获取未读会话列表示例：
+ * ```ts
+ * const res = await RongIMLib.getUnreadConversationList();
+ * console.info('获取未读会话列表结果：', res);
+ * ```
  */
 declare function getUnreadConversationList(conversationTypes?: ConversationType[]): Promise<IAsyncRes<IAReceivedConversation[]>>;
 /**
  * 获取单个群会话 @ 消息未读数
+ * @description 获取当前用户在指定超级群会话指定频道的未读 @ 消息数。
+ * 注意，获取指定频道的未读 @ 消息数要求必须传入超级群频道 ID（channelId）
  * @category 会话未读数
- * @param targetId 目标 ID
+ * @param options 会话信息
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 返回单个群会话 @ 消息未读数
+ * @example
+ * 获取单个群会话 @ 消息未读数示例：
+ * ```ts
+ * const options = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const count = await RongIMLib.getUnreadMentionedCount(options);
+ * console.info('获取单个群会话 @ 消息未读数结果：', count);
+ * ```
  */
 declare function getUnreadMentionedCount(options: IConversationOption): Promise<IAsyncRes<number>>;
 /**
  * 获取所有群会话 @ 消息未读数
+ * @description 仅支持普通群会话，暂不支持超级群
  * @category 会话未读数
+ * @since 5.9.0
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 返回所有群会话 @ 消息未读总数
+ * @example
+ * 获取所有群会话 @ 消息未读数示例：
+ * ```ts
+ * const count = await RongIMLib.getAllUnreadMentionedCount();
+ * console.info('获取所有群会话 @ 消息未读数结果：', count);
+ * ```
  */
 declare function getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
 /**
  * 获取本地全部会话的状态
+ * @description 接口仅针对 Mihoyo 提供使用，目前公有云文档暂未提及，标注 hidden 暂不推荐使用。
+ * @hidden
  * @category 会话
  */
 declare function getAllConversationState(): Promise<IAsyncRes<IConversationState$1[]>>;
 
 /**
  * 获取超级群会话列表
+ * @description 获取超级群会话列表，不传则获取全部超级群会话列表，该列表不包含未产生任何消息的会话。
  * @category 超级群
+ * @since 5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
+ * @param options 获取超级群会话列表参数，不传则获取全部超级群会话列表
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为超级群会话列表 {@link IUltraGroupConversation[]}，code 接口返回状态码
+ * @defaultValue options 默认值为 {}
+ * @example 获取超级群会话列表示例：
+ * ```ts
+ * const res = await RongIMLib.getUltraGroupList();
+ * console.log('获取超级群会话列表结果：', res);
+ * ```
  */
 declare function getUltraGroupList(options?: IGetUltraGroupListOption): Promise<IAsyncRes<IUltraGroupConversation[]>>;
 /**
- * 获取超级群免打扰列表
+ * 获取当前登录用户免打扰超级群会话列表
+ * @description 获取当前登录用户免打扰超级群会话列表
  * @category 超级群
+ * @since 5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为超级群会话列表 {@link IUltraGroupConversation[]}，code 接口返回状态码
+ * @example 获取当前登录用户免打扰超级群会话列表示例：
+ * ```ts
+ * const res = await RongIMLib.getBlockUltraGroupList();
+ * console.log('获取当前登录用户免打扰超级群会话列表结果：', res);
+ * ```
 */
 declare function getBlockUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
 /**
- * 通知服务端正在输入中
+ * 发送输入状态
+ * @description 发送输入状态，用于通知服务端正在输入中
  * @category 超级群
+ * @since 5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
+ * @param options 发送输入状态参数，包含会话类型、目标 Id、频道 Id，类型为 {@link IConversationOption}
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，code 接口返回状态码
+ * @example 发送输入状态示例：
+ * ```ts
+ * const options = {
+ *  conversationType: RongIMLib.ConversationType.ULTRA_GROUP,
+ *  targetId: 'targetId',
+ *  channelId: 'channelId',
+ * };
+ * const res = await RongIMLib.sendUltraGroupTypingStatus(options);
+ * console.log('发送输入状态结果：', res);
+ * ```
  */
 declare function sendUltraGroupTypingStatus(options: IConversationOption): Promise<IAsyncRes<void>>;
 /**
- * 根据消息 ID 获取消息
+ * 从服务端获取特定批量消息
+ * @description 根据消息的 Uid 从服务端获取特定批量消息
  * @category 超级群
+ * @since 5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
+ * @param options 获取消息参数，包含会话类型、目标 Id、频道 Id，类型为 {@link IConversationOption}
+ * @param messages 消息列表，包含消息的 Uid，类型为 {@link IMessageDesc} 数组
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为消息列表，code 接口返回状态码
+ * 从 SDK 版本 @since 5.7.0 开始，该接口的返回数据类型由 {@link IReceivedMessage} 变更为 {@link IAReceivedMessage}
+ * @example 从服务端获取特定批量消息示例：
+ * ```ts
+ * const options = {
+ * conversationType: RongIMLib.ConversationType.ULTRA_GROUP,
+ * targetId: 'targetId',
+ * channelId: 'channelId',
+ * };
+ * // sendTime 为消息的发送时间，此处示例为假数据
+ * const messages = [{ messageUId: 'messageUId1', sendTime: 1626864000000, }];
+ * const res = await RongIMLib.getUltraGroupMessageListByMessageUId(options, messages);
+ * console.log('从服务端获取特定批量消息结果：', res);
+ * ```
  */
 declare function getUltraGroupMessageListByMessageUId(options: IConversationOption, messages: IMessageDesc[]): Promise<IAsyncRes<{
     [messageUid: string]: IAReceivedMessage | undefined;
 }>>;
 /**
- * 修改消息扩展
+ * 设置、更新消息扩展信息
+ * @description 设置、更新消息扩展信息，用于超级群消息扩展信息的设置、更新，消息扩展信息
+ * * **适用场景**：原始消息增加状态标识的需求，都可使用消息扩展
+ * 1. 消息评论需求，可通过设置原始消息扩展信息的方式添加评论信息。
+ * 2. 礼物领取、订单状态变化需求，通过此功能改变消息显示状态。 例如：向用户发送礼物，默认为未领取状态，用户点击后可设置消息扩展为已领取状态
+ * * **注意**：
+ * 1. 每次设置消息扩展将会产生内置通知消息，频繁设置扩展会产生大量消息
+ * 2. 仅当发送消息时指定 canIncludeExpansion 值为 true，才可对消息进行扩展
  * @category 超级群
+ * @since 5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
+ * @param expansion 消息扩展信息，类型是 Object。Key 支持大小写英文字母、数字、 特殊字符+ = - _ 的组合方式，不支持汉字。最大 32 个字符。<br />
+ * （SDK < 5.3.0）Value 最大 64 个字符 <br />
+ * （SDK ≧ 5.3.0）Value 最大 4096 个字符
+ * @param message 接收到的消息，类型是 {@link IAReceivedMessage}
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，code 接口返回状态码
+ * @example 设置、更新消息扩展信息示例：
+ * ```ts
+ * const expansion = { key1: 'value1' };
+ * const message = {} // 需要设置的消息，类型为 IAReceivedMessage
+ * const res = await RongIMLib.updateExpansionForUltraGroupMessage(expansion, message);
+ * console.log('设置、更新消息扩展信息结果：', res);
+ * ```
  */
 declare function updateExpansionForUltraGroupMessage(expansion: {
     [key: string]: any;
 }, message: IAReceivedMessage): Promise<IAsyncRes<void>>;
 /**
  * 删除消息扩展
+ * @description 删除消息扩展，用于超级群消息扩展信息的删除，消息扩展信息
  * @category 超级群
+ * @since 5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
+ * @param expansion 消息扩展信息的 key 数组，类型是 Array。Key 支持大小写英文字母、数字、特殊字符+ = - _ 的组合方式，不支持汉字。最大 32 个字符
+ * @param message 接收到的消息，类型是 {@link IAReceivedMessage}
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，code 接口返回状态码
+ * @example 删除消息扩展示例：
+ * ```ts
+ * const expansion = ['key1'];
+ * // message 需要删除扩展的消息，类型为 IAReceivedMessage，此处示例伪代码
+ * const res = await RongIMLib.removeExpansionForUltraGroupMessage(expansion, message);
+ * console.log('删除消息扩展结果：', res);
+ * ```
  */
 declare function removeExpansionForUltraGroupMessage(expansion: string[], message: IAReceivedMessage): Promise<IAsyncRes<void>>;
 /**
  * 删除指定消息上的所有扩展
+ * @description 删除指定消息上的所有扩展，用于超级群消息扩展信息的删除，消息扩展信息
  * @category 超级群
+ * @since 5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
+ * @param message 接收到的消息，类型是 {@link IAReceivedMessage}
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，code 接口返回状态码
+ * @example 删除指定消息上的所有扩展示例：
+ * ```ts
+ * // message 需要删除扩展的消息，类型为 IAReceivedMessage，此处示例伪代码
+ * const res = await RongIMLib.removeAllExpansionForUltraGroupMessage(message);
+ * console.log('删除指定消息上的所有扩展结果：', res);
+ * ```
  */
 declare function removeAllExpansionForUltraGroupMessage(message: IAReceivedMessage): Promise<IAsyncRes<void>>;
 /**
  * 修改消息
+ * @description 用户在成功发送超级群消息后，可以主动修改已发送消息的消息内容
+ * 消息被修改后，{@link IAReceivedMessage} 对象的 `isModifyMessage` 属性会被更新为 `true`
+ * * **注意**：
+ * 1. 消息类型无法修改。如果改前为文本消息，则传入的新消息内容必须为 {@link ITextMessageBody} 类型
+ * 2. 无法修改他人发送的消息。
  * @category 超级群
+ * @since 5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
+ * @param content 修改后的消息内容，大小不能超过 128k
+ * @param message 需要修改的消息，类型是 {@link IAReceivedMessage}
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，code 接口返回状态码
+ * @example 修改消息示例：
+ * ```ts
+ * const content = { text: '修改后的消息内容' };
+ * // message 需要修改的消息，类型为 IAReceivedMessage，此处示例伪代码
+ * const res = await RongIMLib.modifyMessage(content, message);
+ * console.log('修改消息结果：', res);
+ * ```
  */
 declare function modifyMessage(content: {
     [key: string]: any;
 }, message: IAReceivedMessage): Promise<IAsyncRes<void>>;
 /**
- * 获取超级群所有子频道的未读数
+ * 获取指定会话的未读 @ 消息数
+ * @description 获取当前用户在指定超级群会话中的未读 @ 消息数
  * @category 超级群
+ * @since 5.5.1 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
  * @param targetId 超级群 Id
- * @param notificationLevels 免打扰级别，不传或传空数组则获取全部级别
+ * @param notificationLevels 免打扰级别，不传或传空数组则获取全部级别，类型为 {@link NotificationLevel} 数组
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为未读 @ 消息数，code 接口返回状态码
+ * @example 获取指定会话的未读 @ 消息数示例：
+ * ```ts
+ * const targetId = 'targetId';
+ * const res = await RongIMLib.getUltraGroupUnreadMentionedCountByTargetId(targetId);
+ * console.log('获取指定会话的未读 @ 消息数结果：', res);
+ * ```
  */
 declare function getUltraGroupUnreadMentionedCountByTargetId(targetId: string, notificationLevels?: NotificationLevel[]): Promise<IAsyncRes<number>>;
 /**
- * 查询指定超级群默认通知配置
+ * 查询指定超级群或频道的默认免打扰级别
  * @category 超级群
+ * @since 5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
+ * @param options 查询超级群或频道的默认免打扰级别参数，包含会话类型、目标 Id、频道 Id，类型为 {@link IUltraGroupOption}
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为默认免打扰级别，code 接口返回状态码
+ * @example 查询指定超级群或频道的默认免打扰级别示例：
+ * ```ts
+ * const options = {
+ *  targetId: 'targetId',
+ *  channelId: 'channelId',
+ * };
+ * const res = await RongIMLib.getUltraGroupDefaultNotificationLevel(options);
+ * console.log('查询指定超级群或频道的默认免打扰级别结果：', res);
+ * ```
  */
 declare function getUltraGroupDefaultNotificationLevel(options: IUltraGroupOption): Promise<IAsyncRes<NotificationLevel>>;
 /**
- * 设置指定超级群默认通知配置
+ * 设置指定超级群或频道的默认免打扰级别
+ * @description 为指定的超级群设置的默认免打扰逻辑，自动适用于群下的所有频道。如果针对频道另行设置了默认免打扰逻辑，则以该频道的默认设置为准
+ * @since 5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务
  * @category 超级群
- * @param options
+ * @param options 设置超级群或频道的默认免打扰级别参数，包含会话类型、目标 Id、频道 Id，类型为 {@link IUltraGroupOption}
  * * 设置超级群默认通知配置 options: \{ targetId: 'xxx' \}, channelId 不传或传 ''
  * * 设置超级群指定频道默认通知配置 options: \{ targetId: 'xxx', channelId: 'xxx' \}
- * @param notificationLevel
- * * NotificationLevel
+ * @param notificationLevel  免打扰级别 @since 5.3.0 以后 notificationLevel 类型为 {@link NotificationLevel}
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，code 接口返回状态码
+ * @example 设置指定超级群或频道的默认免打扰级别示例：
+ * ```ts
+ * const options = {
+ *  targetId: 'targetId',
+ *  channelId: 'channelId',
+ * };
+ * const notificationLevel = RongIMLib.NotificationLevel.NOT_MESSAGE_NOTIFICATION;
+ * const res = await RongIMLib.setUltraGroupDefaultNotificationLevel(options, notificationLevel);
+ * console.log('设置指定超级群或频道的默认免打扰级别结果：', res);
+ * ```
  */
 declare function setUltraGroupDefaultNotificationLevel(options: IUltraGroupOption, notificationLevel: NotificationLevel): Promise<IAsyncRes<void>>;
 /**
- * 获取指定超级群所有频道未读数
+ * 获取指定会话的未读消息数
+ * @description 获取当前用户在指定超级群会话中的未读消息数
+ * @since 5.5.1 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
  * @category 超级群
  * @param targetId 超级群 Id
- * @param notificationLevels 免打扰级别，不传或传空数组则获取全部级别
- * @returns 未读数
+ * @param notificationLevels 免打扰级别，不传或传空数组则获取全部级别，类型为 {@link NotificationLevel} 数组
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为未读消息数，code 接口返回状态码
+ * @example 获取指定会话的未读消息数示例：
+ * ```ts
+ * const targetId = 'targetId';
+ * const res = await RongIMLib.getUltraGroupUnreadCountByTargetId(targetId);
+ * console.log('获取指定会话的未读消息数结果：', res);
+ * ```
  */
 declare function getUltraGroupUnreadCountByTargetId(targetId: string, notificationLevels?: NotificationLevel[]): Promise<IAsyncRes<number>>;
 /**
  * 超级群类型所有未读数
+ * @since 5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
  * @category 超级群
- * @returns 未读数
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为未读数，code 接口返回状态码
+ * @example 超级群类型所有未读数示例：
+ * ```ts
+ * const res = await RongIMLib.getAllUltraGroupUnreadCount();
+ * console.log('超级群类型所有未读数结果：', res);
+ * ```
  */
 declare function getAllUltraGroupUnreadCount(): Promise<IAsyncRes<number>>;
 /**
- * 超级群类型所有 @ 消息未读数
+ * 获取所有会话的未读 @ 消息数
+ * @description 获取当前用户加入的所有超级群会话中的未读 @ 消息数的总和
  * @category 超级群
- * @returns 未读数
+ * @since 5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为未读 @ 消息数，code 接口返回状态码
+ * @example 获取所有会话的未读 @ 消息数示例：
+ * ```ts
+ * const res = await RongIMLib.getAllUltraGroupUnreadMentionedCount();
+ * console.log('获取所有会话的未读 @ 消息数结果：', res);
+ * ```
  */
 declare function getAllUltraGroupUnreadMentionedCount(): Promise<IAsyncRes<number>>;
 /**
  * 超级群获取指定会话未读 @ 消息列表
+ * @description 从远端获取指定超级群频道中的未读 @ 消息的摘要数据。最多可获取 50 条（count 取值范围为 [1-50]）
+ * * **注意**：功能依赖融云服务端保存的超级群会话「未读 @ 消息摘要」数据。「@所有人」消息的摘要数据固定存储 7 天（不支持调整）。其他类型 @ 消息的摘要数据与超级群历史消息存储时长一致。
  * @category 超级群
- * @param options
- * @returns 指定会话 @ 未读数消息列表
+ * @since 5.5.2 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
+ * @param options 获取指定会话未读 @ 消息列表参数，包含会话类型、目标 Id、频道 Id、时间戳、获取数量，类型为 {@link IUltraGroupUnreadMentionedOption}
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为未读 @ 消息列表，code 接口返回状态码
+ * @example 获取指定会话未读 @ 消息列表示例：
+ * ```ts
+ * const options = {
+ *  targetId: 'targetId',
+ *  channelId: 'channelId',
+ *  sentTime: 0,
+ *  count: 10,
+ * };
+ * const res = await RongIMLib.getUltraGroupUnreadMentionedMessages(options);
+ * console.log('获取指定会话未读 @ 消息列表结果：', res);
+ * ```
 */
 declare function getUltraGroupUnreadMentionedMessages(options: IUltraGroupUnreadMentionedOption): Promise<IAsyncRes<IUltraUnreadMsg[]>>;
 /**
- * 超级群获取指定会话第一条未读消息时间戳
+ * 获取指定会话的第一条未读消息的时间戳
+ * @description 获取当前用户在指定超级群会话或指定频道的第一条未读消息的时间戳
  * @category 超级群
- * @param conversation
- * @returns 指定会话第一条未读消息时间戳
+ * @since 5.5.2 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。
+ * @param conversation 获取指定会话第一条未读消息时间戳参数，包含会话类型、目标 Id、频道 Id，类型为 {@link IUltraGroupOption}
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为指定会话第一条未读消息时间戳，code 接口返回状态码
+ * @example 获取指定会话第一条未读消息时间戳示例：
+ * ```ts
+ * const conversation = {
+ * targetId: 'targetId',
+ * channelId: 'channelId',
+ * };
+ * const res = await RongIMLib.getUltraGroupFirstUnreadMessageTimestamp(conversation);
+ * console.log('获取指定会话第一条未读消息时间戳结果：', res);
+ * ```
 */
 declare function getUltraGroupFirstUnreadMessageTimestamp(conversation: IUltraGroupOption): Promise<IAsyncRes<IUltraUnreadMsg>>;
 /**
- * 根据超级群的 targetId 数组，获取每个超级群下所有频道会话信息
- * @param targetIds
- * @returns
+ * 批量获取超级群会话信息
+ * @description 根据传入要查询的会话 id，获取该会话下所有频道的 {@link IUltraGroupUnreadInfo} 信息
  * @since 5.7.10
+ * @category 超级群
+ * @param targetIds 超级群 Id 数组，数组长度限制 [1-20] 个
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为超级群会话信息列表，code 接口返回状态码
+ * @example 批量获取超级群会话信息示例：
+ * ```ts
+ * const targetIds = ['targetId1', 'targetId2'];
+ * const res = await RongIMLib.getUltraGroupUnreadInfoList(targetIds);
+ * console.log('批量获取超级群会话信息结果：', res);
+ * ```
  */
 declare function getUltraGroupUnreadInfoList(targetIds: string[]): Promise<IAsyncRes<IUltraGroupUnreadInfo[]>>;
 
 /**
-   * 加入聊天室
- * @category 聊天室
- * @deprecated
-   */
+  * 加入聊天室
+  * @description 接口会创建并加入聊天室。如果聊天室已存在，则直接加入聊天室
+  * @category 聊天室
+  * @param options 加入聊天室配置参数
+  * @param targetId 聊天室 ID
+  * @deprecated 从 @since 5.8.3 开始废弃该方法，请使用 {@link joinExistChatRoom} 代替
+  */
 declare function joinChatRoom(targetId: string, options: {
     /**
      * 拉取消息数
@@ -1481,7 +2181,24 @@ declare function joinChatRoom(targetId: string, options: {
 }): Promise<IAsyncRes<void>>;
 /**
  * 加入已存在的聊天室
+ * @description 聊天室已存在，在获取 `chatRoomId` 后可以调用 `joinExistChatRoom` 加入聊天室。该方法只能加入已存在的聊天室。
+ * * **注意**：
+ * 1. Electron 平台从 5.7.0 开始提供该接口
+ * 2. 从 5.8.3 开始，成功回调的 data 数据中返回聊天室信息和禁言状态，详见 IChatroomJoinResponse
+ * 3. 断网重连场景下，SDK 重新加入聊天室成功后，会按照加入聊天室时传入的 count 值拉取固定数量的消息。拉取的消息有可能在本地已存在，App 可能需要进行排重后再显示
+ * @param options 加入聊天室配置参数, count 为进入聊天室时获取历史消息的数量，数量范围：1-50。如果传 -1，表示不获取任何历史消息。如果传 0，表示使用 SDK 默认设置（默认为获取 10 条）
+ * @param targetId 聊天室 ID
+ * @defaultValue options.count 为 10
  * @category 聊天室
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 {@link IChatroomJoinResponse} 类型
+ * @example
+ * 加入已存在的聊天室示例：
+ * ```ts
+ * const chatRoomId = 'chatroomId';
+ * const options = { count: 10 };
+ * const res = await RongIMLib.joinExistChatRoom(chatRoomId, options);
+ * console.log('加入已存在的聊天室结果：', res);
+ * ```
  */
 declare function joinExistChatRoom(targetId: string, options: {
     /**
@@ -1491,13 +2208,36 @@ declare function joinExistChatRoom(targetId: string, options: {
 }): Promise<IAsyncRes<IChatroomJoinResponse>>;
 /**
  * 退出聊天室
+ * @description 客户端用户可主动退出聊天室，退出后不再接收聊天室消息
  * @category 聊天室
+ * @param targetId 聊天室 ID
+ * @example
+ * 退出聊天室示例：
+ * ```ts
+ * const chatRoomId = 'chatroomId';
+ * const res = await RongIMLib.quitChatRoom(chatRoomId);
+ * console.log('退出聊天室结果：', res);
+ * ```
  */
 declare function quitChatRoom(targetId: string): Promise<IAsyncRes<void>>;
 /**
- * 获取聊天室房间数据
+ * 查询聊天室房间信息
  * @category 聊天室
- * @description count 或 order 有一个为0时,只返回成员总数，不返回成员列表信息
+ * @description 获取聊天室的信息，返回聊天室成员总数和指定数量（最多 20 个）的聊天室成员的列表，包括该成员的用户 ID 以及加入聊天室的时间
+ * * **注意**：
+ * 1. count 或 order 有一个为 0 时，只返回成员总数，不返回成员列表信息， order 人员排序方式，`1` 为正序，`2` 为倒序，默认为 `0` 不返回
+ * 2. 单个设备每秒钟支持调用一次，每分钟单个设备最多调用 20 次
+ * @param targetId 聊天室 ID
+ * @param options 查询聊天室信息配置参数
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 {@link IChatroomInfo} 类型
+ * @example
+ * 查询聊天室房间信息示例：
+ * ```ts
+ * const chatRoomId = 'chatroomId';
+ * const options = { count: 10, order: 1 };
+ * const res = await RongIMLib.getChatRoomInfo(chatRoomId, options);
+ * console.log('查询聊天室房间信息结果：', res);
+ * ```
  */
 declare function getChatRoomInfo(targetId: string, options?: {
     /**
@@ -1505,59 +2245,148 @@ declare function getChatRoomInfo(targetId: string, options?: {
      */
     count?: number;
     /**
-     * 聊天室的人员排序，默认为 0
+     * 聊天室的人员排序，默认为 0 不返回
      * * 1: 升序
      * * 2: 降序
      */
     order?: 0 | 1 | 2;
 }): Promise<IAsyncRes<IChatroomInfo>>;
 /**
- * 设置聊天室自定义属性
+ * 设置单个属性
+ * @description 设置聊天室属性，支持设置 Key-Value 类型的属性信息
+ * * **功能局限性：**
+ *  1. 聊天室销毁后，聊天室中的自定义属性同时销毁。
+ *  2. 每个聊天室中，最多允许设置 100 个属性信息，以 Key-Value 的方式进行存储。
+ *  3. 客户端 SDK 未针对聊天室属性 KV 的操作频率进行限制。建议每个聊天室，每秒钟操作 Key-Value 频率保持在 100 次及以下（一秒内单次操作 100 个 KV 等同于操作 100 次）。
+ *
+ * * **注意**：
+ *  1. 使用该接口需要开通 `聊天室属性自定义设置` 功能，您可以前往控制台的免费基础功能页面开启服务。
+ *  2. 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
  * @category 聊天室
- * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
+ * @param targetId 聊天室 ID
+ * @param options 设置聊天室属性配置参数，类型为 {@link IChatRoomEntry}
+ * @example 设置单个属性示例：
+ * ```ts
+ * const chatRoomId = 'chatroomId';
+ * const options = {
+ *  key: 'key',
+ *  value: 'value',
+ * };
+ * const res = await RongIMLib.setChatRoomEntry(chatRoomId, options);
+ * console.log('设置单个属性结果：', res);
+ * ```
  */
-declare function setChatRoomEntry(targetId: string, options: IChatRoomEntry): Promise<IAsyncRes<void>>;
+declare function setChatRoomEntry(targetId: string, options: IChatroomEntry): Promise<IAsyncRes<void>>;
 /**
- * 批量设置聊天室自定义属性
+ * 批量设置属性
+ *
  * @category 聊天室
- * @param options ISetChatroomEntryOption数组
+ * @description 批量设置聊天室属性
+ * * **功能局限性：**
+ * * 聊天室销毁后，聊天室中的自定义属性同时销毁。
+ * * 每个聊天室中，最多允许设置 100 个属性信息，以 Key-Value 的方式进行存储。
+ * * 客户端 SDK 未针对聊天室属性 KV 的操作频率进行限制。建议每个聊天室，每秒钟操作 Key-Value 频率保持在 100 次及以下（一秒内单次操作 100 个 KV 等同于操作 100 次）。
+ *
+ * * **注意**：
+ * 1. 使用该接口需要开通 `聊天室属性自定义设置` 功能，您可以前往控制台的免费基础功能页面开启服务。
+ * 2. 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
+ * @param targetId 聊天室 ID
+ * @param options 设置聊天室属性配置参数
+ * 类型为 {@link IChatroomEntries} @since 5.3.4 版本开始，该接口同时支持通过 isForce 属性强制设置多个属性值。强制设置可直接覆盖他人创建的属性值。
+ * @example 批量设置属性示例：
+ * ```ts
+ * const chatRoomId = 'chatroomId';
+ * const options = { entries: [{ key: 'key', value: 'value' }] };
+ * const res = await RongIMLib.setChatRoomEntries(chatRoomId, options);
+ * console.log('批量设置属性结果：', res);
+ * ```
  */
 declare function setChatRoomEntries(targetId: string, options: IChatroomEntries): Promise<IAsyncRes<void>>;
 /**
- * 强制 增加/修改 任意聊天室属性
+ * 强制设置单个属性
  * @category 聊天室
- * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
+ * @description 强制设置单个聊天室属性。可用于修改他人创建的属性值，以 key = value 的形式存储。当 key 不存在时，代表增加属性； 当 key 已经存在时，代表更新属性的值。使用强制设置可修改他人创建的属性值
+ * @param targetId 聊天室 ID
+ * @param options 设置聊天室属性配置参数，类型为 {@link IChatroomEntry}
+ * @example 强制设置单个属性示例：
+ * ```ts
+ * const chatRoomId = 'chatroomId';
+ * const options = {
+ *  key: 'key',
+ *  value: 'value',
+ * };
+ * const res = await RongIMLib.forceSetChatRoomEntry(chatRoomId, options);
+ * console.log('强制设置单个属性结果：', res);
+ * ```
  */
-declare function forceSetChatRoomEntry(targetId: string, options: IChatRoomEntry): Promise<IAsyncRes<void>>;
+declare function forceSetChatRoomEntry(targetId: string, options: IChatroomEntry): Promise<IAsyncRes<void>>;
 /**
- * 删除聊天室属性
+ * 删除单个属性
  * @category 聊天室
- * @description 仅限于删除自己设置的聊天室属性
- * @param key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式,最大长度 128 字符
- * @param isSendNotification? 删除成功后是否发送通知消息
- * @param notificationExtra? RC:chrmKVNotiMsg 通知消息中携带的附加信息
+ * @description 删除聊天室自定义属性。只可删除当前用户所创建的属性
+ * @param targetId 聊天室 ID
+ * @param options 删除聊天室属性配置参数，类型为 {@link IRemoveChatroomEntry}
+ * @example 删除单个属性示例：
+ * ```ts
+ * const targetId = 'chatroomId';
+ * const options = {
+ *  key: 'key',
+ * };
+ * const res = await RongIMLib.removeChatRoomEntry(targetId, options);
+ * console.log('删除单个属性结果：', res);
+ * ```
  */
-declare function removeChatRoomEntry(targetId: string, options: IRemoveChatRoomEntry): Promise<IAsyncRes<void>>;
+declare function removeChatRoomEntry(targetId: string, options: IRemoveChatroomEntry): Promise<IAsyncRes<void>>;
 /**
  * 批量删除聊天室属性
  * @category 聊天室
- * @description 仅限于删除自己设置的聊天室属性
- * @param entries[] 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
- * @param notificationExtra? RC:chrmKVNotiMsg 通知消息中携带的附加信息
+ * @description 删除聊天室自定义属性。只可删除当前用户所创建的属性
+ * @param targetId 聊天室 ID
+ * @param options 删除聊天室属性配置参数
+ * @example 批量删除聊天室属性示例：
+ * ```ts
+ * const targetId = 'chatroomId';
+ * const options = {
+ *  entries: ['key'],
+ * };
+ * const res = await RongIMLib.removeChatRoomEntries(targetId, options);
+ * console.log('批量删除聊天室属性结果：', res);
+ * ```
  */
 declare function removeChatRoomEntries(targetId: string, options: {
     entries: string[];
     notificationExtra?: string;
 }): Promise<IAsyncRes<void>>;
 /**
- * 强制删除聊天室内的任意属性
+ * 强制删除
  * @category 聊天室
- * @description
+ * @description 强制删除聊天室自定义属性。可删除他人所创建的属性
+ * @param targetId 聊天室 ID
+ * @param options 删除聊天室属性配置参数，类型为 {@link IRemoveChatroomEntry}
+ * @example 强制删除示例：
+ * ```ts
+ * const targetId = 'chatroomId';
+ * const options = {
+ *  key: 'key',
+ * };
+ * const res = await RongIMLib.forceRemoveChatRoomEntry(targetId, options);
+ * console.log('强制删除结果：', res);
+ * ```
  */
-declare function forceRemoveChatRoomEntry(targetId: string, options: IRemoveChatRoomEntry): Promise<IAsyncRes<void>>;
+declare function forceRemoveChatRoomEntry(targetId: string, options: IRemoveChatroomEntry): Promise<IAsyncRes<void>>;
 /**
- * 获取聊天室的指定属性
+ * 获取单个属性
+ * @description 获取单个聊天室属性
  * @category 聊天室
+ * @param targetId 聊天室 ID
+ * @param key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
+ * @example 获取单个属性示例：
+ * ```ts
+ * const targetId = 'chatroomId';
+ * const key = 'key';
+ * const res = await RongIMLib.getChatRoomEntry(targetId, key);
+ * console.log('获取单个属性结果：', res);
+ * ```
  */
 declare function getChatRoomEntry(targetId: string, 
 /**
@@ -1565,44 +2394,124 @@ declare function getChatRoomEntry(targetId: string,
    */
 key: string): Promise<IAsyncRes<string | number | boolean>>;
 /**
- * 获取聊天室的所有属性
+ * 获取所有属性
+ * @description 获取聊天室所有属性
  * @category 聊天室
+ * @param targetId 聊天室 ID
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为一个对象，包含聊天室所有属性，格式为 { [key: string]: string | number | boolean }
+ * @example 获取所有属性示例：
+ * ```ts
+ * const targetId = 'chatroomId';
+ * const res = await RongIMLib.getAllChatRoomEntries(targetId);
+ * console.log('获取所有属性结果：', res);
+ * ```
  */
 declare function getAllChatRoomEntries(targetId: string): Promise<IAsyncRes<{
     [key: string]: string | number | boolean;
 }>>;
 /**
  * 获取聊天室的历史消息
+ * @description 获取聊天室的历史消息接口要求开通`聊天室消息云端存储服务`。使用前请确认已开通服务。开通后聊天室历史消息保存在云端，默认保存 2 个月
  * @category 聊天室
+ * @param targetId 聊天室 ID
+ * @param options 获取历史消息配置参数，类型为 {@link GetHistoryMessageOption}
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 {@link GetHistoryMessageResult} 类型
+ * @example 获取聊天室的历史消息示例：
+ * ```ts
+ * const chatRoomId = 'chatroomId';
+ * const options = {
+ *  count: 10,
+ *  order: 1,
+ *  timestamp: 0,
+ * };
+ * const res = await RongIMLib.getChatroomHistoryMessages(chatRoomId, options);
+ * console.log('获取聊天室的历史消息结果：', res);
+ * ```
  */
 declare function getChatroomHistoryMessages(targetId: string, options: GetHistoryMessageOption): Promise<IAsyncRes<GetHistoryMessageResult>>;
 /**
- * 将聊天室和 RTC 房间绑定
+ * 绑定音视频房间
+ * @description 聊天室与音视频房间绑定成功后，只要音视频房间仍存在，则阻止聊天室自动销毁
+ * * **适用场景**：
+ * 聊天室具有自动销毁机制。在使用融云 RTC 业务的 App 中，可能配合使用 IM SDK 的聊天室业务实现直播聊天、弹幕、属性记录等功能。
+ * 这种情况下，可以考虑将聊天室与音视频房间绑定，确保聊天室不会在语聊、直播结束前销毁，以免丢失关键数据。
+ * @since 5.2.1
  * @category 聊天室
+ * @param option 绑定音视频房间配置参数，类型为 {@link IRTCRoomBindOption}
+ * @example
+ * 绑定音视频房间示例：
+ * ```ts
+ * const option = {
+ *  chatRoomId: 'chatroomId',
+ *  rtcRoomId: 'rtcRoomId',
+ * };
+ * const res = await RongIMLib.bindRTCRoomForChatroom(option);
+ * console.log('绑定音视频房间结果：', res);
+ * ```
  */
 declare function bindRTCRoomForChatroom(option: IRTCRoomBindOption): Promise<IAsyncRes<void>>;
 
 /**
- * 添加用户到黑名单
+ * 加入黑名单
+ * @description 本功能暂仅限于在 Electron 解决方案中使用，将用户加入黑名单之后，将不再收到对方发来的任何单聊消息
+ * * **注意**：
+ * 1. 加入黑名单为单向操作，例如：用户 A 拉黑用户 B，代表 B 无法给 A 发消息（错误码 405）。但 A 向 B 发消息，B 仍然能正常接收
+ * 2. 单个用户的黑名单总人数存在上限，具体与计费套餐有关。IM 旗舰版与 IM 尊享版上限为 3000 人，其他套餐详见功能对照表中的服务限制
+ * 3. 调用服务端 API 发送单聊消息默认不受黑名单限制。如需启用限制，请在调用 API 时设置 verifyBlacklist 为 1
+ * @since 5.4.0
  * @category 黑名单
  * @param userId 用户 ID
+ * @example
+ * 加入黑名单示例：
+ * ```ts
+ * const userId = 'userId';
+ * const res = await RongIMLib.addToBlacklist(userId);
+ * console.log('加入黑名单结果：', res);
+ * ```
  */
 declare function addToBlacklist(userId: string): Promise<IAsyncRes<void>>;
 /**
- * 从黑名单中移除用户
+ * 移出黑名单
+ * @description 本功能暂仅限于在 Electron 解决方案中使用, 将用户移出黑名单之后，将恢复接收对方发来的任何单聊消息
+ * @since 5.4.0
  * @category 黑名单
  * @param userId 用户 ID
+ * @example
+ * 移出黑名单示例：
+ * ```ts
+ * const userId = 'userId';
+ * const res = await RongIMLib.removeFromBlacklist(userId);
+ * console.log('移出黑名单结果：', res);
+ * ```
  */
 declare function removeFromBlacklist(userId: string): Promise<IAsyncRes<void>>;
 /**
  * 获取黑名单列表
+ * @description 本功能暂仅限于在 Electron 解决方案中使用，用来获取黑名单列表
+ * @since 5.4.0
  * @category 黑名单
+ * @param userId 用户 ID
+ * @example
+ * 获取黑名单列表示例：
+ * ```ts
+ * const res = await RongIMLib.getBlacklist();
+ * console.log('获取黑名单列表结果：', res);
+ * ```
  */
 declare function getBlacklist(): Promise<IAsyncRes<string[]>>;
 /**
  * 查询用户是否在黑名单中
+ * @description 本功能暂仅限于在 Electron 解决方案中使用，用来查询用户是否在黑名单中
+ * @since 5.4.0
  * @category 黑名单
  * @param userId 用户 ID
+ * @example
+ * 获取黑名单列表示例：
+ * ```ts
+ * const userId = 'userId';
+ * const res = await RongIMLib.getBlacklistStatus(userId);
+ * console.log('获取黑名单列表结果：', res);
+ * ```
  */
 declare function getBlacklistStatus(userId: string): Promise<IAsyncRes<boolean>>;
 
@@ -1634,7 +2543,7 @@ interface IImageMessageBody extends IExtraData, IMentionedInfo, IUserInfo, IAudi
 declare const _default$e: MessageConstructor<IImageMessageBody>;
 
 /**
- * 图片消息
+ * 语音消息
  * @category Interface
  */
 interface IHQVoiceMessageBody extends IUserInfo, IExtraData, IMentionedInfo, IAuditInfo {
@@ -1695,7 +2604,7 @@ interface ITextMessageBody extends IUserInfo, IExtraData, IMentionedInfo, IAudit
 declare const _default$b: MessageConstructor<ITextMessageBody>;
 
 /**
- * 富文本消息
+ * 合并转发消息
  * @category Interface
  */
 interface ICombineMessageBody extends IExtraData, IUserInfo, IMentionedInfo {
@@ -1718,6 +2627,11 @@ interface ICombineMessageBody extends IExtraData, IUserInfo, IMentionedInfo {
 }
 declare const _default$a: MessageConstructor<ICombineMessageBody>;
 
+/**
+ * 合并消息
+ * @category Type
+ * @hidden
+ */
 declare type CombineV2MessageContent = ICombineV2MessageContent & IExtraData & IUserInfo & IMentionedInfo;
 declare const _default$9: MessageConstructor<CombineV2MessageContent>;
 
@@ -1779,6 +2693,7 @@ interface IVoiceMessageBody extends IExtraData, IMentionedInfo, IUserInfo, IAudi
 declare const _default$6: MessageConstructor<IVoiceMessageBody>;
 
 /**
+ * 本地消息
  * @category Interface
  */
 interface ILocationMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
@@ -1802,6 +2717,7 @@ interface ILocationMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
 declare const _default$5: MessageConstructor<ILocationMessageBody>;
 
 /**
+ * 引用消息
  * @category Interface
  */
 interface IReferenceMessageBody extends IExtraData, IMentionedInfo, IUserInfo, IAuditInfo {
@@ -1835,6 +2751,7 @@ interface IArticle {
     url: string;
 }
 /**
+ * 富文本消息
  * @category Interface
  */
 interface IRichContentMessageBody extends IArticle, IExtraData, IMentionedInfo, IUserInfo {
@@ -1903,40 +2820,165 @@ declare const _default: MessageConstructor<IGroupNotificationMessageBody>;
 
 /**
 * 发送消息
+* @description 发送消息的基础接口，可用来发送 IMLib 中的内置类型消息或自定义消息。针对不同的特定消息类型
 * @category 消息
-* @param options
+* @param conversation 会话信息
+* @param message 消息体，类型为 BaseMessage 的子类，如 TextMessage、ImageMessage，通过 new TextMessage() 获取
+* @param options 发送消息配置项
+*
+* @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedMessage} 类型
+*
+* @example
+* 发送文本消息示例：
+* ```ts
+* const content = {content: 'hello world'};
+* const message = new RongIMLib.TextMessage(content);
+* const conversation = {
+*  conversationType: RongIMLib.ConversationType.PRIVATE,
+*  targetId: 'targetId'
+* }
+* const sendRes = await RongIMLib.sendMessage(conversation, message);
+* console.info('消息发送结果：', sendRes);
+* ```
 */
 declare function sendMessage(conversation: IConversationOption, message: BaseMessage, options?: ISendMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>;
 /**
- * 发送文本消息
-  * @category 消息
- */
+* 发送文本消息
+* @description 发送文本消息的快捷方式，等同于使用 new TextMessage() 创建消息体后调用 sendMessage() 方法
+* @category 消息
+* @param conversation 会话信息
+* @param messageBody 消息体
+* @param options 发送消息配置项
+*
+* @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedMessage} 类型
+*
+* @example
+* 发送文本消息示例：
+* ```ts
+* const messageBody = {content: 'hello world'};
+* const conversation = {
+*  conversationType: RongIMLib.ConversationType.PRIVATE,
+*  targetId: 'targetId'
+* }
+* const sendRes = await RongIMLib.sendTextMessage(conversation, messageBody);
+* console.info('消息发送结果：', sendRes);
+* ```
+*/
 declare function sendTextMessage(conversation: IConversationOption, messageBody: ITextMessageBody, options?: ISendMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>;
+/**
+ * 发送消息基础类型
+ * @category Type
+ */
 declare type ISendBody = IUserInfo & IExtraData & {
     file: File;
 } & IMentionedInfo & IAuditInfo;
-declare type ISendFileMessageOptions = ISendBody;
 /**
- * 发送文件消息
- * @category 消息
+ * 发送文件消息配置项
+ * @category Type
  */
+declare type ISendFileMessageOptions = ISendBody;
+/**
+* 发送文件消息
+* @description 发送文件消息的快捷方式，等同于使用 new FileMessage() 创建消息体后调用 sendMessage() 方法，支持文件上传，上传成功后自动发送消息
+* @category 消息
+* @param conversation 会话信息
+* @param msgBody 消息体，其中 file 为待上传文件引用
+* @param hooks 上传文件过程中的回调钩子，类型为 {@link IUploadHooks} 可选
+* @param sendOptions 文件消息配置项，类型为 {@link IUploadMessageOption} 可选
+*
+* @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedMessage} 类型
+*
+* @example
+* 发送文本消息示例：
+* ```ts
+* const msgBody = { file }; // file 为待上传文件
+* const conversation = {
+*  conversationType: RongIMLib.ConversationType.PRIVATE,
+*  targetId: 'targetId'
+* }
+* const sendRes = await RongIMLib.sendFileMessage(conversation, msgBody);
+* console.info('消息发送结果：', sendRes);
+* ```
+*/
 declare const sendFileMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
+/**
+ * 发送图片消息配置项
+ * @category Type
+ */
 declare type ISendImageMessageOptions = ISendBody;
 /**
  * 发送图片消息
+ * @description 发送图片消息的快捷方式，等同于使用 new ImageMessage() 创建消息体后调用 sendMessage() 方法，支持图片上传，上传成功后自动发送消息
  * @category 消息
+ * @param conversation 会话信息
+ * @param msgBody 消息体，其中 file 为待上传图片引用
+ * @param hooks 上传图片过程中的回调钩子，类型为 {@link IUploadHooks} 可选
+ * @param sendOptions 图片消息配置项，类型为 {@link IImageMessageOption} 可选
+ *
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedMessage} 类型
+ * @example
+ * 发送图片消息示例：
+ * ```ts
+ * const msgBody = { file }; // file 为待上传图片
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId'
+ * }
+ * const sendRes = await RongIMLib.sendImageMessage(conversation, msgBody);
+ * console.info('消息发送结果：', sendRes);
+ * ```
  */
 declare const sendImageMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IImageMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
 /**
- * 发送 GIF图片消息
+ * 发送 GIF 图片消息
+ * @description 发送 GIF 图片消息的快捷方式，等同于使用 new GIFMessage() 创建消息体后调用 sendMessage() 方法，支持 GIF 图片上传，上传成功后自动发送消息
  * @category 消息
+ * @param conversation 会话信息
+ * @param msgBody 消息体，其中 file 为待上传 GIF 图片引用
+ * @param hooks 上传 GIF 图片过程中的回调钩子，类型为 {@link IUploadHooks} 可选
+ * @param sendOptions GIF 图片消息配置项，类型为 {@link IGIFMessageOption} 可选
+ *
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedMessage} 类型
+ * @example
+ * 发送 GIF 图片消息示例：
+ * ```ts
+ * const msgBody = { file }; // file 为待上传 GIF 图片
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId'
+ * }
+ * const sendRes = await RongIMLib.sendGIFMessage(conversation, msgBody);
+ * console.info('消息发送结果：', sendRes);
+ * ```
  */
 declare const sendGIFMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
 /**
- * 发送高清语音消息，待发送的文件必须为 AAC 音频文件
+ * 发送高清语音消息
+ * @description 待发送的文件必须为 AAC 音频文件。
+ * 发送高清语音消息的快捷方式，等同于使用 new HQVoiceMessage() 创建消息体后调用 sendMessage() 方法，支持高清语音上传，上传成功后自动发送消息
  * @category 消息
+ * @param conversation 会话信息
+ * @param msgBody 消息体，其中 file 为待上传高清语音引用
+ * @param hooks 上传高清语音过程中的回调钩子，类型为 {@link IUploadHooks} 可选
+ * @param sendOptions 高清语音消息配置项，类型为 {@link ISendHQVoiceMessageOptions} 可选
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedMessage} 类型
+ * @example
+ * 发送高清语音消息示例：
+ * ```ts
+ * const msgBody = { file }; // file 为待上传高清语音
+ * const conversation = {
+ * conversationType: RongIMLib.ConversationType.PRIVATE,
+ * targetId: 'targetId'
+ * }
+ * const sendRes = await RongIMLib.sendHQVoiceMessage(conversation, msgBody);
+ * console.info('消息发送结果：', sendRes);
+ * ```
  */
 declare const sendHQVoiceMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
+/**
+ * 发送小视频消息配置项
+ * @category Type
+ */
 declare type ISendSightMessageOptions = {
     duration: number;
     thumbnail: string;
@@ -1945,64 +2987,175 @@ declare type ISendSightMessageOptions = {
 /**
  * 发送小视频消息
  * @category 消息
- * @description 发送的小视频消息必须是 MP4 文件，且音频编码为 AAC，视频编码 H264，否则可能造成 iOS 或 Android 接收后不可播放问题
+ * @description 发送的小视频消息必须是 MP4 文件，且音频编码为 AAC，视频编码 H264，否则可能造成 iOS 或 Android 接收后不可播放问题。
+ * 发送小视频消息的快捷方式，等同于使用 new SightMessage() 创建消息体后调用 sendMessage() 方法，支持小视频上传，上传成功后自动发送消息
+ * @param conversation 会话信息
+ * @param msgBody 消息体，其中 file 为待上传小视频引用
+ * @param hooks 上传小视频过程中的回调钩子，类型为 {@link IUploadHooks} 可选
+ * @param sendOptions 小视频消息配置项，类型为 {@link ISendSightMessageOptions} 可选
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedMessage} 类型
+ * @example
+ * 发送小视频消息示例：
+ * ```ts
+ * const msgBody = { file, duration: 10, thumbnail: 'base64' }; // file 为待上传小视频，duration 为小视频时长，thumbnail 为小视频封面 base64
+ * const conversation = {
+ * conversationType: RongIMLib.ConversationType.PRIVATE,
+ * targetId: 'targetId'
+ * }
+ * const sendRes = await RongIMLib.sendSightMessage(conversation, msgBody);
+ * console.info('消息发送结果：', sendRes);
+ * ```
  */
 declare const sendSightMessage: (conversation: IConversationOption, msgBody: ISendSightMessageOptions, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
 /**
  * 获取历史消息
- * Electron 获取的是本地数据库
- * Web 获取的是远端历史消息
  * @category 消息
+ * @description 获取历史消息，支持分页加载，可指定时间戳、数量、排序方式等参数进行分页获取。
+ *  1. Count 最大值为 100，超过 100 时返回错误码 34232：开发者接口调用时传入的 count 非法
+ *  2. 如果 `SDK < 5.7.4`，范围为 [1-20]；如果 SDK ≧ 5.7.4，范围为 [1-100]。默认值 `20`
+ * * **注意**：
+ *  1. Electron 获取的是本地数据库
+ *  2. Web 获取的是远端历史消息，Web 端不具备持久化的数据存储能力，无法在本地持久化存储历史消息记录与会话列表，因此需要从融云服务端获取数据。
+ *  3. 请确保已开通单群聊消息云端存储服务，如未开通服务请移步到融云开发者后台的 IM 服务管理模块开启。
+ * @param conversation 会话信息
+ * @param options 获取历史消息配置项，类型为 {@link GetHistoryMessageOption} 可选
+ * @defaultValue options = { timestamp: 0, count: 20, order: 0 }
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link GetHistoryMessageResult} 类型
+ *
+ * @example
+ * 获取历史消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const messages = await RongIMLib.getHistoryMessages(conversation);
+ * console.info('获取历史消息结果：', messages);
  */
 declare function getHistoryMessages(conversation: IConversationOption, options?: GetHistoryMessageOption): Promise<IAsyncRes<GetHistoryMessageResult>>;
 /**
  * 获取远程历史消息
  * @category 消息
+ * @description 获取远程历史消息，支持分页加载，可指定时间戳、数量、排序方式等参数进行分页获取。
+ * 1. Count 最大值为 100，超过 100 时返回错误码 34232：开发者接口调用时传入的 count 非法
+ * 2. 如果 `SDK < 5.7.4`，范围为 [1-20]；如果 SDK ≧ 5.7.4，范围为 [1-100]。默认值 `20`
+ * * **注意**：
+ * 需要开启单群聊消息云存储服务后，才可以从远端拉取历史消息，服务请移步到融云开发者后台的 IM 服务管理模块开启。
+ *
+ * @param conversation 会话信息
+ * @param options 获取历史消息配置项，类型为 {@link GetHistoryMessageOption} 可选
+ * @defaultValue options = { timestamp: 0, count: 20, order: 0 }
+ *
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link GetHistoryMessageResult} 类型
+ * @example
+ * 获取远程历史消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const messages = await RongIMLib.getRemoteHistoryMessages(conversation);
+ * console.info('获取远程历史消息结果：', messages);
  */
 declare function getRemoteHistoryMessages(conversation: IConversationOption, options?: GetHistoryMessageOption): Promise<IAsyncRes<GetHistoryMessageResult>>;
 /**
  * 发送单聊已读回执
+ * @description 发送单聊已读回执，用于标记已读消息
+ * * **实现已读功能步骤：**
+ * 1. 在用户查看了某单聊会话的未读消息后，调用 sendReadReceiptMessage 发送已读回执。
+ * 2. 通过 addEventListener 设置消息回执监听器。
+ * 3. SDK 在收到消息已读回执时派发 READ_RECEIPT_RECEIVED 事件。
+ *
+ * * **注意**：
+ * 1. 在 Web 平台，SDK 不会记录每个会话和消息的已读状态，您需要在 localStorage 中记录每个会话的已读时间。在渲染消息列表时，根据 localStorage 中时间判断消息是否已读，更新对应的消息界面。
+ * 2. 在 Electron 平台，收到 READ_RECEIPT_RECEIVED 通知时，您需要调用
+ * {@link electronExtension.setMessageStatusToRead} 方法更新消息已读状态，并更新对应的消息界面。
+ * 3. 调用 `sendReadReceiptMessage` 接口不会清除未读数，需单独调用清除未读数接口 {@link clearMessagesUnreadStatus}。
+ *
+ * @param targetId 目标 ID
+ * @param messageUId 消息唯一标识，可在 Message 中获取
+ * @param timestamp 消息的发送时间，可通过 Message 中 sendTime 获取
  * @category 消息
+ * @example
+ * 单聊消息回执示例：
+ * ```ts
+ * const targetId = 'targetId';
+ * const messageUId = 'BS4O-QEBR-VJM6-9GPP';
+ * const timestamp = 1632728573423;
+ *
+ * const readReceiptRes = await RongIMLib.sendReadReceiptMessage(targetId, messageUId, timestamp);
+ * console.info('单聊消息回执：', readReceiptRes)
+ * ```
  */
 declare function sendReadReceiptMessage(targetId: string, messageUId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<void>>;
 /**
  * 发送群已读回执请求
+ * @description 实现群聊中按需获取己方发送消息的阅读状态请求。与群聊已读回执响应接口 {@link sendReadReceiptResponseV2} 配套使用。单独调用无法实现群回执能力
+ *
  * @category 消息
+ * @param targetId 目标 ID
  * @param messageUIds 消息UID列表
+ *
+ *@example
+ * 群已读回执请求示例：
+ * ```ts
+ * const targetId = 'targetId';
+ * const messageUId = 'BS4O-QEBR-VJM6-9GPP';
+ * const readReceiptRes = await RongIMLib.sendReadReceiptRequest(targetId, messageUId);
+ * console.info('群已读回执请求：', readReceiptRes)
+ * ```
  */
 declare function sendReadReceiptRequest(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<void>>;
 /**
  * @category 消息
- * @deprecated 已废弃，请使用 sendReadReceiptResponseV2
+ * @deprecated 已废弃，@since  5.1.1。请替换使用 {@link sendReadReceiptResponseV2} 方法
  */
 declare function sendReadReceiptResponse(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes<void>>;
 /**
  * 发送群阅读回执响应V2
+ * @description 实现群聊中按需获取己方发送消息的阅读状态响应。
+ * 与群聊已读回执请求接口 {@link sendReadReceiptRequest} 配套使用。单独调用无法实现群回执能力
+ * * **注意**：
+ * 5.9.4 版本之后，SDK 内部维护了已读回执请求信息，并在历史消息列表里携带已读回执信息：readReceiptInfo, 在 Web 平台和 Electron 平台实现不同之处：
+ * Web 和 Electron 平台的区别：
+ * 1. 在 Web 平台，SDK 内部会缓存每个群会话的最新 30 个已读回执信息（以已读回执请求的发送时间为准），缓存有效期为 24H。
+ * 在发送消息回执响应时无需传 messageList 字段，SDK 会把该会话下的所有请求组织好然后发送响应。
+ *
+ * 2. 在 Electron 平台，用户需先获取历史消息，取出 message.messageDirection = MessageDirection.RECEIVE , readReceiptInfo.
+ * isReceiptRequestMessage = true 并且 readReceiptInfo.hasRespond = false 的数据组织成参数 messageList 来发送回执响应。
  * @category 消息
- *  @param targetId 群组Id
- *  @param messageList 要回执的消息列表，结构为： \{senderUserId: [messageUId1, messageUId2]\}
- *  @param channelId
+ * @param targetId 群组Id
+ * @param messageList 要回执的消息列表，结构为： \{senderUserId: [messageUId1, messageUId2]\}
+ * @since  5.1.1
+ * @example
+ * 群已读回执响应示例：
+ * ```ts
+ * const targetId = 'targetId';
+ * const messageList = {
+ *  'senderUserId': ['messageUId1', 'messageUId2'],
+ * }
+ * const readReceiptRes = await RongIMLib.sendReadReceiptResponseV2(targetId, messageList);
+ * console.info('群已读回执响应：', readReceiptRes);
  */
 declare function sendReadReceiptResponseV2(targetId: string, messageList?: {
     [senderUserId: string]: string[];
 }, channelId?: string): Promise<IAsyncRes<void>>;
 /**
  * 多端同步阅读状态
+ * @description 由于未读消息数存储在本地，服务器不存未读消息数量。当用户多端登录时，需要同步未读消息数以保证多端未读数一致
  * @param conversation 会话信息
- * @param timestamp 时间戳
+ * @param timestamp 需要同步消息阅读的时间戳，可以在消息体中通过消息的 sendTime 获取
+ * @category 消息
  * @example
- * ```js
- * const con = {
- *   conversationType: ConversationType.Group,
- *   targetId: 'targetId'
+ * 多端同步阅读状态示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
  * }
- * sendSyncReadStatusMessage(con, Date.now()).then(res => {
- *   if (res.code === ErrorCode.success) {
- *     console.log('send success', res.data)
- *   } else {
- *     console.log('send error', res.msg)
- *   }
- * })
+ * const timestamp = 1632728573423; // 阅读消息的 sendTime
+ * const syncReadStatusRes = await RongIMLib.sendSyncReadStatusMessage(conversation, timestamp);
+ * console.info('多端同步阅读状态：', syncReadStatusRes);
  * ```
  */
 declare function sendSyncReadStatusMessage(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes<void>>;
@@ -2040,7 +3193,7 @@ declare function sendReadReceiptMessageV4(conversation: IConversationOption, end
  * @since 5.9.0
  * @hidden
  * @param conversation 会话信息, 仅支持群聊
- * @param messageUid 消息 UId
+ * @param messageUId 消息 UId
  * @example
  * ```js
  * const con = {
@@ -2083,13 +3236,54 @@ declare function getMessageReadReceiptV4(conversation: IConversationOption, mess
 declare function batchGetMessageReadReceiptInfoV4(conversation: IConversationOption, messageUIds: string[]): Promise<IAsyncRes<IGroupReadReceiptData[]>>;
 /**
  * 撤回消息
+ * @description 融云对撤回消息的操作者不作限制。
+ * 如需避免用户撤回非本人发送的消息，可以提交工单申请打开IMLib SDK 只允许撤回自己发送的消息。从融云服务端进行限制，禁止用户撤回非本人发送的消息。
  * @category 消息
- * @param options
+ * @param conversation 会话信息
+ * @param options 撤回消息参数
+ * @example
+ * 撤回消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const options = {
+ *  messageUId: 'messageUId',
+ *  sentTime: 1632728573423,
+ * }
+ * const recallRes = await RongIMLib.recallMessage(conversation, options);
+ * console.info('撤回消息结果：', recallRes);
+ * ```
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedMessage} 类型
  */
 declare function recallMessage(conversation: IConversationOption, options: IRecallMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>;
 /**
  * 按消息 UId 删除消息
  * @category 消息
+ * @description 根据消息的 ID、时间戳和方向（发送或接收）从服务端删除指定单个会话中的一条或一组消息。
+ * * **注意**：
+ * 1. 删除消息仅会删除本端消息，不会删除对端消息。A 与 B 之间的消息，A 删除消息后，B 仍然可以看到消息。如 B 需要无法查看需要调用撤回消息 {@link recallMessage}接口。
+ * 2. 仅适用于 App Key 已开通单群聊消息云端存储 的 App。
+ * 3. 服务端默认不会删除对应的离线消息补偿，如需彻底删除消息补偿，请提交工单，申请开通删除服务端历史消息时同时删除多端补偿的离线消息。
+ *
+ * @param conversation 会话信息
+ * @param messages 消息列表
+ * @example
+ * 按消息 UId 删除消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * };
+ * const messages = [{
+ *  messageUId: 'BS4O-P5AO-D1O6-9GPP', // 消息 UId
+ *  sentTime: 1632728573423, // 消息发送时间
+ *  messageDirection: RongIMLib.MessageDirection.SEND, // 消息方向
+ * }];
+ * const deleteRes = await RongIMLib.deleteMessages(conversation, messages);
+ * console.info('删除消息结果：', deleteRes);
+ * ```
  */
 declare function deleteMessages$1(conversation: IConversationOption, messages: {
     /**
@@ -2109,23 +3303,37 @@ declare function deleteMessages$1(conversation: IConversationOption, messages: {
 }[]): Promise<IAsyncRes<void>>;
 /**
  * 按时间戳删除消息
+ * @description 根据时间戳删除指定单个会话中早于（含）指定时间戳的所有消息。
  * @category 消息
  * @param conversation 会话
  * @param timestamp 清除时间点, 该时间之前的消息将被清除
+ *
+ * @example
+ * 按时间戳删除消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const timestamp = 1632728573423;
+ * const clearRes = await RongIMLib.clearHistoryMessages(conversation, timestamp);
+ * console.info('清除消息结果：', clearRes);
+ * ```
  */
 declare function clearHistoryMessages(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes<void>>;
 /**
+ * @hidden
  * 批量删除多个会话的远端消息
+ * @category 消息
+ * @description 批量删除服务端多个会话早于（含）发送时间的所有远端消息（Electron 平台可以删除对应的本地消息）
  * @param conversations 会话列表，最大数量为 20
  * @param isDeleteLocal 是否删除本地消息, 仅 Electron 平台支持，默认为 false
- * @category 消息
  * @since 5.9.0
- * @hidden
- * @description 批量删除服务端多个会话早于（含）发送时间的所有远端消息（Electron 平台可以删除对应的本地消息）,
  * 时间戳，传 0 清除所有消息
  * 支持的会话类型：单聊, 群聊,  聊天室, 系统消息
  * @example
- * ```js
+ * 批量删除多个会话的远端消息示例：
+ * ```ts
  *  batchClearHistoryMessages([
  *   {
  *    conversationType: ConversationType.PRIVATE,
@@ -2140,91 +3348,190 @@ declare function clearHistoryMessages(conversation: IConversationOption, timesta
 declare function batchClearRemoteHistoryMessages(clearMessageOption: IClearMessageOption[], isDeleteLocal?: boolean): Promise<IAsyncRes<void>>;
 /**
  * 更新（添加、替换）消息扩展属性
+ * @description 消息扩展功能可为消息增加基于 Key/Value 的状态标识。消息的扩展信息可在发送前、后设置或更新，可用于实现消息评论、礼物领取、订单状态变化等业务需求。
+ * * **注意**：
+ * 1. 单条消息单次最多可设置 20 个扩展信息 KV 对，总计不可超过 300 个扩展信息 KV 对。
+ * 2. 消息扩展（Key、Value 扩展信息）会被存储。如已开通历史消息云存储功能，从服务端获取的历史消息也会携带已设置的扩展信息。
+ * 3. 仅支持单聊、群聊会话类型，不支持聊天室类型。
+ * 4. 仅当发送消息时指定 canIncludeExpansion 值为 true，才可对消息进行拓展。
  * @category 消息
  * @param expansion 要更新的消息扩展信息键值对
  * @param message 要更新的原始消息体
+ *
+ * @example
+ * 更新（添加、替换）消息扩展属性示例：
+ * ```ts
+ * const expansion = { key1: 'value1' };
+ * // message 为 IAReceivedMessage 类型消息体，此处不做具体示例，可在消息监听或者获取历史消息接口获取需要操作的 message
+ * const updateRes = await RongIMLib.updateMessageExpansion(expansion, message);
+ * console.info('更新消息扩展属性结果：', updateRes);
+ * ```
 */
 declare function updateMessageExpansion(expansion: {
     [key: string]: any;
 }, message: IAReceivedMessage): Promise<IAsyncRes<void>>;
 /**
  * 删除扩展存储
+ * @description 删除消息扩展信息中指定的 Key
  * @category 消息
  * @params keys 需删除消息扩展的 keys
  * @params message 原始消息体
+ * @example
+ * 删除扩展存储示例：
+ * ```ts
+ * const keys = ['key1'];
+ * // message 为 IAReceivedMessage 类型消息体，此处不做具体示例，可在消息监听或者获取历史消息接口获取需要操作的 message
+ * const removeRes = await RongIMLib.removeMessageExpansionForKey(keys, message);
+ * console.info('删除扩展存储结果：', removeRes);
+ * ```
 */
 declare function removeMessageExpansionForKey(keys: string[], message: IAReceivedMessage): Promise<IAsyncRes<void>>;
 /**
- * 发送typing消息
+ * 发送输入状态消息
+ * @description 发送输入状态消息，用于展示对方正在输入的状态
  * @category 消息
+ * @param conversation 会话信息
  * @param typingContentType 输入状态消息类型
- * @returns
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedMessage} 类型
+ *
+ * @example
+ * 发送输入状态消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const typingContentType = RongIMLib.MessageType.TEXT;
+ * const typingRes = await RongIMLib.sendTypingStatusMessage(conversation, typingContentType);
+ * console.info('发送typing消息结果：', typingRes);
+ * ```
  */
 declare function sendTypingStatusMessage(conversation: IConversationOption, typingContentType: string): Promise<IAsyncRes<IAReceivedMessage>>;
 /**
  * 获取群已读列表
  * @category 消息
+ * @param targetId 群 ID
  * @param messageUId 消息UID
- * @returns
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IMessageReaderResponse} 类型
+ * @example
+ * ```ts
+ * const messageUId = 'messageUId';
+ * const targetId = 'targetId';
+ * const getReaderRes = await RongIMLib.getMessageReader(targetId, messageUId);
+ * console.info('获取群已读列表结果：', getReaderRes);
+ * ```
  */
-declare function getMessageReader(targetId: string, messageUId: string, channelId: string): Promise<IAsyncRes<IMessageReaderResponse>>;
+declare function getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<IMessageReaderResponse>>;
 /**
  * 注册自定义消息
+ * @description 注册自定义消息，用于定义自定义消息的类型，会影响消息的发送和接收
+ * * **注意**：
+ * 1. 注册自定义消息代码必须在发送、接收该自定义消息之前
+ * 2. 推荐将所有注册自定义消息代码放在 init 方法之后, connect 方法之前
+ * 3. 注册的消息类型名, 必须多端一致, 否则消息无法互通
+ * 4. 请勿使用 RC: 开头的类型名，以免和 SDK 默认的消息名称冲突，自定义消息的消息类型名如和 SDK 默认的消息类型名相同以 SDK 默认的消息定义名为准
+ * 5. 需要再 connect 之前调用防止手消息行为异常
  * @category 消息
  * @param messageType 消息类型
  * @param isPersited  是否存储
  * @param isCounted   是否计数
- * @param searchProps  可搜索的属性
- * @param isStatusMessage  是否状态消息，状态消息不计数，不存储，仅在线能收到
+ * @param searchProps  可搜索的属性，web 端无需设置，搜索字段值设置为数字时取值范围为 (-Math.pow(2, 64), Math.pow(2, 64)) 且为整数
+ * @param isStatusMessage  是否状态消息，状态消息不计数，不存储，接收方在线时才能收到
+ * @returns 返回一个 {@link BaseMessage} 类型的构造函数
+ * @example
+ * ```ts
+ * const messageType = 'CustomMessage';
+ * const isPersited = true;
+ * const isCounted = true;
+ * const searchProps = ['content']; // 搜索字段
+ * const isStatusMsg = false;
+ * const CustomMessage = RongIMLib.registerMessageType(messageType, isPersited, isCounted, searchProps, isStatusMsg);
+ * ```
 */
 declare function registerMessageType<T>(messageType: string, isPersited: boolean, isCounted: boolean, searchProps?: string[], isStatusMessage?: boolean): new (content: T) => BaseMessage<T>;
 /**
  * 获取第一条未读消息
+ * @description 获取指定会话中的第一条未读消息，仅支持 Electron 平台
  * @category 消息
  * @param conversation
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedMessage} 类型
+ *
+ * @example
+ * 获取第一条未读消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const firstUnreadRes = await RongIMLib.getFirstUnreadMessage(conversation);
+ * console.info('获取第一条未读消息结果：', firstUnreadRes);
+ * ```
  */
 declare function getFirstUnreadMessage(conversation: IConversationOption): Promise<IAsyncRes<IAReceivedMessage | null>>;
 /**
  * 获取第一条未读消息信息
  * @category 消息
  * @since 5.9.0
- * @param conversation
- * 当没有未读消息时，返回的 data 为 null
- * 当第一条未读消息被撤回时，此信息不会更新
+ * @param conversation 会话信息
+ * @description 获取指定会话中的第一条未读消息信息
+ * * **注意**：
+ * 1. 当没有未读消息时，返回的 data 为 null
+ * 2. 当第一条未读消息被撤回时，此信息不会更新
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IFirstUnreadMessageInfo} 类型
+ * @example
+ * 获取第一条未读消息信息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const firstUnreadMessageInfoRes = await RongIMLib.getFirstUnreadMessageInfo(conversation);
+ * console.info('获取第一条未读消息信息结果：', firstUnreadMessageInfoRes);
+ * ```
  */
 declare function getFirstUnreadMessageInfo(conversation: IConversationOption): Promise<IAsyncRes<IFirstUnreadMessageInfo | null>>;
 /**
-   * 向本地插入一条消息，不发送到服务器
+ * 向本地插入一条消息，不发送到服务器
  * @category 消息
-   * @param conversationType 会话类型
-   * @param targetId 目标 ID
-   * @param content 消息体
-   * @param callback
-   * @deprecated
-  */
+ * @deprecated  请使用 {@link RongIMLib.ElectronExtension.insertMessage} 代替
+ */
 declare function insertMessage$1(conversation: IConversationOption, content: IReceivedMessage, options?: IInsertOptions): Promise<IAsyncRes<IAReceivedMessage>>;
 /**
  * 获取消息
+ * @description 获取本地消息, 通过本地消息 ID 或 messageUId 获取消息, 仅支持 Electron 平台
  * @category 消息
  * @param messageId 本地消息 ID 或 messageUId
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedMessage} 类型
+ * @example
+ * 获取消息示例：
+ * ```ts
+ * const messageUId = 'BS4O-P5AO-D1O6-9GPP';
+ * const getMessageRes = await RongIMLib.getMessage(messageUId);
+ * console.info('获取消息结果：', getMessageRes);
+ * ```
 */
 declare function getMessage(messageId: number | string): Promise<IAsyncRes<IAReceivedMessage>>;
 /**
  * 获取会话下所有未读的 @ 消息
  * @category 消息
- * @param conversationType 会话类型
- * @param targetId 目标 ID
+ * @param conversation 会话信息
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedMessage[]} 类型
+ * @example
+ * 获取会话下所有未读的 @ 消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }
+ * const getUnreadMentionedRes = await RongIMLib.getUnreadMentionedMessages(conversation);
+ * console.info('获取会话下所有未读的 @ 消息结果：', getUnreadMentionedRes);
+ * ```
  */
 declare function getUnreadMentionedMessages(conversation: IConversationOption): IAsyncRes<IAReceivedMessage[]>;
 /**
  * 按关键字搜索会话内的消息
  * @category 消息
- * @deprecated 已废弃，推荐使用 electronExtension.searchMessages 方法
- * @param conversation 会话
- * @param keyword 搜索内容
- * @param timestamp 搜索时间, 搜索该时间之前的消息
- * @param count 获取的数量
- * @deprecated
+ * @deprecated 已废弃，@since  5.4.0。请替换使用 {@link electronExtension.searchMessages} 方法
 */
 declare function searchMessages$1(conversation: IConversationOption, keyword: string, timestamp: number, count: number): Promise<IAsyncRes<{
     messages: IAReceivedMessage[];
@@ -2233,99 +3540,200 @@ declare function searchMessages$1(conversation: IConversationOption, keyword: st
 /**
  * 从本地消息数据库中删除某一会话指定时间之前的消息数据
  * @category 消息
- * @param conversation 会话
- * @param timestamp 指定删除该时间戳之前的消息
- * @param cleanSpace 指定删除该时间戳之前的消息。是否清理数据条目所使用的磁盘空间。清理磁盘空间会阻塞进程且耗时较长，不推荐使用。
- * 数据在被抹除的情况下，未清理的磁盘空间会在后续存储操作中复用，且对数据查询无影响
- * @deprecated
+ * @deprecated 已废弃，@since  5.4.0。请替换使用 {@link electronExtension.deleteMessagesByTimestamp} 方法
 */
 declare function deleteLocalMessagesByTimestamp(conversation: IConversationOption, timestamp: number, cleanSpace: boolean): Promise<IAsyncRes<void>>;
 /**
  * 清空会话下历史消息
  * @category 消息
- * @param conversation 会话
- * @deprecated
+ * @deprecated 已废弃，@since  5.4.0。请替换使用 {@link electronExtension.clearMessages} 方法
 */
 declare function clearMessages$1(conversation: IConversationOption): Promise<IAsyncRes<void>>;
 /**
  * 按内容搜索会话
  * @category 消息
- * @param keyword 关键字
- * @param conversationTypes 会话类型数组
- * @deprecated
+ * @deprecated 已废弃，@since  5.4.0。请替换使用 {@link electronExtension.searchConversationByContent} 方法
 */
 declare function searchConversationByContent$1(keyword: string, conversationTypes?: ConversationType[], messageTypes?: string[], channelId?: string): Promise<IAsyncRes<IReceivedConversation[] | undefined>>;
 /**
  * 清除时间戳前的未读数
+ * @description 清除时间戳前的未读数，仅支持 Electron 平台。
  * @category 消息
- * @param conversationType 会话类型
- * @param targetId 目标 ID
- * @param timestamp 目标 ID
- * @param callback
+ * @param conversation 会话信息
+ * @param timestamp 清理未读时间戳
+ *
+ * @example
+ * 清除时间戳前的未读数示例：
+ * ```ts
+ * const conversation = {
+ * conversationType: RongIMLib.ConversationType.PRIVATE,
+ * targetId: 'targetId',
+ * }
+ * const timestamp = 1626955200000;
+ * const clearRes = await RongIMLib.clearUnreadCountByTimestamp(conversation, timestamp);
+ * console.info('清除时间戳前的未读数结果：', clearRes);
+ * ```
 */
 declare function clearUnreadCountByTimestamp(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes<void>>;
 /**
  * 设置消息接收状态
  * @category 消息
- * @deprecated
+ * @deprecated 已废弃，@since  5.4.0。请替换使用 {@link electronExtension.setMessageReceivedStatusInfo} 方法
  */
 declare function setMessageReceivedStatus$1(messageId: number, receivedStatus: number): Promise<IAsyncRes<void>>;
 
 /**
  * 创建标签
+ * @description 创建标签系统，用于对会话进行管理。SDK 创建的标签会被同步到服务端
+ * SDK 支持使用一个或多个标签标记会话，可用于会话的分组显示、获取会话列表等操作，并提供了多个接口用于移除会话上的标签
+ * * **注意**：每个用户最多可以创建 20 个标签
  * @category 标签
- * @param tag 标签信息
+ * @param tag 标签信息，包含标签 ID 和标签名称，类型为 {@link ITagParam}
+ * @returns 创建成功返回 code 为 0，失败返回错误码
+ * @example 创建标签示例：
+ * ```ts
+ * const tag = {
+ *  tagId: 'tagId',
+ *  tagName: 'tagName',
+ * };
+ * const res = await RongIMLib.addTag(tag);
+ * console.log('创建标签结果：', res);
+ * ```
  */
 declare function addTag(tag: ITagParam): Promise<IAsyncRes<void>>;
 /**
  * 删除标签
  * @category 标签
  * @param tagId 标签 ID
+ * @returns 删除成功返回 code 为 0，失败返回错误码
+ * @example 删除标签示例：
+ * ```ts
+ * const tagId = 'tagId';
+ * const res = await RongIMLib.removeTag(tagId);
+ * console.log('删除标签结果：', res);
+ * ```
  */
 declare function removeTag(tagId: string): Promise<IAsyncRes<void>>;
 /**
  * 编辑标签
+ * @description 编辑标签名称，标签名称最大长度为 15 个字符, 标签 ID，长度不能超过 10 个字符
  * @category 标签
- * @param tag 标签信息
+ * @param tag 标签信息, 包含标签 ID 和标签名称，类型为 {@link ITagParam}
+ * @returns 编辑成功返回 code 为 0，失败返回错误码
+ * @example 编辑标签示例：
+ * ```ts
+ * const tag = {
+ *  tagId: 'tagId',
+ *  tagName: 'tagName',
+ * };
+ * const res = await RongIMLib.updateTag(tag);
+ * console.log('编辑标签结果：', res);
+ * ```
 */
 declare function updateTag(tag: ITagParam): Promise<IAsyncRes<void>>;
 /**
  * 获取标签列表
  * @category 标签
+ * @description 获取当前用户的标签列表
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为标签列表，类型为 {@link ITagInfo} 数组或者 undefined
+ * @example 获取标签列表示例：
+ * ```ts
+ * const res = await RongIMLib.getTags();
+ * console.log('获取标签列表结果：', res);
+ * ```
  */
 declare function getTags(): Promise<IAsyncRes<ITagInfo[] | undefined>>;
 /**
 * 获取会话下的标签
- * @category 标签
-* @param conversation 会话信息
+* @description 更具会话信息获取具体某个会话下的标签列表
+* @category 标签
+* @param conversation 会话信息，包含会话类型、会话 ID 和 channelId，类型为 {@link IConversationOption}
+* @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为标签列表，类型为 {@link IConversationTag} 数组或者 undefined
+* @example 获取会话下的标签示例：
+* ```ts
+* const conversation = {
+*  conversationType: RongIMLib.ConversationType.PRIVATE,
+*  targetId: 'targetId',
+* };
+* const res = await RongIMLib.getTagsFromConversation(conversation);
+* console.log('获取会话下的标签结果：', res);
+* ```
 */
 declare function getTagsFromConversation(conversation: IConversationOption): Promise<IAsyncRes<IConversationTag[] | undefined>>;
 /**
  * 添加会话到指定标签
+ * @description 添加会话到指定标签，一个会话可以添加到多个标签
+ * * **注意**：
+ * 1. 每个标签下最多可以添加 1000 个会话
+ * 2. 如果标签下已添加 1000 个会话，继续在该标签下添加会话仍会成功，但会导致最早添加标签的会话被移除标签
+ * 3. 同一个会话可以设置多个不同的标签
  * @category 标签
  * @param tagId 标签 ID
- * @param conversations 要添加的会话列表
+ * @param conversations 会话信息，包含会话类型、会话 ID 和 channelId，类型为 {@link IConversationOption} 数组
+ * @example 添加会话到指定标签示例：
+ * ```ts
+ * const tagId = 'tagId';
+ * const conversations = [{
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }];
+ * const res = await RongIMLib.addConversationsToTag(tagId, conversations);
+ * console.log('添加会话到指定标签结果：', res);
+ * ```
  */
 declare function addConversationsToTag(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<void>>;
 /**
- * 删除指定标签中会话
+ * 从指定标签中删除多个会话
+ * @description 从指定标签中删除多个会话，此操作仅解除会话与标签的关系，并不会删除会话数据
  * @category 标签
  * @param tagId 标签 ID
- * @param conversations 要删除的会话列表
+ * @param conversations 会话信息，包含会话类型、会话 ID 和 channelId，类型为 {@link IConversationOption} 数组
+ * @example 从指定标签中删除多个会话示例：
+ * ```ts
+ * const tagId = 'tagId';
+ * const conversations = [{
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }];
+ * const res = await RongIMLib.removeConversationsFromTag(tagId, conversations);
+ * console.log('从指定标签中删除多个会话果：', res);
+ * ```
  */
 declare function removeConversationsFromTag(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<void>>;
 /**
  * 从指定会话中删除多个标签
+ * @description 从指定会话中删除多个标签，此操作仅解除会话与标签的关系，并不会删除会话数据
  * @category 标签
- * @param conversation 会话
+ * @param conversation 会话信息，包含会话类型、会话 ID 和 channelId，类型为 {@link IConversationOption}
  * @param tagIds 要删除的标签列表
+ * @example 从指定会话中删除多个标签示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * };
+ * const tagIds = ['tagId1', 'tagId2'];
+ * const res = await RongIMLib.removeTagsFromConversation(conversation, tagIds);
+ * console.log('从指定会话中删除多个标签结果：', res);
+ * ```
  */
 declare function removeTagsFromConversation(conversation: IConversationOption, tagIds: string[]): Promise<IAsyncRes<void>>;
 /**
  * 从多个会话中删除指定的标签
+ * @description 从多个会话中删除指定的标签，此操作仅解除会话与标签的关系，并不会删除会话数据
  * @category 标签
  * @param tagId 标签 ID
- * @param conversations 要删除的会话列表
+ * @param conversations 会话信息列表
+ * @example 从多个会话中删除指定的标签示例：
+ * ```ts
+ * const tagId = 'tagId';
+ * const conversations = [{
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * }];
+ * const res = await RongIMLib.removeTagFromConversations(tagId, conversations);
+ * console.log('从多个会话中删除指定的标签：', res);
+ * ```
  */
 declare function removeTagFromConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<void>>;
 /**
@@ -2333,7 +3741,17 @@ declare function removeTagFromConversations(tagId: string, conversations: IConve
  * @category 标签
  * @param tagId 标签id
  * @param count 获取数量
- * @param timestamp 会话时间戳
+ * @param timestamp 会话中消息的时间戳
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为会话列表，类型为 {@link IAReceivedConversationByTag} 数组或者 undefined
+ * 从 SDK 版本 @since 5.7.0 开始该接口的返回数据类型由 {@link IReceivedConversationByTag} 变更为 {@link IAReceivedConversationByTag}
+ * @example 分页获取标签下会话列表示例：
+ * ```ts
+ * const tagId = 'tagId';
+ * const count = 10;
+ * const timestamp = 0;
+ * const res = await RongIMLib.getConversationsFromTagByPage(tagId, count, timestamp);
+ * console.log('分页获取标签下会话列表结果：', res);
+ * ```
  */
 declare function getConversationsFromTagByPage(tagId: string, count: number, startTime: number): Promise<IAsyncRes<IAReceivedConversationByTag[] | undefined>>;
 /**
@@ -2341,29 +3759,54 @@ declare function getConversationsFromTagByPage(tagId: string, count: number, sta
  * @category 标签
  * @param tagId 标签id
  * @param containMuted 是否包含免打扰
+ * @example 根据标签获取未读消息数示例：
+ * ```ts
+ * const tagId = 'tagId';
+ * const containMuted = false;
+ * const res = await RongIMLib.getUnreadCountByTag(tagId, containMuted);
+ * console.log('根据标签获取未读消息数结果：', res);
+ * ```
  */
 declare function getUnreadCountByTag(tagId: string, containMuted: boolean): Promise<IAsyncRes<number | undefined>>;
 /**
  * 设置标签中会话置顶
+ * @description 设置在指定标签下置顶的会话。如果根据标签获取会话，可在获取的会话中可以看到该属性。请注意与会话列表中的会话置顶相区分
  * @category 标签
  * @param tagId 标签id
  * @param conversation 会话
  * @param status 状态
+ * @example 设置标签中会话置顶示例：
+ * ```ts
+ * const tagId = 'tagId';
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * };
+ * const isTop = true;
+ * const res = await RongIMLib.setConversationToTopInTag(tagId, conversation, isTop);
+ * console.log('设置标签中会话置顶结果：', res);
+ * ```
  */
 declare function setConversationToTopInTag(tagId: string, conversation: IConversationOption, isTop: boolean): Promise<IAsyncRes<void>>;
 
 /**
  * 创建文件上传任务
  * @param uploadInfo
+ * @hidden
  * @returns
  */
 declare function createUploadTask(uploadInfo: IUploadInfo): Promise<IAsyncRes<UploadTask>>;
 /**
  * 停止文件上传任务
+ * @hidden
  * @param taskId
  * @returns
  */
 declare function stopUploadTask(taskId: number): Promise<IAsyncRes<boolean>>;
+/**
+ * 上传文件
+ * @hidden
+ */
 declare function upload(uploadInfo: IUploadInfo): Promise<IAsyncRes<IUploadResult>>;
 /**
  * 获取文件 token
@@ -2388,6 +3831,7 @@ declare function getFileToken(fileType: FileType, fileName?: string, httpMethod?
  * 获取下载鉴权信息
  * @param url 文件 URL 地址
  * @description 通过文件 URL 地址获取下载鉴权信息，用于下载文件时的鉴权
+ * @hidden
  * token: 原 RCX 存储鉴权 token，优先使用
  * downloadAuthInfo: RCX 升级后，公有云私有化部署的下载鉴权信息
  */
@@ -2415,11 +3859,16 @@ declare function getFileUrl(fileType: FileType, filename?: string, saveName?: st
 
 /**
  * @deprecated 从 5.6.0 版本开始，此定义失效
+ * @category 基础
  */
 declare const ConnectType: {
     COMET: string;
     WEBSOCKET: string;
 };
+/**
+ * 消息类型
+ * @category 消息
+ */
 declare const MessageType: {
     TEXT: string;
     VOICE: string;
@@ -2440,50 +3889,142 @@ declare const MessageType: {
 };
 
 /**
- * 获取全部会话列表
+ * 获取全部本地会话列表
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台获取全部本地会话列表
+ * * **注意**：此接口不包含超级群会话
  * @param channelId 频道 ID，不传则获取全部频道 ID 类型
+ * @since 5.4.0
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 {@link IAReceivedConversation} 类型数组
+ * @example
+ * 获取全部本地会话列表示例：
+ * ```ts
+ * const conversationList = await RongIMLib.electronExtension.getAllConversationList();
+ * console.log('获取全部本地会话列表结果：', conversationList);
+ * ```
  */
 declare function getAllConversationList(channelId?: string): Promise<IAsyncRes<IAReceivedConversation[]>>;
 /**
- * 获取会话列表
- * @param startTime 起始时间
- * @param count 数量
+ * 分页获取本地会话列表
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台分页获取本地会话列表,
+ * * **注意**：不包含超级群会话
+ * @param startTime 获取会话起始时间，需要精确到毫秒，0 表示当前时间
+ * @param count 分页数量
  * @param channelId 频道 ID，不传则获取全部频道 ID 类型
+ * @param topPriority 是否置顶优先
+ * @defaultValue topPriority false
+ * @since 5.4.0
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 {@link IAReceivedConversation} 类型数组
+ * @example
+ * 分页获取本地会话列表示例：
+ * ```ts
+ * const startTime = 0;
+ * const count = 10;
+ * const conversationList = await RongIMLib.electronExtension.getConversationList(startTime, count);
+ * console.log('分页获取本地会话列表结果：', conversationList);
+ * ```
  */
 declare function getConversationList(startTime: number, count: number, channelId?: string, topPriority?: boolean): Promise<IAsyncRes<IAReceivedConversation[]>>;
 /**
- * 根据消息内容搜索会话列表
+ * 搜索本地会话列表
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台搜索本地会话列表
+ * * **注意**：
+ * 1. 不包含超级群会话
+ * 2. 支持查询自定义消息类型，需要再注册自定义消息时设置搜索字段，否则无法搜索 ，详细请查看 {@link registerMessageType} 的 searchProps 参数
  * @param keyword 搜索关键字
  * @param messageTypes 消息类型
  * @param channelId 频道 ID，不传则获取全部频道 ID 类型
+ * @since 5.4.0
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 {@link IAReceivedConversation} 类型数组
+ * @example
+ * 搜索本地会话列表示例：
+ * ```ts
+ * const keyword = 'keyword';
+ * const messageTypes = [RongIMLib.MessageType.TEXT];
+ * const conversationList = await RongIMLib.electronExtension.searchConversationByContent(keyword, messageTypes);
+ * console.log('搜索本地会话列表结果：', conversationList);
+ * ```
  */
 declare function searchConversationByContent(keyword: string, messageTypes: string[], channelId?: string): Promise<IAsyncRes<IAReceivedConversation[]>>;
 /**
  * 批量获取会话列表
- * 仅支持单群聊系统会话
- * @param conversations 需要获取会话的信息
- * 一次最多获取 100 个会话
- * @returns IReceivedConversation[]
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台批量获取会话列表，通过提供会话的唯一标标识属性返回 {@link IReceivedConversation} 类型的会话信息
+ * * **注意**：
+ * 1. 仅支持单群聊系统会话
+ * @since 5.9.9
+ * @param conversations 需要获取会话的信息，一次最多获取 100 个会话
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 {@link IAReceivedConversation} 类型数组
+ * @example
+ * 批量获取会话列表示例：
+ * ```ts
+ * const conversations = [{ conversationType: RongIMLib.ConversationType.PRIVATE, targetId: 'targetId' }];
+ * const conversationList = await RongIMLib.electronExtension.getConversations(conversations);
+ * console.log('批量获取会话列表结果：', conversationList);
+ * ```
  */
 declare function getConversations(conversations: IConversationOption[]): Promise<IAsyncRes<IAReceivedConversation[]>>;
 
 /**
- * 搜索消息
- * 如果不传 channelId，则在所有 channelId 中搜索消息
- * @param conversation 会话
+ * 根据关键字搜索本地消息
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台搜索本地消息
+ * * **注意**：
+ * 1. 文本类型消息只支持搜索 content，文件类型消息只支持搜索 name
+ * 2. 自定义消息根据 registerMessageType 的 searchProps 参数决定
+ * 3. 引用消息不支持搜索
+ * 4. 如果不传 channelId，则在所有 channelId 中搜索消息
+ * 5. 如果不传 messageTypes，则搜索所有支持搜索的消息类型
+ * @since 5.4.0
+ * @param conversation 会话信息
  * @param keyword 搜索关键字
- * @param startTime 搜索起始时间
- * @param count 数量
- * @param messageTypes 消息类型， 只支持文本（RC:TxtMsg）、文件（RC:FileMsg）、引用消息（RC:ReferenceMsg）、自定义消息
+ * @param startTime 搜索时间, 搜索该时间之前的消息
+ * @param count 获取的数量
+ * @param messageTypes 消息类型，@since 5.9.8 开始支持按照消息类型搜索，支持范围：文本（RC:TxtMsg）、文件（RC:FileMsg）、设置 {@link searchProps} 的自定义消息
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 中包含 {@link IAReceivedMessage} 类型数组
+ * @example
+ * 根据关键字搜索本地消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * };
+ * const keyword = 'keyword';
+ * const startTime = Date.now();
+ * const count = 10;
+ * const res = await RongIMLib.electronExtension.searchMessages(conversation, keyword, startTime, count);
+ * console.info('根据关键字搜索本地消息结果：', res);
+ * ```
  */
 declare function searchMessages(conversation: IConversationOption, keyword: string, startTime: number, count: number, messageTypes?: string[]): Promise<IAsyncRes<{
     messages: IAReceivedMessage[];
     count: number | undefined;
 }>>;
 /**
- * 在时间范围内搜索消息
- * @param conversation 会话
- * @param option 配置
+ * 在指定时间范围内搜索本地消息
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台搜索本地消息
+ * @since 5.4.0
+ * @param conversation 会话信息
+ * @param option 搜索参数，类型为 {@link ISearchMessageInTimeRangeOption}
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 中包含 {@link IAReceivedMessage} 类型数组
+ * @example
+ * 在指定时间范围内搜索本地消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId'
+ * }
+ * const option = {
+ *  keyword: 'keyword',
+ *  startTime: 0,
+ *  endTime: 1632728573423,
+ * }
+ * const res = await RongIMLib.electronExtension.searchMessageInTimeRange(conversation, option)
+ * console.info('在指定时间范围内搜索本地消息结果：', res);
+ * ```
  */
 declare function searchMessageInTimeRange(conversation: {
     conversationType: ConversationType;
@@ -2492,17 +4033,51 @@ declare function searchMessageInTimeRange(conversation: {
     messages: IAReceivedMessage[];
 }>>;
 /**
- * 根据用户 ID 搜索消息
- * @param conversation 会话
+ * 根据用户 ID 搜索本地消息
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台在指定会话的所有频道中根据用户 ID 搜索时间范围内的消息
+ * @param conversation 会话信息
+ * @param count 获取的数量
+ * @param startTime 搜索时间，搜索时间之前的消息
+ * @param userId 用户 ID
  * @since 5.7.10
+ * @return 返回一个 {@link IAsyncRes} 类型 Promise，data 中包含 {@link IAReceivedMessage} 类型数组
+ * @example
+ * 根据用户 ID 搜索本地消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId'
+ * };
+ * const userId = 'userId';
+ * const startTime = Date.now();
+ * const count = 10;
+ * const res = await RongIMLib.electronExtension.searchMessagesByUser(conversation, userId, startTime, count);
+ * console.info('根据用户 ID 搜索本地消息', res);
+ * ```
  */
 declare function searchMessagesByUser(conversation: IConversationOption, userId: string, startTime: number, count: number): Promise<IAsyncRes<{
     messages: IAReceivedMessage[];
 }>>;
 /**
- * 获取指定消息类型的历史消息
- * @param conversation 会话
- * @param option 配置参数
+ * 获取会话中指定类型的消息
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台获取会话中指定类型的消息
+ * @param conversation 会话信息
+ * @param option 配置参数，类型为 {@link IGetHistoryMessagesByTypesOption}
+ * @since 5.4.0
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 中包含 {@link IAReceivedMessage} 类型数组
+ * @example
+ * 获取会话中指定类型的消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId'
+ * };
+ * const options = { messageTypes: [RongIMLib.MessageType.TEXT] };
+ * const res = await RongIMLib.electronExtension.getHistoryMessagesByMessageTypes(conversation, option);
+ * console.info('获取会话中指定类型的消息结果：', res);
+ * ```
  */
 declare function getHistoryMessagesByMessageTypes(conversation: IConversationOption, option: IGetHistoryMessagesByTypesOption): Promise<IAsyncRes<{
     /**
@@ -2511,16 +4086,33 @@ declare function getHistoryMessagesByMessageTypes(conversation: IConversationOpt
     messages: IAReceivedMessage[];
 } & GetHistoryMessageResult>>;
 /**
- * 获取本地与远端历史消息(该接口已解决消息断档)
+ * 获取本地与远端历史消息
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台且需要业务层开启`单群聊云存储服务`
+ * 方法与 {@link getRemoteHistoryMessages} 的区别是 getContinuousMessages 会先查询指定会话存储本地数据库的消息，
+ * 当本地消息无法满足查询条件时，再查询在单群聊消息云端存储中的历史消息，以返回连续且相邻的消息对象列表
+ * * **注意**：
  * 1. 分页获取时，下次传的时间戳必须使用 getContinuousMessages 接口返回的 timestamp
  * 2. 获取历史消息逻辑：优先获取本地数据历史消息，本地获取不到再获取远端历史消息，但是该情况可能会因为离线或者补偿消息存储天数影响，出现消息断档现象
  * 消息断档现象：因为离线或者补偿消息存储天数影响，存储在本地数据库中消息存在不连续或者说中间某段时间消息丢失
  * 比如离线消息和补偿消息都为 1 天，第一天 A 给 B 发送 1, 2, 3，第二天 A 给 B 发送 4, 5, 6,
  * B 第二天再登入，由于离线消息和补偿消息都为 1 天，所以 B 只能收到 4, 5, 6。 1, 2, 3 消息丢失
- * @param conversation
- * @param option
+ * 3. option 中的 Count 字段仅支持 1-100 范围
+ * @param conversation 会话信息
+ * @param option 参数配置，类型为 {@link GetHistoryMessageOption}
  * @since 5.9.6
- * @description 该接口需要业务层开启单群聊云存储服务
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 中包含 {@link IAReceivedMessage} 类型数组
+ * @example
+ * 获取本地与远端历史消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId'
+ * };
+ * const options = { timestamp: 0, count: 20, order: 0 };
+ * const res = await RongIMLib.electronExtension.getContinuousMessages(conversation, option);
+ * console.info('获取本地与远端历史消息结果：', res);
+ * ```
  */
 declare function getContinuousMessages(conversation: IConversationOption, options: GetHistoryMessageOption): Promise<IAsyncRes<{
     list: IAReceivedMessage[];
@@ -2528,57 +4120,160 @@ declare function getContinuousMessages(conversation: IConversationOption, option
     hasMore: boolean;
 }>>;
 /**
- * 将自己发送的指定时间之前的消息标记对方已读，状态值为 SentStatus.READ
- * @param conversation 会话
- * @param timestamp 时间戳
+ * 通过时间戳设置消息状态为对方已读
+ * @category Electron 独有
+ * @description 将自己发送的指定时间之前的消息设置为对方已读，状态值为 SentStatus.READ
+ * @param conversation 会话信息
+ * @param timestamp 消息的发送时间，将该时间之前的消息设置为已读
+ * @since 5.4.0
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 boolean 类型的操作结果
+ * @example
+ * 通过时间戳设置消息状态为对方已读示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId'
+ * };
+ * const timestamp = Date.now();
+ * const res = await RongIMLib.electronExtension.setMessageStatusToRead(conversation, timestamp);
+ * console.info('通过时间戳设置消息状态为对方已读结果：', res);
+ * ```
  */
 declare function setMessageStatusToRead(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes<boolean>>;
 /**
- * 设置对方发送的消息 自己的接受状态
+ * 设置消息的接收状态
  * @param messageId 消息 ID
  * @param receivedStatus 接受状态
- * @deprecated 建议使用 setMessageReceivedStatusInfo, 支持设置多种状态
+ * @since 5.4.0
+ * @deprecated @since 5.9.3 MLib SDK 版本 ≧ 5.9.3，建议使用 {@link setMessageReceivedStatusInfo} 接口替换
  */
 declare function setMessageReceivedStatus(messageId: number, receivedStatus: ReceivedStatus): Promise<IAsyncRes<void>>;
 /**
+ * 设置消息的接收状态
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台设置消息的接收状态，支持多状态同时设置
  * 设置对方发送的消息 自己的接受状态信息
- * @param messageId
- * @param receivedStatusInfo
+ * @param messageId 消息 ID，注意：需要传递的参数为 number 类型的 messageId 而非 string 类型的 messageUId
+ * @param receivedStatusInfo 接受状态信息，类型为 {@link IReceivedStatusInfo}
+ * @since 5.9.3
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 void
+ * @example
+ * 设置消息的接收状态示例：
+ * ```ts
+ * const messageId = 123;
+ * const receivedStatusInfo = {
+ *  isRead: true,
+ *  isListened: true,
+ * };
+ * const res = await RongIMLib.electronExtension.setMessageReceivedStatusInfo(messageId, receivedStatusInfo);
+ * console.info('设置消息的接收状态结果：', res);
+ * ```
  */
 declare function setMessageReceivedStatusInfo(messageId: number, receivedStatusInfo: IReceivedStatusInfo): Promise<IAsyncRes<void>>;
 /**
- * 设置自己发送的消息的发送状态
- * @param messageId 消息ID
- * @param sentStatus 发送状态
+ * 设置消息的发送状态
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台设置自己发送的消息的发送状态
+ * @param messageId 消息ID，注意：需要传递的参数为 number 类型的 messageId 而非 string 类型的 messageUId
+ * @param sentStatus 消息的发送状态，类型为 {@link SentStatus}
+ * @since 5.4.0
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 void
+ * @example
+ * 设置消息的发送状态示例：
+ * ```ts
+ * const messageId = 123;
+ * const sentStatus = RongIMLib.SentStatus.SENT;
+ * const res = await RongIMLib.electronExtension.setMessageSentStatus(messageId, sentStatus);
+ * console.info('设置消息的发送状态结果：', res);
+ * ```
  */
 declare function setMessageSentStatus(messageId: number, sentStatus: SentStatus): Promise<IAsyncRes<void>>;
 /**
  * 修改消息内容
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台修改消息内容，目前仅私有云使用 RCE api 暂不对外
+ * @hidden
  * @param messageId 消息 ID
  * @param content 消息 content
  * @param messageType 消息类型，如果设置了消息类型，会使该消息无法被搜索
+ * @since 5.4.0
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 void
+ * @example
+ * 修改消息内容示例：
+ * ```ts
+ * const messageId = 123;
+ * const content = {
+ * content: 'new content',
+ * };
+ * const messageType = 'RC:TxtMsg';
+ * const res = await RongIMLib.electronExtension.setMessageContent(messageId, content, messageType);
+ * console.info('修改消息内容结果：', res);
+ * ```
  */
 declare function setMessageContent(messageId: number, content: Object, messageType?: string): Promise<IAsyncRes<void>>;
 /**
- * 删除消息
+ * 通过消息 ID 删除消息
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台
+ * 通过消息 ID 从本地消息数据库中删除指定的一条或一组消息数据。删除多条消息时，请确保消息 ID 均属于同一会话
  * @param messageIds 消息 ID 列表, 需是同一会话的消息
+ * @since 5.4.0
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 void
+ * @example
+ * 通过消息 ID 删除消息示例：
+ * ```ts
+ * const messageIds = [1, 2];
+ * const res = await RongIMLib.electronExtension.deleteMessages(messageIds);
+ * console.info('通过消息 ID 删除消息结果：', res);
+ * ```
  */
 declare function deleteMessages(messageIds: number[]): Promise<IAsyncRes<void>>;
 /**
  * 清空会话下历史消息
- * @param conversation 会话
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台，从本地消息数据库中删除指定会话所有消息。
+ * @param conversation 会话信息
+ * @since 5.4.0
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 void
+ * @example
+ * 清空会话下历史消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * };
+ * const res = await RongIMLib.electronExtension.clearMessages(conversation);
+ * console.info('清空会话下历史消息结果：', res);
+ * ```
 */
 declare function clearMessages(conversation: IConversationOption): Promise<IAsyncRes<void>>;
 /**
- * 从本地消息数据库中删除某一会话指定时间之前的消息数据
- * @param conversation 会话
+ * 通过时间戳删除
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台，根据时间戳，从本地消息数据库中删除单个会话中早于该时间戳的消息数据。
+ * @param conversation 会话信息
  * @param timestamp 指定删除该时间戳之前的消息
  * @param cleanSpace 指定删除该时间戳之前的消息。是否清理数据条目所使用的磁盘空间。清理磁盘空间会阻塞进程且耗时较长，不推荐使用。
  * 数据在被抹除的情况下，未清理的磁盘空间会在后续存储操作中复用，且对数据查询无影响
+ * @since 5.4.0
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 void
+ * @example
+ * 通过时间戳删除示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * };
+ * const timestamp = Date.now();
+ * const cleanSpace = false;
+ * const res = await RongIMLib.electronExtension.deleteMessagesByTimestamp(conversation, timestamp, cleanSpace);
+ * console.info('通过时间戳删除结果：', res);
+ * ```
 */
 declare function deleteMessagesByTimestamp(conversation: IConversationOption, timestamp: number, cleanSpace: boolean): Promise<IAsyncRes<void>>;
 /**
  * 批量清除多个会话的本地消息
+ * @category Electron 独有
  * @param options 会话列表，最大数量为 20
  * @since 5.9.0
  * @description 从本地消息数据库中批量删除多个会话指定时间之前的消息数据,
@@ -2586,41 +4281,74 @@ declare function deleteMessagesByTimestamp(conversation: IConversationOption, ti
  * 支持的会话类型：单聊, 群聊,  聊天室, 系统消息
  * @hidden
  * @example
- * ```js
- *   const conversations = [{
- *     conversationType: ConversationType.PRIVATE,
- *     targetId: 'targetId',
- *     timestamp: 0,
- *     channelId: '',
- *    }]
- *   RongIMLib.batchClearMessagesByTimestamp(conversations, 0).then(res => {
- *      if (res.code === ErrorCode.SUCCESS) {
- *       console.log('删除成功')
- *      } else {
- *       console.log('删除失败', res.code)
- *     }
- *   })
+ * ```ts
+ * const conversations = [{
+ *  conversationType: ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ *  timestamp: 0,
+ *  channelId: '',
+ * }]
+ * const res = await RongIMLib.batchClearMessagesByTimestamp(conversations, 0);
+ * console.log('批量清除多个会话的本地消息结果:', res);
  * ```
  */
 declare function batchClearMessagesByTimestamp(options: IClearMessageOption[]): Promise<IAsyncRes<void>>;
 /**
-   * 向本地插入一条消息，不发送到服务器
-   * @param conversation 会话
-   * @param message 消息体
-   * @param options
-   * 注意：插入消息时，messageUid 将不会存入数据库
-  */
+ * 向本地插入一条消息
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台，插入消息到本地数据库，不发送到服务器
+ * * **注意**：插入消息时，messageUId 将不会存入数据库
+ * @since 5.4.0
+ * @param conversation 会话信息
+ * @param message 消息体，@since 5.6.1 增加支持 {@link BaseMessage} 类型
+ * @param options 插入消息配置，类型为 {@link IInsertOptions}
+ * @defaultValues options = {}
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 {@link IAReceivedMessage} 类型的消息对象
+ * @example
+ * 插入消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * };
+ * const message = new RongIMLib.TextMessage({ content: 'hello' });
+ * const options = {
+ *  searchContent: 'hello',
+ * };
+ * const res = await RongIMLib.electronExtension.insertMessage(conversation, message, options);
+ * console.info('插入消息结果：', res);
+ * ```
+ */
 declare function insertMessage(conversation: IConversationOption, message: IAReceivedMessage | BaseMessage, options?: IInsertOptions): Promise<IAsyncRes<IAReceivedMessage>>;
 /**
  * 批量向本地插入消息
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台，批量插入消息到本地数据库，不发送到服务器，目前仅有私有云和 RCE 使用 api 标注 hidden
+ * @hidden
+ * @since 5.7.2
  * @param messages 批量插入的消息体
  * @param checkDuplicate 选择是否排重，默认 false
- * @returns
+ * @defaultValues checkDuplicate = false
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 boolean 类型的操作结果
  */
 declare function batchInsertMessage(messages: IInsertMessage[], checkDuplicate: boolean): Promise<IAsyncRes<boolean>>;
 /**
  * 获取会话所有消息数
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台，获取指定会话下的所有消息数
  * @param conversation
+ * @since 5.7.2
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 消息数
+ * @example
+ * 获取会话所有消息数示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * };
+ * const res = await RongIMLib.electronExtension.getMessageCount(conversation);
+ * console.info('获取会话所有消息数结果：', res);
+ * ```
  */
 declare function getMessageCount(conversation: IConversationOption): Promise<IAsyncRes<number>>;
 /**
@@ -2639,29 +4367,68 @@ declare function getPrivateMessageDeliverTime(messageUId: string): Promise<IAsyn
 declare function getGroupMessageDeliverList(targetId: string, messageUId: string): Promise<IAsyncRes<IGroupMessageDeliverInfo>>;
 /**
  * 设置融云消息重排开关
- *
- * 发送方弱网情况下发送消息，消息到达服务但发送方没有收到服务 ack，导致发送方认为消息发送失败
+ * @category Electron 独有
+ * @description 发送方弱网情况下发送消息，消息到达服务但发送方没有收到服务 ack，导致发送方认为消息发送失败
  * 此种情况下，服务端和接收方都会收到第一条消息
  * 此时发送方重发该消息，再次达到服务，那么此时服务端会有两条消息（消息内容相同，messageUid 不同
- * 接收方会收到两条内容相同 messageUid 不同的消息，SDK 此时会把第二条相同内容消息排重掉
+ * 接收方会收到两条内容相同 messageUId 不同的消息，SDK 此时会把第二条相同内容消息排重掉
  * 以此来保证重发的相同内容消息，发送方只有一条消息，接收方也只有一条消息
  *
  * 当消息量少时，消息排重影响不大；但是本地存在大量消息时，排重会出现性能问题
  * 当本地存在大量消息，且发生收消息卡顿时，建议将排重关闭
  *
  * @param checkDuplicate 是否使用融云消息重排机制 true: 开启, false: 关闭
- * @description
- * @returns data => true: 成功，false: 失败
- *
+ * @since 5.7.1
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 boolean 类型的操作结果
+ * @example
+ * 设置融云消息重排开关示例：
+ * ```ts
+ * const checkDuplicate = true;
+ * const res = await RongIMLib.electronExtension.setCheckDuplicateMessage(checkDuplicate);
+ * console.info('设置融云消息重排开关结果：', res);
+ * ```
  */
 declare function setCheckDuplicateMessage(checkDuplicate?: boolean): Promise<IAsyncRes<boolean>>;
+/**
+ * 设置聊天室消息重排开关
+ * @category Electron 独有
+ * @description 仅支持聊天室消息重排开关，不支持其他会话类型，聊天室消息重排开关默认开启
+ * 目前仅支持对 CUID 进行排重策略修改
+ * @hidden 产品协商暂不对外提供
+ * @since 5.9.9
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 boolean 类型的操作结果
+ * @example
+ * 设置聊天室消息重排开关示例：
+ * ```ts
+ * const checkDuplicate = true;
+ * const res = await RongIMLib.electronExtension.setCheckChatRoomDuplicateMessage(checkDuplicate);
+ * console.info('设置聊天室消息重排开关结果：', res);
+ * ```
+ */
 declare function setCheckChatRoomDuplicateMessage(checkDuplicate?: boolean): Promise<IAsyncRes<boolean>>;
 /**
  * 获取本地指定时间戳前后 N 条消息方法
- * @param conversation
- * @param option
- * @returns
- * 与移动端保持一致 beforeCount,afterCount 仅验证是否大于等于0，上限没做控制
+ * @category Electron 独有
+ * @description 本接口仅适用 Electron 平台，获取本地指定时间戳前后 N 条消息
+ * @param conversation 会话信息
+ * @param option 获取参数
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 {@link IAReceivedMessage[]} 类型的消息列表
+ * @since 5.9.8
+ * @example
+ * 获取本地指定时间戳前后 N 条消息示例：
+ * ```ts
+ * const conversation = {
+ *  conversationType: RongIMLib.ConversationType.PRIVATE,
+ *  targetId: 'targetId',
+ * };
+ * const option = {
+ *  timestamp: 0,
+ *  beforeCount: 10,
+ *  afterCount: 10,
+ * };
+ * const res = await RongIMLib.electronExtension.getMessagesAroundTimestamp(conversation, option);
+ * console.info('获取本地指定时间戳前后 N 条消息结果：', res);
+ * ```
  */
 declare function getMessagesAroundTimestamp(conversation: IConversationOption, option: {
     timestamp: number;
@@ -2670,14 +4437,33 @@ declare function getMessagesAroundTimestamp(conversation: IConversationOption, o
 }): Promise<IAsyncRes<IAReceivedMessage[]>>;
 
 /**
- * 清除本地数据, 包括消息列表、会话列表、拉取消息的时间戳
- * @returns data => true: 成功，false: 失败
+ * 清除本地数据
+ * @category Electron 独有
+ * @description 该方法用于清除本地数据，包括消息列表、会话列表、拉取消息的时间戳
+ * * **注意**：清除后在此登录会作为新设备进行消息拉取切操作无法恢复，谨慎使用
+ * @since 5.4.0
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 为 boolean 类型，表示是否清除成功
+ * @example
+ * 清除本地数据示例：
+ * ```ts
+ * const res = await RongIMLib.electronExtension.clearLocalData();
+ * console.info('清除本地数据结果：', res);
+ * ```
  */
 declare function clearLocalData(): Promise<IAsyncRes<boolean>>;
 /**
   * 获取是否使用 Electron 扩展
- * @since 5.8.3
-  */
+  * @category Electron 独有
+  * @description 该方法用于判断当前是否使用 Electron 扩展
+  * @since 5.8.3
+  * @returns {boolean} 是否使用 Electron 扩展
+  * @example
+  * 获取是否使用 Electron 扩展示例：
+  * ```ts
+  * const res = await RongIMLib.electronExtension.enable();
+  * console.info('获取是否使用 Electron 扩展结果：', res);
+  * ```
+ */
 declare function enable(): boolean;
 
 declare const index_getAllConversationList: typeof getAllConversationList;
@@ -2743,57 +4529,200 @@ declare namespace index {
 
 /**
  * 设置代理
- * @param proxy
- * @returns
+ * @hidden
+ * @since 5.7.0
+ * @param proxy 代理信息
  */
 declare function setProxy(proxy: IProxy | null): IPromiseResult<IProxy>;
 /**
  * 获取代理
- * @param proxy
+ * @hidden
+ * @since 5.7.0
  * @returns
  */
 declare function getProxy(): IPromiseResult<IProxy>;
 /**
  * 测试代理
- * @param proxy
- * @returns
+ * @hidden
+ * @since 5.7.0
+ * @param proxy 代理信息
+ * @param testHost 测试代理地址
  */
 declare function testProxy(proxy: IProxy, testHost: string): IPromiseResult<IResponse>;
 
 /**
  * 订阅用户状态
- * <p>此方法用于订阅一组用户的状态。当这些用户的状态发生变化时，将通过回调接口通知调用者。</p>
+ * @category 订阅用户状态
+ * @description 此方法用于订阅一组用户的状态。当这些用户的状态发生变化时，将通过回调接口通知调用者
+ * **注意**：
+ * 1. 一次订阅用户的上限为 200 个, 订阅的用户数最多为 1000 个，一个用户最多可以被 5000 个用户订阅
+ * 2. 订阅用户在线状态能力需要开通服务，开通路径： IM 服务 > IM 服务管理 > 客户端用户在线状态订阅
  * @param userIds 被订阅用户 ID 列表，一次最多订阅 200 个用户
  * @param subscribeType 订阅类型
- * @param expiry 订阅有效期，单位为秒
- * @returns 订阅错误为 26021 时返回被订阅达上限的用户 ID 列表
+ * @param expiry 订阅有效期，取值范围为[60,2592000]（单位:秒）
+ * @returns  返回一个 {@link IAsyncRes} 类型 Promise，订阅错误为 26021 时返回被订阅达上限（用户最多可以被 5000 个用户订阅）的用户 ID 列表
  * @since 5.9.8
+ * @example 订阅用户状态示例：
+ * ```ts
+ * const userIds = ['user1', 'user2'];
+ * const subscribeType = RongIMLib.SubscribeType.ONLINE_STATUS;
+ * // 设置订阅时间，取值范围为[60,2592000]（单位:秒）。
+ * const expiry = 60;
+ * const res = await RongIMLib.subscribeUserStatus(userIds, subscribeType, expiry);
+ * console.log('订阅用户状态结果：', res);
+ * ```
  */
 declare function subscribeUserStatus(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<IAsyncRes<string[]>>;
 /**
  * 取消订阅用户状态
- * <p>此方法用于取消已经订阅的用户状态事件。</p>
- * @param userIds 被订阅用户 ID 列表，一次最多订阅 200 个用户
- * @param subscribeType 订阅类型
- * @returns
+ * @category 订阅用户状态
+ * @description 此方法用于取消已经订阅的用户状态事件
+ * @param userIds 被订阅用户 ID 列表，一次最多传递 200 个用户
+ * @param subscribeType 订阅类型, 可在 {@link SubscribeType} 中获取
  * @since 5.9.8
+ * @example 取消订阅用户状态示例：
+ * ```ts
+ * const userIds = ['user1', 'user2'];
+ * const subscribeType = RongIMLib.SubscribeType.ONLINE_STATUS;
+ * const res = await RongIMLib.unSubscribeUserStatus(userIds, subscribeType);
+ * console.log('取消订阅用户状态结果：', res);
+ * ```
  */
 declare function unSubscribeUserStatus(userIds: string[], subscribeType: SubscribeType): Promise<IAsyncRes<void>>;
 /**
- * 查询当前的订阅用户列表
- * <p>此方法用于获取当前所有订阅的事件的状态信息。（仅支持在线状态类型）</p>
+ * 分页查询已订阅用户的状态信息
+ * @category 订阅用户状态
+ * @description 此方法用于获取当前所有订阅的事件的状态信息（仅支持在线状态类型）
  * @param pageSize 数量
  * @param offset 分页偏移量
- * @returns
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，其中 data 为 {@link ISubscribeUserStatusInfo} 类型数组
  * @since 5.9.8
+ * @example 分页查询已订阅用户的状态信息示例：
+ * ```ts
+ * const pageSize = 10;
+ * const offset = 0;
+ * const subscribeType = RongIMLib.SubscribeType.ONLINE_STATUS;
+ * const res = await RongIMLib.getSubscribeUserList(subscribeType, pageSize, offset);
+ * console.log('分页查询已订阅用户的状态信息结果：', res);
+ * ```
  */
 declare function getSubscribeUserList(subscribeType: SubscribeType, pageSize: number, offset: number): Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>;
 /**
- * 获取指定用户的状态
- * @param userIds 被订阅用户 ID 列表
- * @returns
+ * 查询订阅状态信息
+ * @category 订阅用户状态
+ * @description 查询指定用户和订阅类型的状态信息。 一次最多查询 200 个用户的状态信息
+ * @param userIds 被订阅用户 ID 列表, 列表不可为空，且一次最多查询 200 个用户的状态信息
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，其中 data 为 {@link ISubscribeUserStatusInfo} 类型数组
  * @since 5.9.8
+ * @example 查询订阅状态信息示例：
+ * ```ts
+ * const userIds = ['user1', 'user2'];
+ * const subscribeType = RongIMLib.SubscribeType.ONLINE_STATUS;
+ * const res = await RongIMLib.getSubscribeUserStatus(subscribeType, userIds);
+ * console.log('查询订阅状态信息结果：', res);
+ * ```
  */
 declare function getSubscribeUserStatus(subscribeType: SubscribeType, userIds: string[]): Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>;
+/**
+ * 更新用户资料
+ * @category 用户资料
+ * @description 此方法用于更新当前用户的资料信息
+ * @param profile 用户资料信息
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，其中 data 为 { errorKey: string } 类型
+ * @since 5.10.1
+ * @example 更新用户资料示例：
+ * ```ts
+ * const profile = {
+ *  name: 'name',
+ *  portraitUri: 'portraitUri',
+ *  email: 'email',
+ *  birthday: 'birthday',
+ *  gender: 1,
+ *  location: 'location',
+ *  role: 1,
+ *  level: 1,
+ *  extraProfile: {
+ *   key1: 'value1',
+ *   key2: 'value2',
+ *  },
+ * }
+ * const res = await RongIMLib.updateMyUserProfile(profile);
+ * console.log('更新用户资料结果：', res);
+ * ```
+*/
+declare function updateMyUserProfile(profile: IUserProfileInfo): Promise<IAsyncRes<{
+    errorKey: string;
+}>>;
+/**
+ * 批量获取用户资料
+ * @category 用户资料
+ * @description 此方法用于批量获取用户的资料信息
+ * @param userIds 用户ID 列表，一次最多获取 100 个
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，其中 data 为 {@link IUserProfileInfo} 类型数组
+ * @since 5.10.1
+ * @example 批量获取用户资料示例：
+ * ```ts
+ * const userIds = ['user1', 'user2'];
+ * const res = await RongIMLib.getUserProfiles(userIds);
+ * console.log('批量获取用户资料结果：', res);
+ * ```
+*/
+declare function getUserProfiles(userIds: string[]): Promise<IAsyncRes<IUserProfileInfo[]>>;
+/**
+ * 获取当前用户资料
+ * @category 用户资料
+ * @description 此方法用于获取当前用户的资料信息
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，其中 data 为 {@link IUserProfileInfo} 类型
+ * @since 5.10.1
+ * @example 获取当前用户资料示例：
+ * ```ts
+ * const res = await RongIMLib.getMyUserProfile();
+ * console.log('获取当前用户资料结果：', res);
+ * ```
+*/
+declare function getMyUserProfile(): Promise<IAsyncRes<IUserProfileInfo>>;
+/**
+ * 用户权限设置
+ * @category 用户资料
+ * @description 此方法用于设置用户信息权限
+ * @param Visibility 用户信息权限
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，其中 data 为 void 类型
+ * @since 5.10.1
+ * @example 用户权限设置示例：
+ * ```ts
+ * const visibility = RongIMLib.UserProfileVisibility.EVERYONE;
+ * const res = await RongIMLib.updateMyUserProfileVisibility(visibility);
+ * console.log('用户权限设置结果：', res);
+ * ```
+*/
+declare function updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<IAsyncRes<void>>;
+/**
+ * 用户权限获取
+ * @category 用户资料
+ * @description 此方法用于获取用户信息权限
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，其中 data 为 {@link UserProfileVisibility} 类型
+ * @since 5.10.1
+ * @example 用户权限获取示例：
+ * ```ts
+ * const res = await RongIMLib.getMyUserProfileVisibility();
+ * console.log('用户权限获取结果：', res);
+ * ```
+*/
+declare function getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisibility>>;
+/**
+ * 按用户应用号精确搜索用户信息
+ * @category 用户资料
+ * @description 此方法用于按用户应用号精确搜索用户信息
+ * @param uniqueId 用户应用号
+ * @returns 返回一个 {@link IAsyncRes} 类型 Promise，其中 data 为 {@link IUserProfileInfo} 类型
+ * @since 5.10.1
+ * @example 按用户应用号精确搜索用户信息示例：
+ * ```ts
+ * const uniqueId = 'uniqueId';
+ * const res = await RongIMLib.searchUserProfileByUniqueId(uniqueId);
+ * console.log('按用户应用号精确搜索用户信息结果：', res);
+ * ```
+*/
+declare function searchUserProfileByUniqueId(uniqueId: string): Promise<IAsyncRes<IUserProfileInfo>>;
 
-export { BaseMessage, _default$a as CombineMessage, _default$9 as CombineV2Message, CombineV2MessageContent, _default$2 as CommandMessage, ConnectType, EventListeners, Events, _default$8 as FileMessage, _default$7 as GIFMessage, GetHistoryMessageOption, GetHistoryMessageResult, _default as GroupNotificationMessage, _default$d as HQVoiceMessage, IAReceivedConversation, IAReceivedConversationByTag, IAReceivedMessage, IAUltraGroupReceivedConversation, ICombineMessageBody, ICommandMessageBody, IConversationEvent, IConversationState, IConversationUpdateItem, IExtraData, IFileMessageBody, IGIFMessageBody, IGetHistoryMessagesByTypesOption, IGroupNotificationMessageBody, IHQVoiceMessageBody, IImageMessageBody, IImageMessageOption, IInformationNotificationMessageBody, IInitOption, IInsertOptions, ILocationMessageBody, IMessageDesc, IMessageReceiptRequestEvent, IMessageReceiptResponseEvent, IMessagesEvent, IReadReceiptReceivedEvent, IRecallMessageOptions, IReceivedUpdateConversation, IReferenceMessageBody, IRichContentMessageBody, ISearchMessageInTimeRangeOption, ISendBody, ISendFileMessageOptions, ISendImageMessageOptions, ISendMessageOptions, ISendSightMessageOptions, ISightMessageBody, ITextMessageBody, IThumbnailConfig, ITypingStatusEvent, IUploadConfig, IUploadHooks, IUploadInfo, IUploadMessageOption, IUploadResult, IUserInfo, IVoiceMessageBody, _default$e as ImageMessage, _default$1 as InformationNotificationMessage, _default$5 as LocationMessage, MentionedInfo, MessageConstructor, MessageType, _default$4 as ReferenceMessage, _default$3 as RichContentMessage, _default$c as SightMessage, _default$b as TextMessage, UploadTask, _default$6 as VoiceMessage, __addSDKVersion, addConversationsToTag, addEventListener, addTag, addToBlacklist, batchClearRemoteHistoryMessages, batchGetMessageReadReceiptInfoV4, batchRemoveConversation, batchSetConversationNotificationLevel, batchSetConversationToTop, bindRTCRoomForChatroom, clearAllMessagesUnreadStatus, clearEventListeners, clearHistoryMessages, clearMessages$1 as clearMessages, clearMessagesUnreadStatus, clearTextMessageDraft, clearUnreadCountByTimestamp, connect, createUploadTask, deleteLocalMessagesByTimestamp, deleteMessages$1 as deleteMessages, destroy, disconnect, index as electronExtension, forceRemoveChatRoomEntry, forceSetChatRoomEntry, getAllChatRoomEntries, getAllConversationState, getAllUltraGroupUnreadCount, getAllUltraGroupUnreadMentionedCount, getAllUnreadMentionedCount, getBlacklist, getBlacklistStatus, getBlockUltraGroupList, getBlockedConversationList, getChatRoomEntry, getChatRoomInfo, getChatroomHistoryMessages, getConnectionStatus, getConversation, getConversationList$1 as getConversationList, getConversationNotificationLevel, getConversationNotificationStatus, getConversationTypeNotificationLevel, getConversationsFromTagByPage, getCurrentUserId, getDeviceId, getDownloadAuth, getFileToken, getFileUrl, getFirstUnreadMessage, getFirstUnreadMessageInfo, getHistoryMessages, getMessage, getMessageReadReceiptV4, getMessageReader, getProxy, getRemoteHistoryMessages, getServerTime, getSubscribeUserList, getSubscribeUserStatus, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getTotalUnreadCountByLevels, getTotalUnreadMentionedCountByLevels, getUltraGroupDefaultNotificationLevel, getUltraGroupFirstUnreadMessageTimestamp, getUltraGroupList, getUltraGroupMessageListByMessageUId, getUltraGroupUnreadCountByTargetId, getUltraGroupUnreadInfoList, getUltraGroupUnreadMentionedCountByTargetId, getUltraGroupUnreadMentionedMessages, getUnreadConversationList, getUnreadCount, getUnreadCountByTag, getUnreadMentionedCount, getUnreadMentionedMessages, init, insertMessage$1 as insertMessage, installPlugin, joinChatRoom, joinExistChatRoom, modifyMessage, onceEventListener, quitChatRoom, recallMessage, registerMessageType, removeAllExpansionForUltraGroupMessage, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEventListener, removeEventListeners, removeExpansionForUltraGroupMessage, removeFromBlacklist, removeMessageExpansionForKey, removeTag, removeTagFromConversations, removeTagsFromConversation, saveTextMessageDraft, searchConversationByContent$1 as searchConversationByContent, searchMessages$1 as searchMessages, sendFileMessage, sendGIFMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptMessageV4, sendReadReceiptRequest, sendReadReceiptResponse, sendReadReceiptResponseV2, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, sendUltraGroupTypingStatus, setChatRoomEntries, setChatRoomEntry, setConversationNotificationLevel, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, setConversationTypeNotificationLevel, setMessageReceivedStatus$1 as setMessageReceivedStatus, setProxy, setUltraGroupDefaultNotificationLevel, stopUploadTask, subscribeUserStatus, testProxy, unSubscribeUserStatus, updateExpansionForUltraGroupMessage, updateMessageExpansion, updateTag, upload };
+export { BaseMessage, _default$a as CombineMessage, _default$9 as CombineV2Message, CombineV2MessageContent, _default$2 as CommandMessage, ConnectType, EventListeners, Events, _default$8 as FileMessage, _default$7 as GIFMessage, GetHistoryMessageOption, GetHistoryMessageResult, _default as GroupNotificationMessage, _default$d as HQVoiceMessage, IAReceivedConversation, IAReceivedConversationByTag, IAReceivedMessage, IAUltraGroupReceivedConversation, IAuditInfo, ICombineMessageBody, ICommandMessageBody, IConversationEvent, IConversationState, IConversationUpdateItem, IExtraData, IFileMessageBody, IGIFMessageBody, IGetHistoryMessagesByTypesOption, IGroupNotificationMessageBody, IHQVoiceMessageBody, IImageMessageBody, IImageMessageOption, IInformationNotificationMessageBody, IInitOption, IInsertOptions, ILocationMessageBody, IMessageDesc, IMessageReceiptRequestEvent, IMessageReceiptResponseEvent, IMessagesEvent, IReadReceiptReceivedEvent, IRecallMessageOptions, IReceivedUpdateConversation, IReferenceMessageBody, IRichContentMessageBody, ISearchMessageInTimeRangeOption, ISendBody, ISendFileMessageOptions, ISendImageMessageOptions, ISendMessageOptions, ISendSightMessageOptions, ISightMessageBody, ITextMessageBody, IThumbnailConfig, ITypingStatusEvent, IUploadConfig, IUploadHooks, IUploadInfo, IUploadMessageOption, IUploadResult, IUserInfo, IVoiceMessageBody, _default$e as ImageMessage, _default$1 as InformationNotificationMessage, _default$5 as LocationMessage, MentionedInfo, MessageAuditType, MessageConstructor, MessageType, _default$4 as ReferenceMessage, _default$3 as RichContentMessage, _default$c as SightMessage, _default$b as TextMessage, UploadTask, _default$6 as VoiceMessage, __addSDKVersion, addConversationsToTag, addEventListener, addTag, addToBlacklist, batchClearRemoteHistoryMessages, batchGetMessageReadReceiptInfoV4, batchRemoveConversation, batchSetConversationNotificationLevel, batchSetConversationToTop, bindRTCRoomForChatroom, clearAllMessagesUnreadStatus, clearEventListeners, clearHistoryMessages, clearMessages$1 as clearMessages, clearMessagesUnreadStatus, clearTextMessageDraft, clearUnreadCountByTimestamp, connect, createUploadTask, deleteLocalMessagesByTimestamp, deleteMessages$1 as deleteMessages, destroy, disconnect, index as electronExtension, forceRemoveChatRoomEntry, forceSetChatRoomEntry, getAllChatRoomEntries, getAllConversationState, getAllUltraGroupUnreadCount, getAllUltraGroupUnreadMentionedCount, getAllUnreadMentionedCount, getBlacklist, getBlacklistStatus, getBlockUltraGroupList, getBlockedConversationList, getChatRoomEntry, getChatRoomInfo, getChatroomHistoryMessages, getConnectionStatus, getConversation, getConversationList$1 as getConversationList, getConversationNotificationLevel, getConversationNotificationStatus, getConversationTypeNotificationLevel, getConversationsFromTagByPage, getCurrentUserId, getDeviceId, getDownloadAuth, getFileToken, getFileUrl, getFirstUnreadMessage, getFirstUnreadMessageInfo, getHistoryMessages, getMessage, getMessageReadReceiptV4, getMessageReader, getMyUserProfile, getMyUserProfileVisibility, getProxy, getRemoteHistoryMessages, getServerTime, getSubscribeUserList, getSubscribeUserStatus, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getTotalUnreadCountByLevels, getTotalUnreadMentionedCountByLevels, getUltraGroupDefaultNotificationLevel, getUltraGroupFirstUnreadMessageTimestamp, getUltraGroupList, getUltraGroupMessageListByMessageUId, getUltraGroupUnreadCountByTargetId, getUltraGroupUnreadInfoList, getUltraGroupUnreadMentionedCountByTargetId, getUltraGroupUnreadMentionedMessages, getUnreadConversationList, getUnreadCount, getUnreadCountByTag, getUnreadMentionedCount, getUnreadMentionedMessages, getUserProfiles, init, insertMessage$1 as insertMessage, installPlugin, joinChatRoom, joinExistChatRoom, modifyMessage, onceEventListener, quitChatRoom, recallMessage, registerMessageType, removeAllExpansionForUltraGroupMessage, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEventListener, removeEventListeners, removeExpansionForUltraGroupMessage, removeFromBlacklist, removeMessageExpansionForKey, removeTag, removeTagFromConversations, removeTagsFromConversation, saveTextMessageDraft, searchConversationByContent$1 as searchConversationByContent, searchMessages$1 as searchMessages, searchUserProfileByUniqueId, sendFileMessage, sendGIFMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptMessageV4, sendReadReceiptRequest, sendReadReceiptResponse, sendReadReceiptResponseV2, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, sendUltraGroupTypingStatus, setChatRoomEntries, setChatRoomEntry, setConversationNotificationLevel, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, setConversationTypeNotificationLevel, setMessageReceivedStatus$1 as setMessageReceivedStatus, setProxy, setUltraGroupDefaultNotificationLevel, stopUploadTask, subscribeUserStatus, testProxy, unSubscribeUserStatus, updateExpansionForUltraGroupMessage, updateMessageExpansion, updateMyUserProfile, updateMyUserProfileVisibility, updateTag, upload };