HKWorkoutBuilder

addMetadata

addMetadata(metadata: Record<string, unknown>, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void

func addMetadata(_ metadata: [String : Any]) async throws

add

add(samples: Array<HKSample>, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void

func addSamples(_ samples: [HKSample]) async throws

addWorkoutActivity

addWorkoutActivity(workoutActivity: HKWorkoutActivity, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void

func addWorkoutActivity(_ workoutActivity: HKWorkoutActivity) async throws

addWorkoutEvents

addWorkoutEvents(workoutEvents: Array<HKWorkoutEvent>, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void

func addWorkoutEvents(_ workoutEvents: [HKWorkoutEvent]) async throws

beginCollection

beginCollection(startDate: globalThis.Date, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void

func beginCollection(at startDate: Date) async throws

discardWorkout

discardWorkout(): void

func discardWorkout()

elapsedTime

elapsedTime(date: globalThis.Date): number

func elapsedTime(at date: Date) -> TimeInterval

endCollection

endCollection(endDate: globalThis.Date, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void

func endCollection(at endDate: Date) async throws

finishWorkout

finishWorkout(completion: ((arg0: (HKWorkout) | null, arg1: (NativeError) | null) => void)): void

func finishWorkout() async throws -> HKWorkout?

init

static init(healthStore: HKHealthStore, configuration: HKWorkoutConfiguration, device?: (HKDevice) | null): HKWorkoutBuilder

init(healthStore: HKHealthStore, configuration: HKWorkoutConfiguration, device: HKDevice?)

seriesBuilder

seriesBuilder(seriesType: HKSeriesType): (HKSeriesBuilder) | null

func seriesBuilder(for seriesType: HKSeriesType) -> HKSeriesBuilder?

statistics

statistics(quantityType: HKQuantityType): (HKStatistics) | null

func statistics(for quantityType: HKQuantityType) -> HKStatistics?

updateActivity

updateActivityUuidAddingCompletion(UUID: string, metadata: Record<string, unknown>, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void

func updateActivity(uuid UUID: UUID, adding metadata: [String : Any]) async throws

updateActivity

updateActivityUuidEndCompletion(UUID: string, endDate: globalThis.Date, completion: ((arg0: boolean, arg1: (NativeError) | null) => void)): void

func updateActivity(uuid UUID: UUID, end endDate: Date) async throws

allStatistics

get allStatistics(): NativeMap<HKQuantityType, HKStatistics>

var allStatistics: [HKQuantityType : HKStatistics] { get }

device

get device(): (HKDevice) | null

@NSCopying var device: HKDevice? { get }

endDate

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

var endDate: Date? { get }

metadata

get metadata(): Record<string, unknown>

var metadata: [String : Any] { get }

startDate

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

var startDate: Date? { get }

workoutActivities

get workoutActivities(): Array<HKWorkoutActivity>

var workoutActivities: [HKWorkoutActivity] { get }

workoutConfiguration

get workoutConfiguration(): HKWorkoutConfiguration

@NSCopying var workoutConfiguration: HKWorkoutConfiguration { get }

workoutEvents

get workoutEvents(): Array<HKWorkoutEvent>

var workoutEvents: [HKWorkoutEvent] { get }

zoneConfiguration

zoneConfiguration(quantityType: HKQuantityType): Promise<(HKWorkoutZoneConfiguration) | null>

func zoneConfiguration(for quantityType: HKQuantityType) async throws -> HKWorkoutZoneConfiguration?

Returns the zone configuration being used for the specified quantity type in this workout. If a custom configuration has been set via `setZoneConfiguration(_:for:)`, that configuration is returned. Otherwise, this method fetches and returns the user's preferred workout zone configuration from the health store. - Parameter quantityType: The quantity type to retrieve the configuration for. - Returns: The active zone configuration, or nil if no custom configuration has been set and the user has no preferred configuration for the quantity type. - Throws: An error if the configuration cannot be retrieved.

setCustomZoneConfiguration

setCustomZoneConfiguration(configuration: (HKWorkoutZoneConfiguration) | null, quantityType: HKQuantityType): Promise<void>

func setCustomZoneConfiguration(_ configuration: HKWorkoutZoneConfiguration?, for quantityType: HKQuantityType) async throws

Sets the zone configuration for the specified quantity type for this workout. In order to provide a custom workout zone configuration, this must be called before beginning collection on the builder. If a custom configuration is not provided, the user's preferred workout zone configuration will be used for zone calculations. - Parameter configuration: The zone configuration to use. Setting to `nil` will remove any custom configuration and use the preferred zone configuration for the quantity type. - Parameter quantityType: The quantity type to apply the configuration to. - Throws: An error if the configuration cannot be set or is incompatible with the quantity type.

zoneGroup

zoneGroup(quantityType: HKQuantityType): (HKWorkoutZoneGroup) | null

func zoneGroup(for quantityType: HKQuantityType) -> HKWorkoutZoneGroup?

Returns the current zone group for the specified quantity type, including real-time duration calculations. - Parameter quantityType: The quantity type to retrieve zone information for. - Returns: The zone group with current time-in-zone data, or nil if no zone information is available.