@sapui5/ts-types 1.113.0 → 1.115.0

package/types/sap.fe.navigation.d.ts

@@ -58,7 +58,7 @@ declare namespace sap {
        * If the OData metadata model has not been loaded completely, all properties are removed from the application
        * context.
        *
-       * **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation}
+       * **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation }
        * is available and initialized.
        */
       class NavigationHandler extends sap.ui.base.Object {
@@ -120,7 +120,7 @@ declare namespace sap {
           /**
            * The selection variant in string format as provided by the SmartFilterBar control
            */
-          sSelectionVariant: /* was: sap.fe.navigation.SerializedSelectionVariant */
+          sSelectionVariant: /* was: sap.fe.navigation.SelectionVariant.SerializedSelectionVariant */
             | any
             | string,
           /**
@@ -181,7 +181,7 @@ declare namespace sap {
           /**
            * Object for storing current state of the app
            */
-          oInnerAppData?: /* was: sap.fe.navigation.InnerAppData */ any,
+          oInnerAppData?: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
           /**
            * Callback that is called if an error occurs during navigation
            */
@@ -256,8 +256,7 @@ declare namespace sap {
          *
          * 	 - `oAppData.customData`
          *
-         *          which return the inner app data as stored in {@link #.navigate navigate} or {@link #.storeInnerAppStateAsync
-         * storeInnerAppStateAsync}.
+         *          which return the inner app data as stored in {@link #.navigate navigate} or {@link #.storeInnerAppStateAsync storeInnerAppStateAsync}.
          *          `oAppData.oDefaultedSelectionVariant` is an empty selection variant and
          *          `oAppData.bNavSelVarHasDefaultsOnly` is `false` in this case.
          *
@@ -284,7 +283,7 @@ declare namespace sap {
          * in the URL.
          *
          * 	 - All single selections ("including equal") of the combined selection data are passed to the SmartLink
-         * 			popover as semantic attributes.
+         *     popover as semantic attributes.
          * The method `oTableEventParameters.open()` is called. Note that this does not really open the popover,
          * but the SmartLink
          * control proceeds with firing the event `navigationTargetsObtained`.
@@ -315,7 +314,7 @@ declare namespace sap {
            * Object containing the current state of the app. If provided, opening the Popover is deferred until the
            *        inner app data is saved in a consistent way.
            */
-          mInnerAppData?: /* was: sap.fe.navigation.InnerAppData */ any,
+          mInnerAppData?: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
           /**
            * Object containing the state which will be passed to the target screen.
            */
@@ -379,11 +378,15 @@ declare namespace sap {
           aTechnicalParameters?: any[]
         ): void;
         /**
+         * @deprecated (since 1.104) - Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync }
+         * instead.
+         *
+         *
          * Changes the URL according to the current app state and stores the app state for later retrieval.
          *
          * @returns A Promise object to monitor when all the actions of the function have been executed; if the
          * execution is successful, the
-         *          app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError}
+         *          app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError }
          * is
          *          returned
          */
@@ -391,7 +394,7 @@ declare namespace sap {
           /**
            * Object containing the current state of the app
            */
-          mInnerAppData: /* was: sap.fe.navigation.InnerAppData */ any,
+          mInnerAppData: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
           /**
            * If set to false, the inner app hash will not be replaced until storing is successful; do not
            *        set to false if you cannot react to the resolution of the Promise, for example, when calling the
@@ -404,7 +407,7 @@ declare namespace sap {
          *
          * @returns A Promise object to monitor when all the actions of the function have been executed; if the
          * execution is successful, the
-         *          app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError}
+         *          app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError }
          * is
          *          returned
          */
@@ -412,7 +415,7 @@ declare namespace sap {
           /**
            * Object containing the current state of the app
            */
-          mInnerAppData: /* was: sap.fe.navigation.InnerAppData */ any,
+          mInnerAppData: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
           /**
            * If set to false, the inner app hash will not be replaced until storing is successful; do not
            *        set to false if you cannot react to the resolution of the Promise, for example, when calling the
@@ -426,6 +429,10 @@ declare namespace sap {
           bSkipHashReplace?: boolean
         ): jQuery.Promise<string>;
         /**
+         * @deprecated (since 1.104) - Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync }
+         * instead.
+         *
+         *
          * Changes the URL according to the current app state and stores the app state for later retrieval.
          *
          * @returns An object containing the appStateId and a promise object to monitor when all the actions of
@@ -436,7 +443,7 @@ declare namespace sap {
           /**
            * Object containing the current state of the app
            */
-          mInnerAppData: /* was: sap.fe.navigation.InnerAppData */ any,
+          mInnerAppData: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
           /**
            * If set to false, the inner app hash will not be replaced until storing is successful; do not
            *        set to false if you cannot react to the resolution of the Promise, for example, when calling the
@@ -475,7 +482,7 @@ declare namespace sap {
          *
          * @returns An object containing the properties to be used for the chart visualization.
          */
-        getChartVisualization(): /* was: sap.fe.navigation.Visualization */
+        getChartVisualization(): /* was: sap.fe.navigation.PresentationVariant.Visualization */
           | any
           | undefined;
         /**
@@ -501,7 +508,7 @@ declare namespace sap {
          *
          * @returns An object containing the properties to be used for the table visualization.
          */
-        getTableVisualization(): /* was: sap.fe.navigation.Visualization */
+        getTableVisualization(): /* was: sap.fe.navigation.PresentationVariant.Visualization */
           | any
           | undefined;
         /**
@@ -524,7 +531,7 @@ declare namespace sap {
           /**
            * An object containing the properties to be used for the chart visualization.
            */
-          properties: /* was: sap.fe.navigation.Visualization */ any
+          properties: /* was: sap.fe.navigation.PresentationVariant.Visualization */ any
         ): void;
         /**
          * Sets the context URL.
@@ -560,7 +567,7 @@ declare namespace sap {
           /**
            * An object containing the properties to be used for the table visualization.
            */
-          properties: /* was: sap.fe.navigation.Visualization */ any
+          properties: /* was: sap.fe.navigation.PresentationVariant.Visualization */ any
         ): void;
         /**
          * Sets the text / description of the selection variant.
@@ -576,7 +583,7 @@ declare namespace sap {
          *
          * @returns The external representation of this instance as a JSON object
          */
-        toJSONObject(): /* was: sap.fe.navigation.ExternalPresentationVariant */ any;
+        toJSONObject(): /* was: sap.fe.navigation.PresentationVariant.ExternalPresentationVariant */ any;
         /**
          * Serializes this instance into a JSON-formatted string.
          *
@@ -605,7 +612,7 @@ declare namespace sap {
            * The value of the parameter to be set
            */
           sValue: string
-        ): sap.fe.navigation.SelectionVariant;
+        ): this;
         /**
          * Adds a new range to the list of select options for a given parameter.
          *
@@ -634,7 +641,7 @@ declare namespace sap {
           /**
            * Set only if sOption is **BT**: the upper boundary of the interval;
            */
-          sHigh?: string,
+          sHigh?: null | string,
           /**
            * Text representing the SelectOption. This is an optional parameter. For an example in most Fiori applications
            * if the text is not provided, it is fetched based on the ID.
@@ -644,8 +651,8 @@ declare namespace sap {
           /**
            * Object containing semanticDates filter information
            */
-          semanticDates?: /* was: sap.fe.navigation.SemanticDateConfiguration */ any
-        ): sap.fe.navigation.SelectionVariant;
+          semanticDates?: /* was: sap.fe.navigation.SelectionVariant.SemanticDateConfiguration */ any
+        ): this;
         /**
          * Gets the current context URL intended for the filters.
          *
@@ -778,7 +785,7 @@ declare namespace sap {
            * Set of select options to be added
            */
           aSelectOptions: undefined[]
-        ): sap.fe.navigation.SelectionVariant;
+        ): this;
         /**
          * Removes a parameter called `sName` from the selection variant.
          *
@@ -789,7 +796,7 @@ declare namespace sap {
            * The name of the parameter to be removed
            */
           sName: string
