Show:

F2.AppConfig Class

The AppConfig object represents an app's meta data

Defined in: sdk\src\classes.js:29

Properties

Name Description
appId

The unique ID of the app. More information can be found here

containerLocale

The language and region specification for this container represented as an IETF-defined standard language tag, e.g. "en-us" or "de-de". This is passed during the F2.registerApps process.

context

An object that represents the context of an app

enableBatchRequests

True if the app should be requested in a single request with other apps.

height

The height of the app. The initial height will be pulled from the F2.AppConfig object, but later modified by calling F2.UI.updateHeight. This is used for secure apps to be able to set the initial height of the iframe.

instanceId

The unique runtime ID of the app.

This property is populated during the F2.registerApps process

isSecure

True if the app will be loaded in an iframe. This property will be true if the F2.AppConfig object sets isSecure = true. It will also be true if the container has made the decision to run apps in iframes.

localeSupport

The languages and regions supported by this app represented as an array of IETF-defined standard language tags, e.g. ["en-us","de-de"].

manifestUrl

The url to retrieve the F2.AppManifest object.

maxWidth

The recommended maximum width in pixels that this app should be run. It is up to the container to implement the logic to prevent an app from being run when the maxWidth requirements are not met.

minGridSize

The recommended minimum grid size that this app should be run. This value corresponds to the 12-grid system that is used by the container. This property should be set by apps that require a certain number of columns in their layout.

minWidth

The recommended minimum width in pixels that this app should be run. **It is up to the container to implement the logic to prevent an app from being run when the minWidth requirements are not met.

name

The name of the app

root

The root DOM element that contains the app

This property is populated during the F2.registerApps process

ui

The instance of F2.UI providing easy access to F2.UI methods

This property is populated during the F2.registerApps process

views

The views that this app supports. Available views are defined in F2.Constants.Views. The presence of a view can be checked via F2.inArray:

F2.inArray(F2.Constants.Views.SETTINGS, app.views)

Properties

appId String

The unique ID of the app. More information can be found here


containerLocale String

Defined in sdk\src\classes.js:85

Available since 1.4.0

The language and region specification for this container represented as an IETF-defined standard language tag, e.g. "en-us" or "de-de". This is passed during the F2.registerApps process.

Default: null


context Object

An object that represents the context of an app


enableBatchRequests Bool

True if the app should be requested in a single request with other apps.

Default: false


height Int

The height of the app. The initial height will be pulled from the F2.AppConfig object, but later modified by calling F2.UI.updateHeight. This is used for secure apps to be able to set the initial height of the iframe.


instanceId String

The unique runtime ID of the app.

This property is populated during the F2.registerApps process


isSecure Bool

True if the app will be loaded in an iframe. This property will be true if the F2.AppConfig object sets isSecure = true. It will also be true if the container has made the decision to run apps in iframes.

Default: false


localeSupport Array

Defined in sdk\src\classes.js:97

Available since 1.4.0

The languages and regions supported by this app represented as an array of IETF-defined standard language tags, e.g. ["en-us","de-de"].

Default: []


manifestUrl String

The url to retrieve the F2.AppManifest object.


maxWidth Int

The recommended maximum width in pixels that this app should be run. It is up to the container to implement the logic to prevent an app from being run when the maxWidth requirements are not met.


minGridSize Int

The recommended minimum grid size that this app should be run. This value corresponds to the 12-grid system that is used by the container. This property should be set by apps that require a certain number of columns in their layout.

Default: 4


minWidth Int

The recommended minimum width in pixels that this app should be run. **It is up to the container to implement the logic to prevent an app from being run when the minWidth requirements are not met.

Default: 300


name String

The name of the app


root Element

The root DOM element that contains the app

This property is populated during the F2.registerApps process


ui F2.UI

The instance of F2.UI providing easy access to F2.UI methods

This property is populated during the F2.registerApps process


views Array

The views that this app supports. Available views are defined in F2.Constants.Views. The presence of a view can be checked via F2.inArray:

F2.inArray(F2.Constants.Views.SETTINGS, app.views)