メタデータ API 開発者ガイド
jCommunityThemeDefinition
ファイルのサフィックスおよびディレクトリの場所
CommunityThemeDefinition コンポーネントのサフィックスは .communityThemeDefinition で、communityThemeDefinitions フォルダに保存されます。
バージョン
CommunityThemeDefinition コンポーネントは、API バージョン 38.0 以降で使用できます。
特別なアクセスルール
このオブジェクトは、組織で Salesforce Communities が有効になっている場合にのみ使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| customThemeLayoutType | CommunityCustomThemeLayoutType [ ] | テーマレイアウトで利用できるカスタムテーマレイアウト種別のリスト。この項目は、API バージョン 39.0 以降で使用できます。 |
| description | string | この CommunityThemeDefinition の説明テキスト (省略可能)。 |
| enableExtendedCleanupUpOnDelete | boolean | この CommunityThemeDefinition を削除すると、直接的または間接的に参照される他のオブジェクト (FlexiPage など) が自動的に削除されます。 |
| masterLabel | string | 必須。[設定] に表示されるこの CommunityThemeDefinition の表示ラベル。 |
| themeSetting | CommunityThemeSetting [ ] | 必須。この CommunityThemeDefinition の設定のリスト。 |
CommunityCustomThemeLayoutType
| 項目名 | データ型 | 説明 |
|---|---|---|
| description | string | カスタムテーマレイアウト種別の説明。 |
| label | string | 必須。カスタムテーマレイアウト種別の名前。値 Inner、Home、および Login は予約されています。 |
CommunityThemeSetting
| 項目名 | データ型 | 説明 |
|---|---|---|
| customThemeLayoutType | string | themeLayoutType が指定されていない場合は必須です。テーマレイアウトに関連付けられたカスタムテーマレイアウト種別。この項目と themeLayoutType は相互に排他的で、両方を指定することはできません。この項目は、API バージョン 39.0 以降で使用できます。 |
| themeLayout | string | 必須。このテーマの設定およびレイアウト。 |
| themeLayoutType | CommunityThemeLayoutType (string 型の列挙) | customThemeLayoutType が指定されていない場合は必須です。テーマレイアウトに関連付けられたデフォルトテーマレイアウト種別。有効な値は、Inner、Home、または Login です。この項目と customThemeLayoutType は相互に排他的で、両方を指定することはできません。 |
宣言的なメタデータの定義のサンプル
CommunityThemeDefinition コンポーネントの例を次に示します。
1<CommunityThemeDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
2 <enableExtendedCleanUpOnDelete>true</enableExtendedCleanUpOnDelete>
3 <masterLabel>ax_theme</masterLabel>
4 <themeSetting>
5 <themeLayout>ax_theme_napili_themeLayout_home</themeLayout>
6 <themeLayoutType>Inner</themeLayoutType>
7 </themeSetting>
8</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>MyTheme</members>
5 <name>CommunityThemeDefinition</name>
6 </types>
7 <version>42.0</version>
8</Package>