Sanity Library Reference Docs
    Preparing search index...

    Interface UsePresenceForDocumentOptionsBeta

    interface UsePresenceForDocumentOptions {
        dataset?: string;
        documentId: string;
        documentType: string;
        excludeVersions?: boolean;
        liveEdit?: boolean;
        path?: Path;
        perspective?: ReleasePerspective | ClientPerspective$1;
        projectId?: string;
        resource?: DocumentResource;
        resourceName?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    dataset? documentId documentType excludeVersions? liveEdit? path? perspective? projectId? resource? resourceName?

    Properties

    dataset?: string
    documentId: string
    documentType: string
    excludeVersions?: boolean

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

    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

    path?: Path

    Narrows to participants at or below this field path, which is what a field indicator wants. Omit it for everyone in the document.

    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.

    resourceName?: string

    Settings

    Member Visibility

    On This Page

    Properties