KNotifications

KNotifications QML API

Basic Notifications

Getting started with notifications in QML is quite similar to how this also works in C++:

  • Create a KNotificiation instance.
  • Customize it to your needs via its properties (labels, icons, actions, priorities, etc).
  • Connect to its signals to react to the user interacting with the notification, by triggering its inline actions or by closing it.
  • Eventually call its KNotification::sendEvent() method to show or re-show the notification.
import QtQuick 2.15
import org.kde.notification 1.0
... {
Notification {
id: myNotification
componentName: "your_component"
eventId: "your_event"
title: "Attention!"
text: "Something important happened."
iconName: "kde"
actions: [ "Action 1", "Action 2" ]
flags: Notification.Persistent
urgency: Notification.HighUrgency
onClosed: console.log("Notification closed.")
onDefaultActivated: console.log("Default action activated.")
onAction1Activated: console.log("Action 1 activated.")
onAction2Activated: console.log("Action 2 activated.")
}
Button {
onClicked: myNotification.sendEvent()
}
}

Inline Reply Notifications

Inline reply notifications are also available. There's a small difference to C++ in that the reply action doesn't need to be explicitly managed but is created on demand behind the scenes.

import QtQuick 2.15
import org.kde.notification 1.0
... {
Notification {
id: myReplyNotification
componentName: "plasma_workspace"
eventId: "notification"
title: "Chat message from Dr Konqui"
text: "How are you?"
replyAction {
label: "Reply"
placeholderText: "Reply to Dr Konqi..."
submitButtonText: "Send Reply"
submitButtonIconName: "mail-reply-all"
onReplied: console.log(text)
}
}
}

Creating Notifications Dynamically

You might have a use-case that requires an arbitrary amount of dynamically created notifications rather than a fixed set of reusable instances. In that case the approach shown above might be too restrictive.

To address this it is possible to configure the auto-delete behavior of KNotification objects. When used from C++ it's on by default for compatibility (but can also be switched off), in QML it's off by default and can be switched on when needed as shown in the following example.

import QtQuick 2.15
import org.kde.notification 1.0
... {
Component {
id: notificationComponent
Notification {
componentName: "plasma_workspace"
eventId: "notification"
text: "Temporary notification we can create new instances of."
autoDelete: true
}
}
Button {
property int count: 0
onClicked: {
var notification = notificationComponent.createObject(parent);
notification.title = "New Notification " + count;
n.sendEvent();
++count;
}
}
}

Further References

There's a more complete and actually runnable pure-QML example in examples/notificationtester.qml provided as part of the KNotifications source code.

This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sat Jun 25 2022 05:56:27 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.