@rongcloud/imlib-v2-adapter 5.18.0 → 5.20.0

package/index.d.ts

@@ -1,5 +1,5 @@
 import { IPushConfig, IUserProfile, ConversationType, MessageDirection, ReceivedStatus, IReadReceiptInfo, IReadReceiptResponseInfo, IConversationTag, LogLevel, EnableLogL, RCConnectionStatus, ErrorCode, ITypingMessage, IBlockedMessageInfo, IChatroomListenerData, IMessageDeliver, IGroupMessageDeliverStatus, ILogger, APIContext, AppStorage, IMessageReaderResponse, IInsertMessage, NotificationStatus, IGroupMessageDeliverInfo, IRemoveChatroomEntry, RTCMode, IPluginGenerator, INaviInfo, IChatroomEntry, IChatroomEntries, FileType, IUploadAuth, UploadMethod, ITagParam, ITagInfo, IExtraMethod, MentionedType as MentionedType$1 } from '@rongcloud/engine';
-export { AreaCode, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, ConnectionStatus, ConversationType, EnableLogL, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IConversationTag, IDeletedExpansion, IEventListener, IExpansionListenerData, IGooglePushConfig, IInsertMessage, IMessageReader, IMessageReaderResponse, IPushConfig, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatroomEntry, ITagInfo, ITagParam, ITypingMessage, ITypingUser, IUpdatedExpansion, IUploadAuth, IUserProfile, IiOSPushConfig, LogL, LogLevel, LogSource, LogTagId, MentionedInfoBody, MessageBlockType, MessageDirection, NotificationStatus, RCConnectionStatus, RTCApiType, RTCMode, ReceivedStatus, UploadMethod, logger } from '@rongcloud/engine';
+export { AreaCode, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, ConnectionStatus, ConversationType, EnableLogL, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBlockedMessageInfo, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IConversationTag, IDeletedExpansion, IEventListener, IExpansionListenerData, IGooglePushConfig, IInsertMessage, IMessageReader, IMessageReaderResponse, IPushConfig, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatroomEntry, ITagInfo, ITagParam, ITypingMessage, ITypingUser, IUpdatedExpansion, IUploadAuth, IUserProfile, IiOSPushConfig, LogL, LogLevel, LogSource, MentionedInfo as MentionedInfoBody, MessageBlockType, MessageDirection, NotificationStatus, RCConnectionStatus, RTCApiType, RTCMode, ReceivedStatus, UploadMethod, logger } from '@rongcloud/engine';
 
 declare enum SentStatus {
     /**
@@ -40,7 +40,7 @@ interface ISendOptionsV2 {
      */
     userIds?: string[];
     /**
-     * 为 ture 时, 当对方为 iOS 设备且未在线时，其将收到 Voip Push. 此配置对 Android 无影响
+     * 为 ture 时，当对方为 iOS 设备且未在线时，其将收到 Voip Push. 此配置对 Android 无影响
      */
     isVoipPush?: boolean;
     /**
@@ -134,7 +134,7 @@ interface IReceivedMessageV2 {
     } | null;
     disableNotification: boolean;
     /**
-     * 消息已读回执信息，导航配置grpRRVer=1时群组类型消息内存在, 其他情况为undefined
+     * 消息已读回执信息，导航配置 grpRRVer=1 时群组类型消息内存在，其他情况为 undefined
      */
     readReceiptInfo?: IReadReceiptInfo | IReadReceiptResponseInfo;
     pushConfig?: IPushConfig;
@@ -197,7 +197,7 @@ interface IConversationStatus {
      */
     notificationStatus?: 1 | 2;
     /**
-     * 标签
+     * @deprecated 参数无效
      */
     tags?: IConversationTag[];
 }
@@ -277,7 +277,7 @@ interface IInitOption {
     /**
      * @deprecated 配置已废弃
      */
-    logStdout?: (logLevel: LogLevel, content: string) => void;
+    logStdout?: (logLevel: LogLevel, content: string) => void | Promise<void>;
     /**
      * 调试模式，开启后 SDK 自动向控制台输出日志
      * @deprecated
@@ -324,7 +324,7 @@ interface IInitOption {
     typingExpireTime?: number;
     /**
      * @deprecate
-     * 是否打开 IndexDB 存储, 默认为 true
+     * 是否打开 IndexDB 存储，默认为 true
      */
     indexDBSwitch?: boolean;
     /**
@@ -332,7 +332,7 @@ interface IInitOption {
      */
     checkCA?: boolean;
     /**
-     * 群聊天回执超时时间, 最大值15天，最小1天，单位：天
+     * 群聊天回执超时时间，最大值 15 天，最小 1 天，单位：天
      * @defaultValue 1
      */
     readReceiptTimeout?: number;
@@ -344,6 +344,11 @@ interface IInitOption {
      * 私有云环境配置
      */
     environment?: string;
+    /**
+     * 启动事件循环阻塞检查；当值为 `true` 时，SDK 会启动事件循环阻塞检查，并在发现事件循环阻塞时记录日志。
+     * @since 5.20.0
+     */
+    eventLoopBlockingCheck?: boolean;
 }
 /**
  * 消息监听器
@@ -355,7 +360,7 @@ interface IReceiveMessageListener {
      * @param leftCount 该参数废弃，值将始终为 undefined
      * @param hasMore c++ 协议栈配套参数，消息是否收取结束
      */
-    onReceived(message: IReceivedMessageV2, leftCount?: number, hasMore?: boolean): void;
+    onReceived(message: IReceivedMessageV2, leftCount?: number, hasMore?: boolean): void | Promise<void>;
 }
 /**
  * 连接监听器
@@ -369,7 +374,7 @@ interface IConnectionStatusListener {
      * * RCConnectionStatus.SUSPEND - 连接中断，SDK 会尝试重连，可以通过 `code` 确认中断原因
      * @param code 当 status 值为 `RCConnectionStatus.DISCONNECTED` 或 `RCConnectionStatus.SUSPEND` 时，code 有值
      */
-    onChanged(status: RCConnectionStatus, code?: ErrorCode): void;
+    onChanged(status: RCConnectionStatus, code?: ErrorCode): void | Promise<void>;
 }
 /**
  * 会话状态监听器
@@ -378,56 +383,56 @@ interface IConversationStatusListener {
     /**
      * 状态回调
      */
