@sapui5/types 1.122.2 → 1.123.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.122.1
+// For Library Version: 1.123.0
 
 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 {}
 }