nvim_runtime_lua

vim.lsp.protocol.Methods

Generated by gen_lsp.lua, keep at end of file.

See:

https://microsoft.github.io/language-server-protocol/specification/#metaModel

Fields95

Methods.callHierarchy_incomingCalls: string = "callHierarchy/incomingCalls"

A request to resolve the incoming calls for a given CallHierarchyItem.

@since 3.16.0

Methods.callHierarchy_outgoingCalls: string = "callHierarchy/outgoingCalls"

A request to resolve the outgoing calls for a given CallHierarchyItem.

@since 3.16.0

Methods.client_registerCapability: string = "client/registerCapability"

The client/registerCapability request is sent from the server to the client to register a new capability handler on the client side.

Methods.client_unregisterCapability: string = "client/unregisterCapability"

The client/unregisterCapability request is sent from the server to the client to unregister a previously registered capability handler on the client side.

Methods.codeAction_resolve: string = "codeAction/resolve"

Request to resolve additional information for a given code action.The request's parameter is of type {@link CodeAction} the response is of type {@link CodeAction} or a Thenable that resolves to such.

Methods.codeLens_resolve: string = "codeLens/resolve"

A request to resolve a command for a given code lens.

Methods.completionItem_resolve: string = "completionItem/resolve"

Request to resolve additional information for a given completion item.The request's parameter is of type {@link CompletionItem} the response is of type {@link CompletionItem} or a Thenable that resolves to such.

Methods.dollar_cancelRequest: string = "$/cancelRequest"
Methods.dollar_logTrace: string = "$/logTrace"
Methods.dollar_progress: string = "$/progress"
Methods.dollar_setTrace: string = "$/setTrace"
Methods.exit: string = "exit"

The exit event is sent from the client to the server to ask the server to exit its process.

Methods.initialize: string = "initialize"

The initialize request is sent from the client to the server. It is sent once as the request after starting up the server. The requests parameter is of type {@link InitializeParams} the response if of type {@link InitializeResult} of a Thenable that resolves to such.

Methods.initialized: string = "initialized"

The initialized notification is sent from the client to the server after the client is fully initialized and the server is allowed to send requests from the server to the client.

Methods.inlayHint_resolve: string = "inlayHint/resolve"

A request to resolve additional properties for an inlay hint. The request's parameter is of type {@link InlayHint}, the response is of type {@link InlayHint} or a Thenable that resolves to such.

@since 3.17.0

Methods.notebookDocument_didChange: string = "notebookDocument/didChange"
Methods.notebookDocument_didClose: string = "notebookDocument/didClose"

A notification sent when a notebook closes.

@since 3.17.0

Methods.notebookDocument_didOpen: string = "notebookDocument/didOpen"

A notification sent when a notebook opens.

@since 3.17.0

Methods.notebookDocument_didSave: string = "notebookDocument/didSave"

A notification sent when a notebook document is saved.

@since 3.17.0

Methods.shutdown: string = "shutdown"

A shutdown request is sent from the client to the server. It is sent once when the client decides to shutdown the server. The only notification that is sent after a shutdown request is the exit event.

Methods.telemetry_event: string = "telemetry/event"

The telemetry event notification is sent from the server to the client to ask the client to log telemetry data.

Methods.textDocument_codeAction: string = "textDocument/codeAction"

A request to provide commands for the given text document and range.

Methods.textDocument_codeLens: string = "textDocument/codeLens"

A request to provide code lens for the given text document.

Methods.textDocument_colorPresentation: string = "textDocument/colorPresentation"

A request to list all presentation for a color. The request's parameter is of type {@link ColorPresentationParams} the response is of type {@link ColorPresentation ColorPresentation[]} or a Thenable that resolves to such.

Methods.textDocument_completion: string = "textDocument/completion"

Request to request completion at a given text document position. The request's parameter is of type {@link TextDocumentPosition} the response is of type {@link CompletionItem CompletionItem[]} or {@link CompletionList} or a Thenable that resolves to such. The request can delay the computation of the {@link CompletionItem.detail detail} and {@link CompletionItem.documentation documentation} properties to the completionItem/resolve request. However, properties that are needed for the initial sorting and filtering, like sortText, filterText, insertText, and textEdit, must not be changed during resolve.

Methods.textDocument_declaration: string = "textDocument/declaration"

