@rongcloud/imlib-next 5.26.1 → 5.26.2

package/index.d.ts

@@ -415,8 +415,16 @@ declare enum Events {
      * @since 5.2.0
      */
     ULTRA_GROUP_ENABLE = "ULTRA_GROUP_ENABLE",
+    /** [EN]
+     * Single group chat conversation list synchronization completed
+     * * Non Electron platform only valid after the "conversation list supports super group" function is enabled. When the switch is off, the local will not cache the single group chat conversation list.
+     * * Since 5.28.0, Electron platform enables the "synchronize server conversation information to local" function, this event will be triggered when the synchronization of server conversation list is completed.
+     * @since 5.20.0
+     */
     /**
-     * 单群聊会话列表同步完成，仅在会话列表支持超级群功能后有效。开关关闭的情况下，本地不会缓存单群聊会话列表。
+     * 单群聊会话列表同步完成
+     * * 非 Electron 平台下，仅在“会话列表支持超级群”功能开启后有效。开关关闭的情况下，本地不会缓存单群聊会话列表。
+     * * 5.28.0 版本开始，Electron 平台开启了“同步服务器会话信息到本地”功能后，该事件将在同步服务器会话列表完成时触发。
      * @since 5.20.0
      */
     CONVERSATIONS_SYNCED = "CONVERSATIONS_SYNCED",
@@ -1635,7 +1643,7 @@ declare type EventListeners = {
     [Events.USER_SETTINGS_SYNCED]: (code: number) => void;
     [Events.USER_SETTINGS_CHANGED]: (evt: IUserSettingsChangedEvent) => void;
     [Events.CONVERSATIONS_SETTINGS_SYNCED]: (code: number) => void;
-    [Events.CONVERSATIONS_SYNCED]: () => void;
+    [Events.CONVERSATIONS_SYNCED]: (code: number) => void;
     [Events.CONVERSATION_TAG]: () => void;
     [Events.TYPING_STATUS]: (event: ITypingStatusEvent) => void;
     [Events.MESSAGE_BLOCKED]: (data: IBlockedMessageInfo) => void;
@@ -5479,6 +5487,12 @@ declare function getConversations(conversations: IConversationOption[]): Promise
  * @returns 返回一个 {@link RCResult} 类型 Promise，data 为 {@link IAReceivedConversation} 类型数组
  */
 declare function getUntaggedConversationListByPage(timestamp: number, count: number, topPriority: boolean): Promise<RCResult<IAReceivedConversation[]>>;
+/**
+ * 同步服务器会话列表至本地数据库，同步完成后，SDK 将通知 `Events.CONVERSATIONS_SYNCED` 事件。
+ * 该接口需要开通“同步服务端会话信息到本地”，且未开启“SDK 自动拉取服务端会话”功能时才能使用，否则将返回错误码。
+ * @since 5.28.0
+ */
+declare function getRemoteConversations(): Promise<RCResult>;
 
 /** [EN]
  * Search local messages by keyword
@@ -6465,6 +6479,7 @@ declare const index_getAllConversationList: typeof getAllConversationList;
 declare const index_searchConversationByContent: typeof searchConversationByContent;
 declare const index_getConversations: typeof getConversations;
 declare const index_getUntaggedConversationListByPage: typeof getUntaggedConversationListByPage;
+declare const index_getRemoteConversations: typeof getRemoteConversations;
 declare const index_searchMessages: typeof searchMessages;
 declare const index_searchMessageInTimeRange: typeof searchMessageInTimeRange;
 declare const index_searchMessagesByUser: typeof searchMessagesByUser;
@@ -6497,6 +6512,7 @@ declare namespace index {
     index_searchConversationByContent as searchConversationByContent,
     index_getConversations as getConversations,
     index_getUntaggedConversationListByPage as getUntaggedConversationListByPage,
+    index_getRemoteConversations as getRemoteConversations,
     index_searchMessages as searchMessages,
     index_searchMessageInTimeRange as searchMessageInTimeRange,
     index_searchMessagesByUser as searchMessagesByUser,
@@ -7928,9 +7944,11 @@ declare function getConversation(options: IConversationOption): Promise<RCResult
 /**
  * 移除指定的会话
  * * 自 5.20.0 版本开始，该接口支持删除超级群会话；
+ * * 自 5.26.2 版本开始，该接口支持 Electron 平台删除服务器端会话
  * @category 会话
  * @description 移除指定的会话，不会删除会话内的消息
  * @param options 会话信息
+ * @param deleteRemotely 是否删除服务器端会话，该参数仅 Electron 平台有效
  * @example
  * 移除指定的会话示例：
  * ```ts
@@ -7942,7 +7960,7 @@ declare function getConversation(options: IConversationOption): Promise<RCResult
  * console.info('移除指定的会话结果：', conversation);
  * ```
  */
-declare const removeConversation: MonitorableAPI<(options: IConversationOption) => Promise<RCResult>>;
+declare const removeConversation: MonitorableAPI<(options: IConversationOption, deleteRemotely?: boolean | undefined) => Promise<RCResult>>;
 /** [EN]
  * Batch remove conversations
  * @param conversations Conversation list, with a maximum of 20 items