Skip to main content

Interface: MonitoringServiceContract

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

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:207

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:214

Ensures the monitoring bridge is initialized prior to IPC usage.

Returnsโ€‹

Promise<void>


startMonitoringโ€‹

startMonitoring: () => Promise<MonitoringStartSummary>;

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

Starts monitoring across all configured sites.

Returnsโ€‹

Promise<MonitoringStartSummary>


startMonitoringForMonitorโ€‹

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

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

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:229

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:233

Stops monitoring across all configured sites.

Returnsโ€‹

Promise<MonitoringStopSummary>


stopMonitoringForMonitorโ€‹

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

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

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:244

Stops monitoring for every monitor belonging to the specified site.

Parametersโ€‹

siteIdentifierโ€‹

string

Returnsโ€‹

Promise<void>