From cab85e17e7cc01cbc3ebf8e74030cfd28efe17d3 Mon Sep 17 00:00:00 2001 From: Terrillo Walls Date: Wed, 6 Sep 2017 12:38:54 -0500 Subject: [PATCH] Readme update --- README.md | 689 +++++++++--------- .../Capabilities_HealthKit.png | Bin {examples/images => images}/IMG_0205.PNG | Bin .../body_measurements_demo_screen.png | Bin .../body_measurements_demo_screenshot.png | Bin .../images => images}/steps_demo_screen.png | Bin .../steps_demo_screenshot.png | Bin 7 files changed, 361 insertions(+), 328 deletions(-) rename {examples/images => images}/Capabilities_HealthKit.png (100%) rename {examples/images => images}/IMG_0205.PNG (100%) rename {examples/images => images}/body_measurements_demo_screen.png (100%) rename {examples/images => images}/body_measurements_demo_screenshot.png (100%) rename {examples/images => images}/steps_demo_screen.png (100%) rename {examples/images => images}/steps_demo_screenshot.png (100%) diff --git a/README.md b/README.md index fa4e17c..e4d0578 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# React Native Apple HealthKit -A React Native bridge module for interacting with [Apple HealthKit] data. +# React Native Apple Healthkit +A React Native bridge module for interacting with [Apple Healthkit] data. -![Alt text](https://devimages.apple.com.edgekey.net/assets/elements/icons/healthkit/healthkit-64x64.png "Apple HealthKit") +![Alt text](https://devimages.apple.com.edgekey.net/assets/elements/icons/Healthkit/Healthkit-64x64.png "Apple Healthkit") ## Table of Contents * [Getting Started](#getting-started) @@ -11,7 +11,7 @@ A React Native bridge module for interacting with [Apple HealthKit] data. * [Permissions](#permissions) * [Methods](#methods) * [isAvailable](#isavailable) - * [initHealthKit](#inithealthkit) + * [initHealthkit](#initHealthkit) * [getBiologicalSex](#getbiologicalsex) * [getDateOfBirth](#getdateofbirth) * [getStepCount](#getstepcount) @@ -40,35 +40,33 @@ A React Native bridge module for interacting with [Apple HealthKit] data. * [Examples](#examples) ## References -- Apple HealthKit Documentation [https://developer.apple.com/healthkit/](https://developer.apple.com/healthkit/) +- Apple Healthkit Documentation [https://developer.apple.com/Healthkit/](https://developer.apple.com/Healthkit/) ## Getting started ### Installation -Install the [rn-apple-healthkit] package from npm: +Install the [rn-apple-Healthkit] package from npm: -`npm install rn-apple-healthkit --save` +`npm install rn-apple-Healthkit --save` ##### Xcode 1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]` -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") +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") 6. Compile and run ### Usage -Just `require` the `rn-apple-healthkit` module and you're ready to go! +Just `import` the `rn-apple-Healthkit` module and you're ready to go! ```javascript -var AppleHealthKit = require('rn-apple-healthkit'); - -... +import AppleHealthkit from 'rn-apple-Healthkit'; let options = { permissions: { @@ -77,42 +75,42 @@ let options = { } }; -AppleHealthKit.initHealthKit(options: Object, (err: Object, res: Object) => { - if(err) { - console.log("error initializing healthkit: ", err); +AppleHealthkit.initHealthkit(options: Object, (err: Object, results: Object) => { + if (err) { + console.log("error initializing Healthkit: ", err); return; } - // healthkit initialized... + // Healthkit initialized... }); ``` -When the module has been successfully initialized you can read and write HealthKit data +When the module has been successfully initialized you can read and write Healthkit data ```javascript -var AppleHealthKit = require('rn-apple-healthkit'); -var _ = require('lodash'); - +import AppleHealthkit from 'rn-apple-Healthkit'; -AppleHealthKit.initHealthKit(null: Object, (err: string, res: Object) => { +AppleHealthkit.initHealthkit(null: Object, (err: string, results: Object) => { ... - AppleHealthKit.getLatestWeight(null, (err: Object, weight: Object) => { + AppleHealthkit.getLatestWeight(null, (err: Object, weight: Object) => { if(err){ console.log("error getting current weight: ", err); return; } - // use weight.value ... + // use weight.value }); ... - let options = { value: 200 }; - AppleHealthKit.saveWeight(options: Object, (err: Object, res: Object) => { + let options = { + value: 200 + }; + AppleHealthkit.saveWeight(options: Object, (err: Object, results: Object) => { if (err) { - console.log("error saving weight to healthkit: ", err); + console.log("error saving weight to Healthkit: ", err); return; } // weight successfully saved @@ -124,68 +122,66 @@ AppleHealthKit.initHealthKit(null: Object, (err: string, res: Object) => { ``` - ## Documentation -Permissions ------------ +### Permissions -The available HealthKit permissions to use with `initHealthKit` +The available Healthkit permissions to use with `initHealthkit` -| Permission | HealthKit Identifier Type | Read | Write | +| Permission | Healthkit Identifier Type | Read | Write | |------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|------|-------| -| 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. +| 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. ## Methods #### **`isAvailable`** -Check if HealthKit is available on the device. +Check if Healthkit is available on the device. ```javascript -import AppleHealthKit from 'rn-apple-healthkit'; +import AppleHealthkit from 'rn-apple-Healthkit'; -AppleHealthKit.isAvailable((err: Object, available: boolean) => { - if(available){ +AppleHealthkit.isAvailable((err: Object, available: boolean) => { + if (available) { // ... } }); ``` ___ -#### **`initHealthKit`** -Initialize HealthKit. This will show the HealthKit permissions prompt for any read/write permissions set in the required `options` object. +#### **`initHealthkit`** +Initialize Healthkit. This will show the Healthkit permissions prompt for any read/write permissions set in the required `options` object. 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. -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). +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). -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. +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. -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. +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. -`initHealthKit` requires an options object with HealthKit permission settings +`initHealthkit` requires an options object with Healthkit permission settings ```javascript let options = { permissions: { @@ -196,13 +192,13 @@ let options = { ``` ```javascript -AppleHealthKit.initHealthKit(options: Object, (err: string, res: Object) => { +AppleHealthkit.initHealthkit(options: Object, (err: string, results: Object) => { if (err) { - console.log("error initializing healthkit: ", err); + console.log("error initializing Healthkit: ", err); return; } - // healthkit is initialized... - // now safe to read and write healthkit data... + // Healthkit is initialized... + // now safe to read and write Healthkit data... }); ``` @@ -219,21 +215,35 @@ Get the biological sex (gender). If the `BiologicalSex` read permission is missi | other | HKBiologicalSexOther | ```javascript -AppleHealthKit.getBiologicalSex(null, (err: Object, res: Object) => { - if(this._handleHealthKitError(err, 'getBiologicalSex')){ - return; +AppleHealthkit.getBiologicalSex(null, (err: Object, results: Object) => { + if (this._handleHealthkitError(err, 'getBiologicalSex')) { + return; } - // res.value will be one of the values from the above table (Value column) - // use res.value ... + console.log(results) }); ``` +```javascript +{ + value: 'female', +} +``` + ___ #### **`getDateOfBirth`** Get the date of birth. On success, the callback function will be provided with a `res` object containing dob `value: string` (ISO timestamp), and `age: number` (age in years): +```javascript +AppleHealthkit.getDateOfBirth(null, (err: Object, results: Object) => { + if (this._handleHealthkitError(err, 'getDateOfBirth')) { + return; + } + console.log(results) +}); +``` + ```javascript { value: '1986-09-01T00:00:00.000-0400', @@ -241,16 +251,6 @@ On success, the callback function will be provided with a `res` object containin } ``` -```javascript -AppleHealthKit.getDateOfBirth(null, (err: Object, res: Object) => { - if(this._handleHealthKitError(err, 'getDateOfBirth')){ - return; - } - // use res.value ... (ex: '1986-09-01T12:20:30-04:00') - // use res.age ... (ex: 29) -}); -``` - ___ #### **`getStepCount`** @@ -258,21 +258,27 @@ Get the aggregated total steps for a specific day (starting and ending at midnig 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. ```javascript -let d = new Date(2016,5,27); +let d = new Date(2016,1,1); let options = { date: d.toISOString() }; ``` ```javascript -AppleHealthKit.getStepCount(options: Object, (err: Object, steps: Object) => { - if(this._handleHealthKitError(err, 'getStepCount')){ +AppleHealthkit.getStepCount(options: Object, (err: Object, results: Object) => { + if (this._handleHealthkitError(err, 'getStepCount')) { return; } - // steps.value is the step count for day 'd' + console.log(results) }); ``` +```javascript +{ + value: 213, +} +``` + ___ #### **`getDailyStepCountSamples`** @@ -281,51 +287,43 @@ Get the total steps per day over a specified date range. `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 ```javascript let options = { - startDate: (new Date(2016,5,1)).toISOString() // required - endDate: (new Date()).toISOString() // optional; default now + startDate: (new Date(2016,1,1)).toISOString() // required + endDate: (new Date()).toISOString() // optional; default now }; ``` + +```javascript + AppleHealthkit.getDailyStepCountSamples(options: Object, (err: Object, results: Array) => { + if (this._handleHealthkitError(err, 'getDailyStepCountSamples')) { + return; + } + console.log(results) +}); +``` + The function will be called with an array of elements. Each element is an object containing `value`, `startDate`, and `endDate` fields: ```javascript [ { 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' }, - ... ] ``` - -```javascript - AppleHealthKit.getDailyStepCountSamples(options: Object, (err: Object, res: Array) => { - if(this._handleHealthKitError(err, 'getDailyStepCountSamples')){ - return; - } - // 'res' is array of {value: number, startDate: string, endDate: string} objects - // sorted ascending from startDate through endDate - for(let i=0; i { - if(this._handleHKError(err, 'initHealthKit')){ +```javascript +AppleHealthkit.initHealthkit(HKOPTIONS, (err, res) => { + if (this._handleHKError(err, 'initHealthkit')) { return; } // initialize the step count observer - AppleHealthKit.initStepCountObserver({}, () => {}); + AppleHealthkit.initStepCountObserver({}, () => {}); // add event listener for 'change:steps' and handle the // event in the event handler function. @@ -362,15 +357,15 @@ AppleHealthKit.initHealthKit(HKOPTIONS, (err, res) => { 'change:steps', (evt) => { // a 'change:steps' event has been received. step - // count data should be re-fetched from HealthKit. + // count data should be re-fetched from Healthkit. this._fetchStepCountData(); } ); - // other tasks to perform after HealthKit has been - // initialized (fetch relevant HealthKit data). + // other tasks to perform after Healthkit has been + // initialized (fetch relevant Healthkit data). this._fetchStepCountData(); - this._fetchOtherRelevantHealthKitData(); + this._fetchOtherRelevantHealthkitData(); // ... }); @@ -394,20 +389,20 @@ A step count sample represents the number of steps during a specific period of t `saveSteps` accepts an options object containing required *`value: number`*, *`startDate: ISO8601Timestamp`*, and *`endDate: ISO8601Timestamp`*. ```javascript // startDate and endDate are 30 minutes apart. -// this means the step count value occured within those 30 minutes. +// this means the step count value occurred within those 30 minutes. let options = { - value: 100, - startDate: (new Date(2016,6,2,6,0,0)).toISOString(), - endDate: (new Date(2016,6,2,6,30,0)).toISOString() + value: 100, + startDate: (new Date(2016,6,2,6,0,0)).toISOString(), + endDate: (new Date(2016,6,2,6,30,0)).toISOString() }; ``` ```javascript -AppleHealthKit.saveSteps(options, (err, res) => { - if(this._handleHKError(err, 'saveSteps')){ - return; - } - // step count sample successfully saved +AppleHealthkit.saveSteps(options, (err, res) => { + if (this._handleHKError(err, 'saveSteps')) { + return; + } + // step count sample successfully saved }); ``` @@ -423,17 +418,20 @@ let options = { unit: 'mile', // optional; default 'meter' date: (new Date(2016,5,1)).toISOString(), // optional; default now }; +``` -AppleHealthKit.getDistanceWalkingRunning(options: Object, (err: Object, res: Object) => { - if(this._handleHKError(err, 'getDistanceWalkingRunning')){ +```javascript +AppleHealthkit.getDistanceWalkingRunning(options: Object, (err: Object, results: Object) => { + if (this._handleHKError(err, 'getDistanceWalkingRunning')) { return; } + console.log(results) }); ``` ```javascript { - value: 200, + value: 1.45, startDate: '2016-07-08T12:00:00.000-0400', endDate: '2016-07-08T12:00:00.000-0400' } @@ -447,20 +445,28 @@ Get the total distance cycling on a specific day. `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` ```javascript let options = { - unit: 'meter', // optional; default 'meter' - date: (new Date(2016,5,1)).toISOString(), // optional; default now + unit: 'mile', // optional; default 'meter' + date: (new Date(2016,5,1)).toISOString(), // optional; default now }; ``` ```javascript -AppleHealthKit.getDistanceCycling(options: Object, (err: Object, res: Object) => { - if(this._handleHKError(err, 'getDistanceCycling')){ +AppleHealthkit.getDistanceCycling(options: Object, (err: Object, results: Object) => { + if (err) { return; } - // use res.value ... + console.log(results) }); ``` +```javascript +{ + value: 11.45, + startDate: '2016-07-08T12:00:00.000-0400', + endDate: '2016-07-08T12:00:00.000-0400' +} +``` + ___ #### **`getFlightsClimbed`** @@ -469,19 +475,27 @@ get the total flights climbed (1 flight is ~10ft of elevation) on a specific day `getFlightsClimbed` accepts an options object containing optional *`date: ISO8601Timestamp`*. if `date` is not provided it will default to the current time. ```javascript let options = { - date: (new Date(2016,5,1)).toISOString(), // optional; default now + date: (new Date(2016,5,1)).toISOString(), // optional; default now }; ``` ```javascript -AppleHealthKit.getFlightsClimbed(options: Object, (err: Object, res: Object) => { - if(this._handleHKError(err, 'getFlightsClimbed')){ - return; - } - // use res.value ... +AppleHealthkit.getFlightsClimbed(options: Object, (err: Object, results: Object) => { + if (err) { + return; + } + console.log(results) }); ``` +```javascript +{ + value: 15, + startDate: '2016-07-08T12:00:00.000-0400', + endDate: '2016-07-08T12:00:00.000-0400' +} +``` + ___ #### **`getLatestWeight`** @@ -490,20 +504,18 @@ Get the most recent weight sample. 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.* ```javascript -AppleHealthKit.initHealthKit(null: Object, (err: string, res: Object) => { - - let options = { - unit: 'pound' - }; - - AppleHealthKit.getLatestWeight(options, (err: string, weight: Object) => { - if (err) { - console.log("error getting latest weight: ", err); - return; - } - console.log(weight) - }); +let options = { + unit: 'pound' +}; +``` +```javascript +AppleHealthkit.getLatestWeight(options, (err: string, results: Object) => { + if (err) { + console.log("error getting latest weight: ", err); + return; + } + console.log(results) }); ``` @@ -521,39 +533,50 @@ ___ query for weight samples. the options object is used to setup a query to retrieve relevant samples. ```javascript let options = { - 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 + 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 }; ``` ```javascript -AppleHealthKit.getWeightSamples(options, (err: Object, samples: Array) => { - if(this._handleHealthKitError(err, 'getWeightSamples')){ - return; - } - // use samples ... +AppleHealthkit.getWeightSamples(options, (err: Object, results: Array) => { + if (err) { + return; + } + console.log(results) }); ``` +```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' }, +] +``` + ___ #### **`saveWeight`** -save a numeric weight value to HealthKit +save a numeric weight value to Healthkit `saveWeight` accepts an options object containing a numeric weight value: ```javascript -let options = {value: 200} +let options = { + value: 200 +} ``` + ```javascript -AppleHealthKit.saveWeight(options: Object, (err: Object, res: Object) => { - if(err){ - console.log("error saving weight to healthkit: ", err); +AppleHealthkit.saveWeight(options: Object, (err: Object, results: Object) => { + if (err) { + console.log("error saving weight to Healthkit: ", err); return; } - // weight successfully saved + // Done }); ``` @@ -563,73 +586,74 @@ ___ Get the most recent height value. 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.* -```javascript -{ - value: 72, - startDate: '2016-07-08T12:00:00.000-0400', - endDate: '2016-07-08T12:00:00.000-0400' -} -``` - ```javascript -AppleHealthKit.getLatestHeight(null, (err: string, height: Object) => { - if(err){ +AppleHealthkit.getLatestHeight(null, (err: string, results: Object) => { + if (err) { console.log("error getting latest height: ", err); return; } - // use height.value, height.startDate, etc ... + console.log(results) }); ``` +```javascript +{ + value: 72, + startDate: '2016-07-08T12:00:00.000-0400', + endDate: '2016-07-08T12:00:00.000-0400' +} +``` + ___ #### **`getHeightSamples`** query for height samples. the options object is used to setup a query to retrieve relevant samples. ```javascript let options = { - 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 + 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 }; ``` -the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields ```javascript -// samples is array of objects -[ - {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'}, - ... -] +AppleHealthkit.getHeightSamples(options, (err: Object, results: Array) => { + if (err) { + return; + } + console.log(results) +}); ``` -*example usage* + +The callback function will be called with a `samples` array containing objects with `value`, `startDate`, and `endDate` fields ```javascript -AppleHealthKit.getHeightSamples(options, (err: Object, samples: Array) => { - if(this._handleHealthKitError(err, 'getHeightSamples')){ - return; - } - // use samples ... -}); +[ + { 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' }, +] ``` ___ #### **`saveHeight`** -save a numeric height value to HealthKit +save a numeric height value to Healthkit `saveHeight` accepts an options object containing a numeric height value: ```javascript -let options = {value: 200} +let options = { + value: 200 +} ``` + ```javascript -AppleHealthKit.saveHeight(options: Object, (err: Object, res: Object) => { - if(this._handleHealthKitError(err, 'saveHeight')){ - return; - } - // height successfully saved +AppleHealthkit.saveHeight(options: Object, (err: Object, results: Object) => { + if (err) { + return; + } + // height successfully saved }); ``` @@ -639,6 +663,16 @@ ___ Get the most recent BMI sample. 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.* +```javascript +AppleHealthkit.getLatestBmi(null, (err: string, results: Object) => { + if (err) { + console.log("error getting latest bmi data: ", err); + return; + } + console.log(results) +}); +``` + ```javascript { value: 27.2, @@ -647,33 +681,23 @@ On success, the callback function will be provided with a `bmi` object containin } ``` -```javascript -AppleHealthKit.getLatestBmi(null, (err: string, bmi: Object) => { - if(err){ - console.log("error getting latest bmi data: ", err); - return; - } - let d = bmi.startDate - let val = bmi.value; - // ... -}); -``` - ___ #### **`saveBmi`** -save a numeric BMI value to HealthKit +save a numeric BMI value to Healthkit `saveBmi` accepts an options object containing a numeric BMI value: ```javascript -let options = {value: 27.2} +let options = { + value: 27.2 +} ``` ```javascript -AppleHealthKit.saveBmi(options: Object, (err: Object, res: Object) => { - if(this._handleHealthKitError(err, 'saveBmi')){ - return; - } - // BMI successfully saved +AppleHealthkit.saveBmi(options: Object, (err: Object, results: Object) => { + if (err) { + return; + } + // BMI successfully saved }); ``` @@ -683,6 +707,16 @@ ___ Get the most recent body fat percentage. The percentage value is a number between 0 and 100. 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.* + +```javascript +AppleHealthkit.getLatestBodyFatPercentage(null, (err: Object, results: Object) => { + if (err) { + return; + } + console.log(results) +}); +``` + ```javascript { value: 20, @@ -691,21 +725,22 @@ On success, the callback function will be provided with a `bodyFatPercentage` ob } ``` -```javascript -AppleHealthKit.getLatestBodyFatPercentage(null, (err: Object, bodyFatPercentage: Object) => { - if(this._handleHealthKitError(err, 'getLatestBodyFatPercentage')){ - return; - } - // use bodyFatPercentage.value, bodyFatPercentage.startDate, etc ... -}); -``` - ___ #### **`getLatestLeanBodyMass`** Get the most recent lean body mass. The value is a number representing the weight in pounds (lbs) 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.* + +```javascript + AppleHealthkit.getLatestLeanBodyMass(null, (err: Object, results: Object) => { + if (err) { + return; + } + console.log(results) +}); +``` + ```javascript { value: 176, @@ -714,124 +749,125 @@ On success, the callback function will be provided with a `leanBodyMass` object } ``` -```javascript - AppleHealthKit.getLatestLeanBodyMass(null, (err: Object, leanBodyMass: Object) => { - if(this._handleHealthKitError(err, 'getLatestLeanBodyMass')){ - return; - } - // use leanBodyMass.value, leanBodyMass.startDate, etc ... -}); -``` - ___ #### **`getHeartRateSamples`** query for heart rate samples. the options object is used to setup a query to retrieve relevant samples. ```javascript let options = { - 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 + 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 }; ``` the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields - -*example usage* ```javascript -AppleHealthKit.getHeartRateSamples(options, (err: Object, samples: Array) => { - if(this._handleHealthKitError(err, 'getHeartRateSamples')){ - return; - } - // use samples ... +AppleHealthkit.getHeartRateSamples(options, (err: Object, results: Array) => { + if (err) { + return; + } + console.log(results) }); ``` +```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' }, +] +``` + ___ #### **`getBodyTemperatureSamples`** query for body temperature samples. the options object is used to setup a query to retrieve relevant samples. ```javascript let options = { - 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 + 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 }; ``` available units are: `'fahrenheit'`, `'celsius'`. the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields. -*example usage* ```javascript -AppleHealthKit.getBodyTemperatureSamples(options, (err: Object, samples: Array) => { - if(this._handleHealthKitError(err, 'getBodyTemperatureSamples')){ +AppleHealthkit.getBodyTemperatureSamples(options, (err: Object, results: Array) => { + if (err) { return; } - // use samples ... + console.log(results) }); ``` +```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' }, +] +``` + ___ #### **`getBloodPressureSamples`** query for blood pressure samples. the options object is used to setup a query to retrieve relevant samples. ```javascript let options = { - 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 + 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 }; ``` the callback function will be called with a `samples` array containing objects with *bloodPressureSystolicValue*, *bloodPressureDiastolicValue*, *startDate*, and *endDate* fields + ```javascript -// samples is array of objects -[ - {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'}, - ... -] +AppleHealthkit.getBloodPressureSamples(options, (err: Object, results: Array) => { + if (err) { + return; + } + console.log(results) +}); ``` -*example usage* + ```javascript -AppleHealthKit.getBloodPressureSamples(options, (err: Object, samples: Array) => { - if(this._handleHealthKitError(err, 'getBloodPressureSamples')){ - return; - } - // use samples ... -}); +[ + { 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' }, +] ``` + ___ #### **`getRespiratoryRateSamples`** query for respiratory rate samples. the options object is used to setup a query to retrieve relevant samples. ```javascript let options = { - 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 + 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 }; ``` the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields -*example usage* ```javascript -AppleHealthKit.getRespiratoryRateSamples(options, (err: Object, samples: Array) => { - if(this._handleHealthKitError(err, 'getRespiratoryRateSamples')){ - return; - } - // use samples ... +AppleHealthkit.getRespiratoryRateSamples(options, (err: Object, results: Array) => { + if (err) { + return; + } + console.log(results) }); ``` @@ -841,28 +877,26 @@ ___ query for blood glucose samples. the options object is used to setup a query to retrieve relevant samples. ```javascript let options = { - 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 + 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 }; ``` available units are: `'mmolPerL'`, `'mgPerdL'`. the callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields -*example usage* ```javascript -AppleHealthKit.getBloodGlucoseSamples(options, (err: Object, samples: Array) => { - if(this._handleHealthKitError(err, 'getBloodGlucoseSamples')){ - return; - } - // use samples ... +AppleHealthkit.getBloodGlucoseSamples(options, (err: Object, results: Array) => { + if (err) { + return; + } + console.log(results) }); ``` - ___ #### **`getSleepSamples`** @@ -871,34 +905,33 @@ 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, meaning that two (or more) samples represent a single nights sleep activity. see -[HealthKit SleepAnalysis] reference documentation +[Healthkit SleepAnalysis] reference documentation 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 = { - startDate: (new Date(2016,10,1)).toISOString(), // required - endDate: (new Date()).toISOString(), // optional; default now - limit:10, // optional; default no limit + startDate: (new Date(2016,10,1)).toISOString(), // required + endDate: (new Date()).toISOString(), // optional; default now + limit:10, // optional; default no limit }; ``` -the callback function will be called with a `samples` array containing objects +The callback function will be called with a `samples` array containing objects with *value*, *startDate*, and *endDate* fields -*example usage* ```javascript -AppleHealthKit.getSleepSamples(options, (err: Object, samples: Array) => { - if(this._handleHealthKitError(err, 'getSleepSamples')){ - return; - } - // use samples ... +AppleHealthkit.getSleepSamples(options, (err: Object, results: Array) => { + if (err) { + return; + } + console.log(results). }); ``` ## Examples -- [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) +- [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) -> *This package is fork from [react-native-apple-healthkit](https://github.com/GregWilson/react-native-apple-healthkit)* +> *This package is fork from [react-native-apple-Healthkit](https://github.com/GregWilson/react-native-apple-Healthkit)* diff --git a/examples/images/Capabilities_HealthKit.png b/images/Capabilities_HealthKit.png similarity index 100% rename from examples/images/Capabilities_HealthKit.png rename to images/Capabilities_HealthKit.png diff --git a/examples/images/IMG_0205.PNG b/images/IMG_0205.PNG similarity index 100% rename from examples/images/IMG_0205.PNG rename to images/IMG_0205.PNG diff --git a/examples/images/body_measurements_demo_screen.png b/images/body_measurements_demo_screen.png similarity index 100% rename from examples/images/body_measurements_demo_screen.png rename to images/body_measurements_demo_screen.png diff --git a/examples/images/body_measurements_demo_screenshot.png b/images/body_measurements_demo_screenshot.png similarity index 100% rename from examples/images/body_measurements_demo_screenshot.png rename to images/body_measurements_demo_screenshot.png diff --git a/examples/images/steps_demo_screen.png b/images/steps_demo_screen.png similarity index 100% rename from examples/images/steps_demo_screen.png rename to images/steps_demo_screen.png diff --git a/examples/images/steps_demo_screenshot.png b/images/steps_demo_screenshot.png similarity index 100% rename from examples/images/steps_demo_screenshot.png rename to images/steps_demo_screenshot.png -- 2.26.2