HealthKit · IOS API REFERENCE
HKWorkout
class · iOS 8.0+ · SDK 27.1
class HKWorkout
Members (19)
init · iOS 8.0+ · Deprecated in iOS 17.0init
TypeScriptstatic initActivityTypeStartEnd(workoutActivityType: HKWorkoutActivityType, startDate: globalThis.Date, endDate: globalThis.Date): HKWorkout
Swift declarationconvenience init(activityType workoutActivityType: HKWorkoutActivityType, start startDate: Date, end endDate: Date)
init · iOS 9.0+ · Deprecated in iOS 17.0init
TypeScriptstatic initActivityTypeStartEndDurationTotalEnergyBurnedTotalDistanceDeviceMetadata(workoutActivityType: HKWorkoutActivityType, startDate: globalThis.Date, endDate: globalThis.Date, duration: number, totalEnergyBurned?: (HKQuantity) | null, totalDistance?: (HKQuantity) | null, device?: (HKDevice) | null, metadata?: (Record<string, unknown>) | null): HKWorkout
Swift declarationconvenience init(activityType workoutActivityType: HKWorkoutActivityType, start startDate: Date, end endDate: Date, duration: TimeInterval, totalEnergyBurned: HKQuantity?, totalDistance: HKQuantity?, device: HKDevice?, metadata: [String : Any]?)
init · iOS 8.0+ · Deprecated in iOS 17.0init
TypeScriptstatic initActivityTypeStartEndDurationTotalEnergyBurnedTotalDistanceMetadata(workoutActivityType: HKWorkoutActivityType, startDate: globalThis.Date, endDate: globalThis.Date, duration: number, totalEnergyBurned?: (HKQuantity) | null, totalDistance?: (HKQuantity) | null, metadata?: (Record<string, unknown>) | null): HKWorkout
Swift declarationconvenience init(activityType workoutActivityType: HKWorkoutActivityType, start startDate: Date, end endDate: Date, duration: TimeInterval, totalEnergyBurned: HKQuantity?, totalDistance: HKQuantity?, metadata: [String : Any]?)
init · iOS 9.0+ · Deprecated in iOS 17.0init
TypeScriptstatic initActivityTypeStartEndWorkoutEventsTotalEnergyBurnedTotalDistanceDeviceMetadata(workoutActivityType: HKWorkoutActivityType, startDate: globalThis.Date, endDate: globalThis.Date, workoutEvents?: (Array<HKWorkoutEvent>) | null, totalEnergyBurned?: (HKQuantity) | null, totalDistance?: (HKQuantity) | null, device?: (HKDevice) | null, metadata?: (Record<string, unknown>) | null): HKWorkout
Swift declarationconvenience init(activityType workoutActivityType: HKWorkoutActivityType, start startDate: Date, end endDate: Date, workoutEvents: [HKWorkoutEvent]?, totalEnergyBurned: HKQuantity?, totalDistance: HKQuantity?, device: HKDevice?, metadata: [String : Any]?)
init · iOS 8.0+ · Deprecated in iOS 17.0init
TypeScriptstatic initActivityTypeStartEndWorkoutEventsTotalEnergyBurnedTotalDistanceMetadata(workoutActivityType: HKWorkoutActivityType, startDate: globalThis.Date, endDate: globalThis.Date, workoutEvents?: (Array<HKWorkoutEvent>) | null, totalEnergyBurned?: (HKQuantity) | null, totalDistance?: (HKQuantity) | null, metadata?: (Record<string, unknown>) | null): HKWorkout
Swift declarationconvenience init(activityType workoutActivityType: HKWorkoutActivityType, start startDate: Date, end endDate: Date, workoutEvents: [HKWorkoutEvent]?, totalEnergyBurned: HKQuantity?, totalDistance: HKQuantity?, metadata: [String : Any]?)
init · iOS 11.0+ · Deprecated in iOS 17.0init
TypeScriptstatic initActivityTypeStartEndWorkoutEventsTotalEnergyBurnedTotalDistanceTotalFlightsClimbedDeviceMetadata(workoutActivityType: HKWorkoutActivityType, startDate: globalThis.Date, endDate: globalThis.Date, workoutEvents?: (Array<HKWorkoutEvent>) | null, totalEnergyBurned?: (HKQuantity) | null, totalDistance?: (HKQuantity) | null, totalFlightsClimbed?: (HKQuantity) | null, device?: (HKDevice) | null, metadata?: (Record<string, unknown>) | null): HKWorkout
Swift declarationconvenience init(activityType workoutActivityType: HKWorkoutActivityType, start startDate: Date, end endDate: Date, workoutEvents: [HKWorkoutEvent]?, totalEnergyBurned: HKQuantity?, totalDistance: HKQuantity?, totalFlightsClimbed: HKQuantity?, device: HKDevice?, metadata: [String : Any]?)
init · iOS 10.0+ · Deprecated in iOS 17.0init
TypeScriptstatic initActivityTypeStartEndWorkoutEventsTotalEnergyBurnedTotalDistanceTotalSwimmingStrokeCountDeviceMetadata(workoutActivityType: HKWorkoutActivityType, startDate: globalThis.Date, endDate: globalThis.Date, workoutEvents?: (Array<HKWorkoutEvent>) | null, totalEnergyBurned?: (HKQuantity) | null, totalDistance?: (HKQuantity) | null, totalSwimmingStrokeCount?: (HKQuantity) | null, device?: (HKDevice) | null, metadata?: (Record<string, unknown>) | null): HKWorkout
Swift declarationconvenience init(activityType workoutActivityType: HKWorkoutActivityType, start startDate: Date, end endDate: Date, workoutEvents: [HKWorkoutEvent]?, totalEnergyBurned: HKQuantity?, totalDistance: HKQuantity?, totalSwimmingStrokeCount: HKQuantity?, device: HKDevice?, metadata: [String : Any]?)
method · iOS 16.0+statistics
TypeScriptstatistics(quantityType: HKQuantityType): (HKStatistics) | null
Swift declarationfunc statistics(for quantityType: HKQuantityType) -> HKStatistics?
get · iOS 16.0+allStatistics
TypeScriptget allStatistics(): NativeMap<HKQuantityType, HKStatistics>
Swift declarationvar allStatistics: [HKQuantityType : HKStatistics] { get }
get · iOS 8.0+duration
TypeScriptget duration(): number
Swift declarationvar duration: TimeInterval { get }
get · iOS 8.0+ · Deprecated in iOS 100000.0totalDistance
TypeScriptget totalDistance(): (HKQuantity) | null
Swift declarationvar totalDistance: HKQuantity? { get }
get · iOS 8.0+ · Deprecated in iOS 18.0totalEnergyBurned
TypeScriptget totalEnergyBurned(): (HKQuantity) | null
Swift declarationvar totalEnergyBurned: HKQuantity? { get }
get · iOS 11.0+ · Deprecated in iOS 18.0totalFlightsClimbed
TypeScriptget totalFlightsClimbed(): (HKQuantity) | null
Swift declarationvar totalFlightsClimbed: HKQuantity? { get }
get · iOS 10.0+ · Deprecated in iOS 18.0totalSwimmingStrokeCount
TypeScriptget totalSwimmingStrokeCount(): (HKQuantity) | null
Swift declarationvar totalSwimmingStrokeCount: HKQuantity? { get }
get · iOS 16.0+workoutActivities
TypeScriptget workoutActivities(): Array<HKWorkoutActivity>
Swift declarationvar workoutActivities: [HKWorkoutActivity] { get }
get · iOS 8.0+workoutActivityType
TypeScriptget workoutActivityType(): HKWorkoutActivityType
Swift declarationvar workoutActivityType: HKWorkoutActivityType { get }
get · iOS 8.0+workoutEvents
TypeScriptget workoutEvents(): (Array<HKWorkoutEvent>) | null
Swift declarationvar workoutEvents: [HKWorkoutEvent]? { get }
get · iOS 27.0+zoneGroupsByType
TypeScriptget zoneGroupsByType(): (NativeMap<HKQuantityType, HKWorkoutZoneGroup>) | null
Swift declarationvar zoneGroupsByType: [HKQuantityType : HKWorkoutZoneGroup]? { get }
A dictionary mapping quantity types to their corresponding zone groups for this workout.
method · iOS 27.0+zoneGroup
TypeScriptzoneGroup(quantityType: HKQuantityType): (HKWorkoutZoneGroup) | null
Swift declarationfunc zoneGroup(for quantityType: HKQuantityType) -> HKWorkoutZoneGroup?
Skipped declarations
1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.
HKWorkout.init()
inherited init: cannot prove legal (class declares 14 custom initializers)
All HealthKit types →