MfaPushPollingControl

Interface de contrôle servant à gérer une session de scrutation pour une notification push MFA.

Cette interface fournit des méthodes impératives pour démarrer, arrêter et vérifier l’état d’une boucle de scrutation de longue durée qui permet de vérifier si un défi push MFA a été approuvé.

Example

export interface MfaPushPollingControl {
  /**
   * Arrête immédiatement le processus de scrutation.
   *
   * - Annule tout minuteur planifié ou toute requête en attente.
   * - Une fois arrêté, `isRunning()` retourne `false`.
   * - Peut être appelé plusieurs fois sans risque ; les appels suivants n'ont aucun effet.
   *
   * @example
   * ```ts
   * const control = mfaPushChallengePush.pollingManager({ intervalMs: 5000 });
   * control.startPolling();
   *
   * // Plus tard, si l'utilisateur annule :
   * control.stopPolling();
   * ```
   */
  stopPolling: () => void;

  /**
   * Démarre ou reprend le processus de scrutation.
   *
   * - Si la scrutation est déjà active, un nouvel appel n'a aucun effet.
   * - Si elle a été arrêtée précédemment, cet appel redémarre la boucle de scrutation.
   *
   * @example
   * ```ts
   * control.startPolling(); // Commence à vérifier le défi push MFA
   * ```
   */
  startPolling: () => void;

  /**
   * Indique si le processus de scrutation est en cours d'exécution.
   *
   * - Retourne `true` si la scrutation est active et non annulée.
   * - Retourne `false` si la scrutation a été arrêtée ou est terminée.
   *
   * @example
   * ```ts
   * if (control.isRunning()) {
   *   console.log('Interrogation en cours...');
   * } else {
   *   console.log('Interrogation arrêtée ou terminée.');
   * }
   * ```
   */
  isRunning: () => boolean;
}

Propriétés

isRunning · boolean

Indique si le processus de scrutation est en cours d’exécution.

Example

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

startPolling · void

Démarre ou reprend le processus de scrutation.

• Si la scrutation est déjà active, appeler cette méthode de nouveau n’a aucun effet.
• S’il a été arrêté auparavant, appeler cette méthode redémarre la boucle de scrutation.

Example

control.startPolling(); // Commencer à vérifier le défi push MFA

stopPolling · void

Arrête immédiatement le processus de scrutation.

• Annule tout minuteur planifié ou toute requête en attente.
• Une fois arrêté, isRunning() renvoie false.
• Cette méthode peut être appelée plusieurs fois en toute sécurité; les appels suivants n’ont aucun effet.

Example

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

// Plus tard, si l’utilisateur annule :
control.stopPolling();