Class ExtHostCommentThread

constructor

• new ExtHostCommentThread(proxy, commentController, _id, _uri, _range, _comments, extensionId): ExtHostCommentThread

• Parameters

  • proxy: CommentsMain
  • commentController: CommentController
  • _id: undefined | string
  • _uri: Uri
  • _range: Range
  • _comments: Comment[]
  • extensionId: string

  Returns ExtHostCommentThread

commentHandle

Readonly handle

Readonly onDidUpdateCommentThread

canReply

• get canReply(): boolean

• Whether the thread supports reply. Defaults to true.

  Returns boolean
• set canReply(canReply): void

• Whether the thread supports reply. Defaults to true.

  Parameters

  • canReply: boolean

  Returns void

collapsibleState

• get collapsibleState(): CommentThreadCollapsibleState

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

  Returns CommentThreadCollapsibleState
• set collapsibleState(newState): void

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

  Parameters

  • newState: CommentThreadCollapsibleState

  Returns void

comments

• get comments(): Comment[]

• The ordered comments of the thread.

  Returns Comment[]
• set comments(newComments): void

• The ordered comments of the thread.

  Parameters

  • newComments: Comment[]

  Returns void

contextValue

• get contextValue(): undefined | 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"
        }
       ]
     }
   }
  Copy

  This will show action extension.deleteCommentThread only for comment threads with contextValue is editable.

  Returns undefined | string
• set contextValue(context): void

• 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"
        }
       ]
     }
   }
  Copy

  This will show action extension.deleteCommentThread only for comment threads with contextValue is editable.

  Parameters

  • context: undefined | string

  Returns void

id

• get id(): string

• Returns string

isDisposed

• get isDisposed(): boolean

• Returns boolean

label

• get label(): undefined | string

• The optional human-readable label describing the Comment Thread

  Returns undefined | string
• set label(label): void

• The optional human-readable label describing the Comment Thread

  Parameters

  • label: undefined | string

  Returns void

range

• get 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.

  Returns Range
• set range(range): void

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

  Parameters

  • range: Range

  Returns void

resource

• get resource(): Uri

• Returns Uri

state

• get state(): CommentThreadState

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

  Returns CommentThreadState
• set state(newState): void

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

  Parameters

  • newState: CommentThreadState

  Returns void

threadId

• get threadId(): string

• Returns string

• set threadId(id): void

• Parameters

  • id: string

  Returns void

uri

• get uri(): Uri

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

  Returns Uri

dispose

• dispose(): void

• Dispose this comment thread.

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

  Returns void

eventuallyUpdateCommentThread

• eventuallyUpdateCommentThread(): void

• Returns void

getCommentByUniqueId

• getCommentByUniqueId(uniqueId): undefined | Comment

• Parameters

  • uniqueId: number

  Returns undefined | Comment