Saltar al contenido

@capgo/capacitor-contacts

Lista, busca, crea y actualiza los contactos del dispositivo.

Envuelve la libreta de direcciones nativa con helpers de permisos y flujos de selección para invitaciones y referidos.

PlataformaSoporteNotas
iOSSíFramework de Contacts
AndroidSíContactsContract
WebNoNo hay wrapper de Contacts API; los selectores de contactos del navegador son integraciones separadas
  • countContacts - Contar el número total de contactos en el dispositivo.
  • createContact - Crear un nuevo contacto programáticamente.
  • createGroup - Crear un nuevo grupo de contactos.
  • deleteContactById - Eliminar un contacto por ID.
MétodoDescripción
countContactsCuenta el número total de contactos en el dispositivo.
createContactCrea un nuevo contacto mediante código.
createGroupCrea un nuevo grupo de contactos.
deleteContactByIdElimina un contacto por su ID.
deleteGroupByIdElimina un grupo por su ID.
displayContactByIdMuestra un contacto usando el visor nativo de contactos.
displayCreateContactMuestra la interfaz nativa para crear contactos.
displayUpdateContactByIdMuestra la interfaz nativa de actualización de contacto para un contacto específico.
getAccountsObtén todas las cuentas disponibles en el dispositivo.
getContactByIdObtén un contacto específico por ID.
getContactsObtén todos los contactos del dispositivo.
getGroupByIdObtén un grupo específico por ID.
getGroupsObtén todos los grupos de contactos.
isAvailableComprueba si los contactos están disponibles en el dispositivo.
isSupportedVerifica si el plugin es compatible con la plataforma actual.
openSettingsAbre los ajustes de contactos del dispositivo.
pickContactSelecciona un contacto con el selector nativo de contactos.
pickContactsSelecciona uno o más contactos con el selector nativo de contactos.
updateContactByIdActualiza un contacto existente por ID.
checkPermissionsConsulta el estado actual de permisos de contactos.
requestPermissionsSolicita permisos para acceder a los contactos.
getPluginVersionObtén la versión del plugin nativo Capacitor.

Esta referencia se sincroniza desde src/definitions.ts en capacitor-contacts.

Si estás usando @capgo/capacitor-contacts para planificar las operaciones del dashboard y de API, conéctalo con Usando @capgo/capacitor-contacts para la capacidad nativa en Usando @capgo/capacitor-contacts, Resumen de API para los detalles de implementación en API Overview, Introducción para los detalles de implementación en la Introducción, Claves de API para los detalles de implementación en las claves de API, y Dispositivos para el detalle de implementación en Devices.