Contacts

The contacts object provides access to the device contacts database.

Important privacy note: 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 your app's privacy policy, you should strongly consider providing a just-in-time notice prior to your app accessing or using 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 your app to provide just-in-time notice and obtain permission from the user prior to accessing contact data. A clear and easy to understand user experience surrounding the use of contact data will help avoid user confusion and perceived misuse of contact data. For more information, please see the Privacy Guide.

Methods

• contacts.create
• contacts.find

Arguments

• contactFields
• contactSuccess
• contactError
• contactFindOptions

Objects

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

Permissions

Android

app/res/xml/config.xml

<plugin name="Contacts" value="org.apache.cordova.ContactManager" />

app/AndroidManifest.xml

<uses-permission android:name="android.permission.GET_ACCOUNTS" />
<uses-permission android:name="android.permission.READ_CONTACTS" />
<uses-permission android:name="android.permission.WRITE_CONTACTS" />

Bada

manifest.xml

<Privilege>
    <Name>ADDRESSBOOK</Name>
</Privilege>

BlackBerry WebWorks

www/plugins.xml

<plugin name="Contact" value="org.apache.cordova.pim.Contact" />

www/config.xml

<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.Contact" required="true" version="1.0.0.0" />

iOS

config.xml

<plugin name="Contacts" value="CDVContacts" />

webOS

No permissions are required.

Windows Phone

Properties/WPAppManifest.xml

<Capabilities>
    <Capability Name="ID_CAP_CONTACTS" />
</Capabilities>

Reference: Application Manifest for Windows Phone