Interface: EventsServiceContract
Defined in: src/services/EventsService.ts:152
Contract describing the event subscription surface exposed by the
EventsService facade.
Properties
initialize()
initialize: () =>
Promise<void>
Defined in: src/services/EventsService.ts:153
Returns
Promise<void>
onCacheInvalidated()
onCacheInvalidated: (
callback: (data:CacheInvalidatedEventData) =>void) =>Promise<() =>void>
Defined in: src/services/EventsService.ts:154
Parameters
callback
(data: CacheInvalidatedEventData) => void
Returns
Promise<() => void>
onHistoryLimitUpdated()
onHistoryLimitUpdated: (
callback: (data:HistoryLimitUpdatedEventData) =>void) =>Promise<() =>void>
Defined in: src/services/EventsService.ts:157
Parameters
callback
(data: HistoryLimitUpdatedEventData) => void
Returns
Promise<() => void>
onMonitorCheckCompleted()
onMonitorCheckCompleted: (
callback: (data:MonitorCheckCompletedEventData) =>void) =>Promise<() =>void>
Defined in: src/services/EventsService.ts:160
Parameters
callback
(data: MonitorCheckCompletedEventData) => void
Returns
Promise<() => void>
onMonitorDown()
onMonitorDown: (
callback: (data:MonitorDownEventData) =>void) =>Promise<() =>void>
Defined in: src/services/EventsService.ts:163
Parameters
callback
(data: MonitorDownEventData) => void
Returns
Promise<() => void>
onMonitoringStarted()
onMonitoringStarted: (
callback: (data:MonitoringControlEventData& {monitorCount:number;siteCount:number;summary?:MonitoringStartSummary; }) =>void) =>Promise<() =>void>
Defined in: src/services/EventsService.ts:166
Parameters
callback
(data: MonitoringControlEventData & { monitorCount: number; siteCount: number; summary?: MonitoringStartSummary; }) => void
Returns
Promise<() => void>
onMonitoringStopped()
onMonitoringStopped: (
callback: (data:MonitoringControlEventData& {activeMonitors:number;reason:MonitoringControlReason;summary?:MonitoringStopSummary; }) =>void) =>Promise<() =>void>
Defined in: src/services/EventsService.ts:169
Parameters
callback
(data: MonitoringControlEventData & { activeMonitors: number; reason: MonitoringControlReason; summary?: MonitoringStopSummary; }) => void
Returns
Promise<() => void>
onMonitorStatusChanged()
onMonitorStatusChanged: (
callback: (update:StatusUpdate) =>void) =>Promise<() =>void>
Defined in: src/services/EventsService.ts:172
Parameters
callback
(update: StatusUpdate) => void
Returns
Promise<() => void>
onMonitorUp()
onMonitorUp: (
callback: (data:MonitorUpEventData) =>void) =>Promise<() =>void>
Defined in: src/services/EventsService.ts:175
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:178
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:181
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:184
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:187
Parameters
callback
(data: TestEventData) => void
Returns
Promise<() => void>
onUpdateStatus()
onUpdateStatus: (
callback: (data:UpdateStatusEventData) =>void) =>Promise<() =>void>
Defined in: src/services/EventsService.ts:190
Parameters
callback
(data: UpdateStatusEventData) => void
Returns
Promise<() => void>