@rongcloud/engine 0.0.1-alpha.1 → 0.0.1-c-rs-alpha.3

package/src/RCIMEngine.d.ts

@@ -0,0 +1,1000 @@
+import { RcimEngineParams } from './types/EngineTypes';
+import { RcimAppSettings, RcimBlacklistStatus, RcimChatroomInfo, RcimChatroomJoinedInfo, RcimChatroomKeyErrorInfo, RcimChatroomKvInfo, RcimChatroomMemberBannedInfo, RcimChatroomMemberBlockedInfo, RcimChatroomMemberChangeInfo, RcimChatroomMultiClientSyncInfo, RcimChatroomStatus, RcimConnectionStatus, RcimConversationIdentifier, RcimConversationStatusChangeItem, RcimConversationTagInfo, RcimConversationType, RcimDisconnectMode, RcimErrorCode, RcimInsertLogInfo, RcimMessageBlockInfo, RcimMessageExpansionKvInfo, RcimMessageFlag, RcimMessageIdentifier, RcimOrder, RcimPushNotificationMuteLevel, RcimReadReceiptInfoV5, RcimReadReceiptNotifyV5, RcimReadReceiptUserInfo, RcimReadReceiptUsersOption, RcimReadReceiptV2ReaderInfo, RcimReceivedInfo, RcimReceivedStatus, RcimSendMessageOption, RcimSendReadReceiptResponseMessageData, RcimSentStatus, RcimStreamMessageChunkInfo, RcimStreamMessageRequestEvent, RcimSubscribeType, RcimTypingStatus } from '@rongcloud/electron';
+import { RcimMessage } from './types/message/MessageTypes';
+import { MessageMapper } from './internal/message/MessageMapper';
+import { RcimMessageContent, RcimMessageContentConstructor } from './types/message/MessageContent';
+import { RcimConversation } from './types/ConversationTypes';
+import { MessageMetadata } from './internal/message/MessageMetadata';
+import { RcimRecallNotificationMessage } from './types/message/content/normal/RecallNotificationMessage';
+/**
+ * ```
+ * 比如聊天室 kv 监听，在上层是一个 interface 包含三个监听方法，而 Rust 是三个独立的监听
+ *
+ * interface ChatroomKVStatusListener {
+ *   onChatroomKVSync(roomId: string): void;
+ *   onChatroomKVUpdate(roomId: string, entries: Map<string, string>): void;
+ *   onChatroomKVRemove(roomId: string, entries: Map<string, string>): void;
+ * }
+ * ```
+ */
+/**
+ * RCIMEngine 作为 SDK 对外暴露的主入口。
+ */
+export declare class RCIMEngine {
+    private readonly engine;
+    private readonly deviceId;
+    private readonly messageMetadata;
+    private readonly messageMapper;
+    private consoleLevel;
+    constructor(appkey: string, param: RcimEngineParams);
+    private getCloudType;
+    getMessageMapper(): MessageMapper;
+    getMessageMetadata(): MessageMetadata;
+    /**
+     * 设置重连踢下线策略。
+     * @param isEnabled 是否开启
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setReconnectKickPolicy(isEnabled: boolean): RcimErrorCode;
+    /**
+     * 连接 IM 服务。
+     * @param token 连接 token
+     * @param timeout 超时秒数
+     * @return Promise，code 为 RcimErrorCode，当 code 为 Success 时，userId 为登录用户 ID，否则为 undefined
+     */
+    connect(token: string, timeout: number): Promise<{
+        code: RcimErrorCode;
+        userId?: string;
+    }>;
+    /**
+     * 断开与融云服务的连接。
+     * @param mode 断开连接模式
+     * @return Promise，失败时抛出异常
+     */
+    disconnect(mode: RcimDisconnectMode): Promise<RcimErrorCode>;
+    /**
+     * 获取当前用户 ID。
+     * @return 当前用户 ID；失败时返回空字符串
+     */
+    getCurrentUserId(): string;
+    /**
+     * 获取 deviceId。
+     * @return deviceId
+     */
+    getDeviceId(): string;
+    /**
+     * 获取 SDK 信息 RTC Lib 使用
+     */
+    getSDKInfo(): {
+        version: string;
+    };
+    /**
+     * 获取当前连接状态。
+     * @return 当前连接状态；失败时返回 Idle
+     */
+    getConnectionStatus(): RcimConnectionStatus;
+    /**
+     * 获取本地时间与服务器时间的时间差。
+     * 通过当前本地时间 - 此接口返回的时间，即当前服务器时间。
+     * @return 时间差（毫秒）；失败时返回 0
+     */
+    getDeltaTime(): number;
+    /**
+     * 获取配置信息，连接成功后调用。
+     * @return Promise，code 为 RcimErrorCode，appSettings 为配置信息（可选）
+     */
+    getAppSettings(): Promise<{
+        code: RcimErrorCode;
+        appSettings?: RcimAppSettings;
+    }>;
+    /**
+     * 按 key 列表批量获取导航数据。
+     * @param keys 需要获取的导航字段 key 列表
+     * @return Promise，code 为 RcimErrorCode，kvMap 为 key-value 映射
+     */
+    getNaviDataValues(keys: string[]): Promise<{
+        code: RcimErrorCode;
+        kvMap?: Record<string, string | null>;
+    }>;
+    /**
+     * 写入日志。
+     * 当 logInfo.level <= consoleLevel 时，同时输出到控制台。
+     * @param logInfo 日志数据
+     * @return Promise，code 为 RcimErrorCode
+     */
+    insertLog(logInfo: RcimInsertLogInfo): Promise<RcimErrorCode>;
+    /**
+     * 设置连接状态监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setConnectionStatusListener(listener: ((status: RcimConnectionStatus) => void) | null): RcimErrorCode;
+    /**
+     * 设置离线消息同步完成监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setOfflineMessageSyncCompletedListener(listener: (() => void) | null): RcimErrorCode;
+    /**
+     * 设置标签变化监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setTagListener(listener: (() => void) | null): RcimErrorCode;
+    /**
+     * 设置会话标签变化监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setConversationTagListener(listener: (() => void) | null): RcimErrorCode;
+    /**
+     * 创建标签。
+     * @param tagInfo 标签信息；只需要设置 tagId/tagName
+     * @return Promise，code 为 RcimErrorCode
+     */
+    addTag(tagInfo: {
+        tagId: string;
+        tagName: string;
+    }): Promise<RcimErrorCode>;
+    /**
+     * 获取标签列表。
+     * @return Promise，code 为 RcimErrorCode，tagInfoVec 为标签列表（可能为空数组）
+     */
+    getTags(): Promise<{
+        code: RcimErrorCode;
+        tagInfoVec: {
+            tagId: string;
+            tagName: string;
+            count: number;
+            timestamp: number;
+        }[];
+    }>;
+    /**
+     * 移除标签。
+     * @param tagId 标签 id
+     * @return Promise，code 为 RcimErrorCode
+     */
+    removeTag(tagId: string): Promise<RcimErrorCode>;
+    /**
+     * 更新标签信息（只支持修改 tagName）。
+     * @param tagInfo 标签信息；只需要设置 tagId/tagName
+     * @return Promise，code 为 RcimErrorCode
+     */
+    updateTag(tagInfo: {
+        tagId: string;
+        tagName: string;
+    }): Promise<RcimErrorCode>;
+    /**
+     * 获取会话的所有标签。
+     * @param conversation 会话标识
+     * @return Promise，code 为 RcimErrorCode，conTagInfoVec 为会话标签列表（可能为空数组）
+     */
+    getTagsFromConversation(conversation: RcimConversationIdentifier): Promise<{
+        code: RcimErrorCode;
+        conTagInfoVec: RcimConversationTagInfo[];
+    }>;
+    /**
+     * 添加会话到指定标签。
+     * @param tagId 标签 id
+     * @param convIdfVec 会话标识列表；长度范围 [1, 20]
+     * @return Promise，code 为 RcimErrorCode
+     */
+    addConversationsToTag(tagId: string, convIdfVec: RcimConversationIdentifier[]): Promise<RcimErrorCode>;
+    /**
+     * 从指定标签移除会话。
+     * @param tagId 标签 id
+     * @param convIdfVec 会话标识列表；长度范围 [1, 20]
+     * @return Promise，code 为 RcimErrorCode
+     */
+    removeConversationsFromTag(tagId: string, convIdfVec: RcimConversationIdentifier[]): Promise<RcimErrorCode>;
+    /**
+     * 从指定会话中移除标签。
+     * @param conversation 会话标识
+     * @param tagIdVec 标签 id 列表
+     * @return Promise，code 为 RcimErrorCode
+     */
+    removeTagsFromConversation(conversation: RcimConversationIdentifier, tagIdVec: string[]): Promise<RcimErrorCode>;
+    /**
+     * 分页获取标签中会话列表。
+     * @param tagId 标签 id
+     * @param timestamp 会话时间戳（获取这个时间戳之前的会话列表，0 表示从最新开始获取，单位：毫秒）
+     * @param count 获取数量（当实际取回会话数量小于 count 时，表明已取完）
+     * @return Promise，code 为 RcimErrorCode，conversationList 为会话列表（可能为空数组）
+     */
+    getConversationsFromTagByPage(tagId: string, timestamp: number, count: number): Promise<{
+        code: RcimErrorCode;
+        conversationList: RcimConversation[];
+    }>;
+    /**
+     * 根据标签获取未读消息数。
+     * @param tagId 标签 id
+     * @param containBlocked 是否包含免打扰会话
+     * @return Promise，code 为 RcimErrorCode，count 为未读数
+     */
+    getUnreadCountByTag(tagId: string, containBlocked: boolean): Promise<{
+        code: RcimErrorCode;
+        count: number;
+    }>;
+    /**
+     * 设置标签中的会话置顶。
+     * @param tagId 标签 id
+     * @param conversation 会话标识
+     * @param isTop 是否置顶
+     * @return Promise，code 为 RcimErrorCode
+     */
+    setConversationToTopInTag(tagId: string, conversation: RcimConversationIdentifier, isTop: boolean): Promise<RcimErrorCode>;
+    /**
+     * 将某个用户加入黑名单。
+     * @param userId 需要加入黑名单的用户 ID
+     * @return Promise，code 为 RcimErrorCode
+     */
+    addToBlackList(userId: string): Promise<RcimErrorCode>;
+    /**
+     * 将某个用户移出黑名单。
+     * @param userId 需要移出黑名单的用户 ID
+     * @return Promise，code 为 RcimErrorCode
+     */
+    removeFromBlackList(userId: string): Promise<RcimErrorCode>;
+    /**
+     * 获取当前用户设置的黑名单列表。
+     * @return Promise，code 为 RcimErrorCode，userIdVec 为黑名单用户 id 列表（可能为空数组）
+     */
+    getBlackList(): Promise<{
+        code: RcimErrorCode;
+        userIdVec: string[];
+    }>;
+    /**
+     * 获取指定用户在黑名单中的状态。
+     * @return Promise，code 为 RcimErrorCode，status 为黑名单状态枚举值（number）
+     */
+    getBlackListStatus(userId: string): Promise<{
+        code: RcimErrorCode;
+        status: RcimBlacklistStatus;
+    }>;
+    /**
+     * 发送 RTC 信令。
+     * @param roomId 房间 ID
+     * @param methodName 信令方法名
+     * @param isQuery 是否 Query 信令（false 表示 Publish）
+     * @param dataInfoVec 信令数据字节数组
+     * @param timeoutSec 超时秒数
+     * @param requestIdCallback 请求 ID 回调（可选）
+     * @return Promise，code 为 RcimErrorCode，infoVec 为返回字节数组
+     */
+    sendRtcSignaling(roomId: string, methodName: string, isQuery: boolean, dataInfoVec: Uint8Array, timeoutSec: number, requestIdCallback?: ((requestId: number) => void) | null): Promise<{
+        code: RcimErrorCode;
+        infoVec: Uint8Array;
+    }>;
+    /**
+     * 设置 RTC 房间事件监听。
+     * @param listener 回调函数，接收 RTC 信令的 protobuf 二进制数据；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setRtcRoomEventListener(listener: ((buffer: Uint8Array) => void) | null): RcimErrorCode;
+    /**
+     * 设置聊天室状态监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setChatroomStatusListener(listener: ((code: RcimErrorCode, roomId: string, status: RcimChatroomStatus, info?: RcimChatroomJoinedInfo) => void) | null): RcimErrorCode;
+    /**
+     * 设置聊天室 kv 同步监听。
+     *
+     * 只通知“该聊天室 kv 已同步完成”，如需获取 kv 明细请主动调用 `getChatroomAllKvs` / `getLocalChatroomKvByKeys`。
+     *
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setChatroomKvSyncListener(listener: ((roomId: string) => void) | null): RcimErrorCode;
+    /**
+     * 设置聊天室 kv 更新监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setChatroomKvChangedListener(listener: ((roomId: string, kvVec: RcimChatroomKvInfo[]) => void) | null): RcimErrorCode;
+    /**
+     * 设置聊天室 kv 删除监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setChatroomKvDeleteListener(listener: ((roomId: string, kvVec: RcimChatroomKvInfo[]) => void) | null): RcimErrorCode;
+    /**
+     * 设置聊天室成员变化监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setChatroomMemberChangedListener(listener: ((changeInfo: RcimChatroomMemberChangeInfo) => void) | null): RcimErrorCode;
+    /**
+     * 设置聊天室成员禁言监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setChatroomMemberBannedListener(listener: ((banInfo: RcimChatroomMemberBannedInfo) => void) | null): RcimErrorCode;
+    /**
+     * 设置聊天室成员封禁监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setChatroomMemberBlockedListener(listener: ((blockInfo: RcimChatroomMemberBlockedInfo) => void) | null): RcimErrorCode;
+    /**
+     * 设置聊天室多端同步监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setChatroomMultiClientSyncListener(listener: ((syncInfo: RcimChatroomMultiClientSyncInfo) => void) | null): RcimErrorCode;
+    /**
+     * 设置会话状态监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setConversationStatusListener(listener: ((items: RcimConversationStatusChangeItem[]) => void) | null): RcimErrorCode;
+    /**
+     * 订阅事件。
+     * @param subscribeType 订阅类型
+     * @param userIdVec 订阅用户列表
+     * @param expiry 订阅有效期（秒）
+     * @return Promise，code 为 RcimErrorCode，failedUserIdVec 为失败用户列表
+     */
+    subscribeEvent(subscribeType: RcimSubscribeType, userIdVec: string[], expiry: number): Promise<{
+        code: RcimErrorCode;
+        failedUserIdVec: string[];
+    }>;
+    /**
+     * 设置消息扩展更新监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setMessageExpansionUpdateListener(listener: ((kvVec: RcimMessageExpansionKvInfo[], message?: RcimMessage) => void) | null): RcimErrorCode;
+    /**
+     * 设置消息扩展移除监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setMessageExpansionRemoveListener(listener: ((keyVec: string[], message?: RcimMessage) => void) | null): RcimErrorCode;
+    /**
+     * 设置消息接收监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setMessageReceivedListener(listener: ((message?: RcimMessage, info?: RcimReceivedInfo) => void) | null): RcimErrorCode;
+    /**
+     * 设置消息拦截监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setMessageBlockedListener(listener: ((info?: RcimMessageBlockInfo) => void) | null): RcimErrorCode;
+    /**
+     * 设置输入状态监听。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setTypingStatusListener(listener: ((convType: RcimConversationType, targetId: string, channelId: string | null, typingStatus: RcimTypingStatus[]) => void) | null): RcimErrorCode;
+    /**
+     * 设置输入状态上报间隔。
+     * @param intervalMs 上报间隔（毫秒），有效值 [1000, 60000]，超出范围则设置不成功
+     * @return Promise，code 为 RcimErrorCode
+     */
+    setTypingStatusInterval(intervalMs: number): Promise<RcimErrorCode>;
+    /**
+     * 获取指定会话类型的未读消息数量。
+     * @param convTypeVec 待获取的会话类型数组，取值范围 [1, 300]
+     * @param isContainBlocked 是否包含免打扰；true 代表获取所有会话未读数之和；false 代表获取不包含免打扰会话的正常会话未读数之和
+     * @return Promise，code 为 RcimErrorCode，count 为未读消息数量
+     */
+    getUnreadCountByConversationTypes(convTypeVec: RcimConversationType[], isContainBlocked: boolean): Promise<{
+        code: RcimErrorCode;
+        count: number;
+    }>;
+    /**
+     * 获取指定会话的未读消息数。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 null
+     * @return Promise，code 为 RcimErrorCode，count 为未读消息数量
+     */
+    getUnreadCount(convType: RcimConversationType, targetId: string, channelId?: string): Promise<{
+        code: RcimErrorCode;
+        count: number;
+    }>;
+    /**
+     * 获取本地会话。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 null
+     * @return Promise，code 为 RcimErrorCode，当 code 为 Success 时，conversation 为会话对象，否则为 undefined
+     */
+    getLocalConversation(convType: RcimConversationType, targetId: string, channelId?: string): Promise<{
+        code: RcimErrorCode;
+        conversation?: RcimConversation;
+    }>;
+    /**
+     * 获取会话的免打扰状态。
+     * @param convType 待获取的会话类型
+     * @param targetId 待获取的会话目标 ID
+     * @param channelId 待获取的频道 ID，可为 null
+     * @return Promise，code 为 RcimErrorCode，当 code 为 Success 时，muteLevel 为免打扰等级，否则为 undefined
+     */
+    getLocalConversationMuteLevel(convType: RcimConversationType, targetId: string, channelId?: string): Promise<{
+        code: RcimErrorCode;
+        muteLevel?: RcimPushNotificationMuteLevel;
+    }>;
+    /**
+     * 批量获取本地会话。
+     * @param convTypeVec 待获取的会话类型数组，取值范围 [1, 100]
+     * @param sendTime 查询的起始发送时间，返回小于该时间的会话；如果为 0，则查询全部
+     * @param count 期望返回结果的最大个数，即分页查询的每页个数，取值范围 [1, 1000]
+     * @param topPriority 是否优先返回置顶会话
+     * @return Promise，code 为 RcimErrorCode，conversations 为会话列表（可能为空数组）
+     */
+    getLocalConversationList(convTypeVec: RcimConversationType[], sendTime: number, count: number, topPriority: boolean): Promise<{
+        code: RcimErrorCode;
+        conversations: RcimConversation[];
+    }>;
+    /**
+     * 根据会话类型和过滤条件获取会话列表（支持 channelId 过滤）。
+     * @param filterParams 过滤参数数组，每项包含 convType、可选 targetId 和 channelId
+     * @param sendTime 查询的起始发送时间，0 表示全部
+     * @param count 期望返回结果的最大个数，取值范围 [1, 1000]
+     * @param topPriority 是否优先返回置顶会话
+     * @param hiddenFilter 隐藏状态过滤，0=全部 1=仅隐藏 2=仅非隐藏
+     * @return Promise，code 为 RcimErrorCode，conversations 为会话列表（可能为空数组）
+     */
+    getLocalConversationListWithOption(filterParams: Array<{
+        convType: number;
+        targetId?: string | null;
+        channelId?: string | null;
+    }>, sendTime: number, count: number, topPriority: boolean, hiddenFilter: number): Promise<{
+        code: RcimErrorCode;
+        conversations: RcimConversation[];
+    }>;
+    /**
+     * 根据关键字搜索本地会话。
+     * @param convTypeVec 会话类型数组，取值范围 [1, 300]
+     * @param channelId 频道 ID；可为 null
+     * @param objNameVec 消息类型列表；可为 null，null 表示不过滤消息类型（即全部类型）
+     * @param keyword 搜索关键字，长度范围 [1, 256]
+     * @return Promise，code 为 RcimErrorCode，conversations 为会话列表（可能为空数组）
+     */
+    searchLocalConversations(convTypeVec: RcimConversationType[], channelId: string | undefined, objNameVec: string[] | null, keyword: string): Promise<{
+        code: RcimErrorCode;
+        conversations: RcimConversation[];
+    }>;
+    /**
+     * 按类型清除本地会话，只会移除本地数据库中指定类型的会话和消息。不会删除服务器数据。
+     * @param convTypeVec 待清除的会话类型数组，取值范围 [1, 100]
+     * @return Promise，code 为 RcimErrorCode
+     */
+    clearLocalConversations(convTypeVec: RcimConversationType[]): Promise<RcimErrorCode>;
+    /**
+     * 移除远端和本地的指定会话，但会话内的消息不会删除，当有新消息到达时，仍能看到已存储的本地历史消息。
+     * @param convIdfVec 待移除会话标识符数组，长度范围 [1, 20]
+     * @return Promise，code 为 RcimErrorCode
+     */
+    removeConversations(convIdfVec: RcimConversationIdentifier[]): Promise<RcimErrorCode>;
+    /**
+     * 清除指定会话的未读数。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 null
+     * @return Promise，code 为 RcimErrorCode
+     */
+    clearMessagesUnreadStatus(convType: RcimConversationType, targetId: string, channelId?: string): Promise<RcimErrorCode>;
+    /**
+     * 根据发送时间清除指定会话未读数。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 null
+     * @param sendTime 发送时间小于等于该值的所有消息都会被清除未读状态；必须 > 0
+     * @return Promise，code 为 RcimErrorCode
+     */
+    clearMessagesUnreadStatusBySendTime(convType: RcimConversationType, targetId: string, channelId: string | undefined, sendTime: number): Promise<RcimErrorCode>;
+    /**
+     * 清除指定会话时间戳之前的本地消息。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 null
+     * @param sendTime 清除该时间戳之前的消息（毫秒）；传 0 表示清除所有消息
+     * @return Promise，code 为 RcimErrorCode，value 为是否成功
+     */
+    clearLocalMessageByTimestamp(convType: RcimConversationType, targetId: string, channelId: string | undefined, sendTime: number): Promise<{
+        code: RcimErrorCode;
+        value: boolean;
+    }>;
+    /**
+     * 保存会话草稿。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 null
+     * @param draft 草稿内容；传 null 表示清除草稿
+     * @return RcimErrorCode
+     */
+    saveTextMessageDraft(convType: RcimConversationType, targetId: string, channelId: string | undefined, draft: string | null): RcimErrorCode;
+    /**
+     * 获取会话草稿。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 null
+     * @return code 为 RcimErrorCode，draft 为草稿内容（可能为 undefined）
+     */
+    getTextMessageDraft(convType: RcimConversationType, targetId: string, channelId?: string): {
+        code: RcimErrorCode;
+        draft?: string;
+    };
+    /**
+     * 批量设置会话通知免打扰等级。
+     * @param convIdfVec 会话标识符数组
+     * @param muteLevel 免打扰等级
+     * @return Promise，code 为 RcimErrorCode
+     */
+    muteConversations(convIdfVec: RcimConversationIdentifier[], muteLevel: RcimPushNotificationMuteLevel): Promise<RcimErrorCode>;
+    /**
+     * 批量置顶/取消置顶会话（从本地）。
+     * @param convIdfVec 会话标识符数组，长度范围 [1, 20]
+     * @param isPinned 是否置顶
+     * @param needCreate 如果会话不存在，是否需要创建
+     * @param needUpdateTime 是否需要更新会话时间戳
+     * @return Promise，code 为 RcimErrorCode
+     */
+    pinConversations(convIdfVec: RcimConversationIdentifier[], isPinned: boolean, needCreate: boolean, needUpdateTime: boolean): Promise<RcimErrorCode>;
+    /**
+     * 加入聊天室。
+     * @param chatroomId 待加入聊天室的 ID
+     * @param count 进入聊天室时自动拉取的消息数量，取值范围 [0, 50]
+     * @return Promise，code 为 RcimErrorCode，当 code 为 Success 时，info 为加入聊天室信息，否则为 undefined
+     */
+    joinChatroom(chatroomId: string, count: number): Promise<{
+        code: RcimErrorCode;
+        info?: RcimChatroomJoinedInfo;
+    }>;
+    /**
+     * 加入已存在的聊天室。
+     * @param chatroomId 待加入聊天室的 ID
+     * @param count 进入聊天室时自动拉取的消息数量，取值范围 [0, 50]
+     * @return Promise，code 为 RcimErrorCode，当 code 为 Success 时，info 为加入聊天室信息，否则为 undefined
+     */
+    joinExistingChatroom(chatroomId: string, count: number): Promise<{
+        code: RcimErrorCode;
+        info?: RcimChatroomJoinedInfo;
+    }>;
+    /**
+     * 退出聊天室。
+     * @param chatroomId 待退出聊天室的 ID
+     * @return Promise，code 为 RcimErrorCode
+     */
+    quitChatroom(chatroomId: string): Promise<RcimErrorCode>;
+    /**
+     * 获取聊天室信息。
+     * @param chatroomId 待查询聊天室的 ID
+     * @param count 期望查询人员信息的数量，取值范围 [0, 20]
+     * @param order 查询顺序（RcimOrder：0 降序，1 升序）
+     * @return Promise，code 为 RcimErrorCode，当 code 为 Success 时，info 为聊天室信息，否则为 undefined
+     */
+    getChatroomInfo(chatroomId: string, count: number, order: RcimOrder): Promise<{
+        code: RcimErrorCode;
+        info?: RcimChatroomInfo;
+    }>;
+    /**
+     * 设置聊天室自定义属性。
+     * @param chatroomId 聊天室 ID
+     * @param kvVec 待设置的 kv 数组，长度范围 [1, 10]
+     * @param autoDelete 是否自动删除
+     * @param isForce 是否强制覆盖
+     * @return Promise，code 为 RcimErrorCode，failedVec 为失败 kv 列表（可能为空）
+     */
+    setChatroomKvs(chatroomId: string, kvVec: RcimChatroomKvInfo[], autoDelete: boolean, isForce: boolean): Promise<{
+        code: RcimErrorCode;
+        failedVec: RcimChatroomKeyErrorInfo[];
+    }>;
+    /**
+     * 删除聊天室自定义属性。
+     * @param chatroomId 聊天室 ID
+     * @param keyVec 待删除的 key 数组，长度范围 [1, 10]
+     * @param isForce 是否强制删除
+     * @return Promise，code 为 RcimErrorCode，failedVec 为失败 kv 列表（可能为空）
+     */
+    deleteChatroomKvs(chatroomId: string, keyVec: string[], isForce: boolean): Promise<{
+        code: RcimErrorCode;
+        failedVec: RcimChatroomKeyErrorInfo[];
+    }>;
+    /**
+     * 获取聊天室自定义属性（按 key 列表，从本地）。
+     * @param chatroomId 聊天室 ID
+     * @param keyVec 待获取的 key 数组，长度范围 [1, 100]
+     * @return Promise，code 为 RcimErrorCode，kvVec 为 kv 列表（可能为空）
+     */
+    getLocalChatroomKvByKeys(chatroomId: string, keyVec: string[]): Promise<{
+        code: RcimErrorCode;
+        kvVec: RcimChatroomKvInfo[];
+    }>;
+    /**
+     * 获取聊天室全部自定义属性。
+     * @param chatroomId 聊天室 ID
+     * @return Promise，code 为 RcimErrorCode，kvVec 为 kv 列表（可能为空）
+     */
+    getChatroomAllKvs(chatroomId: string): Promise<{
+        code: RcimErrorCode;
+        kvVec: RcimChatroomKvInfo[];
+    }>;
+    /**
+     * 向本地插入一条消息，不发送到服务器。
+     * @param message 待插入的消息对象
+     * @return Promise，error 为错误码，message 为消息对象（可选）
+     */
+    insertLocalMessage(message: RcimMessage): Promise<{
+        error: RcimErrorCode;
+        message?: RcimMessage;
+    }>;
+    /**
+     * 向本地批量插入消息，不发送到服务器。
+     * @param messages 待插入的消息对象数组，长度 [1, 500]
+     * @return Promise，error 为错误码
+     */
+    insertLocalMessages(messages: RcimMessage[]): Promise<{
+        error: RcimErrorCode;
+    }>;
+    /**
+     * 发送消息。
+     * @param message 待发送的消息对象
+     * @param option 发送可选参数（可选）
+     * @param savedCallback 消息保存回调（可选）
+     * @return Promise，error 为错误码，message 为消息对象（可选）
+     */
+    sendMessage(message: RcimMessage, option?: RcimSendMessageOption, onMessageSaved?: (message: RcimMessage) => void): Promise<{
+        error: RcimErrorCode;
+        message?: RcimMessage;
+    }>;
+    /**
+     * 发送多媒体消息。
+     * @param message 待发送的消息对象
+     * @param option 发送可选参数（可选）
+     * @param savedCallback 消息保存回调（可选）
+     * @param progressCallback 上传进度回调（可选）
+     * @return Promise，error 为错误码，message 为消息对象（可选）
+     */
+    sendMediaMessage(message: RcimMessage, option?: RcimSendMessageOption, onMessageSaved?: (message: RcimMessage) => void, onMediaMessageProgress?: (message: RcimMessage, progress: number) => void): Promise<{
+        error: RcimErrorCode;
+        message?: RcimMessage;
+    }>;
+    /**
+     * 从本地数据库指定会话中，批量获取指定发送时间前后的一批类型消息。
+     * @param convType 待查询消息的会话类型
+     * @param targetId 待查询消息的会话目标 ID
+     * @param channelId 待查询消息的频道 ID，可为 null
+     * @param objNameVec 待查询消息的消息类型列表，可为 null 表示全部类型
+     * @param sendTime 待查询消息的发送时间，0 表示最近一条消息的发送时间
+     * @param beforeCount 获取此时间之前的消息数量
+     * @param afterCount 获取此时间之后的消息数量
+     * @return Promise，code 为错误码，messages 为消息列表（可能为空）
+     */
+    getLocalHistoryMessagesByTime(convType: RcimConversationType, targetId: string, channelId: string | undefined, objNameVec: string[] | null, sendTime: number, beforeCount: number, afterCount: number): Promise<{
+        code: RcimErrorCode;
+        messages: RcimMessage[];
+    }>;
+    /**
+     * 删除远端消息。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 null
+     * @param messageVec 待删除的消息列表
+     * @param isDeleteLocal 是否同时删除本地消息
+     * @return Promise，code 为 RcimErrorCode
+     */
+    deleteRemoteMessages(convType: RcimConversationType, targetId: string, channelId: string | undefined, messageVec: RcimMessage[], isDeleteLocal: boolean): Promise<RcimErrorCode>;
+    /**
+     * 按消息类型获取本地消息列表。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 null
+     * @param objNameVec 消息类型列表
+     * @param count 拉取数量
+     * @param startTime 起始时间戳
+     * @param order 排序方式（RcimOrder：0 降序，1 升序）
+     * @return Promise，code 为 RcimErrorCode，messages 为消息列表（可能为空）
+     */
+    getLocalMessagesByObjectName(convType: RcimConversationType, targetId: string, channelId: string | undefined, objNameVec: string[], count: number, startTime: number, order: RcimOrder): Promise<{
+        code: RcimErrorCode;
+        messages: RcimMessage[];
+    }>;
+    /**
+     * 根据关键字搜索指定会话的本地消息。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 null
+     * @param keyword 搜索关键字
+     * @param count 返回的搜索结果数量
+     * @param startTime 起始发送时间
+     * @return Promise，code 为 RcimErrorCode，messages 为消息列表（可能为空）
+     */
+    searchLocalMessages(convType: RcimConversationType, targetId: string, channelId: string | undefined, keyword: string, count: number, startTime: number): Promise<{
+        code: RcimErrorCode;
+        messages: RcimMessage[];
+    }>;
+    /**
+     * 根据关键字和时间范围搜索指定会话的本地消息。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 null
+     * @param keyword 搜索关键字
+     * @param count 返回的搜索结果数量，范围 [0, 100]
+     * @param startTime 开始时间（包含该时间）
+     * @param endTime 结束时间（包含该时间）
+     * @param offset 偏移量，范围 [0, INT32_MAX]
+     * @return Promise，code 为 RcimErrorCode，messages 为消息列表（可能为空）
+     */
+    searchLocalMessagesByTime(convType: RcimConversationType, targetId: string, channelId: string | undefined, keyword: string, count: number, startTime: number, endTime: number, offset: number): Promise<{
+        code: RcimErrorCode;
+        messages: RcimMessage[];
+    }>;
+    /**
+     * 获取会话中的 @ 消息。
+     * @param convType 待获取未读消息的会话类型
+     * @param targetId 待获取未读消息的会话目标 ID
+     * @param channelId 待获取未读消息的频道 ID，可为 null
+     * @param count 期望获取的消息数量，有效范围 [1, 100]
+     * @param order 获取消息的发送时间排序方式
+     * @return Promise，code 为 RcimErrorCode，messages 为消息列表（可能为空）
+     */
+    getUnreadMentionedMessages(convType: RcimConversationType, targetId: string, channelId: string | undefined, count: number, order: RcimOrder): Promise<{
+        code: RcimErrorCode;
+        messages: RcimMessage[];
+    }>;
+    /**
+     * 更新消息扩展属性。
+     * @param kvVec 待设置的消息扩展数组
+     * @param msgUid 消息 uid
+     * @return Promise，error 为错误码
+     */
+    updateMessageExpansion(kvVec: RcimMessageExpansionKvInfo[], msgUid: string): Promise<RcimErrorCode>;
+    /**
+     * 删除消息扩展属性。
+     * @param keyVec 待删除的消息扩展 key 数组，长度范围 [1, 20]
+     * @param msgUid 消息 uid
+     * @return Promise，error 为错误码
+     */
+    removeMessageExpansion(keyVec: string[], msgUid: string): Promise<RcimErrorCode>;
+    /**
+     * 发送正在输入状态消息。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 会话频道 ID，可为 null
+     * @param objectName 正在输入的消息 ObjectName，如 RC:TxtMsg
+     * @return Promise，error 为错误码
+     */
+    sendTypingStatus(convType: RcimConversationType, targetId: string, channelId: string | undefined, objectName: string): Promise<RcimErrorCode>;
+    /**
+     * 发起群聊消息已读回执响应（V1）。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 会话频道 ID，可为 null
+     * @param msgInfoVec 已读消息数据数组
+     * @return Promise，code 为 RcimErrorCode，messages 为消息列表（可能为空）
+     */
+    sendReadReceiptResponse(convType: RcimConversationType, targetId: string, channelId: string | undefined, msgInfoVec: RcimSendReadReceiptResponseMessageData[]): Promise<{
+        code: RcimErrorCode;
+        messages: RcimMessage[];
+    }>;
+    /**
+     * 发起群聊消息已读回执请求（V1）。
+     * @param messageUid 待发起已读回执请求消息 UID
+     * @return Promise，error 为错误码
+     */
+    sendReadReceiptRequest(messageUid: string): Promise<RcimErrorCode>;
+    /**
+     * 发起群聊消息已读回执 V2 响应。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 会话频道 ID，可为 null
+     * @param messageUIds 已读消息 UID 列表，长度范围 [1, 100]
+     * @return Promise，code 为错误码，messages 为消息列表（可能为空）
+     */
+    sendReadReceiptResponseV2(convType: RcimConversationType, targetId: string, channelId: string | undefined, messageUIds: string[]): Promise<{
+        code: RcimErrorCode;
+        messages: RcimMessage[];
+    }>;
+    /**
+     * 获取群聊已读 V2 的已读成员列表。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 会话频道 ID，可为 null
+     * @param messageUId 消息 UID
+     * @return Promise，code 为错误码，totalCount 为总人数，readerVec 为已读成员列表
+     */
+    getReadReceiptV2Readers(convType: RcimConversationType, targetId: string, channelId: string | undefined, messageUId: string): Promise<{
+        code: RcimErrorCode;
+        totalCount: number;
+        readerVec: RcimReadReceiptV2ReaderInfo[];
+    }>;
+    /**
+     * 设置已读回执监听（V5）。
+     * @param listener 监听回调；传 null 取消监听
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    setReadReceiptV5Listener(listener: ((readInfoVec: RcimReadReceiptNotifyV5[]) => void) | null): RcimErrorCode;
+    /**
+     * 发送已读回执（V5 版本）。
+     * @param identifier 会话标识符
+     * @param messageUIds 消息 UID 列表，长度范围 [1, 100]
+     * @return Promise，code 为错误码，messages 为消息列表（可能为空）
+     */
+    sendReadReceiptResponseV5(identifier: RcimConversationIdentifier, messageUIds: string[]): Promise<{
+        code: RcimErrorCode;
+        messages: RcimMessage[];
+    }>;
+    /**
+     * 获取消息已读人数信息（V5 版本）。
+     * @param identifier 会话标识符
+     * @param messageUIds 消息 UID 列表，长度范围 [1, 100]
+     * @return Promise，code 为错误码，infoVec 为已读回执信息列表（可能为空）
+     */
+    getMessageReadReceiptInfoV5(identifier: RcimConversationIdentifier, messageUIds: string[]): Promise<{
+        code: RcimErrorCode;
+        infoVec: RcimReadReceiptInfoV5[];
+    }>;
+    /**
+     * 跨会话批量获取消息已读人数信息（V5 版本）。
+     * @param identifiers 消息标识符列表，长度范围 [1, 100]
+     * @return Promise，code 为错误码，infoVec 为已读回执信息列表（可能为空）
+     */
+    getMessageReadReceiptInfoByIdentifierV5(identifiers: RcimMessageIdentifier[]): Promise<{
+        code: RcimErrorCode;
+        infoVec: RcimReadReceiptInfoV5[];
+    }>;
+    /**
+     * 分页获取消息已读/未读成员列表（V5 版本）。
+     * @param identifier 会话标识符
+     * @param messageUId 消息 UID
+     * @param option 分页参数（count 范围 [1, 100]）
+     * @return Promise，code 为错误码；respondUserVec/notRespondUserVec 可能为空数组
+     */
+    getMessageReadReceiptUsersByPageV5(identifier: RcimConversationIdentifier, messageUId: string, option: RcimReadReceiptUsersOption): Promise<{
+        code: RcimErrorCode;
+        pageToken: string;
+        totalCount: number;
+        respondUserVec: RcimReadReceiptUserInfo[];
+        notRespondUserVec: RcimReadReceiptUserInfo[];
+    }>;
+    /**
+     * 按用户列表查询消息已读状态（V5 版本）。
+     * @param identifier 会话标识符
+     * @param messageUId 消息 UID
+     * @param userIdVec 待查询用户 ID 列表（至少 1 个）
+     * @return Promise，code 为错误码；respondUserVec/notRespondUserVec 可能为空数组
+     */
+    getMessageReadReceiptUsersByUsersV5(identifier: RcimConversationIdentifier, messageUId: string, userIdVec: string[]): Promise<{
+        code: RcimErrorCode;
+        respondUserVec: RcimReadReceiptUserInfo[];
+        notRespondUserVec: RcimReadReceiptUserInfo[];
+    }>;
+    /**
+     * 获取远端历史消息。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 null
+     * @param sendTime 起始时间戳
+     * @param count 拉取数量
+     * @param order 排序方式（RcimOrder：0 降序，1 升序）
+     * @param isIncludeLocal 是否包含本地消息
+     * @return Promise，code 为 RcimErrorCode，messages 为消息列表（可能为空）
+     */
+    getRemoteHistoryMessages(convType: RcimConversationType, targetId: string, channelId: string | undefined, sendTime: number, count: number, order: RcimOrder, isIncludeLocal: boolean): Promise<{
+        code: RcimErrorCode;
+        messages: RcimMessage[];
+    }>;
+    /**
+     * 从远端服务器指定会话中，清除指定发送时间之前（含）的消息。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 null
+     * @param leSendTime 锚点发送时间，删除小于等于该时间的消息；传 0 代表清除全部
+     * @return Promise，code 为 RcimErrorCode
+     */
+    cleanRemoteHistoryMessages(convType: RcimConversationType, targetId: string, channelId: string | undefined, leSendTime: number): Promise<RcimErrorCode>;
+    /**
+     * 按消息 ID 列表删除本地消息。
+     * @param msgIdVec 消息 ID 列表
+     * @return Promise，code 为 RcimErrorCode
+     */
+    deleteLocalMessagesByIds(msgIdVec: number[]): Promise<RcimErrorCode>;
+    /**
+     * 删除指定会话的本地消息。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID；可为 undefined
+     * @return Promise，code 为 RcimErrorCode
+     */
+    deleteLocalMessages(convType: RcimConversationType, targetId: string, channelId?: string): Promise<RcimErrorCode>;
+    /**
+     * 根据消息 ID 获取本地消息。
+     * @param msgId 消息 ID
+     * @return Promise，error 为错误码，message 为消息对象（可选）
+     */
+    getLocalMessageById(msgId: number): Promise<{
+        error: RcimErrorCode;
+        message?: RcimMessage;
+    }>;
+    /**
+     * 通过 uid 获取本地消息。
+     * @param uid 消息 uid
+     * @return Promise，error 为错误码，message 为消息对象（可选）
+     */
+    getLocalMessageByUid(uid: string): Promise<{
+        error: RcimErrorCode;
+        message?: RcimMessage;
+    }>;
+    /**
+     * 获取会话中的第一条未读消息。
+     * @param convType 会话类型
+     * @param targetId 会话目标 ID
+     * @param channelId 频道 ID（可为 null）
+     * @return Promise，error 为错误码，message 为消息对象（可选）
+     */
+    getFirstUnreadMessage(convType: RcimConversationType, targetId: string, channelId?: string): Promise<{
+        error: RcimErrorCode;
+        message?: RcimMessage;
+    }>;
+    /**
+     * 撤回消息。
+     * @param message 待撤回的消息对象
+     * @return Promise，error 为错误码，recallNotify 为撤回消息通知（可选）
+     */
+    recallMessage(message: RcimMessage): Promise<{
+        error: RcimErrorCode;
+        recallNotify?: RcimRecallNotificationMessage;
+    }>;
+    /**
+     * 设置消息发送状态。
+     * @param messageId 消息 ID
+     * @param sentStatus 发送状态
+     * @return Promise，code 为 RcimErrorCode
+     */
+    setMessageSentStatus(messageId: number, sentStatus: RcimSentStatus): Promise<RcimErrorCode>;
+    /**
+     * 设置消息接收状态。
+     * @param messageId 消息 ID
+     * @param receivedStatus 接收状态
+     * @return Promise，code 为 RcimErrorCode
+     */
+    setMessageReceivedStatus(messageId: number, receivedStatus: RcimReceivedStatus): Promise<RcimErrorCode>;
+    /**
+     * 设置消息内容。
+     * @param messageId 消息 ID
+     * @param content 消息内容
+     * @param objectName 消息类型名
+     * @param searchableWords 可被搜索的内容
+     * @return Promise，code 为 RcimErrorCode
+     */
+    setMessageContent(messageId: number, content: RcimMessageContent, searchableWords: string): Promise<RcimErrorCode>;
+    /**
+     * 注册自定义消息类型，并且定义消息可搜索字段。
+     * 通过此接口自定义的消息类型，消息的 content 需要是 json 类型，SDK 解析可搜索字段时，
+     * 会通过此接口设置成 key，解析 json 中的对应的 value 值，并将 value 作为可搜索字段入库。
+     * @param clazz 消息内容构造器
+     * @param searchableKeyVec 可搜索字段 key 数组（可选）
+     * @return RcimErrorCode，Success 表示成功，其他表示失败
+     */
+    registerMessageTypeWithSearchableKey(clazz: RcimMessageContentConstructor, searchableKeyVec?: string[]): RcimErrorCode;
+    /**
+     * 注册自定义消息
+     * 直接通过 objectName 和 mesasgeFlag 注册自定义消息，此类消息在返回时候的类型为 RcimUnknownMessage
+     * 可以通过
+     * @param objectName 与移动端对齐的消息结构类型，如：RC:TxtMsg
+     * @param mesasgeFlag 是否存储或计数标记
+     * @param searchProps 可搜索字段 key 数组（可选）
+     */
+    registerMessageTypeWithSearchableKeyByObjectName(objectName: string, mesasgeFlag: RcimMessageFlag, searchProps: string[]): RcimErrorCode;
+    /**
+     * 设置流式消息事件监听。
+     * @param listener 流式消息事件监听回调函数（传 null 取消监听）
+     * @return RcimErrorCode，Success 表示成功
+     */
+    setStreamMessageRequestEventListener(listener: ((event: RcimStreamMessageRequestEvent, message?: RcimMessage, chunkInfo?: RcimStreamMessageChunkInfo, completeCode?: RcimErrorCode) => void) | null): RcimErrorCode;
+    /**
+     * 请求流式消息。
+     * @param messageUid 消息 UID
+     * @return Promise，error 为错误码
+     */
+    requestStreamMessage(messageUid: string): Promise<{
+        error: RcimErrorCode;
+    }>;
+}
+//# sourceMappingURL=RCIMEngine.d.ts.map