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

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

Extends ​

Properties ​

activityBackPressedEvent ​

ts
readonly activityBackPressedEvent: "activityBackPressed" = AndroidApplication.activityBackPressedEvent;

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

activityCreatedEvent ​

ts
readonly activityCreatedEvent: "activityCreated" = AndroidApplication.activityCreatedEvent;

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

activityDestroyedEvent ​

ts
readonly activityDestroyedEvent: "activityDestroyed" = AndroidApplication.activityDestroyedEvent;

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

activityNewIntentEvent ​

ts
readonly activityNewIntentEvent: "activityNewIntent" = AndroidApplication.activityNewIntentEvent;

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

activityPausedEvent ​

ts
readonly activityPausedEvent: "activityPaused" = AndroidApplication.activityPausedEvent;

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

activityRequestPermissionsEvent ​

ts
readonly activityRequestPermissionsEvent: "activityRequestPermissions" = AndroidApplication.activityRequestPermissionsEvent;

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

activityResultEvent ​

ts
readonly activityResultEvent: "activityResult" = AndroidApplication.activityResultEvent;

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

activityResumedEvent ​

ts
readonly activityResumedEvent: "activityResumed" = AndroidApplication.activityResumedEvent;

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

activityStartedEvent ​

ts
readonly activityStartedEvent: "activityStarted" = AndroidApplication.activityStartedEvent;

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

activityStoppedEvent ​

ts
readonly activityStoppedEvent: "activityStopped" = AndroidApplication.activityStoppedEvent;

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

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

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

saveActivityStateEvent ​

ts
readonly saveActivityStateEvent: "saveActivityState" = AndroidApplication.saveActivityStateEvent;

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

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

activityBackPressedEvent ​

ts
readonly static activityBackPressedEvent: "activityBackPressed" = 'activityBackPressed';

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

Deprecated ​

Use Application.android.activityBackPressedEvent instead.

activityCreatedEvent ​

ts
readonly static activityCreatedEvent: "activityCreated" = 'activityCreated';

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

Deprecated ​

Use Application.android.activityCreatedEvent instead.

activityDestroyedEvent ​

ts
readonly static activityDestroyedEvent: "activityDestroyed" = 'activityDestroyed';

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

Deprecated ​

Use Application.android.activityDestroyedEvent instead.

activityNewIntentEvent ​

ts
readonly static activityNewIntentEvent: "activityNewIntent" = 'activityNewIntent';

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

Deprecated ​

Use Application.android.activityNewIntentEvent instead.

activityPausedEvent ​

ts
readonly static activityPausedEvent: "activityPaused" = 'activityPaused';

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

Deprecated ​

Use Application.android.activityPausedEvent instead.

activityRequestPermissionsEvent ​

ts
readonly static activityRequestPermissionsEvent: "activityRequestPermissions" = 'activityRequestPermissions';

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

Deprecated ​

Use Application.android.activityRequestPermissionsEvent instead.

activityResultEvent ​

ts
readonly static activityResultEvent: "activityResult" = 'activityResult';

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

Deprecated ​

Use Application.android.activityResultEvent instead.

activityResumedEvent ​

ts
readonly static activityResumedEvent: "activityResumed" = 'activityResumed';

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

Deprecated ​

Use Application.android.activityResumedEvent instead.

activityStartedEvent ​

ts
readonly static activityStartedEvent: "activityStarted" = 'activityStarted';

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

Deprecated ​

Use Application.android.activityStartedEvent instead.

activityStoppedEvent ​

ts
readonly static activityStoppedEvent: "activityStopped" = 'activityStopped';

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

Deprecated ​

Use Application.android.activityStoppedEvent instead.

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

saveActivityStateEvent ​

ts
readonly static saveActivityStateEvent: "saveActivityState" = 'saveActivityState';

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

Deprecated ​

Use Application.android.saveActivityStateEvent instead.

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

backgrounded ​

Get Signature ​

ts
get backgrounded(): boolean;

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

Deprecated ​

Use Application.inBackground instead.

Returns ​

boolean

context ​

Get Signature ​

ts
get context(): Context;

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

Deprecated ​

Use Utils.android.getApplicationContext() instead.

Returns ​

Context

foregroundActivity ​

Get Signature ​

ts
get foregroundActivity(): AppCompatActivity;

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

The currently active (loaded) android Activity.

This property is automatically updated upon Activity events.

Returns ​

AppCompatActivity

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(): Application;

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

The android Application object instance provided to the init of the module.

Returns ​

Application

packageName ​

Get Signature ​

ts
get packageName(): string;

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

Deprecated ​

Use Utils.android.getPackageName() instead.

Returns ​

string

paused ​

Get Signature ​

ts
get paused(): boolean;

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

Deprecated ​

Use Application.suspended instead.

Returns ​

boolean

startActivity ​

Get Signature ​

ts
get startActivity(): AppCompatActivity;

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

The main (start) Activity for the application.

Returns ​

AppCompatActivity

suspended ​

Get Signature ​

ts
get suspended(): boolean;

Defined in: application/application-common.ts

Returns ​

boolean

Inherited from ​

