@sapui5/ts-types 1.122.2 → 1.123.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.
Files changed (66) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +5 -5
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +404 -3
  5. package/types/sap.chart.d.ts +58 -3
  6. package/types/sap.collaboration.d.ts +52 -3
  7. package/types/sap.esh.search.ui.d.ts +2152 -2
  8. package/types/sap.f.d.ts +432 -46
  9. package/types/sap.fe.core.d.ts +20 -15
  10. package/types/sap.fe.macros.d.ts +1048 -21
  11. package/types/sap.fe.navigation.d.ts +1 -1
  12. package/types/sap.fe.placeholder.d.ts +1 -1
  13. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  14. package/types/sap.fe.templates.d.ts +8 -6
  15. package/types/sap.fe.test.d.ts +288 -7
  16. package/types/sap.fe.tools.d.ts +1 -1
  17. package/types/sap.feedback.ui.d.ts +1 -1
  18. package/types/sap.gantt.d.ts +1067 -15
  19. package/types/sap.insights.d.ts +4 -1
  20. package/types/{mobile-1.122.0-d.ts → sap.m.d.ts} +3962 -124
  21. package/types/sap.makit.d.ts +115 -2
  22. package/types/sap.me.d.ts +84 -2
  23. package/types/sap.ndc.d.ts +22 -1
  24. package/types/sap.ovp.d.ts +1 -1
  25. package/types/sap.rules.ui.d.ts +44 -8
  26. package/types/sap.sac.df.d.ts +111 -60
  27. package/types/sap.suite.ui.commons.d.ts +1148 -2174
  28. package/types/sap.suite.ui.generic.template.d.ts +10 -1
  29. package/types/sap.suite.ui.microchart.d.ts +190 -2
  30. package/types/sap.tnt.d.ts +46 -2
  31. package/types/sap.ui.codeeditor.d.ts +16 -1
  32. package/types/{commons-1.122.0-d.ts → sap.ui.commons.d.ts} +792 -30
  33. package/types/sap.ui.comp.d.ts +964 -86
  34. package/types/{core-1.122.0-d.ts → sap.ui.core.d.ts} +2194 -1540
  35. package/types/sap.ui.dt.d.ts +3 -0
  36. package/types/sap.ui.export.d.ts +22 -4
  37. package/types/sap.ui.fl.d.ts +40 -1
  38. package/types/sap.ui.generic.app.d.ts +217 -203
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +147 -5
  41. package/types/sap.ui.layout.d.ts +171 -8
  42. package/types/sap.ui.mdc.d.ts +554 -33
  43. package/types/sap.ui.richtexteditor.d.ts +28 -2
  44. package/types/sap.ui.rta.d.ts +1 -1
  45. package/types/sap.ui.suite.d.ts +27 -2
  46. package/types/sap.ui.support.d.ts +1 -1
  47. package/types/sap.ui.table.d.ts +278 -57
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +481 -9
  50. package/types/{ux3-1.122.0-d.ts → sap.ui.ux3.d.ts} +527 -5
  51. package/types/sap.ui.vbm.d.ts +544 -2
  52. package/types/sap.ui.vk.d.ts +1580 -39
  53. package/types/sap.ui.vtm.d.ts +373 -2
  54. package/types/sap.ui.webc.common.d.ts +7 -2
  55. package/types/sap.ui.webc.fiori.d.ts +351 -2
  56. package/types/sap.ui.webc.main.d.ts +1035 -2
  57. package/types/sap.uiext.inbox.d.ts +124 -2
  58. package/types/sap.ushell.d.ts +1001 -322
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +123 -6
  61. package/types/sap.viz.d.ts +2619 -5
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +35 -10
  64. package/types/sap.zen.crosstab.d.ts +22 -7
  65. package/types/sap.zen.dsh.d.ts +64 -8
  66. package/types/dt-1.122.0-d.ts +0 -3
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.122.2
1
+ // For Library Version: 1.123.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -73,6 +73,230 @@ declare namespace sap {
73
73
  * @since 1.15.0
74
74
  */
