@sapui5/ts-types 1.135.0 → 1.136.0

package/types/sap.m.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.135.0
+// For Library Version: 1.136.0
 
 declare namespace sap {
   /**
@@ -2678,6 +2678,43 @@ declare namespace sap {
       }
 
       namespace UploadSetwithTable {
+        /**
+         * This property type is used to define the file name validation configuration. Object is passed to {@link sap.m.plugins.UploadSetwithTable fileNameValidationConfig property}
+         */
+        type FilenameValidationConfig = {
+          /**
+           * The file name validation config mode.
+           */
+          mode: sap.m.plugins.UploadSetwithTable.FilenameValidationConfigMode;
+          /**
+           * The file name validation configuration characters.
+           *
+           *  The default restricted filename character set is: \:/*?"<>|[]{}@#$
+           */
+          characters: string;
+        };
+
+        /**
+         * Key property of {@link sap.m.plugins.UploadSetwithTable.FilenameValidationConfig FileNameValidationConfig}.
+         * Used to determine the mode for file name validation.
+         *
+         * @since 1.136
+         */
+        type FilenameValidationConfigMode = {
+          /**
+           * The file name validation mode. The allowed values are 'include', 'exclude', or 'override'.
+           *
+           *  If the mode is 'include', the specified characters are added to the default restricted character set.
+           *
+           *  If the mode is 'exclude', the specified characters are excluded from the default resrtricted character
+           * set.
+           *  If the mode is 'override', the specified characters replace the entire default restricted character
+           * set.
+           *  If the mode is not set, the default restricted file name character set is used.
+           */
+          mode: string;
+        };
+
         /**
          * Item info object sent as paramter to {@link sap.m.plugins.UploadSetwithTable.itemValidationHandler itemValidationHandler callback}
          */
@@ -2741,6 +2778,16 @@ declare namespace sap {
         selectionChange?: (oEvent: sap.ui.base.Event) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the ColumnAIAction constructor.
+       */
+      interface $ColumnAIActionSettings extends sap.ui.core.$ElementSettings {
+        /**
+         * Fired when the AI action is pressed.
+         */
+        press?: (oEvent: ColumnAIAction$PressEvent) => void;
+      }
+
       /**
        * Describes the settings that can be provided to the ColumnResizer constructor.
        */
@@ -3065,6 +3112,24 @@ declare namespace sap {
           | string
           | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+        /**
+         * File name validation configuration.
+         *  Set this property to configure the file name validation characters and the validation mode.
+         *  This configuration is used to validate the file name when a file is selected for renaming.
+         *  For the plugin to pick up this configuration, mode and characters of the property must be set to validate
+         * the file name.
+         *  see {@link sap.m.plugins.UploadSetwithTable.FilenameValidationConfigMode mode} to configure the file
+         * name validation mode.
+         *
+         *  The default restricted filename character set is: \:/*?"<>|[]{}@#$
+         *
+         * @since 1.136
+         */
+        fileNameValidationConfig?:
+          | sap.m.plugins.UploadSetwithTable.FilenameValidationConfig
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
         /**
          * Defines the uploader to be used. If not specified, the default implementation is used.
          */
@@ -3192,6 +3257,16 @@ declare namespace sap {
        */
       interface CellSelector$SelectionChangeEventParameters {}
 
+      /**
+       * Parameters of the ColumnAIAction#press event.
+       */
+      interface ColumnAIAction$PressEventParameters {
+        /**
+         * The column action that triggered the event.
+         */
+        action?: sap.ui.core.Control;
+      }
+
       /**
        * Parameters of the ColumnResizer#columnResize event.
        */
@@ -3722,6 +3797,168 @@ declare namespace sap {
           iRangeLimit?: int
         ): this;
       }
+      /**
+       * This plugin adds an AI related action to a table column.
+       *
+       * @since 1.136
+       */
+      class ColumnAIAction extends sap.ui.core.Element {
+        /**
+         * Constructor for a new `ColumnAIAction` plugin that can be used to add an AI related action for table
+         * columns.
+         *
+         * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+         * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+         * of the syntax of the settings object.
+         */
+        constructor(
+          /**
+           * Initial settings for the `ColumnAIAction`
+           */
+          mSettings?: sap.m.plugins.$ColumnAIActionSettings
+        );
+        /**
+         * Constructor for a new `ColumnAIAction` plugin that can be used to add an AI related action for table
+         * columns.
+         *
+         * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+         * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+         * of the syntax of the settings object.
+         */
+        constructor(
+          /**
+           * ID for the new `ColumnAIAction`, generated automatically if no ID is given
+           */
+          sId?: string,
+          /**
+           * Initial settings for the `ColumnAIAction`
+           */
+          mSettings?: sap.m.plugins.$ColumnAIActionSettings
+        );
+
+        /**
+         * Creates a new subclass of class sap.m.plugins.ColumnAIAction 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.core.Element.extend}.
+         *
+         *
+         * @returns Created class / constructor function
+         */
+        static extend<T extends Record<string, unknown>>(
+          /**
+           * Name of the class being created
+           */
+          sClassName: string,
+          /**
+           * Object literal with information about the class
+           */
+          oClassInfo?: sap.ClassInfo<T, sap.m.plugins.ColumnAIAction>,
+          /**
+           * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+           * used by this class
+           */
+          FNMetaImpl?: Function
+        ): Function;
+        /**
+         * Searches a plugin of the corresponding type in the aggregations of the given `Element` instance. The
+         * first plugin that is found is returned.
+         *
+         *
+         * @returns The found plugin instance or `undefined` if not found
+         */
+        static findOn(
+          /**
+           * The `Element` instance to check for
+           */
+          oElement: sap.ui.core.Element
+        ): sap.ui.core.Element | undefined;
+        /**
+         * Returns a metadata object for class sap.m.plugins.ColumnAIAction.
+         *
+         *
+         * @returns Metadata object describing this class
+         */
+        static getMetadata(): sap.ui.core.ElementMetadata;
+        /**
+         * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.m.plugins.ColumnAIAction`.
+         *
+         * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+         * otherwise it will be bound to this `sap.m.plugins.ColumnAIAction` itself.
+         *
+         * Fired when the AI action is pressed.
+         *
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        attachPress(
+          /**
+           * An application-specific payload object that will be passed to the event handler along with the event
+           * object when firing the event
+           */
+          oData: object,
+          /**
+           * The function to be called when the event occurs
+           */
+          fnFunction: (p1: ColumnAIAction$PressEvent) => void,
+          /**
+           * Context object to call the event handler with. Defaults to this `sap.m.plugins.ColumnAIAction` itself
+           */
+          oListener?: object
+        ): this;
+        /**
+         * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.m.plugins.ColumnAIAction`.
+         *
+         * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+         * otherwise it will be bound to this `sap.m.plugins.ColumnAIAction` itself.
+         *
+         * Fired when the AI action is pressed.
+         *
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        attachPress(
+          /**
+           * The function to be called when the event occurs
+           */
+          fnFunction: (p1: ColumnAIAction$PressEvent) => void,
+          /**
+           * Context object to call the event handler with. Defaults to this `sap.m.plugins.ColumnAIAction` itself
+           */
+          oListener?: object
+        ): this;
+        /**
+         * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.m.plugins.ColumnAIAction`.
+         *
+         * The passed function and listener object must match the ones used for event registration.
+         *
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        detachPress(
+          /**
+           * The function to be called, when the event occurs
+           */
+          fnFunction: (p1: ColumnAIAction$PressEvent) => void,
+          /**
+           * Context object on which the given function had to be called
+           */
+          oListener?: object
+        ): this;
+        /**
+         * Fires event {@link #event:press press} to attached listeners.
+         *
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        firePress(
+          /**
+           * Parameters to pass along with the event
+           */
+          mParameters?: sap.m.plugins.ColumnAIAction$PressEventParameters
+        ): this;
+      }
       /**
        * Enables column resizing for the `sap.m.Table`. This plugin can be added to the control via its `dependents`
        * aggregation and there must only be 1 instance of the plugin per control.
@@ -6257,6 +6494,24 @@ declare namespace sap {
          * @returns Value of property `directory`
          */
         getDirectory(): boolean;
