@ohos.window (Window)

The Window module provides basic window management capabilities, such as creating and destroying the current window, setting properties for the current window, and managing and scheduling windows.

This module provides the following common window-related functions:

• Window: the current window instance, which is the basic unit managed by the window manager.
• WindowStage: window manager that manages windows.

NOTE

The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import window from '@ohos.window';

WindowType⁷⁺

Enumerates the window types.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Value	Description
TYPE_APP	0	Application subwindow. Model restriction: This API can be used only in the FA model.
TYPE_SYSTEM_ALERT	1	System alert window.
TYPE_INPUT_METHOD9+	2	Input method window. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_STATUS_BAR9+	3	Status bar. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_PANEL9+	4	Notification panel. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_KEYGUARD9+	5	Lock screen. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_VOLUME_OVERLAY9+	6	Volume bar. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_NAVIGATION_BAR9+	7	Navigation bar. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_FLOAT9+	8	Floating window. Model restriction: This API can be used only in the stage model. Required permissions: ohos.permission.SYSTEM_FLOAT_WINDOW
TYPE_WALLPAPER9+	9	Wallpaper. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_DESKTOP9+	10	Home screen. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_LAUNCHER_RECENT9+	11	Recent tasks screen. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_LAUNCHER_DOCK9+	12	Dock bar on the home screen. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_VOICE_INTERACTION9+	13	Voice assistant. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_POINTER9+	14	Mouse. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_FLOAT_CAMERA9+	15	Floating camera window. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_DIALOG10+	16	Modal window. Model restriction: This API can be used only in the stage model.
TYPE_SCREENSHOT9+	17	Screenshot window. Model restriction: This API can be used only in the stage model. System API: This is a system API.
TYPE_SYSTEM_TOAST11+	18	Toast displayed at the top. Model restriction: This API can be used only in the stage model. System API: This is a system API.

Configuration⁹⁺

Defines the parameters for creating a subwindow or system window.

System capability: SystemCapability.WindowManager.WindowManager.Core

|Name|Type|Mandatory|Description | |———-|————————–|–|—————————————————————————–| |name |string |Yes|Name of the window. | |windowType|WindowType|Yes|Type of the window. | |ctx |BaseContext|No|Current application context. If no value is passed, no context is used.
You do not need to set this parameter to create a subwindow in the FA model or a system window in the stage model.| |displayId|number |No|ID of the current physical screen. If no value is passed, the default value -1 is used. The value must be an integer. | |parentId |number |No|ID of the parent window. If no value is passed, the default value -1 is used. The value must be an integer. |

AvoidAreaType⁷⁺

Enumerates the types of the area where the window cannot be displayed.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Value	Description
TYPE_SYSTEM	0	Default area of the system. Generally, the status bar and navigation bar are included. The default area may vary according to the device in use.
TYPE_CUTOUT	1	Notch.
TYPE_SYSTEM_GESTURE9+	2	Gesture area.
TYPE_KEYBOARD9+	3	Soft keyboard area.

WindowMode⁷⁺

Enumerates the window modes.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Value	Description
UNDEFINED	1	The window mode is not defined by the application.
FULLSCREEN	2	The application is displayed in full screen.
PRIMARY	3	The application is displayed in the primary window in split-screen mode.
SECONDARY	4	The application is displayed in the secondary window in split-screen mode.
FLOATING	5	The application is displayed in a floating window.

WindowLayoutMode⁹⁺

Enumerates the window layout modes.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Value	Description
WINDOW_LAYOUT_MODE_CASCADE	0	Cascade mode.
WINDOW_LAYOUT_MODE_TILE	1	Tile mode.

SystemBarProperties

Describes the properties of the status bar and navigation bar.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Mandatory	Description
statusBarColor	string	No	Background color of the status bar. The value is a hexadecimal RGB or ARGB color code and is case insensitive, for example, #00FF00 or #FF00FF00. The default value is #0x66000000.
isStatusBarLightIcon7+	boolean	No	Whether any icon on the status bar is highlighted. The value true means that the icon is highlighted, and false means the opposite. The default value is false.
statusBarContentColor8+	string	No	Color of the text on the status bar. After this property is set, the setting of isStatusBarLightIcon is invalid. The default value is 0xE5FFFFFF.
navigationBarColor	string	No	Background color of the navigation bar. The value is a hexadecimal RGB or ARGB color code and is case insensitive, for example, #00FF00 or #FF00FF00. The default value is #0x66000000.
isNavigationBarLightIcon7+	boolean	No	Whether any icon on the navigation bar is highlighted. The value true means that the icon is highlighted, and false means the opposite. The default value is false.
navigationBarContentColor8+	string	No	Color of the text on the navigation bar. After this property is set, the setting of isNavigationBarLightIcon is invalid. The default value is 0xE5FFFFFF.

Orientation⁹⁺

Enumerates the window orientations.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Value	Description
UNSPECIFIED	0	Unspecified. The orientation is determined by the system.
PORTRAIT	1	Portrait.
LANDSCAPE	2	Landscape.
PORTRAIT_INVERTED	3	Reverse portrait.
LANDSCAPE_INVERTED	4	Reverse landscape.
AUTO_ROTATION	5	Auto rotation.
AUTO_ROTATION_PORTRAIT	6	Auto rotation in the vertical direction.
AUTO_ROTATION_LANDSCAPE	7	Auto rotation in the horizontal direction.
AUTO_ROTATION_RESTRICTED	8	Switched-determined auto rotation.
AUTO_ROTATION_PORTRAIT_RESTRICTED	9	Switched-determined auto rotation in the vertical direction.
AUTO_ROTATION_LANDSCAPE_RESTRICTED	10	Switched-determined auto rotation in the horizontal direction.
LOCKED	11	Locked.

BlurStyle⁹⁺

Enumerates the window blur styles.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Value	Description
OFF	0	Blur disabled.
THIN	1	Thin blur.
REGULAR	2	Regular blur.
THICK	3	Thick blur.

SystemBarRegionTint⁸⁺

Describes the callback for a single system bar.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Readable	Writable	Description
type	WindowType	Yes	No	Type of the system bar whose properties are changed. Only the status bar and navigation bar are supported.
isEnable	boolean	Yes	No	Whether the system bar is displayed. The value true means that the system bar is displayed, and false means the opposite.
region	Rect	Yes	No	Current position and size of the system bar.
backgroundColor	string	Yes	No	Background color of the system bar. The value is a hexadecimal RGB or ARGB color code and is case insensitive, for example, #00FF00 or #FF00FF00.
contentColor	string	Yes	No	Color of the text on the system bar.

SystemBarTintState⁸⁺

Describes the callback for the current system bar.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Readable	Writable	Description
displayId	number	Yes	No	ID of the current physical screen. The value must be an integer.
regionTint	Array<SystemBarRegionTint>	Yes	No	All system bar information that has been changed.

Rect⁷⁺

Describes the rectangular area of the window.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Readable	Writable	Description
left	number	Yes	Yes	Left boundary of the rectangle, in pixels. The value must be an integer.
top	number	Yes	Yes	Top boundary of the rectangle, in pixels. The value must be an integer.
width	number	Yes	Yes	Width of the rectangle, in pixels. The value must be an integer.
height	number	Yes	Yes	Height of the rectangle, in pixels. The value must be an integer.

AvoidArea⁷⁺

Describes the area where the window cannot be displayed.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Readable	Writable	Description
visible9+	boolean	Yes	Yes	Whether the window can be displayed in the area. The value true means that the window can be displayed in the area, and false means the opposite.
leftRect	Rect	Yes	Yes	Rectangle on the left of the screen.
topRect	Rect	Yes	Yes	Rectangle at the top of the screen.
rightRect	Rect	Yes	Yes	Rectangle on the right of the screen.
bottomRect	Rect	Yes	Yes	Rectangle at the bottom of the screen.

Size⁷⁺

Describes the window size.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Readable	Writable	Description
width	number	Yes	Yes	Window width, in pixels. The value must be an integer.
height	number	Yes	Yes	Window height, in pixels. The value must be an integer.

WindowProperties

Describes the window properties.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Readable	Writable	Description
windowRect7+	Rect	Yes	Yes	Window size.
type7+	WindowType	Yes	Yes	Window type.
isFullScreen	boolean	Yes	Yes	Whether the window is displayed in full-screen mode. The default value is false. The value true means that the window is displayed in full-screen mode, and false means the opposite.
isLayoutFullScreen7+	boolean	Yes	Yes	Whether the window layout is in full-screen mode (whether the window is immersive). The default value is false. The value true means that the window is immersive, and false means the opposite.
focusable7+	boolean	Yes	No	Whether the window can gain focus. The default value is true. The value true means that the window can gain focus, and false means the opposite.
touchable7+	boolean	Yes	No	Whether the window is touchable. The default value is true. The value true means that the window is touchable, and false means the opposite.
brightness	number	Yes	Yes	Screen brightness. The value is a floating point number in the range [0.0, 1.0], and the value 1.0 means the brightest. If no value is passed, the brightness follows the system. In this case, the obtained brightness value is -1.
dimBehindValue(deprecated)	number	Yes	Yes	Dimness of the window that is not on top. The value is a floating point number in the range [0.0, 1.0], and the value 1.0 means the dimmest. NOTE This property is supported since API version 7 and deprecated since API version 9.
isKeepScreenOn	boolean	Yes	Yes	Whether the screen is always on. The default value is false. The value true means that the screen is always on, and false means the opposite.
isPrivacyMode7+	boolean	Yes	Yes	Whether the window is in privacy mode. The default value is false. The value true means that the window is in privacy mode, and false means the opposite.
isRoundCorner(deprecated)	boolean	Yes	Yes	Whether the window has rounded corners. The default value is false. The value true means that the window has rounded corners, and false means the opposite. NOTE This property is supported since API version 7 and deprecated since API version 9.
isTransparent7+	boolean	Yes	Yes	Whether the window is transparent. The default value is false. The value true means that the window is transparent, and false means the opposite.
id9+	number	Yes	No	Window ID. The default value is 0. The value must be an integer.

ColorSpace⁸⁺

Enumerates the color spaces.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Value	Description
DEFAULT	0	Default SRGB gamut.
WIDE_GAMUT	1	Wide-gamut.

ScaleOptions⁹⁺

Describes the scale parameters.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Readable	Writable	Description
x	number	No	Yes	Scale factor along the x-axis. The value is a floating point number, and the default value is 1.0.
y	number	No	Yes	Scale factor along the y-axis. The value is a floating point number, and the default value is 1.0.
pivotX	number	No	Yes	X coordinate of the scale center. The value is a floating point number in the range [0.0, 1.0], and the default value is 0.5.
pivotY	number	No	Yes	Y coordinate of the scale center. The value is a floating point number in the range [0.0, 1.0], and the default value is 0.5.

RotateOptions⁹⁺

Describes the rotation parameters.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Readable	Writable	Description
x	number	No	Yes	Rotation angle around the x-axis. The value is a floating point number, and the default value is 0.0.
y	number	No	Yes	Rotation angle around the y-axis. The value is a floating point number, and the default value is 0.0.
z	number	No	Yes	Rotation angle around the z-axis. The value is a floating point number, and the default value is 0.0.
pivotX	number	No	Yes	X coordinate of the rotation center. The value is a floating point number in the range [0.0, 1.0], and the default value is 0.5.
pivotY	number	No	Yes	Y coordinate of the rotation center. The value is a floating point number in the range [0.0, 1.0], and the default value is 0.5.

TranslateOptions⁹⁺

Describes the translation parameters.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Readable	Writable	Description
x	number	No	Yes	Distance to translate along the x-axis. The value is a floating point number, and the default value is 0.0.
y	number	No	Yes	Distance to translate along the y-axis. The value is a floating point number, and the default value is 0.0.
z	number	No	Yes	Distance to translate along the z-axis. The value is a floating point number, and the default value is 0.0.

WindowEventType¹⁰⁺

Enumerates the window lifecycle states.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Value	Description
WINDOW_SHOWN	1	The window is running in the foreground.
WINDOW_ACTIVE	2	The window gains focus.
WINDOW_INACTIVE	3	The window loses focus.
WINDOW_HIDDEN	4	The window is running in the background.

window.createWindow⁹⁺

createWindow(config: Configuration, callback: AsyncCallback<Window>): void

Creates a subwindow or system window. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——–|————————————–|–|———————————| |config |Configuration |Yes|Parameters used for creating the window.| |callback|AsyncCallback<Window>|Yes|Callback used to return the window created.|

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300001	Repeated operation.
1300006	This window context is abnormal.
1300008	The operation is on invalid display.
1300009	The parent window is invalid.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let config: window.Configuration = {
  name: "alertWindow",
  windowType: window.WindowType.TYPE_SYSTEM_ALERT
};
try {
  window.createWindow(config, (err: BusinessError, data) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to create the window. Cause: ' + JSON.stringify(err));
      return;
    }
    windowClass = data;
    console.info('Succeeded in creating the window. Data: ' + JSON.stringify(data));
    windowClass.resetSize(500, 1000);
  });
} catch (exception) {
  console.error('Failed to create the window. Cause: ' + JSON.stringify(exception));
}

window.createWindow⁹⁺

createWindow(config: Configuration): Promise<Window>

Creates a subwindow or system window. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——|——————————–|–|——————| |config|Configuration|Yes|Parameters used for creating the window.|

Return value

Type	Description
Promise<Window>	Promise used to return the window created.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300001	Repeated operation.
1300006	This window context is abnormal.
1300008	The operation is on invalid display.
1300009	The parent window is invalid.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let config: window.Configuration = {
  name: "alertWindow",
  windowType: window.WindowType.TYPE_SYSTEM_ALERT
};
try {
  let promise = window.createWindow(config);
  promise.then((data) => {
    windowClass = data;
    console.info('Succeeded in creating the window. Data:' + JSON.stringify(data));
  }).catch((err: BusinessError) => {
    console.error('Failed to create the Window. Cause:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to create the window. Cause: ' + JSON.stringify(exception));
}

window.findWindow⁹⁺

findWindow(name: string): Window

Finds a window based on the name.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Window ID.

Return value

Type	Description
Window	Window found.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

let windowClass: window.Window = window.findWindow("test");
try {
  windowClass = window.findWindow('alertWindow');
} catch (exception) {
  console.error('Failed to find the Window. Cause: ' + JSON.stringify(exception));
}

window.getLastWindow⁹⁺

getLastWindow(ctx: BaseContext, callback: AsyncCallback<Window>): void

Obtains the top window of the current application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——–|————————————–|–|—————————————-| |ctx |BaseContext|Yes|Current application context.| |callback|AsyncCallback<Window>|Yes|Callback used to return the top window obtained.|

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300006	This window context is abnormal.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
try {
  class BaseContext {
      stageMode: boolean = false;
    }
    let context: BaseContext = { stageMode: false };
  window.getLastWindow(context, (err: BusinessError, data) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
      return;
    }
    windowClass = data;
    console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
  });
} catch (exception) {
  console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(exception));
}

window.getLastWindow⁹⁺

getLastWindow(ctx: BaseContext): Promise<Window>

Obtains the top window of the current application. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
ctx	BaseContext	Yes	Current application context.

Return value

Type	Description
Promise<Window>	Promise used to return the top window obtained.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300006	This window context is abnormal.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
class BaseContext {
  stageMode: boolean = false;
}
let context: BaseContext = { stageMode: false };
try {
  let promise = window.getLastWindow(context);
  promise.then((data) => {
    windowClass = data;
    console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
  }).catch((err: BusinessError) => {
    console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(exception));
}

window.minimizeAll⁹⁺

minimizeAll(id: number, callback: AsyncCallback<void>): void

Minimizes all windows on a display. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
id	number	Yes	ID of the display. The value must be an integer.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300003	This window manager service works abnormally.

Example

import display from '@ohos.display'
import { BusinessError } from '@ohos.base';

let displayClass: display.Display|null = null;
try {
  displayClass = display.getDefaultDisplaySync();

  try {
    window.minimizeAll(displayClass.id, (err: BusinessError) => {
      const errCode: number = err.code;
      if (errCode) {
        console.error('Failed to minimize all windows. Cause: ' + JSON.stringify(err));
        return;
      }
      console.info('Succeeded in minimizing all windows.');
    });
  } catch (exception) {
    console.error('Failed to minimize all windows. Cause: ' + JSON.stringify(exception));
  }
} catch (exception) {
  console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(exception));
}

window.minimizeAll⁹⁺

minimizeAll(id: number): Promise<void>

Minimizes all windows on a display. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
id	number	Yes	ID of the display. The value must be an integer.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300003	This window manager service works abnormally.

Example

import display from '@ohos.display'
import { BusinessError } from '@ohos.base';

let displayClass: display.Display|null = null;
try {
  displayClass = display.getDefaultDisplaySync();

  try {
    let promise = window.minimizeAll(displayClass.id);
    promise.then(() => {
      console.info('Succeeded in minimizing all windows.');
    }).catch((err: BusinessError) => {
      console.error('Failed to minimize all windows. Cause: ' + JSON.stringify(err));
    });
  } catch (exception) {
    console.error('Failed to minimize all windows. Cause: ' + JSON.stringify(exception));
  }
} catch (exception) {
  console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(exception));
}

window.toggleShownStateForAllAppWindows⁹⁺

toggleShownStateForAllAppWindows(callback: AsyncCallback<void>): void

Hides or restores the application’s windows during quick multi-window switching. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

window.toggleShownStateForAllAppWindows((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to toggle shown state for all app windows. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in toggling shown state for all app windows.');
});

window.toggleShownStateForAllAppWindows⁹⁺

toggleShownStateForAllAppWindows(): Promise<void>

