Interface UserAuthenticationCallback


public interface UserAuthenticationCallback
The UserAuthenticationCallback interface defines the specific elements required for the integrator to interact during a User Authentication flow.

If the integrator use a custom user authentication, this interface will be call during any flow where a User Authentication is needed.

A UserAuthenticationCallback object should be provided to the Orchestrator object (See Orchestrator.setUserAuthenticationCallback(UserAuthenticationCallback, UserAuthentication[])) in order to receive feedback during the user password authentication process.

  • Method Details

    • onUserAuthenticationRequired

      void onUserAuthenticationRequired(UserAuthenticationCallback.UserAuthentication type, UserAuthenticationInputCallback inputCallback, boolean isEnrollment)
      Called when a specific user authentication have been overridden and if an user authentication is required by the Orchestration library. A authentication should be presented to the user. And the user input should be returned throw the inputCallback.
      Parameters:
      type - UserAuthenticationCallback.UserAuthentication the type of authentication asked by the Orchestration library
      inputCallback - a UserAuthenticationInputCallback callback to give the user input to the Orchestration library
      isEnrollment - is set to true in case of enrollment
    • onUserAuthenticationInputError

      void onUserAuthenticationInputError(InputError error)
      Called upon user input error when it is not conform for the Orchestration library.
      Parameters:
      error - the type of input error