Sanity Library Reference Docs
    Preparing search index...

    Interface EditDocumentVersionEventBeta

    This event won't be exposed by the API, it needs to be generated by validating the transactions that occurred between two events. Usually, between two PublishDocumentEvents. Or a create event and a publish event.

    interface EditDocumentVersionEvent {
        author: string;
        contributors: string[];
        documentId: string;
        documentVariantType: DocumentVariantType;
        id: string;
        parentId?: string;
        releaseId?: string;
        revisionId: string;
        timestamp: string;
        transactions: {
            author: string;
            revisionId: string;
            timestamp: string;
            type: "editTransaction";
        }[];
        type: "editDocumentVersion";
    }

    Hierarchy (View Summary)

    Index

    Properties

    author contributors documentId documentVariantType id parentId? releaseId? revisionId timestamp transactions type

    Properties

    author: string
    contributors: string[]
    documentId: string
    documentVariantType: DocumentVariantType

    This is added client side to enhance the UI.

    id: string
    parentId?: string

    Present when an edit was already published, then the user decided to expand the event.

    releaseId?: string

    No longer populated by the events store. Resolve membership from the version document's _system.release instead. Will be removed in the next major.

    revisionId: string

    One edit event could contain multiple transactions that are merged together. This represents the newest transaction in the merged events.

    timestamp: string
    transactions: {
        author: string;
        revisionId: string;
        timestamp: string;
        type: "editTransaction";
    }[]
    type: "editDocumentVersion"

    Settings

    Member Visibility

    On This Page

    Properties