apple.intents.protocol

Interface INStartWorkoutIntentHandling

All Known Subinterfaces:

INWorkoutsDomainHandling

public interface INStartWorkoutIntentHandling

Protocol to declare support for handling an INStartWorkoutIntent. By implementing this protocol, a class can provide logic for resolving, confirming and handling the intent.

The minimum requirement for an implementing class is that it should be able to handle the intent. The resolution and confirmation methods are optional. The handling method is always called last, after resolving and confirming the intent.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	INStartWorkoutIntentHandling.Block_confirmStartWorkoutCompletion
static interface	INStartWorkoutIntentHandling.Block_handleStartWorkoutCompletion
static interface	INStartWorkoutIntentHandling.Block_resolveGoalValueForStartWorkoutWithCompletion
static interface	INStartWorkoutIntentHandling.Block_resolveIsOpenEndedForStartWorkoutWithCompletion
static interface	INStartWorkoutIntentHandling.Block_resolveWorkoutGoalUnitTypeForStartWorkoutWithCompletion
static interface	INStartWorkoutIntentHandling.Block_resolveWorkoutLocationTypeForStartWorkoutWithCompletion
static interface	INStartWorkoutIntentHandling.Block_resolveWorkoutNameForStartWorkoutWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmStartWorkoutCompletion(INStartWorkoutIntent intent, INStartWorkoutIntentHandling.Block_confirmStartWorkoutCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleStartWorkoutCompletion(INStartWorkoutIntent intent, INStartWorkoutIntentHandling.Block_handleStartWorkoutCompletion completion) Handling method - Execute the task represented by the INStartWorkoutIntent that's passed in
default void	resolveGoalValueForStartWorkoutWithCompletion(INStartWorkoutIntent intent, INStartWorkoutIntentHandling.Block_resolveGoalValueForStartWorkoutWithCompletion completion)
default void	resolveIsOpenEndedForStartWorkoutWithCompletion(INStartWorkoutIntent intent, INStartWorkoutIntentHandling.Block_resolveIsOpenEndedForStartWorkoutWithCompletion completion)
default void	resolveWorkoutGoalUnitTypeForStartWorkoutWithCompletion(INStartWorkoutIntent intent, INStartWorkoutIntentHandling.Block_resolveWorkoutGoalUnitTypeForStartWorkoutWithCompletion completion)
default void	resolveWorkoutLocationTypeForStartWorkoutWithCompletion(INStartWorkoutIntent intent, INStartWorkoutIntentHandling.Block_resolveWorkoutLocationTypeForStartWorkoutWithCompletion completion)
default void	resolveWorkoutNameForStartWorkoutWithCompletion(INStartWorkoutIntent intent, INStartWorkoutIntentHandling.Block_resolveWorkoutNameForStartWorkoutWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)

Method Detail

confirmStartWorkoutCompletion

default void confirmStartWorkoutCompletion(INStartWorkoutIntent intent,
                                           INStartWorkoutIntentHandling.Block_confirmStartWorkoutCompletion completion)

Confirmation method - Validate that this intent is ready for the next step (i.e. handling)

Called prior to asking the app to handle the intent. The app should return a response object that contains additional information about the intent, which may be relevant for the system to show the user prior to handling. If unimplemented, the system will assume the intent is valid following resolution, and will assume there is no additional information relevant to this intent.

Parameters:

intent - The input intent

completion - The response block contains an INStartWorkoutIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INStartWorkoutIntentResponse

handleStartWorkoutCompletion

void handleStartWorkoutCompletion(INStartWorkoutIntent intent,
                                  INStartWorkoutIntentHandling.Block_handleStartWorkoutCompletion completion)

Handling method - Execute the task represented by the INStartWorkoutIntent that's passed in

Called to actually execute the intent. The app must return a response for this intent.

Parameters:

intent - The input intent

completion - The response handling block takes a INStartWorkoutIntentResponse containing the details of the result of having executed the intent

See Also:

INStartWorkoutIntentResponse

resolveGoalValueForStartWorkoutWithCompletion

default void resolveGoalValueForStartWorkoutWithCompletion(INStartWorkoutIntent intent,
                                                           INStartWorkoutIntentHandling.Block_resolveGoalValueForStartWorkoutWithCompletion completion)

resolveIsOpenEndedForStartWorkoutWithCompletion

default void resolveIsOpenEndedForStartWorkoutWithCompletion(INStartWorkoutIntent intent,
                                                             INStartWorkoutIntentHandling.Block_resolveIsOpenEndedForStartWorkoutWithCompletion completion)

resolveWorkoutGoalUnitTypeForStartWorkoutWithCompletion

default void resolveWorkoutGoalUnitTypeForStartWorkoutWithCompletion(INStartWorkoutIntent intent,
                                                                     INStartWorkoutIntentHandling.Block_resolveWorkoutGoalUnitTypeForStartWorkoutWithCompletion completion)

resolveWorkoutLocationTypeForStartWorkoutWithCompletion

default void resolveWorkoutLocationTypeForStartWorkoutWithCompletion(INStartWorkoutIntent intent,
                                                                     INStartWorkoutIntentHandling.Block_resolveWorkoutLocationTypeForStartWorkoutWithCompletion completion)

resolveWorkoutNameForStartWorkoutWithCompletion

default void resolveWorkoutNameForStartWorkoutWithCompletion(INStartWorkoutIntent intent,
                                                             INStartWorkoutIntentHandling.Block_resolveWorkoutNameForStartWorkoutWithCompletion completion)

Resolution methods - Determine if this intent is ready for the next step (confirmation)

Called to make sure the app extension is capable of handling this intent in its current form. This method is for validating if the intent needs any further fleshing out.

Parameters:

intent - The input intent

completion - The response block contains an INIntentResolutionResult for the parameter being resolved

See Also:

INIntentResolutionResult