Type Alias CheckoutContactDetailsCallback

CheckoutContactDetailsCallback: (
    context: {
        configurator: Configurator;
        contactDetails: DemandContactAPIModel;
        contactRequirements: DemandFormContactRequirements;
        demandItems: DemandItemAPIModel[];
        formType: DemandFormType;
        selectedOptions: ParameterOptions;
    },
) => false
| Promise<false>
| unknown

Function that is called during checkout process after the user successfully submitted their validated contact details, before sending the data to API and displaying the checkout result screen.

Return false to prevent sending the submitted data to API and displaying the checkout result screen.

This function can be asynchronous (it will be awaited), but does not have to be.

Type declaration

- (
      context: {
          configurator: Configurator;
          contactDetails: DemandContactAPIModel;
          contactRequirements: DemandFormContactRequirements;
          demandItems: DemandItemAPIModel[];
          formType: DemandFormType;
          selectedOptions: ParameterOptions;
      },
  ): false
  | Promise<false>
  | unknown
- Parameters
  - context: {
        configurator: Configurator;
        contactDetails: DemandContactAPIModel;
        contactRequirements: DemandFormContactRequirements;
        demandItems: DemandItemAPIModel[];
        formType: DemandFormType;
        selectedOptions: ParameterOptions;
    }
    - configurator: Configurator
      Configurator object with its state for any additional data
    - contactDetails: DemandContactAPIModel
      Contact details the user has entered
    - contactRequirements: DemandFormContactRequirements
      Requirements for the contact information in the checkout form
    - demandItems: DemandItemAPIModel[]
      Items being requested with amounts the user has selected
    - formType: DemandFormType
      Form type used
    - selectedOptions: ParameterOptions
      Configuration options selected by the user
  Returns false | Promise<false> | unknown

Example

  async function handleCheckoutContactDetails(context) {
      await MyApi.saveDemand({
          items: context.demandItems,
          user: context.contactDetails,
      });
      WebPage.showToast("We've got your demand!");
      return false;
  }

Type Alias CheckoutContactDetailsCallback

Type declaration

Parameters

configurator: Configurator

contactDetails: DemandContactAPIModel

contactRequirements: DemandFormContactRequirements

demandItems: DemandItemAPIModel[]

formType: DemandFormType

selectedOptions: ParameterOptions

Returns false | Promise<false> | unknown

Example

Settings