wusongqingUpdate docs against 74991+72056+74463+72470+71759+71499

3be2e4ea创建于 2025年3月7日历史提交

@ohos.window (Window) (System API)

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: 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.

This topic describes only system APIs provided by the module. For details about its public APIs, see @ohos.window (Window).

Modules to Import

import { window } from '@kit.ArkUI';

WindowType⁷⁺

Enumerates the window types.

Name	Value	Description
TYPE_INPUT_METHOD^(deprecated)	2	Input method window. Model restriction: This API can be used only in the stage model. System API: This is a system API. NOTE: This API is supported since API version 9 and deprecated since API version 13. There is no alternative window type. To control the input method, call Input method framework APIs. System capability: SystemCapability.WindowManager.WindowManager.Core
TYPE_STATUS_BAR⁹⁺	3	Status bar. 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
TYPE_PANEL⁹⁺	4	Notification panel. 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
TYPE_KEYGUARD⁹⁺	5	Lock screen. 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
TYPE_VOLUME_OVERLAY⁹⁺	6	Volume bar. 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
TYPE_NAVIGATION_BAR⁹⁺	7	Navigation bar. 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
TYPE_WALLPAPER⁹⁺	9	Wallpaper. 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
TYPE_DESKTOP⁹⁺	10	Home screen. 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
TYPE_LAUNCHER_RECENT⁹⁺	11	Recent tasks screen. 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
TYPE_LAUNCHER_DOCK⁹⁺	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. System capability: SystemCapability.WindowManager.WindowManager.Core
TYPE_VOICE_INTERACTION⁹⁺	13	Voice assistant. 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
TYPE_POINTER⁹⁺	14	Mouse. 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
TYPE_FLOAT_CAMERA⁹⁺	15	Floating camera window. 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
TYPE_SCREENSHOT⁹⁺	17	Screenshot window. 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
TYPE_SYSTEM_TOAST¹¹⁺	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. System capability: SystemCapability.WindowManager.WindowManager.Core
TYPE_DIVIDER¹¹⁺	19	Divider. 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
TYPE_GLOBAL_SEARCH¹¹⁺	20	Window used for global search. 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
TYPE_HANDWRITE¹²⁺	21	Stylus window. Model restriction: This API can be used only in the stage model. System API: This is a system API. System capability: SystemCapability.Window.SessionManager

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.

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.

ScaleOptions⁹⁺

Describes the scale parameters.

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Read Only	Mandatory	Description
x	number	No	No	Scale factor along the x-axis. The value is a floating point number, and the default value is 1.0.
y	number	No	No	Scale factor along the y-axis. The value is a floating point number, and the default value is 1.0.
pivotX	number	No	No	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	No	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	Read Only	Mandatory	Description
x	number	No	No	Rotation angle around the x-axis. The value is a floating point number, and the default value is 0.0.
y	number	No	No	Rotation angle around the y-axis. The value is a floating point number, and the default value is 0.0.
z	number	No	No	Rotation angle around the z-axis. The value is a floating point number, and the default value is 0.0.
pivotX	number	No	No	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	No	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	Read Only	Optional	Description
x	number	No	Yes	Distance to translate along the x-axis. The value is a floating point number, the default value is 0.0, and the unit is px.
y	number	No	Yes	Distance to translate along the y-axis. The value is a floating point number, the default value is 0.0, and the unit is px.
z	number	No	Yes	Distance to translate along the z-axis. The value is a floating point number, the default value is 0.0, and the unit is px.

WindowInfo¹²⁺

Describes the window information.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Name	Type	Read Only	Optional	Description
rect	Rect	Yes	No	Size of the rectangle that can be drawn in the window. The upper boundary and left boundary are calculated relative to the window.
bundleName	string	Yes	No	Bundle name.
abilityName	string	Yes	No	Ability name.
windowId	number	Yes	No	Window ID.
windowStatusType	WindowStatusType	Yes	No	Window mode.
isFocused¹⁴⁺	boolean	Yes	Yes	Whether the window gains focus. The value true means that the window gains focus, and false means the opposite.

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300003	This window manager service works abnormally.

Example

import { display } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

let displayClass: display.Display | null = null;
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 code: ${err.code}, message: ${err.message}`);
      return;
    }
    console.info('Succeeded in minimizing all windows.');
  });
} catch (exception) {
  console.error(`Failed to minimize all windows. Cause code: ${exception.code}, message: ${exception.message}`);
}

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300003	This window manager service works abnormally.

Example

import { display } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

let displayClass: display.Display | null = null;
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 code: ${err.code}, message: ${err.message}`);
  });
} catch (exception) {
  console.error(`Failed to minimize all windows. Cause code: ${exception.code}, message: ${exception.message}`);
}

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
202	Permission verification failed. A non-system application calls a system API.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@kit.BasicServicesKit';

window.toggleShownStateForAllAppWindows((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error(`Failed to toggle shown state for all app windows. Cause code: ${err.code}, message: ${err.message}`);
    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
202	Permission verification failed. A non-system application calls a system API.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@kit.BasicServicesKit';

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 code: ${err.code}, message: ${err.message}`);
});

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@kit.BasicServicesKit';

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 code: ${err.code}, message: ${err.message}`);
      return;
    }
    console.info('Succeeded in setting window layout mode.');
  });
} catch (exception) {
  console.error(`Failed to set window layout mode. Cause code: ${exception.code}, message: ${exception.message}`);
}

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@kit.BasicServicesKit';

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 code: ${err.code}, message: ${err.message}`);
  });
} catch (exception) {
  console.error(`Failed to set window layout mode. Cause code: ${exception.code}, message: ${exception.message}`);
}

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.

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

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 code: ${exception.code}, message: ${exception.message}`);
}

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.

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Incorrect parameter types; 2. Parameter verification failed.

Example

