@sapui5/ts-types 1.101.1 → 1.103.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.1
+// For Library Version: 1.103.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(
                   /**
@@ -150,46 +163,36 @@ declare namespace sap {
                   }
                 ): Promise<any>;
                 /**
-                 * Provide an option for showing an own message in the message bar above the LR table
+                 * Provide an option for showing an own message in the message bar above the ALP table
                  */
                 setCustomMessage(
                   /**
-                   * the entitySet identifying the table to set custom message
-                   */
-                  vTabKey: any[] | string,
-                  /**
-                   * custom message along with type to set on table
+                   * custom message along with type to set on table. If this parameter is faulty an existing message will
+                   * be removed.
                    */
-                  oMessage: {
+                  oMessage?: {
                     /**
                      * message string to display
                      */
-                    message?: string;
+                    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;
-                  }
-                ): void;
-                /**
-                 * Provide an option for showing an own message in the message bar above the LR table
-                 */
-                setCustomMessage(
+                    type: string;
+                  },
                   /**
-                   * custom message along with type to set on table
+                   * 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.
                    */
-                  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;
-                  }
+                  vTabKey?: any[] | string,
+                  /**
+                   * A function that is called when the user closes the message bar. Note that the messages for all tabs specified
+                   * via `vTabKey` will be considered to be obsolete when the user closes the message bar while one of them
+                   * is active.
+                   */
+                  onClose?: Function
                 ): void;
               }
             }
@@ -245,6 +248,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[];
               /**
@@ -417,6 +423,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(
                 /**
@@ -430,6 +440,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(
                 /**
@@ -493,6 +506,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>>(
                   /**
@@ -514,6 +529,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;
                 /**
@@ -565,21 +582,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(
                   /**
@@ -607,6 +633,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(
                   /**
@@ -659,6 +688,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(
                   /**
@@ -736,6 +768,8 @@ declare namespace sap {
                *  });
                *  ...
                *  });`
+               *
+               * @returns A `Promise` which resolves to the extension API for the embedding SAP Fiori elements view
                */
               getExtensionAPIPromise(
                 /**
@@ -837,6 +871,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>>(
                 /**
@@ -858,6 +894,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;
               /**
@@ -926,6 +964,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>>(
                   /**
@@ -947,6 +987,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;
                 /**
@@ -962,25 +1004,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(
                   /**
@@ -1008,6 +1061,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(
                   /**
@@ -1062,6 +1118,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(
                   /**
@@ -1120,42 +1179,32 @@ declare namespace sap {
                  */
                 setCustomMessage(
                   /**
-                   * the entitySet identifying the table to set custom message
-                   */
-                  vTabKey: any[] | string,
-                  /**
-                   * custom message along with type to set on table
+                   * custom message along with type to set on table. If this parameter is faulty an existing message will
+                   * be removed.
                    */
-                  oMessage: {
+                  oMessage?: {
                     /**
                      * message string to display
                      */
-                    message?: string;
+                    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;
-                  }
-                ): void;
-                /**
-                 * Provide an option for showing an own message in the message bar above the LR table
-                 */
-                setCustomMessage(
+                    type: string;
+                  },
                   /**
-                   * custom message along with type to set on table
+                   * 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.
                    */
-                  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;
-                  }
+                  vTabKey?: any[] | string,
+                  /**
+                   * A function that is called when the user closes the message bar. Note that the messages for all tabs specified
+                   * via `vTabKey` will be considered to be obsolete when the user closes the message bar while one of them
+                   * is active.
+                   */
+                  onClose?: Function
                 ): void;
                 /**
                  * @EXPERIMENTAL
@@ -1184,6 +1233,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>>(
                   /**
@@ -1205,6 +1256,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;
                 /**
@@ -1213,6 +1266,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(
                   /**
@@ -1239,6 +1295,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>;
               }
@@ -1305,6 +1363,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(
                 /**
@@ -1323,6 +1383,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(
                 /**
@@ -1374,6 +1437,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(
                 /**
@@ -1506,6 +1571,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(
                 /**
@@ -1519,6 +1588,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(
                 /**
@@ -1592,6 +1664,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>>(
                   /**
@@ -1613,6 +1687,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;
                 /**
@@ -1685,6 +1761,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;
                 /**
@@ -1741,6 +1819,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>>(
                   /**
@@ -1762,6 +1842,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;
                 /**
@@ -1798,12 +1880,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(
                   /**
@@ -1813,6 +1899,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(
                   /**
@@ -1823,16 +1911,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(
                   /**
@@ -1860,6 +1955,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(
                   /**
@@ -1886,6 +1984,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>;
                 /**
@@ -1933,6 +2034,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(
                   /**
@@ -1986,6 +2090,56 @@ declare namespace sap {
                     sActionLabel?: string;
                   }
                 ): Promise<any>;
+                /**
+                 * Provide an option for showing an own message in the message bar above the OP table
+                 */
+                setCustomMessage(
+                  /**
+                   * the entitySet identifying the table to set custom message
+                   */
+                  vTabKey: any[] | string,
+                  /**
+                   * 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;
+                  },
+                  /**
+                   * Id of the table for which message should be set
+                   */
+                  sSmartTableId: string
+                ): void;
+                /**
+                 * Provide an option for showing an own message in the message bar above the OP 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;
+                  },
+                  /**
+                   * Id of the table for which message should be set
+                   */
+                  sSmartTableId: string
+                ): void;
                 /**
                  * @EXPERIMENTAL
                  *
@@ -2015,6 +2169,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>>(
                   /**
@@ -2036,6 +2192,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;
                 /**
@@ -2076,6 +2234,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(
                   /**
@@ -2186,6 +2347,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>;
               /**
@@ -2195,6 +2358,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(
                 /**
@@ -2216,6 +2381,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>;
               /**
@@ -2271,6 +2438,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(
                 /**
@@ -2284,6 +2455,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(
                 /**