README.md 30.8 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

Terrillo Walls's avatar
Terrillo Walls committed
4
![Alt text](https://devimages.apple.com.edgekey.net/assets/elements/icons/Healthkit/Healthkit-64x64.png "Apple Healthkit")
Greg Wilson's avatar
Greg Wilson committed
5

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

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

Greg Wilson's avatar
Greg Wilson committed
45 46
## Getting started

Greg Wilson's avatar
Greg Wilson committed
47 48
###  Installation

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

Terrillo Walls's avatar
Terrillo Walls committed
51
`npm install rn-apple-Healthkit --save`
Greg Wilson's avatar
Greg Wilson committed
52

Greg Wilson's avatar
Greg Wilson committed
53
##### Xcode
54

Greg Wilson's avatar
Greg Wilson committed
55
1. In XCode, in the project navigator, right click `Libraries``Add Files to [your project's name]`
Terrillo Walls's avatar
Terrillo Walls committed
56 57 58 59 60
2. Go to `node_modules``rn-apple-Healthkit` and add `RCTAppleHealthkit.xcodeproj`
3. In XCode, in the project navigator, select your project. Add `libRCTAppleHealthkit.a` to your project's `Build Phases``Link Binary With Libraries`
4. 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`.
5. Enable Healthkit in your application's `Capabilities`
![Alt text](/examples/images/Capabilities_Healthkit.png "Xcode Capabilities Section")
Greg Wilson's avatar
Greg Wilson committed
61

Greg Wilson's avatar
Greg Wilson committed
62
6. Compile and run
Greg Wilson's avatar
Greg Wilson committed
63

Greg Wilson's avatar
Greg Wilson committed
64
### Usage
Greg Wilson's avatar
Greg Wilson committed
65

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

Greg Wilson's avatar
Greg Wilson committed
68
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
69
import AppleHealthkit from 'rn-apple-Healthkit';
Greg Wilson's avatar
Greg Wilson committed
70

Greg Wilson's avatar
Greg Wilson committed
71
let options = {
Greg Wilson's avatar
Greg Wilson committed
72
    permissions: {
Greg Wilson's avatar
Greg Wilson committed
73 74
        read: ["Height", "Weight", "StepCount", "DateOfBirth", "BodyMassIndex"],
        write: ["Weight", "StepCount", "BodyMassIndex"]
Greg Wilson's avatar
Greg Wilson committed
75 76 77
    }
};

Terrillo Walls's avatar
Terrillo Walls committed
78 79 80
AppleHealthkit.initHealthkit(options: Object, (err: Object, results: Object) => {
    if (err) {
        console.log("error initializing Healthkit: ", err);
Greg Wilson's avatar
Greg Wilson committed
81 82
        return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
83
    // Healthkit initialized...
Greg Wilson's avatar
Greg Wilson committed
84 85 86 87 88
});


```

Terrillo Walls's avatar
Terrillo Walls committed
89
When the module has been successfully initialized you can read and write Healthkit data
Greg Wilson's avatar
Greg Wilson committed
90 91

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

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

Terrillo Walls's avatar
Terrillo Walls committed
96
  ...
Greg Wilson's avatar
Greg Wilson committed
97

Terrillo Walls's avatar
Terrillo Walls committed
98
  AppleHealthkit.getLatestWeight(null, (err: Object, weight: Object) => {
Terrillo Walls's avatar
Terrillo Walls committed
99 100 101 102
      if(err){
          console.log("error getting current weight: ", err);
          return;
      }
Terrillo Walls's avatar
Terrillo Walls committed
103
      // use weight.value
Terrillo Walls's avatar
Terrillo Walls committed
104 105 106 107
  });

  ...

Terrillo Walls's avatar
Terrillo Walls committed
108 109 110 111
  let options = {
    value: 200
  };
  AppleHealthkit.saveWeight(options: Object, (err: Object, results: Object) => {
Terrillo Walls's avatar
Terrillo Walls committed
112
      if (err) {
Terrillo Walls's avatar
Terrillo Walls committed
113
          console.log("error saving weight to Healthkit: ", err);
Terrillo Walls's avatar
Terrillo Walls committed
114 115 116 117 118 119
          return;
      }
      // weight successfully saved
  });

}
Greg Wilson's avatar
Greg Wilson committed
120 121 122


