Interface CommentActions

interface CommentActions {
    createComment: (
        options: WithResourceNameSupport<CreateCommentOptions>,
    ) => Promise<Comment>;
    removeComment: (
        options: WithResourceNameSupport<RemoveCommentOptions>,
    ) => Promise<void>;
    replyToComment: (
        options: WithResourceNameSupport<ReplyToCommentOptions>,
    ) => Promise<Comment>;
    setCommentStatus: (
        options: WithResourceNameSupport<SetCommentStatusOptions>,
    ) => Promise<void>;
    updateComment: (
        options: WithResourceNameSupport<UpdateCommentOptions>,
    ) => Promise<void>;
}

Properties

createComment: (
options: WithResourceNameSupport<CreateCommentOptions>,
) => Promise<Comment>

Starts a thread on a document, or on one of its fields.

removeComment: (
options: WithResourceNameSupport<RemoveCommentOptions>,
) => Promise<void>

Deletes a comment, and its replies when it starts a thread.

replyToComment: (
options: WithResourceNameSupport<ReplyToCommentOptions>,
) => Promise<Comment>

Adds a reply to an existing thread.

setCommentStatus: (
options: WithResourceNameSupport<SetCommentStatusOptions>,
) => Promise<void>

Resolves or reopens a thread. Pass the thread's first comment.

updateComment: (
options: WithResourceNameSupport<UpdateCommentOptions>,
) => Promise<void>

Rewrites a comment's message.