ProtectedallowProtectedcloseProtected ReadonlyconnectionProtected ReadonlycontributionsProtected ReadonlycoreProtected ReadonlydelegateProtected ReadonlyelectronProtectedfrontendProtected ReadonlyfrontendProtectedisLock to prevent multiple parallel executions of the beforeunload listener.
ProtectedonReadonlyonProtected ReadonlyonFires 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.
ProtectedcollectReturns a list of actions that FrontendApplicationContributions would like to take before shutdown It is expected that this will succeed - i.e. return an empty array - at most once per session. If no vetoes are received during any cycle, no further checks will be made. In that case, shutdown should proceed unconditionally.
Reveal and focuses the current window
ProtectedhandleCalled when the window is about to unload its resources.
At this point, the document is still visible and the BeforeUnloadEvent
event will be canceled if the return value of this method is false.
In Electron, handleCloseRequestEvent is is run instead.
ProtectedinitChecks 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.
Called when the application is started. The application shell is not attached yet when this method runs. Should return a promise if it runs asynchronously.
Opens a new default window.
Optionalparams: WindowSearchParamsOpens a new window and loads the content from the given URL. In a browser, opening a new Theia tab or open a link is the same thing. But in Electron, we want to open links in a browser, not in Electron.
ProtectedpreventNotify the browser that we do not want to unload.
Notes:
The beforeunload event
ProtectedregisterImplement the mechanism to detect unloading of the page.
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.
ProtectedupdateUpdates the window zoom level based on the preference value.
Close the window right away when
true, else check if we can unload.