Upgrading Android
This guide shows how to modify Android projects to upgrade from older versions of Cordova.
Most of these instructions apply to projects created with an older set
of command-line tools that precede the cordova
CLI utility. See The Command-Line Interface for information how to update the
version of the CLI.
Upgrading to 3.3.0 from 3.2.0
Follow the same instructions as for 3.2.0
.
Starting with 3.3.0, the Cordova runtime is now compiled as an Android Library
instead of a Jar. This should have no effect for command-line usage, but IDE
users will need to import the newly added MyProject-CordovaLib
project into
their workspace.
Upgrading to 3.2.0 from 3.1.0
For projects that were created with the cordova CLI:
-
Update the
cordova
CLI version. See The Command-Line Interface. -
Run
cordova platform update android
For projects not created with the cordova CLI, run:
bin/update <project_path>
WARNING: On Android 4.4 - Android 4.4.3, creating a file input element with type="file" will not open the file picker dialog. This is a regression with Chromium on Android and the problem can be reproduced in the standalone Chrome browser on Android (see http://code.google.com/p/android/issues/detail?id=62220) The suggested workaround is to use the FileTransfer and File plugins for Android 4.4. You can listen for an onClick event from the input type="file" and then pop up a file picker UI. In order to tie the form data with the upload, you can use JavaScript to attach form values to the multi-part POST request that FileTransfer makes.
Upgrading to 3.1.0 from 3.0.0
For projects that were created with the cordova CLI:
-
Update the
cordova
CLI version. See The Command-Line Interface. -
Run
cordova platform update android
For projects not created with the cordova CLI, run:
bin/update <project_path>
Upgrade to the CLI (3.0.0) from 2.9.0
-
Create a new Apache Cordova 3.0.0 project using the cordova CLI, as described in The Command-Line Interface.
-
Add your platforms the cordova project, for example:
cordova platform add android
. -
Copy the contents of your project's
www
directory to thewww
directory at the root of the cordova project you just created. -
Copy any native assets from your old project into the appropriate directories under
platforms/android
: this directory is where your native cordova-android project exists. -
Use the cordova CLI tool to install any plugins you need. Note that the CLI handles all core APIs as plugins, so they may need to be added. Only 3.0.0 plugins are compatible with the CLI.
Upgrade to 3.0.0 from 2.9.0
-
Create a new Apache Cordova Android project.
-
Copy the contents of the
www
directory to the new project. -
Copy any native Android assets from the
res
directory to the new project. -
Copy over any plugins you installed from the
src
subdirectories into the new project. -
Make sure to upgrade any deprecated
<plugin>
references from your oldconfig.xml
file to the new<feature>
specification. -
Update any references to the
org.apache.cordova.api
package to beorg.apache.cordova
.NOTE: all core APIs have been removed and must be installed as plugins. Please see the Using Plugman to Manage Plugins Guide for details.
Upgrade to 2.9.0 from 2.8.0
- Run
bin/update <project_path>
.
Upgrade to 2.8.0 from 2.7.0
-
Remove
cordova-2.7.0.jar
from the project'slibs
directory. -
Add
cordova-2.8.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova.js
into your project. -
Update your HTML to use the new
cordova.js
file. -
Copy the
res/xml/config.xml
file to matchframework/res/xml/config.xml
. -
Update
framework/res/xml/config.xml
to have similar settings as it did previously. -
Copy files from
bin/templates/cordova
to the project'scordova
directory.
Upgrade to 2.7.0 from 2.6.0
-
Remove
cordova-2.6.0.jar
from the project'slibs
directory. -
Add
cordova-2.7.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-2.7.0.js
into your project. -
Update your HTML to use the new
cordova-2.7.0.js
file. -
Copy the
res/xml/config.xml
to matchframework/res/xml/config.xml
. -
Update
framework/res/xml/config.xml
to have similar settings as it did previously. -
Copy files from
bin/templates/cordova
to the project'scordova
directory.
Upgrade to 2.6.0 from 2.5.0
-
Remove
cordova-2.5.0.jar
from the project'slibs
directory. -
Add
cordova-2.6.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-2.6.0.js
into your project. -
Update your HTML to use the new
cordova-2.6.0.js
file. -
Copy the
res/xml/config.xml
to matchframework/res/xml/config.xml
. -
Update
framework/res/xml/config.xml
to have similar settings as it did previously. -
Copy files from
bin/templates/cordova
to the project'scordova
directory.
Run bin/update <project>
with the project path listed in the Cordova Source directory.
Upgrade to 2.5.0 from 2.4.0
-
Remove
cordova-2.4.0.jar
from the project'slibs
directory. -
Add
cordova-2.5.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-2.5.0.js
into your project. -
Update your HTML to use the new
cordova-2.5.0.js
file. -
Copy the
res/xml/config.xml
to matchframework/res/xml/config.xml
. -
Update
framework/res/xml/config.xml
to have similar settings as it did previously. -
Copy files from
bin/templates/cordova
to the project'scordova
directory.
Upgrade to 2.4.0 from 2.3.0
-
Remove
cordova-2.3.0.jar
from the project'slibs
directory. -
Add
cordova-2.4.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-2.4.0.js
into your project. -
Update your HTML to use the new
cordova-2.4.0.js
file. -
Copy the
res/xml/config.xml
to matchframework/res/xml/config.xml
. -
Copy files from
bin/templates/cordova
to the project'scordova
directory.
Upgrade to 2.3.0 from 2.2.0
-
Remove
cordova-2.2.0.jar
from the project'slibs
directory. -
Add
cordova-2.3.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-2.3.0.js
into your project. -
Update your HTML to use the new
cordova-2.3.0.js
file. -
Copy the
res/xml/config.xml
to matchframework/res/xml/config.xml
. -
Copy files from
bin/templates/cordova
to the project'scordova
directory.
Upgrade to 2.2.0 from 2.1.0
-
Remove
cordova-2.1.0.jar
from the project'slibs
directory. -
Add
cordova-2.2.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-2.2.0.js
into your project. -
Update your HTML to use the new
cordova-2.2.0.js
file. -
Copy the
res/xml/config.xml
to matchframework/res/xml/config.xml
. -
Copy files from
bin/templates/cordova
to the project'scordova
directory.
Upgrade to 2.1.0 from 2.0.0
-
Remove
cordova-2.0.0.jar
from the project'slibs
directory. -
Add
cordova-2.1.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-2.1.0.js
into your project. -
Update your HTML to use the new
cordova-2.1.0.js
file. -
Copy the
res/xml/config.xml
to matchframework/res/xml/config.xml
. -
Copy files from
bin/templates/cordova
to the project'scordova
directory.
Upgrade to 2.0.0 from 1.9.0
-
Remove
cordova-1.9.0.jar
from the project'slibs
directory. -
Add
cordova-2.0.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-2.0.0.js
into your project. -
Update your HTML to use the new
cordova-2.0.0.js
file. -
Copy the
res/xml/config.xml
to matchframework/res/xml/config.xml
.
In the 2.0.0 release, the config.xml
file combines and replaces
cordova.xml
and plugins.xml
. The old files are deprecated, and
while they still work in 2.0.0, will stop working in a future release.
Upgrade to 1.9.0 from 1.8.1
-
Remove
cordova-1.8.0.jar
from the project'slibs
directory. -
Add
cordova-1.9.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-1.9.0.js
into your project. -
Update your HTML to use the new
cordova-1.9.0.js
file. -
Update
res/xml/plugins.xml
to matchframework/res/xml/plugins.xml
.
Due to the introduction of the CordovaWebView
in the 1.9.0 release,
third-party plugins may not work. These plugins need to get a context
from the CordovaInterface
using getContext()
or getActivity()
.
If you are not an experienced Android developer, please contact the
plugin maintainer and add this task to their bug tracker.
Upgrade to 1.8.0 from 1.8.0
-
Remove
cordova-1.8.0.jar
from the project'slibs
directory. -
Add
cordova-1.8.1.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-1.8.1.js
into your project. -
Update your HTML to use the new
cordova-1.8.1.js
file. -
Update
res/xml/plugins.xml
to matchframework/res/xml/plugins.xml
.
Upgrade to 1.8.0 from 1.7.0
-
Remove
cordova-1.7.0.jar
from the project'slibs
directory. -
Add
cordova-1.8.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-1.8.0.js
into your project. -
Update your HTML to use the new
cordova-1.8.0.js
file. -
Update
res/xml/plugins.xml
to matchframework/res/xml/plugins.xml
.
Upgrade to 1.8.0 from 1.7.0
-
Remove
cordova-1.7.0.jar
from the project'slibs
directory. -
Add
cordova-1.8.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-1.8.0.js
into your project. -
Update your HTML to use the new
cordova-1.8.0.js
file. -
Update
res/xml/plugins.xml
to matchframework/res/xml/plugins.xml
.
Upgrade to 1.7.0 from 1.6.1
-
Remove
cordova-1.6.1.jar
from the project'slibs
directory. -
Add
cordova-1.7.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-1.7.0.js
into your project. -
Update
res/xml/plugins.xml
to matchframework/res/xml/plugins.xml
.
Upgrade to 1.6.1 from 1.6.0
-
Remove
cordova-1.6.0.jar
from the project'slibs
directory. -
Add
cordova-1.6.1.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-1.6.1.js
into your project. -
Update
res/xml/plugins.xml
to matchframework/res/xml/plugins.xml
.
Upgrade to 1.6.0 from 1.5.0
-
Remove
cordova-1.5.0.jar
from the project'slibs
directory. -
Add
cordova-1.6.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-1.6.0.js
into your project. -
Update your HTML to use the new
cordova-1.6.0.js
file. -
Update
res/xml/plugins.xml
to matchframework/res/xml/plugins.xml
. -
Replace
res/xml/phonegap.xml
withres/xml/cordova.xml
to matchframework/res/xml/cordova.xml
.
Upgrade to 1.5.0 from 1.4.0
-
Remove
phonegap-1.4.0.jar
from the project'slibs
directory. -
Add
cordova-1.5.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
cordova-1.5.0.js
into your project. -
Update your HTML to use the new
cordova-1.5.0.js
file. -
Update
res/xml/plugins.xml
to matchframework/res/xml/plugins.xml
. -
Replace
res/xml/phonegap.xml
withres/xml/cordova.xml
to matchframework/res/xml/cordova.xml
.
Upgrade to 1.4.0 from 1.3.0
-
Remove
phonegap-1.3.0.jar
from the project'slibs
directory. -
Add
phonegap-1.4.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
phonegap-1.4.0.js
into your project. -
Update your HTML to use the new
phonegap-1.4.0.js
file. -
Update
res/xml/plugins.xml
to matchframework/res/xml/plugins.xml
. -
Update
res/xml/phonegap.xml
to matchframework/res/xml/phonegap.xml
.
Upgrade to 1.3.0 from 1.2.0
-
Remove
phonegap-1.2.0.jar
from the project'slibs
directory. -
Add
phonegap-1.3.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
phonegap-1.3.0.js
into your project. -
Update your HTML to use the new
phonegap-1.2.0.js
file. -
Update
res/xml/plugins.xml
to matchframework/res/xml/plugins.xml
. -
Update
res/xml/phonegap.xml
to matchframework/res/xml/phonegap.xml
.
Upgrade to 1.2.0 from 1.1.0
-
Remove
phonegap-1.1.0.jar
from the project'slibs
directory. -
Add
phonegap-1.2.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
phonegap-1.2.0.js
into your project. -
Update your HTML to use the new
phonegap-1.2.0.js
file. -
Update
res/xml/plugins.xml
to matchframework/res/xml/plugins.xml
. -
Update
res/xml/phonegap.xml
to matchframework/res/xml/phonegap.xml
.
Upgrade to 1.1.0 from 1.0.0
-
Remove
phonegap-1.0.0.jar
from the project'slibs
directory. -
Add
phonegap-1.1.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
phonegap-1.1.0.js
into your project. -
Update your HTML to use the new
phonegap-1.1.0.js
file. -
Update
res/xml/plugins.xml
to matchframework/res/xml/plugins.xml
.
Upgrade to 1.0.0 from 0.9.6
-
Remove
phonegap-0.9.6.jar
from the project'slibs
directory. -
Add
phonegap-1.0.0.jar
to the project'slibs
directory. -
If you use Eclipse, please refresh your Eclipse project and do a clean.
-
Copy the new
phonegap-1.0.0.js
into your project. -
Update your HTML to use the new
phonegap-1.0.0.js
file. -
Add the
res/xml/plugins.xml
to matchframework/res/xml/plugins.xml
.