-        ): sap.fe.navigation.SelectionVariant;
+        ): this;
         /**
          * Removes a select option called `sName` from the selection variant.
          *
@@ -800,7 +807,7 @@ declare namespace sap {
            * The name of the select option to be removed
            */
           sName: string
-        ): sap.fe.navigation.SelectionVariant;
+        ): this;
         /**
          * Renames a parameter called `sNameOld` to `sNameNew`. If a parameter or a select option with
          * the name `sNameNew` already exist, an error is thrown. If a parameter with the name `sNameOld`
@@ -817,7 +824,7 @@ declare namespace sap {
            * The new name of the parameter
            */
           sNameNew: string
-        ): sap.fe.navigation.SelectionVariant;
+        ): this;
         /**
          * Renames a select option called `sNameOld` to `sNameNew`. If a select option or a parameter
          * with the name `sNameNew` already exist, an error is thrown. If a select option with the name `sNameOld`
@@ -834,7 +841,7 @@ declare namespace sap {
            * The new name of the select option property
            */
           sNameNew: string
-        ): sap.fe.navigation.SelectionVariant;
+        ): this;
         /**
          * Sets the context URL intended for the filters.
          */
@@ -876,7 +883,7 @@ declare namespace sap {
          *
          * @returns The external representation of this instance as a JSON object
          */
-        toJSONObject(): /* was: sap.fe.navigation.SerializedSelectionVariant */ any;
+        toJSONObject(): /* was: sap.fe.navigation.SelectionVariant.SerializedSelectionVariant */ any;
         /**
          * Serializes this instance into a JSON-formatted string.
          *

package/types/sap.fe.templates.d.ts

@@ -15,19 +15,9 @@ declare namespace sap {
          * SAP Fiori elements. Don't access or manipulate controls, properties, models, or other internal objects
          * created by the SAP Fiori elements framework.
          */
-        class ExtensionAPI
-          /* was: sap.fe.templates.ExtensionAPI */ extends Object {
+        class ExtensionAPI /* was: sap.fe.core.ExtensionAPI */ extends Object {
           constructor();
 
-          /**
-           * Add any control as a dependent control to this SAP Fiori elements page.
-           */
-          addDependent(
-            /**
-             * Control to be added as a dependent control
-             */
-            oControl: sap.ui.core.Control
-          ): void;
           /**
            * This method converts filter conditions to filters.
            *
@@ -39,12 +29,6 @@ declare namespace sap {
              */
             mFilterConditions: any
           ): object;
-          /**
-           * Retrieves the editFlow controller extension for this page.
-           *
-           * @returns The editFlow controller extension
-           */
-          getEditFlow(): /* was: sap.fe.templates.EditFlow */ any;
           /**
            * Provides all the model filters from the filter bar that are currently active
            * along with the search expression.
@@ -52,96 +36,12 @@ declare namespace sap {
            * @returns An array of active filters and the search expression.
            */
           getFilters(): object;
-          /**
-           * Retrieves the intentBasedNavigation controller extension for this page.
-           *
-           * @returns The intentBasedNavigation controller extension
-           */
-          getIntentBasedNavigation(): /* was: sap.fe.templates.IntentBasedNavigation */ any;
-          /**
-           * Get access to models managed by SAP Fiori elements.
-           *
-           * The following models can be accessed:
-           *
-           *
-           * 	 - undefined: the undefined model returns the SAPUI5 OData V4 model bound to this page
-           *
-           * 	 - i18n / further data models defined in the manifest
-           * ui: returns a SAPUI5 JSON model containing UI information.
-           * Only the following properties are public and supported:
-           *
-           *
-           * 	 - isEditable: set to true if the application is in edit mode
-           *
-           *
-           * .
-           * editMode is deprecated and should not be used anymore. Use isEditable instead.
-           *
-           * @returns The required model
-           */
-          getModel(
-            /**
-             * Name of the model
-             */
-            sModelName?: string
-          ): sap.ui.model.Model | undefined;
-          /**
-           * Retrieves the routing controller extension for this page.
-           *
-           * @returns The routing controller extension
-           */
-          getRouting(): /* was: sap.fe.templates.Routing */ any;
           /**
            * Gets the list entries currently selected for the displayed control.
            *
            * @returns Array containing the selected contexts
            */
           getSelectedContexts(): any;
-          /**
-           * Load a fragment and go through the template preprocessor with the current page context.
-           *
-           * @returns The fragment definition
-           */
-          loadFragment(
-            /**
-             * The settings object
-             */
-            mSettings: {
-              /**
-               * The contextPath to be used for the templating process
-               */
-              contextPath: string;
-              /**
-               * The controller to be attached to the fragment
-               */
-              controller: object;
-              /**
-               * The ID of the fragment itself
-               */
-              id: string;
-              /**
-               * The initial binding context
-               */
-              initialBindingContext: sap.ui.model.Context;
-              /**
-               * The name of the fragment to be loaded
-               */
-              name: string;
-            }
-          ): Promise<sap.ui.core.Element | sap.ui.core.Element[]>;
-          /**
-           * Navigate to another target.
-           */
-          navigateToTarget(
-            /**
-             * Name of the target route
-             */
-            sTarget: string,
-            /**
-             * undefined
-             */
-            oContext: sap.ui.model.Context
-          ): void;
           /**
            * Refreshes the List Report.
            * This method currently only supports triggering the search (by clicking on the GO button)
@@ -151,16 +51,7 @@ declare namespace sap {
            *
            * @returns Resolved once the data is refreshed or rejected if the request failed
            */
-          refresh(): any;
-          /**
-           * Remove a dependent control from this SAP Fiori elements page.
-           */
-          removeDependent(
-            /**
-             * Control to be added as a dependent control
-             */
-            oControl: sap.ui.core.Control
-          ): void;
+          refresh(): Promise<void>;
           /**
            * Provide an option for showing a custom message in the message strip above the list report table.
            */
@@ -168,14 +59,14 @@ declare namespace sap {
             /**
              * Custom message along with the message type to be set on the table.
              */
-            message: /* was: sap.fe.templates.LRCustomMessage */
+            message: /* was: sap.fe.templates.ListReport.LRMessageStrip.LRCustomMessage */
               | any
               | undefined,
             /**
              * The tabKey identifying the table where the custom message is displayed. If tabKey is empty, the message
              * is displayed in all tabs . If tabKey = ['1','2'], the message is displayed in tabs 1 and 2 only
              */
-            tabKey?: string | string[],
+            tabKey?: null | string | string[],
             /**
              * A function that is called when the user closes the message bar.
              */
@@ -208,47 +99,20 @@ declare namespace sap {
               | string
               | string[]
           ): Promise<void>;
-          /**
-           * Triggers an update of the app state.
-           * Should be called if the state of a control, or any other state-relevant information, was changed.
-           *
-           * @returns A promise that resolves with the new app state object.
-           */
-          updateAppState(): Promise<object | void>;
         }
         /**
          * Controller class for the list report page, used inside an SAP Fiori elements application.
          */
         class ListReportController
-          /* was: sap.fe.templates.PageController */ extends Object {
+          /* was: sap.fe.core.PageController */ extends Object {
           constructor();
 
-          /**
-           * @SINCE 1.91.0
-           *
-           * Returns the current app component.
-           *
-           * @returns The app component or, if not found, null
-           */
-          getAppComponent(): /* was: sap.fe.templates.AppComponent */ any;
           /**
            * Get the extension API for the current page.
            *
            * @returns The extension API.
            */
-          getExtensionAPI(): /* was: sap.fe.templates.ListReportExtensionAPI */ any;
-          /**
-           * Convenience method provided by SAP Fiori elements to enable applications to include the view model by
-           * name into each controller.
-           *
-           * @returns The model instance
-           */
-          getModel(
-            /**
-             * The model name
-             */
-            sName?: string
-          ): sap.ui.model.Model;
+          getExtensionAPI(): sap.fe.templates.ListReport.ExtensionAPI;
           /**
            * Method called when the 'Clear' button on the FilterBar is pressed.
            */
@@ -293,21 +157,6 @@ declare namespace sap {
              */
             mParameters: any
           ): void;
-          /**
-           * Convenience method for setting the view model in every controller of the application.
-           *
-           * @returns The view instance
-           */
-          setModel(
-            /**
-             * The model instance
-             */
-            oModel: sap.ui.model.Model,
-            /**
-             * The model name
-             */
-            sName: string
-          ): sap.ui.core.mvc.View;
         }
       }
 
@@ -320,70 +169,15 @@ declare namespace sap {
          * SAP Fiori elements. Don't access or manipulate controls, properties, models, or other internal objects
          * created by the SAP Fiori elements framework.
          */
-        class ExtensionAPI
-          /* was: sap.fe.templates.ExtensionAPI */ extends Object {
+        class ExtensionAPI /* was: sap.fe.core.ExtensionAPI */ extends Object {
           constructor();
 
-          /**
-           * Add any control as a dependent control to this SAP Fiori elements page.
-           */
-          addDependent(
-            /**
-             * Control to be added as a dependent control
-             */
-            oControl: sap.ui.core.Control
-          ): void;
           /**
            * Gets the bound context of the current object page.
            *
            * @returns Context bound to the object page
            */
-          getBindingContext(): sap.ui.model.Context | string | undefined;
-          /**
-           * Retrieves the editFlow controller extension for this page.
-           *
-           * @returns The editFlow controller extension
-           */
-          getEditFlow(): /* was: sap.fe.templates.EditFlow */ any;
-          /**
-           * Retrieves the intentBasedNavigation controller extension for this page.
-           *
-           * @returns The intentBasedNavigation controller extension
-           */
-          getIntentBasedNavigation(): /* was: sap.fe.templates.IntentBasedNavigation */ any;
-          /**
-           * Get access to models managed by SAP Fiori elements.
-           *
-           * The following models can be accessed:
-           *
-           *
-           * 	 - undefined: the undefined model returns the SAPUI5 OData V4 model bound to this page
-           *
-           * 	 - i18n / further data models defined in the manifest
-           * ui: returns a SAPUI5 JSON model containing UI information.
-           * Only the following properties are public and supported:
-           *
-           *
-           * 	 - isEditable: set to true if the application is in edit mode
-           *
-           *
-           * .
-           * editMode is deprecated and should not be used anymore. Use isEditable instead.
-           *
-           * @returns The required model
-           */
-          getModel(
-            /**
-             * Name of the model
-             */
-            sModelName?: string
-          ): sap.ui.model.Model | undefined;
-          /**
-           * Retrieves the routing controller extension for this page.
-           *
-           * @returns The routing controller extension
-           */
-          getRouting(): /* was: sap.fe.templates.Routing */ any;
+          getBindingContext(): null | sap.ui.model.Context | undefined;
           /**
            * Gets the list entries currently selected for the table.
            *
@@ -399,51 +193,6 @@ declare namespace sap {
            * Hides the message strip below the anchor bar.
            */
           hideMessage(): void;
-          /**
-           * Load a fragment and go through the template preprocessor with the current page context.
-           *
-           * @returns The fragment definition
-           */
-          loadFragment(
-            /**
-             * The settings object
-             */
-            mSettings: {
-              /**
-               * The contextPath to be used for the templating process
-               */
-              contextPath: string;
-              /**
-               * The controller to be attached to the fragment
-               */
-              controller: object;
-              /**
-               * The ID of the fragment itself
-               */
-              id: string;
-              /**
-               * The initial binding context
-               */
-              initialBindingContext: sap.ui.model.Context;
-              /**
-               * The name of the fragment to be loaded
-               */
-              name: string;
-            }
-          ): Promise<sap.ui.core.Element | sap.ui.core.Element[]>;
-          /**
-           * Navigate to another target.
-           */
-          navigateToTarget(
-            /**
-             * Name of the target route
-             */
-            sTarget: string,
-            /**
-             * undefined
-             */
-            oContext: sap.ui.model.Context
-          ): void;
           /**
            * Refreshes either the whole object page or only parts of it.
            *
@@ -455,15 +204,6 @@ declare namespace sap {
              */
             vPath: string | string[] | undefined
           ): Promise<void>;
-          /**
-           * Remove a dependent control from this SAP Fiori elements page.
-           */
-          removeDependent(
-            /**
-             * Control to be added as a dependent control
-             */
-            oControl: sap.ui.core.Control
-          ): void;
           /**
            * Displays the message strip between the title and the header of the ObjectPage.
            */
@@ -486,13 +226,6 @@ declare namespace sap {
              */
             bShow: boolean | undefined
           ): void;
-          /**
-           * Triggers an update of the app state.
-           * Should be called if the state of a control, or any other state-relevant information, was changed.
-           *
-           * @returns A promise that resolves with the new app state object.
-           */
-          updateAppState(): Promise<object | void>;
         }
       }
     }