```
Greg Wilson's avatar
Greg Wilson committed
123 124


Greg Wilson's avatar
Greg Wilson committed
125 126
## Documentation

Terrillo Walls's avatar
Terrillo Walls committed
127
### Permissions
Greg Wilson's avatar
Greg Wilson committed
128

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

Terrillo Walls's avatar
Terrillo Walls committed
131
| Permission             | Healthkit Identifier Type                                                                                                                                      | Read | Write |
Greg Wilson's avatar
Greg Wilson committed
132
|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|------|-------|
Terrillo Walls's avatar
Terrillo Walls committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
| 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)                     | ✓    | ✓     |
| 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
156 157


Terrillo Walls's avatar
Terrillo Walls committed
158
## Methods
Greg Wilson's avatar
Greg Wilson committed
159

160
#### **`isAvailable`**
Terrillo Walls's avatar
Terrillo Walls committed
161
Check if Healthkit is available on the device.
Greg Wilson's avatar
Greg Wilson committed
162
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
163
import AppleHealthkit from 'rn-apple-Healthkit';
Terrillo Walls's avatar
Terrillo Walls committed
164

Terrillo Walls's avatar
Terrillo Walls committed
165 166
AppleHealthkit.isAvailable((err: Object, available: boolean) => {
    if (available) {
Greg Wilson's avatar
Greg Wilson committed
167 168 169 170
        // ...
    }
});
```
Greg Wilson's avatar
Greg Wilson committed
171
___
Greg Wilson's avatar
Greg Wilson committed
172

Terrillo Walls's avatar
Terrillo Walls committed
173 174
#### **`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
175

176
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
177

Terrillo Walls's avatar
Terrillo Walls committed
178
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
179

Terrillo Walls's avatar
Terrillo Walls committed
180
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
181

Terrillo Walls's avatar
Terrillo Walls committed
182
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
183

Terrillo Walls's avatar
Terrillo Walls committed
184
`initHealthkit` requires an options object with Healthkit permission settings
Greg Wilson's avatar
Greg Wilson committed
185
```javascript
Greg Wilson's avatar
Greg Wilson committed
186
let options = {
Greg Wilson's avatar
Greg Wilson committed
187
    permissions: {
Greg Wilson's avatar
Greg Wilson committed
188 189
        read: ["Height", "Weight", "StepCount", "DateOfBirth", "BodyMassIndex"],
        write: ["Weight", "StepCount", "BodyMassIndex"]
Greg Wilson's avatar
Greg Wilson committed
190 191
    }
};
Greg Wilson's avatar
Greg Wilson committed
192
```
Greg Wilson's avatar
Greg Wilson committed
193

