A Flutter plugin to access and manage the device's contacts.
To use this plugin, add
contacts_service as a dependency in your
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 the
<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
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.
// 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);
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
Demonstrates how to use the contacts_service plugin.
For help getting started with Flutter, view our online documentation.
Add this to your package's pubspec.yaml file:
dependencies: ngobrel_contacts: ^0.0.2
You can install packages from the command line:
$ flutter packages get
Alternatively, your editor might support
flutter packages get.
Check the docs for your editor to learn more.
Now in your Dart code, you can use:
import 'package:ngobrel_contacts/generated/i18n.dart'; import 'package:ngobrel_contacts/contacts.dart';
|0.0.2||Dec 5, 2018|
|0.0.1||Dec 5, 2018|
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
We analyzed this package on Feb 14, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
Detected platforms: Flutter
References Flutter, and has no conflicting libraries.
flutter format to format
flutter format to format
Homepage URL doesn't exist. (-20 points)
At the time of the analysis the
https://github.com/ngobrel/ngobrel-contacts was unreachable.
Package is pre-v0.1 release. (-10 points)
While nothing is inherently wrong with versions of
0.0.*, it might mean that the author is still experimenting with the general direction of the API.