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;
};