@rongcloud/engine 4.4.9 → 5.0.0-alpha.3

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v4.4.9
- * CommitId - 23d6f4e445f77284cb9e4b70a6df4c90326928db
- * Fri Sep 24 2021 17:12:40 GMT+0800 (China Standard Time)
+ * RCEngine - v5.0.0-alpha.3
+ * CommitId - 3e5a7cf4e97602af42b8933af7de690b0db08c21
+ * Mon Sep 27 2021 18:25:16 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -337,6 +337,19 @@ interface IChrmKVEntry {
     type?: number;
     isDeleted?: boolean;
 }
+interface IChrmKVEntries {
+    entries: {
+        key: string;
+        value?: string;
+    }[];
+    notificationExtra?: string;
+    isOverwrite?: boolean;
+    isAutoDelete?: boolean;
+    timestamp?: number;
+    userId?: string;
+    type?: number;
+    isDeleted?: boolean;
+}
 interface IServerConversationStatus {
     conversationType: number;
     targetId: string;
@@ -395,6 +408,17 @@ declare enum ChatroomEntryType {
     DELETE = 2
 }
 
+declare enum MessageDirection {
+    /**
+     * 己方发送消息
+     */
+    SEND = 1,
+    /**
+     * 己方接收消息
+     */
+    RECEIVE = 2
+}
+
 interface IGooglePushConfig {
     /**
      * 分组ID
@@ -494,6 +518,155 @@ interface IPushConfig {
     templateId: string;
 }
 
+/**
+ * 已读回执数据结构
+ */
+interface IMessageReader {
+    readTime: number;
+    userId: string;
+}
+interface IMessageReaderResponse {
+    totalMemberCount: number;
+    list: IMessageReader[];
+}
+interface ILocalReadReceiptInfo {
+    hasRespond?: boolean;
+    readerInfo?: {
+        [userId: string]: number;
+    };
+    readCount?: number;
+    totalCount?: number;
+}
+interface IReadReceiptInfo {
+    /**
+     * 是否已经发送已读回执
+     */
+    hasRespond?: boolean;
+    /**
+     * 已阅读用户列表（不准确）
+     */
+    readerList?: IMessageReader[];
+    /**
+     * 阅读人数（不准确）
+     */
+    readCount?: number;
+    /**
+     * 群组总人数（不准确）
+     */
+    totalCount?: number;
+}
+/**
+ * 从服务端接收到的消息数据
+ */
+interface IReceivedMessage {
+    /**
+     * 会话的业务标识
+    */
+    channelId?: string;
+    /**
+     * 会话类型
+     * * 1: 单聊
+     * * 3: 群聊
+     * * 4: 聊天室
+     * * 5: 客服会话
+     * * 6: 系统消息
+     * * 7: 默认关注的公众号
+     * * 8: 手动关注的公众号
+     * * 9: RTCLib 房间
+     */
+    conversationType: ConversationType;
+    /**
+     * 会话 targetId
+     */
+    targetId: string;
+    /**
+     * 消息发送者的用户 Id
+     */
+    senderUserId: string;
+    /**
+     * 消息内容
+     */
+    content: any;
+    /**
+     * 消息结构名称，即消息类型
+     * @example RC:TxtMsg
+     */
+    messageType: string;
+    /**
+     * 服务端存储的消息 Id
+     */
+    messageUId: string;
+    /**
+     * 消息方向是发出 or 收取
+     */
+    messageDirection: MessageDirection;
+    /**
+     * 是否为离线消息
+     */
+    isOffLineMessage: boolean;
+    /**
+     * 消息在服务器端的发送时间
+     */
+    sentTime: number;
+    /**
+     * 消息接收时间，该时间通过消息的 `sentTime` 值在本地进行计算得出，不推荐使用
+     * @description 当 isOffLineMessage 为 true 时，该值无效
+     */
+    receivedTime: number;
+    /**
+     * 是否存储
+     * @default true
+     */
+    isPersited: boolean;
+    /**
+     * 是否计数
+     * @default true
+     */
+    isCounted: boolean;
+    /**
+     * 是否为 @ 消息
+     */
+    isMentioned: boolean;
+    /**
+     * 消息是否静默
+     * @description 静默消息不会发送 Push 信息和本地通知提醒
+     */
+    disableNotification: boolean;
+    /**
+     * 是否是状态消息
+     */
+    isStatusMessage: boolean;
+    /**
+     * 是否支持消息扩展存储
+    */
+    canIncludeExpansion: boolean;
+    /**
+     * 消息携带的扩展存储
+    */
+    expansion: {
+        [key: string]: any;
+    } | null;
+    /**
+     * 消息接收状态
+    */
+    receivedStatus: number;
+    /**
+     * CPP 独有字段 消息本地 ID
+    */
+    messageId?: number;
+    /**
+     * CPP 独有字段 消息发送状态
+    */
+    sentStatus?: number;
+    /**
+     * 已读回执信息(导航配置grpRRVer=1时群组类型消息内存在, 其他情况为undefined)
+     */
+    readReceiptInfo?: IReadReceiptInfo;
+    /**
+     * 推送扩展
+     */
+    pushConfig?: IPushConfig;
+}
 interface IUserProfile {
     /**
       * 用户 ID
@@ -512,6 +685,35 @@ interface IUserProfile {
      */
     extra?: string;
 }
+interface IRecallMsgOptions {
+    /**
+     * 会话组织机构标识
+     * 默认值未 空字符串
+    */
+    channelId: string;
+    /**
+     * 发送消息携带的用户信息
+    */
+    user?: IUserProfile;
+    /**
+     * Push 信息
+    */
+    pushContent?: string;
+    /**
+     * 原消息体
+    */
+    oriContent?: any;
+    /**
+     * 是否发送静默消息
+     * @description
+     * 当值为 `true` 时，服务器将不会发送 Push 信息，移动端也不会弹出本地通知提醒
+    */
+    disableNotification?: boolean;
+    /**
+     * 移动端推送配置
+    */
+    pushConfig?: IPushConfig;
+}
 /**
  * 发送消息时的可选项信息
  */
@@ -615,6 +817,55 @@ interface ISendMsgOptions {
     */
     channelId?: string;
 }
+interface IInsertMsgOptions {
+    senderUserId: string;
+    messageType: string;
+    content: string;
+    messageDirection: number;
+    readStatus?: number;
+    sentStatus?: number;
+    sentTime?: number;
+    searchContent?: string;
+    isUnread?: boolean;
+    messageUId?: string;
+    disableNotification?: boolean;
+    canIncludeExpansion?: boolean;
+    expansionMsg?: string;
+    channelId: string;
+}
+interface ISendExMsgOptions {
+    channelId: string;
+    conversationType: ConversationType;
+    targetId: string;
+    /**
+     * 消息 ID
+    */
+    messageUId: string;
+    /**
+     * 原始消息是否支持扩展的字段
+    */
+    canIncludeExpansion: boolean;
+    /**
+     * 删除的 keys
+    */
+    keys?: string[];
+    /**
+     * 扩展对象
+    */
+    expansion?: {
+        [key: string]: string;
+    };
+    /**
+     * 是否删除所有扩展
+    */
+    removeAll?: boolean;
+    /**
+     * 原始消息的扩展
+    */
+    originExpansion?: {
+        [key: string]: string;
+    } | null;
+}
 
 /**
  * TODO: 确定对外暴露的必要性
@@ -895,10 +1146,14 @@ declare enum ErrorCode {
     MSG_ROAMING_SERVICE_UNAVAILABLE = 33007,
     MSG_INSERT_ERROR = 33008,
     MSG_DEL_ERROR = 33009,
+    /**
+     * 标签已存在
+     */
+    TAG_EXISTS = 33101,
     /**
      * 标签不存在
      */
-    TAG_NOT_EXIST = 33101,
+    TAG_NOT_EXIST = 33100,
     /**
      * 会话中不存在此标签
      */
@@ -974,6 +1229,10 @@ declare enum ErrorCode {
      * 开启`禁止把已在线客户端踢下线`开关后，该错误码标识已有同类型端在线，禁止链接
      */
     HAS_OHTER_SAME_CLIENT_ON_LINE = 35010,
+    /**
+     * 上传文件失败
+     */
+    UPLOAD_FILE_FAILED = 35020,
     /**
      * 加入聊天室Id为空
      */
@@ -1112,7 +1371,11 @@ declare enum ErrorCode {
     /**
      * VoIP 不可用
      */
-    VOIP_NOT_AVALIABLE = 18
+    VOIP_NOT_AVALIABLE = 18,
+    /**
+     * 聊天室批量设置kv部分不成功
+     */
+    CHATROOM_KV_STORE_NOT_ALL_SUCCESS = 23428
 }
 
 /**
@@ -1172,17 +1435,6 @@ declare enum RTCIdentityChangeType {
     ViewerToAnchor = 2
 }
 
-declare enum MessageDirection {
-    /**
-     * 己方发送消息
-     */
-    SEND = 1,
-    /**
-     * 己方接收消息
-     */
-    RECEIVE = 2
-}
-
 /**
  * 序列化、反序列化数据通道
 */
@@ -1343,6 +1595,7 @@ declare class DataCodec {
       * 聊天室 KV 存储
     */
     encodeModifyChatRoomKV(chrmId: string, entry: IChrmKVEntry, currentUserId: string): any;
+    encodeModifyChatRoomKVS(chrmId: string, entryOptions: IChrmKVEntries, currentUserId: string): any;
     /**
       * KV 存储拉取
     */
@@ -1409,7 +1662,6 @@ declare class DataCodec {
      * 全量 URI
      */
     encodeUserSetRTCData(message: any, valueInfo: string, objectName: string, mcuValInfo: string): any;
-    encodeUserSetRTCCDNUris(objectName: string, CDNUris: string): any;
     /**
      * 用户属性获取
     */
@@ -1548,6 +1800,16 @@ interface IAsyncRes<T = any> {
  * 通过 `Promise.resolve` 来处理预期内的异常，进而通过 Uncatch Promise Error 暴露预期外的异常
  */
 declare type IPromiseResult<T> = Promise<IAsyncRes<T>>;
+interface IConnectResult {
+    /**
+     * 连接错误码
+     */
+    code: ErrorCode;
+    /**
+     * 导航获取成功后即可有相应的值，在导航数据获取完成之前该值为 undefined
+     */
+    userId?: string;
+}
 
 interface IDataChannelWatcher {
     /**
@@ -1813,157 +2075,6 @@ declare enum NotificationStatus {
     CLOSE = 2
 }
 
-/**
- * 已读回执数据结构
- */
-interface IMessageReader {
-    readTime: number;
-    userId: string;
-}
-interface IMessageReaderResponse {
-    totalMemberCount: number;
-    list: IMessageReader[];
-}
-interface ILocalReadReceiptInfo {
-    hasRespond?: boolean;
-    readerInfo?: {
-        [userId: string]: number;
-    };
-    readCount?: number;
-    totalCount?: number;
-}
-interface IReadReceiptInfo {
-    /**
-     * 是否已经发送已读回执
-     */
-    hasRespond?: boolean;
-    /**
-     * 已阅读用户列表（不准确）
-     */
-    readerList?: IMessageReader[];
-    /**
-     * 阅读人数（不准确）
-     */
-    readCount?: number;
-    /**
-     * 群组总人数（不准确）
-     */
-    totalCount?: number;
-}
-
-/**
- * 从服务端接收到的消息数据
- */
-interface IReceivedMessage {
-    /**
-     * 会话的业务标识
-    */
-    channelId?: string;
-    /**
-     * 会话类型
-     * * 1: 单聊
-     * * 3: 群聊
-     * * 4: 聊天室
-     * * 5: 客服会话
-     * * 6: 系统消息
-     * * 7: 默认关注的公众号
-     * * 8: 手动关注的公众号
-     * * 9: RTCLib 房间
-     */
-    conversationType: ConversationType;
-    /**
-     * 会话 targetId
-     */
-    targetId: string;
-    /**
-     * 消息发送者的用户 Id
-     */
-    senderUserId: string;
-    /**
-     * 消息内容
-     */
-    content: any;
-    /**
-     * 消息结构名称，即消息类型
-     * @example RC:TxtMsg
-     */
-    messageType: string;
-    /**
-     * 服务端存储的消息 Id
-     */
-    messageUId: string;
-    /**
-     * 消息方向是发出 or 收取
-     */
-    messageDirection: MessageDirection;
-    /**
-     * 是否为离线消息
-     */
-    isOffLineMessage: boolean;
-    /**
-     * 消息在服务器端的发送时间
-     */
-    sentTime: number;
-    /**
-     * 消息接收时间，该时间通过消息的 `sentTime` 值在本地进行计算得出，不推荐使用
-     * @description 当 isOffLineMessage 为 true 时，该值无效
-     */
-    receivedTime: number;
-    /**
-     * 是否存储
-     * @default true
-     */
-    isPersited: boolean;
-    /**
-     * 是否计数
-     * @default true
-     */
-    isCounted: boolean;
-    /**
-     * 是否为 @ 消息
-     */
-    isMentioned: boolean;
-    /**
-     * 消息是否静默
-     * @description 静默消息不会发送 Push 信息和本地通知提醒
-     */
-    disableNotification: boolean;
-    /**
-     * 是否是状态消息
-     */
-    isStatusMessage: boolean;
-    /**
-     * 是否支持消息扩展存储
-    */
-    canIncludeExpansion: boolean;
-    /**
-     * 消息携带的扩展存储
-    */
-    expansion: {
-        [key: string]: any;
-    } | null;
-    /**
-     * 消息接收状态
-    */
-    receivedStatus: number;
-    /**
-     * CPP 独有字段 消息本地 ID
-    */
-    messageId?: number;
-    /**
-     * CPP 独有字段 消息发送状态
-    */
-    sentStatus?: number;
-    /**
-     * 已读回执信息(导航配置grpRRVer=1时群组类型消息内存在, 其他情况为undefined)
-     */
-    readReceiptInfo?: IReadReceiptInfo;
-    /**
-     * 推送扩展
-     */
-    pushConfig?: IPushConfig;
-}
-
 /**
  * 从服务器拉取到的会话数据结构
  */
@@ -2031,7 +2142,6 @@ interface IReceivedConversation {
 interface IReceivedConversationByTag extends IReceivedConversation {
     isTopInTag: boolean;
 }
-
 /**
  * 设置会话状态 参数 信息
 */
@@ -2042,61 +2152,227 @@ interface ISetConversationStatusOptions {
     notificationStatus?: number;
     channelId?: string;
 }
-
-interface IChatroomUser {
-    /**
-     * 用户 id
-     */
-    id: string;
+interface IUpdatedConversation {
+    updatedItems: {
+        [key: string]: {
+            time: number;
+            val: any;
+        };
+    };
+    conversationType: number;
+    targetId: string;
+    latestMessage?: IReceivedMessage;
+    unreadMessageCount?: number;
+    hasMentioned?: boolean;
+    mentionedInfo?: {
+        /**
+         * `@ 类型，其中 1 为 @ 所有人，2 为 @ 部分人`
+         */
+        type: 1 | 2;
+        /**
+         * 被 @ 的用户 Id 列表，仅在 `type` 为 `2` 时有效
+         */
+        userIdList: string[];
+    };
+    lastUnreadTime?: number;
+    notificationStatus?: number;
+    isTop?: boolean;
     /**
-     * 加入聊天室的时间
-     */
-    time: number;
+     * 会话标识
+    */
+    channelId?: string;
+    tags?: IUpdatedConversation[];
 }
 
-interface IChatroomInfo {
-    /**
-     * 成员列表
-     * @todo 需确认数组元素的数据结构
-     */
-    userInfos: IChatroomUser[];
-    /**
-     * 房间内总人数
-     */
-    userCount: number;
+/**
+ * 聊天室成员进入和退出状态
+ */
+declare enum ChatroomUserChangeType {
+    QUIT = 0,
+    JOIN = 1
 }
 
-interface IUploadAuth {
+interface IChatroomEntryListenerData {
     /**
-     * 七牛 token 有效期
+     * 更新的键
     */
-    deadline: number;
+    key: string;
     /**
-     * 七牛上传 token
+     * 更新的值
     */
-    token: string;
+    value: string;
     /**
-     * 百度上传 token
+     * 更新的时间
     */
-    bosToken: string;
+    timestamp: number;
     /**
-     * 百度上传 header Date
+     * 更新的聊天室 ID
     */
-    bosDate: string;
+    chatroomId: string;
     /**
-     * 百度上传路径
+     * 更新类型
     */
-    path: string;
-    /**
-     * 上传文件名，阿里上传获取下载地址时，必须使用上传文件名，所以需抛出到业务端
-     */
-    fileName: string;
+    type: ChatroomEntryType;
+}
+interface IChatroomRejoinedFailed {
     /**
-     * 阿里云 oss 的 AccessKeyId
-     */
-    osskeyId: string;
+     * 自动重新加入的聊天室 ID
+    */
+    chatroomId: string;
     /**
-     * 阿里云 oss post 请求表单域中的字段 policy
+     * 自动重新加入失败的 code
+    */
+    errorCode: number;
+}
+interface IChatroomRejoinedSuccessed {
+    /**
+     * 自动重新加入的聊天室 ID
+    */
+    chatroomId: string;
+    /**
+     * 自动重新加入的聊天室拉取消息的数量
+    */
+    count: number;
+}
+interface IChatroomUserChangeInfo {
+    users: {
+        [userId: string]: ChatroomUserChangeType;
+    };
+    chatroomId: string;
+}
+declare type IChatroomRejoinedInfo = IChatroomRejoinedFailed | IChatroomRejoinedSuccessed;
+/**
+ * 聊天室信息
+*/
+interface IChatroomListenerData {
+    /**
+     * SDK 内部重连聊天室信息
+    */
+    rejoinedRoom?: IChatroomRejoinedInfo;
+    /**
+     * 监听到的聊天室 KV 更新
+    */
+    updatedEntries?: IChatroomEntryListenerData[];
+    /**
+     * 登录退出的用户通知
+     */
+    userChange?: IChatroomUserChangeInfo;
+    /**
+     * 聊天室销毁
+     */
+    chatroomDestroyed?: string;
+}
+interface IChatroomEntry {
+    /**
+     * 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
+     */
+    key: string;
+    /**
+     * 属性对应的值, 最大长度 4096 字符
+     */
+    value: string;
+    /**
+     * 设置成功后是否发送通知消息
+     */
+    isSendNotification?: boolean;
+    /**
+     * RC:chrmKVNotiMsg 消息中携带的附加信息
+     */
+    notificationExtra?: string;
+    /**
+     * 用户退出聊天室时是否清除此属性
+     */
+    isAutoDelete?: boolean;
+}
+interface IChatroomUser {
+    /**
+     * 用户 id
+     */
+    id: string;
+    /**
+     * 加入聊天室的时间
+     */
+    time: number;
+}
+interface IChatroomInfo {
+    /**
+     * 成员列表
+     * @todo 需确认数组元素的数据结构
+     */
+    userInfos: IChatroomUser[];
+    /**
+     * 房间内总人数
+     */
+    userCount: number;
+}
+interface IRemoveChatRoomEntryOption {
+    /**
+     * 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
+     */
+    key: string;
+    /**
+     * 删除成功后是否发送通知消息
+     */
+    isSendNotification?: boolean;
+    /**
+     * RC:chrmKVNotiMsg 消息中携带的附加信息
+     */
+    notificationExtra?: string;
+}
+interface IChatroomEntries {
+    /**
+     * entries ,要设置的属性列表
+     * key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
+     * value 属性对应的值, 最大长度 4096 字符
+     */
+    entries: {
+        key: string;
+        value: string;
+    }[];
+    /**
+     * 设置成功后是否发送通知消息
+     */
+    /**
+     * RC:chrmKVNotiMsg 消息中携带的附加信息
+     */
+    notificationExtra?: string;
+    /**
+     * 用户退出聊天室时是否清除此属性
+     */
+    isAutoDelete?: boolean;
+}
+
+interface IUploadAuth {
+    /**
+     * 七牛 token 有效期
+    */
+    deadline: number;
+    /**
+     * 七牛上传 token
+    */
+    token: string;
+    /**
+     * 百度上传 token
+    */
+    bosToken: string;
+    /**
+     * 百度上传 header Date
+    */
+    bosDate: string;
+    /**
+     * 百度上传路径
+    */
+    path: string;
+    /**
+     * 上传文件名，阿里上传获取下载地址时，必须使用上传文件名，所以需抛出到业务端
+     */
+    fileName: string;
+    /**
+     * 阿里云 oss 的 AccessKeyId
+     */
+    osskeyId: string;
+    /**
+     * 阿里云 oss post 请求表单域中的字段 policy
      */
     ossPolicy: string;
     /**
@@ -2166,6 +2442,15 @@ interface IExpansionListenerData {
     deletedExpansion?: IDeletedExpansion;
 }
 
+interface IRTCRoomInfo {
+    roomId: string;
+    roomData: unknown[];
+    userCount: number;
+    list: unknown[];
+}
+interface IRtcTokenData {
+    rtcToken: string;
+}
 interface IRTCUsers {
     users: {
         [userId: string]: {
@@ -2176,29 +2461,12 @@ interface IRTCUsers {
         };
     };
 }
-
-interface IRtcTokenData {
-    rtcToken: string;
-}
-
-interface KVString {
-    [key: string]: string;
-}
-
-interface IRTCRoomInfo {
-    roomId: string;
-    roomData: unknown[];
-    userCount: number;
-    list: unknown[];
-}
-
 interface IJoinRTCRoomData extends IRTCUsers {
     token: string;
     sessionId: string;
-    roomInfo: {
-        key: string;
-        value: string;
-    }[];
+}
+interface KVString {
+    [key: string]: string;
 }
 
 /**
@@ -2250,249 +2518,211 @@ declare enum UploadMethod {
     STC = 4
 }
 
-interface IRecallMsgOptions {
-    /**
-     * 会话组织机构标识
-     * 默认值未 空字符串
-    */
-    channelId: string;
-    /**
-     * 发送消息携带的用户信息
-    */
-    user?: IUserProfile;
+/**
+ * 导航信息数据就结构
+ */
+interface INaviInfo {
     /**
-     * Push 信息
-    */
-    pushContent?: string;
+     * Navi 数据请求响应码，200 为成功请求
+     */
+    code: number;
     /**
-     * 原消息体
-    */
-    oriContent?: any;
+     * 获取 Navi 数据失败时的提示信息
+     */
+    errorMessage?: string;
     /**
-     * 是否发送静默消息
-     * @description
-     * 当值为 `true` 时，服务器将不会发送 Push 信息，移动端也不会弹出本地通知提醒
-    */
-    disableNotification?: boolean;
+     * 获取 Navi 数据失败时的请求 url 信息
+     */
+    url?: string;
     /**
-     * 移动端推送配置
-    */
-    pushConfig?: IPushConfig;
-}
-
-interface IInsertMsgOptions {
-    senderUserId: string;
-    messageType: string;
-    content: string;
-    messageDirection: number;
-    readStatus?: number;
-    sentStatus?: number;
-    sentTime?: number;
-    searchContent?: string;
-    isUnread?: boolean;
-    messageUId?: string;
-    disableNotification?: boolean;
-    canIncludeExpansion?: boolean;
-    expansionMsg?: string;
-    channelId: string;
-}
-
-interface IChatroomEntry {
+     * 请求导航数据时使用的协议：http / https
+     * @description 该字段为 SDK 内增加的字段，导航接口数据中不存在
+     */
+    protocol: 'http' | 'https';
     /**
-     * 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
+     * 获取导航时使用的 userId，小程序不走导航，故拿不到 userId
      */
-    key: string;
+    userId?: string;
     /**
-     * 属性对应的值, 最大长度 4096 字符
+     * CMP 服务 Websocket 连接地址，包含域名与端口，不含 ws 或 wss 协议头
+     * @example a.domain.com:443
      */
-    value: string;
+    server: string;
     /**
-     * 设置成功后是否发送通知消息
+     * 备用 CMP 服务地址，包含域名与端口，不含 ws 或 wss 协议头，多个备用地址以 ',' 分割
+     * @example a.domain.com:443,b.domain.com:443
      */
-    isSendNotification?: boolean;
+    backupServer?: string;
     /**
-     * RC:chrmKVNotiMsg 消息中携带的附加信息
+     * 备用 CMP 服务地址，POST 请求 TCP 连接返回的是 bs 字段，非 backupServer 字段
      */
-    notificationExtra?: string;
+    bs?: string;
     /**
-     * 用户退出聊天室时是否清除此属性
+     * RTC 服务配置，其值可能为 null、无效字符串、有效 JSON 字符串
+     * 1. 公有云未开通音视频时，值为 null
+     * 2. 私有云无配置时为 `{ "strategy": 0 }`
      */
-    isAutoDelete?: boolean;
-}
-
-interface IRemoveChatRoomEntryOption {
+    voipCallInfo: string | null;
     /**
-     * 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
+     * 聊天室 kv 存储开关
+     * @todo 需确认详细有效值
+     * @description 公有云独有配置
      */
-    key: string;
+    kvStorage: number;
     /**
-     * 删除成功后是否发送通知消息
+     * HttpDNS 功能开关，在 web 端无效
+     * @description 公有云独有配置
      */
-    isSendNotification?: boolean;
+    openHttpDNS: boolean;
     /**
-     * RC:chrmKVNotiMsg 消息中携带的附加信息
+     * 历史消息云存储功能开关
+     * @description
+     * 1. 公有云通过 `developer.rongcloud.cn` 管理后台 `单群聊消息云端存储` 功能开关进行配置
+     * 2. 私有云默认为 `true`
      */
-    notificationExtra?: string;
-}
-
-interface IChatroomEntryListenerData {
+    historyMsg: boolean;
     /**
-     * 更新的键
-    */
-    key: string;
+     * 聊天室历史消息开关
+     * @description
+     * 1. 私有云对聊天室功能支持有限，默认为 `false`
+     * 2. TODO: 公有云配置待确认
+     */
+    chatroomMsg: boolean;
     /**
-     * 更新的值
-    */
-    value: string;
+     * 文件服务器地址
+     * @description
+     * 1. 公有云下，该地址为七牛云服务器地址
+     * 2. 私有云下，该地址为私有云自研文件服务器地址
+     */
+    uploadServer: string;
     /**
-     * 更新的时间
-    */
-    timestamp: number;
+     * 实时位置共享配置，web 端无需处理
+     */
+    location: null | string;
     /**
-     * 更新的聊天室 ID
-    */
-    chatroomId: string;
+     * 实时日志上传开关
+     * @todo 需确认有效值及作用
+     */
+    monitor: number;
     /**
-     * 更新类型
-    */
-    type: ChatroomEntryType;
-}
-interface IChatroomRejoinedFailed {
+     * 是否允许加入多聊天室开关
+     */
+    joinMChrm: boolean;
     /**
-     * 自动重新加入的聊天室 ID
-    */
-    chatroomId: string;
+     * 是否开启公众号功能：`0` 为未开启，`1` 为已开启
+     */
+    openMp: 0 | 1;
     /**
-     * 自动重新加入失败的 code
-    */
-    errorCode: number;
-}
-interface IChatroomRejoinedSuccessed {
+     * 是否开启用户级配置，若开启，需连接成功后立即拉取实时配置，0 | 1
+     * @description
+     * 配置来源:
+     * 1. 导航
+     * 2. 服务端实时下发
+     * 已有配置字段:
+     * 1. Lan. 推送使用的语言设置，用户端可自定义修改. Web 端未做设置, 只做接收
+     * 2. ShPushSwit. 推送是否显示详情设置，用户端可自定义修改. Web 端未做设置, 只做接收
+     * 3. MobPushSwit: Web/PC 在线，移动端不在线是否发送推送开关，用户端可自定义修改. Web 端未做设置, 只做接收
+     * 4. OffMsgDur: 离线消息保存天数，设置天数不可大于App级对应配置，用户端可自定义修改. Web 端未做设置, 只做接收
+     * 5. VoipInfo: 音视频相关配置，用户端不可自定义修改. 由服务端决定，与导航下发格式一致
+     * @todo 需确认公有云与私有云区别
+     */
+    openUS: 0 | 1;
     /**
-     * 自动重新加入的聊天室 ID
-    */
-    chatroomId: string;
+     * 群离线消息最大下发条数，`0` 为关闭
+     * @description 公有云独有配合
+     */
+    grpMsgLimit: number;
     /**
-     * 自动重新加入的聊天室拉取消息的数量
-    */
-    count: number;
-}
-declare type IChatroomRejoinedInfo = IChatroomRejoinedFailed | IChatroomRejoinedSuccessed;
-/**
- * 聊天室信息
-*/
-interface IChatroomListenerData {
+     * 消息加密开关，0 为关闭
+     * @todo
+     * 1. 确定其控制的功能
+     * 2. 确定 web 相关性
+     */
+    isFormatted: number;
     /**
-     * SDK 内部重连聊天室信息
-    */
-    rejoinedRoom?: IChatroomRejoinedInfo;
+     * GIF 动图大小限制，默认 2048 KB
+     */
+    gifSize: number;
     /**
-     * 监听到的聊天室 KV 更新
-    */
-    updatedEntries?: IChatroomEntryListenerData[];
-}
-
-interface IUpdatedConversation {
-    updatedItems: {
-        [key: string]: {
-            time: number;
-            val: any;
-        };
-    };
-    conversationType: number;
-    targetId: string;
-    latestMessage?: IReceivedMessage;
-    unreadMessageCount?: number;
-    hasMentioned?: boolean;
-    mentionedInfo?: {
-        /**
-         * `@ 类型，其中 1 为 @ 所有人，2 为 @ 部分人`
-         */
-        type: 1 | 2;
-        /**
-         * 被 @ 的用户 Id 列表，仅在 `type` 为 `2` 时有效
-         */
-        userIdList: string[];
-    };
-    lastUnreadTime?: number;
-    notificationStatus?: number;
-    isTop?: boolean;
+     * 上传小视频时长限制，单位：秒
+     * @description 公有云字段，即私有云配置中的 `uploadVideoTimeLimit`
+     */
+    videoTimes?: number;
     /**
-     * 会话标识
-    */
-    channelId?: string;
-    tags?: IUpdatedConversation[];
-}
-
-declare class PluginContext {
-    protected readonly _context: APIContext;
-    constructor(_context: APIContext);
+     * 上传小视频时长限制，单位：秒
+     * @description 私有云字段，即公有云配置中的 `videoTimes`
+     */
+    uploadVideoTimeLimit?: number;
     /**
-     * 接收 IM 服务推送的消息，并通过返回 boolean 值决定此消息是否拦截
-     * @param message
-     * @returns 当返回值为 true，接收的消息将终止继续传递
+     * 实时日志上传开关：`0` 为关闭，`1` 为开启
      */
-    onmessage?(message: IReceivedMessage): boolean;
+    logSwitch: number;
     /**
-     * 用户主动断开连接的事件通知
+     * 实时日志上传策略
+     * @example `'{ "url": "logcollection.ronghub.com", "level": 1,"itv": 6, "times": 5 }'`
      */
-    ondisconnect?(): void;
+    logPolicy: string;
     /**
-     * 接收 IM 连接状态变更通知
-     * @param status
+     * 百度 BOS 存储服务地址
+     * @description 公有云独有配置
+     * @example `gz.bcebos.com`
      */
-    onconnectionstatechange?(status: ConnectionStatus): void;
+    bosAddr?: string;
     /**
-     * IM 客户端销毁通知
+     * 阿里上传配置，字符串数组，数组顺序代表 七牛、百度、阿里云 上传权重
+     * @example "[{"qiniu":"upload.qiniup.com","p":"1"},{"baidu":"gz.bcebos.com","p":"2"},{"aliyun":"oss-cn-beijing.aliyuncs.com","p":"3"}]"
      */
-    ondestroy?(): void;
+    ossConfig?: string;
     /**
-     * RTC 数据通知
-     * @param roomdId 数据对应的房间 Id
-     * @param data 通知数据为 key:value 方式
-     * @description
-     * 目前仅通知：主播加入、退出房间的人员列表变更，发布、取消发布资源列表变更
-    */
-    onrtcdatachange?(data: IServerRTCRoomEntry[], roomdId?: string): void;
+     * 私有云专有属性，可用来判断当前环境是公有云还是私有云，私有云环境下该值为 `1`
+     */
+    type?: number;
     /**
-     * 获取 `@rongcloud/engine` 包版本
+     * @deprecated 已废弃
      */
-    getCoreVersion(): string;
+    compDays: number;
     /**
-     * 获取当前运行中的 IMLib 版本号
+     * @deprecated 已废弃
      */
-    getAPIVersion(): string;
+    msgAck: unknown;
     /**
-     * 获取当前应用的 appkey
+     * @deprecated 已废弃
      */
-    getAppkey(): string;
+    activeServer: string;
     /**
-     * 获取当前已连接用户的 userId
-     * 用户连接建立之前及 disconnect 之后，该方法返回 '' 值
+     * @deprecated 已废弃
      */
-    getCurrentId(): string;
+    qnAddr: string;
     /**
-     * 获取当前连接状态
+     * @deprecated 已废弃
      */
-    getConnectionStatus(): ConnectionStatus;
-    getDeviceId(): string;
+    extkitSwitch: number;
     /**
-     * 发送消息
+     * @deprecated 已废弃
      */
-    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions): IPromiseResult<IReceivedMessage>;
+    alone: boolean;
     /**
-     * 消息注册
-     * @description 消息注册需在应用初始化完成前进行
-     * @param objectName 消息类型，如：RC:TxtMsg
-     * @param isPersited 是否存储
-     * @param isCounted 是否技术
-     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     * @deprecated 已废弃
      */
-    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[]): void;
+    voipServer: string;
     /**
-     * 获取服务时间
+     * 离线日志上报地址
+     * @deprecated 已废弃
      */
-    getServerTime(): number;
+    offlinelogserver: string;
+    /**
+     * 在线日志上报地址
+     * @deprecated 已废弃
+     */
+    onlinelogserver?: string;
+    /**
+     * 链路加密字段，内容为 JSON 字符串，仅限 C++ 可用
+     */
+    crypto?: string;
+    /**
+     * 群组回执开关, 1: 打开，0(或者没有): 关闭
+     */
+    grpRRVer?: number;
 }
 
 declare enum ReceivedStatus {
@@ -2667,12 +2897,24 @@ declare enum MessageType {
     /**
      * 接受群已读回执更新消息(导航开关grpRRVer为1时使用)
      */
-    GROUP_READ_RECEIPT_REQUEST = "RC:RRMsg"
-}
-
-/**
- * 群组 @ 类型
-*/
+    GROUP_READ_RECEIPT_REQUEST = "RC:RRMsg",
+    /**
+     * 用户加入聊天室
+     */
+    CHATROOM_JOIN = "RC:ChrmJoinNtf",
+    /**
+     * 用户退出聊天室
+     */
+    CHATROOM_LEFT = "RC:ChrmQuitNtf",
+    /**
+     * 用户加入退出聊天室的集合
+     */
+    CHATROOM_MERGE_CHANGE = "RC:ChrmMemChange"
+}
+
+/**
+ * 群组 @ 类型
+*/
 declare enum MentionedType {
     /**
      * 所有人
@@ -2727,1357 +2969,1162 @@ declare enum LogType {
 }
 
 /**
- * 导航信息数据就结构
+ * 拓展方法定义，便于 electron-solution 实现时保持接口类型推导可用
  */
-interface INaviInfo {
+interface IExtraMethod {
+    getConversationsByPage(conversationTypes: ConversationType[], sentTime: number, count: number, channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
+    getHistoryMessagesByObjectNames(conversationType: ConversationType, targetId: string, sentTime: number, count: number, objectNames: string[], desc: 0 | 1, tag: string): Promise<IAsyncRes<{
+        list: IReceivedMessage[];
+        hasMore: boolean;
+    }>>;
+    updateMessageReceiptStatus(conersationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<boolean>>;
+}
+
+/**
+ * engine 基本接口定义，用于约束 Electron 下主进程、渲染进程、JSEngine 的编码一致性
+ */
+interface IEngine {
     /**
-     * Navi 数据请求响应码，200 为成功请求
+     * 建立连接
+     * @param token
+     * @param naviInfo
      */
-    code: number;
+    connect(token: string, naviInfo: INaviInfo, versionInfo: string): Promise<ErrorCode>;
     /**
-     * 获取 Navi 数据失败时的提示信息
+     * 上报版本信息
+     * @param version
      */
-    errorMessage?: string;
+    reportSDKInfo(version: {
+        [name: string]: string;
+    }): void;
     /**
-     * 获取 Navi 数据失败时的请求 url 信息
+     * 连接时间
      */
-    url?: string;
+    getConnectedTime(): number;
     /**
-     * 请求导航数据时使用的协议：http / https
-     * @description 该字段为 SDK 内增加的字段，导航接口数据中不存在
+     * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
+     * 对于未实现的方法，接口响应 Unsupport 错误码
+     * @param method
+     * @param args
      */
-    protocol: 'http' | 'https';
+    callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
     /**
-     * 获取导航时使用的 userId，小程序不走导航，故拿不到 userId
+     * 获取历史消息
+     * @param conversationType
+     * @param targetId
+     * @param timestamp
+     * @param count
+     * @param order
      */
-    userId?: string;
+    getHistoryMessage(conversationType: ConversationType, targetId: string, 
     /**
-     * CMP 服务 Websocket 连接地址，包含域名与端口，不含 ws 或 wss 协议头
-     * @example a.domain.com:443
+     * 拉取时间戳，值为 `0` 表示从当前时间拉取
      */
-    server: string;
+    timestamp: number, 
     /**
-     * 备用 CMP 服务地址，包含域名与端口，不含 ws 或 wss 协议头，多个备用地址以 ',' 分割
-     * @example a.domain.com:443,b.domain.com:443
+     * 获取条数, 有效值 `1` - `20`
      */
-    backupServer?: string;
+    count: number, 
     /**
-     * 备用 CMP 服务地址，POST 请求 TCP 连接返回的是 bs 字段，非 backupServer 字段
+     * @description
+     * 1. `0` 表示升序，获取消息发送时间比传入 `sentTime` 小 的消息
+     * 2. `1` 表示降序，获取消息发送时间比传入 `sentTime` 大 的消息
      */
-    bs?: string;
+    order: 0 | 1, 
     /**
-     * RTC 服务配置，其值可能为 null、无效字符串、有效 JSON 字符串
-     * 1. 公有云未开通音视频时，值为 null
-     * 2. 私有云无配置时为 `{ "strategy": 0 }`
-     */
-    voipCallInfo: string | null;
+     * 会话的业务标识
+    */
+    channelId: string, 
     /**
-     * 聊天室 kv 存储开关
-     * @todo 需确认详细有效值
-     * @description 公有云独有配置
+     * 消息类型
      */
-    kvStorage: number;
+    objectName: string): IPromiseResult<{
+        list: IReceivedMessage[];
+        hasMore: boolean;
+    }>;
     /**
-     * HttpDNS 功能开关，在 web 端无效
-     * @description 公有云独有配置
-     */
-    openHttpDNS: boolean;
+     * 删除历史消息 通过 messageUId
+    */
+    deleteRemoteMessage(conversationType: ConversationType, targetId: string, 
     /**
-     * 历史消息云存储功能开关
      * @description
-     * 1. 公有云通过 `developer.rongcloud.cn` 管理后台 `单群聊消息云端存储` 功能开关进行配置
-     * 2. 私有云默认为 `true`
-     */
-    historyMsg: boolean;
+     * message 中 messageUId、setTime、messageDirection 为必须参数
+    */
+    messages: {
+        messageUId: string;
+        sentTime: number;
+        messageDirection: MessageDirection;
+    }[], 
     /**
-     * 聊天室历史消息开关
-     * @description
-     * 1. 私有云对聊天室功能支持有限，默认为 `false`
-     * 2. TODO: 公有云配置待确认
-     */
-    chatroomMsg: boolean;
+     * 会话的业务标识
+    */
+    channelId: string): Promise<ErrorCode>;
+    recallMsg(conversationType: ConversationType, targetId: string, messageUId: string, sentTime: number, recallMsgOptions: IRecallMsgOptions): IPromiseResult<IReceivedMessage>;
     /**
-     * 文件服务器地址
-     * @description
-     * 1. 公有云下，该地址为七牛云服务器地址
-     * 2. 私有云下，该地址为私有云自研文件服务器地址
-     */
-    uploadServer: string;
+     * 删除历史消息 通过 时间戳
+     * @param timestamp 小于等于传入时间戳的消息均删除
+    */
+    deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, 
     /**
-     * 实时位置共享配置，web 端无需处理
-     */
-    location: null | string;
+     * 会话的业务标识
+    */
+    channelId: string): Promise<ErrorCode>;
     /**
-     * 实时日志上传开关
-     * @todo 需确认有效值及作用
+     * 获取会话列表
+     * @param count 指定获取数量, 不传则获取全部会话列表，默认 `300`
      */
-    monitor: number;
+    getConversationList(
     /**
-     * 是否允许加入多聊天室开关
+     * 拉取数量, 有效值 0 - 1000, 默认 300
      */
-    joinMChrm: boolean;
+    count: number, 
     /**
-     * 是否开启公众号功能：`0` 为未开启，`1` 为已开启
+     * 会话类型
+     * @todo 待确认是否生效
      */
-    openMp: 0 | 1;
+    conversationType?: ConversationType, 
     /**
-     * 是否开启用户级配置，若开启，需连接成功后立即拉取实时配置，0 | 1
-     * @description
-     * 配置来源:
-     * 1. 导航
-     * 2. 服务端实时下发
-     * 已有配置字段:
-     * 1. Lan. 推送使用的语言设置，用户端可自定义修改. Web 端未做设置, 只做接收
-     * 2. ShPushSwit. 推送是否显示详情设置，用户端可自定义修改. Web 端未做设置, 只做接收
-     * 3. MobPushSwit: Web/PC 在线，移动端不在线是否发送推送开关，用户端可自定义修改. Web 端未做设置, 只做接收
-     * 4. OffMsgDur: 离线消息保存天数，设置天数不可大于App级对应配置，用户端可自定义修改. Web 端未做设置, 只做接收
-     * 5. VoipInfo: 音视频相关配置，用户端不可自定义修改. 由服务端决定，与导航下发格式一致
-     * @todo 需确认公有云与私有云区别
-     */
-    openUS: 0 | 1;
+     * 起始时间
+    */
+    startTime?: number, 
     /**
-     * 群离线消息最大下发条数，`0` 为关闭
-     * @description 公有云独有配合
-     */
-    grpMsgLimit: number;
+     * 获取顺序
+    */
+    order?: 0 | 1, 
     /**
-     * 消息加密开关，0 为关闭
-     * @todo
-     * 1. 确定其控制的功能
-     * 2. 确定 web 相关性
-     */
-    isFormatted: number;
+     * 会话的业务标识
+    */
+    channelId?: string): IPromiseResult<IReceivedConversation[]>;
     /**
-     * GIF 动图大小限制，默认 2048 KB
-     */
-    gifSize: number;
+     * 获取指定会话
+    */
+    getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
     /**
-     * 上传小视频时长限制，单位：秒
-     * @description 公有云字段，即私有云配置中的 `uploadVideoTimeLimit`
+     * 删除会话
+     * @description 该删除操作会删除服务器端存储的会话数据
+     * @param conversationType
+     * @param targetId
      */
-    videoTimes?: number;
+    removeConversation(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
     /**
-     * 上传小视频时长限制，单位：秒
-     * @description 私有云字段，即公有云配置中的 `videoTimes`
+     * 获取所有会话未读数
+     * @param channelId 多组织 Id
+     * @param conversationTypes
+     * @param includeMuted 包含已设置免打扰的会话
      */
-    uploadVideoTimeLimit?: number;
+    getAllConversationUnreadCount(channelId: string, conversationTypes: ConversationType[], includeMuted: boolean): IPromiseResult<number>;
     /**
-     * 实时日志上传开关：`0` 为关闭，`1` 为开启
+     * 获取指定会话未读数
      */
-    logSwitch: number;
+    getConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<number>;
     /**
-     * 实时日志上传策略
-     * @example `'{ "url": "logcollection.ronghub.com", "level": 1,"itv": 6, "times": 5 }'`
+     * 清除指定会话未读数
      */
-    logPolicy: string;
+    clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
     /**
-     * 百度 BOS 存储服务地址
-     * @description 公有云独有配置
-     * @example `gz.bcebos.com`
+     * 获取第一个未读消息
      */
-    bosAddr?: string;
+    getFirstUnreadMessage(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedMessage | null>;
     /**
-     * 阿里上传配置，字符串数组，数组顺序代表 七牛、百度、阿里云 上传权重
-     * @example "[{"qiniu":"upload.qiniup.com","p":"1"},{"baidu":"gz.bcebos.com","p":"2"},{"aliyun":"oss-cn-beijing.aliyuncs.com","p":"3"}]"
+     * 设置/保存指定会话消息草稿
+     * @draft 草稿内容
      */
-    ossConfig?: string;
+    saveConversationMessageDraft(conversationType: ConversationType, targetId: string, draft: string): Promise<ErrorCode>;
     /**
-     * 私有云专有属性，可用来判断当前环境是公有云还是私有云，私有云环境下该值为 `1`
+     * 获取指定会话消息草稿
      */
-    type?: number;
+    getConversationMessageDraft(conversationType: ConversationType, targetId: string): IPromiseResult<string>;
     /**
-     * @deprecated 已废弃
+     * 清除指定会话消息草稿
      */
-    compDays: number;
+    clearConversationMessageDraft(conversationType: ConversationType, targetId: string): Promise<ErrorCode>;
     /**
-     * @deprecated 已废弃
+     * 从服务端拉取会话状态
      */
-    msgAck: unknown;
+    pullConversationStatus(timestamp: number): Promise<IAsyncRes<IServerConversationStatus[]>>;
     /**
-     * @deprecated 已废弃
+     * 批量设置会话 置顶、免打扰
      */
-    activeServer: string;
+    batchSetConversationStatus(statusList: ISetConversationStatusOptions[]): Promise<ErrorCode>;
+    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void): IPromiseResult<IReceivedMessage>;
     /**
-     * @deprecated 已废弃
+     * 断开连接
      */
-    qnAddr: string;
+    disconnect(): void;
     /**
-     * @deprecated 已废弃
+     * 拉取用户级配置数据
      */
-    extkitSwitch: number;
+    pullUserSettings(version: number): IPromiseResult<IServerUserSetting>;
     /**
-     * @deprecated 已废弃
+     * 消息注册
+     * @description
+     * 消息注册需在应用初始化完成前进行，否则在搭配 C++ 协议栈使用时，
+     * 本端发出的消息将不默认作为未知消息处理，不存储、不计数
+     * @param objectName 消息类型，如：RC:TxtMsg
+     * @param isPersited 是否存储
+     * @param isCounted 是否技术
+     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
      */
-    alone: boolean;
+    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[]): void;
     /**
-     * @deprecated 已废弃
-     */
-    voipServer: string;
+     * 加入聊天室
+     * @param count 拉取消息数量
+    */
+    joinChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
     /**
-     * 离线日志上报地址
-     * @deprecated 已废弃
-     */
-    offlinelogserver: string;
+     * 加入已存在的聊天室
+     * @param count 拉取消息数量
+    */
+    joinExistChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
     /**
-     * 在线日志上报地址
-     * @deprecated 已废弃
-     */
-    onlinelogserver?: string;
+     * 退出聊天室
+    */
+    quitChatroom(chatroomId: string): Promise<ErrorCode>;
     /**
-     * 链路加密字段，内容为 JSON 字符串，仅限 C++ 可用
-     */
-    crypto?: string;
+     * 获取聊天室信息
+     * @param count 获取人数, 范围 0 - 20
+     * @param order 排序方式, 1 正序, 2 倒序
+    */
+    getChatroomInfo(chatroomId: string, count: number, order: number): IPromiseResult<IChatroomInfo>;
     /**
-     * 群组回执开关, 1: 打开，0(或者没有): 关闭
-     */
-    grpRRVer?: number;
-}
-
-/**
- * 拓展方法定义，便于 electron-solution 实现时保持接口类型推导可用
- */
-interface IExtraMethod {
-    getConversationsByPage(conversationTypes: ConversationType[], sentTime: number, count: number, channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
-    getHistoryMessagesByObjectNames(conversationType: ConversationType, targetId: string, sentTime: number, count: number, objectNames: string[], desc: 0 | 1, tag: string): Promise<IAsyncRes<{
+     * 获取聊天室历史消息
+    */
+    getChatroomHistoryMessages(chatroomId: string, timestamp: number, count: number, order: number): IPromiseResult<{
         list: IReceivedMessage[];
         hasMore: boolean;
-    }>>;
-    updateMessageReceiptStatus(conersationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<boolean>>;
-}
-
-/**
- * typing相关接口
- */
-
-/**
- * typing信息
- */
-interface ITypingUser {
-    userId: string;
-    timestamp: number;
-    messageType: string;
-}
-/**
- * 内存存储typing，key为conversationType_targetId
- */
-interface ITypingInfo {
-    [key: string]: Array<ITypingUser>;
-}
-/**
- * typing通知消息接口
- */
-interface ITypingMessage {
-    targetId: string;
-    conversationType: ConversationType;
-    channelId?: string;
-    list: Array<ITypingUser>;
-}
-
-interface IConnectResult {
+    }>;
     /**
-     * 连接错误码
-     */
-    code: ErrorCode;
+     * 设置聊天室属性
+    */
+    setChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
     /**
-     * 导航获取成功后即可有相应的值，在导航数据获取完成之前该值为 undefined
+     * 批量设置聊天室属性
      */
-    userId?: string;
-}
-declare type IMessageListnenr = (message: IReceivedMessage, leftCount?: number, hasMore?: boolean) => void;
-declare type IConnectionStatusListener = (status: ConnectionStatus) => void;
-declare type IConversationStateListener = (conversation: IUpdatedConversation[]) => void;
-declare type IChatroomListener = (state: IChatroomListenerData) => void;
-declare type IRTCInnerListener = {
-    message?: IMessageListnenr;
-    status?: IConnectionStatusListener;
-};
-declare type IExpansionListener = (data: IExpansionListenerData) => void;
-declare type ITagListener = () => void;
-declare type IConversationTagListener = () => void;
-declare type ItypingStateListener = (data: ITypingMessage[]) => void;
-interface ISendExMsgOptions {
-    channelId: string;
-    conversationType: ConversationType;
-    targetId: string;
+    setChatroomEntries(chatroomId: string, entry: IChrmKVEntries): Promise<ErrorCode>;
     /**
-     * 消息 ID
+     * 强制设置聊天室属性
     */
-    messageUId: string;
+    forceSetChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
     /**
-     * 原始消息是否支持扩展的字段
+     * 删除聊天室属性
     */
-    canIncludeExpansion: boolean;
+    removeChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
     /**
-     * 删除的 keys
+     * 批量删除聊天室属性
+     */
+    removeChatroomEntries(chatroomId: string, entries: IChrmKVEntries): Promise<ErrorCode>;
+    /**
+     * 强制删除聊天室属性
     */
-    keys?: string[];
+    forceRemoveChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
     /**
-     * 扩展对象
+      * 获取聊天室 key 对应 value
     */
-    expansion?: {
+    getChatroomEntry(chatroomId: string, key: string): IPromiseResult<string | null>;
+    /**
+      * 获取聊天室所有 key value
+    */
+    getAllChatroomEntry(chatroomId: string): IPromiseResult<{
         [key: string]: string;
-    };
+    }>;
     /**
-     * 是否删除所有扩展
+     * 获取上传认证信息
+     * @description
+     * 若不传 fileName 百度上传认证字段（bosToken、bosDate、path）均返回 null
     */
-    removeAll?: boolean;
+    getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string): Promise<IAsyncRes<IUploadAuth>>;
     /**
-     * 原始消息的扩展
+     * 获取文件上传后下载地址
     */
-    originExpansion?: {
-        [key: string]: string;
-    } | null;
-}
-interface IWatcher {
-    message?: IMessageListnenr;
-    connectionState?: IConnectionStatusListener;
-    conversationState?: IConversationStateListener;
-    chatroomState?: IChatroomListener;
-    expansion?: IExpansionListener;
+    getFileUrl(fileType: FileType, uploadMethod: UploadMethod, fileName?: string, originName?: string): IPromiseResult<{
+        downloadUrl: string;
+    }>;
     /**
-     * 为兼容老版本 RTCLib 与 CallLib 接收消息的方式，新版本消息走插件机制
-     */
-    rtcInnerWatcher?: IRTCInnerListener;
+     * 创建标签
+     * @param tag 标签
+    */
+    createTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
     /**
-     * 标签的增删改监听
+     * 删除标签
+     * @param tagId 标签id
+    */
+    removeTag(tagId: string): IPromiseResult<IAsyncRes>;
+    /**
+     * 编辑标签
+     * @param tag 标签
+    */
+    updateTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
+    /**
+     * 获取标签列表
      */
-    tag?: ITagListener;
+    getTagList(): IPromiseResult<Array<ITagInfo>>;
     /**
-     * 会话中标签状态变更监听
+     * 添加会话到标签（给多个会话增加标签）
+     * @param tagId 标签id
+     * @param conversations 要添加的会话列表
      */
-    conversationTagChanged?: IConversationTagListener;
+    addTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult<IAsyncRes>;
     /**
-     * 输入状态变更监听
+     * 删除标签中的会话(从多个会话中批量删除指定标签)
+     * @param tagId 标签id
+     * @param conversations 要删除的会话列表
      */
-    typingState?: ItypingStateListener;
+    removeTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult<IAsyncRes>;
     /**
-     * 是否拉取完毕添加通知
+     * 删除会话中的标签(从单一会话中批量删除标签)
+     * @param conversationType 会话类型
+     * @param targetId 会话id
+     * @param tagIds 要删除的标签列表
      */
-    pullFinished?: ITagListener;
-}
-interface IPluginGenerator<API, InitOption> {
+    removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): IPromiseResult<IAsyncRes>;
     /**
-     * 只读插件标识
+     * 获取标签下的会话列表
+     * @param tagId 标签id
      */
-    readonly tag: string;
+    getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): IPromiseResult<IReceivedConversationByTag[]>;
     /**
-     * 版本号
+     * 获取标签下的未读消息数
+     * @param tagId 标签id
+     * @param containMuted 是否包含免打扰会话
      */
-    readonly version?: string;
+    getUnreadCountByTag(tagId: string, containMuted: boolean): IPromiseResult<number>;
     /**
-     * 插件名称
+     * 设置标签中会话置顶
+     * @param conversation 会话
      */
-    readonly name?: string;
+    setConversationStatusInTag(tagId: string, conversation: IConversationOption, status: ITagStatus): IPromiseResult<IAsyncRes>;
     /**
-     * 插件安装前的环境检测，通过返回 boolean 值确认插件是否可运行
+     * 获取会话里的标签
+     * @param config
      */
-    verify(runtime: IRuntime): boolean;
+    getTagsForConversation(conversation: IConversationOption): IPromiseResult<IConversationTag[]>;
     /**
-     * 插件初始化
-     * @param context 插件调用上下文，用于实现插件的消息注册、消息首发等
-     * @param runtime 运行时实例，用于标识最终的运行时平台
-     * @param options 初始化参数
+     * 发送群组消息已读回执
+     * 导航下发已读回执开关为 true 时调用
      */
-    setup(context: PluginContext, runtime: IRuntime, options: InitOption): API;
-}
-interface IAPIContextOption {
+    sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
     /**
-     * 应用 appkey
+     * 获取群组消息已读列表
      */
-    appkey: string;
+    getMessageReader(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IMessageReaderResponse>;
     /**
-     * IMLib 版本号
+     * 获取服务器时间
      */
-    apiVersion: string;
+    getServerTime(): number;
     /**
-     * 自定义导航地址:
-     * 1. 私有云环境下该值为必填项
-     * 2. 当存在自定义导航地址时，SDK 内部默认地址将无效
-     * 3. 当存在自定义导航地址时，地址 url 中需包含 http/https 协议头，否则视为无效值
-     * 4. 建立 ws/wss 连接前的 ping 接口使用的协议与导航 url 中的协议相同
-     * 5. 建立 websocket 建立连接时将根据 ping 接口使用的 http/https 协议来确定使用 ws/wss 协议
-     * 6. 动态导航使用的协议头将与自定义导航地址相同
-     * 7. 公有云默认使用 https 协议
+     * 获取设备ID
      */
-    navigators: string[];
+    getDeviceId(): string;
     /**
-     * (参数已废弃)~~c++ 协议栈数据库地址~~
-     * @deprecated
+     * 设置用户在线状态监听器
     */
-    dbPath?: string;
+    setUserStatusListener(config: {
+        userIds: string[];
+    }, listener: Function): void;
     /**
-     * 小程序的 CMP 代理地址
-     */
-    miniCMPProxy: string[];
-    /**
-     * 指定默认使用的连接类型
-     */
-    connectionType: 'websocket' | 'comet';
-    /**
-     * 修改 engine log 打印等级
-     */
-    logLevel?: LogLevel;
-    /**
-     * 修改默认的 log 输出函数
-     */
-    logStdout?: (logLevel: LogLevel, content: string) => void;
-    /**
-     * （已废弃）私有云标识
-     * @deprecated
-     */
-    isEnterPrise?: boolean;
-    /**
-     * typing状态过期时间
-     */
-    typingExpireTime?: number;
-    /**
-     * 是否打开 IndexDB 存储，默认为 true
-     */
-    indexDBSwitch?: boolean;
-    /**
-     * 是否校验证书，默认为 true
-     */
-    checkCA?: boolean;
-}
-declare class APIContext {
-    private _runtime;
-    private static _context?;
-    static init(runtime: IRuntime, options: IAPIContextOption): APIContext;
-    static destroy(): void;
-    private _token;
-    /**
-     * 插件队列，用于逐一派发消息与信令
-     */
-    private _pluginContextQueue;
-    /**
-     * 插件实例Map，用于重复初始化时返回实例
-     */
-    private _pluginInstanseMap;
-    private readonly _engine;
-    /**
-     * 核心库版本号，后期与 4.0 IM SDK 版本号保持一致
-     */
-    readonly coreVersion: string;
-    readonly appkey: string;
-    readonly apiVersion: string;
-    private readonly _options;
-    private _versionInfo;
-    private _typingInfo;
-    /**
-     * 内部连接状态标识，为 ture 时不允许调用 reconnect 方法
-     */
-    private _isInternalConnected;
-    constructor(_runtime: IRuntime, options: IAPIContextOption);
-    /**
-     * 安装使用插件，并初始化插件实例
-     * @param plugin
-     * @param options
-     */
-    install<T, O>(plugin: IPluginGenerator<T, O>, options: O): T | null;
-    private _connectionStatus;
-    private _canRedirectConnect;
+     * 设置当前用户在线状态
+    */
+    setUserStatus(status: number): Promise<ErrorCode>;
     /**
-     * 重定向后，递归调用 connect
-     */
-    private _handleRedirect;
+     * 订阅用户在线状态
+    */
+    subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
     /**
-     * 连接状态变更回调
-     * @param message
-     */
-    private _connectionStatusListener;
-    private _messageReceiver;
+     * 获取用户状态
+    */
+    getUserStatus(userId: string): IPromiseResult<{
+        status: string;
+    }>;
     /**
-     * 聊天室相关信息监听
+     * 清空所有会话
     */
-    private _chatroomInfoListener;
+    clearConversations(conversationTypes?: ConversationType[], channelId?: string): Promise<ErrorCode>;
     /**
-     * 会话监听相关
+     * 加入黑名单
     */
-    private _conversationInfoListener;
+    addToBlacklist(userId: string): Promise<ErrorCode>;
     /**
-     * 消息扩展监听相关
+      * 将指定用户移除黑名单
     */
-    private _expansionInfoListener;
+    removeFromBlacklist(userId: string): Promise<ErrorCode>;
     /**
-     * 标签增删改监听
-     */
-    private _tagListener;
+      * 获取黑名单列表
+    */
+    getBlacklist(): IPromiseResult<string[]>;
     /**
-     * 会话标签状态监听
-     */
-    private _conversationTagListener;
-    private _typingStatusListener;
-    private _pullFinishedLister;
+      * 获取指定人员在黑名单中的状态
+    */
+    getBlacklistStatus(userId: string): IPromiseResult<string>;
     /**
-     * rtc 数据变更通知 pluginContext
-     */
-    private _rtcDataChange;
+     * 向本地插入一条消息，不发送到服务器
+    */
+    insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): IPromiseResult<IReceivedMessage>;
     /**
-     * 业务层事件监听器挂载点
-     */
-    private _watcher;
+     * 删除本地消息
+    */
+    deleteMessages(timestamps: number[]): Promise<ErrorCode>;
     /**
-     * 添加事件监听
-     * @param options
-     */
-    assignWatcher(watcher: IWatcher): void;
+     * 通过时间戳删除本地消息
+    */
+    deleteMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, channelId: string): Promise<ErrorCode>;
     /**
-     * 向内存中添加 typing 信息
-     * 添加 typing 时不触发通知，只有在轮询时间点校验 _typingChangedList 的长度大于 0 时才通知
-     */
-    private _addTypingInfo;
-    private _typingInternalTimer;
-    private _typingExpireTime;
-    private _typingChangedList;
+     * 清空会话下历史消息
+    */
+    clearMessages(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
     /**
-     * 启动定时移除typing
-     */
-    private _startCheckTypingInfo;
-    getConnectedTime(): number;
-    getServerTime(): number;
-    getDeviceId(): string;
-    getCurrentUserId(): string;
-    getConnectionStatus(): ConnectionStatus;
+     * 获取消息
+    */
+    getMessage(messageId: number): IPromiseResult<IReceivedMessage>;
     /**
-     * 建立连接，连接失败则抛出异常，连接成功后返回用户 userId，否则返回相应的错误码
-     * @param token
-     * @param refreshNavi 是否需要重新请求导航，当值为 `false` 时，优先使用有效缓存导航，若缓存失效则重新获取导航
-     */
-    connect(token: string, refreshNavi?: boolean): Promise<IConnectResult>;
+     * 设置消息内容
+    */
+    setMessageContent(messageId: number, content: any, messageType: string): Promise<ErrorCode>;
     /**
-     * 拉取实时配置 web 端需更新 voipCall 字段
-     */
-    private _pullUserSettings;
-    disconnect(): Promise<void>;
-    reconnect(): Promise<IConnectResult>;
-    private _getTokenWithoutNavi;
+     * 设置消息搜索字段
+    */
+    setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<ErrorCode>;
     /**
-     * 获取当前缓存的导航数据
-     */
-    getInfoFromCache(): INaviInfo | null;
+     * 通过关键字搜索会话
+    */
+    searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
     /**
-     * 消息注册
-     * @description 消息注册需在应用初始化完成前进行
-     * @param objectName 消息类型，如：RC:TxtMsg
-     * @param isPersited 是否存储
-     * @param isCounted 是否技术
-     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
-     */
-    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[]): void;
+     * 按内容搜索会话内的消息
+    */
+    searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, channelId: string): IPromiseResult<{
+        messages: IReceivedMessage[];
+        count: number;
+    }>;
     /**
-     * 发送消息
-     * @param conversationType
-     * @param targetId
-     * @param objectName
-     * @param content
-     * @param options
-     */
-    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void): Promise<IAsyncRes<IReceivedMessage>>;
+     * 获取会话下所有未读的 @ 消息
+    */
+    getUnreadMentionedMessages(conversationType: ConversationType, targetId: string, channelId: string): IReceivedMessage[];
     /**
-     * 发送扩展消息
-     * @param messageUId 消息 Id
-     * @param keys 需要删除的 key
-     * @param expansion 设置的扩展
+     * 设置消息发送状态
     */
-    sendExpansionMessage(options: ISendExMsgOptions): Promise<IAsyncRes<ErrorCode>>;
+    setMessageSentStatus(messageId: number, sentStatus: number): Promise<ErrorCode>;
     /**
-     * 发送群组消息已读回执
-     * 导航下发已读回执开关为 true 时调用
-     * @param targetId 群组会话id
-     * @param messageUIds 消息id
-     */
-    sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
+     * 设置消息接收状态
+    */
+    setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<ErrorCode>;
     /**
-     * 获取群组消息已读列表
-     * @param targetId
-     * @param messageUIds
-     */
-    getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<IMessageReaderResponse>>;
+     * 删除时间戳前的未读数
+    */
+    clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId: string): Promise<ErrorCode>;
     /**
-     * 反初始化，清空所有监听及计时器
-     */
-    private _destroy;
+     * 获取会话免打扰状态
+    */
+    getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationStatus>;
     /**
-     * @param conversationType
-     * @param targetId 会话 Id
-     * @param timestamp 拉取时间戳
-     * @param count 拉取条数
-     * @param order 1 正序拉取，0 为倒序拉取
-     * @param channelId
-     * @param objectName
-     */
-    getHistoryMessage(conversationType: ConversationType, targetId: string, timestamp?: number, count?: number, order?: 0 | 1, channelId?: string, objectName?: string): Promise<IAsyncRes<{
+     * 协议栈获取远端历史消息
+    */
+    getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, order: 0 | 1, channelId: string): IPromiseResult<{
         list: IReceivedMessage[];
         hasMore: boolean;
-    }>>;
-    /**
-     * 获取会话列表
-     * @param count 指定获取数量, 不传则获取全部会话列表，默认 `300`
-     */
-    getConversationList(count?: number, conversationType?: ConversationType, startTime?: number, order?: 0 | 1, channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
-    /**
-     * 获取单一会话数据
-     * @param conversationType
-     * @param targetId
-     * @param channelId
-     */
-    getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
-    /**
-     * 删除会话
-     */
-    removeConversation(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
-    /**
-     * 清除会话消息未读数
-     */
-    clearUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
+    }>;
+    joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number): IPromiseResult<IJoinRTCRoomData>;
+    quitRTCRoom(roomId: string): Promise<ErrorCode>;
+    rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
+    getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
+    getRTCUserInfoList(roomId: string): IPromiseResult<IRTCUsers>;
+    getRTCUserInfo(roomId: string): IPromiseResult<unknown>;
+    setRTCUserInfo(roomId: string, key: string, value: string): Promise<ErrorCode>;
+    removeRTCUserInfo(roomId: string, keys: string[]): Promise<ErrorCode>;
+    setRTCData(roomId: string, key: string, value: string, isInner: boolean, apiType: RTCApiType, message?: {
+        name: string;
+        content: string;
+    }): Promise<ErrorCode>;
     /**
-     * 获取指定会话消息未读数
+     * 全量订阅资源修改
+     * @param roomId 房间 Id
+     * @param message 向前兼容的消息内容
+     * @param valueInfo 全量资源数据
+     * @param objectName 全量 URI 消息名
      */
-    getUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<number>>;
+    setRTCTotalRes(roomId: string, message: {
+        name: string;
+        content: string;
+    }, valueInfo: string, objectName: string, mcuValInfo: string): Promise<ErrorCode>;
+    getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): IPromiseResult<KVString>;
+    removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, message?: {
+        name: string;
+        content: string;
+    }): Promise<ErrorCode>;
+    setRTCOutData(roomId: string, rtcData: unknown, type: number, message: unknown): Promise<ErrorCode>;
+    getRTCOutData(roomId: string, userIds: string[]): IPromiseResult<unknown>;
+    getRTCToken(roomId: string, mode: number, broadcastType?: number): IPromiseResult<IRtcTokenData>;
+    setRTCState(roomId: string, reportId: string): Promise<ErrorCode>;
+    getRTCUserList(roomId: string): IPromiseResult<IRTCUsers>;
+}
+
+interface IExpansionMsgContent {
     /**
-     * 获取所有会话未读数
-     * @param channelId 多组织 Id
-     * @param conversationTypes
-     * @param includeMuted 包含已设置免打扰的会话
-     */
-    getTotalUnreadCount(channelId: string, conversationTypes?: ConversationType[], includeMuted?: boolean): Promise<IAsyncRes<number>>;
+     * 消息扩展的对象
+    */
+    put?: {
+        [key: string]: string;
+    };
     /**
-     * 获取第一个未读消息
-     */
-    getFirstUnreadMessage(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<IReceivedMessage | null>>;
-    setConversationStatus(conversationType: ConversationType, targetId: string, isTop?: boolean, notificationStatus?: 1 | 2, channelId?: string): Promise<ErrorCode>;
-    saveConversationMessageDraft(conversationType: ConversationType, targetId: string, draft: string): Promise<ErrorCode>;
-    getConversationMessageDraft(conversationType: ConversationType, targetId: string): Promise<IAsyncRes<string>>;
-    clearConversationMessageDraft(conversationType: ConversationType, targetId: string): Promise<ErrorCode>;
-    recallMessage(conversationType: ConversationType, targetId: string, messageUId: string, sentTime: number, recallMsgOptions: IRecallMsgOptions): Promise<IAsyncRes<IReceivedMessage>>;
+     * 删除的 keys
+    */
+    del?: string[];
     /**
-     * 删除远端消息
-     * @param conversationType
-     * @param targetId
-     * @param list
-     */
-    deleteRemoteMessage(conversationType: ConversationType, targetId: string, list: {
-        messageUId: string;
-        sentTime: number;
-        messageDirection: MessageDirection;
-    }[], channelId?: string): Promise<ErrorCode>;
+     * messageUId
+    */
+    mid: string;
     /**
-     * 根据时间戳删除指定时间之前的
-     * @param conversationType
-     * @param targetId
-     * @param timestamp
-     */
-    deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
+     * 是否删除所有, 有效值：0、1 . ( 后续如有需要, API Layer 层可使用)
+    */
+    removeAll?: number;
+}
+
+/**
+ * typing相关接口
+ */
+
+/**
+ * typing信息
+ */
+interface ITypingUser {
+    userId: string;
+    timestamp: number;
+    messageType: string;
+}
+/**
+ * 内存存储typing，key为conversationType_targetId
+ */
+interface ITypingInfo {
+    [key: string]: Array<ITypingUser>;
+}
+/**
+ * typing通知消息接口
+ */
+interface ITypingMessage {
+    targetId: string;
+    conversationType: ConversationType;
+    channelId?: string;
+    list: Array<ITypingUser>;
+}
+
+interface IPluginGenerator<API, InitOption> {
     /**
-     * 加入聊天室，若聊天室不存在则创建聊天室
-     * @param roomId 聊天室房间 Id
-     * @param count 进入聊天室成功后，自动拉取的历史消息数量，默认值为 `10`，最大有效值为 `50`，`-1` 为不拉取
+     * 只读插件标识
      */
-    joinChatroom(roomId: string, count?: number): Promise<ErrorCode>;
+    readonly tag: string;
     /**
-     * 加入聊天室，若聊天室不存在则抛出异常
-     * @param roomId 聊天室房间 Id
-     * @param count 进入聊天室成功后，自动拉取的历史消息数量，默认值为 `10`，最大有效值为 `50`，`-1` 为不拉取
+     * 版本号
      */
-    joinExistChatroom(roomId: string, count?: number): Promise<ErrorCode>;
+    readonly version?: string;
     /**
-     * 退出聊天室
-     * @param roomId
+     * 插件名称
      */
-    quitChatroom(roomId: string): Promise<ErrorCode>;
+    readonly name?: string;
     /**
-     * 获取聊天室房间数据
-     * @description count 或 order 有一个为 0 时，只返回成员总数，不返回成员列表信息
-     * @param roomId 聊天室 Id
-     * @param count 获取房间人员列表数量，最大有效值 `20`，最小值未 `0`，默认为 0
-     * @param order 人员排序方式，`1` 为正序，`2` 为倒序，默认为 0
+     * 插件安装前的环境检测，通过返回 boolean 值确认插件是否可运行
      */
-    getChatroomInfo(roomId: string, count?: number, order?: 0 | 1 | 2): Promise<IAsyncRes<IChatroomInfo>>;
+    verify(runtime: IRuntime): boolean;
     /**
-     * 在指定聊天室中设置自定义属性
-     * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
-     * @param roomId 聊天室房间 id
-     * @param entry 属性信息
+     * 插件初始化
+     * @param context 插件调用上下文，用于实现插件的消息注册、消息首发等
+     * @param runtime 运行时实例，用于标识最终的运行时平台
+     * @param options 初始化参数
      */
-    setChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
+    setup(context: PluginContext, runtime: IRuntime, options: InitOption): API;
+}
+
+declare type IMessageListnenr = (message: IReceivedMessage, leftCount?: number, hasMore?: boolean) => void;
+declare type IMessagesListnenr = (messages: IReceivedMessage[], leftCount?: number, hasMore?: boolean) => void;
+declare type IConnectionStatusListener = (status: ConnectionStatus) => void;
+declare type IConversationStateListener = (conversation: IUpdatedConversation[]) => void;
+declare type IChatroomListener = (state: IChatroomListenerData) => void;
+declare type IRTCInnerListener = {
+    message?: IMessageListnenr;
+    status?: IConnectionStatusListener;
+};
+declare type IExpansionListener = (data: IExpansionListenerData) => void;
+declare type ITagListener = () => void;
+declare type IConversationTagListener = (conversationType: ConversationType, targetId: string, conversationTags: {
+    tags: ILocalTagStatus;
+}) => void;
+declare type ItypingStateListener = (data: ITypingMessage[]) => void;
+interface IWatcher {
+    message?: IMessageListnenr;
+    batchMessage?: IMessagesListnenr;
+    connectionState?: IConnectionStatusListener;
+    conversationState?: IConversationStateListener;
+    chatroomState?: IChatroomListener;
+    expansion?: IExpansionListener;
     /**
-     * 在指定聊天室中强制增加 / 修改任意聊天室属性
-     * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
-     * @param roomId 聊天室房间 id
-     * @param entry 属性信息
+     * 为兼容老版本 RTCLib 与 CallLib 接收消息的方式，新版本消息走插件机制
      */
-    forceSetChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
+    rtcInnerWatcher?: IRTCInnerListener;
     /**
-     * 删除聊天室属性
-     * @description 该方法仅限于删除自己设置的聊天室属性
-     * @param roomId 聊天室房间 id
-     * @param entry 要移除的属性信息
+     * 标签的增删改监听
      */
-    removeChatroomEntry(roomId: string, entry: IRemoveChatRoomEntryOption): Promise<ErrorCode>;
+    tag?: ITagListener;
     /**
-     * 强制删除任意聊天室属性
-     * @description 该方法仅限于删除自己设置的聊天室属性
-     * @param roomId 聊天室房间 id
-     * @param entry 要移除的属性信息
+     * 会话中标签状态变更监听
      */
-    forceRemoveChatroomEntry(roomId: string, entry: IRemoveChatRoomEntryOption): Promise<ErrorCode>;
+    conversationTagChanged?: IConversationTagListener;
     /**
-     * 获取聊天室中的指定属性
-     * @param roomId 聊天室房间 id
-     * @param key 属性键名
+     * 输入状态变更监听
      */
-    getChatroomEntry(roomId: string, key: string): Promise<IAsyncRes<string | null>>;
+    typingState?: ItypingStateListener;
+    pullFinished?: ITagListener;
+    onConnecting?: () => void;
+    onConnected?: () => void;
+    onDisconnect?: () => void;
+    onSuspend?: () => void;
+    readReceiptReceived?: (conversation: IConversationOption, messageUId: string, sentTime: number) => void;
+    messageReceiptRequest?: (conversation: IConversationOption, messageUId: string) => void;
+    messageReceiptResponse?: (conversation: IConversationOption, messageUId: string, sender: {
+        [responseUserIdList: string]: number;
+    }) => void;
+}
+interface IAPIContextOption {
     /**
-     * 获取聊天室内的所有属性
-     * @param roomId 聊天室房间 id
+     * 应用 appkey
      */
-    getAllChatroomEntries(roomId: string): Promise<IAsyncRes<{
-        [key: string]: string;
-    }>>;
+    appkey: string;
     /**
-     * 拉取聊天室内的历史消息
-     * @param roomId
-     * @param count 拉取消息条数, 有效值范围 `1 - 20`
-     * @param order 获取顺序，默认值为 0。
-     * * 0：降序，用于获取早于指定时间戳发送的消息
-     * * 1：升序，用于获取晚于指定时间戳发送的消息
-     * @param timestamp 指定拉取消息用到的时间戳。默认值为 `0`，表示按当前时间拉取
+     * IMLib 版本号
      */
-    getChatRoomHistoryMessages(roomId: string, count?: number, order?: 0 | 1, timestamp?: number): Promise<IAsyncRes<{
-        list: IReceivedMessage[];
-        hasMore: boolean;
-    }>>;
+    apiVersion: string;
     /**
-     * 获取存储服务鉴权信息
-     * @param fileType 文件类型
-     * @param fileName 文件名称
-     * @param httpMethod STC 分段上传时的必填参数，有效值为 PUT | POST
-     * @param queryString STC 分段上传时的查询字符串
-     * @description
-     * `httpMethod` 与 `queryString` 为 STC S3 分段上传时的专属参数，STC 分段上传包含三个过程：
-     * 1. 开始分段前调用，此时 `httpMethod` 值应为 `POST`， `queryString` 值为 `uploads`
-     * 2. 上传请求前调用，此时 `httpMethod` 值应为 `PUT`，`queryString` 值为 `partNumber={partamNumer}&uploadId={uploadId}`
-     * 3. 上传结束前调用，此时 `httpMethod` 值应为 `POST`，`queryString` 值为 `uploadId={uploadId}`
-     * @returns
+     * 自定义导航地址:
+     * 1. 私有云环境下该值为必填项
+     * 2. 当存在自定义导航地址时，SDK 内部默认地址将无效
+     * 3. 当存在自定义导航地址时，地址 url 中需包含 http/https 协议头，否则视为无效值
+     * 4. 建立 ws/wss 连接前的 ping 接口使用的协议与导航 url 中的协议相同
+     * 5. 建立 websocket 建立连接时将根据 ping 接口使用的 http/https 协议来确定使用 ws/wss 协议
+     * 6. 动态导航使用的协议头将与自定义导航地址相同
+     * 7. 公有云默认使用 https 协议
      */
-    getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string): Promise<IUploadAuth & {
-        bos: string;
-        qiniu: string;
-    }>;
+    navigators: string[];
     /**
-     * 获取 七牛、百度、阿里云 上传成功可下载的 URL
-     * @param fileType 文件类型
-     * @param fileName 文件名
-     * @param saveName 下载后的存储文件名
-     * @param uploadRes 插件上传返回的结果。降级百度上传后，用户传入返回结果，再把结果里的下载地址返回给用户，保证兼容之前结果获取
-     * @param serverType 使用的存储服务标识
+     * (参数已废弃)~~c++ 协议栈数据库地址~~
+     * @deprecated
     */
-    getFileUrl(fileType: FileType, fileName?: string, saveName?: string, uploadRes?: {
-        isBosRes: boolean;
-        downloadUrl: string;
-    }, serverType?: UploadMethod): Promise<{
-        downloadUrl: string;
-    }>;
+    dbPath?: string;
     /**
-     * 创建标签
-     * @param tag 标签
+     * 小程序的 CMP 代理地址
      */
-    createTag(tag: ITagParam): Promise<IAsyncRes>;
+    miniCMPProxy: string[];
     /**
-     * 删除标签
-     * @param tagId 标签id
+     * 指定默认使用的连接类型
      */
-    removeTag(tagId: string): Promise<IAsyncRes>;
+    connectionType: 'websocket' | 'comet';
     /**
-     * 更新标签
-     * @param tag 标签
+     * 修改 engine log 打印等级
      */
-    updateTag(tag: ITagParam): Promise<IAsyncRes>;
+    logLevel?: LogLevel;
     /**
-     * 获取标签列表
+     * 修改默认的 log 输出函数
      */
-    getTagList(): Promise<IAsyncRes<Array<ITagInfo>>>;
+    logStdout?: (logLevel: LogLevel, content: string) => void;
     /**
-     * 添加会话到标签（给多个会话增加标签）
-     * @param tagId 标签id
-     * @param conversations 要添加的会话列表
+     * （已废弃）私有云标识
+     * @deprecated
      */
-    addTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<IAsyncRes>>;
+    isEnterPrise?: boolean;
     /**
-     * 删除标签中的会话(从多个会话中批量删除指定标签)
-     * @param tagId 标签id
-     * @param conversations 要删除的会话列表
+     * typing状态过期时间
      */
-    removeTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<IAsyncRes>>;
+    typingExpireTime?: number;
     /**
-     * 删除会话中的标签(从单一会话中批量删除标签)
-     * @param conversationType 会话类型
-     * @param targetId 会话id
-     * @param tagIds 要删除的标签列表
+     * 是否打开 IndexDB 存储，默认为 true
      */
-    removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): Promise<IAsyncRes<IAsyncRes>>;
+    indexDBSwitch?: boolean;
     /**
-     * 获取标签下的会话列表
-     * @param tagId 标签id
+     * 是否校验证书，默认为 true
      */
-    getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): Promise<IAsyncRes<IReceivedConversationByTag[]>>;
+    checkCA?: boolean;
+}
+
+interface IRemoveChatRoomEntriesOption {
     /**
-     * 获取标签下的未读消息数
-     * @param tagId 标签id
-     * @param containMuted 是否包含免打扰会话
+     * key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
      */
-    getUnreadCountByTag(tagId: string, containMuted: boolean): Promise<IAsyncRes<number>>;
+    entries: {
+        key: string;
+    }[];
     /**
-     * 设置标签中会话置顶
-     * @param conversation 会话
+     * 删除成功后是否发送通知消息
      */
-    setConversationStatusInTag(tagId: string, conversation: IConversationOption, status: {
-        isTop: boolean;
-    }): Promise<IAsyncRes<IAsyncRes>>;
+    isSendNotification?: boolean;
     /**
-     * 获取会话里的标签
-     * @param conversation
+     * RC:chrmKVNotiMsg 消息中携带的附加信息
      */
-    getTagsForConversation(conversation: IConversationOption): Promise<IAsyncRes<IConversationTag[]>>;
+    notificationExtra?: string;
+}
+
+declare class APIContext {
+    private _runtime;
+    private static _context?;
+    static init(runtime: IRuntime, options: IAPIContextOption): APIContext;
+    static destroy(): void;
+    private _token;
     /**
-     * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
-     * 对于未实现的方法，接口响应 Unsupport 错误码
-     * @param method 方法名
-     * @param args
+     * 插件队列，用于逐一派发消息与信令
      */
-    callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
-    /**
-     * 删除所有会话
-    */
-    clearConversations(conversationTypes?: ConversationType[], tag?: string): Promise<ErrorCode>;
-    /**
-     * 设置用户连接状态监听器
-    */
-    setUserStatusListener(config: {
-        userIds: string[];
-    }, listener: Function): void;
-    /**
-     * 添加用户黑名单
-    */
-    addToBlacklist(userId: string): Promise<ErrorCode>;
-    /**
-     * 将指定用户移除黑名单
-    */
-    removeFromBlacklist(userId: string): Promise<ErrorCode>;
-    /**
-     * 获取黑名单列表
-    */
-    getBlacklist(): Promise<IAsyncRes<string[]>>;
-    /**
-     * 获取指定人员在黑名单中的状态
-    */
-    getBlacklistStatus(userId: string): Promise<IAsyncRes<string>>;
-    /**
-     * 向本地插入一条消息，不发送到服务器
-    */
-    insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): Promise<IAsyncRes<IReceivedMessage>>;
+    private _pluginContextQueue;
     /**
-     * 删除本地消息
-    */
-    deleteMessages(timestamp: number[]): Promise<ErrorCode>;
+     * 插件实例Map，用于重复初始化时返回实例
+     */
+    private _pluginInstanseMap;
+    private readonly _engine;
     /**
-     * 从本地消息数据库中删除某一会话指定时间之前的消息数据
-    */
-    deleteMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, channelId?: string): Promise<ErrorCode>;
+     * 核心库版本号，后期与 4.0 IM SDK 版本号保持一致
+     */
+    readonly coreVersion: string;
+    readonly appkey: string;
+    readonly apiVersion: string;
+    private readonly _options;
+    private _versionInfo;
+    private _typingInfo;
     /**
-     * 清空会话下历史消息
-    */
-    clearMessages(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
+     * 内部连接状态标识，为 ture 时不允许调用 reconnect 方法
+     */
+    private _isInternalConnected;
+    constructor(_runtime: IRuntime, options: IAPIContextOption);
     /**
-     * 获取本地消息
-    */
-    getMessage(messageId: number): Promise<IAsyncRes<IReceivedMessage>>;
+     * 安装使用插件，并初始化插件实例
+     * @param plugin
+     * @param options
+     */
+    install<T, O>(plugin: IPluginGenerator<T, O>, options: O): T | null;
+    private _connectionStatus;
+    private _canRedirectConnect;
     /**
-     * 设置消息内容
-    */
-    setMessageContent(messageId: number, content: any, messageType: string): Promise<ErrorCode>;
+     * 重定向后，递归调用 connect
+     */
+    private _handleRedirect;
     /**
-     * 设置消息搜索字段
-    */
-    setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<ErrorCode>;
+     * 连接状态变更回调
+     * @param message
+     */
+    private _connectionStatusListener;
+    _handleConnecting(): void;
+    _handleConnected(): void;
+    _handleDisconnect(): void;
+    _handleSuspend(): void;
+    private _messageReceiver;
+    _batchMessageReceiver(messages: IReceivedMessage[], leftCount?: number, hasMore?: boolean): void;
     /**
-     * 设置消息发送状态
+     * 聊天室相关信息监听
     */
-    setMessageSentStatus(messageId: number, sentStatus: number): Promise<ErrorCode>;
+    private _chatroomInfoListener;
     /**
-    * 设置消息接收状态
+     * 会话监听相关
     */
-    setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<ErrorCode>;
+    private _conversationInfoListener;
     /**
-     * 设置当前用户在线状态
+     * 消息扩展监听相关
     */
-    setUserStatus(status: number): Promise<ErrorCode>;
+    private _expansionInfoListener;
     /**
-     * 订阅用户在线状态
-    */
-    subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
+     * 标签增删改监听
+     */
+    private _tagListener;
     /**
-     * 获取用户在线状态
-    */
-    getUserStatus(userId: string): Promise<IAsyncRes<{
-        status: string;
-    }>>;
-    searchConversationByContent(keyword: string, customMessageTypes?: string[], channelId?: string, conversationTypes?: ConversationType[]): Promise<IAsyncRes<IReceivedConversation[]>>;
-    searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, channelId?: string): Promise<IAsyncRes<{
-        messages: IReceivedMessage[];
-        count: number;
-    }>>;
-    getUnreadMentionedMessages(conversationType: ConversationType, targetId: string, channelId?: string): IReceivedMessage[];
-    clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
+     * 会话标签状态监听
+     */
+    private _conversationTagListener;
+    private _typingStatusListener;
+    private _pullFinishedLister;
     /**
-     * 获取会话免打扰状态
-    */
-    getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<NotificationStatus>>;
-    getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, order: 0 | 1, channelId: string): Promise<IAsyncRes<{
-        list: IReceivedMessage[];
-        hasMore: boolean;
-    }>>;
+     * rtc 数据变更通知 pluginContext
+     */
+    private _rtcDataChange;
     /**
-     * 加入房间
-     * @param roomId
-     * @param mode 房间模式：直播 or 会议
-     * @param mediaType 直播房间模式下的媒体资源类型
+     * 业务层事件监听器挂载点
      */
-    joinRTCRoom(roomId: string, mode: RTCMode, mediaType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
-    quitRTCRoom(roomId: string): Promise<ErrorCode>;
-    rtcPing(roomId: string, mode: number, mediaType?: number): Promise<ErrorCode>;
-    getRTCRoomInfo(roomId: string): Promise<IAsyncRes<IRTCRoomInfo>>;
-    getRTCUserInfoList(roomId: string): Promise<IAsyncRes<IRTCUsers>>;
-    getRTCUserInfo(roomId: string): IPromiseResult<unknown>;
-    setRTCUserInfo(roomId: string, key: string, value: string): Promise<ErrorCode>;
-    removeRTCUserInfo(roomId: string, keys: string[]): Promise<ErrorCode>;
-    setRTCData(roomId: string, key: string, value: string, isInner: boolean, apiType: RTCApiType, message?: {
-        name: string;
-        content: string;
-    }): Promise<ErrorCode>;
-    setRTCTotalRes(roomId: string, message: {
-        name: string;
-        content: string;
-    }, valueInfo: string, objectName: string, mcuValInfo?: string): Promise<ErrorCode>;
-    setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
-    getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): Promise<IAsyncRes<KVString>>;
-    removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, message?: {
-        name: string;
-        content: string;
-    }): Promise<ErrorCode>;
-    setRTCOutData(roomId: string, rtcData: unknown, type: number, message: unknown): Promise<ErrorCode>;
-    getRTCOutData(roomId: string, userIds: string[]): IPromiseResult<unknown>;
-    getRTCToken(roomId: string, mode: number, broadcastType?: number): Promise<IAsyncRes<IRtcTokenData>>;
-    setRTCState(roomId: string, report: string): Promise<ErrorCode>;
-    getRTCUserList(roomId: string): IPromiseResult<IRTCUsers>;
+    private _watcher;
     /**
-     * 直播观众加房间
+     * 添加事件监听
+     * @param options
      */
