EmailOTPChallenge

Universal Login の email-otp-challenge 画面をカスタマイズするために使用できる、すべてのプロパティとメソッドについて説明します。

EmailOTPChallenge クラスは、email-otp-challenge 画面の機能を実装します。この画面では、ユーザーにメールアドレスに送信されたワンタイムパスコードの入力を求めます。

​

コンストラクタ

EmailOTPChallenge画面マネージャーのインスタンスを作成します:

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
await emailOTPChallengeManager.submitCode({ code: '123456' });

​

プロパティ

branding · BrandingMembers

ブランディングテーマや設定など、branding に関する構成を提供します。

client · ClientMembers

email-otp-challenge 画面向けに、id、name、logoUrl などのクライアント関連の構成を提供します。

organization · OrganizationMembers

ユーザーの組織に関する情報 (id や name など) を提供します。

prompt · PromptMembers

認証フロー内の現在の prompt に関するデータを含みます。

screen · ScreenMembers

構成やコンテキストを含む、email-otp-challenge 画面固有の詳細を含みます。

tenant · TenantMembers

id や関連するメタデータなど、テナントに関するデータを含みます。

transaction · TransactionMembers

アクティブな識別子やフローの state など、email-otp-challenge 画面に固有のトランザクション データを提供します。

untrustedData · UntrustedDataMembers

メール OTP チャレンジフロー中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

現在のユーザーの詳細。username、email、roles などが含まれます。

​

メソッド

changeLanguage · Promise<void>

このメソッドは、Universal Login ページの表示言語を変更します。

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
emailOTPChallengeManager.changeLanguage({
  language: 'fr',
});

メソッドのパラメータ

表示 パラメータ

options

LanguageChangeOptions。

language · string · 必須

使用する言語のロケールコードです (例: 'en'、'fr'、'es') 。

persist? · "session"

'session' に設定すると、選択した言語はセッション中維持されます。

getErrors · Error []

このメソッドは、コンテキストからトランザクションエラーの配列を取得します。存在しない場合は空の配列を返します。

resendCode · Promise<void>

このメソッドは、新しい OTP code をユーザーのメールアドレスに送信するようリクエストします。

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
await emailOTPChallengeManager.resendCode();

resendManager · ResendControl

このメソッドは、タイムアウト管理を伴う再送機能を提供します。startResend() メソッドを持つ ResendControl オブジェクトを返します。このメソッドは再送をトリガーし、ユーザーが再度再送できるようになるまでクールダウン期間を適用します。

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
const { startResend } = emailOTPChallengeManager.resendManager({
  timeoutSeconds: 15,
});
await startResend();

メソッドのパラメータ

表示 パラメータ

options

StartResendOptions。

timeoutSeconds? · number

ユーザーが code を再送信できるようになるまでのクールダウン時間 (秒) です。

onStatusChange? · OnStatusChangeCallback

再送のステータスが変わるたびに呼び出されるコールバックです。残り秒数と、再送機能が現在無効かどうかを返します。

onTimeout? · () => void

クールダウンが終了し、再送信が再び可能になったときに呼び出されるコールバックです。

submitCode · Promise<void>

このメソッドは、ユーザーが入力した OTP code を送信します。

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
await emailOTPChallengeManager.submitCode({ code: '123456' });

メソッドのパラメータ

表示 パラメータ

options

OtpCodeOptions。

code · string · 必須

ユーザーが送信するために入力する OTP code です。