Interface CommentsService

interface CommentsService {
    onDidChangeActiveCommentThread: Event<null | CommentThread>;
    onDidChangeActiveCommentingRange: Event<{
        commentingRangesInfo: CommentingRanges;
        range: Range;
    }>;
    onDidDeleteDataProvider: Event<string>;
    onDidSetAllCommentThreads: Event<WorkspaceCommentThreadsEventMain>;
    onDidSetDataProvider: Event<void>;
    onDidSetResourceCommentInfos: Event<ResourceCommentThreadEvent>;
    onDidUpdateCommentThreads: Event<CommentThreadChangedEventMain>;
    createCommentThreadTemplate(owner, resource, range): void;
    disposeCommentThread(ownerId, threadId): void;
    getCommentController(owner): undefined | CommentController;
    getCommentingRanges(resource): Promise<Range[]>;
    getComments(resource): Promise<(null | CommentInfoMain)[]>;
    registerCommentController(owner, commentControl): void;
    removeWorkspaceComments(owner): void;
    setActiveCommentThread(commentThread): void;
    setDocumentComments(resource, commentInfos): void;
    setWorkspaceComments(owner, commentsByResource): void;
    unregisterCommentController(owner): void;
    updateCommentThreadTemplate(owner, threadHandle, range): Promise<void>;
    updateComments(ownerId, event): void;
}

Implemented by

Properties

onDidChangeActiveCommentThread onDidChangeActiveCommentingRange onDidDeleteDataProvider onDidSetAllCommentThreads onDidSetDataProvider onDidSetResourceCommentInfos onDidUpdateCommentThreads

Methods

createCommentThreadTemplate disposeCommentThread getCommentController getCommentingRanges getComments registerCommentController removeWorkspaceComments setActiveCommentThread setDocumentComments setWorkspaceComments unregisterCommentController updateCommentThreadTemplate updateComments

Properties

Readonly onDidChangeActiveCommentThread

onDidChangeActiveCommentThread: Event<null | CommentThread>

Readonly onDidChangeActiveCommentingRange

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

Type declaration

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

disposeCommentThread

getCommentController

getCommentingRanges

getComments

registerCommentController

removeWorkspaceComments

setActiveCommentThread

setDocumentComments

setWorkspaceComments

unregisterCommentController

updateCommentThreadTemplate

updateComments

Settings

Member Visibility

Theme

On This Page

onDidChangeActiveCommentThreadonDidChangeActiveCommentingRangeonDidDeleteDataProvideronDidSetAllCommentThreadsonDidSetDataProvideronDidSetResourceCommentInfosonDidUpdateCommentThreadscreateCommentThreadTemplatedisposeCommentThreadgetCommentControllergetCommentingRangesgetCommentsregisterCommentControllerremoveWorkspaceCommentssetActiveCommentThreadsetDocumentCommentssetWorkspaceCommentsunregisterCommentControllerupdateCommentThreadTemplateupdateComments