data/dbus: Document important hint

The important hint can be used by apps to override the current per app
or system wide feedback level (if the feedback server allows it).
This commit is contained in:
Guido Günther
2024-04-20 13:21:56 +00:00
committed by Guido Günther
parent 106663e41c
commit f71ece5d8b
+4
View File
@@ -22,6 +22,10 @@
@event: The event name from the Event naming spec @event: The event name from the Event naming spec
@hints: Additional hints. Currently known hints @hints: Additional hints. Currently known hints
- profile: Override the profile used for this event with the given profile name - profile: Override the profile used for this event with the given profile name
- important: Override the current global feedback level.
Together with the 'profile' hint this allows to trigger feedback for events
that would otherwise be disabled. A typical use case is an alarm clock. Note
that the feedback daemon (depending on it's configuration) might ignore this flag.
@timeout: When the feedbacks for this event should end latest in seconds. The special values '-1' (just run each feedback once) and '0' (endless loop) are also supported. @timeout: When the feedbacks for this event should end latest in seconds. The special values '-1' (just run each feedback once) and '0' (endless loop) are also supported.
@id: Event id for future reference @id: Event id for future reference