API Reference
@univerjs
@univerjs/facade
classes
Fthreadcomment

@univerjs/facade v0.2.14Docs


Class: FThreadComment

Constructors

new FThreadComment()

new FThreadComment(
   _thread, 
   _parent, 
   _injector, 
   _commandService, 
   _univerInstanceService, 
   _threadCommentModel): FThreadComment

Parameters

ParameterType
_threadIBaseComment | IThreadComment
_parentundefined | IThreadComment
_injectorInjector
_commandServiceICommandService
_univerInstanceServiceIUniverInstanceService
_threadCommentModelSheetsThreadCommentModel

Returns

FThreadComment

Defined in

submodules/univer/packages/facade/src/apis/sheets/f-thread-comment.ts:27 (opens in a new tab)

Methods

delete()

delete(): Promise<boolean>

Delete the comment and it's replies

Returns

Promise<boolean>

success or not

Defined in

submodules/univer/packages/facade/src/apis/sheets/f-thread-comment.ts:101 (opens in a new tab)


getCommentData()

getCommentData(): IBaseComment

Get the comment data

Returns

IBaseComment

The comment data

Defined in

submodules/univer/packages/facade/src/apis/sheets/f-thread-comment.ts:56 (opens in a new tab)


getContent()

getContent(): IDocumentBody

Get the content of the comment

Returns

IDocumentBody

The content of the comment

Defined in

submodules/univer/packages/facade/src/apis/sheets/f-thread-comment.ts:93 (opens in a new tab)


getIsRoot()

getIsRoot(): boolean

Whether the comment is a root comment

Returns

boolean

Whether the comment is a root comment

Defined in

submodules/univer/packages/facade/src/apis/sheets/f-thread-comment.ts:48 (opens in a new tab)


getRange()

getRange(): null | FRange

Get the range of the comment

Returns

null | FRange

The range of the comment

Defined in

submodules/univer/packages/facade/src/apis/sheets/f-thread-comment.ts:76 (opens in a new tab)


getReplies()

getReplies(): undefined | FThreadComment[]

Get the replies of the comment

Returns

undefined | FThreadComment[]

the replies of the comment

Defined in

submodules/univer/packages/facade/src/apis/sheets/f-thread-comment.ts:65 (opens in a new tab)


resolve()

resolve(resolved?): Promise<boolean>

Resolve the comment

Parameters

ParameterTypeDescription
resolved?booleanWhether the comment is resolved

Returns

Promise<boolean>

success or not

Defined in

submodules/univer/packages/facade/src/apis/sheets/f-thread-comment.ts:141 (opens in a new tab)


update()

update(content): Promise<boolean>

Update the comment content

Parameters

ParameterTypeDescription
contentIDocumentBodyThe new content of the comment

Returns

Promise<boolean>

success or not

Defined in

submodules/univer/packages/facade/src/apis/sheets/f-thread-comment.ts:117 (opens in a new tab)


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.