Skip to main content

Interface: IpcInvokeChannelMap

Defined in: shared/types/ipc.ts:237

Mapping of IPC invoke channel names to their parameter tuples and result payloads.

Propertiesโ€‹

add-siteโ€‹

add-site: {
params: readonly [Site];
result: Site;
};

Defined in: shared/types/ipc.ts:238

paramsโ€‹

params: readonly[Site];

resultโ€‹

result: Site;

check-site-nowโ€‹

check-site-now: {
params: readonly [string, string];
result: StatusUpdate | undefined;
};

Defined in: shared/types/ipc.ts:242

paramsโ€‹

params: readonly[(string, string)];

resultโ€‹

result: StatusUpdate | undefined;

cloud-clear-encryption-keyโ€‹

cloud-clear-encryption-key: {
params: readonly [];
result: CloudStatusSummary;
};

Defined in: shared/types/ipc.ts:246

paramsโ€‹

params: readonly [];

resultโ€‹

result: CloudStatusSummary;

cloud-configure-filesystem-providerโ€‹

cloud-configure-filesystem-provider: {
params: readonly [CloudFilesystemProviderConfig];
result: CloudStatusSummary;
};

Defined in: shared/types/ipc.ts:250

paramsโ€‹

params: readonly[CloudFilesystemProviderConfig];

resultโ€‹

result: CloudStatusSummary;

cloud-connect-dropboxโ€‹

cloud-connect-dropbox: {
params: readonly [];
result: CloudStatusSummary;
};

Defined in: shared/types/ipc.ts:254

paramsโ€‹

params: readonly [];

resultโ€‹

result: CloudStatusSummary;

cloud-connect-google-driveโ€‹

cloud-connect-google-drive: {
params: readonly [];
result: CloudStatusSummary;
};

Defined in: shared/types/ipc.ts:258

paramsโ€‹

params: readonly [];

resultโ€‹

result: CloudStatusSummary;

cloud-delete-backupโ€‹

cloud-delete-backup: {
params: readonly [string];
result: CloudBackupEntry[];
};

Defined in: shared/types/ipc.ts:262

paramsโ€‹

params: readonly[string];

resultโ€‹

result: CloudBackupEntry[];

cloud-disconnectโ€‹

cloud-disconnect: {
params: readonly [];
result: CloudStatusSummary;
};

Defined in: shared/types/ipc.ts:266

paramsโ€‹

params: readonly [];

resultโ€‹

result: CloudStatusSummary;

cloud-enable-syncโ€‹

cloud-enable-sync: {
params: readonly [CloudEnableSyncConfig];
result: CloudStatusSummary;
};

Defined in: shared/types/ipc.ts:270

paramsโ€‹

params: readonly[CloudEnableSyncConfig];

resultโ€‹

result: CloudStatusSummary;

cloud-get-statusโ€‹

cloud-get-status: {
params: readonly [];
result: CloudStatusSummary;
};

Defined in: shared/types/ipc.ts:274

paramsโ€‹

params: readonly [];

resultโ€‹

result: CloudStatusSummary;

cloud-list-backupsโ€‹

cloud-list-backups: {
params: readonly [];
result: CloudBackupEntry[];
};

Defined in: shared/types/ipc.ts:278

paramsโ€‹

params: readonly [];

resultโ€‹

result: CloudBackupEntry[];

cloud-migrate-backupsโ€‹

cloud-migrate-backups: {
params: readonly [CloudBackupMigrationRequest];
result: CloudBackupMigrationResult;
};

Defined in: shared/types/ipc.ts:282

paramsโ€‹

params: readonly[CloudBackupMigrationRequest];

resultโ€‹

result: CloudBackupMigrationResult;

cloud-preview-reset-remote-syncโ€‹

cloud-preview-reset-remote-sync: {
params: readonly [];
result: CloudSyncResetPreview;
};

Defined in: shared/types/ipc.ts:286

paramsโ€‹

params: readonly [];

resultโ€‹

result: CloudSyncResetPreview;

cloud-request-sync-nowโ€‹

cloud-request-sync-now: {
params: readonly [];
result: undefined;
};

Defined in: shared/types/ipc.ts:290

paramsโ€‹

params: readonly [];

resultโ€‹

result: undefined;

