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

## readCharacteristicDataWithTypeSync

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

> [PLATFORM] iOS

### 描述

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

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `permissions` | `string[]` | 否 | - | `5.18.3` | 权限类型(申请读写权限的接口使用)，具体枚举值查看下文的枚举列表 eg. ["1","2"] |
| `readPermissions` | `string[]` | 否 | - | `5.18.3` | 读取权限类型(查询用户是否已经做过授权操作的接口使用),具体枚举值查看下文的枚举列表 eg. ["1","2"] |
| `writePermissions` | `string[]` | 否 | - | `5.18.3` | 写入权限类型(查询用户是否已经做过授权操作的接口使用),具体枚举值查看下文的枚举列表 eg. ["1","2"] |
| `writePermission` | `number` | 否 | - | `5.18.3` | 写入权限类型(查询是否有写权限的接口使用),具体枚举值查看下文的枚举列表 |
| `value` | `number` | 否 | - | `5.18.3` | 写入数值（Quantity 或 Category 类型数据的具体测量值） |
| `unitType` | `string` | 否 | - | `5.18.3` | 传入单位 比如"mg/dL"，"g","cm","count",查询和写入Quantity类型数据时需要 数据类型对应单位可参考苹果官方的HKTypeIdentifiers.h文件 |
| `startTime` | `number` | 否 | - | `5.18.3` | 开始时间,秒级时间戳 |
| `endTime` | `number` | 否 | - | `5.18.3` | 结束时间,秒级时间戳 |
| `type` | `number` | 否 | - | `5.18.3` | 需要读写的数据类型(读写数据的接口使用),具体枚举值查看下文的枚举列表 |

### 错误码

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

### 示例代码

#### 基础调用

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

const { readCharacteristicDataWithTypeSync } = health;

const result = readCharacteristicDataWithTypeSync({
  type: 1,
});
console.log('readCharacteristicDataWithTypeSync result', result.value);
```