Package apple.intents.protocol

Interface INSetTaskAttributeIntentHandling

All Known Subinterfaces:

INNotebookDomainHandling

public interface INSetTaskAttributeIntentHandling

Protocol to declare support for handling an INSetTaskAttributeIntent. 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. API-Since: 11.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	INSetTaskAttributeIntentHandling.Block_confirmSetTaskAttributeCompletion
static interface	INSetTaskAttributeIntentHandling.Block_handleSetTaskAttributeCompletion
static interface	INSetTaskAttributeIntentHandling.Block_resolvePriorityForSetTaskAttributeWithCompletion
static interface	INSetTaskAttributeIntentHandling.Block_resolveSpatialEventTriggerForSetTaskAttributeWithCompletion
static interface	INSetTaskAttributeIntentHandling.Block_resolveStatusForSetTaskAttributeWithCompletion
static interface	INSetTaskAttributeIntentHandling.Block_resolveTargetTaskForSetTaskAttributeWithCompletion
static interface	INSetTaskAttributeIntentHandling.Block_resolveTaskTitleForSetTaskAttributeWithCompletion
static interface	INSetTaskAttributeIntentHandling.Block_resolveTemporalEventTriggerForSetTaskAttributeCompletion
static interface	INSetTaskAttributeIntentHandling.Block_resolveTemporalEventTriggerForSetTaskAttributeWithCompletion

Method Summary

