![\"Capgo](\"https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-health\")
\n\nYour privacy policy content here...
\nExplain how you collect, use, and protect health data...
\n \n\n```\n\n**Option 2: Custom URL (recommended for hosted privacy policies)**\n\nAdd a string resource to your app's `android/app/src/main/res/values/strings.xml`:\n\n```xml\nPromise<AvailabilityResult>\n\n--------------------\n\n\n### requestAuthorization(...)\n\n```typescript\nrequestAuthorization(options: AuthorizationOptions) => PromiseAuthorizationOptions |\n\n**Returns:** Promise<AuthorizationStatus>\n\n--------------------\n\n\n### checkAuthorization(...)\n\n```typescript\ncheckAuthorization(options: AuthorizationOptions) => PromiseAuthorizationOptions |\n\n**Returns:** Promise<AuthorizationStatus>\n\n--------------------\n\n\n### readSamples(...)\n\n```typescript\nreadSamples(options: QueryOptions) => PromiseQueryOptions |\n\n**Returns:** Promise<ReadSamplesResult>\n\n--------------------\n\n\n### saveSample(...)\n\n```typescript\nsaveSample(options: WriteSampleOptions) => PromiseWriteSampleOptions |\n\n--------------------\n\n\n### getPluginVersion()\n\n```typescript\ngetPluginVersion() => Promise<{ version: string; }>\n```\n\nGet the native Capacitor plugin version\n\n**Returns:** Promise<{ version: string; }>\n\n--------------------\n\n\n### openHealthConnectSettings()\n\n```typescript\nopenHealthConnectSettings() => PromiseQueryWorkoutsOptions | Query options including optional workout type filter, date range, limit, and sort order |\n\n**Returns:** Promise<QueryWorkoutsResult>\n\n--------------------\n\n\n### queryAggregated(...)\n\n```typescript\nqueryAggregated(options: QueryAggregatedOptions) => PromiseQueryAggregatedOptions | Query options including data type, date range, bucket size, and aggregation type |\n\n**Returns:** Promise<QueryAggregatedResult>\n\n--------------------\n\n\n### Interfaces\n\n\n#### AvailabilityResult\n\n| Prop | Type | Description |\n| --------------- | ---------------------------------------- | ------------------------------------------------------ |\n| **`available`** | boolean | |\n| **`platform`** | 'ios' \\| 'android' \\| 'web' | Platform specific details (for debugging/diagnostics). |\n| **`reason`** | string | |\n\n\n#### AuthorizationStatus\n\n| Prop | Type | Description |\n| ----------------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`readAuthorized`** | HealthDataType[] | |\n| **`readDenied`** | HealthDataType[] | |\n| **`writeAuthorized`** | HealthDataType[] | |\n| **`writeDenied`** | HealthDataType[] | |\n| **`historyAccessAuthorized`** | boolean | Android only: whether the `READ_HEALTH_DATA_HISTORY` permission is granted. Only present when `requestHistoryAccess` was set on the request; omitted otherwise and always omitted on iOS. Always `false` when `historyAccessAvailable` is `false`, since an unsupported provider can never grant the permission. |\n| **`historyAccessAvailable`** | boolean | Android only: whether the connected Health Connect provider supports the `READ_HEALTH_DATA_HISTORY` permission at all. Only present when `requestHistoryAccess` was set on the request; omitted otherwise and always omitted on iOS. `false` means the provider is too old (pre Android 14 extension 13 / Health Connect APK 171302) to ever grant history access — distinct from the user simply denying it. Use it to avoid re-prompting and to message the user that history access is unavailable on their device. |\n\n\n#### AuthorizationOptions\n\n| Prop | Type | Description |\n| -------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`read`** | HealthDataType[] | Data types that should be readable after authorization. |\n| **`write`** | HealthDataType[] | Data types that should be writable after authorization. |\n| **`requestHistoryAccess`** | boolean | Android only: also request the `READ_HEALTH_DATA_HISTORY` permission in the same Health Connect permission sheet. Without it, Health Connect caps reads to roughly the last 30 days; granting it lets you read older data. The consuming app must also declare the permission in its `AndroidManifest.xml`: `<uses-permission android:name=\"android.permission.health.READ_HEALTH_DATA_HISTORY\" />` The permission only exists on sufficiently new Health Connect providers (Android 14 extension 13+ or Health Connect APK 171302+). On older but otherwise supported providers it is silently skipped — the normal read/write scopes are still requested — and the returned status reports `historyAccessAvailable: false`. Ignored on iOS (HealthKit has no equivalent permission and no 30-day read cap). |\n\n\n#### ReadSamplesResult\n\n| Prop | Type |\n| ------------- | --------------------------- |\n| **`samples`** | HealthSample[] |\n\n\n#### HealthSample\n\n| Prop | Type | Description |\n| ----------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`dataType`** | HealthDataType | |\n| **`value`** | number | |\n| **`unit`** | HealthUnit | |\n| **`startDate`** | string | |\n| **`endDate`** | string | |\n| **`sourceName`** | string | |\n| **`sourceId`** | string | |\n| **`deviceType`** | string | Android only. The recording device's type, when Health Connect reports one: 'watch' \\| 'phone' \\| 'scale' \\| 'ring' \\| 'headMounted' \\| 'fitnessBand' \\| 'chestStrap' \\| 'smartDisplay'. Useful when a record carries a device type but no manufacturer/model, where `sourceName` falls back to the package name and cannot distinguish a watch from a phone. |\n| **`platformId`** | string | Platform-specific unique identifier (HealthKit UUID on iOS, Health Connect metadata ID on Android). |\n| **`sleepState`** | SleepState | For sleep data, indicates the sleep state (e.g., 'asleep', 'awake', 'rem', 'deep', 'light'). |\n| **`standState`** | 'stood' \\| 'idle' | For Apple Stand Hour data (iOS only), whether the hour counted as stood or idle. `value` is normalized to 1 for stood and 0 for idle, so summing values per day yields the Activity ring's stand-hour count. |\n| **`stages`** | SleepStage[] | For sleep data, individual sleep stages when the platform exposes stage-level data. |\n| **`hasStageData`** | boolean | For sleep data, indicates whether stage-level data was emitted. |\n| **`systolic`** | number | For blood pressure data, the systolic value in mmHg. |\n| **`diastolic`** | number | For blood pressure data, the diastolic value in mmHg. |\n| **`measurementMethod`** | number | For VO2 max data on Android, Health Connect's measurement method enum value. |\n\n\n#### SleepStage\n\nStage-level sleep segment emitted for sleep samples when platform data is available.\n\n| Prop | Type | Description |\n| --------------------- | ------------------------------------------------- | -------------------------------------------- |\n| **`startDate`** | string | Stage segment start date in ISO 8601 format. |\n| **`endDate`** | string | Stage segment end date in ISO 8601 format. |\n| **`stage`** | SleepState | Sleep stage label for this segment. |\n| **`durationMinutes`** | number | Duration of this stage segment in minutes. |\n\n\n#### QueryOptions\n\n| Prop | Type | Description |\n| --------------- | --------------------------------------------------------- | ------------------------------------------------------------------ |\n| **`dataType`** | HealthDataType | The type of data to retrieve from the health store. |\n| **`startDate`** | string | Inclusive ISO 8601 start date (defaults to now - 1 day). |\n| **`endDate`** | string | Exclusive ISO 8601 end date (defaults to now). |\n| **`limit`** | number | Maximum number of samples to return (defaults to 100). |\n| **`ascending`** | boolean | Return results sorted ascending by start date (defaults to false). |\n\n\n#### WriteSampleOptions\n\n| Prop | Type | Description |\n| ---------------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`dataType`** | HealthDataType | |\n| **`value`** | number | |\n| **`unit`** | HealthUnit | Optional unit override. If omitted, the default unit for the data type is used (count for `steps`, meter for `distance`, kilocalorie for `calories`, bpm for `heartRate`, kilogram for `weight`). |\n| **`startDate`** | string | ISO 8601 start date for the sample. Defaults to now. |\n| **`endDate`** | string | ISO 8601 end date for the sample. Defaults to startDate. |\n| **`metadata`** | Record<string, string> | Metadata key-value pairs forwarded to the native APIs where supported. |\n| **`mindfulnessSessionType`** | 'meditation' \\| 'unknown' \\| 'breathing' \\| 'music' \\| 'movement' \\| 'unguided' | Android mindfulness session type. Defaults to 'meditation' when dataType is 'mindfulness'. |\n| **`systolic`** | number | For blood pressure data, the systolic value in mmHg. Required when dataType is 'bloodPressure'. |\n| **`diastolic`** | number | For blood pressure data, the diastolic value in mmHg. Required when dataType is 'bloodPressure'. |\n\n\n#### QueryWorkoutsResult\n\n| Prop | Type | Description |\n| -------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`workouts`** | Workout[] | |\n| **`anchor`** | string | Anchor for the next page of results. Pass this value as the anchor parameter in the next query to continue pagination. If undefined or null, there are no more results. |\n\n\n#### Workout\n\n| Prop | Type | Description |\n| ----------------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |\n| **`workoutType`** | WorkoutType | The type of workout. |\n| **`duration`** | number | Duration of the workout in seconds. |\n| **`totalEnergyBurned`** | number | Total energy burned in kilocalories (if available). |\n| **`totalDistance`** | number | Total distance in meters (if available). |\n| **`startDate`** | string | ISO 8601 start date of the workout. |\n| **`endDate`** | string | ISO 8601 end date of the workout. |\n| **`sourceName`** | string | Source name that recorded the workout. |\n| **`sourceId`** | string | Source bundle identifier. |\n| **`platformId`** | string | Platform-specific unique identifier (HealthKit UUID on iOS, Health Connect metadata ID on Android). |\n| **`metadata`** | Record<string, string> | Additional metadata (if available). |\n| **`workoutEvents`** | WorkoutEvent[] | Lap workout events when available. On iOS, includes HealthKit lap markers with per-lap duration and optional distance. |\n\n\n#### WorkoutEvent\n\n| Prop | Type | Description |\n| --------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------- |\n| **`type`** | string | Workout event type. iOS returns lap events from HealthKit (`HKWorkoutEventType.lap`). |\n| **`date`** | string | ISO 8601 timestamp of the event. |\n| **`durationSeconds`** | number | Duration of the lap interval in seconds until the next lap event or the workout end. Present for lap events returned on iOS. |\n| **`distanceMeters`** | number | Lap distance in meters when HealthKit provides it on the workout event metadata (for example `HKMetadataKeyLapLength`). |\n\n\n#### QueryWorkoutsOptions\n\n| Prop | Type | Description |\n| ----------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| **`workoutType`** | WorkoutType | Optional workout type filter. If omitted, all workout types are returned. |\n| **`startDate`** | string | Inclusive ISO 8601 start date (defaults to now - 1 day). |\n| **`endDate`** | string | Exclusive ISO 8601 end date (defaults to now). |\n| **`limit`** | number | Maximum number of workouts to return (defaults to 100). |\n| **`ascending`** | boolean | Return results sorted ascending by start date (defaults to false). |\n| **`anchor`** | string | Anchor for pagination. Use the anchor returned from a previous query to continue from that point. On iOS, this is the ISO 8601 cursor returned by the previous query. On Android, this uses Health Connect's pageToken. Omit this parameter to start from the beginning. |\n\n\n#### QueryAggregatedResult\n\n| Prop | Type |\n| ------------- | ------------------------------- |\n| **`samples`** | AggregatedSample[] |\n\n\n#### AggregatedSample\n\n| Prop | Type | Description |\n| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`startDate`** | string | ISO 8601 start date of the bucket. |\n| **`endDate`** | string | ISO 8601 end date of the bucket. |\n| **`value`** | number | Aggregated value for the bucket. When multiple aggregations are requested, this holds the value of the first requested aggregation that produced a result. See {@link values} for every requested aggregation. |\n| **`values`** | Partial<Record<AggregationType, number>> | Map of each requested aggregation type to its aggregated value for the bucket. |\n| **`unit`** | HealthUnit | Unit of the aggregated value. |\n\n\n#### QueryAggregatedOptions\n\n| Prop | Type | Description |\n| ----------------- | -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`dataType`** | HealthDataType | The type of data to aggregate from the health store. |\n| **`startDate`** | string | Inclusive ISO 8601 start date (defaults to now - 1 day). |\n| **`endDate`** | string | Exclusive ISO 8601 end date (defaults to now). |\n| **`bucket`** | BucketType | Time bucket for aggregation (defaults to 'day'). |\n| **`aggregation`** | AggregationType \\| AggregationType[] | Aggregation operation(s) to perform (defaults to 'sum'). Pass a single {@link AggregationType} to compute one aggregation, or an array to compute several in a single query. Each requested aggregation is returned in {@link AggregatedSample.values}, keyed by its name. |\n\n\n### Type Aliases\n\n\n#### HealthDataType\n\n'steps' | 'distance' | 'calories' | 'heartRate' | 'weight' | 'sleep' | 'respiratoryRate' | 'oxygenSaturation' | 'restingHeartRate' | 'heartRateVariability' | 'vo2Max' | 'bloodPressure' | 'bloodGlucose' | 'bodyTemperature' | 'height' | 'flightsClimbed' | 'exerciseTime' | 'distanceCycling' | 'bodyFat' | 'basalBodyTemperature' | 'appleSleepingWristTemperature' | 'basalCalories' | 'totalCalories' | 'mindfulness' | 'appleStandHour' | 'dietaryWater' | 'dietaryEnergyConsumed' | 'workouts'\n\n\n#### HealthUnit\n\n'count' | 'meter' | 'kilocalorie' | 'bpm' | 'kilogram' | 'minute' | 'percent' | 'millisecond' | 'mL/min/kg' | 'mmHg' | 'mg/dL' | 'celsius' | 'fahrenheit' | 'centimeter' | 'liter'\n\n\n#### SleepState\n\n'inBed' | 'asleep' | 'awake' | 'rem' | 'deep' | 'light'\n\n\n#### Record\n\nConstruct a type with a set of properties K of type T\n\n{\r [P in K]: T;\r }\n\n\n#### WorkoutType\n\n'americanFootball' | 'australianFootball' | 'badminton' | 'baseball' | 'basketball' | 'bowling' | 'boxing' | 'climbing' | 'cricket' | 'crossTraining' | 'curling' | 'cycling' | 'dance' | 'elliptical' | 'fencing' | 'functionalStrengthTraining' | 'golf' | 'gymnastics' | 'handball' | 'hiking' | 'hockey' | 'jumpRope' | 'kickboxing' | 'lacrosse' | 'martialArts' | 'pilates' | 'racquetball' | 'rowing' | 'rugby' | 'running' | 'sailing' | 'skatingSports' | 'skiing' | 'snowboarding' | 'soccer' | 'softball' | 'squash' | 'stairClimbing' | 'strengthTraining' | 'surfing' | 'swimming' | 'swimmingPool' | 'swimmingOpenWater' | 'tableTennis' | 'tennis' | 'trackAndField' | 'traditionalStrengthTraining' | 'volleyball' | 'walking' | 'waterFitness' | 'waterPolo' | 'waterSports' | 'weightlifting' | 'wheelchair' | 'yoga' | 'archery' | 'barre' | 'cooldown' | 'coreTraining' | 'crossCountrySkiing' | 'discSports' | 'downhillSkiing' | 'equestrianSports' | 'fishing' | 'fitnessGaming' | 'flexibility' | 'handCycling' | 'highIntensityIntervalTraining' | 'hunting' | 'mindAndBody' | 'mixedCardio' | 'paddleSports' | 'pickleball' | 'play' | 'preparationAndRecovery' | 'snowSports' | 'stairs' | 'stepTraining' | 'surfingSports' | 'taiChi' | 'transition' | 'underwaterDiving' | 'wheelchairRunPace' | 'wheelchairWalkPace' | 'wrestling' | 'cardioDance' | 'socialDance' | 'backExtension' | 'barbellShoulderPress' | 'benchPress' | 'benchSitUp' | 'bikingStationary' | 'bootCamp' | 'burpee' | 'calisthenics' | 'crunch' | 'dancing' | 'deadlift' | 'dumbbellCurlLeftArm' | 'dumbbellCurlRightArm' | 'dumbbellFrontRaise' | 'dumbbellLateralRaise' | 'dumbbellTricepsExtensionLeftArm' | 'dumbbellTricepsExtensionRightArm' | 'dumbbellTricepsExtensionTwoArm' | 'exerciseClass' | 'forwardTwist' | 'frisbeedisc' | 'guidedBreathing' | 'iceHockey' | 'iceSkating' | 'jumpingJack' | 'latPullDown' | 'lunge' | 'meditation' | 'paddling' | 'paraGliding' | 'plank' | 'rockClimbing' | 'rollerHockey' | 'rowingMachine' | 'runningTreadmill' | 'scubaDiving' | 'skating' | 'snowshoeing' | 'stairClimbingMachine' | 'stretching' | 'upperTwist' | 'other'\n\n\n#### WorkoutEventType\n\n'lap' | 'pause' | 'segment' | 'marker'\n\n\n#### Partial\n\nMake all properties in T optional\n\n{\r [P in keyof T]?: T[P];\r }\n\n\n#### AggregationType\n\n'sum' | 'average' | 'min' | 'max'\n\n\n#### BucketType\n\n'hour' | 'day' | 'week' | 'month'\n\n