Hides or restores the application’s windows during quick multi-window switching. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let promise = window.toggleShownStateForAllAppWindows();
promise.then(() => {
  console.info('Succeeded in toggling shown state for all app windows.');
}).catch((err: BusinessError) => {
  console.error('Failed to toggle shown state for all app windows. Cause: ' + JSON.stringify(err));
});

window.setWindowLayoutMode⁹⁺

setWindowLayoutMode(mode: WindowLayoutMode, callback: AsyncCallback<void>): void

Sets the window layout mode. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
mode	WindowLayoutMode	Yes	Window layout mode to set.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

try {
  window.setWindowLayoutMode(window.WindowLayoutMode.WINDOW_LAYOUT_MODE_CASCADE, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set window layout mode. Cause: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting window layout mode.');
  });
} catch (exception) {
  console.error('Failed to set window layout mode. Cause: ' + JSON.stringify(exception));
}

window.setWindowLayoutMode⁹⁺

setWindowLayoutMode(mode: WindowLayoutMode): Promise<void>

Sets the window layout mode. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
mode	WindowLayoutMode	Yes	Window layout mode to set.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

try {
  let promise = window.setWindowLayoutMode(window.WindowLayoutMode.WINDOW_LAYOUT_MODE_CASCADE);
  promise.then(() => {
    console.info('Succeeded in setting window layout mode.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set window layout mode. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set window layout mode. Cause: ' + JSON.stringify(exception));
}

window.on(‘systemBarTintChange’)⁸⁺

on(type: ‘systemBarTintChange’, callback: Callback<SystemBarTintState>): void

Subscribes to the property change event of the status bar and navigation bar.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘systemBarTintChange’, indicating the property change event of the status bar and navigation bar.
callback	Callback<SystemBarTintState>	Yes	Callback used to return the properties of the status bar and navigation bar.

Example

try {
  window.on('systemBarTintChange', (data) => {
    console.info('Succeeded in enabling the listener for systemBarTint changes. Data: ' + JSON.stringify(data));
  });
} catch (exception) {
  console.error('Failed to enable the listener for systemBarTint changes. Cause: ' + JSON.stringify(exception));
}

window.off(‘systemBarTintChange’)⁸⁺

off(type: ‘systemBarTintChange’, callback?: Callback<SystemBarTintState >): void

Unsubscribes from the property change event of the status bar and navigation bar.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘systemBarTintChange’, indicating the property change event of the status bar and navigation bar.
callback	Callback<SystemBarTintState>	No	Callback used to return the properties of the status bar and navigation bar. If a value is passed in, the corresponding subscription is canceled. If no value is passed in, all subscriptions to the specified event are canceled.

Example

try {
  window.off('systemBarTintChange');
} catch (exception) {
  console.error('Failed to disable the listener for systemBarTint changes. Cause: ' + JSON.stringify(exception));
}

window.on(‘gestureNavigationEnabledChange’)¹⁰⁺

on(type: ‘gestureNavigationEnabledChange’, callback: Callback<boolean>): void

Subscribes to the gesture navigation status change event.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘gestureNavigationEnabledChange’, indicating the gesture navigation status change event.
callback	Callback<boolean>	Yes	Callback used to return the gesture navigation status. The value true means that the gesture navigation status is changed to enabled, and false means that the gesture navigation status is changed to disabled.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

try {
  window.on('gestureNavigationEnabledChange', (data) => {
    console.info('Succeeded in enabling the listener for gesture navigation status changes. Data: ' + JSON.stringify(data));
  });
} catch (exception) {
  console.error('Failed to enable the listener for gesture navigation status changes. Cause: ' + JSON.stringify(exception));
}

window.off(‘gestureNavigationEnabledChange’)¹⁰⁺

off(type: ‘gestureNavigationEnabledChange’, callback?: Callback<boolean>): void

Unsubscribes from the gesture navigation status change event.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type |Mandatory|Description | |——–|———————–|–|————————————————————| |type |string |Yes|Event type. The value is fixed at ‘gestureNavigationEnabledChange’, indicating the gesture navigation status change event.| |callback|Callback<boolean>|No|Callback function that has been used for the subscription. If a value is passed in, the corresponding subscription is canceled. If no value is passed in, all subscriptions to the specified event are canceled.|

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

try {
  window.off('gestureNavigationEnabledChange');
} catch (exception) {
  console.error('Failed to disable the listener for gesture navigation status changes. Cause: ' + JSON.stringify(exception));
}

window.on(‘waterMarkFlagChange’)¹⁰⁺

on(type: ‘waterMarkFlagChange’, callback: Callback<boolean>): void

Subscribes to the watermark status change event.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘waterMarkFlagChange’, indicating the watermark status change event.
callback	Callback<boolean>	Yes	Callback used to return the watermark status. The value true means that the watermark feature is enabled, and false means the opposite.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300003	This window manager service works abnormally.

Example

try {
  window.on('waterMarkFlagChange', (data) => {
    console.info('Succeeded in enabling the listener for watermark flag changes. Data: ' + JSON.stringify(data));
  });
} catch (exception) {
  console.error('Failed to enable the listener for watermark flag changes. Cause: ' + JSON.stringify(exception));
}

window.off(‘waterMarkFlagChange’)¹⁰⁺

off(type: ‘waterMarkFlagChange’, callback?: Callback<boolean>): void

Unsubscribes from the watermark status change event.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type |Mandatory|Description | |——–|———————–|–|————————————————————| |type |string |Yes|Event type. The value is fixed at ‘waterMarkFlagChange’, indicating the watermark status change event.| |callback|Callback<boolean>|No|Callback function that has been used for the subscription. If a value is passed in, the corresponding subscription is canceled. If no value is passed in, all subscriptions to the specified event are canceled.|

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300003	This window manager service works abnormally.

Example

try {
  window.off('waterMarkFlagChange');
} catch (exception) {
  console.error('Failed to disable the listener for watermark flag changes. Cause: ' + JSON.stringify(exception));
}

window.setGestureNavigationEnabled¹⁰⁺

setGestureNavigationEnabled(enable: boolean, callback: AsyncCallback<void>): void

Enables or disables gesture navigation. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to enable gesture navigation. The value true means to enable gesture navigation, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

try {
  window.setGestureNavigationEnabled(true, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set gesture navigation enabled. Cause: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting gesture navigation enabled.');
  });
} catch (exception) {
  console.error('Failed to set gesture navigation enabled. Cause: ' + JSON.stringify(exception));
}

window.setGestureNavigationEnabled¹⁰⁺

setGestureNavigationEnabled(enable: boolean): Promise<void>

Enables or disables gesture navigation. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to enable gesture navigation. The value true means to enable gesture navigation, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

try {
  let promise = window.setGestureNavigationEnabled(true);
  promise.then(() => {
    console.info('Succeeded in setting gesture navigation enabled.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set gesture navigation enabled. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set gesture navigation enabled. Cause: ' + JSON.stringify(exception));
}

window.setWaterMarkImage¹⁰⁺

setWaterMarkImage(pixelMap: image.PixelMap, enable: boolean, callback: AsyncCallback<void>): void

Sets the watermark image display status. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
pixelMap	image.PixelMap	Yes	Watermark image.
enable	boolean	Yes	Whether to display the watermark image. The value true means to display the watermark image, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300003	This window manager service works abnormally.

Example

import image from '@ohos.multimedia.image';
import { BusinessError } from '@ohos.base';

let enable: boolean = true;
let color: ArrayBuffer = new ArrayBuffer(0);
let initializationOptions: image.InitializationOptions = {
  size: {
    height: 100,
    width: 100
  }
};
image.createPixelMap(color, initializationOptions).then((pixelMap: image.PixelMap) => {
  console.info('Succeeded in creating pixelmap.');
  try {
    window.setWaterMarkImage(pixelMap, enable, (err: BusinessError) => {
      const errCode: number = err.code;
      if (errCode) {
        console.error('Failed to show watermark image. Cause: ' + JSON.stringify(err));
        return;
      }
      console.info('Succeeded in showing watermark image.');
    });
  } catch (exception) {
    console.error('Failed to show watermark image. Cause: ' + JSON.stringify(exception));
  }
}).catch((err: BusinessError) => {
  console.error('Failed to create PixelMap. Cause: ' + JSON.stringify(err));
});

window.setWaterMarkImage¹⁰⁺

setWaterMarkImage(pixelMap: image.PixelMap, enable: boolean): Promise<void>

Sets the watermark image display status. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
pixelMap	image.PixelMap	Yes	Watermark image.
enable	boolean	Yes	Whether to display the watermark image. The value true means to display the watermark image, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300003	This window manager service works abnormally.

Example

import image from '@ohos.multimedia.image';
import { BusinessError } from '@ohos.base';

let enable: boolean = true;
let color: ArrayBuffer = new ArrayBuffer(0);
let initializationOptions: image.InitializationOptions = {
  size: {
    height: 100,
    width: 100
  }
};
image.createPixelMap(color, initializationOptions).then((pixelMap: image.PixelMap) => {
  console.info('Succeeded in creating pixelmap.');
  try {
    let promise = window.setWaterMarkImage(pixelMap, enable);
    promise.then(() => {
      console.info('Succeeded in showing watermark image.');
    }).catch((err: BusinessError) => {
      console.error('Failed to show watermark image. Cause: ' + JSON.stringify(err));
    });
  } catch (exception) {
    console.error('Failed to show watermark image. Cause: ' + JSON.stringify(exception));
  }
}).catch((err: BusinessError) => {
  console.error('Failed to create PixelMap. Cause: ' + JSON.stringify(err));
});

window.create^(deprecated)

create(id: string, type: WindowType, callback: AsyncCallback<Window>): void

Creates a subwindow. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use createWindow() instead.

Model restriction: This API can be used only in the FA model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
id	string	Yes	Window ID.
type	WindowType	Yes	Window type.
callback	AsyncCallback<Window>	Yes	Callback used to return the subwindow created.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
window.create('first', window.WindowType.TYPE_APP, (err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err));
    return;
  }
  windowClass = data;
  console.info('Succeeded in creating the subWindow. Data: ' + JSON.stringify(data));
});

window.create^(deprecated)

create(id: string, type: WindowType): Promise<Window>

Creates a subwindow. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use createWindow() instead.

Model restriction: This API can be used only in the FA model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
id	string	Yes	Window ID.
type	WindowType	Yes	Window type.

Return value

Type	Description
Promise<Window>	Promise used to return the subwindow created.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = window.create('first', window.WindowType.TYPE_APP);
promise.then((data) => {
  windowClass = data;
  console.info('Succeeded in creating the subWindow. Data: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err));
});

window.create^(deprecated)

create(ctx: BaseContext, id: string, type: WindowType, callback: AsyncCallback<Window>): void

Creates a system window. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use createWindow() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
ctx	BaseContext	Yes	Current application context.
id	string	Yes	Window ID.
type	WindowType	Yes	Window type.
callback	AsyncCallback<Window>	Yes	Callback used to return the subwindow created.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
window.create('alertWindow', window.WindowType.TYPE_SYSTEM_ALERT, (err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to create the window. Cause: ' + JSON.stringify(err));
    return;
  }
  windowClass = data;
  console.info('Succeeded in creating the window. Data: ' + JSON.stringify(data));
  windowClass.resetSize(500, 1000);
});

window.create^(deprecated)

create(ctx: BaseContext, id: string, type: WindowType): Promise<Window>

Creates a system window. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use createWindow() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
ctx	BaseContext	Yes	Current application context.
id	string	Yes	Window ID.
type	WindowType	Yes	Window type.

Return value

Type	Description
Promise<Window>	Promise used to return the subwindow created.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = window.create('alertWindow', window.WindowType.TYPE_SYSTEM_ALERT);
promise.then((data) => {
  windowClass = data;
  console.info('Succeeded in creating the window. Data:' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to create the Window. Cause:' + JSON.stringify(err));
});

window.find^(deprecated)

find(id: string, callback: AsyncCallback<Window>): void

Finds a window based on the ID. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use findWindow() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
id	string	Yes	Window ID.
callback	AsyncCallback<Window>	Yes	Callback used to return the window found.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
window.find('alertWindow', (err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to find the Window. Cause: ' + JSON.stringify(err));
    return;
  }
  windowClass = data;
  console.info('Succeeded in finding the window. Data: ' + JSON.stringify(data));
});

window.find^(deprecated)

find(id: string): Promise<Window>

Finds a window based on the ID. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use findWindow() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
id	string	Yes	Window ID.

Return value

Type	Description
Promise<Window>	Promise used to return the window found.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = window.find('alertWindow');
promise.then((data) => {
  windowClass = data;
  console.info('Succeeded in finding the window. Data: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to find the Window. Cause: ' + JSON.stringify(err));
});

window.getTopWindow^(deprecated)

getTopWindow(callback: AsyncCallback<Window>): void

Obtains the top window of the current application. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use getLastWindow() instead.

Model restriction: This API can be used only in the FA model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Window>	Yes	Callback used to return the top window obtained.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
window.getTopWindow((err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
    return;
  }
  windowClass = data;
  console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
});

window.getTopWindow^(deprecated)

getTopWindow(): Promise<Window>

Obtains the top window of the current application. This API uses a promise to return the result.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use getLastWindow() instead.

Model restriction: This API can be used only in the FA model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<Window>	Promise used to return the top window obtained.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = window.getTopWindow();
promise.then((data)=> {
    windowClass = data;
    console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
}).catch((err: BusinessError)=>{
    console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
});

window.getTopWindow^(deprecated)

getTopWindow(ctx: BaseContext, callback: AsyncCallback<Window>): void

Obtains the top window of the current application. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getLastWindow() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
ctx	BaseContext	Yes	Current application context.
callback	AsyncCallback<Window>	Yes	Callback used to return the top window obtained.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = window.getTopWindow();
promise.then((data) => {
  windowClass = data;
  console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
});

window.getTopWindow^(deprecated)

getTopWindow(ctx: BaseContext): Promise<Window>

Obtains the top window of the current application. This API uses a promise to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getLastWindow() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
ctx	BaseContext	Yes	Current application context.

Return value

Type	Description
Promise<Window>	Promise used to return the top window obtained.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = window.getTopWindow();
promise.then((data) => {
  windowClass = data;
  console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
});

Window

Represents the current window instance, which is the basic unit managed by the window manager.

In the following API examples, you must use getLastWindow(), createWindow(), or findWindow() to obtain a Window instance and then call a method in this instance.

hide⁷⁺

hide (callback: AsyncCallback<void>): void

Hides this window. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.hide((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to hide the window. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in hiding the window.');
});

hide⁷⁺

hide(): Promise<void>

Hides this window. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.hide();
promise.then(() => {
  console.info('Succeeded in hiding the window.');
}).catch((err: BusinessError) => {
  console.error('Failed to hide the window. Cause: ' + JSON.stringify(err));
});

hideWithAnimation⁹⁺

hideWithAnimation(callback: AsyncCallback<void>): void

Hides this window and plays an animation during the process. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.hideWithAnimation((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to hide the window with animation. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in hiding the window with animation.');
});

hideWithAnimation⁹⁺

hideWithAnimation(): Promise<void>

Hides this window and plays an animation during the process. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.hideWithAnimation();
promise.then(() => {
  console.info('Succeeded in hiding the window with animation.');
}).catch((err: BusinessError) => {
  console.error('Failed to hide the window with animation. Cause: ' + JSON.stringify(err));
});

showWindow⁹⁺

showWindow(callback: AsyncCallback<void>): void

Shows this window. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——–|————————-|–|———| |callback|AsyncCallback<void>|Yes|Callback used to return the result.|

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.showWindow((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in showing the window.');
});

showWindow⁹⁺

showWindow(): Promise<void>

Shows this window. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.showWindow();
promise.then(() => {
  console.info('Succeeded in showing the window.');
}).catch((err: BusinessError) => {
  console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
});

showWithAnimation⁹⁺

showWithAnimation(callback: AsyncCallback<void>): void

Shows this window and plays an animation during the process. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.showWithAnimation((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to show the window with animation. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in showing the window with animation.');
});

showWithAnimation⁹⁺

showWithAnimation(): Promise<void>

Shows this window and plays an animation during the process. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.showWithAnimation();
promise.then(() => {
  console.info('Succeeded in showing the window with animation.');
}).catch((err: BusinessError) => {
  console.error('Failed to show the window with animation. Cause: ' + JSON.stringify(err));
});

destroyWindow⁹⁺

destroyWindow(callback: AsyncCallback<void>): void

Destroys this window. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——–|————————-|–|———| |callback|AsyncCallback<void>|Yes|Callback used to return the result.|

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.destroyWindow((err) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to destroy the window. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in destroying the window.');
});

destroyWindow⁹⁺

destroyWindow(): Promise<void>

Destroys this window. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.destroyWindow();
promise.then(() => {
  console.info('Succeeded in destroying the window.');
}).catch((err: BusinessError) => {
  console.error('Failed to destroy the window. Cause: ' + JSON.stringify(err));
});

moveWindowTo⁹⁺

moveWindowTo(x: number, y: number, callback: AsyncCallback<void>): void

Moves this window. This API uses an asynchronous callback to return the result.

This operation is not supported in a window in full-screen mode.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——–|————————-|–|———————————————| |x |number |Yes|Distance that the window moves along the x-axis, in px. A positive value indicates that the window moves to the right. The value must be an integer.| |y |number |Yes|Distance that the window moves along the y-axis, in px. A positive value indicates that the window moves downwards. The value must be an integer.| |callback|AsyncCallback<void>|Yes|Callback used to return the result. |

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.moveWindowTo(300, 300, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to move the window. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in moving the window.');
  });
} catch (exception) {
  console.error('Failed to move the window. Cause:' + JSON.stringify(exception));
}

