Package apple.intents.protocol

Interface INUnsendMessagesIntentHandling

public interface INUnsendMessagesIntentHandling

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	INUnsendMessagesIntentHandling.Block_confirmUnsendMessagesCompletion
static interface	INUnsendMessagesIntentHandling.Block_handleUnsendMessagesCompletion

Method Summary

Modifier and Type	Method	Description
default void	confirmUnsendMessagesCompletion(@NotNull INUnsendMessagesIntent intent, @NotNull INUnsendMessagesIntentHandling.Block_confirmUnsendMessagesCompletion completion)	Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleUnsendMessagesCompletion(@NotNull INUnsendMessagesIntent intent, @NotNull INUnsendMessagesIntentHandling.Block_handleUnsendMessagesCompletion completion)	Handling method - Execute the task represented by the INUnsendMessagesIntent that's passed in Called to actually execute the intent.

Method Detail

confirmUnsendMessagesCompletion

default void confirmUnsendMessagesCompletion(@NotNull
                                             @NotNull INUnsendMessagesIntent intent,
                                             @NotNull
                                             @NotNull INUnsendMessagesIntentHandling.Block_confirmUnsendMessagesCompletion 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 INUnsendMessagesIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INUnsendMessagesIntentResponse

handleUnsendMessagesCompletion

void handleUnsendMessagesCompletion(@NotNull
                                    @NotNull INUnsendMessagesIntent intent,
                                    @NotNull
                                    @NotNull INUnsendMessagesIntentHandling.Block_handleUnsendMessagesCompletion completion)

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

See Also:

INUnsendMessagesIntentResponse