75
75
  namespace services {
76
+ namespace AppConfiguration {
77
+ /**
78
+ * Type for the metadata object for AppConfiguration
79
+ *
80
+ * @since 1.120.0
81
+ */
82
+ type Metadata = {
83
+ /**
84
+ * The title of the application
85
+ */
86
+ title: string;
87
+ /**
88
+ * The library of the application
89
+ */
90
+ library: string;
91
+ /**
92
+ * The version of the application
93
+ */
94
+ version: string;
95
+ /**
96
+ * A Boolean value indicating if the application fills the full width of the screen
97
+ */
98
+ fullWidth: boolean;
99
+ };
100
+ }
101
+
102
+ namespace AppLifeCycle {
103
+ /**
104
+ * Enumeration of application info parameter names.
105
+ *
106
+ * This enum is part of the 'sap/ushell/services/AppLifeCycle' module export and must be accessed by the
107
+ * property 'AppInfoParameterName'.
108
+ *
109
+ * @since 1.120.0
110
+ */
111
+ enum AppInfoParameterName {
112
+ /**
113
+ * ID of the framework
114
+ */
115
+ appFrameworkId = "appFrameworkId",
116
+ /**
117
+ * Version of the framework
118
+ */
119
+ appFrameworkVersion = "appFrameworkVersion",
120
+ /**
121
+ * Universal stable logical identifier of the application across the whole content.
122
+ */
123
+ appId = "appId",
124
+ /**
125
+ * Intent that was used to launch the application (including parameters)
126
+ */
127
+ appIntent = "appIntent",
128
+ /**
129
+ * The name of an organizational component that handles support incidents.
130
+ */
131
+ appSupportInfo = "appSupportInfo",
132
+ /**
133
+ * Version of the app
134
+ */
135
+ appVersion = "appVersion",
136
+ /**
137
+ * Current Language (BCP47 format)
138
+ */
139
+ languageTag = "languageTag",
140
+ /**
141
+ * A human readable free form text maintained on the platform where FLP runs, and identifying the current
142
+ * product.
143
+ */
144
+ productName = "productName",
145
+ /**
146
+ * Identifier of the component that implements the base application.
147
+ */
148
+ technicalAppComponentId = "technicalAppComponentId",
149
+ /**
150
+ * Current FLP theme. Includes the path to the theme resources if the theme is not an sap theme (does not
151
+ * start with sap_)
152
+ */
153
+ theme = "theme",
154
+ }
155
+ /**
156
+ * Enumeration of application types.
157
+ *
158
+ * This enum is part of the 'sap/ushell/services/AppLifeCycle' module export and must be accessed by the
159
+ * property 'ApplicationType'.
160
+ *
161
+ * @since 1.120.0
162
+ */
163
+ enum ApplicationType {
164
+ /**
165
+ * The application is starting using the SAP Business Client.
166
+ */
167
+ NWBC = "NWBC",
168
+ /**
169
+ * The application is started using a transaction
170
+ */
171
+ TR = "TR",
172
+ /**
173
+ * The application is a UI5 application.
174
+ */
175
+ UI5 = "UI5",
176
+ /**
177
+ * The application is started using a URL
178
+ */
179
+ URL = "URL",
180
+ /**
181
+ * The application is a Webdynpro application.
182
+ */
183
+ WDA = "WDA",
184
+ }
185
+ /**
186
+ * Defines the application info.
187
+ *
188
+ * @since 1.120.0
189
+ */
190
+ type AppInfo = {
191
+ /**
192
+ * A human readable free form text maintained on the platform where FLP runs, and identifying the current
193
+ * product.
194
+ */
195
+ productName: string;
196
+ /**
197
+ * Current FLP theme. Includes the path to the theme resources if the theme is not an sap theme (does not
198
+ * start with sap_)
199
+ */
200
+ theme: string;
201
+ /**
202
+ * Current Language (BCP47 format)
203
+ */
204
+ languageTag: string;
205
+ /**
206
+ * Intent that was used to launch the application (including parameters)
207
+ */
208
+ appIntent: string;
209
+ /**
210
+ * ID of the framework
211
+ */
212
+ appFrameworkId: string;
213
+ /**
214
+ * Identifier of the component that implements the base application.
215
+ */
216
+ technicalAppComponentId: string;
217
+ /**
218
+ * Universal stable logical identifier of the application across the whole content.
219
+ */
220
+ appId: string;
221
+ /**
222
+ * Version of the app
223
+ */
224
+ appVersion: string;
225
+ /**
226
+ * The name of an organizational component that handles support incidents.
227
+ */
228
+ appSupportInfo: string;
229
+ /**
230
+ * Version of the framework
231
+ */
232
+ appFrameworkVersion: string;
233
+ };
234
+
235
+ /**
236
+ * Defines the current application.
237
+ *
238
+ * @since 1.120.0
239
+ */
240
+ type CurrentApplication = {
241
+ /**
242
+ * The type of the current application.
243
+ */
244
+ applicationType: sap.ushell.services.AppLifeCycle.ApplicationType;
245
+ /**
246
+ * reference to component (only for applicationType "UI5")
247
+ */
248
+ componentInstance?: sap.ui.core.Component;
249
+ /**
250
+ * `true` when root intent (normally #Shell-home) or Appfinder (#Shell-appfinder) is currently displayed.
251
+ */
252
+ homePage: boolean;
253
+ /**
254
+ * function that returns the value of a technical parameter for the given application. This method is for
255
+ * SAP internal usage only.
256
+ */
257
+ getTechnicalParameter: Function;
258
+ /**
259
+ * See {@link sap.ushell.services.URLParsing#parseShellHash} for details. This property is for SAP-internal
260
+ * use only!
261
+ */
262
+ getIntent: () => Promise<sap.ushell.services.AppLifeCycle.Intent>;
263
+ /**
264
+ * provides the values of the given parameters.
265
+ */
266
+ getInfo: (
267
+ p1: sap.ushell.services.AppLifeCycle.AppInfoParameterName[]
268
+ ) => Promise<sap.ushell.services.AppLifeCycle.AppInfo>;
269
+ };
270
+
271
+ /**
272
+ * Defines an intent. See {@link sap.ushell.services.URLParsing#parseShellHash} for details.
273
+ *
274
+ * @since 1.120.0
275
+ */
276
+ type Intent = {
277
+ /**
278
+ * The semantic object of the intent.
279
+ */
280
+ semanticObject: string;
281
+ /**
282
+ * The action of the intent.
283
+ */
284
+ action: string;
285
+ /**
286
+ * The raw context of the intent.
287
+ */
288
+ contextRaw: string;
289
+ /**
290
+ * The parameters of the intent.
291
+ */
292
+ params: Record<string, string[]>;
293
+ /**
294
+ * The app specific route of the intent.
295
+ */
296
+ appSpecificRoute: string;
297
+ };
298
+ }
299
+
76
300
  namespace Bookmark {
77
301
  /**
78
302
  * A content node may be: - a classic home page group - an unselectable node (space) or a selectable node
@@ -103,8 +327,113 @@ declare namespace sap {
103
327
  }
104
328
 
105
329
  namespace BookmarkV2 {
330
+ /**
331
+ * Type for data source object. Metadata for parameter serviceUrl. Mandatory to specify if parameter serviceURL
332
+ * contains semantic date ranges. This does not influence the data source of the app itself.
333
+ *
334
+ * Specify the data source as follows:
335
+ * ```javascript
336
+ *
337
+ * {
338
+ * type: "OData",
339
+ * settings: {
340
+ * odataVersion: "4.0"
341
+ * }
342
+ * }
343
+ * ```
344
+ *
345
+ *
346
+ *
347
+ * type: The type of the serviceURL's service. Only "OData" is supported. odataVersion: The OData version
348
+ * of parameter serviceURL. Valid values are "2.0" and "4.0".
349
+ *
350
+ * @since 1.121.0
351
+ */
352
+ type BookmarkParameters = {
353
+ /**
354
+ * The type of the serviceURL's service. Only "OData" is supported.
355
+ */
356
+ type: string;
357
+ /**
358
+ * The settings for the data source.
359
+ */
360
+ settings: {
361
+ x: any;
362
+ };
363
+ /**
364
+ * The title of the bookmark.
365
+ */
366
+ title: string;
367
+ /**
368
+ * The URL of the bookmark. The target intent or URL of the bookmark. If the target app runs in the current
369
+ * shell, the URL has to be a valid intent, i.e. in the format `"#SO-Action?P1=a&P2=x&/route?RPV=1"`.
370
+ */
371
+ url: /* was: sap.ushell.services.navigation.TargetIntent */
372
+ | any
373
+ | sap.ui.core.URI;
374
+ /**
375
+ * The optional icon URL of the bookmark (e.g. `"sap-icon://home"`).
376
+ */
377
+ icon?: string;
378
+ /**
379
+ * The optional information text of the bookmark.
380
+ */
381
+ info?: string;
382
+ /**
383
+ * The optional subtitle of the bookmark.
384
+ */
385
+ subtitle?: string;
386
+ /**
387
+ * The URL to a REST or OData service that provides some dynamic information for the bookmark. The URL to
388
+ * a REST or OData service that provides some dynamic information for the bookmark.
389
+ *
390
+ * **Semantic Date Ranges:**
391
+ *
392
+ * You can use placeholders for dynamic dates in the query parameters of the service URL. This can be used
393
+ * to create KPI tiles based on user entries in control {@link sap.m.DynamicDateRange}, where it is possible
394
+ * to specify dynamic dates like YESTERDAY or THISYEAR.
395
+ *
396
+ * The placeholder format looks like this: {Edm.<type>%%DynamicDate.<operator>.<value1>.<value2>.<position>%%}
397
+ *
398
+ *
399
+ * - <type>: The Edm Type of the parameter. Supported types are String, DateTime and DateTimeOffset
400
+ * for OData V2 and Date and DateTimeOffset for OData V4.
401
+ * - <operator>, <value1>, <value2>: Possible values are the ones that can be used in
402
+ * {@link sap.m.DynamicDateRange#toDates} to create a date range.
403
+ * - <position>: Possible values are 'start' and 'end' which mark the start or end of the interval
404
+ * specified by the operator.
405
+ *
406
+ * Examples:
407
+ * - /a/url/$count?$filter=(testDate ge {Edm.DateTimeOffset%DynamicDate.YESTERDAY.start%} and testDate
408
+ * le {Edm.DateTimeOffset%DynamicDate.YESTERDAY.end%})
409
+ * - /a/url/$count?$filter=(testDate ge {Edm.DateTime%DynamicDate.THISYEAR.start%} and testDate le {Edm.DateTime%DynamicDate.THISYEAR.end%})
410
+ *
411
+ * - /a/url/$count?$filter=(testDate ge {Edm.Date%DynamicDate.TODAYFROMTO.1.5.start%} and testDate le
412
+ * {Edm.Date%DynamicDate.TODAYFROMTO.1.5.end%})
413
+ *
414
+ * Hint: Check the debug log when displaying the resulting KPI tiles to get more information about the resolution
415
+ * of the placeholders.
416
+ */
417
+ serviceUrl?: sap.ui.core.URI;
418
+ /**
419
+ * Metadata for parameter serviceUrl. Mandatory to specify if parameter serviceURL contains semantic date
420
+ * ranges.
421
+ */
422
+ dataSource?: /* was: sap.ushell.services.BookmarkV2.DataSource */ any;
423
+ /**
424
+ * The refresh interval for the `serviceUrl` in seconds.
425
+ */
426
+ serviceRefreshInterval?: string;
427
+ /**
428
+ * The unit for the number retrieved from `serviceUrl`.
429
+ */
430
+ numberUnit?: string;
431
+ };
432
+
106
433
  /**
107
434
  * A tree of content nodes.
435
+ *
436
+ * @since 1.121.0
108
437
  */
109
438
  type ContentNode = {
110
439
  /**
@@ -116,7 +445,7 @@ declare namespace sap {
116
445
  */
117
446
  label: string;
118
447
  /**
119
- * Specifies the content node type. E.g: space, page, etc. See {@link sap.ushell.sap.ushell.services.BookmarkV2.ContentNodeType}
448
+ * Specifies the content node type. E.g: space, page, etc.
120
449
  */
121
450
  type: sap.ushell.ContentNodeType;
122
451
  /**
@@ -536,6 +865,269 @@ declare namespace sap {
536
865
  */
537
866
  processParams?: boolean;
538
867
  };
868
+
869
+ /**
870
+ * The target intent.
871
+ *
872
+ * Navigation is encoded in the fragment identifier of the URL within FLPthe URL has to be a valid intent,
873
+ * i.e. in the format `"#SO-Action?P1=a&P2=x&/route?RPV=1"`. The generic syntax consists of the semantic
874
+ * object, the action and an optional part:
875
+ * ```javascript
876
+ * Intent = "#" semanticObject "-" action ["?" intentParameters "&/" innerAppRoute + "?" + innerAppRouteParameters]```
877
+ * The intent compries of the fthe following parts:
878
+ * semanticObject: Semantic object as defined in an app launcher tile. The following characters are allowed:
879
+ * uppercase letters [A-Z], lowercase letters [a-z], numbers [0-9]. The first character must be an uppercase
880
+ * or lowercase letter. The length of the semantic object is limited to 30 characters.
881
+ *
882
+ *
883
+ * - action: Action as defined in an app launcher tile. For the action name, choose a verb or a short
884
+ * phrase starting with lower case and without blanks. Examples are display, create, or release. The following
885
+ * characters are allowed: uppercase letters [A-Z], lowercase letters [a-z], numbers [0-9] and underscores
886
+ * [_]. The first character must be an uppercase or lowercase letter or an underscore. The length of the
887
+ * action is limited to 50 characters.
888
+ * - intentParameters: Intent parameters are optional parameters. The parameters are separated by the
889
+ * ampersand character (&). The parameter name and value are separated by the equal sign (=). The parameter
890
+ * value must be URL-encoded. When navigating via Intent Based Navigation (IBN) the intent parameters are
891
+ * used to determine the target application.
892
+ * - innerAppRoute: The inner app route is an optional parameter that is used to navigate within the target
893
+ * application. The inner app route is separated from the intent parameters by the "&/".
894
+ * - innerAppRouteParameters: The inner app route parameters are optional parameters that are passed to
895
+ * the target application. The parameters are separated by the ampersand character (&). The parameter name
896
+ * and value are separated by the equal sign (=). The parameter value must be URL-encoded.
897
+ *
898
+ * @since 1.121.0
899
+ */
900
+ type TargetIntent = string;
901
+ }
902
+
903
+ namespace NotificationsV2 {
904
+ /**
905
+ * Enumaration for The nature of the notification
906
+ *
907
+ * This enum is part of the 'sap/ushell/services/NotificationsV2' module export and must be accessed by
908
+ * the property 'Nature'.
909
+ *
910
+ * @since 1.120.0
911
+ */
912
+ enum Nature {
913
+ /**
914
+ * The Negative nature.
915
+ */
916
+ NEGATIVE = "NEGATIVE",
917
+ /**
918
+ * The Neutral nature.
919
+ */
920
+ NEUTRAL = "NEUTRAL",
921
+ /**
922
+ * The Positive nature.
923
+ */
924
+ POSITIVE = "POSITIVE",
925
+ }
926
+ /**
927
+ * Enumeration for the priority of a notification
928
+ *
929
+ * This enum is part of the 'sap/ushell/services/NotificationsV2' module export and must be accessed by
930
+ * the property 'Priority'.
931
+ *
932
+ * @since 1.120.0
933
+ */
934
+ enum Priority {
935
+ /**
936
+ * High priority.
937
+ */
938
+ HIGH = "HIGH",
939
+ /**
940
+ * Low priority.
941
+ */
942
+ LOW = "LOW",
943
+ /**
944
+ * Medium priority.
945
+ */
946
+ MEDIUM = "MEDIUM",
947
+ }
948
+ /**
949
+ * Type for Action
950
+ *
951
+ * @since 1.120.0
952
+ */
953
+ type Action = {
954
+ /**
955
+ * The ID of the action
956
+ */
957
+ ActionId: string;
958
+ /**
959
+ * The text of the action
960
+ */
961
+ ActionText: string;
962
+ /**
963
+ * The group action text
964
+ */
965
+ GroupActionText: string;
966
+ /**
967
+ * The nature of the action
968
+ */
969
+ Nature: sap.ushell.services.NotificationsV2.Nature;
970
+ };
971
+
972
+ /**
973
+ * Type for Actor
974
+ *
975
+ * @since 1.120.0
976
+ */
977
+ type Actor = {
978
+ /**
979
+ * The ID of the actor
980
+ */
981
+ Id: string;
982
+ /**
983
+ * The display text of the actor
984
+ */
985
+ DisplayText: string;
986
+ /**
987
+ * The image source of the actor
988
+ */
989
+ ImageSource: string;
990
+ };
991
+
992
+ /**
993
+ * Type for executeBulkAction
994
+ *
995
+ * @since 1.120.0
996
+ */
997
+ type BulkAction = {
998
+ /**
999
+ * Indicates whether the notification should be deleted after the action is executed
1000
+ */
1001
+ DeleteOnReturn: boolean;
1002
+ /**
1003
+ * Indicates whether the action was executed successfully
1004
+ */
1005
+ Success: boolean;
1006
+ /**
1007
+ * The ID of the notification
1008
+ */
1009
+ NotificationId: string;
1010
+ };
1011
+
1012
+ /**
1013
+ * Type for the notification item
1014
+ *
1015
+ * @since 1.120.0
1016
+ */
1017
+ type NotificationItem = {
1018
+ /**
1019
+ * The ID of the notification.
1020
+ */
1021
+ Id: string;
1022
+ /**
1023
+ * The ID of the origin, can be a combination of system and client or the value `LOCAL`.
1024
+ */
1025
+ OriginId: string;
1026
+ /**
1027
+ * The date and time the notification was created.
1028
+ */
1029
+ CreatedAt: string;
1030
+ /**
1031
+ * Indicates whether the notification is actionable.
1032
+ */
1033
+ IsActionable: boolean;
1034
+ /**
1035
+ * Indicates whether the notification has been read.
1036
+ */
1037
+ IsRead: boolean;
1038
+ /**
1039
+ * Indicates whether the notification can be grouped.
1040
+ */
1041
+ IsGroupable: boolean;
1042
+ /**
1043
+ * Indicates whether the notification is a group header.
1044
+ */
1045
+ IsGroupHeader: boolean;
1046
+ /**
1047
+ * The action to be executed when the notification is clicked.
1048
+ */
1049
+ NavigationTargetAction: string;
1050
+ /**
1051
+ * The object to be navigated to when the notification is clicked.
1052
+ */
1053
+ NavigationTargetObject: string;
1054
+ /**
1055
+ * The intent for navigation when the notification is clicked.
1056
+ */
1057
+ NavigationIntent: string;
1058
+ /**
1059
+ * The ID for the notification type specified in `NotificationTypeKey`.
1060
+ */
1061
+ NotificationTypeId: string;
1062
+ /**
1063
+ * The key of the notification type.
1064
+ */
1065
+ NotificationTypeKey: string;
1066
+ /**
1067
+ * The ID of the parent notification.
1068
+ */
1069
+ ParentId: string;
1070
+ /**
1071
+ * The priority of the notification.
1072
+ */
1073
+ Priority: sap.ushell.services.NotificationsV2.Priority;
1074
+ /**
1075
+ * The sensitive text of the notification.
1076
+ */
1077
+ SensitiveText: string;
1078
+ /**
1079
+ * The text of the notification.
1080
+ */
1081
+ Text: string;
1082
+ /**
1083
+ * The header text of the notification group.
1084
+ */
1085
+ GroupHeaderText: string;
1086
+ /**
1087
+ * The number of notifications.
1088
+ */
1089
+ NotificationCount: number;
1090
+ /**
1091
+ * The subtitle of the notification.
1092
+ */
1093
+ SubTitle: string;
1094
+ /**
1095
+ * The description of the notification type.
1096
+ */
1097
+ NotificationTypeDesc: string;
1098
+ /**
1099
+ * The actor of the notification.
1100
+ */
1101
+ Actor: sap.ushell.services.NotificationsV2.Actor;
1102
+ /**
1103
+ * The navigation target parameters of the notification.
1104
+ */
1105
+ NavigationTargetParams: sap.ushell.services.NotificationsV2.NotificationTargetParameter[];
1106
+ /**
1107
+ * The actions of the notification.
1108
+ */
1109
+ Actions: sap.ushell.services.NotificationsV2.Action[];
1110
+ };
1111
+
1112
+ /**
1113
+ * Type for notification target parameters.
1114
+ *
1115
+ * @since 1.120.0
1116
+ */
1117
+ type NotificationTargetParameter = {
1118
+ /**
1119
+ * The ID of the notification.
1120
+ */
1121
+ NotificationId: string;
1122
+ /**
1123
+ * The key of the notification target parameter.
1124
+ */
1125
+ Key: string;
1126
+ /**
1127
+ * The value of the notification target parameter.
1128
+ */
1129
+ Value: string;
1130
+ };
539
1131
  }
540
1132
 
541
1133
  namespace Personalization {
@@ -1372,7 +1964,7 @@ declare namespace sap {
1372
1964
  *
1373
1965
  * @returns Resolves with undefined on success or rejects on failure
1374
1966
  */
1375
- load(): Promise<undefined>;
1967
+ load(): Promise<any>;
1376
1968
  /**
1377
1969
  * Save the current container data at the underlying storage asynchronously at the earlies nDelayInMilliseconds
1378
1970
  * seconds before. The current state is serialized.
@@ -1727,7 +2319,7 @@ declare namespace sap {
1727
2319
  /**
1728
2320
  * Context
1729
2321
  */
1730
- oContextContainer: object
2322
+ oContextContainer: sap.ushell.services.PersonalizationV2.ContextContainer
1731
2323
  );
1732
2324
 
1733
2325
  /**
@@ -1834,6 +2426,148 @@ declare namespace sap {
1834
2426
  shared?: boolean;
1835
2427
  };
1836
2428
  }
2429
+
2430
+ namespace SpaceContent {
2431
+ /**
2432
+ * Type for the value of a UserDefault parameter. It contains either a value, an extendedValue, or both.
2433
+ *
2434
+ * Example:
2435
+ * ```javascript
2436
+ *
2437
+ * {
2438
+ * "value": "ZMAT1",
2439
+ * "extendedValue": {
2440
+ * "Ranges": [
2441
+ * {
2442
+ * "Sign": "I",
2443
+ * "Option": "BT",
2444
+ * "Low": "A*",
2445
+ * "High": "F*"
2446
+ * }
2447
+ * ]
2448
+ * }
2449
+ * }
2450
+ * ```
2451
+ *
2452
+ *
2453
+ * @since 1.120.0
2454
+ */
2455
+ type ParameterValue = {
2456
+ /**
2457
+ * The value of a single-parameter.
2458
+ */
2459
+ value?: string;
2460
+ /**
2461
+ * Object containing the ranges for a range-parameter.
2462
+ */
2463
+ extendedValue?: {
2464
+ Ranges: sap.ushell.services.SpaceContent.Range[];
2465
+ };
2466
+ };
2467
+
2468
+ /**
2469
+ * Type for describing a parameter value range.
2470
+ *
2471
+ * @since 1.120.0
2472
+ */
2473
+ type Range = {
2474
+ /**
2475
+ * The sign value of the range.
2476
+ */
2477
+ Sign: string;
2478
+ /**
2479
+ * The option value of the range.
2480
+ */
2481
+ Option: string;
2482
+ /**
2483
+ * The low value of the range.
2484
+ */
2485
+ Low: string;
2486
+ /**
2487
+ * The high value of the range.
2488
+ */
2489
+ High: string;
2490
+ };
2491
+ }
2492
+
2493
+ namespace URLParsing {
2494
+ /**
2495
+ * Type for decomposedHash
2496
+ *
2497
+ * @since 1.120.0
2498
+ */
2499
+ type decomposedHash = {
2500
+ /**
2501
+ * the semantic object
2502
+ */
2503
+ semanticObject: string;
2504
+ /**
2505
+ * the action
2506
+ */
2507
+ action: string;
2508
+ /**
2509
+ * the raw context string
2510
+ */
2511
+ contextRaw: string;
2512
+ /**
2513
+ * the parameters
2514
+ */
2515
+ params: Record<string, string[]>;
2516
+ };
2517
+
2518
+ /**
2519
+ * Type for splitHash
2520
+ *
2521
+ * @since 1.120.0
2522
+ */
2523
+ type splitHash = {
2524
+ /**
2525
+ * the shell part of the hash
2526
+ */
2527
+ shellPart: sap.ui.core.URI;
2528
+ /**
2529
+ * the app specific route part of the hash
2530
+ */
2531
+ appSpecificRoute: sap.ui.core.URI;
2532
+ };
2533
+
2534
+ /**
2535
+ * Type for Url value
2536
+ *
2537
+ * @since 1.120.0
2538
+ */
2539
+ type URLValue = string | int;
2540
+ }
2541
+
2542
+ namespace UserInfo {
2543
+ /**
2544
+ * Type for an object representing data about the user: ID, first name, last name, full name, e-mail address.
2545
+ *
2546
+ * @since 1.120.0
2547
+ */
2548
+ type ShellUserInfo = {
2549
+ /**
2550
+ * The user id.
2551
+ */
2552
+ id: string;
2553
+ /**
2554
+ * The user's email address.
2555
+ */
2556
+ email: string;
2557
+ /**
2558
+ * The user's first name.
2559
+ */
2560
+ firstName: string;
2561
+ /**
2562
+ * The user's last name.
2563
+ */
2564
+ lastName: string;
2565
+ /**
2566
+ * The user's full name.
2567
+ */
2568
+ fullName: string;
2569
+ };
2570
+ }
1837
2571
  /**
1838
2572
  * The unified shell's AppConfiguration service as a singleton object.
1839
2573
  *
@@ -1928,15 +2662,18 @@ declare namespace sap {
1928
2662
  *
1929
2663
  * @since 1.38
1930
2664
  */
1931
- attachAppLoaded(
2665
+ attachAppLoaded<ObjectToBePassedToHandler extends object>(
1932
2666
  /**
1933
2667
  * An object that will be passed to the handler along with the event object when the event is fired.
1934
2668
  */
1935
- oData: object,
2669
+ oData: ObjectToBePassedToHandler,
1936
2670
  /**
1937
2671
  * The handler function to call when the event occurs.
1938
2672
  */
1939
- fnFunction: Function,
2673
+ fnFunction: (
2674
+ p1: sap.ui.base.Event,
2675
+ p2: ObjectToBePassedToHandler
2676
+ ) => void,
1940
2677
  /**
1941
2678
  * The object that wants to be notified when the event occurs (this context within the handler function).
1942
2679
  */
@@ -1958,43 +2695,18 @@ declare namespace sap {
1958
2695
  oListener: object
1959
2696
  ): void;
1960
2697
  /**
1961
- * Returns information about the currently running application.
1962
- *
1963
- * The function returns an object with following parameters:
1964
- * - applicationType: “UI5|WDA|NWBC|URL|TR”
1965
- * - componentInstance: reference to component (only for applicationType "UI5").
1966
- * - homePage: `true` when root intent (normally #Shell-home) or Appfinder (#Shell-appfinder) is currently
1967
- * displayed.
1968
- * - getTechnicalParameter: `function` that returns the value of a technical parameter for the given
1969
- * application. This method is for SAP internal usage only.
1970
- * - getIntent: `function` that returns a `Promise` that resolves with the current shell hash as an `Object`.
1971
- * See {@link sap.ushell.services.URLParsing#parseShellHash} for details. This property is for SAP-internal
1972
- * use only!
1973
- * - getInfo: `function` that is called with an `Array` with following optional elements of type `String`
1974
- *
1975
- * ` productName ` A human readable free form text maintained on the platform where FLP runs, and identifying
1976
- * the current product.
1977
- * - ` theme ` Current FLP theme. Includes the path to the theme resources if the theme is not an sap
1978
- * theme (does not start with sap_)
1979
- * - ` languageTag ` Current Language (BCP47 format)
1980
- * - ` appIntent ` Intent that was used to launch the application (including parameters)
1981
- * - ` appFrameworkId `ID of the framework
1982
- * - ` technicalAppComponentId ` Identifier of the component that implements the base application.
1983
- * - ` appId ` Universal stable logical identifier of the application across the whole content.
1984
- * - ` appVersion ` Version of the app
1985
- * - ` appSupportInfo ` The name of an organizational component that handles support incidents.
1986
- * - ` appFrameworkVersion ` Version of the framework The `function` returns a `Promise` that
1987
- * resolves with an `Object` with properties corresponding to the elements of the `Array` passed as input.
1988
- * Each of these properties holds its value or undefined if not configured.
1989
- *
1990
- * **Note:** Return value is only valid after app is loaded. See {@link #attachAppLoaded} for details. Before
1991
- * an app is loaded, `undefined` is returned.
2698
+ * Returns information about the currently running application Information object about currently running
2699
+ * application or `undefined` if no application is running.
1992
2700
  *
1993
2701
  * @since 1.38
1994
2702
  *
1995
2703
  * @returns Information object about currently running application or `undefined` if no application is running.
2704
+ * **Note:** Return value is only valid after app is loaded. See {@link #attachAppLoaded} for details. Before
2705
+ * an app is loaded, `undefined` is returned.
1996
2706
  */
1997
- getCurrentApplication(): object | undefined;
2707
+ getCurrentApplication():
2708
+ | sap.ushell.services.AppLifeCycle.CurrentApplication
2709
+ | undefined;
1998
2710
  }
1999
2711
  /**
2000
2712
  * The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
@@ -2319,110 +3031,27 @@ declare namespace sap {
2319
3031
  * @since 1.119.0
2320
3032
  */
2321
3033
  class BookmarkV2 extends sap.ushell.services.Service {
2322
- /**
2323
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2324
- */
2325
- protected constructor();
2326
-
2327
- /**
2328
- * Adds a bookmark tile to the provided content nodes.
2329
- * See:
2330
- * sap.ushell.services.URLParsing#getShellHash
2331
- *
2332
- * @since 1.119.0
2333
- *
2334
- * @returns A `Promise` which resolves on success, but rejects with a reason-message on failure to add the
2335
- * bookmark to the specified or implied content node. The promise gets resolved if personalization is disabled.
2336
- */
2337
- addBookmark(
2338
- /**
2339
- * Bookmark parameters. In addition to title and URL, a bookmark might allow further settings, such as an
2340
- * icon or a subtitle. Which settings are supported depends on the environment in which the application
2341
- * is running. Unsupported parameters will be ignored.
2342
- */
2343
- oParameters: {
2344
- /**
2345
- * The title of the bookmark.
2346
- */
2347
- title: string;
2348
- /**
2349
- * The target intent or URL of the bookmark. If the target app runs in the current shell, the URL has to
2350
- * be a valid intent, i.e. in the format `"#SO-Action?P1=a&P2=x&/route?RPV=1"`.
2351
- */
2352
- url: string;
2353
- /**
2354
- * The optional icon URL of the bookmark (e.g. `"sap-icon://home"`).
2355
- */
2356
- icon?: string;
2357
- /**
2358
- * The information text of the bookmark.
2359
- */
2360
- info?: string;
2361
- /**
2362
- * The subtitle of the bookmark.
2363
- */
2364
- subtitle?: string;
2365
- /**
2366
- * The URL to a REST or OData service that provides some dynamic information for the bookmark.
2367
- *
2368
- * **Semantic Date Ranges:**
2369
- *
2370
- * You can use placeholders for dynamic dates in the query parameters of the service URL. This can be used
2371
- * to create KPI tiles based on user entries in control {@link sap.m.DynamicDateRange}, where it is possible
2372
- * to specify dynamic dates like YESTERDAY or THISYEAR.
2373
- *
2374
- * The placeholder format looks like this: {Edm.<type>%%DynamicDate.<operator>.<value1>.<value2>.<position>%%}
2375
- *
2376
- *
2377
- * - <type>: The Edm Type of the parameter. Supported types are String, DateTime and DateTimeOffset
2378
- * for OData V2 and Date and DateTimeOffset for OData V4.
2379
- * - <operator>, <value1>, <value2>: Possible values are the ones that can be used in
2380
- * {@link sap.m.DynamicDateRange#toDates} to create a date range.
2381
- * - <position>: Possible values are 'start' and 'end' which mark the start or end of the interval
2382
- * specified by the operator.
2383
- *
2384
- * Examples:
2385
- * - /a/url/$count?$filter=(testDate ge {Edm.DateTimeOffset%DynamicDate.YESTERDAY.start%} and testDate
2386
- * le {Edm.DateTimeOffset%DynamicDate.YESTERDAY.end%})
2387
- * - /a/url/$count?$filter=(testDate ge {Edm.DateTime%DynamicDate.THISYEAR.start%} and testDate le {Edm.DateTime%DynamicDate.THISYEAR.end%})
2388
- *
2389
- * - /a/url/$count?$filter=(testDate ge {Edm.Date%DynamicDate.TODAYFROMTO.1.5.start%} and testDate le
2390
- * {Edm.Date%DynamicDate.TODAYFROMTO.1.5.end%})
2391
- *
2392
- * Hint: Check the debug log when displaying the resulting KPI tiles to get more information about the resolution
2393
- * of the placeholders.
2394
- */
2395
- serviceUrl?: string;
2396
- /**
2397
- * Metadata for parameter serviceUrl. Mandatory to specify if parameter serviceURL contains semantic date
2398
- * ranges. This does not influence the data source of the app itself.
2399
- *
2400
- * Specify the data source as follows:
2401
- * ```javascript
2402
- *
2403
- * {
2404
- * type: "OData",
2405
- * settings: {
2406
- * odataVersion: "4.0"
2407
- * }
2408
- * }
2409
- * ```
2410
- *
2411
- *
2412
- *
2413
- * type: The type of the serviceURL's service. Only "OData" is supported. odataVersion: The OData version
2414
- * of parameter serviceURL. Valid values are "2.0" and "4.0".
2415
- */
2416
- dataSource?: object;
2417
- /**
2418
- * The refresh interval for the `serviceUrl` in seconds.
2419
- */
2420
- serviceRefreshInterval?: string;
2421
- /**
2422
- * The unit for the number retrieved from `serviceUrl`.
2423
- */
2424
- numberUnit?: string;
2425
- },
3034
+ /**
3035
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3036
+ */
3037
+ protected constructor();
3038
+
3039
+ /**
3040
+ * Adds a bookmark tile to the provided content nodes.
3041
+ * See:
3042
+ * sap.ushell.services.URLParsing#getShellHash
3043
+ *
3044
+ * @since 1.119.0
3045
+ *
3046
+ * @returns A promise which resolves on success
3047
+ */
3048
+ addBookmark(
3049
+ /**
3050
+ * Bookmark parameters. In addition to title and URL, a bookmark might allow further settings, such as an
3051
+ * icon or a subtitle. Which settings are supported depends on the environment in which the application
3052
+ * is running. Unsupported parameters will be ignored.
3053
+ */
3054
+ oParameters: sap.ushell.services.BookmarkV2.BookmarkParameters,
2426
3055
  /**
2427
3056
  * Either a content node or an array of content nodes (see {@link #getContentNodes}). If not provided, the
2428
3057
  * bookmark will be added to the default page.
@@ -2452,12 +3081,15 @@ declare namespace sap {
2452
3081
  /**
2453
3082
  * The URL of the bookmarks to be counted, exactly as specified to {@link #addBookmark}.
2454
3083
  */
2455
- sUrl: string,
3084
+ sUrl: /* was: sap.ushell.services.navigation.TargetIntent */
3085
+ | any
3086
+ | sap.ui.core.URI,
2456
3087
  /**
2457
- * The Content Provider ID.
3088
+ * **SAP internal usage only** The contentProviderId or undefined outside the cFLP. The Content Provider
3089
+ * ID.
2458
3090
  */
2459
- sContentProviderId: string
2460
- ): Promise<any>;
3091
+ sContentProviderId?: string
3092
+ ): Promise<int>;
2461
3093
  /**
2462
3094
  * Deletes **all** bookmarks pointing to the given URL from all of the user's pages.
2463
3095
  * See:
@@ -2474,12 +3106,14 @@ declare namespace sap {
2474
3106
  /**
2475
3107
  * The URL of the bookmarks to be deleted, exactly as specified to {@link #addBookmark}.
2476
3108
  */
2477
- sUrl: string,
3109
+ sUrl: /* was: sap.ushell.services.navigation.TargetIntent */
3110
+ | any
3111
+ | sap.ui.core.URI,
2478
3112
  /**
2479
- * The contentProviderId or undefined outside the cFLP
3113
+ * **SAP internal usage only** The contentProviderId or undefined outside the cFLP.
2480
3114
  */
2481
3115
  sContentProviderId?: string
2482
- ): Promise<any>;
3116
+ ): Promise<int>;
2483
3117
  /**
2484
3118
  * Returns available content nodes.
2485
3119
  *
@@ -2515,65 +3149,12 @@ declare namespace sap {
2515
3149
  * an icon or a subtitle. Which settings are supported depends on the environment in which the application
2516
3150
  * is running. Unsupported parameters will be ignored.
2517
3151
  */
2518
- oParameters: {
2519
- /**
2520
- * The title of the bookmark.
2521
- */
2522
- title: string;
2523
- /**
2524
- * The target URL or intent of the bookmark. If the target application shall run in the current shell, the
2525
- * URL has to be a valid intent, i.e. in the format like `"#SO-Action?P1=a&P2=x&/route?RPV=1"`.
2526
- */
2527
- url: string;
2528
- /**
2529
- * The optional icon URL of the bookmark (e.g. `"sap-icon://home"`).
2530
- */
2531
- icon?: string;
2532
- /**
2533
- * The information text of the bookmark.
2534
- */
2535
- info?: string;
2536
- /**
2537
- * The subtitle of the bookmark.
2538
- */
2539
- subtitle?: string;
2540
- /**
2541
- * The URL to a REST or OData service that provides some dynamic information for the bookmark.
2542
- */
2543
- serviceUrl?: string;
2544
- /**
2545
- * Metadata for parameter serviceUrl. Mandatory to specify if parameter serviceURL contains semantic date
2546
- * ranges. This does not influence the data source of the app itself.
2547
- */
2548
- dataSource?: {
2549
- /**
2550
- * The type of the serviceURL's service. Only "OData" is supported.
2551
- */
2552
- type?: string;
2553
- /**
2554
- * Additional settings for the data source.
2555
- */
2556
- settings?: {
2557
- /**
2558
- * The OData version of parameter serviceURL. Valid values are "2.0" and "4.0".
2559
- */
2560
- odataVersion?: object;
2561
- };
2562
- };
2563
- /**
2564
- * The refresh interval for the `serviceUrl` in seconds.
2565
- */
2566
- serviceRefreshInterval?: string;
2567
- /**
2568
- * The unit for the number retrieved from `serviceUrl`.
2569
- */
2570
- numberUnit?: string;
2571
- },
3152
+ oParameters: sap.ushell.services.BookmarkV2.BookmarkParameters,
2572
3153
  /**
2573
- * The contentProviderId or undefined outside the cFLP
3154
+ * **SAP internal usage only** The contentProviderId or undefined outside the cFLP.
2574
3155
  */
2575
3156
  sContentProviderId?: string
2576
- ): Promise<any>;
3157
+ ): Promise<int>;
2577
3158
  }
