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 2012/07/13 00:09:52 UTC
[2/64] Add generated HTML documentation.
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/62a5f4d2/www/cordova_camera_camera.md.html
----------------------------------------------------------------------
diff --git a/www/cordova_camera_camera.md.html b/www/cordova_camera_camera.md.html
new file mode 100644
index 0000000..679dbea
--- /dev/null
+++ b/www/cordova_camera_camera.md.html
@@ -0,0 +1,628 @@
+<!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 selected value="edge">edge</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>Camera</h1>
+ <small><select><option value="Camera">Camera</option>
+<option value="Camera_methods"> - Methods</option>
+<option value="Camera_permissions"> - Permissions</option>
+<option value="camera.getPicture">camera.getPicture</option>
+<option value="camera.getPicture_description"> - Description</option>
+<option value="camera.getPicture_supported_platforms"> - Supported Platforms</option>
+<option value="camera.getPicture_ios_quirks"> - iOS Quirks</option>
+<option value="camera.getPicture_windows_phone_7_quirks"> - Windows Phone 7 Quirks</option>
+<option value="camera.getPicture_quick_example"> - Quick Example</option>
+<option value="camera.getPicture_full_example"> - Full Example</option>
+<option value="cameraSuccess">cameraSuccess</option>
+<option value="cameraSuccess_parameters"> - Parameters</option>
+<option value="cameraSuccess_example"> - Example</option>
+<option value="cameraError">cameraError</option>
+<option value="cameraError_parameters"> - Parameters</option>
+<option value="cameraOptions">cameraOptions</option>
+<option value="cameraOptions_options"> - Options</option>
+<option value="cameraOptions_android_quirks"> - Android Quirks</option>
+<option value="cameraOptions_blackberry_quirks"> - BlackBerry Quirks</option>
+<option value="cameraOptions_webos_quirks"> - webOS Quirks</option>
+<option value="cameraOptions_ios_quirks"> - iOS Quirks</option>
+<option value="cameraOptions_windows_phone_7_quirks"> - Windows Phone 7 Quirks</option>
+<option value="cameraOptions_bada_1_2_quirks"> - Bada 1.2 Quirks</option>
+<option value="CameraPopoverOptions">CameraPopoverOptions</option>
+<option value="CameraPopoverOptions_camerapopoveroptions"> - CameraPopoverOptions</option>
+<option value="CameraPopoverOptions_quick_example"> - Quick Example</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_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</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_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="Camera">Camera</a></h1>
+
+<blockquote>
+ <p>The <code>camera</code> object provides access to the device's default camera application.</p>
+</blockquote>
+
+<h2>
+<a name="Camera_methods">Methods</a>
+</h2>
+
+<ul>
+<li><a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a></li>
+<li><a href="cordova_camera_camera.cleanup.md.html#camera.cleanup">camera.cleanup</a></li>
+</ul>
+<h2>
+<a name="Camera_permissions">Permissions</a>
+</h2>
+
+<h3>Android</h3>
+
+<h4>app/res/xml/plugins.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_camera_camera.md.html#Camera">Camera</a>" value="org.apache.cordova.CameraLauncher" />
+</code></pre>
+
+<h4>app/AndroidManifest</h4>
+
+<pre class="prettyprint"><code><uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+</code></pre>
+
+<h3>Bada</h3>
+
+<h4>manifest.xml</h4>
+
+<pre class="prettyprint"><code><Privilege>
+ <Name>CAMERA</Name>
+</Privilege>
+<Privilege>
+ <Name>RECORDING</Name>
+</Privilege>
+</code></pre>
+
+<h3>BlackBerry WebWorks</h3>
+
+<h4>www/plugins.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_camera_camera.md.html#Camera">Camera</a>" value="org.apache.cordova.camera.<a href="cordova_camera_camera.md.html#Camera">Camera</a>" />
+</code></pre>
+
+<h4>www/config.xml</h4>
+
+<pre class="prettyprint"><code><feature id="blackberry.media.camera" />
+
+<rim:permissions>
+ <rim:permit>use_camera</rim:permit>
+</rim:permissions>
+</code></pre>
+
+<h3>iOS</h3>
+
+<h4>App/Supporting Files/Cordova.plist</h4>
+
+<pre class="prettyprint"><code><key>Plugins</key>
+<dict>
+ <key><a href="cordova_camera_camera.md.html#Camera">Camera</a></key>
+ <string>CDVCamera</string>
+</dict>
+</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_CAMERA" />
+ <Capability Name="ID_CAP_ISV_CAMERA" />
+ <Capability Name="ID_HW_FRONTCAMERA" />
+</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>
+
+<hr>
+<h1><a name="camera.getPicture">camera.getPicture</a></h1>
+
+<p>Takes a photo using the camera or retrieves a photo from the device's album. The image is returned as a base64 encoded <code>String</code> or as the URI of an image file.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>( <a href="cordova_camera_camera.md.html#cameraSuccess">cameraSuccess</a>, <a href="cordova_camera_camera.md.html#cameraError">cameraError</a>, [ <a href="cordova_camera_camera.md.html#cameraOptions">cameraOptions</a> ] );
+</code></pre>
+
+<h2>
+<a name="camera.getPicture_description">Description</a>
+</h2>
+
+<p>Function <code><a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a></code> opens the device's default camera application so that the user can take a picture (if <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.sourceType = <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.CAMERA</code>, which is the default). Once the photo is taken, the camera application closes and your application is restored.</p>
+
+<p>If <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.sourceType = <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY</code> or <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM</code>, then a photo chooser dialog is shown, from which a photo from the album can be selected.</p>
+
+<p>The return value will be sent to the <code><a href="cordova_camera_camera.md.html#cameraSuccess">cameraSuccess</a></code> function, in one of the following formats, depending on the <code><a href="cordova_camera_camera.md.html#cameraOptions">cameraOptions</a></code> you specify:</p>
+
+<ul>
+<li>A <code>String</code> containing the Base64 encoded photo image (default). </li>
+<li>A <code>String</code> representing the image file location on local storage. </li>
+</ul>
+<p>You can do whatever you want with the encoded image or URI, for example:</p>
+
+<ul>
+<li>Render the image in an <code><img></code> tag <em>(see example below)</em>
+</li>
+<li>Save the data locally (<code>LocalStorage</code>, <a class="external" href="http://brianleroux.github.com/lawnchair/">Lawnchair</a>, etc)</li>
+<li>Post the data to a remote server</li>
+</ul>
+<p>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. <em>Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800).</em> Therefore, using FILE_URI as the '<a href="cordova_camera_camera.md.html#Camera">Camera</a>.destinationType' is highly recommended.</p>
+
+<h2>
+<a name="camera.getPicture_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>Blackberry WebWorks (OS 5.0 and higher)</li>
+<li>iOS</li>
+<li>Windows Phone 7 ( Mango )</li>
+<li>Bada 1.2</li>
+<li>webOS</li>
+</ul>
+<h2>
+<a name="camera.getPicture_ios_quirks">iOS Quirks</a>
+</h2>
+
+<p>Including a JavaScript alert() in either of the callback functions can cause problems. Wrap the alert in a setTimeout() to allow the iOS image picker or popover to fully close before the alert is displayed: setTimeout("alert('message');", 0);</p>
+
+<h2>
+<a name="camera.getPicture_windows_phone_7_quirks">Windows Phone 7 Quirks</a>
+</h2>
+
+<p>Invoking the native camera application while your device is connected
+via Zune will not work, and the error callback will be triggered.</p>
+
+<h2>
+<a name="camera.getPicture_quick_example">Quick Example</a>
+</h2>
+
+<p>Take photo and retrieve Base64-encoded image:</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(onSuccess, onFail, { quality: 50,
+ destinationType: <a href="cordova_camera_camera.md.html#Camera">Camera</a>.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);
+}
+</code></pre>
+
+<p>Take photo and retrieve image file location: </p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(onSuccess, onFail, { quality: 50,
+ destinationType: <a href="cordova_camera_camera.md.html#Camera">Camera</a>.DestinationType.FILE_URI });
+
+function onSuccess(imageURI) {
+ var image = document.getElementById('myImage');
+ image.src = imageURI;
+}
+
+function onFail(message) {
+ alert('Failed because: ' + message);
+}
+</code></pre>
+
+<h2>
+<a name="camera.getPicture_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_media_capture_capture.md.html#Capture">Capture</a> Photo</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-1.9.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("<a href="cordova_events_events.md.html#deviceready">deviceready</a>",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.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(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.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(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.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(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();"><a href="cordova_media_capture_capture.md.html#Capture">Capture</a> Photo</button> <br>
+ <button onclick="capturePhotoEdit();"><a href="cordova_media_capture_capture.md.html#Capture">Capture</a> 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>
+</code></pre>
+
+<hr>
+<h1><a name="cameraSuccess">cameraSuccess</a></h1>
+
+<p>onSuccess callback function that provides the image data.</p>
+
+<pre class="prettyprint"><code>function(imageData) {
+ // Do something with the image
+}
+</code></pre>
+
+<h2>
+<a name="cameraSuccess_parameters">Parameters</a>
+</h2>
+
+<ul>
+<li>
+<strong>imageData:</strong> Base64 encoding of the image data, OR the image file URI, depending on <code><a href="cordova_camera_camera.md.html#cameraOptions">cameraOptions</a></code> used. (<code>String</code>)</li>
+</ul>
+<h2>
+<a name="cameraSuccess_example">Example</a>
+</h2>
+
+<pre class="prettyprint"><code>// Show image
+//
+function cameraCallback(imageData) {
+ var image = document.getElementById('myImage');
+ image.src = "data:image/jpeg;base64," + imageData;
+}
+</code></pre>
+
+<hr>
+<h1><a name="cameraError">cameraError</a></h1>
+
+<p>onError callback function that provides an error message.</p>
+
+<pre class="prettyprint"><code>function(message) {
+ // Show a helpful message
+}
+</code></pre>
+
+<h2>
+<a name="cameraError_parameters">Parameters</a>
+</h2>
+
+<ul>
+<li>
+<strong>message:</strong> The message is provided by the device's native code. (<code>String</code>)</li>
+</ul>
+<hr>
+<h1><a name="cameraOptions">cameraOptions</a></h1>
+
+<p>Optional parameters to customize the camera settings.</p>
+
+<pre class="prettyprint"><code>{ quality : 75,
+ destinationType : <a href="cordova_camera_camera.md.html#Camera">Camera</a>.DestinationType.DATA_URL,
+ sourceType : <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.CAMERA,
+ allowEdit : true,
+ encodingType: <a href="cordova_camera_camera.md.html#Camera">Camera</a>.EncodingType.JPEG,
+ targetWidth: 100,
+ targetHeight: 100,
+ popoverOptions: <a href="cordova_camera_camera.md.html#CameraPopoverOptions">CameraPopoverOptions</a>,
+ saveToPhotoAlbum: false };
+</code></pre>
+
+<h2>
+<a name="cameraOptions_options">Options</a>
+</h2>
+
+<ul>
+<li><p><strong>quality:</strong> Quality of saved image. Range is [0, 100]. (<code>Number</code>)</p></li>
+<li>
+<p><strong>destinationType:</strong> Choose the format of the return value. Defined in navigator.camera.DestinationType (<code>Number</code>)</p>
+
+<pre class="prettyprint"><code> <a href="cordova_camera_camera.md.html#Camera">Camera</a>.DestinationType = {
+ DATA_URL : 0, // Return image as base64 encoded string
+ FILE_URI : 1 // Return image file URI
+ };
+</code></pre>
+</li>
+<li>
+<p><strong>sourceType:</strong> Set the source of the picture. Defined in nagivator.camera.PictureSourceType (<code>Number</code>)</p>
+
+<pre class="prettyprint"><code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType = {
+ PHOTOLIBRARY : 0,
+ CAMERA : 1,
+ SAVEDPHOTOALBUM : 2
+};
+</code></pre>
+</li>
+<li><p><strong>allowEdit:</strong> Allow simple editing of image before selection. (<code>Boolean</code>)</p></li>
+<li>
+<p><strong>encodingType:</strong> Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (<code>Number</code>)</p>
+
+<pre class="prettyprint"><code> <a href="cordova_camera_camera.md.html#Camera">Camera</a>.EncodingType = {
+ JPEG : 0, // Return JPEG encoded image
+ PNG : 1 // Return PNG encoded image
+ };
+</code></pre>
+</li>
+<li><p><strong>targetWidth:</strong> Width in pixels to scale image. Must be used with targetHeight. Aspect ratio is maintained. (<code>Number</code>)</p></li>
+<li><p><strong>targetHeight:</strong> Height in pixels to scale image. Must be used with targetWidth. Aspect ratio is maintained. (<code>Number</code>)</p></li>
+<li>
+<p><strong>mediaType:</strong> Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.MediaType (<code>Number</code>)</p>
+
+<pre class="prettyprint"><code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.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
+</code></pre>
+
+<p>};</p>
+</li>
+<li><p><strong>correctOrientation:</strong> Rotate the image to correct for the orientation of the device during capture. (<code>Boolean</code>)</p></li>
+<li>
+<strong>saveToPhotoAlbum:</strong> Save the image to the photo album on the device after capture. (<code>Boolean</code>)</li>
+<li>
+<strong>popoverOptions:</strong> iOS only options to specify popover location in iPad. Defined in <a href="cordova_camera_camera.md.html#CameraPopoverOptions">CameraPopoverOptions</a>
+</li>
+</ul>
+<h2>
+<a name="cameraOptions_android_quirks">Android Quirks</a>
+</h2>
+
+<ul>
+<li>Ignores the <code>allowEdit</code> parameter.</li>
+<li>
+<a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY and <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.</li>
+</ul>
+<h2>
+<a name="cameraOptions_blackberry_quirks">BlackBerry Quirks</a>
+</h2>
+
+<ul>
+<li>Ignores the <code>quality</code> parameter.</li>
+<li>Ignores the <code>sourceType</code> parameter.</li>
+<li>Ignores the <code>allowEdit</code> parameter.</li>
+<li>Application must have key injection permissions to close native <a href="cordova_camera_camera.md.html#Camera">Camera</a> application after photo is taken.</li>
+<li>Using Large image sizes may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800).</li>
+<li>
+<a href="cordova_camera_camera.md.html#Camera">Camera</a>.MediaType is not supported.</li>
+<li>Ignores the <code>correctOrientation</code> parameter.</li>
+<li>Ignores the <code>saveToPhotoAlbum</code> parameter.</li>
+</ul>
+<h2>
+<a name="cameraOptions_webos_quirks">webOS Quirks</a>
+</h2>
+
+<ul>
+<li>Ignores the <code>quality</code> parameter.</li>
+<li>Ignores the <code>sourceType</code> parameter.</li>
+<li>Ignores the <code>allowEdit</code> parameter.</li>
+<li>
+<a href="cordova_camera_camera.md.html#Camera">Camera</a>.MediaType is not supported.</li>
+<li>Ignores the <code>correctOrientation</code> parameter.</li>
+<li>Ignores the <code>saveToPhotoAlbum</code> parameter.</li>
+</ul>
+<h2>
+<a name="cameraOptions_ios_quirks">iOS Quirks</a>
+</h2>
+
+<ul>
+<li>Set <code>quality</code> below 50 to avoid memory error on some devices.</li>
+<li>When <code>destinationType.FILE_URI</code> is used, photos are saved in the application's temporary directory. Developers may delete the contents of this directory using the navigator.fileMgr APIs if storage space is a concern.</li>
+</ul>
+<h2>
+<a name="cameraOptions_windows_phone_7_quirks">Windows Phone 7 Quirks</a>
+</h2>
+
+<ul>
+<li>Ignores the <code>allowEdit</code> parameter.</li>
+<li>Ignores the <code>correctOrientation</code> parameter.</li>
+<li>Ignores the <code>saveToPhotoAlbum</code> parameter.</li>
+</ul>
+<h2>
+<a name="cameraOptions_bada_1_2_quirks">Bada 1.2 Quirks</a>
+</h2>
+
+<ul>
+<li>options not supported</li>
+<li>always returns a FILE URI</li>
+</ul>
+<hr>
+<h1><a name="CameraPopoverOptions">CameraPopoverOptions</a></h1>
+
+<p>Parameters only used by iOS to specify the anchor element location and arrow direction of popover used on iPad when selecting images from the library or album.</p>
+
+<pre class="prettyprint"><code>{ x : 0,
+ y : 32,
+ width : 320,
+ height : 480,
+ arrowDir : <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PopoverArrowDirection.ARROW_ANY
+};
+</code></pre>
+
+<h2>
+<a name="CameraPopoverOptions_camerapopoveroptions">CameraPopoverOptions</a>
+</h2>
+
+<ul>
+<li><p><strong>x:</strong> x pixel coordinate of element on the screen to anchor popover onto. (<code>Number</code>)</p></li>
+<li><p><strong>y:</strong> y pixel coordinate of element on the screen to anchor popover onto. (<code>Number</code>)</p></li>
+<li><p><strong>width:</strong> width, in pixels, of the element on the screen to anchor popover onto. (<code>Number</code>)</p></li>
+<li><p><strong>height:</strong> height, in pixels, of the element on the screen to anchor popover onto. (<code>Number</code>)</p></li>
+<li>
+<p><strong>arrowDir:</strong> Direction the arrow on the popover should point. Defined in <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PopoverArrowDirection (<code>Number</code>)</p>
+
+<pre class="prettyprint"><code> <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PopoverArrowDirection = {
+ ARROW_UP : 1, // matches iOS UIPopoverArrowDirection constants
+ ARROW_DOWN : 2,
+ ARROW_LEFT : 4,
+ ARROW_RIGHT : 8,
+ ARROW_ANY : 15
+ };
+</code></pre>
+</li>
+</ul>
+<p>Note that the size of the popover may change to adjust to the direction of the arrow and orientation of the screen. Make sure to account for orientation changes when specifying the anchor element location. </p>
+
+<h2>
+<a name="CameraPopoverOptions_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code> var popover = new <a href="cordova_camera_camera.md.html#CameraPopoverOptions">CameraPopoverOptions</a>(300,300,100,100,<a href="cordova_camera_camera.md.html#Camera">Camera</a>.PopoverArrowDirection.ARROW_ANY);
+ var options = { quality: 50, destinationType: <a href="cordova_camera_camera.md.html#Camera">Camera</a>.DestinationType.DATA_URL,sourceType: <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSource.SAVEDPHOTOALBUM, popoverOptions : popover };
+
+ navigator.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>(onSuccess, onFail, options);
+
+ function onSuccess(imageData) {
+ var image = document.getElementById('myImage');
+ image.src = "data:image/jpeg;base64," + imageData;
+}
+
+function onFail(message) {
+ alert('Failed because: ' + message);
+}
+</code></pre>
+
+ </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>
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/62a5f4d2/www/cordova_compass_compass.md.html
----------------------------------------------------------------------
diff --git a/www/cordova_compass_compass.md.html b/www/cordova_compass_compass.md.html
new file mode 100644
index 0000000..e659575
--- /dev/null
+++ b/www/cordova_compass_compass.md.html
@@ -0,0 +1,663 @@
+<!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 selected value="edge">edge</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_quirks"> - Windows Phone 7 Quirks</option>
+<option value="compassOptions_bada_quirks"> - Bada 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_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</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_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/plugins.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>App/Supporting Files/Cordova.plist</h4>
+
+<pre class="prettyprint"><code><key>Plugins</key>
+<dict>
+ <key><a href="cordova_compass_compass.md.html#Compass">Compass</a></key>
+ <string>CDVLocation</string>
+</dict>
+</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>
+
+<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 ( Mango ) if available in hardware</li>
+<li>Bada 1.2 & 2.x</li>
+<li>webOS</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-1.9.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("<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 ( Mango ) if available in hardware</li>
+<li>Bada 1.2 & 2.x</li>
+<li>webOS</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-1.9.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("<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 ( Mango ) if available in hardware</li>
+<li>Bada 1.2 & 2.x</li>
+<li>webOS</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-1.9.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("<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>
+
+<p>function(<a href="cordova_compass_compass.md.html#CompassError">CompassError</a>) {
+ // Handle the error
+}</p>
+
+<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_quirks">Windows Phone 7 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>
+<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>
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/62a5f4d2/www/cordova_connection_connection.md.html
----------------------------------------------------------------------
diff --git a/www/cordova_connection_connection.md.html b/www/cordova_connection_connection.md.html
new file mode 100644
index 0000000..e24f343
--- /dev/null
+++ b/www/cordova_connection_connection.md.html
@@ -0,0 +1,311 @@
+<!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 selected value="edge">edge</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_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></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_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</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_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 accessed under the <code>navigator.network</code> interface.</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/plugins.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>App/Supporting Files/Cordova.plist</h4>
+
+<pre class="prettyprint"><code><key>Plugins</key>
+<dict>
+ <key>NetworkStatus</key>
+ <string>CDVConnection</string>
+</dict>
+</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>
+
+<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 ( Mango )</li>
+<li>Bada 2.x</li>
+<li>webOS</li>
+</ul>
+<h2>
+<a name="connection.type_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function checkConnection() {
+ var networkState = navigator.network.<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.network.<a href="cordova_connection_connection.md.html#connection.type">connection.type</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("<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.network.<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_ios_quirks">iOS Quirks</a>
+</h2>
+
+<ul>
+<li>iOS cannot detect the type of cellular network connection.
+<ul>
+<li>
+<code>navigator.network.<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.network.<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>Windows Phone Emulator always detects <code>navigator.network.<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>
+</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>