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/23 00:43:56 UTC
svn commit: r1449255 [13/34] - in /cordova/site/public/docs: en/1.5.0/
en/1.5.0rc1/ en/1.6.0/ en/1.6.0rc1/ en/1.6.1/ en/1.7.0/ en/1.7.0rc1/
en/1.8.0/ en/1.8.0rc1/ en/1.8.1/ en/1.9.0/ en/1.9.0rc1/ en/2.0.0/
en/2.0.0rc1/ en/2.1.0/ en/2.1.0rc1/ en/2.1.0rc...
Added: cordova/site/public/docs/en/2.5.0rc1/cordova_compass_compass.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.5.0rc1/cordova_compass_compass.md.html?rev=1449255&view=auto
==============================================================================
--- cordova/site/public/docs/en/2.5.0rc1/cordova_compass_compass.md.html (added)
+++ cordova/site/public/docs/en/2.5.0rc1/cordova_compass_compass.md.html Fri Feb 22 23:42:47 2013
@@ -0,0 +1,721 @@
+<!DOCTYPE html>
+<!--
+ 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.
+--><html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
+ <div id="header">
+ <h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option selected value="2.5.0rc1">2.5.0rc1</option>
+<option value="2.4.0rc1">2.4.0rc1</option>
+<option value="2.4.0">2.4.0</option>
+<option value="2.3.0rc2">2.3.0rc2</option>
+<option value="2.3.0rc1">2.3.0rc1</option>
+<option value="2.3.0">2.3.0</option>
+<option value="2.2.0rc2">2.2.0rc2</option>
+<option value="2.2.0rc1">2.2.0rc1</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0rc2">2.1.0rc2</option>
+<option value="2.1.0rc1">2.1.0rc1</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0rc1">2.0.0rc1</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0rc1">1.9.0rc1</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.8.0rc1">1.8.0rc1</option>
+<option value="1.8.0">1.8.0</option>
+<option value="1.7.0rc1">1.7.0rc1</option>
+<option value="1.7.0">1.7.0</option>
+<option value="1.6.1">1.6.1</option>
+<option value="1.6.0rc1">1.6.0rc1</option>
+<option value="1.6.0">1.6.0</option>
+<option value="1.5.0rc1">1.5.0rc1</option>
+<option value="1.5.0">1.5.0</option>
+</optgroup>
+<optgroup label="Japanese" value="jp">
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.7.0">1.7.0</option>
+</optgroup>
+<optgroup label="Korean" value="kr"><option value="2.0.0">2.0.0</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>Compass</h1>
+ <small><select><option value="Compass">Compass</option>
+<option value="Compass_methods">Â Â Â Â Â Â - Methods</option>
+<option value="Compass_arguments">Â Â Â Â Â Â - Arguments</option>
+<option value="Compass_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="compass.getCurrentHeading">compass.getCurrentHeading</option>
+<option value="compass.getCurrentHeading_description">Â Â Â Â Â Â - Description</option>
+<option value="compass.getCurrentHeading_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="compass.getCurrentHeading_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="compass.getCurrentHeading_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="compass.watchHeading">compass.watchHeading</option>
+<option value="compass.watchHeading_description">Â Â Â Â Â Â - Description</option>
+<option value="compass.watchHeading_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="compass.watchHeading_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="compass.watchHeading_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="compass.watchHeading_ios_quirks">Â Â Â Â Â Â - iOS Quirks</option>
+<option value="compass.clearWatch">compass.clearWatch</option>
+<option value="compass.clearWatch_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="compass.clearWatch_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="compass.clearWatch_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="compass.watchHeadingFilter">compass.watchHeadingFilter</option>
+<option value="compass.clearWatchFilter">compass.clearWatchFilter</option>
+<option value="compassSuccess">compassSuccess</option>
+<option value="compassSuccess_parameters">Â Â Â Â Â Â - Parameters</option>
+<option value="compassSuccess_example">Â Â Â Â Â Â - Example</option>
+<option value="compassError">compassError</option>
+<option value="compassError_example">Â Â Â Â Â Â - Example</option>
+<option value="compassOptions">compassOptions</option>
+<option value="compassOptions_options">Â Â Â Â Â Â - Options</option>
+<option value="compassOptions_windows_phone_7_and_8_quirks">Â Â Â Â Â Â - Windows Phone 7 and 8 Quirks</option>
+<option value="compassOptions_bada_quirks">Â Â Â Â Â Â - Bada Quirks</option>
+<option value="compassOptions_tizen_quirks">Â Â Â Â Â Â - Tizen Quirks</option>
+<option value="compassHeading">compassHeading</option>
+<option value="compassHeading_properties">Â Â Â Â Â Â - Properties</option>
+<option value="compassHeading_description">Â Â Â Â Â Â - Description</option>
+<option value="compassHeading_android_quirks">Â Â Â Â Â Â - Android Quirks</option>
+<option value="compassHeading_ios_quirks">Â Â Â Â Â Â - iOS Quirks</option>
+<option value="CompassError">CompassError</option>
+<option value="CompassError_properties">Â Â Â Â Â Â - Properties</option>
+<option value="CompassError_constants">Â Â Â Â Â Â - Constants</option>
+<option value="CompassError_description">Â Â Â Â Â Â - Description</option></select></small>
+ </div>
+
+ <div id="sidebar">
+ <div class="vertical_divider"></div>
+ <h1>API Reference</h1>
+<ul>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+<h1>Guides</h1>
+<ul>
+<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
+<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
+<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
+<li><a href="guide_project-settings_index.md.html#Project%20Settings">Project Settings</a></li>
+<li><a href="guide_plugin-development_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
+<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="Compass">Compass</a></h1>
+
+<blockquote>
+ <p>Obtains the direction that the device is pointing.</p>
+</blockquote>
+
+<h2>
+<a name="Compass_methods">Methods</a>
+</h2>
+
+<ul>
+<li><a href="cordova_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a></li>
+<li><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></li>
+<li><a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a></li>
+<li>
+<a href="cordova_compass_compass.md.html#compass.watchHeadingFilter">compass.watchHeadingFilter</a> (obsolete)</li>
+<li>
+<a href="cordova_compass_compass.md.html#compass.clearWatchFilter">compass.clearWatchFilter</a> (obsolete)</li>
+</ul>
+<h2>
+<a name="Compass_arguments">Arguments</a>
+</h2>
+
+<ul>
+<li><a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a></li>
+<li><a href="cordova_compass_compass.md.html#compassError">compassError</a></li>
+<li><a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a></li>
+<li><a href="cordova_compass_compass.md.html#compassHeading">compassHeading</a></li>
+</ul>
+<h2>
+<a name="Compass_permissions">Permissions</a>
+</h2>
+
+<h3>Android</h3>
+
+<h4>app/res/xml/config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_compass_compass.md.html#Compass">Compass</a>" value="org.apache.cordova.CompassListener" />
+</code></pre>
+
+<h3>Bada</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>BlackBerry WebWorks</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>iOS</h3>
+
+<h4>config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_compass_compass.md.html#Compass">Compass</a>" value="CDVLocation" />
+</code></pre>
+
+<h3>webOS</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>Windows Phone</h3>
+
+<h4>Properties/WPAppManifest.xml</h4>
+
+<pre class="prettyprint"><code><Capabilities>
+ <Capability Name="ID_CAP_SENSORS" />
+</Capabilities>
+</code></pre>
+
+<p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx">Application Manifest for Windows Phone</a></p>
+
+<h3>Tizen</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<hr>
+<h1><a name="compass.getCurrentHeading">compass.getCurrentHeading</a></h1>
+
+<p>Get the current compass heading.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a>(<a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a>, <a href="cordova_compass_compass.md.html#compassError">compassError</a>, <a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a>);
+</code></pre>
+
+<h2>
+<a name="compass.getCurrentHeading_description">Description</a>
+</h2>
+
+<p>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.</p>
+
+<p>The compass heading information is returned via a CompassHeading object using the <code><a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a></code> callback function.</p>
+
+<h2>
+<a name="compass.getCurrentHeading_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>iPhone</li>
+<li>Windows Phone 7 and 8 ( if available in hardware )</li>
+<li>Bada 1.2 & 2.x</li>
+<li>webOS</li>
+<li>Tizen</li>
+<li>Windows 8</li>
+</ul>
+<h2>
+<a name="compass.getCurrentHeading_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function onSuccess(heading) {
+ alert('Heading: ' + heading.magneticHeading);
+};
+
+function onError(error) {
+ alert('<a href="cordova_compass_compass.md.html#CompassError">CompassError</a>: ' + error.code);
+};
+
+navigator.<a href="cordova_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a>(onSuccess, onError);
+</code></pre>
+
+<h2>
+<a name="compass.getCurrentHeading_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_compass_compass.md.html#Compass">Compass</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ navigator.<a href="cordova_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a>(onSuccess, onError);
+ }
+
+ // onSuccess: Get the current heading
+ //
+ function onSuccess(heading) {
+ alert('Heading: ' + heading.magneticHeading);
+ }
+
+ // onError: Failed to get the heading
+ //
+ function onError(<a href="cordova_compass_compass.md.html#compassError">compassError</a>) {
+ alert('<a href="cordova_compass_compass.md.html#Compass">Compass</a> Error: ' + <a href="cordova_compass_compass.md.html#compassError">compassError</a>.code);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>getCurrentHeading</p>
+ </body>
+</html>
+</code></pre>
+
+<hr>
+<h1><a name="compass.watchHeading">compass.watchHeading</a></h1>
+
+<p>At a regular interval, get the compass heading in degrees.</p>
+
+<pre class="prettyprint"><code>var watchID = navigator.<a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a>(<a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a>, <a href="cordova_compass_compass.md.html#compassError">compassError</a>, [<a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a>]);
+</code></pre>
+
+<h2>
+<a name="compass.watchHeading_description">Description</a>
+</h2>
+
+<p>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.</p>
+
+<p>The <code><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></code> gets the device's current heading at a regular interval. Each time the heading is retrieved, the <code>headingSuccess</code> callback function is executed. Specify the interval in milliseconds via the <code>frequency</code> parameter in the <code><a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a></code> object.</p>
+
+<p>The returned watch ID references references the compass watch interval. The watch ID can be used with <code><a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a></code> to stop watching the compass.</p>
+
+<h2>
+<a name="compass.watchHeading_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>iPhone</li>
+<li>Windows Phone 7 and 8 ( if available in hardware )</li>
+<li>Bada 1.2 & 2.x</li>
+<li>webOS</li>
+<li>Tizen</li>
+<li>Windows 8</li>
+</ul>
+<h2>
+<a name="compass.watchHeading_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function onSuccess(heading) {
+ var element = document.getElementById('heading');
+ element.innerHTML = 'Heading: ' + heading.magneticHeading;
+};
+
+function onError(<a href="cordova_compass_compass.md.html#compassError">compassError</a>) {
+ alert('<a href="cordova_compass_compass.md.html#Compass">Compass</a> error: ' + <a href="cordova_compass_compass.md.html#compassError">compassError</a>.code);
+};
+
+var options = { frequency: 3000 }; // Update every 3 seconds
+
+var watchID = navigator.<a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a>(onSuccess, onError, options);
+</code></pre>
+
+<h2>
+<a name="compass.watchHeading_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_compass_compass.md.html#Compass">Compass</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.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.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", 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.<a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a>(onSuccess, onError, options);
+ }
+
+ // Stop watching the compass
+ //
+ function stopWatch() {
+ if (watchID) {
+ navigator.<a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a>(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(<a href="cordova_compass_compass.md.html#compassError">compassError</a>) {
+ alert('<a href="cordova_compass_compass.md.html#Compass">Compass</a> error: ' + <a href="cordova_compass_compass.md.html#compassError">compassError</a>.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>
+</code></pre>
+
+<h2>
+<a name="compass.watchHeading_ios_quirks">iOS Quirks</a>
+</h2>
+
+<p>In iOS <code><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></code> 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 <code>headingSuccess</code> callback function is called. Specify the degrees of change via the <code>filter</code> parameter in the <code><a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a></code> object. Clear the watch as normal by passing the returned watch ID to <code><a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a></code>. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.</p>
+
+<p>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.</p>
+
+<hr>
+<h1><a name="compass.clearWatch">compass.clearWatch</a></h1>
+
+<p>Stop watching the compass referenced by the watch ID parameter.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a>(watchID);
+</code></pre>
+
+<ul>
+<li>
+<strong>watchID</strong>: The ID returned by <code><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></code>.</li>
+</ul>
+<h2>
+<a name="compass.clearWatch_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>iPhone</li>
+<li>Windows Phone 7 and 8 ( if available in hardware )</li>
+<li>Bada 1.2 & 2.x</li>
+<li>webOS</li>
+<li>Tizen</li>
+<li>Windows 8</li>
+</ul>
+<h2>
+<a name="compass.clearWatch_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var watchID = navigator.<a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a>(onSuccess, onError, options);
+
+// ... later on ...
+
+navigator.<a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a>(watchID);
+</code></pre>
+
+<h2>
+<a name="compass.clearWatch_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_compass_compass.md.html#Compass">Compass</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.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.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", 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.<a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a>(onSuccess, onError, options);
+ }
+
+ // Stop watching the compass
+ //
+ function stopWatch() {
+ if (watchID) {
+ navigator.<a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a>(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(<a href="cordova_compass_compass.md.html#compassError">compassError</a>) {
+ alert('<a href="cordova_compass_compass.md.html#Compass">Compass</a> error: ' + <a href="cordova_compass_compass.md.html#compassError">compassError</a>.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>
+</code></pre>
+
+<hr>
+<h1><a name="compass.watchHeadingFilter">compass.watchHeadingFilter</a></h1>
+
+<p>No longer supported as of 1.6, see <code><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></code> for equivalent functionality.</p>
+
+<hr>
+<h1><a name="compass.clearWatchFilter">compass.clearWatchFilter</a></h1>
+
+<p>No longer supported as of 1.6. See <code><a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a></code>.</p>
+
+<hr>
+<h1><a name="compassSuccess">compassSuccess</a></h1>
+
+<p>onSuccess callback function that provides the compass heading information via a <a href="cordova_compass_compass.md.html#compassHeading">compassHeading</a> object.</p>
+
+<pre class="prettyprint"><code>function(heading) {
+ // Do something
+}
+</code></pre>
+
+<h2>
+<a name="compassSuccess_parameters">Parameters</a>
+</h2>
+
+<ul>
+<li>
+<strong>heading:</strong> The heading information. <em>(<a href="cordova_compass_compass.md.html#compassHeading">compassHeading</a>)</em>
+</li>
+</ul>
+<h2>
+<a name="compassSuccess_example">Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function onSuccess(heading) {
+ alert('Heading: ' + heading.magneticHeading);
+};
+</code></pre>
+
+<hr>
+<h1><a name="compassError">compassError</a></h1>
+
+<p>onError callback function for compass functions. </p>
+
+<h2>
+<a name="compassError_example">Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function(<a href="cordova_compass_compass.md.html#CompassError">CompassError</a>) {
+ // Handle the error
+}
+</code></pre>
+
+<hr>
+<h1><a name="compassOptions">compassOptions</a></h1>
+
+<p>An optional parameter to customize the retrieval of the compass.</p>
+
+<h2>
+<a name="compassOptions_options">Options</a>
+</h2>
+
+<ul>
+<li>
+<strong>frequency:</strong> How often to retrieve the compass heading in milliseconds. <em>(Number)</em> (Default: 100)</li>
+<li>
+<strong>filter:</strong> The change in degrees required to initiate a watchHeading success callback. <em>(Number)</em>
+</li>
+</ul>
+<p>Android Quirks</p>
+
+<hr>
+<ul>
+<li>filter is not supported.</li>
+</ul>
+<h2>
+<a name="compassOptions_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
+</h2>
+
+<ul>
+<li>filter is not supported.</li>
+</ul>
+<h2>
+<a name="compassOptions_bada_quirks">Bada Quirks</a>
+</h2>
+
+<ul>
+<li>filter is not supported.</li>
+</ul>
+<h2>
+<a name="compassOptions_tizen_quirks">Tizen Quirks</a>
+</h2>
+
+<ul>
+<li>filter is not supported.</li>
+</ul>
+<hr>
+<h1><a name="compassHeading">compassHeading</a></h1>
+
+<p>A <code>CompassHeading</code> object is returned to the <code><a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a></code> callback function when an error occurs.</p>
+
+<h2>
+<a name="compassHeading_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>magneticHeading:</strong> The heading in degrees from 0 - 359.99 at a single moment in time. <em>(Number)</em>
+</li>
+<li>
+<strong>trueHeading:</strong> 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. <em>(Number)</em>
+</li>
+<li>
+<strong>headingAccuracy:</strong> The deviation in degrees between the reported heading and the true heading. <em>(Number)</em>
+</li>
+<li>
+<strong>timestamp:</strong> The time at which this heading was determined. <em>(milliseconds)</em>
+</li>
+</ul>
+<h2>
+<a name="compassHeading_description">Description</a>
+</h2>
+
+<p>The <code>CompassHeading</code> object is returned to the user through the <code><a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a></code> callback function.</p>
+
+<h2>
+<a name="compassHeading_android_quirks">Android Quirks</a>
+</h2>
+
+<ul>
+<li>trueHeading is not supported. It will report the same value as magneticHeading</li>
+<li>headingAccuracy will always be 0 as there is no difference between the magneticHeading and trueHeading on Android.</li>
+</ul>
+<h2>
+<a name="compassHeading_ios_quirks">iOS Quirks</a>
+</h2>
+
+<ul>
+<li>trueHeading is only returned when location services are running via <code>navigator.geolocation.watchLocation()</code>
+</li>
+<li>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.</li>
+</ul>
+<hr>
+<h1><a name="CompassError">CompassError</a></h1>
+
+<p>A <code><a href="cordova_compass_compass.md.html#CompassError">CompassError</a></code> object is returned to the <code><a href="cordova_compass_compass.md.html#compassError">compassError</a></code> callback function when an error occurs.</p>
+
+<h2>
+<a name="CompassError_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>code:</strong> One of the predefined error codes listed below.</li>
+</ul>
+<h2>
+<a name="CompassError_constants">Constants</a>
+</h2>
+
+<ul>
+<li>
+<code><a href="cordova_compass_compass.md.html#CompassError">CompassError</a>.COMPASS_INTERNAL_ERR</code> </li>
+<li><code><a href="cordova_compass_compass.md.html#CompassError">CompassError</a>.COMPASS_NOT_SUPPORTED</code></li>
+</ul>
+<h2>
+<a name="CompassError_description">Description</a>
+</h2>
+
+<p>The <code><a href="cordova_compass_compass.md.html#CompassError">CompassError</a></code> object is returned to the user through the <code><a href="cordova_compass_compass.md.html#compassError">compassError</a></code> callback function when an error occurs.</p>
+
+ </div>
+ </div>
+
+ <!-- Functionality and Syntax Highlighting -->
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
+</html>
Added: cordova/site/public/docs/en/2.5.0rc1/cordova_connection_connection.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.5.0rc1/cordova_connection_connection.md.html?rev=1449255&view=auto
==============================================================================
--- cordova/site/public/docs/en/2.5.0rc1/cordova_connection_connection.md.html (added)
+++ cordova/site/public/docs/en/2.5.0rc1/cordova_connection_connection.md.html Fri Feb 22 23:42:47 2013
@@ -0,0 +1,384 @@
+<!DOCTYPE html>
+<!--
+ 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.
+--><html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
+ <div id="header">
+ <h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option selected value="2.5.0rc1">2.5.0rc1</option>
+<option value="2.4.0rc1">2.4.0rc1</option>
+<option value="2.4.0">2.4.0</option>
+<option value="2.3.0rc2">2.3.0rc2</option>
+<option value="2.3.0rc1">2.3.0rc1</option>
+<option value="2.3.0">2.3.0</option>
+<option value="2.2.0rc2">2.2.0rc2</option>
+<option value="2.2.0rc1">2.2.0rc1</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0rc2">2.1.0rc2</option>
+<option value="2.1.0rc1">2.1.0rc1</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0rc1">2.0.0rc1</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0rc1">1.9.0rc1</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.8.0rc1">1.8.0rc1</option>
+<option value="1.8.0">1.8.0</option>
+<option value="1.7.0rc1">1.7.0rc1</option>
+<option value="1.7.0">1.7.0</option>
+<option value="1.6.1">1.6.1</option>
+<option value="1.6.0rc1">1.6.0rc1</option>
+<option value="1.6.0">1.6.0</option>
+<option value="1.5.0rc1">1.5.0rc1</option>
+<option value="1.5.0">1.5.0</option>
+</optgroup>
+<optgroup label="Japanese" value="jp">
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.7.0">1.7.0</option>
+</optgroup>
+<optgroup label="Korean" value="kr"><option value="2.0.0">2.0.0</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>Connection</h1>
+ <small><select><option value="Connection">Connection</option>
+<option value="Connection_properties">Â Â Â Â Â Â - Properties</option>
+<option value="Connection_constants">Â Â Â Â Â Â - Constants</option>
+<option value="Connection_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="connection.type">connection.type</option>
+<option value="connection.type_description">Â Â Â Â Â Â - Description</option>
+<option value="connection.type_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="connection.type_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="connection.type_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="connection.type_api_change">Â Â Â Â Â Â - API Change</option>
+<option value="connection.type_ios_quirks">Â Â Â Â Â Â - iOS Quirks</option>
+<option value="connection.type_bada_quirks">Â Â Â Â Â Â - Bada Quirks</option>
+<option value="connection.type_webos_quirks">Â Â Â Â Â Â - webOS Quirks</option>
+<option value="connection.type_windows_phone_quirks">Â Â Â Â Â Â - Windows Phone Quirks</option>
+<option value="connection.type_tizen_quirks">Â Â Â Â Â Â - Tizen Quirks</option></select></small>
+ </div>
+
+ <div id="sidebar">
+ <div class="vertical_divider"></div>
+ <h1>API Reference</h1>
+<ul>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+<h1>Guides</h1>
+<ul>
+<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
+<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
+<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
+<li><a href="guide_project-settings_index.md.html#Project%20Settings">Project Settings</a></li>
+<li><a href="guide_plugin-development_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
+<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="Connection">Connection</a></h1>
+
+<blockquote>
+ <p>The <code>connection</code> object gives access to the device's cellular and wifi connection information.</p>
+</blockquote>
+
+<p>This object is exposed as <code>navigator.connection</code>.</p>
+
+<h2>
+<a name="Connection_properties">Properties</a>
+</h2>
+
+<ul>
+<li><a href="cordova_connection_connection.md.html#connection.type">connection.type</a></li>
+</ul>
+<h2>
+<a name="Connection_constants">Constants</a>
+</h2>
+
+<ul>
+<li>
+<a href="cordova_connection_connection.md.html#Connection">Connection</a>.UNKNOWN</li>
+<li>
+<a href="cordova_connection_connection.md.html#Connection">Connection</a>.ETHERNET</li>
+<li>
+<a href="cordova_connection_connection.md.html#Connection">Connection</a>.WIFI</li>
+<li>
+<a href="cordova_connection_connection.md.html#Connection">Connection</a>.CELL_2G</li>
+<li>
+<a href="cordova_connection_connection.md.html#Connection">Connection</a>.CELL_3G</li>
+<li>
+<a href="cordova_connection_connection.md.html#Connection">Connection</a>.CELL_4G</li>
+<li>
+<a href="cordova_connection_connection.md.html#Connection">Connection</a>.NONE</li>
+</ul>
+<h2>
+<a name="Connection_permissions">Permissions</a>
+</h2>
+
+<h3>Android</h3>
+
+<h4>app/res/xml/config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="NetworkStatus" value="org.apache.cordova.NetworkManager" />
+</code></pre>
+
+<h4>app/AndroidManifest.xml</h4>
+
+<pre class="prettyprint"><code><uses-permission android:name="android.permission.INTERNET" />
+<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+<uses-permission android:name="android.permission.READ_PHONE_STATE" />
+</code></pre>
+
+<h3>Bada</h3>
+
+<pre class="prettyprint"><code><Privilege>
+ <Name>SYSTEM_SERVICE</Name>
+</Privilege>
+</code></pre>
+
+<h3>BlackBerry WebWorks</h3>
+
+<h4>www/plugins.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="Network Status" value="org.apache.cordova.network.Network" />
+</code></pre>
+
+<h3>iOS</h3>
+
+<h4>config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="NetworkStatus" value="CDVConnection" />
+</code></pre>
+
+<h3>webOS</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>Windows Phone</h3>
+
+<h4>Properties/WPAppManifest.xml</h4>
+
+<pre class="prettyprint"><code><Capabilities>
+ <Capability Name="ID_CAP_NETWORKING" />
+</Capabilities>
+</code></pre>
+
+<p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx">Application Manifest for Windows Phone</a></p>
+
+<h3>Tizen</h3>
+
+<h4>config.xml</h4>
+
+<pre class="prettyprint"><code><feature name="http://tizen.org/api/systeminfo" required="true"/>
+</code></pre>
+
+<p>Reference: <a class="external" href="https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures">Application Manifest for Tizen Web Application</a></p>
+
+<hr>
+<h1><a name="connection.type">connection.type</a></h1>
+
+<p>Checks the active network connection that is being used.</p>
+
+<h2>
+<a name="connection.type_description">Description</a>
+</h2>
+
+<p>This property is a fast way to determine the device's network connection state, and type of connection.</p>
+
+<h2>
+<a name="connection.type_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>iOS</li>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>Windows Phone 7 and 8</li>
+<li>Bada 2.x</li>
+<li>webOS</li>
+<li>Tizen</li>
+<li>Windows 8</li>
+</ul>
+<h2>
+<a name="connection.type_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function checkConnection() {
+ var networkState = navigator.<a href="cordova_connection_connection.md.html#connection.type">connection.type</a>;
+
+ var states = {};
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.UNKNOWN] = 'Unknown connection';
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.ETHERNET] = 'Ethernet connection';
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.WIFI] = 'WiFi connection';
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.CELL_2G] = 'Cell 2G connection';
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.CELL_3G] = 'Cell 3G connection';
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.CELL_4G] = 'Cell 4G connection';
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.NONE] = 'No network connection';
+
+ alert('<a href="cordova_connection_connection.md.html#Connection">Connection</a> type: ' + states[networkState]);
+}
+
+checkConnection();
+</code></pre>
+
+<h2>
+<a name="connection.type_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title>navigator.<a href="cordova_connection_connection.md.html#connection.type">connection.type</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is loaded and it is now safe to make calls Cordova methods
+ //
+ function onDeviceReady() {
+ checkConnection();
+ }
+
+ function checkConnection() {
+ var networkState = navigator.<a href="cordova_connection_connection.md.html#connection.type">connection.type</a>;
+
+ var states = {};
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.UNKNOWN] = 'Unknown connection';
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.ETHERNET] = 'Ethernet connection';
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.WIFI] = 'WiFi connection';
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.CELL_2G] = 'Cell 2G connection';
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.CELL_3G] = 'Cell 3G connection';
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.CELL_4G] = 'Cell 4G connection';
+ states[<a href="cordova_connection_connection.md.html#Connection">Connection</a>.NONE] = 'No network connection';
+
+ alert('<a href="cordova_connection_connection.md.html#Connection">Connection</a> type: ' + states[networkState]);
+ }
+
+ </script>
+ </head>
+ <body>
+ <p>A dialog box will report the network state.</p>
+ </body>
+</html>
+</code></pre>
+
+<h2>
+<a name="connection.type_api_change">API Change</a>
+</h2>
+
+<p>Before Cordova 2.3.0, the <a href="cordova_connection_connection.md.html#Connection">Connection</a> object existed at: <code>navigator.network.connection</code>.</p>
+
+<p>To match the spec, this was changed to <code>navigator.connection</code> in 2.3.0.</p>
+
+<p><code>navigator.network.connection</code> still exists, but is now deprecated and will be removed in a future release.</p>
+
+<h2>
+<a name="connection.type_ios_quirks">iOS Quirks</a>
+</h2>
+
+<ul>
+<li>iOS cannot detect the type of cellular network connection.
+<ul>
+<li>
+<code>navigator.<a href="cordova_connection_connection.md.html#connection.type">connection.type</a></code> is set to <code><a href="cordova_connection_connection.md.html#Connection">Connection</a>.CELL_2G</code> for all cellular data.</li>
+</ul>
+</li>
+</ul>
+<h2>
+<a name="connection.type_bada_quirks">Bada Quirks</a>
+</h2>
+
+<ul>
+<li>Bada can only detect a WiFi or cellular connection.
+<ul>
+<li>
+<code>navigator.<a href="cordova_connection_connection.md.html#connection.type">connection.type</a></code> is set to <code><a href="cordova_connection_connection.md.html#Connection">Connection</a>.CELL_2G</code> for all cellular data.</li>
+</ul>
+</li>
+</ul>
+<h2>
+<a name="connection.type_webos_quirks">webOS Quirks</a>
+</h2>
+
+<ul>
+<li>Only shows that a connection is available, but not which type.</li>
+</ul>
+<h2>
+<a name="connection.type_windows_phone_quirks">Windows Phone Quirks</a>
+</h2>
+
+<ul>
+<li>When running in the emulator, always detects <code>navigator.<a href="cordova_connection_connection.md.html#connection.type">connection.type</a></code> as <code><a href="cordova_connection_connection.md.html#Connection">Connection</a>.UNKNOWN</code>.</li>
+</ul>
+<h2>
+<a name="connection.type_tizen_quirks">Tizen Quirks</a>
+</h2>
+
+<ul>
+<li>Tizen can only detect a WiFi or cellular connection.
+<ul>
+<li>
+<code>navigator.<a href="cordova_connection_connection.md.html#connection.type">connection.type</a></code> is set to <code><a href="cordova_connection_connection.md.html#Connection">Connection</a>.CELL_2G</code> for all cellular data.</li>
+</ul>
+</li>
+</ul>
+</div>
+ </div>
+
+ <!-- Functionality and Syntax Highlighting -->
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
+</html>