@sapui5/ts-types 1.97.1 → 1.99.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +0 -4
  3. package/types/sap.apf.d.ts +2 -2
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +2 -240
  8. package/types/sap.f.d.ts +263 -636
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +170 -25
  11. package/types/sap.fe.macros.d.ts +13 -1
  12. package/types/sap.fe.navigation.d.ts +1 -1
  13. package/types/sap.fe.templates.d.ts +5 -1
  14. package/types/sap.fe.test.d.ts +19 -14
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +119 -1
  17. package/types/sap.landvisz.d.ts +49 -1
  18. package/types/sap.m.d.ts +3688 -350
  19. package/types/sap.makit.d.ts +1 -1
  20. package/types/sap.me.d.ts +1 -1
  21. package/types/sap.ndc.d.ts +38 -3
  22. package/types/sap.ovp.d.ts +1 -1
  23. package/types/sap.rules.ui.d.ts +1 -1
  24. package/types/sap.sac.grid.d.ts +3 -1
  25. package/types/sap.suite.ui.commons.d.ts +1 -1
  26. package/types/sap.suite.ui.generic.template.d.ts +29 -7
  27. package/types/sap.suite.ui.microchart.d.ts +1 -1
  28. package/types/sap.tnt.d.ts +31 -1
  29. package/types/sap.ui.codeeditor.d.ts +1 -1
  30. package/types/sap.ui.commons.d.ts +1 -1
  31. package/types/sap.ui.comp.d.ts +267 -14
  32. package/types/sap.ui.core.d.ts +1377 -383
  33. package/types/sap.ui.dt.d.ts +1 -1
  34. package/types/sap.ui.export.d.ts +3 -3
  35. package/types/sap.ui.fl.d.ts +13 -5
  36. package/types/sap.ui.generic.app.d.ts +1 -1
  37. package/types/sap.ui.generic.template.d.ts +1 -1
  38. package/types/sap.ui.integration.d.ts +29 -11
  39. package/types/sap.ui.layout.d.ts +7 -4
  40. package/types/sap.ui.mdc.d.ts +16 -6
  41. package/types/sap.ui.richtexteditor.d.ts +7 -1
  42. package/types/sap.ui.rta.d.ts +1 -1
  43. package/types/sap.ui.suite.d.ts +1 -1
  44. package/types/sap.ui.support.d.ts +6 -6
  45. package/types/sap.ui.table.d.ts +30 -1
  46. package/types/sap.ui.testrecorder.d.ts +1 -1
  47. package/types/sap.ui.unified.d.ts +1 -1
  48. package/types/sap.ui.ux3.d.ts +1 -1
  49. package/types/sap.ui.vbm.d.ts +1 -3
  50. package/types/sap.ui.vk.d.ts +64 -31
  51. package/types/sap.ui.vtm.d.ts +4 -4
  52. package/types/sap.uiext.inbox.d.ts +1 -1
  53. package/types/sap.ushell.d.ts +510 -139
  54. package/types/sap.ushell_abap.d.ts +1 -495
  55. package/types/sap.uxap.d.ts +1 -1
  56. package/types/sap.viz.d.ts +1 -1
  57. package/types/sap.webanalytics.core.d.ts +1 -1
  58. package/types/sap.zen.commons.d.ts +1 -1
  59. package/types/sap.zen.crosstab.d.ts +1 -1
  60. package/types/sap.zen.dsh.d.ts +1 -5
  61. package/types/sap.fe.placeholder.d.ts +0 -3
  62. package/types/sap.fe.plugins.d.ts +0 -3
  63. package/types/sap.fe.semantics.d.ts +0 -3
  64. package/types/sap.fe.tools.d.ts +0 -3
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.97.0
1
+ // For Library Version: 1.99.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -23,42 +23,52 @@ declare namespace sap {
23
23
  /**
24
24
  * @SINCE 1.15.0
25
25
  *
26
- * Initializes the Unified Shell container for the given platform. This method must be called exactly once
27
- * in the very beginning by platform-specific code in order to bootstrap the container. As soon as the returned
28
- * promise has been resolved, the container will be available as a singleton object `sap.ushell.Container`.
26
+ * Initializes the Unified Shell Container.
29
27
  *
30
- * For convenience, platform-specific bootstrap code is available and can be easily included (**before**
31
- * the SAPUI5 bootstrap) by a corporate shell as follows:
32
- * ```javascript
28
+ * This platform-specific method must be called exactly once in the very beginning to resolve all necessary
29
+ * dependencies and prepare Unified Shell's global infrastructure. As soon as the returned promise has been
30
+ * resolved, the container will be available as a singleton object in namespace `sap.ushell.Container`.
33
31
  *
34
- * <script src="/sap/public/bc/ui5_ui5/resources/sap/ushell_abap/evo/bootstrap/abap.js"></script>
35
- * <script id="sap-ui-bootstrap" src=".../sap-ui-core.js"></script>
36
- * ```
37
- * This bootstrap code will automatically defer the initialization of SAPUI5 until the container is available.
38
- * This is the preferred way of bootstrapping the Unified Shell.
32
+ * **Note:** `sap.ushell.bootstrap` is used internally by the SAP Fiori launchpad. Developers who build
33
+ * apps or plugins for the SAP Fiori launchpad should use `sap.ushell.bootstrap` in their code. However,
34
+ * there are special use cases where a customized bootstrap of Unified Shell is helpful, e.g. when Unified
35
+ * Shell UI services need to be accessed without having loaded the Unified Shell's UI. In such cases, additional
36
+ * dependencies need to be required to allow proper usage of the Unified Shell's functionality.
39
37
  *
40
- * Note: For SAPUI5 application projects the recommended way is to add a dependency to the "sap.ushell_abap"
41
- * library (`<groupId>com.sap.ushell</groupId> <artifactId>ushell_abap</artifactId>`)
42
- * and load the bootstrap code via the application's resources folder:
38
+ * **Example:**
43
39
  * ```javascript
44
40
  *
45
- * <script src=".../resources/sap/ushell_abap/bootstrap/evo/abap.js"></script>
46
- * <script id="sap-ui-bootstrap" src=".../sap-ui-core.js"></script>
47
- * ```
41
+ * <script id="sap-ui-bootstrap"
42
+ * src=".../sap-ui-core.js"
43
+ * data-sap-ui-libs="sap.ushell,sap.m">
44
+ * </script>
48
45
  *
46
+ * <!--...-->
47
+ *
48
+ * <script>
49
+ * sap.ui.getCore().attachInit(function () {
50
+ * // Container needs to be required to make sap.ushell.bootstrap available
51
+ * sap.ui.require(["sap/ushell/services/Container", ... ], function (Container) {
52
+ * window["sap-ushell-config"] = {...};
53
+ *
54
+ * sap.ushell.bootstrap("abap", {
55
+ * abap: "sap.ushell_abap.adapters.abap"
56
+ * }).then(function () {
57
+ * sap.ushell.Container.getServiceAsync(\/* Service *\/).then(function (serviceInstance) {
58
+ * ...
59
+ * });
60
+ * });
61
+ * });
62
+ * });
63
+ * </script>
64
+ * ```
49
65
  *
50
- * Since 1.15.0 you can provide the function `window['sap.ushell.bootstrap.callback']` for calling back
51
- * from this method asynchronously. SAPUI5's bootstrap is ongoing then. The same restrictions apply as for
52
- * the function `window['sap-ui-config']['xx-bootTask']`) when the Unified Shell container has not yet finished
53
- * its bootstrap. You cannot delay the bootstrap of SAPUI5 or the Unified Shell container; any errors are
54
- * ignored. This callback is useful for sending asynchronous back-end requests at the earliest opportunity
55
- * without delaying the core bootstrap of SAPUI5 and the Unified Shell container.
56
66
  * See:
57
67
  * sap.ushell.Container
58
68
  */
