Package eu.webtoolkit.jwt

Class WNotification

java.lang.Object

eu.webtoolkit.jwt.WObject

eu.webtoolkit.jwt.WNotification

public class WNotification
extends WObject

A class that represent a notification.

A notification is a message sent to the user that can be read from outside the webpage. For a page to be allowed to send notifications, permission must be explicitly given by the user to the application. The permission can be asked to the user with askPermission() or will be asked automatically the first time send() is called in the application. It is possible to listen to the permissionUpdated() signal to react to the user granting or denying permission to send notifications.

If the user has previously granted permission to the page to display notifications, the browser will remember it, and JWt will not ask for that permission again.

The WNotification will not be sent to the user if the permission has not yet been granted. Instead, the notification will wait for the user to accept notifications before being sent. This will however not happen if the notification was closed or destroyed.

A WNotification represents a notification with a tag. The value of this tag is the id of the WNotification. If the same WNotification is sent multiple times, this will update the notification instead of creating a new one, as long as it was not closed.

You can react to a notification being closed or clicked by listening to the closed() and clicked() signals, this does however require that the WNotification has not been destroyed before the event happens.

Notifications can have an icon and a badge. Those can be set using setIcon() and setBadge(), but since these are likely the same for all the notifications sent by your application, it is possible to set a default icon and a default badge for all notifications with setDefaultIcon() and setDefaultBadge().

See Also:

• send()

• Note: Sending notifications requires that:

  • JavaScript is enabled
  • the browser supports notifications
  • HTTPS is used

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WNotification.Permission	Enumeration representing the permission status of notifications.

Nested classes/interfaces inherited from class eu.webtoolkit.jwt.WObject

WObject.FormData

Constructor Summary

Constructors

Constructor	Description
WNotification()	Creates a new notification.
WNotification(CharSequence title)	Creates a new notification.
WNotification(CharSequence title, CharSequence body)	Creates a new notification.

Method Summary

Modifier and Type	Method	Description
static void	askPermission()	Ask permission to send notifications to the user.
JSignal	clicked()	Signal emitted when the notification is clicked.
void	close()	Closes the notification.
JSignal	closed()	Signal emitted when the notification is closed.
JSignal	error()	Signal emitted when the notification was not shown due to an error.
WLink	getBadge()	Returns the link to the notification's badge.
WString	getBody()	Returns the body of the notification.
static WLink	getDefaultBadge()	Returns the link to the notifications default badge.
static WLink	getDefaultIcon()	Returns the link to the notifications default icon.
WLink	getIcon()	Returns the link to the notification's icon.
static WNotification.Permission	getPermission()	Returns the status of the permission to send notifications.
WString	getTitle()	Returns the title of the notification.
boolean	isRequireInteraction()	Returns whether the notification require interaction to become inactive or not.
boolean	isSilent()	Returns whether the notification should be silent or not.
static boolean	isSupported()	Returns whether the user supports notifications or not.
static Signal1<WNotification.Permission>	permissionUpdated()	Signal emitted when the permission to send notification has been updated.
void	send()	Sends the notification.
void	setBadge(WLink badgeLink)	Sets the link to the notification's badge.
void	setBody(CharSequence body)	Sets the body of the notification.
static void	setDefaultBadge(WLink badgeLink)	Sets the link to the notifications default badge.
static void	setDefaultIcon(WLink iconLink)	Sets the link to the notifications default icon.
void	setIcon(WLink iconLink)	Sets the link to the notification's icon.
final void	setRequireInteraction()	Sets whether the notification require interaction to become inactive or not.
void	setRequireInteraction(boolean enable)	Sets whether the notification require interaction to become inactive or not.
final void	setSilent()	Sets whether the notification should be silent or not.
void	setSilent(boolean enable)	Sets whether the notification should be silent or not.
void	setTitle(CharSequence title)	Sets the title of the notification.
JSignal	shown()	Signal emitted when the notification is shown.

Methods inherited from class eu.webtoolkit.jwt.WObject

getId, getObjectName, remove, resendFormData, setFormData, setObjectName, tr

Methods inherited from class java.lang.Object

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

Constructor Details

WNotification

public WNotification(CharSequence title,
 CharSequence body)

Creates a new notification.

Creates a new notification with the given title and body.

WNotification

public WNotification()

Creates a new notification.

Calls this(new WString(), new WString())

WNotification

public WNotification(CharSequence title)

Creates a new notification.

Calls this(title, new WString())

Method Details

setTitle

public void setTitle(CharSequence title)

Sets the title of the notification.

This sets the title of the notification.

By default, the title is an empty string.

getTitle

public WString getTitle()

Returns the title of the notification.

See Also:

• setTitle(CharSequence title)

setBody

public void setBody(CharSequence body)

