输入关键字搜索
开发者能力认证
鸿蒙高校创新赛
HarmonyOS 7
animation
HarmonyOS行业解决方案
layoutWeight
HarmonyOS模板&组件
bindPopup
bindsheet
CTRL+K
文档管理中心

HMS Core

HMS Core 4.0
输入关键字搜索
开发者能力认证
鸿蒙高校创新赛
HarmonyOS 7
animation
HarmonyOS行业解决方案
layoutWeight
HarmonyOS模板&组件
bindPopup
bindsheet
CTRL+K
API参考

此版本文档已归档不再维护，推荐您使用最新版本。

API参考线上快速身份验证服务BioAuthnFingerprintManager

FingerprintManager

更新时间: 2020-04-21 08:56
CLASS info
public class FingerprintManager extends java.lang.Object
FIDO BioAuthn 指纹认证API的主入口。

Constant Summary

TypeNameDesc
intFINGERPRINT_ACQUIRED_GOOD获得的指纹图像很好。
intFINGERPRINT_ACQUIRED_PARTIAL仅检测到部分指纹图像。
intFINGERPRINT_ACQUIRED_INSUFFICIENT由于检测到状况，指纹图像太嘈杂而无法处理。
intFINGERPRINT_ACQUIRED_IMAGER_DIRTY由于怀疑或检测到传感器上的污垢，指纹图像太嘈杂。
intFINGERPRINT_ACQUIRED_TOO_SLOW指纹图像由于缺乏运动而无法读取。
intFINGERPRINT_ACQUIRED_TOO_FAST由于快速运动，指纹图像不完整。
intFINGERPRINT_ACQUIRED_VENDOR: 1038检测到指纹。
intFINGERPRINT_ACQUIRED_VENDOR: 1012指纹不适配，中间状态。
intFINGERPRINT_SUCCESS未检测到错误。
intFINGERPRINT_ERROR_HW_UNAVAILABLE硬件不可用。
intFINGERPRINT_ERROR_UNABLE_TO_PROCESS当传感器无法处理当前指纹图像时返回错误状态。
intFINGERPRINT_ERROR_TIMEOUT当前请求运行太久时返回错误状态。
intFINGERPRINT_ERROR_NO_SPACE没有足够的存储空间来完成操作。
intFINGERPRINT_ERROR_CANCELED由于指纹认证传感器不可用，操作被取消。
intFINGERPRINT_ERROR_LOCKOUT由于尝试次数太多，API被锁定，操作被取消。
intFINGERPRINT_ERROR_VENDOR厂商自定义错误。
intFINGERPRINT_ERROR_LOCKOUT_PERMANENT因为错误锁定发生的次数太多，操作被取消。
intFINGERPRINT_ERROR_USER_CANCELED用户取消了操作。
intFINGERPRINT_ERROR_NO_FINGERPRINTS用户没有注册任何指纹。
intFINGERPRINT_ERROR_HW_NOT_PRESENT没有指纹认证硬件。
intFINGERPRINT_ERROR_SYS_INTEGRITY_FAILED系统完整性检查失败。
intFINGERPRINT_ERROR_CRYPTO_VERIFY_FAILED使用密钥加密验证认证结果失败。
intFINGERPRINT_ERROR_HMS_FRAMEWORK_ERRORHMS Core框架错误。
intFINGERPRINT_ERROR_UNSUPPORTED_OS_VER操作系统版本不支持指纹认证。

Public Constructor Summary

Method name

FingerprintManager(android.app.Activity activity, java.util.concurrent.Executor executor, BioAuthnCallback callback)

构造一个用户可用于指纹认证的FingerprintManager对象，这个对象用于调用 FIDO BioAuthn指纹认证API。

FingerprintManager(android.app.Fragment fragment, java.util.concurrent.Executor executor, BioAuthnCallback callback)

构造一个用户可用于指纹认证的FingerprintManager对象，这个对象用于调用 FIDO BioAuthn指纹认证API。

Public Method Summary

Return typeMethod name
int

canAuth()

确定是否可以使用指纹认证。

void

auth(final CryptoObject crypto)

