メインコンテンツへスキップ

@capgo/capacitor-health

Apple HealthKitおよびHealth Connectのデータを操作するためのCapacitorプラグイン。

@capgo/capacitor-health を通じてユーザーのヘルスデータを読み書きします。 Apple HealthKit のiOS、および Health Connect のAndroidに対応しています。アプリ層で2つの異なるネイティブ SDK 統合を管理することなく、歩数、ワークアウト、睡眠ステージ、バイタル、栄養サンプルなどの取得が可能です。

フィットネスダッシュボード、習慣化アプリ、医療関連のウェルネス製品、企業のウェルネスプログラムなどは、通常 requestAuthorizationから始め、次に readSamples または saveSample で必要なメトリクスを取得します。

プラットフォームサポート備考
iOSはいHealthKitの権限取得とサンプルデータ
AndroidはいHealth Connect(30日を超える履歴の読み取りに必要)
Web限定的isAvailable サポートされていないNative SDKを報告

Android専用のヘルパー: openHealthConnectSettings, showPrivacyPolicy.

  • isAvailable - 現在のプラットフォームがネイティブのhealth SDK をサポートしているかを確認します。
  • requestAuthorization - 指定されたデータ型への読み取り/書き込み権限をリクエストします。
  • checkAuthorization - ユーザーにプロンプトを表示せずに、指定されたデータ型の権限ステータスを確認します。
  • readSamples - 指定された時間内の、指定されたデータ型のサンプルを読み取ります。
メソッド説明
isAvailable現在のプラットフォームがネイティブのヘルス SDK をサポートしているかどうかを返します。
requestAuthorization指定されたデータ型への読み取り/書き込みアクセスをリクエストします。
checkAuthorizationユーザーにプロンプトを表示せずに、指定されたデータ型の承認ステータスを確認します。
readSamples指定された期間内の、指定されたデータ型のサンプルを読み取ります。
saveSample単一のサンプルをネイティブのヘルスストアに書き込みます。
getPluginVersionネイティブの Capacitor プラグインのバージョンを取得します。
openHealthConnectSettingsHealth Connect の設定画面を開きます (Android のみ)。iOS ではこのメソッドは何もしません。
showPrivacyPolicyHealth Connect(Androidのみ)のアプリプライバシーポリシーを表示します。iOSではこのメソッドは動作しません。
queryWorkoutsネイティブのヘルスストアからワークアウトセッションを取得します。iOS (HealthKit) と Android (Health Connect) に対応しています。
queryAggregatedネイティブのヘルスストアから集計済みのヘルスデータを取得します。データは時間バケット(時・日・週・月)単位で、合計・平均・最小・最大などの操作で集計されます。広い日付範囲で個別のサンプルを取得するより効率的です。

このリファレンスは以下から同期されています: src/definitions.ts 内の capacitor-health.

以下を使用している場合: @capgo/capacitor-health ネイティブプラグインの作業を計画するには、それを以下と連携させる @capgo/capacitor-health の使い方 @capgo/capacitor-healthの使用におけるネイティブ機能について Capgo プラグインディレクトリ Capgo プラグインディレクトリでのプロダクトワークフロー向けに、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加・更新 実装の詳細は Adding or Updating Plugins を、 Ionic Enterprise プラグインの代替案 製品ワークフローは Ionic Enterprise Plugin Alternatives を参照してください。