通知
- 在渲染进程中使用
- 类: Notification

通知

创建OS(操作系统)桌面通知

进程：主进程

在渲染进程中使用

如果要显示来自渲染进程的通知, 你应该使用 HTML5 Notification API

类: Notification

创建OS(操作系统)桌面通知

进程：主进程

Notification是一个EventEmitter.

通过 options 来设置的一个新的原生 Notification。

静态方法

Notification 类有以下静态方法：

`new Notification([options])`

options Object (可选)
- title String (optional) - A title for the notification, which will be shown at the top of the notification window when it is shown.
- subtitleString (可选) 通知的副标题, 显示在标题下面。 macOS
- body String (optional) - The body text of the notification, which will be displayed below the title or subtitle.
- silentBoolean (可选) 在显示通知时是否发出系统提示音。
- icon(String | NativeImage ) (可选) 用于在该通知上显示的图标。
- hasReplyBoolean (可选) 是否在通知中添加一个答复选项。 macOS
- timeoutType String (optional) Linux Windows - The timeout duration of the notification. Can be ‘default’ or ‘never’.
- replyPlaceholderString (可选) 答复输入框中的占位符。 macOS
- sound String (可选) 显示通知时播放的声音文件的名称。 macOS
- urgency String (optional) Linux - The urgency level of the notification. Can be ‘normal’, ‘critical’, or ‘low’.
- actions NotificationAction[] (可选) macOS - 要添加到通知中的操作请阅读 NotificationAction文档来了解可用的操作和限制。
- closeButtonText String (optional) macOS - A custom title for the close button of an alert. An empty string will cause the default localized text to be used.
- toastXml String (optional) Windows - A custom description of the Notification on Windows superseding all properties above. Provides full customization of design and behavior of the notification.

实例事件

用 new Notification 创建的对象触发以下事件：

注意: 某些事件仅在特定的操作系统上可用, 这些方法会被标记出来。

事件: ‘show’

event Event

当通知向用户显示时触发, 请注意, 这可能会多次触发, 因为「通知」可以通过 show() 方法多次显示。

事件： ‘close’

event Event

当用户手动关闭通知时触发

当通知关闭后，这个事件不能保证在所有情况下都会触发。

事件: ‘reply’ macOS

event Event
replyString-用户在内联答复字段中输入的字符串.

当用户单击 hasReply: true 的通知上的 “Reply” 按钮时触发。

事件: ‘action’ macOS

event Event
index Number - 已激活的操作的索引.

Event: ‘failed’ Windows

event Event
error String - The error encountered during execution of the show() method.

Emitted when an error is encountered while creating and showing the native notification.

实例方法

用new Notification 创建的对象有以下实例方法：

`notification.show()`

即时向用户展示 notification ，请注意这意味着与HTML5的 Notification 的实现不同，实例化一个new Notification 不会立刻向用户展示，你需要在系统将要显示它之前调用这个方法

如果以前已显示通知, 则此方法将忽略以前显示的通知，并创建具有相同属性的新通知

实例属性

`notification.title`

A String property representing the title of the notification.

`notification.subtitle`

A String property representing the subtitle of the notification.

`notification.body`

A String property representing the body of the notification.

`notification.replyPlaceholder`

A String property representing the reply placeholder of the notification.

`notification.sound`

A String property representing the sound of the notification.

`notification.closeButtonText`

A String property representing the close button text of the notification.

`notification.silent`

A Boolean property representing whether the notification is silent.

`notification.hasReply`

A Boolean property representing whether the notification has a reply action.

`notification.urgency` Linux

A String property representing the urgency level of the notification. Can be ‘normal’, ‘critical’, or ‘low’.

Default is ‘low’ - see NotifyUrgency for more information.

`notification.timeoutType` Linux Windows

A String property representing the type of timeout duration for the notification. Can be ‘default’ or ‘never’.

If timeoutType is set to ‘never’, the notification never expires. It stays open until closed by the calling API or the user.

`notification.actions`

A NotificationAction[] property representing the actions of the notification.

`notification.toastXml` Windows

A String property representing the custom Toast XML of the notification.

在 macOS 上, 您可以指定在显示通知时要播放的声音的名称。 Any of the default sounds (under System Preferences > Sound) can be used, in addition to custom sound files. 请确保声音文件是在应用程序包(例如, YourApp.app/Contents/Resources) 内存在副本, 或者是下列位置之一:

~/Library/Sounds
/Library/Sounds
/Network/Library/Sounds
/System/Library/Sounds

有关详细信息, 请参见 NSSound 文档。

通知

通知