You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2013/12/18 16:40:09 UTC
svn commit: r1551982 [11/18] - in /cordova/site/public/docs/en: 3.0.0/
3.3.0/ edge/
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=1551982&r1=1551981&r2=1551982&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 Wed Dec 18 15:40:06 2013
@@ -17,18 +17,16 @@
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>
@@ -94,8 +92,7 @@
<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>
@@ -245,14 +242,17 @@ 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,8 +260,9 @@ 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>
@@ -272,8 +273,9 @@ 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
@@ -368,12 +370,10 @@ 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,14 +381,18 @@ 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>
@@ -396,13 +400,16 @@ 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>
@@ -434,7 +441,6 @@ 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>
@@ -443,7 +449,9 @@ 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.
@@ -463,7 +471,9 @@ 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>
@@ -471,8 +481,9 @@ 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>
@@ -481,8 +492,9 @@ 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.');
@@ -500,7 +512,9 @@ 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>
@@ -546,12 +560,13 @@ 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>
@@ -569,16 +584,18 @@ 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.
@@ -589,7 +606,9 @@ 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>
@@ -599,8 +618,9 @@ 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");
@@ -625,7 +645,9 @@ 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();
@@ -634,7 +656,9 @@ 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");
@@ -648,7 +672,9 @@ 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>
@@ -720,14 +746,17 @@ 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>
@@ -742,8 +771,9 @@ 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>
@@ -751,8 +781,9 @@ 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>
@@ -766,14 +797,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>
@@ -785,14 +816,17 @@ 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>
@@ -802,8 +836,9 @@ 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
@@ -833,7 +868,9 @@ 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>
@@ -890,14 +927,17 @@ 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>
@@ -909,31 +949,33 @@ 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
@@ -951,7 +993,9 @@ 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>
@@ -961,8 +1005,9 @@ 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>();
@@ -978,7 +1023,9 @@ 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>
@@ -1044,42 +1091,47 @@ 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>
@@ -1088,8 +1140,9 @@ 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) {
@@ -1113,7 +1166,9 @@ 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>
@@ -1164,12 +1219,13 @@ 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>
@@ -1179,12 +1235,15 @@ 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>
@@ -1194,8 +1253,9 @@ 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++) {
@@ -1218,7 +1278,9 @@ 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>
@@ -1269,14 +1331,17 @@ 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>
@@ -1286,21 +1351,22 @@ 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>
@@ -1309,14 +1375,17 @@ 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>
@@ -1325,8 +1394,9 @@ 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++) {
@@ -1350,7 +1420,9 @@ 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>
@@ -1402,14 +1474,17 @@ 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>
@@ -1418,8 +1493,9 @@ 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>
@@ -1428,21 +1504,22 @@ 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>
@@ -1453,14 +1530,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>
@@ -1470,15 +1547,18 @@ 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++) {
@@ -1488,7 +1568,6 @@ navigator.<a href="cordova_contacts_cont
</code></pre>
<hr>
-
<h1><a name="contactError">contactError</a></h1>
<p>Error callback function for contact functions.</p>
@@ -1499,7 +1578,6 @@ 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>
@@ -1508,7 +1586,6 @@ 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
@@ -1520,18 +1597,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>
Modified: cordova/site/public/docs/en/edge/cordova_device_device.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_device_device.md.html?rev=1551982&r1=1551981&r2=1551982&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_device_device.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_device_device.md.html Wed Dec 18 15:40:06 2013
@@ -17,18 +17,16 @@
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>
@@ -94,8 +92,7 @@
<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>Device</h1>
@@ -189,7 +186,9 @@
<p>The <code>device</code> object describes the device's hardware and software.</p>
</blockquote>
-<h2><a name="Device_properties">Properties</a></h2>
+<h2>
+<a name="Device_properties">Properties</a>
+</h2>
<ul>
<li><a href="cordova_device_device.md.html#device.model">device.model</a></li>
@@ -199,8 +198,9 @@
<li><a href="cordova_device_device.md.html#device.version">device.version</a></li>
<li><a href="cordova_device_device.md.html#device.name">device.name</a></li>
</ul>
-
-<h2><a name="Device_variable_scope">Variable Scope</a></h2>
+<h2>
+<a name="Device_variable_scope">Variable Scope</a>
+</h2>
<p>Since <code>device</code> is assigned to the <code>window</code> object, it is implicitly in the global scope.</p>
@@ -209,7 +209,9 @@ var phoneModel = window.<a href="cordova
var phoneModel = <a href="cordova_device_device.md.html#device.model">device.model</a>;
</code></pre>
-<h2><a name="Device_accessing_the_feature">Accessing the Feature</a></h2>
+<h2>
+<a name="Device_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
@@ -274,12 +276,10 @@ 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="device.model">device.model</a></h1>
<p>Get the device's model name.</p>
@@ -287,13 +287,17 @@ configuration. See <a href="guide_suppo
<pre class="prettyprint"><code>var string = <a href="cordova_device_device.md.html#device.model">device.model</a>;
</code></pre>
-<h2><a name="device.model_description">Description</a></h2>
+<h2>
+<a name="device.model_description">Description</a>
+</h2>
<p>The <code><a href="cordova_device_device.md.html#device.model">device.model</a></code> returns the name of the device's model or
product. The value is set by the device manufacturer and may be
different across versions of the same product.</p>
-<h2><a name="device.model_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="device.model_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Android</li>
@@ -303,8 +307,9 @@ different across versions of the same pr
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="device.model_quick_example">Quick Example</a></h2>
+<h2>
+<a name="device.model_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// Android: Nexus One returns "Passion" (Nexus One code name)
// Motorola Droid returns "voles"
@@ -314,7 +319,9 @@ different across versions of the same pr
var model = <a href="cordova_device_device.md.html#device.model">device.model</a>;
</code></pre>
-<h2><a name="device.model_full_example">Full Example</a></h2>
+<h2>
+<a name="device.model_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -347,27 +354,29 @@ var model = <a href="cordova_device_devi
</html>
</code></pre>
-<h2><a name="device.model_android_quirks">Android Quirks</a></h2>
+<h2>
+<a name="device.model_android_quirks">Android Quirks</a>
+</h2>
<ul>
<li>Gets the <a class="external" href="http://developer.android.com/reference/android/os/Build.html#PRODUCT">product name</a> instead of the <a class="external" href="http://developer.android.com/reference/android/os/Build.html#MODEL">model name</a>, which is often the production code name. For example, the Nexus One returns <code>Passion</code>, and Motorola Droid returns <code>voles</code>.</li>
</ul>
-
-<h2><a name="device.model_tizen_quirks">Tizen Quirks</a></h2>
+<h2>
+<a name="device.model_tizen_quirks">Tizen Quirks</a>
+</h2>
<ul>
<li>Returns the <a href="#device%20model">device model</a> assigned by the vendor, for example, <code>TIZEN</code>
</li>
</ul>
-
-<h2><a name="device.model_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a></h2>
+<h2>
+<a name="device.model_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
+</h2>
<ul>
<li>Returns the <a href="#device%20model">device model</a> specified by the manufacturer. For example, the Samsung Focus returns <code>SGH-i917</code>.</li>
</ul>
-
<hr>
-
<h1><a name="device.cordova">device.cordova</a></h1>
<p>Get the version of Cordova running on the device.</p>
@@ -375,11 +384,15 @@ var model = <a href="cordova_device_devi
<pre class="prettyprint"><code>var string = <a href="cordova_device_device.md.html#device.cordova">device.cordova</a>;
</code></pre>
-<h2><a name="device.cordova_description">Description</a></h2>
+<h2>
+<a name="device.cordova_description">Description</a>
+</h2>
<p><code><a href="cordova_device_device.md.html#device.cordova">device.cordova</a></code> returns the version of Cordova running on the device.</p>
-<h2><a name="device.cordova_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="device.cordova_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -390,13 +403,16 @@ var model = <a href="cordova_device_devi
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="device.cordova_quick_example">Quick Example</a></h2>
+<h2>
+<a name="device.cordova_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>var name = <a href="cordova_device_device.md.html#device.cordova">device.cordova</a>;
</code></pre>
-<h2><a name="device.cordova_full_example">Full Example</a></h2>
+<h2>
+<a name="device.cordova_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -430,7 +446,6 @@ var model = <a href="cordova_device_devi
</code></pre>
<hr>
-
<h1><a name="device.platform">device.platform</a></h1>
<p>Get the device's operating system name.</p>
@@ -438,7 +453,9 @@ var model = <a href="cordova_device_devi
<pre class="prettyprint"><code>var string = <a href="cordova_device_device.md.html#device.platform">device.platform</a>;
</code></pre>
-<h2><a name="device.platform_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="device.platform_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Android</li>
@@ -448,8 +465,9 @@ var model = <a href="cordova_device_devi
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="device.platform_quick_example">Quick Example</a></h2>
+<h2>
+<a name="device.platform_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// Depending on the device, a few examples are:
// - "Android"
@@ -460,7 +478,9 @@ var model = <a href="cordova_device_devi
var devicePlatform = <a href="cordova_device_device.md.html#device.platform">device.platform</a>;
</code></pre>
-<h2><a name="device.platform_full_example">Full Example</a></h2>
+<h2>
+<a name="device.platform_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -493,16 +513,19 @@ var devicePlatform = <a href="cordova_de
</html>
</code></pre>
-<h2><a name="device.platform_windows_phone_7_quirks">Windows Phone 7 Quirks</a></h2>
+<h2>
+<a name="device.platform_windows_phone_7_quirks">Windows Phone 7 Quirks</a>
+</h2>
<p>Windows Phone 7 devices report the platform as <code>WinCE</code>.</p>
-<h2><a name="device.platform_windows_phone_8_quirks">Windows Phone 8 Quirks</a></h2>
+<h2>
+<a name="device.platform_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
<p>Windows Phone 8 devices report the platform as <code>Win32NT</code>.</p>
<hr>
-
<h1><a name="device.uuid">device.uuid</a></h1>
<p>Get the device's Universally Unique Identifier (<a class="external" href="http://en.wikipedia.org/wiki/Universally_Unique_Identifier">UUID</a>).</p>
@@ -510,11 +533,15 @@ var devicePlatform = <a href="cordova_de
<pre class="prettyprint"><code>var string = <a href="cordova_device_device.md.html#device.uuid">device.uuid</a>;
</code></pre>
-<h2><a name="device.uuid_description">Description</a></h2>
+<h2>
+<a name="device.uuid_description">Description</a>
+</h2>
<p>The details of how a UUID is generated are determined by the device manufacturer and are specific to the device's platform or model.</p>
-<h2><a name="device.uuid_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="device.uuid_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Android</li>
@@ -524,8 +551,9 @@ var devicePlatform = <a href="cordova_de
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="device.uuid_quick_example">Quick Example</a></h2>
+<h2>
+<a name="device.uuid_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// Android: Returns a random 64-bit integer (as a string, again!)
// The integer is generated on the device's first boot
@@ -544,7 +572,9 @@ var devicePlatform = <a href="cordova_de
var deviceID = <a href="cordova_device_device.md.html#device.uuid">device.uuid</a>;
</code></pre>
-<h2><a name="device.uuid_full_example">Full Example</a></h2>
+<h2>
+<a name="device.uuid_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -577,7 +607,9 @@ var deviceID = <a href="cordova_device_d
</html>
</code></pre>
-<h2><a name="device.uuid_ios_quirk">iOS Quirk</a></h2>
+<h2>
+<a name="device.uuid_ios_quirk">iOS Quirk</a>
+</h2>
<p>The <code>uuid</code> on iOS is not unique to a device, but varies for each
application, for each installation. It changes if you delete and
@@ -585,7 +617,9 @@ re-install the app, and possibly also wh
upgrade the app per version (apparent in iOS 5.1). The <code>uuid</code> is not
a reliable value.</p>
-<h2><a name="device.uuid_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a></h2>
+<h2>
+<a name="device.uuid_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
+</h2>
<p>The <code>uuid</code> for Windows Phone 7 requires the permission
<code>ID_CAP_IDENTITY_DEVICE</code>. Microsoft will likely deprecate this
@@ -594,7 +628,6 @@ generates a persistent guid that is main
application's installation on the device.</p>
<hr>
-
<h1><a name="device.version">device.version</a></h1>
<p>Get the operating system version.</p>
@@ -602,7 +635,9 @@ application's installation on the device
<pre class="prettyprint"><code>var string = <a href="cordova_device_device.md.html#device.version">device.version</a>;
</code></pre>
-<h2><a name="device.version_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="device.version_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Android 2.1+</li>
@@ -612,8 +647,9 @@ application's installation on the device
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="device.version_quick_example">Quick Example</a></h2>
+<h2>
+<a name="device.version_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// Android: Froyo OS would return "2.2"
// Eclair OS would return "2.1", "2.0.1", or "2.0"
@@ -628,7 +664,9 @@ application's installation on the device
var deviceVersion = <a href="cordova_device_device.md.html#device.version">device.version</a>;
</code></pre>
-<h2><a name="device.version_full_example">Full Example</a></h2>
+<h2>
+<a name="device.version_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -662,7 +700,6 @@ var deviceVersion = <a href="cordova_dev
</code></pre>
<hr>
-
<h1><a name="device.name">device.name</a></h1>
<p><strong>WARNING</strong>: <code><a href="cordova_device_device.md.html#device.name">device.name</a></code> is deprecated as of version 2.3.0. Use <code><a href="cordova_device_device.md.html#device.model">device.model</a></code> instead.</p>
@@ -672,13 +709,17 @@ var deviceVersion = <a href="cordova_dev
<pre class="prettyprint"><code>var string = <a href="cordova_device_device.md.html#device.name">device.name</a>;
</code></pre>
-<h2><a name="device.name_description">Description</a></h2>
+<h2>
+<a name="device.name_description">Description</a>
+</h2>
<p><code><a href="cordova_device_device.md.html#device.name">device.name</a></code> returns the name of the device's model or product. This
value is set by the device manufacturer and may be different across
versions of the same product.</p>
-<h2><a name="device.name_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="device.name_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Android</li>
@@ -688,8 +729,9 @@ versions of the same product.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="device.name_quick_example">Quick Example</a></h2>
+<h2>
+<a name="device.name_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// Android: Nexus One returns "Passion" (Nexus One code name)
// Motorola Droid returns "voles"
@@ -699,7 +741,9 @@ versions of the same product.</p>
var name = <a href="cordova_device_device.md.html#device.name">device.name</a>;
</code></pre>
-<h2><a name="device.name_full_example">Full Example</a></h2>
+<h2>
+<a name="device.name_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -733,30 +777,32 @@ var name = <a href="cordova_device_devic
</html>
</code></pre>
-<h2><a name="device.name_android_quirks">Android Quirks</a></h2>
+<h2>
+<a name="device.name_android_quirks">Android Quirks</a>
+</h2>
<ul>
<li>Gets the <a class="external" href="http://developer.android.com/reference/android/os/Build.html#PRODUCT">product name</a> instead of the <a class="external" href="http://developer.android.com/reference/android/os/Build.html#MODEL">model name</a>, which is often the production code name. For example, the Nexus One returns <code>Passion</code>, and Motorola Droid returns <code>voles</code>.</li>
</ul>
-
-<h2><a name="device.name_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a></h2>
+<h2>
+<a name="device.name_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
+</h2>
<ul>
<li>Returns the <a href="#device%20model">device model</a> specified by the manufacturer. For example, the Samsung Focus returns <code>SGH-i917</code>.</li>
</ul>
-
-<h2><a name="device.name_tizen_quirks">Tizen Quirks</a></h2>
+<h2>
+<a name="device.name_tizen_quirks">Tizen Quirks</a>
+</h2>
<ul>
<li>Returns the <a href="#device%20model">device model</a> assigned by the vendor, for example, <code>TIZEN</code>
</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>