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

!2219 一致性问题修复

Merge pull request !2219 from zengyawen/master
...@@ -89,7 +89,7 @@ bytrace.finishTrace("myTestFunc", 1); ...@@ -89,7 +89,7 @@ bytrace.finishTrace("myTestFunc", 1);
## bytrace.traceByValue ## bytrace.traceByValue
traceByValue(name: string, value: number): void traceByValue(name: string, count: number): void
用来标记一个预追踪的数值变量,该变量的数值会不断变化。 用来标记一个预追踪的数值变量,该变量的数值会不断变化。
...@@ -99,7 +99,7 @@ traceByValue(name: string, value: number): void ...@@ -99,7 +99,7 @@ traceByValue(name: string, value: number): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| name | string | 是 | 要追踪的数值变量名称 | | name | string | 是 | 要追踪的数值变量名称 |
| value | number | 是 | 变量的值 | | count | number | 是 | 变量的值 |
**示例:** **示例:**
......
...@@ -10,12 +10,11 @@ ...@@ -10,12 +10,11 @@
import process from '@ohos.process'; import process from '@ohos.process';
``` ```
## 系统能力
SystemCapability.Utils.Lang
## 属性 ## 属性
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Utils.Lang。
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| egid | number | 是 | 否 | 进程的有效组标识。 | | egid | number | 是 | 否 | 进程的有效组标识。 |
...@@ -35,6 +34,8 @@ SystemCapability.Utils.Lang ...@@ -35,6 +34,8 @@ SystemCapability.Utils.Lang
### 属性 ### 属性
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Utils.Lang。
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| pid | number | 是 | 否 | 子进程的pid。 | | pid | number | 是 | 否 | 子进程的pid。 |
...@@ -49,6 +50,8 @@ wait(): Promise<number> ...@@ -49,6 +50,8 @@ wait(): Promise<number>
等待子进程运行结束,返回promise对象,其值为子进程的退出码。 等待子进程运行结束,返回promise对象,其值为子进程的退出码。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -72,6 +75,8 @@ getOutput(): Promise<Uint8Array> ...@@ -72,6 +75,8 @@ getOutput(): Promise<Uint8Array>
获取子进程的标准输出。 获取子进程的标准输出。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -93,7 +98,9 @@ child.getOutput.then(val=>{ ...@@ -93,7 +98,9 @@ child.getOutput.then(val=>{
getErrorOutput(): Promise<Uint8Array> getErrorOutput(): Promise<Uint8Array>
getErrorOutput函数用来获取子进程的标准错误输出。 获取子进程的标准错误输出。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
...@@ -118,6 +125,8 @@ close(): void ...@@ -118,6 +125,8 @@ close(): void
关闭正在运行的子进程。 关闭正在运行的子进程。
**系统能力:** SystemCapability.Utils.Lang
**示例:** **示例:**
``` ```
...@@ -130,7 +139,9 @@ child.close(); ...@@ -130,7 +139,9 @@ child.close();
kill(signal: number | string): void kill(signal: number | string): void
kill函数用来发送信号给子进程,结束指定进程。 用于发送信号给子进程,结束指定进程。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
...@@ -152,6 +163,8 @@ isIsolatedProcess(): boolean ...@@ -152,6 +163,8 @@ isIsolatedProcess(): boolean
判断进程是否被隔离。 判断进程是否被隔离。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -171,6 +184,8 @@ isAppUid(v:number): boolean ...@@ -171,6 +184,8 @@ isAppUid(v:number): boolean
判断uid是否属于应用程序。 判断uid是否属于应用程序。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -196,6 +211,8 @@ is64Bit(): boolean ...@@ -196,6 +211,8 @@ is64Bit(): boolean
判断运行环境是否64位。 判断运行环境是否64位。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -215,6 +232,8 @@ getUidForName(v:string): number ...@@ -215,6 +232,8 @@ getUidForName(v:string): number
通过进程名获取进程uid。 通过进程名获取进程uid。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -240,6 +259,8 @@ getThreadPriority(v:number): number ...@@ -240,6 +259,8 @@ getThreadPriority(v:number): number
根据指定的tid获取线程优先级。 根据指定的tid获取线程优先级。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -266,6 +287,8 @@ getStartRealtime(): number ...@@ -266,6 +287,8 @@ getStartRealtime(): number
获取从系统启动到进程启动所经过的实时时间(以毫秒为单位)。 获取从系统启动到进程启动所经过的实时时间(以毫秒为单位)。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -278,12 +301,14 @@ getStartRealtime(): number ...@@ -278,12 +301,14 @@ getStartRealtime(): number
var realtime = process.getStartRealtime(); var realtime = process.getStartRealtime();
``` ```
## process.getPastCputime<sup>8+</sup> ## process.getPastCpuTime<sup>8+</sup>
getPastCputime(): number getPastCpuTime(): number
获取进程启动到当前时间的CPU时间(以毫秒为单位)。 获取进程启动到当前时间的CPU时间(以毫秒为单位)。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -293,7 +318,7 @@ getPastCputime(): number ...@@ -293,7 +318,7 @@ getPastCputime(): number
**示例:** **示例:**
``` ```
var result = process.getPastCputime() ; var result = process.getPastCpuTime() ;
``` ```
...@@ -303,6 +328,8 @@ getSystemConfig(name:number): number ...@@ -303,6 +328,8 @@ getSystemConfig(name:number): number
获取系统配置信息。 获取系统配置信息。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -329,6 +356,8 @@ getEnvironmentVar(name:string): string ...@@ -329,6 +356,8 @@ getEnvironmentVar(name:string): string
用该方法获取环境变量对应的值。 用该方法获取环境变量对应的值。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -350,10 +379,12 @@ var pres = process.getEnvironmentVar("PATH") ...@@ -350,10 +379,12 @@ var pres = process.getEnvironmentVar("PATH")
## process.runCmd ## process.runCmd
runCmd(command: string, options?: { timeout : number, killSignal number | string, maxBuffer : number }) : ChildProcess runCmd(command: string, options?: { timeout : number, killSignal : number | string, maxBuffer : number }) : ChildProcess
通过runcmd可以fork一个新的进程来运行一段shell,并返回ChildProcess对象。 通过runcmd可以fork一个新的进程来运行一段shell,并返回ChildProcess对象。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -392,6 +423,8 @@ abort(): void ...@@ -392,6 +423,8 @@ abort(): void
该方法会导致进程立即退出并生成一个核心文件,谨慎使用。 该方法会导致进程立即退出并生成一个核心文件,谨慎使用。
**系统能力:** SystemCapability.Utils.Lang
**示例:** **示例:**
``` ```
...@@ -403,7 +436,9 @@ process.abort(); ...@@ -403,7 +436,9 @@ process.abort();
on(type: string, listener: EventListener): void on(type: string, listener: EventListener): void
用该方法来存储用户所触发的事件。 存储用户所触发的事件。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
...@@ -431,7 +466,9 @@ process.on("data", (e)=>{ ...@@ -431,7 +466,9 @@ process.on("data", (e)=>{
off(type: string): boolean off(type: string): boolean
用该方法来删除用户存储的事件。 删除用户存储的事件。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
...@@ -459,7 +496,11 @@ var result = process.off("data"); ...@@ -459,7 +496,11 @@ var result = process.off("data");
exit(code: number): void exit(code: number): void
用该方法终止程序,谨慎使用。 终止程序。
请谨慎使用此接口。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
...@@ -480,6 +521,8 @@ cwd(): string ...@@ -480,6 +521,8 @@ cwd(): string
用该方法获取进程的工作目录。 用该方法获取进程的工作目录。
**系统能力:** SystemCapability.Utils.Lang
**示例:** **示例:**
``` ```
...@@ -491,7 +534,9 @@ var path = process.cwd(); ...@@ -491,7 +534,9 @@ var path = process.cwd();
chdir(dir: string): void chdir(dir: string): void
用该方法更改进程的当前工作目录。 更改进程的当前工作目录。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
...@@ -512,6 +557,8 @@ uptime(): number ...@@ -512,6 +557,8 @@ uptime(): number
获取当前系统已运行的秒数。 获取当前系统已运行的秒数。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -527,9 +574,11 @@ var time = process.uptime(); ...@@ -527,9 +574,11 @@ var time = process.uptime();
## process.kill ## process.kill
kill(pid: number,signal: number ): boolean kill(pid: number, signal: number ): boolean
发送signal到指定的进程,结束指定进程。
用该方法发送signal到指定的进程,结束指定进程。 **系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
......
...@@ -557,4 +557,4 @@ SIM卡状态。 ...@@ -557,4 +557,4 @@ SIM卡状态。
|CU_DUAL_MODE_CARD | 42 | 中国联通双模卡 | |CU_DUAL_MODE_CARD | 42 | 中国联通双模卡 |
|DUAL_MODE_TELECOM_LTE_CARD | 43 | 双模式电信LTE卡 | |DUAL_MODE_TELECOM_LTE_CARD | 43 | 双模式电信LTE卡 |
|DUAL_MODE_UG_CARD | 50 | 双模式UG卡 | |DUAL_MODE_UG_CARD | 50 | 双模式UG卡 |
|SINGLE_MODE_ISIM_CARD | 60 | 单一ISIM卡类型 | |SINGLE_MODE_ISIM_CARD<sup>8+</sup> | 60 | 单一ISIM卡类型 |
\ No newline at end of file \ No newline at end of file
...@@ -111,7 +111,7 @@ export default { ...@@ -111,7 +111,7 @@ export default {
getAuthenticator(): Authenticator getAuthenticator(): Authenticator
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> 从 API Version 8 开始废弃,建议使用[constructor](#constructor8)替代。 > 从 API Version 8 开始废弃,建议使用[constructor](#constructor8)替代。
获取Authenticator对象,用于执行用户身份认证。 获取Authenticator对象,用于执行用户身份认证。
...@@ -120,19 +120,19 @@ getAuthenticator(): Authenticator ...@@ -120,19 +120,19 @@ getAuthenticator(): Authenticator
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ----------------------------------------- | ------------ |
| [Authenticator](#authenticatordeprecated) | 认证器对象。 | | [Authenticator](#authenticatordeprecated) | 认证器对象。 |
- 示例: **示例:**
```js ```js
let authenticator = userIAM_userAuth.getAuthenticator(); let authenticator = userIAM_userAuth.getAuthenticator();
``` ```
## Authenticator<sup>(deprecated)</sup> ## Authenticator<sup>(deprecated)</sup>
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> 从 API Version 8 开始废弃,建议使用[UserAuth](#userauth8)替代。 > 从 API Version 8 开始废弃,建议使用[UserAuth](#userauth8)替代。
认证器对象。 认证器对象。
...@@ -142,7 +142,7 @@ getAuthenticator(): Authenticator ...@@ -142,7 +142,7 @@ getAuthenticator(): Authenticator
execute(type: string, level: string, callback: AsyncCallback&lt;number&gt;): void execute(type: string, level: string, callback: AsyncCallback&lt;number&gt;): void
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> 从 API Version 8 开始废弃,建议使用[auth](#auth8)替代。 > 从 API Version 8 开始废弃,建议使用[auth](#auth8)替代。
执行用户认证,使用callback方式作为异步方法。 执行用户认证,使用callback方式作为异步方法。
...@@ -151,20 +151,21 @@ execute(type: string, level: string, callback: AsyncCallback&lt;number&gt;): voi ...@@ -151,20 +151,21 @@ execute(type: string, level: string, callback: AsyncCallback&lt;number&gt;): voi
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | 参数名 | 类型 | 必填 | 说明 |
| type | string | 是 | 认证类型,当前只支持FACE_ONLY。<br/>ALL为预留参数,当前版本暂不支持ALL类型的认证。 | | -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| level | string | 是 | 安全级别,对应认证的安全级别,有效值为S1(最低)、S2、S3、S4(最高)。<br/>具备3D人脸识别能力的设备支持S3及以下安全级别的认证。<br/>具备2D人脸识别能力的设备支持S2及以下安全级别的认证。 | | type | string | 是 | 认证类型,当前只支持FACE_ONLY。<br/>ALL为预留参数,当前版本暂不支持ALL类型的认证。 |
| callback | AsyncCallback&lt;number&gt; | 否 | 回调函数。 | | level | string | 是 | 安全级别,对应认证的安全级别,有效值为S1(最低)、S2、S3、S4(最高)。<br/>具备3D人脸识别能力的设备支持S3及以下安全级别的认证。<br/>具备2D人脸识别能力的设备支持S2及以下安全级别的认证。 |
| callback | AsyncCallback&lt;number&gt; | 否 | 回调函数。 |
callback返回值: callback返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------------------------------------------------------------ |
| number | 表示认证结果,参见[AuthenticationResult](#authenticationresultdeprecated)。 | | number | 表示认证结果,参见[AuthenticationResult](#authenticationresultdeprecated)。 |
- 示例: **示例:**
```js ```js
authenticator.execute("FACE_ONLY", "S2", (code)=>{ authenticator.execute("FACE_ONLY", "S2", (code)=>{
if (code == userIAM_userAuth.AuthenticationResult.SUCCESS) { if (code == userIAM_userAuth.AuthenticationResult.SUCCESS) {
...@@ -180,7 +181,7 @@ execute(type: string, level: string, callback: AsyncCallback&lt;number&gt;): voi ...@@ -180,7 +181,7 @@ execute(type: string, level: string, callback: AsyncCallback&lt;number&gt;): voi
execute(type:string, level:string): Promise&lt;number&gt; execute(type:string, level:string): Promise&lt;number&gt;
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> 从 API Version 8 开始废弃,建议使用[auth](#auth8)替代。 > 从 API Version 8 开始废弃,建议使用[auth](#auth8)替代。
执行用户认证,使用promise方式作为异步方法。 执行用户认证,使用promise方式作为异步方法。
...@@ -189,49 +190,50 @@ execute(type:string, level:string): Promise&lt;number&gt; ...@@ -189,49 +190,50 @@ execute(type:string, level:string): Promise&lt;number&gt;
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 认证类型,当前只支持FACE_ONLY。<br/>ALL为预留参数,当前版本暂不支持ALL类型的认证。 | | type | string | 是 | 认证类型,当前只支持FACE_ONLY。<br/>ALL为预留参数,当前版本暂不支持ALL类型的认证。 |
| level | string | 是 | 安全级别,对应认证的安全级别,有效值为S1(最低)、S2、S3、S4(最高)。<br/>具备3D人脸识别能力的设备支持S3及以下安全级别的认证。<br/>具备2D人脸识别能力的设备支持S2及以下安全级别的认证。 | | level | string | 是 | 安全级别,对应认证的安全级别,有效值为S1(最低)、S2、S3、S4(最高)。<br/>具备3D人脸识别能力的设备支持S3及以下安全级别的认证。<br/>具备2D人脸识别能力的设备支持S2及以下安全级别的认证。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | --------------------- | ------------------------------------------------------------ |
| Promise&lt;number&gt; | 返回携带一个number的Promise。number&nbsp;为认证结果,参见[AuthenticationResult](#authenticationresultdeprecated)。 | | Promise&lt;number&gt; | 返回携带一个number的Promise。number&nbsp;为认证结果,参见[AuthenticationResult](#authenticationresultdeprecated)。 |
- 示例 **示例:**
```js
let authenticator = userIAM_userAuth.getAuthenticator(); ```js
authenticator.execute("FACE_ONLY", "S2").then((code)=>{ let authenticator = userIAM_userAuth.getAuthenticator();
console.info("auth success"); authenticator.execute("FACE_ONLY", "S2").then((code)=>{
}).catch((code)=>{ console.info("auth success");
console.error("auth fail, code = " + code); }).catch((code)=>{
}); console.error("auth fail, code = " + code);
``` });
```
## AuthenticationResult<sup>(deprecated)</sup> ## AuthenticationResult<sup>(deprecated)</sup>
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> 从 API Version 8 开始废弃,建议使用[ResultCode](#resultcode8)替代。 > 从 API Version 8 开始废弃,建议使用[ResultCode](#resultcode8)替代。
表示认证结果的枚举。 表示认证结果的枚举。
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| -------- | -------- | -------- | | ------------------ | ------ | -------------------------- |
| NO_SUPPORT | -1 | 设备不支持当前的认证方式。 | | NO_SUPPORT | -1 | 设备不支持当前的认证方式。 |
| SUCCESS | 0 | 认证成功。 | | SUCCESS | 0 | 认证成功。 |
| COMPARE_FAILURE | 1 | 比对失败。 | | COMPARE_FAILURE | 1 | 比对失败。 |
| CANCELED | 2 | 用户取消认证。 | | CANCELED | 2 | 用户取消认证。 |
| TIMEOUT | 3 | 认证超时。 | | TIMEOUT | 3 | 认证超时。 |
| CAMERA_FAIL | 4 | 开启相机失败。 | | CAMERA_FAIL | 4 | 开启相机失败。 |
| BUSY | 5 | 认证服务忙,请稍后重试。 | | BUSY | 5 | 认证服务忙,请稍后重试。 |
| INVALID_PARAMETERS | 6 | 认证参数无效。 | | INVALID_PARAMETERS | 6 | 认证参数无效。 |
| LOCKED | 7 | 认证失败次数过多,已锁定。 | | LOCKED | 7 | 认证失败次数过多,已锁定。 |
| NOT_ENROLLED | 8 | 未录入认证凭据。 | | NOT_ENROLLED | 8 | 未录入认证凭据。 |
| GENERAL_ERROR | 100 | 其他错误。 | | GENERAL_ERROR | 100 | 其他错误。 |
## UserAuth<sup>8+</sup> ## UserAuth<sup>8+</sup>
...@@ -239,7 +241,7 @@ execute(type:string, level:string): Promise&lt;number&gt; ...@@ -239,7 +241,7 @@ execute(type:string, level:string): Promise&lt;number&gt;
### constructor<sup>8+</sup> ### constructor<sup>8+</sup>
constructor(); constructor()
表示获取的认证器对象。 表示获取的认证器对象。
...@@ -247,13 +249,13 @@ constructor(); ...@@ -247,13 +249,13 @@ constructor();
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | -------------------- | | ---------------------- | -------------------- |
| [UserAuth](#userauth8) | UserAuth认证器对象。 | | [UserAuth](#userauth8) | UserAuth认证器对象。 |
- 示例: **示例:**
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
...@@ -263,7 +265,7 @@ constructor(); ...@@ -263,7 +265,7 @@ constructor();
### getVersion<sup>8+</sup> ### getVersion<sup>8+</sup>
getVersion() : number; getVersion() : number
表示获取的认证器版本信息。 表示获取的认证器版本信息。
...@@ -271,13 +273,13 @@ getVersion() : number; ...@@ -271,13 +273,13 @@ getVersion() : number;
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ---------------------- | | ------ | ---------------------- |
| number | 获取的认证器版本信息。 | | number | 获取的认证器版本信息。 |
- 示例: **示例:**
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
...@@ -289,7 +291,7 @@ getVersion() : number; ...@@ -289,7 +291,7 @@ getVersion() : number;
### getAvailableStatus<sup>8+</sup> ### getAvailableStatus<sup>8+</sup>
getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : number; getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : number
表示检查指定的认证等级的认证能力是否可用。 表示检查指定的认证等级的认证能力是否可用。
...@@ -297,20 +299,20 @@ getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : n ...@@ -297,20 +299,20 @@ getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : n
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------- | ---- | -------------------------- | | -------------- | ---------------------------------- | ---- | -------------------------- |
| authType | [UserAuthType](#userauthtype8) | 是 | 认证类型,当前只支持FACE。 | | authType | [UserAuthType](#userauthtype8) | 是 | 认证类型,当前只支持FACE。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证结果的信任等级。 | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证结果的信任等级。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------------------------------------------------------ | | ------ | ------------------------------------------------------------ |
| number | 获取指定的认证等级的认证能力是否可用的检查结果,返回值参见[ResultCode](#resultcode8)。 | | number | 获取指定的认证等级的认证能力是否可用的检查结果,返回值参见[ResultCode](#resultcode8)。 |
- 示例: **示例:**
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
...@@ -328,7 +330,7 @@ getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : n ...@@ -328,7 +330,7 @@ getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : n
### auth<sup>8+</sup> ### auth<sup>8+</sup>
auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array; auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array
表示执行用户认证,使用callback方式作为异步方法。 表示执行用户认证,使用callback方式作为异步方法。
...@@ -336,22 +338,22 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev ...@@ -336,22 +338,22 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------------- | ---- | ------------------------ | | -------------- | ---------------------------------------- | ---- | ------------------------ |
| challenge | Uint8Array | 是 | 挑战值,可以填null。 | | challenge | Uint8Array | 是 | 挑战值,可以填null。 |
| authType | [UserAuthType](#userauthtype8) | 是 | 认证类型,当前支持FACE。 | | authType | [UserAuthType](#userauthtype8) | 是 | 认证类型,当前支持FACE。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 信任等级。 | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 信任等级。 |
| callback | [IUserAuthCallback](#iuserauthcallback8) | 是 | 回调函数。 | | callback | [IUserAuthCallback](#iuserauthcallback8) | 是 | 回调函数。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------- | ------------------------------------------------------------ | | ---------- | ------------------------------------------------------------ |
| Uint8Array | ContextId,作为取消认证[cancelAuth](#cancelauth8)接口的入参。 | | Uint8Array | ContextId,作为取消认证[cancelAuth](#cancelauth8)接口的入参。 |
- 示例: **示例:**
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
...@@ -376,7 +378,7 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev ...@@ -376,7 +378,7 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev
### cancelAuth<sup>8+</sup> ### cancelAuth<sup>8+</sup>
cancelAuth(contextID : Uint8Array) : number; cancelAuth(contextID : Uint8Array) : number
表示通过contextID取消本次认证操作。 表示通过contextID取消本次认证操作。
...@@ -384,19 +386,19 @@ cancelAuth(contextID : Uint8Array) : number; ...@@ -384,19 +386,19 @@ cancelAuth(contextID : Uint8Array) : number;
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------- | ---- | ------------------------------------------ | | --------- | ---------- | ---- | ------------------------------------------ |
| contextID | Uint8Array | 是 | 上下文ID信息,通过[auth](#auth8)接口获得。 | | contextID | Uint8Array | 是 | 上下文ID信息,通过[auth](#auth8)接口获得。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------------------ | | ------ | ------------------------ |
| number | 取消本次认证操作的结果。 | | number | 取消本次认证操作的结果。 |
- 示例: **示例:**
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
...@@ -417,21 +419,21 @@ cancelAuth(contextID : Uint8Array) : number; ...@@ -417,21 +419,21 @@ cancelAuth(contextID : Uint8Array) : number;
### onResult<sup>8+</sup> ### onResult<sup>8+</sup>
onResult: (result : number, extraInfo : AuthResult) => void; onResult: (result : number, extraInfo : AuthResult) => void
表示在认证操作中,获取认证结果。 表示在认证操作中,获取认证结果。
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------- | ---- | ------------------------------------------------------------ | | --------- | -------------------------- | ---- | ------------------------------------------------------------ |
| result | number | 是 | 认证结果,参见[ResultCode](#resultcode8)。 | | result | number | 是 | 认证结果,参见[ResultCode](#resultcode8)。 |
| extraInfo | [AuthResult](#authresult8) | 是 | 扩展信息,不同情况下的具体信息,<br/>如果身份验证通过,则在extrainfo中返回用户认证令牌,<br/>如果身份验证失败,则在extrainfo中返回剩余的用户认证次数,<br/>如果身份验证执行器被锁定,则在extrainfo中返回冻结时间。 | | extraInfo | [AuthResult](#authresult8) | 是 | 扩展信息,不同情况下的具体信息,<br/>如果身份验证通过,则在extrainfo中返回用户认证令牌,<br/>如果身份验证失败,则在extrainfo中返回剩余的用户认证次数,<br/>如果身份验证执行器被锁定,则在extrainfo中返回冻结时间。 |
- 示例 **示例:**
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
...@@ -466,21 +468,21 @@ onResult: (result : number, extraInfo : AuthResult) => void; ...@@ -466,21 +468,21 @@ onResult: (result : number, extraInfo : AuthResult) => void;
### onAcquireInfo<sup>8+</sup> ### onAcquireInfo<sup>8+</sup>
onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void; onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void
表示在认证过程中,获取提示码信息,非必须实现。 表示在认证过程中,获取提示码信息,非必须实现。
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------------------------------ | | --------- | ------ | ---- | ------------------------------ |
| module | number | 是 | 认证执行器的类型。 | | module | number | 是 | 认证执行器的类型。 |
| acquire | number | 是 | 认证执行器认证过程的交互信息。 | | acquire | number | 是 | 认证执行器认证过程的交互信息。 |
| extraInfo | any | 是 | 预留字段。 | | extraInfo | any | 是 | 预留字段。 |
- 示例 **示例:**
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
...@@ -531,19 +533,19 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void; ...@@ -531,19 +533,19 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void;
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| -------- | -------- | -------- | | ----------------------- | ------ | -------------------- |
| SUCCESS | 0 | 执行成功。 | | SUCCESS | 0 | 执行成功。 |
| FAIL | 1 | 执行失败。 | | FAIL | 1 | 执行失败。 |
| GENERAL_ERROR | 2 | 操作通用错误。 | | GENERAL_ERROR | 2 | 操作通用错误。 |
| CANCELED | 3 | 操作取消。 | | CANCELED | 3 | 操作取消。 |
| TIMEOUT | 4 | 操作超时。 | | TIMEOUT | 4 | 操作超时。 |
| TYPE_NOT_SUPPORT | 5 | 不支持的认证类型。 | | TYPE_NOT_SUPPORT | 5 | 不支持的认证类型。 |
| TRUST_LEVEL_NOT_SUPPORT | 6 | 不支持的认证等级。 | | TRUST_LEVEL_NOT_SUPPORT | 6 | 不支持的认证等级。 |
| BUSY | 7 | 忙碌状态。 | | BUSY | 7 | 忙碌状态。 |
| INVALID_PARAMETERS | 8 | 无效参数。 | | INVALID_PARAMETERS | 8 | 无效参数。 |
| LOCKED | 9 | 认证器已锁定。 | | LOCKED | 9 | 认证器已锁定。 |
| NOT_ENROLLED | 10 | 用户未录入认证信息。 | | NOT_ENROLLED | 10 | 用户未录入认证信息。 |
## FaceTips<sup>8+</sup> ## FaceTips<sup>8+</sup>
...@@ -573,14 +575,14 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void; ...@@ -573,14 +575,14 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void;
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| -------- | -------- | -------- | | --------------------------------- | ------ | -------------------------------------------------- |
| FINGERPRINT_AUTH_TIP_GOOD | 0 | 获取的指纹图像良好。 | | FINGERPRINT_AUTH_TIP_GOOD | 0 | 获取的指纹图像良好。 |
| FINGERPRINT_AUTH_TIP_DIRTY | 1 | 由于传感器上可疑或检测到的污垢,指纹图像噪音过大。 | | FINGERPRINT_AUTH_TIP_DIRTY | 1 | 由于传感器上可疑或检测到的污垢,指纹图像噪音过大。 |
| FINGERPRINT_AUTH_TIP_INSUFFICIENT | 2 | 由于检测到的情况,指纹图像噪声太大,无法处理。 | | FINGERPRINT_AUTH_TIP_INSUFFICIENT | 2 | 由于检测到的情况,指纹图像噪声太大,无法处理。 |
| FINGERPRINT_AUTH_TIP_PARTIAL | 3 | 仅检测到部分指纹图像。 | | FINGERPRINT_AUTH_TIP_PARTIAL | 3 | 仅检测到部分指纹图像。 |
| FINGERPRINT_AUTH_TIP_TOO_FAST | 4 | 快速移动,指纹图像不完整。 | | FINGERPRINT_AUTH_TIP_TOO_FAST | 4 | 快速移动,指纹图像不完整。 |
| FINGERPRINT_AUTH_TIP_TOO_SLOW | 5 | 缺少运动,指纹图像无法读取。 | | FINGERPRINT_AUTH_TIP_TOO_SLOW | 5 | 缺少运动,指纹图像无法读取。 |
## UserAuthType<sup>8+</sup> ## UserAuthType<sup>8+</sup>
...@@ -589,9 +591,9 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void; ...@@ -589,9 +591,9 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void;
**系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core **系统能力**:以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| -------- | -------- | -------- | | ----------- | ------ | ---------- |
| FACE | 2 | 人脸认证。 | | FACE | 2 | 人脸认证。 |
| FINGERPRINT | 4 | 指纹认证。 | | FINGERPRINT | 4 | 指纹认证。 |
## AuthTrustLevel<sup>8+</sup> ## AuthTrustLevel<sup>8+</sup>
......
...@@ -41,7 +41,7 @@ var thatSer = new xml.XmlSerializer(bufView); ...@@ -41,7 +41,7 @@ var thatSer = new xml.XmlSerializer(bufView);
### setAttributes ### setAttributes
setAttributes(name: string, value: string)void setAttributes(name: string, value: string): void
设置Attributes方法。 设置Attributes方法。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册