NativeWindow

Defined in: native-window/index.d.ts:266

A window surface that hosts a NativeScript view tree.

Wraps a platform window (iOS UIWindowScene + UIWindow, Android Activity) and owns the per-window root view, its CSS classes and its lifecycle events. Instances are created by the framework as the platform connects surfaces; reach them through Application.activeWindow, Application.primaryWindow, Application.getWindows() or Application.getWindowById(), and use ios / android to get at the native objects.

Extends ​

• WindowBase

Constructors ​

Constructor ​

new NativeWindow(): NativeWindow;

Returns ​

NativeWindow

Inherited from ​

WindowBase.constructor

Properties ​

android? ​

readonly optional android?: {
  activity: AppCompatActivity;
};

Defined in: native-window/index.d.ts:71

The Android surface backing this window, or undefined when not running on Android or when the activity is already gone.

activity ​

readonly activity: AppCompatActivity;

Inherited from ​

WindowBase.android

id ​

readonly id: string;

Defined in: native-window/index.d.ts:41

Stable identifier of this window, unique for the lifetime of the JS context. Survives a detach/re-attach, so it can be used to correlate a window across an iOS scene reconnect or an Android activity recreation.

Inherited from ​

WindowBase.id

ios? ​

readonly optional ios?: {
  scene?: UIWindowScene;
  uiWindow: UIWindow;
};

Defined in: native-window/index.d.ts:65

The iOS surface backing this window, or undefined when not running on iOS. scene is absent for apps still on the pre-scene (window-only) lifecycle.

scene? ​

readonly optional scene?: UIWindowScene;

uiWindow ​

readonly uiWindow: UIWindow;

Inherited from ​

WindowBase.ios

isPrimary ​

readonly isPrimary: boolean;

Defined in: native-window/index.d.ts:59

Whether this is the application's primary window.

At most one window is primary at a time. When the primary window closes another attached window is promoted and primaryWindowChanged is raised on the Application.

Inherited from ​

WindowBase.isPrimary

role ​

readonly role: WindowRole;

Defined in: native-window/index.d.ts:46

The purpose this window surface serves.

Inherited from ​

WindowBase.role

rootView ​

readonly rootView: View;

Defined in: native-window/index.d.ts:270

The root view currently hosted by this window, if any.

state ​

readonly state: WindowState;

Defined in: native-window/index.d.ts:51

Where this window currently sits in its lifecycle.

Inherited from ​

WindowBase.state

propertyChangeEvent ​

static propertyChangeEvent: string;

Defined in: data/observable/index.ts

String value used when hooking to propertyChange event.

Ns Event ​

propertyChange

Inherited from ​

WindowBase.propertyChangeEvent

Methods ​

_createPropertyChangeData() ​

_createPropertyChangeData(
   propertyName: string, 
   value: any, 
   oldValue?: any): PropertyChangeData;

Defined in: data/observable/index.ts

This method is intended to be overriden by inheritors to provide additional implementation.

Parameters ​

Returns ​

PropertyChangeData

Inherited from ​

WindowBase._createPropertyChangeData

_emit() ​

_emit(eventName: string): void;

Defined in: data/observable/index.ts

Parameters ​

Returns ​

void

Inherited from ​

WindowBase._emit

addEventListener() ​

addEventListener(
   eventName: string, 
   callback: (data: EventData) => void, 
   thisArg?: any, 
   once?: boolean): void;

Defined in: data/observable/index.ts

Adds a listener for the specified event name.

Parameters ​

Returns ​

void

Inherited from ​

WindowBase.addEventListener

close() ​

abstract close(): void;

Defined in: native-window/index.d.ts:79

Closes this window.

Ends the window session: the native surface is dismissed, close is raised and the window is dropped from the Application registry.

Returns ​

void

Inherited from ​

WindowBase.close

get() ​

get(name: string): any;

Defined in: data/observable/index.ts

Gets the value of the specified property.

Parameters ​

Returns ​

any

Inherited from ​

WindowBase.get

hasListeners() ​

hasListeners(eventName: string): boolean;

Defined in: data/observable/index.ts

Checks whether a listener is registered for the specified event name.

Parameters ​

Returns ​

boolean

Inherited from ​

WindowBase.hasListeners

layoutDirection() ​

layoutDirection(): LayoutDirectionType;

Defined in: native-window/index.d.ts:310

The current layout direction of this window.

