diff --git a/zh-cn/application-dev/reference/apis/js-apis-useriam-faceauth.md b/zh-cn/application-dev/reference/apis/js-apis-useriam-faceauth.md index e7b62b26edd06910929557ff5a97f3b78a869b23..a22163a78c646bedab2ff1ec36df7797f7562b42 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-useriam-faceauth.md +++ b/zh-cn/application-dev/reference/apis/js-apis-useriam-faceauth.md @@ -37,36 +37,38 @@ constructor() ```js import userIAM_faceAuth from '@ohos.userIAM.faceAuth'; - let faceAuthManager = new userIAM_faceAuth.FaceAuthManager() + let faceAuthManager = new userIAM_faceAuth.FaceAuthManager(); ``` ### setSurfaceId -setSurfaceId(surfaceId: string): ResultCode; +setSurfaceId(surfaceId: string): void; -设置录入流程中人脸预览界面 [XComponent](../arkui-ts/ts-basic-components-xcomponent.md#getxcomponentsurfaceid) 持有 Surface 的 ID, 返回值表示操作是否成功。 +设置录入流程中人脸预览界面 [XComponent](../arkui-ts/ts-basic-components-xcomponent.md#getxcomponentsurfaceid) 持有 Surface 的 ID。 **系统能力：** SystemCapability.UserIAM.UserAuth.FaceAuth +**需要权限：** ohos.permission.MANAGE_USER_IDM + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ---------------------------------- | ---- | -------------------------- | | surfaceId | string | 是 | [XComponent](../arkui-ts/ts-basic-components-xcomponent.md#getxcomponentsurfaceid) 持有 Surface 的 ID。 | -**返回值：** - -| 类型 | 说明 | -| ---------- | ------------------------------------------------------------ | -| [ResultCode](#resultcode) | 表示操作是否成功 | - **示例：** ```js - import userIAM_faceAuth from '@ohos.userIAM.faceAuth'; - - let faceAuthManager = new userIAM_faceAuth.FaceAuthManager() - faceAuthManager.setSurfaceId("0"); + import faceAuth from '@ohos.userIAM.faceAuth'; + + let surfaceId = "123456"; + let manager = new faceAuth.FaceAuthManager(); + try { + manager.setSurfaceId(surfaceId); + console.info("set surface id success"); + } catch (e) { + console.error("set surface id failed, error = " + e); + } ``` ## ResultCode @@ -77,5 +79,4 @@ setSurfaceId(surfaceId: string): ResultCode; | 名称 | 默认值 | 描述 | | ----------------------- | ------ | -------------------- | -| SUCCESS | 0 | 执行成功。 | -| FAIL | 1 | 执行失败。 | +| FAIL | 12700001 | 执行失败。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-useriam-userauth.md b/zh-cn/application-dev/reference/apis/js-apis-useriam-userauth.md index 97940a9d991bf61c0e01dc85d6e284092117d8e4..3f5904c8eca91a72e441ce4497ef5c3899776074 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-useriam-userauth.md +++ b/zh-cn/application-dev/reference/apis/js-apis-useriam-userauth.md @@ -14,6 +14,71 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth'; ## 完整示例 +```js +// API version 9 +import userIAM_userAuth from '@ohos.userIAM.userAuth'; + +export default { + getVersion() { + try { + let version = userIAM_userAuth.getVersion(); + console.info("auth version = " + version); + } catch (error) { + console.info("get version failed, error = " + error); + } + }, + + start() { + console.info("start auth"); + let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); + let authType = userIAM_userAuth.UserAuthType.FACE; + let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; + try { + let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); + auth.on("result", { + callback: (result: userIAM_userAuth.AuthResultInfo) => { + console.log("authV9 result " + result.result); + console.log("authV9 token " + result.token); + console.log("authV9 remainAttempts " + result.remainAttempts); + console.log("authV9 lockoutDuration " + result.lockoutDuration); + } + }); + auth.start(); + console.log("authV9 start success"); + } catch (error) { + console.log("authV9 error = " + error); + // do error + } + }, + + getAvailableStatus() { + console.info("start check auth support"); + try { + userIAM_userAuth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1); + console.info("current auth trust level is supported"); + } catch (error) { + console.info("current auth trust level is not supported, error = " + error); + } + }, + + cancel() { + console.info("start cancel auth"); + let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); + let authType = userIAM_userAuth.UserAuthType.FACE; + let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; + + try { + let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); + auth.start(); + auth.cancel(); + console.info("cancel auth success"); + } catch (error) { + console.info("cancel auth failed, error = " + error); + } + } +} +``` + ```js // API version 8 import userIAM_userAuth from '@ohos.userIAM.userAuth'; @@ -22,13 +87,13 @@ let auth = new userIAM_userAuth.UserAuth(); export default { getVersion() { console.info("start get version"); - let version = this.auth.getVersion(); + let version = auth.getVersion(); console.info("auth version = " + version); }, startAuth() { console.info("start auth"); - this.auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, { + auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, { onResult: (result, extraInfo) => { try { console.info("auth onResult result = " + result); @@ -108,15 +173,374 @@ export default { } ``` +## EventInfo9+ + +类型别名，用于表示认证事件信息的类型，取值可以为下表中的类型。 + +**系统能力**：SystemCapability.UserIAM.UserAuth.Core + +| 类型 | 说明 | +| --------- | ----------------------- | +| [AuthResultInfo](#authresultinfo9) | 认证结果信息 | +| [TipInfo](#tipinfo9) | 认证过程中的提示信息 | + +## AuthEvent9+ + +认证事件回调的对象。 + +### callback9+ + +callback: (result : EventInfo) => void + +表示在认证结束后返回结果信息或者在认证操作中返回提示信息。 + +**系统能力**：SystemCapability.UserIAM.UserAuth.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | -------------------------- | ---- | -------------------------------------------------------- | +| result | [EventInfo](#eventinfo9) | 是 | 返回的认证结果信息或提示信息。 | + +**示例：** + + ```js + import userIAM_userAuth from '@ohos.userIAM.userAuth'; + + let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); + let authType = userIAM_userAuth.UserAuthType.FACE; + let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; + try { + let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); + auth.on("result", { + callback: (result: userIAM_userAuth.AuthResultInfo) => { + console.log("authV9 result " + result.result); + console.log("authV9 token " + result.token); + console.log("authV9 remainAttempts " + result.remainAttempts); + console.log("authV9 lockoutDuration " + result.lockoutDuration); + } + }); + auth.start(); + console.log("authV9 start success"); + } catch (error) { + console.log("authV9 error = " + error); + // do error + } + ``` + +## AuthResultInfo9+ + +表示认证结果信息的对象。 + +**系统能力**：SystemCapability.UserIAM.UserAuth.Core + +| 名称 | 参数类型 | 必填 | 说明 | +| ------------ | ---------- | ---- | -------------------- | +| result | number | 是 | 认证结果。 | +| token | Uint8Array | 否 | 用户身份认证通过的凭证。 | +| remainAttempts | number | 否 | 剩余的认证操作次数。 | +| lockoutDuration | number | 否 | 认证操作的冻结时间。 | + +## TipInfo9+ + +表示认证过程中提示信息的对象。 + +**系统能力**：SystemCapability.UserIAM.UserAuth.Core + +| 名称 | 参数类型 | 必填 | 说明 | +| ------------ | ---------- | ---- | -------------------- | +| module | number | 否 | 认证结果。 | +| tip | number | 否 | 认证过程提示信息。 | + +## AuthEventKey9+ + +类型别名，表示认证事件的关键字，取值为表格内字符串。 + +| 取值 | 说明 | +| ---------- | ----------------------- | +| "result" | 取值为result时，事件回调返回认证的结果信息。 | +| "tip" | 取值为tip时，事件回调返回认证操作中的提示信息。 | + +## AuthInstance9+ + +执行用户认证的对象。 + +### on9+ + +on(name : AuthEventKey, callback : AuthEvent) : void + +表示开启对认证事件的监听。 + +**系统能力**：SystemCapability.UserIAM.UserAuth.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | -------------------------- | ---- | ------------------------- | +| name | AuthEventKey | 是 | 认证事件的关键字 | +| callback | AuthEvent | 是 | 认证事件的回调函数 | + +**示例：** + + ```js + import userIAM_userAuth from '@ohos.userIAM.userAuth'; + + let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); + let authType = userIAM_userAuth.UserAuthType.FACE; + let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; + try { + let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); + auth.on("result", { + callback: (result: userIAM_userAuth.AuthResultInfo) => { + console.log("authV9 result " + result.result); + console.log("authV9 token " + result.token); + console.log("authV9 remainAttempts " + result.remainAttempts); + console.log("authV9 lockoutDuration " + result.lockoutDuration); + } + }); + auth.start(); + console.log("authV9 start success"); + } catch (error) { + console.log("authV9 error = " + error); + // do error + } + ``` + +### off9+ + +off(name : AuthEventKey) : void + +表示关闭对认证事件的监听。 + +**系统能力**：SystemCapability.UserIAM.UserAuth.Core + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | -------------------------- | ---- | ------------------------- | +| name | AuthEventKey | 是 | 认证事件的关键字 | + +**示例：** + + ```js + import userIAM_userAuth from '@ohos.userIAM.userAuth'; + + let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); + let authType = userIAM_userAuth.UserAuthType.FACE; + let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; + + try { + let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); + auth.on("result", { + callback: (result: userIAM_userAuth.AuthResultInfo) => { + console.log("authV9 result " + result.result); + console.log("authV9 token " + result.token); + console.log("authV9 remainAttempts " + result.remainAttempts); + console.log("authV9 lockoutDuration " + result.lockoutDuration); + } + }); + console.log("turn on authentication event listening success"); + } catch (error) { + console.log("turn off authentication event listening failed " + error); + // do error + } + + try { + let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); + auth.off("result"); + console.info("turn off authentication event listening success"); + } catch (error) { + console.info("turn off authentication event listening failed, error = " + error); + } + ``` + +### start9+ + +start() : void + +表示开始认证。 + +**需要权限**：ohos.permission.ACCESS_BIOMETRIC + +**系统能力**：SystemCapability.UserIAM.UserAuth.Core + +**示例：** + + ```js + import userIAM_userAuth from '@ohos.userIAM.userAuth'; + + let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); + let authType = userIAM_userAuth.UserAuthType.FACE; + let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; + + try { + let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); + auth.start(); + console.info("authV9 start auth success"); + } catch (error) { + console.info("authV9 start auth failed, error = " + error); + } + ``` + +### cancel9+ + +cancel(): void + +表示取消认证。 + +**需要权限**：ohos.permission.ACCESS_BIOMETRIC + +**系统能力**：SystemCapability.UserIAM.UserAuth.Core + +**示例：** + + ```js + import userIAM_userAuth from '@ohos.userIAM.userAuth'; + + let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); + let authType = userIAM_userAuth.UserAuthType.FACE; + let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; + + try { + let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); + auth.start(); + auth.cancel(); + console.info("cancel auth success"); + } catch (error) { + console.info("cancel auth failed, error = " + error); + } + ``` + +## userIAM_userAuth.getAuthInstance9+ + +getAuthInstance(challenge : Uint8Array, authType : UserAuthType, authTrustLevel : AuthTrustLevel): AuthInstance + +获取AuthInstance对象，用于执行用户身份认证。 + +> **说明：** +> 每个AuthInstance只能用于发起一次认证，若需要再次发起认证需重新获取AuthInstance。 + +**系统能力**：SystemCapability.UserIAM.UserAuth.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ---------------------------------------- | ---- | ------------------------ | +| challenge | Uint8Array | 是 | 挑战值，最大长度为32字节，可以填null。 | +| authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前支持FACE。 | +| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 | + +**返回值：** + +| 类型 | 说明 | +| ----------------------------------------- | ------------ | +| [AuthInstance](#authinstance9) | 认证器对象。 | + +**示例：** + ```js + import userIAM_userAuth from '@ohos.userIAM.userAuth'; + + let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); + let authType = userIAM_userAuth.UserAuthType.FACE; + let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; + + try { + let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); + console.info("get auth instance success"); + } catch (error) { + console.info("get auth instance success failed, error = " + error); + } + ``` + +## userIAM_userAuth.getVersion9+ + +getVersion(): number + +获取认证器的版本信息。 + +**需要权限**：ohos.permission.ACCESS_BIOMETRIC + +**系统能力**：SystemCapability.UserIAM.UserAuth.Core + +**返回值：** + +| 类型 | 说明 | +| ------ | ---------------------- | +| number | 获取的认证器版本信息。 | + +**示例：** + + ```js + import userIAM_userAuth from '@ohos.userIAM.userAuth'; + + try { + let version = userIAM_userAuth.getVersion(); + console.info("auth version = " + version); + } catch (error) { + console.info("get version failed, error = " + error); + } + ``` + +## userIAM_userAuth.getAvailableStatus9+ + +getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): void + +表示检查指定的认证等级的认证能力是否可用。 + +**需要权限**：ohos.permission.ACCESS_BIOMETRIC + +**系统能力**：SystemCapability.UserIAM.UserAuth.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ---------------------------------- | ---- | -------------------------- | +| authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前只支持FACE。 | +| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证结果的信任等级。 | + +**示例：** + + ```js + import userIAM_userAuth from '@ohos.userIAM.userAuth'; + + try { + userIAM_userAuth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1); + console.info("current auth trust level is supported"); + } catch (error) { + console.info("current auth trust level is not supported, error = " + error); + } + ``` + + ## ResultCodeV99+ + +表示执行结果的枚举。 + +**系统能力**：SystemCapability.UserIAM.UserAuth.Core + +| 名称 | 默认值 | 描述 | +| ----------------------- | ------ | -------------------- | +| SUCCESS | 12500000 | 执行成功。 | +| FAIL | 12500001 | 执行失败。 | +| GENERAL_ERROR | 12500002 | 操作通用错误。 | +| CANCELED | 12500003 | 操作取消。 | +| TIMEOUT | 12500004 | 操作超时。 | +| TYPE_NOT_SUPPORT | 12500005 | 不支持的认证类型。 | +| TRUST_LEVEL_NOT_SUPPORT | 12500006 | 不支持的认证等级。 | +| BUSY | 12500007 | 忙碌状态。 | +| INVALID_PARAMETERS | 12500008 | 无效参数。 | +| LOCKED | 12500009 | 认证器已锁定。 | +| NOT_ENROLLED | 12500010 | 用户未录入认证信息。 | ## UserAuth8+ 认证器的对象。 -### constructor8+ +### constructor(deprecated) constructor() +> **说明：** +> 从 API version 9 开始废弃，请使用[getAuthInstance](#useriam_userauthgetauthinstance9)替代。 +
从 API version 8 开始支持。 + 表示获取的认证器对象。 **系统能力**：SystemCapability.UserIAM.UserAuth.Core @@ -135,10 +559,14 @@ constructor() let auth = new userIAM_userAuth.UserAuth(); ``` -### getVersion8+ +### getVersion(deprecated) getVersion() : number +> **说明：** +> 从 API version 9 开始废弃，请使用[getVersion](#useriam_userauthgetversion9)替代。 +
从 API version 8 开始支持。 + 表示获取的认证器版本信息。 **需要权限**：ohos.permission.ACCESS_BIOMETRIC @@ -161,10 +589,14 @@ getVersion() : number console.info("auth version = " + version); ``` -### getAvailableStatus8+ +### getAvailableStatus(deprecated) getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : number +> **说明：** +> 从 API version 9 开始废弃，请使用开始废弃，请使用[getAvailableStatus](#useriam_userauthgetavailablestatus9)替代。 +
从 API version 8 开始支持。 + 表示检查指定的认证等级的认证能力是否可用。 **需要权限**：ohos.permission.ACCESS_BIOMETRIC @@ -182,7 +614,7 @@ getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : n | 类型 | 说明 | | ------ | ------------------------------------------------------------ | -| number | 获取指定的认证等级的认证能力是否可用的检查结果，返回值参见[ResultCode](#resultcode8)。 | +| number | 获取指定的认证等级的认证能力是否可用的检查结果，返回值参见[ResultCode](#resultcodedeprecated)。 | **示例：** @@ -200,10 +632,14 @@ getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : n } ``` -### auth8+ +### auth(deprecated) auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array +> **说明：** +> 从 API version 9 开始废弃，建议使用[start](#start9)代替。 +
从 API version 8 开始支持。 + 表示执行用户认证，使用callback方式作为异步方法。 **需要权限**：ohos.permission.ACCESS_BIOMETRIC @@ -217,13 +653,13 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev | challenge | Uint8Array | 是 | 挑战值，可以填null。 | | authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前支持FACE。 | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 信任等级。 | -| callback | [IUserAuthCallback](#iuserauthcallback8) | 是 | 回调函数。 | +| callback | [IUserAuthCallback](#iuserauthcallbackdeprecated) | 是 | 回调函数。 | **返回值：** | 类型 | 说明 | | ---------- | ------------------------------------------------------------ | -| Uint8Array | ContextId，作为取消认证[cancelAuth](#cancelauth8)接口的入参。 | +| Uint8Array | ContextId，作为取消认证[cancelAuth](#cancelauthdeprecated)接口的入参。 | **示例：** @@ -248,10 +684,14 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev }); ``` -### cancelAuth8+ +### cancelAuth(deprecated) cancelAuth(contextID : Uint8Array) : number +> **说明：** +> 从 API version 9 开始废弃，建议使用[cancel](#cancel9)代替。 +
从 API version 8 开始支持。 + 表示通过contextID取消本次认证操作。 **需要权限**：ohos.permission.ACCESS_BIOMETRIC @@ -262,7 +702,7 @@ cancelAuth(contextID : Uint8Array) : number | 参数名 | 类型 | 必填 | 说明 | | --------- | ---------- | ---- | ------------------------------------------ | -| contextID | Uint8Array | 是 | 上下文ID信息，通过[auth](#auth8)接口获得。 | +| contextID | Uint8Array | 是 | 上下文ID信息，通过[auth](#authdeprecated)接口获得。 | **返回值：** @@ -286,14 +726,22 @@ cancelAuth(contextID : Uint8Array) : number } ``` -## IUserAuthCallback8+ +## IUserAuthCallback(deprecated) + +> **说明：** +> 从 API version 9 开始废弃，建议使用[AuthEvent](#authevent9)代替。 +
从 API version 8 开始支持。 认证过程中回调结果的对象。 -### onResult8+ +### onResult(deprecated) onResult: (result : number, extraInfo : AuthResult) => void +> **说明：** +> 从 API version 9 开始废弃，建议使用[callback](#callback9)代替。 +
从 API version 8 开始支持。 + 表示在认证操作中，获取认证结果。 **系统能力**：SystemCapability.UserIAM.UserAuth.Core @@ -302,8 +750,8 @@ onResult: (result : number, extraInfo : AuthResult) => void | 参数名 | 类型 | 必填 | 说明 | | --------- | -------------------------- | ---- | ------------------------------------------------------------ | -| result | number | 是 | 认证结果，参见[ResultCode](#resultcode8)。 | -| extraInfo | [AuthResult](#authresult8) | 是 | 扩展信息，不同情况下的具体信息，
如果身份验证通过，则在extrainfo中返回用户认证令牌，
如果身份验证失败，则在extrainfo中返回剩余的用户认证次数，
如果身份验证执行器被锁定，则在extrainfo中返回冻结时间。 | +| result | number | 是 | 认证结果，参见[ResultCode](#resultcodedeprecated)。 | +| extraInfo | [AuthResult](#authresultdeprecated) | 是 | 扩展信息，不同情况下的具体信息，
如果身份验证通过，则在extrainfo中返回用户认证令牌，
如果身份验证失败，则在extrainfo中返回剩余的用户认证次数，
如果身份验证执行器被锁定，则在extrainfo中返回冻结时间。 | **示例：** @@ -339,10 +787,14 @@ onResult: (result : number, extraInfo : AuthResult) => void }); ``` -### onAcquireInfo8+ +### onAcquireInfo(deprecated) onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void +> **说明：** +> 从 API version 9 开始废弃，建议使用[callback](#callback9)代替。 +
从 API version 8 开始支持。 + 表示在认证过程中，获取提示码信息，非必须实现。 **系统能力**：SystemCapability.UserIAM.UserAuth.Core @@ -388,7 +840,11 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void }); ``` -## AuthResult8+ +## AuthResult(deprecated) + +> **说明：** +> 从 API version 9 开始废弃，建议使用[AuthResultInfo](#authresultinfo9)代替。 +
从 API version 8 开始支持。 表示认证结果的对象。 @@ -400,7 +856,10 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void | remainTimes | number | 否 | 剩余的认证操作次数。 | | freezingTime | number | 否 | 认证操作的冻结时间。 | -## ResultCode8+ +## ResultCode(deprecated) + +> **说明：** +> 从 API version 9 开始废弃，建议使用[ResultCodeV9](#resultcodev99)代替。 表示执行结果的枚举。 @@ -487,7 +946,7 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void getAuthenticator(): Authenticator > **说明：** -> 从 API Version 8 开始废弃，建议使用[constructor](#constructor8)替代。 +> 从 API version 8 开始废弃，建议使用[constructor](#constructordeprecated)替代。 获取Authenticator对象，用于执行用户身份认证。 @@ -507,7 +966,7 @@ getAuthenticator(): Authenticator ## Authenticator(deprecated) > **说明：** -> 从 API Version 8 开始废弃，建议使用[UserAuth](#userauth8)替代。 +> 从 API version 8 开始废弃，建议使用[UserAuth](#userauth8)替代。 认证器对象。 @@ -517,7 +976,7 @@ getAuthenticator(): Authenticator execute(type: AuthType, level: SecureLevel, callback: AsyncCallback<number>): void > **说明：** -> 从 API Version 8 开始废弃，建议使用[auth](#auth8)替代。 +> 从 API version 8 开始废弃，建议使用[auth](#authdeprecated)替代。 执行用户认证，使用callback方式作为异步方法。 @@ -557,7 +1016,7 @@ execute(type: AuthType, level: SecureLevel, callback: AsyncCallback<number> execute(type:AuthType, level:SecureLevel): Promise<number> > **说明：** -> 从 API Version 8 开始废弃，建议使用[auth](#auth8)替代。 +> 从 API version 8 开始废弃，建议使用[auth](#authdeprecated)替代。 执行用户认证，使用promise方式作为异步方法。 @@ -592,7 +1051,7 @@ execute(type:AuthType, level:SecureLevel): Promise<number> ## AuthenticationResult(deprecated) > **说明：** -> 从 API Version 8 开始废弃，建议使用[ResultCode](#resultcode8)替代。 +> 从 API version 8 开始废弃，建议使用[ResultCode](#resultcodedeprecated)替代。 表示认证结果的枚举。 @@ -610,4 +1069,4 @@ execute(type:AuthType, level:SecureLevel): Promise<number> | INVALID_PARAMETERS | 6 | 认证参数无效。 | | LOCKED | 7 | 认证失败次数过多，已锁定。 | | NOT_ENROLLED | 8 | 未录入认证凭据。 | -| GENERAL_ERROR | 100 | 其他错误。 | \ No newline at end of file +| GENERAL_ERROR | 100 | 其他错误。 |