@sapui5/ts-types 1.149.0 → 1.150.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/ts-types",
-  "version": "1.149.0",
+  "version": "1.150.0",
   "description": "SAPUI5 TypeScript Definitions",
   "homepage": "https://ui5.sap.com",
   "author": "SAP SE (https://www.sap.com)",

package/types/sap.apf.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.149.0
+// For Library Version: 1.150.0
 
 declare namespace sap {
   /**

package/types/sap.ca.ui.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.149.0
+// For Library Version: 1.150.0
 
 declare namespace sap {
   namespace ca {

package/types/sap.chart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.149.0
+// For Library Version: 1.150.0
 
 declare namespace sap {
   /**

package/types/sap.collaboration.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.149.0
+// For Library Version: 1.150.0
 
 declare namespace sap {
   /**

package/types/sap.esh.search.ui.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.149.1
+// For Library Version: 1.150.1
 
 declare namespace sap {
   namespace esh {
@@ -184,7 +184,11 @@ declare namespace sap {
            *
            * @since 1.93.0
            */
-          class SearchLink extends sap.m.Link {
+          class SearchLink
+            extends sap.m.Link
+            implements sap.m.IOverflowToolbarContent
+          {
+            __implements__sap_m_IOverflowToolbarContent: boolean;
             /**
              * Constructs a new `SearchText` to display an attribute (with navigation) on custom grid control tiles.
              * See:
@@ -2223,13 +2227,11 @@ declare namespace sap {
            */
           getConfig(): object;
           /**
-           * Gets current value of property {@link #getCssClass cssClass}.
+           * Gets the additional CSS class which was applied to this control
            *
-           * An additional CSS class to add to this control
-           *
-           * @since 1.93.0
+           * @since 1.98.0
            *
-           * @returns Value of property `cssClass`
+           * @returns The additional CSS class which was applied to this control
            */
           getCssClass(): string;
           /**
@@ -2257,13 +2259,11 @@ declare namespace sap {
            */
           getCustomGridView(): Function;
           /**
-           * Gets current value of property {@link #getDataSource dataSource}.
-           *
-           * The id of the data source in which it will search right after initialization.
+           * Gets the id of the active data source which is selected in the data source drop down list.
            *
            * @since 1.98.0
            *
-           * @returns Value of property `dataSource`
+           * @returns The id of currently selected data source.
            */
           getDataSource(): string;
           /**
@@ -2438,17 +2438,11 @@ declare namespace sap {
            */
           getFilterDataSources(): Function;
           /**
-           * Gets current value of property {@link #getFilterRootCondition filterRootCondition}.
-           *
-           * Defines the filter root condition of a filter tree which shall be applied to the search request. This
-           * control only allows filter trees which have a the following structure: complex condition (root level)
-           * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
-           * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
-           * for a more in-depth example.
+           * Gets the filter root condition which contains all attribute filters currently set.
            *
            * @since 1.98.0
            *
-           * @returns Value of property `filterRootCondition`
+           * @returns The filter root condition
            */
           getFilterRootCondition(): object;
           /**
@@ -2627,6 +2621,16 @@ declare namespace sap {
            * @returns Value of property `parseSearchUrlParameters`
            */
           getParseSearchUrlParameters(): Function;
+          /**
+           * Get the public part of the search model (JSON) In general the model is read-only but a few properties
+           * can be modified. Modifiable properties (i.e. consumtion via two-way binding): - 'results[i].data.selected'
+           * For binding use model 'publicSearchModel' (i.e. "publicSearchModel>results/...")
+           *
+           * @since 1.122.0
+           *
+           * @returns A JSON model containing public artefacts of internal search model
+           */
+          getPublicSearchModel(): object;
           /**
            * Gets current value of property {@link #getQuickSelectDataSources quickSelectDataSources}.
            *
@@ -2649,92 +2653,49 @@ declare namespace sap {
            */
           getRenderSearchUrl(): Function;
           /**
-           * Gets current value of property {@link #getResultviewMasterDetailMode resultviewMasterDetailMode}.
-           *
-           * The result views are displayed in a master-detail mode. The event showResultDetail is fired whenever
-           * the detail button/indicator is clicked.
-           *
-           * Default value is `false`.
+           * Get activation status of master detail mode
            *
-           * @since 1.140.0
+           * @since 1.141.0
            *
-           * @returns Value of property `resultviewMasterDetailMode`
+           * @returns The activation status of master detail mode
            */
           getResultviewMasterDetailMode(): boolean;
           /**
-           * Gets current value of property {@link #getResultviewSelectionMode resultviewSelectionMode}.
-           *
-           * To select result view items, enable multi-selection or single-selection mode. Shows checkboxes ('MultipleItems')
-           * or enables item press ('OneItem'). Values of configuration parameter `resultviewSelectionMode` are 'None',
-           * 'OneItem' and 'MultipleItems'. To show a button for switching selection mode on/off, see 'showSelectionToggleButton'.
-           * A checkbox is provided for each result item if the value is true. The setting is related to `resultviewMasterDetailMode`
-           * (master-detail mode). The event `showResultDetail` is fired whenever the detail button is clicked.
-           *
-           * Default value is `"None"`.
+           * Get result view selection mode ('None', 'OneItem', 'MultipleItems')
            *
            * @since 1.141.0
            *
-           * @returns Value of property `resultviewSelectionMode`
+           * @returns The result view selection mode
            */
           getResultviewSelectionMode(): string;
           /**
-           * Gets current value of property {@link #getResultViewSettings resultViewSettings}.
-           *
-           * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
-           * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
-           * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
-           * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
-           * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
-           * and `resultViewType` must be compatible to each other.
-           *
-           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
-           *
-           * Default value is `...see text or source`.
+           * Gets search result view type settings
            *
            * @since 1.100.0
            *
-           * @returns Value of property `resultViewSettings`
+           * @returns The object of resultViewTypes and resultViewType.
            */
-          getResultViewSettings(): string;
+          getResultViewSettings(): object;
           /**
-           * Gets current value of property {@link #getResultViewType resultViewType}.
-           *
-           * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
-           * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
-           * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
-           * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
-           * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
-           * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
-           * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
-           * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
-           *
-           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
-           *
-           * Default value is `"searchResultList"`.
+           * Gets search result view type
            *
            * @since 1.98.0
            *
-           * @returns Value of property `resultViewType`
+           * @returns The active search result view type.
            */
-          getResultViewType(): string;
+          getResultViewType():
+            | "appSearchResult"
+            | "searchResultList"
+            | "searchResultTable"
+            | "searchResultGrid"
+            | ""
+            | string;
           /**
-           * Gets current value of property {@link #getResultViewTypes resultViewTypes}.
-           *
-           * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
-           * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
-           * not switchable. Case 2: Search in All or other Category: result is switchable between different view
-           * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
-           * Search in Business Object: result is switchable between different view types. Possible values for the
-           * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
-           * of `resultViewTypes` and `resultViewType` must be compatible to each other.
-           *
-           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
-           *
-           * Default value is `["searchResultList", "searchResultTable"]`.
+           * Gets search result view types
            *
            * @since 1.98.0
            *
-           * @returns Value of property `resultViewTypes`
+           * @returns The array of active search result view types.
            */
           getResultViewTypes(): string[];
           /**
@@ -2782,6 +2743,14 @@ declare namespace sap {
            * @returns Value of property `searchOnStart`
            */
           getSearchOnStart(): boolean;
+          /**
+           * Gets the set of result items
+           *
+           * @since 1.114.0
+           *
+           * @returns The result set containg 'items'.
+           */
+          getSearchResultSet(): object;
           /**
            * Gets current value of property {@link #getSearchResultTableMaxNumberOfInitiallyVisibleColumns searchResultTableMaxNumberOfInitiallyVisibleColumns}.
            *
@@ -2796,15 +2765,11 @@ declare namespace sap {
            */
           getSearchResultTableMaxNumberOfInitiallyVisibleColumns(): float;
           /**
-           * Gets current value of property {@link #getSearchTerm searchTerm}.
-           *
-           * Defines the initial search term for the search input.
-           *
-           * Default value is `empty string`.
+           * Gets the search term which is displayed in the search box.
            *
-           * @since 1.93.0
+           * @since 1.98.0
            *
-           * @returns Value of property `searchTerm`
+           * @returns The search term
            */
           getSearchTerm(): string;
           /**
@@ -2893,6 +2858,48 @@ declare namespace sap {
            * @since 1.124.0
            */
           invalidateSearchResultCache(): Promise<void>;
+          /**
+           * Parse the browser URL, update properties and trigger search call (if needed)
+           *
+           * @since 1.122.0
+           *
+           * @returns this
+           */
+          parseURL(): undefined;
+          /**
+           * Recalculate the placeholder text of search input field. If implemented, this will also call function
+           * 'getSearchInputPlaceholderLabel' to get the label for the placeholder text.
+           *
+           * @since 1.136.0
+           *
+           * @returns void
+           */
+          recalculateSearchInputPlaceholder(): undefined;
+          /**
+           * Assembles a search URL.
+           *
+           * Use this method for the creation of links to the search UI.
+           *
+           * @since 1.103.0
+           * @deprecated As of version 1.120.0. use {@link sap.esh.search.ui.SearchCompositeControl#createSearchNavigationTarget createSearchNavigationTarget }
+           * instead.
+           *
+           * @returns search URL.
+           */
+          renderSearchUrlFromParameters(
+            /**
+             * Number of search results to be displayed.
+             */
+            top: number,
+            /**
+             * A sina filter object storing the searchterm, datasource and the filter conditions.
+             */
+            filter: object,
+            /**
+             * A boolean whether to encode the URL parameters or not.
+             */
+            encodeFilter: boolean
+          ): string;
           /**
            * Resets the active data source which is selected in the data source drop down list to its default (see
            * 'defaultDataSource'/'exclusiveDataSource').
@@ -3300,22 +3307,18 @@ declare namespace sap {
             bBoSuggestions?: boolean
           ): this;
           /**
-           * Sets a new value for property {@link #getCssClass cssClass}.
+           * Adds an additional CSS class to this control
            *
-           * An additional CSS class to add to this control
-           *
-           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-           *
-           * @since 1.93.0
+           * @since 1.98.0
            *
-           * @returns Reference to `this` in order to allow method chaining
+           * @returns this
            */
           setCssClass(
             /**
-             * New value for property `cssClass`
+             * The new CSS class
              */
-            sCssClass: string
-          ): this;
+            cssClass: string
+          ): undefined;
           /**
            * Sets a new value for property {@link #getCustomBasket customBasket}.
            *
@@ -3355,22 +3358,24 @@ declare namespace sap {
             fnCustomGridView: Function
           ): this;
           /**
-           * Sets a new value for property {@link #getDataSource dataSource}.
-           *
-           * The id of the data source in which it will search right after initialization.
-           *
-           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           * Sets the id of the active data source which is selected in the data source drop down list.
            *
            * @since 1.98.0
-           *
-           * @returns Reference to `this` in order to allow method chaining
            */
           setDataSource(
             /**
-             * New value for property `dataSource`
+             * The id of the new to be selected data source
              */
-            sDataSource: string
-          ): this;
+            dataSource: string,
+            /**
+             * If true, fires a search query right away. Set to false for batch updates.
+             */
+            fireQuery?: boolean,
+            /**
+             * If true, top will be reset to the default number of visible results.
+             */
+            resetTop?: boolean
+          ): void;
           /**
            * Sets a new value for property {@link #getDefaultDataSource defaultDataSource}.
            *
@@ -3622,26 +3627,28 @@ declare namespace sap {
             fnFilterDataSources: Function
           ): this;
           /**
-           * Sets a new value for property {@link #getFilterRootCondition filterRootCondition}.
+           * Sets the filter root condition for the search query.
            *
-           * Defines the filter root condition of a filter tree which shall be applied to the search request. This
-           * control only allows filter trees which have a the following structure: complex condition (root level)
-           * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
-           * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
-           * for a more in-depth example.
-           *
-           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           * The filter root condition can contain multiple attribute filter which are then combined using AND or
+           * OR operators. For a more comprehensive explanation and examples, see the description of the filterRootCondition
+           * property of this control.
            *
            * @since 1.98.0
            *
-           * @returns Reference to `this` in order to allow method chaining
+           * @returns this
            */
           setFilterRootCondition(
             /**
-             * New value for property `filterRootCondition`
+             * Sets the new filter root condition.
              */
-            oFilterRootCondition: object
-          ): this;
+            filterRootCondition: object,
+            /**
+             * Indicates wether the search query should be sent to the search service or not. Not sending it could be
+             * useful for batch updates, for example if the data source shall also be changed. This way, the search
+             * service will not have to deal with outdated queries which will improve overall performance.
+             */
+            fireQuery?: boolean
+          ): undefined;
           /**
            * Sets a new value for property {@link #getFolderMode folderMode}.
            *
@@ -3942,129 +3949,64 @@ declare namespace sap {
             fnRenderSearchUrl: Function
           ): this;
           /**
-           * Sets a new value for property {@link #getResultviewMasterDetailMode resultviewMasterDetailMode}.
-           *
-           * The result views are displayed in a master-detail mode. The event showResultDetail is fired whenever
-           * the detail button/indicator is clicked.
+           * Set activation status of master detail mode
            *
-           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-           *
-           * Default value is `false`.
-           *
-           * @since 1.140.0
+           * @since 1.141.0
            *
-           * @returns Reference to `this` in order to allow method chaining
+           * @returns this
            */
