@rongcloud/engine 4.5.0-alpha.4 → 4.5.3

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v4.5.0-alpha.4
- * CommitId - aed25bcb04db37260a1cc8910f8992d194ae850c
- * Tue Nov 30 2021 16:31:39 GMT+0800 (China Standard Time)
+ * RCEngine - v4.5.3
+ * CommitId - 53f04162f2b6042fd1f3d893800fcb85ecf4ff9e
+ * Thu Dec 09 2021 18:05:37 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -138,6 +138,42 @@ declare enum OperationType {
     DISCONNECT = 14,
     RESERVER2 = 15
 }
+/**
+ * connect 版本号，用于区分 ConnAckMessage 的解析规则
+ */
+declare enum ConnAckProtocolVer {
+    /**
+     * V4 说明：
+     * ```
+     * 增加 flag 来标识每个位置是否有内容，如果没有 messageId 说明此 APP 没有配置防重放，默认取0
+     * status            |   4byte
+     * flag              |   1byte  每一位标识是否有对应值，由低到高
+     * userId            |   可变长
+     * sessionId         |   可变长
+     * timestamp         |   8byte
+     * messageId         |   4byte
+     * onlineClientInfo  |   可变长
+     * ===
+     * flag 描述：
+     * | | | |          4          |      3       |       2      |      1       |     0     |
+     * | | | | hasOnlineClientInfo | hasMessageId | hasTimeStamp | hasSessionId | hasUserId |
+     * ```
+     */
+    V4 = 4,
+    /**
+     * V3 说明：
+     * ```
+     * status            |   4byte
+     * userId            |   可变长
+     * sessionId         |   可变长
+     * timestamp         |   8byte
+     * descyptionType    |   1byte
+     * secretKey         |   可变长
+     * onlineClientInfo  |   可变长
+     * ```
+     */
+    V3 = 3
+}
 
 /**
  * @todo 注释补全
@@ -163,6 +199,10 @@ declare class RongStreamReader {
     private _poolLen;
     constructor(arr: Uint8Array);
     check(): boolean;
+    /**
+     * 读 2 位
+     */
+    read2Byte(): number;
     /**
      * 读 4 位
      */