A request to resolve the type definition locations of a symbol at a given text document position. The request's parameter is of type {@link TextDocumentPositionParams} the response is of type {@link Declaration} or a typed array of {@link DeclarationLink} or a Thenable that resolves to such.

Methods.textDocument_definition: string = "textDocument/definition"

A request to resolve the definition location of a symbol at a given text document position. The request's parameter is of type {@link TextDocumentPosition} the response is of either type {@link Definition} or a typed array of {@link DefinitionLink} or a Thenable that resolves to such.

Methods.textDocument_diagnostic: string = "textDocument/diagnostic"

The document diagnostic request definition.

@since 3.17.0

Methods.textDocument_didChange: string = "textDocument/didChange"

The document change notification is sent from the client to the server to signal changes to a text document.

Methods.textDocument_didClose: string = "textDocument/didClose"

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). As with the open notification the close notification is about managing the document's content. Receiving a close notification doesn't mean that the document was open in an editor before. A close notification requires a previous open notification to be sent.

Methods.textDocument_didOpen: string = "textDocument/didOpen"

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. Open in this sense means it is managed by the client. It doesn't necessarily mean that its content is presented in an editor. An open notification must not be sent more than once without a corresponding close notification send before. This means open and close notification must be balanced and the max open count is one.

Methods.textDocument_didSave: string = "textDocument/didSave"

The document save notification is sent from the client to the server when the document got saved in the client.

Methods.textDocument_documentColor: string = "textDocument/documentColor"

A request to list all color symbols found in a given text document. The request's parameter is of type {@link DocumentColorParams} the response is of type {@link ColorInformation ColorInformation[]} or a Thenable that resolves to such.

Methods.textDocument_documentHighlight: string = "textDocument/documentHighlight"

Request to resolve a {@link DocumentHighlight} for a given text document position. The request's parameter is of type {@link TextDocumentPosition} the request response is an array of type {@link DocumentHighlight} or a Thenable that resolves to such.

Methods.textDocument_documentSymbol: string = "textDocument/documentSymbol"

A request to list all symbols found in a given text document. The request's parameter is of type {@link TextDocumentIdentifier} the response is of type {@link SymbolInformation SymbolInformation[]} or a Thenable that resolves to such.

Methods.textDocument_foldingRange: string = "textDocument/foldingRange"

A request to provide folding ranges in a document. The request's parameter is of type {@link FoldingRangeParams}, the response is of type {@link FoldingRangeList} or a Thenable that resolves to such.

Methods.textDocument_formatting: string = "textDocument/formatting"

A request to format a whole document.

Methods.textDocument_hover: string = "textDocument/hover"

Request to request hover information at a given text document position. The request's parameter is of type {@link TextDocumentPosition} the response is of type {@link Hover} or a Thenable that resolves to such.

Methods.textDocument_implementation: string = "textDocument/implementation"

A request to resolve the implementation locations of a symbol at a given text document position. The request's parameter is of type {@link TextDocumentPositionParams} the response is of type {@link Definition} or a Thenable that resolves to such.

Methods.textDocument_inlayHint: string = "textDocument/inlayHint"

A request to provide inlay hints in a document. The request's parameter is of type {@link InlayHintsParams}, the response is of type {@link InlayHint InlayHint[]} or a Thenable that resolves to such.

@since 3.17.0

Methods.textDocument_inlineCompletion: string = "textDocument/inlineCompletion"

A request to provide inline completions in a document. The request's parameter is of type {@link InlineCompletionParams}, the response is of type {@link InlineCompletion InlineCompletion[]} or a Thenable that resolves to such.

@since 3.18.0

Methods.textDocument_inlineValue: string = "textDocument/inlineValue"

A request to provide inline values in a document. The request's parameter is of type {@link InlineValueParams}, the response is of type {@link InlineValue InlineValue[]} or a Thenable that resolves to such.

@since 3.17.0

Methods.textDocument_linkedEditingRange: string = "textDocument/linkedEditingRange"

A request to provide ranges that can be edited together.

@since 3.16.0

Methods.textDocument_moniker: string = "textDocument/moniker"

A request to get the moniker of a symbol at a given text document position. The request parameter is of type {@link TextDocumentPositionParams}. The response is of type {@link Moniker Moniker[]} or null.

