@openui5/types 1.120.11 → 1.120.13

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.
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.120.11
1
+ // For Library Version: 1.120.13
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.11
1
+ // For Library Version: 1.120.13
2
2
 
3
3
  declare module "sap/ui/fl/library" {}
4
4
 
@@ -186,7 +186,12 @@ declare module "sap/ui/fl/transport/TransportDialog" {
186
186
  */
187
187
  static getMetadata(): ElementMetadata;
188
188
  }
189
-
189
+ /**
190
+ * Describes the settings that can be provided to the TransportDialog constructor.
191
+ *
192
+ * @deprecated (since 1.74) - The TransportDialog should be used only internally inside the `sap.ui.fl`
193
+ * library.
194
+ */
190
195
  export interface $TransportDialogSettings extends $DialogSettings {}
191
196
  }
192
197
 
@@ -1105,7 +1110,9 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1105
1110
  bUpdateVariantInURL?: boolean
1106
1111
  ): this;
1107
1112
  }
1108
-
1113
+ /**
1114
+ * Describes the settings that can be provided to the VariantManagement constructor.
1115
+ */
1109
1116
  export interface $VariantManagementSettings extends $ControlSettings {
1110
1117
  /**
1111
1118
  * Determines the intention of setting the current variant based on passed information. **Note:** The
@@ -1218,20 +1225,35 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1218
1225
  select?: (oEvent: VariantManagement$SelectEvent) => void;
1219
1226
  }
1220
1227
 
1228
+ /**
1229
+ * Parameters of the VariantManagement#cancel event.
1230
+ */
1221
1231
  export interface VariantManagement$CancelEventParameters {}
1222
1232
 
1233
+ /**
1234
+ * Event object of the VariantManagement#cancel event.
1235
+ */
1223
1236
  export type VariantManagement$CancelEvent = Event<
1224
1237
  VariantManagement$CancelEventParameters,
1225
1238
  VariantManagement
1226
1239
  >;
1227
1240
 
1241
+ /**
1242
+ * Parameters of the VariantManagement#initialized event.
1243
+ */
1228
1244
  export interface VariantManagement$InitializedEventParameters {}
1229
1245
 
1246
+ /**
1247
+ * Event object of the VariantManagement#initialized event.
1248
+ */
1230
1249
  export type VariantManagement$InitializedEvent = Event<
1231
1250
  VariantManagement$InitializedEventParameters,
1232
1251
  VariantManagement
1233
1252
  >;
1234
1253
 
1254
+ /**
1255
+ * Parameters of the VariantManagement#manage event.
1256
+ */
1235
1257
  export interface VariantManagement$ManageEventParameters {
1236
1258
  /**
1237
1259
  * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
@@ -1255,11 +1277,17 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1255
1277
  def?: string;
1256
1278
  }
1257
1279
 
1280
+ /**
1281
+ * Event object of the VariantManagement#manage event.
1282
+ */
1258
1283
  export type VariantManagement$ManageEvent = Event<
1259
1284
  VariantManagement$ManageEventParameters,
1260
1285
  VariantManagement
1261
1286
  >;
1262
1287
 
1288
+ /**
1289
+ * Parameters of the VariantManagement#save event.
1290
+ */
1263
1291
  export interface VariantManagement$SaveEventParameters {
1264
1292
  /**
1265
1293
  * Variant title
@@ -1299,11 +1327,17 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1299
1327
  tile?: boolean;
1300
1328
  }
1301
1329
 
1330
+ /**
1331
+ * Event object of the VariantManagement#save event.
1332
+ */
1302
1333
  export type VariantManagement$SaveEvent = Event<
1303
1334
  VariantManagement$SaveEventParameters,
1304
1335
  VariantManagement
1305
1336
  >;
1306
1337
 
1338
+ /**
1339
+ * Parameters of the VariantManagement#select event.
1340
+ */
1307
1341
  export interface VariantManagement$SelectEventParameters {
1308
1342
  /**
1309
1343
  * Variant key
@@ -1311,6 +1345,9 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1311
1345
  key?: string;
1312
1346
  }
1313
1347
 
1348
+ /**
1349
+ * Event object of the VariantManagement#select event.
1350
+ */
1314
1351
  export type VariantManagement$SelectEvent = Event<
1315
1352
  VariantManagement$SelectEventParameters,
1316
1353
  VariantManagement
@@ -1598,6 +1635,8 @@ declare namespace sap {
1598
1635
 
1599
1636
  "sap/ui/fl/initial/_internal/connectors/BackendConnector": undefined;
1600
1637
 
1638
+ "sap/ui/fl/initial/_internal/connectors/BtpServiceConnector": undefined;
1639
+
1601
1640
  "sap/ui/fl/initial/_internal/connectors/KeyUserConnector": undefined;
1602
1641
 
1603
1642
  "sap/ui/fl/initial/_internal/connectors/LrepConnector": undefined;
@@ -1648,6 +1687,8 @@ declare namespace sap {
1648
1687
 
1649
1688
  "sap/ui/fl/write/_internal/connectors/BackendConnector": undefined;
1650
1689
 
1690
+ "sap/ui/fl/write/_internal/connectors/BtpServiceConnector": undefined;
1691
+
1651
1692
  "sap/ui/fl/write/_internal/connectors/JsObjectConnector": undefined;
1652
1693
 
1653
1694
  "sap/ui/fl/write/_internal/connectors/KeyUserConnector": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.11
1
+ // For Library Version: 1.120.13
2
2
 
3
3
  declare module "sap/ui/integration/library" {
4
4
  import { URI } from "sap/ui/core/library";
@@ -595,7 +595,12 @@ declare module "sap/ui/integration/ActionDefinition" {
595
595
  bVisible?: boolean
596
596
  ): this;
597
597
  }
598
-
598
+ /**
599
+ * Describes the settings that can be provided to the ActionDefinition constructor.
600
+ *
601
+ * @experimental (since 1.85) - Disclaimer: this class is in a beta state - incompatible API changes may
602
+ * be done before its official public release. Use at your own discretion.
603
+ */
599
604
  export interface $ActionDefinitionSettings extends $ElementSettings {
600
605
  /**
601
606
  * The type of the action.
@@ -645,8 +650,14 @@ declare module "sap/ui/integration/ActionDefinition" {
645
650
  press?: (oEvent: Event) => void;
646
651
  }
647
652
 
653
+ /**
654
+ * Parameters of the ActionDefinition#press event.
655
+ */
648
656
  export interface ActionDefinition$PressEventParameters {}
649
657
 
658
+ /**
659
+ * Event object of the ActionDefinition#press event.
660
+ */
650
661
  export type ActionDefinition$PressEvent = Event<
651
662
  ActionDefinition$PressEventParameters,
652
663
  ActionDefinition
@@ -2324,6 +2335,9 @@ declare module "sap/ui/integration/widgets/Card" {
2324
2335
  validateControls(): boolean;
2325
2336
  }
2326
2337
 
2338
+ /**
2339
+ * Describes the settings that can be provided to the Card constructor.
2340
+ */
2327
2341
  export interface $CardSettings extends $CardBaseSettings {
2328
2342
  /**
2329
2343
  * Optional property which can be used by the host to reference the card. It will be forwarded to any children
@@ -2509,6 +2523,12 @@ declare module "sap/ui/integration/widgets/Card" {
2509
2523
  stateChanged?: (oEvent: Event) => void;
2510
2524
  }
2511
2525
 
2526
+ /**
2527
+ * Parameters of the Card#action event.
2528
+ *
2529
+ * @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
2530
+ * be done before its official public release. Use at your own discretion.
2531
+ */
2512
2532
  export interface Card$ActionEventParameters {
2513
2533
  /**
2514
2534
  * The action source.
@@ -2531,8 +2551,19 @@ declare module "sap/ui/integration/widgets/Card" {
2531
2551
  type?: CardActionType | keyof typeof CardActionType;
2532
2552
  }
2533
2553
 
2554
+ /**
2555
+ * Event object of the Card#action event.
2556
+ *
2557
+ * @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
2558
+ * be done before its official public release. Use at your own discretion.
2559
+ */
2534
2560
  export type Card$ActionEvent = Event<Card$ActionEventParameters, Card>;
2535
2561
 
2562
+ /**
2563
+ * Parameters of the Card#configurationChange event.
2564
+ *
2565
+ * @experimental (since 1.96)
2566
+ */
2536
2567
  export interface Card$ConfigurationChangeEventParameters {
2537
2568
  /**
2538
2569
  * Changed configuration settings.
@@ -2549,27 +2580,58 @@ declare module "sap/ui/integration/widgets/Card" {
2549
2580
  changes?: object;
2550
2581
  }
2551
2582
 
2583
+ /**
2584
+ * Event object of the Card#configurationChange event.
2585
+ *
2586
+ * @experimental (since 1.96)
2587
+ */
2552
2588
  export type Card$ConfigurationChangeEvent = Event<
2553
2589
  Card$ConfigurationChangeEventParameters,
2554
2590
  Card
2555
2591
  >;
2556
2592
 
2593
+ /**
2594
+ * Parameters of the Card#manifestApplied event.
2595
+ */
2557
2596
  export interface Card$ManifestAppliedEventParameters {}
2558
2597
 
2598
+ /**
2599
+ * Event object of the Card#manifestApplied event.
2600
+ */
2559
2601
  export type Card$ManifestAppliedEvent = Event<
2560
2602
  Card$ManifestAppliedEventParameters,
2561
2603
  Card
2562
2604
  >;
2563
2605
 
2606
+ /**
2607
+ * Parameters of the Card#manifestReady event.
2608
+ *
2609
+ * @experimental (since 1.72)
2610
+ */
2564
2611
  export interface Card$ManifestReadyEventParameters {}
2565
2612
 
2613
+ /**
2614
+ * Event object of the Card#manifestReady event.
2615
+ *
2616
+ * @experimental (since 1.72)
2617
+ */
2566
2618
  export type Card$ManifestReadyEvent = Event<
2567
2619
  Card$ManifestReadyEventParameters,
2568
2620
  Card
2569
2621
  >;
2570
2622
 
2623
+ /**
2624
+ * Parameters of the Card#stateChanged event.
2625
+ *
2626
+ * @experimental (since 1.107)
2627
+ */
2571
2628
  export interface Card$StateChangedEventParameters {}
2572
2629
 
2630
+ /**
2631
+ * Event object of the Card#stateChanged event.
2632
+ *
2633
+ * @experimental (since 1.107)
2634
+ */
2573
2635
  export type Card$StateChangedEvent = Event<
2574
2636
  Card$StateChangedEventParameters,
2575
2637
  Card
@@ -2670,7 +2732,11 @@ declare module "sap/ui/integration/Designtime" {
2670
2732
  */
2671
2733
  getCard(): CardFacade;
2672
2734
  }
2673
-
2735
+ /**
2736
+ * Describes the settings that can be provided to the Designtime constructor.
2737
+ *
2738
+ * @experimental (since 1.75)
2739
+ */
2674
2740
  export interface $DesigntimeSettings extends $ManagedObjectSettings {}
2675
2741
  }
2676
2742
 
@@ -3087,7 +3153,9 @@ declare module "sap/ui/integration/editor/Extension" {
3087
3153
  */
3088
3154
  onEditorReady(): void;
3089
3155
  }
3090
-
3156
+ /**
3157
+ * Describes the settings that can be provided to the Extension constructor.
3158
+ */
3091
3159
  export interface $ExtensionSettings extends $ExtensionSettings1 {}
3092
3160
  }
3093
3161
 
@@ -3374,7 +3442,9 @@ declare module "sap/ui/integration/Extension" {
3374
3442
  aFormatters?: Record<string, Function>
3375
3443
  ): this;
3376
3444
  }
3377
-
3445
+ /**
3446
+ * Describes the settings that can be provided to the Extension constructor.
3447
+ */
3378
3448
  export interface $ExtensionSettings extends $ManagedObjectSettings {
3379
3449
  /**
3380
3450
  * The actions configuration.
@@ -3405,6 +3475,12 @@ declare module "sap/ui/integration/Extension" {
3405
3475
  action?: (oEvent: Extension$ActionEvent) => void;
3406
3476
  }
3407
3477
 
3478
+ /**
3479
+ * Parameters of the Extension#action event.
3480
+ *
3481
+ * @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
3482
+ * be done before its official public release. Use at your own discretion.
3483
+ */
3408
3484
  export interface Extension$ActionEventParameters {
3409
3485
  /**
3410
3486
  * The card the action is fired from.
@@ -3432,6 +3508,12 @@ declare module "sap/ui/integration/Extension" {
3432
3508
  type?: CardActionType | keyof typeof CardActionType;
3433
3509
  }
3434
3510
 
3511
+ /**
3512
+ * Event object of the Extension#action event.
3513
+ *
3514
+ * @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
3515
+ * be done before its official public release. Use at your own discretion.
3516
+ */
3435
3517
  export type Extension$ActionEvent = Event<
3436
3518
  Extension$ActionEventParameters,
3437
3519
  Extension
@@ -4145,7 +4227,11 @@ declare module "sap/ui/integration/Host" {
4145
4227
  fnResolveDestination?: (p1: string, p2: Card) => string | Promise<string>
4146
4228
  ): this;
4147
4229
  }
4148
-
4230
+ /**
4231
+ * Describes the settings that can be provided to the Host constructor.
4232
+ *
4233
+ * @experimental (since 1.75)
4234
+ */
4149
4235
  export interface $HostSettings extends $ElementSettings {
4150
4236
  /**
4151
4237
  * The actions configuration.
@@ -4214,6 +4300,12 @@ declare module "sap/ui/integration/Host" {
4214
4300
  message?: (oEvent: Host$MessageEvent) => void;
4215
4301
  }
4216
4302
 
4303
+ /**
4304
+ * Parameters of the Host#action event.
4305
+ *
4306
+ * @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
4307
+ * be done before its official public release. Use at your own discretion.
4308
+ */
4217
4309
  export interface Host$ActionEventParameters {
4218
4310
  /**
4219
4311
  * The card the action is fired from.
@@ -4241,8 +4333,19 @@ declare module "sap/ui/integration/Host" {
4241
4333
  type?: CardActionType | keyof typeof CardActionType;
4242
4334
  }
4243
4335
 
4336
+ /**
4337
+ * Event object of the Host#action event.
4338
+ *
4339
+ * @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
4340
+ * be done before its official public release. Use at your own discretion.
4341
+ */
4244
4342
  export type Host$ActionEvent = Event<Host$ActionEventParameters, Host>;
4245
4343
 
4344
+ /**
4345
+ * Parameters of the Host#cardConfigurationChange event.
4346
+ *
4347
+ * @experimental (since 1.96)
4348
+ */
4246
4349
  export interface Host$CardConfigurationChangeEventParameters {
4247
4350
  /**
4248
4351
  * The card the changes are fired from.
@@ -4264,11 +4367,21 @@ declare module "sap/ui/integration/Host" {
4264
4367
  changes?: object;
4265
4368
  }
4266
4369
 
4370
+ /**
4371
+ * Event object of the Host#cardConfigurationChange event.
4372
+ *
4373
+ * @experimental (since 1.96)
4374
+ */
4267
4375
  export type Host$CardConfigurationChangeEvent = Event<
4268
4376
  Host$CardConfigurationChangeEventParameters,
4269
4377
  Host
4270
4378
  >;
4271
4379
 
4380
+ /**
4381
+ * Parameters of the Host#cardInitialized event.
4382
+ *
4383
+ * @experimental (since 1.116)
4384
+ */
4272
4385
  export interface Host$CardInitializedEventParameters {
4273
4386
  /**
4274
4387
  * The card.
@@ -4276,11 +4389,21 @@ declare module "sap/ui/integration/Host" {
4276
4389
  card?: Control;
4277
4390
  }
4278
4391
 
4392
+ /**
4393
+ * Event object of the Host#cardInitialized event.
4394
+ *
4395
+ * @experimental (since 1.116)
4396
+ */
4279
4397
  export type Host$CardInitializedEvent = Event<
4280
4398
  Host$CardInitializedEventParameters,
4281
4399
  Host
4282
4400
  >;
4283
4401
 
4402
+ /**
4403
+ * Parameters of the Host#cardStateChanged event.
4404
+ *
4405
+ * @experimental (since 1.107)
4406
+ */
4284
4407
  export interface Host$CardStateChangedEventParameters {
4285
4408
  /**
4286
4409
  * The card the changes are fired from.
@@ -4288,15 +4411,30 @@ declare module "sap/ui/integration/Host" {
4288
4411
  card?: Control;
4289
4412
  }
4290
4413
 
4414
+ /**
4415
+ * Event object of the Host#cardStateChanged event.
4416
+ *
4417
+ * @experimental (since 1.107)
4418
+ */
4291
4419
  export type Host$CardStateChangedEvent = Event<
4292
4420
  Host$CardStateChangedEventParameters,
4293
4421
  Host
4294
4422
  >;
4295
4423
 
4424
+ /**
4425
+ * Parameters of the Host#message event.
4426
+ *
4427
+ * @experimental (since 1.91)
4428
+ */
4296
4429
  export interface Host$MessageEventParameters {
4297
4430
  data?: object;
4298
4431
  }
4299
4432
 
4433
+ /**
4434
+ * Event object of the Host#message event.
4435
+ *
4436
+ * @experimental (since 1.91)
4437
+ */
4300
4438
  export type Host$MessageEvent = Event<Host$MessageEventParameters, Host>;
4301
4439
  }
4302
4440