React Native Contacts

To contribute read CONTRIBUTING.md.

Usage

getAll is a database intensive process, and can take a long time to complete depending on the size of the contacts list. Because of this, it is recommended you access the getAll method before it is needed, and cache the results for future use.

``js
var Contacts = require('react-native-custom-contacts')

Contacts.getAll((err, contacts) => {
if (err) throw err;

// contacts returned
console.log(contacts)
})
`

getContactMatchingString is meant to alleviate the amount of time it takes to get all contacts, by filtering on the native side based on a string.

`js
var Contacts = require('react-native-custom-contacts')

Contacts.getContactsMatchingString("filter", (err, contacts) => {
if (err) throw err;

// contacts matching "filter"
console.log(contacts)
})
`


Installation




$3

run:

npm install react-native-custom-contacts
react-native link react-native-custom-contacts

or if you use yarn:

yarn add react-native-custom-contacts
react-native link react-native-custom-contacts

$3

1. In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
1. add ./node_modules/react-native-custom-contacts/ios/RCTContacts.xcodeproj
1. In the XCode project navigator, select your project, select the Build Phases tab and in the Link Binary With Libraries section add libRCTContacts.a

$3

As of Xcode 8 and React Native 0.33 it is now necessary to add kit specific "permission" keys to your Xcode Info.plist file, in order to make requestPermission work. Otherwise your app crashes when requesting the specific permission. I discovered this after days of frustration.

Open Xcode > Info.plist > Add a key (starting with "Privacy - ...") with your kit specific permission. The value for the key is optional in development. If you submit to the App Store the value must explain why you need this permission.

You have to add the key "Privacy - Contacts Usage Description".

$3


Android requires allowing permissions with https://facebook.github.io/react-native/docs/permissionsandroid.html
The READ_CONTACTS permission is automatically added to the AndroidManifest.xml, so you just need request it. If your app also needs to create contacts, don't forget to add WRITE_CONTACTS permission to the manifest and request it at runtime.

API

getAll (callback) - returns all* contacts as an array of objects
* getAllWithoutPhotos - same as getAll on Android, but on iOS it will not return uris for contact photos (because there's a significant overhead in creating the images)
* getPhotoForId(contactId, callback) - returns a URI (or null) for a contacts photo
* addContact (contact, callback) - adds a contact to the AddressBook.
* openContactForm (contact, callback) - create a new contact and display in contactsUI.
* updateContact (contact, callback) - where contact is an object with a valid recordID
* deleteContact (contact, callback) - where contact is an object with a valid recordID
* getContactsMatchingString (string, callback) - where string is any string to match a name (first, middle, family) to
* checkPermission (callback) - checks permission to access Contacts _ios only_
* requestPermission (callback) - request permission to access Contacts _ios only_

Callbacks follow node-style:
`sh
callback
err
response