One Logo Pool Ball
App Services · IOS API REFERENCE

HealthKit

Access and share health and fitness data while maintaining the user’s privacy and control.

299 types

1,337 callable entries

105 skipped

93% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

BufferedAsyncByteIterator

struct · iOS 16.0+

BufferedAsyncByteIterator.Element

typealias · iOS 16.0+

HKActivityMoveMode

enum · iOS 14.0+

HKActivityMoveModeObject

class · iOS 14.0+

HKActivitySummary

class · iOS 9.3+

HKActivitySummaryQuery

class

HKActivitySummaryQueryDescriptor

struct · iOS 15.4+

HKActivitySummaryQueryDescriptor.Output

typealias · iOS 15.4+

HKActivitySummaryQueryDescriptor.Results

struct · iOS 15.4+

HKActivitySummaryQueryDescriptor.Results.AsyncIterator

typealias · iOS 15.4+

HKActivitySummaryQueryDescriptor.Results.Element

typealias · iOS 15.4+

HKActivitySummaryQueryDescriptor.Results.Iterator

struct · iOS 15.4+

HKActivitySummaryQueryDescriptor.Results.Iterator.Element

typealias · iOS 15.4+

HKActivitySummaryQueryDescriptor.Sequence

typealias · iOS 15.4+

HKActivitySummaryType

class · iOS 9.3+

HKAnchoredObjectQuery

class

HKAnchoredObjectQueryDescriptor

struct · iOS 15.4+

HKAnchoredObjectQueryDescriptor.Output

typealias · iOS 15.4+

HKAnchoredObjectQueryDescriptor.Result

struct · iOS 15.4+

HKAnchoredObjectQueryDescriptor.Results

struct · iOS 15.4+

HKAnchoredObjectQueryDescriptor.Results.AsyncIterator

typealias · iOS 15.4+

HKAnchoredObjectQueryDescriptor.Results.Element

typealias · iOS 15.4+

HKAnchoredObjectQueryDescriptor.Results.Iterator

struct · iOS 15.4+

HKAnchoredObjectQueryDescriptor.Results.Iterator.Element

typealias · iOS 15.4+

HKAnchoredObjectQueryDescriptor.Sequence

typealias · iOS 15.4+

HKAppleECGAlgorithmVersion

enum · iOS 14.0+

HKAppleSleepingBreathingDisturbancesClassification

enum · iOS 18.0+

HKAppleSleepingBreathingDisturbancesClassification.AllCases

typealias · iOS 18.0+

HKAppleWalkingSteadinessClassification

enum · iOS 15.0+

HKAppleWalkingSteadinessClassification.AllCases

typealias · iOS 15.0+

HKAsyncQuery

protocol · iOS 15.4+

HKAsyncSequenceQuery

protocol · iOS 15.4+

HKAttachment

class · iOS 16.0+

HKAttachment.AsyncBytes

struct · iOS 16.0+

HKAttachment.AsyncBytes.AsyncIterator

typealias · iOS 16.0+

HKAttachment.AsyncBytes.Element

typealias · iOS 16.0+

HKAttachmentDataReader

class · iOS 16.0+

HKAttachmentStore

class · iOS 16.0+

HKAudiogramConductionType

enum · iOS 18.1+

HKAudiogramSample

class · iOS 13.0+

HKAudiogramSampleType

class · iOS 13.0+

HKAudiogramSensitivityPoint

class · iOS 13.0+

HKAudiogramSensitivityPointClampingRange

class · iOS 18.1+

HKAudiogramSensitivityTest

class · iOS 18.1+

HKAudiogramSensitivityTestSide

enum · iOS 18.1+

HKAuthorizationRequestStatus

enum · iOS 12.0+

HKAuthorizationStatus

enum · iOS 8.0+

HKBiologicalSex

enum · iOS 8.0+

HKBiologicalSexObject

class · iOS 8.0+

HKBloodGlucoseMealTime

enum · iOS 11.0+

HKBloodType

enum · iOS 8.0+

HKBloodTypeObject

class · iOS 8.0+

HKBodyTemperatureSensorLocation

enum · iOS 8.0+

HKCategorySample

class · iOS 8.0+

HKCategoryType

class · iOS 8.0+

HKCategoryTypeIdentifier

struct

HKCategoryValue

enum · iOS 9.0+

HKCategoryValueAppetiteChanges

enum · iOS 13.6+

HKCategoryValueAppleStandHour

enum · iOS 9.0+

HKCategoryValueAppleWalkingSteadinessEvent

enum · iOS 15.0+

HKCategoryValueAudioExposureEvent

enum · iOS 13.0+ · Deprecated in iOS 14.0

HKCategoryValueCervicalMucusQuality

enum · iOS 9.0+

HKCategoryValueContraceptive

enum · iOS 14.3+

HKCategoryValueEnvironmentalAudioExposureEvent

enum · iOS 14.0+

HKCategoryValueHeadphoneAudioExposureEvent

enum · iOS 14.2+

HKCategoryValueLowCardioFitnessEvent

enum · iOS 14.3+

HKCategoryValueMenopausalState

enum · iOS 27.0+

HKCategoryValueMenstrualFlow

enum · iOS 9.0+ · Deprecated in iOS 18.0

HKCategoryValueOvulationTestResult

enum · iOS 9.0+

HKCategoryValuePredicateProviding

protocol · iOS 16.0+

HKCategoryValuePregnancyTestResult

enum · iOS 15.0+

HKCategoryValuePresence

enum · iOS 13.6+

HKCategoryValueProgesteroneTestResult

enum · iOS 15.0+

HKCategoryValueSeverity

enum · iOS 13.6+

HKCategoryValueSleepAnalysis

enum · iOS 8.0+

HKCategoryValueVaginalBleeding

enum · iOS 18.0+

HKCDADocument

class · iOS 11.0+

HKCDADocumentSample

class · iOS 10.0+

HKCharacteristicType

class · iOS 8.0+

HKCharacteristicTypeIdentifier

struct

HKClinicalCoding

class · iOS 26.0+

HKClinicalRecord

class · iOS 12.0+

HKClinicalType

class · iOS 12.0+

HKClinicalTypeIdentifier

struct · iOS 12.0+

HKContactsLensSpecification

class · iOS 16.0+

HKContactsPrescription

class · iOS 16.0+

HKCorrelation

class · iOS 8.0+

HKCorrelationQuery

class · iOS 8.0+

HKCorrelationType

class · iOS 8.0+

HKCorrelationTypeIdentifier

struct

HKCumulativeQuantitySample

class · iOS 13.0+

HKCumulativeQuantitySeriesSample

class · iOS 12.0+ · Deprecated in iOS 13.0

HKCyclingFunctionalThresholdPowerTestType

enum · iOS 17.0+

HKDeletedObject

class · iOS 9.0+

HKDevice

class · iOS 9.0+

HKDevicePlacementSide

enum · iOS 14.0+

HKDiscreteQuantitySample

class · iOS 13.0+

HKDocumentQuery

class · iOS 10.0+

HKDocumentSample

class · iOS 10.0+

HKDocumentType

class · iOS 10.0+

HKDocumentTypeIdentifier

struct

HKElectrocardiogram

class · iOS 14.0+

HKElectrocardiogram.Classification

enum · iOS 14.0+

HKElectrocardiogram.Lead

enum · iOS 14.0+

HKElectrocardiogram.SymptomsStatus

enum · iOS 14.0+

HKElectrocardiogram.VoltageMeasurement

class · iOS 14.0+

HKElectrocardiogramQuery

class

HKElectrocardiogramQuery.Result

enum · iOS 14.0+

HKElectrocardiogramQueryDescriptor

struct · iOS 15.4+

HKElectrocardiogramQueryDescriptor.Results

struct · iOS 15.4+

HKElectrocardiogramQueryDescriptor.Results.AsyncIterator

typealias · iOS 15.4+

HKElectrocardiogramQueryDescriptor.Results.Element

typealias · iOS 15.4+

HKElectrocardiogramQueryDescriptor.Results.Iterator

struct · iOS 15.4+

HKElectrocardiogramQueryDescriptor.Results.Iterator.Element

typealias · iOS 15.4+

HKElectrocardiogramQueryDescriptor.Sequence

typealias · iOS 15.4+

HKElectrocardiogramType

class · iOS 14.0+

HKError

struct · iOS 8.0+

HKError.Code

enum · iOS 8.0+

HKFHIRRelease

struct

HKFHIRResource

class · iOS 12.0+

HKFHIRResourceType

struct · iOS 12.0+

HKFHIRVersion

class · iOS 14.0+

HKFitzpatrickSkinType

enum · iOS 9.0+

HKFitzpatrickSkinTypeObject

class · iOS 9.0+

HKGAD7Assessment

class · iOS 18.0+

HKGAD7Assessment.Answer

enum · iOS 18.0+

HKGAD7Assessment.Risk

enum · iOS 18.0+

