UnexpandedReference
A reference not resolved in this response: fetch it (resolveReference) or request a deeper resolve.
Extends
Section titled “Extends”ReferenceBase
Properties
Section titled “Properties”adapter?
Section titled “adapter?”
optionaladapter?:AdapterDescriptor
Inherited from
Section titled “Inherited from”ReferenceBase.adapter
content?
Section titled “content?”
optionalcontent?:undefined
contextualValues?
Section titled “contextualValues?”
optionalcontextualValues?:ContentDocument
The edge’s own values, overlaid on the target’s stored defaults — by the server at resolve ≥ 1, or by applyContextualOverlay under the normalized strategy.
Inherited from
Section titled “Inherited from”ReferenceBase.contextualValues
contract?
Section titled “contract?”
optionalcontract?:EntityDescriptor
Absent only on a bare embed reference authored without one — every top-level descriptor carries it.
Inherited from
Section titled “Inherited from”ReferenceBase.contract
key:
string
Inherited from
Section titled “Inherited from”ReferenceBase.key
paths?
Section titled “paths?”
optionalpaths?:ComponentPathEntry[]
Where the referenced Component lives, when the read asked for it (referencePaths: true) — one
{siteRootNodeId, path} per live published node whose root Presentation payload binds it,
exactly the rule and value listComponents({ paths: true }) reports for an item. [] means
the target is bound at no live node (a fragment, or a page not yet placed); the member being
absent means the read did not ask. Relative paths — pick one for your site with
pathForSite.
Present on an unexpanded descriptor too, which is what lets a resolve: 0 read build
navigation. Always absent on a category descriptor, whose own path means something else.
Inherited from
Section titled “Inherited from”ReferenceBase.paths
preview?
Section titled “preview?”
optionalpreview?:PreviewSource
Live preview only: the authoring entity behind this value. Never present on a delivery response.
Inherited from
Section titled “Inherited from”ReferenceBase.preview
provider
Section titled “provider”provider:
string
Inherited from
Section titled “Inherited from”ReferenceBase.provider
unresolvable?
Section titled “unresolvable?”
optionalunresolvable?:undefined