@sapui5/ts-types 1.112.3 → 1.113.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.112.0
+// For Library Version: 1.113.0
 
 declare namespace sap {
   namespace esh {
@@ -247,6 +247,112 @@ declare namespace sap {
             | sap.ui.base.ManagedObject.PropertyBindingInfo
             | `{${string}}`;
 
+          /**
+           * @SINCE 1.113.0
+           *
+           * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
+           * initial state of the facet panel. When not setting facetVisibility the initial state of the facet panel
+           * typically is taken from the user personalization storage.
+           */
+          facetVisibility?:
+            | boolean
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          /**
+           * @SINCE 1.113.0
+           *
+           * A boolean for enabling (business) object suggestions.
+           */
+          boSuggestions?:
+            | boolean
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          /**
+           * @SINCE 1.113.0
+           *
+           * When set to true the facet panel is displayed also in case there are no search results.
+           */
+          displayFacetPanelInCaseOfNoResults?:
+            | boolean
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          /**
+           * @SINCE 1.113.0
+           *
+           * A boolean indicating that the search state is written to the URL.
+           */
+          updateUrl?:
+            | boolean
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          /**
+           * @SINCE 1.113.0
+           *
+           * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
+           * the URL string. Typically you need to register this callback in case updateUrl=true.
+           */
+          renderSearchUrl?:
+            | Function
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          /**
+           * @SINCE 1.113.0
+           *
+           * A callback for checking whether a URL is a search URL. The callback receives a URL and returns true in
+           * case the URL is a search URL. Typically you need to register this callback in case updateUrl=true.
+           */
+          isSearchUrl?:
+            | Function
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          /**
+           * @SINCE 1.113.0
+           *
+           * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
+           * parameters. This is an optional callback. Also in case you set updateUrl=true typcically this callback
+           * is not needed.
+           */
+          parseSearchUrlParameters?:
+            | Function
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          /**
+           * @SINCE 1.113.0
+           *
+           * A list of datasources to be displayed in the facet panel in the collection area.
+           */
+          quickSelectDataSources?:
+            | object
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          /**
+           * @SINCE 1.113.0
+           *
+           * A callback which is called whenever the selection of result list items changes.
+           */
+          selectionChange?:
+            | Function
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          /**
+           * @SINCE 1.113.0
+           *
+           * A callback which is called after the initialization of the search composite control.
+           */
+          initAsync?:
+            | Function
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
           /**
            * Control instances which are part of this composite control.
            */
@@ -488,6 +594,8 @@ declare namespace sap {
             oListener?: object
           ): this;
           /**
+           * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+           *
            * Fires event {@link #event:searchFinished searchFinished} to attached listeners.
            *
            * @returns Reference to `this` in order to allow method chaining
@@ -499,6 +607,8 @@ declare namespace sap {
             mParameters?: object
           ): this;
           /**
+           * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+           *
            * Fires event {@link #event:searchStarted searchStarted} to attached listeners.
            *
            * @returns Reference to `this` in order to allow method chaining
@@ -534,6 +644,18 @@ declare namespace sap {
            * @returns Value of property `autoAdjustResultViewTypeInFolderMode`
            */
           getAutoAdjustResultViewTypeInFolderMode(): boolean;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Gets current value of property {@link #getBoSuggestions boSuggestions}.
+           *
+           * A boolean for enabling (business) object suggestions.
+           *
+           * Default value is `false`.
+           *
+           * @returns Value of property `boSuggestions`
+           */
+          getBoSuggestions(): boolean;
           /**
            * Gets content of aggregation {@link #getContent content}.
            *
@@ -571,6 +693,18 @@ declare namespace sap {
            * @returns Value of property `defaultDataSource`
            */
           getDefaultDataSource(): string;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Gets current value of property {@link #getDisplayFacetPanelInCaseOfNoResults displayFacetPanelInCaseOfNoResults}.
+           *
+           * When set to true the facet panel is displayed also in case there are no search results.
+           *
+           * Default value is `false`.
+           *
+           * @returns Value of property `displayFacetPanelInCaseOfNoResults`
+           */
+          getDisplayFacetPanelInCaseOfNoResults(): boolean;
           /**
            * @SINCE 1.107.0
            *
@@ -609,6 +743,18 @@ declare namespace sap {
            * @returns Value of property `facetPanelWidthInPercent`
            */
           getFacetPanelWidthInPercent(): float;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Gets current value of property {@link #getFacetVisibility facetVisibility}.
+           *
+           * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
+           * initial state of the facet panel. When not setting facetVisibility the initial state of the facet panel
+           * typically is taken from the user personalization storage.
+           *
+           * @returns Value of property `facetVisibility`
+           */
+          getFacetVisibility(): boolean;
           /**
            * @SINCE 1.112.0
            *
@@ -666,6 +812,27 @@ declare namespace sap {
            * @returns Value of property `getCustomNoResultScreen`
            */
           getGetCustomNoResultScreen(): Function;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Gets current value of property {@link #getInitAsync initAsync}.
+           *
+           * A callback which is called after the initialization of the search composite control.
+           *
+           * @returns Value of property `initAsync`
+           */
+          getInitAsync(): Function;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Gets current value of property {@link #getIsSearchUrl isSearchUrl}.
+           *
+           * A callback for checking whether a URL is a search URL. The callback receives a URL and returns true in
+           * case the URL is a search URL. Typically you need to register this callback in case updateUrl=true.
+           *
+           * @returns Value of property `isSearchUrl`
+           */
+          getIsSearchUrl(): Function;
           /**
            * @SINCE 1.111.0
            *
@@ -687,6 +854,39 @@ declare namespace sap {
            * @returns Value of property `overwriteBrowserTitle`
            */
           getOverwriteBrowserTitle(): boolean;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Gets current value of property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
+           *
+           * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
+           * parameters. This is an optional callback. Also in case you set updateUrl=true typcically this callback
+           * is not needed.
+           *
+           * @returns Value of property `parseSearchUrlParameters`
+           */
+          getParseSearchUrlParameters(): Function;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Gets current value of property {@link #getQuickSelectDataSources quickSelectDataSources}.
+           *
+           * A list of datasources to be displayed in the facet panel in the collection area.
+           *
+           * @returns Value of property `quickSelectDataSources`
+           */
+          getQuickSelectDataSources(): object;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Gets current value of property {@link #getRenderSearchUrl renderSearchUrl}.
+           *
+           * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
+           * the URL string. Typically you need to register this callback in case updateUrl=true.
+           *
+           * @returns Value of property `renderSearchUrl`
+           */
+          getRenderSearchUrl(): Function;
           /**
            * @SINCE 1.100.0
            *
@@ -766,6 +966,16 @@ declare namespace sap {
            * @returns Value of property `searchTerm`
            */
           getSearchTerm(): string;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Gets current value of property {@link #getSelectionChange selectionChange}.
+           *
+           * A callback which is called whenever the selection of result list items changes.
+           *
+           * @returns Value of property `selectionChange`
+           */
+          getSelectionChange(): Function;
           /**
            * @SINCE 1.93.0
            *
@@ -788,6 +998,18 @@ declare namespace sap {
            * @returns Value of property `tabStripsFormatter`
            */
           getTabStripsFormatter(): Function;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Gets current value of property {@link #getUpdateUrl updateUrl}.
+           *
+           * A boolean indicating that the search state is written to the URL.
+           *
+           * Default value is `true`.
+           *
+           * @returns Value of property `updateUrl`
+           */
+          getUpdateUrl(): boolean;
           /**
            * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
            * its index if found or -1 otherwise.
@@ -875,6 +1097,25 @@ declare namespace sap {
              */
             bAutoAdjustResultViewTypeInFolderMode?: boolean
           ): this;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Sets a new value for property {@link #getBoSuggestions boSuggestions}.
+           *
+           * A boolean for enabling (business) object suggestions.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `false`.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setBoSuggestions(
+            /**
+             * New value for property `boSuggestions`
+             */
+            bBoSuggestions?: boolean
+          ): this;
           /**
            * @SINCE 1.93.0
            *
@@ -927,6 +1168,25 @@ declare namespace sap {
              */
             sDefaultDataSource: string
           ): this;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Sets a new value for property {@link #getDisplayFacetPanelInCaseOfNoResults displayFacetPanelInCaseOfNoResults}.
+           *
+           * When set to true the facet panel is displayed also in case there are no search results.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `false`.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setDisplayFacetPanelInCaseOfNoResults(
+            /**
+             * New value for property `displayFacetPanelInCaseOfNoResults`
+             */
+            bDisplayFacetPanelInCaseOfNoResults?: boolean
+          ): this;
           /**
            * @SINCE 1.107.0
            *
@@ -986,6 +1246,25 @@ declare namespace sap {
              */
             fFacetPanelWidthInPercent?: float
           ): this;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Sets a new value for property {@link #getFacetVisibility facetVisibility}.
+           *
+           * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
+           * initial state of the facet panel. When not setting facetVisibility the initial state of the facet panel
+           * typically is taken from the user personalization storage.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setFacetVisibility(
+            /**
+             * New value for property `facetVisibility`
+             */
+            bFacetVisibility: boolean
+          ): this;
           /**
            * @SINCE 1.112.0
            *
@@ -1069,6 +1348,41 @@ declare namespace sap {
              */
             fnGetCustomNoResultScreen: Function
           ): this;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Sets a new value for property {@link #getInitAsync initAsync}.
+           *
+           * A callback which is called after the initialization of the search composite control.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setInitAsync(
+            /**
+             * New value for property `initAsync`
+             */
+            fnInitAsync: Function
+          ): this;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Sets a new value for property {@link #getIsSearchUrl isSearchUrl}.
+           *
+           * A callback for checking whether a URL is a search URL. The callback receives a URL and returns true in
+           * case the URL is a search URL. Typically you need to register this callback in case updateUrl=true.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setIsSearchUrl(
+            /**
+             * New value for property `isSearchUrl`
+             */
+            fnIsSearchUrl: Function
+          ): this;
           /**
            * @SINCE 1.111.0
            *
@@ -1104,6 +1418,60 @@ declare namespace sap {
              */
             bOverwriteBrowserTitle: boolean
           ): this;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Sets a new value for property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
+           *
+           * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
+           * parameters. This is an optional callback. Also in case you set updateUrl=true typcically this callback
+           * is not needed.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setParseSearchUrlParameters(
+            /**
+             * New value for property `parseSearchUrlParameters`
+             */
+            fnParseSearchUrlParameters: Function
+          ): this;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Sets a new value for property {@link #getQuickSelectDataSources quickSelectDataSources}.
+           *
+           * A list of datasources to be displayed in the facet panel in the collection area.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setQuickSelectDataSources(
+            /**
+             * New value for property `quickSelectDataSources`
+             */
+            oQuickSelectDataSources: object
+          ): this;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Sets a new value for property {@link #getRenderSearchUrl renderSearchUrl}.
+           *
+           * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
+           * the URL string. Typically you need to register this callback in case updateUrl=true.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setRenderSearchUrl(
+            /**
+             * New value for property `renderSearchUrl`
+             */
+            fnRenderSearchUrl: Function
+          ): this;
           /**
            * @SINCE 1.100.0
            *
@@ -1218,6 +1586,23 @@ declare namespace sap {
              */
             sSearchTerm?: string
           ): this;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Sets a new value for property {@link #getSelectionChange selectionChange}.
+           *
+           * A callback which is called whenever the selection of result list items changes.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setSelectionChange(
+            /**
+             * New value for property `selectionChange`
+             */
+            fnSelectionChange: Function
+          ): this;
           /**
            * @SINCE 1.93.0
            *
@@ -1254,6 +1639,25 @@ declare namespace sap {
              */
             fnTabStripsFormatter: Function
           ): this;
+          /**
+           * @SINCE 1.113.0
+           *
+           * Sets a new value for property {@link #getUpdateUrl updateUrl}.
+           *
+           * A boolean indicating that the search state is written to the URL.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `true`.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setUpdateUrl(
+            /**
+             * New value for property `updateUrl`
+             */
+            bUpdateUrl?: boolean
+          ): this;
         }
       }
     }