Package apple.intents.protocol

Interface INSearchForNotebookItemsIntentHandling

All Known Subinterfaces:

INNotebookDomainHandling

public interface INSearchForNotebookItemsIntentHandling

Protocol to declare support for handling an INSearchForNotebookItemsIntent. 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	INSearchForNotebookItemsIntentHandling.Block_confirmSearchForNotebookItemsCompletion
static interface	INSearchForNotebookItemsIntentHandling.Block_handleSearchForNotebookItemsCompletion
static interface	INSearchForNotebookItemsIntentHandling.Block_resolveContentForSearchForNotebookItemsWithCompletion
static interface	INSearchForNotebookItemsIntentHandling.Block_resolveDateSearchTypeForSearchForNotebookItemsWithCompletion
static interface	INSearchForNotebookItemsIntentHandling.Block_resolveDateTimeForSearchForNotebookItemsWithCompletion
static interface	INSearchForNotebookItemsIntentHandling.Block_resolveItemTypeForSearchForNotebookItemsWithCompletion
static interface	INSearchForNotebookItemsIntentHandling.Block_resolveLocationForSearchForNotebookItemsWithCompletion
static interface	INSearchForNotebookItemsIntentHandling.Block_resolveLocationSearchTypeForSearchForNotebookItemsWithCompletion
static interface	INSearchForNotebookItemsIntentHandling.Block_resolveStatusForSearchForNotebookItemsWithCompletion
static interface	INSearchForNotebookItemsIntentHandling.Block_resolveTaskPriorityForSearchForNotebookItemsWithCompletion
static interface	INSearchForNotebookItemsIntentHandling.Block_resolveTemporalEventTriggerTypesForSearchForNotebookItemsWithCompletion
static interface	INSearchForNotebookItemsIntentHandling.Block_resolveTitleForSearchForNotebookItemsWithCompletion

Method Summary

