健康 health
更新时间:
接口声明
{ "name": "service.health" }
复制代码
导入模块
import health from '@service.health' 或 const health = require('@service.health')
复制代码
开发者需要在 manifest.json 里面配置权限:
{
"permissions": [{ "name": "watch.permission.READ_HEALTH_DATA" }]
}
复制代码
接口定义
获取最近一次采样数据
health.getRecentSamples(Object)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
dataTypes | Array | 是 | 每个值都是一个 DATA_TYPES |
success | function | 是 | 回调函数,返回值是一个 Array |
complete | function | 否 | 完成的回调函数 |
fail | function | 否 | 失败回调函数 |
success 返回值是一个 Array,每项是一个 Object,Object 定义如下
参数名 | 值类型 | 说明 |
---|---|---|
dataType | DATA_TYPES | 数据类型 |
data | Sample | 采样数据 |
监听采样数据变化
health.subscribeSample(Object)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
dataType | DATA_TYPES | 是 | 数据类型 |
callback | function | 是 | 回调函数,返回值是一个Sample |
fail | function | 否 | 失败回调函数 |
callback 返回值:
参数值 | 类型 | 说明 |
---|---|---|
data | Array | 采样数据 |
取消监听采样数据变化
health.unsubscribeSample(Object)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
dataType | DATA_TYPES | 是 | 数据类型 |
采样数据相关接口的使用方法可参考以下教程 -- 查询以及监听 Sample
查询当日统计数据
health.getTodayStatistic(Object)
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
dataType | DATA_TYPES | 是 | 数据类型 |
statisticType | STATISTIC_TYPES | 否 | 统计的维度,不同厂商,不同的 dataType 支持的维度不一样,详情 |
success | function | 是 | 回调函数,返回值是一个Statistic, 统计类型由 dataType 决定 |
complete | function | 否 | 完成的回调函数 |
fail | function | 否 | 失败回调函数 |
查询当日统计数据
health.getStatistic(Object)
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
dataType | DATA_TYPES | 是 | 数据类型 |
statisticType | STATISTIC_TYPES | 否 | 统计的维度,不同厂商,不同的 dataType 支持的维度不一样,详情 |
startTime | timeStamp | 否 | 开始时间,在这个时间之后发生的活动,包含在这个时间段之前已经发生,但是还没有结束的活动 |
endTime | timeStamp | 否 | 结束时间,在这个时间之前发生的活动,包含正在发生但还没有完全结束的活动 |
success | function | 是 | 回调函数,返回值是一个Statistic, 统计类型由 dataType 决定 |
complete | function | 否 | 完成的回调函数 |
fail | function | 否 | 失败回调函数 |
监听当日统计数据
health.subscribeTodayStatistic(Object)
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
dataType | DATA_TYPES | 是 | 每个值都是一个 DataType 的枚举类型 |
statisticType | STATISTIC_TYPES | 否 | 统计的维度,不同厂商,不同的 dataType 支持的维度不一样,详情 |
callback | function | 是 | 回调函数,返回值是一个Statistic, 统计类型由 dataType 决定 |
fail | function | 否 | 失败回调函数 |
取消监听当日统计数据
health.unsubscribeTodayStatistic(Object)
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
dataType | DATA_TYPES | 是 | 数据类型 |
统计数据相关接口的使用方法可参考以下教程 -- 查询以及监听 Statistics
采样数据部分
采样数据 ,该部分接口主要用以获取健康情况的采样数据,例如获取当前的心率值或者当天的步数。每个采样的数据结构请见Sample