Repository files navigation

A Flutter contacts plugin which provides easy access to the platform specific address book.

Branch	Build Status
develop
master

• Automatically check and request the necessary permissions to access the platform specific address book;
• Read contacts from the addres book;
• [WIP] Store new contacts in the address book;
• [WIP] Update details of existing contacts;
• [WIP] Delete existing contacts from the address book.

To use this plugin, addcontacts_plugin as adependency in your pubspec.yaml file. For example:

dependencies:contacts_plugin:'^0.0.3'

NOTE: There's a known issue with integrating plugins that use Swift into a Flutter project created with the Objective-C template. See issueFlutter#16049 for help on integration.

To fetch all contacts from the address book make a call to thegetContacts method:

import'package:geolocator/contacts_plugin.dart';List<Contact> contacts=awaitContactsPlugin().getContacts();

On Android you'll need to add either theREAD_CONTACTS or theWRITE_CONTACTS permissions to your Android Manifest (depending if you need read and/ or write access to the address book). Todo so open the AndroidManifest.xml file and one of the following two lines as direct children of the<manifest> tag:

<uses-permissionandroid:name="android.permission.READ_CONTACTS" /><uses-permissionandroid:name="android.permission.WRITE_CONTACTS" />

On iOS you'll need to add theNSContactsUsageDescription to your Info.plist file in order to access the device's address book. Simply open your Info.plist file and add the following:

<key>NSContactsUsageDescription</key><string>This app needs access to address book.</string>

Please file any issues, bugs or feature request as an issue on ourGitHub page.

If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review ourcontribution guide and send us yourpull request.

This Contacts plugin for Flutter is developed byBaseflow. You can contact us athello@baseflow.com