apple.intents.protocol

Interface INSearchForBillsIntentHandling

public interface INSearchForBillsIntentHandling

Protocol to declare support for handling an INSearchForBillsIntent. 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	INSearchForBillsIntentHandling.Block_confirmSearchForBillsCompletion
static interface	INSearchForBillsIntentHandling.Block_handleSearchForBillsCompletion
static interface	INSearchForBillsIntentHandling.Block_resolveBillPayeeForSearchForBillsWithCompletion
static interface	INSearchForBillsIntentHandling.Block_resolveBillTypeForSearchForBillsWithCompletion
static interface	INSearchForBillsIntentHandling.Block_resolveDueDateRangeForSearchForBillsWithCompletion
static interface	INSearchForBillsIntentHandling.Block_resolvePaymentDateRangeForSearchForBillsWithCompletion
static interface	INSearchForBillsIntentHandling.Block_resolveStatusForSearchForBillsWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmSearchForBillsCompletion(INSearchForBillsIntent intent, INSearchForBillsIntentHandling.Block_confirmSearchForBillsCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleSearchForBillsCompletion(INSearchForBillsIntent intent, INSearchForBillsIntentHandling.Block_handleSearchForBillsCompletion completion) Handling method - Execute the task represented by the INSearchForBillsIntent that's passed in
default void	resolveBillPayeeForSearchForBillsWithCompletion(INSearchForBillsIntent intent, INSearchForBillsIntentHandling.Block_resolveBillPayeeForSearchForBillsWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)
default void	resolveBillTypeForSearchForBillsWithCompletion(INSearchForBillsIntent intent, INSearchForBillsIntentHandling.Block_resolveBillTypeForSearchForBillsWithCompletion completion)
default void	resolveDueDateRangeForSearchForBillsWithCompletion(INSearchForBillsIntent intent, INSearchForBillsIntentHandling.Block_resolveDueDateRangeForSearchForBillsWithCompletion completion)
default void	resolvePaymentDateRangeForSearchForBillsWithCompletion(INSearchForBillsIntent intent, INSearchForBillsIntentHandling.Block_resolvePaymentDateRangeForSearchForBillsWithCompletion completion)
default void	resolveStatusForSearchForBillsWithCompletion(INSearchForBillsIntent intent, INSearchForBillsIntentHandling.Block_resolveStatusForSearchForBillsWithCompletion completion)

Method Detail

confirmSearchForBillsCompletion

default void confirmSearchForBillsCompletion(INSearchForBillsIntent intent,
                                             INSearchForBillsIntentHandling.Block_confirmSearchForBillsCompletion 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 INSearchForBillsIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INSearchForBillsIntentResponse

handleSearchForBillsCompletion

void handleSearchForBillsCompletion(INSearchForBillsIntent intent,
                                    INSearchForBillsIntentHandling.Block_handleSearchForBillsCompletion completion)

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

See Also:

INSearchForBillsIntentResponse

resolveBillPayeeForSearchForBillsWithCompletion

default void resolveBillPayeeForSearchForBillsWithCompletion(INSearchForBillsIntent intent,
                                                             INSearchForBillsIntentHandling.Block_resolveBillPayeeForSearchForBillsWithCompletion 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

resolveBillTypeForSearchForBillsWithCompletion

default void resolveBillTypeForSearchForBillsWithCompletion(INSearchForBillsIntent intent,
                                                            INSearchForBillsIntentHandling.Block_resolveBillTypeForSearchForBillsWithCompletion completion)

resolveDueDateRangeForSearchForBillsWithCompletion

default void resolveDueDateRangeForSearchForBillsWithCompletion(INSearchForBillsIntent intent,
                                                                INSearchForBillsIntentHandling.Block_resolveDueDateRangeForSearchForBillsWithCompletion completion)

resolvePaymentDateRangeForSearchForBillsWithCompletion

default void resolvePaymentDateRangeForSearchForBillsWithCompletion(INSearchForBillsIntent intent,
                                                                    INSearchForBillsIntentHandling.Block_resolvePaymentDateRangeForSearchForBillsWithCompletion completion)

resolveStatusForSearchForBillsWithCompletion

default void resolveStatusForSearchForBillsWithCompletion(INSearchForBillsIntent intent,
                                                          INSearchForBillsIntentHandling.Block_resolveStatusForSearchForBillsWithCompletion completion)