メタデータ API 開発者ガイド
jCommunityThemeDefinition
ファイルのサフィックスおよびディレクトリの場所
CommunityThemeDefinition コンポーネントのサフィックスは .communityThemeDefinition で、communityThemeDefinitions フォルダに保存されます。
バージョン
CommunityThemeDefinition コンポーネントは、API バージョン 38.0 以降で使用できます。
特別なアクセスルール
この型は、組織で Salesforce コミュニティが有効になっている場合にのみ使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| bundlesInfo | CommunityThemeBundleInfo [ ] | 指定されている場合、少なくとも 1 つのプレビュー画像と 1 つの強調表示が必要です。プレビュー画像は最大 3 件、強調表示は最大 4 件がサポートされます。API バージョン 44.0 以降で使用できます。 |
| customThemeLayoutType | CommunityCustomThemeLayoutType [ ] | テーマレイアウトで利用できるカスタムテーマレイアウト種別のリスト。 |
| defaultBrandingSet | string | エクスペリエンスビルダーの [ブランド] パネルで定義される、この CommunityThemeDefinition に関連付けられた一連のブランドプロパティ。API バージョン 44.0 以降で利用できます。 |
| description | string | この CommunityThemeDefinition の説明テキスト (省略可能)。 |
| enableExtendedCleanUpOnDelete | boolean | デフォルトは false です。この CommunityThemeDefinition を削除した場合に、直接的または間接的に参照される他のオブジェクト (FlexiPage など) を自動的に削除するかどうかを決定します。値は true または false です。 |
| masterLabel | string | 必須。[設定] に表示されるこの CommunityThemeDefinition の表示ラベル。 |
| publisher | string | コミュニティ作成ウィザードで表示されるパブリッシャーの名前を定義します。名前が指定されていない場合、パッケージのエクスポート元組織の名前が使用されます。 この項目は、API バージョン 45.0 以降で使用できます。 |
| 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 は相互に排他的で、両方を指定することはできません。 |
| pageAttributes | string | 必須。デフォルトのテーマレイアウト種別が上書きされるコミュニティページの属性を指定します。有効な値は {"PageName":"Home"} のみです。 |
| pageType | string |
必須。デフォルトのテーマレイアウト種別が上書きされるコミュニティページの種別を指定します。有効な値は comm__standardPage のみです。 |
| themeLayoutType | CommunityThemeLayoutType (string 型の列挙) | customThemeLayoutType が指定されていない場合は必須です。テーマレイアウトに関連付けられたデフォルトのテーマレイアウト種別を提供します。有効な値は、Inner、Home、または Login です。この項目と customThemeLayoutType は相互に排他的で、両方を指定することはできません。 |
CommunityThemeSetting
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| customThemeLayoutType | string | themeLayoutType が指定されていない場合は必須です。テーマレイアウトに関連付けられたカスタムテーマレイアウト種別。この項目と themeLayoutType は相互に排他的で、両方を指定することはできません。 |
| themeLayout | string | 必須。このテーマの設定およびレイアウト。 |
| themeLayoutType | CommunityThemeLayoutType (string 型の列挙) | customThemeLayoutType が指定されていない場合は必須です。テーマレイアウトに関連付けられたデフォルトテーマレイアウト種別。有効な値は、Inner、Home、または Login です。この項目と customThemeLayoutType は相互に排他的で、両方を指定することはできません。 |
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。