moveWindowTo⁹⁺

moveWindowTo(x: number, y: number): Promise<void>

Moves this window. This API uses a promise to return the result.

This operation is not supported in a window in full-screen mode.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |–|—–|–|———————————————| |x|number|Yes|Distance that the window moves along the x-axis, in px. A positive value indicates that the window moves to the right. The value must be an integer.| |y|number|Yes|Distance that the window moves along the y-axis, in px. A positive value indicates that the window moves downwards. The value must be an integer.|

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

try {
  let windowClass: window.Window = window.findWindow("test");
  let promise = windowClass.moveWindowTo(300, 300);
  promise.then(() => {
    console.info('Succeeded in moving the window.');
  }).catch((err: BusinessError) => {
    console.error('Failed to move the window. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to move the window. Cause:' + JSON.stringify(exception));
}

resize⁹⁺

resize(width: number, height: number, callback: AsyncCallback<void>): void

Changes the size of this window. This API uses an asynchronous callback to return the result.

The main window and subwindow have the following size limits: [320, 2560] in width and [240, 2560] in height, both in units of vp.

The system window has the following size limits: [0, 2560] in width and [0, 2560] in height, both in units of vp.

The new width and height you set must meet the limits.

This operation is not supported in a window in full-screen mode.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——–|————————-|–|————————| |width |number |Yes|New width of the window, in px. The value must be an integer.| |height |number |Yes|New height of the window, in px. The value must be an integer.| |callback|AsyncCallback<void>|Yes|Callback used to return the result. |

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.resize(500, 1000, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to change the window size. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in changing the window size.');
  });
} catch (exception) {
  console.error('Failed to change the window size. Cause:' + JSON.stringify(exception));
}

resize⁹⁺

resize(width: number, height: number): Promise<void>

Changes the size of this window. This API uses a promise to return the result.

The main window and subwindow have the following size limits: [320, 2560] in width and [240, 2560] in height, both in units of vp.

The system window has the following size limits: [0, 2560] in width and [0, 2560] in height, both in units of vp.

The new width and height you set must meet the limits.

This operation is not supported in a window in full-screen mode.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——|——|–|————————| |width|number|Yes|New width of the window, in px. The value must be an integer.| |height|number|Yes|New height of the window, in px. The value must be an integer.|

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

try {
  let windowClass: window.Window = window.findWindow("test");
  let promise = windowClass.resize(500, 1000);
  promise.then(() => {
    console.info('Succeeded in changing the window size.');
  }).catch((err: BusinessError) => {
    console.error('Failed to change the window size. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to change the window size. Cause: ' + JSON.stringify(exception));
}

setWindowMode⁹⁺

setWindowMode(mode: WindowMode, callback: AsyncCallback<void>): void

Sets the mode of this window. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——–|————————–|–|———| |mode |WindowMode|Yes|Window mode to set.| |callback|AsyncCallback<void>|Yes|Callback used to return the result.|

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let mode = window.WindowMode.FULLSCREEN;
try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.setWindowMode(mode, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the window mode. Cause: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the window mode.');
  });
} catch (exception) {
  console.error('Failed to set the window mode. Cause: ' + JSON.stringify(exception));
}

setWindowMode⁹⁺

setWindowMode(mode: WindowMode): Promise<void>

Sets the type of this window. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——–|————————–|–|———| |mode |WindowMode|Yes|Window mode to set.|

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let mode = window.WindowMode.FULLSCREEN;
try {
  let windowClass: window.Window = window.findWindow("test");
  let promise = windowClass.setWindowMode(mode);
  promise.then(() => {
    console.info('Succeeded in setting the window mode.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the window mode. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the window mode. Cause: ' + JSON.stringify(exception));
}

getWindowProperties⁹⁺

getWindowProperties(): WindowProperties

Obtains the properties of this window.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
WindowProperties	Window properties obtained.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

try {
  let windowClass: window.Window = window.findWindow("test");
  let properties = windowClass.getWindowProperties();
} catch (exception) {
  console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(exception));
}

getWindowAvoidArea⁹⁺

getWindowAvoidArea(type: AvoidAreaType): AvoidArea

Obtains the area where this window cannot be displayed, for example, the system bar area, notch, gesture area, and soft keyboard area.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |—-|———————————-|–|————————————————————| |type|AvoidAreaType|Yes|Type of the area.|

Return value

Type	Description
AvoidArea	Area where the window cannot be displayed.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

let type = window.AvoidAreaType.TYPE_SYSTEM;
try {
  let windowClass: window.Window = window.findWindow("test");
  let avoidArea = windowClass.getWindowAvoidArea(type);
} catch (exception) {
  console.error('Failed to obtain the area. Cause:' + JSON.stringify(exception));
}

setWindowLayoutFullScreen⁹⁺

setWindowLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback<void>): void

Sets whether the window layout is immersive. This API uses an asynchronous callback to return the result.

An immersive layout means that the layout does not avoid the status bar and navigation bar, and components may overlap with them.

A non-immersive layout means that the layout avoids the status bar and navigation bar, and components do not overlap with them.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——————|————————-|–|———| |isLayoutFullScreen|boolean |Yes|Whether the window layout is immersive. (The status bar and navigation bar of the immersive layout are still displayed.) The value true means that the window layout is immersive, and false means the opposite.| |callback |AsyncCallback<void>|Yes|Callback used to return the result.|

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let isLayoutFullScreen = true;
try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.setWindowLayoutFullScreen(isLayoutFullScreen, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the window layout to full-screen mode.');
  });
} catch (exception) {
  console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(exception));
}

setWindowLayoutFullScreen⁹⁺

setWindowLayoutFullScreen(isLayoutFullScreen: boolean): Promise<void>

Sets whether the window layout is immersive. This API uses a promise to return the result.

An immersive layout means that the layout does not avoid the status bar and navigation bar, and components may overlap with them.

A non-immersive layout means that the layout avoids the status bar and navigation bar, and components do not overlap with them.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——————|——-|–|————————————————————————————————| |isLayoutFullScreen|boolean|Yes|Whether the window layout is immersive. (The status bar and navigation bar of the immersive layout are still displayed.) The value true means that the window layout is immersive, and false means the opposite.|

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let isLayoutFullScreen = true;
try {
  let windowClass: window.Window = window.findWindow("test");
  let promise = windowClass.setWindowLayoutFullScreen(isLayoutFullScreen);
  promise.then(() => {
    console.info('Succeeded in setting the window layout to full-screen mode.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(exception));
}

setWindowSystemBarEnable⁹⁺

setWindowSystemBarEnable(names: Array<‘status’|‘navigation’>, callback: AsyncCallback&lt;void&gt;): void

Sets whether to display the status bar and navigation bar when the window is in full-screen mode. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——–|—————————-|–|———| |names |Array<‘status’|‘navigation’>|Yes|Whether to display the status bar and navigation bar when the window is in full-screen mode.
For example, to display the status bar and navigation bar, set this parameter to [‘status’, ‘navigation’]. By default, they are not displayed.| |callback|AsyncCallback&lt;void&gt;|Yes|Callback used to return the result.|

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

// In this example, the status bar and navigation bar are not displayed.
import { BusinessError } from '@ohos.base';

let names: Array<'status'|'navigation'> = [];
try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.setWindowSystemBarEnable(names, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the system bar to be invisible. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the system bar to be invisible.');
  });
} catch (exception) {
  console.error('Failed to set the system bar to be invisible. Cause:' + JSON.stringify(exception));
}

setWindowSystemBarEnable⁹⁺

setWindowSystemBarEnable(names: Array<‘status’|‘navigation’>): Promise&lt;void&gt;

Sets whether to display the status bar and navigation bar when the window is in full-screen mode. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |—–|—————————-|–|———————————| |names|Array<‘status’|‘navigation’>|Yes|Whether to display the status bar and navigation bar when the window is in full-screen mode.
For example, to display the status bar and navigation bar, set this parameter to [‘status’, ‘navigation’]. By default, they are not displayed.|

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

// In this example, the status bar and navigation bar are not displayed.
import { BusinessError } from '@ohos.base';

let names: Array<'status'|'navigation'> = [];
try {
  let windowClass: window.Window = window.findWindow("test");
  let promise = windowClass.setWindowSystemBarEnable(names);
  promise.then(() => {
    console.info('Succeeded in setting the system bar to be invisible.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the system bar to be invisible. Cause:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the system bar to be invisible. Cause:' + JSON.stringify(exception));
}

setWindowSystemBarProperties⁹⁺

setWindowSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback&lt;void&gt;): void

Sets the properties of the status bar and navigation bar when the window is in full-screen mode. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
SystemBarProperties	SystemBarProperties	Yes	Properties of the status bar and navigation bar.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let SystemBarProperties: window.SystemBarProperties = {
  statusBarColor: '#ff00ff',
  navigationBarColor: '#00ff00',
  // The following properties are supported since API version 8.
  statusBarContentColor: '#ffffff',
  navigationBarContentColor: '#00ffff'
};
try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.setWindowSystemBarProperties(SystemBarProperties, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the system bar properties.');
  });
} catch (exception) {
  console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(exception));
}

setWindowSystemBarProperties⁹⁺

setWindowSystemBarProperties(systemBarProperties: SystemBarProperties): Promise&lt;void&gt;

Sets the properties of the status bar and navigation bar when the window is in full-screen mode. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
SystemBarProperties	SystemBarProperties	Yes	Properties of the status bar and navigation bar.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let SystemBarProperties: window.SystemBarProperties = {
  statusBarColor: '#ff00ff',
  navigationBarColor: '#00ff00',
  // The following properties are supported since API version 8.
  statusBarContentColor: '#ffffff',
  navigationBarContentColor: '#00ffff'
};
try {
  let windowClass: window.Window = window.findWindow("test");
  let promise = windowClass.setWindowSystemBarProperties(SystemBarProperties);
  promise.then(() => {
    console.info('Succeeded in setting the system bar properties.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(exception));
}

setPreferredOrientation⁹⁺

setPreferredOrientation(orientation: Orientation, callback: AsyncCallback&lt;void&gt;): void

Sets the preferred orientation for this window. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
Orientation	Orientation	Yes	Orientation to set.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';

let orientation = window.Orientation.AUTO_ROTATION;
try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.setPreferredOrientation(orientation, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set window orientation. Cause: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting window orientation.');
  });
} catch (exception) {
  console.error('Failed to set window orientation. Cause: ' + JSON.stringify(exception));
}

setPreferredOrientation⁹⁺

setPreferredOrientation(orientation: Orientation): Promise&lt;void&gt;

Sets the preferred orientation for this window. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
Orientation	Orientation	Yes	Orientation to set.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';

let orientation = window.Orientation.AUTO_ROTATION;
try {
  let windowClass: window.Window = window.findWindow("test");
  let promise = windowClass.setPreferredOrientation(orientation);
  promise.then(() => {
    console.info('Succeeded in setting the window orientation.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the window orientation. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set window orientation. Cause: ' + JSON.stringify(exception));
}

getUIContext¹⁰⁺

getUIContext(): UIContext

Obtain a UIContext instance.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
UIContext	UIContext instance obtained.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';
import { UIContext } from '@ohos.arkui.UIContext';

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    // Load content for the main window.
    windowStage.loadContent("pages/page2", (err: BusinessError) => {
      let errCode: number = err.code;
      if (errCode) {
        console.error('Failed to load the content. Cause:' + JSON.stringify(err));
        return;
      }
      console.info('Succeeded in loading the content.');
      // Obtain the main window.
      let windowClass: window.Window = window.findWindow("test");
      windowStage.getMainWindow((err: BusinessError, data) => {
        let errCode: number = err.code;
        if (errCode) {
          console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
          return;
        }
        windowClass = data;
        console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));
        // Obtain a UIContext instance.
        let uiContext: UIContext|null = null;
        uiContext = windowClass.getUIContext();
      })
    });
  }
};

setUIContent⁹⁺

setUIContent(path: string, callback: AsyncCallback&lt;void&gt;): void

Loads content from a page to this window. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——–|————————-|–|——————–| |path |string |Yes|Path of the page from which the content will be loaded.| |callback|AsyncCallback&lt;void&gt;|Yes|Callback used to return the result. |

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.setUIContent('pages/page2/page2', (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to load the content. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in loading the content.');
  });
} catch (exception) {
  console.error('Failed to load the content. Cause:' + JSON.stringify(exception));
}

setUIContent⁹⁺

setUIContent(path: string): Promise&lt;void&gt;

Loads content from a page to this window. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |—-|——|–|——————| |path|string|Yes|Path of the page from which the content will be loaded.|

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

try {
  let windowClass: window.Window = window.findWindow("test");
  let promise = windowClass.setUIContent('pages/page2/page2');
  promise.then(() => {
    console.info('Succeeded in loading the content.');
  }).catch((err: BusinessError) => {
    console.error('Failed to load the content. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to load the content. Cause: ' + JSON.stringify(exception));
}

loadContent⁹⁺

loadContent(path: string, storage: LocalStorage, callback: AsyncCallback&lt;void&gt;): void

Loads content from a page associated with a local storage to this window. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the page from which the content will be loaded.
storage	LocalStorage	Yes	A storage unit, which provides storage for variable state properties and non-variable state properties of an application.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
    let windowClass: window.Window = window.findWindow("test");
    let storage: LocalStorage = new LocalStorage();
    storage.setOrCreate('storageSimpleProp', 121);
    try {
      if (!windowClass) {
        console.info('Failed to load the content. Cause: windowClass is null');
      }
      else {
        (windowClass as window.Window).loadContent('pages/page2', storage, (err: BusinessError) => {
          const errCode: number = err.code;
          if (errCode) {
            console.error('Failed to load the content. Cause:' + JSON.stringify(err));
            return;
          }
          console.info('Succeeded in loading the content.');
        });
      }
    } catch (exception) {
      console.error('Failed to load the content. Cause:' + JSON.stringify(exception));
    }
  }
};

loadContent⁹⁺

loadContent(path: string, storage: LocalStorage): Promise&lt;void&gt;

Loads content from a page associated with a local storage to this window. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the page from which the content will be loaded.
storage	LocalStorage	Yes	A storage unit, which provides storage for variable state properties and non-variable state properties of an application.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
    let windowClass: window.Window = window.findWindow("test");
    let storage: LocalStorage = new LocalStorage();
    storage.setOrCreate('storageSimpleProp', 121);
    try {
      if (!windowClass) {
        console.info('Failed to load the content. Cause: windowClass is null');
      }
      else {
        let promise = (windowClass as window.Window).loadContent('pages/page2', storage);
        promise.then(() => {
          console.info('Succeeded in loading the content.');
        }).catch((err: BusinessError) => {
          console.error('Failed to load the content. Cause:' + JSON.stringify(err));
        });
      }
    } catch (exception) {
      console.error('Failed to load the content. Cause:' + JSON.stringify(exception));
    }
  }
};

isWindowShowing⁹⁺

isWindowShowing(): boolean

Checks whether this window is displayed.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
boolean	Whether the window is displayed. The value true means that the window is displayed, and false means the opposite.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

try {
  let windowClass: window.Window = window.findWindow("test");
  let data = windowClass.isWindowShowing();
  console.info('Succeeded in checking whether the window is showing. Data: ' + JSON.stringify(data));
} catch (exception) {
  console.error('Failed to check whether the window is showing. Cause: ' + JSON.stringify(exception));
}

on(‘windowSizeChange’)⁷⁺

on(type: ‘windowSizeChange’, callback: Callback&lt;Size&gt;): void

Subscribes to the window size change event.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘windowSizeChange’, indicating the window size change event.
callback	Callback<Size>	Yes	Callback used to return the window size.

Example

try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.on('windowSizeChange', (data) => {
    console.info('Succeeded in enabling the listener for window size changes. Data: ' + JSON.stringify(data));
  });
} catch (exception) {
  console.error('Failed to enable the listener for window size changes. Cause: ' + JSON.stringify(exception));
}

off(‘windowSizeChange’)⁷⁺

off(type: ‘windowSizeChange’, callback?: Callback&lt;Size&gt;): void

Unsubscribes from the window size change event.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘windowSizeChange’, indicating the window size change event.
callback	Callback<Size>	No	Callback used to return the window size. If a value is passed in, the corresponding subscription is canceled. If no value is passed in, all subscriptions to the specified event are canceled.

Example

try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.off('windowSizeChange');
} catch (exception) {
  console.error('Failed to disable the listener for window size changes. Cause: ' + JSON.stringify(exception));
}

on(‘avoidAreaChange’)⁹⁺

on(type: ‘avoidAreaChange’, callback: Callback&lt;{ type: AvoidAreaType, area: AvoidArea}&gt;): void

Subscribes to the event indicating changes to the area where the window cannot be displayed.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘avoidAreaChange’, indicating the event of changes to the area where the window cannot be displayed.
callback	Callback<{ type: AvoidAreaType, area: AvoidArea }>	Yes	Callback used to return the area and area type.

Example

try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.on('avoidAreaChange', (data) => {
    console.info('Succeeded in enabling the listener for system avoid area changes. type:' +
    JSON.stringify(data.type) + ', area: ' + JSON.stringify(data.area));
  });
} catch (exception) {
  console.error('Failed to enable the listener for system avoid area changes. Cause: ' + JSON.stringify(exception));
}

off(‘avoidAreaChange’)⁹⁺

off(type: ‘avoidAreaChange’, callback?: Callback&lt;{ type: AvoidAreaType, area: AvoidArea }&gt;): void

Unsubscribes from the event indicating changes to the area where the window cannot be displayed.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘avoidAreaChange’, indicating the event of changes to the area where the window cannot be displayed.
callback	Callback<{ type: AvoidAreaType, area: AvoidArea }>	No	Callback used to return the area and area type. If a value is passed in, the corresponding subscription is canceled. If no value is passed in, all subscriptions to the specified event are canceled.

