React Native Contacts
To contribute read CONTRIBUTING.md.
Rx support with react-native-contacts-rx
Latest version is available on npm the releases tab is not always updated.
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.
Also there is a lot of room for performance enhancements in both iOS and android. PR's welcome!
var Contacts = 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.
var Contacts = Contacts
Installation
run:
npm install react-native-contacts
react-native link react-native-contacts
For versions of RN before v0.21.0 use the old instructions.
iOS Permissions
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".
Android Permissions
Add permissions to your android/app/src/main/AndroidManifest.xml
file. Add only the permissions you need (i.e. if you don't need the WRITE_CONTACTS permission then there's no need to add it).
... ...
Status
- Preliminary iOS and Android support
- API subject to revision, changelog in release notes
Feature | iOS | Android |
---|---|---|
getAll |
✔ | ✔ |
addContact |
✔ | ✔ |
updateContact |
✔ | ✔ |
deleteContact |
✔ | 😞 |
getContactsMatchingString |
✔ | ✔ |
get with options | 😞 | 😞 |
groups | 😞 | 😞 |
API
getAll
(callback) - returns all contacts as an array of objectsgetAllWithoutPhotos
- same asgetAll
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 photoaddContact
(contact, callback) - adds a contact to the AddressBook.updateContact
(contact, callback) - where contact is an object with a valid recordIDdeleteContact
(contact, callback) - where contact is an object with a valid recordIDgetContactsMatchingString
(string, callback) - where string is any string to match a name (first, middle, family) tocheckPermission
(callback) - checks permission to access ContactsrequestPermission
(callback) - request permission to access Contacts
Example Contact Record
recordID: '6b2237ee0df85980' company: "" emailAddresses: label: "work" email: "carl-jung@example.com" familyName: "Jung" givenName: "Carl" jobTitle: "" middleName: "" phoneNumbers: label: "mobile" number: "(555) 555-5555" hasThumbnail: true thumbnailPath: 'content://com.android.contacts/display_photo/3' postalAddresses: street: '123 Fake Street' city: 'Sample City' state: 'CA' region: 'CA' postCode: '90210' country: 'USA' label: 'home'
NOTE
- on Android the entire display name is passed in the
givenName
field.middleName
andfamilyName
will be""
.
Adding Contacts
Currently all fields from the contact record except for thumbnailPath are supported for writing
var newPerson = emailAddresses: label: "work" email: "mrniet@example.com" familyName: "Nietzsche" givenName: "Friedrich" Contacts
Updating and Deleting Contacts
//contrived exampleContacts
Update and delete reference contacts by their recordID (as returned by the OS in getContacts). Apple does not guarantee the recordID will not change, e.g. it may be reassigned during a phone migration. Consequently you should always grab a fresh contact list with getContacts
before performing update and delete operations.
You can also delete a record using only it's recordID like follows: Contacts.deleteContact({recordID: 1}, (err) => {})}
Displaying Thumbnails
The thumbnailPath is the direct URI for the temp location of the contact's cropped thumbnail image.
<Image source=uri: contactthumbnailPath />
Permissions Methods (optional)
checkPermission
(callback) - checks permission to access Contacts.
requestPermission
(callback) - request permission to access Contacts.
Usage as follows:
Contacts
These methods do not re-request permission if permission has already been granted or denied. This is a limitation in iOS, the best you can do is prompt the user with instructions for how to enable contacts from the phone settings page Settings > [app name] > contacts
.
On android permission request is done upon install so this function will only show if the permission has been granted.
Todo
- android feature parity
- migrate iOS from AddressBook to Contacts
- implement
get
with options - groups support