const callback = (systemBarTintState: window.SystemBarTintState) => {
  // ...
}
try {
  window.on('systemBarTintChange', callback);

  window.off('systemBarTintChange', callback);
  // Unregister all the callbacks that have been registered through on().
  window.off('systemBarTintChange');
} catch (exception) {
  console.error(`Failed to enable or disable the listener for systemBarTint changes. Cause code: ${exception.code}, message: ${exception.message}`);
}

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
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 code: ${exception.code}, message: ${exception.message}`);
}

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Incorrect parameter types; 2. Parameter verification failed.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

const callback = (bool: boolean) => {
  // ...
}
try {
  window.on('gestureNavigationEnabledChange', callback);
  window.off('gestureNavigationEnabledChange', callback);
  // Unregister all the callbacks that have been registered through on().
  window.off('gestureNavigationEnabledChange');
} catch (exception) {
  console.error(`Failed to enable or disable the listener for gesture navigation status changes. Cause code: ${exception.code}, message: ${exception.message}`);
}

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
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 code: ${exception.code}, message: ${exception.message}`);
}

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Incorrect parameter types; 2. Parameter verification failed.
1300003	This window manager service works abnormally.

Example

const callback = (bool: boolean) => {
  // ...
}
try {
  window.on('waterMarkFlagChange', callback);
  window.off('waterMarkFlagChange', callback);
  // Unregister all the callbacks that have been registered through on().
  window.off('waterMarkFlagChange');
} catch (exception) {
  console.error(`Failed to enable or disable the listener for watermark flag changes. Cause code: ${exception.code}, message: ${exception.message}`);
}

window.setGestureNavigationEnabled¹⁰⁺

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

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

For security purposes, the system does not interfere with the disabling and enabling of gesture navigation. If an application exits abnormally after it disables gesture navigation and wants to restore gesture navigation, it must implement automatic launch and call this API again to enable gesture navigation.

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@kit.BasicServicesKit';

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

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@kit.BasicServicesKit';

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 code: ${err.code}, message: ${err.message}`);
  });
} catch (exception) {
  console.error(`Failed to set gesture navigation enabled. Cause code: ${exception.code}, message: ${exception.message}`);
}

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
1300003	This window manager service works abnormally.

Example

import { image } from '@kit.ImageKit';
import { BusinessError } from '@kit.BasicServicesKit';

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 code: ${err.code}, message: ${err.message}`);
        return;
      }
      console.info('Succeeded in showing watermark image.');
    });
  } catch (exception) {
    console.error(`Failed to show watermark image. Cause code: ${exception.code}, message: ${exception.message}`);
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to create PixelMap. Cause code: ${err.code}, message: ${err.message}`);
});

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
1300003	This window manager service works abnormally.

Example

import { image } from '@kit.ImageKit';
import { BusinessError } from '@kit.BasicServicesKit';

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 code: ${err.code}, message: ${err.message}`);
    });
  } catch (exception) {
    console.error(`Failed to show watermark image. Cause code: ${exception.code}, message: ${exception.message}`);
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to create PixelMap. Cause code: ${err.code}, message: ${err.message}`);
});

window.getSnapshot¹²⁺

getSnapshot(windowId: number): Promise<image.PixelMap>

Obtains a snapshot of the same size as the specified 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
windowId	number	Yes	Window ID. You can call getWindowProperties to obtain the window properties, in which id is the window ID.

Return value

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

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	This operation is not accessible.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { image } from '@kit.ImageKit';

try {
  // This is only an example. Use getWindowProperties to obtain the window ID.
  let windowId: number = 40;
  let promise = window.getSnapshot(windowId);
  promise.then((pixelMap: image.PixelMap) => {
    console.info('Succeeded in getting snapshot window. Pixel bytes number:' + pixelMap.getPixelBytesNumber());
    pixelMap.release();
  }).catch((err: BusinessError) =>{
    console.error(`Failed to get snapshot. Cause code: ${err.code}, message: ${err.message}`);
  });
} catch (exception) {
  console.error(`Failed to get snapshot. Cause code: ${exception.code}, message: ${exception.message}`);
}

window.getVisibleWindowInfo¹²⁺

getVisibleWindowInfo(): Promise<Array<WindowInfo>>

Obtains information about visible windows on the current screen. Visible windows are windows that are not returned to the background.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Return value

Type	Description
Promise<WindowInfo>	Promise used to return the information about visible windows.

Error codes

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

ID	Error Message
202	Permission verification failed, non-system application uses system API.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300003	This window manager service works abnormally.

Example

import { window } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

let promise = window.getVisibleWindowInfo();
promise.then((data) => {
  data.forEach(windowInfo=>{
    console.info(`left:${windowInfo.rect.left}`);
    console.info(`top:${windowInfo.rect.top}`);
    console.info(`width:${windowInfo.rect.width}`);
    console.info(`height:${windowInfo.rect.height}`);
    console.info(`windowId:${windowInfo.windowId}`);
    console.info(`windowStatusType:${windowInfo.windowStatusType}`);
    console.info(`abilityName:${windowInfo.abilityName}`);
    console.info(`bundleName:${windowInfo.bundleName}`);
    console.info(`isFocused:${windowInfo.isFocused}`);
  })
}).catch((err: BusinessError) => {
  console.error('Failed to getWindowInfo. Cause: ' + JSON.stringify(err));
});

Window

Represents a 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 (named windowClass in this example) 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. This API takes effect only for a system window or an application child window.

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
202	Permission verification failed. A non-system application calls a system API.
1300002	This window state is abnormal.

Example

import { BusinessError } from '@kit.BasicServicesKit';

windowClass.hide((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error(`Failed to hide the window. Cause code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in hiding the window.');
});

hide⁷⁺

hide(): Promise<void>

Hides this window. This API uses a promise to return the result. This API takes effect only for a system window or an application child window.

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
202	Permission verification failed. A non-system application calls a system API.
1300002	This window state is abnormal.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let promise = windowClass.hide();
promise.then(() => {
  console.info('Succeeded in hiding the window.');
}).catch((err: BusinessError) => {
  console.error(`Failed to hide the window. Cause code: ${err.code}, message: ${err.message}`);
});

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. This API takes effect only for a system window.

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
202	Permission verification failed. A non-system application calls a system API.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@kit.BasicServicesKit';

