メタデータ API 開発者ガイド
jCommunityThemeDefinition
ファイルのサフィックスおよびディレクトリの場所
CommunityThemeDefinition コンポーネントのサフィックスは .communityThemeDefinition で、communityThemeDefinitions フォルダに保存されます。
バージョン
CommunityThemeDefinition コンポーネントは、API バージョン 38.0 以降で使用できます。
特別なアクセスルール
この型は、組織で Salesforce コミュニティが有効になっている場合にのみ使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| bundlesInfo | CommunityThemeBundleInfo [ ] | 指定されている場合、少なくとも 1 つのプレビュー画像と 1 つの強調表示が必要です。API バージョン 44.0 以降で使用できます。 |
| customThemeLayoutType | CommunityCustomThemeLayoutType [ ] | テーマレイアウトで利用できるカスタムテーマレイアウト種別のリスト。 |
| defaultBrandingSet | string | エクスペリエンスビルダーの [ブランド] パネルで定義される、この CommunityThemeDefinition に関連付けられた一連のブランドプロパティ。API バージョン 44.0 以降で利用できます。 |
| description | string | この CommunityThemeDefinition の説明テキスト (省略可能)。 |
| enableExtendedCleanupUpOnDelete | boolean | デフォルトは false です。この CommunityThemeDefinition を削除した場合に、直接的または間接的に参照される他のオブジェクト (FlexiPage など) を自動的に削除するかどうかを決定します。値は true または false です。 |
| masterLabel | string | 必須。[設定] に表示されるこの CommunityThemeDefinition の表示ラベル。 |
| themeRouteOverride | CommunityThemeRouteOverride [ ] | FlexiPage (現在はホームのみ) でのテーマレイアウト種別の上書きのリスト。API バージョン 44.0 以降で利用できます。 |
| themeSetting | CommunityThemeSetting [ ] | 必須。この CommunityThemeDefinition の設定のリスト。 |
CommunityThemeBundleInfo
| 項目名 | データ型 | 説明 |
|---|---|---|
| description | string | その CommunityThemeBundleInfo の説明テキスト (省略可能)。 |
| image | string | type が PreviewImage の場合にのみ必須です。それ以外の場合、この項目は省略可能です。この CommunityThemeDefinition のプレビュー画像。 |
| order | int | 必須。その CommunityThemeDefinition 内の同じ型の他の要素に対するこの CommunityThemeBundleInfo の位置を指定する整数。1 は最初の位置、3 は PreviewImage 型の最大位置、4 は Highlight 型の最大位置です。 |
| title | string | 必須。コードで使用されるこの CommunityThemeBundleInfo のタイトル。 |
| type | CommunityTemplateBundleInfoType (string 型の列挙) | 必須。エクスポートに含まれるテーマに関する説明情報を格納します。有効な値は、次のとおりです。
|
CommunityCustomThemeLayoutType
| 項目名 | データ型 | 説明 |
|---|---|---|
| description | string | カスタムテーマレイアウト種別の説明。 |
| label | string | 必須。カスタムテーマレイアウト種別の名前。値 Inner、Home、および Login は予約されています。 |
CommunityThemeRouteOverride
| 項目名 | データ型 | 説明 |
|---|---|---|
| customThemeLayoutType | string | themeLayoutType が指定されていない場合は必須です。テーマレイアウトに関連付けられたカスタムテーマレイアウト種別を提供します。この項目と themeLayoutType は相互に排他的で、両方を指定することはできません。 |
| themeLayoutType | CommunityThemeLayoutType (string 型の列挙) | customThemeLayoutType が指定されていない場合は必須です。テーマレイアウトに関連付けられたデフォルトのテーマレイアウト種別を提供します。有効な値は、Inner、Home、または Login です。この項目と customThemeLayoutType は相互に排他的で、両方を指定することはできません。 |
| pageAttributes | string | 必須。デフォルトのテーマレイアウト種別が上書きされるコミュニティページの属性を指定します。有効な値は {"PageName":"Home"} のみです。 |
| pageType | string |
必須。デフォルトのテーマレイアウト種別が上書きされるコミュニティページの種別を指定します。有効な値は comm__standardPage のみです。 |
CommunityThemeSetting
| 項目名 | データ型 | 説明 |
|---|---|---|
| customThemeLayoutType | string | themeLayoutType が指定されていない場合は必須です。テーマレイアウトに関連付けられたカスタムテーマレイアウト種別。この項目と themeLayoutType は相互に排他的で、両方を指定することはできません。 |
| themeLayout | string | 必須。このテーマの設定およびレイアウト。 |
| themeLayoutType | CommunityThemeLayoutType (string 型の列挙) | customThemeLayoutType が指定されていない場合は必須です。テーマレイアウトに関連付けられたデフォルトテーマレイアウト種別。有効な値は、Inner、Home、または Login です。この項目と customThemeLayoutType は相互に排他的で、両方を指定することはできません。 |
宣言的なメタデータの定義のサンプル
CommunityThemeDefinition コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<CommunityThemeDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3 <bundlesInfo>
4 <description>Batman Feature1 description</description>
5 <order>1</order>
6 <title>Batman Feature1</title>
7 <type>Highlight</type>
8 </bundlesInfo>
9 <bundlesInfo>
10 <image>siteAsset_d90e2d5ce4cf4d8899e233c051091246</image>
11 <order>1</order>
12 <title>siteAsset_d90e2d5ce4cf4d8899e233c051091246</title>
13 <type>PreviewImage</type>
14 </bundlesInfo>
15 <defaultBrandingSet>Batman</defaultBrandingSet>
16 <description>Batman theme</description>
17 <enableExtendedCleanUpOnDelete>true</enableExtendedCleanUpOnDelete>
18 <masterLabel>Batman</masterLabel>
19 <themeRouteOverride>
20 <pageAttributes>{"PageName":"Home"}</pageAttributes>
21 <pageType>comm__standardPage</pageType>
22 <themeLayoutType>Home</themeLayoutType>
23 </themeRouteOverride>
24 <themeSetting>
25 <themeLayout>Batman_themeLayout_Login</themeLayout>
26 <themeLayoutType>Login</themeLayoutType>
27 </themeSetting>
28 <themeSetting>
29 <themeLayout>Batman_themeLayout_Home</themeLayout>
30 <themeLayoutType>Home</themeLayoutType>
31 </themeSetting>
32 <themeSetting>
33 <themeLayout>Batman_themeLayout_Default</themeLayout>
34 <themeLayoutType>Inner</themeLayoutType>
35 </themeSetting>
36</CommunityThemeDefinition>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>Batman</members>
5 <name>BrandingSet</name>
6 </types>
7 <types>
8 <members>Batman</members>
9 <name>CommunityThemeDefinition</name>
10 </types>
11 <types>
12 <members>Batman_themeLayout_Default</members>
13 <members>Batman_themeLayout_Home</members>
14 <members>Batman_themeLayout_Login</members>
15 <name>FlexiPage</name>
16 </types>
17 <types>
18 <members>siteAsset_d90e2d5ce4cf4d8899e233c051091246</members>
19 <name>StaticResource</name>
20 </types>
21 <version>44.0</version>
22</Package>