apple.intents.protocol

Interface INSendPaymentIntentHandling

All Known Subinterfaces:

INPaymentsDomainHandling

public interface INSendPaymentIntentHandling

Protocol to declare support for handling an INSendPaymentIntent. 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	INSendPaymentIntentHandling.Block_confirmSendPaymentCompletion
static interface	INSendPaymentIntentHandling.Block_handleSendPaymentCompletion
static interface	INSendPaymentIntentHandling.Block_resolveCurrencyAmountForSendPaymentCompletion
static interface	INSendPaymentIntentHandling.Block_resolveCurrencyAmountForSendPaymentWithCompletion
static interface	INSendPaymentIntentHandling.Block_resolveNoteForSendPaymentWithCompletion
static interface	INSendPaymentIntentHandling.Block_resolvePayeeForSendPaymentCompletion
static interface	INSendPaymentIntentHandling.Block_resolvePayeeForSendPaymentWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmSendPaymentCompletion(INSendPaymentIntent intent, INSendPaymentIntentHandling.Block_confirmSendPaymentCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleSendPaymentCompletion(INSendPaymentIntent intent, INSendPaymentIntentHandling.Block_handleSendPaymentCompletion completion) Handling method - Execute the task represented by the INSendPaymentIntent that's passed in
default void	resolveCurrencyAmountForSendPaymentCompletion(INSendPaymentIntent intent, INSendPaymentIntentHandling.Block_resolveCurrencyAmountForSendPaymentCompletion completion)
default void	resolveCurrencyAmountForSendPaymentWithCompletion(INSendPaymentIntent intent, INSendPaymentIntentHandling.Block_resolveCurrencyAmountForSendPaymentWithCompletion completion)
default void	resolveNoteForSendPaymentWithCompletion(INSendPaymentIntent intent, INSendPaymentIntentHandling.Block_resolveNoteForSendPaymentWithCompletion completion)
default void	resolvePayeeForSendPaymentCompletion(INSendPaymentIntent intent, INSendPaymentIntentHandling.Block_resolvePayeeForSendPaymentCompletion completion)
default void	resolvePayeeForSendPaymentWithCompletion(INSendPaymentIntent intent, INSendPaymentIntentHandling.Block_resolvePayeeForSendPaymentWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)

Method Detail

confirmSendPaymentCompletion

default void confirmSendPaymentCompletion(INSendPaymentIntent intent,
                                          INSendPaymentIntentHandling.Block_confirmSendPaymentCompletion 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 INSendPaymentIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INSendPaymentIntentResponse

handleSendPaymentCompletion

void handleSendPaymentCompletion(INSendPaymentIntent intent,
                                 INSendPaymentIntentHandling.Block_handleSendPaymentCompletion completion)

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

See Also:

INSendPaymentIntentResponse

resolveCurrencyAmountForSendPaymentWithCompletion

default void resolveCurrencyAmountForSendPaymentWithCompletion(INSendPaymentIntent intent,
                                                               INSendPaymentIntentHandling.Block_resolveCurrencyAmountForSendPaymentWithCompletion completion)

resolveNoteForSendPaymentWithCompletion

default void resolveNoteForSendPaymentWithCompletion(INSendPaymentIntent intent,
                                                     INSendPaymentIntentHandling.Block_resolveNoteForSendPaymentWithCompletion completion)

resolvePayeeForSendPaymentWithCompletion

default void resolvePayeeForSendPaymentWithCompletion(INSendPaymentIntent intent,
                                                      INSendPaymentIntentHandling.Block_resolvePayeeForSendPaymentWithCompletion 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

resolveCurrencyAmountForSendPaymentCompletion

default void resolveCurrencyAmountForSendPaymentCompletion(INSendPaymentIntent intent,
                                                           INSendPaymentIntentHandling.Block_resolveCurrencyAmountForSendPaymentCompletion completion)

resolvePayeeForSendPaymentCompletion

default void resolvePayeeForSendPaymentCompletion(INSendPaymentIntent intent,
                                                  INSendPaymentIntentHandling.Block_resolvePayeeForSendPaymentCompletion completion)