@openfin/fdc3-api 43.100.45 → 43.100.49

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
- * @defaultValue false
139
+ * @default false
140
140
  */
141
141
  crossOriginInjection?: boolean;
142
142
  /**
143
143
  * Inject OpenFin API into same-origin iframes
144
144
  *
145
- * @defaultValue true
145
+ * @default 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
- * @defaultValue false
1191
- *
1192
1190
  * Disables IAB secure logging for the app.
1191
+ *
1192
+ * @default false
1193
1193
  */
1194
1194
  disableIabSecureLogging: boolean;
1195
1195
  /**
1196
- * @defaultValue 'There was an error loading the application.'
1197
- *
1198
1196
  * An error message to display when the application (launched via manifest) fails to load.
1199
1197
  * A dialog box will be launched with the error message just before the runtime exits.
1200
1198
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1201
1199
  * will trigger this dialog.
1202
1200
  * 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
- *
1223
1221
  * A flag to configure the application as non-persistent.
1224
1222
  * Runtime exits when there are no persistent apps running.
1223
+ *
1224
+ * @default false
1225
1225
  */
1226
1226
  nonPersistent: boolean;
1227
1227
  /**
1228
- * @defaultValue false
1229
- *
1230
1228
  * Enable Flash at the application level.
1229
+ *
1230
+ * @default false
1231
1231
  */
1232
1232
  plugins: boolean;
1233
1233
  /**
1234
- * @defaultValue false
1235
- *
1236
1234
  * Enable spell check at the application level.
1235
+ *
1236
+ * @default false
1237
1237
  */
1238
1238
  spellCheck: boolean;
1239
1239
  /**
1240
- * @defaultValue 'about:blank'
1241
- *
1242
1240
  * The url to the application (specifically the application's main window).
1241
+ *
1242
+ * @default 'about:blank'
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
- * @defaultValue true
1252
- *
1253
1251
  * When set to `false` it will disable the same-origin policy for the app.
1252
+ *
1253
+ * @default true
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
- *
1265
1263
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1266
1264
  * 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
- *
1284
1282
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1285
1283
  *
1286
1284
  * Note: if the Platform Provider is showing, it won't close automatically.
1287
1285
  * 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
- * @defaultValue true
1296
- *
1297
1295
  * When set to `false` it will disable OpenFin Diagnostics for the app.
1296
+ *
1297
+ * @default true
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
- *
1315
1313
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1316
1314
  * Only relevant in Windows.
1315
+ *
1316
+ * @default false
1317
1317
  */
1318
1318
  enableJumpList: boolean;
1319
1319
  /**
1320
- * @defaultValue false
1321
- *
1322
1320
  * When set to `true`, any `beforeunload` handler set on the app will fire.
1321
+ *
1322
+ * @default false
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
- *
1405
1403
  * When true, applySnapshot will close existing windows,
1406
1404
  * replacing current Platform state with the given snapshot.
1405
+ *
1406
+ * @default false
1407
1407
  */
1408
1408
  closeExistingWindows?: boolean;
1409
1409
  /**
1410
- * @defaultValue false
1411
- *
1412
1410
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1413
1411
  * replacing current Platform state with the given snapshot.
1412
+ *
1413
+ * @default false
1414
1414
  */
1415
1415
  closeSnapshotWindows?: boolean;
1416
1416
  /**
1417
- * @defaultValue false
1418
- *
1419
1417
  * When true, applySnapshot will not check whether any windows in a
1420
1418
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1421
1419
  * 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
- * @defaultValue 'png'
2105
- *
2106
2104
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2105
+ *
2106
+ * @default 'png'
2107
2107
  */
2108
2108
  format?: 'bmp' | 'jpg' | 'png';
2109
2109
  /**
2110
- * @defaultValue 100
2111
- *
2112
2110
  * Quality of JPEG image. Between 0 - 100.
2111
+ *
2112
+ * @default 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
- * @defaultValue true
2767
- *
2768
2766
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2767
+ *
2768
+ * @default true
2769
2769
  */
2770
2770
  wait?: boolean;
2771
2771
  /**
@@ -3427,9 +3427,9 @@ declare interface CloseWindowPayload {
3427
3427
  windowId: Identity_4;
3428
3428
  options: {
3429
3429
  /**
3430
- * @defaultValue false
3431
- *
3432
3430
  * When set to true skips any before handler set on views that are part of the window
3431
+ *
3432
+ * @default false
3433
3433
  */