-    joinLivingRoomAsAudience(roomId: string, mode: RTCMode, broadcastType?: number): Promise<IAsyncRes<{
-        token: string;
-        kvEntries: IServerRTCRoomEntry[];
-    }>>;
+    assignWatcher(watcher: IWatcher): void;
+    resetWatcher(): void;
     /**
-     * 直播观众退出房间
+     * 向内存中添加 typing 信息
+     * 添加 typing 时不触发通知，只有在轮询时间点校验 _typingChangedList 的长度大于 0 时才通知
      */
-    quitLivingRoomAsAudience(roomId: string): Promise<ErrorCode>;
+    private _addTypingInfo;
+    private _typingInternalTimer;
+    private _typingExpireTime;
+    private _typingChangedList;
     /**
-     * 直播身份切换
+     * 启动定时移除typing
      */
-    rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
-}
-
-/**
- * engine 基本接口定义，用于约束 Electron 下主进程、渲染进程、JSEngine 的编码一致性
- */
-interface IEngine {
+    private _startCheckTypingInfo;
+    getConnectedTime(): number;
+    getServerTime(): number;
+    getDeviceId(): string;
+    getCurrentUserId(): string;
+    getConnectionStatus(): ConnectionStatus;
+    get token(): string;
     /**
-     * 建立连接
+     * 建立连接，连接失败则抛出异常，连接成功后返回用户 userId，否则返回相应的错误码
      * @param token
-     * @param naviInfo
+     * @param refreshNavi 是否需要重新请求导航，当值为 `false` 时，优先使用有效缓存导航，若缓存失效则重新获取导航
      */
-    connect(token: string, naviInfo: INaviInfo, versionInfo: string): Promise<ErrorCode>;
+    connect(token: string, refreshNavi?: boolean): Promise<IConnectResult>;
     /**
-     * 上报版本信息
-     * @param version
+     * 拉取实时配置 web 端需更新 voipCall 字段
      */
-    reportSDKInfo(version: {
-        [name: string]: string;
-    }): void;
+    private _pullUserSettings;
+    disconnect(): Promise<void>;
+    reconnect(): Promise<IConnectResult>;
+    private _getTokenWithoutNavi;
     /**
-     * 连接时间
+     * 获取当前缓存的导航数据
      */
-    getConnectedTime(): number;
+    getInfoFromCache(): INaviInfo | null;
     /**
-     * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
-     * 对于未实现的方法，接口响应 Unsupport 错误码
-     * @param method
-     * @param args
+     * 消息注册
+     * @description 消息注册需在应用初始化完成前进行
+     * @param objectName 消息类型，如：RC:TxtMsg
+     * @param isPersited 是否存储
+     * @param isCounted 是否技术
+     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
      */
-    callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
+    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[]): void;
     /**
-     * 获取历史消息
+     * 发送消息
      * @param conversationType
      * @param targetId
-     * @param timestamp
-     * @param count
-     * @param order
+     * @param objectName
+     * @param content
+     * @param options
      */
