Variables

read onlyappHost:String

The environment in which the app is hosted in. i.e. 'desktop', 'codespaces', 'web'.

read onlyappName:String

The application name of the editor, like 'VS Code'.

read onlyappRoot:String

The application root folder from which the editor is running.

Note that the value is the empty string when running in an environment that has no representation of an application root folder.

read onlyclipboard:Clipboard

The system clipboard.

read onlyisNewAppInstall:Bool

Indicates that this is a fresh install of the application. true if within the first day of installation otherwise false.

read onlyisTelemetryEnabled:Bool

Indicates whether the users has telemetry enabled. Can be observed to determine if the extension should send telemetry.

read onlylanguage:String

Represents the preferred user-language, like de-CH, fr, or en-US.

read onlymachineId:String

A unique identifier for the computer.

read onlyonDidChangeTelemetryEnabled:Event<Bool>

An {@link Event} which fires when the user enabled or disables telemetry. true if the user has enabled telemetry or false if the user has disabled telemetry.

read onlyremoteName:Null<String>

The name of a remote. Defined by extensions, popular samples are wsl for the Windows Subsystem for Linux or ssh-remote for remotes using a secure shell.

Note that the value is undefined when there is no remote extension host but that the value is defined in all extension hosts (local and remote) in case a remote extension host exists. Use {@link Extension.extensionKind} to know if a specific extension runs remote or not.

read onlysessionId:String

A unique identifier for the current session. Changes each time the editor is started.

read onlyshell:String

The detected default shell for the extension host, this is overridden by the terminal.integrated.shell setting for the extension host's platform. Note that in environments that do not support a shell the value is the empty string.

read onlyuiKind:UIKind

The UI kind property indicates from which UI extensions are accessed from. For example, extensions could be accessed from a desktop application or a web browser.

read onlyuriScheme:String

The custom uri scheme the editor registers to in the operating system.

Methods

asExternalUri(target:Uri):Thenable<Uri>

Resolves a uri to a form that is accessible externally.

http: or https: scheme

Resolves an external uri, such as a http: or https: link, from where the extension is running to a uri to the same resource on the client machine.

This is a no-op if the extension is running on the client machine.

If the extension is running remotely, this function automatically establishes a port forwarding tunnel from the local machine to target on the remote and returns a local uri to the tunnel. The lifetime of the port forwarding tunnel is managed by the editor and the tunnel can be closed by the user.

Note that uris passed through openExternal are automatically resolved and you should not call asExternalUri on them.

vscode.env.uriScheme

Creates a uri that - if opened in a browser (e.g. via openExternal) - will result in a registered {@link UriHandler} to trigger.

Extensions should not make any assumptions about the resulting uri and should not alter it in any way. Rather, extensions can e.g. use this uri in an authentication flow, by adding the uri as callback query argument to the server to authenticate to.

Note that if the server decides to add additional query parameters to the uri (e.g. a token or secret), it will appear in the uri that is passed to the {@link UriHandler}.

Example of an authentication flow:

vscode.window.registerUriHandler({
  handleUri(uri: vscode.Uri): vscode.ProviderResult<void> {
    if (uri.path === '/did-authenticate') {
      console.log(uri.toString());
    }
  }
});

const callableUri = await vscode.env.asExternalUri(vscode.Uri.parse(`${vscode.env.uriScheme}://my.extension/did-authenticate`));
await vscode.env.openExternal(callableUri);

Note that extensions should not cache the result of asExternalUri as the resolved uri may become invalid due to a system or user action — for example, in remote cases, a user may close a port forwarding tunnel that was opened by asExternalUri.

Any other scheme

Any other scheme will be handled as if the provided URI is a workspace URI. In that case, the method will return a URI which, when handled, will make the editor open the workspace.

Returns:

A uri that can be used on the client machine.

openExternal(target:Uri):Thenable<Bool>

Opens a link externally using the default application. Depending on the used scheme this can be: a browser (http:, https:) a mail client (mailto:) * VSCode itself (vscode: from vscode.env.uriScheme)

Note that {@linkcode window.showTextDocument showTextDocument} is the right way to open a text document inside the editor, not this function.

Parameters:

target

The uri that should be opened.

Returns:

A promise indicating if open was successful.