$ModuleEnv class - typings.vscode library

Constructors

$ModuleEnv()

Properties

appHost → String: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
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: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
The application name of the editor, like 'VS Code'.
no setter
appRoot → String: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
The application root folder from which the editor is running.
no setter
clipboard → Clipboard: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
The system clipboard.
no setter
hashCode → int: The hash code for this object.
no setterinherited
isNewAppInstall → bool: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
Indicates that this is a fresh install of the application. true if within the first day of installation otherwise false.
no setter
isTelemetryEnabled → bool: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
Indicates whether the users has telemetry enabled. Can be observed to determine if the extension should send telemetry.
no setter
language → String: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
Represents the preferred user-language, like de-CH, fr, or en-US.
no setter
logLevel → LogLevel: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
The current log level of the editor.
no setter
machineId → String: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
A unique identifier for the computer.
no setter
onDidChangeLogLevel → Event<LogLevel>: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
An {@link Event} which fires when the log level of the editor changes.
no setter
onDidChangeShell → Event<String>: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
An {@link Event} which fires when the default shell changes. This fires with the new shell path.
no setter
onDidChangeTelemetryEnabled → Event<bool>: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
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?: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
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
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sessionId → String: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
A unique identifier for the current session. Changes each time the editor is started.
no setter
shell → String: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
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: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
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: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
The custom uri scheme the editor registers to in the operating system.
no setter

Methods

asExternalUri(Uri target) → Future: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
Resolves a uri to a form that is accessible externally.
createTelemetryLogger(TelemetrySender sender, [TelemetryLoggerOptions? options]) → TelemetryLogger: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
Creates a new {@link TelemetryLoggertelemetry logger}.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
openExternal(Uri target) → Future: Available on $ModuleEnv, provided by the $ModuleEnv$Typings extension
Opens a link externally using the default application. Depending on the used scheme this can be:
toString() → String: A string representation of this object.
inherited

Operators

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