authCategoryWritePermissionsSync(params: Object)

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

Description

Request write permission for Category data types [iOS only]

Parameters

PropertyTypeRequiredDescription
permissionsstring[]NoPermission types (used by the API for requesting read/write permissions); see the enum list below for 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 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 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 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 Refer to Apple's official HKTypeIdentifiers.h file for the unit corresponding to each data type
startTimenumberNoStart time, timestamp in seconds
endTimenumberNoEnd time, timestamp in seconds
typenumberNoData types to read/write (used by read/write APIs); see the enum list below for values

Return Value

None

Error Code

Error CodeError Message
1AppleHealthParamsError

Examples

Request write permission for sleep analysis data

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

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

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