apple.intents.protocol

Interface INAddTasksIntentHandling

All Known Subinterfaces:

INNotebookDomainHandling

public interface INAddTasksIntentHandling

Protocol to declare support for handling an INAddTasksIntent. 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	INAddTasksIntentHandling.Block_confirmAddTasksCompletion
static interface	INAddTasksIntentHandling.Block_handleAddTasksCompletion
static interface	INAddTasksIntentHandling.Block_resolvePriorityForAddTasksWithCompletion
static interface	INAddTasksIntentHandling.Block_resolveSpatialEventTriggerForAddTasksWithCompletion
static interface	INAddTasksIntentHandling.Block_resolveTargetTaskListForAddTasksCompletion
static interface	INAddTasksIntentHandling.Block_resolveTargetTaskListForAddTasksWithCompletion
static interface	INAddTasksIntentHandling.Block_resolveTaskTitlesForAddTasksWithCompletion
static interface	INAddTasksIntentHandling.Block_resolveTemporalEventTriggerForAddTasksCompletion
static interface	INAddTasksIntentHandling.Block_resolveTemporalEventTriggerForAddTasksWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmAddTasksCompletion(INAddTasksIntent intent, INAddTasksIntentHandling.Block_confirmAddTasksCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleAddTasksCompletion(INAddTasksIntent intent, INAddTasksIntentHandling.Block_handleAddTasksCompletion completion) Handling method - Execute the task represented by the INAddTasksIntent that's passed in
default void	resolvePriorityForAddTasksWithCompletion(INAddTasksIntent intent, INAddTasksIntentHandling.Block_resolvePriorityForAddTasksWithCompletion completion)
default void	resolveSpatialEventTriggerForAddTasksWithCompletion(INAddTasksIntent intent, INAddTasksIntentHandling.Block_resolveSpatialEventTriggerForAddTasksWithCompletion completion)
default void	resolveTargetTaskListForAddTasksCompletion(INAddTasksIntent intent, INAddTasksIntentHandling.Block_resolveTargetTaskListForAddTasksCompletion completion)
default void	resolveTargetTaskListForAddTasksWithCompletion(INAddTasksIntent intent, INAddTasksIntentHandling.Block_resolveTargetTaskListForAddTasksWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)
default void	resolveTaskTitlesForAddTasksWithCompletion(INAddTasksIntent intent, INAddTasksIntentHandling.Block_resolveTaskTitlesForAddTasksWithCompletion completion)
default void	resolveTemporalEventTriggerForAddTasksCompletion(INAddTasksIntent intent, INAddTasksIntentHandling.Block_resolveTemporalEventTriggerForAddTasksCompletion completion)
default void	resolveTemporalEventTriggerForAddTasksWithCompletion(INAddTasksIntent intent, INAddTasksIntentHandling.Block_resolveTemporalEventTriggerForAddTasksWithCompletion completion)

Method Detail

confirmAddTasksCompletion

default void confirmAddTasksCompletion(INAddTasksIntent intent,
                                       INAddTasksIntentHandling.Block_confirmAddTasksCompletion 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 INAddTasksIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INAddTasksIntentResponse

handleAddTasksCompletion

void handleAddTasksCompletion(INAddTasksIntent intent,
                              INAddTasksIntentHandling.Block_handleAddTasksCompletion completion)

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

See Also:

INAddTasksIntentResponse

resolveSpatialEventTriggerForAddTasksWithCompletion

default void resolveSpatialEventTriggerForAddTasksWithCompletion(INAddTasksIntent intent,
                                                                 INAddTasksIntentHandling.Block_resolveSpatialEventTriggerForAddTasksWithCompletion completion)

resolveTargetTaskListForAddTasksWithCompletion

default void resolveTargetTaskListForAddTasksWithCompletion(INAddTasksIntent intent,
                                                            INAddTasksIntentHandling.Block_resolveTargetTaskListForAddTasksWithCompletion 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

resolveTaskTitlesForAddTasksWithCompletion

default void resolveTaskTitlesForAddTasksWithCompletion(INAddTasksIntent intent,
                                                        INAddTasksIntentHandling.Block_resolveTaskTitlesForAddTasksWithCompletion completion)

resolveTemporalEventTriggerForAddTasksWithCompletion

default void resolveTemporalEventTriggerForAddTasksWithCompletion(INAddTasksIntent intent,
                                                                  INAddTasksIntentHandling.Block_resolveTemporalEventTriggerForAddTasksWithCompletion completion)

resolvePriorityForAddTasksWithCompletion

default void resolvePriorityForAddTasksWithCompletion(INAddTasksIntent intent,
                                                      INAddTasksIntentHandling.Block_resolvePriorityForAddTasksWithCompletion completion)

resolveTargetTaskListForAddTasksCompletion

default void resolveTargetTaskListForAddTasksCompletion(INAddTasksIntent intent,
                                                        INAddTasksIntentHandling.Block_resolveTargetTaskListForAddTasksCompletion completion)

resolveTemporalEventTriggerForAddTasksCompletion

default void resolveTemporalEventTriggerForAddTasksCompletion(INAddTasksIntent intent,
                                                              INAddTasksIntentHandling.Block_resolveTemporalEventTriggerForAddTasksCompletion completion)