Skip to content

Tracklous/react-native-simple-contacts

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

react-native-simple-contacts

This library is a work in progress. Additional features will be added as they become required.

Getting started

$ npm install react-native-simple-contacts --save

Mostly automatic installation

$ react-native link react-native-simple-contacts

Usage

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
});

API

Function Description
getContacts() Returns an array of contacts
getProfile() Return the user's profile.
findContactByNumber(number) 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"
}

Manual installation

iOS

  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-simple-contacts and add BDVSimpleContacts.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libBDVSimpleContacts.a to your project's Build PhasesLink Binary With Libraries
  4. Run your project (Cmd+R)<

Android

  1. Open up android/app/src/main/java/[...]/MainActivity.java
  • Add import ca.bigdata.voice.contacts.BDVSimpleContactsPackage; to the imports at the top of the file
  • Add new BDVSimpleContactsPackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
    include ':react-native-simple-contacts'
    project(':react-native-simple-contacts').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-simple-contacts/android')
    
  2. Insert the following lines inside the dependencies block in android/app/build.gradle:
      compile project(':react-native-simple-contacts')
    

About

Simple interface to iOS and Android contacts

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 48.7%
  • Objective-C 47.4%
  • Ruby 3.3%
  • JavaScript 0.6%