/*
* 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, Callback } from './@ohos.base';
import BaseContext from './application/BaseContext';
import { LocalStorage } from 'StateManagement';
import image from './@ohos.multimedia.image';
import rpc from './@ohos.rpc';
import dialogRequest from './@ohos.app.ability.dialogRequest';
import { UIContext } from './@ohos.arkui.UIContext';
/**
* Window manager.
*
* @namespace window
* @syscap SystemCapability.WindowManager.WindowManager.Core
*/
/**
* Window manager.
*
* @namespace window
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @since 10
*/
/**
* Window manager.
*
* @namespace window
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 11
*/
declare namespace window {
/**
* The type of a window.
*
* @enum { number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
enum WindowType {
/**
* App.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @FAModelOnly
* @since 7
*/
TYPE_APP,
/**
* 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
*/
TYPE_INPUT_METHOD,
/**
* Status bar.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 9
*/
TYPE_STATUS_BAR,
/**
* Panel.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 9
*/
TYPE_PANEL,
/**
* Keyguard.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 9
*/
TYPE_KEYGUARD,
/**
* Volume.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 9
*/
TYPE_VOLUME_OVERLAY,
/**
* Navigation bar.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 9
*/
TYPE_NAVIGATION_BAR,
/**
* Float.
*
* @permission ohos.permission.SYSTEM_FLOAT_WINDOW
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @StageModelOnly
* @since 9
*/
TYPE_FLOAT,
/**
* Wallpaper.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 9
*/
TYPE_WALLPAPER,
/**
* Desktop.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 9
*/
TYPE_DESKTOP,
/**
* Recent.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 9
*/
TYPE_LAUNCHER_RECENT,
/**
* Dock.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 9
*/
TYPE_LAUNCHER_DOCK,
/**
* Voice interaction.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 9
*/
TYPE_VOICE_INTERACTION,
/**
* Pointer.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 9
*/
TYPE_POINTER,
/**
* Float camera.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 9
*/
TYPE_FLOAT_CAMERA,
/**
* Dialog.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @StageModelOnly
* @since 10
*/
TYPE_DIALOG,
/**
* Screenshot.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 9
*/
TYPE_SCREENSHOT,
/**
* System Toast.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 11
*/
TYPE_SYSTEM_TOAST,
/**
* Divider.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 11
*/
TYPE_DIVIDER,
/**
* Global Search.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 11
*/
TYPE_GLOBAL_SEARCH
}
/**
* 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
*/
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
*/
TYPE_SYSTEM,
/**
* Notch
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Notch
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 11
*/
TYPE_CUTOUT,
/**
* Area for system gesture
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Area for system gesture
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 11
*/
TYPE_SYSTEM_GESTURE,
/**
* Area for keyboard
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Area for keyboard
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 11
*/
TYPE_KEYBOARD,
/**
* Area for navigation indicator
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 11
*/
TYPE_NAVIGATION_INDICATOR
}
/**
* Describes the window mode of an application
*
* @enum { number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 7
*/
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 7
*/
FLOATING
}
/**
* 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
*/
enum WindowStatusType {
/**
* Undefined status of the window
*
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
UNDEFINED = 0,
/**
* Full screen status of the window
*
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
FULL_SCREEN,
/**
* Maximize status of the window
*
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
MAXIMIZE,
/**
* Minimize status of the window
*
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
MINIMIZE,
/**
* Floating status of the window
*
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
FLOATING,
/**
* Split screen status of the window
*
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
SPLIT_SCREEN
}
/**
* Properties of status bar and navigation bar, it couldn't update automatically
*
* @interface SystemBarProperties
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 6
*/
interface SystemBarProperties {
/**
* The color of the status bar.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 6
*/
statusBarColor?: string;
/**
* The light icon of the status bar.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
isStatusBarLightIcon?: boolean;
/**
* The content color of the status bar
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 8
*/
statusBarContentColor?: string;
/**
* The color of the navigation bar.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 6
*/
navigationBarColor?: string;
/**
* The light icon of the navigation bar.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
isNavigationBarLightIcon?: boolean;
/**
* The content color of the navigation bar
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 8
*/
navigationBarContentColor?: string;
}
/**
* System bar tint of region
*
* @interface SystemBarRegionTint
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 8
*/
interface SystemBarRegionTint {
/**
* System bar type
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 8
*/
type: WindowType;
/**
* The visibility of system bar
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 8
*/
isEnable?: boolean;
/**
* The region of system bar
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 8
*/
region?: Rect;
/**
* The background color of the system bar.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 8
*/
backgroundColor?: string;
/**
* The content color of the system bar.
*
* @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 8
*/
interface SystemBarTintState {
/**
* Id of display
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 8
*/
displayId: number;
/**
* Region tint of systembar
*
* @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 11
*/
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.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 11
*/
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.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 11
*/
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.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 11
*/
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.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 11
*/
height: number;
}
/**
* Avoid area
*
* @interface AvoidArea
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Avoid area
*
* @interface AvoidArea
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 11
*/
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 11
*/
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
*/
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
*/
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
*/
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
*/
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 11
*/
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 11
*/
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 11
*/
height: 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 11
*/
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 11
*/
windowRect: Rect;
/**
* The position relative to the window and size of drawable area
*
* @type { Rect }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 11
*/
drawableRect: Rect;
/**
* Window type
*
* @type { WindowType }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
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
*/
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
*/
isLayoutFullScreen: boolean;
/**
* Whether the window can gain focus. The default value is true
*
* @type { boolean }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
focusable: boolean;
/**
* Whether the window is touchable. The default value is false
*
* @type { boolean }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
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 11
*/
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 11
*/
isKeepScreenOn: boolean;
/**
* Whether make window in privacy mode or not.
*
* @type { boolean }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
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
*/
isTransparent: boolean;
/**
* Window id.
*
* @type { number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
id: 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
*/
enum ColorSpace {
/**
* Default color space.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 8
*/
/**
* Default color space.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @since 11
*/
DEFAULT,
/**
* 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
}
/**
* Describes the scale Transition Options of window
*
* @interface ScaleOptions
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
interface ScaleOptions {
/**
* The scale param of x direction. Default is 1.f
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
x?: number;
/**
* The scale param of y direction. Default is 1.f
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
y?: number;
/**
* The scale param of pivot point of x. Default is 0.5f, Interval is 0.f - 1.f
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
pivotX?: number;
/**
* The scale param of pivot point of y. Default is 0.5f, Interval is 0.f - 1.f
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
pivotY?: number;
}
/**
* Describes the rotate Transition Options of window
*
* @interface RotateOptions
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
interface RotateOptions {
/**
* The rotate degree of x direction. Default value is 0.f
*
* @type { ?number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
x?: number;
/**
* The rotate degree of y direction. Default value is 0.f
*
* @type { ?number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
y?: number;
/**
* The rotate degree of z direction. Default value is 0.f
*
* @type { ?number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
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 9
*/
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 9
*/
pivotY?: number;
}
/**
* Describes the translate Transition Options of window
*
* @interface TranslateOptions
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
interface TranslateOptions {
/**
* The translate pixel param of x direction. Default is 0.f
*
* @type { ?number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
x?: number;
/**
* The translate pixel param of y direction. Default is 0.f
*
* @type { ?number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
y?: number;
/**
* The translate pixel param of z direction. Default is 0.f
*
* @type { ?number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
z?: number;
}
/**
* Transition Context
*
* @interface TransitionContext
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
interface TransitionContext {
/**
* The target window with animation
*
* @type { Window }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
completeTransition(isCompleted: boolean): void;
}
/**
* Transition Controller
*
* @interface TransitionController
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
interface TransitionController {
/**
* Animation configuration when showing window
*
* @param { TransitionContext } context - The transition context.
* @throws { BusinessError } 401 - Parameter error.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
animationForShown(context: TransitionContext): void;
/**
* Animation configuration when hiding window
*
* @param { TransitionContext } context - The transition context.
* @throws { BusinessError } 401 - Parameter error.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi
* @since 9
*/
animationForHidden(context: TransitionContext): void;
}
/**
* Configuration parameters for window creation.
*
* @interface Configuration
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
interface Configuration {
/**
* Indicates window id.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
name: string;
/**
* Indicates window type
*
* @type { WindowType }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
windowType: WindowType;
/**
* Indicates window context.
*
* @type { ?BaseContext }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
ctx?: BaseContext;
/**
* Indicates display ID.
*
* @type { ?number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
displayId?: number;
/**
* Indicates Parent window id
*
* @type { ?number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
parentId?: number;
}
/**
* Limits of window.
*
* @interface WindowLimits
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
interface WindowLimits {
/**
* The maximum width of the window.
*
* @type { ?number }
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
maxWidth?: number;
/**
* The maximum height of the window.
*
* @type { ?number }
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
maxHeight?: number;
/**
* The minimum width of the window.
*
* @type { ?number }
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
minWidth?: number;
/**
* The minimum height of the window.
*
* @type { ?number }
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
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
*/
interface TitleButtonRect {
/**
* The right of the Rect.
*
* @type { number }
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
right: number;
/**
* The top of the Rect.
*
* @type { number }
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
top: number;
/**
* The width of the Rect.
*
* @type { number }
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
width: number;
/**
* The height of the Rect.
*
* @type { number }
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
height: number;
}
/**
* 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.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 1300001 - Repeated operation.
* @throws { BusinessError } 1300006 - This window context is abnormal.
* @throws { BusinessError } 1300008 - The operation is on invalid display.
* @throws { BusinessError } 1300009 - The parent window is invalid.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
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.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 1300001 - Repeated operation.
* @throws { BusinessError } 1300006 - This window context is abnormal.
* @throws { BusinessError } 1300008 - The operation is on invalid display.
* @throws { BusinessError } 1300009 - The parent window is invalid.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
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.
* @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.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @since 10
*/
/**
* Find the window by name.
*
* @param { string } name - Indicates window name.
* @returns { Window } Window found.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 11
*/
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.
* @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.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300006 - This window context is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @since 10
*/
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.
* @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.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300006 - This window context is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @since 10
*/
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.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 9
*/
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.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 9
*/
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
*/
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
*/
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.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 9
*/
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.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 9
*/
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 } 401 - Parameter error..
* @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 } 401 - Parameter error..
* @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, non-system application uses system API.
* @throws { BusinessError } 401 - Parameter error.
* @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, non-system application uses system API.
* @throws { BusinessError } 401 - Parameter error.
* @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.
* @throws { BusinessError } 801 - Capability not supported.
* @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
*/
function shiftAppWindowFocus(sourceWindowId: number, targetWindowId: 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 } 401 - Parameter error.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 8
*/
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 } 401 - Parameter error.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 8
*/
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 } 401 - Parameter error..
* @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 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 } 401 - Parameter error..
* @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 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, non-system application uses system API.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 10
*/
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, non-system application uses system API.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 10
*/
function off(type: 'waterMarkFlagChange', callback?: Callback): void;
/**
* 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 11
*/
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
*/
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 11
*/
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
*/
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
*/
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
*/
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 11
*/
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
*/
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
*/
AUTO_ROTATION_LANDSCAPE = 7,
/**
* Follow the rotation of the sensor, controlled by auto rotation lock.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
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
*/
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
*/
AUTO_ROTATION_LANDSCAPE_RESTRICTED = 10,
/**
* Locked mode, keep the same direction as previous one.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
LOCKED = 11
}
/**
* Type of blur style
*
* @enum { number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 9
*/
enum BlurStyle {
/**
* Close blur.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 9
*/
OFF,
/**
* Blur style thin.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 9
*/
THIN,
/**
* Blur style regular.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 9
*/
REGULAR,
/**
* Blur style thick.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 9
*/
THICK
}
/**
* 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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
WINDOW_HIDDEN = 4,
/**
* The value of window event is window destroy
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 11
*/
WINDOW_DESTROYED = 7
}
/**
* Specific system bar type.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 11
*/
type SpecificSystemBar = 'status' | 'navigation' | 'navigationIndicator';
/**
* Window
*
* @interface Window
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 6
*/
/**
* Window
*
* @interface Window
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 11
*/
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(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(): 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
*/
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
*/
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
*/
/**
* 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
* @atomicservice
* @since 11
*/
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
*/
/**
* Show window.
*
* @returns { Promise } Promise that returns no value.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 11
*/
showWindow(): 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
*/
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
*/
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.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @since 10
*/
/**
* 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
* @crossplatform
* @atomicservice
* @since 11
*/
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.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @since 10
*/
/**
* 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
* @crossplatform
* @atomicservice
* @since 11
*/
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.
* @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.
* @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.
* @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
*/
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.
* @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.
* @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.
* @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
*/
moveWindowTo(x: number, y: number, callback: AsyncCallback): void;
/**
* 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.
* @param { number } height - Indicates the height of the window.
* @returns { Promise } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error.
* @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.
* @param { number } height - Indicates the height of the window.
* @returns { Promise } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error.
* @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.
* @param { number } height - Indicates the height of the window.
* @returns { Promise } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error.
* @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
*/
resize(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.
* @throws { BusinessError } 401 - Parameter error.
* @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.
* @param { number } height - Indicates the height of the window.
* @param { AsyncCallback } callback - Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error.
* @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.
* @param { number } height - Indicates the height of the window.
* @param { AsyncCallback } callback - Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error.
* @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
*/
resize(width: number, height: number, callback: AsyncCallback): void;
/**
* 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.
* @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
*/
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.
* @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
*/
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 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 11
*/
getWindowProperties(): WindowProperties;
/**
* 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.
* @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.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 11
*/
getWindowAvoidArea(type: AvoidAreaType): AvoidArea;
/**
* 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.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
setWindowLayoutFullScreen(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.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
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.
* @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.
* @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
*/
setWindowSystemBarEnable(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.
* @throws { BusinessError } 401 - Parameter error.
* @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
* @returns { Promise } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error.
* @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
*/
setWindowSystemBarEnable(names: Array<'status' | 'navigation'>): Promise;
/**
* Set specific system bar to have visible.
*
* @param {SpecificSystemBar} name - the set of system bar
* @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.
* @throws {BusinessError} 1300002 - This window state is abnormal.
* @throws {BusinessError} 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 11
*/
setSpecificSystemBarEnabled(name: SpecificSystemBar, enable: 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.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
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.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
setWindowSystemBarProperties(systemBarProperties: SystemBarProperties): Promise;
/**
* 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.
* @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.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @since 10
*/
/**
* 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.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 11
*/
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.
* @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.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @since 10
*/
/**
* 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.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 11
*/
setPreferredOrientation(orientation: Orientation, callback: AsyncCallback): void;
/**
* Loads content
*
* @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.
* @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 content
*
* @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.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @StageModelOnly
* @crossplatform
* @since 10
*/
/**
* Loads content
*
* @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.
* @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
*/
loadContent(path: string, storage: LocalStorage, callback: AsyncCallback): void;
/**
* Loads content
*
* @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.
* @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 content
*
* @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.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @StageModelOnly
* @crossplatform
* @since 10
*/
/**
* Loads content
*
* @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.
* @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
*/
loadContent(path: string, storage: LocalStorage): Promise;
/**
* 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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.window.Window#setUIContent
*/
loadContent(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.
* @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 - If param is invalid
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @stagemodelonly
* @crossplatform
* @since 10
*/
/**
* Get the UIContext associate with the window content.
*
* @returns { UIContext } the object of UIContext.
* @throws { BusinessError } 401 - If param is invalid
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 11
*/
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.
* @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.
* @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
*/
/**
* 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.
* @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
*/
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.
* @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.
* @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
*/
/**
* 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.
* @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
*/
setUIContent(path: string): Promise;
/**
* Loads content by named router
*
* @param { string } name - name 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.
* @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 content by named router
*
* @param { string } name - name of the page to which the content will be loaded.
* @param { AsyncCallback } callback - Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error.
* @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 content by named router
*
* @param { string } name - name 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.
* @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 11
*/
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.
* @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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 11
*/
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.
* @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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 11
*/
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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* 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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 11
*/
on(type: 'avoidAreaChange', callback: Callback<{ type: AvoidAreaType, area: AvoidArea }>): 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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* 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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 11
*/
off(type: 'avoidAreaChange', callback?: Callback<{ type: AvoidAreaType, area: AvoidArea }>): 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.
* @throws { BusinessError } 401 - Parameter error.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
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.
* @throws { BusinessError } 401 - Parameter error.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
off(type: 'keyboardHeightChange', callback?: Callback): void;
/**
* Touch outside callback on.
*
* @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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 11
*/
on(type: 'touchOutside', callback: Callback): void;
/**
* Touch outside callback off.
*
* @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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 11
*/
off(type: 'touchOutside', 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.
* @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
* @since 11
*/
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.
* @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
* @since 11
*/
off(type: 'windowVisibilityChange', 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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
off(type: 'screenshot', 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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 10
*/
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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 10
*/
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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 10
*/
/**
* 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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 11
*/
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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 10
*/
/**
* 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.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 11
*/
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.
* @throws { BusinessError } 801 - Capability not supported on this device.
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
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.
* @throws { BusinessError } 801 - Capability not supported on this device.
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
off(type: 'windowStatusChange', 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.
* @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
*/
bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback