Pasar al contenido principal
@capgo/capacitor-contactos API de dispositivos Fuente abierta

Contactos plugin de Capacitor

Acceda y administre los contactos del dispositivo con capacidades de lectura y escritura

Instalar

bun add @capgo/capacitor-contacts bunx cap sync
npm, pnpm o yarn
  • npm install @capgo/capacitor-contacts
  • pnpm add @capgo/capacitor-contacts
  • yarn add @capgo/capacitor-contacts

Guía

Cómo usar Contactos en Capacitor

Probar en dispositivo

Descargue la aplicación Capgo, luego escane el código QR code.

Previsualización de plugin de contactos QR code

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.

FAQ

FAQ del plugin de contactos

How do I install the Contacts plugin in a aplicación Capacitor?

Run "bun add @capgo/capacitor-contacts" (o "npm install @capgo/capacitor-contacts"), luego ejecuta "bunx cap sync" para que los proyectos iOS y Android capturen el nativo code. Importa desde "@capgo/capacitor-contacts" en tu aplicación code.

¿Funciona @capgo/capacitor-contacts con React, Vue y Angular?

Sí. Contacts es un paquete Capacitor, por lo que funciona con cualquier framework web que se ejecute dentro de Capacitor, incluyendo Ionic, React, Vue, Angular, Svelte y JavaScript puro.

¿Qué versión de Capacitor admite @capgo/capacitor-contacts?

Los plugins Capgo siguen la versión mayor de Capacitor: utiliza la versión mayor del plugin que coincida con la versión mayor de Capacitor (por ejemplo, plugin v8 con Capacitor 8). La tabla de compatibilidad en el README del GitHub lista las versiones mantenidas.

¿Es gratuita y de código abierto @capgo/capacitor-contacts?

Sí. El código fuente code está disponible en GitHub en https://github.com/Cap-go/capacitor-contacts/ y el paquete es gratuito para instalar desde npm. Se aceptan informes de errores y solicitudes de cambios.

Puedo actualizar code que utiliza Contacts sin una revisión de la Tienda?

Instalar o actualizar el plugin cambia el nativo code, por lo que necesita una nueva compilación de la tienda. Después de eso, los cambios en JavaScript, HTML y CSS que llaman al plugin pueden enviar instantáneamente con Capgo actualizaciones en vivo.

Envía cambios de Contactos sin esperar a la revisión de la aplicación

Una vez que el plugin esté en tu tienda de construcción, Capgo actualizaciones en vivo envían los cambios de JavaScript, HTML y CSS a los usuarios en minutos.

Inicia con Capgo