Authenticate
Manage Users
Customize
Platformobject
MFA のプッシュ通知におけるポーリング処理を管理するための設定オプションです。ポーリングセッションの開始時にこれらのオプションを指定すると、
チャレンジ endpoint への問い合わせ頻度や、成功時・失敗時の処理方法を制御できます。
Example
export type MfaPollingOptions = {
/**
* 連続するポーリングリクエストの間隔（**ミリ秒**）を指定する任意の値。
*
* - 省略した場合は、SDK の内部デフォルト間隔が使用されます（通常は 5000 ms）。
* - 応答性とレート制限への配慮のバランスが取れた値を選択してください。
*
* @defaultValue 実装依存（一般的には 5000 ms）
*/
intervalMs?: number;
/**
* MFA プッシュチャレンジが正常に承認され、
* ポーリングが完了した時点で一度だけ実行される任意のコールバック。
*
* - **一度だけ**呼び出され、その後ポーリングは自動的に停止します。
* - ログインフローを次に進める際に役立ちます（例: `continue()` を呼び出す）。
*/
onCompleted?: () => void;
/**
* ポーリング中にエラーが発生した場合に呼び出される任意のコールバック。
*
* 以下を含む {@link ULError} オブジェクトを受け取ります:
* - `status` — 失敗したリクエストの HTTP ステータスコード
* - `responseText` — 利用可能な場合は生のレスポンス本文
*
* - エラーイベントごとに一度呼び出されます。ポーリングはエラーの種類に応じて再試行される場合があります。
* - エラーメッセージを表示したり、独自の再試行/中止ロジックをトリガーしたりするために使用します。
*/
onError?: (error: ULError) => void;
};
Show プロパティ
Show プロパティ
number
連続するポーリングリクエストの間隔 (ミリ秒) を指定する任意の値です。
- 省略した場合は、SDK の内部デフォルト間隔が使用されます (通常は 5000 ms) 。
- 応答性とレート制限への配慮のバランスが取れた値を選択してください。
デフォルト値
Implementation-specific (commonly 5000 ms)
() => void
MFA プッシュチャレンジが正常に承認され、
ポーリングが完了した時点で一度だけ実行される任意のコールバックです。
- 一度だけ呼び出され、その後ポーリングは自動的に停止します。
- ログインフローを次に進める際に役立ちます (例:
continue()を呼び出す) 。
(error) => void