Greg Wilson's avatar
Greg Wilson committed
194
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
195
AppleHealthkit.initHealthkit(options: Object, (err: string, results: Object) => {
Terrillo Walls's avatar
Terrillo Walls committed
196
    if (err) {
Terrillo Walls's avatar
Terrillo Walls committed
197
        console.log("error initializing Healthkit: ", err);
Greg Wilson's avatar
Greg Wilson committed
198 199
        return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
200 201
    // Healthkit is initialized...
    // now safe to read and write Healthkit data...
Greg Wilson's avatar
Greg Wilson committed
202 203 204
});
```

Greg Wilson's avatar
Greg Wilson committed
205 206
___

Greg Wilson's avatar
Greg Wilson committed
207
#### **`getBiologicalSex`**
Greg Wilson's avatar
Greg Wilson committed
208
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
209

Greg Wilson's avatar
Greg Wilson committed
210 211 212 213 214 215 216 217
| Value   | HKBiologicalSex       |
|---------|-----------------------|
| unknown | HKBiologicalSexNotSet |
| male    | HKBiologicalSexMale   |
| female  | HKBiologicalSexFemale |
| other   | HKBiologicalSexOther  |

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
218 219 220
AppleHealthkit.getBiologicalSex(null, (err: Object, results: Object) => {
    if (this._handleHealthkitError(err, 'getBiologicalSex')) {
      return;
Greg Wilson's avatar
Greg Wilson committed
221
    }
Terrillo Walls's avatar
Terrillo Walls committed
222
    console.log(results)
Greg Wilson's avatar
Greg Wilson committed
223 224 225
});
```

Terrillo Walls's avatar
Terrillo Walls committed
226 227 228 229 230 231
```javascript
{
	value: 'female',
}
```

Greg Wilson's avatar
Greg Wilson committed
232 233
___

Greg Wilson's avatar
Greg Wilson committed
234
#### **`getDateOfBirth`**
235
Get the date of birth.
Greg Wilson's avatar
Greg Wilson committed
236

Greg Wilson's avatar
Greg Wilson committed
237
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
238 239 240 241 242 243 244 245 246
```javascript
AppleHealthkit.getDateOfBirth(null, (err: Object, results: Object) => {
    if (this._handleHealthkitError(err, 'getDateOfBirth')) {
        return;
    }
    console.log(results)
});
```

Greg Wilson's avatar
Greg Wilson committed
247
```javascript
248 249 250
{
	value: '1986-09-01T00:00:00.000-0400',
	age: 29
251 252 253
}
```

Greg Wilson's avatar
Greg Wilson committed
254 255
___

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

259
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
260
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
261
let d = new Date(2016,1,1);
Greg Wilson's avatar
Greg Wilson committed
262 263 264 265 266
let options = {
    date: d.toISOString()
};
```

Greg Wilson's avatar
Greg Wilson committed
267
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
268 269
AppleHealthkit.getStepCount(options: Object, (err: Object, results: Object) => {
    if (this._handleHealthkitError(err, 'getStepCount')) {
Greg Wilson's avatar
Greg Wilson committed
270 271
        return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
272
    console.log(results)
Greg Wilson's avatar
Greg Wilson committed
273 274 275
});
```

Terrillo Walls's avatar
Terrillo Walls committed
276 277 278 279 280 281
```javascript
{
	value: 213,
}
```

Greg Wilson's avatar
Greg Wilson committed
282 283
___

Greg Wilson's avatar
Greg Wilson committed
284
#### **`getDailyStepCountSamples`**
285
Get the total steps per day over a specified date range.
Greg Wilson's avatar
Greg Wilson committed
286

Greg Wilson's avatar
Greg Wilson committed
287
`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
288 289
```javascript
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
290 291
    startDate: (new Date(2016,1,1)).toISOString() // required
    endDate:   (new Date()).toISOString() // optional; default now
Greg Wilson's avatar
Greg Wilson committed
292 293
};
```
Terrillo Walls's avatar
Terrillo Walls committed
294 295 296 297 298 299 300 301 302 303

```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
304
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
305
```javascript
306
[
Greg Wilson's avatar
Greg Wilson committed
307 308 309 310 311 312
  { 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
313 314
___

315 316 317
#### **`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
318
Healthkit step count has changed.
Greg Wilson's avatar
Greg Wilson committed
319

320 321 322 323 324
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
325 326
The `initStepCountObserver` method should be called after Healthkit has been
successfully initialized (AppleHealthkit.initHealthkit has been called without
327
error).
328 329

```javascript
330 331 332 333 334 335
// import NativeAppEventEmitter from react-native
import {
  Navigator,
  View,
  NativeAppEventEmitter,
} from 'react-native';
Terrillo Walls's avatar
Terrillo Walls committed
336
```
337 338


Terrillo Walls's avatar
Terrillo Walls committed
339 340 341
```javascript
AppleHealthkit.initHealthkit(HKOPTIONS, (err, res) => {
  if (this._handleHKError(err, 'initHealthkit')) {
342 343 344 345
    return;
  }

  // initialize the step count observer
Terrillo Walls's avatar
Terrillo Walls committed
346
  AppleHealthkit.initStepCountObserver({}, () => {});
347 348 349 350 351 352 353 354 355 356 357 358 359

  // 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
360
      // count data should be re-fetched from Healthkit.
361
      this._fetchStepCountData();
362
    }
363
  );
Greg Wilson's avatar
Greg Wilson committed
364

Terrillo Walls's avatar
Terrillo Walls committed
365 366
  // other tasks to perform after Healthkit has been
  // initialized (fetch relevant Healthkit data).
Greg Wilson's avatar
Greg Wilson committed
367
  this._fetchStepCountData();
Terrillo Walls's avatar
Terrillo Walls committed
368
  this._fetchOtherRelevantHealthkitData();
Greg Wilson's avatar
Greg Wilson committed
369
  // ...
370
});
371 372 373 374 375

...

// 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
376
// 'remove' method of the subscription object.
377 378 379
componentWillUnmount() {
  this.sub.remove();
}
380 381 382 383
```

___

Greg Wilson's avatar
Greg Wilson committed
384
#### **`saveSteps`**
Greg Wilson's avatar
Greg Wilson committed
385
Save a step count sample.
Greg Wilson's avatar
Greg Wilson committed
386

