<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > CodeActionProviderMetadata | VS Code API 中文文档< / title >
< meta name = "description" content = "Documentation for VS Code API 中文文档" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.json" data-base = ".." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
< a href = "../index.html" class = "title" > VS Code API 中文文档< / a >
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< input type = "checkbox" id = "tsd-filter-externals" checked / >
< label class = "tsd-widget" for = "tsd-filter-externals" > Externals< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
< a href = "../modules.html" > VS Code API 中文文档< / a >
< / li >
< li >
< a href = "CodeActionProviderMetadata.html" > CodeActionProviderMetadata< / a >
< / li >
< / ul >
< h1 > Interface CodeActionProviderMetadata< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< section class = "tsd-panel tsd-comment" >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Metadata about the type of code actions that a < a href = "CodeActionProvider.html" > CodeActionProvider< / a > provides.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > CodeActionProviderMetadata< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > 索引< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Properties< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "CodeActionProviderMetadata.html#providedCodeActionKinds" class = "tsd-kind-icon" > provided< wbr > Code< wbr > Action< wbr > Kinds< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "CodeActionProviderMetadata.html#documentation" class = "tsd-kind-icon" > documentation< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Properties< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "providedCodeActionKinds" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > provided< wbr > Code< wbr > Action< wbr > Kinds< / h3 >
< div class = "tsd-signature tsd-kind-icon" > provided< wbr > Code< wbr > Action< wbr > Kinds< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > readonly < / span > < a href = "../classes/CodeActionKind.html" class = "tsd-signature-type" data-tsd-kind = "Class" > CodeActionKind< / a > < span class = "tsd-signature-symbol" > []< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/39c3361/vscode.d.ts#L2365" > vscode.d.ts:2365< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > List of < a href = "../classes/CodeActionKind.html" > CodeActionKinds< / a > that a < a href = "CodeActionProvider.html" > CodeActionProvider< / a > may return.< / p >
< / div >
< p > This list is used to determine if a given < code > CodeActionProvider< / code > should be invoked or not.
To avoid unnecessary computation, every < code > CodeActionProvider< / code > should list use < code > providedCodeActionKinds< / code > . The
list of kinds may either be generic, such as < code > [CodeActionKind.Refactor]< / code > , or list out every kind provided,
such as < code > [CodeActionKind.Refactor.Extract.append(' function' ), CodeActionKind.Refactor.Extract.append(' constant' ), ...]< / code > .< / p >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "documentation" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > documentation< / h3 >
< div class = "tsd-signature tsd-kind-icon" > documentation< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > readonly < / span > < span class = "tsd-signature-symbol" > { < / span > kind< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/CodeActionKind.html" class = "tsd-signature-type" data-tsd-kind = "Class" > CodeActionKind< / a > < span class = "tsd-signature-symbol" > ; < / span > command< span class = "tsd-signature-symbol" > : < / span > < a href = "Command.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Command< / a > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > []< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/39c3361/vscode.d.ts#L2381" > vscode.d.ts:2381< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Static documentation for a class of code actions.< / p >
< / div >
< p > Documentation from the provider is shown in the code actions menu if either:< / p >
< ul >
< li > < p > Code actions of < code > kind< / code > are requested by the editor. In this case, the editor will show the documentation that
most closely matches the requested code action kind. For example, if a provider has documentation for
both < code > Refactor< / code > and < code > RefactorExtract< / code > , when the user requests code actions for < code > RefactorExtract< / code > ,
the editor will use the documentation for < code > RefactorExtract< / code > instead of the documentation for < code > Refactor< / code > .< / p >
< / li >
< li > < p > Any code actions of < code > kind< / code > are returned by the provider.< / p >
< / li >
< / ul >
< p > At most one documentation entry will be shown per provider.< / p >
< / div >
< / section >
< / section >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../modules.html" > Exports< / a >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-interface" >
< a href = "CodeActionProviderMetadata.html" class = "tsd-kind-icon" > Code< wbr > Action< wbr > Provider< wbr > Metadata< / a >
< ul >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "CodeActionProviderMetadata.html#providedCodeActionKinds" class = "tsd-kind-icon" > provided< wbr > Code< wbr > Action< wbr > Kinds< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "CodeActionProviderMetadata.html#documentation" class = "tsd-kind-icon" > documentation< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > 图例< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > Generated by < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >
