Interface: MonitoringApiInterface
Defined in: electron/preload/domains/monitoringApi.ts:25
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
formatMonitorDetail()
formatMonitorDetail: (...
args: [string,string]) =>Promise<string>
Defined in: electron/preload/domains/monitoringApi.ts:44
Formats monitor detail information for display
Parameters
args
...[string, string]
Returns
Promise<string>
Promise resolving to formatted detail string
Overrides
MonitoringChannelMap.formatMonitorDetail
formatMonitorTitleSuffix()
formatMonitorTitleSuffix: (...
args: [string,Monitor]) =>Promise<string>
Defined in: electron/preload/domains/monitoringApi.ts:53
Formats monitor title suffix for display
Parameters
args
...[string, Monitor]
Returns
Promise<string>
Promise resolving to formatted title suffix
Overrides
MonitoringChannelMap.formatMonitorTitleSuffix
startMonitoring()
startMonitoring: () =>
Promise<MonitoringStartSummary>
Defined in: electron/preload/domains/monitoringApi.ts:61
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:71
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:80
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:88
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:98
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:107
Stops monitoring for all monitors belonging to a specific site
Parameters
args
...[string]
Returns
Promise<boolean>
Promise resolving to true if monitoring stopped successfully
Overrides
MonitoringChannelMap.stopMonitoringForSite
validateMonitorData()
validateMonitorData: (...
args: [string,unknown]) =>Promise<ValidationResult>
Defined in: electron/preload/domains/monitoringApi.ts:117
Validates monitor configuration data
Parameters
args
...[string, unknown]
Returns
Promise resolving to validation result