cloud-reset-remote-syncโ€‹

cloud-reset-remote-sync: {
params: readonly [];
result: CloudSyncResetResult;
};

Defined in: shared/types/ipc.ts:294

paramsโ€‹

params: readonly [];

resultโ€‹

result: CloudSyncResetResult;

cloud-restore-backupโ€‹

cloud-restore-backup: {
params: readonly [string];
result: SerializedDatabaseRestoreResult;
};

Defined in: shared/types/ipc.ts:298

paramsโ€‹

params: readonly[string];

resultโ€‹

result: SerializedDatabaseRestoreResult;

cloud-set-encryption-passphraseโ€‹

cloud-set-encryption-passphrase: {
params: readonly [string];
result: CloudStatusSummary;
};

Defined in: shared/types/ipc.ts:302

paramsโ€‹

params: readonly[string];

resultโ€‹

result: CloudStatusSummary;

cloud-upload-latest-backupโ€‹

cloud-upload-latest-backup: {
params: readonly [];
result: CloudBackupEntry;
};

Defined in: shared/types/ipc.ts:306

paramsโ€‹

params: readonly [];

resultโ€‹

result: CloudBackupEntry;

delete-all-sitesโ€‹

delete-all-sites: {
params: readonly [];
result: number;
};

Defined in: shared/types/ipc.ts:310

paramsโ€‹

params: readonly [];

resultโ€‹

result: number;

diagnostics-report-preload-guardโ€‹

diagnostics-report-preload-guard: {
params: readonly [{
channel: string;
guard: string;
metadata?: UnknownRecord;
payloadPreview?: string;
reason?: string;
timestamp: number;
}];
result: undefined;
};

Defined in: shared/types/ipc.ts:314

paramsโ€‹

params: readonly [{
channel: string;
guard: string;
metadata?: UnknownRecord;
payloadPreview?: string;
reason?: string;
timestamp: number;
}];

resultโ€‹

result: undefined;

diagnostics-verify-ipc-handlerโ€‹

diagnostics-verify-ipc-handler: {
params: readonly [string];
result: IpcHandlerVerificationResult;
};

Defined in: shared/types/ipc.ts:318

paramsโ€‹

params: readonly[string];

resultโ€‹

result: IpcHandlerVerificationResult;

download-sqlite-backupโ€‹

download-sqlite-backup: {
params: readonly [];
result: SerializedDatabaseBackupResult;
};

Defined in: shared/types/ipc.ts:322

paramsโ€‹

params: readonly [];

resultโ€‹

result: SerializedDatabaseBackupResult;

export-dataโ€‹

export-data: {
params: readonly [];
result: string;
};

Defined in: shared/types/ipc.ts:326

paramsโ€‹

params: readonly [];

resultโ€‹

result: string;

format-monitor-detailโ€‹

format-monitor-detail: {
params: readonly [
| "cdn-edge-consistency"
| "dns"
| "http"
| "http-header"
| "http-json"
| "http-keyword"
| "http-latency"
| "http-status"
| "ping"
| "port"
| "replication"
| "server-heartbeat"
| "ssl"
| "websocket-keepalive", string];
result: string;
};

Defined in: shared/types/ipc.ts:330

paramsโ€‹

params: readonly [
| "cdn-edge-consistency"
| "dns"
| "http"
| "http-header"
| "http-json"
| "http-keyword"
| "http-latency"
| "http-status"
| "ping"
| "port"
| "replication"
| "server-heartbeat"
| "ssl"
| "websocket-keepalive", string];

resultโ€‹

result: string;

format-monitor-title-suffixโ€‹

format-monitor-title-suffix: {
params: readonly [
| "cdn-edge-consistency"
| "dns"
| "http"
| "http-header"
| "http-json"
| "http-keyword"
| "http-latency"
| "http-status"
| "ping"
| "port"
| "replication"
| "server-heartbeat"
| "ssl"
| "websocket-keepalive", Monitor];
result: string;
};

Defined in: shared/types/ipc.ts:334

paramsโ€‹

params: readonly [
| "cdn-edge-consistency"
| "dns"
| "http"
| "http-header"
| "http-json"
| "http-keyword"
| "http-latency"
| "http-status"
| "ping"
| "port"
| "replication"
| "server-heartbeat"
| "ssl"
| "websocket-keepalive", Monitor];

