cordova.contacts

Provides access to the device contacts database.

WARNING: Collection and use of contact data raises important privacy issues. Your app’s privacy policy should discuss how the app uses contact data and whether it is shared with any other parties. Contact information is considered sensitive because it reveals the people with whom a person communicates. Therefore, in addition to the app’s privacy policy, you should strongly consider providing a just-in-time notice before the app accesses or uses contact data, if the device operating system doesn’t do so already. That notice should provide the same information noted above, as well as obtaining the user’s permission (e.g., by presenting choices for OK and No Thanks). Note that some app marketplaces may require the app to provide a just-in-time notice and obtain the user’s permission before accessing contact data. A clear and easy-to-understand user experience surrounding the use of contact data helps avoid user confusion and perceived misuse of contact data. For more information, please see the Privacy Guide.

Methods

• navigator.contacts.create
• navigator.contacts.find
• navigator.contacts.pickContact

Objects

• Contact
• ContactName
• ContactField
• ContactAddress
• ContactOrganization
• ContactFindOptions
• ContactError
• ContactFieldType

Save Example

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;

// save to device
contact.save(onSuccess,onError);

Clone Example

// 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);

Find Example

function onSuccess() {
  alert(“Removal Success”);
};

function onError(contactError) {
  alert(“Error = ” + contactError.code);
};

// remove the contact from the device

contact.remove(onSuccess,onError);

Find Example

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];

var fields = [navigator.contacts.fieldType.displayName, navigator.contacts.fieldType.name];

navigator.contacts.find(fields, onSuccess, onError, options);

Source Documentation: http://plugins.cordova.io/#/package/org.apache.cordova.contacts