Class CommentController

constructor

• new CommentController(
      _proxy: CommentsExt,
      _commentService: CommentsService,
      _handle: number,
      _uniqueId: string,
      _id: string,
      _label: string,
      _features: CommentProviderFeatures,
  ): CommentController

  Parameters

  • _proxy: CommentsExt
  • _commentService: CommentsService
  • _handle: number
  • _uniqueId: string
  • _id: string
  • _label: string
  • _features: CommentProviderFeatures

  Returns CommentController

OptionalactiveCommentThread

contextValue

• get contextValue(): string

  Returns string

features

• get features(): CommentProviderFeatures

  Returns CommentProviderFeatures

handle

• get handle(): number

  Returns number

id

• get id(): string

  Returns string

label

• get label(): string

  Returns string

options

• get options(): undefined | CommentOptions

  Returns undefined | CommentOptions

proxy

• get proxy(): CommentsExt

  Returns CommentsExt

createCommentThread

• createCommentThread(
      extensionId: string,
      commentThreadHandle: number,
      threadId: string,
      resource: UriComponents,
      range: undefined | Range,
  ): CommentThread

  Parameters

  • extensionId: string
  • commentThreadHandle: number
  • threadId: string
  • resource: UriComponents
  • range: undefined | Range

  Returns CommentThread

createCommentThreadTemplate

• createCommentThreadTemplate(resource: UriComponents, range: Range): void

  Parameters

  • resource: UriComponents
  • range: Range

  Returns void

deleteCommentThread

• deleteCommentThread(commentThreadHandle: number): void

  Parameters

  • commentThreadHandle: number

  Returns void

deleteCommentThreadMain

• deleteCommentThreadMain(commentThreadId: string): void

  Parameters

  • commentThreadId: string

  Returns void

getAllComments

• getAllComments(): CommentThread[]

  Returns CommentThread[]

getCommentingRanges

• getCommentingRanges(
      resource: URI,
      token: CancellationToken,
  ): Promise<undefined | { fileComments: boolean; ranges: Range[] }>

  Parameters

  • resource: URI
  • token: CancellationToken

  Returns Promise<undefined | { fileComments: boolean; ranges: Range[] }>

getDocumentComments

• getDocumentComments(
      resource: URI,
      token: CancellationToken,
  ): Promise<CommentInfoMain>

  Parameters

  • resource: URI
  • token: CancellationToken

  Returns Promise<CommentInfoMain>

updateCommentThread

• updateCommentThread(
      commentThreadHandle: number,
      threadId: string,
      resource: UriComponents,
      changes: CommentThreadChanges,
  ): void

  Parameters

  • commentThreadHandle: number
  • threadId: string
  • resource: UriComponents
  • changes: CommentThreadChanges

  Returns void

updateCommentThreadTemplate

• updateCommentThreadTemplate(threadHandle: number, range: Range): Promise<void>

  Parameters

  • threadHandle: number
  • range: Range

  Returns Promise<void>

updateFeatures

• updateFeatures(features: CommentProviderFeatures): void

  Parameters

  • features: CommentProviderFeatures

  Returns void

updateInput

• updateInput(input: string): void

  Parameters

  • input: string

  Returns void