Example

try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.off('avoidAreaChange');
} catch (exception) {
  console.error('Failed to disable the listener for system avoid area changes. Cause: ' + JSON.stringify(exception));
}

on(‘keyboardHeightChange’)⁷⁺

on(type: ‘keyboardHeightChange’, callback: Callback&lt;number&gt;): void

Subscribes to the event indicating soft keyboard height changes in the input method panel in fixed state. Since API version 10, the input method panel can be set to the fixed or floating state. For details, see Input Method Service.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘keyboardHeightChange’, indicating the keyboard height change event.
callback	Callback<number>	Yes	Callback used to return the current keyboard height, which is an integer.

Example

try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.on('keyboardHeightChange', (data) => {
    console.info('Succeeded in enabling the listener for keyboard height changes. Data: ' + JSON.stringify(data));
  });
} catch (exception) {
  console.error('Failed to enable the listener for keyboard height changes. Cause: ' + JSON.stringify(exception));
}

off(‘keyboardHeightChange’)⁷⁺

off(type: ‘keyboardHeightChange’, callback?: Callback&lt;number&gt;): void

Unsubscribes from the event indicating soft keyboard height changes in the input method panel in fixed state. Since API version 10, the input method panel can be set to the fixed or floating state. For details, see Input Method Service.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘keyboardHeightChange’, indicating the keyboard height change event.
callback	Callback<number>	No	Callback used to return the current keyboard height, which is an integer. If a value is passed in, the corresponding subscription is canceled. If no value is passed in, all subscriptions to the specified event are canceled.

Example

try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.off('keyboardHeightChange');
} catch (exception) {
  console.error('Failed to disable the listener for keyboard height changes. Cause: ' + JSON.stringify(exception));
}

on(‘touchOutside’)¹¹⁺

on(type: ‘touchOutside’, callback: Callback&lt;void&gt;): void

Subscribes to the click event outside this window.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘touchOutside’, indicating the click event outside this window.
callback	Callback<void>	Yes	Callback used to return the click event outside this window.

Example

try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.on('touchOutside', () => {
    console.info('touch outside');
  });
} catch (exception) {
  console.error('Failed to register callback. Cause: ' + JSON.stringify(exception));
}

off(‘touchOutside’)¹¹⁺

off(type: ‘touchOutside’, callback?: Callback&lt;void&gt;): void

Unsubscribes from the click event outside this window.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘touchOutside’, indicating the click event outside this window.
callback	Callback<void>	No	Callback used to return the click event outside this window. If a value is passed in, the corresponding subscription is canceled. If no value is passed in, all subscriptions to the specified event are canceled.

Example

try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.off('touchOutside');
} catch (exception) {
  console.error('Failed to unregister callback. Cause: ' + JSON.stringify(exception));
}

on(‘screenshot’)⁹⁺

on(type: ‘screenshot’, callback: Callback&lt;void&gt;): void

Subscribes to the screenshot event.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘screenshot’, indicating the screenshot event.
callback	Callback<void>	Yes	Callback invoked when a screenshot event occurs.

Example

try {
  let windowClass: window.Window = window.findWindow("test");
  windowClass.on('screenshot', () => {
    console.info('screenshot happened');
  });
} catch (exception) {
  console.error('Failed to register callback. Cause: ' + JSON.stringify(exception));
}

off(‘screenshot’)⁹⁺

off(type: ‘screenshot’, callback?: Callback&lt;void&gt;): void

Unsubscribes from the screenshot event.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘screenshot’, indicating the screenshot event.
callback	Callback<void>	No	Callback invoked when a screenshot event occurs. If a value is passed in, the corresponding subscription is canceled. If no value is passed in, all subscriptions to the specified event are canceled.

Example

let windowClass: window.Window = window.findWindow("test");
let callback = () => {
  console.info('screenshot happened');
};
try {
  windowClass.on('screenshot', callback);
} catch (exception) {
  console.error('Failed to register callback. Cause: ' + JSON.stringify(exception));
}
try {
  windowClass.off('screenshot', callback);
  // If multiple callbacks are enabled in on(), they will all be disabled.
  windowClass.off('screenshot');
} catch (exception) {
  console.error('Failed to unregister callback. Cause: ' + JSON.stringify(exception));
}

on(‘dialogTargetTouch’)¹⁰⁺

on(type: ‘dialogTargetTouch’, callback: Callback&lt;void&gt;): void

Subscribes to the click event of the target window in the modal window mode.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘dialogTargetTouch’, indicating the click event of the target window in the modal window mode.
callback	Callback<void>	Yes	Callback invoked when the click event occurs in the target window of the modal window mode.

Example

let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.on('dialogTargetTouch', () => {
    console.info('touch dialog target');
  });
} catch (exception) {
  console.error('Failed to register callback. Cause: ' + JSON.stringify(exception));
}

off(‘dialogTargetTouch’)¹⁰⁺

off(type: ‘dialogTargetTouch’, callback?: Callback&lt;void&gt;): void

Unsubscribes from the click event of the target window in the modal window mode.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘dialogTargetTouch’, indicating the click event of the target window in the modal window mode.
callback	Callback<void>	No	Callback invoked when the click event occurs in the target window of the modal window mode. If a value is passed in, the corresponding subscription is canceled. If no value is passed in, all subscriptions to the specified event are canceled.

Example

let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.off('dialogTargetTouch');
} catch (exception) {
  console.error('Failed to unregister callback. Cause: ' + JSON.stringify(exception));
}

on(‘windowEvent’)¹⁰⁺

on(type: ‘windowEvent’, callback: Callback&lt;WindowEventType&gt;): void

Subscribes to the window lifecycle change event.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘windowEvent’, indicating the window lifecycle change event.
callback	Callback<WindowEventType>	Yes	Callback used to return the window lifecycle state.

Example

let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.on('windowEvent', (data) => {
    console.info('Window event happened. Event:' + JSON.stringify(data));
  });
} catch (exception) {
  console.error('Failed to register callback. Cause: ' + JSON.stringify(exception));
}

off(‘windowEvent’)¹⁰⁺

off(type: ‘windowEvent’, callback?: Callback&lt;WindowEventType &gt;): void

Unsubscribes from the window lifecycle change event.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘windowEvent’, indicating the window lifecycle change event.
callback	Callback<WindowEventType>	No	Callback used to return the window lifecycle state. If a value is passed in, the corresponding subscription is canceled. If no value is passed in, all subscriptions to the specified event are canceled.

Example

let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.off('windowEvent');
} catch (exception) {
  console.error('Failed to unregister callback. Cause: ' + JSON.stringify(exception));
}

bindDialogTarget⁹⁺

bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback&lt;void&gt;, callback: AsyncCallback&lt;void&gt;): void

Binds the modal window to the target window, and adds a callback to listen for modal window destruction events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
token	rpc.RemoteObject	Yes	Token of the target window.
deathCallback	Callback<void>	Yes	Callback used to listen for modal window destruction events.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import rpc from '@ohos.rpc';
import { BusinessError } from '@ohos.base';

class MyDeathRecipient {
  onRemoteDied() {
    console.log('server died');
  }
}

class TestRemoteObject extends rpc.RemoteObject {
  constructor(descriptor: string) {
    super(descriptor);
  }

  addDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean {
    return true;
  }

  removeDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean {
    return true;
  }

  isObjectDead(): boolean {
    return false;
  }
}

let token: TestRemoteObject = new TestRemoteObject('testObject');
let windowClass: window.Window = window.findWindow("test");
let config: window.Configuration = { name: "dialogWindow", windowType: window.WindowType.TYPE_DIALOG };
try {
  window.createWindow(config, (err: BusinessError, data) => {
    let errCode: number = err.code;
    if (errCode) {
      console.error('Failed to create the window. Cause: ' + JSON.stringify(err));
      return;
    }
    windowClass = data;
  });
  windowClass.bindDialogTarget(token, () => {
    console.info('Dialog Window Need Destroy.');
  }, (err: BusinessError) => {
    let errCode: number = err.code;
    if (errCode) {
      console.error('Failed to bind dialog target. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in binding dialog target.');
  });
} catch (exception) {
  console.error('Failed to bind dialog target. Cause:' + JSON.stringify(exception));
}

bindDialogTarget⁹⁺

bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback&lt;void&gt;): Promise&lt;void&gt;

Binds the modal window to the target window, and adds a callback to listen for modal window destruction events. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
token	rpc.RemoteObject	Yes	Token of the target window.
deathCallback	Callback<void>	Yes	Callback used to listen for modal window destruction events.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import rpc from '@ohos.rpc';
import { BusinessError } from '@ohos.base';

class MyDeathRecipient {
  onRemoteDied() {
    console.log('server died');
  }
}

class TestRemoteObject extends rpc.RemoteObject {
  constructor(descriptor: string) {
    super(descriptor);
  }

  addDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean {
    return true;
  }

  removeDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean {
    return true;
  }

  isObjectDead(): boolean {
    return false;
  }
}

let token: TestRemoteObject = new TestRemoteObject('testObject');
let windowClass: window.Window = window.findWindow("test");
let config: window.Configuration = {
  name: "dialogWindow",
  windowType: window.WindowType.TYPE_DIALOG
};
try {
  window.createWindow(config, (err: BusinessError, data) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to create the window. Cause: ' + JSON.stringify(err));
      return;
    }
    windowClass = data;
  });
  let promise = windowClass.bindDialogTarget(token, () => {
    console.info('Dialog Window Need Destroy.');
  });
  promise.then(() => {
    console.info('Succeeded in binding dialog target.');
  }).catch((err: BusinessError) => {
    console.error('Failed to bind dialog target. Cause:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to bind dialog target. Cause:' + JSON.stringify(exception));
}

bindDialogTarget⁹⁺

bindDialogTarget(requestInfo: dialogRequest.RequestInfo, deathCallback: Callback&lt;void&gt;, callback: AsyncCallback&lt;void&gt;): void

Binds the modal window to the target window, and adds a callback to listen for modal window destruction events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
requestInfo	dialogRequest.RequestInfo	Yes	RequestInfo of the target window.
deathCallback	Callback<void>	Yes	Callback used to listen for modal window destruction events.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import ServiceExtensionAbility from '@ohos.app.ability.ServiceExtensionAbility';
import dialogRequest from '@ohos.app.ability.dialogRequest';
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';

export default class ServiceExtAbility extends ServiceExtensionAbility {
  onRequest(want: Want, startId: number) {
    console.info('onRequest');
    let windowClass: window.Window = window.findWindow("test");
    let config: window.Configuration = {
      name: "dialogWindow", windowType: window.WindowType.TYPE_DIALOG
    };
    try {
      window.createWindow(config, (err: BusinessError, data) => {
        let errCode: number = err.code;
        if (errCode) {
          console.error('Failed to create the window. Cause: ' + JSON.stringify(err));
          return;
        }
        windowClass = data;
      });
      let requestInfo = dialogRequest.getRequestInfo(want)
      windowClass.bindDialogTarget(requestInfo, () => {
        console.info('Dialog Window Need Destroy.');
      }, (err: BusinessError) => {
        let errCode: number = err.code;
        if (errCode) {
          console.error('Failed to bind dialog target. Cause:' + JSON.stringify(err));
          return;
        }
        console.info('Succeeded in binding dialog target.');
      });
    } catch (err) {
      console.error('Failed to bind dialog target. Cause:' + JSON.stringify(err))
    }
  }
}

bindDialogTarget⁹⁺

bindDialogTarget(requestInfo: dialogRequest.RequestInfo, deathCallback: Callback&lt;void&gt;): Promise&lt;void&gt;

Binds the modal window to the target window, and adds a callback to listen for modal window destruction events. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
requestInfo	dialogRequest.RequestInfo	Yes	RequestInfo of the target window.
deathCallback	Callback<void>	Yes	Callback used to listen for modal window destruction events.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import ServiceExtensionAbility from '@ohos.app.ability.ServiceExtensionAbility';
import dialogRequest from '@ohos.app.ability.dialogRequest';
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';

export default class ServiceExtAbility extends ServiceExtensionAbility {
  onRequest(want: Want, startId: number) {
    console.info('onRequest');
    let windowClass: window.Window = window.findWindow("test");
    let config: window.Configuration = {
      name: "dialogWindow", windowType: window.WindowType.TYPE_DIALOG
    };
    try {
      window.createWindow(config, (err: BusinessError, data) => {
        const errCode: number = err.code;
        if (errCode) {
          console.error('Failed to create the window. Cause: ' + JSON.stringify(err));
          return;
        }
        windowClass = data;
      });
      let requestInfo = dialogRequest.getRequestInfo(want)
      let promise = windowClass.bindDialogTarget(requestInfo, () => {
        console.info('Dialog Window Need Destroy.');
      });
      promise.then(() => {
        console.info('Succeeded in binding dialog target.');
      }).catch((err: BusinessError) => {
        console.error('Failed to bind dialog target. Cause:' + JSON.stringify(err));
      });
    } catch (err) {
      console.error('Failed to bind dialog target. Cause:' + JSON.stringify(err))
    }
  }
}

isWindowSupportWideGamut⁹⁺

isWindowSupportWideGamut(callback: AsyncCallback&lt;boolean&gt;): void

Checks whether this window supports the wide-gamut color space. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |——–|—————————-|–|——————————————————————————–| |callback|AsyncCallback&lt;boolean&gt;|Yes|Callback used to return the result. The value true means that the wide-gamut color space is supported, and false means the opposite.|

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.isWindowSupportWideGamut((err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to check whether the window support WideGamut. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in checking whether the window support WideGamut Data: ' + JSON.stringify(data));
});

isWindowSupportWideGamut⁹⁺

isWindowSupportWideGamut(): Promise&lt;boolean&gt;

Checks whether this window supports the wide-gamut color space. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that the wide-gamut color space is supported, and false means the opposite.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.isWindowSupportWideGamut();
promise.then((data) => {
  console.info('Succeeded in checking whether the window support WideGamut. Data: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to check whether the window support WideGamut. Cause: ' + JSON.stringify(err));
});

setWindowColorSpace⁹⁺

setWindowColorSpace(colorSpace:ColorSpace, callback: AsyncCallback&lt;void&gt;): void

Sets a color space for this window. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |———-|————————-|–|———–| |colorSpace|ColorSpace|Yes|Color space to set.| |callback |AsyncCallback&lt;void&gt;|Yes|Callback used to return the result.|

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setWindowColorSpace(window.ColorSpace.WIDE_GAMUT, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set window colorspace. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting window colorspace.');
  });
} catch (exception) {
  console.error('Failed to set window colorspace. Cause:' + JSON.stringify(exception));
}

setWindowColorSpace⁹⁺

setWindowColorSpace(colorSpace:ColorSpace): Promise&lt;void&gt;

Sets a color space for this window. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |———-|————————-|–|————-| |colorSpace|ColorSpace|Yes|Color space to set.|

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
try {
  let promise = windowClass.setWindowColorSpace(window.ColorSpace.WIDE_GAMUT);
  promise.then(() => {
    console.info('Succeeded in setting window colorspace.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set window colorspace. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set window colorspace. Cause:' + JSON.stringify(exception));
}

getWindowColorSpace⁹⁺

getWindowColorSpace(): ColorSpace

Obtains the color space of this window.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
ColorSpace	Color space obtained.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

let colorSpace = windowClass.getWindowColorSpace();

setWindowBackgroundColor⁹⁺

setWindowBackgroundColor(color: string): void

Sets the background color for this window. In the stage model, this API must be used after the call of loadContent or setUIContent() takes effect.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |—–|——|–|———————————————————————–| |color|string|Yes|Background color to set. The value is a hexadecimal RGB or ARGB color code and is case insensitive, for example, #00FF00 or #FF00FF00.|

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

let color: string = '#00ff33';
let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setWindowBackgroundColor(color);
} catch (exception) {
  console.error('Failed to set the background color. Cause: ' + JSON.stringify(exception));
}

setWindowBrightness⁹⁺

setWindowBrightness(brightness: number, callback: AsyncCallback&lt;void&gt;): void

Sets the screen brightness for this window. This API uses an asynchronous callback to return the result.

When the screen brightness setting for the window takes effect, Control Panel cannot adjust the system screen brightness. It can do so only after the window screen brightness is restored to the default value.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description | |———-|————————-|–|——————————————-| |brightness|number |Yes|Brightness to set. The value is a floating point number in the range [0.0, 1.0] or -1.0. The value 1.0 means the brightest, and -1.0 means the default brightness.| |callback |AsyncCallback&lt;void&gt;|Yes|Callback used to return the result. |

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let brightness: number = 1;
let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setWindowBrightness(brightness, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the brightness.');
  });
} catch (exception) {
  console.error('Failed to set the brightness. Cause: ' + JSON.stringify(exception));
}

setWindowBrightness⁹⁺

setWindowBrightness(brightness: number): Promise&lt;void&gt;

Sets the screen brightness for this window. This API uses a promise to return the result.

