@openfin/fdc3-api 40.105.7 → 40.200.2

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.
@@ -126,13 +126,13 @@ declare type ApiSettings = {
126
126
  /**
127
127
  * Inject OpenFin API into cross-origin iframes
128
128
  *
129
- * @default false
129
+ * @defaultValue false
130
130
  */
131
131
  crossOriginInjection?: boolean;
132
132
  /**
133
133
  * Inject OpenFin API into same-origin iframes
134
134
  *
135
- * @default true
135
+ * @defaultValue true
136
136
  */
137
137
  sameOriginInjection?: boolean;
138
138
  /**
@@ -189,10 +189,6 @@ declare type AppAssetRequest = {
189
189
  alias: string;
190
190
  };
191
191
 
192
- declare type AppAssetServeRequest = ServeRequest & {
193
- alias: string;
194
- };
195
-
196
192
  /**
197
193
  * An object representing an application. Allows the developer to create,
198
194
  * execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
@@ -594,23 +590,6 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
594
590
  * ```
595
591
  */
596
592
  setTrayIcon(icon: string): Promise<void>;
597
- /**
598
- * Set hover text for this application's system tray icon.
599
- * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
600
- * @param toolTip
601
- *
602
- * @example
603
- *
604
- * ```js
605
- * const app = fin.Application.getCurrentSync();
606
- * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
607
- *
608
- * await app.setTrayIcon(iconUrl);
609
- *
610
- * await app.setTrayIconToolTip('My Application');
611
- * ```
612
- */
613
- setTrayIconToolTip(toolTip: string): Promise<void>;
614
593
  /**
615
594
  * Sets new application's shortcut configuration. Windows only.
616
595
  * @param config New application's shortcut configuration.
@@ -1171,19 +1150,19 @@ declare class ApplicationModule extends Base {
1171
1150
  */
1172
1151
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1173
1152
  /**
1174
- * Disables IAB secure logging for the app.
1153
+ * @defaultValue false
1175
1154
  *
1176
- * @default false
1155
+ * Disables IAB secure logging for the app.
1177
1156
  */
1178
1157
  disableIabSecureLogging: boolean;
1179
1158
  /**
1159
+ * @defaultValue 'There was an error loading the application.'
1160
+ *
1180
1161
  * An error message to display when the application (launched via manifest) fails to load.
1181
1162
  * A dialog box will be launched with the error message just before the runtime exits.
1182
1163
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1183
1164
  * will trigger this dialog.
1184
1165
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1185
- *
1186
- * @default 'There was an error loading the application.'
1187
1166
  */
1188
1167
  loadErrorMessage: string;
1189
1168
  /**
@@ -1202,28 +1181,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1202
1181
  */
1203
1182
  name: string;
1204
1183
  /**
1184
+ * @defaultValue false
1185
+ *
1205
1186
  * A flag to configure the application as non-persistent.
1206
1187
  * Runtime exits when there are no persistent apps running.
1207
- *
1208
- * @default false
1209
1188
  */
1210
1189
  nonPersistent: boolean;
1211
1190
  /**
1212
- * Enable Flash at the application level.
1191
+ * @defaultValue false
1213
1192
  *
1214
- * @default false
1193
+ * Enable Flash at the application level.
1215
1194
  */
1216
1195
  plugins: boolean;
1217
1196
  /**
1218
- * Enable spell check at the application level.
1197
+ * @defaultValue false
1219
1198
  *
1220
- * @default false
1199
+ * Enable spell check at the application level.
1221
1200
  */
1222
1201
  spellCheck: boolean;
1223
1202
  /**
1224
- * The url to the application (specifically the application's main window).
1203
+ * @defaultValue 'about:blank'
1225
1204
  *
1226
- * @default 'about:blank'
1205
+ * The url to the application (specifically the application's main window).
1227
1206
  */
1228
1207
  url: string;
1229
1208
  /**
@@ -1232,9 +1211,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1232
1211
  */
1233
1212
  uuid: string;
1234
1213
  /**
1235
- * When set to `false` it will disable the same-origin policy for the app.
1214
+ * @defaultValue true
1236
1215
  *
1237
- * @default true
1216
+ * When set to `false` it will disable the same-origin policy for the app.
1238
1217
  */
1239
1218
  webSecurity: boolean;
1240
1219
  /**
@@ -1244,10 +1223,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1244
1223
  commands: ShortcutOverride[];
1245
1224
  isPlatformController: boolean;
1246
1225
  /**
1226
+ * @defaultValue 1000
1227
+ *
1247
1228
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1248
1229
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1249
- *
1250
- * @default 1000
1251
1230
  */
1252
1231
  maxViewPoolSize: number;
1253
1232
  /**
@@ -1263,12 +1242,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1263
1242
  */
1264
1243
  snapshot: Snapshot;
1265
1244
  /**
1245
+ * @defaultValue false
1246
+ *
1266
1247
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1267
1248
  *
1268
1249
  * Note: if the Platform Provider is showing, it won't close automatically.
1269
1250
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1270
- *
1271
- * @default false
1272
1251
  */
1273
1252
  preventQuitOnLastWindowClosed: boolean;
1274
1253
  /**
@@ -1276,9 +1255,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1276
1255
  */
1277
1256
  interopBrokerConfiguration: InteropBrokerOptions;
1278
1257
  /**
1279
- * When set to `false` it will disable OpenFin Diagnostics for the app.
1258
+ * @defaultValue true
1280
1259
  *
1281
- * @default true
1260
+ * When set to `false` it will disable OpenFin Diagnostics for the app.
1282
1261
  */
1283
1262
  apiDiagnostics: boolean;
1284
1263
  /**
@@ -1294,16 +1273,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1294
1273
  */
1295
1274
  permissions?: Partial<Permissions_2>;
1296
1275
  /**
1276
+ * @defaultValue false
1277
+ *
1297
1278
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1298
1279
  * Only relevant in Windows.
1299
- *
1300
- * @default false
1301
1280
  */
1302
1281
  enableJumpList: boolean;
1303
1282
  /**
1304
- * When set to `true`, any `beforeunload` handler set on the app will fire.
1283
+ * @defaultValue false
1305
1284
  *
1306
- * @default false
1285
+ * When set to `true`, any `beforeunload` handler set on the app will fire.
1307
1286
  */
1308
1287
  enableBeforeUnload: boolean;
1309
1288
  /**
@@ -1384,25 +1363,25 @@ declare type ApplicationWindowInfo = {
1384
1363
  */
1385
1364
  declare type ApplySnapshotOptions = {
1386
1365
  /**
1366
+ * @defaultValue false
1367
+ *
1387
1368
  * When true, applySnapshot will close existing windows,
1388
1369
  * replacing current Platform state with the given snapshot.
1389
- *
1390
- * @default false
1391
1370
  */
1392
1371
  closeExistingWindows?: boolean;
1393
1372
  /**
1373
+ * @defaultValue false
1374
+ *
1394
1375
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1395
1376
  * replacing current Platform state with the given snapshot.
1396
- *
1397
- * @default false
1398
1377
  */
1399
1378
  closeSnapshotWindows?: boolean;
1400
1379
  /**
1380
+ * @defaultValue false
1381
+ *
1401
1382
  * When true, applySnapshot will not check whether any windows in a
1402
1383
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1403
1384
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1404
- *
1405
- * @default false
1406
1385
  */
1407
1386
  skipOutOfBoundsCheck?: boolean;
1408
1387
  };
@@ -1682,8 +1661,6 @@ declare type BaseConfig = {
1682
1661
  timeout?: number;
1683
1662
  };
1684
1663
 
1685
- declare type BaseContentBehavior = 'allow' | 'block';
1686
-
1687
1664
  /**
1688
1665
  * Properties shared by all content creation rules, regardless of context.
1689
1666
  *
@@ -1925,35 +1902,7 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
1925
1902
  reason: 'self' | 'animation';
1926
1903
  };
1927
1904
 
1928
- declare type BoundsEvent = BaseEvent_5 & OpenFin.WindowBounds;
1929
-
1930
- declare type BoundsType =
1931
- /**
1932
- * Bounds specify the size and location of the entire window, including OS border styling.
1933
- */
1934
- 'window'
1935
- /**
1936
- * Bounds specify the size and location of the window's DOM content, excluding OS border styling.
1937
- */
1938
- | 'content'
1939
- /**
1940
- * Origin parameters (top, left) specify the location of the window origin, including OS border styling.
1941
- * Size parameters bounds (width, height) specify the size of the window's DOM content, excluding OS border styling.
1942
- */
1943
- | 'window-origin-content-size';
1944
-
1945
- /**
1946
- * Opens matched URLs in the browser.
1947
- *
1948
- * @interface
1949
- */
1950
- declare type BrowserContentBehavior = {
1951
- behavior: 'browser';
1952
- /**
1953
- * When true, closes the window or view that initiated the navigation.
1954
- */
1955
- closeExisting?: boolean;
1956
- };
1905
+ declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
1957
1906
 
1958
1907
  /**
1959
1908
  * A rule prescribing content creation in the browser.
@@ -2059,15 +2008,15 @@ declare type CapturePageOptions = {
2059
2008
  */
2060
2009
  area?: Rectangle;
2061
2010
  /**
2062
- * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2011
+ * @defaultValue 'png'
2063
2012
  *
2064
- * @default 'png'
2013
+ * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2065
2014
  */
2066
2015
  format?: 'bmp' | 'jpg' | 'png';
2067
2016
  /**
2068
- * Quality of JPEG image. Between 0 - 100.
2017
+ * @defaultValue 100
2069
2018
  *
2070
- * @default 100
2019
+ * Quality of JPEG image. Between 0 - 100.
2071
2020
  */
2072
2021
  quality?: number;
2073
2022
  };
@@ -2313,6 +2262,8 @@ declare class Channel extends EmitterBase<ChannelEvent> {
2313
2262
 
2314
2263
  declare type Channel_2 = OpenFin.Fin['InterApplicationBus']['Channel'];
2315
2264
 
2265
+ declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
2266
+
2316
2267
  declare type ChannelAction = OpenFin.ChannelAction;
2317
2268
 
2318
2269
  declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_4 | ClientIdentity) => unknown;
@@ -2700,9 +2651,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2700
2651
  */
2701
2652
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2702
2653
  /**
2703
- * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2654
+ * @defaultValue true
2704
2655
  *
2705
- * @default true
2656
+ * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2706
2657
  */
2707
2658
  wait?: boolean;
2708
2659
  /**
@@ -2986,22 +2937,6 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
2986
2937
  childOptions: OpenFin.WindowOptions;
2987
2938
  };
2988
2939
 
2989
- /**
2990
- * Control behavior for Chromium policies
2991
- *
2992
- * @interface
2993
- */
2994
- declare type ChromiumPolicies = {
2995
- /**
2996
- * Disable AutofillAddressEnabled policy for a Window or View.
2997
- */
2998
- AutofillAddressEnabled?: PolicyOptions;
2999
- /**
3000
- * Disable AutofillCreditCardEnabled policy for a Window or View.
3001
- */
3002
- AutofillCreditCardEnabled?: PolicyOptions;
3003
- };
3004
-
3005
2940
  declare interface ClassicProtocolOffer extends ProtocolPacketBase {
3006
2941
  type: 'classic';
3007
2942
  }
@@ -3085,7 +3020,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
3085
3020
  *
3086
3021
  */