windowClass.hideWithAnimation((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error(`Failed to hide the window with animation. Cause code: ${err.code}, message: ${err.message}`);
    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. This API takes effect only for a system window.

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
202	Permission verification failed. A non-system application calls a system API.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@kit.BasicServicesKit';

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 code: ${err.code}, message: ${err.message}`);
});

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. This API takes effect only for a system window.

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
202	Permission verification failed. A non-system application calls a system API.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@kit.BasicServicesKit';

windowClass.showWithAnimation((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error(`Failed to show the window with animation. Cause code: ${err.code}, message: ${err.message}`);
    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. This API takes effect only for a system window.

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
202	Permission verification failed. A non-system application calls a system API.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@kit.BasicServicesKit';

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 code: ${err.code}, message: ${err.message}`);
});

setWindowMode⁹⁺

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

Sets the mode of the main 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

// EntryAbility.ets
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  // ...
  onWindowStageCreate(windowStage: window.WindowStage): void {
    console.info('onWindowStageCreate');
    let windowClass: window.Window | undefined = undefined;
    windowStage.getMainWindow((err: BusinessError, data) => {
      const errCode: number = err.code;
      if (errCode) {
        console.error(`Failed to obtain the main window. Cause code: ${err.code}, message: ${err.message}`);
        return;
      }
      windowClass = data;
      let mode = window.WindowMode.FULLSCREEN;
      try {
        windowClass.setWindowMode(mode, (err: BusinessError) => {
          const errCode: number = err.code;
          if (errCode) {
            console.error(`Failed to set the window mode. Cause code: ${err.code}, message: ${err.message}`);
            return;
          }
          console.info('Succeeded in setting the window mode.');
        });
      } catch (exception) {
        console.error(`Failed to set the window mode. Cause code: ${exception.code}, message: ${exception.message}`);
      }
    });
  }
}

setWindowMode⁹⁺

setWindowMode(mode: WindowMode): Promise<void>

Sets the mode of the main 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

// EntryAbility.ets
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  // ...
  onWindowStageCreate(windowStage: window.WindowStage): void {
    console.info('onWindowStageCreate');
    let windowClass: window.Window | undefined = undefined;
    windowStage.getMainWindow((err: BusinessError, data) => {
      const errCode: number = err.code;
      if (errCode) {
        console.error(`Failed to obtain the main window. Cause code: ${err.code}, message: ${err.message}`);
        return;
      }
      windowClass = data;
      let mode = window.WindowMode.FULLSCREEN;
      try {
        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 code: ${err.code}, message: ${err.message}`);
        });
      } catch (exception) {
        console.error(`Failed to set the window mode. Cause code: ${exception.code}, message: ${exception.message}`);
      }
    });
  }
}

bindDialogTarget⁹⁺

bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback<void>, callback: AsyncCallback<void>): 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: Incorrect parameter types.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { rpc } from '@kit.IPCKit';
import { BusinessError } from '@kit.BasicServicesKit';

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 | undefined = undefined;
let config: window.Configuration = { name: "test", windowType: window.WindowType.TYPE_DIALOG, ctx: this.context };
try {
  window.createWindow(config, (err: BusinessError, data) => {
    let errCode: number = err.code;
    if (errCode) {
      console.error(`Failed to create the window. Cause code: ${err.code}, message: ${err.message}`);
      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 code: ${err.code}, message: ${err.message}`);
      return;
    }
    console.info('Succeeded in binding dialog target.');
  });
} catch (exception) {
  console.error(`Failed to bind dialog target. Cause code: ${exception.code}, message: ${exception.message}`);
}

bindDialogTarget⁹⁺

bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback<void>): Promise<void>

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: Incorrect parameter types.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { rpc } from '@kit.IPCKit';
import { BusinessError } from '@kit.BasicServicesKit';

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 | undefined = undefined;
let config: window.Configuration = {
  name: "test",
  windowType: window.WindowType.TYPE_DIALOG,
  ctx: this.context
};
try {
  window.createWindow(config, (err: BusinessError, data) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error(`Failed to create the window. Cause code: ${err.code}, message: ${err.message}`);
      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 code: ${err.code}, message: ${err.message}`);
  });
} catch (exception) {
  console.error(`Failed to bind dialog target. Cause code: ${exception.code}, message: ${exception.message}`);
}

bindDialogTarget⁹⁺

bindDialogTarget(requestInfo: dialogRequest.RequestInfo, deathCallback: Callback<void>, callback: AsyncCallback<void>): 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: Incorrect parameter types.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { dialogRequest, Want, ServiceExtensionAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class ServiceExtAbility extends ServiceExtensionAbility {
  onRequest(want: Want, startId: number) {
    console.info('onRequest');
    let windowClass: window.Window | undefined = undefined;
    let config: window.Configuration = {
      name: "test", windowType: window.WindowType.TYPE_DIALOG, ctx: this.context
    };
    try {
      window.createWindow(config, (err: BusinessError, data) => {
        let errCode: number = err.code;
        if (errCode) {
          console.error(`Failed to create the window. Cause code: ${err.code}, message: ${err.message}`);
          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 code: ${err.code}, message: ${err.message}`);
          return;
        }
        console.info('Succeeded in binding dialog target.');
      });
    } catch (err) {
      console.error(`Failed to bind dialog target. Cause code: ${err.code}, message: ${err.message}`)
    }
  }
}

bindDialogTarget⁹⁺

