跳至主要内容

通知

每个操作系统都有自己的机制向用户显示通知。Electron 的通知 API 跨平台，但对于每个进程类型来说都是不同的。

如果您想要在主进程中使用渲染器进程 API，反之亦然，请考虑使用 进程间通信。

用法​

下面是两个示例，展示了如何为每个进程类型显示通知。

在主进程中显示通知​

主进程通知使用 Electron 的 通知模块 显示。使用此模块创建的通知对象不会显示，除非调用它们的 show() 实例方法。

主进程
const { Notification } = require('electron')

const NOTIFICATION_TITLE = 'Basic Notification'
const NOTIFICATION_BODY = 'Notification from the Main process'

new Notification({
  title: NOTIFICATION_TITLE,
  body: NOTIFICATION_BODY
}).show()

这是一个完整的示例，您可以使用 Electron Fiddle 打开它

docs/fiddles/features/notifications/main (29.1.4)在 Fiddle 中打开
const { app, BrowserWindow, Notification } = require('electron/main')

function createWindow () {
  const win = new BrowserWindow({
    width: 800,
    height: 600
  })

  win.loadFile('index.html')
}

const NOTIFICATION_TITLE = 'Basic Notification'
const NOTIFICATION_BODY = 'Notification from the Main process'

function showNotification () {
  new Notification({ title: NOTIFICATION_TITLE, body: NOTIFICATION_BODY }).show()
}

app.whenReady().then(createWindow).then(showNotification)

app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') {
    app.quit()
  }
})

app.on('activate', () => {
  if (BrowserWindow.getAllWindows().length === 0) {
    createWindow()
  }
})

在渲染器进程中显示通知​

可以使用 Web 通知 API 直接从渲染器进程显示通知。

渲染器进程
const NOTIFICATION_TITLE = 'Title'
const NOTIFICATION_BODY =
  'Notification from the Renderer process. Click to log to console.'
const CLICK_MESSAGE = 'Notification clicked'

new Notification(NOTIFICATION_TITLE, { body: NOTIFICATION_BODY }).onclick =
  () => console.log(CLICK_MESSAGE)

这是一个完整的示例，您可以使用 Electron Fiddle 打开它

docs/fiddles/features/notifications/renderer (29.1.4)在 Fiddle 中打开
const NOTIFICATION_TITLE = 'Title'
const NOTIFICATION_BODY = 'Notification from the Renderer process. Click to log to console.'
const CLICK_MESSAGE = 'Notification clicked!'

new window.Notification(NOTIFICATION_TITLE, { body: NOTIFICATION_BODY })
  .onclick = () => { document.getElementById('output').innerText = CLICK_MESSAGE }

平台注意事项​

虽然不同操作系统的代码和用户体验相似，但仍有一些细微差别。

Windows​

对于 Windows 上的通知，您的 Electron 应用程序需要有一个带有 AppUserModelID 的开始菜单快捷方式和一个相应的 ToastActivatorCLSID。

Electron 尝试自动处理 AppUserModelID 和 ToastActivatorCLSID。当 Electron 与 Squirrel.Windows 一起使用时（例如，如果您使用的是 electron-winstaller），快捷方式将自动正确设置。

在生产环境中，Electron 也会检测到使用了 Squirrel，并且会自动使用正确的值调用 app.setAppUserModelId()。在开发过程中，您可能需要自己调用 app.setAppUserModelId()。

开发中的通知

为了在开发过程中快速启动通知，将 node_modules\electron\dist\electron.exe 添加到您的开始菜单也可以解决问题。在资源管理器中导航到该文件，右键单击并“固定到开始菜单”。然后，在主进程中调用 app.setAppUserModelId(process.execPath) 以查看通知。

使用高级通知​

Windows 还允许使用自定义模板、图像和其他灵活元素的高级通知。

要从主进程发送这些通知，您可以使用用户空间模块 electron-windows-notifications，它使用本机 Node 插件来发送 ToastNotification 和 TileNotification 对象。

虽然包含按钮的通知可以使用 electron-windows-notifications，但处理回复需要使用 electron-windows-interactive-notifications，它有助于注册所需的 COM 组件并使用输入的用户数据调用您的 Electron 应用程序。

查询通知状态​

要检测是否允许您发送通知，请使用用户空间模块 windows-notification-state。

此模块允许您预先确定 Windows 是否会静默地丢弃通知。

macOS​

macOS 上的通知很简单，但您应该了解 Apple 关于通知的人机界面指南。

请注意，通知的大小限制为 256 字节，如果您超过此限制，通知将被截断。

查询通知状态​

要检测是否允许你发送通知，请使用用户空间模块 macos-notification-state。

此模块允许你提前检测是否会显示通知。

Linux​

使用 libnotify 发送通知，它可以在遵循 桌面通知规范 的任何桌面环境中显示通知，包括 Cinnamon、Enlightenment、Unity、GNOME 和 KDE。