@sapui5/types 1.141.2 → 1.142.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/package.json +1 -1
- package/types/index.d.ts +1 -0
- 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 +1 -1
- package/types/sap.cux.base.d.ts +3 -0
- package/types/sap.esh.search.ui.d.ts +159 -4
- package/types/sap.f.d.ts +1 -1
- package/types/sap.fe.ariba.d.ts +1 -1
- package/types/sap.fe.base.d.ts +1 -1
- package/types/sap.fe.controls.d.ts +1 -1
- package/types/sap.fe.core.d.ts +471 -32
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +2616 -95
- package/types/sap.fe.navigation.d.ts +2 -2
- 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 +79 -11
- package/types/sap.fe.test.d.ts +8 -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 +4 -1
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.m.d.ts +401 -55
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +106 -2
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +13 -3737
- package/types/sap.suite.ui.commons.d.ts +1 -1
- package/types/sap.suite.ui.generic.template.d.ts +28 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +77 -9
- package/types/sap.ui.core.d.ts +1160 -639
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +63 -1
- package/types/sap.ui.fl.d.ts +1 -1
- 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 +100 -94
- package/types/sap.ui.mdc.d.ts +1505 -167
- 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 +13 -41
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +34 -78
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +1 -1
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +1 -1
- package/types/sap.ui.webc.main.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +13 -1
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +335 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
package/types/sap.fe.core.d.ts
CHANGED
|
@@ -1,4 +1,424 @@
|
|
|
1
|
-
//
|
|
1
|
+
// This is autogenerated, do not edit
|
|
2
|
+
|
|
3
|
+
declare module "sap/fe/core/controllerextensions/MessageHandlerOverrides" {
|
|
4
|
+
/**
|
|
5
|
+
* Defines the message details relevant for the MessageButton building block to display a popover.
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type MessageDetail = {
|
|
9
|
+
message: Message;
|
|
10
|
+
groupName?: string;
|
|
11
|
+
activeTitleHandler?: Function;
|
|
12
|
+
};
|
|
13
|
+
import type Message from "sap/ui/core/message/Message";
|
|
14
|
+
export default interface MessageHandlerOverrides {
|
|
15
|
+
/**
|
|
16
|
+
* Allows the consumer of the MessageButton building block to decide which bound messages are shown and how.
|
|
17
|
+
*
|
|
18
|
+
* This hook is called when the MessageButton building block detects a change in the message model.
|
|
19
|
+
* The hooks allow you to define the behavior for messages in the MessageButton building block.
|
|
20
|
+
*
|
|
21
|
+
* Consumers are able to do the following with this hook:
|
|
22
|
+
*
|
|
23
|
+
* 1. Filter out messages so that they are not shown on the message button.
|
|
24
|
+
* 2. Group messages based on their UI.
|
|
25
|
+
* 3. Provide a presser handler if the message should display as a link.
|
|
26
|
+
* @param _messageDetails Object containing the details related to the message.
|
|
27
|
+
* @param _messageDetails.message The message from the message. It must not be modified directly.
|
|
28
|
+
* @param _messageDetails.groupName The group name associated with the current message.
|
|
29
|
+
* @param _messageDetails.activeTitleHandler Function to handle the click event on a message in the MessageButton building block.
|
|
30
|
+
* @returns A promise that must be returned by the overridden method.
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
beforeShowMessageButton(_messageDetails: MessageDetail[]): Promise<void>;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
declare module "sap/fe/core/controllerextensions/EditFlowOverrides" {
|
|
38
|
+
import type { default as Context } from "sap/ui/model/odata/v4/Context";
|
|
39
|
+
export default interface EditFlowOverrides {
|
|
40
|
+
/**
|
|
41
|
+
* This function can be used to intercept the 'Create' action. You can execute custom coding in this function.
|
|
42
|
+
* The framework waits for the returned promise to be resolved before continuing the 'Create' action.
|
|
43
|
+
* If you reject the promise, the 'Create' action is stopped.
|
|
44
|
+
*
|
|
45
|
+
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
46
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
47
|
+
* @param _mParameters Object containing the parameters passed to onBeforeCreate
|
|
48
|
+
* @param _mParameters.contextPath Path pointing to the context on which Create action is triggered
|
|
49
|
+
* @param _mParameters.createParameters Array of values that are filled in the Action Parameter Dialog
|
|
50
|
+
* @returns A promise to be returned by the overridden method. If resolved, the 'Create' action is triggered. If rejected, the 'Create' action is not triggered.
|
|
51
|
+
* @public
|
|
52
|
+
* @since 1.98.0
|
|
53
|
+
*/
|
|
54
|
+
onBeforeCreate(_mParameters?: { contextPath?: string; createParameters?: unknown[] }): Promise<void>;
|
|
55
|
+
/**
|
|
56
|
+
* This function can be used to intercept the 'Edit' action. You can execute custom coding in this function.
|
|
57
|
+
* The framework waits for the returned promise to be resolved before continuing the 'Edit' action.
|
|
58
|
+
* If you reject the promise, the 'Edit' action is stopped and the user stays in display mode.
|
|
59
|
+
*
|
|
60
|
+
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
61
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
62
|
+
* @param _mParameters Object containing the parameters passed to onBeforeEdit
|
|
63
|
+
* @param _mParameters.context Page context that is going to be edited.
|
|
64
|
+
* @returns A promise to be returned by the overridden method. If resolved, the 'Edit' action is triggered. If rejected, the 'Edit' action is not triggered and the user stays in display mode.
|
|
65
|
+
* @public
|
|
66
|
+
* @since 1.98.0
|
|
67
|
+
*/
|
|
68
|
+
onBeforeEdit(_mParameters?: { context?: Context }): Promise<void>;
|
|
69
|
+
/**
|
|
70
|
+
* This function can be used to intercept the 'Save' action. You can execute custom coding in this function.
|
|
71
|
+
* The framework waits for the returned promise to be resolved before continuing the 'Save' action.
|
|
72
|
+
* If you reject the promise, the 'Save' action is stopped and the user stays in edit mode.
|
|
73
|
+
*
|
|
74
|
+
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
75
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
76
|
+
* @param _mParameters Object containing the parameters passed to onBeforeSave
|
|
77
|
+
* @param _mParameters.context Page context that is going to be saved.
|
|
78
|
+
* @returns A promise to be returned by the overridden method. If resolved, the 'Save' action is triggered. If rejected, the 'Save' action is not triggered and the user stays in edit mode.
|
|
79
|
+
* @public
|
|
80
|
+
* @since 1.90.0
|
|
81
|
+
*/
|
|
82
|
+
onBeforeSave(_mParameters?: { context?: Context }): Promise<void>;
|
|
83
|
+
/**
|
|
84
|
+
* This function can be used to intercept the 'Discard' action. You can execute custom coding in this function.
|
|
85
|
+
* The framework waits for the returned promise to be resolved before continuing the 'Discard' action.
|
|
86
|
+
* If you reject the promise, the 'Discard' action is stopped and the user stays in edit mode.
|
|
87
|
+
*
|
|
88
|
+
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
89
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
90
|
+
* @param _mParameters Object containing the parameters passed to onBeforeDiscard
|
|
91
|
+
* @param _mParameters.context Page context that is going to be discarded.
|
|
92
|
+
* @returns A promise to be returned by the overridden method. If resolved, the 'Discard' action is triggered. If rejected, the 'Discard' action is not triggered and the user stays in edit mode.
|
|
93
|
+
* @public
|
|
94
|
+
* @since 1.98.0
|
|
95
|
+
*/
|
|
96
|
+
onBeforeDiscard(_mParameters?: { context?: Context }): Promise<void>;
|
|
97
|
+
/**
|
|
98
|
+
* This function can be used to intercept the 'Delete' action. You can execute custom coding in this function.
|
|
99
|
+
* The framework waits for the returned promise to be resolved before continuing the 'Delete' action.
|
|
100
|
+
* If you reject the promise, the 'Delete' action is stopped.
|
|
101
|
+
*
|
|
102
|
+
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
103
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
104
|
+
* @param _mParameters Object containing the parameters passed to onBeforeDelete
|
|
105
|
+
* @param _mParameters.contexts An array of contexts that are going to be deleted
|
|
106
|
+
* @returns A promise to be returned by the overridden method. If resolved, the 'Delete' action is triggered. If rejected, the 'Delete' action is not triggered.
|
|
107
|
+
* @public
|
|
108
|
+
* @since 1.98.0
|
|
109
|
+
*/
|
|
110
|
+
onBeforeDelete(_mParameters?: { contexts?: Context[] }): Promise<void>;
|
|
111
|
+
/**
|
|
112
|
+
* This function can be used to execute code after the 'Save' action.
|
|
113
|
+
* You can execute custom coding in this function.
|
|
114
|
+
*
|
|
115
|
+
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
116
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
117
|
+
* @param _mParameters Object containing the parameters passed to onAfterSave
|
|
118
|
+
* @param _mParameters.context The context we obtained after saving
|
|
119
|
+
* @returns A promise to be returned by the overridden method. If rejected, any further processing by the framework is stopped.
|
|
120
|
+
* @public
|
|
121
|
+
* @since 1.116.0
|
|
122
|
+
*/
|
|
123
|
+
onAfterSave(_mParameters?: { context?: Context }): Promise<void>;
|
|
124
|
+
/**
|
|
125
|
+
* This function can be used to execute code after the 'Create' action.
|
|
126
|
+
* You can execute custom coding in this function.
|
|
127
|
+
*
|
|
128
|
+
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
129
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
130
|
+
* @param _mParameters Object containing the parameters passed to onAfterCreate
|
|
131
|
+
* @param _mParameters.context The newly created context
|
|
132
|
+
* @returns A promise to be returned by the overridden method. If rejected, any further processing by the framework is stopped.
|
|
133
|
+
* @public
|
|
134
|
+
* @since 1.116.0
|
|
135
|
+
*/
|
|
136
|
+
onAfterCreate(_mParameters?: { context?: Context }): Promise<void>;
|
|
137
|
+
/**
|
|
138
|
+
* This function can be used to execute code after the 'Edit' action.
|
|
139
|
+
* You can execute custom coding in this function.
|
|
140
|
+
*
|
|
141
|
+
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
142
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
143
|
+
* @param _mParameters Object containing the parameters passed to onAfterEdit
|
|
144
|
+
* @param _mParameters.context Page context that is going to be edited.
|
|
145
|
+
* @returns A promise to be returned by the overridden method. If rejected, any further processing by the framework is stopped.
|
|
146
|
+
* @public
|
|
147
|
+
* @since 1.116.0
|
|
148
|
+
*/
|
|
149
|
+
onAfterEdit(_mParameters?: { context?: Context }): Promise<void>;
|
|
150
|
+
/**
|
|
151
|
+
* This function can be used to execute code after the 'Discard' action.
|
|
152
|
+
* You can execute custom coding in this function.
|
|
153
|
+
*
|
|
154
|
+
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
155
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
156
|
+
* @param _mParameters Object containing the parameters passed to onAfterDiscard
|
|
157
|
+
* @param _mParameters.context The context obtained after discarding the object, or undefined if we discarded a new object
|
|
158
|
+
* @returns A promise to be returned by the overridden method. If rejected, any further processing by the framework is stopped.
|
|
159
|
+
* @public
|
|
160
|
+
* @since 1.116.0
|
|
161
|
+
*/
|
|
162
|
+
onAfterDiscard(_mParameters?: { context?: Context }): Promise<void>;
|
|
163
|
+
/**
|
|
164
|
+
* This function can be used to execute code after the 'Delete' action.
|
|
165
|
+
* You can execute custom coding in this function.
|
|
166
|
+
*
|
|
167
|
+
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
168
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
169
|
+
* @param _mParameters Object containing the parameters passed to onAfterDelete
|
|
170
|
+
* @param _mParameters.contexts An array of contexts that are going to be deleted
|
|
171
|
+
* @returns A promise to be returned by the overridden method. If rejected, any further processing by the framework is stopped.
|
|
172
|
+
* @public
|
|
173
|
+
* @since 1.116.0
|
|
174
|
+
*/
|
|
175
|
+
onAfterDelete(_mParameters?: { contexts?: Context[] }): Promise<void>;
|
|
176
|
+
/**
|
|
177
|
+
* This function can be used to execute code on the mass edit save.
|
|
178
|
+
* You can execute custom coding in this function.
|
|
179
|
+
* If you decide to do your own save processing, you can return `true` to prevent the default save behavior.
|
|
180
|
+
*
|
|
181
|
+
* This function is meant to be individually overridden by consuming controllers but not to be called directly.
|
|
182
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.Instead}.
|
|
183
|
+
* @param _mParameters Object containing the parameters passed to customMassEditSave
|
|
184
|
+
* @param _mParameters.aContexts Array containing the selected contexts for the mass edit
|
|
185
|
+
* @param _mParameters.oUpdateData A dictionary containing the propertyPath and its value
|
|
186
|
+
* @returns `true` to prevent the default execution, `false` to keep the standard behavior
|
|
187
|
+
* @public
|
|
188
|
+
* @since 1.130.0
|
|
189
|
+
*/
|
|
190
|
+
customMassEditSave(_mParameters: { aContexts: Context[]; oUpdateData: Record<string, unknown> }): Promise<boolean>;
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
declare module "sap/fe/core/controllerextensions/IntentBasedNavigationOverrides" {
|
|
195
|
+
import type SelectionVariant from "sap/fe/navigation/SelectionVariant";
|
|
196
|
+
export default interface IntentBasedNavigationOverrides {
|
|
197
|
+
/**
|
|
198
|
+
* Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant} related to the intent-based navigation.
|
|
199
|
+
* @param _oSelectionVariant SelectionVariant provided by SAP Fiori elements.
|
|
200
|
+
* @param _oNavigationInfo Object containing intent-based navigation-related info
|
|
201
|
+
* @param _oNavigationInfo.semanticObject Semantic object related to the intent
|
|
202
|
+
* @param _oNavigationInfo.action Action related to the intent
|
|
203
|
+
* @public
|
|
204
|
+
* @since 1.86.0
|
|
205
|
+
*/
|
|
206
|
+
adaptNavigationContext(
|
|
207
|
+
_oSelectionVariant: SelectionVariant,
|
|
208
|
+
_oNavigationInfo: {
|
|
209
|
+
semanticObject: string;
|
|
210
|
+
action: string;
|
|
211
|
+
}
|
|
212
|
+
): void;
|
|
213
|
+
}
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
declare module "sap/fe/core/controllerextensions/PaginatorOverrides" {
|
|
217
|
+
import type { ContextNavigationType } from "sap/fe/core/library";
|
|
218
|
+
import type { default as Context } from "sap/ui/model/odata/v4/Context";
|
|
219
|
+
export default interface PaginatorOverrides {
|
|
220
|
+
/**
|
|
221
|
+
* Returns the updated context after the paginator operation.
|
|
222
|
+
* @param oContext Final context returned after the paginator action
|
|
223
|
+
* @public
|
|
224
|
+
* @since 1.94.0
|
|
225
|
+
*/
|
|
226
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
227
|
+
onContextUpdate(oContext: Context): void;
|
|
228
|
+
/**
|
|
229
|
+
* This method is invoked whenever a context is loaded using the paginator buttons. It determines whether the context supports navigation. The method must return one of the following:
|
|
230
|
+
* ContextNavigationType.None: If the context is not navigable.
|
|
231
|
+
* ContextNavigationType.Internal: If the context supports internal navigation within the same application to a detail view, such as an object page or a subobject page.
|
|
232
|
+
* ContextNavigationType.External: If the context navigates to an external application.
|
|
233
|
+
* The paginator buttons only allow navigation to contexts with internal navigation. Contexts with None or External navigation are skipped.
|
|
234
|
+
* @param context Object containing the context to be navigated.
|
|
235
|
+
* @returns A Promise which should resolve to ContextNavigationType enum.
|
|
236
|
+
* @public
|
|
237
|
+
* @since 1.138.0
|
|
238
|
+
*/
|
|
239
|
+
determineContextNavigationType(context: Context): Promise<ContextNavigationType>;
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
declare module "sap/fe/core/controllerextensions/RoutingOverrides" {
|
|
244
|
+
import type Context from "sap/ui/model/odata/v4/Context";
|
|
245
|
+
export default interface RoutingOverrides {
|
|
246
|
+
/**
|
|
247
|
+
* This function can be used to intercept the routing event during the normal navigation process, such as when a table row is clicked to navigate, pagination buttons are used, the Apply button in an object page is clicked, or a sub-object page in a flexible column layout is closed.
|
|
248
|
+
*
|
|
249
|
+
* The function is not called during other means of external outbound navigation such as a navigation configured using a link or by using navigation buttons.
|
|
250
|
+
*
|
|
251
|
+
* If declared as an extension, it allows you to intercept and change the normal navigation flow.
|
|
252
|
+
* If you decide to implement your own navigation processing, you can return `true` to prevent the default routing behavior.
|
|
253
|
+
*
|
|
254
|
+
* This function is meant to be individually overridden by consuming controllers and not called directly.
|
|
255
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
256
|
+
* @param mNavigationParameters Object containing row context and page context
|
|
257
|
+
* @param mNavigationParameters.bindingContext The target navigation context
|
|
258
|
+
* @returns `true` to prevent the default execution, false to keep the standard behavior
|
|
259
|
+
* @public
|
|
260
|
+
* @since 1.86.0
|
|
261
|
+
*/
|
|
262
|
+
onBeforeNavigation(mNavigationParameters: { bindingContext: Context }): Promise<boolean>;
|
|
263
|
+
/**
|
|
264
|
+
* This function is used to intercept the routing event before binding a page.
|
|
265
|
+
*
|
|
266
|
+
* If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
|
|
267
|
+
*
|
|
268
|
+
* This function is not called directly, but overridden separately by consuming controllers.
|
|
269
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
270
|
+
* @param oContext Object containing the context for the navigation
|
|
271
|
+
* @public
|
|
272
|
+
* @since 1.90.0
|
|
273
|
+
*/
|
|
274
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
275
|
+
onBeforeBinding(oContext: object | null): void;
|
|
276
|
+
/**
|
|
277
|
+
* This function is used to intercept the routing event after binding a page.
|
|
278
|
+
*
|
|
279
|
+
* If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
|
|
280
|
+
*
|
|
281
|
+
* This function is not called directly, but overridden separately by consuming controllers.
|
|
282
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
283
|
+
* @param oContext Object containing the context to be navigated
|
|
284
|
+
* @public
|
|
285
|
+
* @since 1.90.0
|
|
286
|
+
*/
|
|
287
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
288
|
+
onAfterBinding(oContext: object | null): void;
|
|
289
|
+
}
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
declare module "sap/fe/core/controllerextensions/ShareOverrides" {
|
|
293
|
+
export type ShareMetadata = {
|
|
294
|
+
url: string;
|
|
295
|
+
title: string;
|
|
296
|
+
email: {
|
|
297
|
+
url: string;
|
|
298
|
+
title: string;
|
|
299
|
+
};
|
|
300
|
+
jam: {
|
|
301
|
+
url?: string;
|
|
302
|
+
title: string;
|
|
303
|
+
};
|
|
304
|
+
tile: {
|
|
305
|
+
url?: string;
|
|
306
|
+
title: string;
|
|
307
|
+
subtitle: string;
|
|
308
|
+
icon?: string;
|
|
309
|
+
queryUrl?: string;
|
|
310
|
+
};
|
|
311
|
+
};
|
|
312
|
+
export default interface ShareOverrides {
|
|
313
|
+
/**
|
|
314
|
+
* Adapts the metadata used while sharing the page URL using 'Send Email', 'Share in SAP Jam', and 'Save as Tile'.
|
|
315
|
+
* @param oShareMetadata Object containing the share metadata.
|
|
316
|
+
* @param oShareMetadata.url Default URL that will be used with 'Send Email', 'Share in SAP Jam', and 'Save as Tile'
|
|
317
|
+
* @param oShareMetadata.title Default title that will be used as the 'email subject' in 'Send Email', 'share text' in 'Share in SAP Jam' and 'title' in 'Save as Tile'
|
|
318
|
+
* @param oShareMetadata.email Email-specific metadata.
|
|
319
|
+
* @param oShareMetadata.email.url URL that will be used specifically for 'Send Email'. This takes precedence over oShareMetadata.url.
|
|
320
|
+
* @param oShareMetadata.email.title Title that will be used as "email subject" in 'Send Email'. This takes precedence over oShareMetadata.title.
|
|
321
|
+
* @param oShareMetadata.jam SAP Jam-specific metadata.
|
|
322
|
+
* @param oShareMetadata.jam.url URL that will be used specifically for 'Share in SAP Jam'. This takes precedence over oShareMetadata.url.
|
|
323
|
+
* @param oShareMetadata.jam.title Title that will be used as 'share text' in 'Share in SAP Jam'. This takes precedence over oShareMetadata.title.
|
|
324
|
+
* @param oShareMetadata.tile Save as Tile-specific metadata.
|
|
325
|
+
* @param oShareMetadata.tile.url URL that will be used specifically for 'Save as Tile'. This takes precedence over oShareMetadata.url.
|
|
326
|
+
* @param oShareMetadata.tile.title Title to be used for the tile. This takes precedence over oShareMetadata.title.
|
|
327
|
+
* @param oShareMetadata.tile.subtitle Subtitle to be used for the tile.
|
|
328
|
+
* @param oShareMetadata.tile.icon Icon to be used for the tile.
|
|
329
|
+
* @param oShareMetadata.tile.queryUrl Query URL of an OData service from which data for a dynamic tile is read.
|
|
330
|
+
* @returns Share Metadata or a Promise resolving the Share Metadata
|
|
331
|
+
* @public
|
|
332
|
+
* @since 1.93.0
|
|
333
|
+
*/
|
|
334
|
+
adaptShareMetadata(oShareMetadata: {
|
|
335
|
+
url: string;
|
|
336
|
+
title: string;
|
|
337
|
+
email: {
|
|
338
|
+
url: string;
|
|
339
|
+
title: string;
|
|
340
|
+
};
|
|
341
|
+
jam: {
|
|
342
|
+
url?: string;
|
|
343
|
+
title: string;
|
|
344
|
+
};
|
|
345
|
+
tile: {
|
|
346
|
+
url?: string;
|
|
347
|
+
title: string;
|
|
348
|
+
subtitle: string;
|
|
349
|
+
icon?: string;
|
|
350
|
+
queryUrl?: string;
|
|
351
|
+
};
|
|
352
|
+
}): ShareMetadata | Promise<ShareMetadata>;
|
|
353
|
+
}
|
|
354
|
+
}
|
|
355
|
+
|
|
356
|
+
declare module "sap/fe/core/controllerextensions/ViewStateOverrides" {
|
|
357
|
+
export default interface ViewStateOverrides {
|
|
358
|
+
/**
|
|
359
|
+
* Called when the application is suspended due to keep-alive mode.
|
|
360
|
+
* @public
|
|
361
|
+
*/
|
|
362
|
+
onSuspend(): void;
|
|
363
|
+
/**
|
|
364
|
+
* Called when the application is restored due to keep-alive mode.
|
|
365
|
+
* @public
|
|
366
|
+
*/
|
|
367
|
+
onRestore(): void;
|
|
368
|
+
}
|
|
369
|
+
}
|
|
370
|
+
|
|
371
|
+
declare module "sap/fe/core/controllerextensions/BaseControllerExtension" {
|
|
372
|
+
import type PageController from "sap/fe/core/PageController";
|
|
373
|
+
import type EditFlowOverrides from "sap/fe/core/controllerextensions/EditFlowOverrides";
|
|
374
|
+
import type IntentBasedNavigationOverride from "sap/fe/core/controllerextensions/IntentBasedNavigationOverrides";
|
|
375
|
+
import type MessageHandlerOverrides from "sap/fe/core/controllerextensions/MessageHandlerOverrides";
|
|
376
|
+
import type PaginatorOverrides from "sap/fe/core/controllerextensions/PaginatorOverrides";
|
|
377
|
+
import type RoutingOverrides from "sap/fe/core/controllerextensions/RoutingOverrides";
|
|
378
|
+
import type ShareOverrides from "sap/fe/core/controllerextensions/ShareOverrides";
|
|
379
|
+
import type ViewStateOverrides from "sap/fe/core/controllerextensions/ViewStateOverrides";
|
|
380
|
+
import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
|
|
381
|
+
|
|
382
|
+
type MapThis<T, S> = {
|
|
383
|
+
[P in keyof S]?: S[P] extends (...args: infer A) => infer R ? (this: T, ...args: A) => R : S[P];
|
|
384
|
+
};
|
|
385
|
+
export type ControllerExtensionOverrides<T, ControllerType> = {
|
|
386
|
+
// Lifecycle hooks
|
|
387
|
+
onInit?: (this: T) => void;
|
|
388
|
+
onBeforeRendering?: (this: T) => void;
|
|
389
|
+
onAfterRendering?: (this: T) => void;
|
|
390
|
+
onExit?: (this: T) => void;
|
|
391
|
+
|
|
392
|
+
// CExt Hooks
|
|
393
|
+
paginator?: MapThis<T, PaginatorOverrides>;
|
|
394
|
+
editFlow?: MapThis<T, EditFlowOverrides>;
|
|
395
|
+
routing?: MapThis<T, RoutingOverrides>;
|
|
396
|
+
messageHandler?: MapThis<T, MessageHandlerOverrides>;
|
|
397
|
+
intentBasedNavigation?: MapThis<T, IntentBasedNavigationOverride>;
|
|
398
|
+
share?: MapThis<T, ShareOverrides>;
|
|
399
|
+
viewState?: MapThis<T, ViewStateOverrides>;
|
|
400
|
+
} & MapThis<
|
|
401
|
+
T,
|
|
402
|
+
Omit<
|
|
403
|
+
ControllerType,
|
|
404
|
+
"editFlow" | "paginator" | "routing" | "messageHandler" | "intentBasedNavigation" | "recommendations" | "share" | "viewState"
|
|
405
|
+
>
|
|
406
|
+
>;
|
|
407
|
+
|
|
408
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
409
|
+
// @ts-ignore
|
|
410
|
+
export default class BaseControllerExtension<T extends PageController = PageController> extends ControllerExtension {
|
|
411
|
+
protected base: T;
|
|
412
|
+
|
|
413
|
+
public static createExtensionOverrides<K, BaseControllerType = PageController>(
|
|
414
|
+
overrides: ControllerExtensionOverrides<K, BaseControllerType>
|
|
415
|
+
): ControllerExtensionOverrides<K, BaseControllerType>;
|
|
416
|
+
|
|
417
|
+
constructor();
|
|
418
|
+
}
|
|
419
|
+
}
|
|
420
|
+
|
|
421
|
+
// For Library Version: 1.142.0
|
|
2
422
|
|
|
3
423
|
declare module "sap/fe/core/AppComponent" {
|
|
4
424
|
import {
|
|
@@ -13,7 +433,7 @@ declare module "sap/fe/core/AppComponent" {
|
|
|
13
433
|
* Application developers using the templates and building blocks provided by SAP Fiori elements should
|
|
14
434
|
* create their apps by extending this component.
|
|
15
435
|
* This ensures that all the necessary services that you need for the building blocks and templates to work
|
|
16
|
-
*
|
|
436
|
+
* are started.
|
|
17
437
|
* When you use sap.fe.core.AppComponent as the base component, you also need to use a rootView. SAP Fiori
|
|
18
438
|
* elements provides two options:
|
|
19
439
|
*
|
|
@@ -298,7 +718,7 @@ declare module "sap/fe/core/ExtensionAPI" {
|
|
|
298
718
|
*
|
|
299
719
|
* @returns A promise that resolves with the new app state object.
|
|
300
720
|
*/
|
|
301
|
-
updateAppState():
|
|
721
|
+
updateAppState(): any;
|
|
302
722
|
/**
|
|
303
723
|
* Watch a property from the main page context and trigger a callback when the value changes.
|
|
304
724
|
*/
|
|
@@ -363,8 +783,8 @@ declare module "sap/fe/core/PageController" {
|
|
|
363
783
|
|
|
364
784
|
/**
|
|
365
785
|
* Base controller class for your custom page used inside an SAP Fiori elements application.
|
|
366
|
-
* This controller provides preconfigured extensions that
|
|
367
|
-
*
|
|
786
|
+
* This controller provides preconfigured extensions that ensure you have the basic functionalities required
|
|
787
|
+
* to use the building blocks.
|
|
368
788
|
*
|
|
369
789
|
*
|
|
370
790
|
* @since 1.88.0
|
|
@@ -407,7 +827,23 @@ declare module "sap/fe/core/controllerextensions/BaseControllerExtension" {
|
|
|
407
827
|
*
|
|
408
828
|
* @since 1.118.0
|
|
409
829
|
*/
|
|
410
|
-
|
|
830
|
+
// @ts-ignore
|
|
831
|
+
export default class BaseControllerExtension extends ControllerExtension {
|
|
832
|
+
/**
|
|
833
|
+
* Create the overrides for the controller extension.
|
|
834
|
+
* This method is a helper to get the correct typing when implementing your own controller extension.
|
|
835
|
+
*
|
|
836
|
+
*
|
|
837
|
+
*
|
|
838
|
+
* @returns The overrides passed in as parameter with correct typing
|
|
839
|
+
*/
|
|
840
|
+
static createExtensionOverrides(
|
|
841
|
+
/**
|
|
842
|
+
* The overrides to apply
|
|
843
|
+
*/
|
|
844
|
+
overrides: object
|
|
845
|
+
): object;
|
|
846
|
+
}
|
|
411
847
|
}
|
|
412
848
|
|
|
413
849
|
declare module "sap/fe/core/controllerextensions/CollaborativeDraft" {
|
|
@@ -415,6 +851,8 @@ declare module "sap/fe/core/controllerextensions/CollaborativeDraft" {
|
|
|
415
851
|
|
|
416
852
|
import Context from "sap/ui/model/odata/v4/Context";
|
|
417
853
|
|
|
854
|
+
import ODataListBinding from "sap/ui/model/odata/v4/ODataListBinding";
|
|
855
|
+
|
|
418
856
|
/**
|
|
419
857
|
* A controller extension to handle collaborative draft scenarios.
|
|
420
858
|
*
|
|
@@ -424,7 +862,7 @@ declare module "sap/fe/core/controllerextensions/CollaborativeDraft" {
|
|
|
424
862
|
export default class CollaborativeDraft extends BaseControllerExtension {
|
|
425
863
|
/**
|
|
426
864
|
* Sends a notification to other users that new contexts have been created by the current user.
|
|
427
|
-
* This notification must be sent after the new contexts have been created successfully in the back
|
|
865
|
+
* This notification must be sent after the new contexts have been created successfully in the back end.
|
|
428
866
|
*
|
|
429
867
|
*
|
|
430
868
|
* @since 1.141.0
|
|
@@ -432,13 +870,13 @@ declare module "sap/fe/core/controllerextensions/CollaborativeDraft" {
|
|
|
432
870
|
*/
|
|
433
871
|
sendContextsCreated(
|
|
434
872
|
/**
|
|
435
|
-
* The array of newly created contexts
|
|
873
|
+
* The array of newly created contexts, or the binding where the contexts were created
|
|
436
874
|
*/
|
|
437
|
-
|
|
875
|
+
contextsOrBinding: Context[] | ODataListBinding
|
|
438
876
|
): void;
|
|
439
877
|
/**
|
|
440
878
|
* Sends a notification to other users that contexts have been deleted by the current user.
|
|
441
|
-
* This notification must be sent after the contexts have been deleted successfully in the back
|
|
879
|
+
* This notification must be sent after the contexts have been deleted successfully in the back end.
|
|
442
880
|
*
|
|
443
881
|
*
|
|
444
882
|
* @since 1.141.0
|
|
@@ -472,7 +910,7 @@ declare module "sap/fe/core/controllerextensions/CollaborativeDraft" {
|
|
|
472
910
|
): void;
|
|
473
911
|
/**
|
|
474
912
|
* Sends a notification to other users that property values have been changed by the current user.
|
|
475
|
-
* This notification must be sent after the changes have been sent successfully to the back
|
|
913
|
+
* This notification must be sent after the changes have been sent successfully to the back end.
|
|
476
914
|
*
|
|
477
915
|
*
|
|
478
916
|
* @since 1.141.0
|
|
@@ -730,7 +1168,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
730
1168
|
* An optional array of objects representing the action parameters, where each object has a name of string
|
|
731
1169
|
* type and a value that can be of any data type.
|
|
732
1170
|
*/
|
|
733
|
-
parameterValues?:
|
|
1171
|
+
parameterValues?: any;
|
|
734
1172
|
/**
|
|
735
1173
|
* Boolean value indicating whether navigation is required after the action has been executed. Navigation
|
|
736
1174
|
* takes place to the context returned by the action
|
|
@@ -741,7 +1179,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
741
1179
|
*/
|
|
742
1180
|
skipParameterDialog?: boolean;
|
|
743
1181
|
}
|
|
744
|
-
):
|
|
1182
|
+
): any;
|
|
745
1183
|
/**
|
|
746
1184
|
* This function can be used to execute code after the 'Create' action.
|
|
747
1185
|
* You can execute custom coding in this function.
|
|
@@ -1126,13 +1564,14 @@ declare module "sap/fe/core/controllerextensions/MessageHandler" {
|
|
|
1126
1564
|
*/
|
|
1127
1565
|
export default class MessageHandler extends ControllerExtension {
|
|
1128
1566
|
/**
|
|
1129
|
-
* Allows consumer of
|
|
1130
|
-
*
|
|
1131
|
-
*
|
|
1132
|
-
*
|
|
1567
|
+
* Allows the consumer of the MessageButton building block to decide which bound messages are shown and
|
|
1568
|
+
* how.
|
|
1569
|
+
* This hook is called when the MessageButton building block detects a change in the message model.
|
|
1570
|
+
* The hooks allow you to define the behavior for messages in the MessageButton building block.
|
|
1571
|
+
* Consumers are able to do the following with this hook:
|
|
1133
1572
|
* 1. Filter out messages so that they are not shown on the message button.
|
|
1134
|
-
* 2.
|
|
1135
|
-
* 3.
|
|
1573
|
+
* 2. Group messages based on their UI.
|
|
1574
|
+
* 3. Provide a presser handler if the message should display as a link.
|
|
1136
1575
|
*
|
|
1137
1576
|
*
|
|
1138
1577
|
*
|
|
@@ -1161,7 +1600,7 @@ declare module "sap/fe/core/controllerextensions/MessageHandler" {
|
|
|
1161
1600
|
showMessageDialog(): Promise<void>;
|
|
1162
1601
|
}
|
|
1163
1602
|
/**
|
|
1164
|
-
* Defines the message
|
|
1603
|
+
* Defines the message details relevant for the MessageButton building block to display a popover.
|
|
1165
1604
|
*/
|
|
1166
1605
|
export type MessageDetail = {};
|
|
1167
1606
|
}
|
|
@@ -1288,7 +1727,7 @@ declare module "sap/fe/core/controllerextensions/Routing" {
|
|
|
1288
1727
|
/**
|
|
1289
1728
|
* Parameters to be used with route to create the target hash
|
|
1290
1729
|
*/
|
|
1291
|
-
oParameters?:
|
|
1730
|
+
oParameters?: any
|
|
1292
1731
|
): Promise<boolean>;
|
|
1293
1732
|
/**
|
|
1294
1733
|
* This function is used to intercept the routing event after binding a page.
|
|
@@ -1324,12 +1763,12 @@ declare module "sap/fe/core/controllerextensions/Routing" {
|
|
|
1324
1763
|
* This function can be used to intercept the routing event during the normal navigation process, such as
|
|
1325
1764
|
* when a table row is clicked to navigate, pagination buttons are used, the Apply button in an object page
|
|
1326
1765
|
* is clicked, or a sub-object page in a flexible column layout is closed.
|
|
1327
|
-
* The function is
|
|
1328
|
-
*
|
|
1766
|
+
* The function is not called during other means of external outbound navigation such as a navigation configured
|
|
1767
|
+
* using a link or by using navigation buttons.
|
|
1329
1768
|
* If declared as an extension, it allows you to intercept and change the normal navigation flow.
|
|
1330
|
-
* If you decide to
|
|
1331
|
-
* behavior.
|
|
1332
|
-
* This function is meant to be individually overridden by consuming controllers
|
|
1769
|
+
* If you decide to implement your own navigation processing, you can return `true` to prevent the default
|
|
1770
|
+
* routing behavior.
|
|
1771
|
+
* This function is meant to be individually overridden by consuming controllers and not called directly.
|
|
1333
1772
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
1334
1773
|
*
|
|
1335
1774
|
*
|
|
@@ -1363,8 +1802,8 @@ declare module "sap/fe/core/controllerextensions/Share" {
|
|
|
1363
1802
|
*/
|
|
1364
1803
|
export default class Share extends BaseControllerExtension {
|
|
1365
1804
|
/**
|
|
1366
|
-
* Adapts the metadata used while sharing the page URL
|
|
1367
|
-
* Tile'.
|
|
1805
|
+
* Adapts the metadata used while sharing the page URL using 'Send Email', 'Share in SAP Jam', and 'Save
|
|
1806
|
+
* as Tile'.
|
|
1368
1807
|
*
|
|
1369
1808
|
* @since 1.93.0
|
|
1370
1809
|
*
|
|
@@ -1427,12 +1866,12 @@ declare module "sap/fe/core/controllerextensions/Share" {
|
|
|
1427
1866
|
url?: string;
|
|
1428
1867
|
};
|
|
1429
1868
|
/**
|
|
1430
|
-
* Default title that will be used as 'email subject' in 'Send Email', 'share text' in 'Share in SAP
|
|
1431
|
-
* and 'title' in 'Save as Tile'
|
|
1869
|
+
* Default title that will be used as the 'email subject' in 'Send Email', 'share text' in 'Share in SAP
|
|
1870
|
+
* Jam' and 'title' in 'Save as Tile'
|
|
1432
1871
|
*/
|
|
1433
1872
|
title: string;
|
|
1434
1873
|
/**
|
|
1435
|
-
* Default URL that will be used
|
|
1874
|
+
* Default URL that will be used with 'Send Email', 'Share in SAP Jam', and 'Save as Tile'
|
|
1436
1875
|
*/
|
|
1437
1876
|
url: string;
|
|
1438
1877
|
}
|
|
@@ -1498,7 +1937,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
|
|
|
1498
1937
|
/**
|
|
1499
1938
|
* A plain object which can have one function: `refreshBinding`
|
|
1500
1939
|
*/
|
|
1501
|
-
_oControlHandler:
|
|
1940
|
+
_oControlHandler: any
|
|
1502
1941
|
): void;
|
|
1503
1942
|
/**
|
|
1504
1943
|
* Customize the `retrieve` and `apply` functions for a certain control.
|
package/types/sap.fe.ina.d.ts
CHANGED