apple.intents.protocol

Interface INGetRideStatusIntentHandling

All Known Subinterfaces:

INRidesharingDomainHandling

public interface INGetRideStatusIntentHandling

Protocol to declare support for handling an INGetRideStatusIntent. 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	INGetRideStatusIntentHandling.Block_confirmGetRideStatusCompletion
static interface	INGetRideStatusIntentHandling.Block_handleGetRideStatusCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmGetRideStatusCompletion(INGetRideStatusIntent intent, INGetRideStatusIntentHandling.Block_confirmGetRideStatusCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleGetRideStatusCompletion(INGetRideStatusIntent intent, INGetRideStatusIntentHandling.Block_handleGetRideStatusCompletion completion) Handling method - Execute the task represented by the INGetRideStatusIntent that's passed in
void	startSendingUpdatesForGetRideStatusToObserver(INGetRideStatusIntent intent, INGetRideStatusIntentResponseObserver observer)
void	stopSendingUpdatesForGetRideStatus(INGetRideStatusIntent intent)

Method Detail

confirmGetRideStatusCompletion

default void confirmGetRideStatusCompletion(INGetRideStatusIntent intent,
                                            INGetRideStatusIntentHandling.Block_confirmGetRideStatusCompletion 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 INGetRideStatusIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INGetRideStatusIntentResponse

handleGetRideStatusCompletion

void handleGetRideStatusCompletion(INGetRideStatusIntent intent,
                                   INGetRideStatusIntentHandling.Block_handleGetRideStatusCompletion completion)

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

See Also:

INGetRideStatusIntentResponse

startSendingUpdatesForGetRideStatusToObserver

void startSendingUpdatesForGetRideStatusToObserver(INGetRideStatusIntent intent,
                                                   INGetRideStatusIntentResponseObserver observer)

stopSendingUpdatesForGetRideStatus

void stopSendingUpdatesForGetRideStatus(INGetRideStatusIntent intent)