-    getHistoryMessage(conversationType: ConversationType, targetId: string, 
+    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void): Promise<IAsyncRes<IReceivedMessage>>;
     /**
-     * 拉取时间戳，值为 `0` 表示从当前时间拉取
-     */
-    timestamp: number, 
+     * 发送扩展消息
+     * @param messageUId 消息 Id
+     * @param keys 需要删除的 key
+     * @param expansion 设置的扩展
+    */
+    sendExpansionMessage(options: ISendExMsgOptions): Promise<IAsyncRes<ErrorCode>>;
     /**
-     * 获取条数, 有效值 `1` - `20`
+     * 发送群组消息已读回执
+     * 导航下发已读回执开关为 true 时调用
+     * @param targetId 群组会话id
+     * @param messageUIds 消息id
      */
-    count: number, 
+    sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
     /**
-     * @description
-     * 1. `0` 表示升序，获取消息发送时间比传入 `sentTime` 小 的消息
-     * 2. `1` 表示降序，获取消息发送时间比传入 `sentTime` 大 的消息
+     * 获取群组消息已读列表
+     * @param targetId
+     * @param messageUIds
      */
-    order: 0 | 1, 
+    getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<IMessageReaderResponse>>;
     /**
-     * 会话的业务标识
-    */
-    channelId: string, 
+     * 反初始化，清空所有监听及计时器
+     */
+    private _destroy;
     /**
-     * 消息类型
+     * @param conversationType
+     * @param targetId 会话 Id
+     * @param timestamp 拉取时间戳
+     * @param count 拉取条数
+     * @param order 1 正序拉取，0 为倒序拉取
+     * @param channelId
+     * @param objectName
      */
