@sapui5/types 1.113.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/LICENSE.txt +35 -0
  2. package/README.md +35 -0
  3. package/package.json +23 -0
  4. package/types/index.d.ts +67 -0
  5. package/types/sap.apf.d.ts +1026 -0
  6. package/types/sap.ca.ui.d.ts +14005 -0
  7. package/types/sap.chart.d.ts +4815 -0
  8. package/types/sap.collaboration.d.ts +2704 -0
  9. package/types/sap.esh.search.ui.d.ts +1595 -0
  10. package/types/sap.f.d.ts +20085 -0
  11. package/types/sap.fe.core.d.ts +1508 -0
  12. package/types/sap.fe.macros.d.ts +975 -0
  13. package/types/sap.fe.navigation.d.ts +917 -0
  14. package/types/sap.fe.templates.d.ts +522 -0
  15. package/types/sap.fe.test.d.ts +3533 -0
  16. package/types/sap.feedback.ui.d.ts +3 -0
  17. package/types/sap.gantt.d.ts +51684 -0
  18. package/types/sap.insights.d.ts +23 -0
  19. package/types/sap.landvisz.d.ts +7952 -0
  20. package/types/sap.m.d.ts +147796 -0
  21. package/types/sap.makit.d.ts +4533 -0
  22. package/types/sap.me.d.ts +3665 -0
  23. package/types/sap.ndc.d.ts +774 -0
  24. package/types/sap.ovp.d.ts +176 -0
  25. package/types/sap.rules.ui.d.ts +1471 -0
  26. package/types/sap.sac.df.d.ts +2292 -0
  27. package/types/sap.sac.grid.d.ts +774 -0
  28. package/types/sap.suite.ui.commons.d.ts +46971 -0
  29. package/types/sap.suite.ui.generic.template.d.ts +3431 -0
  30. package/types/sap.suite.ui.microchart.d.ts +12652 -0
  31. package/types/sap.tnt.d.ts +2227 -0
  32. package/types/sap.ui.codeeditor.d.ts +693 -0
  33. package/types/sap.ui.commons.d.ts +30235 -0
  34. package/types/sap.ui.comp.d.ts +37411 -0
  35. package/types/sap.ui.core.d.ts +78872 -0
  36. package/types/sap.ui.dt.d.ts +3 -0
  37. package/types/sap.ui.export.d.ts +843 -0
  38. package/types/sap.ui.fl.d.ts +1663 -0
  39. package/types/sap.ui.generic.app.d.ts +2683 -0
  40. package/types/sap.ui.generic.template.d.ts +3 -0
  41. package/types/sap.ui.integration.d.ts +4032 -0
  42. package/types/sap.ui.layout.d.ts +14472 -0
  43. package/types/sap.ui.mdc.d.ts +476 -0
  44. package/types/sap.ui.richtexteditor.d.ts +1666 -0
  45. package/types/sap.ui.rta.d.ts +124 -0
  46. package/types/sap.ui.suite.d.ts +685 -0
  47. package/types/sap.ui.support.d.ts +453 -0
  48. package/types/sap.ui.table.d.ts +9325 -0
  49. package/types/sap.ui.testrecorder.d.ts +9 -0
  50. package/types/sap.ui.unified.d.ts +20640 -0
  51. package/types/sap.ui.ux3.d.ts +18288 -0
  52. package/types/sap.ui.vbm.d.ts +17251 -0
  53. package/types/sap.ui.vk.d.ts +42381 -0
  54. package/types/sap.ui.vtm.d.ts +10547 -0
  55. package/types/sap.ui.webc.common.d.ts +113 -0
  56. package/types/sap.ui.webc.fiori.d.ts +13850 -0
  57. package/types/sap.ui.webc.main.d.ts +40833 -0
  58. package/types/sap.uiext.inbox.d.ts +4079 -0
  59. package/types/sap.ushell.d.ts +10255 -0
  60. package/types/sap.ushell_abap.d.ts +9 -0
  61. package/types/sap.uxap.d.ts +7636 -0
  62. package/types/sap.viz.d.ts +51209 -0
  63. package/types/sap.webanalytics.core.d.ts +3 -0
  64. package/types/sap.zen.commons.d.ts +1542 -0
  65. package/types/sap.zen.crosstab.d.ts +1159 -0
  66. package/types/sap.zen.dsh.d.ts +2132 -0
