组合按键

InputConsumer模块提供对按键事件的监听。

说明：

• 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

• 本模块接口均为系统接口，三方应用不支持调用。

导入模块

import inputConsumer from '@ohos.multimodalInput.inputConsumer';

inputConsumer.on

on(type: "key", keyOptions: KeyOptions, callback: Callback<KeyOptions>): void

开始监听组合按键事件, 当满足条件的组合按键输入事件发生时，将KeyOptions回调到入参callback表示的回调函数上。

此接口为系统接口。

参数：

示例：

let keyOptions = {preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0}
let callback = function(keyOptions) {
    console.info("preKeys: " + keyOptions.preKeys, "finalKey: " + keyOptions.finalKey,
                 "isFinalKeyDown: " + keyOptions.isFinalKeyDown, "finalKeyDownDuration: " + keyOptions.finalKeyDownDuration)
}
inputConsumer.on('key', keyOptions, callback);

inputConsumer.off

off(type: "key", keyOptions: KeyOptions, callback?: Callback<KeyOptions>): void

停止监听组合按键事件。

此接口为系统接口。

系统能力： SystemCapability.MultimodalInput.Input.InputConsumer

参数：

示例：

let keyOptions = {preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0}
let callback = function(keyOptions) {
    console.info("preKeys: " + keyOptions.preKeys, "finalKey: " + keyOptions.finalKey,
                 "isFinalKeyDown: " + keyOptions.isFinalKeyDown, "finalKeyDownDuration: " + keyOptions.finalKeyDownDuration)
}
inputConsumer.off('key', keyOptions, callback);

KeyOptions

组合键输入事件发生时，组合键满足的选项。

此接口为系统接口。

**系统能力：**SystemCapability.MultimodalInput.Input.InputConsumer