+        /**
+         * Gets current value of property {@link #getFileNameValidationConfig fileNameValidationConfig}.
+         *
+         * File name validation configuration.
+         *  Set this property to configure the file name validation characters and the validation mode.
+         *  This configuration is used to validate the file name when a file is selected for renaming.
+         *  For the plugin to pick up this configuration, mode and characters of the property must be set to validate
+         * the file name.
+         *  see {@link sap.m.plugins.UploadSetwithTable.FilenameValidationConfigMode mode} to configure the file
+         * name validation mode.
+         *
+         *  The default restricted filename character set is: \:/*?"<>|[]{}@#$
+         *
+         * @since 1.136
+         *
+         * @returns Value of property `fileNameValidationConfig`
+         */
+        getFileNameValidationConfig(): sap.m.plugins.UploadSetwithTable.FilenameValidationConfig;
         /**
          * Gets current value of property {@link #getFileTypes fileTypes}.
          *
@@ -6568,6 +6823,31 @@ declare namespace sap {
            */
           bDirectory?: boolean
         ): this;
+        /**
+         * Sets a new value for property {@link #getFileNameValidationConfig fileNameValidationConfig}.
+         *
+         * File name validation configuration.
+         *  Set this property to configure the file name validation characters and the validation mode.
+         *  This configuration is used to validate the file name when a file is selected for renaming.
+         *  For the plugin to pick up this configuration, mode and characters of the property must be set to validate
+         * the file name.
+         *  see {@link sap.m.plugins.UploadSetwithTable.FilenameValidationConfigMode mode} to configure the file
+         * name validation mode.
+         *
+         *  The default restricted filename character set is: \:/*?"<>|[]{}@#$
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * @since 1.136
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setFileNameValidationConfig(
+          /**
+           * New value for property `fileNameValidationConfig`
+           */
+          sFileNameValidationConfig?: sap.m.plugins.UploadSetwithTable.FilenameValidationConfig
+        ): this;
         /**
          * Sets a new value for property {@link #getFileTypes fileTypes}.
          *
@@ -6874,6 +7154,14 @@ declare namespace sap {
         CellSelector
       >;
 
+      /**
+       * Event object of the ColumnAIAction#press event.
+       */
+      type ColumnAIAction$PressEvent = sap.ui.base.Event<
+        ColumnAIAction$PressEventParameters,
+        ColumnAIAction
+      >;
+
       /**
        * Event object of the ColumnResizer#columnResize event.
        */
@@ -17688,6 +17976,64 @@ declare namespace sap {
           | sap.ui.base.ManagedObject.PropertyBindingInfo
           | `{${string}}`;
 
+        /**
+         * Callback function to insert custom content into the preview dialog using a control to display the preview
+         * of unsupported file types.
+         * Use this property as callback function to insert a control with the content into the preview dialog.
+         *
+         * Callback function returns a promise that resolves with a control that is displayed in the preview dialog.
+         * Reject the promise to display the default illustrated message.
+         * Callback function is invoked with {@link sap.m.upload.UploadItem item} for each unsupported file type.
+         *
+         *
+         * Example: There is a file with an xml extension and you want to display the content inside a codeeditor
+         * control for the file type.
+         *
+         *
+         * ```javascript
+         *
+         * 	<UploadSetwithTable>
+         * 		<upload:FilePreviewDialog customPageContentHandler="{onCustomContentHandler}"></upload:FilePreviewDialog>
+         * 	</UploadSetwithTable>
+         * ```
+         *
+         *
+         *
+         * ```javascript
+         *
+         * 	onCustomContentHandler: function(oItem) {
+         *
+         * 			return new Promise(function(resolve, reject) {
+         *
+         * 				switch (oItem.getMediaType().toLowerCase()) {
+         *
+         * 					case "application/xml":
+         *
+         * 						var oCodeEditor = new CodeEditor({
+         * 							value: "XML content",
+         * 							width: "100%",
+         * 							height: "100%"
+         * 						});
+         *
+         * 						resolve(oCodeEditor);
+         * 						break;
+         *
+         * 					default:
+         * 						reject(); // reject the promise to display the default illustrated message.
+         * 						break;
+         * 				}
+         * 			});
+         * 	}
+         * ```
+         *
+         *
+         * @since 1.136
+         */
+        customPageContentHandler?:
+          | Function
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
         /**
          * Custom buttons, to be displayed in the preview dialog footer.
          * Control by default adds two buttons (download and close).
@@ -19313,6 +19659,64 @@ declare namespace sap {
          * Control by default adds two buttons (download and close).
          */
         getAdditionalFooterButtons(): sap.m.Button[];
+        /**
+         * Gets current value of property {@link #getCustomPageContentHandler customPageContentHandler}.
+         *
+         * Callback function to insert custom content into the preview dialog using a control to display the preview
+         * of unsupported file types.
+         * Use this property as callback function to insert a control with the content into the preview dialog.
+         *
+         * Callback function returns a promise that resolves with a control that is displayed in the preview dialog.
+         * Reject the promise to display the default illustrated message.
+         * Callback function is invoked with {@link sap.m.upload.UploadItem item} for each unsupported file type.
+         *
+         *
+         * Example: There is a file with an xml extension and you want to display the content inside a codeeditor
+         * control for the file type.
+         *
+         *
+         * ```javascript
+         *
+         * 	<UploadSetwithTable>
+         * 		<upload:FilePreviewDialog customPageContentHandler="{onCustomContentHandler}"></upload:FilePreviewDialog>
+         * 	</UploadSetwithTable>
+         * ```
+         *
+         *
+         *
+         * ```javascript
+         *
+         * 	onCustomContentHandler: function(oItem) {
+         *
+         * 			return new Promise(function(resolve, reject) {
+         *
+         * 				switch (oItem.getMediaType().toLowerCase()) {
+         *
+         * 					case "application/xml":
+         *
+         * 						var oCodeEditor = new CodeEditor({
+         * 							value: "XML content",
+         * 							width: "100%",
+         * 							height: "100%"
+         * 						});
+         *
+         * 						resolve(oCodeEditor);
+         * 						break;
+         *
+         * 					default:
+         * 						reject(); // reject the promise to display the default illustrated message.
+         * 						break;
+         * 				}
+         * 			});
+         * 	}
+         * ```
+         *
+         *
+         * @since 1.136
+         *
+         * @returns Value of property `customPageContentHandler`
+         */
+        getCustomPageContentHandler(): Function;
         /**
          * Gets current value of property {@link #getMaxFileSizeforPreview maxFileSizeforPreview}.
          *
@@ -19386,6 +19790,71 @@ declare namespace sap {
          * @returns An array of the removed elements (might be empty)
          */
         removeAllAdditionalFooterButtons(): sap.m.Button[];
+        /**
+         * Sets a new value for property {@link #getCustomPageContentHandler customPageContentHandler}.
+         *
+         * Callback function to insert custom content into the preview dialog using a control to display the preview
+         * of unsupported file types.
+         * Use this property as callback function to insert a control with the content into the preview dialog.
+         *
+         * Callback function returns a promise that resolves with a control that is displayed in the preview dialog.
+         * Reject the promise to display the default illustrated message.
+         * Callback function is invoked with {@link sap.m.upload.UploadItem item} for each unsupported file type.
+         *
+         *
+         * Example: There is a file with an xml extension and you want to display the content inside a codeeditor
+         * control for the file type.
+         *
+         *
+         * ```javascript
+         *
+         * 	<UploadSetwithTable>
+         * 		<upload:FilePreviewDialog customPageContentHandler="{onCustomContentHandler}"></upload:FilePreviewDialog>
+         * 	</UploadSetwithTable>
+         * ```
+         *
+         *
+         *
+         * ```javascript
+         *
+         * 	onCustomContentHandler: function(oItem) {
+         *
+         * 			return new Promise(function(resolve, reject) {
+         *
+         * 				switch (oItem.getMediaType().toLowerCase()) {
+         *
+         * 					case "application/xml":
+         *
+         * 						var oCodeEditor = new CodeEditor({
+         * 							value: "XML content",
+         * 							width: "100%",
+         * 							height: "100%"
+         * 						});
+         *
+         * 						resolve(oCodeEditor);
+         * 						break;
+         *
+         * 					default:
+         * 						reject(); // reject the promise to display the default illustrated message.
+         * 						break;
+         * 				}
+         * 			});
+         * 	}
+         * ```
+         *
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * @since 1.136
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setCustomPageContentHandler(
+          /**
+           * New value for property `customPageContentHandler`
+           */
+          fnCustomPageContentHandler?: Function
+        ): this;
         /**
          * Sets a new value for property {@link #getMaxFileSizeforPreview maxFileSizeforPreview}.
          *
@@ -20327,7 +20796,9 @@ declare namespace sap {
           oListener?: object
         ): this;
         /**
-         * Starts the process of downloading a file.
+         * Starts the process of downloading a file. Plugin uses the URL set in the item or the downloadUrl set
+         * in the uploader class to download the file. If the URL is not set, a warning is logged. API downloads
+         * the file with xhr response of blob type or string type.
          *
          *
          * @returns It returns true if the download is processed successfully
@@ -42958,7 +43429,8 @@ declare namespace sap {
         | `{${string}}`;
 
       /**
-       * Adds a priority badge before the content. Works only in Generic Tile ActionMode.
+       * Adds a priority badge before the content. Works only in Generic Tiles in ActionMode or Article Mode containing
+       * NewsContent.
        *
        * @since 1.96
        */
