@rongcloud/engine 4.5.3 → 4.6.0-beem.2

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v4.5.3
- * CommitId - 53f04162f2b6042fd1f3d893800fcb85ecf4ff9e
- * Thu Dec 09 2021 18:05:37 GMT+0800 (China Standard Time)
+ * RCEngine - v4.6.0-beem.2
+ * CommitId - 62a43aacff4328b710113ae921984d364c6f70c1
+ * Tue Jan 25 2022 17:30:10 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -1738,6 +1738,10 @@ interface IRequest {
      * @default 10 * 1000 毫秒
      */
     timeout?: number;
+    /**
+     * 期望返回的数据格式，如果为 json 则返回后会对返回的数据进行一次 JSON.parse, 在小程序平台需要
+     */
+    dataType?: 'json' | 'text' | 'base64' | 'arraybuffer';
 }
 interface IStorage {
     setItem(key: string, value: string): void;
@@ -2634,6 +2638,7 @@ declare class PluginContext {
      * 目前仅通知：主播加入、退出房间的人员列表变更，发布、取消发布资源列表变更
     */
     onrtcdatachange?(data: IServerRTCRoomEntry[], roomdId?: string): void;
+    onCallInfo?(data: string): void;
     /**
      * 获取 `@rongcloud/engine` 包版本
      */
@@ -2677,6 +2682,10 @@ declare class PluginContext {
      * 获取加入 RTC 房间的用户信息（当前仅能查自己的）
      */
     getRTCJoinedUserInfo(userId: string): IPromiseResult<IRTCJoinedInfo[]>;
+    setCallInfo(targetId: string, key: string, value: string): IPromiseResult<{
+        key: string;
+        value: string;
+    }>;
 }
 
 declare enum ReceivedStatus {
@@ -2869,8 +2878,9 @@ declare enum MessageType {
      */
     GROUP_READ_RECEIPT_REQUEST = "RC:RRMsg",
     /**
-     * 用户加入聊天室
+     * 消息送达报告，仅单聊
      */
+    DELIVERED = "RC:Delivered",
     CHATROOM_JOIN = "RC:ChrmJoinNtf",
     /**
      * 用户退出聊天室
@@ -2946,6 +2956,24 @@ declare enum LogType {
     RTC = "RTC"
 }
 
+/**
+ * 消息被拦截类型
+ */
+declare enum MessageBlockType {
+    /*!
+    全局敏感词：命中了融云内置的全局敏感词
+   */
+    GLOBAL = 1,
+    /*!
+     自定义敏感词拦截：命中了客户在融云自定义的敏感词
+    */
+    CUSTOM = 2,
+    /*!
+     第三方审核拦截：命中了第三方（数美）或模板路由决定不下发的状态
+    */
+    THIRD_PARTY = 3
+}
+
 /**
  * 导航信息数据就结构
  */
@@ -3198,1176 +3226,1211 @@ interface ITypingMessage {
 }
 
 /**
- * 消息被拦截类型
+ * 消息送达相关接口
  */
-declare enum MessageBlockType {
-    /*!
-    全局敏感词：命中了融云内置的全局敏感词
-   */
-    GLOBAL = 1,
-    /*!
-     自定义敏感词拦截：命中了客户在融云自定义的敏感词
-    */
-    CUSTOM = 2,
-    /*!
-     第三方审核拦截：命中了第三方（数美）或模板路由决定不下发的状态
-    */
-    THIRD_PARTY = 3
-}
 
-/**
- * 被拦截的消息信息
- */
-interface IBlockedMessageInfo {
-    blockedMessageUId: string;
-    conversationType: number;
+interface IDeliveredUser {
+    time: number;
+    userId: string;
+}
+interface IGroupMessageDeliverInfo {
+    totalCount: number;
+    list: IDeliveredUser[];
+}
+interface IMessageDeliver {
+    deliverTime: number;
+    messageUId: string;
+    conversationType: ConversationType;
     targetId: string;
-    blockType: MessageBlockType;
 }
 
-interface IConnectResult {
+/**
+ * engine 基本接口定义，用于约束 Electron 下主进程、渲染进程、JSEngine 的编码一致性
+ */
+interface IEngine {
     /**
-     * 连接错误码
+     * 建立连接
+     * @param token
+     * @param naviInfo
+     * @param reconnectKickEnable
      */
-    code: ErrorCode;
+    connect(token: string, naviInfo: INaviInfo, reconnectKickEnable?: boolean): Promise<ErrorCode>;
     /**
-     * 导航获取成功后即可有相应的值，在导航数据获取完成之前该值为 undefined
+     * 上报版本信息
+     * @param version
      */
-    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;
+    reportSDKInfo(version: {
+        [name: string]: string;
+    }): void;
     /**
-     * 消息 ID
+     * 连接时间
+     */
+    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, 
+    /**
+     * 获取条数, 有效值 `1` - `20`
+     */
+    count: number, 
+    /**
+     * @description
+     * 1. `0` 表示升序，获取消息发送时间比传入 `sentTime` 小 的消息
+     * 2. `1` 表示降序，获取消息发送时间比传入 `sentTime` 大 的消息
+     */
+    order: 0 | 1, 
+    /**
+     * 会话的业务标识
     */
-    messageUId: string;
+    channelId: string, 
     /**
-     * 原始消息是否支持扩展的字段
+     * 消息类型
+     */
+    objectName: string): IPromiseResult<{
+        list: IReceivedMessage[];
+        hasMore: boolean;
+    }>;
+    /**
+     * 删除历史消息 通过 messageUId
     */
-    canIncludeExpansion: boolean;
+    deleteRemoteMessage(conversationType: ConversationType, targetId: string, 
     /**
-     * 删除的 keys
+     * @description
+     * message 中 messageUId、setTime、messageDirection 为必须参数
     */
-    keys?: string[];
+    messages: {
+        messageUId: string;
+        sentTime: number;
+        messageDirection: MessageDirection;
+    }[], 
     /**
-     * 扩展对象
+     * 会话的业务标识
     */
-    expansion?: {
-        [key: string]: string;
-    };
+    channelId: string): Promise<ErrorCode>;
+    recallMsg(conversationType: ConversationType, targetId: string, messageUId: string, sentTime: number, recallMsgOptions: IRecallMsgOptions): IPromiseResult<IReceivedMessage>;
     /**
-     * 是否删除所有扩展
+     * 删除历史消息 通过 时间戳
+     * @param timestamp 小于等于传入时间戳的消息均删除
     */
-    removeAll?: boolean;
+    deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, 
     /**
-     * 原始消息的扩展
+     * 会话的业务标识
     */
-    originExpansion?: {
-        [key: string]: string;
-    } | null;
-}
-interface IWatcher {
-    message?: IMessageListnenr;
-    connectionState?: IConnectionStatusListener;
-    conversationState?: IConversationStateListener;
-    chatroomState?: IChatroomListener;
-    expansion?: IExpansionListener;
+    channelId: string): Promise<ErrorCode>;
     /**
-     * 为兼容老版本 RTCLib 与 CallLib 接收消息的方式，新版本消息走插件机制
+     * 获取会话列表
+     * @param count 指定获取数量, 不传则获取全部会话列表，默认 `300`
      */
-    rtcInnerWatcher?: IRTCInnerListener;
+    getConversationList(
     /**
-     * 标签的增删改监听
+     * 拉取数量, 有效值 0 - 1000, 默认 300
      */
-    tag?: ITagListener;
+    count: number, 
     /**
-     * 会话中标签状态变更监听
+     * 会话类型
+     * @todo 待确认是否生效
      */
-    conversationTagChanged?: IConversationTagListener;
+    conversationType?: ConversationType, 
     /**
-     * 输入状态变更监听
+     * 起始时间
+    */
+    startTime?: number, 
+    /**
+     * 获取顺序
+    */
+    order?: 0 | 1, 
+    /**
+     * 会话的业务标识
+    */
+    channelId?: string): IPromiseResult<IReceivedConversation[]>;
+    /**
+     * 获取指定会话
+    */
+    getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
+    /**
+     * 删除会话
+     * @description 该删除操作会删除服务器端存储的会话数据
+     * @param conversationType
+     * @param targetId
      */
-    typingState?: ItypingStateListener;
+    removeConversation(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
     /**
-     * 是否拉取完毕添加通知
+     * 获取所有会话未读数
+     * @param channelId 多组织 Id
+     * @param conversationTypes
+     * @param includeMuted 包含已设置免打扰的会话
      */
-    pullFinished?: ITagListener;
+    getAllConversationUnreadCount(channelId: string, conversationTypes: ConversationType[], includeMuted: boolean): IPromiseResult<number>;
     /**
-     * 敏感词被拦截监听
+     * 获取指定会话未读数
      */
-    messageBlocked?: IMessageBlockedListener;
-}
-interface IPluginGenerator<API, InitOption> {
+    getConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<number>;
     /**
-     * 只读插件标识
+     * 清除指定会话未读数
      */
-    readonly tag: string;
+    clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
     /**
-     * 版本号
+     * 获取第一个未读消息
      */
-    readonly version?: string;
+    getFirstUnreadMessage(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedMessage | null>;
     /**
-     * 插件名称
+     * 设置/保存指定会话消息草稿
+     * @draft 草稿内容
      */
-    readonly name?: string;
+    saveConversationMessageDraft(conversationType: ConversationType, targetId: string, draft: string): Promise<ErrorCode>;
     /**
-     * 插件安装前的环境检测，通过返回 boolean 值确认插件是否可运行
+     * 获取指定会话消息草稿
      */
-    verify(runtime: IRuntime): boolean;
+    getConversationMessageDraft(conversationType: ConversationType, targetId: string): IPromiseResult<string>;
     /**
-     * 插件初始化
-     * @param context 插件调用上下文，用于实现插件的消息注册、消息首发等
-     * @param runtime 运行时实例，用于标识最终的运行时平台
-     * @param options 初始化参数
+     * 清除指定会话消息草稿
      */
-    setup(context: PluginContext, runtime: IRuntime, options: InitOption): API;
-}
-interface IAPIContextOption {
+    clearConversationMessageDraft(conversationType: ConversationType, targetId: string): Promise<ErrorCode>;
     /**
-     * 应用 appkey
+     * 从服务端拉取会话状态
      */
-    appkey: string;
+    pullConversationStatus(timestamp: number): Promise<IAsyncRes<IServerConversationStatus[]>>;
     /**
-     * IMLib 版本号
+     * 批量设置会话 置顶、免打扰
      */
-    apiVersion: string;
+    batchSetConversationStatus(statusList: ISetConversationStatusOptions[]): Promise<ErrorCode>;
+    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void): IPromiseResult<IReceivedMessage>;
     /**
-     * 自定义导航地址:
-     * 1. 私有云环境下该值为必填项
-     * 2. 当存在自定义导航地址时，SDK 内部默认地址将无效
-     * 3. 当存在自定义导航地址时，地址 url 中需包含 http/https 协议头，否则视为无效值
-     * 4. 建立 ws/wss 连接前的 ping 接口使用的协议与导航 url 中的协议相同
-     * 5. 建立 websocket 建立连接时将根据 ping 接口使用的 http/https 协议来确定使用 ws/wss 协议
-     * 6. 动态导航使用的协议头将与自定义导航地址相同
-     * 7. 公有云默认使用 https 协议
-     */
-    navigators: string[];
-    /**
-     * (参数已废弃)~~c++ 协议栈数据库地址~~
-     * @deprecated
-    */
-    dbPath?: string;
-    /**
-     * 小程序的 CMP 代理地址
-     */
-    miniCMPProxy: string[];
-    /**
-     * 指定默认使用的连接类型
+     * 断开连接
      */
-    connectionType: 'websocket' | 'comet';
+    disconnect(): void;
     /**
-     * 修改 engine log 打印等级
+     * 拉取用户级配置数据
      */
-    logLevel?: LogLevel;
+    pullUserSettings(version: number): IPromiseResult<IServerUserSetting>;
     /**
-     * 修改默认的 log 输出函数
+     * 消息注册
+     * @description
+     * 消息注册需在应用初始化完成前进行，否则在搭配 C++ 协议栈使用时，
+     * 本端发出的消息将不默认作为未知消息处理，不存储、不计数
+     * @param objectName 消息类型，如：RC:TxtMsg
+     * @param isPersited 是否存储
+     * @param isCounted 是否技术
+     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
      */
-    logStdout?: (logLevel: LogLevel, content: string) => void;
+    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[]): void;
     /**
-     * （已废弃）私有云标识
-     * @deprecated
-     */
-    isEnterPrise?: boolean;
+     * 加入聊天室
+     * @param count 拉取消息数量
+    */
+    joinChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
     /**
-     * typing状态过期时间
-     */
-    typingExpireTime?: number;
+     * 加入已存在的聊天室
+     * @param count 拉取消息数量
+    */
+    joinExistChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
     /**
-     * 是否打开 IndexDB 存储，默认为 true
-     */
-    indexDBSwitch?: boolean;
+     * 退出聊天室
+    */
+    quitChatroom(chatroomId: string): 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;
+     * 获取聊天室信息
+     * @param count 获取人数, 范围 0 - 20
+     * @param order 排序方式, 1 正序, 2 倒序
+    */
+    getChatroomInfo(chatroomId: string, count: number, order: number): IPromiseResult<IChatroomInfo>;
     /**
-     * 插件队列，用于逐一派发消息与信令
-     */
-    private _pluginContextQueue;
+     * 获取聊天室历史消息
+    */
+    getChatroomHistoryMessages(chatroomId: string, timestamp: number, count: number, order: number): IPromiseResult<{
+        list: IReceivedMessage[];
+        hasMore: boolean;
+    }>;
     /**
-     * 插件实例Map，用于重复初始化时返回实例
-     */
-    private _pluginInstanseMap;
-    private readonly _engine;
+     * 设置聊天室属性
+    */
+    setChatroomEntry(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;
+    setChatroomEntries(chatroomId: string, entry: IChrmKVEntries): Promise<{
+        code: ErrorCode;
+        data?: any;
+    }>;
     /**
-     * 内部连接状态标识，为 ture 时不允许调用 reconnect 方法
-     */
-    private _isInternalConnected;
-    constructor(_runtime: IRuntime, options: IAPIContextOption);
+     * 强制设置聊天室属性
+    */
+    forceSetChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
     /**
-     * 安装使用插件，并初始化插件实例
-     * @param plugin
-     * @param options
-     */
-    install<T, O>(plugin: IPluginGenerator<T, O>, options: O): T | null;
-    private _connectionStatus;
-    private _canRedirectConnect;
+     * 删除聊天室属性
+    */
+    removeChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
     /**
-     * 重定向后，递归调用 connect
+     * 批量删除聊天室属性
      */
-    private _handleRedirect;
+    removeChatroomEntries(chatroomId: string, entries: IChrmKVEntries): Promise<{
+        code: ErrorCode;
+        data?: any;
+    }>;
     /**
-     * 连接状态变更回调
-     * @param message
-     */
-    private _connectionStatusListener;
-    private _messageReceiver;
+     * 强制删除聊天室属性
+    */
+    forceRemoveChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
     /**
-     * 聊天室相关信息监听
+      * 获取聊天室 key 对应 value
     */
-    private _chatroomInfoListener;
+    getChatroomEntry(chatroomId: string, key: string): IPromiseResult<string | null>;
     /**
-     * 会话监听相关
+      * 获取聊天室所有 key value
     */
-    private _conversationInfoListener;
+    getAllChatroomEntry(chatroomId: string): IPromiseResult<{
+        [key: string]: string;
+    }>;
     /**
-     * 消息扩展监听相关
+     * 获取上传认证信息
+     * @description
+     * 若不传 fileName 百度上传认证字段（bosToken、bosDate、path）均返回 null
     */
-    private _expansionInfoListener;
+    getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string): Promise<IAsyncRes<IUploadAuth>>;
     /**
-     * 标签增删改监听
-     */
-    private _tagListener;
+     * 获取文件上传后下载地址
+    */
+    getFileUrl(fileType: FileType, uploadMethod: UploadMethod, fileName?: string, originName?: string): IPromiseResult<{
+        downloadUrl: string;
+    }>;
     /**
-     * 会话标签状态监听
-     */
-    private _conversationTagListener;
-    private _typingStatusListener;
-    private _pullFinishedListener;
-    private _MessageBlockedListener;
+     * 创建标签
+     * @param tag 标签
+    */
+    createTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
     /**
-     * rtc 数据变更通知 pluginContext
-     */
-    private _rtcDataChange;
+     * 删除标签
+     * @param tagId 标签id
+    */
+    removeTag(tagId: string): IPromiseResult<IAsyncRes>;
     /**
-     * 业务层事件监听器挂载点
-     */
-    private _watcher;
+     * 编辑标签
+     * @param tag 标签
+    */
+    updateTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
     /**
-     * 添加事件监听
-     * @param options
+     * 获取标签列表
      */
-    assignWatcher(watcher: IWatcher): void;
+    getTagList(): IPromiseResult<Array<ITagInfo>>;
     /**
-     * 向内存中添加 typing 信息
-     * 添加 typing 时不触发通知，只有在轮询时间点校验 _typingChangedList 的长度大于 0 时才通知
+     * 添加会话到标签（给多个会话增加标签）
+     * @param tagId 标签id
+     * @param conversations 要添加的会话列表
      */
-    private _addTypingInfo;
-    private _typingInternalTimer;
-    private _typingExpireTime;
-    private _typingChangedList;
+    addTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult<IAsyncRes>;
     /**
-     * 启动定时移除typing
+     * 删除标签中的会话(从多个会话中批量删除指定标签)
+     * @param tagId 标签id
+     * @param conversations 要删除的会话列表
      */
-    private _startCheckTypingInfo;
-    getConnectedTime(): number;
-    getServerTime(): number;
-    getDeviceId(): string;
-    getCurrentUserId(): string;
-    getConnectionStatus(): ConnectionStatus;
+    removeTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult<IAsyncRes>;
     /**
-     * 建立连接，连接失败则抛出异常，连接成功后返回用户 userId，否则返回相应的错误码
-     * @param token
-     * @param refreshNavi 是否需要重新请求导航，当值为 `false` 时，优先使用有效缓存导航，若缓存失效则重新获取导航
+     * 删除会话中的标签(从单一会话中批量删除标签)
+     * @param conversationType 会话类型
+     * @param targetId 会话id
+     * @param tagIds 要删除的标签列表
      */
-    connect(token: string, refreshNavi?: boolean): Promise<IConnectResult>;
+    removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): IPromiseResult<IAsyncRes>;
     /**
-     * 拉取实时配置 web 端需更新 voipCall 字段
+     * 获取标签下的会话列表
+     * @param tagId 标签id
      */
-    private _pullUserSettings;
-    disconnect(): Promise<void>;
-    reconnect(): Promise<IConnectResult>;
-    private _getTokenWithoutNavi;
+    getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): IPromiseResult<IReceivedConversationByTag[]>;
     /**
-     * 获取当前缓存的导航数据
+     * 获取标签下的未读消息数
+     * @param tagId 标签id
+     * @param containMuted 是否包含免打扰会话
      */
-    getInfoFromCache(): INaviInfo | null;
+    getUnreadCountByTag(tagId: string, containMuted: boolean): IPromiseResult<number>;
     /**
-     * 消息注册
-     * @description 消息注册需在应用初始化完成前进行
-     * @param objectName 消息类型，如：RC:TxtMsg
-     * @param isPersited 是否存储
-     * @param isCounted 是否技术
-     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     * 设置标签中会话置顶
+     * @param conversation 会话
      */
-    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[]): void;
+    setConversationStatusInTag(tagId: string, conversation: IConversationOption, status: ITagStatus): IPromiseResult<IAsyncRes>;
     /**
-     * 发送消息
-     * @param conversationType
-     * @param targetId
-     * @param objectName
-     * @param content
-     * @param options
+     * 获取会话里的标签
+     * @param config
      */
-    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void): Promise<IAsyncRes<IReceivedMessage>>;
-    /**
-     * 发送扩展消息
-     * @param messageUId 消息 Id
-     * @param keys 需要删除的 key
-     * @param expansion 设置的扩展
-    */
-    sendExpansionMessage(options: ISendExMsgOptions): Promise<IAsyncRes<ErrorCode>>;
+    getTagsForConversation(conversation: IConversationOption): IPromiseResult<IConversationTag[]>;
     /**
      * 发送群组消息已读回执
      * 导航下发已读回执开关为 true 时调用
-     * @param targetId 群组会话id
-     * @param messageUIds 消息id
      */
     sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
     /**
      * 获取群组消息已读列表
-     * @param targetId
-     * @param messageUIds
-     */
-    getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<IMessageReaderResponse>>;
-    /**
-     * 反初始化，清空所有监听及计时器
      */
-    private _destroy;
+    getMessageReader(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IMessageReaderResponse>;
     /**
-     * @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;
-    }>>;
+    getServerTime(): number;
     /**
-     * 获取会话列表
-     * @param count 指定获取数量, 不传则获取全部会话列表，默认 `300`
+     * 获取设备ID
      */
-    getConversationList(count?: number, conversationType?: ConversationType, startTime?: number, order?: 0 | 1, channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
+    getDeviceId(): string;
     /**
-     * 获取单一会话数据
-     * @param conversationType
-     * @param targetId
-     * @param channelId
+     * 获取当前 userId
      */
-    getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
+    getCurrentUserId(): string;
     /**
-     * 删除会话
-     */
-    removeConversation(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
+     * 设置用户在线状态监听器
+    */
+    setUserStatusListener(config: {
+        userIds: string[];
+    }, listener: Function): void;
     /**
-     * 清除会话消息未读数
-     */
-    clearUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
+     * 设置当前用户在线状态
+    */
+    setUserStatus(status: number): Promise<ErrorCode>;
     /**
-     * 获取指定会话消息未读数
-     */
-    getUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<number>>;
+     * 订阅用户在线状态
+    */
+    subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
     /**
-     * 获取所有会话未读数
-     * @param channelId 多组织 Id
-     * @param conversationTypes
-     * @param includeMuted 包含已设置免打扰的会话
-     */
-    getTotalUnreadCount(channelId: string, conversationTypes?: ConversationType[], includeMuted?: boolean): Promise<IAsyncRes<number>>;
+     * 获取用户状态
+    */
+    getUserStatus(userId: string): IPromiseResult<{
+        status: 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>>;
+     * 清空所有会话
+    */
+    clearConversations(conversationTypes?: ConversationType[], channelId?: string): Promise<ErrorCode>;
     /**
-     * 删除远端消息
-     * @param conversationType
-     * @param targetId
-     * @param list
-     */
-    deleteRemoteMessage(conversationType: ConversationType, targetId: string, list: {
-        messageUId: string;
-        sentTime: number;
-        messageDirection: MessageDirection;
-    }[], channelId?: string): Promise<ErrorCode>;
+     * 加入黑名单
+    */
+    addToBlacklist(userId: string): Promise<ErrorCode>;
     /**
-     * 根据时间戳删除指定时间之前的
-     * @param conversationType
-     * @param targetId
-     * @param timestamp
-     */
-    deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
+      * 将指定用户移除黑名单
+    */
+    removeFromBlacklist(userId: string): Promise<ErrorCode>;
     /**
-     * 加入聊天室，若聊天室不存在则创建聊天室
-     * @param roomId 聊天室房间 Id
-     * @param count 进入聊天室成功后，自动拉取的历史消息数量，默认值为 `10`，最大有效值为 `50`，`-1` 为不拉取
-     */
-    joinChatroom(roomId: string, count?: number): Promise<ErrorCode>;
+      * 获取黑名单列表
+    */
+    getBlacklist(): IPromiseResult<string[]>;
     /**
-     * 加入聊天室，若聊天室不存在则抛出异常
-     * @param roomId 聊天室房间 Id
-     * @param count 进入聊天室成功后，自动拉取的历史消息数量，默认值为 `10`，最大有效值为 `50`，`-1` 为不拉取
-     */
-    joinExistChatroom(roomId: string, count?: number): Promise<ErrorCode>;
+      * 获取指定人员在黑名单中的状态
+    */
+    getBlacklistStatus(userId: string): IPromiseResult<string>;
     /**
-     * 退出聊天室
-     * @param roomId
-     */
-    quitChatroom(roomId: string): Promise<ErrorCode>;
+     * 向本地插入一条消息，不发送到服务器
+    */
+    insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): IPromiseResult<IReceivedMessage>;
     /**
-     * 获取聊天室房间数据
-     * @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>>;
+     * 删除本地消息
+    */
+    deleteMessages(timestamps: number[]): Promise<ErrorCode>;
     /**
-     * 在指定聊天室中设置自定义属性
-     * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
-     * @param roomId 聊天室房间 id
-     * @param entry 属性信息
-     */
-    setChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
-    setChatroomEntries(roomId: string, entryOptions: IChatroomEntries): Promise<{
-        code: ErrorCode;
-        data?: any;
-    }>;
+     * 通过时间戳删除本地消息
+    */
+    deleteMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, channelId: string): Promise<ErrorCode>;
     /**
-     * 在指定聊天室中强制增加 / 修改任意聊天室属性
-     * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
-     * @param roomId 聊天室房间 id
-     * @param entry 属性信息
-     */
-    forceSetChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
+     * 清空会话下历史消息
+    */
+    clearMessages(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
     /**
-     * 删除聊天室属性
-     * @description 该方法仅限于删除自己设置的聊天室属性
-     * @param roomId 聊天室房间 id
-     * @param entry 要移除的属性信息
-     */
-    removeChatroomEntry(roomId: string, entry: IRemoveChatRoomEntryOption): Promise<ErrorCode>;
+     * 获取消息
+    */
+    getMessage(messageId: number): IPromiseResult<IReceivedMessage>;
     /**
-     * 批量删除聊天室属性
-     * @description 该方法仅限于删除自己设置的聊天室属性
-     * @param roomId 聊天室房间 id
-     * @param entry 要移除的属性信息
-     */
-    removeChatroomEntries(roomId: string, entryOptions: IRemoveChatRoomEntriesOption): Promise<{
-        code: ErrorCode;
-        data?: any;
-    }>;
+     * 设置消息内容
+    */
+    setMessageContent(messageId: number, content: any, messageType: string): Promise<ErrorCode>;
     /**
-     * 强制删除任意聊天室属性
-     * @description 该方法仅限于删除自己设置的聊天室属性
-     * @param roomId 聊天室房间 id
-     * @param entry 要移除的属性信息
-     */
-    forceRemoveChatroomEntry(roomId: string, entry: IRemoveChatRoomEntryOption): Promise<ErrorCode>;
+     * 设置消息搜索字段
+    */
+    setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<ErrorCode>;
     /**
-     * 获取聊天室中的指定属性
-     * @param roomId 聊天室房间 id
-     * @param key 属性键名
-     */
-    getChatroomEntry(roomId: string, key: string): Promise<IAsyncRes<string | null>>;
+     * 通过关键字搜索会话
+    */
+    searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
     /**
-     * 获取聊天室内的所有属性
-     * @param roomId 聊天室房间 id
-     */
-    getAllChatroomEntries(roomId: string): Promise<IAsyncRes<{
-        [key: string]: string;
-    }>>;
+     * 按内容搜索会话内的消息
+    */
+    searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, channelId: string): IPromiseResult<{
+        messages: IReceivedMessage[];
+        count: number;
+    }>;
     /**
-     * 拉取聊天室内的历史消息
-     * @param roomId
-     * @param count 拉取消息条数, 有效值范围 `1 - 20`
-     * @param order 获取顺序，默认值为 0。
-     * * 0：降序，用于获取早于指定时间戳发送的消息
-     * * 1：升序，用于获取晚于指定时间戳发送的消息
-     * @param timestamp 指定拉取消息用到的时间戳。默认值为 `0`，表示按当前时间拉取
-     */
-    getChatRoomHistoryMessages(roomId: string, count?: number, order?: 0 | 1, timestamp?: number): Promise<IAsyncRes<{
-        list: IReceivedMessage[];
-        hasMore: boolean;
-    }>>;
+     * 获取会话下所有未读的 @ 消息
+    */
+    getUnreadMentionedMessages(conversationType: ConversationType, targetId: string, channelId: string): IReceivedMessage[];
     /**
-     * 获取存储服务鉴权信息
-     * @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
-     */
-    getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string): Promise<IUploadAuth & {
-        bos: string;
-        qiniu: string;
-    }>;
+     * 设置消息发送状态
+    */
+    setMessageSentStatus(messageId: number, sentStatus: number): Promise<ErrorCode>;
     /**
-     * 获取 七牛、百度、阿里云 上传成功可下载的 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;
-    }>;
+    setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<ErrorCode>;
     /**
-     * 创建标签
-     * @param tag 标签
-     */
-    createTag(tag: ITagParam): Promise<IAsyncRes>;
+     * 删除时间戳前的未读数
+    */
+    clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId: string): Promise<ErrorCode>;
     /**
-     * 删除标签
-     * @param tagId 标签id
-     */
-    removeTag(tagId: string): Promise<IAsyncRes>;
+     * 获取会话免打扰状态
+    */
+    getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationStatus>;
     /**
-     * 更新标签
-     * @param tag 标签
-     */
-    updateTag(tag: ITagParam): Promise<IAsyncRes>;
+     * 协议栈获取远端历史消息
+    */
+    getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, order: 0 | 1, channelId: string): IPromiseResult<{
+        list: IReceivedMessage[];
+        hasMore: boolean;
+    }>;
     /**
-     * 获取标签列表
+     * 获取群组消息送达列表
      */
