public interface LanguageClient
Modifier and Type | Method and Description |
---|---|
default java.util.concurrent.CompletableFuture<ApplyWorkspaceEditResponse> |
applyEdit(ApplyWorkspaceEditParams params)
The workspace/applyEdit request is sent from the server to the client to modify resource on the client side.
|
default java.util.concurrent.CompletableFuture<java.util.List<java.lang.Object>> |
configuration(ConfigurationParams configurationParams)
The workspace/configuration request is sent from the server to the client to fetch
configuration settings from the client.
|
default java.util.concurrent.CompletableFuture<java.lang.Void> |
createProgress(WorkDoneProgressCreateParams params)
This request is sent from the server to the client to ask the client to create a work done progress.
|
void |
logMessage(MessageParams message)
The log message notification is send from the server to the client to ask
the client to log a particular message.
|
default void |
notifyProgress(ProgressParams params)
The base protocol offers also support to report progress in a generic fashion.
|
void |
publishDiagnostics(PublishDiagnosticsParams diagnostics)
Diagnostics notifications are sent from the server to the client to
signal results of validation runs.
|
default java.util.concurrent.CompletableFuture<java.lang.Void> |
registerCapability(RegistrationParams params)
The client/registerCapability request is sent from the server to the client
to register for a new capability on the client side.
|
default void |
semanticHighlighting(SemanticHighlightingParams params)
Deprecated.
Use
SemanticTokens API instead. |
void |
showMessage(MessageParams 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 interface.
|
java.util.concurrent.CompletableFuture<MessageActionItem> |
showMessageRequest(ShowMessageRequestParams requestParams)
The show message request is sent from a server to a client to ask the
client to display a particular message in the user interface.
|
void |
telemetryEvent(java.lang.Object object)
The telemetry notification is sent from the server to the client to ask
the client to log a telemetry event.
|
default java.util.concurrent.CompletableFuture<java.lang.Void> |
unregisterCapability(UnregistrationParams params)
The client/unregisterCapability request is sent from the server to the client
to unregister a previously register capability.
|
default java.util.concurrent.CompletableFuture<java.util.List<WorkspaceFolder>> |
workspaceFolders()
The workspace/workspaceFolders request is sent from the server to the client
to fetch the current open list of workspace folders.
|
default java.util.concurrent.CompletableFuture<ApplyWorkspaceEditResponse> applyEdit(ApplyWorkspaceEditParams params)
default java.util.concurrent.CompletableFuture<java.lang.Void> registerCapability(RegistrationParams params)
default java.util.concurrent.CompletableFuture<java.lang.Void> unregisterCapability(UnregistrationParams params)
void telemetryEvent(java.lang.Object object)
void publishDiagnostics(PublishDiagnosticsParams diagnostics)
void showMessage(MessageParams messageParams)
java.util.concurrent.CompletableFuture<MessageActionItem> showMessageRequest(ShowMessageRequestParams requestParams)
void logMessage(MessageParams message)
default java.util.concurrent.CompletableFuture<java.util.List<WorkspaceFolder>> workspaceFolders()
default java.util.concurrent.CompletableFuture<java.util.List<java.lang.Object>> configuration(ConfigurationParams configurationParams)
@Beta @Deprecated default void semanticHighlighting(SemanticHighlightingParams params)
SemanticTokens
API instead.textDocument/semanticHighlighting
notification is pushed from the server to the client
to inform the client about additional semantic highlighting information that has to be applied
on the text document. It is the server's responsibility to decide which lines are included in
the highlighting information. In other words, the server is capable of sending only a delta
information. For instance, after opening the text document (DidOpenTextDocumentNotification
)
the server sends the semantic highlighting information for the entire document, but if the server
receives a DidChangeTextDocumentNotification
, it pushes the information only about
the affected lines in the document.
Note: the textDocument/semanticHighlighting
language feature is not yet part of the official LSP specification.
default java.util.concurrent.CompletableFuture<java.lang.Void> createProgress(WorkDoneProgressCreateParams params)
default void notifyProgress(ProgressParams params)