mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-06-10 07:59:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clarify the behavior of updating/closing of notifications without identifiers

Browse Source
This commit is contained in:
Kovid Goyal
2024-07-31 14:48:31 +05:30
parent aa16918dd4
commit 59de64920f
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/desktop-notifications.rst
View File

@@ -171,9 +171,12 @@ To update a previous notification simply send a new notification with the same
*notification id* (``i`` key) as the one you want to update. If the original
notification is still displayed it will be replaced, otherwise a new
notification is displayed. This can be used, for example, to show progress of
an operation. Note that how smoothly the existing notification is replaced
an operation. How smoothly the existing notification is replaced
depends on the underlying OS, for example, on Linux the replacement is usually flicker
free, on macOS it isn't, because of Apple's design choices.
Note that if no ``i`` key is specified, no updating must take place, even if
there is a previous notification without an identifier. The terminal must
treat these as being two unique *unidentified* notifications.
To close a previous notification, send::
@@ -181,7 +184,7 @@ To close a previous notification, send::
This will close a previous notification with the specified id. If no such
notification exists (perhaps because it was already closed or it was activated)
then the request is ignored.
then the request is ignored. If no ``i`` key is specified, this must be a no-op.
Automatically expiring notifications
@@ -390,7 +393,8 @@ Key Value Default Description
``p`` One of ``title``, ``title`` Whether the payload is the notification title or body or query. If a
``body``, notification has no title, the body will be used as title. Terminal
``close``, emulators should ignore payloads of unknown type to allow for future
``?``, ``alive`` expansion of this protocol.
``icon``, expansion of this protocol.
``?``, ``alive``
``t`` :ref:`base64` ``unset`` The type of the notification. Used to filter out notifications. Can be specified multiple times.
encoded UTF-8