tridion-sites-extensions-api-docs

Home > @tridion-sites/models > Folder

Folder class

An item used to organize the items in a Repository.

Signature:

export declare class Folder extends OrganizationalItem

Extends: OrganizationalItem

Constructors

Constructor Modifiers Description
(constructor)({ backendModel, linkedSchema, …orgItemArgs })   Constructs a new instance of the Folder class

Properties

Property Modifiers Type Description
_backendModel   BackendFolder  
getInternalModel   () => BackendFolder  
isActive   boolean Active state of the Folder. If the active state is set to false, the Folder and the items inside it cannot be published.
isActiveResolvedValue   boolean Value indicating whether this Folder and its items can be published. Returns true if the active state of this Folder and all of its ancestors is true. Returns false if the active state of this Folder or any of its ancestors is false. The individual active state of each Folder is represented by the property “IsActive”.
isLinkedSchemaMandatory   boolean Whether the linked Schema is mandatory.
linkedSchema   Link | undefined <p>Linked Schema of the Folder.</p><p>The linked Schema acts as default Schema for Components created in the Folder. It can also acts as mandatory Schema, if “IsLinkedSchemaMandatory” is set to true. In the latter case, Components cannot be saved in the Folder unless they are based on this Schema.</p>