authStatusPermissions(params: Object)

版本要求:
HealthKit≥5.18.3@ray-js/ray≥1.6.17
支持平台:
iOS
import { health } from '@ray-js/ray';

const { authStatusPermissions } = health;

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

描述

查询用户是否已对 Quantity 类型数据完成读写授权 [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否需要读写的数据类型(读写数据的接口使用),具体枚举值查看下文的枚举列表
complete() => void否接口调用结束的回调函数(调用成功、失败都会执行)
success(params: Object) => void否接口调用成功的回调函数
fail(params: Object) => void否接口调用失败的回调函数
success 回调参数
属性类型说明HealthKit 最低版本
valuenumber授权状态:1 表示传入类型均已申请过对应读写权限;0 表示至少有一项未申请v5.18.4
fail 回调参数
属性类型说明
errorMsgstring错误信息
errorCodestring | number错误码
错误扩展

返回值

无

错误码

错误码错误信息
1AppleHealthParamsError

示例代码

查询 HealthKit 读写授权状态

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

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

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