Classes
AndroidApplication
Defined in: application/application.d.ts:53
Extends
Properties
_windows
protected _windows: NativeWindow[];Defined in: application/application-common.ts
Inherited from
activityBackPressedEvent
readonly activityBackPressedEvent: "activityBackPressed" = 'activityBackPressed';Defined in: application/application.d.ts:74
activityCreatedEvent
readonly activityCreatedEvent: "activityCreated" = 'activityCreated';Defined in: application/application.d.ts:66
activityDestroyedEvent
readonly activityDestroyedEvent: "activityDestroyed" = 'activityDestroyed';Defined in: application/application.d.ts:67
activityNewIntentEvent
readonly activityNewIntentEvent: "activityNewIntent" = 'activityNewIntent';Defined in: application/application.d.ts:75
activityPausedEvent
readonly activityPausedEvent: "activityPaused" = 'activityPaused';Defined in: application/application.d.ts:69
activityRequestPermissionsEvent
readonly activityRequestPermissionsEvent: "activityRequestPermissions" = 'activityRequestPermissions';Defined in: application/application.d.ts:76
activityResultEvent
readonly activityResultEvent: "activityResult" = 'activityResult';Defined in: application/application.d.ts:73
activityResumedEvent
readonly activityResumedEvent: "activityResumed" = 'activityResumed';Defined in: application/application.d.ts:70
activityStartedEvent
readonly activityStartedEvent: "activityStarted" = 'activityStarted';Defined in: application/application.d.ts:68
activityStoppedEvent
readonly activityStoppedEvent: "activityStopped" = 'activityStopped';Defined in: application/application.d.ts:71
backgroundEvent
readonly backgroundEvent: "background" = "background";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.backgroundEvent
cssChangedEvent
readonly cssChangedEvent: "cssChanged" = "cssChanged";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.cssChangedEvent
discardedErrorEvent
readonly discardedErrorEvent: "discardedError" = "discardedError";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.discardedErrorEvent
displayedEvent
readonly displayedEvent: "displayed" = "displayed";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.displayedEvent
exitEvent
readonly exitEvent: "exit" = "exit";Defined in: application/application-common.ts
On Android, raised when the last window closes; the process may stay alive. On iOS, raised when the process itself terminates.
Inherited from
fontScaleChangedEvent
readonly fontScaleChangedEvent: "fontScaleChanged" = "fontScaleChanged";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.fontScaleChangedEvent
foregroundEvent
readonly foregroundEvent: "foreground" = "foreground";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.foregroundEvent
hasListeners
hasListeners: (eventName: string) => boolean;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
eventName | string |
Returns
boolean
Inherited from
ApplicationCommon.hasListeners
initRootViewEvent
readonly initRootViewEvent: "initRootView" = "initRootView";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.initRootViewEvent
launchEvent
readonly launchEvent: "launch" = "launch";Defined in: application/application-common.ts
Deprecated
Use the 'ready' event for application initialization and Application.setWindowContentResolver() to provide window UI. 'launch' continues to fire before the first window's content is created, and its 'root' property is still honored, for backwards compatibility. It never fires for additional windows. In a scene-based app it fires with the first window's content, so a background launch that connects no scene does not raise it.
Inherited from
layoutDirectionChangedEvent
readonly layoutDirectionChangedEvent: "layoutDirectionChanged" = "layoutDirectionChanged";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.layoutDirectionChangedEvent
livesyncEvent
readonly livesyncEvent: "livesync" = "livesync";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.livesyncEvent
loadAppCssEvent
readonly loadAppCssEvent: "loadAppCss" = "loadAppCss";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.loadAppCssEvent
lowMemoryEvent
readonly lowMemoryEvent: "lowMemory" = "lowMemory";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.lowMemoryEvent
mainEntry
protected mainEntry: NavigationEntry;Defined in: application/application-common.ts
Inherited from
notify
notify: <T>(eventData: T) => void;Defined in: application/application-common.ts
Type Parameters
| Type Parameter | Default type |
|---|---|
T | ApplicationEventData |
Parameters
| Parameter | Type |
|---|---|
eventData | T |
Returns
void
Inherited from
off
off: (eventNames: string, callback?: any, thisArg?: any) => void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
eventNames | string |
callback? | any |
thisArg? | any |
Returns
void
Inherited from
on
on: AndroidApplicationOn;Defined in: application/application.d.ts:78
Overrides
once
once: {
(eventNames: string, callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "cssChanged", callback: (args: CssChangedEventData) => void, thisArg?: any): void;
(event: "livesync", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "launch", callback: (args: LaunchEventData) => void, thisArg?: any): void;
(event: "ready", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "displayed", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "suspend", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "resume", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "exit", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "lowMemory", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "uncaughtError", callback: (args: UnhandledErrorEventData) => void, thisArg?: any): void;
(event: "discardedError", callback: (args: DiscardedErrorEventData) => void, thisArg?: any): void;
(event: "orientationChanged", callback: (args: OrientationChangedEventData) => void, thisArg?: any): void;
(event: "systemAppearanceChanged", callback: (args: SystemAppearanceChangedEventData) => void, thisArg?: any): void;
(event: "layoutDirectionChanged", callback: (args: LayoutDirectionChangedEventData) => void, thisArg?: any): void;
(event: "fontScaleChanged", callback: (args: FontScaleChangedEventData) => void, thisArg?: any): void;
(event: "windowOpen", callback: (args: WindowOpenEventData) => void, thisArg?: any): void;
(event: "windowClose", callback: (args: WindowCloseEventData) => void, thisArg?: any): void;
(event: "primaryWindowChanged", callback: (args: PrimaryWindowChangedEventData) => void, thisArg?: any): void;
(event: "sceneOpenURLContexts", callback: (args: SceneOpenURLContextsEventData) => void, thisArg?: any): void;
(event: "sceneContinueUserActivity", callback: (args: SceneContinueUserActivityEventData) => void, thisArg?: any): void;
(event: "scenePerformActionForShortcutItem", callback: (args: ScenePerformActionForShortcutItemEventData) => void, thisArg?: any): void;
};Defined in: application/application-common.ts
Call Signature
(
eventNames: string,
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
eventNames | string |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "cssChanged",
callback: (args: CssChangedEventData) => void,
thisArg?: any): void;This event is raised when application css is changed.
Parameters
| Parameter | Type |
|---|---|
event | "cssChanged" |
callback | (args: CssChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "livesync",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Event raised then livesync operation is performed.
Parameters
| Parameter | Type |
|---|---|
event | "livesync" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "launch",
callback: (args: LaunchEventData) => void,
thisArg?: any): void;This event is raised on application launchEvent.
Parameters
| Parameter | Type |
|---|---|
event | "launch" |
callback | (args: LaunchEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "ready",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised once the JS context is initialized.
Parameters
| Parameter | Type |
|---|---|
event | "ready" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "displayed",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Experimental
This event is raised after the application has performed most of its startup actions. Its intent is to be suitable for measuring app startup times.
Parameters
| Parameter | Type |
|---|---|
event | "displayed" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "suspend",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is suspended.
Parameters
| Parameter | Type |
|---|---|
event | "suspend" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "resume",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is resumed after it has been suspended.
Parameters
| Parameter | Type |
|---|---|
event | "resume" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "exit",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is about to exit.
On Android it is raised when the last window closes; the process may stay alive. On iOS it is raised when the process itself terminates.
Parameters
| Parameter | Type |
|---|---|
event | "exit" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "lowMemory",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when there is low memory on the target device.
Parameters
| Parameter | Type |
|---|---|
event | "lowMemory" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "uncaughtError",
callback: (args: UnhandledErrorEventData) => void,
thisArg?: any): void;This event is raised when an uncaught error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "uncaughtError" |
callback | (args: UnhandledErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "discardedError",
callback: (args: DiscardedErrorEventData) => void,
thisArg?: any): void;This event is raised when an discarded error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "discardedError" |
callback | (args: DiscardedErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "orientationChanged",
callback: (args: OrientationChangedEventData) => void,
thisArg?: any): void;This event is raised when the orientation of the application changes.
Parameters
| Parameter | Type |
|---|---|
event | "orientationChanged" |
callback | (args: OrientationChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "systemAppearanceChanged",
callback: (args: SystemAppearanceChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system appearance changes between light and dark theme (for Android); between light and dark mode (for iOS) and vice versa.
Parameters
| Parameter | Type |
|---|---|
event | "systemAppearanceChanged" |
callback | (args: SystemAppearanceChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "layoutDirectionChanged",
callback: (args: LayoutDirectionChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system layout direction changes between ltr and rtl.
Parameters
| Parameter | Type |
|---|---|
event | "layoutDirectionChanged" |
callback | (args: LayoutDirectionChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "fontScaleChanged",
callback: (args: FontScaleChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "fontScaleChanged" |
callback | (args: FontScaleChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowOpen",
callback: (args: WindowOpenEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowOpen" |
callback | (args: WindowOpenEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowClose",
callback: (args: WindowCloseEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowClose" |
callback | (args: WindowCloseEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "primaryWindowChanged",
callback: (args: PrimaryWindowChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "primaryWindowChanged" |
callback | (args: PrimaryWindowChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneOpenURLContexts",
callback: (args: SceneOpenURLContextsEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneOpenURLContexts" |
callback | (args: SceneOpenURLContextsEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneContinueUserActivity",
callback: (args: SceneContinueUserActivityEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneContinueUserActivity" |
callback | (args: SceneContinueUserActivityEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "scenePerformActionForShortcutItem",
callback: (args: ScenePerformActionForShortcutItemEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "scenePerformActionForShortcutItem" |
callback | (args: ScenePerformActionForShortcutItemEventData) => void |
thisArg? | any |
Returns
void
Inherited from
orientationChangedEvent
readonly orientationChangedEvent: "orientationChanged" = "orientationChanged";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.orientationChangedEvent
primaryWindowChangedEvent
readonly primaryWindowChangedEvent: "primaryWindowChanged";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.primaryWindowChangedEvent
readyEvent
readonly readyEvent: "ready" = "ready";Defined in: application/application-common.ts
Raised once per JS context, as soon as the context is initialized. It is never deferred, so it also fires on a background launch where no window is created.
Guaranteed ordering: ready -> windowOpen -> raw connect/create events -> content resolution (the legacy launch bridge runs here, for the first window only) -> contentLoaded -> activate/displayed.
Inherited from
resumeEvent
readonly resumeEvent: "resume" = "resume";Defined in: application/application-common.ts
Inherited from
saveActivityStateEvent
readonly saveActivityStateEvent: "saveActivityState" = 'saveActivityState';Defined in: application/application.d.ts:72
started
started: boolean;Defined in: application/application-common.ts
Inherited from
suspendEvent
readonly suspendEvent: "suspend" = "suspend";Defined in: application/application-common.ts
Reflects whole-app state: with multiple windows it is raised once the app itself is no longer in the foreground, not when an individual window backgrounds. Listen on a NativeWindow for per-window state.
Inherited from
ApplicationCommon.suspendEvent
systemAppearanceChangedEvent
readonly systemAppearanceChangedEvent: "systemAppearanceChanged" = "systemAppearanceChanged";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.systemAppearanceChangedEvent
uncaughtErrorEvent
readonly uncaughtErrorEvent: "uncaughtError" = "uncaughtError";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.uncaughtErrorEvent
windowCloseEvent
readonly windowCloseEvent: "windowClose";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.windowCloseEvent
windowOpenEvent
readonly windowOpenEvent: "windowOpen";Defined in: application/application-common.ts
Inherited from
ApplicationCommon.windowOpenEvent
activityBackPressedEvent
readonly static activityBackPressedEvent: "activityBackPressed" = 'activityBackPressed';Defined in: application/application.d.ts:62
activityCreatedEvent
readonly static activityCreatedEvent: "activityCreated" = 'activityCreated';Defined in: application/application.d.ts:54
activityDestroyedEvent
readonly static activityDestroyedEvent: "activityDestroyed" = 'activityDestroyed';Defined in: application/application.d.ts:55
activityNewIntentEvent
readonly static activityNewIntentEvent: "activityNewIntent" = 'activityNewIntent';Defined in: application/application.d.ts:63
activityPausedEvent
readonly static activityPausedEvent: "activityPaused" = 'activityPaused';Defined in: application/application.d.ts:57
activityRequestPermissionsEvent
readonly static activityRequestPermissionsEvent: "activityRequestPermissions" = 'activityRequestPermissions';Defined in: application/application.d.ts:64
activityResultEvent
readonly static activityResultEvent: "activityResult" = 'activityResult';Defined in: application/application.d.ts:61
activityResumedEvent
readonly static activityResumedEvent: "activityResumed" = 'activityResumed';Defined in: application/application.d.ts:58
activityStartedEvent
readonly static activityStartedEvent: "activityStarted" = 'activityStarted';Defined in: application/application.d.ts:56
activityStoppedEvent
readonly static activityStoppedEvent: "activityStopped" = 'activityStopped';Defined in: application/application.d.ts:59
hasListeners
static hasListeners: (eventName: string) => boolean;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
eventName | string |
Returns
boolean
Deprecated
Use Application.android.hasListeners() instead.
Inherited from
ApplicationCommon.hasListeners
notify
static notify: <T>(eventData: T) => void;Defined in: application/application-common.ts
Type Parameters
| Type Parameter | Default type |
|---|---|
T | ApplicationEventData |
Parameters
| Parameter | Type |
|---|---|
eventData | T |
Returns
void
Deprecated
Use Application.android.notify() instead.
Inherited from
off
static off: (eventNames: string, callback?: any, thisArg?: any) => void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
eventNames | string |
callback? | any |
thisArg? | any |
Returns
void
Deprecated
Use Application.android.off() instead.
Inherited from
on
static on: {
(eventNames: string, callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "cssChanged", callback: (args: CssChangedEventData) => void, thisArg?: any): void;
(event: "livesync", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "launch", callback: (args: LaunchEventData) => void, thisArg?: any): void;
(event: "ready", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "displayed", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "suspend", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "resume", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "exit", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "lowMemory", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "uncaughtError", callback: (args: UnhandledErrorEventData) => void, thisArg?: any): void;
(event: "discardedError", callback: (args: DiscardedErrorEventData) => void, thisArg?: any): void;
(event: "orientationChanged", callback: (args: OrientationChangedEventData) => void, thisArg?: any): void;
(event: "systemAppearanceChanged", callback: (args: SystemAppearanceChangedEventData) => void, thisArg?: any): void;
(event: "layoutDirectionChanged", callback: (args: LayoutDirectionChangedEventData) => void, thisArg?: any): void;
(event: "fontScaleChanged", callback: (args: FontScaleChangedEventData) => void, thisArg?: any): void;
(event: "windowOpen", callback: (args: WindowOpenEventData) => void, thisArg?: any): void;
(event: "windowClose", callback: (args: WindowCloseEventData) => void, thisArg?: any): void;
(event: "primaryWindowChanged", callback: (args: PrimaryWindowChangedEventData) => void, thisArg?: any): void;
(event: "sceneOpenURLContexts", callback: (args: SceneOpenURLContextsEventData) => void, thisArg?: any): void;
(event: "sceneContinueUserActivity", callback: (args: SceneContinueUserActivityEventData) => void, thisArg?: any): void;
(event: "scenePerformActionForShortcutItem", callback: (args: ScenePerformActionForShortcutItemEventData) => void, thisArg?: any): void;
};Defined in: application/application-common.ts
Call Signature
(
eventNames: string,
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
eventNames | string |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "cssChanged",
callback: (args: CssChangedEventData) => void,
thisArg?: any): void;This event is raised when application css is changed.
Parameters
| Parameter | Type |
|---|---|
event | "cssChanged" |
callback | (args: CssChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "livesync",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Event raised then livesync operation is performed.
Parameters
| Parameter | Type |
|---|---|
event | "livesync" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "launch",
callback: (args: LaunchEventData) => void,
thisArg?: any): void;This event is raised on application launchEvent.
Parameters
| Parameter | Type |
|---|---|
event | "launch" |
callback | (args: LaunchEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "ready",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised once the JS context is initialized.
Parameters
| Parameter | Type |
|---|---|
event | "ready" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "displayed",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Experimental
This event is raised after the application has performed most of its startup actions. Its intent is to be suitable for measuring app startup times.
Parameters
| Parameter | Type |
|---|---|
event | "displayed" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "suspend",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is suspended.
Parameters
| Parameter | Type |
|---|---|
event | "suspend" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "resume",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is resumed after it has been suspended.
Parameters
| Parameter | Type |
|---|---|
event | "resume" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "exit",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is about to exit.
On Android it is raised when the last window closes; the process may stay alive. On iOS it is raised when the process itself terminates.
Parameters
| Parameter | Type |
|---|---|
event | "exit" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "lowMemory",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when there is low memory on the target device.
Parameters
| Parameter | Type |
|---|---|
event | "lowMemory" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "uncaughtError",
callback: (args: UnhandledErrorEventData) => void,
thisArg?: any): void;This event is raised when an uncaught error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "uncaughtError" |
callback | (args: UnhandledErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "discardedError",
callback: (args: DiscardedErrorEventData) => void,
thisArg?: any): void;This event is raised when an discarded error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "discardedError" |
callback | (args: DiscardedErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "orientationChanged",
callback: (args: OrientationChangedEventData) => void,
thisArg?: any): void;This event is raised when the orientation of the application changes.
Parameters
| Parameter | Type |
|---|---|
event | "orientationChanged" |
callback | (args: OrientationChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "systemAppearanceChanged",
callback: (args: SystemAppearanceChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system appearance changes between light and dark theme (for Android); between light and dark mode (for iOS) and vice versa.
Parameters
| Parameter | Type |
|---|---|
event | "systemAppearanceChanged" |
callback | (args: SystemAppearanceChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "layoutDirectionChanged",
callback: (args: LayoutDirectionChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system layout direction changes between ltr and rtl.
Parameters
| Parameter | Type |
|---|---|
event | "layoutDirectionChanged" |
callback | (args: LayoutDirectionChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "fontScaleChanged",
callback: (args: FontScaleChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "fontScaleChanged" |
callback | (args: FontScaleChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowOpen",
callback: (args: WindowOpenEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowOpen" |
callback | (args: WindowOpenEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowClose",
callback: (args: WindowCloseEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowClose" |
callback | (args: WindowCloseEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "primaryWindowChanged",
callback: (args: PrimaryWindowChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "primaryWindowChanged" |
callback | (args: PrimaryWindowChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneOpenURLContexts",
callback: (args: SceneOpenURLContextsEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneOpenURLContexts" |
callback | (args: SceneOpenURLContextsEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneContinueUserActivity",
callback: (args: SceneContinueUserActivityEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneContinueUserActivity" |
callback | (args: SceneContinueUserActivityEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "scenePerformActionForShortcutItem",
callback: (args: ScenePerformActionForShortcutItemEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "scenePerformActionForShortcutItem" |
callback | (args: ScenePerformActionForShortcutItemEventData) => void |
thisArg? | any |
Returns
void
Deprecated
Use Application.android.on() instead.
Inherited from
once
static once: {
(eventNames: string, callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "cssChanged", callback: (args: CssChangedEventData) => void, thisArg?: any): void;
(event: "livesync", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "launch", callback: (args: LaunchEventData) => void, thisArg?: any): void;
(event: "ready", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "displayed", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "suspend", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "resume", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "exit", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "lowMemory", callback: (args: ApplicationEventData) => void, thisArg?: any): void;
(event: "uncaughtError", callback: (args: UnhandledErrorEventData) => void, thisArg?: any): void;
(event: "discardedError", callback: (args: DiscardedErrorEventData) => void, thisArg?: any): void;
(event: "orientationChanged", callback: (args: OrientationChangedEventData) => void, thisArg?: any): void;
(event: "systemAppearanceChanged", callback: (args: SystemAppearanceChangedEventData) => void, thisArg?: any): void;
(event: "layoutDirectionChanged", callback: (args: LayoutDirectionChangedEventData) => void, thisArg?: any): void;
(event: "fontScaleChanged", callback: (args: FontScaleChangedEventData) => void, thisArg?: any): void;
(event: "windowOpen", callback: (args: WindowOpenEventData) => void, thisArg?: any): void;
(event: "windowClose", callback: (args: WindowCloseEventData) => void, thisArg?: any): void;
(event: "primaryWindowChanged", callback: (args: PrimaryWindowChangedEventData) => void, thisArg?: any): void;
(event: "sceneOpenURLContexts", callback: (args: SceneOpenURLContextsEventData) => void, thisArg?: any): void;
(event: "sceneContinueUserActivity", callback: (args: SceneContinueUserActivityEventData) => void, thisArg?: any): void;
(event: "scenePerformActionForShortcutItem", callback: (args: ScenePerformActionForShortcutItemEventData) => void, thisArg?: any): void;
};Defined in: application/application-common.ts
Call Signature
(
eventNames: string,
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
eventNames | string |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "cssChanged",
callback: (args: CssChangedEventData) => void,
thisArg?: any): void;This event is raised when application css is changed.
Parameters
| Parameter | Type |
|---|---|
event | "cssChanged" |
callback | (args: CssChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "livesync",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Event raised then livesync operation is performed.
Parameters
| Parameter | Type |
|---|---|
event | "livesync" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "launch",
callback: (args: LaunchEventData) => void,
thisArg?: any): void;This event is raised on application launchEvent.
Parameters
| Parameter | Type |
|---|---|
event | "launch" |
callback | (args: LaunchEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "ready",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised once the JS context is initialized.
Parameters
| Parameter | Type |
|---|---|
event | "ready" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "displayed",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;Experimental
This event is raised after the application has performed most of its startup actions. Its intent is to be suitable for measuring app startup times.
Parameters
| Parameter | Type |
|---|---|
event | "displayed" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "suspend",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is suspended.
Parameters
| Parameter | Type |
|---|---|
event | "suspend" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "resume",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is resumed after it has been suspended.
Parameters
| Parameter | Type |
|---|---|
event | "resume" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "exit",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when the Application is about to exit.
On Android it is raised when the last window closes; the process may stay alive. On iOS it is raised when the process itself terminates.
Parameters
| Parameter | Type |
|---|---|
event | "exit" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "lowMemory",
callback: (args: ApplicationEventData) => void,
thisArg?: any): void;This event is raised when there is low memory on the target device.
Parameters
| Parameter | Type |
|---|---|
event | "lowMemory" |
callback | (args: ApplicationEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "uncaughtError",
callback: (args: UnhandledErrorEventData) => void,
thisArg?: any): void;This event is raised when an uncaught error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "uncaughtError" |
callback | (args: UnhandledErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "discardedError",
callback: (args: DiscardedErrorEventData) => void,
thisArg?: any): void;This event is raised when an discarded error occurs while the application is running.
Parameters
| Parameter | Type |
|---|---|
event | "discardedError" |
callback | (args: DiscardedErrorEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "orientationChanged",
callback: (args: OrientationChangedEventData) => void,
thisArg?: any): void;This event is raised when the orientation of the application changes.
Parameters
| Parameter | Type |
|---|---|
event | "orientationChanged" |
callback | (args: OrientationChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "systemAppearanceChanged",
callback: (args: SystemAppearanceChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system appearance changes between light and dark theme (for Android); between light and dark mode (for iOS) and vice versa.
Parameters
| Parameter | Type |
|---|---|
event | "systemAppearanceChanged" |
callback | (args: SystemAppearanceChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "layoutDirectionChanged",
callback: (args: LayoutDirectionChangedEventData) => void,
thisArg?: any): void;This event is raised when the operating system layout direction changes between ltr and rtl.
Parameters
| Parameter | Type |
|---|---|
event | "layoutDirectionChanged" |
callback | (args: LayoutDirectionChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "fontScaleChanged",
callback: (args: FontScaleChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "fontScaleChanged" |
callback | (args: FontScaleChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowOpen",
callback: (args: WindowOpenEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowOpen" |
callback | (args: WindowOpenEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "windowClose",
callback: (args: WindowCloseEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "windowClose" |
callback | (args: WindowCloseEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "primaryWindowChanged",
callback: (args: PrimaryWindowChangedEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "primaryWindowChanged" |
callback | (args: PrimaryWindowChangedEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneOpenURLContexts",
callback: (args: SceneOpenURLContextsEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneOpenURLContexts" |
callback | (args: SceneOpenURLContextsEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "sceneContinueUserActivity",
callback: (args: SceneContinueUserActivityEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "sceneContinueUserActivity" |
callback | (args: SceneContinueUserActivityEventData) => void |
thisArg? | any |
Returns
void
Call Signature
(
event: "scenePerformActionForShortcutItem",
callback: (args: ScenePerformActionForShortcutItemEventData) => void,
thisArg?: any): void;Parameters
| Parameter | Type |
|---|---|
event | "scenePerformActionForShortcutItem" |
callback | (args: ScenePerformActionForShortcutItemEventData) => void |
thisArg? | any |
Returns
void
Deprecated
Use Application.android.once() instead.
Inherited from
saveActivityStateEvent
readonly static saveActivityStateEvent: "saveActivityState" = 'saveActivityState';Defined in: application/application.d.ts:60
Accessors
activeWindow
Get Signature
get activeWindow(): NativeWindow;Defined in: application/application-common.ts
Get the NativeWindow the user is currently interacting with - the one that activated most recently and is still attached. Falls back to the primary window while no window holds activation, which is the case before the first window activates and on a platform that never raises activate.
Returns
Inherited from
ApplicationCommon.activeWindow
android
Get Signature
get android(): AndroidApplication;Defined in: application/application-common.ts
Returns
AndroidApplication
Inherited from
AndroidApplication
Get Signature
get AndroidApplication(): AndroidApplication;Defined in: application/application-common.ts
Returns
AndroidApplication
Inherited from
ApplicationCommon.AndroidApplication
autoSystemAppearanceChanged
Get Signature
get autoSystemAppearanceChanged(): boolean;Defined in: application/application-common.ts
Boolean to enable/disable systemAppearanceChanged
Returns
boolean
Set Signature
set autoSystemAppearanceChanged(value: boolean): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
ApplicationCommon.autoSystemAppearanceChanged
backgrounded
Get Signature
get backgrounded(): boolean;Defined in: application/application.d.ts:117
Deprecated
Use Application.inBackground instead.
Returns
boolean
context
Get Signature
get context(): Context;Defined in: application/application.d.ts:112
Deprecated
Use Utils.android.getApplicationContext() instead.
Returns
Context
foregroundActivity
Get Signature
get foregroundActivity(): AppCompatActivity;Defined in: application/application.d.ts:107
The currently active (loaded) android Activity.
This property is automatically updated upon Activity events.
Returns
AppCompatActivity
inBackground
Get Signature
get inBackground(): boolean;Defined in: application/application-common.ts
Returns
boolean
Inherited from
ApplicationCommon.inBackground
ios
Get Signature
get ios(): iOSApplication;Defined in: application/application-common.ts
Returns
Inherited from
iOSApplication
Get Signature
get iOSApplication(): iOSApplication;Defined in: application/application-common.ts
Returns
Inherited from
ApplicationCommon.iOSApplication
nativeApp
Get Signature
get nativeApp(): Application;Defined in: application/application.d.ts:90
The android Application object instance provided to the init of the module.
Returns
Application
packageName
Get Signature
get packageName(): string;Defined in: application/application.d.ts:95
Deprecated
Use Utils.android.getPackageName() instead.
Returns
string
paused
Get Signature
get paused(): boolean;Defined in: application/application.d.ts:122
Deprecated
Use Application.suspended instead.
Returns
boolean
primaryWindow
Get Signature
get primaryWindow(): NativeWindow;Defined in: application/application-common.ts
Get the primary NativeWindow.
Returns
Inherited from
ApplicationCommon.primaryWindow
startActivity
Get Signature
get startActivity(): AppCompatActivity;Defined in: application/application.d.ts:100
The main (start) Activity for the application.
Returns
AppCompatActivity
suspended
Get Signature
get suspended(): boolean;Defined in: application/application-common.ts
Returns
boolean
Inherited from
Methods
_onPrimaryWindowPromoted()
protected _onPrimaryWindowPromoted(nativeWindow: NativeWindow): void;Defined in: application/application-common.ts
Hook for platform-specific bookkeeping right after a window takes over the primary role, before primaryWindowChanged is raised.
Parameters
| Parameter | Type |
|---|---|
nativeWindow | NativeWindow |
Returns
void
Inherited from
ApplicationCommon._onPrimaryWindowPromoted
_onWindowRegistered()
protected _onWindowRegistered(nativeWindow: NativeWindow): void;Defined in: application/application-common.ts
Hook for platform-specific bookkeeping right after a window joins the registry, before windowOpen is raised.
Parameters
| Parameter | Type |
|---|---|
nativeWindow | NativeWindow |
Returns
void
Inherited from
ApplicationCommon._onWindowRegistered
addCss()
addCss(cssText: string, attributeScoped?: boolean): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
cssText | string |
attributeScoped? | boolean |
Returns
void
Inherited from
applyCssClass()
applyCssClass(
rootView: View,
cssClasses: string[],
newCssClass: string,
skipCssUpdate?: boolean): void;Defined in: application/application-common.ts
Applies the the newCssClass to the rootView and removes all other css classes from cssClasses previously applied to the rootView.
Parameters
| Parameter | Type | Description |
|---|---|---|
rootView | View | - |
cssClasses | string[] | - |
newCssClass | string | - |
skipCssUpdate? | boolean | - |
Returns
void
Inherited from
ApplicationCommon.applyCssClass
createRootView()
createRootView(
view?: View,
fireLaunchEvent?: boolean,
additionalLanchEventData?: any): View;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
view? | View |
fireLaunchEvent? | boolean |
additionalLanchEventData? | any |
Returns
Inherited from
ApplicationCommon.createRootView
getCssFileName()
getCssFileName(): string;Defined in: application/application-common.ts
Gets css file name for the application.
Returns
string
Inherited from
ApplicationCommon.getCssFileName
getLayoutDirection()
protected getLayoutDirection(): LayoutDirectionType;Defined in: application/application-common.ts
Returns
Inherited from
ApplicationCommon.getLayoutDirection
getMainEntry()
getMainEntry(): any;Defined in: application/application-common.ts
Returns
any
The main entry of the application
Inherited from
ApplicationCommon.getMainEntry
getNativeApplication()
getNativeApplication(): Application;Defined in: application/application.d.ts:80
Returns
Application
Overrides
ApplicationCommon.getNativeApplication
getOrientation()
protected getOrientation(): "portrait" | "landscape" | "unknown";Defined in: application/application-common.ts
Returns
"portrait" | "landscape" | "unknown"
Inherited from
ApplicationCommon.getOrientation
getRegisteredBroadcastReceiver()
getRegisteredBroadcastReceiver(intentFilter: string): any;Defined in: application/application.d.ts:146
Get a registered BroadcastReceiver, then you can get the result code of BroadcastReceiver in onReceiveCallback method.
Parameters
| Parameter | Type | Description |
|---|---|---|
intentFilter | string | A string containing the intent filter. |
Returns
any
Deprecated
Use getRegisteredBroadcastReceivers instead.
getRegisteredBroadcastReceivers()
getRegisteredBroadcastReceivers(intentFilter: string): BroadcastReceiver[];Defined in: application/application.d.ts:151
Get all registered BroadcastReceivers for a specific intent filter.
Parameters
| Parameter | Type | Description |
|---|---|---|
intentFilter | string | a string containing the intent filter |
Returns
BroadcastReceiver[]
getResources()
getResources(): any;Defined in: application/application-common.ts
Get application level static resources.
Returns
any
Inherited from
ApplicationCommon.getResources
getRootView()
getRootView(): View;Defined in: application/application-common.ts
Returns
Inherited from
getSystemAppearance()
protected getSystemAppearance(): "dark" | "light";Defined in: application/application-common.ts
Returns
"dark" | "light"
Inherited from
ApplicationCommon.getSystemAppearance
getWindowById()
getWindowById(id: string): NativeWindow;Defined in: application/application-common.ts
Get a registered NativeWindow by its id.
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Inherited from
ApplicationCommon.getWindowById
getWindowContentResolver()
getWindowContentResolver(): WindowContentResolver;Defined in: application/application-common.ts
Returns
The callback currently supplying window content, if any.
Inherited from
ApplicationCommon.getWindowContentResolver
getWindows()
Call Signature
getWindows(role: "all"): WindowBase[];Defined in: application/application-common.ts
Get the active windows, filtered by role.
Defaults to the view-carrying app windows (application and embedded). Pass 'all' to include every registered surface, including ones that carry no view tree.
Parameters
| Parameter | Type |
|---|---|
role | "all" |
Returns
Inherited from
Call Signature
getWindows(role?:
| WindowRole
| WindowRole[]): NativeWindow[];Defined in: application/application-common.ts
Get the active windows, filtered by role.
Defaults to the view-carrying app windows (application and embedded). Pass 'all' to include every registered surface, including ones that carry no view tree.
Parameters
| Parameter | Type |
|---|---|
role? | | WindowRole | WindowRole[] |
Returns
Inherited from
Call Signature
getWindows(role?:
| "all"
| WindowRole
| WindowRole[]): WindowBase[];Defined in: application/application-common.ts
Get the active windows, filtered by role.
Defaults to the view-carrying app windows (application and embedded). Pass 'all' to include every registered surface, including ones that carry no view tree.
Parameters
| Parameter | Type |
|---|---|
role? | | "all" | WindowRole | WindowRole[] |
Returns
Inherited from
hasLaunched()
hasLaunched(): boolean;Defined in: application/application-common.ts
Returns
boolean
Inherited from
initRootView()
initRootView(rootView: View, window?: NativeWindow): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type | Description |
|---|---|---|
rootView | View | - |
window? | NativeWindow | the window the root view belongs to. Supplies the window-scoped CSS classes; without it they come from the primary window. |
Returns
void
Inherited from
ApplicationCommon.initRootView
layoutDirection()
layoutDirection(): LayoutDirectionType;Defined in: application/application-common.ts
Returns
Deprecated
Use Application.primaryWindow?.layoutDirection() - or the NativeWindow of the relevant view - instead. Continues to reflect the primary window.
Inherited from
ApplicationCommon.layoutDirection
layoutDirectionChanged()
layoutDirectionChanged(rootView: View, newLayoutDirection: LayoutDirectionType): void;Defined in: application/application-common.ts
Updates root view classes including those of modals
Parameters
| Parameter | Type | Description |
|---|---|---|
rootView | View | the root view |
newLayoutDirection | LayoutDirectionType | the new layout direction change |
Returns
void
Inherited from
ApplicationCommon.layoutDirectionChanged
loadAppCss()
loadAppCss(): void;Defined in: application/application-common.ts
Loads immediately the app.css. By default the app.css file is loaded shortly after "loaded". For the Android snapshot the CSS can be parsed during the snapshot generation, as the CSS does not depend on runtime APIs, and loadAppCss will be called explicitly.
Returns
void
Inherited from
notifyLaunch()
protected notifyLaunch(additionalLanchEventData?: any): View;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
additionalLanchEventData? | any |
Returns
Inherited from
ApplicationCommon.notifyLaunch
openWindow()
openWindow(options?: WindowOpenOptions): void;Defined in: application/application.d.ts:172
Experimental
Opens a new window by launching the start activity into its own task.
Parameters
| Parameter | Type | Description |
|---|---|---|
options? | WindowOpenOptions | Options for the new window. options.data is put on the launch intent as extras and surfaces as the window's data. The start activity's launchMode in AndroidManifest.xml decides whether a second instance can exist at all: singleTask (the app template default) and singleInstance route the intent to the existing activity's onNewIntent instead of creating one. Use singleInstancePerTask (API 31+) to keep single-task behavior for launcher and deep-link starts while allowing additional windows, or standard. When the app is already in split-screen, the new window opens in the adjacent pane; otherwise it covers the current one and both show in recents. |
Returns
void
Overrides
orientation()
orientation(): "portrait" | "landscape" | "unknown";Defined in: application/application-common.ts
Returns
"portrait" | "landscape" | "unknown"
Deprecated
Use Application.primaryWindow?.orientation() - or the NativeWindow of the relevant view - instead. Continues to reflect the primary window.
Inherited from
orientationChanged()
orientationChanged(rootView: View, newOrientation: "portrait" | "landscape" | "unknown"): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
rootView | View |
newOrientation | "portrait" | "landscape" | "unknown" |
Returns
void
Inherited from
ApplicationCommon.orientationChanged
registerBroadcastReceiver()
registerBroadcastReceiver(
intentFilter: string,
onReceiveCallback: (context: Context, intent: Intent) => void,
flags?: number): () => void;Defined in: application/application.d.ts:132
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
| Parameter | Type | Description |
|---|---|---|
intentFilter | string | A string containing the intent filter. |
onReceiveCallback | (context: Context, intent: Intent) => void | A callback function that will be called each time the receiver receives a broadcast. |
flags? | number | Any combination of RECEIVER_VISIBLE_TO_INSTANT_APPS (1), RECEIVER_EXPORTED (2) and RECEIVER_NOT_EXPORTED (4). Defaults to RECEIVER_EXPORTED. Only honored from API 26 onwards. |
Returns
A function that can be called to unregister the receiver.
() => void
resetRootView()
resetRootView(entry?: string | NavigationEntry): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
entry? | string | NavigationEntry |
Returns
void
Inherited from
ApplicationCommon.resetRootView
run()
run(entry?: string | NavigationEntry): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
entry? | string | NavigationEntry |
Returns
void
Inherited from
setAutoSystemAppearanceChanged()
setAutoSystemAppearanceChanged(value: boolean): void;Defined in: application/application-common.ts
enable/disable systemAppearanceChanged
Parameters
| Parameter | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
ApplicationCommon.setAutoSystemAppearanceChanged
setCssFileName()
setCssFileName(cssFileName: string): void;Defined in: application/application-common.ts
Sets css file name for the application.
Parameters
| Parameter | Type |
|---|---|
cssFileName | string |
Returns
void
Inherited from
ApplicationCommon.setCssFileName
setInBackground()
setInBackground(value: boolean, additonalData?: any): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
value | boolean |
additonalData? | any |
Returns
void
Inherited from
ApplicationCommon.setInBackground
setLayoutDirection()
protected setLayoutDirection(value: LayoutDirectionType): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
value | LayoutDirectionType |
Returns
void
Inherited from
ApplicationCommon.setLayoutDirection
setMaxRefreshRate()
setMaxRefreshRate(options?: {
max?: number;
min?: number;
preferred?: number;
}): void;Defined in: application/application-common.ts
iOS Only Dynamically change the preferred frame rate For devices (iOS 15+) which support min/max/preferred frame rate you can specify ranges For devices (iOS < 15), you can specify the max frame rate see: https://developer.apple.com/documentation/quartzcore/optimizing_promotion_refresh_rates_for_iphone_13_pro_and_ipad_pro To use, ensure your Info.plist has:
<key>CADisableMinimumFrameDurationOnPhone</key>
<true/>Parameters
| Parameter | Type | Description |
|---|---|---|
options? | { max?: number; min?: number; preferred?: number; } | { min?: number; max?: number; preferred?: number } |
options.max? | number | - |
options.min? | number | - |
options.preferred? | number | - |
Returns
void
Inherited from
ApplicationCommon.setMaxRefreshRate
setOrientation()
protected setOrientation(value: "portrait" | "landscape" | "unknown"): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
value | "portrait" | "landscape" | "unknown" |
Returns
void
Inherited from
ApplicationCommon.setOrientation
setResources()
setResources(res: any): void;Defined in: application/application-common.ts
Set application level static resources.
Parameters
| Parameter | Type |
|---|---|
res | any |
Returns
void
Inherited from
ApplicationCommon.setResources
setSuspended()
setSuspended(value: boolean, additonalData?: any): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
value | boolean |
additonalData? | any |
Returns
void
Inherited from
ApplicationCommon.setSuspended
setSystemAppearance()
protected setSystemAppearance(value: "dark" | "light"): void;Defined in: application/application-common.ts
Parameters
| Parameter | Type |
|---|---|
value | "dark" | "light" |
Returns
void
Inherited from
ApplicationCommon.setSystemAppearance
setWindowContentResolver()
setWindowContentResolver(resolver: WindowContentResolver): void;Defined in: application/application-common.ts
Sets the callback that supplies the UI for windows that need content. Pass null to remove a previously set resolver.
Parameters
| Parameter | Type |
|---|---|
resolver | WindowContentResolver |
Returns
void
Inherited from
ApplicationCommon.setWindowContentResolver
systemAppearance()
systemAppearance(): "dark" | "light";Defined in: application/application-common.ts
Returns
"dark" | "light"
Deprecated
Use Application.primaryWindow?.systemAppearance() - or the NativeWindow of the relevant view - instead. Continues to reflect the primary window.
Inherited from
ApplicationCommon.systemAppearance
systemAppearanceChanged()
systemAppearanceChanged(rootView: View, newSystemAppearance: "dark" | "light"): void;Defined in: application/application-common.ts
Updates root view classes including those of modals
Parameters
| Parameter | Type | Description |
|---|---|---|
rootView | View | the root view |
newSystemAppearance | "dark" | "light" | the new appearance change |
Returns
void
Inherited from
ApplicationCommon.systemAppearanceChanged
unregisterBroadcastReceiver()
unregisterBroadcastReceiver(intentFilter: string): void;Defined in: application/application.d.ts:139
Unregister a previously registered BroadcastReceiver. For more information, please visit 'http://developer.android.com/reference/android/content/Context.html#unregisterReceiver(android.content.BroadcastReceiver)'
Parameters
| Parameter | Type | Description |
|---|---|---|
intentFilter | string | A string containing the intent filter with which the receiver was originally registered. |
Returns
void
- Previous
- ActivityIndicator
- Next
- Animation