@sapui5/types 1.123.1 → 1.124.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +13 -10
- package/README.md +1 -1
- package/package.json +1 -1
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +5 -3
- package/types/sap.esh.search.ui.d.ts +126 -1
- package/types/sap.f.d.ts +49 -12
- package/types/sap.fe.core.d.ts +14 -6
- package/types/sap.fe.macros.d.ts +2309 -463
- package/types/sap.fe.navigation.d.ts +1 -1
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +31 -4
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +3 -2
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.m.d.ts +4151 -476
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +200 -82
- package/types/sap.suite.ui.commons.d.ts +5 -3
- package/types/sap.suite.ui.generic.template.d.ts +31 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +3 -2
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +17 -9
- package/types/sap.ui.comp.d.ts +171 -31
- package/types/sap.ui.core.d.ts +130 -231
- package/types/sap.ui.dt.d.ts +6 -2
- package/types/sap.ui.export.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +3 -2
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +1 -1
- package/types/sap.ui.layout.d.ts +7 -4
- package/types/sap.ui.mdc.d.ts +482 -755
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +1 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +4 -3
- package/types/sap.ui.ux3.d.ts +3 -2
- package/types/sap.ui.vbm.d.ts +3 -2
- package/types/sap.ui.vk.d.ts +77 -26
- package/types/sap.ui.vtm.d.ts +23 -12
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +23 -12
- package/types/sap.ui.webc.main.d.ts +65 -33
- package/types/sap.uiext.inbox.d.ts +62 -1
- package/types/sap.ushell.d.ts +649 -198
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +11 -6
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
package/types/sap.ushell.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.124.1
|
|
2
2
|
|
|
3
3
|
declare module "sap/ushell/library" {
|
|
4
4
|
/**
|
|
@@ -868,7 +868,14 @@ declare module "sap/ushell/Container" {
|
|
|
868
868
|
|
|
869
869
|
/**
|
|
870
870
|
* The Unified Shell's container. Manages renderers, services, and adapters. The container is designed to
|
|
871
|
-
* be a singleton, therefore instead of creating an instance, access the central one via
|
|
871
|
+
* be a singleton, therefore instead of creating an instance, access the central one via
|
|
872
|
+
* ```javascript
|
|
873
|
+
*
|
|
874
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
875
|
+
* // do something with the container
|
|
876
|
+
* });
|
|
877
|
+
* ```
|
|
878
|
+
*
|
|
872
879
|
* See:
|
|
873
880
|
* sap.ushell.bootstrap
|
|
874
881
|
*
|
|
@@ -1272,8 +1279,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
|
|
|
1272
1279
|
|
|
1273
1280
|
/**
|
|
1274
1281
|
* The SAPUI5 component of SAP Fiori Launchpad renderer for the Unified Shell. This method MUST be called
|
|
1275
|
-
* by the Unified Shell's container only, others MUST call
|
|
1276
|
-
* true)`.
|
|
1282
|
+
* by the Unified Shell's container only, others MUST call {@link sap.ushell.Container#getRenderer}.
|
|
1277
1283
|
*
|
|
1278
1284
|
* @since 1.15.0
|
|
1279
1285
|
* @deprecated (since 1.120.0) - Please use {@link sap.ushell.services.Extension} instead.
|
|
@@ -2744,8 +2750,16 @@ declare module "sap/ushell/services/AppLifeCycle" {
|
|
|
2744
2750
|
/**
|
|
2745
2751
|
* The Unified Shell's AppLifeCycle service.
|
|
2746
2752
|
*
|
|
2747
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
2748
|
-
*
|
|
2753
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
2754
|
+
*
|
|
2755
|
+
* ```javascript
|
|
2756
|
+
*
|
|
2757
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
2758
|
+
* const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
|
|
2759
|
+
* // do something with the AppLifeCycle service
|
|
2760
|
+
* });
|
|
2761
|
+
* ```
|
|
2762
|
+
*
|
|
2749
2763
|
*
|
|
2750
2764
|
* @since 1.38
|
|
2751
2765
|
*/
|
|
@@ -2810,8 +2824,7 @@ declare module "sap/ushell/services/AppLifeCycle" {
|
|
|
2810
2824
|
oListener: object
|
|
2811
2825
|
): void;
|
|
2812
2826
|
/**
|
|
2813
|
-
* Returns information about the currently running application
|
|
2814
|
-
* application or `undefined` if no application is running.
|
|
2827
|
+
* Returns information about the currently running application or `undefined` if no application is running.
|
|
2815
2828
|
*
|
|
2816
2829
|
* @since 1.38
|
|
2817
2830
|
*
|
|
@@ -3024,8 +3037,16 @@ declare module "sap/ushell/services/Bookmark" {
|
|
|
3024
3037
|
/**
|
|
3025
3038
|
* The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
|
|
3026
3039
|
*
|
|
3027
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
3028
|
-
*
|
|
3040
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
3041
|
+
*
|
|
3042
|
+
* ```javascript
|
|
3043
|
+
*
|
|
3044
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
3045
|
+
* const Bookmark = await Container.getServiceAsync("Bookmark");
|
|
3046
|
+
* // do something with the Bookmark service
|
|
3047
|
+
* });
|
|
3048
|
+
* ```
|
|
3049
|
+
*
|
|
3029
3050
|
*
|
|
3030
3051
|
* @since 1.15.0
|
|
3031
3052
|
* @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2} instead.
|
|
@@ -3368,8 +3389,16 @@ declare module "sap/ushell/services/BookmarkV2" {
|
|
|
3368
3389
|
/**
|
|
3369
3390
|
* The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
|
|
3370
3391
|
*
|
|
3371
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
3372
|
-
*
|
|
3392
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
3393
|
+
*
|
|
3394
|
+
* ```javascript
|
|
3395
|
+
*
|
|
3396
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
3397
|
+
* const BookmarkV2 = await Container.getServiceAsync("BookmarkV2");
|
|
3398
|
+
* // do something with the BookmarkV2 service
|
|
3399
|
+
* });
|
|
3400
|
+
* ```
|
|
3401
|
+
*
|
|
3373
3402
|
*
|
|
3374
3403
|
* @since 1.119.0
|
|
3375
3404
|
*/
|
|
@@ -3626,8 +3655,16 @@ declare module "sap/ushell/services/Configuration" {
|
|
|
3626
3655
|
* The unified shell's Configuration service. Allows attaching to **selected** launchpad configuration settings
|
|
3627
3656
|
* and their value changes.
|
|
3628
3657
|
*
|
|
3629
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
3630
|
-
*
|
|
3658
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
3659
|
+
*
|
|
3660
|
+
* ```javascript
|
|
3661
|
+
*
|
|
3662
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
3663
|
+
* const Configuration = await Container.getServiceAsync("Configuration");
|
|
3664
|
+
* // do something with the Configuration service
|
|
3665
|
+
* });
|
|
3666
|
+
* ```
|
|
3667
|
+
*
|
|
3631
3668
|
*
|
|
3632
3669
|
* @since 1.64.0
|
|
3633
3670
|
*/
|
|
@@ -3755,8 +3792,16 @@ declare module "sap/ushell/services/CrossApplicationNavigation" {
|
|
|
3755
3792
|
* of the currently running app (but still in scope of the current Fiori launchpad) or to create links to
|
|
3756
3793
|
* such external targets.
|
|
3757
3794
|
*
|
|
3758
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
3759
|
-
*
|
|
3795
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
3796
|
+
*
|
|
3797
|
+
* ```javascript
|
|
3798
|
+
*
|
|
3799
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
3800
|
+
* const CrossApplicationNavigation = await Container.getServiceAsync("CrossApplicationNavigation");
|
|
3801
|
+
* // do something with the CrossApplicationNavigation service
|
|
3802
|
+
* });
|
|
3803
|
+
* ```
|
|
3804
|
+
*
|
|
3760
3805
|
*
|
|
3761
3806
|
* The CrossApplicationNavigation service currently provides platform independent functionality.
|
|
3762
3807
|
*
|
|
@@ -3765,9 +3810,7 @@ declare module "sap/ushell/services/CrossApplicationNavigation" {
|
|
|
3765
3810
|
* Usage:
|
|
3766
3811
|
* ```javascript
|
|
3767
3812
|
*
|
|
3768
|
-
*
|
|
3769
|
-
*
|
|
3770
|
-
* oService.hrefForExternalAsync({
|
|
3813
|
+
* CrossApplicationNavigation.hrefForExternalAsync({
|
|
3771
3814
|
* target : {
|
|
3772
3815
|
* semanticObject: "Product",
|
|
3773
3816
|
* action: "display"
|
|
@@ -3778,7 +3821,6 @@ declare module "sap/ushell/services/CrossApplicationNavigation" {
|
|
|
3778
3821
|
* }).then( function(sHref) {
|
|
3779
3822
|
* // Place sHref somewhere in the DOM
|
|
3780
3823
|
* });
|
|
3781
|
-
* });
|
|
3782
3824
|
* ```
|
|
3783
3825
|
*
|
|
3784
3826
|
*
|
|
@@ -4427,12 +4469,10 @@ declare module "sap/ushell/services/CrossApplicationNavigation" {
|
|
|
4427
4469
|
* to use in link tags:
|
|
4428
4470
|
* ```javascript
|
|
4429
4471
|
*
|
|
4430
|
-
*
|
|
4431
|
-
*
|
|
4432
|
-
*
|
|
4433
|
-
*
|
|
4434
|
-
* // do something with the resolved sExternalHref.
|
|
4435
|
-
* });
|
|
4472
|
+
* CrossApplicationNavigation.hrefForExternalAsync({
|
|
4473
|
+
* target: { shellHash: oLink.intent }
|
|
4474
|
+
* }, that.oComponent).then( function (sExternalHref) {
|
|
4475
|
+
* // do something with the resolved sExternalHref.
|
|
4436
4476
|
* });
|
|
4437
4477
|
* ```
|
|
4438
4478
|
*
|
|
@@ -4620,7 +4660,7 @@ declare module "sap/ushell/services/CrossApplicationNavigation" {
|
|
|
4620
4660
|
* target: { shellHash: "SalesOrder-approve?SOId=1234" }
|
|
4621
4661
|
* ])
|
|
4622
4662
|
* .done(function(aResponses) {
|
|
4623
|
-
* if (
|
|
4663
|
+
* if (aResponses[0].supported===true){
|
|
4624
4664
|
* // enable link
|
|
4625
4665
|
* }
|
|
4626
4666
|
* else {
|
|
@@ -4816,8 +4856,16 @@ declare module "sap/ushell/services/EndUserFeedback" {
|
|
|
4816
4856
|
* The Unified Shell's end user feedback service. This service is deprecated and does nothing. End user
|
|
4817
4857
|
* feedback functionality is not part of the ushell library.
|
|
4818
4858
|
*
|
|
4819
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
4820
|
-
*
|
|
4859
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
4860
|
+
*
|
|
4861
|
+
* ```javascript
|
|
4862
|
+
*
|
|
4863
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
4864
|
+
* const EndUserFeedback = await Container.getServiceAsync("EndUserFeedback");
|
|
4865
|
+
* // do something with the EndUserFeedback service
|
|
4866
|
+
* });
|
|
4867
|
+
* ```
|
|
4868
|
+
*
|
|
4821
4869
|
*
|
|
4822
4870
|
* @since 1.25.1
|
|
4823
4871
|
* @deprecated (since 1.93)
|
|
@@ -4857,30 +4905,194 @@ declare module "sap/ushell/services/EndUserFeedback" {
|
|
|
4857
4905
|
}
|
|
4858
4906
|
|
|
4859
4907
|
declare module "sap/ushell/services/Extension" {
|
|
4908
|
+
import { Properties } from "sap/ushell/ui/shell/ShellHeadItem";
|
|
4909
|
+
|
|
4910
|
+
import Item from "sap/ushell/services/Extension/Item";
|
|
4911
|
+
|
|
4912
|
+
/**
|
|
4913
|
+
* The Unified Shell's Extension service. Allows adding extensions on the user's home page.
|
|
4914
|
+
*
|
|
4915
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
4916
|
+
*
|
|
4917
|
+
* ```javascript
|
|
4918
|
+
*
|
|
4919
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
4920
|
+
* const Extension = await Container.getServiceAsync("Extension");
|
|
4921
|
+
* // do something with the Extension service
|
|
4922
|
+
* });
|
|
4923
|
+
* ```
|
|
4924
|
+
*
|
|
4925
|
+
*
|
|
4926
|
+
* This service is available in any FLP context (native, iframe, ...).
|
|
4927
|
+
*
|
|
4928
|
+
*
|
|
4929
|
+
* All extension items and extension areas are instantiated as invisible. You have to call .show<...> to
|
|
4930
|
+
* make them visible.
|
|
4931
|
+
*
|
|
4932
|
+
* @since 1.120.0
|
|
4933
|
+
*/
|
|
4934
|
+
export default class Extension extends sap.ushell.services.Service {
|
|
4935
|
+
/**
|
|
4936
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4937
|
+
*/
|
|
4938
|
+
protected constructor();
|
|
4939
|
+
|
|
4940
|
+
/**
|
|
4941
|
+
* Creates a header item in the shell header. **Restrictions:**
|
|
4942
|
+
* - The control properties are only allowed to contain primitive properties and event handlers. Aggregations,
|
|
4943
|
+
* controls and types with prototypes are not allowed!
|
|
4944
|
+
* - The event handlers are not bound to the actual control and do not receive the event arguments.
|
|
4945
|
+
*
|
|
4946
|
+
* @since 1.120.0
|
|
4947
|
+
*
|
|
4948
|
+
* @returns The newly created header item.
|
|
4949
|
+
*/
|
|
4950
|
+
createHeaderItem(
|
|
4951
|
+
/**
|
|
4952
|
+
* The properties that will be passed to the created control.
|
|
4953
|
+
*/
|
|
4954
|
+
controlProperties: Properties,
|
|
4955
|
+
/**
|
|
4956
|
+
* Additional parameters.
|
|
4957
|
+
*/
|
|
4958
|
+
parameters?: {
|
|
4959
|
+
/**
|
|
4960
|
+
* Possible values are `begin` and `end`.
|
|
4961
|
+
*/
|
|
4962
|
+
position?: string;
|
|
4963
|
+
}
|
|
4964
|
+
): Promise<Item>;
|
|
4965
|
+
/**
|
|
4966
|
+
* Creates a user action in the user action menu.
|
|
4967
|
+
* **Restrictions:**
|
|
4968
|
+
* - The control properties are only allowed to contain primitive properties and event handlers. Aggregations,
|
|
4969
|
+
* controls and types with prototypes are not allowed!
|
|
4970
|
+
* - The event handlers are not bound to the actual control and do not receive the event arguments.
|
|
4971
|
+
*
|
|
4972
|
+
* @since 1.120.0
|
|
4973
|
+
*
|
|
4974
|
+
* @returns The newly created user action.
|
|
4975
|
+
*/
|
|
4976
|
+
createUserAction(
|
|
4977
|
+
/**
|
|
4978
|
+
* The properties that will be passed to the created control.
|
|
4979
|
+
*/
|
|
4980
|
+
controlProperties: object,
|
|
4981
|
+
/**
|
|
4982
|
+
* Additional parameters.
|
|
4983
|
+
*/
|
|
4984
|
+
parameters?: {
|
|
4985
|
+
/**
|
|
4986
|
+
* Defines the `controlType`.
|
|
4987
|
+
*/
|
|
4988
|
+
controlType?: string;
|
|
4989
|
+
}
|
|
4990
|
+
): Promise<Item>;
|
|
4991
|
+
}
|
|
4992
|
+
}
|
|
4993
|
+
|
|
4994
|
+
declare module "sap/ushell/services/Extension/Item" {
|
|
4995
|
+
/**
|
|
4996
|
+
* Item wrapping an item positioned in an extension point. To be instantiated by {@link sap.ushell.services.Extension}.
|
|
4997
|
+
*
|
|
4998
|
+
* @since 1.120.0
|
|
4999
|
+
*/
|
|
5000
|
+
export default class Item {
|
|
5001
|
+
/**
|
|
5002
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
5003
|
+
*/
|
|
5004
|
+
protected constructor();
|
|
5005
|
+
|
|
5006
|
+
/**
|
|
5007
|
+
* Destroys the item and it's related content.
|
|
5008
|
+
*
|
|
5009
|
+
* @since 1.120.0
|
|
5010
|
+
*
|
|
5011
|
+
* @returns Resolves once the item was destroyed.
|
|
5012
|
+
*/
|
|
5013
|
+
destroy(): Promise<any>;
|
|
5014
|
+
/**
|
|
5015
|
+
* Shows the item for all applications. Does not change the visibility of the item for the launchpad "home".
|
|
5016
|
+
*
|
|
5017
|
+
* @since 1.120.0
|
|
5018
|
+
*
|
|
5019
|
+
* @returns Reference to `this` for method chaining.
|
|
5020
|
+
*/
|
|
5021
|
+
hideForAllApps(): this;
|
|
5022
|
+
/**
|
|
5023
|
+
* Hides the item for the current application. Note: The item will not be hidden if it was set visible for
|
|
5024
|
+
* all apps {@link #showForAllApps}
|
|
5025
|
+
*
|
|
5026
|
+
* @since 1.120.0
|
|
5027
|
+
*
|
|
5028
|
+
* @returns Reference to `this` for method chaining.
|
|
5029
|
+
*/
|
|
5030
|
+
hideForCurrentApp(): this;
|
|
5031
|
+
/**
|
|
5032
|
+
* Hides the item for launchpad "home". Does not change the visibility of the item within applications.
|
|
5033
|
+
*
|
|
5034
|
+
* @since 1.120.0
|
|
5035
|
+
*
|
|
5036
|
+
* @returns Reference to `this` for method chaining.
|
|
5037
|
+
*/
|
|
5038
|
+
hideOnHome(): this;
|
|
5039
|
+
/**
|
|
5040
|
+
* Shows the item for all applications. Does not change the visibility of the item for the launchpad "home".
|
|
5041
|
+
*
|
|
5042
|
+
* @since 1.120.0
|
|
5043
|
+
*
|
|
5044
|
+
* @returns Reference to `this` for method chaining.
|
|
5045
|
+
*/
|
|
5046
|
+
showForAllApps(): this;
|
|
5047
|
+
/**
|
|
5048
|
+
* Shows the item for the current application. The item will be hidden after the user navigates away from
|
|
5049
|
+
* this application. The item will not be added again if the user navigates back to the application.
|
|
5050
|
+
*
|
|
5051
|
+
* @since 1.120.0
|
|
5052
|
+
*
|
|
5053
|
+
* @returns Reference to `this` for method chaining.
|
|
5054
|
+
*/
|
|
5055
|
+
showForCurrentApp(): this;
|
|
5056
|
+
/**
|
|
5057
|
+
* Shows the item for launchpad "home". Does not change the visibility of the item within applications.
|
|
5058
|
+
*
|
|
5059
|
+
* @since 1.120.0
|
|
5060
|
+
*
|
|
5061
|
+
* @returns Reference to `this` for method chaining.
|
|
5062
|
+
*/
|
|
5063
|
+
showOnHome(): this;
|
|
5064
|
+
}
|
|
5065
|
+
}
|
|
5066
|
+
|
|
5067
|
+
declare module "sap/ushell/services/FrameBoundExtension" {
|
|
4860
5068
|
import Control from "sap/ui/core/Control";
|
|
4861
5069
|
|
|
4862
|
-
import Footer from "sap/ushell/services/
|
|
5070
|
+
import Footer from "sap/ushell/services/FrameBoundExtension/Footer";
|
|
4863
5071
|
|
|
4864
|
-
import
|
|
5072
|
+
import { Properties } from "sap/ushell/ui/shell/ShellHeadItem";
|
|
4865
5073
|
|
|
4866
|
-
import
|
|
5074
|
+
import Item from "sap/ushell/services/FrameBoundExtension/Item";
|
|
4867
5075
|
|
|
4868
|
-
import
|
|
5076
|
+
import SidePane from "sap/ushell/services/FrameBoundExtension/SidePane";
|
|
5077
|
+
|
|
5078
|
+
import ToolArea from "sap/ushell/services/FrameBoundExtension/ToolArea";
|
|
4869
5079
|
|
|
4870
5080
|
/**
|
|
4871
5081
|
* The Unified Shell's Extension service. Allows adding extensions on the user's home page.
|
|
4872
5082
|
*
|
|
4873
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("
|
|
5083
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("FrameBoundExtension")`.
|
|
4874
5084
|
* For details, see {@link sap.ushell.Container#getServiceAsync}.
|
|
4875
5085
|
*
|
|
5086
|
+
* **Restriction:** This Service does not work when called from within a iframe. The calling function
|
|
5087
|
+
* has to be in the 'same frame' as the launchpad itself.
|
|
5088
|
+
*
|
|
4876
5089
|
*
|
|
4877
5090
|
* All extension items and extension areas are instantiated as invisible. You have to call .show<...> to
|
|
4878
5091
|
* make them visible.
|
|
4879
5092
|
*
|
|
4880
|
-
* @since 1.
|
|
4881
|
-
* @experimental (since 1.120.0) - Restriction: API calls might be ignored for apps running in an iframe
|
|
5093
|
+
* @since 1.124.0
|
|
4882
5094
|
*/
|
|
4883
|
-
export default class
|
|
5095
|
+
export default class FrameBoundExtension extends sap.ushell.services.Service {
|
|
4884
5096
|
/**
|
|
4885
5097
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4886
5098
|
*/
|
|
@@ -4888,10 +5100,10 @@ declare module "sap/ushell/services/Extension" {
|
|
|
4888
5100
|
|
|
4889
5101
|
/**
|
|
4890
5102
|
* Adds an entry to the user settings dialog box including the UI control that appears when the user clicks
|
|
4891
|
-
* the new entry, and handling of user settings actions such as SAVE and CANCEL. **Restriction:**
|
|
4892
|
-
*
|
|
5103
|
+
* the new entry, and handling of user settings actions such as SAVE and CANCEL. **Restriction:** NOT
|
|
5104
|
+
* available for apps running in an iframe
|
|
4893
5105
|
*
|
|
4894
|
-
* @since 1.
|
|
5106
|
+
* @since 1.124.0
|
|
4895
5107
|
*
|
|
4896
5108
|
* @returns Resolves once the settings entry was added.
|
|
4897
5109
|
*/
|
|
@@ -4938,9 +5150,9 @@ declare module "sap/ushell/services/Extension" {
|
|
|
4938
5150
|
* Creates a new footer which is positioned below the launchpad content.
|
|
4939
5151
|
*
|
|
4940
5152
|
* **Note:** Only one footer is displayed at once. Any new footer will replace the previous one **Restriction:**
|
|
4941
|
-
*
|
|
5153
|
+
* NOT available for apps running in an iframe
|
|
4942
5154
|
*
|
|
4943
|
-
* @since 1.
|
|
5155
|
+
* @since 1.124.0
|
|
4944
5156
|
*
|
|
4945
5157
|
* @returns The newly created footer.
|
|
4946
5158
|
*/
|
|
@@ -4962,7 +5174,7 @@ declare module "sap/ushell/services/Extension" {
|
|
|
4962
5174
|
/**
|
|
4963
5175
|
* Creates a header item in the shell header.
|
|
4964
5176
|
*
|
|
4965
|
-
* @since 1.
|
|
5177
|
+
* @since 1.124.0
|
|
4966
5178
|
*
|
|
4967
5179
|
* @returns The newly created header item.
|
|
4968
5180
|
*/
|
|
@@ -4970,7 +5182,7 @@ declare module "sap/ushell/services/Extension" {
|
|
|
4970
5182
|
/**
|
|
4971
5183
|
* The properties that will be passed to the created control.
|
|
4972
5184
|
*/
|
|
4973
|
-
controlProperties:
|
|
5185
|
+
controlProperties: Properties,
|
|
4974
5186
|
/**
|
|
4975
5187
|
* Additional parameters.
|
|
4976
5188
|
*/
|
|
@@ -4984,10 +5196,10 @@ declare module "sap/ushell/services/Extension" {
|
|
|
4984
5196
|
/**
|
|
4985
5197
|
* Creates a new sub header which is positioned below the header.
|
|
4986
5198
|
*
|
|
4987
|
-
* **Note:** Only one sub header is displayed at once **Restriction:**
|
|
5199
|
+
* **Note:** Only one sub header is displayed at once **Restriction:** NOT available for apps
|
|
4988
5200
|
* running in an iframe
|
|
4989
5201
|
*
|
|
4990
|
-
* @since 1.
|
|
5202
|
+
* @since 1.124.0
|
|
4991
5203
|
*
|
|
4992
5204
|
* @returns The newly created sub header.
|
|
4993
5205
|
*/
|
|
@@ -5009,7 +5221,7 @@ declare module "sap/ushell/services/Extension" {
|
|
|
5009
5221
|
/**
|
|
5010
5222
|
* Creates a user action in the user action menu.
|
|
5011
5223
|
*
|
|
5012
|
-
* @since 1.
|
|
5224
|
+
* @since 1.124.0
|
|
5013
5225
|
*
|
|
5014
5226
|
* @returns The newly created user action.
|
|
5015
5227
|
*/
|
|
@@ -5030,18 +5242,18 @@ declare module "sap/ushell/services/Extension" {
|
|
|
5030
5242
|
): Promise<Item>;
|
|
5031
5243
|
/**
|
|
5032
5244
|
* Returns the API for the SidePane which is located next to the launchpad content. **Restriction:**
|
|
5033
|
-
*
|
|
5245
|
+
* NOT available for apps running in an iframe
|
|
5034
5246
|
*
|
|
5035
|
-
* @since 1.
|
|
5247
|
+
* @since 1.124.0
|
|
5036
5248
|
*
|
|
5037
5249
|
* @returns The SidePane.
|
|
5038
5250
|
*/
|
|
5039
5251
|
getSidePane(): Promise<SidePane>;
|
|
5040
5252
|
/**
|
|
5041
5253
|
* Returns the API for the ToolArea which is located next to the launchpad content. **Restriction:**
|
|
5042
|
-
*
|
|
5254
|
+
* NOT available for apps running in an iframe
|
|
5043
5255
|
*
|
|
5044
|
-
* @since 1.
|
|
5256
|
+
* @since 1.124.0
|
|
5045
5257
|
*
|
|
5046
5258
|
* @returns The ToolArea.
|
|
5047
5259
|
*/
|
|
@@ -5049,13 +5261,16 @@ declare module "sap/ushell/services/Extension" {
|
|
|
5049
5261
|
}
|
|
5050
5262
|
}
|
|
5051
5263
|
|
|
5052
|
-
declare module "sap/ushell/services/
|
|
5264
|
+
declare module "sap/ushell/services/FrameBoundExtension/Footer" {
|
|
5265
|
+
import Control from "sap/ui/core/Control";
|
|
5266
|
+
|
|
5053
5267
|
/**
|
|
5054
|
-
* The footer extension point is positioned below the launchpad content. To be instantiated by {@link sap.ushell.services.
|
|
5055
|
-
* **Restriction:** Might be ignored for apps running in an iframe
|
|
5268
|
+
* The footer extension point is positioned below the launchpad content. To be instantiated by {@link sap.ushell.services.FrameBoundExtension}.
|
|
5056
5269
|
*
|
|
5057
|
-
*
|
|
5058
|
-
*
|
|
5270
|
+
* **Restriction:** Does not work when called from within a iframe. The calling function has to be in
|
|
5271
|
+
* the 'same frame' as the launchpad itself.
|
|
5272
|
+
*
|
|
5273
|
+
* @since 1.124.0
|
|
5059
5274
|
*/
|
|
5060
5275
|
export default class Footer {
|
|
5061
5276
|
/**
|
|
@@ -5066,20 +5281,32 @@ declare module "sap/ushell/services/Extension/Footer" {
|
|
|
5066
5281
|
/**
|
|
5067
5282
|
* Destroys the footer.
|
|
5068
5283
|
*
|
|
5069
|
-
* @since 1.
|
|
5284
|
+
* @since 1.124.0
|
|
5070
5285
|
*
|
|
5071
5286
|
* @returns Resolves once the footer was destroyed.
|
|
5072
5287
|
*/
|
|
5073
5288
|
destroy(): Promise<any>;
|
|
5289
|
+
/**
|
|
5290
|
+
* Returns the related control instance.
|
|
5291
|
+
*
|
|
5292
|
+
* @since 1.124.0
|
|
5293
|
+
*
|
|
5294
|
+
* @returns The control.
|
|
5295
|
+
*/
|
|
5296
|
+
getControl(): Promise<Control>;
|
|
5074
5297
|
}
|
|
5075
5298
|
}
|
|
5076
5299
|
|
|
5077
|
-
declare module "sap/ushell/services/
|
|
5300
|
+
declare module "sap/ushell/services/FrameBoundExtension/Item" {
|
|
5301
|
+
import Control from "sap/ui/core/Control";
|
|
5302
|
+
|
|
5078
5303
|
/**
|
|
5079
|
-
* Item wrapping an item positioned in an extension point. To be instantiated by {@link sap.ushell.services.
|
|
5304
|
+
* Item wrapping an item positioned in an extension point. To be instantiated by {@link sap.ushell.services.FrameBoundExtension}.
|
|
5080
5305
|
*
|
|
5081
|
-
*
|
|
5082
|
-
*
|
|
5306
|
+
* **Restriction:** Does not work when called from within a iframe. The calling function has to be in
|
|
5307
|
+
* the 'same frame' as the launchpad itself.
|
|
5308
|
+
*
|
|
5309
|
+
* @since 1.124.0
|
|
5083
5310
|
*/
|
|
5084
5311
|
export default class Item {
|
|
5085
5312
|
/**
|
|
@@ -5090,15 +5317,23 @@ declare module "sap/ushell/services/Extension/Item" {
|
|
|
5090
5317
|
/**
|
|
5091
5318
|
* Destroys the item and it's related content.
|
|
5092
5319
|
*
|
|
5093
|
-
* @since 1.
|
|
5320
|
+
* @since 1.124.0
|
|
5094
5321
|
*
|
|
5095
5322
|
* @returns Resolves once the item was destroyed.
|
|
5096
5323
|
*/
|
|
5097
5324
|
destroy(): Promise<any>;
|
|
5325
|
+
/**
|
|
5326
|
+
* Returns the related control instance.
|
|
5327
|
+
*
|
|
5328
|
+
* @since 1.124.0
|
|
5329
|
+
*
|
|
5330
|
+
* @returns The control.
|
|
5331
|
+
*/
|
|
5332
|
+
getControl(): Promise<Control>;
|
|
5098
5333
|
/**
|
|
5099
5334
|
* Shows the item for all applications. Does not change the visibility of the item for the launchpad "home".
|
|
5100
5335
|
*
|
|
5101
|
-
* @since 1.
|
|
5336
|
+
* @since 1.124.0
|
|
5102
5337
|
*
|
|
5103
5338
|
* @returns Reference to `this` for method chaining.
|
|
5104
5339
|
*/
|
|
@@ -5107,7 +5342,7 @@ declare module "sap/ushell/services/Extension/Item" {
|
|
|
5107
5342
|
* Hides the item for the current application. Note: The item will not be hidden if it was set visible for
|
|
5108
5343
|
* all apps {@link #showForAllApps}
|
|
5109
5344
|
*
|
|
5110
|
-
* @since 1.
|
|
5345
|
+
* @since 1.124.0
|
|
5111
5346
|
*
|
|
5112
5347
|
* @returns Reference to `this` for method chaining.
|
|
5113
5348
|
*/
|
|
@@ -5115,7 +5350,7 @@ declare module "sap/ushell/services/Extension/Item" {
|
|
|
5115
5350
|
/**
|
|
5116
5351
|
* Hides the item for launchpad "home". Does not change the visibility of the item within applications.
|
|
5117
5352
|
*
|
|
5118
|
-
* @since 1.
|
|
5353
|
+
* @since 1.124.0
|
|
5119
5354
|
*
|
|
5120
5355
|
* @returns Reference to `this` for method chaining.
|
|
5121
5356
|
*/
|
|
@@ -5123,7 +5358,7 @@ declare module "sap/ushell/services/Extension/Item" {
|
|
|
5123
5358
|
/**
|
|
5124
5359
|
* Shows the item for all applications. Does not change the visibility of the item for the launchpad "home".
|
|
5125
5360
|
*
|
|
5126
|
-
* @since 1.
|
|
5361
|
+
* @since 1.124.0
|
|
5127
5362
|
*
|
|
5128
5363
|
* @returns Reference to `this` for method chaining.
|
|
5129
5364
|
*/
|
|
@@ -5132,7 +5367,7 @@ declare module "sap/ushell/services/Extension/Item" {
|
|
|
5132
5367
|
* Shows the item for the current application. The item will be hidden after the user navigates away from
|
|
5133
5368
|
* this application. The item will not be added again if the user navigates back to the application.
|
|
5134
5369
|
*
|
|
5135
|
-
* @since 1.
|
|
5370
|
+
* @since 1.124.0
|
|
5136
5371
|
*
|
|
5137
5372
|
* @returns Reference to `this` for method chaining.
|
|
5138
5373
|
*/
|
|
@@ -5140,7 +5375,7 @@ declare module "sap/ushell/services/Extension/Item" {
|
|
|
5140
5375
|
/**
|
|
5141
5376
|
* Shows the item for launchpad "home". Does not change the visibility of the item within applications.
|
|
5142
5377
|
*
|
|
5143
|
-
* @since 1.
|
|
5378
|
+
* @since 1.124.0
|
|
5144
5379
|
*
|
|
5145
5380
|
* @returns Reference to `this` for method chaining.
|
|
5146
5381
|
*/
|
|
@@ -5148,15 +5383,16 @@ declare module "sap/ushell/services/Extension/Item" {
|
|
|
5148
5383
|
}
|
|
5149
5384
|
}
|
|
5150
5385
|
|
|
5151
|
-
declare module "sap/ushell/services/
|
|
5152
|
-
import Item from "sap/ushell/services/
|
|
5386
|
+
declare module "sap/ushell/services/FrameBoundExtension/SidePane" {
|
|
5387
|
+
import Item from "sap/ushell/services/FrameBoundExtension/Item";
|
|
5153
5388
|
|
|
5154
5389
|
/**
|
|
5155
|
-
* The side pane extension point is positioned next the launchpad content. To be instantiated by {@link sap.ushell.services.
|
|
5156
|
-
* **Restriction:** Might be ignored for apps running in an iframe
|
|
5390
|
+
* The side pane extension point is positioned next the launchpad content. To be instantiated by {@link sap.ushell.services.FrameBoundExtension}.
|
|
5157
5391
|
*
|
|
5158
|
-
*
|
|
5159
|
-
*
|
|
5392
|
+
* **Restriction:** Does not work when called from within a iframe. The calling function has to be in
|
|
5393
|
+
* the 'same frame' as the launchpad itself.
|
|
5394
|
+
*
|
|
5395
|
+
* @since 1.124.0
|
|
5160
5396
|
*/
|
|
5161
5397
|
export default class SidePane {
|
|
5162
5398
|
/**
|
|
@@ -5167,7 +5403,7 @@ declare module "sap/ushell/services/Extension/SidePane" {
|
|
|
5167
5403
|
/**
|
|
5168
5404
|
* Creates an item in the side pane.
|
|
5169
5405
|
*
|
|
5170
|
-
* @since 1.
|
|
5406
|
+
* @since 1.124.0
|
|
5171
5407
|
*
|
|
5172
5408
|
* @returns The newly created item.
|
|
5173
5409
|
*/
|
|
@@ -5190,7 +5426,7 @@ declare module "sap/ushell/services/Extension/SidePane" {
|
|
|
5190
5426
|
* Shows the side pane for all applications. Does not change the visibility of the side pane for the launchpad
|
|
5191
5427
|
* "home".
|
|
5192
5428
|
*
|
|
5193
|
-
* @since 1.
|
|
5429
|
+
* @since 1.124.0
|
|
5194
5430
|
*
|
|
5195
5431
|
* @returns Reference to `this` for method chaining.
|
|
5196
5432
|
*/
|
|
@@ -5198,7 +5434,7 @@ declare module "sap/ushell/services/Extension/SidePane" {
|
|
|
5198
5434
|
/**
|
|
5199
5435
|
* Hides the area for launchpad "home". Does not change the visibility of the area within applications.
|
|
5200
5436
|
*
|
|
5201
|
-
* @since 1.
|
|
5437
|
+
* @since 1.124.0
|
|
5202
5438
|
*
|
|
5203
5439
|
* @returns Reference to `this` for method chaining.
|
|
5204
5440
|
*/
|
|
@@ -5207,7 +5443,7 @@ declare module "sap/ushell/services/Extension/SidePane" {
|
|
|
5207
5443
|
* Shows the side pane for all applications. Does not change the visibility of the side pane for the launchpad
|
|
5208
5444
|
* "home".
|
|
5209
5445
|
*
|
|
5210
|
-
* @since 1.
|
|
5446
|
+
* @since 1.124.0
|
|
5211
5447
|
*
|
|
5212
5448
|
* @returns Reference to `this` for method chaining.
|
|
5213
5449
|
*/
|
|
@@ -5215,7 +5451,7 @@ declare module "sap/ushell/services/Extension/SidePane" {
|
|
|
5215
5451
|
/**
|
|
5216
5452
|
* Shows the side pane for launchpad "home". Does not change the visibility of the side pane within applications.
|
|
5217
5453
|
*
|
|
5218
|
-
* @since 1.
|
|
5454
|
+
* @since 1.124.0
|
|
5219
5455
|
*
|
|
5220
5456
|
* @returns Reference to `this` for method chaining.
|
|
5221
5457
|
*/
|
|
@@ -5223,15 +5459,16 @@ declare module "sap/ushell/services/Extension/SidePane" {
|
|
|
5223
5459
|
}
|
|
5224
5460
|
}
|
|
5225
5461
|
|
|
5226
|
-
declare module "sap/ushell/services/
|
|
5227
|
-
import Item from "sap/ushell/services/
|
|
5462
|
+
declare module "sap/ushell/services/FrameBoundExtension/ToolArea" {
|
|
5463
|
+
import Item from "sap/ushell/services/FrameBoundExtension/Item";
|
|
5228
5464
|
|
|
5229
5465
|
/**
|
|
5230
|
-
* The tool area extension point is positioned next the launchpad content. To be instantiated by {@link sap.ushell.services.
|
|
5231
|
-
* **Restriction:** Might be ignored for apps running in an iframe
|
|
5466
|
+
* The tool area extension point is positioned next the launchpad content. To be instantiated by {@link sap.ushell.services.FrameBoundExtension}.
|
|
5232
5467
|
*
|
|
5233
|
-
*
|
|
5234
|
-
*
|
|
5468
|
+
* **Restriction:** Does not work when called from within a iframe. The calling function has to be in
|
|
5469
|
+
* the 'same frame' as the launchpad itself.
|
|
5470
|
+
*
|
|
5471
|
+
* @since 1.124.0
|
|
5235
5472
|
*/
|
|
5236
5473
|
export default class ToolArea {
|
|
5237
5474
|
/**
|
|
@@ -5242,7 +5479,7 @@ declare module "sap/ushell/services/Extension/ToolArea" {
|
|
|
5242
5479
|
/**
|
|
5243
5480
|
* Creates an item in the tool area.
|
|
5244
5481
|
*
|
|
5245
|
-
* @since 1.
|
|
5482
|
+
* @since 1.124.0
|
|
5246
5483
|
*
|
|
5247
5484
|
* @returns The newly created item.
|
|
5248
5485
|
*/
|
|
@@ -5256,7 +5493,7 @@ declare module "sap/ushell/services/Extension/ToolArea" {
|
|
|
5256
5493
|
* Shows the tool area for all applications. Does not change the visibility of the tool area for the launchpad
|
|
5257
5494
|
* "home".
|
|
5258
5495
|
*
|
|
5259
|
-
* @since 1.
|
|
5496
|
+
* @since 1.124.0
|
|
5260
5497
|
*
|
|
5261
5498
|
* @returns Reference to `this` for method chaining.
|
|
5262
5499
|
*/
|
|
@@ -5264,7 +5501,7 @@ declare module "sap/ushell/services/Extension/ToolArea" {
|
|
|
5264
5501
|
/**
|
|
5265
5502
|
* Hides the tool area for launchpad "home". Does not change the visibility of the tool area within applications.
|
|
5266
5503
|
*
|
|
5267
|
-
* @since 1.
|
|
5504
|
+
* @since 1.124.0
|
|
5268
5505
|
*
|
|
5269
5506
|
* @returns Reference to `this` for method chaining.
|
|
5270
5507
|
*/
|
|
@@ -5273,7 +5510,7 @@ declare module "sap/ushell/services/Extension/ToolArea" {
|
|
|
5273
5510
|
* Shows the tool area for all applications. Does not change the visibility of the tool area for the launchpad
|
|
5274
5511
|
* "home".
|
|
5275
5512
|
*
|
|
5276
|
-
* @since 1.
|
|
5513
|
+
* @since 1.124.0
|
|
5277
5514
|
*
|
|
5278
5515
|
* @returns Reference to `this` for method chaining.
|
|
5279
5516
|
*/
|
|
@@ -5281,7 +5518,7 @@ declare module "sap/ushell/services/Extension/ToolArea" {
|
|
|
5281
5518
|
/**
|
|
5282
5519
|
* Shows the tool area for launchpad "home". Does not change the visibility of the tool area within applications.
|
|
5283
5520
|
*
|
|
5284
|
-
* @since 1.
|
|
5521
|
+
* @since 1.124.0
|
|
5285
5522
|
*
|
|
5286
5523
|
* @returns Reference to `this` for method chaining.
|
|
5287
5524
|
*/
|
|
@@ -5293,8 +5530,16 @@ declare module "sap/ushell/services/LaunchPage" {
|
|
|
5293
5530
|
/**
|
|
5294
5531
|
* A service for handling groups, tiles and catalogs.
|
|
5295
5532
|
*
|
|
5296
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
5297
|
-
*
|
|
5533
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
5534
|
+
*
|
|
5535
|
+
* ```javascript
|
|
5536
|
+
*
|
|
5537
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
5538
|
+
* const LaunchPage = await Container.getServiceAsync("LaunchPage");
|
|
5539
|
+
* // do something with the LaunchPage service
|
|
5540
|
+
* });
|
|
5541
|
+
* ```
|
|
5542
|
+
*
|
|
5298
5543
|
*
|
|
5299
5544
|
* The functions that return the main objects are getGroups, getGroupTitle, getCatalogs and getCatalogTiles.
|
|
5300
5545
|
* Since the implementation (i.e. adapter) is platform specific, do not call or access properties and functions
|
|
@@ -6064,8 +6309,16 @@ declare module "sap/ushell/services/Message" {
|
|
|
6064
6309
|
/**
|
|
6065
6310
|
* Message service.
|
|
6066
6311
|
*
|
|
6067
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
6068
|
-
*
|
|
6312
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
6313
|
+
*
|
|
6314
|
+
* ```javascript
|
|
6315
|
+
*
|
|
6316
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
6317
|
+
* const Message = await Container.getServiceAsync("Message");
|
|
6318
|
+
* // do something with the Message service
|
|
6319
|
+
* });
|
|
6320
|
+
* ```
|
|
6321
|
+
*
|
|
6069
6322
|
*
|
|
6070
6323
|
* @since 1.16.0
|
|
6071
6324
|
* @deprecated (since 1.120)
|
|
@@ -6184,8 +6437,16 @@ declare module "sap/ushell/services/Navigation" {
|
|
|
6184
6437
|
* The Unified Shell's Navigation service. Allows navigating to "external" targets outside of the currently
|
|
6185
6438
|
* running app (but still in scope of the current Fiori launchpad) or to create links to such external targets.
|
|
6186
6439
|
*
|
|
6187
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
6188
|
-
*
|
|
6440
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
6441
|
+
*
|
|
6442
|
+
* ```javascript
|
|
6443
|
+
*
|
|
6444
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
6445
|
+
* const Navigation = await Container.getServiceAsync("Navigation");
|
|
6446
|
+
* // do something with the Navigation service
|
|
6447
|
+
* });
|
|
6448
|
+
* ```
|
|
6449
|
+
*
|
|
6189
6450
|
*
|
|
6190
6451
|
* The Navigation service currently provides platform independent functionality.
|
|
6191
6452
|
*
|
|
@@ -6194,19 +6455,16 @@ declare module "sap/ushell/services/Navigation" {
|
|
|
6194
6455
|
* Usage:
|
|
6195
6456
|
* ```javascript
|
|
6196
6457
|
*
|
|
6197
|
-
*
|
|
6198
|
-
*
|
|
6199
|
-
*
|
|
6200
|
-
*
|
|
6201
|
-
*
|
|
6202
|
-
*
|
|
6203
|
-
*
|
|
6204
|
-
*
|
|
6205
|
-
*
|
|
6206
|
-
*
|
|
6207
|
-
* }, oComponent);
|
|
6208
|
-
* // do something with the resolved sHref.
|
|
6209
|
-
* });
|
|
6458
|
+
* const sHref = await Navigation.getHref({
|
|
6459
|
+
* target : {
|
|
6460
|
+
* semanticObject: "Product",
|
|
6461
|
+
* action: "display"
|
|
6462
|
+
* },
|
|
6463
|
+
* params: {
|
|
6464
|
+
* "ProductID": "102343333"
|
|
6465
|
+
* }
|
|
6466
|
+
* }, oComponent);
|
|
6467
|
+
* // do something with the resolved sHref.
|
|
6210
6468
|
* ```
|
|
6211
6469
|
*
|
|
6212
6470
|
*
|
|
@@ -6264,13 +6522,10 @@ declare module "sap/ushell/services/Navigation" {
|
|
|
6264
6522
|
*
|
|
6265
6523
|
* ```javascript
|
|
6266
6524
|
*
|
|
6267
|
-
*
|
|
6268
|
-
*
|
|
6269
|
-
*
|
|
6270
|
-
*
|
|
6271
|
-
* }, oComponent);
|
|
6272
|
-
* // do something with the resolved sHref.
|
|
6273
|
-
* });
|
|
6525
|
+
* const sHref = await Navigation.getHref({
|
|
6526
|
+
* target: { shellHash: oLink.intent }
|
|
6527
|
+
* }, oComponent);
|
|
6528
|
+
* // do something with the resolved sHref.
|
|
6274
6529
|
* ```
|
|
6275
6530
|
*
|
|
6276
6531
|
*
|
|
@@ -6690,14 +6945,30 @@ declare module "sap/ushell/services/Navigation" {
|
|
|
6690
6945
|
* @since 1.121.0
|
|
6691
6946
|
*/
|
|
6692
6947
|
export type TargetIntent = string;
|
|
6948
|
+
|
|
6949
|
+
/**
|
|
6950
|
+
* The target intent in strict format. same as {@link sap.ushell.services.Navigation.TargetIntent} but with
|
|
6951
|
+
* the following restriction: The intent must not start with a hash character (#).
|
|
6952
|
+
*
|
|
6953
|
+
* @since 1.124.0
|
|
6954
|
+
*/
|
|
6955
|
+
export type TargetIntentStrict = string;
|
|
6693
6956
|
}
|
|
6694
6957
|
|
|
6695
6958
|
declare module "sap/ushell/services/NavTargetResolution" {
|
|
6696
6959
|
/**
|
|
6697
6960
|
* The Unified Shell's internal navigation target resolution service.
|
|
6698
6961
|
*
|
|
6699
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
6700
|
-
*
|
|
6962
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
6963
|
+
*
|
|
6964
|
+
* ```javascript
|
|
6965
|
+
*
|
|
6966
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
6967
|
+
* const NavTargetResolution = await Container.getServiceAsync("NavTargetResolution");
|
|
6968
|
+
* // do something with the NavTargetResolution service
|
|
6969
|
+
* });
|
|
6970
|
+
* ```
|
|
6971
|
+
*
|
|
6701
6972
|
*
|
|
6702
6973
|
* Methods in this class deal with *internal* representations of the shell hash.
|
|
6703
6974
|
*
|
|
@@ -6916,8 +7187,16 @@ declare module "sap/ushell/services/Notifications" {
|
|
|
6916
7187
|
* UShell service for fetching user notification data from the Notification center/service
|
|
6917
7188
|
* and exposing them to the Unified Shell and Fiori applications UI controls.
|
|
6918
7189
|
*
|
|
6919
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
6920
|
-
*
|
|
7190
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
7191
|
+
*
|
|
7192
|
+
* ```javascript
|
|
7193
|
+
*
|
|
7194
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
7195
|
+
* const Notifications = await Container.getServiceAsync("Notifications");
|
|
7196
|
+
* // do something with the Notifications service
|
|
7197
|
+
* });
|
|
7198
|
+
* ```
|
|
7199
|
+
*
|
|
6921
7200
|
*
|
|
6922
7201
|
* In order to get user notifications, Unified Shell notification service issues OData requests
|
|
6923
7202
|
* to the service defined by the configuration property `serviceUrl`,
|
|
@@ -7105,8 +7384,16 @@ declare module "sap/ushell/services/NotificationsV2" {
|
|
|
7105
7384
|
* UShell service for fetching user notification data from the Notification center/service
|
|
7106
7385
|
* and exposing them to the Unified Shell and Fiori applications UI controls.
|
|
7107
7386
|
*
|
|
7108
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
7109
|
-
*
|
|
7387
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
7388
|
+
*
|
|
7389
|
+
* ```javascript
|
|
7390
|
+
*
|
|
7391
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
7392
|
+
* const NotificationsV2 = await Container.getServiceAsync("NotificationsV2");
|
|
7393
|
+
* // do something with the NotificationsV2 service
|
|
7394
|
+
* });
|
|
7395
|
+
* ```
|
|
7396
|
+
*
|
|
7110
7397
|
*
|
|
7111
7398
|
* In order to get user notifications, Unified Shell notification service issues OData requests
|
|
7112
7399
|
* to the service defined by the configuration property `serviceUrl`,
|
|
@@ -7136,7 +7423,7 @@ declare module "sap/ushell/services/NotificationsV2" {
|
|
|
7136
7423
|
*/
|
|
7137
7424
|
protected constructor();
|
|
7138
7425
|
/**
|
|
7139
|
-
*
|
|
7426
|
+
* Enumeration for The nature of the notification
|
|
7140
7427
|
*
|
|
7141
7428
|
* This enum is part of the 'sap/ushell/services/NotificationsV2' module export and must be accessed by
|
|
7142
7429
|
* the property 'Nature'.
|
|
@@ -7355,7 +7642,7 @@ declare module "sap/ushell/services/NotificationsV2" {
|
|
|
7355
7642
|
};
|
|
7356
7643
|
|
|
7357
7644
|
/**
|
|
7358
|
-
*
|
|
7645
|
+
* Enumeration for The nature of the notification
|
|
7359
7646
|
*
|
|
7360
7647
|
* This enum is part of the 'sap/ushell/services/NotificationsV2' module export and must be accessed by
|
|
7361
7648
|
* the property 'Nature'.
|
|
@@ -7527,8 +7814,16 @@ declare module "sap/ushell/services/Personalization" {
|
|
|
7527
7814
|
* The Unified Shell's personalization service, which provides a personalizer object that handles all personalization
|
|
7528
7815
|
* operations.
|
|
7529
7816
|
*
|
|
7530
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
7531
|
-
*
|
|
7817
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
7818
|
+
*
|
|
7819
|
+
* ```javascript
|
|
7820
|
+
*
|
|
7821
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
7822
|
+
* const Personalization = await Container.getServiceAsync("Personalization");
|
|
7823
|
+
* // do something with the Personalization service
|
|
7824
|
+
* });
|
|
7825
|
+
* ```
|
|
7826
|
+
*
|
|
7532
7827
|
*
|
|
7533
7828
|
* @since 1.15.0
|
|
7534
7829
|
* @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2} instead
|
|
@@ -8606,8 +8901,16 @@ declare module "sap/ushell/services/PersonalizationV2" {
|
|
|
8606
8901
|
* The Unified Shell's personalization service. Provides a personalizer object that handles all personalization
|
|
8607
8902
|
* operations.
|
|
8608
8903
|
*
|
|
8609
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
8610
|
-
*
|
|
8904
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
8905
|
+
*
|
|
8906
|
+
* ```javascript
|
|
8907
|
+
*
|
|
8908
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
8909
|
+
* const PersonalizationV2 = await Container.getServiceAsync("PersonalizationV2");
|
|
8910
|
+
* // do something with the PersonalizationV2 service
|
|
8911
|
+
* });
|
|
8912
|
+
* ```
|
|
8913
|
+
*
|
|
8611
8914
|
*
|
|
8612
8915
|
* @since 1.120.0
|
|
8613
8916
|
*/
|
|
@@ -8813,7 +9116,7 @@ declare module "sap/ushell/services/PersonalizationV2" {
|
|
|
8813
9116
|
getTransientPersonalizer(): Promise<TransientPersonalizer>;
|
|
8814
9117
|
}
|
|
8815
9118
|
/**
|
|
8816
|
-
*
|
|
9119
|
+
* The persId identifies the stored personalization container.
|
|
8817
9120
|
*/
|
|
8818
9121
|
export type PersId = {
|
|
8819
9122
|
/**
|
|
@@ -8827,30 +9130,42 @@ declare module "sap/ushell/services/PersonalizationV2" {
|
|
|
8827
9130
|
};
|
|
8828
9131
|
|
|
8829
9132
|
/**
|
|
8830
|
-
*
|
|
9133
|
+
* The scope controls the behavior of the container used by the personalization service.
|
|
8831
9134
|
*/
|
|
8832
9135
|
export type Scope = {
|
|
8833
9136
|
/**
|
|
8834
|
-
* validity of the container persistence in minutes
|
|
8835
|
-
* 0
|
|
8836
|
-
*
|
|
8837
|
-
*
|
|
9137
|
+
* validity of the container persistence in minutes. Available values:
|
|
9138
|
+
* · 0 - The data is persisted in the launchpad window, and is lost when the window is closed or when the
|
|
9139
|
+
* launchpad is reloaded.
|
|
9140
|
+
* · Infinity - The data is persisted on the front-end server without any time restrictions.
|
|
9141
|
+
* · x Minutes - Number of minutes the data is to be persisted on the front-end server, for example 30.
|
|
9142
|
+
*
|
|
9143
|
+
*
|
|
9144
|
+
* For validity > 0 (including infinity) a copy of the container is stored in the volatile memory of the
|
|
9145
|
+
* launchpad window in the browser. Therefore, no roundtrip is necessary for reloading a container at a
|
|
9146
|
+
* later point in time. Only if the launchpad itself is reloaded, the copy is lost and a roundtrip is necessary.
|
|
8838
9147
|
*/
|
|
8839
9148
|
validity?: int;
|
|
8840
9149
|
/**
|
|
8841
9150
|
* Type or category of key
|
|
8842
9151
|
*/
|
|
8843
|
-
keyCategory?:
|
|
9152
|
+
keyCategory?:
|
|
9153
|
+
| sap.ushell.services.PersonalizationV2.KeyCategory
|
|
9154
|
+
| keyof typeof sap.ushell.services.PersonalizationV2.KeyCategory;
|
|
8844
9155
|
/**
|
|
8845
9156
|
* Expected frequency how often users will use this container to store data inside
|
|
8846
9157
|
*/
|
|
8847
|
-
writeFrequency?:
|
|
9158
|
+
writeFrequency?:
|
|
9159
|
+
| sap.ushell.services.PersonalizationV2.WriteFrequency
|
|
9160
|
+
| keyof typeof sap.ushell.services.PersonalizationV2.WriteFrequency;
|
|
8848
9161
|
/**
|
|
8849
|
-
* Defines if storage on client side should be allowed or not
|
|
9162
|
+
* Defines if storage on client side should be allowed or not. Security-relevant data must not be stored
|
|
9163
|
+
* on client side, for instance in local storage or in the HTTP browser cache. Applications should set this
|
|
9164
|
+
* parameter to `true` only if the data is not critical from a security point of view.
|
|
8850
9165
|
*/
|
|
8851
9166
|
clientStorageAllowed?: boolean;
|
|
8852
9167
|
/**
|
|
8853
|
-
* Indicates the container is intended to be shared across multiple applications
|
|
9168
|
+
* Indicates the container is intended to be shared across multiple applications.
|
|
8854
9169
|
*/
|
|
8855
9170
|
shared?: boolean;
|
|
8856
9171
|
};
|
|
@@ -9396,8 +9711,16 @@ declare module "sap/ushell/services/ShellNavigation" {
|
|
|
9396
9711
|
/**
|
|
9397
9712
|
* The Unified Shell's internal navigation service (platform independent).
|
|
9398
9713
|
*
|
|
9399
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
9400
|
-
*
|
|
9714
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
9715
|
+
*
|
|
9716
|
+
* ```javascript
|
|
9717
|
+
*
|
|
9718
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
9719
|
+
* const ShellNavigation = await Container.getServiceAsync("ShellNavigation");
|
|
9720
|
+
* // do something with the ShellNavigation service
|
|
9721
|
+
* });
|
|
9722
|
+
* ```
|
|
9723
|
+
*
|
|
9401
9724
|
*
|
|
9402
9725
|
* This interface is for consumption by shell renderers/containers only
|
|
9403
9726
|
*
|
|
@@ -9565,8 +9888,16 @@ declare module "sap/ushell/services/SmartNavigation" {
|
|
|
9565
9888
|
* will cause an increment of the frequency count, regardless of whether or not the navigation was successful.
|
|
9566
9889
|
*
|
|
9567
9890
|
*
|
|
9568
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
9569
|
-
*
|
|
9891
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
9892
|
+
*
|
|
9893
|
+
* ```javascript
|
|
9894
|
+
*
|
|
9895
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
9896
|
+
* const SmartNavigation = await Container.getServiceAsync("SmartNavigation");
|
|
9897
|
+
* // do something with the SmartNavigation service
|
|
9898
|
+
* });
|
|
9899
|
+
* ```
|
|
9900
|
+
*
|
|
9570
9901
|
*
|
|
9571
9902
|
* @since 1.44.0
|
|
9572
9903
|
* @deprecated (since 1.112) - This service has been deprecated. Please use the CrossApplicationNavigation
|
|
@@ -9731,8 +10062,16 @@ declare module "sap/ushell/services/SupportTicket" {
|
|
|
9731
10062
|
/**
|
|
9732
10063
|
* The Unified Shell's SupportTicket service.
|
|
9733
10064
|
*
|
|
9734
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
9735
|
-
*
|
|
10065
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
10066
|
+
*
|
|
10067
|
+
* ```javascript
|
|
10068
|
+
*
|
|
10069
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
10070
|
+
* const SupportTicket = await Container.getServiceAsync("SupportTicket");
|
|
10071
|
+
* // do something with the SupportTicket service
|
|
10072
|
+
* });
|
|
10073
|
+
* ```
|
|
10074
|
+
*
|
|
9736
10075
|
*
|
|
9737
10076
|
* @since 1.19.1
|
|
9738
10077
|
*/
|
|
@@ -9783,15 +10122,26 @@ declare module "sap/ushell/services/SupportTicket" {
|
|
|
9783
10122
|
declare module "sap/ushell/services/URLParsing" {
|
|
9784
10123
|
import Component from "sap/ui/core/Component";
|
|
9785
10124
|
|
|
9786
|
-
import {
|
|
10125
|
+
import {
|
|
10126
|
+
TargetIntentStrict,
|
|
10127
|
+
TargetIntent,
|
|
10128
|
+
} from "sap/ushell/services/Navigation";
|
|
9787
10129
|
|
|
9788
|
-
import {
|
|
10130
|
+
import { URI } from "sap/ui/core/library";
|
|
9789
10131
|
|
|
9790
10132
|
/**
|
|
9791
10133
|
* The Unified Shell's internal URL parsing service (platform independent).
|
|
9792
10134
|
*
|
|
9793
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
9794
|
-
*
|
|
10135
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
10136
|
+
*
|
|
10137
|
+
* ```javascript
|
|
10138
|
+
*
|
|
10139
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
10140
|
+
* const URLParsing = await Container.getServiceAsync("URLParsing");
|
|
10141
|
+
* // do something with the URLParsing service
|
|
10142
|
+
* });
|
|
10143
|
+
* ```
|
|
10144
|
+
*
|
|
9795
10145
|
*
|
|
9796
10146
|
* Methods in this class allow to break down a shell compliant hash into it's respective parts (SemanticObject,Action,Context,
|
|
9797
10147
|
* Parameters, appSpecificHash) or (ShellPart,appSpecificHash) respectively or construct a hash from its
|
|
@@ -9874,31 +10224,16 @@ declare module "sap/ushell/services/URLParsing" {
|
|
|
9874
10224
|
*
|
|
9875
10225
|
* @since 1.16.0
|
|
9876
10226
|
*
|
|
9877
|
-
* @returns the hash part of an URL, e.g. `"Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
|
|
9878
|
-
*
|
|
10227
|
+
* @returns the hash part of an URL, e.g. `"Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH` Returns
|
|
10228
|
+
* an empty string in case no shell hash was provided.
|
|
9879
10229
|
*/
|
|
9880
10230
|
constructShellHash(
|
|
9881
10231
|
/**
|
|
9882
|
-
* The action must be a valid action,
|
|
9883
|
-
*
|
|
9884
|
-
* ```javascript
|
|
9885
|
-
*
|
|
9886
|
-
* {
|
|
9887
|
-
* target: {
|
|
9888
|
-
* semanticObject: string,
|
|
9889
|
-
* action: string,
|
|
9890
|
-
* contextRaw: string
|
|
9891
|
-
* },
|
|
9892
|
-
* params: MapObject,
|
|
9893
|
-
* appStateKey: string
|
|
9894
|
-
* appSpecificRoute: string
|
|
9895
|
-
* }
|
|
9896
|
-
* ```
|
|
9897
|
-
* xor `{ target: { shellHash } }` Note: in general it is preferred to add an appStateKey directly to the
|
|
9898
|
-
* params object
|
|
10232
|
+
* The parts of a shell hash. Its action must be a valid action, It may not contain "?" or directly a parameter
|
|
10233
|
+
* string. Note: In general it is preferred to add an appStateKey directly to the params object.
|
|
9899
10234
|
*/
|
|
9900
|
-
oShellHash
|
|
9901
|
-
):
|
|
10235
|
+
oShellHash?: SimpleDecomposedHash | DecomposedHash
|
|
10236
|
+
): TargetIntentStrict;
|
|
9902
10237
|
/**
|
|
9903
10238
|
* Extract a hash part from an URL, including an app-specific part
|
|
9904
10239
|
*
|
|
@@ -9935,8 +10270,8 @@ declare module "sap/ushell/services/URLParsing" {
|
|
|
9935
10270
|
* a valid (Shell) url, e.g.
|
|
9936
10271
|
* `http://xx.b.c#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
|
|
9937
10272
|
*/
|
|
9938
|
-
sShellHashString:
|
|
9939
|
-
):
|
|
10273
|
+
sShellHashString: URI
|
|
10274
|
+
): TargetIntent;
|
|
9940
10275
|
/**
|
|
9941
10276
|
* Check if a URL has an intent based navigation part which can be parsed into a semantic object and action
|
|
9942
10277
|
* part. Accepts only a relative URL (must contain #) or fully qualified Urls for which origin and filename
|
|
@@ -10024,7 +10359,7 @@ declare module "sap/ushell/services/URLParsing" {
|
|
|
10024
10359
|
* e.g. `"#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
|
|
10025
10360
|
*/
|
|
10026
10361
|
sHash: TargetIntent
|
|
10027
|
-
):
|
|
10362
|
+
): DecomposedHash;
|
|
10028
10363
|
/**
|
|
10029
10364
|
* split a Unified Shell compliant hash into an Object containing a shell specific part and an app specific
|
|
10030
10365
|
* parts
|
|
@@ -10048,14 +10383,14 @@ declare module "sap/ushell/services/URLParsing" {
|
|
|
10048
10383
|
* Here is an example for the hash part of an URL: "#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
|
|
10049
10384
|
*/
|
|
10050
10385
|
sHash: TargetIntent
|
|
10051
|
-
):
|
|
10386
|
+
): SplitHash;
|
|
10052
10387
|
}
|
|
10053
10388
|
/**
|
|
10054
|
-
* Type for
|
|
10389
|
+
* Type for DecomposedHash
|
|
10055
10390
|
*
|
|
10056
10391
|
* @since 1.120.0
|
|
10057
10392
|
*/
|
|
10058
|
-
export type
|
|
10393
|
+
export type DecomposedHash = {
|
|
10059
10394
|
/**
|
|
10060
10395
|
* the semantic object
|
|
10061
10396
|
*/
|
|
@@ -10072,14 +10407,40 @@ declare module "sap/ushell/services/URLParsing" {
|
|
|
10072
10407
|
* the parameters
|
|
10073
10408
|
*/
|
|
10074
10409
|
params: Record<string, string[]>;
|
|
10410
|
+
/**
|
|
10411
|
+
* the app state key
|
|
10412
|
+
*/
|
|
10413
|
+
appStateKey?: string;
|
|
10414
|
+
/**
|
|
10415
|
+
* the app specific route
|
|
10416
|
+
*/
|
|
10417
|
+
appSpecificRoute?: string;
|
|
10075
10418
|
};
|
|
10076
10419
|
|
|
10077
10420
|
/**
|
|
10078
|
-
* Type for
|
|
10421
|
+
* Simple Type for DecomposedHash with shell hash as part of the target property. Use this type for edge
|
|
10422
|
+
* cases only. Use {@link sap.ushell.services.URLParsing.DecomposedHash} instead.
|
|
10423
|
+
*
|
|
10424
|
+
* @since 1.124.0
|
|
10425
|
+
*/
|
|
10426
|
+
export type SimpleDecomposedHash = {
|
|
10427
|
+
/**
|
|
10428
|
+
* The target object
|
|
10429
|
+
*/
|
|
10430
|
+
target: {
|
|
10431
|
+
/**
|
|
10432
|
+
* The shell hash
|
|
10433
|
+
*/
|
|
10434
|
+
shallHash: TargetIntent;
|
|
10435
|
+
};
|
|
10436
|
+
};
|
|
10437
|
+
|
|
10438
|
+
/**
|
|
10439
|
+
* Type for SplitHash
|
|
10079
10440
|
*
|
|
10080
10441
|
* @since 1.120.0
|
|
10081
10442
|
*/
|
|
10082
|
-
export type
|
|
10443
|
+
export type SplitHash = {
|
|
10083
10444
|
/**
|
|
10084
10445
|
* the shell part of the hash
|
|
10085
10446
|
*/
|
|
@@ -10102,8 +10463,16 @@ declare module "sap/ushell/services/UsageAnalytics" {
|
|
|
10102
10463
|
/**
|
|
10103
10464
|
* A UShell service for tracking business flows and user actions.
|
|
10104
10465
|
*
|
|
10105
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
10106
|
-
*
|
|
10466
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
10467
|
+
*
|
|
10468
|
+
* ```javascript
|
|
10469
|
+
*
|
|
10470
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
10471
|
+
* const UsageAnalytics = await Container.getServiceAsync("UsageAnalytics");
|
|
10472
|
+
* // do something with the UsageAnalytics service
|
|
10473
|
+
* });
|
|
10474
|
+
* ```
|
|
10475
|
+
*
|
|
10107
10476
|
*
|
|
10108
10477
|
* The UsageAnalytics service exposes API for logging custom events and setting custom field values in the
|
|
10109
10478
|
* logged events.
|
|
@@ -10142,6 +10511,7 @@ declare module "sap/ushell/services/UsageAnalytics" {
|
|
|
10142
10511
|
* Currently these attributes correspond to database columns custom5...custom10.
|
|
10143
10512
|
*
|
|
10144
10513
|
* @since 1.32.0
|
|
10514
|
+
* @deprecated (since 1.120.0)
|
|
10145
10515
|
*/
|
|
10146
10516
|
setCustomAttributes(
|
|
10147
10517
|
/**
|
|
@@ -10164,6 +10534,7 @@ declare module "sap/ushell/services/UsageAnalytics" {
|
|
|
10164
10534
|
* Enables the renderer to set the content of the legal message..
|
|
10165
10535
|
*
|
|
10166
10536
|
* @since 1.32.0
|
|
10537
|
+
* @deprecated (since 1.120.0)
|
|
10167
10538
|
*/
|
|
10168
10539
|
setLegalText(): void;
|
|
10169
10540
|
/**
|
|
@@ -10171,13 +10542,10 @@ declare module "sap/ushell/services/UsageAnalytics" {
|
|
|
10171
10542
|
*
|
|
10172
10543
|
*
|
|
10173
10544
|
*
|
|
10174
|
-
*
|
|
10175
|
-
* a) Service configuration property `enable` is set to `true`
|
|
10176
|
-
* b) Service configuration property `pubToken` is not empty
|
|
10177
|
-
* c) Agreement text exists or `setUsageAnalyticsPermitted` is set to `false`
|
|
10178
|
-
*
|
|
10545
|
+
* Since the service is deprecated and no longer supported, this method always returns `false`.
|
|
10179
10546
|
*
|
|
10180
10547
|
* @since 1.32.0
|
|
10548
|
+
* @deprecated (since 1.120.0)
|
|
10181
10549
|
*
|
|
10182
10550
|
* @returns A boolean value indicating whether the UsageAnalytics service is enabled
|
|
10183
10551
|
*/
|
|
@@ -10187,12 +10555,10 @@ declare module "sap/ushell/services/UsageAnalytics" {
|
|
|
10187
10555
|
*
|
|
10188
10556
|
*
|
|
10189
10557
|
*
|
|
10190
|
-
*
|
|
10191
|
-
* a) The function `system enabled` returns `true`
|
|
10192
|
-
* b) The user property `trackUsageAnalytics` is set to `true`
|
|
10193
|
-
*
|
|
10558
|
+
* Since the service is deprecated and no longer supported, this method always returns `false`.
|
|
10194
10559
|
*
|
|
10195
10560
|
* @since 1.32.0
|
|
10561
|
+
* @deprecated (since 1.120.0)
|
|
10196
10562
|
*
|
|
10197
10563
|
* @returns A boolean value indicating whether the user has specified to track activities
|
|
10198
10564
|
*/
|
|
@@ -10204,8 +10570,16 @@ declare module "sap/ushell/services/UserInfo" {
|
|
|
10204
10570
|
/**
|
|
10205
10571
|
* The Unified Shell's user information service. Allows retrieving information about the logged-in user.
|
|
10206
10572
|
*
|
|
10207
|
-
* **Note:** To retrieve a valid instance of this service, it is necessary to call
|
|
10208
|
-
*
|
|
10573
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
|
|
10574
|
+
*
|
|
10575
|
+
* ```javascript
|
|
10576
|
+
*
|
|
10577
|
+
* sap.ui.require(["sap/ushell/Container"], async function (Container) {
|
|
10578
|
+
* const UserInfo = await Container.getServiceAsync("UserInfo");
|
|
10579
|
+
* // do something with the UserInfo service
|
|
10580
|
+
* });
|
|
10581
|
+
* ```
|
|
10582
|
+
*
|
|
10209
10583
|
*
|
|
10210
10584
|
* @since 1.16.3
|
|
10211
10585
|
*/
|
|
@@ -12572,6 +12946,42 @@ declare module "sap/ushell/ui/launchpad/TileState" {
|
|
|
12572
12946
|
>;
|
|
12573
12947
|
}
|
|
12574
12948
|
|
|
12949
|
+
declare module "sap/ushell/ui/shell/ShellHeadItem" {
|
|
12950
|
+
import { URI, aria } from "sap/ui/core/library";
|
|
12951
|
+
|
|
12952
|
+
export type Properties = {
|
|
12953
|
+
/**
|
|
12954
|
+
* The icon of the item, either defined in the sap.ui.core.IconPool or an URI to a custom image.
|
|
12955
|
+
*/
|
|
12956
|
+
icon: URI;
|
|
12957
|
+
/**
|
|
12958
|
+
* The text of the item. It is either visible as tooltip or as label when the item is rendered as part of
|
|
12959
|
+
* an overflow button in a popover.
|
|
12960
|
+
*/
|
|
12961
|
+
text?: string;
|
|
12962
|
+
/**
|
|
12963
|
+
* Target URI of the item.
|
|
12964
|
+
*/
|
|
12965
|
+
target?: URI;
|
|
12966
|
+
/**
|
|
12967
|
+
* The aria-label attribute of the item.
|
|
12968
|
+
*/
|
|
12969
|
+
ariaLabel?: string;
|
|
12970
|
+
/**
|
|
12971
|
+
* Specifies whether the aria-hidden attribute is set to true.
|
|
12972
|
+
*/
|
|
12973
|
+
ariaHidden?: boolean;
|
|
12974
|
+
/**
|
|
12975
|
+
* Specifies the value of the aria-haspopup attribute
|
|
12976
|
+
*/
|
|
12977
|
+
ariaHaspopup?: aria.HasPopup | keyof typeof aria.HasPopup;
|
|
12978
|
+
/**
|
|
12979
|
+
* The press handler function.
|
|
12980
|
+
*/
|
|
12981
|
+
press?: Function;
|
|
12982
|
+
};
|
|
12983
|
+
}
|
|
12984
|
+
|
|
12575
12985
|
declare module "sap/ushell/ui/shell/ToolAreaItem" {
|
|
12576
12986
|
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
12577
12987
|
|
|
@@ -13056,7 +13466,8 @@ declare module "sap/ushell/ui/tile/StaticTile" {
|
|
|
13056
13466
|
* @deprecated (since 1.120)
|
|
13057
13467
|
*/
|
|
13058
13468
|
export default class StaticTile
|
|
13059
|
-
/* was: sap.ushell.ui.tile.TileBase */
|
|
13469
|
+
extends /* was: sap.ushell.ui.tile.TileBase */ Object
|
|
13470
|
+
{
|
|
13060
13471
|
/**
|
|
13061
13472
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
13062
13473
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -13155,7 +13566,8 @@ declare module "sap/ushell/ui5service/UserStatus" {
|
|
|
13155
13566
|
* @deprecated (since 1.70) - Support for this service has been discontinued.
|
|
13156
13567
|
*/
|
|
13157
13568
|
export default class UserStatus
|
|
13158
|
-
/* was: sap.ui.core.service.Service */
|
|
13569
|
+
extends /* was: sap.ui.core.service.Service */ Object
|
|
13570
|
+
{
|
|
13159
13571
|
constructor();
|
|
13160
13572
|
|
|
13161
13573
|
/**
|
|
@@ -13324,6 +13736,32 @@ declare namespace sap {
|
|
|
13324
13736
|
* @since 1.15.0
|
|
13325
13737
|
*/
|
|
13326
13738
|
namespace services {
|
|
13739
|
+
namespace PersonalizationV2 {
|
|
13740
|
+
/**
|
|
13741
|
+
* @since 1.124.0
|
|
13742
|
+
*/
|
|
13743
|
+
enum KeyCategory {
|
|
13744
|
+
/**
|
|
13745
|
+
* A static hard-coded key which does not change. This value is required for caching to take place.
|
|
13746
|
+
*/
|
|
13747
|
+
FIXED_KEY = "FIXED_KEY",
|
|
13748
|
+
/**
|
|
13749
|
+
* For all other cases.
|
|
13750
|
+
*/
|
|
13751
|
+
GENERATED_KEY = "GENERATED_KEY",
|
|
13752
|
+
}
|
|
13753
|
+
/**
|
|
13754
|
+
* @since 1.124.0
|
|
13755
|
+
*/
|
|
13756
|
+
enum WriteFrequency {
|
|
13757
|
+
HIGH = "HIGH",
|
|
13758
|
+
/**
|
|
13759
|
+
* The key is typically rarely updated, for example in explicit table personalization by end users.
|
|
13760
|
+
*/
|
|
13761
|
+
LOW = "LOW",
|
|
13762
|
+
}
|
|
13763
|
+
}
|
|
13764
|
+
|
|
13327
13765
|
/**
|
|
13328
13766
|
* Abstract base class for ushell services. For details, see {@link sap.ushell.Container#getServiceAsync}.
|
|
13329
13767
|
*
|
|
@@ -13413,7 +13851,8 @@ declare namespace sap {
|
|
|
13413
13851
|
* @since 1.38.0
|
|
13414
13852
|
*/
|
|
13415
13853
|
class ShellUIService
|
|
13416
|
-
/* was: sap.ui.core.service.Service */
|
|
13854
|
+
extends /* was: sap.ui.core.service.Service */ Object
|
|
13855
|
+
{
|
|
13417
13856
|
/**
|
|
13418
13857
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
13419
13858
|
*/
|
|
@@ -13504,6 +13943,8 @@ declare namespace sap {
|
|
|
13504
13943
|
}
|
|
13505
13944
|
|
|
13506
13945
|
interface IUI5DefineDependencyNames {
|
|
13946
|
+
"sap/ushell/api/NewExperience": undefined;
|
|
13947
|
+
|
|
13507
13948
|
"sap/ushell/api/RTA": undefined;
|
|
13508
13949
|
|
|
13509
13950
|
"sap/ushell/api/workpage/Designtime": undefined;
|
|
@@ -13558,15 +13999,19 @@ declare namespace sap {
|
|
|
13558
13999
|
|
|
13559
14000
|
"sap/ushell/services/Extension": undefined;
|
|
13560
14001
|
|
|
13561
|
-
"sap/ushell/services/Extension/
|
|
14002
|
+
"sap/ushell/services/Extension/Item": undefined;
|
|
13562
14003
|
|
|
13563
|
-
"sap/ushell/services/
|
|
14004
|
+
"sap/ushell/services/FrameBoundExtension": undefined;
|
|
13564
14005
|
|
|
13565
|
-
"sap/ushell/services/
|
|
14006
|
+
"sap/ushell/services/FrameBoundExtension/FloatingContainer": undefined;
|
|
14007
|
+
|
|
14008
|
+
"sap/ushell/services/FrameBoundExtension/Footer": undefined;
|
|
14009
|
+
|
|
14010
|
+
"sap/ushell/services/FrameBoundExtension/Item": undefined;
|
|
13566
14011
|
|
|
13567
|
-
"sap/ushell/services/
|
|
14012
|
+
"sap/ushell/services/FrameBoundExtension/SidePane": undefined;
|
|
13568
14013
|
|
|
13569
|
-
"sap/ushell/services/
|
|
14014
|
+
"sap/ushell/services/FrameBoundExtension/ToolArea": undefined;
|
|
13570
14015
|
|
|
13571
14016
|
"sap/ushell/services/LaunchPage": undefined;
|
|
13572
14017
|
|
|
@@ -13588,6 +14033,8 @@ declare namespace sap {
|
|
|
13588
14033
|
|
|
13589
14034
|
"sap/ushell/services/PersonalizationV2": undefined;
|
|
13590
14035
|
|
|
14036
|
+
"sap/ushell/services/PersonalizationV2/constants": undefined;
|
|
14037
|
+
|
|
13591
14038
|
"sap/ushell/services/PersonalizationV2/ContextContainer": undefined;
|
|
13592
14039
|
|
|
13593
14040
|
"sap/ushell/services/PersonalizationV2/Personalizer": undefined;
|
|
@@ -13604,6 +14051,8 @@ declare namespace sap {
|
|
|
13604
14051
|
|
|
13605
14052
|
"sap/ushell/services/ShellNavigation": undefined;
|
|
13606
14053
|
|
|
14054
|
+
"sap/ushell/services/ShellNavigationInternal": undefined;
|
|
14055
|
+
|
|
13607
14056
|
"sap/ushell/services/SmartNavigation": undefined;
|
|
13608
14057
|
|
|
13609
14058
|
"sap/ushell/services/SpaceContent": undefined;
|
|
@@ -13636,6 +14085,8 @@ declare namespace sap {
|
|
|
13636
14085
|
|
|
13637
14086
|
"sap/ushell/ui/launchpad/VizInstanceBase": undefined;
|
|
13638
14087
|
|
|
14088
|
+
"sap/ushell/ui/shell/ShellHeadItem": undefined;
|
|
14089
|
+
|
|
13639
14090
|
"sap/ushell/ui/shell/ToolAreaItem": undefined;
|
|
13640
14091
|
|
|
13641
14092
|
"sap/ushell/ui/tile/StaticTile": undefined;
|