Package apple.passkit.protocol

Interface PKPaymentAuthorizationControllerDelegate

public interface PKPaymentAuthorizationControllerDelegate

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidAuthorizePaymentCompletion
static interface	PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidAuthorizePaymentHandler
static interface	PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidChangeCouponCodeHandler
static interface	PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidRequestMerchantSessionUpdate
static interface	PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectPaymentMethodCompletion
static interface	PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectPaymentMethodHandler
static interface	PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectShippingContactCompletion
static interface	PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectShippingContactHandler
static interface	PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectShippingMethodCompletion
static interface	PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectShippingMethodHandler

Method Summary

Modifier and Type	Method	Description
default void	paymentAuthorizationControllerDidAuthorizePaymentCompletion(@NotNull PKPaymentAuthorizationController controller, @NotNull PKPayment payment, @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidAuthorizePaymentCompletion completion)	Deprecated.
default void	paymentAuthorizationControllerDidAuthorizePaymentHandler(@NotNull PKPaymentAuthorizationController controller, @NotNull PKPayment payment, @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidAuthorizePaymentHandler completion)	Sent to the delegate after the user has acted on the payment request.
default void	paymentAuthorizationControllerDidChangeCouponCodeHandler(@NotNull PKPaymentAuthorizationController controller, @NotNull java.lang.String couponCode, @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidChangeCouponCodeHandler completion)	API-Since: 15.0
void	paymentAuthorizationControllerDidFinish(@NotNull PKPaymentAuthorizationController controller)	Sent to the delegate when payment authorization is finished.
default void	paymentAuthorizationControllerDidRequestMerchantSessionUpdate(@NotNull PKPaymentAuthorizationController controller, @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidRequestMerchantSessionUpdate handler)	API-Since: 14.0
default void	paymentAuthorizationControllerDidSelectPaymentMethodCompletion(@NotNull PKPaymentAuthorizationController controller, @NotNull PKPaymentMethod paymentMethod, @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectPaymentMethodCompletion completion)	Deprecated.
default void	paymentAuthorizationControllerDidSelectPaymentMethodHandler(@NotNull PKPaymentAuthorizationController controller, @NotNull PKPaymentMethod paymentMethod, @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectPaymentMethodHandler completion)	Sent when the user has selected a new payment card.
default void	paymentAuthorizationControllerDidSelectShippingContactCompletion(@NotNull PKPaymentAuthorizationController controller, @NotNull PKContact contact, @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectShippingContactCompletion completion)	Deprecated.
default void	paymentAuthorizationControllerDidSelectShippingContactHandler(@NotNull PKPaymentAuthorizationController controller, @NotNull PKContact contact, @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectShippingContactHandler completion)	API-Since: 11.0
default void	paymentAuthorizationControllerDidSelectShippingMethodCompletion(@NotNull PKPaymentAuthorizationController controller, @NotNull PKShippingMethod shippingMethod, @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectShippingMethodCompletion completion)	Deprecated.
default void	paymentAuthorizationControllerDidSelectShippingMethodHandler(@NotNull PKPaymentAuthorizationController controller, @NotNull PKShippingMethod shippingMethod, @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectShippingMethodHandler completion)	Sent when the user has selected a new shipping method.
default void	paymentAuthorizationControllerWillAuthorizePayment(@NotNull PKPaymentAuthorizationController controller)	Sent to the delegate before the payment is authorized, but after the user has authenticated using the side button.
default @Nullable UIWindow	presentationWindowForPaymentAuthorizationController(@NotNull PKPaymentAuthorizationController controller)	API-Since: 14.0

Method Detail

paymentAuthorizationControllerDidAuthorizePaymentCompletion

@Deprecated
default void paymentAuthorizationControllerDidAuthorizePaymentCompletion(@NotNull
                                                                         @NotNull PKPaymentAuthorizationController controller,
                                                                         @NotNull
                                                                         @NotNull PKPayment payment,
                                                                         @NotNull
                                                                         @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidAuthorizePaymentCompletion completion)

Deprecated.

API-Since: 10.0 Deprecated-Since: 11.0 Deprecated-Message: Use paymentAuthorizationController:didAuthorizePayment:handler: instead to provide more granular errors

paymentAuthorizationControllerDidSelectPaymentMethodCompletion

@Deprecated
default void paymentAuthorizationControllerDidSelectPaymentMethodCompletion(@NotNull
                                                                            @NotNull PKPaymentAuthorizationController controller,
                                                                            @NotNull
                                                                            @NotNull PKPaymentMethod paymentMethod,
                                                                            @NotNull
                                                                            @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectPaymentMethodCompletion completion)

Deprecated.

API-Since: 10.0 Deprecated-Since: 11.0 Deprecated-Message: Use paymentAuthorizationController:didSelectPaymentMethod:handler: instead to provide more granular errors

paymentAuthorizationControllerDidSelectShippingContactCompletion

@Deprecated
default void paymentAuthorizationControllerDidSelectShippingContactCompletion(@NotNull
                                                                              @NotNull PKPaymentAuthorizationController controller,
                                                                              @NotNull
                                                                              @NotNull PKContact contact,
                                                                              @NotNull
                                                                              @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectShippingContactCompletion completion)

Deprecated.

