tridion-sites-extensions-api-docs

Home > @tridion-sites/models > SchemaPurpose

SchemaPurpose type

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

* 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 type SchemaPurpose =
    | 'component'
    | 'multimedia'
    | 'embedded'
    | 'metadata'
    | 'protocol'
    | 'virtualFolderType'
    | 'templateParameters'
    | 'bundle'
    | 'region'
    | 'unknownByClient';