Class ElectronMainApplication

Index

Constructors

Properties

_backendPort _config activeWindowStack backendPort contributions customBackgroundColor? didUseNativeWindowFrameOnStart electronSecurityToken electronSecurityTokenService electronStore globals initialWindow? isPortable processArgv restarting useNativeWindowFrame windowFactory windows

Accessors

config

Constructors

constructor

new ElectronMainApplication(): ElectronMainApplication
Returns ElectronMainApplication

Properties

`Protected` `Readonly`_backendPort

_backendPort: Deferred<number> = ...

`Protected`_config

_config: undefined | RequiredRecursive<Partial>

`Protected`activeWindowStack

activeWindowStack: number[] = []

`Readonly`backendPort

backendPort: Promise<number> = ...

`Protected` `Readonly`contributions

contributions: ContributionProvider<ElectronMainApplicationContribution>

`Protected` `Optional`customBackgroundColor

customBackgroundColor?: string

`Protected`didUseNativeWindowFrameOnStart

didUseNativeWindowFrameOnStart: Map<number, boolean> = ...

`Protected` `Readonly`electronSecurityToken

electronSecurityToken: ElectronSecurityToken

`Protected`electronSecurityTokenService

electronSecurityTokenService: ElectronSecurityTokenService

`Protected` `Readonly`electronStore

electronStore: ElectronStore<{ windowstate?: TheiaBrowserWindowOptions }> = ...

`Protected` `Readonly`globals

globals: ElectronMainApplicationGlobals

`Protected` `Optional`initialWindow

initialWindow?: BrowserWindow

Used to temporarily store the reference to an early created main window

`Protected`isPortable

isPortable: boolean = ...

`Protected`processArgv

processArgv: ElectronMainProcessArgv

`Protected`restarting

restarting: boolean = false

`Protected`useNativeWindowFrame

useNativeWindowFrame: boolean = true

`Protected` `Readonly`windowFactory

windowFactory: TheiaElectronWindowFactory

`Protected`windows

windows: Map<number, TheiaElectronWindow> = ...

Accessors

config

get config(): FrontendApplicationConfig
Returns FrontendApplicationConfig
- Defined in packages/core/src/electron-main/electron-main-application.ts:193

Methods

`Protected`attachElectronSecurityToken

attachElectronSecurityToken(port: number): Promise<void>
Parameters
- port: number
Returns Promise<void>
- Defined in packages/core/src/electron-main/electron-main-application.ts:735

`Protected`attachSaveWindowState

attachSaveWindowState(electronWindow: BrowserWindow): void
Save the window geometry state on every change.
Parameters
- electronWindow: BrowserWindow
Returns void
- Defined in packages/core/src/electron-main/electron-main-application.ts:613

`Protected`avoidOverlap

avoidOverlap(options: TheiaBrowserWindowOptions): TheiaBrowserWindowOptions
Parameters
- options: TheiaBrowserWindowOptions
Returns TheiaBrowserWindowOptions
- Defined in packages/core/src/electron-main/electron-main-application.ts:466

`Protected`configureAndShowSplashScreen

configureAndShowSplashScreen(mainWindow: BrowserWindow): Promise<BrowserWindow>
Parameters
- mainWindow: BrowserWindow
Returns Promise<BrowserWindow>
- Defined in packages/core/src/electron-main/electron-main-application.ts:355

createWindow

createWindow(
asyncOptions?: MaybePromise<TheiaBrowserWindowOptions>,
): Promise<BrowserWindow>
Use this rather than creating BrowserWindow instances from scratch, since some security parameters need to be set, this method will do it.
Parameters
- asyncOptions: MaybePromise<TheiaBrowserWindowOptions> = ...
Returns Promise<BrowserWindow>
- Defined in packages/core/src/electron-main/electron-main-application.ts:419

`Protected`createWindowUri

createWindowUri(params?: WindowSearchParams): Promise<URI>
Parameters
- params: WindowSearchParams = {}
Returns Promise<URI>
- Defined in packages/core/src/electron-main/electron-main-application.ts:564

