AppConfig
Interface
This interface defines the experience config structure.
Properties
__not_publish
__not_publish: booleanOnly newly created experience (unpublished) configurations have this property.
dataSources optional
dataSources: { [dsId: string]: DataSourceJson }Data sources within an experience
dialogs
dialogs: { [dialogId: string]: DialogJson }Windows (dialogs) within an experience
exbVersion
exbVersion: stringThe framework version when the experience is created/updated.
footer
footer: FooterJsonThe footer of an experience
forBuilderAttributes
forBuilderAttributes: ForBuilderAttributesThese attributes are used by builder only.
header
header: HeaderJsonThe header of an experience
layouts
layouts: { [layoutId: string]: LayoutJson }Layouts within an experience
mainSizeMode
mainSizeMode: 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 optional
messageConfigs: { [messageConfigId: string]: MessageJson }The message configs of an experience
pageStructure
pageStructure: { [pageId: string]: string[] }[]The structure of pages
pages
pages: { [pageId: string]: PageJson }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: { [screenGroupId: string]: ScreenGroupJson }Screen groups within an experience
screens
screens: { [screenId: string]: ScreenJson }Screens within an experience
sections optional
sections: { [sectionId: string]: SectionJson }Sections within an experience
template
template: stringThe template that an experience created from.
theme
theme: stringThe theme uri, should end with "/".
timestamp
timestamp: stringUTC timestamp for specific app config version. It's used for app's update.
useCachedManifest optional
useCachedManifest: booleanIf true, will read widget's manifest from widgetsManifest.
This value is false by default
views optional
views: { [viewId: string]: ViewJson }Views within an experience
widgets
widgets: { [widgetId: string]: WidgetJson }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.