API Reference
The Extension API consists of several object classes and interfaces exposed by the application to provide access to various features and functionality.
- AssistantsRegistry - Interfaces to registering and invoking assistants
- Charset - A representation of a set of Unicode characters used in search operations
- Clipboard - Reading and writing to the clipboard
- Color - Represents a displayable color object
- CommandsRegistry - Interfaces to registering and invoking extension commands
- CompletionContext - Information about the request for completion items within an editor
- CompletionItem - Represents an item displayed in the editor completions list
- CompositeDisposable - A collection for multiple disposable objects
- Configuration - Interfaces to storing and retrieving settings and persistent state
- Console - Interfaces to the standard logging console
- Credentials - Storage of secure credentials
- Disposable - An interface for objects that can be torn down
- Emitter - Dispatches event notifications to listeners
- Environment - Interfaces to the application environment
- Extension - Contains properties and method related to the current extension
- File - Allows reading and writing of files
- FileStats - Information about files on disk
- FileSystem - Query and modify attributes of file system objects
- FileSystemWatcher - Observe changes to files in the workspace
- Issue - Represents a single diagnostic from a linter, checker, or other tool
- IssueCollection - Used to provide organized issues to a workspace by file
- IssueParser - An object that can parse issues from the string output of a task using predefined rules
- LanguageClient - Interfaces to Language Server Protocol support
- NotificationCenter - Interfaces to managing notification requests
- NotificationRequest - Presents a notification to the user
- NotificationResponse - The result of presenting a notification to the user
- Path - Manipulation of file system paths
- Process - Interface to launch Unix subprocesses
- ProcessMessage - Represents a message sent between an extension and subprocess over JSON-RPC
- Range - Represents contiguous, linear regions of an element
- Scanner - A string parser that scans for substrings or characters in a character set
- Symbol - Represents a symbolic construct within an editor's text
- Task - Represents a dynamically-defined task
- TaskActionResolveContext - Contextual information about a task action being resolved
- TaskCommandAction - Defines a task action that invokes an extension command
- TaskProcessAction - Defines a task action that invokes a Unix subprocess
- TaskResolvableAction - Defines a task action that can be resolved to another type when invoked
- TextDocument - An open document in the workspace
- TextEdit - A single edit that may be applied to an editor
- TextEditor - An open editor in the workspace
- TextEditorEdit - An atomic edit operation that may combine multiple changes
- TreeDataProvider - An interface for objects that provided data to a TreeView
- TreeItem - Represents an item shown within a TreeView
- TreeView - Provides an interface to working with and providing data to a custom tree sidebar
- Web APIs - Interfaces supported from open Web API standards
- Workspace - Interface to an open workspace window