指纹认证的方法。此方法关联一个秘钥或公私钥对，当指纹认证通过后才能使用关联的秘钥或公私钥对。

void

auth()

指纹认证的方法。

void

cancelAuth()

取消指纹认证。

Constants

Constant
public static final int FINGERPRINT_ACQUIRED_GOOD

值: 0 

获得的指纹图像很好。

Constant
public static final int FINGERPRINT_ACQUIRED_PARTIAL

值: 1 

仅检测到部分指纹图像。在注册过程中，应告知用户解决该问题需要采取的措施，例如“用力按传感器。”

Constant
public static final int FINGERPRINT_ACQUIRED_INSUFFICIENT

值: 2 

由于检测到状况（即皮肤干燥）或传感器可能脏污，指纹图像太嘈杂而无法处理（请参阅FINGERPRINT_ACQUIRED_IMAGER_DIRTY）。

Constant
public static final int FINGERPRINT_ACQUIRED_IMAGER_DIRTY

值: 3 

由于怀疑或检测到传感器上的污垢，指纹图像太嘈杂。例如，在多次FINGERPRINT_ACQUIRED_INSUFFICIENT或传感器上实际检测到污垢（卡住的像素，条幅等）之后，可以合理地返回此值。退回传感器时，应要求用户采取措施清洁传感器。

Constant
public static final int FINGERPRINT_ACQUIRED_TOO_SLOW

值: 4

指纹图像由于缺乏运动而无法读取。这最适合需要滑动的线性阵列传感器。

Constant
public static final int FINGERPRINT_ACQUIRED_TOO_FAST

值: 5

由于快速运动，指纹图像不完整。虽然最适合于线性阵列传感器，但是如果在采集过程中移动了手指，也会发生这种情况。应该要求用户将手指放慢（线性）移动或将手指放在传感器上的时间更长。

Constant
public static final int FACE_ACQUIRED_VENDOR:1038

调用auth接口时通过回调对象BioAuthnCallback的onAuthHelp方法的helpCode参数返回值: 1038

检测到指纹。

Constant
public static final int FACE_ACQUIRED_VENDOR:1012

调用auth接口时通过回调对象BioAuthnCallback的onAuthHelp方法的helpCode参数返回值: 1012    

指纹不匹配。

Constant
public static final int FINGERPRINT_SUCCESS

值: 0

如果当前可以使用指纹（已注册且可用）。

Constant
public static final int FINGERPRINT_ERROR_HW_UNAVAILABLE

值: 1

硬件不可用。

Constant
public static final int FINGERPRINT_ERROR_UNABLE_TO_PROCESS

调用auth接口时通过回调对象BioAuthnCallback的onAuthError方法的errorCode参数返回值: 2

当传感器无法处理当前指纹图像时返回错误状态。

Constant
public static final int FINGERPRINT_ERROR_TIMEOUT

调用auth接口时通过回调对象BioAuthnCallback的onAuthError方法的errorCode参数返回值: 3

当前请求运行太久时返回错误状态。这是为了防止程序无限期地等待指纹传感器。超时是特定于平台和传感器的，但通常为30秒。

Constant
public static final int FINGERPRINT_ERROR_NO_SPACE

调用auth接口时通过回调对象BioAuthnCallback的onAuthError方法的errorCode参数返回值: 4

为注册等操作返回错误状态；操作无法完成，因为没有足够的存储空间来完成该操作。

Constant
public static final int FINGERPRINT_ERROR_CANCELED

调用auth接口时通过回调对象BioAuthnCallback的onAuthError方法的errorCode参数返回值: 5

由于指纹认证传感器不可用，操作被取消。

Constant
public static final int FINGERPRINT_ERROR_LOCKOUT

调用auth接口时通过回调对象BioAuthnCallback的onAuthError方法的errorCode参数返回值: 7

由于尝试次数太多，API被锁定，操作被取消。这发生在5次失败的尝试之后，持续30秒。

Constant
public static final int ERROR_VENDOR

调用auth接口时通过回调对象BioAuthnCallback的onAuthError方法的errorCode参数返回值: 8

厂商自定义错误。