When the screen brightness setting for the window takes effect, Control Panel cannot adjust the system screen brightness. It can do so only after the window screen brightness is restored to the default value.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description | |———-|——|–|—————————————-| |brightness|number|Yes|Brightness to set. The value is a floating point number in the range [0.0, 1.0] or -1.0. The value 1.0 means the brightest, and -1.0 means the default brightness.|

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let brightness: number = 1;
try {
  let promise = windowClass.setWindowBrightness(brightness);
  promise.then(() => {
    console.info('Succeeded in setting the brightness.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the brightness. Cause: ' + JSON.stringify(exception));
}

setWindowFocusable⁹⁺

setWindowFocusable(isFocusable: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether this window can gain focus. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |———–|————————-|–|——————————————————-| |isFocusable|boolean |Yes|Whether the window can gain focus. The value true means that the window can gain focus, and false means the opposite.| |callback |AsyncCallback&lt;void&gt;|Yes|Callback used to return the result. |

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let isFocusable: boolean = true;
let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setWindowFocusable(isFocusable, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the window to be focusable. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the window to be focusable.');
  });
} catch (exception) {
  console.error('Failed to set the window to be focusable. Cause:' + JSON.stringify(exception));
}

setWindowFocusable⁹⁺

setWindowFocusable(isFocusable: boolean): Promise&lt;void&gt;

Sets whether this window can gain focus. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |———–|——-|–|——————————————————–| |isFocusable|boolean|Yes|Whether the window can gain focus. The value true means that the window can gain focus, and false means the opposite.|

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let isFocusable: boolean = true;
let windowClass: window.Window = window.findWindow("test");
try {
  let promise = windowClass.setWindowFocusable(isFocusable);
  promise.then(() => {
    console.info('Succeeded in setting the window to be focusable.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the window to be focusable. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the window to be focusable. Cause:' + JSON.stringify(exception));
}

setWindowKeepScreenOn⁹⁺

setWindowKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether to keep the screen always on. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |————–|————————-|–|—————————————————-| |isKeepScreenOn|boolean |Yes|Whether to keep the screen always on. The value true means to keep the screen always on, and false means the opposite.| |callback |AsyncCallback&lt;void&gt;|Yes|Callback used to return the result. |

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let isKeepScreenOn: boolean = true;
let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setWindowKeepScreenOn(isKeepScreenOn, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the screen to be always on.');
  });
} catch (exception) {
  console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(exception));
}

setWindowKeepScreenOn⁹⁺

setWindowKeepScreenOn(isKeepScreenOn: boolean): Promise&lt;void&gt;

Sets whether to keep the screen always on. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |————–|——-|–|—————————————————| |isKeepScreenOn|boolean|Yes|Whether to keep the screen always on. The value true means to keep the screen always on, and false means the opposite.|

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let isKeepScreenOn: boolean = true;
let windowClass: window.Window = window.findWindow("test");
try {
  let promise = windowClass.setWindowKeepScreenOn(isKeepScreenOn);
  promise.then(() => {
    console.info('Succeeded in setting the screen to be always on.');
  }).catch((err: BusinessError) => {
    console.info('Failed to set the screen to be always on. Cause:  ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(exception));
}

setWakeUpScreen()⁹⁺

setWakeUpScreen(wakeUp: boolean): void

Wakes up the screen.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
wakeUp	boolean	Yes	Whether to wake up the screen. The value true means to wake up the screen, and false means the opposite.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

let wakeUp: boolean = true;
let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setWakeUpScreen(wakeUp);
} catch (exception) {
  console.error('Failed to wake up the screen. Cause: ' + JSON.stringify(exception));
}

setWindowPrivacyMode⁹⁺

setWindowPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether this window is in privacy mode. This API uses an asynchronous callback to return the result.

A window in privacy mode cannot be captured or recorded. This API can be used in scenarios where screen capture or recording is disabled.

System capability: SystemCapability.WindowManager.WindowManager.Core

Required permissions: ohos.permission.PRIVACY_WINDOW

Parameters

|Name|Type|Mandatory|Description| |————-|————————-|–|——————————————————| |isPrivacyMode|boolean |Yes|Whether the window is in privacy mode. The value true means that the window is in privacy mode, and false means the opposite.| |callback |AsyncCallback&lt;void&gt;|Yes|Callback used to return the result. |

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';

let isPrivacyMode: boolean = true;
let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setWindowPrivacyMode(isPrivacyMode, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the window to privacy mode. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the window to privacy mode.');
  });
} catch (exception) {
  console.error('Failed to set the window to privacy mode. Cause:' + JSON.stringify(exception));
}

setWindowPrivacyMode⁹⁺

setWindowPrivacyMode(isPrivacyMode: boolean): Promise&lt;void&gt;

Sets whether this window is in privacy mode. This API uses a promise to return the result.

A window in privacy mode cannot be captured or recorded. This API can be used in scenarios where screen capture or recording is disabled.

System capability: SystemCapability.WindowManager.WindowManager.Core

Required permissions: ohos.permission.PRIVACY_WINDOW

Parameters

|Name|Type|Mandatory|Description| |————-|——-|–|—————————————————–| |isPrivacyMode|boolean|Yes|Whether the window is in privacy mode. The value true means that the window is in privacy mode, and false means the opposite.|

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';

let isPrivacyMode: boolean = true;
let windowClass: window.Window = window.findWindow("test");
try {
  let promise = windowClass.setWindowPrivacyMode(isPrivacyMode);
  promise.then(() => {
    console.info('Succeeded in setting the window to privacy mode.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the window to privacy mode. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the window to privacy mode. Cause:' + JSON.stringify(exception));
}

setSnapshotSkip⁹⁺

setSnapshotSkip(isSkip: boolean): void

Sets whether to ignore this window during screen capturing or recording. This API is generally used in scenarios where screen capture or recording is disabled.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isSkip	boolean	Yes	Whether to ignore the window. The default value is false. The value true means that the window is ignored, and false means the opposite.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

let windowClass: window.Window = window.findWindow("test");
let isSkip: boolean = true;
try {
  windowClass.setSnapshotSkip(isSkip);
} catch (exception) {
  console.error('Failed to Skip. Cause: ' + JSON.stringify(exception));
}

setWindowTouchable⁹⁺

setWindowTouchable(isTouchable: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether this window is touchable. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |———–|————————-|–|———————————————–| |isTouchable|boolean |Yes|Whether the window is touchable. The value true means that the window is touchable, and false means the opposite.| |callback |AsyncCallback&lt;void&gt;|Yes|Callback used to return the result. |

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let isTouchable = true;
let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setWindowTouchable(isTouchable, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the window to be touchable. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the window to be touchable.');
  });
} catch (exception) {
  console.error('Failed to set the window to be touchable. Cause:' + JSON.stringify(exception));
}

setWindowTouchable⁹⁺

setWindowTouchable(isTouchable: boolean): Promise&lt;void&gt;

Sets whether this window is touchable. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

|Name|Type|Mandatory|Description| |———–|——-|–|———————————————–| |isTouchable|boolean|Yes|Whether the window is touchable. The value true means that the window is touchable, and false means the opposite.|

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let isTouchable: boolean = true;
let windowClass: window.Window = window.findWindow("test");
try {
  let promise = windowClass.setWindowTouchable(isTouchable);
  promise.then(() => {
    console.info('Succeeded in setting the window to be touchable.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the window to be touchable. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the window to be touchable. Cause:' + JSON.stringify(exception));
}

setForbidSplitMove⁹⁺

setForbidSplitMove(isForbidSplitMove: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether this window is forbidden to move in split-screen mode. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isForbidSplitMove	boolean	Yes	Whether the window is forbidden to move in split-screen mode. The value true means the window is forbidden to move in split-screen mode, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let isForbidSplitMove: boolean = true;
let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setForbidSplitMove(isForbidSplitMove, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to forbid window moving in split screen mode. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in forbidding window moving in split screen mode.');
  });
} catch (exception) {
  console.error('Failed to forbid window moving in split screen mode. Cause:' + JSON.stringify(exception));
}

setForbidSplitMove⁹⁺

setForbidSplitMove(isForbidSplitMove: boolean): Promise&lt;void&gt;

Sets whether this window is forbidden to move in split-screen mode. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isForbidSplitMove	boolean	Yes	Whether the window is forbidden to move in split-screen mode. The value true means the window is forbidden to move in split-screen mode, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@ohos.base';

let isForbidSplitMove: boolean = true;
let windowClass: window.Window = window.findWindow("test");
try {
  let promise = windowClass.setForbidSplitMove(isForbidSplitMove);
  promise.then(() => {
    console.info('Succeeded in forbidding window moving in split screen mode.');
  }).catch((err: BusinessError) => {
    console.error('Failed to forbid window moving in split screen mode. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to forbid window moving in split screen mode. Cause:' + JSON.stringify(exception));
}

snapshot⁹⁺

snapshot(callback: AsyncCallback&lt;image.PixelMap&gt;): void

Captures this window. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<image.PixelMap>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';
import image from '@ohos.multimedia.image';

let windowClass: window.Window = window.findWindow("test");
windowClass.snapshot((err: BusinessError, pixelMap: image.PixelMap) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to snapshot window. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in snapshotting window. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
  pixelMap.release(); // Release the memory in time after the PixelMap is used.
});

snapshot⁹⁺

snapshot(): Promise&lt;image.PixelMap&gt;

Captures this window. This API uses a promise to return the result.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<image.PixelMap>	Promise used to return the window screenshot.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.

Example

import { BusinessError } from '@ohos.base';
import image from '@ohos.multimedia.image';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.snapshot();
promise.then((pixelMap: image.PixelMap) => {
  console.info('Succeeded in snapshotting window. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
  pixelMap.release(); // Release the memory in time after the PixelMap is used.
}).catch((err: BusinessError) => {
  console.error('Failed to snapshot window. Cause:' + JSON.stringify(err));
});

opacity⁹⁺

opacity(opacity: number): void

Sets the opacity for this window. This API can be used only when you customize an animation to be played during the display or hiding of a system window.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
opacity	number	Yes	Opacity. The value is a floating point number in the range [0.0, 1.0]. The value 0.0 means completely transparent, and 1.0 means completely opaque.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.opacity(0.5);
} catch (exception) {
  console.error('Failed to opacity. Cause: ' + JSON.stringify(exception));
}

scale⁹⁺

scale(scaleOptions: ScaleOptions): void

Sets the scale parameters for this window. This API can be used only when you customize an animation to be played during the display or hiding of a system window.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
scaleOptions	ScaleOptions	Yes	Scale parameters to set.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

let windowClass: window.Window = window.findWindow("test");
let obj: window.ScaleOptions = {
  x: 2.0,
  y: 1.0,
  pivotX: 0.5,
  pivotY: 0.5
};
try {
  windowClass.scale(obj);
} catch (exception) {
  console.error('Failed to scale. Cause: ' + JSON.stringify(exception));
}

rotate⁹⁺

rotate(rotateOptions: RotateOptions): void

Sets the rotation parameters for this window. This API can be used only when you customize an animation to be played during the display or hiding of a system window.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
rotateOptions	RotateOptions	Yes	Rotation parameters to set.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

let windowClass: window.Window = window.findWindow("test");
let obj: window.RotateOptions = {
  x: 1.0,
  y: 1.0,
  z: 45.0,
  pivotX: 0.5,
  pivotY: 0.5
};
try {
  windowClass.rotate(obj);
} catch (exception) {
  console.error('Failed to rotate. Cause: ' + JSON.stringify(exception));
}

translate⁹⁺

translate(translateOptions: TranslateOptions): void

Sets the translation parameters for this window. This API can be used only when you customize an animation to be played during the display or hiding of a system window.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
translateOptions	TranslateOptions	Yes	Translation parameters. The unit is pixels.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

let windowClass: window.Window = window.findWindow("test");
let obj: window.TranslateOptions = {
  x: 100.0,
  y: 0.0,
  z: 0.0
};
try {
  windowClass.translate(obj);
} catch (exception) {
  console.error('Failed to translate. Cause: ' + JSON.stringify(exception));
}

getTransitionController⁹⁺

getTransitionController(): TransitionController

Obtains the transition animation controller.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
TransitionController	Transition animation controller.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
(context: window.TransitionContext) => {
  let toWindow = context.toWindow;
  animateTo({
    duration: 1000, // Animation duration.
    tempo: 0.5, // Playback speed.
    curve: Curve.EaseInOut, // Animation curve.
    delay: 0, // Animation delay.
    iterations: 1, // Number of playback times.
    playMode: PlayMode.Normal // Animation playback mode.
    onFinish: () => {
      context.completeTransition(true)
    }
  }, () => {
    let obj: window.TranslateOptions = {
      x: 100.0,
      y: 0.0,
      z: 0.0
    };
    toWindow.translate(obj); // Set the transition animation.
    console.info('toWindow translate end');
  }
  );
  console.info('complete transition end');
};
windowClass.hideWithAnimation((err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to show the window with animation. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in showing the window with animation. Data: ' + JSON.stringify(data));
});

setBlur⁹⁺

setBlur(radius: number): void

Blurs this window.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
radius	number	Yes	Radius of the blur. The value is a floating point number greater than or equal to 0.0, and the value 0.0 means that the blur is disabled for the window.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setBlur(4.0);
} catch (exception) {
  console.error('Failed to set blur. Cause: ' + JSON.stringify(exception));
}

setBackdropBlur⁹⁺

setBackdropBlur(radius: number): void

Blurs the background of this window.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
radius	number	Yes	Radius of the blur. The value is a floating point number greater than or equal to 0.0, and the value 0.0 means that the blur is disabled for the background of the window.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setBackdropBlur(4.0);
} catch (exception) {
  console.error('Failed to set backdrop blur. Cause: ' + JSON.stringify(exception));
}

setBackdropBlurStyle⁹⁺

setBackdropBlurStyle(blurStyle: BlurStyle): void

Sets the blur style for the background of this window.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
blurStyle	BlurStyle	Yes	Blur style to set for the background of the window.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setBackdropBlurStyle(window.BlurStyle.THIN);
} catch (exception) {
  console.error('Failed to set backdrop blur style. Cause: ' + JSON.stringify(exception));
}

setShadow⁹⁺

setShadow(radius: number, color?: string, offsetX?: number, offsetY?: number): void

Sets the shadow for the window borders.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
radius	number	Yes	Radius of the shadow. The value is a floating point number greater than or equal to 0.0, and the value 0.0 means that the shadow is disabled for the window borders.
color	string	No	Color of the shadow. The value is a hexadecimal RGB or ARGB color code and is case insensitive, for example, #00FF00 or #FF00FF00.
offsetX	number	No	Offset of the shadow along the x-axis, in pixels. The value is a floating point number.
offsetY	number	No	Offset of the shadow along the y-axis, in pixels. The value is a floating point number.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setShadow(4.0, '#FF00FF00', 2, 3);
} catch (exception) {
  console.error('Failed to set shadow. Cause: ' + JSON.stringify(exception));
}

setCornerRadius⁹⁺

setCornerRadius(cornerRadius: number): void

Sets the radius of the rounded corners for this window.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
radius	number	Yes	Radius of the rounded corners. The value is a floating point number greater than or equal to 0.0. The value 0.0 means that the window does not use rounded corners.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

let windowClass: window.Window = window.findWindow("test");
try {
  windowClass.setCornerRadius(4.0);
} catch (exception) {
  console.error('Failed to set corner radius. Cause: ' + JSON.stringify(exception));
}

raiseToAppTop¹⁰⁺

raiseToAppTop(callback: AsyncCallback&lt;void&gt;): void

Raises the application subwindow to the top layer of the application. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.
1300009	The parent window is invalid.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.raiseToAppTop((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to raise the window to app top. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in raising the window to app top.');
});

raiseToAppTop¹⁰⁺

raiseToAppTop(): Promise&lt;void&gt;

Raises the application subwindow to the top layer of the application. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.
1300009	The parent window is invalid.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.raiseToAppTop();
promise.then(() => {
  console.info('Succeeded in raising the window to app top.');
}).catch((err: BusinessError) => {
  console.error('Failed to raise the window to app top. Cause: ' + JSON.stringify(err));
});

setAspectRatio¹⁰⁺

setAspectRatio(ratio: number): Promise&lt;void&gt;

Sets the aspect ratio of the window content layout. This API uses a promise to return the result.

