Package apple.intents.protocol

Interface INSendMessageIntentHandling

All Known Subinterfaces:

INMessagesDomainHandling

public interface INSendMessageIntentHandling

Protocol to declare support for handling an INSendMessageIntent. 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	INSendMessageIntentHandling.Block_confirmSendMessageCompletion
static interface	INSendMessageIntentHandling.Block_handleSendMessageCompletion
static interface	INSendMessageIntentHandling.Block_resolveContentForSendMessageWithCompletion
static interface	INSendMessageIntentHandling.Block_resolveGroupNameForSendMessageWithCompletion
static interface	INSendMessageIntentHandling.Block_resolveOutgoingMessageTypeForSendMessageWithCompletion
static interface	INSendMessageIntentHandling.Block_resolveRecipientsForSendMessageCompletion
static interface	INSendMessageIntentHandling.Block_resolveRecipientsForSendMessageWithCompletion
static interface	INSendMessageIntentHandling.Block_resolveSpeakableGroupNameForSendMessageWithCompletion

Method Summary

Modifier and Type	Method	Description
default void	confirmSendMessageCompletion(@NotNull INSendMessageIntent intent, @NotNull INSendMessageIntentHandling.Block_confirmSendMessageCompletion completion)	Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleSendMessageCompletion(@NotNull INSendMessageIntent intent, @NotNull INSendMessageIntentHandling.Block_handleSendMessageCompletion completion)	Handling method - Execute the task represented by the INSendMessageIntent that's passed in Called to actually execute the intent.
default void	resolveContentForSendMessageWithCompletion(@NotNull INSendMessageIntent intent, @NotNull INSendMessageIntentHandling.Block_resolveContentForSendMessageWithCompletion completion)
default void	resolveGroupNameForSendMessageWithCompletion(@NotNull INSendMessageIntent intent, @NotNull INSendMessageIntentHandling.Block_resolveGroupNameForSendMessageWithCompletion completion)	Deprecated.
default void	resolveOutgoingMessageTypeForSendMessageWithCompletion(@NotNull INSendMessageIntent intent, @NotNull INSendMessageIntentHandling.Block_resolveOutgoingMessageTypeForSendMessageWithCompletion completion)	API-Since: 14.0
default void	resolveRecipientsForSendMessageCompletion(@NotNull INSendMessageIntent intent, @NotNull INSendMessageIntentHandling.Block_resolveRecipientsForSendMessageCompletion completion)	API-Since: 11.0
default void	resolveRecipientsForSendMessageWithCompletion(@NotNull INSendMessageIntent intent, @NotNull INSendMessageIntentHandling.Block_resolveRecipientsForSendMessageWithCompletion completion)	Deprecated.
default void	resolveSpeakableGroupNameForSendMessageWithCompletion(@NotNull INSendMessageIntent intent, @NotNull INSendMessageIntentHandling.Block_resolveSpeakableGroupNameForSendMessageWithCompletion completion)	API-Since: 11.0

Method Detail

confirmSendMessageCompletion

default void confirmSendMessageCompletion(@NotNull
                                          @NotNull INSendMessageIntent intent,
                                          @NotNull
                                          @NotNull INSendMessageIntentHandling.Block_confirmSendMessageCompletion 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 INSendMessageIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INSendMessageIntentResponse

handleSendMessageCompletion

void handleSendMessageCompletion(@NotNull
                                 @NotNull INSendMessageIntent intent,
                                 @NotNull
                                 @NotNull INSendMessageIntentHandling.Block_handleSendMessageCompletion completion)

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

See Also:

INSendMessageIntentResponse

resolveContentForSendMessageWithCompletion

default void resolveContentForSendMessageWithCompletion(@NotNull
                                                        @NotNull INSendMessageIntent intent,
                                                        @NotNull
                                                        @NotNull INSendMessageIntentHandling.Block_resolveContentForSendMessageWithCompletion completion)

resolveGroupNameForSendMessageWithCompletion

@Deprecated
default void resolveGroupNameForSendMessageWithCompletion(@NotNull
                                                          @NotNull INSendMessageIntent intent,
                                                          @NotNull
                                                          @NotNull INSendMessageIntentHandling.Block_resolveGroupNameForSendMessageWithCompletion completion)

Deprecated.

API-Since: 10.0 Deprecated-Since: 11.0 Deprecated-Message: resolveGroupNameForSendMessage:withCompletion: is deprecated. Use resolveSpeakableGroupNameForSendMessage:withCompletion: instead

resolveRecipientsForSendMessageWithCompletion

@Deprecated
default void resolveRecipientsForSendMessageWithCompletion(@NotNull
                                                           @NotNull INSendMessageIntent intent,
                                                           @NotNull
                                                           @NotNull INSendMessageIntentHandling.Block_resolveRecipientsForSendMessageWithCompletion completion)

Deprecated.

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:

API-Since: 10.0 Deprecated-Since: 11.0 Deprecated-Message: resolveRecipientsForSendMessage:withCompletion: is deprecated. Use resolveRecipientsForSendMessage:completion: instead

resolveRecipientsForSendMessageCompletion

default void resolveRecipientsForSendMessageCompletion(@NotNull
                                                       @NotNull INSendMessageIntent intent,
                                                       @NotNull
                                                       @NotNull INSendMessageIntentHandling.Block_resolveRecipientsForSendMessageCompletion completion)

API-Since: 11.0

resolveSpeakableGroupNameForSendMessageWithCompletion

default void resolveSpeakableGroupNameForSendMessageWithCompletion(@NotNull
                                                                   @NotNull INSendMessageIntent intent,
                                                                   @NotNull
                                                                   @NotNull INSendMessageIntentHandling.Block_resolveSpeakableGroupNameForSendMessageWithCompletion completion)

API-Since: 11.0

resolveOutgoingMessageTypeForSendMessageWithCompletion

default void resolveOutgoingMessageTypeForSendMessageWithCompletion(@NotNull
                                                                    @NotNull INSendMessageIntent intent,
                                                                    @NotNull
                                                                    @NotNull INSendMessageIntentHandling.Block_resolveOutgoingMessageTypeForSendMessageWithCompletion completion)

API-Since: 14.0