Greg Wilson's avatar
Greg Wilson committed
387
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
388 389 390

`saveSteps` accepts an options object containing required *`value: number`*, *`startDate: ISO8601Timestamp`*, and *`endDate: ISO8601Timestamp`*.
```javascript
391
// startDate and endDate are 30 minutes apart.
Terrillo Walls's avatar
Terrillo Walls committed
392
// this means the step count value occurred within those 30 minutes.
Greg Wilson's avatar
Greg Wilson committed
393
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
394 395 396
  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
397 398 399 400
};
```

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
401 402 403 404 405
AppleHealthkit.saveSteps(options, (err, res) => {
  if (this._handleHKError(err, 'saveSteps')) {
    return;
  }
  // step count sample successfully saved
Greg Wilson's avatar
Greg Wilson committed
406 407 408 409 410
});
```

___

Greg Wilson's avatar
Greg Wilson committed
411
#### **`getDistanceWalkingRunning`**
412
Get the total distance walking/running on a specific day.
Greg Wilson's avatar
Greg Wilson committed
413

Greg Wilson's avatar
Greg Wilson committed
414
`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`.
415

Greg Wilson's avatar
Greg Wilson committed
416 417
```javascript
let options = {
418 419
  unit: 'mile', // optional; default 'meter'
  date: (new Date(2016,5,1)).toISOString(), // optional; default now
Greg Wilson's avatar
Greg Wilson committed
420
};
Terrillo Walls's avatar
Terrillo Walls committed
421
```
Greg Wilson's avatar
Greg Wilson committed
422

Terrillo Walls's avatar
Terrillo Walls committed
423 424 425
```javascript
AppleHealthkit.getDistanceWalkingRunning(options: Object, (err: Object, results: Object) => {
    if (this._handleHKError(err, 'getDistanceWalkingRunning')) {
Greg Wilson's avatar
Greg Wilson committed
426 427
    	return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
428
    console.log(results)
Greg Wilson's avatar
Greg Wilson committed
429 430 431
});
```

432 433
```javascript
{
Terrillo Walls's avatar
Terrillo Walls committed
434
	value: 1.45,
435 436 437 438 439
	startDate: '2016-07-08T12:00:00.000-0400',
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Greg Wilson's avatar
Greg Wilson committed
440 441 442
___

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

Greg Wilson's avatar
Greg Wilson committed
445
`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
446 447
```javascript
let options = {
Terrillo Walls's avatar
Terrillo Walls committed
448 449
  unit: 'mile', // optional; default 'meter'
  date: (new Date(2016,5,1)).toISOString(), // optional; default now
Greg Wilson's avatar
Greg Wilson committed
450 451 452 453
};
```

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
454 455
AppleHealthkit.getDistanceCycling(options: Object, (err: Object, results: Object) => {
    if (err) {
Greg Wilson's avatar
Greg Wilson committed
456 457
    	return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
458
    console.log(results)
Greg Wilson's avatar
Greg Wilson committed
459 460 461
});
```

Terrillo Walls's avatar
Terrillo Walls committed
462 463 464 465 466 467 468 469
```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
470 471 472
___

#### **`getFlightsClimbed`**
473
get the total flights climbed (1 flight is ~10ft of elevation) on a specific day.
Greg Wilson's avatar
Greg Wilson committed
474 475 476 477

`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
478
    date: (new Date(2016,5,1)).toISOString(), // optional; default now
Greg Wilson's avatar
Greg Wilson committed
479 480 481 482
};
```

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
483 484 485 486 487
AppleHealthkit.getFlightsClimbed(options: Object, (err: Object, results: Object) => {
  if (err) {
    return;
  }
  console.log(results)
Greg Wilson's avatar
Greg Wilson committed
488 489 490
});
```

Terrillo Walls's avatar
Terrillo Walls committed
491 492 493 494 495 496 497 498
```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
499 500
___

501
#### **`getLatestWeight`**
Greg Wilson's avatar
Greg Wilson committed
502 503
Get the most recent weight sample.

Greg Wilson's avatar
Greg Wilson committed
504
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
505 506

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
507 508 509 510
let options = {
  unit: 'pound'
};
```
Terrillo Walls's avatar
Terrillo Walls committed
511

Terrillo Walls's avatar
Terrillo Walls committed
512 513 514 515 516 517 518
```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
519 520 521
});
```

Greg Wilson's avatar
Greg Wilson committed
522 523 524
```javascript
{
	value: 200,
525
	startDate: '2016-07-08T12:00:00.000-0400',
Greg Wilson's avatar
Greg Wilson committed
526 527 528 529
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Greg Wilson's avatar
Greg Wilson committed
530 531
___

Greg Wilson's avatar
Greg Wilson committed
532 533 534 535
#### **`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
536 537 538 539 540
  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
541 542 543 544
};
```

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
545 546 547 548 549
AppleHealthkit.getWeightSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
    return;
  }
  console.log(results)
Greg Wilson's avatar
Greg Wilson committed
550 551 552
});
```

