Saltar al contenido

@capgo/capacitor-contacts

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

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

PlataformaSoporteNotas
iOSSíFramework de Contacts
AndroidSíContactsContract
WebNoSin wrapper de API para Contacts; los selectores de contactos del navegador son integraciones aparte
  • 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 ID.
MétodoDescripción
countContactsCuenta el número total de contactos en el dispositivo.
createContactCrea un nuevo contacto por código.
createGroupCrea un nuevo grupo de contactos.
deleteContactByIdElimina un contacto por ID.
deleteGroupByIdElimina un grupo por ID.
displayContactByIdMuestra un contacto con el visor nativo.
displayCreateContactMuestra la interfaz nativa para crear contactos.
displayUpdateContactByIdMuestra la interfaz nativa para actualizar 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 usando el selector nativo.
pickContactsSelecciona uno o varios contactos con el selector nativo.
updateContactByIdActualiza un contacto existente mediante su ID.
checkPermissionsConsulta el estado actual de los permisos de contactos.
requestPermissionsSolicita permisos para acceder a los contactos.
getPluginVersionObtén la versión nativa del plugin Capacitor.

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

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