Kotlin Wrappers API Reference

kotlin-electron/electron.main/Notification

Notification

open external class Notification : Notification(source)

Constructors

constructor(options: NotificationConstructorOptions = definedExternally)

Properties

val actionEvent: <Error class: unknown class><<Error class: unknown class><Event<*>, Double>>

var actions: <Error class: unknown class><NotificationAction>

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

var body: String

A string property representing the body of the notification.

val clickEvent: <Error class: unknown class><<Error class: unknown class><Event<*>>>

closeButtonText

var closeButtonText: String

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

val closeEvent: <Error class: unknown class><<Error class: unknown class><Event<*>>>

val failedEvent: <Error class: unknown class><<Error class: unknown class><Event<*>, String>>

var hasReply: Boolean

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

val replyEvent: <Error class: unknown class><<Error class: unknown class><Event<*>, String>>

replyPlaceholder

var replyPlaceholder: String

A string property representing the reply placeholder of the notification.

val showEvent: <Error class: unknown class><<Error class: unknown class><Event<*>>>

var silent: Boolean

A boolean property representing whether the notification is silent.

var sound: String

A string property representing the sound of the notification.

var subtitle: String

A string property representing the subtitle of the notification.

var timeoutType: NotificationTimeoutType

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

var title: String

A string property representing the title of the notification.

var toastXml: String

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

var urgency: NotificationUrgency

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

Functions

fun close()

Dismisses the notification.

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.