contactsobject provides access to the device contacts database.
Accessing the Feature
As of version 3.0, Cordova implements device-level APIs as plugins.
Use the CLI's
plugin command, described in The Command-line
Interface, to add or remove this feature for a project:
$ cordova plugin add org.apache.cordova.contacts $ cordova plugin ls [ 'org.apache.cordova.contacts' ] $ cordova plugin rm org.apache.cordova.contacts
These commands apply to all targeted platforms, but modify the platform-specific configuration settings described below:
(in app/res/xml/config.xml) <feature name="Contacts"> <param name="android-package" value="org.apache.cordova.contacts.ContactManager" /> </feature> (in app/AndroidManifest.xml) <uses-permission android:name="android.permission.READ_CONTACTS" /> <uses-permission android:name="android.permission.WRITE_CONTACTS" /> <uses-permission android:name="android.permission.GET_ACCOUNTS" />
(in www/plugins.xml) <feature name="Contact"> <param name="blackberry-package" value="org.apache.cordova.pim.Contact" /> </feature> (in www/config.xml) <feature id="blackberry.find" required="true" version="126.96.36.199" /> <feature id="blackberry.identity" required="true" version="188.8.131.52" /> <feature id="blackberry.pim.Address" required="true" version="184.108.40.206" /> <feature id="blackberry.pim.Contact" required="true" version="220.127.116.11" />
<feature name="Contacts"> <param name="ios-package" value="CDVContacts" /> </feature>
(in Properties/WPAppManifest.xml) <Capabilities> <Capability Name="ID_CAP_CONTACTS" /> </Capabilities>
Reference: Application Manifest for Windows Phone
Some platforms may support this feature without requiring any special configuration. See Platform Support in the Overview section.