resultโ€‹

result: string;

get-history-limitโ€‹

get-history-limit: {
params: readonly [];
result: number;
};

Defined in: shared/types/ipc.ts:338

paramsโ€‹

params: readonly [];

resultโ€‹

result: number;

get-monitor-typesโ€‹

get-monitor-types: {
params: readonly [];
result: MonitorTypeConfig[];
};

Defined in: shared/types/ipc.ts:342

paramsโ€‹

params: readonly [];

resultโ€‹

result: MonitorTypeConfig[];

get-sitesโ€‹

get-sites: {
params: readonly [];
result: Site[];
};

Defined in: shared/types/ipc.ts:346

paramsโ€‹

params: readonly [];

resultโ€‹

result: Site[];

get-sync-statusโ€‹

get-sync-status: {
params: readonly [];
result: {
lastSyncAt: number | null;
siteCount: number;
source: "cache" | "database" | "frontend" | "import" | "monitor-update";
synchronized: boolean;
};
};

Defined in: shared/types/ipc.ts:350

paramsโ€‹

params: readonly [];

resultโ€‹

result: {
lastSyncAt: number | null;
siteCount: number;
source: "cache" | "database" | "frontend" | "import" | "monitor-update";
synchronized: boolean;
}
result.lastSyncAtโ€‹
lastSyncAt: number | null;
result.siteCountโ€‹
siteCount: number;
result.sourceโ€‹
source: "cache" | "database" | "frontend" | "import" | "monitor-update";
result.synchronizedโ€‹
synchronized: boolean;

get-update-statusโ€‹

get-update-status: {
params: readonly [];
result: UpdateStatusEventData;
};

Defined in: shared/types/ipc.ts:354

paramsโ€‹

params: readonly [];

resultโ€‹

result: UpdateStatusEventData;

import-dataโ€‹

import-data: {
params: readonly [string];
result: boolean;
};

Defined in: shared/types/ipc.ts:358

paramsโ€‹

params: readonly[string];

resultโ€‹

result: boolean;

notify-app-eventโ€‹

notify-app-event: {
params: readonly [AppNotificationRequest];
result: undefined;
};

Defined in: shared/types/ipc.ts:362

paramsโ€‹

params: readonly[AppNotificationRequest];

resultโ€‹

result: undefined;

open-externalโ€‹

open-external: {
params: readonly [string];
result: boolean;
};

Defined in: shared/types/ipc.ts:366

paramsโ€‹

params: readonly[string];

resultโ€‹

result: boolean;

quit-and-installโ€‹

quit-and-install: {
params: readonly [];
result: boolean;
};

Defined in: shared/types/ipc.ts:370

paramsโ€‹

params: readonly [];

resultโ€‹

result: boolean;

remove-monitorโ€‹

remove-monitor: {
params: readonly [string, string];
result: Site;
};

Defined in: shared/types/ipc.ts:374

paramsโ€‹

params: readonly[(string, string)];

resultโ€‹

result: Site;

remove-siteโ€‹

remove-site: {
params: readonly [string];
result: boolean;
};

Defined in: shared/types/ipc.ts:378

paramsโ€‹

params: readonly[string];

resultโ€‹

result: boolean;

request-full-syncโ€‹

request-full-sync: {
params: readonly [];
result: {
completedAt: number;
revision: number;
siteCount: number;
sites: Site[];
source: "cache" | "database" | "frontend" | "import" | "monitor-update";
synchronized: boolean;
};
};

Defined in: shared/types/ipc.ts:382

paramsโ€‹

params: readonly [];

resultโ€‹

result: {
completedAt: number;
revision: number;
siteCount: number;
sites: Site[];
source: "cache" | "database" | "frontend" | "import" | "monitor-update";
synchronized: boolean;
};
result.completedAtโ€‹
completedAt: number;
result.revisionโ€‹
revision: number;
result.siteCountโ€‹
siteCount: number;
result.sitesโ€‹
sites: Site[];
result.sourceโ€‹
source: "cache" | "database" | "frontend" | "import" | "monitor-update";
result.synchronizedโ€‹
synchronized: boolean;

reset-settingsโ€‹

reset-settings: {
params: readonly [];
result: undefined;
};

