Skip to main content

Interface: SitesApiInterface

Defined in: electron/preload/domains/sitesApi.ts:35

Interface defining the sites domain API operations.

Hierarchy​

View Summary

Extends​

Properties​

addSite​

addSite: IpcBridgeMethod<"add-site">;

Defined in: electron/preload/domains/sitesApi.ts:41

Adds a new site to be monitored

Returns​

Promise resolving to the created site

Overrides​

SitesChannelMap.addSite

deleteAllSites​

deleteAllSites: IpcBridgeMethod<"delete-all-sites">;

Defined in: electron/preload/domains/sitesApi.ts:48

Deletes all sites (dangerous operation)

Returns​

Promise resolving to the number of removed sites

Overrides​

SitesChannelMap.deleteAllSites

getSites​

getSites: IpcBridgeMethod<"get-sites">;

Defined in: electron/preload/domains/sitesApi.ts:55

Retrieves all sites from the database

Returns​

Promise resolving to array of all sites

Overrides​

SitesChannelMap.getSites

removeMonitor​

removeMonitor: IpcBridgeMethod<"remove-monitor">;

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

Removes a monitor from a site

Returns​

Promise resolving to the updated site snapshot emitted by the backend after removal

Overrides​

SitesChannelMap.removeMonitor

removeSite​

removeSite: IpcBridgeMethod<"remove-site">;

Defined in: electron/preload/domains/sitesApi.ts:70

Removes a site from monitoring

Returns​

Promise resolving to a boolean indicating removal success

Overrides​

SitesChannelMap.removeSite

updateSite​

updateSite: IpcBridgeMethod<"update-site">;

Defined in: electron/preload/domains/sitesApi.ts:77

Updates an existing site's configuration

Returns​

Promise resolving to the updated site

Overrides​

SitesChannelMap.updateSite