`Protected`determineSplashScreenBounds

determineSplashScreenBounds(
    initialWindowBounds: {
        height: number;
        width: number;
        x: number;
        y: number;
    },
): Promise<{ height: number; width: number; x: number; y: number }>
Parameters
- initialWindowBounds: { height: number; width: number; x: number; y: number }
Returns Promise<{ height: number; width: number; x: number; y: number }>
- Defined in packages/core/src/electron-main/electron-main-application.ts:302

`Protected`getCurrentScreenLayout

getCurrentScreenLayout(): string
Return a string unique to the current display layout.

Returns string
- Defined in packages/core/src/electron-main/electron-main-application.ts:659

`Protected`getForkOptions

getForkOptions(): Promise<ForkOptions>
Returns Promise<ForkOptions>
- Defined in packages/core/src/electron-main/electron-main-application.ts:723

getLastWindowOptions

getLastWindowOptions(): Promise<TheiaBrowserWindowOptions>
Returns Promise<TheiaBrowserWindowOptions>
- Defined in packages/core/src/electron-main/electron-main-application.ts:448

`Protected`getSplashScreenOptions

getSplashScreenOptions(): undefined | SplashScreenOptions
Returns undefined | SplashScreenOptions
- Defined in packages/core/src/electron-main/electron-main-application.ts:407

`Protected`getTitleBarStyle

getTitleBarStyle(config: FrontendApplicationConfig): "native" | "custom"
Parameters
- config: FrontendApplicationConfig
Returns "native" | "custom"
- Defined in packages/core/src/electron-main/electron-main-application.ts:250

getTitleBarStyleAtStartup

getTitleBarStyleAtStartup(webContents: WebContents): "native" | "custom"
Parameters
- webContents: WebContents
Returns "native" | "custom"
'native' or 'custom'
- Defined in packages/core/src/electron-main/electron-main-application.ts:298

`Protected`handleMainCommand

handleMainCommand(options: ElectronMainCommandOptions): Promise<void>
Parameters
- options: ElectronMainCommandOptions
Returns Promise<void>
- Defined in packages/core/src/electron-main/electron-main-application.ts:535

`Protected`hookApplicationEvents

hookApplicationEvents(): void
Returns void
- Defined in packages/core/src/electron-main/electron-main-application.ts:739

`Protected`isShowSplashScreen

isShowSplashScreen(): boolean
Returns boolean
- Defined in packages/core/src/electron-main/electron-main-application.ts:403

`Protected`isShowWindowEarly

isShowWindowEarly(): boolean
Returns boolean
- Defined in packages/core/src/electron-main/electron-main-application.ts:322

`Protected`makePortable

makePortable(): boolean
Returns boolean
- Defined in packages/core/src/electron-main/electron-main-application.ts:200

`Protected`onSecondInstance

onSecondInstance(
    event: { defaultPrevented: boolean; preventDefault: () => void },
    _: string[],
    cwd: string,
    originalArgv: string[],
): Promise<void>
Parameters
- event: { defaultPrevented: boolean; preventDefault: () => void }
- _: string[]
- cwd: string
- originalArgv: string[]
Returns Promise<void>
- Defined in packages/core/src/electron-main/electron-main-application.ts:760

`Protected`onWebContentsCreated

onWebContentsCreated(
event: { defaultPrevented: boolean; preventDefault: () => void },
webContents: WebContents,
): void
Parameters
- event: { defaultPrevented: boolean; preventDefault: () => void }
- webContents: WebContents
Returns void
- Defined in packages/core/src/electron-main/electron-main-application.ts:783

`Protected`onWillQuit

onWillQuit(
event: { defaultPrevented: boolean; preventDefault: () => void },
): void
Parameters
- event: { defaultPrevented: boolean; preventDefault: () => void }
Returns void
- Defined in packages/core/src/electron-main/electron-main-application.ts:756

