Skip to content

Interface

This interface defines the experience config structure.

Properties

PropertyTypeNotes
__not_publishboolean

Only newly created experience (unpublished) configurations have this property.

connectionsConnection[]

Configure multiple portal connection information

controllerPanelsControllerPanelsJson

Floating panels for controller widget

dataSourcesDataSourcesJson

Data sources within an experience

dialogsDialogsJson

Windows (dialogs) within an experience

exbVersionstring

The framework version when the experience is created/updated.

footerFooterJson

The footer of an experience

forBuilderAttributesForBuilderAttributes

These attributes are used by builder only.

headerHeaderJson

The header of an experience

historyLabelsHistoryLabels

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.

layoutsLayoutsJson

Layouts within an experience

mainSizeModeBrowserSizeMode

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.

messageConfigsMessagesJson

The message configs of an experience

namestring

Because one app can have multiple config.json, we add a name to identify the config.

originExbVersionstring

As the exbVersion will be replaced with the code version when app is launched, we save the origin version in config here.

pagesPagesJson

Pages within an experience

pageStructure{}[]

The structure of pages

permissionPermission

Permissions information

preloadWidgetsstring[]

The widgets uri in this array will be loaded when the app loads, rather than dynamically loading the widget.

publishTimestampstring

This property will be set when publishing.

screenGroupsScreenGroupsJson

Screen groups within an experience

screensScreensJson

Screens within an experience

sectionsSectionsJson

Sections within an experience

templatestring

The template that an experience created from.

themestring

The theme uri, should end with "/".

timestampstring

UTC timestamp for specific app config version. It's used for app's update.

useAutoSortInFixedLayoutboolean

Whether adjust tab order automatically in the fixed layout.

useCachedManifestboolean

If true, will read widget's manifest from widgetsManifest . This value is false by default

viewsViewsJson

Views within an experience

widgetsWidgetsJson

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

connections

optional
Interface Property

controllerPanels

Interface Property

dataSources

optional
Interface Property

dialogs

Interface Property

exbVersion

Interface Property
Interface Property

forBuilderAttributes

Interface Property
Interface Property

historyLabels

Interface Property

layouts

Interface Property

mainSizeMode

Interface Property

messageConfigs

optional
Interface Property

name

Interface Property

originExbVersion

Interface Property

pages

Interface Property

pageStructure

Interface Property

permission

optional
Interface Property

preloadWidgets

optional
Interface Property

publishTimestamp

optional
Interface Property

screenGroups

Interface Property

screens

Interface Property

sections

optional
Interface Property

template

Interface Property

theme

Interface Property

timestamp

Interface Property

useAutoSortInFixedLayout

optional
Interface Property

useCachedManifest

optional
Interface Property

views

optional
Interface Property

widgets

Interface Property

widgetsManifest

Interface Property

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.