Guía
Cómo usar Health en Capacitor
Uso de @capgo/capacitor-health
El plugin Capacitor para interactuar con datos de Apple HealthKit y Health Connect.
Instalar
bun add @capgo/capacitor-health
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 { Health } from '@capgo/capacitor-health';
API de un vistazo
| Método | Descripción |
|---|---|
isAvailable |
Indica si la plataforma actual admite el SDK nativo de health. |
requestAuthorization |
Solicita acceso de lectura/escritura a los tipos de datos proporcionados. |
checkAuthorization |
Verifica el estado de autorización de los tipos de datos proporcionados sin mostrar prompts al usuario. |
readSamples |
Lee las muestras del tipo de dato indicado dentro del intervalo de tiempo especificado. |
saveSample |
Escribe una única muestra en el almacén de salud nativo. |
openHealthConnectSettings |
Abre la pantalla de ajustes de Health Connect (solo Android). En iOS, este método no hace nada. |
showPrivacyPolicy |
Muestra la política de privacidad de la app para Health Connect (solo Android). En iOS, este método no hace nada. |
queryWorkouts |
Consulta sesiones de entrenamiento desde el almacén de salud nativo. Compatible con iOS (HealthKit) y Android (Health Connect). |
queryAggregated |
Consulta datos de salud agregados del almacén de salud nativo. Agrupa los datos en intervalos (hora, día, semana, mes) con operaciones como suma, promedio, mínimo o máximo. Es más eficiente que obtener muestras individuales para rangos de fechas amplios. |
Ejemplos
isAvailable()
Indica si la plataforma actual admite el SDK nativo de health.
import { Health } from '@capgo/capacitor-health';
const result = await Health.isAvailable();
console.log(result);
requestAuthorization()
Solicita acceso de lectura/escritura a los tipos de datos proporcionados.
import { Health } from '@capgo/capacitor-health';
const result = await Health.requestAuthorization({ read: ['steps'] });
console.log(result);
checkAuthorization()
Verifica el estado de autorización de los tipos de datos proporcionados sin mostrar prompts al usuario.
import { Health } from '@capgo/capacitor-health';
const result = await Health.checkAuthorization({ read: ['steps'] });
console.log(result);
readSamples()
Lee las muestras del tipo de dato indicado dentro del intervalo de tiempo especificado.
import { Health } from '@capgo/capacitor-health';
const result = await Health.readSamples({ dataType: 'steps' });
console.log(result);
saveSample()
Escribe una única muestra en el almacén de salud nativo.
import { Health } from '@capgo/capacitor-health';
await Health.saveSample({
dataType: 'steps',
value: 1,
});
openHealthConnectSettings()
Abre la pantalla de ajustes de Health Connect (solo Android). En iOS, este método no hace nada.
import { Health } from '@capgo/capacitor-health';
await Health.openHealthConnectSettings();
La tabla anterior lista los 9 métodos principales. Los helpers de listeners y versión, y el contrato completo de cada método, están documentados en la repositorio GitHub.
Referencia completa
Continúa desde Uso de @capgo/capacitor-health
Si estás usando Uso de @capgo/capacitor-health para planificar el trabajo con plugins nativos, conéctalo con @capgo/capacitor-health para el detalle de implementación en @capgo/capacitor-health, Primeros pasos para los detalles de implementación en Primeros pasos, Directorio de plugins de Capgo para el flujo de trabajo del producto en Capgo Plugin Directory, Plugins de Capacitor por Capgo para los detalles de implementación en Capacitor Plugins de Capgo, y Añadir o actualizar plugins para los detalles de implementación al añadir o actualizar plugins.