health.authCharacteristicReadPermissions - Request Characteristic read permissions [iOS only]

authCharacteristicReadPermissions(params: Object)

Requires:

HealthKit≥5.18.0@ray-js/ray≥1.6.17

Platforms:

iOS

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

const { authCharacteristicReadPermissions } = health;

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

Description

Request read permission for Characteristic data types [iOS only]

Parameters

Property	Type	Required	Description
`permissions`	string[]	No	Permission types (used by the API that requests read/write permissions). See the enum list below for values. e.g. ["1","2"]
`readPermissions`	string[]	No	Read permission types (used by the API that checks whether the user has granted authorization). See the enum list below for values. e.g. ["1","2"]
`writePermissions`	string[]	No	Write permission types (used by the API that checks whether the user has granted authorization). See the enum list below for values. e.g. ["1","2"]
`writePermission`	number	No	Write permission types (used by the API that checks for write permission). See the enum list below for values.
`value`	number	No	Value to write (the specific measurement for Quantity or Category data).
`unitType`	string	No	Unit to pass in, e.g., "mg/dL", "g", "cm", "count"; required when reading or writing Quantity data. For the units corresponding to each data type, refer to Apple's official HKTypeIdentifiers.h file.
`startTime`	number	No	Start time, timestamp in seconds.
`endTime`	number	No	End time, timestamp in seconds.
`type`	number	No	Data types to read/write (used by the data read/write APIs). See the enum list below for values.
`complete`	() => void	No	Completion callback (executed on both success and failure)
`success`	() => void	No	Callback on successful API call
`fail`	(params: Object) => void	No	Failure callback

fail callback parameters

Property	Type	Description
`errorMsg`	string	Error message
`errorCode`	string \| number	Error code
		Error extension

Return Value

None

Error Code

Error Code	Error Message
`1`	AppleHealthParamsError

Examples

Request read permission for biological sex data

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

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

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