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

    Interface LoginMembers

    Login screen members interface extending base members

    interface LoginMembers {
        branding: BrandingMembers;
        client: ClientMembers;
        countryCodes?: CountryCodesMembers;
        experiment?: ExperimentMembers | null;
        organization: OrganizationMembers;
        prompt: PromptMembers;
        tenant: TenantMembers;
        user: UserMembers;
        untrustedData: UntrustedDataMembers;
        getErrors(): Error[];
        changeLanguage(options: LanguageChangeOptions): Promise<void>;
        screen: ScreenMembersOnLogin;
        transaction: TransactionMembersOnLogin;
        login(payload: LoginPayloadOptions): Promise<void>;
        federatedLogin(payload: FederatedLoginPayloadOptions): Promise<void>;
        pickCountryCode(payload?: CustomOptions): Promise<void>;
        googleOneTap(payload: GoogleOneTapOptions): Promise<void>;
        getLoginIdentifiers(): IdentifierType[] | null;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Methods

    getErrors changeLanguage login federatedLogin pickCountryCode googleOneTap getLoginIdentifiers

    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
    user: UserMembers
    untrustedData: UntrustedDataMembers
    screen: ScreenMembersOnLogin
    transaction: TransactionMembersOnLogin

    Methods

    • Returns Error[]

    • Performs login with username/password

      Parameters

      Returns Promise<void>

    • Picks country code for phone number input

      Parameters

      Returns Promise<void>

    • Submits a Google One Tap credential to complete authentication

      Parameters

      Returns Promise<void>

    • Gets the active identifier types for the login screen

      Returns IdentifierType[] | null

      An array of active identifier types or null if none are active

    Settings

    Member Visibility

    On This Page

    Properties
    Methods