MfaPushPollingControl

Interfaz de control para gestionar una sesión de sondeo de notificaciones push de MFA.

Esta interfaz proporciona métodos imperativos para iniciar, detener e inspeccionar el estado de un bucle de sondeo de larga duración que comprueba si se ha aprobado un desafío push de MFA.

Example

export interface MfaPushPollingControl {
  /**
   * Detiene el proceso de sondeo de inmediato.
   *
   * - Cancela cualquier temporizador programado o solicitud pendiente.
   * - Una vez detenido, `isRunning()` devuelve `false`.
   * - Es seguro llamarlo varias veces; las llamadas posteriores no tienen efecto.
   *
   * @example
   * ```ts
   * const control = mfaPushChallengePush.pollingManager({ intervalMs: 5000 });
   * control.startPolling();
   *
   * // Más tarde, si el usuario cancela:
   * control.stopPolling();
   * ```
   */
  stopPolling: () => void;

  /**
   * Inicia o reanuda el proceso de sondeo.
   *
   * - Si el sondeo ya está activo, volver a llamarlo no tiene efecto.
   * - Si fue detenido previamente, llamarlo reinicia el bucle de sondeo.
   *
   * @example
   * ```ts
   * control.startPolling(); // Comenzar a verificar el desafío push de MFA
   * ```
   */
  startPolling: () => void;

  /**
   * Indica si el proceso de sondeo está en ejecución actualmente.
   *
   * - Devuelve `true` si el sondeo está activo y no ha sido cancelado.
   * - Devuelve `false` si el sondeo ha sido detenido o ha finalizado.
   *
   * @example
   * ```ts
   * if (control.isRunning()) {
   *   console.log('Sondeo en curso...');
   * } else {
   *   console.log('El sondeo está detenido o ha finalizado.');
   * }
   * ```
   */
  isRunning: () => boolean;
}

Propiedades

isRunning · boolean

Indica si el proceso de sondeo está en ejecución en ese momento.

Example

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

startPolling · void

Inicia o reanuda el proceso de sondeo.

• Si el sondeo ya está activo, volver a llamarlo no surte efecto.
• Si se detuvo previamente, al llamarlo se reinicia el bucle de sondeo.

Example

control.startPolling(); // Empieza a comprobar el desafío push de MFA

stopPolling · void

Detiene el proceso de sondeo de inmediato.

• Cancela cualquier temporizador programado o solicitud pendiente.
• Una vez detenido, isRunning() devuelve false.
• Se puede llamar varias veces sin problema; las llamadas posteriores no surten efecto.

Example

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

// Más tarde, si el usuario cancela:
control.stopPolling();