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 * Get windows by coordinate. 2890 * 2891 * @param { number } displayId - Indicate the id of display. 2892 * @param { number } windowNumber - Indicate the Number of query windows. 2893 * @param { number } x - Indicate the X-coordinate of the window. 2894 * @param { number } y - Indicate the Y-coordinate of the window. 2895 * @returns { Promise<Array<Window>> } Promise used to return the window. 2896 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 2897 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 2898 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2899 * @syscap SystemCapability.Window.SessionManager 2900 * @atomicservice 2901 * @since 14 2902 */ 2903 function getWindowsByCoordinate(displayId: number, windowNumber?: number, x?: number, y?: number): Promise<Array<Window>>; 2904 2905 /** 2906 * Register the callback of systemBarTintChange 2907 * 2908 * @param { 'systemBarTintChange' } type - The value is fixed at 'systemBarTintChange', indicating the property change event of the system bar. 2909 * @param { Callback<SystemBarTintState> } callback - Callback used to return the properties of the system bar. 2910 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2911 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 2912 * 2. Incorrect parameter types; 2913 * 3. Parameter verification failed. 2914 * @syscap SystemCapability.WindowManager.WindowManager.Core 2915 * @systemapi Hide this for inner system use. 2916 * @since 8 2917 */ 2918 function on(type: 'systemBarTintChange', callback: Callback<SystemBarTintState>): void; 2919 2920 /** 2921 * Unregister the callback of systemBarTintChange 2922 * 2923 * @param { 'systemBarTintChange' } type - The value is fixed at 'systemBarTintChange', indicating the property change event of the system bar. 2924 * @param { Callback<SystemBarTintState> } callback - Callback used to return the properties of the system bar. 2925 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2926 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 2927 * 2. Parameter verification failed. 2928 * @syscap SystemCapability.WindowManager.WindowManager.Core 2929 * @systemapi Hide this for inner system use. 2930 * @since 8 2931 */ 2932 function off(type: 'systemBarTintChange', callback?: Callback<SystemBarTintState>): void; 2933 2934 /** 2935 * Register 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. Mandatory parameters are left unspecified; 2941 * 2. Incorrect parameter types. 2942 * 3. Parameter verification failed. 2943 * @throws { BusinessError } 1300002 - This window state is abnormal. 2944 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2945 * @syscap SystemCapability.WindowManager.WindowManager.Core 2946 * @systemapi Hide this for inner system use. 2947 * @since 10 2948 */ 2949 function on(type: 'gestureNavigationEnabledChange', callback: Callback<boolean>): void; 2950 2951 /** 2952 * Unregister the callback for gesture navigation enabled changes. 2953 * 2954 * @param { 'gestureNavigationEnabledChange' } type the event of gesture navigation enabled changes. 2955 * @param { Callback<boolean> } callback Callback used to return the result whether gesture navigation enabled or not. 2956 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2957 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 2958 * 2. Parameter verification failed. 2959 * @throws { BusinessError } 1300002 - This window state is abnormal. 2960 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2961 * @syscap SystemCapability.WindowManager.WindowManager.Core 2962 * @systemapi Hide this for inner system use. 2963 * @since 10 2964 */ 2965 function off(type: 'gestureNavigationEnabledChange', callback?: Callback<boolean>): void; 2966 2967 /** 2968 * Register the callback for watermark flag change. 2969 * 2970 * @param { 'waterMarkFlagChange' } type the event of watermark flag change. 2971 * @param { Callback<boolean> } callback Callback used to return the result whether watermark flag change or not. 2972 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2973 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2974 * <br>2. Incorrect parameter types. 3.Parameter verification failed. 2975 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2976 * @syscap SystemCapability.WindowManager.WindowManager.Core 2977 * @systemapi Hide this for inner system use. 2978 * @since 10 2979 */ 2980 function on(type: 'waterMarkFlagChange', callback: Callback<boolean>): void; 2981 2982 /** 2983 * Unregister the callback for watermark flag change. 2984 * 2985 * @param { 'waterMarkFlagChange' } type the event of watermark flag change. 2986 * @param { Callback<boolean> } callback Callback used to return the result whether watermark flag change or not. 2987 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 2988 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 2989 * <br>2. Parameter verification failed. 2990 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 2991 * @syscap SystemCapability.WindowManager.WindowManager.Core 2992 * @systemapi Hide this for inner system use. 2993 * @since 10 2994 */ 2995 function off(type: 'waterMarkFlagChange', callback?: Callback<boolean>): void; 2996 /** 2997 * Display orientation 2998 * 2999 * @enum { number } 3000 * @syscap SystemCapability.WindowManager.WindowManager.Core 3001 * @since 9 3002 */ 3003 /** 3004 * Display orientation 3005 * 3006 * @enum { number } 3007 * @syscap SystemCapability.WindowManager.WindowManager.Core 3008 * @crossplatform 3009 * @since 10 3010 */ 3011 /** 3012 * Display orientation 3013 * 3014 * @enum { number } 3015 * @syscap SystemCapability.WindowManager.WindowManager.Core 3016 * @crossplatform 3017 * @atomicservice 3018 * @since 11 3019 */ 3020 enum Orientation { 3021 /** 3022 * Default value. The direction mode is not clearly defined. It is determined by the system. 3023 * 3024 * @syscap SystemCapability.WindowManager.WindowManager.Core 3025 * @since 9 3026 */ 3027 /** 3028 * Default value. The direction mode is not clearly defined. It is determined by the system. 3029 * 3030 * @syscap SystemCapability.WindowManager.WindowManager.Core 3031 * @crossplatform 3032 * @since 10 3033 */ 3034 /** 3035 * Default value. The direction mode is not clearly defined. It is determined by the system. 3036 * 3037 * @syscap SystemCapability.WindowManager.WindowManager.Core 3038 * @crossplatform 3039 * @atomicservice 3040 * @since 12 3041 */ 3042 UNSPECIFIED = 0, 3043 3044 /** 3045 * Display in portrait orientation. 3046 * 3047 * @syscap SystemCapability.WindowManager.WindowManager.Core 3048 * @since 9 3049 */ 3050 /** 3051 * Display in portrait orientation. 3052 * 3053 * @syscap SystemCapability.WindowManager.WindowManager.Core 3054 * @crossplatform 3055 * @since 10 3056 */ 3057 /** 3058 * Display in portrait orientation. 3059 * 3060 * @syscap SystemCapability.WindowManager.WindowManager.Core 3061 * @crossplatform 3062 * @atomicservice 3063 * @since 11 3064 */ 3065 PORTRAIT = 1, 3066 3067 /** 3068 * Display in landscape orientation. 3069 * 3070 * @syscap SystemCapability.WindowManager.WindowManager.Core 3071 * @since 9 3072 */ 3073 /** 3074 * Display in landscape orientation. 3075 * 3076 * @syscap SystemCapability.WindowManager.WindowManager.Core 3077 * @crossplatform 3078 * @since 10 3079 */ 3080 /** 3081 * Display in landscape orientation. 3082 * 3083 * @syscap SystemCapability.WindowManager.WindowManager.Core 3084 * @crossplatform 3085 * @atomicservice 3086 * @since 12 3087 */ 3088 LANDSCAPE = 2, 3089 3090 /** 3091 * Display in inverted portrait orientation. 3092 * 3093 * @syscap SystemCapability.WindowManager.WindowManager.Core 3094 * @since 9 3095 */ 3096 /** 3097 * Display in inverted portrait orientation. 3098 * 3099 * @syscap SystemCapability.WindowManager.WindowManager.Core 3100 * @crossplatform 3101 * @since 10 3102 */ 3103 /** 3104 * Display in inverted portrait orientation. 3105 * 3106 * @syscap SystemCapability.WindowManager.WindowManager.Core 3107 * @crossplatform 3108 * @atomicservice 3109 * @since 12 3110 */ 3111 PORTRAIT_INVERTED = 3, 3112 3113 /** 3114 * Display in inverted landscape orientation. 3115 * 3116 * @syscap SystemCapability.WindowManager.WindowManager.Core 3117 * @since 9 3118 */ 3119 /** 3120 * Display in inverted landscape orientation. 3121 * 3122 * @syscap SystemCapability.WindowManager.WindowManager.Core 3123 * @crossplatform 3124 * @since 10 3125 */ 3126 /** 3127 * Display in inverted landscape orientation. 3128 * 3129 * @syscap SystemCapability.WindowManager.WindowManager.Core 3130 * @crossplatform 3131 * @atomicservice 3132 * @since 12 3133 */ 3134 LANDSCAPE_INVERTED = 4, 3135 3136 /** 3137 * Follow the rotation of the sensor, ignore auto rotation lock. 3138 * 3139 * @syscap SystemCapability.WindowManager.WindowManager.Core 3140 * @since 9 3141 */ 3142 /** 3143 * Follow the rotation of the sensor, ignore auto rotation lock. 3144 * 3145 * @syscap SystemCapability.WindowManager.WindowManager.Core 3146 * @atomicservice 3147 * @since 11 3148 */ 3149 AUTO_ROTATION = 5, 3150 3151 /** 3152 * Follow the rotation of the sensor, only work in the vertical direction, ignore auto rotation lock. 3153 * 3154 * @syscap SystemCapability.WindowManager.WindowManager.Core 3155 * @since 9 3156 */ 3157 /** 3158 * Follow the rotation of the sensor, only work in the vertical direction, ignore auto rotation lock. 3159 * 3160 * @syscap SystemCapability.WindowManager.WindowManager.Core 3161 * @atomicservice 3162 * @since 12 3163 */ 3164 AUTO_ROTATION_PORTRAIT = 6, 3165 3166 /** 3167 * Follow the rotation of the sensor, only work in the horizontal direction, ignore auto rotation lock. 3168 * 3169 * @syscap SystemCapability.WindowManager.WindowManager.Core 3170 * @since 9 3171 */ 3172 /** 3173 * Follow the rotation of the sensor, only work in the horizontal direction, ignore auto rotation lock. 3174 * 3175 * @syscap SystemCapability.WindowManager.WindowManager.Core 3176 * @atomicservice 3177 * @since 12 3178 */ 3179 AUTO_ROTATION_LANDSCAPE = 7, 3180 3181 /** 3182 * Follow the rotation of the sensor, controlled by auto rotation lock. 3183 * 3184 * @syscap SystemCapability.WindowManager.WindowManager.Core 3185 * @since 9 3186 */ 3187 /** 3188 * Follow the rotation of the sensor, controlled by auto rotation lock. 3189 * 3190 * @syscap SystemCapability.WindowManager.WindowManager.Core 3191 * @atomicservice 3192 * @since 12 3193 */ 3194 AUTO_ROTATION_RESTRICTED = 8, 3195 3196 /** 3197 * Follow the rotation of the sensor, only work in the vertical direction, controlled by auto rotation lock. 3198 * 3199 * @syscap SystemCapability.WindowManager.WindowManager.Core 3200 * @since 9 3201 */ 3202 /** 3203 * Follow the rotation of the sensor, only work in the vertical direction, controlled by auto rotation lock. 3204 * 3205 * @syscap SystemCapability.WindowManager.WindowManager.Core 3206 * @atomicservice 3207 * @since 12 3208 */ 3209 AUTO_ROTATION_PORTRAIT_RESTRICTED = 9, 3210 3211 /** 3212 * Follow the rotation of the sensor, only work in the horizontal direction, controlled by auto rotation lock. 3213 * 3214 * @syscap SystemCapability.WindowManager.WindowManager.Core 3215 * @since 9 3216 */ 3217 /** 3218 * Follow the rotation of the sensor, only work in the horizontal direction, controlled by auto rotation lock. 3219 * 3220 * @syscap SystemCapability.WindowManager.WindowManager.Core 3221 * @atomicservice 3222 * @since 12 3223 */ 3224 AUTO_ROTATION_LANDSCAPE_RESTRICTED = 10, 3225 3226 /** 3227 * Locked mode, keep the same direction as previous one. 3228 * 3229 * @syscap SystemCapability.WindowManager.WindowManager.Core 3230 * @since 9 3231 */ 3232 /** 3233 * Locked mode, keep the same direction as previous one. 3234 * 3235 * @syscap SystemCapability.WindowManager.WindowManager.Core 3236 * @atomicservice 3237 * @since 12 3238 */ 3239 LOCKED = 11, 3240 3241 /** 3242 * Follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. 3243 * 3244 * @syscap SystemCapability.Window.SessionManager 3245 * @atomicservice 3246 * @since 12 3247 */ 3248 AUTO_ROTATION_UNSPECIFIED = 12, 3249 3250 /** 3251 * Display in portrait orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. 3252 * 3253 * @syscap SystemCapability.Window.SessionManager 3254 * @atomicservice 3255 * @since 12 3256 */ 3257 USER_ROTATION_PORTRAIT = 13, 3258 3259 /** 3260 * Display in landscape orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. 3261 * 3262 * @syscap SystemCapability.Window.SessionManager 3263 * @atomicservice 3264 * @since 12 3265 */ 3266 USER_ROTATION_LANDSCAPE = 14, 3267 3268 /** 3269 * Display in inverted portrait orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. 3270 * 3271 * @syscap SystemCapability.Window.SessionManager 3272 * @atomicservice 3273 * @since 12 3274 */ 3275 USER_ROTATION_PORTRAIT_INVERTED = 15, 3276 3277 /** 3278 * Display in inverted landscape orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock. 3279 * 3280 * @syscap SystemCapability.Window.SessionManager 3281 * @atomicservice 3282 * @since 12 3283 */ 3284 USER_ROTATION_LANDSCAPE_INVERTED = 16, 3285 3286 /** 3287 * Follow the desktop rotate mode. 3288 * 3289 * @syscap SystemCapability.Window.SessionManager 3290 * @atomicservice 3291 * @since 12 3292 */ 3293 FOLLOW_DESKTOP = 17 3294 } 3295 3296 /** 3297 * Type of blur style 3298 * 3299 * @enum { number } 3300 * @syscap SystemCapability.WindowManager.WindowManager.Core 3301 * @systemapi Hide this for inner system use. 3302 * @since 9 3303 */ 3304 enum BlurStyle { 3305 /** 3306 * Close blur. 3307 * 3308 * @syscap SystemCapability.WindowManager.WindowManager.Core 3309 * @systemapi Hide this for inner system use. 3310 * @since 9 3311 */ 3312 OFF, 3313 /** 3314 * Blur style thin. 3315 * 3316 * @syscap SystemCapability.WindowManager.WindowManager.Core 3317 * @systemapi Hide this for inner system use. 3318 * @since 9 3319 */ 3320 THIN, 3321 /** 3322 * Blur style regular. 3323 * 3324 * @syscap SystemCapability.WindowManager.WindowManager.Core 3325 * @systemapi Hide this for inner system use. 3326 * @since 9 3327 */ 3328 REGULAR, 3329 /** 3330 * Blur style thick. 3331 * 3332 * @syscap SystemCapability.WindowManager.WindowManager.Core 3333 * @systemapi Hide this for inner system use. 3334 * @since 9 3335 */ 3336 THICK 3337 } 3338 3339 /** 3340 * Enum for window callback event type 3341 * 3342 * @enum { number } 3343 * @syscap SystemCapability.WindowManager.WindowManager.Core 3344 * @since 10 3345 */ 3346 /** 3347 * Enum for window callback event type 3348 * 3349 * @enum { number } 3350 * @syscap SystemCapability.WindowManager.WindowManager.Core 3351 * @crossplatform 3352 * @atomicservice 3353 * @since 11 3354 */ 3355 enum WindowEventType { 3356 /** 3357 * The value of window event is window show 3358 * 3359 * @syscap SystemCapability.WindowManager.WindowManager.Core 3360 * @since 10 3361 */ 3362 /** 3363 * The value of window event is window show 3364 * 3365 * @syscap SystemCapability.WindowManager.WindowManager.Core 3366 * @crossplatform 3367 * @atomicservice 3368 * @since 11 3369 */ 3370 WINDOW_SHOWN = 1, 3371 /** 3372 * The value of window event is window active 3373 * 3374 * @syscap SystemCapability.WindowManager.WindowManager.Core 3375 * @since 10 3376 */ 3377 /** 3378 * The value of window event is window active 3379 * 3380 * @syscap SystemCapability.WindowManager.WindowManager.Core 3381 * @crossplatform 3382 * @atomicservice 3383 * @since 11 3384 */ 3385 WINDOW_ACTIVE = 2, 3386 /** 3387 * The value of window event is window inactive 3388 * 3389 * @syscap SystemCapability.WindowManager.WindowManager.Core 3390 * @since 10 3391 */ 3392 /** 3393 * The value of window event is window inactive 3394 * 3395 * @syscap SystemCapability.WindowManager.WindowManager.Core 3396 * @crossplatform 3397 * @atomicservice 3398 * @since 11 3399 */ 3400 WINDOW_INACTIVE = 3, 3401 /** 3402 * The value of window event is window hide 3403 * 3404 * @syscap SystemCapability.WindowManager.WindowManager.Core 3405 * @since 10 3406 */ 3407 /** 3408 * The value of window event is window hide 3409 * 3410 * @syscap SystemCapability.WindowManager.WindowManager.Core 3411 * @crossplatform 3412 * @atomicservice 3413 * @since 11 3414 */ 3415 WINDOW_HIDDEN = 4, 3416 /** 3417 * The value of window event is window destroy 3418 * 3419 * @syscap SystemCapability.Window.SessionManager 3420 * @atomicservice 3421 * @since 11 3422 */ 3423 WINDOW_DESTROYED = 7 3424 } 3425 3426 /** 3427 * Enum for window maximize presentation 3428 * 3429 * @enum { number } 3430 * @syscap SystemCapability.Window.SessionManager 3431 * @atomicservice 3432 * @since 12 3433 */ 3434 enum MaximizePresentation { 3435 /** 3436 * The value means follow immersive state which set by app 3437 * 3438 * @syscap SystemCapability.Window.SessionManager 3439 * @atomicservice 3440 * @since 12 3441 */ 3442 FOLLOW_APP_IMMERSIVE_SETTING = 0, 3443 /** 3444 * The value means exit immersive state 3445 * 3446 * @syscap SystemCapability.Window.SessionManager 3447 * @atomicservice 3448 * @since 12 3449 */ 3450 EXIT_IMMERSIVE = 1, 3451 /** 3452 * The value means enter immersive state 3453 * 3454 * @syscap SystemCapability.Window.SessionManager 3455 * @atomicservice 3456 * @since 12 3457 */ 3458 ENTER_IMMERSIVE = 2, 3459 /** 3460 * The value means enter immersive state and the title bar and dock bar cannot be shown, when the mouse hovers over hot area. 3461 * 3462 * @syscap SystemCapability.Window.SessionManager 3463 * @atomicservice 3464 * @since 14 3465 */ 3466 ENTER_IMMERSIVE_DISABLE_TITLE_AND_DOCK_HOVER = 3, 3467 } 3468 3469 /** 3470 * Specific system bar type. 3471 * 3472 * @syscap SystemCapability.Window.SessionManager 3473 * @atomicservice 3474 * @since 11 3475 */ 3476 /** 3477 * Specific system bar type. 3478 * 3479 * @typedef {'status' | 'navigation' | 'navigationIndicator'} 3480 * @syscap SystemCapability.Window.SessionManager 3481 * @crossplatform 3482 * @atomicservice 3483 * @since 12 3484 */ 3485 type SpecificSystemBar = 'status' | 'navigation' | 'navigationIndicator'; 3486 3487 /** 3488 * Window 3489 * 3490 * @interface Window 3491 * @syscap SystemCapability.WindowManager.WindowManager.Core 3492 * @since 6 3493 */ 3494 /** 3495 * Window 3496 * 3497 * @interface Window 3498 * @syscap SystemCapability.WindowManager.WindowManager.Core 3499 * @crossplatform 3500 * @atomicservice 3501 * @since 11 3502 */ 3503 interface Window { 3504 /** 3505 * Hide window. 3506 * 3507 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3508 * @throws { BusinessError } 1300002 - This window state is abnormal. 3509 * @syscap SystemCapability.WindowManager.WindowManager.Core 3510 * @systemapi Hide this for inner system use. 3511 * @since 7 3512 */ 3513 /** 3514 * Hide window. 3515 * 3516 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3517 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 3518 * @throws { BusinessError } 1300002 - This window state is abnormal. 3519 * @syscap SystemCapability.WindowManager.WindowManager.Core 3520 * @systemapi Hide this for inner system use. 3521 * @since 12 3522 */ 3523 hide(callback: AsyncCallback<void>): void; 3524 3525 /** 3526 * Hide window. 3527 * 3528 * @returns { Promise<void> } Promise that returns no value. 3529 * @throws { BusinessError } 1300002 - This window state is abnormal. 3530 * @syscap SystemCapability.WindowManager.WindowManager.Core 3531 * @systemapi Hide this for inner system use. 3532 * @since 7 3533 */ 3534 /** 3535 * Hide window. 3536 * 3537 * @returns { Promise<void> } Promise that returns no value. 3538 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 3539 * @throws { BusinessError } 1300002 - This window state is abnormal. 3540 * @syscap SystemCapability.WindowManager.WindowManager.Core 3541 * @systemapi Hide this for inner system use. 3542 * @since 12 3543 */ 3544 hide(): Promise<void>; 3545 3546 /** 3547 * Hide window with animation. 3548 * 3549 * @param { AsyncCallback<void> } callback - Callback used to return the result. 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 * @param { AsyncCallback<void> } callback - Callback used to return the result. 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(callback: AsyncCallback<void>): void; 3570 3571 /** 3572 * Hide window with animation. 3573 * 3574 * @returns { Promise<void> } Promise that returns no value. 3575 * @throws { BusinessError } 1300002 - This window state is abnormal. 3576 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3577 * @throws { BusinessError } 1300004 - Unauthorized operation. 3578 * @syscap SystemCapability.WindowManager.WindowManager.Core 3579 * @systemapi 3580 * @since 9 3581 */ 3582 /** 3583 * Hide window with animation. 3584 * 3585 * @returns { Promise<void> } Promise that returns no value. 3586 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 3587 * @throws { BusinessError } 1300002 - This window state is abnormal. 3588 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3589 * @throws { BusinessError } 1300004 - Unauthorized operation. 3590 * @syscap SystemCapability.WindowManager.WindowManager.Core 3591 * @systemapi 3592 * @since 12 3593 */ 3594 hideWithAnimation(): Promise<void>; 3595 3596 /** 3597 * Show window. 3598 * 3599 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3600 * @syscap SystemCapability.WindowManager.WindowManager.Core 3601 * @since 7 3602 * @deprecated since 9 3603 * @useinstead ohos.window.Window#showWindow 3604 */ 3605 show(callback: AsyncCallback<void>): void; 3606 3607 /** 3608 * Show window. 3609 * 3610 * @returns { Promise<void> } Promise that returns no value. 3611 * @syscap SystemCapability.WindowManager.WindowManager.Core 3612 * @since 7 3613 * @deprecated since 9 3614 * @useinstead ohos.window.Window#showWindow 3615 */ 3616 show(): Promise<void>; 3617 3618 /** 3619 * Show window. 3620 * 3621 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3622 * @throws { BusinessError } 1300002 - This window state is abnormal. 3623 * @syscap SystemCapability.WindowManager.WindowManager.Core 3624 * @since 9 3625 */ 3626 /** 3627 * Show window. 3628 * 3629 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3630 * @throws { BusinessError } 1300002 - This window state is abnormal. 3631 * @syscap SystemCapability.WindowManager.WindowManager.Core 3632 * @crossplatform 3633 * @since 10 3634 */ 3635 /** 3636 * Show window. 3637 * 3638 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3639 * @throws { BusinessError } 1300002 - This window state is abnormal. 3640 * @syscap SystemCapability.WindowManager.WindowManager.Core 3641 * @crossplatform 3642 * @atomicservice 3643 * @since 11 3644 */ 3645 showWindow(callback: AsyncCallback<void>): void; 3646 3647 /** 3648 * Show window. 3649 * 3650 * @returns { Promise<void> } Promise that returns no value. 3651 * @throws { BusinessError } 1300002 - This window state is abnormal. 3652 * @syscap SystemCapability.WindowManager.WindowManager.Core 3653 * @since 9 3654 */ 3655 /** 3656 * Show window. 3657 * 3658 * @returns { Promise<void> } Promise that returns no value. 3659 * @throws { BusinessError } 1300002 - This window state is abnormal. 3660 * @syscap SystemCapability.WindowManager.WindowManager.Core 3661 * @crossplatform 3662 * @since 10 3663 */ 3664 /** 3665 * Show window. 3666 * 3667 * @returns { Promise<void> } Promise that returns no value. 3668 * @throws { BusinessError } 1300002 - This window state is abnormal. 3669 * @syscap SystemCapability.WindowManager.WindowManager.Core 3670 * @crossplatform 3671 * @atomicservice 3672 * @since 11 3673 */ 3674 showWindow(): Promise<void>; 3675 3676 /** 3677 * Show window with animation. 3678 * 3679 * @param { AsyncCallback<void> } callback - Callback used to return the result. 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 * @param { AsyncCallback<void> } callback - Callback used to return the result. 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(callback: AsyncCallback<void>): void; 3700 3701 /** 3702 * Show window with animation. 3703 * 3704 * @returns { Promise<void> } Promise that returns no value. 3705 * @throws { BusinessError } 1300002 - This window state is abnormal. 3706 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3707 * @throws { BusinessError } 1300004 - Unauthorized operation. 3708 * @syscap SystemCapability.WindowManager.WindowManager.Core 3709 * @systemapi 3710 * @since 9 3711 */ 3712 /** 3713 * Show window with animation. 3714 * 3715 * @returns { Promise<void> } Promise that returns no value. 3716 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 3717 * @throws { BusinessError } 1300002 - This window state is abnormal. 3718 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3719 * @throws { BusinessError } 1300004 - Unauthorized operation. 3720 * @syscap SystemCapability.WindowManager.WindowManager.Core 3721 * @systemapi 3722 * @since 12 3723 */ 3724 showWithAnimation(): Promise<void>; 3725 3726 /** 3727 * Destroy the window. 3728 * 3729 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3730 * @syscap SystemCapability.WindowManager.WindowManager.Core 3731 * @since 7 3732 * @deprecated since 9 3733 * @useinstead ohos.window.Window#destroyWindow 3734 */ 3735 destroy(callback: AsyncCallback<void>): void; 3736 3737 /** 3738 * Destroy the window. 3739 * 3740 * @returns { Promise<void> } Promise that returns no value. 3741 * @syscap SystemCapability.WindowManager.WindowManager.Core 3742 * @since 7 3743 * @deprecated since 9 3744 * @useinstead ohos.window.Window#destroyWindow 3745 */ 3746 destroy(): Promise<void>; 3747 3748 /** 3749 * Destroy the window. 3750 * 3751 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3752 * @throws { BusinessError } 1300002 - This window state is abnormal. 3753 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3754 * @syscap SystemCapability.WindowManager.WindowManager.Core 3755 * @since 9 3756 */ 3757 /** 3758 * Destroy the window. 3759 * 3760 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3761 * @throws { BusinessError } 1300002 - This window state is abnormal. 3762 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3763 * @syscap SystemCapability.WindowManager.WindowManager.Core 3764 * @crossplatform 3765 * @since 10 3766 */ 3767 /** 3768 * Destroy the window. 3769 * 3770 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3771 * @throws { BusinessError } 1300002 - This window state is abnormal. 3772 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3773 * @syscap SystemCapability.WindowManager.WindowManager.Core 3774 * @crossplatform 3775 * @atomicservice 3776 * @since 11 3777 */ 3778 destroyWindow(callback: AsyncCallback<void>): void; 3779 3780 /** 3781 * Destroy the window. 3782 * 3783 * @returns { Promise<void> } Promise that returns no value. 3784 * @throws { BusinessError } 1300002 - This window state is abnormal. 3785 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3786 * @syscap SystemCapability.WindowManager.WindowManager.Core 3787 * @since 9 3788 */ 3789 /** 3790 * Destroy the window. 3791 * 3792 * @returns { Promise<void> } Promise that returns no value. 3793 * @throws { BusinessError } 1300002 - This window state is abnormal. 3794 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3795 * @syscap SystemCapability.WindowManager.WindowManager.Core 3796 * @crossplatform 3797 * @since 10 3798 */ 3799 /** 3800 * Destroy the window. 3801 * 3802 * @returns { Promise<void> } Promise that returns no value. 3803 * @throws { BusinessError } 1300002 - This window state is abnormal. 3804 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3805 * @syscap SystemCapability.WindowManager.WindowManager.Core 3806 * @crossplatform 3807 * @atomicservice 3808 * @since 11 3809 */ 3810 destroyWindow(): Promise<void>; 3811 3812 /** 3813 * Set the position of a window. 3814 * 3815 * @param { number } x - Indicate the X-coordinate of the window. 3816 * @param { number } y - Indicate the Y-coordinate of the window. 3817 * @returns { Promise<void> } Promise that returns no value. 3818 * @syscap SystemCapability.WindowManager.WindowManager.Core 3819 * @since 7 3820 * @deprecated since 9 3821 * @useinstead ohos.window.Window#moveWindowTo 3822 */ 3823 moveTo(x: number, y: number): Promise<void>; 3824 3825 /** 3826 * Set the position of a window. 3827 * 3828 * @param { number } x - Indicate the X-coordinate of the window. 3829 * @param { number } y - Indicate the Y-coordinate of the window. 3830 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3831 * @syscap SystemCapability.WindowManager.WindowManager.Core 3832 * @since 7 3833 * @deprecated since 9 3834 * @useinstead ohos.window.Window#moveWindowTo 3835 */ 3836 moveTo(x: number, y: number, callback: AsyncCallback<void>): void; 3837 3838 /** 3839 * Set the position of a window. 3840 * 3841 * @param { number } x - Indicate the X-coordinate of the window. 3842 * @param { number } y - Indicate the Y-coordinate of the window. 3843 * @returns { Promise<void> } Promise that returns no value. 3844 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3845 * 2. Incorrect parameter types. 3846 * @throws { BusinessError } 1300002 - This window state is abnormal. 3847 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3848 * @syscap SystemCapability.WindowManager.WindowManager.Core 3849 * @since 9 3850 */ 3851 /** 3852 * Set the position of a window. 3853 * 3854 * @param { number } x - Indicate the X-coordinate of the window. 3855 * @param { number } y - Indicate the Y-coordinate of the window. 3856 * @returns { Promise<void> } Promise that returns no value. 3857 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3858 * 2. Incorrect parameter types. 3859 * @throws { BusinessError } 1300002 - This window state is abnormal. 3860 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3861 * @syscap SystemCapability.WindowManager.WindowManager.Core 3862 * @crossplatform 3863 * @since 10 3864 */ 3865 /** 3866 * Set the position of a window. 3867 * 3868 * @param { number } x - Indicate the X-coordinate of the window. 3869 * @param { number } y - Indicate the Y-coordinate of the window. 3870 * @returns { Promise<void> } Promise that returns no value. 3871 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3872 * 2. Incorrect parameter types. 3873 * @throws { BusinessError } 1300002 - This window state is abnormal. 3874 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3875 * @syscap SystemCapability.WindowManager.WindowManager.Core 3876 * @crossplatform 3877 * @atomicservice 3878 * @since 11 3879 */ 3880 moveWindowTo(x: number, y: number): Promise<void>; 3881 3882 /** 3883 * Set the position of a window. 3884 * 3885 * @param { number } x - Indicate the X-coordinate of the window. 3886 * @param { number } y - Indicate the Y-coordinate of the window. 3887 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3888 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3889 * 2. Incorrect parameter types. 3890 * @throws { BusinessError } 1300002 - This window state is abnormal. 3891 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3892 * @syscap SystemCapability.WindowManager.WindowManager.Core 3893 * @since 9 3894 */ 3895 /** 3896 * Set the position of a window. 3897 * 3898 * @param { number } x - Indicate the X-coordinate of the window. 3899 * @param { number } y - Indicate the Y-coordinate of the window. 3900 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3901 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3902 * 2. Incorrect parameter types. 3903 * @throws { BusinessError } 1300002 - This window state is abnormal. 3904 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3905 * @syscap SystemCapability.WindowManager.WindowManager.Core 3906 * @crossplatform 3907 * @since 10 3908 */ 3909 /** 3910 * Set the position of a window. 3911 * 3912 * @param { number } x - Indicate the X-coordinate of the window. 3913 * @param { number } y - Indicate the Y-coordinate of the window. 3914 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3915 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3916 * 2. Incorrect parameter types. 3917 * @throws { BusinessError } 1300002 - This window state is abnormal. 3918 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3919 * @syscap SystemCapability.WindowManager.WindowManager.Core 3920 * @crossplatform 3921 * @atomicservice 3922 * @since 11 3923 */ 3924 moveWindowTo(x: number, y: number, callback: AsyncCallback<void>): void; 3925 3926 /** 3927 * Move window to the position. 3928 * 3929 * @param { number } x - Indicate the X-coordinate of the window. 3930 * @param { number } y - Indicate the Y-coordinate of the window. 3931 * @returns { Promise<void> } Promise that returns no value. 3932 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3933 * 2. Incorrect parameter types. 3934 * 3. Parameter verification failed. 3935 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 3936 * @throws { BusinessError } 1300002 - This window state is abnormal. 3937 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3938 * @throws { BusinessError } 1300010 - The operation is not supported in full-screen mode. 3939 * @syscap SystemCapability.Window.SessionManager 3940 * @atomicservice 3941 * @since 12 3942 */ 3943 moveWindowToAsync(x: number, y: number): Promise<void>; 3944 3945 /** 3946 * Set the size of a window . 3947 * 3948 * @param { number } width - Indicates the width of the window. 3949 * @param { number } height - Indicates the height of the window. 3950 * @returns { Promise<void> } Promise that returns no value. 3951 * @syscap SystemCapability.WindowManager.WindowManager.Core 3952 * @since 7 3953 * @deprecated since 9 3954 * @useinstead ohos.window.Window#resize 3955 */ 3956 resetSize(width: number, height: number): Promise<void>; 3957 3958 /** 3959 * Set the size of a window . 3960 * 3961 * @param { number } width - Indicates the width of the window. 3962 * @param { number } height - Indicates the height of the window. 3963 * @param { AsyncCallback<void> } callback - Callback used to return the result. 3964 * @syscap SystemCapability.WindowManager.WindowManager.Core 3965 * @since 7 3966 * @deprecated since 9 3967 * @useinstead ohos.window.Window#resize 3968 */ 3969 resetSize(width: number, height: number, callback: AsyncCallback<void>): void; 3970 3971 /** 3972 * Set the size of a window . 3973 * 3974 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 3975 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 3976 * @returns { Promise<void> } Promise that returns no value. 3977 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3978 * 2. Incorrect parameter types; 3979 * 3. Parameter verification failed. 3980 * @throws { BusinessError } 1300002 - This window state is abnormal. 3981 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3982 * @syscap SystemCapability.WindowManager.WindowManager.Core 3983 * @since 9 3984 */ 3985 /** 3986 * Set the size of a window . 3987 * 3988 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 3989 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 3990 * @returns { Promise<void> } Promise that returns no value. 3991 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 3992 * 2. Incorrect parameter types; 3993 * 3. Parameter verification failed. 3994 * @throws { BusinessError } 1300002 - This window state is abnormal. 3995 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 3996 * @syscap SystemCapability.WindowManager.WindowManager.Core 3997 * @crossplatform 3998 * @since 10 3999 */ 4000 /** 4001 * Set the size of a window . 4002 * 4003 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 4004 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 4005 * @returns { Promise<void> } Promise that returns no value. 4006 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4007 * 2. Incorrect parameter types; 4008 * 3. Parameter verification failed. 4009 * @throws { BusinessError } 1300002 - This window state is abnormal. 4010 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4011 * @syscap SystemCapability.WindowManager.WindowManager.Core 4012 * @crossplatform 4013 * @atomicservice 4014 * @since 11 4015 */ 4016 resize(width: number, height: number): Promise<void>; 4017 4018 /** 4019 * Set the size of a window . 4020 * 4021 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 4022 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 4023 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4024 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4025 * 2. Incorrect parameter types; 4026 * 3. Parameter verification failed. 4027 * @throws { BusinessError } 1300002 - This window state is abnormal. 4028 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4029 * @syscap SystemCapability.WindowManager.WindowManager.Core 4030 * @since 9 4031 */ 4032 /** 4033 * Set the size of a window . 4034 * 4035 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 4036 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 4037 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4038 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4039 * 2. Incorrect parameter types; 4040 * 3. Parameter verification failed. 4041 * @throws { BusinessError } 1300002 - This window state is abnormal. 4042 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4043 * @syscap SystemCapability.WindowManager.WindowManager.Core 4044 * @crossplatform 4045 * @since 10 4046 */ 4047 /** 4048 * Set the size of a window . 4049 * 4050 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 4051 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 4052 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4053 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4054 * 2. Incorrect parameter types; 4055 * 3. Parameter verification failed. 4056 * @throws { BusinessError } 1300002 - This window state is abnormal. 4057 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4058 * @syscap SystemCapability.WindowManager.WindowManager.Core 4059 * @crossplatform 4060 * @atomicservice 4061 * @since 11 4062 */ 4063 resize(width: number, height: number, callback: AsyncCallback<void>): void; 4064 4065 /** 4066 * Set the size of a window. 4067 * 4068 * @param { number } width - Indicates the width of the window. The width should be greater than 0. 4069 * @param { number } height - Indicates the height of the window. The height should be greater than 0. 4070 * @returns { Promise<void> } Promise that returns no value. 4071 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4072 * 2. Incorrect parameter types; 4073 * 3. Parameter verification failed. 4074 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 4075 * @throws { BusinessError } 1300002 - This window state is abnormal. 4076 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4077 * @throws { BusinessError } 1300010 - The operation is not supported in full-screen mode. 4078 * @syscap SystemCapability.Window.SessionManager 4079 * @atomicservice 4080 * @since 12 4081 */ 4082 resizeAsync(width: number, height: number): Promise<void>; 4083 4084 /** 4085 * Set the type of a window. 4086 * 4087 * @param { WindowType } type - Indicate the type of a window. 4088 * @returns { Promise<void> } Promise that returns no value. 4089 * @syscap SystemCapability.WindowManager.WindowManager.Core 4090 * @systemapi Hide this for inner system use. 4091 * @since 7 4092 * @deprecated since 9 4093 */ 4094 setWindowType(type: WindowType): Promise<void>; 4095 4096 /** 4097 * Set the type of a window. 4098 * 4099 * @param { WindowType } type - Indicate the type of a window. 4100 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4101 * @syscap SystemCapability.WindowManager.WindowManager.Core 4102 * @systemapi Hide this for inner system use. 4103 * @since 7 4104 * @deprecated since 9 4105 */ 4106 setWindowType(type: WindowType, callback: AsyncCallback<void>): void; 4107 4108 /** 4109 * Set the mode of a window. 4110 * 4111 * @param { WindowMode } mode - Indicate the mode of a window. 4112 * @returns { Promise<void> } Promise that returns no value. 4113 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4114 * 2. Incorrect parameter types; 4115 * 3. Parameter verification failed. 4116 * @throws { BusinessError } 1300002 - This window state is abnormal. 4117 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4118 * @syscap SystemCapability.WindowManager.WindowManager.Core 4119 * @systemapi Hide this for inner system use. 4120 * @since 9 4121 */ 4122 /** 4123 * Set the mode of a window. 4124 * 4125 * @param { WindowMode } mode - Indicate the mode of a window. 4126 * @returns { Promise<void> } Promise that returns no value. 4127 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 4128 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4129 * 2. Incorrect parameter types; 4130 * 3. Parameter verification failed. 4131 * @throws { BusinessError } 1300002 - This window state is abnormal. 4132 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4133 * @syscap SystemCapability.WindowManager.WindowManager.Core 4134 * @systemapi Hide this for inner system use. 4135 * @since 12 4136 */ 4137 setWindowMode(mode: WindowMode): Promise<void>; 4138 4139 /** 4140 * Set the mode of a window. 4141 * 4142 * @param { WindowMode } mode - Indicate the mode of a window. 4143 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4144 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4145 * 2. Incorrect parameter types; 4146 * 3. Parameter verification failed. 4147 * @throws { BusinessError } 1300002 - This window state is abnormal. 4148 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4149 * @syscap SystemCapability.WindowManager.WindowManager.Core 4150 * @systemapi Hide this for inner system use. 4151 * @since 9 4152 */ 4153 /** 4154 * Set the mode of a window. 4155 * 4156 * @param { WindowMode } mode - Indicate the mode of a window. 4157 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4158 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 4159 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4160 * 2. Incorrect parameter types; 4161 * 3. Parameter verification failed. 4162 * @throws { BusinessError } 1300002 - This window state is abnormal. 4163 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4164 * @syscap SystemCapability.WindowManager.WindowManager.Core 4165 * @systemapi Hide this for inner system use. 4166 * @since 12 4167 */ 4168 setWindowMode(mode: WindowMode, callback: AsyncCallback<void>): void; 4169 4170 /** 4171 * Get the properties of current window 4172 * 4173 * @param { AsyncCallback<WindowProperties> } callback - Callback used to return the window properties. 4174 * @syscap SystemCapability.WindowManager.WindowManager.Core 4175 * @since 6 4176 * @deprecated since 9 4177 * @useinstead ohos.window.Window#getWindowProperties 4178 */ 4179 getProperties(callback: AsyncCallback<WindowProperties>): void; 4180 4181 /** 4182 * Get the properties of current window 4183 * 4184 * @returns { Promise<WindowProperties> } Promise used to return the window properties. 4185 * @syscap SystemCapability.WindowManager.WindowManager.Core 4186 * @since 6 4187 * @deprecated since 9 4188 * @useinstead ohos.window.Window#getWindowProperties 4189 */ 4190 getProperties(): Promise<WindowProperties>; 4191 4192 /** 4193 * Get the properties of current window 4194 * 4195 * @returns { WindowProperties } Return the window properties. 4196 * @throws { BusinessError } 1300002 - This window state is abnormal. 4197 * @syscap SystemCapability.WindowManager.WindowManager.Core 4198 * @since 9 4199 */ 4200 /** 4201 * Get the properties of current window 4202 * 4203 * @returns { WindowProperties } Return the window properties. 4204 * @throws { BusinessError } 1300002 - This window state is abnormal. 4205 * @syscap SystemCapability.WindowManager.WindowManager.Core 4206 * @crossplatform 4207 * @since 10 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 * @atomicservice 4217 * @since 11 4218 */ 4219 getWindowProperties(): WindowProperties; 4220 4221 /** 4222 * Get the avoid area 4223 * 4224 * @param { AvoidAreaType } type - Type of the area 4225 * @param { AsyncCallback<AvoidArea> } callback - Callback used to return the area. 4226 * @syscap SystemCapability.WindowManager.WindowManager.Core 4227 * @since 7 4228 * @deprecated since 9 4229 * @useinstead ohos.window.Window#getWindowAvoidArea 4230 */ 4231 getAvoidArea(type: AvoidAreaType, callback: AsyncCallback<AvoidArea>): void; 4232 4233 /** 4234 * Get the avoid area 4235 * 4236 * @param { AvoidAreaType } type - Type of the area 4237 * @returns { Promise<AvoidArea> } Area where the window cannot be displayed. 4238 * @syscap SystemCapability.WindowManager.WindowManager.Core 4239 * @since 7 4240 * @deprecated since 9 4241 * @useinstead ohos.window.Window#getWindowAvoidArea 4242 */ 4243 getAvoidArea(type: AvoidAreaType): Promise<AvoidArea>; 4244 4245 /** 4246 * Get the avoid area 4247 * 4248 * @param { AvoidAreaType } type - Type of the area 4249 * @returns { AvoidArea } Area where the window cannot be displayed. 4250 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4251 * 2. Incorrect parameter types; 4252 * 3. Parameter verification failed. 4253 * @throws { BusinessError } 1300002 - This window state is abnormal. 4254 * @syscap SystemCapability.WindowManager.WindowManager.Core 4255 * @since 9 4256 */ 4257 /** 4258 * Get the avoid area 4259 * 4260 * @param { AvoidAreaType } type - Type of the area 4261 * @returns { AvoidArea } Area where the window cannot be displayed. 4262 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4263 * 2. Incorrect parameter types; 4264 * 3. Parameter verification failed. 4265 * @throws { BusinessError } 1300002 - This window state is abnormal. 4266 * @syscap SystemCapability.WindowManager.WindowManager.Core 4267 * @atomicservice 4268 * @since 11 4269 */ 4270 /** 4271 * Get the avoid area 4272 * 4273 * @param { AvoidAreaType } type - Type of the area 4274 * @returns { AvoidArea } Area where the window cannot be displayed. 4275 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4276 * 2. Incorrect parameter types; 4277 * 3. Parameter verification failed. 4278 * @throws { BusinessError } 1300002 - This window state is abnormal. 4279 * @syscap SystemCapability.WindowManager.WindowManager.Core 4280 * @crossplatform 4281 * @atomicservice 4282 * @since 12 4283 */ 4284 getWindowAvoidArea(type: AvoidAreaType): AvoidArea; 4285 4286 /** 4287 * Set the flag of the window is shown full screen 4288 * 4289 * @param { boolean } isFullScreen - The flag of the window is shown full screen 4290 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4291 * @syscap SystemCapability.WindowManager.WindowManager.Core 4292 * @since 6 4293 * @deprecated since 9 4294 * @useinstead ohos.window.Window#setWindowSystemBarEnable 4295 */ 4296 setFullScreen(isFullScreen: boolean, callback: AsyncCallback<void>): void; 4297 4298 /** 4299 * Set the flag of the window is shown full screen 4300 * 4301 * @param { boolean } isFullScreen - The flag of the window is shown full screen 4302 * @returns { Promise<void> } Promise that returns no value. 4303 * @syscap SystemCapability.WindowManager.WindowManager.Core 4304 * @since 6 4305 * @deprecated since 9 4306 * @useinstead ohos.window.Window#setWindowSystemBarEnable 4307 */ 4308 setFullScreen(isFullScreen: boolean): Promise<void>; 4309 4310 /** 4311 * Set the property of the window can layout in full screen 4312 * 4313 * @param { boolean } isLayoutFullScreen - The window can layout in full screen 4314 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4315 * @syscap SystemCapability.WindowManager.WindowManager.Core 4316 * @since 7 4317 * @deprecated since 9 4318 * @useinstead ohos.window.Window#setWindowLayoutFullScreen 4319 */ 4320 setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback<void>): void; 4321 4322 /** 4323 * Set the property of the window can layout in full screen 4324 * 4325 * @param { boolean } isLayoutFullScreen - The window can layout in full screen 4326 * @returns { Promise<void> } Promise that returns no value. 4327 * @syscap SystemCapability.WindowManager.WindowManager.Core 4328 * @since 7 4329 * @deprecated since 9 4330 * @useinstead ohos.window.Window#setWindowLayoutFullScreen 4331 */ 4332 setLayoutFullScreen(isLayoutFullScreen: boolean): Promise<void>; 4333 4334 /** 4335 * Set the property of the window can layout in full screen 4336 * 4337 * @param { boolean } isLayoutFullScreen - The window can layout in full screen 4338 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4339 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4340 * 2. Incorrect parameter types. 4341 * @throws { BusinessError } 1300002 - This window state is abnormal. 4342 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4343 * @syscap SystemCapability.WindowManager.WindowManager.Core 4344 * @since 9 4345 */ 4346 /** 4347 * Set the property of the window can layout in full screen 4348 * 4349 * @param { boolean } isLayoutFullScreen - The window can layout in full screen 4350 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4351 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4352 * 2. Incorrect parameter types. 4353 * @throws { BusinessError } 1300002 - This window state is abnormal. 4354 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4355 * @syscap SystemCapability.WindowManager.WindowManager.Core 4356 * @crossplatform 4357 * @atomicservice 4358 * @since 12 4359 * @deprecated since 12 4360 * @useinstead ohos.window.Window#setWindowLayoutFullScreen 4361 */ 4362 setWindowLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback<void>): void; 4363 4364 /** 4365 * Set the property of the window can layout in full screen 4366 * 4367 * @param { boolean } isLayoutFullScreen - The window can layout in full screen 4368 * @returns { Promise<void> } Promise that returns no value. 4369 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4370 * 2. Incorrect parameter types. 4371 * @throws { BusinessError } 1300002 - This window state is abnormal. 4372 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4373 * @syscap SystemCapability.WindowManager.WindowManager.Core 4374 * @since 9 4375 */ 4376 /** 4377 * Set the property of the window can layout in full screen 4378 * 4379 * @param { boolean } isLayoutFullScreen - The window can layout in full screen 4380 * @returns { Promise<void> } Promise that returns no value. 4381 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4382 * 2. Incorrect parameter types. 4383 * @throws { BusinessError } 1300002 - This window state is abnormal. 4384 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4385 * @syscap SystemCapability.WindowManager.WindowManager.Core 4386 * @crossplatform 4387 * @atomicservice 4388 * @since 12 4389 */ 4390 setWindowLayoutFullScreen(isLayoutFullScreen: boolean): Promise<void>; 4391 4392 /** 4393 * Set the system bar to have visible. 4394 * 4395 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4396 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4397 * @syscap SystemCapability.WindowManager.WindowManager.Core 4398 * @since 7 4399 * @deprecated since 9 4400 * @useinstead ohos.window.Window#setWindowSystemBarEnable 4401 */ 4402 setSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallback<void>): void; 4403 4404 /** 4405 * Set the system bar to have visible. 4406 * 4407 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4408 * @returns { Promise<void> } Promise that returns no value. 4409 * @syscap SystemCapability.WindowManager.WindowManager.Core 4410 * @since 7 4411 * @deprecated since 9 4412 * @useinstead ohos.window.Window#setWindowSystemBarEnable 4413 */ 4414 setSystemBarEnable(names: Array<'status' | 'navigation'>): Promise<void>; 4415 4416 /** 4417 * Set the system bar to have visible. 4418 * 4419 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4420 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4421 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4422 * 2. Incorrect parameter types. 4423 * @throws { BusinessError } 1300002 - This window state is abnormal. 4424 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4425 * @syscap SystemCapability.WindowManager.WindowManager.Core 4426 * @since 9 4427 */ 4428 /** 4429 * Set the system bar to have visible. 4430 * 4431 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4432 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4433 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4434 * 2. Incorrect parameter types. 4435 * @throws { BusinessError } 1300002 - This window state is abnormal. 4436 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4437 * @syscap SystemCapability.WindowManager.WindowManager.Core 4438 * @crossplatform 4439 * @since 10 4440 */ 4441 /** 4442 * Set the system bar to have visible. 4443 * 4444 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4445 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4446 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1.Mandatory parameters are left unspecified; 4447 * 2.Incorrect parameter types. 4448 * @throws { BusinessError } 1300002 - This window state is abnormal. 4449 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4450 * @syscap SystemCapability.WindowManager.WindowManager.Core 4451 * @crossplatform 4452 * @atomicservice 4453 * @since 12 4454 * @deprecated since 12 4455 * @useinstead ohos.window.Window#setWindowSystemBarEnable 4456 */ 4457 setWindowSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallback<void>): void; 4458 4459 /** 4460 * Set the system bar to have visible. 4461 * 4462 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4463 * @returns { Promise<void> } Promise that returns no value. 4464 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4465 * 2. Incorrect parameter types. 4466 * @throws { BusinessError } 1300002 - This window state is abnormal. 4467 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4468 * @syscap SystemCapability.WindowManager.WindowManager.Core 4469 * @since 9 4470 */ 4471 /** 4472 * Set the system bar to have visible. 4473 * 4474 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4475 * @returns { Promise<void> } Promise that returns no value. 4476 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4477 * 2. Incorrect parameter types. 4478 * @throws { BusinessError } 1300002 - This window state is abnormal. 4479 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4480 * @syscap SystemCapability.WindowManager.WindowManager.Core 4481 * @crossplatform 4482 * @since 10 4483 */ 4484 /** 4485 * Set the system bar to have visible. 4486 * 4487 * @param { Array<'status' | 'navigation'> } names - The set of system bar 4488 * @returns { Promise<void> } Promise that returns no value. 4489 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1.Mandatory parameters are left unspecified; 4490 * 2.Incorrect parameter types. 4491 * @throws { BusinessError } 1300002 - This window state is abnormal. 4492 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4493 * @syscap SystemCapability.WindowManager.WindowManager.Core 4494 * @crossplatform 4495 * @atomicservice 4496 * @since 12 4497 */ 4498 setWindowSystemBarEnable(names: Array<'status' | 'navigation'>): Promise<void>; 4499 4500 /** 4501 * Set specific system bar to have visible. 4502 * 4503 * @param {SpecificSystemBar} name - the set of system bar 4504 * @param {boolean} enable - Show specific system bar if true, or hide specific system bar if false. 4505 * @returns { Promise<void> } Promise that returns no value. 4506 * @throws {BusinessError} 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4507 * 2. Incorrect parameter types. 4508 * @throws {BusinessError} 1300002 - This window state is abnormal. 4509 * @throws {BusinessError} 1300003 - This window manager service works abnormally. 4510 * @syscap SystemCapability.Window.SessionManager 4511 * @atomicservice 4512 * @since 11 4513 */ 4514 /** 4515 * Set specific system bar to have visible. 4516 * 4517 * @param {SpecificSystemBar} name - the set of system bar 4518 * @param {boolean} enable - Show specific system bar if true, or hide specific system bar if false. 4519 * @param {boolean} enableAnimation - Whether using animation during this setting, using animation if true or not using animation if false. 4520 * @returns { Promise<void> } Promise that returns no value. 4521 * @throws {BusinessError} 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4522 * 2. Incorrect parameter types. 4523 * @throws {BusinessError} 1300002 - This window state is abnormal. 4524 * @throws {BusinessError} 1300003 - This window manager service works abnormally. 4525 * @syscap SystemCapability.Window.SessionManager 4526 * @crossplatform 4527 * @atomicservice 4528 * @since 12 4529 */ 4530 setSpecificSystemBarEnabled(name: SpecificSystemBar, enable: boolean, enableAnimation?: boolean): Promise<void>; 4531 4532 /** 4533 * Set the properties of system bar 4534 * 4535 * @param { SystemBarProperties } systemBarProperties - The properties of system bar 4536 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4537 * @syscap SystemCapability.WindowManager.WindowManager.Core 4538 * @since 6 4539 * @deprecated since 9 4540 * @useinstead ohos.window.Window#setWindowSystemBarProperties 4541 */ 4542 setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback<void>): void; 4543 4544 /** 4545 * Set the properties of system bar 4546 * 4547 * @param { SystemBarProperties } systemBarProperties - The properties of system bar 4548 * @returns { Promise<void> } Promise that returns no value. 4549 * @syscap SystemCapability.WindowManager.WindowManager.Core 4550 * @since 6 4551 * @deprecated since 9 4552 * @useinstead ohos.window.Window#setWindowSystemBarProperties 4553 */ 4554 setSystemBarProperties(systemBarProperties: SystemBarProperties): Promise<void>; 4555 4556 /** 4557 * Set the properties of system bar 4558 * 4559 * @param { SystemBarProperties } systemBarProperties - The properties of system bar 4560 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4561 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4562 * 2. Incorrect parameter types. 4563 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 4564 * @throws { BusinessError } 1300002 - This window state is abnormal. 4565 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4566 * @syscap SystemCapability.WindowManager.WindowManager.Core 4567 * @since 9 4568 */ 4569 /** 4570 * Set the properties of system bar 4571 * 4572 * @param { SystemBarProperties } systemBarProperties - The properties of system bar 4573 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4574 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4575 * 2. Incorrect parameter types. 4576 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 4577 * @throws { BusinessError } 1300002 - This window state is abnormal. 4578 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4579 * @syscap SystemCapability.WindowManager.WindowManager.Core 4580 * @atomicservice 4581 * @since 12 4582 * @deprecated since 12 4583 * @useinstead ohos.window.Window#setWindowSystemBarProperties 4584 */ 4585 setWindowSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback<void>): void; 4586 4587 /** 4588 * Set the properties of system bar 4589 * 4590 * @param { SystemBarProperties } systemBarProperties - The properties of system bar 4591 * @returns { Promise<void> } Promise that returns no value. 4592 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4593 * 2. Incorrect parameter types. 4594 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 4595 * @throws { BusinessError } 1300002 - This window state is abnormal. 4596 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4597 * @syscap SystemCapability.WindowManager.WindowManager.Core 4598 * @since 9 4599 */ 4600 /** 4601 * Set the properties of system bar 4602 * 4603 * @param { SystemBarProperties } systemBarProperties - The properties of system bar 4604 * @returns { Promise<void> } Promise that returns no value. 4605 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4606 * 2. Incorrect parameter types. 4607 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 4608 * @throws { BusinessError } 1300002 - This window state is abnormal. 4609 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4610 * @syscap SystemCapability.WindowManager.WindowManager.Core 4611 * @atomicservice 4612 * @since 12 4613 */ 4614 setWindowSystemBarProperties(systemBarProperties: SystemBarProperties): Promise<void>; 4615 4616 /** 4617 * Get the properties of system bar 4618 * 4619 * @returns { SystemBarProperties } Return system bar properties. 4620 * @throws { BusinessError } 1300002 - This window state is abnormal. 4621 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4622 * @throws { BusinessError } 1300004 - Unauthorized operation. 4623 * @syscap SystemCapability.WindowManager.WindowManager.Core 4624 * @atomicservice 4625 * @since 12 4626 */ 4627 getWindowSystemBarProperties(): SystemBarProperties; 4628 4629 /** 4630 * Set the preferred orientation config of the window 4631 * 4632 * @param { Orientation } orientation - The orientation config of the window 4633 * @returns { Promise<void> } Promise that returns no value. 4634 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4635 * 2. Incorrect parameter types; 4636 * 3. Parameter verification failed. 4637 * @throws { BusinessError } 1300002 - This window state is abnormal. 4638 * @syscap SystemCapability.WindowManager.WindowManager.Core 4639 * @since 9 4640 */ 4641 /** 4642 * Set the preferred orientation config of the window 4643 * 4644 * @param { Orientation } orientation - The orientation config of the window 4645 * @returns { Promise<void> } Promise that returns no value. 4646 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4647 * 2. Incorrect parameter types; 4648 * 3. Parameter verification failed. 4649 * @throws { BusinessError } 1300002 - This window state is abnormal. 4650 * @syscap SystemCapability.WindowManager.WindowManager.Core 4651 * @crossplatform 4652 * @since 10 4653 */ 4654 /** 4655 * Set the preferred orientation config of the window 4656 * 4657 * @param { Orientation } orientation - The orientation config of the window 4658 * @returns { Promise<void> } Promise that returns no value. 4659 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4660 * 2. Incorrect parameter types; 4661 * 3. Parameter verification failed. 4662 * @throws { BusinessError } 1300002 - This window state is abnormal. 4663 * @syscap SystemCapability.WindowManager.WindowManager.Core 4664 * @crossplatform 4665 * @atomicservice 4666 * @since 11 4667 */ 4668 setPreferredOrientation(orientation: Orientation): Promise<void>; 4669 4670 /** 4671 * Set the preferred orientation config of the window 4672 * 4673 * @param { Orientation } orientation - The orientation config of the window 4674 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4675 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4676 * 2. Incorrect parameter types; 4677 * 3. Parameter verification failed. 4678 * @throws { BusinessError } 1300002 - This window state is abnormal. 4679 * @syscap SystemCapability.WindowManager.WindowManager.Core 4680 * @since 9 4681 */ 4682 /** 4683 * Set the preferred orientation config of the window 4684 * 4685 * @param { Orientation } orientation - The orientation config of the window 4686 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4687 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4688 * 2. Incorrect parameter types; 4689 * 3. Parameter verification failed. 4690 * @throws { BusinessError } 1300002 - This window state is abnormal. 4691 * @syscap SystemCapability.WindowManager.WindowManager.Core 4692 * @crossplatform 4693 * @since 10 4694 */ 4695 /** 4696 * Set the preferred orientation config of the window 4697 * 4698 * @param { Orientation } orientation - The orientation config of the window 4699 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4700 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4701 * 2. Incorrect parameter types; 4702 * 3. Parameter verification failed. 4703 * @throws { BusinessError } 1300002 - This window state is abnormal. 4704 * @syscap SystemCapability.WindowManager.WindowManager.Core 4705 * @crossplatform 4706 * @atomicservice 4707 * @since 11 4708 */ 4709 setPreferredOrientation(orientation: Orientation, callback: AsyncCallback<void>): void; 4710 4711 /** 4712 * Get the preferred orientation config of the window 4713 * 4714 * @returns { Orientation } orientation - The orientation config of the window 4715 * @throws { BusinessError } 1300002 - This window state is abnormal. 4716 * @syscap SystemCapability.WindowManager.WindowManager.Core 4717 * @atomicservice 4718 * @since 12 4719 */ 4720 getPreferredOrientation(): Orientation; 4721 4722 /** 4723 * Loads content 4724 * 4725 * @param { string } path - Path of the page to which the content will be loaded 4726 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window 4727 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4728 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4729 * 2. Incorrect parameter types. 4730 * @throws { BusinessError } 1300002 - This window state is abnormal. 4731 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4732 * @syscap SystemCapability.WindowManager.WindowManager.Core 4733 * @StageModelOnly 4734 * @since 9 4735 */ 4736 /** 4737 * Loads content 4738 * 4739 * @param { string } path - Path of the page to which the content will be loaded 4740 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window 4741 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4742 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4743 * 2. Incorrect parameter types. 4744 * @throws { BusinessError } 1300002 - This window state is abnormal. 4745 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4746 * @syscap SystemCapability.WindowManager.WindowManager.Core 4747 * @StageModelOnly 4748 * @crossplatform 4749 * @since 10 4750 */ 4751 /** 4752 * Loads content 4753 * 4754 * @param { string } path - Path of the page to which the content will be loaded 4755 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window 4756 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4757 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4758 * 2. Incorrect parameter types. 4759 * @throws { BusinessError } 1300002 - This window state is abnormal. 4760 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4761 * @syscap SystemCapability.WindowManager.WindowManager.Core 4762 * @StageModelOnly 4763 * @crossplatform 4764 * @atomicservice 4765 * @since 11 4766 */ 4767 loadContent(path: string, storage: LocalStorage, callback: AsyncCallback<void>): void; 4768 4769 /** 4770 * Loads content 4771 * 4772 * @param { string } path - Path of the page to which the content will be loaded 4773 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window 4774 * @returns { Promise<void> } Promise that returns no value. 4775 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4776 * 2. Incorrect parameter types. 4777 * @throws { BusinessError } 1300002 - This window state is abnormal. 4778 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4779 * @syscap SystemCapability.WindowManager.WindowManager.Core 4780 * @StageModelOnly 4781 * @since 9 4782 */ 4783 /** 4784 * Loads content 4785 * 4786 * @param { string } path - Path of the page to which the content will be loaded 4787 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window 4788 * @returns { Promise<void> } Promise that returns no value. 4789 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4790 * 2. Incorrect parameter types. 4791 * @throws { BusinessError } 1300002 - This window state is abnormal. 4792 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4793 * @syscap SystemCapability.WindowManager.WindowManager.Core 4794 * @StageModelOnly 4795 * @crossplatform 4796 * @since 10 4797 */ 4798 /** 4799 * Loads content 4800 * 4801 * @param { string } path - Path of the page to which the content will be loaded 4802 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window 4803 * @returns { Promise<void> } Promise that returns no value. 4804 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4805 * 2. Incorrect parameter types. 4806 * @throws { BusinessError } 1300002 - This window state is abnormal. 4807 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4808 * @syscap SystemCapability.WindowManager.WindowManager.Core 4809 * @StageModelOnly 4810 * @crossplatform 4811 * @atomicservice 4812 * @since 11 4813 */ 4814 loadContent(path: string, storage: LocalStorage): Promise<void>; 4815 4816 /** 4817 * Loads content 4818 * 4819 * @param { string } path - Path of the page to which the content will be loaded 4820 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4821 * @syscap SystemCapability.WindowManager.WindowManager.Core 4822 * @since 7 4823 * @deprecated since 9 4824 * @useinstead ohos.window.Window#setUIContent 4825 */ 4826 loadContent(path: string, callback: AsyncCallback<void>): void; 4827 4828 /** 4829 * Loads content 4830 * 4831 * @param { string } path - Path of the page to which the content will be loaded 4832 * @returns { Promise<void> } Promise that returns no value. 4833 * @syscap SystemCapability.WindowManager.WindowManager.Core 4834 * @since 7 4835 * @deprecated since 9 4836 * @useinstead ohos.window.Window#setUIContent 4837 */ 4838 loadContent(path: string): Promise<void>; 4839 4840 /** 4841 * Get the UIContext associate with the window content. 4842 * 4843 * @returns { UIContext } the object of UIContext. 4844 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 4845 * 2. Incorrect parameter types; 4846 * 3. Parameter verification failed. 4847 * @throws { BusinessError } 1300002 - This window state is abnormal. 4848 * @syscap SystemCapability.WindowManager.WindowManager.Core 4849 * @stagemodelonly 4850 * @crossplatform 4851 * @since 10 4852 */ 4853 /** 4854 * Get the UIContext associate with the window content. 4855 * 4856 * @returns { UIContext } the object of UIContext. 4857 * @throws { BusinessError } 1300002 - This window state is abnormal. 4858 * @syscap SystemCapability.WindowManager.WindowManager.Core 4859 * @stagemodelonly 4860 * @crossplatform 4861 * @atomicservice 4862 * @since 11 4863 */ 4864 getUIContext() : UIContext; 4865 4866 /** 4867 * Loads content 4868 * 4869 * @param { string } path - Path of the page to which the content will be loaded 4870 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4871 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4872 * 2. Incorrect parameter types. 4873 * @throws { BusinessError } 1300002 - This window state is abnormal. 4874 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4875 * @syscap SystemCapability.WindowManager.WindowManager.Core 4876 * @since 9 4877 */ 4878 /** 4879 * Loads content 4880 * 4881 * @param { string } path - Path of the page to which the content will be loaded 4882 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4883 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4884 * 2. Incorrect parameter types. 4885 * @throws { BusinessError } 1300002 - This window state is abnormal. 4886 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4887 * @syscap SystemCapability.WindowManager.WindowManager.Core 4888 * @crossplatform 4889 * @since 10 4890 */ 4891 /** 4892 * Loads content 4893 * 4894 * @param { string } path - Path of the page to which the content will be loaded 4895 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4896 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4897 * 2. Incorrect parameter types. 4898 * @throws { BusinessError } 1300002 - This window state is abnormal. 4899 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4900 * @syscap SystemCapability.WindowManager.WindowManager.Core 4901 * @crossplatform 4902 * @atomicservice 4903 * @since 11 4904 */ 4905 setUIContent(path: string, callback: AsyncCallback<void>): void; 4906 4907 /** 4908 * Loads content 4909 * 4910 * @param { string } path - Path of the page to which the content will be loaded 4911 * @returns { Promise<void> } Promise that returns no value. 4912 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4913 * 2. Incorrect parameter types. 4914 * @throws { BusinessError } 1300002 - This window state is abnormal. 4915 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4916 * @syscap SystemCapability.WindowManager.WindowManager.Core 4917 * @since 9 4918 */ 4919 /** 4920 * Loads content 4921 * 4922 * @param { string } path - Path of the page to which the content will be loaded 4923 * @returns { Promise<void> } Promise that returns no value. 4924 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4925 * 2. Incorrect parameter types. 4926 * @throws { BusinessError } 1300002 - This window state is abnormal. 4927 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4928 * @syscap SystemCapability.WindowManager.WindowManager.Core 4929 * @crossplatform 4930 * @since 10 4931 */ 4932 /** 4933 * Loads content 4934 * 4935 * @param { string } path - Path of the page to which the content will be loaded 4936 * @returns { Promise<void> } Promise that returns no value. 4937 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4938 * 2. Incorrect parameter types. 4939 * @throws { BusinessError } 1300002 - This window state is abnormal. 4940 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4941 * @syscap SystemCapability.WindowManager.WindowManager.Core 4942 * @crossplatform 4943 * @atomicservice 4944 * @since 11 4945 */ 4946 setUIContent(path: string): Promise<void>; 4947 4948 /** 4949 * Loads content by named router 4950 * 4951 * @param { string } name - name of the page to which the content will be loaded. 4952 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window. 4953 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4954 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4955 * 2. Incorrect parameter types. 4956 * @throws { BusinessError } 1300002 - This window state is abnormal. 4957 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4958 * @syscap SystemCapability.WindowManager.WindowManager.Core 4959 * @stagemodelonly 4960 * @crossplatform 4961 * @atomicservice 4962 * @since 11 4963 */ 4964 loadContentByName(name: string, storage: LocalStorage, callback: AsyncCallback<void>): void; 4965 4966 /** 4967 * Loads content by named router 4968 * 4969 * @param { string } name - name of the page to which the content will be loaded. 4970 * @param { AsyncCallback<void> } callback - Callback used to return the result. 4971 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4972 * 2. Incorrect parameter types. 4973 * @throws { BusinessError } 1300002 - This window state is abnormal. 4974 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4975 * @syscap SystemCapability.WindowManager.WindowManager.Core 4976 * @stagemodelonly 4977 * @crossplatform 4978 * @atomicservice 4979 * @since 11 4980 */ 4981 loadContentByName(name: string, callback: AsyncCallback<void>): void; 4982 4983 /** 4984 * Loads content by named router 4985 * 4986 * @param { string } name - name of the page to which the content will be loaded. 4987 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window. 4988 * @returns { Promise<void> } Promise that returns no value. 4989 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 4990 * 2. Incorrect parameter types. 4991 * @throws { BusinessError } 1300002 - This window state is abnormal. 4992 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 4993 * @syscap SystemCapability.WindowManager.WindowManager.Core 4994 * @stagemodelonly 4995 * @crossplatform 4996 * @atomicservice 4997 * @since 11 4998 */ 4999 loadContentByName(name: string, storage?: LocalStorage): Promise<void>; 5000 5001 /** 5002 * Checks whether the window is displayed 5003 * 5004 * @param { AsyncCallback<boolean> } callback - Callback used to return the result. 5005 * @syscap SystemCapability.WindowManager.WindowManager.Core 5006 * @since 7 5007 * @deprecated since 9 5008 * @useinstead ohos.window.Window#isWindowShowing 5009 */ 5010 isShowing(callback: AsyncCallback<boolean>): void; 5011 5012 /** 5013 * Checks whether the window is displayed 5014 * 5015 * @returns { Promise<boolean> } Whether the window is displayed. The value true means that the window is displayed, and false means the opposite. 5016 * @syscap SystemCapability.WindowManager.WindowManager.Core 5017 * @since 7 5018 * @deprecated since 9 5019 * @useinstead ohos.window.Window#isWindowShowing 5020 */ 5021 isShowing(): Promise<boolean>; 5022 5023 /** 5024 * Checks whether the window is displayed 5025 * 5026 * @returns { boolean } Whether the window is displayed. The value true means that the window is displayed, and false means the opposite. 5027 * @throws { BusinessError } 1300002 - This window state is abnormal. 5028 * @syscap SystemCapability.WindowManager.WindowManager.Core 5029 * @since 9 5030 */ 5031 /** 5032 * Checks whether the window is displayed 5033 * 5034 * @returns { boolean } Whether the window is displayed. The value true means that the window is displayed, and false means the opposite. 5035 * @throws { BusinessError } 1300002 - This window state is abnormal. 5036 * @syscap SystemCapability.WindowManager.WindowManager.Core 5037 * @crossplatform 5038 * @since 10 5039 */ 5040 /** 5041 * Checks whether the window is displayed 5042 * 5043 * @returns { boolean } Whether the window is displayed. The value true means that the window is displayed, and false means the opposite. 5044 * @throws { BusinessError } 1300002 - This window state is abnormal. 5045 * @syscap SystemCapability.WindowManager.WindowManager.Core 5046 * @crossplatform 5047 * @atomicservice 5048 * @since 11 5049 */ 5050 isWindowShowing(): boolean; 5051 5052 /** 5053 * Register the callback of windowSizeChange 5054 * 5055 * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. 5056 * @param { Callback<Size> } callback - Callback used to return the window size. 5057 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5058 * 2. Incorrect parameter types; 5059 * 3. Parameter verification failed. 5060 * @syscap SystemCapability.WindowManager.WindowManager.Core 5061 * @since 7 5062 */ 5063 /** 5064 * Register the callback of windowSizeChange 5065 * 5066 * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. 5067 * @param { Callback<Size> } callback - Callback used to return the window size. 5068 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5069 * 2. Incorrect parameter types; 5070 * 3. Parameter verification failed. 5071 * @syscap SystemCapability.WindowManager.WindowManager.Core 5072 * @atomicservice 5073 * @since 11 5074 */ 5075 /** 5076 * Register the callback of windowSizeChange 5077 * 5078 * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. 5079 * @param { Callback<Size> } callback - Callback used to return the window size. 5080 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5081 * 2. Incorrect parameter types; 5082 * 3. Parameter verification failed. 5083 * @syscap SystemCapability.WindowManager.WindowManager.Core 5084 * @crossplatform 5085 * @atomicservice 5086 * @since 12 5087 */ 5088 on(type: 'windowSizeChange', callback: Callback<Size>): void; 5089 5090 /** 5091 * Unregister the callback of windowSizeChange 5092 * 5093 * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. 5094 * @param { Callback<Size> } callback - Callback used to return the window size. 5095 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5096 * 2. Parameter verification failed. 5097 * @syscap SystemCapability.WindowManager.WindowManager.Core 5098 * @since 7 5099 */ 5100 /** 5101 * Unregister the callback of windowSizeChange 5102 * 5103 * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. 5104 * @param { Callback<Size> } callback - Callback used to return the window size. 5105 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5106 * 2. Parameter verification failed. 5107 * @syscap SystemCapability.WindowManager.WindowManager.Core 5108 * @atomicservice 5109 * @since 11 5110 */ 5111 /** 5112 * Unregister the callback of windowSizeChange 5113 * 5114 * @param { 'windowSizeChange' } type - The value is fixed at 'windowSizeChange', indicating the window size change event. 5115 * @param { Callback<Size> } callback - Callback used to return the window size. 5116 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5117 * 2. Parameter verification failed. 5118 * @syscap SystemCapability.WindowManager.WindowManager.Core 5119 * @crossplatform 5120 * @atomicservice 5121 * @since 12 5122 */ 5123 off(type: 'windowSizeChange', callback?: Callback<Size>): void; 5124 5125 /** 5126 * Register the callback of systemAvoidAreaChange 5127 * 5128 * @param { 'systemAvoidAreaChange' } type - The value is fixed at 'systemAvoidAreaChange', indicating the event of changes to the avoid area. 5129 * @param { Callback<AvoidArea> } callback - Callback used to return the area. 5130 * @syscap SystemCapability.WindowManager.WindowManager.Core 5131 * @since 7 5132 * @deprecated since 9 5133 * @useinstead ohos.window.Window#on_avoidAreaChange 5134 */ 5135 on(type: 'systemAvoidAreaChange', callback: Callback<AvoidArea>): void; 5136 5137 /** 5138 * Unregister the callback of systemAvoidAreaChange 5139 * 5140 * @param { 'systemAvoidAreaChange' } type - The value is fixed at 'systemAvoidAreaChange', indicating the event of changes to the avoid area. 5141 * @param { Callback<AvoidArea> } callback - Callback used to return the area. 5142 * @syscap SystemCapability.WindowManager.WindowManager.Core 5143 * @since 7 5144 * @deprecated since 9 5145 * @useinstead ohos.window.Window#off_avoidAreaChange 5146 */ 5147 off(type: 'systemAvoidAreaChange', callback?: Callback<AvoidArea>): void; 5148 5149 /** 5150 * Register the callback of avoidAreaChange 5151 * 5152 * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. 5153 * @param { Callback<{ type: AvoidAreaType, area: AvoidArea }> } callback - Callback used to return the area. 5154 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 5155 * 2. Incorrect parameter types; 5156 * 3. Parameter verification failed. 5157 * @syscap SystemCapability.WindowManager.WindowManager.Core 5158 * @since 9 5159 */ 5160 /** 5161 * Register the callback of avoidAreaChange 5162 * 5163 * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. 5164 * @param { Callback<{ type: AvoidAreaType, area: AvoidArea }> } callback - Callback used to return the area. 5165 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 5166 * 2. Incorrect parameter types; 5167 * 3. Parameter verification failed. 5168 * @syscap SystemCapability.WindowManager.WindowManager.Core 5169 * @atomicservice 5170 * @since 11 5171 */ 5172 /** 5173 * Register the callback of avoidAreaChange 5174 * 5175 * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. 5176 * @param { Callback<AvoidAreaOptions> } callback - Callback used to return the area. 5177 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 5178 * 2. Incorrect parameter types; 5179 * 3. Parameter verification failed. 5180 * @syscap SystemCapability.WindowManager.WindowManager.Core 5181 * @atomicservice 5182 * @since 12 5183 */ 5184 on(type: 'avoidAreaChange', callback: Callback<AvoidAreaOptions>): void; 5185 5186 /** 5187 * Unregister the callback of avoidAreaChange 5188 * 5189 * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. 5190 * @param { Callback<{ type: AvoidAreaType, area: AvoidArea }> } callback - Callback used to return the area. 5191 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 5192 * 2. Parameter verification failed. 5193 * @syscap SystemCapability.WindowManager.WindowManager.Core 5194 * @since 9 5195 */ 5196 /** 5197 * Unregister the callback of avoidAreaChange 5198 * 5199 * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. 5200 * @param { Callback<{ type: AvoidAreaType, area: AvoidArea }> } callback - Callback used to return the area. 5201 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 5202 * 2. Parameter verification failed. 5203 * @syscap SystemCapability.WindowManager.WindowManager.Core 5204 * @atomicservice 5205 * @since 11 5206 */ 5207 /** 5208 * Unregister the callback of avoidAreaChange 5209 * 5210 * @param { 'avoidAreaChange' } type - The value is fixed at 'avoidAreaChange', indicating the event of changes to the avoid area. 5211 * @param { Callback<AvoidAreaOptions> } callback - Callback used to return the area. 5212 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 5213 * 2. Parameter verification failed. 5214 * @syscap SystemCapability.WindowManager.WindowManager.Core 5215 * @atomicservice 5216 * @since 12 5217 */ 5218 off(type: 'avoidAreaChange', callback?: Callback<AvoidAreaOptions>): void; 5219 5220 /** 5221 * Register the callback of keyboardHeightChange 5222 * 5223 * @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event. 5224 * @param { Callback<number> } callback - Callback used to return the current keyboard height. 5225 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5226 * 2. Incorrect parameter types; 5227 * 3. Parameter verification failed. 5228 * @syscap SystemCapability.WindowManager.WindowManager.Core 5229 * @since 7 5230 */ 5231 /** 5232 * Register the callback of keyboardHeightChange 5233 * 5234 * @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event. 5235 * @param { Callback<number> } callback - Callback used to return the current keyboard height. 5236 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5237 * 2. Incorrect parameter types; 5238 * 3. Parameter verification failed. 5239 * @syscap SystemCapability.WindowManager.WindowManager.Core 5240 * @atomicservice 5241 * @since 12 5242 */ 5243 on(type: 'keyboardHeightChange', callback: Callback<number>): void; 5244 5245 /** 5246 * Unregister the callback of keyboardHeightChange 5247 * 5248 * @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event. 5249 * @param { Callback<number> } callback - Callback used to return the current keyboard height. 5250 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5251 * 2. Parameter verification failed. 5252 * @syscap SystemCapability.WindowManager.WindowManager.Core 5253 * @since 7 5254 */ 5255 /** 5256 * Unregister the callback of keyboardHeightChange 5257 * 5258 * @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event. 5259 * @param { Callback<number> } callback - Callback used to return the current keyboard height. 5260 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5261 * 2. Parameter verification failed. 5262 * @syscap SystemCapability.WindowManager.WindowManager.Core 5263 * @atomicservice 5264 * @since 12 5265 */ 5266 off(type: 'keyboardHeightChange', callback?: Callback<number>): void; 5267 5268 /** 5269 * Touch outside callback on. 5270 * 5271 * @param { 'touchOutside' } type - The value is fixed at 'touchOutside', indicating the click event outside this window. 5272 * @param { Callback<void> } callback - Callback used to return the click event outside this window. 5273 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5274 * 2. Incorrect parameter types; 5275 * 3. Parameter verification failed. 5276 * @syscap SystemCapability.WindowManager.WindowManager.Core 5277 * @atomicservice 5278 * @since 11 5279 */ 5280 on(type: 'touchOutside', callback: Callback<void>): void; 5281 5282 /** 5283 * Touch outside callback off. 5284 * 5285 * @param { 'touchOutside' } type - The value is fixed at 'touchOutside', indicating the click event outside this window. 5286 * @param { Callback<void> } callback - Callback used to return the click event outside this window. 5287 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5288 * 2. Parameter verification failed. 5289 * @syscap SystemCapability.WindowManager.WindowManager.Core 5290 * @atomicservice 5291 * @since 11 5292 */ 5293 off(type: 'touchOutside', callback?: Callback<void>): void; 5294 5295 /** 5296 * Window visibility change callback on. 5297 * 5298 * @param { 'windowVisibilityChange' } type - The value is fixed at 'windowVisibilityChange', indicating the window visibility change. 5299 * @param { Callback<boolean> } callback - Callback used to notify the window visibility change. 5300 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5301 * 2. Incorrect parameter types; 5302 * 3. Parameter verification failed. 5303 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5304 * @throws { BusinessError } 1300002 - This window state is abnormal. 5305 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5306 * @syscap SystemCapability.Window.SessionManager 5307 * @since 11 5308 */ 5309 /** 5310 * Window visibility change callback on. 5311 * 5312 * @param { 'windowVisibilityChange' } type - The value is fixed at 'windowVisibilityChange', indicating the window visibility change. 5313 * @param { Callback<boolean> } callback - Callback used to notify the window visibility change. 5314 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5315 * 2. Incorrect parameter types; 5316 * 3. Parameter verification failed. 5317 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5318 * @throws { BusinessError } 1300002 - This window state is abnormal. 5319 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5320 * @syscap SystemCapability.Window.SessionManager 5321 * @atomicservice 5322 * @since 12 5323 */ 5324 on(type: 'windowVisibilityChange', callback: Callback<boolean>): void; 5325 5326 /** 5327 * Window visibility change callback off. 5328 * 5329 * @param { 'windowVisibilityChange' } type - The value is fixed at 'windowVisibilityChange', indicating the window visibility change. 5330 * @param { Callback<boolean> } callback - Callback used to notify the window visibility change. 5331 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5332 * 2. Parameter verification failed. 5333 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5334 * @throws { BusinessError } 1300002 - This window state is abnormal. 5335 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5336 * @syscap SystemCapability.Window.SessionManager 5337 * @since 11 5338 */ 5339 /** 5340 * Window visibility change callback off. 5341 * 5342 * @param { 'windowVisibilityChange' } type - The value is fixed at 'windowVisibilityChange', indicating the window visibility change. 5343 * @param { Callback<boolean> } callback - Callback used to notify the window visibility change. 5344 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5345 * 2. Parameter verification failed. 5346 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5347 * @throws { BusinessError } 1300002 - This window state is abnormal. 5348 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5349 * @syscap SystemCapability.Window.SessionManager 5350 * @atomicservice 5351 * @since 12 5352 */ 5353 off(type: 'windowVisibilityChange', callback?: Callback<boolean>): void; 5354 5355 /** 5356 * Register the callback function that has no interaction for a long time. 5357 * 5358 * @param { 'noInteractionDetected' } type - The value is fixed at 'noInteractionDetected', indicating the window has no interaction for a long time. 5359 * @param { number } timeout - The timeout(in seconds) of no interaction detection. 5360 * @param { Callback<void> } callback - Callback used to notify the window has no interaction for a long time. 5361 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5362 * 2. Incorrect parameter types; 5363 * 3. Parameter verification failed. 5364 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5365 * @throws { BusinessError } 1300002 - This window state is abnormal. 5366 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5367 * @syscap SystemCapability.Window.SessionManager 5368 * @atomicservice 5369 * @since 12 5370 */ 5371 on(type: 'noInteractionDetected', timeout: number, callback: Callback<void>): void; 5372 5373 /** 5374 * Unregister the callback function that has no interaction for a long time. 5375 * 5376 * @param { 'noInteractionDetected' } type - The value is fixed at 'noInteractionDetected', indicating the window has no interaction for a long time. 5377 * @param { Callback<void> } callback - Callback used to notify the window has no interaction for a long time. 5378 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5379 * 2. Parameter verification failed. 5380 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5381 * @throws { BusinessError } 1300002 - This window state is abnormal. 5382 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5383 * @syscap SystemCapability.Window.SessionManager 5384 * @atomicservice 5385 * @since 12 5386 */ 5387 off(type: 'noInteractionDetected', callback?: Callback<void>): void; 5388 5389 /** 5390 * Register the callback of screenshot, only the focused window called back 5391 * 5392 * @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event. 5393 * @param { Callback<void> } callback - Callback invoked when a screenshot event occurs. 5394 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5395 * 2. Incorrect parameter types; 5396 * 3. Parameter verification failed. 5397 * @syscap SystemCapability.WindowManager.WindowManager.Core 5398 * @since 9 5399 */ 5400 /** 5401 * Register the callback of screenshot, only the focused window called back 5402 * 5403 * @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event. 5404 * @param { Callback<void> } callback - Callback invoked when a screenshot event occurs. 5405 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5406 * 2. Incorrect parameter types; 5407 * 3. Parameter verification failed. 5408 * @syscap SystemCapability.WindowManager.WindowManager.Core 5409 * @atomicservice 5410 * @since 12 5411 */ 5412 on(type: 'screenshot', callback: Callback<void>): void; 5413 5414 /** 5415 * Unregister the callback of screenshot 5416 * 5417 * @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event. 5418 * @param { Callback<void> } callback - Callback invoked when a screenshot event occurs. 5419 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5420 * 2. Parameter verification failed. 5421 * @syscap SystemCapability.WindowManager.WindowManager.Core 5422 * @since 9 5423 */ 5424 /** 5425 * Unregister the callback of screenshot 5426 * 5427 * @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event. 5428 * @param { Callback<void> } callback - Callback invoked when a screenshot event occurs. 5429 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5430 * 2. Parameter verification failed. 5431 * @syscap SystemCapability.WindowManager.WindowManager.Core 5432 * @atomicservice 5433 * @since 12 5434 */ 5435 off(type: 'screenshot', callback?: Callback<void>): void; 5436 5437 /** 5438 * Register the callback of dialogTargetTouch 5439 * 5440 * @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch', indicating the click event of the target window in the modal window mode. 5441 * @param { Callback<void> } callback - Callback invoked when the click event occurs in the target window of the modal window mode. 5442 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5443 * 2. Incorrect parameter types; 5444 * 3. Parameter verification failed. 5445 * @syscap SystemCapability.WindowManager.WindowManager.Core 5446 * @since 10 5447 */ 5448 /** 5449 * Register the callback of dialogTargetTouch 5450 * 5451 * @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch', indicating the click event of the target window in the modal window mode. 5452 * @param { Callback<void> } callback - Callback invoked when the click event occurs in the target window of the modal window mode. 5453 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5454 * 2. Incorrect parameter types; 5455 * 3. Parameter verification failed. 5456 * @syscap SystemCapability.WindowManager.WindowManager.Core 5457 * @atomicservice 5458 * @since 12 5459 */ 5460 on(type: 'dialogTargetTouch', callback: Callback<void>): void; 5461 5462 /** 5463 * Unregister the callback of dialogTargetTouch 5464 * 5465 * @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch', 5466 * indicating the click event of the target window in the modal window mode. 5467 * @param { Callback<void> } callback - Callback invoked when the click event occurs in the target window of the modal window mode. 5468 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5469 * 2. Parameter verification failed. 5470 * @syscap SystemCapability.WindowManager.WindowManager.Core 5471 * @since 10 5472 */ 5473 /** 5474 * Unregister the callback of dialogTargetTouch 5475 * 5476 * @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch', 5477 * indicating the click event of the target window in the modal window mode. 5478 * @param { Callback<void> } callback - Callback invoked when the click event occurs in the target window of the modal window mode. 5479 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5480 * 2. Parameter verification failed. 5481 * @syscap SystemCapability.WindowManager.WindowManager.Core 5482 * @atomicservice 5483 * @since 12 5484 */ 5485 off(type: 'dialogTargetTouch', callback?: Callback<void>): void; 5486 5487 /** 5488 * Register the callback of windowEvent 5489 * 5490 * @param { 'windowEvent' } type - The value is fixed at 'windowEvent', indicating the window lifecycle change event. 5491 * @param { Callback<WindowEventType> } callback - the callback of window event 5492 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5493 * 2. Incorrect parameter types; 5494 * 3. Parameter verification failed. 5495 * @syscap SystemCapability.WindowManager.WindowManager.Core 5496 * @since 10 5497 */ 5498 /** 5499 * Register the callback of windowEvent 5500 * 5501 * @param { 'windowEvent' } type - The value is fixed at 'windowEvent', indicating the window lifecycle change event. 5502 * @param { Callback<WindowEventType> } callback - the callback of window event 5503 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5504 * 2. Incorrect parameter types; 5505 * 3. Parameter verification failed. 5506 * @syscap SystemCapability.WindowManager.WindowManager.Core 5507 * @crossplatform 5508 * @atomicservice 5509 * @since 11 5510 */ 5511 on(type: 'windowEvent', callback: Callback<WindowEventType>): void; 5512 5513 /** 5514 * Unregister the callback of windowEvent 5515 * 5516 * @param { 'windowEvent' } type - The value is fixed at 'windowEvent', indicating the window lifecycle change event. 5517 * @param { Callback<WindowEventType> } callback - the callback of window event 5518 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5519 * 2. Parameter verification failed. 5520 * @syscap SystemCapability.WindowManager.WindowManager.Core 5521 * @since 10 5522 */ 5523 /** 5524 * Unregister the callback of windowEvent 5525 * 5526 * @param { 'windowEvent' } type - The value is fixed at 'windowEvent', indicating the window lifecycle change event. 5527 * @param { Callback<WindowEventType> } callback - the callback of window event 5528 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5529 * 2. Parameter verification failed. 5530 * @syscap SystemCapability.WindowManager.WindowManager.Core 5531 * @crossplatform 5532 * @atomicservice 5533 * @since 11 5534 */ 5535 off(type: 'windowEvent', callback?: Callback<WindowEventType>): void; 5536 5537 /** 5538 * Register the callback of windowStatusChange 5539 * 5540 * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. 5541 * @param { Callback<WindowStatusType> } callback - Callback used to return the window status. 5542 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5543 * 2. Incorrect parameter types; 5544 * 3. Parameter verification failed. 5545 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5546 * @syscap SystemCapability.Window.SessionManager 5547 * @since 11 5548 */ 5549 /** 5550 * Register the callback of windowStatusChange 5551 * 5552 * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. 5553 * @param { Callback<WindowStatusType> } callback - Callback used to return the window status. 5554 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5555 * 2. Incorrect parameter types; 5556 * 3. Parameter verification failed. 5557 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5558 * @syscap SystemCapability.Window.SessionManager 5559 * @atomicservice 5560 * @since 12 5561 */ 5562 on(type: 'windowStatusChange', callback: Callback<WindowStatusType>): void; 5563 5564 /** 5565 * Unregister the callback of windowStatusChange 5566 * 5567 * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. 5568 * @param { Callback<WindowStatusType> } callback - Callback used to return the window status. 5569 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5570 * 2. Parameter verification failed. 5571 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5572 * @syscap SystemCapability.Window.SessionManager 5573 * @since 11 5574 */ 5575 /** 5576 * Unregister the callback of windowStatusChange 5577 * 5578 * @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event. 5579 * @param { Callback<WindowStatusType> } callback - Callback used to return the window status. 5580 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5581 * 2. Parameter verification failed. 5582 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5583 * @syscap SystemCapability.Window.SessionManager 5584 * @atomicservice 5585 * @since 12 5586 */ 5587 off(type: 'windowStatusChange', callback?: Callback<WindowStatusType>): void; 5588 5589 /** 5590 * Register the callback of subWindowClose 5591 * 5592 * @param { 'subWindowClose' } type - The value is fixed at 'subWindowClose', indicating the subwindow close event. 5593 * @param { Callback<void> } callback - Callback used to return whether to terminate the subwindow close process. 5594 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5595 * 2. Parameter verification failed. 5596 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5597 * @throws { BusinessError } 1300002 - This window state is abnormal. 5598 * @throws { BusinessError } 1300004 - Unauthorized operation. 5599 * @syscap SystemCapability.Window.SessionManager 5600 * @atomicservice 5601 * @since 12 5602 */ 5603 on(type: 'subWindowClose', callback: Callback<void>): void; 5604 5605 /** 5606 * Unregister the callback of subWindowClose 5607 * 5608 * @param { 'subWindowClose' } type - The value is fixed at 'subWindowClose', indicating the subwindow close event. 5609 * @param { Callback<void> } callback - Callback used to return whether to terminate the subwindow close process. 5610 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 5611 * 2. Parameter verification failed. 5612 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5613 * @throws { BusinessError } 1300002 - This window state is abnormal. 5614 * @throws { BusinessError } 1300004 - Unauthorized operation. 5615 * @syscap SystemCapability.Window.SessionManager 5616 * @atomicservice 5617 * @since 12 5618 */ 5619 off(type: 'subWindowClose', callback?: Callback<void>): void; 5620 5621 /** 5622 * Bind dialog to the target window. 5623 * 5624 * @param { rpc.RemoteObject } token - token of the target window. 5625 * @param { Callback<void> } deathCallback - the callback of dialogDeath. 5626 * @returns { Promise<void> } Promise that returns no value. 5627 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5628 * @throws { BusinessError } 1300002 - This window state is abnormal. 5629 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5630 * @syscap SystemCapability.WindowManager.WindowManager.Core 5631 * @systemapi Hide this for inner system use. 5632 * @since 9 5633 */ 5634 /** 5635 * Bind dialog to the target window. 5636 * 5637 * @param { rpc.RemoteObject } token - token of the target window. 5638 * @param { Callback<void> } deathCallback - the callback of dialogDeath. 5639 * @returns { Promise<void> } Promise that returns no value. 5640 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 5641 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5642 * @throws { BusinessError } 1300002 - This window state is abnormal. 5643 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5644 * @syscap SystemCapability.WindowManager.WindowManager.Core 5645 * @systemapi Hide this for inner system use. 5646 * @since 12 5647 */ 5648 bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback<void>): Promise<void>; 5649 5650 /** 5651 * Bind dialog to the target window. 5652 * 5653 * @param { rpc.RemoteObject } token token of the target window. 5654 * @param { Callback<void> } deathCallback the callback of dialogDeath. 5655 * @param { AsyncCallback<void> } callback Callback used to return the result. 5656 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5657 * @throws { BusinessError } 1300002 - This window state is abnormal. 5658 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5659 * @syscap SystemCapability.WindowManager.WindowManager.Core 5660 * @systemapi Hide this for inner system use. 5661 * @since 9 5662 */ 5663 /** 5664 * Bind dialog to the target window. 5665 * 5666 * @param { rpc.RemoteObject } token token of the target window. 5667 * @param { Callback<void> } deathCallback the callback of dialogDeath. 5668 * @param { AsyncCallback<void> } callback Callback used to return the result. 5669 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 5670 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5671 * @throws { BusinessError } 1300002 - This window state is abnormal. 5672 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5673 * @syscap SystemCapability.WindowManager.WindowManager.Core 5674 * @systemapi Hide this for inner system use. 5675 * @since 12 5676 */ 5677 bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback<void>, callback: AsyncCallback<void>): void; 5678 5679 /** 5680 * Bind dialog to the target window. 5681 * 5682 * @param { dialogRequest.RequestInfo } requestInfo requestInfo of the target window. 5683 * @param { Callback<void> } deathCallback the callback of dialogDeath. 5684 * @returns { Promise<void> } Promise that returns no value. 5685 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5686 * @throws { BusinessError } 1300002 - This window state is abnormal. 5687 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5688 * @syscap SystemCapability.WindowManager.WindowManager.Core 5689 * @systemapi Hide this for inner system use. 5690 * @since 9 5691 */ 5692 /** 5693 * Bind dialog to the target window. 5694 * 5695 * @param { dialogRequest.RequestInfo } requestInfo requestInfo of the target window. 5696 * @param { Callback<void> } deathCallback the callback of dialogDeath. 5697 * @returns { Promise<void> } Promise that returns no value. 5698 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 5699 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5700 * @throws { BusinessError } 1300002 - This window state is abnormal. 5701 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5702 * @syscap SystemCapability.WindowManager.WindowManager.Core 5703 * @systemapi Hide this for inner system use. 5704 * @since 12 5705 */ 5706 bindDialogTarget(requestInfo: dialogRequest.RequestInfo, deathCallback: Callback<void>): Promise<void>; 5707 5708 /** 5709 * Bind dialog to the target window. 5710 * 5711 * @param { dialogRequest.RequestInfo } requestInfo requestInfo of the target window. 5712 * @param { Callback<void> } deathCallback the callback of dialogDeath. 5713 * @param { AsyncCallback<void> } callback Callback used to return the result. 5714 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5715 * @throws { BusinessError } 1300002 - This window state is abnormal. 5716 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5717 * @syscap SystemCapability.WindowManager.WindowManager.Core 5718 * @systemapi Hide this for inner system use. 5719 * @since 9 5720 */ 5721 /** 5722 * Bind dialog to the target window. 5723 * 5724 * @param { dialogRequest.RequestInfo } requestInfo requestInfo of the target window. 5725 * @param { Callback<void> } deathCallback the callback of dialogDeath. 5726 * @param { AsyncCallback<void> } callback Callback used to return the result. 5727 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 5728 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 5729 * @throws { BusinessError } 1300002 - This window state is abnormal. 5730 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5731 * @syscap SystemCapability.WindowManager.WindowManager.Core 5732 * @systemapi Hide this for inner system use. 5733 * @since 12 5734 */ 5735 bindDialogTarget( 5736 requestInfo: dialogRequest.RequestInfo, 5737 deathCallback: Callback<void>, 5738 callback: AsyncCallback<void> 5739 ): void; 5740 5741 /** 5742 * Set whether the dialog window responds to back gesture. 5743 * 5744 * @param { boolean } enabled - Responds to back gesture if true, or ignore back gesture if false. 5745 * @returns { Promise<void> } Promise that returns no value. 5746 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5747 * 2. Incorrect parameter types. 5748 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 5749 * @throws { BusinessError } 1300002 - This window state is abnormal. 5750 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 5751 * @throws { BusinessError } 1300004 - Unauthorized operation. 5752 * @syscap SystemCapability.Window.SessionManager 5753 * @atomicservice 5754 * @since 12 5755 */ 5756 setDialogBackGestureEnabled(enabled: boolean): Promise<void>; 5757 5758 /** 5759 * Whether the window supports thr wide gamut setting. 5760 * 5761 * @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. 5762 * @syscap SystemCapability.WindowManager.WindowManager.Core 5763 * @since 8 5764 * @deprecated since 9 5765 * @useinstead ohos.window.Window#isWindowSupportWideGamut 5766 */ 5767 isSupportWideGamut(): Promise<boolean>; 5768 5769 /** 5770 * Whether the window supports thr wide gamut setting. 5771 * 5772 * @param { AsyncCallback<boolean> } callback Callback used to return the result. 5773 * @syscap SystemCapability.WindowManager.WindowManager.Core 5774 * @since 8 5775 * @deprecated since 9 5776 * @useinstead ohos.window.Window#isWindowSupportWideGamut 5777 */ 5778 isSupportWideGamut(callback: AsyncCallback<boolean>): void; 5779 5780 /** 5781 * Whether the window supports thr wide gamut setting. 5782 * 5783 * @returns { Promise<boolean> } Promise used to return the result. 5784 * The value true means that the wide-gamut color space is supported, and false means the opposite. 5785 * @throws { BusinessError } 1300002 - This window state is abnormal. 5786 * @syscap SystemCapability.WindowManager.WindowManager.Core 5787 * @since 9 5788 */ 5789 /** 5790 * Whether the window supports thr wide gamut setting. 5791 * 5792 * @returns { Promise<boolean> } Promise used to return the result. 5793 * The value true means that the wide-gamut color space is supported, and false means the opposite. 5794 * @throws { BusinessError } 1300002 - This window state is abnormal. 5795 * @syscap SystemCapability.WindowManager.WindowManager.Core 5796 * @atomicservice 5797 * @since 12 5798 */ 5799 isWindowSupportWideGamut(): Promise<boolean>; 5800 5801 /** 5802 * Whether the window supports thr wide gamut setting. 5803 * 5804 * @param { AsyncCallback<boolean> } callback Callback used to return the result. 5805 * @throws { BusinessError } 1300002 - This window state is abnormal. 5806 * @syscap SystemCapability.WindowManager.WindowManager.Core 5807 * @since 9 5808 */ 5809 /** 5810 * Whether the window supports thr wide gamut setting. 5811 * 5812 * @param { AsyncCallback<boolean> } callback Callback used to return the result. 5813 * @throws { BusinessError } 1300002 - This window state is abnormal. 5814 * @syscap SystemCapability.WindowManager.WindowManager.Core 5815 * @atomicservice 5816 * @since 12 5817 */ 5818 isWindowSupportWideGamut(callback: AsyncCallback<boolean>): void; 5819 5820 /** 5821 * Sets the specified color space. 5822 * 5823 * @param { ColorSpace } colorSpace the specified color space. 5824 * @returns { Promise<void> } Promise that returns no value. 5825 * @syscap SystemCapability.WindowManager.WindowManager.Core 5826 * @since 8 5827 * @deprecated since 9 5828 * @useinstead ohos.window.Window#setWindowColorSpace 5829 */ 5830 setColorSpace(colorSpace: ColorSpace): Promise<void>; 5831 5832 /** 5833 * Sets the specified color space. 5834 * 5835 * @param { ColorSpace } colorSpace the specified color space. 5836 * @param { AsyncCallback<void> } callback Callback used to return the result. 5837 * @syscap SystemCapability.WindowManager.WindowManager.Core 5838 * @since 8 5839 * @deprecated since 9 5840 * @useinstead ohos.window.Window#setWindowColorSpace 5841 */ 5842 setColorSpace(colorSpace: ColorSpace, callback: AsyncCallback<void>): void; 5843 5844 /** 5845 * Sets the specified color space. 5846 * 5847 * @param { ColorSpace } colorSpace the specified color space. 5848 * @returns { Promise<void> } Promise that returns no value. 5849 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5850 * 2. Incorrect parameter types; 5851 * 3. Parameter verification failed. 5852 * @throws { BusinessError } 1300002 - This window state is abnormal. 5853 * @syscap SystemCapability.WindowManager.WindowManager.Core 5854 * @since 9 5855 */ 5856 /** 5857 * Sets the specified color space. 5858 * 5859 * @param { ColorSpace } colorSpace the specified color space. 5860 * @returns { Promise<void> } Promise that returns no value. 5861 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5862 * 2. Incorrect parameter types; 5863 * 3. Parameter verification failed. 5864 * @throws { BusinessError } 1300002 - This window state is abnormal. 5865 * @syscap SystemCapability.WindowManager.WindowManager.Core 5866 * @crossplatform 5867 * @since 11 5868 */ 5869 /** 5870 * Sets the specified color space. 5871 * 5872 * @param { ColorSpace } colorSpace the specified color space. 5873 * @returns { Promise<void> } Promise that returns no value. 5874 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5875 * 2. Incorrect parameter types; 5876 * 3. Parameter verification failed. 5877 * @throws { BusinessError } 1300002 - This window state is abnormal. 5878 * @syscap SystemCapability.WindowManager.WindowManager.Core 5879 * @crossplatform 5880 * @atomicservice 5881 * @since 12 5882 */ 5883 setWindowColorSpace(colorSpace: ColorSpace): Promise<void>; 5884 5885 /** 5886 * Sets the specified color space. 5887 * 5888 * @param { ColorSpace } colorSpace the specified color space. 5889 * @param { AsyncCallback<void> } callback Callback used to return the result. 5890 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5891 * 2. Incorrect parameter types; 5892 * 3. Parameter verification failed. 5893 * @throws { BusinessError } 1300002 - This window state is abnormal. 5894 * @syscap SystemCapability.WindowManager.WindowManager.Core 5895 * @since 9 5896 */ 5897 /** 5898 * Sets the specified color space. 5899 * 5900 * @param { ColorSpace } colorSpace the specified color space. 5901 * @param { AsyncCallback<void> } callback Callback used to return the result. 5902 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5903 * 2. Incorrect parameter types; 5904 * 3. Parameter verification failed. 5905 * @throws { BusinessError } 1300002 - This window state is abnormal. 5906 * @syscap SystemCapability.WindowManager.WindowManager.Core 5907 * @crossplatform 5908 * @since 11 5909 */ 5910 /** 5911 * Sets the specified color space. 5912 * 5913 * @param { ColorSpace } colorSpace the specified color space. 5914 * @param { AsyncCallback<void> } callback Callback used to return the result. 5915 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 5916 * 2. Incorrect parameter types; 5917 * 3. Parameter verification failed. 5918 * @throws { BusinessError } 1300002 - This window state is abnormal. 5919 * @syscap SystemCapability.WindowManager.WindowManager.Core 5920 * @crossplatform 5921 * @atomicservice 5922 * @since 12 5923 */ 5924 setWindowColorSpace(colorSpace: ColorSpace, callback: AsyncCallback<void>): void; 5925 5926 /** 5927 * Obtains the set color space. 5928 * 5929 * @returns { Promise<ColorSpace> } Promise used to return the current color space. 5930 * @syscap SystemCapability.WindowManager.WindowManager.Core 5931 * @since 8 5932 * @deprecated since 9 5933 * @useinstead ohos.window.Window#getWindowColorSpace 5934 */ 5935 getColorSpace(): Promise<ColorSpace>; 5936 5937 /** 5938 * Obtains the set color space. 5939 * 5940 * @param { AsyncCallback<ColorSpace> } callback Callback used to return the result. 5941 * @syscap SystemCapability.WindowManager.WindowManager.Core 5942 * @since 8 5943 * @deprecated since 9 5944 * @useinstead ohos.window.Window#getWindowColorSpace 5945 */ 5946 getColorSpace(callback: AsyncCallback<ColorSpace>): void; 5947 5948 /** 5949 * Obtains the set color space. 5950 * 5951 * @returns { ColorSpace } Color space obtained. 5952 * @throws { BusinessError } 1300002 - This window state is abnormal. 5953 * @syscap SystemCapability.WindowManager.WindowManager.Core 5954 * @since 9 5955 */ 5956 /** 5957 * Obtains the set color space. 5958 * 5959 * @returns { ColorSpace } Color space obtained. 5960 * @throws { BusinessError } 1300002 - This window state is abnormal. 5961 * @syscap SystemCapability.WindowManager.WindowManager.Core 5962 * @crossplatform 5963 * @since 11 5964 */ 5965 /** 5966 * Obtains the set color space. 5967 * 5968 * @returns { ColorSpace } Color space obtained. 5969 * @throws { BusinessError } 1300002 - This window state is abnormal. 5970 * @syscap SystemCapability.WindowManager.WindowManager.Core 5971 * @crossplatform 5972 * @atomicservice 5973 * @since 12 5974 */ 5975 getWindowColorSpace(): ColorSpace; 5976 5977 /** 5978 * Sets the background color of window. 5979 * 5980 * @param { string } color the specified color. 5981 * @returns { Promise<void> } Promise that returns no value. 5982 * @syscap SystemCapability.WindowManager.WindowManager.Core 5983 * @since 6 5984 * @deprecated since 9 5985 * @useinstead ohos.window.Window#setWindowBackgroundColor 5986 */ 5987 setBackgroundColor(color: string): Promise<void>; 5988 5989 /** 5990 * Sets the background color of window. 5991 * 5992 * @param { string } color the specified color. 5993 * @param { AsyncCallback<void> } callback Callback used to return the result. 5994 * @syscap SystemCapability.WindowManager.WindowManager.Core 5995 * @since 6 5996 * @deprecated since 9 5997 * @useinstead ohos.window.Window#setWindowBackgroundColor 5998 */ 5999 setBackgroundColor(color: string, callback: AsyncCallback<void>): void; 6000 6001 /** 6002 * Sets the background color of window. 6003 * 6004 * @param { string } color the specified color. 6005 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6006 * 2. Incorrect parameter types. 6007 * @throws { BusinessError } 1300002 - This window state is abnormal. 6008 * @syscap SystemCapability.WindowManager.WindowManager.Core 6009 * @since 9 6010 */ 6011 /** 6012 * Sets the background color of window. 6013 * 6014 * @param { string } color the specified color. 6015 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6016 * 2. Incorrect parameter types. 6017 * @throws { BusinessError } 1300002 - This window state is abnormal. 6018 * @syscap SystemCapability.WindowManager.WindowManager.Core 6019 * @crossplatform 6020 * @since 10 6021 */ 6022 /** 6023 * Sets the background color of window. 6024 * 6025 * @param { string } color the specified color. 6026 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6027 * 2. Incorrect parameter types. 6028 * @throws { BusinessError } 1300002 - This window state is abnormal. 6029 * @syscap SystemCapability.WindowManager.WindowManager.Core 6030 * @crossplatform 6031 * @atomicservice 6032 * @since 11 6033 */ 6034 setWindowBackgroundColor(color: string): void; 6035 6036 /** 6037 * Sets the brightness of window. 6038 * 6039 * @param { number } brightness the specified brightness value. 6040 * @returns { Promise<void> } Promise that returns no value. 6041 * @syscap SystemCapability.WindowManager.WindowManager.Core 6042 * @since 6 6043 * @deprecated since 9 6044 * @useinstead ohos.window.Window#setWindowBrightness 6045 */ 6046 setBrightness(brightness: number): Promise<void>; 6047 6048 /** 6049 * Sets the brightness of window. 6050 * 6051 * @param { number } brightness the specified brightness value. 6052 * @param { AsyncCallback<void> } callback Callback used to return the result. 6053 * @syscap SystemCapability.WindowManager.WindowManager.Core 6054 * @since 6 6055 * @deprecated since 9 6056 * @useinstead ohos.window.Window#setWindowBrightness 6057 */ 6058 setBrightness(brightness: number, callback: AsyncCallback<void>): void; 6059 6060 /** 6061 * Set whether the main window is topmost. 6062 * 6063 * @param { boolean } isTopmost - Main window is topmost if true. 6064 * @returns { Promise<void> } Promise that returns no value. 6065 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6066 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6067 * 2. Incorrect parameter types. 6068 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 6069 * @throws { BusinessError } 1300002 - This window state is abnormal. 6070 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6071 * @throws { BusinessError } 1300004 - Unauthorized operation. 6072 * @syscap SystemCapability.Window.SessionManager 6073 * @systemapi 6074 * @since 12 6075 */ 6076 setTopmost(isTopmost: boolean): Promise<void>; 6077 6078 /** 6079 * Set whether the main window is topmost. 6080 * 6081 * @permission ohos.permission.WINDOW_TOPMOST 6082 * @param { boolean } isWindowTopmost - Main window is topmost if true. 6083 * @returns { Promise<void> } Promise that returns no value. 6084 * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. 6085 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6086 * 2. Incorrect parameter types. 6087 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 6088 * @throws { BusinessError } 1300002 - This window state is abnormal. 6089 * @throws { BusinessError } 1300004 - Unauthorized operation. 6090 * @syscap SystemCapability.Window.SessionManager 6091 * @atomicservice 6092 * @since 14 6093 */ 6094 setWindowTopmost(isWindowTopmost: boolean): Promise<void>; 6095 6096 /** 6097 * Sets the brightness of window. 6098 * 6099 * @param { number } brightness the specified brightness value. 6100 * @returns { Promise<void> } Promise that returns no value. 6101 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6102 * 2. Incorrect parameter types. 6103 * @throws { BusinessError } 1300002 - This window state is abnormal. 6104 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6105 * @syscap SystemCapability.WindowManager.WindowManager.Core 6106 * @since 9 6107 */ 6108 /** 6109 * Sets the brightness of window. 6110 * 6111 * @param { number } brightness the specified brightness value. 6112 * @returns { Promise<void> } Promise that returns no value. 6113 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6114 * 2. Incorrect parameter types. 6115 * @throws { BusinessError } 1300002 - This window state is abnormal. 6116 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6117 * @syscap SystemCapability.WindowManager.WindowManager.Core 6118 * @crossplatform 6119 * @since 10 6120 */ 6121 /** 6122 * Sets the brightness of window. 6123 * 6124 * @param { number } brightness the specified brightness value. 6125 * @returns { Promise<void> } Promise that returns no value. 6126 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6127 * 2. Incorrect parameter types. 6128 * @throws { BusinessError } 1300002 - This window state is abnormal. 6129 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6130 * @syscap SystemCapability.WindowManager.WindowManager.Core 6131 * @crossplatform 6132 * @atomicservice 6133 * @since 11 6134 */ 6135 setWindowBrightness(brightness: number): Promise<void>; 6136 6137 /** 6138 * Sets the brightness of window. 6139 * 6140 * @param { number } brightness the specified brightness value. 6141 * @param { AsyncCallback<void> } callback Callback used to return the result. 6142 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6143 * 2. Incorrect parameter types. 6144 * @throws { BusinessError } 1300002 - This window state is abnormal. 6145 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6146 * @syscap SystemCapability.WindowManager.WindowManager.Core 6147 * @since 9 6148 */ 6149 /** 6150 * Sets the brightness of window. 6151 * 6152 * @param { number } brightness the specified brightness value. 6153 * @param { AsyncCallback<void> } callback Callback used to return the result. 6154 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6155 * 2. Incorrect parameter types. 6156 * @throws { BusinessError } 1300002 - This window state is abnormal. 6157 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6158 * @syscap SystemCapability.WindowManager.WindowManager.Core 6159 * @crossplatform 6160 * @since 10 6161 */ 6162 /** 6163 * Sets the brightness of window. 6164 * 6165 * @param { number } brightness the specified brightness value. 6166 * @param { AsyncCallback<void> } callback Callback used to return the result. 6167 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6168 * 2. Incorrect parameter types. 6169 * @throws { BusinessError } 1300002 - This window state is abnormal. 6170 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6171 * @syscap SystemCapability.WindowManager.WindowManager.Core 6172 * @crossplatform 6173 * @atomicservice 6174 * @since 11 6175 */ 6176 setWindowBrightness(brightness: number, callback: AsyncCallback<void>): void; 6177 6178 /** 6179 * Sets the dimBehind of window. 6180 * 6181 * @param { number } dimBehindValue - The specified dimBehind. 6182 * @param { AsyncCallback<void> } callback Callback used to return the result. 6183 * @syscap SystemCapability.WindowManager.WindowManager.Core 6184 * @since 7 6185 * @deprecated since 9 6186 */ 6187 setDimBehind(dimBehindValue: number, callback: AsyncCallback<void>): void; 6188 6189 /** 6190 * Sets the dimBehind of window. 6191 * 6192 * @param { number } dimBehindValue - The specified dimBehind. 6193 * @returns { Promise<void> } Promise that returns no value. 6194 * @syscap SystemCapability.WindowManager.WindowManager.Core 6195 * @since 7 6196 * @deprecated since 9 6197 */ 6198 setDimBehind(dimBehindValue: number): Promise<void>; 6199 6200 /** 6201 * Sets whether focusable or not. 6202 * 6203 * @param { boolean } isFocusable can be focus if true, or can not be focus if false. 6204 * @returns { Promise<void> } Promise that returns no value. 6205 * @syscap SystemCapability.WindowManager.WindowManager.Core 6206 * @since 7 6207 * @deprecated since 9 6208 * @useinstead ohos.window.Window#setWindowFocusable 6209 */ 6210 setFocusable(isFocusable: boolean): Promise<void>; 6211 6212 /** 6213 * Sets whether focusable or not. 6214 * 6215 * @param { boolean } isFocusable can be focus if true, or can not be focus if false. 6216 * @param { AsyncCallback<void> } callback Callback used to return the result. 6217 * @syscap SystemCapability.WindowManager.WindowManager.Core 6218 * @since 7 6219 * @deprecated since 9 6220 * @useinstead ohos.window.Window#setWindowFocusable 6221 */ 6222 setFocusable(isFocusable: boolean, callback: AsyncCallback<void>): void; 6223 6224 /** 6225 * Sets whether focusable or not. 6226 * 6227 * @param { boolean } isFocusable can be focus if true, or can not be focus if false. 6228 * @returns { Promise<void> } Promise that returns no value. 6229 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6230 * 2. Incorrect parameter types. 6231 * @throws { BusinessError } 1300002 - This window state is abnormal. 6232 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6233 * @syscap SystemCapability.WindowManager.WindowManager.Core 6234 * @since 9 6235 */ 6236 /** 6237 * Sets whether focusable or not. 6238 * 6239 * @param { boolean } isFocusable can be focus if true, or can not be focus if false. 6240 * @returns { Promise<void> } Promise that returns no value. 6241 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6242 * 2. Incorrect parameter types. 6243 * @throws { BusinessError } 1300002 - This window state is abnormal. 6244 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6245 * @syscap SystemCapability.WindowManager.WindowManager.Core 6246 * @atomicservice 6247 * @since 12 6248 */ 6249 setWindowFocusable(isFocusable: boolean): Promise<void>; 6250 6251 /** 6252 * Sets whether focusable or not. 6253 * 6254 * @param { boolean } isFocusable can be focus if true, or can not be focus if false. 6255 * @param { AsyncCallback<void> } callback Callback used to return the result. 6256 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6257 * 2. Incorrect parameter types. 6258 * @throws { BusinessError } 1300002 - This window state is abnormal. 6259 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6260 * @syscap SystemCapability.WindowManager.WindowManager.Core 6261 * @since 9 6262 */ 6263 /** 6264 * Sets whether focusable or not. 6265 * 6266 * @param { boolean } isFocusable can be focus if true, or can not be focus if false. 6267 * @param { AsyncCallback<void> } callback Callback used to return the result. 6268 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6269 * 2. Incorrect parameter types. 6270 * @throws { BusinessError } 1300002 - This window state is abnormal. 6271 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6272 * @syscap SystemCapability.WindowManager.WindowManager.Core 6273 * @atomicservice 6274 * @since 12 6275 */ 6276 setWindowFocusable(isFocusable: boolean, callback: AsyncCallback<void>): void; 6277 6278 /** 6279 * Window requests to get focus or lose focus. 6280 * 6281 * @param { boolean } isFocused - Window requests to get focus if true, requests to lose focus if false. 6282 * @returns { Promise<void> } - Promise that returns no value. 6283 * @throws { BusinessError } 202 - Permission verification failed, non-system application uses system API. 6284 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6285 * 2. Incorrect parameter types. 6286 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 6287 * @throws { BusinessError } 1300002 - This window state is abnormal. 6288 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6289 * @syscap SystemCapability.Window.SessionManager 6290 * @systemapi 6291 * @since 13 6292 */ 6293 requestFocus(isFocused: boolean): Promise<void>; 6294 6295 /** 6296 * Sets whether keep screen on or not. 6297 * 6298 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6299 * @returns { Promise<void> } that returns no value. 6300 * @syscap SystemCapability.WindowManager.WindowManager.Core 6301 * @since 6 6302 * @deprecated since 9 6303 * @useinstead ohos.window.Window#setWindowKeepScreenOn 6304 */ 6305 setKeepScreenOn(isKeepScreenOn: boolean): Promise<void>; 6306 6307 /** 6308 * Sets whether keep screen on or not. 6309 * 6310 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6311 * @param { AsyncCallback<void> } callback Callback used to return the result. 6312 * @syscap SystemCapability.WindowManager.WindowManager.Core 6313 * @since 6 6314 * @deprecated since 9 6315 * @useinstead ohos.window.Window#setWindowKeepScreenOn 6316 */ 6317 setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback<void>): void; 6318 6319 /** 6320 * Sets whether keep screen on or not. 6321 * 6322 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6323 * @returns { Promise<void> } Promise that returns no value. 6324 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6325 * 2. Incorrect parameter types. 6326 * @throws { BusinessError } 1300002 - This window state is abnormal. 6327 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6328 * @syscap SystemCapability.WindowManager.WindowManager.Core 6329 * @since 9 6330 */ 6331 /** 6332 * Sets whether keep screen on or not. 6333 * 6334 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6335 * @returns { Promise<void> } Promise that returns no value. 6336 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6337 * 2. Incorrect parameter types. 6338 * @throws { BusinessError } 1300002 - This window state is abnormal. 6339 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6340 * @syscap SystemCapability.WindowManager.WindowManager.Core 6341 * @crossplatform 6342 * @since 10 6343 */ 6344 /** 6345 * Sets whether keep screen on or not. 6346 * 6347 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6348 * @returns { Promise<void> } Promise that returns no value. 6349 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6350 * 2. Incorrect parameter types. 6351 * @throws { BusinessError } 1300002 - This window state is abnormal. 6352 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6353 * @syscap SystemCapability.WindowManager.WindowManager.Core 6354 * @crossplatform 6355 * @atomicservice 6356 * @since 11 6357 */ 6358 setWindowKeepScreenOn(isKeepScreenOn: boolean): Promise<void>; 6359 6360 /** 6361 * Sets whether keep screen on or not. 6362 * 6363 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6364 * @param { AsyncCallback<void> } callback Callback used to return the result. 6365 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6366 * 2. Incorrect parameter types. 6367 * @throws { BusinessError } 1300002 - This window state is abnormal. 6368 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6369 * @syscap SystemCapability.WindowManager.WindowManager.Core 6370 * @since 9 6371 */ 6372 /** 6373 * Sets whether keep screen on or not. 6374 * 6375 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6376 * @param { AsyncCallback<void> } callback Callback used to return the result. 6377 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6378 * 2. Incorrect parameter types. 6379 * @throws { BusinessError } 1300002 - This window state is abnormal. 6380 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6381 * @syscap SystemCapability.WindowManager.WindowManager.Core 6382 * @crossplatform 6383 * @since 10 6384 */ 6385 /** 6386 * Sets whether keep screen on or not. 6387 * 6388 * @param { boolean } isKeepScreenOn keep screen on if true, or not if false. 6389 * @param { AsyncCallback<void> } callback Callback used to return the result. 6390 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6391 * 2. Incorrect parameter types. 6392 * @throws { BusinessError } 1300002 - This window state is abnormal. 6393 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6394 * @syscap SystemCapability.WindowManager.WindowManager.Core 6395 * @crossplatform 6396 * @atomicservice 6397 * @since 11 6398 */ 6399 setWindowKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback<void>): void; 6400 6401 /** 6402 * Sets whether to wake up the screen when this ability is restored. 6403 * 6404 * @param { boolean } wakeUp Specifies whether to wake up the screen. True means to wake it up, false means not. 6405 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6406 * 2. Incorrect parameter types. 6407 * @throws { BusinessError } 1300002 - This window state is abnormal. 6408 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6409 * @syscap SystemCapability.WindowManager.WindowManager.Core 6410 * @systemapi Hide this for inner system use. 6411 * @since 9 6412 */ 6413 /** 6414 * Sets whether to wake up the screen when this ability is restored. 6415 * 6416 * @param { boolean } wakeUp Specifies whether to wake up the screen. True means to wake it up, false means not. 6417 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6418 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6419 * 2. Incorrect parameter types. 6420 * @throws { BusinessError } 1300002 - This window state is abnormal. 6421 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6422 * @syscap SystemCapability.WindowManager.WindowManager.Core 6423 * @systemapi Hide this for inner system use. 6424 * @since 12 6425 */ 6426 setWakeUpScreen(wakeUp: boolean): void; 6427 6428 /** 6429 * Sets whether outside can be touch or not. 6430 * 6431 * @param { boolean } touchable outside can be touch if true, or not if false. 6432 * @returns { Promise<void> } Promise that returns no value. 6433 * @syscap SystemCapability.WindowManager.WindowManager.Core 6434 * @since 7 6435 * @deprecated since 9 6436 */ 6437 setOutsideTouchable(touchable: boolean): Promise<void>; 6438 6439 /** 6440 * Sets whether outside can be touch or not. 6441 * 6442 * @param { boolean } touchable outside can be touch if true, or not if false. 6443 * @param { AsyncCallback<void> } callback Callback used to return the result. 6444 * @syscap SystemCapability.WindowManager.WindowManager.Core 6445 * @since 7 6446 * @deprecated since 9 6447 */ 6448 setOutsideTouchable(touchable: boolean, callback: AsyncCallback<void>): void; 6449 6450 /** 6451 * Sets whether is private mode or not. 6452 * 6453 * @param { boolean } isPrivacyMode in private mode 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 * @useinstead ohos.window.Window#setWindowPrivacyMode 6459 */ 6460 setPrivacyMode(isPrivacyMode: boolean): Promise<void>; 6461 6462 /** 6463 * Sets whether is private mode or not. 6464 * 6465 * @param { boolean } isPrivacyMode in private mode if true, or not if false. 6466 * @param { AsyncCallback<void> } callback Callback used to return the result. 6467 * @syscap SystemCapability.WindowManager.WindowManager.Core 6468 * @since 7 6469 * @deprecated since 9 6470 * @useinstead ohos.window.Window#setWindowPrivacyMode 6471 */ 6472 setPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback<void>): void; 6473 6474 /** 6475 * Sets whether is private mode or not. 6476 * 6477 * @permission ohos.permission.PRIVACY_WINDOW 6478 * @param { boolean } isPrivacyMode in private mode if true, or not if false. 6479 * @returns { Promise<void> } Promise that returns no value. 6480 * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. 6481 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6482 * 2. Incorrect parameter types. 6483 * @throws { BusinessError } 1300002 - This window state is abnormal. 6484 * @syscap SystemCapability.WindowManager.WindowManager.Core 6485 * @since 9 6486 */ 6487 /** 6488 * Sets whether is private mode or not. 6489 * 6490 * @permission ohos.permission.PRIVACY_WINDOW 6491 * @param { boolean } isPrivacyMode in private mode if true, or not if false. 6492 * @returns { Promise<void> } Promise that returns no value. 6493 * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. 6494 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6495 * 2. Incorrect parameter types. 6496 * @throws { BusinessError } 1300002 - This window state is abnormal. 6497 * @syscap SystemCapability.WindowManager.WindowManager.Core 6498 * @atomicservice 6499 * @since 12 6500 */ 6501 setWindowPrivacyMode(isPrivacyMode: boolean): Promise<void>; 6502 6503 /** 6504 * Sets whether is private mode or not. 6505 * 6506 * @permission ohos.permission.PRIVACY_WINDOW 6507 * @param { boolean } isPrivacyMode in private mode if true, or not if false. 6508 * @param { AsyncCallback<void> } callback Callback used to return the result. 6509 * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. 6510 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6511 * 2. Incorrect parameter types. 6512 * @throws { BusinessError } 1300002 - This window state is abnormal. 6513 * @syscap SystemCapability.WindowManager.WindowManager.Core 6514 * @since 9 6515 */ 6516 /** 6517 * Sets whether is private mode or not. 6518 * 6519 * @permission ohos.permission.PRIVACY_WINDOW 6520 * @param { boolean } isPrivacyMode in private mode if true, or not if false. 6521 * @param { AsyncCallback<void> } callback Callback used to return the result. 6522 * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. 6523 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6524 * 2. Incorrect parameter types. 6525 * @throws { BusinessError } 1300002 - This window state is abnormal. 6526 * @syscap SystemCapability.WindowManager.WindowManager.Core 6527 * @atomicservice 6528 * @since 12 6529 */ 6530 setWindowPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback<void>): void; 6531 6532 /** 6533 * Ignore this window during screenshot. 6534 * 6535 * @param { boolean } isSkip skip if true, or not if false. 6536 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6537 * 2. Incorrect parameter types. 6538 * @throws { BusinessError } 1300002 - This window state is abnormal. 6539 * @syscap SystemCapability.WindowManager.WindowManager.Core 6540 * @systemapi Hide this for inner system use. 6541 * @since 9 6542 */ 6543 /** 6544 * Ignore this window during screenshot. 6545 * 6546 * @param { boolean } isSkip skip if true, or not if false. 6547 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6548 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6549 * 2. Incorrect parameter types. 6550 * @throws { BusinessError } 1300002 - This window state is abnormal. 6551 * @syscap SystemCapability.WindowManager.WindowManager.Core 6552 * @systemapi Hide this for inner system use. 6553 * @since 12 6554 */ 6555 setSnapshotSkip(isSkip: boolean): void; 6556 6557 /** 6558 * Sets whether is touchable or not. 6559 * 6560 * @param { boolean } isTouchable is touchable if true, or not if false. 6561 * @returns { Promise<void> } Promise that returns no value. 6562 * @syscap SystemCapability.WindowManager.WindowManager.Core 6563 * @since 7 6564 * @deprecated since 9 6565 * @useinstead ohos.window.Window#setWindowTouchable 6566 */ 6567 setTouchable(isTouchable: boolean): Promise<void>; 6568 6569 /** 6570 * Sets whether is touchable or not. 6571 * 6572 * @param { boolean } isTouchable is touchable if true, or not if false. 6573 * @param { AsyncCallback<void> } callback Callback used to return the result. 6574 * @syscap SystemCapability.WindowManager.WindowManager.Core 6575 * @since 7 6576 * @deprecated since 9 6577 * @useinstead ohos.window.Window#setWindowTouchable 6578 */ 6579 setTouchable(isTouchable: boolean, callback: AsyncCallback<void>): void; 6580 6581 /** 6582 * Sets whether is touchable or not. 6583 * 6584 * @param { boolean } isTouchable is touchable if true, or not if false. 6585 * @returns { Promise<void> } Promise that returns no value. 6586 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6587 * 2. Incorrect parameter types. 6588 * @throws { BusinessError } 1300002 - This window state is abnormal. 6589 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6590 * @syscap SystemCapability.WindowManager.WindowManager.Core 6591 * @since 9 6592 */ 6593 /** 6594 * Sets whether is touchable or not. 6595 * 6596 * @param { boolean } isTouchable is touchable if true, or not if false. 6597 * @returns { Promise<void> } Promise that returns no value. 6598 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6599 * 2. Incorrect parameter types. 6600 * @throws { BusinessError } 1300002 - This window state is abnormal. 6601 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6602 * @syscap SystemCapability.WindowManager.WindowManager.Core 6603 * @atomicservice 6604 * @since 12 6605 */ 6606 setWindowTouchable(isTouchable: boolean): Promise<void>; 6607 6608 /** 6609 * Sets whether is touchable or not. 6610 * 6611 * @param { boolean } isTouchable is touchable if true, or not if false. 6612 * @param { AsyncCallback<void> } callback Callback used to return the result. 6613 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6614 * 2. Incorrect parameter types. 6615 * @throws { BusinessError } 1300002 - This window state is abnormal. 6616 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6617 * @syscap SystemCapability.WindowManager.WindowManager.Core 6618 * @since 9 6619 */ 6620 /** 6621 * Sets whether is touchable or not. 6622 * 6623 * @param { boolean } isTouchable is touchable if true, or not if false. 6624 * @param { AsyncCallback<void> } callback Callback used to return the result. 6625 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6626 * 2. Incorrect parameter types. 6627 * @throws { BusinessError } 1300002 - This window state is abnormal. 6628 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6629 * @syscap SystemCapability.WindowManager.WindowManager.Core 6630 * @atomicservice 6631 * @since 12 6632 */ 6633 setWindowTouchable(isTouchable: boolean, callback: AsyncCallback<void>): void; 6634 6635 /** 6636 * Set handwrite flag on the window. This flag means only response handwrite event. 6637 * 6638 * @param { boolean } enable - Add handwrite flag to window if true, or remove flag if false. 6639 * @returns { Promise<void> } - The promise returned by the function. 6640 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6641 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6642 * 2. Incorrect parameter types. 6643 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 6644 * @throws { BusinessError } 1300002 - This window state is abnormal. 6645 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6646 * @syscap SystemCapability.Window.SessionManager 6647 * @systemapi Hide this for inner system use. 6648 * @since 12 6649 */ 6650 setHandwritingFlag(enable: boolean): Promise<void>; 6651 6652 /** 6653 * Sets the flag of the window is forbidden to move in split screen mode 6654 * 6655 * @param { boolean } isForbidSplitMove the flag of the window is forbidden to move in split screen mode 6656 * @param { AsyncCallback<void> } callback Callback used to return the result. 6657 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6658 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6659 * 2. Incorrect parameter types. 6660 * @throws { BusinessError } 1300002 - This window state is abnormal. 6661 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6662 * @syscap SystemCapability.WindowManager.WindowManager.Core 6663 * @systemapi 6664 * @since 9 6665 */ 6666 setForbidSplitMove(isForbidSplitMove: boolean, callback: AsyncCallback<void>): void; 6667 6668 /** 6669 * Sets the flag of the window is forbidden to move in split screen mode 6670 * 6671 * @param { boolean } isForbidSplitMove the flag of the window is forbidden to move in split screen mode 6672 * @returns { Promise<void> } Promise that returns no value. 6673 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6674 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6675 * 2. Incorrect parameter types. 6676 * @throws { BusinessError } 1300002 - This window state is abnormal. 6677 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 6678 * @syscap SystemCapability.WindowManager.WindowManager.Core 6679 * @systemapi 6680 * @since 9 6681 */ 6682 setForbidSplitMove(isForbidSplitMove: boolean): Promise<void>; 6683 6684 /** 6685 * Obtains snapshot of window 6686 * 6687 * @param { AsyncCallback<image.PixelMap> } callback Callback used to return the result. 6688 * @throws { BusinessError } 1300002 - This window state is abnormal. 6689 * @syscap SystemCapability.WindowManager.WindowManager.Core 6690 * @since 9 6691 */ 6692 /** 6693 * Obtains snapshot of window 6694 * 6695 * @param { AsyncCallback<image.PixelMap> } callback Callback used to return the result. 6696 * @throws { BusinessError } 1300002 - This window state is abnormal. 6697 * @syscap SystemCapability.WindowManager.WindowManager.Core 6698 * @atomicservice 6699 * @since 12 6700 */ 6701 snapshot(callback: AsyncCallback<image.PixelMap>): void; 6702 6703 /** 6704 * Obtains snapshot of window 6705 * 6706 * @returns { Promise<image.PixelMap> } Promise that returns no value. 6707 * @throws { BusinessError } 1300002 - This window state is abnormal. 6708 * @syscap SystemCapability.WindowManager.WindowManager.Core 6709 * @since 9 6710 */ 6711 /** 6712 * Obtains snapshot of window 6713 * 6714 * @returns { Promise<image.PixelMap> } Promise that returns no value. 6715 * @throws { BusinessError } 1300002 - This window state is abnormal. 6716 * @syscap SystemCapability.WindowManager.WindowManager.Core 6717 * @atomicservice 6718 * @since 12 6719 */ 6720 snapshot(): Promise<image.PixelMap>; 6721 6722 /** 6723 * Sets opacity of window 6724 * 6725 * @param { number } opacity Interval is 0.f-1.f. 6726 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6727 * 2. Incorrect parameter types; 6728 * 3. Parameter verification failed. 6729 * @throws { BusinessError } 1300002 - This window state is abnormal. 6730 * @throws { BusinessError } 1300004 - Unauthorized operation. 6731 * @syscap SystemCapability.WindowManager.WindowManager.Core 6732 * @systemapi 6733 * @since 9 6734 */ 6735 /** 6736 * Sets opacity of window 6737 * 6738 * @param { number } opacity Interval is 0.f-1.f. 6739 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6740 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6741 * 2. Incorrect parameter types; 6742 * 3. Parameter verification failed. 6743 * @throws { BusinessError } 1300002 - This window state is abnormal. 6744 * @throws { BusinessError } 1300004 - Unauthorized operation. 6745 * @syscap SystemCapability.WindowManager.WindowManager.Core 6746 * @systemapi 6747 * @since 12 6748 */ 6749 opacity(opacity: number): void; 6750 6751 /** 6752 * Sets scale options of window. 6753 * 6754 * @param { ScaleOptions } scaleOptions scale param of window. 6755 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6756 * 2. Incorrect parameter types; 6757 * 3. Parameter verification failed. 6758 * @throws { BusinessError } 1300002 - This window state is abnormal. 6759 * @throws { BusinessError } 1300004 - Unauthorized operation. 6760 * @syscap SystemCapability.WindowManager.WindowManager.Core 6761 * @systemapi 6762 * @since 9 6763 */ 6764 /** 6765 * Sets scale options of window. 6766 * 6767 * @param { ScaleOptions } scaleOptions scale param of window. 6768 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6769 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6770 * 2. Incorrect parameter types; 6771 * 3. Parameter verification failed. 6772 * @throws { BusinessError } 1300002 - This window state is abnormal. 6773 * @throws { BusinessError } 1300004 - Unauthorized operation. 6774 * @syscap SystemCapability.WindowManager.WindowManager.Core 6775 * @systemapi 6776 * @since 12 6777 */ 6778 scale(scaleOptions: ScaleOptions): void; 6779 6780 /** 6781 * Sets rotate options of window. 6782 * 6783 * @param { RotateOptions } rotateOptions rotate param of window. 6784 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6785 * 2. Incorrect parameter types; 6786 * 3. Parameter verification failed. 6787 * @throws { BusinessError } 1300002 - This window state is abnormal. 6788 * @throws { BusinessError } 1300004 - Unauthorized operation. 6789 * @syscap SystemCapability.WindowManager.WindowManager.Core 6790 * @systemapi 6791 * @since 9 6792 */ 6793 /** 6794 * Sets rotate options of window. 6795 * 6796 * @param { RotateOptions } rotateOptions rotate param of window. 6797 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6798 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6799 * 2. Incorrect parameter types; 6800 * 3. Parameter verification failed. 6801 * @throws { BusinessError } 1300002 - This window state is abnormal. 6802 * @throws { BusinessError } 1300004 - Unauthorized operation. 6803 * @syscap SystemCapability.WindowManager.WindowManager.Core 6804 * @systemapi 6805 * @since 12 6806 */ 6807 rotate(rotateOptions: RotateOptions): void; 6808 6809 /** 6810 * Sets translate options of window. 6811 * 6812 * @param { TranslateOptions } translateOptions translate param of window. 6813 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6814 * 2. Incorrect parameter types; 6815 * 3. Parameter verification failed. 6816 * @throws { BusinessError } 1300002 - This window state is abnormal. 6817 * @throws { BusinessError } 1300004 - Unauthorized operation. 6818 * @syscap SystemCapability.WindowManager.WindowManager.Core 6819 * @systemapi 6820 * @since 9 6821 */ 6822 /** 6823 * Sets translate options of window. 6824 * 6825 * @param { TranslateOptions } translateOptions translate param of window. 6826 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6827 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6828 * 2. Incorrect parameter types; 6829 * 3. Parameter verification failed. 6830 * @throws { BusinessError } 1300002 - This window state is abnormal. 6831 * @throws { BusinessError } 1300004 - Unauthorized operation. 6832 * @syscap SystemCapability.WindowManager.WindowManager.Core 6833 * @systemapi 6834 * @since 12 6835 */ 6836 translate(translateOptions: TranslateOptions): void; 6837 6838 /** 6839 * Get Transition Controller. 6840 * 6841 * @returns { TransitionController } 6842 * @throws { BusinessError } 1300002 - This window state is abnormal. 6843 * @throws { BusinessError } 1300004 - Unauthorized operation. 6844 * @syscap SystemCapability.WindowManager.WindowManager.Core 6845 * @systemapi 6846 * @since 9 6847 */ 6848 /** 6849 * Get Transition Controller. 6850 * 6851 * @returns { TransitionController } 6852 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6853 * @throws { BusinessError } 1300002 - This window state is abnormal. 6854 * @throws { BusinessError } 1300004 - Unauthorized operation. 6855 * @syscap SystemCapability.WindowManager.WindowManager.Core 6856 * @systemapi 6857 * @since 12 6858 */ 6859 getTransitionController(): TransitionController; 6860 6861 /** 6862 * Sets the window blur radius. 6863 * 6864 * @param { number } radius the blur radius. 6865 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6866 * 2. Incorrect parameter types; 6867 * 3. Parameter verification failed. 6868 * @throws { BusinessError } 1300002 - This window state is abnormal. 6869 * @throws { BusinessError } 1300004 - Unauthorized operation. 6870 * @syscap SystemCapability.WindowManager.WindowManager.Core 6871 * @systemapi Hide this for inner system use. 6872 * @since 9 6873 */ 6874 /** 6875 * Sets the window blur radius. 6876 * 6877 * @param { number } radius the blur radius. 6878 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6879 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6880 * 2. Incorrect parameter types; 6881 * 3. Parameter verification failed. 6882 * @throws { BusinessError } 1300002 - This window state is abnormal. 6883 * @throws { BusinessError } 1300004 - Unauthorized operation. 6884 * @syscap SystemCapability.WindowManager.WindowManager.Core 6885 * @systemapi Hide this for inner system use. 6886 * @since 12 6887 */ 6888 setBlur(radius: number): void; 6889 6890 /** 6891 * Sets the window backdrop blur radius. 6892 * 6893 * @param { number } radius the blur radius. 6894 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6895 * 2. Incorrect parameter types; 6896 * 3. Parameter verification failed. 6897 * @throws { BusinessError } 1300002 - This window state is abnormal. 6898 * @throws { BusinessError } 1300004 - Unauthorized operation. 6899 * @syscap SystemCapability.WindowManager.WindowManager.Core 6900 * @systemapi Hide this for inner system use. 6901 * @since 9 6902 */ 6903 /** 6904 * Sets the window backdrop blur radius. 6905 * 6906 * @param { number } radius the blur radius. 6907 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6908 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6909 * 2. Incorrect parameter types; 6910 * 3. Parameter verification failed. 6911 * @throws { BusinessError } 1300002 - This window state is abnormal. 6912 * @throws { BusinessError } 1300004 - Unauthorized operation. 6913 * @syscap SystemCapability.WindowManager.WindowManager.Core 6914 * @systemapi Hide this for inner system use. 6915 * @since 12 6916 */ 6917 setBackdropBlur(radius: number): void; 6918 6919 /** 6920 * Sets the window backdrop blur style. 6921 * 6922 * @param { BlurStyle } blurStyle the specified blur style. 6923 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6924 * 2. Incorrect parameter types; 6925 * 3. Parameter verification failed. 6926 * @throws { BusinessError } 1300002 - This window state is abnormal. 6927 * @throws { BusinessError } 1300004 - Unauthorized operation. 6928 * @syscap SystemCapability.WindowManager.WindowManager.Core 6929 * @systemapi Hide this for inner system use. 6930 * @since 9 6931 */ 6932 /** 6933 * Sets the window backdrop blur style. 6934 * 6935 * @param { BlurStyle } blurStyle the specified blur style. 6936 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6937 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6938 * 2. Incorrect parameter types; 6939 * 3. Parameter verification failed. 6940 * @throws { BusinessError } 1300002 - This window state is abnormal. 6941 * @throws { BusinessError } 1300004 - Unauthorized operation. 6942 * @syscap SystemCapability.WindowManager.WindowManager.Core 6943 * @systemapi Hide this for inner system use. 6944 * @since 12 6945 */ 6946 setBackdropBlurStyle(blurStyle: BlurStyle): void; 6947 6948 /** 6949 * Sets shadow. 6950 * 6951 * @param { number } radius the radius of the shadow. 6952 * @param { string } color the color of the shadow. 6953 * @param { number } offsetX the offset of the shadow on the x-axis. 6954 * @param { number } offsetY the offset of the shadow on the y-axis. 6955 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6956 * 2. Incorrect parameter types; 6957 * 3. Parameter verification failed. 6958 * @throws { BusinessError } 1300002 - This window state is abnormal. 6959 * @throws { BusinessError } 1300004 - Unauthorized operation. 6960 * @syscap SystemCapability.WindowManager.WindowManager.Core 6961 * @systemapi Hide this for inner system use. 6962 * @since 9 6963 */ 6964 /** 6965 * Sets shadow. 6966 * 6967 * @param { number } radius the radius of the shadow. 6968 * @param { string } color the color of the shadow. 6969 * @param { number } offsetX the offset of the shadow on the x-axis. 6970 * @param { number } offsetY the offset of the shadow on the y-axis. 6971 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 6972 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6973 * 2. Incorrect parameter types; 6974 * 3. Parameter verification failed. 6975 * @throws { BusinessError } 1300002 - This window state is abnormal. 6976 * @throws { BusinessError } 1300004 - Unauthorized operation. 6977 * @syscap SystemCapability.WindowManager.WindowManager.Core 6978 * @systemapi Hide this for inner system use. 6979 * @since 12 6980 */ 6981 setShadow(radius: number, color?: string, offsetX?: number, offsetY?: number): void; 6982 6983 /** 6984 * Sets corner radius. 6985 * 6986 * @param { number } cornerRadius the corner radius. 6987 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 6988 * 2. Incorrect parameter types; 6989 * 3. Parameter verification failed. 6990 * @throws { BusinessError } 1300002 - This window state is abnormal. 6991 * @throws { BusinessError } 1300004 - Unauthorized operation. 6992 * @syscap SystemCapability.WindowManager.WindowManager.Core 6993 * @systemapi Hide this for inner system use. 6994 * @since 9 6995 */ 6996 /** 6997 * Sets corner radius. 6998 * 6999 * @param { number } cornerRadius the corner radius. 7000 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7001 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7002 * 2. Incorrect parameter types; 7003 * 3. Parameter verification failed. 7004 * @throws { BusinessError } 1300002 - This window state is abnormal. 7005 * @throws { BusinessError } 1300004 - Unauthorized operation. 7006 * @syscap SystemCapability.WindowManager.WindowManager.Core 7007 * @systemapi Hide this for inner system use. 7008 * @since 12 7009 */ 7010 setCornerRadius(cornerRadius: number): void; 7011 7012 /** 7013 * Raise app sub window to app top 7014 * 7015 * @param { AsyncCallback<void> } callback - The callback of raiseToAppTop 7016 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7017 * @throws { BusinessError } 1300002 - This window state is abnormal. 7018 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7019 * @throws { BusinessError } 1300004 - Unauthorized operation. 7020 * @throws { BusinessError } 1300009 - The parent window is invalid. 7021 * @syscap SystemCapability.WindowManager.WindowManager.Core 7022 * @systemapi Hide this for inner system use. 7023 * @since 10 7024 */ 7025 raiseToAppTop(callback: AsyncCallback<void>): void; 7026 7027 /** 7028 * Raise app sub window to app top 7029 * 7030 * @returns { Promise<void> } - The promise returned by the function 7031 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7032 * @throws { BusinessError } 1300002 - This window state is abnormal. 7033 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7034 * @throws { BusinessError } 1300004 - Unauthorized operation. 7035 * @throws { BusinessError } 1300009 - The parent window is invalid. 7036 * @syscap SystemCapability.WindowManager.WindowManager.Core 7037 * @systemapi Hide this for inner system use. 7038 * @since 10 7039 */ 7040 raiseToAppTop(): Promise<void>; 7041 7042 /** 7043 * Sets the aspect ratio of window 7044 * 7045 * @param { number } ratio - The aspect ratio of window except decoration 7046 * @param { AsyncCallback<void> } callback - The callback of setAspectRatio. 7047 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7048 * 2. Incorrect parameter types; 7049 * 3. Parameter verification failed. 7050 * @throws { BusinessError } 1300002 - This window state is abnormal. 7051 * @throws { BusinessError } 1300004 - Unauthorized operation. 7052 * @syscap SystemCapability.WindowManager.WindowManager.Core 7053 * @since 10 7054 */ 7055 /** 7056 * Sets the aspect ratio of window 7057 * 7058 * @param { number } ratio - The aspect ratio of window except decoration 7059 * @param { AsyncCallback<void> } callback - The callback of setAspectRatio. 7060 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7061 * 2. Incorrect parameter types; 7062 * 3. Parameter verification failed. 7063 * @throws { BusinessError } 1300002 - This window state is abnormal. 7064 * @throws { BusinessError } 1300004 - Unauthorized operation. 7065 * @syscap SystemCapability.WindowManager.WindowManager.Core 7066 * @atomicservice 7067 * @since 12 7068 */ 7069 setAspectRatio(ratio: number, callback: AsyncCallback<void>): void; 7070 7071 /** 7072 * Sets the aspect ratio of window 7073 * 7074 * @param { number } ratio - The aspect ratio of window except decoration 7075 * @returns { Promise<void> } - The promise returned by the function. 7076 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7077 * 2. Incorrect parameter types; 7078 * 3. Parameter verification failed. 7079 * @throws { BusinessError } 1300002 - This window state is abnormal. 7080 * @throws { BusinessError } 1300004 - Unauthorized operation. 7081 * @syscap SystemCapability.WindowManager.WindowManager.Core 7082 * @since 10 7083 */ 7084 /** 7085 * Sets the aspect ratio of window 7086 * 7087 * @param { number } ratio - The aspect ratio of window except decoration 7088 * @returns { Promise<void> } - The promise returned by the function. 7089 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7090 * 2. Incorrect parameter types; 7091 * 3. Parameter verification failed. 7092 * @throws { BusinessError } 1300002 - This window state is abnormal. 7093 * @throws { BusinessError } 1300004 - Unauthorized operation. 7094 * @syscap SystemCapability.WindowManager.WindowManager.Core 7095 * @atomicservice 7096 * @since 12 7097 */ 7098 setAspectRatio(ratio: number): Promise<void>; 7099 7100 /** 7101 * Resets the aspect ratio of window 7102 * 7103 * @param { AsyncCallback<void> } callback - The callback of setAspectRatio. 7104 * @throws { BusinessError } 1300002 - This window state is abnormal. 7105 * @throws { BusinessError } 1300004 - Unauthorized operation. 7106 * @syscap SystemCapability.WindowManager.WindowManager.Core 7107 * @since 10 7108 */ 7109 /** 7110 * Resets the aspect ratio of window 7111 * 7112 * @param { AsyncCallback<void> } callback - The callback of setAspectRatio. 7113 * @throws { BusinessError } 1300002 - This window state is abnormal. 7114 * @throws { BusinessError } 1300004 - Unauthorized operation. 7115 * @syscap SystemCapability.WindowManager.WindowManager.Core 7116 * @atomicservice 7117 * @since 12 7118 */ 7119 resetAspectRatio(callback: AsyncCallback<void>): void; 7120 7121 /** 7122 * Resets the aspect ratio of window 7123 * 7124 * @returns { Promise<void> } - The promise returned by the function. 7125 * @throws { BusinessError } 1300002 - This window state is abnormal. 7126 * @throws { BusinessError } 1300004 - Unauthorized operation. 7127 * @syscap SystemCapability.WindowManager.WindowManager.Core 7128 * @since 10 7129 */ 7130 /** 7131 * Resets the aspect ratio of window 7132 * 7133 * @returns { Promise<void> } - The promise returned by the function. 7134 * @throws { BusinessError } 1300002 - This window state is abnormal. 7135 * @throws { BusinessError } 1300004 - Unauthorized operation. 7136 * @syscap SystemCapability.WindowManager.WindowManager.Core 7137 * @atomicservice 7138 * @since 12 7139 */ 7140 resetAspectRatio(): Promise<void>; 7141 7142 /** 7143 * Set the watermark flag on the window. 7144 * 7145 * @param { boolean } enable - Add water mark flag to window if true, or remove flag if false. 7146 * @param { AsyncCallback<void> } callback - The callback of setWaterMarkFlag. 7147 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 7148 * <br>2. Incorrect parameter types. 7149 * @throws { BusinessError } 1300002 - This window state is abnormal. 7150 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7151 * @throws { BusinessError } 1300008 - The display device is abnormal. 7152 * @syscap SystemCapability.WindowManager.WindowManager.Core 7153 * @systemapi Hide this for inner system use. 7154 * @since 10 7155 */ 7156 /** 7157 * Set the watermark flag on the window. 7158 * 7159 * @param { boolean } enable - Add water mark flag to window if true, or remove flag if false. 7160 * @param { AsyncCallback<void> } callback - The callback of setWaterMarkFlag. 7161 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7162 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 7163 * <br>2. Incorrect parameter types. 7164 * @throws { BusinessError } 1300002 - This window state is abnormal. 7165 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7166 * @throws { BusinessError } 1300008 - The display device is abnormal. 7167 * @syscap SystemCapability.WindowManager.WindowManager.Core 7168 * @systemapi Hide this for inner system use. 7169 * @since 12 7170 */ 7171 setWaterMarkFlag(enable: boolean, callback: AsyncCallback<void>): void; 7172 7173 /** 7174 * Set the watermark flag on the window 7175 * 7176 * @param { boolean } enable - Add water mark flag to window if true, or remove flag if false 7177 * @returns { Promise<void> } - The promise returned by the function 7178 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 7179 * <br>2. Incorrect parameter types. 7180 * @throws { BusinessError } 1300002 - This window state is abnormal. 7181 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7182 * @throws { BusinessError } 1300008 - The display device is abnormal. 7183 * @syscap SystemCapability.WindowManager.WindowManager.Core 7184 * @systemapi Hide this for inner system use. 7185 * @since 10 7186 */ 7187 /** 7188 * Set the watermark flag on the window 7189 * 7190 * @param { boolean } enable - Add water mark flag to window if true, or remove flag if false 7191 * @returns { Promise<void> } - The promise returned by the function 7192 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7193 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 7194 * <br>2. Incorrect parameter types. 7195 * @throws { BusinessError } 1300002 - This window state is abnormal. 7196 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7197 * @throws { BusinessError } 1300008 - The display device is abnormal. 7198 * @syscap SystemCapability.WindowManager.WindowManager.Core 7199 * @systemapi Hide this for inner system use. 7200 * @since 12 7201 */ 7202 setWaterMarkFlag(enable: boolean): Promise<void>; 7203 7204 /** 7205 * Raise one app sub window above another. 7206 * 7207 * @param { number } windowId - Indicates target window id. 7208 * @param { AsyncCallback<void> } callback - The callback of raiseAboveTarget. 7209 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7210 * @throws { BusinessError } 401 - Parameter error. Possible cause: Mandatory parameters are left unspecified. 7211 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7212 * @throws { BusinessError } 1300002 - This window state is abnormal. 7213 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7214 * @throws { BusinessError } 1300004 - Unauthorized operation. 7215 * @throws { BusinessError } 1300009 - The parent window is invalid. 7216 * @syscap SystemCapability.Window.SessionManager 7217 * @systemapi Hide this for inner system use. 7218 * @since 10 7219 */ 7220 raiseAboveTarget(windowId: number, callback: AsyncCallback<void>): void; 7221 7222 /** 7223 * Raise one app sub window above another. 7224 * 7225 * @param { number } windowId - Indicates target window id. 7226 * @returns { Promise<void> } - The promise returned by the function. 7227 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7228 * @throws { BusinessError } 401 - Parameter error. Possible cause: Mandatory parameters are left unspecified. 7229 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7230 * @throws { BusinessError } 1300002 - This window state is abnormal. 7231 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7232 * @throws { BusinessError } 1300004 - Unauthorized operation. 7233 * @throws { BusinessError } 1300009 - The parent window is invalid. 7234 * @syscap SystemCapability.Window.SessionManager 7235 * @systemapi Hide this for inner system use. 7236 * @since 10 7237 */ 7238 raiseAboveTarget(windowId: number): Promise<void>; 7239 7240 /** 7241 * Set whether to enable an app sub window to raise itself by click. 7242 * 7243 * @param { boolean } enable - Disable app sub window to raise itself by by click if false. 7244 * @param { AsyncCallback<void> } callback - The callback of setRaiseByClickEnabled. 7245 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7246 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7247 * 2. Incorrect parameter types. 7248 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7249 * @throws { BusinessError } 1300002 - This window state is abnormal. 7250 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7251 * @throws { BusinessError } 1300004 - Unauthorized operation. 7252 * @throws { BusinessError } 1300009 - The parent window is invalid. 7253 * @syscap SystemCapability.Window.SessionManager 7254 * @systemapi Hide this for inner system use. 7255 * @since 10 7256 */ 7257 setRaiseByClickEnabled(enable: boolean, callback: AsyncCallback<void>): void; 7258 7259 /** 7260 * Set whether to enable an app sub window to raise itself by click. 7261 * 7262 * @param { boolean } enable - Disable app sub window to raise itself by by click if false. 7263 * @returns { Promise<void> } - The promise returned by the function. 7264 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7265 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7266 * 2. Incorrect parameter types. 7267 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7268 * @throws { BusinessError } 1300002 - This window state is abnormal. 7269 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7270 * @throws { BusinessError } 1300004 - Unauthorized operation. 7271 * @throws { BusinessError } 1300009 - The parent window is invalid. 7272 * @syscap SystemCapability.Window.SessionManager 7273 * @systemapi Hide this for inner system use. 7274 * @since 10 7275 */ 7276 setRaiseByClickEnabled(enable: boolean): Promise<void>; 7277 7278 /** 7279 * Minimize app main window and hide app subWindow. 7280 * 7281 * @param { AsyncCallback<void> } callback - The callback of Minimize. 7282 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7283 * @throws { BusinessError } 1300002 - This window state is abnormal. 7284 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7285 * @syscap SystemCapability.Window.SessionManager 7286 * @since 11 7287 */ 7288 /** 7289 * Minimize app main window and hide app subWindow. 7290 * 7291 * @param { AsyncCallback<void> } callback - The callback of Minimize. 7292 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7293 * @throws { BusinessError } 1300002 - This window state is abnormal. 7294 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7295 * @syscap SystemCapability.Window.SessionManager 7296 * @atomicservice 7297 * @since 12 7298 */ 7299 minimize(callback: AsyncCallback<void>): void; 7300 7301 /** 7302 * Minimize app main window and hide app subWindow. 7303 * 7304 * @returns { Promise<void> } - The promise returned by the function. 7305 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7306 * @throws { BusinessError } 1300002 - This window state is abnormal. 7307 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7308 * @syscap SystemCapability.Window.SessionManager 7309 * @since 11 7310 */ 7311 /** 7312 * Minimize app main window and hide app subWindow. 7313 * 7314 * @returns { Promise<void> } - The promise returned by the function. 7315 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7316 * @throws { BusinessError } 1300002 - This window state is abnormal. 7317 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7318 * @syscap SystemCapability.Window.SessionManager 7319 * @atomicservice 7320 * @since 12 7321 */ 7322 minimize(): Promise<void>; 7323 7324 /** 7325 * Maximize app main window. 7326 * @param { MaximizePresentation } presentation - set window presentation when maximize. 7327 * @returns { Promise<void> } - The promise returned by the function. 7328 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7329 * @throws { BusinessError } 1300002 - This window state is abnormal. 7330 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7331 * @throws { BusinessError } 1300004 - Unauthorized operation. 7332 * @throws { BusinessError } 1300005 - This window stage is abnormal. 7333 * @syscap SystemCapability.Window.SessionManager 7334 * @atomicservice 7335 * @since 12 7336 */ 7337 maximize(presentation?: MaximizePresentation): Promise<void>; 7338 7339 /** 7340 * Set whether to enable a window to resize by drag. 7341 * 7342 * @param { boolean } enable - Disable window to resize by drag if false. 7343 * @param { AsyncCallback<void> } callback - The callback of setResizeByDragEnabled. 7344 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7345 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7346 * 2. Incorrect parameter types. 7347 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7348 * @throws { BusinessError } 1300002 - This window state is abnormal. 7349 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7350 * @throws { BusinessError } 1300004 - Unauthorized operation. 7351 * @syscap SystemCapability.Window.SessionManager 7352 * @systemapi Hide this for inner system use. 7353 * @since 10 7354 */ 7355 /** 7356 * Set whether to enable a window to resize by drag. 7357 * 7358 * @param { boolean } enable - Disable window to resize by drag if false. 7359 * @param { AsyncCallback<void> } callback - The callback of setResizeByDragEnabled. 7360 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7361 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7362 * 2. Incorrect parameter types. 7363 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7364 * @throws { BusinessError } 1300002 - This window state is abnormal. 7365 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7366 * @syscap SystemCapability.Window.SessionManager 7367 * @systemapi Hide this for inner system use. 7368 * @since 11 7369 */ 7370 setResizeByDragEnabled(enable: boolean, callback: AsyncCallback<void>): void; 7371 7372 /** 7373 * Set whether to enable a window to resize by drag. 7374 * 7375 * @param { boolean } enable - Disable window to resize by drag if false. 7376 * @returns { Promise<void> } - The promise returned by the function. 7377 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7378 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7379 * 2. Incorrect parameter types. 7380 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7381 * @throws { BusinessError } 1300002 - This window state is abnormal. 7382 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7383 * @syscap SystemCapability.Window.SessionManager 7384 * @systemapi Hide this for inner system use. 7385 * @since 10 7386 */ 7387 setResizeByDragEnabled(enable: boolean): Promise<void>; 7388 7389 /** 7390 * Hide the non-system floating windows. 7391 * 7392 * @param { boolean } shouldHide - Hide the non-system floating windows if true, otherwise means the opposite. 7393 * @param { AsyncCallback<void> } callback - The callback of hideNonSystemFloatingWindows. 7394 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7395 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7396 * 2. Incorrect parameter types. 7397 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7398 * @throws { BusinessError } 1300002 - This window state is abnormal. 7399 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7400 * @throws { BusinessError } 1300004 - Unauthorized operation. 7401 * @syscap SystemCapability.Window.SessionManager 7402 * @systemapi Hide this for inner system use. 7403 * @since 11 7404 */ 7405 hideNonSystemFloatingWindows(shouldHide: boolean, callback: AsyncCallback<void>): void; 7406 7407 /** 7408 * Hide the non-system floating windows. 7409 * 7410 * @param { boolean } shouldHide - Hide the non-system floating windows if true, otherwise means the opposite. 7411 * @returns { Promise<void> } - The promise returned by the function. 7412 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7413 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7414 * 2. Incorrect parameter types. 7415 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7416 * @throws { BusinessError } 1300002 - This window state is abnormal. 7417 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7418 * @throws { BusinessError } 1300004 - Unauthorized operation. 7419 * @syscap SystemCapability.Window.SessionManager 7420 * @systemapi Hide this for inner system use. 7421 * @since 11 7422 */ 7423 hideNonSystemFloatingWindows(shouldHide: boolean): Promise<void>; 7424 7425 /** 7426 * Get the window limits of current window. 7427 * 7428 * @returns { WindowLimits } - The limits of window. 7429 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7430 * @throws { BusinessError } 1300002 - This window state is abnormal. 7431 * @syscap SystemCapability.Window.SessionManager 7432 * @since 11 7433 */ 7434 /** 7435 * Get the window limits of current window. 7436 * 7437 * @returns { WindowLimits } - The limits of window. 7438 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7439 * @throws { BusinessError } 1300002 - This window state is abnormal. 7440 * @syscap SystemCapability.Window.SessionManager 7441 * @atomicservice 7442 * @since 12 7443 */ 7444 getWindowLimits(): WindowLimits; 7445 7446 /** 7447 * Set the window limits of a window. 7448 * 7449 * @param { WindowLimits } windowLimits - window limits of the window. 7450 * @returns { Promise<WindowLimits> } - Promise is used to return the limits of window. 7451 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7452 * 2. Incorrect parameter types; 7453 * 3. Parameter verification failed. 7454 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7455 * @throws { BusinessError } 1300002 - This window state is abnormal. 7456 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7457 * @throws { BusinessError } 1300004 - Unauthorized operation. 7458 * @syscap SystemCapability.Window.SessionManager 7459 * @since 11 7460 */ 7461 /** 7462 * Set the window limits of a window. 7463 * 7464 * @param { WindowLimits } windowLimits - window limits of the window. 7465 * @returns { Promise<WindowLimits> } - Promise is used to return the limits of window. 7466 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7467 * 2. Incorrect parameter types; 7468 * 3. Parameter verification failed. 7469 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7470 * @throws { BusinessError } 1300002 - This window state is abnormal. 7471 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7472 * @throws { BusinessError } 1300004 - Unauthorized operation. 7473 * @syscap SystemCapability.Window.SessionManager 7474 * @atomicservice 7475 * @since 12 7476 */ 7477 setWindowLimits(windowLimits: WindowLimits): Promise<WindowLimits>; 7478 7479 /** 7480 * Set whether to enable the single frame composer. 7481 * 7482 * @param { boolean } enable - Enable the single frame composer if true, otherwise means the opposite. 7483 * @returns { Promise<void> } - The promise returned by the function. 7484 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7485 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7486 * 2. Incorrect parameter types. 7487 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7488 * @throws { BusinessError } 1300002 - This window state is abnormal. 7489 * @syscap SystemCapability.Window.SessionManager 7490 * @systemapi Hide this for inner system use. 7491 * @since 11 7492 */ 7493 setSingleFrameComposerEnabled(enable: boolean): Promise<void>; 7494 7495 /** 7496 * When get focused, keep the keyboard created by other windows, support system window and app subwindow. 7497 * 7498 * @param { boolean } keepKeyboardFlag - keep the keyboard if true, otherwise means the opposite. 7499 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7500 * 2. Incorrect parameter types. 7501 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7502 * @throws { BusinessError } 1300002 - This window state is abnormal. 7503 * @throws { BusinessError } 1300004 - Unauthorized operation. 7504 * @syscap SystemCapability.Window.SessionManager 7505 * @since 11 7506 */ 7507 /** 7508 * When get focused, keep the keyboard created by other windows, support system window and app subwindow. 7509 * 7510 * @param { boolean } keepKeyboardFlag - keep the keyboard if true, otherwise means the opposite. 7511 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7512 * 2. Incorrect parameter types. 7513 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7514 * @throws { BusinessError } 1300002 - This window state is abnormal. 7515 * @throws { BusinessError } 1300004 - Unauthorized operation. 7516 * @syscap SystemCapability.Window.SessionManager 7517 * @atomicservice 7518 * @since 12 7519 */ 7520 keepKeyboardOnFocus(keepKeyboardFlag: boolean): void; 7521 7522 /** 7523 * Recover app main window. 7524 * 7525 * @returns { Promise<void> } - The promise returned by the function. 7526 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7527 * @throws { BusinessError } 1300001 - Repeated operation. 7528 * @throws { BusinessError } 1300002 - This window state is abnormal. 7529 * @syscap SystemCapability.Window.SessionManager 7530 * @since 11 7531 */ 7532 /** 7533 * Recover app main window. 7534 * 7535 * @returns { Promise<void> } - The promise returned by the function. 7536 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7537 * @throws { BusinessError } 1300001 - Repeated operation. 7538 * @throws { BusinessError } 1300002 - This window state is abnormal. 7539 * @syscap SystemCapability.Window.SessionManager 7540 * @atomicservice 7541 * @since 12 7542 */ 7543 recover(): Promise<void>; 7544 7545 /** 7546 * After the app main window is minimized, if the Ability is not in the background state, you can restore app main window. 7547 * 7548 * @returns { Promise<void> } - The promise returned by the function. 7549 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7550 * @throws { BusinessError } 1300002 - This window state is abnormal. 7551 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7552 * @throws { BusinessError } 1300004 - Unauthorized operation. 7553 * @syscap SystemCapability.Window.SessionManager 7554 * @atomicservice 7555 * @since 14 7556 */ 7557 restore(): Promise<void>; 7558 7559 /** 7560 * Set the visibility of the window decor. 7561 * 7562 * @param { boolean } - Enable the decor visible if true, otherwise means the opposite. 7563 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7564 * 2. Incorrect parameter types. 7565 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7566 * @throws { BusinessError } 1300002 - This window state is abnormal. 7567 * @throws { BusinessError } 1300004 - Unauthorized operation. 7568 * @syscap SystemCapability.Window.SessionManager 7569 * @since 11 7570 */ 7571 /** 7572 * Set the visibility of the window decor. 7573 * 7574 * @param { boolean } isVisible - Enable the decor visible if true, otherwise means the opposite. 7575 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7576 * 2. Incorrect parameter types. 7577 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7578 * @throws { BusinessError } 1300002 - This window state is abnormal. 7579 * @throws { BusinessError } 1300004 - Unauthorized operation. 7580 * @syscap SystemCapability.Window.SessionManager 7581 * @atomicservice 7582 * @since 12 7583 */ 7584 setWindowDecorVisible(isVisible: boolean): void; 7585 7586 /** 7587 * Set the modality of the window. 7588 * 7589 * @param { boolean } isModal - Enable the window modal if true, otherwise means the opposite. 7590 * @returns { Promise<void> } Promise that returns no value. 7591 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7592 * 2. Incorrect parameter types. 7593 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7594 * @throws { BusinessError } 1300002 - This window state is abnormal. 7595 * @throws { BusinessError } 1300004 - Unauthorized operation. 7596 * @syscap SystemCapability.Window.SessionManager 7597 * @atomicservice 7598 * @since 12 7599 */ 7600 setSubWindowModal(isModal: boolean): Promise<void>; 7601 7602 /** 7603 * Set the modality of the window. 7604 * 7605 * @param { boolean } isModal - Enable the window modal if true, otherwise means the opposite. 7606 * @param { ModalityType } modalityType - Set modality type when the window modal is true. 7607 * @returns { Promise<void> } Promise that returns no value. 7608 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7609 * 2. Incorrect parameter types. 7610 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7611 * @throws { BusinessError } 1300002 - This window state is abnormal. 7612 * @throws { BusinessError } 1300004 - Unauthorized operation. 7613 * @syscap SystemCapability.Window.SessionManager 7614 * @atomicservice 7615 * @since 14 7616 */ 7617 setSubWindowModal(isModal: boolean, modalityType: ModalityType): Promise<void>; 7618 7619 /** 7620 * Set the height of the window decor. 7621 * 7622 * @param { number } - The height of window decor. 7623 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7624 * 2. Incorrect parameter types; 7625 * 3. Parameter verification failed. 7626 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7627 * @throws { BusinessError } 1300002 - This window state is abnormal. 7628 * @syscap SystemCapability.Window.SessionManager 7629 * @since 11 7630 */ 7631 /** 7632 * Set the height of the window decor. 7633 * 7634 * @param { number } height - The height of window decor. 7635 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7636 * 2. Incorrect parameter types; 7637 * 3. Parameter verification failed. 7638 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7639 * @throws { BusinessError } 1300002 - This window state is abnormal. 7640 * @syscap SystemCapability.Window.SessionManager 7641 * @atomicservice 7642 * @since 12 7643 */ 7644 setWindowDecorHeight(height: number): void; 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 * @since 11 7654 */ 7655 /** 7656 * Get the height of the window decor. 7657 * 7658 * @returns { number } - The height of window decor. 7659 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7660 * @throws { BusinessError } 1300002 - This window state is abnormal. 7661 * @syscap SystemCapability.Window.SessionManager 7662 * @atomicservice 7663 * @since 12 7664 */ 7665 getWindowDecorHeight(): number; 7666 7667 /** 7668 * Set touchable areas. By default, the entire window area is touchable. 7669 * If touchable areas are set in the window, touch events outside the areas will be transparent transmitted. 7670 * If the window area changes, you need to reset it. 7671 * 7672 * @param { Array<Rect> } rects - Touchable areas. The maximum size cannot exceed 10, touchable area cannot exceed the window's area. 7673 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7674 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7675 * 2. Incorrect parameter types. 7676 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7677 * @throws { BusinessError } 1300002 - This window state is abnormal. 7678 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7679 * @syscap SystemCapability.Window.SessionManager 7680 * @systemapi 7681 * @since 12 7682 */ 7683 setTouchableAreas(rects: Array<Rect>): void; 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 * @since 11 7693 */ 7694 /** 7695 * Get the area of window title buttons. 7696 * 7697 * @returns { TitleButtonRect } - The area of window title buttons. 7698 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7699 * @throws { BusinessError } 1300002 - This window state is abnormal. 7700 * @syscap SystemCapability.Window.SessionManager 7701 * @atomicservice 7702 * @since 12 7703 */ 7704 getTitleButtonRect(): TitleButtonRect; 7705 7706 /** 7707 * Set whether to display the maximize, minimize, split buttons of main window. 7708 * 7709 * @param { boolean } isMaximizeVisible - Display maximize button if true, or hide maximize button if false. 7710 * @param { boolean } isMinimizeVisible - Display minimize button if true, or hide minimize button if false. 7711 * @param { boolean } isSplitVisible - Display split button if true, or hide split button if false. 7712 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7713 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7714 * 2. Incorrect parameter types. 7715 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7716 * @throws { BusinessError } 1300002 - This window state is abnormal. 7717 * @throws { BusinessError } 1300004 - Unauthorized operation. 7718 * @syscap SystemCapability.Window.SessionManager 7719 * @systemapi Hide this for inner system use. 7720 * @since 12 7721 */ 7722 setTitleButtonVisible(isMaximizeVisible: boolean, isMinimizeVisible: boolean, isSplitVisible: boolean): void; 7723 7724 /** 7725 * Set whether to display the maximize, minimize buttons of main window. 7726 * 7727 * @param { boolean } isMaximizeVisible - Display maximize button if true, or hide maximize button if false. 7728 * @param { boolean } isMinimizeVisible - Display minimize button if true, or hide minimize button if false. 7729 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7730 * 2. Incorrect parameter types. 7731 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7732 * @throws { BusinessError } 1300002 - This window state is abnormal. 7733 * @throws { BusinessError } 1300004 - Unauthorized operation. 7734 * @syscap SystemCapability.Window.SessionManager 7735 * @atomicservice 7736 * @since 14 7737 */ 7738 setWindowTitleButtonVisible(isMaximizeVisible: boolean, isMinimizeVisible: boolean): void; 7739 7740 /** 7741 * Enable landscape multiWindow 7742 * 7743 * @returns { Promise<void> } Promise that returns no value. 7744 * @throws {BusinessError} 1300002 - This window state is abnormal. 7745 * @throws {BusinessError} 1300003 - This window manager service works abnormally. 7746 * @syscap SystemCapability.Window.SessionManager 7747 * @atomicservice 7748 * @since 12 7749 */ 7750 enableLandscapeMultiWindow(): Promise<void>; 7751 7752 /** 7753 * Start moving window. 7754 * 7755 * @returns { Promise<void> } Promise that returns no value. 7756 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7757 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7758 * @throws { BusinessError } 1300001 - Repeated operation. 7759 * @throws { BusinessError } 1300002 - This window state is abnormal. 7760 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7761 * @throws { BusinessError } 1300004 - Unauthorized operation. 7762 * @syscap SystemCapability.Window.SessionManager 7763 * @systemapi Hide this for inner system use. 7764 * @since 13 7765 */ 7766 startMoving(): Promise<void>; 7767 7768 /** 7769 * Enable drag window. 7770 * 7771 * @param { boolean } enable - The value true means to enable window dragging, and false means the opposite. 7772 * @returns { Promise<void> } Promise that returns no value. 7773 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 7774 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7775 * 2. Incorrect parameter types; 7776 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7777 * @throws { BusinessError } 1300002 - This window state is abnormal. 7778 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7779 * @throws { BusinessError } 1300004 - Unauthorized operation. 7780 * @syscap SystemCapability.Window.SessionManager 7781 * @systemapi Hide this for inner system use. 7782 * @since 13 7783 */ 7784 enableDrag(enable: boolean): Promise<void>; 7785 7786 /** 7787 * Disable landscape multiWindow 7788 * 7789 * @returns { Promise<void> } Promise that returns no value. 7790 * @throws {BusinessError} 1300002 - This window state is abnormal. 7791 * @throws {BusinessError} 1300003 - This window manager service works abnormally. 7792 * @syscap SystemCapability.Window.SessionManager 7793 * @atomicservice 7794 * @since 12 7795 */ 7796 disableLandscapeMultiWindow(): Promise<void>; 7797 7798 /** 7799 * Register the callback of title buttons area change. 7800 * 7801 * @param { 'windowTitleButtonRectChange' } type - The value is fixed at 'windowTitleButtonRectChange', indicating the title buttons area change event. 7802 * @param { Callback<TitleButtonRect> } callback - Callback used to return the current title buttons area. 7803 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7804 * 2. Incorrect parameter types; 7805 * 3. Parameter verification failed. 7806 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7807 * @throws { BusinessError } 1300002 - This window state is abnormal. 7808 * @syscap SystemCapability.Window.SessionManager 7809 * @since 11 7810 */ 7811 /** 7812 * Register the callback of title buttons area change. 7813 * 7814 * @param { 'windowTitleButtonRectChange' } type - The value is fixed at 'windowTitleButtonRectChange', indicating the title buttons area change event. 7815 * @param { Callback<TitleButtonRect> } callback - Callback used to return the current title buttons area. 7816 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7817 * 2. Incorrect parameter types; 7818 * 3. Parameter verification failed. 7819 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7820 * @throws { BusinessError } 1300002 - This window state is abnormal. 7821 * @syscap SystemCapability.Window.SessionManager 7822 * @atomicservice 7823 * @since 12 7824 */ 7825 on(type: 'windowTitleButtonRectChange', callback: Callback<TitleButtonRect>): void; 7826 7827 /** 7828 * Unregister the callback of title buttons area change. 7829 * 7830 * @param { 'windowTitleButtonRectChange' } type - The value is fixed at 'windowTitleButtonRectChange', indicating the title buttons area change event. 7831 * @param { Callback<TitleButtonRect> } callback - Callback used to return the current title buttons area. 7832 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 7833 * 2. Parameter verification failed. 7834 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7835 * @throws { BusinessError } 1300002 - This window state is abnormal. 7836 * @syscap SystemCapability.Window.SessionManager 7837 * @since 11 7838 */ 7839 /** 7840 * Unregister the callback of title buttons area change. 7841 * 7842 * @param { 'windowTitleButtonRectChange' } type - The value is fixed at 'windowTitleButtonRectChange', indicating the title buttons area change event. 7843 * @param { Callback<TitleButtonRect> } callback - Callback used to return the current title buttons area. 7844 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 7845 * 2. Parameter verification failed. 7846 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7847 * @throws { BusinessError } 1300002 - This window state is abnormal. 7848 * @syscap SystemCapability.Window.SessionManager 7849 * @atomicservice 7850 * @since 12 7851 */ 7852 off(type: 'windowTitleButtonRectChange', callback?: Callback<TitleButtonRect>): void; 7853 7854 /** 7855 * Set the window mask of window 7856 * 7857 * @param { Array<Array<number>> } windowMask - The mask of window. The value of the array is 0 and 1, the other number is illegal value. 7858 * @returns { Promise<void> } Promise that returns no value. 7859 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7860 * 2. Incorrect parameter types. 7861 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7862 * @throws { BusinessError } 1300002 - This window state is abnormal. 7863 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7864 * @throws { BusinessError } 1300004 - Unauthorized operation. 7865 * @syscap SystemCapability.Window.SessionManager 7866 * @atomicservice 7867 * @since 12 7868 */ 7869 setWindowMask(windowMask: Array<Array<number>>): Promise<void>; 7870 7871 /** 7872 * Register the callback of windowRectChange 7873 * 7874 * @param { 'windowRectChange' } type - The value is fixed at 'windowRectChange', indicating the window rect change event. 7875 * @param { Callback<RectChangeOptions> } callback - Callback used to return the RectChangeOptions. 7876 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7877 * 2. Incorrect parameter types; 7878 * 3. Parameter verification failed. 7879 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7880 * @throws { BusinessError } 1300002 - This window state is abnormal. 7881 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7882 * @syscap SystemCapability.Window.SessionManager 7883 * @atomicservice 7884 * @since 12 7885 */ 7886 on(type: 'windowRectChange', callback: Callback<RectChangeOptions>): void; 7887 7888 /** 7889 * Unregister the callback of windowRectChange 7890 * 7891 * @param { 'windowRectChange' } type - The value is fixed at 'windowRectChange', indicating the window rect change event. 7892 * @param { Callback<RectChangeOptions> } callback - Callback used to return the RectChangeOptions. 7893 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 7894 * 2. Parameter verification failed. 7895 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7896 * @throws { BusinessError } 1300002 - This window state is abnormal. 7897 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7898 * @syscap SystemCapability.Window.SessionManager 7899 * @atomicservice 7900 * @since 12 7901 */ 7902 off(type: 'windowRectChange', callback?: Callback<RectChangeOptions>): void; 7903 7904 /** 7905 * Set gray scale of window. 7906 * 7907 * @param { number } grayScale - The value of gray scale. 7908 * @returns { Promise<void> } - The promise returned by the function. 7909 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7910 * 2. Incorrect parameter types; 7911 * 3. Parameter verification failed. 7912 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7913 * @throws { BusinessError } 1300002 - This window state is abnormal. 7914 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7915 * @syscap SystemCapability.Window.SessionManager 7916 * @atomicservice 7917 * @since 12 7918 */ 7919 setWindowGrayScale(grayScale: number): Promise<void>; 7920 7921 /** 7922 * Set whether to enable immersive mode. 7923 * 7924 * @param { boolean } enabled - The value true means to enable immersive mode, and false means the opposite. 7925 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7926 * 2. Incorrect parameter types; 7927 * @throws { BusinessError } 1300002 - This window state is abnormal. 7928 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7929 * @throws { BusinessError } 1300004 - Unauthorized operation. 7930 * @syscap SystemCapability.WindowManager.WindowManager.Core 7931 * @atomicservice 7932 * @since 12 7933 */ 7934 setImmersiveModeEnabledState(enabled: boolean): void; 7935 7936 /** 7937 * Get whether the immersive mode is enabled or not. 7938 * 7939 * @returns { boolean } - The value true means the immersive mode is enabled, and false means the opposite. 7940 * @throws { BusinessError } 1300002 - This window state is abnormal. 7941 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7942 * @throws { BusinessError } 1300004 - Unauthorized operation. 7943 * @syscap SystemCapability.WindowManager.WindowManager.Core 7944 * @atomicservice 7945 * @since 12 7946 */ 7947 getImmersiveModeEnabledState(): boolean; 7948 7949 /** 7950 * Get the window status of current window. 7951 * 7952 * @returns { WindowStatusType } - The status of window. 7953 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7954 * @throws { BusinessError } 1300002 - This window state is abnormal. 7955 * @syscap SystemCapability.Window.SessionManager 7956 * @atomicservice 7957 * @since 12 7958 */ 7959 getWindowStatus(): WindowStatusType; 7960 7961 /** 7962 * Checks whether the window is focused. 7963 * 7964 * @returns { boolean } - Whether the window is focused. The value true means that the window is focused, and false means the opposite. 7965 * @throws { BusinessError } 1300002 - This window state is abnormal. 7966 * @syscap SystemCapability.WindowManager.WindowManager.Core 7967 * @atomicservice 7968 * @since 12 7969 */ 7970 isFocused(): boolean; 7971 7972 /** 7973 * Create sub window with options. 7974 * 7975 * @param { string } name - window name of sub window 7976 * @param { SubWindowOptions } options - options of sub window creation 7977 * @returns { Promise<Window> } Promise used to return the subwindow. 7978 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 7979 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7980 * @throws { BusinessError } 1300002 - This window state is abnormal. 7981 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 7982 * @throws { BusinessError } 1300004 - Unauthorized operation. 7983 * @syscap SystemCapability.Window.SessionManager 7984 * @StageModelOnly 7985 * @atomicservice 7986 * @since 12 7987 */ 7988 createSubWindowWithOptions(name: string, options: SubWindowOptions): Promise<Window>; 7989 7990 /** 7991 * Set whether the title bar and dock bar will show, when the mouse hovers over hot area. 7992 * 7993 * @param { boolean } isTitleHoverShown - The value true means to display the title bar, and false means the opposite. 7994 * @param { boolean } isDockHoverShown - The value true means to display the dock bar, and false means the opposite. 7995 * @returns { Promise<void> } Promise that returns no value. 7996 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 7997 * 2. Incorrect parameter types; 7998 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 7999 * @throws { BusinessError } 1300002 - This window state is abnormal. 8000 * @throws { BusinessError } 1300004 - Unauthorized operation. 8001 * @syscap SystemCapability.Window.SessionManager 8002 * @atomicservice 8003 * @since 14 8004 */ 8005 setTitleAndDockHoverShown(isTitleHoverShown?: boolean, isDockHoverShown?: boolean): Promise<void>; 8006 } 8007 8008 /** 8009 * Window stage callback event type 8010 * 8011 * @enum { number } 8012 * @syscap SystemCapability.WindowManager.WindowManager.Core 8013 * @StageModelOnly 8014 * @since 9 8015 */ 8016 /** 8017 * Window stage callback event type 8018 * 8019 * @enum { number } 8020 * @syscap SystemCapability.WindowManager.WindowManager.Core 8021 * @StageModelOnly 8022 * @crossplatform 8023 * @since 10 8024 */ 8025 /** 8026 * Window stage callback event type 8027 * 8028 * @enum { number } 8029 * @syscap SystemCapability.WindowManager.WindowManager.Core 8030 * @StageModelOnly 8031 * @crossplatform 8032 * @atomicservice 8033 * @since 11 8034 */ 8035 enum WindowStageEventType { 8036 /** 8037 * The window stage is running in the foreground. 8038 * 8039 * @syscap SystemCapability.WindowManager.WindowManager.Core 8040 * @StageModelOnly 8041 * @since 9 8042 */ 8043 /** 8044 * The window stage is running in the foreground. 8045 * 8046 * @syscap SystemCapability.WindowManager.WindowManager.Core 8047 * @StageModelOnly 8048 * @crossplatform 8049 * @since 10 8050 */ 8051 /** 8052 * The window stage is running in the foreground. 8053 * 8054 * @syscap SystemCapability.WindowManager.WindowManager.Core 8055 * @StageModelOnly 8056 * @crossplatform 8057 * @atomicservice 8058 * @since 11 8059 */ 8060 SHOWN = 1, 8061 /** 8062 * The window stage gains focus. 8063 * 8064 * @syscap SystemCapability.WindowManager.WindowManager.Core 8065 * @StageModelOnly 8066 * @since 9 8067 */ 8068 /** 8069 * The window stage gains focus. 8070 * 8071 * @syscap SystemCapability.WindowManager.WindowManager.Core 8072 * @StageModelOnly 8073 * @crossplatform 8074 * @since 10 8075 */ 8076 /** 8077 * The window stage gains focus. 8078 * 8079 * @syscap SystemCapability.WindowManager.WindowManager.Core 8080 * @StageModelOnly 8081 * @crossplatform 8082 * @atomicservice 8083 * @since 11 8084 */ 8085 ACTIVE, 8086 /** 8087 * The window stage loses focus. 8088 * 8089 * @syscap SystemCapability.WindowManager.WindowManager.Core 8090 * @StageModelOnly 8091 * @since 9 8092 */ 8093 /** 8094 * The window stage loses focus. 8095 * 8096 * @syscap SystemCapability.WindowManager.WindowManager.Core 8097 * @StageModelOnly 8098 * @crossplatform 8099 * @since 10 8100 */ 8101 /** 8102 * The window stage loses focus. 8103 * 8104 * @syscap SystemCapability.WindowManager.WindowManager.Core 8105 * @StageModelOnly 8106 * @crossplatform 8107 * @atomicservice 8108 * @since 11 8109 */ 8110 INACTIVE, 8111 /** 8112 * The window stage is running in the background. 8113 * 8114 * @syscap SystemCapability.WindowManager.WindowManager.Core 8115 * @StageModelOnly 8116 * @since 9 8117 */ 8118 /** 8119 * The window stage is running in the background. 8120 * 8121 * @syscap SystemCapability.WindowManager.WindowManager.Core 8122 * @StageModelOnly 8123 * @crossplatform 8124 * @since 10 8125 */ 8126 /** 8127 * The window stage is running in the background. 8128 * 8129 * @syscap SystemCapability.WindowManager.WindowManager.Core 8130 * @StageModelOnly 8131 * @crossplatform 8132 * @atomicservice 8133 * @since 11 8134 */ 8135 HIDDEN, 8136 /** 8137 * The window stage is interactive in the foreground. 8138 * 8139 * @syscap SystemCapability.WindowManager.WindowManager.Core 8140 * @StageModelOnly 8141 * @crossplatform 8142 * @atomicservice 8143 * @since 11 8144 */ 8145 RESUMED, 8146 /** 8147 * The window stage is not interactive in the foreground. 8148 * 8149 * @syscap SystemCapability.WindowManager.WindowManager.Core 8150 * @StageModelOnly 8151 * @crossplatform 8152 * @atomicservice 8153 * @since 11 8154 */ 8155 PAUSED 8156 } 8157 8158 /** 8159 * Enum for window modality Type 8160 * 8161 * @enum { number } 8162 * @syscap SystemCapability.Window.SessionManager 8163 * @atomicservice 8164 * @since 14 8165 */ 8166 enum ModalityType { 8167 /** 8168 * The value means window modality. 8169 * 8170 * @syscap SystemCapability.Window.SessionManager 8171 * @atomicservice 8172 * @since 14 8173 */ 8174 WINDOW_MODALITY = 0, 8175 /** 8176 * The value means application modality. 8177 * 8178 * @syscap SystemCapability.Window.SessionManager 8179 * @atomicservice 8180 * @since 14 8181 */ 8182 APPLICATION_MODALITY = 1, 8183 } 8184 8185 /** 8186 * Options for subwindow creation 8187 * 8188 * @interface SubWindowOptions 8189 * @syscap SystemCapability.Window.SessionManager 8190 * @since 11 8191 */ 8192 /** 8193 * Options for subwindow creation 8194 * 8195 * @interface SubWindowOptions 8196 * @syscap SystemCapability.Window.SessionManager 8197 * @atomicservice 8198 * @since 12 8199 */ 8200 interface SubWindowOptions { 8201 /** 8202 * Indicates subwindow title 8203 * 8204 * @type { string } 8205 * @syscap SystemCapability.Window.SessionManager 8206 * @since 11 8207 */ 8208 /** 8209 * Indicates subwindow title 8210 * 8211 * @type { string } 8212 * @syscap SystemCapability.Window.SessionManager 8213 * @atomicservice 8214 * @since 12 8215 */ 8216 title: string; 8217 /** 8218 * Indicates decor of subwindow 8219 * 8220 * @type { boolean } 8221 * @syscap SystemCapability.Window.SessionManager 8222 * @since 11 8223 */ 8224 /** 8225 * Indicates decor of subwindow 8226 * 8227 * @type { boolean } 8228 * @syscap SystemCapability.Window.SessionManager 8229 * @atomicservice 8230 * @since 12 8231 */ 8232 decorEnabled: boolean; 8233 /** 8234 * Indicates modality of subwindow 8235 * 8236 * @type { ?boolean } 8237 * @syscap SystemCapability.Window.SessionManager 8238 * @atomicservice 8239 * @since 12 8240 */ 8241 isModal?: boolean; 8242 /** 8243 * Indicates whether subwindow is topmost 8244 * 8245 * @type { ?boolean } 8246 * @syscap SystemCapability.Window.SessionManager 8247 * @systemapi Hide this for inner system use. 8248 * @since 12 8249 */ 8250 isTopmost?: boolean; 8251 /** 8252 * Indicates modality type of subwindow 8253 * 8254 * @type { ?ModalityType } 8255 * @syscap SystemCapability.Window.SessionManager 8256 * @atomicservice 8257 * @since 14 8258 */ 8259 modalityType?: ModalityType; 8260 } 8261 /** 8262 * WindowStage 8263 * 8264 * @interface WindowStage 8265 * @syscap SystemCapability.WindowManager.WindowManager.Core 8266 * @since 9 8267 */ 8268 /** 8269 * WindowStage 8270 * 8271 * @interface WindowStage 8272 * @syscap SystemCapability.WindowManager.WindowManager.Core 8273 * @crossplatform 8274 * @since 10 8275 */ 8276 /** 8277 * WindowStage 8278 * 8279 * @interface WindowStage 8280 * @syscap SystemCapability.WindowManager.WindowManager.Core 8281 * @crossplatform 8282 * @atomicservice 8283 * @since 11 8284 */ 8285 interface WindowStage { 8286 /** 8287 * Get main window of the stage. 8288 * 8289 * @returns { Promise<Window> } Callback used to return the subwindow. 8290 * @throws { BusinessError } 1300002 - This window state is abnormal. 8291 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8292 * @syscap SystemCapability.WindowManager.WindowManager.Core 8293 * @StageModelOnly 8294 * @since 9 8295 */ 8296 /** 8297 * Get main window of the stage. 8298 * 8299 * @returns { Promise<Window> } Callback used to return the subwindow. 8300 * @throws { BusinessError } 1300002 - This window state is abnormal. 8301 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8302 * @syscap SystemCapability.WindowManager.WindowManager.Core 8303 * @StageModelOnly 8304 * @crossplatform 8305 * @since 10 8306 */ 8307 /** 8308 * Get main window of the stage. 8309 * 8310 * @returns { Promise<Window> } Callback used to return the subwindow. 8311 * @throws { BusinessError } 1300002 - This window state is abnormal. 8312 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8313 * @syscap SystemCapability.WindowManager.WindowManager.Core 8314 * @StageModelOnly 8315 * @crossplatform 8316 * @atomicservice 8317 * @since 11 8318 */ 8319 getMainWindow(): Promise<Window>; 8320 /** 8321 * Get main window of the stage. 8322 * 8323 * @param { AsyncCallback<Window> } callback Callback used to return the main window. 8324 * @throws { BusinessError } 1300002 - This window state is abnormal. 8325 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8326 * @syscap SystemCapability.WindowManager.WindowManager.Core 8327 * @StageModelOnly 8328 * @since 9 8329 */ 8330 /** 8331 * Get main window of the stage. 8332 * 8333 * @param { AsyncCallback<Window> } callback Callback used to return the main window. 8334 * @throws { BusinessError } 1300002 - This window state is abnormal. 8335 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8336 * @syscap SystemCapability.WindowManager.WindowManager.Core 8337 * @StageModelOnly 8338 * @crossplatform 8339 * @since 10 8340 */ 8341 /** 8342 * Get main window of the stage. 8343 * 8344 * @param { AsyncCallback<Window> } callback Callback used to return the main window. 8345 * @throws { BusinessError } 1300002 - This window state is abnormal. 8346 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8347 * @syscap SystemCapability.WindowManager.WindowManager.Core 8348 * @StageModelOnly 8349 * @crossplatform 8350 * @atomicservice 8351 * @since 11 8352 */ 8353 getMainWindow(callback: AsyncCallback<Window>): void; 8354 /** 8355 * Get main window of the stage. 8356 * 8357 * @returns { Window } 8358 * @throws { BusinessError } 1300002 - This window state is abnormal. 8359 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8360 * @syscap SystemCapability.WindowManager.WindowManager.Core 8361 * @StageModelOnly 8362 * @since 9 8363 */ 8364 /** 8365 * Get main window of the stage. 8366 * 8367 * @returns { Window } 8368 * @throws { BusinessError } 1300002 - This window state is abnormal. 8369 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8370 * @syscap SystemCapability.WindowManager.WindowManager.Core 8371 * @StageModelOnly 8372 * @crossplatform 8373 * @since 10 8374 */ 8375 /** 8376 * Get main window of the stage. 8377 * 8378 * @returns { Window } 8379 * @throws { BusinessError } 1300002 - This window state is abnormal. 8380 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8381 * @syscap SystemCapability.WindowManager.WindowManager.Core 8382 * @StageModelOnly 8383 * @crossplatform 8384 * @atomicservice 8385 * @since 11 8386 */ 8387 getMainWindowSync(): Window; 8388 /** 8389 * Create sub window of the stage. 8390 * 8391 * @param { string } name window name of sub window 8392 * @returns { Promise<Window> } Promise used to return the subwindow. 8393 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8394 * @throws { BusinessError } 1300002 - This window state is abnormal. 8395 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8396 * @syscap SystemCapability.WindowManager.WindowManager.Core 8397 * @StageModelOnly 8398 * @since 9 8399 */ 8400 /** 8401 * Create sub window of the stage. 8402 * 8403 * @param { string } name window name of sub window 8404 * @returns { Promise<Window> } Promise used to return the subwindow. 8405 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8406 * @throws { BusinessError } 1300002 - This window state is abnormal. 8407 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8408 * @syscap SystemCapability.WindowManager.WindowManager.Core 8409 * @StageModelOnly 8410 * @crossplatform 8411 * @since 10 8412 */ 8413 /** 8414 * Create sub window of the stage. 8415 * 8416 * @param { string } name window name of sub window 8417 * @returns { Promise<Window> } Promise used to return the subwindow. 8418 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8419 * @throws { BusinessError } 1300002 - This window state is abnormal. 8420 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8421 * @syscap SystemCapability.WindowManager.WindowManager.Core 8422 * @StageModelOnly 8423 * @crossplatform 8424 * @atomicservice 8425 * @since 11 8426 */ 8427 createSubWindow(name: string): Promise<Window>; 8428 /** 8429 * Create sub window of the stage. 8430 * 8431 * @param { string } name window name of sub window 8432 * @param { AsyncCallback<Window> } callback Callback used to return the subwindow. 8433 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8434 * @throws { BusinessError } 1300002 - This window state is abnormal. 8435 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8436 * @syscap SystemCapability.WindowManager.WindowManager.Core 8437 * @StageModelOnly 8438 * @since 9 8439 */ 8440 /** 8441 * Create sub window of the stage. 8442 * 8443 * @param { string } name window name of sub window 8444 * @param { AsyncCallback<Window> } callback Callback used to return the subwindow. 8445 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8446 * @throws { BusinessError } 1300002 - This window state is abnormal. 8447 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8448 * @syscap SystemCapability.WindowManager.WindowManager.Core 8449 * @StageModelOnly 8450 * @crossplatform 8451 * @since 10 8452 */ 8453 /** 8454 * Create sub window of the stage. 8455 * 8456 * @param { string } name window name of sub window 8457 * @param { AsyncCallback<Window> } callback Callback used to return the subwindow. 8458 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8459 * @throws { BusinessError } 1300002 - This window state is abnormal. 8460 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8461 * @syscap SystemCapability.WindowManager.WindowManager.Core 8462 * @StageModelOnly 8463 * @crossplatform 8464 * @atomicservice 8465 * @since 11 8466 */ 8467 createSubWindow(name: string, callback: AsyncCallback<Window>): void; 8468 /** 8469 * Create sub window of the stage. 8470 * 8471 * @param { string } name - window name of sub window 8472 * @param { SubWindowOptions } options - options of sub window creation 8473 * @returns { Promise<Window> } Promise used to return the subwindow. 8474 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8475 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 8476 * @throws { BusinessError } 1300002 - This window state is abnormal. 8477 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8478 * @syscap SystemCapability.Window.SessionManager 8479 * @StageModelOnly 8480 * @since 11 8481 */ 8482 /** 8483 * Create sub window of the stage. 8484 * 8485 * @param { string } name - window name of sub window 8486 * @param { SubWindowOptions } options - options of sub window creation 8487 * @returns { Promise<Window> } Promise used to return the subwindow. 8488 * @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types. 8489 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 8490 * @throws { BusinessError } 1300002 - This window state is abnormal. 8491 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8492 * @syscap SystemCapability.Window.SessionManager 8493 * @StageModelOnly 8494 * @atomicservice 8495 * @since 12 8496 */ 8497 createSubWindowWithOptions(name: string, options: SubWindowOptions): Promise<Window>; 8498 /** 8499 * Get sub window of the stage. 8500 * 8501 * @returns { Promise<Array<Window>> } 8502 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8503 * @syscap SystemCapability.WindowManager.WindowManager.Core 8504 * @StageModelOnly 8505 * @since 9 8506 */ 8507 /** 8508 * Get sub window of the stage. 8509 * 8510 * @returns { Promise<Array<Window>> } 8511 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8512 * @syscap SystemCapability.WindowManager.WindowManager.Core 8513 * @StageModelOnly 8514 * @crossplatform 8515 * @since 10 8516 */ 8517 /** 8518 * Get sub window of the stage. 8519 * 8520 * @returns { Promise<Array<Window>> } 8521 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8522 * @syscap SystemCapability.WindowManager.WindowManager.Core 8523 * @StageModelOnly 8524 * @crossplatform 8525 * @atomicservice 8526 * @since 11 8527 */ 8528 getSubWindow(): Promise<Array<Window>>; 8529 /** 8530 * Get sub window of the stage. 8531 * 8532 * @param { AsyncCallback<Array<Window>> } callback Callback used to return all the subwindows. 8533 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8534 * @syscap SystemCapability.WindowManager.WindowManager.Core 8535 * @StageModelOnly 8536 * @since 9 8537 */ 8538 /** 8539 * Get sub window of the stage. 8540 * 8541 * @param { AsyncCallback<Array<Window>> } callback Callback used to return all the subwindows. 8542 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8543 * @syscap SystemCapability.WindowManager.WindowManager.Core 8544 * @StageModelOnly 8545 * @crossplatform 8546 * @since 10 8547 */ 8548 /** 8549 * Get sub window of the stage. 8550 * 8551 * @param { AsyncCallback<Array<Window>> } callback Callback used to return all the subwindows. 8552 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8553 * @syscap SystemCapability.WindowManager.WindowManager.Core 8554 * @StageModelOnly 8555 * @crossplatform 8556 * @atomicservice 8557 * @since 11 8558 */ 8559 getSubWindow(callback: AsyncCallback<Array<Window>>): void; 8560 /** 8561 * Loads content 8562 * 8563 * @param { string } path Path of the page to which the content will be loaded 8564 * @param { LocalStorage } storage The data object shared within the content instance loaded by the window 8565 * @param { AsyncCallback<void> } callback Callback used to return the result. 8566 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8567 * 2. Incorrect parameter types. 8568 * @throws { BusinessError } 1300002 - This window state is abnormal. 8569 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8570 * @syscap SystemCapability.WindowManager.WindowManager.Core 8571 * @StageModelOnly 8572 * @since 9 8573 */ 8574 /** 8575 * Loads content 8576 * 8577 * @param { string } path Path of the page to which the content will be loaded 8578 * @param { LocalStorage } storage The data object shared within the content instance loaded by the window 8579 * @param { AsyncCallback<void> } callback Callback used to return the result. 8580 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8581 * 2. Incorrect parameter types. 8582 * @throws { BusinessError } 1300002 - This window state is abnormal. 8583 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8584 * @syscap SystemCapability.WindowManager.WindowManager.Core 8585 * @StageModelOnly 8586 * @crossplatform 8587 * @since 10 8588 */ 8589 /** 8590 * Loads content 8591 * 8592 * @param { string } path Path of the page to which the content will be loaded 8593 * @param { LocalStorage } storage The data object shared within the content instance loaded by the window 8594 * @param { AsyncCallback<void> } callback Callback used to return the result. 8595 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8596 * 2. Incorrect parameter types. 8597 * @throws { BusinessError } 1300002 - This window state is abnormal. 8598 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8599 * @syscap SystemCapability.WindowManager.WindowManager.Core 8600 * @StageModelOnly 8601 * @crossplatform 8602 * @atomicservice 8603 * @since 11 8604 */ 8605 loadContent(path: string, storage: LocalStorage, callback: AsyncCallback<void>): void; 8606 /** 8607 * Loads content 8608 * 8609 * @param { string } path of the page to which the content will be loaded 8610 * @param { LocalStorage } storage The data object shared within the content instance loaded by the window 8611 * @returns { Promise<void> } 8612 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8613 * 2. Incorrect parameter types. 8614 * @throws { BusinessError } 1300002 - This window state is abnormal. 8615 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8616 * @syscap SystemCapability.WindowManager.WindowManager.Core 8617 * @StageModelOnly 8618 * @since 9 8619 */ 8620 /** 8621 * Loads content 8622 * 8623 * @param { string } path of the page to which the content will be loaded 8624 * @param { LocalStorage } storage The data object shared within the content instance loaded by the window 8625 * @returns { Promise<void> } 8626 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8627 * 2. Incorrect parameter types. 8628 * @throws { BusinessError } 1300002 - This window state is abnormal. 8629 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8630 * @syscap SystemCapability.WindowManager.WindowManager.Core 8631 * @StageModelOnly 8632 * @crossplatform 8633 * @since 10 8634 */ 8635 /** 8636 * Loads content 8637 * 8638 * @param { string } path of the page to which the content will be loaded 8639 * @param { LocalStorage } storage The data object shared within the content instance loaded by the window 8640 * @returns { Promise<void> } 8641 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8642 * 2. Incorrect parameter types. 8643 * @throws { BusinessError } 1300002 - This window state is abnormal. 8644 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8645 * @syscap SystemCapability.WindowManager.WindowManager.Core 8646 * @StageModelOnly 8647 * @crossplatform 8648 * @atomicservice 8649 * @since 11 8650 */ 8651 loadContent(path: string, storage?: LocalStorage): Promise<void>; 8652 /** 8653 * Loads content 8654 * 8655 * @param { string } path of the page to which the content will be loaded 8656 * @param { AsyncCallback<void> } callback Callback used to return the result. 8657 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8658 * 2. Incorrect parameter types. 8659 * @throws { BusinessError } 1300002 - This window state is abnormal. 8660 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8661 * @syscap SystemCapability.WindowManager.WindowManager.Core 8662 * @StageModelOnly 8663 * @since 9 8664 */ 8665 /** 8666 * Loads content 8667 * 8668 * @param { string } path of the page to which the content will be loaded 8669 * @param { AsyncCallback<void> } callback Callback used to return the result. 8670 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8671 * 2. Incorrect parameter types. 8672 * @throws { BusinessError } 1300002 - This window state is abnormal. 8673 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8674 * @syscap SystemCapability.WindowManager.WindowManager.Core 8675 * @StageModelOnly 8676 * @crossplatform 8677 * @since 10 8678 */ 8679 /** 8680 * Loads content 8681 * 8682 * @param { string } path of the page to which the content will be loaded 8683 * @param { AsyncCallback<void> } callback Callback used to return the result. 8684 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8685 * 2. Incorrect parameter types. 8686 * @throws { BusinessError } 1300002 - This window state is abnormal. 8687 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8688 * @syscap SystemCapability.WindowManager.WindowManager.Core 8689 * @StageModelOnly 8690 * @crossplatform 8691 * @atomicservice 8692 * @since 11 8693 */ 8694 loadContent(path: string, callback: AsyncCallback<void>): void; 8695 8696 /** 8697 * Loads content by named router 8698 * 8699 * @param { string } name - name of the page to which the content will be loaded. 8700 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window. 8701 * @param { AsyncCallback<void> } callback - Callback used to return the result. 8702 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8703 * 2. Incorrect parameter types. 8704 * @throws { BusinessError } 1300002 - This window state is abnormal. 8705 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 8706 * @syscap SystemCapability.WindowManager.WindowManager.Core 8707 * @stagemodelonly 8708 * @crossplatform 8709 * @atomicservice 8710 * @since 11 8711 */ 8712 loadContentByName(name: string, storage: LocalStorage, callback: AsyncCallback<void>): void; 8713 8714 /** 8715 * Loads content by named router 8716 * 8717 * @param { string } name - name of the page to which the content will be loaded. 8718 * @param { AsyncCallback<void> } callback - Callback used to return the result. 8719 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8720 * 2. Incorrect parameter types. 8721 * @throws { BusinessError } 1300002 - This window state is abnormal. 8722 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 8723 * @syscap SystemCapability.WindowManager.WindowManager.Core 8724 * @stagemodelonly 8725 * @crossplatform 8726 * @atomicservice 8727 * @since 11 8728 */ 8729 loadContentByName(name: string, callback: AsyncCallback<void>): void; 8730 8731 /** 8732 * Loads content by named router 8733 * 8734 * @param { string } name - name of the page to which the content will be loaded. 8735 * @param { LocalStorage } storage - The data object shared within the content instance loaded by the window. 8736 * @returns { Promise<void> } Promise that returns no value. 8737 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8738 * 2. Incorrect parameter types. 8739 * @throws { BusinessError } 1300002 - This window state is abnormal. 8740 * @throws { BusinessError } 1300003 - This window manager service works abnormally. 8741 * @syscap SystemCapability.WindowManager.WindowManager.Core 8742 * @stagemodelonly 8743 * @crossplatform 8744 * @atomicservice 8745 * @since 11 8746 */ 8747 loadContentByName(name: string, storage?: LocalStorage): Promise<void>; 8748 8749 /** 8750 * Window stage event callback on. 8751 * 8752 * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. 8753 * @param { Callback<WindowStageEventType> } callback Callback used to return the window stage lifecycle state. 8754 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8755 * 2. Incorrect parameter types; 8756 * 3. Parameter verification failed. 8757 * @throws { BusinessError } 1300002 - This window state is abnormal. 8758 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8759 * @syscap SystemCapability.WindowManager.WindowManager.Core 8760 * @StageModelOnly 8761 * @since 9 8762 */ 8763 /** 8764 * Window stage event callback on. 8765 * 8766 * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. 8767 * @param { Callback<WindowStageEventType> } callback Callback used to return the window stage lifecycle state. 8768 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8769 * 2. Incorrect parameter types; 8770 * 3. Parameter verification failed. 8771 * @throws { BusinessError } 1300002 - This window state is abnormal. 8772 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8773 * @syscap SystemCapability.WindowManager.WindowManager.Core 8774 * @StageModelOnly 8775 * @crossplatform 8776 * @since 10 8777 */ 8778 /** 8779 * Window stage event callback on. 8780 * 8781 * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. 8782 * @param { Callback<WindowStageEventType> } callback Callback used to return the window stage lifecycle state. 8783 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8784 * 2. Incorrect parameter types; 8785 * 3. Parameter verification failed. 8786 * @throws { BusinessError } 1300002 - This window state is abnormal. 8787 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8788 * @syscap SystemCapability.WindowManager.WindowManager.Core 8789 * @StageModelOnly 8790 * @crossplatform 8791 * @atomicservice 8792 * @since 11 8793 */ 8794 on(eventType: 'windowStageEvent', callback: Callback<WindowStageEventType>): void; 8795 /** 8796 * Window stage event callback off. 8797 * 8798 * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. 8799 * @param { Callback<WindowStageEventType> } callback Callback used to return the window stage lifecycle state. 8800 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 8801 * 2. Parameter verification failed. 8802 * @throws { BusinessError } 1300002 - This window state is abnormal. 8803 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8804 * @syscap SystemCapability.WindowManager.WindowManager.Core 8805 * @StageModelOnly 8806 * @since 9 8807 */ 8808 /** 8809 * Window stage event callback off. 8810 * 8811 * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. 8812 * @param { Callback<WindowStageEventType> } callback Callback used to return the window stage lifecycle state. 8813 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 8814 * 2. Parameter verification failed. 8815 * @throws { BusinessError } 1300002 - This window state is abnormal. 8816 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8817 * @syscap SystemCapability.WindowManager.WindowManager.Core 8818 * @StageModelOnly 8819 * @crossplatform 8820 * @since 10 8821 */ 8822 /** 8823 * Window stage event callback off. 8824 * 8825 * @param { 'windowStageEvent' } eventType The value is fixed at 'windowStageEvent', indicating the window stage lifecycle change event. 8826 * @param { Callback<WindowStageEventType> } callback Callback used to return the window stage lifecycle state. 8827 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types; 8828 * 2. Parameter verification failed. 8829 * @throws { BusinessError } 1300002 - This window state is abnormal. 8830 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8831 * @syscap SystemCapability.WindowManager.WindowManager.Core 8832 * @StageModelOnly 8833 * @crossplatform 8834 * @atomicservice 8835 * @since 11 8836 */ 8837 off(eventType: 'windowStageEvent', callback?: Callback<WindowStageEventType>): void; 8838 8839 /** 8840 * Window stage close callback on. 8841 * 8842 * @param { 'windowStageClose' } eventType The value is fixed at 'windowStageClose', indicating the window stage close event. 8843 * @param { Callback<void> } callback Callback function requires a boolean return value to determine whether to close the current main window. 8844 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8845 * 2. Incorrect parameter types; 8846 * 3. Parameter verification failed. 8847 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 8848 * @throws { BusinessError } 1300002 - This window state is abnormal. 8849 * @syscap SystemCapability.Window.SessionManager 8850 * @stagemodelonly 8851 * @atomicservice 8852 * @since 14 8853 */ 8854 on(eventType: 'windowStageClose', callback: Callback<void>): void; 8855 8856 /** 8857 * Window stage close callback off. 8858 * 8859 * @param { 'windowStageClose' } eventType The value is fixed at 'windowStageClose', indicating the window stage close event. 8860 * @param { Callback<void> } callback Callback function requires a boolean return value to determine whether to close the current main window. 8861 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8862 * 2. Incorrect parameter types; 8863 * 3. Parameter verification failed. 8864 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 8865 * @throws { BusinessError } 1300002 - This window state is abnormal. 8866 * @syscap SystemCapability.Window.SessionManager 8867 * @stagemodelonly 8868 * @atomicservice 8869 * @since 14 8870 */ 8871 off(eventType: 'windowStageClose', callback?: Callback<void>): void; 8872 8873 /** 8874 * Disable window decoration. It must be called before loadContent. 8875 * 8876 * @throws { BusinessError } 1300002 - This window state is abnormal. 8877 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8878 * @syscap SystemCapability.WindowManager.WindowManager.Core 8879 * @systemapi 8880 * @StageModelOnly 8881 * @since 9 8882 */ 8883 /** 8884 * Disable window decoration. It must be called before loadContent. 8885 * 8886 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 8887 * @throws { BusinessError } 1300002 - This window state is abnormal. 8888 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8889 * @syscap SystemCapability.WindowManager.WindowManager.Core 8890 * @systemapi 8891 * @StageModelOnly 8892 * @since 12 8893 */ 8894 disableWindowDecor(): void; 8895 8896 /** 8897 * Sets whether can show on lock screen or not 8898 * 8899 * @param { boolean } showOnLockScreen can show on lock screen if true, or not if false 8900 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8901 * 2. Incorrect parameter types. 8902 * @throws { BusinessError } 1300002 - This window state is abnormal. 8903 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8904 * @syscap SystemCapability.WindowManager.WindowManager.Core 8905 * @systemapi Hide this for inner system use. 8906 * @StageModelOnly 8907 * @since 9 8908 */ 8909 /** 8910 * Sets whether can show on lock screen or not 8911 * 8912 * @param { boolean } showOnLockScreen can show on lock screen if true, or not if false 8913 * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. 8914 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8915 * 2. Incorrect parameter types. 8916 * @throws { BusinessError } 1300002 - This window state is abnormal. 8917 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8918 * @syscap SystemCapability.WindowManager.WindowManager.Core 8919 * @systemapi Hide this for inner system use. 8920 * @StageModelOnly 8921 * @since 12 8922 */ 8923 setShowOnLockScreen(showOnLockScreen: boolean): void; 8924 8925 /** 8926 * Set whether to use default density. 8927 * 8928 * @param { boolean } enabled - Use default density if true, or follow system density change if false 8929 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified; 8930 * 2. Incorrect parameter types. 8931 * @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities. 8932 * @throws { BusinessError } 1300002 - This window state is abnormal. 8933 * @throws { BusinessError } 1300005 - This window stage is abnormal. 8934 * @syscap SystemCapability.Window.SessionManager 8935 * @StageModelOnly 8936 * @atomicservice 8937 * @since 12 8938 */ 8939 setDefaultDensityEnabled(enabled: boolean): void; 8940 } 8941 8942 /** 8943 * Attribute of the window for UI service extension ability. 8944 * 8945 * @enum { number } 8946 * @syscap SystemCapability.Window.SessionManager 8947 * @systemapi Hide this for inner system use. 8948 * @stagemodelonly 8949 * @since 14 8950 */ 8951 enum ExtensionWindowAttribute { 8952 /** 8953 * System window. 8954 * 8955 * @syscap SystemCapability.Window.SessionManager 8956 * @systemapi Hide this for inner system use. 8957 * @stagemodelonly 8958 * @since 14 8959 */ 8960 SYSTEM_WINDOW, 8961 8962 /** 8963 * Sub window. 8964 * 8965 * @syscap SystemCapability.Window.SessionManager 8966 * @systemapi Hide this for inner system use. 8967 * @stagemodelonly 8968 * @since 14 8969 */ 8970 SUB_WINDOW 8971 } 8972 8973 /** 8974 * Options for system window creation. 8975 * 8976 * @interface SystemWindowOptions 8977 * @syscap SystemCapability.Window.SessionManager 8978 * @systemapi Hide this for inner system use. 8979 * @stagemodelonly 8980 * @since 14 8981 */ 8982 interface SystemWindowOptions { 8983 /** 8984 * Indicates window type. 8985 * 8986 * @type { WindowType } 8987 * @syscap SystemCapability.Window.SessionManager 8988 * @systemapi Hide this for inner system use. 8989 * @stagemodelonly 8990 * @since 14 8991 */ 8992 windowType: WindowType; 8993 } 8994 8995 /** 8996 * Configuration of the window for UI service extension ability. 8997 * 8998 * @interface ExtensionWindowConfig 8999 * @syscap SystemCapability.Window.SessionManager 9000 * @systemapi Hide this for inner system use. 9001 * @stagemodelonly 9002 * @since 14 9003 */ 9004 interface ExtensionWindowConfig { 9005 /** 9006 * Window name. 9007 * 9008 * @type { string } 9009 * @syscap SystemCapability.Window.SessionManager 9010 * @systemapi Hide this for inner system use. 9011 * @stagemodelonly 9012 * @since 14 9013 */ 9014 windowName: string; 9015 9016 /** 9017 * Defines whether the window is a subwindow or a system window. 9018 * 9019 * @type { ExtensionWindowAttribute } 9020 * @syscap SystemCapability.Window.SessionManager 9021 * @systemapi Hide this for inner system use. 9022 * @stagemodelonly 9023 * @since 14 9024 */ 9025 windowAttribute: ExtensionWindowAttribute; 9026 9027 /** 9028 * The position and size of window. 9029 * 9030 * @type { Rect } 9031 * @syscap SystemCapability.Window.SessionManager 9032 * @systemapi Hide this for inner system use. 9033 * @stagemodelonly 9034 * @since 14 9035 */ 9036 windowRect: Rect; 9037 9038 /** 9039 * The options of sub window creation. 9040 * 9041 * @type { ?SubWindowOptions } 9042 * @syscap SystemCapability.Window.SessionManager 9043 * @systemapi Hide this for inner system use. 9044 * @stagemodelonly 9045 * @since 14 9046 */ 9047 subWindowOptions?: SubWindowOptions; 9048 9049 /** 9050 * The options of system window creation. 9051 * 9052 * @type { ?SystemWindowOptions } 9053 * @syscap SystemCapability.Window.SessionManager 9054 * @systemapi Hide this for inner system use. 9055 * @stagemodelonly 9056 * @since 14 9057 */ 9058 systemWindowOptions?: SystemWindowOptions; 9059 } 9060} 9061 9062export default window; 9063