Application

An application is a unit of runtime execution with sandboxing around concepts and data used inside of it. Each application consists of pages, actions, data queries and logic that glue them together. An application is primarily described with a declarative metadata system, and can have an accompanying imperative extension model.
The imperative extension of the application is typically defined in a script module with a designated entry point, the main function, which allows the imperative logic to integrate with the application life cycle.

Index

Types

Functions

Types

Application

Hierarchy

Application

Properties

Name Signature Description
minVersion minVersion: string (optional)
An optional marker to indicate the minimum platform version required by this component. When this is specified and the component is attempted to be loaded in an older version of the platform, the corresponding workspace is not loaded and user is directed to install a newer version of the platform.

Methods

Name Signature Description
appInit appInit(metadata: ApplicationMetadata): any This method is invoked at the point the application is about to run, with the instance of the application metadata loaded. The metadata passed in can be still modified to change behaviors before this method returns.

ApplicationMetadata

Hierarchy

ApplicationMetadata

Properties

Name Signature Description
ColorName ColorName: string (optional)
The theme color of the application
Configs Configs: [name: string]: any (optional)
An application can have a set of named config supplied by the author or the resource provider
Description Description: string (optional)
The description of the application
IconName IconName: string (optional)
The representative icon of the application
Id Id: string
The unique identifier of the application
Title Title: string
The title of the application

Functions

main

main(metadataService: MetadataService, dataService: DataService, cacheService: CacheService, asyncService: AsyncService): Application

The main method of a business logic module. Each business logic module (as JavaScript file) must contain one main method. The method is invoked when the module is loaded and is being initialized. The method must return the component to run from this module.

Parameters

Name Type Description
metadataService MetadataService
dataService DataService
cacheService CacheService
asyncService AsyncService

Returns Application