ApplicationLifecycle
Summary
| Functions | |
|---|---|
Returns true if the application version is currently being upgraded.
Used to determine the kind of feedback to provide when the application is initialized (e.g. splash screen).
|
|
| Registers listeners for application load events. | |
Functions
isUpgradingVersion
isUpgradingVersion(): boolean
Returns true if the application version is currently being upgraded.
Used to determine the kind of feedback to provide when the application is initialized (e.g. splash screen).
Returns
- boolean
listen
listen(eventHandlers: ApplicationLoadEventHandlers): void
Registers listeners for application load events.
Parameters
-
eventHandlers: ApplicationLoadEventHandlers
Object containing callbacks for the application loading events you want to listen to.
Returns
- void
Provides information about the status of the application's lifecycle. Used to protect the app during upgrades, when local model access shouldn't be allowed, and to customize the application loading process.
Example:
// Check if the app is currently being upgraded var isUpgrading = $public.ApplicationLifecycle.isUpgradingVersion(); var progressCallback = function(loaded, total) { // do something on upgrade progress }; var loadCompleteCallback = function() { // do something on finish }; $public.ApplicationLifecycle.listen({ onUpgradeProgress: isUpgrading ? progressCallback : null, onLoadComplete: loadCompleteCallback });