---
name: "authCharacteristicReadPermissionsSync"
mode: "kit"
versionRequirements:
  - { name: "HealthKit", version: "5.18.0" }
  - { name: "@ray-js/ray", version: "1.6.17" }
platform:
  - "iOS"
title: "health.authCharacteristicReadPermissionsSync - Characteristic 读取权限申请[iOS only]"
---

## authCharacteristicReadPermissionsSync

> [VERSION] HealthKit >= 5.18.0 | @ray-js/ray >= 1.6.17

> [PLATFORM] iOS

### 描述

申请 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` | 否 | - | 需要读写的数据类型(读写数据的接口使用),具体枚举值查看下文的枚举列表 |

### 错误码

| 错误码 | 错误信息 |
| --- | --- |
| `1` | AppleHealthParamsError |

### 示例代码

#### 申请生物性别数据读取权限

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

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

health.authCharacteristicReadPermissions({
  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);
  },
});
```