@@ -219,8 +259,8 @@ declare class BaseReader {
     identifier: string;
     constructor(header: Header);
     getIdentifier(): string | number;
-    read(stream: RongStreamReader, length: number): void;
-    readMessage(stream: RongStreamReader, length?: number): {
+    read(stream: RongStreamReader, length: number, protocolVer: ConnAckProtocolVer): void;
+    readMessage(stream: RongStreamReader, length?: number, protocolVer?: ConnAckProtocolVer): {
         stream: RongStreamReader;
         length: number | undefined;
     };
@@ -325,6 +365,13 @@ interface IConversationOption {
     targetId: string;
     channelId?: string;
 }
+interface IServerRTCRoomEntry {
+    key: string;
+    value: string;
+    status: number;
+    timestamp: number;
+    uid: string;
+}
 interface IChrmKVEntry {
     key: string;
     value?: string;
@@ -337,10 +384,18 @@ interface IChrmKVEntry {
     type?: number;
     isDeleted?: boolean;
 }
-interface IChrmKVPullData {
-    kvEntries: IChrmKVEntry[];
-    isFullUpdate?: boolean;
-    syncTime?: number;
+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;
@@ -384,13 +439,6 @@ interface IGetConversationListOption {
 interface IClearMsgOption {
     timestamp?: number;
 }
-interface IServerRTCRoomEntry {
-    key: string;
-    value: string;
-    status: number;
-    timestamp: number;
-    uid: string;
-}
 
 /**
  *  聊天室 kv 存储操作类型. 对方操作, 己方收到消息(RC:chrmKVNotiMsg)中会带入此值. 根据此值判断是删除还是更新
@@ -510,12 +558,17 @@ interface IUserProfile {
     name?: string;
     /**
      * 用户头像地址
+     * @deprecated
      */
     portraitUri?: string;
     /**
      * user info 中附加信息
      */
     extra?: string;
+    /**
+     * 用户头像地址（向移动端兼容）
+     */
+    portrait?: string;
 }
 /**
  * 发送消息时的可选项信息
@@ -862,6 +915,18 @@ declare enum ErrorCode {
      * Disconnect，由服务器返回，比如用户互踢。
      */
     RC_DISCONN_EXCEPTION = 31011,
+    /**
+     * app 验证Token 验证不通过。所有内部超时，访问失败,返回给客户端sdk都是验证不通过，由服务端日志去看具体是那种失败。
+     */
+    RC_APP_AUTH_NOT_PASS = 31026,
+    /**
+     * One Time Password 已经被使用过
+     */
+    RC_OTP_USED = 31027,
+    /**
+     * token平台验证失败
+     */
+    RC_PLATFORM_ERROR = 31028,
     /**
      * 协议层内部错误。query，上传下载过程中数据错误。
      */
@@ -1117,7 +1182,15 @@ declare enum ErrorCode {
     /**
      * VoIP 不可用
      */
-    VOIP_NOT_AVALIABLE = 18
+    VOIP_NOT_AVALIABLE = 18,
+    /**
+     * 聊天室批量设置kv部分不成功
+     */
+    CHATROOM_KV_STORE_NOT_ALL_SUCCESS = 23428,
+    /**
+     * 聊天室设置批量kv，一次不能超过10个
+     */
+    CHATROOM_KV_STORE_OUT_LIMIT = 23429
 }
 
 /**
@@ -1372,6 +1445,7 @@ declare class DataCodec {
       * 聊天室 KV 存储
     */
     encodeModifyChatRoomKV(chrmId: string, entry: IChrmKVEntry, currentUserId: string): any;
+    encodeModifyChatRoomKVS(chrmId: string, entryOptions: IChrmKVEntries, currentUserId: string): any;
     /**
       * KV 存储拉取
     */
@@ -1615,7 +1689,7 @@ declare abstract class ADataChannel {
      * @param protocol 请求导航数据时使用的网络协议, /ping 与 websocket 需要继续遵循该协议
      * @param apiVersion - apiVersion 需符合 `/\d+(\.\d+){2}/` 规则，对于预发布版本号如 `3.1.0-alpha.1` 需认定为 `3.1.0`
      */
-    abstract connect(appkey: string, token: string, host: string[], protocol: 'http' | 'https', apiVersion: string): Promise<ErrorCode>;
+    abstract connect(appkey: string, token: string, host: string[], protocol: 'http' | 'https', apiVersion: string, protocolVer: ConnAckProtocolVer): Promise<ErrorCode>;
     /**
      * 只发送数据，无需响应
      */
@@ -1782,7 +1856,11 @@ declare class WebSocketChannel extends ADataChannel {
      * @param protocol
      * @param apiVersion - apiVersion 需符合 `/\d+(\.\d+){2}/` 规则
      */
-    connect(appkey: string, token: string, hosts: string[], protocol: 'http' | 'https', apiVersion: string): Promise<ErrorCode>;
+    connect(appkey: string, token: string, hosts: string[], protocol: 'http' | 'https', apiVersion: string, protocolVer: ConnAckProtocolVer): Promise<ErrorCode>;
+    /**
+     * 发起连接请求
+     */
+    private _connect;
     /**
      * 当前累计心跳超时次数
      */
@@ -1826,7 +1904,13 @@ declare class CometChannel extends ADataChannel {
      * 长轮询心跳
      */
     _startPullSignal(protocol: 'http' | 'https'): Promise<void>;
-    connect(appkey: string, token: string, hosts: string[], protocol: 'http' | 'https', apiVersion: string): Promise<ErrorCode>;
+    /**
+     * 连接
+     *  comet 连接暂时不走 protocolVer=v4 的协议
+     * @returns
+     */
+    connect(appkey: string, token: string, hosts: string[], protocol: 'http' | 'https', apiVersion: string, protocolVer: ConnAckProtocolVer): Promise<ErrorCode>;
+    private _connect;
     private _idCount;
     private _generateMessageId;
     sendCometData(writer: BaseWriter, timeout?: number): Promise<void>;
@@ -2232,6 +2316,7 @@ interface IJoinRTCRoomData extends IRTCUsers {
         key: string;
         value: string;
     }[];
+    kvEntries: IServerRTCRoomEntry[];
 }
 
 /**
@@ -2353,6 +2438,22 @@ interface IChatroomEntry {
     isAutoDelete?: boolean;
 }
 
+interface IChatroomEntries {
+    /**
+     * entries ,要设置的属性列表
+     * key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
+     * value 属性对应的值, 最大长度 4096 字符
+     */
+    entries: {
+        key: string;
+        value: string;
+    }[];
+    /**
+     * 用户退出聊天室时是否清除此属性
+     */
+    isAutoDelete?: boolean;
+}
+
 interface IRemoveChatRoomEntryOption {
     /**
      * 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
@@ -2368,6 +2469,23 @@ interface IRemoveChatRoomEntryOption {
     notificationExtra?: string;
 }
 
+interface IRemoveChatRoomEntriesOption {
+    /**
+     * key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
+     */
+    entries: {
+        key: string;
+    }[];
+}
+
+/**
+ * 聊天室成员进入和退出状态
+ */
+declare enum ChatroomUserChangeType {
+    QUIT = 0,
+    JOIN = 1
+}
+
 interface IChatroomEntryListenerData {
     /**
      * 更新的键
@@ -2410,6 +2528,12 @@ interface IChatroomRejoinedSuccessed {
     */
     count: number;
 }
+interface IChatroomUserChangeInfo {
+    users: {
+        [userId: string]: ChatroomUserChangeType;
+    };
+    chatroomId: string;
+}
 declare type IChatroomRejoinedInfo = IChatroomRejoinedFailed | IChatroomRejoinedSuccessed;
 /**
  * 聊天室信息
@@ -2423,6 +2547,11 @@ interface IChatroomListenerData {
      * 监听到的聊天室 KV 更新
     */
     updatedEntries?: IChatroomEntryListenerData[];
+    userChange?: IChatroomUserChangeInfo;
+    /**
+     * 聊天室销毁
+     */
+    chatroomDestroyed?: string;
 }
 
 interface IUpdatedConversation {
@@ -2637,6 +2766,22 @@ declare const ConnectResultCode: {
      * 开启`禁止把已在线客户端踢下线`开关后，该错误码标识已有同类型端在线，禁止链接
      */
     HASOHTERSAMECLIENTONLINE: number;
+    /**
+     * 客户端连错环境，引发连接拒绝
+     */
+    IN_OTHER_CLUSTER: number;
+    /**
+     * app 验证Token 验证不通过。所有内部超时，访问失败,返回给客户端sdk都是验证不通过，由服务端日志去看具体是那种失败。
+     */
+    APP_AUTH_NOT_PASS: number;
+    /**
+     * One Time Password 已经被使用过
+     */
+    OTP_USED: number;
+    /**
+     * token平台验证失败
+     */
+    PLATFORM_ERROR: number;
 };
 
 /**
@@ -2724,9 +2869,25 @@ declare enum MessageType {
      */
     GROUP_READ_RECEIPT_REQUEST = "RC:RRMsg",
     /**
-     * 消息送达报告，仅单聊
+     * 用户加入聊天室
+     */
+    CHATROOM_JOIN = "RC:ChrmJoinNtf",
+    /**
+     * 用户退出聊天室
+     */
+    CHATROOM_LEFT = "RC:ChrmQuitNtf",
+    /**
+     * 用户加入退出聊天室的集合
+     */
+    CHATROOM_MERGE_CHANGE = "RC:ChrmMemChange",
+    /**
+     * 输入状态消息
+     */
+    TYPING_STATUS = "RC:TypSts",
+    /**
+     * 拦截消息,（当发送的消息的敏感词时，服务会下发一个拦截消息，内容包含被拦截消息信息）
      */
-    DELIVERED = "RC:Delivered"
+    INTERCEPT = "RC:InterceptMsg"
 }
 
 /**
@@ -2990,6 +3151,10 @@ interface INaviInfo {
      * 群组回执开关, 1: 打开，0(或者没有): 关闭
      */
     grpRRVer?: number;
+    /**
+     * 防黑产开关, 1: 打开，0：关闭
+     */
+    openAnti?: number;
 }
 
 /**
@@ -3033,1147 +3198,1176 @@ interface ITypingMessage {
 }
 
 /**
- * 消息送达相关接口
+ * 消息被拦截类型
  */
-
-interface IDeliveredUser {
-    time: number;
-    userId: string;
-}
-interface IGroupMessageDeliverInfo {
-    totalCount: number;
-    list: IDeliveredUser[];
-}
-interface IMessageDeliver {
-    deliverTime: number;
-    messageUId: string;
-    conversationType: ConversationType;
-    targetId: string;
+declare enum MessageBlockType {
+    /*!
+    全局敏感词：命中了融云内置的全局敏感词
+   */
+    GLOBAL = 1,
+    /*!
+     自定义敏感词拦截：命中了客户在融云自定义的敏感词
+    */
+    CUSTOM = 2,
+    /*!
+     第三方审核拦截：命中了第三方（数美）或模板路由决定不下发的状态
+    */
+    THIRD_PARTY = 3
 }
 
 /**
- * engine 基本接口定义，用于约束 Electron 下主进程、渲染进程、JSEngine 的编码一致性
+ * 被拦截的消息信息
  */
-interface IEngine {
-    /**
-     * 建立连接
-     * @param token
-     * @param naviInfo
-     */
-    connect(token: string, naviInfo: INaviInfo, versionInfo: string): Promise<ErrorCode>;
-    /**
-     * 上报版本信息
-     * @param version
-     */
-    reportSDKInfo(version: {
-        [name: string]: string;
-    }): void;
-    /**
-     * 连接时间
-     */
-    getConnectedTime(): number;
-    /**
-     * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
-     * 对于未实现的方法，接口响应 Unsupport 错误码
-     * @param method
-     * @param args
-     */
-    callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
-    /**
-     * 获取历史消息
-     * @param conversationType
-     * @param targetId
-     * @param timestamp
-     * @param count
-     * @param order
-     */
-    getHistoryMessage(conversationType: ConversationType, targetId: string, 
-    /**
-     * 拉取时间戳，值为 `0` 表示从当前时间拉取
-     */
-    timestamp: number, 
+interface IBlockedMessageInfo {
+    blockedMessageUId: string;
+    conversationType: number;
+    targetId: string;
+    blockType: MessageBlockType;
+}
+
+interface IConnectResult {
     /**
-     * 获取条数, 有效值 `1` - `20`
+     * 连接错误码
      */
-    count: number, 
+    code: ErrorCode;
     /**
-     * @description
-     * 1. `0` 表示升序，获取消息发送时间比传入 `sentTime` 小 的消息
-     * 2. `1` 表示降序，获取消息发送时间比传入 `sentTime` 大 的消息
+     * 导航获取成功后即可有相应的值，在导航数据获取完成之前该值为 undefined
      */
-    order: 0 | 1, 
+    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;
+declare type IMessageBlockedListener = (data: IBlockedMessageInfo) => void;
+interface ISendExMsgOptions {
+    channelId: string;
+    conversationType: ConversationType;
+    targetId: string;
     /**
-     * 会话的业务标识
+     * 消息 ID
     */
-    channelId: string, 
-    /**
-     * 消息类型
-     */
-    objectName: string): IPromiseResult<{
-        list: IReceivedMessage[];
-        hasMore: boolean;
-    }>;
+    messageUId: string;
     /**
-     * 删除历史消息 通过 messageUId
+     * 原始消息是否支持扩展的字段
     */
-    deleteRemoteMessage(conversationType: ConversationType, targetId: string, 
+    canIncludeExpansion: boolean;
     /**
-     * @description
-     * message 中 messageUId、setTime、messageDirection 为必须参数
+     * 删除的 keys
     */
-    messages: {
-        messageUId: string;
-        sentTime: number;
-        messageDirection: MessageDirection;
-    }[], 
+    keys?: string[];
     /**
-     * 会话的业务标识
+     * 扩展对象
     */
-    channelId: string): Promise<ErrorCode>;
-    recallMsg(conversationType: ConversationType, targetId: string, messageUId: string, sentTime: number, recallMsgOptions: IRecallMsgOptions): IPromiseResult<IReceivedMessage>;
+    expansion?: {
+        [key: string]: string;
+    };
     /**
-     * 删除历史消息 通过 时间戳
-     * @param timestamp 小于等于传入时间戳的消息均删除
+     * 是否删除所有扩展
     */
-    deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, 
+    removeAll?: boolean;
     /**
-     * 会话的业务标识
+     * 原始消息的扩展
     */
-    channelId: string): Promise<ErrorCode>;
+    originExpansion?: {
+        [key: string]: string;
+    } | null;
+}
+interface IWatcher {
+    message?: IMessageListnenr;
+    connectionState?: IConnectionStatusListener;
+    conversationState?: IConversationStateListener;
+    chatroomState?: IChatroomListener;
+    expansion?: IExpansionListener;
     /**
-     * 获取会话列表
-     * @param count 指定获取数量, 不传则获取全部会话列表，默认 `300`
+     * 为兼容老版本 RTCLib 与 CallLib 接收消息的方式，新版本消息走插件机制
      */
-    getConversationList(
+    rtcInnerWatcher?: IRTCInnerListener;
     /**
-     * 拉取数量, 有效值 0 - 1000, 默认 300
+     * 标签的增删改监听
      */
-    count: number, 
+    tag?: ITagListener;
     /**
-     * 会话类型
-     * @todo 待确认是否生效
+     * 会话中标签状态变更监听
      */
-    conversationType?: ConversationType, 
+    conversationTagChanged?: IConversationTagListener;
     /**
-     * 起始时间
-    */
-    startTime?: number, 
+     * 输入状态变更监听
+     */
+    typingState?: ItypingStateListener;
     /**
-     * 获取顺序
-    */
-    order?: 0 | 1, 
+     * 是否拉取完毕添加通知
+     */
+    pullFinished?: ITagListener;
     /**
-     * 会话的业务标识
-    */
-    channelId?: string): IPromiseResult<IReceivedConversation[]>;
-    /**
-     * 获取指定会话
-    */
-    getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
-    /**
-     * 删除会话
-     * @description 该删除操作会删除服务器端存储的会话数据
-     * @param conversationType
-     * @param targetId
+     * 敏感词被拦截监听
      */
-    removeConversation(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
+    messageBlocked?: IMessageBlockedListener;
+}
+interface IPluginGenerator<API, InitOption> {
     /**
-     * 获取所有会话未读数
-     * @param channelId 多组织 Id
-     * @param conversationTypes
-     * @param includeMuted 包含已设置免打扰的会话
+     * 只读插件标识
      */
-    getAllConversationUnreadCount(channelId: string, conversationTypes: ConversationType[], includeMuted: boolean): IPromiseResult<number>;
+    readonly tag: string;
     /**
-     * 获取指定会话未读数
+     * 版本号
      */
-    getConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<number>;
+    readonly version?: string;
     /**
-     * 清除指定会话未读数
+     * 插件名称
      */
-    clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
+    readonly name?: string;
     /**
-     * 获取第一个未读消息
+     * 插件安装前的环境检测，通过返回 boolean 值确认插件是否可运行
      */
-    getFirstUnreadMessage(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedMessage | null>;
+    verify(runtime: IRuntime): boolean;
     /**
-     * 设置/保存指定会话消息草稿
-     * @draft 草稿内容
+     * 插件初始化
+     * @param context 插件调用上下文，用于实现插件的消息注册、消息首发等
+     * @param runtime 运行时实例，用于标识最终的运行时平台
+     * @param options 初始化参数
      */
-    saveConversationMessageDraft(conversationType: ConversationType, targetId: string, draft: string): Promise<ErrorCode>;
+    setup(context: PluginContext, runtime: IRuntime, options: InitOption): API;
+}
+interface IAPIContextOption {
     /**
-     * 获取指定会话消息草稿
+     * 应用 appkey
      */
-    getConversationMessageDraft(conversationType: ConversationType, targetId: string): IPromiseResult<string>;
+    appkey: string;
     /**
-     * 清除指定会话消息草稿
+     * IMLib 版本号
      */
-    clearConversationMessageDraft(conversationType: ConversationType, targetId: string): Promise<ErrorCode>;
+    apiVersion: string;
     /**
-     * 从服务端拉取会话状态
+     * 自定义导航地址:
+     * 1. 私有云环境下该值为必填项
+     * 2. 当存在自定义导航地址时，SDK 内部默认地址将无效
+     * 3. 当存在自定义导航地址时，地址 url 中需包含 http/https 协议头，否则视为无效值
+     * 4. 建立 ws/wss 连接前的 ping 接口使用的协议与导航 url 中的协议相同
+     * 5. 建立 websocket 建立连接时将根据 ping 接口使用的 http/https 协议来确定使用 ws/wss 协议
+     * 6. 动态导航使用的协议头将与自定义导航地址相同
+     * 7. 公有云默认使用 https 协议
      */
-    pullConversationStatus(timestamp: number): Promise<IAsyncRes<IServerConversationStatus[]>>;
+    navigators: string[];
     /**
-     * 批量设置会话 置顶、免打扰
-     */
-    batchSetConversationStatus(statusList: ISetConversationStatusOptions[]): Promise<ErrorCode>;
-    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void): IPromiseResult<IReceivedMessage>;
+     * (参数已废弃)~~c++ 协议栈数据库地址~~
+     * @deprecated
+    */
+    dbPath?: string;
     /**
-     * 断开连接
+     * 小程序的 CMP 代理地址
      */
-    disconnect(): void;
+    miniCMPProxy: string[];
     /**
-     * 拉取用户级配置数据
+     * 指定默认使用的连接类型
      */
-    pullUserSettings(version: number): IPromiseResult<IServerUserSetting>;
+    connectionType: 'websocket' | 'comet';
     /**
-     * 消息注册
-     * @description
-     * 消息注册需在应用初始化完成前进行，否则在搭配 C++ 协议栈使用时，
-     * 本端发出的消息将不默认作为未知消息处理，不存储、不计数
-     * @param objectName 消息类型，如：RC:TxtMsg
-     * @param isPersited 是否存储
-     * @param isCounted 是否技术
-     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     * 修改 engine log 打印等级
      */
-    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[]): void;
-    /**
-     * 加入聊天室
-     * @param count 拉取消息数量
-    */
-    joinChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
+    logLevel?: LogLevel;
     /**
-     * 加入已存在的聊天室
-     * @param count 拉取消息数量
-    */
-    joinExistChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
+     * 修改默认的 log 输出函数
+     */
+    logStdout?: (logLevel: LogLevel, content: string) => void;
     /**
-     * 退出聊天室
-    */
-    quitChatroom(chatroomId: string): Promise<ErrorCode>;
+     * （已废弃）私有云标识
+     * @deprecated
+     */
+    isEnterPrise?: boolean;
     /**
-     * 获取聊天室信息
-     * @param count 获取人数, 范围 0 - 20
-     * @param order 排序方式, 1 正序, 2 倒序
-    */
-    getChatroomInfo(chatroomId: string, count: number, order: number): IPromiseResult<IChatroomInfo>;
+     * typing状态过期时间
+     */
+    typingExpireTime?: number;
     /**
-     * 获取聊天室历史消息
-    */
-    getChatroomHistoryMessages(chatroomId: string, timestamp: number, count: number, order: number): IPromiseResult<{
-        list: IReceivedMessage[];
-        hasMore: boolean;
-    }>;
+     * 是否打开 IndexDB 存储，默认为 true
+     */
+    indexDBSwitch?: boolean;
     /**
-     * 设置聊天室属性
-    */
-    setChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+     * 是否校验证书，默认为 true
+     */
+    checkCA?: boolean;
+}
+declare class APIContext {
+    private _runtime;
+    private static _context?;
+    static init(runtime: IRuntime, options: IAPIContextOption): APIContext;
+    static destroy(): void;
+    private _token;
     /**
-     * 强制设置聊天室属性
-    */
-    forceSetChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+     * 插件队列，用于逐一派发消息与信令
+     */
+    private _pluginContextQueue;
     /**
-     * 删除聊天室属性
-    */
-    removeChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+     * 插件实例Map，用于重复初始化时返回实例
+     */
+    private _pluginInstanseMap;
+    private readonly _engine;
     /**
-     * 强制删除聊天室属性
-    */
-    forceRemoveChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+     * 核心库版本号，后期与 4.0 IM SDK 版本号保持一致
+     */
+    readonly coreVersion: string;
+    readonly appkey: string;
+    readonly apiVersion: string;
+    private readonly _options;
+    private _versionInfo;
+    private _typingInfo;
     /**
-      * 获取聊天室 key 对应 value
-    */
-    getChatroomEntry(chatroomId: string, key: string): IPromiseResult<string | null>;
+     * 内部连接状态标识，为 ture 时不允许调用 reconnect 方法
+     */
+    private _isInternalConnected;
+    constructor(_runtime: IRuntime, options: IAPIContextOption);
     /**
-      * 获取聊天室所有 key value
-    */
-    getAllChatroomEntry(chatroomId: string): IPromiseResult<{
-        [key: string]: string;
-    }>;
+     * 安装使用插件，并初始化插件实例
+     * @param plugin
+     * @param options
+     */
+    install<T, O>(plugin: IPluginGenerator<T, O>, options: O): T | null;
+    private _connectionStatus;
+    private _canRedirectConnect;
     /**
-     * 获取上传认证信息
-     * @description
-     * 若不传 fileName 百度上传认证字段（bosToken、bosDate、path）均返回 null
-    */
-    getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string): Promise<IAsyncRes<IUploadAuth>>;
+     * 重定向后，递归调用 connect
+     */
+    private _handleRedirect;
     /**
-     * 获取文件上传后下载地址
-    */
-    getFileUrl(fileType: FileType, uploadMethod: UploadMethod, fileName?: string, originName?: string): IPromiseResult<{
-        downloadUrl: string;
-    }>;
+     * 连接状态变更回调
+     * @param message
+     */
+    private _connectionStatusListener;
+    private _messageReceiver;
     /**
-     * 创建标签
-     * @param tag 标签
+     * 聊天室相关信息监听
     */
-    createTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
+    private _chatroomInfoListener;
     /**
-     * 删除标签
-     * @param tagId 标签id
+     * 会话监听相关
     */
-    removeTag(tagId: string): IPromiseResult<IAsyncRes>;
+    private _conversationInfoListener;
     /**
-     * 编辑标签
-     * @param tag 标签
+     * 消息扩展监听相关
     */
-    updateTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
+    private _expansionInfoListener;
     /**
-     * 获取标签列表
+     * 标签增删改监听
      */
-    getTagList(): IPromiseResult<Array<ITagInfo>>;
+    private _tagListener;
     /**
-     * 添加会话到标签（给多个会话增加标签）
-     * @param tagId 标签id
-     * @param conversations 要添加的会话列表
+     * 会话标签状态监听
      */
-    addTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult<IAsyncRes>;
+    private _conversationTagListener;
+    private _typingStatusListener;
+    private _pullFinishedListener;
+    private _MessageBlockedListener;
     /**
-     * 删除标签中的会话(从多个会话中批量删除指定标签)
-     * @param tagId 标签id
-     * @param conversations 要删除的会话列表
+     * rtc 数据变更通知 pluginContext
      */
-    removeTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult<IAsyncRes>;
+    private _rtcDataChange;
     /**
-     * 删除会话中的标签(从单一会话中批量删除标签)
-     * @param conversationType 会话类型
-     * @param targetId 会话id
-     * @param tagIds 要删除的标签列表
+     * 业务层事件监听器挂载点
      */
-    removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): IPromiseResult<IAsyncRes>;
+    private _watcher;
     /**
-     * 获取标签下的会话列表
-     * @param tagId 标签id
+     * 添加事件监听
+     * @param options
      */
-    getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): IPromiseResult<IReceivedConversationByTag[]>;
+    assignWatcher(watcher: IWatcher): void;
     /**
-     * 获取标签下的未读消息数
-     * @param tagId 标签id
-     * @param containMuted 是否包含免打扰会话
+     * 向内存中添加 typing 信息
+     * 添加 typing 时不触发通知，只有在轮询时间点校验 _typingChangedList 的长度大于 0 时才通知
      */
-    getUnreadCountByTag(tagId: string, containMuted: boolean): IPromiseResult<number>;
+    private _addTypingInfo;
+    private _typingInternalTimer;
+    private _typingExpireTime;
+    private _typingChangedList;
     /**
-     * 设置标签中会话置顶
-     * @param conversation 会话
+     * 启动定时移除typing
      */
-    setConversationStatusInTag(tagId: string, conversation: IConversationOption, status: ITagStatus): IPromiseResult<IAsyncRes>;
+    private _startCheckTypingInfo;
+    getConnectedTime(): number;
+    getServerTime(): number;
+    getDeviceId(): string;
+    getCurrentUserId(): string;
+    getConnectionStatus(): ConnectionStatus;
     /**
-     * 获取会话里的标签
-     * @param config
+     * 建立连接，连接失败则抛出异常，连接成功后返回用户 userId，否则返回相应的错误码
+     * @param token
+     * @param refreshNavi 是否需要重新请求导航，当值为 `false` 时，优先使用有效缓存导航，若缓存失效则重新获取导航
      */
-    getTagsForConversation(conversation: IConversationOption): IPromiseResult<IConversationTag[]>;
+    connect(token: string, refreshNavi?: boolean): Promise<IConnectResult>;
     /**
-     * 发送群组消息已读回执
-     * 导航下发已读回执开关为 true 时调用
+     * 拉取实时配置 web 端需更新 voipCall 字段
      */
-    sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
+    private _pullUserSettings;
+    disconnect(): Promise<void>;
+    reconnect(): Promise<IConnectResult>;
+    private _getTokenWithoutNavi;
     /**
-     * 获取群组消息已读列表
+     * 获取当前缓存的导航数据
      */
-    getMessageReader(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IMessageReaderResponse>;
+    getInfoFromCache(): INaviInfo | null;
     /**
-     * 获取服务器时间
+     * 消息注册
+     * @description 消息注册需在应用初始化完成前进行
+     * @param objectName 消息类型，如：RC:TxtMsg
+     * @param isPersited 是否存储
+     * @param isCounted 是否技术
+     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
      */
-    getServerTime(): number;
+    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[]): void;
     /**
-     * 获取设备ID
+     * 发送消息
+     * @param conversationType
+     * @param targetId
+     * @param objectName
+     * @param content
+     * @param options
      */
-    getDeviceId(): string;
-    /**
-     * 设置用户在线状态监听器
-    */
-    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[]>;
-    /**
-      * 获取指定人员在黑名单中的状态
-    */
-    getBlacklistStatus(userId: string): IPromiseResult<string>;
-    /**
-     * 向本地插入一条消息，不发送到服务器
-    */
-    insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): IPromiseResult<IReceivedMessage>;
-    /**
-     * 删除本地消息
-    */
-    deleteMessages(timestamps: number[]): Promise<ErrorCode>;
-    /**
-     * 通过时间戳删除本地消息
-    */
-    deleteMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, channelId: string): Promise<ErrorCode>;
-    /**
-     * 清空会话下历史消息
-    */
-    clearMessages(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
-    /**
-     * 获取消息
-    */
-    getMessage(messageId: number): IPromiseResult<IReceivedMessage>;
-    /**
-     * 设置消息内容
-    */
-    setMessageContent(messageId: number, content: any, messageType: string): Promise<ErrorCode>;
-    /**
-     * 设置消息搜索字段
-    */
-    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[];
+    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void): Promise<IAsyncRes<IReceivedMessage>>;
     /**
-     * 设置消息发送状态
+     * 发送扩展消息
+     * @param messageUId 消息 Id
+     * @param keys 需要删除的 key
+     * @param expansion 设置的扩展
     */
-    setMessageSentStatus(messageId: number, sentStatus: number): Promise<ErrorCode>;
+    sendExpansionMessage(options: ISendExMsgOptions): Promise<IAsyncRes<ErrorCode>>;
     /**
-     * 设置消息接收状态
-    */
-    setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<ErrorCode>;
+     * 发送群组消息已读回执
+     * 导航下发已读回执开关为 true 时调用
+     * @param targetId 群组会话id
+     * @param messageUIds 消息id
+     */
+    sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
     /**
-     * 删除时间戳前的未读数
-    */
-    clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId: string): Promise<ErrorCode>;
+     * 获取群组消息已读列表
+     * @param targetId
+     * @param messageUIds
+     */
+    getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<IMessageReaderResponse>>;
     /**
-     * 获取会话免打扰状态
-    */
-    getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationStatus>;
+     * 反初始化，清空所有监听及计时器
+     */
+    private _destroy;
     /**
-     * 协议栈获取远端历史消息
-    */
-    getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, order: 0 | 1, channelId: string): IPromiseResult<{
+     * @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<{
         list: IReceivedMessage[];
         hasMore: boolean;
-    }>;
+    }>>;
     /**
-     * 获取群组消息送达列表
+     * 获取会话列表
+     * @param count 指定获取数量, 不传则获取全部会话列表，默认 `300`
      */
