{ "name": "NotificationServer", "module": "Quickshell.Services.Notifications", "type": "class", "super": { "type": "qt", "module": "qml.QtQml", "name": "QtObject" }, "description": "Desktop Notifications Server.", "details": "An implementation of the [Desktop Notifications Specification] for receiving notifications\nfrom external applications.\n\nThe server does not advertise most capabilities by default. See the individual properties for details.\n\n[Desktop Notifications Specification]: https://specifications.freedesktop.org/notification-spec/notification-spec-latest.html\n", "properties": { "persistenceSupported": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If the notification server should advertise that it can persist notifications in the background\nafter going offscreen. Defaults to false.\n" }, "imageSupported": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If the notification server should advertise that it supports images. Defaults to false.\n" }, "bodyImagesSupported": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If notification body text should be advertised as supporting images as described in [the specification]\nDefaults to false.\n\nNote that returned notifications may still contain images if this property is false, as it is only a hint.\n\n[the specification]: https://specifications.freedesktop.org/notification-spec/notification-spec-latest.html#images\n" }, "trackedNotifications": { "type": { "type": "local", "module": "Quickshell", "name": "ObjectModel", "of": { "type": "local", "module": "Quickshell.Services.Notifications", "name": "Notification" } }, "details": "All notifications currently tracked by the server.\n", "flags": [ "readonly" ] }, "actionsSupported": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If notification actions should be advertised as supported by the notification server. Defaults to false.\n" }, "bodyHyperlinksSupported": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If notification body text should be advertised as supporting hyperlinks as described in [the specification]\nDefaults to false.\n\nNote that returned notifications may still contain hyperlinks if this property is false, as it is only a hint.\n\n[the specification]: https://specifications.freedesktop.org/notification-spec/notification-spec-latest.html#hyperlinks\n" }, "bodySupported": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If notification body text should be advertised as supported by the notification server.\nDefaults to true.\n\nNote that returned notifications are likely to return body text even if this property is false,\nas it is only a hint.\n" }, "extraHints": { "type": { "type": "qt", "module": "qml", "name": "list", "of": { "type": "qt", "module": "qml", "name": "string" } }, "details": "Extra hints to expose to notification clients.\n" }, "keepOnReload": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If notifications should be re-emitted when quickshell reloads. Defaults to true.\n\nThe {{< qmltypelink type=\"local\" module=\"Quickshell.Services.Notifications\" name=\"Notification\" mtype=\"prop\" mname=\"lastGeneration\" >}} flag will be\nset on notifications from the prior generation for further filtering/handling.\n" }, "bodyMarkupSupported": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If notification body text should be advertised as supporting markup as described in [the specification]\nDefaults to false.\n\nNote that returned notifications may still contain markup if this property is false,\nas it is only a hint. By default Text objects will try to render markup. To avoid this\nif any is sent, change {{< qmltypelink type=\"qt\" module=\"qml.QtQuick\" name=\"Text\" mtype=\"prop\" mname=\"textFormat\" >}} to `PlainText`.\n" }, "actionIconsSupported": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If notification actions should be advertised as supporting the display of icons. Defaults to false.\n" } }, "functions": [], "signals": { "notification": { "name": "notification", "details": "Sent when a notification is received by the server.\n\nIf this notification should not be discarded, set its `tracked` property to true.\n", "params": [ { "name": "notification", "type": { "type": "local", "module": "Quickshell.Services.Notifications", "name": "Notification" } } ] } }, "variants": {} }