Racehorse
    Preparing search index...

    Variable BiometricStorageErrorCodeConst

    BiometricStorageErrorCode: {
        CANCELED: "canceled";
        HARDWARE_NOT_PRESENT: "hardware_not_present";
        HARDWARE_UNAVAILABLE: "hardware_unavailable";
        KEY_UNRECOVERABLE: "key_unrecoverable";
        LOCKOUT: "lockout";
        LOCKOUT_PERMANENT: "lockout_permanent";
        NEGATIVE_BUTTON: "negative_button";
        NO_BIOMETRICS: "no_biometrics";
        NO_DEVICE_CREDENTIAL: "no_device_credential";
        NO_SPACE: "no_space";
        SECURITY_UPDATE_REQUIRED: "security_update_required";
        STORAGE_FAILED: "storage_failed";
        TIMEOUT: "timeout";
        UNABLE_TO_PROCESS: "unable_to_process";
        UNKNOWN: "unknown";
        USER_CANCELED: "user_canceled";
        VENDOR: "vendor";
    } = ...

    Type declaration

    • ReadonlyCANCELED: "canceled"

      The operation was canceled because the biometric sensor is unavailable. This may happen when the user is switched, the device is locked, or another pending operation prevents it.

    • ReadonlyHARDWARE_NOT_PRESENT: "hardware_not_present"

      The device does not have the required authentication hardware.

    • ReadonlyHARDWARE_UNAVAILABLE: "hardware_unavailable"

      The hardware is unavailable. Try again later.

    • ReadonlyKEY_UNRECOVERABLE: "key_unrecoverable"

      Encryption key became unrecoverable because user enrolled new auth method.

    • ReadonlyLOCKOUT: "lockout"

      The operation was canceled because the API is locked out due to too many attempts. This occurs after 5 failed attempts, and lasts for 30 seconds.

    • ReadonlyLOCKOUT_PERMANENT: "lockout_permanent"

      The operation was canceled because LOCKOUT occurred too many times. Biometric authentication is disabled until the user unlocks with their device credential (i.e. PIN, pattern, or password).

    • ReadonlyNEGATIVE_BUTTON: "negative_button"

      The user pressed the negative button.

    • ReadonlyNO_BIOMETRICS: "no_biometrics"

      The user does not have any biometrics enrolled.

    • ReadonlyNO_DEVICE_CREDENTIAL: "no_device_credential"

      The device does not have pin, pattern, or password set up.

    • ReadonlyNO_SPACE: "no_space"

      The operation can't be completed because there is not enough device storage remaining.

    • ReadonlySECURITY_UPDATE_REQUIRED: "security_update_required"

      A security vulnerability has been discovered with one or more hardware sensors. The affected sensor(s) are unavailable until a security update has addressed the issue.

    • ReadonlySTORAGE_FAILED: "storage_failed"

      Underlying file storage failed.

    • ReadonlyTIMEOUT: "timeout"

      The current operation has been running too long and has timed out.

      This is intended to prevent programs from waiting for the biometric sensor indefinitely. The timeout is platform and sensor-specific, but is generally on the order of ~30 seconds.

    • ReadonlyUNABLE_TO_PROCESS: "unable_to_process"

      The sensor was unable to process the current image.

    • ReadonlyUNKNOWN: "unknown"

      Unknown error.

    • ReadonlyUSER_CANCELED: "user_canceled"

      The user canceled the operation by pressing "Back" button.

      Upon receiving this, applications should use alternate authentication, such as a password.

      The application should also provide the user a way of returning to biometric authentication, such as a button.

    • ReadonlyVENDOR: "vendor"

      The operation failed due to a vendor-specific error.

      This error code may be used by hardware vendors to extend this list to cover errors that don't fall under one of the other predefined categories. Vendors are responsible for providing the strings for these errors.

      These messages are typically reserved for internal operations such as enrollment but may be used to express any error that is not otherwise covered. In this case, applications are expected to show the error message, but they are advised not to rely on the message ID, since this may vary by vendor and device.