This API is available only for the main window of the application. The aspect ratio will be saved permanently and takes effect even after the application is closed or the device is restarted.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
ratio	number	Yes	Aspect ratio of the window content layout except border decoration. The value is a floating point number greater than or equal to 0.0.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
try {
  let ratio = 1.0;
  let promise = windowClass.setAspectRatio(ratio);
  promise.then(() => {
    console.info('Succeeded in setting aspect ratio of window.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the aspect ratio of window. Cause:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the aspect ratio of window. Cause: ' + JSON.stringify(exception));
}

setAspectRatio¹⁰⁺

setAspectRatio(ratio: number, callback: AsyncCallback&lt;void&gt;): void

Sets the aspect ratio of the window content layout. This API uses an asynchronous callback to return the result.

This API is available only for the main window of the application. The aspect ratio will be saved permanently and takes effect even after the application is closed or the device is restarted.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
ratio	number	Yes	Aspect ratio of the window content layout except border decoration. The value is a floating point number greater than or equal to 0.0.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
try {
  let ratio = 1.0;
  windowClass.setAspectRatio(ratio, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the aspect ratio of window. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the aspect ratio of window.');
  });
} catch (exception) {
  console.error('Failed to set the aspect ratio of window. Cause: ' + JSON.stringify(exception));
}

resetAspectRatio¹⁰⁺

resetAspectRatio(): Promise&lt;void&gt;

Resets the aspect ratio of the window content layout. This API uses a promise to return the result.

This API is available only for the main window of the application. After this API is called, the persistently stored aspect ratio is cleared.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
try {
  let promise = windowClass.resetAspectRatio();
  promise.then(() => {
    console.info('Succeeded in resetting aspect ratio of window.');
  }).catch((err: BusinessError) => {
    console.error('Failed to reset the aspect ratio of window. Cause:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to reset the aspect ratio of window. Cause: ' + JSON.stringify(exception));
}

resetAspectRatio¹⁰⁺

resetAspectRatio(callback: AsyncCallback&lt;void&gt;): void

Resets the aspect ratio of the window content layout. This API uses an asynchronous callback to return the result.

This API is available only for the main window of the application. After this API is called, the persistently stored aspect ratio is cleared.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
try {
    windowClass.resetAspectRatio((err: BusinessError) => {
        const errCode: number = err.code;
        if (errCode) {
            console.error('Failed to reset the aspect ratio of window. Cause:' + JSON.stringify(err));
            return;
        }
        console.info('Succeeded in resetting aspect ratio of window.');
    });
} catch (exception) {
    console.error('Failed to reset the aspect ratio of window. Cause: ' + JSON.stringify(exception));
}

setWaterMarkFlag¹⁰⁺

setWaterMarkFlag(enable: boolean): Promise&lt;void&gt;

Adds or deletes the watermark flag for this window. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to add or delete the watermark flag to the window. The value true means to add the watermark flag and false means to delete the watermark flag.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300008	The operation is on invalid display.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
try {
  let enable = true;
  let promise = windowClass.setWaterMarkFlag(enable);
  promise.then(() => {
    console.info('Succeeded in setting water mark flag of window.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set water mark flag of window. Cause:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set water mark flag of window. Cause: ' + JSON.stringify(exception));
}

setWaterMarkFlag¹⁰⁺

setWaterMarkFlag(enable: boolean, callback: AsyncCallback&lt;void&gt;): void

Adds or deletes the watermark flag for this window. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to add or delete the watermark flag to the window. The value true means to add the watermark flag and false means to delete the watermark flag.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300008	The operation is on invalid display.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
try {
  let enable: boolean = true;
  windowClass.setWaterMarkFlag(enable, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set water mark flag of window. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting water mark flag of window.');
  });
} catch (exception) {
  console.error('Failed to set water mark flag of window. Cause: ' + JSON.stringify(exception));
}

raiseAboveTarget¹⁰⁺

raiseAboveTarget(windowId: number, callback: AsyncCallback&lt;void&gt;): void

Raises a subwindow above a target subwindow. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
windowId	number	Yes	ID of the target subwindow, which is the value of properties.id in properties obtained through getWindowProperties.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.
1300009	The parent window is invalid.

Example

// Raise windowClass above targetWindow.
let properties = targetWindow.getWindowProperties();
let targetId = properties.id;
let windowClass: window.Window = window.findWindow("test");
windowClass.raiseAboveTarget(targetId, (err) => {
    if (err.code) {
        console.error('Failed to raise the subWindow to target subWindow top. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Succeeded in raising the subWindow to target subWindow top.');
});

raiseAboveTarget¹⁰⁺

raiseAboveTarget(windowId: number): Promise&lt;void&gt;

Raises a subwindow above a target subwindow. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
windowId	number	Yes	ID of the target subwindow, which is the value of properties.id in properties obtained through getWindowProperties.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.
1300009	The parent window is invalid.

Example

// Raise windowClass above targetWindow.
let properties = targetWindow.getWindowProperties();
let targetId = properties.id;
let promise = windowClass.raiseAboveTarget(targetId);
promise.then(()=> {
    console.info('Succeeded in raising the subWindow to target subWindow top.');
}).catch((err)=>{
    console.error('Failed to raise the subWindow to target subWindow top. Cause: ' + JSON.stringify(err));
});

setRaiseByClickEnabled¹⁰⁺

setRaiseByClickEnabled(enable: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether to enable a subwindow to raise itself by click. This API uses an asynchronous callback to return the result.

Generally, when a user clicks a subwindow, the subwindow is displayed on the top. If the enable parameter is set to false, the subwindow is not displayed on the top when being clicked.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to enable a subwindow to raise itself by click. The value true means to enable the subwindow to raise itself by click, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.
1300009	The parent window is invalid.

Example

let enabled = false;
let windowClass: window.Window = window.findWindow("test");
windowClass.setRaiseByClickEnabled(enabled, (err) => {
    if (err.code) {
        console.error('Failed to disable the raise-by-click function. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Succeeded in disabling the raise-by-click function.');
});

setRaiseByClickEnabled¹⁰⁺

setRaiseByClickEnabled(enable: boolean): Promise&lt;void&gt;

Sets whether to enable a subwindow to raise itself by click. This API uses a promise to return the result.

Generally, when a user clicks a subwindow, the subwindow is displayed on the top. If the enable parameter is set to false, the subwindow is not displayed on the top when being clicked.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to enable a subwindow to raise itself by click. The value true means to enable the subwindow to raise itself by click, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.
1300009	The parent window is invalid.

Example

let enabled = false;
let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.setRaiseByClickEnabled(enabled);
promise.then(()=> {
    console.info('Succeeded in disabling the raise-by-click function.');
}).catch((err)=>{
    console.error('Failed to disable the raise-by-click function. Cause: ' + JSON.stringify(err));
});

minimize¹⁰⁺

minimize(callback: AsyncCallback&lt;void&gt;): void

Minimizes the main window. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import UIAbility from '@ohos.app.ability.UIAbility';

export default class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage) {
        // Load content for the main window.
        windowStage.loadContent("pages/page2", (err) => {
            if (err.code) {
                console.error('Failed to load the content. Cause:' + JSON.stringify(err));
                return;
            }
            console.info('Succeeded in loading the content.');
        });
        // Obtain the main window.
        let mainWindow = null;
        
        windowStage.getMainWindow((err, data) => {
            if (err.code) {
                console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
                return;
            }
            mainWindow = data;
            console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));
            // Call minimize.
            mainWindow.minimize((err) => {
                if (err.code) {
                    console.error('Failed to minimize the app main window. Cause: ' + JSON.stringify(err));
                    return;
                }
                console.info('Successfully minimized app main window.');
            });
        })
    }
};

minimize¹⁰⁺

minimize(): Promise&lt;void&gt;

Minimizes the main window. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import UIAbility from '@ohos.app.ability.UIAbility';

export default class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage) {
        // Load content for the main window.
        windowStage.loadContent("pages/page2", (err) => {
            if (err.code) {
                console.error('Failed to load the content. Cause:' + JSON.stringify(err));
                return;
            }
            console.info('Succeeded in loading the content.');
        });
        // Obtain the main window.
        let mainWindow = null;
        
        windowStage.getMainWindow((err, data) => {
            if (err.code) {
                console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
                return;
            }
            mainWindow = data;
            console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));
            // Promise object of the minimize API.
            let promise = mainWindow.minimize();
            promise.then(()=> {
                console.info('Successfully minimized app main window.');
            }).catch((err)=>{
                console.error('Failed to minimize the app main window. Cause: ' + JSON.stringify(err));
            });
        })
    }
};

setResizeByDragEnabled¹⁰⁺

setResizeByDragEnabled(enable: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether to enable the main window to resize itself by dragging. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to enable the main window to resize itself by dragging. The value true means to enable the main window to resize itself by dragging, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

import UIAbility from '@ohos.app.ability.UIAbility';

export default class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage) {
        // Load content for the main window.
        windowStage.loadContent("pages/page2", (err) => {
            if (err.code) {
                console.error('Failed to load the content. Cause:' + JSON.stringify(err));
                return;
            }
            console.info('Succeeded in loading the content.');
        });
        // Obtain the main window.
        let mainWindow = null;
        
        windowStage.getMainWindow((err, data) => {
            if (err.code) {
                console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
                return;
            }
            mainWindow = data;
            console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));

            let enabled = false;
            // Call setResizeByDragEnabled.
            mainWindow.setResizeByDragEnabled(enabled, (err) => {
                if (err.code) {
                    console.error('Failed to set the function of disabling the resize by dragg window. Cause: ' + JSON.stringify(err));
                    return;
                }
                console.info('Succeeded in setting the function of disabling the resize by dragg window.');
            });
        })
    }
};

setResizeByDragEnabled¹⁰⁺

setResizeByDragEnabled(enable: boolean): Promise&lt;void&gt;

Sets whether to enable the main window to resize itself by dragging. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to enable the main window to resize itself by dragging. The value true means to enable the main window to resize itself by dragging, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import UIAbility from '@ohos.app.ability.UIAbility';

export default class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage) {
        // Load content for the main window.
        windowStage.loadContent("pages/page2", (err) => {
            if (err.code) {
                console.error('Failed to load the content. Cause:' + JSON.stringify(err));
                return;
            }
            console.info('Succeeded in loading the content.');
        });
        // Obtain the main window.
        let mainWindow = null;
        
        windowStage.getMainWindow((err, data) => {
            if (err.code) {
                console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
                return;
            }
            mainWindow = data;
            console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));

            let enabled = false;
            // Promise object of the setResizeByDragEnabled API.
            let promise = mainWindow.setResizeByDragEnabled(enabled);
            promise.then(()=> {
                console.info('Succeeded in setting the function of disabling the resize by dragg window.');
            }).catch((err)=>{
                console.error('Failed to set the function of disabling the resize by dragg window. Cause: ' + JSON.stringify(err));
            });
        })
    }
};

hideNonSystemFloatingWindows¹¹⁺

hideNonSystemFloatingWindows(shouldHide: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether to hide non-system floating windows. This API uses an asynchronous callback to return the result.

A non-system floating window is a floating window created by a non-system application. By default, the main window of a system application can be displayed together with a non-system floating window. This means that the main window may be blocked by an upper-layer non-system floating window. If the shouldHide parameter is set to true, all non-system floating windows are hidden, so that the main window will never be blocked by a non-system floating window.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
shouldHide	boolean	Yes	Whether to hide non-system floating windows. The value true means to hide the floating windows, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    // Load the page corresponding to the main window.
    windowStage.loadContent('pages/Index', (err) => {
      if (err.code) {
        console.error('Failed to load the content. Cause:' + JSON.stringify(err));
        return;
      }
      console.info('Succeeded in loading the content.');
    });

    // Obtain the main window.
    let mainWindow = null;
    windowStage.getMainWindow((err, data) => {
      if (err.code) {
        console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
        return;
      }
      mainWindow = data;
      console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));

      let shouldHide = true;
      // Call hideNonSystemFloatingWindows with the callback parameter.
      mainWindow.hideNonSystemFloatingWindows(shouldHide, (err) => {
        if (err.code) {
          console.error('Failed to hide the non-system floating windows. Cause: ' + JSON.stringify(err));
          return;
        }
        console.info('Succeeded in hiding the non-system floating windows.');
      });
    })
  }
}

hideNonSystemFloatingWindows¹¹⁺

hideNonSystemFloatingWindows(shouldHide: boolean): Promise&lt;void&gt;

Sets whether to hide non-system floating windows. This API uses an asynchronous callback to return the result.

A non-system floating window is a floating window created by a non-system application. By default, the main window of a system application can be displayed together with a non-system floating window. This means that the main window may be blocked by an upper-layer non-system floating window. If the shouldHide parameter is set to true, all non-system floating windows are hidden, so that the main window will never be blocked by a non-system floating window.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
shouldHide	boolean	Yes	Whether to hide non-system floating windows. The value true means to hide the floating windows, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    // Load the page corresponding to the main window.
    windowStage.loadContent('pages/Index', (err) => {
      if (err.code) {
        console.error('Failed to load the content. Cause:' + JSON.stringify(err));
        return;
      }
      console.info('Succeeded in loading the content.');
    });

    // Obtain the main window.
    let mainWindow = null;
    windowStage.getMainWindow((err, data) => {
      if (err.code) {
        console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
        return;
      }
      mainWindow = data;
      console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));

      let shouldHide = true;
      // Call hideNonSystemFloatingWindows to obtain a promise object.
      let promise = mainWindow.hideNonSystemFloatingWindows(shouldHide);
      promise.then(()=> {
        console.info('Succeeded in hiding the non-system floating windows.');
      }).catch((err)=>{
        console.error('Failed to hide the non-system floating windows. Cause: ' + JSON.stringify(err));
      });
    })
  }
}

show^(deprecated)

show(callback: AsyncCallback&lt;void&gt;): void

Shows this window. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use showWindow() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.show((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in showing the window.');
});

show^(deprecated)

show(): Promise&lt;void&gt;

Shows this window. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use showWindow() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.show();
promise.then(() => {
  console.info('Succeeded in showing the window.');
}).catch((err: BusinessError) => {
  console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
});

destroy^(deprecated)

destroy(callback: AsyncCallback&lt;void&gt;): void

Destroys this window. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use destroyWindow() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.destroy((err: BusinessError) => {
  const errCode: number = err.code;
  if (err.code) {
    console.error('Failed to destroy the window. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in destroying the window.');
});

destroy^(deprecated)

destroy(): Promise&lt;void&gt;

Destroys this window. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use destroyWindow() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.destroy();
promise.then(() => {
  console.info('Succeeded in destroying the window.');
}).catch((err: BusinessError) => {
  console.error('Failed to destroy the window. Cause: ' + JSON.stringify(err));
});

moveTo^(deprecated)

moveTo(x: number, y: number, callback: AsyncCallback&lt;void&gt;): void

Moves this window. This API uses an asynchronous callback to return the result.

This operation is not supported in a window in full-screen mode.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use moveWindowTo() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
x	number	Yes	Distance that the window moves along the x-axis, in px. A positive value indicates that the window moves to the right. The value must be an integer.
y	number	Yes	Distance that the window moves along the y-axis, in px. A positive value indicates that the window moves downwards. The value must be an integer.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.moveTo(300, 300, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to move the window. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in moving the window.');
});

moveTo^(deprecated)

moveTo(x: number, y: number): Promise&lt;void&gt;

Moves this window. This API uses a promise to return the result.

This operation is not supported in a window in full-screen mode.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use moveWindowTo() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
x	number	Yes	Distance that the window moves along the x-axis, in px. A positive value indicates that the window moves to the right. The value must be an integer.
y	number	Yes	Distance that the window moves along the y-axis, in px. A positive value indicates that the window moves downwards. The value must be an integer.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.moveTo(300, 300);
promise.then(() => {
  console.info('Succeeded in moving the window.');
}).catch((err: BusinessError) => {
  console.error('Failed to move the window. Cause: ' + JSON.stringify(err));
});

resetSize^(deprecated)

resetSize(width: number, height: number, callback: AsyncCallback&lt;void&gt;): void

Changes the size of this window. This API uses an asynchronous callback to return the result.

The main window and subwindow have the following size limits: [320, 2560] in width and [240, 2560] in height, both in units of vp.

The system window has the following size limits: [0, 2560] in width and [0, 2560] in height, both in units of vp.

The new width and height you set must meet the limits.

This operation is not supported in a window in full-screen mode.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use resize() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
width	number	Yes	New width of the window, in px. The value must be an integer.
height	number	Yes	New height of the window, in px. The value must be an integer.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.resetSize(500, 1000, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to change the window size. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in changing the window size.');
});

resetSize^(deprecated)

resetSize(width: number, height: number): Promise&lt;void&gt;

Changes the size of this window. This API uses a promise to return the result.

The main window and subwindow have the following size limits: [320, 2560] in width and [240, 2560] in height, both in units of vp.

The system window has the following size limits: [0, 2560] in width and [0, 2560] in height, both in units of vp.

The new width and height you set must meet the limits.

This operation is not supported in a window in full-screen mode.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use resize() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
width	number	Yes	New width of the window, in px. The value must be an integer.
height	number	Yes	New height of the window, in px. The value must be an integer.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.resetSize(500, 1000);
promise.then(() => {
  console.info('Succeeded in changing the window size.');
}).catch((err: BusinessError) => {
  console.error('Failed to change the window size. Cause: ' + JSON.stringify(err));
});

setWindowType^(deprecated)

setWindowType(type: WindowType, callback: AsyncCallback&lt;void&gt;): void

Sets the type of this window. This API uses an asynchronous callback to return the result.

System API: This is a system API.

NOTE

This API is supported since API version 7 and deprecated since API version 9.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	WindowType	Yes	Window type.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let type = window.WindowType.TYPE_APP;
windowClass.setWindowType(type, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to set the window type. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in setting the window type.');
});

setWindowType^(deprecated)

setWindowType(type: WindowType): Promise&lt;void&gt;

Sets the type of this window. This API uses a promise to return the result.

System API: This is a system API.

NOTE

This API is supported since API version 7 and deprecated since API version 9.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	WindowType	Yes	Window type.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let type = window.WindowType.TYPE_APP;
let promise = windowClass.setWindowType(type);
promise.then(() => {
  console.info('Succeeded in setting the window type.');
}).catch((err: BusinessError) => {
  console.error('Failed to set the window type. Cause: ' + JSON.stringify(err));
});

getProperties^(deprecated)

getProperties(callback: AsyncCallback&lt;WindowProperties&gt;): void

Obtains the properties of this window. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use getWindowProperties() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<WindowProperties>	Yes	Callback used to return the window properties.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.getProperties((err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in obtaining the window properties. Data: ' + JSON.stringify(data));
});

getProperties^(deprecated)

getProperties(): Promise&lt;WindowProperties&gt;