3434
3434
  skipBeforeUnload?: boolean;
3435
3435
  };
@@ -3537,9 +3537,9 @@ declare type ConstViewOptions = {
3537
3537
  */
3538
3538
  name: string;
3539
3539
  /**
3540
- * @defaultValue "about:blank"
3541
- *
3542
3540
  * The URL of the window
3541
+ *
3542
+ * @default "about:blank"
3543
3543
  */
3544
3544
  url: string;
3545
3545
  /**
@@ -3600,9 +3600,9 @@ declare type ConstViewOptions = {
3600
3600
  experimental: any;
3601
3601
  fdc3InteropApi?: string;
3602
3602
  /**
3603
- * @defaultValue false
3604
- *
3605
3603
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3604
+ *
3605
+ * @default false
3606
3606
  */
3607
3607
  enableBeforeUnload: boolean;
3608
3608
  /**
@@ -3683,13 +3683,12 @@ declare type ConstWindowOptions = {
3683
3683
  */
3684
3684
  backgroundColor: string;
3685
3685
  /**
3686
- * @defaultValue false
3687
- *
3688
3686
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3689
3687
  * This also affects the Page Visibility API.
3690
3688
  *
3691
3689
  * When `true`, the page is throttled whether it is hidden or not.
3692
3690
  *
3691
+ * @default false
3693
3692
  */
3694
3693
  backgroundThrottling: boolean;
3695
3694
  /**
@@ -3713,21 +3712,21 @@ declare type ConstWindowOptions = {
3713
3712
  */
3714
3713
  customRequestHeaders: CustomRequestHeaders[];
3715
3714
  /**
3716
- * @defaultValue true
3717
- *
3718
3715
  * Setting this to false would keep the Window alive even if all its Views were closed.
3719
3716
  * This is meant for advanced users and should be used with caution.
3720
3717
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3721
3718
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3722
3719
  * **NOTE:** - This option is ignored in non-Platforms apps.
3720
+ *
3721
+ * @default true
3723
3722
  */
3724
3723
  closeOnLastViewRemoved: boolean;
3725
3724
  /**
3726
- * @defaultValue 'all'
3727
- *
3728
3725
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3729
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3726
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3730
3727
  * **NOTE:** - This option is ignored in non-Platforms apps.
3728
+ *
3729
+ * @default 'all'
3731
3730
  */
3732
3731
  viewsPreventingClose: 'all' | 'layout';
3733
3732
  /**
@@ -3738,31 +3737,31 @@ declare type ConstWindowOptions = {
3738
3737
  */
3739
3738
  defaultCentered: boolean;
3740
3739
  /**
3741
- * @defaultValue 500
3742
- *
3743
3740
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3744
3741
  * in favor of the cached value.
3742
+ *
3743
+ * @default 500
3745
3744
  */
3746
3745
  defaultHeight: number;
3747
3746
  /**
3748
- * @defaultValue 100
3749
- *
3750
3747
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3751
3748
  * launches in favor of the cached value.
3749
+ *
3750
+ * @default 100
3752
3751
  */
3753
3752
  defaultLeft: number;
3754
3753
  /**
3755
- * @defaultValue 100
3756
- *
3757
3754
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3758
3755
  * launches in favor of the cached value.
3756
+ *
3757
+ * @default 100
3759
3758
  */
3760
3759
  defaultTop: number;
3761
3760
  /**
3762
- * @defaultValue 800
3763
- *
3764
3761
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3765
3762
  * launches in favor of the cached value.
3763
+ *
3764
+ * @default 800
3766
3765
  */
3767
3766
  defaultWidth: number;
3768
3767
  /**
@@ -3808,19 +3807,19 @@ declare type ConstWindowOptions = {
3808
3807
  */
3809
3808
  processAffinity: string;
3810
3809
  /**
3811
- * @defaultValue false
3812
- *
3813
3810
  * Displays a shadow on frameless windows.
3814
3811
  * `shadow` and `cornerRounding` are mutually exclusive.
3815
3812
  * On Windows 7, Aero theme is required.
3813
+ *
3814
+ * @default false
3816
3815
  */
3817
3816
  shadow: boolean;
3818
3817
  /**
3819
- * @defaultValue true
3820
- *
3821
3818
  * Caches the location of the window.
3822
3819
  *
3823
3820
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3821
+ *
3822
+ * @default true
3824
3823
  */
3825
3824
  saveWindowState: boolean;
3826
3825
  /**
@@ -3829,22 +3828,22 @@ declare type ConstWindowOptions = {
3829
3828
  */
3830
3829
  ignoreSavedWindowState: boolean;
3831
3830
  /**
3832
- * @defaultValue false
3833
- *
3834
3831
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3835
3832
  *
3836
3833
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3837
3834
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3835
+ *
3836
+ * @default false
3838
3837
  */
3839
3838
  smallWindow: boolean;
3840
3839
  /**
3841
- * @defaultValue "normal"
3842
- *
3843
3840
  * The visible state of the window on creation.
3844
3841
  * One of:
3845
3842
  * * `"maximized"`
3846
3843
  * * `"minimized"`
3847
3844
  * * `"normal"`
3845
+ *
3846
+ * @default "normal"
3848
3847
  */
3849
3848
  state: WindowState;
3850
3849
  /**
@@ -3859,26 +3858,26 @@ declare type ConstWindowOptions = {
3859
3858
  */
3860
3859
  taskbarIconGroup: string;
3861
3860
  /**
3862
- * @defaultValue "about:blank"
3863
- *
3864
3861
  * The URL of the window
3862
+ *
3863
+ * @default "about:blank"
3865
3864
  */
3866
3865
  url: string;
3867
3866
  /**
3868
- * @defaultValue <application UUID>
3869
- *
3870
3867
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3871
3868
  * If omitted, defaults to the `uuid` of the application spawning the window.
3872
3869
  * If given, must match the `uuid` of the application spawning the window.
3873
3870
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3874
3871
  * really no need to provide it.
3872
+ *
3873
+ * @default <application UUID>
3875
3874
  */
3876
3875
  uuid: string;
3877
3876
  /**
3878
- * @defaultValue false
3879
- *
3880
3877
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3881
3878
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3879
+ *
3880
+ * @default false
3882
3881
  */
3883
3882
  waitForPageLoad: boolean;
3884
3883
  width: number;
@@ -4160,13 +4159,13 @@ declare type CopyBlockedEventReason = 'disabled';
4160
4159
  */
4161
4160
  declare type CopyPermissions = {
4162
4161
  /**
4163
- * @defaultValue 'allowed'
4164
- *
4165
4162
  * Controls the behavior for copy operations for a matched URL.
4166
4163
  *
4167
4164
  * allow: Enables all copy operations.
4168
4165
  * block: Disables all copy operations.
4169
4166
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4167
+ *
4168
+ * @default 'allowed'
4170
4169
  */
4171
4170
  behavior: 'allow' | 'block' | 'protect';
4172
4171
  /**
@@ -4174,9 +4173,9 @@ declare type CopyPermissions = {
4174
4173
  */
4175
4174
  options?: {
4176
4175
  /**
4177
- * @defaultValue ''
4178
- *
4179
4176
  * 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
+ *
4178
+ * @default ''
4180
4179
  */
4181
4180
  replacementText: string;
4182
4181
  };
@@ -4190,15 +4189,15 @@ declare type CopyPermissions = {
4190
4189
  */
4191
4190
  declare type CornerRounding = {
4192
4191
  /**
4193
- * @defaultValue 0
4194
- *
4195
4192
  * The height in pixels.
4193
+ *
4194
+ * @default 0
4196
4195
  */
4197
4196
  height: number;
4198
4197
  /**
4199
- * @defaultValue 0
4200
- *
4201
4198
  * The width in pixels.
4199
+ *
4200
+ * @default 0
4202
4201
  */
4203
4202
  width: number;
4204
4203
  };
@@ -4288,8 +4287,6 @@ declare type CreateLayoutOptions = {
4288
4287
  layoutName: string;
4289
4288
  layout: LayoutOptions;
4290
4289
  /**
4291
- * @defaultValue 'default'
4292
- *
4293
4290
  * Controls the View behavior for the given `layout` property. Note
4294
4291
  * that the selected behavior only applies to unnamed Views or
4295
4292
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4311,6 +4308,8 @@ declare type CreateLayoutOptions = {
4311
4308
  * override. Note that during applyLayoutSnapshot, Views are created and
4312
4309
  * attached to the Provider while the Window is being created, so it's
4313
4310
  * important to not 'duplicate' Views in this workflow.
4311
+ *
4312
+ * @default 'default'
4314
4313
  */
4315
4314
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4316
4315
  };
@@ -4569,7 +4568,7 @@ declare type DomainApiSettings = {
4569
4568
  * * 'none': The `fin` API will be not available.
4570
4569
  * * 'global': The entire `fin` API will be available.
4571
4570
  *
4572
- * @defaultValue 'global'
4571
+ * @default 'global'
4573
4572
  */
4574
4573
  fin?: InjectionType;
4575
4574
  /**
@@ -5168,9 +5167,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
5168
5167
  */
5169
5168
  declare type ExcludeOptions = {
5170
5169
  /**
5171
- * @defaultValue false
5172
- *
5173
5170
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5171
+ *
5172
+ * @default false
5174
5173
  */
5175
5174
  preloadScripts: boolean;
5176
5175
  };
@@ -6015,34 +6014,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
6015
6014
  */
6016
6015
  declare type FindInPageOptions = {
6017
6016
  /**
6018
- * @defaultValue true
6019
- *
6020
6017
  * Searches in the forward direction (backward otherwise)
6018
+ *
6019
+ * @default true
6021
6020
  */
6022
6021
  forward?: boolean;
6023
6022
  /**
6024
- * @defaultValue false
6025
- *
6026
6023
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
6024
+ *
6025
+ * @default false
6027
6026
  */
6028
6027
  findNext?: boolean;
6029
6028
  /**
6030
- * @defaultValue false
6031
- *
6032
6029
  * Enables case-sensitive searching.
6030
+ *
6031
+ * @default false
6033
6032
  */
6034
6033
  matchCase?: boolean;
6035
6034
  /**
6036
- * @defaultValue false
6037
- *
6038
6035
  * Only searches from the start of words.
6036
+ *
6037
+ * @default false
6039
6038
  */
6040
6039
  wordStart?: boolean;
6041
6040
  /**
6042
- * @defaultValue false
6043
- *
6044
6041
  * 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>
6045
6042
  * lowercase or non-letter. Accepts several other intra-word matches.
6043
+ *
6044
+ * @default false
6046
6045
  */
6047
6046
  medialCapitalAsWordStart?: boolean;
6048
6047
  };
@@ -6556,9 +6555,9 @@ declare type Hotkey = {
6556
6555
  */
6557
6556
  keys: string;
6558
6557
  /**
6559
- * @defaultValue false
6560
- *
6561
6558
  * Prevent default key handling before emitting the event.
6559
+ *
6560
+ * @default false
6562
6561
  */
6563
6562
  preventDefault?: boolean;
6564
6563
  };
@@ -9120,77 +9119,79 @@ declare type LayoutOptions = {
9120
9119
  */
9121
9120
  newTabButtonUrl?: string;
9122
9121
  /**
9123
- * @defaultValue false
9124
- *
9125
9122
  * When true the splitters will not be draggable and the layout will not resize.
9123
+ *
9124
+ * @default false
9126
9125
  */
9127
9126
  preventSplitterResize?: boolean;
9128
9127
  /**
9129
- * @defaultValue false
9130
- *
9131
9128
  * Whether the popout button will only act on the entire stack,
9132
9129
  * as opposed to only the active tab.
9130
+ *
9131
+ * @default false
9133
9132
  */
9134
9133
  popoutWholeStack?: boolean;
9135
9134
  /**
9136
- * @defaultValue false
9137
- *
9138
9135
  * Limits the area to which tabs can be dragged.
9139
9136
  * If true, the layout container is the only area where tabs can be dropped.
9137
+ *
9138
+ * @default false
9140
9139
  */
9141
9140
  constrainDragToContainer?: boolean;
9142
9141
  /**
9143
- * @defaultValue false
9144
- *
9145
9142
  * Whether to show the popout button on stack header.
9146
9143
  * The button will create a new window with current tab as its content.
9147
9144
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
9145
+ *
9146
+ * @default false
9148
9147
  */
9149
9148
  showPopoutIcon?: boolean;
9150
9149
  /**
9151
- * @defaultValue false
9152
- *
9153
9150
  * Whether to show the maximize button on stack header.
9154
9151
  * The button will maximize the current tab to fill the entire window.
9152
+ *
9153
+ * @default false
9155
9154
  */
9156
9155
  showMaximiseIcon?: boolean;
9157
9156
  /**
9158
- * @defaultValue false
9159
- *
9160
9157
  * Whether to show the close button on stack header
9161
9158
  * (not to be confused with close button on every tab).
9159
+ *
9160
+ * @default false
9162
9161
  */
9163
9162
  showCloseIcon?: boolean;
9164
9163
  /**
9165
- * @defaultValue false
9166
- *
9167
9164
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
9165
+ *
9166
+ * @default false
9168
9167
  */
9169
9168
  constrainDragToHeaders?: boolean;
9170
9169
  /**
9171
- * @defaultValue true
9172
- *
9173
9170
  * Turns tab headers on or off.
9174
9171
  * If false, the layout will be displayed with splitters only.
9172
+ *
9173
+ * @default true
9175
9174
  */
9176
9175
  hasHeaders?: boolean;
9177
9176
  /**
9178
- * @defaultValue true
9179
- *
9180
9177
  * If true, the user can re-arrange the layout by
9181
9178
  * dragging items by their tabs to the desired location.
9179
+ *
9180
+ * @default true
9182
9181
  */
9183
9182
  reorderEnabled?: boolean;
9184
9183
  /**
9185
- * @defaultValue false
9186
- *
9187
9184
  * If true, tabs can't be dragged out of the window.
9185
+ *
9186
+ * @default false
9188
9187
  */
9189
9188
  preventDragOut?: boolean;
9190
9189
  /**
9191
- * @defaultValue false
9190
+ * @defaultValue=false
9192
9191
  *
9193
9192
  * If true, tabs can't be dragged into the window.
9193
+ *
9194
+ * @default false
9194
9195
  */
9195
9196
  preventDragIn?: boolean;
9196
9197
  /**
@@ -9711,10 +9712,10 @@ declare type MutableViewOptions = {
9711
9712
  /**
9712
9713
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9713
9714
  *
9714
- * @defaultValue true
9715
- *
9716
9715
  * Show the context menu when right-clicking on the view.
9717
9716
  * Gives access to the devtools for the view.
9717
+ *
9718
+ * @default true
9718
9719
  */
9719
9720
  contextMenu: boolean;
9720
9721
  /**
@@ -9761,24 +9762,25 @@ declare type MutableViewOptions = {
9761
9762
  contentNavigation: ContentNavigation;
9762
9763
  contentRedirect: ContentRedirect;
9763
9764
  /**
9764
- * @defaultValue false
9765
9765
  * @deprecated
9766
9766
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9767
9767
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9768
+ *
9769
+ * @default false
9768
9770
  */
9769
9771
  detachOnClose: boolean;
9770
9772
  /**
9771
- * @defaultValue true
9772
- *
9773
9773
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9774
9774
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9775
9775
  * if the view isn't part of the new layout when running `Layout.replace`.
9776
+ *
9777
+ * @default true
9776
9778
  */
9777
9779
  isClosable: boolean;
9778
9780
  /**
9779
- * @defaultValue false
9780
- *
9781
9781
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9782
+ *
9783
+ * @default false
9782
9784
  */
9783
9785
  preventDragOut: boolean;
9784
9786
  interop?: InteropConfig;
@@ -9790,7 +9792,7 @@ declare type MutableViewOptions = {
9790
9792
  /**
9791
9793
  * {@inheritDoc ViewThrottling}
9792
9794
  *
9793
- * @defaultValue 'enabled'
9795
+ * @default 'enabled'
9794
9796
  */
9795
9797
  throttling: ViewThrottling;
9796
9798
  /**
@@ -9818,25 +9820,25 @@ declare type MutableWindowOptions = {
9818
9820
  */
9819
9821
  alphaMask: RGB;
9820
9822
  /**
9821
- * @defaultValue false
9822
- *
9823
9823
  * Always position the window at the top of the window stack.
9824
+ *
9825
+ * @default false
9824
9826
  */
9825
9827
  alwaysOnTop: boolean;
9826
9828
  /**
9827
- * @defaultValue 0
9828
- *
9829
9829
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9830
9830
  * an aspect ratio will not be enforced.
9831
+ *
9832
+ * @default 0
9831
9833
  */
9832
9834
  aspectRatio: number;
9833
9835
  /**
9834
9836
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9835
9837
  *
9836
- * @defaultValue true
9837
- *
9838
9838
  * Show the context menu when right-clicking on the window.
9839
9839
  * Gives access to the devtools for the window.
9840
+ *
9841
+ * @default true
9840
9842
  */
9841
9843
  contextMenu: boolean;
9842
9844
  /**
@@ -9903,16 +9905,17 @@ declare type MutableWindowOptions = {
9903
9905
  */
9904
9906
  customData: any;
9905
9907
  /**
9906
- * @defaultValue true
9907
9908
  * @deprecated Will be removed in runtime version 45
9908
9909
  *
9909
9910
  * Show the window's frame.
9911
+ *
9912
+ * @default true
9910
9913
  */
9911
9914
  frame: boolean;
9912
9915
  /**
9913
- * @defaultValue false
9914
- *
9915
9916
  * Hides the window instead of closing it when the close button is pressed.
9917
+ *
9918
+ * @default false
9916
9919
  */
9917
9920
  hideOnClose: boolean;
9918
9921
  /**
@@ -9965,60 +9968,60 @@ declare type MutableWindowOptions = {
9965
9968
  */
9966
9969
  icon: string;
9967
9970
  /**
9968
- * @defaultValue true
9969
- *
9970
9971
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9971
9972
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9973
+ *
9974
+ * @default true
9972
9975
  */
9973
9976
  includeInSnapshots: boolean;
9974
9977
  /**
9975
- * @defaultValue -1
9976
- *
9977
9978
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9979
+ *
9980
+ * @default -1
9978
9981
  */
9979
9982
  maxHeight: number;
9980
9983
  /**
9981
- * @defaultValue true
9982
- *
9983
9984
  * Allows the window to be maximized.
9985
+ *
9986
+ * @default true
9984
9987
  */
9985
9988
  maximizable: boolean;
9986
9989
  /**
9987
- * @defaultValue -1
9988
- *
9989
9990
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9991
+ *
9992
+ * @default -1
9990
9993
  */
9991
9994
  maxWidth: number;
9992
9995
  /**
9993
- * @defaultValue 0
9994
- *
9995
9996
  * The minimum height of the window.
9997
+ *
9998
+ * @default 0
9996
9999
  */
9997
10000
  minHeight: number;
9998
10001
  /**
9999
- * @defaultValue true
10000
- *
10001
10002
  * Allows the window to be minimized.
10003
+ *
10004
+ * @default true
10002
10005
  */
10003
10006
  minimizable: boolean;
10004
10007
  /**
10005
- * @defaultValue true
10006
- *
10007
10008
  * The minimum width of the window.
10009
+ *
10010
+ * @default true
10008
10011
  */
10009
10012
  minWidth: number;
10010
10013
  /**
10011
- * @defaultValue 1
10012
- *
10013
10014
  * A flag that specifies how transparent the window will be.
10014
10015
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
10015
10016
  * This value is clamped between `0.0` and `1.0`.
10017
+ *
10018
+ * @default 1
10016
10019
  */
10017
10020
  opacity: number;
10018
10021
  /**
10019
- * @defaultValue true
10020
- *
10021
10022
  * A flag to allow the user to resize the window.
10023
+ *
10024
+ * @default true
10022
10025
  */
10023
10026
  resizable: boolean;
10024
10027
  /**
@@ -10026,16 +10029,16 @@ declare type MutableWindowOptions = {
10026
10029
  */
10027
10030
  resizeRegion: ResizeRegion;
10028
10031
  /**
10029
- * @defaultValue false
10030
- *
10031
10032
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
10032
10033
  * This occurs when the window is resizing or a tab is being dragged within the layout.
10034
+ *
10035
+ * @default false
10033
10036
  */
10034
10037
  showBackgroundImages: boolean;
10035
10038
  /**
10036
- * @defaultValue true
10037
- *
10038
10039
  * Shows the window's icon in the taskbar.
10040
+ *
10041
+ * @default true
10039
10042
  */
10040
10043
  showTaskbarIcon: boolean;
10041
10044
  /**
@@ -10062,7 +10065,7 @@ declare type MutableWindowOptions = {
10062
10065
  /**
10063
10066
  * {@inheritDoc WindowThrottling}
10064
10067
  *
10065
- * @defaultValue 'enabled'
10068
+ * @default 'enabled'
10066
10069
  *
10067
10070
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
10068
10071
  */
@@ -10716,12 +10719,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10716
10719
  */
10717
10720
  declare type PastePermissions = {
10718
10721
  /**
10719
- * @defaultValue 'non-protected-content'
10720
- *
10721
10722
  * Controls the behavior for paste operations for a matched URL.
10722
10723
  *
10723
10724
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10724
10725
  * 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.
10726
+ *
10727
+ * @default 'non-protected-content'
10725
10728
  */
10726
10729
  behavior: 'non-protected-content' | 'all-content';
10727
10730
  };
@@ -11791,11 +11794,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11791
11794
  */
11792
11795
  providerUrl?: string;
11793
11796
  /**
11794
- * @defaultValue true
11795
- *
11796
11797
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11797
11798
  *
11798
11799
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11800
+ *
11801
+ * @default true
11799
11802
  */
11800
11803
  allowLaunchIntoPlatform?: boolean;
11801
11804
  };
@@ -12488,22 +12491,22 @@ declare type PopupOptions = {
12488
12491
  url?: string;
12489
12492
  /**
12490
12493
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
12491
- * @defaultValue 300
12494
+ * @default 300
12492
12495
  */
12493
12496
  height?: number;
12494
12497
  /**
12495
12498
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
12496
- * @defaultValue 300
12499
+ * @default 300
12497
12500
  */
12498
12501
  width?: number;
12499
12502
  /**
12500
12503
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12501
- * @defaultValue 0
12504
+ * @default 0
12502
12505
  */
12503
12506
  x?: number;
12504
12507
  /**
12505
12508
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12506
- * @defaultValue 0
12509
+ * @default 0
12507
12510
  */
12508
12511
  y?: number;
12509
12512
  /**
@@ -12511,7 +12514,7 @@ declare type PopupOptions = {
12511
12514
  * * 'modal' restricts resizing and positioning in the caller.
12512
12515
  * * 'hide' hides the popup window on blur.
12513
12516
  * * 'close' closes the popup window on blur.
12514
- * @defaultValue 'close'
12517
+ * @default 'close'
12515
12518
  */
12516
12519
  blurBehavior?: PopupBlurBehavior;
12517
12520
  /**
@@ -12519,19 +12522,19 @@ declare type PopupOptions = {
12519
12522
  * * 'none' will do nothing.
12520
12523
  * * 'hide' hides the popup window on `dispatchPopupResult`.
12521
12524
  * * 'close' closes the popup window on `dispatchPopupResult`.
12522
- * @defaultValue 'close'
12525
+ * @default 'close'
12523
12526
  */
12524
12527
  resultDispatchBehavior?: PopupResultBehavior;
12525
12528
  /**
12526
12529
  * Hide the popup window instead of closing when `close` is called on it.
12527
12530
  *
12528
12531
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
12529
- * @defaultValue false
12532
+ * @default false
12530
12533
  */
12531
12534
  hideOnClose?: boolean;
12532
12535
  /**
12533
12536
  * Determines if the popup window should or should not be focused when it is shown.
12534
- * @defaultValue true
12537
+ * @default true
12535
12538
  */
12536
12539
  focus?: boolean;
12537
12540
  /**
@@ -12625,9 +12628,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12625
12628
  */
12626
12629
  declare type PreloadScript = {
12627
12630
  /**
12628
- * @defaultValue false
12629
- *
12630
12631
  * Fail to load the window if this preload script fails
12632
+ *
12633
+ * @default false
12631
12634
  */
12632
12635
  mandatory?: boolean;
12633
12636
  /**
@@ -12719,15 +12722,15 @@ declare type PrinterInfo = {
12719
12722
  declare type PrintOptions = {
12720
12723
  content?: 'self';
12721
12724
  /**
12722
- * @defaultValue false
12723
- *
12724
12725
  * Disables prompting the user for print settings.
12726
+ *
12727
+ * @default false
12725
12728
  */
12726
12729
  silent?: boolean;
12727
12730
  /**
12728
- * @defaultValue false
12729
- *
12730
12731
  * Includes the webpage background color and image when printing.
12732
+ *
12733
+ * @default false
12731
12734
  */
12732
12735
  printBackground?: boolean;
12733
12736
  /**
@@ -12735,9 +12738,9 @@ declare type PrintOptions = {
12735
12738
  */
12736
12739
  deviceName?: string;
12737
12740
  /**
12738
- * @defaultValue true
12739
- *
12740
12741
  * Prints in full color (greyscale otherwise).
12742
+ *
12743
+ * @default true
12741
12744
  */
12742
12745
  color?: boolean;
12743
12746
  /**
@@ -12745,9 +12748,9 @@ declare type PrintOptions = {
12745
12748
  */
12746
12749
  margins?: Margins;
12747
12750
  /**
12748
- * @defaultValue true
12749
- *
12750
12751
  * Prints in landscape mode (portrait otherwise).
12752
+ *
12753
+ * @default true
12751
12754
  */
12752
12755
  landscape?: boolean;
12753
12756
  /**
@@ -14123,15 +14126,15 @@ declare type ReplaceViewPayload = {
14123
14126
  */
14124
14127
  declare type ResizeRegion = {
14125
14128
  /**
14126
- * @defaultValue 7
14127
- *
14128
14129
  * The size of the resize region in pixels.
14130
+ *
14131
+ * @default 7
14129
14132
  */
14130
14133
  size?: number;
14131
14134
  /**
14132
- * @defaultValue 9
14133
- *
14134
14135
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
14136
+ *
14137
+ * @default 9
14135
14138
  */
14136
14139
  bottomRightCorner?: number;
14137
14140
  /**
@@ -14139,27 +14142,27 @@ declare type ResizeRegion = {
14139
14142
  */
14140
14143
  sides?: {
14141
14144
  /**
14142
- * @defaultValue true
14143
- *
14144
14145
  * Enables resizing from the top of the window.
14146
+ *
14147
+ * @default true
14145
14148
  */
14146
14149
  top?: boolean;
14147
14150
  /**
14148
- * @defaultValue true
14149
- *
14150
14151
  * Enables resizing from the bottom of the window.
14152
+ *
14153
+ * @default true
14151
14154
  */
14152
14155
  bottom?: boolean;
14153
14156
  /**
14154
- * @defaultValue true
14155
- *
14156
14157
  * Enables resizing from the left side of the window.
14158
+ *
14159
+ * @default true
14157
14160
  */
14158
14161
  left?: boolean;
14159
14162
  /**
14160
- * @defaultValue true
14161
- *
14162
14163
  * Enables resizing from the right side of the window.
14164
+ *
14165
+ * @default true
14163
14166
  */
14164
14167
  right?: boolean;
14165
14168
  };
@@ -14713,9 +14716,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
14713
14716
  */
14714
14717
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
14715
14718
  /**
14716
- * @defaultValue 0
14717
- *
14718
14719
  * Number of milliseconds to wait between view repaints.
14720
+ *
14721
+ * @default 0
14719
14722
  */
14720
14723
  paintIntervalMs?: number;
14721
14724
  };
@@ -16408,6 +16411,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
16408
16411
  serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
16409
16412
  /**
16410
16413
  * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
16414
+ * @experimental
16411
16415
  */
16412
16416
  launchLogUploader(options: OpenFin.LogUploaderOptions): Promise<void>;
16413
16417
  }
@@ -16779,9 +16783,9 @@ declare type TransitionBase = {
16779
16783
  */
16780
16784
  duration: number;
16781
16785
  /**
16782
- * @defaultValue false
16783
- *
16784
16786
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16787
+ *
16788
+ * @default false
16785
16789
  */
16786
16790
  relative?: boolean;
16787
16791
  };
@@ -16797,9 +16801,9 @@ declare type TransitionOptions = {
16797
16801
  */
16798
16802
  interrupt: boolean;
16799
16803
  /**
16800
- * @defaultValue false
16801
- *
16802
16804
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16805
+ *
16806
+ * @default false
16803
16807
  */
16804
16808
  relative?: boolean;
16805
16809
  tween?: tween;
@@ -17870,9 +17874,9 @@ declare type ViewTitlePriority = 'document' | 'options';
17870
17874
  */
17871
17875
  declare type ViewVisibilityOption = {
17872
17876
  /**
17873
- * @defaultValue false
17874
- *
17875
17877
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17878
+ *
17879
+ * @default false
17876
17880
  */
17877
17881
  enabled?: boolean;
17878
17882
  };