Contents

INStartWorkoutIntent

A request to start a workout for the user.

Declaration

class INStartWorkoutIntent

Mentioned in

Overview

SiriKit creates an INStartWorkoutIntent object when the user asks to start a workout using your app. A start workout intent identifies the user-selected workout type and goals.

To handle this intent, the handler object in your Intents extension must adopt the INStartWorkoutIntentHandling protocol. Your handler should confirm the request and create an INStartWorkoutIntentResponse object that indicates it’s possible to start the workout. For the successful handling of the intent, SiriKit launches your app and passes it an NSUserActivity object your app must then use to start the workout.

Additional Intent Attributes

The following table lists additional attributes of this intent object:

Attribute

Description

Supported by

Siri Intents, Siri Suggestions

Always requires unlocked device

Yes

Topics

Creating the Intent Object

Specifying Workout Details

See Also

Start a Workout