Interface CommentsService

Hierarchy

CommentsService

Properties

Readonly onDidChangeActiveCommentThread

onDidChangeActiveCommentThread: Event<null | CommentThread>

Readonly onDidChangeActiveCommentingRange

onDidChangeActiveCommentingRange: Event<{ commentingRangesInfo: CommentingRanges; range: Range }>

Readonly onDidDeleteDataProvider

onDidDeleteDataProvider: Event<string>

Readonly onDidSetAllCommentThreads

onDidSetAllCommentThreads: Event<WorkspaceCommentThreadsEventMain>

Readonly onDidSetDataProvider

onDidSetDataProvider: Event<void>

Readonly onDidSetResourceCommentInfos

onDidSetResourceCommentInfos: Event<ResourceCommentThreadEvent>

Readonly onDidUpdateCommentThreads

onDidUpdateCommentThreads: Event<CommentThreadChangedEventMain>

Methods

createCommentThreadTemplate

createCommentThreadTemplate(owner: string, resource: URI, range: Range): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:75
Parameters
- owner: string
- resource: URI
- range: Range
Returns void

disposeCommentThread

disposeCommentThread(ownerId: string, threadId: string): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:81
Parameters
- ownerId: string
- threadId: string
Returns void

getCommentController

getCommentController(owner: string): undefined | CommentController

- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:73
Parameters
- owner: string
Returns undefined | CommentController

getCommentingRanges

getCommentingRanges(resource: URI): Promise<Range[]>

- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:85
Parameters
- resource: URI
Returns Promise<Range[]>

getComments

getComments(resource: URI): Promise<(null | CommentInfoMain)[]>

- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:83
Parameters
- resource: URI
Returns Promise<(null | CommentInfoMain)[]>

registerCommentController

registerCommentController(owner: string, commentControl: CommentController): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:69
Parameters
- owner: string
- commentControl: CommentController
Returns void

removeWorkspaceComments

removeWorkspaceComments(owner: string): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:67
Parameters
- owner: string
Returns void

setActiveCommentThread

setActiveCommentThread(commentThread: null | CommentThread): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:87
Parameters
- commentThread: null | CommentThread
Returns void

setDocumentComments

setDocumentComments(resource: URI, commentInfos: CommentInfoMain[]): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:63
Parameters
- resource: URI
- commentInfos: CommentInfoMain[]
Returns void

setWorkspaceComments

setWorkspaceComments(owner: string, commentsByResource: CommentThread[]): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:65
Parameters
- owner: string
- commentsByResource: CommentThread[]
Returns void

unregisterCommentController

unregisterCommentController(owner: string): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:71
Parameters
- owner: string
Returns void

updateCommentThreadTemplate

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

- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:77
Parameters
- owner: string
- threadHandle: number
- range: Range
Returns Promise<void>

updateComments

updateComments(ownerId: string, event: CommentThreadChangedEvent): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:79
Parameters
- ownerId: string
- event: CommentThreadChangedEvent
Returns void