react-native-custom-contacts
v1.0.4
Published
To contribute read [CONTRIBUTING.md](CONTRIBUTING.md).
Downloads
2
Readme
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.
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.
var Contacts = require('react-native-custom-contacts')
Contacts.getContactsMatchingString("filter", (err, contacts) => {
if (err) throw err;
// contacts matching "filter"
console.log(contacts)
})
Installation
With React Native Link
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
Manual installation
- In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
- add ./node_modules/react-native-custom-contacts/ios/RCTContacts.xcodeproj
- In the XCode project navigator, select your project, select the Build Phases tab and in the Link Binary With Libraries section add libRCTContacts.a
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
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 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.openContactForm
(contact, callback) - create a new contact and display in contactsUI.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 Contacts ios onlyrequestPermission
(callback) - request permission to access Contacts ios only
Callbacks follow node-style:
callback <Function>
err <Error>
response <Object>
Example Contact Record
{
recordID: '6b2237ee0df85980',
company: "",
emailAddresses: [{
label: "work",
email: "[email protected]",
}],
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'
}
],
birthday: {"year": 1988, "month": 0, "day": 1 }
}
NOTE
- on Android versions below 8 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: "[email protected]",
}],
familyName: "Nietzsche",
givenName: "Friedrich",
}
Contacts.addContact(newPerson, (err) => {
if (err) throw err;
// save successful
})
Open Contact Form
Currently all fields from the contact record except for thumbnailPath are supported for writing
var newPerson = {
emailAddresses: [{
label: "work",
email: "[email protected]",
}],
familyName: "Nietzsche",
givenName: "Friedrich",
}
Contacts.openContactForm(newPerson, (err) => {
if (err) throw err;
// form is open
})
You may want to edit the contact before saving it into your phone book. So using openContactForm
allow you to prompt default phone create contacts UI and the new to-be-added contact will be display on the contacts UI view. Click save or cancel button will exit the contacts UI view.
Updating and Deleting Contacts
Example
Contacts.getAll((err, contacts) => {
if (err) throw err;
// update the first record
let someRecord = contacts[0]
someRecord.emailAddresses.push({
label: "junk",
email: "[email protected]",
})
Contacts.updateContact(someRecord, (err) => {
if (err) throw err;
// record updated
})
//delete the second record
Contacts.deleteContact(contacts[1], (err, recordId) => {
if (err) throw err;
// contact deleted
})
})
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
Contacts.deleteContact({recordID: 1}, (err, recordId) => {
if (err) throw err;
// contact deleted
})
Displaying Thumbnails
The thumbnailPath is the direct URI for the temp location of the contact's cropped thumbnail image.
<Image source={{uri: contact.thumbnailPath}} />
Permissions Methods (optional)
checkPermission
(callback) - checks permission to access Contacts.requestPermission
(callback) - request permission to access Contacts.
Usage as follows:
Contacts.checkPermission((err, permission) => {
if (err) throw err;
// Contacts.PERMISSION_AUTHORIZED || Contacts.PERMISSION_UNDEFINED || Contacts.PERMISSION_DENIED
if (permission === 'undefined') {
Contacts.requestPermission((err, permission) => {
// ...
})
}
if (permission === 'authorized') {
// yay!
}
if (permission === 'denied') {
// x.x
}
})
These methods are only useful on iOS. For Android you'll have to use https://facebook.github.io/react-native/docs/permissionsandroid.html
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
.