3087
3022
  declare class Clipboard_2 extends Base {
3088
- #private;
3089
3023
  /**
3090
3024
  * Writes data into the clipboard as plain text
3091
3025
  * @param writeObj The object for writing data into the clipboard
@@ -3238,56 +3172,6 @@ declare class Clipboard_2 extends Base {
3238
3172
  getAvailableFormats(type?: OpenFin.ClipboardSelectionType): Promise<Array<string>>;
3239
3173
  }
3240
3174
 
3241
- /**
3242
- * Permissions for {@link Clipboard} APIs.
3243
- */
3244
- declare type ClipboardApiPermissions = {
3245
- writeText: boolean;
3246
- readText: boolean;
3247
- writeImage: boolean;
3248
- readImage: boolean;
3249
- writeHtml: boolean;
3250
- readHtml: boolean;
3251
- writeRtf: boolean;
3252
- readRtf: boolean;
3253
- write: boolean;
3254
- };
3255
-
3256
- /**
3257
- * Generated when a copy operation is blocked through {@link OpenFin.DomainSettings}.
3258
- * @interface
3259
- */
3260
- declare type ClipboardCopyBlockedEvent = NamedEvent & {
3261
- type: 'clipboard-copy-blocked';
3262
- /**
3263
- * URL of the Window or View that generated the event.
3264
- */
3265
- url: string;
3266
- reason: CopyBlockedEventReason;
3267
- };
3268
-
3269
- /**
3270
- * Generated when a paste operation is blocked through {@link OpenFin.DomainSettings}.
3271
- * @interface
3272
- */
3273
- declare type ClipboardPasteBlockedEvent = NamedEvent & {
3274
- type: 'clipboard-paste-blocked';
3275
- /**
3276
- * URL of the Window or View that generated the event.
3277
- */
3278
- url: string;
3279
- reason: PasteBlockedEventReason;
3280
- };
3281
-
3282
- /**
3283
- * Clipboard Permissions
3284
- * @interface
3285
- */
3286
- declare type ClipboardPermissions = {
3287
- copy?: CopyPermissions;
3288
- paste?: PastePermissions;
3289
- };
3290
-
3291
3175
  /**
3292
3176
  * The type of clipboard to write to, can be 'clipboard' or 'selection'.
3293
3177
  * Defaults to 'clipboard'. Use 'selection' for linux only.
@@ -3365,9 +3249,9 @@ declare interface CloseWindowPayload {
3365
3249
  windowId: Identity_4;
3366
3250
  options: {
3367
3251
  /**
3368
- * When set to true skips any before handler set on views that are part of the window
3252
+ * @defaultValue false
3369
3253
  *
3370
- * @default false
3254
+ * When set to true skips any before handler set on views that are part of the window
3371
3255
  */
3372
3256
  skipBeforeUnload?: boolean;
3373
3257
  };
@@ -3472,22 +3356,15 @@ declare type ConstViewOptions = {
3472
3356
  */
3473
3357
  name: string;
3474
3358
  /**
3475
- * The URL of the window
3359
+ * @defaultValue "about:blank"
3476
3360
  *
3477
- * @default "about:blank"
3361
+ * The URL of the window
3478
3362
  */
3479
3363
  url: string;
3480
3364
  /**
3481
3365
  * The identity of the window this view should be attached to.
3482
3366
  */
3483
3367
  target: Identity_4;
3484
- /**
3485
- * Defaults to `name`.
3486
- * Ignored in container, but used in @openfin/core-web to set tab titles.
3487
- * Order of precedence for title in container is: document.title, viewOptions.url.
3488
- * Order of precedence for title in @openfin/core-web is ComponentConfig.title, viewOptions.title, viewOptions.url.
3489
- */
3490
- title: string;
3491
3368
  /**
3492
3369
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3493
3370
  */
@@ -3528,13 +3405,17 @@ declare type ConstViewOptions = {
3528
3405
  * but the properties in the manifest will take precedence if there is any collision.
3529
3406
  */
3530
3407
  manifestUrl: string;
3408
+ /**
3409
+ * If true, the view's call to the Web Notifications API will be intercepted by the platform. The event `notification-intercepted` will be emitted with the notification object as the payload.
3410
+ */
3411
+ interceptNotifications: boolean;
3531
3412
  zoomLevel: number;
3532
3413
  experimental: any;
3533
3414
  fdc3InteropApi?: string;
3534
3415
  /**
3535
- * When set to `true`, any `beforeunload` handler set on Views will fire.
3416
+ * @defaultValue false
3536
3417
  *
3537
- * @default false
3418
+ * When set to `true`, any `beforeunload` handler set on Views will fire.
3538
3419
  */
3539
3420
  enableBeforeUnload: boolean;
3540
3421
  /**
@@ -3571,10 +3452,6 @@ declare type ConstViewOptions = {
3571
3452
  */
3572
3453
  enabled: boolean;
3573
3454
  };
3574
- /**
3575
- * Control which options to ignore when creating a Platform View.
3576
- */
3577
- excludeOptions: ExcludeOptions;
3578
3455
  };
3579
3456
 
3580
3457
  /**
@@ -3615,12 +3492,13 @@ declare type ConstWindowOptions = {
3615
3492
  */
3616
3493
  backgroundColor: string;
3617
3494
  /**
3495
+ * @defaultValue false
3496
+ *
3618
3497
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3619
3498
  * This also affects the Page Visibility API.
3620
3499
  *
3621
3500
  * When `true`, the page is throttled whether it is hidden or not.
3622
3501
  *
3623
- * @default false
3624
3502
  */
3625
3503
  backgroundThrottling: boolean;
3626
3504
  /**
@@ -3644,21 +3522,21 @@ declare type ConstWindowOptions = {
3644
3522
  */
3645
3523
  customRequestHeaders: CustomRequestHeaders[];
3646
3524
  /**
3525
+ * @defaultValue true
3526
+ *
3647
3527
  * Setting this to false would keep the Window alive even if all its Views were closed.
3648
3528
  * This is meant for advanced users and should be used with caution.
3649
3529
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3650
3530
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3651
3531
  * **NOTE:** - This option is ignored in non-Platforms apps.
3652
- *
3653
- * @default true
3654
3532
  */
3655
3533
  closeOnLastViewRemoved: boolean;
3656
3534
  /**
3535
+ * @defaultValue 'all'
3536
+ *
3657
3537
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3658
- * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3538
+ + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3659
3539
  * **NOTE:** - This option is ignored in non-Platforms apps.
3660
- *
3661
- * @default 'all'
3662
3540
  */
3663
3541
  viewsPreventingClose: 'all' | 'layout';
3664
3542
  /**
@@ -3669,31 +3547,31 @@ declare type ConstWindowOptions = {
3669
3547
  */
3670
3548
  defaultCentered: boolean;
3671
3549
  /**
3550
+ * @defaultValue 500
3551
+ *
3672
3552
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3673
3553
  * in favor of the cached value.
3674
- *
3675
- * @default 500
3676
3554
  */
3677
3555
  defaultHeight: number;
3678
3556
  /**
3557
+ * @defaultValue 100
3558
+ *
3679
3559
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3680
3560
  * launches in favor of the cached value.
3681
- *
3682
- * @default 100
3683
3561
  */
3684
3562
  defaultLeft: number;
3685
3563
  /**
3564
+ * @defaultValue 100
3565
+ *
3686
3566
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3687
3567
  * launches in favor of the cached value.
3688
- *
3689
- * @default 100
3690
3568
  */
3691
3569
  defaultTop: number;
3692
3570
  /**
3571
+ * @defaultValue 800
3572
+ *
3693
3573
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3694
3574
  * launches in favor of the cached value.
3695
- *
3696
- * @default 800
3697
3575
  */
3698
3576
  defaultWidth: number;
3699
3577
  /**
@@ -3704,6 +3582,12 @@ declare type ConstWindowOptions = {
3704
3582
  */
3705
3583
  downloadShelf: DownloadShelfOptions;
3706
3584
  height: number;
3585
+ /**
3586
+ * @defaultValue false
3587
+ * @remarks
3588
+ * When set to `true` the platform will intercept all web notifications and instead raise `notification-intercepted` events.
3589
+ */
3590
+ interceptNotifications: boolean;
3707
3591
  layout: any;
3708
3592
  /**
3709
3593
  * @experimental
@@ -3739,19 +3623,19 @@ declare type ConstWindowOptions = {
3739
3623
  */
3740
3624
  processAffinity: string;
3741
3625
  /**
3626
+ * @defaultValue false
3627
+ *
3742
3628
  * Displays a shadow on frameless windows.
3743
3629
  * `shadow` and `cornerRounding` are mutually exclusive.
3744
3630
  * On Windows 7, Aero theme is required.
3745
- *
3746
- * @default false
3747
3631
  */
3748
3632
  shadow: boolean;
3749
3633
  /**
3634
+ * @defaultValue true
3635
+ *
3750
3636
  * Caches the location of the window.
3751
3637
  *
3752
3638
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3753
- *
3754
- * @default true
3755
3639
  */
3756
3640
  saveWindowState: boolean;
3757
3641
  /**
@@ -3760,28 +3644,33 @@ declare type ConstWindowOptions = {
3760
3644
  */
3761
3645
  ignoreSavedWindowState: boolean;
3762
3646
  /**
3647
+ * @defaultValue false
3648
+ *
3763
3649
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3764
3650
  *
3765
3651
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3766
3652
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3767
- *
3768
- * @default false
3769
3653
  */
3770
3654
  smallWindow: boolean;
3771
3655
  /**
3656
+ * @defaultValue "normal"
3657
+ *
3772
3658
  * The visible state of the window on creation.
3773
3659
  * One of:
3774
3660
  * * `"maximized"`
3775
3661
  * * `"minimized"`
3776
3662
  * * `"normal"`
3777
- *
3778
- * @default "normal"
3779
3663
  */
3780
3664
  state: WindowState;
3781
3665
  /**
3782
3666
  * @deprecated - use `icon` instead.
3783
3667
  */
3784
3668
  taskbarIcon: string;
3669
+ /**
3670
+ * Specify a taskbar group for the window.
3671
+ * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
3672
+ */
3673
+ taskbarIconGroup: string;
3785
3674
  /**
3786
3675
  * @defaultValue "about:blank"
3787
3676
  *
@@ -3789,20 +3678,20 @@ declare type ConstWindowOptions = {
3789
3678
  */
3790
3679
  url: string;
3791
3680
  /**
3681
+ * @defaultValue <application UUID>
3682
+ *
3792
3683
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3793
3684
  * If omitted, defaults to the `uuid` of the application spawning the window.
3794
3685
  * If given, must match the `uuid` of the application spawning the window.
3795
3686
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3796
3687
  * really no need to provide it.
3797
- *
3798
- * @default <application UUID>
3799
3688
  */
3800
3689
  uuid: string;
3801
3690
  /**
3691
+ * @defaultValue false
3692
+ *
3802
3693
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3803
3694
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3804
- *
3805
- * @default false
3806
3695
  */
3807
3696
  waitForPageLoad: boolean;
3808
3697
  width: number;
@@ -3818,10 +3707,6 @@ declare type ConstWindowOptions = {
3818
3707
  * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3819
3708
  */
3820
3709
  inheritance?: Partial<InheritableOptions>;
3821
- /**
3822
- * Control which options to ignore when creating a Platform Window.
3823
- */
3824
- excludeOptions: ExcludeOptions;
3825
3710
  };
3826
3711
 
3827
3712
  /**
@@ -3832,15 +3717,6 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3832
3717
  type: 'container-created';
3833
3718
  };
3834
3719
 
3835
- /**
3836
- * Behavior when displaying content from matched URLs.
3837
- *
3838
- * 'allow': The content url is allowed.
3839
- * 'block': The content url is blocked.
3840
- * 'browser': The content url is blocked and it is opened in the system's default web browser.
3841
- */
3842
- declare type ContentBehavior = BaseContentBehavior | 'browser';
3843
-
3844
3720
  /**
3845
3721
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
3846
3722
  * @interface
@@ -3928,9 +3804,12 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3928
3804
  declare type ContentNavigation = NavigationRules;
3929
3805
 
3930
3806
  /**
3931
- * Controls whether a content url is allowed or blocked for navigation in Windows and Views or redirection for Windows, Views and iframes.
3807
+ * Whether a content url is allowed or blocked for navigation or redirection.
3808
+ *
3809
+ * * 'allow': The content url is allowed.
3810
+ * * 'block': The content url is blocked.
3932
3811
  */
3933
- declare type ContentPermission = ContentBehavior | StructuredContentBehavior | StructuredContentPermissions;
3812
+ declare type ContentPermission = 'allow' | 'block';
3934
3813
 
3935
3814
  /**
3936
3815
  * Restrict redirects to URLs that match an allowed pattern.
@@ -4061,41 +3940,6 @@ declare type CookieOption = {
4061
3940
  name: string;
4062
3941
  };
4063
3942
 
4064
- /**
4065
- * Reasons for a copy operation being blocked
4066
- *
4067
- * 'disabled': Copy operation is disabled through domain-based permissions.
4068
- */
4069
- declare type CopyBlockedEventReason = 'disabled';
4070
-
4071
- /**
4072
- * Control copy operations for a matched URL.
4073
- * @interface
4074
- */
4075
- declare type CopyPermissions = {
4076
- /**
4077
- * Controls the behavior for copy operations for a matched URL.
4078
- *
4079
- * allow: Enables all copy operations.
4080
- * block: Disables all copy operations.
4081
- * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4082
- *
4083
- * @default 'allowed'
4084
- */
4085
- behavior: 'allow' | 'block' | 'protect';
4086
- /**
4087
- * Additional copy operation options
4088
- */
4089
- options?: {
4090
- /**
4091
- * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4092
- *
4093
- * @default ''
4094
- */
4095
- replacementText: string;
4096
- };
4097
- };
4098
-
4099
3943
  /**
4100
3944
  * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
4101
3945
  * average of _height_ and _width_.
@@ -4104,15 +3948,15 @@ declare type CopyPermissions = {
4104
3948
  */
