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/02/19 23:27:17 UTC
[15/52] [partial] [#2454] Remove versions pre-dating Apache Cordova.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactError.md b/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactError.md
deleted file mode 100644
index 6b50ddc..0000000
--- a/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactError.md
+++ /dev/null
@@ -1,27 +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.
----
-
-contactError
-============
-
-Error callback function for contact functions.
-
- function(error) {
- // Handle the error
- }
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactFields.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactFields.md b/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactFields.md
deleted file mode 100644
index 66c9d3d..0000000
--- a/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactFields.md
+++ /dev/null
@@ -1,25 +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.
----
-
-contactFields
-=============
-
-Required parameter of the `contacts.find` method. Use this parameter to specify which fields should be included in the `Contact` objects resulting from a find operation.
-
- ["name", "phoneNumbers", "emails"]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactFindOptions.md b/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactFindOptions.md
deleted file mode 100644
index 2eb9afc..0000000
--- a/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactFindOptions.md
+++ /dev/null
@@ -1,35 +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.
----
-
-contactFindOptions
-==================
-
-Optional parameter of the `contacts.find` method. Use this parameter to filter the contacts returned from the contacts database.
-
- {
- filter: "",
- multiple: true,
- };
-
-Options
--------
-
-- __filter:__ The search string used to filter contacts. _(DOMString)_ (Default: "")
-- __multiple:__ Determines if the find operation should return multiple contacts. _(Boolean)_ (Default: false)
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactSuccess.md b/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactSuccess.md
deleted file mode 100644
index 9068218..0000000
--- a/docs/en/1.0.0rc2/phonegap/contacts/parameters/contactSuccess.md
+++ /dev/null
@@ -1,40 +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.
----
-
-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/d132c2bd/docs/en/1.0.0rc2/phonegap/device/device.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/device/device.md b/docs/en/1.0.0rc2/phonegap/device/device.md
deleted file mode 100644
index aa1ae31..0000000
--- a/docs/en/1.0.0rc2/phonegap/device/device.md
+++ /dev/null
@@ -1,42 +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
-======
-
-> The `device` object describes the device's hardware and software.
-
-Properties
-----------
-
-- device.name
-- device.phonegap
-- device.platform
-- device.uuid
-- device.version
-
-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;
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/device/device.name.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/device/device.name.md b/docs/en/1.0.0rc2/phonegap/device/device.name.md
deleted file mode 100644
index 436ba91..0000000
--- a/docs/en/1.0.0rc2/phonegap/device/device.name.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.
----
-
-device.name
-===========
-
-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
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- // Android: Nexus One returns "Passion" (Nexus One code name)
- // Motorola Droid returns "voles"
- // BlackBerry: Bold 8900 returns "8900"
- // iPhone: All devices returns a name set by iTunes e.g. "Joe's iPhone"
- //
- var name = device.name;
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- var element = document.getElementById('deviceProperties');
-
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device PhoneGap: ' + device.phonegap + '<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>
-
-
-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"
-
-iPhone Quirks
--------------
-
-- Gets the [device's custom name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UIDevice_Class/Reference/UIDevice.html#//apple_ref/doc/uid/TP40006902-CH3-SW13) instead of the [device model name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UIDevice_Class/Reference/UIDevice.html#//apple_ref/doc/uid/TP40006902-CH3-SW1).
- - The custom name is set by the owner in iTunes.
- - e.g. "Joe's iPhone"
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/device/device.phonegap.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/device/device.phonegap.md b/docs/en/1.0.0rc2/phonegap/device/device.phonegap.md
deleted file mode 100644
index deb9db9..0000000
--- a/docs/en/1.0.0rc2/phonegap/device/device.phonegap.md
+++ /dev/null
@@ -1,78 +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.phonegap
-===============
-
-Get the version of phonegap running on the device.
-
- var string = device.phonegap;
-
-Description
------------
-
-`device.phonegap` returns the version of phonegap running on the device.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- var name = device.phonegap;
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- var element = document.getElementById('deviceProperties');
-
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device PhoneGap: ' + device.phonegap + '<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>
-
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/device/device.platform.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/device/device.platform.md b/docs/en/1.0.0rc2/phonegap/device/device.platform.md
deleted file mode 100644
index 90dc7e1..0000000
--- a/docs/en/1.0.0rc2/phonegap/device/device.platform.md
+++ /dev/null
@@ -1,88 +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
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- // Depending on the device, a few examples are:
- // - "Android"
- // - "BlackBerry"
- // - "iPhone"
- // - "webOS"
- //
- var devicePlatform = device.platform;
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- var element = document.getElementById('deviceProperties');
-
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device PhoneGap: ' + device.phonegap + '<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
--------------
-
-All devices return `iPhone` as the platform. This is inaccurate 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.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/device/device.uuid.md b/docs/en/1.0.0rc2/phonegap/device/device.uuid.md
deleted file mode 100644
index 356ae7a..0000000
--- a/docs/en/1.0.0rc2/phonegap/device/device.uuid.md
+++ /dev/null
@@ -1,88 +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
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-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.
- //
- var deviceID = device.uuid;
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- var element = document.getElementById('deviceProperties');
-
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device PhoneGap: ' + device.phonegap + '<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>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/device/device.version.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/device/device.version.md b/docs/en/1.0.0rc2/phonegap/device/device.version.md
deleted file mode 100644
index fb765fb..0000000
--- a/docs/en/1.0.0rc2/phonegap/device/device.version.md
+++ /dev/null
@@ -1,80 +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
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-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: Bold 9000 using OS 4.6 would return "4.6.0.282"
- //
- // iPhone: iOS 3.2 returns "3.2"
- //
- var deviceVersion = device.version;
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- var element = document.getElementById('deviceProperties');
-
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device PhoneGap: ' + device.phonegap + '<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/d132c2bd/docs/en/1.0.0rc2/phonegap/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/events/events.backbutton.md b/docs/en/1.0.0rc2/phonegap/events/events.backbutton.md
deleted file mode 100644
index fae028f..0000000
--- a/docs/en/1.0.0rc2/phonegap/events/events.backbutton.md
+++ /dev/null
@@ -1,83 +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 on Android.
-
- document.addEventListener("backbutton", yourCallbackFunction, false);
-
-Details
--------
-
-If you need to over ride the default back button behaviour on Android you can register and 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 PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- Android
-
-Quick Example
--------------
-
- document.addEventListener("backbutton", onBackKeyDown, false);
-
- function onBackKeyDown() {
- // Handle the back button
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Device Ready Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but phonegap-1.0.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- // Register the event listener
- document.addEventListener("backbutton", onBackKeyDown, false);
- }
-
- // Handle the back button
- //
- function onBackKeyDown() {
- }
-
- </script>
- </head>
- <body>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/events/events.deviceready.md b/docs/en/1.0.0rc2/phonegap/events/events.deviceready.md
deleted file mode 100644
index 01efb81..0000000
--- a/docs/en/1.0.0rc2/phonegap/events/events.deviceready.md
+++ /dev/null
@@ -1,109 +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 PhoneGap is fully loaded.
-
- document.addEventListener("deviceready", yourCallbackFunction, false);
-
-Details
--------
-
-This is a very important event that every PhoneGap application should use.
-
-PhoneGap 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 PhoneGap JavaScript function before it is loaded.
-
-The PhoneGap `deviceready` event fires once PhoneGap has fully loaded. After the device has fired, you can safely make calls to PhoneGap 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)
-- iPhone
-
-Quick Example
--------------
-
- document.addEventListener("deviceready", onDeviceReady, false);
-
- function onDeviceReady() {
- // Now safe to use the PhoneGap API
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Device Ready Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but phonegap-1.0.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- // Now safe to use the PhoneGap API
- }
-
- </script>
- </head>
- <body>
- </body>
- </html>
-
-BlackBerry (OS 4.6) Quirks
---------------------------
-
-Custom events are not supported in the RIM BrowserField (web browser view), so the `deviceready` event will never fire.
-
-A workaround is to manually query `PhoneGap.available` until PhoneGap has fully loaded.
-
- function onLoad() {
- // BlackBerry OS 4 browser does not support events.
- // So, manually wait until PhoneGap is available.
- //
- var intervalID = window.setInterval(
- function() {
- if (PhoneGap.available) {
- window.clearInterval(intervalID);
- onDeviceReady();
- }
- },
- 500
- );
- }
-
- function onDeviceReady() {
- // Now safe to use the PhoneGap API
- }
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/events/events.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/events/events.md b/docs/en/1.0.0rc2/phonegap/events/events.md
deleted file mode 100644
index d25cbe1..0000000
--- a/docs/en/1.0.0rc2/phonegap/events/events.md
+++ /dev/null
@@ -1,36 +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
-======
-
-> PhoneGap lifecycle events.
-
-Event Types
------------
-
-- deviceready
-- pause
-- resume
-- online
-- offline
-- backbutton
-- menubutton
-- searchbutton
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/events/events.menubutton.md b/docs/en/1.0.0rc2/phonegap/events/events.menubutton.md
deleted file mode 100644
index 28cf872..0000000
--- a/docs/en/1.0.0rc2/phonegap/events/events.menubutton.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.
----
-
-menubutton
-===========
-
-This is an event that fires when the user presses the menu button on Android.
-
- document.addEventListener("menubutton", yourCallbackFunction, false);
-
-Details
--------
-
-If you need to over ride the default menu button behaviour on Android you can register and event listener for the 'menubutton' event.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- Android
-
-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>PhoneGap Device Ready Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but phonegap-1.0.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap 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/d132c2bd/docs/en/1.0.0rc2/phonegap/events/events.offline.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/events/events.offline.md b/docs/en/1.0.0rc2/phonegap/events/events.offline.md
deleted file mode 100644
index b2fb591..0000000
--- a/docs/en/1.0.0rc2/phonegap/events/events.offline.md
+++ /dev/null
@@ -1,88 +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 PhoneGap 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 PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- iOS
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-
-Quick Example
--------------
-
- document.addEventListener("offline", onOffline, false);
-
- function onOffline() {
- // Handle the offline event
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Device Ready Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but phonegap-1.0.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- document.addEventListener("offline", onOffline, false);
- }
-
- // Handle the offline event
- //
- function onOffline() {
- }
-
- </script>
- </head>
- <body>
- </body>
- </html>
-
-iOS Quirks
---------------------------
-During initial startup, the first offline event (if applicable) will take at least a second to fire.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/events/events.online.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/events/events.online.md b/docs/en/1.0.0rc2/phonegap/events/events.online.md
deleted file mode 100644
index a3901df..0000000
--- a/docs/en/1.0.0rc2/phonegap/events/events.online.md
+++ /dev/null
@@ -1,88 +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 PhoneGap 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 PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- iOS
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-
-Quick Example
--------------
-
- document.addEventListener("online", onOnline, false);
-
- function onOnline() {
- // Handle the online event
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Device Ready Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but phonegap-1.0.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- document.addEventListener("online", onOnline, false);
- }
-
- // Handle the online event
- //
- function onOnline() {
- }
-
- </script>
- </head>
- <body>
- </body>
- </html>
-
-iOS Quirks
---------------------------
-During initial startup, the first online event (if applicable) will take at least a second to fire.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/events/events.pause.md b/docs/en/1.0.0rc2/phonegap/events/events.pause.md
deleted file mode 100644
index 7e75da8..0000000
--- a/docs/en/1.0.0rc2/phonegap/events/events.pause.md
+++ /dev/null
@@ -1,88 +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 PhoneGap application is put into the background.
-
- document.addEventListener("pause", yourCallbackFunction, false);
-
-Details
--------
-
-PhoneGap 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 PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- document.addEventListener("pause", onPause, false);
-
- function onPause() {
- // Handle the pause event
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Device Ready Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but phonegap-1.0.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- document.addEventListener("pause", onPause, false);
- }
-
- // Handle the pause event
- //
- function onPause() {
- }
-
- </script>
- </head>
- <body>
- </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 PhoneGap API. These will only be processed when the app resumes (processed on the next run-loop).
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/events/events.resume.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/events/events.resume.md b/docs/en/1.0.0rc2/phonegap/events/events.resume.md
deleted file mode 100644
index f030884..0000000
--- a/docs/en/1.0.0rc2/phonegap/events/events.resume.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.
----
-
-resume
-===========
-
-This is an event that fires when a PhoneGap application is retrieved from the background.
-
- document.addEventListener("resume", yourCallbackFunction, false);
-
-Details
--------
-
-PhoneGap 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 PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- document.addEventListener("resume", onResume, false);
-
- function onResume() {
- // Handle the pause event
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Device Ready Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but phonegap-1.0.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- document.addEventListener("resume", onResume, false);
- }
-
- // Handle the resume event
- //
- function onResume() {
- }
-
- </script>
- </head>
- <body>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/events/events.searchbutton.md b/docs/en/1.0.0rc2/phonegap/events/events.searchbutton.md
deleted file mode 100644
index 93e00a1..0000000
--- a/docs/en/1.0.0rc2/phonegap/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 over ride the default search button behaviour on Android you can register and event listener for the 'searchbutton' event.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- Android
-
-Quick Example
--------------
-
- document.addEventListener("searchbutton", onSearchKeyDown, false);
-
- function onSearchKeyDown() {
- // 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>PhoneGap Device Ready Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but phonegap-1.0.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap 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/d132c2bd/docs/en/1.0.0rc2/phonegap/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/file/directoryentry/directoryentry.md b/docs/en/1.0.0rc2/phonegap/file/directoryentry/directoryentry.md
deleted file mode 100644
index 45f2512..0000000
--- a/docs/en/1.0.0rc2/phonegap/file/directoryentry/directoryentry.md
+++ /dev/null
@@ -1,318 +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 PhoneGap:
-
-- __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.
-- __moveTo__: Move a directory to a different location on the file system.
-- __copyTo__: Copy a directory to a different location on the file system.
-- __toURI__: Return a URI 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
-
-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);
-
-
-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,
- newName = document.getElementById('newName').value,
- parentEntry = new DirectoryEntry({fullPath: 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,
- newName = document.getElementById('newName').value,
- parentEntry = new DirectoryEntry({fullPath: parent});
-
- // copy the directory to a new directory and rename it
- entry.copyTo(parentEntry, newName, success, fail);
- }
-
-
-toURI
------
-
-Returns a URI that can be used to locate the directory.
-
-__Quick Example__
-
- // Get the URI for this directory
- var uri = entry.toURI();
- console.log(uri);
-
-
-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/d132c2bd/docs/en/1.0.0rc2/phonegap/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/file/directoryreader/directoryreader.md b/docs/en/1.0.0rc2/phonegap/file/directoryreader/directoryreader.md
deleted file mode 100644
index be929e7..0000000
--- a/docs/en/1.0.0rc2/phonegap/file/directoryreader/directoryreader.md
+++ /dev/null
@@ -1,65 +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
-
-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/d132c2bd/docs/en/1.0.0rc2/phonegap/file/file.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/file/file.md b/docs/en/1.0.0rc2/phonegap/file/file.md
deleted file mode 100644
index 4e2362f..0000000
--- a/docs/en/1.0.0rc2/phonegap/file/file.md
+++ /dev/null
@@ -1,42 +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
-==========
-
-> 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
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/file/fileentry/fileentry.md b/docs/en/1.0.0rc2/phonegap/file/fileentry/fileentry.md
deleted file mode 100644
index 8c47c17..0000000
--- a/docs/en/1.0.0rc2/phonegap/file/fileentry/fileentry.md
+++ /dev/null
@@ -1,260 +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.
----
-
-FileEntry
-==========
-
-This object represents a file 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 true. _(boolean)_
-- __isDirectory:__ Always false. _(boolean)_
-- __name:__ The name of the FileEntry, excluding the path leading to it. _(DOMString)_
-- __fullPath:__ The full absolute path from the root to the FileEntry. _(DOMString)_
-
-NOTE: The following attributes are defined by the W3C specification, but are __not supported__ by PhoneGap:
-
-- __filesystem:__ The file system on which the FileEntry resides. _(FileSystem)_
-
-
-Methods
--------
-
-- __getMetadata__: Look up metadata about a file.
-- __moveTo__: Move a file to a different location on the file system.
-- __copyTo__: Copy a file to a different location on the file system.
-- __toURI__: Return a URI that can be used to locate a file.
-- __remove__: Delete a file.
-- __getParent__: Look up the parent directory.
-- __createWriter__: Creates a FileWriter object that can be used to write to a file.
-- __file__: Creates a File object containing file properties.
-
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-
-
-getMetadata
-----------------
-
-Look up metadata about a file.
-
-__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);
-
-
-moveTo
-------
-
-Move a file to a different location on the file system. It is an error to attempt to:
-
-- move a file into its parent if a name different from its current one isn't provided;
-- move a file to a path occupied by a directory;
-
-In addition, an attempt to move a file on top of an existing file must attempt to delete and replace that file.
-
-__Parameters:__
-
-- __parent__ - The parent directory to which to move the file. _(DirectoryEntry)_
-- __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
-- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a FileError object. _(Function)_
-
-
-__Quick Example__
-
- function success(entry) {
- console.log("New Path: " + entry.fullPath);
- }
-
- function fail(error) {
- alert(error.code);
- }
-
- function moveFile(entry) {
- var parent = document.getElementById('parent').value,
- parentEntry = new DirectoryEntry({fullPath: parent});
-
- // move the file to a new directory and rename it
- entry.moveTo(parentEntry, "newFile.txt", success, fail);
- }
-
-
-copyTo
-------
-
-Copy a file to a new location on the file system. It is an error to attempt to:
-
-- copy a file into its parent if a name different from its current one is not provided.
-
-__Parameters:__
-
-- __parent__ - The parent directory to which to copy the file. _(DirectoryEntry)_
-- __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
-- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a FileError object. _(Function)_
-
-
-__Quick Example__
-
- function win(entry) {
- console.log("New Path: " + entry.fullPath);
- }
-
- function fail(error) {
- alert(error.code);
- }
-
- function copyFile(entry) {
- var parent = document.getElementById('parent').value,
- parentEntry = new DirectoryEntry({fullPath: parent});
-
- // copy the file to a new directory and rename it
- entry.copyTo(parentEntry, "file.copy", success, fail);
- }
-
-
-toURI
------
-
-Returns a URI that can be used to locate the file.
-
-__Quick Example__
-
- // Request the metadata object for this entry
- var uri = entry.toURI();
- console.log(uri);
-
-
-remove
-------
-
-Deletes a file.
-
-__Parameters:__
-
-- __successCallback__ - A callback that is called after the file has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a FileError object. _(Function)_
-
-__Quick Example__
-
- function success(entry) {
- console.log("Removal succeeded");
- }
-
- function fail(error) {
- alert('Error removing file: ' + error.code);
- }
-
- // remove the file
- entry.remove(success, fail);
-
-
-getParent
----------
-
-Look up the parent DirectoryEntry containing the file.
-
-__Parameters:__
-
-- __successCallback__ - A callback that is called with the file'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(error.code);
- }
-
- // Get the parent DirectoryEntry
- entry.getParent(success, fail);
-
-
-createWriter
-------------
-
-Create a FileWriter object associated with the file that the FileEntry represents.
-
-__Parameters:__
-
-- __successCallback__ - A callback that is called with a FileWriter object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs while attempting to create the FileWriter. Invoked with a FileError object. _(Function)_
-
-__Quick Example__
-
- function success(writer) {
- writer.write("Some text to the file");
- }
-
- function fail(error) {
- alert(error.code);
- }
-
- // create a FileWriter to write to the file
- entry.createWriter(success, fail);
-
-
-file
-----
-
-Return a File object that represents the current state of the file that this FileEntry represents.
-
-__Parameters:__
-
-- __successCallback__ - A callback that is called with a File object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when creating the File object (e.g. the underlying file no longer exists). Invoked with a FileError object. _(Function)_
-
-__Quick Example__
-
- function success(file) {
- console.log("File size: " + file.size);
- }
-
- function fail(error) {
- alert("Unable to retrieve file properties: " + error.code);
- }
-
- // obtain properties of a file
- entry.file(success, fail);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/file/fileerror/fileerror.md b/docs/en/1.0.0rc2/phonegap/file/fileerror/fileerror.md
deleted file mode 100644
index 75511c5..0000000
--- a/docs/en/1.0.0rc2/phonegap/file/fileerror/fileerror.md
+++ /dev/null
@@ -1,49 +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.
----
-
-FileError
-========
-
-A 'FileError' object is set when an error occurs in any of the File API methods.
-
-Properties
-----------
-
-- __code:__ One of the predefined error codes listed below.
-
-Constants
----------
-
-- `FileError.NOT_FOUND_ERR`
-- `FileError.SECURITY_ERR`
-- `FileError.ABORT_ERR`
-- `FileError.NOT_READABLE_ERR`
-- `FileError.ENCODING_ERR`
-- `FileError.NO_MODIFICATION_ALLOWED_ERR`
-- `FileError.INVALID_STATE_ERR`
-- `FileError.SYNTAX_ERR`
-- `FileError.INVALID_MODIFICATION_ERR`
-- `FileError.QUOTA_EXCEEDED_ERR`
-- `FileError.TYPE_MISMATCH_ERR`
-- `FileError.PATH_EXISTS_ERR`
-
-Description
------------
-
-The `FileError` object is the only parameter of any of the File API's error callbacks. Developers must read the code property to determine the type of error.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/file/fileobj/fileobj.md b/docs/en/1.0.0rc2/phonegap/file/fileobj/fileobj.md
deleted file mode 100644
index fc897d9..0000000
--- a/docs/en/1.0.0rc2/phonegap/file/fileobj/fileobj.md
+++ /dev/null
@@ -1,44 +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 object contains attributes of a single file.
-
-Properties
-----------
-
-- __name:__ The name of the file. _(DOMString)_
-- __fullPath:__ The full path of the file including the file name. _(DOMString)_
-- __type:__ The mime type of the file. _(DOMString)_
-- __lastModifiedDate:__ The last time the file was modified. _(Date)_
-- __size:__ The size of the file in bytes. _(long)_
-
-Details
--------
-
-The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `FileEntry` object.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/1.0.0rc2/phonegap/file/filereader/filereader.md b/docs/en/1.0.0rc2/phonegap/file/filereader/filereader.md
deleted file mode 100644
index fe6fc9e..0000000
--- a/docs/en/1.0.0rc2/phonegap/file/filereader/filereader.md
+++ /dev/null
@@ -1,195 +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.
----
-
-FileReader
-==========
-
-FileReader is an object that allows one to read a file.
-
-Properties
-----------
-
-- __readyState:__ One of the three states the reader can be in EMPTY, LOADING or DONE.
-- __result:__ The contents of the file that has been read. _(DOMString)_
-- __error:__ An object containing errors. _(FileError)_
-- __onloadstart:__ Called when the read starts. . _(Function)_
-- __onprogress:__ Called while reading the file, reports progress (progess.loaded/progress.total). _(Function)_ -NOT SUPPORTED
-- __onload:__ Called when the read has successfully completed. _(Function)_
-- __onabort:__ Called when the read has been aborted. For instance, by invoking the abort() method. _(Function)_
-- __onerror:__ Called when the read has failed. _(Function)_
-- __onloadend:__ Called when the request has completed (either in success or failure). _(Function)_
-
-Methods
--------
-
-- __abort__: Aborts reading file.
-- __readAsDataURL__: Read file and return data as a base64 encoded data url.
-- __readAsText__: Reads text file.
-
-Details
--------
-
-The `FileReader` object is a way to read files from the devices file system. Files can be read as text or as a base64 data encoded string. Users register their own event listeners to receive the loadstart, progress, load, loadend, error and abort events.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-
-Read As Data URL
-----------------
-
-__Parameters:__
-- file - the file object to read
-
-
-Quick Example
--------------
-
- function win(file) {
- var reader = new FileReader();
- reader.onloadend = function(evt) {
- console.log("read success");
- console.log(evt.target.result);
- };
- reader.readAsDataURL(file);
- };
-
- var fail = function(evt) {
- console.log(error.code);
- };
-
- entry.file(win, fail);
-
-Read As Text
-------------
-
-__Parameters:__
-
-- file - the file object to read
-- encoding - the encoding to use to encode the file's content. Default is UTF8.
-
-Quick Example
--------------
-
- function win(file) {
- var reader = new FileReader();
- reader.onloadend = function(evt) {
- console.log("read success");
- console.log(evt.target.result);
- };
- reader.readAsText(file);
- };
-
- var fail = function(evt) {
- console.log(error.code);
- };
-
- entry.file(win, fail);
-
-Abort Quick Example
--------------------
-
- function win(file) {
- var reader = new FileReader();
- reader.onloadend = function(evt) {
- console.log("read success");
- console.log(evt.target.result);
- };
- reader.readAsText(file);
- reader.abort();
- };
-
- function fail(error) {
- console.log(error.code);
- }
-
- entry.file(win, fail);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>FileReader Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-1.0.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
- }
-
- function gotFS(fileSystem) {
- fileSystem.root.getFile("readme.txt", null, gotFileEntry, fail);
- }
-
- function gotFileEntry(fileEntry) {
- fileEntry.file(gotFile, fail);
- }
-
- function gotFile(file){
- readDataUrl(file);
- readAsText(file);
- }
-
- function readDataUrl(file) {
- var reader = new FileReader();
- reader.onloadend = function(evt) {
- console.log("Read as data URL");
- console.log(evt.target.result);
- };
- reader.readAsDataURL(file);
- }
-
- function readAsText(file) {
- var reader = new FileReader();
- reader.onloadend = function(evt) {
- console.log("Read as text");
- console.log(evt.target.result);
- };
- reader.readAsText(file);
- }
-
- function fail(evt) {
- console.log(evt.target.error.code);
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>Read File</p>
- </body>
- </html>
-
-iOS Quirks
-----------
-- __encoding__ parameter is not supported, UTF8 encoding is always used.
\ No newline at end of file