@auth0/auth0-acul-react - v1.9.0
    Preparing search index...

    Interface EmailOTPChallengeMembers

    Represents the Email OTP Challenge screen interface.

    interface EmailOTPChallengeMembers {
        branding: BrandingMembers;
        client: ClientMembers;
        countryCodes?: CountryCodesMembers;
        experiment?: ExperimentMembers | null;
        organization: OrganizationMembers;
        prompt: PromptMembers;
        tenant: TenantMembers;
        transaction: TransactionMembers;
        user: UserMembers;
        untrustedData: UntrustedDataMembers;
        getErrors(): Error[];
        changeLanguage(options: LanguageChangeOptions): Promise<void>;
        screen: ScreenMembersOnEmailOTPChallenge;
        submitCode(options: OtpCodeOptions): Promise<void>;
        resendCode(options?: CustomOptions): Promise<void>;
        resendManager(options?: StartResendOptions): ResendControl;
    }

    Hierarchy (View Summary)

    Index

    Properties

    branding client countryCodes? experiment? organization prompt tenant transaction user untrustedData screen

    Methods

    getErrors changeLanguage submitCode resendCode resendManager

    Properties

    branding: BrandingMembers
    client: ClientMembers
    countryCodes?: CountryCodesMembers

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    experiment?: ExperimentMembers | null

    The active Experiment Center experiment for the current screen, or null when none is active (or the screen has not opted in via context_configuration).

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    organization: OrganizationMembers
    prompt: PromptMembers
    tenant: TenantMembers
    transaction: TransactionMembers
    user: UserMembers
    untrustedData: UntrustedDataMembers
    screen: ScreenMembersOnEmailOTPChallenge

    Methods

    • Returns Error[]

    • Submits the OTP code entered by the user.

      Parameters

      • options: OtpCodeOptions

        Optional parameters to include in the submission.

      Returns Promise<void>

    • Requests a new OTP code to be sent to the user's email.

      Parameters

      • Optionaloptions: CustomOptions

        Optional parameters to include in the resend request.

      Returns Promise<void>

    • Gets resend functionality with timeout management for this screen

      Parameters

      Returns ResendControl

    Settings

    Member Visibility

    On This Page

    Properties
    Methods