core_payment/gateways_modal

Description:

  • Contain the logic for the gateways modal.

Source:
Copyright:
  • 2019 Shamim Rezaie
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Contain the logic for the gateways modal.

Members

(static, constant) init

Description:

  • Set up the payment actions.

Source:

Set up the payment actions.

Methods

(async, inner) processPayment(gateway, component, paymentArea, itemId, description) → {Promise.<string>}

Description:

  • Process payment using the selected gateway.

Source:
Parameters:
Name Type Description
gateway string

The gateway to be used for payment
component string

Name of the component that the itemId belongs to
paymentArea string

Name of the area in the component that the itemId belongs to
itemId number

An internal identifier that is used by the component
description string

Description of the payment
Returns:
Type
Promise.<string>

(inner) registerEventListeners()

Description:

  • Register event listeners for the module.

Source:

(inner) selectSingleGateway(root)

Description:

  • Auto-select the gateway if there is only one gateway.

Source:
Parameters:
Name Type Description
root HTMLElement

An HTMLElement that contains the cost region

(async, inner) show(rootNode, options)

Description:

  • Shows the gateway selector modal.

Source:
Parameters:
Name Type Description
rootNode HTMLElement
options Object

Additional options

Properties
Name Type Description
focusOnClose HTMLElement

The element to focus on when the modal is closed.

(async, inner) updateCostRegion(root, defaultCost) → {Promise.<void>}

Description:

  • Shows the cost of the item the user is purchasing in the cost region.

Source:
Parameters:
Name Type Description
root HTMLElement

An HTMLElement that contains the cost region
defaultCost string

The default cost that is going to be displayed if no gateway is selected
Returns:
Type
Promise.<void>