Passer à la navigation principale
@capgo/capacitor-santé APIs de dispositifs Source

Santé plugin Capacitor

Accédez aux données de santé et de fitness à partir de plateformes de santé natives

Installer

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

Guide

Comment utiliser la santé dans Capacitor

Tester sur appareil

Téléchargez l'application Capgo, puis scannez le code QR code.

Prévisualisation du QR du plugin de santé code

Utilisation de @capgo/capacitor-santé

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

Installer

bun add @capgo/capacitor-health
bunx cap sync

bunx cap sync copie le plugin code natif dans vos projets natifs. Exécutez-l’à nouveau 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 la santé native SDK.
requestAuthorization Demande l'accès en lecture/écriture aux types de données fournis.
checkAuthorization Vérifie l'état d'autorisation pour les types de données fournis sans solliciter l'utilisateur.
readSamples Lit les échantillons pour le type de données spécifié dans la plage de temps spécifiée.
saveSample Écrit un échantillon unique dans le magasin de santé native.
openHealthConnectSettings Ouvre l'écran de paramètres de Health Connect (disponible uniquement sur Android). Sur iOS, cette méthode ne fait rien.
showPrivacyPolicy Affiche la politique de confidentialité de l'application pour Health Connect (disponible uniquement sur Android). Sur iOS, cette méthode ne fait rien.
queryWorkouts Interroge les sessions d'entraînement à partir du magasin de santé native. Supporté sur iOS (HealthKit) et Android (Health Connect).
queryAggregated Interroge les données de santé agrégées à partir du magasin de santé native. Agrège les données en blocs de temps (heure, jour, semaine, mois) avec des opérations comme somme, moyenne, minimum ou maximum. Cela est plus efficace que de récupérer des échantillons individuels pour de grandes plages de dates.

Exemples

isAvailable()

Indique si la plateforme actuelle prend en charge la santé native SDK.

import { Health } from '@capgo/capacitor-health';

const result = await Health.isAvailable();
console.log(result);

requestAuthorization()

Accédez aux données fournies en lecture/écriture.

import { Health } from '@capgo/capacitor-health';

const result = await Health.requestAuthorization({ read: ['steps'] });
console.log(result);

checkAuthorization()

Vérifiez l'état d'autorisation pour les données fournies sans solliciter l'utilisateur.

import { Health } from '@capgo/capacitor-health';

const result = await Health.checkAuthorization({ read: ['steps'] });
console.log(result);

readSamples()

Lisez des échantillons pour le type de données spécifié dans la période de temps indiquée.

import { Health } from '@capgo/capacitor-health';

const result = await Health.readSamples({ dataType: 'steps' });
console.log(result);

saveSample()

Écrivez un échantillon unique dans le magasin de santé natif.

import { Health } from '@capgo/capacitor-health';

await Health.saveSample({
  dataType: 'steps',
  value: 1,
});

openHealthConnectSettings()

Ouvrez l'écran de paramètres de Health Connect (disponible uniquement sur Android). Sur iOS, cette méthode ne fait rien.

import { Health } from '@capgo/capacitor-health';

await Health.openHealthConnectSettings();

Les méthodes ci-dessus sont listées. Les aides pour les listeners et les versions, ainsi que le contrat complet de chaque méthode, sont documentés dans le répertoire GitHub.

Référence complète

Continuez à partir de l'utilisation de @capgo/capacitor-health

If vous utilisez En utilisant @capgo/capacitor-health pour planifier le travail de plugin natif, connectez-l’avec @capgo/capacitor-santé pour les détails d'implémentation dans @capgo/capacitor-health, Prise en main pour les détails d'implémentation dans Prise en main, Répertoire des plugins Capgo pour le flux de travail du produit dans Répertoire des plugins Capgo, Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, et Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans l'ajout ou la mise à jour des plugins.

FAQ

FAQ de la santé du plugin

Comment installez-vous le plugin de santé dans une application Capacitor?

Exécutez « bun add @capgo/capacitor-health » (ou « npm install @capgo/capacitor-health »), puis exécutez « bunx cap sync » afin que les projets iOS et Android prennent en charge les natives code. Importez-l’à partir de « @capgo/capacitor-health » dans votre application code.

Fonctionne-t-il @capgo/capacitor-health avec React, Vue et Angular?

Oui. Le plugin de santé est un package Capacitor, il fonctionne donc avec tout framework web qui s'exécute à l'intérieur de Capacitor, y compris Ionic, React, Vue, Angular, Svelte et JavaScript simple.

Quelle version de Capacitor prend en charge @capgo/capacitor-health?

Capgo les plugins suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à la version majeure de votre Capacitor (par exemple, plugin v8 avec Capacitor 8). La table de compatibilité dans le README du GitHub liste les versions maintenues.

Est-ce que @capgo/capacitor-health est gratuit et open source?

Oui. Le code source de code est public sur GitHub à l'adresse https://github.com/Cap-go/capacitor-health/ et le package est gratuit à installer à partir de npm. Les rapports de bogues et les demandes de modification sont les bienvenus.

Puis-je mettre à jour code qui utilise Health sans passer par une revue de l'App Store ?

L'installation ou la mise à niveau du plugin modifie les natives code, il faut donc une nouvelle mise à jour de l'application. Une fois cela fait, les modifications JavaScript, HTML et CSS qui appellent le plugin peuvent être déployées instantanément avec les mises à jour Capgo.

Ship Health changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Démarrer avec Capgo