メタデータ API 開発者ガイド
jCommunityTemplateDefinition
ファイルのサフィックスおよびディレクトリの場所
CommunityTemplateDefinition コンポーネントのサフィックスは .communityTemplateDefinition で、communityTemplateDefinitions フォルダに保存されます。
バージョン
CommunityTemplateDefinition コンポーネントは、API バージョン 38.0 以降で使用できます。
特別なアクセスルール
このオブジェクトは、組織で Salesforce Communities が有効���なっている場合にのみ使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| bundlesInfo | CommunityTemplateBundleInfo [ ] | 必須。この CommunityTemplateDefinition のプレビュー画像および機能の説明のリスト。 |
| category | CommunityTemplateCategory (string 型の列挙) | 必須。この CommunityTemplateDefinition の最適化された使用事例。有効な値は、次のとおりです。
|
| defaultThemeDefinition | string | 必須。この CommunityTemplateDefinition の割り当てられたテーマ定義。 |
| description | string | この CommunityTemplateDefinition の説明テキスト (省略可能)。 |
| enableExtendedCleanupUpOnDelete | boolean | この CommunityTemplateDefinition を削除すると、直接的または間接的に参照される他のオブジェクト (CommunityThemeDefinition、Flexipage、または StaticResource など) が自動的に削除されます。 |
| masterLabel | string | 必須。[設定] に表示されるこの CommunityTemplateDefinition の表示ラベル。 |
| pageSetting | CommunityTemplatePageSetting [ ] | 必須。この CommunityTemplateDefinition の FlexiPage のリスト。 |
CommunityTemplateBundleInfo
| 項目名 | データ型 | 説明 |
|---|---|---|
| description | string | その CommunityTemplateBundleInfo の説明テキスト (省略可能)。 |
| image | string | type が PreviewImage の場合にのみ必須です。それ以外の場合、この項目は省略可能です。この CommunityTemplateDefinition のプレビュー画像。 |
| order | int | 必須。その CommunityTemplateDefinition 内の同じ型の他の要素に対するこの CommunityTemplateBundleInfo の位置を指定する整数。1 は最初の位置、3 は PreviewImage 型の最大位置、4 は Highlight 型の最大位置です。 |
| title | string | 必須。コードで使用されるこの CommunityTemplateBundleInfo のタイトル。 |
| type | CommunityTemplateBundleInfoType (string 型の列挙) | 必須。エクスポートに含まれるテンプレートに関する説明情報を格納します (現在は、機能およびプレビュー画像のみ)。コミュニティ作成ウィザードの UI は、テンプレートによって強化されます。有効な値は、次のとおりです。
|
宣言的なメタデータの定義のサンプル
CommunityTemplateDefinition コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<CommunityTemplateDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3 <bundlesInfo>
4 <description>ax</description>
5 <order>1</order>
6 <title>ax</title>
7 <type>Highlight</type>
8 </bundlesInfo>
9 <bundlesInfo>
10 <image>siteAsset_6b1cf63e4d604d16bb98b84636ab1932</image>
11 <order>1</order>
12 <title>siteAsset_6b1cf63e4d604d16bb98b84636ab1932</title>
13 <type>PreviewImage</type>
14 </bundlesInfo>
15 <category>Sales</category>
16 <defaultThemeDefinition>ax</defaultThemeDefinition>
17 <description>ax</description>
18 <enableExtendedCleanUpOnDelete>true</enableExtendedCleanUpOnDelete>
19 <masterLabel>ax</masterLabel>
20 <pageSetting>
21 <page>ax_Record_List</page>
22 </pageSetting>
23 <pageSetting>
24 <page>ax_Topic_Catalog</page>
25 </pageSetting>
26 <pageSetting>
27 <page>ax_User_Settings</page>
28 </pageSetting>
29 <pageSetting>
30 <page>ax_Error</page>
31 </pageSetting>
32 <pageSetting>
33 <page>ax_Group_Detail</page>
34 </pageSetting>
35 <pageSetting>
36 <page>ax_Sfdc_Page</page>
37 </pageSetting>
38 <pageSetting>
39 <page>ax_Related_Record_List</page>
40 </pageSetting>
41 <pageSetting>
42 <page>ax_User_Profile</page>
43 </pageSetting>
44 <pageSetting>
45 <page>ax_Record_Detail</page>
46 </pageSetting>
47 <pageSetting>
48 <page>ax_Group_List</page>
49 </pageSetting>
50 <pageSetting>
51 <page>ax_Search</page>
52 </pageSetting>
53 <pageSetting>
54 <page>ax_Create_Record</page>
55 </pageSetting>
56 <pageSetting>
57 <page>ax_Question_Detail</page>
58 </pageSetting>
59 <pageSetting>
60 <page>ax_Home</page>
61 </pageSetting>
62 <pageSetting>
63 <page>ax_Topic_Detail</page>
64 </pageSetting>
65 <pageSetting>
66 <page>ax_Report</page>
67 </pageSetting>
68 <pageSetting>
69 <page>ax_Feed_Detail</page>
70 </pageSetting>
71 <pageSetting>
72 <page>ax_Contact_Support</page>
73 </pageSetting>
74</CommunityTemplateDefinition>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>MyTemplate</members>
5 <name>CommunityTemplateDefinition</name>
6 </types>
7 <version>39.0</version>
8</Package>