Interface UseApplePayProps

Hierarchy

UseApplePayProps

Index

Methods

Methods

Optional onShippingMethodSelected

onShippingMethodSelected(shippingMethod: ApplePay.ShippingMethod, handler: (summaryItems: ApplePay.CartSummaryItem[]) => Promise<{ error?: StripeError<ApplePayError> }>): void

- Defined in src/hooks/useApplePay.tsx:21
example
```
const { presentApplePay } = useApplePay({
 onShippingMethodSelected: (shippingMethod, handler) => {
   handler([
     { label: 'Example item name 1', amount: '11.00' },
     { label: 'Example item name 2', amount: '25.00' },
  ]);
 }
})
```
Parameters
- shippingMethod: ApplePay.ShippingMethod
- handler: (summaryItems: ApplePay.CartSummaryItem[]) => Promise<{ error?: StripeError<ApplePayError> }>
  - - (summaryItems: ApplePay.CartSummaryItem[]): Promise<{ error?: StripeError<ApplePayError> }>
    - Parameters
      - summaryItems: ApplePay.CartSummaryItem[]
      Returns Promise<{ error?: StripeError<ApplePayError> }>
Returns void

Optional onShippingContactSelected

onShippingContactSelected(shippingContact: ApplePay.ShippingContact, handler: (summaryItems: ApplePay.CartSummaryItem[], errorAddressFields?: { field: AddressFields; message?: string }[]) => Promise<{ error?: StripeError<ApplePayError> }>): void

- Defined in src/hooks/useApplePay.tsx:43
example
```
const { presentApplePay } = useApplePay({
 onShippingContactSelected: (shippingContact, handler) => {
   handler([
     { label: 'Example item name 1', amount: '11.00' },
     { label: 'Example item name 2', amount: '25.00' },
   ], [
     { field: 'city', message: 'city error' },
   ]);
 }
})
```
Parameters
- shippingContact: ApplePay.ShippingContact
- handler: (summaryItems: ApplePay.CartSummaryItem[], errorAddressFields?: { field: AddressFields; message?: string }[]) => Promise<{ error?: StripeError<ApplePayError> }>
  - - (summaryItems: ApplePay.CartSummaryItem[], errorAddressFields?: { field: AddressFields; message?: string }[]): Promise<{ error?: StripeError<ApplePayError> }>
    - Parameters
      - summaryItems: ApplePay.CartSummaryItem[]
      - Optional errorAddressFields: { field: AddressFields; message?: string }[]
      Returns Promise<{ error?: StripeError<ApplePayError> }>
Returns void

Generated using TypeDoc