apple.intents.protocol

Interface INCreateTaskListIntentHandling

All Known Subinterfaces:

INNotebookDomainHandling

public interface INCreateTaskListIntentHandling

Protocol to declare support for handling an INCreateTaskListIntent. 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	INCreateTaskListIntentHandling.Block_confirmCreateTaskListCompletion
static interface	INCreateTaskListIntentHandling.Block_handleCreateTaskListCompletion
static interface	INCreateTaskListIntentHandling.Block_resolveGroupNameForCreateTaskListWithCompletion
static interface	INCreateTaskListIntentHandling.Block_resolveTaskTitlesForCreateTaskListWithCompletion
static interface	INCreateTaskListIntentHandling.Block_resolveTitleForCreateTaskListWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmCreateTaskListCompletion(INCreateTaskListIntent intent, INCreateTaskListIntentHandling.Block_confirmCreateTaskListCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleCreateTaskListCompletion(INCreateTaskListIntent intent, INCreateTaskListIntentHandling.Block_handleCreateTaskListCompletion completion) Handling method - Execute the task represented by the INCreateTaskListIntent that's passed in
default void	resolveGroupNameForCreateTaskListWithCompletion(INCreateTaskListIntent intent, INCreateTaskListIntentHandling.Block_resolveGroupNameForCreateTaskListWithCompletion completion)
default void	resolveTaskTitlesForCreateTaskListWithCompletion(INCreateTaskListIntent intent, INCreateTaskListIntentHandling.Block_resolveTaskTitlesForCreateTaskListWithCompletion completion)
default void	resolveTitleForCreateTaskListWithCompletion(INCreateTaskListIntent intent, INCreateTaskListIntentHandling.Block_resolveTitleForCreateTaskListWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)

Method Detail

confirmCreateTaskListCompletion

default void confirmCreateTaskListCompletion(INCreateTaskListIntent intent,
                                             INCreateTaskListIntentHandling.Block_confirmCreateTaskListCompletion 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 INCreateTaskListIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INCreateTaskListIntentResponse

handleCreateTaskListCompletion

void handleCreateTaskListCompletion(INCreateTaskListIntent intent,
                                    INCreateTaskListIntentHandling.Block_handleCreateTaskListCompletion completion)

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

See Also:

INCreateTaskListIntentResponse

resolveGroupNameForCreateTaskListWithCompletion

default void resolveGroupNameForCreateTaskListWithCompletion(INCreateTaskListIntent intent,
                                                             INCreateTaskListIntentHandling.Block_resolveGroupNameForCreateTaskListWithCompletion completion)

resolveTaskTitlesForCreateTaskListWithCompletion

default void resolveTaskTitlesForCreateTaskListWithCompletion(INCreateTaskListIntent intent,
                                                              INCreateTaskListIntentHandling.Block_resolveTaskTitlesForCreateTaskListWithCompletion completion)

resolveTitleForCreateTaskListWithCompletion

default void resolveTitleForCreateTaskListWithCompletion(INCreateTaskListIntent intent,
                                                         INCreateTaskListIntentHandling.Block_resolveTitleForCreateTaskListWithCompletion 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