You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ra...@apache.org on 2016/05/16 21:17:45 UTC
svn commit: r1744142 [4/9] - in /cordova/site/public: ./ docs/en/6.x/
docs/en/6.x/config_ref/ docs/en/6.x/cordova/events/
docs/en/6.x/cordova/storage/ docs/en/6.x/guide/platforms/win8/
docs/en/6.x/plugin_ref/ docs/en/6.x/reference/cordova-cli/ docs/en/...
Modified: cordova/site/public/docs/en/6.x/reference/cordova-plugin-contacts/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/6.x/reference/cordova-plugin-contacts/index.html?rev=1744142&r1=1744141&r2=1744142&view=diff
==============================================================================
--- cordova/site/public/docs/en/6.x/reference/cordova-plugin-contacts/index.html (original)
+++ cordova/site/public/docs/en/6.x/reference/cordova-plugin-contacts/index.html Mon May 16 21:17:45 2016
@@ -2687,10 +2687,10 @@
<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
@@ -2729,14 +2729,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.
@@ -2790,7 +2790,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>
@@ -2843,22 +2843,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>
@@ -2889,11 +2889,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>
@@ -2964,72 +2964,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-" data-lang="">// Example to create a contact with 3 phone numbers and then remove
-// 2 phone numbers. This example is for illustrative purpose only
-var myContact = navigator.contacts.create({"displayName": "Test User"});
-var phoneNumbers = [];
-
-phoneNumbers[0] = new ContactField('work', '768-555-1234', false);
-phoneNumbers[1] = new ContactField('mobile', '999-555-5432', true); // preferred number
-phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
-
-myContact.phoneNumbers = phoneNumbers;
-myContact.save(function (contact_obj) {
- var contactObjToModify = contact_obj.clone();
- contact_obj.remove(function(){
- var phoneNumbers = [contactObjToModify.phoneNumbers[0]];
- contactObjToModify.phoneNumbers = phoneNumbers;
- contactObjToModify.save(function(c_obj){
- console.log("All Done");
- }, function(error){
- console.log("Not able to save the cloned object: " + error);
- });
- }, function(contactError) {
- console.log("Contact Remove Operation failed: " + contactError);
- });
-});
+<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>
@@ -3117,33 +3117,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>
@@ -3246,18 +3246,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>
@@ -3265,7 +3265,7 @@ string.</p>
<li><strong>pref</strong>: Not supported, returning <code>false</code>.</li>
</ul>
-<h3>BlackBerry 10 Quirks</h3>
+BlackBerry 10 Quirks</h3>
<ul>
<li><p><strong>type</strong>: Partially supported. Used for phone numbers.</p></li>
@@ -3313,26 +3313,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>
@@ -3402,27 +3402,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>
@@ -3449,7 +3449,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/6.x/reference/cordova-plugin-dialogs/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/6.x/reference/cordova-plugin-dialogs/index.html?rev=1744142&r1=1744141&r2=1744142&view=diff
==============================================================================
--- cordova/site/public/docs/en/6.x/reference/cordova-plugin-dialogs/index.html (original)
+++ cordova/site/public/docs/en/6.x/reference/cordova-plugin-dialogs/index.html Mon May 16 21:17:45 2016
@@ -2739,6 +2739,7 @@ navigator.notification.alert(
<li>Amazon Fire OS</li>
<li>Android</li>
<li>BlackBerry 10</li>
+<li>Browser</li>
<li>Firefox OS</li>
<li>iOS</li>
<li>Tizen</li>
@@ -2803,6 +2804,7 @@ navigator.notification.confirm(
<li>Amazon Fire OS</li>
<li>Android</li>
<li>BlackBerry 10</li>
+<li>Browser</li>
<li>Firefox OS</li>
<li>iOS</li>
<li>Tizen</li>
@@ -2873,6 +2875,7 @@ navigator.notification.prompt(
<ul>
<li>Amazon Fire OS</li>
<li>Android</li>
+<li>Browser</li>
<li>Firefox OS</li>
<li>iOS</li>
<li>Windows Phone 7 and 8</li>
@@ -2916,6 +2919,7 @@ navigator.notification.beep(2);
<li>Amazon Fire OS</li>
<li>Android</li>
<li>BlackBerry 10</li>
+<li>Browser</li>
<li>iOS</li>
<li>Tizen</li>
<li>Windows Phone 7 and 8</li>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org