HKGlassesLensSpecification

class · iOS 16.0+

HKGlassesPrescription

class · iOS 16.0+

HKHealthConceptDomain

struct · iOS 26.0+

HKHealthConceptIdentifier

class · iOS 26.0+

HKHealthStore

class · iOS 8.0+

HKHealthStore.HKUserPreferencesDidChangeMessage

struct · iOS 26.4+

HKHealthStore.HKUserPreferencesDidChangeMessage.Subject

typealias · iOS 26.4+

HKHeartbeatSeriesBuilder

class · iOS 13.0+

HKHeartbeatSeriesQuery

class

HKHeartbeatSeriesQueryDescriptor

struct · iOS 15.4+

HKHeartbeatSeriesQueryDescriptor.Heartbeat

struct · iOS 15.4+

HKHeartbeatSeriesQueryDescriptor.Results

struct · iOS 15.4+

HKHeartbeatSeriesQueryDescriptor.Results.AsyncIterator

typealias · iOS 15.4+

HKHeartbeatSeriesQueryDescriptor.Results.Element

typealias · iOS 15.4+

HKHeartbeatSeriesQueryDescriptor.Results.Iterator

struct · iOS 15.4+

HKHeartbeatSeriesQueryDescriptor.Results.Iterator.Element

typealias · iOS 15.4+

HKHeartbeatSeriesQueryDescriptor.Sequence

typealias · iOS 15.4+

HKHeartbeatSeriesSample

class · iOS 13.0+

HKHeartRateMotionContext

enum · iOS 11.0+

HKHeartRateRecoveryTestType

enum · iOS 16.0+

HKHeartRateSensorLocation

enum · iOS 8.0+

HKInsulinDeliveryReason

enum · iOS 11.0+

HKLensSpecification

class · iOS 16.0+

HKLiveWorkoutBuilder

class · iOS 26.0+

HKLiveWorkoutBuilderDelegate

protocol · iOS 26.0+

HKLiveWorkoutDataSource

class · iOS 26.0+

HKLiveWorkoutZoneUpdate

class · iOS 27.0+

HKMedicationConcept

class · iOS 26.0+

HKMedicationDoseEvent

class · iOS 26.0+

HKMedicationDoseEvent.LogStatus

enum · iOS 26.0+

HKMedicationDoseEvent.ScheduleType

enum · iOS 26.0+

HKMedicationDoseEventType

class · iOS 26.0+

HKMedicationGeneralForm

struct

HKMetricPrefix

enum · iOS 8.0+

HKObject

class · iOS 8.0+

HKObjectType

class · iOS 8.0+

HKObserverQuery

class · iOS 8.0+

HKObserverQueryCompletionHandler

typealias

HKPHQ9Assessment

class · iOS 18.0+

HKPHQ9Assessment.Answer

enum · iOS 18.0+

HKPHQ9Assessment.Risk

enum · iOS 18.0+

HKPhysicalEffortEstimationType

enum · iOS 17.0+

HKPrescriptionType

class · iOS 16.0+

HKPrismBase

enum · iOS 16.0+

HKQuantity

class · iOS 8.0+

HKQuantityAggregationStyle

enum · iOS 8.0+

HKQuantitySample

class · iOS 8.0+

HKQuantitySeriesSampleBuilder

class · iOS 12.0+

HKQuantitySeriesSampleQuery

class

HKQuantitySeriesSampleQueryDescriptor

struct · iOS 15.4+

HKQuantitySeriesSampleQueryDescriptor.Options

struct · iOS 15.4+

HKQuantitySeriesSampleQueryDescriptor.Options.ArrayLiteralElement

typealias · iOS 15.4+

HKQuantitySeriesSampleQueryDescriptor.Options.Element

typealias · iOS 15.4+

HKQuantitySeriesSampleQueryDescriptor.Options.RawValue

typealias · iOS 15.4+

HKQuantitySeriesSampleQueryDescriptor.Result

struct · iOS 15.4+

HKQuantitySeriesSampleQueryDescriptor.Results

struct · iOS 15.4+

HKQuantitySeriesSampleQueryDescriptor.Results.AsyncIterator

typealias · iOS 15.4+

HKQuantitySeriesSampleQueryDescriptor.Results.Element

typealias · iOS 15.4+

HKQuantitySeriesSampleQueryDescriptor.Results.Iterator

struct · iOS 15.4+

HKQuantitySeriesSampleQueryDescriptor.Results.Iterator.Element

typealias · iOS 15.4+

HKQuantitySeriesSampleQueryDescriptor.Sequence

typealias · iOS 15.4+

HKQuantityType

class · iOS 8.0+

HKQuantityTypeIdentifier

struct

HKQuery

class · iOS 8.0+

HKQueryAnchor

class · iOS 9.0+

HKQueryDescriptor

class · iOS 15.0+

HKQueryOptions

struct · iOS 8.0+

HKSample

class · iOS 8.0+

HKSamplePredicate

struct · iOS 15.4+

HKSampleQuery

class

HKSampleQueryDescriptor

struct · iOS 15.4+

HKSampleQueryDescriptor.Output

typealias · iOS 15.4+

HKSampleType

class · iOS 8.0+

HKScoredAssessment

class · iOS 18.0+

HKScoredAssessmentType

class · iOS 18.0+

HKScoredAssessmentTypeIdentifier

struct

HKSeriesBuilder

class

HKSeriesSample

class

HKSeriesType

class · iOS 11.0+

HKSource

class · iOS 8.0+

HKSourceQuery

class

HKSourceQueryDescriptor

struct · iOS 15.4+

HKSourceQueryDescriptor.Output

typealias · iOS 15.4+

HKSourceRevision

class · iOS 9.0+

HKStateOfMind

class · iOS 18.0+

HKStateOfMind.Association

enum · iOS 18.0+

HKStateOfMind.Kind

enum · iOS 18.0+

HKStateOfMind.Label

enum · iOS 18.0+

HKStateOfMind.ValenceClassification

enum · iOS 18.0+

HKStateOfMindType

class · iOS 18.0+

HKStatistics

class · iOS 8.0+

HKStatisticsCollection

class · iOS 8.0+

HKStatisticsCollectionQuery

class

HKStatisticsCollectionQueryDescriptor

struct · iOS 15.4+

HKStatisticsCollectionQueryDescriptor.Output

typealias · iOS 15.4+

HKStatisticsCollectionQueryDescriptor.Result

struct · iOS 15.4+

HKStatisticsCollectionQueryDescriptor.Results

struct · iOS 15.4+

HKStatisticsCollectionQueryDescriptor.Results.AsyncIterator

typealias · iOS 15.4+

HKStatisticsCollectionQueryDescriptor.Results.Element

typealias · iOS 15.4+

HKStatisticsCollectionQueryDescriptor.Results.Iterator

struct · iOS 15.4+

HKStatisticsCollectionQueryDescriptor.Results.Iterator.Element

typealias · iOS 15.4+

HKStatisticsCollectionQueryDescriptor.Sequence

typealias · iOS 15.4+

HKStatisticsOptions

struct · iOS 8.0+

HKStatisticsQuery

class

HKStatisticsQueryDescriptor

struct · iOS 15.4+

HKStatisticsQueryDescriptor.Output

typealias · iOS 15.4+

HKSwimmingStrokeStyle

enum · iOS 10.0+

HKUnit

class · iOS 8.0+

HKUpdateFrequency

enum · iOS 8.0+

HKUserAnnotatedMedication

class · iOS 26.0+

HKUserAnnotatedMedicationQuery

class · iOS 26.0+

HKUserAnnotatedMedicationQueryDescriptor

struct · iOS 26.0+

HKUserAnnotatedMedicationQueryDescriptor.Output

typealias · iOS 26.0+

HKUserAnnotatedMedicationType

class · iOS 26.0+

HKUserMotionContext

enum · iOS 16.0+

HKVerifiableClinicalRecord

class · iOS 15.0+

HKVerifiableClinicalRecordCredentialType

struct · iOS 15.4+

HKVerifiableClinicalRecordQuery

class

HKVerifiableClinicalRecordQueryDescriptor

struct · iOS 15.4+

HKVerifiableClinicalRecordQueryDescriptor.Output

typealias · iOS 15.4+

HKVerifiableClinicalRecordSourceType

struct · iOS 15.4+

HKVerifiableClinicalRecordSubject

class · iOS 15.0+

HKVisionEye

enum · iOS 16.0+

HKVisionPrescription

class · iOS 16.0+

HKVisionPrescriptionType

enum · iOS 16.0+

HKVisionPrism

class · iOS 16.0+

HKVO2MaxTestType

enum · iOS 11.0+

HKWaterSalinity

enum · iOS 17.0+

HKWeatherCondition

enum · iOS 10.0+

HKWheelchairUse

enum · iOS 10.0+

HKWheelchairUseObject

class · iOS 10.0+

HKWorkout

class · iOS 8.0+

HKWorkoutActivity

