CheckVersionLib Documentation

To create a custom UI for the update dialog:

1. Create an Activity that extends VersionDialogActivity.
2. Set the Activity's theme to transparent: android:theme="@style/versionCheckLibvtransparentTheme".
3. Set the launch mode to singleTask: android:launchMode="singleTask".
4. Register your custom class in VersionParams using setCustomDownloadActivityClass(YourCustomActivity.class).

Key Methods for Customization:

• getVersionTitle(): Retrieves the title passed from the service.
• getVersionUpdateMsg(): Retrieves the update message passed from the service.
• getVersionParamBundle(): Retrieves the extra parameters passed from the service.
• showVersionDialog(): Override this to implement your own dialog logic. Crucial: In your confirmation button's click listener, you must call super.dealAPK(); to trigger the download/install process.
• showLoadingDialog(int currentProgress): Override to customize the progress/loading UI.
• showFailDialog(): Override to customize the error/failure UI.

// Inside your CustomVersionDialogActivity
versionDialog = new BaseDialog(this, R.style.BaseDialog, R.layout.custom_dialog_two_layout);
TextView tvTitle = (TextView) versionDialog.findViewById(R.id.tv_title);
TextView tvMsg = (TextView) versionDialog.findViewById(R.id.tv_msg);
Button btnUpdate = (Button) versionDialog.findViewById(R.id.btn_update);

versionDialog.show();
versionDialog.setOnDismissListener(this);

tvTitle.setText(getVersionTitle());
tvMsg.setText(getVersionUpdateMsg());

btnUpdate.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        versionDialog.dismiss();
        // MUST call super.dealAPK() to proceed with download
        CustomVersionDialogActivity.super.dealAPK();
    }
});

To customize the UI shown while the APK is downloading, implement CustomDownloadingDialogListener. This provides two methods:

• getCustomDownloadingDialog(Context context, int progress, UIData versionBundle): Returns the initial dialog.
• updateUI(Dialog dialog, int progress, UIData versionBundle): Called continuously to update progress bars or text.

Requirements:

• If your custom dialog includes a cancel action, the button ID must be @id/versionchecklib_loading_dialog_cancel.

builder.setCustomDownloadingDialogListener(new CustomDownloadingDialogListener() {
    @Override
    public Dialog getCustomDownloadingDialog(Context context, int progress, UIData versionBundle) {
        return new BaseDialog(context, R.style.BaseDialog, R.layout.custom_download_layout);
    }

    @Override
    public void updateUI(Dialog dialog, int progress, UIData versionBundle) {
        TextView tvProgress = dialog.findViewById(R.id.tv_progress);
        ProgressBar progressBar = dialog.findViewById(R.id.pb);
        progressBar.setProgress(progress);
        tvProgress.setText(getString(R.string.versionchecklib_progress, progress));
    }
});

To perform a full version check (requesting an API and showing a dialog), follow these steps:

1. Create a custom service: Extend AVersionService and implement onResponses(AVersionService service, String response). This method handles the API response. You must parse the data and decide whether to show the update dialog using service.showVersionDialog().

2. Start the check: Use AllenChecker.startVersionCheck with a VersionParams.Builder configured with your request URL and the custom service class.

Example implementation of the service logic:

if (serverVersion > clientVersion) { 
    // Pass download URL, title, and update message
    service.showVersionDialog(downloadUrl, title, updateMsg);
    // Or with a bundle for extra parameters
    // service.showVersionDialog(downloadUrl, title, updateMsg, bundle);
}

VersionParams.Builder builder = new VersionParams.Builder()
             .setRequestUrl("http://www.baidu.com")
             .setService(DemoService.class);
             
AllenChecker.startVersionCheck(this, builder.build());

To use a custom UI instead of the default dialogs, follow these steps:

1. Create an Activity that extends VersionDialogActivity.
2. Set the Activity's theme to transparent in your AndroidManifest.xml: android:theme="@style/versionCheckLibvtransparentTheme".
3. Pass your custom class to the service using setCustomDownloadActivityClass(CustomVersionDialogActivity.class) within your VersionParams configuration.

Customization Hooks:

• Version Dialog: Override showVersionDialog() and implement your own logic. Use downloadFile(url) or downloadFile(url, filecallback) to trigger downloads. Do not call the superclass method.
• Loading Dialog: Override showLoadingDialog(int currentProgress) to implement a custom progress UI.
• Failure Dialog: Override showFailDialog to implement custom error handling.
• Listeners: You can implement the following listeners within your custom Activity:
  • setOnDownloadSuccessListener(this)
  • setCommitClickListener(this)
  • setCancelClickListener(this)
  • setOnDownloadingListener(this)