Skip to main content

LinuxOptions

Hints for a Linux freedesktop notification server.

Note

Feature support varies by desktop and notification daemon. Unsupported hints may be ignored. This extension does not expose server-capability queries.

Properties

  • action_key_as_icon_name - Whether to show action buttons as icons.
  • category - Category hint used by the server to classify the notification.
  • icon - Theme icon name or absolute device file path.
  • resident - Whether to retain the notification after an action is invoked.
  • silent - Whether to ask the server to suppress notification sounds.
  • sound - Name of a sound from the desktop sound theme, such as "message".
  • timeout - Requested time to keep the notification visible.
  • transient - Whether to bypass notification history or persistence.
  • urgency - Urgency hint.

Properties​

action_key_as_icon_nameclass-attributeinstance-attribute​

action_key_as_icon_name: bool | None = None

Whether to show action buttons as icons.

The notification server reads each NotificationAction.id as an icon name from the desktop's icon theme, such as "mail-reply-sender", and uses the action's title as the icon's accessible label.

Note

Requires support from the desktop notification server.

categoryclass-attributeinstance-attribute​

category: LinuxCategory | None = None

Category hint used by the server to classify the notification.

Note

See LinuxCategory. The notification server determines the presentation and may ignore this hint.

iconclass-attributeinstance-attribute​

icon: str | None = None

Theme icon name or absolute device file path.

The bridge also recognizes a file:// prefix as a file-icon source; theme names such as "dialog-information" use the desktop's installed icon theme.

residentclass-attributeinstance-attribute​

resident: bool | None = None

Whether to retain the notification after an action is invoked.

Note

The user or application must remove resident notifications; requires persistence support from the notification server.

silentclass-attributeinstance-attribute​

silent: bool | None = None

Whether to ask the server to suppress notification sounds.

Useful when the application plays its own sound.

soundclass-attributeinstance-attribute​

sound: str | None = None

Name of a sound from the desktop sound theme, such as "message".

timeoutclass-attributeinstance-attribute​

timeout: DurationValue | None = None

Requested time to keep the notification visible.

Integer values are interpreted as milliseconds. None or -1 uses the notification server's timeout; 0 requests no expiry.

Note

The server can ignore this hint or apply its own policy, especially for critical notifications.

transientclass-attributeinstance-attribute​

transient: bool | None = None

Whether to bypass notification history or persistence.

Note

Requires support from the desktop notification server.

urgencyclass-attributeinstance-attribute​

urgency: LinuxUrgency | None = None

Urgency hint.