RAGS - v1.11.0
    Preparing search index...

    Class Notification

    Notification

    Represents a single desktop notification with its metadata, actions, and lifecycle.

    Lifecycle:

    1. Construction - Parse notification data and hints
    2. Active - Handle dismiss, close, and action invocation
    3. Disposal - Cleanup resources

    dismissed - Emitted when popup is dismissed

    closed - Emitted when notification is closed

    invoked - Emitted when action is invoked

    Hierarchy (View Summary)

    Implements

    Index

    Accessors

    action_icons actions app_entry app_icon app_name body category hints id image isDisposed popup resident sound_file sound_name summary suppress_sound time timeout transient urgency x y

    Constructors

    constructor

    Methods

    bind changed close connect diffBind disconnectAll dismiss dispose emit invoke retryWithBackoff toJson trackConnection updateProperty fromJson import pspec register

    Accessors

    app_entry

    body

    • get image(): string | undefined

      Path to the notification image (cached from image-data or image-path).

      Returns string | undefined

    • get isDisposed(): boolean

      Check if service has been disposed

      Returns boolean

    • get resident(): boolean | undefined

      Whether the notification persists after action invocation.

      Returns boolean | undefined

    Constructors

    • Parameters

      • appName: string
      • id: number
      • appIcon: string
      • summary: string
      • body: string
      • acts: string[]
      • hints: Hints
      • popup: boolean

      Returns Notification

    Methods

    • Creates a Binding for a property on this service.

      Type Parameters

      • Prop extends
            | "isDisposed"
            | "$signals"
            | "id"
            | "timeout"
            | "summary"
            | "body"
            | "x"
            | "y"
            | "action_icons"
            | "actions"
            | "app_entry"
            | "app_icon"
            | "app_name"
            | "category"
            | "image"
            | "popup"
            | "resident"
            | "sound_file"
            | "sound_name"
            | "suppress_sound"
            | "time"
            | "transient"
            | "urgency"
            | "hints"

      Parameters

      • prop: Prop

        The property to bind

      Returns Binding<Notification, Prop, Notification[Prop]>

      A Binding that can be used in widget constructors

      const label = Widget.Label({
          label: audio.bind('volume').as(v => `${Math.round(v * 100)}%`),
      });

    • Notifies listeners that a property changed and emits the 'changed' signal.

      Parameters

      • property: string

        The property name that changed

      Returns void

    • Connects a callback to a signal on this service.

      Parameters

      • signal: string = 'changed'

        The signal name (defaults to 'changed')

      • callback: (_: this, ...args: any[]) => void

        The callback to invoke when the signal is emitted

      Returns number

      The signal connection ID

    • Creates an incremental list binding that reuses existing widgets.

      Instead of recreating all widgets on every update, this method caches widgets by a key function and only creates new widgets for new items, destroying widgets for removed items.

      Type Parameters

      • Item
      • Prop extends
            | "isDisposed"
            | "$signals"
            | "id"
            | "timeout"
            | "summary"
            | "body"
            | "x"
            | "y"
            | "action_icons"
            | "actions"
            | "app_entry"
            | "app_icon"
            | "app_name"
            | "category"
            | "image"
            | "popup"
            | "resident"
            | "sound_file"
            | "sound_name"
            | "suppress_sound"
            | "time"
            | "transient"
            | "urgency"
            | "hints"

      Parameters

      • prop: Prop

        The property containing the item array

      • opts: {
            create: (item: Item) => Widget;
            key: (item: Item) => string | number;
            update?: (widget: Widget, item: Item) => void;
        }

        Key extractor, widget factory, and optional update callback

      Returns Binding<Notification, Prop, Widget[]>

      A Binding that produces an array of widgets

      const children = audio.diffBind('speakers', {
          key: (s) => s.name,
          create: (s) => Widget.Label({ label: s.description }),
          update: (w, s) => { w.label = s.description; },
      });

    • Clean up all tracked signal connections Call this in service-specific dispose implementations

      Returns void

    • Emits a signal, warning if the signal was not registered via Service.register.

      The warning is cheap (a Set lookup per emit) and helps catch typos and missing signal declarations that silently break .bind().

      Parameters

      • signal: string
      • ...args: any[]

      Returns void

    • Invokes a notification action by ID. Closes the notification if not resident.

      Parameters

      • id: string

        The action identifier to invoke

      Returns void

    • Retry a DBus operation with exponential backoff

      Type Parameters

      • T

      Parameters

      • operation: () => Promise<T>
      • maxRetries: number = 3
      • baseDelay: number = 100

      Returns Promise<T>

    • Serializes the notification to a JSON-compatible object for caching.

      Parameters

      • cacheActions: boolean = notifications.cacheActions

        Whether to include actions in the serialized output

      Returns NotifcationJson

      The serialized notification data

    • Track a signal connection for automatic cleanup

      Parameters

      • emitter: Object

        The object the signal is connected to (defaults to this)

      • id: number

        The signal connection ID

      Returns void

    • Track a signal connection for automatic cleanup

      Parameters

      • id: number

        The signal connection ID

      Returns void

    • Updates a property value and emits a notify signal if the value changed.

      Performs a deep equality check via JSON serialization to avoid unnecessary notifications.

      Parameters

      • prop: string

        The property name in kebab-case

      • value: unknown

        The new value

      Returns void

    • Dynamically imports a built-in service by name.

      Type Parameters

      • S extends keyof Services

      Parameters

      • service: S

        The service name to import

      Returns Promise<Services[S]>

      The default export of the service module

      const Audio = await Service.import('audio');
      const Battery = await Service.import('battery');

    • Creates a GObject property specification.

      Parameters

      • name: string

        The property name in kebab-case

      • type: PspecType = 'jsobject'

        The property type (defaults to 'jsobject')

      • handle: PspecFlag = 'r'

        The access flag: 'r', 'w', or 'rw' (defaults to 'r')

      Returns ParamSpec<unknown>

      A GObject.ParamSpec

    • Registers a GObject subclass with signals and properties.

      Parameters

      • service: new (...args: any[]) => Object

        The class constructor to register

      • Optionalsignals: { [signal: string]: PspecType[] }

        Map of signal names to their parameter types

      • Optionalproperties: { [prop: string]: [type?: PspecType, handle?: PspecFlag] }

        Map of property names to [type, accessFlag] tuples

      Returns void

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructors
    Methods