dots.vscode.comment-thread
A collection of {@link Comment comments} representing a conversation at a particular range in a document.
A collection of {@link Comment comments} representing a conversation at a particular range in a document.
can-reply?cljs
(can-reply? comment-thread)Whether the thread supports reply. Defaults to true.
Returns: boolean
Whether the thread supports reply. Defaults to true. **Returns:** `boolean`
collapsible-statecljs
(collapsible-state comment-thread)Whether the thread should be collapsed or expanded when opening the document. Defaults to Collapsed.
Returns: CommentThreadCollapsibleState
Whether the thread should be collapsed or expanded when opening the document. Defaults to Collapsed. **Returns:** `CommentThreadCollapsibleState`
commentscljs
(comments comment-thread)The ordered comments of the thread.
Returns: readonly Comment[]
The ordered comments of the thread. **Returns:** `readonly Comment[]`
context-valuecljs
(context-value comment-thread)Context value of the comment thread. This can be used to contribute thread specific actions.
For example, a comment thread is given a context value as editable. When contributing actions to comments/commentThread/title
using menus extension point, you can specify context value for key commentThread in when expression like commentThread == editable.
"contributes": {
"menus": {
"comments/commentThread/title": [
{
"command": "extension.deleteCommentThread",
"when": "commentThread == editable"
}
]
}
}
This will show action extension.deleteCommentThread only for comment threads with contextValue is editable.
Returns: string | undefined
Context value of the comment thread. This can be used to contribute thread specific actions.
For example, a comment thread is given a context value as `editable`. When contributing actions to `comments/commentThread/title`
using `menus` extension point, you can specify context value for key `commentThread` in `when` expression like `commentThread == editable`.
```json
"contributes": {
"menus": {
"comments/commentThread/title": [
{
"command": "extension.deleteCommentThread",
"when": "commentThread == editable"
}
]
}
}
```
This will show action `extension.deleteCommentThread` only for comment threads with `contextValue` is `editable`.
**Returns:** `string | undefined`disposecljs
(dispose comment-thread)Dispose this comment thread.
Once disposed, this comment thread will be removed from visible editors and Comment Panel when appropriate.
Returns: void
Dispose this comment thread. Once disposed, this comment thread will be removed from visible editors and Comment Panel when appropriate. **Returns:** `void`
labelcljs
(label comment-thread)The optional human-readable label describing the {@link CommentThread Comment Thread}
Returns: string | undefined
The optional human-readable label describing the {@link CommentThread Comment Thread}
**Returns:** `string | undefined`rangecljs
(range comment-thread)The range the comment thread is located within the document. The thread icon will be shown at the last line of the range.
Returns: Range
The range the comment thread is located within the document. The thread icon will be shown at the last line of the range. **Returns:** `Range`
set-can-reply!cljs
(set-can-reply! comment-thread value)Whether the thread supports reply. Defaults to true.
Whether the thread supports reply. Defaults to true.
set-collapsible-state!cljs
(set-collapsible-state! comment-thread value)Whether the thread should be collapsed or expanded when opening the document. Defaults to Collapsed.
Whether the thread should be collapsed or expanded when opening the document. Defaults to Collapsed.
set-comments!cljs
(set-comments! comment-thread value)The ordered comments of the thread.
The ordered comments of the thread.
set-context-value!cljs
(set-context-value! comment-thread value)Context value of the comment thread. This can be used to contribute thread specific actions.
For example, a comment thread is given a context value as editable. When contributing actions to comments/commentThread/title
using menus extension point, you can specify context value for key commentThread in when expression like commentThread == editable.
"contributes": {
"menus": {
"comments/commentThread/title": [
{
"command": "extension.deleteCommentThread",
"when": "commentThread == editable"
}
]
}
}
This will show action extension.deleteCommentThread only for comment threads with contextValue is editable.
Context value of the comment thread. This can be used to contribute thread specific actions.
For example, a comment thread is given a context value as `editable`. When contributing actions to `comments/commentThread/title`
using `menus` extension point, you can specify context value for key `commentThread` in `when` expression like `commentThread == editable`.
```json
"contributes": {
"menus": {
"comments/commentThread/title": [
{
"command": "extension.deleteCommentThread",
"when": "commentThread == editable"
}
]
}
}
```
This will show action `extension.deleteCommentThread` only for comment threads with `contextValue` is `editable`.set-label!cljs
(set-label! comment-thread value)The optional human-readable label describing the {@link CommentThread Comment Thread}
The optional human-readable label describing the {@link CommentThread Comment Thread}
set-range!cljs
(set-range! comment-thread value)The range the comment thread is located within the document. The thread icon will be shown at the last line of the range.
The range the comment thread is located within the document. The thread icon will be shown at the last line of the range.
set-state!cljs
(set-state! comment-thread value)The optional state of a comment thread, which may affect how the comment is displayed.
The optional state of a comment thread, which may affect how the comment is displayed.
statecljs
(state comment-thread)The optional state of a comment thread, which may affect how the comment is displayed.
Returns: CommentThreadState | undefined
The optional state of a comment thread, which may affect how the comment is displayed. **Returns:** `CommentThreadState | undefined`
uricljs
(uri comment-thread)The uri of the document the thread has been created on.
Returns: Uri
The uri of the document the thread has been created on. **Returns:** `Uri`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close