Interface MetadataType

Whenever this type is requested, return the aliasFor type instead

Type definitions for child types, if the type has any.

Examples: CustomField and CompactLayout on CustomObject

Name of the directory where components are located in a package.

If the type is a folder type (container for components), the id of the type it is a container for.

If the type is contained in folders, the id of the type that contains it.

Unique identifier of the metadata type. Usually the API name lowercased.

If the parent name should be ignored when constructing the type's fullName

Whether or not to ignore the fullName that's parsed from the file path. If true, the metadata type's name will be used instead. For example, CustomLabels instead of MyLabels.

Whether or not components are stored in folders.

Examples: Reports, Dashboards, Documents, EmailTemplates

Deprecated

use folderType to get the related folder type, if one exists

Whether the component is supported by the Metadata API and therefore should be included within a manifest.

When converting deploying source, this will update the suffix in the output or temporary directory (metadata format) Use this, along with additional suffix keys in the registry, to support incorrect suffixes from existing code

MetaFile suffix

An override to the default "-meta.xml" suffix.

Examples: "_meta.json" for DigitalExperience.

API name of the metadata type.

Configuration for resolving and converting components of the type.

Whether or not components are required to reside in a folder named after the type's directoryName.

File suffix

Some types may not have one, such as those made up of varying file extensions.

Examples: LightningComponentBundles, Documents, StaticResources

Whether the component can be partially deleted, such as metadata types that are made up of multiple files.

Examples: LightningComponentBundle, ExperienceBundle, StaticResource, and DigitalExperienceBundle

Whether or not components of the same type can be can be specified with the wildcard character, and by name in a manifest

<members>*</members>
<members>Account</members>
<name>CustomObject</name>
Copy

Whether the component requires the parent to be present when deploying/retrieving

The xml attribute used as the unique identifier when parsing the xml

The XML element name for the type in the xml file used for constructing child components.