跳转到正文

@capgo/capacitor-health

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

@capgo/capacitor-health 通过以下方式读写用户健康数据: Apple HealthKit (iOS 端)以及 Health Connect 在 Android 上。用它处理步数、锻炼、睡眠阶段、生命体征和营养类样本,无需在应用层维护两套独立的原生 SDK 集成。

健身仪表盘、习惯类应用、临床相关健康产品和企业健康计划,通常都从 requestAuthorization,然后 readSamples 或 saveSample 来获取他们关注的指标。

平台支持备注
iOS是HealthKit 授权与样本数据
Android是Health Connect,用于读取 30 天以上历史记录的可选权限
Web 端有限isAvailable 报告不支持的 native SDK

仅限 Android 的辅助函数: openHealthConnectSettings, showPrivacyPolicy.

  • isAvailable - 返回当前平台是否支持 native health SDK。
  • requestAuthorization - 请求对指定数据类型的读/写权限。
  • checkAuthorization - 在不提示用户的情况下,检查指定数据类型的授权状态。
  • readSamples - 读取给定数据类型在指定时间范围内的样本。
方法描述
isAvailable返回当前平台是否支持原生健康 SDK。
requestAuthorization请求对指定数据类型的读/写权限。
checkAuthorization检查所提供数据类型的授权状态,不会向用户弹出提示。
readSamples读取指定时间范围内特定数据类型的样本。
saveSample将单个样本写入原生健康数据存储。
getPluginVersion获取原生 Capacitor 插件版本。
openHealthConnectSettings打开 Health Connect 设置界面(仅限 Android)。在 iOS 上,此方法无效。
showPrivacyPolicy显示 Health 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 插件中的实现细节, 添加或更新插件 关于“添加或更新插件”中的实现细节,以及 Ionic Enterprise 插件替代方案 关于“Ionic Enterprise 插件替代方案”中的产品工作流。