Obtains the properties of this window. This API uses a promise to return the result.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use getWindowProperties() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<WindowProperties>	Promise used to return the window properties.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.getProperties();
promise.then((data) => {
  console.info('Succeeded in obtaining the window properties. Data: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err));
});

getAvoidArea^(deprecated)

getAvoidArea(type: AvoidAreaType, callback: AsyncCallback&lt;AvoidArea&gt;): void

Obtains the area where this window cannot be displayed, for example, the system bar area, notch, gesture area, and soft keyboard area. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getWindowAvoidArea() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	AvoidAreaType	Yes	Type of the area.
callback	AsyncCallback<AvoidArea>	Yes	Callback used to return the area.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let type = window.AvoidAreaType.TYPE_SYSTEM;
windowClass.getAvoidArea(type, (err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to obtain the area. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in obtaining the area. Data:' + JSON.stringify(data));
});

getAvoidArea^(deprecated)

getAvoidArea(type: AvoidAreaType): Promise&lt;AvoidArea&gt;

Obtains the area where this window cannot be displayed, for example, the system bar area, notch, gesture area, and soft keyboard area. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getWindowAvoidArea() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	AvoidAreaType	Yes	Type of the area.

Return value

Type	Description
Promise<AvoidArea>	Promise used to return the area.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let type = window.AvoidAreaType.TYPE_SYSTEM;
let promise = windowClass.getAvoidArea(type);
promise.then((data) => {
  console.info('Succeeded in obtaining the area. Data:' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to obtain the area. Cause:' + JSON.stringify(err));
});

setFullScreen^(deprecated)

setFullScreen(isFullScreen: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether the window is in full-screen mode. This API uses an asynchronous callback to return the result.

In full-screen mode, the window is displayed in full screen, and the status bar and navigation bar are not displayed.

In non-full-screen mode, the status bar and navigation bar are displayed, and the window size does not overlap the positions of the status bar and navigation bar.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use setWindowSystemBarEnable() and setWindowLayoutFullScreen() to implement the full-screen mode.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isFullScreen	boolean	Yes	Whether to set full-screen mode. This setting affects the display of the status bar and navigation bar. The value true means to set full-screen mode, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let isFullScreen: boolean = true;
windowClass.setFullScreen(isFullScreen, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to enable the full-screen mode. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in enabling the full-screen mode.');
});

setFullScreen^(deprecated)

setFullScreen(isFullScreen: boolean): Promise&lt;void&gt;

Sets whether the window is in full-screen mode. This API uses a promise to return the result.

In full-screen mode, the window is displayed in full screen, and the status bar and navigation bar are not displayed.

In non-full-screen mode, the status bar and navigation bar are displayed, and the window size does not overlap the positions of the status bar and navigation bar.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use setWindowSystemBarEnable() and setWindowLayoutFullScreen() to implement the full-screen mode.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isFullScreen	boolean	Yes	Whether to set full-screen mode. This setting affects the display of the status bar and navigation bar. The value true means to set full-screen mode, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let isFullScreen: boolean = true;
let promise = windowClass.setFullScreen(isFullScreen);
promise.then(() => {
  console.info('Succeeded in enabling the full-screen mode.');
}).catch((err: BusinessError) => {
  console.error('Failed to enable the full-screen mode. Cause: ' + JSON.stringify(err));
});

setLayoutFullScreen^(deprecated)

setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether the window layout is immersive. This API uses an asynchronous callback to return the result.

An immersive layout means that the layout does not avoid the status bar and navigation bar, and components may overlap with them.

A non-immersive layout means that the layout avoids the status bar and navigation bar, and components do not overlap with them.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use setWindowLayoutFullScreen() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isLayoutFullScreen	boolean	Yes	Whether the window layout is immersive. This setting does not affect the display of the status bar and navigation bar. The value true means that the window layout is immersive, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let isLayoutFullScreen: boolean = true;
windowClass.setLayoutFullScreen(isLayoutFullScreen, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in setting the window layout to full-screen mode.');
});

setLayoutFullScreen^(deprecated)

setLayoutFullScreen(isLayoutFullScreen: boolean): Promise&lt;void&gt;

Sets whether the window layout is immersive. This API uses a promise to return the result.

An immersive layout means that the layout does not avoid the status bar and navigation bar, and components may overlap with them.

A non-immersive layout means that the layout avoids the status bar and navigation bar, and components do not overlap with them.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use setWindowLayoutFullScreen() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isLayoutFullScreen	boolean	Yes	Whether the window layout is immersive. This setting does not affect the display of the status bar and navigation bar. The value true means that the window layout is immersive, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let isLayoutFullScreen: boolean = true;
let promise = windowClass.setLayoutFullScreen(isLayoutFullScreen);
promise.then(() => {
  console.info('Succeeded in setting the window layout to full-screen mode.');
}).catch((err: BusinessError) => {
  console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
});

setSystemBarEnable^(deprecated)

setSystemBarEnable(names: Array<‘status’|‘navigation’>, callback: AsyncCallback&lt;void&gt;): void

Sets whether to display the status bar and navigation bar when the window is in full-screen mode. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use setWindowSystemBarEnable() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
names	Array<‘status’|‘navigation’>	Yes	Whether to display the status bar and navigation bar when the window is in full-screen mode. For example, to display the status bar and navigation bar, set this parameter to [‘status’, ‘navigation’]. By default, they are not displayed.
callback	AsyncCallback&lt;void&gt;	Yes	Callback used to return the result.

Example

// In this example, the status bar and navigation bar are not displayed.
import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let names: Array<'status'|'navigation'> = [];
windowClass.setSystemBarEnable(names, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to set the system bar to be invisible. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in setting the system bar to be invisible.');
});

setSystemBarEnable^(deprecated)

setSystemBarEnable(names: Array<‘status’|‘navigation’>): Promise&lt;void&gt;

Sets whether to display the status bar and navigation bar when the window is in full-screen mode. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use setWindowSystemBarEnable() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
names	Array<‘status’|‘navigation’>	Yes	Whether to display the status bar and navigation bar when the window is in full-screen mode. For example, to display the status bar and navigation bar, set this parameter to [‘status’, ‘navigation’]. By default, they are not displayed.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

// In this example, the status bar and navigation bar are not displayed.
import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let names: Array<'status'|'navigation'> = [];
let promise = windowClass.setSystemBarEnable(names);
promise.then(() => {
  console.info('Succeeded in setting the system bar to be invisible.');
}).catch((err: BusinessError) => {
  console.error('Failed to set the system bar to be invisible. Cause:' + JSON.stringify(err));
});

setSystemBarProperties^(deprecated)

setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback&lt;void&gt;): void

Sets the properties of the status bar and navigation bar when the window is in full-screen mode. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use setWindowSystemBarProperties() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
SystemBarProperties	SystemBarProperties	Yes	Properties of the status bar and navigation bar.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let SystemBarProperties: window.SystemBarProperties = {
  statusBarColor: '#ff00ff',
  navigationBarColor: '#00ff00',
  // The following properties are supported since API version 8.
  statusBarContentColor: '#ffffff',
  navigationBarContentColor: '#00ffff'
};
let windowClass: window.Window = window.findWindow("test");
windowClass.setSystemBarProperties(SystemBarProperties, (err) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in setting the system bar properties.');
});

setSystemBarProperties^(deprecated)

setSystemBarProperties(systemBarProperties: SystemBarProperties): Promise&lt;void&gt;

Sets the properties of the status bar and navigation bar when the window is in full-screen mode. This API uses a promise to return the result.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use setWindowSystemBarProperties() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
SystemBarProperties	SystemBarProperties	Yes	Properties of the status bar and navigation bar.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let SystemBarProperties: window.SystemBarProperties = {
  statusBarColor: '#ff00ff',
  navigationBarColor: '#00ff00',
  // The following properties are supported since API version 8.
  statusBarContentColor: '#ffffff',
  navigationBarContentColor: '#00ffff'
};
let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.setSystemBarProperties(SystemBarProperties);
promise.then(() => {
  console.info('Succeeded in setting the system bar properties.');
}).catch((err: BusinessError) => {
  console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
});

loadContent^(deprecated)

loadContent(path: string, callback: AsyncCallback&lt;void&gt;): void

Loads content from a page to this window. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use setUIContent() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the page from which the content will be loaded.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.loadContent('pages/page2/page2', (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to load the content. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in loading the content.');
});

loadContent^(deprecated)

loadContent(path: string): Promise&lt;void&gt;

Loads content from a page to this window. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use setUIContent() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the page from which the content will be loaded.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.loadContent('pages/page2/page2');
promise.then(() => {
  console.info('Succeeded in loading the content.');
}).catch((err: BusinessError) => {
  console.error('Failed to load the content. Cause: ' + JSON.stringify(err));
});

isShowing^(deprecated)

isShowing(callback: AsyncCallback&lt;boolean&gt;): void

Checks whether this window is displayed. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use isWindowShowing() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true means that the window is displayed, and false means the opposite.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.isShowing((err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to check whether the window is showing. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in checking whether the window is showing. Data: ' + JSON.stringify(data));
});

isShowing^(deprecated)

isShowing(): Promise&lt;boolean&gt;

Checks whether this window is displayed. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use isWindowShowing() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that the window is displayed, and false means the opposite.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.isShowing();
promise.then((data) => {
  console.info('Succeeded in checking whether the window is showing. Data: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to check whether the window is showing. Cause: ' + JSON.stringify(err));
});

on(‘systemAvoidAreaChange’)^(deprecated)

on(type: ‘systemAvoidAreaChange’, callback: Callback&lt;AvoidArea&gt;): void

Subscribes to the event indicating changes to the area where the window cannot be displayed.

NOTE

This API is supported since API version 7 and deprecated since API version 9. Use on(‘avoidAreaChange’) instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘systemAvoidAreaChange’, indicating the event of changes to the area where the window cannot be displayed.
callback	Callback<AvoidArea>	Yes	Callback used to return the area.

Example

let windowClass: window.Window = window.findWindow("test");
windowClass.on('systemAvoidAreaChange', (data) => {
  console.info('Succeeded in enabling the listener for system avoid area changes. Data: ' + JSON.stringify(data));
});

off(‘systemAvoidAreaChange’)^(deprecated)

off(type: ‘systemAvoidAreaChange’, callback?: Callback&lt;AvoidArea&gt;): void

Unsubscribes from the event indicating changes to the area where the window cannot be displayed.

NOTE

This API is supported since API version 7 and deprecated since API version 9. Use off(‘avoidAreaChange’) instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘systemAvoidAreaChange’, indicating the event of changes to the area where the window cannot be displayed.
callback	Callback<AvoidArea>	No	Callback used to return the area. If a value is passed in, the corresponding subscription is canceled. If no value is passed in, all subscriptions to the specified event are canceled.

Example

let windowClass: window.Window = window.findWindow("test");
windowClass.off('systemAvoidAreaChange');

isSupportWideGamut^(deprecated)

isSupportWideGamut(callback: AsyncCallback&lt;boolean&gt;): void

Checks whether this window supports the wide-gamut color space. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use isWindowSupportWideGamut() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true means that the wide-gamut color space is supported, and false means the opposite.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.isSupportWideGamut((err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to check whether the window support WideGamut. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in checking whether the window support WideGamut Data: ' + JSON.stringify(data));
});

isSupportWideGamut^(deprecated)

isSupportWideGamut(): Promise&lt;boolean&gt;

Checks whether this window supports the wide-gamut color space. This API uses a promise to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use isWindowSupportWideGamut() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that the wide-gamut color space is supported, and false means the opposite.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.isSupportWideGamut();
promise.then((data) => {
  console.info('Succeeded in checking whether the window support WideGamut. Data: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to check whether the window support WideGamut. Cause: ' + JSON.stringify(err));
});

setColorSpace^(deprecated)

setColorSpace(colorSpace:ColorSpace, callback: AsyncCallback&lt;void&gt;): void

Sets a color space for this window. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use setWindowColorSpace() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
colorSpace	ColorSpace	Yes	Color space to set.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.setColorSpace(window.ColorSpace.WIDE_GAMUT, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to set window colorspace. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in setting window colorspace.');
});

setColorSpace^(deprecated)

setColorSpace(colorSpace:ColorSpace): Promise&lt;void&gt;

Sets a color space for this window. This API uses a promise to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use setWindowColorSpace() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
colorSpace	ColorSpace	Yes	Color space to set.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.setColorSpace(window.ColorSpace.WIDE_GAMUT);
promise.then(() => {
  console.info('Succeeded in setting window colorspace.');
}).catch((err: BusinessError) => {
  console.error('Failed to set window colorspace. Cause: ' + JSON.stringify(err));
});

getColorSpace^(deprecated)

getColorSpace(callback: AsyncCallback&lt;ColorSpace&gt;): void

Obtains the color space of this window. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getWindowColorSpace() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<ColorSpace>	Yes	Callback used to return the result. When the color space is obtained successfully, err is undefined, and data is the current color space.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.getColorSpace((err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to get window colorspace. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in getting window colorspace. Cause:' + JSON.stringify(data));
});

getColorSpace^(deprecated)

getColorSpace(): Promise&lt;ColorSpace&gt;

Obtains the color space of this window. This API uses a promise to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getWindowColorSpace() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<ColorSpace>	Promise used to return the current color space.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.getColorSpace();
promise.then((data) => {
  console.info('Succeeded in getting window color space. Cause:' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to get window colorspace. Cause: ' + JSON.stringify(err));
});

setBackgroundColor^(deprecated)

setBackgroundColor(color: string, callback: AsyncCallback&lt;void&gt;): void

Sets the background color for this window. This API uses an asynchronous callback to return the result. In the stage model, this API must be used after the call of loadContent or setUIContent() takes effect.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use setWindowBackgroundColor() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
color	string	Yes	Background color to set. The value is a hexadecimal RGB or ARGB color code and is case insensitive, for example, #00FF00 or #FF00FF00.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let color: string = '#00ff33';
windowClass.setBackgroundColor(color, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to set the background color. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in setting the background color.');
});

setBackgroundColor^(deprecated)

setBackgroundColor(color: string): Promise&lt;void&gt;

Sets the background color for this window. This API uses a promise to return the result. In the stage model, this API must be used after the call of loadContent or setUIContent() takes effect.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use setWindowBackgroundColor() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
color	string	Yes	Background color to set. The value is a hexadecimal RGB or ARGB color code and is case insensitive, for example, #00FF00 or #FF00FF00.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let color: string = '#00ff33';
let promise = windowClass.setBackgroundColor(color);
promise.then(() => {
  console.info('Succeeded in setting the background color.');
}).catch((err: BusinessError) => {
  console.error('Failed to set the background color. Cause: ' + JSON.stringify(err));
});

setBrightness^(deprecated)

setBrightness(brightness: number, callback: AsyncCallback&lt;void&gt;): void

Sets the screen brightness for this window. This API uses an asynchronous callback to return the result.

When the screen brightness setting for the window takes effect, Control Panel cannot adjust the system screen brightness. It can do so only after the window screen brightness is restored to the default value.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use setWindowBrightness() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
brightness	number	Yes	Brightness to set. The value is a floating point number in the range [0.0, 1.0] or -1.0. The value 1.0 means the brightest, and -1.0 means the default brightness.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let brightness: number = 1;
windowClass.setBrightness(brightness, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in setting the brightness.');
});

setBrightness^(deprecated)

setBrightness(brightness: number): Promise&lt;void&gt;

Sets the screen brightness for this window. This API uses a promise to return the result.

When the screen brightness setting for the window takes effect, Control Panel cannot adjust the system screen brightness. It can do so only after the window screen brightness is restored to the default value.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use setWindowBrightness() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
brightness	number	Yes	Brightness to set. The value is a floating point number in the range [0.0, 1.0] or -1.0. The value 1.0 means the brightest, and -1.0 means the default brightness.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let brightness: number = 1;
let promise = windowClass.setBrightness(brightness);
promise.then(() => {
  console.info('Succeeded in setting the brightness.');
}).catch((err: BusinessError) => {
  console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err));
});

setDimBehind^(deprecated)

setDimBehind(dimBehindValue: number, callback: AsyncCallback&lt;void&gt;): void

Sets the dimness of the window that is not on top. This API uses an asynchronous callback to return the result.

NOTE

This API cannot be used. This API is supported since API version 7 and deprecated since API version 9.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
dimBehindValue	number	Yes	Dimness of the window to set. The value range is [0.0, 1.0], and the value 1.0 means the dimmest.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
windowClass.setDimBehind(0.5, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to set the dimness. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in setting the dimness.');
});

setDimBehind^(deprecated)

setDimBehind(dimBehindValue: number): Promise&lt;void&gt;

Sets the dimness of the window that is not on top. This API uses a promise to return the result.

NOTE

This API cannot be used. This API is supported since API version 7 and deprecated since API version 9.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
dimBehindValue	number	Yes	Dimness of the window to set. The value ranges from 0 to 1. The value 1 indicates the dimmest.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.setDimBehind(0.5);
promise.then(() => {
  console.info('Succeeded in setting the dimness.');
}).catch((err: BusinessError) => {
  console.error('Failed to set the dimness. Cause: ' + JSON.stringify(err));
});

setFocusable^(deprecated)

setFocusable(isFocusable: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether this window can gain focus. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use setWindowFocusable() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isFocusable	boolean	Yes	Whether the window can gain focus. The value true means that the window can gain focus, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let isFocusable: boolean = true;
windowClass.setFocusable(isFocusable, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to set the window to be focusable. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in setting the window to be focusable.');
});

setFocusable^(deprecated)

setFocusable(isFocusable: boolean): Promise&lt;void&gt;

Sets whether this window can gain focus. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use setWindowFocusable() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isFocusable	boolean	Yes	Whether the window can gain focus. The value true means that the window can gain focus, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let isFocusable: boolean = true;
let promise = windowClass.setFocusable(isFocusable);
promise.then(() => {
  console.info('Succeeded in setting the window to be focusable.');
}).catch((err: BusinessError) => {
  console.error('Failed to set the window to be focusable. Cause: ' + JSON.stringify(err));
});

setKeepScreenOn^(deprecated)

setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether to keep the screen always on. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use setWindowKeepScreenOn() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isKeepScreenOn	boolean	Yes	Whether to keep the screen always on. The value true means to keep the screen always on, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let isKeepScreenOn: boolean = true;
windowClass.setKeepScreenOn(isKeepScreenOn, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in setting the screen to be always on.');
});

