Skip to main content

Interface: MonitoringApiInterface

Defined in: electron/preload/domains/monitoringApi.ts:56

Interface defining the monitoring domain API operations.

Hierarchy

View Summary

Extends

Properties

checkSiteNow

checkSiteNow: IpcBridgeMethod<"check-site-now">

Defined in: electron/preload/domains/monitoringApi.ts:63

Performs an immediate check for a specific monitor

Returns

Promise resolving to the latest StatusUpdate or undefined when no update is available

Overrides

MonitoringChannelMap.checkSiteNow


startMonitoring

startMonitoring: IpcBridgeMethod<"start-monitoring">

Defined in: electron/preload/domains/monitoringApi.ts:71

Starts the global monitoring system

Returns

Promise resolving to the lifecycle summary returned by the backend.

Overrides

MonitoringChannelMap.startMonitoring


startMonitoringForMonitor

startMonitoringForMonitor: IpcBridgeMethod<"start-monitoring-for-monitor">

Defined in: electron/preload/domains/monitoringApi.ts:78

Starts monitoring for a specific monitor within a site

Returns

Promise resolving to true if monitoring started successfully

Overrides

MonitoringChannelMap.startMonitoringForMonitor


startMonitoringForSite

startMonitoringForSite: IpcBridgeMethod<"start-monitoring-for-site">

Defined in: electron/preload/domains/monitoringApi.ts:85

Starts monitoring for all monitors belonging to a specific site

Returns

Promise resolving to true if monitoring started successfully

Overrides

MonitoringChannelMap.startMonitoringForSite


stopMonitoring

stopMonitoring: IpcBridgeMethod<"stop-monitoring">

Defined in: electron/preload/domains/monitoringApi.ts:93

Stops the global monitoring system

Returns

Promise resolving to the lifecycle summary returned by the backend.

Overrides

MonitoringChannelMap.stopMonitoring


stopMonitoringForMonitor

stopMonitoringForMonitor: IpcBridgeMethod<"stop-monitoring-for-monitor">

Defined in: electron/preload/domains/monitoringApi.ts:100

Stops monitoring for a specific monitor within a site

Returns

Promise resolving to true if monitoring stopped successfully

Overrides

MonitoringChannelMap.stopMonitoringForMonitor


stopMonitoringForSite

stopMonitoringForSite: IpcBridgeMethod<"stop-monitoring-for-site">

Defined in: electron/preload/domains/monitoringApi.ts:107

Stops monitoring for all monitors belonging to a specific site

Returns

Promise resolving to true if monitoring stopped successfully

Overrides

MonitoringChannelMap.stopMonitoringForSite