[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    [kdeconnect-kde] plugins/notifications: Improve notificationsplugin README
From:       Nicolas Fella <null () kde ! org>
Date:       2018-06-30 21:14:04
Message-ID: E1fZNC0-0007pa-4l () code ! kde ! org
[Download RAW message or body]

Git commit 6c7e5adca1ce79590d541f37d4d72c780dea9be8 by Nicolas Fella.
Committed on 30/06/2018 at 21:05.
Pushed by nicolasfella into branch 'master'.

Improve notificationsplugin README

M  +9    -4    plugins/notifications/README

https://commits.kde.org/kdeconnect-kde/6c7e5adca1ce79590d541f37d4d72c780dea=
9be8

diff --git a/plugins/notifications/README b/plugins/notifications/README
index fd49e5ae..82a3a1c1 100644
--- a/plugins/notifications/README
+++ b/plugins/notifications/README
@@ -12,17 +12,22 @@ 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.
+"ticker" (string): The title or headline of the notification, for compatib=
ility with older Android versions.
 "isClearable" (boolean): True if we can request to dismiss the notificatio=
n.
 "isCancel" (boolean): True if the notification was dismissed in the peer d=
evice.
 "requestAnswer" (boolean): True if this is an answer to a "request" packag=
e.
+"title" (string): The title of the notification.
+"text" (string): The text/content of the notification.
+"requestReplyId" (string): Used to reply to messages.
+"silent" (bool): Handle this notification silent, i.e. don't show a notifi=
cation, but show it in the plasmoid.
 =

 Additionally the package can contain a payload with the icon of the notifi=
cation
-in PNG format.
+in PNG format. If there another field will be present:
+
+"payloadHash" (string): MD5 hash of the payload. Used as a filename to sto=
re the payload.
 =

 The content of these fields is used to display the notifications to the us=
er.
-Note that if we receive a second notification with the same "id", we should
-update the existent notification instead of creating a new one.
+Note that if we receive a second notification with the same "id", the exis=
ting 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 fiel=
ds
[prev in list] [next in list] [prev in thread] [next in thread]