API-Since: 10.0 Deprecated-Since: 11.0 Deprecated-Message: Use paymentAuthorizationController:didSelectShippingContact:handler: instead to provide more granular errors

paymentAuthorizationControllerDidSelectShippingMethodCompletion

@Deprecated
default void paymentAuthorizationControllerDidSelectShippingMethodCompletion(@NotNull
                                                                             @NotNull PKPaymentAuthorizationController controller,
                                                                             @NotNull
                                                                             @NotNull PKShippingMethod shippingMethod,
                                                                             @NotNull
                                                                             @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectShippingMethodCompletion completion)

Deprecated.

These delegate methods are deprecated and have been replaced with new callbacks that allow more granular and comprehensive errors to be surfaced to users API-Since: 10.0 Deprecated-Since: 11.0 Deprecated-Message: Use paymentAuthorizationController:didSelectShippingMethod:handler: instead to provide more granular errors

paymentAuthorizationControllerDidFinish

void paymentAuthorizationControllerDidFinish(@NotNull
                                             @NotNull PKPaymentAuthorizationController controller)

Sent to the delegate when payment authorization is finished. This may occur when the user cancels the request, or after the PKPaymentAuthorizationStatus parameter of the paymentAuthorizationController:didAuthorizePayment:completion: has been shown to the user. The delegate is responsible for dismissing and releasing the controller in this method.

paymentAuthorizationControllerWillAuthorizePayment

default void paymentAuthorizationControllerWillAuthorizePayment(@NotNull
                                                                @NotNull PKPaymentAuthorizationController controller)

Sent to the delegate before the payment is authorized, but after the user has authenticated using the side button. Optional.

paymentAuthorizationControllerDidAuthorizePaymentHandler

default void paymentAuthorizationControllerDidAuthorizePaymentHandler(@NotNull
                                                                      @NotNull PKPaymentAuthorizationController controller,
                                                                      @NotNull
                                                                      @NotNull PKPayment payment,
                                                                      @NotNull
                                                                      @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidAuthorizePaymentHandler completion)

Sent to the delegate after the user has acted on the payment request. The application should inspect the payment to determine whether the payment request was authorized. If the application requested a shipping contact then the full contact is now part of the payment. The delegate must call completion with an appropriate authorization status, as may be determined by submitting the payment credential to a processing gateway for payment authorization. API-Since: 11.0

paymentAuthorizationControllerDidSelectPaymentMethodHandler

default void paymentAuthorizationControllerDidSelectPaymentMethodHandler(@NotNull
                                                                         @NotNull PKPaymentAuthorizationController controller,
                                                                         @NotNull
                                                                         @NotNull PKPaymentMethod paymentMethod,
                                                                         @NotNull
                                                                         @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectPaymentMethodHandler completion)

Sent when the user has selected a new payment card. Use this delegate callback if you need to update the summary items in response to the card type changing (for example, applying credit card surcharges) The delegate will receive no further callbacks except paymentAuthorizationControllerDidFinish: until it has invoked the completion block. API-Since: 11.0

paymentAuthorizationControllerDidSelectShippingContactHandler

default void paymentAuthorizationControllerDidSelectShippingContactHandler(@NotNull
                                                                           @NotNull PKPaymentAuthorizationController controller,
                                                                           @NotNull
                                                                           @NotNull PKContact contact,
                                                                           @NotNull
                                                                           @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectShippingContactHandler completion)

API-Since: 11.0

paymentAuthorizationControllerDidSelectShippingMethodHandler

default void paymentAuthorizationControllerDidSelectShippingMethodHandler(@NotNull
                                                                          @NotNull PKPaymentAuthorizationController controller,
                                                                          @NotNull
                                                                          @NotNull PKShippingMethod shippingMethod,
                                                                          @NotNull
                                                                          @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidSelectShippingMethodHandler completion)

Sent when the user has selected a new shipping method. The delegate should determine shipping costs based on the shipping method and either the shipping address contact in the original PKPaymentRequest or the contact provided by the last call to paymentAuthorizationController: didSelectShippingContact:completion:. The delegate must invoke the completion block with an updated array of PKPaymentSummaryItem objects. The delegate will receive no further callbacks except paymentAuthorizationControllerDidFinish: until it has invoked the completion block. API-Since: 11.0

paymentAuthorizationControllerDidRequestMerchantSessionUpdate

default void paymentAuthorizationControllerDidRequestMerchantSessionUpdate(@NotNull
                                                                           @NotNull PKPaymentAuthorizationController controller,
                                                                           @NotNull
                                                                           @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidRequestMerchantSessionUpdate handler)

API-Since: 14.0

presentationWindowForPaymentAuthorizationController

@Nullable
default @Nullable UIWindow presentationWindowForPaymentAuthorizationController(@NotNull
                                                                               @NotNull PKPaymentAuthorizationController controller)

API-Since: 14.0

paymentAuthorizationControllerDidChangeCouponCodeHandler

default void paymentAuthorizationControllerDidChangeCouponCodeHandler(@NotNull
                                                                      @NotNull PKPaymentAuthorizationController controller,
                                                                      @NotNull
                                                                      @NotNull java.lang.String couponCode,
                                                                      @NotNull
                                                                      @NotNull PKPaymentAuthorizationControllerDelegate.Block_paymentAuthorizationControllerDidChangeCouponCodeHandler completion)

API-Since: 15.0