@openfin/node-adapter 35.78.16 → 35.78.17
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/README.md +1 -1
- package/out/node-adapter-alpha.d.ts +549 -1714
- package/out/node-adapter-beta.d.ts +549 -1714
- package/out/node-adapter-public.d.ts +549 -1714
- package/out/node-adapter.d.ts +562 -1804
- package/out/node-adapter.js +0 -1243
- package/package.json +1 -1
package/out/node-adapter.js
CHANGED
@@ -2403,169 +2403,6 @@ function requireInstance$2 () {
|
|
2403
2403
|
const layout_constants_1 = layout_constants;
|
2404
2404
|
const main_1 = main;
|
2405
2405
|
const window_1 = requireWindow();
|
2406
|
-
/**
|
2407
|
-
* @PORTED
|
2408
|
-
* @typedef {object} View~options
|
2409
|
-
* @summary View creation options.
|
2410
|
-
* @desc This is the options object required by {@link View.create View.create}.
|
2411
|
-
*
|
2412
|
-
* Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
|
2413
|
-
* (defaults to `"about:blank"` when omitted).
|
2414
|
-
*
|
2415
|
-
* @property {object} [experimental]
|
2416
|
-
* Configurations for API injection.
|
2417
|
-
*
|
2418
|
-
* @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
|
2419
|
-
*
|
2420
|
-
* @property {object} [accelerator]
|
2421
|
-
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
2422
|
-
*
|
2423
|
-
* @property {boolean} [accelerator.devtools=false]
|
2424
|
-
* If `true`, enables the devtools keyboard shortcut:<br>
|
2425
|
-
* `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
|
2426
|
-
*
|
2427
|
-
* @property {boolean} [accelerator.reload=false]
|
2428
|
-
* If `true`, enables the reload keyboard shortcuts:<br>
|
2429
|
-
* `Ctrl` + `R` _(Windows)_<br>
|
2430
|
-
* `F5` _(Windows)_<br>
|
2431
|
-
* `Command` + `R` _(Mac)_
|
2432
|
-
*
|
2433
|
-
* @property {boolean} [accelerator.reloadIgnoringCache=false]
|
2434
|
-
* If `true`, enables the reload-from-source keyboard shortcuts:<br>
|
2435
|
-
* `Ctrl` + `Shift` + `R` _(Windows)_<br>
|
2436
|
-
* `Shift` + `F5` _(Windows)_<br>
|
2437
|
-
* `Command` + `Shift` + `R` _(Mac)_
|
2438
|
-
*
|
2439
|
-
* @property {boolean} [accelerator.zoom=false]
|
2440
|
-
* If `true`, enables the zoom keyboard shortcuts:<br>
|
2441
|
-
* `Ctrl` + `+` _(Zoom In)_<br>
|
2442
|
-
* `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
|
2443
|
-
* `Ctrl` + `NumPad+` _(Zoom In)_<br>
|
2444
|
-
* `Ctrl` + `-` _(Zoom Out)_<br>
|
2445
|
-
* `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
|
2446
|
-
* `Ctrl` + `NumPad-` _(Zoom Out)_<br>
|
2447
|
-
* `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
|
2448
|
-
* `Ctrl` + `0` _(Restore to 100%)_
|
2449
|
-
*
|
2450
|
-
* @property {object} [api]
|
2451
|
-
* Configurations for API injection.
|
2452
|
-
*
|
2453
|
-
* @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
|
2454
|
-
*
|
2455
|
-
* @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
|
2456
|
-
* @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
|
2457
|
-
*
|
2458
|
-
* @property {string} [autoplayPolicy="no-user-gesture-required"]
|
2459
|
-
* Autoplay policy to apply to content in the window, can be
|
2460
|
-
* `no-user-gesture-required`, `user-gesture-required`,
|
2461
|
-
* `document-user-activation-required`. Defaults to `no-user-gesture-required`.
|
2462
|
-
*
|
2463
|
-
* @property {object} [autoResize] AutoResize options
|
2464
|
-
*
|
2465
|
-
* @property {object} [bounds] initial bounds given relative to the window.
|
2466
|
-
*
|
2467
|
-
* @property {string} [backgroundColor="#FFF"] - _Updatable._
|
2468
|
-
* The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
|
2469
|
-
* (`document.body.style.backgroundColor`),
|
2470
|
-
* this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
|
2471
|
-
* areas when growing a window. Setting
|
2472
|
-
* this value to the anticipated content background color can help improve user experience.
|
2473
|
-
* Default is white.
|
2474
|
-
*
|
2475
|
-
* @property {object} [contentNavigation]
|
2476
|
-
* Restrict navigation to URLs that match an allowed pattern.
|
2477
|
-
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
2478
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
2479
|
-
* @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
|
2480
|
-
* @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
|
2481
|
-
*
|
2482
|
-
* @property {object} [contentRedirect]
|
2483
|
-
* Restrict redirects to URLs that match an allowed pattern.
|
2484
|
-
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
2485
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
2486
|
-
* @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
|
2487
|
-
* @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
|
2488
|
-
*
|
2489
|
-
* @property {object} [contextMenuSettings] - _Updatable._
|
2490
|
-
* Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
2491
|
-
* Configure the context menu when right-clicking on a view.
|
2492
|
-
* @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
|
2493
|
-
* @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
|
2494
|
-
* @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
|
2495
|
-
*
|
2496
|
-
* @property {object} [contextMenuOptions] - _Updatable._
|
2497
|
-
* Configure the context menu when right-clicking on a view. Supported menu items:
|
2498
|
-
* 'separator'
|
2499
|
-
* 'cut'
|
2500
|
-
* 'copy'
|
2501
|
-
* 'copyImage',
|
2502
|
-
* 'paste'
|
2503
|
-
* 'spellCheck'
|
2504
|
-
* 'inspect'
|
2505
|
-
* 'reload'
|
2506
|
-
* 'navigateForward'
|
2507
|
-
* 'navigateBack'
|
2508
|
-
* 'print'
|
2509
|
-
* @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
|
2510
|
-
* @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
|
2511
|
-
*
|
2512
|
-
* @property {any} [customData=""] - _Updatable._
|
2513
|
-
* A field that the user can attach serializable data to be ferried around with the view options.
|
2514
|
-
* _When omitted, the default value of this property is the empty string (`""`)._
|
2515
|
-
*
|
2516
|
-
* @property {any} [customContext=""] - _Updatable._
|
2517
|
-
* A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
|
2518
|
-
* is called.
|
2519
|
-
* When omitted, the default value of this property is the empty string (`""`).
|
2520
|
-
* As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
|
2521
|
-
*
|
2522
|
-
* @property {object[]} [hotkeys=[]] - _Updatable._
|
2523
|
-
* Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
|
2524
|
-
* Within Platform, OpenFin also implements a set of pre-defined actions called
|
2525
|
-
* [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
|
2526
|
-
* that can be assigned to a specific hotkey in the platform manifest.
|
2527
|
-
* @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
|
2528
|
-
* @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
|
2529
|
-
*
|
2530
|
-
* @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
|
2531
|
-
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
2532
|
-
* if the view isn't part of the new layout when running `Layout.replace`.
|
2533
|
-
*
|
2534
|
-
* @property {string} name
|
2535
|
-
* The name of the view.
|
2536
|
-
*
|
2537
|
-
* @property {boolean} [detachOnClose=false] - _Updatable._
|
2538
|
-
* Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
|
2539
|
-
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
2540
|
-
*
|
2541
|
-
* @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
|
2542
|
-
* but the properties in the manifest will take precedence if there is any collision.
|
2543
|
-
*
|
2544
|
-
* @property {preloadScript[]} [preloadScripts] - _Inheritable_
|
2545
|
-
* A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
|
2546
|
-
* from the parent application.
|
2547
|
-
*
|
2548
|
-
* @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
2549
|
-
*
|
2550
|
-
* @property {string} [processAffinity=<application uuid>]
|
2551
|
-
* A string to attempt to group renderers together. Will only be used if pages are on the same origin.
|
2552
|
-
*
|
2553
|
-
* @property {boolean} [spellCheck=false]
|
2554
|
-
* Enable spell check in input text fields for the view.
|
2555
|
-
*
|
2556
|
-
* @property {Identity} [target]
|
2557
|
-
* The identity of the window this view should be attached to.
|
2558
|
-
*
|
2559
|
-
* @property {string} [url="about:blank"]
|
2560
|
-
* The URL of the view.
|
2561
|
-
*
|
2562
|
-
* @property {string} [uuid=<application uuid>]
|
2563
|
-
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
2564
|
-
* If omitted, defaults to the `uuid` of the application spawning the view.
|
2565
|
-
* If given, must match the `uuid` of the application spawning the view.
|
2566
|
-
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
2567
|
-
* really no need to provide it.
|
2568
|
-
*/
|
2569
2406
|
/**
|
2570
2407
|
* A View can be used to embed additional web content into a Window.
|
2571
2408
|
* It is like a child window, except it is positioned relative to its owning window.
|
@@ -3189,100 +3026,6 @@ function requireInstance$1 () {
|
|
3189
3026
|
});
|
3190
3027
|
return windowList;
|
3191
3028
|
}
|
3192
|
-
/**
|
3193
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
3194
|
-
* @param eventType - The type of the event.
|
3195
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
3196
|
-
* @param options - Option to support event timestamps.
|
3197
|
-
*
|
3198
|
-
* @function addListener
|
3199
|
-
* @memberof Application
|
3200
|
-
* @instance
|
3201
|
-
* @tutorial Application.EventEmitter
|
3202
|
-
*/
|
3203
|
-
/**
|
3204
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
3205
|
-
* @param eventType - The type of the event.
|
3206
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
3207
|
-
* @param options - Option to support event timestamps.
|
3208
|
-
*
|
3209
|
-
* @function on
|
3210
|
-
* @memberof Application
|
3211
|
-
* @instance
|
3212
|
-
* @tutorial Application.EventEmitter
|
3213
|
-
*/
|
3214
|
-
/**
|
3215
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
3216
|
-
* @param eventType - The type of the event.
|
3217
|
-
* @param listener - The callback function.
|
3218
|
-
* @param options - Option to support event timestamps.
|
3219
|
-
*
|
3220
|
-
* @function once
|
3221
|
-
* @memberof Application
|
3222
|
-
* @instance
|
3223
|
-
* @tutorial Application.EventEmitter
|
3224
|
-
*/
|
3225
|
-
/**
|
3226
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
3227
|
-
* @param eventType - The type of the event.
|
3228
|
-
* @param listener - The callback function.
|
3229
|
-
* @param options - Option to support event timestamps.
|
3230
|
-
*
|
3231
|
-
* @function prependListener
|
3232
|
-
* @memberof Application
|
3233
|
-
* @instance
|
3234
|
-
* @tutorial Application.EventEmitter
|
3235
|
-
*/
|
3236
|
-
/**
|
3237
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
3238
|
-
* The listener is added to the beginning of the listeners array.
|
3239
|
-
* @param eventType - The type of the event.
|
3240
|
-
* @param listener - The callback function.
|
3241
|
-
* @param options - Option to support event timestamps.
|
3242
|
-
*
|
3243
|
-
* @function prependOnceListener
|
3244
|
-
* @memberof Application
|
3245
|
-
* @instance
|
3246
|
-
* @tutorial Application.EventEmitter
|
3247
|
-
*/
|
3248
|
-
/**
|
3249
|
-
* Remove a listener from the listener array for the specified event.
|
3250
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
3251
|
-
* @param eventType - The type of the event.
|
3252
|
-
* @param listener - The callback function.
|
3253
|
-
* @param options - Option to support event timestamps.
|
3254
|
-
*
|
3255
|
-
* @function removeListener
|
3256
|
-
* @memberof Application
|
3257
|
-
* @instance
|
3258
|
-
* @tutorial Application.EventEmitter
|
3259
|
-
*/
|
3260
|
-
/**
|
3261
|
-
* Removes all listeners, or those of the specified event.
|
3262
|
-
* @param eventType - The type of the event.
|
3263
|
-
*
|
3264
|
-
* @function removeAllListeners
|
3265
|
-
* @memberof Application
|
3266
|
-
* @instance
|
3267
|
-
* @tutorial Application.EventEmitter
|
3268
|
-
*/
|
3269
|
-
/**
|
3270
|
-
* JumpListCategory interface
|
3271
|
-
* @typedef { object } JumpListCategory
|
3272
|
-
* @property { string } name The display title for the category. If omitted, items in this category will be placed into the standard 'Tasks' category. There can be only one such category, and it will always be displayed at the bottom of the JumpList.
|
3273
|
-
* @property { JumpListItem[] } items Array of JumpListItem objects
|
3274
|
-
*/
|
3275
|
-
/**
|
3276
|
-
* @PORTED
|
3277
|
-
* JumpListItem interface
|
3278
|
-
* @typedef { object } JumpListItem
|
3279
|
-
* @property { string } type One of the following: "task" or "separator". Defaults to task.
|
3280
|
-
* @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
|
3281
|
-
* @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
|
3282
|
-
* @property { string } deepLink Deep link to a manifest, i.e: fins://path.to/manifest.json?$$param1=value1. See {@link https://developers.openfin.co/docs/deep-linking deep-linking} for more information.
|
3283
|
-
* @property { string } iconPath The absolute path to an icon to be displayed for the item, which can be an arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll).
|
3284
|
-
* @property { number } iconIndex The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero.
|
3285
|
-
*/
|
3286
3029
|
/**
|
3287
3030
|
* Determines if the application is currently running.
|
3288
3031
|
*
|
@@ -4308,476 +4051,6 @@ function requireInstance () {
|
|
4308
4051
|
const main_1 = main;
|
4309
4052
|
const view_1 = requireView();
|
4310
4053
|
const warnings_1 = warnings;
|
4311
|
-
/**
|
4312
|
-
* @PORTED
|
4313
|
-
* @typedef { object } Margins
|
4314
|
-
* @property { string } [marginType]
|
4315
|
-
* Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
|
4316
|
-
* you will also need to specify `top`, `bottom`, `left`, and `right`.
|
4317
|
-
*
|
4318
|
-
* @property { number } [top] The top margin of the printed web page, in pixels.
|
4319
|
-
* @property { number } [bottom] The bottom margin of the printed web page, in pixels.
|
4320
|
-
* @property { number } [left] The left margin of the printed web page, in pixels.
|
4321
|
-
* @property { number } [right] The right margin of the printed web page, in pixels.
|
4322
|
-
*/
|
4323
|
-
/**
|
4324
|
-
* @PORTED
|
4325
|
-
* @typedef { object } Dpi
|
4326
|
-
* @property { number } [horizontal] The horizontal dpi
|
4327
|
-
* @property { number } [vertical] The vertical dpi
|
4328
|
-
*/
|
4329
|
-
/**
|
4330
|
-
* @PORTED
|
4331
|
-
* @typedef { object } PrintOptions
|
4332
|
-
* @property { boolean } [silent=false] Don't ask user for print settings.
|
4333
|
-
* @property { boolean } [printBackground=false] Prints the background color and image of the web page.
|
4334
|
-
* @property { string } [deviceName=''] Set the printer device name to use.
|
4335
|
-
* @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
|
4336
|
-
* @property { Margins } [margins] Set margins for the printed web page
|
4337
|
-
* @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
|
4338
|
-
* @property { number } [scaleFactor] The scale factor of the web page.
|
4339
|
-
* @property { number } [pagesPerSheet] The number of pages to print per page sheet.
|
4340
|
-
* @property { boolean } [collate] Whether the web page should be collated.
|
4341
|
-
* @property { number } [copies] The number of copies of the web page to print.
|
4342
|
-
* @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
|
4343
|
-
* @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
|
4344
|
-
* @property { Dpi } [dpi] Set dpi for the printed web page
|
4345
|
-
*/
|
4346
|
-
/**
|
4347
|
-
* @REMOVED
|
4348
|
-
* PrinterInfo interface
|
4349
|
-
* @typedef { object } PrinterInfo
|
4350
|
-
* @property { string } name Printer Name
|
4351
|
-
* @property { string } description Printer Description
|
4352
|
-
* @property { number } status Printer Status
|
4353
|
-
* @property { boolean } isDefault Indicates that system's default printer
|
4354
|
-
*/
|
4355
|
-
/**
|
4356
|
-
* @REMOVED
|
4357
|
-
* SharedWorkerInfo interface
|
4358
|
-
* @typedef { object } SharedWorkerInfo
|
4359
|
-
* @property { string } id The unique id of the shared worker.
|
4360
|
-
* @property { string } url The url of the shared worker.
|
4361
|
-
*/
|
4362
|
-
/**
|
4363
|
-
* @PORTED
|
4364
|
-
* ContentCreationRule interface
|
4365
|
-
* @typedef { object } ContentCreationRule
|
4366
|
-
* @property { string } behavior 'view' | 'window' | 'browser' | 'block'
|
4367
|
-
* @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
|
4368
|
-
* @property { object } options Window creation options or View creation options.
|
4369
|
-
*/
|
4370
|
-
/**
|
4371
|
-
* @PORTED
|
4372
|
-
* @typedef {object} Window~options
|
4373
|
-
* @summary Window creation options.
|
4374
|
-
* @desc This is the options object required by {@link Window.create Window.create}.
|
4375
|
-
*
|
4376
|
-
* Note that `name` is the only required property — albeit the `url` property is usually provided as well
|
4377
|
-
* (defaults to `"about:blank"` when omitted).
|
4378
|
-
*
|
4379
|
-
* _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
|
4380
|
-
*
|
4381
|
-
* @property {object} [accelerator]
|
4382
|
-
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
4383
|
-
*
|
4384
|
-
* @property {boolean} [accelerator.devtools=false]
|
4385
|
-
* If `true`, enables the devtools keyboard shortcut:<br>
|
4386
|
-
* `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
|
4387
|
-
*
|
4388
|
-
* @property {boolean} [accelerator.reload=false]
|
4389
|
-
* If `true`, enables the reload keyboard shortcuts:<br>
|
4390
|
-
* `Ctrl` + `R` _(Windows)_<br>
|
4391
|
-
* `F5` _(Windows)_<br>
|
4392
|
-
* `Command` + `R` _(Mac)_
|
4393
|
-
*
|
4394
|
-
* @property {boolean} [accelerator.reloadIgnoringCache=false]
|
4395
|
-
* If `true`, enables the reload-from-source keyboard shortcuts:<br>
|
4396
|
-
* `Ctrl` + `Shift` + `R` _(Windows)_<br>
|
4397
|
-
* `Shift` + `F5` _(Windows)_<br>
|
4398
|
-
* `Command` + `Shift` + `R` _(Mac)_
|
4399
|
-
*
|
4400
|
-
* @property {boolean} [accelerator.zoom=false]
|
4401
|
-
* NOTE: It is not recommended to set this value to true for Windows in Platforms as that may lead to unexpected visual shifts in layout.
|
4402
|
-
* If `true`, enables the zoom keyboard shortcuts:<br>
|
4403
|
-
* `Ctrl` + `+` _(Zoom In)_<br>
|
4404
|
-
* `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
|
4405
|
-
* `Ctrl` + `NumPad+` _(Zoom In)_<br>
|
4406
|
-
* `Ctrl` + `-` _(Zoom Out)_<br>
|
4407
|
-
* `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
|
4408
|
-
* `Ctrl` + `NumPad-` _(Zoom Out)_<br>
|
4409
|
-
* `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
|
4410
|
-
* `Ctrl` + `0` _(Restore to 100%)_
|
4411
|
-
*
|
4412
|
-
* @property {object} [alphaMask] - _Experimental._ _Updatable._
|
4413
|
-
* <br>
|
4414
|
-
* alphaMask turns anything of matching RGB value transparent.
|
4415
|
-
* <br>
|
4416
|
-
* Caveats:
|
4417
|
-
* * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
|
4418
|
-
* * User cannot click-through transparent regions
|
4419
|
-
* * Not supported on Mac
|
4420
|
-
* * Windows Aero must be enabled
|
4421
|
-
* * Won't make visual sense on Pixel-pushed environments such as Citrix
|
4422
|
-
* * Not supported on rounded corner windows
|
4423
|
-
* @property {number} [alphaMask.red=-1] 0-255
|
4424
|
-
* @property {number} [alphaMask.green=-1] 0-255
|
4425
|
-
* @property {number} [alphaMask.blue=-1] 0-255
|
4426
|
-
*
|
4427
|
-
* @property {boolean} [alwaysOnTop=false] - _Updatable._
|
4428
|
-
* A flag to always position the window at the top of the window stack.
|
4429
|
-
*
|
4430
|
-
* @property {object} [api]
|
4431
|
-
* Configurations for API injection.
|
4432
|
-
*
|
4433
|
-
* @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
|
4434
|
-
*
|
4435
|
-
* @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
|
4436
|
-
* @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
|
4437
|
-
*
|
4438
|
-
* @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
|
4439
|
-
*
|
4440
|
-
* @property {number} [aspectRatio=0] - _Updatable._
|
4441
|
-
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
4442
|
-
* an aspect ratio will not be enforced.
|
4443
|
-
*
|
4444
|
-
* @property {string} [autoplayPolicy="no-user-gesture-required"]
|
4445
|
-
* Autoplay policy to apply to content in the window, can be
|
4446
|
-
* `no-user-gesture-required`, `user-gesture-required`,
|
4447
|
-
* `document-user-activation-required`. Defaults to `no-user-gesture-required`.
|
4448
|
-
*
|
4449
|
-
* @property {boolean} [autoShow=true]
|
4450
|
-
* A flag to automatically show the window when it is created.
|
4451
|
-
*
|
4452
|
-
* @property {string} [backgroundColor="#FFF"]
|
4453
|
-
* The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
|
4454
|
-
* (`document.body.style.backgroundColor`),
|
4455
|
-
* this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
|
4456
|
-
* areas when growing a window. Setting
|
4457
|
-
* this value to the anticipated content background color can help improve user experience.
|
4458
|
-
* Default is white.
|
4459
|
-
*
|
4460
|
-
* @property {object} [contentCreation]
|
4461
|
-
* Apply rules that determine how user interaction (`window.open` and links) creates content.
|
4462
|
-
* @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
|
4463
|
-
*
|
4464
|
-
* @property {object} [contentNavigation]
|
4465
|
-
* Restrict navigation to URLs that match an allowed pattern.
|
4466
|
-
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
4467
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
4468
|
-
* @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
|
4469
|
-
* @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
|
4470
|
-
*
|
4471
|
-
* @property {object} [contentRedirect]
|
4472
|
-
* Restrict redirects to URLs that match an allowed pattern.
|
4473
|
-
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
4474
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
4475
|
-
* @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
|
4476
|
-
* @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
|
4477
|
-
*
|
4478
|
-
* @property {boolean} [contextMenu=true] - _Updatable._
|
4479
|
-
* A flag to show the context menu when right-clicking on a window.
|
4480
|
-
* Gives access to the devtools for the window.
|
4481
|
-
*
|
4482
|
-
* @property {object} [contextMenuSettings] - _Updatable._
|
4483
|
-
* Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
4484
|
-
* Configure the context menu when right-clicking on a window.
|
4485
|
-
* @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
|
4486
|
-
* @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
|
4487
|
-
* @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
|
4488
|
-
*
|
4489
|
-
* @property {object} [contextMenuOptions] - _Updatable._
|
4490
|
-
* Configure the context menu when right-clicking on a window. Supported menu items:
|
4491
|
-
* 'separator'
|
4492
|
-
* 'cut'
|
4493
|
-
* 'copy'
|
4494
|
-
* 'paste'
|
4495
|
-
* 'spellCheck'
|
4496
|
-
* 'inspect'
|
4497
|
-
* 'reload'
|
4498
|
-
* 'navigateForward'
|
4499
|
-
* 'navigateBack'
|
4500
|
-
* 'print'
|
4501
|
-
* @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
|
4502
|
-
* @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
|
4503
|
-
*
|
4504
|
-
* @property {object} [cornerRounding] - _Updatable._
|
4505
|
-
* Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
|
4506
|
-
* average of _height_ and _width_.
|
4507
|
-
* @property {number} [cornerRounding.height=0] The height in pixels.
|
4508
|
-
* @property {number} [cornerRounding.width=0] The width in pixels.
|
4509
|
-
*
|
4510
|
-
* @property {any} [customContext=""] - _Updatable. Inheritable._
|
4511
|
-
* A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
|
4512
|
-
* is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
|
4513
|
-
* {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
|
4514
|
-
* _When omitted, _inherits_ from the parent application._
|
4515
|
-
* As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
|
4516
|
-
*
|
4517
|
-
* @property {any} [customData=""] - _Updatable. Inheritable._
|
4518
|
-
* A field that the user can attach serializable data to be ferried around with the window options.
|
4519
|
-
* _When omitted, _inherits_ from the parent application._
|
4520
|
-
*
|
4521
|
-
* @property {object[]} [customRequestHeaders]
|
4522
|
-
* Defines list of custom headers for requests sent by the window.
|
4523
|
-
* @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
|
4524
|
-
* @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
|
4525
|
-
* where the object key is the name of header and value at key is the value of the header
|
4526
|
-
*
|
4527
|
-
* @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
|
4528
|
-
* Toggling off would keep the Window alive even if all its Views were closed.
|
4529
|
-
* This is meant for advanced users and should be used with caution.
|
4530
|
-
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
4531
|
-
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
4532
|
-
* ** note ** - This option is ignored in non-Platforms apps.
|
4533
|
-
*
|
4534
|
-
* @property {boolean} [defaultCentered=false]
|
4535
|
-
* Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
|
4536
|
-
* this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
|
4537
|
-
* somewhat above center vertically.
|
4538
|
-
*
|
4539
|
-
* @property {number} [defaultHeight=500]
|
4540
|
-
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
4541
|
-
* in favor of the cached value.
|
4542
|
-
*
|
4543
|
-
* @property {number} [defaultLeft=100]
|
4544
|
-
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
4545
|
-
* launches in favor of the cached value.
|
4546
|
-
*
|
4547
|
-
* @property {number} [defaultTop=100]
|
4548
|
-
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
4549
|
-
* launches in favor of the cached value.
|
4550
|
-
*
|
4551
|
-
* @property {number} [defaultWidth=800]
|
4552
|
-
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
4553
|
-
* launches in favor of the cached value.
|
4554
|
-
*
|
4555
|
-
* @property {boolean} [includeInSnapshots=true] - _Updatable._
|
4556
|
-
* When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
4557
|
-
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
4558
|
-
*
|
4559
|
-
* @property {boolean} [frame=true] - _Updatable._
|
4560
|
-
* A flag to show the frame.
|
4561
|
-
*
|
4562
|
-
* @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
|
4563
|
-
*
|
4564
|
-
* @property {object[]} [hotkeys=[]] - _Updatable._
|
4565
|
-
* Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
|
4566
|
-
* Within Platform, OpenFin also implements a set of pre-defined actions called
|
4567
|
-
* [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
|
4568
|
-
* that can be assigned to a specific hotkey in the platform manifest.
|
4569
|
-
* @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
|
4570
|
-
* @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
|
4571
|
-
*
|
4572
|
-
* @property {string} [icon] - _Updatable. Inheritable._
|
4573
|
-
* A URL for the icon to be shown in the window title bar and the taskbar.
|
4574
|
-
* When omitted, inherits from the parent application._
|
4575
|
-
* note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
|
4576
|
-
*
|
4577
|
-
* @property {number} [maxHeight=-1] - _Updatable._
|
4578
|
-
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
4579
|
-
*
|
4580
|
-
* @property {boolean} [maximizable=true] - _Updatable._
|
4581
|
-
* A flag that lets the window be maximized.
|
4582
|
-
*
|
4583
|
-
* @property {number} [maxWidth=-1] - _Updatable._
|
4584
|
-
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
4585
|
-
*
|
4586
|
-
* @property {number} [minHeight=0] - _Updatable._
|
4587
|
-
* The minimum height of a window.
|
4588
|
-
*
|
4589
|
-
* @property {boolean} [minimizable=true] - _Updatable._
|
4590
|
-
* A flag that lets the window be minimized.
|
4591
|
-
*
|
4592
|
-
* @property {number} [minWidth=0] - _Updatable._
|
4593
|
-
* The minimum width of a window.
|
4594
|
-
*
|
4595
|
-
* @property {Identity} [modalParentIdentity]
|
4596
|
-
* Parent identity of a modal window. It will create a modal child window when this option is set.
|
4597
|
-
*
|
4598
|
-
* @property {string} name
|
4599
|
-
* The name of the window.
|
4600
|
-
*
|
4601
|
-
* @property {number} [opacity=1.0] - _Updatable._
|
4602
|
-
* A flag that specifies how transparent the window will be.
|
4603
|
-
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
4604
|
-
* This value is clamped between `0.0` and `1.0`.
|
4605
|
-
* * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
|
4606
|
-
*
|
4607
|
-
* @property {preloadScript[]} [preloadScripts] - _Inheritable_
|
4608
|
-
* A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
|
4609
|
-
* from the parent application.
|
4610
|
-
*
|
4611
|
-
* @property {string} [processAffinity]
|
4612
|
-
* A string to attempt to group renderers together. Will only be used if pages are on the same origin.
|
4613
|
-
*
|
4614
|
-
* @property {boolean} [resizable=true] - _Updatable._
|
4615
|
-
* A flag to allow the user to resize the window.
|
4616
|
-
*
|
4617
|
-
* @property {object} [resizeRegion] - _Updatable._
|
4618
|
-
* Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
|
4619
|
-
* @property {number} [resizeRegion.bottomRightCorner=9]
|
4620
|
-
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
4621
|
-
* @property {number} [resizeRegion.size=7]
|
4622
|
-
* The size in pixels.
|
4623
|
-
* @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
|
4624
|
-
* Sides that a window can be resized from.
|
4625
|
-
*
|
4626
|
-
* @property {boolean} [saveWindowState=true]
|
4627
|
-
* A flag to cache the location of the window.
|
4628
|
-
* ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
4629
|
-
*
|
4630
|
-
* @property {boolean} [ignoreSavedWindowState]
|
4631
|
-
* A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
|
4632
|
-
*
|
4633
|
-
* @property {boolean} [shadow=false]
|
4634
|
-
* A flag to display a shadow on frameless windows.
|
4635
|
-
* `shadow` and `cornerRounding` are mutually exclusive.
|
4636
|
-
* On Windows 7, Aero theme is required.
|
4637
|
-
*
|
4638
|
-
* @property {boolean} [showBackgroundImages=false] - _Updatable._
|
4639
|
-
* Platforms Only. If true, will show background images in the layout when the Views are hidden.
|
4640
|
-
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
4641
|
-
*
|
4642
|
-
* @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
|
4643
|
-
* A flag to show the window's icon in the taskbar.
|
4644
|
-
*
|
4645
|
-
* @property {boolean} [smallWindow=false]
|
4646
|
-
* A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
|
4647
|
-
* _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
|
4648
|
-
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
4649
|
-
*
|
4650
|
-
* @property {boolean} [spellCheck=false]
|
4651
|
-
* Enable spell check in input text fields for the window.
|
4652
|
-
*
|
4653
|
-
* @property {string} [state="normal"]
|
4654
|
-
* The visible state of the window on creation.
|
4655
|
-
* One of:
|
4656
|
-
* * `"maximized"`
|
4657
|
-
* * `"minimized"`
|
4658
|
-
* * `"normal"`
|
4659
|
-
*
|
4660
|
-
* @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
|
4661
|
-
*
|
4662
|
-
* @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
|
4663
|
-
* Specify a taskbar group for the window.
|
4664
|
-
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
4665
|
-
*
|
4666
|
-
* @property {string} [url="about:blank"]
|
4667
|
-
* The URL of the window.
|
4668
|
-
*
|
4669
|
-
* @property {string} [uuid=<application uuid>]
|
4670
|
-
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
4671
|
-
* If omitted, defaults to the `uuid` of the application spawning the window.
|
4672
|
-
* If given, must match the `uuid` of the application spawning the window.
|
4673
|
-
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
4674
|
-
* really no need to provide it.
|
4675
|
-
*
|
4676
|
-
* @property {boolean} [waitForPageLoad=false]
|
4677
|
-
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
4678
|
-
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
4679
|
-
*
|
4680
|
-
* @property {ViewVisibility} [viewVisibility]
|
4681
|
-
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
4682
|
-
*/
|
4683
|
-
/**
|
4684
|
-
* @PORTED
|
4685
|
-
* @typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
4686
|
-
* @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
|
4687
|
-
* @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
|
4688
|
-
* @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
|
4689
|
-
*/
|
4690
|
-
/**
|
4691
|
-
* @PORTED
|
4692
|
-
* @typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
4693
|
-
* @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
|
4694
|
-
* @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
|
4695
|
-
*/
|
4696
|
-
/**
|
4697
|
-
* @REMOVED
|
4698
|
-
* @typedef {Object} ShowViewsOnSplitterDrag _Platform Windows Only_. Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
|
4699
|
-
* @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
|
4700
|
-
*/
|
4701
|
-
/**
|
4702
|
-
* @REMOVED
|
4703
|
-
* @typedef {Object} ShowViewsOnTabDrag _Platform Windows Only_. Allows views to be shown when the user is manipulating the layout by repositioning a tab.
|
4704
|
-
* @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
|
4705
|
-
*/
|
4706
|
-
/**
|
4707
|
-
* @PORTED
|
4708
|
-
* @typedef {object} CapturePageOptions
|
4709
|
-
* @property { Area } [area] The area of the window to be captured.
|
4710
|
-
* @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
4711
|
-
* @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
|
4712
|
-
*/
|
4713
|
-
/**
|
4714
|
-
* @PORTED
|
4715
|
-
* @typedef { object } Area
|
4716
|
-
* @property { number } height Area's height
|
4717
|
-
* @property { number } width Area's width
|
4718
|
-
* @property { number } x X coordinate of area's starting point
|
4719
|
-
* @property { number } y Y coordinate of area's starting point
|
4720
|
-
*/
|
4721
|
-
/**
|
4722
|
-
* @PORTED
|
4723
|
-
* @typedef {object} FindInPageOptions
|
4724
|
-
* @property {boolean} [forward=true] Whether to search forward or backward.
|
4725
|
-
* @property {boolean} [findNext=false] Whether to begin a new text finding session. Should be true for first requests, and false for subsequent requests. Defaults to false.
|
4726
|
-
* @property {boolean} [matchCase=false] Whether search should be case-sensitive.
|
4727
|
-
* @property {boolean} [wordStart=false] Whether to look only at the start of words.
|
4728
|
-
* @property {boolean} [medialCapitalAsWordStart=false]
|
4729
|
-
* When combined with wordStart, accepts a match in the middle of a word if the match begins with an uppercase letter followed by a<br>
|
4730
|
-
* lowercase or non-letter. Accepts several other intra-word matches.
|
4731
|
-
*/
|
4732
|
-
/**
|
4733
|
-
* @REMOVED
|
4734
|
-
* @typedef {object} Transition
|
4735
|
-
* @property {Opacity} opacity - The Opacity transition
|
4736
|
-
* @property {Position} position - The Position transition
|
4737
|
-
* @property {Size} size - The Size transition
|
4738
|
-
*/
|
4739
|
-
/**
|
4740
|
-
* @PORTED
|
4741
|
-
* @typedef {object} TransitionOptions
|
4742
|
-
* @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
|
4743
|
-
this animation onto the end of the animation queue.
|
4744
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
4745
|
-
*/
|
4746
|
-
/**
|
4747
|
-
* @PORTED
|
4748
|
-
* @typedef {object} Size
|
4749
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
4750
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
4751
|
-
* @property {number} width - Optional if height is present. Defaults to the window's current width.
|
4752
|
-
* @property {number} height - Optional if width is present. Defaults to the window's current height.
|
4753
|
-
*/
|
4754
|
-
/**
|
4755
|
-
* @PORTED
|
4756
|
-
* @typedef {object} Position
|
4757
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
4758
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
4759
|
-
* @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
|
4760
|
-
* @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
|
4761
|
-
*/
|
4762
|
-
/**
|
4763
|
-
* @PORTED
|
4764
|
-
* @typedef {object} Opacity
|
4765
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
4766
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
4767
|
-
* @property {number} opacity - This value is clamped from 0.0 to 1.0.
|
4768
|
-
*/
|
4769
|
-
/**
|
4770
|
-
* @REMOVED
|
4771
|
-
* Bounds is a interface that has the properties of height,
|
4772
|
-
* width, left, top which are all numbers
|
4773
|
-
* @typedef { object } Bounds
|
4774
|
-
* @property { number } height Get the application height bound
|
4775
|
-
* @property { number } width Get the application width bound
|
4776
|
-
* @property { number } top Get the application top bound
|
4777
|
-
* @property { number } left Get the application left bound
|
4778
|
-
* @property { number } right Get the application right bound
|
4779
|
-
* @property { number } bottom Get the application bottom bound
|
4780
|
-
*/
|
4781
4054
|
/**
|
4782
4055
|
* A basic window that wraps a native HTML window. Provides more fine-grained
|
4783
4056
|
* control over the window state such as the ability to minimize, maximize, restore, etc.
|
@@ -4793,83 +4066,6 @@ function requireInstance () {
|
|
4793
4066
|
constructor(wire, identity) {
|
4794
4067
|
super(wire, identity, 'window');
|
4795
4068
|
}
|
4796
|
-
/**
|
4797
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
4798
|
-
* @param eventType - The type of the event.
|
4799
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
4800
|
-
* @param options - Option to support event timestamps.
|
4801
|
-
*
|
4802
|
-
* @function addListener
|
4803
|
-
* @memberof Window
|
4804
|
-
* @instance
|
4805
|
-
* @tutorial Window.EventEmitter
|
4806
|
-
*/
|
4807
|
-
/**
|
4808
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
4809
|
-
* @param eventType - The type of the event.
|
4810
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
4811
|
-
* @param options - Option to support event timestamps.
|
4812
|
-
*
|
4813
|
-
* @function on
|
4814
|
-
* @memberof Window
|
4815
|
-
* @instance
|
4816
|
-
* @tutorial Window.EventEmitter
|
4817
|
-
*/
|
4818
|
-
/**
|
4819
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
4820
|
-
* @param eventType - The type of the event.
|
4821
|
-
* @param listener - The callback function.
|
4822
|
-
* @param options - Option to support event timestamps.
|
4823
|
-
*
|
4824
|
-
* @function once
|
4825
|
-
* @memberof Window
|
4826
|
-
* @instance
|
4827
|
-
* @tutorial Window.EventEmitter
|
4828
|
-
*/
|
4829
|
-
/**
|
4830
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
4831
|
-
* @param eventType - The type of the event.
|
4832
|
-
* @param listener - The callback function.
|
4833
|
-
* @param options - Option to support event timestamps.
|
4834
|
-
*
|
4835
|
-
* @function prependListener
|
4836
|
-
* @memberof Window
|
4837
|
-
* @instance
|
4838
|
-
* @tutorial Window.EventEmitter
|
4839
|
-
*/
|
4840
|
-
/**
|
4841
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
4842
|
-
* The listener is added to the beginning of the listeners array.
|
4843
|
-
* @param eventType - The type of the event.
|
4844
|
-
* @param listener - The callback function.
|
4845
|
-
* @param options - Option to support event timestamps.
|
4846
|
-
*
|
4847
|
-
* @function prependOnceListener
|
4848
|
-
* @memberof Window
|
4849
|
-
* @instance
|
4850
|
-
* @tutorial Window.EventEmitter
|
4851
|
-
*/
|
4852
|
-
/**
|
4853
|
-
* Remove a listener from the listener array for the specified event.
|
4854
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
4855
|
-
* @param eventType - The type of the event.
|
4856
|
-
* @param listener - The callback function.
|
4857
|
-
* @param options - Option to support event timestamps.
|
4858
|
-
*
|
4859
|
-
* @function removeListener
|
4860
|
-
* @memberof Window
|
4861
|
-
* @instance
|
4862
|
-
* @tutorial Window.EventEmitter
|
4863
|
-
*/
|
4864
|
-
/**
|
4865
|
-
* Removes all listeners, or those of the specified event.
|
4866
|
-
* @param eventType - The type of the event.
|
4867
|
-
*
|
4868
|
-
* @function removeAllListeners
|
4869
|
-
* @memberof Window
|
4870
|
-
* @instance
|
4871
|
-
* @tutorial Window.EventEmitter
|
4872
|
-
*/
|
4873
4069
|
/**
|
4874
4070
|
* create a new window
|
4875
4071
|
* @internal
|
@@ -5941,28 +5137,6 @@ function requireInstance () {
|
|
5941
5137
|
.sendAction('window-authenticate', { userName, password, ...this.identity })
|
5942
5138
|
.then(() => undefined);
|
5943
5139
|
}
|
5944
|
-
/**
|
5945
|
-
* @typedef {object} ShowPopupMenuOptions
|
5946
|
-
* @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
|
5947
|
-
* @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
|
5948
|
-
* @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
|
5949
|
-
*/
|
5950
|
-
/**
|
5951
|
-
* @typedef {object} MenuItemTemplate
|
5952
|
-
* @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
|
5953
|
-
* @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
|
5954
|
-
* @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
|
5955
|
-
* @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
|
5956
|
-
* @property {boolean} [visible] - If false, the menu item will be entirely hidden.
|
5957
|
-
* @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
|
5958
|
-
* @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
|
5959
|
-
* @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
|
5960
|
-
*/
|
5961
|
-
/**
|
5962
|
-
* @typedef {object} MenuResult
|
5963
|
-
* @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
|
5964
|
-
* @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
|
5965
|
-
*/
|
5966
5140
|
/**
|
5967
5141
|
* Shows a menu on the window.
|
5968
5142
|
*
|
@@ -6063,31 +5237,6 @@ function requireInstance () {
|
|
6063
5237
|
async closePopupMenu() {
|
6064
5238
|
return this.wire.sendAction('close-popup-menu', { ...this.identity }).then(() => undefined);
|
6065
5239
|
}
|
6066
|
-
/**
|
6067
|
-
* @PORTED
|
6068
|
-
* @typedef {object} PopupOptions
|
6069
|
-
* @property {string} [name] - If a window with this `name` exists, it will be shown as a popup. Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
|
6070
|
-
* @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
|
6071
|
-
* @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
|
6072
|
-
* @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
|
6073
|
-
* @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
|
6074
|
-
* @property {function} [onPopupReady] - Executed when the popup window is shown. Provides the popup window to the provided function, and allows for easy access the popup window for additional behavior customization.
|
6075
|
-
* @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
|
6076
|
-
* @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
|
6077
|
-
* @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
6078
|
-
* @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
6079
|
-
* @property {'modal' | 'hide' | 'close'} [blurBehavior] - Determines what happens if the popup window is blurred. 'modal' restricts resizing and positioning in the caller, 'hide' hides the popup window on blur and 'close' closes the popup window on blur.
|
6080
|
-
* @property {'none' | 'hide' | 'close'} [resultDispatchBehavior] - Determines what happens when the popup window calls `dispatchPopupResult`. 'none' will do nothing, 'hide' hides the popup window on `dispatchPopupResult` and 'close' closes the popup window on `dispatchPopupResult`.
|
6081
|
-
* @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
|
6082
|
-
* @property {boolean} [hideOnClose] - Hide the popup window instead of closing whenever `close` is called on it. Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
6083
|
-
*/
|
6084
|
-
/**
|
6085
|
-
* @PORTED
|
6086
|
-
* @typedef {object} PopupResult
|
6087
|
-
* @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
|
6088
|
-
* @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
|
6089
|
-
* @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
|
6090
|
-
*/
|
6091
5240
|
/**
|
6092
5241
|
* Dispatch a result to the caller of `showPopupWindow`.
|
6093
5242
|
*
|
@@ -6423,83 +5572,6 @@ class System extends base_1$j.EmitterBase {
|
|
6423
5572
|
});
|
6424
5573
|
});
|
6425
5574
|
}
|
6426
|
-
/**
|
6427
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
6428
|
-
* @param eventType - The type of the event.
|
6429
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
6430
|
-
* @param options - Option to support event timestamps.
|
6431
|
-
*
|
6432
|
-
* @function addListener
|
6433
|
-
* @memberof System
|
6434
|
-
* @instance
|
6435
|
-
* @tutorial System.EventEmitter
|
6436
|
-
*/
|
6437
|
-
/**
|
6438
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
6439
|
-
* @param eventType - The type of the event.
|
6440
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
6441
|
-
* @param options - Option to support event timestamps.
|
6442
|
-
*
|
6443
|
-
* @function on
|
6444
|
-
* @memberof System
|
6445
|
-
* @instance
|
6446
|
-
* @tutorial System.EventEmitter
|
6447
|
-
*/
|
6448
|
-
/**
|
6449
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
6450
|
-
* @param eventType - The type of the event.
|
6451
|
-
* @param listener - The callback function.
|
6452
|
-
* @param options - Option to support event timestamps.
|
6453
|
-
*
|
6454
|
-
* @function once
|
6455
|
-
* @memberof System
|
6456
|
-
* @instance
|
6457
|
-
* @tutorial System.EventEmitter
|
6458
|
-
*/
|
6459
|
-
/**
|
6460
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
6461
|
-
* @param eventType - The type of the event.
|
6462
|
-
* @param listener - The callback function.
|
6463
|
-
* @param options - Option to support event timestamps.
|
6464
|
-
*
|
6465
|
-
* @function prependListener
|
6466
|
-
* @memberof System
|
6467
|
-
* @instance
|
6468
|
-
* @tutorial System.EventEmitter
|
6469
|
-
*/
|
6470
|
-
/**
|
6471
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
6472
|
-
* The listener is added to the beginning of the listeners array.
|
6473
|
-
* @param eventType - The type of the event.
|
6474
|
-
* @param listener - The callback function.
|
6475
|
-
* @param options - Option to support event timestamps.
|
6476
|
-
*
|
6477
|
-
* @function prependOnceListener
|
6478
|
-
* @memberof System
|
6479
|
-
* @instance
|
6480
|
-
* @tutorial System.EventEmitter
|
6481
|
-
*/
|
6482
|
-
/**
|
6483
|
-
* Remove a listener from the listener array for the specified event.
|
6484
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
6485
|
-
* @param eventType - The type of the event.
|
6486
|
-
* @param listener - The callback function.
|
6487
|
-
* @param options - Option to support event timestamps.
|
6488
|
-
*
|
6489
|
-
* @function removeListener
|
6490
|
-
* @memberof System
|
6491
|
-
* @instance
|
6492
|
-
* @tutorial System.EventEmitter
|
6493
|
-
*/
|
6494
|
-
/**
|
6495
|
-
* Removes all listeners, or those of the specified event.
|
6496
|
-
* @param eventType - The type of the event.
|
6497
|
-
*
|
6498
|
-
* @function removeAllListeners
|
6499
|
-
* @memberof System
|
6500
|
-
* @instance
|
6501
|
-
* @tutorial System.EventEmitter
|
6502
|
-
*/
|
6503
5575
|
/**
|
6504
5576
|
* Returns the version of the runtime. The version contains the major, minor,
|
6505
5577
|
* build and revision numbers.
|
@@ -10701,20 +9773,6 @@ var clipboard = {};
|
|
10701
9773
|
Object.defineProperty(clipboard, "__esModule", { value: true });
|
10702
9774
|
clipboard.Clipboard = void 0;
|
10703
9775
|
const base_1$d = base$1;
|
10704
|
-
/**
|
10705
|
-
* @PORTED
|
10706
|
-
* WriteRequestType interface
|
10707
|
-
* @typedef { object } WriteRequestType
|
10708
|
-
* @property { string } data Data to be written
|
10709
|
-
* @property { string } [type] Clipboard Type
|
10710
|
-
*/
|
10711
|
-
/**
|
10712
|
-
* @PORTED
|
10713
|
-
* OpenFin.WriteAnyClipboardRequest interface
|
10714
|
-
* @typedef { object } OpenFin.WriteAnyClipboardRequest
|
10715
|
-
* @property { string } data Data to be written
|
10716
|
-
* @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
10717
|
-
*/
|
10718
9776
|
/**
|
10719
9777
|
* The Clipboard API allows reading and writing to the clipboard in multiple formats.
|
10720
9778
|
*
|
@@ -10927,83 +9985,6 @@ class ExternalApplication extends base_1$c.EmitterBase {
|
|
10927
9985
|
super(wire, 'external-application', identity.uuid);
|
10928
9986
|
this.identity = identity;
|
10929
9987
|
}
|
10930
|
-
/**
|
10931
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
10932
|
-
* @param eventType - The type of the event.
|
10933
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
10934
|
-
* @param options - Option to support event timestamps.
|
10935
|
-
*
|
10936
|
-
* @function addListener
|
10937
|
-
* @memberof ExternalApplication
|
10938
|
-
* @instance
|
10939
|
-
* @tutorial ExternalApplication.EventEmitter
|
10940
|
-
*/
|
10941
|
-
/**
|
10942
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
10943
|
-
* @param eventType - The type of the event.
|
10944
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
10945
|
-
* @param options - Option to support event timestamps.
|
10946
|
-
*
|
10947
|
-
* @function on
|
10948
|
-
* @memberof ExternalApplication
|
10949
|
-
* @instance
|
10950
|
-
* @tutorial ExternalApplication.EventEmitter
|
10951
|
-
*/
|
10952
|
-
/**
|
10953
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
10954
|
-
* @param eventType - The type of the event.
|
10955
|
-
* @param listener - The callback function.
|
10956
|
-
* @param options - Option to support event timestamps.
|
10957
|
-
*
|
10958
|
-
* @function once
|
10959
|
-
* @memberof ExternalApplication
|
10960
|
-
* @instance
|
10961
|
-
* @tutorial ExternalApplication.EventEmitter
|
10962
|
-
*/
|
10963
|
-
/**
|
10964
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
10965
|
-
* @param eventType - The type of the event.
|
10966
|
-
* @param listener - The callback function.
|
10967
|
-
* @param options - Option to support event timestamps.
|
10968
|
-
*
|
10969
|
-
* @function prependListener
|
10970
|
-
* @memberof ExternalApplication
|
10971
|
-
* @instance
|
10972
|
-
* @tutorial ExternalApplication.EventEmitter
|
10973
|
-
*/
|
10974
|
-
/**
|
10975
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
10976
|
-
* The listener is added to the beginning of the listeners array.
|
10977
|
-
* @param eventType - The type of the event.
|
10978
|
-
* @param listener - The callback function.
|
10979
|
-
* @param options - Option to support event timestamps.
|
10980
|
-
*
|
10981
|
-
* @function prependOnceListener
|
10982
|
-
* @memberof ExternalApplication
|
10983
|
-
* @instance
|
10984
|
-
* @tutorial ExternalApplication.EventEmitter
|
10985
|
-
*/
|
10986
|
-
/**
|
10987
|
-
* Remove a listener from the listener array for the specified event.
|
10988
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
10989
|
-
* @param eventType - The type of the event.
|
10990
|
-
* @param listener - The callback function.
|
10991
|
-
* @param options - Option to support event timestamps.
|
10992
|
-
*
|
10993
|
-
* @function removeListener
|
10994
|
-
* @memberof ExternalApplication
|
10995
|
-
* @instance
|
10996
|
-
* @tutorial ExternalApplication.EventEmitter
|
10997
|
-
*/
|
10998
|
-
/**
|
10999
|
-
* Removes all listeners, or those of the specified event.
|
11000
|
-
* @param eventType - The type of the event.
|
11001
|
-
*
|
11002
|
-
* @function removeAllListeners
|
11003
|
-
* @memberof ExternalApplication
|
11004
|
-
* @instance
|
11005
|
-
* @tutorial ExternalApplication.EventEmitter
|
11006
|
-
*/
|
11007
9988
|
/**
|
11008
9989
|
* Retrieves information about the external application.
|
11009
9990
|
*
|
@@ -11140,83 +10121,6 @@ class _Frame extends base_1$a.EmitterBase {
|
|
11140
10121
|
super(wire, 'frame', identity.uuid, identity.name);
|
11141
10122
|
this.identity = identity;
|
11142
10123
|
}
|
11143
|
-
/**
|
11144
|
-
* Adds the listener function to the end of the listeners array for the specified event type.
|
11145
|
-
* @param eventType - The type of the event.
|
11146
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
11147
|
-
* @param options - Option to support event timestamps.
|
11148
|
-
*
|
11149
|
-
* @function addListener
|
11150
|
-
* @memberof Frame
|
11151
|
-
* @instance
|
11152
|
-
* @tutorial Frame.EventEmitter
|
11153
|
-
*/
|
11154
|
-
/**
|
11155
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
11156
|
-
* @param eventType - The type of the event.
|
11157
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
11158
|
-
* @param options - Option to support event timestamps.
|
11159
|
-
*
|
11160
|
-
* @function on
|
11161
|
-
* @memberof Frame
|
11162
|
-
* @instance
|
11163
|
-
* @tutorial Frame.EventEmitter
|
11164
|
-
*/
|
11165
|
-
/**
|
11166
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
11167
|
-
* @param eventType - The type of the event.
|
11168
|
-
* @param listener - The callback function.
|
11169
|
-
* @param options - Option to support event timestamps.
|
11170
|
-
*
|
11171
|
-
* @function once
|
11172
|
-
* @memberof Frame
|
11173
|
-
* @instance
|
11174
|
-
* @tutorial Frame.EventEmitter
|
11175
|
-
*/
|
11176
|
-
/**
|
11177
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
11178
|
-
* @param eventType - The type of the event.
|
11179
|
-
* @param listener - The callback function.
|
11180
|
-
* @param options - Option to support event timestamps.
|
11181
|
-
*
|
11182
|
-
* @function prependListener
|
11183
|
-
* @memberof Frame
|
11184
|
-
* @instance
|
11185
|
-
* @tutorial Frame.EventEmitter
|
11186
|
-
*/
|
11187
|
-
/**
|
11188
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
11189
|
-
* The listener is added to the beginning of the listeners array.
|
11190
|
-
* @param eventType - The type of the event.
|
11191
|
-
* @param listener - The callback function.
|
11192
|
-
* @param options - Option to support event timestamps.
|
11193
|
-
*
|
11194
|
-
* @function prependOnceListener
|
11195
|
-
* @memberof Frame
|
11196
|
-
* @instance
|
11197
|
-
* @tutorial Frame.EventEmitter
|
11198
|
-
*/
|
11199
|
-
/**
|
11200
|
-
* Remove a listener from the listener array for the specified event.
|
11201
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
11202
|
-
* @param eventType - The type of the event.
|
11203
|
-
* @param listener - The callback function.
|
11204
|
-
* @param options - Option to support event timestamps.
|
11205
|
-
*
|
11206
|
-
* @function removeListener
|
11207
|
-
* @memberof Frame
|
11208
|
-
* @instance
|
11209
|
-
* @tutorial Frame.EventEmitter
|
11210
|
-
*/
|
11211
|
-
/**
|
11212
|
-
* Removes all listeners, or those of the specified event.
|
11213
|
-
* @param eventType - The type of the event.
|
11214
|
-
*
|
11215
|
-
* @function removeAllListeners
|
11216
|
-
* @memberof Frame
|
11217
|
-
* @instance
|
11218
|
-
* @tutorial Frame.EventEmitter
|
11219
|
-
*/
|
11220
10124
|
/**
|
11221
10125
|
* Returns a frame info object for the represented frame.
|
11222
10126
|
*
|
@@ -14147,57 +13051,6 @@ function requireInteropBroker () {
|
|
14147
13051
|
/*
|
14148
13052
|
Client API
|
14149
13053
|
*/
|
14150
|
-
/**
|
14151
|
-
* @REMOVED
|
14152
|
-
* SetContextOptions interface
|
14153
|
-
* @typedef { object } SetContextOptions
|
14154
|
-
* @property { Context } {context} - New context to set.
|
14155
|
-
*/
|
14156
|
-
/**
|
14157
|
-
* @REMOVED
|
14158
|
-
* GetContextOptions interface
|
14159
|
-
* @typedef { object } GetContextOptions
|
14160
|
-
* @property { string } [contextType] - Context Type
|
14161
|
-
*/
|
14162
|
-
// TODO: extract inline type and do proper comments
|
14163
|
-
/**
|
14164
|
-
* @REMOVED
|
14165
|
-
* JoinContextGroupOptions interface
|
14166
|
-
* @typedef { object } JoinContextGroupOptions
|
14167
|
-
* @property { string } contextGroupId - Id of the context group.
|
14168
|
-
* @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
|
14169
|
-
*/
|
14170
|
-
/**
|
14171
|
-
* @REMOVED
|
14172
|
-
* AddClientToContextGroupOptions interface
|
14173
|
-
* @typedef { object } AddClientToContextGroupOptions
|
14174
|
-
* @property { string } contextGroupId - Name of the context group.
|
14175
|
-
*/
|
14176
|
-
/**
|
14177
|
-
* @REMOVED
|
14178
|
-
* RemoveFromContextGroupOptions interface
|
14179
|
-
* @typedef { object } RemoveFromContextGroupOptions
|
14180
|
-
* @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
|
14181
|
-
*/
|
14182
|
-
/**
|
14183
|
-
* @REMOVED
|
14184
|
-
* GetInfoForContextGroupOptions interface
|
14185
|
-
* @typedef { object } GetInfoForContextGroupOptions
|
14186
|
-
* @property { string } contextGroupId - Name of the context group to get info for.
|
14187
|
-
*/
|
14188
|
-
/**
|
14189
|
-
* @REMOVED
|
14190
|
-
* GetAllClientsInContextGroupOptions interface
|
14191
|
-
* @typedef { object } GetAllClientsInContextGroupOptions
|
14192
|
-
* @property { string } contextGroupId - Name of the context group to get info for.
|
14193
|
-
*/
|
14194
|
-
/**
|
14195
|
-
* @PORTED
|
14196
|
-
* InfoForIntentOptions interface
|
14197
|
-
* @typedef { object } InfoForIntentOptions
|
14198
|
-
* @property { string } name Name of the intent to get info for.
|
14199
|
-
* @property { Context } [context] Optional context.
|
14200
|
-
*/
|
14201
13054
|
/**
|
14202
13055
|
* Sets a context for the context group of the incoming current entity.
|
14203
13056
|
* @param setContextOptions - New context to set.
|
@@ -15356,95 +14209,6 @@ InteropClient$1.InteropClient = void 0;
|
|
15356
14209
|
const base_1$2 = base$1;
|
15357
14210
|
const SessionContextGroupClient_1 = SessionContextGroupClient$1;
|
15358
14211
|
const utils_1$2 = utils$1;
|
15359
|
-
/**
|
15360
|
-
* @PORTED
|
15361
|
-
* @typedef { object } Intent
|
15362
|
-
* @summary The combination of an action and a context that is passed to an application for resolution.
|
15363
|
-
* @property { string } name Name of the intent.
|
15364
|
-
* @property { Context } context Data associated with the intent
|
15365
|
-
*/
|
15366
|
-
/**
|
15367
|
-
* @REMOVED
|
15368
|
-
* @typedef { object } Subscription
|
15369
|
-
* @summary Object returned when subscribing a handler.
|
15370
|
-
* @property { function } unsubscribe Function to unsubscribe the handler.
|
15371
|
-
*/
|
15372
|
-
/**
|
15373
|
-
* @typedef { function } ContextHandler
|
15374
|
-
* @summary Subscription function for addContextHandler.
|
15375
|
-
*/
|
15376
|
-
/**
|
15377
|
-
* @typedef { function } IntentHandler
|
15378
|
-
* @summary Subscription function for registerIntentHandler
|
15379
|
-
*/
|
15380
|
-
/**
|
15381
|
-
* @PORTED
|
15382
|
-
* @typedef { object } ClientIdentity
|
15383
|
-
* @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
|
15384
|
-
* @property {string} uuid GUID of an application.
|
15385
|
-
* @property {string} name Name of an entity in an application.
|
15386
|
-
* @property {string} endpointId Unique differentiator for different Channel connections for an entity.
|
15387
|
-
*/
|
15388
|
-
/**
|
15389
|
-
* @PORTED
|
15390
|
-
* @typedef { object } ContextGroupInfo
|
15391
|
-
* @summary Information for a Context Group. Contains metadata for displaying the group properly.
|
15392
|
-
* @property {string} id Name of the context group
|
15393
|
-
* @property {DisplayMetadata} displayMetadata Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
|
15394
|
-
*/
|
15395
|
-
/**
|
15396
|
-
* @PORTED
|
15397
|
-
* @typedef { object } DisplayMetadata
|
15398
|
-
* @summary The display data for a Context Group.
|
15399
|
-
* @property {string} name A user-readable name for this context group, e.g: `"Red"`
|
15400
|
-
* @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
|
15401
|
-
* @property {string} [glyph] A URL of an image that can be used to display this context group
|
15402
|
-
*/
|
15403
|
-
/**
|
15404
|
-
* @PORTED
|
15405
|
-
* @typedef { object } Context
|
15406
|
-
* @summary Data passed between entities and applications.
|
15407
|
-
* @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
15408
|
-
* @property {string} [name] User-readable name for the incoming context.
|
15409
|
-
* @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
|
15410
|
-
*/
|
15411
|
-
/**
|
15412
|
-
* @REMOVED
|
15413
|
-
* @typedef { object } ContextForIntent
|
15414
|
-
* @summary Data passed between entities and applications, including an optional metadata.
|
15415
|
-
* @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
15416
|
-
* @property {string} [name] User-readable name for the incoming context.
|
15417
|
-
* @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
|
15418
|
-
* @property {any} [metadata]
|
15419
|
-
*/
|
15420
|
-
/**
|
15421
|
-
* @REMOVED
|
15422
|
-
* @typedef { object } SessionContextGroup
|
15423
|
-
* @summary An instance of a SessionContextGroup
|
15424
|
-
* @property {string} id The SessionContextGroup's id.
|
15425
|
-
* @property {setContext} setContext Sets a context of a certain type
|
15426
|
-
* @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
|
15427
|
-
* @property {addContextHandler} addContextHandler Adds a handler for context change.
|
15428
|
-
*/
|
15429
|
-
/**
|
15430
|
-
* @typedef {function} setContext
|
15431
|
-
* @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
|
15432
|
-
* @param context The Context to be set.
|
15433
|
-
*
|
15434
|
-
*/
|
15435
|
-
/**
|
15436
|
-
* @typedef {function} getCurrentContext
|
15437
|
-
* @summary A SessionContextGroup instance method for getting the current context of a certain type.
|
15438
|
-
* @param contextType The Context Type to get. If not specified the last contextType set would get used.
|
15439
|
-
*
|
15440
|
-
*/
|
15441
|
-
/**
|
15442
|
-
* @typedef {function} addContextHandler
|
15443
|
-
* @summary A SessionContextGroup instance method for adding a handler for context change.
|
15444
|
-
* @param contextHandler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
|
15445
|
-
* @param contextType The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
|
15446
|
-
*
|
15447
|
-
*/
|
15448
14212
|
/**
|
15449
14213
|
* {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
|
15450
14214
|
*
|
@@ -16078,13 +14842,6 @@ function requireFactory () {
|
|
16078
14842
|
const common_utils_1 = commonUtils;
|
16079
14843
|
const defaultOverride = (Class) => new Class();
|
16080
14844
|
const BrokerParamAccessError = 'You have attempted to use or modify InteropBroker parameters, which is not allowed. You are likely using an older InteropBroker override scheme. Please consult our Interop docs for guidance on migrating to the new override scheme.';
|
16081
|
-
/**
|
16082
|
-
* @PORTED
|
16083
|
-
* @typedef { object } InteropConfig
|
16084
|
-
* @summary Information relevant to the Interop Broker.
|
16085
|
-
* @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
|
16086
|
-
* @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
|
16087
|
-
*/
|
16088
14845
|
/**
|
16089
14846
|
* Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
|
16090
14847
|
*
|