setKeepScreenOn^(deprecated)

setKeepScreenOn(isKeepScreenOn: boolean): Promise&lt;void&gt;

Sets whether to keep the screen always on. This API uses a promise to return the result.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use setWindowKeepScreenOn() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isKeepScreenOn	boolean	Yes	Whether to keep the screen always on. The value true means to keep the screen always on, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let isKeepScreenOn: boolean = true;
let promise = windowClass.setKeepScreenOn(isKeepScreenOn);
promise.then(() => {
  console.info('Succeeded in setting the screen to be always on.');
}).catch((err: BusinessError) => {
  console.info('Failed to set the screen to be always on. Cause:  ' + JSON.stringify(err));
});

setOutsideTouchable^(deprecated)

setOutsideTouchable(touchable: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether the area outside the subwindow is touchable. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9.

Since API version 9, the area outside the subwindow is touchable by default. This API is no longer supported and no substitute API is provided.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
touchable	boolean	Yes	Whether the area outside the subwindow is touchable. The value true means the area outside the subwindow is touchable, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

if (!windowClass) {
  console.info('Failed to load the content. Cause: windowClass is null');
}
else {
  (windowClass as window.Window).setOutsideTouchable(true, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the area to be touchable. Cause: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the area to be touchable.');
  });
}

setOutsideTouchable^(deprecated)

setOutsideTouchable(touchable: boolean): Promise&lt;void&gt;

Sets whether the area outside the subwindow is touchable. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9.

Since API version 9, the area outside the subwindow is touchable by default. This API is no longer supported and no substitute API is provided.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
touchable	boolean	Yes	Whether the area outside the subwindow is touchable. The value true means the area outside the subwindow is touchable, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

if (!windowClass) {
  console.info('Failed to load the content. Cause: windowClass is null');
}
else {
let promise = (windowClass as window.Window).setOutsideTouchable(true);
promise.then(() => {
  console.info('Succeeded in setting the area to be touchable.');
}).catch((err: BusinessError) => {
  console.error('Failed to set the area to be touchable. Cause: ' + JSON.stringify(err));
});
}

setPrivacyMode^(deprecated)

setPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether this window is in privacy mode. This API uses an asynchronous callback to return the result.

A window in privacy mode cannot be captured or recorded. This API can be used in scenarios where screen capture or recording is disabled.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use setWindowPrivacyMode() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isPrivacyMode	boolean	Yes	Whether the window is in privacy mode. The value true means that the window is in privacy mode, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let isPrivacyMode: boolean = true;
windowClass.setPrivacyMode(isPrivacyMode, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to set the window to privacy mode. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in setting the window to privacy mode.');
});

setPrivacyMode^(deprecated)

setPrivacyMode(isPrivacyMode: boolean): Promise&lt;void&gt;

Sets whether this window is in privacy mode. This API uses a promise to return the result.

A window in privacy mode cannot be captured or recorded. This API can be used in scenarios where screen capture or recording is disabled.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use setWindowPrivacyMode() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isPrivacyMode	boolean	Yes	Whether the window is in privacy mode. The value true means that the window is in privacy mode, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let windowClass: window.Window = window.findWindow("test");
let isPrivacyMode: boolean = true;
let promise = windowClass.setPrivacyMode(isPrivacyMode);
promise.then(() => {
  console.info('Succeeded in setting the window to privacy mode.');
}).catch((err: BusinessError) => {
  console.error('Failed to set the window to privacy mode. Cause: ' + JSON.stringify(err));
});

setTouchable^(deprecated)

setTouchable(isTouchable: boolean, callback: AsyncCallback&lt;void&gt;): void

Sets whether this window is touchable. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use setWindowTouchable() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isTouchable	boolean	Yes	Whether the window is touchable. The value true means that the window is touchable, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import { BusinessError } from '@ohos.base';

let isTouchable = true;
if (!windowClass) {
  console.info('Failed to load the content. Cause: windowClass is null');
}
else {
  (windowClass as window.Window).setTouchable(isTouchable, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the window to be touchable. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the window to be touchable.');
  });
}

setTouchable^(deprecated)

setTouchable(isTouchable: boolean): Promise&lt;void&gt;

Sets whether this window is touchable. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use setWindowTouchable() instead.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isTouchable	boolean	Yes	Whether the window is touchable. The value true means that the window is touchable, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@ohos.base';

let isTouchable = true;
let windowClass: window.Window = window.findWindow("test");
let promise = windowClass.setTouchable(isTouchable);
promise.then(() => {
  console.info('Succeeded in setting the window to be touchable.');
}).catch((err: BusinessError) => {
  console.error('Failed to set the window to be touchable. Cause: ' + JSON.stringify(err));
});

WindowStageEventType⁹⁺

Describes the lifecycle of a window stage.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Value	Description
SHOWN	1	The window stage is running in the foreground.
ACTIVE	2	The window stage gains focus.
INACTIVE	3	The window stage loses focus.
HIDDEN	4	The window stage is running in the background.
RESUMED11+	5	The window stage is interactive in the foreground. If the user opens the Recents screen when an application is running in the foreground, the application becomes non-interactive. When the user switches back to the application, the application becomes interactive.
PAUSED11+	6	The window stage is non-interactive in the foreground. If the user opens the Recents screen when an application is running in the foreground, the application becomes non-interactive. When the user switches back to the application, the application becomes interactive.

WindowStage⁹⁺

Implements a window manager, which manages each basic window unit, that is, Window instance.

Before calling any of the following APIs, you must use onWindowStageCreate() to create a WindowStage instance.

getMainWindow⁹⁺

getMainWindow(callback: AsyncCallback&lt;Window&gt;): void

Obtains the main window of this window stage. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Window>	Yes	Callback used to return the main window.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
    let windowClass: window.Window = window.findWindow("test");
    windowStage.getMainWindow((err: BusinessError, data) => {
      const errCode: number = err.code;
      if (errCode) {
        console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
        return;
      }
      windowClass = data;
      console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));
    });
  }
};

getMainWindow⁹⁺

getMainWindow(): Promise&lt;Window&gt;

Obtains the main window of this window stage. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<Window>	Promise used to return the main window.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
    let windowClass: window.Window = window.findWindow("test");
    let promise = windowStage.getMainWindow();
    promise.then((data) => {
      windowClass = data;
      console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));
    }).catch((err: BusinessError) => {
      console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
    });
  }
};

getMainWindowSync⁹⁺

getMainWindowSync(): Window

Obtains the main window of this window stage.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Window	return the main window.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
    try {
      let windowClass = windowStage.getMainWindowSync();
    } catch (exception) {
      console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(exception));
    }
  }
};

createSubWindow⁹⁺

createSubWindow(name: string, callback: AsyncCallback&lt;Window&gt;): void

Creates a subwindow for this window stage. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Name of the subwindow.
callback	AsyncCallback<Window>	Yes	Callback used to return the subwindow.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
    let windowClass: window.Window = window.findWindow("test");
    try {
      windowStage.createSubWindow('mySubWindow', (err: BusinessError, data) => {
        const errCode: number = err.code;
        if (errCode) {
          console.error('Failed to create the subwindow. Cause: ' + JSON.stringify(err));
          return;
        }
        windowClass = data;
        console.info('Succeeded in creating the subwindow. Data: ' + JSON.stringify(data));
        if (!windowClass) {
          console.info('Failed to load the content. Cause: windowClass is null');
        }
        else {
          (windowClass as window.Window).resetSize(500, 1000);
        }
      });

    } catch (exception) {
      console.error('Failed to create the subwindow. Cause: ' + JSON.stringify(exception));
    }
  }
};

createSubWindow⁹⁺

createSubWindow(name: string): Promise&lt;Window&gt;

Creates a subwindow for this window stage. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Name of the subwindow.

Return value

Type	Description
Promise<Window>	Promise used to return the subwindow.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
    let windowClass: window.Window = window.findWindow("test");
    try {
      let promise = windowStage.createSubWindow('mySubWindow');
      promise.then((data) => {
        windowClass = data;
        console.info('Succeeded in creating the subwindow. Data: ' + JSON.stringify(data));
      }).catch((err: BusinessError) => {
        console.error('Failed to create the subwindow. Cause: ' + JSON.stringify(err));
      });
    } catch (exception) {
      console.error('Failed to create the subwindow. Cause: ' + JSON.stringify(exception));
    }
  }
};

getSubWindow⁹⁺

getSubWindow(callback: AsyncCallback&lt;Array&lt;Window&gt;&gt;): void

Obtains all the subwindows of this window stage. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Array<Window>>	Yes	Callback used to return all the subwindows.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
    let windowClass: window.Window[] = [];
    windowStage.getSubWindow((err: BusinessError, data) => {
      const errCode: number = err.code;
      if (errCode) {
        console.error('Failed to obtain the subwindow. Cause: ' + JSON.stringify(err));
        return;
      }
      windowClass = data;
      console.info('Succeeded in obtaining the subwindow. Data: ' + JSON.stringify(data));
    });
  }
};

getSubWindow⁹⁺

getSubWindow(): Promise&lt;Array&lt;Window&gt;&gt;

Obtains all the subwindows of this window stage. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<Array<Window>>	Promise used to return all the subwindows.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
    let windowClass: window.Window[] = [];
    let promise = windowStage.getSubWindow();
    promise.then((data) => {
      windowClass = data;
      console.info('Succeeded in obtaining the subwindow. Data: ' + JSON.stringify(data));
    }).catch((err: BusinessError) => {
      console.error('Failed to obtain the subwindow. Cause: ' + JSON.stringify(err));
    })
  }
};

loadContent⁹⁺

loadContent(path: string, storage: LocalStorage, callback: AsyncCallback&lt;void&gt;): void

Loads content from a page associated with a local storage to the main window in this window stage. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the page from which the content will be loaded.
storage	LocalStorage	Yes	A storage unit, which provides storage for variable state properties and non-variable state properties of an application.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...

  storage: LocalStorage = new LocalStorage();

  onWindowStageCreate(windowStage: window.WindowStage) {
    this.storage.setOrCreate('storageSimpleProp', 121);
    console.log('onWindowStageCreate');
    try {
      windowStage.loadContent('pages/page2', this.storage, (err: BusinessError) => {
        const errCode: number = err.code;
        if (errCode) {
          console.error('Failed to load the content. Cause:' + JSON.stringify(err));
          return;
        }
        console.info('Succeeded in loading the content.');
      });
    } catch (exception) {
      console.error('Failed to load the content. Cause:' + JSON.stringify(exception));
    }
  }
};

loadContent⁹⁺

loadContent(path: string, storage?: LocalStorage): Promise&lt;void&gt;

Loads content from a page associated with a local storage to the main window in this window stage. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the page from which the content will be loaded.
storage	LocalStorage	No	A storage unit, which provides storage for variable state properties and non-variable state properties of an application.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...

  storage: LocalStorage = new LocalStorage();

  onWindowStageCreate(windowStage: window.WindowStage) {
    this.storage.setOrCreate('storageSimpleProp', 121);
    console.log('onWindowStageCreate');
    try {
      let promise = windowStage.loadContent('pages/page2', this.storage);
      promise.then(() => {
        console.info('Succeeded in loading the content.');
      }).catch((err: BusinessError) => {
        console.error('Failed to load the content. Cause:' + JSON.stringify(err));
      });
    } catch (exception) {
      console.error('Failed to load the content. Cause:' + JSON.stringify(exception));
    }
    ;
  }
};

loadContent⁹⁺

loadContent(path: string, callback: AsyncCallback&lt;void&gt;): void

Loads content from a page to this window stage. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the page from which the content will be loaded.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
    try {
      windowStage.loadContent('pages/page2', (err: BusinessError) => {
        const errCode: number = err.code;
        if (errCode) {
          console.error('Failed to load the content. Cause:' + JSON.stringify(err));
          return;
        }
        console.info('Succeeded in loading the content.');
      });
    } catch (exception) {
      console.error('Failed to load the content. Cause:' + JSON.stringify(exception));
    }
  }
};

on(‘windowStageEvent’)⁹⁺

on(eventType: ‘windowStageEvent’, callback: Callback&lt;WindowStageEventType&gt;): void

Subscribes to the window stage lifecycle change event.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘windowStageEvent’, indicating the window stage lifecycle change event.
callback	Callback<WindowStageEventType>	Yes	Callback used to return the window stage lifecycle state.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
    try {
      windowStage.on('windowStageEvent', (data) => {
        console.info('Succeeded in enabling the listener for window stage event changes. Data: ' +
        JSON.stringify(data));
      });
    } catch (exception) {
      console.error('Failed to enable the listener for window stage event changes. Cause:' +
      JSON.stringify(exception));
    }
  }
};

off(‘windowStageEvent’)⁹⁺

off(eventType: ‘windowStageEvent’, callback?: Callback&lt;WindowStageEventType&gt;): void

Unsubscribes from the window stage lifecycle change event.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed at ‘windowStageEvent’, indicating the window stage lifecycle change event.
callback	Callback<WindowStageEventType>	No	Callback used to return the window stage lifecycle state. If a value is passed in, the corresponding subscription is canceled. If no value is passed in, all subscriptions to the specified event are canceled.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
    try {
      windowStage.off('windowStageEvent');
    } catch (exception) {
      console.error('Failed to disable the listener for window stage event changes. Cause:' +
      JSON.stringify(exception));
    }
  }
};

disableWindowDecor()⁹⁺

disableWindowDecor(): void

Disables window decorators.

Model restriction: This API can be used only in the stage model.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('disableWindowDecor');
    windowStage.disableWindowDecor();
  }
};

setShowOnLockScreen()⁹⁺

setShowOnLockScreen(showOnLockScreen: boolean): void

Sets whether to display the window of the application on the lock screen.

System API: This is a system API.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
showOnLockScreen	boolean	Yes	Whether to display the window on the lock screen. The value true means to display the window on the lock screen, and false means the opposite.

Error codes

For details about the error codes, see Window Error Codes.

ID	Error Message
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.log('onWindowStageCreate');
    try {
      windowStage.setShowOnLockScreen(true);
    } catch (exception) {
      console.error('Failed to show on lockscreen. Cause:' + JSON.stringify(exception));
    }
  }
};

TransitionContext⁹⁺

Provides the context for the transition animation.

Attributes

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Readable	Writable	Description
toWindow9+	Window	Yes	Yes	Target window to display the animation.

completeTransition⁹⁺

completeTransition(isCompleted: boolean): void

Completes the transition. This API can be called only after animateTo() is executed.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
isCompleted	boolean	Yes	Whether the transition is complete. The value true means that the transition is complete, and false means the opposite.

Example

let windowClass: window.Window = window.findWindow("test");
(context: window.TransitionContext) => {
  let toWindow: window.Window = context.toWindow;
  animateTo({
    duration: 1000, // Animation duration.
    tempo: 0.5, // Playback speed.
    curve: Curve.EaseInOut, // Animation curve.
    delay: 0, // Animation delay.
    iterations: 1, // Number of playback times.
    playMode: PlayMode.Normal // Animation playback mode.
  }, () => {
    let obj: window.TranslateOptions = {
      x: 100.0,
      y: 0.0,
      z: 0.0
    };
    toWindow.translate(obj);
    console.info('toWindow translate end');
  }
  );
  try {
    context.completeTransition(true)
  } catch (exception) {
    console.info('toWindow translate fail. Cause: ' + JSON.stringify(exception));
  }
  console.info('complete transition end');
};

TransitionController⁹⁺

Implements the transition animation controller.

animationForShown⁹⁺

animationForShown(context: TransitionContext): void

Customizes the animation for the scenario when the window is shown.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
context	TransitionContext	Yes	Context of the transition animation.

Example

let windowClass: window.Window = window.findWindow("test");
(context : window.TransitionContext) => {
  let toWindow: window.Window = context.toWindow;
  animateTo({
    duration: 1000, // Animation duration.
    tempo: 0.5, // Playback speed.
    curve: Curve.EaseInOut, // Animation curve.
    delay: 0, // Animation delay.
    iterations: 1, // Number of playback times.
    playMode: PlayMode.Normal // Animation playback mode.
    onFinish: ()=> {
      context.completeTransition(true)
    }
  }, () => {
    let obj : window.TranslateOptions = {
      x : 100.0,
      y : 0.0,
      z : 0.0
    };
    toWindow.translate(obj);
    console.info('toWindow translate end');
  }
  );
  console.info('complete transition end');
};

animationForHidden⁹⁺

animationForHidden(context: TransitionContext): void

Customizes the animation for the scenario when the window is hidden.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Parameters

Name	Type	Mandatory	Description
context	TransitionContext	Yes	Context of the transition animation.

Example

let windowClass: window.Window = window.findWindow("test");
(context: window.TransitionContext) => {
  let toWindow: window.Window = context.toWindow;
  animateTo({
    duration: 1000, // Animation duration.
    tempo: 0.5, // Playback speed.
    curve: Curve.EaseInOut, // Animation curve.
    delay: 0, // Animation delay.
    iterations: 1, // Number of playback times.
    playMode: PlayMode.Normal // Animation playback mode.
    onFinish: () => {
      context.completeTransition(true)
    }
  }, () => {
    let obj: window.TranslateOptions = {
      x: 100.0,
      y: 0.0,
      z: 0.0
    };
    toWindow.translate(obj);
    console.info('toWindow translate end');
  }
  )
  console.info('complete transition end');
};

你可能感兴趣的鸿蒙文章

harmony 鸿蒙APIs

harmony 鸿蒙System Common Events (To Be Deprecated Soon)

harmony 鸿蒙System Common Events

harmony 鸿蒙API Reference Document Description

harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)

harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)

harmony 鸿蒙@ohos.bundle (Bundle)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)