AppUpdate Android Library

For projects with custom API requirements, use the updateApp builder to configure request methods, custom parameters, download paths, and UI styling. You must implement the parseJson block to map your server's JSON response to an UpdateAppBean object.

// Download path
val path = Environment.getExternalStorageDirectory().absolutePath
// Custom parameters
val params = HashMap<String, String>()
params.put("appKey", "ab55ce55Ac4bcP408cPb8c1Aaeac179c5f6f")
params.put("appVersion", AppUpdateUtils.getVersionName(this))
params.put("key1", "value2")
params.put("key2", "value3")

updateApp(mUpdateUrl, UpdateAppHttpUtil())
{
    isPost = false
    setParams(params)
    hideDialogOnDownloading(true)
    topPic = R.mipmap.top_8
    targetPath = path
}
.check {
    onBefore { showProgressDialog() }
    parseJson {
        val jsonObject = JSONObject(it)
        UpdateAppBean()
            .setUpdate(jsonObject.optString("update"))
            .setNewVersion(jsonObject.optString("new_version"))
            .setApkFileUrl(jsonObject.optString("apk_file_url"))
            .setUpdateLog(jsonObject.optString("update_log"))
            .setTargetSize(jsonObject.optString("target_size"))
            .setConstraint(false)
            .setNewMd5(jsonObject.optString("new_md5"))
    }
    noNewApp { toast("没有新版本") }
    onAfter { cancelProgressDialog() }
}

To use your own UI for the update prompt, override the hasNewApp method in UpdateCallback. You can then use the provided UpdateAppBean to populate your dialog and use updateAppManager.download() to trigger the download process.

To monitor download progress within your custom dialog, pass a DownloadService.DownloadCallback to the download() method.

// 1. Override hasNewApp to show your own dialog
@Override
public void hasNewApp(UpdateAppBean updateApp, UpdateAppManager updateAppManager) {
    showDiyDialog(updateApp, updateAppManager);
}

// 2. Inside your dialog, trigger download with a progress callback
private void showDiyDialog(final UpdateAppBean updateApp, final UpdateAppManager updateAppManager) {
    // ... setup your AlertDialog ...
    .setPositiveButton("升级", new DialogInterface.OnClickListener() {
        @Override
        public void onClick(DialogInterface dialog, int which) {
            updateAppManager.download(new DownloadService.DownloadCallback() {
                @Override
                public void onStart() { /* Show progress UI */ }

                @Override
                public void onProgress(float progress, long totalSize) {
                    // progress is 0.00 - 1.00
                }

                @Override
                public boolean onFinish(File file) {
                    // Return true to auto-install, false to just finish download
                    return true;
                }

                @Override
                public void onError(String msg) { /* Handle error */ }
            });
            dialog.dismiss();
        }
    })
}

Silent updates download the APK in the background (e.g., only on WiFi) and only prompt the user once the download is complete.

Default Protocol Silent Update: Use .silenceUpdate() on the builder.

Custom Protocol Silent Update: Use .checkNewApp() with a SilenceUpdateCallback. The showDialog method in the callback is triggered after the download finishes, providing the File object for installation.

// Default protocol silent update
new UpdateAppManager.Builder()
        .setActivity(this)
        .setUpdateUrl(mUpdateUrl)
        .setHttpManager(new UpdateAppHttpUtil())
        .setOnlyWifi()
        .build()
        .silenceUpdate();

// Custom protocol silent update
new UpdateAppManager.Builder()
        .setActivity(this)
        .setUpdateUrl(mUpdateUrl)
        .setHttpManager(new OkGoUpdateHttpUtil())
        .build()
        .checkNewApp(new SilenceUpdateCallback() {
            @Override
            protected void showDialog(UpdateAppBean updateApp, UpdateAppManager updateAppManager, File appFile) {
                // Show your dialog and call AppUpdateUtils.installApp(context, appFile) on click
            }
        });

If your server uses a different API structure, use the checkNewApp method with a custom UpdateCallback. You must implement parseJson to map your server's response to an UpdateAppBean object.

Customizable Options via Builder:

• setPost(boolean): Set request method (default is GET).
• setParams(Map<String, String>): Add custom request parameters.
• hideDialogOnDownloading(boolean): If true, the dialog disappears once downloading starts.
• setTopPic(int resId): Set a header image; the library automatically extracts the theme color for buttons and progress bars.
• setTargetPath(String path): Specify where to save the APK.
• dismissNotificationProgress(): Hides the notification bar progress indicator.
• showIgnoreVersion(): Allows the user to ignore the update version.

new UpdateAppManager
        .Builder()
        .setActivity(this)
        .setHttpManager(new OkGoUpdateHttpUtil())
        .setUpdateUrl(mUpdateUrl)
        .setPost(false)
        .setParams(params)
        .hideDialogOnDownloading(false)
        .setTopPic(R.mipmap.top_8)
        .setTargetPath(path)
        .dismissNotificationProgress()
        .build()
        .checkNewApp(new UpdateCallback() {
            @Override
            protected UpdateAppBean parseJson(String json) {
                UpdateAppBean updateAppBean = new UpdateAppBean();
                try {
                    JSONObject jsonObject = new JSONObject(json);
                    updateAppBean
                            .setUpdate(jsonObject.optString("update"))
                            .setNewVersion(jsonObject.optString("new_version"))
                            .setApkFileUrl(jsonObject.optString("apk_file_url"))
                            .setUpdateLog(jsonObject.optString("update_log"))
                            .setTargetSize(jsonObject.optString("target_size"))
                            .setConstraint(false)
                            .setNewMd5(jsonObject.optString("new_md51"));
                } catch (JSONException e) {
                    e.printStackTrace();
                }
                return updateAppBean;
            }

            @Override
            public void onBefore() { /* Show loading dialog */ }

            @Override
            public void onAfter() { /* Hide loading dialog */ }

            @Override
            public void noNewApp() { /* Handle no update case */ }
        });