Class GettingStartedContribution

A PreferenceContribution allows adding additional custom preferences. For this, the PreferenceContribution has to provide a valid PrefernceSchema specifying which preferences are available including their types and description.

Example usage

const MyPreferencesSchema: PreferenceSchema = {
    'scope': PreferenceScope.Folder,
    'properties': {
        'myext.decorations.enabled': {
            'type': 'boolean',
            'description': 'Show file status',
            'default': true
        },
        // [...]
    }
}
@injectable()
export class MyPreferenceContribution implements PreferenceContribution{
    schema= MyPreferencesSchema;
}

Hierarchy (View Summary)

AbstractViewContribution<GettingStartedWidget>
- GettingStartedContribution

Implements

Constructors

constructor

new GettingStartedContribution(): GettingStartedContribution
Returns GettingStartedContribution
Overrides AbstractViewContribution.constructor
- Defined in packages/getting-started/src/browser/getting-started-contribution.ts:82

Properties

`Protected` `Readonly`commandRegistry

commandRegistry: CommandRegistry

`Protected` `Readonly`editorManager

editorManager: EditorManager

`Protected` `Readonly`fileService

fileService: FileService

`Protected` `Readonly`messageService

messageService: MessageService

`Protected` `Readonly`options

options: ViewContributionOptions

`Protected` `Readonly`preferenceService

preferenceService: PreferenceService

`Protected` `Readonly`quickInputService

quickInputService: QuickInputService

`Optional` `Readonly`toggleCommand

toggleCommand?: Command

`Protected` `Readonly`walkthroughService

walkthroughService: WalkthroughService

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

Accessors

defaultViewOptions

get defaultViewOptions(): ApplicationShell.WidgetOptions
Returns ApplicationShell.WidgetOptions
Inherited from AbstractViewContribution.defaultViewOptions
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:34

effectiveWidgetId

get effectiveWidgetId(): string
The widget ID used for shell operations — viewContainerId if set, otherwise widgetId.

Returns string
Inherited from AbstractViewContribution.effectiveWidgetId
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:36

viewId

get viewId(): string
Returns string
Inherited from AbstractViewContribution.viewId
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:32

viewLabel

get viewLabel(): string
Returns string
Inherited from AbstractViewContribution.viewLabel
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:33

get widget(): Promise<T>
Returns Promise<T>
Inherited from AbstractViewContribution.widget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:37

Methods

closeView

closeView(): Promise<undefined | GettingStartedWidget>
Returns Promise<undefined | GettingStartedWidget>
Inherited from AbstractViewContribution.closeView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:41

initSchema

initSchema(service: PreferenceSchemaService): Promise<void>
Allows to do additional intialisation of the preference schema, for example registering overrides
Parameters
- service: PreferenceSchemaService
  the preference schema service
Returns Promise<void>
Implementation of PreferenceContribution.initSchema
- Defined in packages/getting-started/src/browser/getting-started-contribution.ts:92

onStart

onStart(app: FrontendApplication): Promise<void>
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.
Parameters
- app: FrontendApplication
Returns Promise<void>
Implementation of FrontendApplicationContribution.onStart
- Defined in packages/getting-started/src/browser/getting-started-contribution.ts:107

`Protected`openReadme

openReadme(): Promise<void>
Returns Promise<void>
- Defined in packages/getting-started/src/browser/getting-started-contribution.ts:132

openView

openView(args?: Partial<OpenViewArguments>): Promise<GettingStartedWidget>
Parameters
- Optionalargs: Partial<OpenViewArguments>
Returns Promise<GettingStartedWidget>
Inherited from AbstractViewContribution.openView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:39

`Protected`openWalkthrough

openWalkthrough(walkthrough?: WalkthroughReference): Promise<void>
Open the welcome view and, if a walkthrough is given, select it. Accepts both a plain id and the argument object that VS Code's workbench.action.openWalkthrough uses. Without a walkthrough, the available ones are offered for selection.
Parameters
- Optionalwalkthrough: WalkthroughReference
Returns Promise<void>
- Defined in packages/getting-started/src/browser/getting-started-contribution.ts:178

