| Modifier and Type | Method and Description |
|---|---|
| public default CompletableFuture | callHierarchyIncomingCalls(CallHierarchyIncomingCallsParams params)
Provide all incoming calls for an item, e.g all callers for a method. |
| public default CompletableFuture | callHierarchyOutgoingCalls(CallHierarchyOutgoingCallsParams params)
Provide all outgoing calls for an item, e.g call calls to functions, methods, or constructors from the given item. |
| public default CompletableFuture | codeAction(CodeActionParams params)
The code action request is sent from the client to the server to compute commands for a given text document and range. |
| public default CompletableFuture | codeLens(CodeLensParams params)
The code lens request is sent from the client to the server to compute code lenses for a given text document. |
| public default CompletableFuture | colorPresentation(ColorPresentationParams params)
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. |
| public default CompletableFuture | completion(CompletionParams position)
The Completion request is sent from the client to the server to compute completion items at a given cursor position. |
| public default CompletableFuture | declaration(DeclarationParams params)
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. |
| public default CompletableFuture | definition(DefinitionParams params)
The goto definition request is sent from the client to the server to resolve the definition location of a symbol at a given text document position. |
| public default CompletableFuture | diagnostic(DocumentDiagnosticParams params)
The text document diagnostic request is sent from the client to the server to ask the server to compute the diagnostics for a given document. |
| public void | didChange(DidChangeTextDocumentParams params)
The document change notification is sent from the client to the server to signal changes to a text document. |
| public void | didClose(DidCloseTextDocumentParams params)
The document close notification is sent from the client to the server when the document got closed in the client. |
| public void | didOpen(DidOpenTextDocumentParams params)
The document open notification is sent from the client to the server to signal newly opened text documents. |
| public void | didSave(DidSaveTextDocumentParams params)
The document save notification is sent from the client to the server when the document for saved in the client. |
| public default CompletableFuture | documentColor(DocumentColorParams params)
The document color request is sent from the client to the server to list all color references found in a given text document. |
| public default CompletableFuture | documentHighlight(DocumentHighlightParams params)
The document highlight request is sent from the client to the server to to resolve a document highlights for a given text document position. |
| public default CompletableFuture | documentLink(DocumentLinkParams params)
The document links request is sent from the client to the server to request the location of links in a document. |
| public default CompletableFuture | documentLinkResolve(DocumentLink params)
The document link resolve request is sent from the client to the server to resolve the target of a given document link. |
| public default CompletableFuture | documentSymbol(DocumentSymbolParams params)
The document symbol request is sent from the client to the server to list all symbols found in a given text document. |
| public default CompletableFuture | foldingRange(FoldingRangeRequestParams params)
The folding range request is sent from the client to the server to return all folding ranges found in a given text document. |
| public default CompletableFuture | formatting(DocumentFormattingParams params)
The document formatting request is sent from the client to the server to format a whole document. |
| public default CompletableFuture | hover(HoverParams params)
The hover request is sent from the client to the server to request hover information at a given text document position. |
| public default CompletableFuture | implementation(ImplementationParams params)
The goto implementation request is sent from the client to the server to resolve the implementation location of a symbol at a given text document position. |
| public default CompletableFuture | inlayHint(InlayHintParams params)
The inlay hints request is sent from the client to the server to compute inlay hints for a given [text document, range] tuple that may be rendered in the editor in place with other text. |
| public default CompletableFuture | inlineValue(InlineValueParams params)
The inline value request is sent from the client to the server to compute inline values for a given text document that may be rendered in the editor at the end of lines. |
| public default CompletableFuture | linkedEditingRange(LinkedEditingRangeParams params)
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. |
| public default CompletableFuture | moniker(MonikerParams params)
Language Server Index Format (LSIF) introduced the concept of symbol monikers to help associate symbols across different indexes. |
| public default CompletableFuture | onTypeFormatting(DocumentOnTypeFormattingParams params)
The document on type formatting request is sent from the client to the server to format parts of the document during typing. |
| public default CompletableFuture | prepareCallHierarchy(CallHierarchyPrepareParams params)
Bootstraps call hierarchy by returning the item that is denoted by the given document and position. |
| public default CompletableFuture | prepareRename(PrepareRenameParams params)
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. |
| public default CompletableFuture | prepareTypeHierarchy(TypeHierarchyPrepareParams params)
The type hierarchy request is sent from the client to the server to return a type hierarchy for the language element of given text document positions. |
| public default CompletableFuture | rangeFormatting(DocumentRangeFormattingParams params)
The document range formatting request is sent from the client to the server to format a given range in a document. |
| public default CompletableFuture | references(ReferenceParams params)
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. |
| public default CompletableFuture | rename(RenameParams params)
The rename request is sent from the client to the server to do a workspace wide rename of a symbol. |
| public default CompletableFuture | resolveCodeAction(CodeAction unresolved)
The request is sent from the client to the server to resolve additional information for a given code action. |
| public default CompletableFuture | resolveCodeLens(CodeLens unresolved)
The code lens resolve request is sent from the client to the server to resolve the command for a given code lens item. |
| public default CompletableFuture | resolveCompletionItem(CompletionItem unresolved)
The request is sent from the client to the server to resolve additional information for a given completion item. |
| public default CompletableFuture | resolveInlayHint(InlayHint unresolved)
The request is sent from the client to the server to resolve additional information for a given inlay hint. |
| public default CompletableFuture | selectionRange(SelectionRangeParams params)
The |
| public default CompletableFuture | semanticTokensFull(SemanticTokensParams params)
The |
| public default CompletableFuture | semanticTokensFullDelta(SemanticTokensDeltaParams params)
The |
| public default CompletableFuture | semanticTokensRange(SemanticTokensRangeParams params)
The |
| public default CompletableFuture | signatureHelp(SignatureHelpParams params)
The signature help request is sent from the client to the server to request signature information at a given cursor position. |
| public default CompletableFuture | typeDefinition(TypeDefinitionParams params)
The goto 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. |
| public default CompletableFuture | typeHierarchySubtypes(TypeHierarchySubtypesParams params)
The request is sent from the client to the server to resolve the subtypes for a given type hierarchy item. |
| public default CompletableFuture | typeHierarchySupertypes(TypeHierarchySupertypesParams params)
The request is sent from the client to the server to resolve the supertypes for a given type hierarchy item. |
| public default void | willSave(WillSaveTextDocumentParams params)
The document will save notification is sent from the client to the server before the document is actually saved. |
| public default CompletableFuture | willSaveWaitUntil(WillSaveTextDocumentParams params)
The document will save request is sent from the client to the server before the document is actually saved. |
| callHierarchyIncomingCalls | back to summary |
|---|---|
| public default CompletableFuture Provide all incoming calls for an item, e.g all callers for a method. In graph terms this describes directed and annotated edges inside the call graph, e.g the given item is the starting node and the result is the nodes that can be reached. Since 3.16.0
| |
| callHierarchyOutgoingCalls | back to summary |
|---|---|
| public default CompletableFuture Provide all outgoing calls for an item, e.g call calls to functions, methods, or constructors from the given item. In graph terms this describes directed and annotated edges inside the call graph, e.g the given item is the starting node and the result is the nodes that can be reached. Since 3.16.0
| |
| codeAction | back to summary |
|---|---|
| public default CompletableFuture The code action request is sent from the client to the server to compute commands for a given text document and range. These commands are typically code fixes to either fix problems or to beautify/refactor code.
Registration Options: | |
| codeLens | back to summary |
|---|---|
| public default CompletableFuture The code lens request is sent from the client to the server to compute code lenses for a given text document.
Registration Options:
| |
| colorPresentation | back to summary |
|---|---|
| public default CompletableFuture 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. Clients can use the result to
Since 3.6.0
| |
| completion | back to summary |
|---|---|
| public default CompletableFuture The Completion request is sent from the client to the server to compute completion items at a given cursor position. Completion items are presented in the IntelliSense user interface. If computing complete completion items is expensive servers can additional provide a handler for the resolve completion item request. This request is sent when a completion item is selected in the user interface.
Registration Options:
| |
| declaration | back to summary |
|---|---|
| public default CompletableFuture 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.
Registration Options: Since 3.14.0
| |
| definition | back to summary |
|---|---|
| public default CompletableFuture The goto definition request is sent from the client to the server to resolve the definition location of a symbol at a given text document position.
Registration Options:
| |
| diagnostic | back to summary |
|---|---|
| public default CompletableFuture The text document diagnostic request is sent from the client to the server to ask the server to compute the diagnostics for a given document. As with other pull requests the server is asked to compute the diagnostics for the currently synced version of the document. Since 3.17.0 | |
| didChange | back to summary |
|---|---|
| public void didChange(DidChangeTextDocumentParams params) The document change notification is sent from the client to the server to signal changes to a text document.
Registration Options:
| |
| didClose | back to summary |
|---|---|
| public void didClose(DidCloseTextDocumentParams params) The document close notification is sent from the client to the server when the document got closed in the client. The document's truth now exists where the document's uri points to (e.g. if the document's uri is a file uri the truth now exists on disk).
Registration Options:
| |
| didOpen | back to summary |
|---|---|
| public void didOpen(DidOpenTextDocumentParams params) The document open notification is sent from the client to the server to signal newly opened text documents. The document's truth is now managed by the client and the server must not try to read the document's truth using the document's uri.
Registration Options:
| |
| didSave | back to summary |
|---|---|
| public void didSave(DidSaveTextDocumentParams params) The document save notification is sent from the client to the server when the document for saved in the client.
Registration Options:
| |
| documentColor | back to summary |
|---|---|
| public default CompletableFuture The document color request is sent from the client to the server to list all color references found in a given text document. Along with the range, a color value in RGB is returned. Clients can use the result to decorate color references in an editor. For example:
Since 3.6.0
| |
| documentHighlight | back to summary |
|---|---|
| public default CompletableFuture The document highlight request is sent from the client to the server to to resolve a document highlights for a given text document position.
Registration Options:
| |
| documentLink | back to summary |
|---|---|
| public default CompletableFuture The document links request is sent from the client to the server to request the location of links in a document.
Registration Options:
| |
| documentLinkResolve | back to summary |
|---|---|
| public default CompletableFuture The document link resolve request is sent from the client to the server to resolve the target of a given document link.
| |
| documentSymbol | back to summary |
|---|---|
| public default CompletableFuture The document symbol request is sent from the client to the server to list all symbols found in a given text document.
Registration Options: Caveat although the return type allows mixing the
DocumentSymbol since it is the richer data structure.
| |
| foldingRange | back to summary |
|---|---|
| public default CompletableFuture The folding range request is sent from the client to the server to return all folding ranges found in a given text document. Since 3.10.0
| |
| formatting | back to summary |
|---|---|
| public default CompletableFuture The document formatting request is sent from the client to the server to format a whole document.
Registration Options:
| |
| hover | back to summary |
|---|---|
| public default CompletableFuture The hover request is sent from the client to the server to request hover information at a given text document position.
Registration Options:
| |
| implementation | back to summary |
|---|---|
| public default CompletableFuture The goto implementation request is sent from the client to the server to resolve the implementation location of a symbol at a given text document position.
Registration Options: Since 3.6.0
| |
| inlayHint | back to summary |
|---|---|
| public default CompletableFuture The inlay hints request is sent from the client to the server to compute inlay hints for a given [text document, range] tuple that may be rendered in the editor in place with other text. Since 3.17.0
| |
| inlineValue | back to summary |
|---|---|
| public default CompletableFuture The inline value request is sent from the client to the server to compute inline values for a given text document that may be rendered in the editor at the end of lines. Since 3.17.0 | |
| linkedEditingRange | back to summary |
|---|---|
| public default CompletableFuture 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. Optionally a word pattern can be returned to describe valid contents. A rename to one of the ranges can be applied to all other ranges if the new content is valid. If no result-specific word pattern is provided, the word pattern from the client's language configuration is used.
Registration Options: Since 3.16.0
| |
| moniker | back to summary |
|---|---|
| public default CompletableFuture Language Server Index Format (LSIF) introduced the concept of symbol monikers to help associate symbols across different indexes. This request adds capability for LSP server implementations to provide the same symbol moniker information given a text document position. Clients can utilize this method to get the moniker at the current location in a file user is editing and do further code navigation queries in other services that rely on LSIF indexes and link symbols together.
The Since 3.16.0
| |
| onTypeFormatting | back to summary |
|---|---|
| public default CompletableFuture The document on type formatting request is sent from the client to the server to format parts of the document during typing.
Registration Options:
| |
| prepareCallHierarchy | back to summary |
|---|---|
| public default CompletableFuture Bootstraps call hierarchy by returning the item that is denoted by the given document and position. This item will be used as entry into the call graph. Providers should return null when there is no item at the given location. Since 3.16.0
| |
| prepareRename | back to summary |
|---|---|
| public default CompletableFuture 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. Since 3.12.0 | |
| prepareTypeHierarchy | back to summary |
|---|---|
| public default CompletableFuture The type hierarchy request is sent from the client to the server to return a type hierarchy for
the language element of given text document positions. Will return
Since 3.17.0
| |
| rangeFormatting | back to summary |
|---|---|
| public default CompletableFuture The document range formatting request is sent from the client to the server to format a given range in a document.
Registration Options:
| |
| references | back to summary |
|---|---|
| public default CompletableFuture 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.
Registration Options:
| |
| rename | back to summary |
|---|---|
| public default CompletableFuture The rename request is sent from the client to the server to do a workspace wide rename of a symbol.
Registration Options:
| |
| resolveCodeAction | back to summary |
|---|---|
| public default CompletableFuture The request is sent from the client to the server to resolve additional information for a given code action. This is usually used to compute the `edit` property of a code action to avoid its unnecessary computation during the `textDocument/codeAction` request. Since 3.16.0
| |
| resolveCodeLens | back to summary |
|---|---|
| public default CompletableFuture The code lens resolve request is sent from the client to the server to resolve the command for a given code lens item.
| |
| resolveCompletionItem | back to summary |
|---|---|
| public default CompletableFuture The request is sent from the client to the server to resolve additional information for a given completion item.
| |
| resolveInlayHint | back to summary |
|---|---|
| public default CompletableFuture The request is sent from the client to the server to resolve additional information for a given inlay hint.
This is usually used to compute the Since 3.17.0
| |
| selectionRange | back to summary |
|---|---|
| public default CompletableFuture The Since 3.15.0
| |
| semanticTokensFull | back to summary |
|---|---|
| public default CompletableFuture The Since 3.16.0
| |
| semanticTokensFullDelta | back to summary |
|---|---|
| public default CompletableFuture The Since 3.16.0
| |
| semanticTokensRange | back to summary |
|---|---|
| public default CompletableFuture The When a user opens a file it can be beneficial to only compute the semantic tokens for the visible range (faster rendering of the tokens in the user interface). If a server can compute these tokens faster than for the whole file it can provide a handler for the textDocument/semanticTokens/range request to handle this case special. Please note that if a client also announces that it will send the textDocument/semanticTokens/range server should implement this request as well to allow for flicker free scrolling and semantic coloring of a minimap. Since 3.16.0
| |
| signatureHelp | back to summary |
|---|---|
| public default CompletableFuture The signature help request is sent from the client to the server to request signature information at a given cursor position.
Registration Options:
| |
| typeDefinition | back to summary |
|---|---|
| public default CompletableFuture The goto 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.
Registration Options: Since 3.6.0
| |
| typeHierarchySubtypes | back to summary |
|---|---|
| public default CompletableFuture The request is sent from the client to the server to resolve the subtypes for
a given type hierarchy item. Will return Since 3.17.0
| |
| typeHierarchySupertypes | back to summary |
|---|---|
| public default CompletableFuture The request is sent from the client to the server to resolve the supertypes for
a given type hierarchy item. Will return Since 3.17.0
| |
| willSave | back to summary |
|---|---|
| public default void willSave(WillSaveTextDocumentParams params) The document will save notification is sent from the client to the server before the document is actually saved.
Registration Options:
| |
| willSaveWaitUntil | back to summary |
|---|---|
| public default CompletableFuture The document will save request is sent from the client to the server before the document is actually saved. The request can return an array of TextEdits which will be applied to the text document before it is saved. Please note that clients might drop results if computing the text edits took too long or if a server constantly fails on this request. This is done to keep the save fast and reliable.
Registration Options:
| |