kotlin-electron/electron.core/Notification

Notification

open external class Notification : EventEmitter(source)

Inheritors

Constructors

constructor(options: NotificationConstructorOptions = definedExternally)

Notification

Types

object Companion

Properties

val actionEvent: EventInstance<JsTuple2<Event<*>, Double>>

var actions: ReadonlyArray<NotificationAction>

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

var body: String

A string property representing the body of the notification.

val clickEvent: EventInstance<JsTuple1<Event<*>>>

closeButtonText

var closeButtonText: String

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

val closeEvent: EventInstance<JsTuple1<Event<*>>>

val failedEvent: EventInstance<JsTuple2<Event<*>, String>>

var hasReply: Boolean

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

val replyEvent: EventInstance<JsTuple2<Event<*>, String>>

replyPlaceholder

var replyPlaceholder: String

A string property representing the reply placeholder of the notification.

val showEvent: EventInstance<JsTuple1<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 addListener(type: EventType, listener: EventListener)

fun close()

Dismisses the notification.

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

fun eventNames(): Array<EventType>

getMaxListeners

fun getMaxListeners(): Double

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

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

fun off(type: EventType, listener: EventListener)

fun on(type: EventType, listener: EventListener)

fun once(type: EventType, listener: EventListener)

prependListener

fun prependListener(type: EventType, listener: EventListener)

prependOnceListener

fun prependOnceListener(type: EventType, listener: EventListener)

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

removeAllListeners

fun removeAllListeners(type: EventType)

fun removeListener(type: EventType, listener: EventListener)

setMaxListeners

fun setMaxListeners(n: Number)

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.