2578
3159
  /**
2579
3160
  * The unified shell's Configuration service. Allows attaching to **selected** launchpad configuration settings
@@ -5537,7 +6118,7 @@ declare namespace sap {
5537
6118
  * The ID of the notification whose action is being executed
5538
6119
  */
5539
6120
  sNotificationId: string
5540
- ): Promise<undefined>;
6121
+ ): Promise<any>;
5541
6122
  /**
5542
6123
  * Launches a notification action oData call.
5543
6124
  * After launching the action, the function gets updated notification data in order to push the updated
@@ -5555,14 +6136,17 @@ declare namespace sap {
5555
6136
  * The ID of the action that is being executed
5556
6137
  */
5557
6138
  sActionId: string
5558
- ): Promise<any>;
6139
+ ): Promise<sap.ushell.services.NotificationsV2.BulkAction[]>;
5559
6140
  /**
5560
6141
  * Returns the notifications of the user sorted by type include the group headers and the notifications
5561
6142
  *
5562
6143
  *
5563
- * @returns Promise for all notification items
6144
+ * @returns Promise for all notification items The notifications items have value true for attribute group
6145
+ * header if they are group headers.
5564
6146
  */
5565
- getNotificationsByTypeWithGroupHeaders(): Promise<any>;
6147
+ getNotificationsByTypeWithGroupHeaders(): Promise<
6148
+ sap.ushell.services.NotificationsV2.NotificationItem[]
6149
+ >;
5566
6150
  /**
5567
6151
  * Returns the number of notifications
5568
6152
  * e.g. Notifications for user.
@@ -5575,9 +6159,11 @@ declare namespace sap {
5575
6159
  * Returns the group headers of the user notifications
5576
6160
  *
5577
6161
  *
5578
- * @returns Promise for all group headers
6162
+ * @returns Promise for all group headers The notifications items have value true for attribute group header
5579
6163
  */