Read from the native surface while the window is attached; a detached window reports the last value it saw. A read that catches a change the platform has not reported yet also raises layoutDirectionChanged, so a change is never swallowed by the reading.

Returns ​

LayoutDirectionType

notify() ​

notify<T>(data: T): void;

Defined in: data/observable/index.ts

Notify this Observable instance with some data. This causes all event handlers on the Observable instance to be called, as well as any 'global' event handlers set on the instance's class.

Type Parameters ​

Parameters ​

Returns ​

void

Inherited from ​

WindowBase.notify

notifyPropertyChange() ​

notifyPropertyChange(
   name: string, 
   value: any, 
   oldValue?: any): void;

Defined in: data/observable/index.ts

Notifies all the registered listeners for the property change event.

Parameters ​

Returns ​

void

Inherited from ​

WindowBase.notifyPropertyChange

off() ​

Call Signature ​

off(
   event: "contentLoaded", 
   callback?: (data: NativeWindowEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:393

Removes the listener(s) for the specified event name.

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "activate", 
   callback?: (data: NativeWindowEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:394

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "deactivate", 
   callback?: (data: NativeWindowEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:395

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "background", 
   callback?: (data: NativeWindowEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:396

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "foreground", 
   callback?: (data: NativeWindowEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:397

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "attached", 
   callback?: (data: NativeWindowEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:398

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "detached", 
   callback?: (data: NativeWindowEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:399

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "close", 
   callback?: (data: NativeWindowEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:400

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "displayed", 
   callback?: (data: NativeWindowEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:401

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "orientationChanged", 
   callback?: (data: WindowOrientationChangedEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:402

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "systemAppearanceChanged", 
   callback?: (data: WindowSystemAppearanceChangedEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:403

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "layoutDirectionChanged", 
   callback?: (data: WindowLayoutDirectionChangedEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:404

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

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

Defined in: native-window/index.d.ts:405

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

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

Defined in: native-window/index.d.ts:406

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

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

Defined in: native-window/index.d.ts:407

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

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

Defined in: native-window/index.d.ts:408

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

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

Defined in: native-window/index.d.ts:409

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

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

Defined in: native-window/index.d.ts:410

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

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

Defined in: native-window/index.d.ts:411

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

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

Defined in: native-window/index.d.ts:412

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

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

Defined in: native-window/index.d.ts:413

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

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

Defined in: native-window/index.d.ts:414

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

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

Defined in: native-window/index.d.ts:415

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "sceneWillConnect", 
   callback?: (args: SceneEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:416

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "sceneDidActivate", 
   callback?: (args: SceneEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:417

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "sceneWillResignActive", 
   callback?: (args: SceneEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:418

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "sceneWillEnterForeground", 
   callback?: (args: SceneEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:419

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "sceneDidEnterBackground", 
   callback?: (args: SceneEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:420

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "sceneDidDisconnect", 
   callback?: (args: SceneEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:421

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "sceneOpenURLContexts", 
   callback?: (args: SceneOpenURLContextsEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:422

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "sceneContinueUserActivity", 
   callback?: (args: SceneContinueUserActivityEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:423

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   event: "scenePerformActionForShortcutItem", 
   callback?: (args: ScenePerformActionForShortcutItemEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:424

Removes a listener for the specified event name. Omitting the callback removes every listener registered for that event on this window.

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

Call Signature ​

off(
   eventName: string, 
   callback?: (data: NativeWindowEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:425

Parameters ​

Returns ​

void

Overrides ​

WindowBase.off

on() ​

Call Signature ​

on(
   event: "contentLoaded", 
   callback: (data: NativeWindowEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:321

Raised when the root view content of this window is set or changed.

Bringing a window up follows a fixed order that app code can rely on: Application ready -> Application windowOpen -> the raw platform connect/create event (sceneWillConnect / activityCreated) -> content resolution (the window content resolver, or the legacy launch bridge for the first window) -> contentLoaded -> activate and displayed.

Parameters ​

Returns ​

void

Overrides ​

WindowBase.on

Call Signature ​

on(
   event: "activate", 
   callback: (data: NativeWindowEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:326

Raised when the window loses focus.

Parameters ​

Returns ​

void

Overrides ​

WindowBase.on

Call Signature ​

on(
   event: "deactivate", 
   callback: (data: NativeWindowEventData) => void, 
   thisArg?: any): void;

Defined in: native-window/index.d.ts:327

Raised when the window enters the background.

Parameters ​