Contactos plugin Capacitor

Usando @capgo/capacitor-contacts

Interfaz del plugin Capacitor Contacts para gestionar los contactos del dispositivo.

Instalar

bun add @capgo/capacitor-contacts
bunx cap sync

bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.

Importar

import { CapacitorContacts } from '@capgo/capacitor-contacts';

API de un vistazo

Método	Descripción
countContacts	Cuenta el número total de contactos en el dispositivo.
createContact	Crea un nuevo contacto mediante código.
createGroup	Crea un nuevo grupo de contactos.
deleteContactById	Elimina un contacto por su ID.
deleteGroupById	Elimina un grupo por su ID.
displayContactById	Muestra un contacto usando el visor nativo de contactos.
displayCreateContact	Muestra la interfaz nativa para crear contactos.
displayUpdateContactById	Muestra la interfaz nativa de actualización de contacto para un contacto específico.
getAccounts	Obtén todas las cuentas disponibles en el dispositivo.
getContactById	Obtén un contacto específico por ID.
getContacts	Obtén todos los contactos del dispositivo.
getGroupById	Obtén un grupo específico por ID.
getGroups	Obtén todos los grupos de contactos.
isAvailable	Comprueba si los contactos están disponibles en el dispositivo.
isSupported	Verifica si el plugin es compatible con la plataforma actual.
openSettings	Abre los ajustes de contactos del dispositivo.
pickContact	Selecciona un contacto con el selector nativo de contactos.
pickContacts	Selecciona uno o más contactos con el selector nativo de contactos.
updateContactById	Actualiza un contacto existente por ID.
checkPermissions	Consulta el estado actual de permisos de contactos.
requestPermissions	Solicita permisos para acceder a los contactos.

Ejemplos

countContacts()

Cuenta el número total de contactos en el dispositivo.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.countContacts();
console.log(result);

createContact()

Crea un nuevo contacto mediante código.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.createContact({ contact: {} });
console.log(result);

createGroup()

Crea un nuevo grupo de contactos.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.createGroup({ group: { name: 'example' } });
console.log(result);

deleteContactById()

Elimina un contacto por su ID.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

await CapacitorContacts.deleteContactById({ id: 'id-123' });

deleteGroupById()

Elimina un grupo por su ID.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

await CapacitorContacts.deleteGroupById({ id: 'id-123' });

displayContactById()

Muestra un contacto usando el visor nativo de contactos.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

await CapacitorContacts.displayContactById({ id: 'id-123' });

La tabla anterior enumera los 21 métodos principales. Los helpers de listeners y versiones, así como el contrato completo de cada método, están documentados en la repositorio GitHub.

Referencia completa

• repositorio GitHub
• Documentación
• Referencia de API

Continúa desde Usar @capgo/capacitor-contacts

Si estás usando Usando @capgo/capacitor-contacts para planificar las operaciones del dashboard y de API, conéctalo con @capgo/capacitor-contacts para los detalles de implementación en @capgo/capacitor-contacts, Primeros pasos para los detalles de implementación en Primeros pasos, Resumen de API para los detalles de implementación en API Overview, Introducción para los detalles de implementación en Introducción, y Claves de API para los detalles de implementación en API Keys.