Sanity Library Reference Docs
    Preparing search index...

    Interface CommentDocumentBeta

    interface CommentDocument {
        _createdAt: string;
        _id: string;
        _rev: string;
        _state?: CommentState;
        _type: "comment";
        authorId: string;
        contentSnapshot?: unknown;
        context?: CommentContext;
        lastEditedAt?: string;
        message: PortableTextBlock[];
        parentCommentId?: string;
        reactions: CommentReactionItem[];
        status: CommentStatus;
        target: {
            document:
                | {
                    _dataset: string;
                    _projectId: string;
                    _ref: string;
                    _type: "crossDatasetReference";
                    _weak: boolean;
                }
                | { _ref: string; _type: "reference"; _weak: boolean };
            documentRevisionId?: string;
            documentType: string;
            documentVersionId?: string;
            path?: CommentPath;
        };
        threadId: string;
    }
    Index

    Properties

    _createdAt: string
    _id: string
    _rev: string
    _state?: CommentState
    _type: "comment"
    authorId: string
    contentSnapshot?: unknown

    A snapshot value of the content that the comment is related to.

    context?: CommentContext
    lastEditedAt?: string
    parentCommentId?: string
    reactions: CommentReactionItem[]
    target: {
        document:
            | {
                _dataset: string;
                _projectId: string;
                _ref: string;
                _type: "crossDatasetReference";
                _weak: boolean;
            }
            | { _ref: string; _type: "reference"; _weak: boolean };
        documentRevisionId?: string;
        documentType: string;
        documentVersionId?: string;
        path?: CommentPath;
    }
    threadId: string