mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2025-04-12 01:57:02 +00:00
!18265 JSDOC 接口一致性描述整改
Merge pull request !18265 from Abonadon_hk/master
This commit is contained in:
openharmony_ci
Gitee
commit
cd4d17ca66
41
api/@ohos.userIAM.userAuth.d.ts
vendored
41
api/@ohos.userIAM.userAuth.d.ts
vendored
@ -37,7 +37,7 @@ import type { AsyncCallback } from './@ohos.base';
|
||||
*/
|
||||
declare namespace userAuth {
|
||||
/**
|
||||
* The maximum allowable reuse duration is 300000 milliseconds.
|
||||
* Represents the maximum period for which the device unlocking result can be reused.
|
||||
*
|
||||
* @constant
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
@ -673,7 +673,7 @@ declare namespace userAuth {
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Credential type for authentication.
|
||||
* Enumerates the identity authentication types.
|
||||
*
|
||||
* @enum { number }
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
@ -744,7 +744,7 @@ declare namespace userAuth {
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Trust level of authentication results.
|
||||
* Enumerates the trust levels of the authentication result.
|
||||
*
|
||||
* @enum { number }
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
@ -1022,7 +1022,7 @@ declare namespace userAuth {
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Check whether the authentication capability is available.
|
||||
* Checks whether the specified authentication capability is supported.
|
||||
*
|
||||
* @permission ohos.permission.ACCESS_BIOMETRIC
|
||||
* @param { UserAuthType } authType - Credential type for authentication.
|
||||
@ -1042,7 +1042,7 @@ declare namespace userAuth {
|
||||
function getAvailableStatus(authType: UserAuthType, authTrustLevel: AuthTrustLevel): void;
|
||||
|
||||
/**
|
||||
* Enrolled state.
|
||||
* Represents information about the enrolled credentials.
|
||||
*
|
||||
* @typedef EnrolledState
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
@ -1072,7 +1072,7 @@ declare namespace userAuth {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the state of enrolled credentials which varies as credentials change.
|
||||
* Obtains information about the credentials enrolled. With this API, you can obtain the change of the credentials.
|
||||
*
|
||||
* @permission ohos.permission.ACCESS_BIOMETRIC
|
||||
* @param { UserAuthType } authType - Credential type for authentication.
|
||||
@ -1136,7 +1136,7 @@ declare namespace userAuth {
|
||||
}
|
||||
|
||||
/**
|
||||
* The mode for reusing unlock authentication result.
|
||||
* Represents the mode for reusing the device unlocking result.
|
||||
*
|
||||
* @enum { number }
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
@ -1187,7 +1187,7 @@ declare namespace userAuth {
|
||||
}
|
||||
|
||||
/**
|
||||
* Reuse unlock authentication result.
|
||||
* Represents the device unlocking result.
|
||||
*
|
||||
* @typedef ReuseUnlockResult
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
@ -1224,7 +1224,7 @@ declare namespace userAuth {
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* Auth parameter.
|
||||
* Defines the user authentication parameters.
|
||||
*
|
||||
* @typedef AuthParam
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
@ -1312,7 +1312,7 @@ declare namespace userAuth {
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* Auth widget parameter.
|
||||
* Represents the information presented on the user authentication page.
|
||||
*
|
||||
* @typedef WidgetParam
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
@ -1385,7 +1385,7 @@ declare namespace userAuth {
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* Authentication result: authentication token, credential type for authentication succeed.
|
||||
* Defines the user authentication result. If the authentication is successful, the authentication type and token information are returned.
|
||||
*
|
||||
* @typedef UserAuthResult
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
@ -1464,7 +1464,7 @@ declare namespace userAuth {
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* Asynchronous callback of authentication operation.
|
||||
* Provides callbacks to return the authentication result.
|
||||
*
|
||||
* @interface IAuthCallback
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
@ -1481,8 +1481,7 @@ declare namespace userAuth {
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* The authentication result code is returned through the callback.
|
||||
* If the authentication is passed, the authentication token is returned in extraInfo.
|
||||
* Called to return the authentication result. If the authentication is successful, the token information can be obtained from UserAuthResult.
|
||||
*
|
||||
* @param { UserAuthResult } result - Authentication result information.
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
@ -1500,7 +1499,8 @@ declare namespace userAuth {
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* User authentication instance, used to initiate a complete authentication.
|
||||
* Provides APIs for user authentication. The user authentication widget is supported.
|
||||
* Before using the APIs, you need to obtain a UserAuthInstance instance by using getUserAuthInstance.
|
||||
*
|
||||
* @interface UserAuthInstance
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
@ -1522,7 +1522,7 @@ declare namespace userAuth {
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* Turn on widget authentication result event listening.
|
||||
* Subscribes to the user authentication result.
|
||||
*
|
||||
* @param { 'result' } type - Indicates the type of event.
|
||||
* @param { IAuthCallback } callback - Indicates the listener.
|
||||
@ -1551,7 +1551,7 @@ declare namespace userAuth {
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* Turn off widget authentication result event listening.
|
||||
* Unsubscribes from the user authentication result. The UserAuthInstance instance used to invoke this API must be the one used to subscribe to the event.
|
||||
*
|
||||
* @param { 'result' } type - Indicates the type of event.
|
||||
* @param { IAuthCallback } callback - Indicates the listener.
|
||||
@ -1622,7 +1622,7 @@ declare namespace userAuth {
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* Cancel this authentication.
|
||||
* Cancel this authentication, userAuthInstance must be the instance being authenticated.
|
||||
*
|
||||
* @permission ohos.permission.ACCESS_BIOMETRIC
|
||||
* @throws { BusinessError } 201 - Permission verification failed.
|
||||
@ -1653,7 +1653,8 @@ declare namespace userAuth {
|
||||
* @since 10
|
||||
*/
|
||||
/**
|
||||
* Get user authentication instance with widget.
|
||||
* Obtains a UserAuthInstance instance for user authentication. The user authentication widget is also supported.
|
||||
* A UserAuthInstance instance can be used for an authentication only once.
|
||||
*
|
||||
* @param { AuthParam } authParam - Auth parameter.
|
||||
* @param { WidgetParam } widgetParam - Widget parameter.
|
||||
@ -1717,7 +1718,7 @@ declare namespace userAuth {
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Enum for operation result.
|
||||
* Enumerates the authentication result codes.
|
||||
*
|
||||
* @enum { number }
|
||||
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user