AppConfig

Interface

This interface defines the experience config structure.

Properties

__not_publish

__not_publish: boolean

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

dataSources optional

dataSources: object

Data sources within an experience

Type declaration
  • [dsId: string]: DataSourceJson

dialogs

dialogs: object

Windows (dialogs) within an experience

Type declaration

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

layouts

layouts: object

Layouts within an experience

Type declaration
  • [layoutId: string]: LayoutJson

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: object

The message configs of an experience

Type declaration
  • [messageConfigId: string]: MessageJson

pageStructure

pageStructure: [void]

The structure of pages

pages

pages: object

Pages within an experience

Type declaration

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: object

Screen groups within an experience

Type declaration
  • [screenGroupId: string]: ScreenGroupJson

screens

screens: object

Screens within an experience

Type declaration
  • [screenId: string]: ScreenJson

sections optional

sections: object

Sections within an experience

Type declaration
  • [sectionId: string]: SectionJson

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: object

Views within an experience

Type declaration
  • [viewId: string]: ViewJson

widgets

widgets: object

Widgets within an experience

Type declaration
  • [widgetId: string]: WidgetJson

widgetsManifest

widgetsManifest: object

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.

Type declaration

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