1/* 2 * Copyright (c) 2021 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16/** 17 * @file 18 * @kit ArkUI 19 */ 20 21import { AsyncCallback, BusinessError, Callback } from './@ohos.base'; 22import BaseContext from './application/BaseContext'; 23import image from './@ohos.multimedia.image'; 24import rpc from './@ohos.rpc'; 25import dialogRequest from './@ohos.app.ability.dialogRequest'; 26import { UIContext } from './@ohos.arkui.UIContext'; 27 28/** 29 * Window manager. 30 * 31 * @namespace window 32 * @syscap SystemCapability.WindowManager.WindowManager.Core 33 */ 34/** 35 * Window manager. 36 * 37 * @namespace window 38 * @syscap SystemCapability.WindowManager.WindowManager.Core 39 * @crossplatform 40 * @since 10 41 */ 42/** 43 * Window manager. 44 * 45 * @namespace window 46 * @syscap SystemCapability.WindowManager.WindowManager.Core 47 * @crossplatform 48 * @atomicservice 49 * @since 11 50 */ 51declare namespace window { 52 /** 53 * The type of a window. 54 * 55 * @enum { number } 56 * @syscap SystemCapability.WindowManager.WindowManager.Core 57 * @since 7 58 */ 59 /** 60 * The type of a window. 61 * 62 * @enum { number } 63 * @syscap SystemCapability.WindowManager.WindowManager.Core 64 * @atomicservice 65 * @since 12 66 */ 67 enum WindowType { 68 /** 69 * App. 70 * 71 * @syscap SystemCapability.WindowManager.WindowManager.Core 72 * @FAModelOnly 73 * @since 7 74 */ 75 TYPE_APP, 76 /** 77 * System alert. 78 * 79 * @syscap SystemCapability.WindowManager.WindowManager.Core 80 * @since 7 81 * @deprecated since 11 82 */ 83 TYPE_SYSTEM_ALERT, 84 /** 85 * Input method. 86 * 87 * @syscap SystemCapability.WindowManager.WindowManager.Core 88 * @systemapi Hide this for inner system use. 89 * @StageModelOnly 90 * @since 9 91 * @deprecated since 13 92 */ 93 TYPE_INPUT_METHOD, 94 /** 95 * Status bar. 96 * 97 * @syscap SystemCapability.WindowManager.WindowManager.Core 98 * @systemapi Hide this for inner system use. 99 * @StageModelOnly 100 * @since 9 101 */ 102 TYPE_STATUS_BAR, 103 /** 104 * Panel. 105 * 106 * @syscap SystemCapability.WindowManager.WindowManager.Core 107 * @systemapi Hide this for inner system use. 108 * @StageModelOnly 109 * @since 9 110 */ 111 TYPE_PANEL, 112 /** 113 * Keyguard. 114 * 115 * @syscap SystemCapability.WindowManager.WindowManager.Core 116 * @systemapi Hide this for inner system use. 117 * @StageModelOnly 118 * @since 9 119 */ 120 TYPE_KEYGUARD, 121 /** 122 * Volume. 123 * 124 * @syscap SystemCapability.WindowManager.WindowManager.Core 125 * @systemapi Hide this for inner system use. 126 * @StageModelOnly 127 * @since 9 128 */ 129 TYPE_VOLUME_OVERLAY, 130 /** 131 * Navigation bar. 132 * 133 * @syscap SystemCapability.WindowManager.WindowManager.Core 134 * @systemapi Hide this for inner system use. 135 * @StageModelOnly 136 * @since 9 137 */ 138 TYPE_NAVIGATION_BAR, 139 /** 140 * Float. 141 * 142 * @permission ohos.permission.SYSTEM_FLOAT_WINDOW 143 * @syscap SystemCapability.WindowManager.WindowManager.Core 144 * @StageModelOnly 145 * @since 9 146 */ 147 /** 148 * Float. 149 * Require "ohos.permission.SYSTEM_FLOAT_WINDOW" permission 150 * 151 * @syscap SystemCapability.WindowManager.WindowManager.Core 152 * @StageModelOnly 153 * @atomicservice 154 * @since 12 155 */ 156 TYPE_FLOAT, 157 /** 158 * Wallpaper. 159 * 160 * @syscap SystemCapability.WindowManager.WindowManager.Core 161 * @systemapi Hide this for inner system use. 162 * @StageModelOnly 163 * @since 9 164 */ 165 TYPE_WALLPAPER, 166 /** 167 * Desktop. 168 * 169 * @syscap SystemCapability.WindowManager.WindowManager.Core 170 * @systemapi Hide this for inner system use. 171 * @StageModelOnly 172 * @since 9 173 */ 174 TYPE_DESKTOP, 175 /** 176 * Recent. 177 * 178 * @syscap SystemCapability.WindowManager.WindowManager.Core 179 * @systemapi Hide this for inner system use. 180 * @StageModelOnly 181 * @since 9 182 */ 183 TYPE_LAUNCHER_RECENT, 184 /** 185 * Dock. 186 * 187 * @syscap SystemCapability.WindowManager.WindowManager.Core 188 * @systemapi Hide this for inner system use. 189 * @StageModelOnly 190 * @since 9 191 */ 192 TYPE_LAUNCHER_DOCK, 193 /** 194 * Voice interaction. 195 * 196 * @syscap SystemCapability.WindowManager.WindowManager.Core 197 * @systemapi Hide this for inner system use. 198 * @StageModelOnly 199 * @since 9 200 */ 201 TYPE_VOICE_INTERACTION, 202 /** 203 * Pointer. 204 * 205 * @syscap SystemCapability.WindowManager.WindowManager.Core 206 * @systemapi Hide this for inner system use. 207 * @StageModelOnly 208 * @since 9 209 */ 210 TYPE_POINTER, 211 /** 212 * Float camera. 213 * 214 * @syscap SystemCapability.WindowManager.WindowManager.Core 215 * @systemapi Hide this for inner system use. 216 * @StageModelOnly 217 * @since 9 218 */ 219 TYPE_FLOAT_CAMERA, 220 /** 221 * Dialog. 222 * 223 * @syscap SystemCapability.WindowManager.WindowManager.Core 224 * @StageModelOnly 225 * @since 10 226 */ 227 /** 228 * Dialog. 229 * 230 * @syscap SystemCapability.WindowManager.WindowManager.Core 231 * @StageModelOnly 232 * @atomicservice 233 * @since 12 234 */ 235 TYPE_DIALOG, 236 /** 237 * Screenshot. 238 * 239 * @syscap SystemCapability.WindowManager.WindowManager.Core 240 * @systemapi Hide this for inner system use. 241 * @StageModelOnly 242 * @since 9 243 */ 244 TYPE_SCREENSHOT, 245 /** 246 * System Toast. 247 * 248 * @syscap SystemCapability.WindowManager.WindowManager.Core 249 * @systemapi Hide this for inner system use. 250 * @StageModelOnly 251 * @since 11 252 */ 253 TYPE_SYSTEM_TOAST, 254 /** 255 * Divider. 256 * 257 * @syscap SystemCapability.WindowManager.WindowManager.Core 258 * @systemapi Hide this for inner system use. 259 * @StageModelOnly 260 * @since 11 261 */ 262 TYPE_DIVIDER, 263 /** 264 * Global Search. 265 * 266 * @syscap SystemCapability.WindowManager.WindowManager.Core 267 * @systemapi Hide this for inner system use. 268 * @StageModelOnly 269 * @since 11 270 */ 271 TYPE_GLOBAL_SEARCH, 272 /** 273 * Handwrite. 274 * 275 * @syscap SystemCapability.Window.SessionManager 276 * @systemapi Hide this for inner system use. 277 * @StageModelOnly 278 * @since 12 279 */ 280 TYPE_HANDWRITE 281 } 282 283 /** 284 * Describes the type of avoid area 285 * 286 * @enum { number } 287 * @syscap SystemCapability.WindowManager.WindowManager.Core 288 * @since 7 289 */ 290 /** 291 * Describes the type of avoid area 292 * 293 * @enum { number } 294 * @syscap SystemCapability.WindowManager.WindowManager.Core 295 * @atomicservice 296 * @since 11 297 */ 298 /** 299 * Describes the type of avoid area 300 * 301 * @enum { number } 302 * @syscap SystemCapability.WindowManager.WindowManager.Core 303 * @crossplatform 304 * @atomicservice 305 * @since 12 306 */ 307 enum AvoidAreaType { 308 /** 309 * Default area of the system 310 * 311 * @syscap SystemCapability.WindowManager.WindowManager.Core 312 * @since 7 313 */ 314 /** 315 * Default area of the system 316 * 317 * @syscap SystemCapability.WindowManager.WindowManager.Core 318 * @atomicservice 319 * @since 11 320 */ 321 /** 322 * Default area of the system 323 * 324 * @syscap SystemCapability.WindowManager.WindowManager.Core 325 * @crossplatform 326 * @atomicservice 327 * @since 12 328 */ 329 TYPE_SYSTEM, 330 331 /** 332 * Notch 333 * 334 * @syscap SystemCapability.WindowManager.WindowManager.Core 335 * @since 7 336 */ 337 /** 338 * Notch 339 * 340 * @syscap SystemCapability.WindowManager.WindowManager.Core 341 * @atomicservice 342 * @since 11 343 */ 344 /** 345 * Notch 346 * 347 * @syscap SystemCapability.WindowManager.WindowManager.Core 348 * @crossplatform 349 * @atomicservice 350 * @since 12 351 */ 352 TYPE_CUTOUT, 353 354 /** 355 * Area for system gesture 356 * 357 * @syscap SystemCapability.WindowManager.WindowManager.Core 358 * @since 9 359 */ 360 /** 361 * Area for system gesture 362 * 363 * @syscap SystemCapability.WindowManager.WindowManager.Core 364 * @atomicservice 365 * @since 11 366 */ 367 /** 368 * Area for system gesture 369 * 370 * @syscap SystemCapability.WindowManager.WindowManager.Core 371 * @crossplatform 372 * @atomicservice 373 * @since 12 374 */ 375 TYPE_SYSTEM_GESTURE, 376 377 /** 378 * Area for keyboard 379 * 380 * @syscap SystemCapability.WindowManager.WindowManager.Core 381 * @since 9 382 */ 383 /** 384 * Area for keyboard 385 * 386 * @syscap SystemCapability.WindowManager.WindowManager.Core 387 * @atomicservice 388 * @since 11 389 */ 390 /** 391 * Area for keyboard 392 * 393 * @syscap SystemCapability.WindowManager.WindowManager.Core 394 * @crossplatform 395 * @atomicservice 396 * @since 12 397 */ 398 TYPE_KEYBOARD, 399 400 /** 401 * Area for navigation indicator 402 * 403 * @syscap SystemCapability.WindowManager.WindowManager.Core 404 * @atomicservice 405 * @since 11 406 */ 407 /** 408 * Area for navigation indicator 409 * 410 * @syscap SystemCapability.WindowManager.WindowManager.Core 411 * @crossplatform 412 * @atomicservice 413 * @since 12 414 */ 415 TYPE_NAVIGATION_INDICATOR 416 } 417 /** 418 * Describes the window mode of an application 419 * 420 * @enum { number } 421 * @syscap SystemCapability.WindowManager.WindowManager.Core 422 * @systemapi Hide this for inner system use. 423 * @since 7 424 */ 425 enum WindowMode { 426 /** 427 * Undefined mode of the window 428 * 429 * @syscap SystemCapability.WindowManager.WindowManager.Core 430 * @systemapi Hide this for inner system use. 431 * @since 7 432 */ 433 UNDEFINED = 1, 434 /** 435 * Fullscreen mode of the window 436 * 437 * @syscap SystemCapability.WindowManager.WindowManager.Core 438 * @systemapi Hide this for inner system use. 439 * @since 7 440 */ 441 FULLSCREEN, 442 /** 443 * Primary mode of the window 444 * 445 * @syscap SystemCapability.WindowManager.WindowManager.Core 446 * @systemapi Hide this for inner system use. 447 * @since 7 448 */ 449 PRIMARY, 450 /** 451 * Secondary mode of the window 452 * 453 * @syscap SystemCapability.WindowManager.WindowManager.Core 454 * @systemapi Hide this for inner system use. 455 * @since 7 456 */ 457 SECONDARY, 458 /** 459 * Floating mode of the window 460 * 461 * @syscap SystemCapability.WindowManager.WindowManager.Core 462 * @systemapi Hide this for inner system use. 463 * @since 7 464 */ 465 FLOATING 466 } 467 468 /** 469 * Describes the mode of window layout 470 * 471 * @enum { number } 472 * @syscap SystemCapability.WindowManager.WindowManager.Core 473 * @systemapi Hide this for inner system use. 474 * @since 9 475 */ 476 enum WindowLayoutMode { 477 /** 478 * CASCADE 479 * 480 * @syscap SystemCapability.WindowManager.WindowManager.Core 481 * @systemapi Hide this for inner system use. 482 * @since 9 483 */ 484 WINDOW_LAYOUT_MODE_CASCADE, 485 /** 486 * TILE 487 * 488 * @syscap SystemCapability.WindowManager.WindowManager.Core 489 * @systemapi Hide this for inner system use. 490 * @since 9 491 */ 492 WINDOW_LAYOUT_MODE_TILE 493 } 494 495 /** 496 * Describes the window status of an application 497 * 498 * @enum { number } 499 * @syscap SystemCapability.Window.SessionManager 500 * @since 11 501 */ 502 /** 503 * Describes the window status of an application 504 * 505 * @enum { number } 506 * @syscap SystemCapability.Window.SessionManager 507 * @atomicservice 508 * @since 12 509 */ 510 enum WindowStatusType { 511 /** 512 * Undefined status of the window 513 * 514 * @syscap SystemCapability.Window.SessionManager 515 * @since 11 516 */ 517 /** 518 * Undefined status of the window 519 * 520 * @syscap SystemCapability.Window.SessionManager 521 * @atomicservice 522 * @since 12 523 */ 524 UNDEFINED = 0, 525 /** 526 * Full screen status of the window 527 * 528 * @syscap SystemCapability.Window.SessionManager 529 * @since 11 530 */ 531 /** 532 * Full screen status of the window 533 * 534 * @syscap SystemCapability.Window.SessionManager 535 * @atomicservice 536 * @since 12 537 */ 538 FULL_SCREEN, 539 /** 540 * Maximize status of the window 541 * 542 * @syscap SystemCapability.Window.SessionManager 543 * @since 11 544 */ 545 /** 546 * Maximize status of the window 547 * 548 * @syscap SystemCapability.Window.SessionManager 549 * @atomicservice 550 * @since 12 551 */ 552 MAXIMIZE, 553 /** 554 * Minimize status of the window 555 * 556 * @syscap SystemCapability.Window.SessionManager 557 * @since 11 558 */ 559 /** 560 * Minimize status of the window 561 * 562 * @syscap SystemCapability.Window.SessionManager 563 * @atomicservice 564 * @since 12 565 */ 566 MINIMIZE, 567 /** 568 * Floating status of the window 569 * 570 * @syscap SystemCapability.Window.SessionManager 571 * @since 11 572 */ 573 /** 574 * Floating status of the window 575 * 576 * @syscap SystemCapability.Window.SessionManager 577 * @atomicservice 578 * @since 12 579 */ 580 FLOATING, 581 /** 582 * Split screen status of the window 583 * 584 * @syscap SystemCapability.Window.SessionManager 585 * @since 11 586 */ 587 /** 588 * Split screen status of the window 589 * 590 * @syscap SystemCapability.Window.SessionManager 591 * @atomicservice 592 * @since 12 593 */ 594 SPLIT_SCREEN 595 } 596 597 /** 598 * Properties of status bar and navigation bar, it couldn't update automatically 599 * 600 * @interface SystemBarProperties 601 * @syscap SystemCapability.WindowManager.WindowManager.Core 602 * @since 6 603 */ 604 /** 605 * Properties of status bar and navigation bar, it couldn't update automatically 606 * 607 * @interface SystemBarProperties 608 * @syscap SystemCapability.WindowManager.WindowManager.Core 609 * @atomicservice 610 * @since 12 611 */ 612 interface SystemBarProperties { 613 /** 614 * The color of the status bar. 615 * 616 * @syscap SystemCapability.WindowManager.WindowManager.Core 617 * @since 6 618 */ 619 /** 620 * The color of the status bar. 621 * 622 * @type { ?string } 623 * @syscap SystemCapability.WindowManager.WindowManager.Core 624 * @atomicservice 625 * @since 12 626 */ 627 statusBarColor?: string; 628 629 /** 630 * The light icon of the status bar. 631 * 632 * @syscap SystemCapability.WindowManager.WindowManager.Core 633 * @since 7 634 */ 635 /** 636 * The light icon of the status bar. 637 * 638 * @type { ?boolean } 639 * @syscap SystemCapability.WindowManager.WindowManager.Core 640 * @atomicservice 641 * @since 12 642 */ 643 isStatusBarLightIcon?: boolean; 644 645 /** 646 * The content color of the status bar 647 * 648 * @syscap SystemCapability.WindowManager.WindowManager.Core 649 * @since 8 650 */ 651 /** 652 * The content color of the status bar 653 * 654 * @type { ?string } 655 * @syscap SystemCapability.WindowManager.WindowManager.Core 656 * @atomicservice 657 * @since 12 658 */ 659 statusBarContentColor?: string; 660 661 /** 662 * The color of the navigation bar. 663 * 664 * @syscap SystemCapability.WindowManager.WindowManager.Core 665 * @since 6 666 */ 667 /** 668 * The color of the navigation bar. 669 * 670 * @type { ?string } 671 * @syscap SystemCapability.WindowManager.WindowManager.Core 672 * @atomicservice 673 * @since 12 674 */ 675 navigationBarColor?: string; 676 677 /** 678 * The light icon of the navigation bar. 679 * 680 * @syscap SystemCapability.WindowManager.WindowManager.Core 681 * @since 7 682 */ 683 /** 684 * The light icon of the navigation bar. 685 * 686 * @type { ?boolean } 687 * @syscap SystemCapability.WindowManager.WindowManager.Core 688 * @atomicservice 689 * @since 12 690 */ 691 isNavigationBarLightIcon?: boolean; 692 693 /** 694 * The content color of the navigation bar 695 * 696 * @syscap SystemCapability.WindowManager.WindowManager.Core 697 * @since 8 698 */ 699 /** 700 * The content color of the navigation bar 701 * 702 * @type { ?string } 703 * @syscap SystemCapability.WindowManager.WindowManager.Core 704 * @atomicservice 705 * @since 12 706 */ 707 navigationBarContentColor?: string; 708 709 /** 710 * Enable the animation of the status bar. 711 * 712 * @type { ?boolean } 713 * @syscap SystemCapability.Window.SessionManager 714 * @atomicservice 715 * @since 12 716 */ 717 enableStatusBarAnimation?: boolean; 718 719 /** 720 * Enable the animation of the navigation bar. 721 * 722 * @type { ?boolean } 723 * @syscap SystemCapability.Window.SessionManager 724 * @atomicservice 725 * @since 12 726 */ 727 enableNavigationBarAnimation?: boolean; 728 } 729 730 /** 731 * Properties of status bar, it couldn't update automatically 732 * 733 * @interface SystemBarStyle 734 * @syscap SystemCapability.WindowManager.WindowManager.Core 735 * @atomicservice 736 * @since 12 737 */ 738 interface SystemBarStyle { 739 /** 740 * The content color of the status bar 741 * 742 * @type { ?string } 743 * @syscap SystemCapability.WindowManager.WindowManager.Core 744 * @atomicservice 745 * @since 12 746 */ 747 statusBarContentColor?: string; 748 } 749 750 /** 751 * System bar tint of region 752 * 753 * @interface SystemBarRegionTint 754 * @syscap SystemCapability.WindowManager.WindowManager.Core 755 * @systemapi Hide this for inner system use. 756 * @since 8 757 */ 758 interface SystemBarRegionTint { 759 /** 760 * System bar type 761 * 762 * @type { WindowType } 763 * @syscap SystemCapability.WindowManager.WindowManager.Core 764 * @systemapi Hide this for inner system use. 765 * @since 8 766 */ 767 type: WindowType; 768 769 /** 770 * The visibility of system bar 771 * 772 * @type { ?boolean } 773 * @syscap SystemCapability.WindowManager.WindowManager.Core 774 * @systemapi Hide this for inner system use. 775 * @since 8 776 */ 777 isEnable?: boolean; 778 779 /** 780 * The region of system bar 781 * 782 * @type { ?Rect } 783 * @syscap SystemCapability.WindowManager.WindowManager.Core 784 * @systemapi Hide this for inner system use. 785 * @since 8 786 */ 787 region?: Rect; 788 789 /** 790 * The background color of the system bar. 791 * 792 * @type { ?string } 793 * @syscap SystemCapability.WindowManager.WindowManager.Core 794 * @systemapi Hide this for inner system use. 795 * @since 8 796 */ 797 backgroundColor?: string; 798 799 /** 800 * The content color of the system bar. 801 * 802 * @type { ?string } 803 * @syscap SystemCapability.WindowManager.WindowManager.Core 804 * @systemapi Hide this for inner system use. 805 * @since 8 806 */ 807 contentColor?: string; 808 } 809 810 /** 811 * System bar tint state for systemui 812 * 813 * @interface SystemBarTintState 814 * @syscap SystemCapability.WindowManager.WindowManager.Core 815 * @systemapi Hide this for inner system use. 816 * @since 8 817 */ 818 interface SystemBarTintState { 819 /** 820 * Id of display 821 * 822 * @type { number } 823 * @syscap SystemCapability.WindowManager.WindowManager.Core 824 * @systemapi Hide this for inner system use. 825 * @since 8 826 */ 827 displayId: number; 828 /** 829 * Region tint of systembar 830 * 831 * @type { Array<SystemBarRegionTint> } 832 * @syscap SystemCapability.WindowManager.WindowManager.Core 833 * @systemapi Hide this for inner system use. 834 * @since 8 835 */ 836 regionTint: Array<SystemBarRegionTint>; 837 } 838 839 /** 840 * Rectangle 841 * 842 * @interface Rect 843 * @syscap SystemCapability.WindowManager.WindowManager.Core 844 * @since 7 845 */ 846 /** 847 * Rectangle 848 * 849 * @interface Rect 850 * @syscap SystemCapability.WindowManager.WindowManager.Core 851 * @crossplatform 852 * @since 10 853 */ 854 /** 855 * Rectangle 856 * 857 * @interface Rect 858 * @syscap SystemCapability.WindowManager.WindowManager.Core 859 * @crossplatform 860 * @atomicservice 861 * @since 11 862 */ 863 interface Rect { 864 865 /** 866 * The left of the Rect. 867 * 868 * @syscap SystemCapability.WindowManager.WindowManager.Core 869 * @since 7 870 */ 871 /** 872 * The left of the Rect. 873 * 874 * @syscap SystemCapability.WindowManager.WindowManager.Core 875 * @crossplatform 876 * @since 10 877 */ 878 /** 879 * The left of the Rect. 880 * 881 * @type { number } 882 * @syscap SystemCapability.WindowManager.WindowManager.Core 883 * @crossplatform 884 * @atomicservice 885 * @since 11 886 */ 887 left: number; 888 889 /** 890 * The top of the Rect. 891 * 892 * @syscap SystemCapability.WindowManager.WindowManager.Core 893 * @since 7 894 */ 895 /** 896 * The top of the Rect. 897 * 898 * @syscap SystemCapability.WindowManager.WindowManager.Core 899 * @crossplatform 900 * @since 10 901 */ 902 /** 903 * The top of the Rect. 904 * 905 * @type { number } 906 * @syscap SystemCapability.WindowManager.WindowManager.Core 907 * @crossplatform 908 * @atomicservice 909 * @since 11 910 */ 911 top: number; 912 913 /** 914 * The width of the Rect. 915 * 916 * @syscap SystemCapability.WindowManager.WindowManager.Core 917 * @since 7 918 */ 919 /** 920 * The width of the Rect. 921 * 922 * @syscap SystemCapability.WindowManager.WindowManager.Core 923 * @crossplatform 924 * @since 10 925 */ 926 /** 927 * The width of the Rect. 928 * 929 * @type { number } 930 * @syscap SystemCapability.WindowManager.WindowManager.Core 931 * @crossplatform 932 * @atomicservice 933 * @since 11 934 */ 935 width: number; 936 937 /** 938 * The height of the Rect. 939 * 940 * @syscap SystemCapability.WindowManager.WindowManager.Core 941 * @since 7 942 */ 943 /** 944 * The height of the Rect. 945 * 946 * @syscap SystemCapability.WindowManager.WindowManager.Core 947 * @crossplatform 948 * @since 10 949 */ 950 /** 951 * The height of the Rect. 952 * 953 * @type { number } 954 * @syscap SystemCapability.WindowManager.WindowManager.Core 955 * @crossplatform 956 * @atomicservice 957 * @since 11 958 */ 959 height: number; 960 } 961 962 /** 963 * Avoid area 964 * 965 * @interface AvoidArea 966 * @syscap SystemCapability.WindowManager.WindowManager.Core 967 * @since 7 968 */ 969 /** 970 * Avoid area 971 * 972 * @interface AvoidArea 973 * @syscap SystemCapability.WindowManager.WindowManager.Core 974 * @atomicservice 975 * @since 11 976 */ 977 /** 978 * Avoid area 979 * 980 * @interface AvoidArea 981 * @syscap SystemCapability.WindowManager.WindowManager.Core 982 * @crossplatform 983 * @atomicservice 984 * @since 12 985 */ 986 interface AvoidArea { 987 /** 988 * Whether avoidArea is visible on screen 989 * 990 * @type { boolean } 991 * @syscap SystemCapability.WindowManager.WindowManager.Core 992 * @since 9 993 */ 994 /** 995 * Whether avoidArea is visible on screen 996 * 997 * @type { boolean } 998 * @syscap SystemCapability.WindowManager.WindowManager.Core 999 * @atomicservice 1000 * @since 11 1001 */ 1002 visible: boolean; 1003 1004 /** 1005 * Rectangle on the left of the screen 1006 * 1007 * @type { Rect } 1008 * @syscap SystemCapability.WindowManager.WindowManager.Core 1009 * @since 7 1010 */ 1011 /** 1012 * Rectangle on the left of the screen 1013 * 1014 * @type { Rect } 1015 * @syscap SystemCapability.WindowManager.WindowManager.Core 1016 * @atomicservice 1017 * @since 11 1018 */ 1019 /** 1020 * Rectangle on the left of the screen 1021 * 1022 * @type { Rect } 1023 * @syscap SystemCapability.WindowManager.WindowManager.Core 1024 * @crossplatform 1025 * @atomicservice 1026 * @since 12 1027 */ 1028 leftRect: Rect; 1029 1030 /** 1031 * Rectangle on the top of the screen 1032 * 1033 * @type { Rect } 1034 * @syscap SystemCapability.WindowManager.WindowManager.Core 1035 * @since 7 1036 */ 1037 /** 1038 * Rectangle on the top of the screen 1039 * 1040 * @type { Rect } 1041 * @syscap SystemCapability.WindowManager.WindowManager.Core 1042 * @atomicservice 1043 * @since 11 1044 */ 1045 /** 1046 * Rectangle on the top of the screen 1047 * 1048 * @type { Rect } 1049 * @syscap SystemCapability.WindowManager.WindowManager.Core 1050 * @crossplatform 1051 * @atomicservice 1052 * @since 12 1053 */ 1054 topRect: Rect; 1055 1056 /** 1057 * Rectangle on the right of the screen 1058 * 1059 * @type { Rect } 1060 * @syscap SystemCapability.WindowManager.WindowManager.Core 1061 * @since 7 1062 */ 1063 /** 1064 * Rectangle on the right of the screen 1065 * 1066 * @type { Rect } 1067 * @syscap SystemCapability.WindowManager.WindowManager.Core 1068 * @atomicservice 1069 * @since 11 1070 */ 1071 /** 1072 * Rectangle on the right of the screen 1073 * 1074 * @type { Rect } 1075 * @syscap SystemCapability.WindowManager.WindowManager.Core 1076 * @crossplatform 1077 * @atomicservice 1078 * @since 12 1079 */ 1080 rightRect: Rect; 1081 1082 /** 1083 * Rectangle on the bottom of the screen 1084 * 1085 * @type { Rect } 1086 * @syscap SystemCapability.WindowManager.WindowManager.Core 1087 * @since 7 1088 */ 1089 /** 1090 * Rectangle on the bottom of the screen 1091 * 1092 * @type { Rect } 1093 * @syscap SystemCapability.WindowManager.WindowManager.Core 1094 * @atomicservice 1095 * @since 11 1096 */ 1097 /** 1098 * Rectangle on the bottom of the screen 1099 * 1100 * @type { Rect } 1101 * @syscap SystemCapability.WindowManager.WindowManager.Core 1102 * @crossplatform 1103 * @atomicservice 1104 * @since 12 1105 */ 1106 bottomRect: Rect; 1107 } 1108 1109 /** 1110 * Window size 1111 * 1112 * @interface Size 1113 * @syscap SystemCapability.WindowManager.WindowManager.Core 1114 * @since 7 1115 */ 1116 /** 1117 * Window size 1118 * 1119 * @interface Size 1120 * @syscap SystemCapability.WindowManager.WindowManager.Core 1121 * @crossplatform 1122 * @since 10 1123 */ 1124 /** 1125 * Window size 1126 * 1127 * @interface Size 1128 * @syscap SystemCapability.WindowManager.WindowManager.Core 1129 * @crossplatform 1130 * @atomicservice 1131 * @since 11 1132 */ 1133 interface Size { 1134 /** 1135 * The width of the window. 1136 * 1137 * @type { number } 1138 * @syscap SystemCapability.WindowManager.WindowManager.Core 1139 * @since 7 1140 */ 1141 /** 1142 * The width of the window. 1143 * 1144 * @type { number } 1145 * @syscap SystemCapability.WindowManager.WindowManager.Core 1146 * @crossplatform 1147 * @since 10 1148 */ 1149 /** 1150 * The width of the window. 1151 * 1152 * @type { number } 1153 * @syscap SystemCapability.WindowManager.WindowManager.Core 1154 * @crossplatform 1155 * @atomicservice 1156 * @since 11 1157 */ 1158 width: number; 1159 1160 /** 1161 * The height of the window. 1162 * 1163 * @syscap SystemCapability.WindowManager.WindowManager.Core 1164 * @since 7 1165 */ 1166 /** 1167 * The height of the window. 1168 * 1169 * @type { number } 1170 * @syscap SystemCapability.WindowManager.WindowManager.Core 1171 * @crossplatform 1172 * @since 10 1173 */ 1174 /** 1175 * The height of the window. 1176 * 1177 * @type { number } 1178 * @syscap SystemCapability.WindowManager.WindowManager.Core 1179 * @crossplatform 1180 * @atomicservice 1181 * @since 11 1182 */ 1183 height: number; 1184 } 1185 1186 /** 1187 * The info of window 1188 * 1189 * @interface WindowInfo 1190 * @syscap SystemCapability.Window.SessionManager 1191 * @systemapi 1192 * @since 12 1193 */ 1194 interface WindowInfo { 1195 /** 1196 * The position and size of the window 1197 * 1198 * @type { Rect } 1199 * @syscap SystemCapability.Window.SessionManager 1200 * @systemapi 1201 * @since 12 1202 */ 1203 rect: Rect; 1204 1205 /** 1206 * bundleName of window 1207 * 1208 * @type { string } 1209 * @syscap SystemCapability.Window.SessionManager 1210 * @systemapi 1211 * @since 12 1212 */ 1213 bundleName: string; 1214 1215 /** 1216 * abilityName of window 1217 * 1218 * @type { string } 1219 * @syscap SystemCapability.Window.SessionManager 1220 * @systemapi 1221 * @since 12 1222 */ 1223 abilityName: string; 1224 1225 /** 1226 * Indicates target window id. 1227 * 1228 * @type { number } 1229 * @syscap SystemCapability.Window.SessionManager 1230 * @systemapi 1231 * @since 12 1232 */ 1233 windowId: number; 1234 1235 /** 1236 * The window status of an application. 1237 * 1238 * @type { WindowStatusType } 1239 * @syscap SystemCapability.Window.SessionManager 1240 * @systemapi 1241 * @since 12 1242 */ 1243 windowStatusType: WindowStatusType; 1244 } 1245 1246 /** 1247 * Properties of window, it couldn't update automatically 1248 * 1249 * @interface WindowProperties 1250 * @syscap SystemCapability.WindowManager.WindowManager.Core 1251 * @since 6 1252 */ 1253 /** 1254 * Properties of window, it couldn't update automatically 1255 * 1256 * @interface WindowProperties 1257 * @syscap SystemCapability.WindowManager.WindowManager.Core 1258 * @crossplatform 1259 * @since 10 1260 */ 1261 /** 1262 * Properties of window, it couldn't update automatically 1263 * 1264 * @interface WindowProperties 1265 * @syscap SystemCapability.WindowManager.WindowManager.Core 1266 * @crossplatform 1267 * @atomicservice 1268 * @since 11 1269 */ 1270 interface WindowProperties { 1271 /** 1272 * The position and size of the window 1273 * 1274 * @type { Rect } 1275 * @syscap SystemCapability.WindowManager.WindowManager.Core 1276 * @since 7 1277 */ 1278 /** 1279 * The position and size of the window 1280 * 1281 * @type { Rect } 1282 * @syscap SystemCapability.WindowManager.WindowManager.Core 1283 * @crossplatform 1284 * @since 10 1285 */ 1286 /** 1287 * The position and size of the window 1288 * 1289 * @type { Rect } 1290 * @syscap SystemCapability.WindowManager.WindowManager.Core 1291 * @crossplatform 1292 * @atomicservice 1293 * @since 11 1294 */ 1295 windowRect: Rect; 1296 1297 /** 1298 * The position relative to the window and size of drawable area 1299 * 1300 * @type { Rect } 1301 * @syscap SystemCapability.WindowManager.WindowManager.Core 1302 * @since 11 1303 */ 1304 /** 1305 * The position relative to the window and size of drawable area 1306 * 1307 * @type { Rect } 1308 * @syscap SystemCapability.WindowManager.WindowManager.Core 1309 * @atomicservice 1310 * @since 12 1311 */ 1312 drawableRect: Rect; 1313 1314 /** 1315 * Window type 1316 * 1317 * @type { WindowType } 1318 * @syscap SystemCapability.WindowManager.WindowManager.Core 1319 * @since 7 1320 */ 1321 /** 1322 * Window type 1323 * 1324 * @type { WindowType } 1325 * @syscap SystemCapability.WindowManager.WindowManager.Core 1326 * @atomicservice 1327 * @since 12 1328 */ 1329 type: WindowType; 1330 1331 /** 1332 * Whether the window is displayed in full screen mode. The default value is false. 1333 * 1334 * @type { boolean } 1335 * @syscap SystemCapability.WindowManager.WindowManager.Core 1336 * @since 6 1337 */ 1338 /** 1339 * Whether the window is displayed in full screen mode. The default value is false. 1340 * 1341 * @type { boolean } 1342 * @syscap SystemCapability.WindowManager.WindowManager.Core 1343 * @atomicservice 1344 * @since 12 1345 */ 1346 isFullScreen: boolean; 1347 1348 /** 1349 * Whether the window layout is in full screen mode(whether the window is immersive). The default value is false. 1350 * 1351 * @type { boolean } 1352 * @syscap SystemCapability.WindowManager.WindowManager.Core 1353 * @since 7 1354 */ 1355 /** 1356 * Whether the window layout is in full screen mode(whether the window is immersive). The default value is false. 1357 * 1358 * @type { boolean } 1359 * @syscap SystemCapability.WindowManager.WindowManager.Core 1360 * @atomicservice 1361 * @since 12 1362 */ 1363 isLayoutFullScreen: boolean; 1364 1365 /** 1366 * Whether the window can gain focus. The default value is true 1367 * 1368 * @type { boolean } 1369 * @syscap SystemCapability.WindowManager.WindowManager.Core 1370 * @since 7 1371 */ 1372 /** 1373 * Whether the window can gain focus. The default value is true 1374 * 1375 * @type { boolean } 1376 * @syscap SystemCapability.WindowManager.WindowManager.Core 1377 * @atomicservice 1378 * @since 12 1379 */ 1380 focusable: boolean; 1381 1382 /** 1383 * Whether the window is touchable. The default value is false 1384 * 1385 * @type { boolean } 1386 * @syscap SystemCapability.WindowManager.WindowManager.Core 1387 * @since 7 1388 */ 1389 /** 1390 * Whether the window is touchable. The default value is false 1391 * 1392 * @type { boolean } 1393 * @syscap SystemCapability.WindowManager.WindowManager.Core 1394 * @atomicservice 1395 * @since 12 1396 */ 1397 touchable: boolean; 1398 1399 /** 1400 * Brightness value of window. 1401 * 1402 * @syscap SystemCapability.WindowManager.WindowManager.Core 1403 * @since 6 1404 */ 1405 /** 1406 * Brightness value of window. 1407 * 1408 * @type { number } 1409 * @syscap SystemCapability.WindowManager.WindowManager.Core 1410 * @crossplatform 1411 * @since 10 1412 */ 1413 /** 1414 * Brightness value of window. 1415 * 1416 * @type { number } 1417 * @syscap SystemCapability.WindowManager.WindowManager.Core 1418 * @crossplatform 1419 * @atomicservice 1420 * @since 11 1421 */ 1422 brightness: number; 1423 1424 /** 1425 * The dimbehind value of window. 1426 * 1427 * @type { number } 1428 * @syscap SystemCapability.WindowManager.WindowManager.Core 1429 * @since 7 1430 * @deprecated since 9 1431 */ 1432 dimBehindValue: number; 1433 1434 /** 1435 * Whether keep screen on. 1436 * 1437 * @syscap SystemCapability.WindowManager.WindowManager.Core 1438 * @since 6 1439 */ 1440 /** 1441 * Whether keep screen on. 1442 * 1443 * @type { boolean } 1444 * @syscap SystemCapability.WindowManager.WindowManager.Core 1445 * @crossplatform 1446 * @since 10 1447 */ 1448 /** 1449 * Whether keep screen on. 1450 * 1451 * @type { boolean } 1452 * @syscap SystemCapability.WindowManager.WindowManager.Core 1453 * @crossplatform 1454 * @atomicservice 1455 * @since 11 1456 */ 1457 isKeepScreenOn: boolean; 1458 1459 /** 1460 * Whether make window in privacy mode or not. 1461 * 1462 * @type { boolean } 1463 * @syscap SystemCapability.WindowManager.WindowManager.Core 1464 * @since 7 1465 */ 1466 /** 1467 * Whether make window in privacy mode or not. 1468 * 1469 * @type { boolean } 1470 * @syscap SystemCapability.WindowManager.WindowManager.Core 1471 * @atomicservice 1472 * @since 12 1473 */ 1474 isPrivacyMode: boolean; 1475 1476 /** 1477 * Whether is round corner or not. 1478 * 1479 * @type { boolean } 1480 * @syscap SystemCapability.WindowManager.WindowManager.Core 1481 * @since 7 1482 * @deprecated since 9 1483 */ 1484 isRoundCorner: boolean; 1485 1486 /** 1487 * Whether is transparent or not. 1488 * 1489 * @type { boolean } 1490 * @syscap SystemCapability.WindowManager.WindowManager.Core 1491 * @since 7 1492 */ 1493 /** 1494 * Whether is transparent or not. 1495 * 1496 * @type { boolean } 1497 * @syscap SystemCapability.WindowManager.WindowManager.Core 1498 * @atomicservice 1499 * @since 12 1500 */ 1501 isTransparent: boolean; 1502 1503 /** 1504 * Window id. 1505 * 1506 * @type { number } 1507 * @syscap SystemCapability.WindowManager.WindowManager.Core 1508 * @since 9 1509 */ 1510 /** 1511 * Window id. 1512 * 1513 * @type { number } 1514 * @syscap SystemCapability.WindowManager.WindowManager.Core 1515 * @atomicservice 1516 * @since 12 1517 */ 1518 id: number; 1519 1520 /** 1521 * display id. 1522 * 1523 * @type { ?number } 1524 * @syscap SystemCapability.WindowManager.WindowManager.Core 1525 * @atomicservice 1526 * @since 12 1527 */ 1528 displayId?: number; 1529 } 1530 1531 /** 1532 * Type of allowing the specified of color space. 1533 * 1534 * @enum { number } 1535 * @syscap SystemCapability.WindowManager.WindowManager.Core 1536 * @since 8 1537 */ 1538 /** 1539 * Type of allowing the specified of color space. 1540 * 1541 * @enum { number } 1542 * @syscap SystemCapability.WindowManager.WindowManager.Core 1543 * @crossplatform 1544 * @since 11 1545 */ 1546 /** 1547 * Type of allowing the specified of color space. 1548 * 1549 * @enum { number } 1550 * @syscap SystemCapability.WindowManager.WindowManager.Core 1551 * @crossplatform 1552 * @atomicservice 1553 * @since 12 1554 */ 1555 enum ColorSpace { 1556 /** 1557 * Default color space. 1558 * 1559 * @syscap SystemCapability.WindowManager.WindowManager.Core 1560 * @since 8 1561 */ 1562 /** 1563 * Default color space. 1564 * 1565 * @syscap SystemCapability.WindowManager.WindowManager.Core 1566 * @crossplatform 1567 * @since 11 1568 */ 1569 /** 1570 * Default color space. 1571 * 1572 * @syscap SystemCapability.WindowManager.WindowManager.Core 1573 * @crossplatform 1574 * @atomicservice 1575 * @since 12 1576 */ 1577 DEFAULT, 1578 /** 1579 * Wide gamut color space. The specific wide color gamut depends on thr screen. 1580 * 1581 * @syscap SystemCapability.WindowManager.WindowManager.Core 1582 * @since 8 1583 */ 1584 /** 1585 * Wide gamut color space. The specific wide color gamut depends on thr screen. 1586 * 1587 * @syscap SystemCapability.WindowManager.WindowManager.Core 1588 * @crossplatform 1589 * @since 11 1590 */ 1591 /** 1592 * Wide gamut color space. The specific wide color gamut depends on thr screen. 1593 * 1594 * @syscap SystemCapability.WindowManager.WindowManager.Core 1595 * @crossplatform 1596 * @atomicservice 1597 * @since 12 1598 */ 1599 WIDE_GAMUT 1600 } 1601 /** 1602 * Describes the scale Transition Options of window 1603 * 1604 * @interface ScaleOptions 1605 * @syscap SystemCapability.WindowManager.WindowManager.Core 1606 * @systemapi 1607 * @since 9 1608 */ 1609 interface ScaleOptions { 1610 /** 1611 * The scale param of x direction. Default is 1.f 1612 * 1613 * @type { ?number } 1614 * @syscap SystemCapability.WindowManager.WindowManager.Core 1615 * @systemapi 1616 * @since 9 1617 */ 1618 x?: number; 1619 1620 /** 1621 * The scale param of y direction. Default is 1.f 1622 * 1623 * @type { ?number } 1624 * @syscap SystemCapability.WindowManager.WindowManager.Core 1625 * @systemapi 1626 * @since 9 1627 */ 1628 y?: number; 1629 1630 /** 1631 * The scale param of pivot point of x. Default is 0.5f, Interval is 0.f - 1.f 1632 * 1633 * @type { ?number } 1634 * @syscap SystemCapability.WindowManager.WindowManager.Core 1635 * @systemapi 1636 * @since 9 1637 */ 1638 pivotX?: number; 1639 1640 /** 1641 * The scale param of pivot point of y. Default is 0.5f, Interval is 0.f - 1.f 1642 * 1643 * @type { ?number } 1644 * @syscap SystemCapability.WindowManager.WindowManager.Core 1645 * @systemapi 1646 * @since 9 1647 */ 1648 pivotY?: number; 1649 } 1650 1651 /** 1652 * Describes the rotate Transition Options of window 1653 * 1654 * @interface RotateOptions 1655 * @syscap SystemCapability.WindowManager.WindowManager.Core 1656 * @systemapi 1657 * @since 9 1658 */ 1659 interface RotateOptions { 1660 /** 1661 * The rotate degree of x direction. Default value is 0.f 1662 * 1663 * @type { ?number } 1664 * @syscap SystemCapability.WindowManager.WindowManager.Core 1665 * @systemapi 1666 * @since 9 1667 */ 1668 x?: number; 1669 1670 /** 1671 * The rotate degree of y direction. Default value is 0.f 1672 * 1673 * @type { ?number } 1674 * @syscap SystemCapability.WindowManager.WindowManager.Core 1675 * @systemapi 1676 * @since 9 1677 */ 1678 y?: number; 1679 1680 /** 1681 * The rotate degree of z direction. Default value is 0.f 1682 * 1683 * @type { ?number } 1684 * @syscap SystemCapability.WindowManager.WindowManager.Core 1685 * @systemapi 1686 * @since 9 1687 */ 1688 z?: number; 1689 1690 /** 1691 * The param of pivot point of x. Default is 0.5f, Interval is 0.f - 1.f 1692 * 1693 * @type { ?number } 1694 * @syscap SystemCapability.WindowManager.WindowManager.Core 1695 * @systemapi 1696 * @since 9 1697 */ 1698 pivotX?: number; 1699 1700 /** 1701 * The param of pivot point of y. Default is 0.5f, Interval is 0.f - 1.f 1702 * 1703 * @type { ?number } 1704 * @syscap SystemCapability.WindowManager.WindowManager.Core 1705 * @systemapi 1706 * @since 9 1707 */ 1708 pivotY?: number; 1709 } 1710 1711 /** 1712 * Describes the translate Transition Options of window 1713 * 1714 * @interface TranslateOptions 1715 * @syscap SystemCapability.WindowManager.WindowManager.Core 1716 * @systemapi 1717 * @since 9 1718 */ 1719 interface TranslateOptions { 1720 /** 1721 * The translate pixel param of x direction. Default is 0.f 1722 * 1723 * @type { ?number } 1724 * @syscap SystemCapability.WindowManager.WindowManager.Core 1725 * @systemapi 1726 * @since 9 1727 */ 1728 x?: number; 1729 1730 /** 1731 * The translate pixel param of y direction. Default is 0.f 1732 * 1733 * @type { ?number } 1734 * @syscap SystemCapability.WindowManager.WindowManager.Core 1735 * @systemapi 1736 * @since 9 1737 */ 1738 y?: number; 1739 1740 /** 1741 * The translate pixel param of z direction. Default is 0.f 1742 * 1743 * @type { ?number } 1744 * @syscap SystemCapability.WindowManager.WindowManager.Core 1745 * @systemapi 1746 * @since 9 1747 */ 1748 z?: number; 1749 } 1750 1751 /** 1752 * Transition Context 1753 * 1754 * @interface TransitionContext 1755 * @syscap SystemCapability.WindowManager.WindowManager.Core 1756 * @systemapi 1757 * @since 9 1758 */ 1759 interface TransitionContext { 1760 /** 1761 * The target window with animation 1762 * 1763 * @type { Window } 1764 * @syscap SystemCapability.WindowManager.WindowManager.Core 1765 * @systemapi 1766 * @since 9 1767 */ 1768 toWindow: Window; 1769 1770 /** 1771 * Set complete state of animation transition 1772 * 1773 * @param { boolean } isCompleted - Whether the transition is complete. The value true means that the transition is complete, and false means the opposite. 1774 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 1775 * 2. Incorrect parameter types. 1776 * @syscap SystemCapability.WindowManager.WindowManager.Core 1777 * @systemapi 1778 * @since 9 1779 */ 1780 /** 1781 * Set complete state of animation transition 1782 * 1783 * @param { boolean } isCompleted - Whether the transition is complete. The value true means that the transition is complete, and false means the opposite. 1784 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 1785 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 1786 * 2. Incorrect parameter types. 1787 * @syscap SystemCapability.WindowManager.WindowManager.Core 1788 * @systemapi 1789 * @since 12 1790 */ 1791 completeTransition(isCompleted: boolean): void; 1792 } 1793 1794 /** 1795 * Transition Controller 1796 * 1797 * @interface TransitionController 1798 * @syscap SystemCapability.WindowManager.WindowManager.Core 1799 * @systemapi 1800 * @since 9 1801 */ 1802 interface TransitionController { 1803 /** 1804 * Animation configuration when showing window 1805 * 1806 * @param { TransitionContext } context - The transition context. 1807 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 1808 * 2. Incorrect parameter types. 1809 * @syscap SystemCapability.WindowManager.WindowManager.Core 1810 * @systemapi 1811 * @since 9 1812 */ 1813 /** 1814 * Animation configuration when showing window 1815 * 1816 * @param { TransitionContext } context - The transition context. 1817 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 1818 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 1819 * 2. Incorrect parameter types. 1820 * @syscap SystemCapability.WindowManager.WindowManager.Core 1821 * @systemapi 1822 * @since 12 1823 */ 1824 animationForShown(context: TransitionContext): void; 1825 /** 1826 * Animation configuration when hiding window 1827 * 1828 * @param { TransitionContext } context - The transition context. 1829 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 1830 * 2. Incorrect parameter types. 1831 * @syscap SystemCapability.WindowManager.WindowManager.Core 1832 * @systemapi 1833 * @since 9 1834 */ 1835 /** 1836 * Animation configuration when hiding window 1837 * 1838 * @param { TransitionContext } context - The transition context. 1839 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 1840 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 1841 * 2. Incorrect parameter types. 1842 * @syscap SystemCapability.WindowManager.WindowManager.Core 1843 * @systemapi 1844 * @since 12 1845 */ 1846 animationForHidden(context: TransitionContext): void; 1847 } 1848 1849 /** 1850 * Configuration parameters for window creation. 1851 * 1852 * @interface Configuration 1853 * @syscap SystemCapability.WindowManager.WindowManager.Core 1854 * @since 9 1855 */ 1856 /** 1857 * Configuration parameters for window creation. 1858 * 1859 * @interface Configuration 1860 * @syscap SystemCapability.WindowManager.WindowManager.Core 1861 * @atomicservice 1862 * @since 12 1863 */ 1864 interface Configuration { 1865 /** 1866 * Indicates window id. 1867 * 1868 * @syscap SystemCapability.WindowManager.WindowManager.Core 1869 * @since 9 1870 */ 1871 /** 1872 * Indicates window id. 1873 * 1874 * @type { string } 1875 * @syscap SystemCapability.WindowManager.WindowManager.Core 1876 * @atomicservice 1877 * @since 12 1878 */ 1879 name: string; 1880 1881 /** 1882 * Indicates window type 1883 * 1884 * @type { WindowType } 1885 * @syscap SystemCapability.WindowManager.WindowManager.Core 1886 * @since 9 1887 */ 1888 /** 1889 * Indicates window type 1890 * 1891 * @type { WindowType } 1892 * @syscap SystemCapability.WindowManager.WindowManager.Core 1893 * @atomicservice 1894 * @since 12 1895 */ 1896 windowType: WindowType; 1897 1898 /** 1899 * Indicates window context. 1900 * 1901 * @type { ?BaseContext } 1902 * @syscap SystemCapability.WindowManager.WindowManager.Core 1903 * @since 9 1904 */ 1905 /** 1906 * Indicates window context. 1907 * 1908 * @type { ?BaseContext } 1909 * @syscap SystemCapability.WindowManager.WindowManager.Core 1910 * @atomicservice 1911 * @since 12 1912 */ 1913 ctx?: BaseContext; 1914 1915 /** 1916 * Indicates display ID. 1917 * 1918 * @type { ?number } 1919 * @syscap SystemCapability.WindowManager.WindowManager.Core 1920 * @since 9 1921 */ 1922 /** 1923 * Indicates display ID. 1924 * 1925 * @type { ?number } 1926 * @syscap SystemCapability.WindowManager.WindowManager.Core 1927 * @atomicservice 1928 * @since 12 1929 */ 1930 displayId?: number; 1931 1932 /** 1933 * Indicates Parent window id 1934 * 1935 * @type { ?number } 1936 * @syscap SystemCapability.WindowManager.WindowManager.Core 1937 * @since 9 1938 */ 1939 /** 1940 * Indicates Parent window id 1941 * 1942 * @type { ?number } 1943 * @syscap SystemCapability.WindowManager.WindowManager.Core 1944 * @atomicservice 1945 * @since 12 1946 */ 1947 parentId?: number; 1948 1949 /** 1950 * Indicates whether enable window decor, only support dialog, The default value is false. 1951 * 1952 * @type { ?boolean } 1953 * @syscap SystemCapability.Window.SessionManager 1954 * @atomicservice 1955 * @since 12 1956 */ 1957 decorEnabled?: boolean; 1958 1959 /** 1960 * Indicates dialog window title when decor enabled. 1961 * 1962 * @type { ?string } 1963 * @syscap SystemCapability.Window.SessionManager 1964 * @atomicservice 1965 * @since 12 1966 */ 1967 title?: string; 1968 } 1969 1970 /** 1971 * Limits of window. 1972 * 1973 * @interface WindowLimits 1974 * @syscap SystemCapability.Window.SessionManager 1975 * @since 11 1976 */ 1977 /** 1978 * Limits of window. 1979 * 1980 * @interface WindowLimits 1981 * @syscap SystemCapability.Window.SessionManager 1982 * @atomicservice 1983 * @since 12 1984 */ 1985 interface WindowLimits { 1986 1987 /** 1988 * The maximum width of the window. 1989 * 1990 * @type { ?number } 1991 * @syscap SystemCapability.Window.SessionManager 1992 * @since 11 1993 */ 1994 /** 1995 * The maximum width of the window. 1996 * 1997 * @type { ?number } 1998 * @syscap SystemCapability.Window.SessionManager 1999 * @atomicservice 2000 * @since 12 2001 */ 2002 maxWidth?: number; 2003 2004 /** 2005 * The maximum height of the window. 2006 * 2007 * @type { ?number } 2008 * @syscap SystemCapability.Window.SessionManager 2009 * @since 11 2010 */ 2011 /** 2012 * The maximum height of the window. 2013 * 2014 * @type { ?number } 2015 * @syscap SystemCapability.Window.SessionManager 2016 * @atomicservice 2017 * @since 12 2018 */ 2019 maxHeight?: number; 2020 2021 /** 2022 * The minimum width of the window. 2023 * 2024 * @type { ?number } 2025 * @syscap SystemCapability.Window.SessionManager 2026 * @since 11 2027 */ 2028 /** 2029 * The minimum width of the window. 2030 * 2031 * @type { ?number } 2032 * @syscap SystemCapability.Window.SessionManager 2033 * @atomicservice 2034 * @since 12 2035 */ 2036 minWidth?: number; 2037 2038 /** 2039 * The minimum height of the window. 2040 * 2041 * @type { ?number } 2042 * @syscap SystemCapability.Window.SessionManager 2043 * @since 11 2044 */ 2045 /** 2046 * The minimum height of the window. 2047 * 2048 * @type { ?number } 2049 * @syscap SystemCapability.Window.SessionManager 2050 * @atomicservice 2051 * @since 12 2052 */ 2053 minHeight?: number; 2054 } 2055 2056 /** 2057 * Rectangular area of the title buttons relative to the upper right corner of the window. 2058 * 2059 * @interface TitleButtonRect 2060 * @syscap SystemCapability.Window.SessionManager 2061 * @since 11 2062 */ 2063 /** 2064 * Rectangular area of the title buttons relative to the upper right corner of the window. 2065 * 2066 * @interface TitleButtonRect 2067 * @syscap SystemCapability.Window.SessionManager 2068 * @atomicservice 2069 * @since 12 2070 */ 2071 interface TitleButtonRect { 2072 2073 /** 2074 * The right of the Rect. 2075 * 2076 * @type { number } 2077 * @syscap SystemCapability.Window.SessionManager 2078 * @since 11 2079 */ 2080 /** 2081 * The right of the Rect. 2082 * 2083 * @type { number } 2084 * @syscap SystemCapability.Window.SessionManager 2085 * @atomicservice 2086 * @since 12 2087 */ 2088 right: number; 2089 2090 /** 2091 * The top of the Rect. 2092 * 2093 * @type { number } 2094 * @syscap SystemCapability.Window.SessionManager 2095 * @since 11 2096 */ 2097 /** 2098 * The top of the Rect. 2099 * 2100 * @type { number } 2101 * @syscap SystemCapability.Window.SessionManager 2102 * @atomicservice 2103 * @since 12 2104 */ 2105 top: number; 2106 2107 /** 2108 * The width of the Rect. 2109 * 2110 * @type { number } 2111 * @syscap SystemCapability.Window.SessionManager 2112 * @since 11 2113 */ 2114 /** 2115 * The width of the Rect. 2116 * 2117 * @type { number } 2118 * @syscap SystemCapability.Window.SessionManager 2119 * @atomicservice 2120 * @since 12 2121 */ 2122 width: number; 2123 2124 /** 2125 * The height of the Rect. 2126 * 2127 * @type { number } 2128 * @syscap SystemCapability.Window.SessionManager 2129 * @since 11 2130 */ 2131 /** 2132 * The height of the Rect. 2133 * 2134 * @type { number } 2135 * @syscap SystemCapability.Window.SessionManager 2136 * @atomicservice 2137 * @since 12 2138 */ 2139 height: number; 2140 } 2141 2142 /** 2143 * Rect change options 2144 * 2145 * @interface RectChangeOptions 2146 * @syscap SystemCapability.Window.SessionManager 2147 * @atomicservice 2148 * @since 12 2149 */ 2150 interface RectChangeOptions { 2151 /** 2152 * Rect 2153 * 2154 * @type { Rect } 2155 * @syscap SystemCapability.Window.SessionManager 2156 * @atomicservice 2157 * @since 12 2158 */ 2159 rect: Rect, 2160 2161 /** 2162 * Rect change reason 2163 * 2164 * @type { RectChangeReason } 2165 * @syscap SystemCapability.Window.SessionManager 2166 * @atomicservice 2167 * @since 12 2168 */ 2169 reason: RectChangeReason 2170 } 2171 2172 /** 2173 * Avoid area options 2174 * 2175 * @interface AvoidAreaOptions 2176 * @syscap SystemCapability.WindowManager.WindowManager.Core 2177 * @atomicservice 2178 * @since 12 2179 */ 2180 interface AvoidAreaOptions { 2181 /** 2182 * Avoid area type 2183 * 2184 * @type { AvoidAreaType } 2185 * @syscap SystemCapability.WindowManager.WindowManager.Core 2186 * @atomicservice 2187 * @since 12 2188 */ 2189 type: AvoidAreaType, 2190 2191 /** 2192 * Avoid area 2193 * 2194 * @type { AvoidArea } 2195 * @syscap SystemCapability.WindowManager.WindowManager.Core 2196 * @atomicservice 2197 * @since 12 2198 */ 2199 area: AvoidArea 2200 } 2201 2202 /** 2203 * Window rect change reason. 2204 * 2205 * @enum { number } 2206 * @syscap SystemCapability.Window.SessionManager 2207 * @atomicservice 2208 * @since 12 2209 */ 2210 enum RectChangeReason { 2211 /** 2212 * Default RectChangeReason. 2213 * 2214 * @syscap SystemCapability.Window.SessionManager 2215 * @atomicservice 2216 * @since 12 2217 */ 2218 UNDEFINED = 0, 2219 2220 /** 2221 * Window maximize. 2222 * 2223 * @syscap SystemCapability.Window.SessionManager 2224 * @atomicservice 2225 * @since 12 2226 */ 2227 MAXIMIZE, 2228 2229 /** 2230 * Window recover. 2231 * 2232 * @syscap SystemCapability.Window.SessionManager 2233 * @atomicservice 2234 * @since 12 2235 */ 2236 RECOVER, 2237 2238 /** 2239 * Window move. 2240 * 2241 * @syscap SystemCapability.Window.SessionManager 2242 * @atomicservice 2243 * @since 12 2244 */ 2245 MOVE, 2246 2247 /** 2248 * Window drag. 2249 * 2250 * @syscap SystemCapability.Window.SessionManager 2251 * @atomicservice 2252 * @since 12 2253 */ 2254 DRAG, 2255 2256 /** 2257 * Window drag start. 2258 * 2259 * @syscap SystemCapability.Window.SessionManager 2260 * @atomicservice 2261 * @since 12 2262 */ 2263 DRAG_START, 2264 2265 /** 2266 * Window drag end. 2267 * 2268 * @syscap SystemCapability.Window.SessionManager 2269 * @atomicservice 2270 * @since 12 2271 */ 2272 DRAG_END, 2273 } 2274 2275 /** 2276 * Create a window with a specific configuration 2277 * 2278 * @param { Configuration } config - Parameters for window creation. 2279 * @param { AsyncCallback<Window> } callback - Callback used to return the window created. 2280 * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. 2281 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2282 * 2. Incorrect parameter types. 2283 * @throws { BusinessError } 1300001 - Repeated operation. 2284 * @throws { BusinessError } 1300006 - This window context is abnormal. 2285 * @throws { BusinessError } 1300008 - The display device is abnormal. 2286 * @throws { BusinessError } 1300009 - The parent window is invalid. 2287 * @syscap SystemCapability.WindowManager.WindowManager.Core 2288 * @since 9 2289 */ 2290 /** 2291 * Create a window with a specific configuration 2292 * When config.windowType == TYPE_FLOAT, the "ohos.permission.SYSTEM_FLOAT_WINDOW" permission is required 2293 * 2294 * @permission ohos.permission.SYSTEM_FLOAT_WINDOW 2295 * @param { Configuration } config - Parameters for window creation. 2296 * @param { AsyncCallback<Window> } callback - Callback used to return the window created. 2297 * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. 2298 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2299 * 2. Incorrect parameter types. 2300 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 2301 * @throws { BusinessError } 1300001 - Repeated operation. 2302 * @throws { BusinessError } 1300002 - This window state is abnormal. 2303 * @throws { BusinessError } 1300004 - Unauthorized operation. 2304 * @throws { BusinessError } 1300006 - This window context is abnormal. 2305 * @throws { BusinessError } 1300008 - The display device is abnormal. 2306 * @throws { BusinessError } 1300009 - The parent window is invalid. 2307 * @syscap SystemCapability.WindowManager.WindowManager.Core 2308 * @atomicservice 2309 * @since 12 2310 */ 2311 function createWindow(config: Configuration, callback: AsyncCallback<Window>): void; 2312 2313 /** 2314 * Create a window with a specific configuration 2315 * 2316 * @param { Configuration } config - Parameters for window creation. 2317 * @returns { Promise<Window> } Promise used to return the window created. 2318 * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. 2319 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2320 * 2. Incorrect parameter types. 2321 * @throws { BusinessError } 1300001 - Repeated operation. 2322 * @throws { BusinessError } 1300006 - This window context is abnormal. 2323 * @throws { BusinessError } 1300008 - The display device is abnormal. 2324 * @throws { BusinessError } 1300009 - The parent window is invalid. 2325 * @syscap SystemCapability.WindowManager.WindowManager.Core 2326 * @since 9 2327 */ 2328 /** 2329 * Create a window with a specific configuration 2330 * When config.windowType == TYPE_FLOAT, the "ohos.permission.SYSTEM_FLOAT_WINDOW" permission is required 2331 * 2332 * @permission ohos.permission.SYSTEM_FLOAT_WINDOW 2333 * @param { Configuration } config - Parameters for window creation. 2334 * @returns { Promise<Window> } Promise used to return the window created. 2335 * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. 2336 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2337 * 2. Incorrect parameter types. 2338 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 2339 * @throws { BusinessError } 1300001 - Repeated operation. 2340 * @throws { BusinessError } 1300002 - This window state is abnormal. 2341 * @throws { BusinessError } 1300004 - Unauthorized operation. 2342 * @throws { BusinessError } 1300006 - This window context is abnormal. 2343 * @throws { BusinessError } 1300008 - The display device is abnormal. 2344 * @throws { BusinessError } 1300009 - The parent window is invalid. 2345 * @syscap SystemCapability.WindowManager.WindowManager.Core 2346 * @atomicservice 2347 * @since 12 2348 */ 2349 function createWindow(config: Configuration): Promise<Window>; 2350 2351 /** 2352 * Create a sub window with a specific id and type, only support 7. 2353 * 2354 * @param { string } id - Indicates window id. 2355 * @param { WindowType } type - Indicates window type. 2356 * @param { AsyncCallback<Window> } callback - Callback used to return the subwindow created. 2357 * @syscap SystemCapability.WindowManager.WindowManager.Core 2358 * @FAModelOnly 2359 * @since 7 2360 * @deprecated since 9 2361 * @useinstead ohos.window#createWindow 2362 */ 2363 function create(id: string, type: WindowType, callback: AsyncCallback<Window>): void; 2364 2365 /** 2366 * Create a sub window with a specific id and type, only support 7. 2367 * 2368 * @param { string } id - Indicates window id. 2369 * @param { WindowType } type - Indicates window type. 2370 * @returns { Promise<Window> } Promise used to return the subwindow created. 2371 * @syscap SystemCapability.WindowManager.WindowManager.Core 2372 * @FAModelOnly 2373 * @since 7 2374 * @deprecated since 9 2375 * @useinstead ohos.window#createWindow 2376 */ 2377 function create(id: string, type: WindowType): Promise<Window>; 2378 2379 /** 2380 * Create a system or float window with a specific id and type. 2381 * 2382 * @param { BaseContext } ctx - Indicates the context on which the window depends 2383 * @param { string } id - Indicates window id. 2384 * @param { WindowType } type - Indicates window type. 2385 * @returns { Promise<Window> } Promise used to return the window created. 2386 * @syscap SystemCapability.WindowManager.WindowManager.Core 2387 * @since 8 2388 * @deprecated since 9 2389 * @useinstead ohos.window#createWindow 2390 */ 2391 function create(ctx: BaseContext, id: string, type: WindowType): Promise<Window>; 2392 2393 /** 2394 * Create a system or float window with a specific id and type. 2395 * 2396 * @param { BaseContext } ctx - Indicates the context on which the window depends 2397 * @param { string } id - Indicates window id. 2398 * @param { WindowType } type - Indicates window type. 2399 * @param { AsyncCallback<Window> } callback - Callback used to return the window created. 2400 * @syscap SystemCapability.WindowManager.WindowManager.Core 2401 * @since 8 2402 * @deprecated since 9 2403 * @useinstead ohos.window#createWindow 2404 */ 2405 function create(ctx: BaseContext, id: string, type: WindowType, callback: AsyncCallback<Window>): void; 2406 2407 /** 2408 * Find the window by id. 2409 * 2410 * @param { string } id - Indicates window id. 2411 * @param { AsyncCallback<Window> } callback - Callback used to return the window found. 2412 * @syscap SystemCapability.WindowManager.WindowManager.Core 2413 * @since 7 2414 * @deprecated since 9 2415 * @useinstead ohos.window#findWindow 2416 */ 2417 function find(id: string, callback: AsyncCallback<Window>): void; 2418 2419 /** 2420 * Find the window by id. 2421 * 2422 * @param { string } id - Indicates window id. 2423 * @returns { Promise<Window> } Window found. 2424 * @syscap SystemCapability.WindowManager.WindowManager.Core 2425 * @since 7 2426 * @deprecated since 9 2427 * @useinstead ohos.window#findWindow 2428 */ 2429 function find(id: string): Promise<Window>; 2430 2431 /** 2432 * Find the window by name. 2433 * 2434 * @param { string } name - Indicates window name. 2435 * @returns { Window } Window found. 2436 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2437 * 2. Incorrect parameter types. 2438 * @throws { BusinessError } 1300002 - This window state is abnormal. 2439 * @syscap SystemCapability.WindowManager.WindowManager.Core 2440 * @since 9 2441 */ 2442 /** 2443 * Find the window by name. 2444 * 2445 * @param { string } name - Indicates window name. 2446 * @returns { Window } Window found. 2447 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2448 * 2. Incorrect parameter types. 2449 * @throws { BusinessError } 1300002 - This window state is abnormal. 2450 * @syscap SystemCapability.WindowManager.WindowManager.Core 2451 * @crossplatform 2452 * @since 10 2453 */ 2454 /** 2455 * Find the window by name. 2456 * 2457 * @param { string } name - Indicates window name. 2458 * @returns { Window } Window found. 2459 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2460 * 2. Incorrect parameter types. 2461 * @throws { BusinessError } 1300002 - This window state is abnormal. 2462 * @syscap SystemCapability.WindowManager.WindowManager.Core 2463 * @crossplatform 2464 * @atomicservice 2465 * @since 11 2466 */ 2467 function findWindow(name: string): Window; 2468 2469 /** 2470 * Get the final show window. 2471 * 2472 * @param { AsyncCallback<Window> } callback - Callback used to return the top window obtained. 2473 * @syscap SystemCapability.WindowManager.WindowManager.Core 2474 * @FAModelOnly 2475 * @since 6 2476 * @deprecated since 9 2477 * @useinstead ohos.window#getLastWindow 2478 */ 2479 function getTopWindow(callback: AsyncCallback<Window>): void; 2480 2481 /** 2482 * Get the final show window. 2483 * 2484 * @returns { Promise<Window> } Promise used to return the top window obtained. 2485 * @syscap SystemCapability.WindowManager.WindowManager.Core 2486 * @FAModelOnly 2487 * @since 6 2488 * @deprecated since 9 2489 * @useinstead ohos.window#getLastWindow 2490 */ 2491 function getTopWindow(): Promise<Window>; 2492 2493 /** 2494 * Get the final show window. 2495 * 2496 * @param { BaseContext } ctx - Indicates the context on which the window depends 2497 * @returns { Promise<Window> } Promise used to return the top window obtained. 2498 * @syscap SystemCapability.WindowManager.WindowManager.Core 2499 * @since 8 2500 * @deprecated since 9 2501 * @useinstead ohos.window#getLastWindow 2502 */ 2503 function getTopWindow(ctx: BaseContext): Promise<Window>; 2504 2505 /** 2506 * Get the final show window. 2507 * 2508 * @param { BaseContext } ctx - Indicates the context on which the window depends 2509 * @param { AsyncCallback<Window> } callback - Callback used to return the top window obtained. 2510 * @syscap SystemCapability.WindowManager.WindowManager.Core 2511 * @since 8 2512 * @deprecated since 9 2513 * @useinstead ohos.window#getLastWindow 2514 */ 2515 function getTopWindow(ctx: BaseContext, callback: AsyncCallback<Window>): void; 2516 2517 /** 2518 * Get the final show window. 2519 * 2520 * @param { BaseContext } ctx - Current application context. 2521 * @param { AsyncCallback<Window> } callback - Callback used to return the top window obtained. 2522 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2523 * 2. Incorrect parameter types. 2524 * @throws { BusinessError } 1300002 - This window state is abnormal. 2525 * @throws { BusinessError } 1300006 - This window context is abnormal. 2526 * @syscap SystemCapability.WindowManager.WindowManager.Core 2527 * @since 9 2528 */ 2529 /** 2530 * Get the final show window. 2531 * 2532 * @param { BaseContext } ctx - Current application context. 2533 * @param { AsyncCallback<Window> } callback - Callback used to return the top window obtained. 2534 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2535 * 2. Incorrect parameter types. 2536 * @throws { BusinessError } 1300002 - This window state is abnormal. 2537 * @throws { BusinessError } 1300006 - This window context is abnormal. 2538 * @syscap SystemCapability.WindowManager.WindowManager.Core 2539 * @crossplatform 2540 * @since 10 2541 */ 2542 /** 2543 * Get the final show window. 2544 * 2545 * @param { BaseContext } ctx - Current application context. 2546 * @param { AsyncCallback<Window> } callback - Callback used to return the top window obtained. 2547 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2548 * 2. Incorrect parameter types. 2549 * @throws { BusinessError } 1300002 - This window state is abnormal. 2550 * @throws { BusinessError } 1300006 - This window context is abnormal. 2551 * @syscap SystemCapability.WindowManager.WindowManager.Core 2552 * @crossplatform 2553 * @atomicservice 2554 * @since 12 2555 */ 2556 function getLastWindow(ctx: BaseContext, callback: AsyncCallback<Window>): void; 2557 2558 /** 2559 * Get the final show window. 2560 * 2561 * @param { BaseContext } ctx - Current application context. 2562 * @returns { Promise<Window> } Promise used to return the top window obtained. 2563 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2564 * 2. Incorrect parameter types. 2565 * @throws { BusinessError } 1300002 - This window state is abnormal. 2566 * @throws { BusinessError } 1300006 - This window context is abnormal. 2567 * @syscap SystemCapability.WindowManager.WindowManager.Core 2568 * @since 9 2569 */ 2570 /** 2571 * Get the final show window. 2572 * 2573 * @param { BaseContext } ctx - Current application context. 2574 * @returns { Promise<Window> } Promise used to return the top window obtained. 2575 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2576 * 2. Incorrect parameter types. 2577 * @throws { BusinessError } 1300002 - This window state is abnormal. 2578 * @throws { BusinessError } 1300006 - This window context is abnormal. 2579 * @syscap SystemCapability.WindowManager.WindowManager.Core 2580 * @crossplatform 2581 * @since 10 2582 */ 2583 /** 2584 * Get the final show window. 2585 * 2586 * @param { BaseContext } ctx - Current application context. 2587 * @returns { Promise<Window> } Promise used to return the top window obtained. 2588 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2589 * 2. Incorrect parameter types. 2590 * @throws { BusinessError } 1300002 - This window state is abnormal. 2591 * @throws { BusinessError } 1300006 - This window context is abnormal. 2592 * @syscap SystemCapability.WindowManager.WindowManager.Core 2593 * @crossplatform 2594 * @atomicservice 2595 * @since 12 2596 */ 2597 function getLastWindow(ctx: BaseContext): Promise<Window>; 2598 2599 /** 2600 * Minimize all app windows. 2601 * 2602 * @param { number } id - ID of the display. 2603 * @param { AsyncCallback<void> } callback - Callback used to return the result. 2604 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2605 * 2. Incorrect parameter types; 2606 * 3. Parameter verification failed. 2607 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2608 * @syscap SystemCapability.WindowManager.WindowManager.Core 2609 * @systemapi Hide this for inner system use. 2610 * @since 9 2611 */ 2612 /** 2613 * Minimize all app windows. 2614 * 2615 * @param { number } id - ID of the display. 2616 * @param { AsyncCallback<void> } callback - Callback used to return the result. 2617 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2618 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2619 * 2. Incorrect parameter types; 2620 * 3. Parameter verification failed. 2621 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 2622 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2623 * @syscap SystemCapability.WindowManager.WindowManager.Core 2624 * @systemapi Hide this for inner system use. 2625 * @since 12 2626 */ 2627 function minimizeAll(id: number, callback: AsyncCallback<void>): void; 2628 2629 /** 2630 * Minimize all app windows. 2631 * 2632 * @param { number } id - ID of the display. 2633 * @returns { Promise<void> } Promise that returns no value. 2634 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2635 * 2. Incorrect parameter types; 2636 * 3. Parameter verification failed. 2637 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2638 * @syscap SystemCapability.WindowManager.WindowManager.Core 2639 * @systemapi Hide this for inner system use. 2640 * @since 9 2641 */ 2642 /** 2643 * Minimize all app windows. 2644 * 2645 * @param { number } id - ID of the display. 2646 * @returns { Promise<void> } Promise that returns no value. 2647 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2648 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2649 * 2. Incorrect parameter types; 2650 * 3. Parameter verification failed. 2651 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 2652 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2653 * @syscap SystemCapability.WindowManager.WindowManager.Core 2654 * @systemapi Hide this for inner system use. 2655 * @since 12 2656 */ 2657 function minimizeAll(id: number): Promise<void>; 2658 2659 /** 2660 * Toggle shown state for all app windows. Minimize or restore all app windows. 2661 * 2662 * @param { AsyncCallback<void> } callback - Callback used to return the result. 2663 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2664 * @syscap SystemCapability.WindowManager.WindowManager.Core 2665 * @systemapi Hide this for inner system use. 2666 * @since 9 2667 */ 2668 /** 2669 * Toggle shown state for all app windows. Minimize or restore all app windows. 2670 * 2671 * @param { AsyncCallback<void> } callback - Callback used to return the result. 2672 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2673 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 2674 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2675 * @syscap SystemCapability.WindowManager.WindowManager.Core 2676 * @systemapi Hide this for inner system use. 2677 * @since 12 2678 */ 2679 function toggleShownStateForAllAppWindows(callback: AsyncCallback<void>): void; 2680 2681 /** 2682 * Toggle shown state for all app windows. Minimize or restore all app windows. 2683 * 2684 * @returns { Promise<void> } Promise that returns no value. 2685 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2686 * @syscap SystemCapability.WindowManager.WindowManager.Core 2687 * @systemapi Hide this for inner system use. 2688 * @since 9 2689 */ 2690 /** 2691 * Toggle shown state for all app windows. Minimize or restore all app windows. 2692 * 2693 * @returns { Promise<void> } Promise that returns no value. 2694 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2695 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 2696 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2697 * @syscap SystemCapability.WindowManager.WindowManager.Core 2698 * @systemapi Hide this for inner system use. 2699 * @since 12 2700 */ 2701 function toggleShownStateForAllAppWindows(): Promise<void>; 2702 2703 /** 2704 * Set the layout mode of a window. 2705 * 2706 * @param { WindowLayoutMode } mode - The layout mode of a window. 2707 * @param { AsyncCallback<void> } callback - Callback used to return the result. 2708 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2709 * 2. Incorrect parameter types; 2710 * 3. Parameter verification failed. 2711 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2712 * @syscap SystemCapability.WindowManager.WindowManager.Core 2713 * @systemapi Hide this for inner system use. 2714 * @since 9 2715 */ 2716 /** 2717 * Set the layout mode of a window. 2718 * 2719 * @param { WindowLayoutMode } mode - The layout mode of a window. 2720 * @param { AsyncCallback<void> } callback - Callback used to return the result. 2721 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2722 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2723 * 2. Incorrect parameter types; 2724 * 3. Parameter verification failed. 2725 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2726 * @syscap SystemCapability.WindowManager.WindowManager.Core 2727 * @systemapi Hide this for inner system use. 2728 * @since 12 2729 */ 2730 function setWindowLayoutMode(mode: WindowLayoutMode, callback: AsyncCallback<void>): void; 2731 2732 /** 2733 * Set the layout mode of a window. 2734 * 2735 * @param { WindowLayoutMode } mode - The layout mode of a window. 2736 * @returns { Promise<void> } Promise that returns no value. 2737 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2738 * 2. Incorrect parameter types; 2739 * 3. Parameter verification failed. 2740 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2741 * @syscap SystemCapability.WindowManager.WindowManager.Core 2742 * @systemapi Hide this for inner system use. 2743 * @since 9 2744 */ 2745 /** 2746 * Set the layout mode of a window. 2747 * 2748 * @param { WindowLayoutMode } mode - The layout mode of a window. 2749 * @returns { Promise<void> } Promise that returns no value. 2750 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2751 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2752 * 2. Incorrect parameter types; 2753 * 3. Parameter verification failed. 2754 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2755 * @syscap SystemCapability.WindowManager.WindowManager.Core 2756 * @systemapi Hide this for inner system use. 2757 * @since 12 2758 */ 2759 function setWindowLayoutMode(mode: WindowLayoutMode): Promise<void>; 2760 2761 /** 2762 * Sets whether to enable gesture navigation. 2763 * 2764 * @param { boolean } enable - Gesture navigation if true, or disable if false. 2765 * @param { AsyncCallback<void> } callback - The callback of setGestureNavigationEnabled. 2766 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2767 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2768 * 2. Incorrect parameter types. 2769 * @throws { BusinessError } 1300002 - This window state is abnormal. 2770 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2771 * @syscap SystemCapability.WindowManager.WindowManager.Core 2772 * @systemapi Hide this for inner system use. 2773 * @since 10 2774 */ 2775 function setGestureNavigationEnabled(enable: boolean, callback: AsyncCallback<void>): void; 2776 2777 /** 2778 * Sets whether to enable gesture navigation. 2779 * 2780 * @param { boolean } enable - Gesture navigation if true, or disable if false. 2781 * @returns { Promise<void> } - The promise returned by the function. 2782 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2783 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2784 * 2. Incorrect parameter types. 2785 * @throws { BusinessError } 1300002 - This window state is abnormal. 2786 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2787 * @syscap SystemCapability.WindowManager.WindowManager.Core 2788 * @systemapi Hide this for inner system use. 2789 * @since 10 2790 */ 2791 function setGestureNavigationEnabled(enable: boolean): Promise<void>; 2792 2793 /** 2794 * Set watermark image. 2795 * 2796 * @param { image.PixelMap } pixelMap - Watermark image. 2797 * @param { boolean } enable - Show watermark if true. 2798 * @returns { Promise<void> } - Promise that returns no value. 2799 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2800 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2801 * 2. Incorrect parameter types. 2802 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2803 * @syscap SystemCapability.WindowManager.WindowManager.Core 2804 * @systemapi Hide this for inner system use. 2805 * @since 10 2806 */ 2807 function setWaterMarkImage(pixelMap: image.PixelMap, enable: boolean): Promise<void>; 2808 2809 /** 2810 * Set watermark image. 2811 * 2812 * @param { image.PixelMap } pixelMap - Watermark image. 2813 * @param { boolean } enable - Show watermark if true. 2814 * @param { AsyncCallback<void> } callback - The callback of setWaterMarkImage. 2815 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2816 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2817 * 2. Incorrect parameter types. 2818 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2819 * @syscap SystemCapability.WindowManager.WindowManager.Core 2820 * @systemapi Hide this for inner system use. 2821 * @since 10 2822 */ 2823 function setWaterMarkImage(pixelMap: image.PixelMap, enable: boolean, callback: AsyncCallback<void>): void; 2824 2825 /** 2826 * Shift window focus within the same application. And the window type contains only main window and subwindow. 2827 * 2828 * @param { number } sourceWindowId - Window id which the focus shift from. 2829 * @param { number } targetWindowId - Window id which the focus shift to. 2830 * @returns { Promise<void> } - Promise that returns no value. 2831 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2832 * 2. Incorrect parameter types. 2833 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 2834 * @throws { BusinessError } 1300002 - This window state is abnormal. 2835 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2836 * @throws { BusinessError } 1300004 - Unauthorized operation. 2837 * @syscap SystemCapability.Window.SessionManager 2838 * @since 11 2839 */ 2840 /** 2841 * Shift window focus within the same application. And the window type contains only main window and subwindow. 2842 * 2843 * @param { number } sourceWindowId - Window id which the focus shift from. 2844 * @param { number } targetWindowId - Window id which the focus shift to. 2845 * @returns { Promise<void> } - Promise that returns no value. 2846 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2847 * 2. Incorrect parameter types. 2848 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 2849 * @throws { BusinessError } 1300002 - This window state is abnormal. 2850 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2851 * @throws { BusinessError } 1300004 - Unauthorized operation. 2852 * @syscap SystemCapability.Window.SessionManager 2853 * @atomicservice 2854 * @since 12 2855 */ 2856 function shiftAppWindowFocus(sourceWindowId: number, targetWindowId: number): Promise<void>; 2857 2858 /** 2859 * Get info of visible windows. 2860 * 2861 * @returns { Promise<Array<WindowInfo>> } - Promise that returns windowInfo list. 2862 * @throws { BusinessError } 202 - Permission verification failed, non-system application uses system API. 2863 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 2864 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2865 * @syscap SystemCapability.Window.SessionManager 2866 * @systemapi Hide this for inner system use. 2867 * @since 12 2868 */ 2869 function getVisibleWindowInfo(): Promise<Array<WindowInfo>>; 2870 2871 /** 2872 * gets snapshot of window 2873 * 2874 * @param { number } windowId - Indicates target window id. 2875 * @returns { Promise<image.PixelMap> } - Promise that returns no value. 2876 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2877 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2878 * <br>2. Incorrect parameter types. 3.Parameter verification failed. 2879 * @throws { BusinessError } 1300002 - This window state is abnormal. 2880 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2881 * @throws { BusinessError } 1300004 - This operation is not accessible. 2882 * @syscap SystemCapability.WindowManager.WindowManager.Core 2883 * @systemapi Hide this for inner system use. 2884 * @since 12 2885 */ 2886 function getSnapshot(windowId: number): Promise<image.PixelMap>; 2887 2888 /** 2889 * Register the callback of systemBarTintChange 2890 * 2891 * @param { 'systemBarTintChange' } type - The value is fixed at 'systemBarTintChange', indicating the property change event of the system bar. 2892 * @param { Callback<SystemBarTintState> } callback - Callback used to return the properties of the system bar. 2893 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2894 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2895 * 2. Incorrect parameter types; 2896 * 3. Parameter verification failed. 2897 * @syscap SystemCapability.WindowManager.WindowManager.Core 2898 * @systemapi Hide this for inner system use. 2899 * @since 8 2900 */ 2901 function on(type: 'systemBarTintChange', callback: Callback<SystemBarTintState>): void; 2902 2903 /** 2904 * Unregister the callback of systemBarTintChange 2905 * 2906 * @param { 'systemBarTintChange' } type - The value is fixed at 'systemBarTintChange', indicating the property change event of the system bar. 2907 * @param { Callback<SystemBarTintState> } callback - Callback used to return the properties of the system bar. 2908 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2909 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 2910 * 2. Parameter verification failed. 2911 * @syscap SystemCapability.WindowManager.WindowManager.Core 2912 * @systemapi Hide this for inner system use. 2913 * @since 8 2914 */ 2915 function off(type: 'systemBarTintChange', callback?: Callback<SystemBarTintState>): void; 2916 2917 /** 2918 * Register the callback for gesture navigation enabled changes. 2919 * 2920 * @param { 'gestureNavigationEnabledChange' } type the event of gesture navigation enabled changes. 2921 * @param { Callback<boolean> } callback Callback used to return the result whether gesture navigation enabled or not. 2922 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2923 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2924 * 2. Incorrect parameter types. 2925 * 3. Parameter verification failed. 2926 * @throws { BusinessError } 1300002 - This window state is abnormal. 2927 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2928 * @syscap SystemCapability.WindowManager.WindowManager.Core 2929 * @systemapi Hide this for inner system use. 2930 * @since 10 2931 */ 2932 function on(type: 'gestureNavigationEnabledChange', callback: Callback<boolean>): void; 2933 2934 /** 2935 * Unregister the callback for gesture navigation enabled changes. 2936 * 2937 * @param { 'gestureNavigationEnabledChange' } type the event of gesture navigation enabled changes. 2938 * @param { Callback<boolean> } callback Callback used to return the result whether gesture navigation enabled or not. 2939 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2940 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 2941 * 2. Parameter verification failed. 2942 * @throws { BusinessError } 1300002 - This window state is abnormal. 2943 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2944 * @syscap SystemCapability.WindowManager.WindowManager.Core 2945 * @systemapi Hide this for inner system use. 2946 * @since 10 2947 */ 2948 function off(type: 'gestureNavigationEnabledChange', callback?: Callback<boolean>): void; 2949 2950 /** 2951 * Register the callback for watermark flag change. 2952 * 2953 * @param { 'waterMarkFlagChange' } type the event of watermark flag change. 2954 * @param { Callback<boolean> } callback Callback used to return the result whether watermark flag change or not. 2955 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2956 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2957 * <br>2. Incorrect parameter types. 3.Parameter verification failed. 2958 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2959 * @syscap SystemCapability.WindowManager.WindowManager.Core 2960 * @systemapi Hide this for inner system use. 2961 * @since 10 2962 */ 2963 function on(type: 'waterMarkFlagChange', callback: Callback<boolean>): void; 2964 2965 /** 2966 * Unregister the callback for watermark flag change. 2967 * 2968 * @param { 'waterMarkFlagChange' } type the event of watermark flag change. 2969 * @param { Callback<boolean> } callback Callback used to return the result whether watermark flag change or not. 2970 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2971 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 2972 * <br>2. Parameter verification failed. 2973 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2974 * @syscap SystemCapability.WindowManager.WindowManager.Core 2975 * @systemapi Hide this for inner system use. 2976 * @since 10 2977 */ 2978 function off(type: 'waterMarkFlagChange', callback?: Callback<boolean>): void; 2979 /** 2980 * Display orientation 2981 * 2982 * @enum { number } 2983 * @syscap SystemCapability.WindowManager.WindowManager.Core 2984 * @since 9 2985 */ 2986 /** 2987 * Display orientation 2988 * 2989 * @enum { number } 2990 * @syscap SystemCapability.WindowManager.WindowManager.Core 2991 * @crossplatform 2992 * @since 10 2993 */ 2994 /** 2995 * Display orientation 2996 * 2997 * @enum { number } 2998 * @syscap SystemCapability.WindowManager.WindowManager.Core 2999 * @crossplatform 3000 * @atomicservice 3001 * @since 11 3002 */ 3003 enum Orientation { 3004 /** 3005 * Default value. The direction mode is not clearly defined. It is determined by the system. 3006 * 3007 * @syscap SystemCapability.WindowManager.WindowManager.Core 3008 * @since 9 3009 */ 3010 /** 3011 * Default value. The direction mode is not clearly defined. It is determined by the system. 3012 * 3013 * @syscap SystemCapability.WindowManager.WindowManager.Core 3014 * @crossplatform 3015 * @since 10 3016 */ 3017 /** 3018 * Default value. The direction mode is not clearly defined. It is determined by the system. 3019 * 3020 * @syscap SystemCapability.WindowManager.WindowManager.Core 3021 * @crossplatform 3022 * @atomicservice 3023 * @since 12 3024 */ 3025 UNSPECIFIED = 0, 3026 3027 /** 3028 * Display in portrait orientation. 3029 * 3030 * @syscap SystemCapability.WindowManager.WindowManager.Core 3031 * @since 9 3032 */ 3033 /** 3034 * Display in portrait orientation. 3035 * 3036 * @syscap SystemCapability.WindowManager.WindowManager.Core 3037 * @crossplatform 3038 * @since 10 3039 */ 3040 /** 3041 * Display in portrait orientation. 3042 * 3043 * @syscap SystemCapability.WindowManager.WindowManager.Core 3044 * @crossplatform 3045 * @atomicservice 3046 * @since 11 3047 */ 3048 PORTRAIT = 1, 3049 3050 /** 3051 * Display in landscape orientation. 3052 * 3053 * @syscap SystemCapability.WindowManager.WindowManager.Core 3054 * @since 9 3055 */ 3056 /** 3057 * Display in landscape orientation. 3058 * 3059 * @syscap SystemCapability.WindowManager.WindowManager.Core 3060 * @crossplatform 3061 * @since 10 3062 */ 3063 /** 3064 * Display in landscape orientation. 3065 * 3066 * @syscap SystemCapability.WindowManager.WindowManager.Core 3067 * @crossplatform 3068 * @atomicservice 3069 * @since 12 3070 */ 3071 LANDSCAPE = 2, 3072 3073 /** 3074 * Display in inverted portrait orientation. 3075 * 3076 * @syscap SystemCapability.WindowManager.WindowManager.Core 3077 * @since 9 3078 */ 3079 /** 3080 * Display in inverted portrait orientation. 3081 * 3082 * @syscap SystemCapability.WindowManager.WindowManager.Core 3083 * @crossplatform 3084 * @since 10 3085 */ 3086 /** 3087 * Display in inverted portrait orientation. 3088 * 3089 * @syscap SystemCapability.WindowManager.WindowManager.Core 3090 * @crossplatform 3091 * @atomicservice 3092 * @since 12 3093 */ 3094 PORTRAIT_INVERTED = 3, 3095 3096 /** 3097 * Display in inverted landscape orientation. 3098 * 3099 * @syscap SystemCapability.WindowManager.WindowManager.Core 3100 * @since 9 3101 */ 3102 /** 3103 * Display in inverted landscape orientation. 3104 * 3105 * @syscap SystemCapability.WindowManager.WindowManager.Core 3106 * @crossplatform 3107 * @since 10 3108 */ 3109 /** 3110 * Display in inverted landscape orientation. 3111 * 3112 * @syscap SystemCapability.WindowManager.WindowManager.Core 3113 * @crossplatform 3114 * @atomicservice 3115 * @since 12 3116 */ 3117 LANDSCAPE_INVERTED = 4, 3118 3119 /** 3120 * Follow the rotation of the sensor, ignore auto rotation lock. 3121 * 3122 * @syscap SystemCapability.WindowManager.WindowManager.Core 3123 * @since 9 3124 */ 3125 /** 3126 * Follow the rotation of the sensor, ignore auto rotation lock. 3127 * 3128 * @syscap SystemCapability.WindowManager.WindowManager.Core 3129 * @atomicservice 3130 * @since 11 3131 */ 3132 AUTO_ROTATION = 5, 3133 3134 /** 3135 * Follow the rotation of the sensor, only work in the vertical direction, ignore auto rotation lock. 3136 * 3137 * @syscap SystemCapability.WindowManager.WindowManager.Core 3138 * @since 9 3139 */ 3140 /** 3141 * Follow the rotation of the sensor, only work in the vertical direction, ignore auto rotation lock. 3142 * 3143 * @syscap SystemCapability.WindowManager.WindowManager.Core 3144 * @atomicservice 3145 * @since 12 3146 */ 3147 AUTO_ROTATION_PORTRAIT = 6, 3148 3149 /** 3150 * Follow the rotation of the sensor, only work in the horizontal direction, ignore auto rotation lock. 3151 * 3152 * @syscap SystemCapability.WindowManager.WindowManager.Core 3153 * @since 9 3154 */ 3155 /** 3156 * Follow the rotation of the sensor, only work in the horizontal direction, ignore auto rotation lock. 3157 * 3158 * @syscap SystemCapability.WindowManager.WindowManager.Core 3159 * @atomicservice 3160 * @since 12 3161 */ 3162 AUTO_ROTATION_LANDSCAPE = 7, 3163 3164 /** 3165 * Follow the rotation of the sensor, controlled by auto rotation lock. 3166 * 3167 * @syscap SystemCapability.WindowManager.WindowManager.Core 3168 * @since 9 3169 */ 3170 /** 3171 * Follow the rotation of the sensor, controlled by auto rotation lock. 3172 * 3173 * @syscap SystemCapability.WindowManager.WindowManager.Core 3174 * @atomicservice 3175 * @since 12 3176 */ 3177 AUTO_ROTATION_RESTRICTED = 8, 3178 3179 /** 3180 * Follow the rotation of the sensor, only work in the vertical direction, controlled by auto rotation lock. 3181 * 3182 * @syscap SystemCapability.WindowManager.WindowManager.Core 3183 * @since 9 3184 */ 3185 /** 3186 * Follow the rotation of the sensor, only work in the vertical direction, controlled by auto rotation lock. 3187 * 3188 * @syscap SystemCapability.WindowManager.WindowManager.Core 3189 * @atomicservice 3190 * @since 12 3191 */ 3192 AUTO_ROTATION_PORTRAIT_RESTRICTED = 9, 3193 3194 /** 3195 * Follow the rotation of the sensor, only work in the horizontal direction, controlled by auto rotation lock. 3196 * 3197 * @syscap SystemCapability.WindowManager.WindowManager.Core 3198 * @since 9 3199 */ 3200 /** 3201 * Follow the rotation of the sensor, only work in the horizontal direction, controlled by auto rotation lock. 3202 * 3203 * @syscap SystemCapability.WindowManager.WindowManager.Core 3204 * @atomicservice 3205 * @since 12 3206 */ 3207 AUTO_ROTATION_LANDSCAPE_RESTRICTED = 10, 3208 3209 /** 3210 * Locked mode, keep the same direction as previous one. 3211 * 3212 * @syscap SystemCapability.WindowManager.WindowManager.Core 3213 * @since 9 3214 */ 3215 /** 3216 * Locked mode, keep the same direction as previous one. 3217 * 3218 * @syscap SystemCapability.WindowManager.WindowManager.Core 3219 * @atomicservice 3220 * @since 12 3221 */ 3222 LOCKED = 11, 3223 3224 /** 3225 * Follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. 3226 * 3227 * @syscap SystemCapability.Window.SessionManager 3228 * @atomicservice 3229 * @since 12 3230 */ 3231 AUTO_ROTATION_UNSPECIFIED = 12, 3232 3233 /** 3234 * Display in portrait orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. 3235 * 3236 * @syscap SystemCapability.Window.SessionManager 3237 * @atomicservice 3238 * @since 12 3239 */ 3240 USER_ROTATION_PORTRAIT = 13, 3241 3242 /** 3243 * Display in landscape orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. 3244 * 3245 * @syscap SystemCapability.Window.SessionManager 3246 * @atomicservice 3247 * @since 12 3248 */ 3249 USER_ROTATION_LANDSCAPE = 14, 3250 3251 /** 3252 * Display in inverted portrait orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. 3253 * 3254 * @syscap SystemCapability.Window.SessionManager 3255 * @atomicservice 3256 * @since 12 3257 */ 3258 USER_ROTATION_PORTRAIT_INVERTED = 15, 3259 3260 /** 3261 * Display in inverted landscape orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. 3262 * 3263 * @syscap SystemCapability.Window.SessionManager 3264 * @atomicservice 3265 * @since 12 3266 */ 3267 USER_ROTATION_LANDSCAPE_INVERTED = 16, 3268 3269 /** 3270 * Follow the desktop rotate mode. 3271 * 3272 * @syscap SystemCapability.Window.SessionManager 3273 * @atomicservice 3274 * @since 12 3275 */ 3276 FOLLOW_DESKTOP = 17 3277 } 3278 3279 /** 3280 * Type of blur style 3281 * 3282 * @enum { number } 3283 * @syscap SystemCapability.WindowManager.WindowManager.Core 3284 * @systemapi Hide this for inner system use. 3285 * @since 9 3286 */ 3287 enum BlurStyle { 3288 /** 3289 * Close blur. 3290 * 3291 * @syscap SystemCapability.WindowManager.WindowManager.Core 3292 * @systemapi Hide this for inner system use. 3293 * @since 9 3294 */ 3295 OFF, 3296 /** 3297 * Blur style thin. 3298 * 3299 * @syscap SystemCapability.WindowManager.WindowManager.Core 3300 * @systemapi Hide this for inner system use. 3301 * @since 9 3302 */ 3303 THIN, 3304 /** 3305 * Blur style regular. 3306 * 3307 * @syscap SystemCapability.WindowManager.WindowManager.Core 3308 * @systemapi Hide this for inner system use. 3309 * @since 9 3310 */ 3311 REGULAR, 3312 /** 3313 * Blur style thick. 3314 * 3315 * @syscap SystemCapability.WindowManager.WindowManager.Core 3316 * @systemapi Hide this for inner system use. 3317 * @since 9 3318 */ 3319 THICK 3320 } 3321 3322 /** 3323 * Enum for window callback event type 3324 * 3325 * @enum { number } 3326 * @syscap SystemCapability.WindowManager.WindowManager.Core 3327 * @since 10 3328 */ 3329 /** 3330 * Enum for window callback event type 3331 * 3332 * @enum { number } 3333 * @syscap SystemCapability.WindowManager.WindowManager.Core 3334 * @crossplatform 3335 * @atomicservice 3336 * @since 11 3337 */ 3338 enum WindowEventType { 3339 /** 3340 * The value of window event is window show 3341 * 3342 * @syscap SystemCapability.WindowManager.WindowManager.Core 3343 * @since 10 3344 */ 3345 /** 3346 * The value of window event is window show 3347 * 3348 * @syscap SystemCapability.WindowManager.WindowManager.Core 3349 * @crossplatform 3350 * @atomicservice 3351 * @since 11 3352 */ 3353 WINDOW_SHOWN = 1, 3354 /** 3355 * The value of window event is window active 3356 * 3357 * @syscap SystemCapability.WindowManager.WindowManager.Core 3358 * @since 10 3359 */ 3360 /** 3361 * The value of window event is window active 3362 * 3363 * @syscap SystemCapability.WindowManager.WindowManager.Core 3364 * @crossplatform 3365 * @atomicservice 3366 * @since 11 3367 */ 3368 WINDOW_ACTIVE = 2, 3369 /** 3370 * The value of window event is window inactive 3371 * 3372 * @syscap SystemCapability.WindowManager.WindowManager.Core 3373 * @since 10 3374 */ 3375 /** 3376 * The value of window event is window inactive 3377 * 3378 * @syscap SystemCapability.WindowManager.WindowManager.Core 3379 * @crossplatform 3380 * @atomicservice 3381 * @since 11 3382 */ 3383 WINDOW_INACTIVE = 3, 3384 /** 3385 * The value of window event is window hide 3386 * 3387 * @syscap SystemCapability.WindowManager.WindowManager.Core 3388 * @since 10 3389 */ 3390 /** 3391 * The value of window event is window hide 3392 * 3393 * @syscap SystemCapability.WindowManager.WindowManager.Core 3394 * @crossplatform 3395 * @atomicservice 3396 * @since 11 3397 */ 3398 WINDOW_HIDDEN = 4, 3399 /** 3400 * The value of window event is window destroy 3401 * 3402 * @syscap SystemCapability.Window.SessionManager 3403 * @atomicservice 3404 * @since 11 3405 */ 3406 WINDOW_DESTROYED = 7 3407 } 3408 3409 /** 3410 * Enum for window maximize presentation 3411 * 3412 * @enum { number } 3413 * @syscap SystemCapability.Window.SessionManager 3414 * @atomicservice 3415 * @since 12 3416 */ 3417 enum MaximizePresentation { 3418 /** 3419 * The value means follow immersive state which set by app 3420 * 3421 * @syscap SystemCapability.Window.SessionManager 3422 * @atomicservice 3423 * @since 12 3424 */ 3425 FOLLOW_APP_IMMERSIVE_SETTING = 0, 3426 /** 3427 * The value means exit immersive state 3428 * 3429 * @syscap SystemCapability.Window.SessionManager 3430 * @atomicservice 3431 * @since 12 3432 */ 3433 EXIT_IMMERSIVE = 1, 3434 /** 3435 * The value means enter immersive state 3436 * 3437 * @syscap SystemCapability.Window.SessionManager 3438 * @atomicservice 3439 * @since 12 3440 */ 3441 ENTER_IMMERSIVE = 2, 3442 } 3443 3444 /** 3445 * Specific system bar type. 3446 * 3447 * @syscap SystemCapability.Window.SessionManager 3448 * @atomicservice 3449 * @since 11 3450 */ 3451 /** 3452 * Specific system bar type. 3453 * 3454 * @typedef {'status' | 'navigation' | 'navigationIndicator'} 3455 * @syscap SystemCapability.Window.SessionManager 3456 * @crossplatform 3457 * @atomicservice 3458 * @since 12 3459 */ 3460 type SpecificSystemBar = 'status' | 'navigation' | 'navigationIndicator'; 3461 3462 /** 3463 * Window 3464 * 3465 * @interface Window 3466 * @syscap SystemCapability.WindowManager.WindowManager.Core 3467 * @since 6 3468 */ 3469 /** 3470 * Window 3471 * 3472 * @interface Window 3473 * @syscap SystemCapability.WindowManager.WindowManager.Core 3474 * @crossplatform 3475 * @atomicservice 3476 * @since 11 3477 */ 3478 interface Window { 3479 /** 3480 * Hide window. 3481 * 3482 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3483 * @throws { BusinessError } 1300002 - This window state is abnormal. 3484 * @syscap SystemCapability.WindowManager.WindowManager.Core 3485 * @systemapi Hide this for inner system use. 3486 * @since 7 3487 */ 3488 /** 3489 * Hide window. 3490 * 3491 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3492 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 3493 * @throws { BusinessError } 1300002 - This window state is abnormal. 3494 * @syscap SystemCapability.WindowManager.WindowManager.Core 3495 * @systemapi Hide this for inner system use. 3496 * @since 12 3497 */ 3498 hide(callback: AsyncCallback<void>): void; 3499 3500 /** 3501 * Hide window. 3502 * 3503 * @returns { Promise<void> } Promise that returns no value. 3504 * @throws { BusinessError } 1300002 - This window state is abnormal. 3505 * @syscap SystemCapability.WindowManager.WindowManager.Core 3506 * @systemapi Hide this for inner system use. 3507 * @since 7 3508 */ 3509 /** 3510 * Hide window. 3511 * 3512 * @returns { Promise<void> } Promise that returns no value. 3513 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 3514 * @throws { BusinessError } 1300002 - This window state is abnormal. 3515 * @syscap SystemCapability.WindowManager.WindowManager.Core 3516 * @systemapi Hide this for inner system use. 3517 * @since 12 3518 */ 3519 hide(): Promise<void>; 3520 3521 /** 3522 * Hide window with animation. 3523 * 3524 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3525 * @throws { BusinessError } 1300002 - This window state is abnormal. 3526 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3527 * @throws { BusinessError } 1300004 - Unauthorized operation. 3528 * @syscap SystemCapability.WindowManager.WindowManager.Core 3529 * @systemapi 3530 * @since 9 3531 */ 3532 /** 3533 * Hide window with animation. 3534 * 3535 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3536 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 3537 * @throws { BusinessError } 1300002 - This window state is abnormal. 3538 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3539 * @throws { BusinessError } 1300004 - Unauthorized operation. 3540 * @syscap SystemCapability.WindowManager.WindowManager.Core 3541 * @systemapi 3542 * @since 12 3543 */ 3544 hideWithAnimation(callback: AsyncCallback<void>): void; 3545 3546 /** 3547 * Hide window with animation. 3548 * 3549 * @returns { Promise<void> } Promise that returns no value. 3550 * @throws { BusinessError } 1300002 - This window state is abnormal. 3551 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3552 * @throws { BusinessError } 1300004 - Unauthorized operation. 3553 * @syscap SystemCapability.WindowManager.WindowManager.Core 3554 * @systemapi 3555 * @since 9 3556 */ 3557 /** 3558 * Hide window with animation. 3559 * 3560 * @returns { Promise<void> } Promise that returns no value. 3561 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 3562 * @throws { BusinessError } 1300002 - This window state is abnormal. 3563 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3564 * @throws { BusinessError } 1300004 - Unauthorized operation. 3565 * @syscap SystemCapability.WindowManager.WindowManager.Core 3566 * @systemapi 3567 * @since 12 3568 */ 3569 hideWithAnimation(): Promise<void>; 3570 3571 /** 3572 * Show window. 3573 * 3574 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3575 * @syscap SystemCapability.WindowManager.WindowManager.Core 3576 * @since 7 3577 * @deprecated since 9 3578 * @useinstead ohos.window.Window#showWindow 3579 */ 3580 show(callback: AsyncCallback<void>): void; 3581 3582 /** 3583 * Show window. 3584 * 3585 * @returns { Promise<void> } Promise that returns no value. 3586 * @syscap SystemCapability.WindowManager.WindowManager.Core 3587 * @since 7 3588 * @deprecated since 9 3589 * @useinstead ohos.window.Window#showWindow 3590 */ 3591 show(): Promise<void>; 3592 3593 /** 3594 * Show window. 3595 * 3596 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3597 * @throws { BusinessError } 1300002 - This window state is abnormal. 3598 * @syscap SystemCapability.WindowManager.WindowManager.Core 3599 * @since 9 3600 */ 3601 /** 3602 * Show window. 3603 * 3604 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3605 * @throws { BusinessError } 1300002 - This window state is abnormal. 3606 * @syscap SystemCapability.WindowManager.WindowManager.Core 3607 * @crossplatform 3608 * @since 10 3609 */ 3610 /** 3611 * Show window. 3612 * 3613 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3614 * @throws { BusinessError } 1300002 - This window state is abnormal. 3615 * @syscap SystemCapability.WindowManager.WindowManager.Core 3616 * @crossplatform 3617 * @atomicservice 3618 * @since 11 3619 */ 3620 showWindow(callback: AsyncCallback<void>): void; 3621 3622 /** 3623 * Show window. 3624 * 3625 * @returns { Promise<void> } Promise that returns no value. 3626 * @throws { BusinessError } 1300002 - This window state is abnormal. 3627 * @syscap SystemCapability.WindowManager.WindowManager.Core 3628 * @since 9 3629 */ 3630 /** 3631 * Show window. 3632 * 3633 * @returns { Promise<void> } Promise that returns no value. 3634 * @throws { BusinessError } 1300002 - This window state is abnormal. 3635 * @syscap SystemCapability.WindowManager.WindowManager.Core 3636 * @crossplatform 3637 * @since 10 3638 */ 3639 /** 3640 * Show window. 3641 * 3642 * @returns { Promise<void> } Promise that returns no value. 3643 * @throws { BusinessError } 1300002 - This window state is abnormal. 3644 * @syscap SystemCapability.WindowManager.WindowManager.Core 3645 * @crossplatform 3646 * @atomicservice 3647 * @since 11 3648 */ 3649 showWindow(): Promise<void>; 3650 3651 /** 3652 * Show window with animation. 3653 * 3654 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3655 * @throws { BusinessError } 1300002 - This window state is abnormal. 3656 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3657 * @throws { BusinessError } 1300004 - Unauthorized operation. 3658 * @syscap SystemCapability.WindowManager.WindowManager.Core 3659 * @systemapi 3660 * @since 9 3661 */ 3662 /** 3663 * Show window with animation. 3664 * 3665 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3666 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 3667 * @throws { BusinessError } 1300002 - This window state is abnormal. 3668 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3669 * @throws { BusinessError } 1300004 - Unauthorized operation. 3670 * @syscap SystemCapability.WindowManager.WindowManager.Core 3671 * @systemapi 3672 * @since 12 3673 */ 3674 showWithAnimation(callback: AsyncCallback<void>): void; 3675 3676 /** 3677 * Show window with animation. 3678 * 3679 * @returns { Promise<void> } Promise that returns no value. 3680 * @throws { BusinessError } 1300002 - This window state is abnormal. 3681 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3682 * @throws { BusinessError } 1300004 - Unauthorized operation. 3683 * @syscap SystemCapability.WindowManager.WindowManager.Core 3684 * @systemapi 3685 * @since 9 3686 */ 3687 /** 3688 * Show window with animation. 3689 * 3690 * @returns { Promise<void> } Promise that returns no value. 3691 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 3692 * @throws { BusinessError } 1300002 - This window state is abnormal. 3693 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3694 * @throws { BusinessError } 1300004 - Unauthorized operation. 3695 * @syscap SystemCapability.WindowManager.WindowManager.Core 3696 * @systemapi 3697 * @since 12 3698 */ 3699 showWithAnimation(): Promise<void>; 3700 3701 /** 3702 * Destroy the window. 3703 * 3704 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3705 * @syscap SystemCapability.WindowManager.WindowManager.Core 3706 * @since 7 3707 * @deprecated since 9 3708 * @useinstead ohos.window.Window#destroyWindow 3709 */ 3710 destroy(callback: AsyncCallback<void>): void; 3711 3712 /** 3713 * Destroy the window. 3714 * 3715 * @returns { Promise<void> } Promise that returns no value. 3716 * @syscap SystemCapability.WindowManager.WindowManager.Core 3717 * @since 7 3718 * @deprecated since 9 3719 * @useinstead ohos.window.Window#destroyWindow 3720 */ 3721 destroy(): Promise<void>; 3722 3723 /** 3724 * Destroy the window. 3725 * 3726 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3727 * @throws { BusinessError } 1300002 - This window state is abnormal. 3728 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3729 * @syscap SystemCapability.WindowManager.WindowManager.Core 3730 * @since 9 3731 */ 3732 /** 3733 * Destroy the window. 3734 * 3735 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3736 * @throws { BusinessError } 1300002 - This window state is abnormal. 3737 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3738 * @syscap SystemCapability.WindowManager.WindowManager.Core 3739 * @crossplatform 3740 * @since 10 3741 */ 3742 /** 3743 * Destroy the window. 3744 * 3745 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3746 * @throws { BusinessError } 1300002 - This window state is abnormal. 3747 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3748 * @syscap SystemCapability.WindowManager.WindowManager.Core 3749 * @crossplatform 3750 * @atomicservice 3751 * @since 11 3752 */ 3753 destroyWindow(callback: AsyncCallback<void>): void; 3754 3755 /** 3756 * Destroy the window. 3757 * 3758 * @returns { Promise<void> } Promise that returns no value. 3759 * @throws { BusinessError } 1300002 - This window state is abnormal. 3760 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3761 * @syscap SystemCapability.WindowManager.WindowManager.Core 3762 * @since 9 3763 */ 3764 /** 3765 * Destroy the window. 3766 * 3767 * @returns { Promise<void> } Promise that returns no value. 3768 * @throws { BusinessError } 1300002 - This window state is abnormal. 3769 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3770 * @syscap SystemCapability.WindowManager.WindowManager.Core 3771 * @crossplatform 3772 * @since 10 3773 */ 3774 /** 3775 * Destroy the window. 3776 * 3777 * @returns { Promise<void> } Promise that returns no value. 3778 * @throws { BusinessError } 1300002 - This window state is abnormal. 3779 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3780 * @syscap SystemCapability.WindowManager.WindowManager.Core 3781 * @crossplatform 3782 * @atomicservice 3783 * @since 11 3784 */ 3785 destroyWindow(): Promise<void>; 3786 3787 /** 3788 * Set the position of a window. 3789 * 3790 * @param { number } x - Indicate the X-coordinate of the window. 3791 * @param { number } y - Indicate the Y-coordinate of the window. 3792 * @returns { Promise<void> } Promise that returns no value. 3793 * @syscap SystemCapability.WindowManager.WindowManager.Core 3794 * @since 7 3795 * @deprecated since 9 3796 * @useinstead ohos.window.Window#moveWindowTo 3797 */ 3798 moveTo(x: number, y: number): Promise<void>; 3799 3800 /** 3801 * Set the position of a window. 3802 * 3803 * @param { number } x - Indicate the X-coordinate of the window. 3804 * @param { number } y - Indicate the Y-coordinate of the window. 3805 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3806 * @syscap SystemCapability.WindowManager.WindowManager.Core 3807 * @since 7 3808 * @deprecated since 9 3809 * @useinstead ohos.window.Window#moveWindowTo 3810 */ 3811 moveTo(x: number, y: number, callback: AsyncCallback<void>): void; 3812 3813 /** 3814 * Set the position of a window. 3815 * 3816 * @param { number } x - Indicate the X-coordinate of the window. 3817 * @param { number } y - Indicate the Y-coordinate of the window. 3818 * @returns { Promise<void> } Promise that returns no value. 3819 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3820 * 2. Incorrect parameter types. 3821 * @throws { BusinessError } 1300002 - This window state is abnormal. 3822 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3823 * @syscap SystemCapability.WindowManager.WindowManager.Core 3824 * @since 9 3825 */ 3826 /** 3827 * Set the position of a window. 3828 * 3829 * @param { number } x - Indicate the X-coordinate of the window. 3830 * @param { number } y - Indicate the Y-coordinate of the window. 3831 * @returns { Promise<void> } Promise that returns no value. 3832 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3833 * 2. Incorrect parameter types. 3834 * @throws { BusinessError } 1300002 - This window state is abnormal. 3835 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3836 * @syscap SystemCapability.WindowManager.WindowManager.Core 3837 * @crossplatform 3838 * @since 10 3839 */ 3840 /** 3841 * Set the position of a window. 3842 * 3843 * @param { number } x - Indicate the X-coordinate of the window. 3844 * @param { number } y - Indicate the Y-coordinate of the window. 3845 * @returns { Promise<void> } Promise that returns no value. 3846 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3847 * 2. Incorrect parameter types. 3848 * @throws { BusinessError } 1300002 - This window state is abnormal. 3849 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3850 * @syscap SystemCapability.WindowManager.WindowManager.Core 3851 * @crossplatform 3852 * @atomicservice 3853 * @since 11 3854 */ 3855 moveWindowTo(x: number, y: number): Promise<void>; 3856 3857 /** 3858 * Set the position of a window. 3859 * 3860 * @param { number } x - Indicate the X-coordinate of the window. 3861 * @param { number } y - Indicate the Y-coordinate of the window. 3862 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3863 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3864 * 2. Incorrect parameter types. 3865 * @throws { BusinessError } 1300002 - This window state is abnormal. 3866 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3867 * @syscap SystemCapability.WindowManager.WindowManager.Core 3868 * @since 9 3869 */ 3870 /** 3871 * Set the position of a window. 3872 * 3873 * @param { number } x - Indicate the X-coordinate of the window. 3874 * @param { number } y - Indicate the Y-coordinate of the window. 3875 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3876 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3877 * 2. Incorrect parameter types. 3878 * @throws { BusinessError } 1300002 - This window state is abnormal. 3879 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3880 * @syscap SystemCapability.WindowManager.WindowManager.Core 3881 * @crossplatform 3882 * @since 10 3883 */ 3884 /** 3885 * Set the position of a window. 3886 * 3887 * @param { number } x - Indicate the X-coordinate of the window. 3888 * @param { number } y - Indicate the Y-coordinate of the window. 3889 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3890 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3891 * 2. Incorrect parameter types. 3892 * @throws { BusinessError } 1300002 - This window state is abnormal. 3893 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3894 * @syscap SystemCapability.WindowManager.WindowManager.Core 3895 * @crossplatform 3896 * @atomicservice 3897 * @since 11 3898 */ 3899 moveWindowTo(x: number, y: number, callback: AsyncCallback<void>): void; 3900 3901 /** 3902 * Move window to the position. 3903 * 3904 * @param { number } x - Indicate the X-coordinate of the window. 3905 * @param { number } y - Indicate the Y-coordinate of the window. 3906 * @returns { Promise<void> } Promise that returns no value. 3907 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3908 * 2. Incorrect parameter types. 3909 * 3. Parameter verification failed. 3910 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 3911 * @throws { BusinessError } 1300002 - This window state is abnormal. 3912 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3913 * @throws { BusinessError } 1300010 - The operation in the current window status is invalid. 3914 * @syscap SystemCapability.Window.SessionManager 3915 * @atomicservice 3916 * @since 12 3917 */ 3918 moveWindowToAsync(x: number, y: number): Promise<void>; 3919 3920 /** 3921 * Move window to the position relative to current screen. 3922 * 3923 * @param { number } x - Indicate the X-coordinate of the window relative to current screen. 3924 * @param { number } y - Indicate the Y-coordinate of the window relative to current screen. 3925 * @returns { Promise<void> } Promise that returns no value. 3926 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3927 * 2. Incorrect parameter types. 3928 * 3. Parameter verification failed. 3929 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 3930 * @throws { BusinessError } 1300002 - This window state is abnormal. 3931 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3932 * @throws { BusinessError } 1300010 - The operation in the current window status is invalid. 3933 * @syscap SystemCapability.Window.SessionManager 3934 * @atomicservice 3935 * @since 13 3936 */ 3937 moveWindowToGlobal(x: number, y: number): Promise<void>; 3938 3939 /** 3940 * Set the size of a window . 3941 * 3942 * @param { number } width - Indicates the width of the window. 3943 * @param { number } height - Indicates the height of the window. 3944 * @returns { Promise<void> } Promise that returns no value. 3945 * @syscap SystemCapability.WindowManager.WindowManager.Core 3946 * @since 7 3947 * @deprecated since 9 3948 * @useinstead ohos.window.Window#resize 3949 */ 3950 resetSize(width: number, height: number): Promise<void>; 3951 3952 /** 3953 * Set the size of a window . 3954 * 3955 * @param { number } width - Indicates the width of the window. 3956 * @param { number } height - Indicates the height of the window. 3957 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3958 * @syscap SystemCapability.WindowManager.WindowManager.Core 3959 * @since 7 3960 * @deprecated since 9 3961 * @useinstead ohos.window.Window#resize 3962 */ 3963 resetSize(width: number, height: number, callback: AsyncCallback<void>): void; 3964 3965 /** 3966 * Set the size of a window . 3967 * 3968 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 3969 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 3970 * @returns { Promise<void> } Promise that returns no value. 3971 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3972 * 2. Incorrect parameter types; 3973 * 3. Parameter verification failed. 3974 * @throws { BusinessError } 1300002 - This window state is abnormal. 3975 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3976 * @syscap SystemCapability.WindowManager.WindowManager.Core 3977 * @since 9 3978 */ 3979 /** 3980 * Set the size of a window . 3981 * 3982 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 3983 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 3984 * @returns { Promise<void> } Promise that returns no value. 3985 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3986 * 2. Incorrect parameter types; 3987 * 3. Parameter verification failed. 3988 * @throws { BusinessError } 1300002 - This window state is abnormal. 3989 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3990 * @syscap SystemCapability.WindowManager.WindowManager.Core 3991 * @crossplatform 3992 * @since 10 3993 */ 3994 /** 3995 * Set the size of a window . 3996 * 3997 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 3998 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 3999 * @returns { Promise<void> } Promise that returns no value. 4000 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4001 * 2. Incorrect parameter types; 4002 * 3. Parameter verification failed. 4003 * @throws { BusinessError } 1300002 - This window state is abnormal. 4004 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4005 * @syscap SystemCapability.WindowManager.WindowManager.Core 4006 * @crossplatform 4007 * @atomicservice 4008 * @since 11 4009 */ 4010 resize(width: number, height: number): Promise<void>; 4011 4012 /** 4013 * Set the size of a window . 4014 * 4015 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 4016 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 4017 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4018 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4019 * 2. Incorrect parameter types; 4020 * 3. Parameter verification failed. 4021 * @throws { BusinessError } 1300002 - This window state is abnormal. 4022 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4023 * @syscap SystemCapability.WindowManager.WindowManager.Core 4024 * @since 9 4025 */ 4026 /** 4027 * Set the size of a window . 4028 * 4029 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 4030 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 4031 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4032 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4033 * 2. Incorrect parameter types; 4034 * 3. Parameter verification failed. 4035 * @throws { BusinessError } 1300002 - This window state is abnormal. 4036 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4037 * @syscap SystemCapability.WindowManager.WindowManager.Core 4038 * @crossplatform 4039 * @since 10 4040 */ 4041 /** 4042 * Set the size of a window . 4043 * 4044 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 4045 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 4046 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4047 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4048 * 2. Incorrect parameter types; 4049 * 3. Parameter verification failed. 4050 * @throws { BusinessError } 1300002 - This window state is abnormal. 4051 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4052 * @syscap SystemCapability.WindowManager.WindowManager.Core 4053 * @crossplatform 4054 * @atomicservice 4055 * @since 11 4056 */ 4057 resize(width: number, height: number, callback: AsyncCallback<void>): void; 4058 4059 /** 4060 * Set the size of a window. 4061 * 4062 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 4063 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 4064 * @returns { Promise<void> } Promise that returns no value. 4065 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4066 * 2. Incorrect parameter types; 4067 * 3. Parameter verification failed. 4068 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 4069 * @throws { BusinessError } 1300002 - This window state is abnormal. 4070 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4071 * @throws { BusinessError } 1300010 - The operation in the current window status is invalid. 4072 * @syscap SystemCapability.Window.SessionManager 4073 * @atomicservice 4074 * @since 12 4075 */ 4076 resizeAsync(width: number, height: number): Promise<void>; 4077 4078 /** 4079 * Set the type of a window. 4080 * 4081 * @param { WindowType } type - Indicate the type of a window. 4082 * @returns { Promise<void> } Promise that returns no value. 4083 * @syscap SystemCapability.WindowManager.WindowManager.Core 4084 * @systemapi Hide this for inner system use. 4085 * @since 7 4086 * @deprecated since 9 4087 */ 4088 setWindowType(type: WindowType): Promise<void>; 4089 4090 /** 4091 * Set the type of a window. 4092 * 4093 * @param { WindowType } type - Indicate the type of a window. 4094 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4095 * @syscap SystemCapability.WindowManager.WindowManager.Core 4096 * @systemapi Hide this for inner system use. 4097 * @since 7 4098 * @deprecated since 9 4099 */ 4100 setWindowType(type: WindowType, callback: AsyncCallback<void>): void; 4101 4102 /** 4103 * Set the mode of a window. 4104 * 4105 * @param { WindowMode } mode - Indicate the mode of a window. 4106 * @returns { Promise<void> } Promise that returns no value. 4107 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4108 * 2. Incorrect parameter types; 4109 * 3. Parameter verification failed. 4110 * @throws { BusinessError } 1300002 - This window state is abnormal. 4111 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4112 * @syscap SystemCapability.WindowManager.WindowManager.Core 4113 * @systemapi Hide this for inner system use. 4114 * @since 9 4115 */ 4116 /** 4117 * Set the mode of a window. 4118 * 4119 * @param { WindowMode } mode - Indicate the mode of a window. 4120 * @returns { Promise<void> } Promise that returns no value. 4121 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 4122 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4123 * 2. Incorrect parameter types; 4124 * 3. Parameter verification failed. 4125 * @throws { BusinessError } 1300002 - This window state is abnormal. 4126 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4127 * @syscap SystemCapability.WindowManager.WindowManager.Core 4128 * @systemapi Hide this for inner system use. 4129 * @since 12 4130 */ 4131 setWindowMode(mode: WindowMode): Promise<void>; 4132 4133 /** 4134 * Set the mode of a window. 4135 * 4136 * @param { WindowMode } mode - Indicate the mode of a window. 4137 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4138 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4139 * 2. Incorrect parameter types; 4140 * 3. Parameter verification failed. 4141 * @throws { BusinessError } 1300002 - This window state is abnormal. 4142 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4143 * @syscap SystemCapability.WindowManager.WindowManager.Core 4144 * @systemapi Hide this for inner system use. 4145 * @since 9 4146 */ 4147 /** 4148 * Set the mode of a window. 4149 * 4150 * @param { WindowMode } mode - Indicate the mode of a window. 4151 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4152 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 4153 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4154 * 2. Incorrect parameter types; 4155 * 3. Parameter verification failed. 4156 * @throws { BusinessError } 1300002 - This window state is abnormal. 4157 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4158 * @syscap SystemCapability.WindowManager.WindowManager.Core 4159 * @systemapi Hide this for inner system use. 4160 * @since 12 4161 */ 4162 setWindowMode(mode: WindowMode, callback: AsyncCallback<void>): void; 4163 4164 /** 4165 * Get the properties of current window 4166 * 4167 * @param { AsyncCallback<WindowProperties> } callback - Callback used to return the window properties. 4168 * @syscap SystemCapability.WindowManager.WindowManager.Core 4169 * @since 6 4170 * @deprecated since 9 4171 * @useinstead ohos.window.Window#getWindowProperties 4172 */ 4173 getProperties(callback: AsyncCallback<WindowProperties>): void; 4174 4175 /** 4176 * Get the window rectangular area quadruple {left,top,weight,height}, left and top represent relative to screen coordinates 4177 * and are affected by parent window scaling, weight and height are the scaling width and height. 4178 * 4179 * @returns { Rect } The quadruple {left,top,weight,height} represents respectively the X-coordinate 4180 * and Y-coordinate of the window relative to current screen, the scaled window width and scaled window height. 4181 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 4182 * @throws { BusinessError } 1300002 - This window state is abnormal. 4183 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4184 * @syscap SystemCapability.Window.SessionManager 4185 * @atomicservice 4186 * @since 13 4187 */ 4188 getGlobalRect(): Rect; 4189 4190 /** 4191 * Get the properties of current window 4192 * 4193 * @returns { Promise<WindowProperties> } Promise used to return the window properties. 4194 * @syscap SystemCapability.WindowManager.WindowManager.Core 4195 * @since 6 4196 * @deprecated since 9 4197 * @useinstead ohos.window.Window#getWindowProperties 4198 */ 4199 getProperties(): Promise<WindowProperties>; 4200 4201 /** 4202 * Get the properties of current window 4203 * 4204 * @returns { WindowProperties } Return the window properties. 4205 * @throws { BusinessError } 1300002 - This window state is abnormal. 4206 * @syscap SystemCapability.WindowManager.WindowManager.Core 4207 * @since 9 4208 */ 4209 /** 4210 * Get the properties of current window 4211 * 4212 * @returns { WindowProperties } Return the window properties. 4213 * @throws { BusinessError } 1300002 - This window state is abnormal. 4214 * @syscap SystemCapability.WindowManager.WindowManager.Core 4215 * @crossplatform 4216 * @since 10 4217 */ 4218 /** 4219 * Get the properties of current window 4220 * 4221 * @returns { WindowProperties } Return the window properties. 4222 * @throws { BusinessError } 1300002 - This window state is abnormal. 4223 * @syscap SystemCapability.WindowManager.WindowManager.Core 4224 * @crossplatform 4225 * @atomicservice 4226 * @since 11 4227 */ 4228 getWindowProperties(): WindowProperties; 4229 4230 /** 4231 * Get the avoid area 4232 * 4233 * @param { AvoidAreaType } type - Type of the area 4234 * @param { AsyncCallback<AvoidArea> } callback - Callback used to return the area. 4235 * @syscap SystemCapability.WindowManager.WindowManager.Core 4236 * @since 7 4237 * @deprecated since 9 4238 * @useinstead ohos.window.Window#getWindowAvoidArea 4239 */ 4240 getAvoidArea(type: AvoidAreaType, callback: AsyncCallback<AvoidArea>): void; 4241 4242 /** 4243 * Get the avoid area 4244 * 4245 * @param { AvoidAreaType } type - Type of the area 4246 * @returns { Promise<AvoidArea> } Area where the window cannot be displayed. 4247 * @syscap SystemCapability.WindowManager.WindowManager.Core 4248 * @since 7 4249 * @deprecated since 9 4250 * @useinstead ohos.window.Window#getWindowAvoidArea 4251 */ 4252 getAvoidArea(type: AvoidAreaType): Promise<AvoidArea>; 4253 4254 /** 4255 * Get the avoid area 4256 * 4257 * @param { AvoidAreaType } type - Type of the area 4258 * @returns { AvoidArea } Area where the window cannot be displayed. 4259 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4260 * 2. Incorrect parameter types; 4261 * 3. Parameter verification failed. 4262 * @throws { BusinessError } 1300002 - This window state is abnormal. 4263 * @syscap SystemCapability.WindowManager.WindowManager.Core 4264 * @since 9 4265 */ 4266 /** 4267 * Get the avoid area 4268 * 4269 * @param { AvoidAreaType } type - Type of the area 4270 * @returns { AvoidArea } Area where the window cannot be displayed. 4271 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4272 * 2. Incorrect parameter types; 4273 * 3. Parameter verification failed. 4274 * @throws { BusinessError } 1300002 - This window state is abnormal. 4275 * @syscap SystemCapability.WindowManager.WindowManager.Core 4276 * @atomicservice 4277 * @since 11 4278 */ 4279 /** 4280 * Get the avoid area 4281 * 4282 * @param { AvoidAreaType } type - Type of the area 4283 * @returns { AvoidArea } Area where the window cannot be displayed. 4284 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4285 * 2. Incorrect parameter types; 4286 * 3. Parameter verification failed. 4287 * @throws { BusinessError } 1300002 - This window state is abnormal. 4288 * @syscap SystemCapability.WindowManager.WindowManager.Core 4289 * @crossplatform 4290 * @atomicservice 4291 * @since 12 4292 */ 4293 getWindowAvoidArea(type: AvoidAreaType): AvoidArea; 4294 4295 /** 4296 * Set the flag of the window is shown full screen 4297 * 4298 * @param { boolean } isFullScreen - The flag of the window is shown full screen 4299 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4300 * @syscap SystemCapability.WindowManager.WindowManager.Core 4301 * @since 6 4302 * @deprecated since 9 4303 * @useinstead ohos.window.Window#setWindowSystemBarEnable 4304 */ 4305 setFullScreen(isFullScreen: boolean, callback: AsyncCallback<void>): void; 4306 4307 /** 4308 * Set the flag of the window is shown full screen 4309 * 4310 * @param { boolean } isFullScreen - The flag of the window is shown full screen 4311 * @returns { Promise<void> } Promise that returns no value. 4312 * @syscap SystemCapability.WindowManager.WindowManager.Core 4313 * @since 6 4314 * @deprecated since 9 4315 * @useinstead ohos.window.Window#setWindowSystemBarEnable 4316 */ 4317 setFullScreen(isFullScreen: boolean): Promise<void>; 4318 4319 /** 4320 * Set the property of the window can layout in full screen 4321 * 4322 * @param { boolean } isLayoutFullScreen - The window can layout in full screen 4323 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4324 * @syscap SystemCapability.WindowManager.WindowManager.Core 4325 * @since 7 4326 * @deprecated since 9 4327 * @useinstead ohos.window.Window#setWindowLayoutFullScreen 4328 */ 4329 setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback<void>): void; 4330 4331 /** 4332 * Set the property of the window can layout in full screen 4333 * 4334 * @param { boolean } isLayoutFullScreen - The window can layout in full screen 4335 * @returns { Promise<void> } Promise that returns no value. 4336 * @syscap SystemCapability.WindowManager.WindowManager.Core 4337 * @since 7 4338 * @deprecated since 9 4339 * @useinstead ohos.window.Window#setWindowLayoutFullScreen 4340 */ 4341 setLayoutFullScreen(isLayoutFullScreen: boolean): Promise<void>; 4342 4343 /** 4344 * Set the property of the window can layout in full screen 4345 * 4346 * @param { boolean } isLayoutFullScreen - The window can layout in full screen 4347 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4348 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4349 * 2. Incorrect parameter types. 4350 * @throws { BusinessError } 1300002 - This window state is abnormal. 4351 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4352 * @syscap SystemCapability.WindowManager.WindowManager.Core 4353 * @since 9 4354 */ 4355 /** 4356 * Set the property of the window can layout in full screen 4357 * 4358 * @param { boolean } isLayoutFullScreen - The window can layout in full screen 4359 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4360 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4361 * 2. Incorrect parameter types. 4362 * @throws { BusinessError } 1300002 - This window state is abnormal. 4363 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4364 * @syscap SystemCapability.WindowManager.WindowManager.Core 4365 * @crossplatform 4366 * @atomicservice 4367 * @since 12 4368 * @deprecated since 12 4369 * @useinstead ohos.window.Window#setWindowLayoutFullScreen 4370 */ 4371 setWindowLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback<void>): void; 4372 4373 /** 4374 * Set the property of the window can layout in full screen 4375 * 4376 * @param { boolean } isLayoutFullScreen - The window can layout in full screen 4377 * @returns { Promise<void> } Promise that returns no value. 4378 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4379 * 2. Incorrect parameter types. 4380 * @throws { BusinessError } 1300002 - This window state is abnormal. 4381 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4382 * @syscap SystemCapability.WindowManager.WindowManager.Core 4383 * @since 9 4384 */ 4385 /** 4386 * Set the property of the window can layout in full screen 4387 * 4388 * @param { boolean } isLayoutFullScreen - The window can layout in full screen 4389 * @returns { Promise<void> } Promise that returns no value. 4390 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4391 * 2. Incorrect parameter types. 4392 * @throws { BusinessError } 1300002 - This window state is abnormal. 4393 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4394 * @syscap SystemCapability.WindowManager.WindowManager.Core 4395 * @crossplatform 4396 * @atomicservice 4397 * @since 12 4398 */ 4399 setWindowLayoutFullScreen(isLayoutFullScreen: boolean): Promise<void>; 4400 4401 /** 4402 * Set the system bar to have visible. 4403 * 4404 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4405 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4406 * @syscap SystemCapability.WindowManager.WindowManager.Core 4407 * @since 7 4408 * @deprecated since 9 4409 * @useinstead ohos.window.Window#setWindowSystemBarEnable 4410 */ 4411 setSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallback<void>): void; 4412 4413 /** 4414 * Set the system bar to have visible. 4415 * 4416 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4417 * @returns { Promise<void> } Promise that returns no value. 4418 * @syscap SystemCapability.WindowManager.WindowManager.Core 4419 * @since 7 4420 * @deprecated since 9 4421 * @useinstead ohos.window.Window#setWindowSystemBarEnable 4422 */ 4423 setSystemBarEnable(names: Array<'status' | 'navigation'>): Promise<void>; 4424 4425 /** 4426 * Set the system bar to have visible. 4427 * 4428 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4429 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4430 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4431 * 2. Incorrect parameter types. 4432 * @throws { BusinessError } 1300002 - This window state is abnormal. 4433 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4434 * @syscap SystemCapability.WindowManager.WindowManager.Core 4435 * @since 9 4436 */ 4437 /** 4438 * Set the system bar to have visible. 4439 * 4440 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4441 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4442 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4443 * 2. Incorrect parameter types. 4444 * @throws { BusinessError } 1300002 - This window state is abnormal. 4445 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4446 * @syscap SystemCapability.WindowManager.WindowManager.Core 4447 * @crossplatform 4448 * @since 10 4449 */ 4450 /** 4451 * Set the system bar to have visible. 4452 * 4453 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4454 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4455 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1.Mandatory parameters are left unspecified; 4456 * 2.Incorrect parameter types. 4457 * @throws { BusinessError } 1300002 - This window state is abnormal. 4458 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4459 * @syscap SystemCapability.WindowManager.WindowManager.Core 4460 * @crossplatform 4461 * @atomicservice 4462 * @since 12 4463 * @deprecated since 12 4464 * @useinstead ohos.window.Window#setWindowSystemBarEnable 4465 */ 4466 setWindowSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallback<void>): void; 4467 4468 /** 4469 * Set the system bar to have visible. 4470 * 4471 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4472 * @returns { Promise<void> } Promise that returns no value. 4473 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4474 * 2. Incorrect parameter types. 4475 * @throws { BusinessError } 1300002 - This window state is abnormal. 4476 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4477 * @syscap SystemCapability.WindowManager.WindowManager.Core 4478 * @since 9 4479 */ 4480 /** 4481 * Set the system bar to have visible. 4482 * 4483 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4484 * @returns { Promise<void> } Promise that returns no value. 4485 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4486 * 2. Incorrect parameter types. 4487 * @throws { BusinessError } 1300002 - This window state is abnormal. 4488 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4489 * @syscap SystemCapability.WindowManager.WindowManager.Core 4490 * @crossplatform 4491 * @since 10 4492 */ 4493 /** 4494 * Set the system bar to have visible. 4495 * 4496 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4497 * @returns { Promise<void> } Promise that returns no value. 4498 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1.Mandatory parameters are left unspecified; 4499 * 2.Incorrect parameter types. 4500 * @throws { BusinessError } 1300002 - This window state is abnormal. 4501 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4502 * @syscap SystemCapability.WindowManager.WindowManager.Core 4503 * @crossplatform 4504 * @atomicservice 4505 * @since 12 4506 */ 4507 setWindowSystemBarEnable(names: Array<'status' | 'navigation'>): Promise<void>; 4508 4509 /** 4510 * Set specific system bar to have visible. 4511 * 4512 * @param {SpecificSystemBar} name - the set of system bar 4513 * @param {boolean} enable - Show specific system bar if true, or hide specific system bar if false. 4514 * @returns { Promise<void> } Promise that returns no value. 4515 * @throws {BusinessError} 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4516 * 2. Incorrect parameter types. 4517 * @throws {BusinessError} 1300002 - This window state is abnormal. 4518 * @throws {BusinessError} 1300003 - This window manager service works abnormally. 4519 * @syscap SystemCapability.Window.SessionManager 4520 * @atomicservice 4521 * @since 11 4522 */ 4523 /** 4524 * Set specific system bar to have visible. 4525 * 4526 * @param {SpecificSystemBar} name - the set of system bar 4527 * @param {boolean} enable - Show specific system bar if true, or hide specific system bar if false. 4528 * @param {boolean} enableAnimation - Whether using animation during this setting, using animation if true or not using animation if false. 4529 * @returns { Promise<void> } Promise that returns no value. 4530 * @throws {BusinessError} 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4531 * 2. Incorrect parameter types. 4532 * @throws {BusinessError} 1300002 - This window state is abnormal. 4533 * @throws {BusinessError} 1300003 - This window manager service works abnormally. 4534 * @syscap SystemCapability.Window.SessionManager 4535 * @crossplatform 4536 * @atomicservice 4537 * @since 12 4538 */ 4539 setSpecificSystemBarEnabled(name: SpecificSystemBar, enable: boolean, enableAnimation?: boolean): Promise<void>; 4540 4541 /** 4542 * Set the properties of system bar 4543 * 4544 * @param { SystemBarProperties } systemBarProperties - The properties of system bar 4545 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4546 * @syscap SystemCapability.WindowManager.WindowManager.Core 4547 * @since 6 4548 * @deprecated since 9 4549 * @useinstead ohos.window.Window#setWindowSystemBarProperties 4550 */ 4551 setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback<void>): void; 4552 4553 /** 4554 * Set the properties of system bar 4555 * 4556 * @param { SystemBarProperties } systemBarProperties - The properties of system bar 4557 * @returns { Promise<void> } Promise that returns no value. 4558 * @syscap SystemCapability.WindowManager.WindowManager.Core 4559 * @since 6 4560 * @deprecated since 9 4561 * @useinstead ohos.window.Window#setWindowSystemBarProperties 4562 */ 4563 setSystemBarProperties(systemBarProperties: SystemBarProperties): Promise<void>; 4564 4565 /** 4566 * Set the properties of system bar 4567 * 4568 * @param { SystemBarProperties } systemBarProperties - The properties of system bar 4569 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4570 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4571 * 2. Incorrect parameter types. 4572 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 4573 * @throws { BusinessError } 1300002 - This window state is abnormal. 4574 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4575 * @syscap SystemCapability.WindowManager.WindowManager.Core 4576 * @since 9 4577 */ 4578 /** 4579 * Set the properties of system bar 4580 * 4581 * @param { SystemBarProperties } systemBarProperties - The properties of system bar 4582 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4583 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4584 * 2. Incorrect parameter types. 4585 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 4586 * @throws { BusinessError } 1300002 - This window state is abnormal. 4587 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4588 * @syscap SystemCapability.WindowManager.WindowManager.Core 4589 * @atomicservice 4590 * @since 12 4591 * @deprecated since 12 4592 * @useinstead ohos.window.Window#setWindowSystemBarProperties 4593 */ 4594 setWindowSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback<void>): void; 4595 4596 /** 4597 * Set the properties of system bar 4598 * 4599 * @param { SystemBarProperties } systemBarProperties - The properties of system bar 4600 * @returns { Promise<void> } Promise that returns no value. 4601 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4602 * 2. Incorrect parameter types. 4603 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 4604 * @throws { BusinessError } 1300002 - This window state is abnormal. 4605 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4606 * @syscap SystemCapability.WindowManager.WindowManager.Core 4607 * @since 9 4608 */ 4609 /** 4610 * Set the properties of system bar 4611 * 4612 * @param { SystemBarProperties } systemBarProperties - The properties of system bar 4613 * @returns { Promise<void> } Promise that returns no value. 4614 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4615 * 2. Incorrect parameter types. 4616 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 4617 * @throws { BusinessError } 1300002 - This window state is abnormal. 4618 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4619 * @syscap SystemCapability.WindowManager.WindowManager.Core 4620 * @atomicservice 4621 * @since 12 4622 */ 4623 setWindowSystemBarProperties(systemBarProperties: SystemBarProperties): Promise<void>; 4624 4625 /** 4626 * Get the properties of system bar 4627 * 4628 * @returns { SystemBarProperties } Return system bar properties. 4629 * @throws { BusinessError } 1300002 - This window state is abnormal. 4630 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4631 * @throws { BusinessError } 1300004 - Unauthorized operation. 4632 * @syscap SystemCapability.WindowManager.WindowManager.Core 4633 * @atomicservice 4634 * @since 12 4635 */ 4636 getWindowSystemBarProperties(): SystemBarProperties; 4637 4638 /** 4639 * Set whether to disable the gesture back function. 4640 * 4641 * @param { boolean } enabled - If true then enable the gesture back function, false then disable the gesture back function. 4642 * @returns { Promise<void> } Promise that returns no value. 4643 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4644 * 2. Incorrect parameter types. 4645 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 4646 * @throws { BusinessError } 1300002 - This window state is abnormal. 4647 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4648 * @throws { BusinessError } 1300004 - Unauthorized operation. 4649 * @syscap SystemCapability.Window.SessionManager 4650 * @atomicservice 4651 * @since 13 4652 */ 4653 setGestureBackEnabled(enabled: boolean): Promise<void>; 4654 4655 /** 4656 * Get whether the gesture back function is currently disabled. 4657 * 4658 * @returns { boolean } enabled - If true then the gesture back function is currently enabled, false then the gesture back function is currently disabled. 4659 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 4660 * @throws { BusinessError } 1300002 - This window state is abnormal. 4661 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4662 * @throws { BusinessError } 1300004 - Unauthorized operation. 4663 * @syscap SystemCapability.Window.SessionManager 4664 * @atomicservice 4665 * @since 13 4666 */ 4667 isGestureBackEnabled(): boolean; 4668 4669 /** 4670 * Set the preferred orientation config of the window 4671 * 4672 * @param { Orientation } orientation - The orientation config of the window 4673 * @returns { Promise<void> } Promise that returns no value. 4674 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4675 * 2. Incorrect parameter types; 4676 * 3. Parameter verification failed. 4677 * @throws { BusinessError } 1300002 - This window state is abnormal. 4678 * @syscap SystemCapability.WindowManager.WindowManager.Core 4679 * @since 9 4680 */ 4681 /** 4682 * Set the preferred orientation config of the window 4683 * 4684 * @param { Orientation } orientation - The orientation config of the window 4685 * @returns { Promise<void> } Promise that returns no value. 4686 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4687 * 2. Incorrect parameter types; 4688 * 3. Parameter verification failed. 4689 * @throws { BusinessError } 1300002 - This window state is abnormal. 4690 * @syscap SystemCapability.WindowManager.WindowManager.Core 4691 * @crossplatform 4692 * @since 10 4693 */ 4694 /** 4695 * Set the preferred orientation config of the window 4696 * 4697 * @param { Orientation } orientation - The orientation config of the window 4698 * @returns { Promise<void> } Promise that returns no value. 4699 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4700 * 2. Incorrect parameter types; 4701 * 3. Parameter verification failed. 4702 * @throws { BusinessError } 1300002 - This window state is abnormal. 4703 * @syscap SystemCapability.WindowManager.WindowManager.Core 4704 * @crossplatform 4705 * @atomicservice 4706 * @since 11 4707 */ 4708 setPreferredOrientation(orientation: Orientation): Promise<void>; 4709 4710 /** 4711 * Set the preferred orientation config of the window 4712 * 4713 * @param { Orientation } orientation - The orientation config of the window 4714 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4715 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4716 * 2. Incorrect parameter types; 4717 * 3. Parameter verification failed. 4718 * @throws { BusinessError } 1300002 - This window state is abnormal. 4719 * @syscap SystemCapability.WindowManager.WindowManager.Core 4720 * @since 9 4721 */ 4722 /** 4723 * Set the preferred orientation config of the window 4724 * 4725 * @param { Orientation } orientation - The orientation config of the window 4726 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4727 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4728 * 2. Incorrect parameter types; 4729 * 3. Parameter verification failed. 4730 * @throws { BusinessError } 1300002 - This window state is abnormal. 4731 * @syscap SystemCapability.WindowManager.WindowManager.Core 4732 * @crossplatform 4733 * @since 10 4734 */ 4735 /** 4736 * Set the preferred orientation config of the window 4737 * 4738 * @param { Orientation } orientation - The orientation config of the window 4739 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4740 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4741 * 2. Incorrect parameter types; 4742 * 3. Parameter verification failed. 4743 * @throws { BusinessError } 1300002 - This window state is abnormal. 4744 * @syscap SystemCapability.WindowManager.WindowManager.Core 4745 * @crossplatform 4746 * @atomicservice 4747 * @since 11 4748 */ 4749 setPreferredOrientation(orientation: Orientation, callback: AsyncCallback<void>): void; 4750 4751 /** 4752 * Get the preferred orientation config of the window 4753 * 4754 * @returns { Orientation } orientation - The orientation config of the window 4755 * @throws { BusinessError } 1300002 - This window state is abnormal. 4756 * @syscap SystemCapability.WindowManager.WindowManager.Core 4757 * @atomicservice 4758 * @since 12 4759 */ 4760 getPreferredOrientation(): Orientation; 4761 4762 /** 4763 * Loads content 4764 * 4765 * @param { string } path - Path of the page to which the content will be loaded 4766 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window 4767 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4768 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4769 * 2. Incorrect parameter types. 4770 * @throws { BusinessError } 1300002 - This window state is abnormal. 4771 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4772 * @syscap SystemCapability.WindowManager.WindowManager.Core 4773 * @StageModelOnly 4774 * @since 9 4775 */ 4776 /** 4777 * Loads content 4778 * 4779 * @param { string } path - Path of the page to which the content will be loaded 4780 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window 4781 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4782 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4783 * 2. Incorrect parameter types. 4784 * @throws { BusinessError } 1300002 - This window state is abnormal. 4785 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4786 * @syscap SystemCapability.WindowManager.WindowManager.Core 4787 * @StageModelOnly 4788 * @crossplatform 4789 * @since 10 4790 */ 4791 /** 4792 * Loads content 4793 * 4794 * @param { string } path - Path of the page to which the content will be loaded 4795 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window 4796 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4797 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4798 * 2. Incorrect parameter types. 4799 * @throws { BusinessError } 1300002 - This window state is abnormal. 4800 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4801 * @syscap SystemCapability.WindowManager.WindowManager.Core 4802 * @StageModelOnly 4803 * @crossplatform 4804 * @atomicservice 4805 * @since 11 4806 */ 4807 loadContent(path: string, storage: LocalStorage, callback: AsyncCallback<void>): void; 4808 4809 /** 4810 * Loads content 4811 * 4812 * @param { string } path - Path of the page to which the content will be loaded 4813 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window 4814 * @returns { Promise<void> } Promise that returns no value. 4815 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4816 * 2. Incorrect parameter types. 4817 * @throws { BusinessError } 1300002 - This window state is abnormal. 4818 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4819 * @syscap SystemCapability.WindowManager.WindowManager.Core 4820 * @StageModelOnly 4821 * @since 9 4822 */ 4823 /** 4824 * Loads content 4825 * 4826 * @param { string } path - Path of the page to which the content will be loaded 4827 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window 4828 * @returns { Promise<void> } Promise that returns no value. 4829 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4830 * 2. Incorrect parameter types. 4831 * @throws { BusinessError } 1300002 - This window state is abnormal. 4832 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4833 * @syscap SystemCapability.WindowManager.WindowManager.Core 4834 * @StageModelOnly 4835 * @crossplatform 4836 * @since 10 4837 */ 4838 /** 4839 * Loads content 4840 * 4841 * @param { string } path - Path of the page to which the content will be loaded 4842 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window 4843 * @returns { Promise<void> } Promise that returns no value. 4844 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4845 * 2. Incorrect parameter types. 4846 * @throws { BusinessError } 1300002 - This window state is abnormal. 4847 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4848 * @syscap SystemCapability.WindowManager.WindowManager.Core 4849 * @StageModelOnly 4850 * @crossplatform 4851 * @atomicservice 4852 * @since 11 4853 */ 4854 loadContent(path: string, storage: LocalStorage): Promise<void>; 4855 4856 /** 4857 * Loads content 4858 * 4859 * @param { string } path - Path of the page to which the content will be loaded 4860 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4861 * @syscap SystemCapability.WindowManager.WindowManager.Core 4862 * @since 7 4863 * @deprecated since 9 4864 * @useinstead ohos.window.Window#setUIContent 4865 */ 4866 loadContent(path: string, callback: AsyncCallback<void>): void; 4867 4868 /** 4869 * Loads content 4870 * 4871 * @param { string } path - Path of the page to which the content will be loaded 4872 * @returns { Promise<void> } Promise that returns no value. 4873 * @syscap SystemCapability.WindowManager.WindowManager.Core 4874 * @since 7 4875 * @deprecated since 9 4876 * @useinstead ohos.window.Window#setUIContent 4877 */ 4878 loadContent(path: string): Promise<void>; 4879 4880 /** 4881 * Get the UIContext associate with the window content. 4882 * 4883 * @returns { UIContext } the object of UIContext. 4884 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 4885 * 2. Incorrect parameter types; 4886 * 3. Parameter verification failed. 4887 * @throws { BusinessError } 1300002 - This window state is abnormal. 4888 * @syscap SystemCapability.WindowManager.WindowManager.Core 4889 * @stagemodelonly 4890 * @crossplatform 4891 * @since 10 4892 */ 4893 /** 4894 * Get the UIContext associate with the window content. 4895 * 4896 * @returns { UIContext } the object of UIContext. 4897 * @throws { BusinessError } 1300002 - This window state is abnormal. 4898 * @syscap SystemCapability.WindowManager.WindowManager.Core 4899 * @stagemodelonly 4900 * @crossplatform 4901 * @atomicservice 4902 * @since 11 4903 */ 4904 getUIContext() : UIContext; 4905 4906 /** 4907 * Loads content 4908 * 4909 * @param { string } path - Path of the page to which the content will be loaded 4910 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4911 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4912 * 2. Incorrect parameter types. 4913 * @throws { BusinessError } 1300002 - This window state is abnormal. 4914 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4915 * @syscap SystemCapability.WindowManager.WindowManager.Core 4916 * @since 9 4917 */ 4918 /** 4919 * Loads content 4920 * 4921 * @param { string } path - Path of the page to which the content will be loaded 4922 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4923 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4924 * 2. Incorrect parameter types. 4925 * @throws { BusinessError } 1300002 - This window state is abnormal. 4926 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4927 * @syscap SystemCapability.WindowManager.WindowManager.Core 4928 * @crossplatform 4929 * @since 10 4930 */ 4931 /** 4932 * Loads content 4933 * 4934 * @param { string } path - Path of the page to which the content will be loaded 4935 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4936 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4937 * 2. Incorrect parameter types. 4938 * @throws { BusinessError } 1300002 - This window state is abnormal. 4939 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4940 * @syscap SystemCapability.WindowManager.WindowManager.Core 4941 * @crossplatform 4942 * @atomicservice 4943 * @since 11 4944 */ 4945 setUIContent(path: string, callback: AsyncCallback<void>): void; 4946 4947 /** 4948 * Loads content 4949 * 4950 * @param { string } path - Path of the page to which the content will be loaded 4951 * @returns { Promise<void> } Promise that returns no value. 4952 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4953 * 2. Incorrect parameter types. 4954 * @throws { BusinessError } 1300002 - This window state is abnormal. 4955 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4956 * @syscap SystemCapability.WindowManager.WindowManager.Core 4957 * @since 9 4958 */ 4959 /** 4960 * Loads content 4961 * 4962 * @param { string } path - Path of the page to which the content will be loaded 4963 * @returns { Promise<void> } Promise that returns no value. 4964 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4965 * 2. Incorrect parameter types. 4966 * @throws { BusinessError } 1300002 - This window state is abnormal. 4967 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4968 * @syscap SystemCapability.WindowManager.WindowManager.Core 4969 * @crossplatform 4970 * @since 10 4971 */ 4972 /** 4973 * Loads content 4974 * 4975 * @param { string } path - Path of the page to which the content will be loaded 4976 * @returns { Promise<void> } Promise that returns no value. 4977 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4978 * 2. Incorrect parameter types. 4979 * @throws { BusinessError } 1300002 - This window state is abnormal. 4980 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4981 * @syscap SystemCapability.WindowManager.WindowManager.Core 4982 * @crossplatform 4983 * @atomicservice 4984 * @since 11 4985 */ 4986 setUIContent(path: string): Promise<void>; 4987 4988 /** 4989 * Loads content by named router 4990 * 4991 * @param { string } name - name of the page to which the content will be loaded. 4992 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window. 4993 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4994 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4995 * 2. Incorrect parameter types. 4996 * @throws { BusinessError } 1300002 - This window state is abnormal. 4997 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4998 * @syscap SystemCapability.WindowManager.WindowManager.Core 4999 * @stagemodelonly 5000 * @crossplatform 5001 * @atomicservice 5002 * @since 11 5003 */ 5004 loadContentByName(name: string, storage: LocalStorage, callback: AsyncCallback<void>): void; 5005 5006 /** 5007 * Loads content by named router 5008 * 5009 * @param { string } name - name of the page to which the content will be loaded. 5010 * @param { AsyncCallback<void> } callback - Callback used to return the result. 5011 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5012 * 2. Incorrect parameter types. 5013 * @throws { BusinessError } 1300002 - This window state is abnormal. 5014 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5015 * @syscap SystemCapability.WindowManager.WindowManager.Core 5016 * @stagemodelonly 5017 * @crossplatform 5018 * @atomicservice 5019 * @since 11 5020 */ 5021 loadContentByName(name: string, callback: AsyncCallback<void>): void; 5022 5023 /** 5024 * Loads content by named router 5025 * 5026 * @param { string } name - name of the page to which the content will be loaded. 5027 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window. 5028 * @returns { Promise<void> } Promise that returns no value. 5029 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5030 * 2. Incorrect parameter types. 5031 * @throws { BusinessError } 1300002 - This window state is abnormal. 5032 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5033 * @syscap SystemCapability.WindowManager.WindowManager.Core 5034 * @stagemodelonly 5035 * @crossplatform 5036 * @atomicservice 5037 * @since 11 5038 */ 5039 loadContentByName(name: string, storage?: LocalStorage): Promise<void>; 5040 5041 /** 5042 * Checks whether the window is displayed 5043 * 5044 * @param { AsyncCallback<boolean> } callback - Callback used to return the result. 5045 * @syscap SystemCapability.WindowManager.WindowManager.Core 5046 * @since 7 5047 * @deprecated since 9 5048 * @useinstead ohos.window.Window#isWindowShowing 5049 */ 5050 isShowing(callback: AsyncCallback<boolean>): void; 5051 5052 /** 5053 * Checks whether the window is displayed 5054 * 5055 * @returns { Promise<boolean> } Whether the window is displayed. The value true means that the window is displayed, and false means the opposite. 5056 * @syscap SystemCapability.WindowManager.WindowManager.Core 5057 * @since 7 5058 * @deprecated since 9 5059 * @useinstead ohos.window.Window#isWindowShowing 5060 */ 5061 isShowing(): Promise<boolean>; 5062 5063 /** 5064 * Checks whether the window is displayed 5065 * 5066 * @returns { boolean } Whether the window is displayed. The value true means that the window is displayed, and false means the opposite. 5067 * @throws { BusinessError } 1300002 - This window state is abnormal. 5068 * @syscap SystemCapability.WindowManager.WindowManager.Core 5069 * @since 9 5070 */ 5071 /** 5072 * Checks whether the window is displayed 5073 * 5074 * @returns { boolean } Whether the window is displayed. The value true means that the window is displayed, and false means the opposite. 5075 * @throws { BusinessError } 1300002 - This window state is abnormal. 5076 * @syscap SystemCapability.WindowManager.WindowManager.Core 5077 * @crossplatform 5078 * @since 10 5079 */ 5080 /** 5081 * Checks whether the window is displayed 5082 * 5083 * @returns { boolean } Whether the window is displayed. The value true means that the window is displayed, and false means the opposite. 5084 * @throws { BusinessError } 1300002 - This window state is abnormal. 5085 * @syscap SystemCapability.WindowManager.WindowManager.Core 5086 * @crossplatform 5087 * @atomicservice 5088 * @since 11 5089 */ 5090 isWindowShowing(): boolean; 5091 5092 /** 5093 * Register the callback of windowSizeChange 5094 * 5095 * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. 5096 * @param { Callback<Size> } callback - Callback used to return the window size. 5097 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5098 * 2. Incorrect parameter types; 5099 * 3. Parameter verification failed. 5100 * @syscap SystemCapability.WindowManager.WindowManager.Core 5101 * @since 7 5102 */ 5103 /** 5104 * Register the callback of windowSizeChange 5105 * 5106 * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. 5107 * @param { Callback<Size> } callback - Callback used to return the window size. 5108 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5109 * 2. Incorrect parameter types; 5110 * 3. Parameter verification failed. 5111 * @syscap SystemCapability.WindowManager.WindowManager.Core 5112 * @atomicservice 5113 * @since 11 5114 */ 5115 /** 5116 * Register the callback of windowSizeChange 5117 * 5118 * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. 5119 * @param { Callback<Size> } callback - Callback used to return the window size. 5120 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5121 * 2. Incorrect parameter types; 5122 * 3. Parameter verification failed. 5123 * @syscap SystemCapability.WindowManager.WindowManager.Core 5124 * @crossplatform 5125 * @atomicservice 5126 * @since 12 5127 */ 5128 on(type: 'windowSizeChange', callback: Callback<Size>): void; 5129 5130 /** 5131 * Unregister the callback of windowSizeChange 5132 * 5133 * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. 5134 * @param { Callback<Size> } callback - Callback used to return the window size. 5135 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5136 * 2. Parameter verification failed. 5137 * @syscap SystemCapability.WindowManager.WindowManager.Core 5138 * @since 7 5139 */ 5140 /** 5141 * Unregister the callback of windowSizeChange 5142 * 5143 * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. 5144 * @param { Callback<Size> } callback - Callback used to return the window size. 5145 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5146 * 2. Parameter verification failed. 5147 * @syscap SystemCapability.WindowManager.WindowManager.Core 5148 * @atomicservice 5149 * @since 11 5150 */ 5151 /** 5152 * Unregister the callback of windowSizeChange 5153 * 5154 * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. 5155 * @param { Callback<Size> } callback - Callback used to return the window size. 5156 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5157 * 2. Parameter verification failed. 5158 * @syscap SystemCapability.WindowManager.WindowManager.Core 5159 * @crossplatform 5160 * @atomicservice 5161 * @since 12 5162 */ 5163 off(type: 'windowSizeChange', callback?: Callback<Size>): void; 5164 5165 /** 5166 * Register the callback of systemAvoidAreaChange 5167 * 5168 * @param { 'systemAvoidAreaChange' } type - The value is fixed at 'systemAvoidAreaChange', indicating the event of changes to the avoid area. 5169 * @param { Callback<AvoidArea> } callback - Callback used to return the area. 5170 * @syscap SystemCapability.WindowManager.WindowManager.Core 5171 * @since 7 5172 * @deprecated since 9 5173 * @useinstead ohos.window.Window#on_avoidAreaChange 5174 */ 5175 on(type: 'systemAvoidAreaChange', callback: Callback<AvoidArea>): void; 5176 5177 /** 5178 * Unregister the callback of systemAvoidAreaChange 5179 * 5180 * @param { 'systemAvoidAreaChange' } type - The value is fixed at 'systemAvoidAreaChange', indicating the event of changes to the avoid area. 5181 * @param { Callback<AvoidArea> } callback - Callback used to return the area. 5182 * @syscap SystemCapability.WindowManager.WindowManager.Core 5183 * @since 7 5184 * @deprecated since 9 5185 * @useinstead ohos.window.Window#off_avoidAreaChange 5186 */ 5187 off(type: 'systemAvoidAreaChange', callback?: Callback<AvoidArea>): void; 5188 5189 /** 5190 * Register the callback of avoidAreaChange 5191 * 5192 * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. 5193 * @param { Callback<{ type: AvoidAreaType, area: AvoidArea }> } callback - Callback used to return the area. 5194 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 5195 * 2. Incorrect parameter types; 5196 * 3. Parameter verification failed. 5197 * @syscap SystemCapability.WindowManager.WindowManager.Core 5198 * @since 9 5199 */ 5200 /** 5201 * Register the callback of avoidAreaChange 5202 * 5203 * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. 5204 * @param { Callback<{ type: AvoidAreaType, area: AvoidArea }> } callback - Callback used to return the area. 5205 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 5206 * 2. Incorrect parameter types; 5207 * 3. Parameter verification failed. 5208 * @syscap SystemCapability.WindowManager.WindowManager.Core 5209 * @atomicservice 5210 * @since 11 5211 */ 5212 /** 5213 * Register the callback of avoidAreaChange 5214 * 5215 * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. 5216 * @param { Callback<AvoidAreaOptions> } callback - Callback used to return the area. 5217 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 5218 * 2. Incorrect parameter types; 5219 * 3. Parameter verification failed. 5220 * @syscap SystemCapability.WindowManager.WindowManager.Core 5221 * @atomicservice 5222 * @since 12 5223 */ 5224 on(type: 'avoidAreaChange', callback: Callback<AvoidAreaOptions>): void; 5225 5226 /** 5227 * Unregister the callback of avoidAreaChange 5228 * 5229 * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. 5230 * @param { Callback<{ type: AvoidAreaType, area: AvoidArea }> } callback - Callback used to return the area. 5231 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 5232 * 2. Parameter verification failed. 5233 * @syscap SystemCapability.WindowManager.WindowManager.Core 5234 * @since 9 5235 */ 5236 /** 5237 * Unregister the callback of avoidAreaChange 5238 * 5239 * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. 5240 * @param { Callback<{ type: AvoidAreaType, area: AvoidArea }> } callback - Callback used to return the area. 5241 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 5242 * 2. Parameter verification failed. 5243 * @syscap SystemCapability.WindowManager.WindowManager.Core 5244 * @atomicservice 5245 * @since 11 5246 */ 5247 /** 5248 * Unregister the callback of avoidAreaChange 5249 * 5250 * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. 5251 * @param { Callback<AvoidAreaOptions> } callback - Callback used to return the area. 5252 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 5253 * 2. Parameter verification failed. 5254 * @syscap SystemCapability.WindowManager.WindowManager.Core 5255 * @atomicservice 5256 * @since 12 5257 */ 5258 off(type: 'avoidAreaChange', callback?: Callback<AvoidAreaOptions>): void; 5259 5260 /** 5261 * Register the callback of keyboardHeightChange 5262 * 5263 * @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event. 5264 * @param { Callback<number> } callback - Callback used to return the current keyboard height. 5265 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5266 * 2. Incorrect parameter types; 5267 * 3. Parameter verification failed. 5268 * @syscap SystemCapability.WindowManager.WindowManager.Core 5269 * @since 7 5270 */ 5271 /** 5272 * Register the callback of keyboardHeightChange 5273 * 5274 * @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event. 5275 * @param { Callback<number> } callback - Callback used to return the current keyboard height. 5276 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5277 * 2. Incorrect parameter types; 5278 * 3. Parameter verification failed. 5279 * @syscap SystemCapability.WindowManager.WindowManager.Core 5280 * @atomicservice 5281 * @since 12 5282 */ 5283 on(type: 'keyboardHeightChange', callback: Callback<number>): void; 5284 5285 /** 5286 * Unregister the callback of keyboardHeightChange 5287 * 5288 * @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event. 5289 * @param { Callback<number> } callback - Callback used to return the current keyboard height. 5290 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5291 * 2. Parameter verification failed. 5292 * @syscap SystemCapability.WindowManager.WindowManager.Core 5293 * @since 7 5294 */ 5295 /** 5296 * Unregister the callback of keyboardHeightChange 5297 * 5298 * @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event. 5299 * @param { Callback<number> } callback - Callback used to return the current keyboard height. 5300 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5301 * 2. Parameter verification failed. 5302 * @syscap SystemCapability.WindowManager.WindowManager.Core 5303 * @atomicservice 5304 * @since 12 5305 */ 5306 off(type: 'keyboardHeightChange', callback?: Callback<number>): void; 5307 5308 /** 5309 * Touch outside callback on. 5310 * 5311 * @param { 'touchOutside' } type - The value is fixed at 'touchOutside', indicating the click event outside this window. 5312 * @param { Callback<void> } callback - Callback used to return the click event outside this window. 5313 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5314 * 2. Incorrect parameter types; 5315 * 3. Parameter verification failed. 5316 * @syscap SystemCapability.WindowManager.WindowManager.Core 5317 * @atomicservice 5318 * @since 11 5319 */ 5320 on(type: 'touchOutside', callback: Callback<void>): void; 5321 5322 /** 5323 * Touch outside callback off. 5324 * 5325 * @param { 'touchOutside' } type - The value is fixed at 'touchOutside', indicating the click event outside this window. 5326 * @param { Callback<void> } callback - Callback used to return the click event outside this window. 5327 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5328 * 2. Parameter verification failed. 5329 * @syscap SystemCapability.WindowManager.WindowManager.Core 5330 * @atomicservice 5331 * @since 11 5332 */ 5333 off(type: 'touchOutside', callback?: Callback<void>): void; 5334 5335 /** 5336 * Window visibility change callback on. 5337 * 5338 * @param { 'windowVisibilityChange' } type - The value is fixed at 'windowVisibilityChange', indicating the window visibility change. 5339 * @param { Callback<boolean> } callback - Callback used to notify the window visibility change. 5340 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5341 * 2. Incorrect parameter types; 5342 * 3. Parameter verification failed. 5343 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5344 * @throws { BusinessError } 1300002 - This window state is abnormal. 5345 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5346 * @syscap SystemCapability.Window.SessionManager 5347 * @since 11 5348 */ 5349 /** 5350 * Window visibility change callback on. 5351 * 5352 * @param { 'windowVisibilityChange' } type - The value is fixed at 'windowVisibilityChange', indicating the window visibility change. 5353 * @param { Callback<boolean> } callback - Callback used to notify the window visibility change. 5354 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5355 * 2. Incorrect parameter types; 5356 * 3. Parameter verification failed. 5357 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5358 * @throws { BusinessError } 1300002 - This window state is abnormal. 5359 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5360 * @syscap SystemCapability.Window.SessionManager 5361 * @atomicservice 5362 * @since 12 5363 */ 5364 on(type: 'windowVisibilityChange', callback: Callback<boolean>): void; 5365 5366 /** 5367 * Window visibility change callback off. 5368 * 5369 * @param { 'windowVisibilityChange' } type - The value is fixed at 'windowVisibilityChange', indicating the window visibility change. 5370 * @param { Callback<boolean> } callback - Callback used to notify the window visibility change. 5371 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5372 * 2. Parameter verification failed. 5373 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5374 * @throws { BusinessError } 1300002 - This window state is abnormal. 5375 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5376 * @syscap SystemCapability.Window.SessionManager 5377 * @since 11 5378 */ 5379 /** 5380 * Window visibility change callback off. 5381 * 5382 * @param { 'windowVisibilityChange' } type - The value is fixed at 'windowVisibilityChange', indicating the window visibility change. 5383 * @param { Callback<boolean> } callback - Callback used to notify the window visibility change. 5384 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5385 * 2. Parameter verification failed. 5386 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5387 * @throws { BusinessError } 1300002 - This window state is abnormal. 5388 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5389 * @syscap SystemCapability.Window.SessionManager 5390 * @atomicservice 5391 * @since 12 5392 */ 5393 off(type: 'windowVisibilityChange', callback?: Callback<boolean>): void; 5394 5395 /** 5396 * Register the callback function that has no interaction for a long time. 5397 * 5398 * @param { 'noInteractionDetected' } type - The value is fixed at 'noInteractionDetected', indicating the window has no interaction for a long time. 5399 * @param { number } timeout - The timeout(in seconds) of no interaction detection. 5400 * @param { Callback<void> } callback - Callback used to notify the window has no interaction for a long time. 5401 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5402 * 2. Incorrect parameter types; 5403 * 3. Parameter verification failed. 5404 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5405 * @throws { BusinessError } 1300002 - This window state is abnormal. 5406 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5407 * @syscap SystemCapability.Window.SessionManager 5408 * @atomicservice 5409 * @since 12 5410 */ 5411 on(type: 'noInteractionDetected', timeout: number, callback: Callback<void>): void; 5412 5413 /** 5414 * Unregister the callback function that has no interaction for a long time. 5415 * 5416 * @param { 'noInteractionDetected' } type - The value is fixed at 'noInteractionDetected', indicating the window has no interaction for a long time. 5417 * @param { Callback<void> } callback - Callback used to notify the window has no interaction for a long time. 5418 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5419 * 2. Parameter verification failed. 5420 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5421 * @throws { BusinessError } 1300002 - This window state is abnormal. 5422 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5423 * @syscap SystemCapability.Window.SessionManager 5424 * @atomicservice 5425 * @since 12 5426 */ 5427 off(type: 'noInteractionDetected', callback?: Callback<void>): void; 5428 5429 /** 5430 * Register the callback of screenshot, only the focused window called back 5431 * 5432 * @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event. 5433 * @param { Callback<void> } callback - Callback invoked when a screenshot event occurs. 5434 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5435 * 2. Incorrect parameter types; 5436 * 3. Parameter verification failed. 5437 * @syscap SystemCapability.WindowManager.WindowManager.Core 5438 * @since 9 5439 */ 5440 /** 5441 * Register the callback of screenshot, only the focused window called back 5442 * 5443 * @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event. 5444 * @param { Callback<void> } callback - Callback invoked when a screenshot event occurs. 5445 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5446 * 2. Incorrect parameter types; 5447 * 3. Parameter verification failed. 5448 * @syscap SystemCapability.WindowManager.WindowManager.Core 5449 * @atomicservice 5450 * @since 12 5451 */ 5452 on(type: 'screenshot', callback: Callback<void>): void; 5453 5454 /** 5455 * Unregister the callback of screenshot 5456 * 5457 * @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event. 5458 * @param { Callback<void> } callback - Callback invoked when a screenshot event occurs. 5459 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5460 * 2. Parameter verification failed. 5461 * @syscap SystemCapability.WindowManager.WindowManager.Core 5462 * @since 9 5463 */ 5464 /** 5465 * Unregister the callback of screenshot 5466 * 5467 * @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event. 5468 * @param { Callback<void> } callback - Callback invoked when a screenshot event occurs. 5469 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5470 * 2. Parameter verification failed. 5471 * @syscap SystemCapability.WindowManager.WindowManager.Core 5472 * @atomicservice 5473 * @since 12 5474 */ 5475 off(type: 'screenshot', callback?: Callback<void>): void; 5476 5477 /** 5478 * Register the callback of dialogTargetTouch 5479 * 5480 * @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch', indicating the click event of the target window in the modal window mode. 5481 * @param { Callback<void> } callback - Callback invoked when the click event occurs in the target window of the modal window mode. 5482 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5483 * 2. Incorrect parameter types; 5484 * 3. Parameter verification failed. 5485 * @syscap SystemCapability.WindowManager.WindowManager.Core 5486 * @since 10 5487 */ 5488 /** 5489 * Register the callback of dialogTargetTouch 5490 * 5491 * @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch', indicating the click event of the target window in the modal window mode. 5492 * @param { Callback<void> } callback - Callback invoked when the click event occurs in the target window of the modal window mode. 5493 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5494 * 2. Incorrect parameter types; 5495 * 3. Parameter verification failed. 5496 * @syscap SystemCapability.WindowManager.WindowManager.Core 5497 * @atomicservice 5498 * @since 12 5499 */ 5500 on(type: 'dialogTargetTouch', callback: Callback<void>): void; 5501 5502 /** 5503 * Unregister the callback of dialogTargetTouch 5504 * 5505 * @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch', 5506 * indicating the click event of the target window in the modal window mode. 5507 * @param { Callback<void> } callback - Callback invoked when the click event occurs in the target window of the modal window mode. 5508 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5509 * 2. Parameter verification failed. 5510 * @syscap SystemCapability.WindowManager.WindowManager.Core 5511 * @since 10 5512 */ 5513 /** 5514 * Unregister the callback of dialogTargetTouch 5515 * 5516 * @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch', 5517 * indicating the click event of the target window in the modal window mode. 5518 * @param { Callback<void> } callback - Callback invoked when the click event occurs in the target window of the modal window mode. 5519 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5520 * 2. Parameter verification failed. 5521 * @syscap SystemCapability.WindowManager.WindowManager.Core 5522 * @atomicservice 5523 * @since 12 5524 */ 5525 off(type: 'dialogTargetTouch', callback?: Callback<void>): void; 5526 5527 /** 5528 * Register the callback of windowEvent 5529 * 5530 * @param { 'windowEvent' } type - The value is fixed at 'windowEvent', indicating the window lifecycle change event. 5531 * @param { Callback<WindowEventType> } callback - the callback of window event 5532 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5533 * 2. Incorrect parameter types; 5534 * 3. Parameter verification failed. 5535 * @syscap SystemCapability.WindowManager.WindowManager.Core 5536 * @since 10 5537 */ 5538 /** 5539 * Register the callback of windowEvent 5540 * 5541 * @param { 'windowEvent' } type - The value is fixed at 'windowEvent', indicating the window lifecycle change event. 5542 * @param { Callback<WindowEventType> } callback - the callback of window event 5543 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5544 * 2. Incorrect parameter types; 5545 * 3. Parameter verification failed. 5546 * @syscap SystemCapability.WindowManager.WindowManager.Core 5547 * @crossplatform 5548 * @atomicservice 5549 * @since 11 5550 */ 5551 on(type: 'windowEvent', callback: Callback<WindowEventType>): void; 5552 5553 /** 5554 * Unregister the callback of windowEvent 5555 * 5556 * @param { 'windowEvent' } type - The value is fixed at 'windowEvent', indicating the window lifecycle change event. 5557 * @param { Callback<WindowEventType> } callback - the callback of window event 5558 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5559 * 2. Parameter verification failed. 5560 * @syscap SystemCapability.WindowManager.WindowManager.Core 5561 * @since 10 5562 */ 5563 /** 5564 * Unregister the callback of windowEvent 5565 * 5566 * @param { 'windowEvent' } type - The value is fixed at 'windowEvent', indicating the window lifecycle change event. 5567 * @param { Callback<WindowEventType> } callback - the callback of window event 5568 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5569 * 2. Parameter verification failed. 5570 * @syscap SystemCapability.WindowManager.WindowManager.Core 5571 * @crossplatform 5572 * @atomicservice 5573 * @since 11 5574 */ 5575 off(type: 'windowEvent', callback?: Callback<WindowEventType>): void; 5576 5577 /** 5578 * Register the callback of windowStatusChange 5579 * 5580 * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. 5581 * @param { Callback<WindowStatusType> } callback - Callback used to return the window status. 5582 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5583 * 2. Incorrect parameter types; 5584 * 3. Parameter verification failed. 5585 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5586 * @syscap SystemCapability.Window.SessionManager 5587 * @since 11 5588 */ 5589 /** 5590 * Register the callback of windowStatusChange 5591 * 5592 * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. 5593 * @param { Callback<WindowStatusType> } callback - Callback used to return the window status. 5594 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5595 * 2. Incorrect parameter types; 5596 * 3. Parameter verification failed. 5597 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5598 * @syscap SystemCapability.Window.SessionManager 5599 * @atomicservice 5600 * @since 12 5601 */ 5602 on(type: 'windowStatusChange', callback: Callback<WindowStatusType>): void; 5603 5604 /** 5605 * Unregister the callback of windowStatusChange 5606 * 5607 * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. 5608 * @param { Callback<WindowStatusType> } callback - Callback used to return the window status. 5609 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5610 * 2. Parameter verification failed. 5611 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5612 * @syscap SystemCapability.Window.SessionManager 5613 * @since 11 5614 */ 5615 /** 5616 * Unregister the callback of windowStatusChange 5617 * 5618 * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. 5619 * @param { Callback<WindowStatusType> } callback - Callback used to return the window status. 5620 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5621 * 2. Parameter verification failed. 5622 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5623 * @syscap SystemCapability.Window.SessionManager 5624 * @atomicservice 5625 * @since 12 5626 */ 5627 off(type: 'windowStatusChange', callback?: Callback<WindowStatusType>): void; 5628 5629 /** 5630 * Register the callback of subWindowClose 5631 * 5632 * @param { 'subWindowClose' } type - The value is fixed at 'subWindowClose', indicating the subwindow close event. 5633 * @param { Callback<void> } callback - Callback used to return whether to terminate the subwindow close process. 5634 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5635 * 2. Parameter verification failed. 5636 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5637 * @throws { BusinessError } 1300002 - This window state is abnormal. 5638 * @throws { BusinessError } 1300004 - Unauthorized operation. 5639 * @syscap SystemCapability.Window.SessionManager 5640 * @atomicservice 5641 * @since 12 5642 */ 5643 on(type: 'subWindowClose', callback: Callback<void>): void; 5644 5645 /** 5646 * Unregister the callback of subWindowClose 5647 * 5648 * @param { 'subWindowClose' } type - The value is fixed at 'subWindowClose', indicating the subwindow close event. 5649 * @param { Callback<void> } callback - Callback used to return whether to terminate the subwindow close process. 5650 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5651 * 2. Parameter verification failed. 5652 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5653 * @throws { BusinessError } 1300002 - This window state is abnormal. 5654 * @throws { BusinessError } 1300004 - Unauthorized operation. 5655 * @syscap SystemCapability.Window.SessionManager 5656 * @atomicservice 5657 * @since 12 5658 */ 5659 off(type: 'subWindowClose', callback?: Callback<void>): void; 5660 5661 /** 5662 * Bind dialog to the target window. 5663 * 5664 * @param { rpc.RemoteObject } token - token of the target window. 5665 * @param { Callback<void> } deathCallback - the callback of dialogDeath. 5666 * @returns { Promise<void> } Promise that returns no value. 5667 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5668 * @throws { BusinessError } 1300002 - This window state is abnormal. 5669 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5670 * @syscap SystemCapability.WindowManager.WindowManager.Core 5671 * @systemapi Hide this for inner system use. 5672 * @since 9 5673 */ 5674 /** 5675 * Bind dialog to the target window. 5676 * 5677 * @param { rpc.RemoteObject } token - token of the target window. 5678 * @param { Callback<void> } deathCallback - the callback of dialogDeath. 5679 * @returns { Promise<void> } Promise that returns no value. 5680 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 5681 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5682 * @throws { BusinessError } 1300002 - This window state is abnormal. 5683 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5684 * @syscap SystemCapability.WindowManager.WindowManager.Core 5685 * @systemapi Hide this for inner system use. 5686 * @since 12 5687 */ 5688 bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback<void>): Promise<void>; 5689 5690 /** 5691 * Bind dialog to the target window. 5692 * 5693 * @param { rpc.RemoteObject } token token of the target window. 5694 * @param { Callback<void> } deathCallback the callback of dialogDeath. 5695 * @param { AsyncCallback<void> } callback Callback used to return the result. 5696 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5697 * @throws { BusinessError } 1300002 - This window state is abnormal. 5698 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5699 * @syscap SystemCapability.WindowManager.WindowManager.Core 5700 * @systemapi Hide this for inner system use. 5701 * @since 9 5702 */ 5703 /** 5704 * Bind dialog to the target window. 5705 * 5706 * @param { rpc.RemoteObject } token token of the target window. 5707 * @param { Callback<void> } deathCallback the callback of dialogDeath. 5708 * @param { AsyncCallback<void> } callback Callback used to return the result. 5709 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 5710 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5711 * @throws { BusinessError } 1300002 - This window state is abnormal. 5712 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5713 * @syscap SystemCapability.WindowManager.WindowManager.Core 5714 * @systemapi Hide this for inner system use. 5715 * @since 12 5716 */ 5717 bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback<void>, callback: AsyncCallback<void>): void; 5718 5719 /** 5720 * Bind dialog to the target window. 5721 * 5722 * @param { dialogRequest.RequestInfo } requestInfo requestInfo of the target window. 5723 * @param { Callback<void> } deathCallback the callback of dialogDeath. 5724 * @returns { Promise<void> } Promise that returns no value. 5725 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5726 * @throws { BusinessError } 1300002 - This window state is abnormal. 5727 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5728 * @syscap SystemCapability.WindowManager.WindowManager.Core 5729 * @systemapi Hide this for inner system use. 5730 * @since 9 5731 */ 5732 /** 5733 * Bind dialog to the target window. 5734 * 5735 * @param { dialogRequest.RequestInfo } requestInfo requestInfo of the target window. 5736 * @param { Callback<void> } deathCallback the callback of dialogDeath. 5737 * @returns { Promise<void> } Promise that returns no value. 5738 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 5739 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5740 * @throws { BusinessError } 1300002 - This window state is abnormal. 5741 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5742 * @syscap SystemCapability.WindowManager.WindowManager.Core 5743 * @systemapi Hide this for inner system use. 5744 * @since 12 5745 */ 5746 bindDialogTarget(requestInfo: dialogRequest.RequestInfo, deathCallback: Callback<void>): Promise<void>; 5747 5748 /** 5749 * Bind dialog to the target window. 5750 * 5751 * @param { dialogRequest.RequestInfo } requestInfo requestInfo of the target window. 5752 * @param { Callback<void> } deathCallback the callback of dialogDeath. 5753 * @param { AsyncCallback<void> } callback Callback used to return the result. 5754 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5755 * @throws { BusinessError } 1300002 - This window state is abnormal. 5756 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5757 * @syscap SystemCapability.WindowManager.WindowManager.Core 5758 * @systemapi Hide this for inner system use. 5759 * @since 9 5760 */ 5761 /** 5762 * Bind dialog to the target window. 5763 * 5764 * @param { dialogRequest.RequestInfo } requestInfo requestInfo of the target window. 5765 * @param { Callback<void> } deathCallback the callback of dialogDeath. 5766 * @param { AsyncCallback<void> } callback Callback used to return the result. 5767 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 5768 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5769 * @throws { BusinessError } 1300002 - This window state is abnormal. 5770 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5771 * @syscap SystemCapability.WindowManager.WindowManager.Core 5772 * @systemapi Hide this for inner system use. 5773 * @since 12 5774 */ 5775 bindDialogTarget( 5776 requestInfo: dialogRequest.RequestInfo, 5777 deathCallback: Callback<void>, 5778 callback: AsyncCallback<void> 5779 ): void; 5780 5781 /** 5782 * Set whether the dialog window responds to back gesture. 5783 * 5784 * @param { boolean } enabled - Responds to back gesture if true, or ignore back gesture if false. 5785 * @returns { Promise<void> } Promise that returns no value. 5786 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5787 * 2. Incorrect parameter types. 5788 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5789 * @throws { BusinessError } 1300002 - This window state is abnormal. 5790 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5791 * @throws { BusinessError } 1300004 - Unauthorized operation. 5792 * @syscap SystemCapability.Window.SessionManager 5793 * @atomicservice 5794 * @since 12 5795 */ 5796 setDialogBackGestureEnabled(enabled: boolean): Promise<void>; 5797 5798 /** 5799 * Whether the window supports thr wide gamut setting. 5800 * 5801 * @returns { Promise<boolean> } Promise used to return the result. The value true means that the wide-gamut color space is supported, and false means the opposite. 5802 * @syscap SystemCapability.WindowManager.WindowManager.Core 5803 * @since 8 5804 * @deprecated since 9 5805 * @useinstead ohos.window.Window#isWindowSupportWideGamut 5806 */ 5807 isSupportWideGamut(): Promise<boolean>; 5808 5809 /** 5810 * Whether the window supports thr wide gamut setting. 5811 * 5812 * @param { AsyncCallback<boolean> } callback Callback used to return the result. 5813 * @syscap SystemCapability.WindowManager.WindowManager.Core 5814 * @since 8 5815 * @deprecated since 9 5816 * @useinstead ohos.window.Window#isWindowSupportWideGamut 5817 */ 5818 isSupportWideGamut(callback: AsyncCallback<boolean>): void; 5819 5820 /** 5821 * Whether the window supports thr wide gamut setting. 5822 * 5823 * @returns { Promise<boolean> } Promise used to return the result. 5824 * The value true means that the wide-gamut color space is supported, and false means the opposite. 5825 * @throws { BusinessError } 1300002 - This window state is abnormal. 5826 * @syscap SystemCapability.WindowManager.WindowManager.Core 5827 * @since 9 5828 */ 5829 /** 5830 * Whether the window supports thr wide gamut setting. 5831 * 5832 * @returns { Promise<boolean> } Promise used to return the result. 5833 * The value true means that the wide-gamut color space is supported, and false means the opposite. 5834 * @throws { BusinessError } 1300002 - This window state is abnormal. 5835 * @syscap SystemCapability.WindowManager.WindowManager.Core 5836 * @atomicservice 5837 * @since 12 5838 */ 5839 isWindowSupportWideGamut(): Promise<boolean>; 5840 5841 /** 5842 * Whether the window supports thr wide gamut setting. 5843 * 5844 * @param { AsyncCallback<boolean> } callback Callback used to return the result. 5845 * @throws { BusinessError } 1300002 - This window state is abnormal. 5846 * @syscap SystemCapability.WindowManager.WindowManager.Core 5847 * @since 9 5848 */ 5849 /** 5850 * Whether the window supports thr wide gamut setting. 5851 * 5852 * @param { AsyncCallback<boolean> } callback Callback used to return the result. 5853 * @throws { BusinessError } 1300002 - This window state is abnormal. 5854 * @syscap SystemCapability.WindowManager.WindowManager.Core 5855 * @atomicservice 5856 * @since 12 5857 */ 5858 isWindowSupportWideGamut(callback: AsyncCallback<boolean>): void; 5859 5860 /** 5861 * Sets the specified color space. 5862 * 5863 * @param { ColorSpace } colorSpace the specified color space. 5864 * @returns { Promise<void> } Promise that returns no value. 5865 * @syscap SystemCapability.WindowManager.WindowManager.Core 5866 * @since 8 5867 * @deprecated since 9 5868 * @useinstead ohos.window.Window#setWindowColorSpace 5869 */ 5870 setColorSpace(colorSpace: ColorSpace): Promise<void>; 5871 5872 /** 5873 * Sets the specified color space. 5874 * 5875 * @param { ColorSpace } colorSpace the specified color space. 5876 * @param { AsyncCallback<void> } callback Callback used to return the result. 5877 * @syscap SystemCapability.WindowManager.WindowManager.Core 5878 * @since 8 5879 * @deprecated since 9 5880 * @useinstead ohos.window.Window#setWindowColorSpace 5881 */ 5882 setColorSpace(colorSpace: ColorSpace, callback: AsyncCallback<void>): void; 5883 5884 /** 5885 * Sets the specified color space. 5886 * 5887 * @param { ColorSpace } colorSpace the specified color space. 5888 * @returns { Promise<void> } Promise that returns no value. 5889 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5890 * 2. Incorrect parameter types; 5891 * 3. Parameter verification failed. 5892 * @throws { BusinessError } 1300002 - This window state is abnormal. 5893 * @syscap SystemCapability.WindowManager.WindowManager.Core 5894 * @since 9 5895 */ 5896 /** 5897 * Sets the specified color space. 5898 * 5899 * @param { ColorSpace } colorSpace the specified color space. 5900 * @returns { Promise<void> } Promise that returns no value. 5901 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5902 * 2. Incorrect parameter types; 5903 * 3. Parameter verification failed. 5904 * @throws { BusinessError } 1300002 - This window state is abnormal. 5905 * @syscap SystemCapability.WindowManager.WindowManager.Core 5906 * @crossplatform 5907 * @since 11 5908 */ 5909 /** 5910 * Sets the specified color space. 5911 * 5912 * @param { ColorSpace } colorSpace the specified color space. 5913 * @returns { Promise<void> } Promise that returns no value. 5914 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5915 * 2. Incorrect parameter types; 5916 * 3. Parameter verification failed. 5917 * @throws { BusinessError } 1300002 - This window state is abnormal. 5918 * @syscap SystemCapability.WindowManager.WindowManager.Core 5919 * @crossplatform 5920 * @atomicservice 5921 * @since 12 5922 */ 5923 setWindowColorSpace(colorSpace: ColorSpace): Promise<void>; 5924 5925 /** 5926 * Sets the specified color space. 5927 * 5928 * @param { ColorSpace } colorSpace the specified color space. 5929 * @param { AsyncCallback<void> } callback Callback used to return the result. 5930 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5931 * 2. Incorrect parameter types; 5932 * 3. Parameter verification failed. 5933 * @throws { BusinessError } 1300002 - This window state is abnormal. 5934 * @syscap SystemCapability.WindowManager.WindowManager.Core 5935 * @since 9 5936 */ 5937 /** 5938 * Sets the specified color space. 5939 * 5940 * @param { ColorSpace } colorSpace the specified color space. 5941 * @param { AsyncCallback<void> } callback Callback used to return the result. 5942 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5943 * 2. Incorrect parameter types; 5944 * 3. Parameter verification failed. 5945 * @throws { BusinessError } 1300002 - This window state is abnormal. 5946 * @syscap SystemCapability.WindowManager.WindowManager.Core 5947 * @crossplatform 5948 * @since 11 5949 */ 5950 /** 5951 * Sets the specified color space. 5952 * 5953 * @param { ColorSpace } colorSpace the specified color space. 5954 * @param { AsyncCallback<void> } callback Callback used to return the result. 5955 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5956 * 2. Incorrect parameter types; 5957 * 3. Parameter verification failed. 5958 * @throws { BusinessError } 1300002 - This window state is abnormal. 5959 * @syscap SystemCapability.WindowManager.WindowManager.Core 5960 * @crossplatform 5961 * @atomicservice 5962 * @since 12 5963 */ 5964 setWindowColorSpace(colorSpace: ColorSpace, callback: AsyncCallback<void>): void; 5965 5966 /** 5967 * Obtains the set color space. 5968 * 5969 * @returns { Promise<ColorSpace> } Promise used to return the current color space. 5970 * @syscap SystemCapability.WindowManager.WindowManager.Core 5971 * @since 8 5972 * @deprecated since 9 5973 * @useinstead ohos.window.Window#getWindowColorSpace 5974 */ 5975 getColorSpace(): Promise<ColorSpace>; 5976 5977 /** 5978 * Obtains the set color space. 5979 * 5980 * @param { AsyncCallback<ColorSpace> } callback Callback used to return the result. 5981 * @syscap SystemCapability.WindowManager.WindowManager.Core 5982 * @since 8 5983 * @deprecated since 9 5984 * @useinstead ohos.window.Window#getWindowColorSpace 5985 */ 5986 getColorSpace(callback: AsyncCallback<ColorSpace>): void; 5987 5988 /** 5989 * Obtains the set color space. 5990 * 5991 * @returns { ColorSpace } Color space obtained. 5992 * @throws { BusinessError } 1300002 - This window state is abnormal. 5993 * @syscap SystemCapability.WindowManager.WindowManager.Core 5994 * @since 9 5995 */ 5996 /** 5997 * Obtains the set color space. 5998 * 5999 * @returns { ColorSpace } Color space obtained. 6000 * @throws { BusinessError } 1300002 - This window state is abnormal. 6001 * @syscap SystemCapability.WindowManager.WindowManager.Core 6002 * @crossplatform 6003 * @since 11 6004 */ 6005 /** 6006 * Obtains the set color space. 6007 * 6008 * @returns { ColorSpace } Color space obtained. 6009 * @throws { BusinessError } 1300002 - This window state is abnormal. 6010 * @syscap SystemCapability.WindowManager.WindowManager.Core 6011 * @crossplatform 6012 * @atomicservice 6013 * @since 12 6014 */ 6015 getWindowColorSpace(): ColorSpace; 6016 6017 /** 6018 * Sets the background color of window. 6019 * 6020 * @param { string } color the specified color. 6021 * @returns { Promise<void> } Promise that returns no value. 6022 * @syscap SystemCapability.WindowManager.WindowManager.Core 6023 * @since 6 6024 * @deprecated since 9 6025 * @useinstead ohos.window.Window#setWindowBackgroundColor 6026 */ 6027 setBackgroundColor(color: string): Promise<void>; 6028 6029 /** 6030 * Sets the background color of window. 6031 * 6032 * @param { string } color the specified color. 6033 * @param { AsyncCallback<void> } callback Callback used to return the result. 6034 * @syscap SystemCapability.WindowManager.WindowManager.Core 6035 * @since 6 6036 * @deprecated since 9 6037 * @useinstead ohos.window.Window#setWindowBackgroundColor 6038 */ 6039 setBackgroundColor(color: string, callback: AsyncCallback<void>): void; 6040 6041 /** 6042 * Sets the background color of window. 6043 * 6044 * @param { string } color the specified color. 6045 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6046 * 2. Incorrect parameter types. 6047 * @throws { BusinessError } 1300002 - This window state is abnormal. 6048 * @syscap SystemCapability.WindowManager.WindowManager.Core 6049 * @since 9 6050 */ 6051 /** 6052 * Sets the background color of window. 6053 * 6054 * @param { string } color the specified color. 6055 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6056 * 2. Incorrect parameter types. 6057 * @throws { BusinessError } 1300002 - This window state is abnormal. 6058 * @syscap SystemCapability.WindowManager.WindowManager.Core 6059 * @crossplatform 6060 * @since 10 6061 */ 6062 /** 6063 * Sets the background color of window. 6064 * 6065 * @param { string } color the specified color. 6066 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6067 * 2. Incorrect parameter types. 6068 * @throws { BusinessError } 1300002 - This window state is abnormal. 6069 * @syscap SystemCapability.WindowManager.WindowManager.Core 6070 * @crossplatform 6071 * @atomicservice 6072 * @since 11 6073 */ 6074 setWindowBackgroundColor(color: string): void; 6075 6076 /** 6077 * Sets the brightness of window. 6078 * 6079 * @param { number } brightness the specified brightness value. 6080 * @returns { Promise<void> } Promise that returns no value. 6081 * @syscap SystemCapability.WindowManager.WindowManager.Core 6082 * @since 6 6083 * @deprecated since 9 6084 * @useinstead ohos.window.Window#setWindowBrightness 6085 */ 6086 setBrightness(brightness: number): Promise<void>; 6087 6088 /** 6089 * Sets the brightness of window. 6090 * 6091 * @param { number } brightness the specified brightness value. 6092 * @param { AsyncCallback<void> } callback Callback used to return the result. 6093 * @syscap SystemCapability.WindowManager.WindowManager.Core 6094 * @since 6 6095 * @deprecated since 9 6096 * @useinstead ohos.window.Window#setWindowBrightness 6097 */ 6098 setBrightness(brightness: number, callback: AsyncCallback<void>): void; 6099 6100 /** 6101 * Set whether the main window is topmost. 6102 * 6103 * @param { boolean } isTopmost - Main window is topmost if true. 6104 * @returns { Promise<void> } Promise that returns no value. 6105 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6106 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6107 * 2. Incorrect parameter types. 6108 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 6109 * @throws { BusinessError } 1300002 - This window state is abnormal. 6110 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6111 * @throws { BusinessError } 1300004 - Unauthorized operation. 6112 * @syscap SystemCapability.Window.SessionManager 6113 * @systemapi 6114 * @since 12 6115 */ 6116 setTopmost(isTopmost: boolean): Promise<void>; 6117 6118 /** 6119 * Sets the brightness of window. 6120 * 6121 * @param { number } brightness the specified brightness value. 6122 * @returns { Promise<void> } Promise that returns no value. 6123 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6124 * 2. Incorrect parameter types. 6125 * @throws { BusinessError } 1300002 - This window state is abnormal. 6126 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6127 * @syscap SystemCapability.WindowManager.WindowManager.Core 6128 * @since 9 6129 */ 6130 /** 6131 * Sets the brightness of window. 6132 * 6133 * @param { number } brightness the specified brightness value. 6134 * @returns { Promise<void> } Promise that returns no value. 6135 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6136 * 2. Incorrect parameter types. 6137 * @throws { BusinessError } 1300002 - This window state is abnormal. 6138 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6139 * @syscap SystemCapability.WindowManager.WindowManager.Core 6140 * @crossplatform 6141 * @since 10 6142 */ 6143 /** 6144 * Sets the brightness of window. 6145 * 6146 * @param { number } brightness the specified brightness value. 6147 * @returns { Promise<void> } Promise that returns no value. 6148 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6149 * 2. Incorrect parameter types. 6150 * @throws { BusinessError } 1300002 - This window state is abnormal. 6151 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6152 * @syscap SystemCapability.WindowManager.WindowManager.Core 6153 * @crossplatform 6154 * @atomicservice 6155 * @since 11 6156 */ 6157 setWindowBrightness(brightness: number): Promise<void>; 6158 6159 /** 6160 * Sets the brightness of window. 6161 * 6162 * @param { number } brightness the specified brightness value. 6163 * @param { AsyncCallback<void> } callback Callback used to return the result. 6164 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6165 * 2. Incorrect parameter types. 6166 * @throws { BusinessError } 1300002 - This window state is abnormal. 6167 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6168 * @syscap SystemCapability.WindowManager.WindowManager.Core 6169 * @since 9 6170 */ 6171 /** 6172 * Sets the brightness of window. 6173 * 6174 * @param { number } brightness the specified brightness value. 6175 * @param { AsyncCallback<void> } callback Callback used to return the result. 6176 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6177 * 2. Incorrect parameter types. 6178 * @throws { BusinessError } 1300002 - This window state is abnormal. 6179 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6180 * @syscap SystemCapability.WindowManager.WindowManager.Core 6181 * @crossplatform 6182 * @since 10 6183 */ 6184 /** 6185 * Sets the brightness of window. 6186 * 6187 * @param { number } brightness the specified brightness value. 6188 * @param { AsyncCallback<void> } callback Callback used to return the result. 6189 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6190 * 2. Incorrect parameter types. 6191 * @throws { BusinessError } 1300002 - This window state is abnormal. 6192 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6193 * @syscap SystemCapability.WindowManager.WindowManager.Core 6194 * @crossplatform 6195 * @atomicservice 6196 * @since 11 6197 */ 6198 setWindowBrightness(brightness: number, callback: AsyncCallback<void>): void; 6199 6200 /** 6201 * Sets the dimBehind of window. 6202 * 6203 * @param { number } dimBehindValue - The specified dimBehind. 6204 * @param { AsyncCallback<void> } callback Callback used to return the result. 6205 * @syscap SystemCapability.WindowManager.WindowManager.Core 6206 * @since 7 6207 * @deprecated since 9 6208 */ 6209 setDimBehind(dimBehindValue: number, callback: AsyncCallback<void>): void; 6210 6211 /** 6212 * Sets the dimBehind of window. 6213 * 6214 * @param { number } dimBehindValue - The specified dimBehind. 6215 * @returns { Promise<void> } Promise that returns no value. 6216 * @syscap SystemCapability.WindowManager.WindowManager.Core 6217 * @since 7 6218 * @deprecated since 9 6219 */ 6220 setDimBehind(dimBehindValue: number): Promise<void>; 6221 6222 /** 6223 * Sets whether focusable or not. 6224 * 6225 * @param { boolean } isFocusable can be focus if true, or can not be focus if false. 6226 * @returns { Promise<void> } Promise that returns no value. 6227 * @syscap SystemCapability.WindowManager.WindowManager.Core 6228 * @since 7 6229 * @deprecated since 9 6230 * @useinstead ohos.window.Window#setWindowFocusable 6231 */ 6232 setFocusable(isFocusable: boolean): Promise<void>; 6233 6234 /** 6235 * Sets whether focusable or not. 6236 * 6237 * @param { boolean } isFocusable can be focus if true, or can not be focus if false. 6238 * @param { AsyncCallback<void> } callback Callback used to return the result. 6239 * @syscap SystemCapability.WindowManager.WindowManager.Core 6240 * @since 7 6241 * @deprecated since 9 6242 * @useinstead ohos.window.Window#setWindowFocusable 6243 */ 6244 setFocusable(isFocusable: boolean, callback: AsyncCallback<void>): void; 6245 6246 /** 6247 * Sets whether focusable or not. 6248 * 6249 * @param { boolean } isFocusable can be focus if true, or can not be focus if false. 6250 * @returns { Promise<void> } Promise that returns no value. 6251 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6252 * 2. Incorrect parameter types. 6253 * @throws { BusinessError } 1300002 - This window state is abnormal. 6254 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6255 * @syscap SystemCapability.WindowManager.WindowManager.Core 6256 * @since 9 6257 */ 6258 /** 6259 * Sets whether focusable or not. 6260 * 6261 * @param { boolean } isFocusable can be focus if true, or can not be focus if false. 6262 * @returns { Promise<void> } Promise that returns no value. 6263 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6264 * 2. Incorrect parameter types. 6265 * @throws { BusinessError } 1300002 - This window state is abnormal. 6266 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6267 * @syscap SystemCapability.WindowManager.WindowManager.Core 6268 * @atomicservice 6269 * @since 12 6270 */ 6271 setWindowFocusable(isFocusable: boolean): Promise<void>; 6272 6273 /** 6274 * Sets whether focusable or not. 6275 * 6276 * @param { boolean } isFocusable can be focus if true, or can not be focus if false. 6277 * @param { AsyncCallback<void> } callback Callback used to return the result. 6278 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6279 * 2. Incorrect parameter types. 6280 * @throws { BusinessError } 1300002 - This window state is abnormal. 6281 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6282 * @syscap SystemCapability.WindowManager.WindowManager.Core 6283 * @since 9 6284 */ 6285 /** 6286 * Sets whether focusable or not. 6287 * 6288 * @param { boolean } isFocusable can be focus if true, or can not be focus if false. 6289 * @param { AsyncCallback<void> } callback Callback used to return the result. 6290 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6291 * 2. Incorrect parameter types. 6292 * @throws { BusinessError } 1300002 - This window state is abnormal. 6293 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6294 * @syscap SystemCapability.WindowManager.WindowManager.Core 6295 * @atomicservice 6296 * @since 12 6297 */ 6298 setWindowFocusable(isFocusable: boolean, callback: AsyncCallback<void>): void; 6299 6300 /** 6301 * Window requests to get focus or lose focus. 6302 * 6303 * @param { boolean } isFocused - Window requests to get focus if true, requests to lose focus if false. 6304 * @returns { Promise<void> } - Promise that returns no value. 6305 * @throws { BusinessError } 202 - Permission verification failed, non-system application uses system API. 6306 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6307 * 2. Incorrect parameter types. 6308 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 6309 * @throws { BusinessError } 1300002 - This window state is abnormal. 6310 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6311 * @syscap SystemCapability.Window.SessionManager 6312 * @systemapi 6313 * @since 13 6314 */ 6315 requestFocus(isFocused: boolean): Promise<void>; 6316 6317 /** 6318 * Sets whether keep screen on or not. 6319 * 6320 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6321 * @returns { Promise<void> } that returns no value. 6322 * @syscap SystemCapability.WindowManager.WindowManager.Core 6323 * @since 6 6324 * @deprecated since 9 6325 * @useinstead ohos.window.Window#setWindowKeepScreenOn 6326 */ 6327 setKeepScreenOn(isKeepScreenOn: boolean): Promise<void>; 6328 6329 /** 6330 * Sets whether keep screen on or not. 6331 * 6332 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6333 * @param { AsyncCallback<void> } callback Callback used to return the result. 6334 * @syscap SystemCapability.WindowManager.WindowManager.Core 6335 * @since 6 6336 * @deprecated since 9 6337 * @useinstead ohos.window.Window#setWindowKeepScreenOn 6338 */ 6339 setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback<void>): void; 6340 6341 /** 6342 * Sets whether keep screen on or not. 6343 * 6344 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6345 * @returns { Promise<void> } Promise that returns no value. 6346 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6347 * 2. Incorrect parameter types. 6348 * @throws { BusinessError } 1300002 - This window state is abnormal. 6349 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6350 * @syscap SystemCapability.WindowManager.WindowManager.Core 6351 * @since 9 6352 */ 6353 /** 6354 * Sets whether keep screen on or not. 6355 * 6356 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6357 * @returns { Promise<void> } Promise that returns no value. 6358 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6359 * 2. Incorrect parameter types. 6360 * @throws { BusinessError } 1300002 - This window state is abnormal. 6361 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6362 * @syscap SystemCapability.WindowManager.WindowManager.Core 6363 * @crossplatform 6364 * @since 10 6365 */ 6366 /** 6367 * Sets whether keep screen on or not. 6368 * 6369 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6370 * @returns { Promise<void> } Promise that returns no value. 6371 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6372 * 2. Incorrect parameter types. 6373 * @throws { BusinessError } 1300002 - This window state is abnormal. 6374 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6375 * @syscap SystemCapability.WindowManager.WindowManager.Core 6376 * @crossplatform 6377 * @atomicservice 6378 * @since 11 6379 */ 6380 setWindowKeepScreenOn(isKeepScreenOn: boolean): Promise<void>; 6381 6382 /** 6383 * Sets whether keep screen on or not. 6384 * 6385 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6386 * @param { AsyncCallback<void> } callback Callback used to return the result. 6387 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6388 * 2. Incorrect parameter types. 6389 * @throws { BusinessError } 1300002 - This window state is abnormal. 6390 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6391 * @syscap SystemCapability.WindowManager.WindowManager.Core 6392 * @since 9 6393 */ 6394 /** 6395 * Sets whether keep screen on or not. 6396 * 6397 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6398 * @param { AsyncCallback<void> } callback Callback used to return the result. 6399 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6400 * 2. Incorrect parameter types. 6401 * @throws { BusinessError } 1300002 - This window state is abnormal. 6402 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6403 * @syscap SystemCapability.WindowManager.WindowManager.Core 6404 * @crossplatform 6405 * @since 10 6406 */ 6407 /** 6408 * Sets whether keep screen on or not. 6409 * 6410 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6411 * @param { AsyncCallback<void> } callback Callback used to return the result. 6412 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6413 * 2. Incorrect parameter types. 6414 * @throws { BusinessError } 1300002 - This window state is abnormal. 6415 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6416 * @syscap SystemCapability.WindowManager.WindowManager.Core 6417 * @crossplatform 6418 * @atomicservice 6419 * @since 11 6420 */ 6421 setWindowKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback<void>): void; 6422 6423 /** 6424 * Sets whether to wake up the screen when this ability is restored. 6425 * 6426 * @param { boolean } wakeUp Specifies whether to wake up the screen. True means to wake it up, false means not. 6427 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6428 * 2. Incorrect parameter types. 6429 * @throws { BusinessError } 1300002 - This window state is abnormal. 6430 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6431 * @syscap SystemCapability.WindowManager.WindowManager.Core 6432 * @systemapi Hide this for inner system use. 6433 * @since 9 6434 */ 6435 /** 6436 * Sets whether to wake up the screen when this ability is restored. 6437 * 6438 * @param { boolean } wakeUp Specifies whether to wake up the screen. True means to wake it up, false means not. 6439 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6440 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6441 * 2. Incorrect parameter types. 6442 * @throws { BusinessError } 1300002 - This window state is abnormal. 6443 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6444 * @syscap SystemCapability.WindowManager.WindowManager.Core 6445 * @systemapi Hide this for inner system use. 6446 * @since 12 6447 */ 6448 setWakeUpScreen(wakeUp: boolean): void; 6449 6450 /** 6451 * Sets whether outside can be touch or not. 6452 * 6453 * @param { boolean } touchable outside can be touch if true, or not if false. 6454 * @returns { Promise<void> } Promise that returns no value. 6455 * @syscap SystemCapability.WindowManager.WindowManager.Core 6456 * @since 7 6457 * @deprecated since 9 6458 */ 6459 setOutsideTouchable(touchable: boolean): Promise<void>; 6460 6461 /** 6462 * Sets whether outside can be touch or not. 6463 * 6464 * @param { boolean } touchable outside can be touch if true, or not if false. 6465 * @param { AsyncCallback<void> } callback Callback used to return the result. 6466 * @syscap SystemCapability.WindowManager.WindowManager.Core 6467 * @since 7 6468 * @deprecated since 9 6469 */ 6470 setOutsideTouchable(touchable: boolean, callback: AsyncCallback<void>): void; 6471 6472 /** 6473 * Sets whether is private mode or not. 6474 * 6475 * @param { boolean } isPrivacyMode in private mode if true, or not if false. 6476 * @returns { Promise<void> } Promise that returns no value. 6477 * @syscap SystemCapability.WindowManager.WindowManager.Core 6478 * @since 7 6479 * @deprecated since 9 6480 * @useinstead ohos.window.Window#setWindowPrivacyMode 6481 */ 6482 setPrivacyMode(isPrivacyMode: boolean): Promise<void>; 6483 6484 /** 6485 * Sets whether is private mode or not. 6486 * 6487 * @param { boolean } isPrivacyMode in private mode if true, or not if false. 6488 * @param { AsyncCallback<void> } callback Callback used to return the result. 6489 * @syscap SystemCapability.WindowManager.WindowManager.Core 6490 * @since 7 6491 * @deprecated since 9 6492 * @useinstead ohos.window.Window#setWindowPrivacyMode 6493 */ 6494 setPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback<void>): void; 6495 6496 /** 6497 * Sets whether is private mode or not. 6498 * 6499 * @permission ohos.permission.PRIVACY_WINDOW 6500 * @param { boolean } isPrivacyMode in private mode if true, or not if false. 6501 * @returns { Promise<void> } Promise that returns no value. 6502 * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. 6503 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6504 * 2. Incorrect parameter types. 6505 * @throws { BusinessError } 1300002 - This window state is abnormal. 6506 * @syscap SystemCapability.WindowManager.WindowManager.Core 6507 * @since 9 6508 */ 6509 /** 6510 * Sets whether is private mode or not. 6511 * 6512 * @permission ohos.permission.PRIVACY_WINDOW 6513 * @param { boolean } isPrivacyMode in private mode if true, or not if false. 6514 * @returns { Promise<void> } Promise that returns no value. 6515 * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. 6516 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6517 * 2. Incorrect parameter types. 6518 * @throws { BusinessError } 1300002 - This window state is abnormal. 6519 * @syscap SystemCapability.WindowManager.WindowManager.Core 6520 * @atomicservice 6521 * @since 12 6522 */ 6523 setWindowPrivacyMode(isPrivacyMode: boolean): Promise<void>; 6524 6525 /** 6526 * Sets whether is private mode or not. 6527 * 6528 * @permission ohos.permission.PRIVACY_WINDOW 6529 * @param { boolean } isPrivacyMode in private mode if true, or not if false. 6530 * @param { AsyncCallback<void> } callback Callback used to return the result. 6531 * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. 6532 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6533 * 2. Incorrect parameter types. 6534 * @throws { BusinessError } 1300002 - This window state is abnormal. 6535 * @syscap SystemCapability.WindowManager.WindowManager.Core 6536 * @since 9 6537 */ 6538 /** 6539 * Sets whether is private mode or not. 6540 * 6541 * @permission ohos.permission.PRIVACY_WINDOW 6542 * @param { boolean } isPrivacyMode in private mode if true, or not if false. 6543 * @param { AsyncCallback<void> } callback Callback used to return the result. 6544 * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. 6545 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6546 * 2. Incorrect parameter types. 6547 * @throws { BusinessError } 1300002 - This window state is abnormal. 6548 * @syscap SystemCapability.WindowManager.WindowManager.Core 6549 * @atomicservice 6550 * @since 12 6551 */ 6552 setWindowPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback<void>): void; 6553 6554 /** 6555 * Ignore this window during screenshot. 6556 * 6557 * @param { boolean } isSkip skip if true, or not if false. 6558 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6559 * 2. Incorrect parameter types. 6560 * @throws { BusinessError } 1300002 - This window state is abnormal. 6561 * @syscap SystemCapability.WindowManager.WindowManager.Core 6562 * @systemapi Hide this for inner system use. 6563 * @since 9 6564 */ 6565 /** 6566 * Ignore this window during screenshot. 6567 * 6568 * @param { boolean } isSkip skip if true, or not if false. 6569 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6570 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6571 * 2. Incorrect parameter types. 6572 * @throws { BusinessError } 1300002 - This window state is abnormal. 6573 * @syscap SystemCapability.WindowManager.WindowManager.Core 6574 * @systemapi Hide this for inner system use. 6575 * @since 12 6576 */ 6577 setSnapshotSkip(isSkip: boolean): void; 6578 6579 /** 6580 * Sets whether is touchable or not. 6581 * 6582 * @param { boolean } isTouchable is touchable if true, or not if false. 6583 * @returns { Promise<void> } Promise that returns no value. 6584 * @syscap SystemCapability.WindowManager.WindowManager.Core 6585 * @since 7 6586 * @deprecated since 9 6587 * @useinstead ohos.window.Window#setWindowTouchable 6588 */ 6589 setTouchable(isTouchable: boolean): Promise<void>; 6590 6591 /** 6592 * Sets whether is touchable or not. 6593 * 6594 * @param { boolean } isTouchable is touchable if true, or not if false. 6595 * @param { AsyncCallback<void> } callback Callback used to return the result. 6596 * @syscap SystemCapability.WindowManager.WindowManager.Core 6597 * @since 7 6598 * @deprecated since 9 6599 * @useinstead ohos.window.Window#setWindowTouchable 6600 */ 6601 setTouchable(isTouchable: boolean, callback: AsyncCallback<void>): void; 6602 6603 /** 6604 * Sets whether is touchable or not. 6605 * 6606 * @param { boolean } isTouchable is touchable if true, or not if false. 6607 * @returns { Promise<void> } Promise that returns no value. 6608 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6609 * 2. Incorrect parameter types. 6610 * @throws { BusinessError } 1300002 - This window state is abnormal. 6611 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6612 * @syscap SystemCapability.WindowManager.WindowManager.Core 6613 * @since 9 6614 */ 6615 /** 6616 * Sets whether is touchable or not. 6617 * 6618 * @param { boolean } isTouchable is touchable if true, or not if false. 6619 * @returns { Promise<void> } Promise that returns no value. 6620 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6621 * 2. Incorrect parameter types. 6622 * @throws { BusinessError } 1300002 - This window state is abnormal. 6623 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6624 * @syscap SystemCapability.WindowManager.WindowManager.Core 6625 * @atomicservice 6626 * @since 12 6627 */ 6628 setWindowTouchable(isTouchable: boolean): Promise<void>; 6629 6630 /** 6631 * Sets whether is touchable or not. 6632 * 6633 * @param { boolean } isTouchable is touchable if true, or not if false. 6634 * @param { AsyncCallback<void> } callback Callback used to return the result. 6635 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6636 * 2. Incorrect parameter types. 6637 * @throws { BusinessError } 1300002 - This window state is abnormal. 6638 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6639 * @syscap SystemCapability.WindowManager.WindowManager.Core 6640 * @since 9 6641 */ 6642 /** 6643 * Sets whether is touchable or not. 6644 * 6645 * @param { boolean } isTouchable is touchable if true, or not if false. 6646 * @param { AsyncCallback<void> } callback Callback used to return the result. 6647 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6648 * 2. Incorrect parameter types. 6649 * @throws { BusinessError } 1300002 - This window state is abnormal. 6650 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6651 * @syscap SystemCapability.WindowManager.WindowManager.Core 6652 * @atomicservice 6653 * @since 12 6654 */ 6655 setWindowTouchable(isTouchable: boolean, callback: AsyncCallback<void>): void; 6656 6657 /** 6658 * Set handwrite flag on the window. This flag means only response handwrite event. 6659 * 6660 * @param { boolean } enable - Add handwrite flag to window if true, or remove flag if false. 6661 * @returns { Promise<void> } - The promise returned by the function. 6662 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6663 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6664 * 2. Incorrect parameter types. 6665 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 6666 * @throws { BusinessError } 1300002 - This window state is abnormal. 6667 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6668 * @syscap SystemCapability.Window.SessionManager 6669 * @systemapi Hide this for inner system use. 6670 * @since 12 6671 */ 6672 setHandwritingFlag(enable: boolean): Promise<void>; 6673 6674 /** 6675 * Sets the flag of the window is forbidden to move in split screen mode 6676 * 6677 * @param { boolean } isForbidSplitMove the flag of the window is forbidden to move in split screen mode 6678 * @param { AsyncCallback<void> } callback Callback used to return the result. 6679 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6680 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6681 * 2. Incorrect parameter types. 6682 * @throws { BusinessError } 1300002 - This window state is abnormal. 6683 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6684 * @syscap SystemCapability.WindowManager.WindowManager.Core 6685 * @systemapi 6686 * @since 9 6687 */ 6688 setForbidSplitMove(isForbidSplitMove: boolean, callback: AsyncCallback<void>): void; 6689 6690 /** 6691 * Sets the flag of the window is forbidden to move in split screen mode 6692 * 6693 * @param { boolean } isForbidSplitMove the flag of the window is forbidden to move in split screen mode 6694 * @returns { Promise<void> } Promise that returns no value. 6695 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6696 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6697 * 2. Incorrect parameter types. 6698 * @throws { BusinessError } 1300002 - This window state is abnormal. 6699 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6700 * @syscap SystemCapability.WindowManager.WindowManager.Core 6701 * @systemapi 6702 * @since 9 6703 */ 6704 setForbidSplitMove(isForbidSplitMove: boolean): Promise<void>; 6705 6706 /** 6707 * Obtains snapshot of window 6708 * 6709 * @param { AsyncCallback<image.PixelMap> } callback Callback used to return the result. 6710 * @throws { BusinessError } 1300002 - This window state is abnormal. 6711 * @syscap SystemCapability.WindowManager.WindowManager.Core 6712 * @since 9 6713 */ 6714 /** 6715 * Obtains snapshot of window 6716 * 6717 * @param { AsyncCallback<image.PixelMap> } callback Callback used to return the result. 6718 * @throws { BusinessError } 1300002 - This window state is abnormal. 6719 * @syscap SystemCapability.WindowManager.WindowManager.Core 6720 * @atomicservice 6721 * @since 12 6722 */ 6723 snapshot(callback: AsyncCallback<image.PixelMap>): void; 6724 6725 /** 6726 * Obtains snapshot of window 6727 * 6728 * @returns { Promise<image.PixelMap> } Promise that returns no value. 6729 * @throws { BusinessError } 1300002 - This window state is abnormal. 6730 * @syscap SystemCapability.WindowManager.WindowManager.Core 6731 * @since 9 6732 */ 6733 /** 6734 * Obtains snapshot of window 6735 * 6736 * @returns { Promise<image.PixelMap> } Promise that returns no value. 6737 * @throws { BusinessError } 1300002 - This window state is abnormal. 6738 * @syscap SystemCapability.WindowManager.WindowManager.Core 6739 * @atomicservice 6740 * @since 12 6741 */ 6742 snapshot(): Promise<image.PixelMap>; 6743 6744 /** 6745 * Sets opacity of window 6746 * 6747 * @param { number } opacity Interval is 0.f-1.f. 6748 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6749 * 2. Incorrect parameter types; 6750 * 3. Parameter verification failed. 6751 * @throws { BusinessError } 1300002 - This window state is abnormal. 6752 * @throws { BusinessError } 1300004 - Unauthorized operation. 6753 * @syscap SystemCapability.WindowManager.WindowManager.Core 6754 * @systemapi 6755 * @since 9 6756 */ 6757 /** 6758 * Sets opacity of window 6759 * 6760 * @param { number } opacity Interval is 0.f-1.f. 6761 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6762 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6763 * 2. Incorrect parameter types; 6764 * 3. Parameter verification failed. 6765 * @throws { BusinessError } 1300002 - This window state is abnormal. 6766 * @throws { BusinessError } 1300004 - Unauthorized operation. 6767 * @syscap SystemCapability.WindowManager.WindowManager.Core 6768 * @systemapi 6769 * @since 12 6770 */ 6771 opacity(opacity: number): void; 6772 6773 /** 6774 * Sets scale options of window. 6775 * 6776 * @param { ScaleOptions } scaleOptions scale param of window. 6777 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6778 * 2. Incorrect parameter types; 6779 * 3. Parameter verification failed. 6780 * @throws { BusinessError } 1300002 - This window state is abnormal. 6781 * @throws { BusinessError } 1300004 - Unauthorized operation. 6782 * @syscap SystemCapability.WindowManager.WindowManager.Core 6783 * @systemapi 6784 * @since 9 6785 */ 6786 /** 6787 * Sets scale options of window. 6788 * 6789 * @param { ScaleOptions } scaleOptions scale param of window. 6790 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6791 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6792 * 2. Incorrect parameter types; 6793 * 3. Parameter verification failed. 6794 * @throws { BusinessError } 1300002 - This window state is abnormal. 6795 * @throws { BusinessError } 1300004 - Unauthorized operation. 6796 * @syscap SystemCapability.WindowManager.WindowManager.Core 6797 * @systemapi 6798 * @since 12 6799 */ 6800 scale(scaleOptions: ScaleOptions): void; 6801 6802 /** 6803 * Sets rotate options of window. 6804 * 6805 * @param { RotateOptions } rotateOptions rotate param of window. 6806 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6807 * 2. Incorrect parameter types; 6808 * 3. Parameter verification failed. 6809 * @throws { BusinessError } 1300002 - This window state is abnormal. 6810 * @throws { BusinessError } 1300004 - Unauthorized operation. 6811 * @syscap SystemCapability.WindowManager.WindowManager.Core 6812 * @systemapi 6813 * @since 9 6814 */ 6815 /** 6816 * Sets rotate options of window. 6817 * 6818 * @param { RotateOptions } rotateOptions rotate param of window. 6819 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6820 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6821 * 2. Incorrect parameter types; 6822 * 3. Parameter verification failed. 6823 * @throws { BusinessError } 1300002 - This window state is abnormal. 6824 * @throws { BusinessError } 1300004 - Unauthorized operation. 6825 * @syscap SystemCapability.WindowManager.WindowManager.Core 6826 * @systemapi 6827 * @since 12 6828 */ 6829 rotate(rotateOptions: RotateOptions): void; 6830 6831 /** 6832 * Sets translate options of window. 6833 * 6834 * @param { TranslateOptions } translateOptions translate param of window. 6835 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6836 * 2. Incorrect parameter types; 6837 * 3. Parameter verification failed. 6838 * @throws { BusinessError } 1300002 - This window state is abnormal. 6839 * @throws { BusinessError } 1300004 - Unauthorized operation. 6840 * @syscap SystemCapability.WindowManager.WindowManager.Core 6841 * @systemapi 6842 * @since 9 6843 */ 6844 /** 6845 * Sets translate options of window. 6846 * 6847 * @param { TranslateOptions } translateOptions translate param of window. 6848 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6849 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6850 * 2. Incorrect parameter types; 6851 * 3. Parameter verification failed. 6852 * @throws { BusinessError } 1300002 - This window state is abnormal. 6853 * @throws { BusinessError } 1300004 - Unauthorized operation. 6854 * @syscap SystemCapability.WindowManager.WindowManager.Core 6855 * @systemapi 6856 * @since 12 6857 */ 6858 translate(translateOptions: TranslateOptions): void; 6859 6860 /** 6861 * Get Transition Controller. 6862 * 6863 * @returns { TransitionController } 6864 * @throws { BusinessError } 1300002 - This window state is abnormal. 6865 * @throws { BusinessError } 1300004 - Unauthorized operation. 6866 * @syscap SystemCapability.WindowManager.WindowManager.Core 6867 * @systemapi 6868 * @since 9 6869 */ 6870 /** 6871 * Get Transition Controller. 6872 * 6873 * @returns { TransitionController } 6874 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6875 * @throws { BusinessError } 1300002 - This window state is abnormal. 6876 * @throws { BusinessError } 1300004 - Unauthorized operation. 6877 * @syscap SystemCapability.WindowManager.WindowManager.Core 6878 * @systemapi 6879 * @since 12 6880 */ 6881 getTransitionController(): TransitionController; 6882 6883 /** 6884 * Sets the window blur radius. 6885 * 6886 * @param { number } radius the blur radius. 6887 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6888 * 2. Incorrect parameter types; 6889 * 3. Parameter verification failed. 6890 * @throws { BusinessError } 1300002 - This window state is abnormal. 6891 * @throws { BusinessError } 1300004 - Unauthorized operation. 6892 * @syscap SystemCapability.WindowManager.WindowManager.Core 6893 * @systemapi Hide this for inner system use. 6894 * @since 9 6895 */ 6896 /** 6897 * Sets the window blur radius. 6898 * 6899 * @param { number } radius the blur radius. 6900 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6901 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6902 * 2. Incorrect parameter types; 6903 * 3. Parameter verification failed. 6904 * @throws { BusinessError } 1300002 - This window state is abnormal. 6905 * @throws { BusinessError } 1300004 - Unauthorized operation. 6906 * @syscap SystemCapability.WindowManager.WindowManager.Core 6907 * @systemapi Hide this for inner system use. 6908 * @since 12 6909 */ 6910 setBlur(radius: number): void; 6911 6912 /** 6913 * Sets the window backdrop blur radius. 6914 * 6915 * @param { number } radius the blur radius. 6916 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6917 * 2. Incorrect parameter types; 6918 * 3. Parameter verification failed. 6919 * @throws { BusinessError } 1300002 - This window state is abnormal. 6920 * @throws { BusinessError } 1300004 - Unauthorized operation. 6921 * @syscap SystemCapability.WindowManager.WindowManager.Core 6922 * @systemapi Hide this for inner system use. 6923 * @since 9 6924 */ 6925 /** 6926 * Sets the window backdrop blur radius. 6927 * 6928 * @param { number } radius the blur radius. 6929 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6930 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6931 * 2. Incorrect parameter types; 6932 * 3. Parameter verification failed. 6933 * @throws { BusinessError } 1300002 - This window state is abnormal. 6934 * @throws { BusinessError } 1300004 - Unauthorized operation. 6935 * @syscap SystemCapability.WindowManager.WindowManager.Core 6936 * @systemapi Hide this for inner system use. 6937 * @since 12 6938 */ 6939 setBackdropBlur(radius: number): void; 6940 6941 /** 6942 * Sets the window backdrop blur style. 6943 * 6944 * @param { BlurStyle } blurStyle the specified blur style. 6945 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6946 * 2. Incorrect parameter types; 6947 * 3. Parameter verification failed. 6948 * @throws { BusinessError } 1300002 - This window state is abnormal. 6949 * @throws { BusinessError } 1300004 - Unauthorized operation. 6950 * @syscap SystemCapability.WindowManager.WindowManager.Core 6951 * @systemapi Hide this for inner system use. 6952 * @since 9 6953 */ 6954 /** 6955 * Sets the window backdrop blur style. 6956 * 6957 * @param { BlurStyle } blurStyle the specified blur style. 6958 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6959 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6960 * 2. Incorrect parameter types; 6961 * 3. Parameter verification failed. 6962 * @throws { BusinessError } 1300002 - This window state is abnormal. 6963 * @throws { BusinessError } 1300004 - Unauthorized operation. 6964 * @syscap SystemCapability.WindowManager.WindowManager.Core 6965 * @systemapi Hide this for inner system use. 6966 * @since 12 6967 */ 6968 setBackdropBlurStyle(blurStyle: BlurStyle): void; 6969 6970 /** 6971 * Sets shadow. 6972 * 6973 * @param { number } radius the radius of the shadow. 6974 * @param { string } color the color of the shadow. 6975 * @param { number } offsetX the offset of the shadow on the x-axis. 6976 * @param { number } offsetY the offset of the shadow on the y-axis. 6977 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6978 * 2. Incorrect parameter types; 6979 * 3. Parameter verification failed. 6980 * @throws { BusinessError } 1300002 - This window state is abnormal. 6981 * @throws { BusinessError } 1300004 - Unauthorized operation. 6982 * @syscap SystemCapability.WindowManager.WindowManager.Core 6983 * @systemapi Hide this for inner system use. 6984 * @since 9 6985 */ 6986 /** 6987 * Sets shadow. 6988 * 6989 * @param { number } radius the radius of the shadow. 6990 * @param { string } color the color of the shadow. 6991 * @param { number } offsetX the offset of the shadow on the x-axis. 6992 * @param { number } offsetY the offset of the shadow on the y-axis. 6993 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6994 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6995 * 2. Incorrect parameter types; 6996 * 3. Parameter verification failed. 6997 * @throws { BusinessError } 1300002 - This window state is abnormal. 6998 * @throws { BusinessError } 1300004 - Unauthorized operation. 6999 * @syscap SystemCapability.WindowManager.WindowManager.Core 7000 * @systemapi Hide this for inner system use. 7001 * @since 12 7002 */ 7003 setShadow(radius: number, color?: string, offsetX?: number, offsetY?: number): void; 7004 7005 /** 7006 * Sets corner radius. 7007 * 7008 * @param { number } cornerRadius the corner radius. 7009 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7010 * 2. Incorrect parameter types; 7011 * 3. Parameter verification failed. 7012 * @throws { BusinessError } 1300002 - This window state is abnormal. 7013 * @throws { BusinessError } 1300004 - Unauthorized operation. 7014 * @syscap SystemCapability.WindowManager.WindowManager.Core 7015 * @systemapi Hide this for inner system use. 7016 * @since 9 7017 */ 7018 /** 7019 * Sets corner radius. 7020 * 7021 * @param { number } cornerRadius the corner radius. 7022 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7023 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7024 * 2. Incorrect parameter types; 7025 * 3. Parameter verification failed. 7026 * @throws { BusinessError } 1300002 - This window state is abnormal. 7027 * @throws { BusinessError } 1300004 - Unauthorized operation. 7028 * @syscap SystemCapability.WindowManager.WindowManager.Core 7029 * @systemapi Hide this for inner system use. 7030 * @since 12 7031 */ 7032 setCornerRadius(cornerRadius: number): void; 7033 7034 /** 7035 * Raise app sub window to app top 7036 * 7037 * @param { AsyncCallback<void> } callback - The callback of raiseToAppTop 7038 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7039 * @throws { BusinessError } 1300002 - This window state is abnormal. 7040 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7041 * @throws { BusinessError } 1300004 - Unauthorized operation. 7042 * @throws { BusinessError } 1300009 - The parent window is invalid. 7043 * @syscap SystemCapability.WindowManager.WindowManager.Core 7044 * @systemapi Hide this for inner system use. 7045 * @since 10 7046 */ 7047 raiseToAppTop(callback: AsyncCallback<void>): void; 7048 7049 /** 7050 * Raise app sub window to app top 7051 * 7052 * @returns { Promise<void> } - The promise returned by the function 7053 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7054 * @throws { BusinessError } 1300002 - This window state is abnormal. 7055 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7056 * @throws { BusinessError } 1300004 - Unauthorized operation. 7057 * @throws { BusinessError } 1300009 - The parent window is invalid. 7058 * @syscap SystemCapability.WindowManager.WindowManager.Core 7059 * @systemapi Hide this for inner system use. 7060 * @since 10 7061 */ 7062 raiseToAppTop(): Promise<void>; 7063 7064 /** 7065 * Sets the aspect ratio of window 7066 * 7067 * @param { number } ratio - The aspect ratio of window except decoration 7068 * @param { AsyncCallback<void> } callback - The callback of setAspectRatio. 7069 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7070 * 2. Incorrect parameter types; 7071 * 3. Parameter verification failed. 7072 * @throws { BusinessError } 1300002 - This window state is abnormal. 7073 * @throws { BusinessError } 1300004 - Unauthorized operation. 7074 * @syscap SystemCapability.WindowManager.WindowManager.Core 7075 * @since 10 7076 */ 7077 /** 7078 * Sets the aspect ratio of window 7079 * 7080 * @param { number } ratio - The aspect ratio of window except decoration 7081 * @param { AsyncCallback<void> } callback - The callback of setAspectRatio. 7082 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7083 * 2. Incorrect parameter types; 7084 * 3. Parameter verification failed. 7085 * @throws { BusinessError } 1300002 - This window state is abnormal. 7086 * @throws { BusinessError } 1300004 - Unauthorized operation. 7087 * @syscap SystemCapability.WindowManager.WindowManager.Core 7088 * @atomicservice 7089 * @since 12 7090 */ 7091 setAspectRatio(ratio: number, callback: AsyncCallback<void>): void; 7092 7093 /** 7094 * Sets the aspect ratio of window 7095 * 7096 * @param { number } ratio - The aspect ratio of window except decoration 7097 * @returns { Promise<void> } - The promise returned by the function. 7098 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7099 * 2. Incorrect parameter types; 7100 * 3. Parameter verification failed. 7101 * @throws { BusinessError } 1300002 - This window state is abnormal. 7102 * @throws { BusinessError } 1300004 - Unauthorized operation. 7103 * @syscap SystemCapability.WindowManager.WindowManager.Core 7104 * @since 10 7105 */ 7106 /** 7107 * Sets the aspect ratio of window 7108 * 7109 * @param { number } ratio - The aspect ratio of window except decoration 7110 * @returns { Promise<void> } - The promise returned by the function. 7111 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7112 * 2. Incorrect parameter types; 7113 * 3. Parameter verification failed. 7114 * @throws { BusinessError } 1300002 - This window state is abnormal. 7115 * @throws { BusinessError } 1300004 - Unauthorized operation. 7116 * @syscap SystemCapability.WindowManager.WindowManager.Core 7117 * @atomicservice 7118 * @since 12 7119 */ 7120 setAspectRatio(ratio: number): Promise<void>; 7121 7122 /** 7123 * Resets the aspect ratio of window 7124 * 7125 * @param { AsyncCallback<void> } callback - The callback of setAspectRatio. 7126 * @throws { BusinessError } 1300002 - This window state is abnormal. 7127 * @throws { BusinessError } 1300004 - Unauthorized operation. 7128 * @syscap SystemCapability.WindowManager.WindowManager.Core 7129 * @since 10 7130 */ 7131 /** 7132 * Resets the aspect ratio of window 7133 * 7134 * @param { AsyncCallback<void> } callback - The callback of setAspectRatio. 7135 * @throws { BusinessError } 1300002 - This window state is abnormal. 7136 * @throws { BusinessError } 1300004 - Unauthorized operation. 7137 * @syscap SystemCapability.WindowManager.WindowManager.Core 7138 * @atomicservice 7139 * @since 12 7140 */ 7141 resetAspectRatio(callback: AsyncCallback<void>): void; 7142 7143 /** 7144 * Resets the aspect ratio of window 7145 * 7146 * @returns { Promise<void> } - The promise returned by the function. 7147 * @throws { BusinessError } 1300002 - This window state is abnormal. 7148 * @throws { BusinessError } 1300004 - Unauthorized operation. 7149 * @syscap SystemCapability.WindowManager.WindowManager.Core 7150 * @since 10 7151 */ 7152 /** 7153 * Resets the aspect ratio of window 7154 * 7155 * @returns { Promise<void> } - The promise returned by the function. 7156 * @throws { BusinessError } 1300002 - This window state is abnormal. 7157 * @throws { BusinessError } 1300004 - Unauthorized operation. 7158 * @syscap SystemCapability.WindowManager.WindowManager.Core 7159 * @atomicservice 7160 * @since 12 7161 */ 7162 resetAspectRatio(): Promise<void>; 7163 7164 /** 7165 * Set the watermark flag on the window. 7166 * 7167 * @param { boolean } enable - Add water mark flag to window if true, or remove flag if false. 7168 * @param { AsyncCallback<void> } callback - The callback of setWaterMarkFlag. 7169 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 7170 * <br>2. Incorrect parameter types. 7171 * @throws { BusinessError } 1300002 - This window state is abnormal. 7172 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7173 * @throws { BusinessError } 1300008 - The display device is abnormal. 7174 * @syscap SystemCapability.WindowManager.WindowManager.Core 7175 * @systemapi Hide this for inner system use. 7176 * @since 10 7177 */ 7178 /** 7179 * Set the watermark flag on the window. 7180 * 7181 * @param { boolean } enable - Add water mark flag to window if true, or remove flag if false. 7182 * @param { AsyncCallback<void> } callback - The callback of setWaterMarkFlag. 7183 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7184 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 7185 * <br>2. Incorrect parameter types. 7186 * @throws { BusinessError } 1300002 - This window state is abnormal. 7187 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7188 * @throws { BusinessError } 1300008 - The display device is abnormal. 7189 * @syscap SystemCapability.WindowManager.WindowManager.Core 7190 * @systemapi Hide this for inner system use. 7191 * @since 12 7192 */ 7193 setWaterMarkFlag(enable: boolean, callback: AsyncCallback<void>): void; 7194 7195 /** 7196 * Set the watermark flag on the window 7197 * 7198 * @param { boolean } enable - Add water mark flag to window if true, or remove flag if false 7199 * @returns { Promise<void> } - The promise returned by the function 7200 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 7201 * <br>2. Incorrect parameter types. 7202 * @throws { BusinessError } 1300002 - This window state is abnormal. 7203 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7204 * @throws { BusinessError } 1300008 - The display device is abnormal. 7205 * @syscap SystemCapability.WindowManager.WindowManager.Core 7206 * @systemapi Hide this for inner system use. 7207 * @since 10 7208 */ 7209 /** 7210 * Set the watermark flag on the window 7211 * 7212 * @param { boolean } enable - Add water mark flag to window if true, or remove flag if false 7213 * @returns { Promise<void> } - The promise returned by the function 7214 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7215 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 7216 * <br>2. Incorrect parameter types. 7217 * @throws { BusinessError } 1300002 - This window state is abnormal. 7218 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7219 * @throws { BusinessError } 1300008 - The display device is abnormal. 7220 * @syscap SystemCapability.WindowManager.WindowManager.Core 7221 * @systemapi Hide this for inner system use. 7222 * @since 12 7223 */ 7224 setWaterMarkFlag(enable: boolean): Promise<void>; 7225 7226 /** 7227 * Raise one app sub window above another. 7228 * 7229 * @param { number } windowId - Indicates target window id. 7230 * @param { AsyncCallback<void> } callback - The callback of raiseAboveTarget. 7231 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7232 * @throws { BusinessError } 401 - Parameter error. Possible cause: Mandatory parameters are left unspecified. 7233 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7234 * @throws { BusinessError } 1300002 - This window state is abnormal. 7235 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7236 * @throws { BusinessError } 1300004 - Unauthorized operation. 7237 * @throws { BusinessError } 1300009 - The parent window is invalid. 7238 * @syscap SystemCapability.Window.SessionManager 7239 * @systemapi Hide this for inner system use. 7240 * @since 10 7241 */ 7242 raiseAboveTarget(windowId: number, callback: AsyncCallback<void>): void; 7243 7244 /** 7245 * Raise one app sub window above another. 7246 * 7247 * @param { number } windowId - Indicates target window id. 7248 * @returns { Promise<void> } - The promise returned by the function. 7249 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7250 * @throws { BusinessError } 401 - Parameter error. Possible cause: Mandatory parameters are left unspecified. 7251 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7252 * @throws { BusinessError } 1300002 - This window state is abnormal. 7253 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7254 * @throws { BusinessError } 1300004 - Unauthorized operation. 7255 * @throws { BusinessError } 1300009 - The parent window is invalid. 7256 * @syscap SystemCapability.Window.SessionManager 7257 * @systemapi Hide this for inner system use. 7258 * @since 10 7259 */ 7260 raiseAboveTarget(windowId: number): Promise<void>; 7261 7262 /** 7263 * Set whether to enable an app sub window to raise itself by click. 7264 * 7265 * @param { boolean } enable - Disable app sub window to raise itself by by click if false. 7266 * @param { AsyncCallback<void> } callback - The callback of setRaiseByClickEnabled. 7267 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7268 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7269 * 2. Incorrect parameter types. 7270 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7271 * @throws { BusinessError } 1300002 - This window state is abnormal. 7272 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7273 * @throws { BusinessError } 1300004 - Unauthorized operation. 7274 * @throws { BusinessError } 1300009 - The parent window is invalid. 7275 * @syscap SystemCapability.Window.SessionManager 7276 * @systemapi Hide this for inner system use. 7277 * @since 10 7278 */ 7279 setRaiseByClickEnabled(enable: boolean, callback: AsyncCallback<void>): void; 7280 7281 /** 7282 * Set whether to enable an app sub window to raise itself by click. 7283 * 7284 * @param { boolean } enable - Disable app sub window to raise itself by by click if false. 7285 * @returns { Promise<void> } - The promise returned by the function. 7286 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7287 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7288 * 2. Incorrect parameter types. 7289 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7290 * @throws { BusinessError } 1300002 - This window state is abnormal. 7291 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7292 * @throws { BusinessError } 1300004 - Unauthorized operation. 7293 * @throws { BusinessError } 1300009 - The parent window is invalid. 7294 * @syscap SystemCapability.Window.SessionManager 7295 * @systemapi Hide this for inner system use. 7296 * @since 10 7297 */ 7298 setRaiseByClickEnabled(enable: boolean): Promise<void>; 7299 7300 /** 7301 * Minimize app main window and hide app subWindow. 7302 * 7303 * @param { AsyncCallback<void> } callback - The callback of Minimize. 7304 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7305 * @throws { BusinessError } 1300002 - This window state is abnormal. 7306 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7307 * @syscap SystemCapability.Window.SessionManager 7308 * @since 11 7309 */ 7310 /** 7311 * Minimize app main window and hide app subWindow. 7312 * 7313 * @param { AsyncCallback<void> } callback - The callback of Minimize. 7314 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7315 * @throws { BusinessError } 1300002 - This window state is abnormal. 7316 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7317 * @syscap SystemCapability.Window.SessionManager 7318 * @atomicservice 7319 * @since 12 7320 */ 7321 minimize(callback: AsyncCallback<void>): void; 7322 7323 /** 7324 * Minimize app main window and hide app subWindow. 7325 * 7326 * @returns { Promise<void> } - The promise returned by the function. 7327 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7328 * @throws { BusinessError } 1300002 - This window state is abnormal. 7329 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7330 * @syscap SystemCapability.Window.SessionManager 7331 * @since 11 7332 */ 7333 /** 7334 * Minimize app main window and hide app subWindow. 7335 * 7336 * @returns { Promise<void> } - The promise returned by the function. 7337 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7338 * @throws { BusinessError } 1300002 - This window state is abnormal. 7339 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7340 * @syscap SystemCapability.Window.SessionManager 7341 * @atomicservice 7342 * @since 12 7343 */ 7344 minimize(): Promise<void>; 7345 7346 /** 7347 * Maximize app main window. 7348 * @param { MaximizePresentation } presentation - set window presentation when maximize. 7349 * @returns { Promise<void> } - The promise returned by the function. 7350 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7351 * @throws { BusinessError } 1300002 - This window state is abnormal. 7352 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7353 * @throws { BusinessError } 1300004 - Unauthorized operation. 7354 * @throws { BusinessError } 1300005 - This window stage is abnormal. 7355 * @syscap SystemCapability.Window.SessionManager 7356 * @atomicservice 7357 * @since 12 7358 */ 7359 maximize(presentation?: MaximizePresentation): Promise<void>; 7360 7361 /** 7362 * Set whether to enable a window to resize by drag. 7363 * 7364 * @param { boolean } enable - Disable window to resize by drag if false. 7365 * @param { AsyncCallback<void> } callback - The callback of setResizeByDragEnabled. 7366 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7367 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7368 * 2. Incorrect parameter types. 7369 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7370 * @throws { BusinessError } 1300002 - This window state is abnormal. 7371 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7372 * @throws { BusinessError } 1300004 - Unauthorized operation. 7373 * @syscap SystemCapability.Window.SessionManager 7374 * @systemapi Hide this for inner system use. 7375 * @since 10 7376 */ 7377 /** 7378 * Set whether to enable a window to resize by drag. 7379 * 7380 * @param { boolean } enable - Disable window to resize by drag if false. 7381 * @param { AsyncCallback<void> } callback - The callback of setResizeByDragEnabled. 7382 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7383 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7384 * 2. Incorrect parameter types. 7385 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7386 * @throws { BusinessError } 1300002 - This window state is abnormal. 7387 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7388 * @syscap SystemCapability.Window.SessionManager 7389 * @systemapi Hide this for inner system use. 7390 * @since 11 7391 */ 7392 setResizeByDragEnabled(enable: boolean, callback: AsyncCallback<void>): void; 7393 7394 /** 7395 * Set whether to enable a window to resize by drag. 7396 * 7397 * @param { boolean } enable - Disable window to resize by drag if false. 7398 * @returns { Promise<void> } - The promise returned by the function. 7399 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7400 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7401 * 2. Incorrect parameter types. 7402 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7403 * @throws { BusinessError } 1300002 - This window state is abnormal. 7404 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7405 * @syscap SystemCapability.Window.SessionManager 7406 * @systemapi Hide this for inner system use. 7407 * @since 10 7408 */ 7409 setResizeByDragEnabled(enable: boolean): Promise<void>; 7410 7411 /** 7412 * Hide the non-system floating windows. 7413 * 7414 * @param { boolean } shouldHide - Hide the non-system floating windows if true, otherwise means the opposite. 7415 * @param { AsyncCallback<void> } callback - The callback of hideNonSystemFloatingWindows. 7416 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7417 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7418 * 2. Incorrect parameter types. 7419 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7420 * @throws { BusinessError } 1300002 - This window state is abnormal. 7421 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7422 * @throws { BusinessError } 1300004 - Unauthorized operation. 7423 * @syscap SystemCapability.Window.SessionManager 7424 * @systemapi Hide this for inner system use. 7425 * @since 11 7426 */ 7427 hideNonSystemFloatingWindows(shouldHide: boolean, callback: AsyncCallback<void>): void; 7428 7429 /** 7430 * Hide the non-system floating windows. 7431 * 7432 * @param { boolean } shouldHide - Hide the non-system floating windows if true, otherwise means the opposite. 7433 * @returns { Promise<void> } - The promise returned by the function. 7434 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7435 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7436 * 2. Incorrect parameter types. 7437 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7438 * @throws { BusinessError } 1300002 - This window state is abnormal. 7439 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7440 * @throws { BusinessError } 1300004 - Unauthorized operation. 7441 * @syscap SystemCapability.Window.SessionManager 7442 * @systemapi Hide this for inner system use. 7443 * @since 11 7444 */ 7445 hideNonSystemFloatingWindows(shouldHide: boolean): Promise<void>; 7446 7447 /** 7448 * Get the window limits of current window. 7449 * 7450 * @returns { WindowLimits } - The limits of window. 7451 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7452 * @throws { BusinessError } 1300002 - This window state is abnormal. 7453 * @syscap SystemCapability.Window.SessionManager 7454 * @since 11 7455 */ 7456 /** 7457 * Get the window limits of current window. 7458 * 7459 * @returns { WindowLimits } - The limits of window. 7460 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7461 * @throws { BusinessError } 1300002 - This window state is abnormal. 7462 * @syscap SystemCapability.Window.SessionManager 7463 * @atomicservice 7464 * @since 12 7465 */ 7466 getWindowLimits(): WindowLimits; 7467 7468 /** 7469 * Set the window limits of a window. 7470 * 7471 * @param { WindowLimits } windowLimits - window limits of the window. 7472 * @returns { Promise<WindowLimits> } - Promise is used to return the limits of window. 7473 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7474 * 2. Incorrect parameter types; 7475 * 3. Parameter verification failed. 7476 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7477 * @throws { BusinessError } 1300002 - This window state is abnormal. 7478 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7479 * @throws { BusinessError } 1300004 - Unauthorized operation. 7480 * @syscap SystemCapability.Window.SessionManager 7481 * @since 11 7482 */ 7483 /** 7484 * Set the window limits of a window. 7485 * 7486 * @param { WindowLimits } windowLimits - window limits of the window. 7487 * @returns { Promise<WindowLimits> } - Promise is used to return the limits of window. 7488 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7489 * 2. Incorrect parameter types; 7490 * 3. Parameter verification failed. 7491 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7492 * @throws { BusinessError } 1300002 - This window state is abnormal. 7493 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7494 * @throws { BusinessError } 1300004 - Unauthorized operation. 7495 * @syscap SystemCapability.Window.SessionManager 7496 * @atomicservice 7497 * @since 12 7498 */ 7499 setWindowLimits(windowLimits: WindowLimits): Promise<WindowLimits>; 7500 7501 /** 7502 * Set whether to enable the single frame composer. 7503 * 7504 * @param { boolean } enable - Enable the single frame composer if true, otherwise means the opposite. 7505 * @returns { Promise<void> } - The promise returned by the function. 7506 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7507 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7508 * 2. Incorrect parameter types. 7509 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7510 * @throws { BusinessError } 1300002 - This window state is abnormal. 7511 * @syscap SystemCapability.Window.SessionManager 7512 * @systemapi Hide this for inner system use. 7513 * @since 11 7514 */ 7515 setSingleFrameComposerEnabled(enable: boolean): Promise<void>; 7516 7517 /** 7518 * When get focused, keep the keyboard created by other windows, support system window and app subwindow. 7519 * 7520 * @param { boolean } keepKeyboardFlag - keep the keyboard if true, otherwise means the opposite. 7521 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7522 * 2. Incorrect parameter types. 7523 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7524 * @throws { BusinessError } 1300002 - This window state is abnormal. 7525 * @throws { BusinessError } 1300004 - Unauthorized operation. 7526 * @syscap SystemCapability.Window.SessionManager 7527 * @since 11 7528 */ 7529 /** 7530 * When get focused, keep the keyboard created by other windows, support system window and app subwindow. 7531 * 7532 * @param { boolean } keepKeyboardFlag - keep the keyboard if true, otherwise means the opposite. 7533 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7534 * 2. Incorrect parameter types. 7535 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7536 * @throws { BusinessError } 1300002 - This window state is abnormal. 7537 * @throws { BusinessError } 1300004 - Unauthorized operation. 7538 * @syscap SystemCapability.Window.SessionManager 7539 * @atomicservice 7540 * @since 12 7541 */ 7542 keepKeyboardOnFocus(keepKeyboardFlag: boolean): void; 7543 7544 /** 7545 * Recover app main window. 7546 * 7547 * @returns { Promise<void> } - The promise returned by the function. 7548 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7549 * @throws { BusinessError } 1300001 - Repeated operation. 7550 * @throws { BusinessError } 1300002 - This window state is abnormal. 7551 * @syscap SystemCapability.Window.SessionManager 7552 * @since 11 7553 */ 7554 /** 7555 * Recover app main window. 7556 * 7557 * @returns { Promise<void> } - The promise returned by the function. 7558 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7559 * @throws { BusinessError } 1300001 - Repeated operation. 7560 * @throws { BusinessError } 1300002 - This window state is abnormal. 7561 * @syscap SystemCapability.Window.SessionManager 7562 * @atomicservice 7563 * @since 12 7564 */ 7565 recover(): Promise<void>; 7566 7567 /** 7568 * Set the visibility of the window decor. 7569 * 7570 * @param { boolean } - Enable the decor visible if true, otherwise means the opposite. 7571 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7572 * 2. Incorrect parameter types. 7573 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7574 * @throws { BusinessError } 1300002 - This window state is abnormal. 7575 * @throws { BusinessError } 1300004 - Unauthorized operation. 7576 * @syscap SystemCapability.Window.SessionManager 7577 * @since 11 7578 */ 7579 /** 7580 * Set the visibility of the window decor. 7581 * 7582 * @param { boolean } isVisible - Enable the decor visible if true, otherwise means the opposite. 7583 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7584 * 2. Incorrect parameter types. 7585 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7586 * @throws { BusinessError } 1300002 - This window state is abnormal. 7587 * @throws { BusinessError } 1300004 - Unauthorized operation. 7588 * @syscap SystemCapability.Window.SessionManager 7589 * @atomicservice 7590 * @since 12 7591 */ 7592 setWindowDecorVisible(isVisible: boolean): void; 7593 7594 /** 7595 * Set the modality of the window. 7596 * 7597 * @param { boolean } isModal - Enable the window modal if true, otherwise means the opposite. 7598 * @returns { Promise<void> } Promise that returns no value. 7599 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7600 * 2. Incorrect parameter types. 7601 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7602 * @throws { BusinessError } 1300002 - This window state is abnormal. 7603 * @throws { BusinessError } 1300004 - Unauthorized operation. 7604 * @syscap SystemCapability.Window.SessionManager 7605 * @atomicservice 7606 * @since 12 7607 */ 7608 setSubWindowModal(isModal: boolean): Promise<void>; 7609 7610 /** 7611 * Set the height of the window decor. 7612 * 7613 * @param { number } - The height of window decor. 7614 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7615 * 2. Incorrect parameter types; 7616 * 3. Parameter verification failed. 7617 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7618 * @throws { BusinessError } 1300002 - This window state is abnormal. 7619 * @syscap SystemCapability.Window.SessionManager 7620 * @since 11 7621 */ 7622 /** 7623 * Set the height of the window decor. 7624 * 7625 * @param { number } height - The height of window decor. 7626 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7627 * 2. Incorrect parameter types; 7628 * 3. Parameter verification failed. 7629 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7630 * @throws { BusinessError } 1300002 - This window state is abnormal. 7631 * @syscap SystemCapability.Window.SessionManager 7632 * @atomicservice 7633 * @since 12 7634 */ 7635 setWindowDecorHeight(height: number): void; 7636 7637 /** 7638 * Get the height of the window decor. 7639 * 7640 * @returns { number } - The height of window decor. 7641 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7642 * @throws { BusinessError } 1300002 - This window state is abnormal. 7643 * @syscap SystemCapability.Window.SessionManager 7644 * @since 11 7645 */ 7646 /** 7647 * Get the height of the window decor. 7648 * 7649 * @returns { number } - The height of window decor. 7650 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7651 * @throws { BusinessError } 1300002 - This window state is abnormal. 7652 * @syscap SystemCapability.Window.SessionManager 7653 * @atomicservice 7654 * @since 12 7655 */ 7656 getWindowDecorHeight(): number; 7657 7658 /** 7659 * Set touchable areas. By default, the entire window area is touchable. 7660 * If touchable areas are set in the window, touch events outside the areas will be transparent transmitted. 7661 * If the window area changes, you need to reset it. 7662 * 7663 * @param { Array<Rect> } rects - Touchable areas. The maximum size cannot exceed 10, touchable area cannot exceed the window's area. 7664 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7665 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7666 * 2. Incorrect parameter types. 7667 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7668 * @throws { BusinessError } 1300002 - This window state is abnormal. 7669 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7670 * @syscap SystemCapability.Window.SessionManager 7671 * @systemapi 7672 * @since 12 7673 */ 7674 setTouchableAreas(rects: Array<Rect>): void; 7675 7676 /** 7677 * Get the area of window title buttons. 7678 * 7679 * @returns { TitleButtonRect } - The area of window title buttons. 7680 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7681 * @throws { BusinessError } 1300002 - This window state is abnormal. 7682 * @syscap SystemCapability.Window.SessionManager 7683 * @since 11 7684 */ 7685 /** 7686 * Get the area of window title buttons. 7687 * 7688 * @returns { TitleButtonRect } - The area of window title buttons. 7689 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7690 * @throws { BusinessError } 1300002 - This window state is abnormal. 7691 * @syscap SystemCapability.Window.SessionManager 7692 * @atomicservice 7693 * @since 12 7694 */ 7695 getTitleButtonRect(): TitleButtonRect; 7696 7697 /** 7698 * Set whether to display the maximize, minimize, split buttons of main window. 7699 * 7700 * @param { boolean } isMaximizeVisible - Display maximize button if true, or hide maximize button if false. 7701 * @param { boolean } isMinimizeVisible - Display minimize button if true, or hide minimize button if false. 7702 * @param { boolean } isSplitVisible - Display split button if true, or hide split button if false. 7703 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7704 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7705 * 2. Incorrect parameter types. 7706 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7707 * @throws { BusinessError } 1300002 - This window state is abnormal. 7708 * @throws { BusinessError } 1300004 - Unauthorized operation. 7709 * @syscap SystemCapability.Window.SessionManager 7710 * @systemapi Hide this for inner system use. 7711 * @since 12 7712 */ 7713 setTitleButtonVisible(isMaximizeVisible: boolean, isMinimizeVisible: boolean, isSplitVisible: boolean): void; 7714 7715 /** 7716 * Enable landscape multiWindow 7717 * 7718 * @returns { Promise<void> } Promise that returns no value. 7719 * @throws {BusinessError} 1300002 - This window state is abnormal. 7720 * @throws {BusinessError} 1300003 - This window manager service works abnormally. 7721 * @syscap SystemCapability.Window.SessionManager 7722 * @atomicservice 7723 * @since 12 7724 */ 7725 enableLandscapeMultiWindow(): Promise<void>; 7726 7727 /** 7728 * Disable landscape multiWindow 7729 * 7730 * @returns { Promise<void> } Promise that returns no value. 7731 * @throws {BusinessError} 1300002 - This window state is abnormal. 7732 * @throws {BusinessError} 1300003 - This window manager service works abnormally. 7733 * @syscap SystemCapability.Window.SessionManager 7734 * @atomicservice 7735 * @since 12 7736 */ 7737 disableLandscapeMultiWindow(): Promise<void>; 7738 7739 /** 7740 * Register the callback of title buttons area change. 7741 * 7742 * @param { 'windowTitleButtonRectChange' } type - The value is fixed at 'windowTitleButtonRectChange', indicating the title buttons area change event. 7743 * @param { Callback<TitleButtonRect> } callback - Callback used to return the current title buttons area. 7744 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7745 * 2. Incorrect parameter types; 7746 * 3. Parameter verification failed. 7747 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7748 * @throws { BusinessError } 1300002 - This window state is abnormal. 7749 * @syscap SystemCapability.Window.SessionManager 7750 * @since 11 7751 */ 7752 /** 7753 * Register the callback of title buttons area change. 7754 * 7755 * @param { 'windowTitleButtonRectChange' } type - The value is fixed at 'windowTitleButtonRectChange', indicating the title buttons area change event. 7756 * @param { Callback<TitleButtonRect> } callback - Callback used to return the current title buttons area. 7757 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7758 * 2. Incorrect parameter types; 7759 * 3. Parameter verification failed. 7760 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7761 * @throws { BusinessError } 1300002 - This window state is abnormal. 7762 * @syscap SystemCapability.Window.SessionManager 7763 * @atomicservice 7764 * @since 12 7765 */ 7766 on(type: 'windowTitleButtonRectChange', callback: Callback<TitleButtonRect>): void; 7767 7768 /** 7769 * Unregister the callback of title buttons area change. 7770 * 7771 * @param { 'windowTitleButtonRectChange' } type - The value is fixed at 'windowTitleButtonRectChange', indicating the title buttons area change event. 7772 * @param { Callback<TitleButtonRect> } callback - Callback used to return the current title buttons area. 7773 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 7774 * 2. Parameter verification failed. 7775 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7776 * @throws { BusinessError } 1300002 - This window state is abnormal. 7777 * @syscap SystemCapability.Window.SessionManager 7778 * @since 11 7779 */ 7780 /** 7781 * Unregister the callback of title buttons area change. 7782 * 7783 * @param { 'windowTitleButtonRectChange' } type - The value is fixed at 'windowTitleButtonRectChange', indicating the title buttons area change event. 7784 * @param { Callback<TitleButtonRect> } callback - Callback used to return the current title buttons area. 7785 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 7786 * 2. Parameter verification failed. 7787 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7788 * @throws { BusinessError } 1300002 - This window state is abnormal. 7789 * @syscap SystemCapability.Window.SessionManager 7790 * @atomicservice 7791 * @since 12 7792 */ 7793 off(type: 'windowTitleButtonRectChange', callback?: Callback<TitleButtonRect>): void; 7794 7795 /** 7796 * Set the window mask of window 7797 * 7798 * @param { Array<Array<number>> } windowMask - The mask of window. The value of the array is 0 and 1, the other number is illegal value. 7799 * @returns { Promise<void> } Promise that returns no value. 7800 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7801 * 2. Incorrect parameter types. 7802 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7803 * @throws { BusinessError } 1300002 - This window state is abnormal. 7804 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7805 * @throws { BusinessError } 1300004 - Unauthorized operation. 7806 * @syscap SystemCapability.Window.SessionManager 7807 * @atomicservice 7808 * @since 12 7809 */ 7810 setWindowMask(windowMask: Array<Array<number>>): Promise<void>; 7811 7812 /** 7813 * Register the callback of windowRectChange 7814 * 7815 * @param { 'windowRectChange' } type - The value is fixed at 'windowRectChange', indicating the window rect change event. 7816 * @param { Callback<RectChangeOptions> } callback - Callback used to return the RectChangeOptions. 7817 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7818 * 2. Incorrect parameter types; 7819 * 3. Parameter verification failed. 7820 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7821 * @throws { BusinessError } 1300002 - This window state is abnormal. 7822 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7823 * @syscap SystemCapability.Window.SessionManager 7824 * @atomicservice 7825 * @since 12 7826 */ 7827 on(type: 'windowRectChange', callback: Callback<RectChangeOptions>): void; 7828 7829 /** 7830 * Unregister the callback of windowRectChange 7831 * 7832 * @param { 'windowRectChange' } type - The value is fixed at 'windowRectChange', indicating the window rect change event. 7833 * @param { Callback<RectChangeOptions> } callback - Callback used to return the RectChangeOptions. 7834 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 7835 * 2. Parameter verification failed. 7836 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7837 * @throws { BusinessError } 1300002 - This window state is abnormal. 7838 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7839 * @syscap SystemCapability.Window.SessionManager 7840 * @atomicservice 7841 * @since 12 7842 */ 7843 off(type: 'windowRectChange', callback?: Callback<RectChangeOptions>): void; 7844 7845 /** 7846 * Set gray scale of window. 7847 * 7848 * @param { number } grayScale - The value of gray scale. 7849 * @returns { Promise<void> } - The promise returned by the function. 7850 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7851 * 2. Incorrect parameter types; 7852 * 3. Parameter verification failed. 7853 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7854 * @throws { BusinessError } 1300002 - This window state is abnormal. 7855 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7856 * @syscap SystemCapability.Window.SessionManager 7857 * @atomicservice 7858 * @since 12 7859 */ 7860 setWindowGrayScale(grayScale: number): Promise<void>; 7861 7862 /** 7863 * Set whether to enable immersive mode. 7864 * 7865 * @param { boolean } enabled - The value true means to enable immersive mode, and false means the opposite. 7866 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7867 * 2. Incorrect parameter types; 7868 * @throws { BusinessError } 1300002 - This window state is abnormal. 7869 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7870 * @throws { BusinessError } 1300004 - Unauthorized operation. 7871 * @syscap SystemCapability.WindowManager.WindowManager.Core 7872 * @atomicservice 7873 * @since 12 7874 */ 7875 setImmersiveModeEnabledState(enabled: boolean): void; 7876 7877 /** 7878 * Get whether the immersive mode is enabled or not. 7879 * 7880 * @returns { boolean } - The value true means the immersive mode is enabled, and false means the opposite. 7881 * @throws { BusinessError } 1300002 - This window state is abnormal. 7882 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7883 * @throws { BusinessError } 1300004 - Unauthorized operation. 7884 * @syscap SystemCapability.WindowManager.WindowManager.Core 7885 * @atomicservice 7886 * @since 12 7887 */ 7888 getImmersiveModeEnabledState(): boolean; 7889 7890 /** 7891 * Get the window status of current window. 7892 * 7893 * @returns { WindowStatusType } - The status of window. 7894 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7895 * @throws { BusinessError } 1300002 - This window state is abnormal. 7896 * @syscap SystemCapability.Window.SessionManager 7897 * @atomicservice 7898 * @since 12 7899 */ 7900 getWindowStatus(): WindowStatusType; 7901 7902 /** 7903 * Checks whether the window is focused. 7904 * 7905 * @returns { boolean } - Whether the window is focused. The value true means that the window is focused, and false means the opposite. 7906 * @throws { BusinessError } 1300002 - This window state is abnormal. 7907 * @syscap SystemCapability.WindowManager.WindowManager.Core 7908 * @atomicservice 7909 * @since 12 7910 */ 7911 isFocused(): boolean; 7912 7913 /** 7914 * Create sub window with options. 7915 * 7916 * @param { string } name - window name of sub window 7917 * @param { SubWindowOptions } options - options of sub window creation 7918 * @returns { Promise<Window> } Promise used to return the subwindow. 7919 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 7920 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7921 * @throws { BusinessError } 1300002 - This window state is abnormal. 7922 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7923 * @throws { BusinessError } 1300004 - Unauthorized operation. 7924 * @syscap SystemCapability.Window.SessionManager 7925 * @StageModelOnly 7926 * @atomicservice 7927 * @since 12 7928 */ 7929 createSubWindowWithOptions(name: string, options: SubWindowOptions): Promise<Window>; 7930 } 7931 7932 /** 7933 * Window stage callback event type 7934 * 7935 * @enum { number } 7936 * @syscap SystemCapability.WindowManager.WindowManager.Core 7937 * @StageModelOnly 7938 * @since 9 7939 */ 7940 /** 7941 * Window stage callback event type 7942 * 7943 * @enum { number } 7944 * @syscap SystemCapability.WindowManager.WindowManager.Core 7945 * @StageModelOnly 7946 * @crossplatform 7947 * @since 10 7948 */ 7949 /** 7950 * Window stage callback event type 7951 * 7952 * @enum { number } 7953 * @syscap SystemCapability.WindowManager.WindowManager.Core 7954 * @StageModelOnly 7955 * @crossplatform 7956 * @atomicservice 7957 * @since 11 7958 */ 7959 enum WindowStageEventType { 7960 /** 7961 * The window stage is running in the foreground. 7962 * 7963 * @syscap SystemCapability.WindowManager.WindowManager.Core 7964 * @StageModelOnly 7965 * @since 9 7966 */ 7967 /** 7968 * The window stage is running in the foreground. 7969 * 7970 * @syscap SystemCapability.WindowManager.WindowManager.Core 7971 * @StageModelOnly 7972 * @crossplatform 7973 * @since 10 7974 */ 7975 /** 7976 * The window stage is running in the foreground. 7977 * 7978 * @syscap SystemCapability.WindowManager.WindowManager.Core 7979 * @StageModelOnly 7980 * @crossplatform 7981 * @atomicservice 7982 * @since 11 7983 */ 7984 SHOWN = 1, 7985 /** 7986 * The window stage gains focus. 7987 * 7988 * @syscap SystemCapability.WindowManager.WindowManager.Core 7989 * @StageModelOnly 7990 * @since 9 7991 */ 7992 /** 7993 * The window stage gains focus. 7994 * 7995 * @syscap SystemCapability.WindowManager.WindowManager.Core 7996 * @StageModelOnly 7997 * @crossplatform 7998 * @since 10 7999 */ 8000 /** 8001 * The window stage gains focus. 8002 * 8003 * @syscap SystemCapability.WindowManager.WindowManager.Core 8004 * @StageModelOnly 8005 * @crossplatform 8006 * @atomicservice 8007 * @since 11 8008 */ 8009 ACTIVE, 8010 /** 8011 * The window stage loses focus. 8012 * 8013 * @syscap SystemCapability.WindowManager.WindowManager.Core 8014 * @StageModelOnly 8015 * @since 9 8016 */ 8017 /** 8018 * The window stage loses focus. 8019 * 8020 * @syscap SystemCapability.WindowManager.WindowManager.Core 8021 * @StageModelOnly 8022 * @crossplatform 8023 * @since 10 8024 */ 8025 /** 8026 * The window stage loses focus. 8027 * 8028 * @syscap SystemCapability.WindowManager.WindowManager.Core 8029 * @StageModelOnly 8030 * @crossplatform 8031 * @atomicservice 8032 * @since 11 8033 */ 8034 INACTIVE, 8035 /** 8036 * The window stage is running in the background. 8037 * 8038 * @syscap SystemCapability.WindowManager.WindowManager.Core 8039 * @StageModelOnly 8040 * @since 9 8041 */ 8042 /** 8043 * The window stage is running in the background. 8044 * 8045 * @syscap SystemCapability.WindowManager.WindowManager.Core 8046 * @StageModelOnly 8047 * @crossplatform 8048 * @since 10 8049 */ 8050 /** 8051 * The window stage is running in the background. 8052 * 8053 * @syscap SystemCapability.WindowManager.WindowManager.Core 8054 * @StageModelOnly 8055 * @crossplatform 8056 * @atomicservice 8057 * @since 11 8058 */ 8059 HIDDEN, 8060 /** 8061 * The window stage is interactive in the foreground. 8062 * 8063 * @syscap SystemCapability.WindowManager.WindowManager.Core 8064 * @StageModelOnly 8065 * @crossplatform 8066 * @atomicservice 8067 * @since 11 8068 */ 8069 RESUMED, 8070 /** 8071 * The window stage is not interactive in the foreground. 8072 * 8073 * @syscap SystemCapability.WindowManager.WindowManager.Core 8074 * @StageModelOnly 8075 * @crossplatform 8076 * @atomicservice 8077 * @since 11 8078 */ 8079 PAUSED 8080 } 8081 /** 8082 * Options for subwindow creation 8083 * 8084 * @interface SubWindowOptions 8085 * @syscap SystemCapability.Window.SessionManager 8086 * @since 11 8087 */ 8088 /** 8089 * Options for subwindow creation 8090 * 8091 * @interface SubWindowOptions 8092 * @syscap SystemCapability.Window.SessionManager 8093 * @atomicservice 8094 * @since 12 8095 */ 8096 interface SubWindowOptions { 8097 /** 8098 * Indicates subwindow title 8099 * 8100 * @type { string } 8101 * @syscap SystemCapability.Window.SessionManager 8102 * @since 11 8103 */ 8104 /** 8105 * Indicates subwindow title 8106 * 8107 * @type { string } 8108 * @syscap SystemCapability.Window.SessionManager 8109 * @atomicservice 8110 * @since 12 8111 */ 8112 title: string; 8113 /** 8114 * Indicates decor of subwindow 8115 * 8116 * @type { boolean } 8117 * @syscap SystemCapability.Window.SessionManager 8118 * @since 11 8119 */ 8120 /** 8121 * Indicates decor of subwindow 8122 * 8123 * @type { boolean } 8124 * @syscap SystemCapability.Window.SessionManager 8125 * @atomicservice 8126 * @since 12 8127 */ 8128 decorEnabled: boolean; 8129 /** 8130 * Indicates modality of subwindow 8131 * 8132 * @type { ?boolean } 8133 * @syscap SystemCapability.Window.SessionManager 8134 * @atomicservice 8135 * @since 12 8136 */ 8137 isModal?: boolean; 8138 /** 8139 * Indicates whether subwindow is topmost 8140 * 8141 * @type { ?boolean } 8142 * @syscap SystemCapability.Window.SessionManager 8143 * @systemapi Hide this for inner system use. 8144 * @since 12 8145 */ 8146 isTopmost?: boolean; 8147 } 8148 /** 8149 * WindowStage 8150 * 8151 * @interface WindowStage 8152 * @syscap SystemCapability.WindowManager.WindowManager.Core 8153 * @since 9 8154 */ 8155 /** 8156 * WindowStage 8157 * 8158 * @interface WindowStage 8159 * @syscap SystemCapability.WindowManager.WindowManager.Core 8160 * @crossplatform 8161 * @since 10 8162 */ 8163 /** 8164 * WindowStage 8165 * 8166 * @interface WindowStage 8167 * @syscap SystemCapability.WindowManager.WindowManager.Core 8168 * @crossplatform 8169 * @atomicservice 8170 * @since 11 8171 */ 8172 interface WindowStage { 8173 /** 8174 * Get main window of the stage. 8175 * 8176 * @returns { Promise<Window> } Callback used to return the subwindow. 8177 * @throws { BusinessError } 1300002 - This window state is abnormal. 8178 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8179 * @syscap SystemCapability.WindowManager.WindowManager.Core 8180 * @StageModelOnly 8181 * @since 9 8182 */ 8183 /** 8184 * Get main window of the stage. 8185 * 8186 * @returns { Promise<Window> } Callback used to return the subwindow. 8187 * @throws { BusinessError } 1300002 - This window state is abnormal. 8188 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8189 * @syscap SystemCapability.WindowManager.WindowManager.Core 8190 * @StageModelOnly 8191 * @crossplatform 8192 * @since 10 8193 */ 8194 /** 8195 * Get main window of the stage. 8196 * 8197 * @returns { Promise<Window> } Callback used to return the subwindow. 8198 * @throws { BusinessError } 1300002 - This window state is abnormal. 8199 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8200 * @syscap SystemCapability.WindowManager.WindowManager.Core 8201 * @StageModelOnly 8202 * @crossplatform 8203 * @atomicservice 8204 * @since 11 8205 */ 8206 getMainWindow(): Promise<Window>; 8207 /** 8208 * Get main window of the stage. 8209 * 8210 * @param { AsyncCallback<Window> } callback Callback used to return the main window. 8211 * @throws { BusinessError } 1300002 - This window state is abnormal. 8212 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8213 * @syscap SystemCapability.WindowManager.WindowManager.Core 8214 * @StageModelOnly 8215 * @since 9 8216 */ 8217 /** 8218 * Get main window of the stage. 8219 * 8220 * @param { AsyncCallback<Window> } callback Callback used to return the main window. 8221 * @throws { BusinessError } 1300002 - This window state is abnormal. 8222 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8223 * @syscap SystemCapability.WindowManager.WindowManager.Core 8224 * @StageModelOnly 8225 * @crossplatform 8226 * @since 10 8227 */ 8228 /** 8229 * Get main window of the stage. 8230 * 8231 * @param { AsyncCallback<Window> } callback Callback used to return the main window. 8232 * @throws { BusinessError } 1300002 - This window state is abnormal. 8233 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8234 * @syscap SystemCapability.WindowManager.WindowManager.Core 8235 * @StageModelOnly 8236 * @crossplatform 8237 * @atomicservice 8238 * @since 11 8239 */ 8240 getMainWindow(callback: AsyncCallback<Window>): void; 8241 /** 8242 * Get main window of the stage. 8243 * 8244 * @returns { Window } 8245 * @throws { BusinessError } 1300002 - This window state is abnormal. 8246 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8247 * @syscap SystemCapability.WindowManager.WindowManager.Core 8248 * @StageModelOnly 8249 * @since 9 8250 */ 8251 /** 8252 * Get main window of the stage. 8253 * 8254 * @returns { Window } 8255 * @throws { BusinessError } 1300002 - This window state is abnormal. 8256 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8257 * @syscap SystemCapability.WindowManager.WindowManager.Core 8258 * @StageModelOnly 8259 * @crossplatform 8260 * @since 10 8261 */ 8262 /** 8263 * Get main window of the stage. 8264 * 8265 * @returns { Window } 8266 * @throws { BusinessError } 1300002 - This window state is abnormal. 8267 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8268 * @syscap SystemCapability.WindowManager.WindowManager.Core 8269 * @StageModelOnly 8270 * @crossplatform 8271 * @atomicservice 8272 * @since 11 8273 */ 8274 getMainWindowSync(): Window; 8275 /** 8276 * Create sub window of the stage. 8277 * 8278 * @param { string } name window name of sub window 8279 * @returns { Promise<Window> } Promise used to return the subwindow. 8280 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8281 * @throws { BusinessError } 1300002 - This window state is abnormal. 8282 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8283 * @syscap SystemCapability.WindowManager.WindowManager.Core 8284 * @StageModelOnly 8285 * @since 9 8286 */ 8287 /** 8288 * Create sub window of the stage. 8289 * 8290 * @param { string } name window name of sub window 8291 * @returns { Promise<Window> } Promise used to return the subwindow. 8292 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8293 * @throws { BusinessError } 1300002 - This window state is abnormal. 8294 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8295 * @syscap SystemCapability.WindowManager.WindowManager.Core 8296 * @StageModelOnly 8297 * @crossplatform 8298 * @since 10 8299 */ 8300 /** 8301 * Create sub window of the stage. 8302 * 8303 * @param { string } name window name of sub window 8304 * @returns { Promise<Window> } Promise used to return the subwindow. 8305 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8306 * @throws { BusinessError } 1300002 - This window state is abnormal. 8307 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8308 * @syscap SystemCapability.WindowManager.WindowManager.Core 8309 * @StageModelOnly 8310 * @crossplatform 8311 * @atomicservice 8312 * @since 11 8313 */ 8314 createSubWindow(name: string): Promise<Window>; 8315 /** 8316 * Create sub window of the stage. 8317 * 8318 * @param { string } name window name of sub window 8319 * @param { AsyncCallback<Window> } callback Callback used to return the subwindow. 8320 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8321 * @throws { BusinessError } 1300002 - This window state is abnormal. 8322 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8323 * @syscap SystemCapability.WindowManager.WindowManager.Core 8324 * @StageModelOnly 8325 * @since 9 8326 */ 8327 /** 8328 * Create sub window of the stage. 8329 * 8330 * @param { string } name window name of sub window 8331 * @param { AsyncCallback<Window> } callback Callback used to return the subwindow. 8332 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8333 * @throws { BusinessError } 1300002 - This window state is abnormal. 8334 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8335 * @syscap SystemCapability.WindowManager.WindowManager.Core 8336 * @StageModelOnly 8337 * @crossplatform 8338 * @since 10 8339 */ 8340 /** 8341 * Create sub window of the stage. 8342 * 8343 * @param { string } name window name of sub window 8344 * @param { AsyncCallback<Window> } callback Callback used to return the subwindow. 8345 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8346 * @throws { BusinessError } 1300002 - This window state is abnormal. 8347 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8348 * @syscap SystemCapability.WindowManager.WindowManager.Core 8349 * @StageModelOnly 8350 * @crossplatform 8351 * @atomicservice 8352 * @since 11 8353 */ 8354 createSubWindow(name: string, callback: AsyncCallback<Window>): void; 8355 /** 8356 * Create sub window of the stage. 8357 * 8358 * @param { string } name - window name of sub window 8359 * @param { SubWindowOptions } options - options of sub window creation 8360 * @returns { Promise<Window> } Promise used to return the subwindow. 8361 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8362 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 8363 * @throws { BusinessError } 1300002 - This window state is abnormal. 8364 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8365 * @syscap SystemCapability.Window.SessionManager 8366 * @StageModelOnly 8367 * @since 11 8368 */ 8369 /** 8370 * Create sub window of the stage. 8371 * 8372 * @param { string } name - window name of sub window 8373 * @param { SubWindowOptions } options - options of sub window creation 8374 * @returns { Promise<Window> } Promise used to return the subwindow. 8375 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8376 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 8377 * @throws { BusinessError } 1300002 - This window state is abnormal. 8378 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8379 * @syscap SystemCapability.Window.SessionManager 8380 * @StageModelOnly 8381 * @atomicservice 8382 * @since 12 8383 */ 8384 createSubWindowWithOptions(name: string, options: SubWindowOptions): Promise<Window>; 8385 /** 8386 * Get sub window of the stage. 8387 * 8388 * @returns { Promise<Array<Window>> } 8389 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8390 * @syscap SystemCapability.WindowManager.WindowManager.Core 8391 * @StageModelOnly 8392 * @since 9 8393 */ 8394 /** 8395 * Get sub window of the stage. 8396 * 8397 * @returns { Promise<Array<Window>> } 8398 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8399 * @syscap SystemCapability.WindowManager.WindowManager.Core 8400 * @StageModelOnly 8401 * @crossplatform 8402 * @since 10 8403 */ 8404 /** 8405 * Get sub window of the stage. 8406 * 8407 * @returns { Promise<Array<Window>> } 8408 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8409 * @syscap SystemCapability.WindowManager.WindowManager.Core 8410 * @StageModelOnly 8411 * @crossplatform 8412 * @atomicservice 8413 * @since 11 8414 */ 8415 getSubWindow(): Promise<Array<Window>>; 8416 /** 8417 * Get sub window of the stage. 8418 * 8419 * @param { AsyncCallback<Array<Window>> } callback Callback used to return all the subwindows. 8420 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8421 * @syscap SystemCapability.WindowManager.WindowManager.Core 8422 * @StageModelOnly 8423 * @since 9 8424 */ 8425 /** 8426 * Get sub window of the stage. 8427 * 8428 * @param { AsyncCallback<Array<Window>> } callback Callback used to return all the subwindows. 8429 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8430 * @syscap SystemCapability.WindowManager.WindowManager.Core 8431 * @StageModelOnly 8432 * @crossplatform 8433 * @since 10 8434 */ 8435 /** 8436 * Get sub window of the stage. 8437 * 8438 * @param { AsyncCallback<Array<Window>> } callback Callback used to return all the subwindows. 8439 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8440 * @syscap SystemCapability.WindowManager.WindowManager.Core 8441 * @StageModelOnly 8442 * @crossplatform 8443 * @atomicservice 8444 * @since 11 8445 */ 8446 getSubWindow(callback: AsyncCallback<Array<Window>>): void; 8447 /** 8448 * Loads content 8449 * 8450 * @param { string } path Path of the page to which the content will be loaded 8451 * @param { LocalStorage } storage The data object shared within the content instance loaded by the window 8452 * @param { AsyncCallback<void> } callback Callback used to return the result. 8453 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8454 * 2. Incorrect parameter types. 8455 * @throws { BusinessError } 1300002 - This window state is abnormal. 8456 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8457 * @syscap SystemCapability.WindowManager.WindowManager.Core 8458 * @StageModelOnly 8459 * @since 9 8460 */ 8461 /** 8462 * Loads content 8463 * 8464 * @param { string } path Path of the page to which the content will be loaded 8465 * @param { LocalStorage } storage The data object shared within the content instance loaded by the window 8466 * @param { AsyncCallback<void> } callback Callback used to return the result. 8467 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8468 * 2. Incorrect parameter types. 8469 * @throws { BusinessError } 1300002 - This window state is abnormal. 8470 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8471 * @syscap SystemCapability.WindowManager.WindowManager.Core 8472 * @StageModelOnly 8473 * @crossplatform 8474 * @since 10 8475 */ 8476 /** 8477 * Loads content 8478 * 8479 * @param { string } path Path of the page to which the content will be loaded 8480 * @param { LocalStorage } storage The data object shared within the content instance loaded by the window 8481 * @param { AsyncCallback<void> } callback Callback used to return the result. 8482 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8483 * 2. Incorrect parameter types. 8484 * @throws { BusinessError } 1300002 - This window state is abnormal. 8485 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8486 * @syscap SystemCapability.WindowManager.WindowManager.Core 8487 * @StageModelOnly 8488 * @crossplatform 8489 * @atomicservice 8490 * @since 11 8491 */ 8492 loadContent(path: string, storage: LocalStorage, callback: AsyncCallback<void>): void; 8493 /** 8494 * Loads content 8495 * 8496 * @param { string } path of the page to which the content will be loaded 8497 * @param { LocalStorage } storage The data object shared within the content instance loaded by the window 8498 * @returns { Promise<void> } 8499 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8500 * 2. Incorrect parameter types. 8501 * @throws { BusinessError } 1300002 - This window state is abnormal. 8502 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8503 * @syscap SystemCapability.WindowManager.WindowManager.Core 8504 * @StageModelOnly 8505 * @since 9 8506 */ 8507 /** 8508 * Loads content 8509 * 8510 * @param { string } path of the page to which the content will be loaded 8511 * @param { LocalStorage } storage The data object shared within the content instance loaded by the window 8512 * @returns { Promise<void> } 8513 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8514 * 2. Incorrect parameter types. 8515 * @throws { BusinessError } 1300002 - This window state is abnormal. 8516 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8517 * @syscap SystemCapability.WindowManager.WindowManager.Core 8518 * @StageModelOnly 8519 * @crossplatform 8520 * @since 10 8521 */ 8522 /** 8523 * Loads content 8524 * 8525 * @param { string } path of the page to which the content will be loaded 8526 * @param { LocalStorage } storage The data object shared within the content instance loaded by the window 8527 * @returns { Promise<void> } 8528 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8529 * 2. Incorrect parameter types. 8530 * @throws { BusinessError } 1300002 - This window state is abnormal. 8531 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8532 * @syscap SystemCapability.WindowManager.WindowManager.Core 8533 * @StageModelOnly 8534 * @crossplatform 8535 * @atomicservice 8536 * @since 11 8537 */ 8538 loadContent(path: string, storage?: LocalStorage): Promise<void>; 8539 /** 8540 * Loads content 8541 * 8542 * @param { string } path of the page to which the content will be loaded 8543 * @param { AsyncCallback<void> } callback Callback used to return the result. 8544 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8545 * 2. Incorrect parameter types. 8546 * @throws { BusinessError } 1300002 - This window state is abnormal. 8547 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8548 * @syscap SystemCapability.WindowManager.WindowManager.Core 8549 * @StageModelOnly 8550 * @since 9 8551 */ 8552 /** 8553 * Loads content 8554 * 8555 * @param { string } path of the page to which the content will be loaded 8556 * @param { AsyncCallback<void> } callback Callback used to return the result. 8557 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8558 * 2. Incorrect parameter types. 8559 * @throws { BusinessError } 1300002 - This window state is abnormal. 8560 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8561 * @syscap SystemCapability.WindowManager.WindowManager.Core 8562 * @StageModelOnly 8563 * @crossplatform 8564 * @since 10 8565 */ 8566 /** 8567 * Loads content 8568 * 8569 * @param { string } path of the page to which the content will be loaded 8570 * @param { AsyncCallback<void> } callback Callback used to return the result. 8571 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8572 * 2. Incorrect parameter types. 8573 * @throws { BusinessError } 1300002 - This window state is abnormal. 8574 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8575 * @syscap SystemCapability.WindowManager.WindowManager.Core 8576 * @StageModelOnly 8577 * @crossplatform 8578 * @atomicservice 8579 * @since 11 8580 */ 8581 loadContent(path: string, callback: AsyncCallback<void>): void; 8582 8583 /** 8584 * Loads content by named router 8585 * 8586 * @param { string } name - name of the page to which the content will be loaded. 8587 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window. 8588 * @param { AsyncCallback<void> } callback - Callback used to return the result. 8589 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8590 * 2. Incorrect parameter types. 8591 * @throws { BusinessError } 1300002 - This window state is abnormal. 8592 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 8593 * @syscap SystemCapability.WindowManager.WindowManager.Core 8594 * @stagemodelonly 8595 * @crossplatform 8596 * @atomicservice 8597 * @since 11 8598 */ 8599 loadContentByName(name: string, storage: LocalStorage, callback: AsyncCallback<void>): void; 8600 8601 /** 8602 * Loads content by named router 8603 * 8604 * @param { string } name - name of the page to which the content will be loaded. 8605 * @param { AsyncCallback<void> } callback - Callback used to return the result. 8606 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8607 * 2. Incorrect parameter types. 8608 * @throws { BusinessError } 1300002 - This window state is abnormal. 8609 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 8610 * @syscap SystemCapability.WindowManager.WindowManager.Core 8611 * @stagemodelonly 8612 * @crossplatform 8613 * @atomicservice 8614 * @since 11 8615 */ 8616 loadContentByName(name: string, callback: AsyncCallback<void>): void; 8617 8618 /** 8619 * Loads content by named router 8620 * 8621 * @param { string } name - name of the page to which the content will be loaded. 8622 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window. 8623 * @returns { Promise<void> } Promise that returns no value. 8624 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8625 * 2. Incorrect parameter types. 8626 * @throws { BusinessError } 1300002 - This window state is abnormal. 8627 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 8628 * @syscap SystemCapability.WindowManager.WindowManager.Core 8629 * @stagemodelonly 8630 * @crossplatform 8631 * @atomicservice 8632 * @since 11 8633 */ 8634 loadContentByName(name: string, storage?: LocalStorage): Promise<void>; 8635 8636 /** 8637 * Window stage event callback on. 8638 * 8639 * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. 8640 * @param { Callback<WindowStageEventType> } callback Callback used to return the window stage lifecycle state. 8641 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8642 * 2. Incorrect parameter types; 8643 * 3. Parameter verification failed. 8644 * @throws { BusinessError } 1300002 - This window state is abnormal. 8645 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8646 * @syscap SystemCapability.WindowManager.WindowManager.Core 8647 * @StageModelOnly 8648 * @since 9 8649 */ 8650 /** 8651 * Window stage event callback on. 8652 * 8653 * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. 8654 * @param { Callback<WindowStageEventType> } callback Callback used to return the window stage lifecycle state. 8655 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8656 * 2. Incorrect parameter types; 8657 * 3. Parameter verification failed. 8658 * @throws { BusinessError } 1300002 - This window state is abnormal. 8659 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8660 * @syscap SystemCapability.WindowManager.WindowManager.Core 8661 * @StageModelOnly 8662 * @crossplatform 8663 * @since 10 8664 */ 8665 /** 8666 * Window stage event callback on. 8667 * 8668 * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. 8669 * @param { Callback<WindowStageEventType> } callback Callback used to return the window stage lifecycle state. 8670 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8671 * 2. Incorrect parameter types; 8672 * 3. Parameter verification failed. 8673 * @throws { BusinessError } 1300002 - This window state is abnormal. 8674 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8675 * @syscap SystemCapability.WindowManager.WindowManager.Core 8676 * @StageModelOnly 8677 * @crossplatform 8678 * @atomicservice 8679 * @since 11 8680 */ 8681 on(eventType: 'windowStageEvent', callback: Callback<WindowStageEventType>): void; 8682 /** 8683 * Window stage event callback off. 8684 * 8685 * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. 8686 * @param { Callback<WindowStageEventType> } callback Callback used to return the window stage lifecycle state. 8687 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 8688 * 2. Parameter verification failed. 8689 * @throws { BusinessError } 1300002 - This window state is abnormal. 8690 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8691 * @syscap SystemCapability.WindowManager.WindowManager.Core 8692 * @StageModelOnly 8693 * @since 9 8694 */ 8695 /** 8696 * Window stage event callback off. 8697 * 8698 * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. 8699 * @param { Callback<WindowStageEventType> } callback Callback used to return the window stage lifecycle state. 8700 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 8701 * 2. Parameter verification failed. 8702 * @throws { BusinessError } 1300002 - This window state is abnormal. 8703 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8704 * @syscap SystemCapability.WindowManager.WindowManager.Core 8705 * @StageModelOnly 8706 * @crossplatform 8707 * @since 10 8708 */ 8709 /** 8710 * Window stage event callback off. 8711 * 8712 * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. 8713 * @param { Callback<WindowStageEventType> } callback Callback used to return the window stage lifecycle state. 8714 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 8715 * 2. Parameter verification failed. 8716 * @throws { BusinessError } 1300002 - This window state is abnormal. 8717 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8718 * @syscap SystemCapability.WindowManager.WindowManager.Core 8719 * @StageModelOnly 8720 * @crossplatform 8721 * @atomicservice 8722 * @since 11 8723 */ 8724 off(eventType: 'windowStageEvent', callback?: Callback<WindowStageEventType>): void; 8725 8726 /** 8727 * Disable window decoration. It must be called before loadContent. 8728 * 8729 * @throws { BusinessError } 1300002 - This window state is abnormal. 8730 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8731 * @syscap SystemCapability.WindowManager.WindowManager.Core 8732 * @systemapi 8733 * @StageModelOnly 8734 * @since 9 8735 */ 8736 /** 8737 * Disable window decoration. It must be called before loadContent. 8738 * 8739 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 8740 * @throws { BusinessError } 1300002 - This window state is abnormal. 8741 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8742 * @syscap SystemCapability.WindowManager.WindowManager.Core 8743 * @systemapi 8744 * @StageModelOnly 8745 * @since 12 8746 */ 8747 disableWindowDecor(): void; 8748 8749 /** 8750 * Sets whether can show on lock screen or not 8751 * 8752 * @param { boolean } showOnLockScreen can show on lock screen if true, or not if false 8753 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8754 * 2. Incorrect parameter types. 8755 * @throws { BusinessError } 1300002 - This window state is abnormal. 8756 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8757 * @syscap SystemCapability.WindowManager.WindowManager.Core 8758 * @systemapi Hide this for inner system use. 8759 * @StageModelOnly 8760 * @since 9 8761 */ 8762 /** 8763 * Sets whether can show on lock screen or not 8764 * 8765 * @param { boolean } showOnLockScreen can show on lock screen if true, or not if false 8766 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 8767 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8768 * 2. Incorrect parameter types. 8769 * @throws { BusinessError } 1300002 - This window state is abnormal. 8770 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8771 * @syscap SystemCapability.WindowManager.WindowManager.Core 8772 * @systemapi Hide this for inner system use. 8773 * @StageModelOnly 8774 * @since 12 8775 */ 8776 setShowOnLockScreen(showOnLockScreen: boolean): void; 8777 8778 /** 8779 * Set whether to use default density. 8780 * 8781 * @param { boolean } enabled - Use default density if true, or follow system density change if false 8782 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8783 * 2. Incorrect parameter types. 8784 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 8785 * @throws { BusinessError } 1300002 - This window state is abnormal. 8786 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8787 * @syscap SystemCapability.Window.SessionManager 8788 * @StageModelOnly 8789 * @atomicservice 8790 * @since 12 8791 */ 8792 setDefaultDensityEnabled(enabled: boolean): void; 8793 } 8794} 8795 8796export default window; 8797