59
69
  function bootstrap(
60
70
  /**
61
- * the target platform, such as "abap" or "local" (Note: there is no fixed enumeration of possible platforms)
71
+ * the target platform, such as "abap" or "cdm".
62
72
  */
63
73
  sPlatform: string,
64
74
  /**
@@ -2299,15 +2309,15 @@ declare namespace sap {
2299
2309
  * expanded to `"sap.ushell.renderers." + sRendererName + ".Renderer"`. Names containing a dot are used
2300
2310
  * "as is".
2301
2311
  *
2302
- * The resulting name must point to a SAPUI5 object which is first required and then created (constructor
2303
- * call without arguments). The object must be either a control (i.e. extend `sap.ui.core.Control`) or a
2304
- * UI component (i.e. extend `sap.ui.core.UIComponent`), which is then automatically wrapped into a `sap.ui.core.ComponentContainer`
2305
- * control by this method. This `sap.ui.core.ComponentContainer` is created with `height` and `width` set
2306
- * to "100%" to accommodate the complete available space.
2312
+ * The resulting name must point to a SAPUI5 object which is first required and then instantiated (without
2313
+ * arguments). The object is expected to be a UI component (i.e. extend `sap.ui.core.UIComponent`), which
2314
+ * is then automatically wrapped into a `sap.ui.core.ComponentContainer` control by this method. The `sap.ui.core.ComponentContainer`
2315
+ * is created with `height` and `width` set to "100%" to accommodate the complete available space. Besides
2316
+ * UICompoents a control (i.e. extend `sap.ui.core.Control`) is accepted, too.
2307
2317
  *
2308
- * The returned renderer is supposed to be added to a direct child (for example `DIV`) of the `BODY` of
2318
+ * The returned renderer is supposed to be added to a direct child (for example `div`) of the `body` of
2309
2319
  * the page and there should be no other parts of the page consuming space outside the renderer. Use CSS
2310
- * class `sapUShellFullHeight` at `HTML`, `BODY` and at the element to which the renderer is added to allow
2320
+ * class `sapUShellFullHeight` at `html`, `body` and at the element to which the renderer is added to allow
2311
2321
  * the renderer to use 100% height.
2312
2322
  */
2313
2323
  createRenderer(
@@ -2317,8 +2327,7 @@ declare namespace sap {
2317
2327
  */
2318
2328
  sRendererName?: string,
2319
2329
  /**
2320
- * If true, the renderer is created asynchronously and a Promise is returned. For CSP compliance, applications
2321
- * must always set bAsync:true.
2330
+ * If `true`, the renderer is created asynchronously and a `Promise` is returned.
2322
2331
  */
2323
2332
  bAsync?: boolean
2324
2333
  ): sap.ui.core.Control | Promise<any>;
@@ -2565,49 +2574,6 @@ declare namespace sap {
2565
2574
  */
2566
2575
  bIsDirty?: boolean
2567
2576
  ): void;
2568
- /**
2569
- * @SINCE 1.21.2
2570
- *
2571
- * Determines the current logon frame provider for the entire Unified Shell. Initially, a rudimentary default
2572
- * provider is active and should be replaced as soon as possible by the current renderer.
2573
- *
2574
- * A logon frame provider is used to facilitate user authentication even for requests sent via `XMLHttpRequest`.
2575
- * It is called back in order to create a hidden `IFRAME`, to show it to the user, then to hide and destroy
2576
- * it. The frame must be treated as a black box by the provider; especially with respect to the source of
2577
- * the frame which is managed by the Unified Shell framework. Showing the frame might require user interaction
2578
- * and some decoration around the frame. The frame should be destroyed, not reused, to be on the safe side.
2579
- * Note that in typical cases with SAML2, authentication happens automatically and the frame can stay hidden.
2580
- *
2581
- * The following order of method calls is guaranteed: The `create` method is called first.
2582
- * The `show` method may be called next (if there is HTML code to display). The `destroy` method is
2583
- * called last. A new cycle may start for a new logon process.
2584
- * See:
2585
- * sap.ushell.services.Container#cancelLogon
2586
- */
2587
- setLogonFrameProvider(
2588
- /**
2589
- * The new logon frame provider which needs to implement at least the methods documented here.
2590
- */
2591
- oLogonFrameProvider: {
2592
- /**
2593
- * A function taking no arguments and returning a DOM reference to an empty `IFRAME` which is initially
2594
- * hidden. The frame must not be moved around in the DOM later on. Make sure to add all necessary parent
2595
- * objects immediately, to render SAPUI5 controls as needed, and to return the DOM reference synchronously.
2596
- */
2597
- create: Function;
2598
- /**
2599
- * A function taking no arguments which hides and destroys the current frame.
2600
- */
2601
- destroy: Function;
2602
- /**
2603
- * A function taking no arguments which is called to indicate that the current frame probably needs to be
2604
- * shown to the user because interaction is required. Note that there may be false positives here. It is
2605
- * up to the provider how and when the frame is shown exactly; make sure to provide a good user interaction
2606
- * design here.
2607
- */
2608
- show: Function;
2609
- }
2610
- ): void;
2611
2577
  }
2612
2578
  /**
2613
2579
  * @SINCE 1.15.0
@@ -2624,24 +2590,11 @@ declare namespace sap {
2624
2590
  *
2625
2591
  * This interface is for usage by applications or shell renderers/containers.
2626
2592
  *
2627
- * Usage:
2628
- * ```javascript
2629
- *
2630
- * sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then( function (oService) {
2631
- *
2632
- * var sHref = oService.hrefForExternal({
2633
- * target : {
2634
- * semanticObject : "Product",
2635
- * action : "display" },
2636
- * params : {
2637
- * "ProductID" : "102343333"
2638
- * }
2639
- * }) || "";
2640
- *
2641
- * // do something with sHref
2642
- * });
2643
- * ```
2593
+ * Usage: sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then( function (oService)
2594
+ * {
2644
2595
  *
2596
+ * oService.hrefForExternalAsync({ target : { semanticObject : "Product", action : "display" }, params :
2597
+ * { "ProductID" : "102343333" } }).then( function(sHref) { // do something with sHref }); });
2645
2598
  *
2646
2599
  * Parameter names and values are case sensitive.
2647
2600
  *
@@ -2832,7 +2785,7 @@ declare namespace sap {
2832
2785
  ): jQuery.Deferred;
2833
2786
  /**
2834
2787
  * @SINCE 1.19.0
2835
- * @deprecated (since 1.38.0) - use getLinks
2788
+ * @deprecated (since 1.38) - use getLinks() instead.
2836
2789
  *
2837
2790
  * Resolves a given semantic object and business parameters to a list of links, taking into account the
2838
2791
  * form factor of the current device.
@@ -2901,10 +2854,10 @@ declare namespace sap {
2901
2854
  /**
2902
2855
  * @SINCE 1.94.0
2903
2856
  *
2904
- * Returns a string which can be put into the DOM (e.g. in a link tag) given an application specific hash
2905
- * suffix
2857
+ * Returns a Promise which resolves a string that can be put into the DOM (e.g. in a link tag) given an
2858
+ * application specific hash suffix
2906
2859
  *
2907
- * Example: `hrefForAppSpecificHash("View1/details/0/")` returns `#SemanticObject-action&/View1/details/0/`
2860
+ * Example: `hrefForAppSpecificHashAsync("View1/details/0/")` returns a Promise that resolves: `#SemanticObject-action&/View1/details/0/`
2908
2861
  * if the current application runs in the shell and was started using "SemanticObject-action" as shell navigation
2909
2862
  * hash
2910
2863
  */
@@ -2917,6 +2870,8 @@ declare namespace sap {
2917
2870
  ): Promise<string>;
2918
2871
  /**
2919
2872
  * @SINCE 1.15.0
2873
+ * @deprecated (since 1.98) - Use {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternalAsync}
2874
+ * instead.
2920
2875
  *
2921
2876
  * Returns a string which can be put into the DOM (e.g. in a link tag)
2922
2877
  */
@@ -2958,9 +2913,11 @@ declare namespace sap {
2958
2913
  * after all compaction requests have been sent. `bAsync=false` is deprecated since 1.94.
2959
2914
  */
2960
2915
  bAsync: boolean
2961
- ): string;
2916
+ ): string | Promise<string>;
2962
2917
  /**
2963
2918
  * @SINCE 1.15.0
2919
+ * @deprecated (since 1.98) - Use {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternalAsync}
2920
+ * instead.
2964
2921
  *
2965
2922
  * Returns a string which can be put into the DOM (e.g. in a link tag)
2966
2923
  */
