@sapui5/ts-types 1.100.2 → 1.102.0

package/types/sap.suite.ui.generic.template.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.100.0
+// For Library Version: 1.102.0
 
 declare namespace sap {
   namespace suite {
@@ -22,6 +22,8 @@ declare namespace sap {
                  * with name `sClassName` and enriches it with the information contained in `oClassInfo`.
                  *
                  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+                 *
+                 * @returns Created class / constructor function
                  */
                 static extend<T extends Record<string, unknown>>(
                   /**
@@ -43,6 +45,8 @@ declare namespace sap {
                 ): Function;
                 /**
                  * Returns a metadata object for class sap.suite.ui.generic.template.AnalyticalListPage.extensionAPI.ExtensionAPI.
+                 *
+                 * @returns Metadata object describing this class
                  */
                 static getMetadata(): sap.ui.base.Metadata;
                 /**
@@ -58,14 +62,20 @@ declare namespace sap {
                 ): void;
                 /**
                  * provides incoming navigation context of the app
+                 *
+                 * @returns Navigation context object
                  */
                 getNavigationContext(): Object;
                 /**
                  * Get the navigation controller for navigation actions
+                 *
+                 * @returns the navigation controller
                  */
                 getNavigationController(): sap.suite.ui.generic.template.extensionAPI.NavigationController;
                 /**
                  * Get the list entries currently selected
+                 *
+                 * @returns contains the entries selected
                  */
                 getSelectedContexts(
                   /**
@@ -96,6 +106,9 @@ declare namespace sap {
                  * are fulfilled.
                  * See:
                  * 	{@link topic:6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
+                 *
+                 * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
+                 * returned by fnFunction.
                  */
                 securedExecution(
                   /**
@@ -149,6 +162,31 @@ declare namespace sap {
                     sActionLabel?: string;
                   }
                 ): Promise<any>;
+                /**
+                 * Provide an option for showing an own message in the message bar above the ALP table
+                 */
+                setCustomMessage(
+                  /**
+                   * custom message along with type to set on table
+                   */
+                  oMessage: {
+                    /**
+                     * message string to display
+                     */
+                    message?: string;
+                    /**
+                     * indicates type of message (sap.ui.core.MessageType) whether it's sap.ui.core.MessageType.Success, sap.ui.core.MessageType.Warning,
+                     * sap.ui.core.MessageType.Error or sap.ui.core.MessageType.Information.
+                     */
+                    type?: string;
+                  },
+                  /**
+                   * If switching between different table views is enabled, this parameter can be used to identify the views
+                   * which are affected by this call. Faulty values indicate that all views should be affected. Otherwise
+                   * the value should either be one string or an array of strings identifying the affected variant items.
+                   */
+                  vTabKey?: any[] | string
+                ): void;
               }
             }
             /**
@@ -203,6 +241,9 @@ declare namespace sap {
                * return an array of all selection fields set on SmartFilterBar using custom code as default and doesn't
                * really want to store as part of the AppState. SAP Fiori elements framework will remove these filter properties
                * from the selection variant.
+               *
+               * @returns - Properties which are visible and should not be stored as part of the selection variant in
+               * the AppState
                */
               getVisibleSelectionsWithDefaults(): any[];
               /**
@@ -375,6 +416,10 @@ declare namespace sap {
                * This method is called when the user leaves the app and this page has been displayed within the same app
                * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
                * that have been displayed within some app session when the app is finally destroyed.
+               *
+               * @returns - Only relevant in case that `isDestroyed` is false. In this case Application developers can
+               * provide a function to be called when the same page is opened again (after the user has navigated back
+               * to the app).
                */
               onLeaveAppExtension(
                 /**
@@ -388,6 +433,9 @@ declare namespace sap {
                * developers can override this method and perform conditional (internal or external) navigation from different
                * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController
                * NavigationController}.
+               *
+               * @returns Method should return `true` if framework navigation should be suppressed (that means: extension
+               * code has taken over navigation)
                */
               onListNavigationExtension(
                 /**
@@ -451,6 +499,8 @@ declare namespace sap {
                  * `sClassName` and enriches it with the information contained in `oClassInfo`.
                  *
                  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+                 *
+                 * @returns Created class / constructor function
                  */
                 static extend<T extends Record<string, unknown>>(
                   /**
@@ -472,6 +522,8 @@ declare namespace sap {
                 ): Function;
                 /**
                  * Returns a metadata object for class sap.suite.ui.generic.template.Canvas.extensionAPI.ExtensionAPI.
+                 *
+                 * @returns Metadata object describing this class
                  */
                 static getMetadata(): sap.ui.base.Metadata;
                 /**
@@ -523,21 +575,30 @@ declare namespace sap {
                 ): void;
                 /**
                  * Get the Flexible Column Layout Action Buttons(Fullscreen, Exit Fullscreen and Close).
+                 *
+                 * @returns Flexible Column Layout Action Buttons
                  */
                 getFlexibleColumnLayoutActionButtons(): object;
                 /**
                  * Get the navigation controller for navigation actions
+                 *
+                 * @returns the navigation controller
                  */
                 getNavigationController(): sap.suite.ui.generic.template.extensionAPI.NavigationController;
                 /**
                  * Get the transaction controller for editing actions on the page. Note that the methods provided by this
                  * transaction controller depend on whether the object supports drafts or not.
+                 *
+                 * @returns the transaction controller
                  */
                 getTransactionController():
                   | sap.suite.ui.generic.template.ObjectPage.extensionAPI.DraftTransactionController
                   | sap.suite.ui.generic.template.ObjectPage.extensionAPI.NonDraftTransactionController;
                 /**
                  * Invokes multiple time the action with the given name and submits changes to the back-end.
+                 *
+                 * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
+                 * returned from {@link sap.ui.generic.app.ApplicationController}
                  */
                 invokeActions(
                   /**
@@ -565,6 +626,9 @@ declare namespace sap {
                 ): Promise<any>;
                 /**
                  * Invokes multiple time the action with the given name and submits changes to the back-end.
+                 *
+                 * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
+                 * returned from {@link sap.ui.generic.app.ApplicationController}
                  */
                 invokeActions(
                   /**
@@ -617,6 +681,9 @@ declare namespace sap {
                  * are fulfilled.
                  * See:
                  * 	{@link topic:6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
+                 *
+                 * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
+                 * returned by fnFunction.
                  */
                 securedExecution(
                   /**
@@ -694,6 +761,8 @@ declare namespace sap {
                *  });
                *  ...
                *  });`
+               *
+               * @returns A `Promise` which resolves to the extension API for the embedding SAP Fiori elements view
                */
               getExtensionAPIPromise(
                 /**
@@ -795,6 +864,8 @@ declare namespace sap {
                * name `sClassName` and enriches it with the information contained in `oClassInfo`.
                *
                * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+               *
+               * @returns Created class / constructor function
                */
               static extend<T extends Record<string, unknown>>(
                 /**
@@ -816,6 +887,8 @@ declare namespace sap {
               ): Function;
               /**
                * Returns a metadata object for class sap.suite.ui.generic.template.extensionAPI.NavigationController.
+               *
+               * @returns Metadata object describing this class
                */
               static getMetadata(): sap.ui.base.Metadata;
               /**
@@ -864,7 +937,7 @@ declare namespace sap {
                    * This gives the provision to the application developer to chosse between "display"/"edit" mode for target
                    * page
                    */
-                  displayMode?: sap.suite.ui.generic.template.displayMode;
+                  displayMode?: /* was: sap.suite.ui.generic.template.displayMode */ any;
                 }
               ): void;
             }
@@ -884,6 +957,8 @@ declare namespace sap {
                  * name `sClassName` and enriches it with the information contained in `oClassInfo`.
                  *
                  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+                 *
+                 * @returns Created class / constructor function
                  */
                 static extend<T extends Record<string, unknown>>(
                   /**
@@ -905,6 +980,8 @@ declare namespace sap {
                 ): Function;
                 /**
                  * Returns a metadata object for class sap.suite.ui.generic.template.ListReport.extensionAPI.ExtensionAPI.
+                 *
+                 * @returns Metadata object describing this class
                  */
                 static getMetadata(): sap.ui.base.Metadata;
                 /**
@@ -920,25 +997,36 @@ declare namespace sap {
                 ): void;
                 /**
                  * Get the navigation controller for navigation actions
+                 *
+                 * @returns the navigation controller
                  */
                 getNavigationController(): sap.suite.ui.generic.template.extensionAPI.NavigationController;
                 /**
                  * @EXPERIMENTAL
                  *
                  * If switching between different table views is enabled, this function returns the selected key.
+                 *
+                 * @returns The key of the variant item that is currently selected.
                  */
                 getQuickVariantSelectionKey(): string;
                 /**
                  * Get the list entries currently selected for smart table
+                 *
+                 * @returns contains one entry per line selected
                  */
                 getSelectedContexts(): sap.ui.model.Context[];
                 /**
                  * Get the transaction controller for editing actions on the list. Note: Currently implemented for non draft
                  * case
+                 *
+                 * @returns the transaction controller
                  */
                 getTransactionController(): sap.suite.ui.generic.template.ListReport.extensionAPI.NonDraftTransactionController;
                 /**
                  * Invokes multiple time the action with the given name and submits changes to the back-end.
+                 *
+                 * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
+                 * returned from {@link sap.ui.generic.app.ApplicationController}
                  */
                 invokeActions(
                   /**
@@ -966,6 +1054,9 @@ declare namespace sap {
                 ): Promise<any>;
                 /**
                  * Invokes multiple time the action with the given name and submits changes to the back-end.
+                 *
+                 * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
+                 * returned from {@link sap.ui.generic.app.ApplicationController}
                  */
                 invokeActions(
                   /**
@@ -1020,6 +1111,9 @@ declare namespace sap {
                 /**
                  * Secured execution of the given function. Ensures that the function is only executed when certain conditions
                  * are fulfilled. For more information, see {@link topic:6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}.
+                 *
+                 * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
+                 * returned by fnFunction.
                  */
                 securedExecution(
                   /**
@@ -1073,6 +1167,31 @@ declare namespace sap {
                     sActionLabel?: string;
                   }
                 ): Promise<any>;
+                /**
+                 * Provide an option for showing an own message in the message bar above the LR table
+                 */
+                setCustomMessage(
+                  /**
+                   * custom message along with type to set on table
+                   */
+                  oMessage: {
+                    /**
+                     * message string to display
+                     */
+                    message?: string;
+                    /**
+                     * indicates type of message (sap.ui.core.MessageType) whether it's sap.ui.core.MessageType.Success, sap.ui.core.MessageType.Warning,
+                     * sap.ui.core.MessageType.Error or sap.ui.core.MessageType.Information.
+                     */
+                    type?: string;
+                  },
+                  /**
+                   * If switching between different table views is enabled, this parameter can be used to identify the views
+                   * which are affected by this call. Faulty values indicate that all views should be affected. Otherwise
+                   * the value should either be one string or an array of strings identifying the affected variant items.
+                   */
+                  vTabKey?: any[] | string
+                ): void;
                 /**
                  * @EXPERIMENTAL
                  *
@@ -1100,6 +1219,8 @@ declare namespace sap {
                  * with name `sClassName` and enriches it with the information contained in `oClassInfo`.
                  *
                  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+                 *
+                 * @returns Created class / constructor function
                  */
                 static extend<T extends Record<string, unknown>>(
                   /**
@@ -1121,6 +1242,8 @@ declare namespace sap {
                 ): Function;
                 /**
                  * Returns a metadata object for class sap.suite.ui.generic.template.ListReport.extensionAPI.NonDraftTransactionController.
+                 *
+                 * @returns Metadata object describing this class
                  */
                 static getMetadata(): sap.ui.base.Metadata;
                 /**
@@ -1129,6 +1252,9 @@ declare namespace sap {
                 cancel(): void;
                 /**
                  * This method can be called when a new entry with predefined values should be created (e.g. in a copy scenario).
+                 *
+                 * @returns a context representing the object to be created. It can be passed to {@link sap.suite.ui.generic.template.extensionAPI.NavigationController#navigateInternal}
+                 * in order to visit the corresponding object page.
                  */
                 createEntry(
                   /**
@@ -1155,6 +1281,8 @@ declare namespace sap {
                  * Save the changes which have been applied to the OData model. Sets the application busy during execution
                  * and doesn't execute if application is already busy when called (i.e. don't use `ExtensionAPI.securedExecution`
                  * to call this method).
+                 *
+                 * @returns is resolved when entry is successfully saved and rejected when saving fails
                  */
                 save(): Promise<any>;
               }
@@ -1164,6 +1292,28 @@ declare namespace sap {
              * extension code. Application developers should not override any methods outside this documentation.
              */
             interface controllerFrameworkExtensions {
+              /**
+               * Obsolete and not called anymore. Kept here to avoid conflicts (in the very unlikely case, Fiori elements
+               * would come up with the idea to invent a new extension method with the exact same name some day in future,
+               * and any application would still have an implementation for this old extension).
+               *
+               * (Original purpose: When (standard) filters (i.e. filters defined in annotations) are provided with default
+               * values (also from the annotation), and the user actively removed the default without giving a new value,
+               * and later tried to restore from that state, the default values were reappearing. This was caused by the
+               * way the old API of SFB (getDataSuiteFormat and setDataSuiteFormat) worked: the get method returned only
+               * select options for the filters that actually had values (i.e. no select option for the filters the user
+               * removed the values from), and the set method only overrode those values, select options were provided
+               * for (i.e. the missing ones just kept their default value set during initialization). To overcome this
+               * problem, the extension was created to inform Fiori elements about all fields potentially running into
+               * that problem, and we added a select option (I EQ "") for those fields. This workaround of course ahs
+               * two severe problems: A filter with eq "" is not the same as not having a filter for the same field (rather
+               * the opposite), and all applications were required to keep extension and annotations in sync (and missing
+               * to do that would only be found in very exceptional cases). With the newer API of SFB (getUiState and
+               * setUiState), this problem has been overcome (esp. as setUiState overrides all filters, not only the ones
+               * provided).)
+               */
+              getVisibleSelectionsWithDefaults: undefined;
+
               /**
                * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
                * can override this method and programmatically adapt the parameters which are passed to the target application.
@@ -1199,6 +1349,8 @@ declare namespace sap {
                * can override this method in controller extension & perform additional checks before executing the delete
                * operation. Method is expected to return a Promise. To veto the delete operation, promise needs to be
                * rejected else resolved.
+               *
+               * @returns - Promise object created by the extension, used for Delete operation chaining
                */
               beforeDeleteExtension(
                 /**
@@ -1217,6 +1369,9 @@ declare namespace sap {
                * based on whose resolution or rejection the framework would perform cleanup tasks like closing the dialog
                * and refreshing the table data.There will be no chaining of multi edit save from the framework, if the
                * extension is implemented then the framework will only execute extension code for save.
+               *
+               * @returns - Promise object created by the extension, used for cleanup after the promise is resolved or
+               * rejected.
                */
               beforeMultiEditSaveExtension(
                 /**
@@ -1268,6 +1423,8 @@ declare namespace sap {
                * as a parameter to the method. Application developers can access the properties, values and add it to
                * the returning object map. Application developers will have complete control on properties passed to the
                * new instance creation.
+               *
+               * @returns Key/Value map of the properties
                */
               getPredefinedValuesForCreateExtension(
                 /**
@@ -1279,13 +1436,6 @@ declare namespace sap {
                  */
                 oDefaultValues: object
               ): Map<any, any>;
-              /**
-               * This method is called in the AppState creation lifecycle. Application developers can override this method,
-               * return an array of all selection fields set on SmartFilterBar using custom code as default and doesn't
-               * really want to store as part of the AppState. SAP Fiori elements framework will remove these filter properties
-               * from the selection variant.
-               */
-              getVisibleSelectionsWithDefaults(): any[];
               /**
                * This method is called by SAP Fiori elements in the startup life cycle of a component. Application developers
                * can override this method and modify the startup object. For an example, when the application is started,
@@ -1299,6 +1449,10 @@ declare namespace sap {
                  * Startup Object containing the initial contexts
                  */
                 oStartupObject: {
+                  /**
+                   * information whether the application was triggered via external navigation
+                   */
+                  viaExternalNavigation: boolean;
                   /**
                    * Selection Variant containing the values which needs to be applied to the smart filter bar
                    */
@@ -1307,6 +1461,10 @@ declare namespace sap {
                    * Semantic dates configuration in the manifest is read an assigned in this object
                    */
                   semanticDates: object;
+                  /**
+                   * if switching between different table views is enabled, the key which will be initially selected
+                   */
+                  selectedQuickVariantSelectionKey: string;
                 }
               ): void;
               /**
@@ -1399,6 +1557,10 @@ declare namespace sap {
                * This method is called when the user leaves the app and this page has been displayed within the same app
                * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
                * that have been displayed within some app session when the app is finally destroyed.
+               *
+               * @returns - Only relevant in case that `isDestroyed` is false. In this case Application developers can
+               * provide a function to be called when the same page is opened again (after the user has navigated back
+               * to the app).
                */
               onLeaveAppExtension(
                 /**
@@ -1412,6 +1574,9 @@ declare namespace sap {
                * developers can override this method and perform conditional (internal or external) navigation from different
                * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController
                * NavigationController}.
+               *
+               * @returns Method should return `true` if framework navigation should be suppressed (that means: extension
+               * code has taken over navigation)
                */
               onListNavigationExtension(
                 /**
@@ -1485,6 +1650,8 @@ declare namespace sap {
                  * with name `sClassName` and enriches it with the information contained in `oClassInfo`.
                  *
                  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+                 *
+                 * @returns Created class / constructor function
                  */
                 static extend<T extends Record<string, unknown>>(
                   /**
@@ -1506,6 +1673,8 @@ declare namespace sap {
                 ): Function;
                 /**
                  * Returns a metadata object for class sap.suite.ui.generic.template.ObjectPage.extensionAPI.DraftTransactionController.
+                 *
+                 * @returns Metadata object describing this class
                  */
                 static getMetadata(): sap.ui.base.Metadata;
                 /**
@@ -1578,6 +1747,8 @@ declare namespace sap {
                  * which follows the cancellation of a draft is executed. Moreover, note that executing this method will
                  * set the App to be busy. However, it does not ensure, that the method is only called, when the App is
                  * currently unbusy. If you want to ensure that, you have to use {@link sap.suite.ui.generic.template.ObjectPage.extensionAPI.ExtensionAPI#securedExecution}.
+                 *
+                 * @returns a promise that is resolved when the draft is cancelled, rejected when this is not possible.
                  */
                 discardDraft(): Function;
                 /**
@@ -1634,6 +1805,8 @@ declare namespace sap {
                  * name `sClassName` and enriches it with the information contained in `oClassInfo`.
                  *
                  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+                 *
+                 * @returns Created class / constructor function
                  */
                 static extend<T extends Record<string, unknown>>(
                   /**
@@ -1655,6 +1828,8 @@ declare namespace sap {
                 ): Function;
                 /**
                  * Returns a metadata object for class sap.suite.ui.generic.template.ObjectPage.extensionAPI.ExtensionAPI.
+                 *
+                 * @returns Metadata object describing this class
                  */
                 static getMetadata(): sap.ui.base.Metadata;
                 /**
@@ -1691,12 +1866,16 @@ declare namespace sap {
                 ): void;
                 /**
                  * Get the navigation controller for navigation actions
+                 *
+                 * @returns the navigation controller
                  */
                 getNavigationController(): sap.suite.ui.generic.template.extensionAPI.NavigationController;
                 /**
                  * @EXPERIMENTAL
                  *
                  * This function returns the selected key of selected table of Object Page.
+                 *
+                 * @returns The key of variant item that is currently selected section.
                  */
                 getQuickVariantSelectionKey(
                   /**
@@ -1706,6 +1885,8 @@ declare namespace sap {
                 ): string;
                 /**
                  * Get the entries currently selected in one ui element (table, chart, or list)
+                 *
+                 * @returns contains one entry per entry selected
                  */
                 getSelectedContexts(
                   /**
@@ -1716,16 +1897,23 @@ declare namespace sap {
                 /**
                  * Get the transaction controller for editing actions on the page. Note that the methods provided by this
                  * transaction controller depend on whether the object supports drafts or not.
+                 *
+                 * @returns the transaction controller
                  */
                 getTransactionController():
                   | sap.suite.ui.generic.template.ObjectPage.extensionAPI.DraftTransactionController
                   | sap.suite.ui.generic.template.ObjectPage.extensionAPI.NonDraftTransactionController;
                 /**
                  * Get the id of the view this extension api belongs to
+                 *
+                 * @returns the view id
                  */
                 getViewId(): string;
                 /**
                  * Invokes multiple time the action with the given name and submits changes to the back-end.
+                 *
+                 * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
+                 * returned from {@link sap.ui.generic.app.ApplicationController}
                  */
                 invokeActions(
                   /**
@@ -1753,6 +1941,9 @@ declare namespace sap {
                 ): Promise<any>;
                 /**
                  * Invokes multiple time the action with the given name and submits changes to the back-end.
+                 *
+                 * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
+                 * returned from {@link sap.ui.generic.app.ApplicationController}
                  */
                 invokeActions(
                   /**
@@ -1779,6 +1970,9 @@ declare namespace sap {
                  * the corresponding state can be stored and restored.
                  * See:
                  * 	{@link topic:89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
+                 *
+                 * @returns A `Promise` that is resolved when the changed state is transferred to the URL and the corresponding
+                 * busy session is ended.
                  */
                 onCustomStateChange(): Promise<any>;
                 /**
@@ -1826,6 +2020,9 @@ declare namespace sap {
                  * are fulfilled.
                  * See:
                  * 	{@link topic:6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
+                 *
+                 * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
+                 * returned by fnFunction.
                  */
                 securedExecution(
                   /**
@@ -1908,6 +2105,8 @@ declare namespace sap {
                  * with name `sClassName` and enriches it with the information contained in `oClassInfo`.
                  *
                  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+                 *
+                 * @returns Created class / constructor function
                  */
                 static extend<T extends Record<string, unknown>>(
                   /**
@@ -1929,6 +2128,8 @@ declare namespace sap {
                 ): Function;
                 /**
                  * Returns a metadata object for class sap.suite.ui.generic.template.ObjectPage.extensionAPI.NonDraftTransactionController.
+                 *
+                 * @returns Metadata object describing this class
                  */
                 static getMetadata(): sap.ui.base.Metadata;
                 /**
@@ -1969,6 +2170,9 @@ declare namespace sap {
                 ): void;
                 /**
                  * This method can be called when a new entry with predefined values should be created (e.g. in a copy scenario).
+                 *
+                 * @returns a context representing the object to be created. It can be passed to {@link sap.suite.ui.generic.template.extensionAPI.NavigationController#navigateInternal}
+                 * in order to visit the corresponding object page.
                  */
                 createEntry(
                   /**
@@ -2079,6 +2283,8 @@ declare namespace sap {
                * developers can override this method & perform additional checks before executing the delete operation.
                * Method is expected to return a Promise. To veto the delete operation, promise needs to be rejected else
                * resolved.
+               *
+               * @returns Promise object created by the extension, used for delete operation chaining
                */
               beforeDeleteExtension(): Promise<any>;
               /**
@@ -2088,6 +2294,8 @@ declare namespace sap {
                * resolved. In case the extension code wants to veto the Delete operation, promise needs to be rejected.
                * Application developers can use `sUiElementId` property of the object passed as param to identify the
                * smart table where the Delete operation is being triggered.
+               *
+               * @returns Promise object created by the extension, used for Delete operation chaining
                */
               beforeLineItemDeleteExtension(
                 /**
@@ -2109,6 +2317,8 @@ declare namespace sap {
                * this method & perform additional checks before executing the Save operation. Method is expected to return
                * a Promise. Save operation will be continued only once the promise is resolved. In case the extension
                * code would like to veto the Save operation, promise needs to be rejected.
+               *
+               * @returns Promise object created by the extension, used for Save operation chaining
                */
               beforeSaveExtension(): Promise<any>;
               /**
@@ -2164,6 +2374,10 @@ declare namespace sap {
                * This method is called when the user leaves the app and this page has been displayed within the same app
                * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
                * that have been displayed within some app session when the app is finally destroyed.
+               *
+               * @returns - Only relevant in case that `isDestroyed` is false. In this case Application developers can
+               * provide a function to be called when the same page is opened again (after the user has navigated back
+               * to the app).
                */
               onLeaveAppExtension(
                 /**
@@ -2177,6 +2391,9 @@ declare namespace sap {
                * developers can override this method and perform conditional (internal or external) navigation from different
                * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController
                * NavigationController}.
+               *
+               * @returns Method should return `true` if framework navigation should be suppressed (that means: extension
+               * code has taken over navigation)
                */
               onListNavigationExtension(
                 /**
@@ -2227,28 +2444,6 @@ declare namespace sap {
             }
             const controllerFrameworkExtensions: controllerFrameworkExtensions;
           }
-
-          /**
-           * A static enumeration type which indicates the mode of targeted page while using navigateInternal extensionAPI
-           */
-          enum displayMode {
-            /**
-             * Navigating in create mode
-             */
-            create = "create",
-            /**
-             * Navigating in read-only mode
-             */
-            display = "display",
-            /**
-             * Navigating in draft mode
-             */
-            edit = "edit",
-            /**
-             * Navigating with a mode which is not yet decided (fallback condition)
-             */
-            undefined = "undefined",
-          }
         }
       }
     }