Interface ResolvedUUID

interface ResolvedUUID {
    uuid: string;
    type: string;
    id: string;
    primaryType: string;
    primaryId: string;
    collection: DocumentCollection;
    embedded: string[];
    doc: Document;
    documentType: string;
    documentId: string;
}

Properties

uuid type id primaryType primaryId collection embedded doc documentType documentId

Properties

uuid

uuid: string

The original UUID.

type

type: string

The type of Document referenced. Legacy compendium UUIDs will not populate this field if the compendium is not active in the World.

id

id: string

The ID of the Document referenced.

primaryType

primaryType: string

The primary Document type of this UUID. Only present if the Document is embedded.

primaryId

primaryId: string

The primary Document ID of this UUID. Only present if the Document is embedded.

collection

collection: DocumentCollection

The collection that the primary Document belongs to.

embedded

embedded: string[]

Additional Embedded Document parts.

doc

doc: Document

An already-resolved parent Document.

documentType

documentType: string

Either the document type or the parent type. Retained for backwards compatibility.

documentId

documentId: string

Either the document id or the parent id. Retained for backwards compatibility.

Settings

Member Visibility

Theme

On This Page

uuidtypeidprimaryTypeprimaryIdcollectionembeddeddocdocumentTypedocumentId