tridion-sites-extensions-api-docs

Home > @tridion-sites/models > Schema

Schema class

Schema defines structure of content and/or metadata.

Signature:

export declare class Schema extends VersionedItem

Extends: VersionedItem

Constructors

Constructor Modifiers Description
(constructor)({ backendModel, allowedMultimediaTypes, bundleProcess, componentProcess, fields, metadataFields, purpose, …versionedItemProps })   Constructs a new instance of the Schema class

Properties

Property Modifiers Type Description
_backendModel   BackendSchema  
allowedMultimediaTypes   ReadonlyArray<Link> | undefined  
bundleProcess   Link | undefined  
componentProcess   Link | undefined  
deleteBundleOnProcessFinished   boolean whether the Bundles based on this Schema should be deleted when a workflow process they are part of finishes.
description   string | undefined Description for the Schema.
fields   FieldsDefinitionDictionary | undefined  
getInternalModel   () => BackendSchema  
isIndexable   boolean Whether components based on this schema will be indexed during data publishing.
isPublishable   boolean Whether components based on this schema can be resolved for data publishing.
isTridionWebSchema   boolean Whether the Schema qualifies as “Tridion Web Schema”.
metadataFields   FieldsDefinitionDictionary | undefined  
namespaceUri   string | undefined Namespace URI (target namespace) of the Schema.
purpose   SchemaPurpose | undefined Purpose for the Schema.
rootElementName   string | undefined Name of the root element.