Terrillo Walls's avatar
Terrillo Walls committed
553 554 555 556 557 558 559 560
```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
561 562
___

Greg Wilson's avatar
Greg Wilson committed
563
#### **`saveWeight`**
Terrillo Walls's avatar
Terrillo Walls committed
564
save a numeric weight value to Healthkit
Greg Wilson's avatar
Greg Wilson committed
565

Greg Wilson's avatar
Greg Wilson committed
566
`saveWeight` accepts an options object containing a numeric weight value:
Greg Wilson's avatar
Greg Wilson committed
567
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
568 569 570
let options = {
  value: 200
}
Greg Wilson's avatar
Greg Wilson committed
571
```
Terrillo Walls's avatar
Terrillo Walls committed
572

Greg Wilson's avatar
Greg Wilson committed
573
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
574 575 576
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
577 578
        return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
579
    // Done
Greg Wilson's avatar
Greg Wilson committed
580 581
});
```
Greg Wilson's avatar
Greg Wilson committed
582

583 584 585
___

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

Greg Wilson's avatar
Greg Wilson committed
588
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
589 590

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
591 592
AppleHealthkit.getLatestHeight(null, (err: string, results: Object) => {
    if (err) {
593 594 595
        console.log("error getting latest height: ", err);
        return;
    }
Terrillo Walls's avatar
Terrillo Walls committed
596
    console.log(results)
597 598
});
```
Greg Wilson's avatar
Greg Wilson committed
599

Terrillo Walls's avatar
Terrillo Walls committed
600 601 602 603 604 605 606 607
```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
608 609
___

Greg Wilson's avatar
Greg Wilson committed
610 611 612 613
#### **`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
614 615 616 617 618
  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
619 620 621 622
};
```

```javascript
Terrillo Walls's avatar
Terrillo Walls committed
623 624 625 626 627 628
AppleHealthkit.getHeightSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
    return;
  }
  console.log(results)
});
Greg Wilson's avatar
Greg Wilson committed
629
```
Terrillo Walls's avatar
Terrillo Walls committed
630 631

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
632
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
633 634 635 636
[
	{ 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
637 638 639 640
```

___

Greg Wilson's avatar
Greg Wilson committed
641
#### **`saveHeight`**
Terrillo Walls's avatar
Terrillo Walls committed
642
save a numeric height value to Healthkit
Greg Wilson's avatar
Greg Wilson committed
643 644 645

`saveHeight` accepts an options object containing a numeric height value:
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
646 647 648
let options = {
  value: 200
}
Greg Wilson's avatar
Greg Wilson committed
649
```
Terrillo Walls's avatar
Terrillo Walls committed
650

Greg Wilson's avatar
Greg Wilson committed
651
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
652 653 654 655 656
AppleHealthkit.saveHeight(options: Object, (err: Object, results: Object) => {
  if (err) {
    return;
  }
  // height successfully saved
Greg Wilson's avatar
Greg Wilson committed
657 658 659
});
```

Greg Wilson's avatar
Greg Wilson committed
660 661 662
___

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

