You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2013/09/04 05:11:21 UTC
[38/51] [partial] Delete rc versions of docs
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/config.json
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/config.json b/docs/en/1.7.0rc1/config.json
deleted file mode 100644
index a4aa16e..0000000
--- a/docs/en/1.7.0rc1/config.json
+++ /dev/null
@@ -1,170 +0,0 @@
-{
- "language": "English",
- "merge": {
- "accelerometer.md": [
- "cordova/accelerometer/accelerometer.md",
- "cordova/accelerometer/accelerometer.getCurrentAcceleration.md",
- "cordova/accelerometer/accelerometer.watchAcceleration.md",
- "cordova/accelerometer/accelerometer.clearWatch.md",
- "cordova/accelerometer/acceleration/acceleration.md",
- "cordova/accelerometer/parameters/accelerometerSuccess.md",
- "cordova/accelerometer/parameters/accelerometerError.md",
- "cordova/accelerometer/parameters/accelerometerOptions.md"
- ],
- "camera.md": [
- "cordova/camera/camera.md",
- "cordova/camera/camera.getPicture.md",
- "cordova/camera/parameter/cameraSuccess.md",
- "cordova/camera/parameter/cameraError.md",
- "cordova/camera/parameter/cameraOptions.md"
- ],
- "capture.md": [
- "cordova/media/capture/capture.md",
- "cordova/media/capture/captureAudio.md",
- "cordova/media/capture/captureAudioOptions.md",
- "cordova/media/capture/captureImage.md",
- "cordova/media/capture/captureImageOptions.md",
- "cordova/media/capture/captureVideo.md",
- "cordova/media/capture/captureVideoOptions.md",
- "cordova/media/capture/CaptureError.md",
- "cordova/media/capture/CaptureCB.md",
- "cordova/media/capture/CaptureErrorCB.md",
- "cordova/media/capture/ConfigurationData.md",
- "cordova/media/capture/MediaFile.md",
- "cordova/media/capture/MediaFile.getFormatData.md",
- "cordova/media/capture/MediaFileData.md"
- ],
- "compass.md": [
- "cordova/compass/compass.md",
- "cordova/compass/compass.getCurrentHeading.md",
- "cordova/compass/compass.watchHeading.md",
- "cordova/compass/compass.clearWatch.md",
- "cordova/compass/compass.watchHeadingFilter.md",
- "cordova/compass/compass.clearWatchFilter.md",
- "cordova/compass/parameters/compassSuccess.md",
- "cordova/compass/parameters/compassError.md",
- "cordova/compass/parameters/compassOptions.md",
- "cordova/compass/parameters/compassHeading.md",
- "cordova/compass/compassError/compassError.md"
- ],
- "contacts.md": [
- "cordova/contacts/contacts.md",
- "cordova/contacts/contacts.create.md",
- "cordova/contacts/contacts.find.md",
- "cordova/contacts/Contact/contact.md",
- "cordova/contacts/ContactAddress/contactaddress.md",
- "cordova/contacts/ContactField/contactfield.md",
- "cordova/contacts/ContactFindOptions/contactfindoptions.md",
- "cordova/contacts/ContactName/contactname.md",
- "cordova/contacts/ContactOrganization/contactorganization.md",
- "cordova/contacts/ContactError/contactError.md",
- "cordova/contacts/parameters/contactSuccess.md",
- "cordova/contacts/parameters/contactError.md",
- "cordova/contacts/parameters/contactFields.md",
- "cordova/contacts/parameters/contactFindOptions.md"
- ],
- "device.md": [
- "cordova/device/device.md",
- "cordova/device/device.name.md",
- "cordova/device/device.cordova.md",
- "cordova/device/device.platform.md",
- "cordova/device/device.uuid.md",
- "cordova/device/device.version.md"
- ],
- "events.md": [
- "cordova/events/events.md",
- "cordova/events/events.deviceready.md",
- "cordova/events/events.pause.md",
- "cordova/events/events.resume.md",
- "cordova/events/events.online.md",
- "cordova/events/events.offline.md",
- "cordova/events/events.backbutton.md",
- "cordova/events/events.batterycritical.md",
- "cordova/events/events.batterylow.md",
- "cordova/events/events.batterystatus.md",
- "cordova/events/events.menubutton.md",
- "cordova/events/events.searchbutton.md",
- "cordova/events/events.startcallbutton.md",
- "cordova/events/events.endcallbutton.md",
- "cordova/events/events.volumedownbutton.md",
- "cordova/events/events.volumeupbutton.md"
- ],
- "file.md": [
- "cordova/file/file.md",
- "cordova/file/fileobj/fileobj.md",
- "cordova/file/filereader/filereader.md",
- "cordova/file/filewriter/filewriter.md",
- "cordova/file/filesystem/filesystem.md",
- "cordova/file/fileentry/fileentry.md",
- "cordova/file/directoryentry/directoryentry.md",
- "cordova/file/directoryreader/directoryreader.md",
- "cordova/file/filetransfer/filetransfer.md",
- "cordova/file/fileuploadoptions/fileuploadoptions.md",
- "cordova/file/fileuploadresult/fileuploadresult.md",
- "cordova/file/flags/flags.md",
- "cordova/file/localfilesystem/localfilesystem.md",
- "cordova/file/metadata/metadata.md",
- "cordova/file/fileerror/fileerror.md",
- "cordova/file/filetransfererror/filetransfererror.md"
- ],
- "geolocation.md": [
- "cordova/geolocation/geolocation.md",
- "cordova/geolocation/geolocation.getCurrentPosition.md",
- "cordova/geolocation/geolocation.watchPosition.md",
- "cordova/geolocation/geolocation.clearWatch.md",
- "cordova/geolocation/Coordinates/coordinates.md",
- "cordova/geolocation/Position/position.md",
- "cordova/geolocation/PositionError/positionError.md",
- "cordova/geolocation/parameters/geolocationSuccess.md",
- "cordova/geolocation/parameters/geolocationError.md",
- "cordova/geolocation/parameters/geolocation.options.md"
- ],
- "media.md": [
- "cordova/media/media.md",
- "cordova/media/media.getCurrentPosition.md",
- "cordova/media/media.getDuration.md",
- "cordova/media/media.pause.md",
- "cordova/media/media.play.md",
- "cordova/media/media.release.md",
- "cordova/media/media.seekTo.md",
- "cordova/media/media.startRecord.md",
- "cordova/media/media.stop.md",
- "cordova/media/media.stopRecord.md",
- "cordova/media/MediaError/mediaError.md",
- "cordova/media/Parameters/mediaError.md"
- ],
- "network.md": [
- "cordova/network/network.md",
- "cordova/network/network.isReachable.md",
- "cordova/network/NetworkStatus/NetworkStatus.md",
- "cordova/network/parameters/reachableCallback.md",
- "cordova/network/parameters/reachableHostname.md",
- "cordova/network/parameters/reachableOptions.md"
- ],
- "connection.md": [
- "cordova/connection/connection.md",
- "cordova/connection/connection.type.md"
- ],
- "notification.md": [
- "cordova/notification/notification.md",
- "cordova/notification/notification.alert.md",
- "cordova/notification/notification.confirm.md",
- "cordova/notification/notification.beep.md",
- "cordova/notification/notification.vibrate.md"
- ],
- "storage.md": [
- "cordova/storage/storage.md",
- "cordova/storage/storage.opendatabase.md",
- "cordova/storage/parameters/name.md",
- "cordova/storage/parameters/version.md",
- "cordova/storage/parameters/display_name.md",
- "cordova/storage/parameters/size.md",
- "cordova/storage/database/database.md",
- "cordova/storage/sqltransaction/sqltransaction.md",
- "cordova/storage/sqlresultset/sqlresultset.md",
- "cordova/storage/sqlresultsetlist/sqlresultsetlist.md",
- "cordova/storage/sqlerror/sqlerror.md",
- "cordova/storage/localstorage/localstorage.md"
- ]
- }
-}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/accelerometer/acceleration/acceleration.md b/docs/en/1.7.0rc1/cordova/accelerometer/acceleration/acceleration.md
deleted file mode 100644
index 69cef81..0000000
--- a/docs/en/1.7.0rc1/cordova/accelerometer/acceleration/acceleration.md
+++ /dev/null
@@ -1,104 +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.
----
-
-Acceleration
-============
-
-Contains `Accelerometer` data captured at a specific point in time.
-
-Properties
-----------
-
-- __x:__ Amount of acceleration on the x-axis. (in m/s^2) (`Number`)
-- __y:__ Amount of acceleration on the y-axis. (in m/s^2) (`Number`)
-- __z:__ Amount of acceleration on the z-axis. (in m/s^2) (`Number`)
-- __timestamp:__ Creation timestamp in milliseconds. (`DOMTimeStamp`)
-
-Description
------------
-
-This object is created and populated by Cordova, and returned by an `Accelerometer` method. The x, y, z acceleration values include the effect of gravity (9.81 m/s^2), so at when a device is lying flat on a table facing up, the value returned should be x=0, y=0, z=9.81.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Windows Phone 7 (Mango)
-
-Quick Example
--------------
-
- function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
- 'Timestamp: ' + acceleration.timestamp + '\n');
- };
-
- function onError() {
- alert('onError!');
- };
-
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Acceleration Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
- }
-
- // onSuccess: Get a snapshot of the current acceleration
- //
- function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
- 'Timestamp: ' + acceleration.timestamp + '\n');
- }
-
- // onError: Failed to get the acceleration
- //
- function onError() {
- alert('onError!');
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>getCurrentAcceleration</p>
- </body>
- </html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.clearWatch.md b/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.clearWatch.md
deleted file mode 100644
index 1ddec77..0000000
--- a/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.clearWatch.md
+++ /dev/null
@@ -1,111 +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.
----
-
-accelerometer.clearWatch
-========================
-
-Stop watching the `Acceleration` referenced by the watch ID parameter.
-
- navigator.accelerometer.clearWatch(watchID);
-
-- __watchID__: The ID returned by `accelerometer.watchAcceleration`.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-- Windows Phone 7 (Mango)
-
-Quick Example
--------------
-
- var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
-
- // ... later on ...
-
- navigator.accelerometer.clearWatch(watchID);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Acceleration Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // The watch id references the current `watchAcceleration`
- var watchID = null;
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- startWatch();
- }
-
- // Start watching the acceleration
- //
- function startWatch() {
-
- // Update acceleration every 3 seconds
- var options = { frequency: 3000 };
-
- watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
- }
-
- // Stop watching the acceleration
- //
- function stopWatch() {
- if (watchID) {
- navigator.accelerometer.clearWatch(watchID);
- watchID = null;
- }
- }
-
- // onSuccess: Get a snapshot of the current acceleration
- //
- function onSuccess(acceleration) {
- var element = document.getElementById('accelerometer');
- element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
- 'Acceleration Y: ' + acceleration.y + '<br />' +
- 'Acceleration Z: ' + acceleration.z + '<br />' +
- 'Timestamp: ' + acceleration.timestamp + '<br />';
- }
-
- // onError: Failed to get the acceleration
- //
- function onError() {
- alert('onError!');
- }
-
- </script>
- </head>
- <body>
- <div id="accelerometer">Waiting for accelerometer...</div>
- <button onclick="stopWatch();">Stop Watching</button>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
deleted file mode 100644
index c7f8aa5..0000000
--- a/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ /dev/null
@@ -1,107 +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.
----
-
-accelerometer.getCurrentAcceleration
-====================================
-
-Get the current acceleration along the x, y, and z axis.
-
- navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError);
-
-Description
------------
-
-The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current device orientation. The accelerometer can detect 3D movement along the x, y, and z axis.
-
-The acceleration is returned using the `accelerometerSuccess` callback function.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-- Windows Phone 7 (Mango)
-
-Quick Example
--------------
-
- function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
- 'Timestamp: ' + acceleration.timestamp + '\n');
- };
-
- function onError() {
- alert('onError!');
- };
-
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Acceleration Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
- }
-
- // onSuccess: Get a snapshot of the current acceleration
- //
- function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
- 'Timestamp: ' + acceleration.timestamp + '\n');
- }
-
- // onError: Failed to get the acceleration
- //
- function onError() {
- alert('onError!');
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>getCurrentAcceleration</p>
- </body>
- </html>
-
-iPhone Quirks
--------------
-
-- iPhone doesn't have the concept of getting the current acceleration at any given point.
-- You must watch the acceleration and capture the data at given time intervals.
-- Thus, the `getCurrentAcceleration` function will give you the last value reported from a Cordova `watchAccelerometer` call.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.md b/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.md
deleted file mode 100644
index b84eeb9..0000000
--- a/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.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.
----
-
-Accelerometer
-=============
-
-> Captures device motion in the x, y, and z direction.
-
-Methods
--------
-
-- accelerometer.getCurrentAcceleration
-- accelerometer.watchAcceleration
-- accelerometer.clearWatch
-
-Arguments
----------
-
-- accelerometerSuccess
-- accelerometerError
-- accelerometerOptions
-
-Objects (Read-Only)
--------------------
-
-- Acceleration
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.watchAcceleration.md b/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.watchAcceleration.md
deleted file mode 100644
index 18ef6e8..0000000
--- a/docs/en/1.7.0rc1/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ /dev/null
@@ -1,136 +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.
----
-
-accelerometer.watchAcceleration
-===============================
-
-At a regular interval, get the acceleration along the x, y, and z axis.
-
- var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
- accelerometerError,
- [accelerometerOptions]);
-
-Description
------------
-
-The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current position. The accelerometer can detect 3D movement along the x, y, and z axis.
-
-The `accelerometer.watchAcceleration` gets the device's current acceleration at a regular interval. Each time the `Acceleration` is retrieved, the `accelerometerSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `acceleratorOptions` object.
-
-The returned watch ID references references the accelerometer watch interval. The watch ID can be used with `accelerometer.clearWatch` to stop watching the accelerometer.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-- Windows Phone 7 (Mango)
-
-
-Quick Example
--------------
-
- function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
- 'Timestamp: ' + acceleration.timestamp + '\n');
- };
-
- function onError() {
- alert('onError!');
- };
-
- var options = { frequency: 3000 }; // Update every 3 seconds
-
- var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Acceleration Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // The watch id references the current `watchAcceleration`
- var watchID = null;
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- startWatch();
- }
-
- // Start watching the acceleration
- //
- function startWatch() {
-
- // Update acceleration every 3 seconds
- var options = { frequency: 3000 };
-
- watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
- }
-
- // Stop watching the acceleration
- //
- function stopWatch() {
- if (watchID) {
- navigator.accelerometer.clearWatch(watchID);
- watchID = null;
- }
- }
-
- // onSuccess: Get a snapshot of the current acceleration
- //
- function onSuccess(acceleration) {
- var element = document.getElementById('accelerometer');
- element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
- 'Acceleration Y: ' + acceleration.y + '<br />' +
- 'Acceleration Z: ' + acceleration.z + '<br />' +
- 'Timestamp: ' + acceleration.timestamp + '<br />';
- }
-
- // onError: Failed to get the acceleration
- //
- function onError() {
- alert('onError!');
- }
-
- </script>
- </head>
- <body>
- <div id="accelerometer">Waiting for accelerometer...</div>
- </body>
- </html>
-
- iPhone Quirks
--------------
-
-- At the interval requested, Cordova will call the success callback function and pass the accelerometer results.
-- However, in requests to the device Cordova restricts the interval to minimum of every 40ms and a maximum of every 1000ms.
- - For example, if you request an interval of 3 seconds (3000ms), Cordova will request an interval of 1 second from the device but invoke the success callback at the requested interval of 3 seconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/accelerometer/parameters/accelerometerError.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/accelerometer/parameters/accelerometerError.md b/docs/en/1.7.0rc1/cordova/accelerometer/parameters/accelerometerError.md
deleted file mode 100644
index c908c16..0000000
--- a/docs/en/1.7.0rc1/cordova/accelerometer/parameters/accelerometerError.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.
----
-
-accelerometerError
-==================
-
-onError callback function for acceleration functions.
-
- function() {
- // Handle the error
- }
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/accelerometer/parameters/accelerometerOptions.md b/docs/en/1.7.0rc1/cordova/accelerometer/parameters/accelerometerOptions.md
deleted file mode 100644
index 197f416..0000000
--- a/docs/en/1.7.0rc1/cordova/accelerometer/parameters/accelerometerOptions.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.
----
-
-accelerometerOptions
-====================
-
-An optional parameter to customize the retrieval of the accelerometer.
-
-Options
--------
-
-- __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/accelerometer/parameters/accelerometerSuccess.md b/docs/en/1.7.0rc1/cordova/accelerometer/parameters/accelerometerSuccess.md
deleted file mode 100644
index 277fca8..0000000
--- a/docs/en/1.7.0rc1/cordova/accelerometer/parameters/accelerometerSuccess.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.
----
-
-accelerometerSuccess
-====================
-
-onSuccess callback function that provides the Acceleration information.
-
- function(acceleration) {
- // Do something
- }
-
-Parameters
-----------
-
-- __acceleration:__ The acceleration at a single moment in time. (Acceleration)
-
-Example
--------
-
- function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
- 'Timestamp: ' + acceleration.timestamp + '\n');
- };
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/camera/camera.getPicture.md b/docs/en/1.7.0rc1/cordova/camera/camera.getPicture.md
deleted file mode 100644
index 90ef751..0000000
--- a/docs/en/1.7.0rc1/cordova/camera/camera.getPicture.md
+++ /dev/null
@@ -1,202 +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.
----
-
-camera.getPicture
-=================
-
-Takes a photo using the camera or retrieves a photo from the device's album. The image is returned as a base64 encoded `String` or as the URI of an image file.
-
- navigator.camera.getPicture( cameraSuccess, cameraError, [ cameraOptions ] );
-
-Description
------------
-
-Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `Camera.sourceType = Camera.PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your application is restored.
-
-If `Camera.sourceType = Camera.PictureSourceType.PHOTOLIBRARY` or `Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a photo chooser dialog is shown, from which a photo from the album can be selected.
-
-The return value will be sent to the `cameraSuccess` function, in one of the following formats, depending on the `cameraOptions` you specify:
-
-- A `String` containing the Base64 encoded photo image.
-- A `String` representing the image file location on local storage (default).
-
-You can do whatever you want with the encoded image or URI, for example:
-
-- Render the image in an `<img>` tag _(see example below)_
-- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc)
-- Post the data to a remote server
-
-Note: The image quality of pictures taken using the camera on newer devices is quite good, and images from the Photo Album will not be downscaled to a lower quality, even if a quality parameter is specified. _Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800)._ Therefore, using FILE_URI as the 'Camera.destinationType' is highly recommended.
-
-Supported Platforms
--------------------
-
-- Android
-- Blackberry WebWorks (OS 5.0 and higher)
-- iPhone
-- Windows Phone 7 ( Mango )
-
-
-Windows Phone 7 Quirks
-----------------------
-
-Invoking the native camera application while your device is connected
-via Zune will not work, and the error callback will be triggered.
-
-
-Quick Example
--------------
-
-Take photo and retrieve Base64-encoded image:
-
- navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: Camera.DestinationType.DATA_URL
- });
-
- function onSuccess(imageData) {
- var image = document.getElementById('myImage');
- image.src = "data:image/jpeg;base64," + imageData;
- }
-
- function onFail(message) {
- alert('Failed because: ' + message);
- }
-
-Take photo and retrieve image file location:
-
- navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: Camera.DestinationType.FILE_URI });
-
- function onSuccess(imageURI) {
- var image = document.getElementById('myImage');
- image.src = imageURI;
- }
-
- function onFail(message) {
- alert('Failed because: ' + message);
- }
-
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Capture Photo</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- var pictureSource; // picture source
- var destinationType; // sets the format of returned value
-
- // Wait for Cordova to connect with the device
- //
- document.addEventListener("deviceready",onDeviceReady,false);
-
- // Cordova is ready to be used!
- //
- function onDeviceReady() {
- pictureSource=navigator.camera.PictureSourceType;
- destinationType=navigator.camera.DestinationType;
- }
-
- // Called when a photo is successfully retrieved
- //
- function onPhotoDataSuccess(imageData) {
- // Uncomment to view the base64 encoded image data
- // console.log(imageData);
-
- // Get image handle
- //
- var smallImage = document.getElementById('smallImage');
-
- // Unhide image elements
- //
- smallImage.style.display = 'block';
-
- // Show the captured photo
- // The inline CSS rules are used to resize the image
- //
- smallImage.src = "data:image/jpeg;base64," + imageData;
- }
-
- // Called when a photo is successfully retrieved
- //
- function onPhotoURISuccess(imageURI) {
- // Uncomment to view the image file URI
- // console.log(imageURI);
-
- // Get image handle
- //
- var largeImage = document.getElementById('largeImage');
-
- // Unhide image elements
- //
- largeImage.style.display = 'block';
-
- // Show the captured photo
- // The inline CSS rules are used to resize the image
- //
- largeImage.src = imageURI;
- }
-
- // A button will call this function
- //
- function capturePhoto() {
- // Take picture using device camera and retrieve image as base64-encoded string
- navigator.camera.getPicture(onPhotoDataSuccess, onFail, { quality: 50,
- destinationType: destinationType.DATA_URL });
- }
-
- // A button will call this function
- //
- function capturePhotoEdit() {
- // Take picture using device camera, allow edit, and retrieve image as base64-encoded string
- navigator.camera.getPicture(onPhotoDataSuccess, onFail, { quality: 20, allowEdit: true,
- destinationType: destinationType.DATA_URL });
- }
-
- // A button will call this function
- //
- function getPhoto(source) {
- // Retrieve image file location from specified source
- navigator.camera.getPicture(onPhotoURISuccess, onFail, { quality: 50,
- destinationType: destinationType.FILE_URI,
- sourceType: source });
- }
-
- // Called if something bad happens.
- //
- function onFail(message) {
- alert('Failed because: ' + message);
- }
-
- </script>
- </head>
- <body>
- <button onclick="capturePhoto();">Capture Photo</button> <br>
- <button onclick="capturePhotoEdit();">Capture Editable Photo</button> <br>
- <button onclick="getPhoto(pictureSource.PHOTOLIBRARY);">From Photo Library</button><br>
- <button onclick="getPhoto(pictureSource.SAVEDPHOTOALBUM);">From Photo Album</button><br>
- <img style="display:none;width:60px;height:60px;" id="smallImage" src="" />
- <img style="display:none;" id="largeImage" src="" />
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/camera/camera.md b/docs/en/1.7.0rc1/cordova/camera/camera.md
deleted file mode 100644
index d23563b..0000000
--- a/docs/en/1.7.0rc1/cordova/camera/camera.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.
----
-
-Camera
-======
-
-> The `camera` object provides access to the device's default camera application.
-
-Methods
--------
-
-- camera.getPicture
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/camera/parameter/cameraError.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/camera/parameter/cameraError.md b/docs/en/1.7.0rc1/cordova/camera/parameter/cameraError.md
deleted file mode 100644
index 7ee091b..0000000
--- a/docs/en/1.7.0rc1/cordova/camera/parameter/cameraError.md
+++ /dev/null
@@ -1,32 +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.
----
-
-cameraError
-===========
-
-onError callback function that provides an error message.
-
- function(message) {
- // Show a helpful message
- }
-
-Parameters
-----------
-
-- __message:__ The message is provided by the device's native code. (`String`)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/camera/parameter/cameraOptions.md b/docs/en/1.7.0rc1/cordova/camera/parameter/cameraOptions.md
deleted file mode 100644
index dc46d1d..0000000
--- a/docs/en/1.7.0rc1/cordova/camera/parameter/cameraOptions.md
+++ /dev/null
@@ -1,119 +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.
----
-
-cameraOptions
-=============
-
-Optional parameters to customize the camera settings.
-
- { quality : 75,
- destinationType : Camera.DestinationType.DATA_URL,
- sourceType : Camera.PictureSourceType.CAMERA,
- allowEdit : true,
- encodingType: Camera.EncodingType.JPEG,
- targetWidth: 100,
- targetHeight: 100 };
-
-Options
--------
-
-- __quality:__ Quality of saved image. Range is [0, 100]. (`Number`)
-
-- __destinationType:__ Choose the format of the return value. Defined in navigator.camera.DestinationType (`Number`)
-
- Camera.DestinationType = {
- DATA_URL : 0, // Return image as base64 encoded string
- FILE_URI : 1 // Return image file URI
- };
-
-- __sourceType:__ Set the source of the picture. Defined in nagivator.camera.PictureSourceType (`Number`)
-
- Camera.PictureSourceType = {
- PHOTOLIBRARY : 0,
- CAMERA : 1,
- SAVEDPHOTOALBUM : 2
- };
-
-- __allowEdit:__ Allow simple editing of image before selection. (`Boolean`)
-
-- __encodingType:__ Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (`Number`)
-
- Camera.EncodingType = {
- JPEG : 0, // Return JPEG encoded image
- PNG : 1 // Return PNG encoded image
- };
-
-- __targetWidth:__ Width in pixels to scale image. Must be used with targetHeight. Aspect ratio is maintained. (`Number`)
-- __targetHeight:__ Height in pixels to scale image. Must be used with targetWidth. Aspect ratio is maintained. (`Number`)
-
-- __mediaType:__ Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.MediaType (`Number`)
-
- Camera.MediaType = {
- PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
- VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI
- ALLMEDIA : 2 // allow selection from all media types
-};
-
-- __correctOrientation:__ Rotate the image to correct for the orientation of the device during capture. (`Boolean`)
-- __saveToPhotoAlbum:__ Save the image to the photo album on the device after capture. (`Boolean`)
-
-Android Quirks
---------------
-
-- Ignores the `allowEdit` parameter.
-- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
-- Camera.EncodingType is not supported.
-- Ignores the `correctOrientation` parameter.
-- Ignores the `saveToPhotoAlbum` parameter.
-
-BlackBerry Quirks
------------------
-
-- Ignores the `quality` parameter.
-- Ignores the `sourceType` parameter.
-- Ignores the `allowEdit` parameter.
-- Application must have key injection permissions to close native Camera application after photo is taken.
-- Using Large image sizes may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800).
-- Camera.MediaType is not supported.
-- Ignores the `correctOrientation` parameter.
-- Ignores the `saveToPhotoAlbum` parameter.
-
-Palm Quirks
------------
-
-- Ignores the `quality` parameter.
-- Ignores the `sourceType` parameter.
-- Ignores the `allowEdit` parameter.
-- Camera.MediaType is not supported.
-- Ignores the `correctOrientation` parameter.
-- Ignores the `saveToPhotoAlbum` parameter.
-
-iOS Quirks
---------------
-
-- Set `quality` below 50 to avoid memory error on some devices.
-- When `destinationType.FILE_URI` is used, photos are saved in the application's temporary directory.
-- The contents of the application's temporary directory is deleted when the application ends.
-
-Windows Phone 7 Quirks
---------------
-
-- Ignores the `allowEdit` parameter.
-- Ignores the `correctOrientation` parameter.
-- Ignores the `saveToPhotoAlbum` parameter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/camera/parameter/cameraSuccess.md b/docs/en/1.7.0rc1/cordova/camera/parameter/cameraSuccess.md
deleted file mode 100644
index 773fba4..0000000
--- a/docs/en/1.7.0rc1/cordova/camera/parameter/cameraSuccess.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.
----
-
-cameraSuccess
-=============
-
-onSuccess callback function that provides the image data.
-
- function(imageData) {
- // Do something with the image
- }
-
-Parameters
-----------
-
-- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `cameraOptions` used. (`String`)
-
-Example
--------
-
- // Show image
- //
- function cameraCallback(imageData) {
- var image = document.getElementById('myImage');
- image.src = "data:image/jpeg;base64," + imageData;
- }
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/compass/compass.clearWatch.md b/docs/en/1.7.0rc1/cordova/compass/compass.clearWatch.md
deleted file mode 100755
index 193e2cf..0000000
--- a/docs/en/1.7.0rc1/cordova/compass/compass.clearWatch.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.
----
-
-compass.clearWatch
-========================
-
-Stop watching the compass referenced by the watch ID parameter.
-
- navigator.compass.clearWatch(watchID);
-
-- __watchID__: The ID returned by `compass.watchHeading`.
-
-Supported Platforms
--------------------
-
-- Android
-- iPhone
-- Windows Phone 7 ( Mango ) if available in hardware
-
-Quick Example
--------------
-
- var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
-
- // ... later on ...
-
- navigator.compass.clearWatch(watchID);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Compass Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // The watch id references the current `watchHeading`
- var watchID = null;
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- startWatch();
- }
-
- // Start watching the compass
- //
- function startWatch() {
-
- // Update compass every 3 seconds
- var options = { frequency: 3000 };
-
- watchID = navigator.compass.watchHeading(onSuccess, onError, options);
- }
-
- // Stop watching the compass
- //
- function stopWatch() {
- if (watchID) {
- navigator.compass.clearWatch(watchID);
- watchID = null;
- }
- }
-
- // onSuccess: Get the current heading
- //
- function onSuccess(heading) {
- var element = document.getElementById('heading');
- element.innerHTML = 'Heading: ' + heading.magneticHeading;
- }
-
- // onError: Failed to get the heading
- //
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
- }
-
-
- </script>
- </head>
- <body>
- <div id="heading">Waiting for heading...</div>
- <button onclick="startWatch();">Start Watching</button>
- <button onclick="stopWatch();">Stop Watching</button>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/compass/compass.clearWatchFilter.md b/docs/en/1.7.0rc1/cordova/compass/compass.clearWatchFilter.md
deleted file mode 100644
index 8c92c03..0000000
--- a/docs/en/1.7.0rc1/cordova/compass/compass.clearWatchFilter.md
+++ /dev/null
@@ -1,23 +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.
----
-
-compass.clearWatchFilter
-========================
-
-No longer supported as of 1.6. See `compass.clearWatch`.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/compass/compass.getCurrentHeading.md b/docs/en/1.7.0rc1/cordova/compass/compass.getCurrentHeading.md
deleted file mode 100755
index d89cb24..0000000
--- a/docs/en/1.7.0rc1/cordova/compass/compass.getCurrentHeading.md
+++ /dev/null
@@ -1,94 +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.
----
-
-compass.getCurrentHeading
-=========================
-
-Get the current compass heading.
-
- navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);
-
-Description
------------
-
-The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
-
-The compass heading information is returned via a CompassHeading object using the `compassSuccess` callback function.
-
-Supported Platforms
--------------------
-
-- Android
-- iPhone
-- Windows Phone 7 ( Mango ) if available in hardware
-
-Quick Example
--------------
-
- function onSuccess(heading) {
- alert('Heading: ' + heading.magneticHeading);
- };
-
- function onError(error) {
- alert('CompassError: ' + error.code);
- };
-
- navigator.compass.getCurrentHeading(onSuccess, onError);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Compass Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- navigator.compass.getCurrentHeading(onSuccess, onError);
- }
-
- // onSuccess: Get the current heading
- //
- function onSuccess(heading) {
- alert('Heading: ' + heading.magneticHeading);
- }
-
- // onError: Failed to get the heading
- //
- function onError(compassError) {
- alert('Compass Error: ' + compassError.code);
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>getCurrentHeading</p>
- </body>
- </html>
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/compass/compass.md b/docs/en/1.7.0rc1/cordova/compass/compass.md
deleted file mode 100755
index fbd1d95..0000000
--- a/docs/en/1.7.0rc1/cordova/compass/compass.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.
----
-
-Compass
-=======
-
-> Obtains the direction that the device is pointing.
-
-Methods
--------
-
-- compass.getCurrentHeading
-- compass.watchHeading
-- compass.clearWatch
-- compass.watchHeadingFilter (obsolete)
-- compass.clearWatchFilter (obsolete)
-
-Arguments
----------
-
-- compassSuccess
-- compassError
-- compassOptions
-- compassHeading
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/compass/compass.watchHeading.md b/docs/en/1.7.0rc1/cordova/compass/compass.watchHeading.md
deleted file mode 100755
index 6c8150a..0000000
--- a/docs/en/1.7.0rc1/cordova/compass/compass.watchHeading.md
+++ /dev/null
@@ -1,130 +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.
----
-
-compass.watchHeading
-====================
-
-At a regular interval, get the compass heading in degrees.
-
- var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);
-
-Description
------------
-
-The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
-
-The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `compassOptions` object.
-
-The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatch` to stop watching the compass.
-
-Supported Platforms
--------------------
-
-- Android
-- iPhone
-- Windows Phone 7 ( Mango ) if available in hardware
-
-
-Quick Example
--------------
-
- function onSuccess(heading) {
- var element = document.getElementById('heading');
- element.innerHTML = 'Heading: ' + heading.magneticHeading;
- };
-
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
- };
-
- var options = { frequency: 3000 }; // Update every 3 seconds
-
- var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Compass Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // The watch id references the current `watchHeading`
- var watchID = null;
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- startWatch();
- }
-
- // Start watching the compass
- //
- function startWatch() {
-
- // Update compass every 3 seconds
- var options = { frequency: 3000 };
-
- watchID = navigator.compass.watchHeading(onSuccess, onError, options);
- }
-
- // Stop watching the compass
- //
- function stopWatch() {
- if (watchID) {
- navigator.compass.clearWatch(watchID);
- watchID = null;
- }
- }
-
- // onSuccess: Get the current heading
- //
- function onSuccess(heading) {
- var element = document.getElementById('heading');
- element.innerHTML = 'Heading: ' + heading.magneticHeading;
- }
-
- // onError: Failed to get the heading
- //
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
- }
-
- </script>
- </head>
- <body>
- <div id="heading">Waiting for heading...</div>
- <button onclick="startWatch();">Start Watching</button>
- <button onclick="stopWatch();">Stop Watching</button>
- </body>
- </html>
-
-iOS Quirks
---------------
-
-In iOS `compass.watchHeading` can also get the device's current heading when it changes by a specified number of degrees. Each time the heading changes by the specified number of degrees or more, the `headingSuccess` callback function is called. Specify the degrees of change via the `filter` parameter in the `compassOptions` object. Clear the watch as normal by passing the returned watch ID to `compass.clearWatch`. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.
-
-In iOS only one watchHeading can be in effect at one time. If a watchHeading via filter is in effect, calling getCurrentHeading or watchHeading will use the existing filter value for specifying heading changes. On iOS watching heading changes via a filter is more efficient than via time.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/compass/compass.watchHeadingFilter.md b/docs/en/1.7.0rc1/cordova/compass/compass.watchHeadingFilter.md
deleted file mode 100644
index 6a0283f..0000000
--- a/docs/en/1.7.0rc1/cordova/compass/compass.watchHeadingFilter.md
+++ /dev/null
@@ -1,23 +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.
----
-
-compass.watchHeadingFilter
-==========================
-
-No longer supported as of 1.6, see `compass.watchHeading` for equivalent functionality.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/compass/compassError/compassError.md b/docs/en/1.7.0rc1/cordova/compass/compassError/compassError.md
deleted file mode 100644
index 989b4dc..0000000
--- a/docs/en/1.7.0rc1/cordova/compass/compassError/compassError.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.
----
-
-CompassError
-==========
-
-A `CompassError` object is returned to the `compassError` callback function when an error occurs.
-
-Properties
-----------
-
-- __code:__ One of the predefined error codes listed below.
-
-Constants
----------
-- `CompassError.COMPASS_INTERNAL_ERR`
-- `CompassError.COMPASS_NOT_SUPPORTED`
-
-Description
------------
-
-The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs.
-
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/compass/parameters/compassError.md b/docs/en/1.7.0rc1/cordova/compass/parameters/compassError.md
deleted file mode 100755
index cf89324..0000000
--- a/docs/en/1.7.0rc1/cordova/compass/parameters/compassError.md
+++ /dev/null
@@ -1,30 +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.
----
-
-compassError
-==========
-
-onError callback function for compass functions.
-
-Example
--------
-
-function(CompassError) {
- // Handle the error
-}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/compass/parameters/compassHeading.md b/docs/en/1.7.0rc1/cordova/compass/parameters/compassHeading.md
deleted file mode 100644
index 935ea06..0000000
--- a/docs/en/1.7.0rc1/cordova/compass/parameters/compassHeading.md
+++ /dev/null
@@ -1,48 +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.
----
-
-compassHeading
-==========
-
-A `CompassHeading` object is returned to the `compassSuccess` callback function when an error occurs.
-
-Properties
-----------
-- __magneticHeading:__ The heading in degrees from 0 - 359.99 at a single moment in time. _(Number)_
-- __trueHeading:__ The heading relative to the geographic North Pole in degrees 0 - 359.99 at a single moment in time. A negative value indicates that the true heading could not be determined. _(Number)_
-- __headingAccuracy:__ The deviation in degrees between the reported heading and the true heading. _(Number)_
-- __timestamp:__ The time at which this heading was determined. _(milliseconds)_
-
-Description
------------
-
-The `CompassHeading` object is returned to the user through the `compassSuccess` callback function.
-
-Android Quirks
---------------
-- trueHeading is not supported. It will report the same value as magneticHeading
-- headingAccuracy will always be 0 as there is no difference between the magneticHeading and trueHeading on Android.
-
-iOS Quirks
-----------
-
-- trueHeading is only returned when location services are running via `navigator.geolocation.watchLocation()`
-- For iOS > 4 devices, if the device is rotated and the app supports that orientation, the heading values will be reported
-back with respect to the current orientation.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/compass/parameters/compassOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/compass/parameters/compassOptions.md b/docs/en/1.7.0rc1/cordova/compass/parameters/compassOptions.md
deleted file mode 100755
index f088766..0000000
--- a/docs/en/1.7.0rc1/cordova/compass/parameters/compassOptions.md
+++ /dev/null
@@ -1,38 +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.
----
-
-compassOptions
-==============
-
-An optional parameter to customize the retrieval of the compass.
-
-Options
--------
-
-- __frequency:__ How often to retrieve the compass heading in milliseconds. _(Number)_ (Default: 100)
-- __filter:__ The change in degrees required to initiate a watchHeading success callback. _(Number)_
-
-Android Quirks
-______________
-- filter is not supported.
-
-Windows Phone 7 Quirks
---------------
-
-- filter is not supported.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/compass/parameters/compassSuccess.md b/docs/en/1.7.0rc1/cordova/compass/parameters/compassSuccess.md
deleted file mode 100644
index 1b0fc9c..0000000
--- a/docs/en/1.7.0rc1/cordova/compass/parameters/compassSuccess.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.
----
-
-compassSuccess
-==============
-
-onSuccess callback function that provides the compass heading information via a compassHeading object.
-
- function(heading) {
- // Do something
- }
-
-Parameters
-----------
-
-
-- __heading:__ The heading information. _(compassHeading)_
-
-Example
--------
-
- function onSuccess(heading) {
- alert('Heading: ' + heading.magneticHeading);
- };
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/connection/connection.md b/docs/en/1.7.0rc1/cordova/connection/connection.md
deleted file mode 100644
index 507a854..0000000
--- a/docs/en/1.7.0rc1/cordova/connection/connection.md
+++ /dev/null
@@ -1,48 +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.
----
-
-Connection
-==========
-
-> The `connection` object gives access to the device's cellular and wifi connection information.
-
-This object is accessed under the navigator.network interface.
-
-Properties
-----------
-
-- connection.type
-
-Constants
----------
-
-- Connection.UNKNOWN
-- Connection.ETHERNET
-- Connection.WIFI
-- Connection.CELL_2G
-- Connection.CELL_3G
-- Connection.CELL_4G
-- Connection.NONE
-
-WP7 Quirk
----------
-
-- __type:__
-Windows Phone Emulator always reports navigator.network.connection.type is Connection.UNKNOWN
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.7.0rc1/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/docs/en/1.7.0rc1/cordova/connection/connection.type.md b/docs/en/1.7.0rc1/cordova/connection/connection.type.md
deleted file mode 100644
index 446d8f5..0000000
--- a/docs/en/1.7.0rc1/cordova/connection/connection.type.md
+++ /dev/null
@@ -1,101 +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.
----
-
-connection.type
-===================
-
-Checks the active network connection that is being used.
-
-Description
------------
-
-This property is a fast way to determine the device's network connection state, and type of connection.
-
-
-Supported Platforms
--------------------
-
-- iOS
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- Windows Phone 7 ( Mango )
-
-Quick Example
--------------
-
- function checkConnection() {
- var networkState = navigator.network.connection.type;
-
- var states = {};
- states[Connection.UNKNOWN] = 'Unknown connection';
- states[Connection.ETHERNET] = 'Ethernet connection';
- states[Connection.WIFI] = 'WiFi connection';
- states[Connection.CELL_2G] = 'Cell 2G connection';
- states[Connection.CELL_3G] = 'Cell 3G connection';
- states[Connection.CELL_4G] = 'Cell 4G connection';
- states[Connection.NONE] = 'No network connection';
-
- alert('Connection type: ' + states[networkState]);
- }
-
- checkConnection();
-
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>navigator.network.connection.type Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is loaded and it is now safe to make calls Cordova methods
- //
- function onDeviceReady() {
- checkConnection();
- }
-
- function checkConnection() {
- var networkState = navigator.network.connection.type;
-
- var states = {};
- states[Connection.UNKNOWN] = 'Unknown connection';
- states[Connection.ETHERNET] = 'Ethernet connection';
- states[Connection.WIFI] = 'WiFi connection';
- states[Connection.CELL_2G] = 'Cell 2G connection';
- states[Connection.CELL_3G] = 'Cell 3G connection';
- states[Connection.CELL_4G] = 'Cell 4G connection';
- states[Connection.NONE] = 'No network connection';
-
- alert('Connection type: ' + states[networkState]);
- }
-
- </script>
- </head>
- <body>
- <p>A dialog box will report the network state.</p>
- </body>
- </html>