One Logo Pool Ball
X
Github
Discord

System

HealthKit · IOS API REFERENCE

HKHealthStore

class · iOS 8.0+ · SDK 27.1

class HKHealthStore

Members (40)

static · iOS 8.0+

isHealthDataAvailable

TypeScript
static isHealthDataAvailable(): boolean
Swift declaration
class func isHealthDataAvailable() -> Bool
method · iOS 14.0+

activityMoveMode

TypeScript
activityMoveMode(): HKActivityMoveModeObject
Swift declaration
func activityMoveMode() throws -> HKActivityMoveModeObject
method · iOS 8.0+ · Deprecated in iOS 17.0

add

TypeScript
add(samples: Array<HKSample>, workout: HKWorkout, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func addSamples(_ samples: [HKSample], to workout: HKWorkout) async throws
method · iOS 8.0+

authorizationStatus

TypeScript
authorizationStatus(type: HKObjectType): HKAuthorizationStatus
Swift declaration
func authorizationStatus(for type: HKObjectType) -> HKAuthorizationStatus
method · iOS 8.0+

biologicalSex

TypeScript
biologicalSex(): HKBiologicalSexObject
Swift declaration
func biologicalSex() throws -> HKBiologicalSexObject
method · iOS 8.0+

bloodType

TypeScript
bloodType(): HKBloodTypeObject
Swift declaration
func bloodType() throws -> HKBloodTypeObject
method · iOS 10.0+

dateOfBirthComponents

TypeScript
dateOfBirthComponents(): _Foundation_DateComponents
Swift declaration
func dateOfBirthComponents() throws -> DateComponents
method · iOS 8.0+ · Deprecated in iOS 10.0

dateOfBirth

TypeScript
dateOfBirth(): globalThis.Date
Swift declaration
func dateOfBirth() throws -> Date
method · iOS 8.0+

delete

TypeScript
deleteWithCompletion(object: HKObject, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func delete(_ object: HKObject) async throws
method · iOS 9.0+

delete

TypeScript
deleteWithCompletion64175(objects: Array<HKObject>, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func delete(_ objects: [HKObject]) async throws
method · iOS 9.0+

deleteObjects

TypeScript
deleteObjects(objectType: HKObjectType, predicate: _Foundation_NSPredicate, completion: ((arg0: boolean, arg1: number, arg2: (NativeError) | null) => void)): void
Swift declaration
func deleteObjects(of objectType: HKObjectType, predicate: NSPredicate) async throws -> Int
method

disableAllBackgroundDelivery

TypeScript
disableAllBackgroundDelivery(completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func disableAllBackgroundDelivery() async throws
method

disableBackgroundDelivery

TypeScript
disableBackgroundDelivery(type: HKObjectType, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func disableBackgroundDelivery(for type: HKObjectType) async throws
method · iOS 9.0+

earliestPermittedSampleDate

TypeScript
earliestPermittedSampleDate(): globalThis.Date
Swift declaration
func earliestPermittedSampleDate() -> Date
method

enableBackgroundDelivery

TypeScript
enableBackgroundDelivery(type: HKObjectType, frequency: HKUpdateFrequency, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func enableBackgroundDelivery(for type: HKObjectType, frequency: HKUpdateFrequency) async throws
method · iOS 8.0+

execute

TypeScript
execute(query: HKQuery): void
Swift declaration
func execute(_ query: HKQuery)
method · iOS 9.0+

fitzpatrickSkinType

TypeScript
fitzpatrickSkinType(): HKFitzpatrickSkinTypeObject
Swift declaration
func fitzpatrickSkinType() throws -> HKFitzpatrickSkinTypeObject
method · iOS 27.0+

getEarliestAuthorizedSampleDate

TypeScript
getEarliestAuthorizedSampleDate(types: Array<HKObjectType>, completion: ((arg0: (NativeMap<HKObjectType, globalThis.Date>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func getEarliestAuthorizedSampleDate(for types: Set<HKObjectType>, completion: @escaping @Sendable ([HKObjectType : Date]?, (any Error)?) -> Void)
method · iOS 12.0+

getRequestStatusForAuthorization

TypeScript
getRequestStatusForAuthorization(typesToShare: Array<HKSampleType>, typesToRead: Array<HKObjectType>, completion: ((arg0: HKAuthorizationRequestStatus, arg1: (NativeError) | null) => void)): void
Swift declaration
func statusForAuthorizationRequest(toShare typesToShare: Set<HKSampleType>, read typesToRead: Set<HKObjectType>) async throws -> HKAuthorizationRequestStatus
method · iOS 9.0+

handleAuthorizationForExtension

TypeScript
handleAuthorizationForExtension(completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func handleAuthorizationForExtension() async throws
init

init

TypeScript
static init(): HKHealthStore
Swift declaration
init()
method · iOS 8.2+

preferredUnits

TypeScript
preferredUnits(quantityTypes: Array<HKQuantityType>, completion: ((arg0: NativeMap<HKQuantityType, HKUnit>, arg1: (NativeError) | null) => void)): void
Swift declaration
func preferredUnits(for quantityTypes: Set<HKQuantityType>) async throws -> [HKQuantityType : HKUnit]
method · iOS 15.0+

recalibrateEstimates

TypeScript
recalibrateEstimates(sampleType: HKSampleType, date: globalThis.Date, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func recalibrateEstimates(sampleType: HKSampleType, date: Date) async throws
method · iOS 26.0+

recoverActiveWorkoutSession

TypeScript
recoverActiveWorkoutSession(completion: ((arg0: (HKWorkoutSession) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func recoverActiveWorkoutSession() async throws -> HKWorkoutSession?
method · iOS 18.0+

relateWorkoutEffortSample

TypeScript
relateWorkoutEffortSample(sample: HKSample, workout: HKWorkout, activity: (HKWorkoutActivity) | null, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func relateWorkoutEffortSample(_ sample: HKSample, with workout: HKWorkout, activity: HKWorkoutActivity?) async throws -> Bool
method · iOS 8.0+

requestAuthorization

TypeScript
requestAuthorizationToShareReadCompletion(typesToShare: (Array<HKSampleType>) | null, typesToRead: (Array<HKObjectType>) | null, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func requestAuthorization(toShare typesToShare: Set<HKSampleType>?, read typesToRead: Set<HKObjectType>?, completion: @escaping @Sendable (Bool, (any Error)?) -> Void)
method · iOS 16.0+

requestPerObjectReadAuthorization

TypeScript
requestPerObjectReadAuthorization(objectType: HKObjectType, predicate: (_Foundation_NSPredicate) | null, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func requestPerObjectReadAuthorization(for objectType: HKObjectType, predicate: NSPredicate?) async throws
method · iOS 8.0+

save

TypeScript
saveWithCompletion(object: HKObject, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func save(_ object: HKObject) async throws
method · iOS 8.0+

save

TypeScript
saveWithCompletion30981(objects: Array<HKObject>, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func save(_ objects: [HKObject]) async throws
method · iOS 9.0+ · Deprecated in iOS 11.0

splitTotalEnergy

TypeScript
splitTotalEnergy(totalEnergy: HKQuantity, startDate: globalThis.Date, endDate: globalThis.Date, resultsHandler: ((arg0: (HKQuantity) | null, arg1: (HKQuantity) | null, arg2: (NativeError) | null) => void)): void
Swift declaration
func splitTotalEnergy(_ totalEnergy: HKQuantity, start startDate: Date, end endDate: Date, resultsHandler: @escaping @Sendable (HKQuantity?, HKQuantity?, (any Error)?) -> Void)
method · iOS 10.0+

startWatchApp

TypeScript
startWatchApp(workoutConfiguration: HKWorkoutConfiguration, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func startWatchApp(toHandle workoutConfiguration: HKWorkoutConfiguration) async throws
method · iOS 8.0+

stop

TypeScript
stop(query: HKQuery): void
Swift declaration
func stop(_ query: HKQuery)
method · iOS 12.0+

supportsHealthRecords

TypeScript
supportsHealthRecords(): boolean
Swift declaration
func supportsHealthRecords() -> Bool
method · iOS 18.0+

unrelateWorkoutEffortSample

TypeScript
unrelateWorkoutEffortSample(sample: HKSample, workout: HKWorkout, activity: (HKWorkoutActivity) | null, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void
Swift declaration
func unrelateWorkoutEffortSample(_ sample: HKSample, from workout: HKWorkout, activity: HKWorkoutActivity?) async throws -> Bool
method · iOS 10.0+

wheelchairUse

TypeScript
wheelchairUse(): HKWheelchairUseObject
Swift declaration
func wheelchairUse() throws -> HKWheelchairUseObject
get · iOS 17.0+

workoutSessionMirroringStartHandler

TypeScript
get workoutSessionMirroringStartHandler(): (((arg0: HKWorkoutSession) => Promise<void>)) | null
Swift declaration
var workoutSessionMirroringStartHandler: (@Sendable (HKWorkoutSession) -> Void)? { get set }
set · iOS 17.0+

workoutSessionMirroringStartHandler

TypeScript
set workoutSessionMirroringStartHandler(value: (((arg0: HKWorkoutSession) => void)) | null)
Swift declaration
var workoutSessionMirroringStartHandler: (@Sendable (HKWorkoutSession) -> Void)? { get set }
method · iOS 15.0+

requestAuthorization

TypeScript
requestAuthorizationToShareRead(typesToShare: Array<HKSampleType>, typesToRead: Array<HKObjectType>): Promise<void>
Swift declaration
func requestAuthorization(toShare typesToShare: Set<HKSampleType>, read typesToRead: Set<HKObjectType>) async throws
method · iOS 27.0+

earliestAuthorizedSampleDate

TypeScript
earliestAuthorizedSampleDate(types: Array<HKObjectType>): Promise<NativeMap<HKObjectType, globalThis.Date>>
Swift declaration
func earliestAuthorizedSampleDate(for types: Set<HKObjectType>) async throws -> [HKObjectType : Date]
method · iOS 27.0+

preferredWorkoutZoneConfiguration

TypeScript
preferredWorkoutZoneConfiguration(quantityType: HKQuantityType): Promise<(HKWorkoutZoneConfiguration) | null>
Swift declaration
func preferredWorkoutZoneConfiguration(for quantityType: HKQuantityType) async throws -> HKWorkoutZoneConfiguration?

Returns the user's preferred workout zone configuration for the specified quantity type. - Parameter quantityType: The quantity type to retrieve the preferred zone configuration for. - Returns: The preferred zone configuration, or nil if none is set. - Throws: An error if the zone configuration cannot be retrieved.

Skipped declarations

No declarations were skipped in this snapshot.

All HealthKit types →