-    getGroupMessageDeliverList(targetId: string, messageUId: string, channelId: string): IPromiseResult<IGroupMessageDeliverInfo>;
+    getConversationList(count?: number, conversationType?: ConversationType, startTime?: number, order?: 0 | 1, channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
     /**
-     * 获取单聊消息送达详情
+     * 获取单一会话数据
+     * @param conversationType
+     * @param targetId
+     * @param channelId
      */
-    getPrivateMessageDeliverTime(messageUId: string, channelId: string): IPromiseResult<number>;
-    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>;
+    getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
     /**
-     * 全量订阅资源修改
-     * @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>;
-    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>;
-    setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
-}
-
-interface IExpansionMsgContent {
-    /**
-     * 消息扩展的对象
-    */
-    put?: {
-        [key: string]: string;
-    };
-    /**
-     * 删除的 keys
-    */
-    del?: string[];
-    /**
-     * messageUId
-    */
-    mid: string;
+    removeConversation(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
     /**
-     * 是否删除所有, 有效值：0、1 . ( 后续如有需要, API Layer 层可使用)
-    */
-    removeAll?: number;
-}
-
-interface IConnectResult {
+     * 清除会话消息未读数
+     */
+    clearUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
     /**
-     * 连接错误码
+     * 获取指定会话消息未读数
      */
-    code: ErrorCode;
+    getUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<number>>;
     /**
-     * 导航获取成功后即可有相应的值，在导航数据获取完成之前该值为 undefined
+     * 获取所有会话未读数
+     * @param channelId 多组织 Id
+     * @param conversationTypes
+     * @param includeMuted 包含已设置免打扰的会话
      */
-    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;
-declare type IMessageDeliveredListener = (data: IMessageDeliver[]) => void;
-interface ISendExMsgOptions {
-    channelId: string;
-    conversationType: ConversationType;
-    targetId: string;
+    getTotalUnreadCount(channelId: string, conversationTypes?: ConversationType[], includeMuted?: boolean): Promise<IAsyncRes<number>>;
     /**
-     * 消息 ID
-    */
-    messageUId: 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>>;
     /**
-     * 原始消息是否支持扩展的字段
-    */
-    canIncludeExpansion: boolean;
+     * 删除远端消息
+     * @param conversationType
+     * @param targetId
+     * @param list
+     */
+    deleteRemoteMessage(conversationType: ConversationType, targetId: string, list: {
+        messageUId: string;
+        sentTime: number;
+        messageDirection: MessageDirection;
+    }[], channelId?: string): Promise<ErrorCode>;
     /**
-     * 删除的 keys
-    */
-    keys?: string[];
+     * 根据时间戳删除指定时间之前的
+     * @param conversationType
+     * @param targetId
+     * @param timestamp
+     */
+    deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
     /**
-     * 扩展对象
-    */
-    expansion?: {
-        [key: string]: string;
-    };
+     * 加入聊天室，若聊天室不存在则创建聊天室
+     * @param roomId 聊天室房间 Id
+     * @param count 进入聊天室成功后，自动拉取的历史消息数量，默认值为 `10`，最大有效值为 `50`，`-1` 为不拉取
+     */
+    joinChatroom(roomId: string, count?: number): Promise<ErrorCode>;
     /**
-     * 是否删除所有扩展
-    */
-    removeAll?: boolean;
+     * 加入聊天室，若聊天室不存在则抛出异常
+     * @param roomId 聊天室房间 Id
+     * @param count 进入聊天室成功后，自动拉取的历史消息数量，默认值为 `10`，最大有效值为 `50`，`-1` 为不拉取
+     */
+    joinExistChatroom(roomId: string, count?: number): Promise<ErrorCode>;
     /**
-     * 原始消息的扩展
-    */
-    originExpansion?: {
-        [key: string]: string;
-    } | null;
-}
-interface IWatcher {
-    message?: IMessageListnenr;
-    connectionState?: IConnectionStatusListener;
-    conversationState?: IConversationStateListener;
-    chatroomState?: IChatroomListener;
-    expansion?: IExpansionListener;
+     * 退出聊天室
+     * @param roomId
+     */
+    quitChatroom(roomId: string): Promise<ErrorCode>;
     /**
-     * 为兼容老版本 RTCLib 与 CallLib 接收消息的方式，新版本消息走插件机制
+     * 获取聊天室房间数据
+     * @description count 或 order 有一个为 0 时，只返回成员总数，不返回成员列表信息
+     * @param roomId 聊天室 Id
+     * @param count 获取房间人员列表数量，最大有效值 `20`，最小值未 `0`，默认为 0
+     * @param order 人员排序方式，`1` 为正序，`2` 为倒序，默认为 0
      */
-    rtcInnerWatcher?: IRTCInnerListener;
+    getChatroomInfo(roomId: string, count?: number, order?: 0 | 1 | 2): Promise<IAsyncRes<IChatroomInfo>>;
     /**
-     * 标签的增删改监听
+     * 在指定聊天室中设置自定义属性
+     * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
+     * @param roomId 聊天室房间 id
+     * @param entry 属性信息
      */
-    tag?: ITagListener;
+    setChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
+    setChatroomEntries(roomId: string, entryOptions: IChatroomEntries): Promise<{
+        code: ErrorCode;
+        data?: any;
+    }>;
     /**
-     * 会话中标签状态变更监听
+     * 在指定聊天室中强制增加 / 修改任意聊天室属性
+     * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
+     * @param roomId 聊天室房间 id
+     * @param entry 属性信息
      */
-    conversationTagChanged?: IConversationTagListener;
+    forceSetChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
     /**
-     * 输入状态变更监听
+     * 删除聊天室属性
+     * @description 该方法仅限于删除自己设置的聊天室属性
+     * @param roomId 聊天室房间 id
+     * @param entry 要移除的属性信息
      */
-    typingState?: ItypingStateListener;
+    removeChatroomEntry(roomId: string, entry: IRemoveChatRoomEntryOption): Promise<ErrorCode>;
     /**
-     * 是否拉取完毕添加通知
+     * 批量删除聊天室属性
+     * @description 该方法仅限于删除自己设置的聊天室属性
+     * @param roomId 聊天室房间 id
+     * @param entry 要移除的属性信息
      */
-    pullFinished?: ITagListener;
+    removeChatroomEntries(roomId: string, entryOptions: IRemoveChatRoomEntriesOption): Promise<{
+        code: ErrorCode;
+        data?: any;
+    }>;
     /**
-     * 单聊消息送达通知
+     * 强制删除任意聊天室属性
+     * @description 该方法仅限于删除自己设置的聊天室属性
+     * @param roomId 聊天室房间 id
+     * @param entry 要移除的属性信息
      */
-    messageDelivered?: IMessageDeliveredListener;
-}
-interface IPluginGenerator<API, InitOption> {
+    forceRemoveChatroomEntry(roomId: string, entry: IRemoveChatRoomEntryOption): Promise<ErrorCode>;
     /**
-     * 只读插件标识
+     * 获取聊天室中的指定属性
+     * @param roomId 聊天室房间 id
+     * @param key 属性键名
      */
-    readonly tag: string;
+    getChatroomEntry(roomId: string, key: string): Promise<IAsyncRes<string | null>>;
     /**
-     * 版本号
+     * 获取聊天室内的所有属性
+     * @param roomId 聊天室房间 id
      */
-    readonly version?: string;
+    getAllChatroomEntries(roomId: string): Promise<IAsyncRes<{
+        [key: string]: string;
+    }>>;
     /**
-     * 插件名称
+     * 拉取聊天室内的历史消息
+     * @param roomId
+     * @param count 拉取消息条数, 有效值范围 `1 - 20`
+     * @param order 获取顺序，默认值为 0。
+     * * 0：降序，用于获取早于指定时间戳发送的消息
+     * * 1：升序，用于获取晚于指定时间戳发送的消息
+     * @param timestamp 指定拉取消息用到的时间戳。默认值为 `0`，表示按当前时间拉取
      */
-    readonly name?: string;
+    getChatRoomHistoryMessages(roomId: string, count?: number, order?: 0 | 1, timestamp?: number): Promise<IAsyncRes<{
+        list: IReceivedMessage[];
+        hasMore: boolean;
+    }>>;
     /**
-     * 插件安装前的环境检测，通过返回 boolean 值确认插件是否可运行
+     * 获取存储服务鉴权信息
+     * @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
      */
-    verify(runtime: IRuntime): boolean;
+    getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string): Promise<IUploadAuth & {
+        bos: string;
+        qiniu: string;
+    }>;
     /**
-     * 插件初始化
-     * @param context 插件调用上下文，用于实现插件的消息注册、消息首发等
-     * @param runtime 运行时实例，用于标识最终的运行时平台
-     * @param options 初始化参数
+     * 获取 七牛、百度、阿里云 上传成功可下载的 URL
+     * @param fileType 文件类型
+     * @param fileName 文件名
+     * @param saveName 下载后的存储文件名
+     * @param uploadRes 插件上传返回的结果。降级百度上传后，用户传入返回结果，再把结果里的下载地址返回给用户，保证兼容之前结果获取
+     * @param serverType 使用的存储服务标识
+    */
+    getFileUrl(fileType: FileType, fileName?: string, saveName?: string, uploadRes?: {
+        isBosRes: boolean;
+        downloadUrl: string;
+    }, serverType?: UploadMethod): Promise<{
+        downloadUrl: string;
+    }>;
+    /**
+     * 创建标签
+     * @param tag 标签
      */
-    setup(context: PluginContext, runtime: IRuntime, options: InitOption): API;
-}
-interface IAPIContextOption {
+    createTag(tag: ITagParam): Promise<IAsyncRes>;
     /**
-     * 应用 appkey
+     * 删除标签
+     * @param tagId 标签id
      */
-    appkey: string;
+    removeTag(tagId: string): Promise<IAsyncRes>;
     /**
-     * IMLib 版本号
+     * 更新标签
+     * @param tag 标签
      */
-    apiVersion: string;
+    updateTag(tag: ITagParam): Promise<IAsyncRes>;
     /**
-     * 自定义导航地址:
-     * 1. 私有云环境下该值为必填项
-     * 2. 当存在自定义导航地址时，SDK 内部默认地址将无效
-     * 3. 当存在自定义导航地址时，地址 url 中需包含 http/https 协议头，否则视为无效值
-     * 4. 建立 ws/wss 连接前的 ping 接口使用的协议与导航 url 中的协议相同
-     * 5. 建立 websocket 建立连接时将根据 ping 接口使用的 http/https 协议来确定使用 ws/wss 协议
-     * 6. 动态导航使用的协议头将与自定义导航地址相同
-     * 7. 公有云默认使用 https 协议
+     * 获取标签列表
      */
-    navigators: string[];
+    getTagList(): Promise<IAsyncRes<Array<ITagInfo>>>;
     /**
-     * (参数已废弃)~~c++ 协议栈数据库地址~~
-     * @deprecated
-    */
-    dbPath?: string;
+     * 添加会话到标签（给多个会话增加标签）
+     * @param tagId 标签id
+     * @param conversations 要添加的会话列表
+     */
+    addTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<IAsyncRes>>;
     /**
-     * 小程序的 CMP 代理地址
+     * 删除标签中的会话(从多个会话中批量删除指定标签)
+     * @param tagId 标签id
+     * @param conversations 要删除的会话列表
      */
-    miniCMPProxy: string[];
+    removeTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<IAsyncRes>>;
     /**
-     * 指定默认使用的连接类型
+     * 删除会话中的标签(从单一会话中批量删除标签)
+     * @param conversationType 会话类型
+     * @param targetId 会话id
+     * @param tagIds 要删除的标签列表
      */
-    connectionType: 'websocket' | 'comet';
+    removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): Promise<IAsyncRes<IAsyncRes>>;
     /**
-     * 修改 engine log 打印等级
+     * 获取标签下的会话列表
+     * @param tagId 标签id
      */
-    logLevel?: LogLevel;
+    getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): Promise<IAsyncRes<IReceivedConversationByTag[]>>;
     /**
-     * 修改默认的 log 输出函数
+     * 获取标签下的未读消息数
+     * @param tagId 标签id
+     * @param containMuted 是否包含免打扰会话
      */
