Template Configuration リソース

• Aura — <wave:sdk> getTemplateConfig()

次の JSON はレスポンスボディの例です。

1{
2  "ui": {
3    "pages": [
4      {
5        "title": "Application Preferences",
6        "variables": [
7          "lensDashboardName",
8          "dashboardHeader"
9         ]
10      },
11      {
12      "title": "Other preferences",
13      "variables": [
14        "emailNotifications",
15        "emailAddress"
16       ]
17      }
18    ]
19  },
20  "variables": {
21    "numberPicked": {
22      "defaultValue": 3,
23      "description": "A number between 1 and 10.",
24      "excludeSelected": false,
25      "excludes": [],
26      "label": "Please pick a number between 1 and 10?",
27      "required": true,
28      "variableType": {
29        "enums": [],
30        "max": 10,
31        "min": 1,
32        "type": "NumberType"
33      }
34    },
35    "lensDashboardName": {
36      "defaultValue": "My View of Election Data",
37      "description": "The name of the sample lens.",
38      "excludeSelected": false,
39      "excludes": [],
40      "label": "What would you like to name your lens and dashboard?",
41      "required": true,
42      "variableType": {
43        "type": "StringType"
44      }
45    },
46    "dashboardHeader": {
47      "defaultValue": "Wow! Interactive Dashboards are Nice!",
48      "description": "The dashboard header.",
49      "excludeSelected": false,
50      "excludes": [],
51      "label": "What would you like the dashboard header to say?",
52      "required": true,
53      "variableType": {
54        "enums": [],
55        "type": "StringType"
56      }
57    },
58    "emailNotifications": {
59      "defaultValue": "Yes",
60      "description": "Email notifications",
61      "excludeSelected": false,
62      "excludes": [],
63      "label": "Would you like to receive emails for promotions?",
64      "required": false,
65      "variableType": {
66        "enums": ["Yes","No"],
67        "type": "StringType"
68      }
69    },
70    "emailAddress": {
71      "defaultValue": null,
72      "description": "Your email address.",
73      "excludeSelected": false,
74      "excludes": [],
75      "label": "Please enter your email address?",
76      "required": false,
77      "variableType": {
78        "enums": [],
79        "type": "StringType"
80      }
81    }
82  }
83}

UiDefinitionRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
display​Messages	Display​Message​Representation[]	このテンプレート設定の表示メッセージ。	Small、36.0	36.0
pages	Page​Representation[]	このテンプレート設定のページコレクション。	Small、36.0	36.0

DisplayMessageRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
location	String	テキストが表示されるページの名前。	Small、36.0	36.0
text	String	表示するテキストコンテンツ。	Small、36.0	36.0

PageRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
condition	String	ページが表示されるかどうかを決定する条件 (省略可能)。値はクライアント側 EL 表記です (例: {{Variables.selectedOption}})。	Small、36.0	36.0
help​Url	String	このページのヘルプ Web ページへの URL。	Small、36.0	36.0
title	String	ページのタイトル。	Small、36.0	36.0
variables	Page​Variable​Representation[]	このテンプレート設定の変数のコレクション。	Small、36.0	36.0
vfPage	Asset​Reference​Representation	標準ウィザードインターフェースの代わりにウィザードのユーザインターフェースとして使用する Visualforce ページ。	Small、40.0	40.0

PageVariableRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
name	String	変数の名前。	Small、36.0	36.0
visibility	String	この変数の表示の表記。	Small、36.0	36.0

VariableDefinitionRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
computed​Value	Object	変数の計算値。この値は、統合された Apex 実装によって設定されます。	Small、38.0	38.0
default​Value	Object	変数のデフォルト値。	Small、36.0	36.0
description	String	変数の説明。	Small、36.0	36.0
exclude​Selected	Boolean	すでに選択されている値をこの変数で除外するか否かを示します。	Small、36.0	36.0
excludes	String []	変数選択から除外する値のリスト。	Small、36.0	36.0
label	String	変数の表示ラベル。	Small、36.0	36.0
most​Recent​Value	Object	最新のアプリケーション作成プロセスで指定された値。	Small、36.0	36.0
required	Boolean	変数が必須か否かを示します。	Small、36.0	36.0
variable​Type	Variable​Type​Representation	変数の型。有効な変数種別は、次のとおりです。 Array​Type​Representation Boolean​Type​Representation ConnectorTypeRepresentation Dataset​Any​Field​Type​Representation Dataset​Date​Type​Representation Dataset​Dimension​Type​Representation Dataset​Measure​Type​Representation Dataset​Type​Representation Date​Time​Type​Representation Number​Type​Representation Object​Type​Representation SObject​Field​Type​Representation SObject​Type​Representation String​Type​Representation	Small、36.0	36.0

ArrayTypeRepresentation は、抽象 VariableTypeRepresentation からプロパティを継承します。これらの基本プロパティは、ArrayTypeRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。

BooleanTypeRepresentation は、抽象 VariableTypeRepresentation からプロパティを継承します。これらの基本プロパティは、BooleanTypeRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。

ConnectorTypeRepresentation は、抽象 VariableTypeRepresentation からプロパティを継承します。これらの基本プロパティは、ConnectorTypeRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。

DatasetAnyFieldTypeRepresentation は、抽象 BaseObjectTypeRepresentation からプロパティを継承します。

DatasetDateTypeRepresentation は、抽象 BaseObjectTypeRepresentation からプロパティを継承します。

DatasetDimensionTypeRepresentation は、抽象 BaseObjectTypeRepresentation からプロパティを継承します。

DatasetMeasureTypeRepresentation は、抽象 BaseObjectTypeRepresentation からプロパティを継承します。

DatasetTypeRepresentation は、抽象 BaseObjectTypeRepresentation からプロパティを継承します。

DateTimeTypeRepresentation は、抽象 VariableTypeRepresentation からプロパティを継承します。

NumberTypeRepresentation は、抽象 VariableTypeRepresentation からプロパティを継承します。これらの基本プロパティは、NumberTypeRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。

ObjectTypeRepresentation は、抽象 BaseObjectTypeRepresentation からプロパティを継承します。

SObjectFieldTypeRepresentation は、抽象 BaseObjectTypeRepresentation からプロパティを継承します。これらの基本プロパティは、SObjectFieldTypeRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。

SObjectTypeRepresentation は、抽象 BaseObjectTypeRepresentation からプロパティを継承します。

StringTypeRepresentation は、抽象 VariableTypeRepresentation からプロパティを継承します。これらの基本プロパティは、StringTypeRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。

BaseObjectTypeRepresentation は、抽象 VariableTypeRepresentation からプロパティを継承します。これらの基本プロパティは、BaseObjectTypeRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。