@sapui5/ts-types 1.146.0 → 1.147.1

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 (70) hide show
  1. package/package.json +1 -1
  2. package/types/{sap.ui.commons.d.ts → commons-1.147.0-d.ts} +1 -1
  3. package/types/{sap.ui.core.d.ts → core-1.147.0-d.ts} +175 -16
  4. package/types/{sap.ui.dt.d.ts → dt-1.147.0-d.ts} +1 -1
  5. package/types/index.d.ts +7 -10
  6. package/types/{sap.ui.mdc.d.ts → mdc-1.147.0-d.ts} +107 -20
  7. package/types/{sap.m.d.ts → mobile-1.147.0-d.ts} +376 -127
  8. package/types/sap.apf.d.ts +1 -1
  9. package/types/sap.ca.ui.d.ts +1 -1
  10. package/types/sap.chart.d.ts +4 -7
  11. package/types/sap.collaboration.d.ts +1 -1
  12. package/types/sap.esh.search.ui.d.ts +1 -52
  13. package/types/sap.f.d.ts +144 -1
  14. package/types/sap.fe.ariba.d.ts +1 -1
  15. package/types/sap.fe.base.d.ts +1 -1
  16. package/types/sap.fe.controls.d.ts +1 -1
  17. package/types/sap.fe.core.d.ts +1 -1
  18. package/types/sap.fe.ina.d.ts +1 -1
  19. package/types/sap.fe.macros.d.ts +1666 -1005
  20. package/types/sap.fe.navigation.d.ts +1 -1
  21. package/types/sap.fe.placeholder.d.ts +1 -1
  22. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  23. package/types/sap.fe.templates.d.ts +1 -1
  24. package/types/sap.fe.test.d.ts +49 -1
  25. package/types/sap.fe.tools.d.ts +1 -1
  26. package/types/sap.feedback.ui.d.ts +1 -1
  27. package/types/sap.gantt.d.ts +182 -1
  28. package/types/sap.insights.d.ts +14 -1
  29. package/types/sap.makit.d.ts +1 -1
  30. package/types/sap.me.d.ts +1 -1
  31. package/types/sap.ndc.d.ts +1 -1
  32. package/types/sap.ovp.d.ts +1 -1
  33. package/types/sap.rules.ui.d.ts +1 -1
  34. package/types/sap.sac.df.d.ts +1 -1
  35. package/types/sap.suite.ui.commons.d.ts +122 -1
  36. package/types/sap.suite.ui.generic.template.d.ts +79 -1
  37. package/types/sap.suite.ui.microchart.d.ts +1 -1
  38. package/types/sap.ui.codeeditor.d.ts +82 -46
  39. package/types/sap.ui.comp.d.ts +5 -15
  40. package/types/sap.ui.export.d.ts +1 -1
  41. package/types/sap.ui.fl.d.ts +5 -1
  42. package/types/sap.ui.generic.app.d.ts +5 -5
  43. package/types/sap.ui.generic.template.d.ts +1 -1
  44. package/types/sap.ui.geomap.d.ts +1 -1
  45. package/types/sap.ui.integration.d.ts +23 -25
  46. package/types/sap.ui.layout.d.ts +1 -1
  47. package/types/sap.ui.richtexteditor.d.ts +1 -1
  48. package/types/sap.ui.rta.d.ts +1 -1
  49. package/types/sap.ui.suite.d.ts +1 -1
  50. package/types/sap.ui.support.d.ts +2 -2
  51. package/types/sap.ui.table.d.ts +1 -1
  52. package/types/sap.ui.testrecorder.d.ts +1 -1
  53. package/types/sap.ui.unified.d.ts +6 -9
  54. package/types/sap.ui.vbm.d.ts +8 -24
  55. package/types/sap.ui.vk.d.ts +1 -1
  56. package/types/sap.ui.vtm.d.ts +1 -1
  57. package/types/sap.uiext.inbox.d.ts +1 -1
  58. package/types/sap.ushell.d.ts +407 -66
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +146 -1
  61. package/types/sap.viz.d.ts +4 -5
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +1 -1
  64. package/types/sap.zen.crosstab.d.ts +1 -1
  65. package/types/sap.zen.dsh.d.ts +1 -1
  66. package/types/{sap.tnt.d.ts → tnt-1.147.0-d.ts} +1 -4
  67. package/types/{sap.ui.ux3.d.ts → ux3-1.147.0-d.ts} +1 -1
  68. package/types/sap.ui.webc.common.d.ts +0 -173
  69. package/types/sap.ui.webc.fiori.d.ts +0 -16012
  70. package/types/sap.ui.webc.main.d.ts +0 -51158
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sapui5/ts-types",
3
- "version": "1.146.0",
3
+ "version": "1.147.1",
4
4
  "description": "SAPUI5 TypeScript Definitions",