class · iOS 16.0+

HKWorkoutActivityType

enum · iOS 8.0+

HKWorkoutBuilder

class · iOS 12.0+

HKWorkoutConfiguration

class · iOS 10.0+

HKWorkoutEffortRelationship

class · iOS 18.0+

HKWorkoutEffortRelationshipQuery

class · iOS 18.0+

HKWorkoutEffortRelationshipQueryDescriptor

struct · iOS 18.0+

HKWorkoutEffortRelationshipQueryDescriptor.Output

typealias · iOS 18.0+

HKWorkoutEffortRelationshipQueryDescriptor.Result

struct · iOS 18.0+

HKWorkoutEffortRelationshipQueryDescriptor.Results

struct · iOS 18.0+

HKWorkoutEffortRelationshipQueryDescriptor.Results.AsyncIterator

typealias · iOS 18.0+

HKWorkoutEffortRelationshipQueryDescriptor.Results.Element

typealias · iOS 18.0+

HKWorkoutEffortRelationshipQueryDescriptor.Results.Iterator

struct · iOS 18.0+

HKWorkoutEffortRelationshipQueryDescriptor.Results.Iterator.Element

typealias · iOS 18.0+

HKWorkoutEffortRelationshipQueryDescriptor.Sequence

typealias · iOS 18.0+

HKWorkoutEffortRelationshipQueryOptions

enum · iOS 18.0+

HKWorkoutEvent

class · iOS 8.0+

HKWorkoutEventType

enum · iOS 8.0+

HKWorkoutRoute

class · iOS 11.0+

HKWorkoutRouteBuilder

class · iOS 11.0+

HKWorkoutRouteQuery

class

HKWorkoutRouteQueryDescriptor

struct · iOS 15.4+

HKWorkoutRouteQueryDescriptor.Results

struct · iOS 15.4+

HKWorkoutRouteQueryDescriptor.Results.AsyncIterator

typealias · iOS 15.4+

HKWorkoutRouteQueryDescriptor.Results.Element

typealias · iOS 15.4+

HKWorkoutRouteQueryDescriptor.Results.Iterator

struct · iOS 15.4+

HKWorkoutRouteQueryDescriptor.Results.Iterator.Element

typealias · iOS 15.4+

HKWorkoutRouteQueryDescriptor.Sequence

typealias · iOS 15.4+

HKWorkoutSession

class · iOS 17.0+

HKWorkoutSessionDelegate

protocol · iOS 17.0+

HKWorkoutSessionLocationType

enum · iOS 10.0+

HKWorkoutSessionState

enum · iOS 17.0+

HKWorkoutSessionType

enum · iOS 17.0+

HKWorkoutSwimmingLocationType

enum · iOS 10.0+

HKWorkoutType

class · iOS 8.0+

HKWorkoutZone

struct · iOS 27.0+

HKWorkoutZoneConfiguration

struct · iOS 27.0+

HKWorkoutZoneConfiguration.Source

enum · iOS 27.0+

HKWorkoutZoneDuration

struct · iOS 27.0+

HKWorkoutZoneGroup

struct · iOS 27.0+

Functions and constants

get · iOS 13.0+

HKDataTypeIdentifierHeartbeatSeries

TypeScript
const HKDataTypeIdentifierHeartbeatSeries: string
Swift declaration
let HKDataTypeIdentifierHeartbeatSeries: String
get · iOS 18.0+

HKDataTypeIdentifierStateOfMind

TypeScript
const HKDataTypeIdentifierStateOfMind: string
Swift declaration
let HKDataTypeIdentifierStateOfMind: String
get · iOS 26.0+

HKDataTypeIdentifierUserAnnotatedMedicationConcept

TypeScript
const HKDataTypeIdentifierUserAnnotatedMedicationConcept: string
Swift declaration
let HKDataTypeIdentifierUserAnnotatedMedicationConcept: String
get · iOS 10.0+

HKDetailedCDAValidationErrorKey

TypeScript
const HKDetailedCDAValidationErrorKey: string
Swift declaration
let HKDetailedCDAValidationErrorKey: String
get · iOS 9.0+

HKDevicePropertyKeyFirmwareVersion

TypeScript
const HKDevicePropertyKeyFirmwareVersion: string
Swift declaration
let HKDevicePropertyKeyFirmwareVersion: String
get · iOS 9.0+

HKDevicePropertyKeyHardwareVersion

TypeScript
const HKDevicePropertyKeyHardwareVersion: string
Swift declaration
let HKDevicePropertyKeyHardwareVersion: String
get · iOS 9.0+

HKDevicePropertyKeyLocalIdentifier

TypeScript
const HKDevicePropertyKeyLocalIdentifier: string
Swift declaration
let HKDevicePropertyKeyLocalIdentifier: String
get · iOS 9.0+

HKDevicePropertyKeyManufacturer

TypeScript
const HKDevicePropertyKeyManufacturer: string
Swift declaration
let HKDevicePropertyKeyManufacturer: String
get · iOS 9.0+

HKDevicePropertyKeyModel

TypeScript
const HKDevicePropertyKeyModel: string
Swift declaration
let HKDevicePropertyKeyModel: String
get · iOS 9.0+

HKDevicePropertyKeyName

TypeScript
const HKDevicePropertyKeyName: string
Swift declaration
let HKDevicePropertyKeyName: String
get · iOS 9.0+

HKDevicePropertyKeySoftwareVersion

TypeScript
const HKDevicePropertyKeySoftwareVersion: string
Swift declaration
let HKDevicePropertyKeySoftwareVersion: String
get · iOS 9.0+

HKDevicePropertyKeyUDIDeviceIdentifier

TypeScript
const HKDevicePropertyKeyUDIDeviceIdentifier: string
Swift declaration
let HKDevicePropertyKeyUDIDeviceIdentifier: String
get · iOS 8.0+

HKErrorDomain

TypeScript
const HKErrorDomain: string
Swift declaration
let HKErrorDomain: String
get · iOS 26.0+

HKMedicationDoseEventTypeIdentifierMedicationDoseEvent

TypeScript
const HKMedicationDoseEventTypeIdentifierMedicationDoseEvent: string
Swift declaration
let HKMedicationDoseEventTypeIdentifierMedicationDoseEvent: String
get · iOS 17.0+

HKMetadataKeyActivityType

TypeScript
const HKMetadataKeyActivityType: string
Swift declaration
let HKMetadataKeyActivityType: String
get · iOS 15.0+

HKMetadataKeyAlgorithmVersion

TypeScript
const HKMetadataKeyAlgorithmVersion: string
Swift declaration
let HKMetadataKeyAlgorithmVersion: String
get · iOS 11.2+

HKMetadataKeyAlpineSlopeGrade

TypeScript
const HKMetadataKeyAlpineSlopeGrade: string
Swift declaration
let HKMetadataKeyAlpineSlopeGrade: String
get · iOS 14.0+

HKMetadataKeyAppleDeviceCalibrated

TypeScript
const HKMetadataKeyAppleDeviceCalibrated: string
Swift declaration
let HKMetadataKeyAppleDeviceCalibrated: String
get · iOS 14.0+

HKMetadataKeyAppleECGAlgorithmVersion

TypeScript
const HKMetadataKeyAppleECGAlgorithmVersion: string
Swift declaration
let HKMetadataKeyAppleECGAlgorithmVersion: String
get · iOS 18.2+

HKMetadataKeyAppleFitnessPlusCatalogIdentifier

TypeScript
const HKMetadataKeyAppleFitnessPlusCatalogIdentifier: string
Swift declaration
let HKMetadataKeyAppleFitnessPlusCatalogIdentifier: String
get · iOS 17.0+

HKMetadataKeyAppleFitnessPlusSession

TypeScript
const HKMetadataKeyAppleFitnessPlusSession: string
Swift declaration
let HKMetadataKeyAppleFitnessPlusSession: String
get · iOS 14.2+

HKMetadataKeyAudioExposureDuration

TypeScript
const HKMetadataKeyAudioExposureDuration: string
Swift declaration
let HKMetadataKeyAudioExposureDuration: String
get · iOS 13.0+

HKMetadataKeyAudioExposureLevel

TypeScript
const HKMetadataKeyAudioExposureLevel: string
Swift declaration
let HKMetadataKeyAudioExposureLevel: String
get · iOS 13.0+

HKMetadataKeyAverageMETs

TypeScript
const HKMetadataKeyAverageMETs: string
Swift declaration
let HKMetadataKeyAverageMETs: String
get · iOS 11.2+

HKMetadataKeyAverageSpeed

TypeScript
const HKMetadataKeyAverageSpeed: string
Swift declaration
let HKMetadataKeyAverageSpeed: String
get · iOS 14.0+

HKMetadataKeyBarometricPressure

TypeScript
const HKMetadataKeyBarometricPressure: string
Swift declaration
let HKMetadataKeyBarometricPressure: String
get · iOS 11.0+

