Skip to main content

Interface: EventsDomainBridge

Defined in: shared/types/eventsBridge.ts:35

Contract for the preload events bridge exposed to the renderer.

Properties​

onCacheInvalidated()​

readonly onCacheInvalidated: (callback: (data: CacheInvalidatedEventData) => void) => () => void

Defined in: shared/types/eventsBridge.ts:44

Payload for cache invalidation notifications.

Parameters​

callback​

(data: CacheInvalidatedEventData) => void

Invoked with payloads emitted on the cache:invalidated channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

onHistoryLimitUpdated()​

readonly onHistoryLimitUpdated: (callback: (data: HistoryLimitUpdatedEventData) => void) => () => void

Defined in: shared/types/eventsBridge.ts:56

Payload for database history retention updates.

Parameters​

callback​

(data: HistoryLimitUpdatedEventData) => void

Invoked with payloads emitted on the settings:history-limit-updated channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

onMonitorCheckCompleted()​

readonly onMonitorCheckCompleted: (callback: (data: MonitorCheckCompletedEventData) => void) => () => void

Defined in: shared/types/eventsBridge.ts:68

Payload for monitor check completion events.

Parameters​

callback​

(data: MonitorCheckCompletedEventData) => void

Invoked with payloads emitted on the monitor:check-completed channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

onMonitorDown()​

readonly onMonitorDown: (callback: (data: MonitorDownEventData) => void) => () => void

Defined in: shared/types/eventsBridge.ts:80

Payload for monitor down events.

Parameters​

callback​

(data: MonitorDownEventData) => void

Invoked with payloads emitted on the monitor:down channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

onMonitoringStarted()​

readonly onMonitoringStarted: (callback: (data: MonitoringControlEventData & { monitorCount: number; siteCount: number; summary?: MonitoringStartSummary; }) => void) => () => void

Defined in: shared/types/eventsBridge.ts:92

Payload for monitoring started events.

Parameters​

callback​

(data: MonitoringControlEventData & { monitorCount: number; siteCount: number; summary?: MonitoringStartSummary; }) => void

Invoked with payloads emitted on the monitoring:started channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

onMonitoringStopped()​

readonly onMonitoringStopped: (callback: (data: MonitoringControlEventData & { activeMonitors: number; reason: MonitoringControlReason; summary?: MonitoringStopSummary; }) => void) => () => void

Defined in: shared/types/eventsBridge.ts:104

Payload for monitoring stopped events.

Parameters​

callback​

(data: MonitoringControlEventData & { activeMonitors: number; reason: MonitoringControlReason; summary?: MonitoringStopSummary; }) => void

Invoked with payloads emitted on the monitoring:stopped channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

onMonitorStatusChanged()​

readonly onMonitorStatusChanged: (callback: (data: StatusUpdate) => void) => () => void

Defined in: shared/types/eventsBridge.ts:116

Payload for monitor status change events.

Parameters​

callback​

(data: StatusUpdate) => void

Invoked with payloads emitted on the monitor:status-changed channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

onMonitorUp()​

readonly onMonitorUp: (callback: (data: MonitorUpEventData) => void) => () => void

Defined in: shared/types/eventsBridge.ts:128

Payload for monitor up events.

Parameters​

callback​

(data: MonitorUpEventData) => void

Invoked with payloads emitted on the monitor:up channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

onSiteAdded()​

readonly onSiteAdded: (callback: (data: { site: Site; source: "import" | "migration" | "user"; timestamp: number; }) => void) => () => void

Defined in: shared/types/eventsBridge.ts:140

Payload for site added events.

Parameters​

callback​

(data: { site: Site; source: "import" | "migration" | "user"; timestamp: number; }) => void

Invoked with payloads emitted on the site:added channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

onSiteRemoved()​

readonly onSiteRemoved: (callback: (data: { cascade: boolean; siteIdentifier: string; siteName: string; timestamp: number; }) => void) => () => void

Defined in: shared/types/eventsBridge.ts:152

Payload for site removed events.

Parameters​

callback​

(data: { cascade: boolean; siteIdentifier: string; siteName: string; timestamp: number; }) => void

Invoked with payloads emitted on the site:removed channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

onSiteUpdated()​

readonly onSiteUpdated: (callback: (data: { previousSite: Site; site: Site; timestamp: number; updatedFields: string[]; }) => void) => () => void

Defined in: shared/types/eventsBridge.ts:164

Payload for site updated events.

Parameters​

callback​

(data: { previousSite: Site; site: Site; timestamp: number; updatedFields: string[]; }) => void

Invoked with payloads emitted on the site:updated channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

onStateSyncEvent()​

readonly onStateSyncEvent: (callback: (data: StateSyncEventData) => void) => () => void

Defined in: shared/types/eventsBridge.ts:176

Payload for full state synchronisation broadcasts.

Parameters​

callback​

(data: StateSyncEventData) => void

Invoked with payloads emitted on the state-sync-event channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

onTestEvent()​

readonly onTestEvent: (callback: (data: TestEventPayload) => void) => () => void

Defined in: shared/types/eventsBridge.ts:188

Payload for development/test events.

Parameters​

callback​

(data: TestEventPayload) => void

Invoked with payloads emitted on the test-event channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

onUpdateStatus()​

readonly onUpdateStatus: (callback: (data: UpdateStatusEventData) => void) => () => void

Defined in: shared/types/eventsBridge.ts:200

Payload for auto-updater status notifications.

Parameters​

callback​

(data: UpdateStatusEventData) => void

Invoked with payloads emitted on the update-status channel.

Returns​

Cleanup function that removes the registered listener.

(): void

Returns​

void

removeAllListeners()​

readonly removeAllListeners: () => void

Defined in: shared/types/eventsBridge.ts:207

Remove all registered renderer event listeners.

Returns​

void