You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2013/09/04 05:10:53 UTC
[10/51] [partial] Delete rc versions of docs
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/device/device.platform.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/device/device.platform.md b/docs/en/2.1.0rc1/cordova/device/device.platform.md
deleted file mode 100644
index 514f966..0000000
--- a/docs/en/2.1.0rc1/cordova/device/device.platform.md
+++ /dev/null
@@ -1,95 +0,0 @@
----
-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)
-- iPhone
-- Windows Phone 7 ( Mango )
-- Bada 1.2 & 2.x
-- webOS
-
-Quick Example
--------------
-
- // Depending on the device, a few examples are:
- // - "Android"
- // - "BlackBerry"
- // - "iPhone"
- // - "webOS"
- // - "WinCE"
- 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.1.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>
-
-iPhone Quirks
--------------
-
-The iPhone returns `iPhone` as the platform. The iPad returns `iPad` as the platform. In the simulator they will return `iPhone Simulator` and `iPad Simulator` respectively. These are inaccurate in all cases because Apple has rebranded the iPhone operating system as `iOS`.
-
-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'
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/device/device.uuid.md b/docs/en/2.1.0rc1/cordova/device/device.uuid.md
deleted file mode 100644
index 2cfc73b..0000000
--- a/docs/en/2.1.0rc1/cordova/device/device.uuid.md
+++ /dev/null
@@ -1,103 +0,0 @@
----
-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 ( Mango )
-- Bada 1.2 & 2.x
-- webOS
-
-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
- 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.1.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 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/875c8fe2/docs/en/2.1.0rc1/cordova/device/device.version.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/device/device.version.md b/docs/en/2.1.0rc1/cordova/device/device.version.md
deleted file mode 100644
index 61e6ce4..0000000
--- a/docs/en/2.1.0rc1/cordova/device/device.version.md
+++ /dev/null
@@ -1,84 +0,0 @@
----
-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 ( Mango )
-- Bada 1.2 & 2.x
-- webOS
-
-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
- 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.1.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/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.backbutton.md b/docs/en/2.1.0rc1/cordova/events/events.backbutton.md
deleted file mode 100644
index 7e060bb..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.backbutton.md
+++ /dev/null
@@ -1,87 +0,0 @@
----
-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 ( Mango )
-
-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.1.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.1.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/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.batterycritical.md b/docs/en/2.1.0rc1/cordova/events/events.batterycritical.md
deleted file mode 100644
index db8c158..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.batterycritical.md
+++ /dev/null
@@ -1,93 +0,0 @@
----
-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)
-
-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 Device Ready Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-2.1.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.1.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/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.batterylow.md b/docs/en/2.1.0rc1/cordova/events/events.batterylow.md
deleted file mode 100644
index f2229db..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.batterylow.md
+++ /dev/null
@@ -1,93 +0,0 @@
----
-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)
-
-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.1.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.1.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/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.batterystatus.md b/docs/en/2.1.0rc1/cordova/events/events.batterystatus.md
deleted file mode 100644
index addcaf4..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.batterystatus.md
+++ /dev/null
@@ -1,102 +0,0 @@
----
-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 ( Mango )
-
-
-Windows Phone 7 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.1.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.1.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/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.deviceready.md b/docs/en/2.1.0rc1/cordova/events/events.deviceready.md
deleted file mode 100644
index ea615ae..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.deviceready.md
+++ /dev/null
@@ -1,87 +0,0 @@
----
-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.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7
-- Bada 1.2 & 2.x
-
-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.1.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.1.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/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.endcallbutton.md b/docs/en/2.1.0rc1/cordova/events/events.endcallbutton.md
deleted file mode 100644
index 42db21d..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.endcallbutton.md
+++ /dev/null
@@ -1,86 +0,0 @@
----
-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.1.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.1.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/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.md b/docs/en/2.1.0rc1/cordova/events/events.md
deleted file mode 100644
index 83125b8..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.md
+++ /dev/null
@@ -1,93 +0,0 @@
----
-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/plugins.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
-
-#### App/Supporting Files/Cordova.plist
-
- <key>Plugins</key>
- <dict>
- <key>Battery</key>
- <string>CDVBattery</string>
- </dict>
-
-### webOS
-
- No permissions are required.
-
-### Windows Phone
-
- No permissions are required.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.menubutton.md b/docs/en/2.1.0rc1/cordova/events/events.menubutton.md
deleted file mode 100644
index 193671d..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.menubutton.md
+++ /dev/null
@@ -1,87 +0,0 @@
----
-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.1.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.1.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/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.offline.md b/docs/en/2.1.0rc1/cordova/events/events.offline.md
deleted file mode 100644
index 45f899e..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.offline.md
+++ /dev/null
@@ -1,95 +0,0 @@
----
-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
-
-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.1.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.1.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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.online.md b/docs/en/2.1.0rc1/cordova/events/events.online.md
deleted file mode 100644
index 9473daf..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.online.md
+++ /dev/null
@@ -1,95 +0,0 @@
----
-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
-
-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.1.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.1.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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.pause.md b/docs/en/2.1.0rc1/cordova/events/events.pause.md
deleted file mode 100644
index 833fe3f..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.pause.md
+++ /dev/null
@@ -1,97 +0,0 @@
----
-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
-
-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.1.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.1.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/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.resume.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.resume.md b/docs/en/2.1.0rc1/cordova/events/events.resume.md
deleted file mode 100644
index 229ba83..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.resume.md
+++ /dev/null
@@ -1,108 +0,0 @@
----
-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
-
-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.1.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.1.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/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.searchbutton.md b/docs/en/2.1.0rc1/cordova/events/events.searchbutton.md
deleted file mode 100644
index 51eede7..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.searchbutton.md
+++ /dev/null
@@ -1,86 +0,0 @@
----
-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.1.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.1.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/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.startcallbutton.md b/docs/en/2.1.0rc1/cordova/events/events.startcallbutton.md
deleted file mode 100644
index 82f876d..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.startcallbutton.md
+++ /dev/null
@@ -1,86 +0,0 @@
----
-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.1.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.1.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/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.volumedownbutton.md b/docs/en/2.1.0rc1/cordova/events/events.volumedownbutton.md
deleted file mode 100644
index 4813479..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.volumedownbutton.md
+++ /dev/null
@@ -1,86 +0,0 @@
----
-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.1.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.1.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/875c8fe2/docs/en/2.1.0rc1/cordova/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/events/events.volumeupbutton.md b/docs/en/2.1.0rc1/cordova/events/events.volumeupbutton.md
deleted file mode 100644
index 8cea5be..0000000
--- a/docs/en/2.1.0rc1/cordova/events/events.volumeupbutton.md
+++ /dev/null
@@ -1,86 +0,0 @@
----
-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.1.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.1.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>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/directoryentry/directoryentry.md b/docs/en/2.1.0rc1/cordova/file/directoryentry/directoryentry.md
deleted file mode 100644
index 1726beb..0000000
--- a/docs/en/2.1.0rc1/cordova/file/directoryentry/directoryentry.md
+++ /dev/null
@@ -1,381 +0,0 @@
----
-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.
----
-
-DirectoryEntry
-==============
-
-This object represents a directory on a file system. It is defined in the [W3C Directories and Systems](http://www.w3.org/TR/file-system-api/) specification.
-
-Properties
-----------
-
-- __isFile:__ Always false. _(boolean)_
-- __isDirectory:__ Always true. _(boolean)_
-- __name:__ The name of the DirectoryEntry, excluding the path leading to it. _(DOMString)_
-- __fullPath:__ The full absolute path from the root to the DirectoryEntry. _(DOMString)_
-
-NOTE: The following attributes are defined by the W3C specification, but are __not supported__ by Cordova:
-
-- __filesystem:__ The file system on which the DirectoryEntry resides. _(FileSystem)_
-
-Methods
--------
-
-The following methods can be invoked on a DirectoryEntry object:
-
-- __getMetadata__: Look up metadata about a directory.
-- __setMetadata__: Set metadata on a directory.
-- __moveTo__: Move a directory to a different location on the file system.
-- __copyTo__: Copy a directory to a different location on the file system.
-- __toURL__: Return a URL that can be used to locate a directory.
-- __remove__: Delete a directory. The directory must be empty.
-- __getParent__: Look up the parent directory.
-- __createReader__: Create a new DirectoryReader that can read entries from a directory.
-- __getDirectory__: Create or look up a directory.
-- __getFile__: Create or look up a file.
-- __removeRecursively__: Delete a directory and all of its contents.
-
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-getMetadata
------------
-
-Look up metadata about a directory.
-
-__Parameters:__
-
-- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_
-
-
-__Quick Example__
-
- function success(metadata) {
- console.log("Last Modified: " + metadata.modificationTime);
- }
-
- function fail(error) {
- alert(error.code);
- }
-
- // Request the metadata object for this entry
- entry.getMetadata(success, fail);
-
-setMetadata
-----------------
-
-Set metadata on a directory.
-**Only works on iOS currently** - this will set the extended attributes of a directory.
-
-__Parameters:__
-
-- __successCallback__ - A callback that is called when the metadata was successfully set. _(Function)_
-- __errorCallback__ - A callback that is called when the metadata was not successfully set. _(Function)_
-- __metadataObject__ - An object that contains the metadata keys and values. _(Object)_
-
-
-__Quick Example__
-
- function success() {
- console.log("The metadata was successfully set.");
- }
-
- function fail() {
- alert("There was an error in setting the metadata");
- }
-
- // Set the metadata
- entry.setMetadata(success, fail, { "com.apple.MobileBackup": 1});
-__iOS Quirk__
-
-- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to NOT enable the directory to be backed up by iCloud. Set the value to **0** to re-enable the directory to be backed up by iCloud.
-
-__Quick Example__
-
- function setFolderMetadata(localFileSystem, subFolder, metadataKey, metadataValue)
- {
- var onSetMetadataWin = function() {
- console.log("success setting metadata")
- }
- var onSetMetadataFail = function() {
- console.log("error setting metadata")
- }
-
- var onGetDirectoryWin = function(parent) {
- parent.setMetadata(onSetMetadataWin, onSetMetadataFail, { metadataKey: metadataValue});
- }
- var onGetDirectoryFail = function() {
- console.log("error getting dir")
- }
-
- var onFSWin = function(fileSystem) {
- fileSystem.root.getDirectory(subFolder, {create: true, exclusive: false}, onGetDirectoryWin, onGetDirectoryFail);
- }
-
- var onFSFail = function(evt) {
- console.log(evt.target.error.code);
- }
-
- window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
- }
-
- setFolderMetadata(LocalFileSystem.PERSISTENT, "Backups", "com.apple.MobileBackup", 1);
-
-moveTo
-------
-
-Move a directory to a different location on the file system. It is an error to attempt to:
-
-- move a directory inside itself or to any child at any depth;
-- move a directory into its parent if a name different from its current one is not provided;
-- move a directory to a path occupied by a file;
-- move a directory to a path occupied by a directory which is not empty.
-
-In addition, an attempt to move a directory on top of an existing empty directory must attempt to delete and replace that directory.
-
-__Parameters:__
-
-- __parent__ - The parent directory to which to move the directory. _(DirectoryEntry)_
-- __newName__ - The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
-- __successCallback__ - A callback that is called with the DirectoryEntry object of the new directory. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to move the directory. Invoked with a FileError object. _(Function)_
-
-
-__Quick Example__
-
- function success(entry) {
- console.log("New Path: " + entry.fullPath);
- }
-
- function fail(error) {
- alert(error.code);
- }
-
- function moveDir(entry) {
- var parent = document.getElementById('parent').value,
- parentName = parent.substring(parent.lastIndexOf('/')+1),
- newName = document.getElementById('newName').value,
- parentEntry = new DirectoryEntry(parentName, parent);
-
- // move the directory to a new directory and rename it
- entry.moveTo(parentEntry, newName, success, fail);
- }
-
-copyTo
-------
-
-Copy a directory to a different location on the file system. It is an error to attempt to:
-
-- copy a directory inside itself at any depth;
-- copy a directory into its parent if a name different from its current one is not provided.
-
-Directory copies are always recursive - that is, they copy all contents of the directory.
-
-__Parameters:__
-
-- __parent__ - The parent directory to which to copy the directory. _(DirectoryEntry)_
-- __newName__ - The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
-- __successCallback__ - A callback that is called with the DirectoryEntry object of the new directory. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the underlying directory. Invoked with a FileError object. _(Function)_
-
-
-__Quick Example__
-
- function win(entry) {
- console.log("New Path: " + entry.fullPath);
- }
-
- function fail(error) {
- alert(error.code);
- }
-
- function copyDir(entry) {
- var parent = document.getElementById('parent').value,
- parentName = parent.substring(parent.lastIndexOf('/')+1),
- newName = document.getElementById('newName').value,
- parentEntry = new DirectoryEntry(parentName, parent);
-
- // copy the directory to a new directory and rename it
- entry.copyTo(parentEntry, newName, success, fail);
- }
-
-
-toURL
------
-
-Returns a URL that can be used to locate the directory.
-
-__Quick Example__
-
- // Get the URL for this directory
- var dirURL = entry.toURL();
- console.log(dirURL);
-
-
-remove
-------
-
-Deletes a directory. It is an error to attempt to:
-
-- delete a directory that is not empty;
-- delete the root directory of a filesystem.
-
-__Parameters:__
-
-- __successCallback__ - A callback that is called after the directory has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the directory. Invoked with a FileError object. _(Function)_
-
-__Quick Example__
-
- function success(entry) {
- console.log("Removal succeeded");
- }
-
- function fail(error) {
- alert('Error removing directory: ' + error.code);
- }
-
- // remove this directory
- entry.remove(success, fail);
-
-
-getParent
----------
-
-Look up the parent DirectoryEntry containing the directory.
-
-__Parameters:__
-
-- __successCallback__ - A callback that is called with the directory's parent DirectoryEntry. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a FileError object. _(Function)_
-
-__Quick Example__
-
- function success(parent) {
- console.log("Parent Name: " + parent.name);
- }
-
- function fail(error) {
- alert('Failed to get parent directory: ' + error.code);
- }
-
- // Get the parent DirectoryEntry
- entry.getParent(success, fail);
-
-
-createReader
-------------
-
-Creates a new DirectoryReader to read entries in a directory.
-
-__Quick Example__
-
- // create a directory reader
- var directoryReader = entry.createReader();
-
-
-getDirectory
-------------
-
-Creates or looks up an existing directory. It is an error to attempt to:
-
-- create a directory whose immediate parent does not yet exist.
-
-__Parameters:__
-
-- __path__ - The path to the directory to be looked up or created. Either an absolute path, or a relative path from this DirectoryEntry. _(DOMString)_
-- __options__ - Options to specify whether the directory is created if it doesn't exist. _(Flags)_
-- __successCallback__ - A callback that is invoked with a DirectoryEntry object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs creating or looking up the directory. Invoked with a FileError object. _(Function)_
-
-__Quick Example__
-
- function success(parent) {
- console.log("Parent Name: " + parent.name);
- }
-
- function fail(error) {
- alert("Unable to create new directory: " + error.code);
- }
-
- // Retrieve an existing directory, or create it if it does not already exist
- entry.getDirectory("newDir", {create: true, exclusive: false}, success, fail);
-
-
-getFile
--------
-
-Creates or looks up a file. It is an error to attempt to:
-
-- create a file whose immediate parent does not yet exist.
-
-__Parameters:__
-
-- __path__ - The path to the file to be looked up or created. Either an absolute path, or a relative path from this DirectoryEntry. _(DOMString)_
-- __options__ - Options to specify whether the file is created if it doesn't exist. _(Flags)_
-- __successCallback__ - A callback that is invoked with a FileEntry object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs creating or looking up the file. Invoked with a FileError object. _(Function)_
-
-__Quick Example__
-
- function success(parent) {
- console.log("Parent Name: " + parent.name);
- }
-
- function fail(error) {
- alert("Failed to retrieve file: " + error.code);
- }
-
- // Retrieve an existing file, or create it if it does not exist
- entry.getFile("newFile.txt", {create: true, exclusive: false}, success, fail);
-
-
-removeRecursively
------------------
-
-Deletes a directory and all of its contents. In the event of an error (e.g. trying to delete
-a directory that contains a file that cannot be removed), some of the contents of the directory may
-be deleted. It is an error to attempt to:
-
-- delete the root directory of a filesystem.
-
-__Parameters:__
-
-- __successCallback__ - A callback that is called after the DirectoryEntry has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the DirectoryEntry. Invoked with a FileError object. _(Function)_
-
-__Quick Example__
-
- function success(parent) {
- console.log("Remove Recursively Succeeded");
- }
-
- function fail(error) {
- alert("Failed to remove directory or it's contents: " + error.code);
- }
-
- // remove the directory and all it's contents
- entry.removeRecursively(success, fail);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/directoryreader/directoryreader.md b/docs/en/2.1.0rc1/cordova/file/directoryreader/directoryreader.md
deleted file mode 100644
index 58e59ba..0000000
--- a/docs/en/2.1.0rc1/cordova/file/directoryreader/directoryreader.md
+++ /dev/null
@@ -1,66 +0,0 @@
----
-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.
----
-
-DirectoryReader
-===============
-
-An object that lists files and directories in a directory. Defined in the [Directories and Systems](http://www.w3.org/TR/file-system-api/) specification.
-
-Methods
--------
-
-- __readEntries__: Read the entries in a directory.
-
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 ( Mango )
-
-readEntries
------------
-
-Read the entries in this directory.
-
-__Parameters:__
-
-- __successCallback__ - A callback that is passed an array of FileEntry and DirectoryEntry objects. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the directory listing. Invoked with a FileError object. _(Function)_
-
-__Quick Example__
-
- function success(entries) {
- var i;
- for (i=0; i<entries.length; i++) {
- console.log(entries[i].name);
- }
- }
-
- function fail(error) {
- alert("Failed to list directory contents: " + error.code);
- }
-
- // Get a directory reader
- var directoryReader = dirEntry.createReader();
-
- // Get a list of all the entries in the directory
- directoryReader.readEntries(success,fail);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/2.1.0rc1/cordova/file/file.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/cordova/file/file.md b/docs/en/2.1.0rc1/cordova/file/file.md
deleted file mode 100644
index 0f93e22..0000000
--- a/docs/en/2.1.0rc1/cordova/file/file.md
+++ /dev/null
@@ -1,100 +0,0 @@
----
-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.
----
-
-File
-==========
-
-> This API is based on the W3C [File API](http://www.w3.org/TR/FileAPI). An API to read, write and navigate file system hierarchies.
-
-Objects
--------
-
-- DirectoryEntry
-- DirectoryReader
-- File
-- FileEntry
-- FileError
-- FileReader
-- FileSystem
-- FileTransfer
-- FileTransferError
-- FileUploadOptions
-- FileUploadResult
-- FileWriter
-- Flags
-- LocalFileSystem
-- Metadata
-
-Permissions
------------
-
-### Android
-
-#### app/res/xml/plugins.xml
-
- <plugin name="File" value="org.apache.cordova.FileUtils" />
- <plugin name="FileTransfer" value="org.apache.cordova.FileTransfer" />
-
-#### app/AndroidManifest.xml
-
- <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
-
-### Bada
-
- No permissions are required.
-
-### BlackBerry WebWorks
-
-#### www/plugins.xml
-
- <plugin name="File" value="org.apache.cordova.file.FileManager" />
- <plugin name="FileTransfer" value="org.apache.cordova.http.FileTransfer" />
-
-#### www/config.xml
-
- <feature id="blackberry.io.file" required="true" version="1.0.0.0" />
- <feature id="blackberry.utils" required="true" version="1.0.0.0" />
- <feature id="blackberry.io.dir" required="true" version="1.0.0.0" />
- <rim:permissions>
- <rim:permit>access_shared</rim:permit>
- </rim:permissions>
-
-### iOS
-
-#### App/Supporting Files/Cordova.plist
-
- <key>Plugins</key>
- <dict>
- <key>File</key>
- <string>CDVFile</string>
- </dict>
-
- <key>Plugins</key>
- <dict>
- <key>FileTransfer</key>
- <string>CDVFileTransfer</string>
- </dict>
-
-### webOS
-
- No permissions are required.
-
-### Windows Phone
-
- No permissions are required.