Package org.gnome.gio

Class Notification

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.Notification

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class Notification
extends GObject

GNotification is a mechanism for creating a notification to be shown to the user — typically as a pop-up notification presented by the desktop environment shell.

The key difference between GNotification and other similar APIs is that, if supported by the desktop environment, notifications sent with GNotification will persist after the application has exited, and even across system reboots.

Since the user may click on a notification while the application is not running, applications using GNotification should be able to be started as a D-Bus service, using Application.

In order for GNotification to work, the application must have installed a .desktop file. For example:

 [Desktop Entry]
 Name=Test Application
 Comment=Description of what Test Application does
 Exec=gnome-test-application
 Icon=org.gnome.TestApplication
 Terminal=false
 Type=Application
 Categories=GNOME;GTK;TestApplication Category;
 StartupNotify=true
 DBusActivatable=true
 X-GNOME-UsesNotifications=true
 

The X-GNOME-UsesNotifications key indicates to GNOME Control Center that this application uses notifications, so it can be listed in the Control Center’s ‘Notifications’ panel.

The .desktop file must be named as org.gnome.TestApplication.desktop, where org.gnome.TestApplication is the ID passed to Application().

User interaction with a notification (either the default action, or buttons) must be associated with actions on the application (ie: app. actions). It is not possible to route user interaction through the notification itself, because the object will not exist if the application is autostarted as a result of a notification being clicked.

A notification can be sent with Application.sendNotification(java.lang.String, org.gnome.gio.Notification).

Since:

2.40

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Notification.Builder<B extends Notification.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
Notification()	Creates a new Notification.
Notification(MemorySegment address)	Create a Notification proxy instance for the provided memory address.
Notification(String title)	Creates a new GNotification with title as its title.

Method Summary

Modifier and Type	Method	Description
void	addButton(String label, String detailedAction)	Adds a button to this Notification that activates the action in detailedAction when clicked.
void	addButtonWithTarget(String label, String action, @Nullable Variant target)	Adds a button to this Notification that activates action when clicked.
protected Notification	asParent()	Returns this instance as if it were its parent type.
static Notification.Builder<? extends Notification.Builder>	builder()	A Notification.Builder object constructs a Notification with the specified properties.
static @Nullable Type	getType()	Get the GType of the Notification class
void	setBody(@Nullable String body)	Sets the body of this Notification to body.
void	setCategory(@Nullable String category)	Sets the type of this Notification to category. Categories have a main type like email, im or device and can have a detail separated by a ., e.g.
void	setDefaultAction(String detailedAction)	Sets the default action of this Notification to detailedAction. This action is activated when the notification is clicked on.
void	setDefaultActionAndTarget(String action, @Nullable Variant target)	Sets the default action of this Notification to action. This action is activated when the notification is clicked on.
void	setIcon(Icon icon)	Sets the icon of this Notification to icon.
void	setPriority(NotificationPriority priority)	Sets the priority of this Notification to priority. See GNotificationPriority for possible values.
void	setTitle(String title)	Sets the title of this Notification to title.
void	setUrgent(boolean urgent)	Deprecated. Since 2.42, this has been deprecated in favour of g_notification_set_priority().

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

Notification

public Notification(MemorySegment address)

Create a Notification proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Notification

public Notification(String title)

Creates a new GNotification with title as its title.

After populating notification with more details, it can be sent to the desktop shell with g_application_send_notification(). Changing any properties after this call will not have any effect until resending notification.

Parameters:

title - the title of the notification

Since:

2.40

Notification

public Notification()

Creates a new Notification.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Notification class

Returns:

the GType

asParent

protected Notification asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

addButton

public void addButton(String label,
 String detailedAction)

Adds a button to this Notification that activates the action in detailedAction when clicked. That action must be an application-wide action (starting with "app."). If detailedAction contains a target, the action will be activated with that target as its parameter.

See g_action_parse_detailed_name() for a description of the format for detailedAction.

Parameters:

label - label of the button

detailedAction - a detailed action name

Since:

2.40

addButtonWithTarget

public void addButtonWithTarget(String label,
 String action,
 @Nullable Variant target)

Adds a button to this Notification that activates action when clicked. action must be an application-wide action (it must start with "app.").

If target is non-null, action will be activated with target as its parameter.

Parameters:

label - label of the button

action - an action name

target - a GVariant to use as action's parameter, or null

Since:

2.40

setBody

public void setBody(@Nullable String body)

Sets the body of this Notification to body.

Parameters:

body - the new body for notification, or null

Since:

2.40

setCategory

public void setCategory(@Nullable String category)

Sets the type of this Notification to category. Categories have a main type like email, im or device and can have a detail separated by a ., e.g. im.received or email.arrived. Setting the category helps the notification server to select proper feedback to the user.

Standard categories are listed in the specification.

Parameters:

category - the category for notification, or null for no category

Since:

2.70

setDefaultAction

public void setDefaultAction(String detailedAction)

Sets the default action of this Notification to detailedAction. This action is activated when the notification is clicked on.

The action in detailedAction must be an application-wide action (it must start with "app."). If detailedAction contains a target, the given action will be activated with that target as its parameter. See g_action_parse_detailed_name() for a description of the format for detailedAction.

When no default action is set, the application that the notification was sent on is activated.

Parameters:

detailedAction - a detailed action name

Since:

2.40

setDefaultActionAndTarget

public void setDefaultActionAndTarget(String action,
 @Nullable Variant target)

Sets the default action of this Notification to action. This action is activated when the notification is clicked on. It must be an application-wide action (start with "app.").

If target is non-null, action will be activated with target as its parameter. If target is floating, it will be consumed.

When no default action is set, the application that the notification was sent on is activated.

Parameters:

action - an action name

target - a GVariant to use as action's parameter, or null

Since:

2.40

setIcon

public void setIcon(Icon icon)

Sets the icon of this Notification to icon.

Parameters:

icon - the icon to be shown in notification, as a GIcon

Since:

2.40

setPriority

public void setPriority(NotificationPriority priority)

Sets the priority of this Notification to priority. See GNotificationPriority for possible values.

Parameters:

priority - a GNotificationPriority

setTitle

public void setTitle(String title)

Sets the title of this Notification to title.

Parameters:

title - the new title for this Notification

Since:

2.40

setUrgent

@Deprecated
public void setUrgent(boolean urgent)

Deprecated.

Since 2.42, this has been deprecated in favour of g_notification_set_priority().

Deprecated in favor of g_notification_set_priority().

Parameters:

urgent - true if this Notification is urgent

Since:

2.40

builder

public static Notification.Builder<? extends Notification.Builder> builder()

A Notification.Builder object constructs a Notification with the specified properties. Use the various set...() methods to set properties, and finish construction with Notification.Builder.build().

Returns:

the builder object