`Protected`onWindowAllClosed

onWindowAllClosed(
event: { defaultPrevented: boolean; preventDefault: () => void },
): void
Parameters
- event: { defaultPrevented: boolean; preventDefault: () => void }
Returns void
- Defined in packages/core/src/electron-main/electron-main-application.ts:841

openDefaultWindow

openDefaultWindow(params?: WindowSearchParams): Promise<BrowserWindow>
Parameters
- Optionalparams: WindowSearchParams
Returns Promise<BrowserWindow>
- Defined in packages/core/src/electron-main/electron-main-application.ts:504

openUrl

openUrl(url: string): Promise<void>
Parameters
- url: string
Returns Promise<void>
- Defined in packages/core/src/electron-main/electron-main-application.ts:555

`Protected`openWindowWithWorkspace

openWindowWithWorkspace(workspacePath: string): Promise<BrowserWindow>
Parameters
- workspacePath: string
Returns Promise<BrowserWindow>
- Defined in packages/core/src/electron-main/electron-main-application.ts:511

requestStop

requestStop(): void
"Gently" close all windows, application will not stop if a beforeunload handler returns false.

Returns void
- Defined in packages/core/src/electron-main/electron-main-application.ts:531

restart

restart(webContents: WebContents): Promise<void>
Parameters
- webContents: WebContents
Returns Promise<void>
- Defined in packages/core/src/electron-main/electron-main-application.ts:847

`Protected`reuseOrCreateWindow

reuseOrCreateWindow(
asyncOptions: MaybePromise<TheiaBrowserWindowOptions>,
): Promise<BrowserWindow>
Parameters
- asyncOptions: MaybePromise<TheiaBrowserWindowOptions>
Returns Promise<BrowserWindow>
- Defined in packages/core/src/electron-main/electron-main-application.ts:518

`Protected`saveState

saveState(webContents: WebContents): void
Parameters
- webContents: WebContents
Returns void
- Defined in packages/core/src/electron-main/electron-main-application.ts:285

`Protected`saveWindowState

saveWindowState(electronWindow: BrowserWindow): void
Parameters
- electronWindow: BrowserWindow
Returns void
- Defined in packages/core/src/electron-main/electron-main-application.ts:632

setBackgroundColor

setBackgroundColor(webContents: WebContents, backgroundColor: string): void
Parameters
- webContents: WebContents
- backgroundColor: string
Returns void
- Defined in packages/core/src/electron-main/electron-main-application.ts:275

setTheme

setTheme(theme: ThemeMode): void
Parameters
- theme: ThemeMode
Returns void
- Defined in packages/core/src/electron-main/electron-main-application.ts:281

setTitleBarStyle

setTitleBarStyle(webContents: WebContents, style: string): void
Parameters
- webContents: WebContents
- style: string
Returns void
- Defined in packages/core/src/electron-main/electron-main-application.ts:270

`Protected`showInitialWindow

showInitialWindow(urlToOpen: undefined | string): void
Parameters
- urlToOpen: undefined | string
Returns void
- Defined in packages/core/src/electron-main/electron-main-application.ts:327

start

start(config: FrontendApplicationConfig): Promise<void>
Parameters
- config: FrontendApplicationConfig
Returns Promise<void>
- Defined in packages/core/src/electron-main/electron-main-application.ts:214

`Protected`startBackend

startBackend(): Promise<number>
Start the NodeJS backend server.

Returns Promise<number>
Running server's port promise.
- Defined in packages/core/src/electron-main/electron-main-application.ts:670

`Protected`startContributions

