Class VSXExtensionsContribution

An abstract superclass for frontend contributions that add a view to the application shell.

Hierarchy (View Summary)

AbstractViewContribution<VSXExtensionsViewContainer>
- VSXExtensionsContribution

Implements

Constructors

constructor

new VSXExtensionsContribution(): VSXExtensionsContribution
Returns VSXExtensionsContribution
Overrides AbstractViewContribution.constructor
- Defined in packages/vsx-registry/src/browser/vsx-extensions-contribution.ts:69

Properties

`Protected`applicationServer

applicationServer: ApplicationServer

`Protected`clientProvider

clientProvider: OVSXClientProvider

`Protected`clipboardService

clipboardService: ClipboardService

`Protected`commandRegistry

commandRegistry: CommandRegistry

`Protected`fileDialogService

fileDialogService: FileDialogService

`Protected`labelProvider

labelProvider: LabelProvider

`Protected`messageService

messageService: MessageService

`Protected`model

model: VSXExtensionsModel

`Protected` `Readonly`options

options: ViewContributionOptions

`Protected`preferenceService

preferenceService: PreferenceService

`Protected`quickInput

quickInput: QuickInputService

`Protected` `Readonly`quickView

quickView: QuickViewService

`Protected` `Readonly`selectionService

selectionService: SelectionService

`Protected` `Readonly`shell

shell: ApplicationShell

`Optional` `Readonly`toggleCommand

toggleCommand?: Command

`Protected`vsxApiFilter

vsxApiFilter: OVSXApiFilterProvider

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

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

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:35

Methods

closeView

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

initializeLayout

initializeLayout(app: FrontendApplication): Promise<void>
Called after the application shell has been attached in case there is no previous workbench layout state. Should return a promise if it runs asynchronously.
Parameters
- app: FrontendApplication
Returns Promise<void>
Implementation of FrontendApplicationContribution.initializeLayout
- Defined in packages/vsx-registry/src/browser/vsx-extensions-contribution.ts:90

`Protected`installAnotherVersion

installAnotherVersion(extension: VSXExtension): Promise<void>
Given an extension, displays a quick pick of other compatible versions and installs the selected version.
Parameters
- extension: VSXExtension
  a VSX extension.
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extensions-contribution.ts:279

`Protected`installFromVSIX

installFromVSIX(): Promise<void>
Installs a local .vsix file after prompting the Open File dialog. Resolves to the URI of the file.

Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extensions-contribution.ts:238

`Protected`installVsixFile

installVsixFile(fileURI: URI): Promise<void>
Installs a local vs-code extension file. The implementation doesn't check if the file is a valid VSIX file, or the URI has a *.vsix extension. The caller should ensure the file is a valid VSIX file.
Parameters
- fileURI: URI
  the URI of the file to install.
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extensions-contribution.ts:263

openView

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

registerColors

registerColors(colors: ColorRegistry): void
Parameters
- colors: ColorRegistry
Returns void
Implementation of ColorContribution.registerColors
- Defined in packages/vsx-registry/src/browser/vsx-extensions-contribution.ts:189

registerCommands

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

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:42

registerMenus

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

`Protected`showBuiltinExtensions

showBuiltinExtensions(): Promise<void>
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extensions-contribution.ts:382

`Protected`showInstalledExtensions

showInstalledExtensions(): Promise<void>
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extensions-contribution.ts:387

`Protected`showRecommendedExtensions

showRecommendedExtensions(): Promise<void>
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extensions-contribution.ts:392

`Protected`showRecommendedToast

showRecommendedToast(): Promise<void>
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extensions-contribution.ts:353

toggleView

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

tryGetWidget

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

`Protected`updateVersion

updateVersion(extension: VSXExtension, updateToVersion: string): Promise<void>
Updates an extension to a specific version.
Parameters
- extension: VSXExtension
  the extension to update.
- updateToVersion: string
  the version to update to.
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extensions-contribution.ts:335

Class VSXExtensionsContribution

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns VSXExtensionsContribution

Properties

ProtectedapplicationServer

ProtectedclientProvider

ProtectedclipboardService

ProtectedcommandRegistry

ProtectedfileDialogService

ProtectedlabelProvider

ProtectedmessageService

Protectedmodel

Protected Readonlyoptions

ProtectedpreferenceService

ProtectedquickInput

Protected ReadonlyquickView

Protected ReadonlyselectionService

Protected Readonlyshell

Optional ReadonlytoggleCommand

ProtectedvsxApiFilter

Protected ReadonlywidgetManager

Accessors

defaultViewOptions

Returns ApplicationShell.WidgetOptions

viewId

Returns string

viewLabel

Returns string

widget

Returns Promise<T>

Methods

closeView

Returns Promise<undefined | VSXExtensionsViewContainer>

Protectedcopy

Parameters

Returns Promise<void>

ProtectedcopyExtensionId

Parameters

Returns void

Protectedinit

Returns void

initializeLayout

Parameters

Returns Promise<void>

ProtectedinstallAnotherVersion

Parameters

Returns Promise<void>

ProtectedinstallFromVSIX

Returns Promise<void>

ProtectedinstallVsixFile

Parameters

Returns Promise<void>

openView

Parameters

Returns Promise<VSXExtensionsViewContainer>

registerColors

Parameters

Returns void

registerCommands

Parameters

Returns void

registerKeybindings

Parameters

Returns void

registerMenus

Parameters

Returns void

ProtectedshowBuiltinExtensions

Returns Promise<void>

ProtectedshowInstalledExtensions

Returns Promise<void>

ProtectedshowRecommendedExtensions

`Protected`applicationServer

`Protected`clientProvider

`Protected`clipboardService

`Protected`commandRegistry

`Protected`fileDialogService

`Protected`labelProvider

`Protected`messageService

`Protected`model

`Protected` `Readonly`options

`Protected`preferenceService

`Protected`quickInput

`Protected` `Readonly`quickView

`Protected` `Readonly`selectionService

`Protected` `Readonly`shell

`Optional` `Readonly`toggleCommand

`Protected`vsxApiFilter

`Protected` `Readonly`widgetManager

`Protected`copy

`Protected`copyExtensionId

`Protected`init

`Protected`installAnotherVersion

`Protected`installFromVSIX

`Protected`installVsixFile

`Protected`showBuiltinExtensions

`Protected`showInstalledExtensions

`Protected`showRecommendedExtensions

`Protected`showRecommendedToast

`Protected`updateVersion