@rongcloud/engine 5.10.3 → 5.10.4

package/index.d.ts

@@ -2817,6 +2817,9 @@ declare enum LogTagId {
     L_CONNECT_T = "L-connect-T",
     L_CONNECT_R = "L-connect-R",
     L_CONNECT_S = "L-connect-S",
+    L_DB_UPGRATE_START_S = "L-db_upgrate_start-S",
+    L_DB_UPGRATING_S = "L-db_upgrating-S",
+    L_DB_UPGRATE_COMPLETE_S = "L-db_upgrate_complete-S",
     L_NOTIFY_ULTRA_ONLINE_S = "L-notify-ultra-online-S",
     L_ULTRA_SYNC_DONE_S = "L-ultra-sync-done-S",
     L_BATCH_MESSAGE_O = "L-BATCH_MESSAGE-O",
@@ -6300,6 +6303,18 @@ interface IConnectionListener {
      * @param code 连接终止原因
      */
     onDisconnected(code: ErrorCode): void;
+    /**
+     * 数据库升级开始
+     */
+    onDBUpgrateStart?: () => void;
+    /**
+     * 数据库升级中
+     */
+    onDBUpgrading?: (process: number) => void;
+    /**
+     * 数据库升级完成
+     */
+    onDBUpgradeComplete?: (code: number) => void;
 }
 /**
  * 抽象连接管理器类，负责 engine 层的连接状态维持，和对外的连接状态通知
@@ -8149,6 +8164,9 @@ interface IWatcher {
     subscribedRelationChange?: (data: ISubscribeRelationInfo[]) => void;
     syncSubscribedUserStatusFinished?: (subscribeType: SubscribeType) => void;
     ownUserProfileChanged?: (userProfile: IUserProfileInfo) => void;
+    databaseUpgradeWillStart?: () => void;
+    databaseUpgrading?: (progress: number) => void;
+    databaseUpgradeDidComplete?: (code: ErrorCode) => void;
 }
 interface IAPIContextOption {
     /**
@@ -8472,6 +8490,18 @@ declare class APIContext {
      * 导航数据变更通知
      */
     private _naviDataChange;
+    /**
+     * 数据库升级开始
+     */
+    private _databaseUpgradeWillStart;
+    /**
+     * 数据库升级中
+     */
+    private _databaseUpgrading;
+    /**
+     * 数据库升级完成
+     */
+    private _databaseUpgradeDidComplete;
     /**
      * 业务层事件监听器挂载点
      */
@@ -9603,6 +9633,9 @@ interface IEngineWatcher extends IConnectionListener {
     subscribedRelationChange?: (data: ISubscribeRelationInfo[]) => void;
     syncSubscribedUserStatusFinished?: (subscribeType: SubscribeType) => void;
     ownUserProfileChanged?: (data: IUserProfileInfo) => void;
+    databaseUpgradeWillStart: () => void;
+    databaseUpgrading: (progress: number) => void;
+    databaseUpgradeDidComplete: (code: ErrorCode) => void;
 }
 /**
  * 引擎定义
@@ -11141,6 +11174,16 @@ declare const completeSubscriptionPlatformStatus: (status: ISubscribeStatusDetai
  * 将收到的用户信息转换为本地数据结构
  */
 declare const transformUserProfiles: (userId: string, userProfiles: IServerProfileInfo[], userExtProfiles: IServerProfileInfo[]) => IUserProfileInfo;
+/**
+ * 是否支持 IndexDB
+ * @param runtime
+ * @returns
+ */
+declare const isSupportIndexDB: (runtime: IRuntime) => boolean;
+/**
+ * 清理废弃的数据库
+ */
+declare const clearOldIndexDB: () => void;
 
 /**
  * Navi 缓存数据有效时长，单位毫秒
@@ -11496,4 +11539,4 @@ declare type AbsCodec<T> = Codec<T>;
  */
 declare const version: string;
 
-export { AConnectionMgr, AEngine, APIContext, AbsCodec, AppStorage, AreaCode, AssertRules, BaseCloudController, BasicLogger, BasicNavi, BasicReporter, BasicStaticConfigManager, BasicStatistic, BasicStatisticReporter, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectReason, ConnectType, ConnectionStatus, Content, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, EConnectProtocol, EnableLogL, EnterpriseType, ErrorCode, ErrorCodeMap, EventEmitter, FORMATED_VERSION, FileType, HTTP_TIMEOUT, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBaseStatisticsData, IBlockedMessageInfo, ICancelRoomPKOptions, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListener, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IClearMessageOption, ICloudController, ICombineV2MessageContent, ICombinedMessage, IConnectResult, IConnectionListener, IConnectionStatusListener, IConversationIdentifier, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IFirstUnreadMessageInfo, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupReadReceiptData, IHarmonyOSPushConfig, IInsertMessage, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogDB, ILogData, ILogger, IMRTRConfig, IM_CHATROOM_PULL_INTERVAL_TIME, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IMetionedData, INaviCache, INaviContextInfo, INaviInfo, INetwork, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPluginGenerator, IPrivateReadReceiptData, IProcessCache, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerAddressData, IServerConversationStatus, IServerProfileInfo, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStaticConfig, IStatistic, IStatisticDB, IStatisticData, IStatisticsCMPData, IStatisticsCSData, IStatisticsDurData, IStatisticsNaviData, IStatisticsNetworkData, IStatisticsRMTPData, IStatisticsWebsocketData, IStorage, ISubData, ISubscribeLocalStore, ISubscribeRelationInfo, ISubscribeRelationServerData, ISubscribeStatusDetail, ISubscribeUserLocalBaseData, ISubscribeUserLocalOnlineData, ISubscribeUserLocalProfileData, ISubscribeUserStatusInfo, ISubscribeUserStatusServerData, ISyncReadStatusData, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadConversation, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUploadTask, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IUserProfileInfo, IUserProfileServerData, IWatcher, IWebSocket, IiOSPushConfig, IndexDBLogger, IndexDBReporter, IndexDBStatistic, IndexDBStatisticReporter, RTCKeyMaps as InnerRTCKeyMaps, InterruptionLevel, InvokerType, ItypingStateListener, KVString, LOCAL_STORAGE_KEYS, LiveRole, LiveType, LogContent, LogL, LogLevel, LogSource, LogTagId, LogType, MAX_CHATROOM_NOTIFICATION_EXTRA_LENGTH, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MAX_UPLOAD_FILE_SIZE, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NON_SUBSCRIBE_USER_PROFILE_VALID_TIME, NaviCacheType, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OnlineStatus, OperateStatus, PlatformInfo, PluginContext, ProtocalType, PushImportanceHonor, RCAssertError, RCConnectionStatus, RC_DEFAULT_USER, READ_RECEIPT_CATCH_TIME, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATIC_CONFIG_CACHE_TIME, STATIC_CONFIG_IV, STATIC_CONFIG_KEY, STATUS_MESSAGE, SUBSCRIBE_USER_PROFILE_VALID_TIME, SentStatus, StatisticL, StatisticsTag, StatisticsVersion, StoreKeys, SubscribeDataType, SubscribeOperationType, SubscribeType, SuspendablePromise, TagChangeType, Type, UPLOAD_FILE_CHUNK_SIZE, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMentionedType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, UserGroupChangeType, UserProfileVisibility, VERSION, ValidatorManage, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketNavi, appendUrl, assert, clone, cloneByJSON, completeSubscriptionPlatformStatus, deInitLogDB, decryptCBC, fixUrlProtocol, forEach, getBrowser, getClientMessageId, getDeviceId, getMessageUIdHash, getMimeKey, getMinionURL, getUUID, getUUID22, getUploadFileName, getbundleId, httpRequest, indexOf, initLogDB, initStatisticDB, isArray, isArrayBuffer, isBoolean, isConnnectAckCode as isConnnectAck, isDisconnectCode as isDisconnectedByServer, isFunction, isHttpUrl, isInObject, isInclude, isInteger, isLimitedArray, isLimitedString, isNull, isNumber, isObject, isStartCloudController, isString, isTypeInConversationList, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversation, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, isValidTargetId, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, statisticTranscsv, todo, transcsv, transformReceivedStatusFlag, transformReceivedStatusInfo, transformUserProfiles, unInitStatisticDB, updateMentionedInfo, urlCenter, usingCppEngine, validate, validators, version };
+export { AConnectionMgr, AEngine, APIContext, AbsCodec, AppStorage, AreaCode, AssertRules, BaseCloudController, BasicLogger, BasicNavi, BasicReporter, BasicStaticConfigManager, BasicStatistic, BasicStatisticReporter, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectReason, ConnectType, ConnectionStatus, Content, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, EConnectProtocol, EnableLogL, EnterpriseType, ErrorCode, ErrorCodeMap, EventEmitter, FORMATED_VERSION, FileType, HTTP_TIMEOUT, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBaseStatisticsData, IBlockedMessageInfo, ICancelRoomPKOptions, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListener, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IClearMessageOption, ICloudController, ICombineV2MessageContent, ICombinedMessage, IConnectResult, IConnectionListener, IConnectionStatusListener, IConversationIdentifier, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IFirstUnreadMessageInfo, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupReadReceiptData, IHarmonyOSPushConfig, IInsertMessage, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogDB, ILogData, ILogger, IMRTRConfig, IM_CHATROOM_PULL_INTERVAL_TIME, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IMetionedData, INaviCache, INaviContextInfo, INaviInfo, INetwork, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPluginGenerator, IPrivateReadReceiptData, IProcessCache, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerAddressData, IServerConversationStatus, IServerProfileInfo, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStaticConfig, IStatistic, IStatisticDB, IStatisticData, IStatisticsCMPData, IStatisticsCSData, IStatisticsDurData, IStatisticsNaviData, IStatisticsNetworkData, IStatisticsRMTPData, IStatisticsWebsocketData, IStorage, ISubData, ISubscribeLocalStore, ISubscribeRelationInfo, ISubscribeRelationServerData, ISubscribeStatusDetail, ISubscribeUserLocalBaseData, ISubscribeUserLocalOnlineData, ISubscribeUserLocalProfileData, ISubscribeUserStatusInfo, ISubscribeUserStatusServerData, ISyncReadStatusData, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadConversation, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUploadTask, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IUserProfileInfo, IUserProfileServerData, IWatcher, IWebSocket, IiOSPushConfig, IndexDBLogger, IndexDBReporter, IndexDBStatistic, IndexDBStatisticReporter, RTCKeyMaps as InnerRTCKeyMaps, InterruptionLevel, InvokerType, ItypingStateListener, KVString, LOCAL_STORAGE_KEYS, LiveRole, LiveType, LogContent, LogL, LogLevel, LogSource, LogTagId, LogType, MAX_CHATROOM_NOTIFICATION_EXTRA_LENGTH, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MAX_UPLOAD_FILE_SIZE, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NON_SUBSCRIBE_USER_PROFILE_VALID_TIME, NaviCacheType, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OnlineStatus, OperateStatus, PlatformInfo, PluginContext, ProtocalType, PushImportanceHonor, RCAssertError, RCConnectionStatus, RC_DEFAULT_USER, READ_RECEIPT_CATCH_TIME, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATIC_CONFIG_CACHE_TIME, STATIC_CONFIG_IV, STATIC_CONFIG_KEY, STATUS_MESSAGE, SUBSCRIBE_USER_PROFILE_VALID_TIME, SentStatus, StatisticL, StatisticsTag, StatisticsVersion, StoreKeys, SubscribeDataType, SubscribeOperationType, SubscribeType, SuspendablePromise, TagChangeType, Type, UPLOAD_FILE_CHUNK_SIZE, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMentionedType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, UserGroupChangeType, UserProfileVisibility, VERSION, ValidatorManage, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketNavi, appendUrl, assert, clearOldIndexDB, clone, cloneByJSON, completeSubscriptionPlatformStatus, deInitLogDB, decryptCBC, fixUrlProtocol, forEach, getBrowser, getClientMessageId, getDeviceId, getMessageUIdHash, getMimeKey, getMinionURL, getUUID, getUUID22, getUploadFileName, getbundleId, httpRequest, indexOf, initLogDB, initStatisticDB, isArray, isArrayBuffer, isBoolean, isConnnectAckCode as isConnnectAck, isDisconnectCode as isDisconnectedByServer, isFunction, isHttpUrl, isInObject, isInclude, isInteger, isLimitedArray, isLimitedString, isNull, isNumber, isObject, isStartCloudController, isString, isSupportIndexDB, isTypeInConversationList, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversation, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, isValidTargetId, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, statisticTranscsv, todo, transcsv, transformReceivedStatusFlag, transformReceivedStatusInfo, transformUserProfiles, unInitStatisticDB, updateMentionedInfo, urlCenter, usingCppEngine, validate, validators, version };