apple.intents.protocol

Interface INPayBillIntentHandling

public interface INPayBillIntentHandling

Protocol to declare support for handling an INPayBillIntent. 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	INPayBillIntentHandling.Block_confirmPayBillCompletion
static interface	INPayBillIntentHandling.Block_handlePayBillCompletion
static interface	INPayBillIntentHandling.Block_resolveBillPayeeForPayBillWithCompletion
static interface	INPayBillIntentHandling.Block_resolveBillTypeForPayBillWithCompletion
static interface	INPayBillIntentHandling.Block_resolveDueDateForPayBillWithCompletion
static interface	INPayBillIntentHandling.Block_resolveFromAccountForPayBillWithCompletion
static interface	INPayBillIntentHandling.Block_resolveTransactionAmountForPayBillWithCompletion
static interface	INPayBillIntentHandling.Block_resolveTransactionNoteForPayBillWithCompletion
static interface	INPayBillIntentHandling.Block_resolveTransactionScheduledDateForPayBillWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmPayBillCompletion(INPayBillIntent intent, INPayBillIntentHandling.Block_confirmPayBillCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handlePayBillCompletion(INPayBillIntent intent, INPayBillIntentHandling.Block_handlePayBillCompletion completion) Handling method - Execute the task represented by the INPayBillIntent that's passed in
default void	resolveBillPayeeForPayBillWithCompletion(INPayBillIntent intent, INPayBillIntentHandling.Block_resolveBillPayeeForPayBillWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)
default void	resolveBillTypeForPayBillWithCompletion(INPayBillIntent intent, INPayBillIntentHandling.Block_resolveBillTypeForPayBillWithCompletion completion)
default void	resolveDueDateForPayBillWithCompletion(INPayBillIntent intent, INPayBillIntentHandling.Block_resolveDueDateForPayBillWithCompletion completion)
default void	resolveFromAccountForPayBillWithCompletion(INPayBillIntent intent, INPayBillIntentHandling.Block_resolveFromAccountForPayBillWithCompletion completion)
default void	resolveTransactionAmountForPayBillWithCompletion(INPayBillIntent intent, INPayBillIntentHandling.Block_resolveTransactionAmountForPayBillWithCompletion completion)
default void	resolveTransactionNoteForPayBillWithCompletion(INPayBillIntent intent, INPayBillIntentHandling.Block_resolveTransactionNoteForPayBillWithCompletion completion)
default void	resolveTransactionScheduledDateForPayBillWithCompletion(INPayBillIntent intent, INPayBillIntentHandling.Block_resolveTransactionScheduledDateForPayBillWithCompletion completion)

Method Detail

confirmPayBillCompletion

default void confirmPayBillCompletion(INPayBillIntent intent,
                                      INPayBillIntentHandling.Block_confirmPayBillCompletion 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 INPayBillIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INPayBillIntentResponse

handlePayBillCompletion

void handlePayBillCompletion(INPayBillIntent intent,
                             INPayBillIntentHandling.Block_handlePayBillCompletion completion)

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

See Also:

INPayBillIntentResponse

resolveBillPayeeForPayBillWithCompletion

default void resolveBillPayeeForPayBillWithCompletion(INPayBillIntent intent,
                                                      INPayBillIntentHandling.Block_resolveBillPayeeForPayBillWithCompletion 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

resolveBillTypeForPayBillWithCompletion

default void resolveBillTypeForPayBillWithCompletion(INPayBillIntent intent,
                                                     INPayBillIntentHandling.Block_resolveBillTypeForPayBillWithCompletion completion)

resolveDueDateForPayBillWithCompletion

default void resolveDueDateForPayBillWithCompletion(INPayBillIntent intent,
                                                    INPayBillIntentHandling.Block_resolveDueDateForPayBillWithCompletion completion)

resolveFromAccountForPayBillWithCompletion

default void resolveFromAccountForPayBillWithCompletion(INPayBillIntent intent,
                                                        INPayBillIntentHandling.Block_resolveFromAccountForPayBillWithCompletion completion)

resolveTransactionAmountForPayBillWithCompletion

default void resolveTransactionAmountForPayBillWithCompletion(INPayBillIntent intent,
                                                              INPayBillIntentHandling.Block_resolveTransactionAmountForPayBillWithCompletion completion)

resolveTransactionNoteForPayBillWithCompletion

default void resolveTransactionNoteForPayBillWithCompletion(INPayBillIntent intent,
                                                            INPayBillIntentHandling.Block_resolveTransactionNoteForPayBillWithCompletion completion)

resolveTransactionScheduledDateForPayBillWithCompletion

default void resolveTransactionScheduledDateForPayBillWithCompletion(INPayBillIntent intent,
                                                                     INPayBillIntentHandling.Block_resolveTransactionScheduledDateForPayBillWithCompletion completion)