Class CommentController

Hierarchy

CommentController

Constructors

constructor

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

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:229
Parameters
- _proxy: CommentsExt
- _commentService: CommentsService
- _handle: number
- _uniqueId: string
- _id: string
- _label: string
- _features: CommentProviderFeatures
Returns CommentController

Properties

Optional activeCommentThread

activeCommentThread?: CommentThread

Private Readonly threads

threads: Map<number, CommentThreadImpl> = ...

Accessors

contextValue

get contextValue(): string

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:206
Returns string

features

get features(): CommentProviderFeatures

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:225
Returns CommentProviderFeatures

handle

get handle(): number

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:198
Returns number

id

get id(): string

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:202
Returns string

label

get label(): string

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:214
Returns string

options

get options(): undefined | CommentOptions

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:218
Returns undefined | CommentOptions

proxy

get proxy(): CommentsExt

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:210
Returns CommentsExt

Methods

createCommentThread

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

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:243
Parameters
- extensionId: string
- commentThreadHandle: number
- threadId: string
- resource: UriComponents
- range: Range
Returns CommentThread

createCommentThreadTemplate

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

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:358
Parameters
- resource: UriComponents
- range: Range
Returns void

deleteCommentThread

deleteCommentThread(commentThreadHandle: number): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:283
Parameters
- commentThreadHandle: number
Returns void

deleteCommentThreadMain

deleteCommentThreadMain(commentThreadId: string): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:296
Parameters
- commentThreadId: string
Returns void

getAllComments

getAllComments(): CommentThread[]

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:349
Returns CommentThread[]

getCommentingRanges

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

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

getDocumentComments

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

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:322
Parameters
- resource: URI
- token: CancellationToken
Returns Promise<CommentInfoMain>

Private getKnownThread

getKnownThread(commentThreadHandle: number): CommentThreadImpl

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:314
Parameters
- commentThreadHandle: number
Returns CommentThreadImpl

updateCommentThread

updateCommentThread(commentThreadHandle: number, threadId: string, resource: UriComponents, changes: Partial<{ canReply: boolean; collapseState: CommentThreadCollapsibleState; comments: Comment[]; contextValue: string; label: string; range: Range; state: CommentThreadState }>): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:269
Parameters
- commentThreadHandle: number
- threadId: string
- resource: UriComponents
- changes: Partial<{ canReply: boolean; collapseState: CommentThreadCollapsibleState; comments: Comment[]; contextValue: string; label: string; range: Range; state: CommentThreadState }>
Returns void

updateCommentThreadTemplate

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

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

updateFeatures

updateFeatures(features: CommentProviderFeatures): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:239
Parameters
- features: CommentProviderFeatures
Returns void

updateInput

updateInput(input: string): void

- Defined in packages/plugin-ext/src/main/browser/comments/comments-main.ts:304
Parameters
- input: string
Returns void