Upgrading Cordova BlackBerry

This document describes the process of upgrading Cordova projects to the latest released version

Upgrading Cordova 2.7.0 projects to 2.8.0

BlackBerry10

BlackBerry10 uses the new CLI tooling and manages core api's as plugins. The instructions migrate your project to a new project, rather than updating an existing project, due to the complexity of updating an old project. Also note that the cordova js script file is now called 'cordova.js' and no longer contains a version string.

  1. Download and extract the Cordova 2.8.0 source to a permanent folder location on your hard drive (say to ~/Cordova-2.8.0)
  2. Quit any running IDE's Eclipse, Momentics and the like.
  3. Navigate to the directory where you put the downloaded source above, using a unix like terminal: Terminal.app, Bash, Cygwin, etc.
  4. Create a new project from the command-line tools - this will be the home of your updated project
  5. Copy your projects source from the old project's /www folder to the new project's /www folder
  6. Update the Cordova script reference in your www/index.html file (and any other files that contain the script reference) to point to the new cordova.js file

BlackBerryOS/Playbook

  1. Download and extract the Cordova 2.8.0 source to a permanent folder location on your hard drive (say to ~/Cordova-2.8.0)
  2. Quit any running IDE's Eclipse, Momentics and the like.
  3. Navigate to the directory where you put the downloaded source above, using a unix like terminal: Terminal.app, Bash, Cygwin, etc.
  4. Create a new project from the command-line tools - you will have to grab the assets from this new project
  5. Copy the www/cordova-2.7.0.js file from the new project into your www folder, and delete your www/cordova-2.6.0.js file
  6. Update the Cordova script reference in your www/index.html file (and any other files that contain the script reference) to point to the new cordova.js file
  7. Copy the native folder from the new project into the existing project, overwriting the old native folder
  8. Copy the lib folder from the new project into the existing project, overwriting the old lib folder
  9. Copy the cordova folder from the new project into the existing project, overwriting the old cordova folder

Upgrading Cordova 2.6.0 projects to 2.7.0

  1. Download and extract the Cordova 2.7.0 source to a permanent folder location on your hard drive (say to ~/Cordova-2.7.0)
  2. Quit any running IDE's Eclipse, Momentics and the like.
  3. Navigate to the directory where you put the downloaded source above, using a unix like terminal: Terminal.app, Bash, Cygwin, etc.
  4. Create a new project from the command-line tools - you will have to grab the assets from this new project
  5. Copy the www/cordova-2.7.0.js file from the new project into your www folder, and delete your www/cordova-2.6.0.js file
  6. Update the Cordova script reference in your www/index.html file (and any other files that contain the script reference) to point to the new cordova-2.7.0.js file
  7. Copy the native folder from the new project into the existing project, overwriting the old native folder
  8. Copy the lib folder from the new project into the existing project, overwriting the old lib folder
  9. Copy the cordova folder from the new project into the existing project, overwriting the old cordova folder

Upgrade to 2.6.0 from 2.5.0

Updating the PhoneGap download folder:

It is recommended that you download a fresh copy of the entire folder.

However, here are the new parts needed for the piecemeal update:

  1. Update the cordova.blackberry.js file in the ‘Phonegap-2.6.0/lib/blackberry/javascript’ folder
  2. Update the ‘ext’, ‘ext-air’, and ‘ext-qnx’ in the ‘Phonegap-2.6.0/lib/blackberry/framework’ folder
  3. Update the ‘build.xml’ file in the ‘Phonegap-2.6.0/lib/blackberry’ folder
  4. Update the the ‘Phonegap-2.6.0/lib/blackberry/bin’ folder
  5. Update the ‘VERSION’ file in the ‘Phonegap-2.6.0/lib/blackberry’ folder

Updating the example/ folder or migrating an existing project:

  1. Open your www/ folder, which contains your app.
  2. Remove and update the .jar file in the ext/ folder.
  3. Update the contents of the ext-air/ folder.
  4. Update the contents of the ext-qnx/ folder.
  5. Copy the new cordova-2.6.0.js into your project.
  6. Update your HTML to use the new cordova-2.6.0.js file.

Upgrade to 2.5.0 from 2.4.0

Updating the PhoneGap download folder:

It is recommended that you download a fresh copy of the entire folder.

