9.0 Released! → Native ESM runtimes 🚀, Vite support ⚡️, multi-window apps and more...
Read Announcement

Defined in: application/application.d.ts:152

Extends ​

Properties ​

autoSystemAppearanceChanged ​

ts
autoSystemAppearanceChanged: boolean;

Defined in: application/application-common.ts

Boolean to enable/disable systemAppearanceChanged

Inherited from ​

ApplicationCommon.autoSystemAppearanceChanged

backgroundEvent ​

ts
readonly backgroundEvent: "background" = "background";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.backgroundEvent

cssChangedEvent ​

ts
readonly cssChangedEvent: "cssChanged" = "cssChanged";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.cssChangedEvent

discardedErrorEvent ​

ts
readonly discardedErrorEvent: "discardedError" = "discardedError";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.discardedErrorEvent

displayedEvent ​

ts
readonly displayedEvent: "displayed" = "displayed";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.displayedEvent

exitEvent ​

ts
readonly exitEvent: "exit" = "exit";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.exitEvent

fontScaleChangedEvent ​

ts
readonly fontScaleChangedEvent: "fontScaleChanged" = "fontScaleChanged";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.fontScaleChangedEvent

foregroundEvent ​

ts
readonly foregroundEvent: "foreground" = "foreground";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.foregroundEvent

hasListeners ​

ts
hasListeners: (eventName: string) => boolean;

Defined in: application/application-common.ts

Parameters ​

ParameterType
eventNamestring

Returns ​

boolean

Inherited from ​

ApplicationCommon.hasListeners

initRootViewEvent ​

ts
readonly initRootViewEvent: "initRootView" = "initRootView";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.initRootViewEvent

launchEvent ​

ts
readonly launchEvent: "launch" = "launch";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.launchEvent

layoutDirectionChangedEvent ​

ts
readonly layoutDirectionChangedEvent: "layoutDirectionChanged" = "layoutDirectionChanged";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.layoutDirectionChangedEvent

livesyncEvent ​

ts
readonly livesyncEvent: "livesync" = "livesync";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.livesyncEvent

loadAppCssEvent ​

ts
readonly loadAppCssEvent: "loadAppCss" = "loadAppCss";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.loadAppCssEvent

lowMemoryEvent ​

ts
readonly lowMemoryEvent: "lowMemory" = "lowMemory";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.lowMemoryEvent

mainEntry ​

ts
protected mainEntry: NavigationEntry;

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.mainEntry

notify ​

ts
notify: <T>(eventData: T) => void;

Defined in: application/application-common.ts

Type Parameters ​

Type ParameterDefault type
TApplicationEventData

Parameters ​

ParameterType
eventDataT

Returns ​

void

Inherited from ​

ApplicationCommon.notify

off ​

ts
off: (eventNames: string, callback?: any, thisArg?: any) => void;

Defined in: application/application-common.ts

Parameters ​

ParameterType
eventNamesstring
callback?any
thisArg?any

Returns ​

void

Inherited from ​

ApplicationCommon.off

on ​

ts
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: "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;
};

Defined in: application/application-common.ts

Call Signature ​

ts
(
   eventNames: string, 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;
Parameters ​
ParameterType
eventNamesstring
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "cssChanged", 
   callback: (args: CssChangedEventData) => void, 
   thisArg?: any): void;

This event is raised when application css is changed.

Parameters ​
ParameterType
event"cssChanged"
callback(args: CssChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "livesync", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

Event raised then livesync operation is performed.

Parameters ​
ParameterType
event"livesync"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "launch", 
   callback: (args: LaunchEventData) => void, 
   thisArg?: any): void;

This event is raised on application launchEvent.

Parameters ​
ParameterType
event"launch"
callback(args: LaunchEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   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 ​
ParameterType
event"displayed"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "suspend", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when the Application is suspended.

Parameters ​
ParameterType
event"suspend"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "resume", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when the Application is resumed after it has been suspended.

Parameters ​
ParameterType
event"resume"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "exit", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when the Application is about to exit.

Parameters ​
ParameterType
event"exit"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "lowMemory", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when there is low memory on the target device.

Parameters ​
ParameterType
event"lowMemory"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "uncaughtError", 
   callback: (args: UnhandledErrorEventData) => void, 
   thisArg?: any): void;

