org.xwalk.core

Class XWalkUpdater

java.lang.Object

org.xwalk.core.XWalkUpdater

public class XWalkUpdater
extends java.lang.Object

XWalkUpdater is a follow-up solution for XWalkInitializer in case the initialization has failed. The users of XWalkActivity don't need to use this class.

XWalkUpdater helps to donwload the Crosswalk runtime and displays dialogs to interact with the user. By default, it will navigate to the Crosswalk runtime's page on the default application store, subsequent process will be up to the user. If the developer specified the download URL of the Crosswalk runtime, it will launch the download manager to fetch the APK. To specify the download URL, insert a meta-data element with the name "xwalk_apk_url" inside the application tag in the Android manifest.

 <application android:name="org.xwalk.core.XWalkApplication">
     <meta-data android:name="xwalk_apk_url" android:value="http://host/XWalkRuntimeLib.apk" />
 

After the proper Crosswalk runtime is downloaded and installed, the user will return to current activity from the application store or the installer. The developer should check this point and invoke XWalkInitializer.initAsync() again to repeat the initialization process. Please note that from now on, the application will be running in shared mode.

For example:

 public class MyActivity extends Activity
         implements XWalkInitializer.XWalkInitListener, XWalkUpdater.XWalkUpdateListener {
     XWalkUpdater mXWalkUpdater;

     ......

     @Override
     protected void onResume() {
         super.onResume();

         // Try to initialize again when the user completed updating and returned to current
         // activity. The initAsync() will do nothing if the initialization has already been
         // completed successfully.
         mXWalkInitializer.initAsync();
     }

     @Override
     public void onXWalkInitFailed() {
         if (mXWalkUpdater == null) mXWalkUpdater = new mXWalkUpdater(this, this);

         // The updater won't be launched if previous update dialog is showing.
         mXWalkUpdater.updateXWalkRuntime();
     }

     @Override
     public void onXWalkUpdateCancelled() {
         // Perform error handling here
     }
 }
 

To download the Crosswalk runtime, you need to grant following permissions in the Android manifest:

 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
 <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
 <uses-permission android:name="android.permission.INTERNET" />
 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XWalkUpdater.XWalkUpdateListener Interface used to update the Crosswalk runtime

Constructor Summary

Constructors

Constructor and Description
XWalkUpdater(XWalkUpdater.XWalkUpdateListener listener, android.app.Activity activity) Create XWalkUpdater for single activity

Method Summary

Methods

Modifier and Type	Method and Description
boolean	dismissDialog() Dismiss the dialog showing and waiting for user's input.
void	setXWalkApkUrl(java.lang.String url) Set the download URL of the Crosswalk runtime.
boolean	updateXWalkRuntime() Update the Crosswalk runtime.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XWalkUpdater

public XWalkUpdater(XWalkUpdater.XWalkUpdateListener listener,
            android.app.Activity activity)

Create XWalkUpdater for single activity

Parameters:

listener - The XWalkUpdater.XWalkUpdateListener to use

activity - The activity which initiate the update

Method Detail

updateXWalkRuntime

public boolean updateXWalkRuntime()

Update the Crosswalk runtime. There are 2 ways to download the Crosswalk runtime: from the play store or the specified URL. It will download from the play store if the download URL is not specified. To specify the download URL, insert a meta-data element with the name "xwalk_apk_url" inside the application tag in the Android manifest.

Please try to initialize by XWalkInitializer first and only invoke this method when the initialization failed. This method must be invoked on the UI thread.

Returns:

True if the updater is launched, false if is in updating, or the Crosswalk runtime doesn't need to be updated, or the Crosswalk runtime has not been initialized yet.

dismissDialog

public boolean dismissDialog()

Dismiss the dialog showing and waiting for user's input.

Returns:

Return false if no dialog is being displayed, true if dismissed the showing dialog.

setXWalkApkUrl

public void setXWalkApkUrl(java.lang.String url)

Set the download URL of the Crosswalk runtime. By default, the updater will get the URL from the Android manifest.

Parameters:

url - The download URL.