@sapui5/types 1.113.0

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

@@ -0,0 +1,522 @@
+// For Library Version: 1.111.0
+
+declare module "sap/fe/templates/ListReport/ExtensionAPI" {
+  import Control from "sap/ui/core/Control";
+
+  import Model from "sap/ui/model/Model";
+
+  import Context from "sap/ui/model/Context";
+
+  import UI5Element from "sap/ui/core/Element";
+
+  /**
+   * @SINCE 1.79.0
+   *
+   * Extension API for list reports in SAP Fiori elements for OData V4.
+   * To correctly integrate your app extension coding with SAP Fiori elements, use only the extensionAPI of
+   * SAP Fiori elements. Don't access or manipulate controls, properties, models, or other internal objects
+   * created by the SAP Fiori elements framework.
+   */
+  export default class ExtensionAPI
+    /* was: sap.fe.templates.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: Control
+    ): void;
+    /**
+     * This method converts filter conditions to filters.
+     *
+     * @returns Object containing the converted FilterBar filters.
+     */
+    createFiltersFromFilterConditions(
+      /**
+       * Map containing the filter conditions of the FilterBar.
+       */
+      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.
+     *
+     * @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
+    ): 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: Context;
+        /**
+         * The name of the fragment to be loaded
+         */
+        name: string;
+      }
+    ): Promise<UI5Element | UI5Element[]>;
+    /**
+     * Navigate to another target.
+     */
+    navigateToTarget(
+      /**
+       * Name of the target route
+       */
+      sTarget: string,
+      /**
+       * undefined
+       */
+      oContext: Context
+    ): void;
+    /**
+     * Refreshes the List Report.
+     * This method currently only supports triggering the search (by clicking on the GO button)
+     * in the List Report Filter Bar. It can be used to request the initial load or to refresh the
+     * currently shown data based on the filters entered by the user.
+     * Please note: The Promise is resolved once the search is triggered and not once the data is returned.
+     *
+     * @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: Control
+    ): void;
+    /**
+     * Provide an option for showing a custom message in the message strip above the list report table.
+     */
+    setCustomMessage(
+      /**
+       * Custom message along with the message type to be set on the table.
+       */
+      message: /* was: sap.fe.templates.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[],
+      /**
+       * A function that is called when the user closes the message bar.
+       */
+      onClose?: Function
+    ): void;
+    /**
+     * Set the filter values for the given property in the filter bar.
+     * The filter values can be either a single value or an array of values.
+     * Each filter value must be represented as a primitive value.
+     *
+     * @returns A promise for asynchronous handling
+     */
+    setFilterValues(
+      /**
+       * The path to the property as a condition path
+       */
+      sConditionPath: string,
+      /**
+       * undefined
+       */
+      sOperator: string | undefined,
+      /**
+       * The values to be applied
+       */
+      vValues?: boolean | boolean[] | number | number[] | 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>;
+  }
+}
+
+declare module "sap/fe/templates/ListReport/ListReportController.controller" {
+  import Model from "sap/ui/model/Model";
+
+  import View from "sap/ui/core/mvc/View";
+
+  /**
+   * Controller class for the list report page, used inside an SAP Fiori elements application.
+   */
+  export default class ListReportController
+    /* was: sap.fe.templates.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
+    ): Model;
+    /**
+     * Method called when the 'Clear' button on the FilterBar is pressed.
+     */
+    onAfterClear(): void;
+    /**
+     * Method called when a filter or search value has been changed in the FilterBar,
+     * but has not been validated yet by the end user (with the 'Go' or 'Search' button).
+     * Typically, the content of the current tab is greyed out until the filters are validated.
+     * This method can be overwritten by the controller extension in case of customization.
+     */
+    onPendingFilters(): void;
+    /**
+     * Method called when the content of a custom view used in a list report needs to be refreshed.
+     * This happens either when there is a change on the FilterBar and the search is triggered,
+     * or when a tab with custom content is selected.
+     * This method can be overwritten by the controller extension in case of customization.
+     */
+    onViewNeedsRefresh(
+      /**
+       * Map containing the filter conditions of the FilterBar, the currentTabID
+       * and the view refresh cause (tabChanged or search).
+       * The map looks like this:
+       *
+       * ```javascript
+       *
+       * 	{
+       * 		filterConditions: {
+       * 			Country: [
+       * 				{
+       * 					operator: "EQ"
+       * 					validated: "NotValidated"
+       * 					values: ["Germany", ...]
+       * 				},
+       * 				...
+       * 			]
+       * 			...
+       * 		},
+       * 		currentTabId: "fe::CustomTab::tab1",
+       * 		refreshCause: "tabChanged" | "search"
+       * 	}
+       * ```
+       */
+      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: Model,
+      /**
+       * The model name
+       */
+      sName: string
+    ): View;
+  }
+}
+
+declare module "sap/fe/templates/ObjectPage/ExtensionAPI" {
+  import Control from "sap/ui/core/Control";
+
+  import Context from "sap/ui/model/Context";
+
+  import Model from "sap/ui/model/Model";
+
+  import UI5Element from "sap/ui/core/Element";
+
+  import Message from "sap/ui/core/message/Message";
+
+  /**
+   * @SINCE 1.79.0
+   *
+   * Extension API for object pages on SAP Fiori elements for OData V4.
+   * To correctly integrate your app extension coding with SAP Fiori elements, use only the extensionAPI of
+   * SAP Fiori elements. Don't access or manipulate controls, properties, models, or other internal objects
+   * created by the SAP Fiori elements framework.
+   */
+  export default class ExtensionAPI
+    /* was: sap.fe.templates.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: Control
+    ): void;
+    /**
+     * Gets the bound context of the current object page.
+     *
+     * @returns Context bound to the object page
+     */
+    getBindingContext(): 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
+    ): 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 table.
+     *
+     * @returns Array containing the selected contexts
+     */
+    getSelectedContexts(
+      /**
+       * The ID identifying the table the selected context is requested for
+       */
+      sTableId: string
+    ): any;
+    /**
+     * 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: Context;
+        /**
+         * The name of the fragment to be loaded
+         */
+        name: string;
+      }
+    ): Promise<UI5Element | UI5Element[]>;
+    /**
+     * Navigate to another target.
+     */
+    navigateToTarget(
+      /**
+       * Name of the target route
+       */
+      sTarget: string,
+      /**
+       * undefined
+       */
+      oContext: Context
+    ): void;
+    /**
+     * Refreshes either the whole object page or only parts of it.
+     *
+     * @returns Resolved once the data is refreshed or rejected if the request failed
+     */
+    refresh(
+      /**
+       * undefined
+       */
+      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: Control
+    ): void;
+    /**
+     * Displays the message strip between the title and the header of the ObjectPage.
+     */
+    showMessages(
+      /**
+       * The message to be displayed
+       */
+      messages: Message[]
+    ): Promise<void>;
+    /**
+     * Displays or hides the side content of an object page.
+     */
+    showSideContent(
+      /**
+       * Key of the side content fragment as defined in the manifest.json
+       */
+      sSubSectionKey: string,
+      /**
+       * undefined
+       */
+      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>;
+  }
+}
+
+declare module "sap/fe/templates/library" {}
+
+declare namespace sap {
+  interface IUI5DefineDependencyNames {
+    "sap/fe/templates/library": undefined;
+
+    "sap/fe/templates/ListReport/ExtensionAPI": undefined;
+
+    "sap/fe/templates/ListReport/ListReportController.controller": undefined;
+
+    "sap/fe/templates/ObjectPage/ExtensionAPI": undefined;
+  }
+}