charlsefrancis/main.dart

Contact-list made with dart

#contact-list

contacts_service pub package Build Status Coverage Status

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

Usage #

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

dependencies:
contacts_service: ^0.4.6 Permissions

Android

Add the following permissions to your AndroidManifest.xml:

iOS

Set the NSContactsUsageDescription in your Info.plist file

NSContactsUsageDescription
This app requires contacts access to function properly.
Note contacts_service 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.

Example

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

// Get all contacts on device Iterable contacts = await ContactsService.getContacts();

// Get all contacts without thumbnail (faster) Iterable contacts = await ContactsService.getContacts(withThumbnails: false);

// Android only: Get thumbnail for an avatar afterwards (only necessary if withThumbnails: false is used) Uint8List avatar = await ContactsService.getAvatar(contact);

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

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

// Delete a contact // The contact must have a valid identifier await ContactsService.deleteContact(contact);

// Update a contact // The contact must have a valid identifier await ContactsService.updateContact(contact);

// Usage of the native device form for creating a Contact // Throws a error if the Form could not be open or the Operation is canceled by the User await ContactsService.openContactForm();

// Usage of the native device form for editing a Contact // The contact must have a valid identifier // Throws a error if the Form could not be open or the Operation is canceled by the User await ContactsService.openExistingContact(contact);

Contact Model

// Name String displayName, givenName, middleName, prefix, suffix, familyName;

// Company String company, jobTitle;

// Email addresses Iterable emails = [];

// Phone numbers Iterable phones = [];

// Post addresses Iterable postalAddresses = [];

// Contact avatar/thumbnail Uint8List avatar;