java.lang.Object
net.datenwerke.oidc.client.provider.keycloak.jsi.LoginOptions
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

public class LoginOptions extends Object
Mapper class for keycloak js login options.
  • Constructor Details

    • LoginOptions

      public LoginOptions()
  • Method Details

    • redirectUri

      public String redirectUri()
      Return the uri to redirect to after login.
    • redirectUri

      public final LoginOptions redirectUri(String redirectUri)
      Helper for chaining login option setters.
      Parameters:
      redirectUri - The redirectUri to set.
      Returns:
      The login option instance.
    • prompt

      public String prompt()
      Return the prompt. By default, the login screen is displayed if the user is not logged-in to Keycloak. To only authenticate to the application if the user is already logged-in and not display the login page if the user is not logged-in, set this option to none.
    • prompt

      public final LoginOptions prompt(String prompt)
      Helper for chaining login option setters.
      Parameters:
      prompt - The prompt to set.
      Returns:
      The login option instance.
    • loginHint

      public String loginHint()
      Return the login hint. Used to pre-fill the username/email field on the login form.
    • loginHint

      public final LoginOptions loginHint(String loginHint)
      Helper for chaining login option setters.
      Parameters:
      loginHint - The loginHint to set.
      Returns:
      The login option instance.
    • action

      public String action()
      Return action value. If value is 'register' then user is redirected to registration page, otherwise to login page.
    • action

      public final LoginOptions action(String action)
      Helper for chaining login option setters.
      Parameters:
      action - The action to set.
      Returns:
      The login option instance.
    • locale

      public String locale()
      Return the desired locale for the UI.
    • locale

      public final LoginOptions locale(String locale)
      Helper for chaining login option setters.
      Parameters:
      locale - The locale to set.
      Returns:
      The login option instance.