apple.intents.protocol

Interface INActivateCarSignalIntentHandling

All Known Subinterfaces:

INCarCommandsDomainHandling

public interface INActivateCarSignalIntentHandling

Protocol to declare support for handling an INActivateCarSignalIntent. 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	INActivateCarSignalIntentHandling.Block_confirmActivateCarSignalCompletion
static interface	INActivateCarSignalIntentHandling.Block_handleActivateCarSignalCompletion
static interface	INActivateCarSignalIntentHandling.Block_resolveCarNameForActivateCarSignalWithCompletion
static interface	INActivateCarSignalIntentHandling.Block_resolveSignalsForActivateCarSignalWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmActivateCarSignalCompletion(INActivateCarSignalIntent intent, INActivateCarSignalIntentHandling.Block_confirmActivateCarSignalCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleActivateCarSignalCompletion(INActivateCarSignalIntent intent, INActivateCarSignalIntentHandling.Block_handleActivateCarSignalCompletion completion) Handling method - Execute the task represented by the INActivateCarSignalIntent that's passed in
default void	resolveCarNameForActivateCarSignalWithCompletion(INActivateCarSignalIntent intent, INActivateCarSignalIntentHandling.Block_resolveCarNameForActivateCarSignalWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)
default void	resolveSignalsForActivateCarSignalWithCompletion(INActivateCarSignalIntent intent, INActivateCarSignalIntentHandling.Block_resolveSignalsForActivateCarSignalWithCompletion completion)

Method Detail

confirmActivateCarSignalCompletion

default void confirmActivateCarSignalCompletion(INActivateCarSignalIntent intent,
                                                INActivateCarSignalIntentHandling.Block_confirmActivateCarSignalCompletion 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 INActivateCarSignalIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INActivateCarSignalIntentResponse

handleActivateCarSignalCompletion

void handleActivateCarSignalCompletion(INActivateCarSignalIntent intent,
                                       INActivateCarSignalIntentHandling.Block_handleActivateCarSignalCompletion completion)

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

See Also:

INActivateCarSignalIntentResponse

resolveCarNameForActivateCarSignalWithCompletion

default void resolveCarNameForActivateCarSignalWithCompletion(INActivateCarSignalIntent intent,
                                                              INActivateCarSignalIntentHandling.Block_resolveCarNameForActivateCarSignalWithCompletion 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

resolveSignalsForActivateCarSignalWithCompletion

default void resolveSignalsForActivateCarSignalWithCompletion(INActivateCarSignalIntent intent,
                                                              INActivateCarSignalIntentHandling.Block_resolveSignalsForActivateCarSignalWithCompletion completion)