Metadata API Developer Guide
jNewer Version Available
LightningExperienceSettings
Represents the settings that modify an org’s
Lightning Experience configuration. This type extends the Metadata
metadata type and inherits its fullName field.
In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.
File Suffix and Directory Location
A LightningExperienceSettings component has the suffix .settings and is stored in the settings folder. The .settings files are different from other named components because there is only one settings file for each settings component.
Version
LightningExperienceSettings components are available in API version 47.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| enableAccessCheckCrucPref | boolean | Deprecated in API version 47.0 and later because the feature is no longer available. |
| enableApiUserLtngOutAccessPref | boolean | Indicates whether the API Only Users Can Access Only Salesforce APIs critical update is enforced (true) or not (false). This critical update is enforced in the Winter ‘20 release. See API Only Users Can Access Only Salesforce APIs (Critical Update, Enforced). |
| enableAuraCDNPref | boolean | Indicates whether Lightning Experience and other apps use a content delivery network (CDN) to serve the static content for Lightning Component framework. A CDN generally speeds up page load time, but it also changes the source domain that serves the files. If your company has IP range restrictions for content served from Salesforce, test thoroughly before enabling this setting. The default is true. |
| enableFeedbackInMobile | boolean | Indicates whether users can send feedback to Salesforce from the mobile app. The default is false. |
| enableIE11DeprecationMsgHidden | boolean | Deprecated in API version 47.0 and later because the feature is no longer available. |
| enableIE11LEXCrucPref | boolean | Deprecated in API version 47.0 and later because the feature is no longer available. |
| enableInAppTooltips | boolean | Indicates whether users see onboarding tips in the mobile app. The default is false. |
| enableLEXOnIpadEnabled | boolean | Indicates whether Lightning Experience is turned on for iPad Browsers (true) or not (false). The default is false. See Give Users Access to Lightning Experience on iPad Browsers (Beta) in Salesforce Help. |
| enableLexEndUsersNoSwitching | boolean | Indicates whether Salesforce Classic is turned off for your org (true) or not (false). Removes the Switcher for all users in the org. The default is false. See Turn Off Salesforce Classic for Your Org in Salesforce Help. This field is similar to enableUsersAreLightningOnly. If either field is set to true, users are blocked from switching to Salesforce Classic. |
| enableNavPersonalizationOptOut | boolean | Indicates whether users are blocked from personalizing the Lightning Experience navigation bar (true) or not (false). The default is false (that is, users can personalize the navigation bar by default). Salesforce recommends disabling personalization at the app level, not the org level. See Configure User Interface Settings in Salesforce Help. |
| enableRemoveThemeBrandBanner | boolean | Deprecated in API version 47.0 and later because the feature is no longer available. |
| enableS1BannerPref | boolean | Deprecated in API version 47.0 and later because the feature is no longer available. |
| enableS1BrowserEnabled | boolean | Indicates whether all users can access the Salesforce mobile web view from a supported mobile browser (true) or not (false). If false, then users must access the Salesforce mobile full site view from a mobile browser. Full site view doesn’t have the full functionality of mobile web view. Salesforce Classic and Lightning Experience aren’t supported on mobile browsers. |
| enableS1DesktopEnabled | boolean | Indicates whether Lightning Experience is turned on in the org (true) or not (false). After it is enabled, this setting can’t be disabled via the user interface or the API. See Turn on Lightning Experience for Your Org |
| enableS1UiLoggingEnabled | boolean | Deprecated in API version 47.0 and later because the feature is no longer available. |
| enableTryLightningOptOut | boolean | Indicates whether the Try Lightning Experience Now prompt is hidden from users (true) or not (false). The default is false. See Try Lightning Experience Now Prompt in Salesforce Help. |
| enableUseS1AlohaDesktop | boolean | Deprecated in API version 47.0 and later because the feature is no longer available. |
| enableUsersAreLightningOnly | boolean | Indicates whether Salesforce Classic is turned off for your org (true) or not (false). Removes the Switcher for all users in the org. The default is false. This field is similar to enableLexEndUsersNoSwitching. If either field is set to true, users are blocked from switching to Salesforce Classic. |
Declarative Metadata Sample Definition
The following is an example of a LightningExperienceSettings component.
1<?xml version="1.0" encoding="UTF-8"?>
2<LightningExperienceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <enableApiUserLtngOutAccessPref>true</enableApiUserLtngOutAccessPref>
4 <enableAuraCDNPref>true</enableAuraCDNPref>
5 <enableFeedbackInMobile>true</enableFeedbackInMobile>
6 <enableInAppTooltips>true</enableInAppTooltips>
7 <enableLEXOnIpadEnabled>true</enableLEXOnIpadEnabled>
8 <enableLexEndUsersNoSwitching>true</enableLexEndUsersNoSwitching>
9 <enableNavPersonalizationOptOut>true</enableNavPersonalizationOptOut>
10 <enableS1BrowserEnabled>false</enableS1BrowserEnabled>
11 <enableS1DesktopEnabled>true</enableS1DesktopEnabled>
12 <enableTryLightningOptOut>true</enableTryLightningOptOut>
13 <enableUsersAreLightningOnly>true</enableUsersAreLightningOnly>
14</LightningExperienceSettings>The following is an example package.xml that references the previous definition.
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>LightningExperience</members>
5 <name>Settings</name>
6 </types>
7 <version>47.0</version>
8</Package>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.