-    logStdout?: (logLevel: LogLevel, content: string) => void;
+    getUnreadCountByTag(tagId: string, containMuted: boolean): Promise<IAsyncRes<number>>;
     /**
-     * （已废弃）私有云标识
-     * @deprecated
+     * 设置标签中会话置顶
+     * @param conversation 会话
      */
-    isEnterPrise?: boolean;
+    setConversationStatusInTag(tagId: string, conversation: IConversationOption, status: {
+        isTop: boolean;
+    }): Promise<IAsyncRes<IAsyncRes>>;
     /**
-     * typing状态过期时间
+     * 获取会话里的标签
+     * @param conversation
      */
-    typingExpireTime?: number;
+    getTagsForConversation(conversation: IConversationOption): Promise<IAsyncRes<IConversationTag[]>>;
     /**
-     * 是否打开 IndexDB 存储，默认为 true
+     * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
+     * 对于未实现的方法，接口响应 Unsupport 错误码
+     * @param method 方法名
+     * @param args
      */
-    indexDBSwitch?: boolean;
+    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>>;
     /**
-     * 是否校验证书，默认为 true
-     */
-    checkCA?: boolean;
-}
-declare class APIContext {
-    private _runtime;
-    private static _context?;
-    static init(runtime: IRuntime, options: IAPIContextOption): APIContext;
-    static destroy(): void;
-    private _token;
+     * 删除本地消息
+    */
+    deleteMessages(timestamp: number[]): Promise<ErrorCode>;
     /**
-     * 插件队列，用于逐一派发消息与信令
-     */
-    private _pluginContextQueue;
+     * 从本地消息数据库中删除某一会话指定时间之前的消息数据
+    */
+    deleteMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, channelId?: string): Promise<ErrorCode>;
     /**
-     * 插件实例Map，用于重复初始化时返回实例
-     */
-    private _pluginInstanseMap;
-    private readonly _engine;
+     * 清空会话下历史消息
+    */
+    clearMessages(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
     /**
-     * 核心库版本号，后期与 4.0 IM SDK 版本号保持一致
-     */
-    readonly coreVersion: string;
-    readonly appkey: string;
-    readonly apiVersion: string;
-    private readonly _options;
-    private _versionInfo;
-    private _typingInfo;
+     * 获取本地消息
+    */
+    getMessage(messageId: number): Promise<IAsyncRes<IReceivedMessage>>;
     /**
-     * 内部连接状态标识，为 ture 时不允许调用 reconnect 方法
-     */
-    private _isInternalConnected;
-    constructor(_runtime: IRuntime, options: IAPIContextOption);
+     * 设置消息内容
+    */
+    setMessageContent(messageId: number, content: any, messageType: string): Promise<ErrorCode>;
     /**
-     * 安装使用插件，并初始化插件实例
-     * @param plugin
-     * @param options
-     */
-    install<T, O>(plugin: IPluginGenerator<T, O>, options: O): T | null;
-    private _connectionStatus;
-    private _canRedirectConnect;
+     * 设置消息搜索字段
+    */
+    setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<ErrorCode>;
     /**
-     * 重定向后，递归调用 connect
-     */
-    private _handleRedirect;
+     * 设置消息发送状态
+    */
+    setMessageSentStatus(messageId: number, sentStatus: number): Promise<ErrorCode>;
     /**
-     * 连接状态变更回调
-     * @param message
-     */
-    private _connectionStatusListener;
-    private _messageReceiver;
+    * 设置消息接收状态
+    */
+    setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<ErrorCode>;
     /**
-     * 聊天室相关信息监听
+     * 设置当前用户在线状态
     */
-    private _chatroomInfoListener;
+    setUserStatus(status: number): Promise<ErrorCode>;
     /**
-     * 会话监听相关
+     * 订阅用户在线状态
     */
-    private _conversationInfoListener;
+    subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
     /**
-     * 消息扩展监听相关
+     * 获取用户在线状态
     */
-    private _expansionInfoListener;
+    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;
+    }>>;
+    /**
+     * 加入房间
+     * @param roomId
+     * @param mode 房间模式：直播 or 会议
+     * @param mediaType 直播房间模式下的媒体资源类型
      */
