diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index 3eaaa5ce7a6afe557caa9b7a1eb0e291d4e34e7e..e50472864b141c4b9b17de3d7b9c49578228a443 100755 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -137,6 +137,7 @@ - [@ohos.privacyManager (隐私管理)](js-apis-privacyManager.md) - [@ohos.security.huks (通用密钥库系统)](js-apis-huks.md) - [@ohos.userIAM.userAuth (用户认证)](js-apis-useriam-userauth.md) + - [@ohos.userIAM.faceAuth (人脸认证)](js-apis-useriam-faceauth.md) - [@system.cipher (加密算法)](js-apis-system-cipher.md) - 数据管理 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 new file mode 100644 index 0000000000000000000000000000000000000000..81efc6156f5bcbd0193f7f532564e503be957e0a --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-useriam-faceauth.md @@ -0,0 +1,81 @@ +# 人脸认证 + +提供人脸录入相关接口。 + +> **说明:** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 +> +> 本模块接口为系统接口。 + +## 导入模块 + +```js +import userIAM_faceAuth from '@ohos.userIAM.faceAuth'; +``` + +## FaceAuthManager + +人脸认证管理器对象。 + +### constructor + +constructor() + +表示获取人脸认证管理器对象。 + +**系统能力:** SystemCapability.UserIAM.UserAuth.FaceAuth + +**返回值:** + +| 类型 | 说明 | +| ---------------------- | -------------------- | +| [FaceAuthManager](#faceauthmanager) | 人脸认证管理器对象 | + +**示例:** + + ```js + import userIAM_faceAuth from '@ohos.userIAM.faceAuth'; + + let faceAuthManager = new userIAM_faceAuth.FaceAuthManager() + ``` + +### setSurfaceId + +setSurfaceId(surfaceId: string): ResultCode; + +设置录入流程中人脸预览界面 [XComponent](../arkui-ts/ts-basic-components-xcomponent.md#getxcomponentsurfaceid) 持有 Surface 的 ID, 返回值表示操作是否成功。 + +**系统能力:** SystemCapability.UserIAM.UserAuth.FaceAuth + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ---------------------------------- | ---- | -------------------------- | +| 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(surfaceIdString); + ``` + +## ResultCode + + 表示执行结果的枚举。 + + **系统能力:** SystemCapability.UserIAM.UserAuth.FaceAuth + +| 名称 | 默认值 | 描述 | +| ----------------------- | ------ | -------------------- | +| SUCCESS | 0 | 执行成功。 | +| FAIL | 1 | 执行失败。 |