Help language development. Donate to The Perl Foundation
Desktop::Notify is a set of simple bindings to libnotify using NativeCall.
|Operating System||Build Status||CI Provider|
use v6; use Desktop::Notify; my $notify = Desktop::Notify.new(app-name => 'myapp'); my $n = $notify.new-notification('Attention!', 'What just happened?', 'stop'); $notify.set-timeout($n, NOTIFY_EXPIRES_NEVER); $notify.show($n); sleep 2; $notify.update($n, 'Oh well!', 'Not quite a disaster!', 'stop'); $notify.show($n);
If you run this code, note that the notification doesn't fade by itself, but you need to click on it in order to close it.
For more examples see the
Constructs a new
Desktop::Notify object. It takes one mandatory argument:
app-name, the name of the app that will be registered with the notify dæmon.
Returns True if the object has been successfully initialized.
Queries or sets the app name.
Creates a new notification.
The first form takes three positional arguments: the summary string, the notification string and
the icon to display (See the libnotify documentation for the available icons).
The second form takes a number of named argument.
icon are mandatory,
the others are optional. If
urgency are defined, this method will call
the corresponding "set" methods documented below.
Shows the notification on screen. It takes one mandatory argument, the
NotifyNotification object, and one optional argument, the GError object.
(The default Desktop::Notify error handling is not thread safe. See
for more info)
Closes the notification. It takes one mandatory argument, the NotifyNotification
object, and one optional argument, the GError object. (The default
Desktop::Notify error handling is not thread safe. See
Threading safety for
Note that usually there's no need to explicitly
close a notification, since
the default is to automatically expire after a while.
Returns the the closed reason code for the notification. It takes one argument, the NotifyNotification object. (See the libnotify documentation for the meaning of this code)
Returns the notification type.
Modifies the messages of a notification which is already on screen.
Sets the notification timeout. There are two available constants,
NOTIFY_EXPIRES_NEVER, when explicitly imported
use Desktop::Notify :constants;.
Sets the notification category (See the libnotify documentation).
Sets the notification urgency. An
enum NotifyUrgency <NotifyUrgencyLow NotifyUrgencyNormal NotifyUrgencyCritical>
is available when explicitly imported with
use Desktop::Notify :constants;.
Collects the server capabilities and returns a sequence.
Reads the server info and returns an hash. The return value of the C function call is
returned as the value of the
return key of the hash.
Desktop::Notify offers a simple interface which provides an
error class member,
which is automatically used by the functions that need it.
error is a shared class member, if a program makes use of threading, its value
might be written by another thread before it's been read.
In this case one can declare their own GError variables:
my $err = Desktop::Notify::GError.new;
and pass it as an optional argument to the .show() and .close() methods; it will be used instead of the object-wide one.
This module requires the libnotify library to be installed. Please follow the instructions below based on your platform:
sudo apt-get install libnotify4
$ zef install Desktop::Notify
To run the tests:
$ prove -e "perl6 -Ilib"
With version 0.2.0 I modified the
enum NotifyUrgency to avoid polluting (too much) the namespace.
Now instead of e.g.
low, one has to use
The Artistic License 2.0