-    private _tagListener;
+    joinRTCRoom(roomId: string, mode: RTCMode, mediaType?: number, joinType?: RTCJoinType): 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 _conversationTagListener;
-    private _typingStatusListener;
-    private _pullFinishedListener;
-    private _messageDeliveredListerer;
+    joinLivingRoomAsAudience(roomId: string, mode: RTCMode, broadcastType?: number): Promise<IAsyncRes<{
+        token: string;
+        kvEntries: IServerRTCRoomEntry[];
+    }>>;
     /**
-     * rtc 数据变更通知 pluginContext
+     * 直播观众退出房间
      */
-    private _rtcDataChange;
+    quitLivingRoomAsAudience(roomId: string): Promise<ErrorCode>;
     /**
-     * 业务层事件监听器挂载点
+     * 直播身份切换
      */
-    private _watcher;
+    rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
     /**
-     * 添加事件监听
-     * @param options
+     * 获取加入 RTC 房间的用户信息（当前仅能查自己的）
      */
-    assignWatcher(watcher: IWatcher): void;
+    getRTCJoinedUserInfo(userId: string): Promise<IAsyncRes<IRTCJoinedInfo[]>>;
+}
+
+/**
+ * engine 基本接口定义，用于约束 Electron 下主进程、渲染进程、JSEngine 的编码一致性
+ */
+interface IEngine {
     /**
-     * 向内存中添加 typing 信息
-     * 添加 typing 时不触发通知，只有在轮询时间点校验 _typingChangedList 的长度大于 0 时才通知
+     * 建立连接
+     * @param token
+     * @param naviInfo
      */
-    private _addTypingInfo;
-    private _typingInternalTimer;
-    private _typingExpireTime;
-    private _typingChangedList;
+    connect(token: string, naviInfo: INaviInfo, versionInfo: string): Promise<ErrorCode>;
     /**
-     * 启动定时移除typing
+     * 上报版本信息
+     * @param version
+     */
+    reportSDKInfo(version: {
+        [name: string]: string;
+    }): void;
+    /**
+     * 连接时间
      */
-    private _startCheckTypingInfo;
     getConnectedTime(): number;
-    getServerTime(): number;
-    getDeviceId(): string;
-    getCurrentUserId(): string;
-    getConnectionStatus(): ConnectionStatus;
     /**
-     * 建立连接，连接失败则抛出异常，连接成功后返回用户 userId，否则返回相应的错误码
-     * @param token
-     * @param refreshNavi 是否需要重新请求导航，当值为 `false` 时，优先使用有效缓存导航，若缓存失效则重新获取导航
+     * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
+     * 对于未实现的方法，接口响应 Unsupport 错误码
+     * @param method
+     * @param args
      */
-    connect(token: string, refreshNavi?: boolean): Promise<IConnectResult>;
+    callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
     /**
-     * 拉取实时配置 web 端需更新 voipCall 字段
+     * 获取历史消息
+     * @param conversationType
+     * @param targetId
+     * @param timestamp
+     * @param count
+     * @param order
      */
-    private _pullUserSettings;
-    disconnect(): Promise<void>;
-    reconnect(): Promise<IConnectResult>;
-    private _getTokenWithoutNavi;
+    getHistoryMessage(conversationType: ConversationType, targetId: string, 
     /**
-     * 获取当前缓存的导航数据
+     * 拉取时间戳，值为 `0` 表示从当前时间拉取
      */
-    getInfoFromCache(): INaviInfo | null;
+    timestamp: number, 
     /**
-     * 消息注册
-     * @description 消息注册需在应用初始化完成前进行
-     * @param objectName 消息类型，如：RC:TxtMsg
-     * @param isPersited 是否存储
-     * @param isCounted 是否技术
-     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     * 获取条数, 有效值 `1` - `20`
      */
-    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[]): void;
+    count: number, 
     /**
-     * 发送消息
-     * @param conversationType
-     * @param targetId
-     * @param objectName
-     * @param content
-     * @param options
+     * @description
+     * 1. `0` 表示升序，获取消息发送时间比传入 `sentTime` 小 的消息
+     * 2. `1` 表示降序，获取消息发送时间比传入 `sentTime` 大 的消息
      */
-    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void): Promise<IAsyncRes<IReceivedMessage>>;
+    order: 0 | 1, 
+    /**
+     * 会话的业务标识
+    */
+    channelId: string, 
+    /**
+     * 消息类型
+     */
+    objectName: string): IPromiseResult<{
+        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 messageUId 消息 Id
-     * @param keys 需要删除的 key
-     * @param expansion 设置的扩展
+     * 删除历史消息 通过 时间戳
+     * @param timestamp 小于等于传入时间戳的消息均删除
     */
-    sendExpansionMessage(options: ISendExMsgOptions): Promise<IAsyncRes<ErrorCode>>;
+    deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, 
     /**
-     * 发送群组消息已读回执
-     * 导航下发已读回执开关为 true 时调用
-     * @param targetId 群组会话id
-     * @param messageUIds 消息id
-     */
-    sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
+     * 会话的业务标识
+    */
+    channelId: string): Promise<ErrorCode>;
     /**
-     * 获取群组消息已读列表
-     * @param targetId
-     * @param messageUIds
+     * 获取会话列表
+     * @param count 指定获取数量, 不传则获取全部会话列表，默认 `300`
      */