-    onChanged(status: IReceivedConversationStatus[]): void;
+    onChanged(status: IReceivedConversationStatus[]): void | Promise<void>;
 }
 /**
  * 消息扩展监听器
  */
 interface IMessageExpansionListener {
-    onUpdated(data: IReceivedUpdatedExpansion): void;
-    onDeleted(data: IReceivedDeletedExpansion): void;
+    onUpdated(data: IReceivedUpdatedExpansion): void | Promise<void>;
+    onDeleted(data: IReceivedDeletedExpansion): void | Promise<void>;
 }
 /**
  * 标签监听器
  */
 interface ITagListener {
-    onChanged(): void;
+    onChanged(): void | Promise<void>;
 }
 /**
  * 离线拉取完成监听器
  */
 interface IPullFinishedListener {
-    onFinished(): void;
+    onFinished(): void | Promise<void>;
 }
 /**
- * typing监听器
+ * typing 监听器
  */
 interface ITypingListener {
-    onChanged(info: ITypingMessage[]): void;
+    onChanged(info: ITypingMessage[]): void | Promise<void>;
 }
 /**
  * 消息送达通知监听器
  */
 interface IMessageDeliveredListener {
-    onDelivered(info: IMessageDeliver[]): void;
+    onDelivered(info: IMessageDeliver[]): void | Promise<void>;
 }
 /**
  * 消息送达通知监听器
  */
 interface IGroupMessageDeliveredStatusListener {
-    onDelivered(info: IGroupMessageDeliverStatus): void;
+    onDelivered(info: IGroupMessageDeliverStatus): void | Promise<void>;
 }
 /**
  * 敏感词回调监听器
  */
 interface IMessageBlockedListener {
-    onReceived(info: IBlockedMessageInfo): void;
+    onReceived(info: IBlockedMessageInfo): void | Promise<void>;
 }
 /**
  * 聊天室监听器
  */
 interface IChatRoomListener {
-    onChanged(info: IChatroomListenerData): void;
+    onChanged(info: IChatroomListenerData): void | Promise<void>;
 }
 /**
  * 连接回调
@@ -437,16 +442,16 @@ interface IConnectCallback {
      * 连接成功回调
      * @param userId
      */
