apple.intents.protocol

Interface INCancelRideIntentHandling

public interface INCancelRideIntentHandling

Protocol to declare support for handling an INCancelRideIntent. By implementing this protocol, a class can provide logic for confirming and handling the intent.

The minimum requirement for an implementing class is that it should be able to confirm and handle the intent. The handling method is always called last, after confirming the intent.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	INCancelRideIntentHandling.Block_confirmCancelRideCompletion
static interface	INCancelRideIntentHandling.Block_handleCancelRideCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmCancelRideCompletion(INCancelRideIntent intent, INCancelRideIntentHandling.Block_confirmCancelRideCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleCancelRideCompletion(INCancelRideIntent intent, INCancelRideIntentHandling.Block_handleCancelRideCompletion completion) Handling method - Execute the task represented by the INCancelRideIntent that's passed in

Method Detail

confirmCancelRideCompletion

default void confirmCancelRideCompletion(INCancelRideIntent intent,
                                         INCancelRideIntentHandling.Block_confirmCancelRideCompletion 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 may not use the cancel ride intent.

Parameters:

intent - The input intent

completion - The response block contains an INCancelRideIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INCancelRideIntentResponse

handleCancelRideCompletion

void handleCancelRideCompletion(INCancelRideIntent intent,
                                INCancelRideIntentHandling.Block_handleCancelRideCompletion completion)

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

See Also:

INCancelRideIntentResponse