mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 06:03:30 +00:00
45e7c68ea8
Merge pull request !10994 from 任欣瑶/pr_10934
170 lines
5.5 KiB
TypeScript
170 lines
5.5 KiB
TypeScript
/*
|
|
* Copyright (c) 2023 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 InputKit
|
|
*/
|
|
|
|
import type { AsyncCallback } from './@ohos.base';
|
|
/**
|
|
* Declares interfaces related to short key attributes.
|
|
*
|
|
* @namespace shortKey
|
|
* @syscap SystemCapability.MultimodalInput.Input.ShortKey
|
|
* @systemapi hide for inner use
|
|
* @since 10
|
|
*/
|
|
|
|
declare namespace shortKey {
|
|
/**
|
|
* Sets short key down duration.
|
|
* @param { string } businessKey - The key for business which should be applied to MMI.
|
|
* @param { number } delay - Duration of short key press which should be limited to 0-4000ms.
|
|
* @param { AsyncCallback<void> } callback - Callback used to return the result.
|
|
* @throws { BusinessError } 202 - SystemAPI permission error.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.MultimodalInput.Input.ShortKey
|
|
* @systemapi hide for inner use
|
|
* @since 10
|
|
*/
|
|
function setKeyDownDuration(businessKey: string, delay: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Sets short key down duration.
|
|
* @param { string } businessKey - The key for business which should be applied to MMI.
|
|
* @param { number } delay - Duration of short key press which should be limited to 0-4000ms.
|
|
* @returns { Promise<void> } Returns the result through a promise.
|
|
* @throws { BusinessError } 202 - SystemAPI permission error.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.MultimodalInput.Input.ShortKey
|
|
* @systemapi hide for inner use
|
|
* @since 10
|
|
*/
|
|
function setKeyDownDuration(businessKey: string, delay: number): Promise<void>;
|
|
|
|
}
|
|
export default shortKey;
|
|
|
|
/**
|
|
* Enumerates fingerprint key event types.
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.MultimodalInput.Input.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 12
|
|
*/
|
|
export declare enum FingerprintAction {
|
|
/**
|
|
* Key touching.
|
|
*
|
|
* @syscap SystemCapability.MultimodalInput.Input.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 12
|
|
*/
|
|
DOWN = 0,
|
|
|
|
/**
|
|
* Finger lifting.
|
|
*
|
|
* @syscap SystemCapability.MultimodalInput.Input.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 12
|
|
*/
|
|
UP = 1,
|
|
|
|
/**
|
|
* Sliding on the fingerprint key.
|
|
*
|
|
* @syscap SystemCapability.MultimodalInput.Input.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 12
|
|
*/
|
|
SLIDE = 2,
|
|
|
|
/**
|
|
* Second touch during the double-click process.
|
|
*
|
|
* @syscap SystemCapability.MultimodalInput.Input.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 12
|
|
*/
|
|
RETOUCH = 3,
|
|
|
|
/**
|
|
* Double-click event.
|
|
*
|
|
* @syscap SystemCapability.MultimodalInput.Input.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 12
|
|
*/
|
|
CLICK = 4,
|
|
}
|
|
|
|
/**
|
|
* Fingerprint key event.
|
|
*
|
|
* @interface FingerprintEvent
|
|
* @syscap SystemCapability.MultimodalInput.Input.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 12
|
|
*/
|
|
export declare interface FingerprintEvent {
|
|
/**
|
|
* Fingerprint key event type.
|
|
*
|
|
* @type { FingerprintAction }
|
|
* @syscap SystemCapability.MultimodalInput.Input.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 12
|
|
*/
|
|
action: FingerprintAction;
|
|
|
|
/**
|
|
* This value indicates the sliding percentage of the fingerprint key on the X axis,
|
|
* that is, the ratio of the relative sliding distance to the device length
|
|
* compared with the previous report of the sliding event.
|
|
* A positive value indicates moving in the positive direction of the X axis,
|
|
* and a negative value indicates the opposite.
|
|
* The vertical upward direction of the device stands for the positive direction of the Y axis,
|
|
* and the horizontal rightward direction stands for the positive direction of the X axis.
|
|
* This way, a rectangular coordinate system is constructed.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.MultimodalInput.Input.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 12
|
|
*/
|
|
distanceX: number;
|
|
|
|
/**
|
|
* This value indicates the sliding percentage of the fingerprint key on the Y axis,
|
|
* that is, the ratio of the relative sliding distance to the component length
|
|
* compared with the previous report of the sliding event.
|
|
* A positive value indicates moving in the positive direction of the Y axis,
|
|
* and a negative value indicates the opposite.
|
|
* The vertical upward direction of the device stands for the positive direction of the Y axis,
|
|
* and the horizontal rightward direction stands for the positive direction of the X axis.
|
|
* This way, a rectangular coordinate system is constructed.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.MultimodalInput.Input.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 12
|
|
*/
|
|
distanceY: number;
|
|
} |