-          setResultviewMasterDetailMode(
-            /**
-             * New value for property `resultviewMasterDetailMode`
-             */
-            bResultviewMasterDetailMode?: boolean
-          ): this;
+          setResultviewMasterDetailMode(): undefined;
           /**
-           * Sets a new value for property {@link #getResultviewSelectionMode resultviewSelectionMode}.
-           *
-           * To select result view items, enable multi-selection or single-selection mode. Shows checkboxes ('MultipleItems')
-           * or enables item press ('OneItem'). Values of configuration parameter `resultviewSelectionMode` are 'None',
-           * 'OneItem' and 'MultipleItems'. To show a button for switching selection mode on/off, see 'showSelectionToggleButton'.
-           * A checkbox is provided for each result item if the value is true. The setting is related to `resultviewMasterDetailMode`
-           * (master-detail mode). The event `showResultDetail` is fired whenever the detail button is clicked.
-           *
-           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-           *
-           * Default value is `"None"`.
+           * Set result view selection mode ('None', 'OneItem', 'MultipleItems')
            *
            * @since 1.141.0
            *
-           * @returns Reference to `this` in order to allow method chaining
+           * @returns this
            */
-          setResultviewSelectionMode(
-            /**
-             * New value for property `resultviewSelectionMode`
-             */
-            sResultviewSelectionMode?: string
-          ): this;
+          setResultviewSelectionMode(): undefined;
           /**
-           * Sets a new value for property {@link #getResultViewSettings resultViewSettings}.
-           *
-           * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
-           * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
-           * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
-           * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
-           * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
-           * and `resultViewType` must be compatible to each other.
-           *
-           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
-           *
-           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-           *
-           * Default value is `...see text or source`.
+           * Sets search result view type settings
            *
            * @since 1.100.0
            *
-           * @returns Reference to `this` in order to allow method chaining
+           * @returns this
            */
           setResultViewSettings(
             /**
-             * New value for property `resultViewSettings`
+             * The object of resultViewTypes and resultViewType.
              */
-            sResultViewSettings?: string
-          ): this;
+            settings: object
+          ): undefined;
           /**
-           * Sets a new value for property {@link #getResultViewType resultViewType}.
-           *
-           * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
-           * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
-           * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
-           * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
-           * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
-           * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
-           * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
-           * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
-           *
-           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
-           *
-           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-           *
-           * Default value is `"searchResultList"`.
+           * Sets search result view type
            *
            * @since 1.98.0
            *
-           * @returns Reference to `this` in order to allow method chaining
+           * @returns this
            */
           setResultViewType(
             /**
-             * New value for property `resultViewType`
+             * The active search result view type.
              */
-            sResultViewType?: string
-          ): this;
+            resultViewType:
+              | "appSearchResult"
+              | "searchResultList"
+              | "searchResultTable"
+              | "searchResultGrid"
+          ): undefined;
           /**
-           * Sets a new value for property {@link #getResultViewTypes resultViewTypes}.
-           *
-           * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
-           * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
-           * not switchable. Case 2: Search in All or other Category: result is switchable between different view
-           * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
-           * Search in Business Object: result is switchable between different view types. Possible values for the
-           * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
-           * of `resultViewTypes` and `resultViewType` must be compatible to each other.
-           *
-           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
-           *
-           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-           *
-           * Default value is `["searchResultList", "searchResultTable"]`.
+           * Sets search result view types
            *
            * @since 1.98.0
            *
-           * @returns Reference to `this` in order to allow method chaining
+           * @returns this
            */
           setResultViewTypes(
             /**
-             * New value for property `resultViewTypes`
+             * The array of active search result view types.
              */
-            sResultViewTypes?: string[]
-          ): this;
+            resultViewTypes: string[]
+          ): undefined;
           /**
            * Sets a new value for property {@link #getSearchBarTitle searchBarTitle}.
            *
@@ -4143,24 +4085,24 @@ declare namespace sap {
             fSearchResultTableMaxNumberOfInitiallyVisibleColumns?: float
           ): this;
           /**
-           * Sets a new value for property {@link #getSearchTerm searchTerm}.
-           *
-           * Defines the initial search term for the search input.
+           * Sets the search term which is displayed in the search box.
            *
-           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-           *
-           * Default value is `empty string`.
-           *
-           * @since 1.93.0
+           * @since 1.98.0
            *
-           * @returns Reference to `this` in order to allow method chaining
+           * @returns this
            */
           setSearchTerm(
             /**
-             * New value for property `searchTerm`
+             * Sets the new search term
              */
-            sSearchTerm?: string
-          ): this;
+            searchTerm: string,
+            /**
+             * Indicates wether the search query should be sent to the search service or not. Not sending it could be
+             * useful for batch updates, for example if the data source shall also be changed. This way, the search
+             * service will not have to deal with outdated queries which will improve overall performance.
+             */
+            fireQuery?: boolean
+          ): undefined;
           /**
            * Sets a new value for property {@link #getSearchTermLengthLimit searchTermLengthLimit}.
            *