HealthKit · IOS API REFERENCE

HKWorkoutSession

class · iOS 17.0+ · SDK 27.1

class HKWorkoutSession

Members (21)

method · iOS 26.0+

associatedWorkoutBuilder

TypeScript

associatedWorkoutBuilder(): HKLiveWorkoutBuilder

Swift declaration

func associatedWorkoutBuilder() -> HKLiveWorkoutBuilder

method · iOS 17.0+

beginNewActivity

TypeScript

beginNewActivity(workoutConfiguration: HKWorkoutConfiguration, date: globalThis.Date, metadata?: (Record<string, unknown>) | null): void

Swift declaration

func beginNewActivity(configuration workoutConfiguration: HKWorkoutConfiguration, date: Date, metadata: [String : Any]?)

method · iOS 17.0+

end

TypeScript

end(): void

Swift declaration

func end()

method · iOS 17.0+

endCurrentActivity

TypeScript

endCurrentActivity(date: globalThis.Date): void

Swift declaration

func endCurrentActivity(on date: Date)

init · iOS 26.0+

init

TypeScript

static init(healthStore: HKHealthStore, workoutConfiguration: HKWorkoutConfiguration): HKWorkoutSession

Swift declaration

init(healthStore: HKHealthStore, configuration workoutConfiguration: HKWorkoutConfiguration) throws

method · iOS 17.0+

pause

TypeScript

pause(): void

Swift declaration

func pause()

method · iOS 17.0+

prepare

TypeScript

prepare(): void

Swift declaration

func prepare()

method · iOS 17.0+

resume

TypeScript

resume(): void

Swift declaration

func resume()

method · iOS 17.0+

sendToRemoteWorkoutSession

TypeScript

sendToRemoteWorkoutSession(data: ArrayBuffer, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void

Swift declaration

func sendToRemoteWorkoutSession(data: Data) async throws

method · iOS 17.0+

startActivity

TypeScript

startActivity(date?: (globalThis.Date) | null): void

Swift declaration

func startActivity(with date: Date?)

method · iOS 17.0+

stopActivity

TypeScript

stopActivity(date?: (globalThis.Date) | null): void

Swift declaration

func stopActivity(with date: Date?)

get · iOS 17.0+

activityType

TypeScript

get activityType(): HKWorkoutActivityType

Swift declaration

var activityType: HKWorkoutActivityType { get }

get · iOS 17.0+

currentActivity

TypeScript

get currentActivity(): HKWorkoutActivity

Swift declaration

@NSCopying var currentActivity: HKWorkoutActivity { get }

get · iOS 17.0+

delegate

TypeScript

get delegate(): (SDKHandle) | null

Swift declaration

weak var delegate: (any HKWorkoutSessionDelegate)? { get set }

set · iOS 17.0+

delegate

TypeScript

set delegate(value: (Implements<HKWorkoutSessionDelegate> | SDKHandle) | null)

Swift declaration

weak var delegate: (any HKWorkoutSessionDelegate)? { get set }

get · iOS 17.0+

endDate

TypeScript

get endDate(): (globalThis.Date) | null

Swift declaration

var endDate: Date? { get }

get · iOS 17.0+

locationType

TypeScript

get locationType(): HKWorkoutSessionLocationType

Swift declaration

var locationType: HKWorkoutSessionLocationType { get }

get · iOS 17.0+

startDate

TypeScript

get startDate(): (globalThis.Date) | null

Swift declaration

var startDate: Date? { get }

get · iOS 17.0+

state

TypeScript

get state(): HKWorkoutSessionState

Swift declaration

var state: HKWorkoutSessionState { get }

get · iOS 17.0+

type

TypeScript

get type(): HKWorkoutSessionType

Swift declaration

var type: HKWorkoutSessionType { get }

get · iOS 17.0+

workoutConfiguration

TypeScript

get workoutConfiguration(): HKWorkoutConfiguration

Swift declaration

@NSCopying var workoutConfiguration: HKWorkoutConfiguration { get }

Skipped declarations

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

HKWorkoutSession.init()

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

All HealthKit types →