提交 67736b45 编写于 作者: T Tianshi Liu 提交者: youliang_1314

delete api9 getVersion; modify api 8 getVersion return code

Signed-off-by: NTianshi Liu <tianshi.liu@huawei.com>
Change-Id: Ie5a7dded9c61080bafc5b690f0e4fd6d11581646
上级 aab1f0cb
......@@ -399,44 +399,6 @@ try {
}
```
## userIAM_userAuth.getVersion<sup>9+</sup>
getVersion(): number
获取认证器的版本信息。
**需要权限**:ohos.permission.ACCESS_BIOMETRIC
**系统能力**:SystemCapability.UserIAM.UserAuth.Core
**返回值:**
| 类型 | 说明 |
| ------ | ---------------------- |
| number | 认证器版本信息。 |
以下错误码的详细介绍请参见[用户认证错误码](../errorcodes/errorcode-useriam.md)
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------- |
| 201 | Permission verification failed. |
| 12500002 | General operation error. |
**示例:**
```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.getAvailableStatus<sup>9+</sup>
getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): void
......@@ -535,7 +497,7 @@ getVersion() : number
获取认证器的版本信息。
> **说明:**
> 从 API version 8 开始支持,从 API version 9 开始废弃,请使用[getVersion](#useriam_userauthgetversion9)替代
> 从 API version 8 开始支持,从 API version 9 开始废弃。
**需要权限**:ohos.permission.ACCESS_BIOMETRIC
......
......@@ -17,7 +17,6 @@ userIAM_userAuth模块提供了用户认证的相关方法,包括查询认证
| 接口名称 | 功能描述 |
| ---------- | ----------------------- |
| getVersion() : number | 获取认证对象的版本信息。 |
| getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): void | 根据指定的认证类型、认证等级,检测当前设备是否支持相应的认证能力。 |
| getAuthInstance(challenge : Uint8Array, authType : UserAuthType, authTrustLevel : AuthTrustLevel): AuthInstance | 获取AuthInstance对象,用于执行用户身份认证。 |
| on(name : AuthEventKey, callback : AuthEvent) : void | 订阅指定类型的用户认证事件。 |
......@@ -25,26 +24,6 @@ userIAM_userAuth模块提供了用户认证的相关方法,包括查询认证
| start: void | 执行用户认证。 |
| cancel: void | 取消本次认证操作。 |
## 获取认证对象的版本信息
### 开发步骤
1. 申请权限。调用[getVersion](../reference/apis/js-apis-useriam-userauth.md#useriam_userauthgetversion9)接口,需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息请参考[Stage模型应用程序包结构](../quick-start/module-configuration-file.md)
2. 调用[getVersion](../reference/apis/js-apis-useriam-userauth.md#useriam_userauthgetversion9)接口获取版本信息。
```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);
}
```
## 查询当前设备是否支持相应的认证能力
### 开发步骤
......
# 用户IAM子系统Changelog
## cl.useriam.1 API9 GetVesion接口删除
为优化用户IAM接口,从当前版本开始做如下变更:
用户IAM删除GetVersion(API 9)接口。
**变更影响**
对用户IAM GetVersion(API 9)接口的使用有影响,需删除对此接口的调用,否则会调用失败。
**关键接口/组件变更**
| 模块名 | 类名 | 方法/属性/枚举/常量 | 变更类型 |
| ---------------------- | ------------------- | ------------------------- | ------------------------ |
| ohos.userIAM.userAuth | function | getVersion() : number | 删除 |
**适配指导**
需删除对用户IAM GetVersion(API 9)接口的调用。
## cl.useriam.2 API8 GetVesion接口返回值变更
为统一用户IAM GetVersion(API 8)接口的返回值。从当前版本开始做如下变更:
用户IAM GetVersion(API 8)接口的返回值由0变更为1。
**变更影响**
对用户IAM GetVersion(API 8)接口的使用有影响,如应用校验了此接口的返回值,修改后校验不通过。
**关键接口/组件变更**
用户IAM GetVersion(API 8)接口的返回值由0变更为1。
**适配指导**
此接口已废弃,需删除对用户IAM GetVersion(API 8)接口的使用。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册