MfaPushPollingControl

MFAプッシュ通知のポーリングセッションを管理するための制御インターフェース。

このインターフェースは、MFAプッシュチャレンジが承認されたかどうかを確認する 長時間実行されるポーリングループを開始・停止し、そのステータスを確認するための 命令的なメソッドを提供します。

Example

export interface MfaPushPollingControl {
  /**
   * ポーリング処理を即座に停止します。
   *
   * - スケジュール済みのタイマーまたは保留中のリクエストをキャンセルします。
   * - 停止後、`isRunning()` は `false` を返します。
   * - 複数回呼び出しても安全です。2回目以降の呼び出しは何も行いません。
   *
   * @example
   * ```ts
   * const control = mfaPushChallengePush.pollingManager({ intervalMs: 5000 });
   * control.startPolling();
   *
   * // その後、ユーザーがキャンセルした場合:
   * control.stopPolling();
   * ```
   */
  stopPolling: () => void;

  /**
   * ポーリング処理を開始または再開します。
   *
   * - ポーリングがすでに実行中の場合、再度呼び出しても何も行いません。
   * - 以前に停止していた場合、呼び出すとポーリングループが再開されます。
   *
   * @example
   * ```ts
   * control.startPolling(); // MFA プッシュチャレンジの確認を開始する
   * ```
   */
  startPolling: () => void;

  /**
   * ポーリング処理が現在実行中かどうかを示します。
   *
   * - ポーリングが実行中でキャンセルされていない場合、`true` を返します。
   * - ポーリングが停止または完了している場合、`false` を返します。
   *
   * @example
   * ```ts
   * if (control.isRunning()) {
   *   console.log('ポーリング進行中...');
   * } else {
   *   console.log('ポーリングは停止または完了しています。');
   * }
   * ```
   */
  isRunning: () => boolean;
}

プロパティ

isRunning · boolean

ポーリング処理が現在実行中かどうかを示します。

Example

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

startPolling · void

ポーリング処理を開始または再開します。

• ポーリングがすでに実行中の場合、再度呼び出しても何も起こりません。
• 以前に停止していた場合は、呼び出すとポーリングループが再開されます。

Example

control.startPolling(); // MFA プッシュチャレンジの確認を開始

stopPolling · void

ポーリング処理を直ちに停止します。

• 予定されているタイマーや保留中のリクエストをすべてキャンセルします。
• 停止すると、isRunning() は false を返します。
• 複数回呼び出しても安全で、2 回目以降の呼び出しでは何も起こりません。

Example

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

// 後でユーザーがキャンセルした場合:
control.stopPolling();