tridion-sites-extensions-api-docs

Home > @tridion-sites/models > Page

Page class

Represents the data of a Page: an artifact in the Publication’s target structure.

Signature:

export declare class Page extends VersionedItem

Extends: VersionedItem

Constructors

Constructor Modifiers Description
(constructor)({ backendModel, approvalStatus, componentPresentations, pageTemplate, publishLocationInfo, regionSchema, regions, workflowInfo, …versionedItemArgs })   Constructs a new instance of the Page class

Properties

Property Modifiers Type Description
_backendModel   BackendPage  
approvalStatus   Link | undefined Approval status of the item or undefined if the item has not been part of a workflow process.
componentPresentations   ReadonlyArray<ComponentPresentation> | undefined The Component Presentations directly on the Page (excluding Component Presentations inside of Regions).
fileName   string | undefined <p>File name.</p><p>The file name is the Page’s physical name in the target structure. The file name is subject to the restrictions of the Windows file system. The file name does not include the file extension. The file extension is determined by the Page Template: “fileExtension”.</p>
getInternalModel   () => BackendPage  
isPageTemplateInherited   boolean Whether the Page Template is inherited from the containing Structure Group.
locationInfo   PublishLocationInfo | undefined Location/context info for “RepositoryLocalObjects”.
pageTemplate   Link | undefined <p>The Page Template used to render the Page.</p><p>The Page Template can be set explicitly on the Page or be inherited from the containing Structure Group: “StructureGroup.DefaultPageTemplate”.</p>
regions   ReadonlyArray<Region> | undefined <p>The collection of nested Regions on the Page.</p><p>The collection can be modified according to the following rules. If the “PageTemplate.PageSchema” is set, the structure of regions must adhere to the definition specified by that schema.</p>
regionSchema   Link | undefined <p>Region Schema for the Page.</p><p>Region Schema for the Page is always derived from the “PageTemplate.PageSchema” defined for the Page Template.</p>
workflowInfo   WorkflowInfo | undefined Gets workflow-related information for the item.