4105
3949
  declare type CornerRounding = {
4106
3950
  /**
4107
- * The height in pixels.
3951
+ * @defaultValue 0
4108
3952
  *
4109
- * @default 0
3953
+ * The height in pixels.
4110
3954
  */
4111
3955
  height: number;
4112
3956
  /**
4113
- * The width in pixels.
3957
+ * @defaultValue 0
4114
3958
  *
4115
- * @default 0
3959
+ * The width in pixels.
4116
3960
  */
4117
3961
  width: number;
4118
3962
  };
@@ -4202,6 +4046,8 @@ declare type CreateLayoutOptions = {
4202
4046
  layoutName: string;
4203
4047
  layout: LayoutOptions;
4204
4048
  /**
4049
+ * @defaultValue 'default'
4050
+ *
4205
4051
  * Controls the View behavior for the given `layout` property. Note
4206
4052
  * that the selected behavior only applies to unnamed Views or
4207
4053
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4223,8 +4069,6 @@ declare type CreateLayoutOptions = {
4223
4069
  * override. Note that during applyLayoutSnapshot, Views are created and
4224
4070
  * attached to the Provider while the Window is being created, so it's
4225
4071
  * important to not 'duplicate' Views in this workflow.
4226
- *
4227
- * @default 'default'
4228
4072
  */
4229
4073
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4230
4074
  };
@@ -4323,7 +4167,6 @@ declare type DefaultDomainSettings = DomainSettings;
4323
4167
 
4324
4168
  /**
4325
4169
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4326
- * @interface
4327
4170
  */
4328
4171
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4329
4172
 
@@ -4484,7 +4327,7 @@ declare type DomainApiSettings = {
4484
4327
  * * 'none': The `fin` API will be not available.
4485
4328
  * * 'global': The entire `fin` API will be available.
4486
4329
  *
4487
- * @default 'global'
4330
+ * @defaultValue 'global'
4488
4331
  */
4489
4332
  fin?: InjectionType;
4490
4333
  /**
@@ -4500,9 +4343,8 @@ declare type DomainApiSettings = {
4500
4343
  * @interface
4501
4344
  * Defines application settings that vary by the domain of the current context.
4502
4345
  *
4503
- * @remarks Renderers opened on `about:blank` are considered to belong to the domain of their opener (or, in the case of iframes,
4504
- * their parent), effective recursively. Domain rules matched to `about:blank` will only apply in cases where no opener
4505
- * exists.
4346
+ * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4347
+ * domain should be represented with a single rule.
4506
4348
  */
4507
4349
  declare type DomainSettings = {
4508
4350
  /**
@@ -4517,22 +4359,19 @@ declare type DomainSettings = {
4517
4359
  * more information, see the documentation for the individual properties.
4518
4360
  */
4519
4361
  default?: PerDomainSettings;
4520
- /**
4521
- * {@inheritDoc MultipleDomainMatchBehavior}
4522
- */
4523
- multipleMatchBehavior?: MultipleDomainMatchBehavior;
4524
4362
  };
4525
4363
 
4526
4364
  /**
4527
- * Defines domain-conditional settings for an OpenFin application.
4528
4365
  * @interface
4366
+ *
4367
+ * Defines domain-conditional settings for an OpenFin application.
4529
4368
  */
4530
4369
  declare type DomainSettingsRule = {
4531
4370
  /**
4532
4371
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4533
4372
  * the domain(s) for which the rule applies.
4534
4373
  */
4535
- match: string[];
4374
+ match?: string[];
4536
4375
  /**
4537
4376
  * Settings applied when a webcontents has been navigated to a matched domain.
4538
4377
  */
@@ -4703,15 +4542,6 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
4703
4542
  eventNames: () => (string | symbol)[];
4704
4543
  /* Excluded from this release type: emit */
4705
4544
  private hasEmitter;
4706
- /**
4707
- * Cleans up after removal of a listener, e.g. deleting any lingering deregistration handlers for a
4708
- * `once` subscription.
4709
- *
4710
- * @remarks Implementing this as a `removeListener` handler ensures that direct removal of a listener
4711
- * on the base emitter will not leak additional core handlers. We could do this in the forwarding method,
4712
- * which would involve less "magic," but would be more-vulnerable to accidental re-introduction of a leak.
4713
- */
4714
- private cleanUpRemovedListener;
4715
4545
  private getOrCreateEmitter;
4716
4546
  listeners: (type: string | symbol) => Function[];
4717
4547
  listenerCount: (type: string | symbol) => number;
@@ -4878,7 +4708,6 @@ declare interface Environment {
4878
4708
  getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
4879
4709
  fdc3Version?: Version;
4880
4710
  }>;
4881
- getViewWindowIdentity(fin: OpenFin.Fin<OpenFin.EntityType>, identity: OpenFin.Identity): Promise<OpenFin.Identity>;
4882
4711
  readonly type: EnvironmentType;
4883
4712
  }
4884
4713
 
@@ -4912,7 +4741,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
4912
4741
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
4913
4742
  * from which they propagate).
4914
4743
  */
4915
- declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent;
4744
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | NotificationCloseRequested;
4916
4745
 
4917
4746
  /**
4918
4747
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
@@ -4952,7 +4781,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
4952
4781
  */
4953
4782
  declare type Event_5<Topic extends string> = {
4954
4783
  topic: Topic;
4955
- } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | DidStartLoadingEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent | WillRedirectEvent | ClipboardCopyBlockedEvent | ClipboardPasteBlockedEvent);
4784
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | DidStartLoadingEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent | WillRedirectEvent | NotificationInterceptedEvent);
4956
4785
 
4957
4786
  /**
4958
4787
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
@@ -5057,18 +4886,6 @@ declare type EventType_9 = Event_12['type'];
5057
4886
 
5058
4887
  /* Excluded from this release type: EventWithId */
5059
4888
 
5060
- /**
5061
- * @interface
5062
- */
5063
- declare type ExcludeOptions = {
5064
- /**
5065
- * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5066
- *
5067
- * @default false
5068
- */
5069
- preloadScripts: boolean;
5070
- };
5071
-
5072
4889
  /* Excluded from this release type: ExcludeRequested */
5073
4890
 
5074
4891
  declare type ExistingConnectConfig = ConfigWithUuid & {
@@ -5084,105 +4901,6 @@ declare type ExitCode = {
5084
4901
  exitCode: number;
5085
4902
  };
5086
4903
 
5087
- declare type ExtensionEvent = SecurityRealmEvent & {
5088
- /**
5089
- * Runtime extension whose status has been (possibly) modified
5090
- */
5091
- extension: string;
5092
- };
5093
-
5094
- /**
5095
- * @interface
5096
- */
5097
- declare type ExtensionInfo = {
5098
- extensionId: string;
5099
- name: string;
5100
- enabled: boolean;
5101
- };
5102
-
5103
- /**
5104
- * An event that fires when an extension is installed in the security realm.
5105
- *
5106
- * @interface
5107
- */
5108
- declare type ExtensionInstalledEvent = ExtensionEvent & {
5109
- type: 'extension-installed';
5110
- };
5111
-
5112
- /**
5113
- * An event that fires when an extension fails to install in the security realm.
5114
- *
5115
- * @interface
5116
- */
5117
- declare type ExtensionInstallFailedEvent = ExtensionEvent & {
5118
- type: 'extension-install-failed';
5119
- };
5120
-
5121
- /**
5122
- * An event that fires when extensions are disabled in the security realm.
5123
- *
5124
- * @interface
5125
- */
5126
- declare type ExtensionsDisabledEvent = ExtensionsEvent & {
5127
- type: 'extensions-disabled';
5128
- };
5129
-
5130
- /**
5131
- * An event that fires when extensions are enabled in the security realm.
5132
- *
5133
- * @interface
5134
- */
5135
- declare type ExtensionsEnabledEvent = ExtensionsEvent & {
5136
- type: 'extensions-enabled';
5137
- };
5138
-
5139
- declare type ExtensionsEvent = SecurityRealmEvent & {
5140
- /**
5141
- * Runtime extensions whose status has been (possibly) modified
5142
- */
5143
- extensions: string[];
5144
- };
5145
-
5146
- /**
5147
- * An event that fires when requested extensions are not allowed to be installed in the security realm.
5148
- *
5149
- * @interface
5150
- */
5151
- declare type ExtensionsExcludedEvent = ExtensionsEvent & {
5152
- type: 'extensions-excluded';
5153
- };
5154
-
5155
- /**
5156
- * An event that fires when extension initialization fails on initial app launch. Users may attempt to
5157
- * re-initialize extensions by calling {@link System.refreshExtensions}. This event will not fire in response
5158
- * to manual extension refreshes (users should catch the error normally).
5159
- */
5160
- declare type ExtensionsInitializationFailedEvent = Omit<ExtensionsEvent, 'extensions'> & {
5161
- type: 'extensions-initialization-failed';
5162
- /**
5163
- * The error that caused the extension initialization failure
5164
- */
5165
- error: Error;
5166
- };
5167
-
5168
- /**
5169
- * An event that fires when extensions are installed in the security realm.
5170
- *
5171
- * @interface
5172
- */
5173
- declare type ExtensionsInstalledEvent = ExtensionsEvent & {
5174
- type: 'extensions-installed';
5175
- };
5176
-
5177
- /**
5178
- * An event that fires when extensions fail to install in the security realm.
5179
- *
5180
- * @interface
5181
- */
5182
- declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
5183
- type: 'extensions-install-failed';
5184
- };
5185
-
5186
4904
  /**
5187
4905
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
5188
4906
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
@@ -5372,10 +5090,6 @@ declare namespace FDC3 {
5372
5090
  }
5373
5091
  }
5374
5092
 
5375
- declare type FDC3Factory = typeof fdc3Factory;
5376
-
5377
- declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin.InteropClient, wire: Transport<'unknown'>) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
5378
-
5379
5093
  export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
5380
5094
  fdc3Version?: Fdc3Version;
5381
5095
  }): Promise<Fdc3Module | Fdc3Module2>;
@@ -5830,7 +5544,6 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5830
5544
  * Domain-conditional rules for file downloads.
5831
5545
  *
5832
5546
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5833
- * @interface
5834
5547
  */
