Theia API Documentation v1.77.0
    Preparing search index...
    interface TheiaCoreAPI {
        attachSecurityToken: (endpoint: string) => Promise<void>;
        getSecurityToken: () => string;
        useNativeElements: boolean;
        WindowMetadata: { launchArgs?: LaunchArguments; webcontentId: string };
        applicationStateChanged(state: FrontendApplicationState): void;
        close(windowName?: string): void;
        closePopup(handle: number): void;
        focusWindow(name?: string): void;
        getPathForFile(file: File): string;
        getTitleBarStyleAtStartup(): Promise<string>;
        getZoomLevel(): Promise<number>;
        isFullScreen(): boolean;
        isFullScreenable(): boolean;
        isMaximized(windowName?: string): boolean;
        maximize(windowName?: string): void;
        minimize(windowName?: string): void;
        onAboutToClose(handler: () => void): Disposable;
        onData(handler: (data: Uint8Array) => void): Disposable;
        onKeyboardLayoutChanged(
            handler: (newLayout: NativeKeyboardLayout) => void,
        ): Disposable;
        onSecondaryWindowEvent(
            windowName: string,
            event: WindowEvent,
            handler: () => void,
        ): Disposable;
        onWindowEvent(event: WindowEvent, handler: () => void): Disposable;
        openDevToolsForWindow(windowName: string): void;
        openWithSystemApp(location: string): void;
        popup(
            menu: MenuDto[],
            x: number,
            y: number,
            onClosed: () => void,
            windowName?: string,
        ): Promise<number>;
        readClipboard(): Promise<string>;
        requestReload(newUrl?: string): void;
        restart(): void;
        sendData(data: Uint8Array): void;
        setAutoHideMenuBar(enabled: boolean, windowName?: string): void;
        setBackgroundColor(backgroundColor: string): void;
        setCloseRequestHandler(
            handler: (reason: StopReason) => Promise<boolean>,
        ): void;
        setMenu(menu: MenuDto[] | undefined): void;
        setMenuBarVisible(visible: boolean, windowName?: string): void;
        setOpenUrlHandler(handler: (url: string) => Promise<boolean>): void;
        setSecondaryWindowCloseRequestHandler(
            windowName: string,
            handler: () => Promise<boolean>,
        ): void;
        setTheme(theme: ThemeMode): void;
        setTitleBarStyle(style: string): void;
        setZoomLevel(desired: number, windowName?: string): void;
        showItemInFolder(fsPath: string): void;
        toggleDevTools(): void;
        toggleFullScreen(): void;
        unMaximize(windowName?: string): void;
        updateRecentWorkspaces(workspaceUris: string[], categoryName: string): void;
        writeClipboard(text: string): void;
    }
    Index
    attachSecurityToken: (endpoint: string) => Promise<void>
    getSecurityToken: () => string
    useNativeElements: boolean
    WindowMetadata: { launchArgs?: LaunchArguments; webcontentId: string }

    Type Declaration

    • Optional ExperimentallaunchArgs?: LaunchArguments

      The parsed CLI options of a forwarded launch (see the second-instance handling in ElectronMainApplication), or undefined for a cold-start window. Provided synchronously by the preload script, so a frontend contribution can act on it from the first paint. The options never ride on the window URL; see LaunchArgsStore for the rationale.

    • webcontentId: string