README.md 32 KB
Newer Older
Terrillo Walls's avatar
Terrillo Walls committed
1 2
# React Native Apple Healthkit
A React Native bridge module for interacting with [Apple Healthkit] data.
Greg Wilson's avatar
Greg Wilson committed
3

Greg Wilson's avatar
Greg Wilson committed
4
## Table of Contents
Greg Wilson's avatar
Greg Wilson committed
5
  * [Getting Started](#getting-started)
Greg Wilson's avatar
Greg Wilson committed
6
    * [Installation](#installation)
Greg Wilson's avatar
Greg Wilson committed
7 8 9 10
    * [Usage](#usage)
  * [Documentation](#documentation)
    * [Permissions](#permissions)
    * [Methods](#methods)
Greg Wilson's avatar
Greg Wilson committed
11
      * [isAvailable](#isavailable)
Terrillo Walls's avatar
Terrillo Walls committed
12
      * [initHealthkit](#initHealthkit)
Greg Wilson's avatar
Greg Wilson committed
13 14
      * [getBiologicalSex](#getbiologicalsex)
      * [getDateOfBirth](#getdateofbirth)
Greg Wilson's avatar
Greg Wilson committed
15
      * [getStepCount](#getstepcount)
Greg Wilson's avatar
Greg Wilson committed
16
      * [getDailyStepCountSamples](#getdailystepcountsamples)
17
      * [initStepCountObserver](#initstepcountobserver)
Greg Wilson's avatar
Greg Wilson committed
18
      * [saveSteps](#savesteps)
Greg Wilson's avatar
Greg Wilson committed
19 20 21
      * [getDistanceWalkingRunning](#getdistancewalkingrunning)
      * [getDistanceCycling](#getdistancecycling)
      * [getFlightsClimbed](#getflightsclimbed)
Greg Wilson's avatar
Greg Wilson committed
22
      * [getLatestWeight](#getlatestweight)
Greg Wilson's avatar
Greg Wilson committed
23
      * [getWeightSamples](#getweightsamples)
Greg Wilson's avatar
Greg Wilson committed
24 25
      * [saveWeight](#saveweight)
      * [getLatestHeight](#getlatestheight)
Greg Wilson's avatar
Greg Wilson committed
26
      * [getHeightSamples](#getheightsamples)
Greg Wilson's avatar
Greg Wilson committed
27 28 29 30 31
      * [saveHeight](#saveheight)
      * [getLatestBmi](#getlatestbmi)
      * [saveBmi](#savebmi)
      * [getLatestBodyFatPercentage](#getlatestbodyfatpercentage)
      * [getLatestLeanBodyMass](#getlatestleanbodymass)
Daniele Volpi's avatar
Daniele Volpi committed
32 33 34 35 36
      * [getHeartRateSamples](#getheartratesamples)
      * [getBodyTemperatureSamples](#getbodytemperaturesamples)
      * [getBloodPressureSamples](#getbloodpressuresamples)
      * [getRespiratoryRateSamples](#getrespiratoryratesamples)
      * [getBloodGlucoseSamples](#getbloodglucosesamples)
37
      * [getSleepSamples](#getsleepsamples)
skleest's avatar
skleest committed
38
      * [saveMindfulSession](#saveMindfulSession)
39

Terrillo Walls's avatar
Terrillo Walls committed
40
## References
Terrillo Walls's avatar
Terrillo Walls committed
41
- Apple Healthkit Documentation [https://developer.apple.com/Healthkit/](https://developer.apple.com/Healthkit/)
Greg Wilson's avatar
Greg Wilson committed
42

Greg Wilson's avatar
Greg Wilson committed
43 44
## Getting started

Greg Wilson's avatar
Greg Wilson committed
45 46
###  Installation

Terrillo Walls's avatar
Terrillo Walls committed
47
Install the [rn-apple-Healthkit] package from npm:
Greg Wilson's avatar
Greg Wilson committed
48

Terrillo Walls's avatar
Terrillo Walls committed
49 50
- Run `npm install rn-apple-healthkit --save`
- Run `react-native link rn-apple-Healthkit`
Greg Wilson's avatar
Greg Wilson committed
51

Terrillo Walls's avatar
Terrillo Walls committed
52 53 54 55 56 57 58
Update `info.plist` in your React Native project
```
<key>NSHealthShareUsageDescription</key>
<string>Read and understand health data.</string>
<key>NSHealthUpdateUsageDescription</key>
<string>Share workout data with other apps.</string>
```
59

Terrillo Walls's avatar
Terrillo Walls committed
60
### Manual Installation
Greg Wilson's avatar
Greg Wilson committed
61

Terrillo Walls's avatar
Terrillo Walls committed
62 63 64 65 66 67 68 69
1. Run `npm install rn-apple-healthkit --save`
2. In XCode, in the project navigator, right click `Libraries``Add Files to [your project's name]`
3. Go to `node_modules``rn-apple-Healthkit` and add `RCTAppleHealthkit.xcodeproj`
4. In XCode, in the project navigator, select your project. Add `libRCTAppleHealthkit.a` to your project's `Build Phases``Link Binary With Libraries`
5. Click `RCTAppleHealthkit.xcodeproj` in the project navigator and go the `Build Settings` tab. Make sure 'All' is toggled on (instead of 'Basic'). In the `Search Paths` section, look for `Header Search Paths` and make sure it contains both `$(SRCROOT)/../../react-native/React` and `$(SRCROOT)/../../../React` - mark both as `recursive`.
6. Enable Healthkit in your application's `Capabilities`
![Alt text](/examples/images/Capabilities_Healthkit.png "Xcode Capabilities Section")
7. Compile and run
Greg Wilson's avatar
Greg Wilson committed
70

Greg Wilson's avatar
Greg Wilson committed
71
### Usage
Greg Wilson's avatar
Greg Wilson committed
72

Terrillo Walls's avatar
Terrillo Walls committed
73
Just `import` the `rn-apple-Healthkit` module and you're ready to go!
Terrillo Walls's avatar
Terrillo Walls committed
74

Greg Wilson's avatar
Greg Wilson committed
75
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
76
import AppleHealthkit from 'rn-apple-Healthkit';
Greg Wilson's avatar
Greg Wilson committed
77

Greg Wilson's avatar
Greg Wilson committed
78
let options = {
Greg Wilson's avatar
Greg Wilson committed
79
    permissions: {
Greg Wilson's avatar
Greg Wilson committed
80 81
        read: ["Height", "Weight", "StepCount", "DateOfBirth", "BodyMassIndex"],
        write: ["Weight", "StepCount", "BodyMassIndex"]
Greg Wilson's avatar
Greg Wilson committed
82 83 84
    }
};

Terrillo Walls's avatar
Terrillo Walls committed
85 86 87
AppleHealthkit.initHealthkit(options: Object, (err: Object, results: Object) => {
    if (err) {
        console.log("error initializing Healthkit: ", err);
Greg Wilson's avatar
Greg Wilson committed
88 89
        return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
90
    // Healthkit initialized...
Greg Wilson's avatar
Greg Wilson committed
91 92 93 94 95
});


```

Terrillo Walls's avatar
Terrillo Walls committed
96
When the module has been successfully initialized you can read and write Healthkit data
Greg Wilson's avatar
Greg Wilson committed
97 98

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
99
import AppleHealthkit from 'rn-apple-Healthkit';
Greg Wilson's avatar
Greg Wilson committed
100

Terrillo Walls's avatar
Terrillo Walls committed
101
AppleHealthkit.initHealthkit(null: Object, (err: string, results: Object) => {
Greg Wilson's avatar
Greg Wilson committed
102

Terrillo Walls's avatar
Terrillo Walls committed
103
  ...
Greg Wilson's avatar
Greg Wilson committed
104

Terrillo Walls's avatar
Terrillo Walls committed
105
  AppleHealthkit.getLatestWeight(null, (err: Object, weight: Object) => {
Terrillo Walls's avatar
Terrillo Walls committed
106 107 108 109
      if(err){
          console.log("error getting current weight: ", err);
          return;
      }
Terrillo Walls's avatar
Terrillo Walls committed
110
      // use weight.value
Terrillo Walls's avatar
Terrillo Walls committed
111 112 113 114
  });

  ...

Terrillo Walls's avatar
Terrillo Walls committed
115 116 117 118
  let options = {
    value: 200
  };
  AppleHealthkit.saveWeight(options: Object, (err: Object, results: Object) => {
Terrillo Walls's avatar
Terrillo Walls committed
119
      if (err) {
Terrillo Walls's avatar
Terrillo Walls committed
120
          console.log("error saving weight to Healthkit: ", err);
Terrillo Walls's avatar
Terrillo Walls committed
121 122 123 124 125 126
          return;
      }
      // weight successfully saved
  });

}
Greg Wilson's avatar
Greg Wilson committed
127 128 129


```
Greg Wilson's avatar
Greg Wilson committed
130 131


Greg Wilson's avatar
Greg Wilson committed
132 133
## Documentation

Terrillo Walls's avatar
Terrillo Walls committed
134
### Permissions
Greg Wilson's avatar
Greg Wilson committed
135

Terrillo Walls's avatar
Terrillo Walls committed
136
The available Healthkit permissions to use with `initHealthkit`
Greg Wilson's avatar
Greg Wilson committed
137

Terrillo Walls's avatar
Terrillo Walls committed
138
| Permission             | Healthkit Identifier Type                                                                                                                                      | Read | Write |
Greg Wilson's avatar
Greg Wilson committed
139
|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|------|-------|
Terrillo Walls's avatar
Terrillo Walls committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
| ActiveEnergyBurned     | [HKQuantityTypeIdentifierActiveEnergyBurned](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifieractiveenergyburned?language=objc)         | ✓    | ✓     |
| AppleExerciseTime      | [HKQuantityTypeIdentifierAppleExerciseTime](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierappleexercisetime?language=objc)           | ✓    |       |
| BasalEnergyBurned      | [HKQuantityTypeIdentifierBasalEnergyBurned](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierbasalenergyburned?language=objc)           | ✓    | ✓     |
| BiologicalSex          | [HKCharacteristicTypeIdentifierBiologicalSex](https://developer.apple.com/reference/Healthkit/hkcharacteristictypeidentifierbiologicalsex?language=objc)       | ✓    |       |
| BloodGlucose           | [HKQuantityTypeIdentifierBloodGlucose](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierbloodglucose?language=objc)                     | ✓    |       |
| BodyMassIndex          | [HKQuantityTypeIdentifierBodyMassIndex](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierbodymassindex?language=objc)                   | ✓    | ✓     |
| BodyTemperature        | [HKQuantityTypeIdentifierBodyTemperature](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierbodytemperature?language=objc)               | ✓    |       |
| DateOfBirth            | [HKCharacteristicTypeIdentifierDateOfBirth](https://developer.apple.com/reference/Healthkit/hkcharacteristictypeidentifierdateofbirth?language=objc)           | ✓    |       |
| DietaryEnergy          | [HKQuantityTypeIdentifierDietaryEnergyConsumed](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierdietaryenergyconsumed?language=objc)   | ✓    | ✓     |
| DistanceCycling        | [HKQuantityTypeIdentifierDistanceCycling](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierdistancecycling?language=objc)               | ✓    | ✓     |
| DistanceWalkingRunning | [HKQuantityTypeIdentifierDistanceWalkingRunning](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierdistancewalkingrunning?language=objc) | ✓    | ✓     |
| FlightsClimbed         | [HKQuantityTypeIdentifierFlightsClimbed](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierflightsclimbed?language=objc)                 | ✓    | ✓     |
| HeartRate              | [HKQuantityTypeIdentifierHeartRate](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierheartrate?language=objc)                           | ✓    |       |
| Height                 | [HKQuantityTypeIdentifierHeight](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierheight?language=objc)                                 | ✓    | ✓     |
| LeanBodyMass           | [HKQuantityTypeIdentifierLeanBodyMass](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierleanbodymass?language=objc)                     | ✓    | ✓     |
Terrillo Walls's avatar
Terrillo Walls committed
155
| MindfulSession         | [HKCategoryTypeIdentifierMindfulSession](https://developer.apple.com/reference/healthkit/hkcategorytypeidentifiermindfulsession?language=objc)                 |      |  ✓    |
Terrillo Walls's avatar
Terrillo Walls committed
156 157 158 159 160 161 162 163
| NikeFuel               | [HKQuantityTypeIdentifierNikeFuel](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifiernikefuel?language=objc)                             | ✓    |       |
| RespiratoryRate        | [HKQuantityTypeIdentifierRespiratoryRate](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierrespiratoryrate?language=objc)               | ✓    |       |
| SleepAnalysis          | [HKCategoryTypeIdentifierSleepAnalysis](https://developer.apple.com/reference/Healthkit/hkcategorytypeidentifiersleepanalysis?language=objc)                   | ✓    |       |
| StepCount              | [HKQuantityTypeIdentifierStepCount](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierstepcount?language=objc)                           | ✓    | ✓     |
| Steps                  | [HKQuantityTypeIdentifierSteps](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifiersteps?language=objc)                                   | ✓    | ✓     |
| Weight                 | [HKQuantityTypeIdentifierBodyMass](https://developer.apple.com/reference/Healthkit/hkquantitytypeidentifierbodymass?language=objc)                             | ✓    | ✓     |

These permissions are exported as constants of the `rn-apple-Healthkit` module.
Greg Wilson's avatar
Greg Wilson committed
164 165 166 167 168 169 170 171 172

```javascript
import AppleHealthKit from 'react-native-apple-healthkit';

...

// get the available permissions from AppleHealthKit.Constants object
const PERMS = AppleHealthKit.Constants.Permissions;

Greg Wilson's avatar
Greg Wilson committed
173
// setup healthkit read/write permissions using PERMS
Greg Wilson's avatar
Greg Wilson committed
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
const healthKitOptions = {
    permissions: {
        read:  [
            PERMS.StepCount,
            PERMS.Height,
        ],
        write: [
            PERMS.StepCount
        ],
    }
};

...
```

Greg Wilson's avatar
Greg Wilson committed
189

Greg Wilson's avatar
Greg Wilson committed
190 191
Options
-------
Greg Wilson's avatar
Greg Wilson committed
192

193
#### **`isAvailable`**
Terrillo Walls's avatar
Terrillo Walls committed
194
Check if Healthkit is available on the device.
Greg Wilson's avatar
Greg Wilson committed
195
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
196
import AppleHealthkit from 'rn-apple-Healthkit';
Terrillo Walls's avatar
Terrillo Walls committed
197

Terrillo Walls's avatar
Terrillo Walls committed
198 199
AppleHealthkit.isAvailable((err: Object, available: boolean) => {
    if (available) {
Greg Wilson's avatar
Greg Wilson committed
200 201 202 203
        // ...
    }
});
```
Greg Wilson's avatar
Greg Wilson committed
204
___
Greg Wilson's avatar
Greg Wilson committed
205

Terrillo Walls's avatar
Terrillo Walls committed
206 207
#### **`initHealthkit`**
Initialize Healthkit. This will show the Healthkit permissions prompt for any read/write permissions set in the required `options` object.
Greg Wilson's avatar
Greg Wilson committed
208

209
Due to Apple's privacy model if an app user has previously denied a specific permission then they can not be prompted again for that same permission. The app user would have to go into the Apple Health app and grant the permission to your react-native app under *sources* tab.
Greg Wilson's avatar
Greg Wilson committed
210

Terrillo Walls's avatar
Terrillo Walls committed
211
For any data that is read from Healthkit the status/error is the same for both. This privacy restriction results in having no knowledge of whether the permission was denied (make sure it's added to the permissions options object), or the data for the specific request was nil (ex. no steps recorded today).
Greg Wilson's avatar
Greg Wilson committed
212

Terrillo Walls's avatar
Terrillo Walls committed
213
For any data written to Healthkit an authorization error can be caught. If an authorization error occurs you can prompt the user to set the specific permission or add the permission to the options object if not present.
Greg Wilson's avatar
Greg Wilson committed
214

Terrillo Walls's avatar
Terrillo Walls committed
215
If new read/write permissions are added to the options object then the app user will see the Healthkit permissions prompt with the new permissions to allow.
Greg Wilson's avatar
Greg Wilson committed
216

Terrillo Walls's avatar
Terrillo Walls committed
217
`initHealthkit` requires an options object with Healthkit permission settings
Greg Wilson's avatar
Greg Wilson committed
218
```javascript
Greg Wilson's avatar
Greg Wilson committed
219
let options = {
Greg Wilson's avatar
Greg Wilson committed
220
    permissions: {
Greg Wilson's avatar
Greg Wilson committed
221 222
        read: ["Height", "Weight", "StepCount", "DateOfBirth", "BodyMassIndex"],
        write: ["Weight", "StepCount", "BodyMassIndex"]
Greg Wilson's avatar
Greg Wilson committed
223 224
    }
};
Greg Wilson's avatar
Greg Wilson committed
225
```
Greg Wilson's avatar
Greg Wilson committed
226

Greg Wilson's avatar
Greg Wilson committed
227
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
228
AppleHealthkit.initHealthkit(options: Object, (err: string, results: Object) => {
Terrillo Walls's avatar
Terrillo Walls committed
229
    if (err) {
Terrillo Walls's avatar
Terrillo Walls committed
230
        console.log("error initializing Healthkit: ", err);
Greg Wilson's avatar
Greg Wilson committed
231 232
        return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
233 234
    // Healthkit is initialized...
    // now safe to read and write Healthkit data...
Greg Wilson's avatar
Greg Wilson committed
235 236 237
});
```

Greg Wilson's avatar
Greg Wilson committed
238 239
___

Greg Wilson's avatar
Greg Wilson committed
240
#### **`getBiologicalSex`**
Greg Wilson's avatar
Greg Wilson committed
241
Get the biological sex (gender). If the `BiologicalSex` read permission is missing or the user has denied it then the value will be `unknown`. The possible values are:
Greg Wilson's avatar
Greg Wilson committed
242

Greg Wilson's avatar
Greg Wilson committed
243 244 245 246 247 248 249 250
| Value   | HKBiologicalSex       |
|---------|-----------------------|
| unknown | HKBiologicalSexNotSet |
| male    | HKBiologicalSexMale   |
| female  | HKBiologicalSexFemale |
| other   | HKBiologicalSexOther  |

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
251 252 253
AppleHealthkit.getBiologicalSex(null, (err: Object, results: Object) => {
    if (this._handleHealthkitError(err, 'getBiologicalSex')) {
      return;
Greg Wilson's avatar
Greg Wilson committed
254
    }
Terrillo Walls's avatar
Terrillo Walls committed
255
    console.log(results)
Greg Wilson's avatar
Greg Wilson committed
256 257 258
});
```

Terrillo Walls's avatar
Terrillo Walls committed
259 260 261 262 263 264
```javascript
{
	value: 'female',
}
```

Greg Wilson's avatar
Greg Wilson committed
265 266
___

Greg Wilson's avatar
Greg Wilson committed
267
#### **`getDateOfBirth`**
268
Get the date of birth.
Greg Wilson's avatar
Greg Wilson committed
269

Greg Wilson's avatar
Greg Wilson committed
270
On success, the callback function will be provided with a `res` object containing dob `value: string` (ISO timestamp), and `age: number` (age in years):
Terrillo Walls's avatar
Terrillo Walls committed
271 272 273 274 275 276 277 278 279
```javascript
AppleHealthkit.getDateOfBirth(null, (err: Object, results: Object) => {
    if (this._handleHealthkitError(err, 'getDateOfBirth')) {
        return;
    }
    console.log(results)
});
```

Greg Wilson's avatar
Greg Wilson committed
280
```javascript
281 282 283
{
	value: '1986-09-01T00:00:00.000-0400',
	age: 29
284 285 286
}
```

Greg Wilson's avatar
Greg Wilson committed
287 288
___

Greg Wilson's avatar
Greg Wilson committed
289
#### **`getStepCount`**
290
Get the aggregated total steps for a specific day (starting and ending at midnight).
Greg Wilson's avatar
Greg Wilson committed
291

292
An optional options object may be provided containing `date` field representing the selected day. If `date` is not set or an options object is not provided then the current day will be used.
Greg Wilson's avatar
Greg Wilson committed
293
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
294
let d = new Date(2016,1,1);
Greg Wilson's avatar
Greg Wilson committed
295 296 297 298 299
let options = {
    date: d.toISOString()
};
```

Greg Wilson's avatar
Greg Wilson committed
300
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
301 302
AppleHealthkit.getStepCount(options: Object, (err: Object, results: Object) => {
    if (this._handleHealthkitError(err, 'getStepCount')) {
Greg Wilson's avatar
Greg Wilson committed
303 304
        return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
305
    console.log(results)
Greg Wilson's avatar
Greg Wilson committed
306 307 308
});
```

Terrillo Walls's avatar
Terrillo Walls committed
309 310 311 312 313 314
```javascript
{
	value: 213,
}
```

Greg Wilson's avatar
Greg Wilson committed
315 316
___

Greg Wilson's avatar
Greg Wilson committed
317
#### **`getDailyStepCountSamples`**
318
Get the total steps per day over a specified date range.
Greg Wilson's avatar
Greg Wilson committed
319

Greg Wilson's avatar
Greg Wilson committed
320
`getDailyStepCountSamples` accepts an options object containing required *`startDate: ISO8601Timestamp`* and optional *`endDate: ISO8601Timestamp`*. If `endDate` is not provided it will default to the current time
Greg Wilson's avatar
Greg Wilson committed
321 322
```javascript
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
323 324
    startDate: (new Date(2016,1,1)).toISOString() // required
    endDate:   (new Date()).toISOString() // optional; default now
Greg Wilson's avatar
Greg Wilson committed
325 326
};
```
Terrillo Walls's avatar
Terrillo Walls committed
327 328 329 330 331 332 333 334 335 336

```javascript
 AppleHealthkit.getDailyStepCountSamples(options: Object, (err: Object, results: Array<Object>) => {
    if (this._handleHealthkitError(err, 'getDailyStepCountSamples')) {
        return;
    }
    console.log(results)
});
```

Greg Wilson's avatar
Greg Wilson committed
337
The function will be called with an array of elements. Each element is an object containing `value`, `startDate`, and `endDate` fields:
Greg Wilson's avatar
Greg Wilson committed
338
```javascript
339
[
Greg Wilson's avatar
Greg Wilson committed
340 341 342 343 344 345
  { value: 8, startDate: '2016-07-09T00:00:00.000-0400', endDate: '2016-07-10T00:00:00.000-0400' },
  { value: 1923, startDate: '2016-07-08T00:00:00.000-0400', endDate: '2016-07-09T00:00:00.000-0400' },
  { value: 1802, startDate: '2016-07-07T00:00:00.000-0400', endDate: '2016-07-08T00:00:00.000-0400' },
]
```

Greg Wilson's avatar
Greg Wilson committed
346 347
___

348 349 350
#### **`initStepCountObserver`**
Setup an HKObserverQuery for step count (HKQuantityTypeIdentifierStepCount) that will
trigger an event listenable on react-native `NativeAppEventEmitter` when the
Terrillo Walls's avatar
Terrillo Walls committed
351
Healthkit step count has changed.
Greg Wilson's avatar
Greg Wilson committed
352

353 354 355 356 357
The `initStepCountObserver` method must be called before adding a listener to
NativeAppEventEmitter. After the step count observer has been initialized you can
listen to the NativeAppEventEmitter `change:steps` event and re-fetch relevent
step count data in the event handler.

Terrillo Walls's avatar
Terrillo Walls committed
358 359
The `initStepCountObserver` method should be called after Healthkit has been
successfully initialized (AppleHealthkit.initHealthkit has been called without
360
error).
361 362

```javascript
363 364 365 366 367 368
// import NativeAppEventEmitter from react-native
import {
  Navigator,
  View,
  NativeAppEventEmitter,
} from 'react-native';
Terrillo Walls's avatar
Terrillo Walls committed
369
```
370 371


Terrillo Walls's avatar
Terrillo Walls committed
372 373 374
```javascript
AppleHealthkit.initHealthkit(HKOPTIONS, (err, res) => {
  if (this._handleHKError(err, 'initHealthkit')) {
375 376 377 378
    return;
  }

  // initialize the step count observer
Terrillo Walls's avatar
Terrillo Walls committed
379
  AppleHealthkit.initStepCountObserver({}, () => {});
380 381 382 383 384 385 386 387 388 389 390 391 392

  // add event listener for 'change:steps' and handle the
  // event in the event handler function.
  //
  // when adding a listener, a 'subscription' object is
  // returned that must be used to remove the listener
  // when the component unmounts. The subscription object
  // must be accessible to any function/method/instance
  // that will be unsubscribing from the event.
  this.sub = NativeAppEventEmitter.addListener(
    'change:steps',
    (evt) => {
      // a 'change:steps' event has been received. step
Terrillo Walls's avatar
Terrillo Walls committed
393
      // count data should be re-fetched from Healthkit.
394
      this._fetchStepCountData();
395
    }
396
  );
Greg Wilson's avatar
Greg Wilson committed
397

Terrillo Walls's avatar
Terrillo Walls committed
398 399
  // other tasks to perform after Healthkit has been
  // initialized (fetch relevant Healthkit data).
Greg Wilson's avatar
Greg Wilson committed
400
  this._fetchStepCountData();
Terrillo Walls's avatar
Terrillo Walls committed
401
  this._fetchOtherRelevantHealthkitData();
Greg Wilson's avatar
Greg Wilson committed
402
  // ...
403
});
404 405 406 407 408

...

// when the component where the listener was added unmounts
// (or whenever the listener should be removed), call the
Greg Wilson's avatar
Greg Wilson committed
409
// 'remove' method of the subscription object.
410 411 412
componentWillUnmount() {
  this.sub.remove();
}
413 414 415 416
```

___

Greg Wilson's avatar
Greg Wilson committed
417
#### **`saveSteps`**
Greg Wilson's avatar
Greg Wilson committed
418
Save a step count sample.
Greg Wilson's avatar
Greg Wilson committed
419

Greg Wilson's avatar
Greg Wilson committed
420
A step count sample represents the number of steps during a specific period of time. A sample should be a precise as possible, with startDate and endDate representing the range of time the steps were taken in.
Greg Wilson's avatar
Greg Wilson committed
421 422 423

`saveSteps` accepts an options object containing required *`value: number`*, *`startDate: ISO8601Timestamp`*, and *`endDate: ISO8601Timestamp`*.
```javascript
424
// startDate and endDate are 30 minutes apart.
Terrillo Walls's avatar
Terrillo Walls committed
425
// this means the step count value occurred within those 30 minutes.
Greg Wilson's avatar
Greg Wilson committed
426
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
427 428 429
  value: 100,
  startDate: (new Date(2016,6,2,6,0,0)).toISOString(),
  endDate: (new Date(2016,6,2,6,30,0)).toISOString()
Greg Wilson's avatar
Greg Wilson committed
430 431 432 433
};
```

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
434 435 436 437 438
AppleHealthkit.saveSteps(options, (err, res) => {
  if (this._handleHKError(err, 'saveSteps')) {
    return;
  }
  // step count sample successfully saved
Greg Wilson's avatar
Greg Wilson committed
439 440 441 442 443
});
```

___

Greg Wilson's avatar
Greg Wilson committed
444
#### **`getDistanceWalkingRunning`**
445
Get the total distance walking/running on a specific day.
Greg Wilson's avatar
Greg Wilson committed
446

Greg Wilson's avatar
Greg Wilson committed
447
`getDistanceWalkingRunning` accepts an options object containing optional *`date: ISO8601Timestamp`* and *`unit: string`*. If `date` is not provided it will default to the current time. `unit` defaults to `meter`.
448

Greg Wilson's avatar
Greg Wilson committed
449 450
```javascript
let options = {
451 452
  unit: 'mile', // optional; default 'meter'
  date: (new Date(2016,5,1)).toISOString(), // optional; default now
Greg Wilson's avatar
Greg Wilson committed
453
};
Terrillo Walls's avatar
Terrillo Walls committed
454
```
Greg Wilson's avatar
Greg Wilson committed
455

Terrillo Walls's avatar
Terrillo Walls committed
456 457 458
```javascript
AppleHealthkit.getDistanceWalkingRunning(options: Object, (err: Object, results: Object) => {
    if (this._handleHKError(err, 'getDistanceWalkingRunning')) {
Greg Wilson's avatar
Greg Wilson committed
459 460
    	return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
461
    console.log(results)
Greg Wilson's avatar
Greg Wilson committed
462 463 464
});
```

465 466
```javascript
{
Terrillo Walls's avatar
Terrillo Walls committed
467
	value: 1.45,
468 469 470 471 472
	startDate: '2016-07-08T12:00:00.000-0400',
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Greg Wilson's avatar
Greg Wilson committed
473 474 475
___

#### **`getDistanceCycling`**
476
Get the total distance cycling on a specific day.
Greg Wilson's avatar
Greg Wilson committed
477

Greg Wilson's avatar
Greg Wilson committed
478
`getDistanceCycling` accepts an options object containing optional *`date: ISO8601Timestamp`* and *`unit: string`*. If `date` is not provided it will default to the current time. `unit` defaults to `meter`
Greg Wilson's avatar
Greg Wilson committed
479 480
```javascript
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
481 482
  unit: 'mile', // optional; default 'meter'
  date: (new Date(2016,5,1)).toISOString(), // optional; default now
Greg Wilson's avatar
Greg Wilson committed
483 484 485 486
};
```

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
487 488
AppleHealthkit.getDistanceCycling(options: Object, (err: Object, results: Object) => {
    if (err) {
Greg Wilson's avatar
Greg Wilson committed
489 490
    	return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
491
    console.log(results)
Greg Wilson's avatar
Greg Wilson committed
492 493 494
});
```

Terrillo Walls's avatar
Terrillo Walls committed
495 496 497 498 499 500 501 502
```javascript
{
	value: 11.45,
	startDate: '2016-07-08T12:00:00.000-0400',
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Greg Wilson's avatar
Greg Wilson committed
503 504 505
___

#### **`getFlightsClimbed`**
506
get the total flights climbed (1 flight is ~10ft of elevation) on a specific day.
Greg Wilson's avatar
Greg Wilson committed
507 508 509 510

`getFlightsClimbed` accepts an options object containing optional *`date: ISO8601Timestamp`*. if `date` is not provided it will default to the current time.
```javascript
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
511
    date: (new Date(2016,5,1)).toISOString(), // optional; default now
Greg Wilson's avatar
Greg Wilson committed
512 513 514 515
};
```

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
516 517 518 519 520
AppleHealthkit.getFlightsClimbed(options: Object, (err: Object, results: Object) => {
  if (err) {
    return;
  }
  console.log(results)
Greg Wilson's avatar
Greg Wilson committed
521 522 523
});
```

Terrillo Walls's avatar
Terrillo Walls committed
524 525 526 527 528 529 530 531
```javascript
{
	value: 15,
	startDate: '2016-07-08T12:00:00.000-0400',
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Greg Wilson's avatar
Greg Wilson committed
532 533
___

534
#### **`getLatestWeight`**
Greg Wilson's avatar
Greg Wilson committed
535 536
Get the most recent weight sample.

Greg Wilson's avatar
Greg Wilson committed
537
On success, the callback function will be provided with a `weight` object containing the weight `value`, and the `startDate` and `endDate` of the weight sample. *Note: startDate and endDate will be the same as weight samples are saved at a specific point in time.*
Terrillo Walls's avatar
Terrillo Walls committed
538 539

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
540 541 542 543
let options = {
  unit: 'pound'
};
```
Terrillo Walls's avatar
Terrillo Walls committed
544

Terrillo Walls's avatar
Terrillo Walls committed
545 546 547 548 549 550 551
```javascript
AppleHealthkit.getLatestWeight(options, (err: string, results: Object) => {
  if (err) {
    console.log("error getting latest weight: ", err);
    return;
  }
  console.log(results)
Terrillo Walls's avatar
Terrillo Walls committed
552 553 554
});
```

Greg Wilson's avatar
Greg Wilson committed
555 556 557
```javascript
{
	value: 200,
558
	startDate: '2016-07-08T12:00:00.000-0400',
Greg Wilson's avatar
Greg Wilson committed
559 560 561 562
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Greg Wilson's avatar
Greg Wilson committed
563 564
___

Greg Wilson's avatar
Greg Wilson committed
565 566 567 568
#### **`getWeightSamples`**
query for weight samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
569 570 571 572 573
  unit: 'pound', // optional; default 'pound'
  startDate: (new Date(2016,4,27)).toISOString(), // required
  endDate: (new Date()).toISOString(), // optional; default now
  ascending: false,	// optional; default false
  limit:10, // optional; default no limit
Greg Wilson's avatar
Greg Wilson committed
574 575 576 577
};
```

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
578 579 580 581 582
AppleHealthkit.getWeightSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
    return;
  }
  console.log(results)
Greg Wilson's avatar
Greg Wilson committed
583 584 585
});
```

Terrillo Walls's avatar
Terrillo Walls committed
586 587 588 589 590 591 592 593
```javascript
[
  { value: 160, startDate: '2016-07-09T00:00:00.000-0400', endDate: '2016-07-10T00:00:00.000-0400' },
  { value: 161, startDate: '2016-07-08T00:00:00.000-0400', endDate: '2016-07-09T00:00:00.000-0400' },
  { value: 165, startDate: '2016-07-07T00:00:00.000-0400', endDate: '2016-07-08T00:00:00.000-0400' },
]
```

Greg Wilson's avatar
Greg Wilson committed
594 595
___

Greg Wilson's avatar
Greg Wilson committed
596
#### **`saveWeight`**
Terrillo Walls's avatar
Terrillo Walls committed
597
save a numeric weight value to Healthkit
Greg Wilson's avatar
Greg Wilson committed
598

Greg Wilson's avatar
Greg Wilson committed
599
`saveWeight` accepts an options object containing a numeric weight value:
Greg Wilson's avatar
Greg Wilson committed
600
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
601 602 603
let options = {
  value: 200
}
Greg Wilson's avatar
Greg Wilson committed
604
```
Terrillo Walls's avatar
Terrillo Walls committed
605

Greg Wilson's avatar
Greg Wilson committed
606
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
607 608 609
AppleHealthkit.saveWeight(options: Object, (err: Object, results: Object) => {
    if (err) {
        console.log("error saving weight to Healthkit: ", err);
Greg Wilson's avatar
Greg Wilson committed
610 611
        return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
612
    // Done
Greg Wilson's avatar
Greg Wilson committed
613 614
});
```
Greg Wilson's avatar
Greg Wilson committed
615

616 617 618
___

#### **`getLatestHeight`**
Greg Wilson's avatar
Greg Wilson committed
619 620
Get the most recent height value.

Greg Wilson's avatar
Greg Wilson committed
621
On success, the callback function will be provided with a `height` object containing the height `value`, and the `startDate` and `endDate` of the height sample. *Note: startDate and endDate will be the same as height samples are saved at a specific point in time.*
Greg Wilson's avatar
Greg Wilson committed
622 623

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
624 625
AppleHealthkit.getLatestHeight(null, (err: string, results: Object) => {
    if (err) {
626 627 628
        console.log("error getting latest height: ", err);
        return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
629
    console.log(results)
630 631
});
```
Greg Wilson's avatar
Greg Wilson committed
632

Terrillo Walls's avatar
Terrillo Walls committed
633 634 635 636 637 638 639 640
```javascript
{
	value: 72,
	startDate: '2016-07-08T12:00:00.000-0400',
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Greg Wilson's avatar
Greg Wilson committed
641 642
___

Greg Wilson's avatar
Greg Wilson committed
643 644 645 646
#### **`getHeightSamples`**
query for height samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
647 648 649 650 651
  unit: 'inch', // optional; default 'inch'
  startDate: (new Date(2016,4,27)).toISOString(), // required
  endDate: (new Date()).toISOString(), // optional; default now
  ascending: false, // optional; default false
  limit:10, // optional; default no limit
Greg Wilson's avatar
Greg Wilson committed
652 653 654 655
};
```

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
656 657 658 659 660 661
AppleHealthkit.getHeightSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
    return;
  }
  console.log(results)
});
Greg Wilson's avatar
Greg Wilson committed
662
```
Terrillo Walls's avatar
Terrillo Walls committed
663 664

The callback function will be called with a `samples` array containing objects with `value`, `startDate`, and `endDate` fields
Greg Wilson's avatar
Greg Wilson committed
665
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
666 667 668 669
[
	{ value: 74.02, startDate:'2016-06-29T17:55:00.000-0400', endDate:'2016-06-29T17:55:00.000-0400' },
	{ value: 74, startDate:'2016-03-12T13:22:00.000-0400', endDate:'2016-03-12T13:22:00.000-0400' },
]
Greg Wilson's avatar
Greg Wilson committed
670 671 672 673
```

___

Greg Wilson's avatar
Greg Wilson committed
674
#### **`saveHeight`**
Terrillo Walls's avatar
Terrillo Walls committed
675
save a numeric height value to Healthkit
Greg Wilson's avatar
Greg Wilson committed
676 677 678

`saveHeight` accepts an options object containing a numeric height value:
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
679 680 681
let options = {
  value: 200
}
Greg Wilson's avatar
Greg Wilson committed
682
```
Terrillo Walls's avatar
Terrillo Walls committed
683

Greg Wilson's avatar
Greg Wilson committed
684
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
685 686 687 688 689
AppleHealthkit.saveHeight(options: Object, (err: Object, results: Object) => {
  if (err) {
    return;
  }
  // height successfully saved
Greg Wilson's avatar
Greg Wilson committed
690 691 692
});
```

Greg Wilson's avatar
Greg Wilson committed
693 694 695
___

#### **`getLatestBmi`**
696
Get the most recent BMI sample.
Greg Wilson's avatar
Greg Wilson committed
697

Greg Wilson's avatar
Greg Wilson committed
698
On success, the callback function will be provided with a `bmi` object containing the BMI `value`, and the `startDate` and `endDate` of the sample. *Note: startDate and endDate will be the same as bmi samples are saved at a specific point in time.*
Terrillo Walls's avatar
Terrillo Walls committed
699 700 701 702 703 704 705 706 707 708
```javascript
AppleHealthkit.getLatestBmi(null, (err: string, results: Object) => {
    if (err) {
        console.log("error getting latest bmi data: ", err);
        return;
    }
    console.log(results)
});
```

Greg Wilson's avatar
Greg Wilson committed
709 710 711
```javascript
{
	value: 27.2,
712
	startDate: '2016-07-08T12:00:00.000-0400',
Greg Wilson's avatar
Greg Wilson committed
713 714 715 716
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

717 718
___

Greg Wilson's avatar
Greg Wilson committed
719
#### **`saveBmi`**
Terrillo Walls's avatar
Terrillo Walls committed
720
save a numeric BMI value to Healthkit
Greg Wilson's avatar
Greg Wilson committed
721 722 723

`saveBmi` accepts an options object containing a numeric BMI value:
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
724 725 726
let options = {
  value: 27.2
}
Greg Wilson's avatar
Greg Wilson committed
727 728
```
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
729 730 731 732 733
AppleHealthkit.saveBmi(options: Object, (err: Object, results: Object) => {
  if (err) {
    return;
  }
  // BMI successfully saved
Greg Wilson's avatar
Greg Wilson committed
734 735 736 737 738
});
```

___

739
#### **`getLatestBodyFatPercentage`**
Greg Wilson's avatar
Greg Wilson committed
740 741
Get the most recent body fat percentage. The percentage value is a number between 0 and 100.

Greg Wilson's avatar
Greg Wilson committed
742
On success, the callback function will be provided with a `bodyFatPercentage` object containing the body fat percentage `value`, and the `startDate` and `endDate` of the sample. *Note: startDate and endDate will be the same as bodyFatPercentage samples are saved at a specific point in time.*
Terrillo Walls's avatar
Terrillo Walls committed
743 744 745 746 747 748 749 750 751 752

```javascript
AppleHealthkit.getLatestBodyFatPercentage(null, (err: Object, results: Object) => {
  if (err) {
    return;
  }
  console.log(results)
});
```

Greg Wilson's avatar
Greg Wilson committed
753 754 755
```javascript
{
	value: 20,
756
	startDate: '2016-07-08T12:00:00.000-0400',
Greg Wilson's avatar
Greg Wilson committed
757 758 759 760
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Greg Wilson's avatar
Greg Wilson committed
761 762 763
___

#### **`getLatestLeanBodyMass`**
Greg Wilson's avatar
Greg Wilson committed
764 765
Get the most recent lean body mass. The value is a number representing the weight in pounds (lbs)

Greg Wilson's avatar
Greg Wilson committed
766
On success, the callback function will be provided with a `leanBodyMass` object containing the leanBodyMass `value`, and the `startDate` and `endDate` of the sample. *Note: startDate and endDate will be the same as leanBodyMass samples are saved at a specific point in time.*
Terrillo Walls's avatar
Terrillo Walls committed
767 768 769 770 771 772 773 774 775 776

```javascript
 AppleHealthkit.getLatestLeanBodyMass(null, (err: Object, results: Object) => {
  if (err) {
    return;
  }
  console.log(results)
});
```

Greg Wilson's avatar
Greg Wilson committed
777 778 779
```javascript
{
	value: 176,
780
	startDate: '2016-07-08T12:00:00.000-0400',
Greg Wilson's avatar
Greg Wilson committed
781 782 783 784
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Daniele Volpi's avatar
Daniele Volpi committed
785 786 787 788 789 790
___

#### **`getHeartRateSamples`**
query for heart rate samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
791 792 793 794 795
  unit: 'bpm', // optional; default 'bpm'
  startDate: (new Date(2016,4,27)).toISOString(), // required
  endDate: (new Date()).toISOString(), // optional; default now
  ascending: false, // optional; default false
  limit:10, // optional; default no limit
Daniele Volpi's avatar
Daniele Volpi committed
796 797 798 799 800
};
```

the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
801 802 803 804 805
AppleHealthkit.getHeartRateSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
    return;
  }
  console.log(results)
Daniele Volpi's avatar
Daniele Volpi committed
806 807 808
});
```

Terrillo Walls's avatar
Terrillo Walls committed
809 810 811 812 813 814 815
```javascript
[
	{ value: 74.02, startDate:'2016-06-29T17:55:00.000-0400', endDate:'2016-06-29T17:55:00.000-0400' },
	{ value: 74, startDate:'2016-03-12T13:22:00.000-0400', endDate:'2016-03-12T13:22:00.000-0400' },
]
```

Daniele Volpi's avatar
Daniele Volpi committed
816 817 818 819 820 821
___

#### **`getBodyTemperatureSamples`**
query for body temperature samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
822 823 824 825 826
  unit: 'celsius', // optional; default 'celsius'
  startDate: (new Date(2016,4,27)).toISOString(), // required
  endDate: (new Date()).toISOString(), // optional; default now
  ascending: false, // optional; default false
  limit:10,	// optional; default no limit
Daniele Volpi's avatar
Daniele Volpi committed
827 828 829 830 831 832 833
};
```
available units are: `'fahrenheit'`, `'celsius'`.

the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields.

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
834 835
AppleHealthkit.getBodyTemperatureSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
Daniele Volpi's avatar
Daniele Volpi committed
836 837
		return;
	}
Terrillo Walls's avatar
Terrillo Walls committed
838
	console.log(results)
Daniele Volpi's avatar
Daniele Volpi committed
839 840 841
});
```

Terrillo Walls's avatar
Terrillo Walls committed
842 843 844 845 846 847 848
```javascript
[
	{ value: 74.02, startDate:'2016-06-29T17:55:00.000-0400', endDate:'2016-06-29T17:55:00.000-0400' },
	{ value: 74, startDate:'2016-03-12T13:22:00.000-0400', endDate:'2016-03-12T13:22:00.000-0400' },
]
```

Daniele Volpi's avatar
Daniele Volpi committed
849 850 851 852 853 854
___

#### **`getBloodPressureSamples`**
query for blood pressure samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
855 856 857 858 859
  unit: 'mmhg',	// optional; default 'mmhg'
  startDate: (new Date(2016,4,27)).toISOString(), // required
  endDate: (new Date()).toISOString(),	// optional; default now
  ascending: false,	// optional; default false
  limit:10, // optional; default no limit
Daniele Volpi's avatar
Daniele Volpi committed
860 861 862 863
};
```

the callback function will be called with a `samples` array containing objects with *bloodPressureSystolicValue*, *bloodPressureDiastolicValue*, *startDate*, and *endDate* fields
Terrillo Walls's avatar
Terrillo Walls committed
864

Daniele Volpi's avatar
Daniele Volpi committed
865
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
866 867 868 869 870 871
AppleHealthkit.getBloodPressureSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
    return;
  }
  console.log(results)
});
Daniele Volpi's avatar
Daniele Volpi committed
872
```
Terrillo Walls's avatar
Terrillo Walls committed
873

Daniele Volpi's avatar
Daniele Volpi committed
874
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
875 876 877 878
[
  { bloodPressureSystolicValue: 120, bloodPressureDiastolicValue: 81, startDate:'2016-06-29T17:55:00.000-0400', endDate:'2016-06-29T17:55:00.000-0400' },
  { bloodPressureSystolicValue: 119, bloodPressureDiastolicValue: 77, startDate:'2016-03-12T13:22:00.000-0400', endDate:'2016-03-12T13:22:00.000-0400' },
]
Daniele Volpi's avatar
Daniele Volpi committed
879 880
```

Terrillo Walls's avatar
Terrillo Walls committed
881

Daniele Volpi's avatar
Daniele Volpi committed
882 883 884 885 886 887
___

#### **`getRespiratoryRateSamples`**
query for respiratory rate samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
888 889 890 891 892
  unit: 'bpm', // optional; default 'bpm'
  startDate: (new Date(2016,4,27)).toISOString(), // required
  endDate: (new Date()).toISOString(), // optional; default now
  ascending: false, // optional; default false
  limit:10, // optional; default no limit
Daniele Volpi's avatar
Daniele Volpi committed
893 894 895 896 897 898
};
```

the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
899 900 901 902 903
AppleHealthkit.getRespiratoryRateSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
    return;
  }
  console.log(results)
Daniele Volpi's avatar
Daniele Volpi committed
904 905 906 907 908 909 910 911 912
});
```

___

#### **`getBloodGlucoseSamples`**
query for blood glucose samples. the options object is used to setup a query to retrieve relevant samples.
```javascript
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
913 914 915 916 917
  unit: 'mmolPerL',	// optional; default 'mmolPerL'
  startDate: (new Date(2016,4,27)).toISOString(), // required
  endDate: (new Date()).toISOString(), // optional; default now
  ascending: false, // optional; default false
  limit:10,	// optional; default no limit
Daniele Volpi's avatar
Daniele Volpi committed
918 919 920 921 922 923 924
};
```
available units are: `'mmolPerL'`, `'mgPerdL'`.

the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
925 926 927 928 929
AppleHealthkit.getBloodGlucoseSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
    return;
  }
  console.log(results)
Daniele Volpi's avatar
Daniele Volpi committed
930 931 932
});
```

933 934 935 936 937 938 939
___

#### **`getSleepSamples`**
query for sleep samples.

each sleep sample represents a period of time with a startDate and an endDate.
the sample's value will be either `INBED` or `ASLEEP`. these values should overlap,
Greg Wilson's avatar
Greg Wilson committed
940
meaning that two (or more) samples represent a single nights sleep activity. see
Terrillo Walls's avatar
Terrillo Walls committed
941
[Healthkit SleepAnalysis] reference documentation
942 943 944 945 946 947

the options object is used to setup a query to retrieve relevant samples.
the options must contain `startDate` and may also optionally include `endDate`
and `limit` options
```javascript
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
948 949 950
  startDate: (new Date(2016,10,1)).toISOString(), // required
  endDate: (new Date()).toISOString(), // optional; default now
  limit:10, // optional; default no limit
951 952 953
};
```

Terrillo Walls's avatar
Terrillo Walls committed
954
The callback function will be called with a `samples` array containing objects
955 956 957
with *value*, *startDate*, and *endDate* fields

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
958 959 960 961 962
AppleHealthkit.getSleepSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
    return;
  }
  console.log(results).
963 964 965
});
```

skleest's avatar
skleest committed
966 967 968 969 970 971 972
#### **`saveMindfulSession`**

each mindfulness sample represents a period of time with a startDate and an endDate.
the options must contain `startDate` and `endDate`

```javascript
let options = {
973 974
    startDate: (new Date(2016,10,1)).toISOString(), // required
    endDate: (new Date()).toISOString(), // optional; default now
skleest's avatar
skleest committed
975
};
skleest's avatar
skleest committed
976

977 978 979
```

```
skleest's avatar
minor  
skleest committed
980
AppleHealthKit.saveMindfulSession(options, (err, res) => {
981 982 983
  if (err) return {
    return
  }
skleest's avatar
skleest committed
984 985
  console.log('Mindful session saved')
});
skleest's avatar
skleest committed
986
```
Daniele Volpi's avatar
Daniele Volpi committed
987

Terrillo Walls's avatar
Terrillo Walls committed
988
> *This package is fork from [react-native-apple-Healthkit](https://github.com/GregWilson/react-native-apple-Healthkit)*