Class PaymentRequestHookResult

Result of a hook handling a Payment Request request

Deprecated:

Salesforce Payments includes support for Google Pay

Warning

Property Summary 

PropertyDescription
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.

Constructor Summary 

ConstructorDescription
PaymentRequestHookResult(Status, URL)Constructs a result with the given outcome information.

Method Summary 

MethodDescription
getEventDetail()Detail to the JS custom event to dispatch in response to this result.
getEventName()Name of the JS custom event to dispatch in response to this result.
getRedirect()URL to navigate to in response to this result.
getStatus()Status describing the outcome of this result.
setEvent(String)Sets the name of the JS custom event to dispatch in response to this result.
setEvent(String, Object)Sets the name and detail of the JS custom event to dispatch in response to this result.

Methods inherited from class Object 

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

Property Details 

eventDetail 

eventDetail: Object (read-only)

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


eventName 

eventName: String (read-only)

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


redirect 

redirect: URL (read-only)

URL to navigate to in response to this result.


status 

status: Status (read-only)

Status describing the outcome of this result.


Constructor Details 

PaymentRequestHookResult(Status, URL) 

PaymentRequestHookResult(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

Method Details 

getEventDetail() 

getEventDetail(): Object

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

Returns:

  • event detail

getEventName() 

getEventName(): String

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

Returns:

  • event name

getRedirect() 

getRedirect(): URL

URL to navigate to in response to this result.

Returns:

  • redirect URL

getStatus() 

getStatus(): Status

Status describing the outcome of this result.

Returns:

  • status of this result

setEvent(String) 

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(String, Object) 

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