@@ -2998,39 +2955,18 @@ declare namespace sap {
2998
2955
  * after all compaction requests have been sent. `bAsync=false` is deprecated since 1.94.
2999
2956
  */
3000
2957
  bAsync: boolean
3001
- ): string;
2958
+ ): string | Promise<string>;
3002
2959
  /**
3003
2960
  * @SINCE 1.94.0
3004
2961
  *
3005
- * Returns a string which can be put into the DOM (e.g. in a link tag)
2962
+ * Returns a Promise which resolves a string. That string can be put into the DOM (e.g. in a link tag)
3006
2963
  */
3007
2964
  hrefForExternalAsync(
3008
2965
  /**
3009
- * object encoding a semantic object and action, e.g.
3010
- * ```javascript
3011
- *
3012
- * {
3013
- * target : { semanticObject : "AnObject", action: "action" },
3014
- * params : { A : "B" }
3015
- * }
3016
- * ```
3017
- * or e.g.
3018
- * ```javascript
3019
- *
3020
- * {
3021
- * target : {
3022
- * semanticObject : "AnObject",
3023
- * action: "action", context : "AB7F3C"
3024
- * },
3025
- * params : {
3026
- * A : "B",
3027
- * c : "e"
3028
- * }
3029
- * }
3030
- * ```
3031
- * or
3032
- * ```javascript
3033
- * { target : { shellHash : "SO-36?jumper=postman" } }```
2966
+ * object encoding a semantic object and action, e.g. ` { target : { semanticObject : "AnObject", action:
2967
+ * "action" }, params : { A : "B" } } ` or e.g. ` { target : { semanticObject : "AnObject", action: "action",
2968
+ * context : "AB7F3C" }, params : { A : "B", c : "e" } } ` or `{ target : { shellHash : "SO-36?jumper=postman"
2969
+ * } }`
3034
2970
  */
3035
2971
  oArgs: object,
3036
2972
  /**
@@ -3040,7 +2976,7 @@ declare namespace sap {
3040
2976
  ): Promise<string>;
3041
2977
  /**
3042
2978
  * @SINCE 1.36.0
3043
- * @deprecated (since 1.94) - Use `isInitialNavigationAsync` instead
2979
+ * @deprecated (since 1.94) - Use `isInitialNavigationAsync` instead.
3044
2980
  *
3045
2981
  * Checks whether the FLP has performed the first navigation. This method can be used to detect whether
3046
2982
  * the current app was started directly, that is, without a previous navigation to another app, to the FLP
@@ -3183,6 +3119,7 @@ declare namespace sap {
3183
3119
  }
3184
3120
  /**
3185
3121
  * @SINCE 1.15.0
3122
+ * @deprecated - This service has been deprecated as it only works for the classic homepage.
3186
3123
  *
3187
3124
  * A service for handling groups, tiles and catalogs.
3188
3125
  *
@@ -3462,6 +3399,8 @@ declare namespace sap {
3462
3399
  oGroup: object
3463
3400
  ): string;
3464
3401
  /**
3402
+ * @deprecated - Alternative for use with {@link sap.ushell.services.Bookmark} is {@link sap.ushell.services.Bookmarks#getContentNodes}
3403
+ *
3465
3404
  * Returns the groups of the user. In case of success, the `done` function gets an array of 'anonymous'
3466
3405
  * groups. The order of the array is the order in which the groups will be displayed to the user.
3467
3406
  */
@@ -3668,6 +3607,9 @@ declare namespace sap {
3668
3607
  oTile: object
3669
3608
  ): void;
3670
3609
  /**
3610
+ * @deprecated - This feature has been deprecated with the classic homepage. There is no alternative with
3611
+ * spaces and pages.
3612
+ *
3671
3613
  * Register an external tile actions provider callback function.
3672
3614
  *
3673
3615
  * The callback has to return an array of actions of the given tile. The callback is triggered when @see
@@ -5034,8 +4976,8 @@ declare namespace sap {
5034
4976
  /**
5035
4977
  * any value
5036
4978
  */
5037
- sURL: String
5038
- ): String;
4979
+ sURL: string
4980
+ ): string;
5039
4981
  /**
5040
4982
  * @SINCE 1.16.0
5041
4983
  *
@@ -5061,6 +5003,7 @@ declare namespace sap {
5061
5003
  ): Object;
5062
5004
  /**
5063
5005
  * @SINCE 1.30.0
5006
+ * @deprecated (since 1.96.0) - use isIntentUrlAsync instead
5064
5007
  *
5065
5008
  * Check if a URL has an intent based navigation part which can be parsed into a semantic object and action
5066
5009
  * part. Accepts only a relative URL (must contain #) or fully qualified Urls for which origin and filename
@@ -5071,10 +5014,6 @@ declare namespace sap {
5071
5014
  *
5072
5015
  * The actual test is synchronous and *only* tests whether the hash part can be parsed and contains a semantic
5073
5016
  * object and action. It does not test whether the intent or its parameters are valid for a given user
5074
- *
5075
- * This function does not work properly when used inside the app runtime as it compares the given URL to
5076
- * the app runtime's URL instead of the outer FLP's URL. It can still be used for synchronous use cases
5077
- * in the ushell that do not run inside the app runtime.
5078
5017
  */