-    getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<IMessageReaderResponse>>;
+    getConversationList(
     /**
-     * 反初始化，清空所有监听及计时器
+     * 拉取数量, 有效值 0 - 1000, 默认 300
      */
-    private _destroy;
+    count: number, 
     /**
-     * @param conversationType
-     * @param targetId 会话 Id
-     * @param timestamp 拉取时间戳
-     * @param count 拉取条数
-     * @param order 1 正序拉取，0 为倒序拉取
-     * @param channelId
-     * @param objectName
+     * 会话类型
+     * @todo 待确认是否生效
      */
-    getHistoryMessage(conversationType: ConversationType, targetId: string, timestamp?: number, count?: number, order?: 0 | 1, channelId?: string, objectName?: string): Promise<IAsyncRes<{
-        list: IReceivedMessage[];
-        hasMore: boolean;
-    }>>;
+    conversationType?: ConversationType, 
     /**
-     * 获取会话列表
-     * @param count 指定获取数量, 不传则获取全部会话列表，默认 `300`
-     */
-    getConversationList(count?: number, conversationType?: ConversationType, startTime?: number, order?: 0 | 1, channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
+     * 起始时间
+    */
+    startTime?: number, 
     /**
-     * 获取单一会话数据
-     * @param conversationType
-     * @param targetId
-     * @param channelId
-     */
-    getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
+     * 获取顺序
+    */
+    order?: 0 | 1, 
     /**
-     * 删除会话
-     */
-    removeConversation(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
+     * 会话的业务标识
+    */
+    channelId?: string): IPromiseResult<IReceivedConversation[]>;
     /**
-     * 清除会话消息未读数
-     */
-    clearUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
+     * 获取指定会话
+    */
+    getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
     /**
-     * 获取指定会话消息未读数
+     * 删除会话
+     * @description 该删除操作会删除服务器端存储的会话数据
+     * @param conversationType
+     * @param targetId
      */
-    getUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<number>>;
+    removeConversation(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
     /**
      * 获取所有会话未读数
      * @param channelId 多组织 Id
      * @param conversationTypes
      * @param includeMuted 包含已设置免打扰的会话
      */
-    getTotalUnreadCount(channelId: string, conversationTypes?: ConversationType[], includeMuted?: boolean): Promise<IAsyncRes<number>>;
+    getAllConversationUnreadCount(channelId: string, conversationTypes: ConversationType[], includeMuted: boolean): 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>>;
+    getConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<number>;
     /**
-     * 删除远端消息
-     * @param conversationType
-     * @param targetId
-     * @param list
+     * 清除指定会话未读数
      */
-    deleteRemoteMessage(conversationType: ConversationType, targetId: string, list: {
-        messageUId: string;
-        sentTime: number;
-        messageDirection: MessageDirection;
-    }[], channelId?: string): Promise<ErrorCode>;
+    clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
     /**
-     * 根据时间戳删除指定时间之前的
-     * @param conversationType
-     * @param targetId
-     * @param timestamp
+     * 获取第一个未读消息
      */
-    deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
+    getFirstUnreadMessage(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedMessage | null>;
     /**
-     * 加入聊天室，若聊天室不存在则创建聊天室
-     * @param roomId 聊天室房间 Id
-     * @param count 进入聊天室成功后，自动拉取的历史消息数量，默认值为 `10`，最大有效值为 `50`，`-1` 为不拉取
+     * 设置/保存指定会话消息草稿
+     * @draft 草稿内容
      */
-    joinChatroom(roomId: string, count?: number): Promise<ErrorCode>;
+    saveConversationMessageDraft(conversationType: ConversationType, targetId: string, draft: string): Promise<ErrorCode>;
     /**
-     * 加入聊天室，若聊天室不存在则抛出异常
-     * @param roomId 聊天室房间 Id
-     * @param count 进入聊天室成功后，自动拉取的历史消息数量，默认值为 `10`，最大有效值为 `50`，`-1` 为不拉取
+     * 获取指定会话消息草稿
      */
-    joinExistChatroom(roomId: string, count?: number): Promise<ErrorCode>;
+    getConversationMessageDraft(conversationType: ConversationType, targetId: string): IPromiseResult<string>;
     /**
-     * 退出聊天室
-     * @param roomId
+     * 清除指定会话消息草稿
      */
-    quitChatroom(roomId: string): Promise<ErrorCode>;
+    clearConversationMessageDraft(conversationType: ConversationType, targetId: string): Promise<ErrorCode>;
     /**
-     * 获取聊天室房间数据
-     * @description count 或 order 有一个为 0 时，只返回成员总数，不返回成员列表信息
-     * @param roomId 聊天室 Id
-     * @param count 获取房间人员列表数量，最大有效值 `20`，最小值未 `0`，默认为 0
-     * @param order 人员排序方式，`1` 为正序，`2` 为倒序，默认为 0
+     * 从服务端拉取会话状态
      */
-    getChatroomInfo(roomId: string, count?: number, order?: 0 | 1 | 2): Promise<IAsyncRes<IChatroomInfo>>;
+    pullConversationStatus(timestamp: number): Promise<IAsyncRes<IServerConversationStatus[]>>;
     /**
-     * 在指定聊天室中设置自定义属性
-     * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
-     * @param roomId 聊天室房间 id
-     * @param entry 属性信息
+     * 批量设置会话 置顶、免打扰
      */
-    setChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
+    batchSetConversationStatus(statusList: ISetConversationStatusOptions[]): Promise<ErrorCode>;
+    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void): IPromiseResult<IReceivedMessage>;
     /**
-     * 在指定聊天室中强制增加 / 修改任意聊天室属性
-     * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
-     * @param roomId 聊天室房间 id
-     * @param entry 属性信息
+     * 断开连接
      */
-    forceSetChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
+    disconnect(): void;
     /**
-     * 删除聊天室属性
-     * @description 该方法仅限于删除自己设置的聊天室属性
-     * @param roomId 聊天室房间 id
-     * @param entry 要移除的属性信息
+     * 拉取用户级配置数据
      */
-    removeChatroomEntry(roomId: string, entry: IRemoveChatRoomEntryOption): Promise<ErrorCode>;
+    pullUserSettings(version: number): IPromiseResult<IServerUserSetting>;
     /**
-     * 强制删除任意聊天室属性
-     * @description 该方法仅限于删除自己设置的聊天室属性
-     * @param roomId 聊天室房间 id
-     * @param entry 要移除的属性信息
+     * 消息注册
+     * @description
+     * 消息注册需在应用初始化完成前进行，否则在搭配 C++ 协议栈使用时，
+     * 本端发出的消息将不默认作为未知消息处理，不存储、不计数
+     * @param objectName 消息类型，如：RC:TxtMsg
+     * @param isPersited 是否存储
+     * @param isCounted 是否技术
+     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
      */
-    forceRemoveChatroomEntry(roomId: string, entry: IRemoveChatRoomEntryOption): Promise<ErrorCode>;
+    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[]): void;
     /**
-     * 获取聊天室中的指定属性
-     * @param roomId 聊天室房间 id
-     * @param key 属性键名
-     */
-    getChatroomEntry(roomId: string, key: string): Promise<IAsyncRes<string | null>>;
+     * 加入聊天室
+     * @param count 拉取消息数量
+    */
+    joinChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
     /**
-     * 获取聊天室内的所有属性
-     * @param roomId 聊天室房间 id
-     */
-    getAllChatroomEntries(roomId: string): Promise<IAsyncRes<{
-        [key: string]: string;
-    }>>;
+     * 加入已存在的聊天室
+     * @param count 拉取消息数量
+    */
+    joinExistChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
     /**
-     * 拉取聊天室内的历史消息
-     * @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<{
+     * 退出聊天室
+    */
+    quitChatroom(chatroomId: string): Promise<ErrorCode>;
+    /**
+     * 获取聊天室信息
+     * @param count 获取人数, 范围 0 - 20
+     * @param order 排序方式, 1 正序, 2 倒序
+    */
+    getChatroomInfo(chatroomId: string, count: number, order: number): IPromiseResult<IChatroomInfo>;
+    /**
+     * 获取聊天室历史消息
+    */
+    getChatroomHistoryMessages(chatroomId: string, timestamp: number, count: number, order: number): IPromiseResult<{
         list: IReceivedMessage[];
         hasMore: boolean;
-    }>>;
+    }>;
     /**
-     * 获取存储服务鉴权信息
-     * @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
+     * 设置聊天室属性
+    */
+    setChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+    /**
+     * 批量设置聊天室属性
      */
-    getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string): Promise<IUploadAuth & {
-        bos: string;
-        qiniu: string;
+    setChatroomEntries(chatroomId: string, entry: IChrmKVEntries): Promise<{
+        code: ErrorCode;
+        data?: any;
+    }>;
+    /**
+     * 强制设置聊天室属性
+    */
+    forceSetChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+    /**
+     * 删除聊天室属性
+    */
+    removeChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+    /**
+     * 批量删除聊天室属性
+     */
+    removeChatroomEntries(chatroomId: string, entries: IChrmKVEntries): Promise<{
+        code: ErrorCode;
+        data?: any;
     }>;
     /**
-     * 获取 七牛、百度、阿里云 上传成功可下载的 URL
-     * @param fileType 文件类型
-     * @param fileName 文件名
-     * @param saveName 下载后的存储文件名
-     * @param uploadRes 插件上传返回的结果。降级百度上传后，用户传入返回结果，再把结果里的下载地址返回给用户，保证兼容之前结果获取
-     * @param serverType 使用的存储服务标识
+     * 强制删除聊天室属性
+    */
+    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;
+    }>;
+    /**
+     * 获取上传认证信息
+     * @description
+     * 若不传 fileName 百度上传认证字段（bosToken、bosDate、path）均返回 null
+    */
+    getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string): Promise<IAsyncRes<IUploadAuth>>;
+    /**
+     * 获取文件上传后下载地址
     */
