Enum BiometricsSupport

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<BiometricsSupport>

    public enum BiometricsSupport
    extends java.lang.Enum<BiometricsSupport>
    An enum that identified if the device is capable of supporting the biometrics or not. This includes fingerprint biometrics type.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ANDROID_VERSION_NOT_SUPPORTED
      The SDK will return this error if the firmware version is less than Android 6.0.
      NO_FINGERPRINT_ENROLLED
      The SDK will return this error if the end-user did not yet enroll his/her fingerprints into the Android settings.
      NO_FINGERPRINT_SENSOR
      The SDK will return this error if there is no Fingerprint sensor installed into the device.
      PERMISSION_NOT_GRANTED
      An error returned if the biometric fingerprint permission in the Android manifest is not defined / granted.
      SECURE_LOCK_NOT_PRESENTED
      An error returned if biometrics or only biometric fingerprint is supported and available but secure lock (PIN, Password or Pattern) is not enabled in the device.
      SECURITY_UPDATE_REQUIRED
      A security vulnerability has been discovered and the sensor is unavailable until a security update has addressed this issue *
      NOTE: This error can be received if sensor's strength can only meet weak authenticator
      SUPPORTED
      The SDK can fully support the use of biometrics features including fingerprint.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()
      String representation of the Enum.
      static BiometricsSupport valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static BiometricsSupport[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • ANDROID_VERSION_NOT_SUPPORTED

        public static final BiometricsSupport ANDROID_VERSION_NOT_SUPPORTED
        The SDK will return this error if the firmware version is less than Android 6.0.
      • NO_FINGERPRINT_SENSOR

        public static final BiometricsSupport NO_FINGERPRINT_SENSOR
        The SDK will return this error if there is no Fingerprint sensor installed into the device.
      • NO_FINGERPRINT_ENROLLED

        public static final BiometricsSupport NO_FINGERPRINT_ENROLLED
        The SDK will return this error if the end-user did not yet enroll his/her fingerprints into the Android settings.
        NOTE: MPA to decide the responsibility for the enrollment of the fingerprint data in the Android settings.
      • PERMISSION_NOT_GRANTED

        public static final BiometricsSupport PERMISSION_NOT_GRANTED
        An error returned if the biometric fingerprint permission in the Android manifest is not defined / granted.
      • SUPPORTED

        public static final BiometricsSupport SUPPORTED
        The SDK can fully support the use of biometrics features including fingerprint.
      • SECURE_LOCK_NOT_PRESENTED

        public static final BiometricsSupport SECURE_LOCK_NOT_PRESENTED
        An error returned if biometrics or only biometric fingerprint is supported and available but secure lock (PIN, Password or Pattern) is not enabled in the device. *
        NOTE: There is device dependant setting that few devices support to keep biometrics or fingerprints while having non secure screen lock
      • SECURITY_UPDATE_REQUIRED

        public static final BiometricsSupport SECURITY_UPDATE_REQUIRED
        A security vulnerability has been discovered and the sensor is unavailable until a security update has addressed this issue *
        NOTE: This error can be received if sensor's strength can only meet weak authenticator
    • Method Detail

      • values

        public static BiometricsSupport[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (BiometricsSupport c : BiometricsSupport.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static BiometricsSupport valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • toString

        public java.lang.String toString()
        String representation of the Enum.
        Overrides:
        toString in class java.lang.Enum<BiometricsSupport>
        Returns:
        String representation of the Enum.