AppConfig

Interface

This interface defines the experience config structure.

Properties

PropertyTypeNotes
boolean

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

connections
 optional 
Connection[]

Configure multiple portal connection information

dataSources
 optional 
DataSourcesJson

Data sources within an experience

DialogsJson

Windows (dialogs) within an experience

string

The framework version when the experience is created/updated.

FooterJson

The footer of an experience

ForBuilderAttributes

These attributes are used by builder only.

HeaderJson

The header of an experience

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.

LayoutsJson

Layouts within an experience

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
 optional 
MessagesJson

The message configs of an experience

{ [pageId: string]: string[] }[]

The structure of pages

PagesJson

Pages within an experience

preloadWidgets
 optional 
string[]

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

ScreenGroupsJson

Screen groups within an experience

ScreensJson

Screens within an experience

sections
 optional 
SectionsJson

Sections within an experience

string

The template that an experience created from.

string

The theme uri, should end with "/".

string

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

useCachedManifest
 optional 
boolean

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

views
 optional 
ViewsJson

Views within an experience

WidgetsJson

Widgets within an experience

{ [widgetUri: string]: WidgetManifest }

The manifest here are raw manifest, need to be processed before use. We save raw manifest here to save some network requests.

__not_publish

__not_publish: boolean

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

connections optional

connections: Connection[]

Configure multiple portal connection information

dataSources optional

dataSources: DataSourcesJson

Data sources within an experience

dialogs

dialogs: DialogsJson

Windows (dialogs) within an experience

exbVersion

exbVersion: string

The framework version when the experience is created/updated.

footer: FooterJson

The footer of an experience

forBuilderAttributes

forBuilderAttributes: ForBuilderAttributes

These attributes are used by builder only.

header: HeaderJson

The header of an experience

historyLabels

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

layouts: LayoutsJson

Layouts within an experience

mainSizeMode

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 optional

messageConfigs: MessagesJson

The message configs of an experience

pageStructure

pageStructure: { [pageId: string]: string[] }[]

The structure of pages

pages

pages: PagesJson

Pages within an experience

preloadWidgets optional

preloadWidgets: string[]

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

screenGroups

screenGroups: ScreenGroupsJson

Screen groups within an experience

screens

screens: ScreensJson

Screens within an experience

sections optional

sections: SectionsJson

Sections within an experience

template

template: string

The template that an experience created from.

theme

theme: string

The theme uri, should end with "/".

timestamp

timestamp: string

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

useCachedManifest optional

useCachedManifest: boolean

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

views optional

views: ViewsJson

Views within an experience

widgets

widgets: WidgetsJson

Widgets within an experience

widgetsManifest

widgetsManifest: { [widgetUri: string]: WidgetManifest }

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.

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