@sapui5/ts-types 1.101.1 → 1.102.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/ts-types",
-  "version": "1.101.1",
+  "version": "1.102.2",
   "description": "SAPUI5 TypeScript Definitions",
   "homepage": "https://ui5.sap.com",
   "author": "SAP SE (https://www.sap.com)",

package/types/index.d.ts

@@ -23,6 +23,7 @@
 /// <reference path="./sap.ui.generic.app.d.ts"/>
 /// <reference path="./sap.ui.generic.template.d.ts"/>
 /// <reference path="./sap.uiext.inbox.d.ts"/>
+/// <reference path="./sap.insights.d.ts"/>
 /// <reference path="./sap.ui.integration.d.ts"/>
 /// <reference path="./sap.ui.layout.d.ts"/>
 /// <reference path="./sap.makit.d.ts"/>

package/types/sap.apf.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.102.0
 
 declare namespace sap {
   /**
@@ -42,6 +42,8 @@ declare namespace sap {
         getParameters(): any[];
         /**
          * Gets the previous message object.
+         *
+         * @returns || undefined
          */
         getPrevious(): sap.apf.core.MessageObject;
         /**
@@ -74,22 +76,30 @@ declare namespace sap {
         hasRawText(): boolean;
         /**
          * Sets the code, that classifies the message.
+         *
+         * @returns undefined
          */
         setCode(code: string): undefined;
         /**
          * Sets the message text.
+         *
+         * @returns undefined
          */
         setMessage(sTextMessage: string): undefined;
         /**
          * Sets the previous message object. One can add a message object to this message object, that describes
          * a previous message. The message in the previous message object will also be displayed in the log (as
          * previous entry).
+         *
+         * @returns undefined
          */
         setPrevious(
           oPreviousMessageObject: sap.apf.core.MessageObject
         ): undefined;
         /**
          * Sets the severity , which classifies the message.
+         *
+         * @returns undefined
          */
         setSeverity(
           /**
@@ -134,6 +144,8 @@ declare namespace sap {
         ): /* was: sap.apf.core.MetadataFacade */ any;
         /**
          * Executes an OData request.
+         *
+         * @returns undefined
          */
         send(
           oFilter: sap.apf.utils.Filter | null | undefined,
@@ -187,6 +199,8 @@ declare namespace sap {
         ): /* was: sap.apf.core.MetadataFacade */ any;
         /**
          * Executes an OData request.
+         *
+         * @returns undefined
          */
         send(
           oFilter: sap.apf.utils.Filter | null | undefined,
@@ -250,31 +264,47 @@ declare namespace sap {
           deserialize(oSerializationInformation: object): void;
           /**
            * Returns the alternate representation of current step (i.e. list representation for the charts)
+           *
+           * @returns oAlternateRepresentation
            */
           getAlternateRepresentation(): object;
           /**
            * Returns data for representation type
+           *
+           * @returns aDataResponse
            */
           getData(): any[];
           /**
            * This method has to be implemented so that binding can determine which method has to be used for the filter
            * retrieval from a representations.
+           *
+           * @returns The filter method type the representation supports
            */
           getFilterMethodType(): /* was: sap.apf.constants.filterMethodTypes */ any;
           /**
            * This method holds the logic to draw the content to be shown on main representation area.
+           *
+           * @returns oUiObject The UI object that has to be shown in main representation area. Example: Line chart
+           * instance for a line chart representation.
            */
           getMainContent(): object;
           /**
            * Returns meta data for representation type
+           *
+           * @returns metadata
            */
           getMetaData(): /* was: sap.apf.core.EntityTypeMetadata */ any;
           /**
            * The method returns the constructor arguments which will be used to create toggle representation.
+           *
+           * @returns oParameters
            */
           getParameter(): object;
           /**
            * This method holds the logic to draw the content to be printed.
+           *
+           * @returns oUiObject The UI object that has to be printed. Example: Line chart instance for a line chart
+           * representation.
            */
           getPrintContent(): object;
           /**
@@ -297,20 +327,50 @@ declare namespace sap {
            * is expected, if ascending sort order is required for the property. If omitted default sort order 'descending'
            * is applied.  **array** holding objects with properties 'property' and 'ascending' as described
            * above.
+           *
+           * @returns Example:
+           * { paging : {
+           * 		top : 10,
+           * 		skip : 30,
+           * 		inlineCount : true
+           *  },
+           *  orderby : [
+           * 		{ property : "nameProperty1",
+           * 		}, {
+           * 		property : "nameProperty2",
+           * 		ascending : true
+           * 		}
+           *  ]
+           * }
+           *  See also http://www.odata.org/documentation/odata-version-2-0/uri-conventions/
            */
           getRequestOptions(): object;
           /**
            * This is the basic method with which the step can detect data selected in the chart.
+           *
+           * @returns An array with indices is returned.
+           * E.g. if the first and the third line of the array aDataResponse have been selected, then aIndices = [0,
+           * 2]. Counting of indices start from 0. If all data has been selected, and aDataResponse.length == 4, then
+           * the array [0,1,2,3] is returned. In general [ 0 .. aDataResponse.length - 1] If no data has been selected
+           * at all, then [] is returned. In case of an empty selection, the value undefined has to be returned. An
+           * empty selection may occur, when selections in the previous step has been changed, so that the visual
+           * selection on the chart is now empty (empty rectangle).
            */
           getSelectionAsArray(): number[];
           /**
            * This method holds the logic to draw the content to be shown on thumbnail area.
+           *
+           * @returns oUiObject The UI object that has to be shown in thumbnail area. Example: Line chart instance
+           * for a line chart representation.
            */
           getThumbnailContent(): object;
           /**
            * This method holds the logic to draw the content to be shown as tooltip for a thumbnail. It will be shown
            * inside a tooltip Popup when the thumbnail content overflows the thumbnail container area with a gradient
            * effect to indicate that it is overflowing.
+           *
+           * @returns oUiObject The UI object that has to be shown as tooltip for a thumbnail. Example: Detailed content
+           * of a form representation.
            */
           getTooltipContent(): object;
           /**
@@ -320,6 +380,8 @@ declare namespace sap {
           /**
            * This method returns the selection for serialization. This is required for the Persisting selection of
            * current representation. It includes selection mode and selections.
+           *
+           * @returns oSerializationInformation
            */
           serialize(): object;
           /**
@@ -447,6 +509,8 @@ declare namespace sap {
          * general can be composed of the logical operation AND (see the FilterAnd object) or OR (see the FilterOr
          * object) or be a boolean expression (see the FilterExpression object). AND and OR terms are returned as
          * arrays; boolean expressions are returned as objects.
+         *
+         * @returns Array of AND terms, OR terms and expressions.
          */
         getExpressions(): object[];
         /**
@@ -460,6 +524,8 @@ declare namespace sap {
         /**
          * Build the intersection of the this filter object with the supplied filter(s). The method does not change
          * the "this"-instance.
+         *
+         * @returns new CoreFilter object {@link sap.apf.utils.Filter} for the intersected filters
          */
         intersectWith(
           /**
@@ -470,6 +536,8 @@ declare namespace sap {
         ): sap.apf.utils.Filter;
         /**
          * Updates an expression.
+         *
+         * @returns undefined
          */
         updateExpression(
           /**
@@ -504,6 +572,8 @@ declare namespace sap {
         ): undefined;
         /**
          * Updates a value of an expression object.
+         *
+         * @returns undefined
          */
         updateValue(
           /**
@@ -532,6 +602,8 @@ declare namespace sap {
 
         /**
          * Adds an expression object to this filter.
+         *
+         * @returns this to allow method chaining
          */
         addExpression(
           /**
@@ -628,6 +700,8 @@ declare namespace sap {
         ): sap.apf.utils.FilterAnd;
         /**
          * Adds an expression object to this filter.
+         *
+         * @returns this to allow method chaining
          */
         addExpression(
           /**
@@ -654,6 +728,8 @@ declare namespace sap {
         ): sap.apf.utils.FilterOr;
         /**
          * Retrieves an ID of the term.
+         *
+         * @returns ID of the term.
          */
         getId(): string;
       }
@@ -701,6 +777,8 @@ declare namespace sap {
        *
        * The handling of the window.onerror by the message handler is either switched on or off. Per default the
        * handling is deactivated.
+       *
+       * @returns undefined
        */
       activateOnErrorHandling(
         /**
@@ -725,6 +803,8 @@ declare namespace sap {
        * Restriction: Only a single filter term or a disjunction/conjunction of single terms over a single property
        * is supported. Restriction: Only the operators EQ, LE (less equal than) and GE (greater equal than) are
        * supported.
+       *
+       * @returns ID to be provided for later updates of the same filter via method updatePathFilter.
        */
       addPathFilter(filter: sap.apf.utils.Filter): number;
       /**
@@ -783,6 +863,8 @@ declare namespace sap {
       ): void;
       /**
        * Gets a path filter fragment for the given identifier by fully replacing the existing one.
+       *
+       * @returns filter for id
        */
       getPathFilter(
         /**
@@ -833,6 +915,8 @@ declare namespace sap {
       /**
        * A message is passed to the APF message handler for further processing. All message specific settings
        * (e.g. message code or severity) need to be passed within an APF message object instance.
+       *
+       * @returns undefined
        */
       putMessage(
         /**
@@ -873,6 +957,8 @@ declare namespace sap {
        *
        * Register the function callback to be executed on the given event type. fnCallback will be executed under
        * a context and will be passed with arguments depending on the event type.
+       *
+       * @returns true or false based on success or failure of registering the listener.
        */
       setEventCallback(
         /**
@@ -889,6 +975,8 @@ declare namespace sap {
       /**
        * true, when no fatal error occurred during startup phase. Startup phase includes the initialization +
        * startupApf
+       *
+       * @returns success of startup
        */
       startupSucceeded(): boolean;
       /**