Interface
This interface defines the experience config structure.
Properties
| Property | Type | Notes |
|---|---|---|
__not_publish | boolean | Only newly created experience (unpublished) configurations have this property. |
connections | Connection[] | Configure multiple portal connection information |
controllerPanels | ControllerPanelsJson | Floating panels for controller widget |
dataSources | DataSourcesJson | Data sources within an experience |
dialogs | DialogsJson | Windows (dialogs) within an experience |
exbVersion | string | The framework version when the experience is created/updated. |
footer | FooterJson | The footer of an experience |
forBuilderAttributes | ForBuilderAttributes | These attributes are used by builder only. |
header | HeaderJson | The header of an experience |
historyLabels | HistoryLabels | History labels are saved here because the labels may be used in URL. This can avoid link broken. This is done while publishing, which means all labels in the published app will be saved here. |
layouts | LayoutsJson | Layouts within an experience |
mainSizeMode | BrowserSizeMode | User can configure an experience for multiple size modes, and the default size mode is saved here. The config user interface is not available yet. |
messageConfigs | MessagesJson | The message configs of an experience |
name | string | Because one app can have multiple config.json, we add a name to identify the config. |
originExbVersion | string | As the |
pages | PagesJson | Pages within an experience |
pageStructure | {}[] | The structure of pages |
preloadWidgets | string[] | The widgets uri in this array will be loaded when the app loads, rather than dynamically loading the widget. |
publishTimestamp | string | This property will be set when publishing. |
screenGroups | ScreenGroupsJson | Screen groups within an experience |
screens | ScreensJson | Screens within an experience |
sections | SectionsJson | Sections within an experience |
template | string | The template that an experience created from. |
theme | string | The theme uri, should end with "/". |
timestamp | string | UTC timestamp for specific app config version. It's used for app's update. |
useAutoSortInFixedLayout | boolean | Whether adjust tab order automatically in the fixed layout. |
useCachedManifest | boolean | If true, will read widget's manifest from |
views | ViewsJson | Views within an experience |
widgets | WidgetsJson | Widgets within an experience |
widgetsManifest | {} | The manifest here are raw manifest, need to be processed before use. We save raw manifest here to save some network requests. |
__not_publish
Interface Property__not_publish: booleanOnly newly created experience (unpublished) configurations have this property.
connections
connections: Connection[]Configure multiple portal connection information
controllerPanels
Interface PropertycontrollerPanels: ControllerPanelsJsonFloating panels for controller widget
exbVersion
Interface PropertyexbVersion: stringThe framework version when the experience is created/updated.
When an old experience is opened in a new version code, this version will be set as the new code version.
forBuilderAttributes
Interface PropertyforBuilderAttributes: ForBuilderAttributesThese attributes are used by builder only.
historyLabels
Interface PropertyhistoryLabels: HistoryLabelsHistory labels are saved here because the labels may be used in URL. This can avoid link broken. This is done while publishing, which means all labels in the published app will be saved here.
mainSizeMode
Interface PropertymainSizeMode: BrowserSizeModeUser can configure an experience for multiple size modes, and the default size mode is saved here. The config user interface is not available yet.
messageConfigs
messageConfigs: MessagesJsonThe message configs of an experience
name
Interface Propertyname: stringBecause one app can have multiple config.json, we add a name to identify the config.
originExbVersion
Interface PropertyoriginExbVersion: stringAs the exbVersion will be replaced with the code version when app is launched, we save the origin version
in config here.
preloadWidgets
preloadWidgets: string[]The widgets uri in this array will be loaded when the app loads, rather than dynamically loading the widget.
publishTimestamp
publishTimestamp: stringThis property will be set when publishing.
timestamp
Interface Propertytimestamp: stringUTC timestamp for specific app config version. It's used for app's update.
useAutoSortInFixedLayout
useAutoSortInFixedLayout: booleanWhether adjust tab order automatically in the fixed layout.
useCachedManifest
useCachedManifest: booleanIf true, will read widget's manifest from widgetsManifest .
This value is false by default
widgetsManifest
Interface PropertywidgetsManifest: {}The manifest here are raw manifest, need to be processed before use. We save raw manifest here to save some network requests.
When add a widget in builder, the manifest is not saved here because we need to fetch the latest manifest to check version info. However, we can do this manually.