Modifier and Type	Method	Description
default void	confirmSetTaskAttributeCompletion(@NotNull INSetTaskAttributeIntent intent, @NotNull INSetTaskAttributeIntentHandling.Block_confirmSetTaskAttributeCompletion completion)	Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleSetTaskAttributeCompletion(@NotNull INSetTaskAttributeIntent intent, @NotNull INSetTaskAttributeIntentHandling.Block_handleSetTaskAttributeCompletion completion)	Handling method - Execute the task represented by the INSetTaskAttributeIntent that's passed in Called to actually execute the intent.
default void	resolvePriorityForSetTaskAttributeWithCompletion(@NotNull INSetTaskAttributeIntent intent, @NotNull INSetTaskAttributeIntentHandling.Block_resolvePriorityForSetTaskAttributeWithCompletion completion)	API-Since: 13.0
default void	resolveSpatialEventTriggerForSetTaskAttributeWithCompletion(@NotNull INSetTaskAttributeIntent intent, @NotNull INSetTaskAttributeIntentHandling.Block_resolveSpatialEventTriggerForSetTaskAttributeWithCompletion completion)
default void	resolveStatusForSetTaskAttributeWithCompletion(@NotNull INSetTaskAttributeIntent intent, @NotNull INSetTaskAttributeIntentHandling.Block_resolveStatusForSetTaskAttributeWithCompletion completion)
default void	resolveTargetTaskForSetTaskAttributeWithCompletion(@NotNull INSetTaskAttributeIntent intent, @NotNull INSetTaskAttributeIntentHandling.Block_resolveTargetTaskForSetTaskAttributeWithCompletion 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.
default void	resolveTaskTitleForSetTaskAttributeWithCompletion(@NotNull INSetTaskAttributeIntent intent, @NotNull INSetTaskAttributeIntentHandling.Block_resolveTaskTitleForSetTaskAttributeWithCompletion completion)	API-Since: 13.0
default void	resolveTemporalEventTriggerForSetTaskAttributeCompletion(@NotNull INSetTaskAttributeIntent intent, @NotNull INSetTaskAttributeIntentHandling.Block_resolveTemporalEventTriggerForSetTaskAttributeCompletion completion)	API-Since: 13.0
default void	resolveTemporalEventTriggerForSetTaskAttributeWithCompletion(@NotNull INSetTaskAttributeIntent intent, @NotNull INSetTaskAttributeIntentHandling.Block_resolveTemporalEventTriggerForSetTaskAttributeWithCompletion completion)	Deprecated.

Method Detail

confirmSetTaskAttributeCompletion

default void confirmSetTaskAttributeCompletion(@NotNull
                                               @NotNull INSetTaskAttributeIntent intent,
                                               @NotNull
                                               @NotNull INSetTaskAttributeIntentHandling.Block_confirmSetTaskAttributeCompletion 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 INSetTaskAttributeIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INSetTaskAttributeIntentResponse

handleSetTaskAttributeCompletion

void handleSetTaskAttributeCompletion(@NotNull
                                      @NotNull INSetTaskAttributeIntent intent,
                                      @NotNull
                                      @NotNull INSetTaskAttributeIntentHandling.Block_handleSetTaskAttributeCompletion completion)

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

See Also:

INSetTaskAttributeIntentResponse

resolveSpatialEventTriggerForSetTaskAttributeWithCompletion

default void resolveSpatialEventTriggerForSetTaskAttributeWithCompletion(@NotNull
                                                                         @NotNull INSetTaskAttributeIntent intent,
                                                                         @NotNull
                                                                         @NotNull INSetTaskAttributeIntentHandling.Block_resolveSpatialEventTriggerForSetTaskAttributeWithCompletion completion)

resolveStatusForSetTaskAttributeWithCompletion

default void resolveStatusForSetTaskAttributeWithCompletion(@NotNull
                                                            @NotNull INSetTaskAttributeIntent intent,
                                                            @NotNull
                                                            @NotNull INSetTaskAttributeIntentHandling.Block_resolveStatusForSetTaskAttributeWithCompletion completion)

resolveTargetTaskForSetTaskAttributeWithCompletion

default void resolveTargetTaskForSetTaskAttributeWithCompletion(@NotNull
                                                                @NotNull INSetTaskAttributeIntent intent,
                                                                @NotNull
                                                                @NotNull INSetTaskAttributeIntentHandling.Block_resolveTargetTaskForSetTaskAttributeWithCompletion 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

resolveTemporalEventTriggerForSetTaskAttributeWithCompletion

@Deprecated
default void resolveTemporalEventTriggerForSetTaskAttributeWithCompletion(@NotNull
                                                                          @NotNull INSetTaskAttributeIntent intent,
                                                                          @NotNull
                                                                          @NotNull INSetTaskAttributeIntentHandling.Block_resolveTemporalEventTriggerForSetTaskAttributeWithCompletion completion)

Deprecated.

API-Since: 11.0 Deprecated-Since: 13.0 Deprecated-Message: resolveTemporalEventTriggerForSetTaskAttribute:withCompletion: is deprecated. Use resolveTemporalEventTriggerForSetTaskAttribute:completion: instead

resolvePriorityForSetTaskAttributeWithCompletion

default void resolvePriorityForSetTaskAttributeWithCompletion(@NotNull
                                                              @NotNull INSetTaskAttributeIntent intent,
                                                              @NotNull
                                                              @NotNull INSetTaskAttributeIntentHandling.Block_resolvePriorityForSetTaskAttributeWithCompletion completion)

API-Since: 13.0

resolveTaskTitleForSetTaskAttributeWithCompletion

default void resolveTaskTitleForSetTaskAttributeWithCompletion(@NotNull
                                                               @NotNull INSetTaskAttributeIntent intent,
                                                               @NotNull
                                                               @NotNull INSetTaskAttributeIntentHandling.Block_resolveTaskTitleForSetTaskAttributeWithCompletion completion)

API-Since: 13.0

resolveTemporalEventTriggerForSetTaskAttributeCompletion

default void resolveTemporalEventTriggerForSetTaskAttributeCompletion(@NotNull
                                                                      @NotNull INSetTaskAttributeIntent intent,
                                                                      @NotNull
                                                                      @NotNull INSetTaskAttributeIntentHandling.Block_resolveTemporalEventTriggerForSetTaskAttributeCompletion completion)

API-Since: 13.0