@rongcloud/engine 5.26.1 → 5.26.2

package/index.d.ts

@@ -309,6 +309,8 @@ declare const LogTagId: {
     readonly A_BATCH_DEL_CONVERS_T: "A-batch_del_conversation-T";
     readonly A_BATCH_DEL_CONVERS_R: "A-batch_del_conversation-R";
     readonly L_UPDATE_MSG_BOX_TIME_O: "L-update_msg_box_time-O";
+    readonly A_SYNC_REMOTE_CONVERSATIONS_T: "A-e_sync_remote_conversations-T";
+    readonly A_SYNC_REMOTE_CONVERSATIONS_R: "A-e_sync_remote_conversations-R";
 };
 
 /** [EN]
@@ -5042,7 +5044,7 @@ interface IUpdateItem {
      * Contains @ mention
      */
     /**
-     * 存在 @ 信息
+     * 存在 @ 信息变更，不支持 Electron 平台
      */
     hasMentioned?: {
         time: number;
@@ -5052,7 +5054,7 @@ interface IUpdateItem {
      * @ Information
      */
     /**
-     * @ 信息
+     * @ 信息变更，不支持 Electron 平台
      */
     mentionedInfo?: {
         time: number;
@@ -5062,7 +5064,7 @@ interface IUpdateItem {
      * Unread count change
      */
     /**
-     * 未读数变更
+     * 未读数变更，不支持 Electron 平台
      */
     unreadMessageCount?: {
         time: number;
@@ -5082,7 +5084,7 @@ interface IUpdateItem {
      * The last message in the conversation has changed.
      */
     /**
-     * 会话最后一条消息变更
+     * 会话最后一条消息变更，不支持 Electron 平台
      */
     latestMessage?: {
         time: number;
@@ -9767,10 +9769,10 @@ interface INaviInfo {
      */
     ugDriven?: number;
     /**
-     * 会话列表配置
-     * * 第一位：会话列表是否包含超级群会话，0 为关闭，1 表示开启；
-     * * 第二位：协议栈是否拉服务端会话列表，0 为关闭，1 表示开启；
-     * * 第三位：协议栈自动拉取服务端会话列表，0 为关闭，1 表示开启；仅当第二位为 1 时有效
+     * 会话列表配置，按位取值：
+     * * 0001：会话列表是否包含超级群会话，0 为关闭，1 表示开启；
+     * * 0010：协议栈是否允许拉取服务端会话列表，0 为关闭，1 表示开启；
+     * * 0100：协议栈是否自动拉取服务端会话列表，0 为关闭，1 表示开启；仅当第二位为 1 时有效
      */
     sessionCfg?: number;
     /**
@@ -12165,6 +12167,10 @@ interface IIPCMethods {
      * @param messageInfoMap 消息发送时间映射，仅 Web 端超级群会话有效
      */
     refreshReferenceMessageWithParams(messageUIds: string[], conversationIdentifier: IConversationOption, remoteMessageBlock: ((results: IEnginRefreshReferenceMessageResult[]) => void) | string, localMessageBlock: ((results: IEnginRefreshReferenceMessageResult[]) => void) | string, messageInfoMap?: Record<string, string>): Promise<RCResult>;
+    /**
+     * 同步服务器会话列表至本地数据库
+     */
+    syncRemoteConversations(): Promise<RCResult>;
 }
 
 /**
@@ -12468,7 +12474,7 @@ interface IEngineWatcher extends IConnectionListener<false> {
      */
     conversationTag: () => void;
     ultraGroupEnable: () => void;
-    sgRelationsSynced: () => void;
+    sgRelationsSynced: (code: number) => void;
     operateStatus: (status: IOperateStatusNotify) => void;
     ultraGroupMessageExpansionUpdated: (list: IReceivedMessage[]) => void;
     ultraGroupMessageRecalled: (list: IReceivedMessage[]) => void;
@@ -13752,7 +13758,7 @@ interface IWatcher {
      */
     messageBlocked?: IMessageBlockedListener;
     ultraGroupEnable?: () => void;
-    sgRelationsSynced?: () => void;
+    sgRelationsSynced?: (code: number) => void;
     operateStatus?: (status: IOperateStatusNotify) => void;
     ultraGroupMessageExpansionUpdated?: (list: IReceivedMessage[]) => void;
     ultraGroupMessageRecalled?: (list: IReceivedMessage[]) => void;
@@ -14311,7 +14317,7 @@ declare class APIContext {
     /**
      * 删除会话
      */
-    removeConversation(conversation: IConversationOption): Promise<RCResult>;
+    removeConversation(conversation: IConversationOption, deleteRemotely?: boolean): Promise<RCResult>;
     batchDeleteConversations(params: ConversationBatchDeletionParams): Promise<RCResult>;
     /**
      * 获取超级群会话列表
@@ -14910,6 +14916,10 @@ declare class APIContext {
     getAutoTranslateEnabled(): Promise<RCResult<boolean>>;
     modifyMessageWithParams(params: IModifyMessageParams): Promise<RCResult>;
     refreshReferenceMessageWithParams(params: IRefreshReferenceMessageParams): Promise<RCResult>;
+    /**
+     * Electron 平台下同步服务器会话列表至本地数据库
+     */
+    syncRemoteConversations(): Promise<RCResult>;
 }
 
 declare class RTCPluginContext extends PluginContext {
@@ -15114,7 +15124,7 @@ declare class RTCPluginContext extends PluginContext {
 /**
  * 会话聊天模块
  */
-declare type IChatModule = Pick<IIPCMethods, 'getConversationListByFilter' | 'getTotalUnreadCount' | 'getConversation' | 'batchSetConversationToTop' | 'batchSetConversationNotificationLevel' | 'getConversationNotificationLevel' | 'setConversationTypeNotificationLevel' | 'getConversationTypeNotificationLevel' | 'clearAllUnreadCount' | 'deleteRemoteMessage' | 'deleteRemoteMessageByTimestamp' | 'batchClearRemoteHistoryMessages' | 'sendReadReceiptResponseV5' | 'getMessageReadReceiptInfoV5ByIdentifiers' | 'getMessagesReadReceiptUsersByPageV5' | 'getMessagesReadReceiptByUsersV5' | 'searchConversationByContent' | 'requestSpeechToTextForMessage' | 'setMessageSpeechToTextVisible' | 'addTagForConversations' | 'getTagsForConversation' | 'setConversationStatusInTag' | 'removeTagForConversations' | 'removeTagsForConversation' | 'getConversationListByTag' | 'getUnreadCountByTag' | 'getUntaggedConversationListByPage' | 'batchSetConversationTranslateStrategy' | 'modifyMessageWithParams' | 'refreshReferenceMessageWithParams' | 'batchDeleteConversations' | 'sendReadReceiptV2'>;
+declare type IChatModule = Pick<IIPCMethods, 'getConversationListByFilter' | 'getTotalUnreadCount' | 'getConversation' | 'batchSetConversationToTop' | 'batchSetConversationNotificationLevel' | 'getConversationNotificationLevel' | 'setConversationTypeNotificationLevel' | 'getConversationTypeNotificationLevel' | 'clearAllUnreadCount' | 'deleteRemoteMessage' | 'deleteRemoteMessageByTimestamp' | 'batchClearRemoteHistoryMessages' | 'sendReadReceiptResponseV5' | 'getMessageReadReceiptInfoV5ByIdentifiers' | 'getMessagesReadReceiptUsersByPageV5' | 'getMessagesReadReceiptByUsersV5' | 'searchConversationByContent' | 'requestSpeechToTextForMessage' | 'setMessageSpeechToTextVisible' | 'addTagForConversations' | 'getTagsForConversation' | 'setConversationStatusInTag' | 'removeTagForConversations' | 'removeTagsForConversation' | 'getConversationListByTag' | 'getUnreadCountByTag' | 'getUntaggedConversationListByPage' | 'batchSetConversationTranslateStrategy' | 'modifyMessageWithParams' | 'refreshReferenceMessageWithParams' | 'batchDeleteConversations' | 'sendReadReceiptV2' | 'syncRemoteConversations'>;
 
 /**
  * 聊天室模块