Package ch.nevis.mobile.sdk.api.operation.userverification

Interface BiometricUserVerificationHandler

All Superinterfaces:

CancelableHandler

public interface BiometricUserVerificationHandler
extends CancelableHandler

The object handling the outcome of an interaction where the user provides biometric credentials.

This is used with the Authenticator.BIOMETRIC_AUTHENTICATOR_AAID. The particularity of this authenticator with the other authenticators, is that the SDK relies on the operating system prompt to authentication (i.e. there is no need to develop a GUI to do the authentication when this authenticator is used).

See Also:

• BiometricUserVerifier.verifyBiometric(BiometricUserVerificationContext, BiometricUserVerificationHandler)

Method Summary

Modifier and Type	Method	Description
void	cancel()	The user verification was canceled.
OsAuthenticationListenHandler	listenForOsCredentials(BiometricPromptOptions options)	When this method is invoked, the SDK will invoke the operating system prompt to ask the user to provide credentials.

Method Details

listenForOsCredentials

OsAuthenticationListenHandler listenForOsCredentials(BiometricPromptOptions options)

When this method is invoked, the SDK will invoke the operating system prompt to ask the user to provide credentials. So no GUI must be explicitly defined by the code using the SDK (as required in the fingerprint and the PIN authenticators).

Parameters:

options - the options to be used when prompting

Returns:

an OsAuthenticationListenHandler that can be used to cancel listening for OS credentials

Throws:

IllegalStateException - if either cancel() or this method were previously invoked

cancel

void cancel()

The user verification was canceled.

Specified by:

cancel in interface CancelableHandler

Throws:

IllegalStateException - if either this method or listenForOsCredentials(BiometricPromptOptions) were previously invoked