IODesktopObjectinterface
Object injected by the io.Connect Desktop preload script, containing
desktop-specific APIs and properties. Available on the global window
object as iodesktop (and, for backwards compatibility, glueDesktop).
Properties (60)
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| addCloseHandler⚓︎ | (callback: IODesktopHandler, windowId?: string) => void | x | Register a handler to be called when the window is about to close |
|
| appInstanceId⚓︎ | string | x | Instance of the application running in the window |
|
| application⚓︎ | string | x | x | |
| applicationName⚓︎ | string | x | Name of the application running in the window |
|
| appName⚓︎ | string | x | Name of the application running in the window |
|
| authDone⚓︎ | (auth: AuthInfo) => void | x | x | Complete authentication with auth info |
| autoInited⚓︎ | API | Error | x | x | Auto-initialized Glue instance or error |
| autoInjected⚓︎ | boolean | x | x | Whether Glue was auto-injected |
| autoInjectedFdc3⚓︎ | boolean | x | x | Whether FDC3 was auto-injected |
| build⚓︎ | string | x | x | Build identifier |
| chromium⚓︎ | string | x | x | Chromium version |
| clearCache⚓︎ | () => Promise<void> | x | x | Clear browser cache |
| clearHostResolverCache⚓︎ | () => Promise<void> | x | x | Clear DNS resolver cache |
| consoleLogLevel⚓︎ | LogLevel | undefined | x | x | |
| context⚓︎ | Record<string, unknown> | x | x | Window context — arbitrary app data |
| cookies⚓︎ | CookiesManager | x | x | Cookie management |
| customHeaders⚓︎ | CustomHeadersManager | x | x | Custom request headers management |
| downloads⚓︎ | DownloadsManager | x | x | Download manager |
| electron⚓︎ | string | x | x | Electron version |
| env⚓︎ | { env: string; machineName: string; region: string; windowsUserDomain: string; windowsUserId: string; windowsUserName: string; } | x | x | |
| fdc3InitsGlue⚓︎ | boolean | x | x | Whether FDC3 initializes Glue |
| getAuth⚓︎ | () => Promise<AuthInfo> | x | x | Get authentication info (requires allowAuthInfo in app settings) |
| getConfigs⚓︎ | (params: { timeout: number }) => Promise<Endpoints> | x | x | Get endpoint configurations |
| getError⚓︎ | () => Promise<{ error: Error; url: string }> | x | x | Get the last navigation error |
| getGWInfo⚓︎ | () => Promise<GWInfo> | x | x | Get gateway connection info |
| getGWToken⚓︎ | () => Promise<string> | x | x | |
| getMetricsPublishingEnabled⚓︎ | () => boolean | x | x | |
| getPath⚓︎ | (name: string) => Promise<string> | x | x | Get a system path by name |
| getProxySettings⚓︎ | () => Promise<ProxyConfig> | x | x | Get proxy settings |
| getSid⚓︎ | () => string | x | x | Get the session ID |
| glue42StartTime⚓︎ | Date | x | x | Desktop start time |
| gwURL⚓︎ | string | x | x | |
| hideWindow⚓︎ | (id?: string) => Promise<void> | x | x | Hide a window by ID |
| initialChannel⚓︎ | string | x | x | Initial channel ID |
| injectFdc3⚓︎ | { autoInject: boolean; autoInit?: object | boolean; version?: string; } | x | x | FDC3 auto-inject configuration |
| injectGlue⚓︎ | { autoInject: boolean; autoInit?: Config | boolean; version?: string; } | x | x | Auto-inject configuration |
| insights⚓︎ | Settings | x | x | x |
| isAdvancedMode⚓︎ | boolean | x | x | Whether advanced mode is enabled |
| metrics⚓︎ | { pagePerformanceMetrics: { enabled: boolean; initialPublishTimeout: number; publishInterval: number; } } | x | x | x |
| monitors⚓︎ | Display[] | x | x | Connected monitors |
| node⚓︎ | string | x | x | Node.js version |
| os⚓︎ | { getVersion(): string; getProcesses(): Promise<{ pid: number; name: string; startTime: Date }[]>; } | x | x | OS information (requires allowOSInfo in app settings) |
| pid⚓︎ | number | x | x | |
| preloadScripts⚓︎ | { importAsBase64?: boolean;[key: string]: unknown }[] | x | x | Preload scripts |
| preloadScriptsContent⚓︎ | { base64?: string; url?: string; error?: string }[] | x | x | Preload scripts content (base64) |
| propagationInfo⚓︎ | PropagationInfo | x | x | x |
| refresh⚓︎ | (ignoreCache: boolean) => void | x | x | Refresh the window |
| regeneratePreloads⚓︎ | () => void | x | x | Regenerate preload scripts |
| session⚓︎ | string | x | x | Session token |
| setProxySettings⚓︎ | (config: ProxyConfig) => void | x | x | Set proxy settings (requires allowProxySettingManipulation in app settings) |
| settings⚓︎ | { sfMode?: boolean; registerHtmlContainer?: boolean; zoom?: { enabled?: boolean; mouseWheelZoom?: boolean; factors?: number[]; defaultFactor?: number; mode?: "domain" | "window"; }; crashConfig?: { enabled?: boolean; folderPath?: string; companyName?: string; productName?: string; output?: { type?: "local" | "server" | "backtrace"; serverUrl?: string; }; }; metricsPublishingEnabled?: boolean; nameLookup?: { enabled: boolean; retrieved: boolean; retrieveMethod: string }; allowOSInfo?: boolean; allowAuthInfo?: boolean; allowProxySettingManipulation?: boolean; useBase64PreloadScripts?: boolean; workspacesPlacement?: WorkspacesPlacementConfig; } | x | x | Window settings |
| showWindow⚓︎ | (id?: string) => Promise<void> | x | x | Show a window by ID |
| sid⚓︎ | string | x | Session identifier |
|
| theme⚓︎ | string | x | x | Current theme |
| uiVersion⚓︎ | string | x | x | UI version string |
| updatePerfData⚓︎ | (perf: object) => void | x | x | |
| user⚓︎ | string | x | User identifier |
|
| version⚓︎ | string | x | x | Desktop version string |
| versionNum⚓︎ | number | x | x | Desktop version as a number (e.g. 31200) |
| windowId⚓︎ | string | x | Id of the window |