HKMetadataKeyBloodGlucoseMealTime

TypeScript
const HKMetadataKeyBloodGlucoseMealTime: string
Swift declaration
let HKMetadataKeyBloodGlucoseMealTime: String
get · iOS 8.0+

HKMetadataKeyBodyTemperatureSensorLocation

TypeScript
const HKMetadataKeyBodyTemperatureSensorLocation: string
Swift declaration
let HKMetadataKeyBodyTemperatureSensorLocation: String
get · iOS 8.0+

HKMetadataKeyCoachedWorkout

TypeScript
const HKMetadataKeyCoachedWorkout: string
Swift declaration
let HKMetadataKeyCoachedWorkout: String
get · iOS 12.0+

HKMetadataKeyCrossTrainerDistance

TypeScript
const HKMetadataKeyCrossTrainerDistance: string
Swift declaration
let HKMetadataKeyCrossTrainerDistance: String
get · iOS 17.0+

HKMetadataKeyCyclingFunctionalThresholdPowerTestType

TypeScript
const HKMetadataKeyCyclingFunctionalThresholdPowerTestType: string
Swift declaration
let HKMetadataKeyCyclingFunctionalThresholdPowerTestType: String
get · iOS 15.0+

HKMetadataKeyDateOfEarliestDataUsedForEstimate

TypeScript
const HKMetadataKeyDateOfEarliestDataUsedForEstimate: string
Swift declaration
let HKMetadataKeyDateOfEarliestDataUsedForEstimate: String
get · iOS 8.0+

HKMetadataKeyDeviceManufacturerName

TypeScript
const HKMetadataKeyDeviceManufacturerName: string
Swift declaration
let HKMetadataKeyDeviceManufacturerName: String
get · iOS 8.0+

HKMetadataKeyDeviceName

TypeScript
const HKMetadataKeyDeviceName: string
Swift declaration
let HKMetadataKeyDeviceName: String
get · iOS 14.0+

HKMetadataKeyDevicePlacementSide

TypeScript
const HKMetadataKeyDevicePlacementSide: string
Swift declaration
let HKMetadataKeyDevicePlacementSide: String
get · iOS 8.0+

HKMetadataKeyDeviceSerialNumber

TypeScript
const HKMetadataKeyDeviceSerialNumber: string
Swift declaration
let HKMetadataKeyDeviceSerialNumber: String
get · iOS 8.0+

HKMetadataKeyDigitalSignature

TypeScript
const HKMetadataKeyDigitalSignature: string
Swift declaration
let HKMetadataKeyDigitalSignature: String
get · iOS 11.2+

HKMetadataKeyElevationAscended

TypeScript
const HKMetadataKeyElevationAscended: string
Swift declaration
let HKMetadataKeyElevationAscended: String
get · iOS 11.2+

HKMetadataKeyElevationDescended

TypeScript
const HKMetadataKeyElevationDescended: string
Swift declaration
let HKMetadataKeyElevationDescended: String
get · iOS 8.0+

HKMetadataKeyExternalUUID

TypeScript
const HKMetadataKeyExternalUUID: string
Swift declaration
let HKMetadataKeyExternalUUID: String
get · iOS 12.0+

HKMetadataKeyFitnessMachineDuration

TypeScript
const HKMetadataKeyFitnessMachineDuration: string
Swift declaration
let HKMetadataKeyFitnessMachineDuration: String
get · iOS 8.0+

HKMetadataKeyFoodType

TypeScript
const HKMetadataKeyFoodType: string
Swift declaration
let HKMetadataKeyFoodType: String
get · iOS 16.0+

HKMetadataKeyGlassesPrescriptionDescription

TypeScript
const HKMetadataKeyGlassesPrescriptionDescription: string
Swift declaration
let HKMetadataKeyGlassesPrescriptionDescription: String
get · iOS 8.0+

HKMetadataKeyGroupFitness

TypeScript
const HKMetadataKeyGroupFitness: string
Swift declaration
let HKMetadataKeyGroupFitness: String
get · iOS 16.4+

HKMetadataKeyHeadphoneGain

TypeScript
const HKMetadataKeyHeadphoneGain: string
Swift declaration
let HKMetadataKeyHeadphoneGain: String
get · iOS 12.2+

HKMetadataKeyHeartRateEventThreshold

TypeScript
const HKMetadataKeyHeartRateEventThreshold: string
Swift declaration
let HKMetadataKeyHeartRateEventThreshold: String
get · iOS 11.0+

HKMetadataKeyHeartRateMotionContext

TypeScript
const HKMetadataKeyHeartRateMotionContext: string
Swift declaration
let HKMetadataKeyHeartRateMotionContext: String
get · iOS 16.0+

HKMetadataKeyHeartRateRecoveryActivityDuration

TypeScript
const HKMetadataKeyHeartRateRecoveryActivityDuration: string
Swift declaration
let HKMetadataKeyHeartRateRecoveryActivityDuration: String
get · iOS 16.0+

HKMetadataKeyHeartRateRecoveryActivityType

TypeScript
const HKMetadataKeyHeartRateRecoveryActivityType: string
Swift declaration
let HKMetadataKeyHeartRateRecoveryActivityType: String
get · iOS 16.0+

HKMetadataKeyHeartRateRecoveryMaxObservedRecoveryHeartRate

TypeScript
const HKMetadataKeyHeartRateRecoveryMaxObservedRecoveryHeartRate: string
Swift declaration
let HKMetadataKeyHeartRateRecoveryMaxObservedRecoveryHeartRate: String
get · iOS 16.0+

HKMetadataKeyHeartRateRecoveryTestType

TypeScript
const HKMetadataKeyHeartRateRecoveryTestType: string
Swift declaration
let HKMetadataKeyHeartRateRecoveryTestType: String
get · iOS 8.0+

HKMetadataKeyHeartRateSensorLocation

TypeScript
const HKMetadataKeyHeartRateSensorLocation: string
Swift declaration
let HKMetadataKeyHeartRateSensorLocation: String
get · iOS 12.0+

HKMetadataKeyIndoorBikeDistance

TypeScript
const HKMetadataKeyIndoorBikeDistance: string
Swift declaration
let HKMetadataKeyIndoorBikeDistance: String
get · iOS 8.0+

HKMetadataKeyIndoorWorkout

TypeScript
const HKMetadataKeyIndoorWorkout: string
Swift declaration
let HKMetadataKeyIndoorWorkout: String
get · iOS 11.0+

HKMetadataKeyInsulinDeliveryReason

TypeScript
const HKMetadataKeyInsulinDeliveryReason: string
Swift declaration
let HKMetadataKeyInsulinDeliveryReason: String
get · iOS 10.0+

HKMetadataKeyLapLength

TypeScript
const HKMetadataKeyLapLength: string
Swift declaration
let HKMetadataKeyLapLength: String
get · iOS 14.3+

HKMetadataKeyLowCardioFitnessEventThreshold

TypeScript
const HKMetadataKeyLowCardioFitnessEventThreshold: string
Swift declaration
let HKMetadataKeyLowCardioFitnessEventThreshold: String
get · iOS 17.0+

HKMetadataKeyMaximumLightIntensity

TypeScript
const HKMetadataKeyMaximumLightIntensity: string
Swift declaration
let HKMetadataKeyMaximumLightIntensity: String
get · iOS 11.2+

HKMetadataKeyMaximumSpeed

TypeScript
const HKMetadataKeyMaximumSpeed: string
Swift declaration
let HKMetadataKeyMaximumSpeed: String
get · iOS 9.0+

HKMetadataKeyMenstrualCycleStart

TypeScript
const HKMetadataKeyMenstrualCycleStart: string
Swift declaration
let HKMetadataKeyMenstrualCycleStart: String
get · iOS 17.0+

HKMetadataKeyPhysicalEffortEstimationType

TypeScript
const HKMetadataKeyPhysicalEffortEstimationType: string
Swift declaration
let HKMetadataKeyPhysicalEffortEstimationType: String
get · iOS 16.0+

HKMetadataKeyQuantityClampedToLowerBound

TypeScript
const HKMetadataKeyQuantityClampedToLowerBound: string
Swift declaration
let HKMetadataKeyQuantityClampedToLowerBound: String
get · iOS 16.0+

HKMetadataKeyQuantityClampedToUpperBound

TypeScript
const HKMetadataKeyQuantityClampedToUpperBound: string
Swift declaration
let HKMetadataKeyQuantityClampedToUpperBound: String
get · iOS 8.0+

HKMetadataKeyReferenceRangeLowerLimit

TypeScript
const HKMetadataKeyReferenceRangeLowerLimit: string
Swift declaration
let HKMetadataKeyReferenceRangeLowerLimit: String
get · iOS 8.0+

HKMetadataKeyReferenceRangeUpperLimit

TypeScript
const HKMetadataKeyReferenceRangeUpperLimit: string
Swift declaration
let HKMetadataKeyReferenceRangeUpperLimit: String
get · iOS 16.0+