bindDialogTarget(requestInfo: dialogRequest.RequestInfo, deathCallback: Callback<void>): Promise<void>

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: Incorrect parameter types.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { dialogRequest, Want, ServiceExtensionAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class ServiceExtAbility extends ServiceExtensionAbility {
  onRequest(want: Want, startId: number) {
    console.info('onRequest');
    let windowClass: window.Window | undefined = undefined;
    let config: window.Configuration = {
      name: "test", windowType: window.WindowType.TYPE_DIALOG, ctx: this.context
    };
    try {
      window.createWindow(config, (err: BusinessError, data) => {
        const errCode: number = err.code;
        if (errCode) {
          console.error(`Failed to create the window. Cause code: ${err.code}, message: ${err.message}`);
          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 code: ${err.code}, message: ${err.message}`);
      });
    } catch (err) {
      console.error(`Failed to bind dialog target. Cause code: ${err.code}, message: ${err.message}`)
    }
  }
}

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

let wakeUp: boolean = true;
try {
  windowClass.setWakeUpScreen(wakeUp);
} catch (exception) {
  console.error(`Failed to wake up the screen. Cause code: ${exception.code}, message: ${exception.message}`);
}

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
1300002	This window state is abnormal.

let isSkip: boolean = true;
try {
  windowClass.setSnapshotSkip(isSkip);
} catch (exception) {
  console.error(`Failed to Skip. Cause code: ${exception.code}, message: ${exception.message}`);
}

setForbidSplitMove⁹⁺

setForbidSplitMove(isForbidSplitMove: boolean, callback: AsyncCallback<void>): void

Sets whether the main 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

// EntryAbility.ets
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  // ...
  onWindowStageCreate(windowStage: window.WindowStage): void {
    console.info('onWindowStageCreate');
    let windowClass: window.Window | undefined = undefined;
    windowStage.getMainWindow((err: BusinessError, data) => {
      const errCode: number = err.code;
      if (errCode) {
        console.error(`Failed to obtain the main window. Cause code: ${err.code}, message: ${err.message}`);
        return;
      }
      windowClass = data;
      let isForbidSplitMove: boolean = true;
      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 code: ${err.code}, message: ${err.message}`);
            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 code: ${exception.code}, message: ${exception.message}`);
      }
    });
  }
}

setForbidSplitMove⁹⁺

setForbidSplitMove(isForbidSplitMove: boolean): Promise<void>

Sets whether the main 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

// EntryAbility.ets
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  // ...
  onWindowStageCreate(windowStage: window.WindowStage): void {
    console.info('onWindowStageCreate');
    let windowClass: window.Window | undefined = undefined;
    windowStage.getMainWindow((err: BusinessError, data) => {
      const errCode: number = err.code;
      if (errCode) {
        console.error(`Failed to obtain the main window. Cause code: ${err.code}, message: ${err.message}`);
        return;
      }
      windowClass = data;
      let isForbidSplitMove: boolean = true;
      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 code: ${err.code}, message: ${err.message}`);
        });
      } catch (exception) {
        console.error(`Failed to forbid window moving in split screen mode. Cause code: ${exception.code}, message: ${exception.message}`);
      }
    });
  }
}

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

try {
  windowClass.opacity(0.5);
} catch (exception) {
  console.error(`Failed to opacity. Cause code: ${exception.code}, message: ${exception.message}`);
}

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

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 code: ${exception.code}, message: ${exception.message}`);
}

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

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 code: ${exception.code}, message: ${exception.message}`);
}

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 px.

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

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 code: ${exception.code}, message: ${exception.message}`);
}

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
202	Permission verification failed. A non-system application calls a system API.
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

let controller = windowClass.getTransitionController(); // Obtain the transition animation controller.

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, in px. The value 0.0 means that the blur is disabled for the window.

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

try {
  windowClass.setBlur(4.0);
} catch (exception) {
  console.error(`Failed to set blur. Cause code: ${exception.code}, message: ${exception.message}`);
}

setBackdropBlur⁹⁺

setBackdropBlur(radius: number): void

Blurs the background of this window.

The window background refers to the lower-layer area covered by the window, which is the same as the window size.

To make the blur effect visible, you must set the window background transparent by calling setWindowBackgroundColor.

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, in px. 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

try {
  windowClass.setWindowBackgroundColor('#00FFFFFF');
  windowClass.setBackdropBlur(4.0);
} catch (exception) {
  console.error(`Failed to set backdrop blur. Cause code: ${exception.code}, message: ${exception.message}`);
}

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

try {
  windowClass.setBackdropBlurStyle(window.BlurStyle.THIN);
} catch (exception) {
  console.error(`Failed to set backdrop blur style. Cause code: ${exception.code}, message: ${exception.message}`);
}

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, in px. 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 px. The value is a floating point number.
offsetY	number	No	Offset of the shadow along the y-axis, in px. The value is a floating point number.

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

try {
  windowClass.setShadow(4.0, '#FF00FF00', 2, 3);
} catch (exception) {
  console.error(`Failed to set shadow. Cause code: ${exception.code}, message: ${exception.message}`);
}

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
cornerRadius	number	Yes	Radius of the rounded corners. The value is a floating point number greater than or equal to 0.0, in px. The value 0.0 means that the window does not use rounded corners.

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

try {
  windowClass.setCornerRadius(4.0);
} catch (exception) {
  console.error(`Failed to set corner radius. Cause code: ${exception.code}, message: ${exception.message}`);
}

setTouchableAreas¹²⁺

setTouchableAreas(rects: Array<Rect>): void

Sets the touchable areas for this window. By default, the entire window is touchable. If a touchable area is set, touch events outside this area are transparently transmitted. The setting becomes invalid after the window rectangle changes.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
rects	Array<Rect>	Yes	Touchable areas. The maximum number of touchable areas cannot exceed 10, and each touchable area cannot exceed the window area.

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

try {
  windowClass.setTouchableAreas([{left: 100, top: 100, width: 200, height:200},
    {left: 400, top: 100, width: 200, height:200}]);
} catch (exception) {
  console.error(`Failed to set touchable areas. Cause code: ${exception.code}, message: ${exception.message}`);
}

raiseToAppTop¹⁰⁺

raiseToAppTop(callback: AsyncCallback<void>): void

Raises the application child window 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
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 '@kit.BasicServicesKit';

windowClass.raiseToAppTop((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error(`Failed to raise the window to app top. Cause code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in raising the window to app top.');
});

setWaterMarkFlag¹⁰⁺

setWaterMarkFlag(enable: boolean): Promise<void>

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 flag. The value true means to add the flag and false means to delete the flag.

