Class sap.ushell.services.LaunchPageModule: sap/ushell/services/LaunchPage

Adds a new group.

In case of success, the done function gets the new added group object. Intention: the page builder adds this group to the end of the home screen.

In case of failure, the fail function returns the consistent (i.e. persisted) backend state of all groups.

Adds a new group at a specific location.

In case of success, the done function gets the new added group object. Intention: the page builder adds this group to the specific location on the home screen.

In case of failure, the fail function returns the consistent (i.e. persisted) backend state of all groups.

Adds a tile to a group.

If no group is provided then the tile is added to the default group.

In case of success, the done function returns the new tile. Intention: the page builder by default puts this tile at the end of the default group. In case of failure, the fail function should return the consistent (i.e. persisted) backend state of the default group.

Returns catalog's technical data.

Returns the catalog's technical error message in case it could not be loaded from the backend.

Beware: The technical error message is not translated!

Returns the catalog's unique identifier

Returns the catalogs of the user.

Only severe failures make the overall operation fail. If loading of a remote catalog fails, this is handled gracefully by providing a "dummy" empty catalog (with ID instead of title). Use getCatalogError to check if a (remote) catalog could not be loaded from the backend.

Progress notifications are sent for each single catalog, i.e. attaching a progress handler gives you the same possibilities as attaching a done handler, but with the advantage of improved responsiveness.

sap.ushell.Container.getService("LaunchPage").getCatalogs()
  .fail(function (sErrorMessage) { // string
    // handle error situation
  })
  .progress(function (oCatalog) { // object
    // do s.th. with single catalog
  })
  .done(function (aCatalogs) { // object[]
    aCatalogs.forEach(function (oCatalog) {
      // do s.th. with single catalog
    });
  });

Returns catalog tile's unique identifier. This function may be called for a catalog tile or (since 1.21.0) for a group tile. In the latter case, the function returns the unique identifier of the catalog tile on which the group tile is based.

Returns the keywords associated with a catalog tile which can be used to find the catalog tile in a search. Note: getCatalogTileView must be called before this method. Otherwise the keywords may be incomplete.

Returns preview icon for a catalog tile.

Returns preview title for a catalog tile.

Returns the tiles of a catalog. In case of success, the done function of the returned promise object gets an array of 'anonymous' tiles of the catalog.

Returns the size of a catalog tile as a string. For example: "1x1", "1x2"

Returns the tags associated with a catalog tile which can be used to find the catalog tile in a tag filter.

Returns the navigation target URL of a catalog tile. If the catalog tile does not exist, this function implicitly instantiates it using getCatalogTileView(oCatalogTile).

Returns the catalog tile's title

Returns the UI5 view or control of a catalog tile

Returns the catalog's title

Returns the default group of the user. In case of success, the done function gets an 'anonymous' object representing the default group.

Returns the unique identifier of the given group

Returns the groups of the user. In case of success, the done function gets an array of 'anonymous' groups. The order of the array is the order in which the groups will be displayed to the user.

Returns an array of 'anonymous' tiles of a group. The order of the array is the order of tiles that will be displayed to the user.

Returns the title of the given group.

Returns an array of link tiles for a group. The order of the array is the order in which the links will be displayed to the user.

Returns the tile's unique identifier

Returns the tile size in the format of 1x1 or 1x2 string

Returns the tile's navigation target.

The navigation target string is used (when assigned to location.hash) for performing a navigation action that eventually opens the application represented by the tile.

Returns the tile's title.

Returns the tile's type.

Returns UI5 view or control of the tile. In case of success the done function should return UI5 view or control of the tile. In case of failure the fail function should return nothing.

Returns whether the catalogs collection previously returned by getCatalogs() is still valid.

Initially the result is false until getCatalogs() has been called. Later, the result might be false again in case one of the catalogs has been invalidated, e.g. due to adding a tile to a catalog ("Add to catalog" scenario).

Checks if a group was marked as locked (meaning the group and its tiles will lack several capabilities such as Rename, Drag&Drop...).

Returns true if the group is locked and false if not.

Checks if a group can be removed.

Returns true if the group can be removed (i.e. if the given group was created by the user) and false if the group can only be reset.

Moves a group to a new index (i.e. location).

In case of success, the done function is called without any value. Intention: the page builder already moved the page (visible to the user) and if successful - nothing needs to be done. In case of failure, the fail function returns the consistent (i.e. persisted) backend state of all groups.

Moves a tile within a group or between different groups.

In case of success, the done function returns nothing. Intention: the page builder already moved the tile.

In case of failure, the fail function returns the consistent (i.e. persisted) backend state of the source group and the target group. The result is in the following format {source:[{},{}], target:[{},{}]}.

The source and the target groups tiles are in the form of the @see sap.ushell.services.LaunchPage.getGroupTiles

Triggers a refresh action of a tile. Typically this action is related to the value presented in dynamic tiles

Register an external tile actions provider callback function.

The callback has to return an array of actions of the given tile. The callback is triggered when

of a tile actions provider callback:

    function (oTile){
         return [
                 {
                     text: "Some Action",
                     icon: "sap-icon://action",
                     targetURL: "#SemanticObject-Action"
                 },
                 {
                     text: "Settings",
                     icon: "sap-icon://action-settings",
                     press: function (){
                         //Open settings UI
                     }
                 }
             ];
      }
.


Use Function.prototype.bind() to determine the callback's this or
some of its arguments.

Removes a group.

In case of success, the done function is called without any value (i.e. input data). Intention: the page builder already removed the page (or hid it from the user) and if successful - nothing needs to be done.

In case of failure, the fail function returns the consistent (i.e. persisted) backend state of all groups.

Removes a tile from a group.

In case of success, the done function returns the new tile. Intention: the page builder has already 'hidden' (or removed) the tile.

In case of failure, the fail function should return the consistent (i.e. persisted) backend state of the group.

Resets a group.

The reset action is relevant for a group that was assigned to the user by an administrator. The reset action means that the group is set back to the state defined by the administrator, and changes made by the end user (e.g. adding tiles) are removed. A group can be reset multiple times.

In case of success, the done function gets the reset group object.

In case of failure, or when the given group was created by the user (i.e. can't be reset)- fail handler is called, returning the consistent (i.e. persisted) backend state of all groups. The returned group object is the same as the one returned by @see sap.ushell.services.LaunchPage.getGroups

Sets the title of an existing group.

In case of success, the done function returns nothing. Intention: the page builder knows the new title, and if successful nothing needs to be done, as the title is already visible to the user. In case of failure, the fail function returns the consistent (i.e. persisted) backend state of the group title, in most cases the old title.

Sets the tile's visibility state and notifies the tile about the change.