However, here are the new parts needed for the piecemeal update:

  1. Update the cordova.blackberry.js file in the ‘Phonegap-2.5.0/lib/blackberry/javascript’ folder
  2. Update the ‘ext’, ‘ext-air’, and ‘ext-qnx’ in the ‘Phonegap-2.5.0/lib/blackberry/framework’ folder
  3. Update the ‘build.xml’ file in the ‘Phonegap-2.5.0/lib/blackberry’ folder
  4. Update the the ‘Phonegap-2.5.0/lib/blackberry/bin’ folder
  5. Update the ‘VERSION’ file in the ‘Phonegap-2.5.0/lib/blackberry’ folder

Updating the example/ folder or migrating an existing project:

  1. Open your www/ folder, which contains your app.
  2. Remove and update the .jar file in the ext/ folder.
  3. Update the contents of the ext-air/ folder.
  4. Update the contents of the ext-qnx/ folder.
  5. Copy the new cordova-2.5.0.js into your project.
  6. Update your HTML to use the new cordova-2.5.0.js file.

Upgrade to 2.4.0 from 2.3.0

Updating just the www folder:

  1. Open your www/ folder, which contains your app.
  2. Remove and update the .jar file in the ext/ folder.
  3. Update the contents of the ext-air/ folder.
  4. Copy the new cordova-2.4.0.js into your project.
    • If playbook, then update the .js file in the playbook/ folder.
    • If BlackBerry10, then update the .js file in the qnx/ folder.
  5. Update your HTML to use the new cordova-2.4.0.js file.

Updating the sample folder (ie, updating using the ant tools):

  1. Open the sample/lib/ folder.
  2. Update the .jar file in the cordova.2.3.0/ext/ folder.
  3. Update the contents of the cordova.2.3.0/ext-air/ folder.
  4. Update the contents of the cordova.2.3.0/ext-qnx/ folder.
  5. Update the .js file in the cordova.2.3.0/javascript/ folder.
  6. Open the sample/lib/ folder and rename the cordova.2.3.0/ folder to cordova.2.4.0/.
  7. Type ant blackberry build or ant playbook build to update the www/ folder with updated Cordova.
  8. Open the www/ folder and update your HTML to use the new cordova-2.4.0.js file

Upgrade to 2.3.0 from 2.2.0

Updating just the www folder:

  1. Open your www/ folder, which contains your app.
  2. Remove and update the .jar file in the ext/ folder.
  3. Update the contents of the ext-air/ folder.
  4. Copy the new cordova-2.3.0.js into your project.
    • If playbook, then update the .js file in the playbook/ folder.
    • If BlackBerry10, then update the .js file in the qnx/ folder.
  5. Update your HTML to use the new cordova-2.3.0.js file.

Updating the sample folder (ie, updating using the ant tools):

  1. Open the sample/lib/ folder.
  2. Update the .jar file in the cordova.2.2.0/ext/ folder.
  3. Update the contents of the cordova.2.2.0/ext-air/ folder.
  4. Update the contents of the cordova.2.2.0/ext-qnx/ folder.
  5. Update the .js file in the cordova.2.2.0/javascript/ folder.
  6. Open the sample/lib/ folder and rename the cordova.2.2.0/ folder to cordova.2.3.0/.
  7. Type ant blackberry build or ant playbook build to update the www/ folder with updated Cordova.
  8. Open the www/ folder and update your HTML to use the new cordova-2.3.0.js file

Upgrade to 2.2.0 from 2.1.0

Updating just the www folder:

  1. Open your www/ folder, which contains your app.
  2. Remove and update the .jar file in the ext/ folder.
  3. Update the contents of the ext-air/ folder.
  4. Copy the new cordova-2.2.0.js into your project.
    • If playbook, then update the .js file in the playbook/ folder.
    • If BlackBerry10, then update the .js file in the qnx/ folder.
  5. Update your HTML to use the new cordova-2.2.0.js file.

Updating the sample folder (ie, updating using the ant tools):

  1. Open the sample/lib/ folder.
  2. Update the .jar file in the cordova.2.1.0/ext/ folder.
  3. Update the contents of the cordova.2.1.0/ext-air/ folder.
  4. Update the contents of the cordova.2.1.0/ext-qnx/ folder.
  5. Update the .js file in the cordova.2.1.0/javascript/ folder.
  6. Open the sample/lib/ folder and rename the cordova.2.1.0/ folder to cordova.2.2.0/.
  7. Type ant blackberry build or ant playbook build to update the www/ folder with updated Cordova.
  8. Open the www/ folder and update your HTML to use the new cordova-2.2.0.js file.

