Class Notifications

Notifications Service

Freedesktop Notifications daemon service that receives, stores, and manages desktop notifications.

Lifecycle:

Construction - Register D-Bus service, restore cached notifications
Ready - Receive and manage notifications
Disposal - Cleanup all notifications, timeouts, and D-Bus registration

Fires

notified - Emitted when new notification is received (id: number)

Fires

dismissed - Emitted when notification popup is dismissed (id: number)

Fires

closed - Emitted when notification is closed (id: number)

Fires

changed - Emitted when notification state changes

Hierarchy (View Summary)

default
- Notifications

Implements

Disposable

Accessors

dnd

get dnd(): boolean
Whether Do Not Disturb mode is enabled (suppresses popups).

Returns boolean
- Defined in src/service/notifications.ts:513
set dnd(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/service/notifications.ts:517

isDisposed

get isDisposed(): boolean
Check if service has been disposed

Returns boolean
Inherited from Service.isDisposed
- Defined in src/service.ts:411

notifications

get notifications(): Notification[]
All stored notifications.

Returns Notification[]
- Defined in src/service/notifications.ts:523

popups

get popups(): Notification[]
Notifications currently shown as popups.

Returns Notification[]
- Defined in src/service/notifications.ts:528

Constructors

constructor

new Notifications(): Notifications
Returns Notifications
Overrides default.constructor
- Defined in src/service/notifications.ts:504

Methods

bind

bind<
    Prop extends
        | "notifications"
        | "isDisposed"
        | "$signals"
        | "popupTimeout"
        | "forceTimeout"
        | "cacheActions"
        | "clearDelay"
        | "dnd"
        | "popups",
>(
    prop: Prop,
): Binding<Notifications, Prop, Notifications[Prop]>
Creates a Binding for a property on this service.
Type Parameters
- Prop extends
      | "notifications"
      | "isDisposed"
      | "$signals"
      | "popupTimeout"
      | "forceTimeout"
      | "cacheActions"
      | "clearDelay"
      | "dnd"
      | "popups"
Parameters
- prop: Prop
  The property to bind
Returns Binding<Notifications, Prop, Notifications[Prop]>
A Binding that can be used in widget constructors
Example
```
const label = Widget.Label({
    label: audio.bind('volume').as(v => `${Math.round(v * 100)}%`),
});
```
Inherited from default.bind
- Defined in src/service.ts:348

changed

changed(property: string): void
Notifies listeners that a property changed and emits the 'changed' signal.
Parameters
- property: string
  The property name that changed
Returns void
Inherited from default.changed
- Defined in src/service.ts:330

`Readonly`clear

clear(): Promise<unknown[]>
Closes all notifications with a staggered delay between each.

Returns Promise<unknown[]>
- Defined in src/service/notifications.ts:646

Clear

Clear(): void
D-Bus Clear method: closes all notifications.

Returns void
- Defined in src/service/notifications.ts:594

CloseNotification

CloseNotification(id: number): void
Closes and removes a notification entirely.
Parameters
- id: number
  The notification ID to close
Returns void
- Defined in src/service/notifications.ts:612

connect

connect(signal?: string, callback: (_: this, ...args: any[]) => void): number
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
Inherited from default.connect
- Defined in src/service.ts:272

diffBind

diffBind<
    Item,
    Prop extends

            | "notifications"
            | "isDisposed"
            | "$signals"
            | "popupTimeout"
            | "forceTimeout"
            | "cacheActions"
            | "clearDelay"
            | "dnd"
            | "popups",
>(
    prop: Prop,
    opts: {
        create: (item: Item) => Widget;
        key: (item: Item) => string | number;
        update?: (widget: Widget, item: Item) => void;
    },
): Binding<Notifications, Prop, Widget[]>
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
      | "notifications"
      | "isDisposed"
      | "$signals"
      | "popupTimeout"
      | "forceTimeout"
      | "cacheActions"
      | "clearDelay"
      | "dnd"
      | "popups"
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<Notifications, Prop, Widget[]>
A Binding that produces an array of widgets
Example
```
const children = audio.diffBind('speakers', {
    key: (s) => s.name,
    create: (s) => Widget.Label({ label: s.description }),
    update: (w, s) => { w.label = s.description; },
});
```
Inherited from default.diffBind
- Defined in src/service.ts:472

`Protected`disconnectAll

disconnectAll(): void
Clean up all tracked signal connections Call this in service-specific dispose implementations

Returns void
Inherited from default.disconnectAll
- Defined in src/service.ts:380

DismissNotification

DismissNotification(id: number): void
Dismisses a notification popup without removing it.
Parameters
- id: number
  The notification ID to dismiss
Returns void
- Defined in src/service/notifications.ts:603

dispose

dispose(): void
Dispose of service resources Override in subclasses to add specific cleanup

Returns void
Implementation of Disposable.dispose
Overrides default.dispose
- Defined in src/service/notifications.ts:767

emit

emit(signal: string, ...args: any[]): 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
Inherited from default.emit
- Defined in src/service.ts:283

GetCapabilities

GetCapabilities(): string[]
Returns the list of capabilities supported by this notification daemon.

Returns string[]
- Defined in src/service/notifications.ts:627

`Readonly`getNotification

getNotification(id: number): Notification | undefined
Retrieves a notification by its ID.
Parameters
- id: number
  The notification ID
Returns Notification | undefined
The Notification or undefined
- Defined in src/service/notifications.ts:553

`Readonly`getPopup

getPopup(id: number): Notification | null
Retrieves a notification by ID only if it is currently a popup.
Parameters
- id: number
  The notification ID
Returns Notification | null
The Notification if it is a popup, otherwise null
- Defined in src/service/notifications.ts:542

GetServerInformation

GetServerInformation(): Variant<"(ssss)">
Returns server name, vendor, version, and spec version as a D-Bus variant.

Returns Variant<"(ssss)">
- Defined in src/service/notifications.ts:641

InvokeAction

InvokeAction(id: number, actionId: string): void
Invokes an action on a notification.
Parameters
- id: number
  The notification ID
- actionId: string
  The action identifier to invoke
Returns void
- Defined in src/service/notifications.ts:622

Notify

Notify(
    appName: string,
    replacesId: number,
    appIcon: string,
    summary: string,
    body: string,
    acts: string[],
    hints: Hints,
    expiration: number,
): number
D-Bus Notify method handler: creates or replaces a notification.
Parameters
- appName: string
- replacesId: number
- appIcon: string
- summary: string
- body: string
- acts: string[]
- hints: Hints
- expiration: number
Returns number
- Defined in src/service/notifications.ts:558

`Protected`retryWithBackoff

retryWithBackoff<T>(
    operation: () => Promise<T>,
    maxRetries?: number,
    baseDelay?: number,
): Promise<T>
Retry a DBus operation with exponential backoff
Type Parameters
- T
Parameters
- operation: () => Promise<T>
- maxRetries: number = 3
- baseDelay: number = 100
Returns Promise<T>
Inherited from default.retryWithBackoff
- Defined in src/service.ts:418

`Protected`trackConnection

trackConnection(emitter: Object, id: number): void
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
Inherited from default.trackConnection
- Defined in src/service.ts:361
trackConnection(id: number): void
Track a signal connection for automatic cleanup
Parameters
- id: number
  The signal connection ID
Returns void
Inherited from default.trackConnection
- Defined in src/service.ts:362

updateProperty

updateProperty(prop: string, value: unknown): 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
Inherited from default.updateProperty
- Defined in src/service.ts:315

`Static`import

import<S extends keyof Services>(service: S): Promise<Services[S]>
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
Example
```
const Audio = await Service.import('audio');
const Battery = await Service.import('battery');
```
Inherited from default.import
- Defined in src/service.ts:234

`Static`pspec

pspec(name: string, type?: PspecType, handle?: PspecFlag): ParamSpec<unknown>
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
Inherited from default.pspec
- Defined in src/service.ts:246

`Static`register

register(
    service: new (...args: any[]) => Object,
    signals?: { [signal: string]: PspecType[] },
    properties?: { [prop: string]: [type?: PspecType, handle?: PspecFlag] },
): void
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
Inherited from default.register
- Defined in src/service.ts:257

Properties

cacheActions

cacheActions: boolean = false

Persist actions in cache (default: false)

clearDelay

clearDelay: number = 100

Delay between closing notifications (default: 100ms)

forceTimeout

forceTimeout: boolean = false

Override application timeout (default: false)

popupTimeout

popupTimeout: number = 3000

Default popup timeout in milliseconds (default: 3000)

Class Notifications

Fires

Fires

Fires

Fires

Hierarchy (View Summary)

Implements

Index

Accessors

Constructors

Methods

Properties

Accessors

dnd

Returns boolean

Parameters

Returns void

isDisposed

Returns boolean

notifications

Returns Notification[]

popups

Returns Notification[]

Constructors

constructor

Returns Notifications

Methods

bind

Type Parameters

Parameters

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

Example

changed

Parameters

Returns void

Readonlyclear

Returns Promise<unknown[]>

Clear

Returns void

CloseNotification

Parameters

Returns void

connect

Parameters

Returns number

diffBind

Type Parameters

Parameters

Returns Binding<Notifications, Prop, Widget[]>

Example

ProtecteddisconnectAll

Returns void

DismissNotification

Parameters

Returns void

dispose

Returns void

emit

Parameters

Returns void

GetCapabilities

Returns string[]

ReadonlygetNotification

Parameters

Returns Notification | undefined

ReadonlygetPopup

Parameters

Returns Notification | null

GetServerInformation

Returns Variant<"(ssss)">

InvokeAction

Parameters

Returns void

Notify

Parameters

Returns number

ProtectedretryWithBackoff

Type Parameters

Parameters

Returns Promise<T>

`Readonly`clear

`Protected`disconnectAll

`Readonly`getNotification

`Readonly`getPopup

`Protected`retryWithBackoff

`Protected`trackConnection

`Static`import

`Static`pspec

`Static`register