apple.intents.protocol

Interface INSetProfileInCarIntentHandling

All Known Subinterfaces:

INCarPlayDomainHandling

public interface INSetProfileInCarIntentHandling

Protocol to declare support for handling an INSetProfileInCarIntent. 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	INSetProfileInCarIntentHandling.Block_confirmSetProfileInCarCompletion
static interface	INSetProfileInCarIntentHandling.Block_handleSetProfileInCarCompletion
static interface	INSetProfileInCarIntentHandling.Block_resolveCarNameForSetProfileInCarWithCompletion
static interface	INSetProfileInCarIntentHandling.Block_resolveDefaultProfileForSetProfileInCarWithCompletion
static interface	INSetProfileInCarIntentHandling.Block_resolveProfileNameForSetProfileInCarWithCompletion
static interface	INSetProfileInCarIntentHandling.Block_resolveProfileNumberForSetProfileInCarWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmSetProfileInCarCompletion(INSetProfileInCarIntent intent, INSetProfileInCarIntentHandling.Block_confirmSetProfileInCarCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleSetProfileInCarCompletion(INSetProfileInCarIntent intent, INSetProfileInCarIntentHandling.Block_handleSetProfileInCarCompletion completion) Handling method - Execute the task represented by the INSetProfileInCarIntent that's passed in
default void	resolveCarNameForSetProfileInCarWithCompletion(INSetProfileInCarIntent intent, INSetProfileInCarIntentHandling.Block_resolveCarNameForSetProfileInCarWithCompletion completion)
default void	resolveDefaultProfileForSetProfileInCarWithCompletion(INSetProfileInCarIntent intent, INSetProfileInCarIntentHandling.Block_resolveDefaultProfileForSetProfileInCarWithCompletion completion)
default void	resolveProfileNameForSetProfileInCarWithCompletion(INSetProfileInCarIntent intent, INSetProfileInCarIntentHandling.Block_resolveProfileNameForSetProfileInCarWithCompletion completion)
default void	resolveProfileNumberForSetProfileInCarWithCompletion(INSetProfileInCarIntent intent, INSetProfileInCarIntentHandling.Block_resolveProfileNumberForSetProfileInCarWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)

Method Detail

confirmSetProfileInCarCompletion

default void confirmSetProfileInCarCompletion(INSetProfileInCarIntent intent,
                                              INSetProfileInCarIntentHandling.Block_confirmSetProfileInCarCompletion 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 INSetProfileInCarIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INSetProfileInCarIntentResponse

handleSetProfileInCarCompletion

void handleSetProfileInCarCompletion(INSetProfileInCarIntent intent,
                                     INSetProfileInCarIntentHandling.Block_handleSetProfileInCarCompletion completion)

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

See Also:

INSetProfileInCarIntentResponse

resolveDefaultProfileForSetProfileInCarWithCompletion

default void resolveDefaultProfileForSetProfileInCarWithCompletion(INSetProfileInCarIntent intent,
                                                                   INSetProfileInCarIntentHandling.Block_resolveDefaultProfileForSetProfileInCarWithCompletion completion)

resolveProfileNameForSetProfileInCarWithCompletion

default void resolveProfileNameForSetProfileInCarWithCompletion(INSetProfileInCarIntent intent,
                                                                INSetProfileInCarIntentHandling.Block_resolveProfileNameForSetProfileInCarWithCompletion completion)

resolveProfileNumberForSetProfileInCarWithCompletion

default void resolveProfileNumberForSetProfileInCarWithCompletion(INSetProfileInCarIntent intent,
                                                                  INSetProfileInCarIntentHandling.Block_resolveProfileNumberForSetProfileInCarWithCompletion 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

resolveCarNameForSetProfileInCarWithCompletion

default void resolveCarNameForSetProfileInCarWithCompletion(INSetProfileInCarIntent intent,
                                                            INSetProfileInCarIntentHandling.Block_resolveCarNameForSetProfileInCarWithCompletion completion)