Skip to main content

Interface: SiteOperationsActions

Defined in: src/stores/sites/useSiteOperations.ts:238

Site operations actions exposed by the sites store.

Hierarchy​

View Summary

Extends​

Properties​

addMonitorToSite​

addMonitorToSite: (siteIdentifier: string, monitor: Monitor) => Promise<void>;

Defined in: src/stores/sites/baseTypes.ts:50

Add a monitor to an existing site

Parameters​

siteIdentifier​

string

monitor​

Monitor

Returns​

Promise<void>

Inherited from​

BaseSiteOperations.addMonitorToSite

createSite​

createSite: (siteData: {
    identifier: string;
    monitoring?: boolean;
    monitors?: Monitor[];
    name?: string;
}) => Promise<void>;

Defined in: src/stores/sites/baseTypes.ts:55

Create a new site

Parameters​

siteData​
identifier​

string

monitoring?​

boolean

monitors?​

Monitor[]

name?​

string

Returns​

Promise<void>

Inherited from​

BaseSiteOperations.createSite

deleteSite​

deleteSite: (identifier: string) => Promise<void>;

Defined in: src/stores/sites/baseTypes.ts:62

Delete a site

Parameters​

identifier​

string

Returns​

Promise<void>

Inherited from​

BaseSiteOperations.deleteSite

downloadSqliteBackup​

downloadSqliteBackup: () => Promise<SerializedDatabaseBackupResult>;

Defined in: src/stores/sites/baseTypes.ts:64

Download SQLite backup

Returns​

Promise<SerializedDatabaseBackupResult>

Inherited from​

BaseSiteOperations.downloadSqliteBackup

removeMonitorFromSite​

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

Defined in: src/stores/sites/baseTypes.ts:66

Remove a monitor from a site

Parameters​

siteIdentifier​

string

monitorId​

string

Returns​

Promise<void>

Inherited from​

BaseSiteOperations.removeMonitorFromSite

restoreSqliteBackup​

restoreSqliteBackup: (payload: SerializedDatabaseRestorePayload) =>
    Promise<SerializedDatabaseRestoreResult>;

Defined in: src/stores/sites/baseTypes.ts:71

Restore SQLite backup

Parameters​

payload​

SerializedDatabaseRestorePayload

Returns​

Promise<SerializedDatabaseRestoreResult>

Inherited from​

BaseSiteOperations.restoreSqliteBackup

saveSqliteBackup​

saveSqliteBackup: () => Promise<SerializedDatabaseBackupSaveResult>;

Defined in: src/stores/sites/baseTypes.ts:75

Save SQLite backup via main process

Returns​

Promise<SerializedDatabaseBackupSaveResult>

Inherited from​

BaseSiteOperations.saveSqliteBackup

updateMonitorRetryAttempts​

updateMonitorRetryAttempts: (
    siteIdentifier: string,
    monitorId: string,
    retryAttempts: number | undefined
) => Promise<void>;

Defined in: src/stores/sites/baseTypes.ts:77

Update monitor retry attempts

Parameters​

siteIdentifier​

string

monitorId​

string

retryAttempts​

number | undefined

New retry-attempts value. When undefined, the helper performs a no-op update for this field while still executing the underlying monitor update pipeline.

Returns​

Promise<void>

Inherited from​

BaseSiteOperations.updateMonitorRetryAttempts

updateMonitorTimeout​

updateMonitorTimeout: (
    siteIdentifier: string,
    monitorId: string,
    timeout: number | undefined
) => Promise<void>;

Defined in: src/stores/sites/baseTypes.ts:88

Update monitor timeout

Parameters​

siteIdentifier​

string

monitorId​

string

timeout​

number | undefined

New timeout value in milliseconds. When undefined, the helper leaves the existing timeout unchanged while still participating in the shared update pipeline.

Returns​

Promise<void>

Inherited from​

BaseSiteOperations.updateMonitorTimeout

updateSiteCheckInterval​

updateSiteCheckInterval: (
    siteIdentifier: string,
    monitorId: string,
    interval: number
) => Promise<void>;

Defined in: src/stores/sites/baseTypes.ts:99

Update site check interval

Parameters​

siteIdentifier​

string

monitorId​

string

interval​

number

Returns​

Promise<void>

Inherited from​

BaseSiteOperations.updateSiteCheckInterval

initializeSites​

initializeSites: () =>
    Promise<{
        message: string;
        sitesLoaded: number;
        success: boolean;
    }>;

Defined in: src/stores/sites/useSiteOperations.ts:240

Initialize sites data from backend

Returns​

Promise<{ message: string; sitesLoaded: number; success: boolean; }>

modifySite​

modifySite: (identifier: string, updates: Partial<Site>) => Promise<void>;

Defined in: src/stores/sites/useSiteOperations.ts:249

Modify an existing site

Parameters​

identifier​

string

updates​

Partial<Site>

Returns​

Promise<void>