メタデータ API 開発者ガイド
jLightningExperienceTheme
BrandingSet を含む、カスタムテーマの詳細を表します。テーマを使用して、システム管理者は設定可能な属性 (3 個の色と 5 個の画像など) を指定できます。色と一部の画像は SLDS トークン値を上書きし、app.css の生成に影響します。
ファイルのサフィックスおよびディレクトリの場所
LightningExperienceTheme コンポーネントのサフィックスは .lightningExperienceTheme で、lightningExperienceThemes フォルダに保存されます。
バージョン
LightningExperienceTheme コンポーネントは、API バージョン 42.0 以降で使用できます。
特別なアクセスルール
LightningExperieceTheme 型は、組織で S1DesktopAllowed 権限が有効になっている場合にのみ使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| defaultBrandingSet | string | 必須。LightningExperienceTheme に関連付けられた BrandingSet プロパティの ID。 |
| description | string | この LightningExperienceTheme の説明テキスト (省略可能)。最大 1000 文字です。 |
| masterLabel | string | 必須。[設定] に表示されるこの LightningExperienceTheme の表示ラベル。最大 70 文字です。 |
| shouldOverrideLoadingImage | boolean | true の場合、LightningExperienceTheme でスプラッシュスクリーンの画像が上書きされます。 |
宣言的なメタデータの定義のサンプル
LightningExperienceTheme コンポーネントの例を次に示します。BrandingSet コンポーネントの例は、「BrandingSet」を参照してください。
1<?xml version="1.0" encoding="UTF-8"?>
2<LightningExperienceTheme xmlns="http://soap.sforce.com/2006/04/metadata">
3 <defaultBrandingSet>SummerCelebrationBrand</defaultBrandingSet>
4 <description>Theme for summer celebration week.</description>
5 <masterLabel>Summer Celebration</masterLabel>
6 <shouldOverrideLoadingImage>false</shouldOverrideLoadingImage>
7</LightningExperienceTheme>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>LEXTHEMINGThemeName</members>
5 <name>BrandingSet</name>
6 </types>
7 <types>
8 <members>Summer Celebration</members>
9 <name>LightningExperienceTheme</name>
10 </types>
11 <version>42.0</version>
12</Package>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。