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/12/17 21:31:37 UTC
svn commit: r1551686 [11/19] - in /cordova/site/public/docs/en: 3.3.0/ edge/
Modified: cordova/site/public/docs/en/edge/cordova_camera_camera.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_camera_camera.md.html?rev=1551686&r1=1551685&r2=1551686&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_camera_camera.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_camera_camera.md.html Tue Dec 17 20:31:35 2013
@@ -17,16 +17,18 @@
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>
+ <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>
@@ -92,7 +94,8 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select></small>
+</optgroup></select>
+ </small>
</div>
<div id="subheader">
<h1>Camera</h1>
@@ -191,17 +194,14 @@ obtaining the user's permission (e.g., b
<strong>OK</strong> and <strong>No Thanks</strong>). For more information, please see the
<a href="guide_appdev_privacy_index.md.html#Privacy%20Guide">Privacy Guide</a>.</p>
-<h2>
-<a name="Camera_methods">Methods</a>
-</h2>
+<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_accessing_the_feature">Accessing the Feature</a>
-</h2>
+
+<h2><a name="Camera_accessing_the_feature">Accessing the Feature</a></h2>
<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-Line%0AInterface">The Command-Line
@@ -279,10 +279,12 @@ platform-specific configuration settings
<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>
</li>
</ul>
+
<p>Some platforms may support this feature without requiring any special
configuration. See <a href="guide_support_index.md.html#Platform%20Support">Platform Support</a> for an overview.</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
@@ -294,9 +296,7 @@ reposition the file selection popover.</
<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>
+<h2><a name="camera.getPicture_description">Description</a></h2>
<p>The <code><a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a></code> function opens the device's default camera
application that allows users to snap pictures. This behavior occurs
@@ -319,6 +319,7 @@ one of the following formats, depending
<li><p>A <code>String</code> containing the base64-encoded photo image.</p></li>
<li><p>A <code>String</code> representing the image file location on local storage (default).</p></li>
</ul>
+
<p>You can do whatever you want with the encoded image or URI, for
example:</p>
@@ -327,15 +328,14 @@ example:</p>
<li><p>Save the data locally (<code>LocalStorage</code>, <a class="external" href="http://brianleroux.github.com/lawnchair/">Lawnchair</a>, etc.)</p></li>
<li><p>Post the data to a remote server</p></li>
</ul>
+
<p><strong>NOTE</strong>: Photo resolution on newer devices is quite good. Photos
selected from the device's gallery are not downscaled to a lower
quality, even if a <code>quality</code> parameter is specified. To avoid common
memory problems, set <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.destinationType</code> to <code>FILE_URI</code> rather
than <code>DATA_URL</code>.</p>
-<h2>
-<a name="camera.getPicture_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="camera.getPicture_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -346,17 +346,14 @@ than <code>DATA_URL</code>.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="camera.getPicture_amazon_fire_os_quirks">Amazon Fire OS Quirks</a>
-</h2>
+
+<h2><a name="camera.getPicture_amazon_fire_os_quirks">Amazon Fire OS Quirks</a></h2>
<p>Amazon Fire OS uses intents to launch the camera activity on the device to capture
images, and on phones with low memory, the Cordova activity may be killed. In this
scenario, the image may not appear when the cordova activity is restored.</p>
-<h2>
-<a name="camera.getPicture_android_quirks">Android Quirks</a>
-</h2>
+<h2><a name="camera.getPicture_android_quirks">Android Quirks</a></h2>
<p><em>Android 4.4 only</em>: Android 4.4 introduced a new <a class="external" href="https://developer.android.com/guide/topics/providers/document-provider.html"></a><a href="cordova_storage_storage.md.html#Storage">Storage</a> Access Framework that makes it
easier for users to browse and open documents across all of their preferred document storage providers.
@@ -369,9 +366,7 @@ if they go through the "Gallery" app fir
images, and on phones with low memory, the Cordova activity may be killed. In this
scenario, the image may not appear when the Cordova activity is restored.</p>
-<h2>
-<a name="camera.getPicture_ios_quirks">iOS Quirks</a>
-</h2>
+<h2><a name="camera.getPicture_ios_quirks">iOS Quirks</a></h2>
<p>Including a JavaScript <code>alert()</code> in either of the callback functions
can cause problems. Wrap the alert within a <code>setTimeout()</code> to allow
@@ -383,24 +378,18 @@ displays:</p>
}, 0);
</code></pre>
-<h2>
-<a name="camera.getPicture_windows_phone_7_quirks">Windows Phone 7 Quirks</a>
-</h2>
+<h2><a name="camera.getPicture_windows_phone_7_quirks">Windows Phone 7 Quirks</a></h2>
<p>Invoking the native camera application while the device is connected
via Zune does not work, and triggers an error callback.</p>
-<h2>
-<a name="camera.getPicture_tizen_quirks">Tizen Quirks</a>
-</h2>
+<h2><a name="camera.getPicture_tizen_quirks">Tizen Quirks</a></h2>
<p>Tizen only supports a <code>destinationType</code> of
<code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.DestinationType.FILE_URI</code> and a <code>sourceType</code> of
<code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY</code>.</p>
-<h2>
-<a name="camera.getPicture_quick_example">Quick Example</a>
-</h2>
+<h2><a name="camera.getPicture_quick_example">Quick Example</a></h2>
<p>Take a photo and retrieve it as a base64-encoded image:</p>
@@ -433,9 +422,7 @@ function onFail(message) {
}
</code></pre>
-<h2>
-<a name="camera.getPicture_full_example">Full Example</a>
-</h2>
+<h2><a name="camera.getPicture_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -544,6 +531,7 @@ function onFail(message) {
</code></pre>
<hr>
+
<h1><a name="cameraSuccess">cameraSuccess</a></h1>
<p>onSuccess callback function that provides the image data.</p>
@@ -553,18 +541,15 @@ function onFail(message) {
}
</code></pre>
-<h2>
-<a name="cameraSuccess_parameters">Parameters</a>
-</h2>
+<h2><a name="cameraSuccess_parameters">Parameters</a></h2>
<ul>
<li>
<strong>imageData</strong>: Base64 encoding of the image data, <em>or</em> the image file URI, depending on <code><a href="cordova_camera_camera.md.html#cameraOptions">cameraOptions</a></code> in effect. <em>(String)</em>
</li>
</ul>
-<h2>
-<a name="cameraSuccess_example">Example</a>
-</h2>
+
+<h2><a name="cameraSuccess_example">Example</a></h2>
<pre class="prettyprint"><code>// Show image
//
@@ -575,6 +560,7 @@ function cameraCallback(imageData) {
</code></pre>
<hr>
+
<h1><a name="cameraError">cameraError</a></h1>
<p>onError callback function that provides an error message.</p>
@@ -584,16 +570,16 @@ function cameraCallback(imageData) {
}
</code></pre>
-<h2>
-<a name="cameraError_parameters">Parameters</a>
-</h2>
+<h2><a name="cameraError_parameters">Parameters</a></h2>
<ul>
<li>
<strong>message</strong>: The message is provided by the device's native code. <em>(String)</em>
</li>
</ul>
+
<hr>
+
<h1><a name="cameraOptions">cameraOptions</a></h1>
<p>Optional parameters to customize the camera settings.</p>
@@ -609,9 +595,7 @@ function cameraCallback(imageData) {
saveToPhotoAlbum: false };
</code></pre>
-<h2>
-<a name="cameraOptions_options">Options</a>
-</h2>
+<h2><a name="cameraOptions_options">Options</a></h2>
<ul>
<li><p><strong>quality</strong>: Quality of the saved image, expressed as a range of 0-100, where 100 is typically full resolution with no loss from file compression. <em>(Number)</em> (Note that information about the camera's resolution is unavailable.)</p></li>
@@ -671,27 +655,24 @@ function cameraCallback(imageData) {
</code></pre>
</li>
</ul>
-<h2>
-<a name="cameraOptions_amazon_fire_osquirks">Amazon Fire OSQuirks</a>
-</h2>
+
+<h2><a name="cameraOptions_amazon_fire_osquirks">Amazon Fire OSQuirks</a></h2>
<ul>
<li><p>Any <code>cameraDirection</code> value results in a back-facing photo.</p></li>
<li><p>Ignores the <code>allowEdit</code> parameter.</p></li>
<li><p><code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY</code> and <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM</code> both display the same photo album.</p></li>
</ul>
-<h2>
-<a name="cameraOptions_android_quirks">Android Quirks</a>
-</h2>
+
+<h2><a name="cameraOptions_android_quirks">Android Quirks</a></h2>
<ul>
<li><p>Any <code>cameraDirection</code> value results in a back-facing photo.</p></li>
<li><p>Ignores the <code>allowEdit</code> parameter.</p></li>
<li><p><code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY</code> and <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM</code> both display the same photo album.</p></li>
</ul>
-<h2>
-<a name="cameraOptions_blackberry_10_quirks">BlackBerry 10 Quirks</a>
-</h2>
+
+<h2><a name="cameraOptions_blackberry_10_quirks">BlackBerry 10 Quirks</a></h2>
<ul>
<li><p>Ignores the <code>quality</code> parameter.</p></li>
@@ -701,32 +682,31 @@ function cameraCallback(imageData) {
<li><p>Ignores the <code>correctOrientation</code> parameter.</p></li>
<li><p>Ignores the <code>cameraDirection</code> parameter.</p></li>
</ul>
-<h2>
-<a name="cameraOptions_ios_quirks">iOS Quirks</a>
-</h2>
+
+<h2><a name="cameraOptions_ios_quirks">iOS Quirks</a></h2>
<ul>
<li><p>Set <code>quality</code> below 50 to avoid memory errors on some devices.</p></li>
<li><p>When using <code>destinationType.FILE_URI</code>, photos are saved in the application's temporary directory. You may delete the contents of this directory using the <code>navigator.fileMgr</code> APIs if storage space is a concern.</p></li>
</ul>
-<h2>
-<a name="cameraOptions_tizen_quirks">Tizen Quirks</a>
-</h2>
+
+<h2><a name="cameraOptions_tizen_quirks">Tizen Quirks</a></h2>
<ul>
<li><p>options not supported</p></li>
<li><p>always returns a FILE URI</p></li>
</ul>
-<h2>
-<a name="cameraOptions_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
-</h2>
+
+<h2><a name="cameraOptions_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a></h2>
<ul>
<li><p>Ignores the <code>allowEdit</code> parameter.</p></li>
<li><p>Ignores the <code>correctOrientation</code> parameter.</p></li>
<li><p>Ignores the <code>cameraDirection</code> parameter.</p></li>
</ul>
+
<hr>
+
<h1><a name="CameraPopoverOptions">CameraPopoverOptions</a></h1>
<p>iOS-only parameters that specify the anchor element location and arrow
@@ -741,9 +721,7 @@ or album.</p>
};
</code></pre>
-<h2>
-<a name="CameraPopoverOptions_camerapopoveroptions">CameraPopoverOptions</a>
-</h2>
+<h2><a name="CameraPopoverOptions_camerapopoveroptions">CameraPopoverOptions</a></h2>
<ul>
<li><p><strong>x</strong>: x pixel coordinate of screen element onto which to anchor the popover. <em>(Number)</em></p></li>
@@ -763,14 +741,13 @@ or album.</p>
</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>
+<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 = {
@@ -793,28 +770,25 @@ location.</p>
</code></pre>
<hr>
+
<h1><a name="CameraPopoverHandle">CameraPopoverHandle</a></h1>
<p>A handle to the popover dialog created by <code><a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a></code>.</p>
-<h2>
-<a name="CameraPopoverHandle_methods">Methods</a>
-</h2>
+<h2><a name="CameraPopoverHandle_methods">Methods</a></h2>
<ul>
<li>
<strong>setPosition</strong>: Set the position of the popover.</li>
</ul>
-<h2>
-<a name="CameraPopoverHandle_supported_platforms">Supported Platforms</a>
-</h2>
+
+<h2><a name="CameraPopoverHandle_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>iOS</li>
</ul>
-<h2>
-<a name="CameraPopoverHandle_setposition">setPosition</a>
-</h2>
+
+<h2><a name="CameraPopoverHandle_setposition">setPosition</a></h2>
<p>Set the position of the popover.</p>
@@ -824,17 +798,14 @@ location.</p>
<li>
<code>cameraPopoverOptions</code>: the <code><a href="cordova_camera_camera.md.html#CameraPopoverOptions">CameraPopoverOptions</a></code> that specify the new position</li>
</ul>
-<h2>
-<a name="CameraPopoverHandle_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="CameraPopoverHandle_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code> var cameraPopoverOptions = 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);
cameraPopoverHandle.setPosition(cameraPopoverOptions);
</code></pre>
-<h2>
-<a name="CameraPopoverHandle_full_example">Full Example</a>
-</h2>
+<h2><a name="CameraPopoverHandle_full_example">Full Example</a></h2>
<pre class="prettyprint"><code> function onSuccess(imageData) {
// Do stuff with the image!
@@ -859,6 +830,7 @@ location.</p>
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
-</body>
+ <script type="text/javascript" src="index.js"></script>
+ <script type="text/javascript" src="prettify/prettify.js"></script>
+ </body>
</html>
Modified: cordova/site/public/docs/en/edge/cordova_compass_compass.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_compass_compass.md.html?rev=1551686&r1=1551685&r2=1551686&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_compass_compass.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_compass_compass.md.html Tue Dec 17 20:31:35 2013
@@ -17,16 +17,18 @@
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>
+ <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>
@@ -92,7 +94,8 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select></small>
+</optgroup></select>
+ </small>
</div>
<div id="subheader">
<h1>Compass</h1>
@@ -186,9 +189,7 @@
<p>Obtains the direction that the device is pointing.</p>
</blockquote>
-<h2>
-<a name="Compass_methods">Methods</a>
-</h2>
+<h2><a name="Compass_methods">Methods</a></h2>
<ul>
<li><a href="cordova_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a></li>
@@ -199,9 +200,8 @@
<li>
<a href="cordova_compass_compass.md.html#compass.clearWatchFilter">compass.clearWatchFilter</a> (obsolete)</li>
</ul>
-<h2>
-<a name="Compass_arguments">Arguments</a>
-</h2>
+
+<h2><a name="Compass_arguments">Arguments</a></h2>
<ul>
<li><a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a></li>
@@ -209,9 +209,8 @@
<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_accessing_the_feature">Accessing the Feature</a>
-</h2>
+
+<h2><a name="Compass_accessing_the_feature">Accessing the Feature</a></h2>
<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-Line%0AInterface">The Command-Line
@@ -291,10 +290,12 @@ platform-specific configuration settings
<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>
</li>
</ul>
+
<p>Some platforms may support this feature without requiring any special
configuration. See <a href="guide_support_index.md.html#Platform%20Support">Platform Support</a> for an overview.</p>
<hr>
+
<h1><a name="compass.getCurrentHeading">compass.getCurrentHeading</a></h1>
<p>Get the current compass heading.</p>
@@ -302,9 +303,7 @@ configuration. See <a href="guide_suppo
<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>
+<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, typically from the top of the device. It measures
@@ -313,9 +312,7 @@ the heading in degrees from 0 to 359.99,
<p>The compass heading information is returned via a <code>CompassHeading</code>
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>
+<h2><a name="compass.getCurrentHeading_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -326,9 +323,8 @@ object using the <code><a href="cordova_
<li>Windows Phone 7 and 8 (if available in hardware)</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="compass.getCurrentHeading_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="compass.getCurrentHeading_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>function onSuccess(heading) {
alert('Heading: ' + heading.magneticHeading);
@@ -341,9 +337,7 @@ function onError(error) {
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>
+<h2><a name="compass.getCurrentHeading_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -385,6 +379,7 @@ navigator.<a href="cordova_compass_compa
</code></pre>
<hr>
+
<h1><a name="compass.watchHeading">compass.watchHeading</a></h1>
<p>At a regular interval, get the compass heading in degrees.</p>
@@ -392,9 +387,7 @@ navigator.<a href="cordova_compass_compa
<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>
+<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
@@ -409,9 +402,7 @@ object.</p>
<p>The returned watch ID 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>
+<h2><a name="compass.watchHeading_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -422,9 +413,8 @@ ID can be used with <code><a href="cordo
<li>Windows Phone 7 and 8 (if available in hardware)</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="compass.watchHeading_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="compass.watchHeading_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>function onSuccess(heading) {
var element = document.getElementById('heading');
@@ -442,9 +432,7 @@ var options = {
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>
+<h2><a name="compass.watchHeading_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -509,9 +497,7 @@ var watchID = navigator.<a href="cordova
</html>
</code></pre>
-<h2>
-<a name="compass.watchHeading_ios_quirks">iOS Quirks</a>
-</h2>
+<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
@@ -530,6 +516,7 @@ changes. Watching heading changes with a
with time intervals.</p>
<hr>
+
<h1><a name="compass.clearWatch">compass.clearWatch</a></h1>
<p>Stop watching the compass referenced by the watch ID parameter.</p>
@@ -541,9 +528,8 @@ with time intervals.</p>
<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>
+
+<h2><a name="compass.clearWatch_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -554,9 +540,8 @@ with time intervals.</p>
<li>Windows Phone 7 and 8 (if available in hardware)</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="compass.clearWatch_quick_example">Quick Example</a>
-</h2>
+
+<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);
@@ -565,9 +550,7 @@ with time intervals.</p>
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>
+<h2><a name="compass.clearWatch_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -633,16 +616,19 @@ navigator.<a href="cordova_compass_compa
</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 <code><a href="cordova_compass_compass.md.html#compassHeading">compassHeading</a></code> object.</p>
@@ -652,18 +638,15 @@ navigator.<a href="cordova_compass_compa
}
</code></pre>
-<h2>
-<a name="compassSuccess_parameters">Parameters</a>
-</h2>
+<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>
+
+<h2><a name="compassSuccess_example">Example</a></h2>
<pre class="prettyprint"><code>function onSuccess(heading) {
alert('Heading: ' + heading.magneticHeading);
@@ -671,13 +654,12 @@ navigator.<a href="cordova_compass_compa
</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>
+<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
@@ -685,55 +667,50 @@ navigator.<a href="cordova_compass_compa
</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>
+<h2><a name="compassOptions_options">Options</a></h2>
<ul>
<li><p><strong>frequency</strong>: How often to retrieve the compass heading in milliseconds. <em>(Number)</em> (Default: 100)</p></li>
<li><p><strong>filter</strong>: The change in degrees required to initiate a watchHeading success callback. <em>(Number)</em></p></li>
</ul>
-<h2>
-<a name="compassOptions_amazon_fire_os_quirks">Amazon Fire OS Quirks</a>
-</h2>
+
+<h2><a name="compassOptions_amazon_fire_os_quirks">Amazon Fire OS Quirks</a></h2>
<ul>
<li>
<code>filter</code> is not supported.</li>
</ul>
-<h2>
-<a name="compassOptions_android_quirks">Android Quirks</a>
-</h2>
+
+<h2><a name="compassOptions_android_quirks">Android Quirks</a></h2>
<ul>
<li>No support for <code>filter</code>.</li>
</ul>
-<h2>
-<a name="compassOptions_tizen_quirks">Tizen Quirks</a>
-</h2>
+
+<h2><a name="compassOptions_tizen_quirks">Tizen Quirks</a></h2>
<ul>
<li>No support for <code>filter</code>.</li>
</ul>
-<h2>
-<a name="compassOptions_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
-</h2>
+
+<h2><a name="compassOptions_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a></h2>
<ul>
<li>No support for <code>filter</code>.</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.</p>
-<h2>
-<a name="compassHeading_properties">Properties</a>
-</h2>
+<h2><a name="compassHeading_properties">Properties</a></h2>
<ul>
<li><p><strong>magneticHeading</strong>: The heading in degrees from 0-359.99 at a single moment in time. <em>(Number)</em></p></li>
@@ -741,60 +718,53 @@ navigator.<a href="cordova_compass_compa
<li><p><strong>headingAccuracy</strong>: The deviation in degrees between the reported heading and the true heading. <em>(Number)</em></p></li>
<li><p><strong>timestamp</strong>: The time at which this heading was determined. <em>(milliseconds)</em></p></li>
</ul>
-<h2>
-<a name="compassHeading_description">Description</a>
-</h2>
+
+<h2><a name="compassHeading_description">Description</a></h2>
<p>The <code>CompassHeading</code> object is returned to the <code><a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a></code> callback function.</p>
-<h2>
-<a name="compassHeading_amazon_fire_os_quirks">Amazon Fire OS Quirks</a>
-</h2>
+<h2><a name="compassHeading_amazon_fire_os_quirks">Amazon Fire OS Quirks</a></h2>
<ul>
<li><p><code>trueHeading</code> is not supported, but reports the same value as <code>magneticHeading</code></p></li>
<li><p><code>headingAccuracy</code> is always 0 because there is no difference between the <code>magneticHeading</code> and <code>trueHeading</code></p></li>
</ul>
-<h2>
-<a name="compassHeading_android_quirks">Android Quirks</a>
-</h2>
+
+<h2><a name="compassHeading_android_quirks">Android Quirks</a></h2>
<ul>
<li><p>The <code>trueHeading</code> property is not supported, but reports the same value as <code>magneticHeading</code>.</p></li>
<li><p>The <code>headingAccuracy</code> property is always 0 because there is no difference between the <code>magneticHeading</code> and <code>trueHeading</code>.</p></li>
</ul>
-<h2>
-<a name="compassHeading_ios_quirks">iOS Quirks</a>
-</h2>
+
+<h2><a name="compassHeading_ios_quirks">iOS Quirks</a></h2>
<ul>
<li><p>The <code>trueHeading</code> property is only returned for location services enabled via <code>navigator.geolocation.watchLocation()</code>.</p></li>
<li><p>For iOS 4 devices and above, heading factors in the device's current orientation, and does not reference its absolute position, for apps that supports that orientation.</p></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>
+<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>
+
+<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>
+
+<h2><a name="CompassError_description">Description</a></h2>
<p>When an error occurs, the <code><a href="cordova_compass_compass.md.html#CompassError">CompassError</a></code> object is passed as a
parameter to a <code><a href="cordova_compass_compass.md.html#compassError">compassError</a></code> callback function.</p>
@@ -803,6 +773,7 @@ parameter to a <code><a href="cordova_co
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
-</body>
+ <script type="text/javascript" src="index.js"></script>
+ <script type="text/javascript" src="prettify/prettify.js"></script>
+ </body>
</html>
Modified: cordova/site/public/docs/en/edge/cordova_connection_connection.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_connection_connection.md.html?rev=1551686&r1=1551685&r2=1551686&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_connection_connection.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_connection_connection.md.html Tue Dec 17 20:31:35 2013
@@ -17,16 +17,18 @@
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>
+ <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>
@@ -92,7 +94,8 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select></small>
+</optgroup></select>
+ </small>
</div>
<div id="subheader">
<h1>Connection</h1>
@@ -157,16 +160,13 @@
<p>The <code>connection</code> object, exposed via <code>navigator.connection</code>, provides information about the device's cellular and wifi connection.</p>
</blockquote>
-<h2>
-<a name="Connection_properties">Properties</a>
-</h2>
+<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>
+
+<h2><a name="Connection_constants">Constants</a></h2>
<ul>
<li>
@@ -186,9 +186,8 @@
<li>
<a href="cordova_connection_connection.md.html#Connection">Connection</a>.NONE</li>
</ul>
-<h2>
-<a name="Connection_accessing_the_feature">Accessing the Feature</a>
-</h2>
+
+<h2><a name="Connection_accessing_the_feature">Accessing the Feature</a></h2>
<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-Line%0AInterface">The Command-Line
@@ -264,24 +263,22 @@ platform-specific configuration settings
<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>
</li>
</ul>
+
<p>Some platforms may support this feature without requiring any special
configuration. See <a href="guide_support_index.md.html#Platform%20Support">Platform Support</a> for an overview.</p>
<hr>
+
<h1><a name="connection.type">connection.type</a></h1>
<p>Checks the currently active network connection.</p>
-<h2>
-<a name="connection.type_description">Description</a>
-</h2>
+<h2><a name="connection.type_description">Description</a></h2>
<p>This property offers 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>
+<h2><a name="connection.type_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -292,9 +289,8 @@ connection state, and type of connection
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="connection.type_quick_example">Quick Example</a>
-</h2>
+
+<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>;
@@ -315,9 +311,7 @@ connection state, and type of connection
checkConnection();
</code></pre>
-<h2>
-<a name="connection.type_full_example">Full Example</a>
-</h2>
+<h2><a name="connection.type_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -361,9 +355,7 @@ checkConnection();
</html>
</code></pre>
-<h2>
-<a name="connection.type_api_change">API Change</a>
-</h2>
+<h2><a name="connection.type_api_change">API Change</a></h2>
<p>Until Cordova 2.3.0, the <code><a href="cordova_connection_connection.md.html#Connection">Connection</a></code> object was accessed via
<code>navigator.network.connection</code>, after which it was changed to
@@ -371,9 +363,7 @@ checkConnection();
available at its original location, but is deprecated and will
eventually be removed.</p>
-<h2>
-<a name="connection.type_ios_quirks">iOS Quirks</a>
-</h2>
+<h2><a name="connection.type_ios_quirks">iOS Quirks</a></h2>
<ul>
<li>iOS can't detect the type of cellular network connection.
@@ -383,9 +373,8 @@ eventually be removed.</p>
</ul>
</li>
</ul>
-<h2>
-<a name="connection.type_windows_phone_quirks">Windows Phone Quirks</a>
-</h2>
+
+<h2><a name="connection.type_windows_phone_quirks">Windows Phone Quirks</a></h2>
<ul>
<li><p>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>.</p></li>
@@ -398,9 +387,8 @@ eventually be removed.</p>
</ul>
</li>
</ul>
-<h2>
-<a name="connection.type_tizen_quirks">Tizen Quirks</a>
-</h2>
+
+<h2><a name="connection.type_tizen_quirks">Tizen Quirks</a></h2>
<ul>
<li>Tizen can only detect a WiFi or cellular connection.
@@ -410,10 +398,12 @@ eventually be removed.</p>
</ul>
</li>
</ul>
-</div>
+
+ </div>
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
-</body>
+ <script type="text/javascript" src="index.js"></script>
+ <script type="text/javascript" src="prettify/prettify.js"></script>
+ </body>
</html>
Modified: cordova/site/public/docs/en/edge/cordova_contacts_contacts.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_contacts_contacts.md.html?rev=1551686&r1=1551685&r2=1551686&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_contacts_contacts.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_contacts_contacts.md.html Tue Dec 17 20:31:35 2013
@@ -17,16 +17,18 @@
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>
+ <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>
@@ -92,7 +94,8 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select></small>
+</optgroup></select>
+ </small>
</div>
<div id="subheader">
<h1>Contacts</h1>
@@ -242,17 +245,14 @@ clear and easy-to-understand user experi
contact data helps avoid user confusion and perceived misuse of
contact data. For more information, please see the <a href="guide_appdev_privacy_index.md.html#Privacy%20Guide">Privacy Guide</a>.</p>
-<h2>
-<a name="Contacts_methods">Methods</a>
-</h2>
+<h2><a name="Contacts_methods">Methods</a></h2>
<ul>
<li><a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a></li>
<li><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></li>
</ul>
-<h2>
-<a name="Contacts_arguments">Arguments</a>
-</h2>
+
+<h2><a name="Contacts_arguments">Arguments</a></h2>
<ul>
<li><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></li>
@@ -260,9 +260,8 @@ contact data. For more information, ple
<li><a href="cordova_contacts_contacts.md.html#contactError">contactError</a></li>
<li><a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a></li>
</ul>
-<h2>
-<a name="Contacts_objects">Objects</a>
-</h2>
+
+<h2><a name="Contacts_objects">Objects</a></h2>
<ul>
<li><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></li>
@@ -273,9 +272,8 @@ contact data. For more information, ple
<li><a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a></li>
<li><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></li>
</ul>
-<h2>
-<a name="Contacts_accessing_the_feature">Accessing the Feature</a>
-</h2>
+
+<h2><a name="Contacts_accessing_the_feature">Accessing the Feature</a></h2>
<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-Line%0AInterface">The Command-Line
@@ -370,10 +368,12 @@ which forbids inline scripts. Initialize
<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>
</li>
</ul>
+
<p>Some platforms may support this feature without requiring any special
configuration. See <a href="guide_support_index.md.html#Platform%20Support">Platform Support</a> for an overview.</p>
<hr>
+
<h1><a name="contacts.create">contacts.create</a></h1>
<p>Returns a new <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> object.</p>
@@ -381,18 +381,14 @@ configuration. See <a href="guide_suppo
<pre class="prettyprint"><code>var contact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>(properties);
</code></pre>
-<h2>
-<a name="contacts.create_description">Description</a>
-</h2>
+<h2><a name="contacts.create_description">Description</a></h2>
<p>The <code><a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a></code> method is synchronous, and returns a new <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object.</p>
<p>This method does not retain the <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> object in the device contacts
database, for which you need to invoke the <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a>.save</code> method.</p>
-<h2>
-<a name="contacts.create_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="contacts.create_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Android</li>
@@ -400,16 +396,13 @@ database, for which you need to invoke t
<li>iOS</li>
<li>Windows Phone 7 and 8</li>
</ul>
-<h2>
-<a name="contacts.create_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="contacts.create_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>var myContact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>({"displayName": "Test User"});
</code></pre>
-<h2>
-<a name="contacts.create_full_example">Full Example</a>
-</h2>
+<h2><a name="contacts.create_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -441,6 +434,7 @@ database, for which you need to invoke t
</code></pre>
<hr>
+
<h1><a name="contacts.find">contacts.find</a></h1>
<p>Queries the device contacts database and returns one or more <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code>
@@ -449,9 +443,7 @@ objects, each containing the fields spec
<pre class="prettyprint"><code>navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(<a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a>, <a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a>, <a href="cordova_contacts_contacts.md.html#contactError">contactError</a>, <a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a>);
</code></pre>
-<h2>
-<a name="contacts.find_description">Description</a>
-</h2>
+<h2><a name="contacts.find_description">Description</a></h2>
<p>The <code><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></code> method executes asynchronously, querying the
device contacts database and returning an array of <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> objects.
@@ -471,9 +463,7 @@ case-insensitive, partial value match is
specified in the <strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong> parameter. If there's a match for
<em>any</em> of the specified fields, the contact is returned.</p>
-<h2>
-<a name="contacts.find_parameters">Parameters</a>
-</h2>
+<h2><a name="contacts.find_parameters">Parameters</a></h2>
<ul>
<li><p><strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong>: <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> fields to use as a search qualifier. The resulting <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object only features values for these fields. <em>(DOMString[])</em> [Required]</p></li>
@@ -481,9 +471,8 @@ specified in the <strong><a href="cordov
<li><p><strong><a href="cordova_contacts_contacts.md.html#contactError">contactError</a></strong>: Error callback function, invoked when an error occurs. [Optional]</p></li>
<li><p><strong><a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a></strong>: Search options to filter contacts. [Optional]</p></li>
</ul>
-<h2>
-<a name="contacts.find_supported_platforms">Supported Platforms</a>
-</h2>
+
+<h2><a name="contacts.find_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Android</li>
@@ -492,9 +481,8 @@ specified in the <strong><a href="cordov
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="contacts.find_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="contacts.find_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>function onSuccess(contacts) {
alert('Found ' + contacts.length + ' contacts.');
@@ -512,9 +500,7 @@ var fields = ["displayName", "name
navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(fields, onSuccess, onError, options);
</code></pre>
-<h2>
-<a name="contacts.find_full_example">Full Example</a>
-</h2>
+<h2><a name="contacts.find_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -560,13 +546,12 @@ navigator.<a href="cordova_contacts_cont
</code></pre>
<hr>
+
<h1><a name="Contact">Contact</a></h1>
<p>Contains properties that describe a contact, such as a user's personal or business contact.</p>
-<h2>
-<a name="Contact_properties">Properties</a>
-</h2>
+<h2><a name="Contact_properties">Properties</a></h2>
<ul>
<li><p><strong>id</strong>: A globally unique identifier. <em>(DOMString)</em></p></li>
@@ -584,18 +569,16 @@ navigator.<a href="cordova_contacts_cont
<li><p><strong>categories</strong>: An array of all the user-defined categories associated with the contact. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em></p></li>
<li><p><strong>urls</strong>: An array of web pages associated with the contact. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em></p></li>
</ul>
-<h2>
-<a name="Contact_methods">Methods</a>
-</h2>
+
+<h2><a name="Contact_methods">Methods</a></h2>
<ul>
<li><p><strong>clone</strong>: Returns a new <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object that is a deep copy of the calling object, with the <code>id</code> property set to <code>null</code>.</p></li>
<li><p><strong>remove</strong>: Removes the contact from the device contacts database, otherwise executes an error callback with a <code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></code> object.</p></li>
<li><p><strong>save</strong>: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same <strong>id</strong> already exists.</p></li>
</ul>
-<h2>
-<a name="Contact_details">Details</a>
-</h2>
+
+<h2><a name="Contact_details">Details</a></h2>
<p>The <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object represents a user's contact. <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a> can be
created, stored, or removed from the device contacts database.
@@ -606,9 +589,7 @@ database by invoking the <code><a href="
every <a href="#device%20platform">device platform</a>. Please check each platform's <em>Quirks</em> section
for details.</p>
-<h2>
-<a name="Contact_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="Contact_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -618,9 +599,8 @@ for details.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="Contact_save_quick_example">Save Quick Example</a>
-</h2>
+
+<h2><a name="Contact_save_quick_example">Save Quick Example</a></h2>
<pre class="prettyprint"><code>function onSuccess(contact) {
alert("Save Success");
@@ -645,9 +625,7 @@ contact.name = name;
contact.save(onSuccess,onError);
</code></pre>
-<h2>
-<a name="Contact_clone_quick_example">Clone Quick Example</a>
-</h2>
+<h2><a name="Contact_clone_quick_example">Clone Quick Example</a></h2>
<pre class="prettyprint"><code> // clone the contact object
var clone = contact.clone();
@@ -656,9 +634,7 @@ contact.save(onSuccess,onError);
console.log("Cloned contact name = " + clone.name.givenName);
</code></pre>
-<h2>
-<a name="Contact_remove_quick_example">Remove Quick Example</a>
-</h2>
+<h2><a name="Contact_remove_quick_example">Remove Quick Example</a></h2>
<pre class="prettyprint"><code>function onSuccess() {
alert("Removal Success");
@@ -672,9 +648,7 @@ function onError(<a href="cordova_contac
contact.remove(onSuccess,onError);
</code></pre>
-<h2>
-<a name="Contact_full_example">Full Example</a>
-</h2>
+<h2><a name="Contact_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -746,17 +720,14 @@ function onError(<a href="cordova_contac
</html>
</code></pre>
-<h2>
-<a name="Contact_android_2_x_quirks">Android 2.X Quirks</a>
-</h2>
+<h2><a name="Contact_android_2_x_quirks">Android 2.X Quirks</a></h2>
<ul>
<li>
<strong>categories</strong>: Not supported on Android 2.X devices, returning <code>null</code>.</li>
</ul>
-<h2>
-<a name="Contact_blackberry_10_quirks">BlackBerry 10 Quirks</a>
-</h2>
+
+<h2><a name="Contact_blackberry_10_quirks">BlackBerry 10 Quirks</a></h2>
<ul>
<li><p><strong>id</strong>: Supported. Assigned by the device when saving the contact.</p></li>
@@ -771,9 +742,8 @@ function onError(<a href="cordova_contac
<li><p><strong>categories</strong>: Partially supported. Only <em>Business</em> and <em>Personal</em> categories are supported.</p></li>
<li><p><strong>urls</strong>: Partially supported. The first URL is stored in BlackBerry <strong>webpage</strong> field.</p></li>
</ul>
-<h2>
-<a name="Contact_ios_quirks">iOS Quirks</a>
-</h2>
+
+<h2><a name="Contact_ios_quirks">iOS Quirks</a></h2>
<ul>
<li><p><strong>displayName</strong>: Not supported on iOS, returning <code>null</code> unless there is no <code><a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a></code> specified, in which case it returns the composite name, <strong>nickname</strong> or <code>""</code>, respectively.</p></li>
@@ -781,9 +751,8 @@ function onError(<a href="cordova_contac
<li><p><strong>photos</strong>: Returns a <a href="cordova_file_file.md.html#File">File</a> URL to the image, which is stored in the application's temporary directory. Contents of the temporary directory are removed when the application exits.</p></li>
<li><p><strong>categories</strong>: This property is currently not supported, returning <code>null</code>.</p></li>
</ul>
-<h2>
-<a name="Contact_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
-</h2>
+
+<h2><a name="Contact_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a></h2>
<ul>
<li><p><strong>displayName</strong>: When creating a contact, the value provided for the display name parameter differs from the display name retrieved when finding the contact.</p></li>
@@ -797,14 +766,14 @@ function onError(<a href="cordova_contac
<li><p><strong>birthdays</strong>: Not supported, returning <code>null</code>.</p></li>
<li><p><strong>categories</strong>: Not supported, returning <code>null</code>.</p></li>
</ul>
+
<hr>
+
<h1><a name="ContactAddress">ContactAddress</a></h1>
<p>Contains address properties for a <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object.</p>
-<h2>
-<a name="ContactAddress_properties">Properties</a>
-</h2>
+<h2><a name="ContactAddress_properties">Properties</a></h2>
<ul>
<li><p><strong>pref</strong>: Set to <code>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a></code> contains the user's preferred value. <em>(boolean)</em></p></li>
@@ -816,17 +785,14 @@ function onError(<a href="cordova_contac
<li><p><strong>postalCode</strong>: The zip code or postal code. <em>(DOMString)</em></p></li>
<li><p><strong>country</strong>: The country name. <em>(DOMString)</em></p></li>
</ul>
-<h2>
-<a name="ContactAddress_details">Details</a>
-</h2>
+
+<h2><a name="ContactAddress_details">Details</a></h2>
<p>The <code><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a></code> object stores the properties of a single address
of a contact. A <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object may include more than one address in
a <code><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a>[]</code> array.</p>
-<h2>
-<a name="ContactAddress_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="ContactAddress_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -836,9 +802,8 @@ a <code><a href="cordova_contacts_contac
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="ContactAddress_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="ContactAddress_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>// display the address information for all contacts
@@ -868,9 +833,7 @@ var filter = ["displayName", "addresses"
navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
</code></pre>
-<h2>
-<a name="ContactAddress_full_example">Full Example</a>
-</h2>
+<h2><a name="ContactAddress_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -927,17 +890,14 @@ navigator.<a href="cordova_contacts_cont
</html>
</code></pre>
-<h2>
-<a name="ContactAddress_android_2_x_quirks">Android 2.X Quirks</a>
-</h2>
+<h2><a name="ContactAddress_android_2_x_quirks">Android 2.X Quirks</a></h2>
<ul>
<li>
<strong>pref</strong>: Not supported, returning <code>false</code> on Android 2.X devices.</li>
</ul>
-<h2>
-<a name="ContactAddress_blackberry_10_quirks">BlackBerry 10 Quirks</a>
-</h2>
+
+<h2><a name="ContactAddress_blackberry_10_quirks">BlackBerry 10 Quirks</a></h2>
<ul>
<li><p><strong>pref</strong>: Not supported on BlackBerry devices, returning <code>false</code>.</p></li>
@@ -949,33 +909,31 @@ navigator.<a href="cordova_contacts_cont
<li><p><strong>postalCode</strong>: Supported. Stored in BlackBerry <strong>zipPostal</strong> address field.</p></li>
<li><p><strong>country</strong>: Supported.</p></li>
</ul>
-<h2>
-<a name="ContactAddress_ios_quirks">iOS Quirks</a>
-</h2>
+
+<h2><a name="ContactAddress_ios_quirks">iOS Quirks</a></h2>
<ul>
<li><p><strong>pref</strong>: Not supported on iOS devices, returning <code>false</code>.</p></li>
<li><p><strong>formatted</strong>: Currently not supported.</p></li>
</ul>
+
<hr>
+
<h1><a name="ContactField">ContactField</a></h1>
<p>Supports generic fields in a <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object. Some properties stored
as <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> objects include email addresses, phone numbers, and
URLs.</p>
-<h2>
-<a name="ContactField_properties">Properties</a>
-</h2>
+<h2><a name="ContactField_properties">Properties</a></h2>
<ul>
<li><p><strong>type</strong>: A string that indicates what type of field this is, <em>home</em> for example. <em>(DOMString)</em></p></li>
<li><p><strong>value</strong>: The value of the field, such as a phone number or email address. <em>(DOMString)</em></p></li>
<li><p><strong>pref</strong>: Set to <code>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> contains the user's preferred value. <em>(boolean)</em></p></li>
</ul>
-<h2>
-<a name="ContactField_details">Details</a>
-</h2>
+
+<h2><a name="ContactField_details">Details</a></h2>
<p>The <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> object is a reusable component that represents
contact fields generically. Each <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> object contains a
@@ -993,9 +951,7 @@ field, the <strong>type</strong> field i
image, or <em>base64</em> when the <strong>value</strong> contains a base64-encoded image
string.</p>
-<h2>
-<a name="ContactField_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="ContactField_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -1005,9 +961,8 @@ string.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="ContactField_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="ContactField_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code> // create a new contact
var contact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>();
@@ -1023,9 +978,7 @@ string.</p>
contact.save();
</code></pre>
-<h2>
-<a name="ContactField_full_example">Full Example</a>
-</h2>
+<h2><a name="ContactField_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -1091,47 +1044,42 @@ string.</p>
</html>
</code></pre>
-<h2>
-<a name="ContactField_android_quirks">Android Quirks</a>
-</h2>
+<h2><a name="ContactField_android_quirks">Android Quirks</a></h2>
<ul>
<li>
<strong>pref</strong>: Not supported, returning <code>false</code>.</li>
</ul>
-<h2>
-<a name="ContactField_blackberry_10_quirks">BlackBerry 10 Quirks</a>
-</h2>
+
+<h2><a name="ContactField_blackberry_10_quirks">BlackBerry 10 Quirks</a></h2>
<ul>
<li><p><strong>type</strong>: Partially supported. Used for phone numbers.</p></li>
<li><p><strong>value</strong>: Supported.</p></li>
<li><p><strong>pref</strong>: Not supported, returning <code>false</code>.</p></li>
</ul>
-<h2>
-<a name="ContactField_ios_quirks">iOS Quirks</a>
-</h2>
+
+<h2><a name="ContactField_ios_quirks">iOS Quirks</a></h2>
<ul>
<li>
<strong>pref</strong>: Not supported, returning <code>false</code>.</li>
</ul>
+
<hr>
+
<h1><a name="ContactFindOptions">ContactFindOptions</a></h1>
<p>Contains properties that can be used to filter the results of a <code><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></code> operation.</p>
-<h2>
-<a name="ContactFindOptions_properties">Properties</a>
-</h2>
+<h2><a name="ContactFindOptions_properties">Properties</a></h2>
<ul>
<li><p><strong>filter</strong>: The search string used to find contacts. <em>(DOMString)</em> (Default: <code>""</code>)</p></li>
<li><p><strong>multiple</strong>: Determines if the find operation returns multiple contacts. <em>(Boolean)</em> (Default: <code>false</code>)</p></li>
</ul>
-<h2>
-<a name="ContactFindOptions_supported_platforms">Supported Platforms</a>
-</h2>
+
+<h2><a name="ContactFindOptions_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Android</li>
@@ -1140,9 +1088,8 @@ string.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="ContactFindOptions_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="ContactFindOptions_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>// success callback
function onSuccess(contacts) {
@@ -1166,9 +1113,7 @@ var options = new <a href="cordova_conta
navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
</code></pre>
-<h2>
-<a name="ContactFindOptions_full_example">Full Example</a>
-</h2>
+<h2><a name="ContactFindOptions_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -1219,13 +1164,12 @@ navigator.<a href="cordova_contacts_cont
</code></pre>
<hr>
+
<h1><a name="ContactName">ContactName</a></h1>
<p>Contains different kinds of information about a <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object's name.</p>
-<h2>
-<a name="ContactName_properties">Properties</a>
-</h2>
+<h2><a name="ContactName_properties">Properties</a></h2>
<ul>
<li><p><strong>formatted</strong>: The complete name of the contact. <em>(DOMString)</em></p></li>
@@ -1235,15 +1179,12 @@ navigator.<a href="cordova_contacts_cont
<li><p><strong>honorificPrefix</strong>: The contact's prefix (example <em>Mr.</em> or <em>Dr.</em>) <em>(DOMString)</em></p></li>
<li><p><strong>honorificSuffix</strong>: The contact's suffix (example <em>Esq.</em>). <em>(DOMString)</em></p></li>
</ul>
-<h2>
-<a name="ContactName_details">Details</a>
-</h2>
+
+<h2><a name="ContactName_details">Details</a></h2>
<p>The <code><a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a></code> object stores a contact's name properties.</p>
-<h2>
-<a name="ContactName_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="ContactName_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Amazon Fire OS</li>
@@ -1253,9 +1194,8 @@ navigator.<a href="cordova_contacts_cont
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="ContactName_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="ContactName_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>function onSuccess(contacts) {
for (var i = 0; i < contacts.length; i++) {
@@ -1278,9 +1218,7 @@ filter = ["displayName", "name"];
navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
</code></pre>
-<h2>
-<a name="ContactName_full_example">Full Example</a>
-</h2>
+<h2><a name="ContactName_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -1331,17 +1269,14 @@ navigator.<a href="cordova_contacts_cont
</html>
</code></pre>
-<h2>
-<a name="ContactName_android_quirks">Android Quirks</a>
-</h2>
+<h2><a name="ContactName_android_quirks">Android Quirks</a></h2>
<ul>
<li>
<strong>formatted</strong>: Partially supported, and read-only. Returns a concatenation of <code>honorificPrefix</code>, <code>givenName</code>, <code>middleName</code>, <code>familyName</code>, and <code>honorificSuffix</code>.</li>
</ul>
-<h2>
-<a name="ContactName_blackberry_10_quirks">BlackBerry 10 Quirks</a>
-</h2>
+
+<h2><a name="ContactName_blackberry_10_quirks">BlackBerry 10 Quirks</a></h2>
<ul>
<li><p><strong>formatted</strong>: Partially supported. Returns a concatenation of BlackBerry <strong>firstName</strong> and <strong>lastName</strong> fields.</p></li>
@@ -1351,22 +1286,21 @@ navigator.<a href="cordova_contacts_cont
<li><p><strong>honorificPrefix</strong>: Not supported, returning <code>null</code>.</p></li>
<li><p><strong>honorificSuffix</strong>: Not supported, returning <code>null</code>.</p></li>
</ul>
-<h2>
-<a name="ContactName_ios_quirks">iOS Quirks</a>
-</h2>
+
+<h2><a name="ContactName_ios_quirks">iOS Quirks</a></h2>
<ul>
<li>
<strong>formatted</strong>: Partially supported. Returns iOS Composite Name, but is read-only.</li>
</ul>
+
<hr>
+
<h1><a name="ContactOrganization">ContactOrganization</a></h1>
<p>Contains a <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object's organization properties.</p>
-<h2>
-<a name="ContactOrganization_properties">Properties</a>
-</h2>
+<h2><a name="ContactOrganization_properties">Properties</a></h2>
<ul>
<li><p><strong>pref</strong>: Set to <code>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a></code> contains the user's preferred value. <em>(boolean)</em></p></li>
@@ -1375,17 +1309,14 @@ navigator.<a href="cordova_contacts_cont
<li><p><strong>department</strong>: The department the contract works for. <em>(DOMString)</em></p></li>
<li><p><strong>title</strong>: The contact's title at the organization. <em>(DOMString)</em></p></li>
</ul>
-<h2>
-<a name="ContactOrganization_details">Details</a>
-</h2>
+
+<h2><a name="ContactOrganization_details">Details</a></h2>
<p>The <code><a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a></code> object stores a contact's organization
properties. A <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object stores one or more
<code><a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a></code> objects in an array.</p>
-<h2>
-<a name="ContactOrganization_supported_platforms">Supported Platforms</a>
-</h2>
+<h2><a name="ContactOrganization_supported_platforms">Supported Platforms</a></h2>
<ul>
<li>Android</li>
@@ -1394,9 +1325,8 @@ properties. A <code><a href="cordova_co
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-<h2>
-<a name="ContactOrganization_quick_example">Quick Example</a>
-</h2>
+
+<h2><a name="ContactOrganization_quick_example">Quick Example</a></h2>
<pre class="prettyprint"><code>function onSuccess(contacts) {
for (var i = 0; i < contacts.length; i++) {
@@ -1420,9 +1350,7 @@ filter = ["displayName", "organizations"
navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
</code></pre>
-<h2>
-<a name="ContactOrganization_full_example">Full Example</a>
-</h2>
+<h2><a name="ContactOrganization_full_example">Full Example</a></h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -1474,17 +1402,14 @@ navigator.<a href="cordova_contacts_cont
</html>
</code></pre>
-<h2>
-<a name="ContactOrganization_android_2_x_quirks">Android 2.X Quirks</a>
-</h2>
+<h2><a name="ContactOrganization_android_2_x_quirks">Android 2.X Quirks</a></h2>
<ul>
<li>
<strong>pref</strong>: Not supported by Android 2.X devices, returning <code>false</code>.</li>
</ul>
-<h2>
-<a name="ContactOrganization_blackberry_10_quirks">BlackBerry 10 Quirks</a>
-</h2>
+
+<h2><a name="ContactOrganization_blackberry_10_quirks">BlackBerry 10 Quirks</a></h2>
<ul>
<li><p><strong>pref</strong>: Not supported by BlackBerry devices, returning <code>false</code>.</p></li>
@@ -1493,9 +1418,8 @@ navigator.<a href="cordova_contacts_cont
<li><p><strong>department</strong>: Not supported, returning <code>null</code>.</p></li>
<li><p><strong>title</strong>: Partially supported. The first organization title is stored in the BlackBerry <strong>jobTitle</strong> field.</p></li>
</ul>
-<h2>
-<a name="ContactOrganization_ios_quirks">iOS Quirks</a>
-</h2>
+
+<h2><a name="ContactOrganization_ios_quirks">iOS Quirks</a></h2>
<ul>
<li><p><strong>pref</strong>: Not supported on iOS devices, returning <code>false</code>.</p></li>
@@ -1504,22 +1428,21 @@ navigator.<a href="cordova_contacts_cont
<li><p><strong>department</strong>: Partially supported. The first department name is stored in the iOS <strong>kABPersonDepartmentProperty</strong> field.</p></li>
<li><p><strong>title</strong>: Partially supported. The first title is stored in the iOS <strong>kABPersonJobTitleProperty</strong> field.</p></li>
</ul>
+
<hr>
+
<h1><a name="ContactError">ContactError</a></h1>
<p>A <code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></code> object is passed to the <code><a href="cordova_contacts_contacts.md.html#contactError">contactError</a></code> callback when an error occurs.</p>
-<h2>
-<a name="ContactError_properties">Properties</a>
-</h2>
+<h2><a name="ContactError_properties">Properties</a></h2>
<ul>
<li>
<strong>code</strong>: One of the predefined error codes listed below.</li>
</ul>
-<h2>
-<a name="ContactError_constants">Constants</a>
-</h2>
+
+<h2><a name="ContactError_constants">Constants</a></h2>
<ul>
<li><code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a>.UNKNOWN_ERROR</code></li>
@@ -1530,14 +1453,14 @@ navigator.<a href="cordova_contacts_cont
<li><code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a>.NOT_SUPPORTED_ERROR</code></li>
<li><code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a>.PERMISSION_DENIED_ERROR</code></li>
</ul>
-<h2>
-<a name="ContactError_description">Description</a>
-</h2>
+
+<h2><a name="ContactError_description">Description</a></h2>
<p>The <code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></code> object is returned to the user through the
<code><a href="cordova_contacts_contacts.md.html#contactError">contactError</a></code> callback function when an error occurs.</p>
<hr>
+
<h1><a name="contactSuccess">contactSuccess</a></h1>
<p>Success callback function that provides the <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> array resulting from a <code><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></code> operation.</p>
@@ -1547,18 +1470,15 @@ navigator.<a href="cordova_contacts_cont
}
</code></pre>
-<h2>
-<a name="contactSuccess_parameters">Parameters</a>
-</h2>
+<h2><a name="contactSuccess_parameters">Parameters</a></h2>
<ul>
<li>
<strong>contacts</strong>: The contact array resulting from a find operation. <em>(<a href="cordova_contacts_contacts.md.html#Contact">Contact</a>)</em>
</li>
</ul>
-<h2>
-<a name="contactSuccess_example">Example</a>
-</h2>
+
+<h2><a name="contactSuccess_example">Example</a></h2>
<pre class="prettyprint"><code>function <a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a>(contacts) {
for (var i=0; i<contacts.length; i++) {
@@ -1568,6 +1488,7 @@ navigator.<a href="cordova_contacts_cont
</code></pre>
<hr>
+
<h1><a name="contactError">contactError</a></h1>
<p>Error callback function for contact functions.</p>
@@ -1578,6 +1499,7 @@ navigator.<a href="cordova_contacts_cont
</code></pre>
<hr>
+
<h1><a name="contactFields">contactFields</a></h1>
<p>Required parameter for the <code><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></code> method, used to specify which fields should be included in the <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> objects resulting from a find operation.</p>
@@ -1586,6 +1508,7 @@ navigator.<a href="cordova_contacts_cont
</code></pre>
<hr>
+
<h1><a name="contactFindOptions">contactFindOptions</a></h1>
<p>Optional parameter of the <code><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></code> method, used to filter the
@@ -1597,18 +1520,18 @@ contacts returned from the contacts data
};
</code></pre>
-<h2>
-<a name="contactFindOptions_options">Options</a>
-</h2>
+<h2><a name="contactFindOptions_options">Options</a></h2>
<ul>
<li><p><strong>filter</strong>: The search string used to filter contacts. <em>(DOMString)</em> (Default: <code>""</code>)</p></li>
<li><p><strong>multiple</strong>: Determines if the find operation returns multiple contacts. <em>(Boolean)</em> (Default: <code>false</code>)</p></li>
</ul>
-</div>
+
+ </div>
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
-</body>
+ <script type="text/javascript" src="index.js"></script>
+ <script type="text/javascript" src="prettify/prettify.js"></script>
+ </body>
</html>