health.readCharacteristicDataWithType - 读取 Characteristic[iOS only]

readCharacteristicDataWithType(params: Object)

版本要求:

HealthKit≥5.18.0@ray-js/ray≥1.6.17

支持平台:

iOS

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

const { readCharacteristicDataWithType } = health;

// Promise 调用
try {
  const res = await readCharacteristicDataWithType({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

描述

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

参数

属性	类型	必填	说明
`permissions`	string[]	否	权限类型(申请读写权限的接口使用)，具体枚举值查看下文的枚举列表 eg. ["1","2"]
`readPermissions`	string[]	否	读取权限类型(查询用户是否已经做过授权操作的接口使用),具体枚举值查看下文的枚举列表 eg. ["1","2"]
`writePermissions`	string[]	否	写入权限类型(查询用户是否已经做过授权操作的接口使用),具体枚举值查看下文的枚举列表 eg. ["1","2"]
`writePermission`	number	否	写入权限类型(查询是否有写权限的接口使用),具体枚举值查看下文的枚举列表
`value`	number	否	写入数值（Quantity 或 Category 类型数据的具体测量值）
`unitType`	string	否	传入单位比如"mg/dL"，"g","cm","count",查询和写入Quantity类型数据时需要数据类型对应单位可参考苹果官方的HKTypeIdentifiers.h文件
`startTime`	number	否	开始时间,秒级时间戳
`endTime`	number	否	结束时间,秒级时间戳
`type`	number	否	需要读写的数据类型(读写数据的接口使用),具体枚举值查看下文的枚举列表
`complete`	() => void	否	接口调用结束的回调函数（调用成功、失败都会执行）
`success`	(params: Object) => void	否	接口调用成功的回调函数
`fail`	(params: Object) => void	否	接口调用失败的回调函数

success 回调参数

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

fail 回调参数

属性	类型	说明
`errorMsg`	string	错误信息
`errorCode`	string \| number	错误码
		错误扩展

返回值

无

错误码

错误码	错误信息
`1`	AppleHealthParamsError

示例代码

读取生物性别数据

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);
  },
});