AI Disclosure: This page was generated by an LLM and may contain inaccuracies. Hand-crafted documentation will be implemented over time on the road to 1.0
SDK type reference
This machine-owned reference is generated from the curated Plugin API 1.0.0 declaration graph synchronized with the plugin starter.
Use the workflow guides for permissions, lifecycle consequences, and complete examples. Every declaration below has one canonical page and one owning category.
Plugin
Provider union
File viewing and editing
PreviewProviderPreviewDestinationPreviewSessionPreviewSessionFactoryPropsPreviewSurfacePropsPreviewToolbarContributionPropsPreviewDestinationCapabilitiesThumbnailProviderPropsEditorHistoryHandlePreviewToolbarEditorState
Metadata
MetadataProviderRawMetadataExtractedMetadataFileMetadataMetadataSchemaFieldMetadataSchemaMetadataColumnPolicyFilterValueOptionDirectoryMetadataProfileOptionsMetadataProviderDirectoryStatsDirectoryMetadataProfile
File views
Panels and tabs
ModuleProviderModuleProviderPropsModuleAPIModulesAPIModuleOpenResultModulePositionModuleInstanceItemShortcutConfig
Settings and database
PluginSettingsSchemaSettingsFieldSettingsFieldTypeSettingsFieldBaseBooleanSettingsFieldStringSettingsFieldNumberSettingsFieldSelectSettingsFieldPathSettingsFieldPluginDatabaseSchemaPluginDatabaseMigrationPluginDatabaseTransactionPluginDatabaseSchemaOperationsPluginTableDefinitionPluginColumnDefinitionPluginIndexDefinitionPluginColumnType
Base and scoped APIs
PluginAPIPreviewAPIMetadataAPIExplorerAPIGitAPIWorkspaceFoldersAPIClipboardAPIPluginSettingsPluginSettingsChangePluginSettingsSubscriptionPluginStorageAPIPluginDatabaseAPIDatabaseExecuteResultReadonlyAppSettingsModalAPINotifyAPIFileUtilsAPIPluginTextFileSnapshotPluginTextWriteResultPluginBinaryFileSnapshotPluginBinaryWriteResultPluginDirectoryReadResultPluginPathOutcomePluginFileErrorPluginFileErrorCodePluginFileFailurePluginDirectoryWatchFileMatchAPIEventsAPIViewAPI
Explorer
PluginPaneContextPluginPaneListingPluginPaneSelectionPluginPaneNavigationPluginPaneViewPluginPaneColumnPluginPaneSortPluginPaneWorkspaceFolder
Workspace Folders
WorkspaceFolderSchemaWorkspaceFolderPropertyDefinitionWorkspaceFolderPropertyOptionWorkspaceFolderPropertyTypeWorkspaceFolderPropertyValueWorkspaceFolderFileRefWorkspaceFolderPropertyWriteKnownWorkspaceFolder
Repository inspection
Commands
ToolbarContextToolbarSubToolbarPropsCommandContextKeyCommandContextCommandShortcutCommandPlacementAreaCommandPlacementBaseToolbarPlacementConfigContextMenuPlacementConfigCommandPlacementCommandCommandProvider
File model
Shortcuts
Events
EventMapEventHandlerEventSubscriptionCoreEventsPluginEventsEventPayloadColumnLayoutChangedPayloadLayoutSettledPayloadLayoutSettledReason
Manifest
PluginManifestPluginPermissionPluginIdentityPluginIdentityProjectionPluginCandidateIdentityValidationResult