akasha.notifications

Class Notification

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.notifications.Notification

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Notification")
public class Notification
extends EventTarget

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

See Also:

Notification - MDN, Notifications API

Field Summary

Fields

Modifier and Type	Field and Description
EventHandler	onclick The onclick property of the Notification interface specifies an event listener to receive click events.
EventHandler	onclose The onclose property of the Notification interface specifies an event listener to receive close events.
EventHandler	onerror The onerror property of the Notification interface specifies an event listener to receive error events.
EventHandler	onshow The onshow property of the Notification interface specifies an event listener to receive show events.

Constructor Summary

Constructors

Constructor and Description
Notification(java.lang.String title) The Notification() constructor creates a new Notification object instance, which represents a user notification.
Notification(java.lang.String title, NotificationOptions options) The Notification() constructor creates a new Notification object instance, which represents a user notification.

Method Summary

Modifier and Type	Method and Description
JsArray<NotificationAction>	actions() The actions read-only property of the Notification interface returns the list of NotificationAction objects set using the actions option when creating the notification using the Notification() constructor.
java.lang.String	badge() The badge property of the Notification interface returns the URL of the image used to represent the notification when there is not enough space to display the notification itself.
java.lang.String	body() 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.
void	close() The close() method of the Notification interface is used to close/remove a previously displayed notification.
jsinterop.base.Any	data() 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.
java.lang.String	dir() 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.
java.lang.String	icon() 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.
java.lang.String	image() The image read-only property of the Notification interface contains the URL of an image to be displayed as part of the notification
java.lang.String	lang() 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.
static int	maxActions() The maxActions attribute of the Notification interface returns the maximum number of actions supported by the device and the User Agent.
static java.lang.String	permission() The permission read-only property of the Notification interface indicates the current permission granted by the user for the current origin to display web notifications.
boolean	renotify() The renotify read-only property of the Notification interface specifies whether the user should be notified after a new notification replaces an old one, as specified in the renotify option of the Notification() constructor.
static Promise<java.lang.String>	requestPermission() The requestPermission() method of the Notification interface requests permission from the user for the current origin to display notifications.
static Promise<java.lang.String>	requestPermission(NotificationPermissionCallback deprecatedCallback) The requestPermission() method of the Notification interface requests permission from the user for the current origin to display notifications.
boolean	requireInteraction() The requireInteraction read-only property of the Notification interface returns a Boolean indicating that a notification should remain active until the user clicks or dismisses it, rather than closing automatically.
boolean	silent() 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.
java.lang.String	tag() 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.
int	timestamp() The timestamp read-only property of the Notification interface returns a DOMTimeStamp, as specified in the timestamp option of the Notification() constructor.
java.lang.String	title() 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.
JsArray<java.lang.Double>	vibrate() The vibrate read-only property of the Notification interface specifies a a vibration pattern for the device's vibration hardware to emit when the notification fires.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

onclick

@Nullable
public EventHandler onclick

The onclick property of the Notification interface specifies an event listener to receive click events. These events occur when the user clicks on a displayed Notification.

See Also:

Notification.onclick - MDN, onclick - Notifications API

onclose

@Nullable
public EventHandler onclose

The onclose property of the Notification interface specifies an event listener to receive close events. These events occur when a Notification is closed.

See Also:

Notification.onclose - MDN

onerror

@Nullable
public EventHandler onerror

The onerror property of the Notification interface specifies an event listener to receive error events. These events occur when something goes wrong with a Notification (in many cases an error preventing the notification from being displayed.)

See Also:

Notification.onerror - MDN, onerror - Notifications API

onshow

@Nullable
public EventHandler onshow

The onshow property of the Notification interface specifies an event listener to receive show events. These events occur when a Notification is displayed.

See Also:

Notification.onshow - MDN

Constructor Detail

Notification

public Notification(@Nonnull
                    java.lang.String title,
                    @Nonnull
                    NotificationOptions options)

The Notification() constructor creates a new Notification object instance, which represents a user notification.

See Also:

Notification.Notification - MDN, Notification() constructor - Notifications API

Notification

public Notification(@Nonnull
                    java.lang.String title)

The Notification() constructor creates a new Notification object instance, which represents a user notification.

See Also:

Notification.Notification - MDN, Notification() constructor - Notifications API

Method Detail

actions

