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

val groupTitle: String

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

hasReply

var hasReply: Boolean

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

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

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

replyPlaceholder

var replyPlaceholder: String

A string property representing the reply placeholder of the notification.

showEvent

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

silent

var silent: Boolean

A boolean property representing whether the notification is silent.

sound

var sound: String

A string property representing the sound of the notification.

subtitle

var subtitle: String

A string property representing the subtitle of the notification.

timeoutType

var timeoutType: NotificationTimeoutType

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

title

var title: String

A string property representing the title of the notification.

toastXml

var toastXml: String

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

urgency

var urgency: NotificationUrgency

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

Functions

addListener

fun addListener(type: EventType, listener: EventListener)

fun close()

Dismisses the notification.

emit

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

eventNames

fun eventNames(): ReadonlyArray<EventType>

getMaxListeners

fun getMaxListeners(): Double

listenerCount

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

listeners

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

off

fun off(type: EventType, listener: EventListener)

fun on(type: EventType, listener: EventListener)

once

fun once(type: EventType, listener: EventListener)

prependListener

fun prependListener(type: EventType, listener: EventListener)

prependOnceListener

fun prependOnceListener(type: EventType, listener: EventListener)

rawListeners

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

removeAllListeners

fun removeAllListeners(type: EventType)

removeListener

fun removeListener(type: EventType, listener: EventListener)

setMaxListeners

fun setMaxListeners(n: Number)

show

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.