$ModuleEnv$Typings extension

on

Properties

appHost String
The hosted location of the application On desktop this is 'desktop' In the web this is the specified embedder i.e. 'github.dev', 'codespaces', or 'web' if the embedder does not provide that information
no setter
appName String
The application name of the editor, like 'VS Code'.
no setter
appRoot String
The application root folder from which the editor is running.
no setter
clipboard Clipboard
The system clipboard.
no setter
isNewAppInstall bool
Indicates that this is a fresh install of the application. true if within the first day of installation otherwise false.
no setter
isTelemetryEnabled bool
Indicates whether the users has telemetry enabled. Can be observed to determine if the extension should send telemetry.
no setter
language String
Represents the preferred user-language, like de-CH, fr, or en-US.
no setter
logLevel LogLevel
The current log level of the editor.
no setter
machineId String
A unique identifier for the computer.
no setter
onDidChangeLogLevel Event<LogLevel>
An {@link Event} which fires when the log level of the editor changes.
no setter
onDidChangeShell Event<String>
An {@link Event} which fires when the default shell changes. This fires with the new shell path.
no setter
onDidChangeTelemetryEnabled 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.
no setter
remoteName 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.
no setter
sessionId String
A unique identifier for the current session. Changes each time the editor is started.
no setter
shell String
The detected default shell for the extension host, this is overridden by the terminal.integrated.defaultProfile setting for the extension host's platform. Note that in environments that do not support a shell the value is the empty string.
no setter
uiKind 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.
no setter
uriScheme String
The custom uri scheme the editor registers to in the operating system.
no setter

Methods

asExternalUri(Uri target) Future
Resolves a uri to a form that is accessible externally.
createTelemetryLogger(TelemetrySender sender, [TelemetryLoggerOptions? options]) TelemetryLogger
Creates a new {@link TelemetryLoggertelemetry logger}.
openExternal(Uri target) Future
Opens a link externally using the default application. Depending on the used scheme this can be: