xi-desktop-portals

commit

22560877659566837d0a4ab8e7c2b91bc13ea98d

parent

66ff71654d79988e586728e6a22ffdc9f59f126b

Author

Tobias Bengfort <tobias.bengfort@posteo.de>

Date

2026-03-14 10:46

[StatusIndicator] spec

Diffstat

1 files changed, 41 insertions, 0 deletions

diff --git a/StatusIndicator/README.md b/StatusIndicator/README.md

@@ -0,0 +1,41 @@
   -1     1 # StatusIndicator Portal
   -1     2 
   -1     3 This interface allows applications to indicate their status and provide quick
   -1     4 access to common actions.
   -1     5 
   -1     6 ## Description
   -1     7 
   -1     8 -   Applications can create a status indicator by connecting to
   -1     9     `$XDG_RUNTIME_DIR/xi.portal.StatusIndicator`.
   -1    10 -   Status indicators may contain a list of actions. These action may be
   -1    11     displayed as a menu. When an action is triggered, it is send back to the
   -1    12     application.
   -1    13 -   When the connection is closed, the status indicator is removed.
   -1    14 
   -1    15 
   -1    16 ## Open Questions
   -1    17 
   -1    18 -   Define the exact protocol.
   -1    19 
   -1    20 ## Compatibility Considerations
   -1    21 
   -1    22 While XDG Desktop Portals only provides notifications, but no status
   -1    23 indicators, this project takes the opposite approach (see
   -1    24 [notification-hub](https://github.com/xi/notification-hub) for motivation).
   -1    25 However, the two concepts are mostly compatible: Notifications can be displayed
   -1    26 as persistent status indicators, and status messages can be displayed as
   -1    27 transient notifications.
   -1    28 
   -1    29 ## Security Considerations
   -1    30 
   -1    31 -   Applications may try to cause Denial of Service by opening many simultanious
   -1    32     connections.
   -1    33 -   Actions are never executed by the host, so there is no risk of privilege
   -1    34     escalation.
   -1    35 
   -1    36 ## Related Links
   -1    37 
   -1    38 -   [org.freedesktop.StatusNotifierItem](https://www.freedesktop.org/wiki/Specifications/StatusNotifierItem/)
   -1    39 -   [org.freedesktop.Notifications](https://specifications.freedesktop.org/notification/latest/)
   -1    40 -   [org.freedesktop.portal.Notification](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Notification.html)
   -1    41 -   [notification-hub](https://github.com/xi/notification-hub)