Defined in: shared/types/ipc.ts:386

paramsโ€‹

params: readonly [];

resultโ€‹

result: undefined;

restore-sqlite-backupโ€‹

restore-sqlite-backup: {
params: readonly [SerializedDatabaseRestorePayload];
result: SerializedDatabaseRestoreResult;
};

Defined in: shared/types/ipc.ts:390

paramsโ€‹

params: readonly[SerializedDatabaseRestorePayload];

resultโ€‹

result: SerializedDatabaseRestoreResult;

save-sqlite-backupโ€‹

save-sqlite-backup: {
params: readonly [];
result: SerializedDatabaseBackupSaveResult;
};

Defined in: shared/types/ipc.ts:394

paramsโ€‹

params: readonly [];

resultโ€‹

result: SerializedDatabaseBackupSaveResult;

start-monitoringโ€‹

start-monitoring: {
params: readonly [];
result: MonitoringStartSummary;
};

Defined in: shared/types/ipc.ts:398

paramsโ€‹

params: readonly [];

resultโ€‹

result: MonitoringStartSummary;

start-monitoring-for-monitorโ€‹

start-monitoring-for-monitor: {
params: readonly [string, string];
result: boolean;
};

Defined in: shared/types/ipc.ts:402

paramsโ€‹

params: readonly[(string, string)];

resultโ€‹

result: boolean;

start-monitoring-for-siteโ€‹

start-monitoring-for-site: {
params: readonly [string];
result: boolean;
};

Defined in: shared/types/ipc.ts:406

paramsโ€‹

params: readonly[string];

resultโ€‹

result: boolean;

stop-monitoringโ€‹

stop-monitoring: {
params: readonly [];
result: MonitoringStopSummary;
};

Defined in: shared/types/ipc.ts:410

paramsโ€‹

params: readonly [];

resultโ€‹

result: MonitoringStopSummary;

stop-monitoring-for-monitorโ€‹

stop-monitoring-for-monitor: {
params: readonly [string, string];
result: boolean;
};

Defined in: shared/types/ipc.ts:414

paramsโ€‹

params: readonly[(string, string)];

resultโ€‹

result: boolean;

stop-monitoring-for-siteโ€‹

stop-monitoring-for-site: {
params: readonly [string];
result: boolean;
};

Defined in: shared/types/ipc.ts:418

paramsโ€‹

params: readonly[string];

resultโ€‹

result: boolean;

update-history-limitโ€‹

update-history-limit: {
params: readonly [number];
result: number;
};

Defined in: shared/types/ipc.ts:422

paramsโ€‹

params: readonly[number];

resultโ€‹

result: number;

update-notification-preferencesโ€‹

update-notification-preferences: {
params: readonly [NotificationPreferenceUpdate];
result: undefined;
};

Defined in: shared/types/ipc.ts:426

paramsโ€‹

params: readonly[NotificationPreferenceUpdate];

resultโ€‹

result: undefined;

update-siteโ€‹

update-site: {
params: readonly [string, Partial<Site>];
result: Site;
};

Defined in: shared/types/ipc.ts:430

paramsโ€‹

params: readonly[(string, Partial<Site>)];

resultโ€‹

result: Site;

validate-monitor-dataโ€‹

validate-monitor-data: {
params: readonly [
| "cdn-edge-consistency"
| "dns"
| "http"
| "http-header"
| "http-json"
| "http-keyword"
| "http-latency"
| "http-status"
| "ping"
| "port"
| "replication"
| "server-heartbeat"
| "ssl"
| "websocket-keepalive", unknown];
result: ValidationResult;
};

Defined in: shared/types/ipc.ts:434

paramsโ€‹

params: readonly [
| "cdn-edge-consistency"
| "dns"
| "http"
| "http-header"
| "http-json"
| "http-keyword"
| "http-latency"
| "http-status"
| "ping"
| "port"
| "replication"
| "server-heartbeat"
| "ssl"
| "websocket-keepalive", unknown];

resultโ€‹

result: ValidationResult;

write-clipboard-textโ€‹

write-clipboard-text: {
params: readonly [string];
result: boolean;
};

Defined in: shared/types/ipc.ts:438

paramsโ€‹

params: readonly[string];

resultโ€‹

result: boolean;