health_connector_internal library

Cross-platform health and fitness data integration for Flutter.

This SDK provides a unified API for accessing health data from native platforms: HealthKit on iOS and Health Connect on Android. It handles permission flows, data queries, aggregations, and synchronization with platform-specific health stores.

Classes

ActiveEnergyBurnedDataType
Active energy burned data type.
ActiveEnergyBurnedRecord
Represents active energy burned over a time interval.
ActivityIntensityAggregateRequest
Request to perform aggregation on activity intensity health records.
ActivityIntensityDataType
Activity intensity data type.
ActivityIntensityRecord
Represents an activity intensity measurement over a time interval.
AggregatableHealthDataType<U extends MeasurementUnit>
Interface that adds aggregation capability to a health data type.
AggregateRequest<U extends MeasurementUnit>
Base request class to perform an aggregation query on health records.
AlcoholicBeveragesDataType
Alcoholic beverages data type.
AlcoholicBeveragesRecord
Represents an alcoholic beverages consumption record over a time interval.
AtrialFibrillationBurdenDataType
Atrial Fibrillation Burden data type.
AtrialFibrillationBurdenRecord
Represents an Atrial Fibrillation Burden measurement over a time interval.
AvgAggregatableHealthDataType<U extends MeasurementUnit>
Interface that adds average aggregation capability to a health data type.
BasalBodyTemperatureDataType
Basal body temperature data type.
BasalBodyTemperatureRecord
Represents a basal body temperature measurement at a specific point in time.
BasalEnergyBurnedDataType
Represents the Basal Energy Burned health data type.
BasalEnergyBurnedRecord
Represents basal energy burned over a time interval.
BasalMetabolicRateDataType
Represents the Basal Metabolic Rate health data type.
BasalMetabolicRateRecord
Represents a basal metabolic rate (BMR) record at a specific point in time.
BloodAlcoholContentDataType
Blood alcohol content data type.
BloodAlcoholContentRecord
Represents a blood alcohol content record.
BloodGlucose
Represents a blood glucose measurement with automatic unit conversion.
BloodGlucoseDataType
Blood glucose data type.
BloodGlucoseRecord
Represents a single blood glucose measurement.
BloodPressureAggregateRequest
Request to perform an aggregation query on blood pressure health records.
BloodPressureDataType
Composite blood pressure data type.
BloodPressureRecord
Represents a composite blood pressure measurement at a specific point in time.
BodyFatPercentageDataType
Body fat percentage data type.
BodyFatPercentageRecord
Represents a body fat percentage measurement at a specific point in time.
BodyMassIndexDataType
Body mass index (BMI) data type.
BodyMassIndexRecord
Represents a body mass index (BMI) measurement at a specific point in time.
BodyTemperatureDataType
Body temperature data type.
BodyTemperatureRecord
Represents a body temperature measurement at a specific point in time.
BodyWaterMassDataType
Body water mass data type.
BodyWaterMassRecord
Represents a body water mass record.
BoneMassDataType
Bone mass data type.
BoneMassRecord
Represents a bone mass record.
CervicalMucusDataType
Cervical mucus data type.
CervicalMucusRecord
Represents cervical mucus observation at a specific point in time.
ContraceptiveDataType
Represents the contraceptive usage health data type.
ContraceptiveRecord
Represents a contraceptive usage period.
CrossCountrySkiingDistanceDataType
Cross-country skiing distance data type.
CrossCountrySkiingDistanceRecord
Represents cross-country skiing distance over a time interval.
CyclingDistanceDataType
Cycling distance data type.
CyclingDistanceRecord
Represents cycling distance over a time interval.
CyclingPedalingCadenceDataType
Cycling pedaling cadence measurement data type.
CyclingPedalingCadenceRecord
Represents a single cycling pedaling cadence measurement.
CyclingPedalingCadenceSample
Represents a single cycling pedaling cadence sample at a specific point in time.
CyclingPedalingCadenceSeriesDataType
Health data type for Android cycling pedaling cadence series records.
CyclingPedalingCadenceSeriesRecord
Represents a series of cycling pedaling cadence measurements over a time interval.
CyclingPowerDataType
Cycling power data type.
CyclingPowerRecord
Represents a cycling power measurement at a specific point in time.
DataOrigin
The origin app that wrote the health data.
DeletableByIdsHealthDataType<R extends HealthRecord>
Interface for health data types that support deleting records by ID.
DeletableHealthDataType<R extends HealthRecord>
Interface that adds deletion capability to a health data type.
DeletableInTimeRangeHealthDataType<R extends HealthRecord>
Interface for health data types that support deleting records in a time range.
DeleteRecordsByIdsRequest
Request to delete specific health records by their IDs.
DeleteRecordsInTimeRangeRequest
Request to delete all health records within a time range.
DeleteRecordsRequest
Base sealed class for all delete records requests.
DeveloperLogProcessor
A log processor that uses dart:developer log() for DevTools integration.
Device
Information about the device that recorded health data.
DiastolicBloodPressureDataType
Diastolic blood pressure data type.
DiastolicBloodPressureRecord
Represents a diastolic blood pressure measurement at a specific point in time.
DietaryBiotinDataType
Biotin (Vitamin B7) data type.
DietaryBiotinRecord
Represents a biotin (vitamin B7) measurement from food at a specific point in time.
DietaryCaffeineDataType
Caffeine data type.
DietaryCaffeineRecord
Represents a caffeine measurement from food at a specific point in time.
DietaryCalciumDataType
Calcium data type.
DietaryCalciumRecord
Represents a calcium measurement from food at a specific point in time.
DietaryCholesterolDataType
Cholesterol data type.
DietaryCholesterolRecord
Represents a cholesterol measurement from food at a specific point in time.
DietaryEnergyConsumedDataType
Energy data type.
DietaryEnergyConsumedRecord
Represents an energy (calorie) measurement from food at a specific point in time.
DietaryFiberNutrientDataType
Dietary fiber data type.
DietaryFiberRecord
Represents a dietary fiber measurement from food at a specific point in time.
DietaryFolateDataType
Folate (Vitamin B9) data type.
DietaryFolateRecord
Represents a folate (vitamin B9) measurement from food at a specific point in time.
DietaryIronDataType
Iron data type.
DietaryIronRecord
Represents an iron measurement from food at a specific point in time.
DietaryMagnesiumDataType
Magnesium data type.
DietaryMagnesiumRecord
Represents a magnesium measurement from food at a specific point in time.
DietaryManganeseDataType
Manganese data type.
DietaryManganeseRecord
Represents a manganese measurement from food at a specific point in time.
DietaryMonounsaturatedFatDataType
Monounsaturated fat data type.
DietaryMonounsaturatedFatRecord
Represents a monounsaturated fat measurement from food at a specific point in time.
DietaryNiacinDataType
Niacin (Vitamin B3) data type.
DietaryNiacinRecord
Represents a niacin (vitamin B3) measurement from food at a specific point in time.
DietaryPantothenicAcidDataType
Pantothenic Acid (Vitamin B5) data type.
DietaryPantothenicAcidRecord
Represents a pantothenic acid (vitamin B5) measurement from food at a specific point in time.
DietaryPhosphorusDataType
Phosphorus data type.
DietaryPhosphorusRecord
Represents a phosphorus measurement from food at a specific point in time.
DietaryPolyunsaturatedFatDataType
Polyunsaturated fat data type.
DietaryPolyunsaturatedFatRecord
Represents a polyunsaturated fat measurement from food at a specific point in time.
DietaryPotassiumDataType
Potassium data type.
DietaryPotassiumRecord
Represents a potassium measurement from food at a specific point in time.
DietaryProteinDataType
Protein data type.
DietaryProteinRecord
Represents a protein measurement from food at a specific point in time.
DietaryRiboflavinDataType
Riboflavin (Vitamin B2) data type.
DietaryRiboflavinRecord
Represents a riboflavin (vitamin B2) measurement from food at a specific point in time.
DietarySaturatedFatDataType
Saturated fat data type.
DietarySaturatedFatRecord
Represents a saturated fat measurement from food at a specific point in time.
DietarySeleniumDataType
Selenium data type.
DietarySeleniumRecord
Represents a selenium measurement from food at a specific point in time.
DietarySodiumDataType
Sodium data type.
DietarySodiumRecord
Represents a sodium measurement from food at a specific point in time.
DietarySugarDataType
Sugar data type.
DietarySugarRecord
Represents a sugar measurement from food at a specific point in time.
DietaryThiaminDataType
Thiamin (Vitamin B1) data type.
DietaryThiaminRecord
Represents a thiamin (vitamin B1) measurement from food at a specific point in time.
DietaryTotalCarbohydrateDataType
Total carbohydrate data type.
DietaryTotalCarbohydrateRecord
Represents a total carbohydrate measurement from food at a specific point in time.
DietaryTotalFatDataType
Total fat data type.
DietaryTotalFatRecord
Represents a total fat measurement from food at a specific point in time.
DietaryVitaminADataType
Vitamin A data type.
DietaryVitaminARecord
Represents a vitamin A measurement from food at a specific point in time.
DietaryVitaminB12DataType
Vitamin B12 (Cobalamin) data type.
DietaryVitaminB12Record
Represents a vitamin B12 measurement from food at a specific point in time.
DietaryVitaminB6DataType
Vitamin B6 (Pyridoxine) data type.
DietaryVitaminB6Record
Represents a vitamin B6 measurement from food at a specific point in time.
DietaryVitaminCDataType
Vitamin C (Ascorbic Acid) data type.
DietaryVitaminCRecord
Represents a vitamin C measurement from food at a specific point in time.
DietaryVitaminDDataType
Vitamin D data type.
DietaryVitaminDRecord
Represents a vitamin D measurement from food at a specific point in time.
DietaryVitaminEDataType
Vitamin E data type.
DietaryVitaminERecord
Represents a vitamin E measurement from food at a specific point in time.
DietaryVitaminKDataType
Vitamin K data type.
DietaryVitaminKRecord
Represents a vitamin K measurement from food at a specific point in time.
DietaryZincDataType
Zinc data type.
DietaryZincRecord
Represents a zinc measurement from food at a specific point in time.
DistanceActivityDataType<R extends DistanceActivityRecord>
Base class for activity-specific distance health data types.
DistanceActivityRecord
Base class for activity-specific distance records.
DistanceDataType
Distance data type.
DistanceRecord
Represents a distance measurement over a time interval.
DownhillSnowSportsDistanceDataType
Downhill snow sports distance data type.
DownhillSnowSportsDistanceRecord
Represents downhill snow sports distance over a time interval.
ElectrodermalActivityDataType
Electrodermal activity data type.
ElectrodermalActivityRecord
Represents an electrodermal activity record over a time interval.
ElevationGainedDataType
Elevation gained data type.
ElevationGainedRecord
Captures the elevation gained by the user.
Energy
Represents an energy measurement with automatic unit conversion.
EnvironmentalAudioExposureDataType
Represents the environmental audio exposure health data type.
EnvironmentalAudioExposureEventDataType
Represents the environmental audio exposure event health data type.
EnvironmentalAudioExposureEventRecord
A health record representing an environmental audio exposure event.
EnvironmentalAudioExposureRecord
A health record representing the environmental audio exposure.
ExerciseRoute
Represents a GPS route recorded during an exercise session.
ExerciseRouteLocation
Represents a single location point in an exercise route.
ExerciseRoutePermission
Represents a permission request for accessing exercise route data.
ExerciseSessionDataType
Exercise session data type.
ExerciseSessionEvent
Base class for all exercise session events.
ExerciseSessionInstantEvent
Base class for exercise session events that occur at a single point in time.
ExerciseSessionIntervalEvent
Base class for exercise session events that have a start and end time.
ExerciseSessionLapEvent
Represents a lap within an exercise session.
ExerciseSessionMarkerEvent
Represents an arbitrary marker point during an exercise.
ExerciseSessionRecord
Represents a physical exercise session.
ExerciseSessionSegmentEvent
Represents a segment (exercise phase) within a session.
ExerciseSessionStateTransitionEvent
Represents exercise session pause/resume state transitions.
ExerciseTimeDataType
Apple Exercise Time data type.
ExerciseTimeRecord
Represents an Apple Exercise Time measurement over a time interval.
FloorsClimbedDataType
Floors climbed data type.
FloorsClimbedRecord
Represents floors climbed over a time interval.
ForcedExpiratoryVolumeDataType
Forced expiratory volume data type.
ForcedExpiratoryVolumeRecord
Represents a Forced Expiratory Volume, 1st Second (FEV1) measurement.
ForcedVitalCapacityDataType
Forced vital capacity data type.
ForcedVitalCapacityRecord
Represents a Forced Vital Capacity (FVC) measurement.
Frequency
Represents a frequency measurement with automatic unit conversion.
HeadphoneAudioExposureDataType
Represents the headphone audio exposure health data type.
HeadphoneAudioExposureEventDataType
Represents the headphone audio exposure event health data type.
HeadphoneAudioExposureEventRecord
A health record representing a headphone audio exposure event.
HeadphoneAudioExposureRecord
A health record representing headphone audio exposure.
HealthConnector Core API
Main entry point for interacting with platform-specific health APIs.
HealthConnectorConfig
Configuration for Health Connector.
HealthConnectorDartLog
A log entry originating from Dart code.
HealthConnectorLog
A structured log event emitted by HealthConnectorLogger.
HealthConnectorLogger
Internal singleton logger providing structured, consistent logging across the HealthConnector SDK.
HealthConnectorLoggerConfig
Configuration for the HealthConnector logging system.
HealthConnectorLogProcessor
Base class for processing health connector log records.
HealthConnectorNativeLog
A log entry originating from native platform code (iOS or Android).
HealthConnectorPlatformClient
Platform client interface for interacting with native health platforms.
HealthDataPermission
Represents a permission request for accessing specific health data.
HealthDataSyncResult
Result of a synchronization operation containing changes since the last sync.
HealthDataSyncToken
A synchronization token representing a position in the health data stream.
HealthDataType<R extends HealthRecord, U extends MeasurementUnit>
HealthDataType represents different kinds of health and fitness data that can be read from or written to health platforms.
HealthPlatformFeature
Features are capabilities or functionalities provided by health platforms that may or may not be available on a given device or platform version.
HealthPlatformFeaturePermission
Represents a permission request for a platform feature.
HealthPlatformFeatureReadHealthDataHistory
Feature representing historical health data reading capabilities.
HealthPlatformFeatureReadHealthDataInBackground
Feature representing background health data reading capabilities.
HealthRecord
Base class for all health records.
HealthRecordId
A type-safe identifier for health records.
HeartRateDataType
Heart rate measurement data type.
HeartRateRecord
Represents a single heart rate measurement.
HeartRateRecoveryOneMinuteDataType
Heart rate recovery one minute health data type.
HeartRateRecoveryOneMinuteRecord
Represents a heart rate recovery measurement over a one-minute interval.
HeartRateSample
Represents a single heart rate measurement at a specific point in time.
HeartRateSeriesDataType
Health data type for Android heart rate series records.
HeartRateSeriesRecord
Represents a series of heart rate measurements over a time interval.
HeartRateVariabilityRMSSDDataType
Heart rate variability (RMSSD) data type.
HeartRateVariabilityRMSSDRecord
Represents a heart rate variability (RMSSD) record.
HeartRateVariabilitySDNNDataType
Heart rate variability (SDNN) data type.
HeartRateVariabilitySDNNRecord
Represents a heart rate variability (SDNN) measurement at a point in time.
HeightDataType
Body height data type.
HeightRecord
Represents a body height measurement at a specific point in time.
HighHeartRateEventDataType
Represents the high heart rate event data type.
HighHeartRateEventRecord
Represents a high heart rate event record.
HydrationDataType
Health data type for hydration (water intake) information.
HydrationRecord
Represents a hydration (water intake) measurement over a time interval.
InfrequentMenstrualCycleEventDataType
Represents the infrequent menstrual cycle event data type.
InfrequentMenstrualCycleEventRecord
Represents an infrequent menstrual cycle event record.
InhalerUsageDataType
Inhaler usage data type.
InhalerUsageRecord
Represents an inhaler usage record over a time interval.
InstantHealthRecord
Base health record class representing a measurement at a single point in time.
InsulinDeliveryDataType
Insulin delivery data type.
InsulinDeliveryRecord
Represents a record of insulin delivery.
IntermenstrualBleedingDataType
Intermenstrual bleeding data type.
IntermenstrualBleedingRecord
Represents an intermenstrual bleeding occurrence at a specific point in time.
IntervalHealthRecord
Base health record class that spans a duration of time.
IrregularHeartRhythmEventDataType
Represents the irregular heart rhythm event data type.
IrregularHeartRhythmEventRecord
Represents an irregular heart rhythm event record.
IrregularMenstrualCycleEventDataType
Represents the irregular menstrual cycle event data type.
IrregularMenstrualCycleEventRecord
Represents an irregular menstrual cycle event record.
LactationDataType
Lactation data type.
LactationRecord
A record representing a lactation event.
LeanBodyMassDataType
Lean body mass data type.
LeanBodyMassRecord
Represents a lean body mass measurement at a specific point in time.
Length
Represents a length measurement with automatic unit conversion.
LowCardioFitnessEventDataType
Represents the low cardio fitness event health data type.
LowCardioFitnessEventRecord
Represents a low cardio fitness event.
LowHeartRateEventDataType
Represents the low heart rate event data type.
LowHeartRateEventRecord
Represents a low heart rate event record.
Mass
Represents a mass measurement with automatic unit conversion.
MaxAggregatableHealthDataType<U extends MeasurementUnit>
Interface that adds maximum aggregation capability to a health data type.
MeasurementUnit
Base abstract class for all measurement units in the health connector.
MenstrualFlowDataType
Menstrual flow data type.
MenstrualFlowInstantDataType
Menstrual flow instant data type (Android only).
MenstrualFlowInstantRecord
Represents a menstrual flow measurement at a specific point in time.
MenstrualFlowRecord
Represents a menstrual flow measurement over a time interval.
MenstruationPeriodDataType
Represents the Menstruation Period health data type.
MenstruationPeriodRecord
Represents a menstruation period record spanning a time interval.
Metadata
Metadata associated with a health record.
MinAggregatableHealthDataType<U extends MeasurementUnit>
Interface that adds minimum aggregation capability to a health data type.
MindfulnessSessionDataType
Mindfulness session data type.
MindfulnessSessionRecord
Represents a mindfulness session over a time interval.
MoveTimeDataType
Apple Move Time data type.
MoveTimeRecord
Represents an Apple Move Time measurement over a time interval.
Number
Represents a numeric value without unit conversion.
NumberOfTimesFallenDataType
Number of times fallen data type.
NumberOfTimesFallenRecord
Represents a record of the number of times the user has fallen.
NutrientRecord<U extends MeasurementUnit>
Base class for individual nutrient measurement records.
NutritionDataType
Health data type for nutrition records. Nutrition data type.
NutritionRecord
Represents a comprehensive nutrition record over a time interval.
OvulationTestDataType
Ovulation test data type.
OvulationTestRecord
Represents an ovulation test result at a specific point in time.
OxygenSaturationDataType
Oxygen saturation data type.
OxygenSaturationRecord
Represents an oxygen saturation (SpO₂) measurement at a specific point in time.
PaddleSportsDistanceDataType
Paddle sports distance data type.
PaddleSportsDistanceRecord
Represents paddle sports distance over a time interval.
PeakExpiratoryFlowRateDataType
Peak expiratory flow rate data type.
PeakExpiratoryFlowRateRecord
Represents a Peak Expiratory Flow Rate (PEFR) measurement.
Percentage
Represents a percentage value with automatic unit conversion.
PeripheralPerfusionIndexDataType
Peripheral perfusion index data type.
PeripheralPerfusionIndexRecord
Represents a peripheral perfusion index record.
Permission
Base interface for all permission types in the health client.
PermissionRequestResult
Represents the result of a single permission request.
PersistentIntermenstrualBleedingEventDataType
Represents the persistent intermenstrual bleeding event data type.
PersistentIntermenstrualBleedingEventRecord
Represents a persistent intermenstrual bleeding event record.
Power
Represents a power measurement with automatic unit conversion.
PowerSample
A single power measurement within a PowerSeriesRecord.
PowerSeriesDataType
Health data type for power information.
PowerSeriesRecord
Represents a power measurement over a time interval.
PregnancyDataType
Pregnancy data type.
PregnancyRecord
A record capturing the pregnancy period.
PregnancyTestDataType
Pregnancy test data type.
PregnancyTestRecord
Represents a pregnancy test result at a specific point in time.
Pressure
Represents a pressure measurement with automatic unit conversion.
PrintLogProcessor
A simple log processor that uses print() for console output.
ProgesteroneTestDataType
Progesterone test data type.
ProgesteroneTestRecord
Represents a progesterone test result at a specific point in time.
ProlongedMenstrualPeriodEventDataType
Represents the prolonged menstrual period event data type.
ProlongedMenstrualPeriodEventRecord
Represents a prolonged menstrual period event record.
ReadableByIdHealthDataType<R extends HealthRecord>
Interface that adds capability to read a health record by ID.
ReadableHealthDataType<R extends HealthRecord>
Interface that adds read capability to a health data type.
ReadableInTimeRangeHealthDataType<R extends HealthRecord>
Interface that adds capability to read health records within a time range.
ReadRecordByIdRequest<R extends HealthRecord>
Request to read a single health record by its ID.
ReadRecordsInTimeRangeRequest<R extends HealthRecord>
Request to read multiple health records within a time range.
ReadRecordsInTimeRangeResponse<R extends HealthRecord>
Response from reading multiple health records.
RespiratoryRateDataType
Respiratory rate data type.
RespiratoryRateRecord
Represents a respiratory rate measurement at a specific point in time.
RestingHeartRateDataType
Health data type for resting heart rate information.
RestingHeartRateRecord
Represents a resting heart rate measurement at a specific point in time.
RowingDistanceDataType
Rowing distance data type.
RowingDistanceRecord
Represents rowing distance over a time interval.
RunningGroundContactTimeDataType
Running Ground Contact Time data type.
RunningGroundContactTimeRecord
Represents a Running Ground Contact Time measurement over a time interval.
RunningPowerDataType
Represents the running power health data type.
RunningPowerRecord
Represents a running power measurement at a specific point in time.
RunningSpeedDataType
Running speed data type.
RunningSpeedRecord
Represents a running speed measurement at a specific point in time.
RunningStrideLengthDataType
Running Stride Length data type.
RunningStrideLengthRecord
Represents a Running Stride Length measurement over a time interval.
SeriesHealthRecord<T>
Base health record class containing multiple data samples within a time interval.
SexualActivityDataType
Sexual activity data type.
SexualActivityRecord
Represents a sexual activity occurrence.
SixMinuteWalkTestDistanceDataType
Six-minute walk test distance data type.
SixMinuteWalkTestDistanceRecord
Represents six-minute walk test distance.
SkatingSportsDistanceDataType
Skating sports distance data type.
SkatingSportsDistanceRecord
Represents skating sports distance over a time interval.
SkinTemperatureDeltaSample
Represents a single skin temperature delta measurement at a specific point in time.
SkinTemperatureDeltaSeriesDataType
Represents the Skin Temperature health data type.
SkinTemperatureDeltaSeriesRecord
Represents a series of skin temperature delta measurements over a time interval.
SleepingWristTemperatureDataType
Sleeping wrist temperature data type.
SleepingWristTemperatureRecord
Represents a sleeping wrist temperature measurement over a time interval.
SleepSessionDataType
Sleep session data type.
SleepSessionRecord
Represents a complete sleep session.
SleepStageDataType
Sleep stage data type.
SleepStageRecord
Represents a single sleep stage measurement.
SleepStageSample
Represents a single sleep stage period with time range.
SortDescriptor
Represents a sorting rule applied to a health record query.
SpeedActivityDataType<R extends SpeedActivityRecord>
Base class for activity-specific speed health data types.
SpeedActivityRecord
Base class for activity-specific speed records.
SpeedSample
A single speed measurement within a SpeedSeriesRecord.
SpeedSeriesDataType
Health data type for speed information.
SpeedSeriesRecord
Represents a speed measurement over a time interval.
StairAscentSpeedDataType
Stair ascent speed data type.
StairAscentSpeedRecord
Represents a stair ascent speed measurement at a specific point in time.
StairDescentSpeedDataType
Stair descent speed data type.
StairDescentSpeedRecord
Represents a stair descent speed measurement at a specific point in time.
StandardAggregateRequest<U extends MeasurementUnit>
Standard aggregate request for standard health data types.
StandTimeDataType
Apple Stand Time data type.
StandTimeRecord
Represents an Apple Stand Time measurement over a time interval.
StepsCadenceSample
Represents a single steps cadence sample at a specific point in time.
StepsCadenceSeriesDataType
Steps cadence series data type.
StepsCadenceSeriesRecord
Represents a series of steps cadence samples.
StepsDataType
Step count data type.
StepsRecord
Represents a step count record over a time interval.
SumAggregatableHealthDataType<U extends MeasurementUnit>
Interface that adds sum aggregation capability to a health data type.
SwimmingDistanceDataType
Swimming distance data type.
SwimmingDistanceRecord
Represents swimming distance over a time interval.
SwimmingStrokesDataType
Swimming strokes count data type.
SwimmingStrokesRecord
Represents a swimming stroke count record over a time interval.
SystolicBloodPressureDataType
Systolic blood pressure data type.
SystolicBloodPressureRecord
Represents a systolic blood pressure measurement at a specific point in time.
Temperature
Represents a temperature measurement with automatic unit conversion.
TimeDuration
Represents a duration measurement with automatic unit conversion.
TotalEnergyBurnedDataType
Represents the Total Calories Burned health data type.
TotalEnergyBurnedRecord
Represents the total energy burned over a time interval.
Velocity
Represents a velocity (speed) measurement with automatic unit conversion.
Vo2MaxDataType
VO₂ max data type.
Vo2MaxRecord
Represents a VO₂ max (maximal oxygen uptake) measurement at a specific point in time.
Volume
Represents a volume measurement with automatic unit conversion.
WaistCircumferenceDataType
Waist circumference data type.
WaistCircumferenceRecord
Represents a waist circumference measurement at a specific point in time.
WalkingAsymmetryPercentageDataType
Walking Asymmetry Percentage data type.
WalkingAsymmetryPercentageRecord
Represents a Walking Asymmetry Percentage measurement over a time interval.
WalkingDoubleSupportPercentageDataType
Walking Double Support Percentage data type.
WalkingDoubleSupportPercentageRecord
Represents a Walking Double Support Percentage measurement over a time interval.
WalkingHeartRateAverageDataType
Walking heart rate average data type.
WalkingHeartRateAverageRecord
Represents a user's average heart rate while walking over a time interval.
WalkingRunningDistanceDataType
Walking and running distance data type.
WalkingRunningDistanceRecord
Represents walking/running distance over a time interval.
WalkingSpeedDataType
Walking speed data type.
WalkingSpeedRecord
Represents a walking speed measurement at a specific point in time.
WalkingSteadinessDataType
Apple Walking Steadiness data type.
WalkingSteadinessEventDataType
Walking Steadiness Event data type.
WalkingSteadinessEventRecord
Walking Steadiness Event record.
WalkingSteadinessRecord
Represents an Apple Walking Steadiness measurement over a time interval.
WalkingStepLengthDataType
Walking Step Length data type.
WalkingStepLengthRecord
Represents a Walking Step Length measurement over a time interval.
WeightDataType
Body weight data type.
WeightRecord
Represents a body weight measurement at a specific point in time.
WheelchairDistanceDataType
Wheelchair distance data type.
WheelchairDistanceRecord
Represents wheelchair distance over a time interval.
WheelchairPushesDataType
Wheelchair pushes data type.
WheelchairPushesRecord
Represents wheelchair pushes over a time interval.
WriteableHealthDataType<R extends HealthRecord>
Interface that adds write permission capability to a health data type.