-    onSuccess(userId: string): void;
+    onSuccess(userId: string): void | Promise<void>;
     /**
      * 连接用 token 失效回调
      */
-    onTokenIncorrect(): void;
+    onTokenIncorrect(): void | Promise<void>;
     /**
      * 连接失败回调
      * @param errorcode 错误码
      */
-    onError(errorcode: number): void;
+    onError(errorcode: number): void | Promise<void>;
 }
 /**
  * 重连配置
@@ -458,11 +463,11 @@ interface IReconnectOptions {
      */
     auto?: boolean;
     /**
-     * 用于网络嗅探的地址。auto 为 true 时, 此参数必填
+     * 用于网络嗅探的地址。auto 为 true 时，此参数必填
      */
     url?: string;
     /**
-     * 网络嗅探频率, 单位为毫秒。auto 为 true 时, 此参数必填
+     * 网络嗅探频率，单位为毫秒。auto 为 true 时，此参数必填
      */
     rate?: number[];
 }
@@ -471,19 +476,19 @@ interface IErrorCallback {
      * 失败回调
      * @param error
      */
-    onError(error: ErrorCode, data?: unknown): void;
+    onError(error: ErrorCode, data?: unknown): void | Promise<void>;
 }
 interface ISuccessCallback<T, O = void> {
     /**
      * 成功回调
      * @param data
      */
-    onSuccess(data: T, other?: O): void;
+    onSuccess(data: T, other?: O): void | Promise<void>;
 }
 interface ICallback<T = void, O = void> extends ISuccessCallback<T, O>, IErrorCallback {
 }
 interface ISendCallback<T = void, O = void> extends ICallback<T, O> {
-    onBefore?(messageId: number): void;
+    onBefore?(messageId: number): void | Promise<void>;
 }
 /**
  * V2 API Conversation
@@ -516,7 +521,7 @@ interface IV2Conversation {
     */
     latestMessageId?: number;
     /**
-     * ~~会话中最后一条消息的消息标识, 融云内置消息以 "RC:" 开头~~
+     * ~~会话中最后一条消息的消息标识，融云内置消息以 "RC:" 开头~~
      * @deprecated
      * 该属性已废弃，请通过 `latestMessage` 取值
     */