Methods.textDocument_onTypeFormatting: string = "textDocument/onTypeFormatting"

A request to format a document on type.

Methods.textDocument_prepareCallHierarchy: string = "textDocument/prepareCallHierarchy"

A request to result a CallHierarchyItem in a document at a given position. Can be used as an input to an incoming or outgoing call hierarchy.

@since 3.16.0

Methods.textDocument_prepareRename: string = "textDocument/prepareRename"

A request to test and perform the setup necessary for a rename.

@since 3.16 - support for default behavior

Methods.textDocument_prepareTypeHierarchy: string = "textDocument/prepareTypeHierarchy"

A request to result a TypeHierarchyItem in a document at a given position. Can be used as an input to a subtypes or supertypes type hierarchy.

@since 3.17.0

Methods.textDocument_publishDiagnostics: string = "textDocument/publishDiagnostics"

Diagnostics notification are sent from the server to the client to signal results of validation runs.

Methods.textDocument_rangeFormatting: string = "textDocument/rangeFormatting"

A request to format a range in a document.

Methods.textDocument_rangesFormatting: string = "textDocument/rangesFormatting"

A request to format ranges in a document.

@since 3.18.0

Methods.textDocument_references: string = "textDocument/references"

A request to resolve project-wide references for the symbol denoted by the given text document position. The request's parameter is of type {@link ReferenceParams} the response is of type {@link Location Location[]} or a Thenable that resolves to such.

Methods.textDocument_rename: string = "textDocument/rename"

A request to rename a symbol.

Methods.textDocument_selectionRange: string = "textDocument/selectionRange"

A request to provide selection ranges in a document. The request's parameter is of type {@link SelectionRangeParams}, the response is of type {@link SelectionRange SelectionRange[]} or a Thenable that resolves to such.

Methods.textDocument_semanticTokens_full: string = "textDocument/semanticTokens/full"

@since 3.16.0

Methods.textDocument_semanticTokens_full_delta: string = "textDocument/semanticTokens/full/delta"

@since 3.16.0

Methods.textDocument_semanticTokens_range: string = "textDocument/semanticTokens/range"

@since 3.16.0

Methods.textDocument_signatureHelp: string = "textDocument/signatureHelp"
Methods.textDocument_typeDefinition: string = "textDocument/typeDefinition"

A request to resolve the type definition locations of a symbol at a given text document position. The request's parameter is of type {@link TextDocumentPositionParams} the response is of type {@link Definition} or a Thenable that resolves to such.

Methods.textDocument_willSave: string = "textDocument/willSave"

A document will save notification is sent from the client to the server before the document is actually saved.

Methods.textDocument_willSaveWaitUntil: string = "textDocument/willSaveWaitUntil"

A 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.

Methods.typeHierarchy_subtypes: string = "typeHierarchy/subtypes"

A request to resolve the subtypes for a given TypeHierarchyItem.

@since 3.17.0

Methods.typeHierarchy_supertypes: string = "typeHierarchy/supertypes"

A request to resolve the supertypes for a given TypeHierarchyItem.

@since 3.17.0

Methods.window_logMessage: string = "window/logMessage"

The log message notification is sent from the server to the client to ask the client to log a particular message.

Methods.window_showDocument: string = "window/showDocument"

A request to show a document. This request might open an external program depending on the value of the URI to open. For example a request to open https://code.visualstudio.com/ will very likely open the URI in a WEB browser.

@since 3.16.0

Methods.window_showMessage: string = "window/showMessage"

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.

Methods.window_showMessageRequest: string = "window/showMessageRequest"

The show message request is sent from the server to the client to show a message and a set of options actions to the user.

Methods.window_workDoneProgress_cancel: string = "window/workDoneProgress/cancel"

The window/workDoneProgress/cancel notification is sent from the client to the server to cancel a progress initiated on the server side.

Methods.window_workDoneProgress_create: string = "window/workDoneProgress/create"

The window/workDoneProgress/create request is sent from the server to the client to initiate progress reporting from the server.

Methods.workspaceSymbol_resolve: string = "workspaceSymbol/resolve"

A request to resolve the range inside the workspace symbol's location.

@since 3.17.0

Methods.workspace_applyEdit: string = "workspace/applyEdit"

A request sent from the server to the client to modified certain resources.

