@capgo/capacitor-contacts

Overview

Capacitor Contacts Plugin interface for managing device contacts.

Core Capabilities

• countContacts - Count the total number of contacts on the device.
• createContact - Create a new contact programmatically.
• createGroup - Create a new contact group.
• deleteContactById - Delete a contact by ID.

Public API

Method	Description
countContacts	Count the total number of contacts on the device.
createContact	Create a new contact programmatically.
createGroup	Create a new contact group.
deleteContactById	Delete a contact by ID.
deleteGroupById	Delete a group by ID.
displayContactById	Display a contact using the native contact viewer.
displayCreateContact	Display the native create contact UI.
displayUpdateContactById	Display the native update contact UI for a specific contact.
getAccounts	Get all accounts available on the device.
getContactById	Get a specific contact by ID.
getContacts	Get all contacts from the device.
getGroupById	Get a specific group by ID.
getGroups	Get all contact groups.
isAvailable	Check if contacts are available on the device.
isSupported	Check if the plugin is supported on the current platform.
openSettings	Open the device’s contacts settings.
pickContact	Pick a single contact using the native contact picker.
pickContacts	Pick one or more contacts using the native contact picker.
updateContactById	Update an existing contact by ID.
checkPermissions	Check the current permission status for contacts.
requestPermissions	Request permissions to access contacts.
getPluginVersion	Get the native Capacitor plugin version.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-contacts.