kdeconnect-kde/plugins/notifications
Alexander Lohnau 75a8db1ec5 Use pragma once in plugins
For non-library code, this is simpler and more concise
2023-07-22 20:51:19 +00:00
..
CMakeLists.txt Use target-centric CMake approach for declaring debug category 2023-07-22 20:51:19 +00:00
kdeconnect_notifications.json Remove explicit plugin Id 2023-07-22 20:51:19 +00:00
notification.cpp Clean up unneeded version checks 2023-07-22 16:17:24 +02:00
notification.h Use pragma once in plugins 2023-07-22 20:51:19 +00:00
notificationsplugin.cpp Adjust includes/linking for QX11Extras 2023-07-20 11:15:46 +03:00
notificationsplugin.h Use pragma once in plugins 2023-07-22 20:51:19 +00:00
README Update readme 2023-03-31 21:00:48 +02:00
sendreplydialog.cpp Simplify slots of some KCMs 2023-07-22 20:51:19 +00:00
sendreplydialog.h Use pragma once in plugins 2023-07-22 20:51:19 +00:00
sendreplydialog.ui [sendreplydialog] Move focus on tab 2021-09-26 17:27:42 +00:00

This plugin listens to packages with type "kdeconnect.notification" that will
contain all the information of the other device notifications.

The other device will report us every notification that is created or dismissed,
so we can keep in sync a local list of notifications.

At the beginning we can request the already existing notifications by sending a
package with the boolean "request" set to true.

The received packages will contain the following fields:

"id" (string): A unique notification id.
"appName" (string): The app that generated the notification
"ticker" (string): The title or headline of the notification, for compatibility with older Android versions.
"isClearable" (boolean): True if we can request to dismiss the notification.
"isCancel" (boolean): True if the notification was dismissed in the peer device.
"title" (string): The title of the notification.
"text" (string): The text/content of the notification.
"requestReplyId" (string): Used to reply to messages.
"silent" (bool): Don't show a notification popup for this notification.

Additionally the package can contain a payload with the icon of the notification
in PNG format. If there another field will be present:

"payloadHash" (string): MD5 hash of the payload. Used as a filename to store the payload.

The content of these fields is used to display the notifications to the user.
Note that if we receive a second notification with the same "id", the existing notification is updated.

If the user dismisses a notification from this device, we have to request the
other device to remove it. This is done by sending a package with the fields
"id" set to the id of the notification we want to dismiss and a boolean "cancel"
set to true. The other device will answer with a notification package with
"isCancel" set to true when it is dismissed.