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

!9751 [docs]与JS接口同步修改remainTimes, freezingTime, onAcquireInfo, acquire命名

Merge pull request !9751 from Tianshi Liu/master
......@@ -94,7 +94,7 @@ The Face_auth driver provides basic facial authentication capabilities for the U
| API | Description |
| ------------------------------------------------------------ | ------------------------ |
| IExecutorCallback::OnResult(int32_t code, const std::vector<uint8_t>& extraInfo) | Called to return the operation result. |
| IExecutorCallback::OnAcquireInfo(int32_t code, const std::vector<uint8_t>& extraInfo) | Called to return the interaction information about the operation process.|
| IExecutorCallback::OnTip(int32_t code, const std::vector<uint8_t>& extraInfo) | Called to return the interaction information about the operation process.|
### How to Develop
......
......@@ -108,7 +108,7 @@ The fingerprint_auth driver provides stable basic fingerprint authentication cap
| API | Description |
| ------------------------------------------------------------ | ------------------------ |
| IExecutorCallback::OnResult(int32_t code, const std::vector<uint8_t>& extraInfo) | Called to return the operation result. |
| IExecutorCallback::OnAcquireInfo(int32_t code, const std::vector<uint8_t>& extraInfo) | Called to return the interaction information about the operation process.|
| IExecutorCallback::OnTip(int32_t code, const std::vector<uint8_t>& extraInfo) | Called to return the interaction information about the operation process.|
### How to Develop
......
......@@ -342,8 +342,8 @@ The development procedure is as follows:
}
info.executorType = EXECUTOR_TYPE;
info.remainTimes = infoRet.remainTimes;
info.freezingTime = infoRet.freezingTime;
info.remainAttempts = infoRet.remainTimes;
info.lockoutDuration = infoRet.freezingTime;
return HDF_SUCCESS;
}
......
......@@ -94,7 +94,7 @@ Face_auth驱动的主要工作是为上层用户认证框架和Face_auth服务
| 接口名 | 功能介绍 |
| ------------------------------------------------------------ | ------------------------ |
| IExecutorCallback::OnResult(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的最终结果。 |
| IExecutorCallback::OnAcquireInfo(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的过程交互信息。 |
| IExecutorCallback::OnTip(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的过程交互信息。 |
### 开发步骤
......
......@@ -104,7 +104,7 @@ Fingerprint_auth驱动的主要工作是为上层用户认证框架和Fingerprin
| 接口名 | 功能介绍 |
| ------------------------------------------------------------ | ------------------------ |
| IExecutorCallback::OnResult(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的最终结果。 |
| IExecutorCallback::OnAcquireInfo(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的过程交互信息。 |
| IExecutorCallback::OnTip(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的过程交互信息。 |
### 开发步骤
......
......@@ -340,8 +340,8 @@ Pin_auth驱动的主要工作是为上层用户认证框架和Pin_auth服务提
}
info.executorType = EXECUTOR_TYPE;
info.remainTimes = infoRet.remainTimes;
info.freezingTime = infoRet.freezingTime;
info.remainAttempts = infoRet.remainTimes;
info.lockoutDuration = infoRet.freezingTime;
return HDF_SUCCESS;
}
......
......@@ -16,8 +16,8 @@
| Public&nbsp;属性 | 描述 |
| -------- | -------- |
| [result](#result) | 用户身份认证结果。 |
| [freezingTime](#freezingtime) | 认证方式被冻结的时间。 |
| [remainTimes](#remaintimes) | 认证方式距离被冻结的可处理认证请求次数。 |
| [lockoutDuration](#lockoutduration) | 认证方式被冻结的时间。 |
| [remainAttempts](#remainattempts) | 认证方式距离被冻结的可处理认证请求次数。 |
| [msgs](#msgs) | 执行器发送的消息。 |
| [token](#token) | 用户身份认证令牌。 |
| rootSecret | 保护文件加密密钥的密钥。 |
......@@ -39,11 +39,11 @@
## **类成员变量说明**
### freezingTime
### lockoutDuration
```
int AuthResultInfo::freezingTime
int AuthResultInfo::lockoutDuration
```
**描述:**
......@@ -63,11 +63,11 @@ struct ExecutorSendMsg [] AuthResultInfo::msgs
执行器发送的消息。
### remainTimes
### remainAttempts
```
int AuthResultInfo::remainTimes
int AuthResultInfo::remainAttempts
```
**描述:**
......
......@@ -16,8 +16,8 @@
| Public&nbsp;属性 | 描述 |
| -------- | -------- |
| [executorType](#executortype) | 执行器类型,根据执行器支持的算法类型进行分类。 |
| [freezingTime](#freezingtime) | 认证方式被冻结的时间。 |
| [remainTimes](#remaintimes) | 认证方式距离被冻结的可处理认证请求次数。 |
| [lockoutDuration](#lockoutduration) | 认证方式被冻结的时间。 |
| [remainAttempts](#remainattempts) | 认证方式距离被冻结的可处理认证请求次数。 |
| [extraInfo](#extrainfo) | 其他相关信息,用于支持信息扩展。 |
......@@ -61,11 +61,11 @@ unsigned char [] TemplateInfo::extraInfo
其他相关信息,用于支持信息扩展。
### freezingTime
### lockoutDuration
```
int TemplateInfo::freezingTime
int TemplateInfo::lockoutDuration
```
**描述:**
......@@ -73,11 +73,11 @@ int TemplateInfo::freezingTime
认证方式被冻结的时间。
### remainTimes
### remainAttempts
```
int TemplateInfo::remainTimes
int TemplateInfo::remainAttempts
```
**描述:**
......
......@@ -16,7 +16,7 @@
| Public&nbsp;成员函数 | 描述 |
| -------- | -------- |
| [OnResult](#onresult)&nbsp;([in]&nbsp;int&nbsp;result,&nbsp;[in]&nbsp;unsigned&nbsp;char[]&nbsp;extraInfo) | 定义操作结果回调函数。&nbsp;[更多...](#onresult) |
| [OnAcquireInfo](#onacquireinfo)&nbsp;([in]&nbsp;int&nbsp;acquire,&nbsp;[in]&nbsp;unsigned&nbsp;char[]&nbsp;extraInfo) | 定义操作过程信息反馈回调函数。&nbsp;[更多...](#onacquireinfo) |
| [OnTip](#ontip)&nbsp;([in]&nbsp;int&nbsp;acquire,&nbsp;[in]&nbsp;unsigned&nbsp;char[]&nbsp;extraInfo) | 定义操作过程信息反馈回调函数。&nbsp;[更多...](#ontip) |
## **详细描述**
......@@ -35,11 +35,11 @@
## **成员函数说明**
### OnAcquireInfo()
### OnTip()
```
IExecutorCallback::OnAcquireInfo ([in] int acquire, [in] unsigned char[] extraInfo )
IExecutorCallback::OnTip ([in] int tip, [in] unsigned char[] extraInfo )
```
**描述:**
......@@ -50,7 +50,7 @@ IExecutorCallback::OnAcquireInfo ([in] int acquire, [in] unsigned char[] extraIn
| 名称 | 描述 |
| -------- | -------- |
| acquire | 提示信息编码[FaceTipsCode](_hdf_face_auth.md#facetipscode)。 |
| tip | 提示信息编码[FaceTipsCode](_hdf_face_auth.md#facetipscode)。 |
| extraInfo | 其他相关信息,用于支持信息扩展。 |
**返回:**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册