Class VSXExtension

Implements

Constructors

constructor

new VSXExtension(): VSXExtension
Returns VSXExtension

Properties

`Protected`_currentTask

_currentTask: undefined | Promise<void>

`Protected`_currentTaskName

_currentTaskName: undefined | string

`Readonly`commandRegistry

commandRegistry: CommandRegistry

`Protected` `Readonly`contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

`Protected` `Readonly`data

data: Partial<VSXExtensionData> = {}

`Readonly`environment

environment: VSXEnvironment

`Protected` `Readonly`hoverService

hoverService: HoverService

`Protected` `Readonly`openerService

openerService: OpenerService

`Protected` `Readonly`options

options: VSXExtensionOptions

`Protected` `Readonly`pluginServer

pluginServer: PluginServer

`Protected` `Readonly`pluginSupport

pluginSupport: HostedPluginSupport

`Protected` `Readonly`progressService

progressService: ProgressService

`Protected`registryUri

registryUri: Promise<string>

`Readonly`search

search: VSXExtensionsSearchModel

`Readonly`windowService

windowService: WindowService

`Protected` `Readonly`workspaceTrustService

workspaceTrustService: WorkspaceTrustService

Accessors

averageRating

get averageRating(): undefined | number
Returns undefined | number
Implementation of VSXExtensionData.averageRating
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:260

builtin

get builtin(): boolean
Returns boolean
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:207

currentTask

get currentTask(): undefined | string
Returns undefined | string
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:366

deployed

get deployed(): boolean
Returns boolean
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:193

description

get description(): undefined | string
Returns undefined | string
Implementation of VSXExtensionData.description
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:252

disabled

get disabled(): boolean
Returns boolean
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:199

disabledByTrust

get disabledByTrust(): boolean
Returns boolean
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:203

displayName

get displayName(): undefined | string
Returns undefined | string
Implementation of VSXExtensionData.displayName
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:248

downloadCount

get downloadCount(): undefined | number
Returns undefined | number
Implementation of VSXExtensionData.downloadCount
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:264

downloadUrl

get downloadUrl(): undefined | string
Returns undefined | string
Implementation of VSXExtensionData.downloadUrl
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:268

iconUrl

get iconUrl(): undefined | string
Returns undefined | string
Implementation of VSXExtensionData.iconUrl
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:231

id

get id(): string
default: parent id + position among siblings

Returns string
Implementation of TreeElement.id
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:163

installed

get installed(): boolean
Returns boolean
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:183

installedVersion

get installedVersion(): undefined | string
Returns undefined | string
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:167

license

get license(): undefined | string
Returns undefined | string
Implementation of VSXExtensionData.license
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:304

licenseUrl

get licenseUrl(): undefined | string
Returns undefined | string
Implementation of VSXExtensionData.licenseUrl
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:287

localReadmeUrl

get localReadmeUrl(): undefined | string
The README URL served by the local plugin host for an installed extension, or undefined if the README is not available locally (e.g. for a non-installed extension whose README is hosted by the remote registry). A local README is same-origin and can be fetched directly by the frontend, whereas a remote README must be retrieved through the backend VSXRegistryService.

Returns undefined | string
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:282

model

get model(): VSXExtensionsModel
Returns VSXExtensionsModel
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:171

name

get name(): undefined | string
Returns undefined | string
Implementation of VSXExtensionData.name
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:244

namespaceAccess

get namespaceAccess(): undefined | VSXExtensionNamespaceAccess
Returns undefined | VSXExtensionNamespaceAccess
Implementation of VSXExtensionData.namespaceAccess
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:320

plugin

get plugin(): undefined | DeployedPlugin
Returns undefined | DeployedPlugin
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:179

preview

get preview(): undefined | boolean
Returns undefined | boolean
Implementation of VSXExtensionData.preview
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:312

publishedBy

get publishedBy(): undefined | VSXUser
Returns undefined | VSXUser
Implementation of VSXExtensionData.publishedBy
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:324

publisher

get publisher(): undefined | string
Returns undefined | string
Implementation of VSXExtensionData.publisher
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:240

readme

get readme(): undefined | string
Returns undefined | string
Implementation of VSXExtensionData.readme
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:308

readmeUrl

get readmeUrl(): undefined | string
Returns undefined | string
Implementation of VSXExtensionData.readmeUrl
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:272

repository

get repository(): undefined | string
Returns undefined | string
Implementation of VSXExtensionData.repository
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:300

get tooltip(): string
Returns string
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:328

uninstalled

get uninstalled(): boolean
Returns boolean
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:187

uri

get uri(): URI
Returns URI
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:159

verified

get verified(): undefined | boolean
Returns undefined | boolean
Implementation of VSXExtensionData.verified
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:316

version

get version(): undefined | string
Returns undefined | string
Implementation of VSXExtensionData.version
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:256

visible

get visible(): boolean
default: true

Returns boolean
Implementation of TreeElement.visible
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:175

Methods

disable

disable(): Promise<void>
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:423

`Protected`doInstall

doInstall(options?: PluginDeployOptions): Promise<void>
Parameters
- Optionaloptions: PluginDeployOptions
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:447

doOpen

doOpen(uri: URI, options?: OpenerOptions): Promise<void>
Parameters
- uri: URI
- Optionaloptions: OpenerOptions
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:501

enable

enable(): Promise<void>
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:435

`Protected`getData

getData<K extends keyof VSXExtensionData>(key: K): VSXExtensionData[K]
Type Parameters
- K extends keyof VSXExtensionData
Parameters
- key: K
Returns VSXExtensionData[K]
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:223

getRegistryLink

getRegistryLink(path?: string): Promise<URI>
Get the registry link for the given extension.
Parameters
- path: string = ''
  the url path.
Returns Promise<URI>
the registry link for the given extension at the path.
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:472

handleContextMenu

handleContextMenu(e: MouseEvent<HTMLElement, MouseEvent>): void
Parameters
- e: MouseEvent<HTMLElement, MouseEvent>
Returns void
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:454

install

install(options?: PluginDeployOptions): Promise<void>
Parameters
- Optionaloptions: PluginDeployOptions
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:384

open

open(options?: OpenerOptions): Promise<void>
Parameters
- options: OpenerOptions = ...
Returns Promise<void>
Implementation of TreeElement.open
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:497

`Protected`postConstruct

postConstruct(): void
Returns void
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:155

reloadWindow

reloadWindow(): void
Returns void
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:219

render

render(host: TreeWidget): ReactNode
Parameters
- host: TreeWidget
Returns ReactNode
Implementation of TreeElement.render
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:505

`Protected`runTask

runTask(name: string, task: () => Promise<void>): Promise<void>
Parameters
- name: string
- task: () => Promise<void>
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:371

serialize

serialize(): Promise<string>
Returns Promise<string>
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:483

uninstall

uninstall(): Promise<void>
Returns Promise<void>
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:411

update

update(data: Partial<VSXExtensionData>): void
Parameters
- data: Partial<VSXExtensionData>
Returns void
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:211

`Static`formatVersion

formatVersion(version: undefined | string): undefined | string
Ensure the version string begins with 'v'.
Parameters
- version: undefined | string
Returns undefined | string
- Defined in packages/vsx-registry/src/browser/vsx-extension.tsx:107