*nix Programming Mammals

    @matthiasn/rn-apple-healthkit

    0.6.9 • Public • Published

    React Native Apple Healthkit

    A React Native bridge module for interacting with Apple Healthkit data. Checkout the full documentation

    Installation

    Install the [rn-apple-healthkit] package from npm:

    • Run npm install rn-apple-healthkit --save
    • Run react-native link rn-apple-healthkit

    Update info.plist in your React Native project

    <key>NSHealthShareUsageDescription</key>
    <string>Read and understand health data.</string>
    <key>NSHealthUpdateUsageDescription</key>
    <string>Share workout data with other apps.</string>
    

    Manual Installation

    1. Run npm install rn-apple-healthkit --save
    2. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
    3. Go to node_modulesrn-apple-healthkit and add RCTAppleHealthkit.xcodeproj
    4. In XCode, in the project navigator, select your project. Add libRCTAppleHealthkit.a to your project's Build PhasesLink Binary With Libraries
    5. Click RCTAppleHealthkit.xcodeproj in the project navigator and go the Build Settings tab. Make sure 'All' is toggled on (instead of 'Basic'). In the Search Paths section, look for Header Search Paths and make sure it contains both $(SRCROOT)/../../react-native/React and $(SRCROOT)/../../../React - mark both as recursive.
    6. Enable Healthkit in your application's Capabilities
    7. Compile and run

    Get Started

    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 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.

    initHealthKit requires an options object with Healthkit permission settings

    let options = {
        permissions: {
            read: ["Height", "Weight", "StepCount", "DateOfBirth", "BodyMassIndex", "ActiveEnergyBurned"],
            write: ["Height", "Weight", "StepCount", "BodyMassIndex", "Biotin", "Caffeine", "Calcium", "Carbohydrates", "Chloride", "Cholesterol", "Copper", "EnergyConsumed", "FatMonounsaturated", "FatPolyunsaturated", "FatSaturated", "FatTotal", "Fiber", "Folate", "Iodine", "Iron", "Magnesium", "Manganese", "Molybdenum", "Niacin", "PantothenicAcid", "Phosphorus", "Potassium", "Protein", "Riboflavin", "Selenium", "Sodium", "Sugar", "Thiamin", "VitaminA", "VitaminB12", "VitaminB6", "VitaminC", "VitaminD", "VitaminE", "VitaminK", "Zinc", "Water"]
        }
    };
    import AppleHealthKit from 'rn-apple-healthkit';
    
    AppleHealthKit.initHealthKit(options: Object, (err: string, results: Object) => {
        if (err) {
            console.log("error initializing Healthkit: ", err);
            return;
        }
    
        // Height Example
        AppleHealthKit.getDateOfBirth(null, (err: Object, results: Object) => {
        if (this._handleHealthkitError(err, 'getDateOfBirth')) {
          return;
        }
          console.log(results)
        });
    
    });
    {
    	value: '1986-09-01T00:00:00.000-0400',
    	age: 29
    }

    Changelog

    0.6.5v

    • Enable fetching basal energy #23
    • remove checkPermission functions in order to use from PR #69
    • Added correct link to permissions. #73
    • Add unified way to get workouts + convert Activity Types to name + isTracked flag #25

    0.6.4v

    • Basal energy (#23)
    • Fixed issues with saving weight in the past
    • Commited the docs to increase pull request support
    • Add daily samples for:
      • Flights Climbed
      • WalkingRunning Distance
      • Cycling Distance

    0.6.3v

    • Food and Water (#19)

    0.6.1v

    • HKQuantityTypeIdentifierActiveEnergyBurned

    Wiki

    Supported Apple Permissions

    The available Healthkit permissions to use with initHealthKit

    Permission Healthkit Identifier Type Read Write
    ActiveEnergyBurned HKQuantityTypeIdentifierActiveEnergyBurned
    BasalEnergyBurned HKQuantityTypeIdentifierBasalEnergyBurned
    BiologicalSex HKCharacteristicTypeIdentifierBiologicalSex
    BloodGlucose HKQuantityTypeIdentifierBloodGlucose
    BloodPressureDiastolic HKQuantityTypeIdentifierBloodPressureDiastolic
    BloodPressureSystolic HKQuantityTypeIdentifierBloodPressureSystolic
    BodyMassIndex HKQuantityTypeIdentifierBodyMassIndex
    BodyTemperature HKQuantityTypeIdentifierBodyTemperature
    DateOfBirth HKCharacteristicTypeIdentifierDateOfBirth
    DistanceCycling HKQuantityTypeIdentifierDistanceCycling
    DistanceWalkingRunning HKQuantityTypeIdentifierDistanceWalkingRunning
    FlightsClimbed HKQuantityTypeIdentifierFlightsClimbed
    HeartRate HKQuantityTypeIdentifierHeartRate
    Height HKQuantityTypeIdentifierHeight
    LeanBodyMass HKQuantityTypeIdentifierLeanBodyMass
    MindfulSession HKCategoryTypeIdentifierMindfulSession
    RespiratoryRate HKQuantityTypeIdentifierRespiratoryRate
    SleepAnalysis HKCategoryTypeIdentifierSleepAnalysis
    StepCount HKQuantityTypeIdentifierStepCount
    Steps HKQuantityTypeIdentifierSteps
    Weight HKQuantityTypeIdentifierBodyMass

    These permissions are exported as constants of the rn-apple-healthkit module.

    import AppleHealthKit from 'rn-apple-healthkit';
    
    // get the available permissions from AppleHealthKit.Constants object
    const PERMS = AppleHealthKit.Constants.Permissions;
    
    // setup healthkit read/write permissions using PERMS
    const healthKitOptions = {
        permissions: {
            read:  [
                PERMS.StepCount,
                PERMS.Height,
            ],
            write: [
                PERMS.StepCount
            ],
        }
    };

    Units

    • bpm
    • calorie
    • celsius
    • count
    • day
    • fahrenheit
    • foot
    • gram
    • hour
    • inch
    • joule
    • meter
    • mgPerdL
    • mile
    • minute
    • mmhg
    • mmolPerL
    • percent
    • pound
    • second

    References

    This package is an original fork of react-native-apple-Healthkit

    Install

    npm i @matthiasn/rn-apple-healthkit

    DownloadsWeekly Downloads

    1

    Version

    0.6.9

    License

    MIT

    Unpacked Size

    236 kB

    Total Files

    76

    Last publish

    Collaborators

    • matthiasn