Skip to main content

Interface: DesktopApi

Defined in: plugin/lib.ts:71

APIs exposed to Headlamp's renderer process by the desktop preload bridge.

Indexable​

[key: string]: any

Additional APIs exposed by the desktop preload bridge.

Properties​

isDevelopment?​

optional isDevelopment?: boolean;

Defined in: plugin/lib.ts:77

Whether Electron is running in development mode, independent of the frontend build mode.

oidcLogout?​

optional oidcLogout?: (cluster: string) => Promise<void>;

Defined in: plugin/lib.ts:73

Ends an OIDC session in an isolated desktop browser window.

Parameters​

ParameterType
clusterstring

Returns​

Promise<void>

platform​

platform: Platform;

Defined in: plugin/lib.ts:75

Operating system platform hosting the desktop app.