@openui5/ts-types 1.120.10 → 1.120.12

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.10
+// For Library Version: 1.120.12
 
 declare namespace sap {
   namespace ui {
@@ -33,6 +33,11 @@ declare namespace sap {
         __implements__sap_ui_ux3_DataSetView: boolean;
       }
 
+      /**
+       * Describes the settings that can be provided to the ActionBar constructor.
+       *
+       * @deprecated (since 1.38) - Instead, use the `sap.m.Toolbar` or `sap.m.OverflowToolbar` control.
+       */
       interface $ActionBarSettings extends sap.ui.core.$ControlSettings {
         /**
          * Keeps track of the actionBars Follow/Unfollow button’s state. Its value is one of - FollowActionState.Default
@@ -159,6 +164,11 @@ declare namespace sap {
         feedSubmit?: (oEvent: ActionBar$FeedSubmitEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Collection constructor.
+       *
+       * @deprecated (since 1.38)
+       */
       interface $CollectionSettings extends sap.ui.core.$ElementSettings {
         /**
          * Name for the collection
@@ -206,6 +216,11 @@ declare namespace sap {
         propertyChanged?: (oEvent: sap.ui.base.Event) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the CollectionInspector constructor.
+       *
+       * @deprecated (since 1.38)
+       */
       interface $CollectionInspectorSettings
         extends sap.ui.core.$ControlSettings {
         /**
@@ -263,6 +278,11 @@ declare namespace sap {
         editCollection?: (oEvent: sap.ui.base.Event) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the DataSet constructor.
+       *
+       * @deprecated (since 1.38) - Use a container by choice from the {@link sap.m} library, instead.
+       */
       interface $DataSetSettings extends sap.ui.core.$ControlSettings {
         /**
          * show Toolbar
@@ -339,6 +359,11 @@ declare namespace sap {
         search?: (oEvent: DataSet$SearchEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the DataSetItem constructor.
+       *
+       * @deprecated (since 1.38)
+       */
       interface $DataSetItemSettings extends sap.ui.core.$ElementSettings {
         /**
          * image
@@ -372,6 +397,11 @@ declare namespace sap {
         selected?: (oEvent: DataSetItem$SelectedEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the DataSetSimpleView constructor.
+       *
+       * @deprecated (since 1.38) - Use a layout by choice from the {@link sap.m} library, instead.
+       */
       interface $DataSetSimpleViewSettings
         extends sap.ui.core.$ControlSettings {
         /**
@@ -483,6 +513,12 @@ declare namespace sap {
         template?: sap.ui.core.Control;
       }
 
+      /**
+       * Describes the settings that can be provided to the Exact constructor.
+       *
+       * @deprecated (since 1.38)
+       * @experimental (since 1.2) - API is not yet finished and might change completely
+       */
       interface $ExactSettings extends sap.ui.core.$ControlSettings {
         /**
          * A title text which is displayed above the result section
@@ -514,6 +550,12 @@ declare namespace sap {
         refineSearch?: (oEvent: Exact$RefineSearchEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the ExactArea constructor.
+       *
+       * @deprecated (since 1.38)
+       * @experimental (since 1.6) - API is not yet finished and might change completely
+       */
       interface $ExactAreaSettings extends sap.ui.core.$ControlSettings {
         /**
          * Specifies whether the tool bar shall be visible
@@ -542,6 +584,11 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the ExactAttribute constructor.
+       *
+       * @deprecated (since 1.38)
+       */
       interface $ExactAttributeSettings extends sap.ui.core.$ElementSettings {
         /**
          * The attribute name
@@ -636,6 +683,11 @@ declare namespace sap {
         ) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the ExactBrowser constructor.
+       *
+       * @deprecated (since 1.38)
+       */
       interface $ExactBrowserSettings extends sap.ui.core.$ControlSettings {
         /**
          * Title text in the list area of the Exact Browser. The title is not shown when the property showTopList
@@ -754,6 +806,11 @@ declare namespace sap {
         save?: (oEvent: sap.ui.base.Event) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the ExactList constructor.
+       *
+       * @deprecated (since 1.38)
+       */
       interface $ExactListSettings extends sap.ui.core.$ControlSettings {
         /**
          * Defines whether the close icon shall be displayed in the header.
@@ -797,6 +854,11 @@ declare namespace sap {
         attributeSelected?: (oEvent: ExactList$AttributeSelectedEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the FacetFilter constructor.
+       *
+       * @deprecated (since 1.38) - replaced by {@link sap.m.FacetFilter}
+       */
       interface $FacetFilterSettings extends sap.ui.core.$ControlSettings {
         /**
          * If the value is "Auto" - the Facet Filter takes the whole available height. If "Fixed" , then the default
@@ -817,6 +879,11 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the FacetFilterList constructor.
+       *
+       * @deprecated (since 1.38) - replaced by {@link sap.m.FacetFilter}
+       */
       interface $FacetFilterListSettings extends sap.ui.core.$ControlSettings {
         /**
          * The title of this list.
@@ -873,6 +940,14 @@ declare namespace sap {
         select?: (oEvent: FacetFilterList$SelectEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Feed constructor.
+       *
+       * @deprecated (since 1.38) - Instead, use **any** `sap.ui.layout` container control.
+       * @experimental (since 1.2) - The whole Feed/Feeder API is still under discussion, significant changes
+       * are likely. Especially text presentation (e.g. @-references and formatted text) is not final. Also the
+       * Feed model topic is still open.
+       */
       interface $FeedSettings extends sap.ui.core.$ControlSettings {
         /**
          * The path to the thumbnail image used for the feeder
@@ -953,6 +1028,14 @@ declare namespace sap {
         toggleLive?: (oEvent: Feed$ToggleLiveEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the FeedChunk constructor.
+       *
+       * @deprecated (since 1.38) - Instead, use the `sap.m.FeedListItem` control.
+       * @experimental (since 1.2) - The whole Feed/Feeder API is still under discussion, significant changes
+       * are likely. Especially text presentation (e.g. @-references and formatted text) is not final. Also the
+       * Feed model topic is still open.
+       */
       interface $FeedChunkSettings extends sap.ui.core.$ControlSettings {
         /**
          * URL to the thumbnail image.
@@ -1146,6 +1229,14 @@ declare namespace sap {
         ) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Feeder constructor.
+       *
+       * @deprecated (since 1.38) - Instead, use the `sap.m.FeedInput` control.
+       * @experimental (since 1.2) - The whole Feed/Feeder API is still under discussion, significant changes
+       * are likely. Especially text presentation (e.g. @-references and formatted text) is not final. Also the
+       * Feed model topic is still open.
+       */
       interface $FeederSettings extends sap.ui.core.$ControlSettings {
         /**
          * URL to the thumb nail image This property is optional if the feeder is a sub-control of a feed or a feedChunk
@@ -1183,6 +1274,12 @@ declare namespace sap {
         submit?: (oEvent: Feeder$SubmitEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the NavigationBar constructor.
+       *
+       * @deprecated (since 1.38) - Instead, use the `sap.m.IconTabBar`, `sap.m.TabContainer` or `sap.uxap.ObjectPageLayout`
+       * control.
+       */
       interface $NavigationBarSettings extends sap.ui.core.$ControlSettings {
         /**
          * Defines whether the navigation bar shall have top-level appearance
@@ -1230,6 +1327,12 @@ declare namespace sap {
         select?: (oEvent: NavigationBar$SelectEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the NavigationItem constructor.
+       *
+       * @deprecated (since 1.38) - Instead, use the `sap.m.IconTabBar`, `sap.m.TabContainer` or `sap.uxap.ObjectPageLayout`
+       * control.
+       */
       interface $NavigationItemSettings extends sap.ui.core.$ItemSettings {
         /**
          * Whether the NavigationItem is currently visible. When making NavigationItems invisible at runtime it
@@ -1266,6 +1369,11 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the NotificationBar constructor.
+       *
+       * @deprecated (since 1.38) - Instead, use the `sap.m.MessagePopover` control.
+       */
       interface $NotificationBarSettings extends sap.ui.core.$ControlSettings {
         /**
          * This property displays the bar corresponding to given status
@@ -1323,6 +1431,11 @@ declare namespace sap {
         resize?: (oEvent: NotificationBar$ResizeEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Notifier constructor.
+       *
+       * @deprecated (since 1.38)
+       */
       interface $NotifierSettings extends sap.ui.core.$ElementSettings {
         /**
          * Icon of the control that should be displayed within the corresponding bar
@@ -1352,6 +1465,11 @@ declare namespace sap {
         messageSelected?: (oEvent: Notifier$MessageSelectedEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Overlay constructor.
+       *
+       * @deprecated (since 1.38)
+       */
       interface $OverlaySettings extends sap.ui.core.$ControlSettings {
         /**
          * Defines whether the 'Open' button shall be visible.
@@ -1390,6 +1508,11 @@ declare namespace sap {
         open?: (oEvent: Overlay$OpenEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the OverlayContainer constructor.
+       *
+       * @deprecated (since 1.38)
+       */
       interface $OverlayContainerSettings extends sap.ui.ux3.$OverlaySettings {
         /**
          * Aggregation for content
@@ -1401,6 +1524,11 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the OverlayDialog constructor.
+       *
+       * @deprecated (since 1.38)
+       */
       interface $OverlayDialogSettings extends sap.ui.ux3.$OverlaySettings {
         /**
          * Determines the width of the Overlay Dialog. If the width is set to "auto" it is always 50% of the overlay
@@ -1430,6 +1558,11 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the QuickView constructor.
+       *
+       * @deprecated (since 1.38) - Instead, use the `sap.m.QuickView` control.
+       */
       interface $QuickViewSettings extends sap.ui.commons.$CalloutBaseSettings {
         /**
          * Thing type (mandatory) like Account, Material, Employee etc. is displayed in a header at the top part
@@ -1582,6 +1715,11 @@ declare namespace sap {
         navigate?: (oEvent: QuickView$NavigateEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Shell constructor.
+       *
+       * @deprecated (since 1.38) - replaced by {@link sap.m.Shell}
+       */
       interface $ShellSettings extends sap.ui.core.$ControlSettings {
         /**
          * The application title to appear in the left part of the header, usually a company and/or product name.
@@ -1838,6 +1976,11 @@ declare namespace sap {
         paneClosed?: (oEvent: Shell$PaneClosedEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the ThingAction constructor.
+       *
+       * @deprecated (since 1.38)
+       */
       interface $ThingActionSettings extends sap.ui.core.$ElementSettings {
         /**
          * text of action
@@ -1858,6 +2001,11 @@ declare namespace sap {
         select?: (oEvent: ThingAction$SelectEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the ThingGroup constructor.
+       *
+       * @deprecated (since 1.38)
+       */
       interface $ThingGroupSettings extends sap.ui.core.$ElementSettings {
         /**
          * Title of Group
@@ -1891,6 +2039,11 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the ThingInspector constructor.
+       *
+       * @deprecated (since 1.38) - There is not an exact replacement.
+       */
       interface $ThingInspectorSettings extends sap.ui.ux3.$OverlaySettings {
         /**
          * First Line of the Thing Inspector Title
@@ -2044,6 +2197,11 @@ declare namespace sap {
         feedSubmit?: (oEvent: ThingInspector$FeedSubmitEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the ThingViewer constructor.
+       *
+       * @deprecated (since 1.38) - There is not an exact replacement.
+       */
       interface $ThingViewerSettings extends sap.ui.core.$ControlSettings {
         /**
          * Title of the Thing Inspector
@@ -2138,6 +2296,11 @@ declare namespace sap {
         facetSelected?: (oEvent: ThingViewer$FacetSelectedEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the ToolPopup constructor.
+       *
+       * @deprecated (since 1.38) - Instead, use the `sap.m.Popover` control.
+       */
       interface $ToolPopupSettings extends sap.ui.core.$ControlSettings {
         /**
          * Determines the title displayed in the pop up window
@@ -2323,6 +2486,9 @@ declare namespace sap {
         opened?: (oEvent: sap.ui.base.Event) => void;
       }
 
+      /**
+       * Parameters of the ActionBar#actionSelected event.
+       */
       interface ActionBar$ActionSelectedEventParameters {
         /**
          * Id of selected ThingAction
@@ -2341,6 +2507,9 @@ declare namespace sap {
         newState?: string;
       }
 
+      /**
+       * Parameters of the ActionBar#feedSubmit event.
+       */
       interface ActionBar$FeedSubmitEventParameters {
         /**
          * Feed text
@@ -2348,16 +2517,34 @@ declare namespace sap {
         text?: string;
       }
 
+      /**
+       * Parameters of the Collection#propertyChanged event.
+       */
       interface Collection$PropertyChangedEventParameters {}
 
+      /**
+       * Parameters of the Collection#selectionChanged event.
+       */
       interface Collection$SelectionChangedEventParameters {}
 
+      /**
+       * Parameters of the CollectionInspector#collectionSelected event.
+       */
       interface CollectionInspector$CollectionSelectedEventParameters {}
 
+      /**
+       * Parameters of the CollectionInspector#editCollection event.
+       */
       interface CollectionInspector$EditCollectionEventParameters {}
 
+      /**
+       * Parameters of the CollectionInspector#itemSelectionChanged event.
+       */
       interface CollectionInspector$ItemSelectionChangedEventParameters {}
 
+      /**
+       * Parameters of the DataSet#search event.
+       */
       interface DataSet$SearchEventParameters {
         /**
          * The search query
@@ -2365,6 +2552,9 @@ declare namespace sap {
         query?: string;
       }
 
+      /**
+       * Parameters of the DataSet#selectionChanged event.
+       */
       interface DataSet$SelectionChangedEventParameters {
         /**
          * Old lead selected index
@@ -2377,6 +2567,9 @@ declare namespace sap {
         newLeadSelectedIndex?: int;
       }
 
+      /**
+       * Parameters of the DataSetItem#selected event.
+       */
       interface DataSetItem$SelectedEventParameters {
         /**
          * Id of the selected Datset item
@@ -2384,6 +2577,9 @@ declare namespace sap {
         itemId?: string;
       }
 
+      /**
+       * Parameters of the Exact#refineSearch event.
+       */
       interface Exact$RefineSearchEventParameters {
         /**
          * The query string which was entered in the search field
@@ -2401,6 +2597,9 @@ declare namespace sap {
         allSelectedAttributes?: object;
       }
 
+      /**
+       * Parameters of the Exact#search event.
+       */
       interface Exact$SearchEventParameters {
         /**
          * The query string which was entered in the search field.
@@ -2408,6 +2607,9 @@ declare namespace sap {
         query?: string;
       }
 
+      /**
+       * Parameters of the ExactAttribute#supplyAttributes event.
+       */
       interface ExactAttribute$SupplyAttributesEventParameters {
         /**
          * The ExactAttribute
@@ -2415,6 +2617,9 @@ declare namespace sap {
         attribute?: sap.ui.ux3.ExactAttribute;
       }
 
+      /**
+       * Parameters of the ExactBrowser#attributeSelected event.
+       */
       interface ExactBrowser$AttributeSelectedEventParameters {
         /**
          * The attribute which was selected or unselected recently
@@ -2427,8 +2632,14 @@ declare namespace sap {
         allAttributes?: object;
       }
 
+      /**
+       * Parameters of the ExactBrowser#save event.
+       */
       interface ExactBrowser$SaveEventParameters {}
 
+      /**
+       * Parameters of the ExactList#attributeSelected event.
+       */
       interface ExactList$AttributeSelectedEventParameters {
         /**
          * The attribute which was selected/unselected recently
@@ -2441,6 +2652,9 @@ declare namespace sap {
         allAttributes?: object;
       }
 
+      /**
+       * Parameters of the FacetFilterList#select event.
+       */
       interface FacetFilterList$SelectEventParameters {
         /**
          * Id of the FacetFilterList taht fires the event.
@@ -2464,6 +2678,9 @@ declare namespace sap {
         all?: boolean;
       }
 
+      /**
+       * Parameters of the Feed#chunkAdded event.
+       */
       interface Feed$ChunkAddedEventParameters {
         /**
          * New chunk
@@ -2471,6 +2688,9 @@ declare namespace sap {
         chunk?: sap.ui.ux3.FeedChunk;
       }
 
+      /**
+       * Parameters of the Feed#filterChange event.
+       */
       interface Feed$FilterChangeEventParameters {
         /**
          * The new/changed value of the filter
@@ -2478,6 +2698,9 @@ declare namespace sap {
         newValue?: string;
       }
 
+      /**
+       * Parameters of the Feed#search event.
+       */
       interface Feed$SearchEventParameters {
         /**
          * The search query
@@ -2485,6 +2708,9 @@ declare namespace sap {
         query?: string;
       }
 
+      /**
+       * Parameters of the Feed#toggleLive event.
+       */
       interface Feed$ToggleLiveEventParameters {
         /**
          * Current live indicator
@@ -2492,6 +2718,9 @@ declare namespace sap {
         live?: boolean;
       }
 
+      /**
+       * Parameters of the Feed#toolsItemSelected event.
+       */
       interface Feed$ToolsItemSelectedEventParameters {
         /**
          * The Id of the selected item
@@ -2504,6 +2733,9 @@ declare namespace sap {
         item?: sap.ui.unified.MenuItemBase;
       }
 
+      /**
+       * Parameters of the FeedChunk#actionItemSelected event.
+       */
       interface FeedChunk$ActionItemSelectedEventParameters {
         /**
          * The Id of the selected item
@@ -2516,6 +2748,9 @@ declare namespace sap {
         item?: sap.ui.unified.MenuItemBase;
       }
 
+      /**
+       * Parameters of the FeedChunk#commentAdded event.
+       */
       interface FeedChunk$CommentAddedEventParameters {
         /**
          * New comment chunk
@@ -2523,10 +2758,19 @@ declare namespace sap {
         comment?: sap.ui.ux3.FeedChunk;
       }
 
+      /**
+       * Parameters of the FeedChunk#deleted event.
+       */
       interface FeedChunk$DeletedEventParameters {}
 
+      /**
+       * Parameters of the FeedChunk#inspect event.
+       */
       interface FeedChunk$InspectEventParameters {}
 
+      /**
+       * Parameters of the FeedChunk#referenceClicked event.
+       */
       interface FeedChunk$ReferenceClickedEventParameters {
         /**
          * Text of the @-reference
@@ -2534,8 +2778,14 @@ declare namespace sap {
         text?: string;
       }
 
+      /**
+       * Parameters of the FeedChunk#senderClicked event.
+       */
       interface FeedChunk$SenderClickedEventParameters {}
 
+      /**
+       * Parameters of the FeedChunk#toggleFavorite event.
+       */
       interface FeedChunk$ToggleFavoriteEventParameters {
         /**
          * Current favorite state
@@ -2543,6 +2793,9 @@ declare namespace sap {
         favorite?: boolean;
       }
 
+      /**
+       * Parameters of the FeedChunk#toggleFlagged event.
+       */
       interface FeedChunk$ToggleFlaggedEventParameters {
         /**
          * Current flagged state
@@ -2550,6 +2803,9 @@ declare namespace sap {
         flagged?: boolean;
       }
 
+      /**
+       * Parameters of the FeedChunk#toggleShared event.
+       */
       interface FeedChunk$ToggleSharedEventParameters {
         /**
          * Current shared state
@@ -2557,6 +2813,9 @@ declare namespace sap {
         shareed?: boolean;
       }
 
+      /**
+       * Parameters of the Feeder#submit event.
+       */
       interface Feeder$SubmitEventParameters {
         /**
          * The text that is submitted
@@ -2564,6 +2823,9 @@ declare namespace sap {
         text?: string;
       }
 
+      /**
+       * Parameters of the NavigationBar#select event.
+       */
       interface NavigationBar$SelectEventParameters {
         /**
          * The ID of the newly selected NavigationItem.
@@ -2576,6 +2838,9 @@ declare namespace sap {
         item?: sap.ui.ux3.NavigationItem;
       }
 
+      /**
+       * Parameters of the NotificationBar#display event.
+       */
       interface NotificationBar$DisplayEventParameters {
         /**
          * Indicates if the bar wants to be shown or hidden
@@ -2583,6 +2848,9 @@ declare namespace sap {
         show?: boolean;
       }
 
+      /**
+       * Parameters of the NotificationBar#resize event.
+       */
       interface NotificationBar$ResizeEventParameters {
         /**
          * The corresponding status to which the bar was resized. The corresponding heights can be taken for the
@@ -2591,6 +2859,9 @@ declare namespace sap {
         status?: sap.ui.ux3.NotificationBarStatus;
       }
 
+      /**
+       * Parameters of the Notifier#messageSelected event.
+       */
       interface Notifier$MessageSelectedEventParameters {
         /**
          * The message that was selected
@@ -2603,6 +2874,9 @@ declare namespace sap {
         notifier?: sap.ui.ux3.Notifier;
       }
 
+      /**
+       * Parameters of the Overlay#close event.
+       */
       interface Overlay$CloseEventParameters {
         /**
          * The ID of the Overlay instance.
@@ -2610,6 +2884,9 @@ declare namespace sap {
         id?: string;
       }
 
+      /**
+       * Parameters of the Overlay#closed event.
+       */
       interface Overlay$ClosedEventParameters {
         /**
          * The ID of the Overlay instance.
@@ -2617,6 +2894,9 @@ declare namespace sap {
         id?: string;
       }
 
+      /**
+       * Parameters of the Overlay#open event.
+       */
       interface Overlay$OpenEventParameters {
         /**
          * The ID of the Overlay instance
@@ -2624,6 +2904,9 @@ declare namespace sap {
         id?: string;
       }
 
+      /**
+       * Parameters of the Overlay#openNew event.
+       */
       interface Overlay$OpenNewEventParameters {
         /**
          * The ID of the Overlay instance.
@@ -2631,6 +2914,9 @@ declare namespace sap {
         id?: string;
       }
 
+      /**
+       * Parameters of the QuickView#actionSelected event.
+       */
       interface QuickView$ActionSelectedEventParameters {
         /**
          * Id of selected ThingAction
@@ -2649,6 +2935,9 @@ declare namespace sap {
         newState?: string;
       }
 
+      /**
+       * Parameters of the QuickView#feedSubmit event.
+       */
       interface QuickView$FeedSubmitEventParameters {
         /**
          * Feed text
@@ -2656,6 +2945,9 @@ declare namespace sap {
         text?: string;
       }
 
+      /**
+       * Parameters of the QuickView#navigate event.
+       */
       interface QuickView$NavigateEventParameters {
         /**
          * URI of the Thing Inspector application.
@@ -2663,10 +2955,19 @@ declare namespace sap {
         href?: string;
       }
 
+      /**
+       * Parameters of the Shell#feedSubmit event.
+       */
       interface Shell$FeedSubmitEventParameters {}
 
+      /**
+       * Parameters of the Shell#logout event.
+       */
       interface Shell$LogoutEventParameters {}
 
+      /**
+       * Parameters of the Shell#paneBarItemSelected event.
+       */
       interface Shell$PaneBarItemSelectedEventParameters {
         /**
          * The ID of the selected PaneBarItem.
@@ -2684,6 +2985,9 @@ declare namespace sap {
         key?: string;
       }
 
+      /**
+       * Parameters of the Shell#paneClosed event.
+       */
       interface Shell$PaneClosedEventParameters {
         /**
          * The id of the PaneBarItem to which the closed pane belonged.
@@ -2691,8 +2995,14 @@ declare namespace sap {
         id?: string;
       }
 
+      /**
+       * Parameters of the Shell#search event.
+       */
       interface Shell$SearchEventParameters {}
 
+      /**
+       * Parameters of the Shell#worksetItemSelected event.
+       */
       interface Shell$WorksetItemSelectedEventParameters {
         /**
          * The id of the workset item that has been newly selected by the user. If a top-level item has been clicked
@@ -2711,6 +3021,9 @@ declare namespace sap {
         key?: string;
       }
 
+      /**
+       * Parameters of the ThingAction#select event.
+       */
       interface ThingAction$SelectEventParameters {
         /**
          * Id of selected action
@@ -2723,6 +3036,9 @@ declare namespace sap {
         action?: sap.ui.ux3.ThingAction;
       }
 
+      /**
+       * Parameters of the ThingInspector#actionSelected event.
+       */
       interface ThingInspector$ActionSelectedEventParameters {
         /**
          * Id of selected ThingAction
@@ -2735,6 +3051,9 @@ declare namespace sap {
         action?: sap.ui.ux3.ThingAction;
       }
 
+      /**
+       * Parameters of the ThingInspector#facetSelected event.
+       */
       interface ThingInspector$FacetSelectedEventParameters {
         /**
          * Id of selected NavigationItem
@@ -2752,6 +3071,9 @@ declare namespace sap {
         key?: string;
       }
 
+      /**
+       * Parameters of the ThingInspector#feedSubmit event.
+       */
       interface ThingInspector$FeedSubmitEventParameters {
         /**
          * Feed text
@@ -2759,6 +3081,9 @@ declare namespace sap {
         text?: string;
       }
 
+      /**
+       * Parameters of the ThingViewer#facetSelected event.
+       */
       interface ThingViewer$FacetSelectedEventParameters {
         /**
          * Id of selected NavigationItem
@@ -2776,10 +3101,19 @@ declare namespace sap {
         key?: string;
       }
 
+      /**
+       * Parameters of the ToolPopup#close event.
+       */
       interface ToolPopup$CloseEventParameters {}
 
+      /**
+       * Parameters of the ToolPopup#closed event.
+       */
       interface ToolPopup$ClosedEventParameters {}
 
+      /**
+       * Parameters of the ToolPopup#enter event.
+       */
       interface ToolPopup$EnterEventParameters {
         /**
          * The onsapenter event, received by the pop up
@@ -2792,10 +3126,19 @@ declare namespace sap {
         originalSrcControl?: sap.ui.core.Control;
       }
 
+      /**
+       * Parameters of the ToolPopup#iconChanged event.
+       */
       interface ToolPopup$IconChangedEventParameters {}
 
+      /**
+       * Parameters of the ToolPopup#open event.
+       */
       interface ToolPopup$OpenEventParameters {}
 
+      /**
+       * Parameters of the ToolPopup#opened event.
+       */
       interface ToolPopup$OpenedEventParameters {}
 
       /**
@@ -19061,302 +19404,481 @@ declare namespace sap {
          */
         Fixed = "Fixed",
       }
-
+      /**
+       * Event object of the ActionBar#actionSelected event.
+       */
       type ActionBar$ActionSelectedEvent = sap.ui.base.Event<
         ActionBar$ActionSelectedEventParameters,
         ActionBar
       >;
 
+      /**
+       * Event object of the ActionBar#feedSubmit event.
+       */
       type ActionBar$FeedSubmitEvent = sap.ui.base.Event<
         ActionBar$FeedSubmitEventParameters,
         ActionBar
       >;
 
+      /**
+       * Event object of the Collection#propertyChanged event.
+       */
       type Collection$PropertyChangedEvent = sap.ui.base.Event<
         Collection$PropertyChangedEventParameters,
         Collection
       >;
 
+      /**
+       * Event object of the Collection#selectionChanged event.
+       */
       type Collection$SelectionChangedEvent = sap.ui.base.Event<
         Collection$SelectionChangedEventParameters,
         Collection
       >;
 
+      /**
+       * Event object of the CollectionInspector#collectionSelected event.
+       */
       type CollectionInspector$CollectionSelectedEvent = sap.ui.base.Event<
         CollectionInspector$CollectionSelectedEventParameters,
         CollectionInspector
       >;
 
+      /**
+       * Event object of the CollectionInspector#editCollection event.
+       */
       type CollectionInspector$EditCollectionEvent = sap.ui.base.Event<
         CollectionInspector$EditCollectionEventParameters,
         CollectionInspector
       >;
 
+      /**
+       * Event object of the CollectionInspector#itemSelectionChanged event.
+       */
       type CollectionInspector$ItemSelectionChangedEvent = sap.ui.base.Event<
         CollectionInspector$ItemSelectionChangedEventParameters,
         CollectionInspector
       >;
 
+      /**
+       * Event object of the DataSet#search event.
+       */
       type DataSet$SearchEvent = sap.ui.base.Event<
         DataSet$SearchEventParameters,
         DataSet
       >;
 
+      /**
+       * Event object of the DataSet#selectionChanged event.
+       */
       type DataSet$SelectionChangedEvent = sap.ui.base.Event<
         DataSet$SelectionChangedEventParameters,
         DataSet
       >;
 
+      /**
+       * Event object of the DataSetItem#selected event.
+       */
       type DataSetItem$SelectedEvent = sap.ui.base.Event<
         DataSetItem$SelectedEventParameters,
         DataSetItem
       >;
 
+      /**
+       * Event object of the Exact#refineSearch event.
+       */
       type Exact$RefineSearchEvent = sap.ui.base.Event<
         Exact$RefineSearchEventParameters,
         Exact
       >;
 
+      /**
+       * Event object of the Exact#search event.
+       */
       type Exact$SearchEvent = sap.ui.base.Event<
         Exact$SearchEventParameters,
         Exact
       >;
 
+      /**
+       * Event object of the ExactAttribute#supplyAttributes event.
+       */
       type ExactAttribute$SupplyAttributesEvent = sap.ui.base.Event<
         ExactAttribute$SupplyAttributesEventParameters,
         ExactAttribute
       >;
 
+      /**
+       * Event object of the ExactBrowser#attributeSelected event.
+       */
       type ExactBrowser$AttributeSelectedEvent = sap.ui.base.Event<
         ExactBrowser$AttributeSelectedEventParameters,
         ExactBrowser
       >;
 
+      /**
+       * Event object of the ExactBrowser#save event.
+       */
       type ExactBrowser$SaveEvent = sap.ui.base.Event<
         ExactBrowser$SaveEventParameters,
         ExactBrowser
       >;
 
+      /**
+       * Event object of the ExactList#attributeSelected event.
+       */
       type ExactList$AttributeSelectedEvent = sap.ui.base.Event<
         ExactList$AttributeSelectedEventParameters,
         ExactList
       >;
 
+      /**
+       * Event object of the FacetFilterList#select event.
+       */
       type FacetFilterList$SelectEvent = sap.ui.base.Event<
         FacetFilterList$SelectEventParameters,
         FacetFilterList
       >;
 
+      /**
+       * Event object of the Feed#chunkAdded event.
+       */
       type Feed$ChunkAddedEvent = sap.ui.base.Event<
         Feed$ChunkAddedEventParameters,
         Feed
       >;
 
+      /**
+       * Event object of the Feed#filterChange event.
+       */
       type Feed$FilterChangeEvent = sap.ui.base.Event<
         Feed$FilterChangeEventParameters,
         Feed
       >;
 
+      /**
+       * Event object of the Feed#search event.
+       */
       type Feed$SearchEvent = sap.ui.base.Event<
         Feed$SearchEventParameters,
         Feed
       >;
 
+      /**
+       * Event object of the Feed#toggleLive event.
+       */
       type Feed$ToggleLiveEvent = sap.ui.base.Event<
         Feed$ToggleLiveEventParameters,
         Feed
       >;
 
+      /**
+       * Event object of the Feed#toolsItemSelected event.
+       */
       type Feed$ToolsItemSelectedEvent = sap.ui.base.Event<
         Feed$ToolsItemSelectedEventParameters,
         Feed
       >;
 
+      /**
+       * Event object of the FeedChunk#actionItemSelected event.
+       */
       type FeedChunk$ActionItemSelectedEvent = sap.ui.base.Event<
         FeedChunk$ActionItemSelectedEventParameters,
         FeedChunk
       >;
 
+      /**
+       * Event object of the FeedChunk#commentAdded event.
+       */
       type FeedChunk$CommentAddedEvent = sap.ui.base.Event<
         FeedChunk$CommentAddedEventParameters,
         FeedChunk
       >;
 
+      /**
+       * Event object of the FeedChunk#deleted event.
+       */
       type FeedChunk$DeletedEvent = sap.ui.base.Event<
         FeedChunk$DeletedEventParameters,
         FeedChunk
       >;
 
+      /**
+       * Event object of the FeedChunk#inspect event.
+       */
       type FeedChunk$InspectEvent = sap.ui.base.Event<
         FeedChunk$InspectEventParameters,
         FeedChunk
       >;
 
+      /**
+       * Event object of the FeedChunk#referenceClicked event.
+       */
       type FeedChunk$ReferenceClickedEvent = sap.ui.base.Event<
         FeedChunk$ReferenceClickedEventParameters,
         FeedChunk
       >;
 
+      /**
+       * Event object of the FeedChunk#senderClicked event.
+       */
       type FeedChunk$SenderClickedEvent = sap.ui.base.Event<
         FeedChunk$SenderClickedEventParameters,
         FeedChunk
       >;
 
+      /**
+       * Event object of the FeedChunk#toggleFavorite event.
+       */
       type FeedChunk$ToggleFavoriteEvent = sap.ui.base.Event<
         FeedChunk$ToggleFavoriteEventParameters,
         FeedChunk
       >;
 
+      /**
+       * Event object of the FeedChunk#toggleFlagged event.
+       */
       type FeedChunk$ToggleFlaggedEvent = sap.ui.base.Event<
         FeedChunk$ToggleFlaggedEventParameters,
         FeedChunk
       >;
 
+      /**
+       * Event object of the FeedChunk#toggleShared event.
+       */
       type FeedChunk$ToggleSharedEvent = sap.ui.base.Event<
         FeedChunk$ToggleSharedEventParameters,
         FeedChunk
       >;
 
+      /**
+       * Event object of the Feeder#submit event.
+       */
       type Feeder$SubmitEvent = sap.ui.base.Event<
         Feeder$SubmitEventParameters,
         Feeder
       >;
 
+      /**
+       * Event object of the NavigationBar#select event.
+       */
       type NavigationBar$SelectEvent = sap.ui.base.Event<
         NavigationBar$SelectEventParameters,
         NavigationBar
       >;
 
+      /**
+       * Event object of the NotificationBar#display event.
+       */
       type NotificationBar$DisplayEvent = sap.ui.base.Event<
         NotificationBar$DisplayEventParameters,
         NotificationBar
       >;
 
+      /**
+       * Event object of the NotificationBar#resize event.
+       */
       type NotificationBar$ResizeEvent = sap.ui.base.Event<
         NotificationBar$ResizeEventParameters,
         NotificationBar
       >;
 
+      /**
+       * Event object of the Notifier#messageSelected event.
+       */
       type Notifier$MessageSelectedEvent = sap.ui.base.Event<
         Notifier$MessageSelectedEventParameters,
         Notifier
       >;
 
+      /**
+       * Event object of the Overlay#close event.
+       */
       type Overlay$CloseEvent = sap.ui.base.Event<
         Overlay$CloseEventParameters,
         Overlay
       >;
 
+      /**
+       * Event object of the Overlay#closed event.
+       */
       type Overlay$ClosedEvent = sap.ui.base.Event<
         Overlay$ClosedEventParameters,
         Overlay
       >;
 
+      /**
+       * Event object of the Overlay#open event.
+       */
       type Overlay$OpenEvent = sap.ui.base.Event<
         Overlay$OpenEventParameters,
         Overlay
       >;
 
+      /**
+       * Event object of the Overlay#openNew event.
+       */
       type Overlay$OpenNewEvent = sap.ui.base.Event<
         Overlay$OpenNewEventParameters,
         Overlay
       >;
 
+      /**
+       * Event object of the QuickView#actionSelected event.
+       */
       type QuickView$ActionSelectedEvent = sap.ui.base.Event<
         QuickView$ActionSelectedEventParameters,
         QuickView
       >;
 
+      /**
+       * Event object of the QuickView#feedSubmit event.
+       */
       type QuickView$FeedSubmitEvent = sap.ui.base.Event<
         QuickView$FeedSubmitEventParameters,
         QuickView
       >;
 
+      /**
+       * Event object of the QuickView#navigate event.
+       */
       type QuickView$NavigateEvent = sap.ui.base.Event<
         QuickView$NavigateEventParameters,
         QuickView
       >;
 
+      /**
+       * Event object of the Shell#feedSubmit event.
+       */
       type Shell$FeedSubmitEvent = sap.ui.base.Event<
         Shell$FeedSubmitEventParameters,
         Shell
       >;
 
+      /**
+       * Event object of the Shell#logout event.
+       */
       type Shell$LogoutEvent = sap.ui.base.Event<
         Shell$LogoutEventParameters,
         Shell
       >;
 
+      /**
+       * Event object of the Shell#paneBarItemSelected event.
+       */
       type Shell$PaneBarItemSelectedEvent = sap.ui.base.Event<
         Shell$PaneBarItemSelectedEventParameters,
         Shell
       >;
 
+      /**
+       * Event object of the Shell#paneClosed event.
+       */
       type Shell$PaneClosedEvent = sap.ui.base.Event<
         Shell$PaneClosedEventParameters,
         Shell
       >;
 
+      /**
+       * Event object of the Shell#search event.
+       */
       type Shell$SearchEvent = sap.ui.base.Event<
         Shell$SearchEventParameters,
         Shell
       >;
 
+      /**
+       * Event object of the Shell#worksetItemSelected event.
+       */
       type Shell$WorksetItemSelectedEvent = sap.ui.base.Event<
         Shell$WorksetItemSelectedEventParameters,
         Shell
       >;
 
+      /**
+       * Event object of the ThingAction#select event.
+       */
       type ThingAction$SelectEvent = sap.ui.base.Event<
         ThingAction$SelectEventParameters,
         ThingAction
       >;
 
+      /**
+       * Event object of the ThingInspector#actionSelected event.
+       */
       type ThingInspector$ActionSelectedEvent = sap.ui.base.Event<
         ThingInspector$ActionSelectedEventParameters,
         ThingInspector
       >;
 
+      /**
+       * Event object of the ThingInspector#facetSelected event.
+       */
       type ThingInspector$FacetSelectedEvent = sap.ui.base.Event<
         ThingInspector$FacetSelectedEventParameters,
         ThingInspector
       >;
 
+      /**
+       * Event object of the ThingInspector#feedSubmit event.
+       */
       type ThingInspector$FeedSubmitEvent = sap.ui.base.Event<
         ThingInspector$FeedSubmitEventParameters,
         ThingInspector
       >;
 
+      /**
+       * Event object of the ThingViewer#facetSelected event.
+       */
       type ThingViewer$FacetSelectedEvent = sap.ui.base.Event<
         ThingViewer$FacetSelectedEventParameters,
         ThingViewer
       >;
 
+      /**
+       * Event object of the ToolPopup#close event.
+       */
       type ToolPopup$CloseEvent = sap.ui.base.Event<
         ToolPopup$CloseEventParameters,
         ToolPopup
       >;
 
+      /**
+       * Event object of the ToolPopup#closed event.
+       */
       type ToolPopup$ClosedEvent = sap.ui.base.Event<
         ToolPopup$ClosedEventParameters,
         ToolPopup
       >;
 
+      /**
+       * Event object of the ToolPopup#enter event.
+       */
       type ToolPopup$EnterEvent = sap.ui.base.Event<
         ToolPopup$EnterEventParameters,
         ToolPopup
       >;
 
+      /**
+       * Event object of the ToolPopup#iconChanged event.
+       */
       type ToolPopup$IconChangedEvent = sap.ui.base.Event<
         ToolPopup$IconChangedEventParameters,
         ToolPopup
       >;
 
+      /**
+       * Event object of the ToolPopup#open event.
+       */
       type ToolPopup$OpenEvent = sap.ui.base.Event<
         ToolPopup$OpenEventParameters,
         ToolPopup
       >;
 
+      /**
+       * Event object of the ToolPopup#opened event.
+       */
       type ToolPopup$OpenedEvent = sap.ui.base.Event<
         ToolPopup$OpenedEventParameters,
         ToolPopup