futuraekit-java/com.futurae.sdk.public_api.lock/FuturaeLockApi

FuturaeLockApi

public interface FuturaeLockApi

A grouping for futurae Lock/Unlock management.

See also

  • unlocks the SDK based on the provided credentials and lock configuration.

  • lock the sdk

  • check if SDK is locked at the moment.

  • list of available UnlockMethodType.

  • activate biometric for SDK_PIN_WITH_BIOMETRICS_OPTIONAL

  • deactivate biometrics for SDK_PIN_WITH_BIOMETRICS_OPTIONAL

  • check if new biometric data was added since initialization.

Functions

Link copied to clipboard
public abstract AsyncCompletableOperation activateBiometrics(PresentationConfigurationForBiometricsPrompt presentationConfigurationForBiometricsPrompt)

Activate the biometric authentication as a means of convenience to verify the user presence, so that the user doesn't have to enter the PIN to unlock the SDK. This method shall only be called when the SDK LockConfigurationType is SDK_PIN_WITH_BIOMETRICS_OPTIONAL.

Link copied to clipboard
public abstract AsyncCompletableOperation changeSDKPin(CharArray newSdkPin)

Change the Custom App PIN. This is a protected operation, so the SDK must be unlocked before calling this method.

Link copied to clipboard
public abstract AsyncCompletableOperation deactivateBiometrics()

Deactivate biometrics as an authentication method. This function revokes the biometric authentication capability for unlocking the SDK. This method shall only be called when the SDK LockConfigurationType is SDK_PIN_WITH_BIOMETRICS_OPTIONAL

Link copied to clipboard
public abstract List<UnlockMethodType> getActiveUnlockMethods()

Returns the list of available UnlockMethodType which the SDK may currently be unlocked with.

Link copied to clipboard
public abstract Boolean haveBiometricsChanged()

Check whether the device biometrics have changed. This method is only available when the SDKConfiguration uses setInvalidatedByBiometricChange(true) and LockConfigurationType other than NONE.

Link copied to clipboard
public abstract Boolean isLocked()

Checks whether the SDK is locked or not.

Link copied to clipboard
public abstract Unit lock()

locking function that immediately locks the SDK. Any subsequent call to a locked method will result in LockOperationIsLockedException.

Link copied to clipboard
public abstract AsyncCompletableOperation switchToLockConfiguration(Application application, SwitchTargetLockConfiguration targetLockConfiguration)

Switch lock configuration without resetting. Requires at least one enrolled account.

Link copied to clipboard
public abstract AsyncOperation<UserPresenceVerificationFactor> unlock(UserPresenceVerificationMode userPresenceVerificationMode, Boolean shouldWaitForSDKSync)

Unlocking method that could be called prior to using a locked functionality,