Return value

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

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300008	The display device is abnormal.

Example

import { BusinessError } from '@kit.BasicServicesKit';

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 code: ${err.code}, message: ${err.message}`);
  });
} catch (exception) {
  console.error(`Failed to set water mark flag of window. Cause code: ${exception.code}, message: ${exception.message}`);
}

setWaterMarkFlag¹⁰⁺

setWaterMarkFlag(enable: boolean, callback: AsyncCallback<void>): 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 flag. The value true means to add the flag and false means to delete the flag.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300008	The display device is abnormal.

Example

import { BusinessError } from '@kit.BasicServicesKit';

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 code: ${err.code}, message: ${err.message}`);
      return;
    }
    console.info('Succeeded in setting water mark flag of window.');
  });
} catch (exception) {
  console.error(`Failed to set water mark flag of window. Cause code: ${exception.code}, message: ${exception.message}`);
}

setHandwritingFlag¹²⁺

setHandwritingFlag(enable: boolean): Promise<void>

Adds or deletes the handwriting flag for this window. After this flag is added, the window responds to stylus events but not touch events. 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 add or delete the flag. The value true means to add the flag and false means to delete the flag.

Return value

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

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@kit.BasicServicesKit';

try {
  let enable = true;
  let promise = windowClass.setHandwritingFlag(enable);
  promise.then(() => {
    console.info('Succeeded in setting handwriting flag of window.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to set handwriting flag of window. Cause code: ${err.code}, message: ${err.message}`);
  });
} catch (exception) {
  console.error(`Failed to set handwriting flag of window. Cause code: ${exception.code}, message: ${exception.message}`);
}

raiseAboveTarget¹⁰⁺

raiseAboveTarget(windowId: number, callback: AsyncCallback<void>): void

Raises a child window above a target child 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
windowId	number	Yes	ID of the target child window, 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: Mandatory parameters are left unspecified.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.
1300009	The parent window is invalid.

Example

// EntryAbility.ets
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  // ...
  onWindowStageCreate(windowStage: window.WindowStage): void {
    console.info('onWindowStageCreate');
    let windowClass: window.Window | undefined = undefined;
    // Create a child window.
    try {
      let subWindow = windowStage.createSubWindow("testSubWindow");
      subWindow.then((data) => {
        if (data == null) {
          console.error("Failed to create the subWindow. Cause: The data is empty");
          return;
        }
        windowClass = data;
        // The windowClass must be obtained above the targetWindow.
        let targetWindow: window.Window = windowClass;
        let properties = targetWindow.getWindowProperties();
        let targetId = properties.id;
        windowClass.raiseAboveTarget(targetId, (err) => {
          if (err.code) {
            console.error(`Failed to raise the subWindow to target subWindow top. Cause code: ${err.code}, message: ${err.message}`);
            return;
          }
          console.info('Succeeded in raising the subWindow to target subWindow top.');
        });
      });
    } catch (exception) {
      console.error(`Failed to create the subWindow. Cause code: ${exception.code}, message: ${exception.message}`);
    }
  }
}

raiseAboveTarget¹⁰⁺

raiseAboveTarget(windowId: number): Promise<void>

Raises a child window above a target child window. 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 child window, 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: Mandatory parameters are left unspecified.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.
1300009	The parent window is invalid.

Example

// EntryAbility.ets
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  // ...
  onWindowStageCreate(windowStage: window.WindowStage): void {
    console.info('onWindowStageCreate');
    let windowClass: window.Window | undefined = undefined;
    // Create a child window.
    try {
      let subWindow = windowStage.createSubWindow("testSubWindow");
      subWindow.then((data) => {
        if (data == null) {
          console.error("Failed to create the subWindow. Cause: The data is empty");
          return;
        }
        windowClass = data;
        // The windowClass must be obtained above the targetWindow.
        let targetWindow: window.Window = windowClass;
        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: BusinessError)=>{
          console.error(`Failed to raise the subWindow to target subWindow top. Cause code: ${err.code}, message: ${err.message}`);
        });
      });
    } catch (exception) {
      console.error(`Failed to create the subWindow. Cause code: ${exception.code}, message: ${exception.message}`);
    }
  }
}

setRaiseByClickEnabled¹⁰⁺

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

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

Generally, when a user clicks a child window, the child window is displayed on the top. If the enable parameter is set to false, the child window 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 child window to raise itself by click. The value true means to enable the child window 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.
1300009	The parent window is invalid.

Example

// EntryAbility.ets
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  // ...
  onWindowStageCreate(windowStage: window.WindowStage): void {
    console.info('onWindowStageCreate');
    let windowClass: window.Window | undefined = undefined;
    // Create a child window.
    try {
      let subWindow = windowStage.createSubWindow("testSubWindow");
      subWindow.then((data) => {
        if (data == null) {
          console.error("Failed to create the subWindow. Cause: The data is empty");
          return;
        }
        windowClass = data;
        let enabled = false;
        windowClass.setRaiseByClickEnabled(enabled, (err) => {
          if (err.code) {
            console.error(`Failed to disable the raise-by-click function. Cause code: ${err.code}, message: ${err.message}`);
            return;
          }
          console.info('Succeeded in disabling the raise-by-click function.');
        });
      });
    } catch (exception) {
      console.error(`Failed to create the subWindow. Cause code: ${exception.code}, message: ${exception.message}`);
    }
  }
}

enableDrag¹⁴⁺

enableDrag(enable: boolean): Promise<void>

Enables or disables window dragging. This API uses a promise to return the result.

After window dragging is enabled, the window can be resized using the mouse.

This API takes effect only for the system window on 2-in-1 devices. If this API is called for other device types, an error is reported.

System capability: SystemCapability.Window.SessionManager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to enable dragging. The value true means to enable 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

import { BusinessError } from '@kit.BasicServicesKit';

try {
  windowClass.enableDrag(true).then(() => { 
    console.info('succeeded in setting window draggable');
  }).catch((err: BusinessError) => {
    console.error(`Failed to set window draggable. Cause code: ${err.code}, message: ${err.message}`);
  });
} catch (exception) {
  console.error(`Failed to set window draggable. Cause code: ${exception.code}, message: ${exception.message}`);
}