HKMetadataKeySWOLFScore

TypeScript
const HKMetadataKeySWOLFScore: string
Swift declaration
let HKMetadataKeySWOLFScore: String
get · iOS 16.0+

HKMetadataKeySessionEstimate

TypeScript
const HKMetadataKeySessionEstimate: string
Swift declaration
let HKMetadataKeySessionEstimate: String
get · iOS 9.0+

HKMetadataKeySexualActivityProtectionUsed

TypeScript
const HKMetadataKeySexualActivityProtectionUsed: string
Swift declaration
let HKMetadataKeySexualActivityProtectionUsed: String
get · iOS 10.0+

HKMetadataKeySwimmingLocationType

TypeScript
const HKMetadataKeySwimmingLocationType: string
Swift declaration
let HKMetadataKeySwimmingLocationType: String
get · iOS 10.0+

HKMetadataKeySwimmingStrokeStyle

TypeScript
const HKMetadataKeySwimmingStrokeStyle: string
Swift declaration
let HKMetadataKeySwimmingStrokeStyle: String
get · iOS 11.0+

HKMetadataKeySyncIdentifier

TypeScript
const HKMetadataKeySyncIdentifier: string
Swift declaration
let HKMetadataKeySyncIdentifier: String
get · iOS 11.0+

HKMetadataKeySyncVersion

TypeScript
const HKMetadataKeySyncVersion: string
Swift declaration
let HKMetadataKeySyncVersion: String
get · iOS 8.0+

HKMetadataKeyTimeZone

TypeScript
const HKMetadataKeyTimeZone: string
Swift declaration
let HKMetadataKeyTimeZone: String
get · iOS 8.0+

HKMetadataKeyUDIDeviceIdentifier

TypeScript
const HKMetadataKeyUDIDeviceIdentifier: string
Swift declaration
let HKMetadataKeyUDIDeviceIdentifier: String
get · iOS 8.0+

HKMetadataKeyUDIProductionIdentifier

TypeScript
const HKMetadataKeyUDIProductionIdentifier: string
Swift declaration
let HKMetadataKeyUDIProductionIdentifier: String
get · iOS 16.0+

HKMetadataKeyUserMotionContext

TypeScript
const HKMetadataKeyUserMotionContext: string
Swift declaration
let HKMetadataKeyUserMotionContext: String
get · iOS 11.0+

HKMetadataKeyVO2MaxTestType

TypeScript
const HKMetadataKeyVO2MaxTestType: string
Swift declaration
let HKMetadataKeyVO2MaxTestType: String
get · iOS 14.3+

HKMetadataKeyVO2MaxValue

TypeScript
const HKMetadataKeyVO2MaxValue: string
Swift declaration
let HKMetadataKeyVO2MaxValue: String
get · iOS 8.0+

HKMetadataKeyWasTakenInLab

TypeScript
const HKMetadataKeyWasTakenInLab: string
Swift declaration
let HKMetadataKeyWasTakenInLab: String
get · iOS 8.0+

HKMetadataKeyWasUserEntered

TypeScript
const HKMetadataKeyWasUserEntered: string
Swift declaration
let HKMetadataKeyWasUserEntered: String
get · iOS 17.0+

HKMetadataKeyWaterSalinity

TypeScript
const HKMetadataKeyWaterSalinity: string
Swift declaration
let HKMetadataKeyWaterSalinity: String
get · iOS 10.0+

HKMetadataKeyWeatherCondition

TypeScript
const HKMetadataKeyWeatherCondition: string
Swift declaration
let HKMetadataKeyWeatherCondition: String
get · iOS 10.0+

HKMetadataKeyWeatherHumidity

TypeScript
const HKMetadataKeyWeatherHumidity: string
Swift declaration
let HKMetadataKeyWeatherHumidity: String
get · iOS 10.0+

HKMetadataKeyWeatherTemperature

TypeScript
const HKMetadataKeyWeatherTemperature: string
Swift declaration
let HKMetadataKeyWeatherTemperature: String
get · iOS 8.0+

HKMetadataKeyWorkoutBrandName

TypeScript
const HKMetadataKeyWorkoutBrandName: string
Swift declaration
let HKMetadataKeyWorkoutBrandName: String
get

HKObjectQueryNoLimit

TypeScript
const HKObjectQueryNoLimit: number
Swift declaration
var HKObjectQueryNoLimit: Int { get }
get · iOS 13.0+

HKPredicateKeyPathAverage

TypeScript
const HKPredicateKeyPathAverage: string
Swift declaration
let HKPredicateKeyPathAverage: String
get · iOS 14.0+

HKPredicateKeyPathAverageHeartRate

TypeScript
const HKPredicateKeyPathAverageHeartRate: string
Swift declaration
let HKPredicateKeyPathAverageHeartRate: String
get · iOS 10.0+

HKPredicateKeyPathCDAAuthorName

TypeScript
const HKPredicateKeyPathCDAAuthorName: string
Swift declaration
let HKPredicateKeyPathCDAAuthorName: String
get · iOS 10.0+

HKPredicateKeyPathCDACustodianName

TypeScript
const HKPredicateKeyPathCDACustodianName: string
Swift declaration
let HKPredicateKeyPathCDACustodianName: String
get · iOS 10.0+

HKPredicateKeyPathCDAPatientName

TypeScript
const HKPredicateKeyPathCDAPatientName: string
Swift declaration
let HKPredicateKeyPathCDAPatientName: String
get · iOS 10.0+

HKPredicateKeyPathCDATitle

TypeScript
const HKPredicateKeyPathCDATitle: string
Swift declaration
let HKPredicateKeyPathCDATitle: String
get · iOS 8.0+

HKPredicateKeyPathCategoryValue

TypeScript
const HKPredicateKeyPathCategoryValue: string
Swift declaration
let HKPredicateKeyPathCategoryValue: String
get · iOS 12.0+

HKPredicateKeyPathClinicalRecordFHIRResourceIdentifier

TypeScript
const HKPredicateKeyPathClinicalRecordFHIRResourceIdentifier: string
Swift declaration
let HKPredicateKeyPathClinicalRecordFHIRResourceIdentifier: String
get · iOS 12.0+

HKPredicateKeyPathClinicalRecordFHIRResourceType

TypeScript
const HKPredicateKeyPathClinicalRecordFHIRResourceType: string
Swift declaration
let HKPredicateKeyPathClinicalRecordFHIRResourceType: String
get · iOS 8.0+

HKPredicateKeyPathCorrelation

TypeScript
const HKPredicateKeyPathCorrelation: string
Swift declaration
let HKPredicateKeyPathCorrelation: String
get · iOS 13.0+

HKPredicateKeyPathCount

TypeScript
const HKPredicateKeyPathCount: string
Swift declaration
let HKPredicateKeyPathCount: String
get · iOS 9.3+

HKPredicateKeyPathDateComponents

TypeScript
const HKPredicateKeyPathDateComponents: string
Swift declaration
let HKPredicateKeyPathDateComponents: String
get · iOS 9.0+

HKPredicateKeyPathDevice

TypeScript
const HKPredicateKeyPathDevice: string
Swift declaration
let HKPredicateKeyPathDevice: String
get · iOS 14.0+

HKPredicateKeyPathECGClassification

TypeScript
const HKPredicateKeyPathECGClassification: string
Swift declaration
let HKPredicateKeyPathECGClassification: String
get · iOS 14.0+

HKPredicateKeyPathECGSymptomsStatus

TypeScript
const HKPredicateKeyPathECGSymptomsStatus: string
Swift declaration
let HKPredicateKeyPathECGSymptomsStatus: String
get · iOS 8.0+

HKPredicateKeyPathEndDate

TypeScript
const HKPredicateKeyPathEndDate: string
Swift declaration
let HKPredicateKeyPathEndDate: String
get · iOS 26.0+

HKPredicateKeyPathLogOrigin

TypeScript
const HKPredicateKeyPathLogOrigin: string
Swift declaration
let HKPredicateKeyPathLogOrigin: String
get · iOS 13.0+

HKPredicateKeyPathMax

TypeScript
const HKPredicateKeyPathMax: string
Swift declaration
let HKPredicateKeyPathMax: String
get · iOS 26.0+

HKPredicateKeyPathMedicationConceptIdentifier

TypeScript
const HKPredicateKeyPathMedicationConceptIdentifier: string
Swift declaration
let HKPredicateKeyPathMedicationConceptIdentifier: String
get · iOS 8.0+

HKPredicateKeyPathMetadata

TypeScript
const HKPredicateKeyPathMetadata: string
Swift declaration
let HKPredicateKeyPathMetadata: String
get · iOS 13.0+

HKPredicateKeyPathMin

TypeScript
const HKPredicateKeyPathMin: string
Swift declaration
let HKPredicateKeyPathMin: String
get · iOS 13.0+

HKPredicateKeyPathMostRecent

