deleteQuantityDataType(params: Object)

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

const { deleteQuantityDataType } = health;

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

Description

Delete Quantity health data by type and time range [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, such as "mg/dL", "g", "cm", "count"; required when querying or writing Quantity-type data. For the units corresponding to each data type, refer to Apple’s official HKTypeIdentifiers.h file.
startTimenumberNoStart time, Unix timestamp in seconds
endTimenumberNoEnd time, Unix timestamp in seconds
typenumberNoData types to read/write (used by the data read/write APIs). See the enum 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

Delete weight data by time range

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

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

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