Package apple.intents.protocol

Interface INSearchForMessagesIntentHandling

All Known Subinterfaces:

INMessagesDomainHandling

public interface INSearchForMessagesIntentHandling

Protocol to declare support for handling an INSearchForMessagesIntent. 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: 10.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	INSearchForMessagesIntentHandling.Block_confirmSearchForMessagesCompletion
static interface	INSearchForMessagesIntentHandling.Block_handleSearchForMessagesCompletion
static interface	INSearchForMessagesIntentHandling.Block_resolveAttributesForSearchForMessagesWithCompletion
static interface	INSearchForMessagesIntentHandling.Block_resolveDateTimeRangeForSearchForMessagesWithCompletion
static interface	INSearchForMessagesIntentHandling.Block_resolveGroupNamesForSearchForMessagesWithCompletion
static interface	INSearchForMessagesIntentHandling.Block_resolveRecipientsForSearchForMessagesWithCompletion
static interface	INSearchForMessagesIntentHandling.Block_resolveSendersForSearchForMessagesWithCompletion
static interface	INSearchForMessagesIntentHandling.Block_resolveSpeakableGroupNamesForSearchForMessagesWithCompletion

Method Summary

Modifier and Type	Method	Description
default void	confirmSearchForMessagesCompletion(@NotNull INSearchForMessagesIntent intent, @NotNull INSearchForMessagesIntentHandling.Block_confirmSearchForMessagesCompletion completion)	Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleSearchForMessagesCompletion(@NotNull INSearchForMessagesIntent intent, @NotNull INSearchForMessagesIntentHandling.Block_handleSearchForMessagesCompletion completion)	Handling method - Execute the task represented by the INSearchForMessagesIntent that's passed in Called to actually execute the intent.
default void	resolveAttributesForSearchForMessagesWithCompletion(@NotNull INSearchForMessagesIntent intent, @NotNull INSearchForMessagesIntentHandling.Block_resolveAttributesForSearchForMessagesWithCompletion completion)
default void	resolveDateTimeRangeForSearchForMessagesWithCompletion(@NotNull INSearchForMessagesIntent intent, @NotNull INSearchForMessagesIntentHandling.Block_resolveDateTimeRangeForSearchForMessagesWithCompletion completion)
default void	resolveGroupNamesForSearchForMessagesWithCompletion(@NotNull INSearchForMessagesIntent intent, @NotNull INSearchForMessagesIntentHandling.Block_resolveGroupNamesForSearchForMessagesWithCompletion completion)	Deprecated.
default void	resolveRecipientsForSearchForMessagesWithCompletion(@NotNull INSearchForMessagesIntent intent, @NotNull INSearchForMessagesIntentHandling.Block_resolveRecipientsForSearchForMessagesWithCompletion 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	resolveSendersForSearchForMessagesWithCompletion(@NotNull INSearchForMessagesIntent intent, @NotNull INSearchForMessagesIntentHandling.Block_resolveSendersForSearchForMessagesWithCompletion completion)
default void	resolveSpeakableGroupNamesForSearchForMessagesWithCompletion(@NotNull INSearchForMessagesIntent intent, @NotNull INSearchForMessagesIntentHandling.Block_resolveSpeakableGroupNamesForSearchForMessagesWithCompletion completion)	API-Since: 11.0

Method Detail

confirmSearchForMessagesCompletion

default void confirmSearchForMessagesCompletion(@NotNull
                                                @NotNull INSearchForMessagesIntent intent,
                                                @NotNull
                                                @NotNull INSearchForMessagesIntentHandling.Block_confirmSearchForMessagesCompletion 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 INSearchForMessagesIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INSearchForMessagesIntentResponse

handleSearchForMessagesCompletion

void handleSearchForMessagesCompletion(@NotNull
                                       @NotNull INSearchForMessagesIntent intent,
                                       @NotNull
                                       @NotNull INSearchForMessagesIntentHandling.Block_handleSearchForMessagesCompletion completion)

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

See Also:

INSearchForMessagesIntentResponse

resolveAttributesForSearchForMessagesWithCompletion

default void resolveAttributesForSearchForMessagesWithCompletion(@NotNull
                                                                 @NotNull INSearchForMessagesIntent intent,
                                                                 @NotNull
                                                                 @NotNull INSearchForMessagesIntentHandling.Block_resolveAttributesForSearchForMessagesWithCompletion completion)

resolveDateTimeRangeForSearchForMessagesWithCompletion

default void resolveDateTimeRangeForSearchForMessagesWithCompletion(@NotNull
                                                                    @NotNull INSearchForMessagesIntent intent,
                                                                    @NotNull
                                                                    @NotNull INSearchForMessagesIntentHandling.Block_resolveDateTimeRangeForSearchForMessagesWithCompletion completion)

resolveGroupNamesForSearchForMessagesWithCompletion

@Deprecated
default void resolveGroupNamesForSearchForMessagesWithCompletion(@NotNull
                                                                 @NotNull INSearchForMessagesIntent intent,
                                                                 @NotNull
                                                                 @NotNull INSearchForMessagesIntentHandling.Block_resolveGroupNamesForSearchForMessagesWithCompletion completion)

Deprecated.

API-Since: 10.0 Deprecated-Since: 11.0 Deprecated-Message: resolveGroupNamesForSearchForMessages:withCompletion: is deprecated. Use resolveSpeakableGroupNamesForSearchForMessages:withCompletion: instead

resolveRecipientsForSearchForMessagesWithCompletion

default void resolveRecipientsForSearchForMessagesWithCompletion(@NotNull
                                                                 @NotNull INSearchForMessagesIntent intent,
                                                                 @NotNull
                                                                 @NotNull INSearchForMessagesIntentHandling.Block_resolveRecipientsForSearchForMessagesWithCompletion 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

resolveSendersForSearchForMessagesWithCompletion

default void resolveSendersForSearchForMessagesWithCompletion(@NotNull
                                                              @NotNull INSearchForMessagesIntent intent,
                                                              @NotNull
                                                              @NotNull INSearchForMessagesIntentHandling.Block_resolveSendersForSearchForMessagesWithCompletion completion)

resolveSpeakableGroupNamesForSearchForMessagesWithCompletion

default void resolveSpeakableGroupNamesForSearchForMessagesWithCompletion(@NotNull
                                                                          @NotNull INSearchForMessagesIntent intent,
                                                                          @NotNull
                                                                          @NotNull INSearchForMessagesIntentHandling.Block_resolveSpeakableGroupNamesForSearchForMessagesWithCompletion completion)

API-Since: 11.0