HealthKit · IOS API REFERENCE
HKQuery
class · iOS 8.0+ · SDK 27.1
class HKQuery
Members (58)
static · iOS 9.3+predicate
TypeScriptstatic predicateForActivitySummariesBetweenStartEnd(startDateComponents: _Foundation_DateComponents, endDateComponents: _Foundation_DateComponents): _Foundation_NSPredicate
Swift declarationclass func predicate(forActivitySummariesBetweenStart startDateComponents: DateComponents, end endDateComponents: DateComponents) -> NSPredicate
static · iOS 9.3+predicateForActivitySummary
TypeScriptstatic predicateForActivitySummary(dateComponents: _Foundation_DateComponents): _Foundation_NSPredicate
Swift declarationclass func predicateForActivitySummary(with dateComponents: DateComponents) -> NSPredicate
static · iOS 8.0+ · Deprecated in iOS 100000.0predicateForCategorySamples
TypeScriptstatic predicateForCategorySamples(operatorType: _Foundation_NSComparisonPredicate_Operator, value: number): _Foundation_NSPredicate
Swift declarationclass func predicateForCategorySamples(with operatorType: NSComparisonPredicate.Operator, value: Int) -> NSPredicate
static · iOS 12.0+predicateForClinicalRecords
TypeScriptstatic predicateForClinicalRecordsFromFhirResourceTypeIdentifier(source: HKSource, resourceType: HKFHIRResourceType, identifier: string): _Foundation_NSPredicate
Swift declarationclass func predicateForClinicalRecords(from source: HKSource, fhirResourceType resourceType: HKFHIRResourceType, identifier: String) -> NSPredicate
static · iOS 12.0+predicateForClinicalRecords
TypeScriptstatic predicateForClinicalRecordsWithFHIRResourceType(resourceType: HKFHIRResourceType): _Foundation_NSPredicate
Swift declarationclass func predicateForClinicalRecords(withFHIRResourceType resourceType: HKFHIRResourceType) -> NSPredicate
static · iOS 14.0+predicateForElectrocardiograms
TypeScriptstatic predicateForElectrocardiogramsClassification(classification: HKElectrocardiogram_Classification): _Foundation_NSPredicate
Swift declarationclass func predicateForElectrocardiograms(classification: HKElectrocardiogram.Classification) -> NSPredicate
static · iOS 14.0+predicateForElectrocardiograms
TypeScriptstatic predicateForElectrocardiogramsSymptomsStatus(symptomsStatus: HKElectrocardiogram_SymptomsStatus): _Foundation_NSPredicate
Swift declarationclass func predicateForElectrocardiograms(symptomsStatus: HKElectrocardiogram.SymptomsStatus) -> NSPredicate
static · iOS 26.0+predicateForMedicationDoseEvent
TypeScriptstatic predicateForMedicationDoseEventMedicationConceptIdentifier(medicationConceptIdentifier: HKHealthConceptIdentifier): _Foundation_NSPredicate
Swift declarationclass func predicateForMedicationDoseEvent(medicationConceptIdentifier: HKHealthConceptIdentifier) -> NSPredicate
static · iOS 26.0+predicateForMedicationDoseEvent
TypeScriptstatic predicateForMedicationDoseEventMedicationConceptIdentifiers(medicationConceptIdentifiers: Array<HKHealthConceptIdentifier>): _Foundation_NSPredicate
Swift declarationclass func predicateForMedicationDoseEvent(medicationConceptIdentifiers: Set<HKHealthConceptIdentifier>) -> NSPredicate
static · iOS 26.0+predicateForMedicationDoseEvent
TypeScriptstatic predicateForMedicationDoseEventScheduledDate(scheduledDate: globalThis.Date): _Foundation_NSPredicate
Swift declarationclass func predicateForMedicationDoseEvent(scheduledDate: Date) -> NSPredicate
static · iOS 26.0+predicateForMedicationDoseEvent
TypeScriptstatic predicateForMedicationDoseEventScheduledDates(scheduledDates: Array<globalThis.Date>): _Foundation_NSPredicate
Swift declarationclass func predicateForMedicationDoseEvent(scheduledDates: Set<Date>) -> NSPredicate
static · iOS 26.0+predicateForMedicationDoseEvent
TypeScriptstatic predicateForMedicationDoseEventScheduledStartEnd(startDate?: (globalThis.Date) | null, endDate?: (globalThis.Date) | null): _Foundation_NSPredicate
Swift declarationclass func predicateForMedicationDoseEvent(scheduledStart startDate: Date?, end endDate: Date?) -> NSPredicate
static · iOS 26.0+predicateForMedicationDoseEvent
TypeScriptstatic predicateForMedicationDoseEventStatus(status: HKMedicationDoseEvent_LogStatus): _Foundation_NSPredicate
Swift declarationclass func predicateForMedicationDoseEvent(status: HKMedicationDoseEvent.LogStatus) -> NSPredicate
static · iOS 26.0+predicateForMedicationDoseEvent
TypeScriptstatic predicateForMedicationDoseEventStatuses(statuses: Array<_Foundation_NSNumber>): _Foundation_NSPredicate
Swift declarationclass func predicateForMedicationDoseEvent(statuses: Set<NSNumber>) -> NSPredicate
staticpredicateForObject
TypeScriptstatic predicateForObject(UUID: string): _Foundation_NSPredicate
Swift declarationclass func predicateForObject(with UUID: UUID) -> NSPredicate
static · iOS 14.0+predicateForObjectsAssociated
TypeScriptstatic predicateForObjectsAssociated(electrocardiogram: HKElectrocardiogram): _Foundation_NSPredicate
Swift declarationclass func predicateForObjectsAssociated(electrocardiogram: HKElectrocardiogram) -> NSPredicate
static · iOS 9.0+predicateForObjects
TypeScriptstatic predicateForObjectsFrom(devices: Array<HKDevice>): _Foundation_NSPredicate
Swift declarationclass func predicateForObjects(from devices: Set<HKDevice>) -> NSPredicate
staticpredicateForObjects
TypeScriptstatic predicateForObjectsFrom84340(source: HKSource): _Foundation_NSPredicate
Swift declarationclass func predicateForObjects(from source: HKSource) -> NSPredicate
static · iOS 9.0+predicateForObjects
TypeScriptstatic predicateForObjectsFrom12058(sourceRevisions: Array<HKSourceRevision>): _Foundation_NSPredicate
Swift declarationclass func predicateForObjects(from sourceRevisions: Set<HKSourceRevision>) -> NSPredicate
staticpredicateForObjects
TypeScriptstatic predicateForObjectsFrom41455(sources: Array<HKSource>): _Foundation_NSPredicate
Swift declarationclass func predicateForObjects(from sources: Set<HKSource>) -> NSPredicate
staticpredicateForObjects
TypeScriptstatic predicateForObjectsFrom74200(workout: HKWorkout): _Foundation_NSPredicate
Swift declarationclass func predicateForObjects(from workout: HKWorkout) -> NSPredicate
static · iOS 9.0+predicateForObjects
TypeScriptstatic predicateForObjectsWithDevicePropertyAllowedValues(key: string, allowedValues: Array<string>): _Foundation_NSPredicate
Swift declarationclass func predicateForObjects(withDeviceProperty key: String, allowedValues: Set<String>) -> NSPredicate
staticpredicateForObjects
TypeScriptstatic predicateForObjectsWithMetadataKey(key: string): _Foundation_NSPredicate
Swift declarationclass func predicateForObjects(withMetadataKey key: String) -> NSPredicate
staticpredicateForObjects
TypeScriptstatic predicateForObjectsWithMetadataKeyAllowedValues(key: string, allowedValues: Array<unknown>): _Foundation_NSPredicate
Swift declarationclass func predicateForObjects(withMetadataKey key: String, allowedValues: [Any]) -> NSPredicate
staticpredicateForObjects
TypeScriptstatic predicateForObjectsWithMetadataKeyOperatorTypeValue(key: string, operatorType: _Foundation_NSComparisonPredicate_Operator, value: unknown): _Foundation_NSPredicate
Swift declarationclass func predicateForObjects(withMetadataKey key: String, operatorType: NSComparisonPredicate.Operator, value: Any) -> NSPredicate
staticpredicateForObjectsWithNoCorrelation
TypeScriptstatic predicateForObjectsWithNoCorrelation(): _Foundation_NSPredicate
Swift declarationclass func predicateForObjectsWithNoCorrelation() -> NSPredicate
staticpredicateForObjects
TypeScriptstatic predicateForObjectsWith(UUIDs: Array<string>): _Foundation_NSPredicate
Swift declarationclass func predicateForObjects(with UUIDs: Set<UUID>) -> NSPredicate
staticpredicateForQuantitySamples
TypeScriptstatic predicateForQuantitySamples(operatorType: _Foundation_NSComparisonPredicate_Operator, quantity: HKQuantity): _Foundation_NSPredicate
Swift declarationclass func predicateForQuantitySamples(with operatorType: NSComparisonPredicate.Operator, quantity: HKQuantity) -> NSPredicate
staticpredicateForSamples
TypeScriptstatic predicateForSamples(startDate?: (globalThis.Date) | null, endDate?: (globalThis.Date) | null, options?: HKQueryOptions): _Foundation_NSPredicate
Swift declarationclass func predicateForSamples(withStart startDate: Date?, end endDate: Date?, options: HKQueryOptions = []) -> NSPredicate
staticpredicateForStatesOfMind
TypeScriptstatic predicateForStatesOfMindWith(association: HKStateOfMind_Association): _Foundation_NSPredicate
Swift declarationclass func predicateForStatesOfMind(with association: HKStateOfMind.Association) -> NSPredicate
staticpredicateForStatesOfMind
TypeScriptstatic predicateForStatesOfMindWith92358(kind: HKStateOfMind_Kind): _Foundation_NSPredicate
Swift declarationclass func predicateForStatesOfMind(with kind: HKStateOfMind.Kind) -> NSPredicate
staticpredicateForStatesOfMind
TypeScriptstatic predicateForStatesOfMindWith55314(label: HKStateOfMind_Label): _Foundation_NSPredicate
Swift declarationclass func predicateForStatesOfMind(with label: HKStateOfMind.Label) -> NSPredicate
staticpredicateForStatesOfMind
TypeScriptstatic predicateForStatesOfMindWithValenceOperatorType(valence: number, operatorType: _Foundation_NSComparisonPredicate_Operator): _Foundation_NSPredicate
Swift declarationclass func predicateForStatesOfMind(withValence valence: Double, operatorType: NSComparisonPredicate.Operator) -> NSPredicate
static · iOS 26.0+predicateForUserAnnotatedMedications
TypeScriptstatic predicateForUserAnnotatedMedicationsHasSchedule(hasSchedule: boolean): _Foundation_NSPredicate
Swift declarationclass func predicateForUserAnnotatedMedications(hasSchedule: Bool) -> NSPredicate
static · iOS 26.0+predicateForUserAnnotatedMedications
TypeScriptstatic predicateForUserAnnotatedMedicationsIsArchived(isArchived: boolean): _Foundation_NSPredicate
Swift declarationclass func predicateForUserAnnotatedMedications(isArchived: Bool) -> NSPredicate
static · iOS 15.0+predicateForVerifiableClinicalRecords
TypeScriptstatic predicateForVerifiableClinicalRecords(dateInterval: _Foundation_DateInterval): _Foundation_NSPredicate
Swift declarationclass func predicateForVerifiableClinicalRecords(withRelevantDateWithin dateInterval: DateInterval) -> NSPredicate
static · iOS 16.0+predicateForWorkoutActivities
TypeScriptstatic predicateForWorkoutActivitiesOperatorTypeDuration(operatorType: _Foundation_NSComparisonPredicate_Operator, duration: number): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkoutActivities(operatorType: NSComparisonPredicate.Operator, duration: TimeInterval) -> NSPredicate
static · iOS 16.0+predicateForWorkoutActivities
TypeScriptstatic predicateForWorkoutActivitiesOperatorTypeQuantityTypeAverageQuantity(operatorType: _Foundation_NSComparisonPredicate_Operator, quantityType: HKQuantityType, averageQuantity: HKQuantity): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkoutActivities(operatorType: NSComparisonPredicate.Operator, quantityType: HKQuantityType, averageQuantity: HKQuantity) -> NSPredicate
static · iOS 16.0+predicateForWorkoutActivities
TypeScriptstatic predicateForWorkoutActivitiesOperatorTypeQuantityTypeMaximumQuantity(operatorType: _Foundation_NSComparisonPredicate_Operator, quantityType: HKQuantityType, maximumQuantity: HKQuantity): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkoutActivities(operatorType: NSComparisonPredicate.Operator, quantityType: HKQuantityType, maximumQuantity: HKQuantity) -> NSPredicate
static · iOS 16.0+predicateForWorkoutActivities
TypeScriptstatic predicateForWorkoutActivitiesOperatorTypeQuantityTypeMinimumQuantity(operatorType: _Foundation_NSComparisonPredicate_Operator, quantityType: HKQuantityType, minimumQuantity: HKQuantity): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkoutActivities(operatorType: NSComparisonPredicate.Operator, quantityType: HKQuantityType, minimumQuantity: HKQuantity) -> NSPredicate
static · iOS 16.0+predicateForWorkoutActivities
TypeScriptstatic predicateForWorkoutActivitiesOperatorTypeQuantityTypeSumQuantity(operatorType: _Foundation_NSComparisonPredicate_Operator, quantityType: HKQuantityType, sumQuantity: HKQuantity): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkoutActivities(operatorType: NSComparisonPredicate.Operator, quantityType: HKQuantityType, sumQuantity: HKQuantity) -> NSPredicate
static · iOS 16.0+predicateForWorkoutActivities
TypeScriptstatic predicateForWorkoutActivitiesStartEndOptions(startDate?: (globalThis.Date) | null, endDate?: (globalThis.Date) | null, options?: HKQueryOptions): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkoutActivities(start startDate: Date?, end endDate: Date?, options: HKQueryOptions = []) -> NSPredicate
static · iOS 16.0+predicateForWorkoutActivities
TypeScriptstatic predicateForWorkoutActivitiesWorkoutActivityType(workoutActivityType: HKWorkoutActivityType): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkoutActivities(workoutActivityType: HKWorkoutActivityType) -> NSPredicate
static · iOS 18.0+predicateForWorkoutEffortSamplesRelated
TypeScriptstatic predicateForWorkoutEffortSamplesRelated(workout: HKWorkout, activity?: (HKWorkoutActivity) | null): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkoutEffortSamplesRelated(workout: HKWorkout, activity: HKWorkoutActivity?) -> NSPredicate
static · iOS 16.0+predicateForWorkouts
TypeScriptstatic predicateForWorkoutsActivityPredicate(activityPredicate: _Foundation_NSPredicate): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkouts(activityPredicate: NSPredicate) -> NSPredicate
staticpredicateForWorkouts
TypeScriptstatic predicateForWorkoutsWithDuration(operatorType: _Foundation_NSComparisonPredicate_Operator, duration: number): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkouts(with operatorType: NSComparisonPredicate.Operator, duration: TimeInterval) -> NSPredicate
static · iOS 16.0+predicateForWorkouts
TypeScriptstatic predicateForWorkoutsOperatorTypeQuantityTypeAverageQuantity(operatorType: _Foundation_NSComparisonPredicate_Operator, quantityType: HKQuantityType, averageQuantity: HKQuantity): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkouts(operatorType: NSComparisonPredicate.Operator, quantityType: HKQuantityType, averageQuantity: HKQuantity) -> NSPredicate
static · iOS 16.0+predicateForWorkouts
TypeScriptstatic predicateForWorkoutsOperatorTypeQuantityTypeMaximumQuantity(operatorType: _Foundation_NSComparisonPredicate_Operator, quantityType: HKQuantityType, maximumQuantity: HKQuantity): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkouts(operatorType: NSComparisonPredicate.Operator, quantityType: HKQuantityType, maximumQuantity: HKQuantity) -> NSPredicate
static · iOS 16.0+predicateForWorkouts
TypeScriptstatic predicateForWorkoutsOperatorTypeQuantityTypeMinimumQuantity(operatorType: _Foundation_NSComparisonPredicate_Operator, quantityType: HKQuantityType, minimumQuantity: HKQuantity): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkouts(operatorType: NSComparisonPredicate.Operator, quantityType: HKQuantityType, minimumQuantity: HKQuantity) -> NSPredicate
static · iOS 16.0+predicateForWorkouts
TypeScriptstatic predicateForWorkoutsOperatorTypeQuantityTypeSumQuantity(operatorType: _Foundation_NSComparisonPredicate_Operator, quantityType: HKQuantityType, sumQuantity: HKQuantity): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkouts(operatorType: NSComparisonPredicate.Operator, quantityType: HKQuantityType, sumQuantity: HKQuantity) -> NSPredicate
static · iOS 8.0+ · Deprecated in iOS 100000.0predicateForWorkouts
TypeScriptstatic predicateForWorkoutsWithTotalDistance(operatorType: _Foundation_NSComparisonPredicate_Operator, totalDistance: HKQuantity): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkouts(with operatorType: NSComparisonPredicate.Operator, totalDistance: HKQuantity) -> NSPredicate
static · iOS 8.0+ · Deprecated in iOS 18.0predicateForWorkouts
TypeScriptstatic predicateForWorkoutsWithTotalEnergyBurned(operatorType: _Foundation_NSComparisonPredicate_Operator, totalEnergyBurned: HKQuantity): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkouts(with operatorType: NSComparisonPredicate.Operator, totalEnergyBurned: HKQuantity) -> NSPredicate
static · iOS 11.0+ · Deprecated in iOS 18.0predicateForWorkouts
TypeScriptstatic predicateForWorkoutsWithTotalFlightsClimbed(operatorType: _Foundation_NSComparisonPredicate_Operator, totalFlightsClimbed: HKQuantity): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkouts(with operatorType: NSComparisonPredicate.Operator, totalFlightsClimbed: HKQuantity) -> NSPredicate
static · iOS 10.0+ · Deprecated in iOS 18.0predicateForWorkouts
TypeScriptstatic predicateForWorkoutsWithTotalSwimmingStrokeCount(operatorType: _Foundation_NSComparisonPredicate_Operator, totalSwimmingStrokeCount: HKQuantity): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkouts(with operatorType: NSComparisonPredicate.Operator, totalSwimmingStrokeCount: HKQuantity) -> NSPredicate
staticpredicateForWorkouts
TypeScriptstatic predicateForWorkoutsWith(workoutActivityType: HKWorkoutActivityType): _Foundation_NSPredicate
Swift declarationclass func predicateForWorkouts(with workoutActivityType: HKWorkoutActivityType) -> NSPredicate
get · iOS 9.3+objectType
TypeScriptget objectType(): (HKObjectType) | null
Swift declarationvar objectType: HKObjectType? { get }
get · iOS 8.0+predicate
TypeScriptget predicate(): (_Foundation_NSPredicate) | null
Swift declarationvar predicate: NSPredicate? { get }
get · iOS 8.0+ · Deprecated in iOS 9.3sampleType
TypeScriptget sampleType(): (HKSampleType) | null
Swift declarationvar sampleType: HKSampleType? { get }
Skipped declarations
1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.
HKQuery.init()
inherited init: clang: 'init' is unavailable
All HealthKit types →