Theia API Documentation v1.76.0
    Preparing search index...

    Interface TheiaCoreAPI

    interface TheiaCoreAPI {
        attachSecurityToken: (endpoint: string) => Promise<void>;
        getSecurityToken: () => string;
        useNativeElements: boolean;
        WindowMetadata: { launchArgs?: LaunchArguments; webcontentId: string };
        applicationStateChanged(state: FrontendApplicationState): void;
        close(): void;
        closePopup(handle: number): void;
        focusWindow(name?: string): void;
        getPathForFile(file: File): string;
        getTitleBarStyleAtStartup(): Promise<string>;
        getZoomLevel(): Promise<number>;
        isFullScreen(): boolean;
        isFullScreenable(): boolean;
        isMaximized(): boolean;
        maximize(): void;
        minimize(): void;
        onAboutToClose(handler: () => void): Disposable;
        onData(handler: (data: Uint8Array) => void): Disposable;
        onKeyboardLayoutChanged(
            handler: (newLayout: NativeKeyboardLayout) => 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(): string;
        requestReload(newUrl?: string): void;
        restart(): void;
        sendData(data: Uint8Array): void;
        setBackgroundColor(backgroundColor: string): void;
        setCloseRequestHandler(
            handler: (reason: StopReason) => Promise<boolean>,
        ): void;
        setMenu(menu: undefined | MenuDto[]): 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(): void;
        updateRecentWorkspaces(workspaceUris: string[], categoryName: string): void;
        writeClipboard(text: string): void;
    }
    Index

    Properties

    attachSecurityToken getSecurityToken useNativeElements WindowMetadata

    Methods

    applicationStateChanged close closePopup focusWindow getPathForFile getTitleBarStyleAtStartup getZoomLevel isFullScreen isFullScreenable isMaximized maximize minimize onAboutToClose onData onKeyboardLayoutChanged onWindowEvent openDevToolsForWindow openWithSystemApp popup readClipboard requestReload restart sendData setBackgroundColor setCloseRequestHandler setMenu setMenuBarVisible setOpenUrlHandler setSecondaryWindowCloseRequestHandler setTheme setTitleBarStyle setZoomLevel showItemInFolder toggleDevTools toggleFullScreen unMaximize updateRecentWorkspaces writeClipboard

    Properties

    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

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods