Enum Class BiometricType
- All Implemented Interfaces:
Serializable, Comparable<BiometricType>, Constable
The kind of biometric check a client device offers, as iiziRun's plugin (
cordova-plugin-fingerprint-aio) reports it to IBiometricAuthentication (CC-IIZIRUN-BIOMETRIC-API).The plugin answers its isAvailable with one word: finger (Touch ID, or Android below API 28), face (Face ID), optic (Optic ID on visionOS; IIZI's hot-code-fix of the plugin's iOS source adds it) or biometric (Android API 28 and later, which never says which kind the device has). DEVICE_CREDENTIAL is IIZI's own: the device has no biometric check but has a passcode, PIN, pattern or password that BiometricPrompt.allowDeviceCredential(boolean) can let stand in.
- Author:
- Christopher Mindus
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E>Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionA biometric of a kind the platform does not name: Android API 28 and later, where the device may have a fingerprint reader, face unlock, or both.No biometric check, but a device credential (passcode, PIN, pattern or password) that a prompt may let stand in.Face ID on iOS.A fingerprint: Touch ID on iOS, or a fingerprint reader on Android below API 28.No biometric check: the plugin is absent, answered an error (not enrolled, no hardware, ...), or the client is not iiziRun.Optic ID on visionOS.Field Summary
FieldsModifier and TypeFieldDescriptionfinal StringThe word the plugin'sisAvailableanswers for this type,noneforNONEandcredential(IIZI's own) forDEVICE_CREDENTIAL.Method Summary
Modifier and TypeMethodDescriptionbooleanChecks if this type is a biometric: anything butNONEandDEVICE_CREDENTIAL.static BiometricTypeGets the type the plugin's word names.static BiometricTypeReturns the enum constant of this class with the specified name.static BiometricType[]values()Returns an array containing the constants of this enum class, in the order they are declared.
Enum Constant Details
NONE
No biometric check: the plugin is absent, answered an error (not enrolled, no hardware, ...), or the client is not iiziRun. SeeIBiometricAuthentication.getUnavailableReason().FINGER
A fingerprint: Touch ID on iOS, or a fingerprint reader on Android below API 28.FACE
Face ID on iOS.OPTIC
Optic ID on visionOS.BIOMETRIC
A biometric of a kind the platform does not name: Android API 28 and later, where the device may have a fingerprint reader, face unlock, or both.DEVICE_CREDENTIAL
No biometric check, but a device credential (passcode, PIN, pattern or password) that a prompt may let stand in. Reported when the plugin's biometric check is unavailable andIBiometricAuthentication.getDeviceCredential()isIBiometricAuthentication.DeviceCredential.AVAILABLE.
Field Details
pluginName
The word the plugin'sisAvailableanswers for this type,noneforNONEandcredential(IIZI's own) forDEVICE_CREDENTIAL.
Method Details
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
isBiometric
public boolean isBiometric()Checks if this type is a biometric: anything butNONEandDEVICE_CREDENTIAL.- Returns:
- true for a biometric.
of
Gets the type the plugin's word names.