Members
GlucoseUnits :string
Used for setting units for ocr.
Type:
Properties:
Name |
Type |
Description |
MGDL |
string
|
|
MMOLL |
string
|
|
- Source:
PeripheralType :number
Type:
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:
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:
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:
AvailableCallback()
Generic callback indicating feature availability.
Properties:
Name |
Type |
Description |
isAvailable |
boolean
|
True for is available, false for not |
- Source:
BiometricsRecord
Subtype of
Record. Adds the following additional properties
Type:
Properties:
Name |
Type |
Description |
blood_calcium |
number
|
The value of the measured quantity in mg/dL. |
blood_chromium |
number
|
The value of the measured quantity in µg/L. |
blood_folic_acid |
number
|
The value of the measured quantity in ng/mL. |
blood_magnesium |
number
|
The value of the measured quantity mg/dL. |
blood_potassium |
number
|
The value of the measured quantity in mEq/L. |
blood_sodium |
number
|
The value of the measured quantity in mEq/L. |
blood_vitamin_b12 |
number
|
The value of the measured quantity in pg/mL. |
blood_zinc |
number
|
The value of the measured quantity in µg/dL. |
creatine_kinase |
string
|
The value of the measured quantity in U/L. |
crp |
string
|
The value of the measured quantity in mg/L. |
diastolic |
string
|
The value of the measured quantity in mmHg. |
ferritin |
string
|
The value of the measured quantity in ng/mL. |
hdl |
string
|
The value of the measured quantity in mg/dL. |
hscrp |
string
|
The value of the measured quantity in mg/L . |
il6 |
string
|
The value of the measured quantity in pg/mL. |
ldl |
string
|
The value of the measured quantity in mg/dL. |
resting_heartrate |
string
|
The value of the measured quantity in bpm. |
systolic |
string
|
The value of the measured quantity in mmHg. |
testosterone |
string
|
The value of the measured quantity in ng/dL. |
total_cholesterol |
string
|
The value of the measured quantity in mg/dL. |
tsh |
string
|
The value of the measured quantity in mIU/L. |
uric_acid |
string
|
The value of the measured quantity in mg/dL. |
vitamin_d |
string
|
The value of the measured quantity in ng/mL. |
white_cell_count |
string
|
The value of the measured quantity in cells/µL. |
spo2 |
string
|
The value of the measured quantity in %. |
temperature |
string
|
The value of the measured quantity in Celsius. |
- 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:
DiabetesRecord
Subtype of
Record. Adds the following additional properties
Type:
Properties:
Name |
Type |
Description |
c_peptide |
number
|
The value of the measured quantity in ng/mL. |
fasting_plasma_glucose_test |
number
|
The value of the measured quantity in mg/dL. |
hba1c |
number
|
The value of the measured quantity in %. |
insulin |
number
|
The value of the measured quantity U. |
oral_glucose_tolerance_test |
number
|
The value of the measured quantity in mg/dL. |
random_plasma_glucose_test |
number
|
The value of the measured quantity in mg/dL. |
triglyceride |
number
|
The value of the measured quantity in mg/dL. |
blood_glucose |
number
|
The value of the measured quantity mg/dL. |
relationship_to_meal |
string
|
The value of the measured quantity. |
- 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:
FitnessRecord
Subtype of
Record. Adds the following additional properties
Type:
Properties:
Name |
Type |
Description |
type |
string
|
Type of fitness activity: Walking, Running, Swimming, etc. |
intensity |
string
|
Subjective intensity with which an activity was performed.
Examples are: low, medium, high. Returned as provided by source. |
start_time |
string
|
Timestamp of when fitness activity started in ISO08601 format. |
distance |
number
|
Distance in meters. |
duration |
number
|
Duration of fitness activity in seconds. |
calories |
number
|
Calories burned during fitness activity. |
- 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:
InProgressCallback()
Callback response from BLE.inProgress.
Properties:
Name |
Type |
Description |
inProgress |
boolean
|
Indicates if BLE operation is currently in progress. |
- 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:
NutritionRecord
Subtype of
Record. Adds the following additional properties
Type:
Properties:
Name |
Type |
Description |
calories |
number
|
Calories consumed per food intake. |
carbohydrates |
number
|
Grams of carbohydrates consumed. |
fat |
number
|
Grams of fat consumed. |
fiber |
number
|
Grams of fiber consumed. |
protein |
number
|
Grams of protein consumed. |
sodium |
number
|
Grams of sodium consumed. |
water |
number
|
Grams of water consumed. |
meal |
number
|
Meal consumed: Breakfast, Lunch, or Dinner. |
- 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:
Peripheral
Type:
Properties:
Name |
Type |
Description |
ID |
number
|
A unique identifer for a particular peripheral model. |
Type |
number
|
The type of the peripheral, used to identify its function. PeripheralType |
Model |
string
|
Model number of the peripheral. |
Manufacturer |
string
|
Manufacturer name of the peripheral. |
PeripheralImageURL |
string
|
URL for an image of the peripheral. |
- Source:
PeripheralCallback()
Callback with a single peripheral.
Properties:
Name |
Type |
Description |
peripheral |
Peripheral
|
Returned peripheral. |
- Source:
PeripheralsCallback()
Callback with a list of peripherals.
Properties:
Name |
Type |
Description |
peripherals |
Array.<Peripheral>
|
List of peripherals returned. |
- Source:
PeripheralsOfTypeCallback()
Callback with a list of peripherals.
Properties:
Name |
Type |
Description |
peripherals |
Array.<Peripheral>
|
List of Peripherals returned. |
type |
number
|
Type of peripheral requested. |
- 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:
Record
Subtype of
Peripheral. Adds the following additional properties
Type:
Properties:
Name |
Type |
Description |
RequiresPairing |
boolean
|
Indicates if a peripheral model requires a Bluetooth pairing before it can be used. |
Instruction |
string
|
Text to be presented to the user when BLE.read is called. |
ReadingInstruction |
string
|
Text to be presented to the user when the BLE.ON_READY_TO_READ event is received. |
PairingInstruction |
string
|
Text to be presented to the user when BLE.pair is called.
/** |
activity_id |
string
|
Unique ID generated by the orginal source. |
recordType |
string
|
Type of record. This field not present on server. Added for use by Cordova plugin. Possible values
are "biometrics", "diabetes", "weight", "routine", "nutrition", "fitness", "sleep". |
timestamp |
string
|
Timestamp for the measurement set. |
source |
string
|
The short name of the Validic integration that created the record (validicmobile). |
source_name |
string
|
The display name of the Validic integration that created the record (ValidicMobile). |
original_source |
string
|
The name of the peripheral manufacturer, for records sourced from HealthKit this will be
the name of the application that originally wrote the data to HealthKit. |
intermediary_source |
string
|
The name of the library technology used to create the record
(eg "ValidicMobile Bluetooth", "ValidicMobile Apple Health"). |
device |
string
|
The model number of the peripheral, for records sourced from HealthKit this will be
the bundle ID of the application that originally wrote the data to HealthKit. |
last_updated |
string
|
Date and time when the measurement set was last updated. |
validated |
boolean
|
Indicates the data you are receiving was generated using a device,
opposed to being manually entered by a end user. |
_id |
string
|
Record ID. Assigned after being upload to the server. |
extras |
Object
|
Map of additional extra information. |
media |
Object
|
Object containing URL to image associated with this record if any. |
- Source:
RoutineRecord
Subtype of
Record. Adds the following additional properties
Type:
Properties:
Name |
Type |
Description |
steps |
number
|
Number of steps taken during routine. |
distance |
number
|
The value of the measured quantity in meters. |
floors |
number
|
The value of the measured quantity. |
elevation |
number
|
Elevation climbed in meters. |
calories_burned |
number
|
Calories burned during fitness activity. |
- Source:
SHealthErrorHandler()
SHealth error function
Properties:
Name |
Type |
Description |
error |
SHealthError
|
The error returned by SHealth |
- Source:
SHealthHandlers
SHealth listeners for successful events
Properties:
- 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:
WeightRecord
Subtype of
Record. Adds the following additional properties
Type:
Properties:
Name |
Type |
Description |
weight |
number
|
The value of the measured quantity in kg. |
height |
number
|
The value of the measured quantity in cm. |
free_mass |
number
|
The value of the measured quantity in kg. |
fat_percent |
number
|
The value of the measured quantity. |
mass_weight |
number
|
The value of the measured quantity. |
bmi |
number
|
The value of the measured quantity. |
- Source: