tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > SchemaPurpose

SchemaPurpose enum

Defines a purpose of a Schema, that is in which items the Schema can be used.

Members: * Component - Schema defines the content and metadata of Components with XML content. * Multimedia - Schema defines the content and metadata of Multimedia Components. * Embedded - Schema is included into other Schemas. * Metadata - Schema defines the metadata of items (except for Components). * Protocol - Schema defines the protocol fields of a Publication Target. * VirtualFolderType - Schema defines the configuration data of a Virtual Folder. * TemplateParameters - Schema defines the parameters of a Template. * Bundle - Schema defines the metadata and process definition of a Bundle. * Region - Schema defines the Region definition and metadata. * UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.

Signature:

export declare enum SchemaPurpose

Enumeration Members

Member Value Description
BUNDLE "Bundle"  
COMPONENT "Component"  
EMBEDDED "Embedded"  
METADATA "Metadata"  
MULTIMEDIA "Multimedia"  
PROTOCOL "Protocol"  
REGION "Region"  
TEMPLATE_PARAMETERS "TemplateParameters"  
UNKNOWN_BY_CLIENT "UnknownByClient"  
VIRTUAL_FOLDER_TYPE "VirtualFolderType"