Enums

ActivityIntensityType
Activity intensity classification.
AggregationMetric
Defines the type of aggregation to perform on health data.
BasalBodyTemperatureMeasurementLocation
Represents the measurement location for a basal body temperature reading.
BloodGlucoseRelationToMeal
Represents the relationship of a blood glucose measurement to a meal.
BloodGlucoseSpecimenSource
Represents the source of the biological specimen used for the measurement.
BloodPressureBodyPosition
Represents the body position during a blood pressure measurement.
BloodPressureMeasurementLocation
Represents the measurement location for a blood pressure reading.
CervicalMucusAppearance
Cervical mucus appearance types.
CervicalMucusSensation
Cervical mucus sensation types.
ContraceptiveType
Represents different types of contraceptive methods.
DevicePlacementSide
Defines the placement side of a device used for health measurements.
DeviceType
The type of device that recorded the health data.
ExerciseSegmentType
Types of exercise segments within an exercise session.
ExerciseSessionStateTransitionType
Types of exercise state transitions.
ExerciseType
Represents different types of physical exercises.
HealthConnectorErrorCode
Error codes for HealthConnectorException.
HealthConnectorLogLevel
Enum representing the different log levels.
HealthDataPermissionAccessType
Defines the type of access being requested for a permission.
HealthDataTypeCategory
Categories for organizing health data types.
HealthPlatform
Represents the available health platform APIs.
HealthPlatformFeatureStatus
Represents the availability status of a platform feature.
HealthPlatformStatus
Represents the availability status of the health platform on the device.
InsulinDeliveryReason
Represents the reason for insulin delivery.
MealType
Meal type classification for nutrition and blood glucose records.
MenstrualFlow
Represents the intensity of menstrual flow.
MindfulnessSessionType
Type of mindfulness session.
OvulationTestResult
Represents the result of an ovulation test.
PermissionStatus
Represents the permission status.
PregnancyTestResult
Represents the result of a pregnancy test.
ProgesteroneTestResult
Represents the result of a progesterone test.
RecordingMethod
The method used to record health data.
SexualActivityProtectionUsed
Represents whether protection was used during sexual activity.
SkinTemperatureMeasurementLocation
Represents the measurement location for a skin temperature reading.
SleepStage
Represents the different types of sleep stages.
SortDirection
Defines the direction of the sort operation.
SortField
Defines the available fields by which health records can be sorted.
Vo2MaxTestType
Represents the test type or measurement method used to determine VO₂ max.
WalkingSteadinessType
The type of walking steadiness event.

