Global

Members

GlucoseUnits :string

Used for setting units for ocr.
Type:
  • string
Properties:
Name Type Description
MGDL string
MMOLL string
Source:

PeripheralType :number

Type:
  • number
Properties:
Name Type Description
NONE number
THERMOMETER number
BLOOD_PRESSURE number
HEART_RATE number
GLUCOSE number
WEIGHT_SCALE number
PULSE_OXIMETER number
Source:

RecordType :number

For use with HealthKit.getSampleTypesForRecordType
Type:
  • number
Properties:
Name Type Description
NONE number
BIOMETRICS number
DIABETES number
WEIGHT number
ROUTINE number
NUTRITION number
FITNESS number
SLEEP number
Source:

RecordTypeString :string

Records returned from read operations include a record type value. Records submitted to the session requires the record type property to be set to one of these values.
Type:
  • string
Properties:
Name Type Description
BIOMETRICS string
DIABETES string
WEIGHT string
ROUTINE string
NUTRITION string
FITNESS string
SLEEP string
Source:

Type Definitions

AvailableCallback()

Callback response from availability checks
Properties:
Name Type Description
isAvailable boolean Indicates if the requested service is available.
Source:

Callback()

Success Callback
Properties:
Name Type Attributes Description
data any <nullable>
Source:

DataTypeCallback()

Callback for data type requests
Properties:
Name Type Description
dataTypes Array.<string> Array of strings representing SHealth data types associated with a subscription set
Source:

EventCallback()

Properties:
Name Type Description
event string Name of event to fire in the window.
payload Object The payload of the event.
Properties
Name Type Attributes Description
peripheralID number Id of the peripheral the event came from.
record Record <optional>
 Record returned by event.
records Array.<Record> <optional>
 Array of records returned by the event.
error string <optional>
 Error message returned by the event.
Source:

FailCallback()

Fail callback
Properties:
Name Type Description
error string Message describing the error.
Source:

getPassiveReadPeripheralIDsCallback()

Callback response from BLE.getPassiveReadPeripheralIDs
Properties:
Name Type Description
peripheralIDs Array.<number> Array of peripheral IDs that are currently being passively read.
Source:

HKCallback()

Properties:
Name Type Description
event string Name of event to fire in the window, 'validicOnHealthKitRecordsProcessed'
payload Object The payload of the event.
Properties
Name Type Description
recordType number Value of ValidicMobile.RecordType indicating type of records processed.
count number Number of records processed.
Source:

HKHistoricalFetchCallback()

Properties:
Name Type Description
{RecordType} string Number of records fetched of type ValidicMobile.RecordType. The property name is a string containing the numeric value from ValidicMobile.RecordType.
Source:

HKSampleTypesCallback()

Callback response from HealthKit.getSubscriptions
Properties:
Name Type Description
sampleTypes Array.<string> Array of strings representing HealthKit sample types. Values match constants defined in ValidicMobile.HealthKit.SampleType.
Source:

HKSetSubscriptionsCallback()

Callback response from HealthKit.setSubscriptions
Properties:
Name Type Description
unknownIdentifiers Array.<string> Array of strings representing HealthKit sample types which could not be subscribed to.
Source:

InvalidIDCallback()

Properties:
Name Type Attributes Description
error string The String representation of the error that occured.
peripheralID number <optional>
 The peripheral that the error occured with.
Source:

InvalidTypeCallback()

Properties:
Name Type Description
error string The String representation of the error that occured.
type number The peripheral type that the error is related to.
Source:

IsActiveCallback()

Callback response checking if service is active.
Properties:
Name Type Description
isActive boolean Indicates if the requested service is active.
Source:

OCRReadCallback()

Callback response from OCR.read.
Properties:
Name Type Description
peripheralID number ID of the peripheral which was read.
record object Record scanned by OCR process.
image string Base 64 encoded string representation of the image who's values were read.
Source:

PassiveBluetoothCallback()

Callback for Passive Bluetooth callbacks
Properties:
Name Type Description
event Name of the event being returned
payload payload of the event
Properties
Name Type Description
peripheralID number Id of the peripheral the callback event is related to
records Array.<Record> Records returned by the passive bluetooth manager
error string error returned from the passive read failure
Source:

PermissionChangeHandler()

SHealth permission change handler.
Properties:
Name Type Description
accepted Array.<DataType> An array of accepted DataType.
denied Array.<DataType> An array of denied DataType.
Source:

SHealthErrorHandler()

SHealth error function
Properties:
Name Type Description
error SHealthError The error returned by SHealth
Source:

SHealthHandlers

SHealth listeners for successful events
Properties:
Name Type Description
onPermissionChanged PermissionChangeHandler
onSHealthRecords SHealthRecordsHandler
onSHealthError SHealthErrorHandler
onSHealthHistory SHealthHistoryHandler
Source:

SHealthHistoryHandler()

SHealth History handler
Properties:
Name Type Description
summary Object a dictionary of how many records were collected by SHealth and keyed by RecordType
Source:

SHealthRecordsHandler(summary)

SHealth handler for records gathered by Shealth
Parameters:
Name Type Description
summary Object A dictionary of how many records were collected by SHealth keyed by RecordType
Source:

VersionCallback()

Callback response to obtain version information.
Properties:
Name Type Description
version string Version number of the native Validic Mobile library the plugin is using.
Source: