Guide
Comment utiliser Health dans Capacitor
Utiliser @capgo/capacitor-health
Le plugin Capacitor pour interagir avec les données d'Apple HealthKit et Health Connect.
Installer
bun add @capgo/capacitor-health
bunx cap sync
bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.
Importer
import { Health } from '@capgo/capacitor-health';
API en un coup d'œil
| Méthode | Description |
|---|---|
isAvailable |
Indique si la plateforme actuelle prend en charge le SDK de santé natif. |
requestAuthorization |
Demande l'accès en lecture/écriture pour les types de données fournis. |
checkAuthorization |
Vérifie le statut d'autorisation pour les types de données fournis sans afficher de prompt. |
readSamples |
Lit les échantillons pour le type de données donné dans le laps de temps spécifié. |
saveSample |
Écrit un échantillon unique dans le store de santé natif. |
openHealthConnectSettings |
Ouvre l'écran des paramètres Health Connect (Android uniquement). Sur iOS, cette méthode ne fait rien. |
showPrivacyPolicy |
Affiche la politique de confidentialité de l'application pour Health Connect (Android uniquement). Sur iOS, cette méthode ne fait rien. |
queryWorkouts |
Interroge les sessions d'entraînement du store de santé natif. Disponible sur iOS (HealthKit) et Android (Health Connect). |
queryAggregated |
Interroge les données de santé agrégées du store de santé natif. Agrège les données en intervalles de temps (heure, jour, semaine, mois) avec des opérations comme somme, moyenne, min ou max. C'est plus efficace que de récupérer des échantillons individuels sur de grandes plages de dates. |
Exemples
isAvailable()
Indique si la plateforme actuelle prend en charge le SDK de santé natif.
import { Health } from '@capgo/capacitor-health';
const result = await Health.isAvailable();
console.log(result);
requestAuthorization()
Demande l'accès en lecture/écriture aux types de données fournis.
import { Health } from '@capgo/capacitor-health';
const result = await Health.requestAuthorization({ read: ['steps'] });
console.log(result);
checkAuthorization()
Vérifie le statut d'autorisation des types de données fournis sans afficher de prompt à l'utilisateur.
import { Health } from '@capgo/capacitor-health';
const result = await Health.checkAuthorization({ read: ['steps'] });
console.log(result);
readSamples()
Lit les échantillons du type de données indiqué sur la période spécifiée.
import { Health } from '@capgo/capacitor-health';
const result = await Health.readSamples({ dataType: 'steps' });
console.log(result);
saveSample()
Écrit un échantillon unique dans le store de santé natif.
import { Health } from '@capgo/capacitor-health';
await Health.saveSample({
dataType: 'steps',
value: 1,
});
openHealthConnectSettings()
Ouvre l'écran des paramètres Health Connect (Android uniquement). Sur iOS, cette méthode ne fait rien.
import { Health } from '@capgo/capacitor-health';
await Health.openHealthConnectSettings();
Le tableau ci-dessus liste les 9 méthodes principales. Les helpers de version et de listener, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.
Référence complète
Continuer avec l'utilisation de @capgo/capacitor-health
Si vous utilisez Utiliser @capgo/capacitor-health pour planifier le travail sur un plugin natif, connectez-l’à @capgo/capacitor-health pour les détails d'implémentation dans @capgo/capacitor-health, Premiers pas pour les détails d'implémentation dans Premiers pas, Répertoire des plugins Capgo pour le workflow produit dans le répertoire des plugins Capgo, Plugins Capacitor par Capgo pour les détails d'implémentation dans Capacitor Plugins de Capgo, et Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Ajout ou mise à jour de plugins.