Input Monitor
The input monitor module implements listening for global touch events.
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 touch events.
This is a system API.
Required permissions: ohos.permission.INPUT_MONITORING
System capability: SystemCapability.MultimodalInput.Input.InputMonitor
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Type of the input event to listen for. The value is touch. |
receiver | TouchEventReceiver | Yes | Callback used to return the touch event. |
Example
inputMonitor.off("touch", (event) => {
// A touch event is consumed.
return false;
});
inputMonitor.off
off(type: "touch", receiver?: TouchEventReceiver): void
Stops listening for global touch events.
This is a system API.
Required permissions: ohos.permission.INPUT_MONITORING
System capability: SystemCapability.MultimodalInput.Input.InputMonitor
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Type of the input event to listen for. The value is touch. |
receiver | TouchEventReceiver | No | Callback used to return the touch event. |
Example
inputMonitor.off("touch");
TouchEventReceiver
Represents the class of the callback used to return the touch event. If the value true is returned, the touch event has been consumed, and the event monitor will be closed.
This is a system API.
System capability: SystemCapability.MultimodalInput.Input.InputMonitor
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
touchEvent | TouchEvent | Yes | Callback used to return the touch event. |
Return value
Type | Description |
---|---|
Boolean | Result indicating whether the touch event has been consumed by the input monitor. The value true indicates that the touch event has been consumed, and the value false indicates the opposite. |
Example
inputMonitor.on("touch", (event) => {
// A touch event is consumed.
return false;
});
inputMonitor.off("touch");