Methods.workspace_codeLens_refresh: string = "workspace/codeLens/refresh"

A request to refresh all code actions

@since 3.16.0

Methods.workspace_configuration: string = "workspace/configuration"

The 'workspace/configuration' request is sent from the server to the client to fetch a certain configuration setting. This pull model replaces the old push model were the client signaled configuration change via an event. If the server still needs to react to configuration changes (since the server caches the result of workspace/configuration requests) the server should register for an empty configuration change event and empty the cache if such an event is received.

Methods.workspace_diagnostic: string = "workspace/diagnostic"

The workspace diagnostic request definition.

@since 3.17.0

Methods.workspace_diagnostic_refresh: string = "workspace/diagnostic/refresh"

The diagnostic refresh request definition.

@since 3.17.0

Methods.workspace_didChangeConfiguration: string = "workspace/didChangeConfiguration"

The configuration change notification is sent from the client to the server when the client's configuration has changed. The notification contains the changed configuration as defined by the language client.

Methods.workspace_didChangeWatchedFiles: string = "workspace/didChangeWatchedFiles"

The watched files notification is sent from the client to the server when the client detects changes to file watched by the language client.

Methods.workspace_didChangeWorkspaceFolders: string = "workspace/didChangeWorkspaceFolders"

The workspace/didChangeWorkspaceFolders notification is sent from the client to the server when the workspace folder configuration changes.

Methods.workspace_didCreateFiles: string = "workspace/didCreateFiles"

The did create files notification is sent from the client to the server when files were created from within the client.

@since 3.16.0

Methods.workspace_didDeleteFiles: string = "workspace/didDeleteFiles"

The will delete files request is sent from the client to the server before files are actually deleted as long as the deletion is triggered from within the client.

@since 3.16.0

Methods.workspace_didRenameFiles: string = "workspace/didRenameFiles"

The did rename files notification is sent from the client to the server when files were renamed from within the client.

@since 3.16.0

Methods.workspace_executeCommand: string = "workspace/executeCommand"

A request send from the client to the server to execute a command. The request might return a workspace edit which the client will apply to the workspace.

Methods.workspace_foldingRange_refresh: string = "workspace/foldingRange/refresh"

A request to refresh the folding ranges in a document.

@since 3.18.0

Methods.workspace_inlayHint_refresh: string = "workspace/inlayHint/refresh"

@since 3.17.0

Methods.workspace_inlineValue_refresh: string = "workspace/inlineValue/refresh"

@since 3.17.0

Methods.workspace_semanticTokens_refresh: string = "workspace/semanticTokens/refresh"

@since 3.16.0

Methods.workspace_symbol: string = "workspace/symbol"

A request to list project-wide symbols matching the query string given by the {@link WorkspaceSymbolParams}. The response is of type {@link SymbolInformation SymbolInformation[]} or a Thenable that resolves to such.

@since 3.17.0 - support for WorkspaceSymbol in the returned data. Clients need to advertise support for WorkspaceSymbols via the client capability workspace.symbol.resolveSupport.

Methods.workspace_textDocumentContent: string = "workspace/textDocumentContent"

The workspace/textDocumentContent request is sent from the client to the server to request the content of a text document.

@since 3.18.0

Methods.workspace_textDocumentContent_refresh: string = "workspace/textDocumentContent/refresh"

The workspace/textDocumentContent request is sent from the server to the client to refresh the content of a specific text document.

@since 3.18.0

Methods.workspace_willCreateFiles: string = "workspace/willCreateFiles"

The will create files request is sent from the client to the server before files are actually created as long as the creation is triggered from within the client. The request can return a WorkspaceEdit which will be applied to workspace before the files are created. Hence the WorkspaceEdit can not manipulate the content of the file to be created.

@since 3.16.0

Methods.workspace_willDeleteFiles: string = "workspace/willDeleteFiles"

The did delete files notification is sent from the client to the server when files were deleted from within the client.

@since 3.16.0

Methods.workspace_willRenameFiles: string = "workspace/willRenameFiles"

The will rename files request is sent from the client to the server before files are actually renamed as long as the rename is triggered from within the client.

@since 3.16.0

Methods.workspace_workspaceFolders: string = "workspace/workspaceFolders"

The workspace/workspaceFolders is sent from the server to the client to fetch the open workspace folders.