Skip to main content
​
MfaPollingOptions
object
MFA プッシュ通知のポーリング プロセスを管理するための設定オプションです。ポーリング セッションの開始時にこれらのオプションを指定すると、チャレンジ エンドポイントへの問い合わせ頻度や、成功時または失敗時の処理方法を制御できます。
Example
export type MfaPollingOptions = {
  /**
   * 連続するポーリング リクエストの間隔を**ミリ秒**単位で指定する省略可能な値です。
   *
   * - 省略した場合は、SDK の内部デフォルト間隔が使用されます（通常は 5000 ms）。
   * - 応答性とレート制限への配慮のバランスが取れた値を選択してください。
   *
   * @defaultValue 実装固有（通常は 5000 ms）
   */
  intervalMs?: number;

  /**
   * MFA プッシュ チャレンジが正常に承認され、
   * ポーリングが完了した時点で実行される省略可能なコールバックです。
   *
   * - **1 回だけ**呼び出され、その後ポーリングは自動的に停止します。
   * - ログイン フローを先に進める際に便利です（例: `continue()` の呼び出し）。
   */
  onCompleted?: () => void;

  /**
   * ポーリング中にエラーが発生した場合に呼び出される省略可能なコールバックです。
   *
   * 以下を含む {@link ULError} オブジェクトを受け取ります。
   * - `status` — 失敗したリクエストの HTTP ステータス コード
   * - `responseText` — 利用可能な場合は生のレスポンス ボディ
   *
   * - エラー イベントごとに 1 回呼び出されます。エラーの種類によってはポーリングが再試行される場合があります。
   * - エラー メッセージを表示したり、カスタムの再試行/中止ロジックをトリガーしたりするために使用します。
   */
  onError?: (error: ULError) => void;
};