Sanity Library Reference Docs
    Preparing search index...

    Interface DocumentPresenceOptionsBeta

    interface DocumentPresenceOptions {
        documentId: string;
        excludeVersions?: boolean;
        liveEdit?: boolean;
        path?: Path;
        perspective?: ReleasePerspective | ClientPerspective;
    }

    Hierarchy (View Summary)

    Index

    Properties

    documentId excludeVersions? liveEdit? path? perspective?

    Properties

    documentId: string

    The document to look at. Resolved through the perspective exactly as ReportPresenceOptions.documentId is, so reads match writes.

    excludeVersions?: boolean

    By default a draft, its published version, and any release versions are treated as the same document, which is what document lists want. Set this to compare ids exactly, which is what field-level indicators want so that a draft and a release version do not bleed into each other.

    liveEdit?: boolean

    Live-edit documents have no draft, so presence resolves to the published id.

    path?: Path

    Narrows to participants at or below this field path. Omit it for everyone in the document.

    perspective?: ReleasePerspective | ClientPerspective

    Settings

    Member Visibility

    On This Page

    Properties