Interface | Description |
---|---|
InitializeErrorCode |
Known error codes for an `InitializeError`
|
PartialResultParams |
A parameter literal used to pass a partial result token.
|
WorkDoneProgressNotification |
The $/progress notification payload interface.
|
WorkDoneProgressOptions |
Options to signal work done progress support in server capabilities.
|
WorkDoneProgressParams |
A parameter literal used to pass a work done progress token.
|
Class | Description |
---|---|
AbstractTextDocumentRegistrationAndWorkDoneProgressOptions |
Options to signal work done progress support in server capabilities and TextDocumentRegistrationOptions.
|
AbstractWorkDoneProgressOptions |
Options to signal work done progress support in server capabilities.
|
AnnotatedTextEdit |
A special text edit with an additional change annotation.
|
ApplyWorkspaceEditParams |
The workspace/applyEdit request is sent from the server to the client to modify resource on the client side.
|
ApplyWorkspaceEditResponse | |
CallHierarchyCapabilities |
Capabilities specific to the
textDocument/prepareCallHierarchy . |
CallHierarchyIncomingCall |
Represents an incoming call, e.g.
|
CallHierarchyIncomingCallsParams |
The parameter of a `callHierarchy/incomingCalls` request.
|
CallHierarchyItem |
The result of a
textDocument/prepareCallHierarchy request. |
CallHierarchyOptions |
Since 3.16.0
|
CallHierarchyOutgoingCall |
Represents an outgoing call, e.g.
|
CallHierarchyOutgoingCallsParams |
The parameter of a `callHierarchy/outgoingCalls` request.
|
CallHierarchyPrepareParams |
The parameter of a `textDocument/prepareCallHierarchy` request.
|
CallHierarchyRegistrationOptions |
Since 3.16.0
|
ChangeAnnotation |
Additional information that describes document changes.
|
ClientCapabilities |
`ClientCapabilities` now define capabilities for dynamic registration, workspace and text document features the client supports.
|
ClientInfo |
Information about the client
Since 3.15.0
|
CodeAction |
A code action represents a change that can be performed in code, e.g.
|
CodeActionCapabilities |
Capabilities specific to the `textDocument/codeAction`
|
CodeActionContext |
Contains additional diagnostic information about the context in which a code action is run.
|
CodeActionDisabled |
Marks that the code action cannot currently be applied.
|
CodeActionKind |
The kind of a code action.
|
CodeActionKindCapabilities | |
CodeActionLiteralSupportCapabilities | |
CodeActionOptions |
Code Action options.
|
CodeActionParams |
The code action request is sent from the client to the server to compute commands for a given text document and range.
|
CodeActionRegistrationOptions |
Code Action registration options.
|
CodeActionResolveSupportCapabilities |
Whether the client supports resolving additional code action
properties via a separate `codeAction/resolve` request.
|
CodeLens |
A code lens represents a command that should be shown along with source text, like the number of references,
a way to run tests, etc.
|
CodeLensCapabilities |
Capabilities specific to the `textDocument/codeLens`
|
CodeLensOptions |
Code Lens options.
|
CodeLensParams |
The code lens request is sent from the client to the server to compute code lenses for a given text document.
|
CodeLensRegistrationOptions | |
CodeLensWorkspaceCapabilities |
Capabilities specific to the code lens requests scoped to the
workspace.
|
Color |
Represents a color in RGBA space.
|
ColorInformation | |
ColorPresentation | |
ColorPresentationParams |
The color presentation request is sent from the client to the server to obtain a list of presentations
for a color value at a given location.
|
ColorProviderCapabilities |
Capabilities specific to the `textDocument/documentColor` and the
`textDocument/colorPresentation` request.
|
ColorProviderOptions |
Document color options
|
Command |
Represents a reference to a command.
|
CompletionCapabilities |
Capabilities specific to the `textDocument/completion`
|
CompletionContext | |
CompletionItem |
The Completion request is sent from the client to the server to compute completion items at a given cursor position.
|
CompletionItemCapabilities |
The client supports the following `CompletionItem` specific capabilities.
|
CompletionItemInsertTextModeSupportCapabilities |
The client supports the
CompletionItem.insertTextMode property on
a completion item to override the whitespace handling mode
as defined by the client. |
CompletionItemKindCapabilities |
The client supports the following `CompletionItemKind` specific
capabilities.
|
CompletionItemResolveSupportCapabilities |
Indicates which properties a client can resolve lazily on a completion
item.
|
CompletionItemTagSupportCapabilities |
Client supports the tag property on a completion item.
|
CompletionList |
Represents a collection of completion items to be presented in the editor.
|
CompletionOptions |
Completion options.
|
CompletionParams |
The Completion request is sent from the client to the server to compute completion items at a given cursor position.
|
CompletionRegistrationOptions | |
ConfigurationItem |
A ConfigurationItem consist of the configuration section to ask for and an additional scope URI.
|
ConfigurationParams |
The workspace/configuration request is sent from the server to the client to fetch configuration
settings from the client.
|
CreateFile |
Create file operation
|
CreateFileOptions |
Options to create a file.
|
CreateFilesParams |
The parameters sent in notifications/requests for user-initiated creation
of files.
|
DeclarationCapabilities |
Capabilities specific to the `textDocument/declaration`
Since 3.14.0
|
DeclarationOptions | |
DeclarationParams |
The go to declaration request is sent from the client to the server to resolve the declaration
location of a symbol at a given text document position.
|
DeclarationRegistrationOptions | |
DefinitionCapabilities |
Capabilities specific to the `textDocument/definition`
Since 3.14.0
|
DefinitionOptions | |
DefinitionParams |
The go to definition request is sent from the client to the server to resolve the definition
location of a symbol at a given text document position.
|
DefinitionRegistrationOptions | |
DeleteFile |
Delete file operation
|
DeleteFileOptions |
Delete file options
|
DeleteFilesParams |
The parameters sent in notifications/requests for user-initiated deletes
of files.
|
Diagnostic |
Represents a diagnostic, such as a compiler error or warning.
|
DiagnosticCodeDescription |
Structure to capture a description for an error code.
|
DiagnosticRelatedInformation |
Represents a related message and source code location for a diagnostic.
|
DiagnosticsTagSupport | |
DidChangeConfigurationCapabilities |
Capabilities specific to the `workspace/didChangeConfiguration` notification.
|
DidChangeConfigurationParams |
A notification sent from the client to the server to signal the change of configuration settings.
|
DidChangeTextDocumentParams |
The document change notification is sent from the client to the server to signal changes to a text document.
|
DidChangeWatchedFilesCapabilities |
Capabilities specific to the `workspace/didChangeWatchedFiles` notification.
|
DidChangeWatchedFilesParams |
The watched files notification is sent from the client to the server when the client detects changes
to file watched by the language client.
|
DidChangeWatchedFilesRegistrationOptions | |
DidChangeWorkspaceFoldersParams |
The workspace/didChangeWorkspaceFolders notification is sent from the client to the server to
inform the server about workspace folder configuration changes.
|
DidCloseTextDocumentParams |
The document close notification is sent from the client to the server when the document got closed in the client.
|
DidOpenTextDocumentParams |
The document open notification is sent from the client to the server to signal newly opened text documents.
|
DidSaveTextDocumentParams |
The document save notification is sent from the client to the server when the document was saved in the client.
|
DocumentColorParams |
The document color request is sent from the client to the server to list all color references
found in a given text document.
|
DocumentFilter |
A document filter denotes a document through properties like language, schema or pattern.
|
DocumentFormattingOptions |
Document formatting options.
|
DocumentFormattingParams |
The document formatting request is sent from the server to the client to format a whole document.
|
DocumentFormattingRegistrationOptions |
Document formatting registration options.
|
DocumentHighlight |
A document highlight is a range inside a text document which deserves special attention.
|
DocumentHighlightCapabilities |
Capabilities specific to the `textDocument/documentHighlight`
|
DocumentHighlightOptions | |
DocumentHighlightParams |
The document highlight request is sent from the client to the server to resolve a document highlights
for a given text document position.
|
DocumentHighlightRegistrationOptions | |
DocumentLink |
A document link is a range in a text document that links to an internal or external resource, like another
text document or a web site.
|
DocumentLinkCapabilities |
Capabilities specific to the `textDocument/documentLink`
|
DocumentLinkOptions |
Document link options
|
DocumentLinkParams |
The document links request is sent from the client to the server to request the location of links in a document.
|
DocumentLinkRegistrationOptions | |
DocumentOnTypeFormattingOptions |
Format document on type options
|
DocumentOnTypeFormattingParams |
The document on type formatting request is sent from the client to the server to format parts of the document during typing.
|
DocumentOnTypeFormattingRegistrationOptions | |
DocumentRangeFormattingOptions |
Document range formatting options.
|
DocumentRangeFormattingParams |
The document range formatting request is sent from the client to the server to format a given range in a document.
|
DocumentRangeFormattingRegistrationOptions |
Document range formatting registration options.
|
DocumentSymbol |
Represents programming constructs like variables, classes, interfaces etc.
|
DocumentSymbolCapabilities |
Capabilities specific to the `textDocument/documentSymbol`
|
DocumentSymbolOptions | |
DocumentSymbolParams |
The document symbol request is sent from the client to the server to list all symbols found in a given text document.
|
DocumentSymbolRegistrationOptions | |
DynamicRegistrationCapabilities | |
ExecuteCommandCapabilities |
Capabilities specific to the `workspace/executeCommand` request.
|
ExecuteCommandOptions |
Execute command options.
|
ExecuteCommandParams |
The workspace/executeCommand request is sent from the client to the server to trigger command
execution on the server.
|
ExecuteCommandRegistrationOptions |
Execute command registration options.
|
FailureHandlingKind |
The kind of failure handling supported by the client.
|
FileCreate |
Represents information on a file/folder create.
|
FileDelete |
Represents information on a file/folder delete.
|
FileEvent |
An event describing a file change.
|
FileOperationFilter |
A filter to describe in which file operation requests or notifications
the server is interested in.
|
FileOperationOptions |
The options for file operations.
|
FileOperationPattern |
A pattern to describe in which file operation requests or notifications
the server is interested in.
|
FileOperationPatternKind |
A pattern kind describing if a glob pattern matches a file a folder or
both.
|
FileOperationPatternOptions |
Matching options for the file operation pattern.
|
FileOperationsServerCapabilities |
The server is interested in file notifications/requests.
|
FileOperationsWorkspaceCapabilities |
The client has support for file requests/notifications.
|
FileRename |
Represents information on a file/folder rename.
|
FileSystemWatcher | |
FoldingRange |
Represents a folding range.
|
FoldingRangeCapabilities |
Capabilities specific to `textDocument/foldingRange` requests.
|
FoldingRangeKind |
Enum of known range kinds
|
FoldingRangeProviderOptions |
Folding range options.
|
FoldingRangeRequestParams |
The folding range request is sent from the client to the server to return all folding
ranges found in a given text document.
|
FormattingCapabilities |
Capabilities specific to the `textDocument/formatting`
|
FormattingOptions |
Value-object describing what options formatting should use.
|
GeneralClientCapabilities |
General client capabilities.
|
Hover |
The result of a hover request.
|
HoverCapabilities |
Capabilities specific to the `textDocument/hover`
|
HoverOptions |
Hover options.
|
HoverParams |
The hover request is sent from the client to the server to request hover information at a given
text document position.
|
HoverRegistrationOptions |
Hover registration options.
|
ImplementationCapabilities |
Capabilities specific to the `textDocument/implementation`.
|
ImplementationOptions | |
ImplementationParams |
The go to implementation request is sent from the client to the server to resolve the implementation
location of a symbol at a given text document position.
|
ImplementationRegistrationOptions | |
InitializedParams | |
InitializeError | |
InitializeParams |
The initialize request is sent as the first request from the client to the server.
|
InitializeResult | |
InsertReplaceEdit |
A special text edit to provide an insert and a replace operation.
|
LinkedEditingRangeCapabilities |
Capabilities specific to the
textDocument/linkedEditingRange request. |
LinkedEditingRangeOptions |
Linked editing range options.
|
LinkedEditingRangeParams |
The linked editing range request is sent from the client to the server to return for a given position
in a document the range of the symbol at the position and all ranges that have the same content.
|
LinkedEditingRangeRegistrationOptions |
Linked editing range registration options.
|
LinkedEditingRanges |
The linked editing range response is sent from the server to the client to return the range of the symbol
at the given position and all ranges that have the same content.
|
Location |
Represents a location inside a resource, such as a line inside a text file.
|
LocationLink |
Represents a link between a source and a target location.
|
LogTraceParams |
A notification to log the trace of the server's execution.
|
MarkdownCapabilities |
Client capabilities specific to the used markdown parser.
|
MarkedString | Deprecated
Use
MarkupContent instead. |
MarkupContent |
A MarkupContent literal represents a string value which content is interpreted based on its
kind flag.
|
MarkupKind |
Describes the content type that a client supports in various
result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
|
MessageActionItem |
The show message request is sent from a server to a client to ask the client to display a particular message in the
user class.
|
MessageParams |
The show message notification is sent from a server to a client to ask the client to display a particular message
in the user class.
|
Moniker |
Moniker definition to match LSIF 0.5 moniker definition.
|
MonikerCapabilities |
Capabilities specific to the
textDocument/moniker request. |
MonikerKind |
The moniker kind.
|
MonikerOptions |
Moniker options.
|
MonikerParams |
The moniker request is sent from the client to the server to get the symbol monikers for a given text document position.
|
MonikerRegistrationOptions |
Moniker registration options.
|
OnTypeFormattingCapabilities |
Capabilities specific to the `textDocument/onTypeFormatting`
|
ParameterInformation |
Represents a parameter of a callable-signature.
|
ParameterInformationCapabilities |
Client capabilities specific to parameter information.
|
Position |
Position in a text document expressed as zero-based line and character offset.
|
PrepareRenameParams |
The prepare rename request is sent from the client to the server to setup and test the validity of a
rename operation at a given location.
|
PrepareRenameResult |
One of the result types of the `textDocument/prepareRename` request.
|
ProgressParams |
The base protocol offers also support to report progress in a generic fashion.
|
PublishDiagnosticsCapabilities |
Capabilities specific to `textDocument/publishDiagnostics`.
|
PublishDiagnosticsParams |
Diagnostics notification are sent from the server to the client to signal results of validation runs.
|
Range |
A range in a text document expressed as (zero-based) start and end positions.
|
RangeFormattingCapabilities |
Capabilities specific to the `textDocument/rangeFormatting`
|
ReferenceContext |
The references request is sent from the client to the server to resolve project-wide references for the symbol
denoted by the given text document position.
|
ReferenceOptions | |
ReferenceParams |
The references request is sent from the client to the server to resolve project-wide references for the symbol
denoted by the given text document position.
|
ReferenceRegistrationOptions | |
ReferencesCapabilities |
Capabilities specific to the `textDocument/references`
|
Registration |
General parameters to register for a capability.
|
RegistrationParams |
The client/registerCapability request is sent from the server to the client to register
for a new capability on the client side.
|
RegularExpressionsCapabilities |
Client capabilities specific to regular expressions.
|
RenameCapabilities |
Capabilities specific to the `textDocument/rename`
|
RenameFile |
Rename file operation
|
RenameFileOptions |
Rename file options
|
RenameFilesParams |
The parameters sent in notifications/requests for user-initiated renames
of files.
|
RenameOptions |
Rename options
|
RenameParams |
The rename request is sent from the client to the server to do a workspace wide rename of a symbol.
|
ResolveTypeHierarchyItemParams |
Request to resolve an unresolved
type hierarchy item which is indicated if the
parents or the children is not
defined. |
ResourceChange | Deprecated
As LSP introduces resource operation, use the
ResourceOperation instead. |
ResourceOperation | |
ResourceOperationKind |
The kind of resource operations supported by the client.
|
SaveOptions |
Save options.
|
SelectionRange |
A selection range represents a part of a selection hierarchy.
|
SelectionRangeCapabilities |
Capabilities specific to `textDocument/selectionRange` requests
Since 3.15.0
|
SelectionRangeOptions |
Selection range options.
|
SelectionRangeParams |
A parameter literal used in selection range requests.
|
SelectionRangeRegistrationOptions |
Selection range registration options.
|
SemanticTokenModifiers |
Since 3.16.0
|
SemanticTokens |
Since 3.16.0
|
SemanticTokensCapabilities |
Since 3.16.0
|
SemanticTokensClientCapabilitiesRequests |
Since 3.16.0
|
SemanticTokensClientCapabilitiesRequestsFull |
Since 3.16.0
|
SemanticTokensDelta |
Since 3.16.0
|
SemanticTokensDeltaParams |
The request is sent from the client to the server to resolve semantic token deltas for a given whole file.
|
SemanticTokensDeltaPartialResult |
Since 3.16.0
|
SemanticTokensEdit |
Since 3.16.0
|
SemanticTokensLegend |
The legend used by the server
Since 3.16.0
|
SemanticTokensParams |
The request is sent from the client to the server to resolve semantic tokens for a given whole file.
|
SemanticTokensPartialResult |
Since 3.16.0
|
SemanticTokensRangeParams |
The request is sent from the client to the server to resolve semantic tokens for a range in a given file.
|
SemanticTokensServerFull |
Server supports providing semantic tokens for a full document.
|
SemanticTokensWithRegistrationOptions |
Since 3.16.0
|
SemanticTokensWorkspaceCapabilities |
Capabilities specific to the semantic token requests scoped to the
workspace.
|
SemanticTokenTypes |
Since 3.16.0
|
ServerCapabilities |
The server can signal these capabilities
|
ServerInfo |
Information about the server.
|
SetTraceParams |
A notification that should be used by the client to modify the trace setting of the server.
|
ShowDocumentCapabilities |
Client capabilities for the show document request.
|
ShowDocumentParams |
Params to show a document.
|
ShowDocumentResult |
The result of an show document request.
|
ShowMessageRequestParams |
The show message request is sent from a server to a client to ask the client to display a particular message in the
user class.
|
SignatureHelp |
Signature help represents the signature of something callable.
|
SignatureHelpCapabilities |
Capabilities specific to the `textDocument/signatureHelp`
|
SignatureHelpContext |
Additional information about the context in which a signature help request was triggered.
|
SignatureHelpOptions |
Signature help options.
|
SignatureHelpParams |
The signature help request is sent from the client to the server to request signature information at a given cursor position.
|
SignatureHelpRegistrationOptions | |
SignatureInformation |
Represents the signature of something callable.
|
SignatureInformationCapabilities |
The client supports the following `SignatureInformation` specific properties.
|
StaticRegistrationOptions |
Static registration options to be returned in the initialize request.
|
SymbolCapabilities |
Capabilities specific to the `workspace/symbol` request.
|
SymbolInformation |
Represents information about programming constructs like variables, classes, interfaces etc.
|
SymbolKindCapabilities |
Specific capabilities for the `SymbolKind`.
|
SymbolTagSupportCapabilities |
Specific capabilities for the `SymbolTag`.
|
SynchronizationCapabilities | |
TextDocumentChangeRegistrationOptions |
Describe options to be used when registered for text document change events.
|
TextDocumentClientCapabilities |
Text document specific client capabilities.
|
TextDocumentContentChangeEvent |
An event describing a change to a text document.
|
TextDocumentEdit |
Describes textual changes on a single text document.
|
TextDocumentIdentifier |
Text documents are identified using an URI.
|
TextDocumentItem |
An item to transfer a text document from the client to the server.
|
TextDocumentPositionAndWorkDoneProgressAndPartialResultParams |
Abstract class which extends TextDocumentPosition and implements work done progress and partial result request parameter.
|
TextDocumentPositionAndWorkDoneProgressParams |
Abstract class which extends TextDocumentPosition and implements work done progress request parameter.
|
TextDocumentPositionParams |
A parameter literal used in requests to pass a text document and a position inside that document.
|
TextDocumentRegistrationOptions |
Since most of the registration options require to specify a document selector there is
a base interface that can be used.
|
TextDocumentSaveRegistrationOptions | |
TextDocumentSyncOptions | |
TextEdit |
A textual edit applicable to a text document.
|
TokenFormat |
Since 3.16.0
|
TraceValue |
A TraceValue represents the level of verbosity with which the server systematically reports its execution
trace using
$/logTrace notifications. |
TypeDefinitionCapabilities |
Capabilities specific to the `textDocument/typeDefinition`
Since 3.6.0
|
TypeDefinitionOptions | |
TypeDefinitionParams |
The go to type definition request is sent from the client to the server to resolve the type definition
location of a symbol at a given text document position.
|
TypeDefinitionRegistrationOptions | |
TypeHierarchyCapabilities |
Capabilities specific to the
textDocument/typeHierarchy . |
TypeHierarchyItem |
Representation of an item that carries type information (such as class, interface, enumeration, etc) with additional parentage details.
|
TypeHierarchyParams |
The type hierarchy request is sent from the client resolve a
type hierarchy item for
a give cursor location in the text document. |
UniquenessLevel |
Moniker uniqueness level to define scope of the moniker.
|
Unregistration |
General parameters to unregister a capability.
|
UnregistrationParams |
The client/unregisterCapability request is sent from the server to the client to unregister
a previously registered capability.
|
VersionedTextDocumentIdentifier |
An identifier to denote a specific version of a text document.
|
WatchKind | |
WillSaveTextDocumentParams | |
WindowClientCapabilities |
Window specific client capabilities.
|
WindowShowMessageRequestActionItemCapabilities |
Capabilities specific to the `MessageActionItem` type of show message request.
|
WindowShowMessageRequestCapabilities |
Show message request client capabilities
Since 3.16.0
|
WorkDoneProgressAndPartialResultParams |
Abstract class which implements work done progress and partial result request parameter.
|
WorkDoneProgressBegin |
The $/progress notification payload to start progress reporting.
|
WorkDoneProgressCancelParams |
The
window/workDoneProgress/cancel notification is sent from the client to the server to cancel a progress initiated on the server side using the
window/workDoneProgress/create . |
WorkDoneProgressCreateParams |
The
window/workDoneProgress/create request is sent from the server to the client to ask the client to create a work done progress. |
WorkDoneProgressEnd |
The notification payload about progress reporting.
|
WorkDoneProgressReport |
The notification payload about progress reporting.
|
WorkspaceClientCapabilities |
Workspace specific client capabilities.
|
WorkspaceEdit |
A workspace edit represents changes to many resources managed in the workspace.
|
WorkspaceEditCapabilities |
Capabilities specific to
WorkspaceEdit s |
WorkspaceEditChangeAnnotationSupportCapabilities |
Whether the client in general supports change annotations on text edits,
create file, rename file and delete file changes.
|
WorkspaceFolder |
The workspace/workspaceFolders request is sent from the server to the client to fetch
the current open list of workspace folders.
|
WorkspaceFoldersChangeEvent |
The workspace folder change event.
|
WorkspaceFoldersOptions |
The server supports workspace folder.
|
WorkspaceServerCapabilities |
Workspace specific server capabilities
|
WorkspaceSymbolOptions |
The options of a Workspace Symbol Request.
|
WorkspaceSymbolParams |
The parameters of a Workspace Symbol Request.
|
WorkspaceSymbolRegistrationOptions |
The options of a Workspace Symbol Registration Request.
|
Enum | Description |
---|---|
CallHierarchyDirection |
The direction of a call hierarchy.
|
CompletionItemKind |
The kind of a completion entry.
|
CompletionItemTag |
Completion item tags are extra annotations that tweak the rendering of a completion
item.
|
CompletionTriggerKind |
How a completion was triggered
|
DiagnosticSeverity | |
DiagnosticTag |
The diagnostic tags.
|
DocumentHighlightKind |
A document highlight kind.
|
FileChangeType |
The file event type.
|
InsertTextFormat |
Defines whether the insert text in a completion item should be interpreted as
plain text or a snippet.
|
InsertTextMode |
How whitespace and indentation is handled during completion
item insertion.
|
MessageType | |
PrepareSupportDefaultBehavior |
The value indicates the default behavior used by the
client.
|
ResponseErrorCode | Deprecated
Use
ResponseErrorCode instead |
SignatureHelpTriggerKind |
How a signature help was triggered.
|
SymbolKind | |
SymbolTag |
Symbol tags are extra annotations that tweak the rendering of a symbol.
|
TextDocumentSaveReason |
Represents reasons why a text document is saved.
|
TextDocumentSyncKind |
Defines how text documents are synced.
|
TypeHierarchyDirection |
Direction specific to the
textDocument/typeHierarchy and
typeHierarchy/resolve LS methods. |
WorkDoneProgressKind |