跳转到主要内容

通知

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

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

用法​

以下是显示每种进程类型通知的两个示例。

在主进程中显示通知​

主进程通知使用 Electron 的 Notification 模块显示。使用此模块创建的 Notification 对象除非调用其 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 (40.0.0)在 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 Notifications 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 (40.0.0)在 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）上显示通知。