Interface FlowInstance

Flow instance interface for event handling

interface FlowInstance {
    close(): void;
    off(event: FlowEventType, callback: FlowEventCallback): void;
    on(event: "completed", callback: ((data: FlowCompletionData) => void)): void;
    on(event: "exit", callback: (() => void)): void;
    on(event: "navigated", callback: ((payload: NavigationData) => void)): void;
    on(event: "authenticationSucceeded", callback: (() => void)): void;
    on(event: "authenticationFailed", callback: (() => void)): void;
    on(event: "error", callback: ((data: ErrorData) => void)): void;
    on(event: "loaded", callback: (() => void)): void;
    on(event: "onboardingCompleted", callback: (() => void)): void;
    on(event: "onboardingRequired", callback: (() => void)): void;
}

Methods

close off on

Methods

close

  • close(): void

  • Close the flow and clean up resources

    Returns void

off

  • off(event, callback): void

  • Remove an event listener for this flow

    Parameters

    Returns void

on

  • on(event, callback): void

  • Register an event listener for this flow

    Parameters

    • event: "completed"

      The event type to listen for

    • callback: ((data: FlowCompletionData) => void)

      The callback function to execute when the event occurs

    Returns void

  • on(event, callback): void

  • Parameters

    • event: "exit"
    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

  • on(event, callback): void

  • Parameters

    Returns void

  • on(event, callback): void

  • Parameters

    • event: "authenticationSucceeded"
    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

  • on(event, callback): void

  • Parameters

    • event: "authenticationFailed"
    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

  • on(event, callback): void

  • Parameters

    • event: "error"
    • callback: ((data: ErrorData) => void)
        • (data): void

        • Parameters

          Returns void

    Returns void

  • on(event, callback): void

  • Parameters

    • event: "loaded"
    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

  • on(event, callback): void

  • Parameters

    • event: "onboardingCompleted"
    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

  • on(event, callback): void

  • Parameters

    • event: "onboardingRequired"
    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

Settings

Member Visibility

On This Page

Methods