-    getTagList(): Promise<IAsyncRes<Array<ITagInfo>>>;
+    getGroupMessageDeliverList(targetId: string, messageUId: string, channelId: string): IPromiseResult<IGroupMessageDeliverInfo>;
     /**
-     * 添加会话到标签（给多个会话增加标签）
-     * @param tagId 标签id
-     * @param conversations 要添加的会话列表
+     * 获取单聊消息送达详情
      */
-    addTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<IAsyncRes>>;
+    getPrivateMessageDeliverTime(messageUId: string, channelId: string): IPromiseResult<number>;
+    setCallInfo(targetId: string, key: string, value: string): IPromiseResult<{
+        key: string;
+        value: string;
+    }>;
+    joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number): IPromiseResult<IJoinRTCRoomData>;
+    quitRTCRoom(roomId: string): Promise<ErrorCode>;
+    rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
+    getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
+    getRTCUserInfoList(roomId: string): IPromiseResult<IRTCUsers>;
+    getRTCUserInfo(roomId: string): IPromiseResult<unknown>;
+    setRTCUserInfo(roomId: string, key: string, value: string): Promise<ErrorCode>;
+    removeRTCUserInfo(roomId: string, keys: string[]): Promise<ErrorCode>;
+    setRTCData(roomId: string, key: string, value: string, isInner: boolean, apiType: RTCApiType, message?: {
+        name: string;
+        content: string;
+    }): Promise<ErrorCode>;
     /**
-     * 删除标签中的会话(从多个会话中批量删除指定标签)
-     * @param tagId 标签id
-     * @param conversations 要删除的会话列表
+     * 全量订阅资源修改
+     * @param roomId 房间 Id
+     * @param message 向前兼容的消息内容
+     * @param valueInfo 全量资源数据
+     * @param objectName 全量 URI 消息名
      */
-    removeTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<IAsyncRes>>;
+    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 {
     /**
-     * 删除会话中的标签(从单一会话中批量删除标签)
-     * @param conversationType 会话类型
-     * @param targetId 会话id
-     * @param tagIds 要删除的标签列表
-     */
-    removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): Promise<IAsyncRes<IAsyncRes>>;
+     * 消息扩展的对象
+    */
+    put?: {
+        [key: string]: string;
+    };
     /**
-     * 获取标签下的会话列表
-     * @param tagId 标签id
-     */
-    getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): Promise<IAsyncRes<IReceivedConversationByTag[]>>;
+     * 删除的 keys
+    */
+    del?: string[];
     /**
-     * 获取标签下的未读消息数
-     * @param tagId 标签id
-     * @param containMuted 是否包含免打扰会话
-     */
-    getUnreadCountByTag(tagId: string, containMuted: boolean): Promise<IAsyncRes<number>>;
+     * messageUId
+    */
+    mid: string;
     /**
-     * 设置标签中会话置顶
-     * @param conversation 会话
-     */
-    setConversationStatusInTag(tagId: string, conversation: IConversationOption, status: {
-        isTop: boolean;
-    }): Promise<IAsyncRes<IAsyncRes>>;
+     * 是否删除所有, 有效值：0、1 . ( 后续如有需要, API Layer 层可使用)
+    */
+    removeAll?: number;
+}
+
+/**
+ * 被拦截的消息信息
+ */
+interface IBlockedMessageInfo {
+    blockedMessageUId: string;
+    conversationType: number;
+    targetId: string;
+    channelId: string;
+    blockType: MessageBlockType;
+}
+
+interface IConnectResult {
     /**
-     * 获取会话里的标签
-     * @param conversation
+     * 连接错误码
      */
-    getTagsForConversation(conversation: IConversationOption): Promise<IAsyncRes<IConversationTag[]>>;
+    code: ErrorCode;
     /**
-     * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
-     * 对于未实现的方法，接口响应 Unsupport 错误码
-     * @param method 方法名
-     * @param args
+     * 导航获取成功后即可有相应的值，在导航数据获取完成之前该值为 undefined
      */
-    callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
+    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;
+declare type IMessageBlockedListener = (data: IBlockedMessageInfo) => void;
+interface ISendExMsgOptions {
+    channelId: string;
+    conversationType: ConversationType;
+    targetId: string;
     /**
-     * 删除所有会话
+     * 消息 ID
     */
-    clearConversations(conversationTypes?: ConversationType[], tag?: string): Promise<ErrorCode>;
+    messageUId: string;
     /**
-     * 设置用户连接状态监听器
+     * 原始消息是否支持扩展的字段
     */
-    setUserStatusListener(config: {
-        userIds: string[];
-    }, listener: Function): void;
+    canIncludeExpansion: boolean;
     /**
-     * 添加用户黑名单
+     * 删除的 keys
     */
-    addToBlacklist(userId: string): Promise<ErrorCode>;
+    keys?: string[];
     /**
-     * 将指定用户移除黑名单
+     * 扩展对象
     */
-    removeFromBlacklist(userId: string): Promise<ErrorCode>;
+    expansion?: {
+        [key: string]: string;
+    };
     /**
-     * 获取黑名单列表
+     * 是否删除所有扩展
     */
-    getBlacklist(): Promise<IAsyncRes<string[]>>;
+    removeAll?: boolean;
     /**
-     * 获取指定人员在黑名单中的状态
+     * 原始消息的扩展
     */
-    getBlacklistStatus(userId: string): Promise<IAsyncRes<string>>;
+    originExpansion?: {
+        [key: string]: string;
+    } | null;
+}
+interface IWatcher {
+    message?: IMessageListnenr;
+    connectionState?: IConnectionStatusListener;
+    conversationState?: IConversationStateListener;
+    chatroomState?: IChatroomListener;
+    expansion?: IExpansionListener;
     /**
-     * 向本地插入一条消息，不发送到服务器
-    */
-    insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): Promise<IAsyncRes<IReceivedMessage>>;
+     * 为兼容老版本 RTCLib 与 CallLib 接收消息的方式，新版本消息走插件机制
+     */
+    rtcInnerWatcher?: IRTCInnerListener;
     /**
-     * 删除本地消息
-    */
-    deleteMessages(timestamp: number[]): Promise<ErrorCode>;
+     * 标签的增删改监听
+     */
+    tag?: ITagListener;
     /**
-     * 从本地消息数据库中删除某一会话指定时间之前的消息数据
-    */
-    deleteMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, channelId?: string): Promise<ErrorCode>;
+     * 会话中标签状态变更监听
+     */
+    conversationTagChanged?: IConversationTagListener;
     /**
-     * 清空会话下历史消息
-    */
-    clearMessages(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
+     * 输入状态变更监听
+     */
+    typingState?: ItypingStateListener;
     /**
-     * 获取本地消息
-    */
-    getMessage(messageId: number): Promise<IAsyncRes<IReceivedMessage>>;
+     * 是否拉取完毕添加通知
+     */
+    pullFinished?: ITagListener;
     /**
-     * 设置消息内容
-    */
-    setMessageContent(messageId: number, content: any, messageType: string): Promise<ErrorCode>;
+     * 单聊消息送达通知
+     */
+    messageDelivered?: IMessageDeliveredListener;
+    messageBlocked?: IMessageBlockedListener;
+}
+interface IPluginGenerator<API, InitOption> {
     /**
-     * 设置消息搜索字段
-    */
-    setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<ErrorCode>;
+     * 只读插件标识
+     */
+    readonly tag: string;
     /**
-     * 设置消息发送状态
-    */
-    setMessageSentStatus(messageId: number, sentStatus: number): Promise<ErrorCode>;
+     * 版本号
+     */
+    readonly version?: string;
     /**
-    * 设置消息接收状态
-    */
-    setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<ErrorCode>;
+     * 插件名称
+     */
+    readonly name?: string;
     /**
-     * 设置当前用户在线状态
-    */
-    setUserStatus(status: number): Promise<ErrorCode>;
+     * 插件安装前的环境检测，通过返回 boolean 值确认插件是否可运行
+     */
+    verify(runtime: IRuntime): boolean;
+    /**
+     * 插件初始化
+     * @param context 插件调用上下文，用于实现插件的消息注册、消息首发等
+     * @param runtime 运行时实例，用于标识最终的运行时平台
+     * @param options 初始化参数
+     */
+    setup(context: PluginContext, runtime: IRuntime, options: InitOption): API;
+}
+interface IAPIContextOption {
     /**
-     * 订阅用户在线状态
-    */
-    subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
+     * 应用 appkey
+     */
+    appkey: string;
     /**
-     * 获取用户在线状态
-    */
-    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>;
+     * IMLib 版本号
+     */
+    apiVersion: string;
     /**
-     * 获取会话免打扰状态
+     * 自定义导航地址:
+     * 1. 私有云环境下该值为必填项
+     * 2. 当存在自定义导航地址时，SDK 内部默认地址将无效
+     * 3. 当存在自定义导航地址时，地址 url 中需包含 http/https 协议头，否则视为无效值
+     * 4. 建立 ws/wss 连接前的 ping 接口使用的协议与导航 url 中的协议相同
+     * 5. 建立 websocket 建立连接时将根据 ping 接口使用的 http/https 协议来确定使用 ws/wss 协议
+     * 6. 动态导航使用的协议头将与自定义导航地址相同
+     * 7. 公有云默认使用 https 协议
+     */
+    navigators: string[];
+    /**
+     * (参数已废弃)~~c++ 协议栈数据库地址~~
+     * @deprecated
     */
-    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;
-    }>>;
+    dbPath?: string;
     /**
-     * 加入房间
-     * @param roomId
-     * @param mode 房间模式：直播 or 会议
-     * @param mediaType 直播房间模式下的媒体资源类型
+     * 小程序的 CMP 代理地址
      */
