@sapui5/sap.ushell 1.120.8 → 1.121.0

package/src/main/js/sap/ushell/services/BookmarkV2.js

@@ -3,9 +3,10 @@
 /**
  * @fileOverview The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
  *
- * @version 1.120.8
+ * @version 1.121.0
  */
 sap.ui.define([
+    "sap/ui/core/EventBus",
     "sap/ushell/Config",
     "sap/ushell/library",
     "sap/base/util/deepClone",
@@ -13,6 +14,7 @@ sap.ui.define([
     "sap/base/Log",
     "sap/ushell/utils"
 ], function (
+    EventBus,
     Config,
     ushellLibrary,
     deepClone,
@@ -35,15 +37,21 @@ sap.ui.define([
      *
      * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
      * <code>sap.ushell.Container.getServiceAsync("BookmarkV2")</code>. For details, see
-     * {@link sap.ushell.services.Container#getServiceAsync}.
+     * {@link sap.ushell.Container#getServiceAsync}.
      *
+     * @augments sap.ushell.services.Service
      * @hideconstructor
      *
      * @since 1.119.0
      * @public
      */
     function BookmarkV2 () {
-        // Classical home page service
+        /**
+         * Classical home page service
+         * @returns {Promise} LaunchPage service promise
+         * @private
+         * @deprecated As of version 1.120
+         */
         this._getLaunchPageService = function () {
             if (!this._oLaunchPageServicePromise) {
                 this._oLaunchPageServicePromise = sap.ushell.Container.getServiceAsync("LaunchPage");
@@ -78,18 +86,20 @@ sap.ui.define([
         this._addBookmarkToContentNodes = function (oBookmarkParams, aContentNodes, bCustom, sContentProviderId) {
             const aPromises = aContentNodes.map(function (oContentNode) {
                 if (oContentNode && oContentNode.hasOwnProperty("type") && oContentNode.isContainer) {
-                    switch (oContentNode.type) {
-                        case ContentNodeType.Page:
-                            return this.addBookmarkToPage(oBookmarkParams, oContentNode.id, sContentProviderId);
-                        case ContentNodeType.HomepageGroup:
-                            return this._getLaunchPageService()
-                                .then((oLaunchPageService) => ushellUtils.promisify(oLaunchPageService.getGroupById(oContentNode.id)))
-                                .then(function (oGroup) {
-                                    return this.addBookmarkToHomepageGroup(oBookmarkParams, oGroup, bCustom, sContentProviderId);
-                                }.bind(this));
-                        default:
-                            return Promise.reject("Bookmark Service: The API needs to be called with a valid content node type. '" + oContentNode.type + "' is not supported.");
+                    if (oContentNode.type === ContentNodeType.Page) {
+                        return this.addBookmarkToPage(oBookmarkParams, oContentNode.id, sContentProviderId);
                     }
+                    /**
+                     * @deprecated As of version 1.120
+                     */
+                    if (oContentNode.type === ContentNodeType.HomepageGroup) {
+                        return this._getLaunchPageService()
+                            .then((oLaunchPageService) => ushellUtils.promisify(oLaunchPageService.getGroupById(oContentNode.id)))
+                            .then(function (oGroup) {
+                                return this.addBookmarkToHomepageGroup(oBookmarkParams, oGroup, bCustom, sContentProviderId);
+                            }.bind(this));
+                    }
+                    return Promise.reject("Bookmark Service: The API needs to be called with a valid content node type. '" + oContentNode.type + "' is not supported.");
                 }
                 return Promise.reject("Bookmark Service: Not a valid content node.");
             }.bind(this));
@@ -98,7 +108,7 @@ sap.ui.define([
         };
 
         /**
-         * Adds a bookmark tile to one of the user's classic home page groups or to multiple provided content nodes.
+         * Adds a bookmark tile to the provided content nodes.
          *
          * @param {object} oParameters
          *   Bookmark parameters. In addition to title and URL, a bookmark might allow further
@@ -167,21 +177,19 @@ sap.ui.define([
          *   The refresh interval for the <code>serviceUrl</code> in seconds.
          * @param {string} [oParameters.numberUnit]
          *   The unit for the number retrieved from <code>serviceUrl</code>.
-         * @param {object|sap.ushell.services.BookmarkV2.ContentNode|sap.ushell.services.BookmarkV2.ContentNode[]} [vContainer]
-         *   Either a legacy launchpad home page group, one content node or an array of content nodes (see {@link #getContentNodes}).
-         *   If not provided, the bookmark will be added to the default group if spaces mode is not active
-         *   or to the default page if spaces mode is active.
-         * @param {string} [sContentProviderId] The contentProviderId or undefined outside the cFLP
+         * @param {sap.ushell.services.BookmarkV2.ContentNode|sap.ushell.services.BookmarkV2.ContentNode[]} [vContainer]
+         *   Either a content node or an array of content nodes (see {@link #getContentNodes}).
+         *   If not provided, the bookmark will be added to the default page.
+         * @param {string} [sContentProviderId] <b>SAP internal usage only</b> The contentProviderId or undefined outside the cFLP.
          *
          * @returns {Promise}
          *   A <code>Promise</code> which resolves on success, but rejects
-         *   with a reason-message on failure to add the bookmark to the specified or implied group.
+         *   with a reason-message on failure to add the bookmark to the specified or implied content node.
          *   The promise gets resolved if personalization is disabled.
          *
          * @see sap.ushell.services.URLParsing#getShellHash
          * @since 1.119.0
          * @public
-         * @alias sap.ushell.services.BookmarkV2#addBookmark
          */
         this.addBookmark = function (oParameters, vContainer, sContentProviderId) {
             const bEnablePersonalization = Config.last("/core/shell/enablePersonalization");
@@ -208,7 +216,10 @@ sap.ui.define([
                             }.bind(this));
                     }
 
-                    // Check if an old Launchpad Group object was provided instead of a content node
+                    /**
+                     * Check if an old Launchpad Group object was provided instead of a content node
+                     * @deprecated As of version 1.120
+                     */
                     if ((typeof vContainer === "undefined" || !vContainer.hasOwnProperty("type")) && !Array.isArray(vContainer)) {
                         return this.addBookmarkToHomepageGroup(oParameters, vContainer, false, sContentProviderId);
                     }
@@ -274,8 +285,6 @@ sap.ui.define([
          * @since 1.119.0
          * @private
          * @ui5-restricted ssuite.smartbusiness
-         *
-         * @alias sap.ushell.services.BookmarkV2#addCustomBookmark
          */
         this.addCustomBookmark = function (sVizType, oConfig, vContentNodes, sContentProviderId) {
             const oClonedConfig = deepClone(oConfig);
@@ -341,8 +350,8 @@ sap.ui.define([
          *
          * @see sap.ushell.services.URLParsing#getShellHash
          * @since 1.119.0
+         * @deprecated As of version 1.120
          * @private
-         * @alias sap.ushell.services.BookmarkV2#addBookmarkToHomepageGroup
          */
         this.addBookmarkToHomepageGroup = async function (oParameters, oGroup, bCustom, sContentProviderId) {
             // Reject if in launchpad spaces mode
@@ -362,7 +371,7 @@ sap.ui.define([
                 tile: oTile,
                 group: oGroup
             };
-            sap.ui.getCore().getEventBus().publish("sap.ushell.services.Bookmark", "bookmarkTileAdded", oData);
+            EventBus.getInstance().publish("sap.ushell.services.Bookmark", "bookmarkTileAdded", oData);
         };
 
         /**
@@ -404,7 +413,6 @@ sap.ui.define([
          * @see sap.ushell.services.URLParsing#getShellHash
          * @since 1.119.0
          * @private
-         * @alias sap.ushell.services.BookmarkV2#addBookmarkToPage
          */
         this.addBookmarkToPage = function (oParameters, sPageId, sContentProviderId) {
             // Reject of in launchpad home page mode
@@ -451,8 +459,8 @@ sap.ui.define([
          *
          * @see sap.ushell.services.URLParsing#getShellHash
          * @since 1.119.0
+         * @deprecated As of version 1.120, only spaces mode is available
          * @private
-         * @alias sap.ushell.services.BookmarkV2#addBookmarkByGroupId
          */
         this.addBookmarkByGroupId = function (oParameters, groupId, sContentProviderId) {
             // Reject if in launchpad spaces mode
@@ -472,7 +480,6 @@ sap.ui.define([
         /**
          * Returns the list of group ids and their titles of the user together with filtering out all groups that can not
          * be selected when adding a bookmark.
-         * In case of success, the <code>done</code> function gets an array of 'anonymous' groupId-title objects.
          * The order of the array is the order in which the groups will be displayed to the user.
          * the API is used from "AddBookmarkButton" by not native UI5 applications
          *
@@ -480,8 +487,8 @@ sap.ui.define([
          * @returns {Promise} A promise that resolves to the list of groups. In launchpad spaces mode the promise gets rejected.
          *
          * @since 1.119.0
+         * @deprecated As of version 1.120
          * @private
-         * @alias sap.ushell.services.BookmarkV2#getGroupsIdsForBookmarks
          */
         this.getShellGroupIDs = function (bGetAll) {
             // Reject if in launchpad spaces mode
@@ -581,13 +588,16 @@ sap.ui.define([
          * @public
          */
         this.countBookmarks = function (sUrl, sContentProviderId) {
-            if (Config.last("/core/spaces/enabled")) {
-                return this._getPagesService()
-                    .then((oPagesService) => oPagesService.countBookmarks({ url: sUrl, contentProviderId: sContentProviderId }));
+            /**
+             * @deprecated As of version 1.120
+             */
+            if (!Config.last("/core/spaces/enabled")) {
+                return this._getLaunchPageService()
+                    .then((oLaunchPageService) => ushellUtils.promisify(oLaunchPageService.countBookmarks(sUrl, sContentProviderId)));
             }
 
-            return this._getLaunchPageService()
-                .then((oLaunchPageService) => ushellUtils.promisify(oLaunchPageService.countBookmarks(sUrl, sContentProviderId)));
+            return this._getPagesService()
+                .then((oPagesService) => oPagesService.countBookmarks({ url: sUrl, contentProviderId: sContentProviderId }));
         };
 
         /**
@@ -609,22 +619,22 @@ sap.ui.define([
          *
          * @see #addCustomBookmark
          * @since 1.119.0
-         *
          * @private
          * @ui5-restricted ssuite.smartbusiness
-         *
-         * @alias sap.ushell.services.BookmarkV2#countCustomBookmarks
          */
         this.countCustomBookmarks = function (oIdentifier) {
             if (!oIdentifier || !oIdentifier.url || !oIdentifier.vizType) {
                 return Promise.reject("countCustomBookmarks: required parameters are missing.");
             }
 
-            if (Config.last("/core/spaces/enabled")) {
-                return this._getPagesService().then((oPagesService) => oPagesService.countBookmarks(oIdentifier));
+            /**
+             * @deprecated As of version 1.120
+             */
+            if (!Config.last("/core/spaces/enabled")) {
+                return this._getLaunchPageService().then((LaunchPageService) => LaunchPageService.countCustomBookmarks(oIdentifier));
             }
 
-            return this._getLaunchPageService().then((LaunchPageService) => LaunchPageService.countCustomBookmarks(oIdentifier));
+            return this._getPagesService().then((oPagesService) => oPagesService.countBookmarks(oIdentifier));
         };
 
         /**
@@ -644,19 +654,22 @@ sap.ui.define([
          * @see #countBookmarks
          * @since 1.119.0
          * @public
-         * @alias sap.ushell.services.BookmarkV2#deleteBookmarks
          */
         this.deleteBookmarks = function (sUrl, sContentProviderId) {
-            if (Config.last("/core/spaces/enabled")) {
-                return this._getPagesService()
-                    .then((oPagesService) => oPagesService.deleteBookmarks({ url: sUrl, contentProviderId: sContentProviderId }));
+            /**
+             * @deprecated As of version 1.120
+             */
+            if (!Config.last("/core/spaces/enabled")) {
+                return this._getLaunchPageService()
+                    .then((LaunchPageService) => ushellUtils.promisify(LaunchPageService.deleteBookmarks(sUrl, sContentProviderId)))
+                    .then((oResult) => {
+                        EventBus.getInstance().publish("sap.ushell.services.Bookmark", "bookmarkTileDeleted", sUrl);
+                        return oResult;
+                    });
             }
-            return this._getLaunchPageService()
-                .then((LaunchPageService) => ushellUtils.promisify(LaunchPageService.deleteBookmarks(sUrl, sContentProviderId)))
-                .then((oResult) => {
-                    sap.ui.getCore().getEventBus().publish("sap.ushell.services.Bookmark", "bookmarkTileDeleted", sUrl);
-                    return oResult;
-                });
+
+            return this._getPagesService()
+                .then((oPagesService) => oPagesService.deleteBookmarks({ url: sUrl, contentProviderId: sContentProviderId }));
         };
 
         /**
@@ -678,25 +691,26 @@ sap.ui.define([
          * @see #addCustomBookmark
          * @see #countCustomBookmarks
          * @since 1.119.0
-         *
          * @private
          * @ui5-restricted ssuite.smartbusiness
-         *
-         * @alias sap.ushell.services.BookmarkV2#deleteCustomBookmarks
          */
         this.deleteCustomBookmarks = function (oIdentifier) {
             if (!oIdentifier || !oIdentifier.url || !oIdentifier.vizType) {
                 return Promise.reject("deleteCustomBookmarks: Some required parameters are missing.");
             }
-            if (Config.last("/core/spaces/enabled")) {
-                return this._getPagesService().then((oPagesService) => oPagesService.deleteBookmarks(oIdentifier));
+
+            /**
+             * @deprecated As of version 1.120
+             */
+            if (!Config.last("/core/spaces/enabled")) {
+                return this._getLaunchPageService()
+                    .then((oLaunchPageService) => oLaunchPageService.deleteCustomBookmarks(oIdentifier))
+                    .then(() => {
+                        EventBus.getInstance().publish("sap.ushell.services.Bookmark", "bookmarkTileDeleted", oIdentifier.url);
+                    });
             }
 
-            return this._getLaunchPageService()
-                .then((oLaunchPageService) => oLaunchPageService.deleteCustomBookmarks(oIdentifier))
-                .then(() => {
-                    sap.ui.getCore().getEventBus().publish("sap.ushell.services.Bookmark", "bookmarkTileDeleted", oIdentifier.url);
-                });
+            return this._getPagesService().then((oPagesService) => oPagesService.deleteBookmarks(oIdentifier));
         };
 
         /**
@@ -753,16 +767,18 @@ sap.ui.define([
          * @see #deleteBookmarks
          * @since 1.119.0
          * @public
-         * @alias sap.ushell.services.BookmarkV2#updateBookmarks
          */
         this.updateBookmarks = function (sUrl, oParameters, sContentProviderId) {
-            if (Config.last("/core/spaces/enabled")) {
-                return this._getPagesService()
-                    .then((oPagesService) => oPagesService.updateBookmarks({ url: sUrl, contentProviderId: sContentProviderId }, oParameters));
+            /**
+             * @deprecated As of version 1.120
+             */
+            if (!Config.last("/core/spaces/enabled")) {
+                return this._getLaunchPageService().then((LaunchPageService) => {
+                    return ushellUtils.promisify(LaunchPageService.updateBookmarks(sUrl, oParameters, sContentProviderId));
+                });
             }
-            return this._getLaunchPageService().then((LaunchPageService) => {
-                return ushellUtils.promisify(LaunchPageService.updateBookmarks(sUrl, oParameters, sContentProviderId));
-            });
+            return this._getPagesService()
+                .then((oPagesService) => oPagesService.updateBookmarks({ url: sUrl, contentProviderId: sContentProviderId }, oParameters));
         };
 
         /**
@@ -816,11 +832,8 @@ sap.ui.define([
          * @see #addCustomBookmark
          * @see #countCustomBookmarks
          * @since 1.119.0
-         *
          * @private
          * @ui5-restricted ssuite.smartbusiness
-         *
-         * @alias sap.ushell.services.BookmarkV2#updateCustomBookmarks
          */
         this.updateCustomBookmarks = function (oIdentifier, oConfig) {
             if (!oIdentifier || !oIdentifier.url || !oIdentifier.vizType) {
@@ -841,76 +854,61 @@ sap.ui.define([
             delete oBookmarkConfig.chipConfig;
             delete oBookmarkConfig.loadManifest;
 
-            if (Config.last("/core/spaces/enabled")) {
-                return this._getPagesService()
-                    .then((oPagesService) => oPagesService.updateBookmarks(oIdentifier, oBookmarkConfig));
+            /**
+             * @deprecated As of version 1.120
+             */
+            if (!Config.last("/core/spaces/enabled")) {
+                return this._getLaunchPageService()
+                    .then((oLaunchPageService) => oLaunchPageService.updateCustomBookmarks(oIdentifier, oBookmarkConfig));
             }
-            return this._getLaunchPageService()
-                .then((oLaunchPageService) => oLaunchPageService.updateCustomBookmarks(oIdentifier, oBookmarkConfig));
+
+            return this._getPagesService()
+                .then((oPagesService) => oPagesService.updateBookmarks(oIdentifier, oBookmarkConfig));
         };
 
         /**
          * @typedef {object} sap.ushell.services.BookmarkV2.ContentNode
-         *  A content node may be:
-         *   - a classic home page group
-         *   - an unselectable node (space) or a selectable node (page) in spaces mode
-         *   - or any other containers in the future
-         *
+         * A tree of content nodes.
          * @property {string} id ID of the content node
          * @property {string} label Human-readable representation of a content node which can be displayed in a control
-         * @property {sap.ushell.ContentNodeType} type Specifies the content node type. E.g: space, page, group, etc. See {@link sap.ushell.sap.ushell.services.BookmarkV2.ContentNodeType}
+         * @property {sap.ushell.ContentNodeType} type Specifies the content node type. E.g: space, page, etc. See {@link sap.ushell.sap.ushell.services.BookmarkV2.ContentNodeType}
          * @property {boolean} isContainer Specifies if a bookmark can be added
          * @property {sap.ushell.services.BookmarkV2.ContentNode[]} [children] Specifies sub-nodes
          * @public
          */
 
         /**
-         * Returns available content nodes based on the current launchpad context. (Classic home page, spaces mode)
-         *
-         * A content node may be:
-         * <ul>
-         * <li>a classic home page group</li>
-         * <li>an unselectable node (space) or a selectable node (page) in spaces mode</li>
-         * <li>or any other containers in the future</li>
-         * </ul>
-         *
-         * It has the following properties:
-         * <ul>
-         * <li>id: ID of the content node</li>
-         * <li>label: Human-readable representation of a content node which can be displayed in a control</li>
-         * <li>type: Specifies the content node type. E.g: space, page, group, etc. See {@link sap.ushell.ContentNodeType}</li>
-         * <li>isContainer: Specifies if a bookmark can be added</li>
-         * <li>children: Specifies sub-nodes</li>
-         * <ul>
+         * Returns available content nodes.
          *
          * @returns {Promise<sap.ushell.services.BookmarkV2.ContentNode[]>} Promise resolving the currently available content nodes.
          *
          * @public
          * @since 1.119.0
-         * @alias sap.ushell.services.BookmarkV2#getContentNodes
          */
         this.getContentNodes = function () {
-            // Spaces mode
-            if (Config.last("/core/spaces/enabled")) {
-                return sap.ushell.Container.getServiceAsync("Menu")
-                    .then((oMenuService) => oMenuService.getContentNodes());
+            /**
+             * @deprecated As of version 1.120
+             */
+            if (!Config.last("/core/spaces/enabled")) {
+                // Classic home page
+                return this._getLaunchPageService().then((oLaunchPageService) => {
+                    return ushellUtils.promisify(oLaunchPageService.getGroupsForBookmarks())
+                        .then((aHomepageGroups) => {
+                            const aResults = aHomepageGroups.map((oBookmarkGroup) => {
+                                return {
+                                    id: oLaunchPageService.getGroupId(oBookmarkGroup.object),
+                                    label: oBookmarkGroup.title,
+                                    type: ContentNodeType.HomepageGroup,
+                                    isContainer: true
+                                };
+                            });
+                            return aResults;
+                        });
+                });
             }
 
-            // Classic home page
-            return this._getLaunchPageService().then((oLaunchPageService) => {
-                return ushellUtils.promisify(oLaunchPageService.getGroupsForBookmarks())
-                    .then((aHomepageGroups) => {
-                        const aResults = aHomepageGroups.map((oBookmarkGroup) => {
-                            return {
-                                id: oLaunchPageService.getGroupId(oBookmarkGroup.object),
-                                label: oBookmarkGroup.title,
-                                type: ContentNodeType.HomepageGroup,
-                                isContainer: true
-                            };
-                        });
-                        return aResults;
-                    });
-            });
+            // Spaces mode
+            return sap.ushell.Container.getServiceAsync("Menu").then((oMenuService) => oMenuService.getContentNodes());
         };
     }
 

package/src/main/js/sap/ushell/services/ClientSideTargetResolution.js

@@ -29,7 +29,7 @@
  * In the future, the custom resolver mechanism should be probably moved towards modifying (or only adding to the list of Inbounds),
  * this way a single data source has to be altered to support consistently getLinks, isIntentSupported.
  *
- * @version 1.120.8
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -85,7 +85,7 @@ sap.ui.define([
      *
      * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
      * <code>sap.ushell.Container.getServiceAsync("ClientSideTargetResolution")</code>. For details, see
-     * {@link sap.ushell.services.Container#getServiceAsync}.
+     * {@link sap.ushell.Container#getServiceAsync}.
      *
      * This list defines a common strategy for selecting <b>one</b> appropriate target (even in case of conflicts) across all platforms.
      *
@@ -215,7 +215,7 @@ sap.ui.define([
      *
      * @param {string} sHashFragment The URL hash fragment in internal format
      *   (as obtained by the hasher service from SAPUI5, not as given in <code>location.hash</code>)
-     * @returns {object} A <code>jQuery.Promise</code>. Its <code>done()</code> function gets an object that you can use to create a
+     * @returns {jQuery.Promise} Resolves an object that you can use to create a
      *   {@link sap.ushell.components.container.ApplicationContainer} or <code>undefined</code> in case the hash fragment was empty.
      * @private
      * @since 1.34.0
@@ -246,7 +246,7 @@ sap.ui.define([
      * Resolves a given intent to information that can be used to render a tile.
      *
      * @param {string} sHashFragment The intent to be resolved (including the "#" sign).
-     * @returns {jQuery.Deferred.promise} Resolves with an object containing the necessary information to render a tile,
+     * @returns {jQuery.Promise} Resolves with an object containing the necessary information to render a tile,
      *   or rejects with an error message or <code>undefined</code>.
      * @private
      * @since 1.38.0
@@ -276,7 +276,7 @@ sap.ui.define([
      *
      * @param {object[]} aInbounds The Inbounds.
      * @param {string} sHashFragment The intent to be resolved.
-     * @returns {jQuery.Deferred.promise} A promise.
+     * @returns {jQuery.Promise} Resolves the tile intent.
      * @private
      */
     ClientSideTargetResolution.prototype.resolveTileIntentInContext = function (aInbounds, sHashFragment) {
@@ -643,7 +643,7 @@ sap.ui.define([
         return oDeferred.promise();
     };
 
-    /*
+    /**
      * The following table compares the capabilities and behavior of the different technologies:
      *                                                       SAPUI5  URL  WDA  WebGui  WebGuiWrapped  WCF
      * server/port/client etc altered                           N     Y    Y      Y          Y         Y
@@ -681,10 +681,8 @@ sap.ui.define([
      * @private
      */
     ClientSideTargetResolution.prototype._constructFallbackResolutionResult = function (oMatchingTarget, fnBoundFallback, sFixedHashFragment) {
-        /*
-         * The current flow is to resolve the result with all *uncompressed* default substituted parameters and alters
-         * appState compress the url afterwards if needed (the fallback function takes care of this).
-         */
+        // The current flow is to resolve the result with all *uncompressed* default substituted parameters and alters
+        // appState compress the url afterwards if needed (the fallback function takes care of this).
         var oEffectiveParameters = {};
 
         Object.keys(oMatchingTarget.intentParamsPlusAllDefaults).forEach(function (sParamName) {
@@ -742,7 +740,7 @@ sap.ui.define([
      * The semantic objects coming from an inbound with hideIntentLink set to <code>true</code>
      * are not returned since these inbounds are not returned by getLinks.
      *
-     * @returns {jQuery.Deferred.promise} Resolves with an array of strings representing
+     * @returns {jQuery.Promise} Resolves with an array of strings representing
      *   the User's semantic objects or rejects with an error message.
      *   NOTE: semantic objects are returned in lexicographical order in the result array.
      * @private
@@ -804,7 +802,7 @@ sap.ui.define([
      *            "GUI"       "(GUI)"
      *   Calling getLinks with P1=1&sap-ui-tech-hint=GUI will return "A-b?P1=1&sap-ui-tech-hint=GUI" and the text "(GUI)".
      *   Resolving "A-b?P1=1&sap-ui-tech-hint=GUI" will always invoke UI5 (!).
-     * @returns {jQuery.Deferred.promise} A promise that resolves with an array of links objects containing (at least) the following properties:
+     * @returns {jQuery.Promise} Resolves with an array of links objects containing (at least) the following properties:
      *   <pre>
      *   {
      *      intent: "#AnObject-Action?A=B&C=e&C=j",
@@ -997,7 +995,7 @@ sap.ui.define([
             return jQuery.when([]);
         }
 
-        /*
+        /**
          * Returns ?-prefixed business parameters
          */
         function fnConstructBusinessParamsString (mParams) {
@@ -1526,7 +1524,7 @@ sap.ui.define([
      *
      * @param {string} sIntent The intent to be matched.
      * @param {object} oInboundIndex The index of the inbounds to be matched.
-     * @returns {jQuery.Deferred.promise} A promise that is resolved with a boolean if the intent is supported and rejected if not.
+     * @returns {jQuery.Promise} Resolves with a boolean if the intent is supported and rejected if not.
      *   The promise resolves to true if only one target matches the intent, and false if multiple targets match the intent.
      * @private
      * @since 1.32.0
@@ -1561,7 +1559,7 @@ sap.ui.define([
      * "Supported" means that navigation to the intent is possible.
      *
      * @param {string[]} aIntents The intents (such as <code>"#AnObject-Action?A=B&C=e&C=j"</code>) to be checked.
-     * @returns {object} A <code>jQuery.Deferred</code> object's promise which is resolved with a map containing the intents from
+     * @returns {jQuery.Promise} Resolves a map containing the intents from
      *   <code>aIntents</code> as keys. The map values are objects with a property <code>supported</code> of type <code>boolean</code>.
      *   Example:
      *   <pre>
@@ -1636,7 +1634,7 @@ sap.ui.define([
      * Finds and returns all unique user default parameter names referenced in inbounds.
      *
      * @param {object} oSystemContext The systemContext for which the user default parameter names should be returned.
-     * @returns {jQuery.Deferred.promise} A promise that resolves to an object with the following structure
+     * @returns {jQuery.Promise} Resolves to an object with the following structure
      * <pre>
      *   {
      *     simple: {
@@ -1741,7 +1739,7 @@ sap.ui.define([
      *
      * @param {string} [sMenuType=sapMenu] The type of menu to return the entries for. This can be one of "userMenu" or "sapMenu".
      *   If this parameter is not specified, just the entries for the sap menu will be returned for the sap menu are returned.
-     * @returns {jQuery.Deferred.promise} Returns a promise that resolves with an object containing the systems:
+     * @returns {jQuery.Promise} Resolves with an object containing the systems:
      *   <pre>
      *   {
      *     <system alias {string}>: { text: <text to be displayed in the system list {string}> }
@@ -1828,11 +1826,11 @@ sap.ui.define([
 
                     if (typeof sSystemAliasName === "string") {
                         /*
-                        Code below builds the set of easy access system that should be displayed in the sapMenu/userMenu.
-                        In case multiple inbounds exist with a certain system,
-                        the app type with the highest priority is used to choose the title (see oActionDefinitions above).
-                        Note that other app types should still appear in the result set (see 'appType' in the example result from jsdoc).
-                        */
+                         * Code below builds the set of easy access system that should be displayed in the sapMenu/userMenu.
+                         * In case multiple inbounds exist with a certain system,
+                         * the app type with the highest priority is used to choose the title (see oActionDefinitions above).
+                         * Note that other app types should still appear in the result set (see 'appType' in the example result from jsdoc).
+                         */
                         var iCurrentActionPriority = oActionDefinitions[oEasyAccessInbound.action].priority;
                         var sCurrentActionAppType = oActionDefinitions[oEasyAccessInbound.action].appType;