Input Monitor

NOTE

• The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

• The APIs of this module are system APIs and cannot be called by third-party applications.

Modules to Import

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

Permissions

ohos.permission.INPUT_MONITORING

inputMonitor.on

on(type: "touch", receiver: TouchEventReceiver): void

Starts listening for global input events.

Required permissions: ohos.permission.INPUT_MONITORING

System capability: SystemCapability.MultimodalInput.Input.InputMonitor

Parameters

Example

export default {
    callback: function (value) {
        if (checkEvent(value)) {
            // The event meets the service requirement and is consumed.
            return true;
        } else {
            // The event does not meet the service requirement and is not consumed.
            return false;
        }
    },
    testOn: function () {
        console.info("InputMonitorJsTest---start---testOn");
        inputMonitor.on(
            "touch",
            this.callback
        );
        console.info("InputMonitorJsTest---end---testOn");
    }
}

inputMonitor.off

off(type: "touch", receiver?: TouchEventReceiver): void

Stops listening for global input events.

Required permissions: ohos.permission.INPUT_MONITORING

System capability: SystemCapability.MultimodalInput.Input.InputMonitor

Parameters

Example

export default {
    callback: function (value) {
        if (checkEvent(value)) {
            // The event meets the service requirement and is consumed.
            return true;
        } else {
            // The event does not meet the service requirement and is not consumed.
            return false;
        }
    },
    testOff: function () {
        console.info("InputMonitorJsTest---start---testOff");
        inputMonitor.off(
            "touch",
            this.callback
        );
        console.info("InputMonitorJsTest---end---testOff");
    }
  }

TouchEventReceiver

Represents the class of the callback used to return the touch event. The value true indicates that the touch event has been consumed, and the value false indicates the opposite.

(touchEvent: TouchEvent): Boolean

Represents the callback used to return the touch event. You need to define the name of the callback function in the correct format. Ensure that the input parameter is of the TouchEvent type, and the return value is of the Boolean type.

System capability: SystemCapability.MultimodalInput.Input.InputMonitor

Parameters

Return value

Example

export default {
    callback: function (value) {  // Implementation of the (touchEvent:TouchEvent): Boolean API.
        if (checkEvent(value)) {
            // The event meets the service requirement and is consumed.
            return true;
        } else {
            // The event does not meet the service requirement and is not consumed.
            return false;
        }
    },
    testOff: function () {
        console.info("InputMonitorJsTest---start---testOff");
        inputMonitor.off(
            "touch",
            this.callback
        );
        console.info("InputMonitorJsTest---end---testOff");
    }
}