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" />
On iOS, make sure to set NSContactsUsageDescription in your Info.plist
<key>NSContactsUsageDescription</key>
<string>This app requires contacts access to function properly.</string>
To check and request user permission to access contacts, I recommend using the following plugin : flutter_simple_permissions
// 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);
- update contact
- add withTumbnails optional parameter in getContacts method
Contributions are welcome! If you find a bug or want a feature, please fill an issue.
If you want to contribute code please create a pull request.
Heavily inspired from rt2zz's react native plugin