This event is raised when an uncaught error occurs while the application is running.

Parameters ​
ParameterType
event"uncaughtError"
callback(args: UnhandledErrorEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "discardedError", 
   callback: (args: DiscardedErrorEventData) => void, 
   thisArg?: any): void;

This event is raised when an discarded error occurs while the application is running.

Parameters ​
ParameterType
event"discardedError"
callback(args: DiscardedErrorEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "orientationChanged", 
   callback: (args: OrientationChangedEventData) => void, 
   thisArg?: any): void;

This event is raised when the orientation of the application changes.

Parameters ​
ParameterType
event"orientationChanged"
callback(args: OrientationChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   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 ​
ParameterType
event"systemAppearanceChanged"
callback(args: SystemAppearanceChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   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 ​
ParameterType
event"layoutDirectionChanged"
callback(args: LayoutDirectionChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "fontScaleChanged", 
   callback: (args: FontScaleChangedEventData) => void, 
   thisArg?: any): void;
Parameters ​
ParameterType
event"fontScaleChanged"
callback(args: FontScaleChangedEventData) => void
thisArg?any
Returns ​

void

Inherited from ​

ApplicationCommon.on

once ​

ts
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: "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;
};

Defined in: application/application-common.ts

Call Signature ​

ts
(
   eventNames: string, 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;
Parameters ​
ParameterType
eventNamesstring
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "cssChanged", 
   callback: (args: CssChangedEventData) => void, 
   thisArg?: any): void;

This event is raised when application css is changed.

Parameters ​
ParameterType
event"cssChanged"
callback(args: CssChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "livesync", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

Event raised then livesync operation is performed.

Parameters ​
ParameterType
event"livesync"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "launch", 
   callback: (args: LaunchEventData) => void, 
   thisArg?: any): void;

This event is raised on application launchEvent.

Parameters ​
ParameterType
event"launch"
callback(args: LaunchEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   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 ​
ParameterType
event"displayed"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "suspend", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when the Application is suspended.

Parameters ​
ParameterType
event"suspend"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "resume", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when the Application is resumed after it has been suspended.

Parameters ​
ParameterType
event"resume"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "exit", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when the Application is about to exit.

Parameters ​
ParameterType
event"exit"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "lowMemory", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when there is low memory on the target device.

Parameters ​
ParameterType
event"lowMemory"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "uncaughtError", 
   callback: (args: UnhandledErrorEventData) => void, 
   thisArg?: any): void;

This event is raised when an uncaught error occurs while the application is running.

Parameters ​
ParameterType
event"uncaughtError"
callback(args: UnhandledErrorEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "discardedError", 
   callback: (args: DiscardedErrorEventData) => void, 
   thisArg?: any): void;

This event is raised when an discarded error occurs while the application is running.

Parameters ​
ParameterType
event"discardedError"
callback(args: DiscardedErrorEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "orientationChanged", 
   callback: (args: OrientationChangedEventData) => void, 
   thisArg?: any): void;

This event is raised when the orientation of the application changes.

Parameters ​
ParameterType
event"orientationChanged"
callback(args: OrientationChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   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 ​
ParameterType
event"systemAppearanceChanged"
callback(args: SystemAppearanceChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   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 ​
ParameterType
event"layoutDirectionChanged"
callback(args: LayoutDirectionChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "fontScaleChanged", 
   callback: (args: FontScaleChangedEventData) => void, 
   thisArg?: any): void;
Parameters ​
ParameterType
event"fontScaleChanged"
callback(args: FontScaleChangedEventData) => void
thisArg?any
Returns ​

void

Inherited from ​

ApplicationCommon.once

orientationChangedEvent ​

ts
readonly orientationChangedEvent: "orientationChanged" = "orientationChanged";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.orientationChangedEvent

resumeEvent ​

ts
readonly resumeEvent: "resume" = "resume";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.resumeEvent

sceneDelegate ​

ts
sceneDelegate: UIWindowSceneDelegate;

Defined in: application/application.d.ts:267

The scene delegate for the application. Get the current one or set a custom one.

shouldDelayLaunchEvent ​

ts
shouldDelayLaunchEvent: boolean;

Defined in: application/application.d.ts:273

Flag to be set when the launch event should be delayed until the application has become active. This is useful when you want to process notifications or data in the background without creating the UI.

started ​

ts
started: boolean;

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.started

suspendEvent ​

ts
readonly suspendEvent: "suspend" = "suspend";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.suspendEvent

systemAppearanceChangedEvent ​

ts
readonly systemAppearanceChangedEvent: "systemAppearanceChanged" = "systemAppearanceChanged";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.systemAppearanceChangedEvent

uncaughtErrorEvent ​

ts
readonly uncaughtErrorEvent: "uncaughtError" = "uncaughtError";

Defined in: application/application-common.ts

Inherited from ​

ApplicationCommon.uncaughtErrorEvent

hasListeners ​

ts
static hasListeners: (eventName: string) => boolean;

Defined in: application/application-common.ts

Parameters ​

ParameterType
eventNamestring

Returns ​

boolean

Deprecated ​

Use Application.android.hasListeners() instead.

Inherited from ​

ApplicationCommon.hasListeners

notify ​

ts
static notify: <T>(eventData: T) => void;

Defined in: application/application-common.ts

Type Parameters ​

Type ParameterDefault type
TApplicationEventData

Parameters ​

ParameterType
eventDataT

Returns ​

void

Deprecated ​

Use Application.android.notify() instead.

Inherited from ​

ApplicationCommon.notify

off ​

ts
static off: (eventNames: string, callback?: any, thisArg?: any) => void;

Defined in: application/application-common.ts

Parameters ​

ParameterType
eventNamesstring
callback?any
thisArg?any

Returns ​

void

Deprecated ​

Use Application.android.off() instead.

Inherited from ​

ApplicationCommon.off

on ​

ts
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: "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;
};

Defined in: application/application-common.ts

Call Signature ​

ts
(
   eventNames: string, 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;
Parameters ​
ParameterType
eventNamesstring
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "cssChanged", 
   callback: (args: CssChangedEventData) => void, 
   thisArg?: any): void;

This event is raised when application css is changed.

Parameters ​
ParameterType
event"cssChanged"
callback(args: CssChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "livesync", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

Event raised then livesync operation is performed.

Parameters ​
ParameterType
event"livesync"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "launch", 
   callback: (args: LaunchEventData) => void, 
   thisArg?: any): void;

This event is raised on application launchEvent.

Parameters ​
ParameterType
event"launch"
callback(args: LaunchEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   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 ​
ParameterType
event"displayed"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "suspend", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when the Application is suspended.

Parameters ​
ParameterType
event"suspend"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "resume", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when the Application is resumed after it has been suspended.

Parameters ​
ParameterType
event"resume"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "exit", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when the Application is about to exit.

Parameters ​
ParameterType
event"exit"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "lowMemory", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when there is low memory on the target device.

Parameters ​
ParameterType
event"lowMemory"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "uncaughtError", 
   callback: (args: UnhandledErrorEventData) => void, 
   thisArg?: any): void;

This event is raised when an uncaught error occurs while the application is running.

Parameters ​
ParameterType
event"uncaughtError"
callback(args: UnhandledErrorEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "discardedError", 
   callback: (args: DiscardedErrorEventData) => void, 
   thisArg?: any): void;

This event is raised when an discarded error occurs while the application is running.

Parameters ​
ParameterType
event"discardedError"
callback(args: DiscardedErrorEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "orientationChanged", 
   callback: (args: OrientationChangedEventData) => void, 
   thisArg?: any): void;

This event is raised when the orientation of the application changes.

Parameters ​
ParameterType
event"orientationChanged"
callback(args: OrientationChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   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 ​
ParameterType
event"systemAppearanceChanged"
callback(args: SystemAppearanceChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   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 ​
ParameterType
event"layoutDirectionChanged"
callback(args: LayoutDirectionChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "fontScaleChanged", 
   callback: (args: FontScaleChangedEventData) => void, 
   thisArg?: any): void;
Parameters ​
ParameterType
event"fontScaleChanged"
callback(args: FontScaleChangedEventData) => void
thisArg?any
Returns ​

void

Deprecated ​

Use Application.android.on() instead.

Inherited from ​

ApplicationCommon.on

once ​

ts
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: "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;
};

Defined in: application/application-common.ts

Call Signature ​

ts
(
   eventNames: string, 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;
Parameters ​
ParameterType
eventNamesstring
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "cssChanged", 
   callback: (args: CssChangedEventData) => void, 
   thisArg?: any): void;

This event is raised when application css is changed.

Parameters ​
ParameterType
event"cssChanged"
callback(args: CssChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "livesync", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

Event raised then livesync operation is performed.

Parameters ​
ParameterType
event"livesync"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "launch", 
   callback: (args: LaunchEventData) => void, 
   thisArg?: any): void;

This event is raised on application launchEvent.

Parameters ​
ParameterType
event"launch"
callback(args: LaunchEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   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 ​
ParameterType
event"displayed"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "suspend", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when the Application is suspended.

Parameters ​
ParameterType
event"suspend"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "resume", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when the Application is resumed after it has been suspended.

Parameters ​
ParameterType
event"resume"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "exit", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when the Application is about to exit.

Parameters ​
ParameterType
event"exit"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "lowMemory", 
   callback: (args: ApplicationEventData) => void, 
   thisArg?: any): void;

This event is raised when there is low memory on the target device.

Parameters ​
ParameterType
event"lowMemory"
callback(args: ApplicationEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "uncaughtError", 
   callback: (args: UnhandledErrorEventData) => void, 
   thisArg?: any): void;

This event is raised when an uncaught error occurs while the application is running.

Parameters ​
ParameterType
event"uncaughtError"
callback(args: UnhandledErrorEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "discardedError", 
   callback: (args: DiscardedErrorEventData) => void, 
   thisArg?: any): void;

This event is raised when an discarded error occurs while the application is running.

Parameters ​
ParameterType
event"discardedError"
callback(args: DiscardedErrorEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "orientationChanged", 
   callback: (args: OrientationChangedEventData) => void, 
   thisArg?: any): void;

This event is raised when the orientation of the application changes.

Parameters ​
ParameterType
event"orientationChanged"
callback(args: OrientationChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   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 ​
ParameterType
event"systemAppearanceChanged"
callback(args: SystemAppearanceChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   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 ​
ParameterType
event"layoutDirectionChanged"
callback(args: LayoutDirectionChangedEventData) => void
thisArg?any
Returns ​

void

Call Signature ​

ts
(
   event: "fontScaleChanged", 
   callback: (args: FontScaleChangedEventData) => void, 
   thisArg?: any): void;
Parameters ​
ParameterType
event"fontScaleChanged"
callback(args: FontScaleChangedEventData) => void
thisArg?any
Returns ​

void

Deprecated ​

Use Application.android.once() instead.

Inherited from ​

ApplicationCommon.once

Accessors ​

android ​

Get Signature ​

ts
get android(): AndroidApplication;

Defined in: application/application-common.ts

Returns ​

AndroidApplication

Inherited from ​

ApplicationCommon.android

AndroidApplication ​

Get Signature ​

ts
get AndroidApplication(): AndroidApplication;

Defined in: application/application-common.ts

Returns ​

AndroidApplication

Inherited from ​

ApplicationCommon.AndroidApplication

delegate ​

Get Signature ​

ts
get delegate(): any;

Defined in: application/application.d.ts:171

The UIApplicationDelegate class.

Returns ​

any

Set Signature ​

ts
set delegate(value: any): void;

Defined in: application/application.d.ts:176

Sets a custom UIApplicationDelegate class.

Parameters ​
ParameterType
valueany
Returns ​

void

inBackground ​

Get Signature ​

ts
get inBackground(): boolean;

Defined in: application/application-common.ts

Returns ​

boolean

Inherited from ​

ApplicationCommon.inBackground

ios ​

Get Signature ​

ts
get ios(): iOSApplication;

Defined in: application/application-common.ts

Returns ​

iOSApplication

Inherited from ​

ApplicationCommon.ios

iOSApplication ​

Get Signature ​

ts
get iOSApplication(): iOSApplication;

Defined in: application/application-common.ts

Returns ​

iOSApplication

Inherited from ​

ApplicationCommon.iOSApplication

nativeApp ​

Get Signature ​

ts
get nativeApp(): UIApplication;

Defined in: application/application.d.ts:161

The UIApplication.

Returns ​

UIApplication

rootController ​

Get Signature ​

ts
get rootController(): UIViewController;

Defined in: application/application.d.ts:156

The root view controller for the application.

Returns ​

UIViewController

suspended ​

Get Signature ​

ts
get suspended(): boolean;

Defined in: application/application-common.ts

Returns ​

boolean

Inherited from ​

ApplicationCommon.suspended

window ​

Get Signature ​

ts
get window(): UIWindow;

Defined in: application/application.d.ts:166

The key window.

Returns ​

UIWindow

Methods ​

addCss() ​

ts
addCss(cssText: string, attributeScoped?: boolean): void;

Defined in: application/application-common.ts

Parameters ​

ParameterType
cssTextstring
attributeScoped?boolean

Returns ​

void

Inherited from ​

ApplicationCommon.addCss

addDelegateHandler() ​

ts
addDelegateHandler<T>(methodName: T, handler: any): void;

Defined in: application/application.d.ts:184

Adds a delegate handler for the specified delegate method name. This method does not replace an existing handler, but rather adds the new handler to the existing chain of handlers.

Type Parameters ​

Type Parameter
T extends string | number | symbol

Parameters ​

ParameterTypeDescription
methodNameTThe name of the delegate method to add a handler for.
handleranyA function that will be called when the specified delegate method is called.

Returns ​

void

addNotificationObserver() ​

ts
addNotificationObserver(notificationName: string, onReceiveCallback: (notification: NSNotification) => void): NotificationObserver;

Defined in: application/application.d.ts:192

Adds an observer to the default notification center for the specified notification. For more information, please visit 'https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSNotificationCenter_Class/#//apple_ref/occ/instm/NSNotificationCenter/addObserver:selector:name:object:'

Parameters ​

ParameterTypeDescription
notificationNamestringA string containing the name of the notification.
onReceiveCallback(notification: NSNotification) => voidA callback function that will be called each time the observer receives a notification.

Returns ​

NotificationObserver

applyCssClass() ​

ts
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 ​

ParameterTypeDescription
rootViewView-
cssClassesstring[]-
newCssClassstring-
skipCssUpdate?boolean-

Returns ​

void

Inherited from ​

ApplicationCommon.applyCssClass

closeWindow() ​

ts
closeWindow(target?: any): void;

Defined in: application/application.d.ts:229

Closes a secondary window/scene. If no target is provided, attempts to close a non-primary active scene.

Parameters ​

ParameterTypeDescription
target?anyOptional target to resolve the scene to close. Can be a View, UIWindow, UIWindowScene, or a string scene identifier.

Returns ​

void

createRootView() ​

ts
createRootView(
   view?: View, 
   fireLaunchEvent?: boolean, 
   additionalLanchEventData?: any): View;

Defined in: application/application-common.ts

Parameters ​

ParameterType
view?View
fireLaunchEvent?boolean
additionalLanchEventData?any

Returns ​

View

Inherited from ​

ApplicationCommon.createRootView

getAllScenes() ​

ts
getAllScenes(): UIScene[];

Defined in: application/application.d.ts:239

Gets all scenes for the application.

Returns ​

UIScene[]

getAllWindows() ​

ts
getAllWindows(): UIWindow[];

Defined in: application/application.d.ts:234

Gets all windows for the application.

Returns ​

UIWindow[]

getCssFileName() ​

ts
getCssFileName(): string;

Defined in: application/application-common.ts

Gets css file name for the application.

Returns ​

string

Inherited from ​

ApplicationCommon.getCssFileName

getLayoutDirection() ​

ts
protected getLayoutDirection(): LayoutDirectionType;

Defined in: application/application-common.ts

Returns ​

LayoutDirectionType

Inherited from ​

ApplicationCommon.getLayoutDirection

getMainEntry() ​

ts
getMainEntry(): any;

Defined in: application/application-common.ts

Returns ​

any

The main entry of the application

Inherited from ​

ApplicationCommon.getMainEntry

getNativeApplication() ​

ts
getNativeApplication(): any;

Defined in: application/application-common.ts

Returns ​

any

Inherited from ​

ApplicationCommon.getNativeApplication

getOrientation() ​

ts
protected getOrientation(): "portrait" | "landscape" | "unknown";

Defined in: application/application-common.ts

Returns ​

"portrait" | "landscape" | "unknown"

Inherited from ​

ApplicationCommon.getOrientation

getPrimaryScene() ​

ts
getPrimaryScene(): UIWindowScene;

Defined in: application/application.d.ts:254

Gets the primary scene for the application.

Returns ​

UIWindowScene

getPrimaryWindow() ​

ts
getPrimaryWindow(): UIWindow;

Defined in: application/application.d.ts:249

Gets the primary window for the application.

Returns ​

UIWindow

getResources() ​

ts
getResources(): any;

Defined in: application/application-common.ts

Get application level static resources.

Returns ​

any

Inherited from ​

ApplicationCommon.getResources

getRootView() ​

ts
getRootView(): View;

Defined in: application/application-common.ts

Returns ​

View

Inherited from ​

ApplicationCommon.getRootView

getSystemAppearance() ​

ts
protected getSystemAppearance(): "dark" | "light";

Defined in: application/application-common.ts

Returns ​

"dark" | "light"

Inherited from ​

ApplicationCommon.getSystemAppearance

getWindowScenes() ​

ts
getWindowScenes(): UIWindowScene[];

Defined in: application/application.d.ts:244

Gets all window scenes for the application.

Returns ​

UIWindowScene[]

hasLaunched() ​

ts
hasLaunched(): boolean;

Defined in: application/application-common.ts

Returns ​

boolean

Inherited from ​

ApplicationCommon.hasLaunched

initRootView() ​

ts
initRootView(rootView: View): void;

Defined in: application/application-common.ts

Parameters ​

ParameterType
rootViewView

Returns ​

void

Inherited from ​

ApplicationCommon.initRootView

isUsingSceneLifecycle() ​

ts
isUsingSceneLifecycle(): boolean;

Defined in: application/application.d.ts:216

Checks if the application is using the scene lifecycle.

Returns ​

boolean

layoutDirection() ​

ts
layoutDirection(): LayoutDirectionType;

Defined in: application/application-common.ts

Returns ​

LayoutDirectionType

Inherited from ​

ApplicationCommon.layoutDirection

layoutDirectionChanged() ​

ts
layoutDirectionChanged(rootView: View, newLayoutDirection: LayoutDirectionType): void;

Defined in: application/application-common.ts

Updates root view classes including those of modals

Parameters ​

ParameterTypeDescription
rootViewViewthe root view
newLayoutDirectionLayoutDirectionTypethe new layout direction change

Returns ​

void

Inherited from ​

ApplicationCommon.layoutDirectionChanged

loadAppCss() ​

ts
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

Inherited from ​

ApplicationCommon.loadAppCss

notifyLaunch() ​

ts
protected notifyLaunch(additionalLanchEventData?: any): View;

Defined in: application/application-common.ts

Parameters ​

ParameterType
additionalLanchEventData?any

Returns ​

View

Inherited from ​

ApplicationCommon.notifyLaunch

openWindow() ​

ts
openWindow(data: Record<any, any>): void;

Defined in: application/application.d.ts:222

Opens a new window with the specified data.

Parameters ​

ParameterTypeDescription
dataRecord<any, any>The data to pass to the new window.

Returns ​

void

orientation() ​

ts
orientation(): "portrait" | "landscape" | "unknown";

Defined in: application/application-common.ts

Returns ​

"portrait" | "landscape" | "unknown"

Inherited from ​

ApplicationCommon.orientation

orientationChanged() ​

ts
orientationChanged(rootView: View, newOrientation: "portrait" | "landscape" | "unknown"): void;

Defined in: application/application-common.ts

Parameters ​

ParameterType
rootViewView
newOrientation"portrait" | "landscape" | "unknown"

Returns ​

void

Inherited from ​

ApplicationCommon.orientationChanged

removeNotificationObserver() ​

ts
removeNotificationObserver(observer: any, notificationName: string): any;

Defined in: application/application.d.ts:201

Removes the observer for the specified notification from the default notification center. For more information, please visit 'https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSNotificationCenter_Class/#//apple_ref/occ/instm/NSNotificationCenter/addObserver:selector:name:object:'

Parameters ​

ParameterTypeDescription
observeranyThe observer that was returned from the addNotificationObserver method.
notificationNamestringA string containing the name of the notification.

Returns ​

any

resetRootView() ​

ts
resetRootView(entry?: string | NavigationEntry): void;

Defined in: application/application-common.ts

Parameters ​

ParameterType
entry?string | NavigationEntry

Returns ​

void

Inherited from ​

ApplicationCommon.resetRootView

run() ​

ts
run(entry?: string | NavigationEntry): void;

Defined in: application/application-common.ts

Parameters ​

ParameterType
entry?string | NavigationEntry

Returns ​

void

Inherited from ​

ApplicationCommon.run

setAutoSystemAppearanceChanged() ​

ts
setAutoSystemAppearanceChanged(value: boolean): void;

Defined in: application/application-common.ts

enable/disable systemAppearanceChanged

Parameters ​

ParameterType
valueboolean

Returns ​

void

Inherited from ​

ApplicationCommon.setAutoSystemAppearanceChanged

setCssFileName() ​

ts
setCssFileName(cssFileName: string): void;

Defined in: application/application-common.ts

Sets css file name for the application.

Parameters ​

ParameterType
cssFileNamestring

Returns ​

void

Inherited from ​

ApplicationCommon.setCssFileName

setInBackground() ​

ts
setInBackground(value: boolean, additonalData?: any): void;

Defined in: application/application-common.ts

Parameters ​

ParameterType
valueboolean
additonalData?any

Returns ​

void

Inherited from ​

ApplicationCommon.setInBackground

setLayoutDirection() ​

ts
protected setLayoutDirection(value: LayoutDirectionType): void;

Defined in: application/application-common.ts

Parameters ​

ParameterType
valueLayoutDirectionType

Returns ​

void

Inherited from ​

ApplicationCommon.setLayoutDirection

setMaxRefreshRate() ​

ts
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:

xml
  <key>CADisableMinimumFrameDurationOnPhone</key>
  <true/>

Parameters ​

ParameterTypeDescription
options?{ max?: number; min?: number; preferred?: number; }{ min?: number; max?: number; preferred?: number }
options.max?number-
options.min?number-
options.preferred?number-

Returns ​

void

Inherited from ​

ApplicationCommon.setMaxRefreshRate

setOrientation() ​

ts
protected setOrientation(value: "portrait" | "landscape" | "unknown"): void;

Defined in: application/application-common.ts

Parameters ​

ParameterType
value"portrait" | "landscape" | "unknown"

Returns ​

void

Inherited from ​

ApplicationCommon.setOrientation

setResources() ​

ts
setResources(res: any): void;

Defined in: application/application-common.ts

Set application level static resources.

Parameters ​

ParameterType
resany

Returns ​

void

Inherited from ​

ApplicationCommon.setResources

setSuspended() ​

ts
setSuspended(value: boolean, additonalData?: any): void;

Defined in: application/application-common.ts

Parameters ​

ParameterType
valueboolean
additonalData?any

Returns ​

void

Inherited from ​

ApplicationCommon.setSuspended

setSystemAppearance() ​

ts
protected setSystemAppearance(value: "dark" | "light"): void;

Defined in: application/application-common.ts

Parameters ​

ParameterType
value"dark" | "light"

Returns ​

void

Inherited from ​

ApplicationCommon.setSystemAppearance

setWindowRootView() ​

ts
setWindowRootView(window: UIWindow, view: View): void;

Defined in: application/application.d.ts:261

Sets the root view for a specific window.

Parameters ​

ParameterTypeDescription
windowUIWindowThe window to set the root view for.
viewViewThe view to set as the root view.

Returns ​

void

supportsMultipleScenes() ​

ts
supportsMultipleScenes(): boolean;

Defined in: application/application.d.ts:211

Checks if the application supports multiple scenes.

Returns ​

boolean

supportsScenes() ​

ts
supportsScenes(): boolean;

Defined in: application/application.d.ts:206

Checks if the application supports scenes.

Returns ​

boolean

systemAppearance() ​

ts
systemAppearance(): "dark" | "light";

Defined in: application/application-common.ts

Returns ​

"dark" | "light"

Inherited from ​

ApplicationCommon.systemAppearance

systemAppearanceChanged() ​

ts
systemAppearanceChanged(rootView: View, newSystemAppearance: "dark" | "light"): void;

Defined in: application/application-common.ts

Updates root view classes including those of modals

Parameters ​

ParameterTypeDescription
rootViewViewthe root view
newSystemAppearance"dark" | "light"the new appearance change

Returns ​

void

Inherited from ​

ApplicationCommon.systemAppearanceChanged

Next
ItemSpec