Constant
public static final int FINGERPRINT_ERROR_LOCKOUT_PERMANENT

调用auth接口时通过回调对象BioAuthnCallback的onAuthError方法的errorCode参数返回值: 9

操作被取消，因为错误锁定发生的次数太多。在用户使用强认证（PIN/Pattern/Password）解锁之前，指纹认证将被禁用。

Constant
public static final int FINGERPRINT_ERROR_USER_CANCELED

调用auth接口时通过回调对象BioAuthnCallback的onAuthError方法的errorCode参数返回值: 10

用户取消了操作。收到此消息后，应用程序应使用备用认证（例如密码）。应用程序还应提供返回指纹认证的方法，如“使用”按钮。

Constant
public static final int FINGERPRINT_ERROR_NO_FINGERPRINTS

值: 11

用户没有注册任何指纹。

Constant
public static final int FINGERPRINT_ERROR_NO_HARDWARE

canAuth接口返回值: 12

没有指纹认证硬件。

Constant
public static final int FINGERPRINT_ERROR_SYS_INTEGRITY_FAILED

调用auth接口时通过回调对象BioAuthnCallback的onAuthError方法的errorCode参数返回值: 1001

系统完整性检查失败，比如设备已root，或系统被破坏。

Constant
public static final int FINGERPRINT_ERROR_CRYPTO_VERIFY_FAILED

调用auth接口时通过回调对象BioAuthnCallback的onAuthError方法的errorCode参数返回值: 1002

使用密钥加密验证认证结果失败。

Constant
public static final int FINGERPRINT_ERROR_HMS_FRAMEWORK_ERROR

调用auth接口时通过回调对象BioAuthnCallback的onAuthError方法的errorCode参数返回值: 1003

华为移动服务框架错误。

Constant
public static final int FINGERPRINT_ERROR_UNSUPPORTED_OS_VER

调用auth接口时通过回调对象BioAuthnCallback的onAuthError方法的errorCode参数返回值: 1004

操作系统版本不支持指纹认证。支持FIDO BioAuthn指纹认证的设备需满足 Android 版本 >=6.0。

Public Constructors

Method
public FingerprintManager(android.app.FragmentActivity activity, java.util.concurrent.Executor executor, BioAuthnCallback callback)

Parameters

Parameter nameParameter desc
activity安卓应用的Activity，对客户端的activity的引用。
executor处理回调事件的执行器。
callback用于处理认证事件的回调对象。
Method
public FingerprintManager(android.app.Fragment fragment, java.util.concurrent.Executor executor, BioAuthnCallback callback)

Parameters

Parameter nameParameter desc
fragment安卓应用的 Fragment，对客户端的fragment的引用。
executor处理回调事件的执行器。
callback用于处理认证事件的回调对象。

Public Methods

Method
public int canAuth()
确定是否可以使用指纹认证。

Return

typedesc
int

FINGERPRINT_SUCCESS

如果当前可以使用指纹认证（已注册且可用）。

FINGERPRINT_ERROR_HW_UNAVAILABLE 

如果硬件不可用。

FINGERPRINT_ERROR_NO_FINGERPRINTS 

如果用户没有注册任何指纹。

FINGERPRINT_ERROR_NO_HARDWARE 

如果没有指纹认证硬件。

FINGERPRINT_ERROR_UNSUPPORTED_OS_VER     

操作系统版本不支持指纹认证。

Method
public void auth(final CryptoObject crypto)
指纹认证的方法。此方法关联一个秘钥或公私钥对，当指纹认证通过后才能使用关联的秘钥或公私钥对。

Parameters

Parameter nameParameter desc
crypto与指纹认证关联的加密对象。
Method
public void auth()
指纹认证的方法。
Method
public void cancelAuth()
取消展示指纹认证提示窗口。
Overview
BioAuthnCallback
本页面可能包含由第三方许可的内容，请参考具体描述。
简体中文
华为开发者联盟 版权所有 ©2026
问题反馈
使用条款
华为开发者联盟用户协议
关于华为开发者联盟与隐私的声明
Cookies
开源软件声明
在 API参考 中进行搜索
请输入您想要搜索的关键词