Class ElectronWindowService

Hierarchy (view full)

Constructors

Properties

allowVetoes: boolean = true
closeOnUnload: boolean = false

Close the window right away when true, else check if we can unload.

connectionCloseService: ConnectionCloseService
corePreferences: CorePreferences
electronWindowPreferences: ElectronWindowPreferences
frontendApplication: FrontendApplication
frontendIdProvider: FrontendIdProvider
isUnloading: boolean = false

Lock to prevent multiple parallel executions of the beforeunload listener.

onUnloadEmitter: Emitter<void> = ...

Accessors

  • get onUnload(): Event<void>
  • Fires when the window unloads. The unload event is inevitable. On this event, the frontend application can save its state and release resource. Saving the state and releasing any resources must be a synchronous call. Any asynchronous calls invoked after emitting this event might be ignored.

    Returns Event<void>

Methods

  • Checks FrontendApplicationContribution#willStop for impediments to shutdown and runs any actions returned. Can be used safely in browser and Electron when triggering reload or shutdown programmatically. Should only be called before a shutdown - if this returns true, FrontendApplicationContribution#willStop will not be called again in the current session. I.e. if this return true, the shutdown should proceed without further condition.

    Parameters

    Returns Promise<boolean>

  • Will prevent subsequent checks of FrontendApplicationContribution#willStop. Should only be used after requesting user confirmation.

    This is primarily intended programmatic restarts due to e.g. change of display language. It allows for a single confirmation of intent, rather than one warning and then several warnings from other contributions.

    Returns void