This library is a work in progress. Additional features will be added as they become required.
$ npm install react-native-simple-contacts --save
$ react-native link react-native-simple-contacts
import simpleContacts from 'react-native-simple-contacts';
// Get all contacts
simpleContacts.getContacts().then((contacts) => {
// Do something with the contacts
});
// Get a specific contact based on a phone number
simpleContacts.findContactByNumber(number).then((contact) => {
// Do something with the contact
});
// Get the user's profile
simpleContacts.getProfile().then((profile) => {
// Do something with the profile
});
Function | Description |
---|---|
Returns an array of contacts | |
Return the user's profile. | |
Return the contact that matches the provided number. |
Simple contacts only returns the following fields:
Field | Description |
---|---|
key | A unique identifier |
name | The contact's display name |
avatar | The contact's photo if available |
number | The contacts phone number |
Returned contacts look like this:
const contact = {
"key": "contact_###",
"name": "John Doe",
"avatar": "uri://picture",
"number": "1-555-555-5555"
}
Libraries
➜ Add Files to [your project's name]
node_modules
➜ react-native-simple-contacts
and add BDVSimpleContacts.xcodeproj
libBDVSimpleContacts.a
to your project's Build Phases
➜ Link Binary With Libraries
Cmd+R
)<android/app/src/main/java/[...]/MainActivity.java
import ca.bigdata.voice.contacts.BDVSimpleContactsPackage;
to the imports at the top of the filenew BDVSimpleContactsPackage()
to the list returned by the getPackages()
methodandroid/settings.gradle
:
include ':react-native-simple-contacts'
project(':react-native-simple-contacts').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-simple-contacts/android')
android/app/build.gradle
:
compile project(':react-native-simple-contacts')