<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > CommentController | 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 = "../index.html" > VS Code API 中文文档< / a >
< / li >
< li >
< a href = "CommentController.html" > CommentController< / a >
< / li >
< / ul >
< h1 > Interface CommentController< / 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 > A comment controller is able to provide < a href = "CommentThread.html" > comments< / a > support to the editor and
provide users various ways to interact with comments.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > CommentController< / 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 = "CommentController.html#id" class = "tsd-kind-icon" > id< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "CommentController.html#label" class = "tsd-kind-icon" > label< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "CommentController.html#options" class = "tsd-kind-icon" > options< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "CommentController.html#commentingRangeProvider" class = "tsd-kind-icon" > commenting< wbr > Range< wbr > Provider< / a > < / li >
< / ul >
< / section >
< section class = "tsd-index-section " >
< h3 > Methods< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "CommentController.html#createCommentThread" class = "tsd-kind-icon" > create< wbr > Comment< wbr > Thread< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "CommentController.html#reactionHandler" class = "tsd-kind-icon" > reaction< wbr > Handler< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "CommentController.html#dispose" class = "tsd-kind-icon" > dispose< / 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 = "id" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > id< / h3 >
< div class = "tsd-signature tsd-kind-icon" > id< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/b01fba4/vscode.d.ts#L13547" > vscode.d.ts:13547< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The id of this comment controller.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "label" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > label< / h3 >
< div class = "tsd-signature tsd-kind-icon" > label< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/b01fba4/vscode.d.ts#L13552" > vscode.d.ts:13552< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The human-readable label of this comment controller.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "options" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options< / h3 >
< div class = "tsd-signature tsd-kind-icon" > options< span class = "tsd-signature-symbol" > :< / span > < a href = "CommentOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CommentOptions< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/b01fba4/vscode.d.ts#L13557" > vscode.d.ts:13557< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Comment controller options< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "commentingRangeProvider" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > commenting< wbr > Range< wbr > Provider< / h3 >
< div class = "tsd-signature tsd-kind-icon" > commenting< wbr > Range< wbr > Provider< span class = "tsd-signature-symbol" > :< / span > < a href = "CommentingRangeProvider.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CommentingRangeProvider< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/b01fba4/vscode.d.ts#L13564" > vscode.d.ts:13564< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Optional commenting range provider. Provide a list < a href = "../classes/Range.html" > ranges< / a > which support commenting to any given resource uri.< / p >
< / div >
< p > If not provided, users can leave comments in any document opened in the editor.< / p >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Methods< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "createCommentThread" class = "tsd-anchor" > < / a >
< h3 > create< wbr > Comment< wbr > Thread< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > create< wbr > Comment< wbr > Thread< span class = "tsd-signature-symbol" > (< / span > uri< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > , range< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > , comments< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > readonly < / span > < a href = "Comment.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Comment< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "CommentThread.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CommentThread< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/b01fba4/vscode.d.ts#L13574" > vscode.d.ts:13574< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Create a < a href = "CommentThread.html" > comment thread< / a > . The comment thread will be displayed in visible text editors (if the resource matches)
and Comments Panel once created.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > uri: < a href = "../classes/Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The uri of the document the thread has been created on.< / p >
< / div >
< / li >
< li >
< h5 > range: < a href = "../classes/Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The range the comment thread is located within the document.< / p >
< / div >
< / li >
< li >
< h5 > comments: < span class = "tsd-signature-symbol" > readonly < / span > < a href = "Comment.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Comment< / a > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The ordered comments of the thread.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "CommentThread.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CommentThread< / a > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "reactionHandler" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > reaction< wbr > Handler< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > reaction< wbr > Handler< span class = "tsd-signature-symbol" > (< / span > comment< span class = "tsd-signature-symbol" > : < / span > < a href = "Comment.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Comment< / a > , reaction< span class = "tsd-signature-symbol" > : < / span > < a href = "CommentReaction.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CommentReaction< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/b01fba4/vscode.d.ts#L13579" > vscode.d.ts:13579< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Optional reaction handler for creating and deleting reactions on a < a href = "../enums/FoldingRangeKind.html#Comment" > Comment< / a > .< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > comment: < a href = "Comment.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Comment< / a > < / h5 >
< / li >
< li >
< h5 > reaction: < a href = "CommentReaction.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CommentReaction< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "dispose" class = "tsd-anchor" > < / a >
< h3 > dispose< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > dispose< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/b01fba4/vscode.d.ts#L13587" > vscode.d.ts:13587< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Dispose this comment controller.< / p >
< / div >
< p > Once disposed, all < a href = "CommentThread.html" > comment threads< / a > created by this comment controller will also be removed from the editor
and Comments Panel.< / p >
< / div >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / section >
< / section >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../index.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 = "CommentController.html" class = "tsd-kind-icon" > Comment< wbr > Controller< / a >
< ul >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "CommentController.html#id" class = "tsd-kind-icon" > id< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "CommentController.html#label" class = "tsd-kind-icon" > label< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "CommentController.html#options" class = "tsd-kind-icon" > options< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "CommentController.html#commentingRangeProvider" class = "tsd-kind-icon" > commenting< wbr > Range< wbr > Provider< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "CommentController.html#createCommentThread" class = "tsd-kind-icon" > create< wbr > Comment< wbr > Thread< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "CommentController.html#reactionHandler" class = "tsd-kind-icon" > reaction< wbr > Handler< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "CommentController.html#dispose" class = "tsd-kind-icon" > dispose< / 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 >