5079
5018
  isIntentUrl(
5080
5019
  /**
@@ -5111,8 +5050,8 @@ declare namespace sap {
5111
5050
  /**
5112
5051
  * any value { ABC : [1,"1 2"], DEF : ["4"]}
5113
5052
  */
5114
- oParams: Object
5115
- ): String;
5053
+ oParams: object
5054
+ ): string;
5116
5055
  /**
5117
5056
  * @SINCE 1.20.0
5118
5057
  *
@@ -5122,8 +5061,8 @@ declare namespace sap {
5122
5061
  /**
5123
5062
  * Parameter string, e.g. `?ABC=1&ABC=1%202DEF=4`
5124
5063
  */
5125
- sParams: String
5126
- ): Object;
5064
+ sParams: string
5065
+ ): object;
5127
5066
  /**
5128
5067
  * @SINCE 1.16.0
5129
5068
  *
@@ -5135,7 +5074,7 @@ declare namespace sap {
5135
5074
  *
5136
5075
  * e.g. `"#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
5137
5076
  */
5138
- sHash: String
5077
+ sHash: string
5139
5078
  ): object;
5140
5079
  /**
5141
5080
  * @SINCE 1.16.0
@@ -5149,7 +5088,7 @@ declare namespace sap {
5149
5088
  * Hash part of a shell conformant URL #SO-Action~Context?P1=a&P2=x&/route?RPV=1 the hash part
5150
5089
  * of an URL, e.g. "#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
5151
5090
  */
