• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 查询用户注册凭据的状态
2
3调用者需感知用户注册凭据(人脸、指纹、口令)的变化,可以通过该接口查询当前用户注册凭据的状态。
4
5## 接口说明
6
7具体参数、返回值、错误码等描述,请参考对应的[API文档](../../reference/apis-user-authentication-kit/js-apis-useriam-userauth.md#userauthgetenrolledstate12)。
8
9| 接口名称 | 功能描述 |
10| -------- | -------- |
11| getEnrolledState(authType : UserAuthType): EnrolledState | 根据指定的认证类型,查询用户注册凭据的状态,用于感知注册凭据变化。 |
12
13## 开发步骤
14
151. [申请权限](prerequisites.md#申请权限):ohos.permission.ACCESS_BIOMETRIC16
172. 指定认证类型([UserAuthType](../../reference/apis-user-authentication-kit/js-apis-useriam-userauth.md#userauthtype8)),调用[getEnrolledState](../../reference/apis-user-authentication-kit/js-apis-useriam-userauth.md#userauthgetenrolledstate12)接口查询用户注册凭据的状态。
18
19以查询用户人脸注册凭据的状态为例:
20
21```ts
22import { BusinessError } from  '@kit.BasicServicesKit';
23import { userAuth } from '@kit.UserAuthenticationKit';
24
25try {
26  let enrolledState = userAuth.getEnrolledState(userAuth.UserAuthType.FACE);
27  console.info(`get current enrolled state success, enrolledState: ${JSON.stringify(enrolledState)}`);
28} catch (error) {
29  const err: BusinessError = error as BusinessError;
30  console.error(`get current enrolled state failed, Code is ${err?.code}, message is ${err?.message}`);
31}
32```
33