メタデータ API 開発者ガイド
jLightningExperienceSettings
パッケージマニフェストでは、Settings の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は、「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
LightningExperienceSettings コンポーネントのサフィックスは .settings であり、settings フォルダーに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
LightningExperienceSettings コンポーネントは、API バージョン 47.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| activeThemeName | string | 組織で現在有効なテーマの名前を指定します。この項目は、API バージョン 48.0 以降で使用できます。 |
| enableAccessCheckCrucPref | boolean | この機能は使用できなくなったため、API バージョン 47.0 以降では廃止されました。 |
| enableApiUserLtngOutAccessPref | boolean | この機能は使用できなくなったため、API バージョン 48.0 以降では廃止されました。この項目は、Spring ’20 で適用された重要な更新「API 限定ユーザーは Salesforce API のみでアクセス可能」に対応します。「API 限定ユーザー」権限を持つユーザーが、その他の権限に関係なく、API 経由でのみ Salesforce にアクセスできるようになります。この制限はすでに他の Salesforce 機能に適用されていますが、重要な更新では Lightning Out にも制限が適用されました。 |
| enableAuraCDNPref | boolean | Lightning Experience やその他のアプリケーションが、Lightning コンポーネントフレームワークの静的コンテンツを提供するコンテンツ配信ネットワーク (CDN) を使用するかどうかを示します。通常、CDN を使用するとページの読み込み時間が短縮されますが、ファイルを提供する提供元ドメインも変わります。会社で Salesforce から提供されるコンテンツの IP 範囲を制限している場合、この設定を有効にする前に徹底的にテストします。デフォルトは true です。 |
| enableAuraDepAccessChksCRUCPref | boolean | この機能は使用できなくなったため、API バージョン 51.0 以降では削除されました。 |
| enableAuraSecStaticResCRUCPref | boolean | リリース更新「Lightning コンポーネントの安全な静的リソースの有効化」が適用されるか (true)、否か (false) を示します。セキュリティを向上するため、この更新ではすべての静的リソースが lightning ドメインではなく visualforce ドメインから提供されます。この変更により、静的リソースに含まれるスクリプトは、同一生成元セキュリティポリシーのために、lightning ドメイン内のドキュメントにアクセスできなくなります。この項目は、API バージョン 50.0 以降で使用できます。 |
| enableFeedbackInMobile | boolean | ユーザーがモバイルアプリケーションから Salesforce にフィードバックを送信できるかどうかを示します。デフォルトは false です。 |
| enableGoogleSheetsForSfdcEnabled | boolean | 予約されています。使用しません。 |
| enableIE11DeprecationMsgHidden | boolean | この機能は使用できなくなったため、API バージョン 47.0 以降では廃止されました。 |
| enableIE11LEXCrucPref | boolean | この機能は使用できなくなったため、API バージョン 47.0 以降では廃止されました。 |
| enableInAppTooltips | boolean | ユーザーのモバイルアプリケーションにオンボーディングに関するヒントを表示するかどうかを示します。デフォルトは false です。 |
| enableLEXOnIpadEnabled | boolean | Lightning Experience が iPad ブラウザーに対して有効化されているか (true)、否か (false) を示します。デフォルトは false です。Salesforce ヘルプの「iPad ブラウザー (ベータ) の Lightning Experience へのアクセス権をユーザーに付与」を参照してく���さい。 |
| enableLexEndUsersNoSwitching | boolean | 組織で Salesforce Classic が無効になっているか (true)、否か (false) を示します。組織の全ユーザーのスイッチャーを削除します。デフォルトは false です。Salesforce ヘルプの「組織の Salesforce Classic の無効化」を参照してください。この項目は enableUsersAreLightningOnly と似ています。いずれかの項目が true に設定されている場合、ユーザーの Salesforce Classic への切り替えがブロックされます。 |
| enableNavPersonalizationOptOut | boolean | ユーザーによる Lightning Experience ナビゲーションバーのパーソナライズがブロックされるか (true)、否か (false) を示しています。デフォルトは false です (つまり、ユーザーはデフォルトでナビゲーションバーをパーソナライズできます)。Salesforce では、組織レベルではなく、アプリケーションレベルでナビゲーションのパーソナライズを無効にすることをお勧めしています。Salesforce ヘルプの「ユーザーインターフェースの設定」を参照してください。 |
| enableNoBackgroundNavigations | boolean | Visualforce ページでの連続する API ナビゲーションコールが許可されるか (false)、ブロックされるか (true) を示します。デフォルトは false です。 |
| enableQuip | boolean | 組織で Quip が使用可能かどうかを示します。この項目は、API バージョン 51.0 以降で利用できます。 |
| enableRemoveThemeBrandBanner | boolean | この機能は使用できなくなったため、API バージョン 47.0 以降では廃止されました。 |
| enableS1BannerPref | boolean | この機能は使用できなくなったため、API バージョン 47.0 以降では廃止されました。 |
| enableS1BrowserEnabled | boolean | すべてのユーザーが、サポート対象のモバイルブラウザーから Salesforce モバイル Web ビューにアクセスできるか (true)、否か (false) を示します。false の場合、ユーザーはモバイルブラウザーから Salesforce モバイルフルサイトビューにアクセスする必要があります。フルサイトビューでは、モバイル Web ビューの一部の機能を使用できません。Salesforce Classic と Lightning Experience はモバイルブラウザーではサポートされていません。 |
| enableSkypeChatEnabled | boolean | この機能は使用できなくなったため、API バージョン 50.0 以降では廃止されました。 |
| enableS1DesktopEnabled | boolean | 組織で Lightning Experience が有効化されているか (true)、否か (false) を示します。有効化されると、この設定をユーザーインターフェースや API によって無効にすることはできません。「組織の Lightning Experience の有効化」を参照してください。 |
| enableS1UiLoggingEnabled | boolean | この機能は使用できなくなったため、API バージョン 47.0 以降では廃止されました。 |
| enableSparkAllUsers | boolean | この機能は使用できなくなったため、API バージョン 50.0 以降では廃止されました。 |
| enableSparkConversationEnabled | boolean | この機能は使用できなくなったため、API バージョン 50.0 以降では廃止されました。 |
| enableSplitViewOnStandard | boolean | この機能は使用できなくなったため、API バージョン 52.0 以降では削除されました。 |
| enableTryLightningOptOut | boolean | 「今すぐ Lightning Experience を試そう」プロンプトがユーザーに非表示であるか (true)、否か (false) を示します。デフォルトは false です。Salesforce ヘルプの「「今すぐ Lightning Experience を試そう」プロンプト」を参照してください。 |
| enableUseS1AlohaDesktop | boolean | この機能は使用できなくなったため、API バージョン 47.0 以降では廃止されました。 |
| enableUsersAreLightningOnly | boolean | 組織で Salesforce Classic が無効になっているか (true)、否か (false) を示します。組織の全ユーザーのスイッチャーを削除します。デフォルトは false です。この項目は enableLexEndUsersNoSwitching と似ています。いずれかの項目が true に設定されている場合、ユーザーの Salesforce Classic への切り替えがブロックされます。 |
| enableWebExEnabled | boolean | この機能は使用できなくなったため、API バージョン 50.0 以降では廃止されました。 |
| enableWebexAllUsers | boolean | この機能は使用できなくなったため、API バージョン 50.0 以降では廃止されました。 |
| isLEXExtensionComponentCustomizationOff | boolean | すべてのユーザーが Lightning Extension のコンポーネントのカスタマイズ機能を有効化できるかどうかを示します。false の場合、この機能は、すべてのユーザーに対して無効化されます。これは、有効になっていたユーザーにも適用されます。「Chrome 向け Lightning 拡張機能を使用して新機能を試す」を参照してください。この項目は、API バージョン 48.0 以降で使用できます。 |
| isLEXExtensionDarkModeOff | boolean | すべてのユーザーが Lightning Extension のダークモード���能を有効化できるかどうかを示します。false の場合、この機能は、すべてのユーザーに対して無効化されます。これは、有効になっていたユーザーにも適用されます。この項目は、API バージョン 48.0 以降で使用できます。 |
| isLEXExtensionLinkGrabberOff | boolean | すべてのユーザーが Lightning Extension のリンクグラバー機能を有効化できるかどうかを示します。false の場合、この機能は、すべてのユーザーに対して無効化されます。これは、有効になっていたユーザーにも適用されます。この項目は、API バージョン 48.0 以降で使用できます。 |
| isLEXExtensionOff | boolean | すべてのユーザーが組織に対して Lightning Extension を有効化できるかどうかを示します。false の場合、ユーザーは Lightning Extension を有効化できません。これは、Lightning Extension をインストール済みの場合でも同様です。この項目は、API バージョン 48.0 以降で使用できます。 |
宣言的なメタデータの定義のサンプル
LightningExperienceSettings コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<LightningExperienceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3
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>前の定義を参照する package.xml の例を次に示します。
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>マニフェストファイル内のワイルドカードのサポート
package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。