Skip to main content

Interface: MonitoringServiceContract

Defined in: src/services/MonitoringService.ts:145

Contract for renderer-facing monitoring operations.

Remarksโ€‹

All operations are asynchronous and delegate to the monitoring preload domain. Implementations must ensure the Electron bridge is initialized before invoking any underlying channel.

Propertiesโ€‹

checkSiteNow()โ€‹

checkSiteNow: (siteIdentifier: string, monitorId: string) => Promise<StatusUpdate | undefined>

Defined in: src/services/MonitoringService.ts:149

Performs an immediate manual check for a specific monitor.

Parametersโ€‹

siteIdentifierโ€‹

string

monitorIdโ€‹

string

Returnsโ€‹

Promise<StatusUpdate | undefined>


initialize()โ€‹

initialize: () => Promise<void>

Defined in: src/services/MonitoringService.ts:156

Ensures the monitoring bridge is initialized prior to IPC usage.

Returnsโ€‹

Promise<void>


startMonitoring()โ€‹

startMonitoring: () => Promise<MonitoringStartSummary>

Defined in: src/services/MonitoringService.ts:160

Starts monitoring across all configured sites.

Returnsโ€‹

Promise<MonitoringStartSummary>


startMonitoringForMonitor()โ€‹

startMonitoringForMonitor: (siteIdentifier: string, monitorId: string) => Promise<void>

Defined in: src/services/MonitoringService.ts:164

Starts monitoring for a single monitor within a site.

Parametersโ€‹

siteIdentifierโ€‹

string

monitorIdโ€‹

string

Returnsโ€‹

Promise<void>


startMonitoringForSite()โ€‹

startMonitoringForSite: (siteIdentifier: string) => Promise<void>

Defined in: src/services/MonitoringService.ts:171

Starts monitoring for every monitor within the specified site.

Parametersโ€‹

siteIdentifierโ€‹

string

Returnsโ€‹

Promise<void>


stopMonitoring()โ€‹

stopMonitoring: () => Promise<MonitoringStopSummary>

Defined in: src/services/MonitoringService.ts:175

Stops monitoring across all configured sites.

Returnsโ€‹

Promise<MonitoringStopSummary>


stopMonitoringForMonitor()โ€‹

stopMonitoringForMonitor: (siteIdentifier: string, monitorId: string) => Promise<void>

Defined in: src/services/MonitoringService.ts:179

Stops monitoring for a specific monitor within a site.

Parametersโ€‹

siteIdentifierโ€‹

string

monitorIdโ€‹

string

Returnsโ€‹

Promise<void>


stopMonitoringForSite()โ€‹

stopMonitoringForSite: (siteIdentifier: string) => Promise<void>

Defined in: src/services/MonitoringService.ts:186

Stops monitoring for every monitor belonging to the specified site.

Parametersโ€‹

siteIdentifierโ€‹

string

Returnsโ€‹

Promise<void>