@openfin/fdc3-api 42.103.4 → 43.100.3

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.
@@ -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
  /**
@@ -1181,19 +1181,19 @@ declare class ApplicationModule extends Base {
1181
1181
  */
1182
1182
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1183
1183
  /**
1184
- * Disables IAB secure logging for the app.
1184
+ * @defaultValue false
1185
1185
  *
1186
- * @default false
1186
+ * Disables IAB secure logging for the app.
1187
1187
  */
1188
1188
  disableIabSecureLogging: boolean;
1189
1189
  /**
1190
+ * @defaultValue 'There was an error loading the application.'
1191
+ *
1190
1192
  * An error message to display when the application (launched via manifest) fails to load.
1191
1193
  * A dialog box will be launched with the error message just before the runtime exits.
1192
1194
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1193
1195
  * will trigger this dialog.
1194
1196
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1195
- *
1196
- * @default 'There was an error loading the application.'
1197
1197
  */
1198
1198
  loadErrorMessage: string;
1199
1199
  /**
@@ -1212,28 +1212,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1212
1212
  */
1213
1213
  name: string;
1214
1214
  /**
1215
+ * @defaultValue false
1216
+ *
1215
1217
  * A flag to configure the application as non-persistent.
1216
1218
  * Runtime exits when there are no persistent apps running.
1217
- *
1218
- * @default false
1219
1219
  */
1220
1220
  nonPersistent: boolean;
1221
1221
  /**
1222
- * Enable Flash at the application level.
1222
+ * @defaultValue false
1223
1223
  *
1224
- * @default false
1224
+ * Enable Flash at the application level.
1225
1225
  */
1226
1226
  plugins: boolean;
1227
1227
  /**
1228
- * Enable spell check at the application level.
1228
+ * @defaultValue false
1229
1229
  *
1230
- * @default false
1230
+ * Enable spell check at the application level.
1231
1231
  */
1232
1232
  spellCheck: boolean;
1233
1233
  /**
1234
- * The url to the application (specifically the application's main window).
1234
+ * @defaultValue 'about:blank'
1235
1235
  *
1236
- * @default 'about:blank'
1236
+ * The url to the application (specifically the application's main window).
1237
1237
  */
1238
1238
  url: string;
1239
1239
  /**
@@ -1242,9 +1242,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1242
1242
  */
1243
1243
  uuid: string;
1244
1244
  /**
1245
- * When set to `false` it will disable the same-origin policy for the app.
1245
+ * @defaultValue true
1246
1246
  *
1247
- * @default true
1247
+ * When set to `false` it will disable the same-origin policy for the app.
1248
1248
  */
1249
1249
  webSecurity: boolean;
1250
1250
  /**
@@ -1254,10 +1254,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1254
1254
  commands: ShortcutOverride[];
1255
1255
  isPlatformController: boolean;
1256
1256
  /**
1257
+ * @defaultValue 1000
1258
+ *
1257
1259
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1258
1260
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1259
- *
1260
- * @default 1000
1261
1261
  */
1262
1262
  maxViewPoolSize: number;
1263
1263
  /**
@@ -1273,12 +1273,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1273
1273
  */
1274
1274
  snapshot: Snapshot;
1275
1275
  /**
1276
+ * @defaultValue false
1277
+ *
1276
1278
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1277
1279
  *
1278
1280
  * Note: if the Platform Provider is showing, it won't close automatically.
1279
1281
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1280
- *
1281
- * @default false
1282
1282
  */
1283
1283
  preventQuitOnLastWindowClosed: boolean;
1284
1284
  /**
@@ -1286,9 +1286,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1286
1286
  */
1287
1287
  interopBrokerConfiguration: InteropBrokerOptions;
1288
1288
  /**
1289
- * When set to `false` it will disable OpenFin Diagnostics for the app.
1289
+ * @defaultValue true
1290
1290
  *
1291
- * @default true
1291
+ * When set to `false` it will disable OpenFin Diagnostics for the app.
1292
1292
  */
1293
1293
  apiDiagnostics: boolean;
1294
1294
  /**
@@ -1304,16 +1304,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1304
1304
  */
1305
1305
  permissions?: Partial<Permissions_2>;
1306
1306
  /**
1307
+ * @defaultValue false
1308
+ *
1307
1309
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1308
1310
  * Only relevant in Windows.
1309
- *
1310
- * @default false
1311
1311
  */
1312
1312
  enableJumpList: boolean;
1313
1313
  /**
1314
- * When set to `true`, any `beforeunload` handler set on the app will fire.
1314
+ * @defaultValue false
1315
1315
  *
1316
- * @default false
1316
+ * When set to `true`, any `beforeunload` handler set on the app will fire.
1317
1317
  */
1318
1318
  enableBeforeUnload: boolean;
1319
1319
  /**
@@ -1394,25 +1394,25 @@ declare type ApplicationWindowInfo = {
1394
1394
  */
1395
1395
  declare type ApplySnapshotOptions = {
1396
1396
  /**
1397
+ * @defaultValue false
1398
+ *
1397
1399
  * When true, applySnapshot will close existing windows,
1398
1400
  * replacing current Platform state with the given snapshot.
1399
- *
1400
- * @default false
1401
1401
  */
1402
1402
  closeExistingWindows?: boolean;
1403
1403
  /**
1404
+ * @defaultValue false
1405
+ *
1404
1406
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1405
1407
  * replacing current Platform state with the given snapshot.
1406
- *
1407
- * @default false
1408
1408
  */
1409
1409
  closeSnapshotWindows?: boolean;
1410
1410
  /**
1411
+ * @defaultValue false
1412
+ *
1411
1413
  * When true, applySnapshot will not check whether any windows in a
1412
1414
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1413
1415
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1414
- *
1415
- * @default false
1416
1416
  */
1417
1417
  skipOutOfBoundsCheck?: boolean;
1418
1418
  };
@@ -2069,15 +2069,15 @@ declare type CapturePageOptions = {
2069
2069
  */
2070
2070
  area?: Rectangle;
2071
2071
  /**
2072
- * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2072
+ * @defaultValue 'png'
2073
2073
  *
2074
- * @default 'png'
2074
+ * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2075
2075
  */
2076
2076
  format?: 'bmp' | 'jpg' | 'png';
2077
2077
  /**
2078
- * Quality of JPEG image. Between 0 - 100.
2078
+ * @defaultValue 100
2079
2079
  *
2080
- * @default 100
2080
+ * Quality of JPEG image. Between 0 - 100.
2081
2081
  */
2082
2082
  quality?: number;
2083
2083
  };
@@ -2710,9 +2710,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2710
2710
  */
2711
2711
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2712
2712
  /**
2713
- * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2713
+ * @defaultValue true
2714
2714
  *
2715
- * @default true
2715
+ * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2716
2716
  */
2717
2717
  wait?: boolean;
2718
2718
  /**
@@ -3006,10 +3006,6 @@ declare type ChromiumPolicies = {
3006
3006
  * Disable AutofillAddressEnabled policy for a Window or View.
3007
3007
  */
3008
3008
  AutofillAddressEnabled?: PolicyOptions;
3009
- /**
3010
- * Disable AutofillCreditCardEnabled policy for a Window or View.
3011
- */
3012
- AutofillCreditCardEnabled?: PolicyOptions;
3013
3009
  };
3014
3010
 
