Interface Comment

interface Comment {
    body: string;
    status: CommentStatus;
    sys: CommentSysProps;
    delete(): Promise<void>;
    toPlainObject(): CommentProps;
    update(): Promise<Comment | RichTextComment>;
}

Hierarchy (view full)

Index

Properties

body status sys

Methods

delete toPlainObject update

Properties

body

body: string

status

status: CommentStatus

sys

sys: CommentSysProps

Methods

delete

delete(): Promise<void>
Returns Promise<void>
Inherited from CommentApi.delete
- Defined in lib/entities/comment.ts:127

toPlainObject

toPlainObject(): CommentProps
Returns CommentProps
Inherited from DefaultElements.toPlainObject
- Defined in lib/common-types.ts:190

update

update(): Promise<Comment | RichTextComment>
Returns Promise<Comment | RichTextComment>
Inherited from CommentApi.update
- Defined in lib/entities/comment.ts:126