saveQuantityDataSync(params: Object)

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

Description

Write health data of type Quantity (with start/end time) [iOS only]

Parameters

PropertyTypeRequiredDescriptionHealthKit Since
permissionsstring[]NoPermission types (used by the API that requests read/write permissions). See the enumeration list below for specific values, e.g., ["1","2"]v5.18.0
readPermissionsstring[]NoRead permission types (used by the API that checks whether the user has previously authorized). See the enumeration list below for specific values, e.g., ["1","2"]v5.18.0
writePermissionsstring[]NoWrite permission types (used by the API that checks whether the user has previously authorized). See the enumeration list below for specific values, e.g., ["1","2"]v5.18.0
writePermissionnumberNoWrite permission type (used by the API for checking write permission). See the enumeration list below for specific valuesv5.18.0
valuenumberNoValue to write (the specific measurement for Quantity or Category data)v5.18.0
unitTypestringNoUnit to pass in, e.g., "mg/dL", "g", "cm", "count". Required when querying or writing Quantity data. For units corresponding to each data type, refer to Apple’s official HKTypeIdentifiers.h filev5.18.0
startTimenumberNoStart time, timestamp in secondsv5.18.0
endTimenumberNoEnd time, timestamp in secondsv5.18.0
typenumberNoData type to read/write (used by the read/write APIs). See the enumeration list below for specific valuesv5.18.0

Return Value

None

Error Code

Error CodeError Message
1AppleHealthParamsError
2AppleHealthNoPermission

Examples

Write weight data at a specified time

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

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

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