TypeScript
const HKPredicateKeyPathMostRecent: string
Swift declaration
let HKPredicateKeyPathMostRecent: String
get · iOS 13.0+

HKPredicateKeyPathMostRecentDuration

TypeScript
const HKPredicateKeyPathMostRecentDuration: string
Swift declaration
let HKPredicateKeyPathMostRecentDuration: String
get · iOS 13.0+

HKPredicateKeyPathMostRecentEndDate

TypeScript
const HKPredicateKeyPathMostRecentEndDate: string
Swift declaration
let HKPredicateKeyPathMostRecentEndDate: String
get · iOS 13.0+

HKPredicateKeyPathMostRecentStartDate

TypeScript
const HKPredicateKeyPathMostRecentStartDate: string
Swift declaration
let HKPredicateKeyPathMostRecentStartDate: String
get · iOS 8.0+

HKPredicateKeyPathQuantity

TypeScript
const HKPredicateKeyPathQuantity: string
Swift declaration
let HKPredicateKeyPathQuantity: String
get · iOS 26.0+

HKPredicateKeyPathScheduledDate

TypeScript
const HKPredicateKeyPathScheduledDate: string
Swift declaration
let HKPredicateKeyPathScheduledDate: String
get · iOS 8.0+

HKPredicateKeyPathSource

TypeScript
const HKPredicateKeyPathSource: string
Swift declaration
let HKPredicateKeyPathSource: String
get · iOS 9.0+

HKPredicateKeyPathSourceRevision

TypeScript
const HKPredicateKeyPathSourceRevision: string
Swift declaration
let HKPredicateKeyPathSourceRevision: String
get · iOS 8.0+

HKPredicateKeyPathStartDate

TypeScript
const HKPredicateKeyPathStartDate: string
Swift declaration
let HKPredicateKeyPathStartDate: String
get · iOS 26.0+

HKPredicateKeyPathStatus

TypeScript
const HKPredicateKeyPathStatus: string
Swift declaration
let HKPredicateKeyPathStatus: String
get · iOS 12.0+

HKPredicateKeyPathSum

TypeScript
const HKPredicateKeyPathSum: string
Swift declaration
let HKPredicateKeyPathSum: String
get · iOS 8.0+

HKPredicateKeyPathUUID

TypeScript
const HKPredicateKeyPathUUID: string
Swift declaration
let HKPredicateKeyPathUUID: String
get · iOS 8.0+

HKPredicateKeyPathWorkout

TypeScript
const HKPredicateKeyPathWorkout: string
Swift declaration
let HKPredicateKeyPathWorkout: String
get · iOS 16.0+

HKPredicateKeyPathWorkoutActivity

TypeScript
const HKPredicateKeyPathWorkoutActivity: string
Swift declaration
let HKPredicateKeyPathWorkoutActivity: String
get · iOS 16.0+

HKPredicateKeyPathWorkoutActivityAverageQuantity

TypeScript
const HKPredicateKeyPathWorkoutActivityAverageQuantity: string
Swift declaration
let HKPredicateKeyPathWorkoutActivityAverageQuantity: String
get · iOS 16.0+

HKPredicateKeyPathWorkoutActivityDuration

TypeScript
const HKPredicateKeyPathWorkoutActivityDuration: string
Swift declaration
let HKPredicateKeyPathWorkoutActivityDuration: String
get · iOS 16.0+

HKPredicateKeyPathWorkoutActivityEndDate

TypeScript
const HKPredicateKeyPathWorkoutActivityEndDate: string
Swift declaration
let HKPredicateKeyPathWorkoutActivityEndDate: String
get · iOS 16.0+

HKPredicateKeyPathWorkoutActivityMaximumQuantity

TypeScript
const HKPredicateKeyPathWorkoutActivityMaximumQuantity: string
Swift declaration
let HKPredicateKeyPathWorkoutActivityMaximumQuantity: String
get · iOS 16.0+

HKPredicateKeyPathWorkoutActivityMinimumQuantity

TypeScript
const HKPredicateKeyPathWorkoutActivityMinimumQuantity: string
Swift declaration
let HKPredicateKeyPathWorkoutActivityMinimumQuantity: String
get · iOS 16.0+

HKPredicateKeyPathWorkoutActivityStartDate

TypeScript
const HKPredicateKeyPathWorkoutActivityStartDate: string
Swift declaration
let HKPredicateKeyPathWorkoutActivityStartDate: String
get · iOS 16.0+

HKPredicateKeyPathWorkoutActivitySumQuantity

TypeScript
const HKPredicateKeyPathWorkoutActivitySumQuantity: string
Swift declaration
let HKPredicateKeyPathWorkoutActivitySumQuantity: String
get · iOS 16.0+

HKPredicateKeyPathWorkoutActivityType

TypeScript
const HKPredicateKeyPathWorkoutActivityType: string
Swift declaration
let HKPredicateKeyPathWorkoutActivityType: String
get · iOS 16.0+

HKPredicateKeyPathWorkoutAverageQuantity

TypeScript
const HKPredicateKeyPathWorkoutAverageQuantity: string
Swift declaration
let HKPredicateKeyPathWorkoutAverageQuantity: String
get · iOS 8.0+

HKPredicateKeyPathWorkoutDuration

TypeScript
const HKPredicateKeyPathWorkoutDuration: string
Swift declaration
let HKPredicateKeyPathWorkoutDuration: String
get · iOS 18.0+

HKPredicateKeyPathWorkoutEffortRelationship

TypeScript
const HKPredicateKeyPathWorkoutEffortRelationship: string
Swift declaration
let HKPredicateKeyPathWorkoutEffortRelationship: String
get · iOS 16.0+

HKPredicateKeyPathWorkoutMaximumQuantity

TypeScript
const HKPredicateKeyPathWorkoutMaximumQuantity: string
Swift declaration
let HKPredicateKeyPathWorkoutMaximumQuantity: String
get · iOS 16.0+

HKPredicateKeyPathWorkoutMinimumQuantity

TypeScript
const HKPredicateKeyPathWorkoutMinimumQuantity: string
Swift declaration
let HKPredicateKeyPathWorkoutMinimumQuantity: String
get · iOS 16.0+

HKPredicateKeyPathWorkoutSumQuantity

TypeScript
const HKPredicateKeyPathWorkoutSumQuantity: string
Swift declaration
let HKPredicateKeyPathWorkoutSumQuantity: String
get · iOS 8.0+ · Deprecated in iOS 100000.0

HKPredicateKeyPathWorkoutTotalDistance

TypeScript
const HKPredicateKeyPathWorkoutTotalDistance: string
Swift declaration
let HKPredicateKeyPathWorkoutTotalDistance: String
get · iOS 8.0+ · Deprecated in iOS 18.0

HKPredicateKeyPathWorkoutTotalEnergyBurned

TypeScript
const HKPredicateKeyPathWorkoutTotalEnergyBurned: string
Swift declaration
let HKPredicateKeyPathWorkoutTotalEnergyBurned: String
get · iOS 11.0+ · Deprecated in iOS 18.0

HKPredicateKeyPathWorkoutTotalFlightsClimbed

TypeScript
const HKPredicateKeyPathWorkoutTotalFlightsClimbed: string
Swift declaration
let HKPredicateKeyPathWorkoutTotalFlightsClimbed: String
get · iOS 10.0+ · Deprecated in iOS 18.0

HKPredicateKeyPathWorkoutTotalSwimmingStrokeCount

TypeScript
const HKPredicateKeyPathWorkoutTotalSwimmingStrokeCount: string
Swift declaration
let HKPredicateKeyPathWorkoutTotalSwimmingStrokeCount: String
get · iOS 8.0+

HKPredicateKeyPathWorkoutType

TypeScript
const HKPredicateKeyPathWorkoutType: string
Swift declaration
let HKPredicateKeyPathWorkoutType: String
get · iOS 8.0+

HKSampleSortIdentifierEndDate

TypeScript
const HKSampleSortIdentifierEndDate: string
Swift declaration
let HKSampleSortIdentifierEndDate: String
get · iOS 8.0+

HKSampleSortIdentifierStartDate

TypeScript
const HKSampleSortIdentifierStartDate: string
Swift declaration
let HKSampleSortIdentifierStartDate: String
get · iOS 11.0+

HKSourceRevisionAnyOperatingSystem

TypeScript
const HKSourceRevisionAnyOperatingSystem: _Foundation_OperatingSystemVersion
Swift declaration
let HKSourceRevisionAnyOperatingSystem: OperatingSystemVersion
get · iOS 11.0+

HKSourceRevisionAnyProductType

TypeScript
const HKSourceRevisionAnyProductType: string
Swift declaration
let HKSourceRevisionAnyProductType: String
get · iOS 11.0+

HKSourceRevisionAnyVersion

TypeScript
const HKSourceRevisionAnyVersion: string
Swift declaration
let HKSourceRevisionAnyVersion: String
get · iOS 26.0+