-    objectName: string): IPromiseResult<{
+    getHistoryMessage(conversationType: ConversationType, targetId: string, timestamp?: number, count?: number, order?: 0 | 1, channelId?: string, objectName?: string): Promise<IAsyncRes<{
         list: IReceivedMessage[];
         hasMore: boolean;
-    }>;
-    /**
-     * 删除历史消息 通过 messageUId
-    */
-    deleteRemoteMessage(conversationType: ConversationType, targetId: string, 
-    /**
-     * @description
-     * message 中 messageUId、setTime、messageDirection 为必须参数
-    */
-    messages: {
-        messageUId: string;
-        sentTime: number;
-        messageDirection: MessageDirection;
-    }[], 
-    /**
-     * 会话的业务标识
-    */
-    channelId: string): Promise<ErrorCode>;
-    recallMsg(conversationType: ConversationType, targetId: string, messageUId: string, sentTime: number, recallMsgOptions: IRecallMsgOptions): IPromiseResult<IReceivedMessage>;
-    /**
-     * 删除历史消息 通过 时间戳
-     * @param timestamp 小于等于传入时间戳的消息均删除
-    */
-    deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, 
-    /**
-     * 会话的业务标识
-    */
-    channelId: string): Promise<ErrorCode>;
+    }>>;
     /**
      * 获取会话列表
      * @param count 指定获取数量, 不传则获取全部会话列表，默认 `300`
      */