5835
5548
  declare type FileDownloadSettings = {
5836
5549
  /**
@@ -5883,34 +5596,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
5883
5596
  */
5884
5597
  declare type FindInPageOptions = {
5885
5598
  /**
5886
- * Searches in the forward direction (backward otherwise)
5599
+ * @defaultValue true
5887
5600
  *
5888
- * @default true
5601
+ * Searches in the forward direction (backward otherwise)
5889
5602
  */
5890
5603
  forward?: boolean;
5891
5604
  /**
5892
- * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5605
+ * @defaultValue false
5893
5606
  *
5894
- * @default false
5607
+ * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5895
5608
  */
5896
5609
  findNext?: boolean;
5897
5610
  /**
5898
- * Enables case-sensitive searching.
5611
+ * @defaultValue false
5899
5612
  *
5900
- * @default false
5613
+ * Enables case-sensitive searching.
5901
5614
  */
5902
5615
  matchCase?: boolean;
5903
5616
  /**
5904
- * Only searches from the start of words.
5617
+ * @defaultValue false
5905
5618
  *
5906
- * @default false
5619
+ * Only searches from the start of words.
5907
5620
  */
5908
5621
  wordStart?: boolean;
5909
5622
  /**
5623
+ * @defaultValue false
5624
+ *
5910
5625
  * 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>
5911
5626
  * lowercase or non-letter. Accepts several other intra-word matches.
5912
- *
5913
- * @default false
5914
5627
  */
5915
5628
  medialCapitalAsWordStart?: boolean;
5916
5629
  };
@@ -6059,8 +5772,11 @@ declare type FrameEventType = EventType_5;
6059
5772
  /**
6060
5773
  * @interface
6061
5774
  */
6062
- declare type FrameInfo = EntityInfo & {
5775
+ declare type FrameInfo = {
5776
+ name: string;
5777
+ uuid: string;
6063
5778
  url: string;
5779
+ entityType: EntityType_4;
6064
5780
  parent: Identity_4;
6065
5781
  };
6066
5782
 
@@ -6136,30 +5852,6 @@ declare type FrameProcessDetails = ProcessDetails & {
6136
5852
  entityType: string;
6137
5853
  };
6138
5854
 
6139
- /**
6140
- * @interface
6141
- * Options for the {@link Window._Window.getBounds} method.
6142
- */
6143
- declare interface GetBoundsOptions {
6144
- /**
6145
- * Specifies the state of the window for which to retrieve the bounds.
6146
- *
6147
- * - `'normal'`: Returns the bounds of the window in its 'normal' state (not maximized or minimized).
6148
- * - `'current'`: Returns the bounds of the window in its current state. For a minimized window, this returns the bounds from its previous state before being minimized.
6149
- *
6150
- * If a window is in `normal` state, `current` and `normal` will return the same bounds.
6151
- *
6152
- * If a window is `maximized`, `current` will return the dimensions of the screen while `normal` will return the bounds the window will be restored to.
6153
- *
6154
- * If a window is `minimized`, both `current` and `normal` will return the bounds of the window prior to it being minimized.
6155
- *
6156
- * **Edge case:** On MacOS, if a window is maximized, then minimized, calling `getBounds` with `boundsType: 'current'` will return the bounds of the window when it was maximized while `normal` will return the normal bounds.
6157
- *
6158
- * @default 'normal'
6159
- */
6160
- boundsType?: 'normal' | 'current';
6161
- }
6162
-
6163
5855
  /**
6164
5856
  * @interface
6165
5857
  */
@@ -6418,9 +6110,9 @@ declare type Hotkey = {
6418
6110
  */
6419
6111
  keys: string;
6420
6112
  /**
6421
- * Prevent default key handling before emitting the event.
6113
+ * @defaultValue false
6422
6114
  *
6423
- * @default false
6115
+ * Prevent default key handling before emitting the event.
6424
6116
  */
6425
6117
  preventDefault?: boolean;
6426
6118
  };
@@ -7373,7 +7065,7 @@ declare class InteropBroker extends Base {
7373
7065
  };
7374
7066
  private getClientState;
7375
7067
  private static toObject;
7376
- static checkContextIntegrity: (context: OpenFin.Context) => {
7068
+ static checkContextIntegrity(context: OpenFin.Context): {
7377
7069
  isValid: true;
7378
7070
  } | {
7379
7071
  isValid: false;
@@ -8067,7 +7759,7 @@ declare type LaunchIntoPlatformPayload = {
8067
7759
  *
8068
7760
  * @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
8069
7761
  *
8070
- * #### [addEventListener(type, listener [, options]);](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener)
7762
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
8071
7763
  * Adds a listener to the end of the listeners array for the specified event.
8072
7764
  * @example
8073
7765
  * ```js
@@ -8084,7 +7776,7 @@ declare type LaunchIntoPlatformPayload = {
8084
7776
  * });
8085
7777
  * ```
8086
7778
  *
8087
- * #### [removeEventListener(type, listener [, options]);](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener)
7779
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
8088
7780
  * Adds a listener to the end of the listeners array for the specified event.
8089
7781
  * @example
8090
7782
  * ```js
@@ -8183,7 +7875,6 @@ declare type LaunchIntoPlatformPayload = {
8183
7875
  */
8184
7876
  declare class Layout extends Base {
8185
7877
  #private;
8186
- /* Excluded from this release type: getClient */
8187
7878
  /* Excluded from this release type: init */
8188
7879
  identity: OpenFin.Identity | OpenFin.LayoutIdentity;
8189
7880
  private platform;
@@ -8283,17 +7974,6 @@ declare class Layout extends Base {
8283
7974
  * ```
8284
7975
  */
8285
7976
  getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
8286
- /**
8287
- * Retrieves the OpenFin.TabStack instance which the View belongs to.
8288
- *
8289
- * @example
8290
- * ```js
8291
- * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
8292
- * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
8293
- * console.log(await stack.getViews());
8294
- * ```
8295
- */
8296
- getStackByViewIdentity(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
8297
7977
  /**
8298
7978
  * Replaces the specified view with a view with the provided configuration.
8299
7979
  *
@@ -8347,29 +8027,6 @@ declare class Layout extends Base {
8347
8027
  * ```
8348
8028
  */
8349
8029
  applyPreset: (options: PresetLayoutOptions) => Promise<void>;
8350
- /**
8351
- * Adds a view to the platform layout. Behaves like {@link Platform#createView Platform.createView} with the current layout as the target.
8352
- *
8353
- * @param viewOptions - The options for creating the view.
8354
- * @param options - Optional parameters for adding the view.
8355
- * @param options.location - The location where the view should be added.
8356
- * @param options.targetView - The target view to which the new view should be added.
8357
- * @returns A promise that resolves to an object containing the identity of the added view.
8358
- */
8359
- addView(viewOptions: OpenFin.PlatformViewCreationOptions, { location, targetView }?: {
8360
- location?: OpenFin.CreateViewTarget['location'];
8361
- targetView?: OpenFin.Identity;
8362
- }): Promise<{
8363
- identity: OpenFin.Identity;
8364
- }>;
8365
- /**
8366
- * Closes a view by its identity. Throws an error if the view does not belong to the current layout.
8367
- * Behaves like {@link Platform#closeView Platform.closeView} but only closes the view if it belongs the current layout.
8368
- *
8369
- * @param viewIdentity - The identity of the view to close.
8370
- * @returns A promise that resolves when the view is closed.
8371
- */
8372
- closeView(viewIdentity: OpenFin.Identity): Promise<void>;
8373
8030
  }
8374
8031
 
8375
8032
  /**
@@ -8382,7 +8039,7 @@ declare type LayoutColumn = LayoutItemConfig & {
8382
8039
  /**
8383
8040
  * @interface
8384
8041
  */
8385
- declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
8042
+ declare type LayoutComponent = LayoutItemConfig & {
8386
8043
  /**
8387
8044
  * Only a component type will have this property and it should be set to view.
8388
8045
  */
@@ -8391,7 +8048,6 @@ declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
8391
8048
  * Only a component type will have this property and it represents the view options of a given component.
8392
8049
  */
8393
8050
  componentState?: Partial<ViewCreationOptions>;
8394
- type: 'component';
8395
8051
  };
8396
8052
 
8397
8053
  declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
@@ -8475,7 +8131,10 @@ declare type LayoutIdentity = Identity_4 & {
8475
8131
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8476
8132
  type: 'layout-initialized';
8477
8133
  layoutIdentity: OpenFin.LayoutIdentity;
8478
- ofViews: OpenFin.ViewCreationResult[];
8134
+ ofViews: {
8135
+ identity: OpenFin.Identity;
8136
+ entityType: 'view';
8137
+ }[];
8479
8138
  };
8480
8139
 
8481
8140
  /**
@@ -8583,7 +8242,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
8583
8242
  /**
8584
8243
  * @experimental
8585
8244
  */
8586
- getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
8245
+ getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
8587
8246
  /**
8588
8247
  * @experimental
8589
8248
  */
@@ -8684,17 +8343,6 @@ declare class LayoutModule extends Base {
8684
8343
  * ```
8685
8344
  */
8686
8345
  getCurrentSync(): OpenFin.Layout;
8687
- /**
8688
- * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
8689
- *
8690
- * @example
8691
- * ```js
8692
- * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
8693
- * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
8694
- * console.log(await layout.getCurrentViews());
8695
- * ```
8696
- */
8697
- getLayoutByViewIdentity(viewIdentity: OpenFin.Identity): Promise<OpenFin.Layout>;
8698
8346
  /**
8699
8347
  * Initialize the window's Layout.
8700
8348
  *
@@ -8756,79 +8404,77 @@ declare type LayoutOptions = {
8756
8404
  */
8757
8405
  settings?: {
8758
8406
  /**
8759
- * When true the splitters will not be draggable and the layout will not resize.
8407
+ * @defaultValue false
8760
8408
  *
8761
- * @default false
8409
+ * When true the splitters will not be draggable and the layout will not resize.
8762
8410
  */
8763
8411
  preventSplitterResize?: boolean;
8764
8412
  /**
8413
+ * @defaultValue false
8414
+ *
8765
8415
  * Whether the popout button will only act on the entire stack,
8766
8416
  * as opposed to only the active tab.
8767
- *
8768
- * @default false
8769
8417
  */
8770
8418
  popoutWholeStack?: boolean;
8771
8419
  /**
8420
+ * @defaultValue false
8421
+ *
8772
8422
  * Limits the area to which tabs can be dragged.
8773
8423
  * If true, the layout container is the only area where tabs can be dropped.
8774
- *
8775
- * @default false
8776
8424
  */
8777
8425
  constrainDragToContainer?: boolean;
8778
8426
  /**
8427
+ * @defaultValue false
8428
+ *
8779
8429
  * Whether to show the popout button on stack header.
8780
8430
  * The button will create a new window with current tab as its content.
8781
8431
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8782
- *
8783
- * @default false
8784
8432
  */
8785
8433
  showPopoutIcon?: boolean;
8786
8434
  /**
8435
+ * @defaultValue false
8436
+ *
8787
8437
  * Whether to show the maximize button on stack header.
8788
8438
  * The button will maximize the current tab to fill the entire window.
8789
- *
8790
- * @default false
8791
8439
  */
8792
8440
  showMaximiseIcon?: boolean;
8793
8441
  /**
8442
+ * @defaultValue false
8443
+ *
8794
8444
  * Whether to show the close button on stack header
8795
8445
  * (not to be confused with close button on every tab).
8796
- *
8797
- * @default false
8798
8446
  */
8799
8447
  showCloseIcon?: boolean;
8800
8448
  /**
8801
- * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8449
+ * @defaultValue false
8802
8450
  *
8803
- * @default false
8451
+ * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8804
8452
  */
8805
8453
  constrainDragToHeaders?: boolean;
8806
8454
  /**
8455
+ * @defaultValue true
8456
+ *
8807
8457
  * Turns tab headers on or off.
8808
8458
  * If false, the layout will be displayed with splitters only.
8809
- *
8810
- * @default true
8811
8459
  */
8812
8460
  hasHeaders?: boolean;
8813
8461
  /**
8462
+ * @defaultValue true
8463
+ *
8814
8464
  * If true, the user can re-arrange the layout by
8815
8465
  * dragging items by their tabs to the desired location.
8816
- *
8817
- * @default true
8818
8466
  */
8819
8467
  reorderEnabled?: boolean;
8820
8468
  /**
8821
- * If true, tabs can't be dragged out of the window.
8469
+ * @defaultValue false
8822
8470
  *
8823
- * @default false
8471
+ * If true, tabs can't be dragged out of the window.
8824
8472
  */
8825
8473
  preventDragOut?: boolean;
8826
8474
  /**
8827
8475
  * @defaultValue=false
8828
8476
  *
8829
8477
  * If true, tabs can't be dragged into the window.
8830
- *
8831
- * @default false
8832
8478
  */
8833
8479
  preventDragIn?: boolean;
8834
8480
  };
@@ -9250,19 +8896,6 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9250
8896
  */
9251
8897
  declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9252
8898
 
9253
- /**
9254
- * Behavior for handling multiple {@link DomainSettingsRule} matches.
9255
- */
9256
- declare type MultipleDomainMatchBehavior =
9257
- /**
9258
- * Apply only the first matching rule in the list.
9259
- */
9260
- 'pick-first'
9261
- /**
9262
- * Deep-merge all matching rules in the list, prioritizing earlier matches. Treats arrays as primitives.
9263
- */
9264
- | 'deep-merge';
9265
-
9266
8899
  /**
9267
8900
  * @interface
9268
8901
  */
@@ -9271,10 +8904,10 @@ declare type MutableViewOptions = {
9271
8904
  /**
9272
8905
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9273
8906
  *
8907
+ * @defaultValue true
8908
+ *
9274
8909
  * Show the context menu when right-clicking on the view.
9275
8910
  * Gives access to the devtools for the view.
9276
- *
9277
- * @default true
9278
8911
  */
9279
8912
  contextMenu: boolean;
9280
8913
  /**
@@ -9321,25 +8954,24 @@ declare type MutableViewOptions = {
9321
8954
  contentNavigation: ContentNavigation;
9322
8955
  contentRedirect: ContentRedirect;
9323
8956
  /**
8957
+ * @defaultValue false
9324
8958
  * @deprecated
9325
8959
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9326
8960
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9327
- *
9328
- * @default false
9329
8961
  */
9330
8962
  detachOnClose: boolean;
9331
8963
  /**
8964
+ * @defaultValue true
8965
+ *
9332
8966
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9333
8967
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9334
8968
  * if the view isn't part of the new layout when running `Layout.replace`.
9335
- *
9336
- * @default true
9337
8969
  */
9338
8970
  isClosable: boolean;
9339
8971
  /**
9340
- * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
8972
+ * @defaultValue false
9341
8973
  *
9342
- * @default false
8974
+ * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9343
8975
  */
9344
8976
  preventDragOut: boolean;
9345
8977
  interop?: InteropConfig;
@@ -9347,13 +8979,9 @@ declare type MutableViewOptions = {
9347
8979
  /**
9348
8980
  * {@inheritDoc ViewThrottling}
9349
8981
  *
9350
- * @default 'enabled'
8982
+ * @defaultValue 'enabled'
9351
8983
  */
9352
8984
  throttling: ViewThrottling;
9353
- /**
9354
- * {@inheritDoc ChromiumPolicies}
9355
- */
9356
- chromiumPolicies: ChromiumPolicies;
9357
8985
  };
9358
8986
 
9359
8987
  /**
@@ -9366,7 +8994,7 @@ declare type MutableWindowOptions = {
9366
8994
  * Turns anything of matching RGB value transparent.
9367
8995
  *
9368
8996
  * Caveats:
9369
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
8997
+ * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9370
8998
  * * User cannot click-through transparent regions
9371
8999
  * * Not supported on Mac
9372
9000
  * * Windows Aero must be enabled
@@ -9375,25 +9003,25 @@ declare type MutableWindowOptions = {
9375
9003
  */
9376
9004
  alphaMask: RGB;
9377
9005
  /**
9378
- * Always position the window at the top of the window stack.
9006
+ * @defaultValue false
9379
9007
  *
9380
- * @default false
9008
+ * Always position the window at the top of the window stack.
9381
9009
  */
9382
9010
  alwaysOnTop: boolean;
9383
9011
  /**
9012
+ * @defaultValue 0
9013
+ *
9384
9014
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9385
9015
  * an aspect ratio will not be enforced.
9386
- *
9387
- * @default 0
9388
9016
  */
9389
9017
  aspectRatio: number;
9390
9018
  /**
9391
9019
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9392
9020
  *
9021
+ * @defaultValue true
9022
+ *
9393
9023
  * Show the context menu when right-clicking on the window.
9394
9024
  * Gives access to the devtools for the window.
9395
- *
9396
- * @default true
9397
9025
  */
9398
9026
  contextMenu: boolean;
9399
9027
  /**
@@ -9463,14 +9091,12 @@ declare type MutableWindowOptions = {
9463
9091
  * @defaultValue true
9464
9092
  *
9465
9093
  * Show the window's frame.
9466
- *
9467
- * @default true
9468
9094
  */
9469
9095
  frame: boolean;
9470
9096
  /**
9471
- * Hides the window instead of closing it when the close button is pressed.
9097
+ * @defaultValue false
9472
9098
  *
9473
- * @default false
9099
+ * Hides the window instead of closing it when the close button is pressed.
9474
9100
  */
9475
9101
  hideOnClose: boolean;
9476
9102
  /**
@@ -9523,61 +9149,60 @@ declare type MutableWindowOptions = {
9523
9149
  */
9524
9150
  icon: string;
9525
9151
  /**
9152
+ * @defaultValue true
9153
+ *
9526
9154
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9527
9155
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9528
- *
9529
- * @default true
9530
9156
  */
9531
9157
  includeInSnapshots: boolean;
9532
9158
  /**
9533
- * The maximum height of a window. Will default to the OS defined value if set to -1.
9159
+ * @defaultValue -1
9534
9160
  *
9535
- * @default -1
9161
+ * The maximum height of a window. Will default to the OS defined value if set to -1.
9536
9162
  */
9537
9163
  maxHeight: number;
9538
9164
  /**
9539
- * Allows the window to be maximized.
9165
+ * @defaultValue true
9540
9166
  *
9541
- * @default true
9167
+ * Allows the window to be maximized.
9542
9168
  */
9543
9169
  maximizable: boolean;
9544
9170
  /**
9545
- * The maximum width of a window. Will default to the OS defined value if set to -1.
9171
+ * @defaultValue -1
9546
9172
  *
9547
- * @default -1
9173
+ * The maximum width of a window. Will default to the OS defined value if set to -1.
9548
9174
  */
9549
9175
  maxWidth: number;
9550
9176
  /**
9551
- * The minimum height of the window.
9177
+ * @defaultValue 0
9552
9178
  *
9553
- * @default 0
9179
+ * The minimum height of the window.
9554
9180
  */
9555
9181
  minHeight: number;
9556
9182
  /**
9557
- * Allows the window to be minimized.
9183
+ * @defaultValue true
9558
9184
  *
9559
- * @default true
9185
+ * Allows the window to be minimized.
9560
9186
  */
9561
9187
  minimizable: boolean;
9562
9188
  /**
9563
- * The minimum width of the window.
9189
+ * @defaultValue true
9564
9190
  *
9565
- * @default true
9191
+ * The minimum width of the window.
9566
9192
  */
9567
9193
  minWidth: number;
9568
9194
  /**
9195
+ * @defaultValue 1
9196
+ *
9569
9197
  * A flag that specifies how transparent the window will be.
9570
9198
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9571
9199
  * This value is clamped between `0.0` and `1.0`.
9572
- * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9573
- *
9574
- * @default 1
9575
9200
  */
9576
9201
  opacity: number;
9577
9202
  /**
9578
- * A flag to allow the user to resize the window.
9203
+ * @defaultValue true
9579
9204
  *
9580
- * @default true
9205
+ * A flag to allow the user to resize the window.
9581
9206
  */
9582
9207
  resizable: boolean;
9583
9208
  /**
@@ -9585,39 +9210,29 @@ declare type MutableWindowOptions = {
9585
9210
  */
9586
9211
  resizeRegion: ResizeRegion;
9587
9212
  /**
9213
+ * @defaultValue false
9214
+ *
9588
9215
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9589
9216
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9590
- *
9591
- * @default false
9592
9217
  */
9593
9218
  showBackgroundImages: boolean;
9594
9219
  /**
9595
- * Shows the window's icon in the taskbar.
9220
+ * @defaultValue true
9596
9221
  *
9597
- * @default true
9222
+ * Shows the window's icon in the taskbar.
9598
9223
  */
9599
9224
  showTaskbarIcon: boolean;
9600
- /**
9601
- * Specify a taskbar group for the window.
9602
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
9603
- * @remarks It's only updatable when `enableJumpList` is set to false.
9604
- */
9605
- taskbarIconGroup: string;
9606
9225
  interop: InteropConfig;
9607
9226
  /* Excluded from this release type: _internalWorkspaceData */
9608
9227
  /* Excluded from this release type: workspacePlatform */
9609
9228
  /**
9610
9229
  * {@inheritDoc WindowThrottling}
9611
9230
  *
9612
- * @default 'enabled'
9231
+ * @defaultValue 'enabled'
9613
9232
  *
9614
9233
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9615
9234
  */
9616
9235
  throttling: WindowThrottling;
9617
- /**
9618
- * {@inheritDoc ChromiumPolicies}
9619
- */
9620
- chromiumPolicies: ChromiumPolicies;
9621
9236
  };
9622
9237
 
9623
9238
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -9638,14 +9253,13 @@ declare type NativeWindowIntegrationProviderAuthorization = {
9638
9253
  };
9639
9254
 
9640
9255
  /**
9641
- * Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules or when blocked by a domain-based permission content rule.
9256
+ * Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
9642
9257
  * @interface
9643
9258
  */
9644
9259
  declare type NavigationRejectedEvent = NamedEvent & {
9645
9260
  type: 'navigation-rejected';
9646
9261
  sourceName?: string;
9647
9262
  url: string;
9648
- contentRule?: OpenFin.ContentPermission | undefined;
9649
9263
  };
9650
9264
 
9651
9265
  /**
@@ -9703,28 +9317,176 @@ declare type NonAppProcessDetails = ProcessDetails & {
9703
9317
  name: string;
9704
9318
  };
9705
9319
 
9706
- /**
9707
- * @DEPRECATED All view events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9708
- *
9709
- * A view event that does not propagate to (republish on) parent topics.
9710
- */
9711
- declare type NonPropagatedViewEvent = never;
9712
-
9713
- /**
9714
- * @DEPRECATED all webcontents events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9715
- *
9716
- * A WebContents event that does not propagate to (republish on) parent topics.
9717
- */
9718
- declare type NonPropagatedWebContentsEvent = never;
9719
-
9720
- /**
9721
- * @DEPRECATED All window events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9722
- *
9723
- * A window event that does not propagate to (republish on) parent topics.
9724
- */
9725
- declare type NonPropagatedWindowEvent = never;
9726
-
9727
- /* Excluded from this release type: NotCloseRequested */
9320
+ /**
9321
+ * @DEPRECATED All view events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9322
+ *
9323
+ * A view event that does not propagate to (republish on) parent topics.
9324
+ */
9325
+ declare type NonPropagatedViewEvent = never;
9326
+
9327
+ /**
9328
+ * @DEPRECATED all webcontents events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9329
+ *
9330
+ * A WebContents event that does not propagate to (republish on) parent topics.
9331
+ */
9332
+ declare type NonPropagatedWebContentsEvent = never;
9333
+
9334
+ /**
9335
+ * @DEPRECATED All window events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9336
+ *
9337
+ * A window event that does not propagate to (republish on) parent topics.
9338
+ */
9339
+ declare type NonPropagatedWindowEvent = never;
9340
+
9341
+ /* Excluded from this release type: NotCloseRequested */
9342
+
9343
+ declare type NotificationAction_2 = {
9344
+ /**
9345
+ * Type of action this structure represents (BUTTON, TEXT)
9346
+ */
9347
+ type: number;
9348
+ /**
9349
+ * Action name that the author can use to distinguish them.
9350
+ */
9351
+ action: string;
9352
+ /**
9353
+ * Title of the action button.
9354
+ */
9355
+ title: string;
9356
+ /**
9357
+ * URL of the icon for the button. May be empty if no url was specified.
9358
+ */
9359
+ icon: string;
9360
+ /**
9361
+ * Placeholder to display for text-based actions in absence of user input.
9362
+ */
9363
+ placeholder: string;
9364
+ };
9365
+
9366
+ /**
9367
+ * Emitted when a developer has called .close on a notification which has been interecepted.
9368
+ */
9369
+ declare type NotificationCloseRequested = BaseEvent_9 & {
9370
+ type: 'notification-close-requested';
9371
+ notificationId: string;
9372
+ };
9373
+
9374
+ declare type NotificationData = {
9375
+ /**
9376
+ * Title to be displayed with the Web Notification.
9377
+ */
9378
+ title: string;
9379
+ /**
9380
+ * Hint to determine the directionality of the displayed notification.
9381
+ * (LEFT_TO_RIGHT, RIGHT_TO_LEFT, AUTO)
9382
+ */
9383
+ direction: number;
9384
+ /**
9385
+ * BCP 47 language tag describing the notification's contents. Optional.
9386
+ */
9387
+ lang: string;
9388
+ /**
9389
+ * Contents of the notification.
9390
+ */
9391
+ body: string;
9392
+ /**
9393
+ * Tag of the notification. Notifications sharing both their origin and their, tag
9394
+ * will replace the first displayed notification.
9395
+ */
9396
+ tag: string;
9397
+ /**
9398
+ * URL of the image contents of the notification. May be empty if no url was
9399
+ * specified.
9400
+ */
9401
+ image: string;
9402
+ /**
9403
+ * URL of the icon which is to be displayed with the notification.
9404
+ */
9405
+ icon: string;
9406
+ /**
9407
+ * URL of the badge for representing the notification. May be empty if no url was
9408
+ * specified.
9409
+ */
9410
+ badge: string;
9411
+ /**
9412
+ * Vibration pattern for the notification, following the syntax of the Vibration
9413
+ * API. https://www.w3.org/TR/vibration/
9414
+ */
9415
+ vibration_pattern: number[];
9416
+ /**
9417
+ * The time at which the event the notification represents took place.
9418
+ */
9419
+ timestamp: string;
9420
+ /**
9421
+ * Whether default notification indicators (sound, vibration, light) should be
9422
+ * played again if the notification is replacing an older notification.
9423
+ */
9424
+ renotify: boolean;
9425
+ /**
9426
+ * Whether default notification indicators (sound, vibration, light) should be
9427
+ * played again if the notification is replacing an older notification.
9428
+ */
9429
+ silent: boolean;
9430
+ /**
9431
+ * Whether the notification should remain onscreen indefinitely, rather than being
9432
+ * auto-minimized to the notification center (if allowed by platform).
9433
+ */
9434
+ requireInteraction: boolean;
9435
+ /**
9436
+ * Base64 encoded Developer-provided data associated with the notification, in the
9437
+ * form of a serialized string. Must not exceed |kMaximumDeveloperDataSize| bytes.
9438
+ */
9439
+ data: string;
9440
+ /**
9441
+ * Actions that should be shown as buttons on the notification.
9442
+ */
9443
+ actions: NotificationAction_2[];
9444
+ /**
9445
+ * The time at which the notification should be shown.
9446
+ */
9447
+ showTriggerTimestamp?: string | null;
9448
+ /**
9449
+ * Scenarios that define the notification behavior. (DEFAULT, INCOMING_CALL)
9450
+ */
9451
+ scenario: number;
9452
+ };
9453
+
9454
+ declare type NotificationInterceptedEvent = NamedEvent & {
9455
+ type: 'notification-intercepted';
9456
+ /**
9457
+ * id of the notification
9458
+ */
9459
+ notificationId: string;
9460
+ /**
9461
+ * origin of the notification
9462
+ */
9463
+ origin: string;
9464
+ /**
9465
+ * empty if notification comes from worker
9466
+ */
9467
+ documentUrl: string;
9468
+ notificationData: NotificationData;
9469
+ /**
9470
+ * Image for the notification. The bitmap may be empty if the developer did not
9471
+ * provide an image, or fetching of the image failed.
9472
+ */
9473
+ image: SerializedImage;
9474
+ /**
9475
+ * Main icon for the notification. The bitmap may be empty if the developer did not
9476
+ * provide an icon, or fetching of the icon failed.
9477
+ */
9478
+ notificationIcon: SerializedImage;
9479
+ /**
9480
+ * Badge for the notification. The bitmap may be empty if the developer did not
9481
+ * provide a badge, or fetching of the badge failed.
9482
+ */
9483
+ badge: SerializedImage;
9484
+ /**
9485
+ * Icons for the actions. A bitmap may be empty if the developer did not provide an
9486
+ * icon, or fetching of the icon failed.
9487
+ */
9488
+ actionIcons: SerializedImage[];
9489
+ };
9728
9490
 
9729
9491
  /* Excluded from this release type: NotRequested */
9730
9492
 
@@ -9795,11 +9557,8 @@ declare namespace OpenFin {
9795
9557
  ClientConnectionPayload,
9796
9558
  EntityInfo,
9797
9559
  EntityType_4 as EntityType,
9798
- ScreenCaptureState,
9799
- ScreenCapturePermission,
9800
9560
  Bounds,
9801
9561
  WindowBounds,
9802
- GetBoundsOptions,
9803
9562
  Rectangle,
9804
9563
  ApplicationCreationOptions,
9805
9564
  TimeZones,
@@ -9832,11 +9591,8 @@ declare namespace OpenFin {
9832
9591
  ViewVisibilityOptions,
9833
9592
  WindowState,
9834
9593
  AutoplayPolicyOptions,
9835
- ExcludeOptions,
9836
9594
  ConstWindowOptions,
9837
9595
  InheritableOptions,
9838
- PolicyOptions,
9839
- ChromiumPolicies,
9840
9596
  MutableWindowOptions,
9841
9597
  WorkspacePlatformOptions,
9842
9598
  WebRequestHeader,
@@ -9870,9 +9626,6 @@ declare namespace OpenFin {
9870
9626
  ViewOptions,
9871
9627
  ConstViewOptions,
9872
9628
  ViewState,
9873
- ViewCreationSuccess,
9874
- ViewCreationFailure,
9875
- ViewCreationResult,
9876
9629
  Certificate,
9877
9630
  HostContextChangedPayload,
9878
9631
  ApplySnapshotOptions,
@@ -9902,7 +9655,6 @@ declare namespace OpenFin {
9902
9655
  OpenExternalPermission,
9903
9656
  DeviceInfo,
9904
9657
  Permissions_2 as Permissions,
9905
- ClipboardApiPermissions,
9906
9658
  PlatformWindowCreationOptions,
9907
9659
  PlatformWindowOptions,
9908
9660
  PlatformViewCreationOptions,
@@ -10008,21 +9760,11 @@ declare namespace OpenFin {
10008
9760
  RuntimeInfo,
10009
9761
  DefaultDomainSettings,
10010
9762
  DefaultDomainSettingsRule,
10011
- MultipleDomainMatchBehavior,
10012
9763
  DomainSettings,
10013
9764
  ApiInjection,
10014
9765
  DomainApiSettings,
10015
- BaseContentBehavior,
10016
- ContentBehavior,
10017
- BrowserContentBehavior,
10018
- StructuredContentBehavior,
10019
- StructuredContentPermissions,
10020
9766
  ContentPermission,
10021
- ScreenCaptureBehavior,
10022
9767
  PerDomainSettings,
10023
- CopyPermissions,
10024
- PastePermissions,
10025
- ClipboardPermissions,
10026
9768
  DomainSettingsRule,
10027
9769
  FileDownloadBehavior,
10028
9770
  FileDownloadBehaviorNames,
@@ -10122,7 +9864,6 @@ declare namespace OpenFin {
10122
9864
  Me,
10123
9865
  CapturePageOptions,
10124
9866
  ProcessLoggingOptions,
10125
- BoundsType,
10126
9867
  PositioningOptions,
10127
9868
  ChannelClientConnectionListener,
10128
9869
  ChannelClientDisconnectionListener,
@@ -10130,12 +9871,6 @@ declare namespace OpenFin {
10130
9871
  RoutingInfo,
10131
9872
  DownloadShelfOptions,
10132
9873
  ViewShowAtOptions,
10133
- ExtensionInfo,
10134
- ServeRequest,
10135
- AppAssetServeRequest,
10136
- PathServeRequest,
10137
- ServeAssetOptions,
10138
- ServedAssetInfo,
10139
9874
  ApplicationEvents,
10140
9875
  BaseEvents,
10141
9876
  ExternalApplicationEvents,
@@ -10202,34 +9937,6 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
10202
9937
  title: string;
10203
9938
  };
10204
9939
 
10205
- /**
10206
- * Reasons for a paste operation being blocked
10207
- *
10208
- * 'invalid-data': Copy protection is enabled and the pasted data is invalid.
10209
- * 'disabled': Copy protection is turned on and the current URL for this WebContent has been disabled through domain-based settings from accessing the copied data.
10210
- */
10211
- declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10212
-
10213
- /**
10214
- * Control copy operations for a matched URL.
10215
- * @interface
10216
- */
10217
- declare type PastePermissions = {
10218
- /**
10219
- * Controls the behavior for paste operations for a matched URL.
10220
- *
10221
- * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10222
- * all-content: All matching URLs will be able to paste content copied from both protected (copy.behavior = 'protect') and on-protected (copy.behavior = 'allow') URLs.
10223
- *
10224
- * @default 'non-protected-content'
10225
- */
10226
- behavior: 'non-protected-content' | 'all-content';
10227
- };
10228
-
10229
- declare type PathServeRequest = ServeRequest & {
10230
- path: string;
10231
- };
10232
-
10233
9940
  declare type Payload<Success extends boolean = boolean, Data = any> = {
10234
9941
  success: Success;
10235
9942
  data: Success extends true ? Data : never;
@@ -10365,33 +10072,6 @@ declare type PerDomainSettings = {
10365
10072
  * {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
10366
10073
  */
10367
10074
  content?: ContentPermission;
10368
- /**
10369
- * {@inheritdoc ChromiumPolicies}
10370
- */
10371
- chromiumPolicies?: ChromiumPolicies;
10372
- /**
10373
- * @experimental These features are still under development and may change.
10374
- */
10375
- contentProtection?: {
10376
- /**
10377
- * {@inheritdoc ScreenCaptureBehavior}
10378
- */
10379
- screenCapture?: ScreenCaptureBehavior;
10380
- /**
10381
- * {@inheritdoc ClipboardPermissions}
10382
- */
10383
- clipboard?: ClipboardPermissions;
10384
- /**
10385
- * Whether the content can be printed.
10386
- * Defaults to 'allow'.
10387
- * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10388
- */
10389
- print?: 'allow' | 'block';
10390
- /**
10391
- * * Controls whether HTML5 dragging for this content is allowed or blocked.
10392
- */
10393
- drag?: 'allow' | 'block';
10394
- };
10395
10075
  };
10396
10076
 
10397
10077
  /**
@@ -10416,7 +10096,6 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
10416
10096
  declare type Permissions_2 = {
10417
10097
  Application?: Partial<ApplicationPermissions>;
10418
10098
  System?: Partial<SystemPermissions>;
10419
- Clipboard?: Partial<ClipboardApiPermissions>;
10420
10099
  webAPIs?: WebPermission[];
10421
10100
  devices?: DeviceInfo[];
10422
10101
  };
@@ -10438,7 +10117,6 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
10438
10117
  private _channel;
10439
10118
  Application: OpenFin.Application;
10440
10119
  identity: OpenFin.ApplicationIdentity;
10441
- /* Excluded from this release type: clientMap */
10442
10120
  /* Excluded from this release type: __constructor */
10443
10121
  getClient: (identity?: OpenFin.ApplicationIdentity) => Promise<ChannelClient_2>;
10444
10122
  /**
@@ -11248,11 +10926,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11248
10926
  */
11249
10927
  providerUrl?: string;
11250
10928
  /**
10929
+ * @defaultValue true
10930
+ *
11251
10931
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11252
10932
  *
11253
10933
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11254
- *
11255
- * @default true
11256
10934
  */
11257
10935
  allowLaunchIntoPlatform?: boolean;
11258
10936
  };
@@ -11748,53 +11426,6 @@ declare interface PlatformProvider {
11748
11426
  * @returns {Promise<void>}
11749
11427
  */
11750
11428
  handleRunRequested({ manifest, userAppConfigArgs }: RunRequestedEvent): Promise<void>;
11751
- /**
11752
- * @experimental
11753
- *
11754
- * This method is called to handle errors with view creation and initial navigation during layout creation.
11755
- * Overriding this method enables catching the error and correcting behavior (ie navigating to an error page).
11756
- * * To indicate that the error has been handled, view creation should be treated as successful return {identity: viewIdentity, success: true}.
11757
- * * Not returning anything will cause the layout-initialized event to include the view as failed with the original error.
11758
- * * Throwing an error will update the error on the event payload of layout-initialized to the thrown error.
11759
- *
11760
- * @param viewIdentity Identity of the view
11761
- * @param error error thrown during a view creation
11762
- * @returns {Promise<OpenFin.ViewCreationSuccess | void>}
11763
- *
11764
- * @example
11765
- *
11766
- * ```js
11767
- * const overrideCallback = (PlatformProvider) => {
11768
- * class Override extends PlatformProvider {
11769
- * async handleFailedViewCreation(viewIdentity, error) {
11770
- * const view = fin.View.wrapSync(viewId);
11771
- * try {
11772
- * // navigate to an error page
11773
- * await view.navigate('http://localhost:3000/errorPage.html');
11774
- * // resolve a success result after redirecting to a error page
11775
- * return {identity: viewIdentity, success: true};
11776
- * } catch(e) {
11777
- * // layout-initialized event will include this view with the error
11778
- * throw error;
11779
- * }
11780
- * }
11781
- * }
11782
- * return new Override();
11783
- * }
11784
- *
11785
- * fin.Platform.init({ overrideCallback });
11786
- *
11787
- * ```
11788
- */
11789
- handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
11790
- /**
11791
- * Determines whether a given window should prevent the application from quitting when it is closed.
11792
- * This method is called when checking if closing a window should trigger application termination.
11793
- *
11794
- * @param windowIdentity - The identity of the window being checked.
11795
- * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
11796
- */
11797
- shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
11798
11429
  }
11799
11430
 
11800
11431
  /**
@@ -11859,12 +11490,6 @@ declare type PointTopLeft = {
11859
11490
  left: number;
11860
11491
  };
11861
11492
 
11862
- /**
11863
- * When set to `disable`, disables the policy
11864
- * When set to `defer-to-group-policy`, respects Group Policy settings
11865
- */
11866
- declare type PolicyOptions = 'disable' | 'defer-to-group-policy';
11867
-
11868
11493
  declare type PopupBaseBehavior = 'close' | 'hide';
11869
11494
 
11870
11495
  declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
@@ -11896,22 +11521,22 @@ declare type PopupOptions = {
11896
11521
  url?: string;
11897
11522
  /**
11898
11523
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
11899
- * @default 300
11524
+ * @defaultValue 300
11900
11525
  */
11901
11526
  height?: number;
11902
11527
  /**
11903
11528
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
11904
- * @default 300
11529
+ * @defaultValue 300
11905
11530
  */
11906
11531
  width?: number;
11907
11532
  /**
11908
11533
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11909
- * @default 0
11534
+ * @defaultValue 0
11910
11535
  */
11911
11536
  x?: number;
11912
11537
  /**
11913
11538
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11914
- * @default 0
11539
+ * @defaultValue 0
11915
11540
  */
11916
11541
  y?: number;
11917
11542
  /**
@@ -11919,7 +11544,7 @@ declare type PopupOptions = {
11919
11544
  * * 'modal' restricts resizing and positioning in the caller.
11920
11545
  * * 'hide' hides the popup window on blur.
11921
11546
  * * 'close' closes the popup window on blur.
11922
- * @default 'close'
11547
+ * @defaultValue 'close'
11923
11548
  */
11924
11549
  blurBehavior?: PopupBlurBehavior;
11925
11550
  /**
@@ -11927,19 +11552,19 @@ declare type PopupOptions = {
11927
11552
  * * 'none' will do nothing.
11928
11553
  * * 'hide' hides the popup window on `dispatchPopupResult`.
11929
11554
  * * 'close' closes the popup window on `dispatchPopupResult`.
11930
- * @default 'close'
11555
+ * @defaultValue 'close'
11931
11556
  */
11932
11557
  resultDispatchBehavior?: PopupResultBehavior;
11933
11558
  /**
11934
11559
  * Hide the popup window instead of closing when `close` is called on it.
11935
11560
  *
11936
11561
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
11937
- * @default false
11562
+ * @defaultValue false
11938
11563
  */
11939
11564
  hideOnClose?: boolean;
11940
11565
  /**
11941
11566
  * Determines if the popup window should or should not be focused when it is shown.
11942
- * @default true
11567
+ * @defaultValue true
11943
11568
  */
11944
11569
  focus?: boolean;
11945
11570
  /**
@@ -12018,7 +11643,6 @@ declare type PositioningOptions = {
12018
11643
  * This will have the effect of the maximized window staying maximized and not immediately taking this new position.
12019
11644
  */
12020
11645
  skipRestore?: boolean;
12021
- boundsType?: BoundsType;
12022
11646
  };
12023
11647
 
12024
11648
  /**
@@ -12033,9 +11657,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12033
11657
  */
12034
11658
  declare type PreloadScript = {
12035
11659
  /**
12036
- * Fail to load the window if this preload script fails
11660
+ * @defaultValue false
12037
11661
  *
12038
- * @default false
11662
+ * Fail to load the window if this preload script fails
12039
11663
  */
12040
11664
  mandatory?: boolean;
12041
11665
  /**
@@ -12131,15 +11755,15 @@ declare type PrinterInfo = {
12131
11755
  declare type PrintOptions = {
12132
11756
  content?: 'self';
12133
11757
  /**
12134
- * Disables prompting the user for print settings.
11758
+ * @defaultValue false
12135
11759
  *
12136
- * @default false
11760
+ * Disables prompting the user for print settings.
12137
11761
  */
12138
11762
  silent?: boolean;
12139
11763
  /**
12140
- * Includes the webpage background color and image when printing.
11764
+ * @defaultValue false
12141
11765
  *
12142
- * @default false
11766
+ * Includes the webpage background color and image when printing.
12143
11767
  */
12144
11768
  printBackground?: boolean;
12145
11769
  /**
@@ -12147,9 +11771,9 @@ declare type PrintOptions = {
12147
11771
  */
12148
11772
  deviceName?: string;
12149
11773
  /**
12150
- * Prints in full color (greyscale otherwise).
11774
+ * @defaultValue true
12151
11775
  *
12152
- * @default true
11776
+ * Prints in full color (greyscale otherwise).
12153
11777
  */
12154
11778
  color?: boolean;
12155
11779
  /**
@@ -12157,9 +11781,9 @@ declare type PrintOptions = {
12157
11781
  */
12158
11782
  margins?: Margins;
12159
11783
  /**
12160
- * Prints in landscape mode (portrait otherwise).
11784
+ * @defaultValue true
12161
11785
  *
12162
- * @default true
11786
+ * Prints in landscape mode (portrait otherwise).
12163
11787
  */
12164
11788
  landscape?: boolean;
12165
11789
  /**
@@ -12406,9 +12030,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
12406
12030
  'set-tray-icon': ApplicationIdentityCall<{
12407
12031
  enabledIcon: string;
12408
12032
  }, void>;
12409
- 'set-tray-icon-tooltip': ApplicationIdentityCall<{
12410
- toolTip: string;
12411
- }>;
12412
12033
  'set-shortcuts': ApplicationIdentityCall<{
12413
12034
  data: OpenFin.ShortCutConfig;
12414
12035
  }, void>;
@@ -12546,9 +12167,7 @@ declare interface ProtocolMap extends ProtocolMapBase {
12546
12167
  options: OpenFin.TransitionOptions;
12547
12168
  }>;
12548
12169
  'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
12549
- 'get-window-bounds': IdentityCall<{
12550
- options?: OpenFin.GetBoundsOptions;
12551
- }, OpenFin.WindowBounds>;
12170
+ 'get-window-bounds': IdentityCall<{}, OpenFin.WindowBounds>;
12552
12171
  'center-window': IdentityCall;
12553
12172
  'blur-window': IdentityCall;
12554
12173
  'bring-window-to-front': IdentityCall;
@@ -12728,6 +12347,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
12728
12347
  'get-version': GetterCall<string>;
12729
12348
  'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
12730
12349
  'delete-cache-request': VoidCall;
12350
+ 'dispatch-notification-action': {
12351
+ request: {
12352
+ notificationId: string;
12353
+ action: 'click' | 'close' | 'show';
12354
+ };
12355
+ response: void;
12356
+ };
12731
12357
  'exit-desktop': VoidCall;
12732
12358
  'fetch-manifest': ApiCall<{
12733
12359
  manifestUrl: string;
@@ -12758,9 +12384,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
12758
12384
  response: string;
12759
12385
  };
12760
12386
  'get-focused-window': GetterCall<OpenFin.Identity | null>;
12761
- 'get-focused-content': GetterCall<(OpenFin.Identity & {
12762
- entityType: 'window' | 'view';
12763
- }) | null>;
12764
12387
  'is-app-certified': {
12765
12388
  request: {
12766
12389
  manifestUrl: string;
@@ -12884,22 +12507,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
12884
12507
  options: OpenFin.ProcessLoggingOptions;
12885
12508
  }, void>;
12886
12509
  'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
12887
- 'serve-asset': ApiCall<{
12888
- options: OpenFin.ServeAssetOptions;
12889
- }, OpenFin.ServedAssetInfo>;
12890
12510
  'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
12891
12511
  domainSettings: OpenFin.DefaultDomainSettings;
12892
12512
  }, void>;
12893
12513
  'system-register-shutdown-handler': VoidCall;
12894
12514
  'get-permissions': GetterCall<any>;
12895
- 'refresh-extensions': {
12896
- request: void;
12897
- response: string[] | undefined;
12898
- };
12899
- 'get-installed-extensions': {
12900
- request: void;
12901
- response: OpenFin.ExtensionInfo[];
12902
- };
12903
12515
  'fdc3-add-context-listener': VoidCall;
12904
12516
  'fdc3-add-intent-listener': VoidCall;
12905
12517
  'fdc3-raise-intent': VoidCall;
@@ -13052,10 +12664,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
13052
12664
  };
13053
12665
  response: OpenFin.PopupResult;
13054
12666
  };
13055
- 'get-screen-capture-permissions': {
13056
- request: OpenFin.Identity;
13057
- response: OpenFin.ScreenCapturePermission;
13058
- };
13059
12667
  'render-overlay': {
13060
12668
  request: {
13061
12669
  bounds: OpenFin.Bounds;
@@ -13330,15 +12938,15 @@ declare type ReplaceViewPayload = {
13330
12938
  */
13331
12939
  declare type ResizeRegion = {
13332
12940
  /**
13333
- * The size of the resize region in pixels.
12941
+ * @defaultValue 7
13334
12942
  *
13335
- * @default 7
12943
+ * The size of the resize region in pixels.
13336
12944
  */
13337
12945
  size?: number;
13338
12946
  /**
13339
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
12947
+ * @defaultValue 9
13340
12948
  *
13341
- * @default 9
12949
+ * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13342
12950
  */
13343
12951
  bottomRightCorner?: number;
13344
12952
  /**
@@ -13346,27 +12954,27 @@ declare type ResizeRegion = {
13346
12954
  */
13347
12955
  sides?: {
13348
12956
  /**
13349
- * Enables resizing from the top of the window.
12957
+ * @defaultValue true
13350
12958
  *
13351
- * @default true
12959
+ * Enables resizing from the top of the window.
13352
12960
  */
13353
12961
  top?: boolean;
13354
12962
  /**
13355
- * Enables resizing from the bottom of the window.
12963
+ * @defaultValue true
13356
12964
  *
13357
- * @default true
12965
+ * Enables resizing from the bottom of the window.
13358
12966
  */
13359
12967
  bottom?: boolean;
13360
12968
  /**
13361
- * Enables resizing from the left side of the window.
12969
+ * @defaultValue true
13362
12970
  *
13363
- * @default true
12971
+ * Enables resizing from the left side of the window.
13364
12972
  */
13365
12973
  left?: boolean;
13366
12974
  /**
13367
- * Enables resizing from the right side of the window.
12975
+ * @defaultValue true
13368
12976
  *
13369
- * @default true
12977
+ * Enables resizing from the right side of the window.
13370
12978
  */
13371
12979
  right?: boolean;
13372
12980
  };
@@ -13548,20 +13156,12 @@ declare type RVMInfo = {
13548
13156
  * The app log directory.
13549
13157
  */
13550
13158
  'appLogDirectory': string;
13551
- /**
13552
- * Architecture of the OS that the RVM is running on. One of `arm64`, `x86`, `x64`. Available since RVM 16.
13553
- */
13554
- 'osArch': string;
13555
13159
  /**
13556
13160
  * The path of OpenfinRVM.exe.
13557
13161
  */
13558
13162
  'path': string;
13559
13163
  /**
13560
- * Process architecture of the RVM. One of `arm64`, `x86`, `x64`. Available since RVM 16.
13561
- */
13562
- 'rvmArch': string;
13563
- /**
13564
- * The start time of RVM. Format is `YYYY-MM-DD HH:MM:SS` in local time or `NA` on error.
13164
+ * The start time of RVM.
13565
13165
  */
13566
13166
  'start-time': string;
13567
13167
  /**
@@ -13593,30 +13193,6 @@ declare type RvmLaunchOptions = {
13593
13193
  subscribe?: (launch: LaunchEmitter) => void;
13594
13194
  };
13595
13195
 
13596
- /**
13597
- * Controls whether this content should be allowed or blocked when capturing the screen.
13598
- */
13599
- declare type ScreenCaptureBehavior = 'allow' | 'block';
13600
-
13601
- /**
13602
- * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
13603
- * @interface
13604
- */
13605
- declare type ScreenCapturePermission = {
13606
- permission: ScreenCaptureBehavior;
13607
- permissions: ScreenCaptureState[];
13608
- };
13609
-
13610
- /**
13611
- * screenCapture state for a given entity as defined in domain settings.
13612
- * @interface
13613
- */
13614
- declare type ScreenCaptureState = {
13615
- info: EntityInfo;
13616
- behavior: ScreenCaptureBehavior;
13617
- url: string;
13618
- };
13619
-
13620
13196
  /**
13621
13197
  * @interface
13622
13198
  */
@@ -13624,21 +13200,6 @@ declare type ScreenshotPrintOptions = {
13624
13200
  content: 'screenshot';
13625
13201
  };
13626
13202
 
13627
- /**
13628
- * An event generated when an application modifies the runtime in a way that affects all other applications in the
13629
- * application runtime/security realm.
13630
- */
13631
- declare type SecurityRealmEvent = BaseEvent_9 & {
13632
- /**
13633
- * Config URL of the application that modified the security realm's extensions
13634
- */
13635
- configUrl: string;
13636
- /**
13637
- * Identity of the application that modified the security realm's extensions
13638
- */
13639
- applicationIdentity: OpenFin.ApplicationIdentity;
13640
- };
13641
-
13642
13203
  declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
13643
13204
  data: ProtocolMap[T]['response'];
13644
13205
  } & ProtocolMap[T]['specialResponse']>;
@@ -13655,15 +13216,10 @@ declare type SentMessage<Value> = Promise<Value> & {
13655
13216
  messageId: ReturnType<Environment['getNextMessageId']>;
13656
13217
  };
13657
13218
 
13658
- declare type ServeAssetOptions = AppAssetServeRequest | PathServeRequest;
13659
-
13660
- declare type ServedAssetInfo = {
13661
- baseUrl: string;
13662
- };
13663
-
13664
- declare type ServeRequest = {
13665
- hostName: string;
13666
- };
13219
+ /**
13220
+ * Utility type to mark an image serialized as a base64 data URL.
13221
+ */
13222
+ declare type SerializedImage = string;
13667
13223
 
13668
13224
  /**
13669
13225
  * @interface
@@ -13910,9 +13466,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
13910
13466
  */
13911
13467
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
13912
13468
  /**
13913
- * Number of milliseconds to wait between view repaints.
13469
+ * @defaultValue 0
13914
13470
  *
13915
- * @default 0
13471
+ * Number of milliseconds to wait between view repaints.
13916
13472
  */
13917
13473
  paintIntervalMs?: number;
13918
13474
  };
@@ -13962,7 +13518,6 @@ declare type Snapshot = {
13962
13518
  declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
13963
13519
  topic: 'application';
13964
13520
  type: 'platform-snapshot-applied';
13965
- snapshot: Snapshot;
13966
13521
  };
13967
13522
 
13968
13523
  /**
@@ -14084,32 +13639,6 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
14084
13639
  type: 'started';
14085
13640
  };
14086
13641
 
14087
- /**
14088
- * Behavior when displaying content from matched URLs.
14089
- */
14090
- declare type StructuredContentBehavior = {
14091
- behavior: BaseContentBehavior;
14092
- } | BrowserContentBehavior;
14093
-
14094
- /**
14095
- * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
14096
- * @interface
14097
- */
14098
- declare type StructuredContentPermissions = {
14099
- /**
14100
- * Controls the behavior for navigations
14101
- */
14102
- navigate?: ContentBehavior | StructuredContentBehavior;
14103
- /**
14104
- * Controls the behavior for redirects
14105
- */
14106
- redirect?: ContentBehavior | StructuredContentBehavior;
14107
- /**
14108
- * Controls the behavior for when iframes try to redirect
14109
- */
14110
- iframe?: BaseContentBehavior;
14111
- };
14112
-
14113
13642
  /**
14114
13643
  * @interface
14115
13644
  */
@@ -14128,6 +13657,13 @@ declare type SubscriptionOptions = {
14128
13657
  */
14129
13658
  declare class System extends EmitterBase<OpenFin.SystemEvent> {
14130
13659
  /* Excluded from this release type: __constructor */
13660
+ /**
13661
+ * Dispatch an event to the webcontents that created the notification.
13662
+ * Only works for notifications that have been intercepted in the same runtime.
13663
+ */
13664
+ dispatchNotificationAction(notificationId: string, { action }: {
13665
+ action: 'click' | 'close' | 'show';
13666
+ }): Promise<void>;
14131
13667
  private sendExternalProcessRequest;
14132
13668
  /**
14133
13669
  * Returns the version of the runtime. The version contains the major, minor,
@@ -14306,9 +13842,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
14306
13842
  */
14307
13843
  getEnvironmentVariable(envName: string): Promise<string>;
14308
13844
  /**
14309
- * Get currently focused Window.
14310
- * If a View currently has focus, returns the identity of View's parent Window.
14311
- * Use {@link Window._Window#getFocusedContent Window.getFocusedContent} to directly access currently focused Window or View.
13845
+ * Get current focused window.
14312
13846
  *
14313
13847
  * @example
14314
13848
  * ```js
@@ -14316,17 +13850,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
14316
13850
  * ```
14317
13851
  */
14318
13852
  getFocusedWindow(): Promise<OpenFin.Identity | null>;
14319
- /**
14320
- * Get currently focused content. Returns identity of entity with `entityType`.
14321
- *
14322
- * @example
14323
- * ```js
14324
- * fin.System.getFocusedContent().then(contentIdentity => console.log(contentIdentity)).catch(err => console.log(err));
14325
- * ```
14326
- */
14327
- getFocusedContent(): Promise<(OpenFin.Identity & {
14328
- entityType: 'window' | 'view';
14329
- }) | null>;
14330
13853
  /**
14331
13854
  * Returns information about the given app's certification status
14332
13855
  *
@@ -15580,21 +15103,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
15580
15103
  * ```
15581
15104
  */
15582
15105
  setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
15583
- /**
15584
- * Attempts to install and enable extensions for the security realm. Users may want to call this function in response
15585
- * to an `extensions-install-failed` event. Only extensions allowed by every application on the current security realm
15586
- * will be installed/enabled.
15587
- */
15588
- refreshExtensions(): Promise<string[] | undefined>;
15589
- /**
15590
- * Gets the currently-installed
15591
- */
15592
- getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
15593
- /**
15594
- * Used to serve an asset signed by OpenFin within the given runtime.
15595
- * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
15596
- */
15597
- serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
15598
15106
  }
15599
15107
 
15600
15108
  /**
@@ -15612,6 +15120,7 @@ declare namespace SystemEvents {
15612
15120
  IdleStateChangedEvent,
15613
15121
  IdleEvent,
15614
15122
  MonitorInfoChangedEvent,
15123
+ NotificationCloseRequested,
15615
15124
  MonitorEvent,
15616
15125
  SessionChangedEvent,
15617
15126
  AppVersionEvent,
@@ -15625,14 +15134,6 @@ declare namespace SystemEvents {
15625
15134
  ApplicationCreatedEvent,
15626
15135
  DesktopIconClickedEvent,
15627
15136
  SystemShutdownEvent,
15628
- ExtensionsEnabledEvent,
15629
- ExtensionsDisabledEvent,
15630
- ExtensionsExcludedEvent,
15631
- ExtensionsInstalledEvent,
15632
- ExtensionInstalledEvent,
15633
- ExtensionsInstallFailedEvent,
15634
- ExtensionInstallFailedEvent,
15635
- ExtensionsInitializationFailedEvent,
15636
15137
  Event_11 as Event,
15637
15138
  SystemEvent,
15638
15139
  EventType_8 as EventType,
@@ -15950,9 +15451,9 @@ declare type TransitionBase = {
15950
15451
  */
15951
15452
  duration: number;
15952
15453
  /**
15953
- * Treats 'opacity' as absolute or as a delta. Defaults to false.
15454
+ * @defaultValue false
15954
15455
  *
15955
- * @default false
15456
+ * Treats 'opacity' as absolute or as a delta. Defaults to false.
15956
15457
  */
15957
15458
  relative?: boolean;
15958
15459
  };
@@ -15968,9 +15469,9 @@ declare type TransitionOptions = {
15968
15469
  */
15969
15470
  interrupt: boolean;
15970
15471
  /**
15971
- * Treats 'opacity' as absolute or as a delta. Defaults to false.
15472
+ * @defaultValue false
15972
15473
  *
15973
- * @default false
15474
+ * Treats 'opacity' as absolute or as a delta. Defaults to false.
15974
15475
  */
15975
15476
  relative?: boolean;
15976
15477
  tween?: tween;
@@ -16543,7 +16044,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
16543
16044
  */
16544
16045
  getInfo: () => Promise<OpenFin.ViewInfo>;
16545
16046
  /**
16546
- * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
16047
+ * Retrieves the layout for the window the view is attached to.
16547
16048
  *
16548
16049
  * @example
16549
16050
  * ```js
@@ -16707,24 +16208,6 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
16707
16208
  options?: Partial<ViewOptions>;
16708
16209
  };
16709
16210
 
16710
- /**
16711
- * @interface
16712
- */
16713
- declare type ViewCreationFailure = {
16714
- /**
16715
- * The identity of the created view
16716
- */
16717
- identity: Identity_4;
16718
- /**
16719
- * Whether the view was created with errors
16720
- */
16721
- success: false;
16722
- /**
16723
- * Error thrown during view creation
16724
- */
16725
- error: Error;
16726
- };
16727
-
16728
16211
  /**
16729
16212
  * The options object required by {@link View.ViewModule.create View.create}.
16730
16213
  *
@@ -16740,25 +16223,6 @@ declare type ViewCreationOptions = Partial<ViewOptions> & {
16740
16223
 
16741
16224
  declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
16742
16225
 
16743
- /**
16744
- * A view creation state
16745
- */
16746
- declare type ViewCreationResult = ViewCreationSuccess | ViewCreationFailure;
16747
-
16748
- /**
16749
- * @interface
16750
- */
16751
- declare type ViewCreationSuccess = {
16752
- /**
16753
- * The identity of the created view
16754
- */
16755
- identity: Identity_4;
16756
- /**
16757
- * Whether the view was created without errors
16758
- */
16759
- success: true;
16760
- };
16761
-
16762
16226
  /**
16763
16227
  * Generated when a window has a view detached from it.
16764
16228
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
@@ -16920,9 +16384,6 @@ declare class ViewModule extends Base {
16920
16384
  */
16921
16385
  declare type ViewOptions = ConstViewOptions & MutableViewOptions;
16922
16386
 
16923
- /**
16924
- * @interface
16925
- */
16926
16387
  declare type ViewShowAtOptions = {
16927
16388
  /**
16928
16389
  * Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
@@ -16998,9 +16459,9 @@ declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
16998
16459
  */
16999
16460
  declare type ViewVisibilityOption = {
17000
16461
  /**
17001
- * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
16462
+ * @defaultValue false
17002
16463
  *
17003
- * @default false
16464
+ * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17004
16465
  */
17005
16466
  enabled?: boolean;
17006
16467
  };
@@ -17624,7 +17085,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17624
17085
  * bounds: {top: 10, left: 10, width: 200, height: 200}
17625
17086
  * });
17626
17087
  *
17627
- * await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
17088
+ * await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
17628
17089
  *
17629
17090
  * const sharedWorkers = await view.getSharedWorkers();
17630
17091
  * ```
@@ -17635,7 +17096,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17635
17096
  * name:'child',
17636
17097
  * defaultWidth: 300,
17637
17098
  * defaultHeight: 300,
17638
- * url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
17099
+ * url: 'http://mdn.github.io/simple-shared-worker/index2.html',
17639
17100
  * frame: true,
17640
17101
  * autoShow: true
17641
17102
  * };
@@ -17660,7 +17121,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17660
17121
  * bounds: {top: 10, left: 10, width: 200, height: 200}
17661
17122
  * });
17662
17123
  *
17663
- * await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
17124
+ * await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
17664
17125
  *
17665
17126
  * await view.inspectSharedWorker();
17666
17127
  * ```
@@ -17671,7 +17132,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17671
17132
  * name:'child',
17672
17133
  * defaultWidth: 300,
17673
17134
  * defaultHeight: 300,
17674
- * url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
17135
+ * url: 'http://mdn.github.io/simple-shared-worker/index2.html',
17675
17136
  * frame: true,
17676
17137
  * autoShow: true
17677
17138
  * };
@@ -17697,7 +17158,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17697
17158
  * bounds: {top: 10, left: 10, width: 200, height: 200}
17698
17159
  * });
17699
17160
  *
17700
- * await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
17161
+ * await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
17701
17162
  *
17702
17163
  * const sharedWorkers = await view.getSharedWorkers();
17703
17164
  * await view.inspectSharedWorkerById(sharedWorkers[0].id);
@@ -17709,7 +17170,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17709
17170
  * name:'child',
17710
17171
  * defaultWidth: 300,
17711
17172
  * defaultHeight: 300,
17712
- * url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
17173
+ * url: 'http://mdn.github.io/simple-shared-worker/index2.html',
17713
17174
  * frame: true,
17714
17175
  * autoShow: true
17715
17176
  * };
