A single row in the manage-apps admin page, pairing an Application with whether it is currently enabled for a given organisation or website branch. Instances are built by AppsPageHelper for a specific organisation and, optionally, website branch, and combine either a core application or a marketplace RepositoryApp with its enabled state, display title and, for a marketplace app, the version currently installed.
Properties
| Property | Returns | Description |
|---|---|---|
| anyApp | boolean | True for a core application, or for a marketplace RepositoryApp that provides apps rather than being a library. Used to filter the apps list down to entries that represent an actual app, as opposed to a supporting library. |
| app | Application | The underlying Application this bean wraps, either a core application or a marketplace RepositoryApp. |
| appId | String | The unique instance id of the wrapped application, eg "KContactUs". Used to identify the app in enable/disable and settings form posts. |
| core | boolean | True if the wrapped app is a core app for the current website branch, ie one that must always be enabled and cannot be turned off from the admin page. |
| currentBranch | String | The version of the app currently in use on the website branch this bean was built for, eg the name of the installed version branch. Null for core apps, which are not versioned repository apps, and for apps which have never been installed on this branch. The value is computed once and cached for the lifetime of this bean. |
| enabled | boolean | True if the wrapped app is currently enabled for the organisation or website branch this bean was built for. |
| lib | boolean | True if the wrapped app is a marketplace RepositoryApp library, ie it provides reusable functionality for other apps rather than being an app or theme in its own right. |
| manualEnable | boolean | True if the wrapped app cannot be directly installed by a user from the admin page, although it will continue to function normally if it is already installed, for example because it was enabled as a dependency of another app. |
| marketPlaceApp | boolean | True if the wrapped app is a marketplace RepositoryApp that provides apps, ie it was installed from the marketplace rather than being a built in core app or a library. |
| repoApp | boolean | True if the wrapped app is a marketplace RepositoryApp that is not a library, ie an app or theme rather than reusable supporting code. |
| title | String | The app's display title, resolved for the admin organisation this bean was built with. Never null, but may fall back to a default label if the app does not define its own title. |
Methods
getAppId() · isEnabled() · isAnyApp() · isCore() · isManualEnable() · isMarketPlaceApp() · getApp() · isRepoApp() · isLib() · getTitle() · getCurrentBranch()
getAppId()
Returns: String
The unique instance id of the wrapped application, eg "KContactUs". Used to identify the app in enable/disable and settings form posts.
isEnabled()
Returns: boolean
True if the wrapped app is currently enabled for the organisation or website branch this bean was built for.
isAnyApp()
Returns: boolean
True for a core application, or for a marketplace RepositoryApp that provides apps rather than being a library. Used to filter the apps list down to entries that represent an actual app, as opposed to a supporting library.
isCore()
Returns: boolean
True if the wrapped app is a core app for the current website branch, ie one that must always be enabled and cannot be turned off from the admin page.
isManualEnable()
Returns: boolean
True if the wrapped app cannot be directly installed by a user from the admin page, although it will continue to function normally if it is already installed, for example because it was enabled as a dependency of another app.
isMarketPlaceApp()
Returns: boolean
True if the wrapped app is a marketplace RepositoryApp that provides apps, ie it was installed from the marketplace rather than being a built in core app or a library.
getApp()
Returns: Application
The underlying Application this bean wraps, either a core application or a marketplace RepositoryApp.
isRepoApp()
Returns: boolean
True if the wrapped app is a marketplace RepositoryApp that is not a library, ie an app or theme rather than reusable supporting code.
isLib()
Returns: boolean
True if the wrapped app is a marketplace RepositoryApp library, ie it provides reusable functionality for other apps rather than being an app or theme in its own right.
getTitle()
Returns: String
The app's display title, resolved for the admin organisation this bean was built with. Never null, but may fall back to a default label if the app does not define its own title.
getCurrentBranch()
Returns: String
The version of the app currently in use on the website branch this bean was built for, eg the name of the installed version branch. Null for core apps, which are not versioned repository apps, and for apps which have never been installed on this branch. The value is computed once and cached for the lifetime of this bean.