Protocol

INStartWorkoutIntentHandling

An interface that handles requests to start a workout.

Declaration

protocol INStartWorkoutIntentHandling

Overview

Use the methods of the INStartWorkoutIntentHandling protocol to resolve, confirm, and handle requests to start a workout using your app. Adopt this protocol in an object of your Intents extension capable of validating the workout name or goals.

You don’t actually start a workout from your Intents extension. When your handle(intent:completion:) returns, Siri launches your app and passes it an NSUserActivity object that contains the INStartWorkoutIntent object and your response. Your app uses the information in those objects to start the workout.

Topics

Resolving the Intent Parameters

func resolveWorkoutName(for: INStartWorkoutIntent, with: (INSpeakableStringResolutionResult) -> Void)

Resolves the workout name selected by the user.

func resolveGoalValue(for: INStartWorkoutIntent, with: (INDoubleResolutionResult) -> Void)

Resolves the numerical goal of a user’s workout.

func resolveWorkoutGoalUnitType(for: INStartWorkoutIntent, with: (INWorkoutGoalUnitTypeResolutionResult) -> Void)

Resolves the units for the user’s workout goal.

func resolveWorkoutLocationType(for: INStartWorkoutIntent, with: (INWorkoutLocationTypeResolutionResult) -> Void)

Resolves the location type of a user’s workout.

func resolveIsOpenEnded(for: INStartWorkoutIntent, with: (INBooleanResolutionResult) -> Void)

Resolves whether the user’s workout is open ended.

Confirming the Response

func confirm(intent: INStartWorkoutIntent, completion: (INStartWorkoutIntentResponse) -> Void)

Validates that your app is able to start the workout.

Handling the Intent

func handle(intent: INStartWorkoutIntent, completion: (INStartWorkoutIntentResponse) -> Void)

Handles starting the workout.

Required.

Relationships

Inherits From

Inherited By

See Also

Start a Workout

class INStartWorkoutIntent

A request to start a workout for the user.

class INStartWorkoutIntentResponse

Your app’s response to a start workout intent.