true if the conditions are fulfilled.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sUrl","optional":false,"description":"
the URL to test. Note: this url must be in internal format.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Check if a URL has an intent based navigation part which can be parsed into a semantic object and action part. Accepts only a relative URL (must contain #) or fully qualified Urls for which origin and filename must correspond to the running launchpad.
Given actual url http://www.mycorp.com/sap/fiori/FioriLaunchpad.html?sap-language=DE#SO-action?P1=value1, the following parts http://www.mycorp.com/sap/fiori/FioriLaunchpad.html must match.
This function *only* tests whether the hash part can be parsed and contains a semantic object and action. It does not test whether the intent or its parameters are valid for a given user
","href":"api/sap.ushell.base.UrlParsing#methods/sap.ushell.base.UrlParsing.isIntentUrlAsync","code":"sap.ushell.base.UrlParsing.isIntentUrlAsync(sUrl) : Promise "},{"name":"sap.ushell.base.UrlParsing.paramsToString","visibility":"protected","static":true,"since":"1.94.0","returnValue":{"type":"string","description":"ABC=1&ABC=1%202DEF=4 Note that the result is *not* prefixed with a \"?\", parameter values are encodeURIComponent encoded.
","typeInfo":{"template":"string"}},"parameters":[{"name":"oParams","optional":false,"description":"
any value { ABC : [1,\"1 2\"], DEF : [\"4\"]}
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Combine members of a javascript object into a parameter string, note that parameters are ordered in an arbitrary manner which is subject to change
","href":"api/sap.ushell.base.UrlParsing#methods/sap.ushell.base.UrlParsing.paramsToString","code":"sap.ushell.base.UrlParsing.paramsToString(oParams) : string "},{"name":"sap.ushell.base.UrlParsing.parseParameters","visibility":"protected","static":true,"since":"1.94.0","returnValue":{"type":"object","description":"Any value, e.g. { ABC: [\"1\", \"1 2DEF=4\"] }
","typeInfo":{"template":"object"}},"parameters":[{"name":"sParams","optional":false,"description":"
Parameter string, e.g. ?ABC=1&ABC=1%202DEF=4
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Parses parameters from a URI query string (starting with \"?\") into a parameter object. Keys are decoded twice. This assumes that literal \"%\" characters are not used on keys, otherwise parsing will fail.
","href":"api/sap.ushell.base.UrlParsing#methods/sap.ushell.base.UrlParsing.parseParameters","code":"sap.ushell.base.UrlParsing.parseParameters(sParams) : object "},{"name":"sap.ushell.base.UrlParsing.parseShellHash","visibility":"protected","static":true,"since":"1.94.0","returnValue":{"type":"object","description":"undefined if not a parseable hash
\n {\n semanticObject : string, , Note that params always has an Array for each parameter value!","typeInfo":{"template":"object"}},"parameters":[{"name":"sHash","optional":false,"description":"
Hash part of a FLP-compliant URL #SO-Action?P1=a&P2=x&/route?RPV=1. At minimum, Semantic Object and Action need to be part of the hash. A single # is also accepted.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"bReturnEmpty","optional":true,"defaultValue":false,"description":"
Return an empty parsed hash object instead of undefined
","typeInfo":{"template":"boolean"}}],"description":"Decompose a shell hash into the respective parts.
","href":"api/sap.ushell.base.UrlParsing#methods/sap.ushell.base.UrlParsing.parseShellHash","code":"sap.ushell.base.UrlParsing.parseShellHash(sHash, bReturnEmpty?) : object "},{"name":"sap.ushell.base.UrlParsing.splitHash","visibility":"protected","static":true,"since":"1.94.0","returnValue":{"type":"object","description":"{}(empty object) if not a parseable hash
\n {\n shellPart : \"Object-name?PV1=PV2&PV4=V5\",\n appSpecificRoute : \"&/display/detail/7?UU=HH\"\n }\n otherwise Note that params always has an Array for each parameter value!","typeInfo":{"template":"object"}},"parameters":[{"name":"sHash","optional":false,"description":"
Hash part of a shell conformant URL #SO-Action?P1=a&P2=x&/route?RPV=1 the hash part of an URL, e.g. \"#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"split a Unified Shell compliant hash into an Object containing a shell specific part and an app specific parts for non compliant hash strings, the empty object {} is returned. An optional leading # is stripped.
","href":"api/sap.ushell.base.UrlParsing#methods/sap.ushell.base.UrlParsing.splitHash","code":"sap.ushell.base.UrlParsing.splitHash(sHash) : object "},{"name":"sap.ushell.base.UrlParsing.stripLeadingHash","visibility":"protected","static":true,"since":"1.94.0","returnValue":{"type":"string","description":"the string without a leading #
","typeInfo":{"template":"string"}},"parameters":[{"name":"sHash","optional":false,"description":"
Shell hash
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Internal function
","href":"api/sap.ushell.base.UrlParsing#methods/sap.ushell.base.UrlParsing.stripLeadingHash","code":"sap.ushell.base.UrlParsing.stripLeadingHash(sHash) : string "}],"displayName":"sap.ushell.base.UrlParsing","nodes":[{"name":"sap.ushell.base.UrlParsing.HashComparison","description":"Type for HashComparison
","href":"api/sap.ushell.base.UrlParsing.HashComparison"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.base.UrlParsing","subTitle":""},{"kind":"typedef","name":"sap.ushell.base.UrlParsing.HashComparison","basename":"HashComparison","resource":"sap/ushell/base/UrlParsing.js","module":"sap/ushell/base/UrlParsing","static":true,"visibility":"protected","since":"1.128.0","description":"
Type for HashComparison
","properties":[{"name":"sameIntent","optional":false,"visibility":"protected","description":"The intent is the semantic object and action of the hash
","typeInfo":{"template":"boolean"}},{"name":"sameParameters","optional":false,"visibility":"protected","description":"The intent parameters are the parameters of the hash that are not technical parameters
","typeInfo":{"template":"boolean"}},{"name":"sameAppSpecificRoute","optional":false,"visibility":"protected","description":"The app specific route is the part of the hash after the shell part
","typeInfo":{"template":"boolean"}}],"displayName":"sap.ushell.base.UrlParsing.HashComparison","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.base.UrlParsing.HashComparison","subTitle":""},{"kind":"namespace","name":"sap.ushell.bootstrap.Config","basename":"Config","resource":"sap/ushell/bootstrap/Config.js","module":"sap/ushell/bootstrap/Config","export":"","static":true,"visibility":"restricted","allowedFor":["sap.ushell_abap"],"since":"1.147.0","description":"
Singleton responsible for initializing and providing access to the ushell configuration.
","methods":[{"name":"applyModulePaths","visibility":"restricted","allowedFor":["sap.ushell_abap"],"since":"1.147.0","description":"Applies the configured module paths to the UI5 loader. Converts dot-notation paths from the ushell config to slash-notation.
","href":"api/sap.ushell.bootstrap.Config#methods/applyModulePaths","code":"applyModulePaths() : void "},{"name":"extendConfig","visibility":"restricted","allowedFor":["sap.ushell_abap"],"since":"1.147.0","parameters":[{"name":"oMutatedBaseConfig","optional":false,"description":"
the configuration to merge into, modified in place
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"oConfigToMerge","optional":false,"description":"
the configuration to be merged with oMutatedBaseConfig
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bCloneConfigToMerge","optional":false,"description":"
whether the oConfigToMerge must be cloned prior to the merge
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Merge the object oConfigToMerge into oMutatedBaseConfig according to sap-ushell-config merge rules. Note that the JSON serialized content of oConfigToMerge is used, thus JSON serialization restrictions apply (e.g. Infinity -> null ). Note that it is thus not possible to remove a property definition or overriding with {\"propname\" : undefined}. One has to override with null or 0 etc.
Note: Do not use this method for general merging of other objects, as the rules may be enhanced/altered
","href":"api/sap.ushell.bootstrap.Config#methods/extendConfig","code":"extendConfig(oMutatedBaseConfig, oConfigToMerge, bCloneConfigToMerge) : void "},{"name":"get","visibility":"restricted","allowedFor":["sap.ushell_abap"],"since":"1.147.0","returnValue":{"type":"object","description":"The merged ushell configuration
","typeInfo":{"template":"object"}},"throws":[{"type":"Error","description":"If called before #initialize
","linkEnabled":false}],"description":"Returns the merged ushell configuration object.
","href":"api/sap.ushell.bootstrap.Config#methods/get","code":"get() : object "},{"name":"getUI5Config","visibility":"restricted","allowedFor":["sap.ushell_abap"],"since":"1.147.0","returnValue":{"type":"object","description":"An object with camelCase keys: sapUiPreload, sapUiCompatVersion, sapUiLibs, sapUiActiveTerminologies
","typeInfo":{"template":"object"}},"throws":[{"type":"Error","description":"If called before #initialize
","linkEnabled":false}],"description":"Returns generic UI5 bootstrap configuration derived from the ushell config.
","href":"api/sap.ushell.bootstrap.Config#methods/getUI5Config","code":"getUI5Config() : object "},{"name":"getV2MigrationConfig","visibility":"restricted","allowedFor":["sap.ushell_abap"],"since":"1.147.0","returnValue":{"type":"object","description":"The migrated config, ONLY the migrated part
","typeInfo":{"template":"object"}},"parameters":[{"name":"oUshellConfig","optional":false,"description":"
The ushell config
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Migrates the config for the v2 services based on their predecessor. Does only work for plain values, not for functions and class instances.
","href":"api/sap.ushell.bootstrap.Config#methods/getV2MigrationConfig","code":"getV2MigrationConfig(oUshellConfig) : object "},{"name":"initialize","visibility":"restricted","allowedFor":["sap.ushell_abap"],"parameters":[{"name":"oPlatformDefaults","optional":true,"description":"
Platform-specific default ushell configuration
","typeInfo":{"template":"object"},"defaultValue":""}],"throws":[{"type":"Error","description":"If called more than once
","linkEnabled":false}],"description":"Initializes the ushell configuration by merging the different sources according to this priority order: 1) URL overwrites 2) meta tags 3) provided platform defaults 4) window config (deprecated)
","href":"api/sap.ushell.bootstrap.Config#methods/initialize","code":"initialize(oPlatformDefaults?) : void "}],"displayName":"sap.ushell.bootstrap.Config","component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.bootstrap.Config","subTitle":""},{"kind":"class","name":"sap.ushell.components.factsheet.controls.PictureTile","basename":"PictureTile","resource":"sap/ushell/components/factsheet/controls/PictureTile.js","module":"sap/ushell/components/factsheet/controls/PictureTile","export":"","static":true,"visibility":"public","extends":"sap.m.CustomTile","description":"Tile control embedding an image and allowing custom sizing
","ui5-metamodel":true,"ui5-metadata":{"stereotype":"control","properties":[{"name":"height","defaultValue":"32px","group":"Dimension","visibility":"public","methods":["getHeight","setHeight"],"typeInfo":{"UI5Types":["sap.ui.core.CSSSize"]},"description":""},{"name":"width","defaultValue":"32px","group":"Dimension","visibility":"public","methods":["getWidth","setWidth"],"typeInfo":{"UI5Types":["sap.ui.core.CSSSize"]},"description":""}],"associations":[{"name":"tileContent","singularName":"tileContent","type":"sap.ushell.components.factsheet.controls.PictureViewerItem","cardinality":"0..1","visibility":"public","methods":["getTileContent","setTileContent"],"linkEnabled":true,"description":""}]},"constructor":{"visibility":"public","parameters":[{"name":"sId","optional":true,"description":"
id for the new control, generated automatically if no id is given
","phoneName":"sId","depth":0,"types":[],"typeInfo":{"template":"string"},"defaultValue":""},{"name":"mSettings","optional":true,"description":"
initial settings for the new control
","phoneName":"mSettings","depth":0,"types":[],"typeInfo":{"template":"object"},"defaultValue":""}],"description":"Constructor for a new components/factsheet/controls/PictureTile.
Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
","references":[],"codeExample":"new sap.ushell.components.factsheet.controls.PictureTile(sId?, mSettings?) "},"events":[{"name":"pictureDelete","visibility":"public","parameters":[{"name":"oControlEvent","typeInfo":{"UI5Types":["sap.ui.base.Event"]}},{"name":"getSource","optional":false,"depth":1,"phoneName":"oControlEvent.getSource","typeInfo":{"UI5Types":["sap.ui.base.EventProvider"]}},{"name":"getParameters","optional":false,"depth":1,"phoneName":"oControlEvent.getParameters","typeInfo":{"template":"object"}}]}],"methods":[{"name":"attachPictureDelete","visibility":"public","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"oData","optional":true,"description":"
An application-specific payload object that will be passed to the event handler along with the event object when firing the event
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"fnFunction","optional":false,"description":"
The function to be called when the event occurs
","typeInfo":{"template":"function(${0}) : void","UI5Types":["sap.ui.base.Event"]},"defaultValue":""},{"name":"oListener","optional":true,"description":"
Context object to call the event handler with. Defaults to this sap.ushell.components.factsheet.controls.PictureTile itself
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Attaches event handler fnFunction to the pictureDelete event of this sap.ushell.components.factsheet.controls.PictureTile.
When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ushell.components.factsheet.controls.PictureTile itself.
","href":"api/sap.ushell.components.factsheet.controls.PictureTile#methods/attachPictureDelete","code":"attachPictureDelete(oData?, fnFunction, oListener?) : this "},{"name":"detachPictureDelete","visibility":"public","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"fnFunction","optional":false,"description":"
The function to be called, when the event occurs
","typeInfo":{"template":"function(${0}) : void","UI5Types":["sap.ui.base.Event"]},"defaultValue":""},{"name":"oListener","optional":true,"description":"
Context object on which the given function had to be called
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Detaches event handler fnFunction from the pictureDelete event of this sap.ushell.components.factsheet.controls.PictureTile.
The passed function and listener object must match the ones used for event registration.
","href":"api/sap.ushell.components.factsheet.controls.PictureTile#methods/detachPictureDelete","code":"detachPictureDelete(fnFunction, oListener?) : this "},{"name":"sap.ushell.components.factsheet.controls.PictureTile.extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function
","typeInfo":{"template":"function"}},"parameters":[{"name":"sClassName","optional":false,"description":"
Name of the class being created
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"
Object literal with information about the class
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Creates a new subclass of class sap.ushell.components.factsheet.controls.PictureTile with name sClassName and enriches it with the information contained in oClassInfo.
oClassInfo might contain the same kind of information as described in sap.m.CustomTile.extend .
","href":"api/sap.ushell.components.factsheet.controls.PictureTile#methods/sap.ushell.components.factsheet.controls.PictureTile.extend","code":"sap.ushell.components.factsheet.controls.PictureTile.extend(sClassName, oClassInfo?, FNMetaImpl?) : function "},{"name":"firePictureDelete","visibility":"protected","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"mParameters","optional":true,"description":"
Parameters to pass along with the event
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Fires event pictureDelete to attached listeners.
","href":"api/sap.ushell.components.factsheet.controls.PictureTile#methods/firePictureDelete","code":"firePictureDelete(mParameters?) : this "},{"name":"getHeight","visibility":"public","returnValue":{"type":"sap.ui.core.CSSSize","description":"Value of property height
","typeInfo":{"UI5Types":["sap.ui.core.CSSSize"]}},"description":"Gets current value of property height .
Default value is \"32px\".
","href":"api/sap.ushell.components.factsheet.controls.PictureTile#methods/getHeight","code":"getHeight() : sap.ui.core.CSSSize "},{"name":"sap.ushell.components.factsheet.controls.PictureTile.getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.core.ElementMetadata","description":"Metadata object describing this class
","typeInfo":{"UI5Types":["sap.ui.core.ElementMetadata"]}},"description":"Returns a metadata object for class sap.ushell.components.factsheet.controls.PictureTile.
","href":"api/sap.ushell.components.factsheet.controls.PictureTile#methods/sap.ushell.components.factsheet.controls.PictureTile.getMetadata","code":"sap.ushell.components.factsheet.controls.PictureTile.getMetadata() : sap.ui.core.ElementMetadata "},{"name":"getTileContent","visibility":"public","returnValue":{"type":"sap.ui.core.ID|null","typeInfo":{"template":"${0} | null","UI5Types":["sap.ui.core.ID"]},"description":""},"description":"ID of the element which is the current target of the association tileContent , or null.
","href":"api/sap.ushell.components.factsheet.controls.PictureTile#methods/getTileContent","code":"getTileContent() : sap.ui.core.ID|null "},{"name":"getWidth","visibility":"public","returnValue":{"type":"sap.ui.core.CSSSize","description":"Value of property width
","typeInfo":{"UI5Types":["sap.ui.core.CSSSize"]}},"description":"Gets current value of property width .
Default value is \"32px\".
","href":"api/sap.ushell.components.factsheet.controls.PictureTile#methods/getWidth","code":"getWidth() : sap.ui.core.CSSSize "},{"name":"setHeight","visibility":"public","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"sHeight","optional":true,"defaultValue":"\"32px\"","description":"
New value for property height
","typeInfo":{"UI5Types":["sap.ui.core.CSSSize"]}}],"description":"Sets a new value for property height .
When called with a value of null or undefined, the default value of the property will be restored.
Default value is \"32px\".
","href":"api/sap.ushell.components.factsheet.controls.PictureTile#methods/setHeight","code":"setHeight(sHeight?) : this "},{"name":"setTileContent","visibility":"public","returnValue":{"type":"sap.ushell.components.factsheet.controls.PictureTile","description":"this to allow method chaining
","typeInfo":{"UI5Types":["sap.ushell.components.factsheet.controls.PictureTile"]}},"parameters":[{"name":"vTileContent","optional":false,"description":"
Id of an element which becomes the new target of this tileContent association. Alternatively, an element instance may be given.
","typeInfo":{"template":"string | ${0}","UI5Types":["sap.ushell.components.factsheet.controls.PictureViewerItem"]},"defaultValue":""}],"description":"Reference to one PictureViewerItem coming from the PictureViewer.
","deprecated":{"since":"1.22","text":"Please use {@link sap.m.Carousel} instead."},"href":"api/sap.ushell.components.factsheet.controls.PictureTile#methods/setTileContent","deprecatedText":"Deprecated as of version 1.22. Please use sap.m.Carousel instead.","code":"setTileContent(vTileContent) : sap.ushell.components.factsheet.controls.PictureTile "},{"name":"setWidth","visibility":"public","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"sWidth","optional":true,"defaultValue":"\"32px\"","description":"
New value for property width
","typeInfo":{"UI5Types":["sap.ui.core.CSSSize"]}}],"description":"Sets a new value for property width .
When called with a value of null or undefined, the default value of the property will be restored.
Default value is \"32px\".
","href":"api/sap.ushell.components.factsheet.controls.PictureTile#methods/setWidth","code":"setWidth(sWidth?) : this "}],"displayName":"sap.ushell.components.factsheet.controls.PictureTile","component":"CA-UI2-AR-BE","hasSample":false,"title":"class sap.ushell.components.factsheet.controls.PictureTile","subTitle":"Deprecated in version: 1.22","deprecatedText":"Deprecated as of version 1.22. Please use sap.m.Carousel instead.PictureTile is used in PictureViewer control and is not meant to be consumed outside of PictureViewer usage. PictureViewer was replacing the sap.m.Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully functional, please use sap.m.Carousel instead. This control will not be supported anymore."},{"kind":"class","name":"sap.ushell.components.factsheet.controls.PictureViewer","basename":"PictureViewer","resource":"sap/ushell/components/factsheet/controls/PictureViewer.js","module":"sap/ushell/components/factsheet/controls/PictureViewer","export":"","static":true,"visibility":"public","extends":"sap.m.TileContainer","description":"Picture viewer control relying on the TileContainer control
","ui5-metamodel":true,"ui5-metadata":{"stereotype":"control","properties":[{"name":"removable","defaultValue":false,"group":"Misc","visibility":"public","methods":["getRemovable","setRemovable"],"typeInfo":{"template":"boolean"},"description":""},{"name":"tileScaling","defaultValue":0.95,"group":"Misc","visibility":"public","description":"Percentage of the space occupied by the image in the picture viewer control. Please note that if the factor is too close to 1, the navigation arrows usually displayed in desktop mode will not be available
","methods":["getTileScaling","setTileScaling"],"typeInfo":{"template":"float"}}],"aggregations":[{"name":"items","singularName":"item","type":"sap.ushell.components.factsheet.controls.PictureViewerItem","cardinality":"0..n","visibility":"public","methods":["getItems","destroyItems","insertItem","addItem","removeItem","indexOfItem","removeAllItems"],"linkEnabled":true,"description":""}],"defaultAggregation":"items"},"constructor":{"visibility":"public","parameters":[{"name":"sId","optional":true,"description":"
id for the new control, generated automatically if no id is given
","phoneName":"sId","depth":0,"types":[],"typeInfo":{"template":"string"},"defaultValue":""},{"name":"mSettings","optional":true,"description":"
initial settings for the new control
","phoneName":"mSettings","depth":0,"types":[],"typeInfo":{"template":"object"},"defaultValue":""}],"description":"Constructor for a new components/factsheet/controls/PictureViewer.
Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
","references":[],"codeExample":"new sap.ushell.components.factsheet.controls.PictureViewer(sId?, mSettings?) "},"events":[{"name":"pictureDeleted","visibility":"public","parameters":[{"name":"oControlEvent","typeInfo":{"UI5Types":["sap.ui.base.Event"]}},{"name":"getSource","optional":false,"depth":1,"phoneName":"oControlEvent.getSource","typeInfo":{"UI5Types":["sap.ui.base.EventProvider"]}},{"name":"getParameters","optional":false,"depth":1,"phoneName":"oControlEvent.getParameters","typeInfo":{"template":"object"}}]}],"methods":[{"name":"addItem","visibility":"public","returnValue":{"type":"sap.ushell.components.factsheet.controls.PictureViewer","description":"this to allow method chaining
","typeInfo":{"UI5Types":["sap.ushell.components.factsheet.controls.PictureViewer"]}},"parameters":[{"name":"oItem","optional":false,"description":"
the item to add; if empty, nothing is inserted
","typeInfo":{"UI5Types":["sap.ushell.components.factsheet.controls.PictureViewerItem"]},"defaultValue":""}],"description":"Adds some item oItem to the aggregation named items. Deprecated, use aggregation \"tiles\".
","deprecated":{"since":"1.18","text":"Please use aggregation \"tiles\" instead. Also consider using {@link sap.m.Carousel} as the PictureViewer itself is deprecated."},"href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/addItem","deprecatedText":"Deprecated as of version 1.18. Please use aggregation \"tiles\" instead. Also consider using sap.m.Carousel as the PictureViewer itself is deprecated.","code":"addItem(oItem) : sap.ushell.components.factsheet.controls.PictureViewer "},{"name":"attachPictureDeleted","visibility":"public","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"oData","optional":true,"description":"
An application-specific payload object that will be passed to the event handler along with the event object when firing the event
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"fnFunction","optional":false,"description":"
The function to be called when the event occurs
","typeInfo":{"template":"function(${0}) : void","UI5Types":["sap.ui.base.Event"]},"defaultValue":""},{"name":"oListener","optional":true,"description":"
Context object to call the event handler with. Defaults to this sap.ushell.components.factsheet.controls.PictureViewer itself
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Attaches event handler fnFunction to the pictureDeleted event of this sap.ushell.components.factsheet.controls.PictureViewer.
When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ushell.components.factsheet.controls.PictureViewer itself.
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/attachPictureDeleted","code":"attachPictureDeleted(oData?, fnFunction, oListener?) : this "},{"name":"deletePicture","visibility":"public","returnValue":{"type":"sap.ushell.components.factsheet.controls.PictureViewer","description":"this to allow method chaining
","typeInfo":{"UI5Types":["sap.ushell.components.factsheet.controls.PictureViewer"]}},"parameters":[{"name":"iIndex","optional":false,"description":"
the 0-based index of the picture collection to delete; if iIndex is out of range or empty, the current image will be deleted.
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Removes the picture at index iIndex from the items aggregation.
","deprecated":{"since":"1.22","text":"Please use {@link sap.m.Carousel} instead."},"href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/deletePicture","deprecatedText":"Deprecated as of version 1.22. Please use sap.m.Carousel instead.","code":"deletePicture(iIndex) : sap.ushell.components.factsheet.controls.PictureViewer "},{"name":"destroyItems","visibility":"public","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"description":"Destroys all the items in the aggregation items .
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/destroyItems","code":"destroyItems() : this "},{"name":"detachPictureDeleted","visibility":"public","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"fnFunction","optional":false,"description":"
The function to be called, when the event occurs
","typeInfo":{"template":"function(${0}) : void","UI5Types":["sap.ui.base.Event"]},"defaultValue":""},{"name":"oListener","optional":true,"description":"
Context object on which the given function had to be called
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Detaches event handler fnFunction from the pictureDeleted event of this sap.ushell.components.factsheet.controls.PictureViewer.
The passed function and listener object must match the ones used for event registration.
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/detachPictureDeleted","code":"detachPictureDeleted(fnFunction, oListener?) : this "},{"name":"sap.ushell.components.factsheet.controls.PictureViewer.extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function
","typeInfo":{"template":"function"}},"parameters":[{"name":"sClassName","optional":false,"description":"
Name of the class being created
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"
Object literal with information about the class
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Creates a new subclass of class sap.ushell.components.factsheet.controls.PictureViewer with name sClassName and enriches it with the information contained in oClassInfo.
oClassInfo might contain the same kind of information as described in sap.m.TileContainer.extend .
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/sap.ushell.components.factsheet.controls.PictureViewer.extend","code":"sap.ushell.components.factsheet.controls.PictureViewer.extend(sClassName, oClassInfo?, FNMetaImpl?) : function "},{"name":"firePictureDeleted","visibility":"protected","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"mParameters","optional":true,"description":"
Parameters to pass along with the event
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Fires event pictureDeleted to attached listeners.
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/firePictureDeleted","code":"firePictureDeleted(mParameters?) : this "},{"name":"getCurrentPictureIndex","visibility":"public","returnValue":{"type":"sap.ushell.components.factsheet.controls.PictureViewer","description":"the current picture index
","typeInfo":{"UI5Types":["sap.ushell.components.factsheet.controls.PictureViewer"]}},"description":"Gets the current picture index.
","deprecated":{"since":"1.22","text":"Please use {@link sap.m.Carousel} instead."},"href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/getCurrentPictureIndex","deprecatedText":"Deprecated as of version 1.22. Please use sap.m.Carousel instead.","code":"getCurrentPictureIndex() : sap.ushell.components.factsheet.controls.PictureViewer "},{"name":"getItems","visibility":"public","returnValue":{"type":"sap.ushell.components.factsheet.controls.PictureViewerItem[]","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.components.factsheet.controls.PictureViewerItem"]},"description":""},"description":"Gets content of aggregation items .
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/getItems","code":"getItems() : sap.ushell.components.factsheet.controls.PictureViewerItem[] "},{"name":"sap.ushell.components.factsheet.controls.PictureViewer.getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.core.ElementMetadata","description":"Metadata object describing this class
","typeInfo":{"UI5Types":["sap.ui.core.ElementMetadata"]}},"description":"Returns a metadata object for class sap.ushell.components.factsheet.controls.PictureViewer.
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/sap.ushell.components.factsheet.controls.PictureViewer.getMetadata","code":"sap.ushell.components.factsheet.controls.PictureViewer.getMetadata() : sap.ui.core.ElementMetadata "},{"name":"getRemovable","visibility":"public","returnValue":{"type":"boolean","description":"Value of property removable
","typeInfo":{"template":"boolean"}},"description":"Gets current value of property removable .
Default value is false.
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/getRemovable","code":"getRemovable() : boolean "},{"name":"getTileScaling","visibility":"public","returnValue":{"type":"float","description":"Value of property tileScaling
","typeInfo":{"template":"float"}},"description":"Gets current value of property tileScaling .
Percentage of the space occupied by the image in the picture viewer control. Please note that if the factor is too close to 1, the navigation arrows usually displayed in desktop mode will not be available
Default value is 0.95.
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/getTileScaling","code":"getTileScaling() : float "},{"name":"indexOfItem","visibility":"public","returnValue":{"type":"int","description":"The index of the provided control in the aggregation if found, or -1 otherwise
","typeInfo":{"template":"int"}},"parameters":[{"name":"oItem","optional":false,"description":"
The item whose index is looked for
","typeInfo":{"UI5Types":["sap.ushell.components.factsheet.controls.PictureViewerItem"]},"defaultValue":""}],"description":"Checks for the provided sap.ushell.components.factsheet.controls.PictureViewerItem in the aggregation items . and returns its index if found or -1 otherwise.
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/indexOfItem","code":"indexOfItem(oItem) : int "},{"name":"insertItem","visibility":"public","returnValue":{"type":"sap.ushell.components.factsheet.controls.PictureViewer","description":"this to allow method chaining
","typeInfo":{"UI5Types":["sap.ushell.components.factsheet.controls.PictureViewer"]}},"parameters":[{"name":"oItem","optional":false,"description":"
the item to insert; if empty, nothing is inserted
","typeInfo":{"UI5Types":["sap.ushell.components.factsheet.controls.PictureViewerItem"]},"defaultValue":""},{"name":"iIndex","optional":false,"description":"
the 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Inserts a item into the aggregation named items. When adding a new item to the aggregation, a sap.ca.ui.PictureTile is actually created with its own ID and added to the internal TileContainer. Deprecated, use aggregation \"tiles\".
","deprecated":{"since":"1.18","text":"Please use aggregation \"tiles\" instead. Also consider using {@link sap.m.Carousel} as the PictureViewer itself is deprecated."},"href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/insertItem","deprecatedText":"Deprecated as of version 1.18. Please use aggregation \"tiles\" instead. Also consider using sap.m.Carousel as the PictureViewer itself is deprecated.","code":"insertItem(oItem, iIndex) : sap.ushell.components.factsheet.controls.PictureViewer "},{"name":"removeAllItems","visibility":"public","returnValue":{"type":"sap.ushell.components.factsheet.controls.PictureViewerItem[]","description":"An array of the removed elements (might be empty)
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.components.factsheet.controls.PictureViewerItem"]}},"description":"Removes all the controls from the aggregation items .
Additionally, it unregisters them from the hosting UIArea.
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/removeAllItems","code":"removeAllItems() : sap.ushell.components.factsheet.controls.PictureViewerItem[] "},{"name":"removeItem","visibility":"public","returnValue":{"type":"sap.ushell.components.factsheet.controls.PictureViewerItem|null","description":"The removed item or null
","typeInfo":{"template":"${0} | null","UI5Types":["sap.ushell.components.factsheet.controls.PictureViewerItem"]}},"parameters":[{"name":"vItem","optional":false,"description":"
The item to remove or its index or id
","typeInfo":{"template":"int | string | ${0}","UI5Types":["sap.ushell.components.factsheet.controls.PictureViewerItem"]},"defaultValue":""}],"description":"Removes a item from the aggregation items .
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/removeItem","code":"removeItem(vItem) : sap.ushell.components.factsheet.controls.PictureViewerItem|null "},{"name":"selectPicture","visibility":"public","returnValue":{"type":"sap.ushell.components.factsheet.controls.PictureViewer","description":"this to allow method chaining
","typeInfo":{"UI5Types":["sap.ushell.components.factsheet.controls.PictureViewer"]}},"parameters":[{"name":"iIndex","optional":false,"description":"
the 0-based index of the aggregation to select; for a negative value of iIndex, the picture at position 0 is selected; for a value greater than the current size of the aggregation, the selected picture at the last position is selected
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Select the picture at index iIndex from the items aggregation.
","deprecated":{"since":"1.22","text":"Please use {@link sap.m.Carousel} instead."},"href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/selectPicture","deprecatedText":"Deprecated as of version 1.22. Please use sap.m.Carousel instead.","code":"selectPicture(iIndex) : sap.ushell.components.factsheet.controls.PictureViewer "},{"name":"setRemovable","visibility":"public","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"bRemovable","optional":true,"defaultValue":false,"description":"
New value for property removable
","typeInfo":{"template":"boolean"}}],"description":"Sets a new value for property removable .
When called with a value of null or undefined, the default value of the property will be restored.
Default value is false.
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/setRemovable","code":"setRemovable(bRemovable?) : this "},{"name":"setTileScaling","visibility":"public","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"fTileScaling","optional":true,"defaultValue":0.95,"description":"
New value for property tileScaling
","typeInfo":{"template":"float"}}],"description":"Sets a new value for property tileScaling .
Percentage of the space occupied by the image in the picture viewer control. Please note that if the factor is too close to 1, the navigation arrows usually displayed in desktop mode will not be available
When called with a value of null or undefined, the default value of the property will be restored.
Default value is 0.95.
","href":"api/sap.ushell.components.factsheet.controls.PictureViewer#methods/setTileScaling","code":"setTileScaling(fTileScaling?) : this "}],"displayName":"sap.ushell.components.factsheet.controls.PictureViewer","component":"CA-UI2-AR-BE","hasSample":false,"title":"class sap.ushell.components.factsheet.controls.PictureViewer","subTitle":"Deprecated in version: 1.22","deprecatedText":"Deprecated as of version 1.22. Please use sap.m.Carousel instead. PictureViewer was replacing the Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully functional, please use sap.m.Carousel instead. This control will not be supported anymore."},{"kind":"class","name":"sap.ushell.components.factsheet.controls.PictureViewerItem","basename":"PictureViewerItem","resource":"sap/ushell/components/factsheet/controls/PictureViewerItem.js","module":"sap/ushell/components/factsheet/controls/PictureViewerItem","export":"","static":true,"visibility":"public","extends":"sap.ui.core.Control","description":"Picture viewer control relying on the TileContainer control
","ui5-metamodel":true,"ui5-metadata":{"stereotype":"control","properties":[{"name":"src","defaultValue":"","group":"Misc","visibility":"public","methods":["getSrc","setSrc"],"typeInfo":{"template":"string"},"description":""}],"aggregations":[{"name":"image","singularName":"image","type":"sap.m.Image","cardinality":"0..1","visibility":"public","methods":["getImage","destroyImage","setImage"],"linkEnabled":true,"description":""}]},"constructor":{"visibility":"public","parameters":[{"name":"sId","optional":true,"description":"
id for the new control, generated automatically if no id is given
","phoneName":"sId","depth":0,"types":[],"typeInfo":{"template":"string"},"defaultValue":""},{"name":"mSettings","optional":true,"description":"
initial settings for the new control
","phoneName":"mSettings","depth":0,"types":[],"typeInfo":{"template":"object"},"defaultValue":""}],"description":"Constructor for a new components/factsheet/controls/PictureViewerItem.
Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
","references":[],"codeExample":"new sap.ushell.components.factsheet.controls.PictureViewerItem(sId?, mSettings?) "},"methods":[{"name":"destroyImage","visibility":"public","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"description":"Destroys the image in the aggregation image .
","href":"api/sap.ushell.components.factsheet.controls.PictureViewerItem#methods/destroyImage","code":"destroyImage() : this "},{"name":"sap.ushell.components.factsheet.controls.PictureViewerItem.extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function
","typeInfo":{"template":"function"}},"parameters":[{"name":"sClassName","optional":false,"description":"
Name of the class being created
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"
Object literal with information about the class
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Creates a new subclass of class sap.ushell.components.factsheet.controls.PictureViewerItem with name sClassName and enriches it with the information contained in oClassInfo.
oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend .
","href":"api/sap.ushell.components.factsheet.controls.PictureViewerItem#methods/sap.ushell.components.factsheet.controls.PictureViewerItem.extend","code":"sap.ushell.components.factsheet.controls.PictureViewerItem.extend(sClassName, oClassInfo?, FNMetaImpl?) : function "},{"name":"getImage","visibility":"public","returnValue":{"type":"sap.m.Image","typeInfo":{"UI5Types":["sap.m.Image"]},"description":""},"description":"Gets content of aggregation image .
","href":"api/sap.ushell.components.factsheet.controls.PictureViewerItem#methods/getImage","code":"getImage() : sap.m.Image "},{"name":"sap.ushell.components.factsheet.controls.PictureViewerItem.getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.core.ElementMetadata","description":"Metadata object describing this class
","typeInfo":{"UI5Types":["sap.ui.core.ElementMetadata"]}},"description":"Returns a metadata object for class sap.ushell.components.factsheet.controls.PictureViewerItem.
","href":"api/sap.ushell.components.factsheet.controls.PictureViewerItem#methods/sap.ushell.components.factsheet.controls.PictureViewerItem.getMetadata","code":"sap.ushell.components.factsheet.controls.PictureViewerItem.getMetadata() : sap.ui.core.ElementMetadata "},{"name":"getSrc","visibility":"public","returnValue":{"type":"string","description":"Value of property src
","typeInfo":{"template":"string"}},"description":"Gets current value of property src .
","href":"api/sap.ushell.components.factsheet.controls.PictureViewerItem#methods/getSrc","code":"getSrc() : string "},{"name":"setImage","visibility":"public","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"oImage","optional":false,"description":"
The image to set
","typeInfo":{"UI5Types":["sap.m.Image"]},"defaultValue":""}],"description":"Sets the aggregated image .
","href":"api/sap.ushell.components.factsheet.controls.PictureViewerItem#methods/setImage","code":"setImage(oImage) : this "},{"name":"setSrc","visibility":"public","returnValue":{"type":"sap.ushell.components.factsheet.controls.PictureViewerItem","description":"this to allow method chaining
","typeInfo":{"UI5Types":["sap.ushell.components.factsheet.controls.PictureViewerItem"]}},"parameters":[{"name":"sSrc","optional":false,"description":"
new value for property src
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Setter for property src.
Default value is empty/undefined
","deprecated":{"since":"1.22","text":"Please use {@link sap.m.Carousel} instead."},"href":"api/sap.ushell.components.factsheet.controls.PictureViewerItem#methods/setSrc","deprecatedText":"Deprecated as of version 1.22. Please use sap.m.Carousel instead.","code":"setSrc(sSrc) : sap.ushell.components.factsheet.controls.PictureViewerItem "}],"displayName":"sap.ushell.components.factsheet.controls.PictureViewerItem","component":"CA-UI2-AR-BE","hasSample":false,"title":"class sap.ushell.components.factsheet.controls.PictureViewerItem","subTitle":"Deprecated in version: 1.22","deprecatedText":"Deprecated as of version 1.22. Please use sap.m.Carousel instead. PictureViewerItem is used in PictureViewer control and is not meant to be consumed outside of PictureViewer usage. PictureViewer was replacing the Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully functional, please use sap.m.Carousel instead. This control will not be supported anymore."},{"kind":"namespace","name":"sap.ushell.Container","basename":"Container","resource":"sap/ushell/Container.js","module":"sap/ushell/Container","export":"","static":true,"visibility":"public","since":"1.15.0","description":"
The Unified Shell's container. Manages renderers, services, and adapters. The container is designed to be a singleton, therefore instead of creating an instance, access the central one via
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n // do something with the container\n });\n ","properties":[{"name":"DirtyState","visibility":"public","since":"1.21.1","description":"An enumeration for the application work protect mode state.
","deprecated":{"since":"1.146","text":"the concept has been abandoned."},"deprecatedText":"Deprecated as of version 1.146. the concept has been abandoned.","typeInfo":{"UI5Types":["sap.ushell.Container.DirtyState"],"refersToTypedef":true}}],"methods":[{"name":"addRemoteSystem","visibility":"public","since":"1.15.0","parameters":[{"name":"oRemoteSystem","optional":false,"description":"
Remote system to be added.
","typeInfo":{"UI5Types":["sap.ushell.System"]},"defaultValue":""}],"description":"Adds a system to the list of remote systems currently in use. On logout this list is processed and performs a logout for each system via the ContainerAdapter specific for its platform.
","href":"api/sap.ushell.Container#methods/addRemoteSystem","code":"addRemoteSystem(oRemoteSystem) : void "},{"name":"attachLogoutEvent","visibility":"public","since":"1.19.1","parameters":[{"name":"fnFunction","optional":false,"description":"
Event handler to be attached.
","typeInfo":{"template":"function"},"defaultValue":""},{"name":"bAsyncFunction","optional":false,"description":"
Whether the function returns a Promise to wait for its resolvent (since 1.81.0).
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Attaches a listener to the logout event. In case the bAsyncFunction parameter is true, the fnFunction must return a promise. FLP will wait for the promise to be resolved before doing the actual logout.
","href":"api/sap.ushell.Container#methods/attachLogoutEvent","code":"attachLogoutEvent(fnFunction, bAsyncFunction) : void "},{"name":"attachRendererCreatedEvent","visibility":"public","since":"1.34.1","parameters":[{"name":"fnFunction","optional":false,"description":"
Event handler to be attached. If a renderer is created, this function is called with a parameter of instance sap.ui.base.Event. The event object provides the instance of the created renderer as parameter "renderer". If the renderer is a SAPUI5 UI component (i.e. extend sap.ui.core.UIComponent), the event parameter returns the component instance, i.e. it unwraps the renderer component from its component container.
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Attaches a listener to the rendererCreated event.
","deprecated":{"since":"1.146","text":"the concept has been abandoned."},"href":"api/sap.ushell.Container#methods/attachRendererCreatedEvent","deprecatedText":"Deprecated as of version 1.146. the concept has been abandoned.","code":"attachRendererCreatedEvent(fnFunction) : void "},{"name":"cancelLogon","visibility":"public","since":"1.21.2","description":"Cancels the logon procedure in the current frame, if any. This MUST be used by the logon frame provider in case the user wants to close the logon frame for good. It will report \"Authentication cancelled\" and let all pending requests for the current realm fail. As a side-effect, it also calls destroy on the logon frame provider.
","deprecated":{"since":"1.120","text":"Deprecated without successor."},"href":"api/sap.ushell.Container#methods/cancelLogon","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor.","code":"cancelLogon() : void "},{"name":"createRenderer","visibility":"public","since":"1.15.0","returnValue":{"type":"sap.ui.core.Control|Promise|sap.ui.core.ComponentContainer|Promise","description":"the renderer or Promise (in asynchronous mode)
","typeInfo":{"template":"${0} | Promise<${1}> | ${2} | Promise<${3}>","UI5Types":["sap.ui.core.Control","sap.ui.core.Control","sap.ui.core.ComponentContainer","sap.ui.core.ComponentContainer"]}},"parameters":[{"name":"sRendererName","optional":true,"description":"
The renderer name, such as \"standard\" or \"acme.foo.bar.MyRenderer\"; it is taken from the configuration property defaultRenderer if not given here.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"bAsync","optional":true,"description":"
If true, the renderer is created asynchronously and a Promise is returned.
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Creates a new renderer instance for the given renderer name.
Names without a dot are interpreted as package names within the default naming convention and will be expanded to \"sap.ushell.renderers.\" + sRendererName + \".Renderer\". Names containing a dot are used \"as is\".
The resulting name must point to a SAPUI5 object which is first required and then instantiated (without arguments). The object is expected to be a UI component (i.e. extend sap.ui.core.UIComponent), which is then automatically wrapped into a sap.ui.core.ComponentContainer control by this method. The sap.ui.core.ComponentContainer is created with height and width set to \"100%\" to accommodate the complete available space. Besides UIComponents a control (i.e. extend sap.ui.core.Control) is accepted, too.
The returned renderer is supposed to be added to a direct child (for example div) of the body of the page and there should be no other parts of the page consuming space outside the renderer. Use CSS class sapUShellFullHeight at html, body and at the element to which the renderer is added to allow the renderer to use 100% height.
","deprecated":{"since":"1.120","text":"Deprecated without successor. Custom renderers are no longer supported."},"href":"api/sap.ushell.Container#methods/createRenderer","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor. Custom renderers are no longer supported.","code":"createRenderer(sRendererName?, bAsync?) : sap.ui.core.Control|Promise|sap.ui.core.ComponentContainer|Promise "},{"name":"deregisterDirtyStateProvider","visibility":"public","since":"1.67.0","parameters":[{"name":"fnDirty","optional":false,"description":"
function for determining the state of the application
","typeInfo":{"template":"function() : boolean"},"defaultValue":""}],"throws":[{"type":"TypeError","description":"If fnDirty is not a function.
","linkEnabled":false}],"description":"Deregister the work protection dirty callback function. See registerDirtyStateProvider for more information. Only the last registered function will be deregistered (in case it was registered multiple times).
","deprecated":{"since":"1.146","text":"replaced by {@link sap.ushell.navigation.DirtyState#deregisterDirtyStateProvider}."},"href":"api/sap.ushell.Container#methods/deregisterDirtyStateProvider","deprecatedText":"Deprecated as of version 1.146. replaced by sap.ushell.navigation.DirtyState#deregisterDirtyStateProvider .","code":"deregisterDirtyStateProvider(fnDirty) : void "},{"name":"detachLogoutEvent","visibility":"public","since":"1.19.1","parameters":[{"name":"fnFunction","optional":false,"description":"
Event handler to be detached.
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Detaches a listener from the logout event.
","href":"api/sap.ushell.Container#methods/detachLogoutEvent","code":"detachLogoutEvent(fnFunction) : void "},{"name":"detachRendererCreatedEvent","visibility":"public","since":"1.34.1","parameters":[{"name":"fnFunction","optional":false,"description":"
Event handler to be detached.
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Detaches a listener from the rendererCreated event.
","deprecated":{"since":"1.146","text":"the concept has been abandoned."},"href":"api/sap.ushell.Container#methods/detachRendererCreatedEvent","deprecatedText":"Deprecated as of version 1.146. the concept has been abandoned.","code":"detachRendererCreatedEvent(fnFunction) : void "},{"name":"getDirtyFlag","visibility":"public","since":"1.27.0","returnValue":{"type":"boolean","description":"The value of the dirty flag or the determined dirty state returned by the dirty state providers.
","typeInfo":{"template":"boolean"}},"description":"If the dirty state was set to 'false' using 'setDirtyFlag' the registered dirty state provider methods get called to determine the actual dirty state. The determined dirty state is then returned.
However, if the dirty state was previously set to 'true' using 'setDirtyFlag' the registered dirty state provider methods are ignored and the function simply returns 'true'.
","deprecated":{"since":"1.120","text":"replaced by {@link sap.ushell.navigation.DirtyState#getDirtyFlag}."},"href":"api/sap.ushell.Container#methods/getDirtyFlag","deprecatedText":"Deprecated as of version 1.120. replaced by sap.ushell.navigation.DirtyState#getDirtyFlag .","code":"getDirtyFlag() : boolean "},{"name":"getFLPUrlAsync","visibility":"restricted","allowedFor":["sap.fe","sap.suite.ui.generic"],"since":"1.87","returnValue":{"type":"Promise","description":"Resolves the FLP URL.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"bIncludeHash","optional":true,"defaultValue":false,"description":"
defines if the hash is added to the result.
","typeInfo":{"template":"boolean"}}],"description":"Async version of getFLPUrl
","href":"api/sap.ushell.Container#methods/getFLPUrlAsync","code":"getFLPUrlAsync(bIncludeHash?) : Promise "},{"name":"getGlobalDirty","visibility":"public","since":"1.21.1","returnValue":{"type":"jQuery.Promise","description":"Resolves the dirty state (see sap.ushell.Container.DirtyState ).
","typeInfo":{"template":"jQuery.Promise"}},"description":"Returns the global dirty state.
All open UShell browser windows for the same origin are asked about their global dirty state.
","deprecated":{"since":"1.120","text":"the concept has been abandoned. Use {@link sap.ushell.navigation.DirtyState#getDirtyFlag} instead."},"href":"api/sap.ushell.Container#methods/getGlobalDirty","deprecatedText":"Deprecated as of version 1.120. the concept has been abandoned. Use sap.ushell.navigation.DirtyState#getDirtyFlag instead.","code":"getGlobalDirty() : jQuery.Promise "},{"name":"getLogonSystem","visibility":"restricted","allowedFor":["sap.ui.fl"],"since":"1.15.0","returnValue":{"type":"sap.ushell.System","description":"object providing information about the system where the container is logged in.
","typeInfo":{"UI5Types":["sap.ushell.System"]}},"description":"Returns the logon system.
","href":"api/sap.ushell.Container#methods/getLogonSystem","code":"getLogonSystem() : sap.ushell.System "},{"name":"getRenderer","visibility":"public","since":"1.30.0","returnValue":{"type":"sap.ui.core.Control|sap.ui.core.Component","description":"the renderer with the specified name; the returned object is either a control (i.e. extend sap.ui.core.Control) or a UI component (i.e. extend sap.ui.core.UIComponent), i.e. this method unwraps the renderer component from its sap.ui.core.ComponentContainer; if no renderer name can be determined and a single renderer instance has been created, this single instance is returned.
","typeInfo":{"template":"${0} | ${1}","UI5Types":["sap.ui.core.Control","sap.ui.core.Component"]}},"parameters":[{"name":"sRendererName","optional":true,"description":"
The renderer name, such as \"standard\" or \"fiori2\"; it is taken from the configuration property defaultRenderer if not given here.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Gets a renderer instance for the given renderer name, that was created by the createRenderer method.
","deprecated":{"since":"1.120","text":"Use {@link sap.ushell.services.Extension} for shell extensions instead."},"href":"api/sap.ushell.Container#methods/getRenderer","deprecatedText":"Deprecated as of version 1.120. Use sap.ushell.services.Extension for shell extensions instead.","code":"getRenderer(sRendererName?) : sap.ui.core.Control|sap.ui.core.Component "},{"name":"getService","visibility":"public","since":"1.15.0","typeParameters":[{"name":"ServiceType","type":"sap.ushell.services.Service"},{"name":"ServiceName","type":"string","default":"string"}],"returnValue":{"type":"sap.ushell.services.Service|Promise","description":"the service or, in asynchronous mode, a Promise that returns the service
","typeInfo":{"template":"${0} | Promise","UI5Types":["sap.ushell.services.Service"]}},"parameters":[{"name":"sServiceName","optional":false,"description":"
The service name, such as \"Menu\"
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sParameter","optional":true,"description":"
A parameter which is passed to the service constructor and every adapter constructor. (since 1.15.0)
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"bAsync","optional":true,"description":"
if true, the adapter is loaded asynchronously and a Promise is returned. (since 1.55.0)
","typeInfo":{"template":"boolean"},"defaultValue":""}],"throws":[{"type":"Error","description":"If sServiceName is not the name of an available service.
","linkEnabled":false}],"description":"Returns a service with the given name, creating it if necessary. Services are singleton objects identified by their (resulting) name.
Names without a dot are interpreted as service names within the default naming convention and will be expanded to \"sap.ushell.services.\" + sServiceName. Names containing a dot are not yet supported. This name may be overridden via configuration. See example 2 below.
The resulting name must point to a constructor function which is first required as a SAPUI5 module and then called to create a service instance. The service will be passed to a corresponding service adapter for the current logon system, as well as a callback interface (of virtual type sap.ushell.services.ContainerInterface) to the container providing a method createAdapter(oSystem) to create further adapters for the same service but connected to remote systems. The third parameter will be sParameter as passed to this function. The fourth parameter will be an object with the property config supplied by the configuration. See example 2 below.
The adapter for the logon system will be created before the service. Its constructor gets three parameters. The first parameter is the logon system, the second parameter is sParameter and the third parameter is an object with the property config supplied by the configuration.
The service may declare itself adapterless by setting the property hasNoAdapter = true at the constructor function. In this case no adapter will be created and passed to the constructor and all other parameters will be shifted.
Example 1: The service sap.ushell.services.UserInfo is parameterless. It indicates this by setting sap.ushell.services.UserInfo.hasNoAdapter = true;.
Example 2: (Configuration)
\n window[\"sap-ushell-config\"] = {\n services: {\n Foo: {\n module: \"my.own.Foo\"\n config: {header: \"hidden\"},\n adapter: {\n module: \"my.own.FooAdapter\",\n config: {foo: \"bar\"}\n }\n }\n }\n }\n sap.ushell.Container.getServiceAsync(\"Foo\", \"runtimeConfig\")\n .then(function (Foo) {\n // Do something with the service\n });\n Now oService is an instance of my.own.Foo. The third parameter of the constructor will be \"runtimeConfig\", the fourth parameter {config: {header: \"hidden\"}}. Its adapter is an instance of my.own.FooAdapter constructed with the parameters logon system, \"runtimeConfig\" and {config: {foo: \"bar\"}}.Note that the api will throw a runtime error (or reject for async mode) if the service name does not reflect a service available.
","deprecated":{"since":"1.77","text":"Please use {@link #getServiceAsync} instead."},"references":["{@link sap.ushell.services.ContainerInterface} "],"href":"api/sap.ushell.Container#methods/getService","deprecatedText":"Deprecated as of version 1.77. Please use #getServiceAsync instead.","code":"getService(sServiceName, sParameter?, bAsync?) : sap.ushell.services.Service|Promise "},{"name":"getServiceAsync","visibility":"public","since":"1.55.0","typeParameters":[{"name":"ServiceType","type":"sap.ushell.services.Service"},{"name":"ServiceName","type":"string","default":"string"}],"returnValue":{"type":"Promise","description":"a Promise that returns the requested service
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.Service"]}},"parameters":[{"name":"sServiceName","optional":false,"description":"
The service name, such as \"Menu\"
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sParameter","optional":true,"description":"
A parameter which is passed to the service constructor and every adapter constructor.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns a Promise that resolves a service with the given name, creating it if necessary. Services are singleton objects identified by their (resulting) name.
Names without a dot are interpreted as service names within the default naming convention and will be expanded to \"sap.ushell.services.\" + sServiceName. Names containing a dot are not yet supported. This name may be overridden via configuration. See example 2 below.
The resulting name must point to a constructor function which is first required as a SAPUI5 module and then called to create a service instance. The service will be passed to a corresponding service adapter for the current logon system, as well as a callback interface (of virtual type sap.ushell.services.ContainerInterface) to the container providing a method createAdapter(oSystem) to create further adapters for the same service but connected to remote systems. The third parameter will be sParameter as passed to this function. The fourth parameter will be an object with the property config supplied by the configuration. See example 2 below.
The adapter for the logon system will be created before the service. Its constructor gets three parameters. The first parameter is the logon system, the second parameter is sParameter and the third parameter is an object with the property config supplied by the configuration.
The service may declare itself adapterless by setting the property hasNoAdapter = true at the constructor function. In this case no adapter will be created and passed to the constructor and all other parameters will be shifted.
Example 1: The service sap.ushell.services.UserInfo is parameterless. It indicates this by setting sap.ushell.services.UserInfo.hasNoAdapter = true;.
Example 2: (Configuration)
\n window[\"sap-ushell-config\"] = {\n services: {\n Foo: {\n module: \"my.own.Foo\"\n config: {header: \"hidden\"},\n adapter: {\n module: \"my.own.FooAdapter\",\n config: {foo: \"bar\"}\n }\n }\n }\n }\n sap.ushell.Container.getServiceAsync(\"Foo\", \"runtimeConfig\")\n .then(function (Foo) {\n // Do something with the service\n });\n Now the parameter provided in the promise handler is an instance of my.own.Foo. The third parameter of the constructor will be \"runtimeConfig\", the fourth parameter {config: {header: \"hidden\"}}. Its adapter is an instance of my.own.FooAdapter constructed with the parameters logon system, \"runtimeConfig\" and {config: {foo: \"bar\"}}.{@link sap.ushell.services.ContainerInterface} "],"href":"api/sap.ushell.Container#methods/getServiceAsync","code":"getServiceAsync(sServiceName, sParameter?) : Promise "},{"name":"logout","visibility":"public","since":"1.15.0","returnValue":{"type":"jQuery.Promise","description":"Resolves when logout is finished, even when it fails.
","typeInfo":{"template":"jQuery.Promise"}},"description":"Logs out the current user from all relevant back-end systems, including the logon system itself. This member represents the default native implementation of logout. If SessionHandler was created, we register the alternate logout function using registerLogout function.
","deprecated":{"since":"1.120","text":"Deprecated without successor."},"href":"api/sap.ushell.Container#methods/logout","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor.","code":"logout() : jQuery.Promise "},{"name":"ready","visibility":"restricted","allowedFor":["sap.ui.fl"],"since":"1.120.0","returnValue":{"type":"Promise","description":"Promise that resolves after init.
","typeInfo":{"template":"Promise"}},"description":"Returns a Promise that resolves when the Container instance has been initialized completely.
","href":"api/sap.ushell.Container#methods/ready","code":"ready() : Promise "},{"name":"registerDirtyStateProvider","visibility":"public","since":"1.31.0","parameters":[{"name":"fnDirty","optional":false,"description":"
Function for determining the state of the application. The callback is used to determine the current dirty state during a navigation. The function must return a boolean which determines if the current application is dirty or not. If true is returned the end user is prompted with a dialog where they need to confirm the potential data loss. The callback is called with a navigation context as its first parameter which can be used to determine the dirty state:
\n {\n isCrossAppNavigation: true, // Boolean which indicates if the navigation is inner app or across two different applications.\n innerAppRoute: \"&/SalesOrder/11\" // If it is an inner app navigation, it describes the inner app route.\n }\n ","typeInfo":{"template":"function() : boolean"},"defaultValue":""}],"throws":[{"type":"TypeError","description":"If fnDirty is not a function.
","linkEnabled":false}],"description":"Register the work protection dirty callback function. In the work protect mechanism, each platform can register their own method in order to check if data was changed during the session, and notify the container about the change. Registering multiple times the same function is allowed.
Use Function.prototype.bind() to determine the callback's this or some of its arguments.
","deprecated":{"since":"1.146","text":"replaced by {@link sap.ushell.navigation.DirtyState#registerDirtyStateProvider}."},"href":"api/sap.ushell.Container#methods/registerDirtyStateProvider","deprecatedText":"Deprecated as of version 1.146. replaced by sap.ushell.navigation.DirtyState#registerDirtyStateProvider .","code":"registerDirtyStateProvider(fnDirty) : void "},{"name":"setDirtyFlag","visibility":"public","since":"1.27.0","parameters":[{"name":"bIsDirty","optional":true,"description":"
The value of the dirty flag.
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Setter for the isDirty flag value.
Default value is false
","deprecated":{"since":"1.146","text":"replaced by {@link sap.ushell.navigation.DirtyState#setDirtyFlag}."},"href":"api/sap.ushell.Container#methods/setDirtyFlag","deprecatedText":"Deprecated as of version 1.146. replaced by sap.ushell.navigation.DirtyState#setDirtyFlag .","code":"setDirtyFlag(bIsDirty?) : void "}],"displayName":"sap.ushell.Container","nodes":[{"name":"sap.ushell.Container.DirtyState","description":"An enumeration for the application work protect mode state.
","href":"api/sap.ushell.Container.DirtyState","deprecated":true}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.Container","subTitle":""},{"kind":"typedef","name":"sap.ushell.Container.DirtyState","basename":"DirtyState","resource":"sap/ushell/Container.js","module":"sap/ushell/Container","static":true,"visibility":"public","since":"1.90.0","description":"
An enumeration for the application work protect mode state.
","properties":[{"name":"CLEAN","optional":false,"visibility":"public","description":"The embedded application is clean, there is no unsaved data.
","typeInfo":{"template":"\"CLEAN\""}},{"name":"DIRTY","optional":false,"visibility":"public","description":"The embedded application is dirty, the user has entered data that is not yet saved.
","typeInfo":{"template":"\"DIRTY\""}},{"name":"MAYBE_DIRTY","optional":false,"visibility":"public","description":"The embedded application container's dirty state cannot be determined because of technical reasons.
","typeInfo":{"template":"\"MAYBE_DIRTY\""}}],"displayName":"sap.ushell.Container.DirtyState","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.Container.DirtyState","subTitle":"Deprecated in version: 1.146","deprecatedText":"Deprecated as of version 1.146. the concept has been abandoned."},{"kind":"enum","name":"sap.ushell.ContentNodeType","basename":"ContentNodeType","resource":"sap/ushell/library.js","module":"sap/ushell/library","export":"ContentNodeType","static":true,"visibility":"public","description":"
Denotes the types of the content nodes.
This enum is part of the 'sap/ushell/library' module export and must be accessed by the property 'ContentNodeType'.
","ui5-metadata":{"stereotype":"enum"},"properties":[{"name":"sap.ushell.ContentNodeType.HomepageGroup","visibility":"public","description":"A group of the classic homepage
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage."},{"name":"sap.ushell.ContentNodeType.Page","visibility":"public","description":"A page which is assigned to a space in spaces mode
"},{"name":"sap.ushell.ContentNodeType.Space","visibility":"public","description":"A space in spaces mode
"},{"name":"sap.ushell.ContentNodeType.Visualization","visibility":"public","description":"A visualization which is assigned to a space in spaces mode
"}],"displayName":"sap.ushell.ContentNodeType","component":"CA-FLP-FE-UI","hasSample":false,"title":"enum sap.ushell.ContentNodeType","subTitle":""},{"kind":"enum","name":"sap.ushell.MenuEntryType","basename":"MenuEntryType","resource":"sap/ushell/library.js","module":"sap/ushell/library","export":"MenuEntryType","static":true,"visibility":"restricted","allowedFor":["FLP platforms"],"description":"
Denotes the types of the content nodes.
This enum is part of the 'sap/ushell/library' module export and must be accessed by the property 'MenuEntryType'.
","ui5-metadata":{"stereotype":"enum"},"properties":[{"name":"sap.ushell.MenuEntryType.IBN","visibility":"restricted","description":""},{"name":"sap.ushell.MenuEntryType.separator","visibility":"restricted","description":""},{"name":"sap.ushell.MenuEntryType.text","visibility":"restricted","description":""},{"name":"sap.ushell.MenuEntryType.URL","visibility":"restricted","description":""}],"displayName":"sap.ushell.MenuEntryType","component":"CA-FLP-FE-UI","hasSample":false,"title":"enum sap.ushell.MenuEntryType","subTitle":""},{"kind":"namespace","name":"sap.ushell.modules","basename":"modules","resource":"sap/ushell/library.js","module":"sap/ushell/library","export":"modules","static":true,"visibility":"restricted","since":"1.136.0","displayName":"sap.ushell.modules","nodes":[{"name":"sap.ushell.modules.Assistant","description":"The Assistant module API to set an AssistantProvider and Config.\n
","href":"api/sap.ushell.modules.Assistant"},{"name":"sap.ushell.modules.NavigationMenu","description":"The navigation menu API provides a way of placing content on the navigation menu.
","href":"api/sap.ushell.modules.NavigationMenu"},{"name":"sap.ushell.modules.Notifications","description":"The Notifications module API to set a NotficiationsProvider and Config.
","href":"api/sap.ushell.modules.Notifications"},{"name":"sap.ushell.modules.Search","description":"The Search module API to set a SearchProvider and Config.
","href":"api/sap.ushell.modules.Search"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.modules","subTitle":""},{"kind":"namespace","name":"sap.ushell.modules.Assistant","basename":"Assistant","resource":"sap/ushell/modules/Assistant.js","module":"sap/ushell/modules/Assistant","export":"","static":true,"visibility":"restricted","allowedFor":["Joule"],"since":"1.143.0","description":"
The Assistant module API to set an AssistantProvider and Config.
**Basic usage inside a shell plugin:**
If the provider lives in a dedicated file that is resolvable by `sap.ui.require` (e.g. it is part of the plugin's component preload), the inline `sap.ui.define` call is not needed — just pass the module path directly to `setAssistantProvider`.
```javascript // Option A: inline registration — useful when the provider is defined ad hoc sap.ui.define(\"my/app/AssistantProvider\", [], () => { function AssistantProvider(oAPI) { if (oAPI.getAssistantButton()) { // shell bar is active: button is pre-created oAPI.getAssistantButton().attachClick(() => { alert(\"Hello World!\"); }); } else { // based on ushell configuration the shell bar may not be used — // create a header item manually via FrameBoundExtension sap.ui.require([\"sap/ushell/Container\"], async (Container) => { const FrameBoundExtension = await Container.getServiceAsync(\"FrameBoundExtension\"); const oItem = await FrameBoundExtension.createHeaderItem({ id: \"shell.item.id\", ariaLabel: \"My Assistant\", ariaHaspopup: \"dialog\", icon: \"sap-icon://ai\", tooltip: \"Open Assistant\", press: () => { alert(\"Hello World!\"); } }, { position: \"end\" }); oItem.showOnHome(); oItem.showForAllApps(); }); } } return AssistantProvider; });
sap.ui.require([\"sap/ushell/modules/Assistant\"], (Assistant) => { Assistant.setAssistantProvider(\"my/app/AssistantProvider\", { icon: \"sap-icon://ai\" }); });
// Option B: file-based module — the provider is a regular JS file resolvable via // sap.ui.require (e.g. included in the plugin's component preload) without prior // sap.ui.define. my/app/AssistantProvider.js must export a constructor function. sap.ui.require([\"sap/ushell/modules/Assistant\"], (Assistant) => { Assistant.setAssistantProvider(\"my/app/AssistantProvider\", { icon: \"sap-icon://ai\" }); }); ```
","methods":[{"name":"setAssistantProvider","visibility":"restricted","allowedFor":["Joule"],"since":"1.143.0","returnValue":{"type":"Promise","description":"A promise that resolves when the configuration is set.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sModulePath","optional":false,"description":"
The AMD module path of the assistant provider constructor. Must be resolvable via `sap.ui.require` at the time the loader instantiates it.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oVisualConfiguration","optional":true,"description":"
Visual configuration for the assistant button (icon, id, helpId). Falls back to bootstrap defaults when omitted or partially specified.
","typeInfo":{"UI5Types":["sap.ushell.modules.Assistant.VisualConfiguration"]},"defaultValue":""},{"name":"oConfiguration","optional":true,"description":"
Serializable configuration passed to the provider constructor via sap.ushell.modules.Assistant.AssistantAPI#getConfigValue . Function-valued properties are not supported and will be silently ignored.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets the assistant provider for the assistant module.
The loader internally calls `new Module(oAssistantAPI)`, so the export must be a **constructor function** — not a plain object or an arrow function returning an object literal. The module can either be registered inline via `sap.ui.define` before this call, or it can be a file-based module resolvable by `sap.ui.require` (e.g. included in the plugin's component preload).
**Important:** `oConfiguration` is serialized with `JSON.stringify` before being stored. Function-valued properties are silently dropped during serialization. Do not pass callbacks in `oConfiguration`; use the `AssistantAPI` passed to the provider constructor to wire event handlers instead.
","href":"api/sap.ushell.modules.Assistant#methods/setAssistantProvider","code":"setAssistantProvider(sModulePath, oVisualConfiguration?, oConfiguration?) : Promise "}],"displayName":"sap.ushell.modules.Assistant","nodes":[{"name":"sap.ushell.modules.Assistant.AssistantAPI","description":"The API object for the Assistant module.
","href":"api/sap.ushell.modules.Assistant.AssistantAPI"},{"name":"sap.ushell.modules.Assistant.AssistantProvider","description":"","href":"api/sap.ushell.modules.Assistant.AssistantProvider"},{"name":"sap.ushell.modules.Assistant.VisualConfiguration","description":"","href":"api/sap.ushell.modules.Assistant.VisualConfiguration"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.modules.Assistant","subTitle":""},{"kind":"namespace","name":"sap.ushell.modules.Assistant.AssistantAPI","basename":"AssistantAPI","resource":"sap/ushell/modules/Assistant/AssistantAPI.js","module":"sap/ushell/modules/Assistant/AssistantAPI","export":"","static":true,"visibility":"restricted","allowedFor":["Joule"],"since":"1.143.0","description":"
The API object for the Assistant module. This module cannot be required it gets injected in the constructor of the Assistant module.
{@link sap.ushell.modules.Assistant.AssistantProvider} "],"methods":[{"name":"getAssistantButton","visibility":"restricted","allowedFor":["Joule"],"since":"1.143.0","returnValue":{"type":"sap.f.gen.webcomponents.dist.Button|undefined","description":"The assistant button, or `undefined` if the shell bar is not available.
","typeInfo":{"template":"${0} | undefined","UI5Types":["sap.f.gen.webcomponents.dist.Button"]}},"description":"Gets the assistant button pre-created by the shell bar.
Based on ushell configuration the shell bar may not be used, in which case this method returns `undefined`. Always check the return value before using it and implement the fallback via `FrameBoundExtension.createHeaderItem`.
**Important:** The returned object is a UI5 web component wrapper (`sap.f.gen.webcomponents.dist.Button`), **not** a `sap.ushell.ui.ShellHeadItem`. Use `attachClick` to register a click handler — `attachPress` does not exist on this type:
```javascript const oButton = oAPI.getAssistantButton(); if (oButton) { oButton.attachClick(myHandler); } ```
See the [Web Components Button API](https://ui5.github.io/webcomponents/nightly/components/main/Button/) for the full list of supported properties and events.
","href":"api/sap.ushell.modules.Assistant.AssistantAPI#methods/getAssistantButton","code":"getAssistantButton() : sap.f.gen.webcomponents.dist.Button|undefined "},{"name":"getAssistantDomRef","visibility":"restricted","allowedFor":["Joule"],"since":"1.143.0","returnValue":{"type":"Element","description":"The DOM reference.
","typeInfo":{"template":"Element"}},"description":"Gets the DOM reference for the assistant button.
","href":"api/sap.ushell.modules.Assistant.AssistantAPI#methods/getAssistantDomRef","code":"getAssistantDomRef() : Element "}],"displayName":"sap.ushell.modules.Assistant.AssistantAPI","component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.modules.Assistant.AssistantAPI","subTitle":""},{"kind":"class","name":"sap.ushell.modules.Assistant.AssistantProvider","basename":"AssistantProvider","resource":"sap/ushell/modules/Assistant/AssistantProvider.js","module":"sap/ushell/modules/Assistant/AssistantProvider","export":"","abstract":true,"static":true,"visibility":"restricted","allowedFor":["Joule"],"since":"1.143.0","constructor":{"visibility":"restricted","allowedFor":["Joule"],"parameters":[{"name":"oAssistantAPI","optional":false,"description":"
The injected API object. Provides access to the shell bar button and any serializable configuration passed to sap.ushell.modules.Assistant#setAssistantProvider .
","phoneName":"oAssistantAPI","depth":0,"types":[],"typeInfo":{"UI5Types":["sap.ushell.modules.Assistant.AssistantAPI"]},"defaultValue":""}],"description":"Required interface for the assistant provider module registered via sap.ushell.modules.Assistant#setAssistantProvider .
**The export must be a constructor function** callable with `new`. The loader internally executes `new Module(oAssistantAPI)`, so arrow functions returning object literals are not supported.
The constructor receives an sap.ushell.modules.Assistant.AssistantAPI instance and is responsible for wiring the assistant UI. The shell bar button is enabled automatically once the constructor returns — no additional promise is required on the provider.
","references":["sap.ushell.modules.Assistant#setAssistantProvider for a full usage example."],"codeExample":"new sap.ushell.modules.Assistant.AssistantProvider(oAssistantAPI) "},"methods":[{"name":"exit","visibility":"restricted","allowedFor":["Joule"],"since":"1.143.0","returnValue":{"type":"Promise","description":"Resolves once destroy is done.
","typeInfo":{"template":"Promise"}},"description":"Cleans up the component instance.
","href":"api/sap.ushell.modules.Assistant.AssistantProvider#methods/exit","code":"exit() : Promise "}],"displayName":"sap.ushell.modules.Assistant.AssistantProvider","component":"CA-FLP-FE-UI","hasSample":false,"title":"abstract class sap.ushell.modules.Assistant.AssistantProvider","subTitle":""},{"kind":"class","name":"sap.ushell.modules.Assistant.VisualConfiguration","basename":"VisualConfiguration","resource":"sap/ushell/modules/Assistant/VisualConfiguration.js","module":"sap/ushell/modules/Assistant/VisualConfiguration","export":"","abstract":true,"static":true,"visibility":"restricted","allowedFor":["Joule"],"since":"1.143.0","constructor":{"visibility":"restricted","allowedFor":["Joule"],"description":"Plain configuration object that controls the visual appearance of the assistant button in the shell bar. Pass an instance of this shape as the second argument to sap.ushell.modules.Assistant#setAssistantProvider .
Unspecified properties fall back to the values set in the bootstrap configuration under `/ushell/assistant/visualConfiguration`.
","examples":[{"data":"Example: // Minimal — only the icon is customized; all other properties use bootstrap defaults.\nAssistant.setAssistantProvider(\"my/app/AssistantProvider\", {\n icon: \"sap-icon://ai\"\n});
"},{"data":"Example: // Full configuration\nAssistant.setAssistantProvider(\"my/app/AssistantProvider\", {\n id: \"joule-assistant-button\",\n icon: \"sap-icon://ai\",\n helpId: \"joule-button\"\n});
"}],"references":[],"codeExample":"new sap.ushell.modules.Assistant.VisualConfiguration() "},"properties":[{"name":"helpId","visibility":"restricted","allowedFor":["Joule"],"since":"1.143.0","description":"Help id written to the button DOM as `data-help-id`. Used by the SAP Enable Now / WalkMe integration to anchor contextual help.
","typeInfo":{"template":"string"}},{"name":"icon","visibility":"restricted","allowedFor":["Joule"],"since":"1.143.0","description":"URI of the icon displayed on the assistant button. Use a value from the SAP icon font, e.g. `\"sap-icon://ai\"`.
","typeInfo":{"template":"string"}},{"name":"id","visibility":"restricted","allowedFor":["Joule"],"since":"1.143.0","description":"Optional stable DOM id for the assistant button. When omitted the shell bar generates an id automatically.
","typeInfo":{"template":"string"}}],"displayName":"sap.ushell.modules.Assistant.VisualConfiguration","component":"CA-FLP-FE-UI","hasSample":false,"title":"abstract class sap.ushell.modules.Assistant.VisualConfiguration","subTitle":""},{"kind":"namespace","name":"sap.ushell.modules.NavigationMenu","basename":"NavigationMenu","resource":"sap/ushell/modules/NavigationMenu.js","module":"sap/ushell/modules/NavigationMenu","export":"","static":true,"visibility":"restricted","allowedFor":["SAL"],"since":"1.136.0","description":"
The navigation menu API provides a way of placing content on the navigation menu. The ListProviders have to provide items as sap.tnt.NavigationList which is then embedded in the sap.tnt.SideNavigation . The items have to provide unique keys to have them properly selected on navigation. The selected key has to be determined by the extending ListProvider via sap.ushell.modules.NavigationMenu.ListProvider#findSelectedKey .
","methods":[{"name":"setFixedNavigationListProvider","visibility":"restricted","allowedFor":["SAL"],"since":"1.136.0","parameters":[{"name":"sModulePath","optional":false,"description":"
The module path of the navigation list provider. The module needs to fulfill the sap.ushell.modules.NavigationMenu.ListProvider interface.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oConfiguration","optional":false,"description":"
The configuration object for the navigation list provider.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets the navigation list provider for the fixed area of the navigation menu.
","href":"api/sap.ushell.modules.NavigationMenu#methods/setFixedNavigationListProvider","code":"setFixedNavigationListProvider(sModulePath, oConfiguration) : void "},{"name":"setNavigationListProvider","visibility":"restricted","allowedFor":["SAL"],"since":"1.136.0","parameters":[{"name":"sModulePath","optional":false,"description":"
The module path of the navigation list provider. The module needs to fulfill the sap.ushell.modules.NavigationMenu.ListProvider interface.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oConfiguration","optional":false,"description":"
The configuration object for the navigation list provider.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets the navigation list provider for the navigation menu.
","href":"api/sap.ushell.modules.NavigationMenu#methods/setNavigationListProvider","code":"setNavigationListProvider(sModulePath, oConfiguration) : void "}],"displayName":"sap.ushell.modules.NavigationMenu","nodes":[{"name":"sap.ushell.modules.NavigationMenu.ListProvider","description":"","href":"api/sap.ushell.modules.NavigationMenu.ListProvider"},{"name":"sap.ushell.modules.NavigationMenu.ListProviderAPI","description":"The API for an navigation menu list provider.
","href":"api/sap.ushell.modules.NavigationMenu.ListProviderAPI"},{"name":"sap.ushell.modules.NavigationMenu.NavContainer","description":"The API to interact with the navigation menu container.
","href":"api/sap.ushell.modules.NavigationMenu.NavContainer"},{"name":"sap.ushell.modules.NavigationMenu.NavigationMenuMode","description":"","href":"api/sap.ushell.modules.NavigationMenu.NavigationMenuMode"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.modules.NavigationMenu","subTitle":""},{"kind":"class","name":"sap.ushell.modules.NavigationMenu.ListProvider","basename":"ListProvider","resource":"sap/ushell/modules/NavigationMenu/ListProvider.js","module":"sap/ushell/modules/NavigationMenu/ListProvider","export":"","abstract":true,"static":true,"visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","constructor":{"visibility":"restricted","allowedFor":["SAL"],"parameters":[{"name":"oListProviderAPI","optional":false,"description":"
The API for the list provider
","phoneName":"oListProviderAPI","depth":0,"types":[],"typeInfo":{"UI5Types":["sap.ushell.modules.NavigationMenu.ListProviderAPI"]},"defaultValue":""}],"description":"The required interface for a navigation menu list provider.
","references":[],"codeExample":"new sap.ushell.modules.NavigationMenu.ListProvider(oListProviderAPI) "},"methods":[{"name":"exit","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","returnValue":{"type":"Promise","description":"Resolves once destroy is done.
","typeInfo":{"template":"Promise"}},"description":"Cleans up the component instance.
","href":"api/sap.ushell.modules.NavigationMenu.ListProvider#methods/exit","code":"exit() : Promise "},{"name":"findSelectedKey","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","returnValue":{"type":"Promise","description":"A promise that resolves to the selected key from the spaces.
","typeInfo":{"template":"Promise"}},"href":"api/sap.ushell.modules.NavigationMenu.ListProvider#methods/findSelectedKey","code":"findSelectedKey() : Promise "},{"name":"getRootItem","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","returnValue":{"type":"Promise","description":"A promise that resolves to the root item of the navigation list.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.tnt.NavigationList"]}},"href":"api/sap.ushell.modules.NavigationMenu.ListProvider#methods/getRootItem","code":"getRootItem() : Promise "}],"displayName":"sap.ushell.modules.NavigationMenu.ListProvider","component":"CA-FLP-FE-UI","hasSample":false,"title":"abstract class sap.ushell.modules.NavigationMenu.ListProvider","subTitle":""},{"kind":"namespace","name":"sap.ushell.modules.NavigationMenu.ListProviderAPI","basename":"ListProviderAPI","resource":"sap/ushell/modules/NavigationMenu/ListProviderAPI.js","module":"sap/ushell/modules/NavigationMenu/ListProviderAPI","export":"","static":true,"visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","description":"
The API for an navigation menu list provider. This module cannot be required it gets injected in the constructor of the ListProvider.
","methods":[{"name":"closeSideNavigation","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","description":"Closes the side navigation.
","href":"api/sap.ushell.modules.NavigationMenu.ListProviderAPI#methods/closeSideNavigation","code":"closeSideNavigation() : void "},{"name":"collapseSideNavigation","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","description":"Collapses the side navigation.
","href":"api/sap.ushell.modules.NavigationMenu.ListProviderAPI#methods/collapseSideNavigation","code":"collapseSideNavigation() : void "},{"name":"expandSideNavigation","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","description":"Expands the side navigation.
","href":"api/sap.ushell.modules.NavigationMenu.ListProviderAPI#methods/expandSideNavigation","code":"expandSideNavigation() : void "},{"name":"getConfigValue","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","returnValue":{"type":"any","description":"The configuration value for the provided path.
","typeInfo":{"template":"any"}},"parameters":[{"name":"sPath","optional":false,"description":"
The configuration path to get the value for.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns the configuration value for the provided path. The configuration path has to be provided in dot notation. The contents of the configuration have to be set with the setter methods in sap.ushell.modules.NavigationMenu .
","href":"api/sap.ushell.modules.NavigationMenu.ListProviderAPI#methods/getConfigValue","code":"getConfigValue(sPath) : any "},{"name":"getNavContainerFacade","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","returnValue":{"type":"sap.ushell.modules.NavigationMenu.NavContainer","description":"The navigation container facade.
","typeInfo":{"UI5Types":["sap.ushell.modules.NavigationMenu.NavContainer"]}},"description":"Returns the navigation container facade. With this a list provider can make updates in the surrounding NavContainer.
","href":"api/sap.ushell.modules.NavigationMenu.ListProviderAPI#methods/getNavContainerFacade","code":"getNavContainerFacade() : sap.ushell.modules.NavigationMenu.NavContainer "},{"name":"openSideNavigation","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","description":"Opens the side navigation.
","href":"api/sap.ushell.modules.NavigationMenu.ListProviderAPI#methods/openSideNavigation","code":"openSideNavigation() : void "},{"name":"updateSelectedKey","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","returnValue":{"type":"Promise","description":"Resolves once selected key was updated
","typeInfo":{"template":"Promise"}},"description":"Updates the selected key in the navigation container based on sap.ushell.modules.NavigationMenu.ListProvider#findSelectedKey .
","href":"api/sap.ushell.modules.NavigationMenu.ListProviderAPI#methods/updateSelectedKey","code":"updateSelectedKey() : Promise "}],"displayName":"sap.ushell.modules.NavigationMenu.ListProviderAPI","component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.modules.NavigationMenu.ListProviderAPI","subTitle":""},{"kind":"namespace","name":"sap.ushell.modules.NavigationMenu.NavContainer","basename":"NavContainer","resource":"sap/ushell/modules/NavigationMenu/NavContainer.js","module":"sap/ushell/modules/NavigationMenu/NavContainer","export":"","static":true,"visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","description":"
The API to interact with the navigation menu container. This module cannot be required. It has to be fetched via the respective APIs e.g. sap.ushell.modules.NavigationMenu.ListProviderAPI#getNavContainerFacade .
","methods":[{"name":"add","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","parameters":[{"name":"oControl","optional":false,"description":"
The control to add.
","typeInfo":{"UI5Types":["sap.ui.core.Control"]},"defaultValue":""}],"description":"Adds a control to the navigation container.
","href":"api/sap.ushell.modules.NavigationMenu.NavContainer#methods/add","code":"add(oControl) : void "},{"name":"to","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","parameters":[{"name":"vControl","optional":false,"description":"
The control to navigate to.
","typeInfo":{"template":"string | ${0}","UI5Types":["sap.ui.core.Control"]},"defaultValue":""}],"description":"Navigates to the specified control.
","href":"api/sap.ushell.modules.NavigationMenu.NavContainer#methods/to","code":"to(vControl) : void "},{"name":"toRoot","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","description":"Navigates to the root control.
","href":"api/sap.ushell.modules.NavigationMenu.NavContainer#methods/toRoot","code":"toRoot() : void "}],"displayName":"sap.ushell.modules.NavigationMenu.NavContainer","component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.modules.NavigationMenu.NavContainer","subTitle":""},{"kind":"enum","name":"sap.ushell.modules.NavigationMenu.NavigationMenuMode","basename":"NavigationMenuMode","resource":"sap/ushell/modules/NavigationMenu/NavigationMenuMode.js","module":"sap/ushell/modules/NavigationMenu/NavigationMenuMode","export":"","static":true,"visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","ui5-metadata":{"stereotype":"enum"},"properties":[{"name":"sap.ushell.modules.NavigationMenu.NavigationMenuMode.Docked","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","description":"Renders the NavigationMenu primarily as docked area.
"},{"name":"sap.ushell.modules.NavigationMenu.NavigationMenuMode.Popover","visibility":"restricted","allowedFor":["SAL"],"since":"1.141.0","description":"Renders the NavigationMenu primarily as popover.
"}],"displayName":"sap.ushell.modules.NavigationMenu.NavigationMenuMode","component":"CA-FLP-FE-UI","hasSample":false,"title":"enum sap.ushell.modules.NavigationMenu.NavigationMenuMode","subTitle":""},{"kind":"namespace","name":"sap.ushell.modules.Notifications","basename":"Notifications","resource":"sap/ushell/modules/Notifications.js","module":"sap/ushell/modules/Notifications","export":"","static":true,"visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","description":"
The Notifications module API to set a NotficiationsProvider and Config.
","methods":[{"name":"setNotificationsProvider","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","returnValue":{"type":"Promise","description":"A promise that resolves when the configuration is set.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sModulePath","optional":false,"description":"
The module path of the notifications provider.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oConfiguration","optional":false,"description":"
The configuration object for the notifications provider.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets the notifications provider for the notifications module.
","href":"api/sap.ushell.modules.Notifications#methods/setNotificationsProvider","code":"setNotificationsProvider(sModulePath, oConfiguration) : Promise "}],"displayName":"sap.ushell.modules.Notifications","nodes":[{"name":"sap.ushell.modules.Notifications.NotificationsAPI","description":"The API object for the Notifications module.
","href":"api/sap.ushell.modules.Notifications.NotificationsAPI"},{"name":"sap.ushell.modules.Notifications.NotificationsProvider","description":"","href":"api/sap.ushell.modules.Notifications.NotificationsProvider"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.modules.Notifications","subTitle":""},{"kind":"namespace","name":"sap.ushell.modules.Notifications.NotificationsAPI","basename":"NotificationsAPI","resource":"sap/ushell/modules/Notifications/NotificationsAPI.js","module":"sap/ushell/modules/Notifications/NotificationsAPI","export":"","static":true,"visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","description":"
The API object for the Notifications module. This module cannot be required it gets injected in the constructor of the Notifications module.
{@link sap.ushell.modules.Notifications.NotificationsProvider} "],"methods":[{"name":"attachNotificationsPress","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","parameters":[{"name":"oData","optional":true,"description":"
An object that will be passed to the handler along with the event object when the event is fired
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"fnFunction","optional":false,"description":"
The handler function to call when the event occurs. This function will be called in the context of the oListener instance (if present) or on the event provider instance. The event object (@see: sap.ui.base.Event) is provided as first argument of the handler. Handlers must not change the content of the event. The second argument is the specified oData instance (if present).
","typeInfo":{"template":"function"},"defaultValue":""},{"name":"oListener","optional":true,"description":"
The object that wants to be notified when the event occurs (this context within the handler function).
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Attaches a handler to the notifications press event.
","href":"api/sap.ushell.modules.Notifications.NotificationsAPI#methods/attachNotificationsPress","code":"attachNotificationsPress(oData?, fnFunction, oListener?) : void "},{"name":"bindNotificationsCount","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","parameters":[{"name":"sPath","optional":false,"description":"
Absolute path to the property in the model.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oModel","optional":false,"description":"
The model to bind to.
","typeInfo":{"UI5Types":["sap.ui.model.Model"]},"defaultValue":""}],"description":"Binds the notifications count property to a model. The model value must be compatible with the value of @see #setNotificationsCount.
","href":"api/sap.ushell.modules.Notifications.NotificationsAPI#methods/bindNotificationsCount","code":"bindNotificationsCount(sPath, oModel) : void "},{"name":"bindShowNotifications","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","parameters":[{"name":"sPath","optional":false,"description":"
Absolute path to the property in the model.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oModel","optional":false,"description":"
The model to bind to.
","typeInfo":{"UI5Types":["sap.ui.model.Model"]},"defaultValue":""}],"description":"Binds the the notifaction visibility to a model. The model value must be compatible with the value of @see #setShowNotifications.
","href":"api/sap.ushell.modules.Notifications.NotificationsAPI#methods/bindShowNotifications","code":"bindShowNotifications(sPath, oModel) : void "},{"name":"detachNotificationsPress","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","parameters":[{"name":"fnFunction","optional":false,"description":"
The handler function to detach from the event.
","typeInfo":{"template":"function"},"defaultValue":""},{"name":"oListener","optional":true,"description":"
The object that wanted to be notified when the event occurred.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Detaches a handler from the notifications press event.
","href":"api/sap.ushell.modules.Notifications.NotificationsAPI#methods/detachNotificationsPress","code":"detachNotificationsPress(fnFunction, oListener?) : void "},{"name":"getNotificationsCount","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","returnValue":{"type":"int","description":"The current notifications count.
","typeInfo":{"template":"int"}},"description":"Gets the notifications count.
","href":"api/sap.ushell.modules.Notifications.NotificationsAPI#methods/getNotificationsCount","code":"getNotificationsCount() : int "},{"name":"getNotificationsDomRef","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","returnValue":{"type":"Element","description":"The DOM reference.
","typeInfo":{"template":"Element"}},"description":"Gets the DOM reference for the notifications area.
","href":"api/sap.ushell.modules.Notifications.NotificationsAPI#methods/getNotificationsDomRef","code":"getNotificationsDomRef() : Element "},{"name":"getShowNotifications","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","returnValue":{"type":"boolean","description":"Whether notifications are shown.
","typeInfo":{"template":"boolean"}},"description":"Returns whether notifications are currently shown. The returned value can differ from last set value due FLP state management.
","href":"api/sap.ushell.modules.Notifications.NotificationsAPI#methods/getShowNotifications","code":"getShowNotifications() : boolean "},{"name":"setNotificationsCount","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","parameters":[{"name":"iCount","optional":false,"description":"
The notifications count to set.
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Sets the notifications count.
","href":"api/sap.ushell.modules.Notifications.NotificationsAPI#methods/setNotificationsCount","code":"setNotificationsCount(iCount) : void "},{"name":"setShowNotifications","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","parameters":[{"name":"bShow","optional":false,"description":"
Whether to show notifications.
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Sets whether notifications should be currently shown. The actual value can differ from the set value due FLP state management.
","href":"api/sap.ushell.modules.Notifications.NotificationsAPI#methods/setShowNotifications","code":"setShowNotifications(bShow) : void "},{"name":"unbindNotificationsCount","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","description":"Unbinds the notifications count property from a model.
","href":"api/sap.ushell.modules.Notifications.NotificationsAPI#methods/unbindNotificationsCount","code":"unbindNotificationsCount() : void "},{"name":"unbindShowNotifications","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","description":"Unbinds the notifaction visibility.
","href":"api/sap.ushell.modules.Notifications.NotificationsAPI#methods/unbindShowNotifications","code":"unbindShowNotifications() : void "}],"displayName":"sap.ushell.modules.Notifications.NotificationsAPI","component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.modules.Notifications.NotificationsAPI","subTitle":""},{"kind":"class","name":"sap.ushell.modules.Notifications.NotificationsProvider","basename":"NotificationsProvider","resource":"sap/ushell/modules/Notifications/NotificationsProvider.js","module":"sap/ushell/modules/Notifications/NotificationsProvider","export":"","abstract":true,"static":true,"visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","constructor":{"visibility":"restricted","allowedFor":["ANS"],"parameters":[{"name":"oNotificationsAPI","optional":false,"description":"
The notifications API object.
","phoneName":"oNotificationsAPI","depth":0,"types":[],"typeInfo":{"UI5Types":["sap.ushell.modules.Notifications.NotificationsAPI"]},"defaultValue":""}],"description":"The required interface for a Notifications module.
","references":[],"codeExample":"new sap.ushell.modules.Notifications.NotificationsProvider(oNotificationsAPI) "},"methods":[{"name":"exit","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","returnValue":{"type":"Promise","description":"Resolves once destroy is done.
","typeInfo":{"template":"Promise"}},"description":"Cleans up the component instance.
","href":"api/sap.ushell.modules.Notifications.NotificationsProvider#methods/exit","code":"exit() : Promise "}],"displayName":"sap.ushell.modules.Notifications.NotificationsProvider","component":"CA-FLP-FE-UI","hasSample":false,"title":"abstract class sap.ushell.modules.Notifications.NotificationsProvider","subTitle":""},{"kind":"namespace","name":"sap.ushell.modules.Search","basename":"Search","resource":"sap/ushell/modules/Search.js","module":"sap/ushell/modules/Search","export":"","static":true,"visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","description":"
The Search module API to set a SearchProvider and Config.
","methods":[{"name":"setSearchProvider","visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","returnValue":{"type":"Promise","description":"A promise that resolves when the configuration is set.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sModulePath","optional":false,"description":"
The module path of the search provider.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sSearchResultAppIntent","optional":false,"description":"
The intent to be used for the search result app incl. #.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oConfiguration","optional":false,"description":"
The configuration object for the search provider.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets the search provider for the search module.
","href":"api/sap.ushell.modules.Search#methods/setSearchProvider","code":"setSearchProvider(sModulePath, sSearchResultAppIntent, oConfiguration) : Promise "}],"displayName":"sap.ushell.modules.Search","nodes":[{"name":"sap.ushell.modules.Search.SearchAPI","description":"","href":"api/sap.ushell.modules.Search.SearchAPI"},{"name":"sap.ushell.modules.Search.SearchProvider","description":"","href":"api/sap.ushell.modules.Search.SearchProvider"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.modules.Search","subTitle":""},{"kind":"class","name":"sap.ushell.modules.Search.SearchAPI","basename":"SearchAPI","resource":"sap/ushell/modules/Search/SearchAPI.js","module":"sap/ushell/modules/Search/SearchAPI","export":"","static":true,"visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","hideconstructor":true,"methods":[{"name":"attachSearchButtonPress","visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","parameters":[{"name":"oData","optional":true,"description":"
An object that will be passed to the handler along with the event object when the event is fired
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"fnFunction","optional":false,"description":"
The handler function to call when the event occurs. This function will be called in the context of the oListener instance (if present) or on the event provider instance. The event object (@see: sap.ui.base.Event) is provided as first argument of the handler. Handlers must not change the content of the event. The second argument is the specified oData instance (if present).
","typeInfo":{"template":"function"},"defaultValue":""},{"name":"oListener","optional":true,"description":"
The object that wants to be notified when the event occurs (this context within the handler function).
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Attaches a handler to the search button press event. Fired, when the search button is activated. Note: You can prevent expanding/collapsing of the search field by calling event.preventDefault().
","href":"api/sap.ushell.modules.Search.SearchAPI#methods/attachSearchButtonPress","code":"attachSearchButtonPress(oData?, fnFunction, oListener?) : void "},{"name":"attachSearchFieldClear","visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","parameters":[{"name":"oData","optional":true,"description":"
An object that will be passed to the handler along with the event object when the event is fired
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"fnFunction","optional":false,"description":"
The handler function to call when the event occurs. This function will be called in the context of the oListener instance (if present) or on the event provider instance. The event object (@see: sap.ui.base.Event) is provided as first argument of the handler. Handlers must not change the content of the event. The second argument is the specified oData instance (if present).
","typeInfo":{"template":"function"},"defaultValue":""},{"name":"oListener","optional":true,"description":"
The object that wants to be notified when the event occurs (this context within the handler function).
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Attaches a handler to the search field clear event. Fired, when the search cancel button is activated. Note: You can prevent the default behavior (clearing the search field value) by calling event.preventDefault(). The search will still be closed. Note: this event is only available when using the ShellBar.
","href":"api/sap.ushell.modules.Search.SearchAPI#methods/attachSearchFieldClear","code":"attachSearchFieldClear(oData?, fnFunction, oListener?) : void "},{"name":"attachSearchFieldToggle","visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","parameters":[{"name":"oData","optional":true,"description":"
An object that will be passed to the handler along with the event object when the event is fired
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"fnFunction","optional":false,"description":"
The handler function to call when the event occurs. This function will be called in the context of the oListener instance (if present) or on the event provider instance. The event object (@see: sap.ui.base.Event) is provided as first argument of the handler. Handlers must not change the content of the event. The second argument is the specified oData instance (if present).
","typeInfo":{"template":"function"},"defaultValue":""},{"name":"oListener","optional":true,"description":"
The object that wants to be notified when the event occurs (this context within the handler function).
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Detaches a handler from the search button toggle event. Fired, when the search field is expanded or collapsed. Note: this event is only available when using the ShellBar.
","href":"api/sap.ushell.modules.Search.SearchAPI#methods/attachSearchFieldToggle","code":"attachSearchFieldToggle(oData?, fnFunction, oListener?) : void "},{"name":"bindShowSearchField","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","parameters":[{"name":"sPath","optional":false,"description":"
Absolute path to the property in the model.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oModel","optional":false,"description":"
The model to bind to.
","typeInfo":{"UI5Types":["sap.ui.model.Model"]},"defaultValue":""}],"description":"Binds the ShowSearchField property to a model. The model value must be compatible with the value of @see #setShowSearchField.
","href":"api/sap.ushell.modules.Search.SearchAPI#methods/bindShowSearchField","code":"bindShowSearchField(sPath, oModel) : void "},{"name":"detachSearchButtonPress","visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","parameters":[{"name":"fnFunction","optional":false,"description":"
The handler function to detach from the event.
","typeInfo":{"template":"function"},"defaultValue":""},{"name":"oListener","optional":true,"description":"
The object that wanted to be notified when the event occurred.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Detaches a handler from the search button press event.
","href":"api/sap.ushell.modules.Search.SearchAPI#methods/detachSearchButtonPress","code":"detachSearchButtonPress(fnFunction, oListener?) : void "},{"name":"detachSearchFieldClear","visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","parameters":[{"name":"fnFunction","optional":false,"description":"
The handler function to detach from the event.
","typeInfo":{"template":"function"},"defaultValue":""},{"name":"oListener","optional":true,"description":"
The object that wanted to be notified when the event occurred.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Detaches a handler from the search field clear event.
","href":"api/sap.ushell.modules.Search.SearchAPI#methods/detachSearchFieldClear","code":"detachSearchFieldClear(fnFunction, oListener?) : void "},{"name":"detachSearchFieldToggle","visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","parameters":[{"name":"fnFunction","optional":false,"description":"
The handler function to detach from the event.
","typeInfo":{"template":"function"},"defaultValue":""},{"name":"oListener","optional":true,"description":"
The object that wanted to be notified when the event occurred.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Detaches a handler from the search field toggle event.
","href":"api/sap.ushell.modules.Search.SearchAPI#methods/detachSearchFieldToggle","code":"detachSearchFieldToggle(fnFunction, oListener?) : void "},{"name":"getSearchField","visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","returnValue":{"type":"Promise|undefined","description":"A promise that resolves to the search field instance or undefined if not available.
","typeInfo":{"template":"Promise | undefined"}},"description":"Gets the search field instance. The search field is not visible by default. The search module has to set it to visible by calling setVisible(true). This allows to get the search field prepared before showing it. In case the ShellHeader is used this method returns undefined as the search field is not available.
","href":"api/sap.ushell.modules.Search.SearchAPI#methods/getSearchField","code":"getSearchField() : Promise|undefined "},{"name":"getShowSearchField","visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","returnValue":{"type":"boolean|undefined","description":"True if the search field is shown, false if it is hidden, or undefined if not available.
","typeInfo":{"template":"boolean | undefined"}},"description":"Gets whether the search field is shown or hidden.
","href":"api/sap.ushell.modules.Search.SearchAPI#methods/getShowSearchField","code":"getShowSearchField() : boolean|undefined "},{"name":"setShowSearchField","visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","parameters":[{"name":"bShow","optional":false,"description":"
Whether to show or hide the search field.
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Shows or hides the search field. Note: Hiding the search field will also collapse it if it is expanded.
","href":"api/sap.ushell.modules.Search.SearchAPI#methods/setShowSearchField","code":"setShowSearchField(bShow) : void "},{"name":"unbindShowSearchField","visibility":"restricted","allowedFor":["ANS"],"since":"1.142.0","description":"Unbinds the ShowSearchField property from a model.
","href":"api/sap.ushell.modules.Search.SearchAPI#methods/unbindShowSearchField","code":"unbindShowSearchField() : void "}],"displayName":"sap.ushell.modules.Search.SearchAPI","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.modules.Search.SearchAPI","subTitle":""},{"kind":"class","name":"sap.ushell.modules.Search.SearchProvider","basename":"SearchProvider","resource":"sap/ushell/modules/Search/SearchProvider.js","module":"sap/ushell/modules/Search/SearchProvider","export":"","abstract":true,"static":true,"visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","constructor":{"visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"parameters":[{"name":"oSearchAPI","optional":false,"description":"
The search API object.
","phoneName":"oSearchAPI","depth":0,"types":[],"typeInfo":{"UI5Types":["sap.ushell.modules.Search.SearchAPI"]},"defaultValue":""}],"description":"The required interface for a Search module.
","references":[],"codeExample":"new sap.ushell.modules.Search.SearchProvider(oSearchAPI) "},"methods":[{"name":"exit","visibility":"restricted","allowedFor":["HAN-AS-INA-UI"],"since":"1.142.0","returnValue":{"type":"Promise","description":"Resolves once destroy is done.
","typeInfo":{"template":"Promise"}},"description":"Cleans up the component instance.
","href":"api/sap.ushell.modules.Search.SearchProvider#methods/exit","code":"exit() : Promise "}],"displayName":"sap.ushell.modules.Search.SearchProvider","component":"CA-FLP-FE-UI","hasSample":false,"title":"abstract class sap.ushell.modules.Search.SearchProvider","subTitle":""},{"kind":"namespace","name":"sap.ushell.navigation.DirtyState","basename":"DirtyState","resource":"sap/ushell/navigation/DirtyState.js","module":"sap/ushell/navigation/DirtyState","export":"","static":true,"visibility":"public","since":"1.146.0","description":"
Module that stores the dirty state of the application.
","methods":[{"name":"deregisterDirtyStateProvider","visibility":"public","since":"1.146.0","parameters":[{"name":"fnDirty","optional":false,"description":"
function for determining the state of the application
","typeInfo":{"template":"function() : boolean"},"defaultValue":""}],"throws":[{"type":"TypeError","description":"If fnDirty is not a function.
","linkEnabled":false}],"description":"Deregister the work protection dirty callback function. See registerDirtyStateProvider for more information. Only the last registered function will be deregistered (in case it was registered multiple times).
","href":"api/sap.ushell.navigation.DirtyState#methods/deregisterDirtyStateProvider","code":"deregisterDirtyStateProvider(fnDirty) : void "},{"name":"getDirtyFlag","visibility":"public","since":"1.146.0","returnValue":{"type":"Promise","description":"The value of the dirty flag or the determined dirty state returned by the dirty state providers.
","typeInfo":{"template":"Promise"}},"description":"If the dirty state was set to 'false' using 'setDirtyFlag' the registered dirty state provider methods get called to determine the actual dirty state. The determined dirty state is then returned.
However, if the dirty state was previously set to 'true' using 'setDirtyFlag' the registered dirty state provider methods are ignored and the function simply returns 'true'.
","href":"api/sap.ushell.navigation.DirtyState#methods/getDirtyFlag","code":"getDirtyFlag() : Promise "},{"name":"registerDirtyStateProvider","visibility":"public","since":"1.146.0","parameters":[{"name":"fnDirty","optional":false,"description":"
Function for determining the state of the application. The callback is used to determine the current dirty state during a navigation. The function must return a boolean which determines if the current application is dirty or not. If true is returned the end user is prompted with a dialog where they need to confirm the potential data loss. The callback is called with a navigation context as its first parameter which can be used to determine the dirty state:
\n {\n isCrossAppNavigation: true, // Boolean which indicates if the navigation is inner app or across two different applications.\n innerAppRoute: \"&/SalesOrder/11\" // If it is an inner app navigation, it describes the inner app route.\n }\n ","typeInfo":{"template":"function() : boolean"},"defaultValue":""}],"throws":[{"type":"TypeError","description":"If fnDirty is not a function.
","linkEnabled":false}],"description":"Register the work protection dirty callback function. In the work protect mechanism, each platform can register their own method in order to check if data was changed during the session, and notify the container about the change. Registering multiple times the same function is allowed.
Use Function.prototype.bind() to determine the callback's this or some of its arguments.
Note that registered callback functions are not automatically de-registered when an application is closed. Use sap.ushell.navigation.DirtyState.deregisterDirtyStateProvider to de-register the callback function.
","href":"api/sap.ushell.navigation.DirtyState#methods/registerDirtyStateProvider","code":"registerDirtyStateProvider(fnDirty) : void "},{"name":"setDirtyFlag","visibility":"public","since":"1.146.0","returnValue":{"type":"Promise","description":"Resolves when the dirty flag is set.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"bIsDirty","optional":true,"defaultValue":false,"description":"
The value of the dirty flag.
","typeInfo":{"template":"boolean"}}],"throws":[{"type":"TypeError","description":"If bIsDirty is not a boolean or null/undefined.
","linkEnabled":false}],"description":"Setter for the isDirty flag value.
","href":"api/sap.ushell.navigation.DirtyState#methods/setDirtyFlag","code":"setDirtyFlag(bIsDirty?) : Promise "}],"displayName":"sap.ushell.navigation.DirtyState","component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.navigation.DirtyState","subTitle":""},{"kind":"enum","name":"sap.ushell.NavigationState","basename":"NavigationState","resource":"sap/ushell/library.js","module":"sap/ushell/library","export":"NavigationState","static":true,"visibility":"public","description":"
The state of a navigation operation
This enum is part of the 'sap/ushell/library' module export and must be accessed by the property 'NavigationState'.
","ui5-metadata":{"stereotype":"enum"},"properties":[{"name":"sap.ushell.NavigationState.Finished","visibility":"public","description":""},{"name":"sap.ushell.NavigationState.InProgress","visibility":"public","description":""}],"displayName":"sap.ushell.NavigationState","component":"CA-FLP-FE-UI","hasSample":false,"title":"enum sap.ushell.NavigationState","subTitle":"Deprecated in version: 1.136","deprecatedText":"Deprecated as of version 1.136. Deprecated without successor."},{"kind":"namespace","name":"sap.ushell.renderer.ShellLayout","basename":"ShellLayout","resource":"sap/ushell/renderer/ShellLayout.js","module":"sap/ushell/renderer/ShellLayout","export":"","static":true,"visibility":"restricted","allowedFor":["DWS"],"since":"1.137.0","description":"
The ShellLayout is responsible for creating the shell layout.
","methods":[{"name":"attachAdjacentSideContentBeforeMainChanged","visibility":"restricted","allowedFor":["DWS"],"since":"1.137.0","description":"Registers a handler for the \"adjacentSideContentBeforeMainChanged\" event.
","href":"api/sap.ushell.renderer.ShellLayout#methods/attachAdjacentSideContentBeforeMainChanged","code":"attachAdjacentSideContentBeforeMainChanged() : void "},{"name":"detachAdjacentSideContentBeforeMainChanged","visibility":"restricted","allowedFor":["DWS"],"since":"1.137.0","description":"Registers a handler for the \"adjacentSideContentBeforeMainChanged\" event.
","href":"api/sap.ushell.renderer.ShellLayout#methods/detachAdjacentSideContentBeforeMainChanged","code":"detachAdjacentSideContentBeforeMainChanged() : void "},{"name":"hasAdjacentSideContentBeforeMain","visibility":"restricted","allowedFor":["DWS"],"since":"1.137.0","returnValue":{"type":"boolean","description":"whether the main content has adjacent content before it
","typeInfo":{"template":"boolean"}},"href":"api/sap.ushell.renderer.ShellLayout#methods/hasAdjacentSideContentBeforeMain","code":"hasAdjacentSideContentBeforeMain() : boolean "}],"displayName":"sap.ushell.renderer.ShellLayout","component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.renderer.ShellLayout","subTitle":""},{"kind":"class","name":"sap.ushell.renderers.fiori2.Renderer","basename":"Renderer","resource":"sap/ushell/renderers/fiori2/Renderer.js","module":"sap/ushell/renderers/fiori2/Renderer","export":"","static":true,"visibility":"public","since":"1.15.0","extends":"sap.ui.core.UIComponent","description":"The SAPUI5 component of SAP Fiori Launchpad renderer for the Unified Shell. This method MUST be called by the Unified Shell's container only, others MUST call sap.ushell.Container#getRenderer .
","ui5-metadata":{"stereotype":"component"},"hideconstructor":true,"properties":[{"name":"LaunchpadState","visibility":"public","since":"1.30","description":"The launchpad states that can be passed as a parameter.
Values: App - launchpad state when running a Fiori app Home - launchpad state when the home page is open
","deprecated":{"since":"1.120","text":"The LaunchpadState concept has been migrated to explicit APIs. Please use {@link sap.ushell.services.Extension.Item} or {@link sap.ushell.services.FrameBoundExtension.Item} APIs instead."},"deprecatedText":"Deprecated as of version 1.120. The LaunchpadState concept has been migrated to explicit APIs. Please use sap.ushell.services.Extension.Item or sap.ushell.services.FrameBoundExtension.Item APIs instead.","typeInfo":{"template":"undefined"}}],"methods":[{"name":"addActionButton","visibility":"public","since":"1.30","returnValue":{"type":"sap.ui.core.Control","description":"oItem - the created control
","typeInfo":{"UI5Types":["sap.ui.core.Control"]}},"parameters":[{"name":"controlType","optional":false,"description":"
The (class) name of the control type to create.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oControlProperties","optional":false,"description":"
The properties that will be passed to the created control.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bIsVisible","optional":false,"description":"
Specify whether to display the control. If true, the control is displayed (calls the showActionButton method) according to the bCurrentState and aStates parameters. If false, the control is created but not displayed (you can use showActionButton to display the control when needed).
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true, add the current control only to the current rendered shell state. Once the user navigates to another app or back to the home page, this control will be removed.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
List of the launchpad states (sap.ushell.renderers.fiori2.Renderer.LaunchpadState) in which to add the control. Valid only if bCurrentState is set to false.
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Creates an action button in the User Actions Menu in the SAP Fiori launchpad, in the given launchpad states (LaunchpadState).
Example:
\nsap.ushell.Container.getRenderer(\"fiori2\").addActionButton(\"sap.m.Button\", {id: \"testBtn2\", text: \"test button\"}, true, true);\n This function is marked for deprecation as of version 1.48.
","deprecated":{"since":"1.48","text":"Please use {@link #addUserAction} instead."},"references":["{@link sap.ushell.renderers.fiori2.Renderer.LaunchpadState\n If no launchpad state is provided, the content is added in all states.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/addActionButton","deprecatedText":"Deprecated as of version 1.48. Please use #addUserAction instead.","code":"addActionButton(controlType, oControlProperties, bIsVisible, bCurrentState, aStates) : sap.ui.core.Control "},{"name":"addEndUserFeedbackCustomUI","visibility":"public","since":"1.30","parameters":[{"name":"oCustomUIContent","optional":false,"description":"
The control to be added to the EndUserFeedback dialog.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bShowCustomUIContent","optional":false,"description":"
Specify whether to display the control.
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Adds the given sap.ui.core.Control to the EndUserFeedback dialog. The EndUserFeedback dialog is opened via the user actions menu in the Fiori Launchpad shell header.
","deprecated":{"since":"1.93","text":"Deprecated without successor. EndUserFeedback has been discontinued."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/addEndUserFeedbackCustomUI","deprecatedText":"Deprecated as of version 1.93. Deprecated without successor. EndUserFeedback has been discontinued.","code":"addEndUserFeedbackCustomUI(oCustomUIContent, bShowCustomUIContent) : void "},{"name":"addFloatingActionButton","visibility":"public","since":"1.30","returnValue":{"type":"object","description":"oItem - the created control
","typeInfo":{"template":"object"}},"parameters":[{"name":"controlType","optional":false,"description":"
The (class) name of the control type to create.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oControlProperties","optional":false,"description":"
The properties that will be passed to the created control.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bIsVisible","optional":false,"description":"
Specify whether to display the control.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true, add the current control only to the current rendered shell state. Once the user navigates to another app or back to the Home page, this control will be removed.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
(only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to add the control.
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Creates a FloatingActionButton in Fiori launchpad, in the given launchpad states. The FloatingActionButton is rendered in the bottom right corner of the shell.
Example:
\nsap.ushell.Container.getRenderer(\"fiori2\").addFloatingActionButton(\"sap.ushell.ui.shell.ShellFloatingAction\", {id: \"testBtn\"}, true, true);\n This function is marked for deprecation as of version 1.48.
","deprecated":{"since":"1.48","text":"Please use {@link #addFloatingButton} instead."},"references":["{@link LaunchpadState\n If no launchpad state is provided the content is added in all states.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/addFloatingActionButton","deprecatedText":"Deprecated as of version 1.48. Please use #addFloatingButton instead.","code":"addFloatingActionButton(controlType, oControlProperties, bIsVisible, bCurrentState, aStates) : object "},{"name":"addFloatingButton","visibility":"public","since":"1.48","returnValue":{"type":"jQuery.Promise","description":"Resolves with the newly created control
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oParameters","optional":false,"description":"
Contains the required parameters for creating and showing the new control object:
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Creates a FloatingActionButton in Fiori launchpad, in the given launchpad states. The FloatingActionButton is rendered in the bottom right corner of the shell.
Example:
\nsap.ushell.Container.getRenderer(\"fiori2\").addFloatingActionButton(\"sap.ushell.ui.shell.ShellFloatingAction\", {id: \"testBtn\"}, true, true);\n {@link LaunchpadState\n If no launchpad state is provided the content is added in all states.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/addFloatingButton","deprecatedText":"Deprecated as of version 1.52. Deprecated without successor. Support for the FloatingActionButton has been discontinued.","code":"addFloatingButton(oParameters) : jQuery.Promise "},{"name":"addHeaderEndItem","visibility":"public","since":"1.30","returnValue":{"type":"sap.ui.core.Control","description":"oItem - the created control
","typeInfo":{"UI5Types":["sap.ui.core.Control"]}},"parameters":[{"name":"controlType","optional":false,"description":"
The (class) name of the control type to create. Deprecated : Since version 1.38. This parameter is no longer supported and can be omitted.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oControlProperties","optional":false,"description":"
The properties that will be passed to the created control. The object may contain the following properties:
{string} [id] - The ID of the object. {string} icon - The button icon source. {string} [text] - The button text. It is only rendered in the overflow popover but not in the shell header. {string} [target] - target URI for a navigation link. {string} [ariaLabel] - Accessibility: aria-label attribute. {string} [ariaHaspopup] - Accessibility: aria-haspopup attribute. {Function} [press] - A function to be called when the button is depressed. ","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bIsVisible","optional":false,"description":"
Specify whether to display the control.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true, add the current control only to the current rendered shell state. Once the user navigates to another app or back to the Home page, this control will be removed.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
(only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to add the control.
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Creates and displays a shell header icon in Fiori launchpad, in the given launchpad states. The icon is displayed in the right side of the Fiori Launchpad shell header or in an overflow menu. The text property is mandatory as it might be used in the overflow menu. The tooltip property must not have the same text as the text property, as this causes accessibility issues if the item is in the overflow menu. If no tooltip is provided, the text property is shown as tooltip when the item is not in the overflow menu.
Example:
\nvar oRenderer = sap.ushell.Container.getRenderer(\"fiori2\");\n\n // Create an icon button that opens a dialog\n oRenderer.addHeaderEndItem({\n id: \"myTestButton\",\n icon: \"sap-icon://action-settings\",\n tooltip: resources.i18n.getText(\"testButton.tooltip\"),\n text: resources.i18n.getText(\"testButton.text\"),\n ariaLabel: resources.i18n.getText(\"testButton.ariaLabel\"),\n ariaHaspopup: \"dialog\",\n press: [myController.handleTestButtonPress, myController]\n }, true);\n\n // Create a temporary link\n oRenderer.addHeaderEndItem({\n id: \"myTestLink\",\n ariaLabel: resources.i18n.getText(\"testLink.label\"),\n target: \"#MyTestApplication-show\",\n icon: \"sap-icon://overflow\"\n }, true, true);\n {@link LaunchpadState\n If no launchpad state is provided the content is added in all states.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/addHeaderEndItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Extension#createHeaderItem or sap.ushell.services.FrameBoundExtension#createHeaderItem instead.","code":"addHeaderEndItem(controlType, oControlProperties, bIsVisible, bCurrentState, aStates) : sap.ui.core.Control "},{"name":"addHeaderItem","visibility":"public","since":"1.30","returnValue":{"type":"sap.ui.core.Control","description":"The created control
","typeInfo":{"UI5Types":["sap.ui.core.Control"]}},"parameters":[{"name":"controlType","optional":true,"description":"
The (class) name of the control type to create. Deprecated : Since version 1.38. This parameter is no longer supported and can be omitted.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oControlProperties","optional":false,"description":"
The properties that will be passed to the created control. For example: {id: \"testButton\"}
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bIsVisible","optional":false,"description":"
Specifies whether the header item control is displayed after being created.true then the control is displayed according to parameters bCurrentState and aStates.false then the control is created but not displayed.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true then the new created control is added to the current rendered shell state.false then add the control to the LaunchPadState itself.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
(Valid only if bCurrentState is false)
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Creates and displays an item in the header of Fiori launchpad, in the given launchpad states.
Example:
\nvar oRenderer = sap.ushell.Container.getRenderer(\"fiori2\");\n oRenderer.addHeaderItem({\n id: \"myTestButton\",\n ariaLabel: resources.i18n.getText(\"testButton.label\"),\n ariaHaspopup: \"dialog\",\n icon: \"sap-icon://action-settings\",\n tooltip: resources.i18n.getText(\"testButton.tooltip\"),\n text: resources.i18n.getText(\"testButton.text\"),\n press: controller.handleTestButtonPress\n }, true, true);\n {@link LaunchpadState} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/addHeaderItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Extension#createHeaderItem or sap.ushell.services.FrameBoundExtension#createHeaderItem instead.","code":"addHeaderItem(controlType?, oControlProperties, bIsVisible, bCurrentState, aStates) : sap.ui.core.Control "},{"name":"addLeftPaneContent","visibility":"public","since":"1.30","returnValue":{"type":"object","description":"oItem - the created control
","typeInfo":{"template":"object"}},"parameters":[{"name":"controlType","optional":false,"description":"
The (class) name of the control type to create.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oControlProperties","optional":false,"description":"
The properties that will be passed to the created control.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bIsVisible","optional":false,"description":"
Specify whether to display the control.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true, add the current control only to the current rendered shell state. Once the user navigates to another app or back to the Home page, this control will be removed.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
(only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to add the control.
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Creates the Left Pane content in Fiori launchpad, in the given launchpad states.
Example:
\nsap.ushell.Container.getRenderer(\"fiori2\").addLeftPaneContent(\"sap.m.Button\", {id: \"testBtn\", text: \"Test Button\"}, true, true);\n This function is marked for deprecation as of version 1.48.
","deprecated":{"since":"1.48","text":"Please use {@link #addSidePaneContent} instead."},"references":["{@link LaunchpadState\n If no launchpad state is provided the content is added in all states.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/addLeftPaneContent","deprecatedText":"Deprecated as of version 1.48. Please use #addSidePaneContent instead.","code":"addLeftPaneContent(controlType, oControlProperties, bIsVisible, bCurrentState, aStates) : object "},{"name":"addShellSubHeader","visibility":"public","since":"1.48","returnValue":{"type":"jQuery.Promise","description":"Resolves with the newly created control
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oParameters","optional":false,"description":"
Contains the required parameters for creating and showing the new control object.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"controlType","optional":false,"description":"
The (class) name of the control type to create.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.controlType","defaultValue":""},{"name":"oControlProperties","optional":false,"description":"
The properties that will be passed to the created control.
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oParameters.oControlProperties","defaultValue":""},{"name":"bIsVisible","optional":false,"description":"
Specify whether to display the control.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"oParameters.bIsVisible","defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true, add the current control only to the current rendered shell state. Once the user navigates to another app or back to the Home page, this control will be removed.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"oParameters.bCurrentState","defaultValue":""},{"name":"aStates","optional":false,"description":"
(only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to add the control.
","depth":1,"typeInfo":{"template":"Array"},"phoneName":"oParameters.aStates","defaultValue":""}],"description":"Creates and displays a sub header control in Fiori launchpad, in the given launchpad states.Example:
\nvar oRenderer = sap.ushell.Container.getRenderer(\"fiori2\"),\n oAddSubHeaderProperties = {\n controlType : \"sap.m.Bar\",\n oControlProperties : {\n id: \"testBar\",\n contentLeft: [new sap.m.Button({\n text: \"Test SubHeader Button\",\n press: function () {\n sap.m.MessageToast.show(\"Pressed\");\n }\n })\n },\n bIsVisible: true,\n bCurrentState: true\n };\n\noRenderer.addShellSubHeader(oAddSubHeaderProperties);\n ","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.FrameBoundExtension#createSubHeader} instead."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/addShellSubHeader","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension#createSubHeader instead.","code":"addShellSubHeader(oParameters) : jQuery.Promise "},{"name":"addSidePaneContent","visibility":"public","since":"1.48","returnValue":{"type":"jQuery.Promise","description":"Resolves with the newly created control
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oParameters","optional":false,"description":"
Contains the parameters for the control that should be added to the side pane
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"controlType","optional":false,"description":"
The (class) name of the control type to create.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.controlType","defaultValue":""},{"name":"oControlProperties","optional":false,"description":"
The properties that will be passed to the created control.
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oParameters.oControlProperties","defaultValue":""},{"name":"bIsVisible","optional":false,"description":"
Specify whether to display the control.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"oParameters.bIsVisible","defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true, add the current control only to the current rendered shell state. Once the user navigates to another app or back to the Home page, this control will be removed.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"oParameters.bCurrentState","defaultValue":""},{"name":"aStates","optional":false,"description":"
(only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to add the control.
","depth":1,"typeInfo":{"template":"Array"},"phoneName":"oParameters.aStates","defaultValue":""}],"description":"Creates the Left Pane content in Fiori launchpad, in the given launchpad states.
Example:
\nvar oRenderer = sap.ushell.Container.getRenderer(\"fiori2\"),\n oSidePaneContentProperties = {\n controlType : \"sap.m.Button\",\n oControlProperties : {\n id: \"testBtn\",\n text: \"Test Button\"\n },\n bIsVisible: true,\n bCurrentState: true\n };\n\noRenderer.addSidePaneContent(oSidePaneContentProperties);\n {@link LaunchpadState\n If no launchpad state is provided the content is added in all states.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/addSidePaneContent","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension#getSidePane instead.","code":"addSidePaneContent(oParameters) : jQuery.Promise "},{"name":"addSubHeader","visibility":"public","since":"1.30","returnValue":{"type":"object","description":"The created control
","typeInfo":{"template":"object"}},"parameters":[{"name":"controlType","optional":false,"description":"
The (class) name of the control type to create.\"sap.m.Bar\"
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oControlProperties","optional":false,"description":"
The properties that will be passed to the created control.{id: \"testBar\"}
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bIsVisible","optional":false,"description":"
Specifies whether the sub header control is displayed after being created.true then the control is displayed according to parameters bCurrentState and aStates,false then the control is created but not displayed.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true then the new created control is added to the current rendered shell state.false then add the control to the LaunchPadState itself.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
(Valid only if bCurrentState is false)
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Creates and displays a sub header control in Fiori launchpad, in the given launchpad states.
Example:
\nvar oRenderer = sap.ushell.Container.getRenderer(\"fiori2\");\noRenderer.addSubHeader(\"sap.m.Bar\", {id: \"testBar\", contentLeft: [new sap.m.Button({text: \"Test SubHeader Button\",\n press: function () {\n sap.m.MessageToast.show(\"Pressed\");\n }})\n]}, true, true);\n This function is marked for deprecation as of version 1.48.
","deprecated":{"since":"1.48","text":"Please use {@link #addShellSubHeader} instead."},"references":["{@link LaunchpadState} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/addSubHeader","deprecatedText":"Deprecated as of version 1.48. Please use #addShellSubHeader instead.","code":"addSubHeader(controlType, oControlProperties, bIsVisible, bCurrentState, aStates) : object "},{"name":"addToolAreaItem","visibility":"public","since":"1.30","returnValue":{"type":"sap.ui.core.Control","description":"the added control
","typeInfo":{"UI5Types":["sap.ui.core.Control"]}},"parameters":[{"name":"oControlProperties","optional":false,"description":"
The properties object that will be passed to the constructor of sap.ushell.ui.shell.ToolAreaItem control.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bIsVisible","optional":false,"description":"
Specify whether to display the control.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true, add the item to the currently rendered shell. If false, add the item to the given LaunchPadStates This causes the items to be rendered every time the given states are active.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
(only valid if bCurrentState is set to false) - An array of shell states (i.e. sap.ushell.renderers.fiori2.Renderer.LaunchpadState) in which the controls are added. If no launchpad state is provided the items are added in all states.
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Creates a ToolAreaItem in Fiori Launchpad and adds it to the Tool Area, in the given launchpad states. Once the item is added, the Tool Area is rendered on the left side on the Fiori Launchpad shell.
Example:
\nsap.ushell.Container.getRenderer(\"fiori2\").addToolAreaItem({\n id: \"testButton\",\n icon: \"sap-icon://documents\",\n expandable: true,\n press: function (evt) {\n window.alert(\"Press\" );\n },\n expand: function (evt) {\n // This function will be called on the press event of the \"expand\" button. The result of \"expand\" event in the UI must be determined by the developer\n window.alert(\"Expand\" );\n }\n}, true, false, [\"home\"]);\n {@link sap.ushell.ui.shell.ToolAreaItem} ","{@link sap.ushell.renderers.fiori2.Renderer.LaunchpadState.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/addToolAreaItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension#getToolArea instead.","code":"addToolAreaItem(oControlProperties, bIsVisible, bCurrentState, aStates) : sap.ui.core.Control "},{"name":"addUserAction","visibility":"public","since":"1.48","returnValue":{"type":"jQuery.Promise","description":"Resolves with the newly created control
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oParameters","optional":false,"description":"
Contains the required parameters for creating and showing the new control object.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"controlType","optional":false,"description":"
The (class) name of the control type to create.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.controlType","defaultValue":""},{"name":"oControlProperties","optional":false,"description":"
The properties that will be passed to the created control.
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oParameters.oControlProperties","defaultValue":""},{"name":"bIsVisible","optional":false,"description":"
Specify whether to display the control.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"oParameters.bIsVisible","defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true, add the current control only to the current rendered shell state. Once the user navigates to another app or back to the Home page, this control will be removed.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"oParameters.bCurrentState","defaultValue":""},{"name":"aStates","optional":false,"description":"
(only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to add the control. If no launchpad state is provided the content is added in all states. @see LaunchpadState
","depth":1,"typeInfo":{"template":"Array"},"phoneName":"oParameters.aStates","defaultValue":""}],"description":"Creates an Action Button in Fiori launchpad, in the given launchpad states. The button will be displayed in the user actions menu, that is opened from the user button in the shell header. Example:
\nvar oRenderer = sap.ushell.Container.getRenderer(\"fiori2\"),\n oAddActionButtonProperties = {\n controlType : \"sap.m.Button\",\n oControlProperties : {\n id: \"exampleButton\",\n text: \"Example Button\",\n icon: \"sap-icon://refresh\",\n press: function () {\n alert(\"Example Button was pressed!\");\n }\n },\n bIsVisible: true,\n bCurrentState: true\n };\noRenderer.addUserAction(oAddActionButtonProperties);\n ","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Extension#createUserAction} or {@link sap.ushell.services.FrameBoundExtension#createUserAction} instead."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/addUserAction","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Extension#createUserAction or sap.ushell.services.FrameBoundExtension#createUserAction instead.","code":"addUserAction(oParameters) : jQuery.Promise "},{"name":"addUserPreferencesEntry","visibility":"public","since":"1.30","parameters":[{"name":"entryObject","optional":false,"description":"
The data of the new added User Preference entry.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"entryHelpID","optional":false,"description":"
(Optional) - The ID of the object.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"entryObject.entryHelpID","defaultValue":""},{"name":"title","optional":false,"description":"
The title of the entry to be presented in the list in the User Preferences dialog box. We recommend using a string from the translation bundle.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"entryObject.title","defaultValue":""},{"name":"content","optional":false,"description":"
A function to be called that returns a jQuery.Promise object which consists of a {sap.ui.core.Control} to be displayed in a follow-on dialog box. A SAPUI5 view instance can also be returned. The function is called on each time the user opens the User Preferences dialog box.
","depth":1,"typeInfo":{"template":"function"},"phoneName":"entryObject.content","defaultValue":""},{"name":"onSave","optional":false,"description":"
A function to be called which returns a jQuery.Promise object when the user clicks \"save\" in the User Preferences dialog box. If an error occurs, pass the error message via the jQuery.Promise object. Errors are displayed in the log.
","depth":1,"typeInfo":{"template":"function"},"phoneName":"entryObject.onSave","defaultValue":""},{"name":"onCancel","optional":false,"description":"
A function to be called that closes the User Preferences dialog box without saving any changes.
","depth":1,"typeInfo":{"template":"function"},"phoneName":"entryObject.onCancel","defaultValue":""},{"name":"provideEmptyWrapper","optional":false,"description":"
Set this value to true if you want that your content is displayed without the standard header.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"entryObject.provideEmptyWrapper","defaultValue":""},{"name":"value","optional":false,"description":"
A string to be presented as the value of the entry OR a function to be called which returns a jQuery.Promise object.
","typeInfo":{"template":"string | function"},"defaultValue":""}],"description":"Adds an entry to the User Preferences dialog box including the UI control that appears when the user clicks the new entry, and handling of User Preferences actions such as SAVE and CANCEL.
Example:
\nvar oRenderer = sap.ushell.Container.getRenderer(\"fiori2\");\nvar oEntry = {\n title: \"title\",\n value: function() {\n return jQuery.Deferred().resolve(\"entryTitleToBeDisplayed\");\n },\n content: function() {\n return jQuery.Deferred().resolve(new sap.m.Button(\"userPrefEntryButton\", {text: \"Button\"}));\n },\n onSave: function() {\n return jQuery.Deferred().resolve();\n }\n};\noRenderer.addUserPreferencesEntry(oEntry);\n ","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.FrameBoundExtension#addUserSettingsEntry} instead."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/addUserPreferencesEntry","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension#addUserSettingsEntry instead.","code":"addUserPreferencesEntry(entryObject, value) : void "},{"name":"getCurrentViewportState","visibility":"public","since":"1.37","returnValue":{"type":"string","description":"The current Viewport State.
","typeInfo":{"template":"string"}},"description":"This method returns the current state of the Viewport Container control.
","deprecated":{"since":"1.120","text":"This functionality was discontinued."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/getCurrentViewportState","deprecatedText":"Deprecated as of version 1.120. This functionality was discontinued.","code":"getCurrentViewportState() : string "},{"name":"hideActionButton","visibility":"public","since":"1.30","parameters":[{"name":"aIds","optional":false,"description":"
IDs of the button controls that should hidden.
","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true, removes the current control only from the current rendered shell state.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
A list of the launchpad states in which to hide the control. Valid only if bCurrentState is set to false.
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Hides an action button from the User Actions Menu in the SAP Fiori launchpad, in the given launchpad states (LaunchpadState). The removed button will not be destroyed.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Extension#createUserAction} or {@link sap.ushell.services.FrameBoundExtension#createUserAction} instead."},"references":["{@link sap.ushell.renderers.fiori2.Renderer.LaunchpadState.\n If no launchpad state is provided, the content is hidden in all states.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/hideActionButton","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Extension#createUserAction or sap.ushell.services.FrameBoundExtension#createUserAction instead.","code":"hideActionButton(aIds, bCurrentState, aStates) : void "},{"name":"hideFloatingActionButton","visibility":"public","since":"1.30","parameters":[{"name":"aIds","optional":false,"description":"
the Ids of the sap.ushell.ui.shell.ShellFloatingAction to remove.
","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
if true, remove the current control only from the current rendered shell state.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to remove the control. (Only valid if bCurrentState is set to false)
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Hide the given sap.ushell.ui.shell.ShellFloatingAction from Fiori Launchpad, in the given launchpad states. The removed control will not be destroyed.
","deprecated":{"since":"1.52","text":"Deprecated without successor. Support for the FloatingActionButton has been discontinued."},"references":["{@link LaunchpadState\n If no launchpad state is provided the content is removed in all states.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/hideFloatingActionButton","deprecatedText":"Deprecated as of version 1.52. Deprecated without successor. Support for the FloatingActionButton has been discontinued.","code":"hideFloatingActionButton(aIds, bCurrentState, aStates) : void "},{"name":"hideHeaderEndItem","visibility":"public","since":"1.30","parameters":[{"name":"aIds","optional":false,"description":"
the Ids of the sap.ushell.ui.shell.ShellHeadItem to remove.
","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
if true, remove the current control only from the current rendered shell state.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to remove the control. (Only valid if bCurrentState is set to false)
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Hide the given sap.ushell.ui.shell.ShellHeadItem from Fiori Launchpad, in the given launchpad states. The removed control will not be destroyed.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Extension#createHeaderItem} or {@link sap.ushell.services.FrameBoundExtension#createHeaderItem} instead."},"references":["{@link LaunchpadState\n If no launchpad state is provided the content is removed in all states.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/hideHeaderEndItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Extension#createHeaderItem or sap.ushell.services.FrameBoundExtension#createHeaderItem instead.","code":"hideHeaderEndItem(aIds, bCurrentState, aStates) : void "},{"name":"hideHeaderItem","visibility":"public","since":"1.30","parameters":[{"name":"aIds","optional":false,"description":"
the Ids of the sap.ushell.ui.shell.ShellHeadItem to remove.
","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
if true, remove the current control only from the current rendered shell state.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to remove the control. (Only valid if bCurrentState is set to false)
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Hide the given sap.ushell.ui.shell.ShellHeadItem from Fiori Launchpad, in the given launchpad states. The removed control will not be destroyed.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Extension#createHeaderItem} or {@link sap.ushell.services.FrameBoundExtension#createHeaderItem} instead."},"references":["{@link LaunchpadState\n If no launchpad state is provided the content is removed in all states.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/hideHeaderItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Extension#createHeaderItem or sap.ushell.services.FrameBoundExtension#createHeaderItem instead.","code":"hideHeaderItem(aIds, bCurrentState, aStates) : void "},{"name":"hideLeftPaneContent","visibility":"public","since":"1.30","parameters":[{"name":"aIds","optional":false,"description":"
the Ids of the controls to remove.
","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
if true, remove the current control only from the current rendered shell state.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to remove the control. (Only valid if bCurrentState is set to false)
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Hide the given control from Fiori Launchpad, in the given launchpad states. The removed control will not be destroyed.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.FrameBoundExtension#getSidePane} instead."},"references":["{@link LaunchpadState\n If no launchpad state is provided the content is removed in all states.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/hideLeftPaneContent","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension#getSidePane instead.","code":"hideLeftPaneContent(aIds, bCurrentState, aStates) : void "},{"name":"hideSubHeader","visibility":"public","since":"1.30","parameters":[{"name":"aIds","optional":false,"description":"
the Ids of the controls to remove.
","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
if true, remove the current control only from the current rendered shell state.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to remove the control. (Only valid if bCurrentState is set to false)
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Hide the given control from the Fiori Launchpad sub header, in the given launchpad states. The removed control will not be destroyed.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.FrameBoundExtension#createSubHeader} instead."},"references":["{@link LaunchpadState\n If no launchpad state is provided the content is removed in all states.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/hideSubHeader","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension#createSubHeader instead.","code":"hideSubHeader(aIds, bCurrentState, aStates) : void "},{"name":"removeFooter","visibility":"public","since":"1.30","description":"If exists, this method will remove the footer from the Fiori Launchpad.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.FrameBoundExtension.Footer#destroy} instead."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/removeFooter","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension.Footer#destroy instead.","code":"removeFooter() : void "},{"name":"removeToolAreaItem","visibility":"public","since":"1.30","parameters":[{"name":"vIds","optional":false,"description":"
A single ID or an array of IDs to remove from the Tool Area.
","typeInfo":{"template":"string | Array"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true, remove the items from the currently rendered shell. If false, remove the items from the LaunchPadState itself, causing the items to be removed every time the given states are active.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
(only valid if bCurrentState is set to false) - An array of shell states (i.e. sap.ushell.renderers.fiori2.Renderer.LaunchpadState) from which the controls are removed. If no launchpad state is provided the items are removed from all states.
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Remove the given Tool Area Item from Fiori Launchpad, in the given launchpad states. This API is meant to be used for implementing custom elements in the SAP Fiori launchpad. We do not recommend using it on a standard launchpad element, as this may interfere with the standard launchpad functionality.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.FrameBoundExtension#getToolArea} instead."},"references":["{@link sap.ushell.renderers.fiori2.Renderer.LaunchpadState.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/removeToolAreaItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension#getToolArea instead.","code":"removeToolAreaItem(vIds, bCurrentState, aStates) : void "},{"name":"setFooter","visibility":"public","since":"1.30","parameters":[{"name":"oFooter","optional":false,"description":"
sap.m.Bar, the control to be added as the footer of the Fiori Launchpad
","typeInfo":{"UI5Types":["sap.m.Bar"]},"defaultValue":""}],"description":"Displays the given sap.m.Bar as the footer of the Fiori launchpad shell. The footer will be displayed in all states.
Example:
\nvar bar = new sap.m.Bar({contentLeft: [new sap.m.Button({text: \"Test Footer Button\",\n press: function () {\n sap.m.MessageToast.show(\"Pressed\");\n }})\n]});\nvar renderer = sap.ushell.Container.getRenderer(\"fiori2\");\nrenderer.setFooter(bar);\n ","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.FrameBoundExtension#createFooter} instead."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/setFooter","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension#createFooter instead.","code":"setFooter(oFooter) : void "},{"name":"setFooterControl","visibility":"public","since":"1.42","returnValue":{"type":"sap.ui.core.Control","description":"The created control
","typeInfo":{"UI5Types":["sap.ui.core.Control"]}},"parameters":[{"name":"controlType","optional":false,"description":"
The (class) name of the control type to create.\"sap.m.Bar\"
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oControlProperties","optional":false,"description":"
The properties that will be passed to the created control.{id: \"testBar\"}
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Creates and displays an SAPUI5 control as the footer of the Fiori launchpad shell.
For example, using the sap.m.Bar control:
\nvar oRenderer = sap.ushell.Container.getRenderer(\"fiori2\");\noRenderer.setFooterControl(\"sap.m.Bar\", {id: \"testBar\", contentLeft: [new sap.m.Button({text: \"Test Footer Button\",\n press: function () {\n sap.m.MessageToast.show(\"Pressed\");\n }})\n]});\n This function is marked for deprecation as of version 1.48.
","deprecated":{"since":"1.48","text":"Please use {@link #setShellFooter} instead."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/setFooterControl","deprecatedText":"Deprecated as of version 1.48. Please use #setShellFooter instead.","code":"setFooterControl(controlType, oControlProperties) : sap.ui.core.Control "},{"name":"setHeaderTitle","visibility":"public","since":"1.30","parameters":[{"name":"sTitle","optional":false,"description":"
The title to be displayed in the Fiori Launchpad shell header
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Sets the title in the Fiori Launchpad shell header.
","deprecated":{"since":"1.120","text":"The \"second title\" functionality was discontinued. Set a title via {@link sap.ushell.ui5service.ShellUIService#setTitle} instead."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/setHeaderTitle","deprecatedText":"Deprecated as of version 1.120. The \"second title\" functionality was discontinued. Set a title via sap.ushell.ui5service.ShellUIService#setTitle instead.","code":"setHeaderTitle(sTitle) : void "},{"name":"setHeaderVisibility","visibility":"public","since":"1.38","parameters":[{"name":"bVisible","optional":false,"description":"
The visibility of the header
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true then the visibility is set only to the current rendered shell state.false then set the visibility according to the states provided in the aState parameter.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
(Valid only if bCurrentState is false)
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Sets the header visibility according to the given value and shell states. (see sap.ushell.renderers.fiori2.Renderer.LaunchpadState).
Example:
\nvar oRenderer = sap.ushell.Container.getRenderer(\"fiori2\");\noRenderer.setHeaderVisibility(false, false, [\"home\", \"app\"]);\n {@link LaunchpadState} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/setHeaderVisibility","deprecatedText":"Deprecated as of version 1.120. This functionality was discontinued.","code":"setHeaderVisibility(bVisible, bCurrentState, aStates) : void "},{"name":"setLeftPaneVisibility","visibility":"public","since":"1.30","parameters":[{"name":"sLaunchpadState","optional":false,"description":"
LaunchpadState in which to show/hide the left pane
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"bVisible","optional":false,"description":"
specify whether to display the left pane or not
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Sets the visibility of the left pane in the Fiori Launchpad shell, in the given launchpad state @see LaunchpadState
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.FrameBoundExtension#getSidePane} instead."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/setLeftPaneVisibility","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension#getSidePane instead.","code":"setLeftPaneVisibility(sLaunchpadState, bVisible) : void "},{"name":"setShellFooter","visibility":"public","since":"1.48","returnValue":{"type":"jQuery.Promise","description":"Resolves with the newly created control
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oParameters","optional":false,"description":"
Contains the required parameters for creating and showing the new control object.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"controlType","optional":false,"description":"
The (class) name of the control type to create, for example: sap.m.Bar
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.controlType","defaultValue":""},{"name":"oControlProperties","optional":false,"description":"
The properties that will be passed to the created control, for example: {id: \"testBar\"}
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oParameters.oControlProperties","defaultValue":""}],"description":"Creates and displays an SAPUI5 control as the footer of the Fiori launchpad shell.
For example, using the sap.m.Bar control:
\nvar oRenderer = sap.ushell.Container.getRenderer(\"fiori2\"),\n oFooterControlProperties = {\n controlType : \"sap.m.Bar\",\n oControlProperties : {\n id: \"testBar\",\n contentLeft: [new sap.m.Button({\n text: \"Test Footer Button\",\n press: function () {\n sap.m.MessageToast.show(\"Pressed\");\n }\n })]\n }\n };\noRenderer.setShellFooter(oFooterControlProperties);\n ","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.FrameBoundExtension#createFooter} instead."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/setShellFooter","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension#createFooter instead.","code":"setShellFooter(oParameters) : jQuery.Promise "},{"name":"showActionButton","visibility":"public","since":"1.30","parameters":[{"name":"aIds","optional":false,"description":"
List of ID elements to that should be added to the User Actions Menu options bar.
","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true, add the created control to the current rendered shell state. When the user navigates to a different state, or to a different application, then the control is removed. If false, the control is added to the LaunchpadState.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
List of the launchpad states (sap.ushell.renderers.fiori2.Renderer.LaunchpadState) in which to add the aIds. Valid only if bCurrentState is set to false.
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Displays action buttons in the User Actions Menu in the SAP Fiori launchpad, in the given launchpad states (LaunchpadState). (see sap.ushell.renderers.fiori2.Renderer.LaunchpadState). If no launchpad state is provided the content is displayed in all states. The user actions menu is opened via the button on the right hand side of the shell header.
Example:
\nvar button1 = new sap.m.Button();\nvar renderer = sap.ushell.Container.getRenderer(\"fiori2\");\nrenderer.showActionButton([button1.getId()], false, [\"home\", \"app\"]);\n {@link sap.ushell.renderers.fiori2.Renderer.LaunchpadState.\n If no launchpad state is provided, the content is added in all states.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/showActionButton","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Extension#createUserAction or sap.ushell.services.FrameBoundExtension#createUserAction instead.","code":"showActionButton(aIds, bCurrentState, aStates) : void "},{"name":"showFloatingActionButton","visibility":"public","since":"1.30","parameters":[{"name":"aIds","optional":false,"description":"
List of ID elements to add to the user actions menu.
","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
if true, add the current Buttons only to the current instance of the rendering of the shell. if false, add the Buttons to the LaunchPadState itself.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
(only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to add the aIds.
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Displays FloatingActionButton in the bottom right corner of the Fiori launchpad, in the given launchpad states. The FloatingActionButton is rendered in the bottom right corner of the shell. (see sap.ushell.renderers.fiori2.Renderer.LaunchpadState). If no launchpad state is provided, the content is displayed in all states.
Example:
\nvar button1 = new sap.ushell.ui.shell.ShellFloatingAction();\nvar renderer = sap.ushell.Container.getRenderer(\"fiori2\");\nrenderer.showFloatingActionButton([button1.getId()], true);\n ","deprecated":{"since":"1.52","text":"Support for the FloatingActionButton has been discontinued."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/showFloatingActionButton","deprecatedText":"Deprecated as of version 1.52. Support for the FloatingActionButton has been discontinued.","code":"showFloatingActionButton(aIds, bCurrentState, aStates) : void "},{"name":"showHeaderEndItem","visibility":"public","since":"1.30","parameters":[{"name":"aIds","optional":false,"description":"
List of ID elements to add to the shell header.
","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
if true, add the current HeaderItems only to the current instance of the rendering of the shell. if false, add the HeaderItems to the LaunchPadState itself.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
(only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to add the aIds.
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Displays HeaderItems on the right side of the Fiori launchpad shell header, in the given launchpad states (see sap.ushell.renderers.fiori2.Renderer.LaunchpadState). If no launchpad state is provided the content is displayed in all states. The shell header can display the user HeaderItem, and just one more HeaderItem. If this method is called when the right side of the header is full, this method will not do anything.
Example:
\nvar button1 = new sap.ushell.ui.shell.ShellHeadItem();\nvar renderer = sap.ushell.Container.getRenderer(\"fiori2\");\nrenderer.showHeaderEndItem ([button1.getId()], false, [\"home\", \"app\"]);\n ","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Extension#createHeaderItem} or {@link sap.ushell.services.FrameBoundExtension#createHeaderItem} instead."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/showHeaderEndItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Extension#createHeaderItem or sap.ushell.services.FrameBoundExtension#createHeaderItem instead.","code":"showHeaderEndItem(aIds, bCurrentState, aStates) : void "},{"name":"showHeaderItem","visibility":"public","since":"1.30","parameters":[{"name":"vIds","optional":false,"description":"
Either ID or an array of IDs of headerItem controls to be added to the shell header.
","typeInfo":{"template":"string | Array"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true then the new created controls are added to the current rendered shell state. When the user navigates to another application (including the Home page) then the controls will be removed. If false then the controls are added to the LaunchPadState itself.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
Valid only if bCurrentState is false. A list of shell states (i.e. sap.ushell.renderers.fiori2.Renderer.LaunchpadState) in which the controls are added. If no launchpad state is provided the controls are added in all states.
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Creates and displays one or more HeaderItem controls according to the given control IDs and Shell states
Example:
\nvar button1 = new sap.ushell.ui.shell.ShellHeadItem();\nvar button2 = new sap.ushell.ui.shell.ShellHeadItem();\nvar renderer = sap.ushell.Container.getRenderer(\"fiori2\");\nrenderer.showHeaderItem ([button1.getId(), button2.getId()], false, [\"home\", \"app\"]);\n {@link sap.ushell.renderers.fiori2.Renderer.LaunchpadState.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/showHeaderItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Extension#createHeaderItem or sap.ushell.services.FrameBoundExtension#createHeaderItem instead.","code":"showHeaderItem(vIds, bCurrentState, aStates) : void "},{"name":"showSubHeader","visibility":"public","since":"1.30","parameters":[{"name":"aIds","optional":false,"description":"
Array of sub header control IDs to be added
","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true then the new created controls are added only to the current rendered shell state.false then add the control to the LaunchPadState itself.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
(Valid only if bCurrentState is false)
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Displays one or more sub header controls according to the given control IDs and shell states.
Example:
\nvar bar = new sap.m.Bar({id: \"testBar\", contentLeft: [new sap.m.Button({text: \"Test SubHeader Button\",\n press: function () {\n sap.m.MessageToast.show(\"Pressed\");\n }})\n]});\nvar oRenderer = sap.ushell.Container.getRenderer(\"fiori2\");\noRenderer.showSubHeader([bar.getId()], false, [\"home\", \"app\"]);\n {@link LaunchpadState} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/showSubHeader","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension#createSubHeader instead.","code":"showSubHeader(aIds, bCurrentState, aStates) : void "},{"name":"showToolArea","visibility":"public","parameters":[{"name":"sLaunchpadState","optional":true,"description":"
LaunchpadState in which to show/hide the ToolArea @see LaunchpadState
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"bVisible","optional":true,"description":"
specifies whether to display the ToolArea or not
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Sets the ToolArea visibility
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.FrameBoundExtension#getToolArea} instead."},"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/showToolArea","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension#getToolArea instead.","code":"showToolArea(sLaunchpadState?, bVisible?) : void "},{"name":"showToolAreaItem","visibility":"public","since":"1.30","parameters":[{"name":"vIds","optional":false,"description":"
A single ID or an array of IDs to add to the Tool Area.
","typeInfo":{"template":"string | Array"},"defaultValue":""},{"name":"bCurrentState","optional":false,"description":"
If true, add the items to the currently rendered shell. If false, add the items to the LaunchPadState itself, causing the items to be rendered every time the given states are active.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"aStates","optional":false,"description":"
Only valid if bCurrentState is set to false. An array of shell states (i.e. sap.ushell.renderers.fiori2.Renderer.LaunchpadState) in which the controls are added. If no launchpad state is provided the items are added in all states.
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Displays ToolAreaItems on the left side of the Fiori Launchpad shell, in the given launchpad states.
Example:
\nsap.ui.require([\"sap/ushell/ui/shell/ToolAreaItem\"], function (ToolAreaItem) {\n var oRenderer = sap.ushell.Container.getRenderer(\"fiori2\"),\n oToolAreaItem = new ToolAreaItem({ icon: \"sap-icon://wrench\" });\n renderer.showToolAreaItem(oToolAreaItem.getId(), false, [\"home\", \"app\"]);\n});\n {@link sap.ushell.renderers.fiori2.Renderer.LaunchpadState.} "],"href":"api/sap.ushell.renderers.fiori2.Renderer#methods/showToolAreaItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.FrameBoundExtension#getToolArea instead.","code":"showToolAreaItem(vIds, bCurrentState, aStates) : void "}],"displayName":"sap.ushell.renderers.fiori2.Renderer","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.renderers.fiori2.Renderer","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Extension or sap.ushell.services.FrameBoundExtension instead."},{"kind":"namespace","name":"sap.ushell.sandbox.SandboxBootTask","basename":"SandboxBootTask","resource":"sap/ushell/sandbox/SandboxBootTask.js","module":"sap/ushell/sandbox/SandboxBootTask","export":"","static":true,"visibility":"public","since":"1.136","description":"
The Unified Shell's bootstrap code for development sandbox scenarios.
This module provides a boot task that integrates the sandbox configuration provider into the UI5 configuration system. It is used for UI5 1.x compatibility where the boot task mechanism is required to inject configuration before the framework fully initializes.
For UI5 2.x, the preferred approach is to use the manifest-based configuration via `sandboxManifest.json`.
Usage: Include this script before the UI5 bootstrap script to register the sandbox configuration provider via the `xx-bootTask` mechanism.
","examples":[{"data":"Example: \n
"}],"displayName":"sap.ushell.sandbox.SandboxBootTask","component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.sandbox.SandboxBootTask","subTitle":"Deprecated in version: 1.136","deprecatedText":"Deprecated as of version 1.136. Use sandboxManifest.json with manifest-based boot configuration instead"},{"kind":"namespace","name":"sap.ushell.services","basename":"services","static":true,"visibility":"public","since":"1.15.0","description":"
Default namespace for Unified Shell services.
{@link sap.ushell.Container.getServiceAsync} "],"displayName":"sap.ushell.services","nodes":[{"name":"sap.ushell.services.AppConfiguration","description":"The unified shell's AppConfiguration service as a singleton object.
","href":"api/sap.ushell.services.AppConfiguration"},{"name":"sap.ushell.services.AppLifeCycle","description":"The Unified Shell's AppLifeCycle service.\n
","href":"api/sap.ushell.services.AppLifeCycle"},{"name":"sap.ushell.services.Bookmark","description":"The Unified Shell's bookmark service.
","href":"api/sap.ushell.services.Bookmark","deprecated":true},{"name":"sap.ushell.services.BookmarkV2","description":"The Unified Shell's bookmark service.
","href":"api/sap.ushell.services.BookmarkV2"},{"name":"sap.ushell.services.Configuration","description":"The unified shell's Configuration service.
","href":"api/sap.ushell.services.Configuration"},{"name":"sap.ushell.services.ContentExtensionAdapterFactory","description":"","href":"api/sap.ushell.services.ContentExtensionAdapterFactory","deprecated":true},{"name":"sap.ushell.services.CrossApplicationNavigation","description":"The Unified Shell's CrossApplicationNavigation service.
","href":"api/sap.ushell.services.CrossApplicationNavigation","deprecated":true},{"name":"sap.ushell.services.EndUserFeedback","description":"The Unified Shell's end user feedback service.
","href":"api/sap.ushell.services.EndUserFeedback","deprecated":true},{"name":"sap.ushell.services.Extension","description":"The Unified Shell's Extension service.
","href":"api/sap.ushell.services.Extension"},{"name":"sap.ushell.services.FrameBoundExtension","description":"The Unified Shell's Extension service.
","href":"api/sap.ushell.services.FrameBoundExtension"},{"name":"sap.ushell.services.LaunchPage","description":"A service for handling groups, tiles and catalogs.\n
","href":"api/sap.ushell.services.LaunchPage","deprecated":true},{"name":"sap.ushell.services.Message","description":"Message service.\n
","href":"api/sap.ushell.services.Message","deprecated":true},{"name":"sap.ushell.services.MessageBroker","description":"The Unified Shell's MessageBroker service.\n
","href":"api/sap.ushell.services.MessageBroker"},{"name":"sap.ushell.services.Navigation","description":"The Unified Shell's Navigation service.
","href":"api/sap.ushell.services.Navigation"},{"name":"sap.ushell.services.NavTargetResolution","description":"The Unified Shell's internal navigation target resolution service.\n
","href":"api/sap.ushell.services.NavTargetResolution","deprecated":true},{"name":"sap.ushell.services.Notifications","description":"UShell service for fetching user notification data from the Notification center/service
","href":"api/sap.ushell.services.Notifications","deprecated":true},{"name":"sap.ushell.services.NotificationsV2","description":"UShell service for fetching user notification data from the Notification center/service
","href":"api/sap.ushell.services.NotificationsV2"},{"name":"sap.ushell.services.Personalization","description":"The Unified Shell's personalization service, which provides a personalizer object that handles all personalization operations.\n
","href":"api/sap.ushell.services.Personalization","deprecated":true},{"name":"sap.ushell.services.PersonalizationV2","description":"The Unified Shell's personalization service.
","href":"api/sap.ushell.services.PersonalizationV2"},{"name":"sap.ushell.services.PluginManager","description":"The Unified Shell's PluginManager service.\n
","href":"api/sap.ushell.services.PluginManager"},{"name":"sap.ushell.services.SearchableContent","description":"The Unified Shell's SearchableContent service.\n
","href":"api/sap.ushell.services.SearchableContent"},{"name":"sap.ushell.services.Service","description":"Abstract base interface for ushell services.
","href":"api/sap.ushell.services.Service"},{"name":"sap.ushell.services.ServiceTypes","description":"A helper type that maps service names to service types.
","href":"api/sap.ushell.services.ServiceTypes"},{"name":"sap.ushell.services.SessionHandler","description":"The Unified Shell's session handler service.
","href":"api/sap.ushell.services.SessionHandler"},{"name":"sap.ushell.services.ShellNavigation","description":"The Unified Shell's internal navigation service (platform independent).\n
","href":"api/sap.ushell.services.ShellNavigation","deprecated":true},{"name":"sap.ushell.services.ShellNavigationInternal","description":"The Unified Shell's internal navigation service (platform independent).\n
","href":"api/sap.ushell.services.ShellNavigationInternal"},{"name":"sap.ushell.services.SmartNavigation","description":"Constructs an instance of SmartNavigation.
","href":"api/sap.ushell.services.SmartNavigation","deprecated":true},{"name":"sap.ushell.services.SpaceContent","description":"This service provides APIs for the S/4 MyHome.
","href":"api/sap.ushell.services.SpaceContent"},{"name":"sap.ushell.services.SupportTicket","description":"The Unified Shell's SupportTicket service.\n
","href":"api/sap.ushell.services.SupportTicket"},{"name":"sap.ushell.services.URLParsing","description":"The Unified Shell's internal URL parsing service (platform independent).\n
","href":"api/sap.ushell.services.URLParsing"},{"name":"sap.ushell.services.UsageAnalytics","description":"A UShell service for tracking business flows and user actions.\n
","href":"api/sap.ushell.services.UsageAnalytics","deprecated":true},{"name":"sap.ushell.services.UserDefaultParameters","description":"The Unified Shell's UserDefaultParameters service.\n
","href":"api/sap.ushell.services.UserDefaultParameters"},{"name":"sap.ushell.services.UserInfo","description":"The Unified Shell's user information service.
","href":"api/sap.ushell.services.UserInfo"},{"name":"sap.ushell.services.UserRecents","description":"The Unified Shell's user recents service.
","href":"api/sap.ushell.services.UserRecents"},{"name":"sap.ushell.services.VisualizationInstantiation","description":"The Unified Shell's VisualizationInstantiation service.\n
","href":"api/sap.ushell.services.VisualizationInstantiation"},{"name":"sap.ushell.services.Pages","description":"","href":"api/sap.ushell.services.Pages"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.services","subTitle":""},{"kind":"namespace","name":"sap.ushell.services.AppConfiguration","basename":"AppConfiguration","resource":"sap/ushell/services/AppConfiguration.js","module":"sap/ushell/services/AppConfiguration","export":"","static":true,"visibility":"public","since":"1.15.0","description":"
The unified shell's AppConfiguration service as a singleton object.
","methods":[{"name":"addActivity","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves the updated list of user recents.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oRecentActivity","optional":false,"description":"
oRecentActivity
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Adds an entry to user recent activity list. The list of recent activities will be displayed in the UserActionsMenu of FLP application (fiori 2.0) This method should be used by applications of special types. like \"Search\", \"OVP\", \"Co-Pilot\" and \"FactSheet\" This method should be only called in the \"exit\" method of applications Component.js in order to assure that it will be added to recent activities. For these applications the unique identifier of the entry is url and not appId, so in order to add different entry, different url should be specified, otherwise the entry will be updated with a new timestamp Only applications of type Search and Co-Pilot can set their icon.
","deprecated":{"since":"1.120","text":"Deprecated without successor."},"examples":[{"data":"Example: Of oRecentActivity object - all properties are mandatory:\n\n {\n title: 'Sample Activity Entry',\n appType: 'OVP',\n appId: \"#Action-todefaultapp\",\n url: \"#Action-todefaultapp?param1\"\n }\n
"},{"data":"Example: Of oRecentActivity object for application of type Search and Co-Pilot:\n\n {\n icon: 'sap-icon://search',//not mandatory. In case icon is not set, a default one will be used\n title: 'Sample Activity Entry',\n appType: 'Search',\n appId: \"#Action-todefaultapp\",\n url: \"#Action-todefaultapp?param1\"\n }\n
"}],"href":"api/sap.ushell.services.AppConfiguration#methods/addActivity","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor.","code":"addActivity(oRecentActivity) : jQuery.Promise "},{"name":"addApplicationSettingsButtons","visibility":"public","parameters":[{"name":"aButtons","optional":false,"description":"
List of sap.m.Button controls
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.m.Button"]},"defaultValue":""}],"description":"Adds buttons to the action sheet in the shell header. This function always overrides the already existing application settings buttons with the new buttons. It is meant to be used by applications that want to add their own settings button to the shell header.
","deprecated":{"since":"1.120","text":"Use {@link sap.ushell.services.Extension#createUserAction} instead."},"href":"api/sap.ushell.services.AppConfiguration#methods/addApplicationSettingsButtons","deprecatedText":"Deprecated as of version 1.120. Use sap.ushell.services.Extension#createUserAction instead.","code":"addApplicationSettingsButtons(aButtons) : void "},{"name":"getMetadata","visibility":"restricted","allowedFor":["sap.feedback.ui"],"returnValue":{"type":"sap.ushell.services.AppConfiguration.Metadata","description":"A copy of the metadata object
","typeInfo":{"UI5Types":["sap.ushell.services.AppConfiguration.Metadata"],"refersToTypedef":true}},"parameters":[{"name":"oApplication","optional":true,"description":"
oApplication
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"oParsedHash","optional":true,"description":"
The parsed shell hash
","typeInfo":{"UI5Types":["sap.ushell.services.URLParsing.DecomposedHash"],"refersToTypedef":true},"defaultValue":""}],"description":"Returns the current metadata.
","href":"api/sap.ushell.services.AppConfiguration#methods/getMetadata","code":"getMetadata(oApplication?, oParsedHash?) : sap.ushell.services.AppConfiguration.Metadata "},{"name":"setApplicationFullWidth","visibility":"public","parameters":[{"name":"bValue","optional":false,"description":"
A Boolean value indicating if the application fills the full width of the screen
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Sets the application screen size to full width
","deprecated":{"since":"1.120","text":"Use {@link sap.ushell.ui5service.ShellUIService#setApplicationFullWidth} instead."},"href":"api/sap.ushell.services.AppConfiguration#methods/setApplicationFullWidth","deprecatedText":"Deprecated as of version 1.120. Use sap.ushell.ui5service.ShellUIService#setApplicationFullWidth instead.","code":"setApplicationFullWidth(bValue) : void "},{"name":"setIcons","visibility":"public","parameters":[{"name":"oIconsProperties","optional":false,"description":"
Icon properties, an object holding icon URLs
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets the icons of the browser.
","deprecated":{"since":"1.120","text":"Use {@link sap.ui.util.Mobile#setIcons} instead."},"href":"api/sap.ushell.services.AppConfiguration#methods/setIcons","deprecatedText":"Deprecated as of version 1.120. Use sap.ui.util.Mobile#setIcons instead.","code":"setIcons(oIconsProperties) : void "}],"displayName":"sap.ushell.services.AppConfiguration","nodes":[{"name":"sap.ushell.services.AppConfiguration.Metadata","description":"Type for the metadata object for AppConfiguration
","href":"api/sap.ushell.services.AppConfiguration.Metadata"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.services.AppConfiguration","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.AppConfiguration.Metadata","basename":"Metadata","resource":"sap/ushell/services/AppConfiguration.js","module":"sap/ushell/services/AppConfiguration","static":true,"visibility":"public","since":"1.120.0","description":"
Type for the metadata object for AppConfiguration
","properties":[{"name":"title","optional":false,"visibility":"public","description":"The title of the application
","typeInfo":{"template":"string"}},{"name":"library","optional":false,"visibility":"public","description":"The library of the application
","typeInfo":{"template":"string"}},{"name":"version","optional":false,"visibility":"public","description":"The version of the application
","typeInfo":{"template":"string"}},{"name":"fullWidth","optional":false,"visibility":"public","description":"A Boolean value indicating if the application fills the full width of the screen
","typeInfo":{"template":"boolean"}}],"displayName":"sap.ushell.services.AppConfiguration.Metadata","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.AppConfiguration.Metadata","subTitle":""},{"kind":"class","name":"sap.ushell.services.AppLifeCycle","basename":"AppLifeCycle","resource":"sap/ushell/services/AppLifeCycle.js","module":"sap/ushell/services/AppLifeCycle","export":"","static":true,"visibility":"public","since":"1.38","extends":"sap.ushell.services.Service","description":"The Unified Shell's AppLifeCycle service.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const AppLifeCycle = await Container.getServiceAsync(\"AppLifeCycle\");\n // do something with the AppLifeCycle service\n });\n ","hideconstructor":true,"methods":[{"name":"attachAppLoaded","visibility":"public","since":"1.38","typeParameters":[{"name":"ObjectToBePassedToHandler","type":"object"}],"parameters":[{"name":"oData","optional":false,"description":"
An object that will be passed to the handler along with the event object when the event is fired.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"fnFunction","optional":false,"description":"
The handler function to call when the event occurs.
","typeInfo":{"template":"function(${0},object)","UI5Types":["sap.ui.base.Event"]},"defaultValue":""},{"name":"oListener","optional":false,"description":"
The object that wants to be notified when the event occurs (this context within the handler function).
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Attaches an event handler for the appLoaded event. This event handler will be triggered each time an application has been loaded.
","href":"api/sap.ushell.services.AppLifeCycle#methods/attachAppLoaded","code":"attachAppLoaded(oData, fnFunction, oListener) : void "},{"name":"detachAppLoaded","visibility":"public","since":"1.38","parameters":[{"name":"fnFunction","optional":false,"description":"
The handler function that has to be detached from the EventProvider.
","typeInfo":{"template":"function"},"defaultValue":""},{"name":"oListener","optional":false,"description":"
The object that wanted to be notified when the event occurred
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Detaches an event handler from the EventProvider.
","href":"api/sap.ushell.services.AppLifeCycle#methods/detachAppLoaded","code":"detachAppLoaded(fnFunction, oListener) : void "},{"name":"getCurrentApplication","visibility":"public","since":"1.38","returnValue":{"type":"sap.ushell.services.AppLifeCycle.CurrentApplication|undefined","description":"Information object about currently running application or undefined if no application is running. Note: Return value is only valid after app is loaded. See #attachAppLoaded for details. Before an app is loaded, undefined is returned.
","typeInfo":{"template":"${0} | undefined","UI5Types":["sap.ushell.services.AppLifeCycle.CurrentApplication"]}},"description":"Returns information about the currently running application or undefined if no application is running.
","href":"api/sap.ushell.services.AppLifeCycle#methods/getCurrentApplication","code":"getCurrentApplication() : sap.ushell.services.AppLifeCycle.CurrentApplication|undefined "},{"name":"reloadCurrentApp","visibility":"restricted","allowedFor":["sap.ui.rta"],"since":"1.84","description":"Reloads the currently displayed app (used by RTA plugin).
","href":"api/sap.ushell.services.AppLifeCycle#methods/reloadCurrentApp","code":"reloadCurrentApp() : void "}],"displayName":"sap.ushell.services.AppLifeCycle","nodes":[{"name":"sap.ushell.services.AppLifeCycle.AppInfo","description":"Defines the application info.
","href":"api/sap.ushell.services.AppLifeCycle.AppInfo"},{"name":"sap.ushell.services.AppLifeCycle.AppInfoParameterName","description":"Enumeration of application info parameter names.
","href":"api/sap.ushell.services.AppLifeCycle.AppInfoParameterName"},{"name":"sap.ushell.services.AppLifeCycle.ApplicationType","description":"Enumeration of application types.
","href":"api/sap.ushell.services.AppLifeCycle.ApplicationType"},{"name":"sap.ushell.services.AppLifeCycle.CurrentApplication","description":"Defines the current application.
","href":"api/sap.ushell.services.AppLifeCycle.CurrentApplication"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.AppLifeCycle","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.AppLifeCycle.AppInfo","basename":"AppInfo","resource":"sap/ushell/services/AppLifeCycle/CurrentApplication.js","module":"sap/ushell/services/AppLifeCycle/CurrentApplication","static":true,"visibility":"public","since":"1.120.0","description":"
Defines the application info. Key-value pairs of application info parameters and their values.
","type":"Object","displayName":"sap.ushell.services.AppLifeCycle.AppInfo","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.AppLifeCycle.AppInfo","subTitle":""},{"kind":"enum","name":"sap.ushell.services.AppLifeCycle.AppInfoParameterName","basename":"AppInfoParameterName","resource":"sap/ushell/services/AppLifeCycle/AppInfoParameterName.js","module":"sap/ushell/services/AppLifeCycle/AppInfoParameterName","export":"","static":true,"visibility":"public","since":"1.120.0","description":"
Enumeration of application info parameter names.
","ui5-metadata":{"stereotype":"enum"},"properties":[{"name":"sap.ushell.services.AppLifeCycle.AppInfoParameterName.appFrameworkId","visibility":"public","description":"ID of the framework
"},{"name":"sap.ushell.services.AppLifeCycle.AppInfoParameterName.appFrameworkVersion","visibility":"public","description":"Version of the framework
"},{"name":"sap.ushell.services.AppLifeCycle.AppInfoParameterName.appId","visibility":"public","description":"Universal stable logical identifier of the application across the whole content.
"},{"name":"sap.ushell.services.AppLifeCycle.AppInfoParameterName.appIntent","visibility":"public","description":"Intent that was used to launch the application (including parameters)
"},{"name":"sap.ushell.services.AppLifeCycle.AppInfoParameterName.appSupportInfo","visibility":"public","description":"The name of an organizational component that handles support incidents.
"},{"name":"sap.ushell.services.AppLifeCycle.AppInfoParameterName.appVersion","visibility":"public","description":"Version of the app
"},{"name":"sap.ushell.services.AppLifeCycle.AppInfoParameterName.languageTag","visibility":"public","description":"Current Language (BCP47 format)
"},{"name":"sap.ushell.services.AppLifeCycle.AppInfoParameterName.productName","visibility":"public","description":"A human readable free form text maintained on the platform where FLP runs, and identifying the current product.
"},{"name":"sap.ushell.services.AppLifeCycle.AppInfoParameterName.technicalAppComponentId","visibility":"public","description":"Identifier of the component that implements the base application.
"},{"name":"sap.ushell.services.AppLifeCycle.AppInfoParameterName.theme","visibility":"public","description":"Current FLP theme. Includes the path to the theme resources if the theme is not an sap theme (does not start with sap_)
"},{"name":"sap.ushell.services.AppLifeCycle.AppInfoParameterName.transaction","visibility":"public","description":"The transaction code which not always available and therefore can be undefined.
"}],"displayName":"sap.ushell.services.AppLifeCycle.AppInfoParameterName","component":"CA-FLP-FE-UI","hasSample":false,"title":"enum sap.ushell.services.AppLifeCycle.AppInfoParameterName","subTitle":""},{"kind":"enum","name":"sap.ushell.services.AppLifeCycle.ApplicationType","basename":"ApplicationType","resource":"sap/ushell/services/AppLifeCycle/ApplicationType.js","module":"sap/ushell/services/AppLifeCycle/ApplicationType","export":"","static":true,"visibility":"public","since":"1.120.0","description":"
Enumeration of application types.
","ui5-metadata":{"stereotype":"enum"},"properties":[{"name":"sap.ushell.services.AppLifeCycle.ApplicationType.NWBC","visibility":"public","description":"The application is starting using the SAP Business Client.
"},{"name":"sap.ushell.services.AppLifeCycle.ApplicationType.TR","visibility":"public","description":"The application is started using a transaction
"},{"name":"sap.ushell.services.AppLifeCycle.ApplicationType.UI5","visibility":"public","description":"The application is a UI5 application.
"},{"name":"sap.ushell.services.AppLifeCycle.ApplicationType.URL","visibility":"public","description":"The application is started using a URL
"},{"name":"sap.ushell.services.AppLifeCycle.ApplicationType.WDA","visibility":"public","description":"The application is a Webdynpro application.
"}],"displayName":"sap.ushell.services.AppLifeCycle.ApplicationType","component":"CA-FLP-FE-UI","hasSample":false,"title":"enum sap.ushell.services.AppLifeCycle.ApplicationType","subTitle":""},{"kind":"class","name":"sap.ushell.services.AppLifeCycle.CurrentApplication","basename":"CurrentApplication","resource":"sap/ushell/services/AppLifeCycle/CurrentApplication.js","module":"sap/ushell/services/AppLifeCycle/CurrentApplication","export":"","static":true,"visibility":"public","since":"1.120.0","description":"Defines the current application. This object is only valid until the next application navigation. Fetch it again from the AppLifeCycle service in the appLoaded event.
","hideconstructor":true,"properties":[{"name":"applicationType","visibility":"public","since":"1.120.0","description":"The type of the current application.
","typeInfo":{"UI5Types":["sap.ushell.services.AppLifeCycle.ApplicationType"]}},{"name":"componentInstance","visibility":"public","since":"1.120.0","description":"Reference to component. Only available for applicationType \"UI5\"
","typeInfo":{"template":"${0} | null","UI5Types":["sap.ui.core.Component"]}},{"name":"homePage","visibility":"public","since":"1.120.0","description":"true when root intent (normally #Shell-home) or Appfinder (#Shell-appfinder) is currently displayed.
","typeInfo":{"template":"boolean"}}],"methods":[{"name":"disableKeepAliveAppRouterRetrigger","visibility":"restricted","allowedFor":["sap.fe"],"since":"1.98","parameters":[{"name":"bDisableRouterRetrigger","optional":false,"description":"
A flag to disable or enable the router's re-trigger when a keep-alive application is restored
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Emits an event when disableKeepAliveAppRouterRetrigger API is called This API should be used only by Fiori Elements team
","href":"api/sap.ushell.services.AppLifeCycle.CurrentApplication#methods/disableKeepAliveAppRouterRetrigger","code":"disableKeepAliveAppRouterRetrigger(bDisableRouterRetrigger) : void "},{"name":"getInfo","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves to an object keeping the application info parameters with values
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.AppLifeCycle.AppInfo"]}},"parameters":[{"name":"aParameterNames","optional":false,"description":"
Array of requested parameters
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.services.AppLifeCycle.AppInfoParameterName"]},"defaultValue":""}],"description":"A function to collect the values of the given parameters
","href":"api/sap.ushell.services.AppLifeCycle.CurrentApplication#methods/getInfo","code":"getInfo(aParameterNames) : Promise "},{"name":"getIntent","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"A promise that resolves with the intent of the current application
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.URLParsing.DecomposedHash"]}},"parameters":[{"name":"bRealAppIntent","optional":false,"description":"
If set to true, the intent is extracted from the real application URL in case of a remote app
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"See sap.ushell.services.URLParsing#parseShellHash for details. This method is for SAP-internal use only!
","href":"api/sap.ushell.services.AppLifeCycle.CurrentApplication#methods/getIntent","code":"getIntent(bRealAppIntent) : Promise "},{"name":"getTechnicalParameter","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"A promise that resolves with the value of the technical parameter
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sParameterName","optional":false,"description":"
The name of the technical parameter
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"function that returns the value of a technical parameter for the given application. This method is for SAP internal usage only.
","href":"api/sap.ushell.services.AppLifeCycle.CurrentApplication#methods/getTechnicalParameter","code":"getTechnicalParameter(sParameterName) : Promise "}],"displayName":"sap.ushell.services.AppLifeCycle.CurrentApplication","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.AppLifeCycle.CurrentApplication","subTitle":""},{"kind":"class","name":"sap.ushell.services.Bookmark","basename":"Bookmark","resource":"sap/ushell/services/Bookmark.js","module":"sap/ushell/services/Bookmark","export":"","static":true,"visibility":"public","since":"1.15.0","extends":"sap.ushell.services.Service","description":"The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const Bookmark = await Container.getServiceAsync(\"Bookmark\");\n // do something with the Bookmark service\n });\n ","hideconstructor":true,"methods":[{"name":"addBookmark","visibility":"public","since":"1.15.0","returnValue":{"type":"jQuery.Promise","description":"Resolves on success, but rejects with a reason-message on failure to add the bookmark to the specified or implied group. The promise gets resolved if personalization is disabled.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oParameters","optional":false,"description":"
Bookmark parameters. In addition to title and URL, a bookmark might allow further settings, such as an icon or a subtitle. Which settings are supported depends on the environment in which the application is running. Unsupported parameters will be ignored.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"title","optional":false,"description":"
The title of the bookmark.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.title","defaultValue":""},{"name":"url","optional":false,"description":"
The target intent or URL of the bookmark. If the target app runs in the current shell, the URL has to be a valid intent, i.e. in the format \"#SO-Action?P1=a&P2=x&/route?RPV=1\".
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.url","defaultValue":""},{"name":"icon","optional":true,"description":"
The optional icon URL of the bookmark (e.g. \"sap-icon://home\").
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.icon","defaultValue":""},{"name":"info","optional":true,"description":"
The information text of the bookmark.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.info","defaultValue":""},{"name":"subtitle","optional":true,"description":"
The subtitle of the bookmark.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.subtitle","defaultValue":""},{"name":"serviceUrl","optional":true,"description":"
The URL to a REST or OData service that provides some dynamic information for the bookmark.
Semantic Date Ranges:
You can use placeholders for dynamic dates in the query parameters of the service URL. This can be used to create KPI tiles based on user entries in control sap.m.DynamicDateRange , where it is possible to specify dynamic dates like YESTERDAY or THISYEAR.
The placeholder format looks like this: {Edm.<type>%%DynamicDate.<operator>.<value1>.<value2>.<position>%%}
<type>: The Edm Type of the parameter. Supported types are String, DateTime and DateTimeOffset for OData V2 and Date and DateTimeOffset for OData V4. <operator>, <value1>, <value2>: Possible values are the ones that can be used in sap.m.DynamicDateRange#toDates to create a date range. <position>: Possible values are 'start' and 'end' which mark the start or end of the interval specified by the operator. Examples:
/a/url/$count?$filter=(testDate ge {Edm.DateTimeOffset%DynamicDate.YESTERDAY.start%} and testDate le {Edm.DateTimeOffset%DynamicDate.YESTERDAY.end%}) /a/url/$count?$filter=(testDate ge {Edm.DateTime%DynamicDate.THISYEAR.start%} and testDate le {Edm.DateTime%DynamicDate.THISYEAR.end%}) /a/url/$count?$filter=(testDate ge {Edm.Date%DynamicDate.TODAYFROMTO.1.5.start%} and testDate le {Edm.Date%DynamicDate.TODAYFROMTO.1.5.end%}) Hint: Check the debug log when displaying the resulting KPI tiles to get more information about the resolution of the placeholders.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.serviceUrl","defaultValue":""},{"name":"dataSource","optional":true,"description":"
Metadata for parameter serviceUrl. Mandatory to specify if parameter serviceURL contains semantic date ranges. This does not influence the data source of the app itself.
Specify the data source as follows:
\n {\n type: \"OData\",\n settings: {\n odataVersion: \"4.0\"\n }\n }\n
type: The type of the serviceURL's service. Only \"OData\" is supported. odataVersion: The OData version of parameter serviceURL. Valid values are \"2.0\" and \"4.0\". ","depth":1,"typeInfo":{"template":"object"},"phoneName":"oParameters.dataSource","defaultValue":""},{"name":"serviceRefreshInterval","optional":true,"description":"
The refresh interval for the serviceUrl in seconds.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.serviceRefreshInterval","defaultValue":""},{"name":"numberUnit","optional":true,"description":"
The unit for the number retrieved from serviceUrl.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.numberUnit","defaultValue":""},{"name":"vContainer","optional":true,"description":"
Either a legacy launchpad home page group, one content node or an array of content nodes (see #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.
","typeInfo":{"template":"object | ${0} | Array<${1}>","UI5Types":["sap.ushell.services.Bookmark.ContentNode","sap.ushell.services.Bookmark.ContentNode"]},"defaultValue":""},{"name":"sContentProviderId","optional":true,"description":"
The contentProviderId or undefined outside the cFLP
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Adds a bookmark tile to one of the user's classic home page groups or to multiple provided content nodes.
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.BookmarkV2#addBookmark} instead."},"references":["{@link sap.ushell.services.URLParsing#getShellHash} "],"href":"api/sap.ushell.services.Bookmark#methods/addBookmark","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.BookmarkV2#addBookmark instead.","code":"addBookmark(oParameters, vContainer?, sContentProviderId?) : jQuery.Promise "},{"name":"addCatalogTileToGroup","visibility":"public","since":"1.21.2","returnValue":{"type":"jQuery.Promise","description":"Resolves if successful. In case of failure, an error message is passed. In launchpad spaces mode the promise gets rejected.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sCatalogTileId","optional":false,"description":"
The ID of the tile within the catalog
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sGroupId","optional":true,"description":"
The id of the group. If not given, the tile is added to the default group
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oCatalogData","optional":true,"description":"
The data to identify the catalog containing the tile with the given ID
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"baseUrl","optional":false,"description":"
The remote catalog's base URL such as \"/sap/hba/apps/kpi/s/odata/hana_chip_catalog.xsodata/\"
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oCatalogData.baseUrl","defaultValue":""},{"name":"remoteId","optional":false,"description":"
The remote catalog's id on the remote system such as \"HANA_CATALOG\"
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oCatalogData.remoteId","defaultValue":""}],"description":"Adds the catalog tile with the given ID to given group. The catalog tile is looked up in the legacy SAP HANA catalog unless data to look up a remote catalog is provided.
","deprecated":{"since":"1.112","text":"Please use {@link sap.ushell.services.BookmarkV2#addBookmark} instead."},"href":"api/sap.ushell.services.Bookmark#methods/addCatalogTileToGroup","deprecatedText":"Deprecated as of version 1.112. Please use sap.ushell.services.BookmarkV2#addBookmark instead.","code":"addCatalogTileToGroup(sCatalogTileId, sGroupId?, oCatalogData?) : jQuery.Promise "},{"name":"addCustomBookmark","visibility":"restricted","allowedFor":["ssuite.smartbusiness"],"since":"1.81","returnValue":{"type":"Promise<(undefined|string)>","description":"A promise which resolves on success, but rejects with a reason-message if the bookmark couldn't be created.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sVizType","optional":false,"description":"
Specifies what tile should be created, for example \"ssuite.smartbusiness.abap.tiles.contribution\"
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oConfig","optional":false,"description":"
Viz type specific configuration including all parameters the visualization needs.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"title","optional":false,"description":"
Title of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.title","defaultValue":""},{"name":"url","optional":false,"description":"
The URL of the bookmark. If the target application shall run in the Shell, the URL has to be in the format \"#SemanticObject-Action?P1=a&P2=x&/route?RPV=1\".
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.url","defaultValue":""},{"name":"subtitle","optional":true,"description":"
Subtitle of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.subtitle","defaultValue":""},{"name":"icon","optional":true,"description":"
Icon of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.icon","defaultValue":""},{"name":"info","optional":true,"description":"
Icon of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.info","defaultValue":""},{"name":"vizConfig","optional":false,"description":"
Can include any app descriptor (manifest.json) namespace the visualization needs. For example sap.app/datasources.
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oConfig.vizConfig","defaultValue":""},{"name":"loadManifest","optional":true,"defaultValue":false,"description":"
false: viz config (merged with viz type) represents the full manifest which is injected into UI5 and replaces the manifest of the viz type's component. The latter is not loaded at all. true: (experimental) Manifest of viz type's component is loaded, oConfig.vizConfig is NOT merged with the component. In future both may be merged!
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"oConfig.loadManifest"},{"name":"chipConfig","optional":true,"description":"
Simplified UI2 CHIP (runtime) model allowing for creation for tiles based on the ABAP stack. This can be considered as a compatibility feature. Will end-up in vizConfig/sap.flp/chipConfig.
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oConfig.chipConfig","defaultValue":""},{"name":"chipId","optional":true,"description":"
Specifies what chip is going to be instantiated on the ABAP stack. The chipId is mandatory when used in a FLP running on ABAP.
","depth":2,"typeInfo":{"template":"string"},"phoneName":"oConfig.chipConfig.chipId","defaultValue":""},{"name":"bags","optional":true,"description":"
Simplified model of UI2 bags
","depth":2,"typeInfo":{"template":"object"},"phoneName":"oConfig.chipConfig.bags","defaultValue":""},{"name":"configuration","optional":true,"description":"
UI2 configuration parameters
","depth":2,"typeInfo":{"template":"object"},"phoneName":"oConfig.chipConfig.configuration","defaultValue":""},{"name":"vContentNodes","optional":false,"description":"
Either an array of ContentNodes or a single ContentNode in which the Bookmark will be placed.
","typeInfo":{"template":"${0} | Array<${1}>","UI5Types":["sap.ushell.services.Bookmark.ContentNode","sap.ushell.services.Bookmark.ContentNode"]},"defaultValue":""},{"name":"sContentProviderId","optional":true,"description":"
The contentProviderId or undefined outside the cFLP
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Adds a custom bookmark visualization to one or multiple provided content nodes.
","href":"api/sap.ushell.services.Bookmark#methods/addCustomBookmark","code":"addCustomBookmark(sVizType, oConfig, vContentNodes, sContentProviderId?) : Promise<(undefined|string)> "},{"name":"countBookmarks","visibility":"public","since":"1.17.1","returnValue":{"type":"jQuery.Promise","description":"Resolves the count of existing bookmarks is provided (which might be zero). In case of failure, an error message is passed.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sUrl","optional":false,"description":"
The URL of the bookmarks to be counted, exactly as specified to #addBookmark .
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sContentProviderId","optional":false,"description":"
The Content Provider ID.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Counts all bookmarks pointing to the given URL from all of the user's pages. You can use this method to check if a bookmark already exists.
This is a potentially asynchronous operation in case the user's pages have not yet been loaded completely!
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.BookmarkV2#countBookmarks} instead."},"references":["{@link #addBookmark} "],"href":"api/sap.ushell.services.Bookmark#methods/countBookmarks","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.BookmarkV2#countBookmarks instead.","code":"countBookmarks(sUrl, sContentProviderId) : jQuery.Promise "},{"name":"countCustomBookmarks","visibility":"restricted","allowedFor":["ssuite.smartbusiness"],"since":"1.83.0","returnValue":{"type":"Promise","description":"The count of bookmarks matching the identifier.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oIdentifier","optional":false,"description":"
An object which is used to find the bookmarks by matching the provided properties.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"url","optional":false,"description":"
The URL which was used to create the bookmark using #addCustomBookmark .
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.url","defaultValue":""},{"name":"vizType","optional":false,"description":"
The visualization type (viz type) which was used to create the bookmark using #addCustomBookmark . The viz type is only used by the FLP running on CDM.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.vizType","defaultValue":""},{"name":"chipId","optional":true,"description":"
The chipId which was used to create the bookmark using #addCustomBookmark . The chipId is mandatory when used in a FLP running on ABAP.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.chipId","defaultValue":""}],"description":"Counts all custom bookmarks matching exactly the identification data. Can be used to check if a bookmark already exists (e.g. before updating).
","references":["{@link #addCustomBookmark} "],"href":"api/sap.ushell.services.Bookmark#methods/countCustomBookmarks","code":"countCustomBookmarks(oIdentifier) : Promise "},{"name":"deleteBookmarks","visibility":"public","since":"1.17.1","returnValue":{"type":"jQuery.Promise","description":"Resolves the number of deleted bookmarks is provided (which might be zero). In case of failure, an error message is passed.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sUrl","optional":false,"description":"
The URL of the bookmarks to be deleted, exactly as specified to #addBookmark .
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sContentProviderId","optional":true,"description":"
The contentProviderId or undefined outside the cFLP
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Deletes all bookmarks pointing to the given URL from all of the user's pages.
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.BookmarkV2#deleteBookmarks} instead."},"references":["{@link #addBookmark} ","{@link #countBookmarks} "],"href":"api/sap.ushell.services.Bookmark#methods/deleteBookmarks","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.BookmarkV2#deleteBookmarks instead.","code":"deleteBookmarks(sUrl, sContentProviderId?) : jQuery.Promise "},{"name":"deleteCustomBookmarks","visibility":"restricted","allowedFor":["ssuite.smartbusiness"],"since":"1.83.0","returnValue":{"type":"Promise","description":"The count of bookmarks which were deleted.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oIdentifier","optional":false,"description":"
An object which is used to find the bookmarks by matching the provided properties.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"url","optional":false,"description":"
The URL which was used to create the bookmark using #addCustomBookmark .
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.url","defaultValue":""},{"name":"vizType","optional":false,"description":"
The visualization type (viz type) which was used to create the bookmark using #addCustomBookmark .
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.vizType","defaultValue":""},{"name":"chipId","optional":true,"description":"
The chipId which was used to create the bookmark using #addCustomBookmark . The chipId is mandatory when used in a FLP running on ABAP.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.chipId","defaultValue":""}],"description":"Deletes all custom bookmarks matching exactly the identification data. #countCustomBookmarks can be used to check upfront how many bookmarks are going to be affected.
","references":["{@link #addCustomBookmark} ","{@link #countCustomBookmarks} "],"href":"api/sap.ushell.services.Bookmark#methods/deleteCustomBookmarks","code":"deleteCustomBookmarks(oIdentifier) : Promise "},{"name":"getContentNodes","visibility":"public","since":"1.81","returnValue":{"type":"Promise","description":"Promise resolving the currently available content nodes.
","typeInfo":{"template":"Promise>","UI5Types":["sap.ushell.services.Bookmark.ContentNode"]}},"description":"Returns available content nodes based on the current launchpad context. (Classic home page, spaces mode)
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 It has the following properties:
id: ID of the content node label: Human-readable representation of a content node which can be displayed in a control type: Specifies the content node type. E.g: space, page, group, etc. See sap.ushell.ContentNodeType isContainer: Specifies if a bookmark can be added children: Specifies sub-nodes ","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.BookmarkV2#getContentNodes} instead."},"href":"api/sap.ushell.services.Bookmark#methods/getContentNodes","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.BookmarkV2#getContentNodes instead.","code":" getContentNodes() : Promise "},{"name":"updateBookmarks","visibility":"public","since":"1.17.1","returnValue":{"type":"jQuery.Promise","description":"Resolves the number of updated bookmarks is provided (which might be zero). In case of failure, an error message is passed.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sUrl","optional":false,"description":"
The URL of the bookmarks to be updated, exactly as specified to #addBookmark . In case you need to update the URL itself, pass the old one here and the new one as oParameters.url!
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oParameters","optional":false,"description":"
Bookmark parameters. In addition to title and URL, a bookmark might allow additional settings, such as an icon or a subtitle. Which settings are supported depends on the environment in which the application is running. Unsupported parameters will be ignored.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"title","optional":false,"description":"
The title of the bookmark.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.title","defaultValue":""},{"name":"url","optional":false,"description":"
The target URL or intent of the bookmark. If the target application shall run in the current shell, the URL has to be a valid intent, i.e. in the format like \"#SO-Action?P1=a&P2=x&/route?RPV=1\".
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.url","defaultValue":""},{"name":"icon","optional":true,"description":"
The optional icon URL of the bookmark (e.g. \"sap-icon://home\").
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.icon","defaultValue":""},{"name":"info","optional":true,"description":"
The information text of the bookmark.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.info","defaultValue":""},{"name":"subtitle","optional":true,"description":"
The subtitle of the bookmark.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.subtitle","defaultValue":""},{"name":"serviceUrl","optional":true,"description":"
The URL to a REST or OData service that provides some dynamic information for the bookmark.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.serviceUrl","defaultValue":""},{"name":"dataSource","optional":true,"description":"
Metadata for parameter serviceUrl. Mandatory to specify if parameter serviceURL contains semantic date ranges. This does not influence the data source of the app itself.
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oParameters.dataSource","defaultValue":""},{"name":"type","optional":true,"description":"
The type of the serviceURL's service. Only \"OData\" is supported.
","depth":2,"typeInfo":{"template":"string"},"phoneName":"oParameters.dataSource.type","defaultValue":""},{"name":"settings","optional":true,"description":"
Additional settings for the data source.
","depth":2,"typeInfo":{"template":"object"},"phoneName":"oParameters.dataSource.settings","defaultValue":""},{"name":"odataVersion","optional":true,"description":"
The OData version of parameter serviceURL. Valid values are \"2.0\" and \"4.0\".
","depth":3,"typeInfo":{"template":"object"},"phoneName":"oParameters.dataSource.settings.odataVersion","defaultValue":""},{"name":"serviceRefreshInterval","optional":true,"description":"
The refresh interval for the serviceUrl in seconds.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.serviceRefreshInterval","defaultValue":""},{"name":"numberUnit","optional":true,"description":"
The unit for the number retrieved from serviceUrl.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oParameters.numberUnit","defaultValue":""},{"name":"sContentProviderId","optional":true,"description":"
The contentProviderId or undefined outside the cFLP
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Updates all bookmarks pointing to the given URL on all of the user's pages with the given new parameters. Parameters which are omitted are not changed in the existing bookmarks.
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.BookmarkV2#updateBookmarks} instead."},"references":["{@link #addBookmark} ","{@link #countBookmarks} ","{@link #deleteBookmarks} "],"href":"api/sap.ushell.services.Bookmark#methods/updateBookmarks","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.BookmarkV2#updateBookmarks instead.","code":"updateBookmarks(sUrl, oParameters, sContentProviderId?) : jQuery.Promise "},{"name":"updateCustomBookmarks","visibility":"restricted","allowedFor":["ssuite.smartbusiness"],"since":"1.83.0","returnValue":{"type":"Promise","description":"The count of bookmarks which were updated.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oIdentifier","optional":false,"description":"
An object which is used to find the bookmarks by matching the provided properties.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"url","optional":false,"description":"
The URL which was used to create the bookmark using #addCustomBookmark .
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.url","defaultValue":""},{"name":"vizType","optional":false,"description":"
The visualization type (viz type) which was used to create the bookmark using #addCustomBookmark .
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.vizType","defaultValue":""},{"name":"chipId","optional":true,"description":"
The chipId which was used to create the bookmark using #addCustomBookmark . The chipId is mandatory when used in a FLP running on ABAP.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.chipId","defaultValue":""},{"name":"oConfig","optional":false,"description":"
Viz type specific configuration including all parameters the visualization needs.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"title","optional":false,"description":"
Title of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.title","defaultValue":""},{"name":"url","optional":false,"description":"
The URL of the bookmark. If the target application shall run in the Shell, the URL has to be in the format \"#SemanticObject-Action?P1=a&P2=x&/route?RPV=1\".
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.url","defaultValue":""},{"name":"subtitle","optional":true,"description":"
Subtitle of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.subtitle","defaultValue":""},{"name":"icon","optional":true,"description":"
Icon of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.icon","defaultValue":""},{"name":"info","optional":true,"description":"
Icon of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.info","defaultValue":""},{"name":"vizConfig","optional":false,"description":"
Can include any app descriptor (manifest.json) namespace the visualization needs. For example sap.app/datasources.
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oConfig.vizConfig","defaultValue":""},{"name":"loadManifest","optional":true,"defaultValue":false,"description":"
false: viz config (merged with viz type) represents the full manifest which is injected into UI5 and replaces the manifest of the viz type's component. The latter is not loaded at all. true: (experimental) Manifest of viz type's component is loaded, oConfig.vizConfig is NOT merged with the component. In future both may be merged!
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"oConfig.loadManifest"},{"name":"chipConfig","optional":true,"description":"
Simplified UI2 CHIP (runtime) model allowing for creation for tiles based on the ABAP stack. This can be considered as a compatibility feature. Will end-up in vizConfig/sap.flp/chipConfig. In case of errors during the update there are no rollbacks happening. This might lead to corrupt bookmarks.
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oConfig.chipConfig","defaultValue":""},{"name":"bags","optional":true,"description":"
Simplified model of UI2 bags
","depth":2,"typeInfo":{"template":"object"},"phoneName":"oConfig.chipConfig.bags","defaultValue":""},{"name":"configuration","optional":true,"description":"
UI2 configuration parameters
","depth":2,"typeInfo":{"template":"object"},"phoneName":"oConfig.chipConfig.configuration","defaultValue":""}],"description":"Updates all custom bookmarks matching exactly the identification data. Only given properties are updated. #countCustomBookmarks can be used to check upfront how many bookmarks are going to be affected. The vizType as well as the chipId of the bookmarks cannot be changed!
","references":["{@link #addCustomBookmark} ","{@link #countCustomBookmarks} "],"href":"api/sap.ushell.services.Bookmark#methods/updateCustomBookmarks","code":"updateCustomBookmarks(oIdentifier, oConfig) : Promise "}],"displayName":"sap.ushell.services.Bookmark","nodes":[{"name":"sap.ushell.services.Bookmark.ContentNode","description":"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
","href":"api/sap.ushell.services.Bookmark.ContentNode","deprecated":true}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Bookmark","subTitle":"Deprecated in version: 1.119","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.BookmarkV2 instead."},{"kind":"typedef","name":"sap.ushell.services.Bookmark.ContentNode","basename":"ContentNode","resource":"sap/ushell/services/Bookmark.js","module":"sap/ushell/services/Bookmark","static":true,"visibility":"public","description":"
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
","properties":[{"name":"id","optional":false,"visibility":"public","description":"ID of the content node
","typeInfo":{"template":"string"}},{"name":"label","optional":false,"visibility":"public","description":"Human-readable representation of a content node which can be displayed in a control
","typeInfo":{"template":"string"}},{"name":"type","optional":false,"visibility":"public","description":"Specifies the content node type. E.g: space, page, group, etc. See sap.ushell.sap.ushell.services.Bookmark.ContentNodeType
","typeInfo":{"UI5Types":["sap.ushell.ContentNodeType"]}},{"name":"isContainer","optional":false,"visibility":"public","description":"Specifies if a bookmark can be added
","typeInfo":{"template":"boolean"}},{"name":"children","optional":true,"visibility":"public","description":"Specifies sub-nodes
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.services.Bookmark.ContentNode"]}}],"displayName":"sap.ushell.services.Bookmark.ContentNode","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.Bookmark.ContentNode","subTitle":"Deprecated in version: 1.119","deprecatedText":"Deprecated as of version 1.119. because it is part of the deprecated package sap.ushell.services.Bookmark"},{"kind":"class","name":"sap.ushell.services.BookmarkV2","basename":"BookmarkV2","resource":"sap/ushell/services/BookmarkV2.js","module":"sap/ushell/services/BookmarkV2","export":"","static":true,"visibility":"public","since":"1.119.0","extends":"sap.ushell.services.Service","description":"The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const BookmarkV2 = await Container.getServiceAsync(\"BookmarkV2\");\n // do something with the BookmarkV2 service\n });\n ","hideconstructor":true,"methods":[{"name":"addBookmark","visibility":"public","since":"1.119.0","returnValue":{"type":"Promise","description":"A promise which resolves on success
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oParameters","optional":false,"description":"
Bookmark parameters. In addition to title and URL, a bookmark might allow further settings, such as an icon or a subtitle. Which settings are supported depends on the environment in which the application is running. Unsupported parameters will be ignored.
","typeInfo":{"UI5Types":["sap.ushell.services.BookmarkV2.BookmarkParameters"],"refersToTypedef":true},"defaultValue":""},{"name":"vContainer","optional":true,"description":"
Either a content node or an array of content nodes (see #getContentNodes ). If not provided, the bookmark will be added to the default page.
","typeInfo":{"template":"${0} | Array<${1}>","UI5Types":["sap.ushell.services.BookmarkV2.ContentNode","sap.ushell.services.BookmarkV2.ContentNode"]},"defaultValue":""},{"name":"sContentProviderId","optional":true,"description":"
SAP internal usage only The contentProviderId or undefined outside the cFLP.
","typeInfo":{"template":"string"},"defaultValue":""}],"throws":[{"type":"Error","description":"rejects 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.
","linkEnabled":false}],"description":"Adds a bookmark tile to the provided content nodes.
","references":["{@link sap.ushell.services.URLParsing#getShellHash} "],"href":"api/sap.ushell.services.BookmarkV2#methods/addBookmark","code":"addBookmark(oParameters, vContainer?, sContentProviderId?) : Promise "},{"name":"addCustomBookmark","visibility":"restricted","allowedFor":["ssuite.smartbusiness"],"since":"1.119.0","returnValue":{"type":"Promise","description":"A promise which resolves on success, but rejects with a reason-message if the bookmark couldn't be created.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sVizType","optional":false,"description":"
Specifies what tile should be created, for example \"ssuite.smartbusiness.abap.tiles.contribution\"
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oConfig","optional":false,"description":"
Viz type specific configuration including all parameters the visualization needs.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"title","optional":false,"description":"
Title of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.title","defaultValue":""},{"name":"url","optional":false,"description":"
The URL of the bookmark. If the target application shall run in the Shell, the URL has to be in the format \"#SemanticObject-Action?P1=a&P2=x&/route?RPV=1\".
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.url","defaultValue":""},{"name":"subtitle","optional":true,"description":"
Subtitle of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.subtitle","defaultValue":""},{"name":"icon","optional":true,"description":"
Icon of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.icon","defaultValue":""},{"name":"info","optional":true,"description":"
Icon of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.info","defaultValue":""},{"name":"vizConfig","optional":false,"description":"
Can include any app descriptor (manifest.json) namespace the visualization needs. For example sap.app/datasources.
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oConfig.vizConfig","defaultValue":""},{"name":"loadManifest","optional":true,"defaultValue":false,"description":"
false: viz config (merged with viz type) represents the full manifest which is injected into UI5 and replaces the manifest of the viz type's component. The latter is not loaded at all. true: (experimental) Manifest of viz type's component is loaded, oConfig.vizConfig is NOT merged with the component. In future both may be merged!
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"oConfig.loadManifest"},{"name":"chipConfig","optional":true,"description":"
Simplified UI2 CHIP (runtime) model allowing for creation for tiles based on the ABAP stack. This can be considered as a compatibility feature. Will end-up in vizConfig/sap.flp/chipConfig.
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oConfig.chipConfig","defaultValue":""},{"name":"chipId","optional":true,"description":"
Specifies what chip is going to be instantiated on the ABAP stack. The chipId is mandatory when used in a FLP running on ABAP.
","depth":2,"typeInfo":{"template":"string"},"phoneName":"oConfig.chipConfig.chipId","defaultValue":""},{"name":"bags","optional":true,"description":"
Simplified model of UI2 bags
","depth":2,"typeInfo":{"template":"object"},"phoneName":"oConfig.chipConfig.bags","defaultValue":""},{"name":"configuration","optional":true,"description":"
UI2 configuration parameters
","depth":2,"typeInfo":{"template":"object"},"phoneName":"oConfig.chipConfig.configuration","defaultValue":""},{"name":"vContentNodes","optional":false,"description":"
Either an array of ContentNodes or a single ContentNode in which the Bookmark will be placed.
","typeInfo":{"template":"${0} | Array<${1}>","UI5Types":["sap.ushell.services.BookmarkV2.ContentNode","sap.ushell.services.BookmarkV2.ContentNode"]},"defaultValue":""},{"name":"sContentProviderId","optional":true,"description":"
SAP internal usage only The contentProviderId or undefined outside the cFLP.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Adds a custom bookmark visualization to one or multiple provided content nodes.
","href":"api/sap.ushell.services.BookmarkV2#methods/addCustomBookmark","code":"addCustomBookmark(sVizType, oConfig, vContentNodes, sContentProviderId?) : Promise "},{"name":"countBookmarks","visibility":"public","since":"1.119.0","returnValue":{"type":"Promise","description":"A Promise which informs about success or failure of this asynchronous operation. In case of success, the count of existing bookmarks is provided (which might be zero). In case of failure, an error message is passed.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sUrl","optional":false,"description":"
The URL of the bookmarks to be counted, exactly as specified to #addBookmark .
","typeInfo":{"template":"${0} | ${1}","UI5Types":["sap.ushell.services.navigation.TargetIntent","sap.ui.core.URI"]},"defaultValue":""},{"name":"sContentProviderId","optional":true,"description":"
SAP internal usage only The contentProviderId or undefined outside the cFLP. The Content Provider ID.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Counts all bookmarks pointing to the given URL from all of the user's pages. You can use this method to check if a bookmark already exists.
This is a potentially asynchronous operation in case the user's pages have not yet been loaded completely!
","references":["{@link #addBookmark} "],"href":"api/sap.ushell.services.BookmarkV2#methods/countBookmarks","code":"countBookmarks(sUrl, sContentProviderId?) : Promise "},{"name":"countCustomBookmarks","visibility":"restricted","allowedFor":["ssuite.smartbusiness"],"since":"1.119.0","returnValue":{"type":"Promise","description":"The count of bookmarks matching the identifier.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oIdentifier","optional":false,"description":"
An object which is used to find the bookmarks by matching the provided properties.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"url","optional":false,"description":"
The URL which was used to create the bookmark using #addCustomBookmark .
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.url","defaultValue":""},{"name":"vizType","optional":false,"description":"
The visualization type (viz type) which was used to create the bookmark using #addCustomBookmark . The viz type is only used by the FLP running on CDM.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.vizType","defaultValue":""},{"name":"chipId","optional":true,"description":"
The chipId which was used to create the bookmark using #addCustomBookmark . The chipId is mandatory when used in a FLP running on ABAP.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.chipId","defaultValue":""}],"description":"Counts all custom bookmarks matching exactly the identification data. Can be used to check if a bookmark already exists (e.g. before updating).
","references":["{@link #addCustomBookmark} "],"href":"api/sap.ushell.services.BookmarkV2#methods/countCustomBookmarks","code":"countCustomBookmarks(oIdentifier) : Promise "},{"name":"deleteBookmarks","visibility":"public","since":"1.119.0","returnValue":{"type":"Promise","description":"A Promise which informs about success or failure of this asynchronous operation. In case of success, the number of deleted bookmarks is provided (which might be zero). In case of failure, an error message is passed.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sUrl","optional":false,"description":"
The URL of the bookmarks to be deleted, exactly as specified to #addBookmark .
","typeInfo":{"template":"${0} | ${1}","UI5Types":["sap.ushell.services.navigation.TargetIntent","sap.ui.core.URI"]},"defaultValue":""},{"name":"sContentProviderId","optional":true,"description":"
SAP internal usage only The contentProviderId or undefined outside the cFLP.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Deletes all bookmarks pointing to the given URL from all of the user's pages.
","references":["{@link #addBookmark} ","{@link #countBookmarks} "],"href":"api/sap.ushell.services.BookmarkV2#methods/deleteBookmarks","code":"deleteBookmarks(sUrl, sContentProviderId?) : Promise "},{"name":"deleteCustomBookmarks","visibility":"restricted","allowedFor":["ssuite.smartbusiness"],"since":"1.119.0","returnValue":{"type":"Promise","description":"The count of bookmarks which were deleted.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oIdentifier","optional":false,"description":"
An object which is used to find the bookmarks by matching the provided properties.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"url","optional":false,"description":"
The URL which was used to create the bookmark using #addCustomBookmark .
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.url","defaultValue":""},{"name":"vizType","optional":false,"description":"
The visualization type (viz type) which was used to create the bookmark using #addCustomBookmark .
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.vizType","defaultValue":""},{"name":"chipId","optional":true,"description":"
The chipId which was used to create the bookmark using #addCustomBookmark . The chipId is mandatory when used in a FLP running on ABAP.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.chipId","defaultValue":""}],"description":"Deletes all custom bookmarks matching exactly the identification data. #countCustomBookmarks can be used to check upfront how many bookmarks are going to be affected.
","references":["{@link #addCustomBookmark} ","{@link #countCustomBookmarks} "],"href":"api/sap.ushell.services.BookmarkV2#methods/deleteCustomBookmarks","code":"deleteCustomBookmarks(oIdentifier) : Promise "},{"name":"getContentNodes","visibility":"public","since":"1.119.0","returnValue":{"type":"Promise","description":"Promise resolving the currently available content nodes.
","typeInfo":{"template":"Promise>","UI5Types":["sap.ushell.services.BookmarkV2.ContentNode"]}},"description":"Returns available content nodes.
","href":"api/sap.ushell.services.BookmarkV2#methods/getContentNodes","code":"getContentNodes() : Promise "},{"name":"updateBookmarks","visibility":"public","since":"1.119.0","returnValue":{"type":"Promise","description":"A Promise which informs about success or failure of this asynchronous operation. In case of success, the number of updated bookmarks is provided (which might be zero). In case of failure, an error message is passed.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sUrl","optional":false,"description":"
The URL of the bookmarks to be updated, exactly as specified to #addBookmark . In case you need to update the URL itself, pass the old one here and the new one as oParameters.url!
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oParameters","optional":false,"description":"
Bookmark parameters. In addition to title and URL, a bookmark might allow additional settings, such as an icon or a subtitle. Which settings are supported depends on the environment in which the application is running. Unsupported parameters will be ignored.
","typeInfo":{"UI5Types":["sap.ushell.services.BookmarkV2.BookmarkParameters"],"refersToTypedef":true},"defaultValue":""},{"name":"sContentProviderId","optional":true,"description":"
SAP internal usage only The contentProviderId or undefined outside the cFLP.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Updates all bookmarks pointing to the given URL on all of the user's pages with the given new parameters. Parameters which are omitted are not changed in the existing bookmarks.
","references":["{@link #addBookmark} ","{@link #countBookmarks} ","{@link #deleteBookmarks} "],"href":"api/sap.ushell.services.BookmarkV2#methods/updateBookmarks","code":"updateBookmarks(sUrl, oParameters, sContentProviderId?) : Promise "},{"name":"updateCustomBookmarks","visibility":"restricted","allowedFor":["ssuite.smartbusiness"],"since":"1.119.0","returnValue":{"type":"Promise","description":"The count of bookmarks which were updated.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oIdentifier","optional":false,"description":"
An object which is used to find the bookmarks by matching the provided properties.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"url","optional":false,"description":"
The URL which was used to create the bookmark using #addCustomBookmark .
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.url","defaultValue":""},{"name":"vizType","optional":false,"description":"
The visualization type (viz type) which was used to create the bookmark using #addCustomBookmark .
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.vizType","defaultValue":""},{"name":"chipId","optional":true,"description":"
The chipId which was used to create the bookmark using #addCustomBookmark . The chipId is mandatory when used in a FLP running on ABAP.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oIdentifier.chipId","defaultValue":""},{"name":"oConfig","optional":false,"description":"
Viz type specific configuration including all parameters the visualization needs.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"title","optional":false,"description":"
Title of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.title","defaultValue":""},{"name":"url","optional":false,"description":"
The URL of the bookmark. If the target application shall run in the Shell, the URL has to be in the format \"#SemanticObject-Action?P1=a&P2=x&/route?RPV=1\".
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.url","defaultValue":""},{"name":"subtitle","optional":true,"description":"
Subtitle of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.subtitle","defaultValue":""},{"name":"icon","optional":true,"description":"
Icon of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.icon","defaultValue":""},{"name":"info","optional":true,"description":"
Icon of the visualization.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oConfig.info","defaultValue":""},{"name":"vizConfig","optional":false,"description":"
Can include any app descriptor (manifest.json) namespace the visualization needs. For example sap.app/datasources.
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oConfig.vizConfig","defaultValue":""},{"name":"loadManifest","optional":true,"defaultValue":false,"description":"
false: viz config (merged with viz type) represents the full manifest which is injected into UI5 and replaces the manifest of the viz type's component. The latter is not loaded at all. true: (experimental) Manifest of viz type's component is loaded, oConfig.vizConfig is NOT merged with the component. In future both may be merged!
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"oConfig.loadManifest"},{"name":"chipConfig","optional":true,"description":"
Simplified UI2 CHIP (runtime) model allowing for creation for tiles based on the ABAP stack. This can be considered as a compatibility feature. Will end-up in vizConfig/sap.flp/chipConfig. In case of errors during the update there are no rollbacks happening. This might lead to corrupt bookmarks.
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oConfig.chipConfig","defaultValue":""},{"name":"bags","optional":true,"description":"
Simplified model of UI2 bags
","depth":2,"typeInfo":{"template":"object"},"phoneName":"oConfig.chipConfig.bags","defaultValue":""},{"name":"configuration","optional":true,"description":"
UI2 configuration parameters
","depth":2,"typeInfo":{"template":"object"},"phoneName":"oConfig.chipConfig.configuration","defaultValue":""}],"description":"Updates all custom bookmarks matching exactly the identification data. Only given properties are updated. #countCustomBookmarks can be used to check upfront how many bookmarks are going to be affected. The vizType as well as the chipId of the bookmarks cannot be changed!
","references":["{@link #addCustomBookmark} ","{@link #countCustomBookmarks} "],"href":"api/sap.ushell.services.BookmarkV2#methods/updateCustomBookmarks","code":"updateCustomBookmarks(oIdentifier, oConfig) : Promise "}],"displayName":"sap.ushell.services.BookmarkV2","nodes":[{"name":"sap.ushell.services.BookmarkV2.BookmarkParameters","description":"Type for data source object.
","href":"api/sap.ushell.services.BookmarkV2.BookmarkParameters"},{"name":"sap.ushell.services.BookmarkV2.ContentNode","description":"A tree of content nodes.
","href":"api/sap.ushell.services.BookmarkV2.ContentNode"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.BookmarkV2","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.BookmarkV2.BookmarkParameters","basename":"BookmarkParameters","resource":"sap/ushell/services/BookmarkV2.js","module":"sap/ushell/services/BookmarkV2","static":true,"visibility":"public","since":"1.121.0","description":"
Type for data source object. Metadata for parameter serviceUrl. Mandatory to specify if parameter serviceURL contains semantic date ranges. This does not influence the data source of the app itself.
Specify the data source as follows:
\n {\n type: \"OData\",\n settings: {\n odataVersion: \"4.0\"\n }\n }\n
type: The type of the serviceURL's service. Only \"OData\" is supported. odataVersion: The OData version of parameter serviceURL. Valid values are \"2.0\" and \"4.0\". ","properties":[{"name":"type","optional":false,"visibility":"public","description":"The type of the serviceURL's service. Only \"OData\" is supported.
","typeInfo":{"template":"string"}},{"name":"settings","optional":false,"visibility":"public","description":"The settings for the data source.
","typeInfo":{"template":"{x:any}"}},{"name":"title","optional":false,"visibility":"public","description":"The title of the bookmark.
","typeInfo":{"template":"string"}},{"name":"url","optional":false,"visibility":"public","description":"The URL of the bookmark. The target intent or URL of the bookmark. If the target app runs in the current shell, the URL has to be a valid intent, i.e. in the format \"#SO-Action?P1=a&P2=x&/route?RPV=1\".
","typeInfo":{"template":"${0} | ${1}","UI5Types":["sap.ushell.services.navigation.TargetIntent","sap.ui.core.URI"]}},{"name":"icon","optional":true,"visibility":"public","description":"The optional icon URL of the bookmark (e.g. \"sap-icon://home\").
","typeInfo":{"template":"string"}},{"name":"info","optional":true,"visibility":"public","description":"The optional information text of the bookmark.
","typeInfo":{"template":"string"}},{"name":"subtitle","optional":true,"visibility":"public","description":"The optional subtitle of the bookmark.
","typeInfo":{"template":"string"}},{"name":"serviceUrl","optional":true,"visibility":"public","description":"The URL to a REST or OData service that provides some dynamic information for the bookmark. The URL to a REST or OData service that provides some dynamic information for the bookmark.
Semantic Date Ranges:
You can use placeholders for dynamic dates in the query parameters of the service URL. This can be used to create KPI tiles based on user entries in control sap.m.DynamicDateRange , where it is possible to specify dynamic dates like YESTERDAY or THISYEAR.
The placeholder format looks like this: {Edm.<type>%%DynamicDate.<operator>.<value1>.<value2>.<position>%%}
<type>: The Edm Type of the parameter. Supported types are String, DateTime and DateTimeOffset for OData V2 and Date and DateTimeOffset for OData V4. <operator>, <value1>, <value2>: Possible values are the ones that can be used in sap.m.DynamicDateRange#toDates to create a date range. <position>: Possible values are 'start' and 'end' which mark the start or end of the interval specified by the operator. Examples:
/a/url/$count?$filter=(testDate ge {Edm.DateTimeOffset%DynamicDate.YESTERDAY.start%} and testDate le {Edm.DateTimeOffset%DynamicDate.YESTERDAY.end%}) /a/url/$count?$filter=(testDate ge {Edm.DateTime%DynamicDate.THISYEAR.start%} and testDate le {Edm.DateTime%DynamicDate.THISYEAR.end%}) /a/url/$count?$filter=(testDate ge {Edm.Date%DynamicDate.TODAYFROMTO.1.5.start%} and testDate le {Edm.Date%DynamicDate.TODAYFROMTO.1.5.end%}) Hint: Check the debug log when displaying the resulting KPI tiles to get more information about the resolution of the placeholders.
","typeInfo":{"UI5Types":["sap.ui.core.URI"]}},{"name":"dataSource","optional":true,"visibility":"public","description":"Metadata for parameter serviceUrl. Mandatory to specify if parameter serviceURL contains semantic date ranges.
","typeInfo":{"UI5Types":["sap.ushell.services.BookmarkV2.DataSource"]}},{"name":"serviceRefreshInterval","optional":true,"visibility":"public","description":"The refresh interval for the serviceUrl in seconds.
","typeInfo":{"template":"string"}},{"name":"numberUnit","optional":true,"visibility":"public","description":"The unit for the number retrieved from serviceUrl.
","typeInfo":{"template":"string"}}],"displayName":"sap.ushell.services.BookmarkV2.BookmarkParameters","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.BookmarkV2.BookmarkParameters","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.BookmarkV2.ContentNode","basename":"ContentNode","resource":"sap/ushell/services/BookmarkV2.js","module":"sap/ushell/services/BookmarkV2","static":true,"visibility":"public","since":"1.121.0","description":"
A tree of content nodes.
","properties":[{"name":"id","optional":false,"visibility":"public","description":"ID of the content node
","typeInfo":{"template":"string"}},{"name":"label","optional":false,"visibility":"public","description":"Human-readable representation of a content node which can be displayed in a control
","typeInfo":{"template":"string"}},{"name":"type","optional":false,"visibility":"public","description":"Specifies the content node type. E.g: space, page, etc.
","typeInfo":{"UI5Types":["sap.ushell.ContentNodeType"]}},{"name":"isContainer","optional":false,"visibility":"public","description":"Specifies if a bookmark can be added
","typeInfo":{"template":"boolean"}},{"name":"children","optional":true,"visibility":"public","description":"Specifies sub-nodes
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.services.BookmarkV2.ContentNode"]}}],"displayName":"sap.ushell.services.BookmarkV2.ContentNode","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.BookmarkV2.ContentNode","subTitle":""},{"kind":"class","name":"sap.ushell.services.Configuration","basename":"Configuration","resource":"sap/ushell/services/Configuration.js","module":"sap/ushell/services/Configuration","export":"","static":true,"visibility":"public","since":"1.64.0","extends":"sap.ushell.services.Service","description":"The unified shell's Configuration service. Allows attaching to selected launchpad configuration settings and their value changes.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const Configuration = await Container.getServiceAsync(\"Configuration\");\n // do something with the Configuration service\n });\n ","hideconstructor":true,"methods":[{"name":"attachSizeBehaviorUpdate","visibility":"public","returnValue":{"type":"{detach:function}","description":"detach handler - call detach() to detach from further updates
","typeInfo":{"template":"{detach:function}"}},"parameters":[{"name":"fnCallback","optional":false,"description":"
The function to be called once the property changes. It receives a parameter of type sap.m.TileSizeBehavior .
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Allows to attach to any value change of the sizeBehavior configuration for homepage parts (smaller tile size) which is needed to implement custom tiles reacting on this setting. The returned value can directly be used in sap.m.GenericTile#sizeBehavior .
Once attached, fnCallback will be called once initially for the current value and afterwards every time the value changed.
Please ensure to detach from the registry by calling .detach on the returned object e.g. in the destroy function of your component or controller! Make sure that you do not attach twice with the same function as otherwise a detach cannot be performed later!
Example usage:
\nvar oEventRegistry;\n\n// the callback that is called whenever the property changes\nvar fnCallback = function (sSizeBehavior) {\n // do something with sSizeBehavior like setting it on a\n // sap.m.GenericTile via model and data binding!\n};\n\n\n// retrieve service via getServiceAsync API\nsap.ushell.Container.getServiceAsync(\"Configuration\").then( function (oService) {\n // keep the returned event registry in order to detach upon destroy of your context\n oEventRegistry = oService.attachSizeBehaviorUpdate(fnCallback);\n});\n\n// detach later when your context is destroyed (e.g. destroy of the controller)\noEventRegistry.detach();\n ","href":"api/sap.ushell.services.Configuration#methods/attachSizeBehaviorUpdate","code":"attachSizeBehaviorUpdate(fnCallback) : {detach:function} "}],"displayName":"sap.ushell.services.Configuration","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Configuration","subTitle":""},{"kind":"namespace","name":"sap.ushell.services.ContentExtensionAdapterFactory","basename":"ContentExtensionAdapterFactory","resource":"sap/ushell/services/ContentExtensionAdapterFactory.js","module":"sap/ushell/services/ContentExtensionAdapterFactory","export":"","static":true,"visibility":"protected","since":"1.62.0","methods":[{"name":"sap.ushell.services.ContentExtensionAdapterFactory.getAdapters","visibility":"protected","static":true,"returnValue":{"type":"Promise","description":"A promise that resolves to a map of content provider names to adapter instances Note that the map might contain undefined entries if the adapters are disabled.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"vConfigs","optional":false,"description":"
A configuration array for the different adapters of ContentExtensionAdapterFactory.
","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"contentProviderName","optional":false,"description":"
The name of the adapter to find it in the service
","depth":1,"typeInfo":{"template":"string"},"phoneName":"vConfigs.contentProviderName","defaultValue":""},{"name":"adapter","optional":false,"description":"
The path to the adapter
","depth":1,"typeInfo":{"template":"string"},"phoneName":"vConfigs.adapter","defaultValue":""},{"name":"config","optional":false,"description":"
The path to the configuration flag for this adapter
","depth":1,"typeInfo":{"template":"string"},"phoneName":"vConfigs.config","defaultValue":""},{"name":"system","optional":false,"description":"
A system object for creating the system when instantiating the adapter
","depth":1,"typeInfo":{"template":"object"},"phoneName":"vConfigs.system","defaultValue":""},{"name":"configHandler","optional":false,"description":"
A function that returns any needed configuration for the adapter
","depth":1,"typeInfo":{"template":"function"},"phoneName":"vConfigs.configHandler","defaultValue":""}],"description":"Constructs a new instance of the Content Extension Adapter Factory. An array of adapter configurations needs to be passed to it (one specific adapter for each extended content). The configuration can be passed explicitly as an array vConfig or coded in ContentExtensionAdapterConfig.
Once instantiated, it generates a map of all the needed adapters and returns them (as a promise) with the method #getAdapterMap. Once the Promises resolve, the adapters are available in the map.
IMPORTANT: aConfig.contentProviderName is the string any content would use to indicate the LaunchPage service which adapter needs to be used through a field \"contentProvider\" e.g. oGroup.contentProvider
Currently, the configuration mocks the content through FeatureGroupConfig and uses the local adapter. This should be changed once a dedicated adapter for the extended content exists.
","href":"api/sap.ushell.services.ContentExtensionAdapterFactory#methods/sap.ushell.services.ContentExtensionAdapterFactory.getAdapters","code":"sap.ushell.services.ContentExtensionAdapterFactory.getAdapters(vConfigs) : Promise "}],"displayName":"sap.ushell.services.ContentExtensionAdapterFactory","component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.services.ContentExtensionAdapterFactory","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage."},{"kind":"class","name":"sap.ushell.services.CrossApplicationNavigation","basename":"CrossApplicationNavigation","resource":"sap/ushell/services/CrossApplicationNavigation.js","module":"sap/ushell/services/CrossApplicationNavigation","export":"","static":true,"visibility":"public","since":"1.15.0","extends":"sap.ushell.services.Service","description":"The Unified Shell's CrossApplicationNavigation service. Allows navigating to \"external\" targets outside of the currently running app (but still in scope of the current Fiori launchpad) or to create links to such external targets.
Note: To retrieve a valid instance of this service, it is necessary to call Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const CrossApplicationNavigation = await Container.getServiceAsync(\"CrossApplicationNavigation\");\n // do something with the CrossApplicationNavigation service\n });\n The CrossApplicationNavigation service currently provides platform independent functionality.
The service is meant to be used by applications, plugins and shell components.
Usage:
\n CrossApplicationNavigation.hrefForExternalAsync({\n target : {\n semanticObject: \"Product\",\n action: \"display\"\n },\n params: {\n \"ProductID\": \"102343333\"\n }\n }).then( function(sHref) {\n // Place sHref somewhere in the DOM\n });\n Parameter names and values are case sensitive.
Note that the usage of multi-valued parameters (specifying an array with more than one member as parameter value, e.g. params : { A : [\"a1\", \"a2\"] }) is possible with this API but strongly discouraged . Depending on the used platform / back-end implementation the target matching might not supported multi-value parameters. Furthermore, it is not guaranteed that additional parameter values specified in the back-end configuration are merged with parameter values passed in this method.
Note that the application parameter length (including SemanticObject/Action) shall not exceed 512 bytes when serialized as UTF-8.
Note that when receiving the values as startup parameters (as part of the component data object) single values are represented as an array of size 1. Above example is returned as deepEqual(getComponentData().startupParameters , { \"ProductID\" : [ \"102343333\" ] } )
Make sure not to store security critical data within an URL. URLs may appear in a server log, be persisted inside and outside the system.
Note: When constructing large URLs, the URLs may be shortened and persisted on a database server for prolonged time, the actual data is persisted under a key accessible to any User (guessing the key).
The same restrictions apply for the Application state.
","hideconstructor":true,"methods":[{"name":"_getAppStateData","visibility":"restricted","allowedFor":["SAP Internal usage only","beware! internally public","cannot be changed","but not part of the public documentation."],"since":"1.32","returnValue":{"type":"jQuery.Promise","description":"Resolves the data of an AppState object, or an empty {} javascript object if the key could not be resolved or an error occurred!
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sAppStateKey","optional":false,"description":"
the application state key, or an array, see below. SAP internal usage only.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Get data of an AppStates data given a key. A lookup for a cross user app state will be performed.
","href":"api/sap.ushell.services.CrossApplicationNavigation#methods/_getAppStateData","code":"_getAppStateData(sAppStateKey) : jQuery.Promise "},{"name":"backToPreviousApp","visibility":"public","returnValue":{"type":"Promise","description":"A promise which resolves once the back navigation was triggered
","typeInfo":{"template":"Promise"}},"description":"Attempts to use the browser history to navigate to the previous app.
A navigation to the Fiori launchpad Home is performed when this method is called on a first navigation. In all other cases, this function simply performs a browser back navigation.
Note that the behavior of this method is subject to change and therefore it may not yield to the expected results especially on mobile devices where \"back\" is the previous inner-app state if these are put into the history!
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Navigation#backToPreviousApp} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/backToPreviousApp","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Navigation#backToPreviousApp instead.","code":"backToPreviousApp() : Promise "},{"name":"createComponentData","visibility":"restricted","allowedFor":["cross.fnd.fiori.inbox (CA-INB-FIO)"],"since":"1.88.0","returnValue":{"type":"Promise","description":"Resolves the component data.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sIntent","optional":false,"description":"
Semantic object and action as a string with a \"#\" as prefix
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oConfig","optional":true,"description":"
Configuration used to instantiate the component, when given it is expected that the only property contained in this object is `componentData`. When the `componentData` is not relevant, then this method should be called with an empty object or null otherwise it throws. Note that the `componentData` member is cloned for use by this method, and the following properties are unconditionally set by this method and should not be passed in `componentData`: -- componentData.startupParameters, componentData.config, componentData[\"sap-xapp-state\"].
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Resolves a given navigation intent (if valid) and returns the respective component data only for further processing.
This method should be accessed by the Unified Inbox only.
","href":"api/sap.ushell.services.CrossApplicationNavigation#methods/createComponentData","code":"createComponentData(sIntent, oConfig?) : Promise "},{"name":"createComponentInstance","visibility":"restricted","allowedFor":["cross.fnd.fiori.inbox (CA-INB-FIO)","sap.cp.ui (MOB-UIA-CP-CLT)"],"since":"1.32.0","returnValue":{"type":"jQuery.Promise","description":"Resolves the component instance.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sIntent","optional":false,"description":"
Semantic object and action as a string with a \"#\" as prefix
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oConfig","optional":true,"description":"
Configuration used to instantiate the component, when given it is expected that the only property contained in this object is `componentData`. When the `componentData` is not relevant, then this method should be called with an empty object or null otherwise it throws. Note that the `componentData` member is cloned for use by this method, and the following properties are unconditionally set by this method and should not be passed in `componentData`: -- componentData.startupParameters, componentData.config, componentData[\"sap-xapp-state\"].
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"oOwnerComponent","optional":true,"description":"
If specified, the created component will be called within the context of the oOwnerComponent (via oOwnerComponent.runAsOwner(fn))
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Resolves a given navigation intent (if valid) and returns the respective component instance for further processing.
This method should be accessed by the Unified Inbox and Copilot only.
","href":"api/sap.ushell.services.CrossApplicationNavigation#methods/createComponentInstance","code":"createComponentInstance(sIntent, oConfig?, oOwnerComponent?) : jQuery.Promise "},{"name":"createEmptyAppState","visibility":"restricted","allowedFor":["SAP-internally public","must not be changed. Not part of public documentation."],"since":"1.28","returnValue":{"type":"object","description":"App state container
","typeInfo":{"template":"object"}},"parameters":[{"name":"oAppComponent","optional":false,"description":"
A UI5 component used as context for the app state.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bTransientEnforced","optional":false,"description":"
If set to true the appstate is not persisted on the backend. If set to false or undefined the persistency location is determined by the global ushell configuration.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"sPersistencyMethod","optional":false,"description":"
See sap/ushell/services/appstate/AppStatePersistencyMethod for possible values. Support depends on the used platform.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oPersistencySettings","optional":false,"description":"
Persistency settings.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Creates an empty app state object which acts as a parameter container for cross app navigation.
","deprecated":{"since":"1.95","text":"Please use {@link #createEmptyAppStateAsync} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/createEmptyAppState","deprecatedText":"Deprecated as of version 1.95. Please use #createEmptyAppStateAsync instead.","code":"createEmptyAppState(oAppComponent, bTransientEnforced, sPersistencyMethod, oPersistencySettings) : object "},{"name":"createEmptyAppStateAsync","visibility":"restricted","allowedFor":["SAP-internally public","must not be changed. Not part of public documentation."],"since":"1.95","returnValue":{"type":"Promise","description":"A Promise, resolving the app state container.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oAppComponent","optional":false,"description":"
A UI5 component used as context for the app state.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bTransientEnforced","optional":false,"description":"
If set to true the appstate is not persisted on the backend. If set to false or undefined the persistency location is determined by the global ushell configuration.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"sPersistencyMethod","optional":false,"description":"
See sap/ushell/services/appstate/AppStatePersistencyMethod for possible values. Support depends on the used platform.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oPersistencySettings","optional":false,"description":"
Persistency settings.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Creates an empty app state object which acts as a parameter container for cross app navigation.
","href":"api/sap.ushell.services.CrossApplicationNavigation#methods/createEmptyAppStateAsync","code":"createEmptyAppStateAsync(oAppComponent, bTransientEnforced, sPersistencyMethod, oPersistencySettings) : Promise "},{"name":"expandCompactHash","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves the expanded shell hash as first argument.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sHashFragment","optional":false,"description":"
an (internal format) shell hash
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"if sHashFragment is a compacted hash (sap-intent-param is present), in a hash, this function replaces it into a long url with all parameters expanded
","deprecated":{"since":"1.120","text":"Deprecated without successor."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/expandCompactHash","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor.","code":"expandCompactHash(sHashFragment) : jQuery.Promise "},{"name":"getAppState","visibility":"restricted","allowedFor":["SAP Internal usage only","beware! internally public","cannot be changed","but not part of the public documentation"],"since":"1.28","returnValue":{"type":"jQuery.Promise","description":"Resolves the app state object. Note that this is an unmodifiable container and its data must be copied into a writable container!
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oAppComponent","optional":false,"description":"
UI5 component, key will be extracted from component data
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"sAppStateKey","optional":false,"description":"
the application state key. SAP internal usage only.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Get an app state object given a key. A lookup for a cross user app state will be performed.
","href":"api/sap.ushell.services.CrossApplicationNavigation#methods/getAppState","code":"getAppState(oAppComponent, sAppStateKey) : jQuery.Promise "},{"name":"getDistinctSemanticObjects","visibility":"public","since":"1.38.0","returnValue":{"type":"jQuery.Promise","description":"Resolves with an array of strings representing the semantic objects of the intents the current user can navigate to, or rejects with an error message. The returned array will not contain duplicates.
NOTE: the caller should not rely on the specific order the semantic objects appear in the returned array.
","typeInfo":{"template":"jQuery.Promise"}},"description":"Returns a list of semantic objects of the intents the current user can navigate to.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Navigation#getSemanticObjects} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/getDistinctSemanticObjects","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Navigation#getSemanticObjects instead.","code":"getDistinctSemanticObjects() : jQuery.Promise "},{"name":"getLinks","visibility":"public","since":"1.38.0","returnValue":{"type":"jQuery.Promise","description":"Resolves with an array of link objects containing (at least) the following properties:
\n {\n intent: \"#AnObject-Action?A=B&C=e&C=j\",\n text: \"Perform action\",\n icon: \"sap-icon://Fiori2/F0018\", // optional\n subTitle: \"Action\", //optional\n shortTitle: \"Perform\" // optional\n tags: [\"tag-1\", \"tag-2\"] // optional\n }\n
Properties marked as 'optional' in the example above may not be present in the returned result.
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: \n externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent} }, that.oComponent);\n
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:
\n [ // mass interface was used, so return multiple values\n [ // values returned from the first call (functions may return multiple values)\n // value returned from first getLinks call (as returned by single getLinks call)\n [\n {intent: \"#SO-something1\", text: \"Perform navigation\"},\n {intent: \"#SO-something2\", text: \"Perform action\"} ],\n ]\n ],\n [\n // value returned from second getLinks call (as returned by single getLinks call)\n [\n {intent: \"#Object-someAction\", text: \"Some action1\"}\n ]\n ]\n // ... and so on\n ]\n ","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"vArgs","optional":true,"description":"
An object containing nominal arguments for the method, having the following structure:
\n {\n semanticObject: \"Object\", // optional, matches any semantic objects if undefined\n action: \"action\", // optional, matches any actions if undefined\n params: { // optional business parameters\n A: \"B\",\n C: [\"e\", \"j\"]\n },\n withAtLeastOneUsedParam: true, // optional, defaults to false.\n // If true, returns only the links that use at least one (non sap-) parameter from 'params'.\n\n sortResultsBy: \"intent\", // optional parameter that decides on how the returned results will be sorted.\n // Possible values are:\n // - \"intent\" (default) lexicographical sort on returned 'intent' field\n // - \"text\" lexicographical sort on returned 'text' field\n // - \"priority\" top intents are returned first\n\n treatTechHintAsFilter : true, // optional, defaults to false.\n // if true, only apps that match exactly the supplied technology (e.g. sap-ui-tech-hint=WDA) will be considered.\n\n ui5Component: UI5Component, // mandatory, the UI5 component invoking the service, shall be a root component!\n\n appStateKey: \"abc123...\", // optional, application state key to add to the generated links, SAP internal usage only.\n\n compactIntents: true // optional, whether intents should be returned in compact format. Defaults to false.\n\n ignoreFormFactor: true, // optional, defaults to false, deprecated, do not use, may have no effect in the future.\n\n tags: [\"tag-1\", \"tag-2\"] // optional, if specified, only returns links that match inbound with certain tags.\n }\n Starting from UI5 version 1.52.0 the params argument can be specified in the extended format:
\n ...\n params: {\n P1: { value: \"v1\" },\n P2: { value: [\"v2\", \"v3\"] }\n }\n When the parameter is expressed in this format, the caller can specify additional search options.
Besides 'value', supported search options for the extended format are:
required : whether the parameter must be required (true) or not required (false) in the signature of the matching target (once the navigation occurs to the returned link). Note that this option will be effective if the Fiori Launchpad is configured to resolve navigation targets via sap.ushell.services.ClientSideTargetResolution and therefore may not be supported in all platforms.Example:
\n ...\n params: {\n P1: { value: \"v1\", required: true },\n P2: { value: [\"v2\", \"v3\"] }\n }\n ...\n
This method supports a mass invocation interface to obtain multiple results with a single call, as shown in the following example:
\n oCrossApplicationService.getLinks([ // array, because multiple invocations are to be made\n [ // arguments for the first invocation\n { semanticObject: \"SO\" } // this method supports one parameter only in each call\n ],\n [ // arguments for the second invocation\n { action: \"someAction\" }\n ]\n // ... and so on\n ]).done(…);\n
Calling this method with no arguments will produce the same result as if the method was called with an empty object.
","typeInfo":{"template":"object | Array"},"defaultValue":""},{"name":"semanticObject","optional":true,"description":"
Optional, matches any semantic objects if undefined
","depth":1,"typeInfo":{"template":"string"},"phoneName":"vArgs.semanticObject","defaultValue":""},{"name":"action","optional":true,"description":"
Optional, matches any actions if undefined
","depth":1,"typeInfo":{"template":"string"},"phoneName":"vArgs.action","defaultValue":""},{"name":"params","optional":true,"description":"
Optional business parameters
","depth":1,"typeInfo":{"template":"object"},"phoneName":"vArgs.params","defaultValue":""},{"name":"withAtLeastOneUsedParam","optional":true,"description":"
Optional, defaults to false. If true, returns only the links that use at least one (non sap-) parameter from 'params'.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"vArgs.withAtLeastOneUsedParam","defaultValue":""},{"name":"sortResultsBy","optional":true,"description":"
Optional parameter that decides on how the returned results will be sorted.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"vArgs.sortResultsBy","defaultValue":""},{"name":"treatTechHintAsFilter","optional":true,"description":"
Optional, defaults to false. If true, only apps that match exactly the supplied technology (e.g. sap-ui-tech-hint=WDA) will be considered.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"vArgs.treatTechHintAsFilter","defaultValue":""},{"name":"ui5Component","optional":false,"description":"
Mandatory, the UI5 component invoking the service, shall be a root component.
","depth":1,"typeInfo":{"UI5Types":["sap.ui.core.Component"]},"phoneName":"vArgs.ui5Component","defaultValue":""},{"name":"appStateKey","optional":true,"description":"
Optional, application state key to add to the generated links, SAP internal usage only.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"vArgs.appStateKey","defaultValue":""},{"name":"compactIntents","optional":true,"defaultValue":false,"description":"
Optional, whether intents should be returned in compact format. Defaults to false.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"vArgs.compactIntents"},{"name":"tags","optional":true,"description":"
Optional, if specified, only returns links that match inbound with certain tags.
","depth":1,"typeInfo":{"template":"Array"},"phoneName":"vArgs.tags","defaultValue":""}],"description":"Resolves the given semantic object (and action) and business parameters to a list of links available to the user.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Navigation#getLinks} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/getLinks","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Navigation#getLinks instead.","code":"getLinks(vArgs?) : jQuery.Promise "},{"name":"getPrimaryIntent","visibility":"public","since":"1.48","returnValue":{"type":"jQuery.Promise","description":"Resolves to an object of the following form when a relevant link object exists:
\n {\n intent: \"#AnObject-Action?A=B&C=e&C=j\",\n text: \"Perform action\",\n icon: \"sap-icon://Fiori2/F0018\", // optional\n shortTitle: \"Perform\" // optional\n tags: [\"tag-1\", \"tag-2\"] // optional\n }\n Otherwise, the returned promise will resolve to null when no relevant link object exists.","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sSemanticObject","optional":false,"description":"
Semantic object.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"mParameters","optional":true,"description":"
@see sap.ushell.services.CrossApplicationNavigation#getSemanticObjectLinks for description.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"For a given semantic object, this method considers all actions associated with the semantic object and returns the one tagged as a \"primaryAction\". If no inbound tagged as \"primaryAction\" exists, then the intent of the first inbound (after sorting has been applied) matching the action \"displayFactSheet\".
The primary intent is determined by querying sap.ushell.services.CrossApplicationNavigation#getLinks with the given semantic object and optional parameter. Then the resulting list is filtered to the outcome that a single item remains.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Navigation#getPrimaryIntent} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/getPrimaryIntent","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Navigation#getPrimaryIntent instead.","code":"getPrimaryIntent(sSemanticObject, mParameters?) : jQuery.Promise "},{"name":"getSemanticObjectLinks","visibility":"public","since":"1.19.0","returnValue":{"type":"jQuery.Promise","description":"Resolves with an array of link objects containing (at least) the following properties:
\n {\n intent: \"#AnObject-action?A=B&C=e\",\n text: \"Perform action\",\n icon: \"sap-icon://Fiori2/F0018\", //optional\n subTitle: \"Action\", //optional\n shortTitle: \"Perform\" //optional\n }\n 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: \n externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent} }, that.oComponent);\n
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sSemanticObject","optional":false,"description":"
the semantic object such as \"AnObject\"
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"mParameters","optional":true,"description":"
the map of business parameters with values, for instance
\n {\n A: \"B\",\n c: \"e\"\n }\n ","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bIgnoreFormFactor","optional":true,"defaultValue":false,"description":"
when set to true the form factor of the current device is ignored
","typeInfo":{"template":"boolean"}},{"name":"oComponent","optional":true,"description":"
SAP UI5 Component invoking the service
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"sAppStateKey","optional":true,"description":"
application state key to add to the generated links, SAP internal usage only
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"bCompactIntents","optional":true,"description":"
whether the returned intents should be returned in compact format. Defaults to false.
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Resolves a given semantic object and business parameters to a list of links, taking into account the form factor of the current device.
","deprecated":{"since":"1.38","text":"Please use {@link #getLinks} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/getSemanticObjectLinks","deprecatedText":"Deprecated as of version 1.38. Please use #getLinks instead.","code":"getSemanticObjectLinks(sSemanticObject, mParameters?, bIgnoreFormFactor?, oComponent?, sAppStateKey?, bCompactIntents?) : jQuery.Promise "},{"name":"getStartupAppState","visibility":"restricted","allowedFor":["SAP Internal usage only","beware! internally public","cannot be changed","but not part of the public documentation"],"since":"1.28","returnValue":{"type":"jQuery.Promise","description":"Resolves the app state object. Note that this is an unmodifiable container and its data must be copied into a writable container!
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oAppComponent","optional":false,"description":"
UI5 component, key will be extracted from component data
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Get the app state object that was used for the current cross application navigation
","href":"api/sap.ushell.services.CrossApplicationNavigation#methods/getStartupAppState","code":"getStartupAppState(oAppComponent) : jQuery.Promise "},{"name":"historyBack","visibility":"public","parameters":[{"name":"iSteps","optional":false,"description":"
positive integer representing the steps to go back in the history
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Navigates back in history the number of given steps if this is supported by the underlying platform. If no argument is provided it will navigate back 1 step.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Navigation#historyBack} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/historyBack","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Navigation#historyBack instead.","code":"historyBack(iSteps) : void "},{"name":"hrefForAppSpecificHash","visibility":"public","since":"1.15.0","returnValue":{"type":"string","description":"A string which can be put into the link tag, containing the current shell navigation target and the specified application specific hash suffix
","typeInfo":{"template":"string"}},"parameters":[{"name":"sAppHash","optional":false,"description":"
the app specific router, obtained e.g. via router.getURL(...). Note that sAppHash shall not exceed 512 bytes when serialized as UTF-8.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns a string which can be put into the DOM (e.g. in a link tag) given an application specific hash suffix
Example: hrefForAppSpecificHash(\"View1/details/0/\") returns #SemanticObject-action&/View1/details/0/ if the current application runs in the shell and was started using \"SemanticObject-action\" as shell navigation hash
","deprecated":{"since":"1.94","text":"Please use {@link #hrefForAppSpecificHashAsync} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/hrefForAppSpecificHash","deprecatedText":"Deprecated as of version 1.94. Please use #hrefForAppSpecificHashAsync instead.","code":"hrefForAppSpecificHash(sAppHash) : string "},{"name":"hrefForAppSpecificHashAsync","visibility":"public","since":"1.94.0","returnValue":{"type":"Promise","description":"A promise which resolves a string which can be put into the link tag, containing the current shell navigation target and the specified application specific hash suffix
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sAppHash","optional":false,"description":"
the app specific router, obtained e.g. via router.getURL(...). Note that sAppHash shall not exceed 512 bytes when serialized as UTF-8.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns a Promise which resolves a string that can be put into the DOM (e.g. in a link tag) given an application specific hash suffix
Example: hrefForAppSpecificHashAsync(\"View1/details/0/\") returns a Promise that resolves: #SemanticObject-action&/View1/details/0/ if the current application runs in the shell and was started using \"SemanticObject-action\" as shell navigation hash
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Navigation#getHref} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/hrefForAppSpecificHashAsync","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Navigation#getHref instead.","code":"hrefForAppSpecificHashAsync(sAppHash) : Promise "},{"name":"hrefForExternal","visibility":"public","since":"1.15.0","returnValue":{"type":"string|Promise","description":"the href for the specified parameters as an external shell hash; always starting with a hash character; all parameters and parameter names are URL-encoded (via encodeURIComponent) and the complete string is encoded via encodeURI (!). The generated string can not be used in the majority of interfaces which expect a internal shell 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\" to navigate to a specific homepage!
Note: if object is undefined, the current shell hash is returned.
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:
\n externalHash = oCrossApplicationNavigationService.hrefForExternal({\n target: { shellHash: oLink.intent }\n }, that.oComponent);\n Since version 1.56 this API accepts a sap-xapp-state-data parameter that can be used generate a url that can be used to launch and application with certain data, for example:
\n {\n target : { semanticObject : \"AnObject\", action: \"action\" },\n params : { \"sap-xapp-state-data\" : JSON.stringify({ a: \"b\", c: \"d\" }) }\n }\n Using the arguments as in the example above, a link with a sap-xapp-state parameter that encodes the provided data is returned. The sap-xapp-state-data parameter does not appear in the generated link.
","typeInfo":{"template":"string | Promise"}},"parameters":[{"name":"oArgs","optional":false,"description":"
object encoding a semantic object and action, e.g.
\n {\n target : { semanticObject : \"AnObject\", action: \"action\" },\n params : { A : \"B\" }\n }\n or e.g. \n {\n target : {\n semanticObject : \"AnObject\",\n action: \"action\", context : \"AB7F3C\"\n },\n params : {\n A : \"B\",\n c : \"e\"\n }\n }\n or { target : { shellHash : \"SO-36?jumper=postman\" } } ","typeInfo":{"template":"object"},"defaultValue":""},{"name":"oComponent","optional":true,"description":"
the root component of the application
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bAsync","optional":false,"description":"
if set to true, a promise will be returned instead of the direct argument. The promise will only succeed after all compaction requests have been sent. bAsync=false is deprecated since 1.94.
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Returns a string which can be put into the DOM (e.g. in a link tag). Note: The generated url / url segment must not be used as shellHash in the target definition of sap.ushell.services.CrossApplicationNavigation#toExternal
","deprecated":{"since":"1.98","text":"Please use {@link sap.ushell.services.Navigation#getHref} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/hrefForExternal","deprecatedText":"Deprecated as of version 1.98. Please use sap.ushell.services.Navigation#getHref instead.","code":"hrefForExternal(oArgs, oComponent?, bAsync) : string|Promise "},{"name":"hrefForExternalAsync","visibility":"public","since":"1.94.0","returnValue":{"type":"Promise","description":"A Promise which resolves href for the specified parameters as an *external* shell hash; always starting with a hash character; all parameters and parameter names are URL-encoded (via encodeURIComponent) and the complete string is encoded via encodeURI (!). The generated string can not be used in the majority of interfaces which expect a internal shell hash.
A proper way for an application to generate a link to return to the home page of the Fiori launchpad is: hrefForExternalAsync( { target : { shellHash : \"#\" }})
Do *not* use \"#Shell-home\" to navigate to a specific homepage!
Note: if object is undefined, the current shell hash is returned.
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:
\n CrossApplicationNavigation.hrefForExternalAsync({\n target: { shellHash: oLink.intent }\n }, that.oComponent).then( function (sExternalHref) {\n // do something with the resolved sExternalHref.\n });\n This API accepts a sap-xapp-state-data parameter that can be used generate a url that can be used to launch and application with certain data, for example:
\n {\n target : { semanticObject : \"AnObject\", action: \"action\" },\n params : { \"sap-xapp-state-data\" : JSON.stringify({ a: \"b\", c: \"d\" }) }\n }\n Using the arguments as in the example above, a link with a sap-xapp-state parameter that encodes the provided data is returned. The sap-xapp-state-data parameter does not appear in the generated link.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oArgs","optional":false,"description":"
object encoding a semantic object and action, e.g.
\n {\n target : { semanticObject : \"AnObject\", action: \"action\" },\n params : { A : \"B\" }\n }\n or e.g. \n {\n target : {\n semanticObject : \"AnObject\",\n action: \"action\", context : \"AB7F3C\"\n },\n params : {\n A : \"B\",\n c : \"e\"\n }\n }\n or \n {\n target : {\n shellHash : \"SO-36?jumper=postman\"\n }\n }\n ","typeInfo":{"template":"object"},"defaultValue":""},{"name":"oComponent","optional":true,"description":"
the root component of the application
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns a promise resolving to a URL that launches an app with certain parameters. The URL can be used to define a link to a Fiori application, for example.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Navigation#getHref} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/hrefForExternalAsync","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Navigation#getHref instead.","code":"hrefForExternalAsync(oArgs, oComponent?) : Promise "},{"name":"isInitialNavigation","visibility":"public","since":"1.36.0","returnValue":{"type":"boolean","description":"Whether the initial navigation occurred.
","typeInfo":{"template":"boolean"}},"description":"Checks wether the FLP currently shows the initially loaded navigation target (i.e. the intent it was started with). This method can be used to e.g. detect whether the current app was started directly, that is, without a navigation from another app or FLP home.
","deprecated":{"since":"1.94","text":"Please use {@link #isInitialNavigationAsync} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/isInitialNavigation","deprecatedText":"Deprecated as of version 1.94. Please use #isInitialNavigationAsync instead.","code":"isInitialNavigation() : boolean "},{"name":"isInitialNavigationAsync","visibility":"public","since":"1.94.0","returnValue":{"type":"Promise","description":"This promise resolves with a boolean indicating if the current navigation is considered initial
","typeInfo":{"template":"Promise"}},"description":"Checks whether the FLP has performed the first navigation. This method can be used to detect whether the current app was started directly, that is, without a previous navigation to another app, to the FLP home, or another target that adds an entry in the browser history.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Navigation#isInitialNavigation} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/isInitialNavigationAsync","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Navigation#isInitialNavigation instead.","code":"isInitialNavigationAsync() : Promise "},{"name":"isIntentSupported","visibility":"public","since":"1.19.1","returnValue":{"type":"jQuery.Promise","description":"Resolves with a map containing the intents from aIntents as keys. The map values are objects with a property supported of type boolean.
\n {\n \"#AnObject-action?A=B&c=e\": { supported: false },\n \"#AnotherObject-action2\": { supported: true }\n }\n Example usage:
\n this.oCrossAppNav.isIntentSupported([\"SalesOrder-approve?SOId=1234\"])\n .done(function(aResponses) {\n if (oResponse[\"SalesOrder-approve?SOId=1234\"].supported===true){\n // enable link\n }\n else {\n // disable link\n }\n })\n .fail(function() {\n // disable link\n // request failed or other error\n });\n ","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"aIntents","optional":false,"description":"
the intents (such as [\"#AnObject-action?A=B&c=e\"]) to be checked
","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"oComponent","optional":true,"description":"
the root component of the application
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Tells whether the given intent(s) are supported, taking into account the form factor of the current device. \"Supported\" means that navigation to the intent is possible. Note that the intents are assumed to be in internal format and expanded.
","deprecated":{"since":"1.31","text":"Please use {@link #isNavigationSupported} instead. Note that this has a slightly different response format."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/isIntentSupported","deprecatedText":"Deprecated as of version 1.31. Please use #isNavigationSupported instead. Note that this has a slightly different response format.","code":"isIntentSupported(aIntents, oComponent?) : jQuery.Promise "},{"name":"isNavigationSupported","visibility":"public","since":"1.32","returnValue":{"type":"jQuery.Promise","description":"Resolves to an array of objects indicating whether the intent is supported or not. Each object has a property supported of type boolean.
Example:
aIntents:
\n [\n {\n target : {\n semanticObject : \"AnObject\",\n action: \"action\"\n },\n params : { P1 : \"B\", P2 : [ \"V2a\", \"V2b\"] }\n },\n {\n target : {\n semanticObject : \"SalesOrder\",\n action: \"display\"\n },\n params : { P3 : \"B\", SalesOrderIds : [ \"4711\", \"472\"] }\n }\n ]\n response:
\n [\n { supported: false },\n { supported: true }\n ]\n Example usage:
\n this.oCrossAppNav.isNavigationSupported([\n target: { shellHash: \"SalesOrder-approve?SOId=1234\" }\n ])\n .done(function(aResponses) {\n if (aResponses[0].supported===true){\n // enable link\n }\n else {\n // disable link\n }\n })\n .fail(function() {\n // disable link\n // request failed or other fatal error\n });\n ","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"aIntents","optional":false,"description":"
The intents to be checked, with object[] being instances of the oArgs argument of the toExternal or hrefForExternal methods, e.g.
\n {\n target: {\n semanticObject: \"AnObject\",\n action: \"action\"\n },\n params: { A: \"B\" }\n }\n or e.g. \n {\n target: {\n semanticObject: \"AnObject\",\n action: \"action\"\n },\n params: {\n A: \"B\",\n c: \"e\"\n }\n }\n or \n {\n target: {\n shellHash: \"SalesOrder-approve?SOId=1234\"\n }\n }\n ","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"oComponent","optional":true,"description":"
The root component of the application
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Tells whether the given navigation intents are supported for the given parameters, form factor etc. . \"Supported\" means that a valid navigation target is configured for the user and for the given device.
isNavigationSupported is effectively a test function for sap.ushell.services.CrossApplicationNavigation#toExternal and sap.ushell.services.CrossApplicationNavigation#hrefForExternal .
It is functionally equivalent to sap.ushell.services.CrossApplicationNavigation#isIntentSupported but accepts the same interface as sap.ushell.services.CrossApplicationNavigation#toExternal and sap.ushell.services.CrossApplicationNavigation#hrefForExternal .
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Navigation#isNavigationSupported} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/isNavigationSupported","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Navigation#isNavigationSupported instead.","code":"isNavigationSupported(aIntents, oComponent?) : jQuery.Promise "},{"name":"resolveIntent","visibility":"protected","returnValue":{"type":"jQuery.Promise","description":"Resolves the intent.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sHashFragment","optional":false,"description":"
The formatted URL hash fragment in internal format (as obtained by the SAPUI5 hasher service) not as given in location.hash)! Example: #SemanticObject-action?P1=V1&P2=A%20B%20C
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Resolves the URL hash fragment.
This function gets the hash part of the URL and returns the URL of the target application.
This is an asynchronous operation.
","href":"api/sap.ushell.services.CrossApplicationNavigation#methods/resolveIntent","code":"resolveIntent(sHashFragment) : jQuery.Promise "},{"name":"saveMultipleAppStates","visibility":"restricted","allowedFor":["SAP Internal usage only","beware! internally public","cannot be changed","but not part of the public documentation"],"returnValue":{"type":"jQuery.Promise","description":"Resolves an array of individual save promise objects is returned as argument in case of a reject, individual responses are not available
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"aAppStates","optional":false,"description":"
Array of application States
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"persist multiple app states (in future potentially batched in a single roundtrip)
","href":"api/sap.ushell.services.CrossApplicationNavigation#methods/saveMultipleAppStates","code":"saveMultipleAppStates(aAppStates) : jQuery.Promise "},{"name":"toExternal","visibility":"public","since":"1.15.0","returnValue":{"type":"Promise","description":"A Promise which resolves once the navigation was triggered. The Promise might never reject or resolve when an error occurs during the navigation.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oArgs","optional":false,"description":"
A configuration object describing the navigation target. The navigation target can be provided as its separate aspects like semantic object, action, parameters etc. in separate members of the configuration object.
Note: Parameter values can contain special characters and must be provided unencoded; the function takes care for necessary encodings itself.
Simple Example:
\n{\n target: {\n semanticObject: \"Customer\",\n action: \"display\"\n },\n params: {\n customerId: \"0815-4711\"\n }\n}\n Example with text:
\n{\n target: {\n semanticObject: \"Note\",\n action: \"create\"\n },\n params: {\n noteText: \"Thanks for reading the documentation!\"\n }\n}\n Example with a given context:
\n{\n target: {\n semanticObject: \"AnObject\",\n action: \"action\",\n context: \"AB7F3C\"\n },\n params: {\n param1: \"Value One\"\n }\n}\n Alternatively a shellHash can be provided that includes already all aspects of the navigation target: semantic object, action, intent parameters, app-specific route (including app parameters)
Note: While parameters need to be url-encoded once when used in the shellHash the app specific route must not be encoded.
Example with shellHash as target:
\n{\n target: {\n shellHash: \"Note-update?noteText=You%20got%20quite%20far&/Notes/My First Note\"\n }\n}\n To navigate to the homepage of the Fiori launchpad, navigate to {target: {shellHash: \"#\"}}. Do not use \"#Shell-home\" or \"Shell-home\" to navigate to!
To provide a complex parameter structure to a target app the pseudo parameter sap-xapp-state-data can be used.
Example:
\n{\n ...\n params : {\n \"sap-xapp-state-data\": JSON.stringify({ a: \"b\", c: \"d\" })\n }\n}\n The data specified via sap-xapp-state-data is passed to the target application in the sap-xapp-state parameter. The sap-xapp-state-data parameter itself is not passed to the target application.
Note: The parameter length (including semantic object and action) shall not exceed 512 bytes when serialized as UTF-8.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"oComponent","optional":true,"description":"
an optional UI5 component, used to logically attach a possibly generated app state.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Triggers a navigation to a specified target outside of the currently running application (e.g. different launchpad application). Invocation will trigger a hash change and subsequent invocation of the target.
If the navigation target opens in a new window the running application may be retained.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Navigation#navigate} instead."},"href":"api/sap.ushell.services.CrossApplicationNavigation#methods/toExternal","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Navigation#navigate instead.","code":"toExternal(oArgs, oComponent?) : Promise "}],"displayName":"sap.ushell.services.CrossApplicationNavigation","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.CrossApplicationNavigation","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Navigation instead."},{"kind":"class","name":"sap.ushell.services.EndUserFeedback","basename":"EndUserFeedback","resource":"sap/ushell/services/EndUserFeedback.js","module":"sap/ushell/services/EndUserFeedback","export":"","static":true,"visibility":"public","since":"1.25.1","extends":"sap.ushell.services.Service","description":"The Unified Shell's end user feedback service. This service is deprecated and does nothing. End user feedback functionality is not part of the ushell library.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const EndUserFeedback = await Container.getServiceAsync(\"EndUserFeedback\");\n // do something with the EndUserFeedback service\n });\n ","hideconstructor":true,"methods":[{"name":"getLegalText","visibility":"public","since":"1.25.1","returnValue":{"type":"string","description":"Empty string
","typeInfo":{"template":"string"}},"deprecated":{"since":"1.93","text":"Deprecated without successor."},"href":"api/sap.ushell.services.EndUserFeedback#methods/getLegalText","deprecatedText":"Deprecated as of version 1.93. Deprecated without successor.","code":"getLegalText() : string "},{"name":"isEnabled","visibility":"public","since":"1.25.1","returnValue":{"type":"Promise","description":"Rejected promise.
","typeInfo":{"template":"Promise"}},"description":"The service is deprecated. The function always returns a negative answer.
","deprecated":{"since":"1.93","text":"Deprecated without successor."},"href":"api/sap.ushell.services.EndUserFeedback#methods/isEnabled","deprecatedText":"Deprecated as of version 1.93. Deprecated without successor.","code":"isEnabled() : Promise "},{"name":"sendFeedback","visibility":"public","since":"1.25.1","returnValue":{"type":"Promise","description":"Empty promise
","typeInfo":{"template":"Promise"}},"description":"Sends a feedback.
","deprecated":{"since":"1.93","text":"Deprecated without successor."},"href":"api/sap.ushell.services.EndUserFeedback#methods/sendFeedback","deprecatedText":"Deprecated as of version 1.93. Deprecated without successor.","code":"sendFeedback() : Promise "}],"displayName":"sap.ushell.services.EndUserFeedback","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.EndUserFeedback","subTitle":"Deprecated in version: 1.93","deprecatedText":"Deprecated as of version 1.93. Deprecated without successor."},{"kind":"class","name":"sap.ushell.services.Extension","basename":"Extension","resource":"sap/ushell/services/Extension.js","module":"sap/ushell/services/Extension","export":"","static":true,"visibility":"public","since":"1.120.0","extends":"sap.ushell.services.Service","description":"The Unified Shell's Extension service. Allows adding extensions on the user's home page.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const Extension = await Container.getServiceAsync(\"Extension\");\n // do something with the Extension service\n });\n This service is available in any FLP context (native, iframe, ...).
","hideconstructor":true,"methods":[{"name":"createHeaderItem","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"The newly created header item.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.Extension.Item"]}},"parameters":[{"name":"controlProperties","optional":false,"description":"
The properties that will be passed to the created control.
","typeInfo":{"UI5Types":["sap.ushell.ui.shell.ShellHeadItem.Properties"],"refersToTypedef":true},"defaultValue":""},{"name":"parameters","optional":true,"description":"
Additional parameters.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"position","optional":true,"defaultValue":"end","description":"
Possible values are begin and end.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"parameters.position"},{"name":"helpId","optional":true,"description":"
The help id of the user action. This allows to assign help content to the user action.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"parameters.helpId","defaultValue":""}],"description":"Creates a header item in the shell header. Restrictions:
The control properties are only allowed to contain primitive properties and event handlers. Bindings, aggregations, controls and objects with prototypes are not allowed! The created controls cannot have stable ids! Instead you can provide a help id. The event handlers are not bound to the actual control and do not receive the event arguments. ","examples":[{"data":"Example: Extension.createHeaderItem({\n ariaLabel: \"headerItem-ariaLabel\",\n ariaHaspopup: \"dialog\",\n icon: \"sap-icon://action-settings\",\n tooltip: \"headerItem-tooltip\",\n text: \"headerItem-text\",\n press: () => {\n MessageToast.show(\"Press header item\");\n }\n }, {\n position: \"begin\"\n helpId: \"myHeaderItemHelpId\"\n })
"}],"href":"api/sap.ushell.services.Extension#methods/createHeaderItem","code":"createHeaderItem(controlProperties, parameters?) : Promise "},{"name":"createUserAction","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"The newly created user action.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.Extension.Item"]}},"parameters":[{"name":"controlProperties","optional":false,"description":"
The properties that will be passed to the created control.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"parameters","optional":true,"description":"
Additional parameters.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"controlType","optional":true,"defaultValue":"sap.ushell.ui.launchpad.ActionItem","description":"
Defines the controlType of the item.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"parameters.controlType"},{"name":"helpId","optional":true,"description":"
The help id of the user action. This allows to assign help content to the user action.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"parameters.helpId","defaultValue":""}],"description":"Creates a user action in the user action menu.controlType can be any control and is by default a sap.ushell.ui.launchpad.ActionItem . The controlProperties are passed to the constructor of the control. Restrictions:
The control properties are only allowed to contain primitive properties and event handlers. Bindings, aggregations, controls and objects with prototypes are not allowed! The created controls cannot have stable ids! Instead you can provide a help id. The event handlers are not bound to the actual control and do not receive the event arguments. ","examples":[{"data":"Example: Extension.createUserAction({\n text: \"New UserAction\",\n icon: \"sap-icon://refresh\",\n press: () => {\n MessageToast.show(\"Press UserAction\");\n }\n }, {\n controlType: \"sap.ushell.ui.launchpad.ActionItem\",\n helpId: \"myUserActionHelpId\"\n })
"}],"href":"api/sap.ushell.services.Extension#methods/createUserAction","code":"createUserAction(controlProperties, parameters?) : Promise "}],"displayName":"sap.ushell.services.Extension","nodes":[{"name":"sap.ushell.services.Extension.Item","description":"Item wrapping an item positioned in an extension point.
","href":"api/sap.ushell.services.Extension.Item"}],"component":"CA-FLP-FE-UI","hasSample":true,"title":"class sap.ushell.services.Extension","subTitle":""},{"kind":"class","name":"sap.ushell.services.Extension.Item","basename":"Item","resource":"sap/ushell/services/Extension/Item.js","module":"sap/ushell/services/Extension/Item","export":"","static":true,"visibility":"public","since":"1.120.0","description":"Item wrapping an item positioned in an extension point. To be instantiated by sap.ushell.services.Extension . sap.ushell.services.Extension.Item#showOnHome or sap.ushell.services.Extension.Item#showForAllApps the item is not destroyed automatically and has to be destroyed manually via sap.ushell.services.Extension.Item#destroy .
","hideconstructor":true,"methods":[{"name":"destroy","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves once the item was destroyed.
","typeInfo":{"template":"Promise"}},"description":"Destroys the item and it's related content.
","href":"api/sap.ushell.services.Extension.Item#methods/destroy","code":"destroy() : Promise "},{"name":"hideForAllApps","visibility":"public","since":"1.120.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Hides the item for all applications. Does not change the visibility of the item for the launchpad \"home\".
","href":"api/sap.ushell.services.Extension.Item#methods/hideForAllApps","code":"hideForAllApps() : this "},{"name":"hideForCurrentApp","visibility":"public","since":"1.120.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Hides the item for the current application.
","href":"api/sap.ushell.services.Extension.Item#methods/hideForCurrentApp","code":"hideForCurrentApp() : this "},{"name":"hideOnHome","visibility":"public","since":"1.120.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Hides the item for launchpad \"home\". Does not change the visibility of the item within applications.
","href":"api/sap.ushell.services.Extension.Item#methods/hideOnHome","code":"hideOnHome() : this "},{"name":"showForAllApps","visibility":"public","since":"1.120.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Shows the item for all applications. Does not change the visibility of the item for the launchpad \"home\".
","href":"api/sap.ushell.services.Extension.Item#methods/showForAllApps","code":"showForAllApps() : this "},{"name":"showForCurrentApp","visibility":"public","since":"1.120.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Shows the item for the current application. The item will be hidden after the user navigates away from this application. The item will not be added again if the user navigates back to the application. Exception: Apps which are using the keep alive feature. There the visibility is restored together with the app.
","href":"api/sap.ushell.services.Extension.Item#methods/showForCurrentApp","code":"showForCurrentApp() : this "},{"name":"showOnHome","visibility":"public","since":"1.120.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Shows the item for launchpad \"home\". Does not change the visibility of the item within applications.
","href":"api/sap.ushell.services.Extension.Item#methods/showOnHome","code":"showOnHome() : this "}],"displayName":"sap.ushell.services.Extension.Item","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Extension.Item","subTitle":""},{"kind":"class","name":"sap.ushell.services.FrameBoundExtension","basename":"FrameBoundExtension","resource":"sap/ushell/services/FrameBoundExtension.js","module":"sap/ushell/services/FrameBoundExtension","export":"","static":true,"visibility":"public","since":"1.124.0","extends":"sap.ushell.services.Service","description":"The Unified Shell's Extension service. Allows adding extensions on the user's home page.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container.getServiceAsync(\"FrameBoundExtension\"). For details, see sap.ushell.Container#getServiceAsync .
Restriction: This Service does not work when called from within a iframe. The calling function has to be in the 'same frame' as the launchpad itself.
","hideconstructor":true,"methods":[{"name":"addGroupedUserSettingsEntry","visibility":"restricted","allowedFor":["sap.fe","sap.esh.search.ui"],"since":"1.124.0","returnValue":{"type":"Promise","description":"Resolves with the new entry once the settings entry was added.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.FrameBoundExtension.UserSettingsEntry"]}},"parameters":[{"name":"properties","optional":false,"description":"
The data of the new added user settings entry.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"entryHelpID","optional":true,"description":"
The ID of the object.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"properties.entryHelpID","defaultValue":""},{"name":"title","optional":false,"description":"
The title of the entry to be presented in the list in the user settings dialog box. We recommend using a string from the translation bundle.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"properties.title","defaultValue":""},{"name":"value","optional":false,"description":"
A string to be presented as the subtitle of the entry OR a function which resolves the sub title.
","depth":1,"typeInfo":{"template":"string | function() : Promise"},"phoneName":"properties.value","defaultValue":""},{"name":"content","optional":false,"description":"
A function that resolves the content which has to be a sap.ui.core.Control . A SAPUI5 view instance can also be returned. The result will be displayed in the settings as content for this entry.
","depth":1,"typeInfo":{"template":"function() : Promise<${0}>","UI5Types":["sap.ui.core.Control"]},"phoneName":"properties.content","defaultValue":""},{"name":"onSave","optional":false,"description":"
A callback which is called when the user clicks \"save\" in the user settings dialog. The function has to return a native promise. If an error occurs, pass the error message via rejected promise. Errors are displayed in the common log.
","depth":1,"typeInfo":{"template":"function"},"phoneName":"properties.onSave","defaultValue":""},{"name":"onCancel","optional":false,"description":"
A callback which is called when the user closes the user settings dialog without saving any changes.
","depth":1,"typeInfo":{"template":"function() : Promise"},"phoneName":"properties.onCancel","defaultValue":""},{"name":"provideEmptyWrapper","optional":true,"defaultValue":false,"description":"
Set this value to true if you want that your content is displayed without the standard header.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"properties.provideEmptyWrapper"},{"name":"groupingId","optional":true,"description":"
The ID of the group this entry should be included in.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"properties.groupingId","defaultValue":""},{"name":"groupingTabTitle","optional":true,"description":"
The tab title of the entry, when this entry is grouped.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"properties.groupingTabTitle","defaultValue":""},{"name":"groupingTabHelpId","optional":true,"description":"
The help ID for the grouped tab, when this entry is grouped.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"properties.groupingTabHelpId","defaultValue":""}],"description":"Adds an entry to the user settings dialog box including the UI control that appears when the user clicks the new entry, and handling of user settings actions such as SAVE and CANCEL.
Restriction: NOT available for apps running in an iframe
","href":"api/sap.ushell.services.FrameBoundExtension#methods/addGroupedUserSettingsEntry","code":"addGroupedUserSettingsEntry(properties) : Promise "},{"name":"addUserSettingsEntry","visibility":"public","since":"1.124.0","returnValue":{"type":"Promise","description":"Resolves with the new entry once the settings entry was added.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.FrameBoundExtension.UserSettingsEntry"]}},"parameters":[{"name":"properties","optional":false,"description":"
The data of the new added user settings entry.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"entryHelpID","optional":true,"description":"
The ID of the object.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"properties.entryHelpID","defaultValue":""},{"name":"title","optional":false,"description":"
The title of the entry to be presented in the list in the user settings dialog box. We recommend using a string from the translation bundle.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"properties.title","defaultValue":""},{"name":"value","optional":false,"description":"
A string to be presented as the subtitle of the entry OR a function which resolves the sub title.
","depth":1,"typeInfo":{"template":"string | function() : Promise"},"phoneName":"properties.value","defaultValue":""},{"name":"content","optional":false,"description":"
A function that resolves the content which has to be a sap.ui.core.Control . A SAPUI5 view instance can also be returned. The result will be displayed in the settings as content for this entry.
","depth":1,"typeInfo":{"template":"function() : Promise<${0}>","UI5Types":["sap.ui.core.Control"]},"phoneName":"properties.content","defaultValue":""},{"name":"onSave","optional":false,"description":"
A callback which is called when the user clicks \"save\" in the user settings dialog. The function has to return a native promise. If an error occurs, pass the error message via rejected promise. Errors are displayed in the common log.
","depth":1,"typeInfo":{"template":"function() : Promise"},"phoneName":"properties.onSave","defaultValue":""},{"name":"onCancel","optional":false,"description":"
A callback which is called when the user closes the user settings dialog without saving any changes.
","depth":1,"typeInfo":{"template":"function"},"phoneName":"properties.onCancel","defaultValue":""},{"name":"provideEmptyWrapper","optional":true,"defaultValue":false,"description":"
Set this value to true if you want that your content is displayed without the standard header.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"properties.provideEmptyWrapper"}],"description":"Adds an entry to the user settings dialog box including the UI control that appears when the user clicks the new entry, and handling of user settings actions such as SAVE and CANCEL.
Restriction: NOT available for apps running in an iframe
","href":"api/sap.ushell.services.FrameBoundExtension#methods/addUserSettingsEntry","code":"addUserSettingsEntry(properties) : Promise "},{"name":"createFooter","visibility":"public","since":"1.124.0","returnValue":{"type":"Promise","description":"The newly created footer.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.FrameBoundExtension.Footer"]}},"parameters":[{"name":"controlProperties","optional":false,"description":"
The properties that will be passed to the created control.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"parameters","optional":true,"description":"
Additional parameters.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"controlType","optional":true,"defaultValue":"sap.m.Bar","description":"
Defines the controlType.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"parameters.controlType"}],"description":"Creates a new footer which is positioned below the launchpad content.
The controlType can be any control and is by default a sap.m.Bar . The controlProperties are passed to the constructor of the control.
Note: Only one footer is displayed at once. Any new footer will replace the previous one
Note: As several application views can provide own footer's, usage can result in a non aria complained HTML structure. Two 'footer' tags will be present in the HTML structure which ends in an invalid accessibility state.
Restriction: NOT available for apps running in an iframe
","examples":[{"data":"Example: FrameBoundExtension.createFooter({\n id: \"footer1\",\n contentLeft: [new Button({\n text: \"Footer ContentLeftBtn\",\n press: () => {\n MessageToast.show(\"Press footer1 contentLeft\");\n }\n })],\n contentMiddle: [new Button({\n text: \"Footer contentMiddleBtn\",\n press: () => {\n MessageToast.show(\"Press footer1 contentMiddle\");\n }\n })],\n contentRight: [new Button({\n text: \"Footer contentRightBtn\",\n press: () => {\n MessageToast.show(\"Press footer1 contentRight\");\n }\n })]\n }, {\n controlType: \"sap.m.Bar\"\n })
"}],"href":"api/sap.ushell.services.FrameBoundExtension#methods/createFooter","code":"createFooter(controlProperties, parameters?) : Promise "},{"name":"createHeaderItem","visibility":"public","since":"1.124.0","returnValue":{"type":"Promise","description":"The newly created header item.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.FrameBoundExtension.Item"]}},"parameters":[{"name":"controlProperties","optional":false,"description":"
The properties that will be passed to the created control.
","typeInfo":{"UI5Types":["sap.ushell.ui.shell.ShellHeadItem.Properties"],"refersToTypedef":true},"defaultValue":""},{"name":"parameters","optional":true,"description":"
Additional parameters.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"position","optional":true,"defaultValue":"end","description":"
Possible values are begin and end.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"parameters.position"}],"description":"Creates a header item in the shell header.
","examples":[{"data":"Example: FrameBoundExtension.createHeaderItem({\n id: \"headerItem1\",\n ariaLabel: \"headerItem-ariaLabel\",\n ariaHaspopup: \"dialog\",\n icon: \"sap-icon://action-settings\",\n tooltip: \"headerItem-tooltip\",\n text: \"headerItem-text\",\n press: () => {\n MessageToast.show(\"Press header item\");\n }\n }, {\n position: \"begin\"\n })
"}],"href":"api/sap.ushell.services.FrameBoundExtension#methods/createHeaderItem","code":"createHeaderItem(controlProperties, parameters?) : Promise "},{"name":"createSubHeader","visibility":"public","since":"1.124.0","returnValue":{"type":"Promise","description":"The newly created sub header.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.FrameBoundExtension.Item"]}},"parameters":[{"name":"controlProperties","optional":false,"description":"
The properties that will be passed to the created control.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"parameters","optional":true,"description":"
Additional parameters.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"controlType","optional":true,"defaultValue":"sap.m.Bar","description":"
Defines the controlType.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"parameters.controlType"}],"description":"Creates a new sub header which is positioned below the header.
The controlType can be any control and is by default a sap.m.Bar . The controlProperties are passed to the constructor of the control.
Note: Only one sub header is displayed at once
Restriction: NOT available for apps running in an iframe
","examples":[{"data":"Example: FrameBoundExtension.createSubHeader({\n id: \"subheader1\",\n contentLeft: [new Button({\n text: \"SubHeader ContentLeftBtn\",\n press: () => {\n MessageToast.show(\"Press subheader1 contentLeft\");\n }\n })],\n contentMiddle: [new Button({\n text: \"SubHeader contentMiddleBtn\",\n press: () => {\n MessageToast.show(\"Press subheader1 contentMiddle\");\n }\n })],\n contentRight: [new Button({\n text: \"SubHeader contentRightBtn\",\n press: () => {\n MessageToast.show(\"Press subheader1 contentRight\");\n }\n })]\n }, {\n controlType: \"sap.m.Bar\"\n })
"}],"href":"api/sap.ushell.services.FrameBoundExtension#methods/createSubHeader","code":"createSubHeader(controlProperties, parameters?) : Promise "},{"name":"createUserAction","visibility":"public","since":"1.124.0","returnValue":{"type":"Promise","description":"The newly created user action.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.FrameBoundExtension.Item"]}},"parameters":[{"name":"controlProperties","optional":false,"description":"
The properties that will be passed to the created control.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"parameters","optional":true,"description":"
Additional parameters.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"controlType","optional":true,"defaultValue":"sap.ushell.ui.launchpad.ActionItem","description":"
Defines the controlType of the item.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"parameters.controlType"}],"description":"Creates a user action in the user action menu.
The controlType can be any control and is by default a sap.ushell.ui.launchpad.ActionItem . The controlProperties are passed to the constructor of the control.
","examples":[{"data":"Example: FrameBoundExtension.createUserAction({\n id: \"userAction1\",\n text: \"New UserAction\",\n icon: \"sap-icon://refresh\",\n press: () => {\n MessageToast.show(\"Press UserAction\");\n }\n }, {\n controlType: \"sap.ushell.ui.launchpad.ActionItem\"\n })
"}],"href":"api/sap.ushell.services.FrameBoundExtension#methods/createUserAction","code":"createUserAction(controlProperties, parameters?) : Promise "},{"name":"getFloatingContainer","visibility":"restricted","since":"1.124.0","returnValue":{"type":"Promise","description":"The FloatingContainer.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.FrameBoundExtension.FloatingContainer"]}},"description":"Returns the API for the FloatingContainer.
Restriction: NOT available for apps running in an iframe
","href":"api/sap.ushell.services.FrameBoundExtension#methods/getFloatingContainer","code":"getFloatingContainer() : Promise "},{"name":"getSidePane","visibility":"public","since":"1.124.0","returnValue":{"type":"Promise","description":"The SidePane.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.FrameBoundExtension.SidePane"]}},"description":"Returns the API for the SidePane which is located next to the launchpad content.
Restriction: NOT available for apps running in an iframe
","href":"api/sap.ushell.services.FrameBoundExtension#methods/getSidePane","code":"getSidePane() : Promise "},{"name":"getToolArea","visibility":"public","since":"1.124.0","returnValue":{"type":"Promise","description":"The ToolArea.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.FrameBoundExtension.ToolArea"]}},"description":"Returns the API for the ToolArea which is located next to the launchpad content.
Restriction: NOT available for apps running in an iframe
","href":"api/sap.ushell.services.FrameBoundExtension#methods/getToolArea","code":"getToolArea() : Promise "},{"name":"setAvatarImage","visibility":"public","since":"1.151.0","returnValue":{"type":"Promise","description":"A promise that resolves when the image was set.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sImageSrc","optional":true,"description":"
The image src as URI or base64.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Sets the image src for all avatar related spots. The image will not be scoped to the current application, but will be applied through the rest of the user session.
There is no validation on the user image. Ensure before calling this API that you set a valid image.
If called with undefined the ushell defaults will be applied.
","href":"api/sap.ushell.services.FrameBoundExtension#methods/setAvatarImage","code":"setAvatarImage(sImageSrc?) : Promise "}],"displayName":"sap.ushell.services.FrameBoundExtension","nodes":[{"name":"sap.ushell.services.FrameBoundExtension.FloatingContainer","description":"The floating container.
","href":"api/sap.ushell.services.FrameBoundExtension.FloatingContainer"},{"name":"sap.ushell.services.FrameBoundExtension.Footer","description":"The footer extension point is positioned below the launchpad content.
","href":"api/sap.ushell.services.FrameBoundExtension.Footer"},{"name":"sap.ushell.services.FrameBoundExtension.Item","description":"Item wrapping an item positioned in an extension point.
","href":"api/sap.ushell.services.FrameBoundExtension.Item"},{"name":"sap.ushell.services.FrameBoundExtension.SidePane","description":"The side pane extension point is positioned next the launchpad content.
","href":"api/sap.ushell.services.FrameBoundExtension.SidePane"},{"name":"sap.ushell.services.FrameBoundExtension.ToolArea","description":"The tool area extension point is positioned next the launchpad content.
","href":"api/sap.ushell.services.FrameBoundExtension.ToolArea"},{"name":"sap.ushell.services.FrameBoundExtension.UserSettingsEntry","description":"The UserSettingsEntry defines an entry in the user settings dialog.
","href":"api/sap.ushell.services.FrameBoundExtension.UserSettingsEntry"}],"component":"CA-FLP-FE-UI","hasSample":true,"title":"class sap.ushell.services.FrameBoundExtension","subTitle":""},{"kind":"class","name":"sap.ushell.services.FrameBoundExtension.FloatingContainer","basename":"FloatingContainer","resource":"sap/ushell/services/FrameBoundExtension/FloatingContainer.js","module":"sap/ushell/services/FrameBoundExtension/FloatingContainer","export":"","static":true,"visibility":"restricted","since":"1.124.0","extends":"sap.ui.base.ManagedObject","description":"The floating container. To be instantiated by sap.ushell.services.FrameBoundExtension .
Restriction: Does not work when called from within a iframe. The calling function has to be in the 'same frame' as the launchpad itself.
","ui5-metadata":{"stereotype":"object"},"hideconstructor":true,"events":[{"name":"dockingStateUpdate","visibility":"restricted","parameters":[{"name":"oControlEvent","typeInfo":{"UI5Types":["sap.ui.base.Event"]}},{"name":"getSource","optional":false,"depth":1,"phoneName":"oControlEvent.getSource","typeInfo":{"UI5Types":["sap.ui.base.EventProvider"]}},{"name":"getParameters","optional":false,"depth":1,"phoneName":"oControlEvent.getParameters","typeInfo":{"template":"object"}},{"name":"visible","optional":false,"description":"
Indicates whether the floating container is currently visible.
","depth":2,"phoneName":"oControlEvent.getParameters.visible","typeInfo":{"template":"boolean"}},{"name":"docked","optional":false,"description":"
Indicates whether the floating container is currently docked.
","depth":2,"phoneName":"oControlEvent.getParameters.docked","typeInfo":{"template":"boolean"}}],"description":"
Is triggered after the floating container was docked or undocked. Happens either by user drag or by window resize. It might happen that the floating container is undocked while invisible.
"}],"methods":[{"name":"attachDockingStateUpdate","visibility":"restricted","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"oData","optional":true,"description":"
An application-specific payload object that will be passed to the event handler along with the event object when firing the event
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"fnFunction","optional":false,"description":"
The function to be called when the event occurs
","typeInfo":{"template":"function(${0}) : void","UI5Types":["sap.ui.base.Event"]},"defaultValue":""},{"name":"oListener","optional":true,"description":"
Context object to call the event handler with. Defaults to this sap.ushell.services.FrameBoundExtension.FloatingContainer itself
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Attaches event handler fnFunction to the dockingStateUpdate event of this sap.ushell.services.FrameBoundExtension.FloatingContainer.
When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ushell.services.FrameBoundExtension.FloatingContainer itself.
Is triggered after the floating container was docked or undocked. Happens either by user drag or by window resize. It might happen that the floating container is undocked while invisible.
","href":"api/sap.ushell.services.FrameBoundExtension.FloatingContainer#methods/attachDockingStateUpdate","code":"attachDockingStateUpdate(oData?, fnFunction, oListener?) : this "},{"name":"detachDockingStateUpdate","visibility":"restricted","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"fnFunction","optional":false,"description":"
The function to be called, when the event occurs
","typeInfo":{"template":"function(${0}) : void","UI5Types":["sap.ui.base.Event"]},"defaultValue":""},{"name":"oListener","optional":true,"description":"
Context object on which the given function had to be called
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Detaches event handler fnFunction from the dockingStateUpdate event of this sap.ushell.services.FrameBoundExtension.FloatingContainer.
The passed function and listener object must match the ones used for event registration.
","href":"api/sap.ushell.services.FrameBoundExtension.FloatingContainer#methods/detachDockingStateUpdate","code":"detachDockingStateUpdate(fnFunction, oListener?) : this "},{"name":"sap.ushell.services.FrameBoundExtension.FloatingContainer.extend","visibility":"restricted","static":true,"returnValue":{"type":"function","description":"Created class / constructor function
","typeInfo":{"template":"function"}},"parameters":[{"name":"sClassName","optional":false,"description":"
Name of the class being created
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"
Object literal with information about the class
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Creates a new subclass of class sap.ushell.services.FrameBoundExtension.FloatingContainer with name sClassName and enriches it with the information contained in oClassInfo.
oClassInfo might contain the same kind of information as described in sap.ui.base.ManagedObject.extend .
","href":"api/sap.ushell.services.FrameBoundExtension.FloatingContainer#methods/sap.ushell.services.FrameBoundExtension.FloatingContainer.extend","code":"sap.ushell.services.FrameBoundExtension.FloatingContainer.extend(sClassName, oClassInfo?, FNMetaImpl?) : function "},{"name":"fireDockingStateUpdate","visibility":"restricted","returnValue":{"type":"this","description":"Reference to this in order to allow method chaining
","typeInfo":{"template":"this"}},"parameters":[{"name":"mParameters","optional":true,"description":"
Parameters to pass along with the event
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"visible","optional":true,"description":"
Indicates whether the floating container is currently visible.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"mParameters.visible","defaultValue":""},{"name":"docked","optional":true,"description":"
Indicates whether the floating container is currently docked.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"mParameters.docked","defaultValue":""}],"description":"Fires event dockingStateUpdate to attached listeners.
","href":"api/sap.ushell.services.FrameBoundExtension.FloatingContainer#methods/fireDockingStateUpdate","code":"fireDockingStateUpdate(mParameters?) : this "},{"name":"sap.ushell.services.FrameBoundExtension.FloatingContainer.getMetadata","visibility":"restricted","static":true,"returnValue":{"type":"sap.ui.base.ManagedObjectMetadata","description":"Metadata object describing this class
","typeInfo":{"UI5Types":["sap.ui.base.ManagedObjectMetadata"]}},"description":"Returns a metadata object for class sap.ushell.services.FrameBoundExtension.FloatingContainer.
","href":"api/sap.ushell.services.FrameBoundExtension.FloatingContainer#methods/sap.ushell.services.FrameBoundExtension.FloatingContainer.getMetadata","code":"sap.ushell.services.FrameBoundExtension.FloatingContainer.getMetadata() : sap.ui.base.ManagedObjectMetadata "},{"name":"hide","visibility":"restricted","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Hides the floating container.
","href":"api/sap.ushell.services.FrameBoundExtension.FloatingContainer#methods/hide","code":"hide() : this "},{"name":"isDocked","visibility":"restricted","since":"1.124.0","returnValue":{"type":"Promise","description":"Whether the floating container is currently in docked state.
","typeInfo":{"template":"Promise"}},"description":"Checks whether the floating container is docked.
","href":"api/sap.ushell.services.FrameBoundExtension.FloatingContainer#methods/isDocked","code":"isDocked() : Promise "},{"name":"isVisible","visibility":"restricted","since":"1.124.0","returnValue":{"type":"Promise","description":"Whether the floating container is currently visible.
","typeInfo":{"template":"Promise"}},"description":"Checks whether the floating container is docked.
","href":"api/sap.ushell.services.FrameBoundExtension.FloatingContainer#methods/isVisible","code":"isVisible() : Promise "},{"name":"setContent","visibility":"restricted","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"parameters":[{"name":"control","optional":false,"description":"
The actual content of the extension.
","typeInfo":{"UI5Types":["sap.ui.core.Control"]},"defaultValue":""},{"name":"dragSelector","optional":false,"description":"
CSS selector describing the drag handle to enable drag and drop.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Sets the content of the floating container.
","href":"api/sap.ushell.services.FrameBoundExtension.FloatingContainer#methods/setContent","code":"setContent(control, dragSelector) : this "},{"name":"show","visibility":"restricted","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Shows the floating container.
","href":"api/sap.ushell.services.FrameBoundExtension.FloatingContainer#methods/show","code":"show() : this "}],"displayName":"sap.ushell.services.FrameBoundExtension.FloatingContainer","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.FrameBoundExtension.FloatingContainer","subTitle":""},{"kind":"class","name":"sap.ushell.services.FrameBoundExtension.Footer","basename":"Footer","resource":"sap/ushell/services/FrameBoundExtension/Footer.js","module":"sap/ushell/services/FrameBoundExtension/Footer","export":"","static":true,"visibility":"public","since":"1.124.0","description":"The footer extension point is positioned below the launchpad content. To be instantiated by sap.ushell.services.FrameBoundExtension .
Restriction: Does not work when called from within a iframe. The calling function has to be in the 'same frame' as the launchpad itself.
","hideconstructor":true,"methods":[{"name":"destroy","visibility":"public","since":"1.124.0","returnValue":{"type":"Promise","description":"Resolves once the footer was destroyed.
","typeInfo":{"template":"Promise"}},"description":"Destroys the footer.
","href":"api/sap.ushell.services.FrameBoundExtension.Footer#methods/destroy","code":"destroy() : Promise "},{"name":"getControl","visibility":"public","since":"1.124.0","returnValue":{"type":"Promise","description":"The control.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ui.core.Control"]}},"description":"Returns the related control instance.
","href":"api/sap.ushell.services.FrameBoundExtension.Footer#methods/getControl","code":"getControl() : Promise "}],"displayName":"sap.ushell.services.FrameBoundExtension.Footer","component":"CA-FLP-FE-UI","hasSample":true,"title":"class sap.ushell.services.FrameBoundExtension.Footer","subTitle":""},{"kind":"class","name":"sap.ushell.services.FrameBoundExtension.Item","basename":"Item","resource":"sap/ushell/services/FrameBoundExtension/Item.js","module":"sap/ushell/services/FrameBoundExtension/Item","export":"","static":true,"visibility":"public","since":"1.124.0","description":"Item wrapping an item positioned in an extension point. To be instantiated by sap.ushell.services.FrameBoundExtension . sap.ushell.services.Extension.Item#showOnHome or sap.ushell.services.Extension.Item#showForAllApps the item is not destroyed automatically and has to be destroyed manually via sap.ushell.services.Extension.Item#destroy .
Restriction: Does not work when called from within a iframe. The calling function has to be in the 'same frame' as the launchpad itself.
","hideconstructor":true,"methods":[{"name":"destroy","visibility":"public","since":"1.124.0","returnValue":{"type":"Promise","description":"Resolves once the item was destroyed.
","typeInfo":{"template":"Promise"}},"description":"Destroys the item and it's related content.
","href":"api/sap.ushell.services.FrameBoundExtension.Item#methods/destroy","code":"destroy() : Promise "},{"name":"getControl","visibility":"public","since":"1.124.0","returnValue":{"type":"Promise","description":"The control.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ui.core.Control"]}},"description":"Returns the related control instance.
","href":"api/sap.ushell.services.FrameBoundExtension.Item#methods/getControl","code":"getControl() : Promise "},{"name":"hideForAllApps","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Hides the item for all applications. Does not change the visibility of the item for the launchpad \"home\".
","href":"api/sap.ushell.services.FrameBoundExtension.Item#methods/hideForAllApps","code":"hideForAllApps() : this "},{"name":"hideForCurrentApp","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Hides the item for the current application.
","href":"api/sap.ushell.services.FrameBoundExtension.Item#methods/hideForCurrentApp","code":"hideForCurrentApp() : this "},{"name":"hideOnHome","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Hides the item for launchpad \"home\". Does not change the visibility of the item within applications.
","href":"api/sap.ushell.services.FrameBoundExtension.Item#methods/hideOnHome","code":"hideOnHome() : this "},{"name":"showForAllApps","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Shows the item for all applications. Does not change the visibility of the item for the launchpad \"home\".
","href":"api/sap.ushell.services.FrameBoundExtension.Item#methods/showForAllApps","code":"showForAllApps() : this "},{"name":"showForCurrentApp","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Shows the item for the current application. The item will be hidden after the user navigates away from this application. The item will not be added again if the user navigates back to the application. Exception: Apps which are using the keep alive feature. There the visibility is restored together with the app.
","href":"api/sap.ushell.services.FrameBoundExtension.Item#methods/showForCurrentApp","code":"showForCurrentApp() : this "},{"name":"showOnHome","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Shows the item for launchpad \"home\". Does not change the visibility of the item within applications.
","href":"api/sap.ushell.services.FrameBoundExtension.Item#methods/showOnHome","code":"showOnHome() : this "}],"displayName":"sap.ushell.services.FrameBoundExtension.Item","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.FrameBoundExtension.Item","subTitle":""},{"kind":"class","name":"sap.ushell.services.FrameBoundExtension.SidePane","basename":"SidePane","resource":"sap/ushell/services/FrameBoundExtension/SidePane.js","module":"sap/ushell/services/FrameBoundExtension/SidePane","export":"","static":true,"visibility":"public","since":"1.124.0","description":"The side pane extension point is positioned next the launchpad content. To be instantiated by sap.ushell.services.FrameBoundExtension .
Restriction: Does not work when called from within a iframe. The calling function has to be in the 'same frame' as the launchpad itself.
","hideconstructor":true,"methods":[{"name":"createItem","visibility":"public","since":"1.124.0","returnValue":{"type":"Promise","description":"The newly created item.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.FrameBoundExtension.Item"]}},"parameters":[{"name":"controlProperties","optional":false,"description":"
The properties that will be passed to the created control.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"parameters","optional":true,"description":"
Additional parameters.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"controlType","optional":true,"defaultValue":"sap.m.Button","description":"
Defines the controlType of the item.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"parameters.controlType"}],"description":"Creates an item in the side pane.
The controlType can be any control and is by default a sap.m.Button . The controlProperties are passed to the constructor of the control.
","examples":[{"data":"Example: SidePane.createItem({\n id: \"sidePaneContent1\",\n text: \"SidePaneContent Button\",\n press: () => {\n MessageToast.show(\"Press SidePaneContent Button\");\n }\n }, {\n controlType: \"sap.m.Button\"\n });
"}],"href":"api/sap.ushell.services.FrameBoundExtension.SidePane#methods/createItem","code":"createItem(controlProperties, parameters?) : Promise "},{"name":"hideForAllApps","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Hides the side pane for all applications. Does not change the visibility of the side pane for the launchpad \"home\".
","href":"api/sap.ushell.services.FrameBoundExtension.SidePane#methods/hideForAllApps","code":"hideForAllApps() : this "},{"name":"hideOnHome","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Hides the side pane for launchpad \"home\". Does not change the visibility of the side pane within applications.
","href":"api/sap.ushell.services.FrameBoundExtension.SidePane#methods/hideOnHome","code":"hideOnHome() : this "},{"name":"showForAllApps","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Shows the side pane for all applications. Does not change the visibility of the side pane for the launchpad \"home\".
","href":"api/sap.ushell.services.FrameBoundExtension.SidePane#methods/showForAllApps","code":"showForAllApps() : this "},{"name":"showOnHome","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Shows the side pane for launchpad \"home\". Does not change the visibility of the side pane within applications.
","href":"api/sap.ushell.services.FrameBoundExtension.SidePane#methods/showOnHome","code":"showOnHome() : this "}],"displayName":"sap.ushell.services.FrameBoundExtension.SidePane","component":"CA-FLP-FE-UI","hasSample":true,"title":"class sap.ushell.services.FrameBoundExtension.SidePane","subTitle":""},{"kind":"class","name":"sap.ushell.services.FrameBoundExtension.ToolArea","basename":"ToolArea","resource":"sap/ushell/services/FrameBoundExtension/ToolArea.js","module":"sap/ushell/services/FrameBoundExtension/ToolArea","export":"","static":true,"visibility":"public","since":"1.124.0","description":"The tool area extension point is positioned next the launchpad content. To be instantiated by sap.ushell.services.FrameBoundExtension .
Restriction: Does not work when called from within a iframe. The calling function has to be in the 'same frame' as the launchpad itself.
","hideconstructor":true,"methods":[{"name":"createItem","visibility":"public","since":"1.124.0","returnValue":{"type":"Promise","description":"The newly created item.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.FrameBoundExtension.Item"]}},"parameters":[{"name":"controlProperties","optional":false,"description":"
The properties that will be passed to the sap.ushell.ui.shell.ToolAreaItem .
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Creates an item in the tool area.
","examples":[{"data":"Example: ToolArea.createItem({\n id: \"toolAreaItem1\",\n icon: \"sap-icon://documents\",\n text: \"My ToolArea Item 1\",\n expandable: true,\n press: (evt) => {\n MessageToast.show(\"Press toolAreaItem1\");\n },\n expand: (evt) => {\n MessageToast.show(\"Expand toolAreaItem1\");\n }\n });
"}],"references":["{@link sap.ushell.ui.shell.ToolAreaItem} "],"href":"api/sap.ushell.services.FrameBoundExtension.ToolArea#methods/createItem","code":"createItem(controlProperties) : Promise "},{"name":"hideForAllApps","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Hides the tool area for all applications. Does not change the visibility of the tool area for the launchpad \"home\".
","href":"api/sap.ushell.services.FrameBoundExtension.ToolArea#methods/hideForAllApps","code":"hideForAllApps() : this "},{"name":"hideOnHome","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Hides the tool area for launchpad \"home\". Does not change the visibility of the tool area within applications.
","href":"api/sap.ushell.services.FrameBoundExtension.ToolArea#methods/hideOnHome","code":"hideOnHome() : this "},{"name":"showForAllApps","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Shows the tool area for all applications. Does not change the visibility of the tool area for the launchpad \"home\".
","href":"api/sap.ushell.services.FrameBoundExtension.ToolArea#methods/showForAllApps","code":"showForAllApps() : this "},{"name":"showOnHome","visibility":"public","since":"1.124.0","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"description":"Shows the tool area for launchpad \"home\". Does not change the visibility of the tool area within applications.
","href":"api/sap.ushell.services.FrameBoundExtension.ToolArea#methods/showOnHome","code":"showOnHome() : this "}],"displayName":"sap.ushell.services.FrameBoundExtension.ToolArea","component":"CA-FLP-FE-UI","hasSample":true,"title":"class sap.ushell.services.FrameBoundExtension.ToolArea","subTitle":""},{"kind":"class","name":"sap.ushell.services.FrameBoundExtension.UserSettingsEntry","basename":"UserSettingsEntry","resource":"sap/ushell/services/FrameBoundExtension/UserSettingsEntry.js","module":"sap/ushell/services/FrameBoundExtension/UserSettingsEntry","export":"","static":true,"visibility":"public","since":"1.134.0","description":"The UserSettingsEntry defines an entry in the user settings dialog. To be instantiated by sap.ushell.services.FrameBoundExtension .
Restriction: Does not work when called from within an iframe. The calling function has to be in the 'same frame' as the launchpad itself.
","hideconstructor":true,"methods":[{"name":"open","visibility":"public","since":"1.134.0","description":"Opens the user settings entry.
The dialog is opened and then navigated to the new entry. If a group is available, the function navigates to the group and entry (tab).
","href":"api/sap.ushell.services.FrameBoundExtension.UserSettingsEntry#methods/open","code":"open() : void "}],"displayName":"sap.ushell.services.FrameBoundExtension.UserSettingsEntry","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.FrameBoundExtension.UserSettingsEntry","subTitle":""},{"kind":"class","name":"sap.ushell.services.LaunchPage","basename":"LaunchPage","resource":"sap/ushell/services/LaunchPage.js","module":"sap/ushell/services/LaunchPage","export":"","static":true,"visibility":"public","since":"1.15.0","extends":"sap.ushell.services.Service","description":"A service for handling groups, tiles and catalogs.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const LaunchPage = await Container.getServiceAsync(\"LaunchPage\");\n // do something with the LaunchPage service\n });\n The functions that return the main objects are getGroups, getGroupTitle, getCatalogs and getCatalogTiles. Since the implementation (i.e. adapter) is platform specific, do not call or access properties and functions of returned objects. Instead, use other functions of the LaunchPage service with the relevant object as the input parameter.
When using the content extension factory, any extended content needs to refer to the correct adapter with the field \"contentProvider\".
","hideconstructor":true,"methods":[{"name":"addGroup","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves once the group was added.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sTitle","optional":false,"description":"
The title of the new group
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Adds a new group.
Intention: the page builder adds this group to the end of the home screen.
In case of failure it gets the consistent (i.e. persisted) backend state of all groups.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/addGroup","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"addGroup(sTitle) : jQuery.Promise "},{"name":"addGroupAt","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves the group.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sTitle","optional":false,"description":"
The title of the new group
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"iIndex","optional":false,"description":"
the location of the new group
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Adds a new group at a specific location.
Intention: the page builder adds this group to the specific location on the home screen.
In case of error it gets the consistent (i.e. persisted) backend state of all groups.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/addGroupAt","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"addGroupAt(sTitle, iIndex) : jQuery.Promise "},{"name":"addTile","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves once the tile was added.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oCatalogTile","optional":false,"description":"
An 'anonymous' tile from the tile catalog
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"oGroup","optional":true,"description":"
The target group
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Adds a tile to a group.
If no group is provided then the tile is added to the default group.
Intention: the page builder by default puts this tile at the end of the default group. In case of failure it gets the consistent (i.e. persisted) backend state of the default group.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/addTile","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"addTile(oCatalogTile, oGroup?) : jQuery.Promise "},{"name":"getAppBoxPressHandler","visibility":"public","returnValue":{"type":"function","description":"handler for clicking on the tile.
","typeInfo":{"template":"function"}},"parameters":[{"name":"oTile","optional":false,"description":"
The tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the press handler for clicking on a tile.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getAppBoxPressHandler","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getAppBoxPressHandler(oTile) : function "},{"name":"getCatalogData","visibility":"public","since":"1.21.2","returnValue":{"type":"object","description":"An object that includes the following properties (the list may include additional properties):
id: the catalog ID systemId: [remote catalogs] the ID of the remote system remoteId: [remote catalogs] the ID of the catalog in the remote system baseUrl: [remote catalogs] the base URL of the catalog in the remote system ","typeInfo":{"template":"object"}},"parameters":[{"name":"oCatalog","optional":false,"description":"
the catalog
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns catalog's technical data.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogData","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogData(oCatalog) : object "},{"name":"getCatalogError","visibility":"public","since":"1.17.1","returnValue":{"type":"string","description":"The technical error message or undefined if the catalog was loaded properly
","typeInfo":{"template":"string"}},"parameters":[{"name":"oCatalog","optional":false,"description":"
the catalog
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"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!
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogError","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogError(oCatalog) : string "},{"name":"getCatalogId","visibility":"public","returnValue":{"type":"string","description":"Catalog id
","typeInfo":{"template":"string"}},"parameters":[{"name":"oCatalog","optional":false,"description":"
The catalog
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the catalog's unique identifier
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogId","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogId(oCatalog) : string "},{"name":"getCatalogs","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves an array of black-box catalog objects is provided (which might be empty). In case of failure, an error message is passed. Progress notifications are sent for each single catalog, providing a single black-box catalog object each time.
","typeInfo":{"template":"jQuery.Promise"}},"description":"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.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"examples":[{"data":"Example: sap.ushell.Container.getServiceAsync(\"LaunchPage\")\n .then(function (LaunchPage) {\n LaunchPage.getCatalogs()\n .fail(function (sErrorMessage) { // string\n // handle error situation\n })\n .progress(function (oCatalog) { // object\n // do s.th. with single catalog\n })\n .done(function (aCatalogs) { // object[]\n aCatalogs.forEach(function (oCatalog) {\n // do s.th. with single catalog\n });\n });\n });
"}],"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogs","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogs() : jQuery.Promise "},{"name":"getCatalogTileContentProviderId","resource":"sap/ushell/services/FlpLaunchPage.js","module":"sap/ushell/services/FlpLaunchPage","visibility":"public","returnValue":{"type":"string","description":"Tile content provider ID
","typeInfo":{"template":"string"}},"parameters":[{"name":"oTile","optional":false,"description":"
The tile or the catalog tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns catalog tile's content provider ID.
","href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTileContentProviderId","code":"getCatalogTileContentProviderId(oTile) : string "},{"name":"getCatalogTileId","visibility":"public","returnValue":{"type":"string","description":"Tile id
","typeInfo":{"template":"string"}},"parameters":[{"name":"oTile","optional":false,"description":"
The tile or the catalog tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"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.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTileId","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTileId(oTile) : string "},{"name":"getCatalogTileKeywords","visibility":"public","returnValue":{"type":"string[]","description":"The keywords associated with this catalog tile
","typeInfo":{"template":"Array"}},"parameters":[{"name":"oCatalogTile","optional":false,"description":"
The catalog tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the keywords associated with a catalog tile which can be used to find the catalog tile in a search. Note: getCatalogTileViewControl must be called before this method. Otherwise the keywords may be incomplete.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTileKeywords","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTileKeywords(oCatalogTile) : string[] "},{"name":"getCatalogTilePreviewIcon","visibility":"public","since":"1.16.3","returnValue":{"type":"string","description":"Preview icon as URL/URI for the catalog tile's underlying application as provided via the \"preview\" contract
","typeInfo":{"template":"string"}},"parameters":[{"name":"oCatalogTile","optional":false,"description":"
The catalog tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns preview icon for a catalog tile.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTilePreviewIcon","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTilePreviewIcon(oCatalogTile) : string "},{"name":"getCatalogTilePreviewInfo","visibility":"public","since":"1.67.0","returnValue":{"type":"string","description":"The catalog tile info
","typeInfo":{"template":"string"}},"parameters":[{"name":"oCatalogTile","optional":false,"description":"
The catalog tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the catalog tile info
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTilePreviewInfo","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTilePreviewInfo(oCatalogTile) : string "},{"name":"getCatalogTilePreviewSubtitle","visibility":"public","since":"1.40","returnValue":{"type":"string","description":"Preview subtitle for the catalog tile's underlying application as provided via the \"preview\" contract
","typeInfo":{"template":"string"}},"parameters":[{"name":"oCatalogTile","optional":false,"description":"
The catalog tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns preview subtitle for a catalog tile.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTilePreviewSubtitle","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTilePreviewSubtitle(oCatalogTile) : string "},{"name":"getCatalogTilePreviewTitle","visibility":"public","since":"1.16.3","returnValue":{"type":"string","description":"Preview title for the catalog tile's underlying application as provided via the \"preview\" contract
","typeInfo":{"template":"string"}},"parameters":[{"name":"oCatalogTile","optional":false,"description":"
The catalog tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns preview title for a catalog tile.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTilePreviewTitle","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTilePreviewTitle(oCatalogTile) : string "},{"name":"getCatalogTiles","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolve the catalog tiles.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oCatalog","optional":false,"description":"
The catalog
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the tiles of a catalog.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTiles","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTiles(oCatalog) : jQuery.Promise "},{"name":"getCatalogTileSize","visibility":"public","returnValue":{"type":"string","description":"Tile size in units in 1x1 or 1x2 format
","typeInfo":{"template":"string"}},"parameters":[{"name":"oCatalogTile","optional":false,"description":"
The catalog tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the size of a catalog tile as a string. For example: \"1x1\", \"1x2\"
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTileSize","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTileSize(oCatalogTile) : string "},{"name":"getCatalogTileTags","visibility":"public","returnValue":{"type":"string[]","description":"The tags associated with this catalog tile
","typeInfo":{"template":"Array"}},"parameters":[{"name":"oCatalogTile","optional":false,"description":"
The catalog tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the tags associated with a catalog tile which can be used to find the catalog tile in a tag filter.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTileTags","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTileTags(oCatalogTile) : string[] "},{"name":"getCatalogTileTargetURL","visibility":"public","returnValue":{"type":"string","description":"The target URL for the catalog tile's underlying application as provided via the \"preview\" contract
","typeInfo":{"template":"string"}},"parameters":[{"name":"oCatalogTile","optional":false,"description":"
The catalog tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the navigation target URL of a catalog tile.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTileTargetURL","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTileTargetURL(oCatalogTile) : string "},{"name":"getCatalogTileTechnicalAttributes","visibility":"public","returnValue":{"type":"string[]","description":"The technical attributes associated with this catalog tile if this is supported by the adapter implementation
","typeInfo":{"template":"Array"}},"parameters":[{"name":"oCatalogTile","optional":false,"description":"
The catalog tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the technical attributes associated with a catalog tile which can be used define additional tags for apps. Note: getCatalogTileViewControl must be called before this method. Otherwise the technical attributes may be incomplete.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTileTechnicalAttributes","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTileTechnicalAttributes(oCatalogTile) : string[] "},{"name":"getCatalogTileTitle","visibility":"public","returnValue":{"type":"string","description":"Tile title
","typeInfo":{"template":"string"}},"parameters":[{"name":"oCatalogTile","optional":false,"description":"
The catalog tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the catalog tile's title
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTileTitle","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTileTitle(oCatalogTile) : string "},{"name":"getCatalogTileView","visibility":"public","returnValue":{"type":"object","description":"UI5 view or control
","typeInfo":{"template":"object"}},"parameters":[{"name":"oCatalogTile","optional":false,"description":"
The catalog tile
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bPreview","optional":true,"description":"
SAP-internal: Whether the tile should be displayed in preview mode
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Returns the UI5 view or control of a catalog tile
","deprecated":{"since":"1.48","text":"Please use {@link #getCatalogTileViewControl} instead."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTileView","deprecatedText":"Deprecated as of version 1.48. Please use #getCatalogTileViewControl instead.","code":"getCatalogTileView(oCatalogTile, bPreview?) : object "},{"name":"getCatalogTileViewControl","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves the Catalog Tile View
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oCatalogTile","optional":false,"description":"
The catalog tile
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bPreview","optional":true,"description":"
SAP-internal: Whether the tile should be displayed in preview mode
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Returns the UI5 view or control of a catalog tile
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTileViewControl","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTileViewControl(oCatalogTile, bPreview?) : jQuery.Promise "},{"name":"getCatalogTitle","visibility":"public","returnValue":{"type":"string","description":"Catalog title
","typeInfo":{"template":"string"}},"parameters":[{"name":"oCatalog","optional":false,"description":"
The catalog
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the catalog's title
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getCatalogTitle","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getCatalogTitle(oCatalog) : string "},{"name":"getDefaultGroup","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves the default group.
","typeInfo":{"template":"jQuery.Promise"}},"description":"Returns the default group of the user.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getDefaultGroup","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getDefaultGroup() : jQuery.Promise "},{"name":"getGroupId","visibility":"public","returnValue":{"type":"string","description":"Group id
","typeInfo":{"template":"string"}},"parameters":[{"name":"oGroup","optional":false,"description":"
The group whose id is returned
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the unique identifier of the given group
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getGroupId","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getGroupId(oGroup) : string "},{"name":"getGroups","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"A promise that resolves to the list of groups
","typeInfo":{"template":"jQuery.Promise"}},"description":"Returns the groups of the user. The order of the array is the order in which the groups will be displayed to the user.
","deprecated":{"since":"1.99","text":"Alternative for use with {@link sap.ushell.services.Bookmark} is {@link sap.ushell.services.Bookmark#getContentNodes}."},"href":"api/sap.ushell.services.LaunchPage#methods/getGroups","deprecatedText":"Deprecated as of version 1.99. Alternative for use with sap.ushell.services.Bookmark is sap.ushell.services.Bookmark#getContentNodes .","code":"getGroups() : jQuery.Promise "},{"name":"getGroupTiles","visibility":"public","returnValue":{"type":"object[]","description":"The group tiles array
","typeInfo":{"template":"Array"}},"parameters":[{"name":"oGroup","optional":false,"description":"
The group whose tiles are returned
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"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.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getGroupTiles","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getGroupTiles(oGroup) : object[] "},{"name":"getGroupTitle","visibility":"public","returnValue":{"type":"string","description":"group title
","typeInfo":{"template":"string"}},"parameters":[{"name":"oGroup","optional":false,"description":"
The group whose title is returned
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the title of the given group.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getGroupTitle","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getGroupTitle(oGroup) : string "},{"name":"getLinkTiles","visibility":"public","returnValue":{"type":"object[]","description":"The array of link tiles
","typeInfo":{"template":"Array"}},"parameters":[{"name":"oGroup","optional":false,"description":"
The group whose link tiles are returned
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"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.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getLinkTiles","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getLinkTiles(oGroup) : object[] "},{"name":"getTileId","visibility":"public","returnValue":{"type":"string","description":"Tile id
","typeInfo":{"template":"string"}},"parameters":[{"name":"oTile","optional":false,"description":"
The tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the tile's unique identifier
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getTileId","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getTileId(oTile) : string "},{"name":"getTileSize","visibility":"public","returnValue":{"type":"string","description":"tile size in units in 1x1 format
","typeInfo":{"template":"string"}},"parameters":[{"name":"oTile","optional":false,"description":"
The tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the tile size in the format of 1x1 or 1x2 string
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getTileSize","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getTileSize(oTile) : string "},{"name":"getTileTarget","visibility":"public","returnValue":{"type":"string","description":"the tile target
","typeInfo":{"template":"string"}},"parameters":[{"name":"oTile","optional":false,"description":"
the tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"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.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getTileTarget","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getTileTarget(oTile) : string "},{"name":"getTileTitle","visibility":"public","returnValue":{"type":"string","description":"The title
","typeInfo":{"template":"string"}},"parameters":[{"name":"oTile","optional":false,"description":"
The tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the tile's title.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getTileTitle","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getTileTitle(oTile) : string "},{"name":"getTileType","visibility":"public","returnValue":{"type":"string","description":"The type
","typeInfo":{"template":"string"}},"parameters":[{"name":"oTile","optional":false,"description":"
The tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns the tile's type.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getTileType","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getTileType(oTile) : string "},{"name":"getTileView","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves the UI5 view or control of the tile.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oTile","optional":false,"description":"
The tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Returns UI5 view or control of the tile.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/getTileView","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"getTileView(oTile) : jQuery.Promise "},{"name":"isCatalogsValid","visibility":"public","since":"1.16.4","returnValue":{"type":"boolean","description":"true in case the catalogs are still valid; false if not
","typeInfo":{"template":"boolean"}},"description":"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).
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"references":["{@link #getCatalogs} "],"href":"api/sap.ushell.services.LaunchPage#methods/isCatalogsValid","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"isCatalogsValid() : boolean "},{"name":"isGroupFeatured","visibility":"public","returnValue":{"type":"boolean","description":"true if featured; false if not (or as default in case the function was not implemented in the proper adapter).
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"oGroup","optional":false,"description":"
The group to be checked
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Checks if a group was marked as featured (meaning the group is a Fiori 3 featured group).
Returns true if the group is featured and false if not.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/isGroupFeatured","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"isGroupFeatured(oGroup) : boolean "},{"name":"isGroupLocked","visibility":"public","returnValue":{"type":"boolean","description":"true if locked; false if not (or as default in case the function was not implemented in the proper adapter).
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"oGroup","optional":false,"description":"
The group to be checked
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"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.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/isGroupLocked","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"isGroupLocked(oGroup) : boolean "},{"name":"isGroupRemovable","visibility":"public","returnValue":{"type":"boolean","description":"true if removable; false if resettable
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"oGroup","optional":false,"description":"
The group to be checked
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"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.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/isGroupRemovable","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"isGroupRemovable(oGroup) : boolean "},{"name":"moveGroup","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves once the group was moved.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oGroup","optional":false,"description":"
The group to be moved
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"iNewIndex","optional":false,"description":"
The new index for the group
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Moves a group to a new index (i.e. location).
Intention: the page builder already moved the page (visible to the user) and if successful - nothing needs to be done. In case of failure it gets the consistent (i.e. persisted) backend state of all groups.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/moveGroup","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"moveGroup(oGroup, iNewIndex) : jQuery.Promise "},{"name":"moveTile","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves once the tile was moved.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oTile","optional":false,"description":"
a tile instance to be moved. The same object type as the one returned by sap.ushell.services.LaunchPage.getGroupTiles
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"iSourceIndex","optional":false,"description":"
the index in the source group
","typeInfo":{"template":"int"},"defaultValue":""},{"name":"iTargetIndex","optional":false,"description":"
the target group index, in case this parameter is not supplied we assume the move tile is within the source group using iSourceIndex
","typeInfo":{"template":"int"},"defaultValue":""},{"name":"oSourceGroup","optional":false,"description":"
the source group the tile came from
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"oTargetGroup","optional":true,"description":"
The same object type as the one returned by sap.ushell.services.LaunchPage.getGroups the target group the tile will be placed in, in case this parameter is not supplied we assume the move tile is within the source group
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"sNewTileType","optional":true,"description":"
(added with 1.46) The new type of the tile
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Moves a tile within a group or between different groups.
Intention: the page builder already moved the tile.
In case of failure it gets 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
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/moveTile","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"moveTile(oTile, iSourceIndex, iTargetIndex, oSourceGroup, oTargetGroup?, sNewTileType?) : jQuery.Promise "},{"name":"refreshTile","visibility":"public","parameters":[{"name":"oTile","optional":false,"description":"
The tile
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Triggers a refresh action of a tile. Typically this action is related to the value presented in dynamic tiles
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/refreshTile","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"refreshTile(oTile) : void "},{"name":"registerTileActionsProvider","visibility":"public","parameters":[{"name":"fnProvider","optional":false,"description":"
A callback which returns an array of action objects.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"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 @see sap.ushell.services.LaunchPage.getTileActions is called.
Tile actions are additional operations that can be executed on a tile, and can be provided by external providers.
A tile action is an object with the following properties: text, icon and targetURL or a press handler.
Tile actions should be returned immediately without any additional server access in order to avoid delays in rendering the action list in the browser.
","deprecated":{"since":"1.99","text":"Deprecated together with the classic homepage."},"examples":[{"data":"Example: of a tile actions provider callback:\n\n function (oTile){\n return [\n {\n text: \"Some Action\",\n icon: \"sap-icon://action\",\n targetURL: \"#SemanticObject-Action\"\n },\n {\n text: \"Settings\",\n icon: \"sap-icon://action-settings\",\n press: function () {\n //Open settings UI\n }\n }\n ];\n }\n
Use Function.prototype.bind() to determine the callback's this or some of its arguments.
"}],"href":"api/sap.ushell.services.LaunchPage#methods/registerTileActionsProvider","deprecatedText":"Deprecated as of version 1.99. Deprecated together with the classic homepage.","code":"registerTileActionsProvider(fnProvider) : void "},{"name":"removeGroup","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves once the group was removed.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oGroup","optional":false,"description":"
The group to be removed
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"iIndex","optional":false,"description":"
The index of the group to be removed
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Removes a group.
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 it gets the consistent (i.e. persisted) backend state of all groups.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/removeGroup","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"removeGroup(oGroup, iIndex) : jQuery.Promise "},{"name":"removeTile","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves once the tile was removed.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oGroup","optional":false,"description":"
The group from which to remove the tile instance
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"oTile","optional":false,"description":"
The tile instance to remove
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"iIndex","optional":false,"description":"
The tile index
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Removes a tile from a group.
Intention: the page builder has already 'hidden' (or removed) the tile.
In case of failure it gets the consistent (i.e. persisted) backend state of the group.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/removeTile","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"removeTile(oGroup, oTile, iIndex) : jQuery.Promise "},{"name":"resetGroup","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves once the group was reset.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oGroup","optional":false,"description":"
The group to be reset
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"iIndex","optional":false,"description":"
The index of the group to be reset
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"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 failure, or when the given group was created by the user (i.e. can't be reset)- it gets, 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
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/resetGroup","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"resetGroup(oGroup, iIndex) : jQuery.Promise "},{"name":"setGroupTitle","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves once the group title was set.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oGroup","optional":false,"description":"
The group whose title is set
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"sTitle","optional":false,"description":"
The new title of the group
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Sets the title of an existing group.
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 it gets the consistent (i.e. persisted) backend state of the group title, in most cases the old title.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/setGroupTitle","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"setGroupTitle(oGroup, sTitle) : jQuery.Promise "},{"name":"setTileVisible","visibility":"public","parameters":[{"name":"oTile","optional":false,"description":"
The tile
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bNewVisible","optional":false,"description":"
The tile's required visibility state.
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"Sets the tile's visibility state and notifies the tile about the change.
","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"href":"api/sap.ushell.services.LaunchPage#methods/setTileVisible","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","code":"setTileVisible(oTile, bNewVisible) : void "}],"displayName":"sap.ushell.services.LaunchPage","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.LaunchPage","subTitle":"Deprecated in version: 1.99","deprecatedText":"Deprecated as of version 1.99. Deprecated without successor together with the classic homepage."},{"kind":"class","name":"sap.ushell.services.Message","basename":"Message","resource":"sap/ushell/services/Message.js","module":"sap/ushell/services/Message","export":"","static":true,"visibility":"public","since":"1.16.0","extends":"sap.ushell.services.Service","description":"Message service.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const Message = await Container.getServiceAsync(\"Message\");\n // do something with the Message service\n });\n ","hideconstructor":true,"displayName":"sap.ushell.services.Message","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Message","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Please use sap.m.MessageToast , sap.m.MessageBox , or sap.m.Dialog instead."},{"kind":"class","name":"sap.ushell.services.MessageBroker","basename":"MessageBroker","resource":"sap/ushell/services/MessageBroker.js","module":"sap/ushell/services/MessageBroker","export":"","static":true,"visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.72.0","description":"The Unified Shell's MessageBroker service.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const MessageBroker = await Container.getServiceAsync(\"MessageBroker\");\n // do something with the MessageBroker service\n });\n ","hideconstructor":true,"methods":[{"name":"addAcceptedOrigin","visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","parameters":[{"name":"sOrigin","optional":false,"description":"
The iframe origin (e.g https://www.example.com:443)
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Adds the iframe origin to the list of accepted origins. The port is automatically added based on the protocol (HTTP/HTTPS).
","href":"api/sap.ushell.services.MessageBroker#methods/addAcceptedOrigin","code":"addAcceptedOrigin(sOrigin) : void "},{"name":"connect","visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","returnValue":{"type":"Promise","description":"Resolves once the client is connected.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sClientId","optional":false,"description":"
client id.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"fnClientConnectionCallback","optional":false,"description":"
Callback function that is called whenever the client subscribes or unsubscribes to a channel.
","typeInfo":{"UI5Types":["sap.ushell.services.MessageBroker.ClientConnectionCallback"]},"defaultValue":""}],"description":"Connects the client to the message broker. When the client connects, it will receive the information about all other clients that are already subscribed to channels. Additionally, the client is informed about _any_ new subscription and unsubscription to a channel.
","href":"api/sap.ushell.services.MessageBroker#methods/connect","code":"connect(sClientId, fnClientConnectionCallback) : Promise "},{"name":"disconnect","visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","returnValue":{"type":"Promise","description":"Resolves once the client is disconnected.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sClientId","optional":false,"description":"
client id.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Disconnects the client. If the client was subscribed to channels, it will be unsubscribed from all channels.
","href":"api/sap.ushell.services.MessageBroker#methods/disconnect","code":"disconnect(sClientId) : Promise "},{"name":"getAcceptedOrigins","visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","returnValue":{"type":"string[]","description":"The list of accepted origins.
","typeInfo":{"template":"Array"}},"description":"Returns the current list of accepted origins.
","href":"api/sap.ushell.services.MessageBroker#methods/getAcceptedOrigins","code":"getAcceptedOrigins() : string[] "},{"name":"publish","visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","returnValue":{"type":"Promise","description":"Resolves once the message is published successfully.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sChannelId","optional":false,"description":"
channel id.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sClientId","optional":false,"description":"
The client id of the sender.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sMessageId","optional":false,"description":"
DEPRECATED since 1.141.0 Should not be provided.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sMessageName","optional":false,"description":"
message name. Can be used to identify the message type or as a topic.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"vTargetClientIds","optional":false,"description":"
list of target client ids. Can include the wildcard \"*\" to send the message to all clients subscribed to the channel. If the wildcard is used, the other client ids are ignored.
","typeInfo":{"template":"Array | ${0}","UI5Types":["sap.ushell.services.MessageBroker.ClientAlias.AllClients"]},"defaultValue":""},{"name":"oData","optional":false,"description":"
additional data.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Publishes a message to a channel. All clients that are subscribed to the channel will receive the message. The message is NOT sent to the client that published it.
","href":"api/sap.ushell.services.MessageBroker#methods/publish","code":"publish(sChannelId, sClientId, sMessageId, sMessageName, vTargetClientIds, oData) : Promise "},{"name":"removeAcceptedOrigin","visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","parameters":[{"name":"sOrigin","optional":false,"description":"
The iframe origin (e.g https://www.example.com:443)
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Removes the iframe origin from the list of accepted origins. Also removes the origin with or without port based on the protocol (HTTP/HTTPS).
","href":"api/sap.ushell.services.MessageBroker#methods/removeAcceptedOrigin","code":"removeAcceptedOrigin(sOrigin) : void "},{"name":"subscribe","visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","returnValue":{"type":"Promise","description":"Resolves once the client is subscribed to the channels.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sClientId","optional":false,"description":"
client id.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"aSubscribedChannels","optional":false,"description":"
array of channel-objects.
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.services.MessageBroker.Channel"]},"defaultValue":""},{"name":"fnMessageCallback","optional":false,"description":"
Callback function that is called whenever a message is published to subscribed channels. The message callback is overwritten on subsequent calls to subscribe. Every channel can has its own message callback.
","typeInfo":{"UI5Types":["sap.ushell.services.MessageBroker.MessageCallback"]},"defaultValue":""},{"name":"fnClientConnectionCallback","optional":false,"description":"
DEPRECATED since 1.141.0 Should be provided as part of #connect .
","typeInfo":{"UI5Types":["sap.ushell.services.MessageBroker.ClientConnectionCallback"]},"defaultValue":""}],"description":"Subscribe to a channel. Before subscribing, the client must be connected. Afterwards, the client receives messages for the subscribed channels.
","href":"api/sap.ushell.services.MessageBroker#methods/subscribe","code":"subscribe(sClientId, aSubscribedChannels, fnMessageCallback, fnClientConnectionCallback) : Promise "},{"name":"unsubscribe","visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","returnValue":{"type":"Promise","description":"Resolves once the client is unsubscribed from the channels.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sClientId","optional":false,"description":"
client id.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"aUnsubscribedChannels","optional":false,"description":"
channels to unsubscribe from.
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.services.MessageBroker.Channel"]},"defaultValue":""}],"description":"Unsubscribes the client from the specified channels.
","href":"api/sap.ushell.services.MessageBroker#methods/unsubscribe","code":"unsubscribe(sClientId, aUnsubscribedChannels) : Promise "}],"displayName":"sap.ushell.services.MessageBroker","nodes":[{"name":"sap.ushell.services.MessageBroker.Channel","description":"","href":"api/sap.ushell.services.MessageBroker.Channel"},{"name":"sap.ushell.services.MessageBroker.ClientAlias","description":"","href":"api/sap.ushell.services.MessageBroker.ClientAlias"},{"name":"sap.ushell.services.MessageBroker.ClientConnectionCallback","description":"","href":"api/sap.ushell.services.MessageBroker.ClientConnectionCallback"},{"name":"sap.ushell.services.MessageBroker.ClientConnectionMessage","description":"","href":"api/sap.ushell.services.MessageBroker.ClientConnectionMessage"},{"name":"sap.ushell.services.MessageBroker.MessageCallback","description":"","href":"api/sap.ushell.services.MessageBroker.MessageCallback"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.MessageBroker","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.MessageBroker.Channel","basename":"Channel","resource":"sap/ushell/services/MessageBroker.js","module":"sap/ushell/services/MessageBroker","static":true,"visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","returnValue":{"type":"object"},"parameters":[{"name":"channelId","type":"string","optional":false,"description":"channel id."}],"displayName":"sap.ushell.services.MessageBroker.Channel","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.MessageBroker.Channel","subTitle":""},{"kind":"enum","name":"sap.ushell.services.MessageBroker.ClientAlias","basename":"ClientAlias","resource":"sap/ushell/services/MessageBroker/ClientAlias.js","module":"sap/ushell/services/MessageBroker/ClientAlias","export":"","static":true,"visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","properties":[{"name":"sap.ushell.services.MessageBroker.ClientAlias.AllClients","value":"*","visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","description":"Wildcard '*' which refers to all clients in a channel
"},{"name":"sap.ushell.services.MessageBroker.ClientAlias.FLP","value":"FLP","visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.141.0","description":"The FLP client
"}],"displayName":"sap.ushell.services.MessageBroker.ClientAlias","component":"CA-FLP-FE-UI","hasSample":false,"title":"enum sap.ushell.services.MessageBroker.ClientAlias","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.MessageBroker.ClientConnectionCallback","basename":"ClientConnectionCallback","resource":"sap/ushell/services/MessageBroker.js","module":"sap/ushell/services/MessageBroker","static":true,"visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","returnValue":{"type":"function"},"parameters":[{"name":"sMessageName","type":"sap.ushell.services.MessageBroker.ClientConnectionMessage","optional":false,"description":"The message name."},{"name":"sClientId","type":"string","optional":false,"description":"The client id."},{"name":"aSubscribedChannels","type":"sap.ushell.services.MessageBroker.Channel[]","optional":false,"description":"The channels the client is subscribed to."}],"displayName":"sap.ushell.services.MessageBroker.ClientConnectionCallback","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.MessageBroker.ClientConnectionCallback","subTitle":""},{"kind":"enum","name":"sap.ushell.services.MessageBroker.ClientConnectionMessage","basename":"ClientConnectionMessage","resource":"sap/ushell/services/MessageBroker/ClientConnectionMessage.js","module":"sap/ushell/services/MessageBroker/ClientConnectionMessage","export":"","static":true,"visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","properties":[{"name":"sap.ushell.services.MessageBroker.ClientConnectionMessage.ClientSubscribed","value":"clientSubscribed","visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","description":"Emitted when a client subscribes to a channel.
"},{"name":"sap.ushell.services.MessageBroker.ClientConnectionMessage.ClientUnsubscribed","value":"clientUnsubscribed","visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","description":"Emitted when a client unsubscribes from a channel.
"}],"displayName":"sap.ushell.services.MessageBroker.ClientConnectionMessage","component":"CA-FLP-FE-UI","hasSample":false,"title":"enum sap.ushell.services.MessageBroker.ClientConnectionMessage","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.MessageBroker.MessageCallback","basename":"MessageCallback","resource":"sap/ushell/services/MessageBroker.js","module":"sap/ushell/services/MessageBroker","static":true,"visibility":"restricted","allowedFor":["SAP internally public"],"since":"1.110.0","returnValue":{"type":"function"},"parameters":[{"name":"sClientId","type":"string","optional":false,"description":"The client id of the sender."},{"name":"sChannelId","type":"string","optional":false,"description":"The channel id."},{"name":"sMessageName","type":"string","optional":false,"description":"The message name."},{"name":"oData","type":"object","optional":false,"description":"The data of the message."}],"displayName":"sap.ushell.services.MessageBroker.MessageCallback","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.MessageBroker.MessageCallback","subTitle":""},{"kind":"class","name":"sap.ushell.services.Navigation","basename":"Navigation","resource":"sap/ushell/services/Navigation.js","module":"sap/ushell/services/Navigation","export":"","static":true,"visibility":"public","since":"1.120.0","extends":"sap.ushell.services.Service","description":"The Unified Shell's Navigation service. Allows navigating to \"external\" targets outside of the currently running app (but still in scope of the current Fiori launchpad) or to create links to such external targets.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const Navigation = await Container.getServiceAsync(\"Navigation\");\n // do something with the Navigation service\n });\n The Navigation service currently provides platform independent functionality.
The service is meant to be used by applications, plugins and shell components.
Usage:
\n const sHref = await Navigation.getHref({\n target : {\n semanticObject: \"Product\",\n action: \"display\"\n },\n params: {\n \"ProductID\": \"102343333\"\n }\n }, oComponent);\n // do something with the resolved sHref.\n Parameter names and values are case sensitive.
Note that the usage of multi-valued parameters (specifying an array with more than one member as parameter value, e.g. params : { A : [\"a1\", \"a2\"] }) is possible with this API but strongly discouraged . Depending on the used platform / back-end implementation the target matching might not support multi-value parameters. Furthermore, it is not guaranteed that additional parameter values specified in the back-end configuration are merged with parameter values passed via the Navigation service.
Note that the application parameter length (including SemanticObject/Action) shall not exceed 512 bytes when serialized as UTF-8.
Note that when receiving the values as startup parameters (as part of the component data object) single values are represented as an array of size 1. Above example is returned as deepEqual(getComponentData().startupParameters , { \"ProductID\" : [ \"102343333\" ] } )
Make sure not to store sensitive data within an URL. URLs may appear in a server log, be persisted inside and outside the system.
Note: When constructing large URLs, the URLs may be shortened and persisted on a database server for prolonged time, the actual data is persisted under a key accessible to any User (guessing the key).
The same restrictions apply for the Application state.
","hideconstructor":true,"methods":[{"name":"backToPreviousApp","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"A promise which resolves once the back navigation was triggered
","typeInfo":{"template":"Promise"}},"description":"Attempts to use the browser history to navigate to the previous app.
A navigation to the Fiori launchpad Home is performed when this method is called on a first navigation. In all other cases, this function simply performs a browser back navigation.
Note that the behavior of this method is subject to change and therefore it may not yield to the expected results especially on mobile devices where \"back\" is the previous inner-app state if these are put into the history!
","href":"api/sap.ushell.services.Navigation#methods/backToPreviousApp","code":"backToPreviousApp() : Promise "},{"name":"createEmptyAppState","visibility":"restricted","allowedFor":["SAP-internally public","must not be changed. Not part of public documentation."],"since":"1.120.0","returnValue":{"type":"Promise","description":"A Promise resolving the app state container.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.AppState.AppState"]}},"parameters":[{"name":"oAppComponent","optional":false,"description":"
A UI5 component used as context for the app state.
","typeInfo":{"UI5Types":["sap.ui.core.Component"]},"defaultValue":""},{"name":"bTransientEnforced","optional":false,"description":"
If set to true the appstate is not persisted on the backend. If set to false or undefined the persistency location is determined by the global ushell configuration.
","typeInfo":{"template":"boolean"},"defaultValue":""},{"name":"sPersistencyMethod","optional":false,"description":"
See sap/ushell/services/appstate/AppStatePersistencyMethod for possible values. Support depends on the used platform.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oPersistencySettings","optional":false,"description":"
Persistency settings.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Creates an empty app state object which acts as a parameter container for navigation.
","href":"api/sap.ushell.services.Navigation#methods/createEmptyAppState","code":"createEmptyAppState(oAppComponent, bTransientEnforced, sPersistencyMethod, oPersistencySettings) : Promise "},{"name":"getAppState","visibility":"restricted","allowedFor":["SAP-internally public","must not be changed. Not part of public documentation."],"since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves the app state object. Note: that this is an unmodifiable container and its data must be copied into a writable container!
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.AppState.AppState"]}},"parameters":[{"name":"oAppComponent","optional":false,"description":"
UI5 component, key will be extracted from component data
","typeInfo":{"UI5Types":["sap.ui.core.Component"]},"defaultValue":""},{"name":"sAppStateKey","optional":false,"description":"
the application state key.
","typeInfo":{"template":"object | string"},"defaultValue":""}],"description":"Get an app state object given a key. A lookup for a cross user app state will be performed.
","href":"api/sap.ushell.services.Navigation#methods/getAppState","code":"getAppState(oAppComponent, sAppStateKey) : Promise "},{"name":"getAppStateData","visibility":"restricted","allowedFor":["SAP-internally public","must not be changed. Not part of public documentation. (exposure to WebDynpro ABAP)"],"since":"1.120.0","returnValue":{"type":"Promise","description":"A promise resolving the list of AppState data. Defaults empty object when the AppState could not be retrieved.
This is interface exposed to platforms who need a serializable form of the application state data
","typeInfo":{"template":"Promise>"}},"parameters":[{"name":"aAppStateKeys","optional":false,"description":"
An array of AppState keys.
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Get data of an AppStates data given a key. A lookup for a cross user app state will be performed.
","href":"api/sap.ushell.services.Navigation#methods/getAppStateData","code":"getAppStateData(aAppStateKeys) : Promise "},{"name":"getHref","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"A Promise resolving the encoded href.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oTarget","optional":true,"description":"
The navigation target to transform. When omitted the current hash is used as basis for the calculation.
","typeInfo":{"UI5Types":["sap.ushell.services.Navigation.Target"],"refersToTypedef":true},"defaultValue":""},{"name":"oComponent","optional":true,"description":"
A UI5 component, used to logically attach any related app state.
","typeInfo":{"UI5Types":["sap.ui.core.Component"]},"defaultValue":""}],"description":"Returns a promise resolving to a URL that launches an app with certain parameters. This API can be used to convert the internal shell hash format into the URL format for use in link tags. The resulting href is fully encoded and cannot be used in other APIs expecting the internal decoded hash.
\n const sHref = await Navigation.getHref({\n target: { shellHash: oLink.intent }\n }, oComponent);\n // do something with the resolved sHref.\n This API accepts a sap-xapp-state-data parameter that can be used generate a url that can be used to launch an app with certain data, for example:
\n {\n target : { semanticObject : \"AnObject\", action: \"action\" },\n params : { \"sap-xapp-state-data\" : JSON.stringify({ a: \"b\", c: \"d\" }) }\n }\n Using the arguments as in the example above, a link with a sap-xapp-state parameter that encodes the provided data is returned. The sap-xapp-state-data parameter does not appear in the generated link.Do not use \"#Shell-home\" to navigate to a specific homepage!getHref( { target : { shellHash : \"#\" }})
","href":"api/sap.ushell.services.Navigation#methods/getHref","code":"getHref(oTarget?, oComponent?) : Promise "},{"name":"getLinks","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"A promise that resolves an array with a list for each filter containing the matched links. Note: The intent is in a internal format and cannot be directly put into a link tag. If you want to use it directly you have to transform it first into a href.
\n const sHref = await NavigationService.getHref({ target: { shellHash: oLink.intent} }, oComponent);\n ","typeInfo":{"template":"Promise>>","UI5Types":["sap.ushell.services.Navigation.Link"]}},"parameters":[{"name":"aLinkFilter","optional":true,"defaultValue":"[]","description":"
A list of target filters.
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.services.Navigation.LinkFilter"]}}],"description":"Resolves the given filters to a list of links available to the user.
","href":"api/sap.ushell.services.Navigation#methods/getLinks","code":"getLinks(aLinkFilter?) : Promise "},{"name":"getPrimaryIntent","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"A promise resolving a link matching the 'primaryAction' tag.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.Navigation.Link"]}},"parameters":[{"name":"sSemanticObject","optional":false,"description":"
The semantic object.
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oLinkFilter","optional":true,"description":"
A target filter.
","typeInfo":{"UI5Types":["sap.ushell.services.Navigation.LinkFilter"],"refersToTypedef":true},"defaultValue":""}],"description":"For a given semantic object, this method considers all actions associated with the semantic object and returns the one tagged as a \"primaryAction\".
The primary intent is determined by querying sap.ushell.services.Navigation#getLinks with the given semantic object and optional parameter.
","href":"api/sap.ushell.services.Navigation#methods/getPrimaryIntent","code":"getPrimaryIntent(sSemanticObject, oLinkFilter?) : Promise "},{"name":"getSemanticObjects","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"A promise that resolves with an array of strings representing the semantic objects of the intents the current user can navigate to, or rejects with an error message. The returned array will not contain duplicates. Note: the caller should not rely on the specific order the semantic objects appear in the returned array.
","typeInfo":{"template":"Promise>"}},"description":"Returns a list of semantic objects of the intents the current user can navigate to.
","href":"api/sap.ushell.services.Navigation#methods/getSemanticObjects","code":"getSemanticObjects() : Promise "},{"name":"getStartupAppState","visibility":"restricted","allowedFor":["SAP-internally public","must not be changed. Not part of public documentation."],"since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves the app state object. Note that this is an unmodifiable container and its data must be copied into a writable container!
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.AppState.AppState"]}},"parameters":[{"name":"oAppComponent","optional":false,"description":"
UI5 component, key will be extracted from component data.
","typeInfo":{"UI5Types":["sap.ui.core.Component"]},"defaultValue":""}],"description":"Get the app state object that was used for the current navigation
","href":"api/sap.ushell.services.Navigation#methods/getStartupAppState","code":"getStartupAppState(oAppComponent) : Promise "},{"name":"historyBack","visibility":"public","since":"1.120.0","parameters":[{"name":"iSteps","optional":true,"defaultValue":1,"description":"
positive integer representing the steps to go back in the history
","typeInfo":{"template":"int"}}],"description":"Navigates back in history the number of given steps if this is supported by the underlying platform. If no argument is provided it will navigate back 1 step.
","href":"api/sap.ushell.services.Navigation#methods/historyBack","code":"historyBack(iSteps?) : void "},{"name":"isInitialNavigation","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"This promise resolves with a boolean indicating if the current navigation is considered initial
","typeInfo":{"template":"Promise"}},"description":"Checks whether the FLP has performed the first navigation. This method can be used to detect whether the current app was started directly, that is, without a previous navigation to another app, to the FLP home, or another target that adds an entry in the browser history.
","href":"api/sap.ushell.services.Navigation#methods/isInitialNavigation","code":"isInitialNavigation() : Promise "},{"name":"isNavigationSupported","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise>","description":"A promise that resolves to an array of objects indicating whether the intent is supported or not. Each object has a property supported of type boolean.
","typeInfo":{"template":"Promise>"}},"parameters":[{"name":"aTargets","optional":false,"description":"
A list of navigation targets to be checked.
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.services.Navigation.Target"]},"defaultValue":""},{"name":"oComponent","optional":true,"description":"
The root component of the application.
","typeInfo":{"UI5Types":["sap.ui.core.Component"]},"defaultValue":""}],"description":"Calculates whether the given navigation targets are supported for the given parameters, form factor etc. . \"Supported\" means that a valid navigation target is configured for the user and for the given device.
isNavigationSupported is a test function for sap.ushell.services.Navigation#navigate and sap.ushell.services.Navigation#getHref .
Example usage:
\n const aResult = await oNavigationService.isNavigationSupported([{\n target: { shellHash: \"SalesOrder-approve?SOId=1234\" }\n }])\n if (aResult[0].supported===true){\n // enable link\n }\n else {\n // disable link\n }\n ","href":"api/sap.ushell.services.Navigation#methods/isNavigationSupported","code":"isNavigationSupported(aTargets, oComponent?) : Promise> "},{"name":"navigate","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"A Promise resolving once the navigation was triggered. The Promise might never reject or resolve when an error occurs during the navigation.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oTarget","optional":false,"description":"
The navigation target.
","typeInfo":{"UI5Types":["sap.ushell.services.Navigation.Target"],"refersToTypedef":true},"defaultValue":""},{"name":"oComponent","optional":true,"description":"
A UI5 component, used to logically attach any related app state.
","typeInfo":{"UI5Types":["sap.ui.core.Component"]},"defaultValue":""}],"description":"Triggers a navigation to a specified target outside of the currently running application (e.g. different launchpad application). Invocation will trigger a hash change and subsequent invocation of the target.
If the navigation target opens in a new window the running application may be retained.
This API accepts a sap-xapp-state-data parameter that can be used generate a url that can be used to launch an app with certain data, for example:
\n {\n target : { semanticObject : \"AnObject\", action: \"action\" },\n params : { \"sap-xapp-state-data\" : JSON.stringify({ a: \"b\", c: \"d\" }) }\n }\n Using the arguments as in the example above, a link with a sap-xapp-state parameter that encodes the provided data is returned. The sap-xapp-state-data parameter does not appear in the generated link.Do not use \"#Shell-home\" to navigate to a specific homepage!navigate( { target : { shellHash : \"#\" }})
","href":"api/sap.ushell.services.Navigation#methods/navigate","code":"navigate(oTarget, oComponent?) : Promise "},{"name":"resolveIntent","visibility":"protected","since":"1.120.0","returnValue":{"type":"Promise<{url:string}>","description":"A Promise resolving the intent.
","typeInfo":{"template":"Promise<{url:string}>"}},"parameters":[{"name":"sHashFragment","optional":false,"description":"
The formatted URL hash fragment in internal format (as obtained by the SAPUI5 hasher service) not as given in location.hash)! Example: #SemanticObject-action?P1=V1&P2=A%20B%20C
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Resolves the URL hash fragment. This function gets the hash part of the URL and returns the URL of the target application.
","href":"api/sap.ushell.services.Navigation#methods/resolveIntent","code":"resolveIntent(sHashFragment) : Promise<{url:string}> "},{"name":"saveAppStates","visibility":"restricted","allowedFor":["SAP-internally public","must not be changed. Not part of public documentation. (exposure to WebDynpro ABAP)"],"since":"1.120.0","returnValue":{"type":"Promise","description":"A Promise, in case of success an array of individual save promise objects is returned as argument in case of a reject, individual responses are not available
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"aAppStates","optional":false,"description":"
Array of application States
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"persist multiple app states (in future potentially batched in a single roundtrip)
","href":"api/sap.ushell.services.Navigation#methods/saveAppStates","code":"saveAppStates(aAppStates) : Promise "}],"displayName":"sap.ushell.services.Navigation","nodes":[{"name":"sap.ushell.services.Navigation.Link","description":"Optional properties may not be present in the link.
","href":"api/sap.ushell.services.Navigation.Link"},{"name":"sap.ushell.services.Navigation.LinkFilter","description":"","href":"api/sap.ushell.services.Navigation.LinkFilter"},{"name":"sap.ushell.services.Navigation.Target","description":"A target describing the intent: #-?&/ Note: The intent shall not exceed 512 bytes when serialized as UTF-8.
","href":"api/sap.ushell.services.Navigation.Target"},{"name":"sap.ushell.services.Navigation.TargetIntent","description":"The target intent.\n
","href":"api/sap.ushell.services.Navigation.TargetIntent"},{"name":"sap.ushell.services.Navigation.TargetIntentStrict","description":"The target intent in strict format.
","href":"api/sap.ushell.services.Navigation.TargetIntentStrict"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Navigation","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.Navigation.Link","basename":"Link","resource":"sap/ushell/services/Navigation.js","module":"sap/ushell/services/Navigation","static":true,"visibility":"public","description":"
Optional properties may not be present in the link.
","properties":[{"name":"intent","optional":false,"visibility":"public","description":"The intent: for example \"#AnObject-Action?A=B&C=e&C=j\" Note: The intent is in a internal format and cannot be directly put into a link tag.
","typeInfo":{"template":"string"}},{"name":"text","optional":false,"visibility":"public","description":"The title of the link.
","typeInfo":{"template":"string"}},{"name":"icon","optional":true,"visibility":"public","description":"A URI to the icon: for example \"sap-icon://Fiori2/F0018\".
","typeInfo":{"UI5Types":["sap.ui.core.URI"]}},{"name":"subTitle","optional":true,"visibility":"public","description":"The short title of the link.
","typeInfo":{"template":"string"}},{"name":"shortTitle","optional":true,"visibility":"public","description":"The short title of the link.
","typeInfo":{"template":"string"}},{"name":"tags","optional":true,"visibility":"public","description":"The list of tags.
","typeInfo":{"template":"Array"}}],"displayName":"sap.ushell.services.Navigation.Link","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.Navigation.Link","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.Navigation.LinkFilter","basename":"LinkFilter","resource":"sap/ushell/services/Navigation.js","module":"sap/ushell/services/Navigation","static":true,"visibility":"public","properties":[{"name":"semanticObject","optional":true,"visibility":"public","description":"Matches the semantic object of a link.
","typeInfo":{"template":"string"}},{"name":"action","optional":true,"visibility":"public","description":"Matches the action object of a link.
","typeInfo":{"template":"string"}},{"name":"params","optional":true,"visibility":"public","description":"Matches the parameters of a link.
Simple format:
\n{\n P1: \"B\",\n P2: [\"e\", \"j\"]\n}\n
Extended format:
\n {\n P1: { value: \"v1\" },\n P2: { value: [\"v2\", \"v3\"] },\n P3: { value: \"v4\", required: true }\n }\n required: Whether the parameter is be required (true) or not (false) in the signature of the matching target. Note that this option is only effective on platforms using the sap.ushell.services.ClientSideTargetResolution
","typeInfo":{"template":"object"}},{"name":"withAtLeastOneUsedParam","optional":true,"visibility":"public","description":"If true, matches only links that use at least one (non sap-) parameter from 'params'.
","typeInfo":{"template":"boolean"}},{"name":"sortResultsBy","optional":true,"visibility":"public","description":"How the matching links should be sorted. Possible Values:
\"intent\" lexicographical sort on returned 'intent' field \"text\" lexicographical sort on returned 'text' field \"priority\" top intents are returned first ","typeInfo":{"template":"string"}},{"name":"treatTechHintAsFilter","optional":true,"visibility":"public","description":"If true, only apps that match exactly the supplied technology (for example sap-ui-tech-hint=WDA) will be considered.
","typeInfo":{"template":"boolean"}},{"name":"ui5Component","optional":false,"visibility":"public","description":"The UI5 component invoking the service, shall be a root component.
","typeInfo":{"UI5Types":["sap.ui.core.Component"]}},{"name":"appStateKey","optional":true,"visibility":"public","description":"SAP internal usage only Application state key to add to the generated links.
","typeInfo":{"template":"string"}},{"name":"compactIntents","optional":true,"visibility":"public","description":"Whether intents should be returned in compact format.
","typeInfo":{"template":"boolean"}},{"name":"tags","optional":true,"visibility":"public","description":"Matches only links which match an inbound with certain tags.
","typeInfo":{"template":"Array"}}],"displayName":"sap.ushell.services.Navigation.LinkFilter","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.Navigation.LinkFilter","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.Navigation.Target","basename":"Target","resource":"sap/ushell/services/Navigation.js","module":"sap/ushell/services/Navigation","static":true,"visibility":"public","description":"
A target describing the intent: #-?&/ Note: The intent shall not exceed 512 bytes when serialized as UTF-8.
","properties":[{"name":"target","optional":true,"visibility":"public","description":"Defaults to current hash. Note that the only the appSpecificRoute will be considered when target is omitted.
","typeInfo":{"template":"object"}},{"name":"semanticObject","optional":true,"description":"
The semanticObject part of the intent.
","visibility":"public","depth":1,"phoneName":"target.semanticObject","typeInfo":{"template":"string"}},{"name":"action","optional":true,"description":"
The action part of the intent.
","visibility":"public","depth":1,"phoneName":"target.action","typeInfo":{"template":"string"}},{"name":"shellHash","optional":true,"description":"
The entire intent including parameters and appSpecificRoute. Note: If set all other parameters are ignored. Note: While parameters need to be url-encoded once when used in the shellHash the app specific route must not be encoded.
","visibility":"public","depth":1,"phoneName":"target.shellHash","typeInfo":{"template":"string"}},{"name":"params","optional":true,"visibility":"public","description":"The parameters of the target
Simple format:
\n{\n P1: \"B\",\n P2: [\"e\", \"j\"]\n}\n
Extended format:
\n{\n P1: { value: \"v1\" },\n P2: { value: [\"v2\", \"v3\"] }\n}\n
Note: Parameter values can contain special characters and must be provided unencoded. The APIs takes care of the necessary encodings.
","typeInfo":{"template":"object"}},{"name":"appSpecificRoute","optional":true,"visibility":"public","description":"The appSpecificRoute without the '&/' prefix.
","typeInfo":{"template":"string"}},{"name":"processParams","optional":true,"visibility":"public","description":"Wether the parameter provided in params should be applied or ignored. Parameters already set by the shellHash are ignored.
","typeInfo":{"template":"boolean"}}],"displayName":"sap.ushell.services.Navigation.Target","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.Navigation.Target","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.Navigation.TargetIntent","basename":"TargetIntent","resource":"sap/ushell/services/Navigation.js","module":"sap/ushell/services/Navigation","static":true,"visibility":"public","since":"1.121.0","description":"
The target intent.
Navigation is encoded in the fragment identifier of the URL within FLPthe URL has to be a valid intent, i.e. in the format \"#SO-Action?P1=a&P2=x&/route?RPV=1\". The generic syntax consists of the semantic object, the action and an optional part:
Intent = \"#\" semanticObject \"-\" action [\"?\" intentParameters \"&/\" innerAppRoute + \"?\" + innerAppRouteParameters] The intent comprises of the following parts: semanticObject: Semantic object as defined in an app launcher tile. The following characters are allowed: uppercase letters [A-Z], lowercase letters [a-z], numbers [0-9]. The first character must be an uppercase or lowercase letter. The length of the semantic object is limited to 30 characters.
action: Action as defined in an app launcher tile. For the action name, choose a verb or a short phrase starting with lower case and without blanks. Examples are display, create, or release. The following characters are allowed: uppercase letters [A-Z], lowercase letters [a-z], numbers [0-9] and underscores [_]. The first character must be an uppercase or lowercase letter or an underscore. The length of the action is limited to 50 characters. intentParameters: Intent parameters are optional parameters. The parameters are separated by the ampersand character (&). The parameter name and value are separated by the equal sign (=). The parameter value must be URL-encoded. When navigating via Intent Based Navigation (IBN) the intent parameters are used to determine the target application. innerAppRoute: The inner app route is an optional parameter that is used to navigate within the target application. The inner app route is separated from the intent parameters by the \"&/\". innerAppRouteParameters: The inner app route parameters are optional parameters that are passed to the target application. The parameters are separated by the ampersand character (&). The parameter name and value are separated by the equal sign (=). The parameter value must be URL-encoded. ","type":"string","displayName":"sap.ushell.services.Navigation.TargetIntent","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.Navigation.TargetIntent","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.Navigation.TargetIntentStrict","basename":"TargetIntentStrict","resource":"sap/ushell/services/Navigation.js","module":"sap/ushell/services/Navigation","static":true,"visibility":"public","since":"1.124.0","description":"
The target intent in strict format. same as sap.ushell.services.Navigation.TargetIntent but with the following restriction: The intent must not start with a hash character (#).
","type":"string","displayName":"sap.ushell.services.Navigation.TargetIntentStrict","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.Navigation.TargetIntentStrict","subTitle":""},{"kind":"class","name":"sap.ushell.services.NavTargetResolution","basename":"NavTargetResolution","resource":"sap/ushell/services/NavTargetResolution.js","module":"sap/ushell/services/NavTargetResolution","export":"","static":true,"visibility":"public","since":"1.15.0","extends":"sap.ushell.services.Service","description":"The Unified Shell's internal navigation target resolution service.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const NavTargetResolution = await Container.getServiceAsync(\"NavTargetResolution\");\n // do something with the NavTargetResolution service\n });\n Methods in this class deal with *internal* representations of the shell hash.
configurations: config : { allowTestUrlComponentConfig : true } allow to redefine the Test-url, Test-local1, Test-local2 applications via url parameters (sap-ushell-test-local1-url= / sap-ushell-test-local1-additionalInformation= ... )
","hideconstructor":true,"methods":[{"name":"expandCompactHash","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves expanded shell hash (in internal format).
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sHashFragment","optional":false,"description":"
The formatted URL hash fragment in internal format (as obtained by the SAPUI5 hasher service, not as given in location.hash)
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"expands a URL hash fragment
This function gets the hash part of the URL and expands a sap-intent-param if present and retrievable
This is an asynchronous operation.
","deprecated":{"since":"1.120","text":"Deprecated without successor."},"href":"api/sap.ushell.services.NavTargetResolution#methods/expandCompactHash","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor.","code":"expandCompactHash(sHashFragment) : jQuery.Promise "},{"name":"isNavigationSupported","visibility":"public","since":"1.32","returnValue":{"type":"jQuery.Promise","description":"Resolves an array of objects representing whether the intent is supported or not objects with a property supported of type boolean.
aIntents: an array of parameterized (parsed) Intent objects, in the corresponding structure to arguments to sap.ushell.services.CrossApplicationNavigation.toExternal , sap.ushell.services.CrossApplicationNavigation.hrefForExternal
\n [\n {\n target : {\n semanticObject : \"AnObject\",\n action: \"action\"\n },\n params : { P1 : \"B\", P2 : [ \"V2a\", \"V2b\"] }\n },\n {\n target : {\n semanticObject : \"SalesOrder\",\n action: \"display\"\n },\n params : { P3 : \"B\", SalesOrderIds : [ \"4711\", \"472\"] }\n }\n ]\n The following formats are also supported as input to ease migration of existing code: [ \"#AnObject-action?P1=B&SalesOrderIds=4711&SalesOrderIds=472\" ]
response:
\n [\n { supported: false },\n { supported: true }\n ]\n Example usage:
\n this.oCrossAppNav.isNavigationSupported([ ])\n .done(function(aResponses) {\n if (oResponse[0].supported===true){\n // enable link\n }\n else {\n // disable link\n }\n })\n .fail(function() {\n // disable link\n // request failed or other fatal error\n });\n ","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"aIntents","optional":false,"description":"
the intents (such as [\"#AnObject-action?A=B&c=e\"]) to be checked with object being instances the oArgs object of toExternal, hrefForExternal etc. e.g.
\n {\n target : { semanticObject : \"AnObject\", action: \"action\" },\n params : { A : \"B\" }\n }\n or e.g. \n {\n target : { semanticObject : \"AnObject\", action: \"action\" },\n params : { A : \"B\", c : \"e\" }\n }\n or { target : { shellHash : \"AnObject-action?A=B&c=e\" } }","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Tells whether the given navigation intent(s) are supported for the given parameters Supported\" means that a valid navigation target is configured for the user for the given device form factor.
This is effectively a test function for toExternal / hrefForExternal . It function accepts the same input as toExternal / hrefForExternal .
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Navigation#isNavigationSupported} instead."},"href":"api/sap.ushell.services.NavTargetResolution#methods/isNavigationSupported","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Navigation#isNavigationSupported instead.","code":"isNavigationSupported(aIntents) : jQuery.Promise "},{"name":"registerCustomResolver","visibility":"restricted","allowedFor":["cp.portal"],"returnValue":{"type":"boolean","description":"true if resolver was registered, false otherwise
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"oResolver","optional":false,"description":"
the custom resolver
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Register a custom resolver for semantic objects
The resolver must be JavaScript object with a string property name, and two functions resolveHashFragment(sHashFragment,nextResolver) returning a promise and isApplicable(sHashFragment) returning a boolean
","href":"api/sap.ushell.services.NavTargetResolution#methods/registerCustomResolver","code":"registerCustomResolver(oResolver) : boolean "},{"name":"resolveHashFragment","visibility":"public","returnValue":{"type":"jQuery.Promise","description":"Resolves an object that you can use to create a sap.ushell.components.container.ApplicationContainer or undefined in case the hash fragment was empty. Typically it contains the following information:
\n {\n \"applicationType\": \"URL\",\n \"url\": \"/sap/bc/\",\n \"additionalInformation\": \"SAPUI5.Component=com.sap.AComponent\",\n \"text\": \"My targetmapping description\",\n \"navigationMode\": \"embedded\"\n }\n The navigationMode indicates how the target application should be navigated. It is added to the result using the logic in navigationMode#getNavigationMode if none of the resolvers in the chain added it.
No navigation should occur when the promise is resolved to undefined.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sHashFragment","optional":false,"description":"
The formatted URL hash fragment in internal format (as obtained by the SAPUI5 hasher service) not as given in location.hash)! Example: #SemanticObject-action?P1=V1&P2=A%20B%20C
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Resolves the URL hash fragment.
This function should be used by a custom renderer in order to implement custom navigation. Do not use this function for developing Fiori applications.
This function gets the hash part of the URL and returns data of the target application.
Example of the returned data:
\n {\n \"additionalInformation\": \"SAPUI5.Component=sap.ushell.renderer.search.container\",\n \"applicationType\": \"URL\",\n \"url\": \"/sap/bc/ui5_ui5/ui2/ushell/resources/sap/ushell/renderer/search/container\",\n \"navigationMode\": \"embedded\"\n }\n This is an asynchronous operation.
","deprecated":{"since":"1.120","text":"Deprecated without successor."},"href":"api/sap.ushell.services.NavTargetResolution#methods/resolveHashFragment","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor.","code":"resolveHashFragment(sHashFragment) : jQuery.Promise "},{"name":"resolveTarget","visibility":"protected","returnValue":{"type":"jQuery.Promise","description":"Resolves an object. Typically it contains the following information:
\n {\n \"url\": \"/sap/bc/\",\n \"text\": \"My targetmapping description\",\n \"externalNavigationMode\": boolean\n }\n ","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oArgs","optional":false,"description":"
\n {\n target : {\n semanticObject : \"semantic object\",\n action : \"action\",\n },\n params : {\n \"sap-system-src\": \"e.g. sid(UR5.120)\",\n \"sap-system\": {\n ... data related to the sap-system\n }\n }\n }\n ","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Resolves a navigation target taking into account the sap-system
This function should be used by the NWBC browser in order to get a resolved target corresponding to a certain configuration object describing the target. Do not use this function for developing Fiori applications.
","href":"api/sap.ushell.services.NavTargetResolution#methods/resolveTarget","code":"resolveTarget(oArgs) : jQuery.Promise "}],"displayName":"sap.ushell.services.NavTargetResolution","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.NavTargetResolution","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Use sap.ushell.services.Navigation for Navigation instead."},{"kind":"class","name":"sap.ushell.services.Notifications","basename":"Notifications","resource":"sap/ushell/services/Notifications.js","module":"sap/ushell/services/Notifications","export":"","static":true,"visibility":"public","since":"1.32.0","extends":"sap.ushell.services.Service","description":"UShell service for fetching user notification data from the Notification center/service
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const Notifications = await Container.getServiceAsync(\"Notifications\");\n // do something with the Notifications service\n });\n In order to get user notifications, Unified Shell notification service issues OData requestsserviceUrl,
Unified Shell Notification service has several working modes, depending on the environment and the available resources:
The notification service exposes an API that includes: - Service enabling and initialization
","hideconstructor":true,"methods":[{"name":"dismissNotification","visibility":"public","since":"1.34","returnValue":{"type":"jQuery.Promise","description":"Resolves to undefined or it is rejected with a message object
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sNotificationId","optional":false,"description":"
The ID of the notification whose action is being executed
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Launches dismiss notification call.
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2#dismissNotification} instead."},"href":"api/sap.ushell.services.Notifications#methods/dismissNotification","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2#dismissNotification instead.","code":"dismissNotification(sNotificationId) : jQuery.Promise "},{"name":"executeBulkAction","visibility":"public","since":"1.32","returnValue":{"type":"jQuery.Promise","description":"Resolves to undefined on success or is rejected with failed notifications
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sNotificationGroupId","optional":false,"description":"
The ID of the notification header/group whose action is being executed
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sActionId","optional":false,"description":"
The ID of the action that is being executed
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Launches a notification action oData call.
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2#executeBulkAction} instead."},"href":"api/sap.ushell.services.Notifications#methods/executeBulkAction","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2#executeBulkAction instead.","code":"executeBulkAction(sNotificationGroupId, sActionId) : jQuery.Promise "},{"name":"getNotificationsByTypeWithGroupHeaders","visibility":"public","since":"1.38","returnValue":{"type":"jQuery.Promise","description":"Resolves all notification items
","typeInfo":{"template":"jQuery.Promise"}},"description":"Returns the notifications of the user sorted by type include the group headers and the notifications
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2#getNotificationsByTypeWithGroupHeaders} instead."},"href":"api/sap.ushell.services.Notifications#methods/getNotificationsByTypeWithGroupHeaders","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2#getNotificationsByTypeWithGroupHeaders instead.","code":"getNotificationsByTypeWithGroupHeaders() : jQuery.Promise "},{"name":"getNotificationsCount","visibility":"public","since":"1.44","returnValue":{"type":"int","description":"Returns the number of notifications of the user
","typeInfo":{"template":"int"}},"description":"Returns the number of notifications
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2#getNotificationsCount} instead."},"href":"api/sap.ushell.services.Notifications#methods/getNotificationsCount","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2#getNotificationsCount instead.","code":"getNotificationsCount() : int "},{"name":"getNotificationsGroupHeaders","visibility":"public","since":"1.44","returnValue":{"type":"jQuery.Promise","description":"Resolves all group headers
","typeInfo":{"template":"jQuery.Promise"}},"description":"Returns the group headers of the user notifications
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2#getNotificationsGroupHeaders} instead."},"href":"api/sap.ushell.services.Notifications#methods/getNotificationsGroupHeaders","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2#getNotificationsGroupHeaders instead.","code":"getNotificationsGroupHeaders() : jQuery.Promise "},{"name":"getUnseenNotificationsCount","visibility":"public","since":"1.32","returnValue":{"type":"jQuery.Promise","description":"Resolves the number of unread notifications of the user
","typeInfo":{"template":"jQuery.Promise"}},"description":"Returns the number of unseen notifications
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2#getUnseenNotificationsCount} instead."},"href":"api/sap.ushell.services.Notifications#methods/getUnseenNotificationsCount","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2#getUnseenNotificationsCount instead.","code":"getUnseenNotificationsCount() : jQuery.Promise "},{"name":"init","visibility":"public","since":"1.32","description":"Initializes the notification service
Initialization is performed only if the following two conditions are fulfilled:
The main initialization functionality is determining and setting the mode in which notifications are consumed.
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2#init} instead."},"href":"api/sap.ushell.services.Notifications#methods/init","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2#init instead.","code":"init() : void "},{"name":"isEnabled","visibility":"public","since":"1.32.0","returnValue":{"type":"boolean","description":"A boolean value indicating whether the notifications service is enabled
","typeInfo":{"template":"boolean"}},"description":"Indicates whether notification service is enabled.enable service configuration flag.
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2#isEnabled} instead."},"href":"api/sap.ushell.services.Notifications#methods/isEnabled","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2#isEnabled instead.","code":"isEnabled() : boolean "},{"name":"isFirstDataLoaded","visibility":"public","since":"1.38","returnValue":{"type":"boolean","description":"boolean value whether first request was already performed and data was returned.
","typeInfo":{"template":"boolean"}},"deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2#isFirstDataLoaded} instead."},"href":"api/sap.ushell.services.Notifications#methods/isFirstDataLoaded","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2#isFirstDataLoaded instead.","code":"isFirstDataLoaded() : boolean "},{"name":"markRead","visibility":"public","since":"1.34","returnValue":{"type":"jQuery.Promise","description":"Resolves to undefined or it is rejected with a message object
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sNotificationId","optional":false,"description":"
The ID of the notification whose action is being executed
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Launches mark as read notification call.
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2#markRead} instead."},"href":"api/sap.ushell.services.Notifications#methods/markRead","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2#markRead instead.","code":"markRead(sNotificationId) : jQuery.Promise "},{"name":"notificationsSeen","visibility":"public","since":"1.32","description":"Mark all notifications as seen.
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2#notificationsSeen} instead."},"href":"api/sap.ushell.services.Notifications#methods/notificationsSeen","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2#notificationsSeen instead.","code":"notificationsSeen() : void "},{"name":"registerNotificationCountUpdateCallback","visibility":"public","since":"1.32","parameters":[{"name":"callback","optional":false,"description":"
The callback function that is registered and called on data update.
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Gets a callback function that will be called when updated unseen notifications count is available.
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2#registerNotificationCountUpdateCallback} instead."},"href":"api/sap.ushell.services.Notifications#methods/registerNotificationCountUpdateCallback","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2#registerNotificationCountUpdateCallback instead.","code":"registerNotificationCountUpdateCallback(callback) : void "},{"name":"registerNotificationsUpdateCallback","visibility":"public","since":"1.32","parameters":[{"name":"callback","optional":false,"description":"
The callback function that is registered and called on data update.
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Gets a callback function that will be called when updated notifications data is available.
","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2#registerNotificationsUpdateCallback} instead."},"href":"api/sap.ushell.services.Notifications#methods/registerNotificationsUpdateCallback","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2#registerNotificationsUpdateCallback instead.","code":"registerNotificationsUpdateCallback(callback) : void "}],"displayName":"sap.ushell.services.Notifications","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Notifications","subTitle":"Deprecated in version: 1.119","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2 instead."},{"kind":"class","name":"sap.ushell.services.NotificationsV2","basename":"NotificationsV2","resource":"sap/ushell/services/NotificationsV2.js","module":"sap/ushell/services/NotificationsV2","export":"","static":true,"visibility":"public","since":"1.119","extends":"sap.ushell.services.Service","description":"UShell service for fetching user notification data from the Notification center/service
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const NotificationsV2 = await Container.getServiceAsync(\"NotificationsV2\");\n // do something with the NotificationsV2 service\n });\n In order to get user notifications, Unified Shell notification service issues OData requestsserviceUrl,
Unified Shell Notification service has several working modes, depending on the environment and the available resources:
The notification service exposes an API that includes: - Service enabling and initialization
","hideconstructor":true,"methods":[{"name":"dismissNotification","visibility":"public","returnValue":{"type":"Promise","description":"Promise object that on success resolves to undefined or it is rejected with a message object
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sNotificationId","optional":false,"description":"
The ID of the notification whose action is being executed
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Launches dismiss notification call.
","href":"api/sap.ushell.services.NotificationsV2#methods/dismissNotification","code":"dismissNotification(sNotificationId) : Promise "},{"name":"executeBulkAction","visibility":"public","returnValue":{"type":"Promise","description":"Promise object that on success resolves to undefined or it is rejected with failed notifications
","typeInfo":{"template":"Promise>","UI5Types":["sap.ushell.services.NotificationsV2.BulkAction"]}},"parameters":[{"name":"sNotificationGroupId","optional":false,"description":"
The ID of the notification header/group whose action is being executed
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sActionId","optional":false,"description":"
The ID of the action that is being executed
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Launches a notification action oData call.
","href":"api/sap.ushell.services.NotificationsV2#methods/executeBulkAction","code":"executeBulkAction(sNotificationGroupId, sActionId) : Promise "},{"name":"getNotificationsByTypeWithGroupHeaders","visibility":"public","returnValue":{"type":"Promise","description":"Promise for all notification items The notifications items have value true for attribute group header if they are group headers.
","typeInfo":{"template":"Promise>","UI5Types":["sap.ushell.services.NotificationsV2.NotificationItem"]}},"description":"Returns the notifications of the user sorted by type include the group headers and the notifications
","href":"api/sap.ushell.services.NotificationsV2#methods/getNotificationsByTypeWithGroupHeaders","code":"getNotificationsByTypeWithGroupHeaders() : Promise "},{"name":"getNotificationsCount","visibility":"public","returnValue":{"type":"int","description":"Returns the number of notifications of the user
","typeInfo":{"template":"int"}},"description":"Returns the number of notifications
","href":"api/sap.ushell.services.NotificationsV2#methods/getNotificationsCount","code":"getNotificationsCount() : int "},{"name":"getNotificationsGroupHeaders","visibility":"public","returnValue":{"type":"Promise","description":"Promise for all group headers The notifications items have value true for attribute group header
","typeInfo":{"template":"Promise>","UI5Types":["sap.ushell.services.NotificationsV2.NotificationItem"]}},"description":"Returns the group headers of the user notifications
","href":"api/sap.ushell.services.NotificationsV2#methods/getNotificationsGroupHeaders","code":"getNotificationsGroupHeaders() : Promise "},{"name":"getUnseenNotificationsCount","visibility":"public","returnValue":{"type":"Promise","description":"Promise resolves with the number of unread notifications of the user
","typeInfo":{"template":"Promise"}},"description":"Returns the number of unseen notifications
","href":"api/sap.ushell.services.NotificationsV2#methods/getUnseenNotificationsCount","code":"getUnseenNotificationsCount() : Promise "},{"name":"init","visibility":"public","description":"Initializes the notification service
Initialization is performed only if the following two conditions are fulfilled:
The main initialization functionality is determining and setting the mode in which notifications are consumed.
","href":"api/sap.ushell.services.NotificationsV2#methods/init","code":"init() : void "},{"name":"isEnabled","visibility":"public","returnValue":{"type":"boolean","description":"A boolean value indicating whether the notifications service is enabled
","typeInfo":{"template":"boolean"}},"description":"Indicates whether notification service is enabled.enable service configuration flag.
","href":"api/sap.ushell.services.NotificationsV2#methods/isEnabled","code":"isEnabled() : boolean "},{"name":"isFirstDataLoaded","visibility":"public","returnValue":{"type":"boolean","description":"boolean value whether first request was already performed and data was returned.
","typeInfo":{"template":"boolean"}},"href":"api/sap.ushell.services.NotificationsV2#methods/isFirstDataLoaded","code":"isFirstDataLoaded() : boolean "},{"name":"markRead","visibility":"public","returnValue":{"type":"Promise","description":"Promise object that on success resolves to undefined or it is rejected with a message object
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sNotificationId","optional":false,"description":"
The ID of the notification whose action is being executed
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Launches mark as read notification call.
","href":"api/sap.ushell.services.NotificationsV2#methods/markRead","code":"markRead(sNotificationId) : Promise "},{"name":"notificationsSeen","visibility":"public","returnValue":{"type":"Promise","description":"Promise that resolves when operation is finished
","typeInfo":{"template":"Promise"}},"description":"Mark all notifications as seen.
","href":"api/sap.ushell.services.NotificationsV2#methods/notificationsSeen","code":"notificationsSeen() : Promise "},{"name":"registerNotificationCountUpdateCallback","visibility":"public","parameters":[{"name":"callback","optional":false,"description":"
The callback function that is registered and called on data update.
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Gets a callback function that will be called when updated unseen notifications count is available.
","href":"api/sap.ushell.services.NotificationsV2#methods/registerNotificationCountUpdateCallback","code":"registerNotificationCountUpdateCallback(callback) : void "},{"name":"registerNotificationsUpdateCallback","visibility":"public","parameters":[{"name":"callback","optional":false,"description":"
The callback function that is registered and called on data update.
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Gets a callback function that will be called when updated notifications data is available.
","href":"api/sap.ushell.services.NotificationsV2#methods/registerNotificationsUpdateCallback","code":"registerNotificationsUpdateCallback(callback) : void "},{"name":"setUnseenNotificationsCount","visibility":"public","returnValue":{"type":"Promise","description":"Promise resolves when the unseen notifications count is set
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"number","optional":false,"description":"
The number of unseen notifications to set
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Set the number of unseen notifications
","href":"api/sap.ushell.services.NotificationsV2#methods/setUnseenNotificationsCount","code":"setUnseenNotificationsCount(number) : Promise "}],"displayName":"sap.ushell.services.NotificationsV2","nodes":[{"name":"sap.ushell.services.NotificationsV2.Action","description":"Type for Action
","href":"api/sap.ushell.services.NotificationsV2.Action"},{"name":"sap.ushell.services.NotificationsV2.Actor","description":"Type for Actor
","href":"api/sap.ushell.services.NotificationsV2.Actor"},{"name":"sap.ushell.services.NotificationsV2.BulkAction","description":"Type for executeBulkAction
","href":"api/sap.ushell.services.NotificationsV2.BulkAction"},{"name":"sap.ushell.services.NotificationsV2.Nature","description":"Enumeration for The nature of the notification
This enum is part of the 'sap/ushell/services/NotificationsV2' module export and must be accessed by the property 'Nature'.
","href":"api/sap.ushell.services.NotificationsV2.Nature"},{"name":"sap.ushell.services.NotificationsV2.NotificationItem","description":"Type for the notification item
","href":"api/sap.ushell.services.NotificationsV2.NotificationItem"},{"name":"sap.ushell.services.NotificationsV2.NotificationTargetParameter","description":"Type for notification target parameters.
","href":"api/sap.ushell.services.NotificationsV2.NotificationTargetParameter"},{"name":"sap.ushell.services.NotificationsV2.Priority","description":"Enumeration for the priority of a notification
This enum is part of the 'sap/ushell/services/NotificationsV2' module export and must be accessed by the property 'Priority'.
","href":"api/sap.ushell.services.NotificationsV2.Priority"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.NotificationsV2","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.NotificationsV2.Action","basename":"Action","resource":"sap/ushell/services/NotificationsV2.js","module":"sap/ushell/services/NotificationsV2","static":true,"visibility":"public","since":"1.120.0","description":"
Type for Action
","properties":[{"name":"ActionId","optional":false,"visibility":"public","description":"The ID of the action
","typeInfo":{"template":"string"}},{"name":"ActionText","optional":false,"visibility":"public","description":"The text of the action
","typeInfo":{"template":"string"}},{"name":"GroupActionText","optional":false,"visibility":"public","description":"The group action text
","typeInfo":{"template":"string"}},{"name":"Nature","optional":false,"visibility":"public","description":"The nature of the action
","typeInfo":{"UI5Types":["sap.ushell.services.NotificationsV2.Nature"]}}],"displayName":"sap.ushell.services.NotificationsV2.Action","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.NotificationsV2.Action","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.NotificationsV2.Actor","basename":"Actor","resource":"sap/ushell/services/NotificationsV2.js","module":"sap/ushell/services/NotificationsV2","static":true,"visibility":"public","since":"1.120.0","description":"
Type for Actor
","properties":[{"name":"Id","optional":false,"visibility":"public","description":"The ID of the actor
","typeInfo":{"template":"string"}},{"name":"DisplayText","optional":false,"visibility":"public","description":"The display text of the actor
","typeInfo":{"template":"string"}},{"name":"ImageSource","optional":false,"visibility":"public","description":"The image source of the actor
","typeInfo":{"template":"string"}}],"displayName":"sap.ushell.services.NotificationsV2.Actor","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.NotificationsV2.Actor","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.NotificationsV2.BulkAction","basename":"BulkAction","resource":"sap/ushell/services/NotificationsV2.js","module":"sap/ushell/services/NotificationsV2","static":true,"visibility":"public","since":"1.120.0","description":"
Type for executeBulkAction
","properties":[{"name":"DeleteOnReturn","optional":false,"visibility":"public","description":"Indicates whether the notification should be deleted after the action is executed
","typeInfo":{"template":"boolean"}},{"name":"Success","optional":false,"visibility":"public","description":"Indicates whether the action was executed successfully
","typeInfo":{"template":"boolean"}},{"name":"NotificationId","optional":false,"visibility":"public","description":"The ID of the notification
","typeInfo":{"template":"string"}}],"displayName":"sap.ushell.services.NotificationsV2.BulkAction","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.NotificationsV2.BulkAction","subTitle":""},{"kind":"enum","name":"sap.ushell.services.NotificationsV2.Nature","basename":"Nature","resource":"sap/ushell/services/NotificationsV2.js","module":"sap/ushell/services/NotificationsV2","export":"Nature","static":true,"visibility":"public","since":"1.120.0","description":"
Enumeration for The nature of the notification
This enum is part of the 'sap/ushell/services/NotificationsV2' module export and must be accessed by the property 'Nature'.
","ui5-metadata":{"stereotype":"enum"},"properties":[{"name":"sap.ushell.services.NotificationsV2.Nature.NEGATIVE","visibility":"public","description":"The Negative nature.
"},{"name":"sap.ushell.services.NotificationsV2.Nature.NEUTRAL","visibility":"public","description":"The Neutral nature.
"},{"name":"sap.ushell.services.NotificationsV2.Nature.POSITIVE","visibility":"public","description":"The Positive nature.
"}],"displayName":"sap.ushell.services.NotificationsV2.Nature","component":"CA-FLP-FE-UI","hasSample":false,"title":"enum sap.ushell.services.NotificationsV2.Nature","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.NotificationsV2.NotificationItem","basename":"NotificationItem","resource":"sap/ushell/services/NotificationsV2.js","module":"sap/ushell/services/NotificationsV2","static":true,"visibility":"public","since":"1.120.0","description":"
Type for the notification item
","properties":[{"name":"Id","optional":false,"visibility":"public","description":"The ID of the notification.
","typeInfo":{"template":"string"}},{"name":"OriginId","optional":false,"visibility":"public","description":"The ID of the origin, can be a combination of system and client or the value LOCAL.
","typeInfo":{"template":"string"}},{"name":"CreatedAt","optional":false,"visibility":"public","description":"The date and time the notification was created.
","typeInfo":{"template":"string"}},{"name":"IsActionable","optional":false,"visibility":"public","description":"Indicates whether the notification is actionable.
","typeInfo":{"template":"boolean"}},{"name":"IsRead","optional":false,"visibility":"public","description":"Indicates whether the notification has been read.
","typeInfo":{"template":"boolean"}},{"name":"IsGroupable","optional":false,"visibility":"public","description":"Indicates whether the notification can be grouped.
","typeInfo":{"template":"boolean"}},{"name":"IsGroupHeader","optional":false,"visibility":"public","description":"Indicates whether the notification is a group header.
","typeInfo":{"template":"boolean"}},{"name":"NavigationTargetAction","optional":false,"visibility":"public","description":"The action to be executed when the notification is clicked.
","typeInfo":{"template":"string"}},{"name":"NavigationTargetObject","optional":false,"visibility":"public","description":"The object to be navigated to when the notification is clicked.
","typeInfo":{"template":"string"}},{"name":"NavigationIntent","optional":false,"visibility":"public","description":"The intent for navigation when the notification is clicked.
","typeInfo":{"template":"string"}},{"name":"NotificationTypeId","optional":false,"visibility":"public","description":"The ID for the notification type specified in NotificationTypeKey.
","typeInfo":{"template":"string"}},{"name":"NotificationTypeKey","optional":false,"visibility":"public","description":"The key of the notification type.
","typeInfo":{"template":"string"}},{"name":"ParentId","optional":false,"visibility":"public","description":"The ID of the parent notification.
","typeInfo":{"template":"string"}},{"name":"Priority","optional":false,"visibility":"public","description":"The priority of the notification.
","typeInfo":{"UI5Types":["sap.ushell.services.NotificationsV2.Priority"]}},{"name":"SensitiveText","optional":false,"visibility":"public","description":"The sensitive text of the notification.
","typeInfo":{"template":"string"}},{"name":"Text","optional":false,"visibility":"public","description":"The text of the notification.
","typeInfo":{"template":"string"}},{"name":"GroupHeaderText","optional":false,"visibility":"public","description":"The header text of the notification group.
","typeInfo":{"template":"string"}},{"name":"NotificationCount","optional":false,"visibility":"public","description":"The number of notifications.
","typeInfo":{"template":"number"}},{"name":"SubTitle","optional":false,"visibility":"public","description":"The subtitle of the notification.
","typeInfo":{"template":"string"}},{"name":"NotificationTypeDesc","optional":false,"visibility":"public","description":"The description of the notification type.
","typeInfo":{"template":"string"}},{"name":"Actor","optional":false,"visibility":"public","description":"The actor of the notification.
","typeInfo":{"UI5Types":["sap.ushell.services.NotificationsV2.Actor"],"refersToTypedef":true}},{"name":"NavigationTargetParams","optional":false,"visibility":"public","description":"The navigation target parameters of the notification.
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.services.NotificationsV2.NotificationTargetParameter"]}},{"name":"Actions","optional":false,"visibility":"public","description":"The actions of the notification.
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.services.NotificationsV2.Action"]}}],"displayName":"sap.ushell.services.NotificationsV2.NotificationItem","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.NotificationsV2.NotificationItem","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.NotificationsV2.NotificationTargetParameter","basename":"NotificationTargetParameter","resource":"sap/ushell/services/NotificationsV2.js","module":"sap/ushell/services/NotificationsV2","static":true,"visibility":"public","since":"1.120.0","description":"
Type for notification target parameters.
","properties":[{"name":"NotificationId","optional":false,"visibility":"public","description":"The ID of the notification.
","typeInfo":{"template":"string"}},{"name":"Key","optional":false,"visibility":"public","description":"The key of the notification target parameter.
","typeInfo":{"template":"string"}},{"name":"Value","optional":false,"visibility":"public","description":"The value of the notification target parameter.
","typeInfo":{"template":"string"}}],"displayName":"sap.ushell.services.NotificationsV2.NotificationTargetParameter","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.NotificationsV2.NotificationTargetParameter","subTitle":""},{"kind":"enum","name":"sap.ushell.services.NotificationsV2.Priority","basename":"Priority","resource":"sap/ushell/services/NotificationsV2.js","module":"sap/ushell/services/NotificationsV2","export":"Priority","static":true,"visibility":"public","since":"1.120.0","description":"
Enumeration for the priority of a notification
This enum is part of the 'sap/ushell/services/NotificationsV2' module export and must be accessed by the property 'Priority'.
","ui5-metadata":{"stereotype":"enum"},"properties":[{"name":"sap.ushell.services.NotificationsV2.Priority.HIGH","visibility":"public","description":"High priority.
"},{"name":"sap.ushell.services.NotificationsV2.Priority.LOW","visibility":"public","description":"Low priority.
"},{"name":"sap.ushell.services.NotificationsV2.Priority.MEDIUM","visibility":"public","description":"Medium priority.
"}],"displayName":"sap.ushell.services.NotificationsV2.Priority","component":"CA-FLP-FE-UI","hasSample":false,"title":"enum sap.ushell.services.NotificationsV2.Priority","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.Pages.PageData","basename":"PageData","resource":"sap/ushell/services/Pages.js","module":"sap/ushell/services/Pages","static":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.120.0","description":"
Type for a page in the \"pages and spaces\" concept.
","properties":[{"name":"id","optional":false,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The ID of the page.
","typeInfo":{"template":"string"}},{"name":"title","optional":false,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The title of the page.
","typeInfo":{"template":"string"}},{"name":"description","optional":false,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The description of the page.
","typeInfo":{"template":"string"}},{"name":"sections","optional":false,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The ID of the page.
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.services.Pages.Section"]}}],"displayName":"sap.ushell.services.Pages.PageData","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.Pages.PageData","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.Pages.Section","basename":"Section","resource":"sap/ushell/services/Pages.js","module":"sap/ushell/services/Pages","static":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.120.0","description":"
Type for the section of a page.
","properties":[{"name":"id","optional":false,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The ID of the section.
","typeInfo":{"template":"string"}},{"name":"title","optional":false,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The title of the section.
","typeInfo":{"template":"string"}},{"name":"default","optional":false,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"Whether this is the default section.
","typeInfo":{"template":"boolean"}},{"name":"locked","optional":false,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"Whether the section is locked.
","typeInfo":{"template":"boolean"}},{"name":"preset","optional":false,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"Whether the section is preset.
","typeInfo":{"template":"boolean"}},{"name":"visible","optional":false,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"Whether the section is visible.
","typeInfo":{"template":"boolean"}},{"name":"visualizations","optional":false,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The visualizations in the section.
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.services.Pages.Visualization"]}}],"displayName":"sap.ushell.services.Pages.Section","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.Pages.Section","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.Pages.Visualization","basename":"Visualization","resource":"sap/ushell/services/Pages.js","module":"sap/ushell/services/Pages","static":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.120.0","description":"
Type for a visualization. Note: not all possible properties are maintained here.
","properties":[{"name":"title","optional":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The title
","typeInfo":{"template":"string"}},{"name":"target","optional":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The target in object format
","typeInfo":{"template":"object"}},{"name":"subtitle","optional":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The subtitle
","typeInfo":{"template":"string"}},{"name":"icon","optional":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The icon
","typeInfo":{"template":"string"}},{"name":"info","optional":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The information text
","typeInfo":{"template":"string"}},{"name":"isBookmark","optional":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"Whether the visualization is bookmarked.
","typeInfo":{"template":"boolean"}},{"name":"numberUnit","optional":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The numberUnit
","typeInfo":{"template":"string"}},{"name":"indicatorDataSource","optional":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The indicator data source
","typeInfo":{"template":"string"}},{"name":"displayFormatHint","optional":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The format in which the visualization is displayed
","typeInfo":{"template":"string"}},{"name":"serviceUrl","optional":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The service URL from the indicator data source, if it exists.
","typeInfo":{"template":"string"}},{"name":"serviceRefreshInterval","optional":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The service refresh interval from the indicator data source, if it exists.
","typeInfo":{"template":"string"}},{"name":"vizType","optional":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The visualization type.
","typeInfo":{"template":"string"}},{"name":"vizConfig","optional":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"description":"The visualization configuration.
","typeInfo":{"template":"object"}}],"displayName":"sap.ushell.services.Pages.Visualization","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.Pages.Visualization","subTitle":""},{"kind":"class","name":"sap.ushell.services.Personalization","basename":"Personalization","resource":"sap/ushell/services/Personalization.js","module":"sap/ushell/services/Personalization","export":"","static":true,"visibility":"public","since":"1.15.0","extends":"sap.ushell.services.Service","description":"The Unified Shell's personalization service, which provides a personalizer object that handles all personalization operations.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const Personalization = await Container.getServiceAsync(\"Personalization\");\n // do something with the Personalization service\n });\n ","hideconstructor":true,"methods":[{"name":"createEmptyContainer","visibility":"public","since":"1.22.0","returnValue":{"type":"jQuery.Promise","description":"Resolves a sap.ushell.services.Personalization.ContextContainer object as parameter. The personalization container provides two different interfaces to synchronously operate on personalization data. In the item mode the container contains items as name value pairs for personalization data. In the variant mode the container contains variant sets which contain variants containing items.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sContainerKey","optional":false,"description":"
identifies the container. The string length is restricted to 40 characters
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oScope","optional":false,"description":"
scope object. Currently the validity property of the scope object is relevant: E.g. { validity : 30} indicates a validity of the data for 30 minutes.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"oComponent","optional":false,"description":"
Since 1.27.0. SAPUI5 component which uses the container. This allows to associate the stored data with the application.
","typeInfo":{"UI5Types":["sap.ui.core.Component"]},"defaultValue":""}],"description":"Factory method to obtain an empty Data Context object. When data present in a prior context is not relevant (e.g. when using a \"uniquely\" generated key and planning to overwrite any colliding front-end server data).
The call always returns an cleared container().
Note that an existing container at the front-end server is not actually deleted or overwritten unless a save operation is executed.
An initial object is returned.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2#createEmptyContainer} instead."},"href":"api/sap.ushell.services.Personalization#methods/createEmptyContainer","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2#createEmptyContainer instead.","code":"createEmptyContainer(sContainerKey, oScope, oComponent) : jQuery.Promise "},{"name":"delContainer","visibility":"public","since":"1.22.0","returnValue":{"type":"jQuery.Promise","description":"Resolves once the container was deleted.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sContainerKey","optional":false,"description":"
identifies the container
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oScope","optional":false,"description":"
scope object
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Asynchronously starts a deletion request for the given container identified by sContainerKey. Can be called without having ever called getContainer with the corresponding key
Note: After invoking this operation, the state of other Containers obtained for the same key is undefined! If you want to use the container after deletion, it is strongly recommended to obtain a new instance of a container for the given key *after* the promise has returned.
Note: Invoking this operation while another save or load operation is under way may result in failure.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2#deleteContainer} instead."},"href":"api/sap.ushell.services.Personalization#methods/delContainer","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2#deleteContainer instead.","code":"delContainer(sContainerKey, oScope) : jQuery.Promise "},{"name":"delPersonalizationContainer","visibility":"public","since":"1.18.0","returnValue":{"type":"jQuery.Promise","description":"Resolves once the container was deleted.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sContainerKey","optional":false,"description":"
identifies the container
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Asynchronously starts a deletion request for the given container identified by sContainerKey. Can be called without having ever created a personalization container.
Note: After invoking this operation, the state of other PersonalizationContainers obtained for the same key is undefined! If you want to use the container after deletion, it is strongly recommended to obtain a new instance of PersonalizationContainer for the given key *after* the promise has returned.
Note: Invoking this operation while another save or load operation is under way may result in failure.
","deprecated":{"since":"1.22","text":"Please use {@link #delContainer} instead."},"href":"api/sap.ushell.services.Personalization#methods/delPersonalizationContainer","deprecatedText":"Deprecated as of version 1.22. Please use #delContainer instead.","code":"delPersonalizationContainer(sContainerKey) : jQuery.Promise "},{"name":"getContainer","visibility":"public","since":"1.22.0","returnValue":{"type":"jQuery.Promise","description":"Resolves a sap.ushell.services.Personalization.ContextContainer object as parameter. The container provides setItemValue / getItemValue methods to synchronously operate on personalization data. By wrapping it in a VariantSetAdapter, an alternate interface to maintain variants can be obtained.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sContainerKey","optional":false,"description":"
identifies the container. The string length is restricted to 40 characters
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oScope","optional":false,"description":"
scope object. Currently the validity property of the scope object is relevant: E.g. { validity : 30} indicates a validity of the data for 30 minutes.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"oComponent","optional":false,"description":"
Since 1.27.0. SAPUI5 component which uses the container. This allows to associate the stored data with the application.
","typeInfo":{"UI5Types":["sap.ui.core.Component"]},"defaultValue":""}],"description":"Factory method to obtain a Data Context object, which is a local copy of the persistence layer data. The Container data is asynchronously read on creation if present, otherwise an initial object is created. The Container data can then be *synchronously* modified (getItemValue, setItemValue). Only on invoking the save()/saveDeferred() method the data is transferred to the persistence. This allows the application to perform multiple local modifications and delay the save operation.
Every getContainer operation returns a new local copy, containing the full data at the point of creation.
Executing load() on the container reloads the data from the persistence, discarding local changes.
Note that the container allows the application to control the round trips to the front-end server persistence. The factory method getContainer is asynchronous and loads the container via the connected adapter from the front-end server. All operations (but for the save operation) are executed synchronously, operating on the local data. This allows the application to control the round trips to the front-end server persistence.
A container can contain a set of items, identified by a key.
You can wrap a container in a VariantSetAdapter to read and write a more complex structure (with multiple keys (variantSet,variant,item)).
Do not mix up the usage of a personalizer and a container for one containerKey. Do not use a PersonalizationContainer and a Container for the same key except for migration scenarios.
scope / validity parameter (@since 1.22.0): An unspecified (undefined validity) or infinite (Infinity) validity indicates that data is persisted in the Personalization data of the front-end server. A round trip is executed on an initial get and at least every save operation. Data is stored per user and retained indefinitely at the front-end server.
The validity parameter allows a designated storage validity for the created container. A 0 validity indicates the data is only persisted within the Fiori launchpad window. No round trips to the front-end server are executed. Data is lost if the Fiori launchpad window state is lost (e.g. by navigating to a different page, pressing F5 (reload page) or duplicating the window).
For versions > 1.24 it may happen that for cross-app navigation a reload of the Fiori launchpad is triggered. In this case a storage of the personalization data in the Fiori launchpad window would lead to data loss. To overcome this a validity 0 is automatically changed to a validity 1440 (24h; storage on the front-end server). This is only done if a reload of the Fiori launchpad is triggered for a cross-app navigation.
Security: It is the responsibility of the application to not persist information relevant to auditing or security using the PersonalizationService with inappropriate validity models. No mechanisms exist to destroy or selectively destroy application-specific data in the front-end server persistence (especially for validity Infinity).
For non-zero validity scopes, data will be transmitted and persisted in the front-end server system.
For limited validity, actual deletion of data on the front-end server is subject to explicit cleanup execution of front-end server jobs and not guaranteed. The data may still be persisted and retrievable. The interface only assures that expired data is no longer exposed to the application code in the Fiori launchpad.
The ContainerKey uniquely defines the Container, validity is not part of the key (there are no separate namespaces per validity).
In general, mixing different validity models for a given container key is not supported. Fast chaining of different methods may source arbitrary persistence layers. The validity of the resolved object is the last get validity.
The validity associated with the last getContainer or createEmptyContainer determines the current validity of the container and the validity used during the next save operation.
Naturally, if a delete or get with validity 0 is issued, it will *not* delete or retrieve a front-end server persistent storage. Thus a sequence delete( [validity 0])/wait for promise, getContainer(sKey,{ validity : Infinity}) may return a valid dataset.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2#getContainer} instead."},"href":"api/sap.ushell.services.Personalization#methods/getContainer","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2#getContainer instead.","code":"getContainer(sContainerKey, oScope, oComponent) : jQuery.Promise "},{"name":"getGeneratedKey","visibility":"public","since":"1.28.0","returnValue":{"type":"string","description":"40 character string consisting of A-Z and 0-9 which can be used as a generated key for personalization container. Every invocation returns a new key. Seed of random function is OS Random Seed.
","typeInfo":{"template":"string"}},"description":"Returns a generated key. This key is suitably random, but it is susceptible to brute force attacks. Storages based on the generated key must not be used for sensitive data.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2#getGeneratedKey} instead."},"href":"api/sap.ushell.services.Personalization#methods/getGeneratedKey","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2#getGeneratedKey instead.","code":"getGeneratedKey() : string "},{"name":"getPersonalizationContainer","visibility":"public","since":"1.18.0","returnValue":{"type":"jQuery.Promise","description":"Resolves a sap.ushell.services.PersonalizationContainer object as parameter. The personalization container provides two different interfaces to synchronously operate on personalization data. In the item mode the container contains items as name-value pairs for personalization data. In the variant mode the container contains variant sets which contain variants containing items.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sContainerKey","optional":false,"description":"
identifies the container
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"This interface is deprecated since 1.22, please use getContainer / delContainer.
Note: the underlying storage model for Objects stored with getContainer / getPersonalizationContainer is identical.getPersonalizationContainer to getContainer without loss of data. One may even run mixed set of applications on the same container keys. The sole differences are w.r.t. client side handling of the Context data within one session.
If you want to use the variant interface, use the following pattern
\n getContainer(sContainerKey).done(function(oContainer) {\n var variantSetAdapter = new Personalization.VariantSetAdapter(oContainer);\n }\n Factory method to obtain a personalization container object which is a client-local buffer for personalization data. The Container data is asynchronously read on creation (if present, otherwise an initial object is created). The Container data can then be *synchronously* modified (read/write/delete). Only on invoking the save() method the data is persisted at the front-end server. This allows the application to perform multiple local modifications and delay the save operation. Note that the personalization container allows the application to control the round trips to the front-end server persistence. The factory method getPersonalizationContainer is asynchronous and loads the container via the connected adapter from the front-end server. All operations (but for the save operation) are executed synchronously, operating on the local data. This allows the application to control the round trips to the front-end server persistence.
A personalization container can contain items as well as variant sets. Variant sets have the following structure: variantSet.variant.item A variant set is enclosing several variants of the same data.
Example: An application has two types of variants. Variant type 1 contains filter values for a query, which are stored in item 1 of the variant, and personalization data for a table, which are stored in item 2 of the variant. Variant type 2 contains a setting (item 3) that is independent of the filtering and the table settings. It might be used for a different screen than the variants of type 1. In this example you would have 2 variant sets, one for each variant type.
Do not mix up the usage of a personalizer and a personalization container for one containerKey.
","deprecated":{"since":"1.21","text":"Please use {@link #getContainer} instead."},"href":"api/sap.ushell.services.Personalization#methods/getPersonalizationContainer","deprecatedText":"Deprecated as of version 1.21. Please use #getContainer instead.","code":"getPersonalizationContainer(sContainerKey) : jQuery.Promise "},{"name":"getPersonalizer","visibility":"public","since":"1.15.0","returnValue":{"type":"sap.ushell.services.Personalizer","description":"A Personalizer which provides generic read and write access to the currently logged on user's personalization settings.
","typeInfo":{"UI5Types":["sap.ushell.services.Personalizer"]}},"parameters":[{"name":"oPersId","optional":false,"description":"
JSON object consisting of the following parts: container - Identifies the set of personalization data that is loaded/saved as one bundle from the front-end server. item - The name of the object the personalization is applied to.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"oScope","optional":false,"description":"
scope object { validity : 30} indicates a validity of the data for 30 minutes.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"oComponent","optional":true,"description":"
Since 1.27.0. SAPUI5 component which uses the personalizer. This allows to associate the stored data with the application.
","typeInfo":{"UI5Types":["sap.ui.core.Component"]},"defaultValue":""}],"description":"Returns a personalizer object which handles personalization by asynchronous operations storing the personalization data immediately via the connected adapter. For each operation a round trip is executed.
Do not mix the usage of a personalizer and a personalization container for one containerKey.
Fetching multiple Personalizer for the same container, but different items is not supported. Use sap.ushell.services.Personalizer#getContainer instead for this scenario.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2#getPersonalizer} instead."},"href":"api/sap.ushell.services.Personalization#methods/getPersonalizer","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2#getPersonalizer instead.","code":"getPersonalizer(oPersId, oScope, oComponent?) : sap.ushell.services.Personalizer "},{"name":"getTransientPersonalizer","visibility":"public","since":"1.18.0","returnValue":{"type":"sap.ushell.services.TransientPersonalizer","description":"A TransientPersonalizer which provides asynchronous read and write access to a transient personalization data storage.
","typeInfo":{"UI5Types":["sap.ushell.services.TransientPersonalizer"]}},"description":"Returns a transient personalizer object which handles personalization by asynchronous operations storing the personalization data transiently as an object property. Primary usage of the transient personalizer is a personalization scenario with variants where the transient personalizer is used as a buffer for table personalization data.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2#getTransientPersonalizer} instead."},"href":"api/sap.ushell.services.Personalization#methods/getTransientPersonalizer","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2#getTransientPersonalizer instead.","code":"getTransientPersonalizer() : sap.ushell.services.TransientPersonalizer "}],"displayName":"sap.ushell.services.Personalization","nodes":[{"name":"sap.ushell.services.Personalization.ContextContainer","description":"The container is the anchor object of the unified shell personalization in container mode.\n
","href":"api/sap.ushell.services.Personalization.ContextContainer","deprecated":true},{"name":"sap.ushell.services.Personalization.PersonalizationContainer","description":"The personalization container is the anchor object of the unified shell personalization in container mode.\n
","href":"api/sap.ushell.services.Personalization.PersonalizationContainer","deprecated":true},{"name":"sap.ushell.services.Personalization.PersonalizationContainerVariant","description":"The personalization variant contains personalization data.
","href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariant","deprecated":true},{"name":"sap.ushell.services.Personalization.PersonalizationContainerVariantSet","description":"The personalization variant set contains variants of personalization data.
","href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariantSet","deprecated":true},{"name":"sap.ushell.services.Personalization.Personalizer","description":"The Unified Shell personalizer providing set get delete methods to access the persisted personalization data in direct mode.\n
","href":"api/sap.ushell.services.Personalization.Personalizer","deprecated":true},{"name":"sap.ushell.services.Personalization.TransientPersonalizer","description":"The transient personalizer shall be used in container mode for table personalization.
","href":"api/sap.ushell.services.Personalization.TransientPersonalizer","deprecated":true},{"name":"sap.ushell.services.Personalization.Variant","description":"The personalization variant contains personalization data.
","href":"api/sap.ushell.services.Personalization.Variant","deprecated":true},{"name":"sap.ushell.services.Personalization.VariantSet","description":"The personalization variant set contains variants of personalization data.
","href":"api/sap.ushell.services.Personalization.VariantSet","deprecated":true},{"name":"sap.ushell.services.Personalization.VariantSetAdapter","description":"Wrapper object to expose a variant interface on a ContextContainer object obtained from the Personalization service:
\ngetContainer(...).done( function(oContainer) {\n that.oVariantSetContainer = new VariantSetAdapter(oContainer);\n});\n ","href":"api/sap.ushell.services.Personalization.VariantSetAdapter","deprecated":true}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Personalization","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2 instead."},{"kind":"class","name":"sap.ushell.services.Personalization.ContextContainer","basename":"ContextContainer","resource":"sap/ushell/services/_Personalization/ContextContainer.js","module":"sap/ushell/services/_Personalization/ContextContainer","export":"","static":true,"visibility":"public","since":"1.22.0","description":"The container is the anchor object of the unified shell personalization in container mode.
To be called by the personalization service getContainer method.
","hideconstructor":true,"methods":[{"name":"_getInternalKeys","visibility":"public","since":"1.22.0","returnValue":{"type":"string[]","description":"item keys
","typeInfo":{"template":"Array"}},"description":"Returns an array with all internal keys of direct items in the container.
","deprecated":{"since":"1.120","text":"Deprecated without successor. This internal method should not be used."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/_getInternalKeys","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor. This internal method should not be used.","code":"_getInternalKeys() : string[] "},{"name":"clear","visibility":"public","since":"1.22.0","description":"clears the local copy data of this container
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer#clearData} instead."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/clear","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.ContextContainer#clearData instead.","code":"clear() : void "},{"name":"containsItem","visibility":"public","since":"1.22.0","returnValue":{"type":"boolean","description":"true if the container contains a direct item with the key
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Checks if a specific direct item is contained in the container.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer#containsItem} instead."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/containsItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.ContextContainer#containsItem instead.","code":"containsItem(sItemKey) : boolean "},{"name":"delItem","visibility":"public","since":"1.22.0","parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Deletes a direct item from the container. In case the item does not exist, nothing happens.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer#deleteItem} instead."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/delItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.ContextContainer#deleteItem instead.","code":"delItem(sItemKey) : void "},{"name":"flush","visibility":"public","since":"1.22.0","returnValue":{"type":"jQuery.Promise","description":"Resolves once the requests were flushed.
","typeInfo":{"template":"jQuery.Promise"}},"description":"flush all pending request; The result of the promise may reflect the last pending operation in the queue
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer#flushPendingRequests} instead."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/flush","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.ContextContainer#flushPendingRequests instead.","code":"flush() : jQuery.Promise "},{"name":"getItemKeys","visibility":"public","since":"1.22.0","returnValue":{"type":"string[]","description":"item keys
","typeInfo":{"template":"Array"}},"description":"Returns an array with the keys of direct items in the container.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer#getItemKeys} instead."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/getItemKeys","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.ContextContainer#getItemKeys instead.","code":"getItemKeys() : string[] "},{"name":"getItemValue","visibility":"public","since":"1.22.0","returnValue":{"type":"object","description":"item value (JSON object). In case the container does not contain a direct item with this key undefined is returned.
","typeInfo":{"template":"object"}},"parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns the value for a direct item from the container. (Value semantics, new copy is returned)
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer#getItemValue} instead."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/getItemValue","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.ContextContainer#getItemValue instead.","code":"getItemValue(sItemKey) : object "},{"name":"getKey","visibility":"public","since":"1.28.0","returnValue":{"type":"string","description":"the container key
","typeInfo":{"template":"string"}},"description":"return the container key as a string variable
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer#getKey} instead."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/getKey","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.ContextContainer#getKey instead.","code":"getKey() : string "},{"name":"getUnmodifiableContainer","visibility":"public","since":"1.28.0","returnValue":{"type":"object","description":"unmodifiable wrapper instance
","typeInfo":{"template":"object"}},"description":"Return an instance unmodifiable container instance. There is one instance of this wrapper per container. It will permit all read accesses to the container, but block all modifying accesses.
","deprecated":{"since":"1.120","text":"Deprecated without successor."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/getUnmodifiableContainer","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor.","code":"getUnmodifiableContainer() : object "},{"name":"getValidity","visibility":"public","since":"1.22.0","returnValue":{"type":"int","description":"the scope validity.
","typeInfo":{"template":"int"}},"description":"return the validity of this container only for testing!
","deprecated":{"since":"1.31","text":"Support for this function has been discontinued."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/getValidity","deprecatedText":"Deprecated as of version 1.31. Support for this function has been discontinued.","code":"getValidity() : int "},{"name":"load","visibility":"public","since":"1.22.0","returnValue":{"type":"jQuery.Promise","description":"Resolves once the context container is loaded.
","typeInfo":{"template":"jQuery.Promise"}},"description":"(Re)loads the current container data from the underlying storage asynchronously. The current local data is discarded.
Returns a promise for the load operation. If another save/load/delete operation is not completed, the operation may fail! (wait for the other promise).
Synchronous read and write operations before the load is done have undefined effects.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer#load} instead."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/load","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.ContextContainer#load instead.","code":"load() : jQuery.Promise "},{"name":"save","visibility":"public","since":"1.22.0","returnValue":{"type":"jQuery.Promise","description":"Resolves once the container is saved.
If another save/load/delete operation is not completed, the operation may fail! (wait for the other promise).
","typeInfo":{"template":"jQuery.Promise"}},"description":"Attempts to save the current container data at the underlying storage asynchronously. The current state is serialized.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer#save} instead."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/save","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.ContextContainer#save instead.","code":"save() : jQuery.Promise "},{"name":"saveDeferred","visibility":"public","since":"1.22.0","returnValue":{"type":"jQuery.Promise","description":"Resolves once the container is saved.
The operation may wait for completion of another pending operation.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"nDelayInMilliseconds","optional":false,"description":"
the delay in milliseconds.
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Save the current container data at the underlying storage asynchronously at the earliest nDelayInMilliseconds seconds before. The current state is serialized.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer#save} instead."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/saveDeferred","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.ContextContainer#save instead.","code":"saveDeferred(nDelayInMilliseconds) : jQuery.Promise "},{"name":"setItemValue","visibility":"public","since":"1.22.0","parameters":[{"name":"sItemKey","optional":false,"description":"
item key The string length is restricted to 40 characters
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oItemValue","optional":false,"description":"
item value (JSON object)
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets the value of a direct item in the container. In case the item is already existing its value is overwritten. In case it is not existing a new item with this key and value is created. The value is serialized during set
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer#setItemValue} instead."},"href":"api/sap.ushell.services.Personalization.ContextContainer#methods/setItemValue","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.ContextContainer#setItemValue instead.","code":"setItemValue(sItemKey, oItemValue) : void "}],"displayName":"sap.ushell.services.Personalization.ContextContainer","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Personalization.ContextContainer","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.ContextContainer instead."},{"kind":"class","name":"sap.ushell.services.Personalization.PersonalizationContainer","basename":"PersonalizationContainer","resource":"sap/ushell/services/_Personalization/PersonalizationContainer.js","module":"sap/ushell/services/_Personalization/PersonalizationContainer","export":"","static":true,"visibility":"public","since":"1.18.0","description":"The personalization container is the anchor object of the unified shell personalization in container mode.
To be called by the personalization service getPersonalizationContainer method.
","hideconstructor":true,"displayName":"sap.ushell.services.Personalization.PersonalizationContainer","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Personalization.PersonalizationContainer","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Personalization#getContainer instead."},{"kind":"class","name":"sap.ushell.services.Personalization.PersonalizationContainerVariant","basename":"PersonalizationContainerVariant","resource":"sap/ushell/services/_Personalization/PersonalizationContainerVariant.js","module":"sap/ushell/services/_Personalization/PersonalizationContainerVariant","export":"","static":true,"visibility":"public","since":"1.18.0","description":"The personalization variant contains personalization data. It is used in the personalization container mode.
To be called by the personalization variant set.
","hideconstructor":true,"methods":[{"name":"containsItem","visibility":"public","since":"1.18.0","returnValue":{"type":"boolean","description":"true if the variant contains an item with the key
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Checks if a specific item is contained in this variant.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#containsItem} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariant#methods/containsItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#containsItem instead.","code":"containsItem(sItemKey) : boolean "},{"name":"delItem","visibility":"public","since":"1.18.0","returnValue":{"type":"boolean","description":"whether the key was removed.
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Deletes an item from this variant. In case the item does not exist, nothing happens.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#deleteItem} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariant#methods/delItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#deleteItem instead.","code":"delItem(sItemKey) : boolean "},{"name":"getItemKeys","visibility":"public","since":"1.18.0","returnValue":{"type":"string[]","description":"item keys
","typeInfo":{"template":"Array"}},"description":"Returns an array with the keys of all items in this variant.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#getItemKeys} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariant#methods/getItemKeys","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#getItemKeys instead.","code":"getItemKeys() : string[] "},{"name":"getItemValue","visibility":"public","since":"1.18.0","returnValue":{"type":"object","description":"item value (JSON object). In case the variant does not contain an item with this key undefined is returned.
","typeInfo":{"template":"object"}},"parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns the value for an item in this variant.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#getItemValue} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariant#methods/getItemValue","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#getItemValue instead.","code":"getItemValue(sItemKey) : object "},{"name":"getVariantKey","visibility":"public","since":"1.18.0","returnValue":{"type":"string","description":"variant key.
","typeInfo":{"template":"string"}},"description":"Returns the key of this variant.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#getVariantKey} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariant#methods/getVariantKey","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#getVariantKey instead.","code":"getVariantKey() : string "},{"name":"getVariantName","visibility":"public","since":"1.18.0","returnValue":{"type":"string","description":"variant name.
","typeInfo":{"template":"string"}},"description":"Returns the name of this variant.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#getVariantName} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariant#methods/getVariantName","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#getVariantName instead.","code":"getVariantName() : string "},{"name":"setItemValue","visibility":"public","since":"1.18.0","returnValue":{"type":"any","description":"the old value.
","typeInfo":{"template":"any"}},"parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oItemValue","optional":false,"description":"
item value (JSON object)
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets the value for an item in this variant.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#setItemValue} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariant#methods/setItemValue","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#setItemValue instead.","code":"setItemValue(sItemKey, oItemValue) : any "}],"displayName":"sap.ushell.services.Personalization.PersonalizationContainerVariant","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Personalization.PersonalizationContainerVariant","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Personalization#getContainer instead."},{"kind":"class","name":"sap.ushell.services.Personalization.PersonalizationContainerVariantSet","basename":"PersonalizationContainerVariantSet","resource":"sap/ushell/services/_Personalization/PersonalizationContainerVariantSet.js","module":"sap/ushell/services/_Personalization/PersonalizationContainerVariantSet","export":"","static":true,"visibility":"public","since":"1.18.0","description":"The personalization variant set contains variants of personalization data. It is used in the personalization container mode.
To be called by the personalization container.
","hideconstructor":true,"methods":[{"name":"addVariant","visibility":"public","since":"1.18.0","returnValue":{"type":"object","description":"sap.ushell.services.Personalization.PersonalizationContainerVariant
","typeInfo":{"template":"object"}},"parameters":[{"name":"sVariantName","optional":false,"description":"
variant set name
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Creates a new variant in the variant set. sap.ushell.services.Personalization.PersonalizationContainerVariantSet#addVariant In case a variant with this name is already existing an exception is thrown.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#addVariant} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariantSet#methods/addVariant","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#addVariant instead.","code":"addVariant(sVariantName) : object "},{"name":"containsVariant","visibility":"public","since":"1.18.0","returnValue":{"type":"boolean","description":"true if the variant set contains a variant with the key
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"sVariantKey","optional":false,"description":"
variant key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Checks if a specific variant is contained in the variant set.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#containsVariant} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariantSet#methods/containsVariant","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#containsVariant instead.","code":"containsVariant(sVariantKey) : boolean "},{"name":"delVariant","visibility":"public","since":"1.18.0","parameters":[{"name":"sVariantKey","optional":false,"description":"
variant key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Deletes a variant from the variant set. In case the variant does not exist nothing happens.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#deleteVariant} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariantSet#methods/delVariant","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#deleteVariant instead.","code":"delVariant(sVariantKey) : void "},{"name":"getCurrentVariantKey","visibility":"public","since":"1.18.0","returnValue":{"type":"string","description":"current variant key. In case the current variant was never set null is returned.
","typeInfo":{"template":"string"}},"description":"Returns the current variant key.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#getCurrentVariantKey} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariantSet#methods/getCurrentVariantKey","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#getCurrentVariantKey instead.","code":"getCurrentVariantKey() : string "},{"name":"getVariant","visibility":"public","since":"1.18.0","returnValue":{"type":"object","description":"sap.ushell.services.Personalization.PersonalizationContainerVariant In case the variant set does not contain a variant with this key undefined is returned.
","typeInfo":{"template":"object"}},"parameters":[{"name":"sVariantKey","optional":false,"description":"
variant key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns a variant object.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#getVariant} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariantSet#methods/getVariant","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#getVariant instead.","code":"getVariant(sVariantKey) : object "},{"name":"getVariantKeyByName","visibility":"public","since":"1.18.0","returnValue":{"type":"object","description":"variant key. In case the variant set does not contain a variant with this name undefined is returned.
","typeInfo":{"template":"object"}},"parameters":[{"name":"sVariantName","optional":false,"description":"
variant name
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns the variant key corresponding to a variant name.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#getVariantKeyByName} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariantSet#methods/getVariantKeyByName","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#getVariantKeyByName instead.","code":"getVariantKeyByName(sVariantName) : object "},{"name":"getVariantKeys","visibility":"public","since":"1.18.0","returnValue":{"type":"string[]","description":"variant keys
","typeInfo":{"template":"Array"}},"description":"Returns an array with the keys of the variants in the variant set.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#getVariantKeys} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariantSet#methods/getVariantKeys","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#getVariantKeys instead.","code":"getVariantKeys() : string[] "},{"name":"setCurrentVariantKey","visibility":"public","since":"1.18.0","parameters":[{"name":"sVariantKey","optional":false,"description":"
There is no validity check for the variant key.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Sets the current variant key.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#setCurrentVariantKey} instead."},"href":"api/sap.ushell.services.Personalization.PersonalizationContainerVariantSet#methods/setCurrentVariantKey","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#setCurrentVariantKey instead.","code":"setCurrentVariantKey(sVariantKey) : void "}],"displayName":"sap.ushell.services.Personalization.PersonalizationContainerVariantSet","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Personalization.PersonalizationContainerVariantSet","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Personalization#getContainer instead."},{"kind":"class","name":"sap.ushell.services.Personalization.Personalizer","basename":"Personalizer","resource":"sap/ushell/services/_Personalization/Personalizer.js","module":"sap/ushell/services/_Personalization/Personalizer","export":"","static":true,"visibility":"public","since":"1.15.0","description":"The Unified Shell personalizer providing set get delete methods to access the persisted personalization data in direct mode.
To be called by the personalization service getPersonalizer method.
","hideconstructor":true,"methods":[{"name":"delPersData","visibility":"public","since":"1.15.0","returnValue":{"type":"jQuery.Promise","description":"Resolves once the pers data was deleted or rejects with an error message.
","typeInfo":{"template":"jQuery.Promise"}},"description":"Deletes a personalization data value.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Personalizer#deletePersData} instead."},"href":"api/sap.ushell.services.Personalization.Personalizer#methods/delPersData","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Personalizer#deletePersData instead.","code":"delPersData() : jQuery.Promise "},{"name":"getPersData","visibility":"public","since":"1.15.0","returnValue":{"type":"jQuery.Promise","description":"Resolves the personalization value. If there is no personalization data for the item, undefined is returned. Promise object fail function: param {string} sMessage Error message.
","typeInfo":{"template":"jQuery.Promise"}},"description":"Gets a personalization data value.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Personalizer#getPersData} instead."},"href":"api/sap.ushell.services.Personalization.Personalizer#methods/getPersData","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Personalizer#getPersData instead.","code":"getPersData() : jQuery.Promise "},{"name":"setPersData","visibility":"public","since":"1.15.0","returnValue":{"type":"jQuery.Promise","description":"Resolves once the pers data was stored or rejects with an error message.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oValue","optional":false,"description":"
JSON object containing the personalization value.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets a personalization data value.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Personalizer#setPersData} instead."},"href":"api/sap.ushell.services.Personalization.Personalizer#methods/setPersData","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Personalizer#setPersData instead.","code":"setPersData(oValue) : jQuery.Promise "}],"displayName":"sap.ushell.services.Personalization.Personalizer","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Personalization.Personalizer","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Personalizer instead."},{"kind":"class","name":"sap.ushell.services.Personalization.TransientPersonalizer","basename":"TransientPersonalizer","resource":"sap/ushell/services/_Personalization/TransientPersonalizer.js","module":"sap/ushell/services/_Personalization/TransientPersonalizer","export":"","static":true,"visibility":"public","since":"1.18.0","description":"The transient personalizer shall be used in container mode for table personalization. To be called by the personalization service getTransientPersonalizer method.
","constructor":{"visibility":"public","references":[],"codeExample":"new sap.ushell.services.Personalization.TransientPersonalizer() "},"displayName":"sap.ushell.services.Personalization.TransientPersonalizer","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Personalization.TransientPersonalizer","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.TransientPersonalizer instead."},{"kind":"class","name":"sap.ushell.services.Personalization.Variant","basename":"Variant","resource":"sap/ushell/services/_Personalization/Variant.js","module":"sap/ushell/services/_Personalization/Variant","export":"","static":true,"visibility":"public","since":"1.22.0","description":"The personalization variant contains personalization data. It is used in the personalization container mode.
To be instantiated via Personalization.VariantSet add / get Variant only
","hideconstructor":true,"methods":[{"name":"containsItem","visibility":"public","since":"1.18.0","returnValue":{"type":"boolean","description":"true if the variant contains an item with the key
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Checks if a specific item is contained in this variant.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#containsItem} instead."},"href":"api/sap.ushell.services.Personalization.Variant#methods/containsItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#containsItem instead.","code":"containsItem(sItemKey) : boolean "},{"name":"delItem","visibility":"public","since":"1.22.0","parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Deletes an item from this variant. In case the item does not exist, nothing happens.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#deleteItem} instead."},"href":"api/sap.ushell.services.Personalization.Variant#methods/delItem","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#deleteItem instead.","code":"delItem(sItemKey) : void "},{"name":"getItemKeys","visibility":"public","since":"1.22.0","returnValue":{"type":"string[]","description":"item keys
","typeInfo":{"template":"Array"}},"description":"Returns an array with the keys of all items in this variant.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#getItemKeys} instead."},"href":"api/sap.ushell.services.Personalization.Variant#methods/getItemKeys","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#getItemKeys instead.","code":"getItemKeys() : string[] "},{"name":"getItemValue","visibility":"public","since":"1.18.0","returnValue":{"type":"object","description":"item value (JSON object). In case the variant does not contain an item with this key undefined is returned.
","typeInfo":{"template":"object"}},"parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns the value for an item in this variant.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#getItemValue} instead."},"href":"api/sap.ushell.services.Personalization.Variant#methods/getItemValue","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#getItemValue instead.","code":"getItemValue(sItemKey) : object "},{"name":"getVariantKey","visibility":"public","since":"1.22.0","returnValue":{"type":"string","description":"variant key.
","typeInfo":{"template":"string"}},"description":"Returns the key of this variant.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#getVariantKey} instead."},"href":"api/sap.ushell.services.Personalization.Variant#methods/getVariantKey","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#getVariantKey instead.","code":"getVariantKey() : string "},{"name":"getVariantName","visibility":"public","since":"1.22.0","returnValue":{"type":"string","description":"variant name.
","typeInfo":{"template":"string"}},"description":"Returns the name of this variant.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#getVariantName} instead."},"href":"api/sap.ushell.services.Personalization.Variant#methods/getVariantName","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#getVariantName instead.","code":"getVariantName() : string "},{"name":"setItemValue","visibility":"public","since":"1.18.0","parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oItemValue","optional":false,"description":"
item value (JSON object)
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets the value for an item in this variant.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#setItemValue} instead."},"href":"api/sap.ushell.services.Personalization.Variant#methods/setItemValue","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#setItemValue instead.","code":"setItemValue(sItemKey, oItemValue) : void "},{"name":"setVariantName","visibility":"public","since":"1.24.0","parameters":[{"name":"sVariantName","optional":false,"description":"
variant name
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Sets the name of the variant.
In case a variant with sVariantName is already existing in the corresponding variant set an exception is thrown.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.Variant#setVariantName} instead."},"href":"api/sap.ushell.services.Personalization.Variant#methods/setVariantName","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant#setVariantName instead.","code":"setVariantName(sVariantName) : void "}],"displayName":"sap.ushell.services.Personalization.Variant","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Personalization.Variant","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.Variant instead."},{"kind":"class","name":"sap.ushell.services.Personalization.VariantSet","basename":"VariantSet","resource":"sap/ushell/services/_Personalization/VariantSet.js","module":"sap/ushell/services/_Personalization/VariantSet","export":"","static":true,"visibility":"public","since":"1.22.0","description":"The personalization variant set contains variants of personalization data. It is used in the personalization container mode. A VariantSet is a class representing a collection of Variants (identified by a key and name) and a member variable indicating the \"current variable\"
When manipulating the underlying data, additional constraints are enforced.
To be called by the personalization container.
","hideconstructor":true,"methods":[{"name":"addVariant","visibility":"public","since":"1.22.0","returnValue":{"type":"object","description":"sap.ushell.services.PersonalizationContainerVariant
","typeInfo":{"template":"object"}},"parameters":[{"name":"sVariantName","optional":false,"description":"
variant set name.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Creates a new variant in the variant set. In case a variant with this name is already existing an exception is thrown.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#addVariant} instead."},"href":"api/sap.ushell.services.Personalization.VariantSet#methods/addVariant","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#addVariant instead.","code":"addVariant(sVariantName) : object "},{"name":"containsVariant","visibility":"public","since":"1.22.0","returnValue":{"type":"boolean","description":"true if the variant set contains a variant with the key
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"sVariantKey","optional":false,"description":"
variant key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Checks if a specific variant is contained in the variant set.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#containsVariant} instead."},"href":"api/sap.ushell.services.Personalization.VariantSet#methods/containsVariant","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#containsVariant instead.","code":"containsVariant(sVariantKey) : boolean "},{"name":"delVariant","visibility":"public","since":"1.22.0","parameters":[{"name":"sVariantKey","optional":false,"description":"
variant key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Deletes a variant from the variant set. In case the variant does not exist nothing happens.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#deleteVariant} instead."},"href":"api/sap.ushell.services.Personalization.VariantSet#methods/delVariant","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#deleteVariant instead.","code":"delVariant(sVariantKey) : void "},{"name":"getCurrentVariantKey","visibility":"public","since":"1.22.0","returnValue":{"type":"string","description":"current variant key. In case the current variant was never set null is returned.
","typeInfo":{"template":"string"}},"description":"Returns the current variant key.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#getCurrentVariantKey} instead."},"href":"api/sap.ushell.services.Personalization.VariantSet#methods/getCurrentVariantKey","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#getCurrentVariantKey instead.","code":"getCurrentVariantKey() : string "},{"name":"getVariant","visibility":"public","since":"1.22.0","returnValue":{"type":"object","description":"sap.ushell.services.PersonalizationContainerVariant . In case the variant set does not contain a variant with this key undefined is returned.
","typeInfo":{"template":"object"}},"parameters":[{"name":"sVariantKey","optional":false,"description":"
variant key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns a variant object.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#getVariant} instead."},"href":"api/sap.ushell.services.Personalization.VariantSet#methods/getVariant","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#getVariant instead.","code":"getVariant(sVariantKey) : object "},{"name":"getVariantKeyByName","visibility":"public","since":"1.22.0","returnValue":{"type":"string","description":"variant key. In case the variant set does not contain a variant with this name undefined is returned.
","typeInfo":{"template":"string"}},"parameters":[{"name":"sVariantName","optional":false,"description":"
variant name
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns the variant key corresponding to a variant name.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#getVariantKeyByName} instead."},"href":"api/sap.ushell.services.Personalization.VariantSet#methods/getVariantKeyByName","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#getVariantKeyByName instead.","code":"getVariantKeyByName(sVariantName) : string "},{"name":"getVariantKeys","visibility":"public","since":"1.22.0","returnValue":{"type":"string[]","description":"variant keys
","typeInfo":{"template":"Array"}},"description":"Returns an array with the keys of the variants in the variant set.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#getVariantKeys} instead."},"href":"api/sap.ushell.services.Personalization.VariantSet#methods/getVariantKeys","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#getVariantKeys instead.","code":"getVariantKeys() : string[] "},{"name":"setCurrentVariantKey","visibility":"public","since":"1.22.0","parameters":[{"name":"sVariantKey","optional":false,"description":"
There is no validity check for the variant key.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Sets the current variant key.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSet#setCurrentVariantKey} instead."},"href":"api/sap.ushell.services.Personalization.VariantSet#methods/setCurrentVariantKey","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet#setCurrentVariantKey instead.","code":"setCurrentVariantKey(sVariantKey) : void "}],"displayName":"sap.ushell.services.Personalization.VariantSet","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Personalization.VariantSet","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSet instead."},{"kind":"class","name":"sap.ushell.services.Personalization.VariantSetAdapter","basename":"VariantSetAdapter","resource":"sap/ushell/services/personalization/VariantSetAdapter.js","module":"sap/ushell/services/personalization/VariantSetAdapter","export":"","static":true,"visibility":"public","since":"1.18.0","description":"Wrapper object to expose a variant interface on a ContextContainer object obtained from the Personalization service:
\ngetContainer(...).done( function(oContainer) {\n that.oVariantSetContainer = new VariantSetAdapter(oContainer);\n});\n ","constructor":{"visibility":"public","parameters":[{"name":"oContextContainer","optional":false,"description":"
Context
","phoneName":"oContextContainer","depth":0,"types":[],"typeInfo":{"template":"object"},"defaultValue":""}],"description":"VariantSetAdapter amends ContextContainer with functionality to
Example: An application has two types of variants. Variant type 1 contains filter values for a query, which are stored in item 1 of the variant, and personalization data for a table, which are stored in item 2 of the variant. Variant type 2 contains a setting (item 3) that is independent of the filtering and the table settings. It might be used for a different screen than the variants of type 1. In this example you would have 2 variant sets, one for each variant type.
","references":[],"codeExample":"new sap.ushell.services.Personalization.VariantSetAdapter(oContextContainer) "},"methods":[{"name":"addVariantSet","visibility":"public","since":"1.22.0","returnValue":{"type":"object","description":"ontainerVariantSet
","typeInfo":{"template":"object"}},"parameters":[{"name":"sVariantSetKey","optional":false,"description":"
variant set key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Creates a new variant set in the container. In case a variant set with this key is already existing an exception is thrown.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSetAdapter#addVariantSet} instead."},"href":"api/sap.ushell.services.Personalization.VariantSetAdapter#methods/addVariantSet","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSetAdapter#addVariantSet instead.","code":"addVariantSet(sVariantSetKey) : object "},{"name":"containsVariantSet","visibility":"public","since":"1.18.0","returnValue":{"type":"boolean","description":"true if the container contains a variant set with the key
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"sVariantSetKey","optional":false,"description":"
variant set key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Checks if a specific variant set is contained in the container.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSetAdapter#containsVariantSet} instead."},"href":"api/sap.ushell.services.Personalization.VariantSetAdapter#methods/containsVariantSet","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSetAdapter#containsVariantSet instead.","code":"containsVariantSet(sVariantSetKey) : boolean "},{"name":"delVariantSet","visibility":"public","since":"1.22.0","parameters":[{"name":"sVariantSetKey","optional":false,"description":"
variant set key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Deletes a variant set from the container. In case the variant set does not exist nothing happens.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSetAdapter#deleteVariantSet} instead."},"href":"api/sap.ushell.services.Personalization.VariantSetAdapter#methods/delVariantSet","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSetAdapter#deleteVariantSet instead.","code":"delVariantSet(sVariantSetKey) : void "},{"name":"getVariantSet","visibility":"public","since":"1.22.0","returnValue":{"type":"object","description":"ontainerVariantSet . In case the container does not contain a variant set with this key undefined is returned.
","typeInfo":{"template":"object"}},"parameters":[{"name":"sVariantSetKey","optional":false,"description":"
variant set key The string length is restricted to 40 characters
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns the variant set object from the container.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSetAdapter#getVariantSet} instead."},"href":"api/sap.ushell.services.Personalization.VariantSetAdapter#methods/getVariantSet","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSetAdapter#getVariantSet instead.","code":"getVariantSet(sVariantSetKey) : object "},{"name":"getVariantSetKeys","visibility":"public","since":"1.18.0","returnValue":{"type":"string[]","description":"variant set keys
","typeInfo":{"template":"Array"}},"description":"Returns an array with the keys of the variant sets in the container.
","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2.VariantSetAdapter#getVariantSetKeys} instead."},"href":"api/sap.ushell.services.Personalization.VariantSetAdapter#methods/getVariantSetKeys","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSetAdapter#getVariantSetKeys instead.","code":"getVariantSetKeys() : string[] "}],"displayName":"sap.ushell.services.Personalization.VariantSetAdapter","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Personalization.VariantSetAdapter","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2.VariantSetAdapter instead."},{"kind":"class","name":"sap.ushell.services.PersonalizationV2","basename":"PersonalizationV2","resource":"sap/ushell/services/PersonalizationV2.js","module":"sap/ushell/services/PersonalizationV2","export":"","static":true,"visibility":"public","since":"1.120.0","extends":"sap.ushell.services.Service","description":"The Unified Shell's personalization service. Provides a personalizer object that handles all personalization operations.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const PersonalizationV2 = await Container.getServiceAsync(\"PersonalizationV2\");\n // do something with the PersonalizationV2 service\n });\n ","hideconstructor":true,"methods":[{"name":"createEmptyContainer","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves a ContextContainer as parameter. object as parameter. The personalization container provides two different interfaces to synchronously operate on personalization data. In the item mode the container contains items as name value pairs for personalization data. In the variant mode the container contains variant sets which contain variants containing items.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.PersonalizationV2.ContextContainer"]}},"parameters":[{"name":"sContainerKey","optional":false,"description":"
Identifies the container. The string length is restricted to 40 characters
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oScope","optional":false,"description":"
Currently the validity property of the scope object is relevant. { validity : 30} indicates a validity of the data for 30 minutes.
","typeInfo":{"UI5Types":["sap.ushell.services.PersonalizationV2.Scope"],"refersToTypedef":true},"defaultValue":""},{"name":"oComponent","optional":false,"description":"
Component which uses the container. This allows to associate the stored data with the application.
","typeInfo":{"UI5Types":["sap.ui.core.Component"]},"defaultValue":""}],"description":"Factory method to obtain an empty Data Context object. When data present in a prior context is not relevant (e.g. when using a \"uniquely\" generated key and planning to overwrite any colliding front-end server data).
The call always returns an cleared container().
Note that an existing container at the front-end server is not actually deleted or overwritten unless a save operation is executed.
An initial object is returned.
","href":"api/sap.ushell.services.PersonalizationV2#methods/createEmptyContainer","code":"createEmptyContainer(sContainerKey, oScope, oComponent) : Promise "},{"name":"deleteContainer","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves once the container was deleted.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sContainerKey","optional":false,"description":"
identifies the container
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oScope","optional":false,"description":"
The scope
","typeInfo":{"UI5Types":["sap.ushell.services.PersonalizationV2.Scope"],"refersToTypedef":true},"defaultValue":""}],"description":"Asynchronously starts a deletion request for the given container identified by sContainerKey. Can be called without having ever called getContainer with the corresponding key
Note: After invoking this operation, the state of other containers obtained for the same key is undefined! If you want to use the container after deletion, it is strongly recommended to obtain a new instance of a container for the given key *after* the promise has returned.
Note: Invoking this operation while another save or load operation is under way may result in failure.
","href":"api/sap.ushell.services.PersonalizationV2#methods/deleteContainer","code":"deleteContainer(sContainerKey, oScope) : Promise "},{"name":"getContainer","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves a ContextContainer as parameter. The container provides setItemValue / getItemValue methods to synchronously operate on personalization data. By wrapping it in a VariantSetAdapter, an alternate interface to maintain variants can be obtained.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.PersonalizationV2.ContextContainer"]}},"parameters":[{"name":"sContainerKey","optional":false,"description":"
Identifies the container. The string length is restricted to 40 characters
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oScope","optional":false,"description":"
Currently the validity property of the scope object is relevant: E.g. { validity : 30} indicates a validity of the data for 30 minutes.
","typeInfo":{"UI5Types":["sap.ushell.services.PersonalizationV2.Scope"],"refersToTypedef":true},"defaultValue":""},{"name":"oComponent","optional":false,"description":"
Component which uses the container. This allows to associate the stored data with the application.
","typeInfo":{"UI5Types":["sap.ui.core.Component"]},"defaultValue":""}],"description":"Factory method to obtain a Data Context object, which is a local copy of the persistence layer data. The Container data is asynchronously read on creation if present, otherwise an initial object is created. The Container data can then be *synchronously* modified (getItemValue, setItemValue). Only on invoking the save() method the data is transferred to the persistence. This allows the application to perform multiple local modifications and delay the save operation.
Every getContainer operation returns a new local copy, containing the full data at the point of creation.
Executing load() on the container reloads the data from the persistence, discarding local changes.
Note that the container allows the application to control the round trips to the front-end server persistence. The factory method getContainer is asynchronous and loads the container via the connected adapter from the front-end server. All operations (but for the save operation) are executed synchronously, operating on the local data. This allows the application to control the round trips to the front-end server persistence.
A container can contain a set of items, identified by a key.
You can wrap a container in a VariantSetAdapter to read and write a more complex structure (with multiple keys (variantSet,variant,item)).
Do not mix up the usage of a personalizer and a container for one containerKey. Do not use a PersonalizationContainer and a Container for the same key except for migration scenarios.
scope / validity parameter: An unspecified (undefined validity) or infinite (Infinity) validity indicates that data is persisted in the Personalization data of the front-end server. A round trip is executed on an initial get and at least every save operation. Data is stored per user and retained indefinitely at the front-end server.
The validity parameter allows a designated storage validity for the created container. A 0 validity indicates the data is only persisted within the Fiori launchpad window. No round trips to the front-end server are executed. Data is lost if the Fiori launchpad window state is lost (e.g. by navigating to a different page, pressing F5 (reload page) or duplicating the window).
For versions > 1.24 it may happen that for cross-app navigation a reload of the Fiori launchpad is triggered. In this case a storage of the personalization data in the Fiori launchpad window would lead to data loss. To overcome this a validity 0 is automatically changed to a validity 1440 (24h; storage on the front-end server). This is only done if a reload of the Fiori launchpad is triggered for a cross-app navigation.
Security: It is the responsibility of the application to not persist information relevant to auditing or security using the PersonalizationService with inappropriate validity models. No mechanisms exist to destroy or selectively destroy application-specific data in the front-end server persistence (especially for validity Infinity).
For non-zero validity scopes, data will be transmitted and persisted in the front-end server system.
For limited validity, actual deletion of data on the front-end server is subject to explicit cleanup execution of front-end server jobs and not guaranteed. The data may still be persisted and retrievable. The interface only assures that expired data is no longer exposed to the application code in the Fiori launchpad.
The ContainerKey uniquely defines the Container, validity is not part of the key (there are no separate namespaces per validity).
In general, mixing different validity models for a given container key is not supported. Fast chaining of different methods may source arbitrary persistence layers. The validity of the resolved object is the last get validity.
The validity associated with the last getContainer or createEmptyContainer determines the current validity of the container and the validity used during the next save operation.
Naturally, if a delete or get with validity 0 is issued, it will *not* delete or retrieve a front-end server persistent storage. Thus a sequence delete( [validity 0])/wait for promise, getContainer(sKey,{ validity : Infinity}) may return a valid dataset.
","href":"api/sap.ushell.services.PersonalizationV2#methods/getContainer","code":"getContainer(sContainerKey, oScope, oComponent) : Promise "},{"name":"getGeneratedKey","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"40 character string consisting of A-Z and 0-9 which can be used as a generated key for personalization container. Every invocation returns a new key. Seed of random function is OS Random Seed.
","typeInfo":{"template":"Promise"}},"description":"Returns a generated key. This key is suitably random, but it is susceptible to brute force attacks. Storages based on the generated key must not be used for sensitive data.
","href":"api/sap.ushell.services.PersonalizationV2#methods/getGeneratedKey","code":"getGeneratedKey() : Promise "},{"name":"getPersonalizer","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"which provides generic read and write access to the currently logged on user's personalization settings.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.PersonalizationV2.Personalizer"]}},"parameters":[{"name":"oPersId","optional":false,"description":"
object for identifying the data
","typeInfo":{"UI5Types":["sap.ushell.services.PersonalizationV2.PersId"],"refersToTypedef":true},"defaultValue":""},{"name":"oScope","optional":false,"description":"
scope object { validity: 30} indicates a validity of the data for 30 minutes.
","typeInfo":{"UI5Types":["sap.ushell.services.PersonalizationV2.Scope"],"refersToTypedef":true},"defaultValue":""},{"name":"oComponent","optional":true,"description":"
Component which uses the personalizer. This allows to associate the stored data with the application.
","typeInfo":{"UI5Types":["sap.ui.core.Component"]},"defaultValue":""}],"description":"Returns a personalizer object which handles personalization by asynchronous operations storing the personalization data immediately via the connected adapter. For each operation a round trip is executed.
Do not mix the usage of a personalizer and a personalization container for one containerKey.
Fetching multiple Personalizer for the same container, but different items is not supported. Use sap.ushell.services.PersonalizationV2#getContainer instead for this scenario.
","href":"api/sap.ushell.services.PersonalizationV2#methods/getPersonalizer","code":"getPersonalizer(oPersId, oScope, oComponent?) : Promise "},{"name":"getTransientPersonalizer","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"which provides asynchronous read and write access to a transient personalization data storage.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.PersonalizationV2.TransientPersonalizer"]}},"description":"Returns a transient personalizer object which handles personalization by asynchronous operations storing the personalization data transiently as an object property. Primary usage of the transient personalizer is a personalization scenario with variants where the transient personalizer is used as a buffer for table personalization data.
","href":"api/sap.ushell.services.PersonalizationV2#methods/getTransientPersonalizer","code":"getTransientPersonalizer() : Promise "}],"displayName":"sap.ushell.services.PersonalizationV2","nodes":[{"name":"sap.ushell.services.PersonalizationV2.ContextContainer","description":"The container is the anchor object of the unified shell personalization in container mode.\n
","href":"api/sap.ushell.services.PersonalizationV2.ContextContainer"},{"name":"sap.ushell.services.PersonalizationV2.KeyCategory","description":"","href":"api/sap.ushell.services.PersonalizationV2.KeyCategory"},{"name":"sap.ushell.services.PersonalizationV2.PersId","description":"The persId identifies the stored personalization container.
","href":"api/sap.ushell.services.PersonalizationV2.PersId"},{"name":"sap.ushell.services.PersonalizationV2.Personalizer","description":"The Unified Shell personalizer providing set get delete methods to access the persisted personalization data in direct mode.\n
","href":"api/sap.ushell.services.PersonalizationV2.Personalizer"},{"name":"sap.ushell.services.PersonalizationV2.Scope","description":"The scope controls the behavior of the container used by the personalization service.
","href":"api/sap.ushell.services.PersonalizationV2.Scope"},{"name":"sap.ushell.services.PersonalizationV2.TransientPersonalizer","description":"The transient personalizer shall be used in container mode for table personalization.
","href":"api/sap.ushell.services.PersonalizationV2.TransientPersonalizer"},{"name":"sap.ushell.services.PersonalizationV2.Variant","description":"The personalization variant contains personalization data.
","href":"api/sap.ushell.services.PersonalizationV2.Variant"},{"name":"sap.ushell.services.PersonalizationV2.VariantSet","description":"A VariantSet is a class representing a collection of Variants (identified by a key and name) and a member variable indicating the \"current variable\"
When manipulating the underlying data, additional constraints are enforced.
The personalization variant set contains variants of personalization data. It is used in the personalization container mode.
To be called by the personalization container
","href":"api/sap.ushell.services.PersonalizationV2.VariantSet"},{"name":"sap.ushell.services.PersonalizationV2.VariantSetAdapter","description":"Wrapper object to expose a variant interface on a ContextContainer object obtained from the PersonalizationV2 service:
\noPersonalizationV2Service.getContainer(...).then(function(oContainer) {\n that.oVariantSetContainer = new VariantSetAdapter(oContainer);\n});\n VariantSetAdapter amends ContextContainer with functionality to
Example: An application has two types of variants. Variant type 1 contains filter values for a query, which are stored in item 1 of the variant, and personalization data for a table, which are stored in item 2 of the variant. Variant type 2 contains a setting (item 3) that is independent of the filtering and the table settings. It might be used for a different screen than the variants of type 1. In this example you would have 2 variant sets, one for each variant type.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSetAdapter"},{"name":"sap.ushell.services.PersonalizationV2.WriteFrequency","description":"","href":"api/sap.ushell.services.PersonalizationV2.WriteFrequency"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.PersonalizationV2","subTitle":""},{"kind":"class","name":"sap.ushell.services.PersonalizationV2.ContextContainer","basename":"ContextContainer","resource":"sap/ushell/services/PersonalizationV2/ContextContainer.js","module":"sap/ushell/services/PersonalizationV2/ContextContainer","export":"","static":true,"visibility":"public","since":"1.120.0","description":"The container is the anchor object of the unified shell personalization in container mode.
To be called by the personalization service getContainer method.
","hideconstructor":true,"methods":[{"name":"clearData","visibility":"public","since":"1.120.0","description":"clears the local copy data of this container
","href":"api/sap.ushell.services.PersonalizationV2.ContextContainer#methods/clearData","code":"clearData() : void "},{"name":"containsItem","visibility":"public","since":"1.120.0","returnValue":{"type":"boolean","description":"true if the container contains a direct item with the key
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Checks if a specific direct item is contained in the container.
","href":"api/sap.ushell.services.PersonalizationV2.ContextContainer#methods/containsItem","code":"containsItem(sItemKey) : boolean "},{"name":"deleteItem","visibility":"public","since":"1.120.0","parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Deletes a direct item from the container. In case the item does not exist, nothing happens.
","href":"api/sap.ushell.services.PersonalizationV2.ContextContainer#methods/deleteItem","code":"deleteItem(sItemKey) : void "},{"name":"flushPendingRequests","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves once the pending requests were flushed.
","typeInfo":{"template":"Promise"}},"description":"flush all pending request; The result of the promise may reflect the last pending operation in the queue
","href":"api/sap.ushell.services.PersonalizationV2.ContextContainer#methods/flushPendingRequests","code":"flushPendingRequests() : Promise "},{"name":"getItemKeys","visibility":"public","since":"1.120.0","returnValue":{"type":"string[]","description":"item keys
","typeInfo":{"template":"Array"}},"description":"Returns an array with the keys of direct items in the container.
","href":"api/sap.ushell.services.PersonalizationV2.ContextContainer#methods/getItemKeys","code":"getItemKeys() : string[] "},{"name":"getItemValue","visibility":"public","since":"1.120.0","returnValue":{"type":"object","description":"item value (JSON object). In case the container does not contain a direct item with this key undefined is returned.
","typeInfo":{"template":"object"}},"parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns the value for a direct item from the container. (Value semantics, new copy is returned)
","href":"api/sap.ushell.services.PersonalizationV2.ContextContainer#methods/getItemValue","code":"getItemValue(sItemKey) : object "},{"name":"getKey","visibility":"public","since":"1.120.0","returnValue":{"type":"string","description":"the container key
","typeInfo":{"template":"string"}},"description":"return the container key as a string variable
","href":"api/sap.ushell.services.PersonalizationV2.ContextContainer#methods/getKey","code":"getKey() : string "},{"name":"load","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves with undefined on success or rejects on failure
","typeInfo":{"template":"Promise"}},"description":"(Re)loads the current container data from the underlying storage asynchronously. The current local data is discarded.
Returns a promise for the load operation. If another save/load/delete operation is not completed, the operation may fail! (wait for the other promise).
Synchronous read and write operations before the load is done have undefined effects.
","href":"api/sap.ushell.services.PersonalizationV2.ContextContainer#methods/load","code":"load() : Promise "},{"name":"save","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Promise object
The operation may wait for completion of another pending operation.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"nDelayInMilliseconds","optional":false,"description":"
the delay.
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Save the current container data at the underlying storage asynchronously at the earliest nDelayInMilliseconds seconds before. The current state is serialized.
","href":"api/sap.ushell.services.PersonalizationV2.ContextContainer#methods/save","code":"save(nDelayInMilliseconds) : Promise "},{"name":"setItemValue","visibility":"public","since":"1.120.0","parameters":[{"name":"sItemKey","optional":false,"description":"
item key. The string length is restricted to 40 characters
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oItemValue","optional":false,"description":"
item value (JSON object)
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets the value of a direct item in the container. In case the item is already existing its value is overwritten. In case it is not existing a new item with this key and value is created. The value is serialized during set
","href":"api/sap.ushell.services.PersonalizationV2.ContextContainer#methods/setItemValue","code":"setItemValue(sItemKey, oItemValue) : void "}],"displayName":"sap.ushell.services.PersonalizationV2.ContextContainer","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.PersonalizationV2.ContextContainer","subTitle":""},{"kind":"enum","name":"sap.ushell.services.PersonalizationV2.KeyCategory","basename":"KeyCategory","resource":"sap/ushell/services/PersonalizationV2/constants.js","module":"sap/ushell/services/PersonalizationV2/constants","static":true,"visibility":"public","since":"1.124.0","ui5-metadata":{"stereotype":"enum"},"properties":[{"name":"sap.ushell.services.PersonalizationV2.KeyCategory.FIXED_KEY","visibility":"public","description":"A static hard-coded key which does not change. This value is required for caching to take place.
"},{"name":"sap.ushell.services.PersonalizationV2.KeyCategory.GENERATED_KEY","visibility":"public","description":"For all other cases.
"}],"displayName":"sap.ushell.services.PersonalizationV2.KeyCategory","component":"CA-FLP-FE-UI","hasSample":false,"title":"enum sap.ushell.services.PersonalizationV2.KeyCategory","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.PersonalizationV2.PersId","basename":"PersId","resource":"sap/ushell/services/PersonalizationV2.js","module":"sap/ushell/services/PersonalizationV2","static":true,"visibility":"public","description":"
The persId identifies the stored personalization container.
","properties":[{"name":"container","optional":false,"visibility":"public","description":"Identifies the set of personalization data that is loaded/saved as one bundle from the front-end server.
","typeInfo":{"template":"string"}},{"name":"item","optional":false,"visibility":"public","description":"The name of the object the personalization is applied to.
","typeInfo":{"template":"string"}}],"displayName":"sap.ushell.services.PersonalizationV2.PersId","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.PersonalizationV2.PersId","subTitle":""},{"kind":"class","name":"sap.ushell.services.PersonalizationV2.Personalizer","basename":"Personalizer","resource":"sap/ushell/services/PersonalizationV2/Personalizer.js","module":"sap/ushell/services/PersonalizationV2/Personalizer","export":"","static":true,"visibility":"public","since":"1.120.0","description":"The Unified Shell personalizer providing set get delete methods to access the persisted personalization data in direct mode.
To be called by the personalization service getPersonalizer method.
","hideconstructor":true,"methods":[{"name":"deletePersData","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves if delete was successful
","typeInfo":{"template":"Promise"}},"description":"Deletes a personalization data value.
","href":"api/sap.ushell.services.PersonalizationV2.Personalizer#methods/deletePersData","code":"deletePersData() : Promise "},{"name":"getPersData","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves with the personalization data or rejects on failure
","typeInfo":{"template":"Promise"}},"description":"Gets a personalization data value.
","href":"api/sap.ushell.services.PersonalizationV2.Personalizer#methods/getPersData","code":"getPersData() : Promise "},{"name":"setPersData","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves if save was successful
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oValue","optional":false,"description":"
JSON object containing the personalization value.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets a personalization data value.
","href":"api/sap.ushell.services.PersonalizationV2.Personalizer#methods/setPersData","code":"setPersData(oValue) : Promise "}],"displayName":"sap.ushell.services.PersonalizationV2.Personalizer","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.PersonalizationV2.Personalizer","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.PersonalizationV2.Scope","basename":"Scope","resource":"sap/ushell/services/PersonalizationV2.js","module":"sap/ushell/services/PersonalizationV2","static":true,"visibility":"public","description":"
The scope controls the behavior of the container used by the personalization service.
","properties":[{"name":"validity","optional":true,"visibility":"public","description":"validity of the container persistence in minutes. Available values:
For validity > 0 (including infinity) a copy of the container is stored in the volatile memory of the launchpad window in the browser. Therefore, no roundtrip is necessary for reloading a container at a later point in time. Only if the launchpad itself is reloaded, the copy is lost and a roundtrip is necessary.
","typeInfo":{"template":"int"}},{"name":"keyCategory","optional":true,"visibility":"public","description":"Type or category of key
","typeInfo":{"UI5Types":["sap.ushell.services.PersonalizationV2.KeyCategory"]}},{"name":"writeFrequency","optional":true,"visibility":"public","description":"Expected frequency how often users will use this container to store data inside
","typeInfo":{"UI5Types":["sap.ushell.services.PersonalizationV2.WriteFrequency"]}},{"name":"clientStorageAllowed","optional":true,"visibility":"public","description":"Defines if storage on client side should be allowed or not. Security-relevant data must not be stored on client side, for instance in local storage or in the HTTP browser cache. Applications should set this parameter to true only if the data is not critical from a security point of view.
","typeInfo":{"template":"boolean"}},{"name":"shared","optional":true,"visibility":"public","description":"Indicates the container is intended to be shared across multiple applications.
","typeInfo":{"template":"boolean"}}],"displayName":"sap.ushell.services.PersonalizationV2.Scope","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.PersonalizationV2.Scope","subTitle":""},{"kind":"class","name":"sap.ushell.services.PersonalizationV2.TransientPersonalizer","basename":"TransientPersonalizer","resource":"sap/ushell/services/PersonalizationV2/TransientPersonalizer.js","module":"sap/ushell/services/PersonalizationV2/TransientPersonalizer","export":"","static":true,"visibility":"public","since":"1.120.0","description":"The transient personalizer shall be used in container mode for table personalization. To be called by the personalization service getTransientPersonalizer method.
","hideconstructor":true,"methods":[{"name":"deletePersData","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves if delete was successful.
","typeInfo":{"template":"Promise"}},"description":"Deletes a personalization data value.
","href":"api/sap.ushell.services.PersonalizationV2.TransientPersonalizer#methods/deletePersData","code":"deletePersData() : Promise "},{"name":"getPersData","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves the data.
","typeInfo":{"template":"Promise"}},"description":"Gets a personalization data value.
","href":"api/sap.ushell.services.PersonalizationV2.TransientPersonalizer#methods/getPersData","code":"getPersData() : Promise "},{"name":"setPersData","visibility":"public","since":"1.120.0","returnValue":{"type":"Promise","description":"Resolves if save was successful.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oValue","optional":false,"description":"
JSON object containing the personalization value.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets a personalization data value.
","href":"api/sap.ushell.services.PersonalizationV2.TransientPersonalizer#methods/setPersData","code":"setPersData(oValue) : Promise "}],"displayName":"sap.ushell.services.PersonalizationV2.TransientPersonalizer","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.PersonalizationV2.TransientPersonalizer","subTitle":""},{"kind":"class","name":"sap.ushell.services.PersonalizationV2.Variant","basename":"Variant","resource":"sap/ushell/services/PersonalizationV2/Variant.js","module":"sap/ushell/services/PersonalizationV2/Variant","export":"","static":true,"visibility":"public","since":"1.120.0","description":"The personalization variant contains personalization data. It is used in the personalization container mode.
To be instantiated via Personalization.VariantSet add / get Variant only
","hideconstructor":true,"methods":[{"name":"containsItem","visibility":"public","since":"1.120.0","returnValue":{"type":"boolean","description":"true if the variant contains an item with the key
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Checks if a specific item is contained in this variant.
","href":"api/sap.ushell.services.PersonalizationV2.Variant#methods/containsItem","code":"containsItem(sItemKey) : boolean "},{"name":"deleteItem","visibility":"public","since":"1.120.0","parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Deletes an item from this variant. In case the item does not exist, nothing happens.
","href":"api/sap.ushell.services.PersonalizationV2.Variant#methods/deleteItem","code":"deleteItem(sItemKey) : void "},{"name":"getItemKeys","visibility":"public","since":"1.120.0","returnValue":{"type":"string[]","description":"item keys
","typeInfo":{"template":"Array"}},"description":"Returns an array with the keys of all items in this variant.
","href":"api/sap.ushell.services.PersonalizationV2.Variant#methods/getItemKeys","code":"getItemKeys() : string[] "},{"name":"getItemValue","visibility":"public","since":"1.120.0","returnValue":{"type":"object","description":"item value (JSON object). In case the variant does not contain an item with this key undefined is returned.
","typeInfo":{"template":"object"}},"parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns the value for an item in this variant.
","href":"api/sap.ushell.services.PersonalizationV2.Variant#methods/getItemValue","code":"getItemValue(sItemKey) : object "},{"name":"getVariantKey","visibility":"public","since":"1.120.0","returnValue":{"type":"string","description":"variant key.
","typeInfo":{"template":"string"}},"description":"Returns the key of this variant.
","href":"api/sap.ushell.services.PersonalizationV2.Variant#methods/getVariantKey","code":"getVariantKey() : string "},{"name":"getVariantName","visibility":"public","since":"1.120.0","returnValue":{"type":"string","description":"variant name.
","typeInfo":{"template":"string"}},"description":"Returns the name of this variant.
","href":"api/sap.ushell.services.PersonalizationV2.Variant#methods/getVariantName","code":"getVariantName() : string "},{"name":"setItemValue","visibility":"public","since":"1.120.0","parameters":[{"name":"sItemKey","optional":false,"description":"
item key
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oItemValue","optional":false,"description":"
value (JSON object)
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets the value for an item in this variant.
","href":"api/sap.ushell.services.PersonalizationV2.Variant#methods/setItemValue","code":"setItemValue(sItemKey, oItemValue) : void "},{"name":"setVariantName","visibility":"public","since":"1.120.0","parameters":[{"name":"sVariantName","optional":false,"description":"
variant name
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Sets the name of the variant.
In case a variant with sVariantName is already existing in the corresponding variant set an exception is thrown.
","href":"api/sap.ushell.services.PersonalizationV2.Variant#methods/setVariantName","code":"setVariantName(sVariantName) : void "}],"displayName":"sap.ushell.services.PersonalizationV2.Variant","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.PersonalizationV2.Variant","subTitle":""},{"kind":"class","name":"sap.ushell.services.PersonalizationV2.VariantSet","basename":"VariantSet","resource":"sap/ushell/services/PersonalizationV2/VariantSet.js","module":"sap/ushell/services/PersonalizationV2/VariantSet","export":"","static":true,"visibility":"public","since":"1.120.0","description":"A VariantSet is a class representing a collection of Variants (identified by a key and name) and a member variable indicating the \"current variable\"
When manipulating the underlying data, additional constraints are enforced.
The personalization variant set contains variants of personalization data. It is used in the personalization container mode.
To be called by the personalization container
","constructor":{"visibility":"public","references":[],"codeExample":"new sap.ushell.services.PersonalizationV2.VariantSet() "},"methods":[{"name":"addVariant","visibility":"public","since":"1.120.0","returnValue":{"type":"sap.ushell.services.PersonalizationV2.Variant","description":"the variant.
","typeInfo":{"UI5Types":["sap.ushell.services.PersonalizationV2.Variant"]}},"parameters":[{"name":"sVariantName","optional":false,"description":"
variant set name
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Creates a new variant in the variant set. In case a variant with this name is already existing an exception is thrown.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSet#methods/addVariant","code":"addVariant(sVariantName) : sap.ushell.services.PersonalizationV2.Variant "},{"name":"containsVariant","visibility":"public","since":"1.120.0","returnValue":{"type":"boolean","description":"true if the variant set contains a variant with the key
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"sVariantKey","optional":false,"description":"
variant key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Checks if a specific variant is contained in the variant set.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSet#methods/containsVariant","code":"containsVariant(sVariantKey) : boolean "},{"name":"deleteVariant","visibility":"public","since":"1.120.0","parameters":[{"name":"sVariantKey","optional":false,"description":"
variant key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Deletes a variant from the variant set. In case the variant does not exist nothing happens.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSet#methods/deleteVariant","code":"deleteVariant(sVariantKey) : void "},{"name":"getCurrentVariantKey","visibility":"public","since":"1.120.0","returnValue":{"type":"string","description":"current variant key. In case the current variant was never set null is returned.
","typeInfo":{"template":"string"}},"description":"Returns the current variant key.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSet#methods/getCurrentVariantKey","code":"getCurrentVariantKey() : string "},{"name":"getVariant","visibility":"public","since":"1.120.0","returnValue":{"type":"sap.ushell.services.PersonalizationV2.Variant","description":"In case the variant set does not contain a variant with this key undefined is returned.
","typeInfo":{"UI5Types":["sap.ushell.services.PersonalizationV2.Variant"]}},"parameters":[{"name":"sVariantKey","optional":false,"description":"
variant key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns a variant object.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSet#methods/getVariant","code":"getVariant(sVariantKey) : sap.ushell.services.PersonalizationV2.Variant "},{"name":"getVariantKeyByName","visibility":"public","since":"1.120.0","returnValue":{"type":"string","description":"variant key. In case the variant set does not contain a variant with this name undefined is returned.
","typeInfo":{"template":"string"}},"parameters":[{"name":"sVariantName","optional":false,"description":"
variant name
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns the variant key corresponding to a variant name.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSet#methods/getVariantKeyByName","code":"getVariantKeyByName(sVariantName) : string "},{"name":"getVariantKeys","visibility":"public","since":"1.120.0","returnValue":{"type":"string[]","description":"variant keys
","typeInfo":{"template":"Array"}},"description":"Returns an array with the keys of the variants in the variant set.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSet#methods/getVariantKeys","code":"getVariantKeys() : string[] "},{"name":"setCurrentVariantKey","visibility":"public","since":"1.120.0","parameters":[{"name":"sVariantKey","optional":false,"description":"
There is no validity check for the variant key.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Sets the current variant key.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSet#methods/setCurrentVariantKey","code":"setCurrentVariantKey(sVariantKey) : void "}],"displayName":"sap.ushell.services.PersonalizationV2.VariantSet","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.PersonalizationV2.VariantSet","subTitle":""},{"kind":"class","name":"sap.ushell.services.PersonalizationV2.VariantSetAdapter","basename":"VariantSetAdapter","resource":"sap/ushell/services/PersonalizationV2/VariantSetAdapter.js","module":"sap/ushell/services/PersonalizationV2/VariantSetAdapter","export":"","static":true,"visibility":"public","since":"1.120.0","description":"Wrapper object to expose a variant interface on a ContextContainer object obtained from the PersonalizationV2 service:
\noPersonalizationV2Service.getContainer(...).then(function(oContainer) {\n that.oVariantSetContainer = new VariantSetAdapter(oContainer);\n});\n VariantSetAdapter amends ContextContainer with functionality to
Example: An application has two types of variants. Variant type 1 contains filter values for a query, which are stored in item 1 of the variant, and personalization data for a table, which are stored in item 2 of the variant. Variant type 2 contains a setting (item 3) that is independent of the filtering and the table settings. It might be used for a different screen than the variants of type 1. In this example you would have 2 variant sets, one for each variant type.
","constructor":{"visibility":"public","parameters":[{"name":"oContextContainer","optional":false,"description":"
Context
","phoneName":"oContextContainer","depth":0,"types":[],"typeInfo":{"UI5Types":["sap.ushell.services.PersonalizationV2.ContextContainer"]},"defaultValue":""}],"references":[],"codeExample":"new sap.ushell.services.PersonalizationV2.VariantSetAdapter(oContextContainer) "},"methods":[{"name":"addVariantSet","visibility":"public","since":"1.120.0","returnValue":{"type":"sap.ushell.services.PersonalizationV2.VariantSet","description":"The new VariantSet
","typeInfo":{"UI5Types":["sap.ushell.services.PersonalizationV2.VariantSet"]}},"parameters":[{"name":"sVariantSetKey","optional":false,"description":"
variant set key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Creates a new variant set in the container. In case a variant set with this key is already existing an exception is thrown.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSetAdapter#methods/addVariantSet","code":"addVariantSet(sVariantSetKey) : sap.ushell.services.PersonalizationV2.VariantSet "},{"name":"containsVariantSet","visibility":"public","since":"1.120.0","returnValue":{"type":"boolean","description":"true if the container contains a variant set with the key
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"sVariantSetKey","optional":false,"description":"
variant set key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Checks if a specific variant set is contained in the container.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSetAdapter#methods/containsVariantSet","code":"containsVariantSet(sVariantSetKey) : boolean "},{"name":"deleteVariantSet","visibility":"public","since":"1.120.0","parameters":[{"name":"sVariantSetKey","optional":false,"description":"
variant set key
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Deletes a variant set from the container. In case the variant set does not exist nothing happens.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSetAdapter#methods/deleteVariantSet","code":"deleteVariantSet(sVariantSetKey) : void "},{"name":"getVariantSet","visibility":"public","since":"1.120.0","returnValue":{"type":"sap.ushell.services.PersonalizationV2.VariantSet","description":"In case the container does not contain a variant set with this key undefined is returned.
","typeInfo":{"UI5Types":["sap.ushell.services.PersonalizationV2.VariantSet"]}},"parameters":[{"name":"sVariantSetKey","optional":false,"description":"
variant set key. The string length is restricted to 40 characters.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns the variant set object from the container.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSetAdapter#methods/getVariantSet","code":"getVariantSet(sVariantSetKey) : sap.ushell.services.PersonalizationV2.VariantSet "},{"name":"getVariantSetKeys","visibility":"public","since":"1.120.0","returnValue":{"type":"string[]","description":"variant set keys
","typeInfo":{"template":"Array"}},"description":"Returns an array with the keys of the variant sets in the container.
","href":"api/sap.ushell.services.PersonalizationV2.VariantSetAdapter#methods/getVariantSetKeys","code":"getVariantSetKeys() : string[] "}],"displayName":"sap.ushell.services.PersonalizationV2.VariantSetAdapter","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.PersonalizationV2.VariantSetAdapter","subTitle":""},{"kind":"enum","name":"sap.ushell.services.PersonalizationV2.WriteFrequency","basename":"WriteFrequency","resource":"sap/ushell/services/PersonalizationV2/constants.js","module":"sap/ushell/services/PersonalizationV2/constants","static":true,"visibility":"public","since":"1.124.0","ui5-metadata":{"stereotype":"enum"},"properties":[{"name":"sap.ushell.services.PersonalizationV2.WriteFrequency.HIGH","visibility":"public","description":""},{"name":"sap.ushell.services.PersonalizationV2.WriteFrequency.LOW","visibility":"public","description":"The key is typically rarely updated, for example in explicit table personalization by end users.
"}],"displayName":"sap.ushell.services.PersonalizationV2.WriteFrequency","component":"CA-FLP-FE-UI","hasSample":false,"title":"enum sap.ushell.services.PersonalizationV2.WriteFrequency","subTitle":""},{"kind":"class","name":"sap.ushell.services.PluginManager","basename":"PluginManager","resource":"sap/ushell/services/PluginManager.js","module":"sap/ushell/services/PluginManager","export":"","static":true,"visibility":"restricted","allowedFor":["sap.fe"],"since":"1.38","description":"The Unified Shell's PluginManager service.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const PluginManager = await Container.getServiceAsync(\"PluginManager\");\n // do something with the PluginManager service\n });\n ","hideconstructor":true,"methods":[{"name":"getRegisteredPlugins","visibility":"restricted","allowedFor":["sap.fe"],"since":"1.38","returnValue":{"type":"object","description":"Map of registered plugins
","typeInfo":{"template":"object"}},"description":"Returns a map of all the plugins which are registered with the PluginManager sorted by supported plugin categories.
\n{\n \"PluginCategoryA\": [oPluginX, oPluginY, oPluginZ],\n \"PluginCategoryB\": [oPluginG]\n}\n ","href":"api/sap.ushell.services.PluginManager#methods/getRegisteredPlugins","code":"getRegisteredPlugins() : object "}],"displayName":"sap.ushell.services.PluginManager","nodes":[{"name":"sap.ushell.services.PluginManager.PostMessagePluginInterface","description":"This namespace provides an interface independent of the runtime environment for post message communication.
","href":"api/sap.ushell.services.PluginManager.PostMessagePluginInterface"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.PluginManager","subTitle":""},{"kind":"namespace","name":"sap.ushell.services.PluginManager.PostMessagePluginInterface","basename":"PostMessagePluginInterface","resource":"sap/ushell/services/PluginManager/PostMessagePluginInterface.js","module":"sap/ushell/services/PluginManager/PostMessagePluginInterface","export":"","static":true,"visibility":"restricted","allowedFor":["sap.ui.rta"],"extends":"sap.ui.base.Object","description":"
This namespace provides an interface independent of the runtime environment for post message communication. However, it is only meant to be used in the context of \"application runtimes\" (FLP, appruntime).
It is not meant to be used in standalone iframes.
","ui5-metadata":{},"methods":[{"name":"createPostMessageResult","visibility":"restricted","allowedFor":["sap.ui.rta"],"returnValue":{"type":"jQuery.Promise","description":"A promise that resolves with the result object.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oResult","optional":true,"description":"
The result object.
","typeInfo":{"template":"any"},"defaultValue":""}],"description":"Sanitizes the result for the post message response.
","href":"api/sap.ushell.services.PluginManager.PostMessagePluginInterface#methods/createPostMessageResult","code":"createPostMessageResult(oResult?) : jQuery.Promise "},{"name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.extend","visibility":"restricted","allowedFor":["sap.ui.rta"],"static":true,"returnValue":{"type":"function","description":"Created class / constructor function
","typeInfo":{"template":"function"}},"parameters":[{"name":"sClassName","optional":false,"description":"
Name of the class being created
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"
Object literal with information about the class
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Creates a new subclass of class sap.ushell.services.PluginManager.PostMessagePluginInterface with name sClassName and enriches it with the information contained in oClassInfo.
oClassInfo might contain the same kind of information as described in sap.ui.base.Object.extend .
","href":"api/sap.ushell.services.PluginManager.PostMessagePluginInterface#methods/sap.ushell.services.PluginManager.PostMessagePluginInterface.extend","code":"sap.ushell.services.PluginManager.PostMessagePluginInterface.extend(sClassName, oClassInfo?, FNMetaImpl?) : function "},{"name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.getMetadata","visibility":"restricted","allowedFor":["sap.ui.rta"],"static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"Metadata object describing this class
","typeInfo":{"UI5Types":["sap.ui.base.Metadata"]}},"description":"Returns a metadata object for class sap.ushell.services.PluginManager.PostMessagePluginInterface.
","href":"api/sap.ushell.services.PluginManager.PostMessagePluginInterface#methods/sap.ushell.services.PluginManager.PostMessagePluginInterface.getMetadata","code":"sap.ushell.services.PluginManager.PostMessagePluginInterface.getMetadata() : sap.ui.base.Metadata "},{"name":"postMessageToApp","visibility":"restricted","allowedFor":["sap.ui.rta"],"returnValue":{"type":"jQuery.Promise","description":"A promise that resolves with the result of the post message.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sServiceName","optional":false,"description":"
The name of the service.
","typeInfo":{"UI5Types":["sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceName"]},"defaultValue":""},{"name":"sInterface","optional":false,"description":"
The interface to call.
","typeInfo":{"UI5Types":["sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceInterface"]},"defaultValue":""},{"name":"oBody","optional":false,"description":"
The parameters to pass to the interface.
","typeInfo":{"template":"any"},"defaultValue":""}],"description":"Posts a message to the application. Only available in the outer shell.
","href":"api/sap.ushell.services.PluginManager.PostMessagePluginInterface#methods/postMessageToApp","code":"postMessageToApp(sServiceName, sInterface, oBody) : jQuery.Promise "},{"name":"postMessageToFlp","visibility":"restricted","allowedFor":["sap.ui.rta"],"returnValue":{"type":"jQuery.Promise","description":"A promise that resolves with the result of the post message.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"sServiceName","optional":false,"description":"
The name of the service.
","typeInfo":{"UI5Types":["sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceName"]},"defaultValue":""},{"name":"sInterface","optional":false,"description":"
The interface to call.
","typeInfo":{"UI5Types":["sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceInterface"]},"defaultValue":""},{"name":"oBody","optional":false,"description":"
The parameters to pass to the interface.
","typeInfo":{"template":"any"},"defaultValue":""}],"description":"Posts a message to the FLP. Only available in the inner shell.
","href":"api/sap.ushell.services.PluginManager.PostMessagePluginInterface#methods/postMessageToFlp","code":"postMessageToFlp(sServiceName, sInterface, oBody) : jQuery.Promise "},{"name":"registerPostMessageAPIs","visibility":"restricted","allowedFor":["sap.ui.rta"],"returnValue":{"type":"{status:string,desc:string}","description":"The result of the registration. status can be \"success\" or \"error\", and desc provides a description of the result.
","typeInfo":{"template":"{status:string,desc:string}"}},"parameters":[{"name":"oNewCommunicationObject","optional":false,"description":"
The new communication object containing the APIs to register.
","typeInfo":{"UI5Types":["sap.ushell.services.PluginManager.PostMessagePluginInterface.CommunicationObject"]},"defaultValue":""},{"name":"bSAPInternal","optional":true,"defaultValue":false,"description":"
If true, the APIs are considered as internal SAP APIs and do not require the prefix 'user.postapi.'.
","typeInfo":{"template":"boolean"}}],"description":"Registers new post message APIs.
","href":"api/sap.ushell.services.PluginManager.PostMessagePluginInterface#methods/registerPostMessageAPIs","code":"registerPostMessageAPIs(oNewCommunicationObject, bSAPInternal?) : {status:string,desc:string} "}],"displayName":"sap.ushell.services.PluginManager.PostMessagePluginInterface","nodes":[{"name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.CommunicationObject","description":"Defines the communication object for post message APIs.
","href":"api/sap.ushell.services.PluginManager.PostMessagePluginInterface.CommunicationObject"},{"name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.InCallDefinition","description":"Defines the incoming call interface for post message usage in the sap.ushell.services.PluginManager.PostMessagePluginInterface.CommunicationObject .
","href":"api/sap.ushell.services.PluginManager.PostMessagePluginInterface.InCallDefinition"},{"name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.OutCallDefinition","description":"Defines the outgoing call interface for post message usage in the sap.ushell.services.PluginManager.PostMessagePluginInterface.CommunicationObject .
","href":"api/sap.ushell.services.PluginManager.PostMessagePluginInterface.OutCallDefinition"},{"name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceDefinition","description":"Defines the service definition for post message usage in the sap.ushell.services.PluginManager.PostMessagePluginInterface.CommunicationObject .
","href":"api/sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceDefinition"},{"name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceInterface","description":"The interface of the service.
","href":"api/sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceInterface"},{"name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceName","description":"The name of the service.
","href":"api/sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceName"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"namespace sap.ushell.services.PluginManager.PostMessagePluginInterface","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.CommunicationObject","basename":"CommunicationObject","resource":"sap/ushell/services/PluginManager/PostMessagePluginInterface.js","module":"sap/ushell/services/PluginManager/PostMessagePluginInterface","static":true,"visibility":"restricted","allowedFor":["sap.ui.rta"],"since":"1.140.0","description":"
Defines the communication object for post message APIs. It is a mapping of sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceName to sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceDefinition .
Example: {\n \"user.postapi.myService\": { // ServiceName\n inCalls: {\n \"myInterface\": { // ServiceInterface\n // InCallDefinition\n executeServiceCallFn: async function () {\n // Implementation of the service call\n }\n }\n },\n outCalls: {\n \"myInterface\": { // ServiceInterface\n // OutCallDefinition\n isActiveOnly: true,\n distributionType: [\"all\"] // obsolete, should not be set\n }\n }\n }\n}
"}],"references":["{@link sap.ushell.services.PluginManager.PostMessagePluginInterface.OutCallDefinition} ","{@link sap.ushell.services.PluginManager.PostMessagePluginInterface.InCallDefinition} "],"type":"Object","displayName":"sap.ushell.services.PluginManager.PostMessagePluginInterface.CommunicationObject","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.PluginManager.PostMessagePluginInterface.CommunicationObject","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.InCallDefinition","basename":"InCallDefinition","resource":"sap/ushell/services/PluginManager/PostMessagePluginInterface.js","module":"sap/ushell/services/PluginManager/PostMessagePluginInterface","static":true,"visibility":"restricted","allowedFor":["sap.ui.rta"],"since":"1.140.0","description":"
Defines the incoming call interface for post message usage in the sap.ushell.services.PluginManager.PostMessagePluginInterface.CommunicationObject . This is the interface that defines the handler in case applications are sending post messages to the plugin.
","properties":[{"name":"executeServiceCallFn","optional":true,"visibility":"restricted","allowedFor":["sap.ui.rta"],"description":"The function to execute the service call.
","typeInfo":{"template":"function() : Promise"}}],"displayName":"sap.ushell.services.PluginManager.PostMessagePluginInterface.InCallDefinition","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.PluginManager.PostMessagePluginInterface.InCallDefinition","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.OutCallDefinition","basename":"OutCallDefinition","resource":"sap/ushell/services/PluginManager/PostMessagePluginInterface.js","module":"sap/ushell/services/PluginManager/PostMessagePluginInterface","static":true,"visibility":"restricted","allowedFor":["sap.ui.rta"],"since":"1.140.0","description":"
Defines the outgoing call interface for post message usage in the sap.ushell.services.PluginManager.PostMessagePluginInterface.CommunicationObject . Needs to be defined otherwise those post messages might not be sent to applications.
","properties":[{"name":"isActiveOnly","optional":true,"visibility":"restricted","allowedFor":["sap.ui.rta"],"description":"If true, the post message is sent to the current application. Any other inactive applications are ignored then.
","typeInfo":{"template":"boolean"}},{"name":"distributionType","optional":true,"visibility":"restricted","allowedFor":["sap.ui.rta"],"description":"The distribution type of the post message. The value \"all\" is transformed to ignoreCapabilities=true. Any other value than \"all\" will cause errors.
","typeInfo":{"template":"Array"}}],"displayName":"sap.ushell.services.PluginManager.PostMessagePluginInterface.OutCallDefinition","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.PluginManager.PostMessagePluginInterface.OutCallDefinition","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceDefinition","basename":"ServiceDefinition","resource":"sap/ushell/services/PluginManager/PostMessagePluginInterface.js","module":"sap/ushell/services/PluginManager/PostMessagePluginInterface","static":true,"visibility":"restricted","allowedFor":["sap.ui.rta"],"since":"1.140.0","description":"
Defines the service definition for post message usage in the sap.ushell.services.PluginManager.PostMessagePluginInterface.CommunicationObject .
","properties":[{"name":"inCalls","optional":true,"visibility":"restricted","allowedFor":["sap.ui.rta"],"description":"Contains the interfaces for incoming calls.
","typeInfo":{"template":"Object<${0},${1}>","UI5Types":["sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceInterface","sap.ushell.services.PluginManager.PostMessagePluginInterface.InCallDefinition"]}},{"name":"outCalls","optional":true,"visibility":"restricted","allowedFor":["sap.ui.rta"],"description":"Contains the interfaces for outgoing calls.
","typeInfo":{"template":"Object<${0},${1}>","UI5Types":["sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceInterface","sap.ushell.services.PluginManager.PostMessagePluginInterface.OutCallDefinition"]}}],"displayName":"sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceDefinition","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceDefinition","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceInterface","basename":"ServiceInterface","resource":"sap/ushell/services/PluginManager/PostMessagePluginInterface.js","module":"sap/ushell/services/PluginManager/PostMessagePluginInterface","static":true,"visibility":"restricted","allowedFor":["sap.ui.rta"],"since":"1.140.0","description":"
The interface of the service. The interface is used to identify the specific functionality within the service.
","type":"string","displayName":"sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceInterface","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceInterface","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceName","basename":"ServiceName","resource":"sap/ushell/services/PluginManager/PostMessagePluginInterface.js","module":"sap/ushell/services/PluginManager/PostMessagePluginInterface","static":true,"visibility":"restricted","allowedFor":["sap.ui.rta"],"since":"1.140.0","description":"
The name of the service. All service names must start with 'user.postapi.'. Only SAP internal APIs are exempt from this rule.
","type":"string","displayName":"sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceName","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.PluginManager.PostMessagePluginInterface.ServiceName","subTitle":""},{"kind":"class","name":"sap.ushell.services.SearchableContent","basename":"SearchableContent","resource":"sap/ushell/services/SearchableContent.js","module":"sap/ushell/services/SearchableContent","export":"","static":true,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"since":"1.77.0","description":"The Unified Shell's SearchableContent service.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const SearchableContent = await Container.getServiceAsync(\"SearchableContent\");\n // do something with the SearchableContent service\n });\n ","hideconstructor":true,"methods":[{"name":"getApps","visibility":"restricted","allowedFor":["sap.esh.search.ui"],"since":"1.77.0","returnValue":{"type":"Promise","description":"A list of appData.
","typeInfo":{"template":"Promise>","UI5Types":["sap.ushell.services.SearchableContent.AppData"]}},"parameters":[{"name":"oParameters","optional":true,"description":"
the parameters for the search.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"includeAppsWithoutVisualizations","optional":true,"defaultValue":false,"description":"
if set to true, apps without visualizations are also included in the result (default is false); this option is only supported when spaces and pages are used
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"oParameters.includeAppsWithoutVisualizations"},{"name":"enableVisualizationPreview","optional":true,"defaultValue":true,"description":"
if set to true, will be put into preview mode. This might include a conversion of the tile type.
","depth":1,"typeInfo":{"template":"boolean"},"phoneName":"oParameters.enableVisualizationPreview"}],"description":"Collects and returns all apps
","href":"api/sap.ushell.services.SearchableContent#methods/getApps","code":"getApps(oParameters?) : Promise "}],"displayName":"sap.ushell.services.SearchableContent","nodes":[{"name":"sap.ushell.services.SearchableContent.AppData","description":"","href":"api/sap.ushell.services.SearchableContent.AppData"},{"name":"sap.ushell.services.SearchableContent.VizData","description":"","href":"api/sap.ushell.services.SearchableContent.VizData"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.SearchableContent","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.SearchableContent.AppData","basename":"AppData","resource":"sap/ushell/services/SearchableContent.js","module":"sap/ushell/services/SearchableContent","static":true,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"properties":[{"name":"id","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"","typeInfo":{"template":"string"}},{"name":"title","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"","typeInfo":{"template":"string"}},{"name":"subtitle","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"","typeInfo":{"template":"string"}},{"name":"icon","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"","typeInfo":{"template":"string"}},{"name":"info","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"","typeInfo":{"template":"string"}},{"name":"keywords","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"Search key words
","typeInfo":{"template":"Array"}},{"name":"technicalAttributes","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"Technical attributes in \"sap.app\" section of the app descriptor
","typeInfo":{"template":"Array"}},{"name":"target","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"Same format as in CDM RT schema in visualization/vizConfig/sap.flp/target.
","typeInfo":{"template":"object"}},{"name":"visualizations","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"List of tiles etc.
","typeInfo":{"template":"Array<${0}>","UI5Types":["sap.ushell.services.SearchableContent.VizData"]}},{"name":"targetURL","optional":true,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"the target URL for navigation
","typeInfo":{"template":"string"}}],"displayName":"sap.ushell.services.SearchableContent.AppData","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.SearchableContent.AppData","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.SearchableContent.VizData","basename":"VizData","resource":"sap/ushell/services/SearchableContent.js","module":"sap/ushell/services/SearchableContent","static":true,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"properties":[{"name":"id","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"","typeInfo":{"template":"string"}},{"name":"vizId","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"","typeInfo":{"template":"string"}},{"name":"vizType","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"","typeInfo":{"template":"string"}},{"name":"title","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"","typeInfo":{"template":"string"}},{"name":"subtitle","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"","typeInfo":{"template":"string"}},{"name":"icon","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"","typeInfo":{"template":"string"}},{"name":"info","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"","typeInfo":{"template":"string"}},{"name":"keywords","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"Search key words
","typeInfo":{"template":"Array"}},{"name":"target","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"Same format as in CDM RT schema in visualization/vizConfig/sap.flp/target.
","typeInfo":{"template":"object"}},{"name":"_instantiationData","optional":false,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"Platform-specific data for instantiation
","typeInfo":{"template":"object"}},{"name":"targetURL","optional":true,"visibility":"restricted","allowedFor":["sap.esh.search.ui"],"description":"the target URL for navigation
","typeInfo":{"template":"string"}}],"displayName":"sap.ushell.services.SearchableContent.VizData","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.SearchableContent.VizData","subTitle":""},{"kind":"class","name":"sap.ushell.services.Service","basename":"Service","resource":"sap/ushell/Container.js","module":"sap/ushell/Container","export":"Service","static":true,"visibility":"public","since":"1.121.0","description":"Abstract base interface for ushell services. For details, see sap.ushell.Container#getServiceAsync .Documentation links:
","constructor":{"visibility":"public","references":["sap.ushell.Container.getServiceAsync"],"codeExample":"new sap.ushell.services.Service() "},"displayName":"sap.ushell.services.Service","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.Service","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.ServiceTypes","basename":"ServiceTypes","resource":"sap/ushell/Container.js","module":"sap/ushell/Container","static":true,"visibility":"public","description":"
A helper type that maps service names to service types.
","properties":[{"name":"AppLifeCycle","optional":false,"visibility":"public","description":"","typeInfo":{"UI5Types":["sap.ushell.services.AppLifeCycle"]}},{"name":"Bookmark","optional":false,"visibility":"public","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.BookmarkV2} instead."},"description":"","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.BookmarkV2 instead.","typeInfo":{"UI5Types":["sap.ushell.services.Bookmark"]}},{"name":"BookmarkV2","optional":false,"visibility":"public","description":"","typeInfo":{"UI5Types":["sap.ushell.services.BookmarkV2"]}},{"name":"Configuration","optional":false,"visibility":"public","description":"","typeInfo":{"UI5Types":["sap.ushell.services.Configuration"]}},{"name":"ContentExtensionAdapterFactory","optional":false,"visibility":"public","deprecated":{"since":"1.120","text":"Deprecated without successor together with the classic homepage."},"description":"","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor together with the classic homepage.","typeInfo":{"UI5Types":["sap.ushell.services.ContentExtensionAdapterFactory"]}},{"name":"CrossApplicationNavigation","optional":false,"visibility":"public","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.Navigation} instead."},"description":"","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.Navigation instead.","typeInfo":{"UI5Types":["sap.ushell.services.CrossApplicationNavigation"]}},{"name":"EndUserFeedback","optional":false,"visibility":"public","deprecated":{"since":"1.93","text":"Deprecated without successor."},"description":"","deprecatedText":"Deprecated as of version 1.93. Deprecated without successor.","typeInfo":{"UI5Types":["sap.ushell.services.EndUserFeedback"]}},{"name":"Extension","optional":false,"visibility":"public","description":"","typeInfo":{"UI5Types":["sap.ushell.services.Extension"]}},{"name":"FrameBoundExtension","optional":false,"visibility":"public","description":"","typeInfo":{"UI5Types":["sap.ushell.services.FrameBoundExtension"]}},{"name":"LaunchPage","optional":false,"visibility":"public","deprecated":{"since":"1.99","text":"Deprecated together with the classic homepage."},"description":"","deprecatedText":"Deprecated as of version 1.99. Deprecated together with the classic homepage.","typeInfo":{"UI5Types":["sap.ushell.services.LaunchPage"]}},{"name":"Message","optional":false,"visibility":"public","deprecated":{"since":"1.120","text":"Please use {@link sap.m.MessageToast}, {@link sap.m.MessageBox}, or {@link sap.m.Dialog} instead."},"description":"","deprecatedText":"Deprecated as of version 1.120. Please use sap.m.MessageToast , sap.m.MessageBox , or sap.m.Dialog instead.","typeInfo":{"UI5Types":["sap.ushell.services.Message"]}},{"name":"NavTargetResolution","optional":false,"visibility":"public","deprecated":{"since":"1.120","text":"Use {@link sap.ushell.services.Navigation} for Navigation instead."},"description":"","deprecatedText":"Deprecated as of version 1.120. Use sap.ushell.services.Navigation for Navigation instead.","typeInfo":{"UI5Types":["sap.ushell.services.NavTargetResolution"]}},{"name":"Navigation","optional":false,"visibility":"public","description":"","typeInfo":{"UI5Types":["sap.ushell.services.Navigation"]}},{"name":"Notifications","optional":false,"visibility":"public","deprecated":{"since":"1.119","text":"Please use {@link sap.ushell.services.NotificationsV2} instead."},"description":"","deprecatedText":"Deprecated as of version 1.119. Please use sap.ushell.services.NotificationsV2 instead.","typeInfo":{"UI5Types":["sap.ushell.services.Notifications"]}},{"name":"NotificationsV2","optional":false,"visibility":"public","description":"","typeInfo":{"UI5Types":["sap.ushell.services.NotificationsV2"]}},{"name":"Personalization","optional":false,"visibility":"public","deprecated":{"since":"1.120","text":"Please use {@link sap.ushell.services.PersonalizationV2} instead."},"description":"","deprecatedText":"Deprecated as of version 1.120. Please use sap.ushell.services.PersonalizationV2 instead.","typeInfo":{"UI5Types":["sap.ushell.services.Personalization"]}},{"name":"PersonalizationV2","optional":false,"visibility":"public","description":"","typeInfo":{"UI5Types":["sap.ushell.services.PersonalizationV2"]}},{"name":"SessionHandler","optional":false,"visibility":"public","description":"","typeInfo":{"UI5Types":["sap.ushell.services.SessionHandler"]}},{"name":"ShellNavigation","optional":false,"visibility":"public","deprecated":{"since":"1.120","text":"Use {@link sap.ushell.services.Navigation} for Navigation instead."},"description":"","deprecatedText":"Deprecated as of version 1.120. Use sap.ushell.services.Navigation for Navigation instead.","typeInfo":{"UI5Types":["sap.ushell.services.ShellNavigation"]}},{"name":"SmartNavigation","optional":false,"visibility":"public","deprecated":{"since":"1.112","text":"Please use the CrossApplicationNavigation service instead."},"description":"","deprecatedText":"Deprecated as of version 1.112. Please use the CrossApplicationNavigation service instead.","typeInfo":{"UI5Types":["sap.ushell.services.SmartNavigation"]}},{"name":"SupportTicket","optional":false,"visibility":"public","description":"","typeInfo":{"UI5Types":["sap.ushell.services.SupportTicket"]}},{"name":"URLParsing","optional":false,"visibility":"public","description":"","typeInfo":{"UI5Types":["sap.ushell.services.URLParsing"]}},{"name":"UsageAnalytics","optional":false,"visibility":"public","deprecated":{"since":"1.120","text":"The corresponding cloud service \"SAP Web Analytics\" has been retired, therefore this client-side service API cannot be used any longer."},"description":"","deprecatedText":"Deprecated as of version 1.120. The corresponding cloud service \"SAP Web Analytics\" has been retired, therefore this client-side service API cannot be used any longer.","typeInfo":{"UI5Types":["sap.ushell.services.UsageAnalytics"]}},{"name":"UserInfo","optional":false,"visibility":"public","description":"","typeInfo":{"UI5Types":["sap.ushell.services.UserInfo"]}}],"displayName":"sap.ushell.services.ServiceTypes","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.ServiceTypes","subTitle":""},{"kind":"class","name":"sap.ushell.services.SessionHandler","basename":"SessionHandler","resource":"sap/ushell/services/SessionHandler.js","module":"sap/ushell/services/SessionHandler","export":"","static":true,"visibility":"public","since":"1.151.0","extends":"sap.ushell.services.Service","description":"The Unified Shell's session handler service. Manages the timeout of an FLP session:
Announces user activity to the platform (via the UShell container service). Maintains user activity data in local storage to support multi-browser-tab use cases. Notifies the user once the session is about to end, offering the option to extend the session. Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const SessionHandler = await Container.getServiceAsync(\"SessionHandler\");\n // do something with the SessionHandler service\n });\n This service should be available in any FLP context (native, iframe, ...).
","hideconstructor":true,"methods":[{"name":"notifyUserActivity","visibility":"public","since":"1.151.0","description":"Notifies the FLP that the user is currently active, so the FLP treats the session as active and defers idle warnings / automatic sign-out.
Intended for apps whose user activity the FLP cannot observe directly (e.g. content embedded in an iframe). The app decides when the user is active and calls this to signal it.
","examples":[{"data":"Example: sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const SessionHandler = await Container.getServiceAsync(\"SessionHandler\");\n // call whenever the embedded app observes user activity\n SessionHandler.notifyUserActivity();\n });
"}],"href":"api/sap.ushell.services.SessionHandler#methods/notifyUserActivity","code":"notifyUserActivity() : void "}],"displayName":"sap.ushell.services.SessionHandler","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.SessionHandler","subTitle":""},{"kind":"class","name":"sap.ushell.services.ShellNavigation","basename":"ShellNavigation","resource":"sap/ushell/services/ShellNavigation.js","module":"sap/ushell/services/ShellNavigation","export":"","static":true,"visibility":"public","since":"1.15.0","description":"The Unified Shell's internal navigation service (platform independent).
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const ShellNavigation = await Container.getServiceAsync(\"ShellNavigation\");\n // do something with the ShellNavigation service\n });\n This interface is for consumption by shell renderers/containers only
It is not for direct usage by applications, see inner app navigation : UI5 interfaces (hashChanger, Router) cross app navigation : @see sap.ushell.services.CrossApplicationNavigation
Usage:
Example: see renders/fiorisandbox/Shell.controller.js
\n sap.ui.define([\n \"sap/ushell/services/ShellNavigation\"\n ], function (ShellNavigation) {\n Shell.onHashChange(shellHash,appHash) { / *resolve url, load app and exchange root view* / }\n Shell.init() {\n this.privShellNavigator = new ShellNavigation();\n this.privShellNavigator.init(this.doHashChange.bind(this));\n }\n });\n Note: further app specific integration via the reference app reuse code (setting of app specific handler)
Note: the ShellNavigation service replaces the UI5 core HashChanger which abstracts from the browser url modification.
It performs the following services: - encoding of the actual browser url hash ( via hasher.js). - expansion of \"shortened\" urls ( AppParameterParts) via invocation. - splitting of shellHash and AppSpecific hash and abstraction w.r.t. Eventing
Thus it is crucial to use appropriate interfaces and not directly invoke window.location.hash.
- internal construction methods for a \"current\" App specific and non-app specific hash (invoked by CrossApplicationNavigation), not to be invoked directly!
","hideconstructor":true,"properties":[{"name":"NavigationFilterStatus","visibility":"restricted","allowedFor":["sap.ui.fl"],"description":"The navigation filter statuses that should be returned by a navigation filter
Continue - continue with the navigation flow Abandon - stop the navigation flow, and revert to the previous hash state Custom - stop the navigation flow, but leave the hash state as is. The filter should use this status to provide alternative navigation handling
","references":["sap.ushell.services.ShellNavigation#registerNavigationFilter"],"typeInfo":{"template":"undefined"}}],"methods":[{"name":"compactParams","visibility":"protected","returnValue":{"type":"jQuery.Promise","description":"a promise, whose first argument of resolve is
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oParams","optional":false,"description":"
A parameter object
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"aRetainedParameters","optional":true,"description":"
An array of string value of parameters which shall not be compacted The array may contains a *-terminated string, which will match and strings with the same prefix ( e.g. \"sap-*\" will match \"sap-ushell\", \"sap-wd\", \"sap-\" etc. )
","typeInfo":{"template":"Array"},"defaultValue":""},{"name":"oComponent","optional":true,"description":"
optional, a SAP UI5 Component
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"bTransient","optional":true,"description":"
whether an transient appstate is sufficient
","typeInfo":{"template":"boolean"},"defaultValue":""}],"description":"compact the parameter object, if required a number of parameters will be removed, instead a corresponding \"sap-intent-param\" containing a key of an appstate representing the removed parameters will be inserted
","href":"api/sap.ushell.services.ShellNavigation#methods/compactParams","code":"compactParams(oParams, aRetainedParameters?, oComponent?, bTransient?) : jQuery.Promise "},{"name":"getNavigationContext","visibility":"protected","returnValue":{"type":"object","description":"An object like:
\n {\n \"isCrossAppNavigation\": true,\n \"innerAppRoute\": \"employee/overview\"\n }\n This object can be used inside dirty flag providers to take corresponding actions.
","typeInfo":{"template":"object"}},"description":"Returns the current navigation context.
","href":"api/sap.ushell.services.ShellNavigation#methods/getNavigationContext","code":"getNavigationContext() : object "},{"name":"init","visibility":"public","returnValue":{"type":"this","description":"Reference to this for method chaining.
","typeInfo":{"template":"this"}},"parameters":[{"name":"fnShellCallback","optional":false,"description":"
The callback method for hash changes
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Initializes ShellNavigation
This function should be used by a custom renderer in order to implement custom navigation. Do not use this function for developing Fiori applications.
This method should be invoked by the Shell in order to: - Register the event listener - Register the container callback for the (currently single) ShellHash changes.
Signature of the callback function sShellHashPart, // The hash part on the URL that is resolved and used for application loading sAppSpecificPart // Typically ignored sOldShellHashPart, // The old shell hash part, if exist sOldAppSpecificPart, // The old app hash part, if exist
","deprecated":{"since":"1.120","text":"Deprecated without successor. Custom renderer initialization is no longer supported."},"href":"api/sap.ushell.services.ShellNavigation#methods/init","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor. Custom renderer initialization is no longer supported.","code":"init(fnShellCallback) : this "},{"name":"registerNavigationFilter","visibility":"restricted","allowedFor":["sap.ui.fl"],"parameters":[{"name":"fnFilter","optional":false,"description":"
navigation filter function
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Register the navigation filter callback function. A navigation filter provides plugins with the ability to intervene in the navigation flow, and optionally to stop the navigation.
The callback has to return sap.ushell.services.ShellNavigationInternal.NavigationFilterStatus
Use Function.prototype.bind() to determine the callback's this or some of its arguments.
","references":["{@link sap.ushell.services.ShellNavigation#registerNavigationFilter} "],"href":"api/sap.ushell.services.ShellNavigation#methods/registerNavigationFilter","code":"registerNavigationFilter(fnFilter) : void "},{"name":"replaceHashWithoutNavigation","visibility":"protected","parameters":[{"name":"sNewHash","optional":false,"description":"
new hash fragment
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Rewrite the hash fragment identifier without triggering any navigation at
","href":"api/sap.ushell.services.ShellNavigation#methods/replaceHashWithoutNavigation","code":"replaceHashWithoutNavigation(sNewHash) : void "},{"name":"resetHistoryEntryReplaced","visibility":"protected","description":"Resets the internal flag used to track whether the last navigation is made via hasher#setHash or hasher#replaceHash. This method should be called after a navigation is successfully made to a target application to avoid returning an inconsistent answer when calling #wasHistoryEntryReplaced. An inconsistent answer might occur when a navigation is made via forward/back button without passing via hasher#replaceHash or hasher#setHash.
This method should not be used externally. It's reserved uniquely for internal shell consumption and its signature or result might change at any time.
","href":"api/sap.ushell.services.ShellNavigation#methods/resetHistoryEntryReplaced","code":"resetHistoryEntryReplaced() : void "},{"name":"unregisterNavigationFilter","visibility":"restricted","allowedFor":["sap.ui.fl"],"parameters":[{"name":"fnFilter","optional":false,"description":"
navigation filter function
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Unregister a previously registered navigation filter
The callback has to return sap.ushell.services.ShellNavigationInternal.NavigationFilterStatus
Note the same filter function that was registered should be passed as a parameter to this method.
","references":["{@link sap.ushell.services.ShellNavigation#registerNavigationFilter} "],"href":"api/sap.ushell.services.ShellNavigation#methods/unregisterNavigationFilter","code":"unregisterNavigationFilter(fnFilter) : void "},{"name":"wasHistoryEntryReplaced","visibility":"protected","returnValue":{"type":"boolean","description":"Whether hasher#replaceHash was called after the last navigation.
","typeInfo":{"template":"boolean"}},"description":"Returns true if the history entry was replaced immediately after the last navigation. To be useful, this method should be called immediately after the hash enters the URL but before the target application is finally navigated to.
This method should not be used externally. It's reserved uniquely for internal shell consumption and its signature or result might change at any time.
","href":"api/sap.ushell.services.ShellNavigation#methods/wasHistoryEntryReplaced","code":"wasHistoryEntryReplaced() : boolean "}],"displayName":"sap.ushell.services.ShellNavigation","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.ShellNavigation","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. Use sap.ushell.services.Navigation for Navigation instead."},{"kind":"class","name":"sap.ushell.services.ShellNavigationInternal","basename":"ShellNavigationInternal","resource":"sap/ushell/services/ShellNavigationInternal.js","module":"sap/ushell/services/ShellNavigationInternal","export":"","static":true,"visibility":"restricted","allowedFor":["sap.ui.fl"],"since":"1.121.0","description":"The Unified Shell's internal navigation service (platform independent).
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const ShellNavigationInternal = await Container.getServiceAsync(\"ShellNavigationInternal\");\n // do something with the ShellNavigationInternal service\n });\n This interface is for consumption by shell renderers/containers only
It is not for direct usage by applications, see inner app navigation : UI5 interfaces (hashChanger, Router) cross app navigation : @see sap.ushell.services.CrossApplicationNavigation
Usage:
Example: see renders/fiorisandbox/Shell.controller.js
\n sap.ui.define([\n \"sap/ushell/services/ShellNavigationInternal\"\n ], function (ShellNavigationInternal) {\n Shell.onHashChange(shellHash,appHash) { / *resolve url, load app and exchange root view* / }\n Shell.init() {\n this.privShellNavigator = new ShellNavigationInternal();\n this.privShellNavigator.init(this.doHashChange.bind(this));\n }\n });\n Note: further app specific integration via the reference app reuse code (setting of app specific handler)
Note: the ShellNavigationInternal service replaces the UI5 core HashChanger which abstracts from the browser url modification.
It performs the following services: - encoding of the actual browser url hash ( via hasher.js). - expansion of \"shortened\" urls ( AppParameterParts) via invocation. - splitting of shellHash and AppSpecific hash and abstraction w.r.t. Eventing
Thus it is crucial to use appropriate interfaces and not directly invoke window.location.hash.
- internal construction methods for a \"current\" App specific and non-app specific hash (invoked by CrossApplicationNavigation), not to be invoked directly!
","hideconstructor":true,"properties":[{"name":"NavigationFilterStatus","visibility":"restricted","allowedFor":["sap.ui.fl"],"description":"The navigation filter statuses that should be returned by a navigation filter
Continue - continue with the navigation flow Abandon - stop the navigation flow, and revert to the previous hash state Custom - stop the navigation flow, but leave the hash state as is. The filter should use this status to provide alternative navigation handling
","references":["sap.ushell.services.ShellNavigationInternal#registerNavigationFilter"],"typeInfo":{"template":"undefined"}}],"methods":[{"name":"registerNavigationFilter","visibility":"restricted","allowedFor":["sap.ui.fl"],"parameters":[{"name":"fnFilter","optional":false,"description":"
navigation filter function
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Register the navigation filter callback function. A navigation filter provides plugins with the ability to intervene in the navigation flow, and optionally to stop the navigation.
The callback has to return sap.ushell.services.ShellNavigationInternal.NavigationFilterStatus
Use Function.prototype.bind() to determine the callback's this or some of its arguments.
","references":["{@link sap.ushell.services.ShellNavigationInternal#registerNavigationFilter} "],"href":"api/sap.ushell.services.ShellNavigationInternal#methods/registerNavigationFilter","code":"registerNavigationFilter(fnFilter) : void "},{"name":"unregisterNavigationFilter","visibility":"restricted","allowedFor":["sap.ui.fl"],"parameters":[{"name":"fnFilter","optional":false,"description":"
navigation filter function
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Unregister a previously registered navigation filter
The callback has to return sap.ushell.services.ShellNavigationInternal.NavigationFilterStatus
Note the same filter function that was registered should be passed as a parameter to this method.
","references":["{@link sap.ushell.services.ShellNavigationInternal#registerNavigationFilter} "],"href":"api/sap.ushell.services.ShellNavigationInternal#methods/unregisterNavigationFilter","code":"unregisterNavigationFilter(fnFilter) : void "}],"displayName":"sap.ushell.services.ShellNavigationInternal","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.ShellNavigationInternal","subTitle":""},{"kind":"class","name":"sap.ushell.services.SmartNavigation","basename":"SmartNavigation","resource":"sap/ushell/services/SmartNavigation.js","module":"sap/ushell/services/SmartNavigation","export":"","static":true,"visibility":"public","since":"1.44.0","extends":"sap.ushell.services.Service","description":"Constructs an instance of SmartNavigation.
The constructed service provides an enhancement on CrossApplicationNavigation#getLinks and CrossApplicationNavigation#toExternal . In order for an application to leverage this enhancement, it is pertinent that the application uses SmartNavigation#toExternal for navigation. Hence the caller can subsequently use SmartNavigation#getLinks with the outcome that it sorts the resulting list in the order of frequency of attempted navigation from the application to respective links.
Attempted in the previous paragraph is emphasized due to the fact that a click on the link will cause an increment of the frequency count, regardless of whether or not the navigation was successful.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const SmartNavigation = await Container.getServiceAsync(\"SmartNavigation\");\n // do something with the SmartNavigation service\n });\n ","hideconstructor":true,"methods":[{"name":"getLinks","visibility":"public","since":"1.44.0","returnValue":{"type":"jQuery.Promise","description":"Resolves with an array of link objects sorted according to their relevance to the calling application.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oArgs","optional":true,"description":"
An object containing nominal arguments for the method.
","typeInfo":{"template":"object | Array>"},"defaultValue":""}],"description":"Resolves the given semantic object (or action) and business parameters to a list of links available to the user, sorted according their relevance to the calling application.
The relevance of link is defined by the frequency with which a navigation activity from the calling application to that link occurs.
Internally, this method delegates to sap.ushell.services.CrossApplicationNavigation#getLinks and then sorts the resulting list accordingly.
","deprecated":{"since":"1.112","text":"Please use {@link sap.ushell.services.Navigation#getLinks} instead."},"references":["{@link sap.ushell.services.CrossApplicationNavigation#getLinks} "],"href":"api/sap.ushell.services.SmartNavigation#methods/getLinks","deprecatedText":"Deprecated as of version 1.112. Please use sap.ushell.services.Navigation#getLinks instead.","code":"getLinks(oArgs?) : jQuery.Promise "},{"name":"getPrimaryIntent","visibility":"public","since":"1.48.0","returnValue":{"type":"jQuery.Promise","description":"Resolves to an object when a relevant link object exists.
","typeInfo":{"template":"jQuery.Promise"}},"description":"Completely delegates to sap.ushell.services.CrossApplicationNavigation#getPrimaryIntent , and either may be used in place of the other with exactly the same outcome.
","deprecated":{"since":"1.112","text":"Please use {@link sap.ushell.services.Navigation#getPrimaryIntent} instead."},"references":["{@link sap.ushell.services.CrossApplicationNavigation#getPrimaryIntent} "],"href":"api/sap.ushell.services.SmartNavigation#methods/getPrimaryIntent","deprecatedText":"Deprecated as of version 1.112. Please use sap.ushell.services.Navigation#getPrimaryIntent instead.","code":"getPrimaryIntent() : jQuery.Promise "},{"name":"hrefForExternal","visibility":"public","since":"1.46.0","returnValue":{"type":"string","description":"A href for the specified parameters as an *external* shell hash.
","typeInfo":{"template":"string"}},"description":"Completely delegates to sap.ushell.services.CrossApplicationNavigation#hrefForExternal , and may be used in place of the other with exactly the same outcome.
","deprecated":{"since":"1.94","text":"Please use {@link #hrefForExternalAsync} instead."},"references":["{@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal} "],"href":"api/sap.ushell.services.SmartNavigation#methods/hrefForExternal","deprecatedText":"Deprecated as of version 1.94. Please use #hrefForExternalAsync instead.","code":"hrefForExternal() : string "},{"name":"hrefForExternalAsync","visibility":"public","since":"1.94.0","returnValue":{"type":"Promise","description":"A promise that is resolved to a string that can be put into an href attribute of an HTML anchor. The returned string will always start with a hash character.
","typeInfo":{"template":"Promise"}},"description":"Completely delegates to sap.ushell.services.CrossApplicationNavigation#hrefForExternalAsync , and may be used in place of the other with exactly the same outcome.
","deprecated":{"since":"1.112","text":"Please use {@link sap.ushell.services.Navigation#getHref} instead."},"references":["{@link sap.ushell.services.CrossApplicationNavigation#hrefForExternalAsync} "],"href":"api/sap.ushell.services.SmartNavigation#methods/hrefForExternalAsync","deprecatedText":"Deprecated as of version 1.112. Please use sap.ushell.services.Navigation#getHref instead.","code":"hrefForExternalAsync() : Promise "},{"name":"toExternal","visibility":"public","since":"1.44.0","parameters":[{"name":"oArgs","optional":true,"description":"
An object containing nominal arguments for the method.
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Usage of this method in place of sap.ushell.services.CrossApplicationNavigation#toExternal drives the smartness of the results returned by sap.ushell.services.SmartNavigation#getLinks .
","deprecated":{"since":"1.112","text":"Please use {@link sap.ushell.services.Navigation#navigate} instead."},"references":["{@link sap.ushell.services.CrossApplicationNavigation#toExternal} "],"href":"api/sap.ushell.services.SmartNavigation#methods/toExternal","deprecatedText":"Deprecated as of version 1.112. Please use sap.ushell.services.Navigation#navigate instead.","code":"toExternal(oArgs?) : void "},{"name":"trackNavigation","visibility":"public","since":"1.46.0","returnValue":{"type":"jQuery.Promise","description":"Resolves once the navigation was tracked.
","typeInfo":{"template":"jQuery.Promise"}},"parameters":[{"name":"oArgs","optional":false,"description":"
The navigation target as object, for example: { target: { shellHash: 'SaleOrder-display' } } or
\n {\n target: {\n semanticObject: 'SalesOrder',\n action: 'action'\n }\n }\n ","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Tracks a navigation to a valid intent if provided via arguments but does not perform the navigation itself. If no valid intent was provided tracking will be prevented. The intent has to consist of SemanticObject and Action. It may be passed as complete shellHash (presidence) or as individual parts Additional parameters will not be part of the tracking and ignored This Method can be used to track a click if the actual navigation was triggered via clicking a link on the UI.
","deprecated":{"since":"1.112","text":"Deprecated without successor. The SmartNavigation tracking functionality has been discontinued."},"href":"api/sap.ushell.services.SmartNavigation#methods/trackNavigation","deprecatedText":"Deprecated as of version 1.112. Deprecated without successor. The SmartNavigation tracking functionality has been discontinued.","code":"trackNavigation(oArgs) : jQuery.Promise "}],"displayName":"sap.ushell.services.SmartNavigation","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.SmartNavigation","subTitle":"Deprecated in version: 1.112","deprecatedText":"Deprecated as of version 1.112. Please use the CrossApplicationNavigation service instead."},{"kind":"class","name":"sap.ushell.services.SpaceContent","basename":"SpaceContent","resource":"sap/ushell/services/SpaceContent.js","module":"sap/ushell/services/SpaceContent","export":"","static":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.103.0","description":"This service provides APIs for the S/4 MyHome. For FLP internal usage, the internal APIs should be used directly.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const SpaceContent = await Container.getServiceAsync(\"SpaceContent\");\n // do something with the SpaceContent service\n });\n ","hideconstructor":true,"methods":[{"name":"addSection","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.103.0","returnValue":{"type":"Promise","description":"Promise which resolves after the personalization was saved
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"pageId","optional":false,"description":"
The ID of the page to which the section is added
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sectionIndex","optional":false,"description":"
The index of the added section on the page
","typeInfo":{"template":"int"},"defaultValue":""},{"name":"sectionProperties","optional":true,"description":"
Properties of the added section
","typeInfo":{"UI5Types":["sap.ushell.services.Pages.Section"],"refersToTypedef":true},"defaultValue":""}],"description":"Adds a section to a page
","href":"api/sap.ushell.services.SpaceContent#methods/addSection","code":"addSection(pageId, sectionIndex, sectionProperties?) : Promise "},{"name":"addVisualization","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.103.0","returnValue":{"type":"Promise","description":"Promise which resolves after the personalization was saved
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"pageId","optional":false,"description":"
The ID of the page the visualization should be added to
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sectionId","optional":true,"description":"
The ID of the section the visualization should be added to
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"vizId","optional":false,"description":"
The ID of the visualization to add
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Adds a new visualization to a page
If no section ID is specified, the visualization is added to the 'Recently Added' section automatically.
","href":"api/sap.ushell.services.SpaceContent#methods/addVisualization","code":"addVisualization(pageId, sectionId?, vizId) : Promise "},{"name":"deleteSection","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.146.0","returnValue":{"type":"Promise","description":"Promise which resolves after the personalization was saved
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"pageId","optional":false,"description":"
The ID of the page from which the section is deleted
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sectionId","optional":false,"description":"
The ID of the deleted section
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Deletes a section from a page
","href":"api/sap.ushell.services.SpaceContent#methods/deleteSection","code":"deleteSection(pageId, sectionId) : Promise "},{"name":"deleteVisualization","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.103.0","returnValue":{"type":"Promise","description":"Promise which resolves after the personalization was saved.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"pageId","optional":false,"description":"
The ID of the page containing the deleted visualization
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sectionIndex","optional":false,"description":"
The index of the section from where the visualization is deleted
","typeInfo":{"template":"int"},"defaultValue":""},{"name":"visualizationIndex","optional":false,"description":"
The index of the deleted visualization
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Deletes a visualization from a page
","href":"api/sap.ushell.services.SpaceContent#methods/deleteVisualization","code":"deleteVisualization(pageId, sectionIndex, visualizationIndex) : Promise "},{"name":"generateId","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.146.0","returnValue":{"type":"Promise","description":"The generated unique ID
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"pageId","optional":false,"description":"
The ID of the page for which the section ID is generated
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Generates a unique ID for sections of the homepage
","href":"api/sap.ushell.services.SpaceContent#methods/generateId","code":"generateId(pageId) : Promise "},{"name":"getPage","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.103.0","returnValue":{"type":"Promise","description":"Promise that resolves with the page data
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.Pages.PageData"]}},"parameters":[{"name":"pageId","optional":false,"description":"
ID of the page
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Returns the data of a page
","href":"api/sap.ushell.services.SpaceContent#methods/getPage","code":"getPage(pageId) : Promise "},{"name":"getPages","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.103.0","returnValue":{"type":"Promise","description":"Promise that resolves with the page data
","typeInfo":{"template":"Promise>","UI5Types":["sap.ushell.services.Pages.PageData"]}},"parameters":[{"name":"pageIds","optional":false,"description":"
IDs of the pages
","typeInfo":{"template":"Array"},"defaultValue":""}],"description":"Returns the data of multiple pages
","href":"api/sap.ushell.services.SpaceContent#methods/getPages","code":"getPages(pageIds) : Promise "},{"name":"getUserDefaultParameter","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.103.0","returnValue":{"type":"Promise<(null|sap.ushell.services.SpaceContent.ParameterValue)>","description":"A Promise that resolves to an object containing the parameter values. Returns single parameters in property value and range parameters in property extendedValue. Returns null if the parameter has no value.
","typeInfo":{"template":"Promise","UI5Types":["sap.ushell.services.SpaceContent.ParameterValue"]}},"parameters":[{"name":"parameterName","optional":false,"description":"
The parameter name
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Attempt to determine a value for the parameter name.
","href":"api/sap.ushell.services.SpaceContent#methods/getUserDefaultParameter","code":"getUserDefaultParameter(parameterName) : Promise<(null|sap.ushell.services.SpaceContent.ParameterValue)> "},{"name":"instantiateVisualization","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.103.0","returnValue":{"type":"Promise","description":"A VizInstance control
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.ui.launchpad.VizInstanceBase"]}},"parameters":[{"name":"vizData","optional":false,"description":"
Data for a visualization
","typeInfo":{"UI5Types":["sap.ushell.services.Pages.Visualization"],"refersToTypedef":true},"defaultValue":""}],"description":"Creates VizInstance controls from the visualization data returned by getPage and getPages.
","href":"api/sap.ushell.services.SpaceContent#methods/instantiateVisualization","code":"instantiateVisualization(vizData) : Promise "},{"name":"isPersonalizationEnabled","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.106.0","returnValue":{"type":"boolean","description":"Whether personalization enabled
","typeInfo":{"template":"boolean"}},"description":"Returns the personalization enabled flag
","href":"api/sap.ushell.services.SpaceContent#methods/isPersonalizationEnabled","code":"isPersonalizationEnabled() : boolean "},{"name":"launchTileTarget","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.103.0","parameters":[{"name":"url","optional":false,"description":"
URL of the app
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"title","optional":true,"description":"
Title of the app. This is only used for non-intent based navigation in order to add an entry to the recently used apps. If no title is provided for such a target no recently used entry is added.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Starts an app based on the provided URL. If an intent is provided an intent based navigation is triggered. If a fully qualified URL is provided the app is opened in a new tab. This API must only be used to start tile targets.
","href":"api/sap.ushell.services.SpaceContent#methods/launchTileTarget","code":"launchTileTarget(url, title?) : void "},{"name":"moveSection","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.146.0","returnValue":{"type":"Promise","description":"Promise which resolves after the personalization was saved
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"pageId","optional":false,"description":"
The ID of the page containing the moved section
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sourceSectionIndex","optional":false,"description":"
The index of the moved section
","typeInfo":{"template":"int"},"defaultValue":""},{"name":"targetSectionIndex","optional":false,"description":"
The new index of the moved section
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Moves a section on a page
","href":"api/sap.ushell.services.SpaceContent#methods/moveSection","code":"moveSection(pageId, sourceSectionIndex, targetSectionIndex) : Promise "},{"name":"moveVisualization","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.103.0","returnValue":{"type":"Promise<{visualizationIndex:int}>","description":"Promise which resolves with an object containing the visualizationIndex after the personalization was saved.
","typeInfo":{"template":"Promise<{visualizationIndex:int}>"}},"parameters":[{"name":"pageId","optional":false,"description":"
The ID of the page containing the moved visualization
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sourceSectionIndex","optional":false,"description":"
The index of the section from where the visualization is moved
","typeInfo":{"template":"int"},"defaultValue":""},{"name":"sourceVisualizationIndex","optional":false,"description":"
The index of the moved visualization
","typeInfo":{"template":"int"},"defaultValue":""},{"name":"targetSectionIndex","optional":false,"description":"
The index of the section to which the visualization should be moved
","typeInfo":{"template":"int"},"defaultValue":""},{"name":"targetVisualizationIndex","optional":false,"description":"
The new index of the moved visualization. If -1 is passed, the visualization is moved to the last position.
","typeInfo":{"template":"int"},"defaultValue":""}],"description":"Moves a visualization on a page
","href":"api/sap.ushell.services.SpaceContent#methods/moveVisualization","code":"moveVisualization(pageId, sourceSectionIndex, sourceVisualizationIndex, targetSectionIndex, targetVisualizationIndex) : Promise<{visualizationIndex:int}> "},{"name":"renameSection","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.146.0","returnValue":{"type":"Promise","description":"Promise which resolves after the personalization was saved
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"pageId","optional":false,"description":"
The ID of the page containing the renamed section
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sectionId","optional":false,"description":"
The ID of the renamed section
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"newTitle","optional":false,"description":"
The new title of the section
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Renames a section on a page
","href":"api/sap.ushell.services.SpaceContent#methods/renameSection","code":"renameSection(pageId, sectionId, newTitle) : Promise "},{"name":"updateVisualization","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1"],"since":"1.105","returnValue":{"type":"Promise","description":"The promise resolves when the visualization has been updated successfully
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"pageId","optional":false,"description":"
The ID of the page containing the updated visualization
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"sectionIndex","optional":false,"description":"
The index of the section from where the visualization is updated
","typeInfo":{"template":"int"},"defaultValue":""},{"name":"visualizationIndex","optional":false,"description":"
The index of the updated visualization
","typeInfo":{"template":"int"},"defaultValue":""},{"name":"visualizationData","optional":false,"description":"
The updated visualization properties
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"displayFormatHint","optional":true,"description":"
The format in which the visualization is displayed
","depth":1,"typeInfo":{"template":"string"},"phoneName":"visualizationData.displayFormatHint","defaultValue":""},{"name":"title","optional":true,"description":"
The title of the visualization
","depth":1,"typeInfo":{"template":"string"},"phoneName":"visualizationData.title","defaultValue":""},{"name":"subtitle","optional":true,"description":"
The subtitle of the visualization
","depth":1,"typeInfo":{"template":"string"},"phoneName":"visualizationData.subtitle","defaultValue":""},{"name":"info","optional":true,"description":"
The information text of the visualization
","depth":1,"typeInfo":{"template":"string"},"phoneName":"visualizationData.info","defaultValue":""}],"description":"Updates the properties of a visualization. Properties that are not supplied are not updated. Currently only the display format, title and subtitle are supported.
","href":"api/sap.ushell.services.SpaceContent#methods/updateVisualization","code":"updateVisualization(pageId, sectionIndex, visualizationIndex, visualizationData) : Promise "}],"displayName":"sap.ushell.services.SpaceContent","nodes":[{"name":"sap.ushell.services.SpaceContent.ParameterValue","description":"Type for the value of a UserDefault parameter.
","href":"api/sap.ushell.services.SpaceContent.ParameterValue"},{"name":"sap.ushell.services.SpaceContent.Range","description":"Type for describing a parameter value range.
","href":"api/sap.ushell.services.SpaceContent.Range"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.SpaceContent","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.SpaceContent.ParameterValue","basename":"ParameterValue","resource":"sap/ushell/services/SpaceContent.js","module":"sap/ushell/services/SpaceContent","static":true,"visibility":"public","since":"1.120.0","description":"
Type for the value of a UserDefault parameter. It contains either a value, an extendedValue, or both.
Example:
\n {\n \"value\": \"ZMAT1\",\n \"extendedValue\": {\n \"Ranges\": [\n {\n \"Sign\": \"I\",\n \"Option\": \"BT\",\n \"Low\": \"A*\",\n \"High\": \"F*\"\n }\n ]\n }\n }\n ","properties":[{"name":"value","optional":true,"visibility":"public","description":"The value of a single-parameter.
","typeInfo":{"template":"string"}},{"name":"extendedValue","optional":true,"visibility":"public","description":"Object containing the ranges for a range-parameter.
","typeInfo":{"template":"{Ranges:Array<${0}>}","UI5Types":["sap.ushell.services.SpaceContent.Range"]}}],"displayName":"sap.ushell.services.SpaceContent.ParameterValue","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.SpaceContent.ParameterValue","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.SpaceContent.Range","basename":"Range","resource":"sap/ushell/services/SpaceContent.js","module":"sap/ushell/services/SpaceContent","static":true,"visibility":"public","since":"1.120.0","description":"
Type for describing a parameter value range.
","properties":[{"name":"Sign","optional":false,"visibility":"public","description":"The sign value of the range.
","typeInfo":{"template":"string"}},{"name":"Option","optional":false,"visibility":"public","description":"The option value of the range.
","typeInfo":{"template":"string"}},{"name":"Low","optional":false,"visibility":"public","description":"The low value of the range.
","typeInfo":{"template":"string"}},{"name":"High","optional":false,"visibility":"public","description":"The high value of the range.
","typeInfo":{"template":"string"}}],"displayName":"sap.ushell.services.SpaceContent.Range","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.SpaceContent.Range","subTitle":""},{"kind":"class","name":"sap.ushell.services.SupportTicket","basename":"SupportTicket","resource":"sap/ushell/services/SupportTicket.js","module":"sap/ushell/services/SupportTicket","export":"","static":true,"visibility":"public","since":"1.19.1","extends":"sap.ushell.services.Service","description":"The Unified Shell's SupportTicket service.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const SupportTicket = await Container.getServiceAsync(\"SupportTicket\");\n // do something with the SupportTicket service\n });\n ","hideconstructor":true,"methods":[{"name":"createTicket","visibility":"public","since":"1.20.0","returnValue":{"type":"Promise","description":"Promise, that returns the ID of the generated message
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"oSupportTicketData","optional":false,"description":"
JSON object containing the input fields required for the support ticket.
","typeInfo":{"template":"object"},"defaultValue":""},{"name":"subject","optional":false,"description":"
Subject line of the ticket.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oSupportTicketData.subject","defaultValue":""},{"name":"text","optional":false,"description":"
Long text or description of the support ticket.
","depth":1,"typeInfo":{"template":"string"},"phoneName":"oSupportTicketData.text","defaultValue":""},{"name":"clientContext","optional":false,"description":"
JSON object containing client-related information.
","depth":1,"typeInfo":{"template":"object"},"phoneName":"oSupportTicketData.clientContext","defaultValue":""}],"description":"Creates a Support Ticket. Forwards the given data (JSON object) to the associated adapter.
","href":"api/sap.ushell.services.SupportTicket#methods/createTicket","code":"createTicket(oSupportTicketData) : Promise "},{"name":"isEnabled","visibility":"public","since":"1.20.0","returnValue":{"type":"boolean","description":"true if the service is enabled; false otherwise
","typeInfo":{"template":"boolean"}},"description":"Checks if the service is enabled.
The service enablement depends on the configuration in the back-end system and the bootstrap configuration.
","href":"api/sap.ushell.services.SupportTicket#methods/isEnabled","code":"isEnabled() : boolean "}],"displayName":"sap.ushell.services.SupportTicket","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.SupportTicket","subTitle":""},{"kind":"class","name":"sap.ushell.services.URLParsing","basename":"URLParsing","resource":"sap/ushell/services/URLParsing.js","module":"sap/ushell/services/URLParsing","export":"","static":true,"visibility":"public","since":"1.15.0","extends":"sap.ushell.services.Service","description":"The Unified Shell's internal URL parsing service (platform independent).
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const URLParsing = await Container.getServiceAsync(\"URLParsing\");\n // do something with the URLParsing service\n });\n Methods in this class allow to break down a shell compliant hash into it's respective parts (SemanticObject,Action,Context, Parameters, appSpecificHash) or (ShellPart,appSpecificHash) respectively or construct a hash from its constituents.
All methods deal with the *internal* shellHash format.
Most of the parse methods are robust w.r.t. a leading \"#\".
Note: The functions were designed with a \"truthy\" behavior for not present values, Thus a client should not rely on the difference between null, \"undefined\", \"\" when testing for the result of a parse action.
The parsing functions are deliberately restrictive and fragile, only shell compliant hashes are parsed correctly, behavior for non-compliant hashes is undefined and subject to change, notably we do not aim do \"degrade\" nicely or support partial parsing of corrupted urls.
","hideconstructor":true,"methods":[{"name":"addSystemToServiceUrl","visibility":"public","since":"1.19.1","returnValue":{"type":"string","description":"the service URL pointing to the system specified in parameter vComponentOrSystem or to the system of the current application
","typeInfo":{"template":"string"}},"parameters":[{"name":"sServiceUrl","optional":false,"description":"
a server-relative URL without system alias information
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"vComponentOrSystem","optional":true,"description":"
the root component of the FLP application ( getComponentData().startupParameters["sap-system"][0] is used as system alias if present) or a string valued system specification like "SYS" or "sid(SYS.123)" if undefined or falsy the system of the current application is used
","typeInfo":{"template":"string | ${0}","UI5Types":["sap.ui.core.Component"]},"defaultValue":""}],"throws":[{"description":"Error if the URL is not server-relative (e.g. ./something, http://foo.bar/something, ...)
","type":"undefined","linkEnabled":false}],"description":"Note: deprecated, please use sap.ui.model.odata.ODataUtils.setOrigin(sServiceUrl, { alias : sSystem }); Makes the given server-relative SAP OData service URL point to the system given explicitly as parameter vComponentOrSystem. If this parameter is not provided, it makes the server-relative URL point to the system of the current application. Server-relative URL means a URL starting with exactly one "/" (also known as absolute-path URL). The system of the current application is taken from the parameter "sap-system" of the last navigation target resolution result.
If either a multiple-origin parameter ;mo/ or an origin parameter with qualified system (;o=sid(SYS.123) or o=SYSALIAS) is already present, the sServiceUrl is returned unchanged.
The framework invokes this function for SAPUI5 applications that have been built using declarative model instantiation with the application descriptor (data source) mechanism or using an sap.ca framework. For these applications, you do not need to invoke this function explicitly in the application code. If the application does not use any of these mechanisms, but explicitly constructs additional OData models or performs OData requests, the application code shall invoke this function. It shall pass its root component instance as vComponentOrSystem - the function will then determine the system from the navigation start-up parameter "sap-system" (getComponentData().startupParameters["sap-system"][0]). Applications may call this API with parameter vComponentOrSystem and a non-empty string value if application-specific logic is used to determine the target system for service calls.
With service URLs converted using this API, administrators can redirect service calls to servers other than the default SAP Gateway and back-end server either via reverse proxy (e.g. SAP Web Dispatcher) configuration or using the system alias functionality of the SAP Gateway server.
The system is added to the last URL segment of the service URL with the segment parameter ;o=. You can also make this function put the system to a different URL path segment of the service URL by specifying the empty segment parameter ;o=, e.g. /sap/opu/odata/MyService;o=/MyEntities/$count?p1=v1. If both vComponentOrSystem is empty and the current application has no system, no system is added and the empty segment parameter ;o is removed.
Example 1: /sap/opu/odata/MyService/?p1=v1 is converted to /sap/opu/odata/MyService;o=SYS/?p1=v1 if the target system is "SYS". However it remains unchanged if both the current application's system and the parameter vComponentOrSystem are empty.
Example 2: /sap/opu/odata/MyService;o=/MyEntities/$count?p1=v1 is converted to /sap/opu/odata/MyService;o=sid(SYS.123)/MyEntities/$count?p1=v1 if parameter vComponentOrSystem is set to "sid(SYS.123)".
The URL is in no way normalized.
","deprecated":{"since":"1.31","text":"Please use {@link sap.ui.model.odata.ODataUtils#setOrigin} instead."},"href":"api/sap.ushell.services.URLParsing#methods/addSystemToServiceUrl","deprecatedText":"Deprecated as of version 1.31. Please use sap.ui.model.odata.ODataUtils#setOrigin instead.","code":"addSystemToServiceUrl(sServiceUrl, vComponentOrSystem?) : string "},{"name":"constructShellHash","visibility":"public","since":"1.16.0","returnValue":{"type":"sap.ushell.services.Navigation.TargetIntentStrict","description":"the hash part of an URL, e.g. \"Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH Returns an empty string in case no shell hash was provided.
","typeInfo":{"UI5Types":["sap.ushell.services.Navigation.TargetIntentStrict"]}},"parameters":[{"name":"oShellHash","optional":true,"description":"
The parts of a shell hash. Its action must be a valid action, It may not contain \"?\" or directly a parameter string. Note: In general it is preferred to add an appStateKey directly to the params object.
","typeInfo":{"UI5Types":["sap.ushell.services.URLParsing.ShellHash"]},"defaultValue":""}],"description":"compose a shell Hash from it's respective parts Note that it also may append an app specific route!
","href":"api/sap.ushell.services.URLParsing#methods/constructShellHash","code":"constructShellHash(oShellHash?) : sap.ushell.services.Navigation.TargetIntentStrict "},{"name":"getHash","visibility":"public","since":"1.16.0","returnValue":{"type":"string","description":"extracted string if and only if a hash is present, undefined otherwise
","typeInfo":{"template":"string"}},"parameters":[{"name":"sURL","optional":false,"description":"
any value
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Extract a hash part from an URL, including an app-specific part
","href":"api/sap.ushell.services.URLParsing#methods/getHash","code":"getHash(sURL) : string "},{"name":"getShellHash","visibility":"public","since":"1.16.0","returnValue":{"type":"sap.ushell.services.Navigation.TargetIntent","description":"the parsed result
","typeInfo":{"UI5Types":["sap.ushell.services.Navigation.TargetIntent"]}},"parameters":[{"name":"sShellHashString","optional":false,"description":"
a valid (Shell) url, e.g. http://xx.b.c#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
","typeInfo":{"UI5Types":["sap.ui.core.URI"]},"defaultValue":""}],"description":"Extract the Shell hash# part from an URL The application specific route part is removed See #getHash for a function which retains the app specific route.
Shell services shall use this service to extract relevant parts of an URL from an actual URL string (which should be treated as opaque)
The URL has to comply with the Fiori-Wave 2 agreed upon format
This service shall be used to extract a hash part from an url. The result can be further broken up by parseShellHash
Examples
http://a.b.c?defhij#SemanticObject-Action?PV1=A&PV2=B&/appspecific
Note: the results when passing an illegal (non-compliant) url are undefined and subject to change w.o. notice. Notably further checks may added. The design is deliberately restrictive and non-robust.
","href":"api/sap.ushell.services.URLParsing#methods/getShellHash","code":"getShellHash(sShellHashString) : sap.ushell.services.Navigation.TargetIntent "},{"name":"isIntentUrl","visibility":"public","since":"1.30.0","returnValue":{"type":"boolean","description":"true if the conditions are fulfilled.
","typeInfo":{"template":"boolean"}},"parameters":[{"name":"sUrl","optional":false,"description":"
the URL to test. Note: this url must be in internal format.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Check if a URL has an intent based navigation part which can be parsed into a semantic object and action part. Accepts only a relative URL (must contain #) or fully qualified Urls for which origin and filename must correspond to the running launchpad.
Given actual url http://www.mycorp.com/sap/fiori/FioriLaunchpad.html?sap-language=DE#SO-action?P1=value1, the following parts http://www.mycorp.com/sap/fiori/FioriLaunchpad.html must match.
The actual test is synchronous and *only* tests whether the hash part can be parsed and contains a semantic object and action. It does not test whether the intent or its parameters are valid for a given user
","deprecated":{"since":"1.96","text":"Please use {@link #isIntentUrlAsync} instead."},"href":"api/sap.ushell.services.URLParsing#methods/isIntentUrl","deprecatedText":"Deprecated as of version 1.96. Please use #isIntentUrlAsync instead.","code":"isIntentUrl(sUrl) : boolean "},{"name":"isIntentUrlAsync","visibility":"public","since":"1.96.0","returnValue":{"type":"Promise","description":"true if the conditions are fulfilled.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sUrl","optional":false,"description":"
the URL to test. Note: this url must be in internal format.
","typeInfo":{"template":"string"},"defaultValue":""}],"description":"Check if a URL has an intent based navigation part which can be parsed into a semantic object and action part. Accepts only a relative URL (must contain #) or fully qualified Urls for which origin and filename must correspond to the running launchpad.
Given actual url http://www.mycorp.com/sap/fiori/FioriLaunchpad.html?sap-language=DE#SO-action?P1=value1, the following parts http://www.mycorp.com/sap/fiori/FioriLaunchpad.html must match.
This function *only* tests whether the hash part can be parsed and contains a semantic object and action. It does not test whether the intent or its parameters are valid for a given user
","href":"api/sap.ushell.services.URLParsing#methods/isIntentUrlAsync","code":"isIntentUrlAsync(sUrl) : Promise "},{"name":"paramsToString","visibility":"public","since":"1.20.0","returnValue":{"type":"sap.ui.core.URI","description":"* @returns {sap.ui.core.URI} The parameter string, e.g. ABC=1&ABC=1%202&DEF=4. Note that the result is *not* prefixed with a \"?\", parameter values are encodeURIComponent encoded.
","typeInfo":{"UI5Types":["sap.ui.core.URI"]}},"parameters":[{"name":"oParams","optional":false,"description":"
The parameters to combine into the parameter String, e.g. { ABC : [1,\"1 2\"], DEF : [\"4\"]}
","typeInfo":{"template":"Object>","UI5Types":["sap.ushell.services.URLParsing.URLValue"]},"defaultValue":""}],"description":"combine members of a javascript object into a parameter string, note that parameters are ordered in an arbitrary manner which is subject to change
","href":"api/sap.ushell.services.URLParsing#methods/paramsToString","code":"paramsToString(oParams) : sap.ui.core.URI "},{"name":"parseParameters","visibility":"public","since":"1.20.0","returnValue":{"type":"Object","description":"The parsed parameters, e.g. { ABC : [\"1\", \"1 2\"], DEF : [\"4\"]}.
","typeInfo":{"template":"Object>","UI5Types":["sap.ushell.services.URLParsing.URLValue"]}},"parameters":[{"name":"sParams","optional":false,"description":"
Parameter string, e.g. ?ABC=1&ABC=1%202&DEF=4
","typeInfo":{"UI5Types":["sap.ui.core.URI"]},"defaultValue":""}],"description":"This method parses parameters from a URI query string (starting with ?) and puts the result into a parameter object.
","href":"api/sap.ushell.services.URLParsing#methods/parseParameters","code":"parseParameters(sParams) : Object "},{"name":"parseShellHash","visibility":"public","since":"1.16.0","returnValue":{"type":"sap.ushell.services.URLParsing.DecomposedHash","description":"undefined if not a parsable hash
","typeInfo":{"UI5Types":["sap.ushell.services.URLParsing.DecomposedHash"],"refersToTypedef":true}},"parameters":[{"name":"sHash","optional":false,"description":"
Hash part of a shell compliant URL #SO-Action?P1=a&P2=x&/route?RPV=1 the hash part of an URL, \"#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
","typeInfo":{"UI5Types":["sap.ushell.services.Navigation.TargetIntent"]},"defaultValue":""}],"description":"Decompose a shell hash into the respective parts
","href":"api/sap.ushell.services.URLParsing#methods/parseShellHash","code":"parseShellHash(sHash) : sap.ushell.services.URLParsing.DecomposedHash "},{"name":"splitHash","visibility":"public","since":"1.16.0","returnValue":{"type":"sap.ushell.services.URLParsing.SplitHash","description":"{}(empty object) if not a parsable hash
\n {\n shellPart : \"Object-name?PV1=PV2&PV4=V5\",\n appSpecificRoute : \"display/detail/7?UU=HH\"\n }\n otherwise Note that params always has an Array for each parameter value!","typeInfo":{"UI5Types":["sap.ushell.services.URLParsing.SplitHash"],"refersToTypedef":true}},"parameters":[{"name":"sHash","optional":false,"description":"
The hash part of a shell conformant URL. It has to have the following format: #SO-Action?P1=a&P2=x&/route?RPV=1 Here is an example for the hash part of an URL: \"#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
","typeInfo":{"UI5Types":["sap.ushell.services.Navigation.TargetIntent"]},"defaultValue":""}],"description":"split a Unified Shell compliant hash into an Object containing a shell specific part and an app specific parts for non compliant hash strings, the empty object {} is returned. an optional leading # is stripped
","href":"api/sap.ushell.services.URLParsing#methods/splitHash","code":"splitHash(sHash) : sap.ushell.services.URLParsing.SplitHash "}],"displayName":"sap.ushell.services.URLParsing","nodes":[{"name":"sap.ushell.services.URLParsing.DecomposedHash","description":"Describes the result of #parseShellHash .
","href":"api/sap.ushell.services.URLParsing.DecomposedHash"},{"name":"sap.ushell.services.URLParsing.SimpleTarget","description":"Commonly used by services like sap.ushell.services.Navigation .
","href":"api/sap.ushell.services.URLParsing.SimpleTarget"},{"name":"sap.ushell.services.URLParsing.SplitHash","description":"Type for SplitHash
","href":"api/sap.ushell.services.URLParsing.SplitHash"},{"name":"sap.ushell.services.URLParsing.Target","description":"Commonly used by services like sap.ushell.services.Navigation
","href":"api/sap.ushell.services.URLParsing.Target"},{"name":"sap.ushell.services.URLParsing.URLValue","description":"Type for Url value
","href":"api/sap.ushell.services.URLParsing.URLValue"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.URLParsing","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.URLParsing.DecomposedHash","basename":"DecomposedHash","resource":"sap/ushell/services/URLParsing.js","module":"sap/ushell/services/URLParsing","static":true,"visibility":"public","since":"1.120.0","description":"
Describes the result of #parseShellHash .
","properties":[{"name":"semanticObject","optional":false,"visibility":"public","description":"the semantic object
","typeInfo":{"template":"string"}},{"name":"action","optional":false,"visibility":"public","description":"the action
","typeInfo":{"template":"string"}},{"name":"params","optional":false,"visibility":"public","description":"the parameters
","typeInfo":{"template":"Object>"}},{"name":"appStateKey","optional":true,"visibility":"public","description":"the app state key
","typeInfo":{"template":"string"}},{"name":"appSpecificRoute","optional":false,"visibility":"public","description":"the app specific route
","typeInfo":{"template":"string"}}],"displayName":"sap.ushell.services.URLParsing.DecomposedHash","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.URLParsing.DecomposedHash","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.URLParsing.SimpleTarget","basename":"SimpleTarget","resource":"sap/ushell/services/URLParsing.js","module":"sap/ushell/services/URLParsing","static":true,"visibility":"public","since":"1.124.0","description":"
Commonly used by services like sap.ushell.services.Navigation . Use this type for edge cases only. Use sap.ushell.services.URLParsing.DecomposedHash instead. This type ignores all other properties
","properties":[{"name":"target","optional":false,"visibility":"public","description":"The target object
","typeInfo":{"template":"object"}},{"name":"shellHash","optional":false,"description":"
The shell hash
","visibility":"public","depth":1,"phoneName":"target.shellHash","typeInfo":{"UI5Types":["sap.ushell.services.Navigation.TargetIntent"]}}],"displayName":"sap.ushell.services.URLParsing.SimpleTarget","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.URLParsing.SimpleTarget","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.URLParsing.SplitHash","basename":"SplitHash","resource":"sap/ushell/services/URLParsing.js","module":"sap/ushell/services/URLParsing","static":true,"visibility":"public","since":"1.120.0","description":"
Type for SplitHash
","properties":[{"name":"shellPart","optional":false,"visibility":"public","description":"the shell part of the hash
","typeInfo":{"UI5Types":["sap.ui.core.URI"]}},{"name":"appSpecificRoute","optional":false,"visibility":"public","description":"the app specific route part of the hash
","typeInfo":{"UI5Types":["sap.ui.core.URI"]}}],"displayName":"sap.ushell.services.URLParsing.SplitHash","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.URLParsing.SplitHash","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.URLParsing.Target","basename":"Target","resource":"sap/ushell/services/URLParsing.js","module":"sap/ushell/services/URLParsing","static":true,"visibility":"public","since":"1.142.0","description":"
Commonly used by services like sap.ushell.services.Navigation
","properties":[{"name":"target","optional":false,"visibility":"public","description":"The target object
","typeInfo":{"template":"object"}},{"name":"semanticObject","optional":false,"description":"
the semantic object
","visibility":"public","depth":1,"phoneName":"target.semanticObject","typeInfo":{"template":"string"}},{"name":"action","optional":false,"description":"
the action
","visibility":"public","depth":1,"phoneName":"target.action","typeInfo":{"template":"string"}},{"name":"params","optional":false,"visibility":"public","description":"the parameters
","typeInfo":{"template":"Object>"}},{"name":"appSpecificRoute","optional":false,"visibility":"public","description":"the app specific route
","typeInfo":{"template":"string"}},{"name":"appStateKey","optional":true,"visibility":"public","description":"the app state key
","typeInfo":{"template":"string"}}],"displayName":"sap.ushell.services.URLParsing.Target","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.URLParsing.Target","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.URLParsing.URLValue","basename":"URLValue","resource":"sap/ushell/services/URLParsing.js","module":"sap/ushell/services/URLParsing","static":true,"visibility":"public","since":"1.120.0","description":"
Type for Url value
","type":"string|int","displayName":"sap.ushell.services.URLParsing.URLValue","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.URLParsing.URLValue","subTitle":""},{"kind":"class","name":"sap.ushell.services.UsageAnalytics","basename":"UsageAnalytics","resource":"sap/ushell/services/UsageAnalytics.js","module":"sap/ushell/services/UsageAnalytics","export":"","static":true,"visibility":"public","since":"1.32.0","extends":"sap.ushell.services.Service","description":"A UShell service for tracking business flows and user actions.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const UsageAnalytics = await Container.getServiceAsync(\"UsageAnalytics\");\n // do something with the UsageAnalytics service\n });\n The UsageAnalytics service exposes API for logging custom events and setting custom field values in the logged events.baseUrl service configuration property.pubToken attribute.
Each tracked event is represented by a table entry on the server database.
Two types of events can be logged:
Each tracked event (either automatic or custom) is represented by a database row, that includes 10 custom attributes named custom1...custom10.
","hideconstructor":true,"methods":[{"name":"setCustomAttributes","visibility":"public","since":"1.32.0","parameters":[{"name":"oCustomFieldValues","optional":false,"description":"
An json object that includes attribute1...attribute6 (or subset)
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Sets up to 6 customer attributes of logged events according to the given object attributes.
","deprecated":{"since":"1.120","text":"Deprecated without successor. SAP Web Analytics has been retired."},"href":"api/sap.ushell.services.UsageAnalytics#methods/setCustomAttributes","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor. SAP Web Analytics has been retired.","code":"setCustomAttributes(oCustomFieldValues) : void "},{"name":"setLegalText","visibility":"public","since":"1.32.0","description":"Enables the renderer to set the content of the legal message..
","deprecated":{"since":"1.120","text":"Deprecated without successor. SAP Web Analytics has been retired."},"href":"api/sap.ushell.services.UsageAnalytics#methods/setLegalText","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor. SAP Web Analytics has been retired.","code":"setLegalText() : void "},{"name":"systemEnabled","visibility":"public","since":"1.32.0","returnValue":{"type":"boolean","description":"A boolean value indicating whether the UsageAnalytics service is enabled
","typeInfo":{"template":"boolean"}},"description":"Indicates whether the service is available.
Since the service is deprecated and no longer supported, this method always returns false.
","deprecated":{"since":"1.120","text":"Deprecated without successor. SAP Web Analytics has been retired."},"href":"api/sap.ushell.services.UsageAnalytics#methods/systemEnabled","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor. SAP Web Analytics has been retired.","code":"systemEnabled() : boolean "},{"name":"userEnabled","visibility":"public","since":"1.32.0","returnValue":{"type":"boolean","description":"A boolean value indicating whether the user has specified to track activities
","typeInfo":{"template":"boolean"}},"description":"Indicates whether the user has specified to track activities.
Since the service is deprecated and no longer supported, this method always returns false.
","deprecated":{"since":"1.120","text":"Deprecated without successor. SAP Web Analytics has been retired."},"href":"api/sap.ushell.services.UsageAnalytics#methods/userEnabled","deprecatedText":"Deprecated as of version 1.120. Deprecated without successor. SAP Web Analytics has been retired.","code":"userEnabled() : boolean "}],"displayName":"sap.ushell.services.UsageAnalytics","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.UsageAnalytics","subTitle":"Deprecated in version: 1.120","deprecatedText":"Deprecated as of version 1.120. The corresponding cloud service \"SAP Web Analytics\" has been retired, therefore this client-side service API cannot be used any longer."},{"kind":"class","name":"sap.ushell.services.UserDefaultParameters","basename":"UserDefaultParameters","resource":"sap/ushell/services/UserDefaultParameters.js","module":"sap/ushell/services/UserDefaultParameters","export":"","static":true,"visibility":"restricted","allowedFor":["ssuite.smartbusiness"],"since":"1.32.0","description":"The Unified Shell's UserDefaultParameters service.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const UserDefaultParameters = await Container.getServiceAsync(\"UserDefaultParameters\");\n // do something with the UserDefaultParameters service\n });\n ","hideconstructor":true,"methods":[{"name":"attachValueStored","visibility":"restricted","allowedFor":["FIN UserDefaults Plugin"],"since":"1.34.0","parameters":[{"name":"fnFunction","optional":false,"description":"
Event handler to be attached.
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Attaches a listener to the valueStored event.
","href":"api/sap.ushell.services.UserDefaultParameters#methods/attachValueStored","code":"attachValueStored(fnFunction) : void "},{"name":"detachValueStored","visibility":"restricted","allowedFor":["FIN UserDefaults Plugin"],"since":"1.34.0","parameters":[{"name":"fnFunction","optional":false,"description":"
Event handler to be detached.
","typeInfo":{"template":"function"},"defaultValue":""}],"description":"Detaches a listener from the valueStored event.
","href":"api/sap.ushell.services.UserDefaultParameters#methods/detachValueStored","code":"detachValueStored(fnFunction) : void "},{"name":"getValue","visibility":"restricted","allowedFor":["ssuite.smartbusiness"],"returnValue":{"type":"Promise","description":"Resolves a rich parameter object containing a value, e.g. { value : \"value\" }. The promise will typically always be resolved. Note: It will always return an object, the value property may be undefined if no value could be retrieved.
","typeInfo":{"template":"Promise"}},"parameters":[{"name":"sParameterName","optional":false,"description":"
The parameter name
","typeInfo":{"template":"string"},"defaultValue":""},{"name":"oSystemContext","optional":false,"description":"
The system context object
","typeInfo":{"template":"object"},"defaultValue":""}],"description":"Attempt to determine a value for the parameter name sParameterName.
","href":"api/sap.ushell.services.UserDefaultParameters#methods/getValue","code":"getValue(sParameterName, oSystemContext) : Promise "},{"name":"registerPlugin","visibility":"restricted","allowedFor":["FIN UserDefaults Plugin"],"parameters":[{"name":"oPlugin","optional":false,"description":"
the Plugin to register with the service
","typeInfo":{"template":"object"},"defaultValue":""}],"href":"api/sap.ushell.services.UserDefaultParameters#methods/registerPlugin","code":"registerPlugin(oPlugin) : void "}],"displayName":"sap.ushell.services.UserDefaultParameters","component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.UserDefaultParameters","subTitle":""},{"kind":"class","name":"sap.ushell.services.UserInfo","basename":"UserInfo","resource":"sap/ushell/services/UserInfo.js","module":"sap/ushell/services/UserInfo","export":"","static":true,"visibility":"public","since":"1.16.3","extends":"sap.ushell.services.Service","description":"The Unified Shell's user information service. Allows retrieving information about the logged-in user.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const UserInfo = await Container.getServiceAsync(\"UserInfo\");\n // do something with the UserInfo service\n });\n ","hideconstructor":true,"methods":[{"name":"getEmail","visibility":"public","since":"1.86.0","returnValue":{"type":"string","description":"The user's email address.
","typeInfo":{"template":"string"}},"description":"Returns the email address of the user.
","href":"api/sap.ushell.services.UserInfo#methods/getEmail","code":"getEmail() : string "},{"name":"getFirstName","visibility":"public","since":"1.86.0","returnValue":{"type":"string","description":"The user's first name.
","typeInfo":{"template":"string"}},"description":"Returns the first name of the user.
","href":"api/sap.ushell.services.UserInfo#methods/getFirstName","code":"getFirstName() : string "},{"name":"getFullName","visibility":"public","since":"1.86.0","returnValue":{"type":"string","description":"The user's full name.
","typeInfo":{"template":"string"}},"description":"Returns the full name of the user.
","href":"api/sap.ushell.services.UserInfo#methods/getFullName","code":"getFullName() : string "},{"name":"getId","visibility":"public","since":"1.16.3","returnValue":{"type":"string","description":"The user id.
","typeInfo":{"template":"string"}},"description":"Returns the id of the user.
","href":"api/sap.ushell.services.UserInfo#methods/getId","code":"getId() : string "},{"name":"getLastName","visibility":"public","since":"1.86.0","returnValue":{"type":"string","description":"The user's last name.
","typeInfo":{"template":"string"}},"description":"Returns the last name of the user.
","href":"api/sap.ushell.services.UserInfo#methods/getLastName","code":"getLastName() : string "},{"name":"getShellUserInfo","visibility":"public","since":"1.115.0","returnValue":{"type":"Promise","description":"Object providing information about the logged-in user.
","typeInfo":{"template":"Promise<${0}>","UI5Types":["sap.ushell.services.UserInfo.ShellUserInfo"]}},"description":"Returns an object representing data about the user.
","href":"api/sap.ushell.services.UserInfo#methods/getShellUserInfo","code":"getShellUserInfo() : Promise "}],"displayName":"sap.ushell.services.UserInfo","nodes":[{"name":"sap.ushell.services.UserInfo.ShellUserInfo","description":"Type for an object representing data about the user: ID, first name, last name, full name, e-mail address.
","href":"api/sap.ushell.services.UserInfo.ShellUserInfo"}],"component":"CA-FLP-FE-UI","hasSample":false,"title":"class sap.ushell.services.UserInfo","subTitle":""},{"kind":"typedef","name":"sap.ushell.services.UserInfo.ShellUserInfo","basename":"ShellUserInfo","resource":"sap/ushell/services/UserInfo.js","module":"sap/ushell/services/UserInfo","static":true,"visibility":"public","since":"1.120.0","description":"
Type for an object representing data about the user: ID, first name, last name, full name, e-mail address.
","properties":[{"name":"id","optional":false,"visibility":"public","description":"The user id.
","typeInfo":{"template":"string"}},{"name":"email","optional":false,"visibility":"public","description":"The user's email address.
","typeInfo":{"template":"string"}},{"name":"firstName","optional":false,"visibility":"public","description":"The user's first name.
","typeInfo":{"template":"string"}},{"name":"lastName","optional":false,"visibility":"public","description":"The user's last name.
","typeInfo":{"template":"string"}},{"name":"fullName","optional":false,"visibility":"public","description":"The user's full name.
","typeInfo":{"template":"string"}}],"displayName":"sap.ushell.services.UserInfo.ShellUserInfo","component":"CA-FLP-FE-UI","hasSample":false,"title":"typedef sap.ushell.services.UserInfo.ShellUserInfo","subTitle":""},{"kind":"class","name":"sap.ushell.services.UserRecents","basename":"UserRecents","resource":"sap/ushell/services/UserRecents.js","module":"sap/ushell/services/UserRecents","export":"","static":true,"visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1","sap.esh.search.ui"],"since":"1.15.0","description":"The Unified Shell's user recents service. Manages recent searches and recently viewed apps.
Note: To retrieve a valid instance of this service, it is necessary to call sap.ushell.Container#getServiceAsync .
\n sap.ui.require([\"sap/ushell/Container\"], async function (Container) {\n const UserRecents = await Container.getServiceAsync(\"UserRecents\");\n // do something with the UserRecents service\n });\n ","hideconstructor":true,"methods":[{"name":"addActivity","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1","sap.esh.search.ui"],"since":"1.32.0","returnValue":{"type":"Promise","description":"A Promise that is resolved to the list of updated activities.
","typeInfo":{"template":"Promise>","UI5Types":["sap.ushell.services.UserRecents.ActivityItem"]}},"parameters":[{"name":"oActivityItem","optional":false,"description":"
The activity to be added.
","typeInfo":{"UI5Types":["sap.ushell.services.UserRecents.ActivityItem"],"refersToTypedef":true},"defaultValue":""}],"description":"Adds the given activity item to the list of activities.
Respects the user's tracking-user-activities preference: when the user has disabled activity tracking, the item is not persisted and the current list is returned unchanged.
Was part of the public interface.
","href":"api/sap.ushell.services.UserRecents#methods/addActivity","code":"addActivity(oActivityItem) : Promise "},{"name":"getFrequentActivity","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1","sap.esh.search.ui"],"since":"1.42.0","returnValue":{"type":"Promise","description":"A Promise that is resolved to a list of frequently used activities.
","typeInfo":{"template":"Promise>","UI5Types":["sap.ushell.services.UserRecents.ActivityItem"]}},"description":"Resolves the frequent activities.
Was part of the public interface.
","href":"api/sap.ushell.services.UserRecents#methods/getFrequentActivity","code":"getFrequentActivity() : Promise "},{"name":"getRecentActivity","visibility":"restricted","allowedFor":["ux.eng.producthome","ux.eng.s4producthomes1","sap.esh.search.ui"],"since":"1.32.0","returnValue":{"type":"Promise","description":"A Promise that is resolved to the list of activities.
","typeInfo":{"template":"Promise>","UI5Types":["sap.ushell.services.UserRecents.ActivityItem"]}},"description":"Resolves to the list of activities.
Was part of the public interface.
","href":"api/sap.ushell.services.UserRecents#methods/getRecentActivity","code":"getRecentActivity() : Promise