Modifier and Type	Method	Description
default void	confirmSearchForNotebookItemsCompletion(@NotNull INSearchForNotebookItemsIntent intent, @NotNull INSearchForNotebookItemsIntentHandling.Block_confirmSearchForNotebookItemsCompletion completion)	Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleSearchForNotebookItemsCompletion(@NotNull INSearchForNotebookItemsIntent intent, @NotNull INSearchForNotebookItemsIntentHandling.Block_handleSearchForNotebookItemsCompletion completion)	Handling method - Execute the task represented by the INSearchForNotebookItemsIntent that's passed in Called to actually execute the intent.
default void	resolveContentForSearchForNotebookItemsWithCompletion(@NotNull INSearchForNotebookItemsIntent intent, @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveContentForSearchForNotebookItemsWithCompletion completion)
default void	resolveDateSearchTypeForSearchForNotebookItemsWithCompletion(@NotNull INSearchForNotebookItemsIntent intent, @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveDateSearchTypeForSearchForNotebookItemsWithCompletion completion)
default void	resolveDateTimeForSearchForNotebookItemsWithCompletion(@NotNull INSearchForNotebookItemsIntent intent, @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveDateTimeForSearchForNotebookItemsWithCompletion completion)
default void	resolveItemTypeForSearchForNotebookItemsWithCompletion(@NotNull INSearchForNotebookItemsIntent intent, @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveItemTypeForSearchForNotebookItemsWithCompletion completion)
default void	resolveLocationForSearchForNotebookItemsWithCompletion(@NotNull INSearchForNotebookItemsIntent intent, @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveLocationForSearchForNotebookItemsWithCompletion completion)
default void	resolveLocationSearchTypeForSearchForNotebookItemsWithCompletion(@NotNull INSearchForNotebookItemsIntent intent, @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveLocationSearchTypeForSearchForNotebookItemsWithCompletion completion)
default void	resolveStatusForSearchForNotebookItemsWithCompletion(@NotNull INSearchForNotebookItemsIntent intent, @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveStatusForSearchForNotebookItemsWithCompletion completion)
default void	resolveTaskPriorityForSearchForNotebookItemsWithCompletion(@NotNull INSearchForNotebookItemsIntent intent, @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveTaskPriorityForSearchForNotebookItemsWithCompletion completion)	API-Since: 13.0
default void	resolveTemporalEventTriggerTypesForSearchForNotebookItemsWithCompletion(@NotNull INSearchForNotebookItemsIntent intent, @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveTemporalEventTriggerTypesForSearchForNotebookItemsWithCompletion completion)	API-Since: 13.0
default void	resolveTitleForSearchForNotebookItemsWithCompletion(@NotNull INSearchForNotebookItemsIntent intent, @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveTitleForSearchForNotebookItemsWithCompletion 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.

Method Detail

confirmSearchForNotebookItemsCompletion

default void confirmSearchForNotebookItemsCompletion(@NotNull
                                                     @NotNull INSearchForNotebookItemsIntent intent,
                                                     @NotNull
                                                     @NotNull INSearchForNotebookItemsIntentHandling.Block_confirmSearchForNotebookItemsCompletion 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 INSearchForNotebookItemsIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INSearchForNotebookItemsIntentResponse

handleSearchForNotebookItemsCompletion

void handleSearchForNotebookItemsCompletion(@NotNull
                                            @NotNull INSearchForNotebookItemsIntent intent,
                                            @NotNull
                                            @NotNull INSearchForNotebookItemsIntentHandling.Block_handleSearchForNotebookItemsCompletion completion)

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

See Also:

INSearchForNotebookItemsIntentResponse

resolveContentForSearchForNotebookItemsWithCompletion

default void resolveContentForSearchForNotebookItemsWithCompletion(@NotNull
                                                                   @NotNull INSearchForNotebookItemsIntent intent,
                                                                   @NotNull
                                                                   @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveContentForSearchForNotebookItemsWithCompletion completion)

resolveDateSearchTypeForSearchForNotebookItemsWithCompletion

default void resolveDateSearchTypeForSearchForNotebookItemsWithCompletion(@NotNull
                                                                          @NotNull INSearchForNotebookItemsIntent intent,
                                                                          @NotNull
                                                                          @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveDateSearchTypeForSearchForNotebookItemsWithCompletion completion)

resolveDateTimeForSearchForNotebookItemsWithCompletion

default void resolveDateTimeForSearchForNotebookItemsWithCompletion(@NotNull
                                                                    @NotNull INSearchForNotebookItemsIntent intent,
                                                                    @NotNull
                                                                    @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveDateTimeForSearchForNotebookItemsWithCompletion completion)

resolveItemTypeForSearchForNotebookItemsWithCompletion

default void resolveItemTypeForSearchForNotebookItemsWithCompletion(@NotNull
                                                                    @NotNull INSearchForNotebookItemsIntent intent,
                                                                    @NotNull
                                                                    @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveItemTypeForSearchForNotebookItemsWithCompletion completion)

resolveLocationForSearchForNotebookItemsWithCompletion

default void resolveLocationForSearchForNotebookItemsWithCompletion(@NotNull
                                                                    @NotNull INSearchForNotebookItemsIntent intent,
                                                                    @NotNull
                                                                    @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveLocationForSearchForNotebookItemsWithCompletion completion)

resolveLocationSearchTypeForSearchForNotebookItemsWithCompletion

default void resolveLocationSearchTypeForSearchForNotebookItemsWithCompletion(@NotNull
                                                                              @NotNull INSearchForNotebookItemsIntent intent,
                                                                              @NotNull
                                                                              @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveLocationSearchTypeForSearchForNotebookItemsWithCompletion completion)

resolveStatusForSearchForNotebookItemsWithCompletion

default void resolveStatusForSearchForNotebookItemsWithCompletion(@NotNull
                                                                  @NotNull INSearchForNotebookItemsIntent intent,
                                                                  @NotNull
                                                                  @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveStatusForSearchForNotebookItemsWithCompletion completion)

resolveTitleForSearchForNotebookItemsWithCompletion

default void resolveTitleForSearchForNotebookItemsWithCompletion(@NotNull
                                                                 @NotNull INSearchForNotebookItemsIntent intent,
                                                                 @NotNull
                                                                 @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveTitleForSearchForNotebookItemsWithCompletion 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

resolveTaskPriorityForSearchForNotebookItemsWithCompletion

default void resolveTaskPriorityForSearchForNotebookItemsWithCompletion(@NotNull
                                                                        @NotNull INSearchForNotebookItemsIntent intent,
                                                                        @NotNull
                                                                        @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveTaskPriorityForSearchForNotebookItemsWithCompletion completion)

API-Since: 13.0

resolveTemporalEventTriggerTypesForSearchForNotebookItemsWithCompletion

default void resolveTemporalEventTriggerTypesForSearchForNotebookItemsWithCompletion(@NotNull
                                                                                     @NotNull INSearchForNotebookItemsIntent intent,
                                                                                     @NotNull
                                                                                     @NotNull INSearchForNotebookItemsIntentHandling.Block_resolveTemporalEventTriggerTypesForSearchForNotebookItemsWithCompletion completion)

API-Since: 13.0