Stability: 2 - Stable
events 本身是一个EventEmitter。
需要注意的是,事件的处理是单线程的,并且仍然在原线程执行,如果脚本主体或者其他事件处理中有耗时操作、轮询等,则事件将无法得到及时处理(会进入事件队列等待脚本主体或其他事件处理完成才执行)。
events.emitter()返回一个新的EventEmitter。这个 EventEmitter 没有内置任何事件。
事件: 'exit`当脚本正常或者异常退出时会触发该事件。事件处理中如果有异常抛出,则立即中止 exit 事件的处理(即使 exit 事件有多个处理函数)并在控制台和日志中打印该异常。
一个脚本停止运行时,会关闭该脚本的所有悬浮窗,触发 exit 事件,之后再回收资源。如果 exit 事件的处理中有死循环,则后续资源无法得到及时回收。 此时脚本会停留在任务列表,如果在任务列表中关闭,则会强制结束 exit 事件的处理并回收后续资源。
log("开始运行");
events.on("exit", function () {
log("结束运行");
});
log("即将结束运行");events.observeKey()启用按键监听,例如音量键、Home 键。按键监听使用无障碍服务实现,如果无障碍服务未启用会抛出异常并提示开启。
只有这个函数成功执行后, onKeyDown, onKeyUp等按键事件的监听才有效。
该函数在安卓 4.3 以上才能使用。
events.onKeyDown(keyName, listener)keyName {string} 要监听的按键名称listener {Function} 按键监听器。参数为一个KeyEvent。注册一个按键监听函数,当有 keyName 对应的按键被按下会调用该函数。可用的按键名称参见Keys。
例如:
//启用按键监听
events.observeKey();
//监听音量上键按下
events.onKeyDown("volume_up", function (event) {
toast("音量上键被按下了");
});
//监听菜单键按下
events.onKeyDown("menu", function (event) {
toast("菜单键被按下了");
exit();
});events.onKeyUp(keyName, listener)keyName {string} 要监听的按键名称listener {Function} 按键监听器。参数为一个KeyEvent。注册一个按键监听函数,当有 keyName 对应的按键弹起会调用该函数。可用的按键名称参见Keys。
一次完整的按键动作包括了按键按下和弹起。按下事件会在手指按下一个按键的"瞬间"触发, 弹起事件则在手指放开这个按键时触发。
例如:
//启用按键监听
events.observeKey();
//监听音量下键弹起
events.onKeyUp("volume_down", function (event) {
toast("音量下键弹起");
});
//监听Home键弹起
events.onKeyUp("home", function (event) {
toast("Home键弹起");
exit();
});events.onceKeyDown(keyName, listener)keyName {string} 要监听的按键名称listener {Function} 按键监听器。参数为一个KeyEvent。注册一个按键监听函数,当有 keyName 对应的按键被按下时会调用该函数,之后会注销该按键监听器。
也就是 listener 只有在 onceKeyDown 调用后的第一次按键事件被调用一次。
events.onceKeyUp(keyName, listener)keyName {string} 要监听的按键名称listener {Function} 按键监听器。参数为一个KeyEvent。注册一个按键监听函数,当有 keyName 对应的按键弹起时会调用该函数,之后会注销该按键监听器。
也就是 listener 只有在 onceKeyUp 调用后的第一次按键事件被调用一次。
events.removeAllKeyDownListeners(keyName)keyName {string} 按键名称删除该按键的 KeyDown(按下)事件的所有监听。
events.removeAllKeyUpListeners(keyName)keyName {string} 按键名称删除该按键的 KeyUp(弹起)事件的所有监听。
events.setKeyInterceptionEnabled(enabled, key)enabled {boolean} 是否启用按键屏蔽key {string} 要屏蔽的按键设置按键屏蔽是否启用。所谓按键屏蔽指的是,屏蔽原有按键的功能,例如使得音量键不再能调节音量,但此时仍然能通过按键事件监听按键。
如果不加参数 key 则会屏蔽所有按键。
例如,调用events.setKeyInterceptionEnabled(true)会使系统的音量、Home、返回等键不再具有调节音量、回到主页、返回的作用,但此时仍然能通过按键事件监听按键。
该函数通常于按键监听结合,例如想监听音量键并使音量键按下时不弹出音量调节框则为:
events.setKeyInterceptionEnabled("volume_up", true);
events.observeKey();
events.onKeyDown("volume_up", () => {
log("音量上键被按下");
});只要有一个脚本屏蔽了某个按键,该按键便会被屏蔽;当脚本退出时,会自动解除所有按键屏蔽。
events.observeTouch()启用屏幕触摸监听。(需要 root 权限)
只有这个函数被成功执行后, 触摸事件的监听才有效。
没有 root 权限调用该函数则什么也不会发生。
events.setTouchEventTimeout(timeout)timeout {number} 两个触摸事件的最小间隔。单位毫秒。默认为 10 毫秒。如果 number 小于 0,视为 0 处理。设置两个触摸事件分发的最小时间间隔。
例如间隔为 10 毫秒的话,前一个触摸事件发生并被注册的监听器处理后,至少要过 10 毫秒才能分发和处理下一个触摸事件,这 10 毫秒之间的触摸将会被忽略。
建议在满足需要的情况下尽量提高这个间隔。一个简单滑动动作可能会连续触发上百个触摸事件,如果 timeout 设置过低可能造成事件拥堵。强烈建议不要设置 timeout 为 0。
events.getTouchEventTimeout()返回 {number}返回触摸事件的最小时间间隔。
events.onTouch(listener)listener {Function} 参数为Point的函数注册一个触摸监听函数。相当于on("touch", listener)。
例如:
//启用触摸监听
events.observeTouch();
//注册触摸监听器
events.onTouch(function (p) {
//触摸事件发生时, 打印出触摸的点的坐标
log(p.x + ", " + p.y);
});events.removeAllTouchListeners()删除所有触摸事件监听函数。
events.observeNotification()开启通知监听。例如 QQ 消息、微信消息、推送等通知。
通知监听依赖于通知服务,如果通知服务没有运行,会抛出异常并跳转到通知权限开启界面。(有时即使通知权限已经开启通知服务也没有运行,这时需要关闭权限再重新开启一次)
例如:
events.observeNotification();
events.on("notification", function (notification) {
log(notification.getText());
});事件: 'notification'当有通知出现时会触发该事件。例如 QQ 消息、微信消息、推送等通知。
events.observeNotification();
events.on("notification", function (notification) {
log("通知标题: " + notification.getTitle());
log("通知内容: " + notification.getText());
log("通知包名: " + notification.getPackageName());
});events.observeToast()开启 Toast 监听。
Toast 监听依赖于无障碍服务,因此此函数会确保无障碍服务运行。
事件: 'toast'当有 Toast 出现时会触发该事件。
events.observeToast();
events.on("toast", function (event) {
log("Toast内容: " + event.getText());
log("Toast包名: " + event.getPackageName());
});事件: 'key'当有按键事件时会触发该事件。需要先调用events.observeKey()启用按键监听。
events.observeKey();
events.on("key", function (event) {
log("按键: " + event.getKeyCode());
});事件: 'key_down'当有按键按下时会触发该事件。需要先调用events.observeKey()启用按键监听。
事件: 'key_up'当有按键弹起时会触发该事件。需要先调用events.observeKey()启用按键监听。
EventEmitterStability: 2 - Stable
EventEmitter.defaultMaxListeners每个事件默认可以注册最多 10 个监听器。 单个 EventEmitter 实例的限制可以使用 emitter.setMaxListeners(n) 方法改变。 所有 EventEmitter 实例的默认值可以使用 EventEmitter.defaultMaxListeners 属性改变。
设置 EventEmitter.defaultMaxListeners 要谨慎,因为会影响所有 EventEmitter 实例,包括之前创建的。 因而,调用 emitter.setMaxListeners(n) 优先于 EventEmitter.defaultMaxListeners。
注意,与 Node.js 不同,这是一个硬性限制。 EventEmitter 实例不允许添加更多的监听器,监听器超过最大数量时会抛出 TooManyListenersException。
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once("event", () => {
// 做些操作
emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});EventEmitter.addListener(eventName, listener)eventName {any}listener {Function}emitter.on(eventName, listener) 的别名。
EventEmitter.emit(eventName[, ...args])eventName {any}args {any}按监听器的注册顺序,同步地调用每个注册到名为 eventName 事件的监听器,并传入提供的参数。
如果事件有监听器,则返回 true ,否则返回 false。
EventEmitter.eventNames()返回一个列出触发器已注册监听器的事件的数组。 数组中的值为字符串或符号。
const myEE = events.emitter();
myEE.on('foo', () => \{\});
myEE.on('bar', () => \{\});
const sym = Symbol('symbol');
myEE.on(sym, () => \{\});
console.log(myEE.eventNames());
// 打印: [ 'foo', 'bar', Symbol(symbol) ]EventEmitter.getMaxListeners()返回 EventEmitter 当前的最大监听器限制值,该值可以通过 emitter.setMaxListeners(n) 设置或默认为 EventEmitter.defaultMaxListeners。
EventEmitter.listenerCount(eventName)eventName {string} 正在被监听的事件名返回正在监听名为 eventName 的事件的监听器的数量。
EventEmitter.listeners(eventName)eventName {string}返回名为 eventName 的事件的监听器数组的副本。
server.on("connection", (stream) => {
console.log("someone connected!");
});
console.log(util.inspect(server.listeners("connection")));
// 打印: [ [Function] ]EventEmitter.on(eventName, listener)eventName {any} 事件名listener {Function} 回调函数添加 listener 函数到名为 eventName 的事件的监听器数组的末尾。 不会检查 listener 是否已被添加。 多次调用并传入相同的 eventName 和 listener 会导致 listener 被添加与调用多次。
server.on("connection", (stream) => {
console.log("有连接!");
});返回一个 EventEmitter 引用,可以链式调用。
默认情况下,事件监听器会按照添加的顺序依次调用。 emitter.prependListener() 方法可用于将事件监听器添加到监听器数组的开头。
const myEE = events.emitter();
myEE.on("foo", () => console.log("a"));
myEE.prependListener("foo", () => console.log("b"));
myEE.emit("foo");
// 打印:
// b
// aEventEmitter.once(eventName, listener)#eventName {any} 事件名listener {Function} 回调函数添加一个单次 listener 函数到名为 eventName 的事件。 下次触发 eventName 事件时,监听器会被移除,然后调用。
server.once("connection", (stream) => {
console.log("首次调用!");
});返回一个 EventEmitter 引用,可以链式调用。
默认情况下,事件监听器会按照添加的顺序依次调用。 emitter.prependOnceListener() 方法可用于将事件监听器添加到监听器数组的开头。
const myEE = events.emitter();
myEE.once("foo", () => console.log("a"));
myEE.prependOnceListener("foo", () => console.log("b"));
myEE.emit("foo");
// 打印:
// b
// aEventEmitter.prependListener(eventName, listener)eventName {any} 事件名listener {Function} 回调函数添加 listener 函数到名为 eventName 的事件的监听器数组的开头。 不会检查 listener 是否已被添加。 多次调用并传入相同的 eventName 和 listener 会导致 listener 被添加与调用多次。
server.prependListener("connection", (stream) => {
console.log("有连接!");
});返回一个 EventEmitter 引用,可以链式调用。
EventEmitter.prependOnceListener(eventName, listener)eventName {any} 事件名listener {Function} 回调函数添加一个单次 listener 函数到名为 eventName 的事件的监听器数组的开头。 下次触发 eventName 事件时,监听器会被移除,然后调用。
server.prependOnceListener("connection", (stream) => {
console.log("首次调用!");
});返回一个 EventEmitter 引用,可以链式调用。
EventEmitter.removeAllListeners([eventName])eventName {any}移除全部或指定 eventName 的监听器。
注意,在代码中移除其他地方添加的监听器是一个不好的做法,尤其是当 EventEmitter 实例是其他组件或模块创建的。
返回一个 EventEmitter 引用,可以链式调用。
EventEmitter.removeListener(eventName, listener)eventName {any}listener {Function}从名为 eventName 的事件的监听器数组中移除指定的 listener。
const callback = (stream) => {
console.log("有连接!");
};
server.on("connection", callback);
// ...
server.removeListener("connection", callback);removeListener 最多只会从监听器数组里移除一个监听器实例。 如果任何单一的监听器被多次添加到指定 eventName 的监听器数组中,则必须多次调用 removeListener 才能移除每个实例。
注意,一旦一个事件被触发,所有绑定到它的监听器都会按顺序依次触发。 这意味着,在事件触发后、最后一个监听器完成执行前,任何 removeListener() 或 removeAllListeners() 调用都不会从 emit() 中移除它们。 随后的事件会像预期的那样发生。
const myEmitter = events.emitter();
const callbackA = () => {
console.log("A");
myEmitter.removeListener("event", callbackB);
};
const callbackB = () => {
console.log("B");
};
myEmitter.on("event", callbackA);
myEmitter.on("event", callbackB);
// callbackA 移除了监听器 callbackB,但它依然会被调用。
// 触发是内部的监听器数组为 [callbackA, callbackB]
myEmitter.emit("event");
// 打印:
// A
// B
// callbackB 被移除了。
// 内部监听器数组为 [callbackA]
myEmitter.emit("event");
// 打印:
// A因为监听器是使用内部数组进行管理的,所以调用它会改变在监听器被移除后注册的任何监听器的位置索引。 虽然这不会影响监听器的调用顺序,但意味着由 emitter.listeners() 方法返回的监听器数组副本需要被重新创建。
返回一个 EventEmitter 引用,可以链式调用。
EventEmitter.setMaxListeners(n)n {number}默认情况下,如果为特定事件添加了超过 10 个监听器,则 EventEmitter 会打印一个警告。 此限制有助于寻找内存泄露。 但是,并不是所有的事件都要被限为 10 个。 emitter.setMaxListeners() 方法允许修改指定的 EventEmitter 实例的限制。 值设为 Infinity(或 0)表明不限制监听器的数量。
返回一个 EventEmitter 引用,可以链式调用。
events.broadcast: 脚本间广播脚本间通信除了使用 engines 模块提供的ScriptEngine.emit()方法以外,也可以使用 events 模块提供的 broadcast 广播。
events.broadcast 本身是一个 EventEmitter,但它的事件是在脚本间共享的,所有脚本都能发送和监听这些事件;事件处理会在脚本主线程执行(后续可能加入函数onThisThread(eventName, ...args)来提供在其他线程执行的能力)。
例如在一个脚本发送一个广播 hello:
events.broadcast.emit("hello", "小明");在其他脚本中监听并处理:
events.broadcast.on("hello", function(name){
toast("你好, " + name);
});
//保持脚本运行
setInterval(()=>\{\}, 1000);KeyEvent按键事件对象,在按键监听器的回调函数中作为参数传入。
KeyEvent.getAction()返回 {number}返回事件的动作。包括:
KeyEvent.ACTION_DOWN 按下事件KeyEvent.ACTION_UP 弹起事件KeyEvent.getKeyCode()返回 {number}返回按键的键值。包括:
KeyEvent.KEYCODE_HOME 主页键KeyEvent.KEYCODE_BACK 返回键KeyEvent.KEYCODE_MENU 菜单键KeyEvent.KEYCODE_VOLUME_UP 音量上键KeyEvent.KEYCODE_VOLUME_DOWN 音量下键KeyEvent.getEventTime()返回 {number}返回事件发生的时间戳。
KeyEvent.getDownTime()返回 {number}返回最近一次按下事件的时间戳。如果本身是按下事件,则与getEventTime()相同。
KeyEvent.keyCodeToString(code)code {number} 键值返回 {string}把键值转换为字符串。例如 KEYCODE_HOME 转换为"KEYCODE_HOME"。
Notification通知对象,可以获取通知详情,包括通知标题、内容、发出通知的包名、时间等,也可以对通知进行操作,比如点击、删除。
Notification.number{number}通知数量。例如 QQ 连续收到两条消息时 number 为 2。
Notification.when{number}通知发出时间的时间戳,可以用于构造Date对象。例如:
events.observeNotification();
events.on("notification", function (n) {
log("通知时间为" + new Date(n.when));
});Notification.getPackageName()返回 {string}获取发出通知的应用包名。
Notification.getTitle()返回 {string | null}获取通知的标题。
Notification.getText()返回 {string | null}获取通知的内容。
Notification.click()点击该通知。例如对于一条 QQ 消息,点击会进入具体的聊天界面。
Notification.delete()返回 {boolean}删除该通知。该通知将从通知栏中消失。
ToastEventToast 事件对象,在 Toast 监听器的回调函数中作为参数传入。
ToastEvent.getText()返回 {string | null}获取 Toast 的文本内容。
ToastEvent.text{string | null}Toast 的文本内容(只读属性)。
ToastEvent.getPackageName()返回 {string}获取发出 Toast 的应用包名。
ToastEvent.packageName{string}发出 Toast 的应用包名(只读属性)。
Keys可用的按键名称,用于按键监听函数:
"home" 主页键"back" 返回键"menu" 菜单键"volume_up" 音量上键"volume_down" 音量下键
