WorkoutKit · IOS API REFERENCE

CustomWorkout

struct · iOS 17.0+ · SDK 27.1

struct CustomWorkout

Members (16)

get · iOS 17.0+

displayName

TypeScript

get displayName(): (string) | null

Swift declaration

var displayName: String?

set · iOS 17.0+

displayName

TypeScript

set displayName(value: (string) | null)

Swift declaration

var displayName: String?

static · iOS 17.0+

supportsGoal

TypeScript

static supportsGoal(goal: WorkoutGoal, activity: _HealthKit_HKWorkoutActivityType, location?: _HealthKit_HKWorkoutSessionLocationType): boolean

Swift declaration

static func supportsGoal(_ goal: WorkoutGoal, activity: HKWorkoutActivityType, location: HKWorkoutSessionLocationType = .unknown) -> Bool

static · iOS 17.0+

supportsAlert

TypeScript

static supportsAlert(alert: SDKHandle, activity: _HealthKit_HKWorkoutActivityType, location?: _HealthKit_HKWorkoutSessionLocationType): boolean

Swift declaration

static func supportsAlert(_ alert: any WorkoutAlert, activity: HKWorkoutActivityType, location: HKWorkoutSessionLocationType = .unknown) -> Bool

static · iOS 17.0+

supportsActivity

TypeScript

static supportsActivity(activity: _HealthKit_HKWorkoutActivityType): boolean

Swift declaration

static func supportsActivity(_ activity: HKWorkoutActivityType) -> Bool

get · iOS 17.0+

blocks

TypeScript

get blocks(): Array<IntervalBlock>

Swift declaration

var blocks: [IntervalBlock] { get set }

set · iOS 17.0+

blocks

TypeScript

set blocks(value: Array<IntervalBlock>)

Swift declaration

var blocks: [IntervalBlock] { get set }

get · iOS 17.0+

warmup

TypeScript

get warmup(): (WorkoutStep) | null

Swift declaration

var warmup: WorkoutStep? { get set }

set · iOS 17.0+

warmup

TypeScript

set warmup(value: (WorkoutStep) | null)

Swift declaration

var warmup: WorkoutStep? { get set }

init · iOS 17.0+

init

TypeScript

static init(activity: _HealthKit_HKWorkoutActivityType, location?: _HealthKit_HKWorkoutSessionLocationType, displayName?: (string) | null, warmup?: (WorkoutStep) | null, blocks?: Array<IntervalBlock>, cooldown?: (WorkoutStep) | null): CustomWorkout

Swift declaration

init(activity: HKWorkoutActivityType, location: HKWorkoutSessionLocationType = .unknown, displayName: String? = nil, warmup: WorkoutStep? = nil, blocks: [IntervalBlock] = [], cooldown: WorkoutStep? = nil)

get · iOS 17.0+

activity

TypeScript

get activity(): _HealthKit_HKWorkoutActivityType

Swift declaration

var activity: HKWorkoutActivityType { get set }

set · iOS 17.0+

activity

TypeScript

set activity(value: _HealthKit_HKWorkoutActivityType)

Swift declaration

var activity: HKWorkoutActivityType { get set }

get · iOS 17.0+

cooldown

TypeScript

get cooldown(): (WorkoutStep) | null

Swift declaration

var cooldown: WorkoutStep? { get set }

set · iOS 17.0+

cooldown

TypeScript

set cooldown(value: (WorkoutStep) | null)

Swift declaration

var cooldown: WorkoutStep? { get set }

get · iOS 17.0+

location

TypeScript

get location(): _HealthKit_HKWorkoutSessionLocationType

Swift declaration

var location: HKWorkoutSessionLocationType { get set }

set · iOS 17.0+

location

TypeScript

set location(value: _HealthKit_HKWorkoutSessionLocationType)

Swift declaration

var location: HKWorkoutSessionLocationType { get set }

Skipped declarations

No declarations were skipped in this snapshot.

All WorkoutKit types →