Interface: EventsDomainBridge
Defined in: shared/types/eventsBridge.ts:35
Contract for the preload events bridge exposed to the renderer.
Properties
onCacheInvalidated()
readonlyonCacheInvalidated: (callback: (data:CacheInvalidatedEventData) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:44
Subscribe to events emitted on the cache:invalidated channel.
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()
readonlyonHistoryLimitUpdated: (callback: (data:HistoryLimitUpdatedEventData) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:57
Subscribe to events emitted on the settings:history-limit-updated
channel.
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()
readonlyonMonitorCheckCompleted: (callback: (data:MonitorCheckCompletedEventData) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:69
Subscribe to events emitted on the monitor:check-completed channel.
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()
readonlyonMonitorDown: (callback: (data:MonitorDownEventData) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:81
Subscribe to events emitted on the monitor:down channel.
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()
readonlyonMonitoringStarted: (callback: (data:MonitoringStartedEventData) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:93
Subscribe to events emitted on the monitoring:started channel.
Parameters
callback
(data: MonitoringStartedEventData) => void
Invoked with payloads emitted on the
monitoring:started channel.
Returns
Cleanup function that removes the registered listener.
():
void
Returns
void
onMonitoringStopped()
readonlyonMonitoringStopped: (callback: (data:MonitoringStoppedEventData) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:105
Subscribe to events emitted on the monitoring:stopped channel.
Parameters
callback
(data: MonitoringStoppedEventData) => void
Invoked with payloads emitted on the
monitoring:stopped channel.
Returns
Cleanup function that removes the registered listener.
():
void
Returns
void
onMonitorStatusChanged()
readonlyonMonitorStatusChanged: (callback: (data:StatusUpdate) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:117
Subscribe to events emitted on the monitor:status-changed channel.
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()
readonlyonMonitorUp: (callback: (data:MonitorUpEventData) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:129
Subscribe to events emitted on the monitor:up channel.
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()
readonlyonSiteAdded: (callback: (data: {site:Site;source:"import"|"migration"|"user";timestamp:number; }) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:141
Subscribe to events emitted on the site:added channel.
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()
readonlyonSiteRemoved: (callback: (data: {cascade:boolean;siteIdentifier:string;siteName:string;timestamp:number; }) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:153
Subscribe to events emitted on the site:removed channel.
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()
readonlyonSiteUpdated: (callback: (data: {previousSite:Site;site:Site;timestamp:number;updatedFields:string[]; }) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:165
Subscribe to events emitted on the site:updated channel.
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()
readonlyonStateSyncEvent: (callback: (data:StateSyncEventData) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:177
Subscribe to events emitted on the state-sync-event channel.
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()
readonlyonTestEvent: (callback: (data:TestEventPayload) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:189
Subscribe to events emitted on the test-event channel.
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()
readonlyonUpdateStatus: (callback: (data:UpdateStatusEventData) =>void) => () =>void
Defined in: shared/types/eventsBridge.ts:201
Subscribe to events emitted on the update-status channel.
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()
readonlyremoveAllListeners: () =>void
Defined in: shared/types/eventsBridge.ts:208
Remove all registered renderer event listeners.
Returns
void