Interface ModBaseWidgetCallbacks

interface ModBaseWidgetCallbacks {
    onError?: (() => void);
    onNavigate?: ((location) => void);
    onSuccess?: ((processToken) => void);
}

Hierarchy (view full)

Properties

onError? onNavigate? onSuccess?

Properties

Optional onError

onError?: (() => void)

The onError event is triggered when a technical error occurs, such as an inaccessible API server, an incorrect widget configuration, or any other unexpected error.

Type declaration

    • (): void

    • The onError event is triggered when a technical error occurs, such as an inaccessible API server, an incorrect widget configuration, or any other unexpected error.

      Returns void

Optional onNavigate

onNavigate?: ((location) => void)

The onNavigate event is triggered when navigating to a different view. The event's payload is the route's path. For example, you can use this event to incorporate the widget's steps into your own stepper.

Type declaration

    • (location): void

    • The onNavigate event is triggered when navigating to a different view. The event's payload is the route's path. For example, you can use this event to incorporate the widget's steps into your own stepper.

      Parameters

      • location: string

      Returns void

Optional onSuccess

onSuccess?: ((processToken) => void)

When the widget has finished executing, the onSuccess event is triggered. This event indicates that the widget has completed successfully, not that the widget's check has returned positive results. If the results of the widget's check are to be provided, then they should be sent as the payload of a separate event.

Type declaration

    • (processToken): void

    • When the widget has finished executing, the onSuccess event is triggered. This event indicates that the widget has completed successfully, not that the widget's check has returned positive results. If the results of the widget's check are to be provided, then they should be sent as the payload of a separate event.

      Parameters

      • processToken: string

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc