Guía
Cómo usar Contactos en Capacitor
Usando @capgo/capacitor-contacts
Interfaz del plugin de Contactos de Capacitor para gestionar 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. Correlo de nuevo después de cada actualización del plugin
Importar
import { CapacitorContacts } from '@capgo/capacitor-contacts';
Vista general de API
| Método | Descripción |
|---|---|
countContacts |
Contar el número total de contactos en el dispositivo. |
createContact |
Crear un nuevo contacto de manera programática. |
createGroup |
Crear un nuevo grupo de contactos. |
deleteContactById |
Borrar un contacto por ID. |
deleteGroupById |
Borrar un grupo por ID. |
displayContactById |
Mostrar un contacto utilizando el visor de contactos nativo. |
displayCreateContact |
Mostrar la interfaz de creación de contactos nativa. |
displayUpdateContactById |
Mostrar la interfaz de actualización de contactos nativa para un contacto específico. |
getAccounts |
Obtener todos los cuentas disponibles en el dispositivo. |
getContactById |
Obtener un contacto específico por ID. |
getContacts |
Obtener todos los contactos del dispositivo. |
getGroupById |
Obtener un grupo específico por ID. |
getGroups |
Obtener todos los grupos de contactos. |
isAvailable |
Comprobar si los contactos están disponibles en el dispositivo. |
isSupported |
Comprobar si el plugin es compatible con la plataforma actual. |
openSettings |
Abrir la configuración de contactos del dispositivo. |
pickContact |
Seleccionar un solo contacto utilizando el selector de contactos nativo. |
pickContacts |
Seleccionar uno o más contactos utilizando el selector de contactos nativo. |
updateContactById |
Actualizar un contacto existente por ID. |
checkPermissions |
Comprobar el estado actual de permisos para contactos. |
requestPermissions |
Solicitar permisos para acceder a contactos. |
Ejemplos
countContacts()
Contar el número total de contactos en el dispositivo.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
const result = await CapacitorContacts.countContacts();
console.log(result);
createContact()
Crear un nuevo contacto de forma programática.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
const result = await CapacitorContacts.createContact({ contact: {} });
console.log(result);
createGroup()
Crear un nuevo grupo de contactos.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
const result = await CapacitorContacts.createGroup({ group: { name: 'example' } });
console.log(result);
deleteContactById()
Borrar un contacto por ID.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.deleteContactById({ id: 'id-123' });
deleteGroupById()
Borrar un grupo por ID.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.deleteGroupById({ id: 'id-123' });
displayContactById()
Mostrar un contacto utilizando el visor de contactos nativo.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.displayContactById({ id: 'id-123' });
La tabla anterior muestra los 21 métodos básicos. Los ayudantes de escucha y versión, y el contrato completo de cada método, se documentan en el GitHub repositorio.
Referencia completa
Continuar desde Usar @capgo/capacitor-contacts
Si estás utilizando Usando @capgo/capacitor-contacts para planificar la consola y las operaciones de @API conectarlo con @capgo/capacitor-contacts para obtener detalles de implementación en @capgo/capacitor-contacts Getting Started para obtener detalles de implementación en Getting Started Resumen de API para obtener detalles de implementación en API Overview Introducción para obtener detalles de implementación en Introducción, y Claves de API para los detalles de implementación en API Claves.