-    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>;
+    miniCMPProxy: string[];
     /**
-     * 直播观众加房间
+     * 指定默认使用的连接类型
      */
-    joinLivingRoomAsAudience(roomId: string, mode: RTCMode, broadcastType?: number): Promise<IAsyncRes<{
-        token: string;
-        kvEntries: IServerRTCRoomEntry[];
-    }>>;
+    connectionType: 'websocket' | 'comet';
     /**
-     * 直播观众退出房间
+     * 修改 engine log 打印等级
      */
-    quitLivingRoomAsAudience(roomId: string): Promise<ErrorCode>;
+    logLevel?: LogLevel;
     /**
-     * 直播身份切换
+     * 修改默认的 log 输出函数
      */
-    rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
+    logStdout?: (logLevel: LogLevel, content: string) => void;
     /**
-     * 获取加入 RTC 房间的用户信息（当前仅能查自己的）
+     * （已废弃）私有云标识
+     * @deprecated
      */
-    getRTCJoinedUserInfo(userId: string): Promise<IAsyncRes<IRTCJoinedInfo[]>>;
-}
-
-/**
- * engine 基本接口定义，用于约束 Electron 下主进程、渲染进程、JSEngine 的编码一致性
- */
-interface IEngine {
+    isEnterPrise?: boolean;
     /**
-     * 建立连接
-     * @param token
-     * @param naviInfo
+     * typing状态过期时间
      */
-    connect(token: string, naviInfo: INaviInfo, versionInfo: string): Promise<ErrorCode>;
+    typingExpireTime?: number;
     /**
-     * 上报版本信息
-     * @param version
+     * 是否打开 IndexDB 存储，默认为 true
      */
-    reportSDKInfo(version: {
-        [name: string]: string;
-    }): void;
+    indexDBSwitch?: boolean;
     /**
-     * 连接时间
+     * 是否校验证书，默认为 true
      */
-    getConnectedTime(): number;
+    checkCA?: boolean;
+}
+declare class APIContext {
+    private _runtime;
+    private static _context?;
+    static init(runtime: IRuntime, options: IAPIContextOption): APIContext;
+    static destroy(): void;
+    private _token;
     /**
-     * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
-     * 对于未实现的方法，接口响应 Unsupport 错误码
-     * @param method
-     * @param args
+     * 插件队列，用于逐一派发消息与信令
      */
-    callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
+    private _pluginContextQueue;
     /**
-     * 获取历史消息
-     * @param conversationType
-     * @param targetId
-     * @param timestamp
-     * @param count
-     * @param order
+     * 插件实例Map，用于重复初始化时返回实例
      */
-    getHistoryMessage(conversationType: ConversationType, targetId: string, 
+    private _pluginInstanseMap;
+    private readonly _engine;
     /**
-     * 拉取时间戳，值为 `0` 表示从当前时间拉取
+     * 核心库版本号，后期与 4.0 IM SDK 版本号保持一致
      */
-    timestamp: number, 
+    readonly coreVersion: string;
+    readonly appkey: string;
+    readonly apiVersion: string;
+    private readonly _options;
+    private _versionInfo;
+    private _typingInfo;
     /**
-     * 获取条数, 有效值 `1` - `20`
+     * 内部连接状态标识，为 ture 时不允许调用 reconnect 方法
      */
-    count: number, 
+    private _isInternalConnected;
+    constructor(_runtime: IRuntime, options: IAPIContextOption);
     /**
-     * @description
-     * 1. `0` 表示升序，获取消息发送时间比传入 `sentTime` 小 的消息
-     * 2. `1` 表示降序，获取消息发送时间比传入 `sentTime` 大 的消息
+     * 安装使用插件，并初始化插件实例
+     * @param plugin
+     * @param options
      */
-    order: 0 | 1, 
+    install<T, O>(plugin: IPluginGenerator<T, O>, options: O): T | null;
+    private _connectionStatus;
+    private _canRedirectConnect;
     /**
-     * 会话的业务标识
-    */
-    channelId: string, 
+     * 重定向后，递归调用 connect
+     */
+    private _handleRedirect;
     /**
-     * 消息类型
+     * 连接状态变更回调
+     * @param message
      */
-    objectName: string): IPromiseResult<{
-        list: IReceivedMessage[];
-        hasMore: boolean;
-    }>;
+    private _connectionStatusListener;
+    private _messageReceiver;
     /**
-     * 删除历史消息 通过 messageUId
+     * 聊天室相关信息监听
     */
-    deleteRemoteMessage(conversationType: ConversationType, targetId: string, 
+    private _chatroomInfoListener;
     /**
-     * @description
-     * message 中 messageUId、setTime、messageDirection 为必须参数
+     * 会话监听相关
     */
-    messages: {
-        messageUId: string;
-        sentTime: number;
-        messageDirection: MessageDirection;
-    }[], 
+    private _conversationInfoListener;
     /**
-     * 会话的业务标识
+     * 消息扩展监听相关
     */
-    channelId: string): Promise<ErrorCode>;
-    recallMsg(conversationType: ConversationType, targetId: string, messageUId: string, sentTime: number, recallMsgOptions: IRecallMsgOptions): IPromiseResult<IReceivedMessage>;
+    private _expansionInfoListener;
     /**
-     * 删除历史消息 通过 时间戳
-     * @param timestamp 小于等于传入时间戳的消息均删除
-    */
-    deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, 
+     * 标签增删改监听
+     */
+    private _tagListener;
     /**
-     * 会话的业务标识
-    */
-    channelId: string): Promise<ErrorCode>;
+     * 会话标签状态监听
+     */
+    private _conversationTagListener;
+    private _typingStatusListener;
+    private _pullFinishedListener;
+    private _messageDeliveredListerer;
+    private _MessageBlockedListener;
+    private _callInfoListener;
     /**
-     * 获取会话列表
-     * @param count 指定获取数量, 不传则获取全部会话列表，默认 `300`
+     * rtc 数据变更通知 pluginContext
      */
