Microsoft.VisualStudio.LanguageServer.Protocol Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
ApplyWorkspaceEditParams |
Class representing the parameters sent from a server to a client for the workspace/applyEdit request. See the Language Server Protocol specification for additional information. |
ApplyWorkspaceEditResponse |
Class representing the response sent for a workspace/applyEdit request. See the Language Server Protocol specification for additional information. |
ClientCapabilities |
Class which represents client capabilities. See the Language Server Protocol specification for additional information. |
CodeAction |
A class representing a change that can be performed in code. A CodeAction must either set Edit or Command. If both are supplied, the edit will be applied first, then the command will be executed. See the Language Server Protocol specification for additional information. |
CodeActionContext |
Class representing diagnostic information about the context of a code action See the Language Server Protocol specification for additional information. |
CodeActionKindSetting |
Class containing the set of code action kinds that are supported. See the Language Server Protocol specification for additional information. |
CodeActionLiteralSetting |
Class representing support for code action literals. See the Language Server Protocol specification for additional information. |
CodeActionOptions |
Class representing the registration options for code actions support. See the Language Server Protocol specification for additional information. |
CodeActionParams |
Class representing the parameters sent from the client to the server for the textDocument/codeAction request. See the Language Server Protocol specification for additional information. |
CodeActionResolveSupportSetting |
Class representing settings for codeAction/resolve support. See the Language Server Protocol specification for additional information. |
CodeActionSetting |
Class representing settings for code action support. See the Language Server Protocol specification for additional information. |
CodeDescription |
Class representing a description for an error code. See the Language Server Protocol specification for additional information. |
CodeLens |
A class representing a code lens command that should be shown alongside source code. See the Language Server Protocol specification for additional information. |
CodeLensOptions |
Class representing the options for code lens support. See the Language Server Protocol specification for additional information. |
CodeLensParams |
Class representing the parameters sent from the client to the server for a textDocument/codeLens request. See the Language Server Protocol specification for additional information. |
CodeLensRegistrationOptions |
Class representing the registration options for indication code lens support. |
Color |
Class which represents a color. See the Language Server Protocol specification for additional information. |
ColorInformation |
Class which represents color information. See the Language Server Protocol specification for additional information. |
Command |
Class representing a reference to a command See the Language Server Protocol specification for additional information. |
CompletionContext |
Class representing additional information about the content in which a completion request is triggered. See the Language Server Protocol specification for additional information. |
CompletionItem |
Class which represents an IntelliSense completion item. See the Language Server Protocol specification for additional information. |
CompletionItemKindSetting |
Class which represents the initialization setting for completion item kind See the Language Server Protocol specification for additional information. |
CompletionItemSetting |
Class which represents initialization setting for completion item. See the Language Server Protocol specification for additional information. |
CompletionList |
Class which represents a completion list. See the Language Server Protocol specification for additional information. |
CompletionListItemDefaults |
Class which represents default properties associated with the entire completion list. |
CompletionListSetting |
Class which represents capabilites for the completion list type. |
CompletionOptions |
Class which represents completion capabilities. See the Language Server Protocol specification for additional information. |
CompletionParams |
Class representing the parameters for the textDocument/completion request. See the Language Server Protocol specification for additional information. |
CompletionRegistrationOptions |
Class representing the options for registering completion support. |
CompletionSetting |
Class which represents initialization setting for completion. See the Language Server Protocol specification for additional information. |
ConfigurationItem |
Class which represents an configuration item. See the Language Server Protocol specification for additional information. |
ConfigurationParams |
Class representing the parameters for the workspace/configuration request. See the Language Server Protocol specification for additional information. |
CreateFile |
Class representing a create file operation. See the Language Server Protocol specification for additional information. |
CreateFileOptions |
Class representing the options for a create file operation. See the Language Server Protocol specification for additional information. |
DefinitionOptions |
Class which represents workspace symbols capabilities. See the Language Server Protocol specification for additional information. |
DeleteFile |
Class representing a delete file operation. See the Language Server Protocol specification for additional information. |
DeleteFileOptions |
Class representing the options for a create file operation. See the Language Server Protocol specification for additional information. |
Diagnostic |
Class which represents a source code diagnostic message. See the Language Server Protocol specification for additional information. |
DidChangeConfigurationParams |
Class which represents the parameter sent with workspace/didChangeConfiguration requests. See the Language Server Protocol specification for additional information. |
DidChangeTextDocumentParams |
Class which represents the parameter that is sent with textDocument/didChange message. See the Language Server Protocol specification for additional information. |
DidChangeWatchedFilesParams |
Class which represents the parameter that is sent with workspace/didChangeWatchedFiles message. See the Language Server Protocol specification for additional information. |
DidChangeWatchedFilesRegistrationOptions |
Class representing the options for registering workspace/didChangeWatchedFiles support. |
DidCloseTextDocumentParams |
Class which represents the parameter that is sent with textDocument/didClose message. See the Language Server Protocol specification for additional information. |
DidOpenTextDocumentParams |
Class which represents the parameter that is sent with textDocument/didOpen message. See the Language Server Protocol specification for additional information. |
DidSaveTextDocumentParams |
Class which represents the parameter that is sent with a textDocument/didSave message. See the Language Server Protocol specification for additional information. |
DocumentColorOptions |
Class which represents workspace symbols capabilities. See the Language Server Protocol specification for additional information. |
DocumentColorParams |
Class representing the parameters sent for a textDocument/documentColor request. See the Language Server Protocol specification for additional information. |
DocumentFilter |
Class representing a filter over certain types of documents See the Language Server Protocol specification for additional information. |
DocumentFormattingOptions |
Class representing the document formatting options for server capabilities. See the Language Server Protocol specification for additional information. |
DocumentFormattingParams |
Class which represents the parameter that is sent with textDocument/formatting message. See the Language Server Protocol specification for additional information. |
DocumentHighlight |
Class representing the response from a textDocument/documentHighlight request. See the Language Server Protocol specification for additional information. |
DocumentHighlightOptions |
Class which represents workspace symbols capabilities. See the Language Server Protocol specification for additional information. |
DocumentHighlightParams |
Class representing the parameters sent for a textDocument/documentHighlight request. See the Language Server Protocol specification for additional information. |
DocumentLink |
Class representing the response of a textDocument/documentLink request. See the Language Server Protocol specification for additional information. |
DocumentLinkOptions |
Class representing the document link options for server capabilities. See the Language Server Protocol specification for additional information. |
DocumentLinkParams |
Class representing the parameters sent for a textDocument/documentLink request. See the Language Server Protocol specification for additional information. |
DocumentLinkRegistrationOptions |
Class representing the options for registering textDocument/documentLink support. |
DocumentOnTypeFormattingOptions |
Class representing the options for on type formatting. See the Language Server Protocol specification for additional information. |
DocumentOnTypeFormattingParams |
Class representing the parameters sent for a textDocument/onTypeFormatting request. See the Language Server Protocol specification for additional information. |
DocumentOnTypeFormattingRegistrationOptions |
Class representing the options for registering textDocument/onTypeFormatting support. |
DocumentRangeFormattingOptions |
Class representing the document range formatting options for server capabilities. See the Language Server Protocol specification for additional information. |
DocumentRangeFormattingParams |
Class which represents the parameter that is sent with textDocument/rangeFormatting message. See the Language Server Protocol specification for additional information. |
DocumentSymbol |
Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range, e.g. the range of an identifier. See the Language Server Protocol specification for additional information. |
DocumentSymbolOptions |
Class which represents workspace symbols capabilities. See the Language Server Protocol specification for additional information. |
DocumentSymbolParams |
Class which represents the parameter sent with textDocument/documentSymbol requests. See the Language Server Protocol specification for additional information. |
DocumentSymbolSetting |
Class representing the initialization setting for document symbols. See the Language Server Protocol specification for additional information. |
DocumentUriConverter |
TODO: document |
DynamicRegistrationSetting |
Class which represents a setting that can be dynamically registered. |
ExecuteCommandOptions |
Class representing the options for execute command support. See the Language Server Protocol specification for additional information. |
ExecuteCommandParams |
Class representing the parameters sent from client to server for the workspace/executeCommand request. See the Language Server Protocol specification for additional information. |
ExecuteCommandRegistrationOptions |
Class representing the registration options for indicating execute command support. |
FileEvent |
Class which represents a file change event. See the Language Server Protocol specification for additional information. |
FileSystemWatcher |
Class representing the watcher options for DidChangeWatchedFilesRegistrationOptions |
FoldingRange |
Class representing a folding range in a document. See the Language Server Protocol specification for additional information. |
FoldingRangeOptions |
Class representing the folding range provider options for initialization. See the Language Server Protocol specification for additional information. |
FoldingRangeOptionsConverter |
Converter which serializes a boolean value to FoldingRangeProviderOptions. |
FoldingRangeParams |
Class representing the folding range request parameter. See the Language Server Protocol specification for additional information. |
FoldingRangeProviderOptions |
Class representing the folding range provider options for initialization. |
FoldingRangeSetting |
Class representing the folding range setting for initialization. See the Language Server Protocol specification for additional information. |
FormattingOptions |
Class which represents formatting options. See the Language Server Protocol specification for additional information. |
Hover |
Class representing the data returned by a textDocument/hover request. See the Language Server Protocol specification for additional information. |
HoverContentsConverter |
Converter which provides custom serialization for the Contents property. |
HoverOptions |
Class which represents the server hover support. See the Language Server Protocol specification for additional information. |
HoverSetting |
Class which represents the initialization setting for hover. See the Language Server Protocol specification for additional information. |
ImplementationOptions |
Class which represents workspace symbols capabilities. See the Language Server Protocol specification for additional information. |
InitializedParams |
Class containing information sent with the 'initialized' notification. See the Language Server Protocol specification for additional information. |
InitializeError |
Class representing the error type sent when the initialize request fails. See the Language Server Protocol specification for additional information. |
InitializeParams |
Class which represents the parameter sent with an initialize method request. See the Language Server Protocol specification for additional information. |
InitializeResult |
Class which represents the result returned by the initialize request. See the Language Server Protocol specification for additional information. |
LinkedEditingRangeOptions |
Class which represents linked editing range capabilities. See the Language Server Protocol specification for additional information. |
LinkedEditingRangeParams |
Class representing the parameters sent for a textDocument/linkedEditingRange request. See the Language Server Protocol specification for additional information. |
LinkedEditingRanges |
Class representing the response of an LinkedEditingRanges response. See the Language Server Protocol specification for additional information. |
Location |
Class representing a location in a document. See the Language Server Protocol specification for additional information. |
LogMessageParams |
Class which represents parameter sent with window/logMessage requests. See the Language Server Protocol specification for additional information. |
LspNotification<TIn> |
Strongly typed object used to specify a LSP notification's parameter type. |
LspRequest<TIn,TOut> |
Strongly typed object used to specify a LSP requests's parameter and return types. |
MarkedString |
Class representing human readable text that should be rendered. See the Language Server Protocol specification for additional information. |
MarkupContent |
Class representing text and an associated format that should be rendered. See the Language Server Protocol specification for additional information. |
MessageActionItem |
Class which represent an action the user performs after a window/showMessageRequest request is sent. See the Language Server Protocol specification for additional information. |
Methods |
Class which contains the string values for all common language protocol methods. |
OptionalVersionedTextDocumentIdentifier |
Class which represents a text document, but optionally has a version identifier. See the Language Server Protocol specification for additional information. |
ParameterInformation |
Class representing a parameter of a callable signature. See the Language Server Protocol specification for additional information. |
ParameterInformationConverter |
JsonConverter to correctly deserialize int arrays in the Label param of ParameterInformation |
ParameterInformationSetting |
Class representing the parameter information initialization setting. See the Language Server Protocol specification for additional information. |
Position |
Class which represents a position on a text document. See the Language Server Protocol specification for additional information. |
PublishDiagnosticParams |
Class which represents the parameter that's sent with 'textDocument/publishDiagnostics' messages. See the Language Server Protocol specification for additional information. |
PublishDiagnosticsSetting |
Class representing the initialization setting for publish diagnostics. See the Language Server Protocol specification for additional information. |
Range |
Class which represents a text document text range. See the Language Server Protocol specification for additional information. |
ReferenceContext |
Class representing reference context information for find reference request parameter. See the Language Server Protocol specification for additional information. |
ReferenceOptions |
Class which represents workspace symbols capabilities. See the Language Server Protocol specification for additional information. |
ReferenceParams |
Class representing find reference parameter for find reference request. See the Language Server Protocol specification for additional information. |
Registration |
Class representing the general registration information for registering for a capability. See the Language Server Protocol specification for additional information. |
RegistrationParams |
Class representing the parameters sent for the client/registerCapability request. See the Language Server Protocol specification for additional information. |
RenameFile |
Class representing a rename file operation. See the Language Server Protocol specification for additional information. |
RenameFileOptions |
Class representing the options for a create file operation. See the Language Server Protocol specification for additional information. |
RenameOptions |
Class representing the rename options for server capabilities. See the Language Server Protocol specification for additional information. |
RenameParams |
Class representing the rename parameters for the textDocument/rename request. See the Language Server Protocol specification for additional information. |
SaveOptions |
Class which represents save option configurations. See the Language Server Protocol specification for additional information. |
SemanticTokenModifiers |
Well-known semantic token modifiers. |
SemanticTokens |
Class representing response to semantic tokens messages. See the Language Server Protocol specification for additional information. |
SemanticTokensDelta |
Represents a response from a semantic tokens Document provider Edits request. See the Language Server Protocol specification for additional information. |
SemanticTokensDeltaParams |
Parameters for a request for Edits that can be applied to a previous response from a semantic tokens Document provider. See the Language Server Protocol specification for additional information. |
SemanticTokensDeltaPartialResult |
Represents a response from a semantic tokens Document provider Edits request. See the Language Server Protocol specification for additional information. |
SemanticTokensEdit |
Class representing an individual edit incrementally applied to a previous semantic tokens response from the Document provider. See the Language Server Protocol specification for additional information. |
SemanticTokensFullOptions |
Options for the full document semantic tokens classification provider. See the Language Server Protocol specification for additional information. |
SemanticTokensLegend |
Legend used to encode semantic token types in Data. See the Language Server Protocol specification for additional information. |
SemanticTokensOptions |
Initialization options for semantic tokens support. See the Language Server Protocol specification for additional information. |
SemanticTokensParams |
Parameters for semantic tokens full Document request. See the Language Server Protocol specification for additional information. |
SemanticTokensPartialResult |
Class representing response to semantic tokens messages. See the Language Server Protocol specification for additional information. |
SemanticTokensRangeParams |
Parameters for the semantic tokens Range request. See the Language Server Protocol specification for additional information. |
SemanticTokensRequestsFullSetting |
Client settings for semantic tokens related to the
See the Language Server Protocol specification for additional information. |
SemanticTokensRequestsSetting |
Requests client settings for semantic tokens. See the Language Server Protocol specification for additional information. |
SemanticTokensSetting |
Client settings for semantic tokens. See the Language Server Protocol specification for additional information. |
SemanticTokenTypes |
Well-known semantic tokens types. |
ServerCapabilities |
Class which represents server capabilities. See the Language Server Protocol specification for additional information. |
ShowMessageParams |
Class which represents parameter sent with window/showMessage requests. See the Language Server Protocol specification for additional information. |
ShowMessageRequestParams |
Class which represents parameter sent with window/showMessageRequest requests. See the Language Server Protocol specification for additional information. |
SignatureHelp |
Class representing the signature of something callable. This class is returned from the textDocument/signatureHelp request. See the Language Server Protocol specification for additional information. |
SignatureHelpContext |
Class representing additional information about the context in which a signature help request is triggered. See the Language Server Protocol specification for additional information. |
SignatureHelpOptions |
Class representing the options for signature help support. See the Language Server Protocol specification for additional information. |
SignatureHelpParams |
Class representing the parameters for the textDocument/signatureHelp request. See the Language Server Protocol specification for additional information. |
SignatureHelpRegistrationOptions |
Class representing the registration options for indicating signature help support. |
SignatureHelpSetting |
Class representing the signature help initialization setting. See the Language Server Protocol specification for additional information. |
SignatureInformation |
Class representing a single signature of a callable item. See the Language Server Protocol specification for additional information. |
SignatureInformationSetting |
Class representing the signature information initialization setting. See the Language Server Protocol specification for additional information. |
SumConverter |
Converter to translate to and from SumTypes. |
SymbolInformation |
Class representing information about programming constructs like variables, classes, interfaces, etc. See the Language Server Protocol specification for additional information. |
SymbolKindSetting |
Class representing the symbol kind setting in initialization. See the Language Server Protocol specification for additional information. |
SymbolSetting |
Class representing the symbol setting for initialization. See the Language Server Protocol specification for additional information. |
SynchronizationSetting |
Class which represents synchronization initialization setting. See the Language Server Protocol specification for additional information. |
TagSupport |
Class representing the TagSupport capabilities. See the Language Server Protocol specification for additional information. |
TextDocumentChangeRegistrationOptions |
Class representing the registration options for textDocument/didChange support. |
TextDocumentClientCapabilities |
Class which represents text document capabilities. See the Language Server Protocol specification for additional information. |
TextDocumentContentChangeEvent |
Class which encapsulates a text document changed event. See the Language Server Protocol specification for additional information. |
TextDocumentEdit |
Class representing a set of changes to a single text document. See the Language Server Protocol specification for additional information. |
TextDocumentIdentifier |
Class which identifies a text document. See the Language Server Protocol specification for additional information. |
TextDocumentItem |
Class which represents a text document. See the Language Server Protocol specification for additional information. |
TextDocumentPositionParams |
Class which represents a position within a text document. See the Language Server Protocol specification for additional information. |
TextDocumentRegistrationOptions |
Class representing the registration options for many different text document functions. See the Language Server Protocol specification for additional information. |
TextDocumentSaveRegistrationOptions |
Class representing the options for registering textDocument/didSave support. |
TextDocumentSyncConverter |
Converter which offers custom serialization for TextDocumentSyncKind enum to a TextDocumentSyncOptions object. |
TextDocumentSyncOptions |
Class which represents configuration values indicating how text documents should be synced. See the Language Server Protocol specification for additional information. |
TextEdit |
Class which represents a text edit to a document. See the Language Server Protocol specification for additional information. |
TypeDefinitionOptions |
Class which represents workspace symbols capabilities. See the Language Server Protocol specification for additional information. |
Unregistration |
Class representing the information needed for unregistering a capability. See the Language Server Protocol specification for additional information. |
UnregistrationParams |
Class representing the parameter sent for the client/unregisterCapability request. See the Language Server Protocol specification for additional information. |
VersionedTextDocumentIdentifier |
Class which represents a text document, but has a version identifier. See the Language Server Protocol specification for additional information. |
WillSaveTextDocumentParams |
Class representing the parameters sent for the textDocument/willSave request. See the Language Server Protocol specification for additional information. |
WorkspaceClientCapabilities |
Class which represents workspace capabilities. See the Language Server Protocol specification for additional information. |
WorkspaceEdit |
Class representing a request sent from a language server to modify resources in the workspace. See the Language Server Protocol specification for additional information. |
WorkspaceEditSetting |
Class which represents initialization settings for workspace edit. See the Language Server Protocol specification for additional information. |
WorkspaceSymbolOptions |
Class which represents workspace symbols capabilities. See the Language Server Protocol specification for additional information. |
WorkspaceSymbolParams |
Class which represents the parameter that's sent with the 'workspace/symbol' request. See the Language Server Protocol specification for additional information. |
Structs
SumType<T1,T2> |
Struct that may contain a |
SumType<T1,T2,T3> |
Struct that may contain a |
SumType<T1,T2,T3,T4> |
Struct that may contain a |
Interfaces
IPartialResultParams<T> |
Interface to describe parameters for requests that support streaming results. See the Language Server Protocol specification for additional information. |
ISumType |
Abstracts over the idea of a "sum type". Sum types are types that can contain one value of various types. This abstraction is guaranteed to be typesafe, meaning you cannot access the underlying value without knowing its specific type. |
Enums
CodeActionKind |
Enum which represents the various kinds of code actions. See the Language Server Protocol specification for additional information. |
CompletionItemKind |
Enum values for completion item kinds. See the Language Server Protocol specification for additional information. |
CompletionTriggerKind |
Enum which represents the various ways in which completion can be triggered. See the Language Server Protocol specification for additional information. |
DiagnosticSeverity |
Diagnostic severity enum. See the Language Server Protocol specification for additional information. |
DiagnosticTag |
Diagnostic tag enum. Additional metadata about the type of a diagnostic See the Language Server Protocol specification for additional information. |
DocumentHighlightKind |
Enum representing the different types of document highlight. See the Language Server Protocol specification for additional information. |
FileChangeType |
File event type enum. See the Language Server Protocol specification for additional information. |
FoldingRangeKind |
Enum representing various code action kinds. See the Language Server Protocol specification for additional information. |
InitializeErrorCode |
Enum representing the possible reasons for an initialization error. See the Language Server Protocol specification for additional information. |
InsertTextFormat |
Enum representing insert text format for completion items. See the Language Server Protocol specification for additional information. |
MarkupKind |
Enum which represents the various formats of markup text. See the Language Server Protocol specification for additional information. |
MessageType |
Message type enum. See the Language Server Protocol specification for additional information. |
ResourceOperationKind |
The kind of resource operations supported by the client. See the Language Server Protocol specification for additional information. |
SemanticTokenFormat |
The format used to describe semantic tokens. See the Language Server Protocol specification for additional information. |
SignatureHelpTriggerKind |
Enum which represents the various ways in which completion can be triggered. See the Language Server Protocol specification for additional information. |
SymbolKind |
Enum which represents the various kinds of symbols. See the Language Server Protocol specification for additional information. |
TextDocumentSaveReason |
Enum representing the reason a document was saved. See the Language Server Protocol specification for additional information. |
TextDocumentSyncKind |
Enum which represents the various ways to sync text documents. See the Language Server Protocol specification for additional information. |
TraceSetting |
Enum which represents language server trace setting. See the Language Server Protocol specification for additional information. |
WatchKind |
Enum representing the type of changes to watch for. |