-    getConversationList(
+    getConversationList(count?: number, conversationType?: ConversationType, startTime?: number, order?: 0 | 1, channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
     /**
-     * 拉取数量, 有效值 0 - 1000, 默认 300
+     * 获取单一会话数据
+     * @param conversationType
+     * @param targetId
+     * @param channelId
      */
-    count: number, 
+    getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
     /**
-     * 会话类型
-     * @todo 待确认是否生效
+     * 删除会话
      */
-    conversationType?: ConversationType, 
-    /**
-     * 起始时间
-    */
-    startTime?: number, 
-    /**
-     * 获取顺序
-    */
-    order?: 0 | 1, 
-    /**
-     * 会话的业务标识
-    */
-    channelId?: string): IPromiseResult<IReceivedConversation[]>;
+    removeConversation(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
     /**
-     * 获取指定会话
-    */
-    getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
+     * 清除会话消息未读数
+     */
+    clearUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
     /**
-     * 删除会话
-     * @description 该删除操作会删除服务器端存储的会话数据
-     * @param conversationType
-     * @param targetId
+     * 获取指定会话消息未读数
      */
-    removeConversation(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
+    getUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<number>>;
     /**
      * 获取所有会话未读数
      * @param channelId 多组织 Id
      * @param conversationTypes
      * @param includeMuted 包含已设置免打扰的会话
      */
-    getAllConversationUnreadCount(channelId: string, conversationTypes: ConversationType[], includeMuted: boolean): IPromiseResult<number>;
+    getTotalUnreadCount(channelId: string, conversationTypes?: ConversationType[], includeMuted?: boolean): Promise<IAsyncRes<number>>;
     /**
-     * 获取指定会话未读数
+     * 获取第一个未读消息
      */
-    getConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<number>;
+    getFirstUnreadMessage(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<IReceivedMessage | null>>;
+    setConversationStatus(conversationType: ConversationType, targetId: string, isTop?: boolean, notificationStatus?: 1 | 2, channelId?: string): Promise<ErrorCode>;
+    saveConversationMessageDraft(conversationType: ConversationType, targetId: string, draft: string): Promise<ErrorCode>;
+    getConversationMessageDraft(conversationType: ConversationType, targetId: string): Promise<IAsyncRes<string>>;
+    clearConversationMessageDraft(conversationType: ConversationType, targetId: string): Promise<ErrorCode>;
+    recallMessage(conversationType: ConversationType, targetId: string, messageUId: string, sentTime: number, recallMsgOptions: IRecallMsgOptions): Promise<IAsyncRes<IReceivedMessage>>;
     /**
-     * 清除指定会话未读数
+     * 删除远端消息
+     * @param conversationType
+     * @param targetId
+     * @param list
      */
-    clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
+    deleteRemoteMessage(conversationType: ConversationType, targetId: string, list: {
+        messageUId: string;
+        sentTime: number;
+        messageDirection: MessageDirection;
+    }[], channelId?: string): Promise<ErrorCode>;
     /**
-     * 获取第一个未读消息
+     * 根据时间戳删除指定时间之前的
+     * @param conversationType
+     * @param targetId
+     * @param timestamp
      */
-    getFirstUnreadMessage(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedMessage | null>;
+    deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
     /**
-     * 设置/保存指定会话消息草稿
-     * @draft 草稿内容
+     * 加入聊天室，若聊天室不存在则创建聊天室
+     * @param roomId 聊天室房间 Id
+     * @param count 进入聊天室成功后，自动拉取的历史消息数量，默认值为 `10`，最大有效值为 `50`，`-1` 为不拉取
      */
-    saveConversationMessageDraft(conversationType: ConversationType, targetId: string, draft: string): Promise<ErrorCode>;
+    joinChatroom(roomId: string, count?: number): Promise<ErrorCode>;
     /**
-     * 获取指定会话消息草稿
+     * 加入聊天室，若聊天室不存在则抛出异常
+     * @param roomId 聊天室房间 Id
+     * @param count 进入聊天室成功后，自动拉取的历史消息数量，默认值为 `10`，最大有效值为 `50`，`-1` 为不拉取
      */
-    getConversationMessageDraft(conversationType: ConversationType, targetId: string): IPromiseResult<string>;
+    joinExistChatroom(roomId: string, count?: number): Promise<ErrorCode>;
     /**
-     * 清除指定会话消息草稿
+     * 退出聊天室
+     * @param roomId
      */
-    clearConversationMessageDraft(conversationType: ConversationType, targetId: string): Promise<ErrorCode>;
+    quitChatroom(roomId: string): Promise<ErrorCode>;
     /**
-     * 从服务端拉取会话状态
+     * 获取聊天室房间数据
+     * @description count 或 order 有一个为 0 时，只返回成员总数，不返回成员列表信息
+     * @param roomId 聊天室 Id
+     * @param count 获取房间人员列表数量，最大有效值 `20`，最小值未 `0`，默认为 0
+     * @param order 人员排序方式，`1` 为正序，`2` 为倒序，默认为 0
      */
-    pullConversationStatus(timestamp: number): Promise<IAsyncRes<IServerConversationStatus[]>>;
+    getChatroomInfo(roomId: string, count?: number, order?: 0 | 1 | 2): Promise<IAsyncRes<IChatroomInfo>>;
     /**
-     * 批量设置会话 置顶、免打扰
+     * 在指定聊天室中设置自定义属性
+     * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
+     * @param roomId 聊天室房间 id
+     * @param entry 属性信息
      */
-    batchSetConversationStatus(statusList: ISetConversationStatusOptions[]): Promise<ErrorCode>;
-    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void): IPromiseResult<IReceivedMessage>;
+    setChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
+    setChatroomEntries(roomId: string, entryOptions: IChatroomEntries): Promise<ErrorCode>;
     /**
-     * 断开连接
+     * 在指定聊天室中强制增加 / 修改任意聊天室属性
+     * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
+     * @param roomId 聊天室房间 id
+     * @param entry 属性信息
      */
-    disconnect(): void;
+    forceSetChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
     /**
-     * 拉取用户级配置数据
+     * 删除聊天室属性
+     * @description 该方法仅限于删除自己设置的聊天室属性
+     * @param roomId 聊天室房间 id
+     * @param entry 要移除的属性信息
      */
-    pullUserSettings(version: number): IPromiseResult<IServerUserSetting>;
+    removeChatroomEntry(roomId: string, entry: IRemoveChatRoomEntryOption): Promise<ErrorCode>;
     /**
-     * 消息注册
-     * @description
-     * 消息注册需在应用初始化完成前进行，否则在搭配 C++ 协议栈使用时，
-     * 本端发出的消息将不默认作为未知消息处理，不存储、不计数
-     * @param objectName 消息类型，如：RC:TxtMsg
-     * @param isPersited 是否存储
-     * @param isCounted 是否技术
-     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     * 批量删除聊天室属性
+     * @description 该方法仅限于删除自己设置的聊天室属性
+     * @param roomId 聊天室房间 id
+     * @param entry 要移除的属性信息
      */
-    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[]): void;
-    /**
-     * 加入聊天室
-     * @param count 拉取消息数量
-    */
-    joinChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
+    removeChatroomEntries(roomId: string, entryOptions: IRemoveChatRoomEntriesOption): Promise<ErrorCode>;
     /**
-     * 加入已存在的聊天室
-     * @param count 拉取消息数量
-    */
-    joinExistChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
+     * 强制删除任意聊天室属性
+     * @description 该方法仅限于删除自己设置的聊天室属性
+     * @param roomId 聊天室房间 id
+     * @param entry 要移除的属性信息
+     */
+    forceRemoveChatroomEntry(roomId: string, entry: IRemoveChatRoomEntryOption): Promise<ErrorCode>;
     /**
-     * 退出聊天室
-    */
-    quitChatroom(chatroomId: string): Promise<ErrorCode>;
+     * 获取聊天室中的指定属性
+     * @param roomId 聊天室房间 id
+     * @param key 属性键名
+     */
+    getChatroomEntry(roomId: string, key: string): Promise<IAsyncRes<string | null>>;
     /**
-     * 获取聊天室信息
-     * @param count 获取人数, 范围 0 - 20
-     * @param order 排序方式, 1 正序, 2 倒序
-    */
-    getChatroomInfo(chatroomId: string, count: number, order: number): IPromiseResult<IChatroomInfo>;
+     * 获取聊天室内的所有属性
+     * @param roomId 聊天室房间 id
+     */
+    getAllChatroomEntries(roomId: string): Promise<IAsyncRes<{
+        [key: string]: string;
+    }>>;
     /**
-     * 获取聊天室历史消息
-    */
-    getChatroomHistoryMessages(chatroomId: string, timestamp: number, count: number, order: number): IPromiseResult<{
+     * 拉取聊天室内的历史消息
+     * @param roomId
+     * @param count 拉取消息条数, 有效值范围 `1 - 20`
+     * @param order 获取顺序，默认值为 0。
+     * * 0：降序，用于获取早于指定时间戳发送的消息
+     * * 1：升序，用于获取晚于指定时间戳发送的消息
+     * @param timestamp 指定拉取消息用到的时间戳。默认值为 `0`，表示按当前时间拉取
+     */
+    getChatRoomHistoryMessages(roomId: string, count?: number, order?: 0 | 1, timestamp?: number): Promise<IAsyncRes<{
         list: IReceivedMessage[];
         hasMore: boolean;
-    }>;
-    /**
-     * 设置聊天室属性
-    */
-    setChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
-    /**
-     * 强制设置聊天室属性
-    */
-    forceSetChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
-    /**
-     * 删除聊天室属性
-    */
-    removeChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
-    /**
-     * 强制删除聊天室属性
-    */
-    forceRemoveChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
-    /**
-      * 获取聊天室 key 对应 value
-    */
-    getChatroomEntry(chatroomId: string, key: string): IPromiseResult<string | null>;
-    /**
-      * 获取聊天室所有 key value
-    */
-    getAllChatroomEntry(chatroomId: string): IPromiseResult<{
-        [key: string]: string;
-    }>;
+    }>>;
     /**
-     * 获取上传认证信息
+     * 获取存储服务鉴权信息
+     * @param fileType 文件类型
+     * @param fileName 文件名称
+     * @param httpMethod STC 分段上传时的必填参数，有效值为 PUT | POST
+     * @param queryString STC 分段上传时的查询字符串
      * @description
-     * 若不传 fileName 百度上传认证字段（bosToken、bosDate、path）均返回 null
-    */
-    getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string): Promise<IAsyncRes<IUploadAuth>>;
+     * `httpMethod` 与 `queryString` 为 STC S3 分段上传时的专属参数，STC 分段上传包含三个过程：
+     * 1. 开始分段前调用，此时 `httpMethod` 值应为 `POST`， `queryString` 值为 `uploads`
+     * 2. 上传请求前调用，此时 `httpMethod` 值应为 `PUT`，`queryString` 值为 `partNumber={partamNumer}&uploadId={uploadId}`
+     * 3. 上传结束前调用，此时 `httpMethod` 值应为 `POST`，`queryString` 值为 `uploadId={uploadId}`
+     * @returns
+     */
+    getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string): Promise<IUploadAuth & {
+        bos: string;
+        qiniu: string;
+    }>;
     /**
-     * 获取文件上传后下载地址
+     * 获取 七牛、百度、阿里云 上传成功可下载的 URL
+     * @param fileType 文件类型
+     * @param fileName 文件名
+     * @param saveName 下载后的存储文件名
+     * @param uploadRes 插件上传返回的结果。降级百度上传后，用户传入返回结果，再把结果里的下载地址返回给用户，保证兼容之前结果获取
+     * @param serverType 使用的存储服务标识
     */
-    getFileUrl(fileType: FileType, uploadMethod: UploadMethod, fileName?: string, originName?: string): IPromiseResult<{
+    getFileUrl(fileType: FileType, fileName?: string, saveName?: string, uploadRes?: {
+        isBosRes: boolean;
+        downloadUrl: string;
+    }, serverType?: UploadMethod): Promise<{
         downloadUrl: string;
     }>;
     /**
      * 创建标签
      * @param tag 标签
-    */
-    createTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
+     */
+    createTag(tag: ITagParam): Promise<IAsyncRes>;
     /**
      * 删除标签
      * @param tagId 标签id
-    */
-    removeTag(tagId: string): IPromiseResult<IAsyncRes>;
+     */
+    removeTag(tagId: string): Promise<IAsyncRes>;
     /**
-     * 编辑标签
+     * 更新标签
      * @param tag 标签
-    */
-    updateTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
+     */
+    updateTag(tag: ITagParam): Promise<IAsyncRes>;
     /**
      * 获取标签列表
      */
-    getTagList(): IPromiseResult<Array<ITagInfo>>;
+    getTagList(): Promise<IAsyncRes<Array<ITagInfo>>>;
     /**
      * 添加会话到标签（给多个会话增加标签）
      * @param tagId 标签id
      * @param conversations 要添加的会话列表
      */
-    addTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult<IAsyncRes>;
+    addTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<IAsyncRes>>;
     /**
      * 删除标签中的会话(从多个会话中批量删除指定标签)
      * @param tagId 标签id
      * @param conversations 要删除的会话列表
      */
-    removeTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult<IAsyncRes>;
+    removeTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<IAsyncRes>>;
     /**
      * 删除会话中的标签(从单一会话中批量删除标签)
      * @param conversationType 会话类型
      * @param targetId 会话id
      * @param tagIds 要删除的标签列表
      */
-    removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): IPromiseResult<IAsyncRes>;
+    removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): Promise<IAsyncRes<IAsyncRes>>;
     /**
      * 获取标签下的会话列表
      * @param tagId 标签id
      */
