From 40295f7de3441edd1d0bad1d3bb88b20ce329f24 Mon Sep 17 00:00:00 2001 From: "https://gitee.com/WALL_EYE" Date: Sun, 30 Jan 2022 17:07:49 +0800 Subject: [PATCH] modify UserAuth d.ts Signed-off-by: https://gitee.com/WALL_EYE Change-Id: I33c7e65632951d5da6151b41aad455cf90f11001 --- api/@ohos.userIAM.d.ts | 348 -------------------------------- api/@ohos.userIAM.userAuth.d.ts | 325 +++++++++++++++++++++++++++++ 2 files changed, 325 insertions(+), 348 deletions(-) delete mode 100644 api/@ohos.userIAM.d.ts diff --git a/api/@ohos.userIAM.d.ts b/api/@ohos.userIAM.d.ts deleted file mode 100644 index 3975fbe865..0000000000 --- a/api/@ohos.userIAM.d.ts +++ /dev/null @@ -1,348 +0,0 @@ -/* - * Copyright (c) 2022 Huawei Device Co., Ltd. - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import{AsyncCallback} from './basic'; - -/** - * User Identity and Access Management. - * @since 8 - * @sysCap SystemCapability.UserIAM.UserAuth - * @permission ohos.permission.ACCESS_BIOMETRIC - */ -declare namespace userIAM { - /** - * User authentication. - */ - class UserAuth { - /** - * Constructor to get the UserAuth class instance. - * @since 8 - * @SysCap SystemCapability.UserIAM.UserAuth - * @return Returns the UserAuth class instance. - */ - constructor(); - - /** - * Get version information. - * @since 8 - * @SysCap SystemCapability.UserIAM.UserAuth - * @return Returns version information. - */ - getVersion() : number; - - /** - * Check whether the authentication capability is available. - * @since 8 - * @SysCap SystemCapability.UserIAM.UserAuth - * @permission ohos.permission.ACCESS_BIOMETRIC - * @param authType Credential type for authentication. - * @param authTrustLevel Trust level of authentication result. - * @return Returns a check result, which is specified by getAvailabeStatus. - */ - getAvailabeStatus(authType : AuthType, authTrustLevel : AuthTrustLevel) : number; - - /** - * Executes authentication. - * @since 8 - * @SysCap SystemCapability.UserIAM.UserAuth - * @permission ohos.permission.ACCESS_BIOMETRIC - * @param challenge pass in challenge value. - * @param authType type of authentication. - * @param authTrustLevel Trust level of authentication result. - * @param callback Return result and acquireinfo through callback. - * @return Returns ContextId for cancel. - */ - auth(challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array; - - /** - * Cancels authentication with ContextID. - * @since 8 - * @SysCap SystemCapability.UserIAM.UserAuth - * @permission ohos.permission.ACCESS_BIOMETRIC - * @param contextID Cancel authentication and pass in ContextID. - * @return Returns a number value indicating whether Cancel authentication was successful. - */ - cancelAuth(contextID : Uint8Array) : number; - } - - interface IUserAuthCallback { - /** - * The authentication result code is returned through the callback. - * @since 8 - * @param result authentication result code. - * @param extraInfo pass the specific information for different situation. - * If the authentication is passed, the authentication token is returned in extrainfo, - * If the authentication fails, the remaining authentication times are returned in extrainfo, - * If the authentication executor is locked, the freezing time is returned in extrainfo. - */ - onResult: (result : number, extraInfo : AuthResult) => void; - - /** - * During an authentication, the TipsCode is returned through the callback. - * @since 8 - * @param module the executor type for authentication. - * @param acquire the tip code for different authentication executor. - * @param extraInfo reserved parameter. - */ - onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void; - } - - /** - * Authentication result: authentication token, remaining authentication times, freezing time. - * @since 8 - * @param token pass the authentication result if the authentication is passed. - * @param remainTimes return the remaining authentication times if the authentication fails. - * @param freezingTime return the freezing time if the authectication executor is locked. - */ - interface AuthResult { - token ?: Uint8Array; - remainTimes ?: number; - freezingTime ?: number; - } - - /** - * Result code. - * @since 8 - */ - enum ResultCode { - /** - * Indicates that the result is success or ability is supported. - * @since 8 - */ - SUCCESS = 0, - - /** - * Indicates the the result is failure or ability is not supported. - * @since 8 - */ - FAIL = 1, - - /** - * Indicates other errors. - * @since 8 - */ - GENERAL_ERROR = 2, - - /** - * Indicates that this operation has been canceled. - * @since 8 - */ - CANCELED = 3, - - /** - * Indicates that this operation has timed out. - * @since 8 - */ - TIMEOUT = 4, - - /** - * Indicates that this authentication type is not supported. - * @since 8 - */ - TYPE_NOT_SUPPORT = 5, - - /** - * Indicates that the authentication trust level is not supported. - * @since 8 - */ - TRUST_LEVEL_NOT_SUPPORT = 6, - - /** - * Indicates that the authentication task is busy. Wait for a few seconds and try again. - * @since 8 - */ - BUSY = 7, - - /** - * Indicates incorrect parameters. - * @since 8 - */ - INVALID_PARAMETERS = 8, - - /** - * Indicates that the authenticator is locked. - * @since 8 - */ - LOCKED = 9, - - /** - * Indicates that the user has not enrolled the authenticator. - * @since 8 - */ - NOT_ENROLLED = 10 - } - - /** - * Indicates the enumeration of prompt codes in the process of face authentication. - * @since 8 - */ - enum FaceTips { - /** - * Indicates that the obtained facial image is too bright due to high illumination. - * @since 8 - */ - FACE_AUTH_TIP_TOO_BRIGHT = 1, - - /** - * Indicates that the obtained facial image is too dark due to low illumination. - * @since 8 - */ - FACE_AUTH_TIP_TOO_DARK = 2, - - /** - * Indicates that the face is too close to the device. - * @since 8 - */ - FACE_AUTH_TIP_TOO_CLOSE = 3, - - /** - * Indicates that the face is too far away from the device. - * @since 8 - */ - FACE_AUTH_TIP_TOO_FAR = 4, - - /** - * Indicates that the device is too high, and that only the upper part of the face is captured. - * @since 8 - */ - FACE_AUTH_TIP_TOO_HIGH = 5, - - /** - * Indicates that the device is too low, and that only the lower part of the face is captured. - * @since 8 - */ - FACE_AUTH_TIP_TOO_LOW = 6, - - /** - * Indicates that the device is deviated to the right, and that only the right part of the face is captured. - * @since 8 - */ - FACE_AUTH_TIP_TOO_RIGHT = 7, - - /** - * Indicates that the device is deviated to the left, and that only the left part of the face is captured. - * @since 8 - */ - FACE_AUTH_TIP_TOO_LEFT = 8, - - /** - * Indicates that the face moves too fast during facial information collection. - * @since 8 - */ - FACE_AUTH_TIP_TOO_MUCH_MOTION = 9, - - /** - * Indicates that the face is not facing the device. - * @since 8 - */ - FACE_AUTH_TIP_POOR_GAZE = 10, - - /** - * Indicates that no face is detected. - * @since 8 - */ - FACE_AUTH_TIP_NOT_DETECTED = 11, - } - - /** - * Indicates the enumeration of prompt codes in the process of fingerprint authentication. - * @since 8 - */ - enum FingerprintTips { - /** - * Indicates that the image acquired is good. - * @since 8 - */ - FINGERPRINT_AUTH_TIP_GOOD = 0, - - /** - * Indicates that the fingerprint image is too noisy due to suspected or detected dirt on sensor. - * @since 8 - */ - FINGERPRINT_AUTH_TIP_DIRTY = 1, - - /** - * Indicates that the fingerprint image is too noisy to process due to a detected condition. - * @since 8 - */ - FINGERPRINT_AUTH_TIP_INSUFFICIENT = 2, - - /** - * Indicates that only a partial fingerprint image is detected. - * @since 8 - */ - FINGERPRINT_AUTH_TIP_PARTIAL = 3, - - /** - * Indicates that the fingerprint image is incomplete due to quick motion. - * @since 8 - */ - FINGERPRINT_AUTH_TIP_TOO_FAST = 4, - - /** - * Indicates that the fingerprint image is unreadable due to lack of motion. - * @since 8 - */ - FINGERPRINT_AUTH_TIP_TOO_SLOW = 5 - } - - /** - * Credential type for authentication. - */ - enum AuthType { - /** - * Authentication type face. - * @since 8 - */ - FACE = 2, - - /** - * Authentication type fingerprint. - * @since 8 - */ - FINGERPRINT = 4 - } - - /** - * Trust level of authentication results. - */ - enum AuthTrustLevel { - /** - * Authentication result trusted level 1. - * @since 8 - */ - ATL1 = 10000, - - /** - * Authentication result trusted level 2. - * @since 8 - */ - ATL2 = 20000, - - /** - * Authentication result trusted level 3. - * @since 8 - */ - ATL3 = 30000, - - /** - * Authentication result trusted level 4. - * @since 8 - */ - ATL4 = 40000 - } -} - -export default userIAM; \ No newline at end of file diff --git a/api/@ohos.userIAM.userAuth.d.ts b/api/@ohos.userIAM.userAuth.d.ts index 28d4884df2..b93bd46de5 100644 --- a/api/@ohos.userIAM.userAuth.d.ts +++ b/api/@ohos.userIAM.userAuth.d.ts @@ -327,6 +327,331 @@ declare namespace userAuth { * @return Returns an Authenticator. */ function getAuthenticator(): Authenticator; + + /** + * User authentication. + * @since 8 + */ + class UserAuth { + /** + * Constructor to get the UserAuth class instance. + * @since 8 + * @SysCap SystemCapability.UserIAM.UserAuth + * @return Returns the UserAuth class instance. + */ + constructor(); + + /** + * Get version information. + * @since 8 + * @SysCap SystemCapability.UserIAM.UserAuth + * @return Returns version information. + */ + getVersion() : number; + + /** + * Check whether the authentication capability is available. + * @since 8 + * @SysCap SystemCapability.UserIAM.UserAuth + * @permission ohos.permission.ACCESS_BIOMETRIC + * @param authType Credential type for authentication. + * @param authTrustLevel Trust level of authentication result. + * @return Returns a check result, which is specified by getAvailabeStatus. + */ + getAvailabeStatus(authType : AuthType, authTrustLevel : AuthTrustLevel) : number; + + /** + * Executes authentication. + * @since 8 + * @SysCap SystemCapability.UserIAM.UserAuth + * @permission ohos.permission.ACCESS_BIOMETRIC + * @param challenge pass in challenge value. + * @param authType type of authentication. + * @param authTrustLevel Trust level of authentication result. + * @param callback Return result and acquireinfo through callback. + * @return Returns ContextId for cancel. + */ + auth(challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array; + + /** + * Cancels authentication with ContextID. + * @since 8 + * @SysCap SystemCapability.UserIAM.UserAuth + * @permission ohos.permission.ACCESS_BIOMETRIC + * @param contextID Cancel authentication and pass in ContextID. + * @return Returns a number value indicating whether Cancel authentication was successful. + */ + cancelAuth(contextID : Uint8Array) : number; + } + + interface IUserAuthCallback { + /** + * The authentication result code is returned through the callback. + * @since 8 + * @param result authentication result code. + * @param extraInfo pass the specific information for different situation. + * If the authentication is passed, the authentication token is returned in extrainfo, + * If the authentication fails, the remaining authentication times are returned in extrainfo, + * If the authentication executor is locked, the freezing time is returned in extrainfo. + */ + onResult: (result : number, extraInfo : AuthResult) => void; + + /** + * During an authentication, the TipsCode is returned through the callback. + * @since 8 + * @param module the executor type for authentication. + * @param acquire the tip code for different authentication executor. + * @param extraInfo reserved parameter. + */ + onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void; + } + + /** + * Authentication result: authentication token, remaining authentication times, freezing time. + * @since 8 + * @param token pass the authentication result if the authentication is passed. + * @param remainTimes return the remaining authentication times if the authentication fails. + * @param freezingTime return the freezing time if the authectication executor is locked. + */ + interface AuthResult { + token ?: Uint8Array; + remainTimes ?: number; + freezingTime ?: number; + } + + /** + * Result code. + * @since 8 + */ + enum ResultCode { + /** + * Indicates that the result is success or ability is supported. + * @since 8 + */ + SUCCESS = 0, + + /** + * Indicates the the result is failure or ability is not supported. + * @since 8 + */ + FAIL = 1, + + /** + * Indicates other errors. + * @since 8 + */ + GENERAL_ERROR = 2, + + /** + * Indicates that this operation has been canceled. + * @since 8 + */ + CANCELED = 3, + + /** + * Indicates that this operation has timed out. + * @since 8 + */ + TIMEOUT = 4, + + /** + * Indicates that this authentication type is not supported. + * @since 8 + */ + TYPE_NOT_SUPPORT = 5, + + /** + * Indicates that the authentication trust level is not supported. + * @since 8 + */ + TRUST_LEVEL_NOT_SUPPORT = 6, + + /** + * Indicates that the authentication task is busy. Wait for a few seconds and try again. + * @since 8 + */ + BUSY = 7, + + /** + * Indicates incorrect parameters. + * @since 8 + */ + INVALID_PARAMETERS = 8, + + /** + * Indicates that the authenticator is locked. + * @since 8 + */ + LOCKED = 9, + + /** + * Indicates that the user has not enrolled the authenticator. + * @since 8 + */ + NOT_ENROLLED = 10 + } + + /** + * Indicates the enumeration of prompt codes in the process of face authentication. + * @since 8 + */ + enum FaceTips { + /** + * Indicates that the obtained facial image is too bright due to high illumination. + * @since 8 + */ + FACE_AUTH_TIP_TOO_BRIGHT = 1, + + /** + * Indicates that the obtained facial image is too dark due to low illumination. + * @since 8 + */ + FACE_AUTH_TIP_TOO_DARK = 2, + + /** + * Indicates that the face is too close to the device. + * @since 8 + */ + FACE_AUTH_TIP_TOO_CLOSE = 3, + + /** + * Indicates that the face is too far away from the device. + * @since 8 + */ + FACE_AUTH_TIP_TOO_FAR = 4, + + /** + * Indicates that the device is too high, and that only the upper part of the face is captured. + * @since 8 + */ + FACE_AUTH_TIP_TOO_HIGH = 5, + + /** + * Indicates that the device is too low, and that only the lower part of the face is captured. + * @since 8 + */ + FACE_AUTH_TIP_TOO_LOW = 6, + + /** + * Indicates that the device is deviated to the right, and that only the right part of the face is captured. + * @since 8 + */ + FACE_AUTH_TIP_TOO_RIGHT = 7, + + /** + * Indicates that the device is deviated to the left, and that only the left part of the face is captured. + * @since 8 + */ + FACE_AUTH_TIP_TOO_LEFT = 8, + + /** + * Indicates that the face moves too fast during facial information collection. + * @since 8 + */ + FACE_AUTH_TIP_TOO_MUCH_MOTION = 9, + + /** + * Indicates that the face is not facing the device. + * @since 8 + */ + FACE_AUTH_TIP_POOR_GAZE = 10, + + /** + * Indicates that no face is detected. + * @since 8 + */ + FACE_AUTH_TIP_NOT_DETECTED = 11, + } + + /** + * Indicates the enumeration of prompt codes in the process of fingerprint authentication. + * @since 8 + */ + enum FingerprintTips { + /** + * Indicates that the image acquired is good. + * @since 8 + */ + FINGERPRINT_AUTH_TIP_GOOD = 0, + + /** + * Indicates that the fingerprint image is too noisy due to suspected or detected dirt on sensor. + * @since 8 + */ + FINGERPRINT_AUTH_TIP_DIRTY = 1, + + /** + * Indicates that the fingerprint image is too noisy to process due to a detected condition. + * @since 8 + */ + FINGERPRINT_AUTH_TIP_INSUFFICIENT = 2, + + /** + * Indicates that only a partial fingerprint image is detected. + * @since 8 + */ + FINGERPRINT_AUTH_TIP_PARTIAL = 3, + + /** + * Indicates that the fingerprint image is incomplete due to quick motion. + * @since 8 + */ + FINGERPRINT_AUTH_TIP_TOO_FAST = 4, + + /** + * Indicates that the fingerprint image is unreadable due to lack of motion. + * @since 8 + */ + FINGERPRINT_AUTH_TIP_TOO_SLOW = 5 + } + + /** + * Credential type for authentication. + * @since 8 + */ + enum UserAuthType { + /** + * Authentication type face. + * @since 8 + */ + FACE = 2, + + /** + * Authentication type fingerprint. + * @since 8 + */ + FINGERPRINT = 4 + } + + /** + * Trust level of authentication results. + * @since 8 + */ + enum AuthTrustLevel { + /** + * Authentication result trusted level 1. + * @since 8 + */ + ATL1 = 10000, + + /** + * Authentication result trusted level 2. + * @since 8 + */ + ATL2 = 20000, + + /** + * Authentication result trusted level 3. + * @since 8 + */ + ATL3 = 30000, + + /** + * Authentication result trusted level 4. + * @since 8 + */ + ATL4 = 40000 + } } export default userAuth; -- Gitee