Protected
allowProtected
Readonly
contributionsProtected
Readonly
coreProtected
frontendProtected
onProtected
collectReturns 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.
Protected
handleCalled 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.
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.
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.
Protected
preventProtected
registerWill 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.
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.