API Docs for:
Show:

eb_adminCheckout Class

Define eb_adminCheckout class.

Methods

eb_adminCheckout.domElement

(
  • domElement
)

Page DOM element.

Parameters:

  • domElement Object

    current DOM element.

eb_adminCheckout.model

(
  • options
)

Checkout Model for binding data. The model contains observable properties to hold corresponding data returned from services. Also, model contains computed properties and methods to support Checkout functionality.

Parameters:

  • options Object

    Contains necessary data which is required for Checkout functionality.

    • ServicePath String

      Service URL.

    • SitePath String

      Site URL.

    • domElement Object

      DOM element.

    • templatePath String

      HTML path.

    • shoppingCart Object

      Shopping Cart Object.

    • personId String

      Person ID.

eb_reviewOrder.render

(
  • options
)
String

Rendering public method to load HTML template. Based on page level configuration it will select the template and load in DOM. Template path and DOM element are required parameters. GET the template by Ajax call using template path and then assign it to DOM element.

Parameters:

  • options Any

    Object with data required for getting HTML template through Ajax call.

    • SitePath String

      Site path.

    • templatePath String

      HTML file path.

    • domElement Object

      DOM element.

Returns:

String:

jQuery promise object which when resolved returns HTML template.

Properties

eb_adminCheckout.completePayment

String

For Completing the payment

eb_adminCheckout.defaultErrorMessage

String

Default error message.

eb_adminCheckout.errorResponses

Object

Globally defined error codes object for the control. Every error code should have boolean 'useServerMessage' attribute, which when true suggests we are showing service error message on the UI. If the 'useServerMessage' is defined as false, then provide another attribute 'frontEndMessage' with the error string which will be shown on UI. If 'useServerMessage' is false and 'frontEndMessage' is not defined, default error message will be shown. If service error response contains error code not defined in this object then default error message will be shown.

eb_adminCheckout.initiatePayment

String

For Initiating the payment

eb_adminCheckout.orderConfirmationUrl

String

Order confirmation URL.

eb_adminCheckout.payPalUrl

String

Paypal Url

eb_adminCheckout.purchaseOrder

String

Order type

eb_adminCheckout.reviewOrderUrl

String

Redirect from checkout page to reviewOrder

eb_adminCheckout.ServicePath

String

The path to the eBusiness SOA layer.

eb_adminCheckout.shippingAddressUrl

String

Shipping address URL.

eb_adminCheckout.SitePath

String

Control level setting: Site path.

eb_adminCheckout.TemplatePath

String

Control level setting Template path.