Extension<T> class

Represents an extension.

To get an instance of an Extension use {@link extensions.getExtensiongetExtension}.

Available extensions
Annotations
  • @JS()
  • @staticInterop
  • @anonymous

Constructors

Extension({String? id, Uri? extensionUri, String? extensionPath, bool? isActive, dynamic packageJSON, ExtensionKind? extensionKind, dynamic exports, Future activate()?})
factory

Properties

activate Future Function()

Available on Extension<T>, provided by the Extension$Typings extension

getter/setter pair
exports → T

Available on Extension<T>, provided by the Extension$Typings extension

The public API exported by this extension (return value of activate). It is an invalid action to access this field before this extension has been activated.
no setter
extensionKind ExtensionKind

Available on Extension<T>, provided by the Extension$Typings extension

The extension kind describes if an extension runs where the UI runs or if an extension runs where the remote extension host runs. The extension kind is defined in the package.json-file of extensions but can also be refined via the remote.extensionKind-setting. When no remote extension host exists, the value is {@linkcode ExtensionKind.UI}.
getter/setter pair
extensionPath String

Available on Extension<T>, provided by the Extension$Typings extension

The absolute file path of the directory containing this extension. Shorthand notation for {@link Extension.extensionUriExtension.extensionUri.fsPath} (independent of the uri scheme).
no setter
extensionUri Uri

Available on Extension<T>, provided by the Extension$Typings extension

The uri of the directory containing the extension.
no setter
hashCode int
The hash code for this object.
no setterinherited
id String

Available on Extension<T>, provided by the Extension$Typings extension

The canonical extension identifier in the form of: publisher.name.
no setter
isActive bool

Available on Extension<T>, provided by the Extension$Typings extension

true if the extension has been activated.
no setter
packageJSON → dynamic

Available on Extension<T>, provided by the Extension$Typings extension

The parsed contents of the extension's package.json.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited