Class sap.ushell.services.CrossApplicationNavigationModule: sap/ushell/services/CrossApplicationNavigation

NOTE: the caller should not rely on the specific order the semantic objects appear in the returned array.

  {
     semanticObject: "Object", // optional, matches any semantic
                               // objects if undefined

     action: "action",         // optional, matches any actions if
                               // undefined

     params: {                 // optional business parameters
        A: "B",
        C: ["e", "j"]
     },
     withAtLeastOneUsedParam: true, // optional, defaults to false. If
                                    // true, only the links that use
                                    // at least one (non sap-) parameter
                                    // from 'params' will be returned.
     treatTechHintAsFilter : true, // optional, defaults to false
                                   // if true, only apps that match
                                   // exactly the supplied technology
                                   // (e.g. sap-ui-tech-hint=WDA) will be considered

     ui5Component: UI5Component, // mandatory, the UI5 component
                                 // invoking the service, shall be a root component!

     appStateKey: "abc123...",   // optional, application state key
                                 // to add to the generated links,
                                 // SAP internal usage only

     compactIntents: true        // optional, whether intents
                                 // should be returned in compact
                                 // format. Defaults to false.
     ignoreFormFactor: true,   // optional, defaults to false, deprecated, do not use, may have no effect in the future
  }
  

This method supports a mass invocation interface to obtain multiple results with a single call, as shown in the following example:

     oCrossApplicationService.getLinks([ // array, because multiple invocations are to be made
        [                           // arguments for the first invocation
          { semanticObject: "SO" }  // this method supports one parameter only in each call
        ],
        [                           // arguments for the second invocation
          { action: "someAction" }
        ]
        // ... and so on
    ]);
  

Calling this method with no arguments will produce the same result as if the method was called with an empty object.

  {
     intent: "#AnObject-Action?A=B&C=e&C=j",
     text: "Perform action"
  }

NOTE: the intents returned are in internal format and cannot be directly put into a link tag.

Example: Let the string "C&A != H&M" be a parameter value.

Intent will be encoded as#AnObject-action?text=C%26A%20!%3D%20H%26M. Note that the intent is in internal format, before putting it into a link tag, you must invoke: externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent} }, that.oComponent);

NOTE: in case the mass invocation interface is used (see vArgs parameter explanation above), the promise will resolve to an array of arrays of arrays. For example, if the mass interface specified two arguments, the promise would resolve as follows:

  [     // mass interface was used, so return multiple values
     [  // values returned from the first call (functions may return multiple values)

        // value returned from first getLinks call (as returned by single getLinks call)
        [
          {intent: "#SO-something1", text: "Perform navigation"},
          {intent: "#SO-something2", text: "Perform action"} ],
        ]
     ],
     [

        // value returned from second getLinks call (as returned by single getLinks call)
        [
          {intent: "#Object-someAction", text: "Some action1"}
        ]
     ]
     // ... and so on
  ]
  

Note that sAppHash shall not exceed 512 bytes when serialized as UTF-8

 {
    target : { semanticObject : "AnObject", action: "action" },
    params : { A : "B" }
 }
 

 {
    target : {
       semanticObject : "AnObject",
       action: "action", context  : "AB7F3C"
    },
    params : {
       A : "B",
       c : "e"
    }
 }
 

 {
    target : { shellHash : "SO-36&jumper=postman" }
 }
 

A proper way for an application to generate a link to return to the home page of the Fiori launchpad is : hrefForExternal( { target : { shellHash : "#" }})

Do *not* use "#Shell-home" to navigate to a specific homepage!

Note that the application parameter length (including SemanticObject/Action) shall not exceed 512 bytes when serialized as UTF-8.

The function can be used to convert an shell hash internal format commonly encountered into the URL format to use in link tags:

externalHash = oCrossApplicationNavigationService.hrefForExternal({
    target: {
        shellHash: oLink.intent
    }
}, that.oComponent);

  {
    "#AnObject-action?A=B&c=e": { supported: false },
    "#AnotherObject-action2": { supported: true }
  }

e.g. { target: { semanticObject: "AnObject", action: "action" }, params: { A: "B" } } or e.g. { target: { semanticObject: "AnObject", action: "action" }, params: { A: "B", c: "e" } } or { target: { shellHash: "SO-36&jumper=postman" }, }

aIntents:

 [
   {  target : {
         semanticObject : "AnObject",
         action: "action"
      },
      params : { P1 : "B", P2 : [ "V2a", "V2b"]  }
   },
   {  target : {
         semanticObject : "SalesOrder",
         action: "display"
      },
      params : { P3 : "B", SalesOrderIds : [ "4711", "472"] }
   }
]

response: [Indices correspond]

[
  { supported: false },
  { supported: true }
]

e.g. { target : { semanticObject : "AnObject", action: "action" },
params : { A : "B" } } constructs sth. like #AnObject-action?A=B&C=e&C=j; or e.g. { target : { semanticObject : "AnObject", action: "action", context : "AB7F3C" },
params : { A : "B", c : "e" } } or { target : { shellHash : "SO-36&jumper=postman" }, }

and navigate to it via changing the hash

A proper way for an application to generate a link to return to the home page of the Fiori launchpad is: hrefForExternal( { target : { shellHash : "#" }})

Do *not* use "#Shell-home" or "Shell-home" to navigate to a specific homepage!

The actual navigation may occur deferred!

Note that the application parameter length (including SemanticObject/Action) shall not exceed 512 bytes when serialized as utf-8