harmony 鸿蒙用户IAM子系统Changelog

2022-12-22
浏览 (618)

用户IAM子系统Changelog

cl.useriam.1 API异常处理方式变更

用户IAM部分接口使用业务逻辑返回值表示错误信息，不符合OpenHarmony接口错误码规范。从API9开始作以下变更：

接口通过抛出异常的方式返回错误信息。

变更影响

基于此版本以前开发的应用不受影响，以后的需适配变更接口的错误信息返回方式，否则会影响业务逻辑。

关键接口/组件变更

为适配统一的API异常处理方式，对用户IAM相关接口进行废弃（下表中原接口列内容），并新增对应接口（下表中新接口列内容）。新增接口支持统一的错误码异常处理规范，功能上与原接口保持一致。

模块名	类名	方法/属性/枚举/常量	变更类型
ohos.userIAM.userAuth	UserAuth	constructor()	废弃
ohos.userIAM.userAuth	UserAuth	getVersion() : number	废弃
ohos.userIAM.userAuth	UserAuth	getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : number	废弃
ohos.userIAM.userAuth	UserAuth	auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array	废弃
ohos.userIAM.userAuth	UserAuth	cancelAuth(contextID : Uint8Array) : number	废弃
ohos.userIAM.userAuth	IUserAuthCallback	onResult: (result : number, extraInfo : AuthResult) => void	废弃
ohos.userIAM.userAuth	IUserAuthCallback	onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void	废弃
ohos.userIAM.userAuth	AuthResult	AuthResult { token ?: Uint8Array; remainTimes ?: number; freezingTime ?: number;}	废弃
ohos.userIAM.userAuth	枚举	ResultCode { SUCCESS = 0, FAIL = 1, GENERAL_ERROR = 2, CANCELED = 3, TIMEOUT = 4, TYPE_NOT_SUPPORT = 5, TRUST_LEVEL_NOT_SUPPORT = 6, BUSY = 7, INVALID_PARAMETERS = 8, LOCKED = 9, NOT_ENROLLED = 10,}	废弃
ohos.userIAM.userAuth	type	AuthEventKey = “result”	新增
ohos.userIAM.userAuth	type	EventInfo = AuthResultInfo	新增
ohos.userIAM.userAuth	AuthResultInfo	AuthResultInfo { result : number; token ?: Uint8Array; remainAttempts ?: number; lockoutDuration ?: number;}	新增
ohos.userIAM.userAuth	TipInfo	TipInfo { module : number; tip : number;}	新增
ohos.userIAM.userAuth	AuthInstance	AuthInstance { on: (name: AuthEventKey, callback: AuthEvent) => void; off: (name: AuthEventKey) => void; start: () => void; cancel: () => void;}	新增
ohos.userIAM.userAuth	枚举	ResultCodeV9 { SUCCESS = 12500000, FAIL = 12500001, GENERAL_ERROR = 12500002, CANCELED = 12500003, TIMEOUT = 12500004, TYPE_NOT_SUPPORT = 12500005, TRUST_LEVEL_NOT_SUPPORT = 12500006, BUSY = 12500007, LOCKED = 12500009, NOT_ENROLLED = 12500010,}	新增
ohos.userIAM.userAuth	function	getAuthInstance(challenge : Uint8Array, authType : UserAuthType, authTrustLevel : AuthTrustLevel) : AuthInstance	新增
ohos.userIAM.userAuth	function	getVersion() : number	新增
ohos.userIAM.userAuth	function	getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : void	新增
ohos.userIAM.faceAuth	FaceAuthManager	setSurfaceId(surfaceId : string) : ResultCode	删除
ohos.userIAM.faceAuth	枚举	ResultCode { SUCCESS = 0, FAIL = 1,}	删除
ohos.userIAM.faceAuth	FaceAuthManager	setSurfaceId(surfaceId: string) : void	新增

适配指导

以getVersion接口为例，示例代码如下：

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);
}

更多接口的示例代码可参考用户认证API文档和人脸认证API文档。