Contacts

The contacts object 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

Arguments

Objects

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:

  • Amazon Fire OS

      (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" />

  • Android

      (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" />

  • BlackBerry 10

      (in www/config.xml)

  <feature name="Contacts" value="Contacts"/>
  <rim:permit>access_pimdomain_contacts</rim:permit>

  • iOS (in the named application directory's config.xml)

      <feature name="Contacts">
      <param name="ios-package" value="CDVContacts" />
  </feature>

  • FirefoxOS

      Enable access to the API by changing [app permissions](https://developer.mozilla.org/en-US/Apps/Developing/App_permissions)

  (in platforms/firefoxos/www/manifest.webapp)
  "type": "privileged",
  "permissions": {
      "contacts": {
          "access": (choose from "readonly", "readwrite", "readcreate", or "createonly"),
          "description": "Describe why you need access to contacts API"
      }
  }

  All privileged apps enforce [Content Security Policy](https://developer.mozilla.org/en-US/Apps/CSP) 
  which forbids inline scripts. Initialize your application in another way.

  • Windows Phone (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 for an overview.