Extensions

DoubleToMeasurementUnit on double
Extension on double to facilitate conversion to MeasurementUnit types based on HealthDataType.
ExerciseTypeExtension on ExerciseType
Extension on ExerciseType that provides static getters for platform-specific supported exercise types.
ObjectNameExtension on Object
Extensions to provide a consistent tag property for logging.
PermissionListExtension on List<Permission>
Extension methods for filtering List<Permission> by permission type.

Constants

experimentalApi → const _ExperimentalApi Annotations
Marks APIs as experimental and subject to change.
internalUse → const _InternalUse Annotations
Annotation to mark APIs for internal plugin ecosystem use only.
readOnly → const _ReadOnly Annotations
Annotation to mark health data types and records as read-only.
sinceV1_0_0 → const _Since Annotations
Marks APIs added in version 1.0.0 of the SDK.
sinceV1_1_0 → const _Since Annotations
Marks APIs added in version 1.1.0 of the SDK.
sinceV1_2_0 → const _Since Annotations
Marks APIs added in version 1.2.0 of the SDK.
sinceV1_3_0 → const _Since Annotations
Marks APIs added in version 1.3.0 of the SDK.
sinceV1_4_0 → const _Since Annotations
Marks APIs added in version 1.4.0 of the SDK.
sinceV2_0_0 → const _Since Annotations
Marks APIs added in version 2.0.0 of the SDK.
sinceV2_1_0 → const _Since Annotations
Marks APIs added in version 2.1.0 of the SDK.
sinceV2_2_0 → const _Since Annotations
Marks APIs added in version 2.2.0 of the SDK.
sinceV2_3_0 → const _Since Annotations
Marks APIs added in version 2.3.0 of the SDK.
sinceV2_3_1 → const _Since Annotations
Marks APIs added in version 2.3.1 of the SDK.
sinceV2_3_2 → const _Since Annotations
Marks APIs added in version 2.3.2 of the SDK.
sinceV2_4_0 → const _Since Annotations
Marks APIs added in version 2_4_0 of the SDK.
sinceV3_0_0 → const _Since Annotations
Marks APIs added in version 3.0.0 of the SDK.
sinceV3_0_1 → const _Since Annotations
Marks APIs added in version 3.0.1 of the SDK.
sinceV3_1_0 → const _Since Annotations
Marks APIs added in version 3.1.0 of the SDK.
sinceV3_2_0 → const _Since Annotations
Marks APIs added in version 3.2.0 of the SDK.
sinceV3_3_0 → const _Since Annotations
Marks APIs added in version 3.3.0 of the SDK.
sinceV3_4_0 → const _Since Annotations
Marks APIs added in version 3.4.0 of the SDK.
sinceV3_5_0 → const _Since Annotations
Marks APIs added in version 3.5.0 of the SDK.
sinceV3_6_0 → const _Since Annotations
Marks APIs added in version 3.6.0 of the SDK.
sinceV3_7_0 → const _Since Annotations
Marks APIs added in version 3.7.0 of the SDK.
sinceV3_8_0 → const _Since Annotations
Marks APIs added in version 3.8.0 of the SDK.
sinceV3_9_0 → const _Since Annotations
Marks APIs added in version 3.9.0 of the SDK.
supportedOnAppleHealth → const _SupportedOn Annotations
Convenience annotation for APIs supported only on iOS HealthKit.
supportedOnAppleHealthIOS16Plus → const _SupportedOn Annotations
Convenience annotation for APIs supported only on iOS 16+.
supportedOnAppleHealthIOS17Plus → const _SupportedOn Annotations
Convenience annotation for APIs supported only on iOS 17+.
supportedOnAppleHealthIOS18Plus → const _SupportedOn Annotations
Convenience annotation for APIs supported only on iOS 18+.
supportedOnHealthConnect → const _SupportedOn Annotations
Convenience annotation for APIs supported only on Android Health Connect.
supportedOnHealthConnectSdkExtension21 → const _SupportedOn Annotations
Convenience annotation for APIs that require Android Health Connect with SDK Extension 21 (Android 14+ with the Health Connect Mainline update).

Exceptions / Errors

AuthorizationException
Exception thrown when authorization/permission issues occur.
ConfigurationException
Exception thrown when app configuration is missing or invalid.
HealthConnectorException
Sealed exception class for all health connector plugin errors.
HealthServiceException
Exception thrown when health service operational errors occur.
HealthServiceUnavailableException
Exception thrown when health service is unavailable.
InvalidArgumentException
Exception thrown when an invalid argument is provided to the API.
UnknownException
Exception thrown when an unknown or unexpected error occurred.
UnsupportedOperationException
Exception thrown when an API not supported by the current platform or version is used.