-    getConversationList(
+    private _rtcDataChange;
     /**
-     * 拉取数量, 有效值 0 - 1000, 默认 300
+     * 业务层事件监听器挂载点
      */
-    count: number, 
+    private _watcher;
+    /**
+     * 添加事件监听
+     * @param options
+     */
+    assignWatcher(watcher: IWatcher): void;
+    /**
+     * 向内存中添加 typing 信息
+     * 添加 typing 时不触发通知，只有在轮询时间点校验 _typingChangedList 的长度大于 0 时才通知
+     */
+    private _addTypingInfo;
+    private _typingInternalTimer;
+    private _typingExpireTime;
+    private _typingChangedList;
+    /**
+     * 启动定时移除typing
+     */
+    private _startCheckTypingInfo;
+    getConnectedTime(): number;
+    getServerTime(): number;
+    getDeviceId(): string;
+    getCurrentUserId(): string;
+    getConnectionStatus(): ConnectionStatus;
+    /**
+     * 建立连接，连接失败则抛出异常，连接成功后返回用户 userId，否则返回相应的错误码
+     * @param token
+     * @param refreshNavi 是否需要重新请求导航，当值为 `false` 时，优先使用有效缓存导航，若缓存失效则重新获取导航
+     * @param reconnectKickEnable 设置断线重连时是否踢出当前正在重连的设备 (仅 Electron 环境有效)
+     *  同一个账号在一台新设备上登录的时候，会把这个账号在之前登录的设备上踢出。
+        由于 SDK 有断线重连功能，存在下面情况。
+        用户在 A 设备登录，A 设备网络不稳定，没有连接成功，SDK 启动重连机制。
+        用户此时又在 B 设备登录，B 设备连接成功。
+        A 设备网络稳定之后，用户在 A 设备连接成功，B 设备被踢出。
+        这个字段就是为这种情况加的。
+        设置 reconnectKickEnable 为 true 时，SDK 重连的时候发现此时已有别的设备连接成功，不再强行踢出已有设备，而是踢出重连设备。
+     */
+    connect(token: string, refreshNavi?: boolean, reconnectKickEnable?: boolean): Promise<IConnectResult>;
+    /**
+     * 拉取实时配置 web 端需更新 voipCall 字段
+     */
+    private _pullUserSettings;
+    disconnect(): Promise<void>;
+    reconnect(reconnectKickEnable?: boolean): Promise<IConnectResult>;
+    private _getTokenWithoutNavi;
     /**
-     * 会话类型
-     * @todo 待确认是否生效
+     * 获取当前缓存的导航数据
      */
-    conversationType?: ConversationType, 
+    getInfoFromCache(): INaviInfo | null;
     /**
-     * 起始时间
-    */
-    startTime?: number, 
+     * 消息注册
+     * @description 消息注册需在应用初始化完成前进行
+     * @param objectName 消息类型，如：RC:TxtMsg
+     * @param isPersited 是否存储
+     * @param isCounted 是否技术
+     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     */
+    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[]): void;
     /**
-     * 获取顺序
-    */
-    order?: 0 | 1, 
+     * 发送消息
+     * @param conversationType
+     * @param targetId
+     * @param objectName
+     * @param content
+     * @param options
+     */
+    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void): Promise<IAsyncRes<IReceivedMessage>>;
     /**
-     * 会话的业务标识
+     * 发送扩展消息
+     * @param messageUId 消息 Id
+     * @param keys 需要删除的 key
+     * @param expansion 设置的扩展
     */
