Class PluginCommentService

Implements

CommentsService

Constructors

constructor

new PluginCommentService(): PluginCommentService
Returns PluginCommentService

Properties

`Readonly`onDidChangeActiveCommentingRange

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

`Readonly`onDidChangeActiveCommentThread

onDidChangeActiveCommentThread: Event<null | CommentThread> = ...

`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
Parameters
- owner: string
- resource: URI
- range: Range
Returns void
Implementation of CommentsService.createCommentThreadTemplate
- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:146

disposeCommentThread

disposeCommentThread(owner: string, threadId: string): void
Parameters
- owner: string
- threadId: string
Returns void
Implementation of CommentsService.disposeCommentThread
- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:166

getCommentController

getCommentController(owner: string): undefined | CommentController
Parameters
- owner: string
Returns undefined | CommentController
Implementation of CommentsService.getCommentController
- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:142

getCommentingRanges

getCommentingRanges(resource: URI): Promise<Range[]>
Parameters
- resource: URI
Returns Promise<Range[]>
Implementation of CommentsService.getCommentingRanges
- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:192

getComments

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

registerCommentController

registerCommentController(
owner: string,
commentControl: CommentController,
): void
Parameters
- owner: string
- commentControl: CommentController
Returns void
Implementation of CommentsService.registerCommentController
- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:132

removeWorkspaceComments

removeWorkspaceComments(owner: string): void
Parameters
- owner: string
Returns void
Implementation of CommentsService.removeWorkspaceComments
- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:128

setActiveCommentThread

setActiveCommentThread(commentThread: null | CommentThread): void
Parameters
- commentThread: null | CommentThread
Returns void
Implementation of CommentsService.setActiveCommentThread
- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:116

setDocumentComments

setDocumentComments(resource: URI, commentInfos: CommentInfoMain[]): void
Parameters
- resource: URI
- commentInfos: CommentInfoMain[]
Returns void
Implementation of CommentsService.setDocumentComments
- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:120

setWorkspaceComments

setWorkspaceComments(owner: string, commentsByResource: CommentThread[]): void
Parameters
- owner: string
- commentsByResource: CommentThread[]
Returns void
Implementation of CommentsService.setWorkspaceComments
- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:124

unregisterCommentController

unregisterCommentController(owner: string): void
Parameters
- owner: string
Returns void
Implementation of CommentsService.unregisterCommentController
- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:137

updateComments

updateComments(ownerId: string, event: CommentThreadChangedEvent): void
Parameters
- ownerId: string
- event: CommentThreadChangedEvent
Returns void
Implementation of CommentsService.updateComments
- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:173

updateCommentThreadTemplate

updateCommentThreadTemplate(
    owner: string,
    threadHandle: number,
    range: Range,
): Promise<void>
Parameters
- owner: string
- threadHandle: number
- range: Range
Returns Promise<void>
Implementation of CommentsService.updateCommentThreadTemplate
- Defined in packages/plugin-ext/src/main/browser/comments/comments-service.ts:156

Class PluginCommentService

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PluginCommentService

Properties

ReadonlyonDidChangeActiveCommentingRange

ReadonlyonDidChangeActiveCommentThread

ReadonlyonDidDeleteDataProvider

ReadonlyonDidSetAllCommentThreads

ReadonlyonDidSetDataProvider

ReadonlyonDidSetResourceCommentInfos

ReadonlyonDidUpdateCommentThreads

Methods

createCommentThreadTemplate

Parameters

Returns void

disposeCommentThread

Parameters

Returns void

getCommentController

Parameters

Returns undefined | CommentController

getCommentingRanges

Parameters

Returns Promise<Range[]>

getComments

Parameters

Returns Promise<(null | CommentInfoMain)[]>

registerCommentController

Parameters

Returns void

removeWorkspaceComments

Parameters

Returns void

setActiveCommentThread

Parameters

Returns void

setDocumentComments

Parameters

Returns void

setWorkspaceComments

Parameters

Returns void

unregisterCommentController

Parameters

Returns void

updateComments

Parameters

Returns void

updateCommentThreadTemplate

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`onDidChangeActiveCommentingRange

`Readonly`onDidChangeActiveCommentThread

`Readonly`onDidDeleteDataProvider

`Readonly`onDidSetAllCommentThreads

`Readonly`onDidSetDataProvider

`Readonly`onDidSetResourceCommentInfos

`Readonly`onDidUpdateCommentThreads