Class ApplePayHookResult

• TopLevel.Object
  • dw.extensions.applepay.ApplePayHookResult

Result of a hook handling an Apple Pay request.

Use the constants in this type to indicate specific error reasons to be provided to Apple Pay JS. For example, the following code creates a Status that indicates the shipping contact information provided by Apple Pay is invalid:

1var ApplePayHookResult = require('dw/extensions/applepay/ApplePayHookResult');
2var Status = require('dw/system/Status');
3
4var error = new Status(Status.ERROR);
5error.addDetail(ApplePayHookResult.STATUS_REASON_DETAIL_KEY, ApplePayHookResult.REASON_SHIPPING_CONTACT);

If a specific error reason is not provided, the generic Apple Pay STATUS_FAILURE reason will be used when necessary.

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

REASON_BILLING_ADDRESS: String = "InvalidBillingPostalAddress"

Error reason code representing an invalid billing address.

REASON_FAILURE: String = "Failure"

Error reason code representing an error or failure not otherwise specified.

REASON_PIN_INCORRECT: String = "PINIncorrect"

Error reason code representing the PIN is incorrect.

REASON_PIN_LOCKOUT: String = "PINLockout"

Error reason code representing a PIN lockout.

REASON_PIN_REQUIRED: String = "PINRequired"

Error reason code representing a PIN is required.

REASON_SHIPPING_ADDRESS: String = "InvalidShippingPostalAddress"

Error reason code representing an invalid shipping address.

REASON_SHIPPING_CONTACT: String = "InvalidShippingContact"

Error reason code representing invalid shipping contact information.

STATUS_REASON_DETAIL_KEY: String = "reason"

Key for the detail to be used in Status objects to indicate the reason to communicate to Apple Pay for errors.

eventDetail: Object (read-only)

Detail to the JS custom event to dispatch in response to this result.

eventName: String (read-only)

Name of the JS custom event to dispatch in response to this result.

redirect: URL (read-only)

URL to navigate to in response to this result.

status: Status (read-only)

Status describing the outcome of this result.

ApplePayHookResult(status: Status, redirect: URL)

Constructs a result with the given outcome information.

Parameters:

• status - status of the result
• redirect - optional URL to which to navigate to in response to this outcome

getEventDetail(): Object

Detail to the JS custom event to dispatch in response to this result.

Returns:

• event detail

getEventName(): String

Name of the JS custom event to dispatch in response to this result.

Returns:

• event name

getRedirect(): URL

URL to navigate to in response to this result.

Returns:

• redirect URL

getStatus(): Status

Status describing the outcome of this result.

Returns:

• status of this result

setEvent(name: String): void

Sets the name of the JS custom event to dispatch in response to this result.

Parameters:

• name - JS custom event name

setEvent(name: String, detail: Object): void

Sets the name and detail of the JS custom event to dispatch in response to this result.

Parameters:

• name - JS custom event name
• detail - JS custom event detail