readCharacteristicDataWithTypeSync(params: Object)

版本要求:
HealthKit≥5.18.0@ray-js/ray≥1.6.17
支持平台:
iOS

描述

按类型读取 Characteristic 健康数据 [iOS only]

参数

属性类型必填说明
permissionsstring[]否权限类型(申请读写权限的接口使用),具体枚举值查看下文的枚举列表 eg. ["1","2"]
readPermissionsstring[]否读取权限类型(查询用户是否已经做过授权操作的接口使用),具体枚举值查看下文的枚举列表 eg. ["1","2"]
writePermissionsstring[]否写入权限类型(查询用户是否已经做过授权操作的接口使用),具体枚举值查看下文的枚举列表 eg. ["1","2"]
writePermissionnumber否写入权限类型(查询是否有写权限的接口使用),具体枚举值查看下文的枚举列表
valuenumber否写入数值(Quantity 或 Category 类型数据的具体测量值)
unitTypestring否传入单位 比如"mg/dL","g","cm","count",查询和写入Quantity类型数据时需要 数据类型对应单位可参考苹果官方的HKTypeIdentifiers.h文件
startTimenumber否开始时间,秒级时间戳
endTimenumber否结束时间,秒级时间戳
typenumber否需要读写的数据类型(读写数据的接口使用),具体枚举值查看下文的枚举列表

返回值

类型:Object↓
属性类型说明HealthKit 最低版本
读取到的数据,是一个数组,数组中每一项是一个字典,具体定义如下 value: Integer 读取到的值,不同的含义参考苹果官方文档 startDate: Double 读取到的条目的起始时间戳 endDate: Double 读取到的条目的截止时间戳v5.18.4

错误码

错误码错误信息
1AppleHealthParamsError

示例代码

读取生物性别数据

import { health } from '@ray-js/ray'

const endTime = Math.floor(Date.now() / 1000);
const startTime = endTime - 60 * 60;

health.readCharacteristicDataWithType({
  permissions: ["1"],
  readPermissions: ["1"],
  writePermissions: ["1"],
  writePermission: 1,
  value: 65.5,
  unitType: "count",
  startTime,
  endTime,
  type: 1,
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});