Interface MfaPushPollingControl

Control interface for managing a polling session.

This interface provides imperative methods to start, stop, and inspect the status of a long-running polling loop that checks whether the polled request, such as an MFA push challenge or a pending consent, has been completed.

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

Index

Properties

stopPolling startPolling isRunning

Properties

stopPolling

stopPolling: () => void

Stops the polling process immediately.

Cancels any scheduled timer or pending request.
Once stopped, isRunning() returns false.
Safe to call multiple times; subsequent calls have no effect.

Example

const control = mfaPushChallengePush.pollingManager({ intervalMs: 5000 });
control.startPolling();

// Later, if the user cancels:
control.stopPolling();

startPolling

startPolling: () => void

Starts or resumes the polling process.

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

Example

control.startPolling(); // Begin polling

isRunning

isRunning: () => boolean

Indicates whether the polling process is currently running.

Returns true if polling is active and not cancelled.
Returns false if polling has been stopped or has completed.

Example

if (control.isRunning()) {
  console.log('Polling in progress...');
} else {
  console.log('Polling is stopped or completed.');
}

Interface MfaPushPollingControl

Index

Properties

Properties

stopPolling

Example

startPolling

Example

isRunning

Example

Settings

On This Page