kotlin-browser/web.notifications/Notification

Notification

open class Notification(val title: String, options: NotificationOptions = definedExternally) : EventTarget(source)

The Notification interface of the Notifications API is used to configure and display desktop notifications to the user.

MDN Reference

Constructors

Notification

constructor(title: String, options: NotificationOptions = definedExternally)

Types

Companion

object Companion

Properties

actions

external val actions: ReadonlyArray<NotificationAction>

The actions read-only property of the Notification interface provides the actions available for users to choose from for interacting with the notification.

body

external val body: String

The body read-only property of the Notification interface indicates the body string of the notification, as specified in the body option of the Notification() constructor.

data

external val data: JsAny?

The data read-only property of the Notification interface returns a structured clone of the notification's data, as specified in the data option of the Notification() constructor.

dir

external val dir: NotificationDirection

The dir read-only property of the Notification interface indicates the text direction of the notification, as specified in the dir option of the Notification() constructor.

icon

external val icon: String

The icon read-only property of the Notification interface contains the URL of an icon to be displayed as part of the notification, as specified in the icon option of the Notification() constructor.

lang

external val lang: String

The lang read-only property of the Notification interface indicates the language used in the notification, as specified in the lang option of the Notification() constructor.

onclick

external var onclick: EventHandler<Event, Notification, Notification>?

MDN Reference

onclose

external var onclose: EventHandler<Event, Notification, Notification>?

MDN Reference

onerror

external var onerror: EventHandler<Event, Notification, Notification>?

MDN Reference

onshow

external var onshow: EventHandler<Event, Notification, Notification>?

MDN Reference

requireInteraction

external val requireInteraction: Boolean

The requireInteraction read-only property of the Notification interface returns a boolean value indicating that a notification should remain active until the user clicks or dismisses it, rather than closing automatically.

silent

external val silent: Boolean?

The silent read-only property of the Notification interface specifies whether the notification should be silent, i.e., no sounds or vibrations should be issued regardless of the device settings. This is controlled via the silent option of the Notification() constructor.

tag

external val tag: String

The tag read-only property of the Notification interface signifies an identifying tag for the notification, as specified in the tag option of the Notification() constructor.

title

external val title: String

The title read-only property of the Notification interface indicates the title of the notification, as specified in the title parameter of the Notification() constructor.

Functions

external fun close()

The close() method of the Notification interface is used to close/remove a previously displayed notification.

dispatchEvent

open external fun dispatchEvent(event: Event): Boolean

when

external fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>