startContributions(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/electron-main/electron-main-application.ts:866

`Protected`stopContributions

stopContributions(): void
Returns void
- Defined in packages/core/src/electron-main/electron-main-application.ts:876

Class ElectronMainApplication

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ElectronMainApplication

Properties

Protected Readonly_backendPort

Protected_config

ProtectedactiveWindowStack

ReadonlybackendPort

Protected Readonlycontributions

Protected OptionalcustomBackgroundColor

ProtecteddidUseNativeWindowFrameOnStart

Protected ReadonlyelectronSecurityToken

ProtectedelectronSecurityTokenService

Protected ReadonlyelectronStore

Protected Readonlyglobals

Protected OptionalinitialWindow

ProtectedisPortable

ProtectedprocessArgv

Protectedrestarting

ProtecteduseNativeWindowFrame

Protected ReadonlywindowFactory

Protectedwindows

Accessors

config

Returns FrontendApplicationConfig

Methods

ProtectedattachElectronSecurityToken

Parameters

Returns Promise<void>

ProtectedattachSaveWindowState

Parameters

Returns void

ProtectedavoidOverlap

Parameters

Returns TheiaBrowserWindowOptions

ProtectedconfigureAndShowSplashScreen

Parameters

Returns Promise<BrowserWindow>

createWindow

Parameters

Returns Promise<BrowserWindow>

ProtectedcreateWindowUri

Parameters

Returns Promise<URI>

ProtecteddetermineSplashScreenBounds

Parameters

Returns Promise<{ height: number; width: number; x: number; y: number }>

ProtectedgetCurrentScreenLayout

Returns string

ProtectedgetDefaultOptions

Returns TheiaBrowserWindowOptions

ProtectedgetDefaultTheiaSecondaryWindowBounds

Returns TheiaBrowserWindowOptions

ProtectedgetDefaultTheiaWindowBounds

Returns TheiaBrowserWindowOptions

ProtectedgetDefaultTheiaWindowOptions

Returns TheiaBrowserWindowOptions

ProtectedgetForkOptions

Returns Promise<ForkOptions>

getLastWindowOptions

Returns Promise<TheiaBrowserWindowOptions>

ProtectedgetSplashScreenOptions

Returns undefined | SplashScreenOptions

ProtectedgetTitleBarStyle

Parameters

Returns "native" | "custom"

getTitleBarStyleAtStartup

Parameters

Returns "native" | "custom"

ProtectedhandleMainCommand

Parameters

Returns Promise<void>

ProtectedhookApplicationEvents

Returns void

`Protected` `Readonly`_backendPort

`Protected`_config

`Protected`activeWindowStack

`Readonly`backendPort

`Protected` `Readonly`contributions

`Protected` `Optional`customBackgroundColor

`Protected`didUseNativeWindowFrameOnStart

`Protected` `Readonly`electronSecurityToken

`Protected`electronSecurityTokenService

`Protected` `Readonly`electronStore

`Protected` `Readonly`globals

`Protected` `Optional`initialWindow

`Protected`isPortable

`Protected`processArgv

`Protected`restarting

`Protected`useNativeWindowFrame

`Protected` `Readonly`windowFactory

`Protected`windows

`Protected`attachElectronSecurityToken

`Protected`attachSaveWindowState

`Protected`avoidOverlap

`Protected`configureAndShowSplashScreen

`Protected`createWindowUri

`Protected`determineSplashScreenBounds

`Protected`getCurrentScreenLayout

`Protected`getDefaultOptions

`Protected`getDefaultTheiaSecondaryWindowBounds

`Protected`getDefaultTheiaWindowBounds

`Protected`getDefaultTheiaWindowOptions

`Protected`getForkOptions

`Protected`getSplashScreenOptions

`Protected`getTitleBarStyle

`Protected`handleMainCommand

`Protected`hookApplicationEvents

`Protected`isShowSplashScreen

`Protected`isShowWindowEarly

`Protected`makePortable

`Protected`onSecondInstance

`Protected`onWebContentsCreated

`Protected`onWillQuit

`Protected`onWindowAllClosed

`Protected`openWindowWithWorkspace

`Protected`reuseOrCreateWindow

`Protected`saveState

`Protected`saveWindowState

`Protected`showInitialWindow

`Protected`startBackend

`Protected`startContributions

`Protected`stopContributions