View source

typedef CommentThread

package vscode

A collection of {@link Comment comments} representing a conversation at a particular range in a document.

Fields

read onlyuri:Uri

The uri of the document the thread has been created on.

range:Range

The range the comment thread is located within the document. The thread icon will be shown at the first line of the range.

@:optionaloptionallabel:Null<String>

The optional human-readable label describing the {@link CommentThread Comment Thread}

dispose():Void

Dispose this comment thread.

Once disposed, this comment thread will be removed from visible editors and Comment Panel when appropriate.

@:optionaloptionalcontextValue:Null<String>

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.

comments:ReadOnlyArray<Comment>

The ordered comments of the thread.

collapsibleState:CommentThreadCollapsibleState

Whether the thread should be collapsed or expanded when opening the document. Defaults to Collapsed.

canReply:Bool

Whether the thread supports reply. Defaults to true.