-    getFileUrl(fileType: FileType, fileName?: string, saveName?: string, uploadRes?: {
-        isBosRes: boolean;
-        downloadUrl: string;
-    }, serverType?: UploadMethod): Promise<{
+    getFileUrl(fileType: FileType, uploadMethod: UploadMethod, fileName?: string, originName?: string): IPromiseResult<{
         downloadUrl: string;
     }>;
     /**
      * 创建标签
      * @param tag 标签
-     */
-    createTag(tag: ITagParam): Promise<IAsyncRes>;
+    */
+    createTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
     /**
      * 删除标签
      * @param tagId 标签id
-     */
-    removeTag(tagId: string): Promise<IAsyncRes>;
+    */
+    removeTag(tagId: string): IPromiseResult<IAsyncRes>;
     /**
-     * 更新标签
+     * 编辑标签
      * @param tag 标签
-     */
-    updateTag(tag: ITagParam): Promise<IAsyncRes>;
+    */
+    updateTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
     /**
      * 获取标签列表
      */
-    getTagList(): Promise<IAsyncRes<Array<ITagInfo>>>;
+    getTagList(): IPromiseResult<Array<ITagInfo>>;
     /**
      * 添加会话到标签（给多个会话增加标签）
      * @param tagId 标签id
      * @param conversations 要添加的会话列表
      */
-    addTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<IAsyncRes>>;
+    addTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult<IAsyncRes>;
     /**
      * 删除标签中的会话(从多个会话中批量删除指定标签)
      * @param tagId 标签id
      * @param conversations 要删除的会话列表
      */
-    removeTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<IAsyncRes>>;
+    removeTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult<IAsyncRes>;
     /**
      * 删除会话中的标签(从单一会话中批量删除标签)
      * @param conversationType 会话类型
      * @param targetId 会话id
      * @param tagIds 要删除的标签列表
      */
-    removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): Promise<IAsyncRes<IAsyncRes>>;
+    removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): IPromiseResult<IAsyncRes>;
     /**
      * 获取标签下的会话列表
      * @param tagId 标签id
      */
-    getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): Promise<IAsyncRes<IReceivedConversationByTag[]>>;
+    getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): IPromiseResult<IReceivedConversationByTag[]>;
     /**
      * 获取标签下的未读消息数
      * @param tagId 标签id
      * @param containMuted 是否包含免打扰会话
      */
-    getUnreadCountByTag(tagId: string, containMuted: boolean): Promise<IAsyncRes<number>>;
+    getUnreadCountByTag(tagId: string, containMuted: boolean): IPromiseResult<number>;
     /**
      * 设置标签中会话置顶
      * @param conversation 会话
      */
-    setConversationStatusInTag(tagId: string, conversation: IConversationOption, status: {
-        isTop: boolean;
-    }): Promise<IAsyncRes<IAsyncRes>>;
+    setConversationStatusInTag(tagId: string, conversation: IConversationOption, status: ITagStatus): IPromiseResult<IAsyncRes>;
     /**
      * 获取会话里的标签
-     * @param conversation
+     * @param config
      */
-    getTagsForConversation(conversation: IConversationOption): Promise<IAsyncRes<IConversationTag[]>>;
+    getTagsForConversation(conversation: IConversationOption): IPromiseResult<IConversationTag[]>;
     /**
-     * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
-     * 对于未实现的方法，接口响应 Unsupport 错误码
-     * @param method 方法名
-     * @param args
+     * 发送群组消息已读回执
+     * 导航下发已读回执开关为 true 时调用
      */