HKUserAnnotatedMedicationPredicateKeyPathHasSchedule

TypeScript
const HKUserAnnotatedMedicationPredicateKeyPathHasSchedule: string
Swift declaration
let HKUserAnnotatedMedicationPredicateKeyPathHasSchedule: String
get · iOS 26.0+

HKUserAnnotatedMedicationPredicateKeyPathIsArchived

TypeScript
const HKUserAnnotatedMedicationPredicateKeyPathIsArchived: string
Swift declaration
let HKUserAnnotatedMedicationPredicateKeyPathIsArchived: String
get · iOS 8.2+

HKUserPreferencesDidChange

TypeScript
get HKUserPreferencesDidChange(): _Foundation_NSNotification_Name
Swift declaration
static let HKUserPreferencesDidChange: NSNotification.Name
get · iOS 16.0+

HKVisionPrescriptionTypeIdentifier

TypeScript
const HKVisionPrescriptionTypeIdentifier: string
Swift declaration
let HKVisionPrescriptionTypeIdentifier: String
get · iOS 11.0+

HKWorkoutRouteTypeIdentifier

TypeScript
const HKWorkoutRouteTypeIdentifier: string
Swift declaration
let HKWorkoutRouteTypeIdentifier: String
get · iOS 8.0+

HKWorkoutSortIdentifierDuration

TypeScript
const HKWorkoutSortIdentifierDuration: string
Swift declaration
let HKWorkoutSortIdentifierDuration: String
get · iOS 8.0+

HKWorkoutSortIdentifierTotalDistance

TypeScript
const HKWorkoutSortIdentifierTotalDistance: string
Swift declaration
let HKWorkoutSortIdentifierTotalDistance: String
get · iOS 8.0+

HKWorkoutSortIdentifierTotalEnergyBurned

TypeScript
const HKWorkoutSortIdentifierTotalEnergyBurned: string
Swift declaration
let HKWorkoutSortIdentifierTotalEnergyBurned: String
get · iOS 11.0+

HKWorkoutSortIdentifierTotalFlightsClimbed

TypeScript
const HKWorkoutSortIdentifierTotalFlightsClimbed: string
Swift declaration
let HKWorkoutSortIdentifierTotalFlightsClimbed: String
get · iOS 10.0+

HKWorkoutSortIdentifierTotalSwimmingStrokeCount

TypeScript
const HKWorkoutSortIdentifierTotalSwimmingStrokeCount: string
Swift declaration
let HKWorkoutSortIdentifierTotalSwimmingStrokeCount: String
get · iOS 8.0+

HKWorkoutTypeIdentifier

TypeScript
const HKWorkoutTypeIdentifier: string
Swift declaration
let HKWorkoutTypeIdentifier: String
get

HKAnchoredObjectQueryNoAnchor

TypeScript
const HKAnchoredObjectQueryNoAnchor: number
Swift declaration
var HKAnchoredObjectQueryNoAnchor: Int32 { get }
get

HKUnitMolarMassBloodGlucose

TypeScript
const HKUnitMolarMassBloodGlucose: number
Swift declaration
var HKUnitMolarMassBloodGlucose: Double { get }
get · iOS 15.4+

nsPredicate

TypeScript
get nsPredicate(): (_Foundation_NSPredicate) | null
Swift declaration
nonisolated(unsafe) let nsPredicate: NSPredicate?

If non-nil, this `NSPredicate` further restricts which samples that match the receiver.

get · iOS 15.4+

sampleType

TypeScript
get sampleType(): HKSampleType
Swift declaration
let sampleType: HKSampleType

The value of the `sampleType` property of the samples that match the receiver.

static · iOS 15.4+

correlation

