跳转至正文

@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 - 返回当前平台是否支持原生健康 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 插件替代方案的产品工作流。