Classes
ApplicationCommon
Defined in: application/application-common.ts
Extended by
Properties
_windows
protected _windows: NativeWindow[];Defined in: application/application-common.ts
backgroundEvent
readonly backgroundEvent: "background" = "background";Defined in: application/application-common.ts
cssChangedEvent
readonly cssChangedEvent: "cssChanged" = "cssChanged";Defined in: application/application-common.ts
discardedErrorEvent
readonly discardedErrorEvent: "discardedError" = "discardedError";Defined in: application/application-common.ts
displayedEvent
readonly displayedEvent: "displayed" = "displayed";Defined in: application/application-common.ts
exitEvent
readonly exitEvent: "exit" = "exit";Defined in: application/application-common.ts
On Android, raised when the last window closes; the process may stay alive. On iOS, raised when the process itself terminates.
fontScaleChangedEvent
readonly fontScaleChangedEvent: "fontScaleChanged" = "fontScaleChanged";Defined in: application/application-common.ts
foregroundEvent
readonly foregroundEvent: "foreground" = "foreground";Defined in: application/application-common.ts
hasListeners
hasListeners: (eventName: string) => boolean;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
eventName | string |
Returns
boolean
initRootViewEvent
readonly initRootViewEvent: "initRootView" = "initRootView";Defined in: application/application-common.ts
launchEvent
readonly launchEvent: "launch" = "launch";Defined in: application/application-common.ts
Deprecated
Use the 'ready' event for application initialization and Application.setWindowContentResolver() to provide window UI. 'launch' continues to fire before the first window's content is created, and its 'root' property is still honored, for backwards compatibility. It never fires for additional windows. In a scene-based app it fires with the first window's content, so a background launch that connects no scene does not raise it.
layoutDirectionChangedEvent
readonly layoutDirectionChangedEvent: "layoutDirectionChanged" = "layoutDirectionChanged";Defined in: application/application-common.ts
livesyncEvent
readonly livesyncEvent: "livesync" = "livesync";Defined in: application/application-common.ts
loadAppCssEvent
readonly loadAppCssEvent: "loadAppCss" = "loadAppCss";Defined in: application/application-common.ts
lowMemoryEvent
readonly lowMemoryEvent: "lowMemory" = "lowMemory";Defined in: application/application-common.ts
mainEntry
protected mainEntry: NavigationEntry;Defined in: application/application-common.ts
notify
notify: <T>(eventData: T) => void;Defined in: application/application-common.ts
Type Parameters
| Type Parameter | Default type |
|---|---|
T | ApplicationEventData |
Parameters
| Parameter | Type |
|---|---|
eventData | T |
Returns
void
off
off: (eventNames: string, callback?: any, thisArg?: any) => void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
eventNames | string |
callback? | any |
thisArg? | any |
Returns
void
on
on: {
(eventNames: string, callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "cssChanged", callback: (args: CssChangedEventData) => void, thisArg?: any): void;
(event: "livesync", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "launch", callback: (args: LaunchEventData) => void, thisArg?: any): void;
(event: "ready", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "displayed", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "suspend", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "resume", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "exit", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "lowMemory", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "uncaughtError", callback: (args: UnhandledErrorEventData) => void, thisArg?: any): void;
(event: "discardedError", callback: (args: DiscardedErrorEventData) => void, thisArg?: any): void;
(event: "orientationChanged", callback: (args: OrientationChangedEventData) => void, thisArg?: any): void;
(event: "systemAppearanceChanged", callback: (args: SystemAppearanceChangedEventData) => void, thisArg?: any): void;
(event: "layoutDirectionChanged", callback: (args: LayoutDirectionChangedEventData) => void, thisArg?: any): void;
(event: "fontScaleChanged", callback: (args: FontScaleChangedEventData) => void, thisArg?: any): void;
(event: "windowOpen", callback: (args: WindowOpenEventData) => void, thisArg?: any): void;
(event: "windowClose", callback: (args: WindowCloseEventData) => void, thisArg?: any): void;
(event: "primaryWindowChanged", callback: (args: PrimaryWindowChangedEventData) => void, thisArg?: any): void;
(event: "sceneOpenURLContexts", callback: (args: SceneOpenURLContextsEventData) => void, thisArg?: any): void;
(event: "sceneContinueUserActivity", callback: (args: SceneContinueUserActivityEventData) => void, thisArg?: any): void;
(event: "scenePerformActionForShortcutItem", callback: (args: ScenePerformActionForShortcutItemEventData) => void, thisArg?: any): void;
};Defined in: application/application-common.ts
Call Signature
(
eventNames: string,
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
eventNames | string |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "cssChanged",
callback: (args: CssChangedEventData) => void,
thisArg?: any): void;This event is raised when application css is changed.
Parameters
| Parameter | Type |
|---|---|
event | "cssChanged" |
callback | (args: CssChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "livesync",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Event raised then livesync operation is performed.
Parameters
| Parameter | Type |
|---|---|
event | "livesync" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "launch",
callback: (args: LaunchEventData) => void,
thisArg?: any): void;This event is raised on application launchEvent.
Parameters
| Parameter | Type |
|---|---|
event | "launch" |
callback | (args: LaunchEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "ready",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised once the JS context is initialized.
Parameters
| Parameter | Type |
|---|---|
event | "ready" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "displayed",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Experimental
This event is raised after the application has performed most of its startup actions. Its intent is to be suitable for measuring app startup times.
Parameters
| Parameter | Type |
|---|---|
event | "displayed" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "suspend",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is suspended.
Parameters
| Parameter | Type |
|---|---|
event | "suspend" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "resume",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is resumed after it has been suspended.
Parameters
| Parameter | Type |
|---|---|
event | "resume" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "exit",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is about to exit.
On Android it is raised when the last window closes; the process may stay alive. On iOS it is raised when the process itself terminates.
Parameters
| Parameter | Type |
|---|---|
event | "exit" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "lowMemory",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when there is low memory on the target device.
Parameters
| Parameter | Type |
|---|---|
event | "lowMemory" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "uncaughtError",
callback: (args: UnhandledErrorEventData) => void,
thisArg?: any): void;This event is raised when an uncaught error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "uncaughtError" |
callback | (args: UnhandledErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "discardedError",
callback: (args: DiscardedErrorEventData) => void,
thisArg?: any): void;This event is raised when an discarded error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "discardedError" |
callback | (args: DiscardedErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "orientationChanged",
callback: (args: OrientationChangedEventData) => void,
thisArg?: any): void;This event is raised when the orientation of the application changes.
Parameters
| Parameter | Type |
|---|---|
event | "orientationChanged" |
callback | (args: OrientationChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "systemAppearanceChanged",
callback: (args: SystemAppearanceChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system appearance changes between light and dark theme (for Android); between light and dark mode (for iOS) and vice versa.
Parameters
| Parameter | Type |
|---|---|
event | "systemAppearanceChanged" |
callback | (args: SystemAppearanceChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "layoutDirectionChanged",
callback: (args: LayoutDirectionChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system layout direction changes between ltr and rtl.
Parameters
| Parameter | Type |
|---|---|
event | "layoutDirectionChanged" |
callback | (args: LayoutDirectionChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "fontScaleChanged",
callback: (args: FontScaleChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "fontScaleChanged" |
callback | (args: FontScaleChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowOpen",
callback: (args: WindowOpenEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowOpen" |
callback | (args: WindowOpenEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowClose",
callback: (args: WindowCloseEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowClose" |
callback | (args: WindowCloseEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "primaryWindowChanged",
callback: (args: PrimaryWindowChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "primaryWindowChanged" |
callback | (args: PrimaryWindowChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneOpenURLContexts",
callback: (args: SceneOpenURLContextsEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneOpenURLContexts" |
callback | (args: SceneOpenURLContextsEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneContinueUserActivity",
callback: (args: SceneContinueUserActivityEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneContinueUserActivity" |
callback | (args: SceneContinueUserActivityEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "scenePerformActionForShortcutItem",
callback: (args: ScenePerformActionForShortcutItemEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "scenePerformActionForShortcutItem" |
callback | (args: ScenePerformActionForShortcutItemEventData) => void |
thisArg? | any |
Returns
void
once
once: {
(eventNames: string, callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "cssChanged", callback: (args: CssChangedEventData) => void, thisArg?: any): void;
(event: "livesync", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "launch", callback: (args: LaunchEventData) => void, thisArg?: any): void;
(event: "ready", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "displayed", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "suspend", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "resume", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "exit", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "lowMemory", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "uncaughtError", callback: (args: UnhandledErrorEventData) => void, thisArg?: any): void;
(event: "discardedError", callback: (args: DiscardedErrorEventData) => void, thisArg?: any): void;
(event: "orientationChanged", callback: (args: OrientationChangedEventData) => void, thisArg?: any): void;
(event: "systemAppearanceChanged", callback: (args: SystemAppearanceChangedEventData) => void, thisArg?: any): void;
(event: "layoutDirectionChanged", callback: (args: LayoutDirectionChangedEventData) => void, thisArg?: any): void;
(event: "fontScaleChanged", callback: (args: FontScaleChangedEventData) => void, thisArg?: any): void;
(event: "windowOpen", callback: (args: WindowOpenEventData) => void, thisArg?: any): void;
(event: "windowClose", callback: (args: WindowCloseEventData) => void, thisArg?: any): void;
(event: "primaryWindowChanged", callback: (args: PrimaryWindowChangedEventData) => void, thisArg?: any): void;
(event: "sceneOpenURLContexts", callback: (args: SceneOpenURLContextsEventData) => void, thisArg?: any): void;
(event: "sceneContinueUserActivity", callback: (args: SceneContinueUserActivityEventData) => void, thisArg?: any): void;
(event: "scenePerformActionForShortcutItem", callback: (args: ScenePerformActionForShortcutItemEventData) => void, thisArg?: any): void;
};Defined in: application/application-common.ts
Call Signature
(
eventNames: string,
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
eventNames | string |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "cssChanged",
callback: (args: CssChangedEventData) => void,
thisArg?: any): void;This event is raised when application css is changed.
Parameters
| Parameter | Type |
|---|---|
event | "cssChanged" |
callback | (args: CssChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "livesync",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Event raised then livesync operation is performed.
Parameters
| Parameter | Type |
|---|---|
event | "livesync" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "launch",
callback: (args: LaunchEventData) => void,
thisArg?: any): void;This event is raised on application launchEvent.
Parameters
| Parameter | Type |
|---|---|
event | "launch" |
callback | (args: LaunchEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "ready",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised once the JS context is initialized.
Parameters
| Parameter | Type |
|---|---|
event | "ready" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "displayed",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Experimental
This event is raised after the application has performed most of its startup actions. Its intent is to be suitable for measuring app startup times.
Parameters
| Parameter | Type |
|---|---|
event | "displayed" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "suspend",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is suspended.
Parameters
| Parameter | Type |
|---|---|
event | "suspend" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "resume",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is resumed after it has been suspended.
Parameters
| Parameter | Type |
|---|---|
event | "resume" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "exit",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is about to exit.
On Android it is raised when the last window closes; the process may stay alive. On iOS it is raised when the process itself terminates.
Parameters
| Parameter | Type |
|---|---|
event | "exit" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "lowMemory",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when there is low memory on the target device.
Parameters
| Parameter | Type |
|---|---|
event | "lowMemory" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "uncaughtError",
callback: (args: UnhandledErrorEventData) => void,
thisArg?: any): void;This event is raised when an uncaught error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "uncaughtError" |
callback | (args: UnhandledErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "discardedError",
callback: (args: DiscardedErrorEventData) => void,
thisArg?: any): void;This event is raised when an discarded error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "discardedError" |
callback | (args: DiscardedErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "orientationChanged",
callback: (args: OrientationChangedEventData) => void,
thisArg?: any): void;This event is raised when the orientation of the application changes.
Parameters
| Parameter | Type |
|---|---|
event | "orientationChanged" |
callback | (args: OrientationChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "systemAppearanceChanged",
callback: (args: SystemAppearanceChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system appearance changes between light and dark theme (for Android); between light and dark mode (for iOS) and vice versa.
Parameters
| Parameter | Type |
|---|---|
event | "systemAppearanceChanged" |
callback | (args: SystemAppearanceChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "layoutDirectionChanged",
callback: (args: LayoutDirectionChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system layout direction changes between ltr and rtl.
Parameters
| Parameter | Type |
|---|---|
event | "layoutDirectionChanged" |
callback | (args: LayoutDirectionChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "fontScaleChanged",
callback: (args: FontScaleChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "fontScaleChanged" |
callback | (args: FontScaleChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowOpen",
callback: (args: WindowOpenEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowOpen" |
callback | (args: WindowOpenEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowClose",
callback: (args: WindowCloseEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowClose" |
callback | (args: WindowCloseEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "primaryWindowChanged",
callback: (args: PrimaryWindowChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "primaryWindowChanged" |
callback | (args: PrimaryWindowChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneOpenURLContexts",
callback: (args: SceneOpenURLContextsEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneOpenURLContexts" |
callback | (args: SceneOpenURLContextsEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneContinueUserActivity",
callback: (args: SceneContinueUserActivityEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneContinueUserActivity" |
callback | (args: SceneContinueUserActivityEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "scenePerformActionForShortcutItem",
callback: (args: ScenePerformActionForShortcutItemEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "scenePerformActionForShortcutItem" |
callback | (args: ScenePerformActionForShortcutItemEventData) => void |
thisArg? | any |
Returns
void
orientationChangedEvent
readonly orientationChangedEvent: "orientationChanged" = "orientationChanged";Defined in: application/application-common.ts
primaryWindowChangedEvent
readonly primaryWindowChangedEvent: "primaryWindowChanged";Defined in: application/application-common.ts
readyEvent
readonly readyEvent: "ready" = "ready";Defined in: application/application-common.ts
Raised once per JS context, as soon as the context is initialized. It is never deferred, so it also fires on a background launch where no window is created.
Guaranteed ordering: ready -> windowOpen -> raw connect/create events -> content resolution (the legacy launch bridge runs here, for the first window only) -> contentLoaded -> activate/displayed.
resumeEvent
readonly resumeEvent: "resume" = "resume";Defined in: application/application-common.ts
started
started: boolean;Defined in: application/application-common.ts
suspendEvent
readonly suspendEvent: "suspend" = "suspend";Defined in: application/application-common.ts
Reflects whole-app state: with multiple windows it is raised once the app itself is no longer in the foreground, not when an individual window backgrounds. Listen on a NativeWindow for per-window state.
systemAppearanceChangedEvent
readonly systemAppearanceChangedEvent: "systemAppearanceChanged" = "systemAppearanceChanged";Defined in: application/application-common.ts
uncaughtErrorEvent
readonly uncaughtErrorEvent: "uncaughtError" = "uncaughtError";Defined in: application/application-common.ts
windowCloseEvent
readonly windowCloseEvent: "windowClose";Defined in: application/application-common.ts
windowOpenEvent
readonly windowOpenEvent: "windowOpen";Defined in: application/application-common.ts
hasListeners
static hasListeners: (eventName: string) => boolean;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
eventName | string |
Returns
boolean
Deprecated
Use Application.android.hasListeners() instead.
notify
static notify: <T>(eventData: T) => void;Defined in: application/application-common.ts
Type Parameters
| Type Parameter | Default type |
|---|---|
T | ApplicationEventData |
Parameters
| Parameter | Type |
|---|---|
eventData | T |
Returns
void
Deprecated
Use Application.android.notify() instead.
off
static off: (eventNames: string, callback?: any, thisArg?: any) => void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
eventNames | string |
callback? | any |
thisArg? | any |
Returns
void
Deprecated
Use Application.android.off() instead.
on
static on: {
(eventNames: string, callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "cssChanged", callback: (args: CssChangedEventData) => void, thisArg?: any): void;
(event: "livesync", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "launch", callback: (args: LaunchEventData) => void, thisArg?: any): void;
(event: "ready", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "displayed", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "suspend", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "resume", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "exit", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "lowMemory", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "uncaughtError", callback: (args: UnhandledErrorEventData) => void, thisArg?: any): void;
(event: "discardedError", callback: (args: DiscardedErrorEventData) => void, thisArg?: any): void;
(event: "orientationChanged", callback: (args: OrientationChangedEventData) => void, thisArg?: any): void;
(event: "systemAppearanceChanged", callback: (args: SystemAppearanceChangedEventData) => void, thisArg?: any): void;
(event: "layoutDirectionChanged", callback: (args: LayoutDirectionChangedEventData) => void, thisArg?: any): void;
(event: "fontScaleChanged", callback: (args: FontScaleChangedEventData) => void, thisArg?: any): void;
(event: "windowOpen", callback: (args: WindowOpenEventData) => void, thisArg?: any): void;
(event: "windowClose", callback: (args: WindowCloseEventData) => void, thisArg?: any): void;
(event: "primaryWindowChanged", callback: (args: PrimaryWindowChangedEventData) => void, thisArg?: any): void;
(event: "sceneOpenURLContexts", callback: (args: SceneOpenURLContextsEventData) => void, thisArg?: any): void;
(event: "sceneContinueUserActivity", callback: (args: SceneContinueUserActivityEventData) => void, thisArg?: any): void;
(event: "scenePerformActionForShortcutItem", callback: (args: ScenePerformActionForShortcutItemEventData) => void, thisArg?: any): void;
};Defined in: application/application-common.ts
Call Signature
(
eventNames: string,
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
eventNames | string |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "cssChanged",
callback: (args: CssChangedEventData) => void,
thisArg?: any): void;This event is raised when application css is changed.
Parameters
| Parameter | Type |
|---|---|
event | "cssChanged" |
callback | (args: CssChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "livesync",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Event raised then livesync operation is performed.
Parameters
| Parameter | Type |
|---|---|
event | "livesync" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "launch",
callback: (args: LaunchEventData) => void,
thisArg?: any): void;This event is raised on application launchEvent.
Parameters
| Parameter | Type |
|---|---|
event | "launch" |
callback | (args: LaunchEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "ready",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised once the JS context is initialized.
Parameters
| Parameter | Type |
|---|---|
event | "ready" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "displayed",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Experimental
This event is raised after the application has performed most of its startup actions. Its intent is to be suitable for measuring app startup times.
Parameters
| Parameter | Type |
|---|---|
event | "displayed" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "suspend",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is suspended.
Parameters
| Parameter | Type |
|---|---|
event | "suspend" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "resume",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is resumed after it has been suspended.
Parameters
| Parameter | Type |
|---|---|
event | "resume" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "exit",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is about to exit.
On Android it is raised when the last window closes; the process may stay alive. On iOS it is raised when the process itself terminates.
Parameters
| Parameter | Type |
|---|---|
event | "exit" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "lowMemory",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when there is low memory on the target device.
Parameters
| Parameter | Type |
|---|---|
event | "lowMemory" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "uncaughtError",
callback: (args: UnhandledErrorEventData) => void,
thisArg?: any): void;This event is raised when an uncaught error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "uncaughtError" |
callback | (args: UnhandledErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "discardedError",
callback: (args: DiscardedErrorEventData) => void,
thisArg?: any): void;This event is raised when an discarded error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "discardedError" |
callback | (args: DiscardedErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "orientationChanged",
callback: (args: OrientationChangedEventData) => void,
thisArg?: any): void;This event is raised when the orientation of the application changes.
Parameters
| Parameter | Type |
|---|---|
event | "orientationChanged" |
callback | (args: OrientationChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "systemAppearanceChanged",
callback: (args: SystemAppearanceChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system appearance changes between light and dark theme (for Android); between light and dark mode (for iOS) and vice versa.
Parameters
| Parameter | Type |
|---|---|
event | "systemAppearanceChanged" |
callback | (args: SystemAppearanceChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "layoutDirectionChanged",
callback: (args: LayoutDirectionChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system layout direction changes between ltr and rtl.
Parameters
| Parameter | Type |
|---|---|
event | "layoutDirectionChanged" |
callback | (args: LayoutDirectionChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "fontScaleChanged",
callback: (args: FontScaleChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "fontScaleChanged" |
callback | (args: FontScaleChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowOpen",
callback: (args: WindowOpenEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowOpen" |
callback | (args: WindowOpenEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowClose",
callback: (args: WindowCloseEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowClose" |
callback | (args: WindowCloseEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "primaryWindowChanged",
callback: (args: PrimaryWindowChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "primaryWindowChanged" |
callback | (args: PrimaryWindowChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneOpenURLContexts",
callback: (args: SceneOpenURLContextsEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneOpenURLContexts" |
callback | (args: SceneOpenURLContextsEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneContinueUserActivity",
callback: (args: SceneContinueUserActivityEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneContinueUserActivity" |
callback | (args: SceneContinueUserActivityEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "scenePerformActionForShortcutItem",
callback: (args: ScenePerformActionForShortcutItemEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "scenePerformActionForShortcutItem" |
callback | (args: ScenePerformActionForShortcutItemEventData) => void |
thisArg? | any |
Returns
void
Deprecated
Use Application.android.on() instead.
once
static once: {
(eventNames: string, callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "cssChanged", callback: (args: CssChangedEventData) => void, thisArg?: any): void;
(event: "livesync", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "launch", callback: (args: LaunchEventData) => void, thisArg?: any): void;
(event: "ready", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "displayed", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "suspend", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "resume", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "exit", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "lowMemory", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "uncaughtError", callback: (args: UnhandledErrorEventData) => void, thisArg?: any): void;
(event: "discardedError", callback: (args: DiscardedErrorEventData) => void, thisArg?: any): void;
(event: "orientationChanged", callback: (args: OrientationChangedEventData) => void, thisArg?: any): void;
(event: "systemAppearanceChanged", callback: (args: SystemAppearanceChangedEventData) => void, thisArg?: any): void;
(event: "layoutDirectionChanged", callback: (args: LayoutDirectionChangedEventData) => void, thisArg?: any): void;
(event: "fontScaleChanged", callback: (args: FontScaleChangedEventData) => void, thisArg?: any): void;
(event: "windowOpen", callback: (args: WindowOpenEventData) => void, thisArg?: any): void;
(event: "windowClose", callback: (args: WindowCloseEventData) => void, thisArg?: any): void;
(event: "primaryWindowChanged", callback: (args: PrimaryWindowChangedEventData) => void, thisArg?: any): void;
(event: "sceneOpenURLContexts", callback: (args: SceneOpenURLContextsEventData) => void, thisArg?: any): void;
(event: "sceneContinueUserActivity", callback: (args: SceneContinueUserActivityEventData) => void, thisArg?: any): void;
(event: "scenePerformActionForShortcutItem", callback: (args: ScenePerformActionForShortcutItemEventData) => void, thisArg?: any): void;
};Defined in: application/application-common.ts
Call Signature
(
eventNames: string,
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
eventNames | string |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "cssChanged",
callback: (args: CssChangedEventData) => void,
thisArg?: any): void;This event is raised when application css is changed.
Parameters
| Parameter | Type |
|---|---|
event | "cssChanged" |
callback | (args: CssChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "livesync",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Event raised then livesync operation is performed.
Parameters
| Parameter | Type |
|---|---|
event | "livesync" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "launch",
callback: (args: LaunchEventData) => void,
thisArg?: any): void;This event is raised on application launchEvent.
Parameters
| Parameter | Type |
|---|---|
event | "launch" |
callback | (args: LaunchEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "ready",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised once the JS context is initialized.
Parameters
| Parameter | Type |
|---|---|
event | "ready" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "displayed",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Experimental
This event is raised after the application has performed most of its startup actions. Its intent is to be suitable for measuring app startup times.
Parameters
| Parameter | Type |
|---|---|
event | "displayed" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "suspend",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is suspended.
Parameters
| Parameter | Type |
|---|---|
event | "suspend" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "resume",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is resumed after it has been suspended.
Parameters
| Parameter | Type |
|---|---|
event | "resume" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "exit",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is about to exit.
On Android it is raised when the last window closes; the process may stay alive. On iOS it is raised when the process itself terminates.
Parameters
| Parameter | Type |
|---|---|
event | "exit" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "lowMemory",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when there is low memory on the target device.
Parameters
| Parameter | Type |
|---|---|
event | "lowMemory" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "uncaughtError",
callback: (args: UnhandledErrorEventData) => void,
thisArg?: any): void;This event is raised when an uncaught error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "uncaughtError" |
callback | (args: UnhandledErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "discardedError",
callback: (args: DiscardedErrorEventData) => void,
thisArg?: any): void;This event is raised when an discarded error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "discardedError" |
callback | (args: DiscardedErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "orientationChanged",
callback: (args: OrientationChangedEventData) => void,
thisArg?: any): void;This event is raised when the orientation of the application changes.
Parameters
| Parameter | Type |
|---|---|
event | "orientationChanged" |
callback | (args: OrientationChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "systemAppearanceChanged",
callback: (args: SystemAppearanceChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system appearance changes between light and dark theme (for Android); between light and dark mode (for iOS) and vice versa.
Parameters
| Parameter | Type |
|---|---|
event | "systemAppearanceChanged" |
callback | (args: SystemAppearanceChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "layoutDirectionChanged",
callback: (args: LayoutDirectionChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system layout direction changes between ltr and rtl.
Parameters
| Parameter | Type |
|---|---|
event | "layoutDirectionChanged" |
callback | (args: LayoutDirectionChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "fontScaleChanged",
callback: (args: FontScaleChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "fontScaleChanged" |
callback | (args: FontScaleChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowOpen",
callback: (args: WindowOpenEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowOpen" |
callback | (args: WindowOpenEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowClose",
callback: (args: WindowCloseEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowClose" |
callback | (args: WindowCloseEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "primaryWindowChanged",
callback: (args: PrimaryWindowChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "primaryWindowChanged" |
callback | (args: PrimaryWindowChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneOpenURLContexts",
callback: (args: SceneOpenURLContextsEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneOpenURLContexts" |
callback | (args: SceneOpenURLContextsEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneContinueUserActivity",
callback: (args: SceneContinueUserActivityEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneContinueUserActivity" |
callback | (args: SceneContinueUserActivityEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "scenePerformActionForShortcutItem",
callback: (args: ScenePerformActionForShortcutItemEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "scenePerformActionForShortcutItem" |
callback | (args: ScenePerformActionForShortcutItemEventData) => void |
thisArg? | any |
Returns
void
Deprecated
Use Application.android.once() instead.
Accessors
activeWindow
Get Signature
get activeWindow(): NativeWindow;Defined in: application/application-common.ts
Get the NativeWindow the user is currently interacting with - the one that activated most recently and is still attached. Falls back to the primary window while no window holds activation, which is the case before the first window activates and on a platform that never raises activate.
Returns
android
Get Signature
get android(): AndroidApplication;Defined in: application/application-common.ts
Returns
AndroidApplication
Get Signature
get AndroidApplication(): AndroidApplication;Defined in: application/application-common.ts
Returns
autoSystemAppearanceChanged
Get Signature
get autoSystemAppearanceChanged(): boolean;Defined in: application/application-common.ts
Boolean to enable/disable systemAppearanceChanged
Returns
boolean
Set Signature
set autoSystemAppearanceChanged(value: boolean): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
value | boolean |
Returns
void
inBackground
Get Signature
get inBackground(): boolean;Defined in: application/application-common.ts
Returns
boolean
ios
Get Signature
get ios(): iOSApplication;Defined in: application/application-common.ts
Returns
iOSApplication
Get Signature
get iOSApplication(): iOSApplication;Defined in: application/application-common.ts
Returns
primaryWindow
Get Signature
get primaryWindow(): NativeWindow;Defined in: application/application-common.ts
Get the primary NativeWindow.
Returns
suspended
Get Signature
get suspended(): boolean;Defined in: application/application-common.ts
Returns
boolean
Methods
_onPrimaryWindowPromoted()
protected _onPrimaryWindowPromoted(nativeWindow: NativeWindow): void;Defined in: application/application-common.ts
Hook for platform-specific bookkeeping right after a window takes over the primary role, before primaryWindowChanged is raised.
Parameters
| Parameter | Type |
|---|---|
nativeWindow | NativeWindow |
Returns
void
_onWindowRegistered()
protected _onWindowRegistered(nativeWindow: NativeWindow): void;Defined in: application/application-common.ts
Hook for platform-specific bookkeeping right after a window joins the registry, before windowOpen is raised.
Parameters
| Parameter | Type |
|---|---|
nativeWindow | NativeWindow |
Returns
void
addCss()
addCss(cssText: string, attributeScoped?: boolean): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
cssText | string |
attributeScoped? | boolean |
Returns
void
applyCssClass()
applyCssClass(
rootView: View,
cssClasses: string[],
newCssClass: string,
skipCssUpdate?: boolean): void;Defined in: application/application-common.ts
Applies the the newCssClass to the rootView and removes all other css classes from cssClasses previously applied to the rootView.
Parameters
| Parameter | Type | Description |
|---|---|---|
rootView | View | - |
cssClasses | string[] | - |
newCssClass | string | - |
skipCssUpdate? | boolean | - |
Returns
void
createRootView()
createRootView(
view?: View,
fireLaunchEvent?: boolean,
additionalLanchEventData?: any): View;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
view? | View |
fireLaunchEvent? | boolean |
additionalLanchEventData? | any |
Returns
getCssFileName()
getCssFileName(): string;Defined in: application/application-common.ts
Gets css file name for the application.
Returns
string
getLayoutDirection()
protected getLayoutDirection(): LayoutDirectionType;Defined in: application/application-common.ts
Returns
getMainEntry()
getMainEntry(): any;Defined in: application/application-common.ts
Returns
any
The main entry of the application
getNativeApplication()
getNativeApplication(): any;Defined in: application/application-common.ts
Returns
any
getOrientation()
protected getOrientation(): "portrait" | "landscape" | "unknown";Defined in: application/application-common.ts
Returns
"portrait" | "landscape" | "unknown"
getResources()
getResources(): any;Defined in: application/application-common.ts
Get application level static resources.
Returns
any
getRootView()
getRootView(): View;Defined in: application/application-common.ts
Returns
getSystemAppearance()
protected getSystemAppearance(): "dark" | "light";Defined in: application/application-common.ts
Returns
"dark" | "light"
getWindowById()
getWindowById(id: string): NativeWindow;Defined in: application/application-common.ts
Get a registered NativeWindow by its id.
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
getWindowContentResolver()
getWindowContentResolver(): WindowContentResolver;Defined in: application/application-common.ts
Returns
The callback currently supplying window content, if any.
getWindows()
Call Signature
getWindows(role: "all"): WindowBase[];Defined in: application/application-common.ts
Get the active windows, filtered by role.
Defaults to the view-carrying app windows (application and embedded). Pass 'all' to include every registered surface, including ones that carry no view tree.
Parameters
| Parameter | Type |
|---|---|
role | "all" |
Returns
Call Signature
getWindows(role?:
| WindowRole
| WindowRole[]): NativeWindow[];Defined in: application/application-common.ts
Get the active windows, filtered by role.
Defaults to the view-carrying app windows (application and embedded). Pass 'all' to include every registered surface, including ones that carry no view tree.
Parameters
| Parameter | Type |
|---|---|
role? | | WindowRole | WindowRole[] |
Returns
Call Signature
getWindows(role?:
| "all"
| WindowRole
| WindowRole[]): WindowBase[];Defined in: application/application-common.ts
Get the active windows, filtered by role.
Defaults to the view-carrying app windows (application and embedded). Pass 'all' to include every registered surface, including ones that carry no view tree.
Parameters
| Parameter | Type |
|---|---|
role? | | "all" | WindowRole | WindowRole[] |
Returns
hasLaunched()
hasLaunched(): boolean;Defined in: application/application-common.ts
Returns
boolean
initRootView()
initRootView(rootView: View, window?: NativeWindow): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type | Description |
|---|---|---|
rootView | View | - |
window? | NativeWindow | the window the root view belongs to. Supplies the window-scoped CSS classes; without it they come from the primary window. |
Returns
void
layoutDirection()
layoutDirection(): LayoutDirectionType;Defined in: application/application-common.ts
Returns
Deprecated
Use Application.primaryWindow?.layoutDirection() - or the NativeWindow of the relevant view - instead. Continues to reflect the primary window.
layoutDirectionChanged()
layoutDirectionChanged(rootView: View, newLayoutDirection: LayoutDirectionType): void;Defined in: application/application-common.ts
Updates root view classes including those of modals
Parameters
| Parameter | Type | Description |
|---|---|---|
rootView | View | the root view |
newLayoutDirection | LayoutDirectionType | the new layout direction change |
Returns
void
loadAppCss()
loadAppCss(): void;Defined in: application/application-common.ts
Loads immediately the app.css. By default the app.css file is loaded shortly after "loaded". For the Android snapshot the CSS can be parsed during the snapshot generation, as the CSS does not depend on runtime APIs, and loadAppCss will be called explicitly.
Returns
void
notifyLaunch()
protected notifyLaunch(additionalLanchEventData?: any): View;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
additionalLanchEventData? | any |
Returns
openWindow()
openWindow(options?: WindowOpenOptions): void;Defined in: application/application-common.ts
Opens a new window.
Parameters
| Parameter | Type | Description |
|---|---|---|
options? | WindowOpenOptions | Options for the new window, including data to hand to it. |
Returns
void
orientation()
orientation(): "portrait" | "landscape" | "unknown";Defined in: application/application-common.ts
Returns
"portrait" | "landscape" | "unknown"
Deprecated
Use Application.primaryWindow?.orientation() - or the NativeWindow of the relevant view - instead. Continues to reflect the primary window.
orientationChanged()
orientationChanged(rootView: View, newOrientation: "portrait" | "landscape" | "unknown"): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
rootView | View |
newOrientation | "portrait" | "landscape" | "unknown" |
Returns
void
resetRootView()
resetRootView(entry?: string | NavigationEntry): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
entry? | string | NavigationEntry |
Returns
void
run()
run(entry?: string | NavigationEntry): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
entry? | string | NavigationEntry |
Returns
void
setAutoSystemAppearanceChanged()
setAutoSystemAppearanceChanged(value: boolean): void;Defined in: application/application-common.ts
enable/disable systemAppearanceChanged
Parameters
| Parameter | Type |
|---|---|
value | boolean |
Returns
void
setCssFileName()
setCssFileName(cssFileName: string): void;Defined in: application/application-common.ts
Sets css file name for the application.
Parameters
| Parameter | Type |
|---|---|
cssFileName | string |
Returns
void
setInBackground()
setInBackground(value: boolean, additonalData?: any): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
value | boolean |
additonalData? | any |
Returns
void
setLayoutDirection()
protected setLayoutDirection(value: LayoutDirectionType): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
value | LayoutDirectionType |
Returns
void
setMaxRefreshRate()
setMaxRefreshRate(options?: {
max?: number;
min?: number;
preferred?: number;
}): void;Defined in: application/application-common.ts
iOS Only Dynamically change the preferred frame rate For devices (iOS 15+) which support min/max/preferred frame rate you can specify ranges For devices (iOS < 15), you can specify the max frame rate see: https://developer.apple.com/documentation/quartzcore/optimizing_promotion_refresh_rates_for_iphone_13_pro_and_ipad_pro To use, ensure your Info.plist has:
<key>CADisableMinimumFrameDurationOnPhone</key>
<true/>Parameters
| Parameter | Type | Description |
|---|---|---|
options? | { max?: number; min?: number; preferred?: number; } | { min?: number; max?: number; preferred?: number } |
options.max? | number | - |
options.min? | number | - |
options.preferred? | number | - |
Returns
void
setOrientation()
protected setOrientation(value: "portrait" | "landscape" | "unknown"): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
value | "portrait" | "landscape" | "unknown" |
Returns
void
setResources()
setResources(res: any): void;Defined in: application/application-common.ts
Set application level static resources.
Parameters
| Parameter | Type |
|---|---|
res | any |
Returns
void
setSuspended()
setSuspended(value: boolean, additonalData?: any): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
value | boolean |
additonalData? | any |
Returns
void
setSystemAppearance()
protected setSystemAppearance(value: "dark" | "light"): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
value | "dark" | "light" |
Returns
void
setWindowContentResolver()
setWindowContentResolver(resolver: WindowContentResolver): void;Defined in: application/application-common.ts
Sets the callback that supplies the UI for windows that need content. Pass null to remove a previously set resolver.
Parameters
| Parameter | Type |
|---|---|
resolver | WindowContentResolver |
Returns
void
systemAppearance()
systemAppearance(): "dark" | "light";Defined in: application/application-common.ts
Returns
"dark" | "light"
Deprecated
Use Application.primaryWindow?.systemAppearance() - or the NativeWindow of the relevant view - instead. Continues to reflect the primary window.
systemAppearanceChanged()
systemAppearanceChanged(rootView: View, newSystemAppearance: "dark" | "light"): void;Defined in: application/application-common.ts
Updates root view classes including those of modals
Parameters
| Parameter | Type | Description |
|---|---|---|
rootView | View | the root view |
newSystemAppearance | "dark" | "light" | the new appearance change |
Returns
void
- Previous
- Animation
- Next
- Background