apple.intents.protocol

Interface INRequestRideIntentHandling

All Known Subinterfaces:

INRidesharingDomainHandling

public interface INRequestRideIntentHandling

Protocol to declare support for handling an INRequestRideIntent. 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	INRequestRideIntentHandling.Block_confirmRequestRideCompletion
static interface	INRequestRideIntentHandling.Block_handleRequestRideCompletion
static interface	INRequestRideIntentHandling.Block_resolveDropOffLocationForRequestRideWithCompletion
static interface	INRequestRideIntentHandling.Block_resolvePartySizeForRequestRideWithCompletion
static interface	INRequestRideIntentHandling.Block_resolvePickupLocationForRequestRideWithCompletion
static interface	INRequestRideIntentHandling.Block_resolveRideOptionNameForRequestRideWithCompletion
static interface	INRequestRideIntentHandling.Block_resolveScheduledPickupTimeForRequestRideWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmRequestRideCompletion(INRequestRideIntent intent, INRequestRideIntentHandling.Block_confirmRequestRideCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleRequestRideCompletion(INRequestRideIntent intent, INRequestRideIntentHandling.Block_handleRequestRideCompletion completion) Handling method - Execute the task represented by the INRequestRideIntent that's passed in
default void	resolveDropOffLocationForRequestRideWithCompletion(INRequestRideIntent intent, INRequestRideIntentHandling.Block_resolveDropOffLocationForRequestRideWithCompletion completion)
default void	resolvePartySizeForRequestRideWithCompletion(INRequestRideIntent intent, INRequestRideIntentHandling.Block_resolvePartySizeForRequestRideWithCompletion completion)
default void	resolvePickupLocationForRequestRideWithCompletion(INRequestRideIntent intent, INRequestRideIntentHandling.Block_resolvePickupLocationForRequestRideWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)
default void	resolveRideOptionNameForRequestRideWithCompletion(INRequestRideIntent intent, INRequestRideIntentHandling.Block_resolveRideOptionNameForRequestRideWithCompletion completion)
default void	resolveScheduledPickupTimeForRequestRideWithCompletion(INRequestRideIntent intent, INRequestRideIntentHandling.Block_resolveScheduledPickupTimeForRequestRideWithCompletion completion)

Method Detail

confirmRequestRideCompletion

default void confirmRequestRideCompletion(INRequestRideIntent intent,
                                          INRequestRideIntentHandling.Block_confirmRequestRideCompletion 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 INRequestRideIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INRequestRideIntentResponse

handleRequestRideCompletion

void handleRequestRideCompletion(INRequestRideIntent intent,
                                 INRequestRideIntentHandling.Block_handleRequestRideCompletion completion)

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

See Also:

INRequestRideIntentResponse

resolveDropOffLocationForRequestRideWithCompletion

default void resolveDropOffLocationForRequestRideWithCompletion(INRequestRideIntent intent,
                                                                INRequestRideIntentHandling.Block_resolveDropOffLocationForRequestRideWithCompletion completion)

resolvePartySizeForRequestRideWithCompletion

default void resolvePartySizeForRequestRideWithCompletion(INRequestRideIntent intent,
                                                          INRequestRideIntentHandling.Block_resolvePartySizeForRequestRideWithCompletion completion)

resolvePickupLocationForRequestRideWithCompletion

default void resolvePickupLocationForRequestRideWithCompletion(INRequestRideIntent intent,
                                                               INRequestRideIntentHandling.Block_resolvePickupLocationForRequestRideWithCompletion 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

resolveRideOptionNameForRequestRideWithCompletion

default void resolveRideOptionNameForRequestRideWithCompletion(INRequestRideIntent intent,
                                                               INRequestRideIntentHandling.Block_resolveRideOptionNameForRequestRideWithCompletion completion)

resolveScheduledPickupTimeForRequestRideWithCompletion

default void resolveScheduledPickupTimeForRequestRideWithCompletion(INRequestRideIntent intent,
                                                                    INRequestRideIntentHandling.Block_resolveScheduledPickupTimeForRequestRideWithCompletion completion)