You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/02/23 00:43:56 UTC
svn commit: r1449255 [14/34] - in /cordova/site/public/docs: en/1.5.0/
en/1.5.0rc1/ en/1.6.0/ en/1.6.0rc1/ en/1.6.1/ en/1.7.0/ en/1.7.0rc1/
en/1.8.0/ en/1.8.0rc1/ en/1.8.1/ en/1.9.0/ en/1.9.0rc1/ en/2.0.0/
en/2.0.0rc1/ en/2.1.0/ en/2.1.0rc1/ en/2.1.0rc...
Added: cordova/site/public/docs/en/2.5.0rc1/cordova_contacts_contacts.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.5.0rc1/cordova_contacts_contacts.md.html?rev=1449255&view=auto
==============================================================================
--- cordova/site/public/docs/en/2.5.0rc1/cordova_contacts_contacts.md.html (added)
+++ cordova/site/public/docs/en/2.5.0rc1/cordova_contacts_contacts.md.html Fri Feb 22 23:42:47 2013
@@ -0,0 +1,1703 @@
+<!DOCTYPE html>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+--><html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
+ <div id="header">
+ <h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option selected value="2.5.0rc1">2.5.0rc1</option>
+<option value="2.4.0rc1">2.4.0rc1</option>
+<option value="2.4.0">2.4.0</option>
+<option value="2.3.0rc2">2.3.0rc2</option>
+<option value="2.3.0rc1">2.3.0rc1</option>
+<option value="2.3.0">2.3.0</option>
+<option value="2.2.0rc2">2.2.0rc2</option>
+<option value="2.2.0rc1">2.2.0rc1</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0rc2">2.1.0rc2</option>
+<option value="2.1.0rc1">2.1.0rc1</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0rc1">2.0.0rc1</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0rc1">1.9.0rc1</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.8.0rc1">1.8.0rc1</option>
+<option value="1.8.0">1.8.0</option>
+<option value="1.7.0rc1">1.7.0rc1</option>
+<option value="1.7.0">1.7.0</option>
+<option value="1.6.1">1.6.1</option>
+<option value="1.6.0rc1">1.6.0rc1</option>
+<option value="1.6.0">1.6.0</option>
+<option value="1.5.0rc1">1.5.0rc1</option>
+<option value="1.5.0">1.5.0</option>
+</optgroup>
+<optgroup label="Japanese" value="jp">
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.7.0">1.7.0</option>
+</optgroup>
+<optgroup label="Korean" value="kr"><option value="2.0.0">2.0.0</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>Contacts</h1>
+ <small><select><option value="Contacts">Contacts</option>
+<option value="Contacts_methods">Â Â Â Â Â Â - Methods</option>
+<option value="Contacts_arguments">Â Â Â Â Â Â - Arguments</option>
+<option value="Contacts_objects">Â Â Â Â Â Â - Objects</option>
+<option value="Contacts_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="contacts.create">contacts.create</option>
+<option value="contacts.create_description">Â Â Â Â Â Â - Description</option>
+<option value="contacts.create_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="contacts.create_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="contacts.create_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="contacts.find">contacts.find</option>
+<option value="contacts.find_description">Â Â Â Â Â Â - Description</option>
+<option value="contacts.find_parameters">Â Â Â Â Â Â - Parameters</option>
+<option value="contacts.find_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="contacts.find_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="contacts.find_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="Contact">Contact</option>
+<option value="Contact_properties">Â Â Â Â Â Â - Properties</option>
+<option value="Contact_methods">Â Â Â Â Â Â - Methods</option>
+<option value="Contact_details">Â Â Â Â Â Â - Details</option>
+<option value="Contact_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="Contact_save_quick_example">Â Â Â Â Â Â - Save Quick Example</option>
+<option value="Contact_clone_quick_example">Â Â Â Â Â Â - Clone Quick Example</option>
+<option value="Contact_remove_quick_example">Â Â Â Â Â Â - Remove Quick Example</option>
+<option value="Contact_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="Contact_android_2_x_quirks">Â Â Â Â Â Â - Android 2.X Quirks</option>
+<option value="Contact_blackberry_webworks_os_5_0_and_higher_quirks">Â Â Â Â Â Â - BlackBerry WebWorks (OS 5.0 and higher) Quirks</option>
+<option value="Contact_ios_quirks">Â Â Â Â Â Â - iOS Quirks</option>
+<option value="Contact_windows_phone_7_and_8_quirks">Â Â Â Â Â Â - Windows Phone 7 and 8 Quirks</option>
+<option value="Contact_bada_quirks">Â Â Â Â Â Â - Bada Quirks</option>
+<option value="ContactAddress">ContactAddress</option>
+<option value="ContactAddress_properties">Â Â Â Â Â Â - Properties</option>
+<option value="ContactAddress_details">Â Â Â Â Â Â - Details</option>
+<option value="ContactAddress_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="ContactAddress_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="ContactAddress_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="ContactAddress_android_2_x_quirks">Â Â Â Â Â Â - Android 2.X Quirks</option>
+<option value="ContactAddress_blackberry_webworks_os_5_0_and_higher_quirks">Â Â Â Â Â Â - BlackBerry WebWorks (OS 5.0 and higher) Quirks</option>
+<option value="ContactAddress_ios_quirks">Â Â Â Â Â Â - iOS Quirks</option>
+<option value="ContactAddress_bada_quirks">Â Â Â Â Â Â - Bada Quirks</option>
+<option value="ContactField">ContactField</option>
+<option value="ContactField_properties">Â Â Â Â Â Â - Properties</option>
+<option value="ContactField_details">Â Â Â Â Â Â - Details</option>
+<option value="ContactField_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="ContactField_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="ContactField_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="ContactField_android_quirks">Â Â Â Â Â Â - Android Quirks</option>
+<option value="ContactField_blackberry_webworks_os_5_0_and_higher_quirks">Â Â Â Â Â Â - BlackBerry WebWorks (OS 5.0 and higher) Quirks</option>
+<option value="ContactField_ios_quirks">Â Â Â Â Â Â - iOS Quirks</option>
+<option value="ContactField_bada_quirks">Â Â Â Â Â Â - Bada Quirks</option>
+<option value="ContactFindOptions">ContactFindOptions</option>
+<option value="ContactFindOptions_properties">Â Â Â Â Â Â - Properties</option>
+<option value="ContactFindOptions_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="ContactFindOptions_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="ContactFindOptions_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="ContactFindOptions_bada_quirks">Â Â Â Â Â Â - Bada Quirks</option>
+<option value="ContactName">ContactName</option>
+<option value="ContactName_properties">Â Â Â Â Â Â - Properties</option>
+<option value="ContactName_details">Â Â Â Â Â Â - Details</option>
+<option value="ContactName_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="ContactName_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="ContactName_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="ContactName_android_quirks">Â Â Â Â Â Â - Android Quirks</option>
+<option value="ContactName_blackberry_webworks_os_5_0_and_higher_quirks">Â Â Â Â Â Â - BlackBerry WebWorks (OS 5.0 and higher) Quirks</option>
+<option value="ContactName_ios_quirks">Â Â Â Â Â Â - iOS Quirks</option>
+<option value="ContactName_bada_quirks">Â Â Â Â Â Â - Bada Quirks</option>
+<option value="ContactOrganization">ContactOrganization</option>
+<option value="ContactOrganization_properties">Â Â Â Â Â Â - Properties</option>
+<option value="ContactOrganization_details">Â Â Â Â Â Â - Details</option>
+<option value="ContactOrganization_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="ContactOrganization_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="ContactOrganization_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="ContactOrganization_android_2_x_quirks">Â Â Â Â Â Â - Android 2.X Quirks</option>
+<option value="ContactOrganization_blackberry_webworks_os_5_0_and_higher_quirks">Â Â Â Â Â Â - BlackBerry WebWorks (OS 5.0 and higher) Quirks</option>
+<option value="ContactOrganization_ios_quirks">Â Â Â Â Â Â - iOS Quirks</option>
+<option value="ContactOrganization_bada_2_0_quirks">Â Â Â Â Â Â - Bada 2.0 Quirks</option>
+<option value="ContactError">ContactError</option>
+<option value="ContactError_properties">Â Â Â Â Â Â - Properties</option>
+<option value="ContactError_constants">Â Â Â Â Â Â - Constants</option>
+<option value="ContactError_description">Â Â Â Â Â Â - Description</option>
+<option value="contactSuccess">contactSuccess</option>
+<option value="contactSuccess_parameters">Â Â Â Â Â Â - Parameters</option>
+<option value="contactSuccess_example">Â Â Â Â Â Â - Example</option>
+<option value="contactError">contactError</option>
+<option value="contactFields">contactFields</option>
+<option value="contactFindOptions">contactFindOptions</option>
+<option value="contactFindOptions_options">Â Â Â Â Â Â - Options</option></select></small>
+ </div>
+
+ <div id="sidebar">
+ <div class="vertical_divider"></div>
+ <h1>API Reference</h1>
+<ul>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+<h1>Guides</h1>
+<ul>
+<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
+<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
+<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
+<li><a href="guide_project-settings_index.md.html#Project%20Settings">Project Settings</a></li>
+<li><a href="guide_plugin-development_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
+<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="Contacts">Contacts</a></h1>
+
+<blockquote>
+ <p>The <code>contacts</code> object provides access to the device contacts database.</p>
+</blockquote>
+
+<h2>
+<a name="Contacts_methods">Methods</a>
+</h2>
+
+<ul>
+<li><a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a></li>
+<li><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></li>
+</ul>
+<h2>
+<a name="Contacts_arguments">Arguments</a>
+</h2>
+
+<ul>
+<li><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></li>
+<li><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a></li>
+<li><a href="cordova_contacts_contacts.md.html#contactError">contactError</a></li>
+<li><a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a></li>
+</ul>
+<h2>
+<a name="Contacts_objects">Objects</a>
+</h2>
+
+<ul>
+<li><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></li>
+<li><a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a></li>
+<li><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></li>
+<li><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a></li>
+<li><a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a></li>
+<li><a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a></li>
+<li><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></li>
+</ul>
+<h2>
+<a name="Contacts_permissions">Permissions</a>
+</h2>
+
+<h3>Android</h3>
+
+<h4>app/res/xml/config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a>" value="org.apache.cordova.ContactManager" />
+</code></pre>
+
+<h4>app/AndroidManifest.xml</h4>
+
+<pre class="prettyprint"><code><uses-permission android:name="android.permission.GET_ACCOUNTS" />
+<uses-permission android:name="android.permission.READ_CONTACTS" />
+<uses-permission android:name="android.permission.WRITE_CONTACTS" />
+</code></pre>
+
+<h3>Bada</h3>
+
+<h4>manifest.xml</h4>
+
+<pre class="prettyprint"><code><Privilege>
+ <Name>ADDRESSBOOK</Name>
+</Privilege>
+</code></pre>
+
+<h3>BlackBerry WebWorks</h3>
+
+<h4>www/plugins.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_contacts_contacts.md.html#Contact">Contact</a>" value="org.apache.cordova.pim.<a href="cordova_contacts_contacts.md.html#Contact">Contact</a>" />
+</code></pre>
+
+<h4>www/config.xml</h4>
+
+<pre class="prettyprint"><code><feature id="blackberry.find" required="true" version="1.0.0.0" />
+<feature id="blackberry.identity" required="true" version="1.0.0.0" />
+<feature id="blackberry.pim.Address" required="true" version="1.0.0.0" />
+<feature id="blackberry.pim.<a href="cordova_contacts_contacts.md.html#Contact">Contact</a>" required="true" version="1.0.0.0" />
+</code></pre>
+
+<h3>iOS</h3>
+
+<h4>config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a>" value="CDVContacts" />
+</code></pre>
+
+<h3>webOS</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>Windows Phone</h3>
+
+<h4>Properties/WPAppManifest.xml</h4>
+
+<pre class="prettyprint"><code><Capabilities>
+ <Capability Name="ID_CAP_CONTACTS" />
+</Capabilities>
+</code></pre>
+
+<p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx">Application Manifest for Windows Phone</a></p>
+
+<hr>
+<h1><a name="contacts.create">contacts.create</a></h1>
+
+<p>Returns a new <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> object.</p>
+
+<pre class="prettyprint"><code>var contact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>(properties);
+</code></pre>
+
+<h2>
+<a name="contacts.create_description">Description</a>
+</h2>
+
+<p><a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a> is a synchronous function that returns a new <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object.</p>
+
+<p>This method does not persist the <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> object to the device contacts database. To persist the <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> object to the device, invoke the <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a>.save</code> method.</p>
+
+<h2>
+<a name="contacts.create_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iOS</li>
+<li>Windows Phone 7 and 8</li>
+<li>Bada 1.2 & 2.0</li>
+</ul>
+<h2>
+<a name="contacts.create_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var myContact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>({"displayName": "Test User"});
+</code></pre>
+
+<h2>
+<a name="contacts.create_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_contacts_contacts.md.html#Contact">Contact</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var myContact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>({"displayName": "Test User"});
+ myContact.note = "This contact has a note.";
+ console.log("The contact, " + myContact.displayName + ", note: " + myContact.note);
+ }
+
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Create <a href="cordova_contacts_contacts.md.html#Contact">Contact</a></p>
+ </body>
+</html>
+</code></pre>
+
+<hr>
+<h1><a name="contacts.find">contacts.find</a></h1>
+
+<p>Queries the device contacts database and returns one or more <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> objects, each containing the fields specified.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(<a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a>, <a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a>, <a href="cordova_contacts_contacts.md.html#contactError">contactError</a>, <a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a>);
+</code></pre>
+
+<h2>
+<a name="contacts.find_description">Description</a>
+</h2>
+
+<p><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a> is an asynchronous function that queries the device contacts database and returns an array of <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> objects. The resulting objects are passed to the <code><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a></code> callback function specified by the <strong><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a></strong> parameter. </p>
+
+<p>Users must specify the contact fields to be used as a search qualifier in the <strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong> parameter. Only the fields specified in the <strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong> parameter will be returned as properties of the <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> objects that are passed to the <strong><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a></strong> callback function. A zero-length <strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong> parameter will result in an array of <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> objects with only the <code>id</code> property populated. A <strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong> value of ["*"] will return all c
ontact fields. </p>
+
+<p>The <strong><a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a>.filter</strong> string can be used as a search filter when querying the contacts database. If provided, a case-insensitive, partial value match is applied to each field specified in the <strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong> parameter. If a match is found in a comparison with <em>any</em> of the specified fields, the contact is returned.</p>
+
+<h2>
+<a name="contacts.find_parameters">Parameters</a>
+</h2>
+
+<ul>
+<li>
+<strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a>:</strong> <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> fields to be used as search qualifier. Only these fields will have values in the resulting <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> objects. <em>(DOMString[])</em> [Required]</li>
+<li>
+<strong><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a>:</strong> Success callback function that is invoked with the contacts returned from the contacts database. [Required]</li>
+<li>
+<strong><a href="cordova_contacts_contacts.md.html#contactError">contactError</a>:</strong> Error callback function. Invoked when error occurs. [Optional]</li>
+<li>
+<strong><a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a>:</strong> Search options to filter contacts. [Optional]</li>
+</ul>
+<h2>
+<a name="contacts.find_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iOS</li>
+<li>Windows Phone 7 and 8</li>
+<li>Bada 1.2 & 2.0</li>
+<li>Windows 8</li>
+</ul>
+<h2>
+<a name="contacts.find_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function onSuccess(contacts) {
+ alert('Found ' + contacts.length + ' contacts.');
+};
+
+function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert('onError!');
+};
+
+// find all contacts with 'Bob' in any name field
+var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
+options.filter="Bob";
+options.multiple=true;
+var fields = ["displayName", "name"];
+navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(fields, onSuccess, onError, options);
+</code></pre>
+
+<h2>
+<a name="contacts.find_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_contacts_contacts.md.html#Contact">Contact</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // find all contacts with 'Bob' in any name field
+ var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
+ options.filter="Bob";
+ var fields = ["displayName", "name"];
+ navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(fields, onSuccess, onError, options);
+ }
+
+ // onSuccess: Get a snapshot of the current contacts
+ //
+ function onSuccess(contacts) {
+ for (var i=0; i<contacts.length; i++) {
+ console.log("Display Name = " + contacts[i].displayName);
+ }
+ }
+
+ // onError: Failed to get the contacts
+ //
+ function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Find <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></p>
+ </body>
+</html>
+</code></pre>
+
+<hr>
+<h1><a name="Contact">Contact</a></h1>
+
+<p>Contains properties that describe a contact, such as a user's personal or business contact.</p>
+
+<h2>
+<a name="Contact_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>id:</strong> A globally unique identifier. <em>(DOMString)</em>
+</li>
+<li>
+<strong>displayName:</strong> The name of this <a href="cordova_contacts_contacts.md.html#Contact">Contact</a>, suitable for display to end-users. <em>(DOMString)</em>
+</li>
+<li>
+<strong>name:</strong> An object containing all components of a persons name. <em>(<a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a>)</em>
+</li>
+<li>
+<strong>nickname:</strong> A casual name to address the contact by. <em>(DOMString)</em>
+</li>
+<li>
+<strong>phoneNumbers:</strong> An array of all the contact's phone numbers. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em>
+</li>
+<li>
+<strong>emails:</strong> An array of all the contact's email addresses. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em>
+</li>
+<li>
+<strong>addresses:</strong> An array of all the contact's addresses. <em>(<a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a>[])</em>
+</li>
+<li>
+<strong>ims:</strong> An array of all the contact's IM addresses. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em>
+</li>
+<li>
+<strong>organizations:</strong> An array of all the contact's organizations. <em>(<a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a>[])</em>
+</li>
+<li>
+<strong>birthday:</strong> The birthday of the contact. <em>(Date)</em>
+</li>
+<li>
+<strong>note:</strong> A note about the contact. <em>(DOMString)</em>
+</li>
+<li>
+<strong>photos:</strong> An array of the contact's photos. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em>
+</li>
+<li>
+<strong>categories:</strong> An array of all the contacts user defined categories. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em>
+</li>
+<li>
+<strong>urls:</strong> An array of web pages associated to the contact. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em>
+</li>
+</ul>
+<h2>
+<a name="Contact_methods">Methods</a>
+</h2>
+
+<ul>
+<li>
+<strong>clone</strong>: Returns a new <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> object that is a deep copy of the calling object, with the id property set to <code>null</code>. </li>
+<li>
+<strong>remove</strong>: Removes the contact from the device contacts database. An error callback is called with a <code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></code> object if the removal is unsuccessful.</li>
+<li>
+<strong>save</strong>: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same <strong>id</strong> already exists.</li>
+</ul>
+<h2>
+<a name="Contact_details">Details</a>
+</h2>
+
+<p>The <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object represents a user contact. <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a> can be created, saved to, or removed from the device contacts database. <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a> can also be retrieved (individually or in bulk) from the database by invoking the <code><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></code> method.</p>
+
+<p><em>Note: Not all of the above contact fields are supported on every <a href="#device%20platform">device platform</a>. Please check each platform's Quirks section for information about which fields are supported.</em></p>
+
+<h2>
+<a name="Contact_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iOS</li>
+<li>Windows Phone 7 and 8</li>
+<li>Bada 1.2 & 2.0</li>
+<li>Windows 8</li>
+</ul>
+<h2>
+<a name="Contact_save_quick_example">Save Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function onSuccess(contact) {
+ alert("Save Success");
+};
+
+function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert("Error = " + <a href="cordova_contacts_contacts.md.html#contactError">contactError</a>.code);
+};
+
+// create a new contact object
+var contact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>();
+contact.displayName = "Plumber";
+contact.nickname = "Plumber"; //specify both to support all devices
+
+// populate some fields
+var name = new <a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a>();
+name.givenName = "Jane";
+name.familyName = "Doe";
+contact.name = name;
+
+// save to device
+contact.save(onSuccess,onError);
+</code></pre>
+
+<h2>
+<a name="Contact_clone_quick_example">Clone Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>// 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);
+</code></pre>
+
+<h2>
+<a name="Contact_remove_quick_example">Remove Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function onSuccess() {
+ alert("Removal Success");
+};
+
+function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert("Error = " + <a href="cordova_contacts_contacts.md.html#contactError">contactError</a>.code);
+};
+
+// remove the contact from the device
+contact.remove(onSuccess,onError);
+</code></pre>
+
+<h2>
+<a name="Contact_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_contacts_contacts.md.html#Contact">Contact</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // create
+ var contact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>();
+ contact.displayName = "Plumber";
+ contact.nickname = "Plumber"; //specify both to support all devices
+ var name = new <a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a>();
+ name.givenName = "Jane";
+ name.familyName = "Doe";
+ contact.name = name;
+
+ // save
+ contact.save(onSaveSuccess,onSaveError);
+
+ // clone
+ var clone = contact.clone();
+ clone.name.givenName = "John";
+ console.log("Original contact name = " + contact.name.givenName);
+ console.log("Cloned contact name = " + clone.name.givenName);
+
+ // remove
+ contact.remove(onRemoveSuccess,onRemoveError);
+ }
+
+ // onSaveSuccess: Get a snapshot of the current contacts
+ //
+ function onSaveSuccess(contact) {
+ alert("Save Success");
+ }
+
+ // onSaveError: Failed to get the contacts
+ //
+ function onSaveError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert("Error = " + <a href="cordova_contacts_contacts.md.html#contactError">contactError</a>.code);
+ }
+
+ // onRemoveSuccess: Get a snapshot of the current contacts
+ //
+ function onRemoveSuccess(contacts) {
+ alert("Removal Success");
+ }
+
+ // onRemoveError: Failed to get the contacts
+ //
+ function onRemoveError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert("Error = " + <a href="cordova_contacts_contacts.md.html#contactError">contactError</a>.code);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Find <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></p>
+ </body>
+</html>
+</code></pre>
+
+<h2>
+<a name="Contact_android_2_x_quirks">Android 2.X Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>categories:</strong> This property is not support by Android 2.X devices, and will always be returned as <code>null</code>.</li>
+</ul>
+<h2>
+<a name="Contact_blackberry_webworks_os_5_0_and_higher_quirks">BlackBerry WebWorks (OS 5.0 and higher) Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>id:</strong> Supported. Assigned by device when contact is saved.</li>
+<li>
+<strong>displayName:</strong> Supported. Stored in BlackBerry <strong>user1</strong> field.</li>
+<li>
+<strong>nickname:</strong> This property is not supported, and will always be returned as <code>null</code>. </li>
+<li>
+<strong>phoneNumbers:</strong> Partially supported. Phone numbers will be stored in BlackBerry fields <strong>homePhone1</strong> and <strong>homePhone2</strong> if <em>type</em> is 'home', <strong>workPhone1</strong> and <strong>workPhone2</strong> if <em>type</em> is 'work', <strong>mobilePhone</strong> if <em>type</em> is 'mobile', <strong>faxPhone</strong> if <em>type</em> is 'fax', <strong>pagerPhone</strong> if <em>type</em> is 'pager', and <strong>otherPhone</strong> if <em>type</em> is none of the above.</li>
+<li>
+<strong>emails:</strong> Partially supported. The first three email addresses will be stored in the BlackBerry <strong>email1</strong>, <strong>email2</strong>, and <strong>email3</strong> fields, respectively.</li>
+<li>
+<strong>addresses:</strong> Partially supported. The first and second addresses will be stored in the BlackBerry <strong>homeAddress</strong> and <strong>workAddress</strong> fields, respectively.</li>
+<li>
+<strong>ims:</strong> This property is not supported, and will always be returned as <code>null</code>. </li>
+<li>
+<strong>organizations:</strong> Partially supported. The <strong>name</strong> and <strong>title</strong> of the first organization are stored in the BlackBerry <strong>company</strong> and <strong>title</strong> fields, respectively.</li>
+<li>
+<strong>photos:</strong> - Partially supported. A single thumbnail-sized photo is supported. To set a contact's photo, pass in a either a Base64 encoded image, or a URL pointing to the image. The image will be scaled down before saving to the BlackBerry contacts database. The contact photo is returned as a Base64 encoded image.</li>
+<li>
+<strong>categories:</strong> Partially supported. Only 'Business' and 'Personal' categories are supported. </li>
+<li>
+<strong>urls:</strong> Partially supported. The first url is stored in BlackBerry <strong>webpage</strong> field.</li>
+</ul>
+<h2>
+<a name="Contact_ios_quirks">iOS Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>displayName:</strong> This property is not supported by iOS and will be returned as <code>null</code> unless there is no <a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a> specified. If there is no <a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a>, then composite name, <strong>nickname</strong> or "" is returned for <strong>displayName</strong>, respectively. </li>
+<li>
+<strong>birthday:</strong> For input, this property must be provided as a JavaScript Date object. It is returned as a JavaScript Date object.</li>
+<li>
+<strong>photos:</strong> Returned Photo is stored in the application's temporary directory and a <a href="cordova_file_file.md.html#File">File</a> URL to photo is returned. Contents of temporary folder is deleted when application exits. </li>
+<li>
+<strong>categories:</strong> This property is not currently supported and will always be returned as <code>null</code>.</li>
+</ul>
+<h2>
+<a name="Contact_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>displayName:</strong> When creating a contact, the value provided for the display name parameter differs from the display name retrieved when finding the contact. </li>
+<li>
+<strong>urls:</strong> When creating a contact, user inputs multiple web addresses in the url field and saves the contact. While pulling the information during the contact search url field do not <a href="cordova_splashscreen_splashscreen.md.html#show">show</a> up multiple web addresses</li>
+<li>
+<strong>phoneNumbers:</strong> <em>pref</em> is not supported, <em>type</em> is not supported in a <em>find</em> operation, only supports one phoneNumber of each <em>type</em>
+</li>
+<li>
+<strong>emails:</strong> <em>pref</em> is not supported, home and personal points to same email entry, supports only one entry for each <em>type</em>
+</li>
+<li>
+<strong>addresses:</strong> supports only <em>type</em> of work, home/personal, <em>type</em> home and personal points to same address entry, supports only one entry for each <em>type</em>
+</li>
+<li>
+<strong>organizations:</strong> Multiple <em>organizations</em> are not supported, does not support the attributes: <em>pref</em>, <em>type</em>, <em>department</em>
+</li>
+<li>
+<strong>note:</strong> This property is not supported, and will always be returned as <code>null</code>. </li>
+<li>
+<strong>ims:</strong> This property is not supported, and will always be returned as <code>null</code>. </li>
+<li>
+<strong>birthdays:</strong> This property is not supported, and will always be returned as <code>null</code>. </li>
+<li>
+<strong>categories:</strong> This property is not supported, and will always be returned as <code>null</code>. </li>
+</ul>
+<h2>
+<a name="Contact_bada_quirks">Bada Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>displayName:</strong> This property is not supported</li>
+<li>
+<strong>birthday:</strong> This property is not supported</li>
+<li>
+<strong>photos:</strong> This property should be a list with one URL to a photo</li>
+<li>
+<strong>categories:</strong> This property is not supported</li>
+<li>
+<strong>ims:</strong> This property is not supported</li>
+</ul>
+<hr>
+<h1><a name="ContactAddress">ContactAddress</a></h1>
+
+<p>Contains address properties for a <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object.</p>
+
+<h2>
+<a name="ContactAddress_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>pref:</strong> Set to <code>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a></code> contains the user's preferred value. <em>(boolean)</em>
+</li>
+<li>
+<strong>type:</strong> A string that tells you what type of field this is (example: 'home'). _(DOMString)</li>
+<li>
+<strong>formatted:</strong> The full address formatted for display. <em>(DOMString)</em>
+</li>
+<li>
+<strong>streetAddress:</strong> The full street address. <em>(DOMString)</em>
+</li>
+<li>
+<strong>locality:</strong> The city or locality. <em>(DOMString)</em>
+</li>
+<li>
+<strong>region:</strong> The state or region. <em>(DOMString)</em>
+</li>
+<li>
+<strong>postalCode:</strong> The zip code or postal code. <em>(DOMString)</em>
+</li>
+<li>
+<strong>country:</strong> The country name. <em>(DOMString)</em>
+</li>
+</ul>
+<h2>
+<a name="ContactAddress_details">Details</a>
+</h2>
+
+<p>The <code><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a></code> object stores the properties of a single address of a contact. A <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object can have one or more addresses in a <code><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a>[]</code> array. </p>
+
+<h2>
+<a name="ContactAddress_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iOS</li>
+<li>Bada 1.2 & 2.0</li>
+<li>Windows Phone 7 and 8</li>
+<li>Windows 8</li>
+</ul>
+<h2>
+<a name="ContactAddress_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>// display the address information for all contacts
+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(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert('onError!');
+};
+
+// find all contacts
+var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
+options.filter="";
+var filter = ["displayName","addresses"];
+navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
+</code></pre>
+
+<h2>
+<a name="ContactAddress_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_contacts_contacts.md.html#Contact">Contact</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // find all contacts
+ var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
+ options.filter="";
+ var filter = ["displayName","addresses"];
+ navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
+ }
+
+ // onSuccess: Get a snapshot of the current contacts
+ //
+ function onSuccess(contacts) {
+ // display the address information for all 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);
+ }
+ }
+ };
+
+ // onError: Failed to get the contacts
+ //
+ function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Find <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></p>
+ </body>
+</html>
+</code></pre>
+
+<h2>
+<a name="ContactAddress_android_2_x_quirks">Android 2.X Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>pref:</strong> This property is not supported by Android 2.X devices and will always return <code>false</code>.</li>
+</ul>
+<h2>
+<a name="ContactAddress_blackberry_webworks_os_5_0_and_higher_quirks">BlackBerry WebWorks (OS 5.0 and higher) Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>pref:</strong> This property is not supported on Blackberry devices and will always return <code>false</code>.</li>
+<li>
+<strong>type:</strong> Partially supported. Only one each of "Work" and "Home" type addresses can be stored per contact. </li>
+<li>
+<strong>formatted:</strong> Partially supported. Will return concatenation of all BlackBerry address fields.</li>
+<li>
+<strong>streetAddress:</strong> Supported. Will return concatenation of BlackBerry <strong>address1</strong> and <strong>address2</strong> address fields. </li>
+<li>
+<strong>locality:</strong> Supported. Stored in BlackBerry <strong>city</strong> address field.</li>
+<li>
+<strong>region:</strong> Supported. Stored in BlackBerry <strong>stateProvince</strong> address field.</li>
+<li>
+<strong>postalCode:</strong> Supported. Stored in BlackBerry <strong>zipPostal</strong> address field.</li>
+<li>
+<strong>country:</strong> Supported.</li>
+</ul>
+<h2>
+<a name="ContactAddress_ios_quirks">iOS Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>pref:</strong> This property is not supported on iOS devices and will always return <code>false</code>.</li>
+<li>
+<strong>formatted:</strong> Not currently supported.</li>
+</ul>
+<h2>
+<a name="ContactAddress_bada_quirks">Bada Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>formatted:</strong> This property is not supported</li>
+<li>
+<strong>type:</strong> Has to be one of the following: WORK, HOME</li>
+</ul>
+<hr>
+<h1><a name="ContactField">ContactField</a></h1>
+
+<p>Supports generic fields in a <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object. Some properties that are stored as <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> objects include email addresses, phone numbers, and urls.</p>
+
+<h2>
+<a name="ContactField_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>type:</strong> A string that tells you what type of field this is (example: 'home'). <em>(DOMString)</em>
+</li>
+<li>
+<strong>value:</strong> The value of the field (such as a phone number or email address). <em>(DOMString)</em>
+</li>
+<li>
+<strong>pref:</strong> Set to <code>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> contains the user's preferred value. <em>(boolean)</em>
+</li>
+</ul>
+<h2>
+<a name="ContactField_details">Details</a>
+</h2>
+
+<p>The <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> object is a reusable component that is used to support contact fields in a generic fashion. Each <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> object contains a value property, a type property, and a pref property. A <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object stores several properties in <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[]</code> arrays, such as phone numbers and email addresses.</p>
+
+<p>In most instances, there are no pre-determined values for the <strong>type</strong> attribute of a <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> object. For example, a phone number can have <strong>type</strong> values of 'home', 'work', 'mobile', 'iPhone', or any other value that is supported by the contact database on a particular <a href="#device%20platform">device platform</a>. However, in the case of the <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> <strong>photos</strong> field, Cordova makes use of the <strong>type</strong> field to indicate the format of the returned image. Cordova will return <strong>type: 'url'</strong> when the <strong>value</strong> attribute contains a URL to the photo image, or <strong>type: 'base64'</strong> when the returned <strong>value</strong> attribute contains a Base64 encoded image string.</p>
+
+<h2>
+<a name="ContactField_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iOS</li>
+<li>Bada 1.2 & 2.0</li>
+<li>Windows Phone 7 and 8</li>
+<li>Windows 8</li>
+</ul>
+<h2>
+<a name="ContactField_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>// create a new contact
+var contact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>();
+
+// store contact phone numbers in <a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[]
+var phoneNumbers = [];
+phoneNumbers[0] = new <a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>('work', '212-555-1234', false);
+phoneNumbers[1] = new <a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>('mobile', '917-555-5432', true); // preferred number
+phoneNumbers[2] = new <a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>('home', '203-555-7890', false);
+contact.phoneNumbers = phoneNumbers;
+
+// save the contact
+contact.save();
+</code></pre>
+
+<h2>
+<a name="ContactField_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_contacts_contacts.md.html#Contact">Contact</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // create a new contact
+ var contact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>();
+
+ // store contact phone numbers in <a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[]
+ var phoneNumbers = [];
+ phoneNumbers[0] = new <a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>('work', '212-555-1234', false);
+ phoneNumbers[1] = new <a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>('mobile', '917-555-5432', true); // preferred number
+ phoneNumbers[2] = new <a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>('home', '203-555-7890', false);
+ contact.phoneNumbers = phoneNumbers;
+
+ // save the contact
+ contact.save();
+
+ // search contacts, returning display name and phone numbers
+ var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
+ options.filter="";
+ filter = ["displayName","phoneNumbers"];
+ navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
+ }
+
+ // onSuccess: Get a snapshot of the current contacts
+ //
+ function onSuccess(contacts) {
+ for (var i=0; i<contacts.length; i++) {
+ // display phone numbers
+ for (var j=0; j<contacts[i].phoneNumbers.length; j++) {
+ alert("Type: " + contacts[i].phoneNumbers[j].type + "\n" +
+ "Value: " + contacts[i].phoneNumbers[j].value + "\n" +
+ "Preferred: " + contacts[i].phoneNumbers[j].pref);
+ }
+ }
+ };
+
+ // onError: Failed to get the contacts
+ //
+ function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Find <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></p>
+ </body>
+</html>
+</code></pre>
+
+<h2>
+<a name="ContactField_android_quirks">Android Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>pref:</strong> This property is not support by Android devices, and will always return <code>false</code>.</li>
+</ul>
+<h2>
+<a name="ContactField_blackberry_webworks_os_5_0_and_higher_quirks">BlackBerry WebWorks (OS 5.0 and higher) Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>type:</strong> Partially supported. Used for phone numbers.</li>
+<li>
+<strong>value:</strong> Supported.</li>
+<li>
+<strong>pref:</strong> This property is not supported, and will always return <code>false</code>.</li>
+</ul>
+<h2>
+<a name="ContactField_ios_quirks">iOS Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>pref:</strong> This property is not supported on iOS devices and will always return <code>false</code>.</li>
+</ul>
+<h2>
+<a name="ContactField_bada_quirks">Bada Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>type:</strong> Property has to be one of the following for Email or Address fields: "WORK", "HOME". Property has to be one of the following for Phone fields: "WORK", "HOME", "VOICE", "FAX", "MSG", "CELL", "PAGER","BBS", "MODEM", "CAR", "ISDN","VIDEO", "PCS"</li>
+</ul>
+<hr>
+<h1><a name="ContactFindOptions">ContactFindOptions</a></h1>
+
+<p>Contains properties that can be used to filter the results of a <code><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></code> operation.</p>
+
+<h2>
+<a name="ContactFindOptions_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>filter:</strong> The search string used to find contacts. <em>(DOMString)</em> (Default: "")</li>
+<li>
+<strong>multiple:</strong> Determines if the find operation should return multiple contacts. <em>(Boolean)</em> (Default: false)</li>
+</ul>
+<h2>
+<a name="ContactFindOptions_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iOS</li>
+<li>Bada 1.2 & 2.0</li>
+<li>Windows Phone 7 and 8</li>
+<li>Windows 8</li>
+</ul>
+<h2>
+<a name="ContactFindOptions_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>// success callback
+function onSuccess(contacts) {
+ for (var i=0; i<contacts.length; i++) {
+ alert(contacts[i].displayName);
+ }
+};
+
+// error callback
+function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert('onError!');
+};
+
+// specify contact search criteria
+var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
+options.filter=""; // empty search string returns all contacts
+options.multiple=true; // return multiple results
+filter = ["displayName"]; // return contact.displayName field
+
+// find contacts
+navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
+</code></pre>
+
+<h2>
+<a name="ContactFindOptions_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_contacts_contacts.md.html#Contact">Contact</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // specify contact search criteria
+ var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
+ options.filter=""; // empty search string returns all contacts
+ options.multiple=true; // return multiple results
+ filter = ["displayName"]; // return contact.displayName field
+
+ // find contacts
+ navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
+ }
+
+ // onSuccess: Get a snapshot of the current contacts
+ //
+ function onSuccess(contacts) {
+ for (var i=0; i<contacts.length; i++) {
+ alert(contacts[i].displayName);
+ }
+ };
+
+ // onError: Failed to get the contacts
+ //
+ function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Find <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></p>
+ </body>
+</html>
+</code></pre>
+
+<h2>
+<a name="ContactFindOptions_bada_quirks">Bada Quirks</a>
+</h2>
+
+<p><strong>filter:</strong> Property can only apply to the following: "firstName", "lastName", "nickname", "phoneNumber", "email", "address"</p>
+
+<hr>
+<h1><a name="ContactName">ContactName</a></h1>
+
+<p>Contains name properties of a <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object.</p>
+
+<h2>
+<a name="ContactName_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>formatted:</strong> The complete name of the contact. <em>(DOMString)</em>
+</li>
+<li>
+<strong>familyName:</strong> The contacts family name. <em>(DOMString)</em>
+</li>
+<li>
+<strong>givenName:</strong> The contacts given name. <em>(DOMString)</em>
+</li>
+<li>
+<strong>middleName:</strong> The contacts middle name. <em>(DOMString)</em>
+</li>
+<li>
+<strong>honorificPrefix:</strong> The contacts prefix (example Mr. or Dr.) <em>(DOMString)</em>
+</li>
+<li>
+<strong>honorificSuffix:</strong> The contacts suffix (example Esq.). <em>(DOMString)</em>
+</li>
+</ul>
+<h2>
+<a name="ContactName_details">Details</a>
+</h2>
+
+<p>The <code><a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a></code> object stores name properties of a contact.</p>
+
+<h2>
+<a name="ContactName_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android 2.X</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iOS</li>
+<li>Bada 1.2 & 2.0</li>
+<li>Windows Phone 7 and 8</li>
+<li>Windows 8</li>
+</ul>
+<h2>
+<a name="ContactName_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function onSuccess(contacts) {
+ for (var i=0; i<contacts.length; i++) {
+ 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(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert('onError!');
+};
+
+var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
+options.filter="";
+filter = ["displayName","name"];
+navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
+</code></pre>
+
+<h2>
+<a name="ContactName_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_contacts_contacts.md.html#Contact">Contact</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
+ options.filter="";
+ filter = ["displayName","name"];
+ navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
+ }
+
+ // onSuccess: Get a snapshot of the current contacts
+ //
+ 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.honorificPrefix);
+ }
+ };
+
+ // onError: Failed to get the contacts
+ //
+ function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Find <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></p>
+ </body>
+</html>
+</code></pre>
+
+<h2>
+<a name="ContactName_android_quirks">Android Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>formatted:</strong> Partially supported. Will return the concatenation of honorificPrefix, givenName, middleName, familyName and honorificSuffix but will not store.</li>
+</ul>
+<h2>
+<a name="ContactName_blackberry_webworks_os_5_0_and_higher_quirks">BlackBerry WebWorks (OS 5.0 and higher) Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>formatted:</strong> Partially supported. Will return concatenation of BlackBerry <strong>firstName</strong> and <strong>lastName</strong> fields.</li>
+<li>
+<strong>familyName:</strong> Supported. Stored in BlackBerry <strong>lastName</strong> field.</li>
+<li>
+<strong>givenName:</strong> Supported. Stored in BlackBerry <strong>firstName</strong> field.</li>
+<li>
+<strong>middleName:</strong> This property is not supported, and will always return <code>null</code>.</li>
+<li>
+<strong>honorificPrefix:</strong> This property is not supported, and will always return <code>null</code>.</li>
+<li>
+<strong>honorificSuffix:</strong> This property is not supported, and will always return <code>null</code>.</li>
+</ul>
+<h2>
+<a name="ContactName_ios_quirks">iOS Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>formatted:</strong> Partially supported. Will return iOS Composite Name but will not store.</li>
+</ul>
+<h2>
+<a name="ContactName_bada_quirks">Bada Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>formatted:</strong> Property not supported</li>
+<li>
+<strong>middleName:</strong> Property not supported
+_ <strong>honorificPrefix:</strong> Property not supported</li>
+<li>
+<strong>honorificSuffix:</strong> Property not supported</li>
+</ul>
+<hr>
+<h1><a name="ContactOrganization">ContactOrganization</a></h1>
+
+<p>Contains organization properties of a <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object.</p>
+
+<h2>
+<a name="ContactOrganization_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>pref:</strong> Set to <code>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a></code> contains the user's preferred value. <em>(boolean)</em>
+</li>
+<li>
+<strong>type:</strong> A string that tells you what type of field this is (example: 'home'). _(DOMString)</li>
+<li>
+<strong>name:</strong> The name of the organization. <em>(DOMString)</em>
+</li>
+<li>
+<strong>department:</strong> The department the contract works for. <em>(DOMString)</em>
+</li>
+<li>
+<strong>title:</strong> The contacts title at the organization. <em>(DOMString)</em>
+</li>
+</ul>
+<h2>
+<a name="ContactOrganization_details">Details</a>
+</h2>
+
+<p>The <code><a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a></code> object stores a contact's organization properties. A <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object stores one or more <code><a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a></code> objects in an array. </p>
+
+<h2>
+<a name="ContactOrganization_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iOS</li>
+<li>Bada 1.2</li>
+<li>Windows Phone 7 and 8</li>
+<li>Windows 8</li>
+</ul>
+<h2>
+<a name="ContactOrganization_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function onSuccess(contacts) {
+ for (var i=0; i<contacts.length; i++) {
+ 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(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert('onError!');
+};
+
+var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
+options.filter="";
+filter = ["displayName","organizations"];
+navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
+</code></pre>
+
+<h2>
+<a name="ContactOrganization_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_contacts_contacts.md.html#Contact">Contact</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
+ options.filter="";
+ filter = ["displayName","organizations"];
+ navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
+ }
+
+ // onSuccess: Get a snapshot of the current contacts
+ //
+ 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);
+ }
+ }
+ };
+
+ // onError: Failed to get the contacts
+ //
+ function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Find <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></p>
+ </body>
+</html>
+</code></pre>
+
+<h2>
+<a name="ContactOrganization_android_2_x_quirks">Android 2.X Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>pref:</strong> This property is not supported by Android 2.X devices and will always return <code>false</code>.</li>
+</ul>
+<h2>
+<a name="ContactOrganization_blackberry_webworks_os_5_0_and_higher_quirks">BlackBerry WebWorks (OS 5.0 and higher) Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>pref:</strong> This property is not supported by Blackberry devices and will always return <code>false</code>.</li>
+<li>
+<strong>type:</strong> This property is not supported by Blackberry devices and will always return <code>null</code>.</li>
+<li>
+<strong>name:</strong> Partially supported. The first organization name will be stored in the BlackBerry <strong>company</strong> field.</li>
+<li>
+<strong>department:</strong> This property is not supported, and will always be returned as <code>null</code>.</li>
+<li>
+<strong>title:</strong> Partially supported. The first organization title will be stored in the BlackBerry <strong>jobTitle</strong> field.</li>
+</ul>
+<h2>
+<a name="ContactOrganization_ios_quirks">iOS Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>pref:</strong> This property is not supported on iOS devices and will always return <code>false</code>.</li>
+<li>
+<strong>type:</strong> This property is not supported on iOS devices and will always return <code>null</code>.</li>
+<li>
+<strong>name:</strong> Partially supported. The first organization name will be stored in the iOS <strong>kABPersonOrganizationProperty</strong> field.</li>
+<li>
+<strong>department</strong>: Partially supported. The first department name will be stored in the iOS <strong>kABPersonDepartmentProperty</strong> field.</li>
+<li>
+<strong>title</strong>: Partially supported. The first title will be stored in the iOS <strong>kABPersonJobTitleProperty</strong> field.</li>
+</ul>
+<h2>
+<a name="ContactOrganization_bada_2_0_quirks">Bada 2.0 Quirks</a>
+</h2>
+
+<ul>
+<li>
+<a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a> not supported</li>
+</ul>
+<hr>
+<h1><a name="ContactError">ContactError</a></h1>
+
+<p>A <code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></code> object is returned to the <code><a href="cordova_contacts_contacts.md.html#contactError">contactError</a></code> callback when an error occurs.</p>
+
+<h2>
+<a name="ContactError_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>code:</strong> One of the predefined error codes listed below.</li>
+</ul>
+<h2>
+<a name="ContactError_constants">Constants</a>
+</h2>
+
+<ul>
+<li><code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a>.UNKNOWN_ERROR</code></li>
+<li><code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a>.INVALID_ARGUMENT_ERROR</code></li>
+<li><code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a>.TIMEOUT_ERROR</code></li>
+<li><code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a>.PENDING_OPERATION_ERROR</code></li>
+<li><code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a>.IO_ERROR</code></li>
+<li><code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a>.NOT_SUPPORTED_ERROR</code></li>
+<li><code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a>.PERMISSION_DENIED_ERROR</code></li>
+</ul>
+<h2>
+<a name="ContactError_description">Description</a>
+</h2>
+
+<p>The <code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></code> object is returned to the user through the <code><a href="cordova_contacts_contacts.md.html#contactError">contactError</a></code> callback function when an error occurs.</p>
+
+<hr>
+<h1><a name="contactSuccess">contactSuccess</a></h1>
+
+<p>Success callback function that provides the <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> array resulting from a <code><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></code> operation.</p>
+
+<pre class="prettyprint"><code>function(contacts) {
+ // Do something
+}
+</code></pre>
+
+<h2>
+<a name="contactSuccess_parameters">Parameters</a>
+</h2>
+
+<ul>
+<li>
+<strong>contacts:</strong> The contact array resulting from a find operation. (<code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code>)</li>
+</ul>
+<h2>
+<a name="contactSuccess_example">Example</a>
+</h2>
+
+<pre class="prettyprint"><code>function <a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a>(contacts) {
+ for (var i=0; i<contacts.length; i++) {
+ console.log("Display Name = " + contacts[i].displayName;
+}
+</code></pre>
+
+<hr>
+<h1><a name="contactError">contactError</a></h1>
+
+<p>Error callback function for contact functions.</p>
+
+<pre class="prettyprint"><code>function(error) {
+ // Handle the error
+}
+</code></pre>
+
+<hr>
+<h1><a name="contactFields">contactFields</a></h1>
+
+<p>Required parameter of the <code><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></code> method. Use this parameter to specify which fields should be included in the <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> objects resulting from a find operation.</p>
+
+<pre class="prettyprint"><code>["name", "phoneNumbers", "emails"]
+</code></pre>
+
+<hr>
+<h1><a name="contactFindOptions">contactFindOptions</a></h1>
+
+<p>Optional parameter of the <code><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></code> method. Use this parameter to filter the contacts returned from the contacts database.</p>
+
+<pre class="prettyprint"><code>{
+ filter: "",
+ multiple: true,
+};
+</code></pre>
+
+<h2>
+<a name="contactFindOptions_options">Options</a>
+</h2>
+
+<ul>
+<li>
+<strong>filter:</strong> The search string used to filter contacts. <em>(DOMString)</em> (Default: "")</li>
+<li>
+<strong>multiple:</strong> Determines if the find operation should return multiple contacts. <em>(Boolean)</em> (Default: false)</li>
+</ul>
+</div>
+ </div>
+
+ <!-- Functionality and Syntax Highlighting -->
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
+</html>