Protected ReadonlycommandProtectedcontextProtected ReadonlycontextProtected ReadonlycontributionThe definition each walkthrough was registered from, to detect a changed contribution.
Protected ReadonlygettingProtectedknownProtected ReadonlyloggerProtected ReadonlymessageReadonlyonProtected ReadonlyonReadonlyonProtected ReadonlyonProtected ReadonlyopenerProtectedpluginProtected ReadonlypluginProtected ReadonlypreferenceProtectedprogressResolves once the persisted progress has been read and the initial sync has run.
ProtectedprogressProtectedselectedProtectedselectedProtected ReadonlystorageProtected ReadonlytoProtected ReadonlyviewProtected ReadonlywalkthroughsThe step of the selectedWalkthrough whose content is currently shown, if any.
The walkthrough that is currently opened in the welcome view, if any. While a walkthrough is selected, the welcome view renders it instead of its regular content.
Close the currently selected walkthrough and return the welcome view to its regular content.
ProtectedcompleteComplete every pending step whose onContext: expression currently holds.
Dispose this object.
ProtectedestablishRemember the currently deployed plugins as the set that is not considered newly installed.
Plugins are deployed asynchronously while the application starts, so the baseline can only be trusted
once plugins have actually arrived. Without this, every plugin of a fresh session would look like a new
installation and - with workbench.welcomePage.walkthroughs.openOnInstall enabled - open a walkthrough
on startup.
ProtectedfromVS Code refers to a walkthrough as publisher.name#walkthroughId, for example in the command: links of a
step description, while the ids used here are fully dot-separated.
ProtectedgetThe context keys that the when clauses and the onContext: completion events of all registered
walkthroughs depend on.
The set is cached because context keys change very frequently, while walkthroughs rarely do.
ProtectedgetThe walkthrough with the given id, or undefined if it is unknown or its when clause does not hold.
All walkthroughs whose when clause currently holds, restricted to their currently visible steps.
ProtectedhandleProtectedhandleHandle a link click from a walkthrough step description.
Fires the onLink:{url} completion event and opens the link.
Walkthroughs commonly link to command: URIs that Theia does not implement. Such a link must not
reject unhandled, so the failure is reported to the user instead.
ProtectedhandleProtectedhandleProtectedinitProtectedisWhether a when clause currently holds. A contribution without a when clause is always visible.
ProtectedloadMark every step of the given walkthrough as complete, persisting the progress once.
Take the completion mark off a step again, for example when it was completed by mistake.
ProtectednormalizeVS Code walkthroughs use command:toSide:<commandId> to open the result of a command beside the walkthrough.
Theia has no generic equivalent, so the command is executed as usual rather than failing to resolve.
ProtectedregisterProtectedsaveShow the content of the given step of the currently selected walkthrough.
Open the given walkthrough in the welcome view and preselect its first pending step. Does nothing if no walkthrough is registered under that id.
ProtectedsetProtectedsyncProtectedtoRestricts a walkthrough to the steps that are currently visible.
Hidden steps also stay out of the progress, so that a walkthrough whose remaining steps do not apply to this platform or workspace can still be completed.
Protectedto
Cache of getContextKeys, invalidated whenever the set of walkthroughs changes.