upPedometerModule 计步模块
模块概述
计步模块为H5页面提供获取当前统计的步数的能力。
方法列表
- getStepCount (获取当前统计的步数)
公共数据
- 所有数据均以JSON结构返回,由代码,信息和数据三部分组成
{ "retCode": "000000", //接口状态标识码 "retInfo": "操作成功",//接口信息说明 "retData": null //业务数据 }
具体定义:返回数据通用
模块变更记录
- V3.0.0 无
- V3.2.0
- 计步模块未定义的retCode编码按照通用数据规定变为990001,'获取当前统计的步数失败'使用通用retCode为000001
- V4.0.0
- 计步模块重构
方法说明
getStepCount (获取当前统计的步数)
getStepCount()
适用性
容器 | Nebula |
---|---|
支持情况 | 是 |
APP版本 | 6.12.0 及以上 |
params 输入参数:
无
错误返回 retCode说明:
retCode编码 | retInfo说明 |
---|---|
使用通用retCode
正确返回 retData说明:
属性名 | 数据类型 | 说明 |
---|---|---|
step | Number | 当前统计的步数 |
示例
调用方式
uplusapi.upPedometerModule.getStepCount().then((result) =>console.log('result',result));
获取成功返回结果
{
"retCode": "000000",
"retInfo": "调用函数getStepCountForPedometer成功",
"retData": {
"step": 100
}
}
获取失败返回结果
{
"retCode": "000001",
"retInfo": "调用函数getStepCountForPedometer失败,errMsg:获取当前统计的步数失败",
}