@@ -17971,19 +17432,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17971
17432
  * {@link OpenFin.WebContentsEvents event namespace}.
17972
17433
  */
17973
17434
  showPopupWindow(options: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
17974
- /**
17975
- *
17976
- * Get the screen capture permission for this content.
17977
- *
17978
- * @example
17979
- * ```js
17980
- * const { permission } = await fin.me.getScreenCapturePermission();
17981
- *
17982
- * console.log(`This content is currently ${permission}ed in screen captures.`);
17983
- *
17984
- * ```
17985
- */
17986
- getScreenCapturePermission(): Promise<OpenFin.ScreenCapturePermission>;
17987
17435
  }
17988
17436
 
17989
17437
  /**
@@ -18022,8 +17470,10 @@ declare namespace WebContentsEvents {
18022
17470
  FileDownloadProgressEvent,
18023
17471
  FileDownloadCompletedEvent,
18024
17472
  ContentBlockedEvent,
18025
- ClipboardCopyBlockedEvent,
18026
- ClipboardPasteBlockedEvent,
17473
+ SerializedImage,
17474
+ NotificationAction_2 as NotificationAction,
17475
+ NotificationData,
17476
+ NotificationInterceptedEvent,
18027
17477
  Event_5 as Event,
18028
17478
  WebContentsEvent,
18029
17479
  WillPropagateWebContentsEvent,
@@ -18193,7 +17643,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18193
17643
  * getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
18194
17644
  * ```
18195
17645
  */
18196
- getBounds(options?: OpenFin.GetBoundsOptions): Promise<OpenFin.WindowBounds>;
17646
+ getBounds(): Promise<OpenFin.WindowBounds>;
18197
17647
  /**
18198
17648
  * Centers the window on its current screen.
18199
17649
  *
@@ -19160,10 +18610,6 @@ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
19160
18610
  declare type WindowBounds = Bounds & {
19161
18611
  bottom: number;
19162
18612
  right: number;
19163
- /**
19164
- * The bounds for the window's web content, excluding any OS border
19165
- */
19166
- content: Bounds;
19167
18613
  };
19168
18614
 
19169
18615
  /**