-    channelId?: string): IPromiseResult<IReceivedConversation[]>;
+    sendExpansionMessage(options: ISendExMsgOptions): Promise<IAsyncRes<ErrorCode>>;
     /**
-     * 获取指定会话
-    */
-    getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
+     * 发送群组消息已读回执
+     * 导航下发已读回执开关为 true 时调用
+     * @param targetId 群组会话id
+     * @param messageUIds 消息id
+     */
+    sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
     /**
-     * 删除会话
-     * @description 该删除操作会删除服务器端存储的会话数据
-     * @param conversationType
+     * 获取群组消息已读列表
      * @param targetId
+     * @param messageUIds
      */
-    removeConversation(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
+    getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<IMessageReaderResponse>>;
     /**
-     * 获取所有会话未读数
-     * @param channelId 多组织 Id
-     * @param conversationTypes
-     * @param includeMuted 包含已设置免打扰的会话
+     * 反初始化，清空所有监听及计时器
      */
-    getAllConversationUnreadCount(channelId: string, conversationTypes: ConversationType[], includeMuted: boolean): IPromiseResult<number>;
+    private _destroy;
     /**
-     * 获取指定会话未读数
+     * @param conversationType
+     * @param targetId 会话 Id
+     * @param timestamp 拉取时间戳
+     * @param count 拉取条数
+     * @param order 1 正序拉取，0 为倒序拉取
+     * @param channelId
+     * @param objectName
      */
-    getConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<number>;
+    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`
      */
-    clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
+    getConversationList(count?: number, conversationType?: ConversationType, startTime?: number, order?: 0 | 1, channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
     /**
-     * 获取第一个未读消息
+     * 获取单一会话数据
+     * @param conversationType
+     * @param targetId
+     * @param channelId
      */
-    getFirstUnreadMessage(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedMessage | null>;
+    getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
     /**
-     * 设置/保存指定会话消息草稿
-     * @draft 草稿内容
+     * 删除会话
      */
-    saveConversationMessageDraft(conversationType: ConversationType, targetId: string, draft: string): Promise<ErrorCode>;
+    removeConversation(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
     /**
-     * 获取指定会话消息草稿
+     * 清除会话消息未读数
      */
-    getConversationMessageDraft(conversationType: ConversationType, targetId: string): IPromiseResult<string>;
+    clearUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
     /**
-     * 清除指定会话消息草稿
+     * 清除全部会话消息未读数
      */
-    clearConversationMessageDraft(conversationType: ConversationType, targetId: string): Promise<ErrorCode>;
+    clearAllUnreadCount(): Promise<ErrorCode>;
     /**
-     * 从服务端拉取会话状态
+     * 获取指定会话消息未读数
      */
-    pullConversationStatus(timestamp: number): Promise<IAsyncRes<IServerConversationStatus[]>>;
+    getUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<number>>;
     /**
-     * 批量设置会话 置顶、免打扰
+     * 获取所有会话未读数
+     * @param channelId 多组织 Id
+     * @param conversationTypes
+     * @param includeMuted 包含已设置免打扰的会话
      */
-    batchSetConversationStatus(statusList: ISetConversationStatusOptions[]): Promise<ErrorCode>;
-    sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void): IPromiseResult<IReceivedMessage>;
+    getTotalUnreadCount(channelId: string, conversationTypes?: ConversationType[], includeMuted?: boolean): Promise<IAsyncRes<number>>;
     /**
-     * 断开连接
+     * 获取第一个未读消息
      */
-    disconnect(): void;
+    getFirstUnreadMessage(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<IReceivedMessage | null>>;
+    setConversationStatus(conversationType: ConversationType, targetId: string, isTop?: boolean, notificationStatus?: 1 | 2, channelId?: string): Promise<ErrorCode>;
+    saveConversationMessageDraft(conversationType: ConversationType, targetId: string, draft: string): Promise<ErrorCode>;
+    getConversationMessageDraft(conversationType: ConversationType, targetId: string): Promise<IAsyncRes<string>>;
+    clearConversationMessageDraft(conversationType: ConversationType, targetId: string): Promise<ErrorCode>;
+    recallMessage(conversationType: ConversationType, targetId: string, messageUId: string, sentTime: number, recallMsgOptions: IRecallMsgOptions): Promise<IAsyncRes<IReceivedMessage>>;
     /**
-     * 拉取用户级配置数据
+     * 删除远端消息
+     * @param conversationType
+     * @param targetId
+     * @param list
      */
-    pullUserSettings(version: number): IPromiseResult<IServerUserSetting>;
+    deleteRemoteMessage(conversationType: ConversationType, targetId: string, list: {
+        messageUId: string;
+        sentTime: number;
+        messageDirection: MessageDirection;
+    }[], channelId?: string): Promise<ErrorCode>;
     /**
-     * 消息注册
-     * @description
-     * 消息注册需在应用初始化完成前进行，否则在搭配 C++ 协议栈使用时，
-     * 本端发出的消息将不默认作为未知消息处理，不存储、不计数
-     * @param objectName 消息类型，如：RC:TxtMsg
-     * @param isPersited 是否存储
-     * @param isCounted 是否技术
-     * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     * 根据时间戳删除指定时间之前的
+     * @param conversationType
+     * @param targetId
+     * @param timestamp
      */
-    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[]): void;
+    deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
     /**
-     * 加入聊天室
-     * @param count 拉取消息数量
-    */
-    joinChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
+     * 加入聊天室，若聊天室不存在则创建聊天室
+     * @param roomId 聊天室房间 Id
+     * @param count 进入聊天室成功后，自动拉取的历史消息数量，默认值为 `10`，最大有效值为 `50`，`-1` 为不拉取
+     */
+    joinChatroom(roomId: string, count?: number): Promise<ErrorCode>;
     /**
-     * 加入已存在的聊天室
-     * @param count 拉取消息数量
-    */
-    joinExistChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
+     * 加入聊天室，若聊天室不存在则抛出异常
+     * @param roomId 聊天室房间 Id
+     * @param count 进入聊天室成功后，自动拉取的历史消息数量，默认值为 `10`，最大有效值为 `50`，`-1` 为不拉取
+     */
+    joinExistChatroom(roomId: string, count?: number): Promise<ErrorCode>;
     /**
      * 退出聊天室
-    */
-    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 roomId
+     */
+    quitChatroom(roomId: string): Promise<ErrorCode>;
     /**
-     * 设置聊天室属性
-    */
-    setChatroomEntry(chatroomId: string, entry: IChrmKVEntry): 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>>;
     /**
-     * 批量设置聊天室属性
+     * 在指定聊天室中设置自定义属性
+     * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
+     * @param roomId 聊天室房间 id
+     * @param entry 属性信息
      */
-    setChatroomEntries(chatroomId: string, entry: IChrmKVEntries): Promise<{
+    setChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
+    setChatroomEntries(roomId: string, entryOptions: IChatroomEntries): Promise<{
         code: ErrorCode;
         data?: any;
     }>;
     /**
-     * 强制设置聊天室属性
-    */
-    forceSetChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+     * 在指定聊天室中强制增加 / 修改任意聊天室属性
+     * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
+     * @param roomId 聊天室房间 id
+     * @param entry 属性信息
+     */
+    forceSetChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
     /**
      * 删除聊天室属性
-    */
-    removeChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+     * @description 该方法仅限于删除自己设置的聊天室属性
+     * @param roomId 聊天室房间 id
+     * @param entry 要移除的属性信息
+     */
+    removeChatroomEntry(roomId: string, entry: IRemoveChatRoomEntryOption): Promise<ErrorCode>;
     /**
      * 批量删除聊天室属性
+     * @description 该方法仅限于删除自己设置的聊天室属性
+     * @param roomId 聊天室房间 id
+     * @param entry 要移除的属性信息
      */
-    removeChatroomEntries(chatroomId: string, entries: IChrmKVEntries): Promise<{
+    removeChatroomEntries(roomId: string, entryOptions: IRemoveChatRoomEntriesOption): Promise<{
         code: ErrorCode;
         data?: any;
     }>;
     /**
-     * 强制删除聊天室属性
-    */
-    forceRemoveChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
+     * 强制删除任意聊天室属性
+     * @description 该方法仅限于删除自己设置的聊天室属性
+     * @param roomId 聊天室房间 id
+     * @param entry 要移除的属性信息
+     */
+    forceRemoveChatroomEntry(roomId: string, entry: IRemoveChatRoomEntryOption): Promise<ErrorCode>;
     /**
-      * 获取聊天室 key 对应 value
-    */
-    getChatroomEntry(chatroomId: string, key: string): IPromiseResult<string | null>;
+     * 获取聊天室中的指定属性
+     * @param roomId 聊天室房间 id
+     * @param key 属性键名
+     */
+    getChatroomEntry(roomId: string, key: string): Promise<IAsyncRes<string | null>>;
     /**
-      * 获取聊天室所有 key value
-    */
-    getAllChatroomEntry(chatroomId: string): IPromiseResult<{
+     * 获取聊天室内的所有属性
+     * @param roomId 聊天室房间 id
+     */
+    getAllChatroomEntries(roomId: string): Promise<IAsyncRes<{
         [key: string]: string;
-    }>;
+    }>>;
     /**
-     * 获取上传认证信息
+     * 拉取聊天室内的历史消息
+     * @param roomId
+     * @param count 拉取消息条数, 有效值范围 `1 - 20`
+     * @param order 获取顺序，默认值为 0。
+     * * 0：降序，用于获取早于指定时间戳发送的消息
+     * * 1：升序，用于获取晚于指定时间戳发送的消息
+     * @param timestamp 指定拉取消息用到的时间戳。默认值为 `0`，表示按当前时间拉取
+     */
+    getChatRoomHistoryMessages(roomId: string, count?: number, order?: 0 | 1, timestamp?: number): Promise<IAsyncRes<{
+        list: IReceivedMessage[];
+        hasMore: boolean;
+    }>>;
+    /**
+     * 获取存储服务鉴权信息
+     * @param fileType 文件类型
+     * @param fileName 文件名称
+     * @param httpMethod STC 分段上传时的必填参数，有效值为 PUT | POST
+     * @param queryString STC 分段上传时的查询字符串
      * @description
-     * 若不传 fileName 百度上传认证字段（bosToken、bosDate、path）均返回 null
-    */
-    getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string): Promise<IAsyncRes<IUploadAuth>>;
+     * `httpMethod` 与 `queryString` 为 STC S3 分段上传时的专属参数，STC 分段上传包含三个过程：
+     * 1. 开始分段前调用，此时 `httpMethod` 值应为 `POST`， `queryString` 值为 `uploads`
+     * 2. 上传请求前调用，此时 `httpMethod` 值应为 `PUT`，`queryString` 值为 `partNumber={partamNumer}&uploadId={uploadId}`
+     * 3. 上传结束前调用，此时 `httpMethod` 值应为 `POST`，`queryString` 值为 `uploadId={uploadId}`
+     * @returns
+     */
+    getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string): Promise<IUploadAuth & {
+        bos: string;
+        qiniu: string;
+    }>;
     /**
-     * 获取文件上传后下载地址
+     * 获取 七牛、百度、阿里云 上传成功可下载的 URL
+     * @param fileType 文件类型
+     * @param fileName 文件名
+     * @param saveName 下载后的存储文件名
+     * @param uploadRes 插件上传返回的结果。降级百度上传后，用户传入返回结果，再把结果里的下载地址返回给用户，保证兼容之前结果获取
+     * @param serverType 使用的存储服务标识
     */
-    getFileUrl(fileType: FileType, uploadMethod: UploadMethod, fileName?: string, originName?: string): IPromiseResult<{
+    getFileUrl(fileType: FileType, fileName?: string, saveName?: string, uploadRes?: {
+        isBosRes: boolean;
+        downloadUrl: string;
+    }, serverType?: UploadMethod): Promise<{
         downloadUrl: string;
     }>;
     /**
      * 创建标签
      * @param tag 标签
-    */
-    createTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
+     */
+    createTag(tag: ITagParam): Promise<IAsyncRes>;
     /**
      * 删除标签
      * @param tagId 标签id
-    */
-    removeTag(tagId: string): IPromiseResult<IAsyncRes>;
+     */
+    removeTag(tagId: string): Promise<IAsyncRes>;
     /**
-     * 编辑标签
+     * 更新标签
      * @param tag 标签
-    */
-    updateTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
+     */
+    updateTag(tag: ITagParam): Promise<IAsyncRes>;
     /**
      * 获取标签列表
      */
-    getTagList(): IPromiseResult<Array<ITagInfo>>;
+    getTagList(): Promise<IAsyncRes<Array<ITagInfo>>>;
     /**
      * 添加会话到标签（给多个会话增加标签）
      * @param tagId 标签id
      * @param conversations 要添加的会话列表
      */
-    addTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult<IAsyncRes>;
+    addTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<IAsyncRes>>;
     /**
      * 删除标签中的会话(从多个会话中批量删除指定标签)
      * @param tagId 标签id
      * @param conversations 要删除的会话列表
      */
-    removeTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult<IAsyncRes>;
+    removeTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<IAsyncRes>>;
     /**
      * 删除会话中的标签(从单一会话中批量删除标签)
      * @param conversationType 会话类型
      * @param targetId 会话id
      * @param tagIds 要删除的标签列表
      */
-    removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): IPromiseResult<IAsyncRes>;
+    removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): Promise<IAsyncRes<IAsyncRes>>;
     /**
      * 获取标签下的会话列表
      * @param tagId 标签id
      */
-    getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): IPromiseResult<IReceivedConversationByTag[]>;
+    getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): Promise<IAsyncRes<IReceivedConversationByTag[]>>;
     /**
      * 获取标签下的未读消息数
      * @param tagId 标签id
      * @param containMuted 是否包含免打扰会话
      */
-    getUnreadCountByTag(tagId: string, containMuted: boolean): IPromiseResult<number>;
+    getUnreadCountByTag(tagId: string, containMuted: boolean): Promise<IAsyncRes<number>>;
     /**
      * 设置标签中会话置顶
      * @param conversation 会话
      */
-    setConversationStatusInTag(tagId: string, conversation: IConversationOption, status: ITagStatus): IPromiseResult<IAsyncRes>;
+    setConversationStatusInTag(tagId: string, conversation: IConversationOption, status: {
+        isTop: boolean;
+    }): Promise<IAsyncRes<IAsyncRes>>;
     /**
      * 获取会话里的标签
-     * @param config
-     */
-    getTagsForConversation(conversation: IConversationOption): IPromiseResult<IConversationTag[]>;
-    /**
-     * 发送群组消息已读回执
-     * 导航下发已读回执开关为 true 时调用
-     */
-    sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
-    /**
-     * 获取群组消息已读列表
-     */
-    getMessageReader(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IMessageReaderResponse>;
-    /**
-     * 获取服务器时间
+     * @param conversation
      */
-    getServerTime(): number;
+    getTagsForConversation(conversation: IConversationOption): Promise<IAsyncRes<IConversationTag[]>>;
     /**
-     * 获取设备ID
+     * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
+     * 对于未实现的方法，接口响应 Unsupport 错误码
+     * @param method 方法名
+     * @param args
      */
-    getDeviceId(): string;
+    callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
     /**
-     * 获取当前 userId
-     */
-    getCurrentUserId(): string;
+     * 删除所有会话
+    */
+    clearConversations(conversationTypes?: ConversationType[], tag?: string): Promise<ErrorCode>;
     /**
-     * 设置用户在线状态监听器
+     * 设置用户连接状态监听器
     */
     setUserStatusListener(config: {
         userIds: string[];
     }, listener: Function): void;
     /**
-     * 设置当前用户在线状态
-    */
-    setUserStatus(status: number): Promise<ErrorCode>;
-    /**
-     * 订阅用户在线状态
-    */
-    subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
-    /**
-     * 获取用户状态
-    */
-    getUserStatus(userId: string): IPromiseResult<{
-        status: string;
-    }>;
-    /**
-     * 清空所有会话
-    */
-    clearConversations(conversationTypes?: ConversationType[], channelId?: string): Promise<ErrorCode>;
-    /**
-     * 加入黑名单
+     * 添加用户黑名单
     */
     addToBlacklist(userId: string): Promise<ErrorCode>;
     /**
-      * 将指定用户移除黑名单
+     * 将指定用户移除黑名单
     */
     removeFromBlacklist(userId: string): Promise<ErrorCode>;
     /**
-      * 获取黑名单列表
+     * 获取黑名单列表
     */
-    getBlacklist(): IPromiseResult<string[]>;
+    getBlacklist(): Promise<IAsyncRes<string[]>>;
     /**
-      * 获取指定人员在黑名单中的状态
+     * 获取指定人员在黑名单中的状态
     */
-    getBlacklistStatus(userId: string): IPromiseResult<string>;
+    getBlacklistStatus(userId: string): Promise<IAsyncRes<string>>;
     /**
      * 向本地插入一条消息，不发送到服务器
     */
-    insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): IPromiseResult<IReceivedMessage>;
+    insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): Promise<IAsyncRes<IReceivedMessage>>;
     /**
      * 删除本地消息
     */
-    deleteMessages(timestamps: number[]): Promise<ErrorCode>;
+    deleteMessages(timestamp: number[]): Promise<ErrorCode>;
     /**
-     * 通过时间戳删除本地消息
+     * 从本地消息数据库中删除某一会话指定时间之前的消息数据
     */
-    deleteMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, channelId: string): Promise<ErrorCode>;
+    deleteMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, channelId?: string): Promise<ErrorCode>;
     /**
      * 清空会话下历史消息
     */
-    clearMessages(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
+    clearMessages(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
     /**
-     * 获取消息
+     * 获取本地消息
     */
-    getMessage(messageId: number): IPromiseResult<IReceivedMessage>;
+    getMessage(messageId: number): Promise<IAsyncRes<IReceivedMessage>>;
     /**
      * 设置消息内容
     */
@@ -4376,49 +4439,66 @@ interface IEngine {
      * 设置消息搜索字段
     */
     setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<ErrorCode>;
-    /**
-     * 通过关键字搜索会话
-    */
-    searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
-    /**
-     * 按内容搜索会话内的消息
-    */
-    searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, channelId: string): IPromiseResult<{
-        messages: IReceivedMessage[];
-        count: number;
-    }>;
-    /**
-     * 获取会话下所有未读的 @ 消息
-    */
-    getUnreadMentionedMessages(conversationType: ConversationType, targetId: string, channelId: string): IReceivedMessage[];
     /**
      * 设置消息发送状态
     */
     setMessageSentStatus(messageId: number, sentStatus: number): Promise<ErrorCode>;
     /**
-     * 设置消息接收状态
+    * 设置消息接收状态
     */
     setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<ErrorCode>;
     /**
-     * 删除时间戳前的未读数
+     * 设置当前用户在线状态
     */
-    clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId: string): Promise<ErrorCode>;
+    setUserStatus(status: number): Promise<ErrorCode>;
     /**
-     * 获取会话免打扰状态
+     * 订阅用户在线状态
     */
-    getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationStatus>;
+    subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
     /**
-     * 协议栈获取远端历史消息
+     * 获取用户在线状态
     */
-    getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, order: 0 | 1, channelId: string): IPromiseResult<{
+    getUserStatus(userId: string): Promise<IAsyncRes<{
+        status: string;
+    }>>;
+    searchConversationByContent(keyword: string, customMessageTypes?: string[], channelId?: string, conversationTypes?: ConversationType[]): Promise<IAsyncRes<IReceivedConversation[]>>;
+    searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, channelId?: string): Promise<IAsyncRes<{
+        messages: IReceivedMessage[];
+        count: number;
+    }>>;
+    getUnreadMentionedMessages(conversationType: ConversationType, targetId: string, channelId?: string): IReceivedMessage[];
+    clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
+    /**
+     * 获取会话免打扰状态
+    */
+    getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<NotificationStatus>>;
+    getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, order: 0 | 1, channelId: string): Promise<IAsyncRes<{
         list: IReceivedMessage[];
         hasMore: boolean;
+    }>>;
+    /**
+     * 获取群组消息送达信息
+     */
+    getGroupMessageDeliverList(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IGroupMessageDeliverInfo>;
+    /**
+     * 获取单聊消息送达信息
+     */
+    getPrivateMessageDeliverTime(messageUId: string, channelId?: string): IPromiseResult<number>;
+    setCallInfo(targetId: string, key: string, value: string): IPromiseResult<{
+        key: string;
+        value: string;
     }>;
-    joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number): IPromiseResult<IJoinRTCRoomData>;
+    /**
+     * 加入房间
+     * @param roomId
+     * @param mode 房间模式：直播 or 会议
+     * @param mediaType 直播房间模式下的媒体资源类型
+     */
+    joinRTCRoom(roomId: string, mode: RTCMode, mediaType?: number, joinType?: RTCJoinType): Promise<IAsyncRes<IJoinRTCRoomData>>;
     quitRTCRoom(roomId: string): Promise<ErrorCode>;
-    rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
-    getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
-    getRTCUserInfoList(roomId: string): IPromiseResult<IRTCUsers>;
+    rtcPing(roomId: string, mode: number, mediaType?: number): Promise<ErrorCode>;
+    getRTCRoomInfo(roomId: string): Promise<IAsyncRes<IRTCRoomInfo>>;
+    getRTCUserInfoList(roomId: string): Promise<IAsyncRes<IRTCUsers>>;
     getRTCUserInfo(roomId: string): IPromiseResult<unknown>;
     setRTCUserInfo(roomId: string, key: string, value: string): Promise<ErrorCode>;
     removeRTCUserInfo(roomId: string, keys: string[]): Promise<ErrorCode>;
@@ -4426,49 +4506,40 @@ interface IEngine {
         name: string;
         content: string;
     }): Promise<ErrorCode>;
-    /**
-     * 全量订阅资源修改
-     * @param roomId 房间 Id
-     * @param message 向前兼容的消息内容
-     * @param valueInfo 全量资源数据
-     * @param objectName 全量 URI 消息名
-     */
     setRTCTotalRes(roomId: string, message: {
         name: string;
         content: string;
-    }, valueInfo: string, objectName: string, mcuValInfo: string): Promise<ErrorCode>;
-    getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): IPromiseResult<KVString>;
+    }, valueInfo: string, objectName: string, mcuValInfo?: string): Promise<ErrorCode>;
+    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): IPromiseResult<IRtcTokenData>;
-    setRTCState(roomId: string, reportId: string): Promise<ErrorCode>;
+    getRTCToken(roomId: string, mode: number, broadcastType?: number): Promise<IAsyncRes<IRtcTokenData>>;
+    setRTCState(roomId: string, report: string): Promise<ErrorCode>;
     getRTCUserList(roomId: string): IPromiseResult<IRTCUsers>;
-    setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
-}
-
-interface IExpansionMsgContent {
     /**
-     * 消息扩展的对象
-    */
-    put?: {
-        [key: string]: string;
-    };
+     * 直播观众加房间
+     */
+    joinLivingRoomAsAudience(roomId: string, mode: RTCMode, broadcastType?: number): Promise<IAsyncRes<{
+        token: string;
+        kvEntries: IServerRTCRoomEntry[];
+    }>>;
     /**
-     * 删除的 keys
-    */
-    del?: string[];
+     * 直播观众退出房间
+     */
+    quitLivingRoomAsAudience(roomId: string): Promise<ErrorCode>;
     /**
-     * messageUId
-    */
-    mid: string;
+     * 直播身份切换
+     */
+    rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
     /**
-     * 是否删除所有, 有效值：0、1 . ( 后续如有需要, API Layer 层可使用)
-    */
-    removeAll?: number;
+     * 获取加入 RTC 房间的用户信息（当前仅能查自己的）
+     */
+    getRTCJoinedUserInfo(userId: string): Promise<IAsyncRes<IRTCJoinedInfo[]>>;
 }
 
 declare class RTCPluginContext extends PluginContext {
@@ -4612,6 +4683,8 @@ interface IEngineWatcher {
      */
     onRTCDataChange: (data: IServerRTCRoomEntry[], roomId?: string) => void;
     pullFinished: () => void;
+    messageDelivered: (data: IMessageDeliver[]) => void;
+    callInfo: (data: string) => void;
 }
 /**
  * 引擎定义
@@ -4648,8 +4721,9 @@ declare abstract class AEngine implements IEngine {
      * 建立连接
      * @param token
      * @param naviInfo
+     * @param reconnectKickEnable
      */
-    abstract connect(token: string, naviInfo: INaviInfo): Promise<ErrorCode>;
+    abstract connect(token: string, naviInfo: INaviInfo, reconnectKickEnable?: boolean): Promise<ErrorCode>;
     /**
      * 发送SDK版本
      * @param versionInfo
@@ -4770,6 +4844,10 @@ declare abstract class AEngine implements IEngine {
      * 清除指定会话未读数
      */
     abstract clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
+    /**
+     * 清除全部会话未读数
+     */
+    abstract clearAllUnreadCount(): Promise<ErrorCode>;
     /**
      * 获取第一个未读消息
      */
@@ -5101,6 +5179,18 @@ 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 setCallInfo(targetId: string, key: string, value: string): IPromiseResult<{
+        key: string;
+        value: string;
+    }>;
     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>;
@@ -5605,4 +5695,4 @@ declare enum CONNECTION_TYPE {
  */
 declare const version: string;
 
-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 };
+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, 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, IMessageBlockedListener, IMessageDeliver, IMessageDeliveredListener, 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, MessageBlockType, 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 };