@sapui5/types 1.120.11 → 1.120.13

package/types/sap.uiext.inbox.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.11
+// For Library Version: 1.120.13
 
 declare module "sap/uiext/inbox/library" {}
 
@@ -80,7 +80,9 @@ declare module "sap/uiext/inbox/composite/InboxAddAttachmentTile" {
      */
     static getMetadata(): ElementMetadata;
   }
-
+  /**
+   * Describes the settings that can be provided to the InboxAddAttachmentTile constructor.
+   */
   export interface $InboxAddAttachmentTileSettings extends $ControlSettings {}
 }
 
@@ -649,7 +651,9 @@ declare module "sap/uiext/inbox/composite/InboxAttachmentsTileContainer" {
       sUploadUrl?: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the InboxAttachmentsTileContainer constructor.
+   */
   export interface $InboxAttachmentsTileContainerSettings
     extends $ControlSettings {
     /**
@@ -707,22 +711,40 @@ declare module "sap/uiext/inbox/composite/InboxAttachmentsTileContainer" {
     uploadFailed?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the InboxAttachmentsTileContainer#uploadButtonPress event.
+   */
   export interface InboxAttachmentsTileContainer$UploadButtonPressEventParameters {}
 
+  /**
+   * Event object of the InboxAttachmentsTileContainer#uploadButtonPress event.
+   */
   export type InboxAttachmentsTileContainer$UploadButtonPressEvent = Event<
     InboxAttachmentsTileContainer$UploadButtonPressEventParameters,
     InboxAttachmentsTileContainer
   >;
 
+  /**
+   * Parameters of the InboxAttachmentsTileContainer#uploadFailed event.
+   */
   export interface InboxAttachmentsTileContainer$UploadFailedEventParameters {}
 
+  /**
+   * Event object of the InboxAttachmentsTileContainer#uploadFailed event.
+   */
   export type InboxAttachmentsTileContainer$UploadFailedEvent = Event<
     InboxAttachmentsTileContainer$UploadFailedEventParameters,
     InboxAttachmentsTileContainer
   >;
 
+  /**
+   * Parameters of the InboxAttachmentsTileContainer#uploadSuccess event.
+   */
   export interface InboxAttachmentsTileContainer$UploadSuccessEventParameters {}
 
+  /**
+   * Event object of the InboxAttachmentsTileContainer#uploadSuccess event.
+   */
   export type InboxAttachmentsTileContainer$UploadSuccessEvent = Event<
     InboxAttachmentsTileContainer$UploadSuccessEventParameters,
     InboxAttachmentsTileContainer
@@ -1094,7 +1116,9 @@ declare module "sap/uiext/inbox/composite/InboxAttachmentTile" {
       bShowDeleteButton?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the InboxAttachmentTile constructor.
+   */
   export interface $InboxAttachmentTileSettings extends $ControlSettings {
     /**
      * Name of the attachment
@@ -1142,8 +1166,14 @@ declare module "sap/uiext/inbox/composite/InboxAttachmentTile" {
     deleteAttachment?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the InboxAttachmentTile#deleteAttachment event.
+   */
   export interface InboxAttachmentTile$DeleteAttachmentEventParameters {}
 
+  /**
+   * Event object of the InboxAttachmentTile#deleteAttachment event.
+   */
   export type InboxAttachmentTile$DeleteAttachmentEvent = Event<
     InboxAttachmentTile$DeleteAttachmentEventParameters,
     InboxAttachmentTile
@@ -1228,7 +1258,9 @@ declare module "sap/uiext/inbox/composite/InboxBusyIndicator" {
      */
     static getMetadata(): ElementMetadata;
   }
-
+  /**
+   * Describes the settings that can be provided to the InboxBusyIndicator constructor.
+   */
   export interface $InboxBusyIndicatorSettings extends $ControlSettings {}
 }
 
@@ -1458,7 +1490,9 @@ declare module "sap/uiext/inbox/composite/InboxComment" {
       sTimestamp?: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the InboxComment constructor.
+   */
   export interface $InboxCommentSettings extends $ControlSettings {
     /**
      * Sender of the comment chunk
@@ -1841,7 +1875,9 @@ declare module "sap/uiext/inbox/composite/InboxTaskComments" {
       bShowHeader?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the InboxTaskComments constructor.
+   */
   export interface $InboxTaskCommentsSettings extends $ControlSettings {
     /**
      * Sender for the comment feeder
@@ -1878,8 +1914,14 @@ declare module "sap/uiext/inbox/composite/InboxTaskComments" {
     commentSubmit?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the InboxTaskComments#commentSubmit event.
+   */
   export interface InboxTaskComments$CommentSubmitEventParameters {}
 
+  /**
+   * Event object of the InboxTaskComments#commentSubmit event.
+   */
   export type InboxTaskComments$CommentSubmitEvent = Event<
     InboxTaskComments$CommentSubmitEventParameters,
     InboxTaskComments
@@ -2091,7 +2133,9 @@ declare module "sap/uiext/inbox/composite/InboxTaskTitleControl" {
       oTitleLink: Control
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the InboxTaskTitleControl constructor.
+   */
   export interface $InboxTaskTitleControlSettings extends $ControlSettings {
     /**
      * The Task Title of the Task
@@ -2331,7 +2375,9 @@ declare module "sap/uiext/inbox/composite/InboxUploadAttachmentTile" {
       sFileTypeIcon?: URI
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the InboxUploadAttachmentTile constructor.
+   */
   export interface $InboxUploadAttachmentTileSettings extends $ControlSettings {
     /**
      * name of the selected file
@@ -2349,8 +2395,14 @@ declare module "sap/uiext/inbox/composite/InboxUploadAttachmentTile" {
     uploadSelectedFile?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the InboxUploadAttachmentTile#uploadSelectedFile event.
+   */
   export interface InboxUploadAttachmentTile$UploadSelectedFileEventParameters {}
 
+  /**
+   * Event object of the InboxUploadAttachmentTile#uploadSelectedFile event.
+   */
   export type InboxUploadAttachmentTile$UploadSelectedFileEvent = Event<
     InboxUploadAttachmentTile$UploadSelectedFileEventParameters,
     InboxUploadAttachmentTile
@@ -3008,7 +3060,12 @@ declare module "sap/uiext/inbox/Inbox" {
       sTaskExecutionURLThemeValue?: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the Inbox constructor.
+   *
+   * @deprecated (since 1.38.0)
+   * @experimental (since 1.5.2) - API is not yet finished and might change completely
+   */
   export interface $InboxSettings extends $ControlSettings {
     /**
      * set the theme URL parameter string to be appended to the task Execution URL. In case of a function callback
@@ -3051,26 +3108,50 @@ declare module "sap/uiext/inbox/Inbox" {
     taskSelectionChange?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the Inbox#oDataRequestCompleted event.
+   */
   export interface Inbox$ODataRequestCompletedEventParameters {}
 
+  /**
+   * Event object of the Inbox#oDataRequestCompleted event.
+   */
   export type Inbox$ODataRequestCompletedEvent = Event<
     Inbox$ODataRequestCompletedEventParameters,
     Inbox
   >;
 
+  /**
+   * Parameters of the Inbox#refresh event.
+   */
   export interface Inbox$RefreshEventParameters {}
 
+  /**
+   * Event object of the Inbox#refresh event.
+   */
   export type Inbox$RefreshEvent = Event<Inbox$RefreshEventParameters, Inbox>;
 
+  /**
+   * Parameters of the Inbox#taskAction event.
+   */
   export interface Inbox$TaskActionEventParameters {}
 
+  /**
+   * Event object of the Inbox#taskAction event.
+   */
   export type Inbox$TaskActionEvent = Event<
     Inbox$TaskActionEventParameters,
     Inbox
   >;
 
+  /**
+   * Parameters of the Inbox#taskSelectionChange event.
+   */
   export interface Inbox$TaskSelectionChangeEventParameters {}
 
+  /**
+   * Event object of the Inbox#taskSelectionChange event.
+   */
   export type Inbox$TaskSelectionChangeEvent = Event<
     Inbox$TaskSelectionChangeEventParameters,
     Inbox
@@ -3576,7 +3657,11 @@ declare module "sap/uiext/inbox/InboxLaunchPad" {
       sUserName?: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the InboxLaunchPad constructor.
+   *
+   * @experimental (since 1.7.0) - API is not yet finished and might change completely
+   */
   export interface $InboxLaunchPadSettings extends $ControlSettings {
     /**
      * The title text appearing in Inbox LaunchPad header bar.
@@ -3616,15 +3701,27 @@ declare module "sap/uiext/inbox/InboxLaunchPad" {
     logout?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the InboxLaunchPad#logout event.
+   */
   export interface InboxLaunchPad$LogoutEventParameters {}
 
+  /**
+   * Event object of the InboxLaunchPad#logout event.
+   */
   export type InboxLaunchPad$LogoutEvent = Event<
     InboxLaunchPad$LogoutEventParameters,
     InboxLaunchPad
   >;
 
+  /**
+   * Parameters of the InboxLaunchPad#tileSelected event.
+   */
   export interface InboxLaunchPad$TileSelectedEventParameters {}
 
+  /**
+   * Event object of the InboxLaunchPad#tileSelected event.
+   */
   export type InboxLaunchPad$TileSelectedEvent = Event<
     InboxLaunchPad$TileSelectedEventParameters,
     InboxLaunchPad
@@ -4159,7 +4256,11 @@ declare module "sap/uiext/inbox/InboxSplitApp" {
       sTcmServiceURL?: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the InboxSplitApp constructor.
+   *
+   * @experimental (since 1.7.0) - API is not yet finished and might change completely
+   */
   export interface $InboxSplitAppSettings extends $ControlSettings {
     /**
      * Show/Hide the Navigation Button for the Master Page
@@ -4192,8 +4293,14 @@ declare module "sap/uiext/inbox/InboxSplitApp" {
     navButtonPressed?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the InboxSplitApp#navButtonPressed event.
+   */
   export interface InboxSplitApp$NavButtonPressedEventParameters {}
 
+  /**
+   * Event object of the InboxSplitApp#navButtonPressed event.
+   */
   export type InboxSplitApp$NavButtonPressedEvent = Event<
     InboxSplitApp$NavButtonPressedEventParameters,
     InboxSplitApp
@@ -4289,7 +4396,11 @@ declare module "sap/uiext/inbox/SubstitutionRulesManager" {
       path: string
     ): SubstitutionRulesManager;
   }
-
+  /**
+   * Describes the settings that can be provided to the SubstitutionRulesManager constructor.
+   *
+   * @experimental (since 1.7.0) - API is not yet finished and might change completely
+   */
   export interface $SubstitutionRulesManagerSettings extends $ControlSettings {}
 }
 

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.11
+// For Library Version: 1.120.13
 
 declare module "sap/ushell/library" {
   /**
@@ -262,7 +262,16 @@ declare module "sap/ushell/components/factsheet/controls/PictureTile" {
       sWidth?: CSSSize
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the PictureTile constructor.
+   *
+   * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead.
+   *
+   * PictureTile is used in PictureViewer control and is not meant to be consumed outside of PictureViewer
+   * usage. PictureViewer was replacing the sap.m.Carousel as it wasn't supporting some versions of MS Internet
+   * Explorer. Now, the sap.m.Carousel is fully functional, please use sap.m.Carousel instead. This control
+   * will not be supported anymore.
+   */
   export interface $PictureTileSettings extends $CustomTileSettings {
     height?: CSSSize | PropertyBindingInfo | `{${string}}`;
 
@@ -273,8 +282,14 @@ declare module "sap/ushell/components/factsheet/controls/PictureTile" {
     pictureDelete?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the PictureTile#pictureDelete event.
+   */
   export interface PictureTile$PictureDeleteEventParameters {}
 
+  /**
+   * Event object of the PictureTile#pictureDelete event.
+   */
   export type PictureTile$PictureDeleteEvent = Event<
     PictureTile$PictureDeleteEventParameters,
     PictureTile
@@ -617,7 +632,13 @@ declare module "sap/ushell/components/factsheet/controls/PictureViewer" {
       fTileScaling?: float
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the PictureViewer constructor.
+   *
+   * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead. PictureViewer was replacing the
+   * Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully
+   * functional, please use sap.m.Carousel instead. This control will not be supported anymore.
+   */
   export interface $PictureViewerSettings extends $TileContainerSettings {
     /**
      * Percentage of the space occupied by the image in the picture viewer control. Please note that if the
@@ -636,8 +657,14 @@ declare module "sap/ushell/components/factsheet/controls/PictureViewer" {
     pictureDeleted?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the PictureViewer#pictureDeleted event.
+   */
   export interface PictureViewer$PictureDeletedEventParameters {}
 
+  /**
+   * Event object of the PictureViewer#pictureDeleted event.
+   */
   export type PictureViewer$PictureDeletedEvent = Event<
     PictureViewer$PictureDeletedEventParameters,
     PictureViewer
@@ -769,7 +796,14 @@ declare module "sap/ushell/components/factsheet/controls/PictureViewerItem" {
       sSrc: string
     ): PictureViewerItem;
   }
-
+  /**
+   * Describes the settings that can be provided to the PictureViewerItem constructor.
+   *
+   * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead. PictureViewerItem is used in PictureViewer
+   * control and is not meant to be consumed outside of PictureViewer usage. PictureViewer was replacing the
+   * Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully
+   * functional, please use sap.m.Carousel instead. This control will not be supported anymore.
+   */
   export interface $PictureViewerItemSettings extends $ControlSettings {
     src?: string | PropertyBindingInfo;
 
@@ -2606,7 +2640,11 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
       aStates: string[]
     ): void;
   }
-
+  /**
+   * Describes the settings that can be provided to the Renderer constructor.
+   *
+   * @deprecated (since 1.120.0) - Please use {@link sap.ushell.services.Extension} instead.
+   */
   export interface $RendererSettings extends $UIComponentSettings {}
 }
 
@@ -9054,7 +9092,11 @@ declare module "sap/ushell/ui/appfinder/AppBox" {
       sUrl?: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the AppBox constructor.
+   *
+   * @deprecated (since 1.120)
+   */
   export interface $AppBoxSettings extends $ControlSettings {
     /**
      * Specifies the title of the appBox.
@@ -9097,15 +9139,27 @@ declare module "sap/ushell/ui/appfinder/AppBox" {
     afterRendering?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the AppBox#afterRendering event.
+   */
   export interface AppBox$AfterRenderingEventParameters {}
 
+  /**
+   * Event object of the AppBox#afterRendering event.
+   */
   export type AppBox$AfterRenderingEvent = Event<
     AppBox$AfterRenderingEventParameters,
     AppBox
   >;
 
+  /**
+   * Parameters of the AppBox#press event.
+   */
   export interface AppBox$PressEventParameters {}
 
+  /**
+   * Event object of the AppBox#press event.
+   */
   export type AppBox$PressEvent = Event<AppBox$PressEventParameters, AppBox>;
 }
 
@@ -9571,7 +9625,9 @@ declare module "sap/ushell/ui/footerbar/AddBookmarkButton" {
       sTitle?: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the AddBookmarkButton constructor.
+   */
   export interface $AddBookmarkButtonSettings extends $ButtonSettings {
     /**
      * A callback function that is called before the save-as-tile dialog is opened.
@@ -9912,7 +9968,9 @@ declare module "sap/ushell/ui/launchpad/ActionItem" {
       sActionType?: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ActionItem constructor.
+   */
   export interface $ActionItemSettings extends $ButtonSettings {
     actionType?: string | PropertyBindingInfo;
 
@@ -9921,16 +9979,28 @@ declare module "sap/ushell/ui/launchpad/ActionItem" {
     afterRendering?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the ActionItem#afterRendering event.
+   */
   export interface ActionItem$AfterRenderingEventParameters {}
 
+  /**
+   * Event object of the ActionItem#afterRendering event.
+   */
   export type ActionItem$AfterRenderingEvent = Event<
     ActionItem$AfterRenderingEventParameters,
     ActionItem
   >;
 
+  /**
+   * Parameters of the ActionItem#press event.
+   */
   export interface ActionItem$PressEventParameters
     extends Button$PressEventParameters {}
 
+  /**
+   * Event object of the ActionItem#press event.
+   */
   export type ActionItem$PressEvent = Event<
     ActionItem$PressEventParameters,
     ActionItem
@@ -10216,7 +10286,11 @@ declare module "sap/ushell/ui/launchpad/DashboardGroupsContainer" {
       sDisplayMode?: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the DashboardGroupsContainer constructor.
+   *
+   * @deprecated (since 1.120)
+   */
   export interface $DashboardGroupsContainerSettings extends $ControlSettings {
     /**
      * A value for an optional accessibility label.
@@ -10230,8 +10304,14 @@ declare module "sap/ushell/ui/launchpad/DashboardGroupsContainer" {
     afterRendering?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the DashboardGroupsContainer#afterRendering event.
+   */
   export interface DashboardGroupsContainer$AfterRenderingEventParameters {}
 
+  /**
+   * Event object of the DashboardGroupsContainer#afterRendering event.
+   */
   export type DashboardGroupsContainer$AfterRenderingEvent = Event<
     DashboardGroupsContainer$AfterRenderingEventParameters,
     DashboardGroupsContainer
@@ -11007,7 +11087,11 @@ declare module "sap/ushell/ui/launchpad/LinkTileWrapper" {
       bVisible?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the LinkTileWrapper constructor.
+   *
+   * @deprecated (since 1.120)
+   */
   export interface $LinkTileWrapperSettings extends $ControlSettings {
     uuid?: string | PropertyBindingInfo;
 
@@ -11042,29 +11126,53 @@ declare module "sap/ushell/ui/launchpad/LinkTileWrapper" {
     showActions?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the LinkTileWrapper#afterRendering event.
+   */
   export interface LinkTileWrapper$AfterRenderingEventParameters {}
 
+  /**
+   * Event object of the LinkTileWrapper#afterRendering event.
+   */
   export type LinkTileWrapper$AfterRenderingEvent = Event<
     LinkTileWrapper$AfterRenderingEventParameters,
     LinkTileWrapper
   >;
 
+  /**
+   * Parameters of the LinkTileWrapper#coverDivPress event.
+   */
   export interface LinkTileWrapper$CoverDivPressEventParameters {}
 
+  /**
+   * Event object of the LinkTileWrapper#coverDivPress event.
+   */
   export type LinkTileWrapper$CoverDivPressEvent = Event<
     LinkTileWrapper$CoverDivPressEventParameters,
     LinkTileWrapper
   >;
 
+  /**
+   * Parameters of the LinkTileWrapper#press event.
+   */
   export interface LinkTileWrapper$PressEventParameters {}
 
+  /**
+   * Event object of the LinkTileWrapper#press event.
+   */
   export type LinkTileWrapper$PressEvent = Event<
     LinkTileWrapper$PressEventParameters,
     LinkTileWrapper
   >;
 
+  /**
+   * Parameters of the LinkTileWrapper#showActions event.
+   */
   export interface LinkTileWrapper$ShowActionsEventParameters {}
 
+  /**
+   * Event object of the LinkTileWrapper#showActions event.
+   */
   export type LinkTileWrapper$ShowActionsEvent = Event<
     LinkTileWrapper$ShowActionsEventParameters,
     LinkTileWrapper
@@ -11248,15 +11356,25 @@ declare module "sap/ushell/ui/launchpad/TileState" {
       sState?: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the TileState constructor.
+   *
+   * @deprecated (since 1.120)
+   */
   export interface $TileStateSettings extends $ControlSettings {
     state?: string | PropertyBindingInfo;
 
     press?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the TileState#press event.
+   */
   export interface TileState$PressEventParameters {}
 
+  /**
+   * Event object of the TileState#press event.
+   */
   export type TileState$PressEvent = Event<
     TileState$PressEventParameters,
     TileState
@@ -11663,7 +11781,9 @@ declare module "sap/ushell/ui/shell/ToolAreaItem" {
       bVisible?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ToolAreaItem constructor.
+   */
   export interface $ToolAreaItemSettings extends $ControlSettings {
     /**
      * Icon that is displayed in the item.
@@ -11707,15 +11827,27 @@ declare module "sap/ushell/ui/shell/ToolAreaItem" {
     expand?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the ToolAreaItem#expand event.
+   */
   export interface ToolAreaItem$ExpandEventParameters {}
 
+  /**
+   * Event object of the ToolAreaItem#expand event.
+   */
   export type ToolAreaItem$ExpandEvent = Event<
     ToolAreaItem$ExpandEventParameters,
     ToolAreaItem
   >;
 
+  /**
+   * Parameters of the ToolAreaItem#press event.
+   */
   export interface ToolAreaItem$PressEventParameters {}
 
+  /**
+   * Event object of the ToolAreaItem#press event.
+   */
   export type ToolAreaItem$PressEvent = Event<
     ToolAreaItem$PressEventParameters,
     ToolAreaItem
@@ -11828,6 +11960,9 @@ declare module "sap/ushell/ui5service/UserStatus" {
     getMetadata(): Metadata;
   }
   const UserStatus: UserStatus;
+  /**
+   * @deprecated (since 1.70) - Support for this service has been discontinued.
+   */
   export default UserStatus;
 }
 

package/types/sap.ushell_abap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.11
+// For Library Version: 1.120.13
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {