A Flutter plugin to access and manage the device's contacts. (Android Only for now)
To use this plugin, add
raw_contacts as a dependency in your
dependencies: raw_contacts: ^0.0.1
Add the following permissions to your AndroidManifest.xml:
<uses-permission android:name="android.permission.READ_CONTACTS" /> <uses-permission android:name="android.permission.WRITE_CONTACTS" />
raw_contacts does not handle the process of asking and checking for permissions. To check and request user permission to access contacts, try using the following plugins: flutter_simple_permissions or permission_handler.
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:raw_contacts/raw_contacts.dart'; String _accountType="com.test_app"; // Get all contact list for the account type Iterable<Contact> contacts = await RawContacts.getContacts(filter: _accountType); // Get all contacts without thumbnail(faster) Iterable<Contact> contacts = await RawContacts.getContacts(getImages: false,filter: _accountType); // Add a contact // The contact must have at least DisplayName and Email await RawContacts.addContact(newContact); // Delete a contact // The contact must have a valid identifier await RawContacts.deleteContact(contact);
// Name String displayName, givenName, middleName, prefix, suffix, familyName; // Company String company, jobTitle; // Email addresses Iterable<KeyValuePair> emails = ; // Phone numbers Iterable<KeyValuePair> phones = ; // Post addresses Iterable<PostalAddress> postalAddresses = ; // Contact avatar/thumbnail Uint8List avatar;
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.
Demonstrates how to use the raw_contacts plugin.
For help getting started with Flutter, view our online documentation.
Add this to your package's pubspec.yaml file:
dependencies: raw_contacts: ^0.0.3
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:
|0.0.3||Apr 8, 2019|
|0.0.2||Apr 4, 2019|
|0.0.1||Mar 26, 2019|
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 Apr 16, 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.
The package description is too short. (-20 points)
Add more detail to the
description field of
pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.
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.