5580
- getNotificationsGroupHeaders(): Promise<any>;
6164
+ getNotificationsGroupHeaders(): Promise<
6165
+ sap.ushell.services.NotificationsV2.NotificationItem[]
6166
+ >;
5581
6167
  /**
5582
6168
  * Returns the number of unseen notifications
5583
6169
  * e.g. Notifications that the user hasn't seen yet.
@@ -5585,7 +6171,7 @@ declare namespace sap {
5585
6171
  *
5586
6172
  * @returns Promise resolves with the number of unread notifications of the user
5587
6173
  */
5588
- getUnseenNotificationsCount(): Promise<any>;
6174
+ getUnseenNotificationsCount(): Promise<int>;
5589
6175
  /**
5590
6176
  * Initializes the notification service
5591
6177
  *
@@ -5631,7 +6217,7 @@ declare namespace sap {
5631
6217
  * The ID of the notification whose action is being executed
5632
6218
  */
5633
6219
  sNotificationId: string
5634
- ): Promise<undefined>;
6220
+ ): Promise<any>;
5635
6221
  /**
5636
6222
  * Mark all notifications as seen.
5637
6223
  * the main use-case is when the user navigated to the notification center and sees all the pending notifications.
@@ -6700,50 +7286,35 @@ declare namespace sap {
6700
7286
  *
6701
7287
  * @since 1.20.0
6702
7288
  *
6703
- * @returns `ABC=1&ABC=1%202DEF=4` Note that the result is *not* prefixed with a "?", parameter values are
6704
- * encodeURIComponent encoded.
7289
+ * @returns * @returns {sap.ui.core.URI} The parameter string, e.g. `ABC=1&ABC=1%202&DEF=4`. Note that the
7290
+ * result is *not* prefixed with a "?", parameter values are encodeURIComponent encoded.
6705
7291
  */
