GLib.Notification – gio-2.0 – Vala Binding Reference

Description:

[ CCode ( type_id = "g_notification_get_type ()" ) ]
[ Version ( since = "2.40" ) ]
public class Notification : Object

Notification 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 Notification and other similar APIs is that, if supported by the desktop environment, notifications sent with Notification 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 Notification should be able to be started as a D-Bus service, using Application.

In order for Notification 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 send_notification.

Namespace: GLib

Package: gio-2.0

Content:

Creation methods:

public Notification (string title)

Creates a new Notification with

title

as its title.

Methods:

public void add_button (string label, string detailed_action)

Adds a button to this that activates the action in detailed_action when clicked.

public void add_button_with_target (string label, string action, string? target_format, ...)

Adds a button to this that activates action when clicked.

public void add_button_with_target_value (string label, string action, Variant? target)

Adds a button to this that activates action when clicked.

public void set_body (string? body)

Sets the body of this to

body

public void set_category (string? category)

Sets the type of this to


									category

public void set_default_action (string detailed_action)

Sets the default action of this to detailed_action.

public void set_default_action_and_target (string action, string? target_format, ...)

Sets the default action of this to action.

public void set_default_action_and_target_value (string action, Variant? target)

Sets the default action of this to action.

public void set_icon (Icon icon)

Sets the icon of this to

icon

public void set_priority (NotificationPriority priority)

Sets the priority of this to


									priority

public void set_title (string title)

Sets the title of this to


									title

public void set_urgent (bool urgent)

Deprecated in favor of set_priority.

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref

Notification

Object Hierarchy:

Description:

Content:

Creation methods:

Methods:

Inherited Members: