Interface MfaPollingResult

Result object returned by useMfaPolling.

interface MfaPollingResult {
    isRunning: boolean;
    startPolling: () => void;
    stopPolling: () => void;
}

Index

Properties

isRunning startPolling stopPolling

Properties

isRunning

isRunning: boolean

Indicates whether the MFA push polling process is currently active.

true — Polling is running and awaiting completion.
false — Polling has stopped, either due to completion, manual cancellation, or component unmount.

startPolling

startPolling: () => void

Starts or resumes the polling process.

If polling is already active, this call has no effect.
If previously stopped, calling this restarts the polling loop.

stopPolling

stopPolling: () => void

Stops the polling process immediately.

Cancels any scheduled timers or in-flight requests.
Safe to call multiple times; subsequent calls have no effect.