contacts_service

A Flutter plugin to access and manage the device's contacts.

flutter_contacts

Usage

To use this plugin, add contacts_service as a dependency in your pubspec.yaml file.

Make sure you add the following permissions to your Android Manifest:

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

On iOS, make sure to set NSContactsUsageDescription in the Info.plist file

<key>NSContactsUsageDescription</key>
<string>This app requires contacts access to function properly.</string>
XML

To check and request user permission to access contacts, I recommend using the following plugin: flutter_simple_permissions

If you do not request user permission or have it granted, the application will fail. For testing purposes, you can manually set the permissions for your test app in Settings for your app on the device that you are using. For Android, go to "Settings" - "Apps" - select your test app - "Permissions" - then turn "on" the slider for contacts.

Example

// Import package
import 'package:contacts_service/contacts_service.dart';

// Get all contacts
Iterable<Contact> contacts = await ContactsService.getContacts();

// Get contacts matching a string
Iterable<Contact> johns = await ContactsService.getContacts(query : "john");

// Add a contact
// The contact must have a firstName / lastName to be successfully addded
await ContactsService.addContact(newContact);

//Delete a contact
await ContactsService.deleteContact(contact);
Dart

Example

Todo

  • [ ] update contact

GitHub

https://github.com/fluttercommunity/flutter_contacts