fingerprint
Fingerprint模块管理指纹识别。
方法:
- isSupport: 当前设备环境是否支持指纹识别
- isKeyguardSecure: 当前设备是否设置密码锁屏
- isEnrolledFingerprints: 当前设备是否已经录入指纹
- authenticate: 指纹识别认证
- cancel: 取消指纹识别认证
对象:
- AuthenticateOptions: JSON对象,指纹识别认证参数
- FingerprintError: JSON对象,指纹识别错误信息
回调方法:
- FingerprintSuccessCallback: 指纹识别认证成功回调函数
- FingerprintErrorCallback: 指纹识别认证失败的回调函数
权限:
5+功能模块(permissions)
{
// ...
"permissions":{
// ...
"Fingerprint": {
"description": "指纹识别"
}
}
}
AuthenticateOptions
JSON对象,指纹识别认证参数
interface AuthenticateOptions {
readonly attribute String message;
}
说明:
用于设置指纹识别认证界面显示的提示信息等。
属性:
- message: (String
类型
)在指纹识别过程中显示在界面上的提示信息
如果指纹识别认证过程中不显示提示框,则不显示此信息。
FingerprintError
JSON对象,指纹识别错误信息
interface FingerprintError {
const Number UNSUPPORT = 1;
const Number KEYGUARD_INSECURE = 2;
const Number FINGERPRINT_UNENROLLED = 3;
const Number AUTHENTICATE_MISMATCH = 4;
const Number AUTHENTICATE_OVERLIMIT = 5;
const Number CANCEL = 6;
const Number UNKNOWN_ERROR = 7;
readonly attribute Number code;
readonly attribute String message;
}
属性:
- code: (Number
类型
)错误代码
取值范围为FingerprintError对象的错误常量值。
- message: (String
类型
)错误描述信息
详细错误描述信息。
FingerprintSuccessCallback
指纹识别认证成功回调函数
void onSuccess() {
// Authenticate success code.
}
参数:
无
返回值:
void : 无FingerprintErrorCallback
指纹识别认证失败的回调函数
function void onError(FingerprintError error) {
// Handle error
var code = error.code; // 错误编码
var message = error.message; // 错误描述信息
}
参数:
- error:
(
FingerprintError
)
必选 获取加速度操作的错误信息
可通过error.code(Number类型)获取错误编码; 可通过error.message(String类型)获取错误描述信息。