App Services · IOS API REFERENCE

WorkoutKit

Create, preview, and sync workout compositions to the Workout app.

29 types

141 callable entries

14 skipped

91% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

CadenceRangeAlert

struct · iOS 17.0+

CadenceThresholdAlert

struct · iOS 17.0+

CustomWorkout

struct · iOS 17.0+

HeartRateRangeAlert

struct · iOS 17.0+

HeartRateZoneAlert

struct · iOS 17.0+

IntervalBlock

struct · iOS 17.0+

IntervalStep

struct · iOS 17.0+

IntervalStep.Purpose

enum · iOS 17.0+

PacerWorkout

struct · iOS 17.0+

PowerRangeAlert

struct · iOS 17.0+

PowerThresholdAlert

struct · iOS 17.0+

PowerZoneAlert

struct · iOS 17.0+

ScheduledWorkoutPlan

struct · iOS 17.0+

SingleGoalWorkout

struct · iOS 17.0+

SpeedRangeAlert

struct · iOS 17.0+

SpeedThresholdAlert

struct · iOS 17.0+

StateError

enum · iOS 17.0+

SwimBikeRunWorkout

struct · iOS 17.0+

SwimBikeRunWorkout.Activity

enum · iOS 17.0+

WorkoutAlert

protocol · iOS 17.0+

WorkoutAlertMetric

enum · iOS 17.0+

WorkoutGoal

enum · iOS 17.0+

WorkoutPlan

struct · iOS 17.0+

WorkoutPlan.ID

typealias · iOS 17.0+

WorkoutPlan.Workout

enum · iOS 17.0+

WorkoutScheduler

class · iOS 17.0+

WorkoutScheduler.AuthorizationState

enum · iOS 17.0+

WorkoutScheduler.AuthorizationState.RawValue

typealias · iOS 17.0+

WorkoutStep

struct · iOS 17.0+

Functions and constants

get · iOS 17.0+

workoutPlan

TypeScript

get workoutPlan(): Promise<(WorkoutPlan) | null>

Swift declaration

var workoutPlan: WorkoutPlan? { get async throws }

Skipped declarations

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

WorkoutAlert.heartRate(_:unit:)