5152
- sHash: String
5091
+ sHash: string
5153
5092
  ): object;
5154
5093
  }
5155
5094
  /**
@@ -6271,6 +6210,436 @@ declare namespace sap {
6271
6210
  }
6272
6211
  }
6273
6212
 
6213
+ namespace footerbar {
6214
+ interface $AddBookmarkButtonSettings extends sap.m.$ButtonSettings {
6215
+ /**
6216
+ * A callback function that is called before the save-as-tile dialog is opened.
6217
+ */
6218
+ beforePressHandler?:
6219
+ | Function
6220
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
6221
+
6222
+ /**
6223
+ * A callback function that is called after the save-as-tile dialog is closed.
6224
+ */
6225
+ afterPressHandler?:
6226
+ | any
6227
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
6228
+
6229
+ /**
6230
+ * Title to be displayed on the tile.
6231
+ */
6232
+ title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6233
+
6234
+ /**
6235
+ * Subtitle to be displayed below the tile title.
6236
+ */
6237
+ subtitle?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6238
+
6239
+ /**
6240
+ * Text to be displayed at the bottom of the tile.
6241
+ */
6242
+ info?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6243
+
6244
+ /**
6245
+ * Icon to be displayed in the Tile.
6246
+ */
6247
+ tileIcon?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6248
+
6249
+ /**
6250
+ * For dynamic tile, the unit to be displayed below the number, for example, USD.
6251
+ */
6252
+ numberUnit?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6253
+
6254
+ /**
6255
+ * The keywords based on which the future tile should be indexed and filtered.
6256
+ */
6257
+ keywords?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6258
+
6259
+ /**
6260
+ * A customized target URL for the tile.
6261
+ */
6262
+ customUrl?: any | sap.ui.base.ManagedObject.PropertyBindingInfo;
6263
+
6264
+ /**
6265
+ * URL of an OData service from which data for a dynamic tile should be read.
6266
+ */
6267
+ serviceUrl?: any | sap.ui.base.ManagedObject.PropertyBindingInfo;
6268
+
6269
+ /**
6270
+ * Number of seconds after which dynamic content is read from the data source and the display is refreshed.
6271
+ */
6272
+ serviceRefreshInterval?:
6273
+ | string
6274
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
6275
+
6276
+ /**
6277
+ * Whether to display the control for group selection in the save-as-tile dialog in launchpad homepage mode.
6278
+ */
6279
+ showGroupSelection?:
6280
+ | boolean
6281
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
6282
+
6283
+ /**
6284
+ * Whether to display the control for page selection in the save-bookmark dialog in launchpad spaces mode.
6285
+ */
6286
+ showPageSelection?:
6287
+ | boolean
6288
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
6289
+
6290
+ /**
6291
+ * @deprecated - use dedicated properties above instead
6292
+ *
6293
+ * An object containing properties with information about the app, e.g. serviceUrl, numberUnit, ... .
6294
+ */
6295
+ appData?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
6296
+ }
6297
+
6298
+ /**
6299
+ * Clicking the button opens a dialog box allowing the user to save the app state, so that the app can be
6300
+ * launched in this state directly from the launchpad.
6301
+ */
6302
+ class AddBookmarkButton extends sap.m.Button {
6303
+ /**
6304
+ * Constructor for a new ui/footerbar/AddBookmarkButton.
6305
+ *
6306
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
6307
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
6308
+ * of the syntax of the settings object.
6309
+ */
6310
+ constructor(
6311
+ /**
6312
+ * Initial settings for the new control
6313
+ */
6314
+ mSettings?: sap.ushell.ui.footerbar.$AddBookmarkButtonSettings
6315
+ );
6316
+ /**
6317
+ * Constructor for a new ui/footerbar/AddBookmarkButton.
6318
+ *
6319
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
6320
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
6321
+ * of the syntax of the settings object.
6322
+ */
6323
+ constructor(
6324
+ /**
6325
+ * ID for the new control, generated automatically if no id is given
6326
+ */
6327
+ sId?: string,
6328
+ /**
6329
+ * Initial settings for the new control
6330
+ */
6331
+ mSettings?: sap.ushell.ui.footerbar.$AddBookmarkButtonSettings
6332
+ );
6333
+
6334
+ /**
6335
+ * Creates a new subclass of class sap.ushell.ui.footerbar.AddBookmarkButton with name `sClassName` and
6336
+ * enriches it with the information contained in `oClassInfo`.
6337
+ *
6338
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Button.extend}.
6339
+ */
6340
+ static extend<T extends Record<string, unknown>>(
6341
+ /**
6342
+ * Name of the class being created
6343
+ */
6344
+ sClassName: string,
6345
+ /**
6346
+ * Object literal with information about the class
6347
+ */
6348
+ oClassInfo?: sap.ClassInfo<
6349
+ T,
6350
+ sap.ushell.ui.footerbar.AddBookmarkButton
6351
+ >,
6352
+ /**
6353
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
6354
+ * used by this class
6355
+ */
6356
+ FNMetaImpl?: Function
6357
+ ): Function;
6358
+ /**
6359
+ * Returns a metadata object for class sap.ushell.ui.footerbar.AddBookmarkButton.
6360
+ */
6361
+ static getMetadata(): sap.ui.core.ElementMetadata;
6362
+ /**
6363
+ * Gets current value of property {@link #getAfterPressHandler afterPressHandler}.
6364
+ *
6365
+ * A callback function that is called after the save-as-tile dialog is closed.
6366
+ */
6367
+ getAfterPressHandler(): any;
6368
+ /**
6369
+ * @deprecated - use dedicated properties above instead
6370
+ *
6371
+ * Gets current value of property {@link #getAppData appData}.
6372
+ *
6373
+ * An object containing properties with information about the app, e.g. serviceUrl, numberUnit, ... .
6374
+ */
6375
+ getAppData(): object;
6376
+ /**
6377
+ * Gets current value of property {@link #getBeforePressHandler beforePressHandler}.
6378
+ *
6379
+ * A callback function that is called before the save-as-tile dialog is opened.
6380
+ */
6381
+ getBeforePressHandler(): Function;
6382
+ /**
6383
+ * Gets current value of property {@link #getCustomUrl customUrl}.
6384
+ *
6385
+ * A customized target URL for the tile.
6386
+ */
6387
+ getCustomUrl(): any;
6388
+ /**
6389
+ * Gets current value of property {@link #getInfo info}.
6390
+ *
6391
+ * Text to be displayed at the bottom of the tile.
6392
+ */
6393
+ getInfo(): string;
6394
+ /**
6395
+ * Gets current value of property {@link #getKeywords keywords}.
6396
+ *
6397
+ * The keywords based on which the future tile should be indexed and filtered.
6398
+ */
6399
+ getKeywords(): string;
6400
+ /**
6401
+ * Gets current value of property {@link #getNumberUnit numberUnit}.
6402
+ *
6403
+ * For dynamic tile, the unit to be displayed below the number, for example, USD.
6404
+ */
6405
+ getNumberUnit(): string;
6406
+ /**
6407
+ * Gets current value of property {@link #getServiceRefreshInterval serviceRefreshInterval}.
6408
+ *
6409
+ * Number of seconds after which dynamic content is read from the data source and the display is refreshed.
6410
+ */
6411
+ getServiceRefreshInterval(): string;
6412
+ /**
6413
+ * Gets current value of property {@link #getServiceUrl serviceUrl}.
6414
+ *
6415
+ * URL of an OData service from which data for a dynamic tile should be read.
6416
+ */
6417
+ getServiceUrl(): any;
6418
+ /**
6419
+ * Gets current value of property {@link #getShowGroupSelection showGroupSelection}.
6420
+ *
6421
+ * Whether to display the control for group selection in the save-as-tile dialog in launchpad homepage mode.
6422
+ *
6423
+ * Default value is `true`.
6424
+ */
6425
+ getShowGroupSelection(): boolean;
6426
+ /**
6427
+ * Gets current value of property {@link #getShowPageSelection showPageSelection}.
6428
+ *
6429
+ * Whether to display the control for page selection in the save-bookmark dialog in launchpad spaces mode.
6430
+ *
6431
+ * Default value is `true`.
6432
+ */
6433
+ getShowPageSelection(): boolean;
6434
+ /**
6435
+ * Gets current value of property {@link #getSubtitle subtitle}.
6436
+ *
6437
+ * Subtitle to be displayed below the tile title.
6438
+ */
6439
+ getSubtitle(): string;
6440
+ /**
6441
+ * Gets current value of property {@link #getTileIcon tileIcon}.
6442
+ *
6443
+ * Icon to be displayed in the Tile.
6444
+ */
6445
+ getTileIcon(): string;
6446
+ /**
6447
+ * Gets current value of property {@link #getTitle title}.
6448
+ *
6449
+ * Title to be displayed on the tile.
6450
+ */
6451
+ getTitle(): string;
6452
+ /**
6453
+ * Sets a new value for property {@link #getAfterPressHandler afterPressHandler}.
6454
+ *
6455
+ * A callback function that is called after the save-as-tile dialog is closed.
6456
+ *
6457
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6458
+ */
6459
+ setAfterPressHandler(
6460
+ /**
6461
+ * New value for property `afterPressHandler`
6462
+ */
6463
+ oAfterPressHandler?: any
6464
+ ): this;
6465
+ /**
6466
+ * @deprecated - use dedicated properties above instead
6467
+ *
6468
+ * Sets a new value for property {@link #getAppData appData}.
6469
+ *
6470
+ * An object containing properties with information about the app, e.g. serviceUrl, numberUnit, ... .
6471
+ *
6472
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6473
+ */
6474
+ setAppData(
6475
+ /**
6476
+ * New value for property `appData`
6477
+ */
6478
+ oAppData?: object
6479
+ ): this;
6480
+ /**
6481
+ * Sets a new value for property {@link #getBeforePressHandler beforePressHandler}.
6482
+ *
6483
+ * A callback function that is called before the save-as-tile dialog is opened.
6484
+ *
6485
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6486
+ */
6487
+ setBeforePressHandler(
6488
+ /**
6489
+ * New value for property `beforePressHandler`
6490
+ */
6491
+ fnBeforePressHandler?: Function
6492
+ ): this;
6493
+ /**
6494
+ * Sets a new value for property {@link #getCustomUrl customUrl}.
6495
+ *
6496
+ * A customized target URL for the tile.
6497
+ *
6498
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6499
+ */
6500
+ setCustomUrl(
6501
+ /**
6502
+ * New value for property `customUrl`
6503
+ */
6504
+ oCustomUrl?: any
6505
+ ): this;
6506
+ /**
6507
+ * Sets a new value for property {@link #getInfo info}.
6508
+ *
6509
+ * Text to be displayed at the bottom of the tile.
6510
+ *
6511
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6512
+ */
6513
+ setInfo(
6514
+ /**
6515
+ * New value for property `info`
6516
+ */
6517
+ sInfo?: string
6518
+ ): this;
6519
+ /**
6520
+ * Sets a new value for property {@link #getKeywords keywords}.
6521
+ *
6522
+ * The keywords based on which the future tile should be indexed and filtered.
6523
+ *
6524
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6525
+ */
6526
+ setKeywords(
6527
+ /**
6528
+ * New value for property `keywords`
6529
+ */
6530
+ sKeywords?: string
6531
+ ): this;
6532
+ /**
6533
+ * Sets a new value for property {@link #getNumberUnit numberUnit}.
6534
+ *
6535
+ * For dynamic tile, the unit to be displayed below the number, for example, USD.
6536
+ *
6537
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6538
+ */
6539
+ setNumberUnit(
6540
+ /**
6541
+ * New value for property `numberUnit`
6542
+ */
6543
+ sNumberUnit?: string
6544
+ ): this;
6545
+ /**
6546
+ * Sets a new value for property {@link #getServiceRefreshInterval serviceRefreshInterval}.
6547
+ *
6548
+ * Number of seconds after which dynamic content is read from the data source and the display is refreshed.
6549
+ *
6550
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6551
+ */
6552
+ setServiceRefreshInterval(
6553
+ /**
6554
+ * New value for property `serviceRefreshInterval`
6555
+ */
6556
+ sServiceRefreshInterval?: string
6557
+ ): this;
6558
+ /**
6559
+ * Sets a new value for property {@link #getServiceUrl serviceUrl}.
6560
+ *
6561
+ * URL of an OData service from which data for a dynamic tile should be read.
6562
+ *
6563
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6564
+ */
6565
+ setServiceUrl(
6566
+ /**
6567
+ * New value for property `serviceUrl`
6568
+ */
6569
+ oServiceUrl?: any
6570
+ ): this;
6571
+ /**
6572
+ * Sets a new value for property {@link #getShowGroupSelection showGroupSelection}.
6573
+ *
6574
+ * Whether to display the control for group selection in the save-as-tile dialog in launchpad homepage mode.
6575
+ *
6576
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6577
+ *
6578
+ * Default value is `true`.
6579
+ */
6580
+ setShowGroupSelection(
6581
+ /**
6582
+ * New value for property `showGroupSelection`
6583
+ */
6584
+ bShowGroupSelection?: boolean
6585
+ ): this;
6586
+ /**
6587
+ * Sets a new value for property {@link #getShowPageSelection showPageSelection}.
6588
+ *
6589
+ * Whether to display the control for page selection in the save-bookmark dialog in launchpad spaces mode.
6590
+ *
6591
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6592
+ *
6593
+ * Default value is `true`.
6594
+ */
6595
+ setShowPageSelection(
6596
+ /**
6597
+ * New value for property `showPageSelection`
6598
+ */
6599
+ bShowPageSelection?: boolean
6600
+ ): this;
6601
+ /**
6602
+ * Sets a new value for property {@link #getSubtitle subtitle}.
6603
+ *
6604
+ * Subtitle to be displayed below the tile title.
6605
+ *
6606
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6607
+ */
6608
+ setSubtitle(
6609
+ /**
6610
+ * New value for property `subtitle`
6611
+ */
6612
+ sSubtitle?: string
6613
+ ): this;
6614
+ /**
6615
+ * Sets a new value for property {@link #getTileIcon tileIcon}.
6616
+ *
6617
+ * Icon to be displayed in the Tile.
6618
+ *
6619
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6620
+ */
6621
+ setTileIcon(
6622
+ /**
6623
+ * New value for property `tileIcon`
6624
+ */
6625
+ sTileIcon?: string
6626
+ ): this;
6627
+ /**
6628
+ * Sets a new value for property {@link #getTitle title}.
6629
+ *
6630
+ * Title to be displayed on the tile.
6631
+ *
6632
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6633
+ */
6634
+ setTitle(
6635
+ /**
6636
+ * New value for property `title`
6637
+ */
6638
+ sTitle?: string
6639
+ ): this;
6640
+ }
6641
+ }
6642
+
6274
6643
  namespace launchpad {
6275
6644
  interface $ActionItemSettings extends sap.m.$ButtonSettings {
6276
6645
  actionType?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
@@ -9641,6 +10010,8 @@ declare namespace sap {
9641
10010
 
9642
10011
  "sap/ushell/ui/appfinder/AppBox": undefined;
9643
10012
 
10013
+ "sap/ushell/ui/footerbar/AddBookmarkButton": undefined;
10014
+
9644
10015
  "sap/ushell/ui/launchpad/ActionItem": undefined;
9645
10016
 
9646
10017
  "sap/ushell/ui/launchpad/DashboardGroupsContainer": undefined;