@@ -42968,7 +43440,8 @@ declare namespace sap {
         | `{${string}}`;
 
       /**
-       * Sets the Text inside the Priority badge in Generic Tile ActionMode.
+       * Sets the Text inside the Priority badge in Generic Tile. Works only in Generic Tiles in ActionMode or
+       * Article Mode containing NewsContent.
        *
        * @since 1.103
        */
@@ -91067,11 +91540,11 @@ declare namespace sap {
         /**
          * The reference docking location of the `Menu` for positioning the menu on the screen
          */
-        sDockMy?: sap.ui.core.Dock,
+        sDockMy?: sap.ui.core.Popup.Dock,
         /**
          * The `oControl` reference docking location for positioning the menu on the screen
          */
-        sDockAt?: sap.ui.core.Dock,
+        sDockAt?: sap.ui.core.Popup.Dock,
         /**
          * The offset relative to the docking point, specified as a string with space-separated pixel values (e.g.
          * "0 10" to move the popup 10 pixels to the right). If the docking of both "my" and "at" is RTL-sensitive
@@ -148798,7 +149271,8 @@ declare namespace sap {
       /**
        * Gets current value of property {@link #getPriority priority}.
        *
-       * Adds a priority badge before the content. Works only in Generic Tile ActionMode.
+       * Adds a priority badge before the content. Works only in Generic Tiles in ActionMode or Article Mode containing
+       * NewsContent.
        *
        * Default value is `None`.
        *
@@ -148810,7 +149284,8 @@ declare namespace sap {
       /**
        * Gets current value of property {@link #getPriorityText priorityText}.
        *
-       * Sets the Text inside the Priority badge in Generic Tile ActionMode.
+       * Sets the Text inside the Priority badge in Generic Tile. Works only in Generic Tiles in ActionMode or
+       * Article Mode containing NewsContent.
        *
        * @since 1.103
        *
@@ -148936,40 +149411,28 @@ declare namespace sap {
         sFrameType?: sap.m.FrameType
       ): this;
       /**
-       * Sets a new value for property {@link #getPriority priority}.
-       *
-       * Adds a priority badge before the content. Works only in Generic Tile ActionMode.
-       *
-       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       * Sets the priority of the tile content.
        *
-       * Default value is `None`.
        *
-       * @since 1.96
-       *
-       * @returns Reference to `this` in order to allow method chaining
+       * @returns Reference to the current instance for method chaining.
        */
       setPriority(
         /**
-         * New value for property `priority`
+         * The priority level.
          */
-        sPriority?: sap.m.Priority
+        sPriority: sap.m.Priority
       ): this;
       /**
-       * Sets a new value for property {@link #getPriorityText priorityText}.
+       * Sets the text for the priority badge.
        *
-       * Sets the Text inside the Priority badge in Generic Tile ActionMode.
-       *
-       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
-       * @since 1.103
-       *
-       * @returns Reference to `this` in order to allow method chaining
+       * @returns Reference to the current instance for method chaining.
        */
       setPriorityText(
         /**
-         * New value for property `priorityText`
+         * The text to be displayed on the badge.
          */
-        sPriorityText?: string
+        sPriorityText: string
       ): this;
       /**
        * Setter for protected property to enable or disable content rendering. This function does not invalidate
@@ -164350,19 +164813,19 @@ declare namespace sap {
        *
        * @since 1.136
        */
-      ExtraSmall = "Dot",
+      ExtraSmall = "ExtraSmall",
       /**
        * Large `Illustration` size. Alias for `Scene` size (L breakpoint). Suitable for a `Page` or a table.
        *
        * @since 1.136
        */
-      Large = "Scene",
+      Large = "Large",
       /**
        * Medium `Illustration` size. Alias for `Dialog` size (M breakpoint). Suitable for dialogs.
        *
        * @since 1.136
        */
-      Medium = "Dialog",
+      Medium = "Medium",
       /**
        * Scene `Illustration` size (L breakpoint). Suitable for a `Page` or a table.
        *
@@ -164374,7 +164837,7 @@ declare namespace sap {
        *
        * @since 1.136
        */
-      Small = "Spot",
+      Small = "Small",
       /**
        * Spot `Illustration` size (S breakpoint). Suitable for cards (four columns).
        *
@@ -169950,6 +170413,8 @@ declare namespace sap {
 
     "sap/m/plugins/CellSelector": undefined;
 
+    "sap/m/plugins/ColumnAIAction": undefined;
+
     "sap/m/plugins/ColumnResizer": undefined;
 
     "sap/m/plugins/ContextMenuSetting": undefined;