Skip to content

NativeWindowEvents.md

Latest commit

 

History

History
308 lines (208 loc) · 6.38 KB

NativeWindowEvents.md

File metadata and controls

308 lines (208 loc) · 6.38 KB
Raw
title NativeWindowEvents
titleTemplate title - API / NativeScript
description Events emitted by a NativeWindow instance.
contributors false 
const NativeWindowEvents: {
  activate: "activate";
  activityBackPressed: "activityBackPressed";
  activityCreated: "activityCreated";
  activityDestroyed: "activityDestroyed";
  activityNewIntent: "activityNewIntent";
  activityPaused: "activityPaused";
  activityRequestPermissions: "activityRequestPermissions";
  activityResult: "activityResult";
  activityResumed: "activityResumed";
  activityStarted: "activityStarted";
  activityStopped: "activityStopped";
  attached: "attached";
  background: "background";
  close: "close";
  contentLoaded: "contentLoaded";
  deactivate: "deactivate";
  detached: "detached";
  displayed: "displayed";
  foreground: "foreground";
  layoutDirectionChanged: "layoutDirectionChanged";
  orientationChanged: "orientationChanged";
  saveActivityState: "saveActivityState";
  sceneContinueUserActivity: "sceneContinueUserActivity";
  sceneDidActivate: "sceneDidActivate";
  sceneDidDisconnect: "sceneDidDisconnect";
  sceneDidEnterBackground: "sceneDidEnterBackground";
  sceneOpenURLContexts: "sceneOpenURLContexts";
  scenePerformActionForShortcutItem: "scenePerformActionForShortcutItem";
  sceneWillConnect: "sceneWillConnect";
  sceneWillEnterForeground: "sceneWillEnterForeground";
  sceneWillResignActive: "sceneWillResignActive";
  systemAppearanceChanged: "systemAppearanceChanged";
};

Defined in: native-window/native-window-interfaces.ts

Events emitted by a NativeWindow instance.

Type Declaration

activate

readonly activate: "activate";

Fired when the window becomes the active/focused window.

activityBackPressed

readonly activityBackPressed: "activityBackPressed";

Fired when the back button is pressed (Android only).

activityCreated

readonly activityCreated: "activityCreated";

Fired when the activity is created (Android only).

activityDestroyed

readonly activityDestroyed: "activityDestroyed";

Fired when the activity is destroyed (Android only).

activityNewIntent

readonly activityNewIntent: "activityNewIntent";

Fired when the activity receives a new intent (Android only).

activityPaused

readonly activityPaused: "activityPaused";

Fired when the activity is paused (Android only).

activityRequestPermissions

readonly activityRequestPermissions: "activityRequestPermissions";

Fired when permission results are received (Android only).

activityResult

readonly activityResult: "activityResult";

Fired when the activity receives a result (Android only).

activityResumed

readonly activityResumed: "activityResumed";

Fired when the activity is resumed (Android only).

activityStarted

readonly activityStarted: "activityStarted";

Fired when the activity is started (Android only).

activityStopped

readonly activityStopped: "activityStopped";

Fired when the activity is stopped (Android only).

attached

readonly attached: "attached";

Fired when a native surface is bound to the window, both on first connect and on every re-attach.

background

readonly background: "background";

Fired when the window enters the background.

close

readonly close: "close";

Fired when the window session ends for good. Fires at most once per window; every listener on the window is dropped right after it is dispatched.

contentLoaded

readonly contentLoaded: "contentLoaded";

Fired when the root view content is set or changed.

deactivate

readonly deactivate: "deactivate";

Fired when the window loses focus.

detached

readonly detached: "detached";

Fired when the native surface goes away while the window session stays alive (iOS scene disconnect, Android activity recreation). The window stays registered and keeps its listeners, so the same instance is reused when attached fires again.

displayed

readonly displayed: "displayed";

Fired after the window content has been displayed for the first time.

foreground

readonly foreground: "foreground";

Fired when the window enters the foreground.

layoutDirectionChanged

readonly layoutDirectionChanged: "layoutDirectionChanged";

Fired when the layout direction of this window changes between ltr and rtl.

orientationChanged

readonly orientationChanged: "orientationChanged";

Fired when the orientation of this window changes.

saveActivityState

readonly saveActivityState: "saveActivityState";

Fired when the activity state is being saved (Android only).

sceneContinueUserActivity

readonly sceneContinueUserActivity: "sceneContinueUserActivity";

Fired when the scene is asked to continue a handoff/universal link activity (iOS only).

sceneDidActivate

readonly sceneDidActivate: "sceneDidActivate";

Fired when the scene becomes active (iOS only).

sceneDidDisconnect

readonly sceneDidDisconnect: "sceneDidDisconnect";

Fired when the scene has disconnected (iOS only).

sceneDidEnterBackground

readonly sceneDidEnterBackground: "sceneDidEnterBackground";

Fired when the scene has entered the background (iOS only).

sceneOpenURLContexts

readonly sceneOpenURLContexts: "sceneOpenURLContexts";

Fired when the scene is asked to open one or more URLs (iOS only).

scenePerformActionForShortcutItem

readonly scenePerformActionForShortcutItem: "scenePerformActionForShortcutItem";

Fired when a home screen quick action is directed at the scene (iOS only).

sceneWillConnect

readonly sceneWillConnect: "sceneWillConnect";

Fired when the scene is about to connect (iOS only).

sceneWillEnterForeground

readonly sceneWillEnterForeground: "sceneWillEnterForeground";

Fired when the scene is about to enter the foreground (iOS only).

sceneWillResignActive

readonly sceneWillResignActive: "sceneWillResignActive";

Fired when the scene is about to resign active state (iOS only).

systemAppearanceChanged

readonly systemAppearanceChanged: "systemAppearanceChanged";

Fired when the system appearance of this window changes between light and dark.