Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebFormHandlers

Web Form event handlers.

Hierarchy

  • WebFormHandlers

Index

Properties

Optional onAbort

onAbort: () => void

Callback for the abort event. In case the end user cancels (aborts) the web form, they will first see the "Abort" view. Only when the end user clicks the "Close" button, the callback will be triggered.

Type declaration

    • (): void
    • Returns void

Optional onComplete

onComplete: () => void

Callback for the complete event. The moment when this callback is triggered, depends on whether a profile is applied to the web form, and whether this profile has "functionality.skipConfirmationView" flag set to "true" - in that case, the callback is triggered immediately once the flow is completed. Otherwise, the end user will first see the "Confirmation" view, and only when the end user clicks the "Close" button, the callback will be triggered.

Type declaration

    • (): void
    • Returns void

Optional onFail

onFail: () => void

Callback for the fail event. In case of an error, the end user will first see the "Error" view with error details. Only when the end user clicks the "Close" button, the callback will be triggered.

Type declaration

    • (): void
    • Returns void

Optional onLoadError

onLoadError: () => void

Callback in case of error occurs while loading the Web form. It may happen if Web Form bundle js fails to load due to any reason that prevents it from downloading.

Type declaration

    • (): void
    • Returns void

Optional onLoaded

onLoaded: () => void

Callback triggered when first component of the Web Form is rendered.

Type declaration

    • (): void
    • Returns void

Generated using TypeDoc