hideNonSystemFloatingWindows¹¹⁺

hideNonSystemFloatingWindows(shouldHide: boolean, callback: AsyncCallback<void>): 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

// EntryAbility.ets
import { UIAbility, Want } from '@kit.AbilityKit';

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 code: ${err.code}, message: ${err.message}`);
        return;
      }
      console.info('Succeeded in loading the content.');
    });

    // Obtain the main window.
    let mainWindow: window.Window | undefined = undefined;
    windowStage.getMainWindow((err, data) => {
      if (err.code) {
        console.error(`Failed to obtain the main window. Cause code: ${err.code}, message: ${err.message}`);
        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 code: ${err.code}, message: ${err.message}`);
          return;
        }
        console.info('Succeeded in hiding the non-system floating windows.');
      });
    });
  }
}

hideNonSystemFloatingWindows¹¹⁺

hideNonSystemFloatingWindows(shouldHide: boolean): Promise<void>

Sets whether to hide non-system floating windows. 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
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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

// EntryAbility.ets
import { UIAbility, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

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 code: ${err.code}, message: ${err.message}`);
        return;
      }
      console.info('Succeeded in loading the content.');
    });

    // Obtain the main window.
    let mainWindow: window.Window | undefined = undefined;
    windowStage.getMainWindow((err, data) => {
      if (err.code) {
        console.error(`Failed to obtain the main window. Cause code: ${err.code}, message: ${err.message}`);
        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: BusinessError)=>{
        console.error(`Failed to hide the non-system floating windows. Cause code: ${err.code}, message: ${err.message}`);
      });
    });
  }
}

setTopmost¹²⁺

setTopmost(isTopmost: boolean): Promise<void>

Called by the main window to place the window above all the other windows. This API uses a promise to return the result.

This parameter is valid only when the main window is a floating window in 2-in-1 devices.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
isTopmost	boolean	Yes	Whether to pin the main window on top. The value true means to pin the main window on top, 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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.
1300004	Unauthorized operation.

Example

// EntryAbility.ets
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  // ...
  onWindowStageCreate(windowStage: window.WindowStage): void {
    // ...
    windowStage.getMainWindow().then((window) => {
      let isTopmost: boolean = true;
      let promise = window.setTopmost(isTopmost);
      promise.then(() => {
        console.info('Succeeded in setting the main window to be topmost.');
      }).catch((err: BusinessError) => {
        console.error(`Failed to set the main window to be topmost. Cause code: ${err.code}, message: ${err.message}`);
      });
    });
  }
}

setSingleFrameComposerEnabled¹¹⁺

setSingleFrameComposerEnabled(enable: boolean): Promise<void>

Enables or disables the single-frame composer. This API uses a promise to return the result.

The single-frame composer is mainly used in scenarios that requires extremely low interaction latency. It reduces the screen display latency of the rendering node.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to enable the single-frame composer. The value true means to enable the single-frame composer, and false means to disable it.

Return value

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

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300002	This window state is abnormal.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let enable = true;
let promise = windowClass.setSingleFrameComposerEnabled(enable);
promise.then(()=> {
    console.info('Succeeded in enabling the single-frame-composer function.');
}).catch((err: BusinessError)=>{
    console.error(`Failed to enable the single-frame-composer function. code:${err.code}, message:${err.message}.`);
});

setTitleButtonVisible¹²⁺

setTitleButtonVisible(isMaximizeVisible: boolean, isMinimizeVisible: boolean, isSplitVisible: boolean): void

Shows or hides the maximize, minimize, and split-screen buttons on the title bar of the main window.

This API is valid only for 2-in-1 devices and takes effect only for the title bar buttons (maximize, minimize, and split-screen) that are available in the current scenario.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
isMaximizeVisible	boolean	Yes	Whether to show the maximize button. The value true means to show the button, and false means to hide it.
isMinimizeVisible	boolean	Yes	Whether to show the minimize button. The value true means to show the button, and false means to hide it.
isSplitVisible	boolean	Yes	Whether to show the split-screen button. The value true means to show the button, and false means to hide it.

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300002	This window state is abnormal.
1300004	Unauthorized operation.

Example

// EntryAbility.ets
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage): void {
    // Load the page corresponding to the main window.
    windowStage.loadContent('pages/Index', (err) => {
      let mainWindow: window.Window | undefined = undefined;
      // Obtain the main window.
      windowStage.getMainWindow().then(
        data => {
          mainWindow = data;
          console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));
          // Call setTitleButtonVisible to hide the maximize, minimize, and split-screen buttons on the title bar of the main window.
          mainWindow.setTitleButtonVisible(false, false, false);
        }
      ).catch((err: BusinessError) => {
          if(err.code){
            console.error(`Failed to obtain the main window. Cause code: ${err.code}, message: ${err.message}`);
          }
      });
    });
  }
}

setWindowType^(deprecated)

setWindowType(type: WindowType, callback: AsyncCallback<void>): 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 '@kit.BasicServicesKit';

let type = window.WindowType.TYPE_SYSTEM_ALERT;
windowClass.setWindowType(type, (err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error(`Failed to set the window type. Cause code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in setting the window type.');
});

setWindowType^(deprecated)

setWindowType(type: WindowType): Promise<void>

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 '@kit.BasicServicesKit';

