IPublisherDocumentContentV1
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Versioned content shared verbatim by document templates and documents.
export interface IPublisherDocumentContentV1
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Configuration of the content-level attribute filters, keyed by the filter’s local identifier. | |||
(ALPHA) (Optional) Content-level default filters; pages and slots may extend or override them. The document period is NOT stored here — it is derived from periodStart/periodEnd at execution time. | |||
(ALPHA) Ordered pages of the document. | |||
string | (ALPHA) (Optional) Instructions every AI-written text without instructions of its own is generated with. Supports | ||
(ALPHA) (Optional) Custom variable declarations. Values live on the document (IPublisherDocumentBaseV1.variableValues). | |||
“1” | (ALPHA) Content model version, for stored-content evolution. |
Property details
IPublisherDocumentContentV1.attributeFilterConfigspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Configuration of the content-level attribute filters, keyed by the filter’s local identifier.
attributeFilterConfigs?: IPublisherAttributeFilterConfigV1[];
Remarks
A filter with a displayAsLabel must be stored on the attribute’s primary label: its selection is read as primary-label values and shown by displayAsLabel.
IPublisherDocumentContentV1.filterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Content-level default filters; pages and slots may extend or override them. The document period is NOT stored here — it is derived from periodStart/periodEnd at execution time.
filters?: FilterContextItem[];
IPublisherDocumentContentV1.pagespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Ordered pages of the document.
pages: IPublisherDocumentPageV1[];
IPublisherDocumentContentV1.takeawaysInstructionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Instructions every AI-written text without instructions of its own is generated with. Supports {variables}.
takeawaysInstruction?: string;
IPublisherDocumentContentV1.variablespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Custom variable declarations. Values live on the document (IPublisherDocumentBaseV1.variableValues).
variables?: IPublisherVariableDefinitionV1[];
IPublisherDocumentContentV1.versionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Content model version, for stored-content evolution.
version: "1";