ApplicationCommon.suspended

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

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

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

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(): Application;

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

Returns ​

Application

Overrides ​

ApplicationCommon.getNativeApplication

getOrientation() ​

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

Defined in: application/application-common.ts

Returns ​

"portrait" | "landscape" | "unknown"

Inherited from ​

ApplicationCommon.getOrientation

getRegisteredBroadcastReceiver() ​

ts
getRegisteredBroadcastReceiver(intentFilter: string): BroadcastReceiver;

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

Get a registered BroadcastReceiver, then you can get the result code of BroadcastReceiver in onReceiveCallback method.

Parameters ​

ParameterTypeDescription
intentFilterstringA string containing the intent filter.

Returns ​

BroadcastReceiver

Deprecated ​

Use getRegisteredBroadcastReceivers instead.

getRegisteredBroadcastReceivers() ​

ts
getRegisteredBroadcastReceivers(intentFilter: string): BroadcastReceiver[];

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

Get all registered BroadcastReceivers for a specific intent filter.

Parameters ​

ParameterTypeDescription
intentFilterstringa string containing the intent filter

Returns ​

BroadcastReceiver[]

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

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

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

on() ​

Call Signature ​

ts
on(
   event: "activityCreated", 
   callback: (args: AndroidActivityBundleEventData) => void, 
   thisArg?: any): void;

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

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

void

Overrides ​
ts
ApplicationCommon.on

Call Signature ​

ts
on(
   event: "activityDestroyed", 
   callback: (args: AndroidActivityEventData) => void, 
   thisArg?: any): void;

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

This event is raised when application css is changed.

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

void

Overrides ​
ts
ApplicationCommon.on

Call Signature ​

ts
on(
   event: "activityStarted", 
   callback: (args: AndroidActivityEventData) => void, 
   thisArg?: any): void;

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

Event raised then livesync operation is performed.

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

void

Overrides ​
ts
ApplicationCommon.on

Call Signature ​

ts
on(
   event: "activityPaused", 
   callback: (args: AndroidActivityEventData) => void, 
   thisArg?: any): void;

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

This event is raised on application launchEvent.

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

void

Overrides ​
ts
ApplicationCommon.on

Call Signature ​

ts
on(
   event: "activityResumed", 
   callback: (args: AndroidActivityEventData) => void, 
   thisArg?: any): void;

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

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"activityResumed"
callback(args: AndroidActivityEventData) => void
thisArg?any
Returns ​

void

Overrides ​
ts
ApplicationCommon.on

Call Signature ​

ts
on(
   event: "activityStopped", 
   callback: (args: AndroidActivityEventData) => void, 
   thisArg?: any): void;

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

This event is raised when the Application is suspended.

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

void

Overrides ​
ts
ApplicationCommon.on

Call Signature ​

ts
on(
   event: "saveActivityState", 
   callback: (args: AndroidActivityBundleEventData) => void, 
   thisArg?: any): void;

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

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

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

void

Overrides ​
ts
ApplicationCommon.on

Call Signature ​

ts
on(
   event: "activityResult", 
   callback: (args: AndroidActivityResultEventData) => void, 
   thisArg?: any): void;

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

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

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

void

Overrides ​
ts
ApplicationCommon.on

Call Signature ​

ts
on(
   event: "activityBackPressed", 
   callback: (args: AndroidActivityBackPressedEventData) => void, 
   thisArg?: any): void;

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

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

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

void

Overrides ​
ts
ApplicationCommon.on

Call Signature ​

ts
on(
   event: "activityNewIntent", 
   callback: (args: AndroidActivityNewIntentEventData) => void, 
   thisArg?: any): void;

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

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

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

void

Overrides ​
ts
ApplicationCommon.on

Call Signature ​

ts
on(
   event: "activityRequestPermissions", 
   callback: (args: AndroidActivityRequestPermissionsEventData) => void, 
   thisArg?: any): void;

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

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

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

void

Overrides ​
ts
ApplicationCommon.on

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

registerBroadcastReceiver() ​

ts
registerBroadcastReceiver(intentFilter: string, onReceiveCallback: (context: Context, intent: Intent) => void): () => void;

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

Register a BroadcastReceiver to be run in the main activity thread. The receiver will be called with any broadcast Intent that matches filter, in the main application thread. For more information, please visit 'http://developer.android.com/reference/android/content/Context.html#registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)'

Parameters ​

ParameterTypeDescription
intentFilterstringA string containing the intent filter.
onReceiveCallback(context: Context, intent: Intent) => voidA callback function that will be called each time the receiver receives a broadcast.

Returns ​

A function that can be called to unregister the receiver.

() => void

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

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

unregisterBroadcastReceiver() ​

ts
unregisterBroadcastReceiver(intentFilter: string): void;

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

Unregister a previously registered BroadcastReceiver. For more information, please visit 'http://developer.android.com/reference/android/content/Context.html#unregisterReceiver(android.content.BroadcastReceiver)'

Parameters ​

ParameterTypeDescription
intentFilterstringA string containing the intent filter with which the receiver was originally registered.

Returns ​

void

Next
Animation