Interface IUserAuthenticationUI


  • public interface IUserAuthenticationUI
    User authentication interface used for the login panel UI.

    It enables saving the user authentication settings on a specific device and restoring them from previous states if the application enables it.

    Automatic login is also supported.

    Author:
    Christopher Mindus
    • Method Detail

      • initialize

        void initialize​(VSField user,
                        VSField password,
                        VSField rememberMe,
                        VSAction signUp)
                 throws ValueConversionException
        Initializes the user ID, password and "Remember Me" enabled settings.
        Parameters:
        user - The user name field.
        password - The password field.
        rememberMe - The "Remember Me" check box.
        signUp - The sign-up action.
        Throws:
        ValueConversionException - In case of value conversion errors.
      • isAutoLoginEnabled

        boolean isAutoLoginEnabled()
        Checks if automatic login should be performed.
        Returns:
        true to do automatic login (if user and password is filled in), false not to do so.
      • saveSettings

        void saveSettings​(VSField user,
                          VSField password,
                          VSField rememberMe)
                   throws ValueConversionException
        Saves the user ID, password and "Remember Me" enabled settings. The User ID and password cleared on the device if "Remember Me" is not enabled.

        If the application does not support "Remember Me", the flag is ignored and assumed to be false.

        Throws:
        ValueConversionException - In case of value conversion errors.