未验证 提交 eef05e4f 编写于 作者: O openharmony_ci 提交者: Gitee

!8646 添加人脸认证 api 接口说明

Merge pull request !8646 from shipengtao9579/addFaceDoc
......@@ -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)
- 数据管理
......
# 人脸认证
提供人脸录入相关接口。
> **说明:**
>
> 本模块首批接口从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 | 执行失败。 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册