Greg Wilson's avatar
Greg Wilson committed
665
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
666 667 668 669 670 671 672 673 674 675
```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
676 677 678
```javascript
{
	value: 27.2,
679
	startDate: '2016-07-08T12:00:00.000-0400',
Greg Wilson's avatar
Greg Wilson committed
680 681 682 683
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

684 685
___

Greg Wilson's avatar
Greg Wilson committed
686
#### **`saveBmi`**
Terrillo Walls's avatar
Terrillo Walls committed
687
save a numeric BMI value to Healthkit
Greg Wilson's avatar
Greg Wilson committed
688 689 690

`saveBmi` accepts an options object containing a numeric BMI value:
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
691 692 693
let options = {
  value: 27.2
}
Greg Wilson's avatar
Greg Wilson committed
694 695
```
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
696 697 698 699 700
AppleHealthkit.saveBmi(options: Object, (err: Object, results: Object) => {
  if (err) {
    return;
  }
  // BMI successfully saved
Greg Wilson's avatar
Greg Wilson committed
701 702 703 704 705
});
```

___

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

Greg Wilson's avatar
Greg Wilson committed
709
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
710 711 712 713 714 715 716 717 718 719

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

Greg Wilson's avatar
Greg Wilson committed
720 721 722
```javascript
{
	value: 20,
723
	startDate: '2016-07-08T12:00:00.000-0400',
Greg Wilson's avatar
Greg Wilson committed
724 725 726 727
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Greg Wilson's avatar
Greg Wilson committed
728 729 730
___

#### **`getLatestLeanBodyMass`**
Greg Wilson's avatar
Greg Wilson committed
731 732
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
733
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
734 735 736 737 738 739 740 741 742 743

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

Greg Wilson's avatar
Greg Wilson committed
744 745 746
```javascript
{
	value: 176,
747
	startDate: '2016-07-08T12:00:00.000-0400',
Greg Wilson's avatar
Greg Wilson committed
748 749 750 751
	endDate: '2016-07-08T12:00:00.000-0400'
}
```

Daniele Volpi's avatar
Daniele Volpi committed
752 753 754 755 756 757
___

#### **`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
758 759 760 761 762
  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
763 764 765 766 767
};
```

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
768 769 770 771 772
AppleHealthkit.getHeartRateSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
    return;
  }
  console.log(results)
Daniele Volpi's avatar
Daniele Volpi committed
773 774 775
});
```

Terrillo Walls's avatar
Terrillo Walls committed
776 777 778 779 780 781 782
```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
783 784 785 786 787 788
___

#### **`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
789 790 791 792 793
  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
794 795 796 797 798 799 800
};
```
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
801 802
AppleHealthkit.getBodyTemperatureSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
Daniele Volpi's avatar
Daniele Volpi committed
803 804
		return;
	}
Terrillo Walls's avatar
Terrillo Walls committed
805
	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
___

#### **`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
822 823 824 825 826
  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
827 828 829 830
};
```

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
831

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

Daniele Volpi's avatar
Daniele Volpi committed
841
```javascript
Terrillo Walls's avatar
Terrillo Walls committed
842 843 844 845
[
  { 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
846 847
```

Terrillo Walls's avatar
Terrillo Walls committed
848

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

#### **`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
855 856 857 858 859
  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
860 861 862 863 864 865
};
```

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
866 867 868 869 870
AppleHealthkit.getRespiratoryRateSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
    return;
  }
  console.log(results)
Daniele Volpi's avatar
Daniele Volpi committed
871 872 873 874 875 876 877 878 879
});
```

___

#### **`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
880 881 882 883 884
  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
885 886 887 888 889 890 891
};
```
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
892 893 894 895 896
AppleHealthkit.getBloodGlucoseSamples(options, (err: Object, results: Array<Object>) => {
  if (err) {
    return;
  }
  console.log(results)
Daniele Volpi's avatar
Daniele Volpi committed
897 898 899
});
```

900 901 902 903 904 905 906
___

#### **`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
907
meaning that two (or more) samples represent a single nights sleep activity. see
Terrillo Walls's avatar
Terrillo Walls committed
908
[Healthkit SleepAnalysis] reference documentation
909 910 911 912 913 914

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
915 916 917
  startDate: (new Date(2016,10,1)).toISOString(), // required
  endDate: (new Date()).toISOString(), // optional; default now
  limit:10, // optional; default no limit
918 919 920
};
```

Terrillo Walls's avatar
Terrillo Walls committed
921
The callback function will be called with a `samples` array containing objects
922 923 924
with *value*, *startDate*, and *endDate* fields

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

Greg Wilson's avatar
Greg Wilson committed
933
## Examples
Terrillo Walls's avatar
Terrillo Walls committed
934 935
- [Steps Demo](https://github.com/GregWilson/rn-apple-Healthkit/tree/master/examples/StepsDemo)
- [Body Measurements Demo](https://github.com/GregWilson/rn-apple-Healthkit/tree/master/examples/BodyMeasurements)
Greg Wilson's avatar
Greg Wilson committed
936

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