apple.intents.protocol

Interface INRequestPaymentIntentHandling

All Known Subinterfaces:

INPaymentsDomainHandling

public interface INRequestPaymentIntentHandling

Protocol to declare support for handling an INRequestPaymentIntent. 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	INRequestPaymentIntentHandling.Block_confirmRequestPaymentCompletion
static interface	INRequestPaymentIntentHandling.Block_handleRequestPaymentCompletion
static interface	INRequestPaymentIntentHandling.Block_resolveCurrencyAmountForRequestPaymentCompletion
static interface	INRequestPaymentIntentHandling.Block_resolveCurrencyAmountForRequestPaymentWithCompletion
static interface	INRequestPaymentIntentHandling.Block_resolveNoteForRequestPaymentWithCompletion
static interface	INRequestPaymentIntentHandling.Block_resolvePayerForRequestPaymentCompletion
static interface	INRequestPaymentIntentHandling.Block_resolvePayerForRequestPaymentWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmRequestPaymentCompletion(INRequestPaymentIntent intent, INRequestPaymentIntentHandling.Block_confirmRequestPaymentCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleRequestPaymentCompletion(INRequestPaymentIntent intent, INRequestPaymentIntentHandling.Block_handleRequestPaymentCompletion completion) Handling method - Execute the task represented by the INRequestPaymentIntent that's passed in
default void	resolveCurrencyAmountForRequestPaymentCompletion(INRequestPaymentIntent intent, INRequestPaymentIntentHandling.Block_resolveCurrencyAmountForRequestPaymentCompletion completion)
default void	resolveCurrencyAmountForRequestPaymentWithCompletion(INRequestPaymentIntent intent, INRequestPaymentIntentHandling.Block_resolveCurrencyAmountForRequestPaymentWithCompletion completion)
default void	resolveNoteForRequestPaymentWithCompletion(INRequestPaymentIntent intent, INRequestPaymentIntentHandling.Block_resolveNoteForRequestPaymentWithCompletion completion)
default void	resolvePayerForRequestPaymentCompletion(INRequestPaymentIntent intent, INRequestPaymentIntentHandling.Block_resolvePayerForRequestPaymentCompletion completion)
default void	resolvePayerForRequestPaymentWithCompletion(INRequestPaymentIntent intent, INRequestPaymentIntentHandling.Block_resolvePayerForRequestPaymentWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)

Method Detail

confirmRequestPaymentCompletion

default void confirmRequestPaymentCompletion(INRequestPaymentIntent intent,
                                             INRequestPaymentIntentHandling.Block_confirmRequestPaymentCompletion 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 INRequestPaymentIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INRequestPaymentIntentResponse

handleRequestPaymentCompletion

void handleRequestPaymentCompletion(INRequestPaymentIntent intent,
                                    INRequestPaymentIntentHandling.Block_handleRequestPaymentCompletion completion)

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

See Also:

INRequestPaymentIntentResponse

resolveCurrencyAmountForRequestPaymentWithCompletion

default void resolveCurrencyAmountForRequestPaymentWithCompletion(INRequestPaymentIntent intent,
                                                                  INRequestPaymentIntentHandling.Block_resolveCurrencyAmountForRequestPaymentWithCompletion completion)

resolveNoteForRequestPaymentWithCompletion

default void resolveNoteForRequestPaymentWithCompletion(INRequestPaymentIntent intent,
                                                        INRequestPaymentIntentHandling.Block_resolveNoteForRequestPaymentWithCompletion completion)

resolvePayerForRequestPaymentWithCompletion

default void resolvePayerForRequestPaymentWithCompletion(INRequestPaymentIntent intent,
                                                         INRequestPaymentIntentHandling.Block_resolvePayerForRequestPaymentWithCompletion 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

resolveCurrencyAmountForRequestPaymentCompletion

default void resolveCurrencyAmountForRequestPaymentCompletion(INRequestPaymentIntent intent,
                                                              INRequestPaymentIntentHandling.Block_resolveCurrencyAmountForRequestPaymentCompletion completion)

resolvePayerForRequestPaymentCompletion

default void resolvePayerForRequestPaymentCompletion(INRequestPaymentIntent intent,
                                                     INRequestPaymentIntentHandling.Block_resolvePayerForRequestPaymentCompletion completion)