`Protected`pickWalkthrough

pickWalkthrough(): Promise<undefined | string>
Let the user choose one of the available walkthroughs, completed ones included.

Returns Promise<undefined | string>
the id of the chosen walkthrough, or undefined if there is nothing to choose or the user cancelled.
- Defined in packages/getting-started/src/browser/getting-started-contribution.ts:200

registerColors

registerColors(colors: ColorRegistry): void
Parameters
- colors: ColorRegistry
Returns void
Implementation of ColorContribution.registerColors
- Defined in packages/getting-started/src/browser/getting-started-contribution.ts:236

registerCommands

registerCommands(registry: CommandRegistry): void
Register commands and handlers.
Parameters
- registry: CommandRegistry
Returns void
Overrides AbstractViewContribution.registerCommands
- Defined in packages/getting-started/src/browser/getting-started-contribution.ts:152

registerKeybindings

registerKeybindings(keybindings: KeybindingRegistry): void
Registers keybindings.
Parameters
- keybindings: KeybindingRegistry
  the keybinding registry.
Returns void
Inherited from AbstractViewContribution.registerKeybindings
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:44

registerMenus

registerMenus(menus: MenuModelRegistry): void
Registers menus.
Parameters
- menus: MenuModelRegistry
  the menu model registry.
Returns void
Overrides AbstractViewContribution.registerMenus
- Defined in packages/getting-started/src/browser/getting-started-contribution.ts:223

toggleView

toggleView(): Promise<GettingStartedWidget>
Returns Promise<GettingStartedWidget>
Inherited from AbstractViewContribution.toggleView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:42

tryGetWidget

tryGetWidget(): undefined | GettingStartedWidget
Returns undefined | GettingStartedWidget
Inherited from AbstractViewContribution.tryGetWidget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:38

Class GettingStartedContribution

Example usage

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GettingStartedContribution

Properties

Protected ReadonlycommandRegistry

Protected ReadonlyeditorManager

Protected ReadonlyfileService

Protected ReadonlymessageService

Protected Readonlyoptions

Protected ReadonlypreferenceService

Protected ReadonlyquickInputService

Protected ReadonlyquickView

Protected Readonlyshell

Protected ReadonlystateService

Optional ReadonlytoggleCommand

Protected ReadonlywalkthroughService

Protected ReadonlywidgetManager

Protected ReadonlyworkspaceService

Accessors

defaultViewOptions

Returns ApplicationShell.WidgetOptions

effectiveWidgetId

Returns string

viewId

Returns string

viewLabel

Returns string

widget

Returns Promise<T>

Methods

closeView

Returns Promise<undefined | GettingStartedWidget>

initSchema

Parameters

Returns Promise<void>

onStart

Parameters

Returns Promise<void>

ProtectedopenReadme

Returns Promise<void>

openView

Parameters

Returns Promise<GettingStartedWidget>

ProtectedopenWalkthrough

Parameters

Returns Promise<void>

ProtectedpickWalkthrough

Returns Promise<undefined | string>

registerColors

Parameters

Returns void

registerCommands

Parameters

Returns void

registerKeybindings

Parameters

Returns void

registerMenus

Parameters

Returns void

toggleView

Returns Promise<GettingStartedWidget>

tryGetWidget

Returns undefined | GettingStartedWidget

Settings

On This Page

`Protected` `Readonly`commandRegistry

`Protected` `Readonly`editorManager

`Protected` `Readonly`fileService

`Protected` `Readonly`messageService

`Protected` `Readonly`options

`Protected` `Readonly`preferenceService

`Protected` `Readonly`quickInputService

`Protected` `Readonly`quickView

`Protected` `Readonly`shell

`Protected` `Readonly`stateService

`Optional` `Readonly`toggleCommand

`Protected` `Readonly`walkthroughService

`Protected` `Readonly`widgetManager

`Protected` `Readonly`workspaceService

`Protected`openReadme

`Protected`openWalkthrough

`Protected`pickWalkthrough