flutter_contacts 0.0.3

Flutter plugin to read, create, update, delete and observe native contacts on Android and iOS.

flutter_contacts

Flutter plugin to read, create, update, delete and observe native contacts on Android and iOS.

For a minimalistic example, take a look at example/. You can write a full-fledged contacts app with it – see example_full/ to see how.

Features

• List all contacts
• Create new contact
• Update existing contact
• Delete contacts
• Observe contact database changes
• Fetch all details for a given contact, including:
  • Photo (low / high resolution)
  • Phones
  • Emails
  • Company / job title
  • Postal addresses
  • Websites
  • Birthday / events
  • Instant messaging / social profiles
  • Notes
  • Labels (such as "main" or "work" for phones)

Screenshots

(identities and photos from https://www.fakenamegenerator.com/ and https://thispersondoesnotexist.com/)

Usage

import 'package:flutter_contacts/flutter_contacts.dart';
import 'package:permission_handler/permission_handler.dart';

if (await Permission.contacts.request().isGranted) {
    /// Get all contacts (IDs and names only)
    List<Contact> contacts = await FlutterContacts.getContacts();

    /// Get all fields (phones, emails, photo, job, etc) for a given contact
    Contact contact = await FlutterContacts.getContact(contacts.first.id);

    /// Listen to contacts database changes
    FlutterContacts.onChange(() => print('Contact DB changed'));

    /// Create contact
    Contact newContact = Contact.create()
        ..name = Name(first: 'John', last: 'Doe')
        ..phones = [Phone('555-123-4567'), Phone('555-999-9999', label: PhoneLabel.work)];
    await FlutterContacts.newContact(newContact);

    /// Update contact
    contact.emails.add(Email('[e-mail]'));
    await FlutterContacts.updateContact(contact);

    /// Delete contact
    await FlutterContacts.deleteContact(contact.id);
}

Installation

1. Add json_serializable: ^3.5.0 (or higher) to the dev_dependencies in pubspec.yaml.
2. Add permission_handler: ^5.0.0+hotfix.3 (or higher) to the dependencies in pubspec.yaml: this is the package that allows you to request for contact permissions.
3. Add the following key/value pair to your app's Info.plist (for iOS):

   <plist version="1.0">
   <dict>
       ...
       <key>NSContactsUsageDescription</key>
       <string>Access contact list</string>
   </dict>
   </plist>
   

4. Add the following <uses-permissions> tags to your app's AndroidManifest.xml (for Android):

   <manifest xmlns:android="http://schemas.android.com/apk/res/android" ...>
       <uses-permission android:name="android.permission.READ_CONTACTS"/>
       <uses-permission android:name="android.permission.WRITE_CONTACTS"/>
       <application ...>
       ...