Modified: cordova/site/public/docs/en/dev/reference/cordova-plugin-contacts/index.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/reference/cordova-plugin-contacts/index.html?rev=1752402&r1=1752401&r2=1752402&view=diff ============================================================================== --- cordova/site/public/docs/en/dev/reference/cordova-plugin-contacts/index.html (original) +++ cordova/site/public/docs/en/dev/reference/cordova-plugin-contacts/index.html Wed Jul 13 11:51:10 2016 @@ -6,12 +6,12 @@ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <meta name="format-detection" content="telephone=no"> <meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width" /> - <meta name="description" content=" "> + <meta name="description" content="Manage the contacts on the device. "> <title> - cordova-plugin-contacts - Apache Cordova + Contacts - Apache Cordova </title> @@ -732,7 +732,7 @@ <li> <a class="" href="../../reference/cordova-plugin-battery-status/index.html"> - cordova-plugin-battery-status + Battery Status </a> @@ -747,7 +747,7 @@ <li> <a class="" href="../../reference/cordova-plugin-camera/index.html"> - cordova-plugin-camera + Camera </a> @@ -762,7 +762,7 @@ <li> <a class="" href="../../reference/cordova-plugin-console/index.html"> - cordova-plugin-console + Console </a> @@ -777,7 +777,7 @@ <li> <a class="this-page" href="../../reference/cordova-plugin-contacts/index.html"> - cordova-plugin-contacts + Contacts </a> <span class="entry-highlight"></span> @@ -794,7 +794,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device/index.html"> - cordova-plugin-device + Device </a> @@ -809,7 +809,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device-motion/index.html"> - cordova-plugin-device-motion + Device Motion </a> @@ -824,7 +824,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device-orientation/index.html"> - cordova-plugin-device-orientation + Device Orientation </a> @@ -839,7 +839,7 @@ <li> <a class="" href="../../reference/cordova-plugin-dialogs/index.html"> - cordova-plugin-dialogs + Dialogs </a> @@ -854,7 +854,7 @@ <li> <a class="" href="../../reference/cordova-plugin-file/index.html"> - cordova-plugin-file + File </a> @@ -869,7 +869,7 @@ <li> <a class="" href="../../reference/cordova-plugin-file-transfer/index.html"> - cordova-plugin-file-transfer + File Transfer </a> @@ -884,7 +884,7 @@ <li> <a class="" href="../../reference/cordova-plugin-geolocation/index.html"> - cordova-plugin-geolocation + Geolocation </a> @@ -899,7 +899,7 @@ <li> <a class="" href="../../reference/cordova-plugin-globalization/index.html"> - cordova-plugin-globalization + Globalization </a> @@ -914,7 +914,7 @@ <li> <a class="" href="../../reference/cordova-plugin-inappbrowser/index.html"> - cordova-plugin-inappbrowser + Inappbrowser </a> @@ -929,7 +929,7 @@ <li> <a class="" href="../../reference/cordova-plugin-media/index.html"> - cordova-plugin-media + Media </a> @@ -944,7 +944,7 @@ <li> <a class="" href="../../reference/cordova-plugin-media-capture/index.html"> - cordova-plugin-media-capture + Media Capture </a> @@ -959,7 +959,7 @@ <li> <a class="" href="../../reference/cordova-plugin-network-information/index.html"> - cordova-plugin-network-information + Network Information </a> @@ -974,7 +974,7 @@ <li> <a class="" href="../../reference/cordova-plugin-splashscreen/index.html"> - cordova-plugin-splashscreen + Splashscreen </a> @@ -989,7 +989,7 @@ <li> <a class="" href="../../reference/cordova-plugin-vibration/index.html"> - cordova-plugin-vibration + Vibration </a> @@ -1004,7 +1004,7 @@ <li> <a class="" href="../../reference/cordova-plugin-statusbar/index.html"> - cordova-plugin-statusbar + Statusbar </a> @@ -1019,7 +1019,7 @@ <li> <a class="" href="../../reference/cordova-plugin-whitelist/index.html"> - cordova-plugin-whitelist + Whitelist </a> @@ -1034,7 +1034,7 @@ <li> <a class="" href="../../reference/cordova-plugin-legacy-whitelist/index.html"> - cordova-plugin-legacy-whitelist + Legacy Whitelist </a> @@ -1388,7 +1388,7 @@ <li> <a class="" href="../../reference/cordova-plugin-battery-status/index.html"> - cordova-plugin-battery-status + Battery Status </a> </li> @@ -1397,7 +1397,7 @@ <li> <a class="" href="../../reference/cordova-plugin-camera/index.html"> - cordova-plugin-camera + Camera </a> </li> @@ -1406,7 +1406,7 @@ <li> <a class="" href="../../reference/cordova-plugin-console/index.html"> - cordova-plugin-console + Console </a> </li> @@ -1415,7 +1415,7 @@ <li> <a class="this-page" href="../../reference/cordova-plugin-contacts/index.html"> - cordova-plugin-contacts + Contacts </a> </li> @@ -1424,7 +1424,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device/index.html"> - cordova-plugin-device + Device </a> </li> @@ -1433,7 +1433,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device-motion/index.html"> - cordova-plugin-device-motion + Device Motion </a> </li> @@ -1442,7 +1442,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device-orientation/index.html"> - cordova-plugin-device-orientation + Device Orientation </a> </li> @@ -1451,7 +1451,7 @@ <li> <a class="" href="../../reference/cordova-plugin-dialogs/index.html"> - cordova-plugin-dialogs + Dialogs </a> </li> @@ -1460,7 +1460,7 @@ <li> <a class="" href="../../reference/cordova-plugin-file/index.html"> - cordova-plugin-file + File </a> </li> @@ -1469,7 +1469,7 @@ <li> <a class="" href="../../reference/cordova-plugin-file-transfer/index.html"> - cordova-plugin-file-transfer + File Transfer </a> </li> @@ -1478,7 +1478,7 @@ <li> <a class="" href="../../reference/cordova-plugin-geolocation/index.html"> - cordova-plugin-geolocation + Geolocation </a> </li> @@ -1487,7 +1487,7 @@ <li> <a class="" href="../../reference/cordova-plugin-globalization/index.html"> - cordova-plugin-globalization + Globalization </a> </li> @@ -1496,7 +1496,7 @@ <li> <a class="" href="../../reference/cordova-plugin-inappbrowser/index.html"> - cordova-plugin-inappbrowser + Inappbrowser </a> </li> @@ -1505,7 +1505,7 @@ <li> <a class="" href="../../reference/cordova-plugin-media/index.html"> - cordova-plugin-media + Media </a> </li> @@ -1514,7 +1514,7 @@ <li> <a class="" href="../../reference/cordova-plugin-media-capture/index.html"> - cordova-plugin-media-capture + Media Capture </a> </li> @@ -1523,7 +1523,7 @@ <li> <a class="" href="../../reference/cordova-plugin-network-information/index.html"> - cordova-plugin-network-information + Network Information </a> </li> @@ -1532,7 +1532,7 @@ <li> <a class="" href="../../reference/cordova-plugin-splashscreen/index.html"> - cordova-plugin-splashscreen + Splashscreen </a> </li> @@ -1541,7 +1541,7 @@ <li> <a class="" href="../../reference/cordova-plugin-vibration/index.html"> - cordova-plugin-vibration + Vibration </a> </li> @@ -1550,7 +1550,7 @@ <li> <a class="" href="../../reference/cordova-plugin-statusbar/index.html"> - cordova-plugin-statusbar + Statusbar </a> </li> @@ -1559,7 +1559,7 @@ <li> <a class="" href="../../reference/cordova-plugin-whitelist/index.html"> - cordova-plugin-whitelist + Whitelist </a> </li> @@ -1568,7 +1568,7 @@ <li> <a class="" href="../../reference/cordova-plugin-legacy-whitelist/index.html"> - cordova-plugin-legacy-whitelist + Legacy Whitelist </a> </li> @@ -2688,17 +2688,35 @@ # under the License. --> -<p><a href="https://travis-ci.org/apache/cordova-plugin-contacts"><img src="https://travis-ci.org/apache/cordova-plugin-contacts.svg?branch=master" alt="Build Status"></a></p> +<table><thead> +<tr> +<th style="text-align: center">Android</th> +<th style="text-align: center">iOS</th> +<th style="text-align: center">Windows 8.1 Store</th> +<th style="text-align: center">Windows 8.1 Phone</th> +<th style="text-align: center">Windows 10 Store</th> +<th style="text-align: center">Travis CI</th> +</tr> +</thead><tbody> +<tr> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=android,PLUGIN=cordova-plugin-contacts/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=android,PLUGIN=cordova-plugin-contacts" alt="Build Status"></a></td> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=ios,PLUGIN=cordova-plugin-contacts/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=ios,PLUGIN=cordova-plugin-contacts" alt="Build Status"></a></td> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-8.1-store,PLUGIN=cordova-plugin-contacts/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=windows-8.1-store,PLUGIN=cordova-plugin-contacts" alt="Build Status"></a></td> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-8.1-phone,PLUGIN=cordova-plugin-contacts/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=windows-8.1-phone,PLUGIN=cordova-plugin-contacts" alt="Build Status"></a></td> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-10-store,PLUGIN=cordova-plugin-contacts/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=windows-10-store,PLUGIN=cordova-plugin-contacts" alt="Build Status"></a></td> +<td style="text-align: center"><a href="https://travis-ci.org/apache/cordova-plugin-contacts"><img src="https://travis-ci.org/apache/cordova-plugin-contacts.svg?branch=master" alt="Build Status"></a></td> +</tr> +</tbody></table> <h1>cordova-plugin-contacts</h1> <p>This plugin defines a global <code>navigator.contacts</code> object, which provides access to the device contacts database.</p> <p>Although the object is attached to the global scoped <code>navigator</code>, it is not available until after the <code>deviceready</code> event.</p> -<div class="highlight"><pre><code class="language-" data-lang="">document.addEventListener("deviceready", onDeviceReady, false); -function onDeviceReady() { - console.log(navigator.contacts); -} +<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nb">document</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span><span class="s2">"deviceready"</span><span class="p">,</span> <span class="nx">onDeviceReady</span><span class="p">,</span> <span class="kc">false</span><span class="p">);</span> +<span class="kd">function</span> <span class="nx">onDeviceReady</span><span class="p">()</span> <span class="p">{</span> +<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">);</span> +<span class="p">}</span> </code></pre></div> <p><strong>WARNING</strong>: Collection and use of contact data raises important privacy issues. Your app's privacy policy should discuss @@ -2737,14 +2755,14 @@ contact data. For more information, ple Add relevant permisions. There is also a need to change the webapp type to "privileged" - <a href="https://developer.mozilla.org/en-US/Apps/Developing/Manifest#type">Manifest Docs</a>. <strong>WARNING</strong>: All privileged apps enforce <a href="https://developer.mozilla.org/en-US/Apps/CSP">Content Security Policy</a> which forbids inline script. Initialize your application in another way.</p> -<div class="highlight"><pre><code class="language-" data-lang="">"type": "privileged", -"permissions": { - "contacts": { - "access": "readwrite", - "description": "Describe why there is a need for such permission" - } -} -</code></pre></div> +<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="s2">"type"</span><span class="err">:</span><span class="w"> </span><span class="s2">"privileged"</span><span class="err">,</span><span class="w"> +</span><span class="s2">"permissions"</span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w"> + </span><span class="nt">"contacts"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> + </span><span class="nt">"access"</span><span class="p">:</span><span class="w"> </span><span class="s2">"readwrite"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Describe why there is a need for such permission"</span><span class="w"> + </span><span class="p">}</span><span class="w"> +</span><span class="p">}</span><span class="w"> +</span></code></pre></div> <h3>Windows Quirks</h3> <p><strong>Prior to Windows 10:</strong> Any contacts returned from <code>find</code> and <code>pickContact</code> methods are readonly, so your application cannot modify them. @@ -2798,7 +2816,7 @@ database, for which you need to invoke t </ul> <h3>Example</h3> -<div class="highlight"><pre><code class="language-" data-lang="">var myContact = navigator.contacts.create({"displayName": "Test User"}); +<div class="highlight"><pre><code class="language-js" data-lang="js"> <span class="kd">var</span> <span class="nx">myContact</span> <span class="o">=</span> <span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">.</span><span class="nx">create</span><span class="p">({</span><span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"Test User"</span><span class="p">});</span> </code></pre></div> <h2>navigator.contacts.find</h2> @@ -2851,22 +2869,22 @@ parameter to control which contact prope </ul> <h3>Example</h3> -<div class="highlight"><pre><code class="language-" data-lang="">function onSuccess(contacts) { - alert('Found ' + contacts.length + ' contacts.'); -}; - -function onError(contactError) { - alert('onError!'); -}; - -// find all contacts with 'Bob' in any name field -var options = new ContactFindOptions(); -options.filter = "Bob"; -options.multiple = true; -options.desiredFields = [navigator.contacts.fieldType.id]; -options.hasPhoneNumber = true; -var fields = [navigator.contacts.fieldType.displayName, navigator.contacts.fieldType.name]; -navigator.contacts.find(fields, onSuccess, onError, options); +<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="kd">function</span> <span class="nx">onSuccess</span><span class="p">(</span><span class="nx">contacts</span><span class="p">)</span> <span class="p">{</span> + <span class="nx">alert</span><span class="p">(</span><span class="s1">'Found '</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">.</span><span class="nx">length</span> <span class="o">+</span> <span class="s1">' contacts.'</span><span class="p">);</span> +<span class="p">};</span> + +<span class="kd">function</span> <span class="nx">onError</span><span class="p">(</span><span class="nx">contactError</span><span class="p">)</span> <span class="p">{</span> + <span class="nx">alert</span><span class="p">(</span><span class="s1">'onError!'</span><span class="p">);</span> +<span class="p">};</span> + +<span class="c1">// find all contacts with 'Bob' in any name field</span> +<span class="kd">var</span> <span class="nx">options</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ContactFindOptions</span><span class="p">();</span> +<span class="nx">options</span><span class="p">.</span><span class="nx">filter</span> <span class="o">=</span> <span class="s2">"Bob"</span><span class="p">;</span> +<span class="nx">options</span><span class="p">.</span><span class="nx">multiple</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span> +<span class="nx">options</span><span class="p">.</span><span class="nx">desiredFields</span> <span class="o">=</span> <span class="p">[</span><span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">.</span><span class="nx">fieldType</span><span class="p">.</span><span class="nx">id</span><span class="p">];</span> +<span class="nx">options</span><span class="p">.</span><span class="nx">hasPhoneNumber</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span> +<span class="kd">var</span> <span class="nx">fields</span> <span class="o">=</span> <span class="p">[</span><span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">.</span><span class="nx">fieldType</span><span class="p">.</span><span class="nx">displayName</span><span class="p">,</span> <span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">.</span><span class="nx">fieldType</span><span class="p">.</span><span class="nx">name</span><span class="p">];</span> +<span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">.</span><span class="nx">find</span><span class="p">(</span><span class="nx">fields</span><span class="p">,</span> <span class="nx">onSuccess</span><span class="p">,</span> <span class="nx">onError</span><span class="p">,</span> <span class="nx">options</span><span class="p">);</span> </code></pre></div> <h3>Windows Quirks</h3> @@ -2897,11 +2915,11 @@ function specified by the <strong>contac </ul> <h3>Example</h3> -<div class="highlight"><pre><code class="language-" data-lang="">navigator.contacts.pickContact(function(contact){ - console.log('The following contact has been selected:' + JSON.stringify(contact)); - },function(err){ - console.log('Error: ' + err); - }); +<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">.</span><span class="nx">pickContact</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">contact</span><span class="p">){</span> + <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'The following contact has been selected:'</span> <span class="o">+</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">contact</span><span class="p">));</span> + <span class="p">},</span><span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">){</span> + <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Error: '</span> <span class="o">+</span> <span class="nx">err</span><span class="p">);</span> + <span class="p">});</span> </code></pre></div> <h3>Android Quirks</h3> @@ -2972,46 +2990,72 @@ for details.</p> </ul> <h3>Save Example</h3> -<div class="highlight"><pre><code class="language-" data-lang="">function onSuccess(contact) { - alert("Save Success"); -}; - -function onError(contactError) { - alert("Error = " + contactError.code); -}; - -// create a new contact object -var contact = navigator.contacts.create(); -contact.displayName = "Plumber"; -contact.nickname = "Plumber"; // specify both to support all devices - -// populate some fields -var name = new ContactName(); -name.givenName = "Jane"; -name.familyName = "Doe"; -contact.name = name; +<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="kd">function</span> <span class="nx">onSuccess</span><span class="p">(</span><span class="nx">contact</span><span class="p">)</span> <span class="p">{</span> + <span class="nx">alert</span><span class="p">(</span><span class="s2">"Save Success"</span><span class="p">);</span> +<span class="p">};</span> + +<span class="kd">function</span> <span class="nx">onError</span><span class="p">(</span><span class="nx">contactError</span><span class="p">)</span> <span class="p">{</span> + <span class="nx">alert</span><span class="p">(</span><span class="s2">"Error = "</span> <span class="o">+</span> <span class="nx">contactError</span><span class="p">.</span><span class="nx">code</span><span class="p">);</span> +<span class="p">};</span> + +<span class="c1">// create a new contact object</span> +<span class="kd">var</span> <span class="nx">contact</span> <span class="o">=</span> <span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">.</span><span class="nx">create</span><span class="p">();</span> +<span class="nx">contact</span><span class="p">.</span><span class="nx">displayName</span> <span class="o">=</span> <span class="s2">"Plumber"</span><span class="p">;</span> +<span class="nx">contact</span><span class="p">.</span><span class="nx">nickname</span> <span class="o">=</span> <span class="s2">"Plumber"</span><span class="p">;</span> <span class="c1">// specify both to support all devices</span> + +<span class="c1">// populate some fields</span> +<span class="kd">var</span> <span class="nx">name</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ContactName</span><span class="p">();</span> +<span class="nx">name</span><span class="p">.</span><span class="nx">givenName</span> <span class="o">=</span> <span class="s2">"Jane"</span><span class="p">;</span> +<span class="nx">name</span><span class="p">.</span><span class="nx">familyName</span> <span class="o">=</span> <span class="s2">"Doe"</span><span class="p">;</span> +<span class="nx">contact</span><span class="p">.</span><span class="nx">name</span> <span class="o">=</span> <span class="nx">name</span><span class="p">;</span> -// save to device -contact.save(onSuccess,onError); +<span class="c1">// save to device</span> +<span class="nx">contact</span><span class="p">.</span><span class="nx">save</span><span class="p">(</span><span class="nx">onSuccess</span><span class="p">,</span><span class="nx">onError</span><span class="p">);</span> </code></pre></div> <h3>Clone Example</h3> -<div class="highlight"><pre><code class="language-" data-lang=""> // clone the contact object - var clone = contact.clone(); - clone.name.givenName = "John"; - console.log("Original contact name = " + contact.name.givenName); - console.log("Cloned contact name = " + clone.name.givenName); +<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="c1">// clone the contact object</span> +<span class="kd">var</span> <span class="nx">clone</span> <span class="o">=</span> <span class="nx">contact</span><span class="p">.</span><span class="nx">clone</span><span class="p">();</span> +<span class="nx">clone</span><span class="p">.</span><span class="nx">name</span><span class="p">.</span><span class="nx">givenName</span> <span class="o">=</span> <span class="s2">"John"</span><span class="p">;</span> +<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">"Original contact name = "</span> <span class="o">+</span> <span class="nx">contact</span><span class="p">.</span><span class="nx">name</span><span class="p">.</span><span class="nx">givenName</span><span class="p">);</span> +<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">"Cloned contact name = "</span> <span class="o">+</span> <span class="nx">clone</span><span class="p">.</span><span class="nx">name</span><span class="p">.</span><span class="nx">givenName</span><span class="p">);</span> </code></pre></div> <h3>Remove Example</h3> -<div class="highlight"><pre><code class="language-" data-lang="">function onSuccess() { - alert("Removal Success"); -}; - -function onError(contactError) { - alert("Error = " + contactError.code); -}; +<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="kd">function</span> <span class="nx">onSuccess</span><span class="p">()</span> <span class="p">{</span> + <span class="nx">alert</span><span class="p">(</span><span class="s2">"Removal Success"</span><span class="p">);</span> +<span class="p">};</span> + +<span class="kd">function</span> <span class="nx">onError</span><span class="p">(</span><span class="nx">contactError</span><span class="p">)</span> <span class="p">{</span> + <span class="nx">alert</span><span class="p">(</span><span class="s2">"Error = "</span> <span class="o">+</span> <span class="nx">contactError</span><span class="p">.</span><span class="nx">code</span><span class="p">);</span> +<span class="p">};</span> -// remove the contact from the device -contact.remove(onSuccess,onError); +<span class="c1">// remove the contact from the device</span> +<span class="nx">contact</span><span class="p">.</span><span class="nx">remove</span><span class="p">(</span><span class="nx">onSuccess</span><span class="p">,</span><span class="nx">onError</span><span class="p">);</span> +</code></pre></div> +<h3>Removing phone number(s) from a saved contact</h3> +<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="c1">// Example to create a contact with 3 phone numbers and then remove</span> +<span class="c1">// 2 phone numbers. This example is for illustrative purpose only</span> +<span class="kd">var</span> <span class="nx">myContact</span> <span class="o">=</span> <span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">.</span><span class="nx">create</span><span class="p">({</span><span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"Test User"</span><span class="p">});</span> +<span class="kd">var</span> <span class="nx">phoneNumbers</span> <span class="o">=</span> <span class="p">[];</span> + +<span class="nx">phoneNumbers</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ContactField</span><span class="p">(</span><span class="s1">'work'</span><span class="p">,</span> <span class="s1">'768-555-1234'</span><span class="p">,</span> <span class="kc">false</span><span class="p">);</span> +<span class="nx">phoneNumbers</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ContactField</span><span class="p">(</span><span class="s1">'mobile'</span><span class="p">,</span> <span class="s1">'999-555-5432'</span><span class="p">,</span> <span class="kc">true</span><span class="p">);</span> <span class="c1">// preferred number</span> +<span class="nx">phoneNumbers</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ContactField</span><span class="p">(</span><span class="s1">'home'</span><span class="p">,</span> <span class="s1">'203-555-7890'</span><span class="p">,</span> <span class="kc">false</span><span class="p">);</span> + +<span class="nx">myContact</span><span class="p">.</span><span class="nx">phoneNumbers</span> <span class="o">=</span> <span class="nx">phoneNumbers</span><span class="p">;</span> +<span class="nx">myContact</span><span class="p">.</span><span class="nx">save</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">contact_obj</span><span class="p">)</span> <span class="p">{</span> + <span class="kd">var</span> <span class="nx">contactObjToModify</span> <span class="o">=</span> <span class="nx">contact_obj</span><span class="p">.</span><span class="nx">clone</span><span class="p">();</span> + <span class="nx">contact_obj</span><span class="p">.</span><span class="nx">remove</span><span class="p">(</span><span class="kd">function</span><span class="p">(){</span> + <span class="kd">var</span> <span class="nx">phoneNumbers</span> <span class="o">=</span> <span class="p">[</span><span class="nx">contactObjToModify</span><span class="p">.</span><span class="nx">phoneNumbers</span><span class="p">[</span><span class="mi">0</span><span class="p">]];</span> + <span class="nx">contactObjToModify</span><span class="p">.</span><span class="nx">phoneNumbers</span> <span class="o">=</span> <span class="nx">phoneNumbers</span><span class="p">;</span> + <span class="nx">contactObjToModify</span><span class="p">.</span><span class="nx">save</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">c_obj</span><span class="p">){</span> + <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">"All Done"</span><span class="p">);</span> + <span class="p">},</span> <span class="kd">function</span><span class="p">(</span><span class="nx">error</span><span class="p">){</span> + <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">"Not able to save the cloned object: "</span> <span class="o">+</span> <span class="nx">error</span><span class="p">);</span> + <span class="p">});</span> + <span class="p">},</span> <span class="kd">function</span><span class="p">(</span><span class="nx">contactError</span><span class="p">)</span> <span class="p">{</span> + <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">"Contact Remove Operation failed: "</span> <span class="o">+</span> <span class="nx">contactError</span><span class="p">);</span> + <span class="p">});</span> +<span class="p">});</span> </code></pre></div> <h3>Android 2.X Quirks</h3> @@ -3099,33 +3143,33 @@ a <code>ContactAddress[]</code> array.</ </ul> <h3>Example</h3> -<div class="highlight"><pre><code class="language-" data-lang="">// display the address information for all contacts +<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="c1">// display the address information for all contacts</span> + +<span class="kd">function</span> <span class="nx">onSuccess</span><span class="p">(</span><span class="nx">contacts</span><span class="p">)</span> <span class="p">{</span> + <span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">contacts</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span> + <span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">j</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nx">j</span> <span class="o"><</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">addresses</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">j</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span> + <span class="nx">alert</span><span class="p">(</span><span class="s2">"Pref: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">addresses</span><span class="p">[</span><span class="nx">j</span><span class="p">].</span><span class="nx">pref</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Type: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">addresses</span><span class="p">[</span><span class="nx">j</span><span class="p">].</span><span class="nx">type</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Formatted: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">addresses</span><span class="p">[</span><span class="nx">j</span><span class="p">].</span><span class="nx">formatted</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Street Address: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">addresses</span><span class="p">[</span><span class="nx">j</span><span class="p">].</span><span class="nx">streetAddress</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Locality: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">addresses</span><span class="p">[</span><span class="nx">j</span><span class="p">].</span><span class="nx">locality</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Region: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">addresses</span><span class="p">[</span><span class="nx">j</span><span class="p">].</span><span class="nx">region</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Postal Code: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">addresses</span><span class="p">[</span><span class="nx">j</span><span class="p">].</span><span class="nx">postalCode</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Country: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">addresses</span><span class="p">[</span><span class="nx">j</span><span class="p">].</span><span class="nx">country</span><span class="p">);</span> + <span class="p">}</span> + <span class="p">}</span> +<span class="p">};</span> -function onSuccess(contacts) { - for (var i = 0; i < contacts.length; i++) { - for (var j = 0; j < contacts[i].addresses.length; j++) { - alert("Pref: " + contacts[i].addresses[j].pref + "\n" + - "Type: " + contacts[i].addresses[j].type + "\n" + - "Formatted: " + contacts[i].addresses[j].formatted + "\n" + - "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" + - "Locality: " + contacts[i].addresses[j].locality + "\n" + - "Region: " + contacts[i].addresses[j].region + "\n" + - "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" + - "Country: " + contacts[i].addresses[j].country); - } - } -}; - -function onError(contactError) { - alert('onError!'); -}; - -// find all contacts -var options = new ContactFindOptions(); -options.filter = ""; -options.multiple = true; -var filter = ["displayName", "addresses"]; -navigator.contacts.find(filter, onSuccess, onError, options); +<span class="kd">function</span> <span class="nx">onError</span><span class="p">(</span><span class="nx">contactError</span><span class="p">)</span> <span class="p">{</span> + <span class="nx">alert</span><span class="p">(</span><span class="s1">'onError!'</span><span class="p">);</span> +<span class="p">};</span> + +<span class="c1">// find all contacts</span> +<span class="kd">var</span> <span class="nx">options</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ContactFindOptions</span><span class="p">();</span> +<span class="nx">options</span><span class="p">.</span><span class="nx">filter</span> <span class="o">=</span> <span class="s2">""</span><span class="p">;</span> +<span class="nx">options</span><span class="p">.</span><span class="nx">multiple</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span> +<span class="kd">var</span> <span class="nx">filter</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"displayName"</span><span class="p">,</span> <span class="s2">"addresses"</span><span class="p">];</span> +<span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">.</span><span class="nx">find</span><span class="p">(</span><span class="nx">filter</span><span class="p">,</span> <span class="nx">onSuccess</span><span class="p">,</span> <span class="nx">onError</span><span class="p">,</span> <span class="nx">options</span><span class="p">);</span> </code></pre></div> <h3>Android 2.X Quirks</h3> @@ -3228,18 +3272,18 @@ string.</p> </ul> <h3>Example</h3> -<div class="highlight"><pre><code class="language-" data-lang=""> // create a new contact - var contact = navigator.contacts.create(); +<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="c1">// create a new contact</span> +<span class="kd">var</span> <span class="nx">contact</span> <span class="o">=</span> <span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">.</span><span class="nx">create</span><span class="p">();</span> - // store contact phone numbers in ContactField[] - var phoneNumbers = []; - phoneNumbers[0] = new ContactField('work', '212-555-1234', false); - phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number - phoneNumbers[2] = new ContactField('home', '203-555-7890', false); - contact.phoneNumbers = phoneNumbers; +<span class="c1">// store contact phone numbers in ContactField[]</span> +<span class="kd">var</span> <span class="nx">phoneNumbers</span> <span class="o">=</span> <span class="p">[];</span> +<span class="nx">phoneNumbers</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ContactField</span><span class="p">(</span><span class="s1">'work'</span><span class="p">,</span> <span class="s1">'212-555-1234'</span><span class="p">,</span> <span class="kc">false</span><span class="p">);</span> +<span class="nx">phoneNumbers</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ContactField</span><span class="p">(</span><span class="s1">'mobile'</span><span class="p">,</span> <span class="s1">'917-555-5432'</span><span class="p">,</span> <span class="kc">true</span><span class="p">);</span> <span class="c1">// preferred number</span> +<span class="nx">phoneNumbers</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ContactField</span><span class="p">(</span><span class="s1">'home'</span><span class="p">,</span> <span class="s1">'203-555-7890'</span><span class="p">,</span> <span class="kc">false</span><span class="p">);</span> +<span class="nx">contact</span><span class="p">.</span><span class="nx">phoneNumbers</span> <span class="o">=</span> <span class="nx">phoneNumbers</span><span class="p">;</span> - // save the contact - contact.save(); +<span class="c1">// save the contact</span> +<span class="nx">contact</span><span class="p">.</span><span class="nx">save</span><span class="p">();</span> </code></pre></div> <h3>Android Quirks</h3> @@ -3295,26 +3339,26 @@ string.</p> </ul> <h3>Example</h3> -<div class="highlight"><pre><code class="language-" data-lang="">function onSuccess(contacts) { - for (var i = 0; i < contacts.length; i++) { - alert("Formatted: " + contacts[i].name.formatted + "\n" + - "Family Name: " + contacts[i].name.familyName + "\n" + - "Given Name: " + contacts[i].name.givenName + "\n" + - "Middle Name: " + contacts[i].name.middleName + "\n" + - "Suffix: " + contacts[i].name.honorificSuffix + "\n" + - "Prefix: " + contacts[i].name.honorificSuffix); - } -}; - -function onError(contactError) { - alert('onError!'); -}; - -var options = new ContactFindOptions(); -options.filter = ""; -options.multiple = true; -filter = ["displayName", "name"]; -navigator.contacts.find(filter, onSuccess, onError, options); +<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="kd">function</span> <span class="nx">onSuccess</span><span class="p">(</span><span class="nx">contacts</span><span class="p">)</span> <span class="p">{</span> + <span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">contacts</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span> + <span class="nx">alert</span><span class="p">(</span><span class="s2">"Formatted: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">name</span><span class="p">.</span><span class="nx">formatted</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Family Name: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">name</span><span class="p">.</span><span class="nx">familyName</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Given Name: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">name</span><span class="p">.</span><span class="nx">givenName</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Middle Name: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">name</span><span class="p">.</span><span class="nx">middleName</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Suffix: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">name</span><span class="p">.</span><span class="nx">honorificSuffix</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Prefix: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">name</span><span class="p">.</span><span class="nx">honorificSuffix</span><span class="p">);</span> + <span class="p">}</span> +<span class="p">};</span> + +<span class="kd">function</span> <span class="nx">onError</span><span class="p">(</span><span class="nx">contactError</span><span class="p">)</span> <span class="p">{</span> + <span class="nx">alert</span><span class="p">(</span><span class="s1">'onError!'</span><span class="p">);</span> +<span class="p">};</span> + +<span class="kd">var</span> <span class="nx">options</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ContactFindOptions</span><span class="p">();</span> +<span class="nx">options</span><span class="p">.</span><span class="nx">filter</span> <span class="o">=</span> <span class="s2">""</span><span class="p">;</span> +<span class="nx">options</span><span class="p">.</span><span class="nx">multiple</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span> +<span class="nx">filter</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"displayName"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">];</span> +<span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">.</span><span class="nx">find</span><span class="p">(</span><span class="nx">filter</span><span class="p">,</span> <span class="nx">onSuccess</span><span class="p">,</span> <span class="nx">onError</span><span class="p">,</span> <span class="nx">options</span><span class="p">);</span> </code></pre></div> <h3>Android Quirks</h3> @@ -3384,27 +3428,27 @@ properties. A <code>Contact</code> obje </ul> <h3>Example</h3> -<div class="highlight"><pre><code class="language-" data-lang="">function onSuccess(contacts) { - for (var i = 0; i < contacts.length; i++) { - for (var j = 0; j < contacts[i].organizations.length; j++) { - alert("Pref: " + contacts[i].organizations[j].pref + "\n" + - "Type: " + contacts[i].organizations[j].type + "\n" + - "Name: " + contacts[i].organizations[j].name + "\n" + - "Department: " + contacts[i].organizations[j].department + "\n" + - "Title: " + contacts[i].organizations[j].title); - } - } -}; - -function onError(contactError) { - alert('onError!'); -}; - -var options = new ContactFindOptions(); -options.filter = ""; -options.multiple = true; -filter = ["displayName", "organizations"]; -navigator.contacts.find(filter, onSuccess, onError, options); +<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="kd">function</span> <span class="nx">onSuccess</span><span class="p">(</span><span class="nx">contacts</span><span class="p">)</span> <span class="p">{</span> + <span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">contacts</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span> + <span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">j</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nx">j</span> <span class="o"><</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">organizations</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">j</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span> + <span class="nx">alert</span><span class="p">(</span><span class="s2">"Pref: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">organizations</span><span class="p">[</span><span class="nx">j</span><span class="p">].</span><span class="nx">pref</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Type: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">organizations</span><span class="p">[</span><span class="nx">j</span><span class="p">].</span><span class="nx">type</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Name: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">organizations</span><span class="p">[</span><span class="nx">j</span><span class="p">].</span><span class="nx">name</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Department: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">organizations</span><span class="p">[</span><span class="nx">j</span><span class="p">].</span><span class="nx">department</span> <span class="o">+</span> <span class="s2">"\n"</span> <span class="o">+</span> + <span class="s2">"Title: "</span> <span class="o">+</span> <span class="nx">contacts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">organizations</span><span class="p">[</span><span class="nx">j</span><span class="p">].</span><span class="nx">title</span><span class="p">);</span> + <span class="p">}</span> + <span class="p">}</span> +<span class="p">};</span> + +<span class="kd">function</span> <span class="nx">onError</span><span class="p">(</span><span class="nx">contactError</span><span class="p">)</span> <span class="p">{</span> + <span class="nx">alert</span><span class="p">(</span><span class="s1">'onError!'</span><span class="p">);</span> +<span class="p">};</span> + +<span class="kd">var</span> <span class="nx">options</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ContactFindOptions</span><span class="p">();</span> +<span class="nx">options</span><span class="p">.</span><span class="nx">filter</span> <span class="o">=</span> <span class="s2">""</span><span class="p">;</span> +<span class="nx">options</span><span class="p">.</span><span class="nx">multiple</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span> +<span class="nx">filter</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"displayName"</span><span class="p">,</span> <span class="s2">"organizations"</span><span class="p">];</span> +<span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">.</span><span class="nx">find</span><span class="p">(</span><span class="nx">filter</span><span class="p">,</span> <span class="nx">onSuccess</span><span class="p">,</span> <span class="nx">onError</span><span class="p">,</span> <span class="nx">options</span><span class="p">);</span> </code></pre></div> <h3>Android 2.X Quirks</h3> @@ -3431,7 +3475,7 @@ navigator.contacts.find(filter, onSucces <li><p>Fields <strong>name</strong> and <strong>title</strong> stored in <strong>org</strong> and <strong>jobTitle</strong>.</p></li> </ul> -<h3>iOS Quirks</h3> +iOS Quirks</h3> <ul> <li><p><strong>pref</strong>: Not supported on iOS devices, returning <code>false</code>.</p></li>
Modified: cordova/site/public/docs/en/dev/reference/cordova-plugin-device-motion/index.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/reference/cordova-plugin-device-motion/index.html?rev=1752402&r1=1752401&r2=1752402&view=diff ============================================================================== --- cordova/site/public/docs/en/dev/reference/cordova-plugin-device-motion/index.html (original) +++ cordova/site/public/docs/en/dev/reference/cordova-plugin-device-motion/index.html Wed Jul 13 11:51:10 2016 @@ -6,12 +6,12 @@ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <meta name="format-detection" content="telephone=no"> <meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width" /> - <meta name="description" content=" "> + <meta name="description" content="Access accelerometer data. "> <title> - cordova-plugin-device-motion - Apache Cordova + Device Motion - Apache Cordova </title> @@ -732,7 +732,7 @@ <li> <a class="" href="../../reference/cordova-plugin-battery-status/index.html"> - cordova-plugin-battery-status + Battery Status </a> @@ -747,7 +747,7 @@ <li> <a class="" href="../../reference/cordova-plugin-camera/index.html"> - cordova-plugin-camera + Camera </a> @@ -762,7 +762,7 @@ <li> <a class="" href="../../reference/cordova-plugin-console/index.html"> - cordova-plugin-console + Console </a> @@ -777,7 +777,7 @@ <li> <a class="" href="../../reference/cordova-plugin-contacts/index.html"> - cordova-plugin-contacts + Contacts </a> @@ -792,7 +792,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device/index.html"> - cordova-plugin-device + Device </a> @@ -807,7 +807,7 @@ <li> <a class="this-page" href="../../reference/cordova-plugin-device-motion/index.html"> - cordova-plugin-device-motion + Device Motion </a> <span class="entry-highlight"></span> @@ -824,7 +824,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device-orientation/index.html"> - cordova-plugin-device-orientation + Device Orientation </a> @@ -839,7 +839,7 @@ <li> <a class="" href="../../reference/cordova-plugin-dialogs/index.html"> - cordova-plugin-dialogs + Dialogs </a> @@ -854,7 +854,7 @@ <li> <a class="" href="../../reference/cordova-plugin-file/index.html"> - cordova-plugin-file + File </a> @@ -869,7 +869,7 @@ <li> <a class="" href="../../reference/cordova-plugin-file-transfer/index.html"> - cordova-plugin-file-transfer + File Transfer </a> @@ -884,7 +884,7 @@ <li> <a class="" href="../../reference/cordova-plugin-geolocation/index.html"> - cordova-plugin-geolocation + Geolocation </a> @@ -899,7 +899,7 @@ <li> <a class="" href="../../reference/cordova-plugin-globalization/index.html"> - cordova-plugin-globalization + Globalization </a> @@ -914,7 +914,7 @@ <li> <a class="" href="../../reference/cordova-plugin-inappbrowser/index.html"> - cordova-plugin-inappbrowser + Inappbrowser </a> @@ -929,7 +929,7 @@ <li> <a class="" href="../../reference/cordova-plugin-media/index.html"> - cordova-plugin-media + Media </a> @@ -944,7 +944,7 @@ <li> <a class="" href="../../reference/cordova-plugin-media-capture/index.html"> - cordova-plugin-media-capture + Media Capture </a> @@ -959,7 +959,7 @@ <li> <a class="" href="../../reference/cordova-plugin-network-information/index.html"> - cordova-plugin-network-information + Network Information </a> @@ -974,7 +974,7 @@ <li> <a class="" href="../../reference/cordova-plugin-splashscreen/index.html"> - cordova-plugin-splashscreen + Splashscreen </a> @@ -989,7 +989,7 @@ <li> <a class="" href="../../reference/cordova-plugin-vibration/index.html"> - cordova-plugin-vibration + Vibration </a> @@ -1004,7 +1004,7 @@ <li> <a class="" href="../../reference/cordova-plugin-statusbar/index.html"> - cordova-plugin-statusbar + Statusbar </a> @@ -1019,7 +1019,7 @@ <li> <a class="" href="../../reference/cordova-plugin-whitelist/index.html"> - cordova-plugin-whitelist + Whitelist </a> @@ -1034,7 +1034,7 @@ <li> <a class="" href="../../reference/cordova-plugin-legacy-whitelist/index.html"> - cordova-plugin-legacy-whitelist + Legacy Whitelist </a> @@ -1388,7 +1388,7 @@ <li> <a class="" href="../../reference/cordova-plugin-battery-status/index.html"> - cordova-plugin-battery-status + Battery Status </a> </li> @@ -1397,7 +1397,7 @@ <li> <a class="" href="../../reference/cordova-plugin-camera/index.html"> - cordova-plugin-camera + Camera </a> </li> @@ -1406,7 +1406,7 @@ <li> <a class="" href="../../reference/cordova-plugin-console/index.html"> - cordova-plugin-console + Console </a> </li> @@ -1415,7 +1415,7 @@ <li> <a class="" href="../../reference/cordova-plugin-contacts/index.html"> - cordova-plugin-contacts + Contacts </a> </li> @@ -1424,7 +1424,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device/index.html"> - cordova-plugin-device + Device </a> </li> @@ -1433,7 +1433,7 @@ <li> <a class="this-page" href="../../reference/cordova-plugin-device-motion/index.html"> - cordova-plugin-device-motion + Device Motion </a> </li> @@ -1442,7 +1442,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device-orientation/index.html"> - cordova-plugin-device-orientation + Device Orientation </a> </li> @@ -1451,7 +1451,7 @@ <li> <a class="" href="../../reference/cordova-plugin-dialogs/index.html"> - cordova-plugin-dialogs + Dialogs </a> </li> @@ -1460,7 +1460,7 @@ <li> <a class="" href="../../reference/cordova-plugin-file/index.html"> - cordova-plugin-file + File </a> </li> @@ -1469,7 +1469,7 @@ <li> <a class="" href="../../reference/cordova-plugin-file-transfer/index.html"> - cordova-plugin-file-transfer + File Transfer </a> </li> @@ -1478,7 +1478,7 @@ <li> <a class="" href="../../reference/cordova-plugin-geolocation/index.html"> - cordova-plugin-geolocation + Geolocation </a> </li> @@ -1487,7 +1487,7 @@ <li> <a class="" href="../../reference/cordova-plugin-globalization/index.html"> - cordova-plugin-globalization + Globalization </a> </li> @@ -1496,7 +1496,7 @@ <li> <a class="" href="../../reference/cordova-plugin-inappbrowser/index.html"> - cordova-plugin-inappbrowser + Inappbrowser </a> </li> @@ -1505,7 +1505,7 @@ <li> <a class="" href="../../reference/cordova-plugin-media/index.html"> - cordova-plugin-media + Media </a> </li> @@ -1514,7 +1514,7 @@ <li> <a class="" href="../../reference/cordova-plugin-media-capture/index.html"> - cordova-plugin-media-capture + Media Capture </a> </li> @@ -1523,7 +1523,7 @@ <li> <a class="" href="../../reference/cordova-plugin-network-information/index.html"> - cordova-plugin-network-information + Network Information </a> </li> @@ -1532,7 +1532,7 @@ <li> <a class="" href="../../reference/cordova-plugin-splashscreen/index.html"> - cordova-plugin-splashscreen + Splashscreen </a> </li> @@ -1541,7 +1541,7 @@ <li> <a class="" href="../../reference/cordova-plugin-vibration/index.html"> - cordova-plugin-vibration + Vibration </a> </li> @@ -1550,7 +1550,7 @@ <li> <a class="" href="../../reference/cordova-plugin-statusbar/index.html"> - cordova-plugin-statusbar + Statusbar </a> </li> @@ -1559,7 +1559,7 @@ <li> <a class="" href="../../reference/cordova-plugin-whitelist/index.html"> - cordova-plugin-whitelist + Whitelist </a> </li> @@ -1568,7 +1568,7 @@ <li> <a class="" href="../../reference/cordova-plugin-legacy-whitelist/index.html"> - cordova-plugin-legacy-whitelist + Legacy Whitelist </a> </li> @@ -2688,7 +2688,25 @@ # under the License. --> -<p><a href="https://travis-ci.org/apache/cordova-plugin-device-motion"><img src="https://travis-ci.org/apache/cordova-plugin-device-motion.svg?branch=master" alt="Build Status"></a></p> +<table><thead> +<tr> +<th style="text-align: center">Android</th> +<th style="text-align: center">iOS</th> +<th style="text-align: center">Windows 8.1 Store</th> +<th style="text-align: center">Windows 8.1 Phone</th> +<th style="text-align: center">Windows 10 Store</th> +<th style="text-align: center">Travis CI</th> +</tr> +</thead><tbody> +<tr> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=android,PLUGIN=cordova-plugin-device-motion/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=android,PLUGIN=cordova-plugin-device-motion" alt="Build Status"></a></td> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=ios,PLUGIN=cordova-plugin-device-motion/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=ios,PLUGIN=cordova-plugin-device-motion" alt="Build Status"></a></td> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-8.1-store,PLUGIN=cordova-plugin-device-motion/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=windows-8.1-store,PLUGIN=cordova-plugin-device-motion" alt="Build Status"></a></td> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-8.1-phone,PLUGIN=cordova-plugin-device-motion/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=windows-8.1-phone,PLUGIN=cordova-plugin-device-motion" alt="Build Status"></a></td> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-10-store,PLUGIN=cordova-plugin-device-motion/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=windows-10-store,PLUGIN=cordova-plugin-device-motion" alt="Build Status"></a></td> +<td style="text-align: center"><a href="https://travis-ci.org/apache/cordova-plugin-device-motion"><img src="https://travis-ci.org/apache/cordova-plugin-device-motion.svg?branch=master" alt="Build Status"></a></td> +</tr> +</tbody></table> <h1>cordova-plugin-device-motion</h1> @@ -2793,7 +2811,7 @@ accelerometer.</p> <li><strong>accelerometerOptions</strong>: An object with the following optional keys: <ul> -<li><strong>period</strong>: requested period of calls to accelerometerSuccess with acceleration data in Milliseconds. <em>(Number)</em> (Default: 10000)</li> +<li><strong>frequency</strong>: requested frequency of calls to accelerometerSuccess with acceleration data in Milliseconds. <em>(Number)</em> (Default: 10000)</li> </ul></li> </ul> Modified: cordova/site/public/docs/en/dev/reference/cordova-plugin-device-orientation/index.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/reference/cordova-plugin-device-orientation/index.html?rev=1752402&r1=1752401&r2=1752402&view=diff ============================================================================== --- cordova/site/public/docs/en/dev/reference/cordova-plugin-device-orientation/index.html (original) +++ cordova/site/public/docs/en/dev/reference/cordova-plugin-device-orientation/index.html Wed Jul 13 11:51:10 2016 @@ -6,12 +6,12 @@ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <meta name="format-detection" content="telephone=no"> <meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width" /> - <meta name="description" content=" "> + <meta name="description" content="Access compass data. "> <title> - cordova-plugin-device-orientation - Apache Cordova + Device Orientation - Apache Cordova </title> @@ -732,7 +732,7 @@ <li> <a class="" href="../../reference/cordova-plugin-battery-status/index.html"> - cordova-plugin-battery-status + Battery Status </a> @@ -747,7 +747,7 @@ <li> <a class="" href="../../reference/cordova-plugin-camera/index.html"> - cordova-plugin-camera + Camera </a> @@ -762,7 +762,7 @@ <li> <a class="" href="../../reference/cordova-plugin-console/index.html"> - cordova-plugin-console + Console </a> @@ -777,7 +777,7 @@ <li> <a class="" href="../../reference/cordova-plugin-contacts/index.html"> - cordova-plugin-contacts + Contacts </a> @@ -792,7 +792,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device/index.html"> - cordova-plugin-device + Device </a> @@ -807,7 +807,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device-motion/index.html"> - cordova-plugin-device-motion + Device Motion </a> @@ -822,7 +822,7 @@ <li> <a class="this-page" href="../../reference/cordova-plugin-device-orientation/index.html"> - cordova-plugin-device-orientation + Device Orientation </a> <span class="entry-highlight"></span> @@ -839,7 +839,7 @@ <li> <a class="" href="../../reference/cordova-plugin-dialogs/index.html"> - cordova-plugin-dialogs + Dialogs </a> @@ -854,7 +854,7 @@ <li> <a class="" href="../../reference/cordova-plugin-file/index.html"> - cordova-plugin-file + File </a> @@ -869,7 +869,7 @@ <li> <a class="" href="../../reference/cordova-plugin-file-transfer/index.html"> - cordova-plugin-file-transfer + File Transfer </a> @@ -884,7 +884,7 @@ <li> <a class="" href="../../reference/cordova-plugin-geolocation/index.html"> - cordova-plugin-geolocation + Geolocation </a> @@ -899,7 +899,7 @@ <li> <a class="" href="../../reference/cordova-plugin-globalization/index.html"> - cordova-plugin-globalization + Globalization </a> @@ -914,7 +914,7 @@ <li> <a class="" href="../../reference/cordova-plugin-inappbrowser/index.html"> - cordova-plugin-inappbrowser + Inappbrowser </a> @@ -929,7 +929,7 @@ <li> <a class="" href="../../reference/cordova-plugin-media/index.html"> - cordova-plugin-media + Media </a> @@ -944,7 +944,7 @@ <li> <a class="" href="../../reference/cordova-plugin-media-capture/index.html"> - cordova-plugin-media-capture + Media Capture </a> @@ -959,7 +959,7 @@ <li> <a class="" href="../../reference/cordova-plugin-network-information/index.html"> - cordova-plugin-network-information + Network Information </a> @@ -974,7 +974,7 @@ <li> <a class="" href="../../reference/cordova-plugin-splashscreen/index.html"> - cordova-plugin-splashscreen + Splashscreen </a> @@ -989,7 +989,7 @@ <li> <a class="" href="../../reference/cordova-plugin-vibration/index.html"> - cordova-plugin-vibration + Vibration </a> @@ -1004,7 +1004,7 @@ <li> <a class="" href="../../reference/cordova-plugin-statusbar/index.html"> - cordova-plugin-statusbar + Statusbar </a> @@ -1019,7 +1019,7 @@ <li> <a class="" href="../../reference/cordova-plugin-whitelist/index.html"> - cordova-plugin-whitelist + Whitelist </a> @@ -1034,7 +1034,7 @@ <li> <a class="" href="../../reference/cordova-plugin-legacy-whitelist/index.html"> - cordova-plugin-legacy-whitelist + Legacy Whitelist </a> @@ -1388,7 +1388,7 @@ <li> <a class="" href="../../reference/cordova-plugin-battery-status/index.html"> - cordova-plugin-battery-status + Battery Status </a> </li> @@ -1397,7 +1397,7 @@ <li> <a class="" href="../../reference/cordova-plugin-camera/index.html"> - cordova-plugin-camera + Camera </a> </li> @@ -1406,7 +1406,7 @@ <li> <a class="" href="../../reference/cordova-plugin-console/index.html"> - cordova-plugin-console + Console </a> </li> @@ -1415,7 +1415,7 @@ <li> <a class="" href="../../reference/cordova-plugin-contacts/index.html"> - cordova-plugin-contacts + Contacts </a> </li> @@ -1424,7 +1424,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device/index.html"> - cordova-plugin-device + Device </a> </li> @@ -1433,7 +1433,7 @@ <li> <a class="" href="../../reference/cordova-plugin-device-motion/index.html"> - cordova-plugin-device-motion + Device Motion </a> </li> @@ -1442,7 +1442,7 @@ <li> <a class="this-page" href="../../reference/cordova-plugin-device-orientation/index.html"> - cordova-plugin-device-orientation + Device Orientation </a> </li> @@ -1451,7 +1451,7 @@ <li> <a class="" href="../../reference/cordova-plugin-dialogs/index.html"> - cordova-plugin-dialogs + Dialogs </a> </li> @@ -1460,7 +1460,7 @@ <li> <a class="" href="../../reference/cordova-plugin-file/index.html"> - cordova-plugin-file + File </a> </li> @@ -1469,7 +1469,7 @@ <li> <a class="" href="../../reference/cordova-plugin-file-transfer/index.html"> - cordova-plugin-file-transfer + File Transfer </a> </li> @@ -1478,7 +1478,7 @@ <li> <a class="" href="../../reference/cordova-plugin-geolocation/index.html"> - cordova-plugin-geolocation + Geolocation </a> </li> @@ -1487,7 +1487,7 @@ <li> <a class="" href="../../reference/cordova-plugin-globalization/index.html"> - cordova-plugin-globalization + Globalization </a> </li> @@ -1496,7 +1496,7 @@ <li> <a class="" href="../../reference/cordova-plugin-inappbrowser/index.html"> - cordova-plugin-inappbrowser + Inappbrowser </a> </li> @@ -1505,7 +1505,7 @@ <li> <a class="" href="../../reference/cordova-plugin-media/index.html"> - cordova-plugin-media + Media </a> </li> @@ -1514,7 +1514,7 @@ <li> <a class="" href="../../reference/cordova-plugin-media-capture/index.html"> - cordova-plugin-media-capture + Media Capture </a> </li> @@ -1523,7 +1523,7 @@ <li> <a class="" href="../../reference/cordova-plugin-network-information/index.html"> - cordova-plugin-network-information + Network Information </a> </li> @@ -1532,7 +1532,7 @@ <li> <a class="" href="../../reference/cordova-plugin-splashscreen/index.html"> - cordova-plugin-splashscreen + Splashscreen </a> </li> @@ -1541,7 +1541,7 @@ <li> <a class="" href="../../reference/cordova-plugin-vibration/index.html"> - cordova-plugin-vibration + Vibration </a> </li> @@ -1550,7 +1550,7 @@ <li> <a class="" href="../../reference/cordova-plugin-statusbar/index.html"> - cordova-plugin-statusbar + Statusbar </a> </li> @@ -1559,7 +1559,7 @@ <li> <a class="" href="../../reference/cordova-plugin-whitelist/index.html"> - cordova-plugin-whitelist + Whitelist </a> </li> @@ -1568,7 +1568,7 @@ <li> <a class="" href="../../reference/cordova-plugin-legacy-whitelist/index.html"> - cordova-plugin-legacy-whitelist + Legacy Whitelist </a> </li> @@ -2688,7 +2688,25 @@ # under the License. --> -<p><a href="https://travis-ci.org/apache/cordova-plugin-device-orientation"><img src="https://travis-ci.org/apache/cordova-plugin-device-orientation.svg?branch=master" alt="Build Status"></a></p> +<table><thead> +<tr> +<th style="text-align: center">Android</th> +<th style="text-align: center">iOS</th> +<th style="text-align: center">Windows 8.1 Store</th> +<th style="text-align: center">Windows 8.1 Phone</th> +<th style="text-align: center">Windows 10 Store</th> +<th style="text-align: center">Travis CI</th> +</tr> +</thead><tbody> +<tr> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=android,PLUGIN=cordova-plugin-device-orientation/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=android,PLUGIN=cordova-plugin-device-orientation" alt="Build Status"></a></td> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=ios,PLUGIN=cordova-plugin-device-orientation/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=ios,PLUGIN=cordova-plugin-device-orientation" alt="Build Status"></a></td> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-8.1-store,PLUGIN=cordova-plugin-device-orientation/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=windows-8.1-store,PLUGIN=cordova-plugin-device-orientation" alt="Build Status"></a></td> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-8.1-phone,PLUGIN=cordova-plugin-device-orientation/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=windows-8.1-phone,PLUGIN=cordova-plugin-device-orientation" alt="Build Status"></a></td> +<td style="text-align: center"><a href="http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-10-store,PLUGIN=cordova-plugin-device-orientation/"><img src="http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=windows-10-store,PLUGIN=cordova-plugin-device-orientation" alt="Build Status"></a></td> +<td style="text-align: center"><a href="https://travis-ci.org/apache/cordova-plugin-device-orientation"><img src="https://travis-ci.org/apache/cordova-plugin-device-orientation.svg?branch=master" alt="Build Status"></a></td> +</tr> +</tbody></table> <h1>cordova-plugin-device-orientation</h1> @@ -2876,8 +2894,7 @@ navigator.compass.clearWatch(watchID); <h3>iOS Quirks</h3> <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> +<li>The <code>trueHeading</code> property is only returned for location services enabled via <code>navigator.geolocation.watchLocation()</code>.</li> </ul> <h2>CompassError</h2> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@cordova.apache.org For additional commands, e-mail: commits-h...@cordova.apache.org