apple.intents.protocol

Interface INSaveProfileInCarIntentHandling

All Known Subinterfaces:

INCarPlayDomainHandling

public interface INSaveProfileInCarIntentHandling

Protocol to declare support for handling an INSaveProfileInCarIntent. 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	INSaveProfileInCarIntentHandling.Block_confirmSaveProfileInCarCompletion
static interface	INSaveProfileInCarIntentHandling.Block_handleSaveProfileInCarCompletion
static interface	INSaveProfileInCarIntentHandling.Block_resolveProfileNameForSaveProfileInCarWithCompletion
static interface	INSaveProfileInCarIntentHandling.Block_resolveProfileNumberForSaveProfileInCarWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmSaveProfileInCarCompletion(INSaveProfileInCarIntent intent, INSaveProfileInCarIntentHandling.Block_confirmSaveProfileInCarCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleSaveProfileInCarCompletion(INSaveProfileInCarIntent intent, INSaveProfileInCarIntentHandling.Block_handleSaveProfileInCarCompletion completion) Handling method - Execute the task represented by the INSaveProfileInCarIntent that's passed in
default void	resolveProfileNameForSaveProfileInCarWithCompletion(INSaveProfileInCarIntent intent, INSaveProfileInCarIntentHandling.Block_resolveProfileNameForSaveProfileInCarWithCompletion completion)
default void	resolveProfileNumberForSaveProfileInCarWithCompletion(INSaveProfileInCarIntent intent, INSaveProfileInCarIntentHandling.Block_resolveProfileNumberForSaveProfileInCarWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)

Method Detail

confirmSaveProfileInCarCompletion

default void confirmSaveProfileInCarCompletion(INSaveProfileInCarIntent intent,
                                               INSaveProfileInCarIntentHandling.Block_confirmSaveProfileInCarCompletion 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 INSaveProfileInCarIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INSaveProfileInCarIntentResponse

handleSaveProfileInCarCompletion

void handleSaveProfileInCarCompletion(INSaveProfileInCarIntent intent,
                                      INSaveProfileInCarIntentHandling.Block_handleSaveProfileInCarCompletion completion)

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

See Also:

INSaveProfileInCarIntentResponse

resolveProfileNameForSaveProfileInCarWithCompletion

default void resolveProfileNameForSaveProfileInCarWithCompletion(INSaveProfileInCarIntent intent,
                                                                 INSaveProfileInCarIntentHandling.Block_resolveProfileNameForSaveProfileInCarWithCompletion completion)

resolveProfileNumberForSaveProfileInCarWithCompletion

default void resolveProfileNumberForSaveProfileInCarWithCompletion(INSaveProfileInCarIntent intent,
                                                                   INSaveProfileInCarIntentHandling.Block_resolveProfileNumberForSaveProfileInCarWithCompletion 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