let type = window.WindowType.TYPE_SYSTEM_ALERT;
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 code: ${err.code}, message: ${err.message}`);
});

requestFocus¹³⁺

requestFocus(isFocused: boolean): Promise<void>

Allows this window to proactively request to gain or lose focus. This API uses a promise to return the result. A value is returned as long as the API is successfully called. The return value does not indicate that the window has gained or lost focus. You can use on('windowEvent') to listen for the focus status of the window.

When a focus request is sent, whether the window can successfully gain focus depends on its capability of being focused and its current visibility. To gain focus, the window must be capable of receiving focus and in a visible state (actively displayed and not hidden or destroyed).

Conversely, once a blur request is sent, the window will lose focus without any conditions.

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Parameters

Name	Type	Mandatory	Description
isFocused	boolean	Yes	Whether to gain or lose focus. The value true means to gain focus, and false means to lose focus.

Return value

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

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported. Failed to call the API due to limited device capabilities.
1300002	This window state is abnormal.
1300003	This window manager service works abnormally.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let isFocused: boolean = true;
let promise = windowClass.requestFocus(isFocused);
promise.then(() => {
  console.info('Succeeded in requesting focus.');
}).catch((err: BusinessError) => {
  console.error(`Failed to request focus. Cause code: ${err.code}, message: ${err.message}`);
});

SubWindowOptions¹¹⁺

Describes the parameters used for creating a child window.

System capability: SystemCapability.Window.SessionManager

Name	Type	Read Only	Optional	Description
isTopmost¹²⁺	boolean	No	Yes	Whether the child window is topmost. The value true means that the child window is topmost, and false means the opposite. The default value is false.

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.

disableWindowDecor⁹⁺

disableWindowDecor(): void

Disables window decorators.

When window decorators are disabled and the main window transitions into full-screen mode, hovering the cursor over the hot zone of the top window's title bar will cause a floating title bar to appear. To prevent the floating title bar from appearing, call setTitleAndDockHoverShown().

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
202	Permission verification failed. A non-system application calls a system API.
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

// EntryAbility.ets
import { UIAbility, Want } from '@kit.AbilityKit';

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 Universal Error Codes and Window Error Codes.

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
1300002	This window state is abnormal.
1300005	This window stage is abnormal.

Example

// EntryAbility.ets
import { UIAbility } from '@kit.AbilityKit';

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 code: ${exception.code}, message: ${exception.message}`);
    }
  }
};

TransitionContext⁹⁺

Provides the context for the transition animation.

System API: This is a system API.

Attributes

System API: This is a system API.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Readable	Writable	Description
toWindow⁹⁺	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.

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

Example

(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.error(`toWindow translate fail. Cause code: ${exception.code}, message: ${exception.message}`);
  }
  console.info('complete transition end');
};

TransitionController⁹⁺

Implements the transition animation controller. Before calling any API, you must create a system window. For details, see the sample code.

