/* * Copyright (c) 2021 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @file * @kit ArkUI */ import { AsyncCallback, BusinessError } from './@ohos.base'; import BaseContext from './application/BaseContext'; import image from './@ohos.multimedia.image'; import rpc from './@ohos.rpc'; import dialogRequest from './@ohos.app.ability.dialogRequest'; /*** if arkts 1.1 */ import { UIContext } from './@ohos.arkui.UIContext'; import { ColorMetrics } from './@ohos.arkui.node'; /*** endif */ import ConfigurationConstant from './@ohos.app.ability.ConfigurationConstant'; import bundleManager from './@ohos.bundle.bundleManager'; /*** if arkts 1.2 */ import { LocalStorage } from '@ohos.arkui.stateManagement'; import { UIContext } from '@ohos.arkui.UIContext'; import { ColorMetrics } from '@ohos.arkui.node'; import { Callback } from './@ohos.base'; /*** endif */ /*** if arkts 1.1 */ /** * Defines the window callback. * * @typedef Callback * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ declare interface Callback { /** * Defines the callback info. * * @param { T } data - the data will be used in the callback. * @returns { V } - Returns result of the callback. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ (data: T): V; } /*** endif */ /** * Defines the window animation curve param. * * @typedef { Array } AnimationCurveParam * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ declare type WindowAnimationCurveParam = Array; /** * Window manager. * * @namespace window * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 */ /** * Window manager. * * @namespace window * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Window manager. * * @namespace window * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ declare namespace window { /** * The type of a window. * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * The type of a window. * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ enum WindowType { /** * App. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @FAModelOnly * @since arkts {'1.1':'7', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_APP = 0, /** * System alert. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 11 */ TYPE_SYSTEM_ALERT, /** * Input method. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since 9 * @deprecated since 13 */ TYPE_INPUT_METHOD, /** * Status bar. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_STATUS_BAR = 3, /** * Panel. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_PANEL = 4, /** * Keyguard. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_KEYGUARD = 5, /** * Volume. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_VOLUME_OVERLAY = 6, /** * Navigation bar. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_NAVIGATION_BAR = 7, /** * Float. * * @permission ohos.permission.SYSTEM_FLOAT_WINDOW * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * Float. * Require "ohos.permission.SYSTEM_FLOAT_WINDOW" permission * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_FLOAT = 8, /** * Wallpaper. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_WALLPAPER = 9, /** * Desktop. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_DESKTOP = 10, /** * Recent. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_LAUNCHER_RECENT = 11, /** * Dock. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_LAUNCHER_DOCK = 12, /** * Voice interaction. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_VOICE_INTERACTION = 13, /** * Pointer. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_POINTER = 14, /** * Float camera. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_FLOAT_CAMERA = 15, /** * Dialog. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 10 */ /** * Dialog. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_DIALOG= 16, /** * Screenshot. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_SCREENSHOT = 17, /** * System Toast. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_SYSTEM_TOAST = 18, /** * Divider. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_DIVIDER= 19, /** * Global Search. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_GLOBAL_SEARCH= 20, /** * Handwrite. * * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_HANDWRITE = 21, /** * TYPE_WALLET_SWIPE_CARD. * * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since arkts {'1.1':'15', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_WALLET_SWIPE_CARD = 22, /** * Screen Control * * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since arkts {'1.1':'15', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_SCREEN_CONTROL = 23, /** * TYPE_FLOAT_NAVIGATION. * * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since arkts {'1.1':'17', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_FLOAT_NAVIGATION = 24, /** * TYPE_DYNAMIC. * * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since 20 */ TYPE_DYNAMIC, /** * TYPE_MUTISCREEN_COLLABORATION. * * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since 20 */ TYPE_MUTISCREEN_COLLABORATION = 26, /** * Main. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 18 */ TYPE_MAIN = 32 } /** * Describes the type of avoid area * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Describes the type of avoid area * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Describes the type of avoid area * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ enum AvoidAreaType { /** * Default area of the system * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Default area of the system * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Default area of the system * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_SYSTEM = 0, /** * Notch * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Notch * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Notch * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_CUTOUT = 1, /** * Area for system gesture * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Area for system gesture * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Area for system gesture * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_SYSTEM_GESTURE = 2, /** * Area for keyboard * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Area for keyboard * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Area for keyboard * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_KEYBOARD = 3, /** * Area for navigation indicator * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Area for navigation indicator * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ TYPE_NAVIGATION_INDICATOR = 4 } /** * Describes the window mode of an application * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'7', '1.2':'20'} * @arkts 1.1&1.2 */ enum WindowMode { /** * Undefined mode of the window * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 7 */ UNDEFINED = 1, /** * Fullscreen mode of the window * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 7 */ FULLSCREEN, /** * Primary mode of the window * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 7 */ PRIMARY, /** * Secondary mode of the window * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 7 */ SECONDARY, /** * Floating mode of the window * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'7', '1.2':'20'} * @arkts 1.1&1.2 */ FLOATING = 5 } /** * Describes the mode of window layout * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ enum WindowLayoutMode { /** * CASCADE * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ WINDOW_LAYOUT_MODE_CASCADE, /** * TILE * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ WINDOW_LAYOUT_MODE_TILE } /** * Describes the window status of an application * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Describes the window status of an application * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ /** * Describes the window status of an application * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ enum WindowStatusType { /** * Undefined status of the window * * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Undefined status of the window * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ /** * Undefined status of the window * * @syscap SystemCapability.Window.SessionManager * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ UNDEFINED = 0, /** * Full screen status of the window * * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Full screen status of the window * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ /** * Full screen status of the window * * @syscap SystemCapability.Window.SessionManager * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ FULL_SCREEN = 1, /** * Maximize status of the window * * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Maximize status of the window * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ MAXIMIZE = 2, /** * Minimize status of the window * * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Minimize status of the window * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ /** * Minimize status of the window * * @syscap SystemCapability.Window.SessionManager * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ MINIMIZE = 3, /** * Floating status of the window * * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Floating status of the window * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ /** * Floating status of the window * * @syscap SystemCapability.Window.SessionManager * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ FLOATING = 4, /** * Split screen status of the window * * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Split screen status of the window * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ /** * Split screen status of the window * * @syscap SystemCapability.Window.SessionManager * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ SPLIT_SCREEN = 5 } /** * Properties of status bar and navigation bar, it couldn't update automatically * * @interface SystemBarProperties * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 */ /** * Properties of status bar and navigation bar, it couldn't update automatically * * @interface SystemBarProperties * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * Properties of status bar and navigation bar, it couldn't update automatically * * @interface SystemBarProperties * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ interface SystemBarProperties { /** * The color of the status bar. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 */ /** * The color of the status bar. * * @type { ?string } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * The color of the status bar. * * @type { ?string } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ statusBarColor?: string; /** * The light icon of the status bar. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * The light icon of the status bar. * * @type { ?boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * The light icon of the status bar. * * @type { ?boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ isStatusBarLightIcon?: boolean; /** * The content color of the status bar * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 */ /** * The content color of the status bar * * @type { ?string } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ statusBarContentColor?: string; /** * The color of the navigation bar. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 */ /** * The color of the navigation bar. * * @type { ?string } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * The color of the navigation bar. * * @type { ?string } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ navigationBarColor?: string; /** * The light icon of the navigation bar. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * The light icon of the navigation bar. * * @type { ?boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * The light icon of the navigation bar. * * @type { ?boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ isNavigationBarLightIcon?: boolean; /** * The content color of the navigation bar * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 */ /** * The content color of the navigation bar * * @type { ?string } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ navigationBarContentColor?: string; /** * Enable the animation of the status bar. * * @type { ?boolean } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ /** * Enable the animation of the status bar. * * @type { ?boolean } * @syscap SystemCapability.Window.SessionManager * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ enableStatusBarAnimation?: boolean; /** * Enable the animation of the navigation bar. * * @type { ?boolean } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ enableNavigationBarAnimation?: boolean; } /** * Properties of status bar. * * @interface StatusBarProperty * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ interface StatusBarProperty { /** * The content color of the status bar. * * @type { string } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ contentColor: string; } /** * Properties of status bar, it couldn't update automatically * * @interface SystemBarStyle * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ interface SystemBarStyle { /** * The content color of the status bar * * @type { ?string } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ statusBarContentColor?: string; } /** * System bar tint of region * * @interface SystemBarRegionTint * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'8', '1.2':'20'} * @arkts 1.1&1.2 */ interface SystemBarRegionTint { /** * System bar type * * @type { WindowType } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 8 */ type: WindowType; /** * The visibility of system bar * * @type { ?boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 8 */ isEnable?: boolean; /** * The region of system bar * * @type { ?Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 8 */ region?: Rect; /** * The background color of the system bar. * * @type { ?string } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 8 */ backgroundColor?: string; /** * The content color of the system bar. * * @type { ?string } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 8 */ contentColor?: string; } /** * System bar tint state for systemui * * @interface SystemBarTintState * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'8', '1.2':'20'} * @arkts 1.1&1.2 */ interface SystemBarTintState { /** * Id of display * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 8 */ displayId: number; /** * Region tint of systembar * * @type { Array } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 8 */ regionTint: Array; } /** * Rectangle * * @interface Rect * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Rectangle * * @interface Rect * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Rectangle * * @interface Rect * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ interface Rect { /** * The left of the Rect. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * The left of the Rect. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * The left of the Rect. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ left: number; /** * The top of the Rect. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * The top of the Rect. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * The top of the Rect. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ top: number; /** * The width of the Rect. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * The width of the Rect. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * The width of the Rect. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ width: number; /** * The height of the Rect. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * The height of the Rect. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * The height of the Rect. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ height: number; } /** * Position * * @interface Position * @syscap SystemCapability.Window.SessionManager * @since 20 */ export interface Position { /** * The X-coordinate * * @type { number } * @syscap SystemCapability.Window.SessionManager * @since 20 */ x: number; /** * The Y-coordinate * * @type { number } * @syscap SystemCapability.Window.SessionManager * @since 20 */ y: number; } /** * Enum for window anchor * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @since 20 */ enum WindowAnchor { /** * The value means window top left corner. * * @syscap SystemCapability.Window.SessionManager * @since 20 */ TOP_START = 0, /** * The value means horizontal midpoint of the border on the window. * * @syscap SystemCapability.Window.SessionManager * @since 20 */ TOP = 1, /** * The value means window top right corner. * * @syscap SystemCapability.Window.SessionManager * @since 20 */ TOP_END = 2, /** * The value means vertical midpoint of the left border of the window. * * @syscap SystemCapability.Window.SessionManager * @since 20 */ START = 3, /** * The value means window horizontal and vertical midpoint. * * @syscap SystemCapability.Window.SessionManager * @since 20 */ CENTER = 4, /** * The value means vertical midpoint of the right border of the window. * * @syscap SystemCapability.Window.SessionManager * @since 20 */ END = 5, /** * The value means window bottom left corner. * * @syscap SystemCapability.Window.SessionManager * @since 20 */ BOTTOM_START = 6, /** * The value means horizontal midpoint of the lower border of the window. * * @syscap SystemCapability.Window.SessionManager * @since 20 */ BOTTOM = 7, /** * The value means window bottom right corner. * * @syscap SystemCapability.Window.SessionManager * @since 20 */ BOTTOM_END = 8, } /** * Avoid area * * @interface AvoidArea * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Avoid area * * @interface AvoidArea * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Avoid area * * @interface AvoidArea * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ interface AvoidArea { /** * Whether avoidArea is visible on screen * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Whether avoidArea is visible on screen * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ visible: boolean; /** * Rectangle on the left of the screen * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Rectangle on the left of the screen * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Rectangle on the left of the screen * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ leftRect: Rect; /** * Rectangle on the top of the screen * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Rectangle on the top of the screen * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Rectangle on the top of the screen * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ topRect: Rect; /** * Rectangle on the right of the screen * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Rectangle on the right of the screen * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Rectangle on the right of the screen * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ rightRect: Rect; /** * Rectangle on the bottom of the screen * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Rectangle on the bottom of the screen * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Rectangle on the bottom of the screen * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ bottomRect: Rect; } /** * Window size * * @interface Size * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Window size * * @interface Size * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Window size * * @interface Size * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ interface Size { /** * The width of the window. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * The width of the window. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * The width of the window. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ width: number; /** * The height of the window. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * The height of the window. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * The height of the window. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ height: number; } /** * The info of window * * @interface WindowInfo * @syscap SystemCapability.Window.SessionManager * @systemapi * @since 12 */ /** * The info of window * * @interface WindowInfo * @syscap SystemCapability.Window.SessionManager * @since 18 */ interface WindowInfo { /** * The position and size of the window * * @type { Rect } * @syscap SystemCapability.Window.SessionManager * @systemapi * @since 12 */ /** * The position and size of the window * * @type { Rect } * @syscap SystemCapability.Window.SessionManager * @since arkts {'1.1':'18', '1.2':'20'} * @arkts 1.1&1.2 */ rect: Rect; /** * Global display rect. * * @type { ?Rect } * @syscap SystemCapability.Window.SessionManager * @since 20 */ globalDisplayRect?: Rect; /** * bundleName of window * * @type { string } * @syscap SystemCapability.Window.SessionManager * @systemapi * @since 12 */ /** * bundleName of window * * @type { string } * @syscap SystemCapability.Window.SessionManager * @since 18 */ bundleName: string; /** * abilityName of window * * @type { string } * @syscap SystemCapability.Window.SessionManager * @systemapi * @since 12 */ /** * abilityName of window * * @type { string } * @syscap SystemCapability.Window.SessionManager * @since 18 */ abilityName: string; /** * Indicates target window id. * * @type { number } * @syscap SystemCapability.Window.SessionManager * @systemapi * @since 12 */ /** * Indicates target window id. * * @type { number } * @syscap SystemCapability.Window.SessionManager * @since 18 */ windowId: number; /** * The window status of an application. * * @type { WindowStatusType } * @syscap SystemCapability.Window.SessionManager * @systemapi * @since 12 */ /** * The window status of an application. * * @type { WindowStatusType } * @syscap SystemCapability.Window.SessionManager * @since 18 */ /** * The window status of an application. * * @type { WindowStatusType } * @syscap SystemCapability.Window.SessionManager * @crossplatform * @since 20 */ windowStatusType: WindowStatusType; /** * Whether the window is focused. The default value is false. * * @type { ?boolean } * @syscap SystemCapability.Window.SessionManager * @systemapi * @since 14 */ /** * Whether the window is focused. The default value is false. * * @type { ?boolean } * @syscap SystemCapability.Window.SessionManager * @since 18 */ isFocused?: boolean; } /** * The info of window density * * @interface WindowDensityInfo * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'15', '1.2':'20'} * @arkts 1.1&1.2 */ interface WindowDensityInfo { /** * System density * * @type { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'15', '1.2':'20'} * @arkts 1.1&1.2 */ systemDensity: number; /** * Default density * * @type { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'15', '1.2':'20'} * @arkts 1.1&1.2 */ defaultDensity: number; /** * Custom density * * @type { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'15', '1.2':'20'} * @arkts 1.1&1.2 */ customDensity: number; } /** * Properties of window, it couldn't update automatically * * @interface WindowProperties * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 */ /** * Properties of window, it couldn't update automatically * * @interface WindowProperties * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Properties of window, it couldn't update automatically * * @interface WindowProperties * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ interface WindowProperties { /** * The position and size of the window * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * The position and size of the window * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * The position and size of the window * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ windowRect: Rect; /** * The position relative to the window and size of drawable area * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 11 */ /** * The position relative to the window and size of drawable area * * @type { Rect } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ drawableRect: Rect; /** * Global display rect. * * @type { ?Rect } * @syscap SystemCapability.Window.SessionManager * @since 20 */ globalDisplayRect?: Rect; /** * Window type * * @type { WindowType } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Window type * * @type { WindowType } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ type: WindowType; /** * Whether the window is displayed in full screen mode. The default value is false. * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 */ /** * Whether the window is displayed in full screen mode. The default value is false. * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ isFullScreen: boolean; /** * Whether the window layout is in full screen mode(whether the window is immersive). The default value is false. * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Whether the window layout is in full screen mode(whether the window is immersive). The default value is false. * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ isLayoutFullScreen: boolean; /** * Whether the window can gain focus. The default value is true * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Whether the window can gain focus. The default value is true * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ focusable: boolean; /** * Whether the window is touchable. The default value is false * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Whether the window is touchable. The default value is false * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ touchable: boolean; /** * Brightness value of window. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 */ /** * Brightness value of window. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Brightness value of window. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ brightness: number; /** * The dimbehind value of window. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 */ dimBehindValue: number; /** * Whether keep screen on. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 */ /** * Whether keep screen on. * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Whether keep screen on. * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ isKeepScreenOn: boolean; /** * Whether make window in privacy mode or not. * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Whether make window in privacy mode or not. * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ isPrivacyMode: boolean; /** * Whether is round corner or not. * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 */ isRoundCorner: boolean; /** * Whether is transparent or not. * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Whether is transparent or not. * * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ isTransparent: boolean; /** * Window id. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Window id. * * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ id: number; /** * display id. * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ displayId?: number; /** * window name. * * @type { ?string } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'18', '1.2':'20'} * @arkts 1.1&1.2 */ name?: string; } /** * The decor button style of the window. * * @interface DecorButtonStyle * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'14', '1.2':'20'} * @arkts 1.1&1.2 */ interface DecorButtonStyle { /** * color mode. * * @type { ?colorMode } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ colorMode?: ConfigurationConstant.ColorMode; /** * button background size when hover. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ buttonBackgroundSize? : number; /** * button spacing. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ spacingBetweenButtons? : number; /** * close button right Margin. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ closeButtonRightMargin? : number; /** * button icon size. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ buttonIconSize? : number; /** * corner radius of button background when hover. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ buttonBackgroundCornerRadius? : number; } /** * Type of allowing the specified of color space. * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 */ /** * Type of allowing the specified of color space. * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 11 */ /** * Type of allowing the specified of color space. * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ enum ColorSpace { /** * Default color space. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 */ /** * Default color space. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 11 */ /** * Default color space. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ DEFAULT = 0, /** * Wide gamut color space. The specific wide color gamut depends on thr screen. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 */ /** * Wide gamut color space. The specific wide color gamut depends on thr screen. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 11 */ /** * Wide gamut color space. The specific wide color gamut depends on thr screen. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ WIDE_GAMUT = 1 } /** * Describes the scale Transition Options of window * * @interface ScaleOptions * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ interface ScaleOptions { /** * The scale param of x direction. Default is 1.f * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ x?: number; /** * The scale param of y direction. Default is 1.f * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ y?: number; /** * The scale param of pivot point of x. Default is 0.5f, Interval is 0.f - 1.f * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ pivotX?: number; /** * The scale param of pivot point of y. Default is 0.5f, Interval is 0.f - 1.f * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ pivotY?: number; } /** * Describes the rotate Transition Options of window * * @interface RotateOptions * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ interface RotateOptions { /** * The rotate degree of x direction. Default value is 0.f * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ x?: number; /** * The rotate degree of y direction. Default value is 0.f * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ y?: number; /** * The rotate degree of z direction. Default value is 0.f * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ z?: number; /** * The param of pivot point of x. Default is 0.5f, Interval is 0.f - 1.f * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ pivotX?: number; /** * The param of pivot point of y. Default is 0.5f, Interval is 0.f - 1.f * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ pivotY?: number; } /** * Describes the translate Transition Options of window * * @interface TranslateOptions * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ interface TranslateOptions { /** * The translate pixel param of x direction. Default is 0.f * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ x?: number; /** * The translate pixel param of y direction. Default is 0.f * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ y?: number; /** * The translate pixel param of z direction. Default is 0.f * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ z?: number; } /** * Transition Context * * @interface TransitionContext * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ interface TransitionContext { /** * The target window with animation * * @type { Window } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ toWindow: Window; /** * Set complete state of animation transition * * @param { boolean } isCompleted - Whether the transition is complete. The value true means that the transition is complete, and false means the opposite. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ /** * Set complete state of animation transition * * @param { boolean } isCompleted - Whether the transition is complete. The value true means that the transition is complete, and false means the opposite. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ completeTransition(isCompleted: boolean): void; } /** * Transition Controller * * @interface TransitionController * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ interface TransitionController { /** * Animation configuration when showing window * * @param { TransitionContext } context - The transition context. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ /** * Animation configuration when showing window * * @param { TransitionContext } context - The transition context. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ animationForShown(context: TransitionContext): void; /** * Animation configuration when hiding window * * @param { TransitionContext } context - The transition context. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ /** * Animation configuration when hiding window * * @param { TransitionContext } context - The transition context. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ animationForHidden(context: TransitionContext): void; } /** * Configuration parameters for window creation. * * @interface Configuration * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Configuration parameters for window creation. * * @interface Configuration * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ interface Configuration { /** * Indicates window id. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Indicates window id. * * @type { string } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ name: string; /** * Indicates window type * * @type { WindowType } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Indicates window type * * @type { WindowType } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ windowType: WindowType; /** * Indicates window context. * * @type { ?BaseContext } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Indicates window context. * * @type { ?BaseContext } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ ctx?: BaseContext; /** * Indicates display ID. * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Indicates display ID. * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ displayId?: number; /** * Indicates Parent window id * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Indicates Parent window id * * @type { ?number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ parentId?: number; /** * Indicates whether enable window decor, only support dialog, The default value is false. * * @type { ?boolean } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ decorEnabled?: boolean; /** * Indicates dialog window title when decor enabled. * * @type { ?string } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ title?: string; /** * Indicates window container zIndex. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ zIndex?: number; /** * Indicates whether to use default density. * * @type { ?boolean } * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ defaultDensityEnabled?: boolean; } /** * Limits of window. * * @interface WindowLimits * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Limits of window. * * @interface WindowLimits * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ interface WindowLimits { /** * The maximum width of the window. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * The maximum width of the window. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ maxWidth?: number; /** * The maximum height of the window. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * The maximum height of the window. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ maxHeight?: number; /** * The minimum width of the window. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * The minimum width of the window. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ minWidth?: number; /** * The minimum height of the window. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * The minimum height of the window. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ minHeight?: number; } /** * Rectangular area of the title buttons relative to the upper right corner of the window. * * @interface TitleButtonRect * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Rectangular area of the title buttons relative to the upper right corner of the window. * * @interface TitleButtonRect * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ interface TitleButtonRect { /** * The right of the Rect. * * @type { number } * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * The right of the Rect. * * @type { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ right: number; /** * The top of the Rect. * * @type { number } * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * The top of the Rect. * * @type { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ top: number; /** * The width of the Rect. * * @type { number } * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * The width of the Rect. * * @type { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ width: number; /** * The height of the Rect. * * @type { number } * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * The height of the Rect. * * @type { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ height: number; } /** * Rect change options * * @interface RectChangeOptions * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ interface RectChangeOptions { /** * Rect * * @type { Rect } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ rect: Rect, /** * Rect change reason * * @type { RectChangeReason } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ reason: RectChangeReason } /** * Avoid area options * * @interface AvoidAreaOptions * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * Avoid area options * * @interface AvoidAreaOptions * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ interface AvoidAreaOptions { /** * Avoid area type * * @type { AvoidAreaType } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * Avoid area type * * @type { AvoidAreaType } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ type: AvoidAreaType, /** * Avoid area * * @type { AvoidArea } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * Avoid area * * @type { AvoidArea } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ area: AvoidArea } /** * Window rect change reason. * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ enum RectChangeReason { /** * Default RectChangeReason. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ UNDEFINED = 0, /** * Window maximize. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ MAXIMIZE = 1, /** * Window recover. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ RECOVER = 2, /** * Window move. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ MOVE = 3, /** * Window drag. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ DRAG = 4, /** * Window drag start. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ DRAG_START = 5, /** * Window drag end. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ DRAG_END = 6, } /** * Create a window with a specific configuration * * @param { Configuration } config - Parameters for window creation. * @param { AsyncCallback } callback - Callback used to return the window created. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300001 - Repeated operation. * @throws { BusinessError } 1300006 - This window context is abnormal. * @throws { BusinessError } 1300008 - The display device is abnormal. * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Create a window with a specific configuration * When config.windowType == TYPE_FLOAT, the "ohos.permission.SYSTEM_FLOAT_WINDOW" permission is required * * @permission ohos.permission.SYSTEM_FLOAT_WINDOW * @param { Configuration } config - Parameters for window creation. * @param { AsyncCallback } callback - Callback used to return the window created. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300001 - Repeated operation. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300006 - This window context is abnormal. * @throws { BusinessError } 1300008 - The display device is abnormal. * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * Creates a child window or system window. This API uses an asynchronous callback to return the result. * * @permission ohos.permission.SYSTEM_FLOAT_WINDOW * @param { Configuration } config - Parameters used for creating the window. * @param { AsyncCallback } callback - Callback used to return the window created. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported.createWindow can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300001 - Repeated operation. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300006 - This window context is abnormal. * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 17 */ function createWindow(config: Configuration, callback: AsyncCallback): void; /** * Create a window with a specific configuration * * @param { Configuration } config - Parameters for window creation. * @returns { Promise } Promise used to return the window created. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300001 - Repeated operation. * @throws { BusinessError } 1300006 - This window context is abnormal. * @throws { BusinessError } 1300008 - The display device is abnormal. * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Create a window with a specific configuration * When config.windowType == TYPE_FLOAT, the "ohos.permission.SYSTEM_FLOAT_WINDOW" permission is required * * @permission ohos.permission.SYSTEM_FLOAT_WINDOW * @param { Configuration } config - Parameters for window creation. * @returns { Promise } Promise used to return the window created. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300001 - Repeated operation. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300006 - This window context is abnormal. * @throws { BusinessError } 1300008 - The display device is abnormal. * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * Create a window with a specific configuration * When config.windowType == TYPE_FLOAT, the "ohos.permission.SYSTEM_FLOAT_WINDOW" permission is required * * @permission ohos.permission.SYSTEM_FLOAT_WINDOW * @param { Configuration } config - Parameters for window creation. * @returns { Promise } Promise used to return the window created. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported.createWindow can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300001 - Repeated operation. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300006 - This window context is abnormal. * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 17 */ function createWindow(config: Configuration): Promise; /** * Create a sub window with a specific id and type, only support 7. * * @param { string } id - Indicates window id. * @param { WindowType } type - Indicates window type. * @param { AsyncCallback } callback - Callback used to return the subwindow created. * @syscap SystemCapability.WindowManager.WindowManager.Core * @FAModelOnly * @since 7 * @deprecated since 9 * @useinstead ohos.window#createWindow */ function create(id: string, type: WindowType, callback: AsyncCallback): void; /** * Create a sub window with a specific id and type, only support 7. * * @param { string } id - Indicates window id. * @param { WindowType } type - Indicates window type. * @returns { Promise } Promise used to return the subwindow created. * @syscap SystemCapability.WindowManager.WindowManager.Core * @FAModelOnly * @since 7 * @deprecated since 9 * @useinstead ohos.window#createWindow */ function create(id: string, type: WindowType): Promise; /** * Create a system or float window with a specific id and type. * * @param { BaseContext } ctx - Indicates the context on which the window depends * @param { string } id - Indicates window id. * @param { WindowType } type - Indicates window type. * @returns { Promise } Promise used to return the window created. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 * @deprecated since 9 * @useinstead ohos.window#createWindow */ function create(ctx: BaseContext, id: string, type: WindowType): Promise; /** * Create a system or float window with a specific id and type. * * @param { BaseContext } ctx - Indicates the context on which the window depends * @param { string } id - Indicates window id. * @param { WindowType } type - Indicates window type. * @param { AsyncCallback } callback - Callback used to return the window created. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 * @deprecated since 9 * @useinstead ohos.window#createWindow */ function create(ctx: BaseContext, id: string, type: WindowType, callback: AsyncCallback): void; /** * Find the window by id. * * @param { string } id - Indicates window id. * @param { AsyncCallback } callback - Callback used to return the window found. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window#findWindow */ function find(id: string, callback: AsyncCallback): void; /** * Find the window by id. * * @param { string } id - Indicates window id. * @returns { Promise } Window found. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window#findWindow */ function find(id: string): Promise; /** * Find the window by name. * * @param { string } name - Indicates window name. * @returns { Window } Window found. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Find the window by name. * * @param { string } name - Indicates window name. * @returns { Window } Window found. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Finds a window based on the name. * * @param { string } name - Window name, that is, the value of name in Configuration. * @returns { Window } Window found. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ function findWindow(name: string): Window; /** * Get the final show window. * * @param { AsyncCallback } callback - Callback used to return the top window obtained. * @syscap SystemCapability.WindowManager.WindowManager.Core * @FAModelOnly * @since 6 * @deprecated since 9 * @useinstead ohos.window#getLastWindow */ function getTopWindow(callback: AsyncCallback): void; /** * Get the final show window. * * @returns { Promise } Promise used to return the top window obtained. * @syscap SystemCapability.WindowManager.WindowManager.Core * @FAModelOnly * @since 6 * @deprecated since 9 * @useinstead ohos.window#getLastWindow */ function getTopWindow(): Promise; /** * Get the final show window. * * @param { BaseContext } ctx - Indicates the context on which the window depends * @returns { Promise } Promise used to return the top window obtained. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 * @deprecated since 9 * @useinstead ohos.window#getLastWindow */ function getTopWindow(ctx: BaseContext): Promise; /** * Get the final show window. * * @param { BaseContext } ctx - Indicates the context on which the window depends * @param { AsyncCallback } callback - Callback used to return the top window obtained. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 * @deprecated since 9 * @useinstead ohos.window#getLastWindow */ function getTopWindow(ctx: BaseContext, callback: AsyncCallback): void; /** * Get the final show window. * * @param { BaseContext } ctx - Current application context. * @param { AsyncCallback } callback - Callback used to return the top window obtained. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300006 - This window context is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Get the final show window. * * @param { BaseContext } ctx - Current application context. * @param { AsyncCallback } callback - Callback used to return the top window obtained. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300006 - This window context is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Obtains the top window of the current application. This API uses an asynchronous callback to return the result. * If no child window is available, the main window of the application is returned. * * @param { BaseContext } ctx - Current application context. * @param { AsyncCallback } callback - Callback used to return the top window obtained. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. Top window or main window is null or destroyed. * @throws { BusinessError } 1300006 - This window context is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ function getLastWindow(ctx: BaseContext, callback: AsyncCallback): void; /** * Get the final show window. * * @param { BaseContext } ctx - Current application context. * @returns { Promise } Promise used to return the top window obtained. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300006 - This window context is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Get the final show window. * * @param { BaseContext } ctx - Current application context. * @returns { Promise } Promise used to return the top window obtained. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300006 - This window context is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Obtains the top window of the current application. This API uses a promise to return the result. * If no child window is available, the main window of the application is returned. * * @param { BaseContext } ctx - Current application context. * @returns { Promise } Promise used to return the top window obtained. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. Top window or main window is null or destroyed. * @throws { BusinessError } 1300006 - This window context is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ function getLastWindow(ctx: BaseContext): Promise; /** * Minimize all app windows. * * @param { number } id - ID of the display. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Minimize all app windows. * * @param { number } id - ID of the display. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ function minimizeAll(id: number, callback: AsyncCallback): void; /** * Minimize all app windows. * * @param { number } id - ID of the display. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Minimize all app windows. * * @param { number } id - ID of the display. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ function minimizeAll(id: number): Promise; /** * Toggle shown state for all app windows. Minimize or restore all app windows. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Toggle shown state for all app windows. Minimize or restore all app windows. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ function toggleShownStateForAllAppWindows(callback: AsyncCallback): void; /** * Toggle shown state for all app windows. Minimize or restore all app windows. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Toggle shown state for all app windows. Minimize or restore all app windows. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ function toggleShownStateForAllAppWindows(): Promise; /** * Set the layout mode of a window. * * @param { WindowLayoutMode } mode - The layout mode of a window. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Set the layout mode of a window. * * @param { WindowLayoutMode } mode - The layout mode of a window. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ function setWindowLayoutMode(mode: WindowLayoutMode, callback: AsyncCallback): void; /** * Set the layout mode of a window. * * @param { WindowLayoutMode } mode - The layout mode of a window. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Set the layout mode of a window. * * @param { WindowLayoutMode } mode - The layout mode of a window. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ function setWindowLayoutMode(mode: WindowLayoutMode): Promise; /** * Sets whether to enable gesture navigation. * * @param { boolean } enable - Gesture navigation if true, or disable if false. * @param { AsyncCallback } callback - The callback of setGestureNavigationEnabled. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 10 */ function setGestureNavigationEnabled(enable: boolean, callback: AsyncCallback): void; /** * Sets whether to enable gesture navigation. * * @param { boolean } enable - Gesture navigation if true, or disable if false. * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 10 */ function setGestureNavigationEnabled(enable: boolean): Promise; /** * Set watermark image. * * @param { image.PixelMap } pixelMap - Watermark image. * @param { boolean } enable - Show watermark if true. * @returns { Promise } - Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 10 */ function setWaterMarkImage(pixelMap: image.PixelMap, enable: boolean): Promise; /** * Set watermark image. * * @param { image.PixelMap } pixelMap - Watermark image. * @param { boolean } enable - Show watermark if true. * @param { AsyncCallback } callback - The callback of setWaterMarkImage. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 10 */ function setWaterMarkImage(pixelMap: image.PixelMap, enable: boolean, callback: AsyncCallback): void; /** * Shift window focus within the same application. And the window type contains only main window and subwindow. * * @param { number } sourceWindowId - Window id which the focus shift from. * @param { number } targetWindowId - Window id which the focus shift to. * @returns { Promise } - Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Shifts the window focus from the source window to the target window in the same application. * The window focus can be shifted between the main window and a child window. * * @param { number } sourceWindowId - Window id which the focus shift from. * @param { number } targetWindowId - Window id which the focus shift to. * @returns { Promise } - Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ function shiftAppWindowFocus(sourceWindowId: number, targetWindowId: number): Promise; /** * Transfers an input event from one window to another within the same application, particularly in split-window scenarios. * It takes effect only for the main window and its child windows on 2-in-1 devices. * * @param { number } sourceWindowId - ID of the source window. You are advised to call getWindowProperties() to obtain the window ID. * @param { number } targetWindowId - ID of the target window. You are advised to call getWindowProperties() to obtain the window ID. * @returns { Promise } - Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ function shiftAppWindowPointerEvent(sourceWindowId: number, targetWindowId: number): Promise; /** * Shift window touch event within the same application. And the window type contains only main window and subwindow. * * @param { number } sourceWindowId - Window id which the touch event shift from. * @param { number } targetWindowId - Window id which the touch event shift to. * @param { number } fingerId - Finger id in touch event. * @returns { Promise } - Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Function shiftAppWindowTouchEvent can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1. Invalid parameter range. * @syscap SystemCapability.Window.SessionManager * @since 20 */ function shiftAppWindowTouchEvent(sourceWindowId: number, targetWindowId: number, fingerId: number): Promise; /** * Get info of visible windows. * * @returns { Promise> } - Promise that returns windowInfo list. * @throws { BusinessError } 202 - Permission verification failed, non-system application uses system API. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 12 */ /** * Get info of visible windows. * * @permission ohos.permission.VISIBLE_WINDOW_INFO * @returns { Promise> } - Promise that returns windowInfo list. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 801 - Capability not supported. Function getVisibleWindowInfo can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 18 */ function getVisibleWindowInfo(): Promise>; /** * gets snapshot of window * * @param { number } windowId - Indicates target window id. * @returns { Promise } - Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - This operation is not accessible. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ function getSnapshot(windowId: number): Promise; /** * Get windows by coordinate. * * @param { number } displayId - Indicate the id of display. * @param { number } windowNumber - Indicate the Number of query windows. * @param { number } x - Indicate the X-coordinate of the window. * @param { number } y - Indicate the Y-coordinate of the window. * @returns { Promise> } Promise used to return the window. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ function getWindowsByCoordinate(displayId: number, windowNumber?: number, x?: number, y?: number): Promise>; /** * Get Layout info of all windows on the selected display. * * @param { number } displayId - Indicate the id of display. * @returns { Promise> } Promise used to return the WindowLayoutInfo. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ /** * Get Layout info of all windows on the selected display. * * @param { number } displayId - Indicate the id of display. * @returns { Promise> } Promise used to return the WindowLayoutInfo. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. function getAllWindowLayoutInfo can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ function getAllWindowLayoutInfo(displayId: number): Promise>; /** * List the window modes of the foreground window on the specified display. * * @param { number } displayId - Indicate the id of display. * @returns { Promise } Promise used to return the window modes. * @throws { BusinessError } 801 - Capability not supported. function getGlobalWindowMode can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1. Invalid parameter range. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ function getGlobalWindowMode(displayId?: number): Promise; /** * Get the name of the top navigation destination. * * @param { number } windowId - Indicates target window id. * @returns { Promise } The name of the top navigation destination. * @throws { BusinessError } 202 - Permission verification failed, non-system application uses system API. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1. Invalid parameter range. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ function getTopNavDestinationName(windowId: number): Promise; /** * Register the callback of systemBarTintChange * * @param { 'systemBarTintChange' } type - The value is fixed at 'systemBarTintChange', indicating the property change event of the system bar. * @param { Callback } callback - Callback used to return the properties of the system bar. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'8', '1.2':'20'} * @arkts 1.1&1.2 */ function on(type: 'systemBarTintChange', callback: Callback): void; /** * Unregister the callback of systemBarTintChange * * @param { 'systemBarTintChange' } type - The value is fixed at 'systemBarTintChange', indicating the property change event of the system bar. * @param { Callback } callback - Callback used to return the properties of the system bar. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'8', '1.2':'20'} * @arkts 1.1&1.2 */ function off(type: 'systemBarTintChange', callback?: Callback): void; /** * Register the callback for gesture navigation enabled changes. * * @param { 'gestureNavigationEnabledChange' } type the event of gesture navigation enabled changes. * @param { Callback } callback Callback used to return the result whether gesture navigation enabled or not. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10', '1.2':'20'} * @arkts 1.1&1.2 */ function on(type: 'gestureNavigationEnabledChange', callback: Callback): void; /** * Unregister the callback for gesture navigation enabled changes. * * @param { 'gestureNavigationEnabledChange' } type the event of gesture navigation enabled changes. * @param { Callback } callback Callback used to return the result whether gesture navigation enabled or not. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10', '1.2':'20'} * @arkts 1.1&1.2 */ function off(type: 'gestureNavigationEnabledChange', callback?: Callback): void; /** * Register the callback for watermark flag change. * * @param { 'waterMarkFlagChange' } type the event of watermark flag change. * @param { Callback } callback Callback used to return the result whether watermark flag change or not. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10', '1.2':'20'} * @arkts 1.1&1.2 */ function on(type: 'waterMarkFlagChange', callback: Callback): void; /** * Unregister the callback for watermark flag change. * * @param { 'waterMarkFlagChange' } type the event of watermark flag change. * @param { Callback } callback Callback used to return the result whether watermark flag change or not. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; *
2. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10', '1.2':'20'} * @arkts 1.1&1.2 */ function off(type: 'waterMarkFlagChange', callback?: Callback): void; /** * Sets starting window background color * * @param { string } moduleName - module Name that needs to be set. * @param { string } abilityName - ability Name that needs to be set. * @param { ColorMetrics } color - Color metrics. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported.function setStartWindowBackgroundColor can not to work correctly due to limited device capabilities. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1. Invalid parameter range. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ function setStartWindowBackgroundColor(moduleName: string, abilityName: string, color: ColorMetrics): Promise; /** * Notify screenshot event * * @param { ScreenshotEventType } eventType - Screenshot event type. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1. Invalid parameter range. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 20 */ function notifyScreenshotEvent(eventType: ScreenshotEventType): Promise; /** * Display orientation * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Display orientation * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Display orientation * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ enum Orientation { /** * Default value. The direction mode is not clearly defined. It is determined by the system. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Default value. The direction mode is not clearly defined. It is determined by the system. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Default value. The direction mode is not clearly defined. It is determined by the system. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ UNSPECIFIED = 0, /** * Display in portrait orientation. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Display in portrait orientation. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Display in portrait orientation. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ PORTRAIT = 1, /** * Display in landscape orientation. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Display in landscape orientation. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Display in landscape orientation. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ LANDSCAPE = 2, /** * Display in inverted portrait orientation. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Display in inverted portrait orientation. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Display in inverted portrait orientation. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ PORTRAIT_INVERTED = 3, /** * Display in inverted landscape orientation. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Display in inverted landscape orientation. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Display in inverted landscape orientation. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ LANDSCAPE_INVERTED = 4, /** * Follow the rotation of the sensor, ignore auto rotation lock. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Follow the rotation of the sensor, ignore auto rotation lock. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ AUTO_ROTATION = 5, /** * Follow the rotation of the sensor, only work in the vertical direction, ignore auto rotation lock. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Follow the rotation of the sensor, only work in the vertical direction, ignore auto rotation lock. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ AUTO_ROTATION_PORTRAIT = 6, /** * Follow the rotation of the sensor, only work in the horizontal direction, ignore auto rotation lock. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Follow the rotation of the sensor, only work in the horizontal direction, ignore auto rotation lock. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ AUTO_ROTATION_LANDSCAPE = 7, /** * Follow the rotation of the sensor, controlled by auto rotation lock. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Follow the rotation of the sensor, controlled by auto rotation lock. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ AUTO_ROTATION_RESTRICTED = 8, /** * Follow the rotation of the sensor, only work in the vertical direction, controlled by auto rotation lock. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Follow the rotation of the sensor, only work in the vertical direction, controlled by auto rotation lock. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ AUTO_ROTATION_PORTRAIT_RESTRICTED = 9, /** * Follow the rotation of the sensor, only work in the horizontal direction, controlled by auto rotation lock. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Follow the rotation of the sensor, only work in the horizontal direction, controlled by auto rotation lock. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ AUTO_ROTATION_LANDSCAPE_RESTRICTED = 10, /** * Locked mode, keep the same direction as previous one. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Locked mode, keep the same direction as previous one. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ LOCKED = 11, /** * Follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ AUTO_ROTATION_UNSPECIFIED = 12, /** * Display in portrait orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ USER_ROTATION_PORTRAIT = 13, /** * Display in landscape orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ USER_ROTATION_LANDSCAPE = 14, /** * Display in inverted portrait orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ USER_ROTATION_PORTRAIT_INVERTED = 15, /** * Display in inverted landscape orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ USER_ROTATION_LANDSCAPE_INVERTED = 16, /** * Follow the desktop rotate mode. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ FOLLOW_DESKTOP = 17 } /** * Type of blur style * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ enum BlurStyle { /** * Close blur. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ OFF = 0, /** * Blur style thin. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ THIN = 1, /** * Blur style regular. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ REGULAR = 2, /** * Blur style thick. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ THICK = 3 } /** * Enum for window callback event type * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ /** * Enum for window callback event type * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ enum WindowEventType { /** * The value of window event is window show * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ /** * The value of window event is window show * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ WINDOW_SHOWN = 1, /** * The value of window event is window active * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ /** * The value of window event is window active * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ WINDOW_ACTIVE = 2, /** * The value of window event is window inactive * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ /** * The value of window event is window inactive * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ WINDOW_INACTIVE = 3, /** * The value of window event is window hide * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ /** * The value of window event is window hide * * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ WINDOW_HIDDEN = 4, /** * The value of window event is window destroy * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ WINDOW_DESTROYED = 7 } /** * Enum for window maximize presentation * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ enum MaximizePresentation { /** * The value means follow immersive state which set by app * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ FOLLOW_APP_IMMERSIVE_SETTING = 0, /** * The value means exit immersive state * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ EXIT_IMMERSIVE = 1, /** * The value means enter immersive state * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ ENTER_IMMERSIVE = 2, /** * The value means enter immersive state and the title bar and dock bar cannot be shown, when the mouse hovers over hot area. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ ENTER_IMMERSIVE_DISABLE_TITLE_AND_DOCK_HOVER = 3, } /** * the optional move configuration used in moveWindowToAsync/moveWindowToGlobal * * @interface MoveConfiguration * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'15', '1.2':'20'} * @arkts 1.1&1.2 */ interface MoveConfiguration { /** * The display id of the screen * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'15', '1.2':'20'} * @arkts 1.1&1.2 */ displayId?: number; } /** * Specific system bar type. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 11 */ /** * Specific system bar type. * * @typedef {'status' | 'navigation' | 'navigationIndicator'} * @syscap SystemCapability.Window.SessionManager * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ type SpecificSystemBar = 'status' | 'navigation' | 'navigationIndicator'; /** * Describes the window transition type * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ enum WindowTransitionType { /** * Destroy transition * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ DESTROY = 0, } /** * Describes the window animation type * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @since 20 */ enum AnimationType { /** * Window animation type fade in out * * @syscap SystemCapability.Window.SessionManager * @since 20 */ FADE_IN_OUT = 0, /** * Window animation type fade in * * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ FADE_IN = 1, } /** * Describes the window animation curve * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ enum WindowAnimationCurve { /** * Animation curve type linear * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ LINEAR = 0, /** * Animation curve type interpolation spring * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ INTERPOLATION_SPRING = 1, /** * Animation curve type cubic bezier * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ CUBIC_BEZIER = 2, } /** * Window animation config * * @interface WindowAnimationConfig * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ interface WindowAnimationConfig { /** * Curve of the animation * * @type { WindowAnimationCurve } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ curve: WindowAnimationCurve; /** * Duration of the animation * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ duration?: number; /** * Param of animation curve * * @type { ?WindowAnimationCurveParam } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ param?: WindowAnimationCurveParam; } /** * The animation configuration of window transition * * @interface TransitionAnimation * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ interface TransitionAnimation { /** * The config of window animation * * @type { WindowAnimationConfig } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ config: WindowAnimationConfig; /** * The opacity of window * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ opacity?: number; } /** * The params of start animation * * @interface StartAnimationSystemParams * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ interface StartAnimationSystemParams { /** * The type of window animation * * @type { AnimationType } * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ type: AnimationType; /** * The configuration of start animation * * @type { ?WindowAnimationConfig } * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ animationConfig?: WindowAnimationConfig; } /** * The params of start animation * * @interface StartAnimationParams * @syscap SystemCapability.Window.SessionManager * @since 20 */ interface StartAnimationParams { /** * The type of window animation * * @type { AnimationType } * @syscap SystemCapability.Window.SessionManager * @since 20 */ type: AnimationType; } /** * Window create params * * @interface WindowCreateParams * @syscap SystemCapability.Window.SessionManager * @since 20 */ interface WindowCreateParams { /** * The params of start animation * * @type { ?StartAnimationParams } * @syscap SystemCapability.Window.SessionManager * @since 20 */ animationParams?: StartAnimationParams; /** * The params of system start animation * * @type { ?StartAnimationSystemParams } * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ systemAnimationParams?: StartAnimationSystemParams; } /** * The information of keyboard * * @interface KeyboardInfo * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'18', '1.2':'20'} * @arkts 1.1&1.2 */ interface KeyboardInfo { /** * The position and size of keyboard before animation. * * @type { Rect } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ beginRect: Rect; /** * The position and size of keyboard after animation completed. * * @type { Rect } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ endRect: Rect; /** * Indicates whether animation exists. * * @type { ?boolean } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ animated?: boolean; /** * The configuration of keyboard animation. * * @type { ?WindowAnimationConfig } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ config?: WindowAnimationConfig; } /** * The policy of key frame. * * @interface KeyFramePolicy * @syscap SystemCapability.Window.SessionManager * @since 20 */ interface KeyFramePolicy { /** * Whether to use key frame. * * @type { boolean } * @syscap SystemCapability.Window.SessionManager * @since 20 */ enable: boolean; /** * Set the drag interval to notify rect change in millisecond. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @since 20 */ interval?: number; /** * Set the drag distance to notify rect change in px. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @since 20 */ distance?: number; /** * Set the rect change animation duration in millisecond. * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @since 20 */ animationDuration?: number; /** * Set then rect change animation delay in millisecond * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @since 20 */ animationDelay?: number; } /** * Window * * @interface Window * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 */ /** * Window * * @interface Window * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ interface Window { /** * Hide window. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 7 */ /** * Hide window. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ hide(callback: AsyncCallback): void; /** * Hide window. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 7 */ /** * Hide window. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ hide(): Promise; /** * Hide window with animation. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ /** * Hide window with animation. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ hideWithAnimation(callback: AsyncCallback): void; /** * Hide window with animation. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ /** * Hide window with animation. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ hideWithAnimation(): Promise; /** * Show window. * * @param { AsyncCallback } callback - Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#showWindow */ show(callback: AsyncCallback): void; /** * Show window. * * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#showWindow */ show(): Promise; /** * Show window. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Show window. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Shows 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. * For the main window of an application, this API moves it at the top when the main window is already displayed. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ showWindow(callback: AsyncCallback): void; /** * Show window. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Show window. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Shows 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. * For the main window of an application, this API moves it at the top when the main window is already displayed. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ showWindow(): Promise; /** * Show window. * * @param { ShowWindowOptions } options - options of window shown * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Function showWindow can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300016 - Parameter validation error. Possible cause: 1. The value of the parameter is out of the allowed range; * 2. The length of the parameter exceeds the allowed length; * 3. The parameter format is incorrect. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ showWindow(options: ShowWindowOptions): Promise; /** * Show window with animation. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ /** * Show window with animation. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ showWithAnimation(callback: AsyncCallback): void; /** * Show window with animation. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ /** * Show window with animation. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ showWithAnimation(): Promise; /** * Destroy the window. * * @param { AsyncCallback } callback - Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#destroyWindow */ destroy(callback: AsyncCallback): void; /** * Destroy the window. * * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#destroyWindow */ destroy(): Promise; /** * Destroy the window. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Destroy the window. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Destroys 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. * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ destroyWindow(callback: AsyncCallback): void; /** * Destroy the window. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Destroy the window. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Destroys 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. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ destroyWindow(): Promise; /** * Set the position of a window. * * @param { number } x - Indicate the X-coordinate of the window. * @param { number } y - Indicate the Y-coordinate of the window. * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#moveWindowTo */ moveTo(x: number, y: number): Promise; /** * Set the position of a window. * * @param { number } x - Indicate the X-coordinate of the window. * @param { number } y - Indicate the Y-coordinate of the window. * @param { AsyncCallback } callback - Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#moveWindowTo */ moveTo(x: number, y: number, callback: AsyncCallback): void; /** * Set the position of a window. * * @param { number } x - Indicate the X-coordinate of the window. * @param { number } y - Indicate the Y-coordinate of the window. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Set the position of a window. * * @param { number } x - Indicate the X-coordinate of the window. * @param { number } y - Indicate the Y-coordinate of the window. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Set the position of a window. * * @param { number } x - Indicate the X-coordinate of the window. * @param { number } y - Indicate the Y-coordinate of the window. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ moveWindowTo(x: number, y: number): Promise; /** * Set the position of a window. * * @param { number } x - Indicate the X-coordinate of the window. * @param { number } y - Indicate the Y-coordinate of the window. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Set the position of a window. * * @param { number } x - Indicate the X-coordinate of the window. * @param { number } y - Indicate the Y-coordinate of the window. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Set the position of a window. * * @param { number } x - Indicate the X-coordinate of the window. * @param { number } y - Indicate the Y-coordinate of the window. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ moveWindowTo(x: number, y: number, callback: AsyncCallback): void; /** * Move window to the position. * * @param { number } x - Indicate the X-coordinate of the window. * @param { number } y - Indicate the Y-coordinate of the window. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300010 - The operation in the current window status is invalid. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ moveWindowToAsync(x: number, y: number): Promise; /** * Move window to the position. * * @param { number } x - Indicate the X-coordinate of the window. * @param { number } y - Indicate the Y-coordinate of the window. * @param { ?MoveConfiguration } moveConfiguration - Indicate the window move configuration. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300010 - The operation in the current window status is invalid. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ moveWindowToAsync(x: number, y: number, moveConfiguration?: MoveConfiguration): Promise; /** * Move window to the position relative to current screen. * * @param { number } x - Indicate the X-coordinate of the window relative to current screen. * @param { number } y - Indicate the Y-coordinate of the window relative to current screen. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300010 - The operation in the current window status is invalid. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 13 */ moveWindowToGlobal(x: number, y: number): Promise; /** * Move window to the position relative to current screen. * * @param { number } x - Indicate the X-coordinate of the window relative to current screen. * @param { number } y - Indicate the Y-coordinate of the window relative to current screen. * @param { ?MoveConfiguration } moveConfiguration - Indicate the window move configuration. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300010 - The operation in the current window status is invalid. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ moveWindowToGlobal(x: number, y: number, moveConfiguration?: MoveConfiguration): Promise; /** * Move window to the position relative to the main screen. * * @param { number } x - Indicate the X-coordinate of the window relative to the main screen. * @param { number } y - Indicate the Y-coordinate of the window relative to the main screen. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300010 - The operation in the current window status is invalid. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1.Invalid parameter range. * @syscap SystemCapability.Window.SessionManager * @since 20 */ moveWindowToGlobalDisplay(x: number, y: number): Promise; /** * Set the size of a window . * * @param { number } width - Indicates the width of the window. * @param { number } height - Indicates the height of the window. * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#resize */ resetSize(width: number, height: number): Promise; /** * Set the size of a window . * * @param { number } width - Indicates the width of the window. * @param { number } height - Indicates the height of the window. * @param { AsyncCallback } callback - Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#resize */ resetSize(width: number, height: number, callback: AsyncCallback): void; /** * Set the size of a window . * * @param { number } width - Indicates the width of the window. The width should be greater than 0. * @param { number } height - Indicates the height of the window. The height should be greater than 0. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Set the size of a window . * * @param { number } width - Indicates the width of the window. The width should be greater than 0. * @param { number } height - Indicates the height of the window. The height should be greater than 0. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Set the size of a window . * * @param { number } width - Indicates the width of the window. The width should be greater than 0. * @param { number } height - Indicates the height of the window. The height should be greater than 0. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ resize(width: number, height: number): Promise; /** * Set the size of a window . * * @param { number } width - Indicates the width of the window. The width should be greater than 0. * @param { number } height - Indicates the height of the window. The height should be greater than 0. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Set the size of a window . * * @param { number } width - Indicates the width of the window. The width should be greater than 0. * @param { number } height - Indicates the height of the window. The height should be greater than 0. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Set the size of a window . * * @param { number } width - Indicates the width of the window. The width should be greater than 0. * @param { number } height - Indicates the height of the window. The height should be greater than 0. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ resize(width: number, height: number, callback: AsyncCallback): void; /** * Set the size of a window. * * @param { number } width - Indicates the width of the window. The width should be greater than 0. * @param { number } height - Indicates the height of the window. The height should be greater than 0. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300010 - The operation in the current window status is invalid. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ resizeAsync(width: number, height: number): Promise; /** * Set whether to follow parent window layout. Only sub windows and dialogs are available. * * @param { boolean } enabled - If true, this window updates the layout follow the parent window. * If false, this window does not update the layout follow the parent window. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @atomicservice * @since 17 */ setFollowParentWindowLayoutEnabled(enabled: boolean): Promise; /** * Set whether the first level sub window supports maintaining the same relative position with the main window. * * @param { boolean } enabled - The value true means the first level sub window supports maintaining * the same relative position with the main window, and false means the opposite. * @param { WindowAnchor } [anchor] - Window anchor point that setting * when the relative position between the primary sub window and the main window remains unchanged. * @param { number } [offsetX] - The x-axis offset * between the anchor point of the first level sub window and the anchor point of the main window. * @param { number } [offsetY] - The y-axis offset * between the anchor point of the first level sub window and the anchor point of the main window. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. * Function setRelativePositionToParentWindowEnabled can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1. Invalid parameter range. * @syscap SystemCapability.Window.SessionManager * @since 20 */ setRelativePositionToParentWindowEnabled(enabled: boolean, anchor?: WindowAnchor, offsetX?: number, offsetY?: number): Promise; /** * Set the type of a window. * * @param { WindowType } type - Indicate the type of a window. * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 7 * @deprecated since 9 */ setWindowType(type: WindowType): Promise; /** * Set the type of a window. * * @param { WindowType } type - Indicate the type of a window. * @param { AsyncCallback } callback - Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 7 * @deprecated since 9 */ setWindowType(type: WindowType, callback: AsyncCallback): void; /** * Set the mode of a window. * * @param { WindowMode } mode - Indicate the mode of a window. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Set the mode of a window. * * @param { WindowMode } mode - Indicate the mode of a window. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ setWindowMode(mode: WindowMode): Promise; /** * Set the mode of a window. * * @param { WindowMode } mode - Indicate the mode of a window. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Set the mode of a window. * * @param { WindowMode } mode - Indicate the mode of a window. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ setWindowMode(mode: WindowMode, callback: AsyncCallback): void; /** * Get the properties of current window * * @param { AsyncCallback } callback - Callback used to return the window properties. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 * @deprecated since 9 * @useinstead ohos.window.Window#getWindowProperties */ getProperties(callback: AsyncCallback): void; /** * Get the window rectangular area quadruple {left,top,weight,height}, left and top represent relative to screen coordinates * and are affected by parent window scaling, weight and height are the scaling width and height. * * @returns { Rect } The quadruple {left,top,weight,height} represents respectively the X-coordinate * and Y-coordinate of the window relative to current screen, the scaled window width and scaled window height. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'13', '1.2':'20'} * @arkts 1.1&1.2 */ getGlobalRect(): Rect; /** * Get the properties of current window * * @returns { Promise } Promise used to return the window properties. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 * @deprecated since 9 * @useinstead ohos.window.Window#getWindowProperties */ getProperties(): Promise; /** * Get the properties of current window * * @returns { WindowProperties } Return the window properties. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Get the properties of current window * * @returns { WindowProperties } Return the window properties. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Get the properties of current window * * @returns { WindowProperties } Return the window properties. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ getWindowProperties(): WindowProperties; /** * Get the window density of current window. * * @returns { WindowDensityInfo } Return system density, default density and custom density of window. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ getWindowDensityInfo(): WindowDensityInfo; /** * Set whether the current window follows the default density of its screen. * * @param { boolean } enabled - Use default density if true, or follow system density change if false. * @throws { BusinessError } 202 - Permission verification * failed. A non-system application calls a system API. * @throws { BusinessError } 801 - Capability not supported. * Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ setDefaultDensityEnabled(enabled: boolean): void; /** * Set window container background color in the active and inactive states. * * @param { string } activeColor - window container color in active. * @param { string } inactiveColor - window container color in inactive. * @throws { BusinessError } 202 - Permission verification * failed. A non-system application calls a system API. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ setWindowContainerModalColor(activeColor: string, inactiveColor: string): void; /** * Determine whether the window spans multiple screens and displays in full screen mode. * * @returns { Promise } Whether the window spans multiple screens and displays in full screen mode. * The value true means that the window spans multiple screens and displays in full screen mode,and false means the opposite. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ isMainWindowFullScreenAcrossDisplays(): Promise; /** * Get the avoid area * * @param { AvoidAreaType } type - Type of the area * @param { AsyncCallback } callback - Callback used to return the area. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#getWindowAvoidArea */ getAvoidArea(type: AvoidAreaType, callback: AsyncCallback): void; /** * Get the avoid area * * @param { AvoidAreaType } type - Type of the area * @returns { Promise } Area where the window cannot be displayed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#getWindowAvoidArea */ getAvoidArea(type: AvoidAreaType): Promise; /** * Get the avoid area * * @param { AvoidAreaType } type - Type of the area * @returns { AvoidArea } Area where the window cannot be displayed. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Get the avoid area * * @param { AvoidAreaType } type - Type of the area * @returns { AvoidArea } Area where the window cannot be displayed. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Get the avoid area * * @param { AvoidAreaType } type - Type of the area * @returns { AvoidArea } Area where the window cannot be displayed. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ getWindowAvoidArea(type: AvoidAreaType): AvoidArea; /** * Set whether system window type could obtain avoid area. * * @param { boolean } enabled - If true, the system window type can obtain avoid area. If false, the avoid area obtained by the system window type will always be empty. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ setSystemAvoidAreaEnabled(enabled: boolean): Promise; /** * Get whether system window type could obtain avoid area. * * @returns { boolean } enable - If true, the system window type can obtain avoid area. If false, the avoid area obtained by the system window type will always be empty. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ isSystemAvoidAreaEnabled(): boolean; /** * Set the flag of the window is shown full screen * * @param { boolean } isFullScreen - The flag of the window is shown full screen * @param { AsyncCallback } callback - Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowSystemBarEnable */ setFullScreen(isFullScreen: boolean, callback: AsyncCallback): void; /** * Set the flag of the window is shown full screen * * @param { boolean } isFullScreen - The flag of the window is shown full screen * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowSystemBarEnable */ setFullScreen(isFullScreen: boolean): Promise; /** * Set the property of the window can layout in full screen * * @param { boolean } isLayoutFullScreen - The window can layout in full screen * @param { AsyncCallback } callback - Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowLayoutFullScreen */ setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback): void; /** * Set the property of the window can layout in full screen * * @param { boolean } isLayoutFullScreen - The window can layout in full screen * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowLayoutFullScreen */ setLayoutFullScreen(isLayoutFullScreen: boolean): Promise; /** * Set the property of the window can layout in full screen * * @param { boolean } isLayoutFullScreen - The window can layout in full screen * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Set the property of the window can layout in full screen * * @param { boolean } isLayoutFullScreen - The window can layout in full screen * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since 12 * @deprecated since 12 * @useinstead ohos.window.Window#setWindowLayoutFullScreen */ setWindowLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback): void; /** * Sets whether the main window layout or the child window layout is immersive. * * @param { boolean } isLayoutFullScreen - Whether the window layout is immersive * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets whether the main window layout or the child window layout is immersive. * * @param { boolean } isLayoutFullScreen - Whether the window layout is immersive * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowLayoutFullScreen(isLayoutFullScreen: boolean): Promise; /** * Set the system bar to have visible. * * @param { Array<'status' | 'navigation'> } names - The set of system bar * @param { AsyncCallback } callback - Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowSystemBarEnable */ setSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallback): void; /** * Set the system bar to have visible. * * @param { Array<'status' | 'navigation'> } names - The set of system bar * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowSystemBarEnable */ setSystemBarEnable(names: Array<'status' | 'navigation'>): Promise; /** * Set the system bar to have visible. * * @param { Array<'status' | 'navigation'> } names - The set of system bar * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Set the system bar to have visible. * * @param { Array<'status' | 'navigation'> } names - The set of system bar * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Set the system bar to have visible. * * @param { Array<'status' | 'navigation'> } names - The set of system bar * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1.Mandatory parameters are left unspecified; * 2.Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since 12 * @deprecated since 12 * @useinstead ohos.window.Window#setWindowSystemBarEnable */ setWindowSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallback): void; /** * Sets whether to show the system bar of the main window. * * @param { Array<'status' | 'navigation'> } names - The set of system bar types * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets whether to show the system bar of the main window. * * @param { Array<'status' | 'navigation'> } names - The set of system bar types * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Sets whether to show the system bar of the main window. * * @param { Array<'status' | 'navigation'> } names - The set of system bar types * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1.Mandatory parameters are left unspecified; * 2.Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowSystemBarEnable(names: Array<'status' | 'navigation'>): Promise; /** * Sets whether to show the specific system bar of the main window. * * @param {SpecificSystemBar} name - Type of the system bar to be shown or hidden * @param {boolean} enable - Show specific system bar if true, or hide specific system bar if false. * @returns { Promise } Promise that returns no value. * @throws {BusinessError} 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws {BusinessError} 1300002 - This window state is abnormal. * @throws {BusinessError} 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 11 */ /** * Sets whether to show the specific system bar of the main window. * * @param {SpecificSystemBar} name - Type of the system bar to be shown or hidden * @param {boolean} enable - Show specific system bar if true, or hide specific system bar if false. * @param {boolean} enableAnimation - Whether using animation during this setting, using animation if true or not using animation if false. * @returns { Promise } Promise that returns no value. * @throws {BusinessError} 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws {BusinessError} 1300002 - This window state is abnormal. * @throws {BusinessError} 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setSpecificSystemBarEnabled(name: SpecificSystemBar, enable: boolean, enableAnimation?: boolean): Promise; /** * Set the properties of system bar * * @param { SystemBarProperties } systemBarProperties - The properties of system bar * @param { AsyncCallback } callback - Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowSystemBarProperties */ setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback): void; /** * Set the properties of system bar * * @param { SystemBarProperties } systemBarProperties - The properties of system bar * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowSystemBarProperties */ setSystemBarProperties(systemBarProperties: SystemBarProperties): Promise; /** * Set the properties of system bar * * @param { SystemBarProperties } systemBarProperties - The properties of system bar * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Set the properties of system bar * * @param { SystemBarProperties } systemBarProperties - The properties of system bar * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 * @deprecated since 12 * @useinstead ohos.window.Window#setWindowSystemBarProperties */ setWindowSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback): void; /** * Set the properties of system bar * * @param { SystemBarProperties } systemBarProperties - The properties of system bar * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Set the properties of system bar * * @param { SystemBarProperties } systemBarProperties - The properties of system bar * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * Set the properties of system bar * * @param { SystemBarProperties } systemBarProperties - The properties of system bar * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowSystemBarProperties(systemBarProperties: SystemBarProperties): Promise; /** * Get the properties of system bar * * @returns { SystemBarProperties } Return system bar properties. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ getWindowSystemBarProperties(): SystemBarProperties; /** * Set the content color of the status bar. * * @param { ColorMetrics } color - Content color of the status bar * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported on this device. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ setStatusBarColor(color: ColorMetrics): Promise; /** * Get the properties of the status bar. * * @returns { StatusBarProperty } Return status bar properties. * @throws { BusinessError } 801 - Capability not supported on this device. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ getStatusBarProperty(): StatusBarProperty; /** * Set whether to disable the gesture back function. * * @param { boolean } enabled - If true then enable the gesture back function, false then disable the gesture back function. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 13 */ setGestureBackEnabled(enabled: boolean): Promise; /** * Get whether the gesture back function is currently disabled. * * @returns { boolean } enabled - If true then the gesture back function is currently enabled, false then the gesture back function is currently disabled. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 13 */ isGestureBackEnabled(): boolean; /** * Set the preferred orientation config of the window * * @param { Orientation } orientation - The orientation config of the window * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Set the preferred orientation config of the window * * @param { Orientation } orientation - The orientation config of the window * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Sets the preferred orientation for the main window. * This API uses a promise to return the result. * It does not take effect on devices that do not support rotation with the sensor, on 2-in-1 devices or for the child window. * * @param { Orientation } orientation - The orientation config of the window * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ setPreferredOrientation(orientation: Orientation): Promise; /** * Set the preferred orientation config of the window * * @param { Orientation } orientation - The orientation config of the window * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Set the preferred orientation config of the window * * @param { Orientation } orientation - The orientation config of the window * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Sets the preferred orientation for the main window. * This API uses an asynchronous callback to return the result. * It does not take effect on devices that do not support rotation with the sensor, on 2-in-1 devices or for the child window. * * @param { Orientation } orientation - The orientation config of the window * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ setPreferredOrientation(orientation: Orientation, callback: AsyncCallback): void; /** * Obtains the orientation of the main window. * This API can be called only by the main window. * * @returns { Orientation } orientation - The orientation config of the window * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ getPreferredOrientation(): Orientation; /** * Loads the content of a page, with its path in the current project specified, to this window, * and transfers the state attribute to the page through a local storage. * This API uses a promise to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path - Path of the page to which the content will be loaded * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @since 9 */ /** * Loads the content of a page, with its path in the current project specified, to this window, * and transfers the state attribute to the page through a local storage. * This API uses a promise to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path - Path of the page to which the content will be loaded * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @since 10 */ /** * Loads the content of a page, with its path in the current project specified, * to this window, and transfers the state attribute to the page through a local storage. * This API uses a promise to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path - Path of the page from which the content will be loaded. * The path is configured in the main_pages.json file of the project. * @param { LocalStorage } storage - Page-level UI state storage unit, which is used to transfer the state attribute for the page. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ loadContent(path: string, storage: LocalStorage, callback: AsyncCallback): void; /** * Loads the content of a page, with its path in the current project specified, to this window, * and transfers the state attribute to the page through a local storage. * This API uses a promise to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path - Path of the page to which the content will be loaded * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @since 9 */ /** * Loads the content of a page, with its path in the current project specified, to this window, * and transfers the state attribute to the page through a local storage. * This API uses a promise to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path - Path of the page to which the content will be loaded * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @since 10 */ /** * Loads the content of a page, with its path in the current project specified, to this window, * and transfers the state attribute to the page through a local storage. * This API uses a promise to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path - Path of the page from which the content will be loaded. * The path is configured in the main_pages.json file of the project. * @param { LocalStorage } storage - Page-level UI state storage unit, which is used to transfer the state attribute for the page. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ loadContent(path: string, storage: LocalStorage): Promise; /** * Loads content from a page to this window. This API uses an asynchronous callback to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) before loading the new content. Exercise caution when using it. * * @param { string } path - Path of the page to which the content will be loaded * @param { AsyncCallback } callback - Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#setUIContent */ loadContent(path: string, callback: AsyncCallback): void; /** * Loads content from a page to this window. This API uses a promise to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) before loading the new content. Exercise caution when using it. * * @param { string } path - Path of the page to which the content will be loaded * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#setUIContent */ loadContent(path: string): Promise; /** * Get the UIContext associate with the window content. * * @returns { UIContext } the object of UIContext. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @since 10 */ /** * Obtain a UIContext instance. * * @returns { UIContext } UIContext instance obtained. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ getUIContext() : UIContext; /** * Loads content * * @param { string } path - Path of the page to which the content will be loaded * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Loads content * * @param { string } path - Path of the page to which the content will be loaded * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Loads the content of a page, with its path in the current project specified, to this window. * This API uses an asynchronous callback to return the result. * * @param { string } path - Path of the page from which the content will be loaded. * In the stage model, the path is configured in the main_pages.json file of the project. * In the FA model, the path is configured in the config.json file of the project. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ setUIContent(path: string, callback: AsyncCallback): void; /** * Loads content * * @param { string } path - Path of the page to which the content will be loaded * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Loads content * * @param { string } path - Path of the page to which the content will be loaded * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Loads the content of a page, with its path in the current project specified, to this window. * This API uses a promise to return the result. * * @param { string } path - Path of the page from which the content will be loaded. * In the stage model, the path is configured in the main_pages.json file of the project. * In the FA model, the path is configured in the config.json file of the project. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ setUIContent(path: string): Promise; /** * Loads the content of a named route page to this window, and transfers the state attribute to the page through a local storage. * This API uses an asynchronous callback to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) before loading the new content. * Exercise caution when using it. * * @param { string } name - Name of the named route page. * @param { LocalStorage } storage - Page-level UI state storage unit, which is used to transfer the state attribute for the page. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @atomicservice * @since 11 */ loadContentByName(name: string, storage: LocalStorage, callback: AsyncCallback): void; /** * Loads the content of a named route page to this window, and transfers the state attribute to the page through a local storage. * This API uses an asynchronous callback to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) before loading the new content. * Exercise caution when using it. * * @param { string } name - Name of the named route page. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @atomicservice * @since 11 */ loadContentByName(name: string, callback: AsyncCallback): void; /** * Loads the content of a named route page to this window, and transfers the state attribute to the page through a local storage. * This API uses an asynchronous callback to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) before loading the new content. * Exercise caution when using it. * * @param { string } name - Name of the named route page. * @param { LocalStorage } storage - Page-level UI state storage unit, which is used to transfer the state attribute for the page. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @atomicservice * @since 11 */ loadContentByName(name: string, storage?: LocalStorage): Promise; /** * Checks whether the window is displayed * * @param { AsyncCallback } callback - Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#isWindowShowing */ isShowing(callback: AsyncCallback): void; /** * Checks whether the window is displayed * * @returns { Promise } Whether the window is displayed. The value true means that the window is displayed, and false means the opposite. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#isWindowShowing */ isShowing(): Promise; /** * Checks whether the window is displayed * * @returns { boolean } Whether the window is displayed. The value true means that the window is displayed, and false means the opposite. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Checks whether the window is displayed * * @returns { boolean } Whether the window is displayed. The value true means that the window is displayed, and false means the opposite. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Checks whether the window is displayed * * @returns { boolean } Whether the window is displayed. The value true means that the window is displayed, and false means the opposite. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ isWindowShowing(): boolean; /** * Register the callback of windowSizeChange * * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. * @param { Callback } callback - Callback used to return the window size. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Register the callback of windowSizeChange * * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. * @param { Callback } callback - Callback used to return the window size. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Register the callback of windowSizeChange * * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. * @param { Callback } callback - Callback used to return the window size. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'windowSizeChange', callback: Callback): void; /** * Unregister the callback of windowSizeChange * * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. * @param { Callback } callback - Callback used to return the window size. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Unregister the callback of windowSizeChange * * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. * @param { Callback } callback - Callback used to return the window size. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 11 */ /** * Unregister the callback of windowSizeChange * * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. * @param { Callback } callback - Callback used to return the window size. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'windowSizeChange', callback?: Callback): void; /** * Register the callback of systemAvoidAreaChange * * @param { 'systemAvoidAreaChange' } type - The value is fixed at 'systemAvoidAreaChange', indicating the event of changes to the avoid area. * @param { Callback } callback - Callback used to return the area. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#on_avoidAreaChange */ on(type: 'systemAvoidAreaChange', callback: Callback): void; /** * Unregister the callback of systemAvoidAreaChange * * @param { 'systemAvoidAreaChange' } type - The value is fixed at 'systemAvoidAreaChange', indicating the event of changes to the avoid area. * @param { Callback } callback - Callback used to return the area. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#off_avoidAreaChange */ off(type: 'systemAvoidAreaChange', callback?: Callback): void; /** * Register the callback of avoidAreaChange * * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. * @param { Callback<{ type: AvoidAreaType, area: AvoidArea }> } callback - Callback used to return the area. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ /** * Register the callback of avoidAreaChange * * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. * @param { Callback<{ type: AvoidAreaType, area: AvoidArea }> } callback - Callback used to return the area. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ /** * Register the callback of avoidAreaChange * * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. * @param { Callback } callback - Callback used to return the area. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * Register the callback of avoidAreaChange * * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. * @param { Callback } callback - Callback used to return the area. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'avoidAreaChange', callback: Callback): void; /** * Unregister the callback of avoidAreaChange * * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. * @param { Callback<{ type: AvoidAreaType, area: AvoidArea }> } callback - Callback used to return the area. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ /** * Unregister the callback of avoidAreaChange * * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. * @param { Callback<{ type: AvoidAreaType, area: AvoidArea }> } callback - Callback used to return the area. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ /** * Unregister the callback of avoidAreaChange * * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. * @param { Callback } callback - Callback used to return the area. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * Unregister the callback of avoidAreaChange * * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. * @param { Callback } callback - Callback used to return the area. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'avoidAreaChange', callback?: Callback): void; /** * Register the callback of keyboardHeightChange * * @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event. * @param { Callback } callback - Callback used to return the current keyboard height, which is an integer, in px. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Register the callback of keyboardHeightChange * * @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event. * @param { Callback } callback - Callback used to return the current keyboard height, which is an integer, in px. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'keyboardHeightChange', callback: Callback): void; /** * Unregister the callback of keyboardHeightChange * * @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event. * @param { Callback } callback - Callback used to return the current keyboard height, which is an integer, in px. * 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. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 */ /** * Unregister the callback of keyboardHeightChange * * @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event. * @param { Callback } callback - Callback used to return the current keyboard height, which is an integer, in px. * 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. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'keyboardHeightChange', callback?: Callback): void; /** * Register the callback of keyboardWillShow * * @param { 'keyboardWillShow' } type - The value is fixed at 'keyboardWillShow', indicating the start of the keyboard show animation event. * @param { Callback } callback - Callback invoked before the keyboard show animation start. * @throws { BusinessError } 801 - Capability not supported. Function keyboardWillShow can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ on(type: 'keyboardWillShow', callback: Callback): void; /** * Unregister the callback of keyboardWillShow * * @param { 'keyboardWillShow' } type - The value is fixed at 'keyboardWillShow', indicating the start of the keyboard show animation event. * @param { Callback } callback - Callback invoked before the keyboard show animation start. * @throws { BusinessError } 801 - Capability not supported. Function keyboardWillShow can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ off(type: 'keyboardWillShow', callback?: Callback): void; /** * Register the callback of keyboardWillHide * * @param { 'keyboardWillHide' } type - The value is fixed at 'keyboardWillHide', indicating the start of the keyboard hide animation event. * @param { Callback } callback - Callback invoked before the keyboard hide animation start. * @throws { BusinessError } 801 - Capability not supported. Function keyboardWillHide can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ on(type: 'keyboardWillHide', callback: Callback): void; /** * Unregister the callback of keyboardWillHide * * @param { 'keyboardWillHide' } type - The value is fixed at 'keyboardWillHide', indicating the start of the keyboard hide animation event. * @param { Callback } callback - Callback invoked before the keyboard hide animation start. * @throws { BusinessError } 801 - Capability not supported. Function keyboardWillHide can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ off(type: 'keyboardWillHide', callback?: Callback): void; /** * Register the callback of keyboardDidShow * * @param { 'keyboardDidShow' } type - The value is fixed at 'keyboardDidShow', indicating the completion of the keyboard show animation event. * @param { Callback } callback - Callback invoked when the keyboard show animation is completed. * @throws { BusinessError } 801 - Capability not supported. Function keyboardDidShow can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'18', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'keyboardDidShow', callback: Callback): void; /** * Unregister the callback of keyboardDidShow * * @param { 'keyboardDidShow' } type - The value is fixed at 'keyboardDidShow', indicating the completion of the keyboard show animation event. * @param { Callback } callback - Callback invoked when the keyboard show animation is completed. * @throws { BusinessError } 801 - Capability not supported. Function keyboardDidShow can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'18', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'keyboardDidShow', callback?: Callback): void; /** * Register the callback of keyboardDidHide * * @param { 'keyboardDidHide' } type - The value is fixed at 'keyboardDidHide', indicating the completion of the keyboard hide animation event. * @param { Callback } callback - Callback invoked when the keyboard hide animation is completed. * @throws { BusinessError } 801 - Capability not supported. Function keyboardDidHide can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'18', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'keyboardDidHide', callback: Callback): void; /** * Unregister the callback of keyboardDidHide * * @param { 'keyboardDidHide' } type - The value is fixed at 'keyboardDidHide', indicating the completion of the keyboard hide animation event. * @param { Callback } callback - Callback invoked when the keyboard hide animation is completed. * @throws { BusinessError } 801 - Capability not supported. Function keyboardDidHide can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'18', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'keyboardDidHide', callback?: Callback): void; /** * Subscribes to the touch event outside this window. * * @param { 'touchOutside' } type - The value is fixed at 'touchOutside', indicating the click event outside this window. * @param { Callback } callback - Callback used to return the click event outside this window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'touchOutside', callback: Callback): void; /** * Unsubscribes from the touch event outside this window. * * @param { 'touchOutside' } type - The value is fixed at 'touchOutside', indicating the click event outside this window. * @param { Callback } callback - Callback used to return the click event outside this window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'touchOutside', callback?: Callback): void; /** * Window displayId change callback on. * * @param { 'displayIdChange' } type - The value is fixed at 'displayIdChange', indicating the Display this window is current showing has changed. * @param { Callback } callback - Callback used to notify the Display this window is current showing has changed. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ on(type: 'displayIdChange', callback: Callback): void; /** * Window displayId change callback off. * * @param { 'displayIdChange' } type - The value is fixed at 'displayIdChange', indicating the Display this window is current showing has changed. * @param { Callback } callback - Callback used to notify the Display this window is current showing has changed. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ off(type: 'displayIdChange', callback?: Callback): void; /** * Window visibility change callback on. * * @param { 'windowVisibilityChange' } type - The value is fixed at 'windowVisibilityChange', indicating the window visibility change. * @param { Callback } callback - Callback used to notify the window visibility change. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Subscribes to the visibility status change event of this window. * * @param { 'windowVisibilityChange' } type - Event type. The value is fixed at 'windowVisibilityChange', indicating the visibility status change event. * @param { Callback } callback - Callback used to return the visibility status of the window, which is a Boolean value. * The value true means that the window is visible, and false means the opposite. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'windowVisibilityChange', callback: Callback): void; /** * Window visibility change callback off. * * @param { 'windowVisibilityChange' } type - The value is fixed at 'windowVisibilityChange', indicating the window visibility change. * @param { Callback } callback - Callback used to notify the window visibility change. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Unsubscribes from the visibility status change event of this window. * * @param { 'windowVisibilityChange' } type - Event type. The value is fixed at 'windowVisibilityChange', indicating the visibility status change event. * @param { Callback } callback - Callback used to return the visibility status of the window. * If a value is passed in, the corresponding subscription is canceled. * If no value is passed in, all subscriptions to the specified event are canceled. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'windowVisibilityChange', callback?: Callback): void; /** * System density change callback on. * * @param { 'systemDensityChange' } type - The value is fixed at 'systemDensityChange', indicating the system density is current has changed. * @param { Callback } callback - Callback used to notify the system density is current has changed. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ on(type: 'systemDensityChange', callback: Callback): void; /** * System density change callback off. * * @param { 'systemDensityChange' } type - The value is fixed at 'systemDensityChange', indicating the system density is current showing has changed. * @param { Callback } callback - Callback used to notify the system density is current has changed. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ off(type: 'systemDensityChange', callback?: Callback): void; /** * Register Callback for window spans multiple screens and displays in full screen mode changed. * * * @param { 'mainWindowFullScreenAcrossDisplaysChanged' } type - The value is fixed at 'mainWindowFullScreenAcrossDisplaysChanged', * indicating the window spans multiple screens and displays in full screen mode changed. * @param { Callback } callback - Callback used to notify the window spans multiple screens and displays in full screen mode changed. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ on(type: 'mainWindowFullScreenAcrossDisplaysChanged', callback: Callback): void; /** * Unregister Callback for window spans multiple screens and displays in full screen mode changed. * * @param { 'mainWindowFullScreenAcrossDisplaysChanged' } type - The value is fixed at 'mainWindowFullScreenAcrossDisplaysChanged', * indicating the window spans multiple screens and displays in full screen mode changed. * @param { Callback } [callback] - Callback used to notify the window spans multiple screens and displays in full screen mode changed. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ off(type: 'mainWindowFullScreenAcrossDisplaysChanged', callback?: Callback): void; /** * Subscribes to non-interaction events in a window within the specified period. * Interaction events include physical keyboard input events and screen touch/click events, but not soft keyboard input events. * * @param { 'noInteractionDetected' } type - The value is fixed at 'noInteractionDetected', indicating the window has no interaction for a long time. * @param { number } timeout - The timeout(in seconds) of no interaction detection. * @param { Callback } callback - Callback used to notify the window has no interaction for a long time. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'noInteractionDetected', timeout: number, callback: Callback): void; /** * Unsubscribes from non-interaction events in a window within the specified period. * Interaction events include physical keyboard input events and screen touch/click events, but not soft keyboard input events. * * @param { 'noInteractionDetected' } type - The value is fixed at 'noInteractionDetected', indicating the window has no interaction for a long time. * @param { Callback } callback - Callback used to notify the window has no interaction for a long time. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'noInteractionDetected', callback?: Callback): void; /** * Register the callback of screenshot, only the focused window called back * * @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event. * @param { Callback } callback - Callback invoked when a screenshot event occurs. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ /** * Register the callback of screenshot, only the focused window called back * * @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event. * @param { Callback } callback - Callback invoked when a screenshot event occurs. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'screenshot', callback: Callback): void; /** * Unregister the callback of screenshot * * @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event. * @param { Callback } callback - Callback invoked when a screenshot event occurs. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ /** * Unregister the callback of screenshot * * @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event. * @param { Callback } callback - Callback invoked when a screenshot event occurs. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'screenshot', callback?: Callback): void; /** * Register the callback of screenshot app event * * @param { 'screenshotAppEvent' } type - The value is fixed at 'screenshotAppEvent', indicating the screenshot app event. * @param { Callback } callback - Callback invoked when a screenshot app event occurs. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 20 */ on(type: 'screenshotAppEvent', callback: Callback): void; /** * Unregister the callback of screenshot app event * * @param { 'screenshotAppEvent' } type - The value is fixed at 'screenshotAppEvent', indicating the screenshot app event. * @param { Callback } callback - Callback invoked when a screenshot app event occurs. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 20 */ off(type: 'screenshotAppEvent', callback?: Callback): void; /** * Register the callback of dialogTargetTouch * * @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch', indicating the click event of the target window in the modal window mode. * @param { Callback } callback - Callback invoked when the click event occurs in the target window of the modal window mode. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ /** * Subscribes to click or touch events in a window covered by a modal window. This API takes effect only when it is called by a modal window. * * @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch', indicating the click event of the target window in the modal window mode. * @param { Callback } callback - Callback invoked when the click event occurs in the target window of the modal window mode. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'dialogTargetTouch', callback: Callback): void; /** * Unregister the callback of dialogTargetTouch * * @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch', * indicating the click event of the target window in the modal window mode. * @param { Callback } callback - Callback invoked when the click event occurs in the target window of the modal window mode. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ /** * Unsubscribes from the touch event of the target window in the modal window mode. * * @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch', * indicating the click event of the target window in the modal window mode. * @param { Callback } callback - Callback invoked when the click event occurs in the target window of the modal window mode. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'dialogTargetTouch', callback?: Callback): void; /** * Register the callback of windowEvent * * @param { 'windowEvent' } type - The value is fixed at 'windowEvent', indicating the window lifecycle change event. * @param { Callback } callback - the callback of window event * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ /** * Subscribes to the window lifecycle change event. * * @param { 'windowEvent' } type - Event type. The value is fixed at 'windowEvent', indicating the window lifecycle change event. * @param { Callback } callback - Callback used to return the window lifecycle state. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'windowEvent', callback: Callback): void; /** * Unregister the callback of windowEvent * * @param { 'windowEvent' } type - The value is fixed at 'windowEvent', indicating the window lifecycle change event. * @param { Callback } callback - the callback of window event * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ /** * Unsubscribes from the window lifecycle change event. * * @param { 'windowEvent' } type - Event type. The value is fixed at 'windowEvent', indicating the window lifecycle change event. * @param { Callback } callback - Callback used to return the window lifecycle state. * If a value is passed in, the corresponding subscription is canceled. * If no value is passed in, all subscriptions to the specified event are canceled. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'windowEvent', callback?: Callback): void; /** * Register the callback of windowStatusChange * * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. * @param { Callback } callback - Callback used to return the window status. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Register the callback of windowStatusChange * * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. * @param { Callback } callback - Callback used to return the window status. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ /** * Register the callback of windowStatusChange * * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. * @param { Callback } callback - Callback used to return the window status. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @syscap SystemCapability.Window.SessionManager * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'windowStatusChange', callback: Callback): void; /** * Unregister the callback of windowStatusChange * * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. * @param { Callback } callback - Callback used to return the window status. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Unregister the callback of windowStatusChange * * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. * @param { Callback } callback - Callback used to return the window status. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ /** * Unregister the callback of windowStatusChange * * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. * @param { Callback } callback - Callback used to return the window status. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @syscap SystemCapability.Window.SessionManager * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'windowStatusChange', callback?: Callback): void; /** * Register the callback of windowStatusDidChange * * @param { 'windowStatusDidChange' } type - The value is fixed at 'windowStatusDidChange', indicating the window status change event. * @param { Callback } callback - Callback used to return the window status. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @since 20 */ on(type: 'windowStatusDidChange', callback: Callback): void; /** * Unregister the callback of windowStatusDidChange * * @param { 'windowStatusDidChange' } type - The value is fixed at 'windowStatusDidChange', indicating the window status change event. * @param { Callback } [callback] - Callback used to return the window status. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @since 20 */ off(type: 'windowStatusDidChange', callback?: Callback): void; /** * Subscribes to the event indicating that the child window is closed. * This event is triggered only when the user clicks the system-provided close button in the upper right corner to close the child window. * It is not triggered when the child window is closed in other ways. * * @param { 'subWindowClose' } type - Event type. The value is fixed at 'subWindowClose', indicating the child window close event. * @param { Callback } callback - Callback invoked when the close button in the upper right corner of the child window is clicked. * The internal logic of the callback function requires a return value of the Boolean type. * The return value determines whether to continue to close the child window. * The value true means not to close the child window, and false means to continue to close the child window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ on(type: 'subWindowClose', callback: Callback): void; /** * Unsubscribes from the event indicating that the child window is closed. * * @param { 'subWindowClose' } type - Event type. The value is fixed at 'subWindowClose', indicating the child window close event. * @param { Callback } callback - Callback invoked when the close button in the upper right corner of the child window is clicked. * The internal logic of the callback function requires a return value of the Boolean type. * The return value determines whether to continue to close the child window. * The value true means not to close the child window, and false means to continue to close the child window. * If a value is passed in, the corresponding subscription is canceled. * If no value is passed in, all subscriptions to the specified event are canceled. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ off(type: 'subWindowClose', callback?: Callback): void; /** * Subscribes to the event indicating that the main window or child window will be closed. * This event is triggered only when the user clicks the close button in the system-provided title bar to close the window. * It is not triggered when the window is closed in other ways. * * @param { 'windowWillClose' } type - Event type. The value is fixed at 'windowWillClose', indicating the window close event. * @param { Callback> } callback - Callback used to when the close button in the upper right corner of the window is clicked. * The internal logic of the callback function requires a return value of the Promise type. * In the returned Promise function, resolve(true) means not to close the window, * and resolve(false) or reject means to continue to close the window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ on(type: 'windowWillClose', callback: Callback>): void; /** * Unsubscribes from the event indicating that the main window or child window will be closed. * * @param { 'windowWillClose' } type - Event type. The value is fixed at 'windowWillClose', indicating the window close event. * @param { Callback> } callback - Callback used to when the close button in the upper right corner of the window is clicked. * The internal logic of the callback function requires a return value of the Promise type. * It does not return any parameter. In the returned Promise function, * resolve(true) means not to close the window, * and resolve(false) or reject means to continue to close the window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ off(type: 'windowWillClose', callback?: Callback>): void; /** * Register the callback of window highlight state change * * @param { 'windowHighlightChange' } type - The value is fixed at 'windowHighlightChange', indicating the window highlight state change event. * @param { Callback } callback - Callback used to return the highlight status of the window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'15', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'windowHighlightChange', callback: Callback): void; /** * Unregister the callback of window highlight state change * * @param { 'windowHighlightChange' } type - The value is fixed at 'windowHighlightChange', indicating the window highlight change event. * @param { Callback } callback - Callback used to return the highlight status of the window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'15', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'windowHighlightChange', callback?: Callback): void; /** * Bind dialog to the target window. * * @param { rpc.RemoteObject } token - token of the target window. * @param { Callback } deathCallback - the callback of dialogDeath. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Bind dialog to the target window. * * @param { rpc.RemoteObject } token - token of the target window. * @param { Callback } deathCallback - the callback of dialogDeath. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback): Promise; /** * Bind dialog to the target window. * * @param { rpc.RemoteObject } token token of the target window. * @param { Callback } deathCallback the callback of dialogDeath. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Bind dialog to the target window. * * @param { rpc.RemoteObject } token token of the target window. * @param { Callback } deathCallback the callback of dialogDeath. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback, callback: AsyncCallback): void; /** * Bind dialog to the target window. * * @param { dialogRequest.RequestInfo } requestInfo requestInfo of the target window. * @param { Callback } deathCallback the callback of dialogDeath. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Bind dialog to the target window. * * @param { dialogRequest.RequestInfo } requestInfo requestInfo of the target window. * @param { Callback } deathCallback the callback of dialogDeath. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ bindDialogTarget(requestInfo: dialogRequest.RequestInfo, deathCallback: Callback): Promise; /** * Bind dialog to the target window. * * @param { dialogRequest.RequestInfo } requestInfo requestInfo of the target window. * @param { Callback } deathCallback the callback of dialogDeath. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Bind dialog to the target window. * * @param { dialogRequest.RequestInfo } requestInfo requestInfo of the target window. * @param { Callback } deathCallback the callback of dialogDeath. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ bindDialogTarget( requestInfo: dialogRequest.RequestInfo, deathCallback: Callback, callback: AsyncCallback ): void; /** * Sets whether the modal window responds to the back gesture event. An error code is returned if this API is called for a non-modal window. * * @param { boolean } enabled - Whether to respond to the back gesture event. * The value true means to respond to the back gesture event and trigger the onBackPress callback, and false means the opposite. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ setDialogBackGestureEnabled(enabled: boolean): Promise; /** * Whether the window supports thr wide gamut setting. * * @returns { Promise } Promise used to return the result. The value true means that the wide-gamut color space is supported, and false means the opposite. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 * @deprecated since 9 * @useinstead ohos.window.Window#isWindowSupportWideGamut */ isSupportWideGamut(): Promise; /** * Whether the window supports thr wide gamut setting. * * @param { AsyncCallback } callback Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 * @deprecated since 9 * @useinstead ohos.window.Window#isWindowSupportWideGamut */ isSupportWideGamut(callback: AsyncCallback): void; /** * Whether the window supports thr wide gamut setting. * * @returns { Promise } Promise used to return the result. * The value true means that the wide-gamut color space is supported, and false means the opposite. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Whether the window supports thr wide gamut setting. * * @returns { Promise } Promise used to return the result. * The value true means that the wide-gamut color space is supported, and false means the opposite. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ isWindowSupportWideGamut(): Promise; /** * Whether the window supports thr wide gamut setting. * * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Whether the window supports thr wide gamut setting. * * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ isWindowSupportWideGamut(callback: AsyncCallback): void; /** * Sets the specified color space. * * @param { ColorSpace } colorSpace the specified color space. * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowColorSpace */ setColorSpace(colorSpace: ColorSpace): Promise; /** * Sets the specified color space. * * @param { ColorSpace } colorSpace the specified color space. * @param { AsyncCallback } callback Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowColorSpace */ setColorSpace(colorSpace: ColorSpace, callback: AsyncCallback): void; /** * Sets the specified color space. * * @param { ColorSpace } colorSpace the specified color space. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets the specified color space. * * @param { ColorSpace } colorSpace the specified color space. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 11 */ /** * Sets the specified color space. * * @param { ColorSpace } colorSpace the specified color space. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowColorSpace(colorSpace: ColorSpace): Promise; /** * Sets the specified color space. * * @param { ColorSpace } colorSpace the specified color space. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets the specified color space. * * @param { ColorSpace } colorSpace the specified color space. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 11 */ /** * Sets the specified color space. * * @param { ColorSpace } colorSpace the specified color space. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowColorSpace(colorSpace: ColorSpace, callback: AsyncCallback): void; /** * Obtains the set color space. * * @returns { Promise } Promise used to return the current color space. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 * @deprecated since 9 * @useinstead ohos.window.Window#getWindowColorSpace */ getColorSpace(): Promise; /** * Obtains the set color space. * * @param { AsyncCallback } callback Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 8 * @deprecated since 9 * @useinstead ohos.window.Window#getWindowColorSpace */ getColorSpace(callback: AsyncCallback): void; /** * Obtains the set color space. * * @returns { ColorSpace } Color space obtained. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Obtains the set color space. * * @returns { ColorSpace } Color space obtained. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 11 */ /** * Obtains the set color space. * * @returns { ColorSpace } Color space obtained. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since 12 */ getWindowColorSpace(): ColorSpace; /** * Sets the background color of window. * * @param { string } color the specified color. * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowBackgroundColor */ setBackgroundColor(color: string): Promise; /** * Sets the background color of window. * * @param { string } color the specified color. * @param { AsyncCallback } callback Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowBackgroundColor */ setBackgroundColor(color: string, callback: AsyncCallback): void; /** * Sets the background color of window. * * @param { string } color the specified color. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets the background color of window. * * @param { string } color the specified color. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Sets the background color of window. * * @param { string } color the specified color. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since 11 */ /** * Sets the background color of window. * * @param { string | ColorMetrics } color - the specified color. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'18', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowBackgroundColor(color: string | ColorMetrics): void; /** * Sets the shadow enable of window. * * @permission ohos.permission.SET_WINDOW_TRANSPARENT * @param { boolean } enable - Enable or disable window shadow. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 201 - Permission verification failed. * The application does not have the permission required to call the API. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @since 20 */ setWindowShadowEnabled(enable: boolean): Promise; /** * Sets the brightness of window. * * @param { number } brightness the specified brightness value. * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowBrightness */ setBrightness(brightness: number): Promise; /** * Sets the brightness of window. * * @param { number } brightness the specified brightness value. * @param { AsyncCallback } callback Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowBrightness */ setBrightness(brightness: number, callback: AsyncCallback): void; /** * Set whether the main window is topmost. * * @param { boolean } isTopmost - Main window is topmost if true. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @systemapi * @since 12 */ setTopmost(isTopmost: boolean): Promise; /** * Places the main window above all the other windows of the application. * * @permission ohos.permission.WINDOW_TOPMOST * @param { boolean } isWindowTopmost - Whether to pin the main window on top. * The value true means to pin the main window on top, and false means the opposite. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ setWindowTopmost(isWindowTopmost: boolean): Promise; /** * Sets the brightness of window. * * @param { number } brightness the specified brightness value. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets the brightness of window. * * @param { number } brightness the specified brightness value. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Sets the brightness of window. * * @param { number } brightness the specified brightness value. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since 11 */ setWindowBrightness(brightness: number): Promise; /** * Sets the brightness of window. * * @param { number } brightness the specified brightness value. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets the brightness of window. * * @param { number } brightness the specified brightness value. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Sets the brightness of window. * * @param { number } brightness the specified brightness value. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since 11 */ setWindowBrightness(brightness: number, callback: AsyncCallback): void; /** * Sets the dimBehind of window. * * @param { number } dimBehindValue - The specified dimBehind. * @param { AsyncCallback } callback Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 */ setDimBehind(dimBehindValue: number, callback: AsyncCallback): void; /** * Sets the dimBehind of window. * * @param { number } dimBehindValue - The specified dimBehind. * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 */ setDimBehind(dimBehindValue: number): Promise; /** * Sets whether focusable or not. * * @param { boolean } isFocusable can be focus if true, or can not be focus if false. * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowFocusable */ setFocusable(isFocusable: boolean): Promise; /** * Sets whether focusable or not. * * @param { boolean } isFocusable can be focus if true, or can not be focus if false. * @param { AsyncCallback } callback Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowFocusable */ setFocusable(isFocusable: boolean, callback: AsyncCallback): void; /** * Sets whether focusable or not. * * @param { boolean } isFocusable can be focus if true, or can not be focus if false. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets whether focusable or not. * * @param { boolean } isFocusable can be focus if true, or can not be focus if false. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowFocusable(isFocusable: boolean): Promise; /** * Sets whether focusable or not. * * @param { boolean } isFocusable can be focus if true, or can not be focus if false. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets whether focusable or not. * * @param { boolean } isFocusable can be focus if true, or can not be focus if false. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowFocusable(isFocusable: boolean, callback: AsyncCallback): void; /** * Window requests to get focus or lose focus. * * @param { boolean } isFocused - Window requests to get focus if true, requests to lose focus if false. * @returns { Promise } - Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed, non-system application uses system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @systemapi * @since 13 */ requestFocus(isFocused: boolean): Promise; /** * Sets whether exclusively highlighted or not. * * @param { boolean } exclusivelyHighlighted Whether the window can become highlight exclusively when it gain focus. The value * true means that the window can cause the window outside the current window link to * lose its highlight state, and false means the opposite. * @returns { Promise } - Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ setExclusivelyHighlighted(exclusivelyHighlighted: boolean): Promise; /** * Checks whether the window is highlighted. * * @returns { boolean } - Whether the window is highlighted. The value true means that the window is highlighted, and false means the opposite. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ isWindowHighlighted(): boolean; /** * Sets whether keep screen on or not. * * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. * @returns { Promise } that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowKeepScreenOn */ setKeepScreenOn(isKeepScreenOn: boolean): Promise; /** * Sets whether keep screen on or not. * * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. * @param { AsyncCallback } callback Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 6 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowKeepScreenOn */ setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback): void; /** * Sets whether keep screen on or not. * * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets whether keep screen on or not. * * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Sets whether keep screen on or not. * * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowKeepScreenOn(isKeepScreenOn: boolean): Promise; /** * Sets whether keep screen on or not. * * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets whether keep screen on or not. * * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * Sets whether keep screen on or not. * * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback): void; /** * Sets whether to wake up the screen when this ability is restored. * * @param { boolean } wakeUp Specifies whether to wake up the screen. True means to wake it up, false means not. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Sets whether to wake up the screen when this ability is restored. * * @param { boolean } wakeUp Specifies whether to wake up the screen. True means to wake it up, false means not. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ setWakeUpScreen(wakeUp: boolean): void; /** * Sets whether outside can be touch or not. * * @param { boolean } touchable outside can be touch if true, or not if false. * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 */ setOutsideTouchable(touchable: boolean): Promise; /** * Sets whether outside can be touch or not. * * @param { boolean } touchable outside can be touch if true, or not if false. * @param { AsyncCallback } callback Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 */ setOutsideTouchable(touchable: boolean, callback: AsyncCallback): void; /** * Sets whether is private mode or not. * * @param { boolean } isPrivacyMode in private mode if true, or not if false. * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowPrivacyMode */ setPrivacyMode(isPrivacyMode: boolean): Promise; /** * Sets whether is private mode or not. * * @param { boolean } isPrivacyMode in private mode if true, or not if false. * @param { AsyncCallback } callback Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowPrivacyMode */ setPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback): void; /** * Sets whether is private mode or not. * * @permission ohos.permission.PRIVACY_WINDOW * @param { boolean } isPrivacyMode in private mode if true, or not if false. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets whether is private mode or not. * * @permission ohos.permission.PRIVACY_WINDOW * @param { boolean } isPrivacyMode in private mode if true, or not if false. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * Sets whether is private mode or not. * * @permission ohos.permission.PRIVACY_WINDOW * @param { boolean } isPrivacyMode in private mode if true, or not if false. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowPrivacyMode(isPrivacyMode: boolean): Promise; /** * Sets whether is private mode or not. * * @permission ohos.permission.PRIVACY_WINDOW * @param { boolean } isPrivacyMode in private mode if true, or not if false. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets whether is private mode or not. * * @permission ohos.permission.PRIVACY_WINDOW * @param { boolean } isPrivacyMode in private mode if true, or not if false. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ /** * Sets whether is private mode or not. * * @permission ohos.permission.PRIVACY_WINDOW * @param { boolean } isPrivacyMode in private mode if true, or not if false. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback): void; /** * Ignore this window during screenshot. * * @param { boolean } isSkip skip if true, or not if false. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Ignore this window during screenshot. * * @param { boolean } isSkip skip if true, or not if false. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ setSnapshotSkip(isSkip: boolean): void; /** * Sets whether is touchable or not. * * @param { boolean } isTouchable is touchable if true, or not if false. * @returns { Promise } Promise that returns no value. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowTouchable */ setTouchable(isTouchable: boolean): Promise; /** * Sets whether is touchable or not. * * @param { boolean } isTouchable is touchable if true, or not if false. * @param { AsyncCallback } callback Callback used to return the result. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 7 * @deprecated since 9 * @useinstead ohos.window.Window#setWindowTouchable */ setTouchable(isTouchable: boolean, callback: AsyncCallback): void; /** * Sets whether is touchable or not. * * @param { boolean } isTouchable is touchable if true, or not if false. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets whether is touchable or not. * * @param { boolean } isTouchable is touchable if true, or not if false. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowTouchable(isTouchable: boolean): Promise; /** * Sets whether is touchable or not. * * @param { boolean } isTouchable is touchable if true, or not if false. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Sets whether is touchable or not. * * @param { boolean } isTouchable is touchable if true, or not if false. * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowTouchable(isTouchable: boolean, callback: AsyncCallback): void; /** * Set handwrite flag on the window. This flag means only response handwrite event. * * @param { boolean } enable - Add handwrite flag to window if true, or remove flag if false. * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 12 */ setHandwritingFlag(enable: boolean): Promise; /** * Sets the flag of the window is forbidden to move in split screen mode * * @param { boolean } isForbidSplitMove the flag of the window is forbidden to move in split screen mode * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ setForbidSplitMove(isForbidSplitMove: boolean, callback: AsyncCallback): void; /** * Sets the flag of the window is forbidden to move in split screen mode * * @param { boolean } isForbidSplitMove the flag of the window is forbidden to move in split screen mode * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ setForbidSplitMove(isForbidSplitMove: boolean): Promise; /** * Obtains snapshot of window * * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Obtains snapshot of window * * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ snapshot(callback: AsyncCallback): void; /** * Obtains snapshot of window * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * Obtains snapshot of window * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ snapshot(): Promise; /** * Obtains snapshot of window * * @returns { image.PixelMap } Return pixel map of snapshot. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300018 - Timeout. * @syscap SystemCapability.Window.SessionManager * @since 20 */ snapshotSync(): image.PixelMap; /** * Obtains snapshot of window even set the privacy mode. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Function snapshotIgnorePrivacy can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ snapshotIgnorePrivacy(): Promise; /** * Sets opacity of window * * @param { number } opacity Interval is 0.f-1.f. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ /** * 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. * * @param { number } opacity Interval is 0.f-1.f. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ opacity(opacity: number): void; /** * Sets scale options of window. * * @param { ScaleOptions } scaleOptions scale param of window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ /** * 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. * * @param { ScaleOptions } scaleOptions scale param of window. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ scale(scaleOptions: ScaleOptions): void; /** * Sets rotate options of window. * * @param { RotateOptions } rotateOptions rotate param of window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ /** * 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. * * @param { RotateOptions } rotateOptions rotate param of window. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ rotate(rotateOptions: RotateOptions): void; /** * Sets translate options of window. * * @param { TranslateOptions } translateOptions translate param of window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ /** * 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. * * @param { TranslateOptions } translateOptions translate param of window. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ translate(translateOptions: TranslateOptions): void; /** * Get Transition Controller. * * @returns { TransitionController } * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 9 */ /** * Get Transition Controller. * * @returns { TransitionController } * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @since 12 */ getTransitionController(): TransitionController; /** * Sets the window blur radius. * * @param { number } radius the blur radius. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Sets the window blur radius. * * @param { number } radius the blur radius. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ setBlur(radius: number): void; /** * Sets the window backdrop blur radius. * * @param { number } radius the blur radius. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * 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. * * @param { number } radius the blur radius. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ setBackdropBlur(radius: number): void; /** * Sets the window backdrop blur style. * * @param { BlurStyle } blurStyle the specified blur style. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Sets the blur style for the background of this window. * * @param { BlurStyle } blurStyle the specified blur style. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ setBackdropBlurStyle(blurStyle: BlurStyle): void; /** * Sets shadow. * * @param { number } radius the radius of the shadow. * @param { string } color the color of the shadow. * @param { number } offsetX the offset of the shadow on the x-axis. * @param { number } offsetY the offset of the shadow on the y-axis. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Sets the shadow for the window borders. * * @param { number } radius the radius of the shadow. * @param { string } color the color of the shadow. * @param { number } offsetX the offset of the shadow on the x-axis. * @param { number } offsetY the offset of the shadow on the y-axis. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setShadow(radius: number, color?: string, offsetX?: number, offsetY?: number): void; /** * Sets the blur radius of the shadow on the edges of a child window or floating window. * * @param { number } radius - Radius of the shadow, measured in px. * The value is a floating point number greater than or equal to 0.0, * and the value 0.0 means that the shadow is disabled for the window borders. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 17 */ setWindowShadowRadius(radius: number): void; /** * Sets corner radius. * * @param { number } cornerRadius the corner radius. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 9 */ /** * Sets the radius of the rounded corners for this window. * * @param { number } cornerRadius the corner radius. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 12 */ setCornerRadius(cornerRadius: number): void; /** * Sets the radius of the rounded corners for a child window or floating window. * * @param { number } cornerRadius - Radius of the rounded corners, measured in vp. * The value is a floating point number greater than or equal to 0.0. * The value 0.0 means that the window does not use rounded corners. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 17 */ setWindowCornerRadius(cornerRadius: number): Promise; /** * Obtains the radius of rounded corners of a child window or floating window. * * @returns { number } - Radius of the rounded corner of the child window or floating window, measured in vp. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 17 */ getWindowCornerRadius(): number; /** * Raise app sub window to app top * * @param { AsyncCallback } callback - The callback of raiseToAppTop * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 10 */ raiseToAppTop(callback: AsyncCallback): void; /** * Raise app sub window to app top * * @returns { Promise } - The promise returned by the function * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 14 */ raiseToAppTop(): Promise; /** * Sets the aspect ratio of window * * @param { number } ratio - The aspect ratio of window except decoration * @param { AsyncCallback } callback - The callback of setAspectRatio. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ /** * Sets the aspect ratio of window * * @param { number } ratio - The aspect ratio of window except decoration * @param { AsyncCallback } callback - The callback of setAspectRatio. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ setAspectRatio(ratio: number, callback: AsyncCallback): void; /** * Sets the aspect ratio of window * * @param { number } ratio - The aspect ratio of window except decoration * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ /** * Sets the aspect ratio of window * * @param { number } ratio - The aspect ratio of window except decoration * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ setAspectRatio(ratio: number): Promise; /** * Resets the aspect ratio of window * * @param { AsyncCallback } callback - The callback of setAspectRatio. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ /** * Resets the aspect ratio of window * * @param { AsyncCallback } callback - The callback of setAspectRatio. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ resetAspectRatio(callback: AsyncCallback): void; /** * Resets the aspect ratio of window * * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 10 */ /** * Resets the aspect ratio of window * * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ resetAspectRatio(): Promise; /** * Set the watermark flag on the window. * * @param { boolean } enable - Add water mark flag to window if true, or remove flag if false. * @param { AsyncCallback } callback - The callback of setWaterMarkFlag. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300008 - The display device is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 10 */ /** * Set the watermark flag on the window. * * @param { boolean } enable - Add water mark flag to window if true, or remove flag if false. * @param { AsyncCallback } callback - The callback of setWaterMarkFlag. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300008 - The display device is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setWaterMarkFlag(enable: boolean, callback: AsyncCallback): void; /** * Set the watermark flag on the window * * @param { boolean } enable - Add water mark flag to window if true, or remove flag if false * @returns { Promise } - The promise returned by the function * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300008 - The display device is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since 10 */ /** * Set the watermark flag on the window * * @param { boolean } enable - Add water mark flag to window if true, or remove flag if false * @returns { Promise } - The promise returned by the function * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300008 - The display device is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setWaterMarkFlag(enable: boolean): Promise; /** * Raise one app sub window above another. * * @param { number } windowId - Indicates target window id. * @param { AsyncCallback } callback - The callback of raiseAboveTarget. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: Mandatory parameters are left unspecified. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 10 */ raiseAboveTarget(windowId: number, callback: AsyncCallback): void; /** * Raise one app sub window above another. * * @param { number } windowId - Indicates target window id. * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: Mandatory parameters are left unspecified. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 10 */ raiseAboveTarget(windowId: number): Promise; /** * Raise main window above another. * * @param { number } windowId - Indicates target window id. * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 801 - Capability not supported. * Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: * 1. Invalid Parameter range. 2. Invalid parameter length. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 20 */ raiseMainWindowAboveTarget(windowId: number): Promise; /** * Set whether to enable an app sub window to raise itself by click. * * @param { boolean } enable - Disable app sub window to raise itself by by click if false. * @param { AsyncCallback } callback - The callback of setRaiseByClickEnabled. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 10 */ setRaiseByClickEnabled(enable: boolean, callback: AsyncCallback): void; /** * Set whether to enable an app sub window to raise itself by click. * * @param { boolean } enable - Disable app sub window to raise itself by by click if false. * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.Window.SessionManager * @since 14 */ setRaiseByClickEnabled(enable: boolean): Promise; /** * Minimize app main window and hide app subWindow. * * @param { AsyncCallback } callback - The callback of Minimize. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Minimizes the main window if the caller is the main window. The main window can be restored in the dock bar. For 2-in-1 devices, it can be restored by calling restore(). * Hides the child window if the caller is a child window. The child window cannot be restored in the dock bar. It can be made visible again by calling showWindow(). * * * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ minimize(callback: AsyncCallback): void; /** * Minimize app main window and hide app subWindow. * * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Minimizes the main window if the caller is the main window. The main window can be restored in the dock bar. For 2-in-1 devices, it can be restored by calling restore(). * Hides the child window if the caller is a child window. The child window cannot be restored in the dock bar. It can be made visible again by calling showWindow(). * * @returns { Promise } - Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ minimize(): Promise; /** * Maximize app main window. * @param { MaximizePresentation } presentation - set window presentation when maximize. * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ /** * Maximizes the main window. * * @param { ?MaximizePresentation } presentation - Layout when the window is maximized. * The default value is window.MaximizePresentation.ENTER_IMMERSIVE, * indicating that the window enters the immersive layout when maximized. * @returns { Promise } - Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Function maximize can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ maximize(presentation?: MaximizePresentation): Promise; /** * Set whether to enable a window to resize by drag. * * @param { boolean } enable - Disable window to resize by drag if false. * @param { AsyncCallback } callback - The callback of setResizeByDragEnabled. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ setResizeByDragEnabled(enable: boolean, callback: AsyncCallback): void; /** * Set whether to enable a window to resize by drag. * * @param { boolean } enable - Disable window to resize by drag if false. * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ setResizeByDragEnabled(enable: boolean): Promise; /** * Hide the non-system floating windows. * * @param { boolean } shouldHide - Hide the non-system floating windows if true, otherwise means the opposite. * @param { AsyncCallback } callback - The callback of hideNonSystemFloatingWindows. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ hideNonSystemFloatingWindows(shouldHide: boolean, callback: AsyncCallback): void; /** * Hide the non-system floating windows. * * @param { boolean } shouldHide - Hide the non-system floating windows if true, otherwise means the opposite. * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ hideNonSystemFloatingWindows(shouldHide: boolean): Promise; /** * Get the window limits of current window. * * @returns { WindowLimits } - The limits of window. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Get the window limits of current window. * * @returns { WindowLimits } - The limits of window. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ getWindowLimits(): WindowLimits; /** * Set the window limits of a window. * * @param { WindowLimits } windowLimits - window limits of the window. * @returns { Promise } - Promise is used to return the limits of window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Set the window limits of a window. * * @param { WindowLimits } windowLimits - window limits of the window. * @returns { Promise } - Promise is used to return the limits of window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ setWindowLimits(windowLimits: WindowLimits): Promise; /** * Set the window limits of a window. * * @param { WindowLimits } windowLimits - Window limits of the window. * @param { boolean } isForcible - Ignore system limits. * @returns { Promise } - Promise is used to return the limits of window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ setWindowLimits(windowLimits: WindowLimits, isForcible: boolean): Promise; /** * Set whether to enable the single frame composer. * * @param { boolean } enable - Enable the single frame composer if true, otherwise means the opposite. * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 11 */ setSingleFrameComposerEnabled(enable: boolean): Promise; /** * When get focused, keep the keyboard created by other windows, support system window and app subwindow. * * @param { boolean } keepKeyboardFlag - keep the keyboard if true, otherwise means the opposite. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * When get focused, keep the keyboard created by other windows, support system window and app subwindow. * * @param { boolean } keepKeyboardFlag - Whether to keep the soft keyboard created by others. * The value true means to keep the soft keyboard, and false means the opposite. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ keepKeyboardOnFocus(keepKeyboardFlag: boolean): void; /** * Recover app main window. * * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300001 - Repeated operation. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Restores the main window from the full-screen, maximized, or split-screen mode to a floating window, * and restores the window size and position to those before the full-screen, maximized, or split-screen mode is entered. * * @returns { Promise } - Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300001 - Repeated operation. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ recover(): Promise; /** * Restores the main window from minimization to the foreground, returning it to its size and position before it is minimized. * * @returns { Promise } - Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ restore(): Promise; /** * Set the visibility of the window decor. * * @param { boolean } - Enable the decor visible if true, otherwise means the opposite. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Set the visibility of the window decor. * * @param { boolean } isVisible - Enable the decor visible if true, otherwise means the opposite. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ /** * Sets whether the title bar is visible in the window. * * @param { boolean } isVisible - Whether the title bar is visible. The value true means that the title bar is visible and false means the opposite. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'20', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowDecorVisible(isVisible: boolean): void; /** * Checks whether the title bar of this window is visible. * * @returns { boolean } - Check result. The value true means that the title bar is visible, and false means the opposite. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ getWindowDecorVisible(): boolean; /** * Enables or disables the capability to move the window (either main window or child window) by dragging its title bar and to maximize the window with a double-click. * * @param { boolean } enabled - Whether to enable the capability to move the window by dragging the title bar and to maximize the window with a double-click. * The value true means to enable the capability, and false means the opposite. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ setWindowTitleMoveEnabled(enabled: boolean): void; /** * Set the title bar name of the window * * @param { string } titleName - The name of the title bar that needs to be set * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ setWindowTitle(titleName: string): Promise; /** * Set the modality of the window. * * @param { boolean } isModal - Enable the window modal if true, otherwise means the opposite. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ /** * Enables the modal property of the child window. After the modal property is enabled, * the parent window does not respond to user interactions until the child window is closed or the child window's modal property is disabled. * * @param { boolean } isModal - Whether to enable the modal property of the child window. * The value true means to enable the modal property, and false means the opposite. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ setSubWindowModal(isModal: boolean): Promise; /** * Set the modality of the window. * * @param { boolean } isModal - Enable the window modal if true, otherwise means the opposite. * @param { ModalityType } modalityType - Set modality type when the window modal is true. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ /** * Enables the modal property of the child window. After the modal property is enabled, * the parent window does not respond to user interactions until the child window is closed or the child window's modal property is disabled. * * @param { boolean } isModal - Whether to enable the modal property of the child window. The value true means to enable the modal property, * and false means the opposite. Currently, this parameter can only be set to true. * @param { ModalityType } modalityType - Modality type of the child window. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ setSubWindowModal(isModal: boolean, modalityType: ModalityType): Promise; /** * Set the height of the window decor. * * @param { number } - The height of window decor. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Sets the height of the title bar of this window. * This API takes effect for the window that has a title bar or a three-button area on 2-in-1 devices. * * @param { number } height - Height of the title bar. It takes effect only for the window with the title bar. * The value is an integer in the range [37,112]. The unit is vp. If a floating point number is passed in, * the value is rounded down. A value outside the range is invalid. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setWindowDecorHeight(height: number): void; /** * Get the height of the window decor. * * @returns { number } - The height of window decor. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Obtains the height of the title bar of this window. * This API takes effect for the window that has a title bar or a three-button area on 2-in-1 devices. * * @returns { number } - Height of the title bar. The value is an integer in the range [37,112]. The unit is vp. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ getWindowDecorHeight(): number; /** * Sets the button style of the decoration bar. The setting takes effect only for the main window and the child window with the window title enabled. * * @param { DecorButtonStyle } dectorStyle - Button style of the decoration bar. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ setDecorButtonStyle(dectorStyle: DecorButtonStyle): void; /** * Obtains the button style of the decoration bar. The setting takes effect only for the main window and the child window with the window title enabled. * * @returns { DecorButtonStyle } - Button style on the decoration bar of the current window. * The decoration button area is located in the upper right corner of the window. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ getDecorButtonStyle(): DecorButtonStyle; /** * Set touchable areas. By default, the entire window area is touchable. * If touchable areas are set in the window, touch events outside the areas will be transparent transmitted. * If the window area changes, you need to reset it. * * @param { Array } rects - Touchable areas. The maximum size cannot exceed 10, touchable area cannot exceed the window's area. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @systemapi * @since 12 */ setTouchableAreas(rects: Array): void; /** * Get the area of window title buttons. * * @returns { TitleButtonRect } - The area of window title buttons. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Obtains the rectangle that holds the minimize, maximize, and close buttons on the title bar of the main window or the decorated child window. * * @returns { TitleButtonRect } - Rectangle obtained, which is located in the upper right corner of the window. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ getTitleButtonRect(): TitleButtonRect; /** * Shows or hides the maximize, minimize, and split-screen buttons on the title bar of the main window. * * @param { boolean } isMaximizeVisible - Whether to show the maximize button. The value true means to show the button, and false means to hide it. * @param { boolean } isMinimizeVisible - Whether to show the minimize button. The value true means to show the button, and false means to hide it. * @param { boolean } isSplitVisible - Whether to show the split-screen button. The value true means to show the button, and false means to hide it. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 12 */ setTitleButtonVisible(isMaximizeVisible: boolean, isMinimizeVisible: boolean, isSplitVisible: boolean): void; /** * Shows or hides the maximize, minimize, and close buttons on the title bar of the main window. * * @param { boolean } isMaximizeButtonVisible - Whether to show the maximize button. The value true means to show the button, and false means the opposite. * If the maximize button is hidden, the corresponding restore button is also hidden in the maximize scenario. * @param { boolean } isMinimizeButtonVisible - Whether to show the minimize button. The value true means to show the button, and false means the opposite. * @param { boolean } isCloseButtonVisible - Whether to show the close button. The value true means to show the button, and false means the opposite. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ setWindowTitleButtonVisible(isMaximizeButtonVisible: boolean, isMinimizeButtonVisible: boolean, isCloseButtonVisible?: boolean): void; /** * Enable landscape multiWindow * * @returns { Promise } Promise that returns no value. * @throws {BusinessError} 1300002 - This window state is abnormal. * @throws {BusinessError} 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ enableLandscapeMultiWindow(): Promise; /** * Starts moving this window. This API uses a promise to return the result. * The window moves along with the cursor only when this API is called in the callback function of onTouch, where the event type is TouchType.Down. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300001 - Repeated operation. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ startMoving(): Promise; /** * Specifies the cursor position within the window and moves the window. It first adjusts the window to the cursor position before starting to move the window. * The window moves along with the cursor only when this API is called in the callback function of onTouch, where the event type is TouchType.Down. * * @param { number } offsetX - X-axis offset of the cursor position relative to the upper left corner of the window during movement, measured in px. * This parameter only accepts integer values; any floating-point input will be rounded down. * Negative values or values exceeding the window width are invalid. The window width can be obtained from WindowProperties. * @param { number } offsetY - Y-axis offset of the cursor position relative to the upper left corner of the window during movement, measured in px. * This parameter only accepts integer values; any floating-point input will be rounded down. * Negative values or values exceeding the window height are invalid. The window height can be obtained from WindowProperties. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300001 - Repeated operation. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ startMoving(offsetX: number, offsetY: number): Promise; /** * Stops window movement when a window is being dragged. This API uses a promise to return the result. * * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ stopMoving(): Promise; /** * Enable drag window. * * @param { boolean } enable - The value true means to enable window dragging, and false means the opposite. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 14 */ /** * Enable drag window. * * @param { boolean } enable - The value true means to enable window dragging, and false means the opposite. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @since 20 */ enableDrag(enable: boolean): Promise; /** * Disable landscape multiWindow * * @returns { Promise } Promise that returns no value. * @throws {BusinessError} 1300002 - This window state is abnormal. * @throws {BusinessError} 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ disableLandscapeMultiWindow(): Promise; /** * Set window transition animation * * @param { WindowTransitionType } transitionType - Transition animation type. * @param { TransitionAnimation } animation - Transition animation config. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1. Invalid parameter range. 2. Invalid parameter length. * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @atomicservice * @since 20 */ setWindowTransitionAnimation(transitionType: WindowTransitionType, animation: TransitionAnimation): Promise; /** * Get window transition animation configuration * * @param { WindowTransitionType } transitionType - Transition animation type. * @returns { TransitionAnimation | undefined } Transition animation with transition type, or undefined if it has not been set. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1. Invalid parameter range. * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @atomicservice * @since 20 */ getWindowTransitionAnimation(transitionType: WindowTransitionType): TransitionAnimation | undefined; /** * Register the callback of title buttons area change. * * @param { 'windowTitleButtonRectChange' } type - The value is fixed at 'windowTitleButtonRectChange', indicating the title buttons area change event. * @param { Callback } callback - Callback used to return the current title buttons area. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Subscribes to the change event of the rectangle that holds the minimize, maximize, and close buttons on the title bar of the window. * * @param { 'windowTitleButtonRectChange' } type - Event type. The value is fixed at 'windowTitleButtonRectChange', * indicating that the change event of the rectangle that holds the minimize, maximize, and close buttons. * @param { Callback } callback - Callback used to return the new rectangle. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ on(type: 'windowTitleButtonRectChange', callback: Callback): void; /** * Unregister the callback of title buttons area change. * * @param { 'windowTitleButtonRectChange' } type - The value is fixed at 'windowTitleButtonRectChange', indicating the title buttons area change event. * @param { Callback } callback - Callback used to return the current title buttons area. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Unsubscribes from the change event of the rectangle that holds the minimize, maximize, and close buttons on the title bar of the window. * * @param { 'windowTitleButtonRectChange' } type - Event type. The value is fixed at 'windowTitleButtonRectChange', * indicating that the change event of the rectangle that holds the minimize, maximize, and close buttons. * @param { Callback } callback - Callback used to return the new rectangle. 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. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ off(type: 'windowTitleButtonRectChange', callback?: Callback): void; /** * Set the window mask of window * * @param { Array> } windowMask - The mask of window. The value of the array is 0 and 1, the other number is illegal value. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ setWindowMask(windowMask: Array>): Promise; /** * Register the callback of windowRectChange * * @param { 'windowRectChange' } type - The value is fixed at 'windowRectChange', indicating the window rect change event. * @param { Callback } callback - Callback used to return the RectChangeOptions. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'windowRectChange', callback: Callback): void; /** * Unregister the callback of windowRectChange * * @param { 'windowRectChange' } type - The value is fixed at 'windowRectChange', indicating the window rect change event. * @param { Callback } callback - Callback used to return the RectChangeOptions. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'windowRectChange', callback?: Callback): void; /** * Register the callback of rectChangeInGlobalDisplay * * @param { 'rectChangeInGlobalDisplay' } type - The value is fixed at 'rectChangeInGlobalDisplay', indicating the window gloabl rect change event. * @param { Callback } callback - Callback used to return the RectChangeOptions. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 20 */ on(type: 'rectChangeInGlobalDisplay', callback: Callback): void; /** * Unregister the callback of rectChangeInGlobalDisplay * * @param { 'rectChangeInGlobalDisplay' } type - The value is fixed at 'rectChangeInGlobalDisplay', indicating the window global rect change event. * @param { Callback } [callback] - Callback used to return the RectChangeOptions. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @since 20 */ off(type: 'rectChangeInGlobalDisplay', callback?: Callback): void; /** * Convert the window coordinates to the global coordinates. * * @param { number } winX - Indicate the X-coordinate of the component relative to the current window. * @param { number } winY - Indicate the Y-coordinate of the component relative to the current window. * @returns { Position } The pair {x, y} represents respectively the X-coordinate * and Y-coordinate of the window relative to the main screen. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300010 - The operation in the current window status is invalid. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1.Invalid parameter range. * @syscap SystemCapability.Window.SessionManager * @since 20 */ clientToGlobalDisplay(winX: number, winY: number): Position; /** * Convert the global coordinates to the window coordinates. * * @param { number } globalDisplayX - Indicate the X-coordinate of the component relative to the main screen. * @param { number } globalDisplayY - Indicate the Y-coordinate of the component relative to the main screen. * @returns { Position } The pair {x, y} represents respectively the X-coordinate * and Y-coordinate of the window relative to the current screen. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300010 - The operation in the current window status is invalid. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1.Invalid parameter range. * @syscap SystemCapability.Window.SessionManager * @since 20 */ globalDisplayToClient(globalDisplayX: number, globalDisplayY: number): Position; /** * Register the callback of rotation change * * @param { 'rotationChange' } type - The value is fixed at 'rotationChange', indicating the window rotation change event. * @param { RotationChangeCallback } callback - Callback used to return the rotation change result. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ on(type: 'rotationChange', callback: RotationChangeCallback): void; /** * Unregister the callback of rotationChange * * @param { 'rotationChange' } type - The value is fixed at 'rotationChange', indicating the window rotation change event. * @param { RotationChangeCallback } callback - Callback used to return the RectChangeOptions. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ off(type: 'rotationChange', callback?: RotationChangeCallback): void; /** * UIExtension in window secure limit change callback on. * * @param { 'uiExtensionSecureLimitChange' } eventType The value is fixed at 'uiExtensionSecureLimitChange', indicating the UIExtension secure limit change. * @param { Callback } callback Callback used to return the result whether the APP has uiextension secure limit. * @throws { BusinessError } 801 - Capability not supported.Function on('uiExtensionSecureLimitChange') can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ on(eventType: 'uiExtensionSecureLimitChange', callback: Callback): void; /** * UIExtension in window secure limit change callback off. * * @param { 'uiExtensionSecureLimitChange' } eventType The value is fixed at 'uiExtensionSecureLimitChange', indicating the UIExtension secure limit change. * @param { Callback } callback Callback used to return the result whether the APP has uiextension secure limit. * @throws { BusinessError } 801 - Capability not supported.Function off('uiExtensionSecureLimitChange') can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ off(eventType: 'uiExtensionSecureLimitChange', callback?: Callback): void; /** * Set gray scale of window. * * @param { number } grayScale - The value of gray scale. * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ setWindowGrayScale(grayScale: number): Promise; /** * Set whether to enable immersive mode. * * @param { boolean } enabled - The value true means to enable immersive mode, and false means the opposite. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setImmersiveModeEnabledState(enabled: boolean): void; /** * Get whether the immersive mode is enabled or not. * * @returns { boolean } - The value true means the immersive mode is enabled, and false means the opposite. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ getImmersiveModeEnabledState(): boolean; /** * Checks whether the layout is immersive. * * @returns { boolean } The value true means that the layout is immersive, and false means the opposite. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @since 20 */ isImmersiveLayout(): boolean; /** * Get the window status of current window. * * @returns { WindowStatusType } - The status of window. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ getWindowStatus(): WindowStatusType; /** * Checks whether the window is focused. * * @returns { boolean } - Whether the window is focused. The value true means that the window is focused, and false means the opposite. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice * @since 12 */ isFocused(): boolean; /** * Creates a child window under the main window, another child window, or floating window. * * @param { string } name - Name of the child window. * @param { SubWindowOptions } options - Parameters used for creating the child window. * @returns { Promise } Promise used to used to return the child window created. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @StageModelOnly * @atomicservice * @since 12 */ createSubWindowWithOptions(name: string, options: SubWindowOptions): Promise; /** * Set the parent window of the child window. * * @param { number } windowId - Indicates parent window id. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300009 - The parent window is invaild. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ setParentWindow(windowId: number): Promise; /** * Get the parent window. * * @returns { Window } Parent Window. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300009 - The parent window is invaild. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ getParentWindow(): Window; /** * Set whether the sub window supports simultaneous display on multiple screens when the parent window is dragged to move or dragged to zoom. * * @param { boolean } enabled - The value true means sub window supports simultaneous display on multiple screens when the parent window * is dragged to move or dragged to zoom, and false means the opposite. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported.Function setFollowParentMultiScreenPolicy can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 17 */ setFollowParentMultiScreenPolicy(enabled: boolean): Promise; /** * Set whether the title bar and dock bar will show, when the mouse hovers over hot area. * * @param { boolean } isTitleHoverShown - The value true means to display the title bar, and false means the opposite. * @param { boolean } isDockHoverShown - The value true means to display the dock bar, and false means the opposite. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ /** * Sets whether to show the window title bar and dock bar when the cursor hovers over the hot zone while the main window is in full-screen mode. * * @param { boolean } isTitleHoverShown - Whether to show the window title bar. The value true means to show the window title bar, * and false means the opposite. The default value is true. * @param { boolean } isDockHoverShown - Whether to show the dock bar. The value true means to show the dock bar, * and false means the opposite. The default value is true. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ setTitleAndDockHoverShown(isTitleHoverShown?: boolean, isDockHoverShown?: boolean): Promise; /** * Set window container active and inactive color. * * @permission ohos.permission.SET_WINDOW_TRANSPARENT * @param { string } activeColor - window container color in active. * @param { string } inactiveColor - window container color in inactive. * @throws { BusinessError } 201 - Permission verification failed. * The application does not have the permission required to call the API. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @since 20 */ setWindowContainerColor(activeColor: string, inactiveColor: string): void; /** * Set whether window delay raise is enabled. * * @param { boolean } isEnabled - The value true means to enable window delay raise, and false means disable window delay raise. * @throws { BusinessError } 801 - Capability not supported.function setWindowDelayRaiseOnDrag can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ setWindowDelayRaiseOnDrag(isEnabled: boolean): void; /** * Set the zlevel of current sub window. * * @param { number } zLevel - the zlevel of current sub window. * @returns { Promise } - The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Function setSubWindowZLevel can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300009 - The parent window is invalid. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ setSubWindowZLevel(zLevel: number): Promise; /** * Get the zlevel of current sub window. * * @returns { number } - the zlevel of current sub window. * @throws { BusinessError } 801 - Capability not supported. Function getSubWindowZLevel can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300004 - Unauthorized operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ getSubWindowZLevel(): number; /** * Set the policy of key frame when resize by dragging. * * @param { KeyFramePolicy } keyFramePolicy - The policy of key frame to set. * @returns { Promise } - Promise is used to return the effective policy of key frame. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300004 - Unauthorized operation. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1. Invalid parameter range; 2. The parameter format is incorrect. * @syscap SystemCapability.Window.SessionManager * @since 20 */ setDragKeyFramePolicy(keyFramePolicy: KeyFramePolicy): Promise; } /** * Window stage callback event type * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * Window stage callback event type * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * Window stage callback event type * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ enum WindowStageEventType { /** * The window stage is running in the foreground. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * The window stage is running in the foreground. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * The window stage is running in the foreground. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ SHOWN = 1, /** * The window stage gains focus. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * The window stage gains focus. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * The window stage gains focus. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ ACTIVE = 2, /** * The window stage loses focus. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * The window stage loses focus. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * The window stage loses focus. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ INACTIVE = 3, /** * The window stage is running in the background. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * The window stage is running in the background. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * The window stage is running in the background. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ HIDDEN = 4, /** * The window stage is interactive in the foreground. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ RESUMED = 5, /** * The window stage is not interactive in the foreground. * * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ PAUSED = 6 } /** * Window stage lifecycle callback event type * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @since 20 */ enum WindowStageLifecycleEventType { /** * The window stage is running in the foreground. * * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @since 20 */ SHOWN = 1, /** * The window stage is interactive in the foreground. * * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @since 20 */ RESUMED = 2, /** * The window stage is not interactive in the foreground. * * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @since 20 */ PAUSED = 3, /** * The window stage is running in the background. * * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @since 20 */ HIDDEN = 4 } /** * Enum for window modality Type * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'14', '1.2':'20'} * @arkts 1.1&1.2 */ enum ModalityType { /** * The value means window modality. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'14', '1.2':'20'} * @arkts 1.1&1.2 */ WINDOW_MODALITY = 0, /** * The value means application modality. * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'14', '1.2':'20'} * @arkts 1.1&1.2 */ APPLICATION_MODALITY = 1, } /** * Options for window shown * * @interface ShowWindowOptions * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ interface ShowWindowOptions { /** * Indicates whether the window get focus when it is shown * * @type { ?boolean } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ focusOnShow?: boolean; } /** * Options for subwindow creation * * @interface SubWindowOptions * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Options for subwindow creation * * @interface SubWindowOptions * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ interface SubWindowOptions { /** * Indicates subwindow title * * @type { string } * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Indicates subwindow title * * @type { string } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ title: string; /** * Indicates decor of subwindow * * @type { boolean } * @syscap SystemCapability.Window.SessionManager * @since 11 */ /** * Indicates decor of subwindow * * @type { boolean } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ decorEnabled: boolean; /** * Indicates modality of subwindow * * @type { ?boolean } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 12 */ isModal?: boolean; /** * Indicates whether subwindow is topmost * * @type { ?boolean } * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @since 12 */ isTopmost?: boolean; /** * Indicates modality type of subwindow * * @type { ?ModalityType } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 14 */ modalityType?: ModalityType; /** * Indicates position and size of subwindow * * @type { ?Rect } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ windowRect?: Rect; /** * Indicates whether subwindow support fullscreen * * @type { ?boolean } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ maximizeSupported?: boolean; /** * Indicates zlevel of subwindow * * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 */ zLevel?: number; /** * Indicates whether subwindow show outline * * @type { ?boolean } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ outlineEnabled?: boolean; } /** * WindowStage * * @interface WindowStage * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 9 */ /** * WindowStage * * @interface WindowStage * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @since 10 */ /** * WindowStage * * @interface WindowStage * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ interface WindowStage { /** * Get main window of the stage. * * @returns { Promise } Callback used to return the subwindow. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * Get main window of the stage. * * @returns { Promise } Callback used to return the subwindow. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * Obtains the main window of this window stage. This API uses a promise to return the result. * * @returns { Promise } Promise used to return the main window. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ getMainWindow(): Promise; /** * Get main window of the stage. * * @param { AsyncCallback } callback Callback used to return the main window. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * Get main window of the stage. * * @param { AsyncCallback } callback Callback used to return the main window. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * Obtains the main window of this window stage. This API uses an asynchronous callback to return the result. * * @param { AsyncCallback } callback Callback used to return the main window. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ getMainWindow(callback: AsyncCallback): void; /** * Get main window of the stage. * * @returns { Window } * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * Get main window of the stage. * * @returns { Window } * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * Obtains the main window of this window stage. * * @returns { Window } Main window. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ getMainWindowSync(): Window; /** * Create sub window of the stage. * * @param { string } name window name of sub window * @returns { Promise } Promise used to return the subwindow. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * Create sub window of the stage. * * @param { string } name window name of sub window * @returns { Promise } Promise used to return the subwindow. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * Creates a child window for this window stage. This API uses a promise to return the result. * * @param { string } name Name of the child window. * @returns { Promise } Promise used to return the child window. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since 11 */ createSubWindow(name: string): Promise; /** * Create sub window of the stage. * * @param { string } name window name of sub window * @param { AsyncCallback } callback Callback used to return the subwindow. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * Create sub window of the stage. * * @param { string } name window name of sub window * @param { AsyncCallback } callback Callback used to return the subwindow. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * Creates a child window for this window stage. This API uses an asynchronous callback to return the result. * * @param { string } name Name of the child window. * @param { AsyncCallback } callback Callback used to return the child window. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since 11 */ createSubWindow(name: string, callback: AsyncCallback): void; /** * Create sub window of the stage. * * @param { string } name - window name of sub window * @param { SubWindowOptions } options - options of sub window creation * @returns { Promise } Promise used to return the subwindow. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.Window.SessionManager * @StageModelOnly * @since 11 */ /** * Create sub window of the stage. * * @param { string } name - window name of sub window * @param { SubWindowOptions } options - options of sub window creation * @returns { Promise } Promise used to return the subwindow. * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.Window.SessionManager * @StageModelOnly * @atomicservice * @since 12 */ createSubWindowWithOptions(name: string, options: SubWindowOptions): Promise; /** * Get sub window of the stage. * * @returns { Promise> } * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * Get sub window of the stage. * * @returns { Promise> } * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * Obtains all the child windows of this window stage. This API uses a promise to return the result. * * @returns { Promise> } Promise used to return all the child windows. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since 11 */ getSubWindow(): Promise>; /** * Get sub window of the stage. * * @param { AsyncCallback> } callback Callback used to return all the subwindows. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * Get sub window of the stage. * * @param { AsyncCallback> } callback Callback used to return all the subwindows. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * Obtains all the child windows of this window stage. This API uses a promise to return the result. * * @param { AsyncCallback> } callback Callback used to return all the child windows. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since 11 */ getSubWindow(callback: AsyncCallback>): void; /** * Loads the content of a page, with its path in the current project specified, to the main window * of this window stage, and transfers the state attribute to the page through a local storage. * This API uses an asynchronous callback to return the result. * You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path Path of the page to which the content will be loaded * @param { LocalStorage } storage The data object shared within the content instance loaded by the window * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @since 9 */ /** * Loads the content of a page, with its path in the current project specified, to the main window * of this window stage, and transfers the state attribute to the page through a local storage. * This API uses an asynchronous callback to return the result. * You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path Path of the page to which the content will be loaded * @param { LocalStorage } storage The data object shared within the content instance loaded by the window * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @since 10 */ /** * Loads the content of a page, with its path in the current project specified, to the main window * of this window stage, and transfers the state attribute to the page through a local storage. * This API uses an asynchronous callback to return the result. * You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path Path of the page to which the content will be loaded * @param { LocalStorage } storage The data object shared within the content instance loaded by the window * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ loadContent(path: string, storage: LocalStorage, callback: AsyncCallback): void; /** * Loads the content of a page, with its path in the current project specified, to the main window * of this window stage, and transfers the state attribute to the page through a local storage. * This API uses a promise to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path of the page to which the content will be loaded * @param { LocalStorage } storage The data object shared within the content instance loaded by the window * @returns { Promise } * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @since 9 */ /** * Loads the content of a page, with its path in the current project specified, to the main window * of this window stage, and transfers the state attribute to the page through a local storage. * This API uses a promise to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path of the page to which the content will be loaded * @param { LocalStorage } storage The data object shared within the content instance loaded by the window * @returns { Promise } * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @since 10 */ /** * Loads the content of a page, with its path in the current project specified, to the main window * of this window stage, and transfers the state attribute to the page through a local storage. * This API uses a promise to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path of the page to which the content will be loaded * @param { LocalStorage } storage The data object shared within the content instance loaded by the window * @returns { Promise } * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ loadContent(path: string, storage?: LocalStorage): Promise; /** * Loads content from a page to this window stage. This API uses an asynchronous callback to * return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path of the page to which the content will be loaded * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @since 9 */ /** * Loads content from a page to this window stage. This API uses an asynchronous callback to * return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path of the page to which the content will be loaded * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @since 10 */ /** * Loads content from a page to this window stage. This API uses an asynchronous callback to * return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) * before loading the new content. Exercise caution when using it. * * @param { string } path of the page to which the content will be loaded * @param { AsyncCallback } callback Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Invalid path parameter. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ loadContent(path: string, callback: AsyncCallback): void; /** * Loads the content of a named route page to this window, and transfers the state attribute to the page through a local storage. * This API uses an asynchronous callback to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) before loading the new content. * Exercise caution when using it. * * @param { string } name - Name of the named route page. * @param { LocalStorage } storage - Page-level UI state storage unit, which is used to transfer the state attribute for the page. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ loadContentByName(name: string, storage: LocalStorage, callback: AsyncCallback): void; /** * Loads the content of a named route page to this window, and transfers the state attribute to the page through a local storage. * This API uses an asynchronous callback to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) before loading the new content. * Exercise caution when using it. * * @param { string } name - Name of the named route page. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ loadContentByName(name: string, callback: AsyncCallback): void; /** * Loads the content of a named route page to this window, and transfers the state attribute to the page through a local storage. * This API uses an asynchronous callback to return the result. You are advised to call this API during UIAbility startup. * If called multiple times, this API will destroy the existing page content (UIContent) before loading the new content. * Exercise caution when using it. * * @param { string } name - Name of the named route page. * @param { LocalStorage } storage - Page-level UI state storage unit, which is used to transfer the state attribute for the page. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @stagemodelonly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ loadContentByName(name: string, storage?: LocalStorage): Promise; /** * Window stage event callback on. * * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. * @param { Callback } callback Callback used to return the window stage lifecycle state. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * Window stage event callback on. * * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. * @param { Callback } callback Callback used to return the window stage lifecycle state. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * Subscribes to the window stage lifecycle change event. * * @param { 'windowStageEvent' } eventType Event type. The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. * @param { Callback } callback Callback used to return the window stage lifecycle state. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ on(eventType: 'windowStageEvent', callback: Callback): void; /** * Window stage event callback off. * * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. * @param { Callback } callback Callback used to return the window stage lifecycle state. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @since 9 */ /** * Window stage event callback off. * * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. * @param { Callback } callback Callback used to return the window stage lifecycle state. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @since 10 */ /** * Unsubscribes from the window stage lifecycle change event. * * @param { 'windowStageEvent' } eventType Event type. The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. * @param { Callback } callback Callback used to return the window stage lifecycle state. * If a value is passed in, the corresponding subscription is canceled. * If no value is passed in, all subscriptions to the specified event are canceled. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; * 2. Parameter verification failed. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @StageModelOnly * @crossplatform * @atomicservice * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ off(eventType: 'windowStageEvent', callback?: Callback): void; /** * Subscribes to the window stage lifecycle change event. * * @param { 'windowStageLifecycleEvent' } eventType Event type. * The value is fixed at 'windowStageLifecycleEvent', indicating the window stage lifecycle change event. * @param { Callback } callback Callback used to * return the window stage lifecycle state. * @throws { BusinessError } 801 - Capability not supported. * Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @since 20 */ on(eventType: 'windowStageLifecycleEvent', callback: Callback): void; /** * Unsubscribes from the window stage lifecycle change event. * * @param { 'windowStageLifecycleEvent' } eventType Event type. * The value is fixed at 'windowStageLifecycleEvent', indicating the window stage lifecycle change event. * @param { Callback } [callback] Callback used to * return the window stage lifecycle state. * If a value is passed in, the corresponding subscription is canceled. * If no value is passed in, all subscriptions to the specified event are canceled. * @throws { BusinessError } 801 - Capability not supported. * Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @since 20 */ off(eventType: 'windowStageLifecycleEvent', callback?: Callback): void; /** * Subscribes to the click event on the close button in the three-button navigation bar of the main window. * This event is triggered when the close button in the three-button navigation bar of the main window is clicked. * * @param { 'windowStageClose' } eventType - Event type. The value is fixed at 'windowStageClose', * indicating that the close button in the three-button navigation bar of the main window is clicked. * @param { Callback } callback - Callback invoked when the close button in the upper right corner of the main window is clicked. * The return value determines whether to continue to close the main window. * The value true means not to close the main window, and false means to continue to close the main window. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @atomicservice * @since 14 */ on(eventType: 'windowStageClose', callback: Callback): void; /** * Unsubscribes from the event indicating that the main window is closed. * * @param { 'windowStageClose' } eventType - Event type. The value is fixed at 'windowStageClose', * indicating that the close button in the three-button navigation bar of the main window is clicked. * @param { Callback } callback - Callback invoked when the close button in the upper right corner of the main window is clicked. * 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. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @atomicservice * @since 14 */ off(eventType: 'windowStageClose', callback?: Callback): void; /** * Disable window decoration. It must be called before loadContent. * * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @StageModelOnly * @since 9 */ /** * Disable window decoration. It must be called before loadContent. * * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @StageModelOnly * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ disableWindowDecor(): void; /** * Sets whether can show on lock screen or not * * @param { boolean } showOnLockScreen can show on lock screen if true, or not if false * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since 9 */ /** * Sets whether can show on lock screen or not * * @param { boolean } showOnLockScreen can show on lock screen if true, or not if false * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. * @StageModelOnly * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ setShowOnLockScreen(showOnLockScreen: boolean): void; /** * Set whether to use default density. * * @param { boolean } enabled - Use default density if true, or follow system density change if false * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.Window.SessionManager * @StageModelOnly * @atomicservice * @since 12 */ setDefaultDensityEnabled(enabled: boolean): void; /** * Sets the custom density of ability. * * @param { number } density - the specified custom density value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.Window.SessionManager * @StageModelOnly * @atomicservice * @since 15 */ setCustomDensity(density: number): void; /** * Sets the custom density of ability. * * @param { number } density - the specified custom density value. * @param { boolean } [applyToSubWindow] - whether to apply the custom density to already created subwindows. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @since 20 */ setCustomDensity(density: number, applyToSubWindow?: boolean): void; /** * Allows the application to control the time when the launch page disappears. * This API takes effect only for the application main window when enable.remove.starting.window under metadata in abilities in the module.json5 file is set to true. * * @returns { Promise } - Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @StageModelOnly * @atomicservice * @since 14 */ removeStartingWindow(): Promise; /** * Set the application modality of the windowStage. * * @param { boolean } isModal - Enable the window modal if true, otherwise means the opposite. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @StageModelOnly * @atomicservice * @since 14 */ /** * Enables the modal property of the main window. * * @param { boolean } isModal - Whether to enable the modal property of the main window. * The value true means to enable the modal property, and false means the opposite. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300005 - This window stage is abnormal. * @syscap SystemCapability.Window.SessionManager * @StageModelOnly * @atomicservice * @since 20 */ setWindowModal(isModal: boolean): Promise; /** * Sets whether to enable the auto-save feature for the size of the main window. * * @param { boolean } enabled - Whether to enable the auto-save feature for the main window's size. * The value true means to enable the auto-save feature, and false means the opposite. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @StageModelOnly * @atomicservice * @since 14 */ setWindowRectAutoSave(enabled: boolean): Promise; /** * Set to automatically save the window rect and whether to enable specifiedFlag. * Through the specifiedFlag flag, the window is marked and its rect is saved. * * @param { boolean } enabled - Enable the window rect auto-save if true, otherwise means the opposite. * @param { boolean } isSaveBySpecifiedFlag - Enable the specifiedFlag if true, otherwise means the opposite. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Function setWindowRectAutoSave can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @atomicservice * @since 17 */ setWindowRectAutoSave(enabled: boolean, isSaveBySpecifiedFlag: boolean): Promise; /** * Whether the window supports the window rect auto-save. * * @returns { Promise } Promise used to return the result. * The value true means that the window rect auto-save is supported, and false means the opposite. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @syscap SystemCapability.Window.SessionManager * @StageModelOnly * @atomicservice * @since 14 */ /** * Checks whether the auto-save feature is enabled for the main window's size. * * @returns { Promise } Promise used to return the result. The value true means that the auto-save feature is enabled, and false means the opposite. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @StageModelOnly * @atomicservice * @since 20 */ isWindowRectAutoSave(): Promise; /** * Sets the supported window modes of the main window. * * @param { Array } supportedWindowModes - The supported modes of window. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @StageModelOnly * @atomicservice * @since 15 */ setSupportedWindowModes(supportedWindowModes: Array): Promise; /** * Sets the supported window modes of the main window. * * @param { Array } supportedWindowModes - The supported modes of window. * @param { boolean } grayOutMaximizeButton - Whether to gray out the window maximize button. The value true means to gray out the button, and false means the opposite. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 801 - Capability not supported. Function setSupportedWindowModes can not work correctly due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1. Invalid parameter range. 2. Invalid parameter length. 3. Incorrect parameter format. * @syscap SystemCapability.Window.SessionManager * @stagemodelonly * @since 20 */ setSupportedWindowModes(supportedWindowModes: Array, grayOutMaximizeButton: boolean): Promise; /** * Sets Image for recent. * * @param { number } imgResourceId - This value is resource ID for the recent image. * @param { ImageFit } value - Sets the zoom type of an image. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 1300002 - This window state is abnormal. * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @throws { BusinessError } 1300016 - Parameter error. Possible cause: 1. Invalid parameter range. 2. Invalid parameter length. 3. Incorrect parameter format. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since 19 */ setImageForRecent(imgResourceId: number, value: ImageFit): Promise; } /** * Attribute of the window for UI service extension ability. * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since arkts {'1.1':'14', '1.2':'20'} * @arkts 1.1&1.2 */ enum ExtensionWindowAttribute { /** * System window. * * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since arkts {'1.1':'14', '1.2':'20'} * @arkts 1.1&1.2 */ SYSTEM_WINDOW = 0, /** * Sub window. * * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since arkts {'1.1':'14', '1.2':'20'} * @arkts 1.1&1.2 */ SUB_WINDOW = 1 } /** * Options for system window creation. * * @interface SystemWindowOptions * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since arkts {'1.1':'14', '1.2':'20'} * @arkts 1.1&1.2 */ interface SystemWindowOptions { /** * Indicates window type. * * @type { WindowType } * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since arkts {'1.1':'14', '1.2':'20'} * @arkts 1.1&1.2 */ windowType: WindowType; } /** * Configuration of the window for UI service extension ability. * * @interface ExtensionWindowConfig * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since arkts {'1.1':'14', '1.2':'20'} * @arkts 1.1&1.2 */ interface ExtensionWindowConfig { /** * Window name. * * @type { string } * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since arkts {'1.1':'14', '1.2':'20'} * @arkts 1.1&1.2 */ windowName: string; /** * Defines whether the window is a subwindow or a system window. * * @type { ExtensionWindowAttribute } * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since 14 */ windowAttribute: ExtensionWindowAttribute; /** * The position and size of window. * * @type { Rect } * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since 14 */ windowRect: Rect; /** * The options of sub window creation. * * @type { ?SubWindowOptions } * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since 14 */ subWindowOptions?: SubWindowOptions; /** * The options of system window creation. * * @type { ?SystemWindowOptions } * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. * @stagemodelonly * @since 14 */ systemWindowOptions?: SystemWindowOptions; } /** * The layout info of Window. * * @interface WindowLayoutInfo * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ interface WindowLayoutInfo { /** * The position and size of window. * * @type { Rect } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 15 */ windowRect: Rect; } /** * Enum for window mode * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ enum GlobalWindowMode { /** * Fullscreen * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ FULLSCREEN = 1, /** * Split * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ SPLIT = 1 << 1, /** * Float * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ FLOAT = 1 << 2, /** * Picture in picture * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 20 */ PIP = 1 << 3 } /** * Rotation change type * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ enum RotationChangeType { /** * Rotation will begin * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ WINDOW_WILL_ROTATE = 0, /** * Rotation end * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ WINDOW_DID_ROTATE = 1 } /** * Rect type * * @enum { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ enum RectType { /** * Rect relative to screen * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ RELATIVE_TO_SCREEN = 0, /** * Rect relative to parent window * * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ RELATIVE_TO_PARENT_WINDOW = 1 } /** * Screenshot event type * * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 20 */ enum ScreenshotEventType { /** * System screenshot * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 20 */ SYSTEM_SCREENSHOT = 0, /** * System screenshot abort * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 20 */ SYSTEM_SCREENSHOT_ABORT = 1, /** * Scroll shot start * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 20 */ SCROLL_SHOT_START = 2, /** * Scroll shot end * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 20 */ SCROLL_SHOT_END = 3, /** * Scroll shot abort * * @syscap SystemCapability.WindowManager.WindowManager.Core * @since 20 */ SCROLL_SHOT_ABORT = 4, } /** * Rotation change info * * @interface RotationChangeInfo * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ interface RotationChangeInfo { /** * Rotation change type * * @type { RotationChangeType } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ type: RotationChangeType; /** * window orientation * * @type { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ orientation: number; /** * Display id * * @type { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ displayId: number; /** * Display rect * * @type { Rect } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ displayRect: Rect; } /** * Rotation change result * * @interface RotationChangeResult * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ interface RotationChangeResult { /** * Rect type * * @type { RectType } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ rectType: RectType; /** * Window rect * * @type { Rect } * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ windowRect: Rect; } /** * Rotation Change callback * * @typedef RotationChangeCallback * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ interface RotationChangeCallback { /** * Defines the rotation change callback * * @param { T } info * @returns { U } result * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 19 */ (info: T): U; } } export default window;