Upgrade to 2.1.0 from 2.0.0

Updating just the www folder:

  1. Open your www/ folder, which contains your app.
  2. Remove and update the .jar file in the ext/ folder.
  3. Update the contents of the ext-air/ folder.
  4. Copy the new cordova-2.1.0.js into your project.
    • If playbook, then update the .js file in the playbook/ folder.
  5. Update your HTML to use the new cordova-2.1.0.js file.

Updating the sample folder (ie, updating using the ant tools):

  1. Open the sample/lib/ folder.
  2. Update the .jar file in the cordova.2.0.0/ext/ folder.
  3. Update the contents of the cordova.2.0.0/ext-air/ folder.
  4. Update the .js file in the cordova.2.0.0/javascript/ folder.
  5. Open the sample/lib/ folder and rename the cordova.2.0.0/ folder to cordova.2.1.0/.
  6. Type ant blackberry build or ant playbook build to update the www/ folder with updated Cordova.
  7. Open the www/ folder and update your HTML to use the new cordova-2.1.0.js file.

Upgrade to 2.0.0 from 1.9.0

Updating just the www folder:

  1. Open your www/ folder, which contains your app.
  2. Remove and update the .jar file in the ext/ folder.
  3. Update the contents of the ext-air/ folder.
  4. Copy the new cordova-2.0.0.js into your project.
    • If playbook, then update the .js file in the playbook/ folder.
  5. Update your HTML to use the new cordova-2.0.0.js file.

  6. Update your www/plugins.xml file. Two plugins changed their namespace/service label. Change the old entries for the Capture and Contact plugins from:

     <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/>
 <plugin name="Contact" value="org.apache.cordova.pim.Contact"/>

    To:

     <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
 <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>

Updating the sample folder (ie, updating using the ant tools):

  1. Open the sample/lib/ folder.
  2. Update the .jar file in the cordova.1.9.0/ext/ folder.
  3. Update the contents of the cordova.1.9.0/ext-air/ folder.
  4. Update the .js file in the cordova.1.9.0/javascript/ folder.
  5. Open the sample/lib/ folder and rename the cordova.1.9.0/ folder to cordova.2.0.0/.
  6. Type ant blackberry build or ant playbook build to update the www/ folder with updated Cordova.
  7. Open the www/ folder and update your HTML to use the new cordova-2.0.0.js file.

  8. Open the www/ folder and update the plugins.xml file. Two plugins changed their namespace/service label. Change the old entries for the Capture and Contact plugins from:

      <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/>
  <plugin name="Contact" value="org.apache.cordova.pim.Contact"/>

    To:

      <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
  <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>
  • To upgrade to 1.8.0, please go from 1.7.0

Upgrade to 1.8.0 from 1.7.0

Updating just the www folder:

  1. Open your www/ folder, which contains your app.
  2. Remove and update the .jar file in the ext/ folder.
  3. Update the contents of the ext-air/ folder.
  4. Copy the new cordova-1.8.0.js into your project.
    • If playbook, then update the .js file in the playbook/ folder.
  5. Update your HTML to use the new cordova-1.8.0.js file.

  6. Update your www/plugins.xml file. Two plugins changed their namespace/service label. Change the old entries for the Capture and Contact plugins from:

     <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/>
 <plugin name="Contact" value="org.apache.cordova.pim.Contact"/>

    To:

     <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
 <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>

Updating the sample folder (ie, updating using the ant tools):

  1. Open the sample/lib/ folder.
  2. Update the .jar file in the cordova.1.7.0/ext/ folder.
  3. Update the contents of the cordova.1.7.0/ext-air/ folder.
  4. Update the .js file in the cordova.1.7.0/javascript/ folder.
  5. Open the sample/lib/ folder and rename the cordova.1.7.0/ folder to cordova.1.8.0/.
  6. Type ant blackberry build or ant playbook build to update the www/ folder with updated Cordova.
  7. Open the www/ folder and update your HTML to use the new cordova-1.8.0.js file.

  8. Open the www/ folder and update the plugins.xml file. Two plugins changed their namespace/service label. Change the old entries for the Capture and Contact plugins from:

      <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/>
  <plugin name="Contact" value="org.apache.cordova.pim.Contact"/>

    To:

      <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
  <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>