A string property representing the group identifier of the notification. Notifications with the same groupId will be visually grouped together in Notification Center (macOS) or Action Center (Windows).

groupTitle

external val groupTitle: String

A string property representing the title of the notification group header.

hasReply

external var hasReply: Boolean

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

external val id: String

A string property representing the unique identifier of the notification. This is set at construction time — either from the id option or as a generated UUID if none was provided.

replyEvent

external val replyEvent: EventInstance<Tuple2<Event<NotificationReplyEventParams>, String>>

replyPlaceholder

external var replyPlaceholder: String

A string property representing the reply placeholder of the notification.

showEvent

external val showEvent: EventInstance<Tuple1<Event<*>>>

silent

external var silent: Boolean

A boolean property representing whether the notification is silent.

sound

external var sound: String

A string property representing the sound of the notification.

subtitle

external var subtitle: String

A string property representing the subtitle of the notification.

timeoutType

external var timeoutType: NotificationTimeoutType

A string property representing the type of timeout duration for the notification. Can be 'default' or 'never'.

title

external var title: String

A string property representing the title of the notification.

toastXml

external var toastXml: String

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

urgency

external var urgency: NotificationUrgency

A string property representing the urgency level of the notification. Can be 'normal', 'critical', or 'low'.

Functions

addListener

external fun addListener(type: EventType, listener: EventListener)

external fun close()

Dismisses the notification.

emit

external fun emit(type: EventType, vararg args: Any?): Boolean

eventNames

external fun eventNames(): ReadonlyArray<EventType>

getMaxListeners

external fun getMaxListeners(): Double

listenerCount

external fun listenerCount(type: EventType, listener: EventListener): Double

listeners

external fun listeners(type: EventType): ReadonlyArray<EventListener>

off

external fun off(type: EventType, listener: EventListener)

external fun on(type: EventType, listener: EventListener)

once

external fun once(type: EventType, listener: EventListener)

prependListener

external fun prependListener(type: EventType, listener: EventListener)

prependOnceListener

external fun prependOnceListener(type: EventType, listener: EventListener)

rawListeners

external fun rawListeners(type: EventType): ReadonlyArray<EventListener>

removeAllListeners

external fun removeAllListeners(type: EventType)

removeListener

external fun removeListener(type: EventType, listener: EventListener)

setMaxListeners

external fun setMaxListeners(n: Number)

show

external fun show()

Immediately shows the notification to the user. Unlike the web notification API, instantiating a new Notification() does not immediately show it to the user. Instead, you need to call this method before the OS will display it.