Sanity Library Reference Docs
    Preparing search index...

    Interface UseReportPresenceOptionsBeta

    interface UseReportPresenceOptions {
        dataset?: string;
        documentId: string;
        documentType: string;
        liveEdit?: boolean;
        path?: Path;
        perspective?: ReleasePerspective | ClientPerspective;
        projectId?: string;
        resource?: DocumentResource;
        resourceName?: string;
        selection?: PresenceSelection;
        source?: DocumentResource;
        throttleMs?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    dataset? documentId documentType liveEdit? path? perspective? projectId? resource? resourceName? selection? source? throttleMs?

    Properties

    dataset?: string
    documentId: string
    documentType: string
    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

    The focused field path. Omit it for document-level presence. Keyed and numeric segments are supported, so array items and Portable Text spans can be addressed.

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

    Explicit resource object to use for this operation.

    resourceName?: string
    selection?: PresenceSelection

    The Portable Text caret, when the focused field is a Portable Text field.

    source?: DocumentResource

    Use resource instead.

    throttleMs?: number

    Overrides the throttle interval. Mainly useful in tests.

    Settings

    Member Visibility

    On This Page

    Properties