saveQuantityData(params: Object)

Requires:
HealthKit≥5.18.3@ray-js/ray≥1.6.17
Platforms:
iOS
import { health } from '@ray-js/ray';

const { saveQuantityData } = health;

// Promise usage
try {
  const res = await saveQuantityData({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Write Quantity-type health data (with start and end times) [iOS only]

Parameters

PropertyTypeRequiredDescription
permissionsstring[]NoPermission types (used by APIs that request read/write permissions); see the enum list below for specific values e.g. ["1","2"]
readPermissionsstring[]NoRead permission types (used by APIs that check whether the user has already authorized); see the enum list below for specific values e.g. ["1","2"]
writePermissionsstring[]NoWrite permission types (used by APIs that check whether the user has already authorized); see the enum list below for specific values e.g. ["1","2"]
writePermissionnumberNoWrite permission type (used by the API for checking write permission). See the enumeration list below for specific values
valuenumberNoValue to write (the specific measurement for Quantity or Category data)
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 file
startTimenumberNoStart time, timestamp in seconds
endTimenumberNoEnd time, timestamp in seconds
typenumberNoData type to read/write (used by the read/write APIs). See the enumeration list below for specific values
complete() => voidNoCompletion callback (executed on both success and failure)
success() => voidNoCallback on successful API call
fail(params: Object) => voidNoFailure callback
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

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