kotlin-vscode/vscode/CommentThread

CommentThread

interface CommentThread : DisposableLike(source)

A collection of comments representing a conversation at a particular range in a document.

Online Documentation

Properties

Link copied to clipboard
abstract var canReply: JsAny

Whether the thread supports reply. Defaults to true.

Link copied to clipboard
abstract var collapsibleState: CommentThreadCollapsibleState

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

Link copied to clipboard
abstract var comments: ReadonlyArray<Comment>

The ordered comments of the thread.

Link copied to clipboard
abstract var contextValue: 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.

Link copied to clipboard
abstract var label: String?

The optional human-readable label describing the Comment Thread

Link copied to clipboard
abstract var range: Range?

The range the comment thread is located within the document. The thread icon will be shown at the last line of the range. When set to undefined, the comment will be associated with the file, and not a specific range.

Link copied to clipboard
abstract var state: CommentThreadState?

The optional state of a comment thread, which may affect how the comment is displayed.

Link copied to clipboard
abstract val uri: Uri

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

Functions

Link copied to clipboard
abstract override fun dispose()

Dispose this comment thread.