ExperienceBundleSettings

Represents the settings of ExperienceBundleMetadata of an organization. This type extends the Metadata metadata type and inherits its fullName field.

ExperienceBundleMetadata is a text-based code structure of Community settings and site components, such as pages, branding sets, and themes. Developers can quickly update and deploy one or more Lightning communities programmatically using their preferred development tools. ExperienceBundleSettings represents the org preferences associated with ExperienceBundleMetadata.

Note

File Suffix and Directory Location

ExperienceBundleSettings values are stored in a single file named ExperienceBundle.settings in the settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.

Version

ExperienceBundleSettings is available in API version 46.0 and later.

Fields

Field Name	Field Type	Description
enableExperienceBundleMetadata	boolean	Indicates whether ExperienceBundleMetadata is enabled. Default is `false`.

Declarative Metadata Sample Definition

Here’s an example of ExperienceBundle.settings that references the previous definition.

1<ExperienceBundleSettings xmlns="http://soap.sforce.com/2006/04/metadata">
2        <enableExperienceBundleMetadata>true</enableExperienceBundleMetadata>
3</ExperienceBundleSettings>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide