IPublisherSlotBaseV1
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Structural base of every document slot.
export interface IPublisherSlotBaseV1
Remarks
Parsers written against this base can skip slot types introduced by a newer content version instead of failing.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) Identifier unique within the page body. The layout tree references it, and it is the join key when a document fills a template’s slots. Regenerated when a page is cloned into template content so repeated use of one page stays unique. | ||
(ALPHA) (Optional) Present when the slot is an unfilled placeholder. | |||
string | (ALPHA) |
Property details
IPublisherSlotBaseV1.localIdentifierpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Identifier unique within the page body. The layout tree references it, and it is the join key when a document fills a template’s slots. Regenerated when a page is cloned into template content so repeated use of one page stays unique.
localIdentifier: string;
IPublisherSlotBaseV1.placeholderpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Present when the slot is an unfilled placeholder.
placeholder?: IPublisherSlotPlaceholderV1;
IPublisherSlotBaseV1.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
type: string;