-    getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): IPromiseResult<IReceivedConversationByTag[]>;
+    getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): Promise<IAsyncRes<IReceivedConversationByTag[]>>;
     /**
      * 获取标签下的未读消息数
      * @param tagId 标签id
      * @param containMuted 是否包含免打扰会话
      */
-    getUnreadCountByTag(tagId: string, containMuted: boolean): IPromiseResult<number>;
+    getUnreadCountByTag(tagId: string, containMuted: boolean): Promise<IAsyncRes<number>>;
     /**
      * 设置标签中会话置顶
      * @param conversation 会话
      */
-    setConversationStatusInTag(tagId: string, conversation: IConversationOption, status: ITagStatus): IPromiseResult<IAsyncRes>;
+    setConversationStatusInTag(tagId: string, conversation: IConversationOption, status: {
+        isTop: boolean;
+    }): Promise<IAsyncRes<IAsyncRes>>;
     /**
      * 获取会话里的标签
-     * @param config
-     */
-    getTagsForConversation(conversation: IConversationOption): IPromiseResult<IConversationTag[]>;
-    /**
-     * 发送群组消息已读回执
-     * 导航下发已读回执开关为 true 时调用
-     */
-    sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
-    /**
-     * 获取群组消息已读列表
-     */
-    getMessageReader(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IMessageReaderResponse>;
-    /**
-     * 获取服务器时间
+     * @param conversation
      */
-    getServerTime(): number;
+    getTagsForConversation(conversation: IConversationOption): Promise<IAsyncRes<IConversationTag[]>>;
     /**
-     * 获取设备ID
+     * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
+     * 对于未实现的方法，接口响应 Unsupport 错误码
+     * @param method 方法名
+     * @param args
      */
-    getDeviceId(): string;
+    callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
     /**
-     * 获取当前 userId
-     */
-    getCurrentUserId(): string;
+     * 删除所有会话
+    */
+    clearConversations(conversationTypes?: ConversationType[], tag?: string): Promise<ErrorCode>;
     /**
-     * 设置用户在线状态监听器
+     * 设置用户连接状态监听器
     */
     setUserStatusListener(config: {
         userIds: string[];
     }, listener: Function): void;
     /**
-     * 设置当前用户在线状态
-    */
-    setUserStatus(status: number): Promise<ErrorCode>;
-    /**
-     * 订阅用户在线状态
-    */
-    subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
-    /**
-     * 获取用户状态
-    */
-    getUserStatus(userId: string): IPromiseResult<{
-        status: string;
-    }>;
-    /**
-     * 清空所有会话
-    */
-    clearConversations(conversationTypes?: ConversationType[], channelId?: string): Promise<ErrorCode>;
-    /**
-     * 加入黑名单
+     * 添加用户黑名单
     */
     addToBlacklist(userId: string): Promise<ErrorCode>;
     /**
-      * 将指定用户移除黑名单
+     * 将指定用户移除黑名单
     */
     removeFromBlacklist(userId: string): Promise<ErrorCode>;
     /**
-      * 获取黑名单列表
+     * 获取黑名单列表
     */
-    getBlacklist(): IPromiseResult<string[]>;
+    getBlacklist(): Promise<IAsyncRes<string[]>>;
     /**
-      * 获取指定人员在黑名单中的状态
+     * 获取指定人员在黑名单中的状态
     */
-    getBlacklistStatus(userId: string): IPromiseResult<string>;
+    getBlacklistStatus(userId: string): Promise<IAsyncRes<string>>;
     /**
      * 向本地插入一条消息，不发送到服务器
     */
-    insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): IPromiseResult<IReceivedMessage>;
+    insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): Promise<IAsyncRes<IReceivedMessage>>;
     /**
      * 删除本地消息
     */