6706
7292
  paramsToString(
6707
7293
  /**
6708
- * any value { ABC : [1,"1 2"], DEF : ["4"]}
7294
+ * The parameters to combine into the parameter String, e.g. `{ ABC : [1,"1 2"], DEF : ["4"]}`
6709
7295
  */
6710
- oParams: object
6711
- ): string;
7296
+ oParams: Record<string, sap.ushell.services.URLParsing.URLValue[]>
7297
+ ): sap.ui.core.URI;
6712
7298
  /**
6713
- * parse parameters from a URI query string (starting with ?) into a parameter object
7299
+ * This method parses parameters from a URI query string (starting with ?) and puts the result into a parameter
7300
+ * object.
6714
7301
  *
6715
7302
  * @since 1.20.0
6716
7303
  *
6717
- * @returns oParams, any value { ABC : ["1", "1 2DEF=4"]}
7304
+ * @returns The parsed parameters, e.g. { ABC : ["1", "1 2"], DEF : ["4"]}.
6718
7305
  */
6719
7306
  parseParameters(
6720
7307
  /**
6721
- * Parameter string, e.g. `?ABC=1&ABC=1%202DEF=4`
7308
+ * Parameter string, e.g. `?ABC=1&ABC=1%202&DEF=4`
6722
7309
  */
6723
- sParams: string
6724
- ): object;
7310
+ sParams: sap.ui.core.URI
7311
+ ): Record<string, sap.ushell.services.URLParsing.URLValue[]>;
6725
7312
  /**
6726
7313
  * Decompose a shell hash into the respective parts
6727
7314
  *
6728
7315
  * @since 1.16.0
6729
7316
  *
6730
7317
  * @returns `undefined` if not a parsable hash
6731
- *
6732
- * ```javascript
6733
- *
6734
- * {
6735
- * semanticObject : string,
6736
- *
6737
- * action : string,
6738
- *
6739
- * contextRaw : string,
6740
- *
6741
- * params : MapObject,
6742
- *
6743
- * appSpecificRoute : string
6744
- *
6745
- * }
6746
- * ```
6747
7318
  * Note that params always has an Array for each parameter value!
6748
7319
  */
