Package apple.intents.protocol

Interface INPayBillIntentHandling

@Deprecated
public interface INPayBillIntentHandling

Deprecated.

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. API-Since: 10.3 Deprecated-Since: 15.0 Deprecated-Message: INPayBillIntentHandling is deprecated. There is no replacement.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	INPayBillIntentHandling.Block_confirmPayBillCompletion	Deprecated.
static interface	INPayBillIntentHandling.Block_handlePayBillCompletion	Deprecated.
static interface	INPayBillIntentHandling.Block_resolveBillPayeeForPayBillWithCompletion	Deprecated.
static interface	INPayBillIntentHandling.Block_resolveBillTypeForPayBillWithCompletion	Deprecated.
static interface	INPayBillIntentHandling.Block_resolveDueDateForPayBillWithCompletion	Deprecated.
static interface	INPayBillIntentHandling.Block_resolveFromAccountForPayBillWithCompletion	Deprecated.
static interface	INPayBillIntentHandling.Block_resolveTransactionAmountForPayBillWithCompletion	Deprecated.
static interface	INPayBillIntentHandling.Block_resolveTransactionNoteForPayBillWithCompletion	Deprecated.
static interface	INPayBillIntentHandling.Block_resolveTransactionScheduledDateForPayBillWithCompletion	Deprecated.

Method Summary

Modifier and Type	Method	Description
default void	confirmPayBillCompletion(@NotNull INPayBillIntent intent, @NotNull INPayBillIntentHandling.Block_confirmPayBillCompletion completion)	Deprecated. Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handlePayBillCompletion(@NotNull INPayBillIntent intent, @NotNull INPayBillIntentHandling.Block_handlePayBillCompletion completion)	Deprecated. Handling method - Execute the task represented by the INPayBillIntent that's passed in Called to actually execute the intent.
default void	resolveBillPayeeForPayBillWithCompletion(@NotNull INPayBillIntent intent, @NotNull INPayBillIntentHandling.Block_resolveBillPayeeForPayBillWithCompletion completion)	Deprecated. 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.
default void	resolveBillTypeForPayBillWithCompletion(@NotNull INPayBillIntent intent, @NotNull INPayBillIntentHandling.Block_resolveBillTypeForPayBillWithCompletion completion)	Deprecated.
default void	resolveDueDateForPayBillWithCompletion(@NotNull INPayBillIntent intent, @NotNull INPayBillIntentHandling.Block_resolveDueDateForPayBillWithCompletion completion)	Deprecated.
default void	resolveFromAccountForPayBillWithCompletion(@NotNull INPayBillIntent intent, @NotNull INPayBillIntentHandling.Block_resolveFromAccountForPayBillWithCompletion completion)	Deprecated.
default void	resolveTransactionAmountForPayBillWithCompletion(@NotNull INPayBillIntent intent, @NotNull INPayBillIntentHandling.Block_resolveTransactionAmountForPayBillWithCompletion completion)	Deprecated.
default void	resolveTransactionNoteForPayBillWithCompletion(@NotNull INPayBillIntent intent, @NotNull INPayBillIntentHandling.Block_resolveTransactionNoteForPayBillWithCompletion completion)	Deprecated.
default void	resolveTransactionScheduledDateForPayBillWithCompletion(@NotNull INPayBillIntent intent, @NotNull INPayBillIntentHandling.Block_resolveTransactionScheduledDateForPayBillWithCompletion completion)	Deprecated.

Method Detail

confirmPayBillCompletion

default void confirmPayBillCompletion(@NotNull
                                      @NotNull INPayBillIntent intent,
                                      @NotNull
                                      @NotNull INPayBillIntentHandling.Block_confirmPayBillCompletion completion)

Deprecated.

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(@NotNull
                             @NotNull INPayBillIntent intent,
                             @NotNull
                             @NotNull INPayBillIntentHandling.Block_handlePayBillCompletion completion)

Deprecated.

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(@NotNull
                                                      @NotNull INPayBillIntent intent,
                                                      @NotNull
                                                      @NotNull INPayBillIntentHandling.Block_resolveBillPayeeForPayBillWithCompletion completion)

Deprecated.

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(@NotNull
                                                     @NotNull INPayBillIntent intent,
                                                     @NotNull
                                                     @NotNull INPayBillIntentHandling.Block_resolveBillTypeForPayBillWithCompletion completion)

Deprecated.

resolveDueDateForPayBillWithCompletion

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

Deprecated.

resolveFromAccountForPayBillWithCompletion

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

Deprecated.

resolveTransactionAmountForPayBillWithCompletion

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

Deprecated.

resolveTransactionNoteForPayBillWithCompletion

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

Deprecated.

resolveTransactionScheduledDateForPayBillWithCompletion

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

Deprecated.