@@ -532,7 +537,7 @@ interface IV2Conversation {
     */
     isTop: boolean;
     /**
-     * 会话免打扰状态： 1 开启免打扰、 2 关闭免打扰
+     * 会话免打扰状态：1 开启免打扰、2 关闭免打扰
     */
     notificationStatus: 1 | 2;
     /**
@@ -541,9 +546,6 @@ interface IV2Conversation {
      * 该属性已废弃，请通过 `latestMessage` 取值
     */
     receivedStatus?: number;
-    /**
-     * 会话中最后一条消息发送状态 TODO 待确认是否弃用
-    */
     /**
      * 按照消息搜索会话时，匹配到的消息数量
      */
@@ -554,7 +556,7 @@ interface IV2Conversation {
 */
 interface IV2ConversationContainTag extends IV2Conversation {
     /**
-     * 在tag中是否置顶
+     * 在 tag 中是否置顶
     */
     isTopInTag: boolean;
 }
@@ -614,7 +616,7 @@ interface IV2ChatRoomInfo {
 }
 interface IInsertOptions {
     /**
-     * 插入消息是否计入未读数: true 计数 false 不计数, 默认不计数
+     * 插入消息是否计入未读数：true 计数 false 不计数，默认不计数
      */
     isUnread?: boolean;
     /**
@@ -624,7 +626,7 @@ interface IInsertOptions {
 }
 interface IIMClientOptions {
     /**
-     * 群回执超时时间，单位天，最大15天
+     * 群回执超时时间，单位天，最大 15 天
      */
     readReceiptTimeout: number;
 }
@@ -689,7 +691,7 @@ declare class ChannelClient {
      * 获取当前组织下的所有会话的消息未读数
      * @description
      * 1. 清除浏览器缓存会导致会话未读数不准确
-     * 2. 会话消息未读数存储在 WebStorage 中, 若浏览器不支持或禁用 WebStorage，未读消息数将不会保存，浏览器页面刷新未读消息数将不会存在
+     * 2. 会话消息未读数存储在 WebStorage 中，若浏览器不支持或禁用 WebStorage，未读消息数将不会保存，浏览器页面刷新未读消息数将不会存在
      * @param callback
      * @param conversationTypes 要获取未读数的会话类型，若为空，则默认获取单聊、群聊及系统消息未读数
      * @param includeMuted 是否包含免打扰会话（web 暂未实现）
@@ -748,7 +750,7 @@ declare class ChannelClient {
      * @param isMentioned `是否为 @ 消息`
      * @param pushContent 移动端在接收到消息推送时用于显示的推送信息
      * @param pushData Push 通知时附加信息
-     * @param methodType 1 : 多客服(客服后台使用);   2 : 消息撤回
+     * @param methodType 1 : 多客服 (客服后台使用);   2 : 消息撤回
      * @param options 其他设置项
      */
     sendMessage(conversationType: ConversationType, targetId: string, msg: BaseMessage, callback: ISendCallback<IReceivedMessageV2>, isMentioned?: boolean, pushContent?: string, pushData?: string, options?: ISendOptionsV2): void;
@@ -807,8 +809,8 @@ declare class ChannelClient {
      * 从服务端拉取指定会话的历史消息
      * @param conversationType 会话类型
      * @param targetId 会话 ID
-     * @param timestamp 获取时间戳, 0 为从当前时间拉取
-     * @param count 拉取条数，获取条数, 范围 1 - 20
+     * @param timestamp 获取时间戳，0 为从当前时间拉取
+     * @param count 拉取条数，获取条数，范围 1 - 20
      * @param order 获取顺序，默认为 0。0 为升序，获取消息发送时间比 timestamp 更早的消息；1 为降序。
      * @param objectname
      */
@@ -865,8 +867,8 @@ declare class ChannelClient {
      * 协议栈获取远端历史消息
      * @param conversationType 会话类型
      * @param targetId 会话 ID
-     * @param timestamp 获取时间戳, 0 为从当前时间拉取
-     * @param count 拉取条数，获取条数, 范围 1 - 20
+     * @param timestamp 获取时间戳，0 为从当前时间拉取
+     * @param count 拉取条数，获取条数，范围 1 - 20
     */
     getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, callback: ICallback<Array<IReceivedMessageV2>, boolean>, options: {
         order?: 0 | 1;
@@ -893,7 +895,7 @@ declare class ChannelClient {
      * @param keyword 搜索内容
      * @param conversationType 会话类型
      * @param targetId 目标 ID
-     * @param timestamp 搜索时间, 搜索该时间之前的消息
+     * @param timestamp 搜索时间，搜索该时间之前的消息
      * @param count 获取的数量
     */
     searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, callback: ICallback<IReceivedMessageV2[], number>): void;
@@ -1013,7 +1015,7 @@ declare class IMClient {
      */
     disconnect(closeDB?: boolean): Promise<void>;
     /**
-     * 该方法等价于 disconnect
+     * @deprecated 请使用 disconnect 方法
      */
     logout(): Promise<void>;
     /**
@@ -1079,7 +1081,7 @@ declare class IMClient {
      * 获取所有会话的消息未读数
      * @description
      * 1. 清除浏览器缓存会导致会话未读数不准确
-     * 2. 会话消息未读数存储在 WebStorage 中, 若浏览器不支持或禁用 WebStorage，未读消息数将不会保存，浏览器页面刷新未读消息数将不会存在
+     * 2. 会话消息未读数存储在 WebStorage 中，若浏览器不支持或禁用 WebStorage，未读消息数将不会保存，浏览器页面刷新未读消息数将不会存在
      * @param callback
      * @param conversationTypes 要获取未读数的会话类型，若为空，则默认获取单聊、群聊及系统消息未读数（web 暂未实现）
      * @param includeMuted 是否包含免打扰会话（web 暂未实现）
@@ -1139,7 +1141,7 @@ declare class IMClient {
      * @param isMentioned `是否为 @ 消息`
      * @param pushContent 移动端在接收到消息推送时用于显示的推送信息
      * @param pushData Push 通知时附加信息
-     * @param methodType 该参数已废弃 ~~1 : 多客服(客服后台使用);   2 : 消息撤回~~
+     * @param methodType 该参数已废弃 ~~1 : 多客服 (客服后台使用);   2 : 消息撤回~~
      * @param options 其他设置项
      */
     sendMessage(conversationType: ConversationType, targetId: string, msg: BaseMessage, callback: ISendCallback<IReceivedMessageV2>, isMentioned?: boolean, pushContent?: string, pushData?: string, methodType?: number, options?: ISendOptionsV2): void;
@@ -1198,8 +1200,8 @@ declare class IMClient {
      * 从服务端拉取指定会话的历史消息
      * @param conversationType 会话类型
      * @param targetId 会话 ID
-     * @param timestamp 获取时间戳, 0 为从当前时间拉取
-     * @param count 拉取条数，获取条数, 范围 1 - 20
+     * @param timestamp 获取时间戳，0 为从当前时间拉取
+     * @param count 拉取条数，获取条数，范围 1 - 20
      * @param callback
      * @param objectName
      * @param order 获取顺序，默认为 0。0 为升序，获取消息发送时间比 timestamp 更早的消息；1 为降序。
@@ -1221,7 +1223,7 @@ declare class IMClient {
     /**
      * 获取聊天室信息
      * @param chatRoomId 聊天室 id
-     * @param count 获取人数, 范围 0 - 20
+     * @param count 获取人数，范围 0 - 20
      * 1. 传入 0 获取到的聊天室信息将或仅包含成员总数，不包含具体的成员列表
      * 2. 传入其他大于 0 的值返回聊天室信息，结果仅包含包含不多于 20 人的成员信息和当前成员总数。最大值为 20
      * @param order 排序方式，1 为正序，2 为倒序
@@ -1238,7 +1240,7 @@ declare class IMClient {
     setChatroomEntry(chatRoomId: string, chatroomEntry: IChatroomEntry, callback: ICallback): void;
     /**
      * 批量设置聊天室自定义属性
-     * @param options ISetChatroomEntryOption数组
+     * @param options ISetChatroomEntryOption 数组
      */
     setChatRoomEntries(chatRoomId: string, options: IChatroomEntries, callback: ICallback): void;
     /**
@@ -1260,7 +1262,7 @@ declare class IMClient {
     /**
      * 批量删除聊天室属性
      * @description 仅限于删除自己设置的聊天室属性
-     * @param options entries属性名称集合, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
+     * @param options entries 属性名称集合，支持英文字母、数字、+、=、-、_ 的组合方式，最大长度 128 字符
      */
     removeChatRoomEntries(chatRoomId: string, options: {
         entries: string[];
@@ -1291,12 +1293,12 @@ declare class IMClient {
     /**
      * 拉取聊天室内的历史消息
      * @param chatRoomId
-     * @param count 拉取消息条数, 有效值范围 1 - 20
+     * @param count 拉取消息条数，有效值范围 1 - 20
      * @param order 获取顺序，默认值为 0。
      * * 0：降序，用于获取早于指定时间戳发送的消息
      * * 1：升序，用于获取晚于指定时间戳发送的消息
      * @param callback
-     * @param timestamp v3.0 版本中的新增参数，用于指定拉取消息用到的时间戳。默认值为0，表示按当前时间拉取
+     * @param timestamp v3.0 版本中的新增参数，用于指定拉取消息用到的时间戳。默认值为 0，表示按当前时间拉取
      */
     getChatRoomHistoryMessages(chatRoomId: string, count: number, order: 0 | 1, callback: ICallback<IReceivedMessageV2[], boolean>, timestamp?: number): void;
     /**
@@ -1321,7 +1323,7 @@ declare class IMClient {
      * 通过时间戳删除消息
      * @param conversationType 会话类型
      * @param targetId 会话 id
-     * @param timestamp 清除时间点, 该时间之前的消息将被清除
+     * @param timestamp 清除时间点，该时间之前的消息将被清除
      * @param callback
      */
     /**
@@ -1339,10 +1341,10 @@ declare class IMClient {
      * @param queryString STC 分段上传时的查询字符串
      * @description
      * `httpMethod` 与 `queryString` 为 STC S3 分段上传时的专属参数，STC 分段上传包含三个过程：
-     * 1. 开始分段前调用，此时 `httpMethod` 值应为 `POST`， `queryString` 值为 `uploads`,filename为空
+     * 1. 开始分段前调用，此时 `httpMethod` 值应为 `POST`，`queryString` 值为 `uploads`,filename 为空
      * 2. 上传请求前调用，此时 `httpMethod` 值应为 `PUT`，`queryString` 值为 `partNumber={partamNumer}&uploadId={uploadId}`，
-     * filename为第一个步骤生成的filename
-     * 3. 上传结束前调用，此时 `httpMethod` 值应为 `POST`，`queryString` 值为 `uploadId={uploadId}`，filename为第一个步骤生成的filename
+     * filename 为第一个步骤生成的 filename
+     * 3. 上传结束前调用，此时 `httpMethod` 值应为 `POST`，`queryString` 值为 `uploadId={uploadId}`，filename 为第一个步骤生成的 filename
      * @returns
      */
     getFileToken(fileType: FileType, callback: ICallback<IUploadAuth & {
@@ -1406,20 +1408,20 @@ declare class IMClient {
     removeTagsForConversation(conversation: IConversationOption, tagIds: string[], callback: ICallback): void;
     /**
      * 分页获取标签下会话列表
-     * @param tagId 标签id
+     * @param tagId 标签 id
      * @param count 获取数量
      * @param timestamp 会话时间戳
     */
     getConversationListByTag(tagId: string, count: number, startTime: number, callback: ICallback<IV2ConversationContainTag[]>): void;
     /**
      * 根据标签获取未读消息数
-     * @param tagId 标签id
+     * @param tagId 标签 id
      * @param containMuted 是否包含免打扰
      */
     getUnreadCountByTag(tagId: string, containMuted: boolean, callback: ICallback<number>): void;
     /**
      * 设置标签中会话置顶
-     * @param tagId 标签id
+     * @param tagId 标签 id
      * @param conversation 会话
      * @param status 状态
      */
@@ -1434,7 +1436,7 @@ declare class IMClient {
      */
     callExtra(method: string | keyof IExtraMethod, callback: ICallback<unknown, unknown>, ...args: any[]): void;
     /**
-     * 是否有远端未读消息 （ C++ ）
+     * 是否有远端未读消息（C++ ）
      * @description
     */
     hasRemoteUnreadMessages(token: string, callback: ICallback<Boolean>): void;
@@ -1502,9 +1504,9 @@ declare class IMClient {
      * 获取远端历史消息
      * @param conversationType 会话类型
      * @param targetId 会话 ID
-     * @param timestamp 获取时间戳, 0 为从当前时间拉取
-     * @param count 拉取条数，获取条数, 范围 1 - 20
-     * @param options.order 获取顺序, 默认为 0
+     * @param timestamp 获取时间戳，0 为从当前时间拉取
+     * @param count 拉取条数，获取条数，范围 1 - 20
+     * @param options.order 获取顺序，默认为 0
     */
     getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, callback: ICallback<Array<IReceivedMessageV2>, boolean>, options?: {
         order?: 0 | 1;
@@ -1565,14 +1567,14 @@ declare class IMClient {
      * 按内容搜索会话
      * @param keyword 关键字
      * @param conversationTypes 会话类型数组
-     * @param customMessageTypes 自定义消息类型,若关键字属于自定义消息类型，需传入
+     * @param customMessageTypes 自定义消息类型，若关键字属于自定义消息类型，需传入
     */
     searchConversationByContent(keyword: string, callback: ICallback<IV2Conversation[]>, conversationTypes?: ConversationType[], customMessageTypes?: string[]): void;
     /**
-     * 按内容搜索全部会话(包含全部 channel)
+     * 按内容搜索全部会话 (包含全部 channel)
      * @param keyword 关键字
      * @param callback 回调函数
-     * @param customMessageTypes 自定义消息类型,若关键字属于自定义消息类型，需传入
+     * @param customMessageTypes 自定义消息类型，若关键字属于自定义消息类型，需传入
      * @param conversationTypes 会话类型数组
     */
     searchConversationByContentWithAllChannel(keyword: string, callback: ICallback<IV2Conversation[]>, customMessageTypes?: string[], conversationTypes?: ConversationType[]): void;
@@ -1581,7 +1583,7 @@ declare class IMClient {
      * @param keyword 搜索内容
      * @param conversationType 会话类型
      * @param targetId 目标 ID
-     * @param timestamp 搜索时间, 搜索该时间之前的消息
+     * @param timestamp 搜索时间，搜索该时间之前的消息
      * @param count 获取的数量
     */
     searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, callback: ICallback<IReceivedMessageV2[], number>): void;
@@ -1590,7 +1592,7 @@ declare class IMClient {
      * @param conversationType 会话类型
      * @param targetId 目标 ID
      * @param keyword 搜索内容
-     * @param timestamp 搜索时间, 搜索该时间之前的消息
+     * @param timestamp 搜索时间，搜索该时间之前的消息
      * @param count 获取的数量
     */
     searchMessageByContentWithAllChannel(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, callback: ICallback<IReceivedMessageV2[], number>): void;
@@ -1711,11 +1713,11 @@ declare const _default$i: {
     */
     setMessageExpansionListener(listener: IMessageExpansionListener): void;
     /**
-     * tag监听
+     * tag 监听
      */
     setTagListener(listener: ITagListener): void;
     /**
-     * 会话中tag状态监听
+     * 会话中 tag 状态监听
      */
     setConversationTagListener(listener: ITagListener): void;
     /**
@@ -1723,7 +1725,7 @@ declare const _default$i: {
      */
     setPullOffLineFinished(listener: IPullFinishedListener): void;
     /**
-     * typing监听
+     * typing 监听
      */
     setTypingStatusListener(listenner: ITypingListener): void;
     /**
@@ -1844,7 +1846,7 @@ interface ImageMessageOptions extends IExtraData, IMentionedInfo, IUserInfo, IBu
     /**
      * 图片的略缩图
      * @description
-     * 1. 必须是 base64 字符串, 图片类型为 JPG
+     * 1. 必须是 base64 字符串，图片类型为 JPG
      * 2. base64 字符串大小不可超过 80 KB
      * 3. 字符串前无媒体类型前缀
      */
@@ -1883,7 +1885,7 @@ interface HQVoiceMessageOptions extends IExtraData, IMentionedInfo, IBurnDuratio
      */
     type?: string;
     /**
-     * 语音消息的时长，最大值为 60 （单位：秒）
+     * 语音消息的时长，最大值为 60（单位：秒）
      */
     duration: number;
 }
@@ -1895,7 +1897,7 @@ interface FileMessageOptions extends IExtraData, IUserInfo {
      */
     name: string;
     /**
-     * 文件尺寸，单位: Byte
+     * 文件尺寸，单位：Byte
      */
     size: number;
     /**
@@ -1980,7 +1982,7 @@ declare const _default$6: new (content: ReadReceiptRequestMessageContent) => Bas
 
 interface ReadReceiptResponseMessageContent {
     /**
-     * 回复已读通知信息,{userId: [messageUId]}
+     * 回复已读通知信息，{userId: [messageUId]}
      */
     receiptMessageDic: {
         [userId: string]: string[];
@@ -2002,7 +2004,7 @@ interface CombineMessageOptions extends IExtraData, IUserInfo {
     */
     summaryList: string;
     /**
-     * 会话类型，目前合并转发功能支持二人会话及群聊会话，二人会话是 1 、群组会话是 3
+     * 会话类型，目前合并转发功能支持二人会话及群聊会话，二人会话是 1、群组会话是 3
     */
     conversationType: ConversationType;
 }
@@ -2181,8 +2183,8 @@ declare const ConnectionState: {
     UNACCEPTABLE_PROTOCOL_VERSION: number;
     /**
      * 客户端（移动端 TCP 连接建立时）`info` 字段格式错误
-     * @description 格式：`{平台类型}-{设备信息}-{sdk版本}`。
-     * 其中设备信息为：{手机类型}{手机型号}{网络类型，4G/WIFI}{运营商标识, 移动/电信/联通}
+     * @description 格式：`{平台类型}-{设备信息}-{sdk 版本}`。
+     * 其中设备信息为：{手机类型}{手机型号}{网络类型，4G/WIFI}{运营商标识，移动/电信/联通}
      */
     IDENTIFIER_REJECTED: number;
     /**
@@ -2227,7 +2229,7 @@ declare const ConnectionState: {
      */
     HOSTNAME_ERROR: number;
     /**
-     * 开启`禁止把已在线客户端踢下线`开关后，该错误码标识已有同类型端在线，禁止链接
+     * 开启 `禁止把已在线客户端踢下线` 开关后，该错误码标识已有同类型端在线，禁止链接
      */
     HASOHTERSAMECLIENTONLINE: number;
     /**