notification - 通知


notification - 通知

Notification即通知,是指在通知栏显示的消息。以一种醒目的方式及时提醒用户一些重要的信息,用户可以点击通知打开应用或直接从通知中执行操作。

此模块提供了显示通知、在获得用户授权的情况下监听其他应用的通知等功能。

要导入此模块,请使用语句const notification = require('notification');

目录

接口

函数

函数

cancel

cancel(id): void

根据通知id取消通知。此函数只能取消本应用发出的通知,也即通过notify函数显示的通知。要获取和取消其他应用的通知,请通过requestListeningNotifications

参数

名称类型描述
idnumbernotify通知时传入的id,参见notify

返回值

void


goToNotificationListenerSettings

goToNotificationListenerSettings(): void

跳转通知权限设置页面。

返回值

void


notify

notify(id, n): void

根据通知选项创建通知,并显示通知。参数id是通知的唯一标识,若之前已经有相同id的通知,再次调用notify则会更新该通知。id也可用于取消通知。

示例

"nodejs";
const notification = require('notification');

const notificationId = 10001;
notification.notify(notificationId, {
    contentTitle: "点击触发一条新通知",
    contentText: "这是一条无法被用户清理的通知",
    ticker: "收到一条新通知",
    onContentClick: () => {
        showCounterNotification(0);
    },
    ongoing: true,
    autoCancel: true,
});

参数

名称类型描述
idnumber通知的唯一id,为了避免和Auto.js本身的通知冲突,建议从10000开始
nBuildNotificationOptions通知选项,包括标题、内容等,参见BuildNotificationOptions

返回值

void


requestListeningNotifications

requestListeningNotifications(options?): Promise<NotificationListenerService>

请求监听通知,使本应用获取通知监听服务的权限。返回通知监听服务NotificationListenerService的Promise对象。

示例

"nodejs";
const notification = require('notification');

async function main() {
    const notificationListenerService = await notification.requestListeningNotifications({
        toast: true,
    });
    console.log('listening notifications...');
    notificationListenerService.on("notification", n => {
        console.log("收到通知");
        console.log(`标题: ${n.getTitle()}, 文本: ${n.getText()}, 包名: ${n.getPackageName()}`);
    });

    $autojs.keepRunning();
}
main();

参数

名称类型描述
options?RequestListeningNotificationsOptions请求监听通知的选项,比如显示给用户的Toast信息

返回值

Promise<NotificationListenerService>