ガイド
Capacitor で Health を使用する方法
@capgo/capacitor-health の使用
Apple HealthKit や Health Connect のデータと連携するための Capacitor プラグイン。
インストール
bun add @capgo/capacitor-health
bunx cap sync
bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。
インポート
import { Health } from '@capgo/capacitor-health';
API の概要
| メソッド | 説明 |
|---|---|
isAvailable |
現在のプラットフォームがネイティブのヘルス SDK をサポートしているかどうかを返します。 |
requestAuthorization |
指定されたデータ型への読み取り/書き込みアクセスをリクエストします。 |
checkAuthorization |
ユーザーにプロンプトを出さずに、指定されたデータ型の認可ステータスを確認します。 |
readSamples |
指定されたデータ型のサンプルを、指定された期間内に読み取ります。 |
saveSample |
1件のサンプルをネイティブのヘルスストアに書き込みます。 |
openHealthConnectSettings |
Health Connectの設定画面を開きます（Androidのみ）。iOSではこのメソッドは動作しません。 |
showPrivacyPolicy |
Health Connectに関するアプリのプライバシーポリシーを表示します（Androidのみ）。iOSではこのメソッドは動作しません。 |
queryWorkouts |
ネイティブのヘルスストアからワークアウトセッションを取得します。iOS（HealthKit）とAndroid（Health Connect）に対応しています。 |
queryAggregated |
ネイティブのヘルスストアから集計済みのヘルスデータを取得します。データは時間バケット（時・日・週・月）に集計され、合計・平均・最小・最大などの操作が可能です。広い日付範囲で個別のサンプルを取得するより効率的です。 |
例
isAvailable()
現在のプラットフォームがネイティブのヘルス SDK をサポートしているかどうかを返します。
import { Health } from '@capgo/capacitor-health';
const result = await Health.isAvailable();
console.log(result);
requestAuthorization()
指定されたデータ型への読み取り/書き込みアクセスをリクエストします。
import { Health } from '@capgo/capacitor-health';
const result = await Health.requestAuthorization({ read: ['steps'] });
console.log(result);
checkAuthorization()
ユーザーにプロンプトを出さずに、指定されたデータ型の認可ステータスを確認します。
import { Health } from '@capgo/capacitor-health';
const result = await Health.checkAuthorization({ read: ['steps'] });
console.log(result);
readSamples()
指定されたデータ型のサンプルを、指定された期間内に読み取ります。
import { Health } from '@capgo/capacitor-health';
const result = await Health.readSamples({ dataType: 'steps' });
console.log(result);
saveSample()
1件のサンプルをネイティブのヘルスストアに書き込みます。
import { Health } from '@capgo/capacitor-health';
await Health.saveSample({
dataType: 'steps',
value: 1,
});
openHealthConnectSettings()
Health Connectの設定画面を開きます（Androidのみ）。iOSではこのメソッドは動作しません。
import { Health } from '@capgo/capacitor-health';
await Health.openHealthConnectSettings();
上記の表には9つのコアメソッドが記載されています。リスナーやバージョンのヘルパー、および各メソッドの完全なコントラクトについては、 GitHub リポジトリ.
完全なリファレンス
「@capgo/capacitor-health の使用」から続ける
使用している場合 @capgo/capacitor-health の使用 ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-health @capgo/capacitor-health の実装の詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。