@JsProperty(name="actions")
 @Nonnull
public JsArray<NotificationAction> actions()

The actions read-only property of the Notification interface returns the list of NotificationAction objects set using the actions option when creating the notification using the Notification() constructor.

See Also:

Notification.actions - MDN, actions - Notifications API

badge

@JsProperty(name="badge")
 @Nonnull
public java.lang.String badge()

The badge property of the Notification interface returns the URL of the image used to represent the notification when there is not enough space to display the notification itself.

See Also:

Notification.badge - MDN, badge - Notifications API

body

@JsProperty(name="body")
 @Nonnull
public java.lang.String body()

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.

See Also:

Notification.body - MDN, body - Notifications API

data

@JsProperty(name="data")
 @Nullable
public jsinterop.base.Any data()

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.

See Also:

Notification.data - MDN, data - Notifications API

dir

@JsProperty(name="dir")
 @Nonnull
 @NotificationDirection
public java.lang.String dir()

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.

See Also:

Notification.dir - MDN

icon

@JsProperty(name="icon")
 @Nonnull
public java.lang.String icon()

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.

See Also:

Notification.icon - MDN, icon - Notifications API

image

@JsProperty(name="image")
 @Nonnull
public java.lang.String image()

The image read-only property of the Notification interface contains the URL of an image to be displayed as part of the notification

See Also:

Notification.image - MDN, image - Notifications API

lang

@JsProperty(name="lang")
 @Nonnull
public java.lang.String lang()

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.

See Also:

Notification.lang - MDN, lang - Notifications API

maxActions

@JsProperty(name="maxActions")
public static int maxActions()

The maxActions attribute of the Notification interface returns the maximum number of actions supported by the device and the User Agent. Effectively, this is the maximum number of elements in Notification.actions array which will be respected by the User Agent.

See Also:

Notification.maxActions - MDN, Notifications API

permission

@JsProperty(name="permission")
 @Nonnull
 @NotificationPermission
public static java.lang.String permission()

The permission read-only property of the Notification interface indicates the current permission granted by the user for the current origin to display web notifications.

See Also:

Notification.permission - MDN, permission - Notifications API

renotify

@JsProperty(name="renotify")
public boolean renotify()

The renotify read-only property of the Notification interface specifies whether the user should be notified after a new notification replaces an old one, as specified in the renotify option of the Notification() constructor.

See Also:

Notification.renotify - MDN, renotify - Notifications API

requireInteraction

@JsProperty(name="requireInteraction")
public boolean requireInteraction()

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

See Also:

Notification.requireInteraction - MDN, requireInteraction - Notifications API

silent

@JsProperty(name="silent")
public boolean silent()

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 specified in the silent option of the Notification() constructor.

See Also:

Notification.silent - MDN, silent - Notifications API

tag

@JsProperty(name="tag")
 @Nonnull
public java.lang.String tag()

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.

See Also:

Notification.tag - MDN

timestamp

@JsProperty(name="timestamp")
public int timestamp()

The timestamp read-only property of the Notification interface returns a DOMTimeStamp, as specified in the timestamp option of the Notification() constructor.

See Also:

Notification.timestamp - MDN, timestamp - Notifications API

title

@JsProperty(name="title")
 @Nonnull
public java.lang.String title()

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.

See Also:

Notification.title - MDN, title - Notifications API

vibrate

@JsProperty(name="vibrate")
 @Nonnull
public JsArray<java.lang.Double> vibrate()

The vibrate read-only property of the Notification interface specifies a a vibration pattern for the device's vibration hardware to emit when the notification fires. This is specified in the vibrate option of the Notification() constructor.

See Also:

Notification.vibrate - MDN, vibrate - Notifications API

requestPermission

@Nonnull
public static Promise<java.lang.String> requestPermission(@Nonnull
                                                                   NotificationPermissionCallback deprecatedCallback)

The requestPermission() method of the Notification interface requests permission from the user for the current origin to display notifications.

See Also:

Notification.requestPermission - MDN, Notifications API

requestPermission

@Nonnull
public static Promise<java.lang.String> requestPermission()

The requestPermission() method of the Notification interface requests permission from the user for the current origin to display notifications.

See Also:

Notification.requestPermission - MDN, Notifications API

close

public void close()

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

See Also:

Notification.close - MDN, Notifications API