System API: This is a system API.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let windowClass: window.Window | undefined = undefined;
let config: window.Configuration = {
  name: "systemTypeWindow",
  windowType: window.WindowType.TYPE_PANEL, // Select a system window type as required.
  ctx: this.context
};
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 code: ${err.code}, message: ${err.message}`);
});

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.

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

Example

// xxx.ts
export class AnimationConfig {
  private animationForShownCallFunc_: Function = undefined;
  ShowWindowWithCustomAnimation(windowClass: window.Window, callback) {
    if (!windowClass) {
      console.error('windowClass is undefined');
      return false;
    }
    this.animationForShownCallFunc_ = callback;
    let controller: window.TransitionController = windowClass.getTransitionController();
    controller.animationForShown = (context : window.TransitionContext)=> {
      this.animationForShownCallFunc_(context);
    };
    windowClass.showWithAnimation(()=>{
      console.info('Show with animation success');
    });
  }
}

// xxx.ets
let animationConfig = new AnimationConfig();
let systemTypeWindow = window.findWindow("systemTypeWindow"); // Obtain a system window.
try {
  animationConfig?.ShowWindowWithCustomAnimation(systemTypeWindow, (context : window.TransitionContext)=>{
    console.info('complete transition end');
    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: () => {
        console.info('onFinish in animation');
        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 in animation');
    });
    console.info('complete transition end');
  });
} catch (error) {
  console.error(`ShowWindowWithCustomAnimation error code: ${error.code}, message: ${error.message}`);
}

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.

Error codes

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

ID	Error Message
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

Example

// xxx.ts
export class AnimationConfig {
  private animationForHiddenCallFunc_: Function = undefined;
  HideWindowWithCustomAnimation(windowClass: window.Window, callback) {
    if (!windowClass) {
      console.error('windowClass is undefined');
      return false;
    }
    this.animationForHiddenCallFunc_ = callback;
    let controller: window.TransitionController = windowClass.getTransitionController();
    controller.animationForHidden = (context : window.TransitionContext)=> {
      this.animationForHiddenCallFunc_(context);
    };
    windowClass.hideWithAnimation(()=>{
      console.info('hide with animation success');
    });
  }
}

// xxx.ets
let animationConfig = new AnimationConfig();
let systemTypeWindow = window.findWindow("systemTypeWindow"); // Obtain a system window.
try {
  animationConfig?.HideWindowWithCustomAnimation(systemTypeWindow, (context : window.TransitionContext)=>{
    console.info('complete transition end');
    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: () => {
        console.info('onFinish in animation');
        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 in animation');
    });
    console.info('complete transition end');
  });
} catch (error) {
  console.error(`HideWindowWithCustomAnimation error code: ${error.code}, message: ${error.message}` );
}

ExtensionWindowAttribute¹⁴⁺

Enumerates the attributes of a window for a UI ServiceExtensionAbility.

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

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Name	Value	Description
SYSTEM_WINDOW	0	System window
SUB_WINDOW	1	child window.

SystemWindowOptions¹⁴⁺

Describes the parameters for creating a system window.

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

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Name	Type	Read Only	Optional	Description
windowType	WindowType	No	No	Window type. There is no default value. If null is passed in, the window fails to be created. TYPE_DIALOG is not supported.

ExtensionWindowConfig¹⁴⁺

Describes the parameters for creating a window for a UI ServiceExtensionAbility.

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

System API: This is a system API.

System capability: SystemCapability.Window.SessionManager

Name	Type	Read Only	Optional	Description
windowName	string	No	No	Window name.
windowAttribute	ExtensionWindowAttribute	No	No	Window attribute. It specifies whether the created window is a child window or a system window. When windowAttribute is set to SUB_WINDOW, subWindowOptions is mandatory. When windowAttribute is set to SYSTEM_WINDOW, systemWindowOptions is mandatory. Otherwise, the window fails to be created.
windowRect	Rect	No	No	Rectangular area of the window.
subWindowOptions	SubWindowOptions	No	Yes	Parameters used for creating a child window. There is no default value. This parameter is mandatory when windowAttribute is set to SUB_WINDOW. Otherwise, the window fails to be created.
systemWindowOptions	SystemWindowOptions	No	Yes	Parameters for creating a system window. There is no default value. This parameter is mandatory when windowAttribute is set to SYSTEM_WINDOW. Otherwise, the window fails to be created.

@ohos.window (Window) (System API)

Modules to Import

WindowType7+

WindowMode7+

WindowLayoutMode9+

BlurStyle9+

SystemBarRegionTint8+

SystemBarTintState8+

ScaleOptions9+

RotateOptions9+

TranslateOptions9+

WindowInfo12+

window.minimizeAll9+

window.minimizeAll9+

window.toggleShownStateForAllAppWindows9+

window.toggleShownStateForAllAppWindows9+

window.setWindowLayoutMode9+

window.setWindowLayoutMode9+

window.on('systemBarTintChange')8+

window.off('systemBarTintChange')8+

window.on('gestureNavigationEnabledChange')10+

window.off('gestureNavigationEnabledChange')10+

window.on('waterMarkFlagChange')10+

window.off('waterMarkFlagChange')10+

window.setGestureNavigationEnabled10+

window.setGestureNavigationEnabled10+

window.setWaterMarkImage10+

window.setWaterMarkImage10+

window.getSnapshot12+

window.getVisibleWindowInfo12+

Window

hide7+

hide7+

hideWithAnimation9+

hideWithAnimation9+

showWithAnimation9+

showWithAnimation9+

setWindowMode9+

setWindowMode9+

bindDialogTarget9+

bindDialogTarget9+

bindDialogTarget9+

bindDialogTarget9+

setWakeUpScreen9+

setSnapshotSkip9+

setForbidSplitMove9+

setForbidSplitMove9+

opacity9+

scale9+

rotate9+

translate9+

getTransitionController9+

setBlur9+

setBackdropBlur9+

setBackdropBlurStyle9+

setShadow9+

setCornerRadius9+

setTouchableAreas12+

raiseToAppTop10+

setWaterMarkFlag10+

setWaterMarkFlag10+

setHandwritingFlag12+

raiseAboveTarget10+

raiseAboveTarget10+

setRaiseByClickEnabled10+

enableDrag14+

hideNonSystemFloatingWindows11+

hideNonSystemFloatingWindows11+

setTopmost12+

setSingleFrameComposerEnabled11+

setTitleButtonVisible12+

setWindowType(deprecated)

setWindowType(deprecated)

requestFocus13+

SubWindowOptions11+

WindowStage9+

disableWindowDecor9+

setShowOnLockScreen9+

TransitionContext9+

Attributes

WindowType⁷⁺

WindowMode⁷⁺

WindowLayoutMode⁹⁺

BlurStyle⁹⁺

SystemBarRegionTint⁸⁺

SystemBarTintState⁸⁺

ScaleOptions⁹⁺

RotateOptions⁹⁺

TranslateOptions⁹⁺

WindowInfo¹²⁺

window.minimizeAll⁹⁺

window.minimizeAll⁹⁺

window.toggleShownStateForAllAppWindows⁹⁺

window.toggleShownStateForAllAppWindows⁹⁺

window.setWindowLayoutMode⁹⁺

window.setWindowLayoutMode⁹⁺

window.on('systemBarTintChange')⁸⁺

window.off('systemBarTintChange')⁸⁺

window.on('gestureNavigationEnabledChange')¹⁰⁺

window.off('gestureNavigationEnabledChange')¹⁰⁺

window.on('waterMarkFlagChange')¹⁰⁺

window.off('waterMarkFlagChange')¹⁰⁺

window.setGestureNavigationEnabled¹⁰⁺

window.setGestureNavigationEnabled¹⁰⁺

window.setWaterMarkImage¹⁰⁺

window.setWaterMarkImage¹⁰⁺

window.getSnapshot¹²⁺

window.getVisibleWindowInfo¹²⁺

hide⁷⁺

hide⁷⁺

hideWithAnimation⁹⁺

hideWithAnimation⁹⁺

showWithAnimation⁹⁺

showWithAnimation⁹⁺

setWindowMode⁹⁺

setWindowMode⁹⁺

bindDialogTarget⁹⁺

bindDialogTarget⁹⁺

bindDialogTarget⁹⁺

bindDialogTarget⁹⁺

setWakeUpScreen⁹⁺

setSnapshotSkip⁹⁺

setForbidSplitMove⁹⁺

setForbidSplitMove⁹⁺

opacity⁹⁺

scale⁹⁺

rotate⁹⁺

translate⁹⁺

getTransitionController⁹⁺

setBlur⁹⁺

setBackdropBlur⁹⁺

setBackdropBlurStyle⁹⁺

setShadow⁹⁺

setCornerRadius⁹⁺

setTouchableAreas¹²⁺

raiseToAppTop¹⁰⁺

setWaterMarkFlag¹⁰⁺

setWaterMarkFlag¹⁰⁺

setHandwritingFlag¹²⁺

raiseAboveTarget¹⁰⁺

raiseAboveTarget¹⁰⁺

setRaiseByClickEnabled¹⁰⁺

enableDrag¹⁴⁺

hideNonSystemFloatingWindows¹¹⁺

hideNonSystemFloatingWindows¹¹⁺

setTopmost¹²⁺

setSingleFrameComposerEnabled¹¹⁺

setTitleButtonVisible¹²⁺

setWindowType^(deprecated)

setWindowType^(deprecated)

requestFocus¹³⁺

SubWindowOptions¹¹⁺

WindowStage⁹⁺

disableWindowDecor⁹⁺

setShowOnLockScreen⁹⁺

TransitionContext⁹⁺

completeTransition⁹⁺

TransitionController⁹⁺

animationForShown⁹⁺

animationForHidden⁹⁺