@sapui5/types 1.116.0 → 1.117.0

package/types/sap.ui.dt.d.ts

@@ -1,3 +1,3 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
 declare namespace sap {}

package/types/sap.ui.export.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
 declare module "sap/ui/export/library" {
   /**
@@ -60,6 +60,12 @@ declare module "sap/ui/export/library" {
    * File types for document export.
    */
   export enum FileType {
+    /**
+     * @since 1.117
+     *
+     * Portable Document Format (PDF) file type.
+     */
+    PDF = "PDF",
     /**
      * Office Open XML - SpreadsheetML file type.
      */
@@ -255,7 +261,199 @@ declare module "sap/ui/export/ExportBase" {
 
   export interface ExportBase$BeforeExportEventParameters {}
 
-  export type ExportBase$BeforeExportEvent = Event<ExportBase$BeforeExportEventParameters>;
+  export type ExportBase$BeforeExportEvent = Event<
+    ExportBase$BeforeExportEventParameters,
+    ExportBase
+  >;
+}
+
+declare module "sap/ui/export/ExportHandler" {
+  import EventProvider from "sap/ui/base/EventProvider";
+
+  import Metadata from "sap/ui/base/Metadata";
+
+  import Filter from "sap/ui/export/util/Filter";
+
+  import Event from "sap/ui/base/Event";
+
+  /**
+   * @since 1.102
+   *
+   * The `sap.ui.export.ExportHandler` class allows you to export table data from an SAPUI5 application.
+   */
+  export default class ExportHandler extends EventProvider {
+    /**
+     * Any export-related functionality is encapsulated in the `ExportHandler` that also stores user settings
+     * throughout the session.
+     */
+    constructor(
+      /**
+       * `ExportHandler` capabilities that define supported file types and features
+       */
+      mCapabilities: object
+    );
+
+    /**
+     * Creates a new subclass of class sap.ui.export.ExportHandler 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.EventProvider.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, ExportHandler>,
+      /**
+       * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+       * used by this class
+       */
+      FNMetaImpl?: Function
+    ): Function;
+    /**
+     * Returns a metadata object for class sap.ui.export.ExportHandler.
+     *
+     * @returns Metadata object describing this class
+     */
+    static getMetadata(): Metadata;
+    /**
+     * @since 1.102
+     *
+     * Attaches event handler `fnFunction` to the {@link sap.ui.export.ExportHandler#event:beforeExport} event
+     * of this `sap.ui.export.ExportHandler`.
+     *  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.ui.export.ExportHandler` itself.
+     *  This event is fired just before the export process is started.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachBeforeExport(
+      /**
+       * 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
+       */
+      fnHandler: Function,
+      /**
+       * Context object to call the event handler with; defaults to this `sap.ui.export.ExportHandler` instance
+       * itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * @since 1.102
+     *
+     * Attaches event handler `fnFunction` to the {@link sap.ui.export.ExportHandler#event:beforeExport} event
+     * of this `sap.ui.export.ExportHandler`.
+     *  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.ui.export.ExportHandler` itself.
+     *  This event is fired just before the export process is started.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachBeforeExport(
+      /**
+       * The function to be called when the event occurs
+       */
+      fnHandler: Function,
+      /**
+       * Context object to call the event handler with; defaults to this `sap.ui.export.ExportHandler` instance
+       * itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Cleans up the internal structures and removes all event handlers.
+     *
+     * The object must not be used anymore after destroy was called.
+     * See:
+     * 	sap.ui.base.Object#destroy
+     */
+    destroy(): void;
+    /**
+     * @since 1.102
+     *
+     * Detaches event handler `fnFunction` from the {@link sap.ui.export.ExportHandler#event:beforeExport} event
+     * of this `sap.ui.export.ExportHandler`.
+     *  The passed function and listener object must match the ones used for event registration.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    detachBeforeExport(
+      /**
+       * The function to be called when the event occurs
+       */
+      fnHandler: Function,
+      /**
+       * Context object on which the given function had to be called
+       */
+      oListener?: object
+    ): this;
+    /**
+     * @since 1.102
+     *
+     * Exports the data as defined via parameter. The function returns a `Promise` that will be resolved after
+     * the export process has been finished. In case of an error, its message will be shown in a `Dialog`, and
+     * the `Promise` will be rejected.
+     *
+     * @returns A `Promise` that gets resolved after the export process has been finished
+     */
+    export(
+      /**
+       * Export settings that are used for the export
+       */
+      mExportSettings: object
+    ): Promise<any>;
+    /**
+     * @since 1.102
+     *
+     * Exports the data as defined by the user. This function will show an export settings dialog where the
+     * user can define certain settings that influence the output of the export functionality.
+     *
+     * @returns A `Promise` that resolves once the data has been exported
+     */
+    exportAs(
+      /**
+       * General export settings containing `workbook` and `dataSource` information
+       */
+      oSettings: object,
+      /**
+       * Resolves the label for a particular column that is not directly contained in the export settings
+       */
+      fnResolveColumnLabel?: Function
+    ): Promise<any>;
+  }
+
+  export interface ExportHandler$BeforeExportEventParameters {
+    /**
+     * Contains export-related configuration
+     */
+    exportSettings?: object;
+
+    /**
+     * User-specific settings from the Export As dialog
+     */
+    userExportSettings?: object;
+
+    /**
+     * Array of filter settings for the exported data
+     */
+    filterSettings?: Filter[];
+  }
+
+  export type ExportHandler$BeforeExportEvent = Event<
+    ExportHandler$BeforeExportEventParameters,
+    ExportHandler
+  >;
 }
 
 declare module "sap/ui/export/Spreadsheet" {
@@ -674,7 +872,10 @@ declare module "sap/ui/export/Spreadsheet" {
 
   export interface Spreadsheet$BeforeSaveEventParameters {}
 
-  export type Spreadsheet$BeforeSaveEvent = Event<Spreadsheet$BeforeSaveEventParameters>;
+  export type Spreadsheet$BeforeSaveEvent = Event<
+    Spreadsheet$BeforeSaveEventParameters,
+    Spreadsheet
+  >;
 }
 
 declare module "sap/ui/export/util/Filter" {

package/types/sap.ui.fl.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
 declare module "sap/ui/fl/library" {}
 
@@ -1179,11 +1179,17 @@ declare module "sap/ui/fl/variants/VariantManagement" {
 
   export interface VariantManagement$CancelEventParameters {}
 
-  export type VariantManagement$CancelEvent = Event<VariantManagement$CancelEventParameters>;
+  export type VariantManagement$CancelEvent = Event<
+    VariantManagement$CancelEventParameters,
+    VariantManagement
+  >;
 
   export interface VariantManagement$InitializedEventParameters {}
 
-  export type VariantManagement$InitializedEvent = Event<VariantManagement$InitializedEventParameters>;
+  export type VariantManagement$InitializedEvent = Event<
+    VariantManagement$InitializedEventParameters,
+    VariantManagement
+  >;
 
   export interface VariantManagement$ManageEventParameters {
     /**
@@ -1208,7 +1214,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
     def?: string;
   }
 
-  export type VariantManagement$ManageEvent = Event<VariantManagement$ManageEventParameters>;
+  export type VariantManagement$ManageEvent = Event<
+    VariantManagement$ManageEventParameters,
+    VariantManagement
+  >;
 
   export interface VariantManagement$SaveEventParameters {
     /**
@@ -1249,7 +1258,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
     tile?: boolean;
   }
 
-  export type VariantManagement$SaveEvent = Event<VariantManagement$SaveEventParameters>;
+  export type VariantManagement$SaveEvent = Event<
+    VariantManagement$SaveEventParameters,
+    VariantManagement
+  >;
 
   export interface VariantManagement$SelectEventParameters {
     /**
@@ -1258,7 +1270,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
     key?: string;
   }
 
-  export type VariantManagement$SelectEvent = Event<VariantManagement$SelectEventParameters>;
+  export type VariantManagement$SelectEvent = Event<
+    VariantManagement$SelectEventParameters,
+    VariantManagement
+  >;
 }
 
 declare module "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVariant" {

package/types/sap.ui.generic.app.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
 declare module "sap/ui/generic/app/library" {
   export namespace navigation {

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

@@ -1,3 +1,3 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
 declare namespace sap {}

package/types/sap.ui.integration.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
 declare module "sap/ui/integration/library" {
   import { URI } from "sap/ui/core/library";
@@ -600,7 +600,10 @@ declare module "sap/ui/integration/ActionDefinition" {
 
   export interface ActionDefinition$PressEventParameters {}
 
-  export type ActionDefinition$PressEvent = Event<ActionDefinition$PressEventParameters>;
+  export type ActionDefinition$PressEvent = Event<
+    ActionDefinition$PressEventParameters,
+    ActionDefinition
+  >;
 }
 
 declare module "sap/ui/integration/widgets/Card" {
@@ -1468,6 +1471,12 @@ declare module "sap/ui/integration/widgets/Card" {
        */
       eCardArea?: CardArea | keyof typeof CardArea
     ): void;
+    /**
+     * @experimental (since 1.117)
+     *
+     * Hides the message previously shown by showMessage.
+     */
+    hideMessage(): void;
     /**
      * @since 1.85
      * @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
@@ -2010,6 +2019,12 @@ declare module "sap/ui/integration/widgets/Card" {
        */
       eCardArea?: CardArea | keyof typeof CardArea
     ): void;
+    /**
+     * @experimental (since 1.117)
+     *
+     * Hides the message previously shown by showMessage.
+     */
+    hideMessage(): void;
     /**
      * @since 1.85
      * @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
@@ -2410,7 +2425,7 @@ declare module "sap/ui/integration/widgets/Card" {
     type?: CardActionType | keyof typeof CardActionType;
   }
 
-  export type Card$ActionEvent = Event<Card$ActionEventParameters>;
+  export type Card$ActionEvent = Event<Card$ActionEventParameters, Card>;
 
   export interface Card$ConfigurationChangeEventParameters {
     /**
@@ -2428,19 +2443,31 @@ declare module "sap/ui/integration/widgets/Card" {
     changes?: object;
   }
 
-  export type Card$ConfigurationChangeEvent = Event<Card$ConfigurationChangeEventParameters>;
+  export type Card$ConfigurationChangeEvent = Event<
+    Card$ConfigurationChangeEventParameters,
+    Card
+  >;
 
   export interface Card$ManifestAppliedEventParameters {}
 
-  export type Card$ManifestAppliedEvent = Event<Card$ManifestAppliedEventParameters>;
+  export type Card$ManifestAppliedEvent = Event<
+    Card$ManifestAppliedEventParameters,
+    Card
+  >;
 
   export interface Card$ManifestReadyEventParameters {}
 
-  export type Card$ManifestReadyEvent = Event<Card$ManifestReadyEventParameters>;
+  export type Card$ManifestReadyEvent = Event<
+    Card$ManifestReadyEventParameters,
+    Card
+  >;
 
   export interface Card$StateChangedEventParameters {}
 
-  export type Card$StateChangedEvent = Event<Card$StateChangedEventParameters>;
+  export type Card$StateChangedEvent = Event<
+    Card$StateChangedEventParameters,
+    Card
+  >;
 }
 
 declare module "sap/ui/integration/Designtime" {
@@ -3187,6 +3214,25 @@ declare module "sap/ui/integration/Extension" {
      * Called after the card is initialized.
      */
     onCardReady(): void;
+    /**
+     * @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
+     * @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
+     * may be done before its official public release. Use at your own discretion.
+     *
+     * Sets a new value for property {@link #getActions actions}.
+     *
+     * The actions configuration.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setActions(
+      /**
+       * New value for property `actions`
+       */
+      sActions: CardMenuAction[]
+    ): this;
     /**
      * Sets current value of property {@link #setFormatters formatters}.
      *
@@ -3260,7 +3306,10 @@ declare module "sap/ui/integration/Extension" {
     type?: CardActionType | keyof typeof CardActionType;
   }
 
-  export type Extension$ActionEvent = Event<Extension$ActionEventParameters>;
+  export type Extension$ActionEvent = Event<
+    Extension$ActionEventParameters,
+    Extension
+  >;
 }
 
 declare module "sap/ui/integration/Host" {
@@ -4057,7 +4106,7 @@ declare module "sap/ui/integration/Host" {
     type?: CardActionType | keyof typeof CardActionType;
   }
 
-  export type Host$ActionEvent = Event<Host$ActionEventParameters>;
+  export type Host$ActionEvent = Event<Host$ActionEventParameters, Host>;
 
   export interface Host$CardConfigurationChangeEventParameters {
     /**
@@ -4080,7 +4129,10 @@ declare module "sap/ui/integration/Host" {
     changes?: object;
   }
 
-  export type Host$CardConfigurationChangeEvent = Event<Host$CardConfigurationChangeEventParameters>;
+  export type Host$CardConfigurationChangeEvent = Event<
+    Host$CardConfigurationChangeEventParameters,
+    Host
+  >;
 
   export interface Host$CardInitializedEventParameters {
     /**
@@ -4089,7 +4141,10 @@ declare module "sap/ui/integration/Host" {
     card?: Control;
   }
 
-  export type Host$CardInitializedEvent = Event<Host$CardInitializedEventParameters>;
+  export type Host$CardInitializedEvent = Event<
+    Host$CardInitializedEventParameters,
+    Host
+  >;
 
   export interface Host$CardStateChangedEventParameters {
     /**
@@ -4098,13 +4153,16 @@ declare module "sap/ui/integration/Host" {
     card?: Control;
   }
 
-  export type Host$CardStateChangedEvent = Event<Host$CardStateChangedEventParameters>;
+  export type Host$CardStateChangedEvent = Event<
+    Host$CardStateChangedEventParameters,
+    Host
+  >;
 
   export interface Host$MessageEventParameters {
     data?: object;
   }
 
-  export type Host$MessageEvent = Event<Host$MessageEventParameters>;
+  export type Host$MessageEvent = Event<Host$MessageEventParameters, Host>;
 }
 
 declare namespace sap {