You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/01/23 02:32:44 UTC
[9/11] Version 2.4.0rc1
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/contacts/parameters/contactSuccess.md b/docs/en/2.4.0rc1/cordova/contacts/parameters/contactSuccess.md
new file mode 100644
index 0000000..9068218
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/contacts/parameters/contactSuccess.md
@@ -0,0 +1,40 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+contactSuccess
+==============
+
+Success callback function that provides the `Contact` array resulting from a `contacts.find` operation.
+
+ function(contacts) {
+ // Do something
+ }
+
+Parameters
+----------
+
+- __contacts:__ The contact array resulting from a find operation. (`Contact`)
+
+Example
+-------
+
+ function contactSuccess(contacts) {
+ for (var i=0; i<contacts.length; i++) {
+ console.log("Display Name = " + contacts[i].displayName;
+ }
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/device/device.cordova.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/device/device.cordova.md b/docs/en/2.4.0rc1/cordova/device/device.cordova.md
new file mode 100644
index 0000000..5f8cfb9
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/device/device.cordova.md
@@ -0,0 +1,81 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+device.cordova
+===============
+
+Get the version of Cordova running on the device.
+
+ var string = device.cordova;
+
+Description
+-----------
+
+`device.cordova` returns the version of Cordova running on the device.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 7 and 8
+- Bada 1.2 & 2.x
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ var name = device.cordova;
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var element = document.getElementById('deviceProperties');
+
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="deviceProperties">Loading device properties...</p>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/device/device.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/device/device.md b/docs/en/2.4.0rc1/cordova/device/device.md
new file mode 100644
index 0000000..294cb42
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/device/device.md
@@ -0,0 +1,104 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Device
+======
+
+> The `device` object describes the device's hardware and software.
+
+Properties
+----------
+
+- device.name
+- device.cordova
+- device.platform
+- device.uuid
+- device.version
+- device.model
+
+Variable Scope
+--------------
+
+Since `device` is assigned to the `window` object, it is implicitly in the global scope.
+
+ // These reference the same `device`
+ var phoneName = window.device.name;
+ var phoneName = device.name;
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Device" value="org.apache.cordova.Device" />
+
+#### app/AndroidManifest.xml
+
+ <uses-permission android:name="android.permission.READ_PHONE_STATE" />
+
+### Bada
+
+#### manifest.xml
+
+ <Privilege>
+ <Name>SYSTEM_SERVICE</Name>
+ </Privilege>
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Device" value="org.apache.cordova.device.Device" />
+
+#### www/config.xml
+
+ <feature id="blackberry.app" required="true" version="1.0.0.0" />
+ <rim:permissions>
+ <rim:permit>read_device_identifying_information</rim:permit>
+ </rim:permissions>
+
+### iOS
+
+ No permissions are required.
+
+### webOS
+
+ No permissions are required.
+
+### Windows Phone
+
+#### Properties/WPAppManifest.xml
+
+ <Capabilities>
+ <Capability Name="ID_CAP_WEBBROWSERCOMPONENT" />
+ <Capability Name="ID_CAP_IDENTITY_DEVICE" />
+ <Capability Name="ID_CAP_IDENTITY_USER" />
+ </Capabilities>
+
+Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
+
+### Tizen
+
+#### config.xml
+
+ <feature name="http://tizen.org/api/systeminfo" required="true"/>
+
+Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/device/device.model.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/device/device.model.md b/docs/en/2.4.0rc1/cordova/device/device.model.md
new file mode 100644
index 0000000..0caba9b
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/device/device.model.md
@@ -0,0 +1,108 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+device.model
+===========
+
+Get the device's model name.
+
+ var string = device.model;
+
+Description
+-----------
+
+`device.model` returns the name of the device's model or product. This value is set by the device manufacturer and may be different across versions of the same product.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Bada 1.2 & 2.x
+- webOS
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // Android: Nexus One returns "Passion" (Nexus One code name)
+ // Motorola Droid returns "voles"
+ // BlackBerry: Torch 9800 returns "9800"
+ // iOS: for the iPad Mini, will return iPad2,5. iPhone 5 is iPhone 5,1. See http://theiphonewiki.com/wiki/index.php?title=Models
+ //
+ var model = device.model;
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var element = document.getElementById('deviceProperties');
+
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Model: ' + device.model + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="deviceProperties">Loading device properties...</p>
+ </body>
+ </html>
+
+
+Android Quirks
+--------------
+
+- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL).
+ - The product name is often the code name given during production.
+ - e.g. Nexus One returns "Passion", Motorola Droid returns "voles"
+
+Windows Phone 7 and 8 Quirks
+-------------
+
+- returns the manufacturer specified device model, for example, the Samsung Focus returns 'SGH-i917'
+
+Bada Quirks
+-----------
+- returns the manufacturer model name. For example 'Samsung Wave S8500'
+
+Tizen Quirks
+-----------
+- returns the device model assigned by the vendor. For example 'TIZEN'
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/device/device.name.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/device/device.name.md b/docs/en/2.4.0rc1/cordova/device/device.name.md
new file mode 100644
index 0000000..e970728
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/device/device.name.md
@@ -0,0 +1,109 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+device.name
+===========
+WARNING: device.name is deprecated as of version 2.3.0, use device.model instead
+
+Get the device's model name.
+
+ var string = device.name;
+
+Description
+-----------
+
+`device.name` returns the name of the device's model or product. This value is set by the device manufacturer and may be different across versions of the same product.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Bada 1.2 & 2.x
+- webOS
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // Android: Nexus One returns "Passion" (Nexus One code name)
+ // Motorola Droid returns "voles"
+ // BlackBerry: Torch 9800 returns "9800"
+ // iOS: All devices returns either "iPhone", "iPod Touch", "iPhone Simulator", "iPad", "iPad Simulator"
+ //
+ var name = device.name;
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var element = document.getElementById('deviceProperties');
+
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Model: ' + device.model + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="deviceProperties">Loading device properties...</p>
+ </body>
+ </html>
+
+
+Android Quirks
+--------------
+
+- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL).
+ - The product name is often the code name given during production.
+ - e.g. Nexus One returns "Passion", Motorola Droid returns "voles"
+
+Windows Phone 7 and 8 Quirks
+-------------
+
+- returns the manufacturer specified device name, for example, the Samsung Focus returns 'SGH-i917'
+
+Bada Quirks
+-----------
+- returns the manufacturer model name. For example 'Samsung Wave S8500'
+
+Tizen Quirks
+-----------
+- returns the device model assigned by the vendor. For example 'TIZEN'
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/device/device.platform.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/device/device.platform.md b/docs/en/2.4.0rc1/cordova/device/device.platform.md
new file mode 100644
index 0000000..e76e352
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/device/device.platform.md
@@ -0,0 +1,99 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+device.platform
+===============
+
+Get the device's operating system name.
+
+ var string = device.platform;
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Bada 1.2 & 2.x
+- webOS
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // Depending on the device, a few examples are:
+ // - "Android"
+ // - "BlackBerry"
+ // - "iOS"
+ // - "webOS"
+ // - "WinCE"
+ // - "Tizen"
+ var devicePlatform = device.platform;
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var element = document.getElementById('deviceProperties');
+
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="deviceProperties">Loading device properties...</p>
+ </body>
+ </html>
+
+BlackBerry Quirks
+-----------------
+
+Devices may return the device platform version instead of the platform name. For example, the Storm2 9550 would return '2.13.0.95' or similar.
+
+Windows Phone 7 Quirks
+-----------------
+
+Windows Phone 7 devices report platform as 'WinCE'
+
+
+Windows Phone 8 Quirks
+-----------------
+
+Windows Phone 8 devices report platform as 'Win32NT'
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/device/device.uuid.md b/docs/en/2.4.0rc1/cordova/device/device.uuid.md
new file mode 100644
index 0000000..7bb8884
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/device/device.uuid.md
@@ -0,0 +1,108 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+device.uuid
+===========
+
+Get the device's Universally Unique Identifier ([UUID](http://en.wikipedia.org/wiki/Universally_Unique_Identifier)).
+
+ var string = device.uuid;
+
+Description
+-----------
+
+The details of how a UUID is generated are determined by the device manufacturer and specific to the device's platform or model.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 7 and 8
+- Bada 1.2 & 2.x
+- webOS
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // Android: Returns a random 64-bit integer (as a string, again!)
+ // The integer is generated on the device's first boot
+ //
+ // BlackBerry: Returns the PIN number of the device
+ // This is a nine-digit unique integer (as a string, though!)
+ //
+ // iPhone: (Paraphrased from the UIDevice Class documentation)
+ // Returns a string of hash values created from multiple hardware identifies.
+ // It is guaranteed to be unique for every device and cannot be tied
+ // to the user account.
+ // Windows Phone 7 : Returns a hash of device+current user,
+ // if the user is not defined, a guid is generated and will persist until the app is uninstalled
+ //
+ // webOS: returns the device NDUID
+ //
+ // Tizen: returns the device IMEI (International Mobile Equipment Identity or IMEI is a number
+ // unique to every GSM and UMTS mobile phone.
+ var deviceID = device.uuid;
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var element = document.getElementById('deviceProperties');
+
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="deviceProperties">Loading device properties...</p>
+ </body>
+ </html>
+
+iOS Quirk
+-------------
+
+The uuid for iOS is not unique for a device, but is unique per application per install. This will change if you delete the app and re-install, and possibly also when you upgrade your iOS version, or even upgrade your app per version (as we've seen in iOS 5.1). Not a reliable value.
+
+Windows Phone 7 and 8 Quirks
+-------------
+
+The uuid for Windows Phone 7 requires the permission ID_CAP_IDENTITY_DEVICE. Microsoft will likely be deprecating this property in the near future. If the capability is not available, the application generates a persistent guid, that will be maintained for the install-lifetime of the application on the device.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/device/device.version.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/device/device.version.md b/docs/en/2.4.0rc1/cordova/device/device.version.md
new file mode 100644
index 0000000..eb181b7
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/device/device.version.md
@@ -0,0 +1,87 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+device.version
+==============
+
+Get the operating system version.
+
+ var string = device.version;
+
+Supported Platforms
+-------------------
+
+- Android 2.1+
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 7 and 8
+- Bada 1.2 & 2.x
+- webOS
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // Android: Froyo OS would return "2.2"
+ // Eclair OS would return "2.1", "2.0.1", or "2.0"
+ // Version can also return update level "2.1-update1"
+ //
+ // BlackBerry: Torch 9800 using OS 6.0 would return "6.0.0.600"
+ //
+ // iPhone: iOS 3.2 returns "3.2"
+ //
+ // Windows Phone 7: returns current OS version number, ex. on Mango returns 7.10.7720
+ // webOS: webOS 2.2.4 return 2.2.4
+ // Tizen: returns "TIZEN_20120425_2"
+ var deviceVersion = device.version;
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var element = document.getElementById('deviceProperties');
+
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="deviceProperties">Loading device properties...</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.backbutton.md b/docs/en/2.4.0rc1/cordova/events/events.backbutton.md
new file mode 100644
index 0000000..75eaeeb
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.backbutton.md
@@ -0,0 +1,87 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+backbutton
+===========
+
+This is an event that fires when the user presses the back button.
+
+ document.addEventListener("backbutton", yourCallbackFunction, false);
+
+Details
+-------
+
+If you need to override the default back button behaviour you can register an event listener for the 'backbutton' event. It is no longer necessary to call any other method to over ride the back button behaviour. Now, you only need to register an event listener for 'backbutton'.
+
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- Windows Phone 7 and 8
+
+Quick Example
+-------------
+
+ document.addEventListener("backbutton", onBackKeyDown, false);
+
+ function onBackKeyDown() {
+ // Handle the back button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Cordova Back Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to call Cordova methods
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("backbutton", onBackKeyDown, false);
+ }
+
+ // Handle the back button
+ //
+ function onBackKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.batterycritical.md b/docs/en/2.4.0rc1/cordova/events/events.batterycritical.md
new file mode 100644
index 0000000..6212707
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.batterycritical.md
@@ -0,0 +1,94 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+batterycritical
+===========
+
+This is an event that fires when a Cordova application detects the battery has reached the critical level threshold.
+
+ window.addEventListener("batterycritical", yourCallbackFunction, false);
+
+Details
+-------
+
+This event that fires when a Cordova application detects the percentage of battery has reached the critical battery threshold. This value is device specific.
+
+The batterycritical handler will be called with an object that contains two properties:
+
+- __level:__ The percentage of battery (0-100). _(Number)_
+- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
+
+Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- iOS
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- Tizen
+
+Quick Example
+-------------
+
+ window.addEventListener("batterycritical", onBatteryCritical, false);
+
+ function onBatteryCritical(info) {
+ // Handle the battery critical event
+ alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Cordova Battery Critical Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ window.addEventListener("batterycritical", onBatteryCritical, false);
+ }
+
+ // Handle the batterycritical event
+ //
+ function onBatteryCritical(info) {
+ alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.batterylow.md b/docs/en/2.4.0rc1/cordova/events/events.batterylow.md
new file mode 100644
index 0000000..d082e89
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.batterylow.md
@@ -0,0 +1,94 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+batterylow
+===========
+
+This is an event that fires when a Cordova application detects the battery has reached the low level threshold.
+
+ window.addEventListener("batterylow", yourCallbackFunction, false);
+
+Details
+-------
+
+This event that fires when a Cordova application detects the percentage of battery has reached the low battery threshold. This value is device specific.
+
+The batterylow handler will be called with an object that contains two properties:
+
+- __level:__ The percentage of battery (0-100). _(Number)_
+- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
+
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- iOS
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- Tizen
+
+Quick Example
+-------------
+
+ window.addEventListener("batterylow", onBatteryLow, false);
+
+ function onBatteryLow(info) {
+ // Handle the battery low event
+ alert("Battery Level Low " + info.level + "%");
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Cordova Device Ready Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ window.addEventListener("batterylow", onBatteryLow, false);
+ }
+
+ // Handle the batterylow event
+ //
+ function onBatteryLow(info) {
+ alert("Battery Level Low " + info.level + "%");
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.batterystatus.md b/docs/en/2.4.0rc1/cordova/events/events.batterystatus.md
new file mode 100644
index 0000000..dda998a
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.batterystatus.md
@@ -0,0 +1,102 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+batterystatus
+===========
+
+This is an event that fires when a Cordova application detects a change in the battery status.
+
+ window.addEventListener("batterystatus", yourCallbackFunction, false);
+
+Details
+-------
+
+This event that fires when a Cordova application detects the percentage of battery has changed by at least 1 percent. It is also fired if the device has been plugged in or un-plugged.
+
+The battery status handler will be called with an object that contains two properties:
+
+- __level:__ The percentage of battery (0-100). _(Number)_
+- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
+
+Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- iOS
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- Windows Phone 7 and 8
+- Tizen
+
+Windows Phone 7 and 8 Quirks
+----------------------
+
+The `level` property is unavailable as Windows Phone 7 does not provide
+native APIs for determining battery level. The `isPlugged` parameter
+_is_ supported.
+
+Quick Example
+-------------
+
+ window.addEventListener("batterystatus", onBatteryStatus, false);
+
+ function onBatteryStatus(info) {
+ // Handle the online event
+ console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Cordova Device Ready Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ window.addEventListener("batterystatus", onBatteryStatus, false);
+ }
+
+ // Handle the batterystatus event
+ //
+ function onBatteryStatus(info) {
+ console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.deviceready.md b/docs/en/2.4.0rc1/cordova/events/events.deviceready.md
new file mode 100644
index 0000000..c45aba6
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.deviceready.md
@@ -0,0 +1,91 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+deviceready
+===========
+
+This is an event that fires when Cordova is fully loaded.
+
+ document.addEventListener("deviceready", yourCallbackFunction, false);
+
+Details
+-------
+
+This is a very important event that every Cordova application should use.
+
+Cordova consists of two code bases: native and JavaScript. While the native code is loading, a custom loading image is displayed. However, JavaScript is only loaded once the DOM loads. This means your web application could, potentially, call a Cordova JavaScript function before it is loaded.
+
+The Cordova `deviceready` event fires once Cordova has fully loaded. After the device has fired, you can safely make calls to Cordova function.
+
+Typically, you will want to attach an event listener with `document.addEventListener` once the HTML document's DOM has loaded.
+
+This event behaves differently from others in that any event handler registered after the event has been fired will have its callback function called immediately.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Bada 1.2 & 2.x
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ function onDeviceReady() {
+ // Now safe to use the Cordova API
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Cordova Device Ready Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ // Now safe to use the Cordova API
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.endcallbutton.md b/docs/en/2.4.0rc1/cordova/events/events.endcallbutton.md
new file mode 100644
index 0000000..46d427a
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.endcallbutton.md
@@ -0,0 +1,86 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+endcallbutton
+===========
+
+This is an event that fires when the user presses the end call button.
+
+ document.addEventListener("endcallbutton", yourCallbackFunction, false);
+
+Details
+-------
+
+If you need to override the default end call behaviour you can register an event listener for the 'endcallbutton' event.
+
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- BlackBerry WebWorks (OS 5.0 and higher)
+
+Quick Example
+-------------
+
+ document.addEventListener("endcallbutton", onEndCallKeyDown, false);
+
+ function onEndCallKeyDown() {
+ // Handle the end call button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Cordova End Call Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("endcallbutton", onEndCallKeyDown, false);
+ }
+
+ // Handle the end call button
+ //
+ function onEndCallKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.md b/docs/en/2.4.0rc1/cordova/events/events.md
new file mode 100644
index 0000000..1581844
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.md
@@ -0,0 +1,97 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Events
+======
+
+> Cordova lifecycle events.
+
+Event Types
+-----------
+
+- deviceready
+- pause
+- resume
+- online
+- offline
+- backbutton
+- batterycritical
+- batterylow
+- batterystatus
+- menubutton
+- searchbutton
+- startcallbutton
+- endcallbutton
+- volumedownbutton
+- volumeupbutton
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Battery" value="org.apache.cordova.BatteryListener" />
+
+#### app/AndroidManifest.xml
+
+ <uses-permission android:name="android.permission.BROADCAST_STICKY" />
+
+### Bada
+
+#### manifest.xml
+
+ <Privilege>
+ <Name>SYSTEM_SERVICE</Name>
+ </Privilege>
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Battery" value="org.apache.cordova.battery.Battery" />
+
+#### www/config.xml
+
+ <feature id="blackberry.app" required="true" version="1.0.0.0" />
+ <feature id="blackberry.app.event" required="true" version="1.0.0.0" />
+ <feature id="blackberry.system.event" required="true" version="1.0.0.0" />
+
+### iOS
+
+#### config.xml
+
+ <plugin name="Battery" value="CDVBattery" />
+
+### webOS
+
+ No permissions are required.
+
+### Windows Phone
+
+ No permissions are required.
+
+### Tizen
+
+#### config.xml
+
+ <feature name="http://tizen.org/api/systeminfo" required="true"/>
+
+Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.menubutton.md b/docs/en/2.4.0rc1/cordova/events/events.menubutton.md
new file mode 100644
index 0000000..a66d742
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.menubutton.md
@@ -0,0 +1,87 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+menubutton
+===========
+
+This is an event that fires when the user presses the menu button.
+
+ document.addEventListener("menubutton", yourCallbackFunction, false);
+
+Details
+-------
+
+If you need to override the default menu button behaviour you can register an event listener for the 'menubutton' event.
+
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+
+Quick Example
+-------------
+
+ document.addEventListener("menubutton", onMenuKeyDown, false);
+
+ function onMenuKeyDown() {
+ // Handle the back button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Cordova Menu Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("menubutton", onMenuKeyDown, false);
+ }
+
+ // Handle the menu button
+ //
+ function onMenuKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.offline.md b/docs/en/2.4.0rc1/cordova/events/events.offline.md
new file mode 100644
index 0000000..8b07aaf
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.offline.md
@@ -0,0 +1,101 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+offline
+===========
+
+This is an event that fires when a Cordova application is offline (not connected to the Internet).
+
+ document.addEventListener("offline", yourCallbackFunction, false);
+
+Details
+-------
+
+When the application's network connection changes to being offline, the offline event is fired.
+
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ document.addEventListener("offline", onOffline, false);
+
+ function onOffline() {
+ // Handle the offline event
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Cordova Offline Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ document.addEventListener("offline", onOffline, false);
+ }
+
+ // Handle the offline event
+ //
+ function onOffline() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
+
+iOS Quirks
+--------------------------
+During initial startup, the first offline event (if applicable) will take at least a second to fire.
+
+Windows Phone 7 Quirks
+--------------------------
+When running in the Emulator, the connection.status of the device is always unknown, and this event will NOT fire.
+
+Windows Phone 8 Quirks
+--------------------------
+Emulator reports connection type as Cellular, and it will not change, so events will NOT fire.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.online.md b/docs/en/2.4.0rc1/cordova/events/events.online.md
new file mode 100644
index 0000000..7f720ad
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.online.md
@@ -0,0 +1,101 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+online
+===========
+
+This is an event that fires when a Cordova application is online (connected to the Internet).
+
+ document.addEventListener("online", yourCallbackFunction, false);
+
+Details
+-------
+
+When the application's network connection changes to being online, the online event is fired.
+
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ document.addEventListener("online", onOnline, false);
+
+ function onOnline() {
+ // Handle the online event
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Cordova Online Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ document.addEventListener("online", onOnline, false);
+ }
+
+ // Handle the online event
+ //
+ function onOnline() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
+
+iOS Quirks
+--------------------------
+During initial startup, the first online event (if applicable) will take at least a second to fire.
+
+Windows Phone 7 Quirks
+--------------------------
+When running in the Emulator, the connection.status of the device is always unknown, and this event will NOT fire.
+
+Windows Phone 8 Quirks
+--------------------------
+Emulator reports connection type as Cellular, and it will not change, so events will NOT fire.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.pause.md b/docs/en/2.4.0rc1/cordova/events/events.pause.md
new file mode 100644
index 0000000..c6b9b61
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.pause.md
@@ -0,0 +1,98 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+pause
+===========
+
+This is an event that fires when a Cordova application is put into the background.
+
+ document.addEventListener("pause", yourCallbackFunction, false);
+
+Details
+-------
+
+Cordova consists of two code bases: native and JavaScript. While the native code puts the application into the background the pause event is fired.
+
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ document.addEventListener("pause", onPause, false);
+
+ function onPause() {
+ // Handle the pause event
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Cordova Pause Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ document.addEventListener("pause", onPause, false);
+ }
+
+ // Handle the pause event
+ //
+ function onPause() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
+
+iOS Quirks
+--------------------------
+In the pause handler, any calls that go through Objective-C will not work, nor will any calls that are interactive, like alerts. This means that you cannot call console.log (and its variants), or any calls from Plugins or the Cordova API. These will only be processed when the app resumes (processed on the next run-loop).
+
+- __resign__ event
+
+ This iOS specific event is available as a variant of the **pause** event, and is often used to detect when the "Lock" button has been pressed to lock the device when your app is the foreground app. If your app (and device) is enabled for multi-tasking, this will be paired with a subsequent **pause** event, but only under iOS 5 (effectively all "locked" apps in iOS 5 that have multi-tasking enabled are put to the background).
+
+ Under iOS 5, if you want your app to still run when the device is locked, you will have to disable multi-tasking (UIApplicationExitsOnSuspend - YES) for your app. This is different when you are on iOS 4 - to have your app run when the device is locked, the multi-tasking setting for your app does not matter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.resume.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.resume.md b/docs/en/2.4.0rc1/cordova/events/events.resume.md
new file mode 100644
index 0000000..ce6749f
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.resume.md
@@ -0,0 +1,109 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+resume
+===========
+
+This is an event that fires when a Cordova application is retrieved from the background.
+
+ document.addEventListener("resume", yourCallbackFunction, false);
+
+Details
+-------
+
+Cordova consists of two code bases: native and JavaScript. While the native code pulls the application from the background the resume event is fired.
+
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ document.addEventListener("resume", onResume, false);
+
+ function onResume() {
+ // Handle the resume event
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Cordova Resume Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ document.addEventListener("resume", onResume, false);
+ }
+
+ // Handle the resume event
+ //
+ function onResume() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
+
+iOS Quirks
+--------------------------
+Any calls to console.log during your **pause** event handler will be run now when the app resumes, see the iOS Quirks section for the **pause** event for an explanation.
+
+- __active__ event
+
+ This iOS specific event is available as a variant of the **resume** event, and is often used to detect when the "Lock" button has been pressed to unlock the device when your app is the foreground app. If your app (and device) is enabled for multi-tasking, this will be paired with a subsequent **resume** event, but only under iOS 5 (effectively all "locked" apps in iOS 5 that have multi-tasking enabled are put to the background).
+
+ Under iOS 5, if you want your app to still run when the device is locked, you will have to disable multi-tasking (UIApplicationExitsOnSuspend - YES) for your app. This is different when you are on iOS 4 - to have your app run when the device is locked, the multi-tasking setting for your app does not matter.
+
+- __resume__ event
+
+ Interactive functions like alert() when the resume event fires will need to be wrapped in a setTimeout call with a timeout value of zero, or else the app will hang. e.g.
+
+ document.addEventListener("resume", onResume, false);
+ function onResume() {
+ setTimeout(function() {
+ // TODO: do your thing!
+ }, 0);
+ }
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.searchbutton.md b/docs/en/2.4.0rc1/cordova/events/events.searchbutton.md
new file mode 100644
index 0000000..4c75f2b
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.searchbutton.md
@@ -0,0 +1,86 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+searchbutton
+===========
+
+This is an event that fires when the user presses the search button on Android.
+
+ document.addEventListener("searchbutton", yourCallbackFunction, false);
+
+Details
+-------
+
+If you need to override the default search button behaviour on Android you can register an event listener for the 'searchbutton' event.
+
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- Android
+
+Quick Example
+-------------
+
+ document.addEventListener("searchbutton", onSearchKeyDown, false);
+
+ function onSearchKeyDown() {
+ // Handle the search button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Cordova Search Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("searchbutton", onSearchKeyDown, false);
+ }
+
+ // Handle the search button
+ //
+ function onSearchKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.startcallbutton.md b/docs/en/2.4.0rc1/cordova/events/events.startcallbutton.md
new file mode 100644
index 0000000..b3e9893
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.startcallbutton.md
@@ -0,0 +1,86 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+startcallbutton
+===========
+
+This is an event that fires when the user presses the start call button.
+
+ document.addEventListener("startcallbutton", yourCallbackFunction, false);
+
+Details
+-------
+
+If you need to override the default start call behaviour you can register an event listener for the 'startcallbutton' event.
+
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- BlackBerry WebWorks (OS 5.0 and higher)
+
+Quick Example
+-------------
+
+ document.addEventListener("startcallbutton", onStartCallKeyDown, false);
+
+ function onStartCallKeyDown() {
+ // Handle the start call button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Cordova Start Call Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("startcallbutton", onStartCallKeyDown, false);
+ }
+
+ // Handle the start call button
+ //
+ function onStartCallKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.volumedownbutton.md b/docs/en/2.4.0rc1/cordova/events/events.volumedownbutton.md
new file mode 100644
index 0000000..8934591
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.volumedownbutton.md
@@ -0,0 +1,86 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+volumedownbutton
+===========
+
+This is an event that fires when the user presses the volume down button.
+
+ document.addEventListener("volumedownbutton", yourCallbackFunction, false);
+
+Details
+-------
+
+If you need to override the default volume down behaviour you can register an event listener for the 'volumedownbutton' event.
+
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- BlackBerry WebWorks (OS 5.0 and higher)
+
+Quick Example
+-------------
+
+ document.addEventListener("volumedownbutton", onVolumeDownKeyDown, false);
+
+ function onVolumeDownKeyDown() {
+ // Handle the volume down button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Cordova Volume Down Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("volumedownbutton", onVolumeDownKeyDown, false);
+ }
+
+ // Handle the volume down button
+ //
+ function onVolumeDownKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f52c2140/docs/en/2.4.0rc1/cordova/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.4.0rc1/cordova/events/events.volumeupbutton.md b/docs/en/2.4.0rc1/cordova/events/events.volumeupbutton.md
new file mode 100644
index 0000000..be4c908
--- /dev/null
+++ b/docs/en/2.4.0rc1/cordova/events/events.volumeupbutton.md
@@ -0,0 +1,86 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+volumeupbutton
+===========
+
+This is an event that fires when the user presses the volume up button.
+
+ document.addEventListener("volumeupbutton", yourCallbackFunction, false);
+
+Details
+-------
+
+If you need to override the default volume up behaviour you can register an event listener for the 'volumeupbutton' event.
+
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+
+Supported Platforms
+-------------------
+
+- BlackBerry WebWorks (OS 5.0 and higher)
+
+Quick Example
+-------------
+
+ document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false);
+
+ function onVolumeUpKeyDown() {
+ // Handle the volume up button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Cordova Volume Up Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.4.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Call onDeviceReady when Cordova is loaded.
+ //
+ // At this point, the document has loaded but cordova-2.4.0.js has not.
+ // When Cordova is loaded and talking with the native device,
+ // it will call the event `deviceready`.
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false);
+ }
+
+ // Handle the volume up button
+ //
+ function onVolumeUpKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>