@@ -0,0 +1,774 @@
1
+ // For Library Version: 1.113.0
2
+
3
+ declare module "sap/ndc/library" {}
4
+
5
+ declare module "sap/ndc/BarcodeScanner" {
6
+ import JSONModel from "sap/ui/model/json/JSONModel";
7
+
8
+ /**
9
+ * @SINCE 1.28.0
10
+ *
11
+ * Please refer to SAP
12
+ * Note 2402585 for information on Barcode Scanner support in native iOS and Android browsers.
13
+ *
14
+ * Here is an example of how to trigger the scan function of BarcodeScanner:
15
+ * ```javascript
16
+ *
17
+ * sap.ui.require(["sap/ndc/BarcodeScanner"], function(BarcodeScanner) {
18
+ * BarcodeScanner.scan(
19
+ * function (oResult) { / * process scan result * / },
20
+ * function (oError) { / * handle scan error * / },
21
+ * function (oResult) { / * handle input dialog change * / }
22
+ * );
23
+ * });
24
+ * ```
25
+ * The Barcode Scanner control can open the flashlight of Android devices if supported. The Barcode Scanner
26
+ * control can also scan the barcode from a selected image file in gallery, or a photo taking by System
27
+ * Camera App directly.
28
+ *
29
+ * The Barcode Scanner control integrates with the laser scanner when the page is loaded in the Enterprise
30
+ * Browser on a Zebra device. To enable laser scanning with a Zebra device, two JavaScript files (ebapi.js
31
+ * and eb.barcode.js) need to be loaded during runtime by the Enterprise Browser.
32
+ * - Your company admin / IT should configure the Barcode API settings in the Enterprise Browser config.xml
33
+ * file using mobile device management (MDM). Refer to CustomDOMElements
34
+ * for detailed information (recommended).
35
+ * - Developers can load these files directly into an HTML file. Refer to Enabling the API for detailed
36
+ * information.
37
+ */
38
+ interface BarcodeScanner {
39
+ /**
40
+ * Closes the barcode input dialog. It can be used to close the dialog before the user presses the OK or
41
+ * the Cancel button (e.g. in the fnLiveUpdate callback function of the {@link sap.ndc.BarcodeScanner.scan}
42
+ * method.)
43
+ */
44
+ closeScanDialog(): void;
45
+ /**
46
+ * Returns the scanner API info that will be used to scan the barcode.
47
+ *
48
+ * @returns The Barcode Scanner API info. (e.g. ZebraEnterpriseBrowser, Cordova, ZXingCPP, ZXing or unknown)
49
+ */
50
+ getScanAPIInfo(): string;
51
+ /**
52
+ * Returns the status model of the Barcode Scanner. It is a JSON model which contains below properties:
53
+ *
54
+ * ```javascript
55
+ *
56
+ * {
57
+ * scannerAPI: "ZXingCPP",
58
+ * available: true,
59
+ * deviceId: undefined,
60
+ * devices: [],
61
+ * apis: [
62
+ * {
63
+ * key: "ZebraEnterpriseBrowser",
64
+ * status: "UnAvailable"
65
+ * },
66
+ * {
67
+ * key: "Cordova",
68
+ * status: "UnAvailable"
69
+ * },
70
+ * {
71
+ * key: "ZXingCPP",
72
+ * status: "Available"
73
+ * },
74
+ * {
75
+ * key: "ZXing",
76
+ * status: "Initial"
77
+ * }
78
+ * ]
79
+ * }
80
+ * ```
81
+ * '`scannerAPI`' shows the current scanner API used to scan the Barcode. '`available`' indicating whether
82
+ * or not the Barcode Scanner feature is available. It can be used to bind to the `visible` property of
83
+ * UI controls which have to be hidden in case the feature is unavailable. '`deviceId`' lists the current
84
+ * used camera id of current device. Not working for iOS devices since do not support to get all the cameras.
85
+ * '`devices`' lists all the cameras of current device. Not working for iOS devices since do not support
86
+ * to get all the cameras. '`apis`' lists scanner APIs with status value. Status value can be: "Initial",
87
+ * "Loading", "Available" or "UnAvailable".
88
+ *
89
+ * IMPORTANT: This model just shows current status of Barcode Scanner. Any change to it will not impact
90
+ * Barcode Scanner.
91
+ *
92
+ * @returns The Barcode Scanner Status Model
93
+ */
94
+ getStatusModel(): JSONModel;
95
+ /**
96
+ * Starts the barcode scanning process either showing the live input from the camera or displaying a dialog
97
+ * to enter the value directly if the barcode scanning feature is unavailable.
98
+ *
99
+ * The barcode scanning is done asynchronously. When it is triggered, this function returns without waiting
100
+ * for the scanning process to finish. The applications have to provide callback functions to react to the
101
+ * events of a successful scanning, an error during scanning, and the live input on the dialog.
102
+ *
103
+ * `fnSuccess` is passed an object with text, format and cancelled properties. Text is the text representation
104
+ * of the barcode data, format is the type of the barcode detected, and cancelled is whether or not the
105
+ * user cancelled the scan. `fnError` is given the error, `fnLiveUpdate` is passed the new value entered
106
+ * in the dialog's input field. An example:
107
+ *
108
+ *
109
+ * ```javascript
110
+ *
111
+ * sap.ui.require(["sap/ndc/BarcodeScanner"], function(BarcodeScanner) {
112
+ * BarcodeScanner.scan(
113
+ * function (mResult) {
114
+ * alert("We got a barcode\n" +
115
+ * "Result: " + mResult.text + "\n" +
116
+ * "Format: " + mResult.format + "\n" +
117
+ * "Cancelled: " + mResult.cancelled);
118
+ * },
119
+ * function (Error) {
120
+ * alert("Scanning failed: " + Error);
121
+ * },
122
+ * function (mParams) {
123
+ * alert("Value entered: " + mParams.newValue);
124
+ * },
125
+ * "Enter Product Barcode",
126
+ * true,
127
+ * 30,
128
+ * 1,
129
+ * false
130
+ * );
131
+ * });
132
+ * ```
133
+ */
134
+ scan(
135
+ /**
136
+ * Function to be called when the scanning is done or cancelled
137
+ */
138
+ fnSuccess?: Function,
139
+ /**
140
+ * Function to be called when the scanning is failed
141
+ */
142
+ fnFail?: Function,
143
+ /**
144
+ * Function to be called when value of the dialog's input is changed
145
+ */
146
+ fnLiveUpdate?: Function,
147
+ /**
148
+ * Defines the barcode input dialog title. If unset, a predefined title will be used.
149
+ */
150
+ dialogTitle?: string,
151
+ /**
152
+ * Flag, which defines whether the front or back camera should be used.
153
+ */
154
+ preferFrontCamera?: boolean,
155
+ /**
156
+ * Defines the frame rate of the camera.
157
+ */
158
+ frameRate?: float,
159
+ /**
160
+ * Defines the zoom of the camera. This parameter is not supported on iOS.
161
+ */
162
+ zoom?: float,
163
+ /**
164
+ * Flag, which defines whether the camera should be used for scanning in Zebra Enterprise Browser.
165
+ */
166
+ keepCameraScan?: boolean
167
+ ): void;
168
+ /**
169
+ * Set the configs of the control Barcode Scanner.
170
+ */
171
+ setConfig(
172
+ /**
173
+ * The options are the configs that will be used to scan. It is a object which contains below key and value:
174
+ * { "enableGS1Header": true, //If set to true, add the symbology identifier (GS1 specification 5.4.3.7.
175
+ * and 5.4.6.4.) as prefix into the result text "deviceId": "string" // The specific camera id to scan the
176
+ * Barcode. If set to "", Barcode Scanner will use default camera. This option is not working for iOS devices
177
+ * since do not support to get all the cameras. }
178
+ */
179
+ options?: object
180
+ ): void;
181
+ /**
182
+ * Set the callback function for the physical scan button.
183
+ */
184
+ setPhysicalScan(
185
+ /**
186
+ * Function to be called when the scanning is done by pressing physical scan button.
187
+ */
188
+ fnPhysicalScan?: Function
189
+ ): void;
190
+ /**
191
+ * Set the scanner API info that will be used to scan the barcode.
192
+ *
193
+ * IMPORTANT: The status of the scanner API must be **"Available"**(for ZXingCPP and ZXing, status is **NOT
194
+ * "UnAvailable"**), or will return False. Scanner APIs with status value can be got by using {@link #getStatusModel}.
195
+ * By default, Barcode Scanner will select the scanner API(Available) with priority: ZebraEnterpriseBrowser
196
+ * > Cordova > ZXingCPP > ZXing.
197
+ *
198
+ * @returns Return True if set success.
199
+ */
200
+ setScanAPIInfo(
201
+ /**
202
+ * Defines the scanner API to scan the barcode. Scanner API can be "ZebraEnterpriseBrowser", "Cordova",
203
+ * "ZXingCPP" or "ZXing".
204
+ */
205
+ scannerAPI?: string
206
+ ): boolean;
207
+ }
208
+ const BarcodeScanner: BarcodeScanner;
209
+ export default BarcodeScanner;
210
+ }
211
+
212
+ declare module "sap/ndc/BarcodeScannerButton" {
213
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
214
+
215
+ import Event from "sap/ui/base/Event";
216
+
217
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
218
+
219
+ import { CSSSize } from "sap/ui/core/library";
220
+
221
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
222
+
223
+ /**
224
+ * A button control (displaying a barcode icon) to start the barcode scanning process. If the native scanning
225
+ * feature is not available or camera capability is not granted, the button is either hidden or it provides
226
+ * a fallback by opening a dialog with an input field where the barcode can be entered manually.
227
+ */
228
+ export default class BarcodeScannerButton extends Control {
229
+ /**
230
+ * Constructor for a new BarcodeScannerButton.
231
+ *
232
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
233
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
234
+ * of the syntax of the settings object.
235
+ */
236
+ constructor(
237
+ /**
238
+ * initial settings for the new control
239
+ */
240
+ mSettings?: $BarcodeScannerButtonSettings
241
+ );
242
+ /**
243
+ * Constructor for a new BarcodeScannerButton.
244
+ *
245
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
246
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
247
+ * of the syntax of the settings object.
248
+ */
249
+ constructor(
250
+ /**
251
+ * id for the new control, generated automatically if no id is given
252
+ */
253
+ sId?: string,
254
+ /**
255
+ * initial settings for the new control
256
+ */
257
+ mSettings?: $BarcodeScannerButtonSettings
258
+ );
259
+
260
+ /**
261
+ * Creates a new subclass of class sap.ndc.BarcodeScannerButton with name `sClassName` and enriches it with
262
+ * the information contained in `oClassInfo`.
263
+ *
264
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
265
+ *
266
+ * @returns Created class / constructor function
267
+ */
268
+ static extend<T extends Record<string, unknown>>(
269
+ /**
270
+ * Name of the class being created
271
+ */
272
+ sClassName: string,
273
+ /**
274
+ * Object literal with information about the class
275
+ */
276
+ oClassInfo?: sap.ClassInfo<T, BarcodeScannerButton>,
277
+ /**
278
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
279
+ * used by this class
280
+ */
281
+ FNMetaImpl?: Function
282
+ ): Function;
283
+ /**
284
+ * Returns a metadata object for class sap.ndc.BarcodeScannerButton.
285
+ *
286
+ * @returns Metadata object describing this class
287
+ */
288
+ static getMetadata(): ElementMetadata;
289
+ /**
290
+ * Attaches event handler `fnFunction` to the {@link #event:inputLiveUpdate inputLiveUpdate} event of this
291
+ * `sap.ndc.BarcodeScannerButton`.
292
+ *
293
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
294
+ * otherwise it will be bound to this `sap.ndc.BarcodeScannerButton` itself.
295
+ *
296
+ * Event is fired when the text in the dialog's input field is changed.
297
+ *
298
+ * @returns Reference to `this` in order to allow method chaining
299
+ */
300
+ attachInputLiveUpdate(
301
+ /**
302
+ * An application-specific payload object that will be passed to the event handler along with the event
303
+ * object when firing the event
304
+ */
305
+ oData: object,
306
+ /**
307
+ * The function to be called when the event occurs
308
+ */
309
+ fnFunction: (p1: Event) => void,
310
+ /**
311
+ * Context object to call the event handler with. Defaults to this `sap.ndc.BarcodeScannerButton` itself
312
+ */
313
+ oListener?: object
314
+ ): this;
315
+ /**
316
+ * Attaches event handler `fnFunction` to the {@link #event:inputLiveUpdate inputLiveUpdate} event of this
317
+ * `sap.ndc.BarcodeScannerButton`.
318
+ *
319
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
320
+ * otherwise it will be bound to this `sap.ndc.BarcodeScannerButton` itself.
321
+ *
322
+ * Event is fired when the text in the dialog's input field is changed.
323
+ *
324
+ * @returns Reference to `this` in order to allow method chaining
325
+ */
326
+ attachInputLiveUpdate(
327
+ /**
328
+ * The function to be called when the event occurs
329
+ */
330
+ fnFunction: (p1: Event) => void,
331
+ /**
332
+ * Context object to call the event handler with. Defaults to this `sap.ndc.BarcodeScannerButton` itself
333
+ */
334
+ oListener?: object
335
+ ): this;
336
+ /**
337
+ * Attaches event handler `fnFunction` to the {@link #event:scanFail scanFail} event of this `sap.ndc.BarcodeScannerButton`.
338
+ *
339
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
340
+ * otherwise it will be bound to this `sap.ndc.BarcodeScannerButton` itself.
341
+ *
342
+ * Event is fired when the native scanning process is failed.
343
+ *
344
+ * @returns Reference to `this` in order to allow method chaining
345
+ */
346
+ attachScanFail(
347
+ /**
348
+ * An application-specific payload object that will be passed to the event handler along with the event
349
+ * object when firing the event
350
+ */
351
+ oData: object,
352
+ /**
353
+ * The function to be called when the event occurs
354
+ */
355
+ fnFunction: (p1: Event) => void,
356
+ /**
357
+ * Context object to call the event handler with. Defaults to this `sap.ndc.BarcodeScannerButton` itself
358
+ */
359
+ oListener?: object
360
+ ): this;
361
+ /**
362
+ * Attaches event handler `fnFunction` to the {@link #event:scanFail scanFail} event of this `sap.ndc.BarcodeScannerButton`.
363
+ *
364
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
365
+ * otherwise it will be bound to this `sap.ndc.BarcodeScannerButton` itself.
366
+ *
367
+ * Event is fired when the native scanning process is failed.
368
+ *
369
+ * @returns Reference to `this` in order to allow method chaining
370
+ */
371
+ attachScanFail(
372
+ /**
373
+ * The function to be called when the event occurs
374
+ */
375
+ fnFunction: (p1: Event) => void,
376
+ /**
377
+ * Context object to call the event handler with. Defaults to this `sap.ndc.BarcodeScannerButton` itself
378
+ */
379
+ oListener?: object
380
+ ): this;
381
+ /**
382
+ * Attaches event handler `fnFunction` to the {@link #event:scanSuccess scanSuccess} event of this `sap.ndc.BarcodeScannerButton`.
383
+ *
384
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
385
+ * otherwise it will be bound to this `sap.ndc.BarcodeScannerButton` itself.
386
+ *
387
+ * Event is fired when the scanning is finished or cancelled
388
+ *
389
+ * @returns Reference to `this` in order to allow method chaining
390
+ */
391
+ attachScanSuccess(
392
+ /**
393
+ * An application-specific payload object that will be passed to the event handler along with the event
394
+ * object when firing the event
395
+ */
396
+ oData: object,
397
+ /**
398
+ * The function to be called when the event occurs
399
+ */
400
+ fnFunction: (p1: Event) => void,
401
+ /**
402
+ * Context object to call the event handler with. Defaults to this `sap.ndc.BarcodeScannerButton` itself
403
+ */
404
+ oListener?: object
405
+ ): this;
406
+ /**
407
+ * Attaches event handler `fnFunction` to the {@link #event:scanSuccess scanSuccess} event of this `sap.ndc.BarcodeScannerButton`.
408
+ *
409
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
410
+ * otherwise it will be bound to this `sap.ndc.BarcodeScannerButton` itself.
411
+ *
412
+ * Event is fired when the scanning is finished or cancelled
413
+ *
414
+ * @returns Reference to `this` in order to allow method chaining
415
+ */
416
+ attachScanSuccess(
417
+ /**
418
+ * The function to be called when the event occurs
419
+ */
420
+ fnFunction: (p1: Event) => void,
421
+ /**
422
+ * Context object to call the event handler with. Defaults to this `sap.ndc.BarcodeScannerButton` itself
423
+ */
424
+ oListener?: object
425
+ ): this;
426
+ /**
427
+ * Detaches event handler `fnFunction` from the {@link #event:inputLiveUpdate inputLiveUpdate} event of
428
+ * this `sap.ndc.BarcodeScannerButton`.
429
+ *
430
+ * The passed function and listener object must match the ones used for event registration.
431
+ *
432
+ * @returns Reference to `this` in order to allow method chaining
433
+ */
434
+ detachInputLiveUpdate(
435
+ /**
436
+ * The function to be called, when the event occurs
437
+ */
438
+ fnFunction: (p1: Event) => void,
439
+ /**
440
+ * Context object on which the given function had to be called
441
+ */
442
+ oListener?: object
443
+ ): this;
444
+ /**
445
+ * Detaches event handler `fnFunction` from the {@link #event:scanFail scanFail} event of this `sap.ndc.BarcodeScannerButton`.
446
+ *
447
+ * The passed function and listener object must match the ones used for event registration.
448
+ *
449
+ * @returns Reference to `this` in order to allow method chaining
450
+ */
451
+ detachScanFail(
452
+ /**
453
+ * The function to be called, when the event occurs
454
+ */
455
+ fnFunction: (p1: Event) => void,
456
+ /**
457
+ * Context object on which the given function had to be called
458
+ */
459
+ oListener?: object
460
+ ): this;
461
+ /**
462
+ * Detaches event handler `fnFunction` from the {@link #event:scanSuccess scanSuccess} event of this `sap.ndc.BarcodeScannerButton`.
463
+ *
464
+ * The passed function and listener object must match the ones used for event registration.
465
+ *
466
+ * @returns Reference to `this` in order to allow method chaining
467
+ */
468
+ detachScanSuccess(
469
+ /**
470
+ * The function to be called, when the event occurs
471
+ */
472
+ fnFunction: (p1: Event) => void,
473
+ /**
474
+ * Context object on which the given function had to be called
475
+ */
476
+ oListener?: object
477
+ ): this;
478
+ /**
479
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
480
+ *
481
+ * Fires event {@link #event:inputLiveUpdate inputLiveUpdate} to attached listeners.
482
+ *
483
+ * @returns Reference to `this` in order to allow method chaining
484
+ */
485
+ fireInputLiveUpdate(
486
+ /**
487
+ * Parameters to pass along with the event
488
+ */
489
+ mParameters?: {
490
+ /**
491
+ * The new value of the input field.
492
+ */
493
+ newValue?: string;
494
+ }
495
+ ): this;
496
+ /**
497
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
498
+ *
499
+ * Fires event {@link #event:scanFail scanFail} to attached listeners.
500
+ *
501
+ * @returns Reference to `this` in order to allow method chaining
502
+ */
503
+ fireScanFail(
504
+ /**
505
+ * Parameters to pass along with the event
506
+ */
507
+ mParameters?: object
508
+ ): this;
509
+ /**
510
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
511
+ *
512
+ * Fires event {@link #event:scanSuccess scanSuccess} to attached listeners.
513
+ *
514
+ * @returns Reference to `this` in order to allow method chaining
515
+ */
516
+ fireScanSuccess(
517
+ /**
518
+ * Parameters to pass along with the event
519
+ */
520
+ mParameters?: {
521
+ /**
522
+ * The the text representation of the barcode data.
523
+ */
524
+ text?: string;
525
+ /**
526
+ * The type of the barcode detected.
527
+ */
528
+ format?: string;
529
+ /**
530
+ * Indicates whether or not the user cancelled the scan.
531
+ */
532
+ cancelled?: boolean;
533
+ }
534
+ ): this;
535
+ /**
536
+ * Gets current value of property {@link #getDialogTitle dialogTitle}.
537
+ *
538
+ * Defines the barcode input dialog title. If unset, a predefined title will be used.
539
+ *
540
+ * @returns Value of property `dialogTitle`
541
+ */
542
+ getDialogTitle(): string;
543
+ /**
544
+ * Gets current value of property {@link #getFrameRate frameRate}.
545
+ *
546
+ * Defines the frame rate of the camera.
547
+ *
548
+ * @returns Value of property `frameRate`
549
+ */
550
+ getFrameRate(): float;
551
+ /**
552
+ * Gets current value of property {@link #getKeepCameraScan keepCameraScan}.
553
+ *
554
+ * If set to true, the camera should be used for scanning in Zebra Enterprise Browser.
555
+ *
556
+ * Default value is `false`.
557
+ *
558
+ * @returns Value of property `keepCameraScan`
559
+ */
560
+ getKeepCameraScan(): boolean;
561
+ /**
562
+ * Gets current value of property {@link #getPreferFrontCamera preferFrontCamera}.
563
+ *
564
+ * If set to true, the front camera will be used to decode.
565
+ *
566
+ * Default value is `false`.
567
+ *
568
+ * @returns Value of property `preferFrontCamera`
569
+ */
570
+ getPreferFrontCamera(): boolean;
571
+ /**
572
+ * Gets current value of property {@link #getProvideFallback provideFallback}.
573
+ *
574
+ * If set to true, the button remains visible if the scanner is not available and triggers a dialog to enter
575
+ * barcode.
576
+ *
577
+ * Default value is `true`.
578
+ *
579
+ * @returns Value of property `provideFallback`
580
+ */
581
+ getProvideFallback(): boolean;
582
+ /**
583
+ * Gets current value of property {@link #getWidth width}.
584
+ *
585
+ * Defines the width of the scanner button.
586
+ *
587
+ * @returns Value of property `width`
588
+ */
589
+ getWidth(): CSSSize;
590
+ /**
591
+ * Gets current value of property {@link #getZoom zoom}.
592
+ *
593
+ * Defines the zoom of the camera. This parameter is not supported on iOS.
594
+ *
595
+ * @returns Value of property `zoom`
596
+ */
597
+ getZoom(): float;
598
+ /**
599
+ * Sets a new value for property {@link #getDialogTitle dialogTitle}.
600
+ *
601
+ * Defines the barcode input dialog title. If unset, a predefined title will be used.
602
+ *
603
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
604
+ *
605
+ * @returns Reference to `this` in order to allow method chaining
606
+ */
607
+ setDialogTitle(
608
+ /**
609
+ * New value for property `dialogTitle`
610
+ */
611
+ sDialogTitle?: string
612
+ ): this;
613
+ /**
614
+ * Sets a new value for property {@link #getFrameRate frameRate}.
615
+ *
616
+ * Defines the frame rate of the camera.
617
+ *
618
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
619
+ *
620
+ * @returns Reference to `this` in order to allow method chaining
621
+ */
622
+ setFrameRate(
623
+ /**
624
+ * New value for property `frameRate`
625
+ */
626
+ fFrameRate: float
627
+ ): this;
628
+ /**
629
+ * Sets a new value for property {@link #getKeepCameraScan keepCameraScan}.
630
+ *
631
+ * If set to true, the camera should be used for scanning in Zebra Enterprise Browser.
632
+ *
633
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
634
+ *
635
+ * Default value is `false`.
636
+ *
637
+ * @returns Reference to `this` in order to allow method chaining
638
+ */
639
+ setKeepCameraScan(
640
+ /**
641
+ * New value for property `keepCameraScan`
642
+ */
643
+ bKeepCameraScan?: boolean
644
+ ): this;
645
+ /**
646
+ * Sets a new value for property {@link #getPreferFrontCamera preferFrontCamera}.
647
+ *
648
+ * If set to true, the front camera will be used to decode.
649
+ *
650
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
651
+ *
652
+ * Default value is `false`.
653
+ *
654
+ * @returns Reference to `this` in order to allow method chaining
655
+ */
656
+ setPreferFrontCamera(
657
+ /**
658
+ * New value for property `preferFrontCamera`
659
+ */
660
+ bPreferFrontCamera?: boolean
661
+ ): this;
662
+ /**
663
+ * Sets a new value for property {@link #getProvideFallback provideFallback}.
664
+ *
665
+ * If set to true, the button remains visible if the scanner is not available and triggers a dialog to enter
666
+ * barcode.
667
+ *
668
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
669
+ *
670
+ * Default value is `true`.
671
+ *
672
+ * @returns Reference to `this` in order to allow method chaining
673
+ */
674
+ setProvideFallback(
675
+ /**
676
+ * New value for property `provideFallback`
677
+ */
678
+ bProvideFallback?: boolean
679
+ ): this;
680
+ /**
681
+ * Sets a new value for property {@link #getWidth width}.
682
+ *
683
+ * Defines the width of the scanner button.
684
+ *
685
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
686
+ *
687
+ * @returns Reference to `this` in order to allow method chaining
688
+ */
689
+ setWidth(
690
+ /**
691
+ * New value for property `width`
692
+ */
693
+ sWidth?: CSSSize
694
+ ): this;
695
+ /**
696
+ * Sets a new value for property {@link #getZoom zoom}.
697
+ *
698
+ * Defines the zoom of the camera. This parameter is not supported on iOS.
699
+ *
700
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
701
+ *
702
+ * @returns Reference to `this` in order to allow method chaining
703
+ */
704
+ setZoom(
705
+ /**
706
+ * New value for property `zoom`
707
+ */
708
+ fZoom: float
709
+ ): this;
710
+ }
711
+
712
+ export interface $BarcodeScannerButtonSettings extends $ControlSettings {
713
+ /**
714
+ * If set to true, the button remains visible if the scanner is not available and triggers a dialog to enter
715
+ * barcode.
716
+ */
717
+ provideFallback?: boolean | PropertyBindingInfo | `{${string}}`;
718
+
719
+ /**
720
+ * Defines the width of the scanner button.
721
+ */
722
+ width?: CSSSize | PropertyBindingInfo | `{${string}}`;
723
+
724
+ /**
725
+ * Defines the barcode input dialog title. If unset, a predefined title will be used.
726
+ */
727
+ dialogTitle?: string | PropertyBindingInfo;
728
+
729
+ /**
730
+ * If set to true, the front camera will be used to decode.
731
+ */
732
+ preferFrontCamera?: boolean | PropertyBindingInfo | `{${string}}`;
733
+
734
+ /**
735
+ * Defines the frame rate of the camera.
736
+ */
737
+ frameRate?: float | PropertyBindingInfo | `{${string}}`;
738
+
739
+ /**
740
+ * Defines the zoom of the camera. This parameter is not supported on iOS.
741
+ */
742
+ zoom?: float | PropertyBindingInfo | `{${string}}`;
743
+
744
+ /**
745
+ * If set to true, the camera should be used for scanning in Zebra Enterprise Browser.
746
+ */
747
+ keepCameraScan?: boolean | PropertyBindingInfo | `{${string}}`;
748
+
749
+ /**
750
+ * Event is fired when the scanning is finished or cancelled
751
+ */
752
+ scanSuccess?: (oEvent: Event) => void;
753
+
754
+ /**
755
+ * Event is fired when the native scanning process is failed.
756
+ */
757
+ scanFail?: (oEvent: Event) => void;
758
+
759
+ /**
760
+ * Event is fired when the text in the dialog's input field is changed.
761
+ */
762
+ inputLiveUpdate?: (oEvent: Event) => void;
763
+ }
764
+ }
765
+
766
+ declare namespace sap {
767
+ interface IUI5DefineDependencyNames {
768
+ "sap/ndc/BarcodeScanner": undefined;
769
+
770
+ "sap/ndc/BarcodeScannerButton": undefined;
771
+
772
+ "sap/ndc/library": undefined;
773
+ }
774
+ }