apple.intents.protocol

Interface INEndWorkoutIntentHandling

All Known Subinterfaces:

INWorkoutsDomainHandling

public interface INEndWorkoutIntentHandling

Protocol to declare support for handling an INEndWorkoutIntent. 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	INEndWorkoutIntentHandling.Block_confirmEndWorkoutCompletion
static interface	INEndWorkoutIntentHandling.Block_handleEndWorkoutCompletion
static interface	INEndWorkoutIntentHandling.Block_resolveWorkoutNameForEndWorkoutWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmEndWorkoutCompletion(INEndWorkoutIntent intent, INEndWorkoutIntentHandling.Block_confirmEndWorkoutCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleEndWorkoutCompletion(INEndWorkoutIntent intent, INEndWorkoutIntentHandling.Block_handleEndWorkoutCompletion completion) Handling method - Execute the task represented by the INEndWorkoutIntent that's passed in
default void	resolveWorkoutNameForEndWorkoutWithCompletion(INEndWorkoutIntent intent, INEndWorkoutIntentHandling.Block_resolveWorkoutNameForEndWorkoutWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)

Method Detail

confirmEndWorkoutCompletion

default void confirmEndWorkoutCompletion(INEndWorkoutIntent intent,
                                         INEndWorkoutIntentHandling.Block_confirmEndWorkoutCompletion 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 INEndWorkoutIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INEndWorkoutIntentResponse

handleEndWorkoutCompletion

void handleEndWorkoutCompletion(INEndWorkoutIntent intent,
                                INEndWorkoutIntentHandling.Block_handleEndWorkoutCompletion completion)

Handling method - Execute the task represented by the INEndWorkoutIntent 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 INEndWorkoutIntentResponse containing the details of the result of having executed the intent

See Also:

INEndWorkoutIntentResponse

resolveWorkoutNameForEndWorkoutWithCompletion

default void resolveWorkoutNameForEndWorkoutWithCompletion(INEndWorkoutIntent intent,
                                                           INEndWorkoutIntentHandling.Block_resolveWorkoutNameForEndWorkoutWithCompletion 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