6749
7320
  parseShellHash(
@@ -6752,8 +7323,8 @@ declare namespace sap {
6752
7323
  *
6753
7324
  * e.g. `"#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
6754
7325
  */
6755
- sHash: string
6756
- ): object;
7326
+ sHash: sap.ushell.services.Navigation.TargetIntent
7327
+ ): sap.ushell.services.URLParsing.decomposedHash;
6757
7328
  /**
6758
7329
  * split a Unified Shell compliant hash into an Object containing a shell specific part and an app specific
6759
7330
  * parts
@@ -6773,11 +7344,11 @@ declare namespace sap {
6773
7344
  */
6774
7345
  splitHash(
6775
7346
  /**
6776
- * Hash part of a shell conformant URL #SO-Action~Context?P1=a&P2=x&/route?RPV=1 the hash part
6777
- * of an URL, e.g. "#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
7347
+ * The hash part of a shell conformant URL. It has to have the following format: #SO-Action~Context?P1=a&P2=x&/route?RPV=1
7348
+ * Here is an example for the hash part of an URL: "#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
6778
7349
  */
6779
- sHash: string
6780
- ): object;
7350
+ sHash: sap.ushell.services.Navigation.TargetIntent
7351
+ ): sap.ushell.services.URLParsing.splitHash;
6781
7352
  }
6782
7353
  /**
6783
7354
  * A UShell service for tracking business flows and user actions.
@@ -6933,20 +7504,29 @@ declare namespace sap {
6933
7504
  */
6934
7505
  getLastName(): string;
6935
7506
  /**
6936
- * Returns an object representing data about the user: ID, first name, last name, full name, e-mail address.
7507
+ * Returns an object representing data about the user.
6937
7508
  *
6938
7509
  * @since 1.71.0
6939
7510
  *
6940
- * @returns object providing information about the logged-in user: ID, first name, last name, full name,
6941
- * e-mail address
7511
+ * @returns Object providing information about the logged-in user.
6942
7512
  */
6943
- getShellUserInfo(): Promise<any>;
7513
+ getShellUserInfo(): Promise<sap.ushell.services.UserInfo.ShellUserInfo>;
6944
7514
  }
6945
7515
  }
6946
7516
 
6947
7517
  namespace components {
6948
7518
  namespace factsheet {
6949
7519
  namespace controls {
7520
+ /**
7521
+ * Describes the settings that can be provided to the PictureTile constructor.
7522
+ *
7523
+ * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead.
7524
+ *
7525
+ * PictureTile is used in PictureViewer control and is not meant to be consumed outside of PictureViewer
7526
+ * usage. PictureViewer was replacing the sap.m.Carousel as it wasn't supporting some versions of MS Internet
7527
+ * Explorer. Now, the sap.m.Carousel is fully functional, please use sap.m.Carousel instead. This control
7528
+ * will not be supported anymore.
7529
+ */
6950
7530
  interface $PictureTileSettings extends sap.m.$CustomTileSettings {
6951
7531
  height?:
6952
7532
  | sap.ui.core.CSSSize
@@ -6965,6 +7545,13 @@ declare namespace sap {
6965
7545
  pictureDelete?: (oEvent: sap.ui.base.Event) => void;
6966
7546
  }
6967
7547
 
7548
+ /**
7549
+ * Describes the settings that can be provided to the PictureViewer constructor.
7550
+ *
7551
+ * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead. PictureViewer was replacing the
7552
+ * Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully
7553
+ * functional, please use sap.m.Carousel instead. This control will not be supported anymore.
7554
+ */
6968
7555
  interface $PictureViewerSettings
6969
7556
  extends sap.m.$TileContainerSettings {
6970
7557
  /**
@@ -6990,6 +7577,14 @@ declare namespace sap {
6990
7577
  pictureDeleted?: (oEvent: sap.ui.base.Event) => void;
6991
7578
  }
6992
7579
 
7580
+ /**
7581
+ * Describes the settings that can be provided to the PictureViewerItem constructor.
7582
+ *
7583
+ * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead. PictureViewerItem is used in PictureViewer
7584
+ * control and is not meant to be consumed outside of PictureViewer usage. PictureViewer was replacing the
7585
+ * Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully
7586
+ * functional, please use sap.m.Carousel instead. This control will not be supported anymore.
7587
+ */
6993
7588
  interface $PictureViewerItemSettings
6994
7589
  extends sap.ui.core.$ControlSettings {
6995
7590
  src?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
@@ -6997,8 +7592,14 @@ declare namespace sap {
6997
7592
  image?: sap.m.Image;
6998
7593
  }
6999
7594
 
7595
+ /**
7596
+ * Parameters of the PictureTile#pictureDelete event.
7597
+ */
7000
7598
  interface PictureTile$PictureDeleteEventParameters {}
7001
7599
 
7600
+ /**
7601
+ * Parameters of the PictureViewer#pictureDeleted event.
7602
+ */
7002
7603
  interface PictureViewer$PictureDeletedEventParameters {}
7003
7604
 
7004
7605
  /**
@@ -7670,11 +8271,17 @@ declare namespace sap {
7670
8271
  ): sap.ushell.components.factsheet.controls.PictureViewerItem;
7671
8272
  }
7672
8273
 
8274
+ /**
8275
+ * Event object of the PictureTile#pictureDelete event.
8276
+ */
7673
8277
  type PictureTile$PictureDeleteEvent = sap.ui.base.Event<
7674
8278
  PictureTile$PictureDeleteEventParameters,
7675
8279
  PictureTile
7676
8280
  >;
7677
8281
 
8282
+ /**
8283
+ * Event object of the PictureViewer#pictureDeleted event.
8284
+ */
7678
8285
  type PictureViewer$PictureDeletedEvent = sap.ui.base.Event<
7679
8286
  PictureViewer$PictureDeletedEventParameters,
7680
8287
  PictureViewer
@@ -7707,6 +8314,11 @@ declare namespace sap {
7707
8314
 
7708
8315
  namespace renderers {
7709
8316
  namespace fiori2 {
8317
+ /**
8318
+ * Describes the settings that can be provided to the Renderer constructor.
8319
+ *
8320
+ * @deprecated (since 1.120.0) - Please use {@link sap.ushell.services.Extension} instead.
8321
+ */
7710
8322
  interface $RendererSettings extends sap.ui.core.$UIComponentSettings {}
7711
8323
 
7712
8324
  /**
@@ -9124,6 +9736,11 @@ declare namespace sap {
9124
9736
 
9125
9737
  namespace ui {
9126
9738
  namespace appfinder {
9739
+ /**
9740
+ * Describes the settings that can be provided to the AppBox constructor.
9741
+ *
9742
+ * @deprecated (since 1.120)
9743
+ */
9127
9744
  interface $AppBoxSettings extends sap.ui.core.$ControlSettings {}
9128
9745
 
9129
9746
  /**
@@ -9157,6 +9774,9 @@ declare namespace sap {
9157
9774
  }
9158
9775
 
9159
9776
  namespace footerbar {
9777
+ /**
9778
+ * Describes the settings that can be provided to the AddBookmarkButton constructor.
9779
+ */
9160
9780
  interface $AddBookmarkButtonSettings extends sap.m.$ButtonSettings {
9161
9781
  /**
9162
9782
  * A callback function that is called before the save-as-tile dialog is opened.
@@ -9726,6 +10346,9 @@ declare namespace sap {
9726
10346
  }
9727
10347
 
9728
10348
  namespace launchpad {
10349
+ /**
10350
+ * Describes the settings that can be provided to the ActionItem constructor.
10351
+ */
9729
10352
  interface $ActionItemSettings extends sap.m.$ButtonSettings {
9730
10353
  actionType?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
9731
10354
 
@@ -9734,6 +10357,11 @@ declare namespace sap {
9734
10357
  afterRendering?: (oEvent: sap.ui.base.Event) => void;
9735
10358
  }
9736
10359
 
10360
+ /**
10361
+ * Describes the settings that can be provided to the DashboardGroupsContainer constructor.
10362
+ *
10363
+ * @deprecated (since 1.120)
10364
+ */
9737
10365
  interface $DashboardGroupsContainerSettings
9738
10366
  extends sap.ui.core.$ControlSettings {
9739
10367
  /**
@@ -9754,6 +10382,11 @@ declare namespace sap {
9754
10382
  afterRendering?: (oEvent: sap.ui.base.Event) => void;
9755
10383
  }
9756
10384
 
10385
+ /**
10386
+ * Describes the settings that can be provided to the LinkTileWrapper constructor.
10387
+ *
10388
+ * @deprecated (since 1.120)
10389
+ */
9757
10390
  interface $LinkTileWrapperSettings
9758
10391
  extends sap.ui.core.$ControlSettings {
9759
10392
  uuid?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
@@ -9816,27 +10449,56 @@ declare namespace sap {
9816
10449
  showActions?: (oEvent: sap.ui.base.Event) => void;
9817
10450
  }
9818
10451
 
10452
+ /**
10453
+ * Describes the settings that can be provided to the TileState constructor.
10454
+ *
10455
+ * @deprecated (since 1.120)
10456
+ */
9819
10457
  interface $TileStateSettings extends sap.ui.core.$ControlSettings {
9820
10458
  state?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
9821
10459
 
9822
10460
  press?: (oEvent: sap.ui.base.Event) => void;
9823
10461
  }
9824
10462
 
10463
+ /**
10464
+ * Parameters of the ActionItem#afterRendering event.
10465
+ */
9825
10466
  interface ActionItem$AfterRenderingEventParameters {}
9826
10467
 
10468
+ /**
10469
+ * Parameters of the ActionItem#press event.
10470
+ */
9827
10471
  interface ActionItem$PressEventParameters
9828
10472
  extends sap.m.Button$PressEventParameters {}
9829
10473
 
10474
+ /**
10475
+ * Parameters of the DashboardGroupsContainer#afterRendering event.
10476
+ */
9830
10477
  interface DashboardGroupsContainer$AfterRenderingEventParameters {}
9831
10478
 
10479
+ /**
10480
+ * Parameters of the LinkTileWrapper#afterRendering event.
10481
+ */
9832
10482
  interface LinkTileWrapper$AfterRenderingEventParameters {}
9833
10483
 
10484
+ /**
10485
+ * Parameters of the LinkTileWrapper#coverDivPress event.
10486
+ */
9834
10487
  interface LinkTileWrapper$CoverDivPressEventParameters {}
9835
10488
 
10489
+ /**
10490
+ * Parameters of the LinkTileWrapper#press event.
10491
+ */
9836
10492
  interface LinkTileWrapper$PressEventParameters {}
9837
10493
 
10494
+ /**
10495
+ * Parameters of the LinkTileWrapper#showActions event.
10496
+ */
9838
10497
  interface LinkTileWrapper$ShowActionsEventParameters {}
9839
10498
 
10499
+ /**
10500
+ * Parameters of the TileState#press event.
10501
+ */
9840
10502
  interface TileState$PressEventParameters {}
9841
10503
 
9842
10504
  /**
@@ -11276,6 +11938,8 @@ declare namespace sap {
11276
11938
  * Denotes display states of the viewport
11277
11939
  *
11278
11940
  * This enum is part of the 'sap/ushell/library' module export and must be accessed by the property 'ui.launchpad.ViewPortState'.
11941
+ *
11942
+ * @deprecated (since 1.120.0) - The ViewPortState is related to Fiori2 and not used anymore.
11279
11943
  */
11280
11944
  enum ViewPortState {
11281
11945
  /**
@@ -11307,42 +11971,65 @@ declare namespace sap {
11307
11971
  */
11308
11972
  RightCenter = "RightCenter",
11309
11973
  }
11310
-
11974
+ /**
11975
+ * Event object of the ActionItem#afterRendering event.
11976
+ */
11311
11977
  type ActionItem$AfterRenderingEvent = sap.ui.base.Event<
11312
11978
  ActionItem$AfterRenderingEventParameters,
11313
11979
  ActionItem
11314
11980
  >;
11315
11981
 
11982
+ /**
11983
+ * Event object of the ActionItem#press event.
11984
+ */
11316
11985
  type ActionItem$PressEvent = sap.ui.base.Event<
11317
11986
  ActionItem$PressEventParameters,
11318
11987
  ActionItem
11319
11988
  >;
11320
11989
 
11990
+ /**
11991
+ * Event object of the DashboardGroupsContainer#afterRendering event.
11992
+ */
11321
11993
  type DashboardGroupsContainer$AfterRenderingEvent = sap.ui.base.Event<
11322
11994
  DashboardGroupsContainer$AfterRenderingEventParameters,
11323
11995
  DashboardGroupsContainer
11324
11996
  >;
11325
11997
 
11998
+ /**
11999
+ * Event object of the LinkTileWrapper#afterRendering event.
12000
+ */
11326
12001
  type LinkTileWrapper$AfterRenderingEvent = sap.ui.base.Event<
11327
12002
  LinkTileWrapper$AfterRenderingEventParameters,
11328
12003
  LinkTileWrapper
11329
12004
  >;
11330
12005
 
12006
+ /**
12007
+ * Event object of the LinkTileWrapper#coverDivPress event.
12008
+ */
11331
12009
  type LinkTileWrapper$CoverDivPressEvent = sap.ui.base.Event<
11332
12010
  LinkTileWrapper$CoverDivPressEventParameters,
11333
12011
  LinkTileWrapper
11334
12012
  >;
11335
12013
 
12014
+ /**
12015
+ * Event object of the LinkTileWrapper#press event.
12016
+ */
11336
12017
  type LinkTileWrapper$PressEvent = sap.ui.base.Event<
11337
12018
  LinkTileWrapper$PressEventParameters,
11338
12019
  LinkTileWrapper
11339
12020
  >;
11340
12021
 
12022
+ /**
12023
+ * Event object of the LinkTileWrapper#showActions event.
12024
+ */
11341
12025
  type LinkTileWrapper$ShowActionsEvent = sap.ui.base.Event<
11342
12026
  LinkTileWrapper$ShowActionsEventParameters,
11343
12027
  LinkTileWrapper
11344
12028
  >;
11345
12029
 
12030
+ /**
12031
+ * Event object of the TileState#press event.
12032
+ */
11346
12033
  type TileState$PressEvent = sap.ui.base.Event<
11347
12034
  TileState$PressEventParameters,
11348
12035
  TileState
@@ -11350,6 +12037,9 @@ declare namespace sap {
11350
12037
  }
11351
12038
 
11352
12039
  namespace shell {
12040
+ /**
12041
+ * Describes the settings that can be provided to the ToolAreaItem constructor.
12042
+ */
11353
12043
  interface $ToolAreaItemSettings extends sap.ui.core.$ControlSettings {
11354
12044
  /**
11355
12045
  * Icon that is displayed in the item.
@@ -11405,8 +12095,14 @@ declare namespace sap {
11405
12095
  expand?: (oEvent: sap.ui.base.Event) => void;
11406
12096
  }
11407
12097
 
12098
+ /**
12099
+ * Parameters of the ToolAreaItem#expand event.
12100
+ */
11408
12101
  interface ToolAreaItem$ExpandEventParameters {}
11409
12102
 
12103
+ /**
12104
+ * Parameters of the ToolAreaItem#press event.
12105
+ */
11410
12106
  interface ToolAreaItem$PressEventParameters {}
11411
12107
 
11412
12108
  /**
@@ -11799,11 +12495,17 @@ declare namespace sap {
11799
12495
  ): this;
11800
12496
  }
11801
12497
 
12498
+ /**
12499
+ * Event object of the ToolAreaItem#expand event.
12500
+ */
11802
12501
  type ToolAreaItem$ExpandEvent = sap.ui.base.Event<
11803
12502
  ToolAreaItem$ExpandEventParameters,
11804
12503
  ToolAreaItem
11805
12504
  >;
11806
12505
 
12506
+ /**
12507
+ * Event object of the ToolAreaItem#press event.
12508
+ */
11807
12509
  type ToolAreaItem$PressEvent = sap.ui.base.Event<
11808
12510
  ToolAreaItem$PressEventParameters,
11809
12511
  ToolAreaItem
@@ -11874,6 +12576,44 @@ declare namespace sap {
11874
12576
  }
11875
12577
 
11876
12578
  namespace ui5service {
12579
+ namespace ShellUIService {
12580
+ /**
12581
+ * Defines essential information about an app.
12582
+ *
12583
+ * Example:
12584
+ * ```javascript
12585
+ *
12586
+ * {
12587
+ * title: "App 1",
12588
+ * icon: "sap-icon://folder",
12589
+ * subtitle: "go to app 1",
12590
+ * intent: "#Action-toapp1"
12591
+ * }
12592
+ * ```
12593
+ *
12594
+ *
12595
+ * @since 1.120.0
12596
+ */
12597
+ type AppInfo = {
12598
+ /**
12599
+ * The title of the app.
12600
+ */
12601
+ title: string;
12602
+ /**
12603
+ * The icon src representing the app.
12604
+ */
12605
+ icon: string;
12606
+ /**
12607
+ * An optional subtitle of the app.
12608
+ */
12609
+ subtitle?: string;
12610
+ /**
12611
+ * The navigation intent of the app.
12612
+ */
12613
+ intent: string;
12614
+ };
12615
+ }
12616
+
11877
12617
  /**
11878
12618
  * The Unified Shell's ShellUIService service.
11879
12619
  *
@@ -11951,25 +12691,9 @@ declare namespace sap {
11951
12691
  class ShellUIService
11952
12692
  /* was: sap.ui.core.service.Service */ extends Object {
11953
12693
  /**
11954
- * Returns an instance of the ShellUIService. This constructor must only be called internally by the Fiori
11955
- * Launchpad renderer and never by applications.
11956
- *
11957
- * Instead, this service should be consumed by app components as described in the overview section of this
11958
- * class.
12694
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
11959
12695
  */
11960
- constructor(
11961
- /**
11962
- * The context in which the service was instantiated. Must have the format:
11963
- * ```javascript
11964
- *
11965
- * {
11966
- * scopeType: "component",
11967
- * scopeObject: [a UI5 Component in the sap.ushell package]
11968
- * }
11969
- * ```
11970
- */
11971
- oCallerContext: object
11972
- );
12696
+ protected constructor();
11973
12697
 
11974
12698
  /**
11975
12699
  * Creates a new subclass of class sap.ushell.ui5service.ShellUIService with name `sClassName` and enriches
@@ -12017,35 +12741,11 @@ declare namespace sap {
12017
12741
  */
12018
12742
  setHierarchy(
12019
12743
  /**
12020
- * An array representing hierarchies of the currently displayed app. The array should specify title, icon,
12021
- * and navigation intent as shown in the following example:
12022
- *
12023
- *
12024
- * ```javascript
12025
- *
12026
- * [
12027
- * {
12028
- * title: "Main View",
12029
- * icon: "sap-icon://documents",
12030
- * intent: "#Action-sameApp"
12031
- * },
12032
- * {
12033
- * title: "View 2",
12034
- * subtitle: "Application view number 2",
12035
- * intent: "#Action-sameApp&/View2/"
12036
- * },
12037
- * {
12038
- * title: "View 3",
12039
- * subtitle: "Application view number 3",
12040
- * intent: "#Action-sameApp&/View3/"
12041
- * }
12042
- * ]
12043
- * ```
12044
- *
12744
+ * An array representing hierarchies of the currently displayed app.
12045
12745
  *
12046
12746
  * The default app hierarchy is applied if no parameter is given.
12047
12747
  */
12048
- aHierarchyLevels?: object[]
12748
+ aHierarchyLevels?: sap.ushell.ui5service.ShellUIService.AppInfo[]
12049
12749
  ): void;
12050
12750
  /**
12051
12751
  * Used by apps to set related apps. This setting is propagated towards the Shell Header via corresponding
@@ -12055,34 +12755,9 @@ declare namespace sap {
12055
12755
  */
12056
12756
  setRelatedApps(
12057
12757
  /**
12058
- * an array of related apps, for example like:
12059
- *
12060
- *
12061
- * ```javascript
12062
- *
12063
- * [
12064
- * {
12065
- * title: "App 1",
12066
- * icon: "sap-icon://folder",
12067
- * subtitle: "go to app 1",
12068
- * intent: "#Action-toapp1"
12069
- * },
12070
- * {
12071
- * title: "App 2",
12072
- * icon: "sap-icon://folder",
12073
- * subtitle: "go to app 2",
12074
- * intent: "#Action-toapp2"
12075
- * },
12076
- * {
12077
- * title: "App 3",
12078
- * icon: "sap-icon://folder",
12079
- * subtitle: "go to app 3",
12080
- * intent: "#Action-toapp3"
12081
- * }
12082
- * ]
12083
- * ```
12758
+ * An array of related apps.
12084
12759
  */
12085
- aRelatedApps?: object[]
12760
+ aRelatedApps?: sap.ushell.ui5service.ShellUIService.AppInfo[]
12086
12761
  ): void;
12087
12762
  /**
12088
12763
  * Displays the given title in the shell header. This method should not be called if the app calling the
@@ -12662,6 +13337,8 @@ declare namespace sap {
12662
13337
 
12663
13338
  "sap/ushell/services/_Personalization/VariantSet": undefined;
12664
13339
 
13340
+ "sap/ushell/services/_Ui5ComponentLoader/utils": undefined;
13341
+
12665
13342
  "sap/ushell/services/AppConfiguration": undefined;
12666
13343
 
12667
13344
  "sap/ushell/services/AppLifeCycle": undefined;
@@ -12702,6 +13379,8 @@ declare namespace sap {
12702
13379
 
12703
13380
  "sap/ushell/services/NotificationsV2": undefined;
12704
13381
 
13382
+ "sap/ushell/services/Pages": undefined;
13383
+
12705
13384
  "sap/ushell/services/Personalization": undefined;
12706
13385
 
12707
13386
  "sap/ushell/services/personalization/VariantSetAdapter": undefined;