TypeScript
static correlation(correlationType: HKCorrelationType, predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKCorrelation>
Swift declaration
static func correlation(type correlationType: HKCorrelationType, predicate: NSPredicate? = nil) -> HKSamplePredicate<HKCorrelation>

Returns a sample predicate matching instances of `HKCorrelation`.

static · iOS 18.0+

stateOfMind

TypeScript
static stateOfMind(predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKStateOfMind>
Swift declaration
static func stateOfMind(_ predicate: NSPredicate? = nil) -> HKSamplePredicate<HKStateOfMind>

Returns a sample predicate matching instances of `HKStateOfMind`.

static · iOS 15.4+

workoutRoute

TypeScript
static workoutRoute(predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKWorkoutRoute>
Swift declaration
static func workoutRoute(_ predicate: NSPredicate? = nil) -> HKSamplePredicate<HKWorkoutRoute>

Returns a sample predicate matching instances of `HKWorkoutRoute`.

static · iOS 15.4+

categorySample

TypeScript
static categorySample(categoryType: HKCategoryType, predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKCategorySample>
Swift declaration
static func categorySample(type categoryType: HKCategoryType, predicate: NSPredicate? = nil) -> HKSamplePredicate<HKCategorySample>

Returns a sample predicate matching instances of `HKCategorySample`.

static · iOS 15.4+

clinicalRecord

TypeScript
static clinicalRecord(clinicalType: HKClinicalType, predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKClinicalRecord>
Swift declaration
static func clinicalRecord(type clinicalType: HKClinicalType, predicate: NSPredicate? = nil) -> HKSamplePredicate<HKClinicalRecord>

Returns a sample predicate matching instances of `HKClinicalRecord`.

static · iOS 18.0+

gad7Assessment

TypeScript
static gad7Assessment(predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKGAD7Assessment>
Swift declaration
static func gad7Assessment(_ predicate: NSPredicate? = nil) -> HKSamplePredicate<HKGAD7Assessment>
static · iOS 18.0+

phq9Assessment

TypeScript
static phq9Assessment(predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKPHQ9Assessment>
Swift declaration
static func phq9Assessment(_ predicate: NSPredicate? = nil) -> HKSamplePredicate<HKPHQ9Assessment>
static · iOS 15.4+

quantitySample

TypeScript
static quantitySample(quantityType: HKQuantityType, predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKQuantitySample>
Swift declaration
static func quantitySample(type quantityType: HKQuantityType, predicate: NSPredicate? = nil) -> HKSamplePredicate<HKQuantitySample>

Returns a sample predicate matching instances of `HKQuantitySample`.

static · iOS 15.4+

heartbeatSeries

TypeScript
static heartbeatSeries(predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKHeartbeatSeriesSample>
Swift declaration
static func heartbeatSeries(_ predicate: NSPredicate? = nil) -> HKSamplePredicate<HKHeartbeatSeriesSample>

Returns a sample predicate matching instances of `HKHeartbeatSeriesSample`.

static · iOS 15.4+

electrocardiogram

TypeScript
static electrocardiogram(predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKElectrocardiogram>
Swift declaration
static func electrocardiogram(_ predicate: NSPredicate? = nil) -> HKSamplePredicate<HKElectrocardiogram>

Returns a sample predicate matching instances of `HKElectrocardiogram`.

static · iOS 16.0+

visionPrescription

TypeScript
static visionPrescription(predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKVisionPrescription>
Swift declaration
static func visionPrescription(_ predicate: NSPredicate? = nil) -> HKSamplePredicate<HKVisionPrescription>

Returns a sample predicate matching instances of `HKVisionPrescription`.

static · iOS 15.4+

sample

TypeScript
static sample(sampleType: HKSampleType, predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKSample>
Swift declaration
static func sample(type sampleType: HKSampleType, predicate: NSPredicate? = nil) -> HKSamplePredicate<HKSample>

Returns a sample predicate matching instances of `HKSample` with the given sample type. Use this to construct predicates for a query that will return a collection of samples with heterogenous subclasses of `HKSample`.

static · iOS 15.4+

workout

TypeScript
static workout(predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKWorkout>
Swift declaration
static func workout(_ predicate: NSPredicate? = nil) -> HKSamplePredicate<HKWorkout>

Returns a sample predicate matching instances of `HKWorkout`.

static · iOS 15.4+

audiogram

TypeScript
static audiogram(predicate?: (_Foundation_NSPredicate) | null): HKSamplePredicate<HKAudiogramSample>
Swift declaration
static func audiogram(_ predicate: NSPredicate? = nil) -> HKSamplePredicate<HKAudiogramSample>

Returns a sample predicate matching instances of `HKAudiogramSample`.

init · iOS 15.4+

init

TypeScript
static init(predicates: Array<HKSamplePredicate<HKSample>>, sortDescriptors: Array<_Foundation_SortDescriptor<HKSample>>, limit?: (number) | null): HKSampleQueryDescriptor<HKSample>
Swift declaration
init(predicates: [HKSamplePredicate<Sample>], sortDescriptors: [SortDescriptor<Sample>], limit: Int? = nil)
get · iOS 15.4+

predicates

TypeScript
get predicates(): Array<HKSamplePredicate<HKSample>>
Swift declaration
var predicates: [HKSamplePredicate<Sample>] { get set }

The predicates that match the desired samples. If there is more than one predicate then they are combined using a disjunction. May not be empty.

set · iOS 15.4+

predicates

TypeScript
set predicates(value: Array<HKSamplePredicate<HKSample>>)
Swift declaration
var predicates: [HKSamplePredicate<Sample>] { get set }

The predicates that match the desired samples. If there is more than one predicate then they are combined using a disjunction. May not be empty.

get · iOS 15.4+

sortDescriptors

TypeScript
get sortDescriptors(): Array<_Foundation_SortDescriptor<HKSample>>
Swift declaration
var sortDescriptors: [SortDescriptor<Sample>]

The descriptors controlling the sort order of the resulting samples. May be empty, in which case samples are returned in an undefined order.

set · iOS 15.4+

sortDescriptors

TypeScript
set sortDescriptors(value: Array<_Foundation_SortDescriptor<HKSample>>)
Swift declaration
var sortDescriptors: [SortDescriptor<Sample>]

The descriptors controlling the sort order of the resulting samples. May be empty, in which case samples are returned in an undefined order.

get · iOS 15.4+

limit

TypeScript
get limit(): (number) | null
Swift declaration
var limit: Int?

The maximum number of resulting samples.

set · iOS 15.4+

limit

TypeScript
set limit(value: (number) | null)
Swift declaration
var limit: Int?

The maximum number of resulting samples.

method · iOS 15.4+

result

TypeScript
result(healthStore: HKHealthStore): Promise<Array<HKSample>>
Swift declaration
func result(for healthStore: HKHealthStore) async throws -> [Sample]

Returns the samples matching the reciever. If the `sortDescriptors` property is not empty, the returned samples will be ordered according to those descriptors.

method · iOS 15.4+

result

TypeScript
result(healthStore: HKHealthStore): Promise<Array<HKSource>>
Swift declaration
func result(for healthStore: HKHealthStore) async throws -> [HKSource]

Returns the unique sources belonging to samples that match the receiver.

get · iOS 15.4+

predicate

TypeScript
get predicate(): HKSamplePredicate<HKSample>
Swift declaration
var predicate: HKSamplePredicate<Sample>

The predicate that matches the desired samples.

set · iOS 15.4+

predicate

TypeScript
set predicate(value: HKSamplePredicate<HKSample>)
Swift declaration
var predicate: HKSamplePredicate<Sample>

The predicate that matches the desired samples.

init · iOS 15.4+

init

TypeScript
static init(predicate: HKSamplePredicate<HKSample>): HKSourceQueryDescriptor<HKSample>
Swift declaration
init(predicate: HKSamplePredicate<Sample>)
init · iOS 15.4+

init

TypeScript
static init(predicates: Array<HKSamplePredicate<HKSample>>, anchor?: (HKQueryAnchor) | null, limit?: (number) | null): HKAnchoredObjectQueryDescriptor<HKSample>
Swift declaration
init(predicates: [HKSamplePredicate<Sample>], anchor: HKQueryAnchor?, limit: Int? = nil)
get · iOS 15.4+

predicates

TypeScript
get predicates(): Array<HKSamplePredicate<HKSample>>
Swift declaration
var predicates: [HKSamplePredicate<Sample>] { get set }

The predicates that match the desired samples. If there is more than one predicate then they are combined using a disjunction. May not be empty.

set · iOS 15.4+

predicates

TypeScript
set predicates(value: Array<HKSamplePredicate<HKSample>>)
Swift declaration
var predicates: [HKSamplePredicate<Sample>] { get set }

The predicates that match the desired samples. If there is more than one predicate then they are combined using a disjunction. May not be empty.

get · iOS 15.4+

limit

TypeScript
get limit(): (number) | null
Swift declaration
var limit: Int?

The maximum number of resulting samples and deleted objects.

set · iOS 15.4+

limit

TypeScript
set limit(value: (number) | null)
Swift declaration
var limit: Int?

The maximum number of resulting samples and deleted objects.

get · iOS 15.4+

addedSamples

TypeScript
get addedSamples(): Array<HKSample>
Swift declaration
let addedSamples: [Sample]

The samples that have been added since `anchor`.

get · iOS 15.4+

deletedObjects

TypeScript
get deletedObjects(): Array<HKDeletedObject>
Swift declaration
let deletedObjects: [HKDeletedObject]

The objects that have been deleted since `anchor`.

get · iOS 15.4+

newAnchor

TypeScript
get newAnchor(): HKQueryAnchor
Swift declaration
let newAnchor: HKQueryAnchor

The new query anchor. This anchor value may be used in a subsequent query to request more changes.

get · iOS 15.4+

anchor

TypeScript
get anchor(): (HKQueryAnchor) | null
Swift declaration
var anchor: HKQueryAnchor?

An anchor that was returned by a previous query. Restricts query results to samples and deleted objects that were introduced after `anchor`.

set · iOS 15.4+

anchor

TypeScript
set anchor(value: (HKQueryAnchor) | null)
Swift declaration
var anchor: HKQueryAnchor?

An anchor that was returned by a previous query. Restricts query results to samples and deleted objects that were introduced after `anchor`.

method · iOS 15.4+

result

TypeScript
result(healthStore: HKHealthStore): Promise<HKAnchoredObjectQueryDescriptor_Result<HKSample>>
Swift declaration
func result(for healthStore: HKHealthStore) async throws -> HKAnchoredObjectQueryDescriptor<Sample>.Result

Returns the changes made to the health store matching the receiver. If the `anchor` property is non-nil, the result will be limited to changes made since that anchor was previously returned.

method · iOS 15.4+

makeAsyncIterator

TypeScript
makeAsyncIterator(): HKAnchoredObjectQueryDescriptor_Results_Iterator<HKSample>
Swift declaration
func makeAsyncIterator() -> HKAnchoredObjectQueryDescriptor<Sample>.Results.Iterator

Creates the asynchronous iterator that produces elements of this asynchronous sequence. - Returns: An instance of the `AsyncIterator` type used to produce elements of the asynchronous sequence.

method · iOS 15.4+

next

TypeScript
next(): Promise<(HKAnchoredObjectQueryDescriptor_Result<HKSample>) | null>
Swift declaration
mutating func next() async throws -> HKAnchoredObjectQueryDescriptor<Sample>.Results.Element?

Asynchronously advances to the next element and returns it, or ends the sequence if there is no next element. - Returns: The next element, if it exists, or `nil` to signal the end of the sequence.

method · iOS 15.4+

results

TypeScript
results(healthStore: HKHealthStore): HKAnchoredObjectQueryDescriptor_Results<HKSample>
Swift declaration
func results(for healthStore: HKHealthStore) -> HKAnchoredObjectQueryDescriptor<Sample>.Results

Returns an unbounded stream of changes to the health store matching the receiver, starting with the changes that have occurred since the `anchor` property was generated. The initial elements in the stream are the changes that are available immediately. Subsequent changes become available as they occur.

Skipped declarations

105 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

HKCategoryValuePredicateProviding.predicateForSamples(_:value:)

Static protocol requirements cannot be called through an instance.

HKCategoryValuePredicateProviding.predicateForSamples(equalTo:)

Static protocol requirements cannot be called through an instance.

HKStatisticsCollection.enumerateStatistics(from:to:with:)

synchronous callback requires a nonescaping JS-thread call

NotificationCenter.MessageIdentifier.userPreferencesDidChange

Static protocol requirements cannot be called through an instance.

HKAttachmentStore.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

HKGlassesPrescription.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

HKVisionPrism.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

HKLensSpecification.init()

inherited init: clang: 'init' is unavailable

HKActivitySummaryType.init()

inherited init: clang: 'init' is unavailable

HKAudiogramSampleType.init()

inherited init: clang: 'init' is unavailable

HKCategoryType.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

HKCharacteristicType.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

HKCorrelationType.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

HKDocumentType.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

HKElectrocardiogramType.init()

inherited init: clang: 'init' is unavailable

HKMedicationDoseEventType.init()

inherited init: clang: 'init' is unavailable

HKObjectType.init()

inherited init: clang: 'init' is unavailable

HKPrescriptionType.init()

inherited init: clang: 'init' is unavailable

HKQuantityType.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

HKSampleType.init()

inherited init: clang: 'init' is unavailable

HKScoredAssessmentType.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

HKSeriesType.init()

inherited init: clang: 'init' is unavailable

HKStateOfMindType.init()

inherited init: clang: 'init' is unavailable

HKUserAnnotatedMedicationType.init()

inherited init: clang: 'init' is unavailable

HKWorkoutType.init()

inherited init: clang: 'init' is unavailable

HKElectrocardiogramQuery.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

HKVerifiableClinicalRecord.init()

inherited init: clang: 'init' is unavailable

HKUnit.init()

inherited init: cannot prove legal (class declares 8 custom initializers)

HKContactsPrescription.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

HKMedicationDoseEvent.init()

inherited init: clang: 'init' is unavailable