readCharacteristicDataWithTypeSync(params: Object)

Requires:
HealthKit≥5.18.0@ray-js/ray≥1.6.17
Platforms:
iOS

Description

Read Characteristic health data by type [iOS only]

Parameters

PropertyTypeRequiredDescription
permissionsstring[]NoPermission types (used by the API to request read/write permissions). See the enum list below for specific values. e.g., ["1","2"]
readPermissionsstring[]NoRead permission types (used by the API that checks whether the user has already authorized). See the enum list below for specific values. e.g., ["1","2"]
writePermissionsstring[]NoWrite permission types (used by the API that checks whether the user has already authorized). See the enum list below for specific values. e.g., ["1","2"]
writePermissionnumberNoWrite permission types (used by the API that checks whether write permission is granted). See the enum list below for specific values.
valuenumberNoValue to write (the specific measurement for Quantity or Category data types).
unitTypestringNoUnit to pass in, e.g., "mg/dL", "g", "cm", "count"; required when querying and writing Quantity-type data. For the unit applicable to each data type, refer to Apple's HKTypeIdentifiers.h.
startTimenumberNoStart time, Unix timestamp in seconds
endTimenumberNoEnd time, Unix timestamp in seconds
typenumberNoData type to read/write (used by read/write APIs); see the enum list below for values

Return Value

Type: Object↓
PropertyTypeDescriptionHealthKit Since
The data read is an array; each item is a dictionary defined as follows value: Integer The value read; see Apple's official documentation for its meaning startDate: Double The start timestamp of the entry endDate: Double The end timestamp of the entryv5.18.4

Error Code

Error CodeError Message
1AppleHealthParamsError

Examples

Read biological sex data

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