Android平台6.0及以上系统支持,仅适配Google官方指纹识别的标准接口的设备。
方法:
对象:
回调方法:
权限:
5+功能模块(permissions)
isSupport
当前设备环境是否支持指纹识别
说明:
目前还有很多设备没有指纹识别模块,需要调用此方法判断是否可使用指纹识别功能。
参数:
无
返回值:
Boolean : 设备支持指纹识别则返回true,否则返回false。
示例:
uni-app使用plus注意事项
isKeyguardSecure
当前设备是否设置密码锁屏
说明:
如果设备没有设置密码锁屏,则无法使用指纹识别功能,建议调用指纹识别前先使用此接口检查。 调用plus.fingerprint.authenticate会返回失败。
参数:
无
返回值:
Boolean : 设备已设置密码锁屏则返回true,否则返回false。
平台支持:
示例:
uni-app使用plus注意事项
isEnrolledFingerprints
当前设备是否已经录入指纹
说明:
如果设备没有录入指纹,则无法使用指纹识别功能,建议调用指纹识别前先使用此接口检查。 调用plus.fingerprint.authenticate会返回失败。
参数:
无
返回值:
Boolean : 设备已经录入指纹则返回true,否则返回false。
示例:
uni-app使用plus注意事项
authenticate
指纹识别认证
说明:
用户可以开始输入指纹进行识别,如果认证成功则触发successCB回调,识别失败则触发errorCB回调返回错误信息。
参数:
返回值:
void : 无
平台支持:
示例:
uni-app使用plus注意事项
cancel
取消指纹识别认证
说明:
取消当前正在处理的指纹识别认证操作。 如果当前没有进行指纹识别则不进行任何操作;如果当前正在进行指纹识别则触发错误回调(错误码为“CANCEL”)。
参数:
无
返回值:
void : 无
示例:
uni-app使用plus注意事项
AuthenticateOptions
JSON对象,指纹识别认证参数
说明:
用于设置指纹识别认证界面显示的提示信息等。
属性:
FingerprintError
JSON对象,指纹识别错误信息
常量:
- UNSUPPORT: (Number 类型 )不支持指纹识别
当前设备不支持指纹识别功能时返回此错误,错误代码常量值为1。
- KEYGUARD_INSECURE: (Number 类型 )设备未设置密码锁屏
当前设备为设置密码锁屏导致无法使用指纹识别功能时返回此错误,错误代码常量值为2。
- FINGERPRINT_UNENROLLED: (Number 类型 )未录入指纹识别
当前设备未录入指纹导致无法使用指纹识别功能时返回此错误,错误代码常量值为3。
- AUTHENTICATE_MISMATCH: (Number 类型 )指纹识别不匹配
用户指纹识别认证不通过时返回此错误,错误代码常量值为4。 用户每次尝试指纹识别认证未通过都会触发此错误,此时还可以继续识别认证。
- AUTHENTICATE_OVERLIMIT: (Number 类型 )指纹识别次数超过限制
用户多次指纹识别认证不通过时返回此错误,错误代码常量值为5。 通常出现此错误后系统会锁定一段时间禁止使用指纹识别,如果再次调用指纹识别认证会立即返回此错误,因此出现此错误时应该提示用户使用其它方式进行认证。
- CANCEL: (Number 类型 )取消指纹识别
用户取消指纹识别认证时返回此错误,错误代码常量值为6。
- UNKNOWN_ERROR: (Number 类型 )未知错误
其它未知错误,错误代码常量值为7。
属性:
FingerprintSuccessCallback
指纹识别认证成功回调函数
参数:
无
返回值:
void : 无
示例:
uni-app使用plus注意事项
FingerprintErrorCallback
指纹识别认证失败的回调函数
参数:
返回值:
void : 无
示例: