LanguageClient (org.eclipse.lsp4j 0.20.0 API)

All Known Subinterfaces:

LanguageClientExtensions
```
public interface LanguageClient
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
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`	`logTrace(LogTraceParams params)` A notification to log the trace of the server's execution.
`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>`	`refreshCodeLenses()` The `workspace/codeLens/refresh` request is sent from the server to the client.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`refreshDiagnostics()` The `workspace/diagnostic/refresh` request is sent from the server to the client.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`refreshInlayHints()` The `workspace/inlayHint/refresh` request is sent from the server to the client.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`refreshInlineValues()` The `workspace/inlineValue/refresh` request is sent from the server to the client.
`default java.util.concurrent.CompletableFuture<java.lang.Void>`	`refreshSemanticTokens()` The `workspace/semanticTokens/refresh` request is sent from the server to the client.
`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 java.util.concurrent.CompletableFuture<ShowDocumentResult>`	`showDocument(ShowDocumentParams params)` The show document request is sent from a server to a client to ask the client to display a particular document in the user interface.
`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.

- Method Detail
  - applyEdit
```
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.
  - registerCapability
```
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. Not all clients need to support dynamic capability registration. A client opts in via the ClientCapabilities.dynamicRegistration property
  - unregisterCapability
```
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.
  - telemetryEvent
```
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.
  - publishDiagnostics
```
void publishDiagnostics(PublishDiagnosticsParams diagnostics)
```
    Diagnostics notifications are sent from the server to the client to signal results of validation runs.
  - showMessage
```
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.
  - showMessageRequest
```
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. In addition to the show message notification the request allows to pass actions and to wait for an answer from the client.
  - showDocument
```
default java.util.concurrent.CompletableFuture<ShowDocumentResult> showDocument(ShowDocumentParams params)
```
    The show document request is sent from a server to a client to ask the client to display a particular document in the user interface.
    Since 3.16.0
  - logMessage
```
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.
  - workspaceFolders
```
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.
    Since 3.6.0
    
    Returns:
    
    null in the response if only a single file is open in the tool, an empty array if a workspace is open but no folders are configured, the workspace folders otherwise.
  - configuration
```
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. The request can fetch several configuration settings in one roundtrip. The order of the returned configuration settings correspond to the order of the passed ConfigurationItems (e.g. the first item in the response is the result for the first configuration item in the params).
    Since 3.6.0
  - createProgress
```
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.
    Since 3.15.0
  - notifyProgress
```
default void notifyProgress(ProgressParams params)
```
    The base protocol offers also support to report progress in a generic fashion. This mechanism can be used to report any kind of progress including work done progress (usually used to report progress in the user interface using a progress bar) and partial result progress to support streaming of results.
    Since 3.15.0
  - logTrace
```
default void logTrace(LogTraceParams params)
```
    A notification to log the trace of the server's execution. The amount and content of these notifications depends on the current trace configuration. If trace is 'off', the server should not send any logTrace notification. If trace is 'message', the server should not add the 'verbose' field in the LogTraceParams.
    $/logTrace should be used for systematic trace reporting. For single debugging messages, the server should send window/logMessage notifications.
    Since 3.16.0
  - refreshSemanticTokens
```
default java.util.concurrent.CompletableFuture<java.lang.Void> refreshSemanticTokens()
```
    The workspace/semanticTokens/refresh request is sent from the server to the client. Servers can use it to ask clients to refresh the editors for which this server provides semantic tokens. As a result the client should ask the server to recompute the semantic tokens for these editors. This is useful if a server detects a project wide configuration change which requires a re-calculation of all semantic tokens. Note that the client still has the freedom to delay the re-calculation of the semantic tokens if for example an editor is currently not visible.
    Since 3.16.0
  - refreshCodeLenses
```
default java.util.concurrent.CompletableFuture<java.lang.Void> refreshCodeLenses()
```
    The workspace/codeLens/refresh request is sent from the server to the client. Servers can use it to ask clients to refresh the code lenses currently shown in editors. As a result the client should ask the server to recompute the code lenses for these editors. This is useful if a server detects a configuration change which requires a re-calculation of all code lenses. Note that the client still has the freedom to delay the re-calculation of the code lenses if for example an editor is currently not visible.
    Since 3.16.0
  - refreshInlayHints
```
default java.util.concurrent.CompletableFuture<java.lang.Void> refreshInlayHints()
```
    The workspace/inlayHint/refresh request is sent from the server to the client. Servers can use it to ask clients to refresh the inlay hints currently shown in editors. As a result the client should ask the server to recompute the inlay hints for these editors. This is useful if a server detects a configuration change which requires a re-calculation of all inlay hints. Note that the client still has the freedom to delay the re-calculation of the inlay hints if for example an editor is currently not visible.
    Since 3.17.0
  - refreshInlineValues
```
default java.util.concurrent.CompletableFuture<java.lang.Void> refreshInlineValues()
```
    The workspace/inlineValue/refresh request is sent from the server to the client. Servers can use it to ask clients to refresh the inline values currently shown in editors. As a result the client should ask the server to recompute the inline values for these editors. This is useful if a server detects a configuration change which requires a re-calculation of all inline values. Note that the client still has the freedom to delay the re-calculation of the inline values if for example an editor is currently not visible.
    Since 3.17.0
  - refreshDiagnostics
```
default java.util.concurrent.CompletableFuture<java.lang.Void> refreshDiagnostics()
```
    The workspace/diagnostic/refresh request is sent from the server to the client. Servers can use it to ask clients to refresh all needed document and workspace diagnostics. This is useful if a server detects a project wide configuration change which requires a re-calculation of all diagnostics.
    Since 3.17.0

Interface LanguageClient

Method Summary

Method Detail

applyEdit

registerCapability

unregisterCapability

telemetryEvent

publishDiagnostics

showMessage

showMessageRequest

showDocument

logMessage

workspaceFolders

configuration

createProgress

notifyProgress

logTrace

refreshSemanticTokens

refreshCodeLenses

refreshInlayHints

refreshInlineValues

refreshDiagnostics