-    callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
+    sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
     /**
-     * 删除所有会话
-    */
-    clearConversations(conversationTypes?: ConversationType[], tag?: string): Promise<ErrorCode>;
+     * 获取群组消息已读列表
+     */
+    getMessageReader(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IMessageReaderResponse>;
     /**
-     * 设置用户连接状态监听器
+     * 获取服务器时间
+     */
+    getServerTime(): number;
+    /**
+     * 获取设备ID
+     */
+    getDeviceId(): string;
+    /**
+     * 获取当前 userId
+     */
+    getCurrentUserId(): string;
+    /**
+     * 设置用户在线状态监听器
     */
     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(): Promise<IAsyncRes<string[]>>;
+    getBlacklist(): IPromiseResult<string[]>;
     /**
-     * 获取指定人员在黑名单中的状态
+      * 获取指定人员在黑名单中的状态
     */
-    getBlacklistStatus(userId: string): Promise<IAsyncRes<string>>;
+    getBlacklistStatus(userId: string): IPromiseResult<string>;
     /**
      * 向本地插入一条消息，不发送到服务器
     */
-    insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): Promise<IAsyncRes<IReceivedMessage>>;
+    insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): IPromiseResult<IReceivedMessage>;
     /**
      * 删除本地消息
     */
-    deleteMessages(timestamp: number[]): Promise<ErrorCode>;
+    deleteMessages(timestamps: 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): Promise<IAsyncRes<IReceivedMessage>>;
+    getMessage(messageId: number): IPromiseResult<IReceivedMessage>;
     /**
      * 设置消息内容
     */
@@ -4183,61 +4377,48 @@ declare class APIContext {
     */
     setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<ErrorCode>;
     /**
-     * 设置消息发送状态
+     * 通过关键字搜索会话
     */
-    setMessageSentStatus(messageId: number, sentStatus: number): Promise<ErrorCode>;
+    searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
     /**
-    * 设置消息接收状态
+     * 按内容搜索会话内的消息
     */
-    setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<ErrorCode>;
+    searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, channelId: string): IPromiseResult<{
+        messages: IReceivedMessage[];
+        count: number;
+    }>;
     /**
-     * 设置当前用户在线状态
+     * 获取会话下所有未读的 @ 消息
     */
-    setUserStatus(status: number): Promise<ErrorCode>;
+    getUnreadMentionedMessages(conversationType: ConversationType, targetId: string, channelId: string): IReceivedMessage[];
     /**
-     * 订阅用户在线状态
+     * 设置消息发送状态
     */
-    subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
+    setMessageSentStatus(messageId: number, sentStatus: number): Promise<ErrorCode>;
     /**
-     * 获取用户在线状态
+     * 设置消息接收状态
     */
-    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>;
+    setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<ErrorCode>;
+    /**
+     * 删除时间戳前的未读数
+    */
+    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<{
+    getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationStatus>;
+    /**
+     * 协议栈获取远端历史消息
+    */
+    getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, order: 0 | 1, channelId: string): IPromiseResult<{
         list: IReceivedMessage[];
         hasMore: boolean;
-    }>>;
-    /**
-     * 获取群组消息送达信息
-     */
-    getGroupMessageDeliverList(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IGroupMessageDeliverInfo>;
-    /**
-     * 获取单聊消息送达信息
-     */
-    getPrivateMessageDeliverTime(messageUId: string, channelId?: string): IPromiseResult<number>;
-    /**
-     * 加入房间
-     * @param roomId
-     * @param mode 房间模式：直播 or 会议
-     * @param mediaType 直播房间模式下的媒体资源类型
-     */
-    joinRTCRoom(roomId: string, mode: RTCMode, mediaType?: number, joinType?: RTCJoinType): Promise<IAsyncRes<IJoinRTCRoomData>>;
+    }>;
+    joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number): IPromiseResult<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>>;
+    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>;
@@ -4245,43 +4426,49 @@ declare class APIContext {
         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>;
-    setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
-    getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): Promise<IAsyncRes<KVString>>;
+    }, 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): Promise<IAsyncRes<IRtcTokenData>>;
-    setRTCState(roomId: string, report: string): Promise<ErrorCode>;
+    getRTCToken(roomId: string, mode: number, broadcastType?: number): IPromiseResult<IRtcTokenData>;
+    setRTCState(roomId: string, reportId: string): Promise<ErrorCode>;
     getRTCUserList(roomId: string): IPromiseResult<IRTCUsers>;
+    setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
+}
+
+interface IExpansionMsgContent {
     /**
-     * 直播观众加房间
-     */
-    joinLivingRoomAsAudience(roomId: string, mode: RTCMode, broadcastType?: number): Promise<IAsyncRes<{
-        token: string;
-    }>>;
-    /**
-     * 直播观众退出房间
-     */
-    quitLivingRoomAsAudience(roomId: string): Promise<ErrorCode>;
+     * 消息扩展的对象
+    */
+    put?: {
+        [key: string]: string;
+    };
     /**
-     * 直播身份切换
-     */
-    rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
+     * 删除的 keys
+    */
+    del?: string[];
     /**
-     * 获取加入 RTC 房间的用户信息（当前仅能查自己的）
-     */
-    getRTCJoinedUserInfo(userId: string): Promise<IAsyncRes<IRTCJoinedInfo[]>>;
+     * messageUId
+    */
+    mid: string;
     /**
-     * 拉取 RTC 全量 KV
-     */
-    pullRTCRoomEntry(roomId: string, timestamp: number): Promise<IAsyncRes<IChrmKVPullData>>;
+     * 是否删除所有, 有效值：0、1 . ( 后续如有需要, API Layer 层可使用)
+    */
+    removeAll?: number;
 }
 
 declare class RTCPluginContext extends PluginContext {
@@ -4367,6 +4554,7 @@ declare class RTCPluginContext extends PluginContext {
      */
     joinLivingRoomAsAudience(roomId: string, mode: RTCMode, broadcastType?: number): IPromiseResult<{
         token: string;
+        kvEntries: IServerRTCRoomEntry[];
     }>;
     /**
      * 直播观众退出房间
@@ -4376,10 +4564,6 @@ declare class RTCPluginContext extends PluginContext {
      * 直播身份切换
      */
     rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): IPromiseResult<IJoinRTCRoomData>;
-    /**
-     * 拉取 RTC 全量 KV
-     */
-    pullRTCRoomEntry(roomId: string, timestamp: number): IPromiseResult<IChrmKVPullData>;
 }
 
 declare abstract class ANavi {
@@ -4428,7 +4612,6 @@ interface IEngineWatcher {
      */
     onRTCDataChange: (data: IServerRTCRoomEntry[], roomId?: string) => void;
     pullFinished: () => void;
-    messageDelivered: (data: IMessageDeliver[]) => void;
 }
 /**
  * 引擎定义
@@ -4680,6 +4863,13 @@ declare abstract class AEngine implements IEngine {
      * 设置聊天室属性
     */
     abstract setChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+    /**
+     * 批量设置聊天室属性
+     */
+    abstract setChatroomEntries(chatroomId: string, entry: IChrmKVEntries): Promise<{
+        code: ErrorCode;
+        data?: any;
+    }>;
     /**
      * 强制设置聊天室属性
     */
@@ -4688,6 +4878,13 @@ declare abstract class AEngine implements IEngine {
      * 删除聊天室属性
     */
     abstract removeChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+    /**
+     * 批量删除聊天室属性
+     */
+    abstract removeChatroomEntries(chatroomId: string, entry: IChrmKVEntries): Promise<{
+        code: ErrorCode;
+        data?: any;
+    }>;
     /**
      * 强制删除聊天室属性
     */
@@ -4794,6 +4991,10 @@ declare abstract class AEngine implements IEngine {
      * 获取设备ID
      */
     abstract getDeviceId(): string;
+    /**
+     * 获取当前 userId
+     */
+    abstract getCurrentUserId(): string;
     /**
      * 设置用户在线状态监听器
     */
@@ -4900,14 +5101,6 @@ declare abstract class AEngine implements IEngine {
         list: IReceivedMessage[];
         hasMore: boolean;
     }>;
-    /**
-     * 获取群组消息送达列表
-     */
-    abstract getGroupMessageDeliverList(targetId: string, messageUId: string, channelId: string): IPromiseResult<IGroupMessageDeliverInfo>;
-    /**
-     * 获取单聊消息送达列表
-     */
-    abstract getPrivateMessageDeliverTime(messageUId: string, channelId: string): IPromiseResult<number>;
     abstract joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType): IPromiseResult<IJoinRTCRoomData>;
     abstract quitRTCRoom(roomId: string): Promise<ErrorCode>;
     abstract rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
@@ -4943,12 +5136,12 @@ 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 getRTCJoinedUserInfo(userId: string): Promise<IAsyncRes<IRTCJoinedInfo[]>>;
     abstract setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
-    abstract pullRTCRoomEntry(roomId: string, timestamp: number): Promise<IAsyncRes<IChrmKVPullData>>;
 }
 
 declare class AppStorage {
@@ -5110,6 +5303,19 @@ declare class EventEmitter {
     clear(): void;
 }
 
+declare class VersionManage {
+    static add(name: string, version: string): void;
+    /**
+     * 校验当前 engine 版本是否大于等于所需版本，只校验前三位数字
+     * @param version
+     * @returns
+    */
+    static validEngine(version: string): boolean;
+    static getInfo(): {
+        [key: string]: string;
+    };
+}
+
 /**
  * 检查参数是否为字符串
  * 只做类型检查，不做长度检查，故当字符串长度为 0，结果依然为 true
@@ -5399,4 +5605,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, IDeliveredUser, IEngine, IEngineWatcher, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGroupMessageDeliverInfo, IInsertMsgOptions, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, 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, RTCJoinType, 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, IBlockedMessageInfo, IChatroomEntries, IChatroomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, 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, IMessageBlockedListener, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomInfo, IRTCUsers, IReadReceiptInfo, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntriesOption, 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, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UploadMethod, VersionManage, 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 };