-    deleteMessages(timestamps: number[]): Promise<ErrorCode>;
+    deleteMessages(timestamp: number[]): Promise<ErrorCode>;
     /**
-     * 通过时间戳删除本地消息
+     * 从本地消息数据库中删除某一会话指定时间之前的消息数据
     */
-    deleteMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, channelId: string): Promise<ErrorCode>;
+    deleteMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, channelId?: string): Promise<ErrorCode>;
     /**
      * 清空会话下历史消息
     */
-    clearMessages(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
+    clearMessages(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
     /**
-     * 获取消息
+     * 获取本地消息
     */
-    getMessage(messageId: number): IPromiseResult<IReceivedMessage>;
+    getMessage(messageId: number): Promise<IAsyncRes<IReceivedMessage>>;
     /**
      * 设置消息内容
     */
@@ -4086,49 +4133,54 @@ interface IEngine {
      * 设置消息搜索字段
     */
     setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<ErrorCode>;
-    /**
-     * 通过关键字搜索会话
-    */
-    searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
-    /**
-     * 按内容搜索会话内的消息
-    */
-    searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, channelId: string): IPromiseResult<{
-        messages: IReceivedMessage[];
-        count: number;
-    }>;
-    /**
-     * 获取会话下所有未读的 @ 消息
-    */
-    getUnreadMentionedMessages(conversationType: ConversationType, targetId: string, channelId: string): IReceivedMessage[];
     /**
      * 设置消息发送状态
     */
     setMessageSentStatus(messageId: number, sentStatus: number): Promise<ErrorCode>;
     /**
-     * 设置消息接收状态
+    * 设置消息接收状态
     */
     setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<ErrorCode>;
     /**
-     * 删除时间戳前的未读数
+     * 设置当前用户在线状态
     */
-    clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId: string): Promise<ErrorCode>;
+    setUserStatus(status: number): Promise<ErrorCode>;
     /**
-     * 获取会话免打扰状态
+     * 订阅用户在线状态
     */
-    getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationStatus>;
+    subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
     /**
-     * 协议栈获取远端历史消息
+     * 获取用户在线状态
     */
-    getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, order: 0 | 1, channelId: string): IPromiseResult<{
+    getUserStatus(userId: string): Promise<IAsyncRes<{
+        status: string;
+    }>>;
+    searchConversationByContent(keyword: string, customMessageTypes?: string[], channelId?: string, conversationTypes?: ConversationType[]): Promise<IAsyncRes<IReceivedConversation[]>>;
+    searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, channelId?: string): Promise<IAsyncRes<{
+        messages: IReceivedMessage[];
+        count: number;
+    }>>;
+    getUnreadMentionedMessages(conversationType: ConversationType, targetId: string, channelId?: string): IReceivedMessage[];
+    clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
+    /**
+     * 获取会话免打扰状态
+    */
+    getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<NotificationStatus>>;
+    getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, order: 0 | 1, channelId: string): Promise<IAsyncRes<{
         list: IReceivedMessage[];
         hasMore: boolean;
-    }>;
-    joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number): IPromiseResult<IJoinRTCRoomData>;
+    }>>;
+    /**
+     * 加入房间
+     * @param roomId
+     * @param mode 房间模式：直播 or 会议
+     * @param mediaType 直播房间模式下的媒体资源类型
+     */
+    joinRTCRoom(roomId: string, mode: RTCMode, mediaType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
     quitRTCRoom(roomId: string): Promise<ErrorCode>;
-    rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
-    getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
-    getRTCUserInfoList(roomId: string): IPromiseResult<IRTCUsers>;
+    rtcPing(roomId: string, mode: number, mediaType?: number): Promise<ErrorCode>;
+    getRTCRoomInfo(roomId: string): Promise<IAsyncRes<IRTCRoomInfo>>;
+    getRTCUserInfoList(roomId: string): Promise<IAsyncRes<IRTCUsers>>;
     getRTCUserInfo(roomId: string): IPromiseResult<unknown>;
     setRTCUserInfo(roomId: string, key: string, value: string): Promise<ErrorCode>;
     removeRTCUserInfo(roomId: string, keys: string[]): Promise<ErrorCode>;
@@ -4136,49 +4188,105 @@ interface IEngine {
         name: string;
         content: string;
     }): Promise<ErrorCode>;
