Sanity Library Reference Docs
    Preparing search index...

    Interface CommentsOptionsBeta

    Which comments to read.

    interface CommentsOptions {
        dataset?: string;
        documentId: string;
        documentType: string;
        fieldPath?: string | Path;
        liveEdit?: boolean;
        perspective?: ReleasePerspective | ClientPerspective$1;
        projectId?: string;
        resource?: DocumentResource;
        status?: CommentStatus;
    }

    Hierarchy (View Summary)

    Index

    Properties

    dataset? documentId documentType fieldPath? liveEdit? perspective? projectId? resource? status?

    Properties

    dataset?: string
    documentId: string
    documentType: string
    fieldPath?: string | Path

    Narrow to one field. Omit to get every comment on the document.

    liveEdit?: boolean

    Indicates whether this document uses liveEdit mode. When true, the document does not use the draft/published model and edits are applied directly to the document.

    https://www.sanity.io/docs/content-lake/drafts#ca0663a8f002

    perspective?: ReleasePerspective | ClientPerspective$1
    projectId?: string
    resource?: DocumentResource

    Explicit resource to use. On an individual operation this overrides any default; on a SanityConfig it becomes the instance's default resource. Unlike projectId/dataset, this can also be a media library or canvas resource.

    status?: CommentStatus

    Narrow to open or resolved threads. Omit for both.

    Settings

    Member Visibility

    On This Page

    Properties