5
5
  "homepage": "https://ui5.sap.com",
6
6
  "author": "SAP SE (https://www.sap.com)",
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.146.0
282
+ // For Library Version: 1.147.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -33157,6 +33157,9 @@ declare namespace sap {
33157
33157
  * 'SUPPORTED_PROTOCOLS'.
33158
33158
  */
33159
33159
  enum SUPPORTED_PROTOCOLS {
33160
+ /**
33161
+ * Protocol v10.pcp.sap.com
33162
+ */
33160
33163
  v10 = "v10.pcp.sap.com",
33161
33164
  }
33162
33165
  }
@@ -33767,7 +33770,6 @@ declare namespace sap {
33767
33770
  /**
33768
33771
  * Implementing this interface allows a control to be accessible via access keys.
33769
33772
  *
33770
- * @since 1.104
33771
33773
  * @experimental As of version 1.104.
33772
33774
  */
33773
33775
  interface IAccessKeySupport {
@@ -33777,21 +33779,18 @@ declare namespace sap {
33777
33779
  * Returns a refence to DOM element to be focused during Access key navigation. If not implemented getFocusDomRef()
33778
33780
  * method is used.
33779
33781
  *
33780
- * @since 1.104
33781
33782
  * @experimental As of version 1.104.
33782
33783
  */
33783
33784
  getAccessKeysFocusTarget?(): void;
33784
33785
  /**
33785
33786
  * If implemented called when access keys feature is enabled and highlighting is over
33786
33787
  *
33787
- * @since 1.104
33788
33788
  * @experimental As of version 1.104.
33789
33789
  */
33790
33790
  onAccKeysHighlightEnd?(): void;
33791
33791
  /**
33792
33792
  * If implemented called when access keys feature is enabled and highlighting is ongoing
33793
33793
  *
33794
- * @since 1.104
33795
33794
  * @experimental As of version 1.104.
33796
33795
  */
33797
33796
  onAccKeysHighlightStart?(): void;
@@ -48727,6 +48726,59 @@ declare namespace sap {
48727
48726
  */
48728
48727
  oTargetDomNode: /* was Element */ global_Element
48729
48728
  ): void;
48729
+ /**
48730
+ * Executes a rendering callback and flushes the result into the provided DOM node.
48731
+ *
48732
+ * The rendering callback receives a RenderManager instance with the semantic rendering API implementation
48733
+ * (DOM interface methods like `openStart`, `attr`, `openEnd`, `text`, `close`, etc.).
48734
+ *
48735
+ * This method combines rendering and flushing in a single call, automatically handling non-HTML namespaces
48736
+ * (e.g., SVG, MathML) by detecting the namespace of the target DOM node.
48737
+ *
48738
+ * **Difference from calling render() then flush() separately:** When rendering into a non-HTML namespace
48739
+ * context (e.g., SVG or MathML elements), this method automatically detects the target node's namespace
48740
+ * and applies it as a fallback namespace for the rendering operation. This ensures that elements created
48741
+ * without an explicit parent element (such as when rendering into a DocumentFragment initially) inherit
48742
+ * the correct namespace.
48743
+ *
48744
+ * This function must not be called within control renderers.
48745
+ *
48746
+ * Usage:
48747
+ * ```javascript
48748
+ *
48749
+ * const oRM = new RenderManager().getInterface();
48750
+ *
48751
+ * // assume that oSvgContainer is already part of the DOM and we want to render a circle into it
48752
+ * oRM.renderAndFlush(function(oRM) {
48753
+ * oRM.openStart("circle").attr("cx", "50").attr("cy", "50").attr("r", "40");
48754
+ * oRM.openEnd();
48755
+ * oRM.close("circle");
48756
+ * }, oSvgContainer);
48757
+ *
48758
+ * oRM.destroy();
48759
+ * ```
48760
+ *
48761
+ *
48762
+ * @since 1.147
48763
+ *
48764
+ * @returns Reference to `this` to allow method chaining
48765
+ */
48766
+ renderAndFlush(
48767
+ /**
48768
+ * Rendering callback that receives a RenderManager instance with the semantic rendering API implementation
48769
+ * (DOM interface methods like `openStart`, `attr`, `openEnd`, `text`, `close`, etc.)
48770
+ */
48771
+ fnRender: (p1: sap.ui.core.RenderManager) => void,
48772
+ /**
48773
+ * Node in the DOM where the result should be flushed into
48774
+ */
48775
+ oTargetDomNode: /* was Element */ global_Element,
48776
+ /**
48777
+ * Determines whether the buffer of the target DOM node is expanded (`true`) or replaced (`false`), or the
48778
+ * new entry is inserted at a specific position (value of type `int`)
48779
+ */
48780
+ vInsert?: boolean | int
48781
+ ): this;
48730
48782
  /**
48731
48783
  * Turns the given control into its HTML representation and appends it to the rendering buffer.
48732
48784
  *
@@ -62737,9 +62789,9 @@ declare namespace sap {
62737
62789
  * has been resolved!
62738
62790
  *
62739
62791
  *
62740
- * @returns The meta model for this `ODataModel`
62792
+ * @returns The meta model for this `ODataModel`, or `undefined` if the model has been destroyed
62741
62793
  */
62742
- getMetaModel(): sap.ui.model.odata.ODataMetaModel;
62794
+ getMetaModel(): sap.ui.model.odata.ODataMetaModel | undefined;
62743
62795
  /**
62744
62796
  * Returns a JSON object that is a copy of the entity data referenced by the given `sPath` and `oContext`.
62745
62797
  * It does not load any data and may not return all requested data if it is not available.
@@ -65446,11 +65498,24 @@ declare namespace sap {
65446
65498
  * @returns `true` if this context is kept alive
65447
65499
  */
65448
65500
  isKeepAlive(): boolean;
65501
+ /**
65502
+ * Tells whether this context is outdated:
65503
+ * `undefined`: The outdated state has not been determined yet `true`: The context is outdated `false`:
65504
+ * The context is up to date
65505
+ *
65506
+ * The outdated state can also be accessed via the instance annotation "@$ui5.context.isOutdated".
65507
+ *
65508
+ * @experimental As of version 1.147.
65509
+ *
65510
+ * @returns Whether this context is outdated, or `undefined` if the outdated state has not been determined
65511
+ * yet
65512
+ */
65513
+ isOutdated(): boolean | undefined;
65449
65514
  /**
65450
65515
  * Tells whether this context is currently selected, but not {@link #delete deleted} on the client. Selection
65451
- * was experimental as of version 1.111.0. Since 1.122.0, the selection state can also be accessed via instance
65452
- * annotation "@$ui5.context.isSelected" at the entity. Note that the annotation does not take the deletion
65453
- * state into account.
65516
+ * was experimental as of version 1.111.0. Since 1.122.0, the selection state can also be accessed via the
65517
+ * instance annotation "@$ui5.context.isSelected" at the entity. Note that the annotation does not take
65518
+ * the deletion state into account.
65454
65519
  * See:
65455
65520
  * #setSelected
65456
65521
  *
@@ -65726,9 +65791,11 @@ declare namespace sap {
65726
65791
  * effects fail to load. Use it to set fields affected by side effects to read-only before {@link #requestSideEffects }
65727
65792
  * and make them editable again when the promise resolves; in the error handler, you can repeat the loading
65728
65793
  * of side effects.
65729
- * The promise is rejected if the call wants to refresh a whole list binding (via header context or an
65730
- * absolute path), but the deletion of a row context (see {@link #delete}) is pending with a different group
65731
- * ID.
65794
+ * The promise is rejected if
65795
+ * the call attempts to refresh an entire list binding (via header context or an absolute path) while
65796
+ * the deletion of a row context (see {@link #delete}) is pending with a different group ID, this is
65797
+ * the row context of a list binding with data aggregation which has `groupLevels` or `"grandTotal like
65798
+ * 1.84"`, or this context does not represent a single entity
65732
65799
  */
65733
65800
  requestSideEffects(
65734
65801
  /**
@@ -67142,9 +67209,11 @@ declare namespace sap {
67142
67209
  */
67143
67210
  getGroupId(): string;
67144
67211
  /**
67145
- * Returns the header context which allows binding to `$count` or `@$ui5.context.isSelected`.
67212
+ * Returns the header context which allows binding to `$count`, `@$ui5.context.isOutdated`, or `@$ui5.context.isSelected`.
67146
67213
  * See:
67147
67214
  * #getCount
67215
+ * sap.ui.model.odata.v4.Context#isOutdated
67216
+ * sap.ui.model.odata.v4.Context#isSelected
67148
67217
  *
67149
67218
  * @since 1.45.0
67150
67219
  *
@@ -76559,7 +76628,7 @@ declare namespace sap {
76559
76628
  /**
76560
76629
  * HTTP status code returned by the request (if available)
76561
76630
  */
76562
- statusCode?: string;
76631
+ statusCode?: string | number;
76563
76632
 
76564
76633
  /**
76565
76634
  * The status as a text, details not specified, intended only for diagnosis output
@@ -81034,6 +81103,11 @@ declare namespace sap {
81034
81103
  * See `vGroup` parameter
81035
81104
  */
81036
81105
  group?: boolean | Function;
81106
+ /**
81107
+ * An array of paths that are required for grouping. Supported since 1.147.0; consult the documentation
81108
+ * of the specific model implementation whether it evaluates these paths.
81109
+ */
81110
+ groupPaths?: string[];
81037
81111
  /**
81038
81112
  * The binding path for this sorter
81039
81113
  */
@@ -81143,6 +81217,14 @@ declare namespace sap {
81143
81217
  * @returns The group function
81144
81218
  */
81145
81219
  getGroupFunction(): Function;
81220
+ /**
81221
+ * Returns the group paths.
81222
+ *
81223
+ * @since 1.147.0
81224
+ *
81225
+ * @returns The array of group paths or `undefined` if this sorter has no group paths.
81226
+ */
81227
+ getGroupPaths(): string[] | undefined;
81146
81228
  /**
81147
81229
  * Returns the binding path for this sorter; see the path parameter of {@link sap.ui.model.Sorter#constructor}.
81148
81230
  *
@@ -82916,6 +82998,19 @@ declare namespace sap {
82916
82998
  | boolean
82917
82999
  | sap.ui.base.ManagedObject.PropertyBindingInfo
82918
83000
  | `{${string}}`;
83001
+
83002
+ /**
83003
+ * If set to `true`, a right-click (context menu) event will be triggered instead of a left-click. This
83004
+ * simulates the native browser right-click behavior by dispatching `mousedown` and `mouseup` with `button:
83005
+ * 2`, followed by a `contextmenu` event. The `xPercentage` and `yPercentage` properties can be used to
83006
+ * specify the position of the right-click event.
83007
+ *
83008
+ * @since 1.147
83009
+ */
83010
+ rightClick?:
83011
+ | boolean
83012
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
83013
+ | `{${string}}`;
82919
83014
  }
82920
83015
 
82921
83016
  /**
@@ -83534,6 +83629,10 @@ declare namespace sap {
83534
83629
  * The `Press` action is used to simulate a press interaction with a control. Most controls are supported,
83535
83630
  * for example buttons, links, list items, tables, filters, and form controls.
83536
83631
  *
83632
+ * The `Press` action can also simulate right-click (context menu) interactions by setting the `rightClick`
83633
+ * property to true. This is useful for testing controls with custom context menus, such as `sap.ui.table.Table`
83634
+ * and `sap.m.Table`.
83635
+ *
83537
83636
  * The `Press` action targets a special DOM element representing the control. This DOM element can be customized.
83538
83637
  *
83539
83638
  * For most most controls (even custom ones), the DOM focus reference is an appropriate choice. You can
@@ -83633,7 +83732,9 @@ declare namespace sap {
83633
83732
  /**
83634
83733
  * Sets focus on given control and triggers a 'tap' event on it (which is internally translated into a 'press'
83635
83734
  * event). If `keyDown` or `keyUp` is set to `true`, dispatches the corresponding keyboard event instead
83636
- * of mouse events. Logs an error if control is not visible (i.e. has no dom representation)
83735
+ * of mouse events. If `rightClick` property is set to `true`, triggers a `contextmenu` event instead, along
83736
+ * with appropriate `mousedown` and `mouseup` events. Logs an error if control is not visible (i.e. has
83737
+ * no dom representation)
83637
83738
  */
83638
83739
  executeOn(
83639
83740
  /**
@@ -83683,6 +83784,21 @@ declare namespace sap {
83683
83784
  * @returns Value of property `keyUp`
83684
83785
  */
83685
83786
  getKeyUp(): boolean;
83787
+ /**
83788
+ * Gets current value of property {@link #getRightClick rightClick}.
83789
+ *
83790
+ * If set to `true`, a right-click (context menu) event will be triggered instead of a left-click. This
83791
+ * simulates the native browser right-click behavior by dispatching `mousedown` and `mouseup` with `button:
83792
+ * 2`, followed by a `contextmenu` event. The `xPercentage` and `yPercentage` properties can be used to
83793
+ * specify the position of the right-click event.
83794
+ *
83795
+ * Default value is `false`.
83796
+ *
83797
+ * @since 1.147
83798
+ *
83799
+ * @returns Value of property `rightClick`
83800
+ */
83801
+ getRightClick(): boolean;
83686
83802
  /**
83687
83803
  * Gets current value of property {@link #getShiftKey shiftKey}.
83688
83804
  *
@@ -83785,6 +83901,28 @@ declare namespace sap {
83785
83901
  */
83786
83902
  bKeyUp: boolean
83787
83903
  ): this;
83904
+ /**
83905
+ * Sets a new value for property {@link #getRightClick rightClick}.
83906
+ *
83907
+ * If set to `true`, a right-click (context menu) event will be triggered instead of a left-click. This
83908
+ * simulates the native browser right-click behavior by dispatching `mousedown` and `mouseup` with `button:
83909
+ * 2`, followed by a `contextmenu` event. The `xPercentage` and `yPercentage` properties can be used to
83910
+ * specify the position of the right-click event.
83911
+ *
83912
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
83913
+ *
83914
+ * Default value is `false`.
83915
+ *
83916
+ * @since 1.147
83917
+ *
83918
+ * @returns Reference to `this` in order to allow method chaining
83919
+ */
83920
+ setRightClick(
83921
+ /**
83922
+ * New value for property `rightClick`
83923
+ */
83924
+ bRightClick?: boolean
83925
+ ): this;
83788
83926
  /**
83789
83927
  * Sets a new value for property {@link #getShiftKey shiftKey}.
83790
83928
  *
@@ -87787,6 +87925,27 @@ declare namespace sap {
87787
87925
  * Use when there are multiple views with the same viewName.
87788
87926
  */
87789
87927
  viewId?: string;
87928
+ /**
87929
+ * The namespace to be prepended to the view name defined in the `viewName` parameter. When set, all `waitFor`
87930
+ * calls inside the page object will resolve the view by `viewNamespace + "." + viewName`.
87931
+ *
87932
+ * Example:
87933
+ * ```javascript
87934
+ *
87935
+ * Opa5.createPageObjects({
87936
+ * onMyPage: {
87937
+ * viewName: "myView",
87938
+ * viewNamespace: "my.app.namespace",
87939
+ * assertions: { ... }
87940
+ * }
87941
+ * });
87942
+ * ```
87943
+ *
87944
+ *
87945
+ * Note: If all page objects share the same `viewNamespace`, consider setting it globally via {@link sap.ui.test.Opa5.extendConfig }
87946
+ * to avoid repetition.
87947
+ */
87948
+ viewNamespace?: string;
87790
87949
  /**
87791
87950
  * Base class for the page object's actions and assertions
87792
87951
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
package/types/index.d.ts CHANGED
@@ -17,10 +17,10 @@
17
17
  /// <reference path="./sap.zen.dsh.d.ts"/>
18
18
  /// <reference path="./sap.zen.commons.d.ts"/>
19
19
  /// <reference path="./sap.sac.df.d.ts"/>
20
- /// <reference path="./sap.ui.commons.d.ts"/>
20
+ /// <reference path="./commons-1.147.0-d.ts"/>
21
21
  /// <reference path="./sap.ui.comp.d.ts"/>
22
- /// <reference path="./sap.ui.core.d.ts"/>
23
- /// <reference path="./sap.ui.dt.d.ts"/>
22
+ /// <reference path="./core-1.147.0-d.ts"/>
23
+ /// <reference path="./dt-1.147.0-d.ts"/>
24
24
  /// <reference path="./sap.ui.export.d.ts"/>
25
25
  /// <reference path="./sap.f.d.ts"/>
26
26
  /// <reference path="./sap.ui.fl.d.ts"/>
@@ -33,8 +33,8 @@
33
33
  /// <reference path="./sap.ui.integration.d.ts"/>
34
34
  /// <reference path="./sap.ui.layout.d.ts"/>
35
35
  /// <reference path="./sap.makit.d.ts"/>
36
- /// <reference path="./sap.ui.mdc.d.ts"/>
37
- /// <reference path="./sap.m.d.ts"/>
36
+ /// <reference path="./mdc-1.147.0-d.ts"/>
37
+ /// <reference path="./mobile-1.147.0-d.ts"/>
38
38
  /// <reference path="./sap.me.d.ts"/>
39
39
  /// <reference path="./sap.ndc.d.ts"/>
40
40
  /// <reference path="./sap.ovp.d.ts"/>
@@ -70,15 +70,12 @@
70
70
  /// <reference path="./sap.ui.support.d.ts"/>
71
71
  /// <reference path="./sap.ui.table.d.ts"/>
72
72
  /// <reference path="./sap.ui.testrecorder.d.ts"/>
73
- /// <reference path="./sap.tnt.d.ts"/>
73
+ /// <reference path="./tnt-1.147.0-d.ts"/>
74
74
  /// <reference path="./sap.ca.ui.d.ts"/>
75
75
  /// <reference path="./sap.ui.unified.d.ts"/>
76
76
  /// <reference path="./sap.ushell.d.ts"/>
77
77
  /// <reference path="./sap.ushell_abap.d.ts"/>
78
- /// <reference path="./sap.ui.ux3.d.ts"/>
78
+ /// <reference path="./ux3-1.147.0-d.ts"/>
79
79
  /// <reference path="./sap.uxap.d.ts"/>
80
80
  /// <reference path="./sap.ui.vbm.d.ts"/>
81
81
  /// <reference path="./sap.viz.d.ts"/>
82
- /// <reference path="./sap.ui.webc.common.d.ts"/>
83
- /// <reference path="./sap.ui.webc.fiori.d.ts"/>
84
- /// <reference path="./sap.ui.webc.main.d.ts"/>
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/mdc/AggregationBaseDelegate" {
4
4
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -9880,8 +9880,10 @@ declare namespace sap {
9880
9880
  interface $FilterBarBaseSettings extends sap.ui.mdc.$ControlSettings {
9881
9881
  /**
9882
9882
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
9883
- * The object has the following properties:
9884
- * - `name` defines the path to the `Delegate` module
9883
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
9884
+ *
9885
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate}.
9886
+ *
9885
9887
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
9886
9888
  * Sample delegate object:
9887
9889
  * ```javascript
@@ -9952,8 +9954,8 @@ declare namespace sap {
9952
9954
  * aggregation) should be specified here, rather than in the `FilterField` configuration.
9953
9955
  * **Note**: This property must not be bound.
9954
9956
  * **Node**: Please check {@link sap.ui.mdc.filterbar.PropertyInfo} for more information about the supported
9955
- * inner elements. **Note**: Existing properties (set via `sap.ui.mdc.filterbar.FilterBarBase#setPropertyInfo`)
9956
- * must not be removed and their attributes must not be changed during the {@link module:sap/ui/mdc/FilterBarDelegate.fetchProperties fetchProperties }
9957
+ * inner elements. **Note**: Existing properties (set via {@link #setPropertyInfo setPropertyInfo}) must
9958
+ * not be removed and their attributes must not be changed during the {@link module:sap/ui/mdc/FilterBarDelegate.fetchProperties fetchProperties }
9957
9959
  * callback. Otherwise validation errors might occur whenever personalization-related control features (such
9958
9960
  * as the opening of any personalization dialog) are activated.
9959
9961
  *
@@ -10149,6 +10151,28 @@ declare namespace sap {
10149
10151
  */
10150
10152
  oInvisibleText: sap.ui.core.InvisibleText
10151
10153
  ): void;
10154
+ /**
10155
+ * Adds a message to the {@link sap.ui.model.message.MessageModel MessageModel} for a `propertyKey`. The
10156
+ * message is displayed on the corresponding {@link sap.ui.mdc.FilterField FilterField}.
10157
+ *
10158
+ * @since 1.147
10159
+ *
10160
+ * @returns The created message object
10161
+ */
10162
+ addMessage(
10163
+ /**
10164
+ * The `propertyKey` of the {@link sap.ui.mdc.FilterField FilterField}
10165
+ */
10166
+ sPropertyKey: string,
10167
+ /**
10168
+ * The message text
10169
+ */
10170
+ sMessage: string,
10171
+ /**
10172
+ * The message type
10173
+ */
10174
+ sMessageType: sap.ui.core.MessageType
10175
+ ): sap.ui.core.message.Message;
10152
10176
  /**
10153
10177
  * Attaches event handler `fnFunction` to the {@link #event:filtersChanged filtersChanged} event of this
10154
10178
  * `sap.ui.mdc.filterbar.FilterBarBase`.
@@ -10395,8 +10419,10 @@ declare namespace sap {
10395
10419
  * Gets current value of property {@link #getDelegate delegate}.
10396
10420
  *
10397
10421
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
10398
- * The object has the following properties:
10399
- * - `name` defines the path to the `Delegate` module
10422
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
10423
+ *
10424
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate}.
10425
+ *
10400
10426
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
10401
10427
  * Sample delegate object:
10402
10428
  * ```javascript
@@ -10454,6 +10480,19 @@ declare namespace sap {
10454
10480
  * @returns Value of property `liveMode`
10455
10481
  */
10456
10482
  getLiveMode(): boolean;
10483
+ /**
10484
+ * Returns all messages associated with the given `propertyKey` from the {@link sap.ui.model.message.MessageModel MessageModel}.
10485
+ *
10486
+ * @since 1.147
10487
+ *
10488
+ * @returns Array of messages for the given `propertyKey`
10489
+ */
10490
+ getMessages(
10491
+ /**
10492
+ * The `propertyKey` of the {@link sap.ui.mdc.FilterField FilterField}
10493
+ */
10494
+ sPropertyKey: string
10495
+ ): sap.ui.core.message.Message[];
10457
10496
  /**
10458
10497
  * Gets the value of the basic search condition.
10459
10498
  *
@@ -10531,6 +10570,30 @@ declare namespace sap {
10531
10570
  * @returns Resolves after the initial filters have been applied and the metadata has been obtained
10532
10571
  */
10533
10572
  initializedWithMetadata(): Promise<any>;
10573
+ /**
10574
+ * Removes a given message from the {@link sap.ui.model.message.MessageModel MessageModel}. The message
10575
+ * is removed from the corresponding {@link sap.ui.mdc.FilterField FilterField}.
10576
+ *
10577
+ * @since 1.147
10578
+ */
10579
+ removeMessage(
10580
+ /**
10581
+ * The message to remove
10582
+ */
10583
+ oMessage: sap.ui.core.Message
10584
+ ): void;
10585
+ /**
10586
+ * Removes all messages for the given `propertyKey` from the {@link sap.ui.model.message.MessageModel MessageModel}.
10587
+ * Clears the messages from the corresponding {@link sap.ui.mdc.FilterField FilterField}.
10588
+ *
10589
+ * @since 1.147
10590
+ */
10591
+ removeMessages(
10592
+ /**
10593
+ * The `propertyKey` of the {@link sap.ui.mdc.FilterField FilterField}
10594
+ */
10595
+ sPropertyKey: string
10596
+ ): void;
10534
10597
  /**
10535
10598
  * Sets the aggregated {@link #getBasicSearchField basicSearchField}.
10536
10599
  *
@@ -10547,8 +10610,10 @@ declare namespace sap {
10547
10610
  * Sets a new value for property {@link #getDelegate delegate}.
10548
10611
  *
10549
10612
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
10550
- * The object has the following properties:
10551
- * - `name` defines the path to the `Delegate` module
10613
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
10614
+ *
10615
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate}.
10616
+ *
10552
10617
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
10553
10618
  * Sample delegate object:
10554
10619
  * ```javascript
@@ -19744,8 +19809,10 @@ declare namespace sap {
19744
19809
 
19745
19810
  /**
19746
19811
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
19747
- * The object has the following properties:
19748
- * - `name` defines the path to the `Delegate` module
19812
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
19813
+ *
19814
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ChartDelegate ChartDelegate}.
19815
+ *
19749
19816
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
19750
19817
  * Sample delegate object:
19751
19818
  * ```javascript
@@ -20020,7 +20087,8 @@ declare namespace sap {
20020
20087
  interface $ControlSettings extends sap.ui.core.$ControlSettings {
20021
20088
  /**
20022
20089
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
20023
- * The object has the following properties:
20090
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
20091
+ *
20024
20092
  * - `name` defines the path to the `Delegate` module
20025
20093
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
20026
20094
  * Sample delegate object:
@@ -20045,7 +20113,8 @@ declare namespace sap {
20045
20113
  interface $ElementSettings extends sap.ui.core.$ElementSettings {
20046
20114
  /**
20047
20115
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
20048
- * The object has the following properties:
20116
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
20117
+ *
20049
20118
  * - `name` defines the path to the `Delegate` module
20050
20119
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
20051
20120
  * Sample delegate object:
@@ -20476,7 +20545,8 @@ declare namespace sap {
20476
20545
  /**
20477
20546
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
20478
20547
  *
20479
- * The object has the following properties:
20548
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
20549
+ *
20480
20550
  * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
20481
20551
  *
20482
20552
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
@@ -21609,8 +21679,10 @@ declare namespace sap {
21609
21679
  * Gets current value of property {@link #getDelegate delegate}.
21610
21680
  *
21611
21681
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
21612
- * The object has the following properties:
21613
- * - `name` defines the path to the `Delegate` module
21682
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
21683
+ *
21684
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ChartDelegate ChartDelegate}.
21685
+ *
21614
21686
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
21615
21687
  * Sample delegate object:
21616
21688
  * ```javascript
@@ -21942,8 +22014,10 @@ declare namespace sap {
21942
22014
  * Sets a new value for property {@link #getDelegate delegate}.
21943
22015
  *
21944
22016
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
21945
- * The object has the following properties:
21946
- * - `name` defines the path to the `Delegate` module
22017
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
22018
+ *
22019
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ChartDelegate ChartDelegate}.
22020
+ *
21947
22021
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
21948
22022
  * Sample delegate object:
21949
22023
  * ```javascript
@@ -25677,7 +25751,8 @@ declare namespace sap {
25677
25751
  *
25678
25752
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
25679
25753
  *
25680
- * The object has the following properties:
25754
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
25755
+ *
25681
25756
  * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
25682
25757
  *
25683
25758
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
@@ -26238,7 +26313,8 @@ declare namespace sap {
26238
26313
  *
26239
26314
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
26240
26315
  *
26241
- * The object has the following properties:
26316
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
26317
+ *
26242
26318
  * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
26243
26319
  *
26244
26320
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
@@ -27178,6 +27254,17 @@ declare namespace sap {
27178
27254
  ): this;
27179
27255
  }
27180
27256
 
27257
+ type DelegateConfig = {
27258
+ /**
27259
+ * Delegate module path
27260
+ */
27261
+ name: string;
27262
+ /**
27263
+ * defines application-specific information that can be used in the given delegate
27264
+ */
27265
+ payload?: any;
27266
+ };
27267
+
27181
27268
  /**
27182
27269
  * Acts a subset of the `FilterBarDelegate` that can be used in {@link module:sap/ui/mdc/TableDelegate.getFilterDelegate TableDelegate.getFilterDelegate }
27183
27270
  * or {@link module:sap/ui/mdc/ChartDelegate.getFilterDelegate Chart.getFilterDelegate} to enable inbuilt