3015
3011
  declare interface ClassicProtocolOffer extends ProtocolPacketBase {
@@ -3375,9 +3371,9 @@ declare interface CloseWindowPayload {
3375
3371
  windowId: Identity_4;
3376
3372
  options: {
3377
3373
  /**
3378
- * When set to true skips any before handler set on views that are part of the window
3374
+ * @defaultValue false
3379
3375
  *
3380
- * @default false
3376
+ * When set to true skips any before handler set on views that are part of the window
3381
3377
  */
3382
3378
  skipBeforeUnload?: boolean;
3383
3379
  };
@@ -3482,9 +3478,9 @@ declare type ConstViewOptions = {
3482
3478
  */
3483
3479
  name: string;
3484
3480
  /**
3485
- * The URL of the window
3481
+ * @defaultValue "about:blank"
3486
3482
  *
3487
- * @default "about:blank"
3483
+ * The URL of the window
3488
3484
  */
3489
3485
  url: string;
3490
3486
  /**
@@ -3509,15 +3505,6 @@ declare type ConstViewOptions = {
3509
3505
  * Custom headers for requests sent by the view.
3510
3506
  */
3511
3507
  customRequestHeaders: CustomRequestHeaders[];
3512
- /**
3513
- * @experimental
3514
- *
3515
- * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
3516
- * These css properties are used to enable dragging of a frameless window.
3517
- *
3518
- * @default false
3519
- */
3520
- disableAppRegion: boolean;
3521
3508
  /**
3522
3509
  * Initial bounds given relative to the window.
3523
3510
  */
@@ -3554,9 +3541,9 @@ declare type ConstViewOptions = {
3554
3541
  experimental: any;
3555
3542
  fdc3InteropApi?: string;
3556
3543
  /**
3557
- * When set to `true`, any `beforeunload` handler set on Views will fire.
3544
+ * @defaultValue false
3558
3545
  *
3559
- * @default false
3546
+ * When set to `true`, any `beforeunload` handler set on Views will fire.
3560
3547
  */
3561
3548
  enableBeforeUnload: boolean;
3562
3549
  /**
@@ -3597,12 +3584,6 @@ declare type ConstViewOptions = {
3597
3584
  * Control which options to ignore when creating a Platform View.
3598
3585
  */
3599
3586
  excludeOptions: ExcludeOptions;
3600
- /**
3601
- * Determines whether window.open calls from web contents should use the specified target name as provided, or automatically generate a unique name.
3602
- * When true, each call generates a new unique target name, ensuring a new window is always created.
3603
- * When false, the target name passed to window.open is respected.
3604
- */
3605
- ignoreChildFrameName?: boolean;
3606
3587
  };
3607
3588
 
3608
3589
  /**
@@ -3643,12 +3624,13 @@ declare type ConstWindowOptions = {
3643
3624
  */
3644
3625
  backgroundColor: string;
3645
3626
  /**
3627
+ * @defaultValue false
3628
+ *
3646
3629
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3647
3630
  * This also affects the Page Visibility API.
3648
3631
  *
3649
3632
  * When `true`, the page is throttled whether it is hidden or not.
3650
3633
  *
3651
- * @default false
3652
3634
  */
3653
3635
  backgroundThrottling: boolean;
3654
3636
  /**
@@ -3672,30 +3654,21 @@ declare type ConstWindowOptions = {
3672
3654
  */
3673
3655
  customRequestHeaders: CustomRequestHeaders[];
3674
3656
  /**
3657
+ * @defaultValue true
3658
+ *
3675
3659
  * Setting this to false would keep the Window alive even if all its Views were closed.
3676
3660
  * This is meant for advanced users and should be used with caution.
3677
3661
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3678
3662
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3679
3663
  * **NOTE:** - This option is ignored in non-Platforms apps.
3680
- *
3681
- * @default true
3682
3664
  */
3683
3665
  closeOnLastViewRemoved: boolean;
3684
3666
  /**
3685
- * @experimental
3686
- *
3687
- * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
3688
- * These css properties are used to enable dragging of a frameless window.
3667
+ * @defaultValue 'all'
3689
3668
  *
3690
- * @default false
3691
- */
3692
- disableAppRegion: boolean;
3693
- /**
3694
3669
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3695
- * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3670
+ + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3696
3671
  * **NOTE:** - This option is ignored in non-Platforms apps.
3697
- *
3698
- * @default 'all'
3699
3672
  */
3700
3673
  viewsPreventingClose: 'all' | 'layout';
3701
3674
  /**
@@ -3706,31 +3679,31 @@ declare type ConstWindowOptions = {
3706
3679
  */
3707
3680
  defaultCentered: boolean;
3708
3681
  /**
3682
+ * @defaultValue 500
3683
+ *
3709
3684
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3710
3685
  * in favor of the cached value.
3711
- *
3712
- * @default 500
3713
3686
  */
3714
3687
  defaultHeight: number;
3715
3688
  /**
3689
+ * @defaultValue 100
3690
+ *
3716
3691
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3717
3692
  * launches in favor of the cached value.
3718
- *
3719
- * @default 100
3720
3693
  */
3721
3694
  defaultLeft: number;
3722
3695
  /**
3696
+ * @defaultValue 100
3697
+ *
3723
3698
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3724
3699
  * launches in favor of the cached value.
3725
- *
3726
- * @default 100
3727
3700
  */
3728
3701
  defaultTop: number;
3729
3702
  /**
3703
+ * @defaultValue 800
3704
+ *
3730
3705
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3731
3706
  * launches in favor of the cached value.
3732
- *
3733
- * @default 800
3734
3707
  */
3735
3708
  defaultWidth: number;
3736
3709
  /**
@@ -3776,19 +3749,19 @@ declare type ConstWindowOptions = {
3776
3749
  */
3777
3750
  processAffinity: string;
3778
3751
  /**
3752
+ * @defaultValue false
3753
+ *
3779
3754
  * Displays a shadow on frameless windows.
3780
3755
  * `shadow` and `cornerRounding` are mutually exclusive.
3781
3756
  * On Windows 7, Aero theme is required.
3782
- *
3783
- * @default false
3784
3757
  */
3785
3758
  shadow: boolean;
3786
3759
  /**
3760
+ * @defaultValue true
3761
+ *
3787
3762
  * Caches the location of the window.
3788
3763
  *
3789
3764
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3790
- *
3791
- * @default true
3792
3765
  */
3793
3766
  saveWindowState: boolean;
3794
3767
  /**
@@ -3797,22 +3770,22 @@ declare type ConstWindowOptions = {
3797
3770
  */
3798
3771
  ignoreSavedWindowState: boolean;
3799
3772
  /**
3773
+ * @defaultValue false
3774
+ *
3800
3775
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3801
3776
  *
3802
3777
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3803
3778
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3804
- *
3805
- * @default false
3806
3779
  */
3807
3780
  smallWindow: boolean;
3808
3781
  /**
3782
+ * @defaultValue "normal"
3783
+ *
3809
3784
  * The visible state of the window on creation.
3810
3785
  * One of:
3811
3786
  * * `"maximized"`
3812
3787
  * * `"minimized"`
3813
3788
  * * `"normal"`
3814
- *
3815
- * @default "normal"
3816
3789
  */
3817
3790
  state: WindowState;
3818
3791
  /**
@@ -3827,26 +3800,26 @@ declare type ConstWindowOptions = {
3827
3800
  */
3828
3801
  taskbarIconGroup: string;
3829
3802
  /**
3830
- * The URL of the window
3803
+ * @defaultValue "about:blank"
3831
3804
  *
3832
- * @default "about:blank"
3805
+ * The URL of the window
3833
3806
  */
3834
3807
  url: string;
3835
3808
  /**
3809
+ * @defaultValue <application UUID>
3810
+ *
3836
3811
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3837
3812
  * If omitted, defaults to the `uuid` of the application spawning the window.
3838
3813
  * If given, must match the `uuid` of the application spawning the window.
3839
3814
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3840
3815
  * really no need to provide it.
3841
- *
3842
- * @default <application UUID>
3843
3816
  */
3844
3817
  uuid: string;
3845
3818
  /**
3819
+ * @defaultValue false
3820
+ *
3846
3821
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3847
3822
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3848
- *
3849
- * @default false
3850
3823
  */
3851
3824
  waitForPageLoad: boolean;
3852
3825
  width: number;
@@ -3866,16 +3839,6 @@ declare type ConstWindowOptions = {
3866
3839
  * Control which options to ignore when creating a Platform Window.
3867
3840
  */
3868
3841
  excludeOptions: ExcludeOptions;
3869
- /**
3870
- * 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.
3871
- */
3872
- roundedCorners: boolean;
3873
- /**
3874
- * Determines whether window.open calls from web contents should use the specified target name as provided, or automatically generate a unique name.
3875
- * When true, each call generates a new unique target name, ensuring a new window is always created.
3876
- * When false, the target name passed to window.open is respected.
3877
- */
3878
- ignoreChildFrameName?: boolean;
3879
3842
  };
3880
3843
 
3881
3844
  /**
@@ -4138,13 +4101,13 @@ declare type CopyBlockedEventReason = 'disabled';
4138
4101
  */
4139
4102
  declare type CopyPermissions = {
4140
4103
  /**
4104
+ * @defaultValue 'allowed'
4105
+ *
4141
4106
  * Controls the behavior for copy operations for a matched URL.
4142
4107
  *
4143
4108
  * allow: Enables all copy operations.
4144
4109
  * block: Disables all copy operations.
4145
4110
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4146
- *
4147
- * @default 'allowed'
4148
4111
  */
4149
4112
  behavior: 'allow' | 'block' | 'protect';
4150
4113
  /**
@@ -4152,9 +4115,9 @@ declare type CopyPermissions = {
4152
4115
  */
4153
4116
  options?: {
4154
4117
  /**
4155
- * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4118
+ * @defaultValue ''
4156
4119
  *
4157
- * @default ''
4120
+ * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4158
4121
  */
4159
4122
  replacementText: string;
4160
4123
  };
@@ -4168,15 +4131,15 @@ declare type CopyPermissions = {
4168
4131
  */
4169
4132
  declare type CornerRounding = {
4170
4133
  /**
4171
- * The height in pixels.
4134
+ * @defaultValue 0
4172
4135
  *
4173
- * @default 0
4136
+ * The height in pixels.
4174
4137
  */
4175
4138
  height: number;
4176
4139
  /**
4177
- * The width in pixels.
4140
+ * @defaultValue 0
4178
4141
  *
4179
- * @default 0
4142
+ * The width in pixels.
4180
4143
  */
4181
4144
  width: number;
4182
4145
  };
@@ -4266,6 +4229,8 @@ declare type CreateLayoutOptions = {
4266
4229
  layoutName: string;
4267
4230
  layout: LayoutOptions;
4268
4231
  /**
4232
+ * @defaultValue 'default'
4233
+ *
4269
4234
  * Controls the View behavior for the given `layout` property. Note
4270
4235
  * that the selected behavior only applies to unnamed Views or
4271
4236
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4287,8 +4252,6 @@ declare type CreateLayoutOptions = {
4287
4252
  * override. Note that during applyLayoutSnapshot, Views are created and
4288
4253
  * attached to the Provider while the Window is being created, so it's
4289
4254
  * important to not 'duplicate' Views in this workflow.
4290
- *
4291
- * @default 'default'
4292
4255
  */
4293
4256
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4294
4257
  };
@@ -4547,7 +4510,7 @@ declare type DomainApiSettings = {
4547
4510
  * * 'none': The `fin` API will be not available.
4548
4511
  * * 'global': The entire `fin` API will be available.
4549
4512
  *
4550
- * @default 'global'
4513
+ * @defaultValue 'global'
4551
4514
  */
4552
4515
  fin?: InjectionType;
4553
4516
  /**
@@ -4587,22 +4550,7 @@ declare type DomainSettings = {
4587
4550
  };
4588
4551
 
4589
4552
  /**
4590
- * Enables or disables specific preload scripts by URL.
4591
- *
4592
- * Uses the script's full URL as the key and an object
4593
- * with an `enabled` boolean property as the value.
4594
- * @example
4595
- * ```js
4596
- * {
4597
- "match": ["<all_urls>"],
4598
- "options": {
4599
- "preloadScripts": {
4600
- "http://localhost:53000/block-preload.js": { "enabled": false }
4601
- "http://localhost:53000/allow-preload.js": { "enabled": true }
4602
- }
4603
- }
4604
- }
4605
- * ```
4553
+ * Map of preload scripts that can enable new scripts or disable options defined preloadScripts.
4606
4554
  */
4607
4555
  declare type DomainSettingsPreloadScripts = Record<string, {
4608
4556
  enabled: boolean;
@@ -4788,11 +4736,20 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
4788
4736
  eventNames: () => (string | symbol)[];
4789
4737
  /* Excluded from this release type: emit */
4790
4738
  private hasEmitter;
4739
+ /**
4740
+ * Cleans up after removal of a listener, e.g. deleting any lingering deregistration handlers for a
4741
+ * `once` subscription.
4742
+ *
4743
+ * @remarks Implementing this as a `removeListener` handler ensures that direct removal of a listener
4744
+ * on the base emitter will not leak additional core handlers. We could do this in the forwarding method,
4745
+ * which would involve less "magic," but would be more-vulnerable to accidental re-introduction of a leak.
4746
+ */
4747
+ private cleanUpRemovedListener;
4791
4748
  private getOrCreateEmitter;
4792
4749
  listeners: (type: string | symbol) => Function[];
4793
4750
  listenerCount: (type: string | symbol) => number;
4794
4751
  protected registerEventListener: (eventType: EmitterEventType, options: OpenFin.SubscriptionOptions | undefined, applySubscription: (emitter: EventEmitter) => void, undoSubscription: (emitter: EventEmitter) => void) => Promise<void>;
4795
- private deregisterEventListener;
4752
+ protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin.SubscriptionOptions) => Promise<void | EventEmitter>;
4796
4753
  /**
4797
4754
  * Adds a listener to the end of the listeners array for the specified event.
4798
4755
  *
@@ -4828,7 +4785,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
4828
4785
  * @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
4829
4786
  */
4830
4787
  removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
4831
- private deregisterAllListeners;
4788
+ protected deregisterAllListeners(eventType: EmitterEventType): Promise<EventEmitter | void>;
4832
4789
  /**
4833
4790
  * Removes all listeners, or those of the specified event.
4834
4791
  *
@@ -5138,9 +5095,9 @@ declare type EventType_9 = Event_12['type'];
5138
5095
  */
5139
5096
  declare type ExcludeOptions = {
5140
5097
  /**
5141
- * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5098
+ * @defaultValue false
5142
5099
  *
5143
- * @default false
5100
+ * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5144
5101
  */
5145
5102
  preloadScripts: boolean;
5146
5103
  };
@@ -5772,7 +5729,7 @@ declare class FDC3ModuleBase<ChannelType extends v1_2.Channel | v2_0.Channel> {
5772
5729
  *
5773
5730
  * @tutorial fdc3.getOrCreateChannel
5774
5731
  */
5775
- protected getOrCreateChannel(channelId: string, fdc3Factory: (contextGroup: OpenFin.SessionContextGroup) => ChannelType): Promise<ChannelType>;
5732
+ getOrCreateChannel(channelId: string): Promise<ChannelType>;
5776
5733
  /**
5777
5734
  * Returns the Interop-Broker-defined context groups available for an entity to join.
5778
5735
  *
@@ -5955,7 +5912,6 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
5955
5912
  readonly Platform: PlatformModule;
5956
5913
  readonly Interop: InteropModule;
5957
5914
  readonly SnapshotSource: SnapshotSourceModule;
5958
- readonly NotificationManager: NotificationManagerModule;
5959
5915
  /**
5960
5916
  * Provides access to the OpenFin representation of the current code context (usually an entity
5961
5917
  * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -5973,34 +5929,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
5973
5929
  */
5974
5930
  declare type FindInPageOptions = {
5975
5931
  /**
5976
- * Searches in the forward direction (backward otherwise)
5932
+ * @defaultValue true
5977
5933
  *
5978
- * @default true
5934
+ * Searches in the forward direction (backward otherwise)
5979
5935
  */
5980
5936
  forward?: boolean;
5981
5937
  /**
5982
- * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5938
+ * @defaultValue false
5983
5939
  *
5984
- * @default false
5940
+ * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5985
5941
  */
5986
5942
  findNext?: boolean;
5987
5943
  /**
5988
- * Enables case-sensitive searching.
5944
+ * @defaultValue false
5989
5945
  *
5990
- * @default false
5946
+ * Enables case-sensitive searching.
5991
5947
  */
5992
5948
  matchCase?: boolean;
5993
5949
  /**
5994
- * Only searches from the start of words.
5950
+ * @defaultValue false
5995
5951
  *
5996
- * @default false
5952
+ * Only searches from the start of words.
5997
5953
  */
5998
5954
  wordStart?: boolean;
5999
5955
  /**
5956
+ * @defaultValue false
5957
+ *
6000
5958
  * 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>
6001
5959
  * lowercase or non-letter. Accepts several other intra-word matches.
6002
- *
6003
- * @default false
6004
5960
  */
6005
5961
  medialCapitalAsWordStart?: boolean;
6006
5962
  };
@@ -6508,9 +6464,9 @@ declare type Hotkey = {
6508
6464
  */
6509
6465
  keys: string;
6510
6466
  /**
6511
- * Prevent default key handling before emitting the event.
6467
+ * @defaultValue false
6512
6468
  *
6513
- * @default false
6469
+ * Prevent default key handling before emitting the event.
6514
6470
  */
6515
6471
  preventDefault?: boolean;
6516
6472
  };
@@ -6996,7 +6952,6 @@ declare class InteropBroker extends Base {
6996
6952
  private sessionContextGroupMap;
6997
6953
  private channel;
6998
6954
  private logging;
6999
- private privateChannelProviderMap;
7000
6955
  /* Excluded from this release type: __constructor */
7001
6956
  private getProvider;
7002
6957
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
@@ -8868,82 +8823,79 @@ declare type LayoutOptions = {
8868
8823
  */
8869
8824
  newTabButtonUrl?: string;
8870
8825
  /**
8871
- * When true the splitters will not be draggable and the layout will not resize.
8826
+ * @defaultValue false
8872
8827
  *
8873
- * @default false
8828
+ * When true the splitters will not be draggable and the layout will not resize.
8874
8829
  */
8875
8830
  preventSplitterResize?: boolean;
8876
8831
  /**
8832
+ * @defaultValue false
8833
+ *
8877
8834
  * Whether the popout button will only act on the entire stack,
8878
8835
  * as opposed to only the active tab.
8879
- *
8880
- * @default false
8881
8836
  */
8882
8837
  popoutWholeStack?: boolean;
8883
8838
  /**
8839
+ * @defaultValue false
8840
+ *
8884
8841
  * Limits the area to which tabs can be dragged.
8885
8842
  * If true, the layout container is the only area where tabs can be dropped.
8886
- *
8887
- * @default false
8888
8843
  */
8889
8844
  constrainDragToContainer?: boolean;
8890
8845
  /**
8846
+ * @defaultValue false
8847
+ *
8891
8848
  * Whether to show the popout button on stack header.
8892
8849
  * The button will create a new window with current tab as its content.
8893
8850
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8894
- *
8895
- * @default false
8896
8851
  */
8897
8852
  showPopoutIcon?: boolean;
8898
8853
  /**
8854
+ * @defaultValue false
8855
+ *
8899
8856
  * Whether to show the maximize button on stack header.
8900
8857
  * The button will maximize the current tab to fill the entire window.
8901
- *
8902
- * @default false
8903
8858
  */
8904
8859
  showMaximiseIcon?: boolean;
8905
8860
  /**
8861
+ * @defaultValue false
8862
+ *
8906
8863
  * Whether to show the close button on stack header
8907
8864
  * (not to be confused with close button on every tab).
8908
- *
8909
- * @default false
8910
8865
  */
8911
8866
  showCloseIcon?: boolean;
8912
8867
  /**
8913
- * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8868
+ * @defaultValue false
8914
8869
  *
8915
- * @default false
8870
+ * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8916
8871
  */
8917
8872
  constrainDragToHeaders?: boolean;
8918
8873
  /**
8874
+ * @defaultValue true
8875
+ *
8919
8876
  * Turns tab headers on or off.
8920
8877
  * If false, the layout will be displayed with splitters only.
8921
- *
8922
- * @default true
8923
8878
  */
8924
8879
  hasHeaders?: boolean;
8925
8880
  /**
8881
+ * @defaultValue true
8882
+ *
8926
8883
  * If true, the user can re-arrange the layout by
8927
8884
  * dragging items by their tabs to the desired location.
8928
- *
8929
- * @default true
8930
8885
  */
8931
8886
  reorderEnabled?: boolean;
8932
8887
  /**
8933
- * If true, tabs can't be dragged out of the window.
8888
+ * @defaultValue false
8934
8889
  *
8935
- * @default false
8890
+ * If true, tabs can't be dragged out of the window.
8936
8891
  */
8937
8892
  preventDragOut?: boolean;
8938
8893
  /**
8939
8894
  * @defaultValue=false
8940
8895
  *
8941
8896
  * If true, tabs can't be dragged into the window.
8942
- *
8943
- * @default false
8944
8897
  */
8945
8898
  preventDragIn?: boolean;
8946
- /* Excluded from this release type: disableTabOverflowDropdown */
8947
8899
  };
8948
8900
  /**
8949
8901
  * Content of the layout. There can only be one top-level LayoutItem in the content array.
@@ -9051,111 +9003,21 @@ declare type LogInfo = {
9051
9003
  */
9052
9004
  declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
9053
9005
 
9054
- /**
9055
- * Log types
9056
- *
9057
- * Note: For the debug log options, the one with the most specific matching pattern will be used.
9058
- */
9059
- declare type LogTypes =
9060
- /**
9061
- * Uploads app logs
9062
- */
9063
- 'app'
9064
- /**
9065
- * Uploads rvm logs
9066
- */
9067
- | 'rvm'
9068
- /**
9069
- * Uploads all debug logs
9070
- */
9071
- | 'debug'
9072
- /**
9073
- * Uploads the most current debug log the current application
9074
- */
9075
- | 'debug:self'
9076
- /**
9077
- * Uploads all debug logs for the current application
9078
- */
9079
- | 'debug:self:archive'
9080
- /**
9081
- * Uploads the last two debug logs for the current application
9082
- */
9083
- | 'debug:self:archive:last';
9084
-
9085
- /**
9086
- * Options for the Log Uploader.
9087
- */
9088
- declare type LogUploaderOptions = LogUploadOptions & {
9089
- ui?: LogUploaderUIOptions & {
9090
- /**
9091
- * Whether the Log Uploader UI should be shown.
9092
- * @defaultValue true
9093
- */
9094
- show?: boolean;
9095
- };
9096
- };
9097
-
9098
- /**
9099
- * Options for the Log Uploader UI.
9100
- * @interface
9101
- */
9102
9006
  declare type LogUploaderUIOptions = {
9103
- /**
9104
- * Title for the Log Uploader window.
9105
- * @defaultValue 'Here Log Uploader'
9106
- */
9107
9007
  title?: string;
9108
- /**
9109
- * URL of an icon to use for the Log Uploader tool. The default is the Here logo.
9110
- */
9111
9008
  icon?: string;
9112
- /**
9113
- * Name of the organization displayed in the Uploader window.
9114
- * @defaultValue 'Here'
9115
- */
9116
9009
  header?: string;
9117
- /**
9118
- * An explanation for the user of the purpose of the tool.
9119
- * @defaultValue 'The following logs are being requested'
9120
- */
9121
9010
  description?: string;
9122
- /**
9123
- * An email address that the user can contact with questions.
9124
- * @defaultValue 'support@here.io'
9125
- */
9126
9011
  email?: string;
9127
- /**
9128
- * URL of a webpage where the user can find more information about log uploading.
9129
- * @defaultValue 'https://resources.here.io/docs/core/manage/security/'
9130
- */
9131
9012
  website?: string;
9132
- /**
9133
- * Description of the webpage where the user can find more information.
9134
- * @defaultValue 'Here Security'
9135
- */
9136
9013
  websiteDescription?: string;
9137
9014
  };
9138
9015
 
9139
9016
  declare type LogUploadOptions = {
9140
- /**
9141
- * The URL where log files are to be uploaded.
9142
- */
9143
9017
  endpoint: string;
9144
- /**
9145
- * An array of URL match patterns to define the manifests of the programs that the Log Uploader should upload logs for.
9146
- * @defaultValue []
9147
- */
9148
9018
  manifests?: string[];
9149
- /**
9150
- * An array of strings that specifies which logs should be uploaded.
9151
- * @defaultValue ['app', 'rvm', 'debug']
9152
- */
9153
- logs?: LogTypes[];
9019
+ logs?: string[];
9154
9020
  ui?: LogUploaderUIOptions;
9155
- /**
9156
- * Max file size limit in Megabytes for the logs archive.
9157
- */
9158
- sizeLimit?: number;
9159
9021
  };
9160
9022
 
9161
9023
  /**
@@ -9193,9 +9055,6 @@ declare type Manifest = {
9193
9055
  forceLatest?: boolean;
9194
9056
  futureVersion?: string;
9195
9057
  version: string;
9196
- policies?: {
9197
- CloudAPAuthEnabled?: 'enabled' | 'disabled';
9198
- };
9199
9058
  };
9200
9059
  services?: string[];
9201
9060
  shortcut?: {
@@ -9486,10 +9345,10 @@ declare type MutableViewOptions = {
9486
9345
  /**
9487
9346
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9488
9347
  *
9348
+ * @defaultValue true
9349
+ *
9489
9350
  * Show the context menu when right-clicking on the view.
9490
9351
  * Gives access to the devtools for the view.
9491
- *
9492
- * @default true
9493
9352
  */
9494
9353
  contextMenu: boolean;
9495
9354
  /**
@@ -9536,25 +9395,24 @@ declare type MutableViewOptions = {
9536
9395
  contentNavigation: ContentNavigation;
9537
9396
  contentRedirect: ContentRedirect;
9538
9397
  /**
9398
+ * @defaultValue false
9539
9399
  * @deprecated
9540
9400
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9541
9401
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9542
- *
9543
- * @default false
9544
9402
  */
9545
9403
  detachOnClose: boolean;
9546
9404
  /**
9405
+ * @defaultValue true
9406
+ *
9547
9407
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9548
9408
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9549
9409
  * if the view isn't part of the new layout when running `Layout.replace`.
9550
- *
9551
- * @default true
9552
9410
  */
9553
9411
  isClosable: boolean;
9554
9412
  /**
9555
- * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9413
+ * @defaultValue false
9556
9414
  *
9557
- * @default false
9415
+ * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9558
9416
  */
9559
9417
  preventDragOut: boolean;
9560
9418
  interop?: InteropConfig;
@@ -9562,7 +9420,7 @@ declare type MutableViewOptions = {
9562
9420
  /**
9563
9421
  * {@inheritDoc ViewThrottling}
9564
9422
  *
9565
- * @default 'enabled'
9423
+ * @defaultValue 'enabled'
9566
9424
  */
9567
9425
  throttling: ViewThrottling;
9568
9426
  /**
@@ -9581,7 +9439,7 @@ declare type MutableWindowOptions = {
9581
9439
  * Turns anything of matching RGB value transparent.
9582
9440
  *
9583
9441
  * Caveats:
9584
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9442
+ * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9585
9443
  * * User cannot click-through transparent regions
9586
9444
  * * Not supported on Mac
9587
9445
  * * Windows Aero must be enabled
@@ -9590,25 +9448,25 @@ declare type MutableWindowOptions = {
9590
9448
  */
9591
9449
  alphaMask: RGB;
9592
9450
  /**
9593
- * Always position the window at the top of the window stack.
9451
+ * @defaultValue false
9594
9452
  *
9595
- * @default false
9453
+ * Always position the window at the top of the window stack.
9596
9454
  */
9597
9455
  alwaysOnTop: boolean;
9598
9456
  /**
9457
+ * @defaultValue 0
9458
+ *
9599
9459
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9600
9460
  * an aspect ratio will not be enforced.
9601
- *
9602
- * @default 0
9603
9461
  */
9604
9462
  aspectRatio: number;
9605
9463
  /**
9606
9464
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9607
9465
  *
9466
+ * @defaultValue true
9467
+ *
9608
9468
  * Show the context menu when right-clicking on the window.
9609
9469
  * Gives access to the devtools for the window.
9610
- *
9611
- * @default true
9612
9470
  */
9613
9471
  contextMenu: boolean;
9614
9472
  /**
@@ -9675,19 +9533,15 @@ declare type MutableWindowOptions = {
9675
9533
  */
9676
9534
  customData: any;
9677
9535
  /**
9536
+ * @defaultValue true
9678
9537
  *
9679
9538
  * Show the window's frame.
9680
- *
9681
- * @remarks
9682
- * This property will not be updatable starting runtime version 45.
9683
- *
9684
- * @default true
9685
9539
  */
9686
9540
  frame: boolean;
9687
9541
  /**
9688
- * Hides the window instead of closing it when the close button is pressed.
9542
+ * @defaultValue false
9689
9543
  *
9690
- * @default false
9544
+ * Hides the window instead of closing it when the close button is pressed.
9691
9545
  */
9692
9546
  hideOnClose: boolean;
9693
9547
  /**
@@ -9740,61 +9594,60 @@ declare type MutableWindowOptions = {
9740
9594
  */
9741
9595
  icon: string;
9742
9596
  /**
9597
+ * @defaultValue true
9598
+ *
9743
9599
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9744
9600
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9745
- *
9746
- * @default true
9747
9601
  */
9748
9602
  includeInSnapshots: boolean;
9749
9603
  /**
9750
- * The maximum height of a window. Will default to the OS defined value if set to -1.
9604
+ * @defaultValue -1
9751
9605
  *
9752
- * @default -1
9606
+ * The maximum height of a window. Will default to the OS defined value if set to -1.
9753
9607
  */
9754
9608
  maxHeight: number;
9755
9609
  /**
9756
- * Allows the window to be maximized.
9610
+ * @defaultValue true
9757
9611
  *
9758
- * @default true
9612
+ * Allows the window to be maximized.
9759
9613
  */
9760
9614
  maximizable: boolean;
9761
9615
  /**
9762
- * The maximum width of a window. Will default to the OS defined value if set to -1.
9616
+ * @defaultValue -1
9763
9617
  *
9764
- * @default -1
9618
+ * The maximum width of a window. Will default to the OS defined value if set to -1.
9765
9619
  */
9766
9620
  maxWidth: number;
9767
9621
  /**
9768
- * The minimum height of the window.
9622
+ * @defaultValue 0
9769
9623
  *
9770
- * @default 0
9624
+ * The minimum height of the window.
9771
9625
  */
9772
9626
  minHeight: number;
9773
9627
  /**
9774
- * Allows the window to be minimized.
9628
+ * @defaultValue true
9775
9629
  *
9776
- * @default true
9630
+ * Allows the window to be minimized.
9777
9631
  */
9778
9632
  minimizable: boolean;
9779
9633
  /**
9780
- * The minimum width of the window.
9634
+ * @defaultValue true
9781
9635
  *
9782
- * @default true
9636
+ * The minimum width of the window.
9783
9637
  */
9784
9638
  minWidth: number;
9785
9639
  /**
9640
+ * @defaultValue 1
9641
+ *
9786
9642
  * A flag that specifies how transparent the window will be.
9787
9643
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9788
9644
  * This value is clamped between `0.0` and `1.0`.
9789
- * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9790
- *
9791
- * @default 1
9792
9645
  */
9793
9646
  opacity: number;
9794
9647
  /**
9795
- * A flag to allow the user to resize the window.
9648
+ * @defaultValue true
9796
9649
  *
9797
- * @default true
9650
+ * A flag to allow the user to resize the window.
9798
9651
  */
9799
9652
  resizable: boolean;
9800
9653
  /**
@@ -9802,22 +9655,16 @@ declare type MutableWindowOptions = {
9802
9655
  */
9803
9656
  resizeRegion: ResizeRegion;
9804
9657
  /**
9658
+ * @defaultValue false
9659
+ *
9805
9660
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9806
9661
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9807
- *
9808
- * @default false
9809
9662
  */
9810
9663
  showBackgroundImages: boolean;
9811
9664
  /**
9812
- * Shows the window's icon in the taskbar.
9665
+ * @defaultValue true
9813
9666
  *
9814
- * @remarks
9815
- * In Windows, setting `showTaskbarIcon` to false will cause the window to display on all virtual desktops.
9816
- * In order to prevent this while keeping `showTaskbarIcon` false, pass the identity of the parent via the
9817
- * `modalParentIdentity` (see {@link WindowCreationOptions}). This is useful for popups managed by
9818
- * {@link Window._Window.showPopupWindow}.
9819
- *
9820
- * @default true
9667
+ * Shows the window's icon in the taskbar.
9821
9668
  */
9822
9669
  showTaskbarIcon: boolean;
9823
9670
  /**
@@ -9836,7 +9683,7 @@ declare type MutableWindowOptions = {
9836
9683
  /**
9837
9684
  * {@inheritDoc WindowThrottling}
9838
9685
  *
9839
- * @default 'enabled'
9686
+ * @defaultValue 'enabled'
9840
9687
  *
9841
9688
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9842
9689
  */
@@ -9953,108 +9800,6 @@ declare type NonPropagatedWindowEvent = never;
9953
9800
 
9954
9801
  /* Excluded from this release type: NotCloseRequested */
9955
9802
 
9956
- declare type NotificationEvent = {
9957
- type: 'close' | 'click' | 'show';
9958
- notificationId: string;
9959
- };
9960
-
9961
- declare type NotificationHandler = (notification: WebNotificationInfo) => void;
9962
-
9963
- /**
9964
- * 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.
9965
- *
9966
- * Please note, currently Notifications will only be intercepted if the following conditions are met:
9967
- * - The source WebContents has the `notification` webAPI permission.
9968
- * - The source WebContents is not a service worker.
9969
- *
9970
- * Service worker and push notifications are currently not supported.
9971
- *
9972
- * **See also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | Notification API (MDN)}
9973
- *
9974
- * @experimental This API is subject to change in future releases.
9975
- *
9976
- */
9977
- declare class NotificationManagerInstance {
9978
- #private;
9979
- /* Excluded from this release type: __constructor */
9980
- /**
9981
- * Sets the current handler for notifications. The provided function will be invoked whenever a WebContents successfully raises a notification.
9982
- *
9983
- * **Note**, only one handler can be used at a time, calling `setNotificationHandler` will replace any existing registered handler.
9984
- *
9985
- * @param handler The notification handler callback which will be invoked whenever a notification is created.
9986
- *
9987
- * @example
9988
- *
9989
- * ```typescript
9990
- * const notificationManager = await fin.NotificationManager.init();
9991
- * const handler = (notification) => {
9992
- * console.log("Received the following notification", info);
9993
- * }
9994
- * await notificationManager.setNotificationHandler(handler);
9995
- * ```
9996
- */
9997
- setNotificationHandler: (handler: OpenFin.NotificationHandler) => Promise<void>;
9998
- /**
9999
- * Destroys the current NotificationManagerInstance.
10000
- *
10001
- * @example
10002
- * ```typescript
10003
- * await notificationManager.destroy();
10004
- * ```
10005
- */
10006
- destroy: () => Promise<void>;
10007
- /**
10008
- * Dispatches a Notification lifecycle event ('close' | 'click' | 'show').
10009
- *
10010
- * @param event Identifies the type of event to emit, and which `notificationId` to emit it for.
10011
- *
10012
- * @example
10013
- * ```typescript
10014
- * notificationManager.setNotificationHandler((notification) => {
10015
- * await mockNotificationUi.showNotification(notification);
10016
- * await notificationManager.dispatchNotificationEvent({
10017
- * notificationId: notification.notificationId,
10018
- * type: 'show
10019
- * })
10020
- * })
10021
- * ```
10022
- *
10023
- * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/click_event | Notification Click Event (MDN)}
10024
- *
10025
- * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/close_event | Notification Close Event (MDN)}
10026
- *
10027
- * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/show_event | Notification Show Event (MDN)}
10028
- */
10029
- dispatch: (event: OpenFin.NotificationEvent) => Promise<void>;
10030
- }
10031
-
10032
- declare class NotificationManagerModule extends Base {
10033
- /**
10034
- * Initializes a NotificationManager for the current application, which allows interception of HTML5 web notifications.
10035
- *
10036
- * Secured by default, must be called from a WebContents with the NotificationManager.init permission.
10037
- *
10038
- * Only one NotificationManager can be active at a time, calls to `init` will fail otherwise.
10039
- *
10040
- * If a WebContents with the NotificationManager active reloads or is closed, it will be possible to create a new one.
10041
- *
10042
- * @example
10043
- *
10044
- * ```js
10045
- * // From Provider context
10046
- * const notificationManager = await fin.NotificationManager.init();
10047
- * // NotificationManager is now active and will intercept all incoming notifications.
10048
- * ```
10049
- * @experimental
10050
- */
10051
- init: () => Promise<NotificationManagerInstance>;
10052
- }
10053
-
10054
- declare type NotificationManagerPermissions = {
10055
- init: boolean;
10056
- };
10057
-
10058
9803
  /* Excluded from this release type: NotRequested */
10059
9804
 
10060
9805
  /**
@@ -10227,7 +9972,6 @@ declare namespace OpenFin {
10227
9972
  ApplicationPermissions,
10228
9973
  LaunchExternalProcessRule,
10229
9974
  SystemPermissions,
10230
- NotificationManagerPermissions,
10231
9975
  DevicePermissionName,
10232
9976
  WebPermissionName,
10233
9977
  WebPermission,
@@ -10241,9 +9985,7 @@ declare namespace OpenFin {
10241
9985
  PlatformViewCreationOptions,
10242
9986
  ProcessAffinityStrategy,
10243
9987
  PlatformOptions,
10244
- LogUploaderOptions,
10245
9988
  LogUploaderUIOptions,
10246
- LogTypes,
10247
9989
  LogUploadOptions,
10248
9990
  Manifest,
10249
9991
  LayoutContent,
@@ -10359,8 +10101,6 @@ declare namespace OpenFin {
10359
10101
  CopyPermissions,
10360
10102
  PastePermissions,
10361
10103
  ClipboardPermissions,
10362
- PrintPlaceholder,
10363
- PrintPermission,
10364
10104
  DomainSettingsRule,
10365
10105
  FileDownloadBehavior,
10366
10106
  FileDownloadBehaviorNames,
@@ -10468,12 +10208,6 @@ declare namespace OpenFin {
10468
10208
  RoutingInfo,
10469
10209
  DownloadShelfOptions,
10470
10210
  ViewShowAtOptions,
10471
- WebNotificationProperties,
10472
- WebNotificationInfo,
10473
- NotificationEvent,
10474
- NotificationHandler,
10475
- NotificationManagerInstance,
10476
- NotificationManagerModule,
10477
10211
  ExtensionInfo,
10478
10212
  ServeRequest,
10479
10213
  AppAssetServeRequest,
@@ -10561,12 +10295,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10561
10295
  */
10562
10296
  declare type PastePermissions = {
10563
10297
  /**
10298
+ * @defaultValue 'non-protected-content'
10299
+ *
10564
10300
  * Controls the behavior for paste operations for a matched URL.
10565
10301
  *
10566
10302
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10567
10303
  * 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.
10568
- *
10569
- * @default 'non-protected-content'
10570
10304
  */
10571
10305
  behavior: 'non-protected-content' | 'all-content';
10572
10306
  };
@@ -10735,7 +10469,7 @@ declare type PerDomainSettings = {
10735
10469
  * Defaults to 'allow'.
10736
10470
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10737
10471
  */
10738
- print?: 'allow' | 'block' | PrintPermission;
10472
+ print?: 'allow' | 'block';
10739
10473
  /**
10740
10474
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
10741
10475
  */
@@ -10768,7 +10502,6 @@ declare type Permissions_2 = {
10768
10502
  Clipboard?: Partial<ClipboardApiPermissions>;
10769
10503
  webAPIs?: WebPermission[];
10770
10504
  devices?: DeviceInfo[];
10771
- NotificationManager?: Partial<NotificationManagerPermissions>;
10772
10505
  };
10773
10506
 
10774
10507
  declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -11598,11 +11331,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11598
11331
  */
11599
11332
  providerUrl?: string;
11600
11333
  /**
11334
+ * @defaultValue true
11335
+ *
11601
11336
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11602
11337
  *
11603
11338
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11604
- *
11605
- * @default true
11606
11339
  */
11607
11340
  allowLaunchIntoPlatform?: boolean;
11608
11341
  };
@@ -12250,22 +11983,22 @@ declare type PopupOptions = {
12250
11983
  url?: string;
12251
11984
  /**
12252
11985
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
12253
- * @default 300
11986
+ * @defaultValue 300
12254
11987
  */
12255
11988
  height?: number;
12256
11989
  /**
12257
11990
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
12258
- * @default 300
11991
+ * @defaultValue 300
12259
11992
  */
12260
11993
  width?: number;
12261
11994
  /**
12262
11995
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12263
- * @default 0
11996
+ * @defaultValue 0
12264
11997
  */
12265
11998
  x?: number;
12266
11999
  /**
12267
12000
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12268
- * @default 0
12001
+ * @defaultValue 0
12269
12002
  */
12270
12003
  y?: number;
12271
12004
  /**
@@ -12273,7 +12006,7 @@ declare type PopupOptions = {
12273
12006
  * * 'modal' restricts resizing and positioning in the caller.
12274
12007
  * * 'hide' hides the popup window on blur.
12275
12008
  * * 'close' closes the popup window on blur.
12276
- * @default 'close'
12009
+ * @defaultValue 'close'
12277
12010
  */
12278
12011
  blurBehavior?: PopupBlurBehavior;
12279
12012
  /**
@@ -12281,19 +12014,19 @@ declare type PopupOptions = {
12281
12014
  * * 'none' will do nothing.
12282
12015
  * * 'hide' hides the popup window on `dispatchPopupResult`.
12283
12016
  * * 'close' closes the popup window on `dispatchPopupResult`.
12284
- * @default 'close'
12017
+ * @defaultValue 'close'
12285
12018
  */
12286
12019
  resultDispatchBehavior?: PopupResultBehavior;
12287
12020
  /**
12288
12021
  * Hide the popup window instead of closing when `close` is called on it.
12289
12022
  *
12290
12023
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
12291
- * @default false
12024
+ * @defaultValue false
12292
12025
  */
12293
12026
  hideOnClose?: boolean;
12294
12027
  /**
12295
12028
  * Determines if the popup window should or should not be focused when it is shown.
12296
- * @default true
12029
+ * @defaultValue true
12297
12030
  */
12298
12031
  focus?: boolean;
12299
12032
  /**
@@ -12387,9 +12120,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12387
12120
  */
12388
12121
  declare type PreloadScript = {
12389
12122
  /**
12390
- * Fail to load the window if this preload script fails
12123
+ * @defaultValue false
12391
12124
  *
12392
- * @default false
12125
+ * Fail to load the window if this preload script fails
12393
12126
  */
12394
12127
  mandatory?: boolean;
12395
12128
  /**
@@ -12481,15 +12214,15 @@ declare type PrinterInfo = {
12481
12214
  declare type PrintOptions = {
12482
12215
  content?: 'self';
12483
12216
  /**
12484
- * Disables prompting the user for print settings.
12217
+ * @defaultValue false
12485
12218
  *
12486
- * @default false
12219
+ * Disables prompting the user for print settings.
12487
12220
  */
12488
12221
  silent?: boolean;
12489
12222
  /**
12490
- * Includes the webpage background color and image when printing.
12223
+ * @defaultValue false
12491
12224
  *
12492
- * @default false
12225
+ * Includes the webpage background color and image when printing.
12493
12226
  */
12494
12227
  printBackground?: boolean;
12495
12228
  /**
@@ -12497,9 +12230,9 @@ declare type PrintOptions = {
12497
12230
  */
12498
12231
  deviceName?: string;
12499
12232
  /**
12500
- * Prints in full color (greyscale otherwise).
12233
+ * @defaultValue true
12501
12234
  *
12502
- * @default true
12235
+ * Prints in full color (greyscale otherwise).
12503
12236
  */
12504
12237
  color?: boolean;
12505
12238
  /**
@@ -12507,9 +12240,9 @@ declare type PrintOptions = {
12507
12240
  */
12508
12241
  margins?: Margins;
12509
12242
  /**
12510
- * Prints in landscape mode (portrait otherwise).
12243
+ * @defaultValue true
12511
12244
  *
12512
- * @default true
12245
+ * Prints in landscape mode (portrait otherwise).
12513
12246
  */
12514
12247
  landscape?: boolean;
12515
12248
  /**
@@ -12542,53 +12275,6 @@ declare type PrintOptions = {
12542
12275
  dpi?: Dpi;
12543
12276
  };
12544
12277
 
12545
- /**
12546
- * Control print operations for a matched URL.
12547
- * @interface
12548
- */
12549
- declare type PrintPermission = {
12550
- /**
12551
- * Controls the behavior for print operations for a matched URL.
12552
- *
12553
- * allow: Enables all print operations.
12554
- * block: Disables all print operations.
12555
- *
12556
- * @defaultValue 'allowed'
12557
- */
12558
- behavior: 'allow' | 'block';
12559
- /**
12560
- * Additional placeholder options. When setting behavior = 'block' , then this will be used to draw placeholder.
12561
- */
12562
- placeholder?: PrintPlaceholder;
12563
- };
12564
-
12565
- declare type PrintPlaceholder = {
12566
- /**
12567
- * This color will be background color for placeholder.
12568
- *
12569
- * @defaultValue '#FFFFFFFF'
12570
- */
12571
- backgroundColor?: string;
12572
- /**
12573
- * This string will be visible on placeholder instead of the original content.
12574
- *
12575
- * @defaultValue 'Content is print restricted'
12576
- */
12577
- text?: string;
12578
- /**
12579
- * This color will be text color for placeholder.
12580
- *
12581
- * @defaultValue '#FF000000'
12582
- */
12583
- textColor?: string;
12584
- /**
12585
- * This font type will be font for placeholder.
12586
- *
12587
- * @defaultValue Default system font.
12588
- */
12589
- textFontType?: string;
12590
- };
12591
-
12592
12278
  /**
12593
12279
  * Strategy to assign views to process affinity by domain.
12594
12280
  *
@@ -12984,10 +12670,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
12984
12670
  transitions: OpenFin.Transition;
12985
12671
  options: OpenFin.TransitionOptions;
12986
12672
  }>;
12987
- 'activate-window-and-focus': ApiCall<{
12988
- winIdentity: OpenFin.Identity;
12989
- focusIdentity: OpenFin.Identity;
12990
- }, boolean>;
12991
12673
  'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
12992
12674
  'get-window-bounds': IdentityCall<{
12993
12675
  options?: OpenFin.GetBoundsOptions;
@@ -13243,13 +12925,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
13243
12925
  apiPath: '.getOSInfo';
13244
12926
  namespace: 'System';
13245
12927
  };
13246
- 'launch-log-uploader': ApiCall<{
13247
- options: OpenFin.LogUploaderOptions;
13248
- }, void> & {
13249
- secure: true;
13250
- apiPath: '.launchLogUploader';
13251
- namespace: 'System';
13252
- };
13253
12928
  'launch-external-process': ApiCall<OpenFin.ExternalProcessRequestType, OpenFin.Identity> & {
13254
12929
  secure: true;
13255
12930
  apiPath: '.launchExternalProcess';
@@ -13617,28 +13292,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
13617
13292
  };
13618
13293
  response: void;
13619
13294
  };
13620
- 'dispatch-notification-event': {
13621
- request: {
13622
- notificationId: string;
13623
- type: 'close' | 'show' | 'click';
13624
- };
13625
- response: void;
13626
- };
13627
- 'init-notification-manager': {
13628
- request: {};
13629
- response: {
13630
- managerId: string;
13631
- };
13632
- apiPath: '.init';
13633
- secure: true;
13634
- namespace: 'NotificationManager';
13635
- };
13636
- 'destroy-notification-manager': {
13637
- request: {
13638
- managerId: string;
13639
- };
13640
- response: void;
13641
- };
13642
13295
  };
13643
13296
 
13644
13297
  declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
@@ -13886,15 +13539,15 @@ declare type ReplaceViewPayload = {
13886
13539
  */
13887
13540
  declare type ResizeRegion = {
13888
13541
  /**
13889
- * The size of the resize region in pixels.
13542
+ * @defaultValue 7
13890
13543
  *
13891
- * @default 7
13544
+ * The size of the resize region in pixels.
13892
13545
  */
13893
13546
  size?: number;
13894
13547
  /**
13895
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13548
+ * @defaultValue 9
13896
13549
  *
13897
- * @default 9
13550
+ * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13898
13551
  */
13899
13552
  bottomRightCorner?: number;
13900
13553
  /**
@@ -13902,27 +13555,27 @@ declare type ResizeRegion = {
13902
13555
  */
13903
13556
  sides?: {
13904
13557
  /**
13905
- * Enables resizing from the top of the window.
13558
+ * @defaultValue true
13906
13559
  *
13907
- * @default true
13560
+ * Enables resizing from the top of the window.
13908
13561
  */
13909
13562
  top?: boolean;
13910
13563
  /**
13911
- * Enables resizing from the bottom of the window.
13564
+ * @defaultValue true
13912
13565
  *
13913
- * @default true
13566
+ * Enables resizing from the bottom of the window.
13914
13567
  */
13915
13568
  bottom?: boolean;
13916
13569
  /**
13917
- * Enables resizing from the left side of the window.
13570
+ * @defaultValue true
13918
13571
  *
13919
- * @default true
13572
+ * Enables resizing from the left side of the window.
13920
13573
  */
13921
13574
  left?: boolean;
13922
13575
  /**
13923
- * Enables resizing from the right side of the window.
13576
+ * @defaultValue true
13924
13577
  *
13925
- * @default true
13578
+ * Enables resizing from the right side of the window.
13926
13579
  */
13927
13580
  right?: boolean;
13928
13581
  };
@@ -14476,9 +14129,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
14476
14129
  */
14477
14130
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
14478
14131
  /**
14479
- * Number of milliseconds to wait between view repaints.
14132
+ * @defaultValue 0
14480
14133
  *
14481
- * @default 0
14134
+ * Number of milliseconds to wait between view repaints.
14482
14135
  */
14483
14136
  paintIntervalMs?: number;
14484
14137
  };
@@ -16163,11 +15816,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
16163
15816
  * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
16164
15817
  */
16165
15818
  serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
16166
- /**
16167
- * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
16168
- * @experimental
16169
- */
16170
- launchLogUploader(options: OpenFin.LogUploaderOptions): Promise<void>;
16171
15819
  }
16172
15820
 
16173
15821
  /**
@@ -16268,7 +15916,6 @@ declare type SystemPermissions = {
16268
15916
  downloadAsset: boolean;
16269
15917
  serveAsset: boolean;
16270
15918
  enableNativeWindowIntegrationProvider: boolean;
16271
- launchLogUploader: boolean;
16272
15919
  };
16273
15920
 
16274
15921
  /**
@@ -16531,9 +16178,9 @@ declare type TransitionBase = {
16531
16178
  */
16532
16179
  duration: number;
16533
16180
  /**
16534
- * Treats 'opacity' as absolute or as a delta. Defaults to false.
16181
+ * @defaultValue false
16535
16182
  *
16536
- * @default false
16183
+ * Treats 'opacity' as absolute or as a delta. Defaults to false.
16537
16184
  */
16538
16185
  relative?: boolean;
16539
16186
  };
@@ -16549,9 +16196,9 @@ declare type TransitionOptions = {
16549
16196
  */
16550
16197
  interrupt: boolean;
16551
16198
  /**
16552
- * Treats 'opacity' as absolute or as a delta. Defaults to false.
16199
+ * @defaultValue false
16553
16200
  *
16554
- * @default false
16201
+ * Treats 'opacity' as absolute or as a delta. Defaults to false.
16555
16202
  */
16556
16203
  relative?: boolean;
16557
16204
  tween?: tween;
@@ -17585,9 +17232,9 @@ declare type ViewTitlePriority = 'document' | 'options';
17585
17232
  */
17586
17233
  declare type ViewVisibilityOption = {
17587
17234
  /**
17588
- * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17235
+ * @defaultValue false
17589
17236
  *
17590
- * @default false
17237
+ * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17591
17238
  */
17592
17239
  enabled?: boolean;
17593
17240
  };
@@ -18619,19 +18266,6 @@ declare namespace WebContentsEvents {
18619
18266
  }
18620
18267
  }
18621
18268
 
18622
- declare type WebNotificationInfo = {
18623
- notificationId: string;
18624
- properties: WebNotificationProperties;
18625
- url: string;
18626
- images: {
18627
- icon?: string;
18628
- badge?: string;
18629
- image?: string;
18630
- };
18631
- };
18632
-
18633
- declare type WebNotificationProperties = Pick<Notification, 'tag' | 'body' | 'data' | 'dir' | 'icon' | 'lang' | 'title'>;
18634
-
18635
18269
  /**
18636
18270
  * Defines the type of requested web APIs permission.
18637
18271
  *
@@ -18774,30 +18408,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18774
18408
  * ```
18775
18409
  */
18776
18410
  getAllFrames(): Promise<Array<OpenFin.FrameInfo>>;
18777
- /**
18778
- * Activates the current window and focuses the child entity if it exists. If this does
18779
- * not succeed - say the child does not belong to this window, or the identity does not exist -
18780
- * it will return false.
18781
- *
18782
- * @example
18783
- * ```js
18784
- * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
18785
- *
18786
- * win.getCurrentViews()
18787
- * .then(([view1]) => {
18788
- * return win.activateAndFocus(view1.identity);
18789
- * })
18790
- * .then(success => {
18791
- * if (success) {
18792
- * console.log('Window activated and child focused');
18793
- * } else {
18794
- * console.log('Window activation failed, focus state unchanged');
18795
- * }
18796
- * })
18797
- * .catch(console.error);
18798
- * ```
18799
- */
18800
- activateAndFocus(childIdentityToFocus: OpenFin.Identity): Promise<boolean>;
18801
18411
  /**
18802
18412
  * Gets the current bounds (top, bottom, right, left, width, height) of the window.
18803
18413
  *