Skip to main content

Monitor Database Upgrade Status

Starting from version 5.10.4, the SDK introduces a database upgrade status monitoring interface. When an SDK upgrade involves changes to the database module, an overlay installation of the SDK will trigger a database upgrade. During the database upgrade, the connection status may become unstable. Therefore, a database upgrade status monitoring interface is added to allow developers to include upgrade prompts or progress pages when a database upgrade event is received, alleviating user waiting anxiety.

tip

The database upgrade is automatically triggered by the SDK and will not result in user data loss. The upgrade time depends on the phone's performance, database version, and size, and the specific duration cannot be estimated.

The following interfaces have been added to RongIMClient to add and remove database upgrade status listeners:

  • addDatabaseStatusListener
  • removeDatabaseStatusListener

Sample Code

// Set up a database upgrade status listener
public void addDatabaseStatusListener(IRongCoreListener.DatabaseUpgradeStatusListener listener);

// Remove a database upgrade status listener
public void removeDatabaseStatusListener(IRongCoreListener.DatabaseUpgradeStatusListener listener);

You can customize your own database upgrade status listener by implementing the DatabaseUpgradeStatusListener interface with the following 3 functions.

  • databaseUpgradeWillStart: The database upgrade starts.
  • databaseIsUpgrading: The database upgrade is in progress.
  • databaseUpgradeDidComplete: The database upgrade is complete.

Sample Code

public interface DatabaseUpgradeStatusListener {
    /**
     * The database upgrade starts.
     */
    public abstract void databaseUpgradeWillStart();

    /**
     * Callback when the database upgrade is in progress.
     *
     * @param progress The progress value ranges from 0 to 100.
     */
    public abstract void databaseIsUpgrading(int progress);

    /**
     * Callback when the database upgrade is complete.
     *
     * @param code Returns {IRongCoreEnum.CoreErrorCode.SUCCESS} if the upgrade is successful, or
     *     {IRongCoreEnum.CoreErrorCode.RC_DB_UPGRADE_FAILED} if the upgrade fails.
     */
    public abstract void databaseUpgradeDidComplete(IRongCoreEnum.CoreErrorCode code);
}
Last updated on