Sets the body of the notification.

This sets the body of the notification.

By default, the notification has no body, which is represented by an empty string.

getBody

public WString getBody()

Returns the body of the notification.

Returns the body of the notification or an empty string if the notification has no body.

See Also:

• setBody(CharSequence body)

setIcon

public void setIcon(WLink iconLink)

Sets the link to the notification's icon.

This sets the link to the notification's icon which is the image displayed on the left of the notification.

By default, the icon is set to the default icon.

See Also:

• setDefaultIcon(WLink iconLink)

getIcon

public WLink getIcon()

Returns the link to the notification's icon.

Returns the link to the notification's icon or a null link if the notification uses the default icon.

By default, the icon is set to the default icon.

See Also:

• setIcon(WLink iconLink)

setBadge

public void setBadge(WLink badgeLink)

Sets the link to the notification's badge.

This sets the link to the notification's badge which is the image displayed when there is not enough space to display the notification.

By default, the badge is set to the default badge.

See Also:

• setDefaultBadge(WLink badgeLink)

getBadge

public WLink getBadge()

Returns the link to the notification's badge.

Returns the link to the notification's badge.

By default, the badge is set to the default badge.

See Also:

• setBadge(WLink badgeLink)
• setDefaultBadge(WLink badgeLink)

setSilent

public void setSilent(boolean enable)

Sets whether the notification should be silent or not.

This sets whether the notification should be silent or not. A silent notification will not make any noise or vibration.

By default, the notification is not silent.

Note: A non silent notification may still make no noise or vibration as it will respect the user's configuration.

setSilent

public final void setSilent()

Sets whether the notification should be silent or not.

Calls setSilent(true)

isSilent

public boolean isSilent()

Returns whether the notification should be silent or not.

See Also:

• setSilent(boolean enable)

setRequireInteraction

public void setRequireInteraction(boolean enable)

Sets whether the notification require interaction to become inactive or not.

This sets whether the notification should remain active until the user click's on it or dismiss it.

By default, this is set to false.

setRequireInteraction

public final void setRequireInteraction()

Sets whether the notification require interaction to become inactive or not.

Calls setRequireInteraction(true)

isRequireInteraction

public boolean isRequireInteraction()

Returns whether the notification require interaction to become inactive or not.

See Also:

• setRequireInteraction(boolean enable)

send

public void send()

Sends the notification.

Sends the notification to the user. This only happens if the permission to send notification has been granted by the user.

In case the user has not denied or granted notification to the user, the first call to send will instead ask for permission to send notification. The notification will then be sent after the user granted permission to send notification, unless this notification was closed or destroyed.

Calling send() multiple times on the same notification will not create multiple notification but replace the previous with the new one, as long as the previous one has not been closed. This means that the user will not be notified again for this notification unless the previous one has been closed.

See Also:

• close()

close

public void close()

Closes the notification.

Closes the notification. This does nothing if the notification was not sent or was already closed.

See Also:

• send()

clicked

public JSignal clicked()

Signal emitted when the notification is clicked.

closed

public JSignal closed()

Signal emitted when the notification is closed.

shown

public JSignal shown()

Signal emitted when the notification is shown.

error

public JSignal error()

Signal emitted when the notification was not shown due to an error.

setDefaultIcon

public static void setDefaultIcon(WLink iconLink)

Sets the link to the notifications default icon.

By default, this is a null link which means no default icon is used.

See Also:

• setIcon(WLink iconLink)

getDefaultIcon

public static WLink getDefaultIcon()

Returns the link to the notifications default icon.

See Also:

• setDefaultIcon(WLink iconLink)

setDefaultBadge

public static void setDefaultBadge(WLink badgeLink)

Sets the link to the notifications default badge.

By default, this is a null link which means no default badge is used.

See Also:

• setBadge(WLink badgeLink)

getDefaultBadge

public static WLink getDefaultBadge()

Returns the link to the notifications default badge.

See Also:

• setDefaultBadge(WLink badgeLink)

isSupported

public static boolean isSupported()

Returns whether the user supports notifications or not.

askPermission

public static void askPermission()

Ask permission to send notifications to the user.

This ask permission to the user to send notifications. This will only be done once per application. More calls to this function will not do anything.

See Also:

• Note: Browsers ignores this if the permission is already denied or granted.

getPermission

public static WNotification.Permission getPermission()

Returns the status of the permission to send notifications.

See Also:

• askPermission()

permissionUpdated

public static Signal1<WNotification.Permission> permissionUpdated()

Signal emitted when the permission to send notification has been updated.

Signal emitted when the permission to send notification has been updated. This happens when the user answered to askPermission(), and the new permission status is given by the signal as parameter to all connected functions.

See Also:

• askPermission()