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
[34/52] [partial] [#2454] Remove versions pre-dating Apache Cordova.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/contacts/parameters/contactFindOptions.md b/docs/en/0.9.5/phonegap/contacts/parameters/contactFindOptions.md
deleted file mode 100644
index 98ddd08..0000000
--- a/docs/en/0.9.5/phonegap/contacts/parameters/contactFindOptions.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.
----
-
-contactFindOptions
-==================
-
-Optional parameter of the `contacts.find` method. Use this parameter to filter the contacts returned from the contacts database.
-
- {
- filter: "",
- multiple: true,
- updatedSince: ""
- };
-
-Options
--------
-
-- __filter:__ The search string used to filter contacts. _(DOMString)_ (Default: "")
-- __multiple:__ Determines if the find operation should return multiple contacts. _(Boolean)_ (Default: true)
-- __updatedSince:__ Only return contacts updated since the date specified. _(Date)_ (Default: "")
-
-Android Quirks
-----------
-- __updatedSince:__ Not currently supported.
-
-BlackBerry WebWorks (OS 5.0 and higher) Quirks
----------------------------------------------
-- __updatedSince:__ Not currently supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/contacts/parameters/contactSuccess.md b/docs/en/0.9.5/phonegap/contacts/parameters/contactSuccess.md
deleted file mode 100644
index 9068218..0000000
--- a/docs/en/0.9.5/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/0.9.5/phonegap/device/device.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/device/device.md b/docs/en/0.9.5/phonegap/device/device.md
deleted file mode 100644
index aa1ae31..0000000
--- a/docs/en/0.9.5/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/0.9.5/phonegap/device/device.name.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/device/device.name.md b/docs/en/0.9.5/phonegap/device/device.name.md
deleted file mode 100644
index db12c48..0000000
--- a/docs/en/0.9.5/phonegap/device/device.name.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.
----
-
-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 PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.5.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() {
- 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 onload="onLoad()">
- <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/0.9.5/phonegap/device/device.phonegap.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/device/device.phonegap.md b/docs/en/0.9.5/phonegap/device/device.phonegap.md
deleted file mode 100644
index ca02f49..0000000
--- a/docs/en/0.9.5/phonegap/device/device.phonegap.md
+++ /dev/null
@@ -1,81 +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 PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.5.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() {
- 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 onload="onLoad()">
- <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/0.9.5/phonegap/device/device.platform.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/device/device.platform.md b/docs/en/0.9.5/phonegap/device/device.platform.md
deleted file mode 100644
index 688d327..0000000
--- a/docs/en/0.9.5/phonegap/device/device.platform.md
+++ /dev/null
@@ -1,91 +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 PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.5.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() {
- 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 onload="onLoad()">
- <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/0.9.5/phonegap/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/device/device.uuid.md b/docs/en/0.9.5/phonegap/device/device.uuid.md
deleted file mode 100644
index 907b602..0000000
--- a/docs/en/0.9.5/phonegap/device/device.uuid.md
+++ /dev/null
@@ -1,91 +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 PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.5.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() {
- 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 onload="onLoad()">
- <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/0.9.5/phonegap/device/device.version.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/device/device.version.md b/docs/en/0.9.5/phonegap/device/device.version.md
deleted file mode 100644
index 8bc7cad..0000000
--- a/docs/en/0.9.5/phonegap/device/device.version.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.
----
-
-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 PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.5.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() {
- 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 onload="onLoad()">
- <p id="deviceProperties">Loading device properties...</p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/events/events.deviceready.md b/docs/en/0.9.5/phonegap/events/events.deviceready.md
deleted file mode 100644
index e84a828..0000000
--- a/docs/en/0.9.5/phonegap/events/events.deviceready.md
+++ /dev/null
@@ -1,112 +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 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.0.9.5.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but phonegap.0.9.5.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() {
- // Now safe to use the PhoneGap API
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </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/0.9.5/phonegap/events/events.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/events/events.md b/docs/en/0.9.5/phonegap/events/events.md
deleted file mode 100644
index f3932f7..0000000
--- a/docs/en/0.9.5/phonegap/events/events.md
+++ /dev/null
@@ -1,28 +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
-======
-
-> There is only one and it fires when PhoneGap is loaded.
-
-Event Types
------------
-
-- deviceready
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/file/file.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/file/file.md b/docs/en/0.9.5/phonegap/file/file.md
deleted file mode 100644
index f0e022c..0000000
--- a/docs/en/0.9.5/phonegap/file/file.md
+++ /dev/null
@@ -1,34 +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
-==========
-
-> The `FileReader` and `FileWriter` objects provide access to the devices file system for reading of files.
-
-Objects
--------
-
-- FileReader
-- FileWriter
-- FileError
-- FileTransfer
-- FileUploadOptions
-- FileUploadResult
-- FileTransferError
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/file/fileerror/fileerror.md b/docs/en/0.9.5/phonegap/file/fileerror/fileerror.md
deleted file mode 100644
index 6ae5726..0000000
--- a/docs/en/0.9.5/phonegap/file/fileerror/fileerror.md
+++ /dev/null
@@ -1,46 +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 on the FileWriter/FileReader error property when an error occurs.
-
-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`
-
-Description
------------
-
-The `FileError` object may be thrown when an unrecoverable error occurs when reading, writing, seeking or truncating a file. When the user calls the abort method of the writer a FileError with a code of ABORT_ERR is thrown if the current state is FileWriter.DONE or FileWriter.INIT.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/file/filereader/filereader.md b/docs/en/0.9.5/phonegap/file/filereader/filereader.md
deleted file mode 100644
index 3ef07bc..0000000
--- a/docs/en/0.9.5/phonegap/file/filereader/filereader.md
+++ /dev/null
@@ -1,164 +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:__
-- fileName - the full path of the file to read
-
-
-Quick Example
--------------
-
- var win = function(evt) {
- console.log(evt.target.result);
- };
- var fail = function(evt) {
- console.log(evt.target.error.code);
- };
-
- var paths = navigator.fileMgr.getRootPaths();
- var reader = new FileReader();
- reader.onload = win;
- reader.onerror= fail;
- reader.readAsDataURL(paths[0] + "readme.txt");
-
-Read As Text
-------------
-
-__Parameters:__
-
-- fileName - the full path of the file to read
-- encoding - the encoding to use to encode the file's content. Default is UTF8.
-
-Quick Example
--------------
-
- var win = function(evt) {
- console.log(evt.target.result);
- };
- var fail = function(evt) {
- console.log(evt.target.error.code);
- };
-
- var paths = navigator.fileMgr.getRootPaths();
- var reader = new FileReader();
- reader.onload = win;
- reader.onerror= fail;
- reader.readAsText(paths[0] + "readme.txt");
-
-Abort Quick Example
--------------------
-
- var aborted = function(evt) {
- console.log(evt.target.error.code);
- };
-
- var paths = navigator.fileMgr.getRootPaths();
- var reader = new FileReader();
- reader.onabort = aborted;
- reader.readAsText(paths[0] + "readme.txt");
- reader.abort();
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.5.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() {
- var paths = navigator.fileMgr.getRootPaths();
- var reader = new FileReader();
- reader.onload = win;
- reader.onerror= fail;
- reader.readAsText(paths[0] + "readme.txt");
- }
-
- function win(evt) {
- console.log(evt.target.result);
- }
-
- function fail(evt) {
- console.log(evt.target.error.code);
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <h1>Example</h1>
- <p>Read File</p>
- </body>
- </html>
-
-iOS Quirks
-----------
-- __encoding__ parameter is not supported, UTF8 encoding is always used.
-- __readAsDataUrl()__ is not supported.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/file/filetransfer/filetransfer.md b/docs/en/0.9.5/phonegap/file/filetransfer/filetransfer.md
deleted file mode 100644
index dc10c6e..0000000
--- a/docs/en/0.9.5/phonegap/file/filetransfer/filetransfer.md
+++ /dev/null
@@ -1,127 +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.
----
-
-FileTransfer
-==========
-
-FileTransfer is an object that allows you to upload files to a server.
-
-Properties
-----------
-
-N/A
-
-Methods
--------
-
-- __upload__: sends a file to a server.
-
-Details
--------
-
-The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a FileUploadOptions object to the upload method. On successful upload, the success callback will be called with a FileUploadResult object. If an error occurs, the error callback will be invoked with a FileTransferError object.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-
-Quick Example
-------------------------------
-
- var win = function(r) {
- console.log("Code = " + r.responseCode);
- console.log("Response = " + r.response);
- console.log("Sent = " + r.bytesSent);
- }
-
- var fail = function(error) {
- alert("An error has occurred: Code = " = error.code);
- }
-
- var options = new FileUploadOptions();
- options.fileKey="file";
- options.fileName="newfile.txt";
- options.mimeType="text/plain";
-
- var params = new Object();
- params.value1 = "test";
- params.value2 = "param";
-
- options.params = params;
-
- var paths = navigator.fileMgr.getRootPaths();
- var ft = new FileTransfer();
- ft.upload(paths[0] + "newfile.txt", "http://some.server.com/upload.php", win, fail, options);
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.5.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() {
- var options = new FileUploadOptions();
- options.fileKey="file";
- options.fileName="newfile.txt";
- options.mimeType="text/plain";
-
- var params = new Object();
- params.value1 = "test";
- params.value2 = "param";
-
- options.params = params;
-
- var paths = navigator.fileMgr.getRootPaths();
- var ft = new FileTransfer();
- ft.upload(paths[0] + "newfile.txt", "http://some.server.com/upload.php", win, fail, options);
- }
-
- function win(evt) {
- console.log("Code = " + r.responseCode);
- console.log("Response = " + r.response);
- console.log("Sent = " + r.bytesSent);
- }
-
- function fail(evt) {
- alert("An error has occurred: Code = " = error.code);
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <h1>Example</h1>
- <p>Read File</p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/file/filetransfererror/filetransfererror.md b/docs/en/0.9.5/phonegap/file/filetransfererror/filetransfererror.md
deleted file mode 100644
index 78d831b..0000000
--- a/docs/en/0.9.5/phonegap/file/filetransfererror/filetransfererror.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.
----
-
-FileTransferError
-========
-
-A `FileTransferError` object is thrown when an error occurs.
-
-Properties
-----------
-
-- __code:__ One of the predefined error codes listed below. (int)
-
-Constants
----------
-
-- `FileTransferError.FILE_NOT_FOUND_ERR`
-- `FileTransferError.INVALID_URL_ERR`
-- `FileTransferError.CONNECTION_ERR`
-
-Description
------------
-
-The `FileTransferError` object is thrown when an error occurs when uploading a file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/file/fileuploadoptions/fileuploadoptions.md b/docs/en/0.9.5/phonegap/file/fileuploadoptions/fileuploadoptions.md
deleted file mode 100644
index 36e5165..0000000
--- a/docs/en/0.9.5/phonegap/file/fileuploadoptions/fileuploadoptions.md
+++ /dev/null
@@ -1,37 +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.
----
-
-FileUploadOptions
-========
-
-A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
-
-Properties
-----------
-
-- __fileKey:__ The name of the form element. If not set defaults to "file". (DOMString)
-- __fileName:__ The file name you want the file to be saved as on the server. If not set defaults to "image.jpg". (DOMString)
-- __mimeType:__ The mime type of the data you are uploading. If not set defaults to "image/jpeg". (DOMString)
-- __params:__ A set of optional key/value pairs to be passed along in the HTTP request. (Object)
-
-
-Description
------------
-
-A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/file/fileuploadresult/fileuploadresult.md b/docs/en/0.9.5/phonegap/file/fileuploadresult/fileuploadresult.md
deleted file mode 100644
index 09e7ef9..0000000
--- a/docs/en/0.9.5/phonegap/file/fileuploadresult/fileuploadresult.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.
----
-
-FileUploadResult
-========
-
-A `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
-
-Properties
-----------
-
-- __bytesSent:__ The number of bytes sent to the server as part of the upload. (long)
-- __responseCode:__ The HTTP response code returned by the server. (long)
-- __response:__ The HTTP response returned by the server. (DOMString)
-
-Description
------------
-
-The `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/file/filewriter/filewriter.md b/docs/en/0.9.5/phonegap/file/filewriter/filewriter.md
deleted file mode 100644
index dfdc341..0000000
--- a/docs/en/0.9.5/phonegap/file/filewriter/filewriter.md
+++ /dev/null
@@ -1,162 +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.
----
-
-FileWriter
-==========
-
-FileWriter is an object that allows one to write a file.
-
-Properties
-----------
-
-- __readyState:__ One of the three states the reader can be in INIT, WRITING or DONE.
-- __fileName:__ The name of the file to be written. _(DOMString)_
-- __length:__ The length of the file to be written. _(long)_
-- __position:__ The current position of the file pointer. _(long)_
-- __error:__ An object containing errors. _(FileError)_
-- __onwritestart:__ Called when the write starts. . _(Function)_
-- __onprogress:__ Called while writing the file, reports progress (progress.loaded/progress.total). _(Function)_ -NOT SUPPORTED
-- __onwrite:__ Called when the request has completed successfully. _(Function)_
-- __onabort:__ Called when the write has been aborted. For instance, by invoking the abort() method. _(Function)_
-- __onerror:__ Called when the write has failed. _(Function)_
-- __onwriteend:__ Called when the request has completed (either in success or failure). _(Function)_
-
-Methods
--------
-
-- __abort__: Aborts writing file.
-- __seek__: Moves the file pointer to the byte specified.
-- __truncate__: Shortens the file to the length specified.
-- __write__: Writes data to the file.
-
-Details
--------
-
-The `FileWriter` object is a way to write files from the devices file system. Users register their own event listeners to receive the writestart, progress, write, writeend, error and abort events.
-
-A FileWriter is created for a single file. You can use it to write to a file multiple times. The FileWriter maintains the file's position and length attributes, so you can seek and write anywhere in the file. By default, the FileWriter writes to the beginning of the file (will overwrite existing data). Set the optional append boolean to true in the FileWriter's constructor to begin writing to the end of the file.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-
-Seek Quick Example
-------------------------------
-
- var paths = navigator.fileMgr.getRootPaths();
- var writer = new FileWriter(paths[0] + "write.txt");
- // fast forwards file pointer to end of file
- writer.seek(writer.length);
-
-Truncate Quick Example
---------------------------
-
- var paths = navigator.fileMgr.getRootPaths();
- var writer = new FileWriter(paths[0] + "write.txt");
- writer.truncate(10);
-
-Write Quick Example
--------------------
-
- var writeSuccess = function(evt) {
- console.log("Write has succeeded");
- };
-
- var paths = navigator.fileMgr.getRootPaths();
- var writer = new FileWriter(paths[0] + "write.txt");
- writer.onwrite = writeSuccess;
- writer.write("some sample text");
-
-Append Quick Example
---------------------
-
- var writeSuccess = function(evt) {
- console.log("Write has succeeded");
- };
-
- var paths = navigator.fileMgr.getRootPaths();
- var writer = new FileWriter(paths[0] + "write.txt", true);
- writer.onwrite = writeSuccess;
- writer.write("some more text");
-
-Abort Quick Example
--------------------
-
- var aborted = function(evt) {
- console.log(evt.target.error);
- };
-
- var paths = navigator.fileMgr.getRootPaths();
- var writer = new FileWriter(paths[0] + "write.txt");
- writer.onabort = aborted;
- writer.write("some sample text");
- writer.abort();
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.5.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() {
- var paths = navigator.fileMgr.getRootPaths();
- var writer = new FileWriter(paths[0] + "write.txt");
- writer.onwrite = writeSuccess;
- writer.write("some sample text");
- // The file is now 'some sample text'
- }
-
- function writeSuccess() {
- console.log("Write has succeeded");
- var paths = navigator.fileMgr.getRootPaths();
- var writer = new FileWriter(paths[0] + "write.txt");
- writer.seek(4);
- writer.truncate(writer.position);
- // The file is now 'some'
- }
-
- function fail(evt) {
- console.log(evt.target.error.code);
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <h1>Example</h1>
- <p>Write File</p>
- </body>
- </html>
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/geolocation/Coordinates/coordinates.md b/docs/en/0.9.5/phonegap/geolocation/Coordinates/coordinates.md
deleted file mode 100644
index b2818e8..0000000
--- a/docs/en/0.9.5/phonegap/geolocation/Coordinates/coordinates.md
+++ /dev/null
@@ -1,126 +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.
----
-
-Coordinates
-===========
-
-A set of properties that describe the geographic coordinates of a position.
-
-Properties
-----------
-
-* __latitude__: Latitude in decimal degrees. _(Number)_
-* __longitude__: Longitude in decimal degrees. _(Number)_
-* __altitude__: Height of the position in meters above the ellipsoid. _(Number)_
-* __accuracy__: Accuracy level of the latitude and longitude coordinates in meters. _(Number)_
-* __altitudeAccuracy__: Accuracy level of the altitude coordinate in meters. _(Number)_
-* __heading__: Direction of travel, specified in degrees counting clockwise relative to the true north. _(Number)_
-* __speed__: Current ground speed of the device, specified in meters per second. _(Number)_
-
-Description
------------
-
-The `Coordinates` object is created and populated by PhoneGap, and attached to the `Position` object. The `Position` object is then returned to the user through a callback function.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry (OS 4.6)
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- // onSuccess Callback
- //
- var onSuccess = function(position) {
- alert('Latitude: ' + position.coords.latitude + '\n' +
- 'Longitude: ' + position.coords.longitude + '\n' +
- 'Altitude: ' + position.coords.altitude + '\n' +
- 'Accuracy: ' + position.coords.accuracy + '\n' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' +
- 'Heading: ' + position.coords.heading + '\n' +
- 'Speed: ' + position.coords.speed + '\n' +
- 'Timestamp: ' + new Date(position.timestamp) + '\n');
- };
-
- // onError Callback
- //
- var onError = function() {
- alert('onError!');
- };
-
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Geolocation Position Example</title>
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.5.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Set an event to wait for PhoneGap to load
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and Ready
- //
- function onDeviceReady() {
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
- }
-
- // Display `Position` properties from the geolocation
- //
- function onSuccess(position) {
- var div = document.getElementById('myDiv');
-
- div.innerHTML = 'Latitude: ' + position.coords.latitude + '<br/>' +
- 'Longitude: ' + position.coords.longitude + '<br/>' +
- 'Altitude: ' + position.coords.altitude + '<br/>' +
- 'Accuracy: ' + position.coords.accuracy + '<br/>' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br/>' +
- 'Heading: ' + position.coords.heading + '<br/>' +
- 'Speed: ' + position.coords.speed + '<br/>';
- }
-
- // Show an alert if there is a problem getting the geolocation
- //
- function onError() {
- alert('onError!');
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <div id="myDiv"></div>
- </body>
- </html>
-
-Android Quirks
--------------
-
-__altitudeAccuracy:__ This property is not support by Android devices, it will always return null.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/geolocation/Position/position.md b/docs/en/0.9.5/phonegap/geolocation/Position/position.md
deleted file mode 100644
index b6ffa2a..0000000
--- a/docs/en/0.9.5/phonegap/geolocation/Position/position.md
+++ /dev/null
@@ -1,132 +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.
----
-
-Position
-========
-
-Contains `Position` coordinates that are created by the geolocation API.
-
-Properties
-----------
-
-- __coords:__ A set of geographic coordinates. _(Coordinates)_
-- __timestamp:__ Creation timestamp for `coords` in milliseconds. _(DOMTimeStamp)_
-
-Description
------------
-
-The `Position` object is created and populated by PhoneGap, and returned to the user through a callback function.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry (OS 4.6)
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- // onSuccess Callback
- //
- var onSuccess = function(position) {
- alert('Latitude: ' + position.coords.latitude + '\n' +
- 'Longitude: ' + position.coords.longitude + '\n' +
- 'Altitude: ' + position.coords.altitude + '\n' +
- 'Accuracy: ' + position.coords.accuracy + '\n' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' +
- 'Heading: ' + position.coords.heading + '\n' +
- 'Speed: ' + position.coords.speed + '\n' +
- 'Timestamp: ' + new Date(position.timestamp) + '\n');
- };
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.5.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() {
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
- }
-
- // onSuccess Geolocation
- //
- function onSuccess(position) {
- var element = document.getElementById('geolocation');
- element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
- 'Longitude: ' + position.coords.longitude + '<br />' +
- 'Altitude: ' + position.coords.altitude + '<br />' +
- 'Accuracy: ' + position.coords.accuracy + '<br />' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br />' +
- 'Heading: ' + position.coords.heading + '<br />' +
- 'Speed: ' + position.coords.speed + '<br />' +
- 'Timestamp: ' + new Date(position.timestamp) + '<br />';
- }
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <p id="geolocation">Finding geolocation...</p>
- </body>
- </html>
-
-iPhone Quirks
--------------
-
-- __timestamp:__ Uses seconds instead of milliseconds.
-
-A workaround is to manually convert the timestamp to milliseconds (x 1000):
-
- var onSuccess = function(position) {
- alert('Latitude: ' + position.coords.latitude + '\n' +
- 'Longitude: ' + position.coords.longitude + '\n' +
- 'Timestamp: ' + new Date(position.timestamp * 1000) + '\n');
- };
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/geolocation/PositionError/positionError.md b/docs/en/0.9.5/phonegap/geolocation/PositionError/positionError.md
deleted file mode 100755
index aa64fe1..0000000
--- a/docs/en/0.9.5/phonegap/geolocation/PositionError/positionError.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.
----
-
-PositionError
-========
-
-A `PositionError` object is returned to the geolocationError callback when an error occurs.
-
-Properties
-----------
-
-- __code:__ One of the predefined error codes listed below.
-- __message:__ Error message describing the details of the error encountered.
-
-Constants
----------
-
-- `PositionError.PERMISSION_DENIED`
-- `PositionError.POSITION_UNAVAILABLE`
-- `PositionError.TIMEOUT`
-
-Description
------------
-
-The `PositionError` object is returned to the user through the `geolocationError` callback function when an error occurs with geolocation.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/geolocation/geolocation.clearWatch.md b/docs/en/0.9.5/phonegap/geolocation/geolocation.clearWatch.md
deleted file mode 100644
index 637a87c..0000000
--- a/docs/en/0.9.5/phonegap/geolocation/geolocation.clearWatch.md
+++ /dev/null
@@ -1,116 +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.
----
-
-geolocation.clearWatch
-======================
-
-Stop watching for changes to the device's location referenced by the `watchID` parameter.
-
- navigator.geolocation.clearWatch(watchID);
-
-Parameters
-----------
-
-- __watchID:__ The id of the `watchPosition` interval to clear. (String)
-
-Description
------------
-
-Function `geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watchPosition` referenced by `watchID`.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry (OS 4.6)
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- // Options: retrieve the location every 3 seconds
- //
- var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { frequency: 3000 });
-
- // ...later on...
-
- navigator.geolocation.clearWatch(watchID);
-
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.5.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- var watchID = null;
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- // Update every 3 seconds
- var options = { frequency: 3000 };
- watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
- }
-
- // onSuccess Geolocation
- //
- function onSuccess(position) {
- var element = document.getElementById('geolocation');
- element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
- 'Longitude: ' + position.coords.longitude + '<br />' +
- '<hr />' + element.innerHTML;
- }
-
- // clear the watch that was started earlier
- //
- function clearWatch() {
- if (watchID != null) {
- navigator.geolocation.clearWatch(watchID);
- watchID = null;
- }
- }
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <p id="geolocation">Watching geolocation...</p>
- <button onclick="clearWatch();">Clear Watch</button>
- </body>
- </html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/geolocation/geolocation.getCurrentPosition.md b/docs/en/0.9.5/phonegap/geolocation/geolocation.getCurrentPosition.md
deleted file mode 100644
index b357c88..0000000
--- a/docs/en/0.9.5/phonegap/geolocation/geolocation.getCurrentPosition.md
+++ /dev/null
@@ -1,127 +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.
----
-
-geolocation.getCurrentPosition
-==============================
-
-Returns the device's current position as a `Position` object.
-
- navigator.geolocation.getCurrentPosition(geolocationSuccess,
- [geolocationError],
- [geolocationOptions]);
-
-Parameters
-----------
-
-- __geolocationSuccess__: The callback that is called with the current position.
-- __geolocationError__: (Optional) The callback that is called if there was an error.
-- __geolocationOptions__: (Optional) The geolocation options.
-
-Description
------------
-
-Function `geolocation.getCurrentPosition` is an asynchronous function. It returns the device's current position to the `geolocationSuccess` callback with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
-
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry (OS 4.6)
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- // onSuccess Callback
- // This method accepts a `Position` object, which contains
- // the current GPS coordinates
- //
- var onSuccess = function(position) {
- alert('Latitude: ' + position.coords.latitude + '\n' +
- 'Longitude: ' + position.coords.longitude + '\n' +
- 'Altitude: ' + position.coords.altitude + '\n' +
- 'Accuracy: ' + position.coords.accuracy + '\n' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' +
- 'Heading: ' + position.coords.heading + '\n' +
- 'Speed: ' + position.coords.speed + '\n' +
- 'Timestamp: ' + new Date(position.timestamp) + '\n');
- };
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.5.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() {
- navigator.geolocation.getCurrentPosition(onSuccess, onError);
- }
-
- // onSuccess Geolocation
- //
- function onSuccess(position) {
- var element = document.getElementById('geolocation');
- element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
- 'Longitude: ' + position.coords.longitude + '<br />' +
- 'Altitude: ' + position.coords.altitude + '<br />' +
- 'Accuracy: ' + position.coords.accuracy + '<br />' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br />' +
- 'Heading: ' + position.coords.heading + '<br />' +
- 'Speed: ' + position.coords.speed + '<br />' +
- 'Timestamp: ' + new Date(position.timestamp) + '<br />';
- }
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <p id="geolocation">Finding geolocation...</p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/geolocation/geolocation.md b/docs/en/0.9.5/phonegap/geolocation/geolocation.md
deleted file mode 100644
index e45b31c..0000000
--- a/docs/en/0.9.5/phonegap/geolocation/geolocation.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.
----
-
-Geolocation
-===========
-
-> The `geolocation` object provides access to the device's GPS sensor.
-
-Geolocation provides location information for the device, such as latitude and longitude. Common sources of location information include Global Positioning System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. No guarantee is given that the API returns the device's actual location.
-
-This API is based on the [W3C Geo location API Specification](http://dev.w3.org/geo/api/spec-source.html). Some devices already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with PhoneGap's implementation. For devices that don't have geolocation support, PhoneGap's implementation should be compatible with the W3C specification.
-
-Methods
--------
-
-- geolocation.getCurrentPosition
-- geolocation.watchPosition
-- geolocation.clearWatch
-
-
-Arguments
----------
-
-- geolocationSuccess
-- geolocationError
-- geolocationOptions
-
-Objects (Read-Only)
--------------------
-
-- Position
-- PositionError
-- Coordinates
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/geolocation/geolocation.watchPosition.md b/docs/en/0.9.5/phonegap/geolocation/geolocation.watchPosition.md
deleted file mode 100644
index c966b1a..0000000
--- a/docs/en/0.9.5/phonegap/geolocation/geolocation.watchPosition.md
+++ /dev/null
@@ -1,129 +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.
----
-
-geolocation.watchPosition
-=========================
-
-Watches for changes to the device's current position.
-
- var watchId = navigator.geolocation.watchPosition(geolocationSuccess,
- [geolocationError],
- [geolocationOptions]);
-
-Parameters
-----------
-
-- __geolocationSuccess__: The callback that is called with the current position.
-- __geolocationError__: (Optional) The callback that is called if there was an error.
-- __geolocationOptions__: (Optional) The geolocation options.
-
-Returns
--------
-
-- __String__: returns a watch id that references the watch position interval. The watch id can be used with `geolocation.clearWatch` to stop watching for changes in position.
-
-Description
------------
-
-Function `geolocation.watchPosition` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `geolocationSuccess` callback is invoked with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry (OS 4.6)
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- // onSuccess Callback
- // This method accepts a `Position` object, which contains
- // the current GPS coordinates
- //
- function onSuccess(position) {
- var element = document.getElementById('geolocation');
- element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
- 'Longitude: ' + position.coords.longitude + '<br />' +
- '<hr />' + element.innerHTML;
- }
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- // Options: retrieve the location every 3 seconds
- //
- var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { frequency: 3000 });
-
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap.0.9.5.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- var watchID = null;
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- // Update every 3 seconds
- var options = { frequency: 3000 };
- watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
- }
-
- // onSuccess Geolocation
- //
- function onSuccess(position) {
- var element = document.getElementById('geolocation');
- element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
- 'Longitude: ' + position.coords.longitude + '<br />' +
- '<hr />' + element.innerHTML;
- }
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <p id="geolocation">Watching geolocation...</p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/0.9.5/phonegap/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.5/phonegap/geolocation/parameters/geolocation.options.md b/docs/en/0.9.5/phonegap/geolocation/parameters/geolocation.options.md
deleted file mode 100644
index ce2cf69..0000000
--- a/docs/en/0.9.5/phonegap/geolocation/parameters/geolocation.options.md
+++ /dev/null
@@ -1,41 +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.
----
-
-geolocationOptions
-==================
-
-Optional parameters to customize the retrieval of the geolocation.
-
- { maximumAge: 3000, timeout: 5000, enableHighAccuracy: true };
-
-Options
--------
-
-- __frequency:__ How often to retrieve the position in milliseconds. This option is not part of the W3C spec and will be removed in the future. maximumAge should be used instead. _(Number)_ (Default: 10000)
-- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. _(Boolean)_
-- __timeout:__ The maximum length of time (msec) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback is invoked. _(Number)_
-- __maximumAge:__ Accept a cached position whose age is no greater than the specified time in milliseconds. _(Number)_
-
-Android Quirks
---------------
-
-The Android 2.x simulators will not return a geolocation result unless the enableHighAccuracy option is set to true.
-
- { enableHighAccuracy: true }
-