与Android Health Connect互动的电容插件.
安装
npm install @devmaxime/capacitor-health-connect
npx cap sync
在您的应用程序中添加以下内容 AndroidManifest.xml数字 :
<queries>
<package android:name="com.google.android.apps.healthdata" />
</queries>
把这个加进你的 AndroidManifest.xml数字 :
<application>
...
<activity>
...
<!-- Permission handling for Android 13 and before -->
<intent-filter>
<action android:name="androidx.health.ACTION_SHOW_PERMISSIONS_RATIONALE" />
</intent-filter>
<!-- Permission handling for Android 14 and later -->
<intent-filter>
<action android:name="android.intent.action.VIEW_PERMISSION_USAGE"/>
<category android:name="android.intent.category.HEALTH_PERMISSIONS"/>
</intent-filter>
...
</activity>
</application>
权限
您还需要在 AndroidManifest.xml 上添加您想要读取和/或写入的记录的权限 。 可以找到一份完整的可用记录和相应的权限清单 这里。 。 。 .
<!-- Example permissions -->
<uses-permission android:name="android.permission.health.READ_STEPS"/>
<uses-permission android:name="android.permission.health.WRITE_STEPS"/>
<uses-permission android:name="android.permission.health.READ_EXERCISE"/>
<uses-permission android:name="android.permission.health.WRITE_EXERCISE"/>
API 密码
checkAvailability()requestPermissions(...)getGrantedPermissions()revokePermissions()readRecords(...)aggregateRecords(...)- 接口
- 类型异名
检查可用性( )
checkAvailability() => Promise<{ availability: HealthConnectAvailability; }>
回返情况: Promise<{ availability: HealthConnectAvailability; }>
请求(...)
requestPermissions(options: { read: RecordType[]; write: RecordType[]; }) => Promise<PermissionsResponse>
| 参数 | 类型 |
|---|---|
options | { read: RecordType[]; write: RecordType[]; } |
回返情况: Promise<PermissionsResponse>
获得授权的许可( C)
getGrantedPermissions() => Promise<PermissionsResponse>
回返情况: Promise<PermissionsResponse>
撤销( )
revokePermissions() => Promise<void>
读取记录(...)
readRecords(options: { start: string; end: string; type: RecordType; pageSize?: number; pageToken?: string; }) => Promise<ReadRecordsResponse>
在一个时间范围内读取指定类型的记录.
未提供页面时, 将使用自动页码检索所有记录 在指定的时间范围内。 大型数据集可能需要更长的时间,但要确保 完全数据检索.
在提供页面时,使用手动页码,只使用一个单页 结果与下一个PageToken一起返回,以检索随后的页面.
| 参数 | 类型 |
|---|---|
options | { start: string; end: string; type: RecordType; pageSize?: number; pageToken?: string; } |
回返情况: Promise<ReadRecordsResponse>
汇总记录(...)
aggregateRecords(options: { start: string; end: string; type: AggregateRecordType; groupBy?: AggregateGroupBy; }) => Promise<AggregateResponse>
在一个时间范围内汇总指定类型的记录. 返回按规定时间段分组的汇总数据(例如每日总数).
| 参数 | 类型 |
|---|---|
options | { start: string; end: string; type: AggregateRecordType; groupBy?: AggregateGroupBy; } |
回返情况: Promise<AggregateResponse>
接口
权限响应
| Prop | 类型 |
|---|---|
read | RecordType[] |
write | RecordType[] |
读取记录回复
阅读健康记录后的反应.
当使用自动页标( 未提供页面Token) 时, 所有记录都会返回 下一个PageToken将被取消定义.
当使用手动 pagination (pageToken 提供) 时, 下一个 PageToken 将包含 下页的符号,如果这是最后一页,则未定义.
| Prop | 类型 |
|---|---|
records | any[] |
nextPageToken | string |
总体反应
健康记录汇总的答复. 载有按时间段分类的汇总数据.
| Prop | 类型 |
|---|---|
aggregates | AggregateData[] |
汇总数据
特定时期的汇总数据.
| Prop | 类型 |
|---|---|
startTime | string |
endTime | string |
value | number |
unit | string |
类型异名
健康连通性
'Available' | 'NotSupported' | 'NotInstalled'
记录类型
'Steps' | 'Weight' | 'ActivitySession' | 'SleepSession' | 'RestingHeartRate'
总计记录
'Steps' | 'Distance' | 'TotalCaloriesBurned' | 'ActiveCaloriesBurned' | 'HeartRate'
组合By
'day' | 'hour' | 'week' | 'month'
Android Health Connect TODO中的现有记录:将此添加到文档中.
ActiveCalories Burned - > Class androidx.health.connect.client.records. ActiveCalories Burned Records (英语). ActiveCalories Burned Record (英语) 活动会话 - > 类与roidx.health.connect.client.records. 练习会话记录 BasalBodyTemperature - > 类与roidx.health.connect.client.records.BasalBodyTemperature 互联网档案馆的存檔,存档日期2013-12-02 BasalMetabolicRate - > 类与roidx.health.connect.client.records.BasalMetabolicRate Records 血葡萄糖 - > 类和roidx.health.connect.client.records. Blood 葡萄糖记录 血压 - > 类和roidx.health.connect.client.records. BloodPressure Records BodyFat - > 类和roidx.health.connect.client.records.BodyFat Record (英语) BodyTemperature - > 类与roidx.health.connect.client.records.BodyTemperature Records (英语) BodyWaterMass - > Class androidx.health.connect.client.records.BodyWaterMass Record (英语) BoneMass - > Class androidx.health.connect.client.records.BoneMass Record 互联网档案馆的存檔,存档日期2014-12-02 子宫颈穆克斯 - > 类与roidx.health.connect.client.records. Cervical穆克斯记录 CyclingPedalingCadenceSeries - > 类与roidx.health.connect.client.client.records. CyclingPedalingCadence Record (英语) 距离 - > 类和roidx.health.connect.client.records. 远程记录 ElevationGained - > 类和roidx.health.connect.client.records.elevationGained Records FloorsClimbed - > Class androidx.health.connect.client.records.floorsClimbed Records (英语) HeartRateSeries - > 类和roidx.health.connect.client.client.records. 心脏记录 HeartRateVariabilityRmsd - > Class androidx.health.connect.client.client.records. HeartRateVariabilityRmsd Record (中文(中国大陆) ) 高度 - > 类和roidx.health.connect.client.records.Height Records 水分 - > 类和roidx.health.connect.client.records. 水分记录 LeanBodyMass - > Class androidx.health.connect.client.records. LeanBodyMass Record 互联网档案馆的存檔,存档日期2013-12-22 月经 - > 类与roidx.health.connect.client.records.Menstruation FlowRecord 互联网档案馆的存檔,存档日期2013-12-21 月经Period - > 类与roidx.health.connect.client.records.MenstruationPeriod Records 营养 - > 类与roidx.health.connect.client.records. 营养记录 排出 测试 - > Class androidx.health.connect.client.records.Ovulate Testrecord 互联网档案馆的存檔,存档日期2013-12-22 氧饱和 - > 类和roidx.health.connect.client.records.oxygen饱和记录 PowerSeries - > 类和roidx.health.connect.client.records. 权力记录 呼吸道 - > 类与roidx.health.connect.client.records. 呼吸道记录 恢复心电图 - > Class androidx.health.connect.client.records.Resting HeartRate Record 互联网档案馆的存檔,存档日期2013-12-21 性活性 - > 类和roidx.health.connect.client.records. Sexual Activity Records SkinTemperature - > Class androidx.health.connect.client.records. SkinTemperature Records (英语). SkinTemperature Record (英语) 睡眠会话 - > 类和roidx.health.connect.client.records. sleeps.records. 睡眠会话记录 速度串 - > 类和roidx.health.connect.client.records.peed Records Intermenstrual Bleeding - > Class androidx.health.connect.client.client.records. Intermenstrual Bleeding Record 互联网档案馆的存檔,存档日期2013-12-02 Steps - > Class androidx.health.connect.client.records.Steps 记录系统 存档副本 步骤CadenceSeries - > 类和roidx.health.connect.client.records.StepsCadence Records TotalCalories Burned - > Class androidx.health.connect.client.records. TotalCalories Burned Records (中文(中国大陆) ) Vo2Max - > 类和roidx.health.connect.client.records.Vo2Max记录 轮椅 Pushes - > 类与roidx.health.connect.client.records.Wheelfair Pushes Record (英语) 重量 - > 类和roidx.health.connect.client.records.weight Records