Provides the core content viewing and authoring features for a website: file and folder resources, asset management, page rendering, menus, templates, search, and content type fields. The main thing it does is convert FileResource objects into RenderFileResource objects for html files accessed within a website, which is what allows theme templating to occur; html files that already declare their own doctype are left as plain files and are not wrapped for rendering. It registers a set of content-related roles, field providers, and event listeners that keep the content search index up to date as files are created, moved, or removed.
Implements: Application, PortletApplication, ResourceApplication, MenuApplication, DataResourceApplication, ChildPageApplication, TemplatingApplication, SettingsApplication, TableUploadApplication, SearchableApplication, PathApplication, ComponentApplication, DependentApplication, BrowseResourcesApplication, JourneyBuilderApplication, FieldProviderApplication, PriviledgeApplication, ContentTypeApplication, OmniSearchApplication
Properties
| Property | Returns | Description |
|---|---|---|
| assetManager | AssetManager | The asset manager this application uses to store and retrieve assets (content items, images, and other managed content). |
| assetsAppIndexer | AssetsAppIndexer | The search indexer this application uses to keep assets searchable, registered with the platform via getAppIndexers. |
| instanceId | String | The fixed identifier this application is registered under, used to look it up in the application manager and as a namespace prefix for its settings and resources. |
| roles | List<Role> | The roles this application contributes to the platform's role registry: Content Author and Content Viewer. |
Methods
getInstanceId()
Returns: String
The fixed identifier this application is registered under, used to look it up in the application manager and as a namespace prefix for its settings and resources.
call(String execFn, Object args)
Returns: Object
Lets you call a JavaScript function defined by the current website's controllers. Looks up the website's controller mappings and, if any are configured, invokes the named function with the given arguments.
| Parameter | Description |
|---|---|
execFn | the name of the function to call |
args | the arguments to pass to the function, if any |
mappings(Branch b)
Returns: ControllerMappingList
Finds the controller mappings (JS-backed URL routes, portlets, and menu contributions) configured for the given website branch, loading them from the branch's data session.
| Parameter | Description |
|---|---|
b | the website branch whose controller mappings are wanted |
getRoles()
Returns: List<Role>
The roles this application contributes to the platform's role registry: Content Author and Content Viewer.
getDisallowedRobotsSetting(Branch websiteBranch)
Returns: List<String>
The list of paths that should be disallowed for search engine robots, read from the "robotsDisallowedPaths" setting on the given website branch, or on the current tenant organisation if the branch has no setting of its own. The /theme/ path is always disallowed in addition to whatever this returns.
| Parameter | Description |
|---|---|
websiteBranch | the website branch to read the setting from, or null to use the organisation-level setting |
getAssetManager()
Returns: AssetManager
The asset manager this application uses to store and retrieve assets (content items, images, and other managed content).
getAssetsAppIndexer()
Returns: AssetsAppIndexer
The search indexer this application uses to keep assets searchable, registered with the platform via getAppIndexers.