Classes
WindowBase
Cross-platform base for any window surface. Carries identity, role, state, lifecycle events and the native accessors. Surfaces that host a NativeScript view ...
Defined in: native-window/index.d.ts:35
Cross-platform base for any window surface.
Carries identity, role, state, lifecycle events and the native accessors. Surfaces that host a NativeScript view tree are NativeWindow instances.
Extends
Extended by
Constructors
Constructor
new WindowBase(): WindowBase;Returns
WindowBase
Inherited from
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;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.
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;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.
role
readonly role: WindowRole;Defined in: native-window/index.d.ts:46
The purpose this window surface serves.
state
readonly state: WindowState;Defined in: native-window/index.d.ts:51
Where this window currently sits in its lifecycle.
propertyChangeEvent
static propertyChangeEvent: string;Defined in: data/observable/index.ts
String value used when hooking to propertyChange event.
Ns Event
propertyChange
Inherited from
Observable.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
| Parameter | Type |
|---|---|
propertyName | string |
value | any |
oldValue? | any |
Returns
Inherited from
Observable._createPropertyChangeData
_emit()
_emit(eventName: string): void;Defined in: data/observable/index.ts
Parameters
| Parameter | Type |
|---|---|
eventName | string |
Returns
void
Inherited from
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
| Parameter | Type | Description |
|---|---|---|
eventName | string | Name of the event to attach to. |
callback | (data: EventData) => void | A function to be called when some of the specified event(s) is raised. |
thisArg? | any | An optional parameter which when set will be used as "this" in callback method call. |
once? | boolean | An optional parameter which when set will cause the event listener to fire once. |
Returns
void
Inherited from
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
get()
get(name: string): any;Defined in: data/observable/index.ts
Gets the value of the specified property.
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
any
Inherited from
hasListeners()
hasListeners(eventName: string): boolean;Defined in: data/observable/index.ts
Checks whether a listener is registered for the specified event name.
Parameters
| Parameter | Type | Description |
|---|---|---|
eventName | string | The name of the event to check for. |
Returns
boolean
Inherited from
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
| Type Parameter |
|---|
T extends Optional<EventData, "object"> |
Parameters
| Parameter | Type | Description |
|---|---|---|
data | T | an object that satisfies the EventData interface, though with an optional 'object' property. If left undefined, the 'object' property will implicitly be set as this Observable instance. |
Returns
void
Inherited from
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
| Parameter | Type |
|---|---|
name | string |
value | any |
oldValue? | any |
Returns
void
Inherited from
Observable.notifyPropertyChange
off()
Call Signature
off(
event: "activate",
callback?: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:218
Removes the listener(s) for the specified event name.
Parameters
| Parameter | Type | Description |
|---|---|---|
event | "activate" | - |
callback? | (data: WindowBaseEventData) => void | An optional specific event listener to remove (if omitted, all event listeners by this name will be removed). |
thisArg? | any | An optional parameter which, when set, will be used to refine search of the correct event listener to be removed. |
Returns
void
Overrides
Call Signature
off(
event: "deactivate",
callback?: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:219
Parameters
| Parameter | Type |
|---|---|
event | "deactivate" |
callback? | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "background",
callback?: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:220
Parameters
| Parameter | Type |
|---|---|
event | "background" |
callback? | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "foreground",
callback?: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:221
Parameters
| Parameter | Type |
|---|---|
event | "foreground" |
callback? | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "attached",
callback?: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:222
Parameters
| Parameter | Type |
|---|---|
event | "attached" |
callback? | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "detached",
callback?: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:223
Parameters
| Parameter | Type |
|---|---|
event | "detached" |
callback? | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "close",
callback?: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:224
Parameters
| Parameter | Type |
|---|---|
event | "close" |
callback? | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "displayed",
callback?: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:225
Parameters
| Parameter | Type |
|---|---|
event | "displayed" |
callback? | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "orientationChanged",
callback?: (data: WindowOrientationChangedEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:226
Parameters
| Parameter | Type |
|---|---|
event | "orientationChanged" |
callback? | (data: WindowOrientationChangedEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "systemAppearanceChanged",
callback?: (data: WindowSystemAppearanceChangedEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:227
Parameters
| Parameter | Type |
|---|---|
event | "systemAppearanceChanged" |
callback? | (data: WindowSystemAppearanceChangedEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "layoutDirectionChanged",
callback?: (data: WindowLayoutDirectionChangedEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:228
Parameters
| Parameter | Type |
|---|---|
event | "layoutDirectionChanged" |
callback? | (data: WindowLayoutDirectionChangedEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "activityCreated",
callback?: (args: AndroidActivityBundleEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:229
Parameters
| Parameter | Type |
|---|---|
event | "activityCreated" |
callback? | (args: AndroidActivityBundleEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "activityDestroyed",
callback?: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:230
Parameters
| Parameter | Type |
|---|---|
event | "activityDestroyed" |
callback? | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "activityStarted",
callback?: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:231
Parameters
| Parameter | Type |
|---|---|
event | "activityStarted" |
callback? | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "activityPaused",
callback?: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:232
Parameters
| Parameter | Type |
|---|---|
event | "activityPaused" |
callback? | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "activityResumed",
callback?: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:233
Parameters
| Parameter | Type |
|---|---|
event | "activityResumed" |
callback? | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "activityStopped",
callback?: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:234
Parameters
| Parameter | Type |
|---|---|
event | "activityStopped" |
callback? | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "saveActivityState",
callback?: (args: AndroidActivityBundleEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:235
Parameters
| Parameter | Type |
|---|---|
event | "saveActivityState" |
callback? | (args: AndroidActivityBundleEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "activityResult",
callback?: (args: AndroidActivityResultEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:236
Parameters
| Parameter | Type |
|---|---|
event | "activityResult" |
callback? | (args: AndroidActivityResultEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "activityBackPressed",
callback?: (args: AndroidActivityBackPressedEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:237
Parameters
| Parameter | Type |
|---|---|
event | "activityBackPressed" |
callback? | (args: AndroidActivityBackPressedEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "activityNewIntent",
callback?: (args: AndroidActivityNewIntentEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:238
Parameters
| Parameter | Type |
|---|---|
event | "activityNewIntent" |
callback? | (args: AndroidActivityNewIntentEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "activityRequestPermissions",
callback?: (args: AndroidActivityRequestPermissionsEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:239
Parameters
| Parameter | Type |
|---|---|
event | "activityRequestPermissions" |
callback? | (args: AndroidActivityRequestPermissionsEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "sceneWillConnect",
callback?: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:240
Parameters
| Parameter | Type |
|---|---|
event | "sceneWillConnect" |
callback? | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "sceneDidActivate",
callback?: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:241
Parameters
| Parameter | Type |
|---|---|
event | "sceneDidActivate" |
callback? | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "sceneWillResignActive",
callback?: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:242
Parameters
| Parameter | Type |
|---|---|
event | "sceneWillResignActive" |
callback? | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "sceneWillEnterForeground",
callback?: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:243
Parameters
| Parameter | Type |
|---|---|
event | "sceneWillEnterForeground" |
callback? | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "sceneDidEnterBackground",
callback?: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:244
Parameters
| Parameter | Type |
|---|---|
event | "sceneDidEnterBackground" |
callback? | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "sceneDidDisconnect",
callback?: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:245
Parameters
| Parameter | Type |
|---|---|
event | "sceneDidDisconnect" |
callback? | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "sceneOpenURLContexts",
callback?: (args: SceneOpenURLContextsEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:246
Parameters
| Parameter | Type |
|---|---|
event | "sceneOpenURLContexts" |
callback? | (args: SceneOpenURLContextsEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "sceneContinueUserActivity",
callback?: (args: SceneContinueUserActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:247
Parameters
| Parameter | Type |
|---|---|
event | "sceneContinueUserActivity" |
callback? | (args: SceneContinueUserActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
event: "scenePerformActionForShortcutItem",
callback?: (args: ScenePerformActionForShortcutItemEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:248
Parameters
| Parameter | Type |
|---|---|
event | "scenePerformActionForShortcutItem" |
callback? | (args: ScenePerformActionForShortcutItemEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offCall Signature
off(
eventName: string,
callback?: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:254
Removes a listener for the specified event name. Omitting the callback removes every listener registered for that event on this window.
Parameters
| Parameter | Type |
|---|---|
eventName | string |
callback? | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.offon()
Call Signature
on(
event: "activate",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:84
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "activate" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Call Signature
on(
event: "deactivate",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:89
Raised when the window loses focus.
Parameters
| Parameter | Type |
|---|---|
event | "deactivate" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "background",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:94
Raised when the window enters the background.
Parameters
| Parameter | Type |
|---|---|
event | "background" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "foreground",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:99
Raised when the window enters the foreground.
Parameters
| Parameter | Type |
|---|---|
event | "foreground" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "attached",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:105
Raised when a native surface is bound to the window - both on the first connect and on every re-attach after a detached.
Parameters
| Parameter | Type |
|---|---|
event | "attached" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "detached",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:115
Raised when the native surface goes away while the window session stays alive (iOS scene disconnect, Android activity recreation).
The window stays registered on the Application and keeps its listeners, so the same instance is handed back when a surface re-attaches and handlers registered before the detach keep working afterwards.
Parameters
| Parameter | Type |
|---|---|
event | "detached" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "close",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:125
Raised when the window session ends for good.
Fires exactly once per window. Listeners stay registered for the whole teardown, so a handler added at any earlier point still observes it; immediately after it is dispatched the framework drops every listener on the instance, so nothing registered on a window outlives the window.
Parameters
| Parameter | Type |
|---|---|
event | "close" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "displayed",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:130
Raised after the window content has been displayed for the first time.
Parameters
| Parameter | Type |
|---|---|
event | "displayed" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "orientationChanged",
callback: (data: WindowOrientationChangedEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:135
Raised when the orientation of this window changes.
Parameters
| Parameter | Type |
|---|---|
event | "orientationChanged" |
callback | (data: WindowOrientationChangedEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "systemAppearanceChanged",
callback: (data: WindowSystemAppearanceChangedEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:140
Raised when the system appearance of this window changes between light and dark.
Parameters
| Parameter | Type |
|---|---|
event | "systemAppearanceChanged" |
callback | (data: WindowSystemAppearanceChangedEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "layoutDirectionChanged",
callback: (data: WindowLayoutDirectionChangedEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:145
Raised when the layout direction of this window changes between ltr and rtl.
Parameters
| Parameter | Type |
|---|---|
event | "layoutDirectionChanged" |
callback | (data: WindowLayoutDirectionChangedEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "activityCreated",
callback: (args: AndroidActivityBundleEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:147
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "activityCreated" |
callback | (args: AndroidActivityBundleEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "activityDestroyed",
callback: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:148
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "activityDestroyed" |
callback | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "activityStarted",
callback: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:149
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "activityStarted" |
callback | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "activityPaused",
callback: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:150
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "activityPaused" |
callback | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "activityResumed",
callback: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:151
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "activityResumed" |
callback | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "activityStopped",
callback: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:152
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "activityStopped" |
callback | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "saveActivityState",
callback: (args: AndroidActivityBundleEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:153
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "saveActivityState" |
callback | (args: AndroidActivityBundleEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "activityResult",
callback: (args: AndroidActivityResultEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:154
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "activityResult" |
callback | (args: AndroidActivityResultEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "activityBackPressed",
callback: (args: AndroidActivityBackPressedEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:155
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "activityBackPressed" |
callback | (args: AndroidActivityBackPressedEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "activityNewIntent",
callback: (args: AndroidActivityNewIntentEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:156
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "activityNewIntent" |
callback | (args: AndroidActivityNewIntentEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "activityRequestPermissions",
callback: (args: AndroidActivityRequestPermissionsEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:157
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "activityRequestPermissions" |
callback | (args: AndroidActivityRequestPermissionsEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "sceneWillConnect",
callback: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:158
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "sceneWillConnect" |
callback | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "sceneDidActivate",
callback: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:159
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "sceneDidActivate" |
callback | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "sceneWillResignActive",
callback: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:160
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "sceneWillResignActive" |
callback | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "sceneWillEnterForeground",
callback: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:161
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "sceneWillEnterForeground" |
callback | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "sceneDidEnterBackground",
callback: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:162
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "sceneDidEnterBackground" |
callback | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "sceneDidDisconnect",
callback: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:163
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "sceneDidDisconnect" |
callback | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "sceneOpenURLContexts",
callback: (args: SceneOpenURLContextsEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:164
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "sceneOpenURLContexts" |
callback | (args: SceneOpenURLContextsEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "sceneContinueUserActivity",
callback: (args: SceneContinueUserActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:165
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "sceneContinueUserActivity" |
callback | (args: SceneContinueUserActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
event: "scenePerformActionForShortcutItem",
callback: (args: ScenePerformActionForShortcutItemEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:166
Raised when the window becomes the active/focused window.
Parameters
| Parameter | Type |
|---|---|
event | "scenePerformActionForShortcutItem" |
callback | (args: ScenePerformActionForShortcutItemEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onCall Signature
on(
eventName: string,
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:178
Adds a listener for the specified event name.
Parameters
| Parameter | Type | Description |
|---|---|---|
eventName | string | The name of the event. |
callback | (data: WindowBaseEventData) => void | The event listener to add. Will be called when an event of the given name is raised. |
thisArg? | any | An optional parameter which, when set, will be bound as the this context when the callback is called. Falsy values will be not be bound. |
Returns
void
Overrides
Observable.ononce()
Call Signature
once(
event: "activate",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:180
Adds a listener for the specified event name, which, once fired, will remove itself.
Parameters
| Parameter | Type | Description |
|---|---|---|
event | "activate" | - |
callback | (data: WindowBaseEventData) => void | The event listener to add. Will be called when an event of the given name is raised. |
thisArg? | any | An optional parameter which, when set, will be bound as the this context when the callback is called. Falsy values will be not be bound. |
Returns
void
Overrides
Call Signature
once(
event: "deactivate",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:181
Parameters
| Parameter | Type |
|---|---|
event | "deactivate" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "background",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:182
Parameters
| Parameter | Type |
|---|---|
event | "background" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "foreground",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:183
Parameters
| Parameter | Type |
|---|---|
event | "foreground" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "attached",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:184
Parameters
| Parameter | Type |
|---|---|
event | "attached" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "detached",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:185
Parameters
| Parameter | Type |
|---|---|
event | "detached" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "close",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:186
Parameters
| Parameter | Type |
|---|---|
event | "close" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "displayed",
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:187
Parameters
| Parameter | Type |
|---|---|
event | "displayed" |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "orientationChanged",
callback: (data: WindowOrientationChangedEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:188
Parameters
| Parameter | Type |
|---|---|
event | "orientationChanged" |
callback | (data: WindowOrientationChangedEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "systemAppearanceChanged",
callback: (data: WindowSystemAppearanceChangedEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:189
Parameters
| Parameter | Type |
|---|---|
event | "systemAppearanceChanged" |
callback | (data: WindowSystemAppearanceChangedEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "layoutDirectionChanged",
callback: (data: WindowLayoutDirectionChangedEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:190
Parameters
| Parameter | Type |
|---|---|
event | "layoutDirectionChanged" |
callback | (data: WindowLayoutDirectionChangedEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "activityCreated",
callback: (args: AndroidActivityBundleEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:191
Parameters
| Parameter | Type |
|---|---|
event | "activityCreated" |
callback | (args: AndroidActivityBundleEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "activityDestroyed",
callback: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:192
Parameters
| Parameter | Type |
|---|---|
event | "activityDestroyed" |
callback | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "activityStarted",
callback: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:193
Parameters
| Parameter | Type |
|---|---|
event | "activityStarted" |
callback | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "activityPaused",
callback: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:194
Parameters
| Parameter | Type |
|---|---|
event | "activityPaused" |
callback | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "activityResumed",
callback: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:195
Parameters
| Parameter | Type |
|---|---|
event | "activityResumed" |
callback | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "activityStopped",
callback: (args: AndroidActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:196
Parameters
| Parameter | Type |
|---|---|
event | "activityStopped" |
callback | (args: AndroidActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "saveActivityState",
callback: (args: AndroidActivityBundleEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:197
Parameters
| Parameter | Type |
|---|---|
event | "saveActivityState" |
callback | (args: AndroidActivityBundleEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "activityResult",
callback: (args: AndroidActivityResultEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:198
Parameters
| Parameter | Type |
|---|---|
event | "activityResult" |
callback | (args: AndroidActivityResultEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "activityBackPressed",
callback: (args: AndroidActivityBackPressedEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:199
Parameters
| Parameter | Type |
|---|---|
event | "activityBackPressed" |
callback | (args: AndroidActivityBackPressedEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "activityNewIntent",
callback: (args: AndroidActivityNewIntentEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:200
Parameters
| Parameter | Type |
|---|---|
event | "activityNewIntent" |
callback | (args: AndroidActivityNewIntentEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "activityRequestPermissions",
callback: (args: AndroidActivityRequestPermissionsEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:201
Parameters
| Parameter | Type |
|---|---|
event | "activityRequestPermissions" |
callback | (args: AndroidActivityRequestPermissionsEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "sceneWillConnect",
callback: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:202
Parameters
| Parameter | Type |
|---|---|
event | "sceneWillConnect" |
callback | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "sceneDidActivate",
callback: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:203
Parameters
| Parameter | Type |
|---|---|
event | "sceneDidActivate" |
callback | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "sceneWillResignActive",
callback: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:204
Parameters
| Parameter | Type |
|---|---|
event | "sceneWillResignActive" |
callback | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "sceneWillEnterForeground",
callback: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:205
Parameters
| Parameter | Type |
|---|---|
event | "sceneWillEnterForeground" |
callback | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "sceneDidEnterBackground",
callback: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:206
Parameters
| Parameter | Type |
|---|---|
event | "sceneDidEnterBackground" |
callback | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "sceneDidDisconnect",
callback: (args: SceneEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:207
Parameters
| Parameter | Type |
|---|---|
event | "sceneDidDisconnect" |
callback | (args: SceneEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "sceneOpenURLContexts",
callback: (args: SceneOpenURLContextsEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:208
Parameters
| Parameter | Type |
|---|---|
event | "sceneOpenURLContexts" |
callback | (args: SceneOpenURLContextsEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "sceneContinueUserActivity",
callback: (args: SceneContinueUserActivityEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:209
Parameters
| Parameter | Type |
|---|---|
event | "sceneContinueUserActivity" |
callback | (args: SceneContinueUserActivityEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
event: "scenePerformActionForShortcutItem",
callback: (args: ScenePerformActionForShortcutItemEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:210
Parameters
| Parameter | Type |
|---|---|
event | "scenePerformActionForShortcutItem" |
callback | (args: ScenePerformActionForShortcutItemEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceCall Signature
once(
eventName: string,
callback: (data: WindowBaseEventData) => void,
thisArg?: any): void;Defined in: native-window/index.d.ts:216
Adds a listener for the specified event name that is removed as soon as it is raised once.
Parameters
| Parameter | Type |
|---|---|
eventName | string |
callback | (data: WindowBaseEventData) => void |
thisArg? | any |
Returns
void
Overrides
Observable.onceremoveEventListener()
removeEventListener(
eventName: string,
callback?: (data: EventData) => void,
thisArg?: any): void;Defined in: data/observable/index.ts
Removes listener(s) for the specified event name.
Parameters
| Parameter | Type | Description |
|---|---|---|
eventName | string | Name of the event to attach to. |
callback? | (data: EventData) => void | An optional parameter pointing to a specific listener. If not defined, all listeners for the event names will be removed. |
thisArg? | any | An optional parameter which when set will be used to refine search of the correct callback which will be removed as event listener. |
Returns
void
Inherited from
Observable.removeEventListener
set()
set(name: string, value: any): void;Defined in: data/observable/index.ts
Updates the specified property with the provided value.
Parameters
| Parameter | Type |
|---|---|
name | string |
value | any |
Returns
void
Inherited from
setProperty()
setProperty(name: string, value: any): void;Defined in: data/observable/index.ts
Updates the specified property with the provided value and raises a property change event and a specific change event based on the property name.
Parameters
| Parameter | Type |
|---|---|
name | string |
value | any |
Returns
void
Inherited from
addEventListener()
static addEventListener(
eventName: string,
callback: (data: EventData) => void,
thisArg?: any,
once?: boolean): void;Defined in: data/observable/index.ts
Please avoid using the static event-handling APIs as they will be removed in future.
Parameters
| Parameter | Type |
|---|---|
eventName | string |
callback | (data: EventData) => void |
thisArg? | any |
once? | boolean |
Returns
void
Deprecated
Inherited from
off()
static off(
eventName: string,
callback?: (data: EventData) => void,
thisArg?: any): void;Defined in: data/observable/index.ts
Please avoid using the static event-handling APIs as they will be removed in future.
Parameters
| Parameter | Type |
|---|---|
eventName | string |
callback? | (data: EventData) => void |
thisArg? | any |
Returns
void
Deprecated
Inherited from
on()
static on(
eventName: string,
callback: (data: EventData) => void,
thisArg?: any,
once?: boolean): void;Defined in: data/observable/index.ts
Please avoid using the static event-handling APIs as they will be removed in future.
Parameters
| Parameter | Type |
|---|---|
eventName | string |
callback | (data: EventData) => void |
thisArg? | any |
once? | boolean |
Returns
void
Deprecated
Inherited from
once()
static once(
eventName: string,
callback: (data: EventData) => void,
thisArg?: any): void;Defined in: data/observable/index.ts
Please avoid using the static event-handling APIs as they will be removed in future.
Parameters
| Parameter | Type |
|---|---|
eventName | string |
callback | (data: EventData) => void |
thisArg? | any |
Returns
void
Deprecated
Inherited from
removeEventListener()
static removeEventListener(
eventName: string,
callback?: (data: EventData) => void,
thisArg?: any): void;Defined in: data/observable/index.ts
Please avoid using the static event-handling APIs as they will be removed in future.
Parameters
| Parameter | Type |
|---|---|
eventName | string |
callback? | (data: EventData) => void |
thisArg? | any |
Returns
void
Deprecated
Inherited from
- Previous
- WebView
- Next
- WrapLayout