Skip to main content

Interface: EventsServiceContract

Defined in: src/services/EventsService.ts:89

Contract describing the event subscription surface exposed by the EventsService facade.

Properties​

initialize​

initialize: () => Promise<void>

Defined in: src/services/EventsService.ts:90

Returns​

Promise<void>

onCacheInvalidated​

onCacheInvalidated: (callback: (data: CacheInvalidatedEventData) => void) => Promise<() => void>

Defined in: src/services/EventsService.ts:91

Parameters​

callback​

(data: CacheInvalidatedEventData) => void

Returns​

Promise<() => void>

onHistoryLimitUpdated​

onHistoryLimitUpdated: (callback: (data: HistoryLimitUpdatedEventData) => void) => Promise<() => void>

Defined in: src/services/EventsService.ts:94

Parameters​

callback​

(data: HistoryLimitUpdatedEventData) => void

Returns​

Promise<() => void>

onMonitorCheckCompleted​

onMonitorCheckCompleted: (callback: (data: MonitorCheckCompletedEventData) => void) => Promise<() => void>

Defined in: src/services/EventsService.ts:97

Parameters​

callback​

(data: MonitorCheckCompletedEventData) => void

Returns​

Promise<() => void>

onMonitorDown​

onMonitorDown: (callback: (data: MonitorDownEventData) => void) => Promise<() => void>

Defined in: src/services/EventsService.ts:100

Parameters​

callback​

(data: MonitorDownEventData) => void

Returns​

Promise<() => void>

onMonitoringStarted​

onMonitoringStarted: (callback: (data: MonitoringStartedEventData) => void) => Promise<() => void>

Defined in: src/services/EventsService.ts:103

Parameters​

callback​

(data: MonitoringStartedEventData) => void

Returns​

Promise<() => void>

onMonitoringStopped​

onMonitoringStopped: (callback: (data: MonitoringStoppedEventData) => void) => Promise<() => void>

Defined in: src/services/EventsService.ts:106

Parameters​

callback​

(data: MonitoringStoppedEventData) => void

Returns​

Promise<() => void>

onMonitorStatusChanged​

onMonitorStatusChanged: (callback: (update: StatusUpdate) => void) => Promise<() => void>

Defined in: src/services/EventsService.ts:109

Parameters​

callback​

(update: StatusUpdate) => void

Returns​

Promise<() => void>

onMonitorUp​

onMonitorUp: (callback: (data: MonitorUpEventData) => void) => Promise<() => void>

Defined in: src/services/EventsService.ts:112

Parameters​

callback​

(data: MonitorUpEventData) => void

Returns​

Promise<() => void>

onSiteAdded​

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

Defined in: src/services/EventsService.ts:115

Parameters​

callback​

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

Returns​

Promise<() => void>

onSiteRemoved​

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

Defined in: src/services/EventsService.ts:118

Parameters​

callback​

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

Returns​

Promise<() => void>

onSiteUpdated​

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

Defined in: src/services/EventsService.ts:121

Parameters​

callback​

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

Returns​

Promise<() => void>

onTestEvent​

onTestEvent: (callback: (data: TestEventData) => void) => Promise<() => void>

Defined in: src/services/EventsService.ts:124

Parameters​

callback​

(data: TestEventData) => void

Returns​

Promise<() => void>

onUpdateStatus​

onUpdateStatus: (callback: (data: UpdateStatusEventData) => void) => Promise<() => void>

Defined in: src/services/EventsService.ts:127

Parameters​

callback​

(data: UpdateStatusEventData) => void

Returns​

Promise<() => void>