Interface: MonitoringApiInterface
Defined in: electron/preload/domains/monitoringApi.ts:28
Interface defining the monitoring domain API operations.
Extends
Properties
checkSiteNow()
checkSiteNow: (...
args: [string,string]) =>Promise<StatusUpdate|undefined>
Defined in: electron/preload/domains/monitoringApi.ts:35
Performs an immediate check for a specific monitor
Parameters
args
...[string, string]
Returns
Promise<StatusUpdate | undefined>
Promise resolving to the latest StatusUpdate or undefined when no update is available
Overrides
MonitoringChannelMap.checkSiteNow
startMonitoring()
startMonitoring: () =>
Promise<MonitoringStartSummary>
Defined in: electron/preload/domains/monitoringApi.ts:43
Starts the global monitoring system
Returns
Promise<MonitoringStartSummary>
Promise resolving to the lifecycle summary returned by the backend.
Overrides
MonitoringChannelMap.startMonitoring
startMonitoringForMonitor()
startMonitoringForMonitor: (...
args: [string,string]) =>Promise<boolean>
Defined in: electron/preload/domains/monitoringApi.ts:50
Starts monitoring for a specific monitor within a site
Parameters
args
...[string, string]
Returns
Promise<boolean>
Promise resolving to true if monitoring started successfully
Overrides
MonitoringChannelMap.startMonitoringForMonitor
startMonitoringForSite()
startMonitoringForSite: (...
args: [string]) =>Promise<boolean>
Defined in: electron/preload/domains/monitoringApi.ts:57
Starts monitoring for all monitors belonging to a specific site
Parameters
args
...[string]
Returns
Promise<boolean>
Promise resolving to true if monitoring started successfully
Overrides
MonitoringChannelMap.startMonitoringForSite
stopMonitoring()
stopMonitoring: () =>
Promise<MonitoringStopSummary>
Defined in: electron/preload/domains/monitoringApi.ts:65
Stops the global monitoring system
Returns
Promise<MonitoringStopSummary>
Promise resolving to the lifecycle summary returned by the backend.
Overrides
MonitoringChannelMap.stopMonitoring
stopMonitoringForMonitor()
stopMonitoringForMonitor: (...
args: [string,string]) =>Promise<boolean>
Defined in: electron/preload/domains/monitoringApi.ts:72
Stops monitoring for a specific monitor within a site
Parameters
args
...[string, string]
Returns
Promise<boolean>
Promise resolving to true if monitoring stopped successfully
Overrides
MonitoringChannelMap.stopMonitoringForMonitor
stopMonitoringForSite()
stopMonitoringForSite: (...
args: [string]) =>Promise<boolean>
Defined in: electron/preload/domains/monitoringApi.ts:79
Stops monitoring for all monitors belonging to a specific site
Parameters
args
...[string]
Returns
Promise<boolean>
Promise resolving to true if monitoring stopped successfully