INCancelWorkoutIntent
A request to cancel an active workout.
Declaration
class INCancelWorkoutIntentOverview
SiriKit creates an INCancelWorkoutIntent object when the user asks to cancel a currently running workout. Canceling a workout stops the workout and doesn’t record any progress toward the workout goals. Use this intent object to get the workout parameters.
To handle this intent, the handler object in your Intents extension must adopt the INCancelWorkoutIntentHandling protocol. Your handler should confirm the request and create an INCancelWorkoutIntentResponse object to indicate it’s possible to cancel the workout. For the successful handling of the intent, SiriKit launches your app and passes it an NSUserActivity object that your app must then use to cancel 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 |