Aller au contenu

@capgo/capacitor-health

Le plugin Capacitor pour interagir avec les données d'Apple HealthKit et Health Connect.

@capgo/capacitor-health lit et écrit les données de santé de l'utilisateur via Apple HealthKit sur iOS et Health Connect sur Android. Utilisez-le pour le nombre de pas, les entraînements, les phases de sommeil, les constantes vitales et les échantillons de type nutrition, sans avoir à maintenir deux intégrations natives distinctes SDK dans votre couche applicative.

Les dashboards fitness, apps d'habitudes, produits de bien-être clinique et programmes de bien-être en entreprise commencent souvent par requestAuthorization, puis readSamples ou saveSample pour les métriques qui les intéressent.

PlateformeSupportNotes
iOSOuiAutorisation HealthKit et échantillons
AndroidOuiHealth Connect, autorisation d’historique facultative pour les lectures au-delà d’environ 30 jours
Le WebLimitéisAvailable signale les SDK natifs non pris en charge

Helpers pour Android uniquement : openHealthConnectSettings, showPrivacyPolicy.

  • isAvailable - Indique si la plateforme actuelle prend en charge le SDK de santé natif.
  • requestAuthorization - Demande l'accès en lecture/écriture aux types de données fournis.
  • checkAuthorization - Vérifie le statut d'autorisation des types de données fournis sans afficher de prompt à l'utilisateur.
  • readSamples - Lit les échantillons du type de données donné sur la période spécifiée.
MéthodeDescription
isAvailableIndique si la plateforme actuelle prend en charge le SDK de santé natif.
requestAuthorizationDemande l'accès en lecture/écriture aux types de données fournis.
checkAuthorizationVérifie le statut d'autorisation pour les types de données fournis sans solliciter l'utilisateur.
readSamplesLit les échantillons du type de données donné sur la période spécifiée.
saveSampleÉcrit un échantillon unique dans le store de santé natif.
getPluginVersionRécupère la version du plugin natif Capacitor.
openHealthConnectSettingsOuvre l'écran de paramètres Health Connect (Android uniquement). Sur iOS, cette méthode ne fait rien.
showPrivacyPolicyAffiche la politique de confidentialité de l’application pour Health Connect (Android uniquement). Sur iOS, cette méthode ne fait rien.
queryWorkoutsInterroge les sessions d'entraînement depuis le store de santé natif. Compatible avec iOS (HealthKit) et Android (Health Connect).
queryAggregatedInterroge les données de santé agrégées du store de santé natif. Agrège les données par intervalles (heure, jour, semaine, mois) avec des opérations comme la somme, la moyenne, le min ou le max. C'est plus efficace que de récupérer des échantillons individuels sur de longues plages de dates.

Cette référence est synchronisée depuis src/definitions.ts dans capacitor-health.

Si vous utilisez @capgo/capacitor-health pour planifier le travail sur les plugins natifs, connectez-l’à Utiliser @capgo/capacitor-health pour la fonctionnalité native dans « Utiliser @capgo/capacitor-health », Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Ajout ou mise à jour de plugins, et Alternatives aux plugins Ionic Enterprise pour le workflow produit dans Alternatives aux plugins Ionic Enterprise.