-    /**
-     * 全量订阅资源修改
-     * @param roomId 房间 Id
-     * @param message 向前兼容的消息内容
-     * @param valueInfo 全量资源数据
-     * @param objectName 全量 URI 消息名
-     */
     setRTCTotalRes(roomId: string, message: {
         name: string;
         content: string;
-    }, valueInfo: string, objectName: string, mcuValInfo: string): Promise<ErrorCode>;
-    getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): IPromiseResult<KVString>;
+    }, valueInfo: string, objectName: string, mcuValInfo?: string): Promise<ErrorCode>;
+    getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): Promise<IAsyncRes<KVString>>;
     removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, message?: {
         name: string;
         content: string;
     }): Promise<ErrorCode>;
     setRTCOutData(roomId: string, rtcData: unknown, type: number, message: unknown): Promise<ErrorCode>;
     getRTCOutData(roomId: string, userIds: string[]): IPromiseResult<unknown>;
-    getRTCToken(roomId: string, mode: number, broadcastType?: number): IPromiseResult<IRtcTokenData>;
-    setRTCState(roomId: string, reportId: string): Promise<ErrorCode>;
+    getRTCToken(roomId: string, mode: number, broadcastType?: number): Promise<IAsyncRes<IRtcTokenData>>;
+    setRTCState(roomId: string, report: string): Promise<ErrorCode>;
     getRTCUserList(roomId: string): IPromiseResult<IRTCUsers>;
-    setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
+    /**
+     * 直播观众加房间
+     */
+    joinLivingRoomAsAudience(roomId: string, mode: RTCMode, broadcastType?: number): Promise<IAsyncRes<{
+        token: string;
+    }>>;
+    /**
+     * 直播观众退出房间
+     */
+    quitLivingRoomAsAudience(roomId: string): Promise<ErrorCode>;
+    /**
+     * 直播身份切换
+     */
+    rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
 }
 
-interface IExpansionMsgContent {
+declare class PluginContext {
+    protected readonly _context: APIContext;
+    constructor(_context: APIContext);
     /**
-     * 消息扩展的对象
-    */
-    put?: {
-        [key: string]: string;
-    };
+     * 接收 IM 服务推送的消息，并通过返回 boolean 值决定此消息是否拦截
+     * @param message
+     * @returns 当返回值为 true，接收的消息将终止继续传递
+     */
+    onmessage?(message: IReceivedMessage): boolean;
     /**
-     * 删除的 keys
-    */
-    del?: string[];
+     * 用户主动断开连接的事件通知
+     */
+    ondisconnect?(): void;
     /**
-     * messageUId
-    */
-    mid: string;
+     * 接收 IM 连接状态变更通知
+     * @param status
+     */
+    onconnectionstatechange?(status: ConnectionStatus): void;
     /**
-     * 是否删除所有, 有效值：0、1 . ( 后续如有需要, API Layer 层可使用)
+     * IM 客户端销毁通知
+     */
+    ondestroy?(): void;
+    /**
+     * RTC 数据通知
+     * @param roomdId 数据对应的房间 Id
+     * @param data 通知数据为 key:value 方式
+     * @description
+     * 目前仅通知：主播加入、退出房间的人员列表变更，发布、取消发布资源列表变更
     */
-    removeAll?: number;
+    onrtcdatachange?(data: IServerRTCRoomEntry[], roomdId?: string): void;
+    /**
+     * 获取 `@rongcloud/engine` 包版本
+     */
+    getCoreVersion(): string;
+    /**
+     * 获取当前运行中的 IMLib 版本号
+     */
+    getAPIVersion(): string;
+    /**
+     * 获取当前应用的 appkey
+     */
+    getAppkey(): string;
+    /**
+     * 获取当前已连接用户的 userId
+     * 用户连接建立之前及 disconnect 之后，该方法返回 '' 值
+     */
+    getCurrentId(): string;
+    /**
+     * 获取当前连接状态
+     */
+    getConnectionStatus(): ConnectionStatus;
+    getDeviceId(): string;
+    /**
+     * 发送消息
+     */
+    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions): IPromiseResult<IReceivedMessage>;
+    /**
+     * 消息注册
+     * @description 消息注册需在应用初始化完成前进行
+     * @param objectName 消息类型，如：RC:TxtMsg
+     * @param isPersited 是否存储
+     * @param isCounted 是否技术
+     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     */
+    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[]): void;
+    /**
+     * 获取服务时间
+     */
+    getServerTime(): number;
 }
 
 declare class RTCPluginContext extends PluginContext {
@@ -4233,22 +4341,6 @@ declare class RTCPluginContext extends PluginContext {
      * mcu 合流发布内容，是一个 JSON 字符串，解析类型为 {mediaType: number, msid: string, uri: string}[]
      */
     mcuValInfo?: string): Promise<ErrorCode>;
-    /**
-     * 设置 cdn_uris 扩散
-     * @param objectName 全量 URI 消息名，即 `RCRTC:TotalContentResources`
-     * @param CDNUris cdn_uris 扩散字段
-     * {
-        "broadcast":0,
-        "fps":25,
-        "h":640,
-        "pull_safe":true,
-        "push_mode":1,
-        "url":"https://rtc-media-api-service-ucbj2-01.rongcloud.net/api/rtc/cdn/player",
-        "w":360,
-        "enableInnerCDN":true
-      }[]
-     */
-    setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
     getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): IPromiseResult<KVString>;
     removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, message?: {
         name: string;
@@ -4264,7 +4356,6 @@ declare class RTCPluginContext extends PluginContext {
      */
     joinLivingRoomAsAudience(roomId: string, mode: RTCMode, broadcastType?: number): IPromiseResult<{
         token: string;
-        kvEntries: IServerRTCRoomEntry[];
     }>;
     /**
      * 直播观众退出房间
@@ -4310,13 +4401,15 @@ interface IEngineWatcher {
      * @param leftCount 参数废弃，值始终为 undefined
      * @param hasMore 消息是否收取结束，需与协议栈配合使用
     */
-    message: (message: IReceivedMessage, leftCount?: number, hasMore?: boolean) => void;
+    batchMessage: (messages: IReceivedMessage[], leftCount?: number, hasMore?: boolean) => void;
     status: (status: ConnectionStatus) => void;
     chatroom: (event: IChatroomListenerData) => void;
     conversation: (event: any) => void;
     expansion: (event: IExpansionListenerData) => void;
     tag: () => void;
-    conversationTag: () => void;
+    conversationTag: (conversationType: ConversationType, targetId: string, conversationTags: {
+        tags: ILocalTagStatus;
+    }) => void;
     /**
      * RTC 数据变更
      */
@@ -4573,6 +4666,10 @@ declare abstract class AEngine implements IEngine {
      * 设置聊天室属性
     */
     abstract setChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+    /**
+     * 批量设置聊天室属性
+     */
+    abstract setChatroomEntries(chatroomId: string, entry: IChrmKVEntries): Promise<ErrorCode>;
     /**
      * 强制设置聊天室属性
     */
@@ -4581,6 +4678,10 @@ declare abstract class AEngine implements IEngine {
      * 删除聊天室属性
     */
     abstract removeChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+    /**
+     * 批量删除聊天室属性
+     */
+    abstract removeChatroomEntries(chatroomId: string, entry: IChrmKVEntries): Promise<ErrorCode>;
     /**
      * 强制删除聊天室属性
     */
@@ -4687,10 +4788,6 @@ declare abstract class AEngine implements IEngine {
      * 获取设备ID
      */
     abstract getDeviceId(): string;
-    /**
-     * 获取当前 userId
-     */
-    abstract getCurrentUserId(): string;
     /**
      * 设置用户在线状态监听器
     */
@@ -4832,11 +4929,9 @@ declare abstract class AEngine implements IEngine {
     abstract getRTCUserList(roomId: string): IPromiseResult<IRTCUsers>;
     abstract joinLivingRoomAsAudience(roomId: string, mode: RTCMode, broadcastType?: number): Promise<IAsyncRes<{
         token: string;
-        kvEntries: IServerRTCRoomEntry[];
     }>>;
     abstract quitLivingRoomAsAudience(roomId: string): Promise<ErrorCode>;
     abstract rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
-    abstract setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
 }
 
 declare class AppStorage {
@@ -5287,4 +5382,4 @@ declare enum CONNECTION_TYPE {
  */
 declare const version: string;
 
-export { AEngine, ANavi, APIContext, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAsyncRes, IChatroomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEngine, IEngineWatcher, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IInsertMsgOptions, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCRoomInfo, IRTCUsers, IReadReceiptInfo, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntryOption, IRequest, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogType, Logger, MAX_MESSAGE_CONTENT_BYTES, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NotificationStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, RTCApiType, RTCIdentityChangeType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UploadMethod, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, cloneByJSON, forEach, formatConnectResponseCode, getBrowser, getMimeKey, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidFileType, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, usingCppEngine, validate, version };
+export { AEngine, ANavi, APIContext, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType as ChatroomMemberChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAsyncRes, IChatroomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IInsertMsgOptions, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCRoomInfo, IRTCUsers, IReadReceiptInfo, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntryOption, IRequest, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogType, Logger, MAX_MESSAGE_CONTENT_BYTES, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NotificationStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, RTCApiType, RTCIdentityChangeType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UploadMethod, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, cloneByJSON, forEach, formatConnectResponseCode, getBrowser, getMimeKey, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidFileType, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, usingCppEngine, validate, version };