健康 Capacitor 插件

使用 @capgo/capacitor-health

Capacitor 插件，用于与 Apple HealthKit 和 Health Connect 的数据进行交互。

安装

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	将单个样本写入原生健康数据存储。
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()

将单个样本写入原生健康数据存储。

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 仓库.

完整参考文档

• GitHub 仓库
• 文档
• API 参考文档

继续阅读 使用 @capgo/capacitor-health

如果你正在使用 使用 @capgo/capacitor-health 要规划原生插件工作，请将其与 @capgo/capacitor-health 了解 @capgo/capacitor-health 中的实现细节， 快速入门 有关“入门指南”中的实现细节， Capgo 插件目录 查看 Capgo 插件目录中的产品工作流， Capgo 提供的 Capacitor 插件 有关 Capgo 开发的 Capacitor 插件的实现细节，以及 添加或更新插件 有关添加或更新插件的实现细节。