CredentialState

public class CredentialState

Class represents the credential state during a specific operation using a Pin dialog with requestCredential function of the Pin class. A single CredentialState has to be used in a single process in order to update its values. See the examples of requestCredential function of the Pin class.

Constructors

CredentialState

public CredentialState(int remainingTries, int facialRemainingTries, String error)

Creates a CredentialState instance.

Parameters:
  • remainingTries – the PIN remaining tries. It can be obtained with Pin.getRemainingTries().
  • facialRemainingTries – the facial biometry authentication object remaining tries, if applicable. It can be obtained with Pin.getFacialRemainingTries().
  • error – a potential error message that can be displayed in the Pin dialog during a specific process.

Methods

getError

public String getError()

Gets the error message.

Returns:the error message.

getFacialRemainingTries

public int getFacialRemainingTries()

Gets the remaining tries for facial biometry authentication object, if applicable.

Returns:biometric facial remaining tries or -1 if not available.

getRemainingTries

public int getRemainingTries()

Gets the remaining tries value registered in the current object.

Returns:the remaining tries value registered in the current object.