@openfin/fdc3-api 42.103.4 → 43.100.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/out/fdc3-api.d.ts CHANGED
@@ -136,13 +136,13 @@ declare type ApiSettings = {
136
136
  /**
137
137
  * Inject OpenFin API into cross-origin iframes
138
138
  *
139
- * @default false
139
+ * @defaultValue false
140
140
  */
141
141
  crossOriginInjection?: boolean;
142
142
  /**
143
143
  * Inject OpenFin API into same-origin iframes
144
144
  *
145
- * @default true
145
+ * @defaultValue true
146
146
  */
147
147
  sameOriginInjection?: boolean;
148
148
  /**
@@ -1187,19 +1187,19 @@ declare class ApplicationModule extends Base {
1187
1187
  */
1188
1188
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1189
1189
  /**
1190
- * Disables IAB secure logging for the app.
1190
+ * @defaultValue false
1191
1191
  *
1192
- * @default false
1192
+ * Disables IAB secure logging for the app.
1193
1193
  */
1194
1194
  disableIabSecureLogging: boolean;
1195
1195
  /**
1196
+ * @defaultValue 'There was an error loading the application.'
1197
+ *
1196
1198
  * An error message to display when the application (launched via manifest) fails to load.
1197
1199
  * A dialog box will be launched with the error message just before the runtime exits.
1198
1200
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1199
1201
  * will trigger this dialog.
1200
1202
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1201
- *
1202
- * @default 'There was an error loading the application.'
1203
1203
  */
1204
1204
  loadErrorMessage: string;
1205
1205
  /**
@@ -1218,28 +1218,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1218
1218
  */
1219
1219
  name: string;
1220
1220
  /**
1221
+ * @defaultValue false
1222
+ *
1221
1223
  * A flag to configure the application as non-persistent.
1222
1224
  * Runtime exits when there are no persistent apps running.
1223
- *
1224
- * @default false
1225
1225
  */
1226
1226
  nonPersistent: boolean;
1227
1227
  /**
1228
- * Enable Flash at the application level.
1228
+ * @defaultValue false
1229
1229
  *
1230
- * @default false
1230
+ * Enable Flash at the application level.
1231
1231
  */
1232
1232
  plugins: boolean;
1233
1233
  /**
1234
- * Enable spell check at the application level.
1234
+ * @defaultValue false
1235
1235
  *
1236
- * @default false
1236
+ * Enable spell check at the application level.
1237
1237
  */
1238
1238
  spellCheck: boolean;
1239
1239
  /**
1240
- * The url to the application (specifically the application's main window).
1240
+ * @defaultValue 'about:blank'
1241
1241
  *
1242
- * @default 'about:blank'
1242
+ * The url to the application (specifically the application's main window).
1243
1243
  */
1244
1244
  url: string;
1245
1245
  /**
@@ -1248,9 +1248,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1248
1248
  */
1249
1249
  uuid: string;
1250
1250
  /**
1251
- * When set to `false` it will disable the same-origin policy for the app.
1251
+ * @defaultValue true
1252
1252
  *
1253
- * @default true
1253
+ * When set to `false` it will disable the same-origin policy for the app.
1254
1254
  */
1255
1255
  webSecurity: boolean;
1256
1256
  /**
@@ -1260,10 +1260,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1260
1260
  commands: ShortcutOverride[];
1261
1261
  isPlatformController: boolean;
1262
1262
  /**
1263
+ * @defaultValue 1000
1264
+ *
1263
1265
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1264
1266
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1265
- *
1266
- * @default 1000
1267
1267
  */
1268
1268
  maxViewPoolSize: number;
1269
1269
  /**
@@ -1279,12 +1279,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1279
1279
  */
1280
1280
  snapshot: Snapshot;
1281
1281
  /**
1282
+ * @defaultValue false
1283
+ *
1282
1284
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1283
1285
  *
1284
1286
  * Note: if the Platform Provider is showing, it won't close automatically.
1285
1287
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1286
- *
1287
- * @default false
1288
1288
  */
1289
1289
  preventQuitOnLastWindowClosed: boolean;
1290
1290
  /**
@@ -1292,9 +1292,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1292
1292
  */
1293
1293
  interopBrokerConfiguration: InteropBrokerOptions;
1294
1294
  /**
1295
- * When set to `false` it will disable OpenFin Diagnostics for the app.
1295
+ * @defaultValue true
1296
1296
  *
1297
- * @default true
1297
+ * When set to `false` it will disable OpenFin Diagnostics for the app.
1298
1298
  */
1299
1299
  apiDiagnostics: boolean;
1300
1300
  /**
@@ -1310,16 +1310,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1310
1310
  */
1311
1311
  permissions?: Partial<Permissions_2>;
1312
1312
  /**
1313
+ * @defaultValue false
1314
+ *
1313
1315
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1314
1316
  * Only relevant in Windows.
1315
- *
1316
- * @default false
1317
1317
  */
1318
1318
  enableJumpList: boolean;
1319
1319
  /**
1320
- * When set to `true`, any `beforeunload` handler set on the app will fire.
1320
+ * @defaultValue false
1321
1321
  *
1322
- * @default false
1322
+ * When set to `true`, any `beforeunload` handler set on the app will fire.
1323
1323
  */
1324
1324
  enableBeforeUnload: boolean;
1325
1325
  /**
@@ -1400,25 +1400,25 @@ declare type ApplicationWindowInfo = {
1400
1400
  */
1401
1401
  declare type ApplySnapshotOptions = {
1402
1402
  /**
1403
+ * @defaultValue false
1404
+ *
1403
1405
  * When true, applySnapshot will close existing windows,
1404
1406
  * replacing current Platform state with the given snapshot.
1405
- *
1406
- * @default false
1407
1407
  */
1408
1408
  closeExistingWindows?: boolean;
1409
1409
  /**
1410
+ * @defaultValue false
1411
+ *
1410
1412
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1411
1413
  * replacing current Platform state with the given snapshot.
1412
- *
1413
- * @default false
1414
1414
  */
1415
1415
  closeSnapshotWindows?: boolean;
1416
1416
  /**
1417
+ * @defaultValue false
1418
+ *
1417
1419
  * When true, applySnapshot will not check whether any windows in a
1418
1420
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1419
1421
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1420
- *
1421
- * @default false
1422
1422
  */
1423
1423
  skipOutOfBoundsCheck?: boolean;
1424
1424
  };
@@ -2101,15 +2101,15 @@ declare type CapturePageOptions = {
2101
2101
  */
2102
2102
  area?: Rectangle;
2103
2103
  /**
2104
- * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2104
+ * @defaultValue 'png'
2105
2105
  *
2106
- * @default 'png'
2106
+ * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2107
2107
  */
2108
2108
  format?: 'bmp' | 'jpg' | 'png';
2109
2109
  /**
2110
- * Quality of JPEG image. Between 0 - 100.
2110
+ * @defaultValue 100
2111
2111
  *
2112
- * @default 100
2112
+ * Quality of JPEG image. Between 0 - 100.
2113
2113
  */
2114
2114
  quality?: number;
2115
2115
  };
@@ -2763,9 +2763,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2763
2763
  */
2764
2764
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2765
2765
  /**
2766
- * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2766
+ * @defaultValue true
2767
2767
  *
2768
- * @default true
2768
+ * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2769
2769
  */
2770
2770
  wait?: boolean;
2771
2771
  /**
@@ -3062,10 +3062,6 @@ declare type ChromiumPolicies = {
3062
3062
  * Disable AutofillAddressEnabled policy for a Window or View.
3063
3063
  */
3064
3064
  AutofillAddressEnabled?: PolicyOptions;
3065
- /**
3066
- * Disable AutofillCreditCardEnabled policy for a Window or View.
3067
- */
3068
- AutofillCreditCardEnabled?: PolicyOptions;
3069
3065
  };
3070
3066
 
