mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 06:03:30 +00:00
88 lines
2.5 KiB
Plaintext
88 lines
2.5 KiB
Plaintext
/*
|
|
* Copyright (c) 2024 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.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @kit UserAuthenticationKit
|
|
*/
|
|
|
|
import userAuth from '@ohos.userIAM.userAuth';
|
|
|
|
/**
|
|
* Declare UserAuthIcon, use for user authentication.
|
|
*
|
|
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
|
* @since 12
|
|
*/
|
|
@Component
|
|
export default struct UserAuthIcon {
|
|
/**
|
|
* Set user auth parameter.
|
|
*
|
|
* @type { userAuth.AuthParam }
|
|
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
|
* @since 12
|
|
*/
|
|
authParam: userAuth.AuthParam;
|
|
|
|
/**
|
|
* Set auth widget parameter.
|
|
*
|
|
* @type { userAuth.WidgetParam }
|
|
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
|
* @since 12
|
|
*/
|
|
widgetParam: userAuth.WidgetParam;
|
|
|
|
/**
|
|
* Set the height of the icon, width and height ratio 1:1.
|
|
*
|
|
* @type { ?Dimension }
|
|
* @default 64
|
|
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
|
* @since 12
|
|
*/
|
|
iconHeight?: Dimension;
|
|
|
|
/**
|
|
* Set the color of the icon.
|
|
*
|
|
* @type { ?ResourceColor }
|
|
* @default $r('sys.color.ohos_id_color_activated')
|
|
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
|
* @since 12
|
|
*/
|
|
iconColor?: ResourceColor;
|
|
|
|
/**
|
|
* The authentication result code is returned through the callback.
|
|
* If the authentication is passed, the authentication token and auth type will be returned.
|
|
* You need to apply for permission:ohos.permission.ACCESS_BIOMETRIC to use user authentication ability.
|
|
*
|
|
* @param { userAuth.UserAuthResult } result - Authentication result information.
|
|
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
|
* @since 12
|
|
*/
|
|
onAuthResult: (result: userAuth.UserAuthResult) => void;
|
|
|
|
/**
|
|
* When user click the icon, it will be returned through this callback.
|
|
*
|
|
* @syscap SystemCapability.UserIAM.UserAuth.Core
|
|
* @since 12
|
|
*/
|
|
onIconClick?: () => void;
|
|
}
|