3071
3067
  declare interface ClassicProtocolOffer extends ProtocolPacketBase {
@@ -3431,9 +3427,9 @@ declare interface CloseWindowPayload {
3431
3427
  windowId: Identity_4;
3432
3428
  options: {
3433
3429
  /**
3434
- * When set to true skips any before handler set on views that are part of the window
3430
+ * @defaultValue false
3435
3431
  *
3436
- * @default false
3432
+ * When set to true skips any before handler set on views that are part of the window
3437
3433
  */
3438
3434
  skipBeforeUnload?: boolean;
3439
3435
  };
@@ -3541,9 +3537,9 @@ declare type ConstViewOptions = {
3541
3537
  */
3542
3538
  name: string;
3543
3539
  /**
3544
- * The URL of the window
3540
+ * @defaultValue "about:blank"
3545
3541
  *
3546
- * @default "about:blank"
3542
+ * The URL of the window
3547
3543
  */
3548
3544
  url: string;
3549
3545
  /**
@@ -3568,15 +3564,6 @@ declare type ConstViewOptions = {
3568
3564
  * Custom headers for requests sent by the view.
3569
3565
  */
3570
3566
  customRequestHeaders: CustomRequestHeaders[];
3571
- /**
3572
- * @experimental
3573
- *
3574
- * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
3575
- * These css properties are used to enable dragging of a frameless window.
3576
- *
3577
- * @default false
3578
- */
3579
- disableAppRegion: boolean;
3580
3567
  /**
3581
3568
  * Initial bounds given relative to the window.
3582
3569
  */
@@ -3613,9 +3600,9 @@ declare type ConstViewOptions = {
3613
3600
  experimental: any;
3614
3601
  fdc3InteropApi?: string;
3615
3602
  /**
3616
- * When set to `true`, any `beforeunload` handler set on Views will fire.
3603
+ * @defaultValue false
3617
3604
  *
3618
- * @default false
3605
+ * When set to `true`, any `beforeunload` handler set on Views will fire.
3619
3606
  */
3620
3607
  enableBeforeUnload: boolean;
3621
3608
  /**
@@ -3656,12 +3643,6 @@ declare type ConstViewOptions = {
3656
3643
  * Control which options to ignore when creating a Platform View.
3657
3644
  */
3658
3645
  excludeOptions: ExcludeOptions;
3659
- /**
3660
- * Determines whether window.open calls from web contents should use the specified target name as provided, or automatically generate a unique name.
3661
- * When true, each call generates a new unique target name, ensuring a new window is always created.
3662
- * When false, the target name passed to window.open is respected.
3663
- */
3664
- ignoreChildFrameName?: boolean;
3665
3646
  };
3666
3647
 
3667
3648
  /**
@@ -3702,12 +3683,13 @@ declare type ConstWindowOptions = {
3702
3683
  */
3703
3684
  backgroundColor: string;
3704
3685
  /**
3686
+ * @defaultValue false
3687
+ *
3705
3688
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3706
3689
  * This also affects the Page Visibility API.
3707
3690
  *
3708
3691
  * When `true`, the page is throttled whether it is hidden or not.
3709
3692
  *
3710
- * @default false
3711
3693
  */
3712
3694
  backgroundThrottling: boolean;
3713
3695
  /**
@@ -3731,30 +3713,21 @@ declare type ConstWindowOptions = {
3731
3713
  */
3732
3714
  customRequestHeaders: CustomRequestHeaders[];
3733
3715
  /**
3716
+ * @defaultValue true
3717
+ *
3734
3718
  * Setting this to false would keep the Window alive even if all its Views were closed.
3735
3719
  * This is meant for advanced users and should be used with caution.
3736
3720
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3737
3721
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3738
3722
  * **NOTE:** - This option is ignored in non-Platforms apps.
3739
- *
3740
- * @default true
3741
3723
  */
3742
3724
  closeOnLastViewRemoved: boolean;
3743
3725
  /**
3744
- * @experimental
3745
- *
3746
- * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
3747
- * These css properties are used to enable dragging of a frameless window.
3726
+ * @defaultValue 'all'
3748
3727
  *
3749
- * @default false
3750
- */
3751
- disableAppRegion: boolean;
3752
- /**
3753
3728
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3754
- * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3729
+ + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3755
3730
  * **NOTE:** - This option is ignored in non-Platforms apps.
3756
- *
3757
- * @default 'all'
3758
3731
  */
3759
3732
  viewsPreventingClose: 'all' | 'layout';
3760
3733
  /**
@@ -3765,31 +3738,31 @@ declare type ConstWindowOptions = {
3765
3738
  */
3766
3739
  defaultCentered: boolean;
3767
3740
  /**
3741
+ * @defaultValue 500
3742
+ *
3768
3743
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3769
3744
  * in favor of the cached value.
3770
- *
3771
- * @default 500
3772
3745
  */
3773
3746
  defaultHeight: number;
3774
3747
  /**
3748
+ * @defaultValue 100
3749
+ *
3775
3750
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3776
3751
  * launches in favor of the cached value.
3777
- *
3778
- * @default 100
3779
3752
  */
3780
3753
  defaultLeft: number;
3781
3754
  /**
3755
+ * @defaultValue 100
3756
+ *
3782
3757
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3783
3758
  * launches in favor of the cached value.
3784
- *
3785
- * @default 100
3786
3759
  */
3787
3760
  defaultTop: number;
3788
3761
  /**
3762
+ * @defaultValue 800
3763
+ *
3789
3764
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3790
3765
  * launches in favor of the cached value.
3791
- *
3792
- * @default 800
3793
3766
  */
3794
3767
  defaultWidth: number;
3795
3768
  /**
@@ -3835,19 +3808,19 @@ declare type ConstWindowOptions = {
3835
3808
  */
3836
3809
  processAffinity: string;
3837
3810
  /**
3811
+ * @defaultValue false
3812
+ *
3838
3813
  * Displays a shadow on frameless windows.
3839
3814
  * `shadow` and `cornerRounding` are mutually exclusive.
3840
3815
  * On Windows 7, Aero theme is required.
3841
- *
3842
- * @default false
3843
3816
  */
3844
3817
  shadow: boolean;
3845
3818
  /**
3819
+ * @defaultValue true
3820
+ *
3846
3821
  * Caches the location of the window.
3847
3822
  *
3848
3823
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3849
- *
3850
- * @default true
3851
3824
  */
3852
3825
  saveWindowState: boolean;
3853
3826
  /**
@@ -3856,22 +3829,22 @@ declare type ConstWindowOptions = {
3856
3829
  */
3857
3830
  ignoreSavedWindowState: boolean;
3858
3831
  /**
3832
+ * @defaultValue false
3833
+ *
3859
3834
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3860
3835
  *
3861
3836
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3862
3837
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3863
- *
3864
- * @default false
3865
3838
  */
3866
3839
  smallWindow: boolean;
3867
3840
  /**
3841
+ * @defaultValue "normal"
3842
+ *
3868
3843
  * The visible state of the window on creation.
3869
3844
  * One of:
3870
3845
  * * `"maximized"`
3871
3846
  * * `"minimized"`
3872
3847
  * * `"normal"`
3873
- *
3874
- * @default "normal"
3875
3848
  */
3876
3849
  state: WindowState;
3877
3850
  /**
@@ -3886,26 +3859,26 @@ declare type ConstWindowOptions = {
3886
3859
  */
3887
3860
  taskbarIconGroup: string;
3888
3861
  /**
3889
- * The URL of the window
3862
+ * @defaultValue "about:blank"
3890
3863
  *
3891
- * @default "about:blank"
3864
+ * The URL of the window
3892
3865
  */
3893
3866
  url: string;
3894
3867
  /**
3868
+ * @defaultValue <application UUID>
3869
+ *
3895
3870
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3896
3871
  * If omitted, defaults to the `uuid` of the application spawning the window.
3897
3872
  * If given, must match the `uuid` of the application spawning the window.
3898
3873
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3899
3874
  * really no need to provide it.
3900
- *
3901
- * @default <application UUID>
3902
3875
  */
3903
3876
  uuid: string;
3904
3877
  /**
3878
+ * @defaultValue false
3879
+ *
3905
3880
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3906
3881
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3907
- *
3908
- * @default false
3909
3882
  */
3910
3883
  waitForPageLoad: boolean;
3911
3884
  width: number;
@@ -3925,16 +3898,6 @@ declare type ConstWindowOptions = {
3925
3898
  * Control which options to ignore when creating a Platform Window.
3926
3899
  */
3927
3900
  excludeOptions: ExcludeOptions;
3928
- /**
3929
- * Controls whether frameless window should have rounded corners. Default is false for Windows and true for MacOS. Setting this property to false will prevent the window from being fullscreenable on macOS. On Windows versions older than Windows 11 Build 22000 this property has no effect, and frameless windows will not have rounded corners.
3930
- */
3931
- roundedCorners: boolean;
3932
- /**
3933
- * Determines whether window.open calls from web contents should use the specified target name as provided, or automatically generate a unique name.
3934
- * When true, each call generates a new unique target name, ensuring a new window is always created.
3935
- * When false, the target name passed to window.open is respected.
3936
- */
3937
- ignoreChildFrameName?: boolean;
3938
3901
  };
3939
3902
 
3940
3903
  /**
@@ -4197,13 +4160,13 @@ declare type CopyBlockedEventReason = 'disabled';
4197
4160
  */
4198
4161
  declare type CopyPermissions = {
4199
4162
  /**
4163
+ * @defaultValue 'allowed'
4164
+ *
4200
4165
  * Controls the behavior for copy operations for a matched URL.
4201
4166
  *
4202
4167
  * allow: Enables all copy operations.
4203
4168
  * block: Disables all copy operations.
4204
4169
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4205
- *
4206
- * @default 'allowed'
4207
4170
  */
4208
4171
  behavior: 'allow' | 'block' | 'protect';
4209
4172
  /**
@@ -4211,9 +4174,9 @@ declare type CopyPermissions = {
4211
4174
  */
4212
4175
  options?: {
4213
4176
  /**
4214
- * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4177
+ * @defaultValue ''
4215
4178
  *
4216
- * @default ''
4179
+ * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4217
4180
  */
4218
4181
  replacementText: string;
4219
4182
  };
@@ -4227,15 +4190,15 @@ declare type CopyPermissions = {
4227
4190
  */
4228
4191
  declare type CornerRounding = {
4229
4192
  /**
4230
- * The height in pixels.
4193
+ * @defaultValue 0
4231
4194
  *
4232
- * @default 0
4195
+ * The height in pixels.
4233
4196
  */
4234
4197
  height: number;
4235
4198
  /**
4236
- * The width in pixels.
4199
+ * @defaultValue 0
4237
4200
  *
4238
- * @default 0
4201
+ * The width in pixels.
4239
4202
  */
4240
4203
  width: number;
4241
4204
  };
@@ -4325,6 +4288,8 @@ declare type CreateLayoutOptions = {
4325
4288
  layoutName: string;
4326
4289
  layout: LayoutOptions;
4327
4290
  /**
4291
+ * @defaultValue 'default'
4292
+ *
4328
4293
  * Controls the View behavior for the given `layout` property. Note
4329
4294
  * that the selected behavior only applies to unnamed Views or
4330
4295
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4346,8 +4311,6 @@ declare type CreateLayoutOptions = {
4346
4311
  * override. Note that during applyLayoutSnapshot, Views are created and
4347
4312
  * attached to the Provider while the Window is being created, so it's
4348
4313
  * important to not 'duplicate' Views in this workflow.
4349
- *
4350
- * @default 'default'
4351
4314
  */
4352
4315
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4353
4316
  };
@@ -4606,7 +4569,7 @@ declare type DomainApiSettings = {
4606
4569
  * * 'none': The `fin` API will be not available.
4607
4570
  * * 'global': The entire `fin` API will be available.
4608
4571
  *
4609
- * @default 'global'
4572
+ * @defaultValue 'global'
4610
4573
  */
4611
4574
  fin?: InjectionType;
4612
4575
  /**
@@ -4646,22 +4609,7 @@ declare type DomainSettings = {
4646
4609
  };
4647
4610
 
4648
4611
  /**
4649
- * Enables or disables specific preload scripts by URL.
4650
- *
4651
- * Uses the script's full URL as the key and an object
4652
- * with an `enabled` boolean property as the value.
4653
- * @example
4654
- * ```js
4655
- * {
4656
- "match": ["<all_urls>"],
4657
- "options": {
4658
- "preloadScripts": {
4659
- "http://localhost:53000/block-preload.js": { "enabled": false }
4660
- "http://localhost:53000/allow-preload.js": { "enabled": true }
4661
- }
4662
- }
4663
- }
4664
- * ```
4612
+ * Map of preload scripts that can enable new scripts or disable options defined preloadScripts.
4665
4613
  */
4666
4614
  declare type DomainSettingsPreloadScripts = Record<string, {
4667
4615
  enabled: boolean;
@@ -4852,11 +4800,20 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
4852
4800
  type: EventType;
4853
4801
  }>, ...args: any[]) => boolean;
4854
4802
  private hasEmitter;
4803
+ /**
4804
+ * Cleans up after removal of a listener, e.g. deleting any lingering deregistration handlers for a
4805
+ * `once` subscription.
4806
+ *
4807
+ * @remarks Implementing this as a `removeListener` handler ensures that direct removal of a listener
4808
+ * on the base emitter will not leak additional core handlers. We could do this in the forwarding method,
4809
+ * which would involve less "magic," but would be more-vulnerable to accidental re-introduction of a leak.
4810
+ */
4811
+ private cleanUpRemovedListener;
4855
4812
  private getOrCreateEmitter;
4856
4813
  listeners: (type: string | symbol) => Function[];
4857
4814
  listenerCount: (type: string | symbol) => number;
4858
4815
  protected registerEventListener: (eventType: EmitterEventType, options: OpenFin.SubscriptionOptions | undefined, applySubscription: (emitter: EventEmitter) => void, undoSubscription: (emitter: EventEmitter) => void) => Promise<void>;
4859
- private deregisterEventListener;
4816
+ protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin.SubscriptionOptions) => Promise<void | EventEmitter>;
4860
4817
  /**
4861
4818
  * Adds a listener to the end of the listeners array for the specified event.
4862
4819
  *
@@ -4892,7 +4849,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
4892
4849
  * @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
4893
4850
  */
4894
4851
  removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
4895
- private deregisterAllListeners;
4852
+ protected deregisterAllListeners(eventType: EmitterEventType): Promise<EventEmitter | void>;
4896
4853
  /**
4897
4854
  * Removes all listeners, or those of the specified event.
4898
4855
  *
@@ -5211,9 +5168,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
5211
5168
  */
5212
5169
  declare type ExcludeOptions = {
5213
5170
  /**
5214
- * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5171
+ * @defaultValue false
5215
5172
  *
5216
- * @default false
5173
+ * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5217
5174
  */
5218
5175
  preloadScripts: boolean;
5219
5176
  };
@@ -5857,7 +5814,7 @@ declare class FDC3ModuleBase<ChannelType extends v1_2.Channel | v2_0.Channel> {
5857
5814
  *
5858
5815
  * @tutorial fdc3.getOrCreateChannel
5859
5816
  */
5860
- protected getOrCreateChannel(channelId: string, fdc3Factory: (contextGroup: OpenFin.SessionContextGroup) => ChannelType): Promise<ChannelType>;
5817
+ getOrCreateChannel(channelId: string): Promise<ChannelType>;
5861
5818
  /**
5862
5819
  * Returns the Interop-Broker-defined context groups available for an entity to join.
5863
5820
  *
@@ -6040,7 +5997,6 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
6040
5997
  readonly Platform: PlatformModule;
6041
5998
  readonly Interop: InteropModule;
6042
5999
  readonly SnapshotSource: SnapshotSourceModule;
6043
- readonly NotificationManager: NotificationManagerModule;
6044
6000
  /**
6045
6001
  * Provides access to the OpenFin representation of the current code context (usually an entity
6046
6002
  * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -6058,34 +6014,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
6058
6014
  */
6059
6015
  declare type FindInPageOptions = {
6060
6016
  /**
6061
- * Searches in the forward direction (backward otherwise)
6017
+ * @defaultValue true
6062
6018
  *
6063
- * @default true
6019
+ * Searches in the forward direction (backward otherwise)
6064
6020
  */
6065
6021
  forward?: boolean;
6066
6022
  /**
6067
- * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
6023
+ * @defaultValue false
6068
6024
  *
6069
- * @default false
6025
+ * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
6070
6026
  */
6071
6027
  findNext?: boolean;
6072
6028
  /**
6073
- * Enables case-sensitive searching.
6029
+ * @defaultValue false
6074
6030
  *
6075
- * @default false
6031
+ * Enables case-sensitive searching.
6076
6032
  */
6077
6033
  matchCase?: boolean;
6078
6034
  /**
6079
- * Only searches from the start of words.
6035
+ * @defaultValue false
6080
6036
  *
6081
- * @default false
6037
+ * Only searches from the start of words.
6082
6038
  */
6083
6039
  wordStart?: boolean;
6084
6040
  /**
6041
+ * @defaultValue false
6042
+ *
6085
6043
  * 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>
6086
6044
  * lowercase or non-letter. Accepts several other intra-word matches.
6087
- *
6088
- * @default false
6089
6045
  */
6090
6046
  medialCapitalAsWordStart?: boolean;
6091
6047
  };
@@ -6599,9 +6555,9 @@ declare type Hotkey = {
6599
6555
  */
6600
6556
  keys: string;
6601
6557
  /**
6602
- * Prevent default key handling before emitting the event.
6558
+ * @defaultValue false
6603
6559
  *
6604
- * @default false
6560
+ * Prevent default key handling before emitting the event.
6605
6561
  */
6606
6562
  preventDefault?: boolean;
6607
6563
  };
@@ -7102,7 +7058,6 @@ declare class InteropBroker extends Base {
7102
7058
  private sessionContextGroupMap;
7103
7059
  private channel;
7104
7060
  private logging;
7105
- private privateChannelProviderMap;
7106
7061
  /**
7107
7062
  * @internal
7108
7063
  */
@@ -9164,95 +9119,79 @@ declare type LayoutOptions = {
9164
9119
  */
9165
9120
  newTabButtonUrl?: string;
9166
9121
  /**
9167
- * When true the splitters will not be draggable and the layout will not resize.
9122
+ * @defaultValue false
9168
9123
  *
9169
- * @default false
9124
+ * When true the splitters will not be draggable and the layout will not resize.
9170
9125
  */
9171
9126
  preventSplitterResize?: boolean;
9172
9127
  /**
9128
+ * @defaultValue false
9129
+ *
9173
9130
  * Whether the popout button will only act on the entire stack,
9174
9131
  * as opposed to only the active tab.
9175
- *
9176
- * @default false
9177
9132
  */
9178
9133
  popoutWholeStack?: boolean;
9179
9134
  /**
9135
+ * @defaultValue false
9136
+ *
9180
9137
  * Limits the area to which tabs can be dragged.
9181
9138
  * If true, the layout container is the only area where tabs can be dropped.
9182
- *
9183
- * @default false
9184
9139
  */
9185
9140
  constrainDragToContainer?: boolean;
9186
9141
  /**
9142
+ * @defaultValue false
9143
+ *
9187
9144
  * Whether to show the popout button on stack header.
9188
9145
  * The button will create a new window with current tab as its content.
9189
9146
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
9190
- *
9191
- * @default false
9192
9147
  */
9193
9148
  showPopoutIcon?: boolean;
9194
9149
  /**
9150
+ * @defaultValue false
9151
+ *
9195
9152
  * Whether to show the maximize button on stack header.
9196
9153
  * The button will maximize the current tab to fill the entire window.
9197
- *
9198
- * @default false
9199
9154
  */
9200
9155
  showMaximiseIcon?: boolean;
9201
9156
  /**
9157
+ * @defaultValue false
9158
+ *
9202
9159
  * Whether to show the close button on stack header
9203
9160
  * (not to be confused with close button on every tab).
9204
- *
9205
- * @default false
9206
9161
  */
9207
9162
  showCloseIcon?: boolean;
9208
9163
  /**
9209
- * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
9164
+ * @defaultValue false
9210
9165
  *
9211
- * @default false
9166
+ * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
9212
9167
  */
9213
9168
  constrainDragToHeaders?: boolean;
9214
9169
  /**
9170
+ * @defaultValue true
9171
+ *
9215
9172
  * Turns tab headers on or off.
9216
9173
  * If false, the layout will be displayed with splitters only.
9217
- *
9218
- * @default true
9219
9174
  */
9220
9175
  hasHeaders?: boolean;
9221
9176
  /**
9177
+ * @defaultValue true
9178
+ *
9222
9179
  * If true, the user can re-arrange the layout by
9223
9180
  * dragging items by their tabs to the desired location.
9224
- *
9225
- * @default true
9226
9181
  */
9227
9182
  reorderEnabled?: boolean;
9228
9183
  /**
9229
- * If true, tabs can't be dragged out of the window.
9184
+ * @defaultValue false
9230
9185
  *
9231
- * @default false
9186
+ * If true, tabs can't be dragged out of the window.
9232
9187
  */
9233
9188
  preventDragOut?: boolean;
9234
9189
  /**
9235
9190
  * @defaultValue=false
9236
9191
  *
9237
9192
  * If true, tabs can't be dragged into the window.
9238
- *
9239
- * @default false
9240
9193
  */
9241
9194
  preventDragIn?: boolean;
9242
- /**
9243
- * When true, will disable placement of tabs that don't fit in the stack into a dropdown menu
9244
- * and the button to open the dropdown menu will never be shown.
9245
- * **CAUTION**: the overflowing tabs may end up being invisible to the user
9246
- * and certain CSS modifications will need to be implemented in order to restore usability.
9247
- * This is an internal property and usage is highly discouraged.
9248
- *
9249
- * Not available in web layouts.
9250
- *
9251
- * @experimental
9252
- * @internal
9253
- * @defaultValue false
9254
- */
9255
- disableTabOverflowDropdown?: boolean;
9256
9195
  };
9257
9196
  /**
9258
9197
  * Content of the layout. There can only be one top-level LayoutItem in the content array.
@@ -9360,111 +9299,21 @@ declare type LogInfo = {
9360
9299
  */
9361
9300
  declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
9362
9301
 
9363
- /**
9364
- * Log types
9365
- *
9366
- * Note: For the debug log options, the one with the most specific matching pattern will be used.
9367
- */
9368
- declare type LogTypes =
9369
- /**
9370
- * Uploads app logs
9371
- */
9372
- 'app'
9373
- /**
9374
- * Uploads rvm logs
9375
- */
9376
- | 'rvm'
9377
- /**
9378
- * Uploads all debug logs
9379
- */
9380
- | 'debug'
9381
- /**
9382
- * Uploads the most current debug log the current application
9383
- */
9384
- | 'debug:self'
9385
- /**
9386
- * Uploads all debug logs for the current application
9387
- */
9388
- | 'debug:self:archive'
9389
- /**
9390
- * Uploads the last two debug logs for the current application
9391
- */
9392
- | 'debug:self:archive:last';
9393
-
9394
- /**
9395
- * Options for the Log Uploader.
9396
- */
9397
- declare type LogUploaderOptions = LogUploadOptions & {
9398
- ui?: LogUploaderUIOptions & {
9399
- /**
9400
- * Whether the Log Uploader UI should be shown.
9401
- * @defaultValue true
9402
- */
9403
- show?: boolean;
9404
- };
9405
- };
9406
-
9407
- /**
9408
- * Options for the Log Uploader UI.
9409
- * @interface
9410
- */
9411
9302
  declare type LogUploaderUIOptions = {
9412
- /**
9413
- * Title for the Log Uploader window.
9414
- * @defaultValue 'Here Log Uploader'
9415
- */
9416
9303
  title?: string;
9417
- /**
9418
- * URL of an icon to use for the Log Uploader tool. The default is the Here logo.
9419
- */
9420
9304
  icon?: string;
9421
- /**
9422
- * Name of the organization displayed in the Uploader window.
9423
- * @defaultValue 'Here'
9424
- */
9425
9305
  header?: string;
9426
- /**
9427
- * An explanation for the user of the purpose of the tool.
9428
- * @defaultValue 'The following logs are being requested'
9429
- */
9430
9306
  description?: string;
9431
- /**
9432
- * An email address that the user can contact with questions.
9433
- * @defaultValue 'support@here.io'
9434
- */
9435
9307
  email?: string;
9436
- /**
9437
- * URL of a webpage where the user can find more information about log uploading.
9438
- * @defaultValue 'https://resources.here.io/docs/core/manage/security/'
9439
- */
9440
9308
  website?: string;
9441
- /**
9442
- * Description of the webpage where the user can find more information.
9443
- * @defaultValue 'Here Security'
9444
- */
9445
9309
  websiteDescription?: string;
9446
9310
  };
9447
9311
 
9448
9312
  declare type LogUploadOptions = {
9449
- /**
9450
- * The URL where log files are to be uploaded.
9451
- */
9452
9313
  endpoint: string;
9453
- /**
9454
- * An array of URL match patterns to define the manifests of the programs that the Log Uploader should upload logs for.
9455
- * @defaultValue []
9456
- */
9457
9314
  manifests?: string[];
9458
- /**
9459
- * An array of strings that specifies which logs should be uploaded.
9460
- * @defaultValue ['app', 'rvm', 'debug']
9461
- */
9462
- logs?: LogTypes[];
9315
+ logs?: string[];
9463
9316
  ui?: LogUploaderUIOptions;
9464
- /**
9465
- * Max file size limit in Megabytes for the logs archive.
9466
- */
9467
- sizeLimit?: number;
9468
9317
  };
9469
9318
 
9470
9319
  /**
@@ -9502,9 +9351,6 @@ declare type Manifest = {
9502
9351
  forceLatest?: boolean;
9503
9352
  futureVersion?: string;
9504
9353
  version: string;
9505
- policies?: {
9506
- CloudAPAuthEnabled?: 'enabled' | 'disabled';
9507
- };
9508
9354
  };
9509
9355
  services?: string[];
9510
9356
  shortcut?: {
@@ -9795,10 +9641,10 @@ declare type MutableViewOptions = {
9795
9641
  /**
9796
9642
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9797
9643
  *
9644
+ * @defaultValue true
9645
+ *
9798
9646
  * Show the context menu when right-clicking on the view.
9799
9647
  * Gives access to the devtools for the view.
9800
- *
9801
- * @default true
9802
9648
  */
9803
9649
  contextMenu: boolean;
9804
9650
  /**
@@ -9845,25 +9691,24 @@ declare type MutableViewOptions = {
9845
9691
  contentNavigation: ContentNavigation;
9846
9692
  contentRedirect: ContentRedirect;
9847
9693
  /**
9694
+ * @defaultValue false
9848
9695
  * @deprecated
9849
9696
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9850
9697
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9851
- *
9852
- * @default false
9853
9698
  */
9854
9699
  detachOnClose: boolean;
9855
9700
  /**
9701
+ * @defaultValue true
9702
+ *
9856
9703
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9857
9704
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9858
9705
  * if the view isn't part of the new layout when running `Layout.replace`.
9859
- *
9860
- * @default true
9861
9706
  */
9862
9707
  isClosable: boolean;
9863
9708
  /**
9864
- * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9709
+ * @defaultValue false
9865
9710
  *
9866
- * @default false
9711
+ * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9867
9712
  */
9868
9713
  preventDragOut: boolean;
9869
9714
  interop?: InteropConfig;
@@ -9875,7 +9720,7 @@ declare type MutableViewOptions = {
9875
9720
  /**
9876
9721
  * {@inheritDoc ViewThrottling}
9877
9722
  *
9878
- * @default 'enabled'
9723
+ * @defaultValue 'enabled'
9879
9724
  */
9880
9725
  throttling: ViewThrottling;
9881
9726
  /**
@@ -9894,7 +9739,7 @@ declare type MutableWindowOptions = {
9894
9739
  * Turns anything of matching RGB value transparent.
9895
9740
  *
9896
9741
  * Caveats:
9897
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9742
+ * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9898
9743
  * * User cannot click-through transparent regions
9899
9744
  * * Not supported on Mac
9900
9745
  * * Windows Aero must be enabled
@@ -9903,25 +9748,25 @@ declare type MutableWindowOptions = {
9903
9748
  */
9904
9749
  alphaMask: RGB;
9905
9750
  /**
9906
- * Always position the window at the top of the window stack.
9751
+ * @defaultValue false
9907
9752
  *
9908
- * @default false
9753
+ * Always position the window at the top of the window stack.
9909
9754
  */
9910
9755
  alwaysOnTop: boolean;
9911
9756
  /**
9757
+ * @defaultValue 0
9758
+ *
9912
9759
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9913
9760
  * an aspect ratio will not be enforced.
9914
- *
9915
- * @default 0
9916
9761
  */
9917
9762
  aspectRatio: number;
9918
9763
  /**
9919
9764
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9920
9765
  *
9766
+ * @defaultValue true
9767
+ *
9921
9768
  * Show the context menu when right-clicking on the window.
9922
9769
  * Gives access to the devtools for the window.
9923
- *
9924
- * @default true
9925
9770
  */
9926
9771
  contextMenu: boolean;
9927
9772
  /**
@@ -9988,19 +9833,15 @@ declare type MutableWindowOptions = {
9988
9833
  */
9989
9834
  customData: any;
9990
9835
  /**
9836
+ * @defaultValue true
9991
9837
  *
9992
9838
  * Show the window's frame.
9993
- *
9994
- * @remarks
9995
- * This property will not be updatable starting runtime version 45.
9996
- *
9997
- * @default true
9998
9839
  */
9999
9840
  frame: boolean;
10000
9841
  /**
10001
- * Hides the window instead of closing it when the close button is pressed.
9842
+ * @defaultValue false
10002
9843
  *
10003
- * @default false
9844
+ * Hides the window instead of closing it when the close button is pressed.
10004
9845
  */
10005
9846
  hideOnClose: boolean;
10006
9847
  /**
@@ -10053,61 +9894,60 @@ declare type MutableWindowOptions = {
10053
9894
  */
10054
9895
  icon: string;
10055
9896
  /**
9897
+ * @defaultValue true
9898
+ *
10056
9899
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
10057
9900
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
10058
- *
10059
- * @default true
10060
9901
  */
10061
9902
  includeInSnapshots: boolean;
10062
9903
  /**
10063
- * The maximum height of a window. Will default to the OS defined value if set to -1.
9904
+ * @defaultValue -1
10064
9905
  *
10065
- * @default -1
9906
+ * The maximum height of a window. Will default to the OS defined value if set to -1.
10066
9907
  */
10067
9908
  maxHeight: number;
10068
9909
  /**
10069
- * Allows the window to be maximized.
9910
+ * @defaultValue true
10070
9911
  *
10071
- * @default true
9912
+ * Allows the window to be maximized.
10072
9913
  */
10073
9914
  maximizable: boolean;
10074
9915
  /**
10075
- * The maximum width of a window. Will default to the OS defined value if set to -1.
9916
+ * @defaultValue -1
10076
9917
  *
10077
- * @default -1
9918
+ * The maximum width of a window. Will default to the OS defined value if set to -1.
10078
9919
  */
10079
9920
  maxWidth: number;
10080
9921
  /**
10081
- * The minimum height of the window.
9922
+ * @defaultValue 0
10082
9923
  *
10083
- * @default 0
9924
+ * The minimum height of the window.
10084
9925
  */
10085
9926
  minHeight: number;
10086
9927
  /**
10087
- * Allows the window to be minimized.
9928
+ * @defaultValue true
10088
9929
  *
10089
- * @default true
9930
+ * Allows the window to be minimized.
10090
9931
  */
10091
9932
  minimizable: boolean;
10092
9933
  /**
10093
- * The minimum width of the window.
9934
+ * @defaultValue true
10094
9935
  *
10095
- * @default true
9936
+ * The minimum width of the window.
10096
9937
  */
10097
9938
  minWidth: number;
10098
9939
  /**
9940
+ * @defaultValue 1
9941
+ *
10099
9942
  * A flag that specifies how transparent the window will be.
10100
9943
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
10101
9944
  * This value is clamped between `0.0` and `1.0`.
10102
- * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
10103
- *
10104
- * @default 1
10105
9945
  */
10106
9946
  opacity: number;
10107
9947
  /**
10108
- * A flag to allow the user to resize the window.
9948
+ * @defaultValue true
10109
9949
  *
10110
- * @default true
9950
+ * A flag to allow the user to resize the window.
10111
9951
  */
10112
9952
  resizable: boolean;
10113
9953
  /**
@@ -10115,22 +9955,16 @@ declare type MutableWindowOptions = {
10115
9955
  */
10116
9956
  resizeRegion: ResizeRegion;
10117
9957
  /**
9958
+ * @defaultValue false
9959
+ *
10118
9960
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
10119
9961
  * This occurs when the window is resizing or a tab is being dragged within the layout.
10120
- *
10121
- * @default false
10122
9962
  */
10123
9963
  showBackgroundImages: boolean;
10124
9964
  /**
10125
- * Shows the window's icon in the taskbar.
10126
- *
10127
- * @remarks
10128
- * In Windows, setting `showTaskbarIcon` to false will cause the window to display on all virtual desktops.
10129
- * In order to prevent this while keeping `showTaskbarIcon` false, pass the identity of the parent via the
10130
- * `modalParentIdentity` (see {@link WindowCreationOptions}). This is useful for popups managed by
10131
- * {@link Window._Window.showPopupWindow}.
9965
+ * @defaultValue true
10132
9966
  *
10133
- * @default true
9967
+ * Shows the window's icon in the taskbar.
10134
9968
  */
10135
9969
  showTaskbarIcon: boolean;
10136
9970
  /**
@@ -10157,7 +9991,7 @@ declare type MutableWindowOptions = {
10157
9991
  /**
10158
9992
  * {@inheritDoc WindowThrottling}
10159
9993
  *
10160
- * @default 'enabled'
9994
+ * @defaultValue 'enabled'
10161
9995
  *
10162
9996
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
10163
9997
  */
@@ -10279,111 +10113,6 @@ declare type NonPropagatedWindowEvent = never;
10279
10113
  */
10280
10114
  declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'close-requested'>;
10281
10115
 
10282
- declare type NotificationEvent = {
10283
- type: 'close' | 'click' | 'show';
10284
- notificationId: string;
10285
- };
10286
-
10287
- declare type NotificationHandler = (notification: WebNotificationInfo) => void;
10288
-
10289
- /**
10290
- * NotificationManagers allow all {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | HTML5 notifications} created in the application to be intercepted and dispatched.
10291
- *
10292
- * Please note, currently Notifications will only be intercepted if the following conditions are met:
10293
- * - The source WebContents has the `notification` webAPI permission.
10294
- * - The source WebContents is not a service worker.
10295
- *
10296
- * Service worker and push notifications are currently not supported.
10297
- *
10298
- * **See also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | Notification API (MDN)}
10299
- *
10300
- * @experimental This API is subject to change in future releases.
10301
- *
10302
- */
10303
- declare class NotificationManagerInstance {
10304
- #private;
10305
- /**
10306
- * @internal
10307
- */
10308
- constructor(wire: Transport, id: string);
10309
- /**
10310
- * Sets the current handler for notifications. The provided function will be invoked whenever a WebContents successfully raises a notification.
10311
- *
10312
- * **Note**, only one handler can be used at a time, calling `setNotificationHandler` will replace any existing registered handler.
10313
- *
10314
- * @param handler The notification handler callback which will be invoked whenever a notification is created.
10315
- *
10316
- * @example
10317
- *
10318
- * ```typescript
10319
- * const notificationManager = await fin.NotificationManager.init();
10320
- * const handler = (notification) => {
10321
- * console.log("Received the following notification", info);
10322
- * }
10323
- * await notificationManager.setNotificationHandler(handler);
10324
- * ```
10325
- */
10326
- setNotificationHandler: (handler: OpenFin.NotificationHandler) => Promise<void>;
10327
- /**
10328
- * Destroys the current NotificationManagerInstance.
10329
- *
10330
- * @example
10331
- * ```typescript
10332
- * await notificationManager.destroy();
10333
- * ```
10334
- */
10335
- destroy: () => Promise<void>;
10336
- /**
10337
- * Dispatches a Notification lifecycle event ('close' | 'click' | 'show').
10338
- *
10339
- * @param event Identifies the type of event to emit, and which `notificationId` to emit it for.
10340
- *
10341
- * @example
10342
- * ```typescript
10343
- * notificationManager.setNotificationHandler((notification) => {
10344
- * await mockNotificationUi.showNotification(notification);
10345
- * await notificationManager.dispatchNotificationEvent({
10346
- * notificationId: notification.notificationId,
10347
- * type: 'show
10348
- * })
10349
- * })
10350
- * ```
10351
- *
10352
- * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/click_event | Notification Click Event (MDN)}
10353
- *
10354
- * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/close_event | Notification Close Event (MDN)}
10355
- *
10356
- * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/show_event | Notification Show Event (MDN)}
10357
- */
10358
- dispatch: (event: OpenFin.NotificationEvent) => Promise<void>;
10359
- }
10360
-
10361
- declare class NotificationManagerModule extends Base {
10362
- /**
10363
- * Initializes a NotificationManager for the current application, which allows interception of HTML5 web notifications.
10364
- *
10365
- * Secured by default, must be called from a WebContents with the NotificationManager.init permission.
10366
- *
10367
- * Only one NotificationManager can be active at a time, calls to `init` will fail otherwise.
10368
- *
10369
- * If a WebContents with the NotificationManager active reloads or is closed, it will be possible to create a new one.
10370
- *
10371
- * @example
10372
- *
10373
- * ```js
10374
- * // From Provider context
10375
- * const notificationManager = await fin.NotificationManager.init();
10376
- * // NotificationManager is now active and will intercept all incoming notifications.
10377
- * ```
10378
- * @experimental
10379
- */
10380
- init: () => Promise<NotificationManagerInstance>;
10381
- }
10382
-
10383
- declare type NotificationManagerPermissions = {
10384
- init: boolean;
10385
- };
10386
-
10387
10116
  /**
10388
10117
  * @internal
10389
10118
  *
@@ -10561,7 +10290,6 @@ declare namespace OpenFin {
10561
10290
  ApplicationPermissions,
10562
10291
  LaunchExternalProcessRule,
10563
10292
  SystemPermissions,
10564
- NotificationManagerPermissions,
10565
10293
  DevicePermissionName,
10566
10294
  WebPermissionName,
10567
10295
  WebPermission,
@@ -10575,9 +10303,7 @@ declare namespace OpenFin {
10575
10303
  PlatformViewCreationOptions,
10576
10304
  ProcessAffinityStrategy,
10577
10305
  PlatformOptions,
10578
- LogUploaderOptions,
10579
10306
  LogUploaderUIOptions,
10580
- LogTypes,
10581
10307
  LogUploadOptions,
10582
10308
  Manifest,
10583
10309
  LayoutContent,
@@ -10693,8 +10419,6 @@ declare namespace OpenFin {
10693
10419
  CopyPermissions,
10694
10420
  PastePermissions,
10695
10421
  ClipboardPermissions,
10696
- PrintPlaceholder,
10697
- PrintPermission,
10698
10422
  DomainSettingsRule,
10699
10423
  FileDownloadBehavior,
10700
10424
  FileDownloadBehaviorNames,
@@ -10802,12 +10526,6 @@ declare namespace OpenFin {
10802
10526
  RoutingInfo,
10803
10527
  DownloadShelfOptions,
10804
10528
  ViewShowAtOptions,
10805
- WebNotificationProperties,
10806
- WebNotificationInfo,
10807
- NotificationEvent,
10808
- NotificationHandler,
10809
- NotificationManagerInstance,
10810
- NotificationManagerModule,
10811
10529
  ExtensionInfo,
10812
10530
  ServeRequest,
10813
10531
  AppAssetServeRequest,
@@ -10895,12 +10613,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10895
10613
  */
10896
10614
  declare type PastePermissions = {
10897
10615
  /**
10616
+ * @defaultValue 'non-protected-content'
10617
+ *
10898
10618
  * Controls the behavior for paste operations for a matched URL.
10899
10619
  *
10900
10620
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10901
10621
  * 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.
10902
- *
10903
- * @default 'non-protected-content'
10904
10622
  */
10905
10623
  behavior: 'non-protected-content' | 'all-content';
10906
10624
  };
@@ -11069,7 +10787,7 @@ declare type PerDomainSettings = {
11069
10787
  * Defaults to 'allow'.
11070
10788
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
11071
10789
  */
11072
- print?: 'allow' | 'block' | PrintPermission;
10790
+ print?: 'allow' | 'block';
11073
10791
  /**
11074
10792
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
11075
10793
  */
@@ -11102,7 +10820,6 @@ declare type Permissions_2 = {
11102
10820
  Clipboard?: Partial<ClipboardApiPermissions>;
11103
10821
  webAPIs?: WebPermission[];
11104
10822
  devices?: DeviceInfo[];
11105
- NotificationManager?: Partial<NotificationManagerPermissions>;
11106
10823
  };
11107
10824
 
11108
10825
  declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -11970,11 +11687,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11970
11687
  */
11971
11688
  providerUrl?: string;
11972
11689
  /**
11690
+ * @defaultValue true
11691
+ *
11973
11692
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11974
11693
  *
11975
11694
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11976
- *
11977
- * @default true
11978
11695
  */
11979
11696
  allowLaunchIntoPlatform?: boolean;
11980
11697
  };
@@ -12667,22 +12384,22 @@ declare type PopupOptions = {
12667
12384
  url?: string;
12668
12385
  /**
12669
12386
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
12670
- * @default 300
12387
+ * @defaultValue 300
12671
12388
  */
12672
12389
  height?: number;
12673
12390
  /**
12674
12391
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
12675
- * @default 300
12392
+ * @defaultValue 300
12676
12393
  */
12677
12394
  width?: number;
12678
12395
  /**
12679
12396
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12680
- * @default 0
12397
+ * @defaultValue 0
12681
12398
  */
12682
12399
  x?: number;
12683
12400
  /**
12684
12401
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12685
- * @default 0
12402
+ * @defaultValue 0
12686
12403
  */
12687
12404
  y?: number;
12688
12405
  /**
@@ -12690,7 +12407,7 @@ declare type PopupOptions = {
12690
12407
  * * 'modal' restricts resizing and positioning in the caller.
12691
12408
  * * 'hide' hides the popup window on blur.
12692
12409
  * * 'close' closes the popup window on blur.
12693
- * @default 'close'
12410
+ * @defaultValue 'close'
12694
12411
  */
12695
12412
  blurBehavior?: PopupBlurBehavior;
12696
12413
  /**
@@ -12698,19 +12415,19 @@ declare type PopupOptions = {
12698
12415
  * * 'none' will do nothing.
12699
12416
  * * 'hide' hides the popup window on `dispatchPopupResult`.
12700
12417
  * * 'close' closes the popup window on `dispatchPopupResult`.
12701
- * @default 'close'
12418
+ * @defaultValue 'close'
12702
12419
  */
12703
12420
  resultDispatchBehavior?: PopupResultBehavior;
12704
12421
  /**
12705
12422
  * Hide the popup window instead of closing when `close` is called on it.
12706
12423
  *
12707
12424
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
12708
- * @default false
12425
+ * @defaultValue false
12709
12426
  */
12710
12427
  hideOnClose?: boolean;
12711
12428
  /**
12712
12429
  * Determines if the popup window should or should not be focused when it is shown.
12713
- * @default true
12430
+ * @defaultValue true
12714
12431
  */
12715
12432
  focus?: boolean;
12716
12433
  /**
@@ -12804,9 +12521,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12804
12521
  */
12805
12522
  declare type PreloadScript = {
12806
12523
  /**
12807
- * Fail to load the window if this preload script fails
12524
+ * @defaultValue false
12808
12525
  *
12809
- * @default false
12526
+ * Fail to load the window if this preload script fails
12810
12527
  */
12811
12528
  mandatory?: boolean;
12812
12529
  /**
@@ -12898,15 +12615,15 @@ declare type PrinterInfo = {
12898
12615
  declare type PrintOptions = {
12899
12616
  content?: 'self';
12900
12617
  /**
12901
- * Disables prompting the user for print settings.
12618
+ * @defaultValue false
12902
12619
  *
12903
- * @default false
12620
+ * Disables prompting the user for print settings.
12904
12621
  */
12905
12622
  silent?: boolean;
12906
12623
  /**
12907
- * Includes the webpage background color and image when printing.
12624
+ * @defaultValue false
12908
12625
  *
12909
- * @default false
12626
+ * Includes the webpage background color and image when printing.
12910
12627
  */
12911
12628
  printBackground?: boolean;
12912
12629
  /**
@@ -12914,9 +12631,9 @@ declare type PrintOptions = {
12914
12631
  */
12915
12632
  deviceName?: string;
12916
12633
  /**
12917
- * Prints in full color (greyscale otherwise).
12634
+ * @defaultValue true
12918
12635
  *
12919
- * @default true
12636
+ * Prints in full color (greyscale otherwise).
12920
12637
  */
12921
12638
  color?: boolean;
12922
12639
  /**
@@ -12924,9 +12641,9 @@ declare type PrintOptions = {
12924
12641
  */
12925
12642
  margins?: Margins;
12926
12643
  /**
12927
- * Prints in landscape mode (portrait otherwise).
12644
+ * @defaultValue true
12928
12645
  *
12929
- * @default true
12646
+ * Prints in landscape mode (portrait otherwise).
12930
12647
  */
12931
12648
  landscape?: boolean;
12932
12649
  /**
@@ -12959,53 +12676,6 @@ declare type PrintOptions = {
12959
12676
  dpi?: Dpi;
12960
12677
  };
12961
12678
 
12962
- /**
12963
- * Control print operations for a matched URL.
12964
- * @interface
12965
- */
12966
- declare type PrintPermission = {
12967
- /**
12968
- * Controls the behavior for print operations for a matched URL.
12969
- *
12970
- * allow: Enables all print operations.
12971
- * block: Disables all print operations.
12972
- *
12973
- * @defaultValue 'allowed'
12974
- */
12975
- behavior: 'allow' | 'block';
12976
- /**
12977
- * Additional placeholder options. When setting behavior = 'block' , then this will be used to draw placeholder.
12978
- */
12979
- placeholder?: PrintPlaceholder;
12980
- };
12981
-
12982
- declare type PrintPlaceholder = {
12983
- /**
12984
- * This color will be background color for placeholder.
12985
- *
12986
- * @defaultValue '#FFFFFFFF'
12987
- */
12988
- backgroundColor?: string;
12989
- /**
12990
- * This string will be visible on placeholder instead of the original content.
12991
- *
12992
- * @defaultValue 'Content is print restricted'
12993
- */
12994
- text?: string;
12995
- /**
12996
- * This color will be text color for placeholder.
12997
- *
12998
- * @defaultValue '#FF000000'
12999
- */
13000
- textColor?: string;
13001
- /**
13002
- * This font type will be font for placeholder.
13003
- *
13004
- * @defaultValue Default system font.
13005
- */
13006
- textFontType?: string;
13007
- };
13008
-
13009
12679
  /**
13010
12680
  * Strategy to assign views to process affinity by domain.
13011
12681
  *
@@ -13401,10 +13071,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
13401
13071
  transitions: OpenFin.Transition;
13402
13072
  options: OpenFin.TransitionOptions;
13403
13073
  }>;
13404
- 'activate-window-and-focus': ApiCall<{
13405
- winIdentity: OpenFin.Identity;
13406
- focusIdentity: OpenFin.Identity;
13407
- }, boolean>;
13408
13074
  'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
13409
13075
  'get-window-bounds': IdentityCall<{
13410
13076
  options?: OpenFin.GetBoundsOptions;
@@ -13660,13 +13326,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
13660
13326
  apiPath: '.getOSInfo';
13661
13327
  namespace: 'System';
13662
13328
  };
13663
- 'launch-log-uploader': ApiCall<{
13664
- options: OpenFin.LogUploaderOptions;
13665
- }, void> & {
13666
- secure: true;
13667
- apiPath: '.launchLogUploader';
13668
- namespace: 'System';
13669
- };
13670
13329
  'launch-external-process': ApiCall<OpenFin.ExternalProcessRequestType, OpenFin.Identity> & {
13671
13330
  secure: true;
13672
13331
  apiPath: '.launchExternalProcess';
@@ -14034,28 +13693,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
14034
13693
  };
14035
13694
  response: void;
14036
13695
  };
14037
- 'dispatch-notification-event': {
14038
- request: {
14039
- notificationId: string;
14040
- type: 'close' | 'show' | 'click';
14041
- };
14042
- response: void;
14043
- };
14044
- 'init-notification-manager': {
14045
- request: {};
14046
- response: {
14047
- managerId: string;
14048
- };
14049
- apiPath: '.init';
14050
- secure: true;
14051
- namespace: 'NotificationManager';
14052
- };
14053
- 'destroy-notification-manager': {
14054
- request: {
14055
- managerId: string;
14056
- };
14057
- response: void;
14058
- };
14059
13696
  };
14060
13697
 
14061
13698
  declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
@@ -14303,15 +13940,15 @@ declare type ReplaceViewPayload = {
14303
13940
  */
14304
13941
  declare type ResizeRegion = {
14305
13942
  /**
14306
- * The size of the resize region in pixels.
13943
+ * @defaultValue 7
14307
13944
  *
14308
- * @default 7
13945
+ * The size of the resize region in pixels.
14309
13946
  */
14310
13947
  size?: number;
14311
13948
  /**
14312
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13949
+ * @defaultValue 9
14313
13950
  *
14314
- * @default 9
13951
+ * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
14315
13952
  */
14316
13953
  bottomRightCorner?: number;
14317
13954
  /**
@@ -14319,27 +13956,27 @@ declare type ResizeRegion = {
14319
13956
  */
14320
13957
  sides?: {
14321
13958
  /**
14322
- * Enables resizing from the top of the window.
13959
+ * @defaultValue true
14323
13960
  *
14324
- * @default true
13961
+ * Enables resizing from the top of the window.
14325
13962
  */
14326
13963
  top?: boolean;
14327
13964
  /**
14328
- * Enables resizing from the bottom of the window.
13965
+ * @defaultValue true
14329
13966
  *
14330
- * @default true
13967
+ * Enables resizing from the bottom of the window.
14331
13968
  */
14332
13969
  bottom?: boolean;
14333
13970
  /**
14334
- * Enables resizing from the left side of the window.
13971
+ * @defaultValue true
14335
13972
  *
14336
- * @default true
13973
+ * Enables resizing from the left side of the window.
14337
13974
  */
14338
13975
  left?: boolean;
14339
13976
  /**
14340
- * Enables resizing from the right side of the window.
13977
+ * @defaultValue true
14341
13978
  *
14342
- * @default true
13979
+ * Enables resizing from the right side of the window.
14343
13980
  */
14344
13981
  right?: boolean;
14345
13982
  };
@@ -14893,9 +14530,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
14893
14530
  */
14894
14531
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
14895
14532
  /**
14896
- * Number of milliseconds to wait between view repaints.
14533
+ * @defaultValue 0
14897
14534
  *
14898
- * @default 0
14535
+ * Number of milliseconds to wait between view repaints.
14899
14536
  */
14900
14537
  paintIntervalMs?: number;
14901
14538
  };
@@ -16586,11 +16223,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
16586
16223
  * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
16587
16224
  */
16588
16225
  serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
16589
- /**
16590
- * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
16591
- * @experimental
16592
- */
16593
- launchLogUploader(options: OpenFin.LogUploaderOptions): Promise<void>;
16594
16226
  }
16595
16227
 
16596
16228
  /**
@@ -16691,7 +16323,6 @@ declare type SystemPermissions = {
16691
16323
  downloadAsset: boolean;
16692
16324
  serveAsset: boolean;
16693
16325
  enableNativeWindowIntegrationProvider: boolean;
16694
- launchLogUploader: boolean;
16695
16326
  };
16696
16327
 
16697
16328
  /**
@@ -16961,9 +16592,9 @@ declare type TransitionBase = {
16961
16592
  */
16962
16593
  duration: number;
16963
16594
  /**
16964
- * Treats 'opacity' as absolute or as a delta. Defaults to false.
16595
+ * @defaultValue false
16965
16596
  *
16966
- * @default false
16597
+ * Treats 'opacity' as absolute or as a delta. Defaults to false.
16967
16598
  */
16968
16599
  relative?: boolean;
16969
16600
  };
@@ -16979,9 +16610,9 @@ declare type TransitionOptions = {
16979
16610
  */
16980
16611
  interrupt: boolean;
16981
16612
  /**
16982
- * Treats 'opacity' as absolute or as a delta. Defaults to false.
16613
+ * @defaultValue false
16983
16614
  *
16984
- * @default false
16615
+ * Treats 'opacity' as absolute or as a delta. Defaults to false.
16985
16616
  */
16986
16617
  relative?: boolean;
16987
16618
  tween?: tween;
@@ -18052,9 +17683,9 @@ declare type ViewTitlePriority = 'document' | 'options';
18052
17683
  */
18053
17684
  declare type ViewVisibilityOption = {
18054
17685
  /**
18055
- * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17686
+ * @defaultValue false
18056
17687
  *
18057
- * @default false
17688
+ * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
18058
17689
  */
18059
17690
  enabled?: boolean;
18060
17691
  };
@@ -19086,19 +18717,6 @@ declare namespace WebContentsEvents {
19086
18717
  }
19087
18718
  }
19088
18719
 
19089
- declare type WebNotificationInfo = {
19090
- notificationId: string;
19091
- properties: WebNotificationProperties;
19092
- url: string;
19093
- images: {
19094
- icon?: string;
19095
- badge?: string;
19096
- image?: string;
19097
- };
19098
- };
19099
-
19100
- declare type WebNotificationProperties = Pick<Notification, 'tag' | 'body' | 'data' | 'dir' | 'icon' | 'lang' | 'title'>;
19101
-
19102
18720
  /**
19103
18721
  * Defines the type of requested web APIs permission.
19104
18722
  *
@@ -19244,30 +18862,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19244
18862
  * ```
19245
18863
  */
19246
18864
  getAllFrames(): Promise<Array<OpenFin.FrameInfo>>;
19247
- /**
19248
- * Activates the current window and focuses the child entity if it exists. If this does
19249
- * not succeed - say the child does not belong to this window, or the identity does not exist -
19250
- * it will return false.
19251
- *
19252
- * @example
19253
- * ```js
19254
- * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
19255
- *
19256
- * win.getCurrentViews()
19257
- * .then(([view1]) => {
19258
- * return win.activateAndFocus(view1.identity);
19259
- * })
19260
- * .then(success => {
19261
- * if (success) {
19262
- * console.log('Window activated and child focused');
19263
- * } else {
19264
- * console.log('Window activation failed, focus state unchanged');
19265
- * }
19266
- * })
19267
- * .catch(console.error);
19268
- * ```
19269
- */
19270
- activateAndFocus(childIdentityToFocus: OpenFin.Identity): Promise<boolean>;
19271
18865
  /**
19272
18866
  * Gets the current bounds (top, bottom, right, left, width, height) of the window.
19273
18867
  *