@openfin/fdc3-api 42.100.97 → 42.100.99
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-alpha.d.ts +231 -201
- package/out/fdc3-api-beta.d.ts +231 -201
- package/out/fdc3-api-public.d.ts +231 -201
- package/out/fdc3-api.d.ts +231 -201
- package/package.json +1 -1
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
|
-
* @
|
|
139
|
+
* @default false
|
|
140
140
|
*/
|
|
141
141
|
crossOriginInjection?: boolean;
|
|
142
142
|
/**
|
|
143
143
|
* Inject OpenFin API into same-origin iframes
|
|
144
144
|
*
|
|
145
|
-
* @
|
|
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
|
/**
|
|
@@ -3062,6 +3062,10 @@ declare type ChromiumPolicies = {
|
|
|
3062
3062
|
* Disable AutofillAddressEnabled policy for a Window or View.
|
|
3063
3063
|
*/
|
|
3064
3064
|
AutofillAddressEnabled?: PolicyOptions;
|
|
3065
|
+
/**
|
|
3066
|
+
* Disable AutofillCreditCardEnabled policy for a Window or View.
|
|
3067
|
+
*/
|
|
3068
|
+
AutofillCreditCardEnabled?: PolicyOptions;
|
|
3065
3069
|
};
|
|
3066
3070
|
|
|
3067
3071
|
declare interface ClassicProtocolOffer extends ProtocolPacketBase {
|
|
@@ -3427,9 +3431,9 @@ declare interface CloseWindowPayload {
|
|
|
3427
3431
|
windowId: Identity_4;
|
|
3428
3432
|
options: {
|
|
3429
3433
|
/**
|
|
3430
|
-
* @defaultValue false
|
|
3431
|
-
*
|
|
3432
3434
|
* When set to true skips any before handler set on views that are part of the window
|
|
3435
|
+
*
|
|
3436
|
+
* @default false
|
|
3433
3437
|
*/
|
|
3434
3438
|
skipBeforeUnload?: boolean;
|
|
3435
3439
|
};
|
|
@@ -3537,9 +3541,9 @@ declare type ConstViewOptions = {
|
|
|
3537
3541
|
*/
|
|
3538
3542
|
name: string;
|
|
3539
3543
|
/**
|
|
3540
|
-
* @defaultValue "about:blank"
|
|
3541
|
-
*
|
|
3542
3544
|
* The URL of the window
|
|
3545
|
+
*
|
|
3546
|
+
* @default "about:blank"
|
|
3543
3547
|
*/
|
|
3544
3548
|
url: string;
|
|
3545
3549
|
/**
|
|
@@ -3564,6 +3568,15 @@ declare type ConstViewOptions = {
|
|
|
3564
3568
|
* Custom headers for requests sent by the view.
|
|
3565
3569
|
*/
|
|
3566
3570
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3571
|
+
/**
|
|
3572
|
+
* @experimental
|
|
3573
|
+
*
|
|
3574
|
+
* When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
|
|
3575
|
+
* These css properties are used to enable dragging of a frameless window.
|
|
3576
|
+
*
|
|
3577
|
+
* @default false
|
|
3578
|
+
*/
|
|
3579
|
+
disableAppRegion: boolean;
|
|
3567
3580
|
/**
|
|
3568
3581
|
* Initial bounds given relative to the window.
|
|
3569
3582
|
*/
|
|
@@ -3600,9 +3613,9 @@ declare type ConstViewOptions = {
|
|
|
3600
3613
|
experimental: any;
|
|
3601
3614
|
fdc3InteropApi?: string;
|
|
3602
3615
|
/**
|
|
3603
|
-
* @defaultValue false
|
|
3604
|
-
*
|
|
3605
3616
|
* When set to `true`, any `beforeunload` handler set on Views will fire.
|
|
3617
|
+
*
|
|
3618
|
+
* @default false
|
|
3606
3619
|
*/
|
|
3607
3620
|
enableBeforeUnload: boolean;
|
|
3608
3621
|
/**
|
|
@@ -3683,13 +3696,12 @@ declare type ConstWindowOptions = {
|
|
|
3683
3696
|
*/
|
|
3684
3697
|
backgroundColor: string;
|
|
3685
3698
|
/**
|
|
3686
|
-
* @defaultValue false
|
|
3687
|
-
*
|
|
3688
3699
|
* Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
|
|
3689
3700
|
* This also affects the Page Visibility API.
|
|
3690
3701
|
*
|
|
3691
3702
|
* When `true`, the page is throttled whether it is hidden or not.
|
|
3692
3703
|
*
|
|
3704
|
+
* @default false
|
|
3693
3705
|
*/
|
|
3694
3706
|
backgroundThrottling: boolean;
|
|
3695
3707
|
/**
|
|
@@ -3713,21 +3725,30 @@ declare type ConstWindowOptions = {
|
|
|
3713
3725
|
*/
|
|
3714
3726
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3715
3727
|
/**
|
|
3716
|
-
* @defaultValue true
|
|
3717
|
-
*
|
|
3718
3728
|
* Setting this to false would keep the Window alive even if all its Views were closed.
|
|
3719
3729
|
* This is meant for advanced users and should be used with caution.
|
|
3720
3730
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
3721
3731
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
3722
3732
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3733
|
+
*
|
|
3734
|
+
* @default true
|
|
3723
3735
|
*/
|
|
3724
3736
|
closeOnLastViewRemoved: boolean;
|
|
3725
3737
|
/**
|
|
3726
|
-
* @
|
|
3738
|
+
* @experimental
|
|
3727
3739
|
*
|
|
3740
|
+
* When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
|
|
3741
|
+
* These css properties are used to enable dragging of a frameless window.
|
|
3742
|
+
*
|
|
3743
|
+
* @default false
|
|
3744
|
+
*/
|
|
3745
|
+
disableAppRegion: boolean;
|
|
3746
|
+
/**
|
|
3728
3747
|
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
|
3729
|
-
|
|
3748
|
+
* Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3730
3749
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3750
|
+
*
|
|
3751
|
+
* @default 'all'
|
|
3731
3752
|
*/
|
|
3732
3753
|
viewsPreventingClose: 'all' | 'layout';
|
|
3733
3754
|
/**
|
|
@@ -3738,31 +3759,31 @@ declare type ConstWindowOptions = {
|
|
|
3738
3759
|
*/
|
|
3739
3760
|
defaultCentered: boolean;
|
|
3740
3761
|
/**
|
|
3741
|
-
* @defaultValue 500
|
|
3742
|
-
*
|
|
3743
3762
|
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
|
3744
3763
|
* in favor of the cached value.
|
|
3764
|
+
*
|
|
3765
|
+
* @default 500
|
|
3745
3766
|
*/
|
|
3746
3767
|
defaultHeight: number;
|
|
3747
3768
|
/**
|
|
3748
|
-
* @defaultValue 100
|
|
3749
|
-
*
|
|
3750
3769
|
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3751
3770
|
* launches in favor of the cached value.
|
|
3771
|
+
*
|
|
3772
|
+
* @default 100
|
|
3752
3773
|
*/
|
|
3753
3774
|
defaultLeft: number;
|
|
3754
3775
|
/**
|
|
3755
|
-
* @defaultValue 100
|
|
3756
|
-
*
|
|
3757
3776
|
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3758
3777
|
* launches in favor of the cached value.
|
|
3778
|
+
*
|
|
3779
|
+
* @default 100
|
|
3759
3780
|
*/
|
|
3760
3781
|
defaultTop: number;
|
|
3761
3782
|
/**
|
|
3762
|
-
* @defaultValue 800
|
|
3763
|
-
*
|
|
3764
3783
|
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3765
3784
|
* launches in favor of the cached value.
|
|
3785
|
+
*
|
|
3786
|
+
* @default 800
|
|
3766
3787
|
*/
|
|
3767
3788
|
defaultWidth: number;
|
|
3768
3789
|
/**
|
|
@@ -3808,19 +3829,19 @@ declare type ConstWindowOptions = {
|
|
|
3808
3829
|
*/
|
|
3809
3830
|
processAffinity: string;
|
|
3810
3831
|
/**
|
|
3811
|
-
* @defaultValue false
|
|
3812
|
-
*
|
|
3813
3832
|
* Displays a shadow on frameless windows.
|
|
3814
3833
|
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
3815
3834
|
* On Windows 7, Aero theme is required.
|
|
3835
|
+
*
|
|
3836
|
+
* @default false
|
|
3816
3837
|
*/
|
|
3817
3838
|
shadow: boolean;
|
|
3818
3839
|
/**
|
|
3819
|
-
* @defaultValue true
|
|
3820
|
-
*
|
|
3821
3840
|
* Caches the location of the window.
|
|
3822
3841
|
*
|
|
3823
3842
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3843
|
+
*
|
|
3844
|
+
* @default true
|
|
3824
3845
|
*/
|
|
3825
3846
|
saveWindowState: boolean;
|
|
3826
3847
|
/**
|
|
@@ -3829,22 +3850,22 @@ declare type ConstWindowOptions = {
|
|
|
3829
3850
|
*/
|
|
3830
3851
|
ignoreSavedWindowState: boolean;
|
|
3831
3852
|
/**
|
|
3832
|
-
* @defaultValue false
|
|
3833
|
-
*
|
|
3834
3853
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3835
3854
|
*
|
|
3836
3855
|
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3837
3856
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3857
|
+
*
|
|
3858
|
+
* @default false
|
|
3838
3859
|
*/
|
|
3839
3860
|
smallWindow: boolean;
|
|
3840
3861
|
/**
|
|
3841
|
-
* @defaultValue "normal"
|
|
3842
|
-
*
|
|
3843
3862
|
* The visible state of the window on creation.
|
|
3844
3863
|
* One of:
|
|
3845
3864
|
* * `"maximized"`
|
|
3846
3865
|
* * `"minimized"`
|
|
3847
3866
|
* * `"normal"`
|
|
3867
|
+
*
|
|
3868
|
+
* @default "normal"
|
|
3848
3869
|
*/
|
|
3849
3870
|
state: WindowState;
|
|
3850
3871
|
/**
|
|
@@ -3859,26 +3880,26 @@ declare type ConstWindowOptions = {
|
|
|
3859
3880
|
*/
|
|
3860
3881
|
taskbarIconGroup: string;
|
|
3861
3882
|
/**
|
|
3862
|
-
* @defaultValue "about:blank"
|
|
3863
|
-
*
|
|
3864
3883
|
* The URL of the window
|
|
3884
|
+
*
|
|
3885
|
+
* @default "about:blank"
|
|
3865
3886
|
*/
|
|
3866
3887
|
url: string;
|
|
3867
3888
|
/**
|
|
3868
|
-
* @defaultValue <application UUID>
|
|
3869
|
-
*
|
|
3870
3889
|
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
3871
3890
|
* If omitted, defaults to the `uuid` of the application spawning the window.
|
|
3872
3891
|
* If given, must match the `uuid` of the application spawning the window.
|
|
3873
3892
|
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
3874
3893
|
* really no need to provide it.
|
|
3894
|
+
*
|
|
3895
|
+
* @default <application UUID>
|
|
3875
3896
|
*/
|
|
3876
3897
|
uuid: string;
|
|
3877
3898
|
/**
|
|
3878
|
-
* @defaultValue false
|
|
3879
|
-
*
|
|
3880
3899
|
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
|
3881
3900
|
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
|
3901
|
+
*
|
|
3902
|
+
* @default false
|
|
3882
3903
|
*/
|
|
3883
3904
|
waitForPageLoad: boolean;
|
|
3884
3905
|
width: number;
|
|
@@ -3898,6 +3919,10 @@ declare type ConstWindowOptions = {
|
|
|
3898
3919
|
* Control which options to ignore when creating a Platform Window.
|
|
3899
3920
|
*/
|
|
3900
3921
|
excludeOptions: ExcludeOptions;
|
|
3922
|
+
/**
|
|
3923
|
+
* 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.
|
|
3924
|
+
*/
|
|
3925
|
+
roundedCorners: boolean;
|
|
3901
3926
|
};
|
|
3902
3927
|
|
|
3903
3928
|
/**
|
|
@@ -4160,13 +4185,13 @@ declare type CopyBlockedEventReason = 'disabled';
|
|
|
4160
4185
|
*/
|
|
4161
4186
|
declare type CopyPermissions = {
|
|
4162
4187
|
/**
|
|
4163
|
-
* @defaultValue 'allowed'
|
|
4164
|
-
*
|
|
4165
4188
|
* Controls the behavior for copy operations for a matched URL.
|
|
4166
4189
|
*
|
|
4167
4190
|
* allow: Enables all copy operations.
|
|
4168
4191
|
* block: Disables all copy operations.
|
|
4169
4192
|
* protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
|
|
4193
|
+
*
|
|
4194
|
+
* @default 'allowed'
|
|
4170
4195
|
*/
|
|
4171
4196
|
behavior: 'allow' | 'block' | 'protect';
|
|
4172
4197
|
/**
|
|
@@ -4174,9 +4199,9 @@ declare type CopyPermissions = {
|
|
|
4174
4199
|
*/
|
|
4175
4200
|
options?: {
|
|
4176
4201
|
/**
|
|
4177
|
-
* @defaultValue ''
|
|
4178
|
-
*
|
|
4179
4202
|
* When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
|
|
4203
|
+
*
|
|
4204
|
+
* @default ''
|
|
4180
4205
|
*/
|
|
4181
4206
|
replacementText: string;
|
|
4182
4207
|
};
|
|
@@ -4190,15 +4215,15 @@ declare type CopyPermissions = {
|
|
|
4190
4215
|
*/
|
|
4191
4216
|
declare type CornerRounding = {
|
|
4192
4217
|
/**
|
|
4193
|
-
* @defaultValue 0
|
|
4194
|
-
*
|
|
4195
4218
|
* The height in pixels.
|
|
4219
|
+
*
|
|
4220
|
+
* @default 0
|
|
4196
4221
|
*/
|
|
4197
4222
|
height: number;
|
|
4198
4223
|
/**
|
|
4199
|
-
* @defaultValue 0
|
|
4200
|
-
*
|
|
4201
4224
|
* The width in pixels.
|
|
4225
|
+
*
|
|
4226
|
+
* @default 0
|
|
4202
4227
|
*/
|
|
4203
4228
|
width: number;
|
|
4204
4229
|
};
|
|
@@ -4288,8 +4313,6 @@ declare type CreateLayoutOptions = {
|
|
|
4288
4313
|
layoutName: string;
|
|
4289
4314
|
layout: LayoutOptions;
|
|
4290
4315
|
/**
|
|
4291
|
-
* @defaultValue 'default'
|
|
4292
|
-
*
|
|
4293
4316
|
* Controls the View behavior for the given `layout` property. Note
|
|
4294
4317
|
* that the selected behavior only applies to unnamed Views or
|
|
4295
4318
|
* Views with the prefix `internal-generated-`. In all cases, if any
|
|
@@ -4311,6 +4334,8 @@ declare type CreateLayoutOptions = {
|
|
|
4311
4334
|
* override. Note that during applyLayoutSnapshot, Views are created and
|
|
4312
4335
|
* attached to the Provider while the Window is being created, so it's
|
|
4313
4336
|
* important to not 'duplicate' Views in this workflow.
|
|
4337
|
+
*
|
|
4338
|
+
* @default 'default'
|
|
4314
4339
|
*/
|
|
4315
4340
|
multiInstanceViewBehavior?: MultiInstanceViewBehavior;
|
|
4316
4341
|
};
|
|
@@ -4569,7 +4594,7 @@ declare type DomainApiSettings = {
|
|
|
4569
4594
|
* * 'none': The `fin` API will be not available.
|
|
4570
4595
|
* * 'global': The entire `fin` API will be available.
|
|
4571
4596
|
*
|
|
4572
|
-
* @
|
|
4597
|
+
* @default 'global'
|
|
4573
4598
|
*/
|
|
4574
4599
|
fin?: InjectionType;
|
|
4575
4600
|
/**
|
|
@@ -5168,9 +5193,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
|
|
|
5168
5193
|
*/
|
|
5169
5194
|
declare type ExcludeOptions = {
|
|
5170
5195
|
/**
|
|
5171
|
-
* @defaultValue false
|
|
5172
|
-
*
|
|
5173
5196
|
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
|
5197
|
+
*
|
|
5198
|
+
* @default false
|
|
5174
5199
|
*/
|
|
5175
5200
|
preloadScripts: boolean;
|
|
5176
5201
|
};
|
|
@@ -6015,34 +6040,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
6015
6040
|
*/
|
|
6016
6041
|
declare type FindInPageOptions = {
|
|
6017
6042
|
/**
|
|
6018
|
-
* @defaultValue true
|
|
6019
|
-
*
|
|
6020
6043
|
* Searches in the forward direction (backward otherwise)
|
|
6044
|
+
*
|
|
6045
|
+
* @default true
|
|
6021
6046
|
*/
|
|
6022
6047
|
forward?: boolean;
|
|
6023
6048
|
/**
|
|
6024
|
-
* @defaultValue false
|
|
6025
|
-
*
|
|
6026
6049
|
* Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
|
|
6050
|
+
*
|
|
6051
|
+
* @default false
|
|
6027
6052
|
*/
|
|
6028
6053
|
findNext?: boolean;
|
|
6029
6054
|
/**
|
|
6030
|
-
* @defaultValue false
|
|
6031
|
-
*
|
|
6032
6055
|
* Enables case-sensitive searching.
|
|
6056
|
+
*
|
|
6057
|
+
* @default false
|
|
6033
6058
|
*/
|
|
6034
6059
|
matchCase?: boolean;
|
|
6035
6060
|
/**
|
|
6036
|
-
* @defaultValue false
|
|
6037
|
-
*
|
|
6038
6061
|
* Only searches from the start of words.
|
|
6062
|
+
*
|
|
6063
|
+
* @default false
|
|
6039
6064
|
*/
|
|
6040
6065
|
wordStart?: boolean;
|
|
6041
6066
|
/**
|
|
6042
|
-
* @defaultValue false
|
|
6043
|
-
*
|
|
6044
6067
|
* 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
6068
|
* lowercase or non-letter. Accepts several other intra-word matches.
|
|
6069
|
+
*
|
|
6070
|
+
* @default false
|
|
6046
6071
|
*/
|
|
6047
6072
|
medialCapitalAsWordStart?: boolean;
|
|
6048
6073
|
};
|
|
@@ -6556,9 +6581,9 @@ declare type Hotkey = {
|
|
|
6556
6581
|
*/
|
|
6557
6582
|
keys: string;
|
|
6558
6583
|
/**
|
|
6559
|
-
* @defaultValue false
|
|
6560
|
-
*
|
|
6561
6584
|
* Prevent default key handling before emitting the event.
|
|
6585
|
+
*
|
|
6586
|
+
* @default false
|
|
6562
6587
|
*/
|
|
6563
6588
|
preventDefault?: boolean;
|
|
6564
6589
|
};
|
|
@@ -9120,77 +9145,79 @@ declare type LayoutOptions = {
|
|
|
9120
9145
|
*/
|
|
9121
9146
|
newTabButtonUrl?: string;
|
|
9122
9147
|
/**
|
|
9123
|
-
* @defaultValue false
|
|
9124
|
-
*
|
|
9125
9148
|
* When true the splitters will not be draggable and the layout will not resize.
|
|
9149
|
+
*
|
|
9150
|
+
* @default false
|
|
9126
9151
|
*/
|
|
9127
9152
|
preventSplitterResize?: boolean;
|
|
9128
9153
|
/**
|
|
9129
|
-
* @defaultValue false
|
|
9130
|
-
*
|
|
9131
9154
|
* Whether the popout button will only act on the entire stack,
|
|
9132
9155
|
* as opposed to only the active tab.
|
|
9156
|
+
*
|
|
9157
|
+
* @default false
|
|
9133
9158
|
*/
|
|
9134
9159
|
popoutWholeStack?: boolean;
|
|
9135
9160
|
/**
|
|
9136
|
-
* @defaultValue false
|
|
9137
|
-
*
|
|
9138
9161
|
* Limits the area to which tabs can be dragged.
|
|
9139
9162
|
* If true, the layout container is the only area where tabs can be dropped.
|
|
9163
|
+
*
|
|
9164
|
+
* @default false
|
|
9140
9165
|
*/
|
|
9141
9166
|
constrainDragToContainer?: boolean;
|
|
9142
9167
|
/**
|
|
9143
|
-
* @defaultValue false
|
|
9144
|
-
*
|
|
9145
9168
|
* Whether to show the popout button on stack header.
|
|
9146
9169
|
* The button will create a new window with current tab as its content.
|
|
9147
9170
|
* In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
|
|
9171
|
+
*
|
|
9172
|
+
* @default false
|
|
9148
9173
|
*/
|
|
9149
9174
|
showPopoutIcon?: boolean;
|
|
9150
9175
|
/**
|
|
9151
|
-
* @defaultValue false
|
|
9152
|
-
*
|
|
9153
9176
|
* Whether to show the maximize button on stack header.
|
|
9154
9177
|
* The button will maximize the current tab to fill the entire window.
|
|
9178
|
+
*
|
|
9179
|
+
* @default false
|
|
9155
9180
|
*/
|
|
9156
9181
|
showMaximiseIcon?: boolean;
|
|
9157
9182
|
/**
|
|
9158
|
-
* @defaultValue false
|
|
9159
|
-
*
|
|
9160
9183
|
* Whether to show the close button on stack header
|
|
9161
9184
|
* (not to be confused with close button on every tab).
|
|
9185
|
+
*
|
|
9186
|
+
* @default false
|
|
9162
9187
|
*/
|
|
9163
9188
|
showCloseIcon?: boolean;
|
|
9164
9189
|
/**
|
|
9165
|
-
* @defaultValue false
|
|
9166
|
-
*
|
|
9167
9190
|
* Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
|
|
9191
|
+
*
|
|
9192
|
+
* @default false
|
|
9168
9193
|
*/
|
|
9169
9194
|
constrainDragToHeaders?: boolean;
|
|
9170
9195
|
/**
|
|
9171
|
-
* @defaultValue true
|
|
9172
|
-
*
|
|
9173
9196
|
* Turns tab headers on or off.
|
|
9174
9197
|
* If false, the layout will be displayed with splitters only.
|
|
9198
|
+
*
|
|
9199
|
+
* @default true
|
|
9175
9200
|
*/
|
|
9176
9201
|
hasHeaders?: boolean;
|
|
9177
9202
|
/**
|
|
9178
|
-
* @defaultValue true
|
|
9179
|
-
*
|
|
9180
9203
|
* If true, the user can re-arrange the layout by
|
|
9181
9204
|
* dragging items by their tabs to the desired location.
|
|
9205
|
+
*
|
|
9206
|
+
* @default true
|
|
9182
9207
|
*/
|
|
9183
9208
|
reorderEnabled?: boolean;
|
|
9184
9209
|
/**
|
|
9185
|
-
* @defaultValue false
|
|
9186
|
-
*
|
|
9187
9210
|
* If true, tabs can't be dragged out of the window.
|
|
9211
|
+
*
|
|
9212
|
+
* @default false
|
|
9188
9213
|
*/
|
|
9189
9214
|
preventDragOut?: boolean;
|
|
9190
9215
|
/**
|
|
9191
|
-
* @defaultValue
|
|
9216
|
+
* @defaultValue=false
|
|
9192
9217
|
*
|
|
9193
9218
|
* If true, tabs can't be dragged into the window.
|
|
9219
|
+
*
|
|
9220
|
+
* @default false
|
|
9194
9221
|
*/
|
|
9195
9222
|
preventDragIn?: boolean;
|
|
9196
9223
|
/**
|
|
@@ -9711,10 +9738,10 @@ declare type MutableViewOptions = {
|
|
|
9711
9738
|
/**
|
|
9712
9739
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9713
9740
|
*
|
|
9714
|
-
* @defaultValue true
|
|
9715
|
-
*
|
|
9716
9741
|
* Show the context menu when right-clicking on the view.
|
|
9717
9742
|
* Gives access to the devtools for the view.
|
|
9743
|
+
*
|
|
9744
|
+
* @default true
|
|
9718
9745
|
*/
|
|
9719
9746
|
contextMenu: boolean;
|
|
9720
9747
|
/**
|
|
@@ -9761,24 +9788,25 @@ declare type MutableViewOptions = {
|
|
|
9761
9788
|
contentNavigation: ContentNavigation;
|
|
9762
9789
|
contentRedirect: ContentRedirect;
|
|
9763
9790
|
/**
|
|
9764
|
-
* @defaultValue false
|
|
9765
9791
|
* @deprecated
|
|
9766
9792
|
* **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
|
|
9767
9793
|
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
|
9794
|
+
*
|
|
9795
|
+
* @default false
|
|
9768
9796
|
*/
|
|
9769
9797
|
detachOnClose: boolean;
|
|
9770
9798
|
/**
|
|
9771
|
-
* @defaultValue true
|
|
9772
|
-
*
|
|
9773
9799
|
* **Platforms Only.** If false, the view will be persistent and can't be closed through
|
|
9774
9800
|
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
|
9775
9801
|
* if the view isn't part of the new layout when running `Layout.replace`.
|
|
9802
|
+
*
|
|
9803
|
+
* @default true
|
|
9776
9804
|
*/
|
|
9777
9805
|
isClosable: boolean;
|
|
9778
9806
|
/**
|
|
9779
|
-
* @defaultValue false
|
|
9780
|
-
*
|
|
9781
9807
|
* **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
|
9808
|
+
*
|
|
9809
|
+
* @default false
|
|
9782
9810
|
*/
|
|
9783
9811
|
preventDragOut: boolean;
|
|
9784
9812
|
interop?: InteropConfig;
|
|
@@ -9790,7 +9818,7 @@ declare type MutableViewOptions = {
|
|
|
9790
9818
|
/**
|
|
9791
9819
|
* {@inheritDoc ViewThrottling}
|
|
9792
9820
|
*
|
|
9793
|
-
* @
|
|
9821
|
+
* @default 'enabled'
|
|
9794
9822
|
*/
|
|
9795
9823
|
throttling: ViewThrottling;
|
|
9796
9824
|
/**
|
|
@@ -9809,7 +9837,7 @@ declare type MutableWindowOptions = {
|
|
|
9809
9837
|
* Turns anything of matching RGB value transparent.
|
|
9810
9838
|
*
|
|
9811
9839
|
* Caveats:
|
|
9812
|
-
* *
|
|
9840
|
+
* * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
|
|
9813
9841
|
* * User cannot click-through transparent regions
|
|
9814
9842
|
* * Not supported on Mac
|
|
9815
9843
|
* * Windows Aero must be enabled
|
|
@@ -9818,25 +9846,25 @@ declare type MutableWindowOptions = {
|
|
|
9818
9846
|
*/
|
|
9819
9847
|
alphaMask: RGB;
|
|
9820
9848
|
/**
|
|
9821
|
-
* @defaultValue false
|
|
9822
|
-
*
|
|
9823
9849
|
* Always position the window at the top of the window stack.
|
|
9850
|
+
*
|
|
9851
|
+
* @default false
|
|
9824
9852
|
*/
|
|
9825
9853
|
alwaysOnTop: boolean;
|
|
9826
9854
|
/**
|
|
9827
|
-
* @defaultValue 0
|
|
9828
|
-
*
|
|
9829
9855
|
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
|
9830
9856
|
* an aspect ratio will not be enforced.
|
|
9857
|
+
*
|
|
9858
|
+
* @default 0
|
|
9831
9859
|
*/
|
|
9832
9860
|
aspectRatio: number;
|
|
9833
9861
|
/**
|
|
9834
9862
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9835
9863
|
*
|
|
9836
|
-
* @defaultValue true
|
|
9837
|
-
*
|
|
9838
9864
|
* Show the context menu when right-clicking on the window.
|
|
9839
9865
|
* Gives access to the devtools for the window.
|
|
9866
|
+
*
|
|
9867
|
+
* @default true
|
|
9840
9868
|
*/
|
|
9841
9869
|
contextMenu: boolean;
|
|
9842
9870
|
/**
|
|
@@ -9903,16 +9931,17 @@ declare type MutableWindowOptions = {
|
|
|
9903
9931
|
*/
|
|
9904
9932
|
customData: any;
|
|
9905
9933
|
/**
|
|
9906
|
-
* @defaultValue true
|
|
9907
9934
|
* @deprecated Will be removed in runtime version 45
|
|
9908
9935
|
*
|
|
9909
9936
|
* Show the window's frame.
|
|
9937
|
+
*
|
|
9938
|
+
* @default true
|
|
9910
9939
|
*/
|
|
9911
9940
|
frame: boolean;
|
|
9912
9941
|
/**
|
|
9913
|
-
* @defaultValue false
|
|
9914
|
-
*
|
|
9915
9942
|
* Hides the window instead of closing it when the close button is pressed.
|
|
9943
|
+
*
|
|
9944
|
+
* @default false
|
|
9916
9945
|
*/
|
|
9917
9946
|
hideOnClose: boolean;
|
|
9918
9947
|
/**
|
|
@@ -9965,60 +9994,61 @@ declare type MutableWindowOptions = {
|
|
|
9965
9994
|
*/
|
|
9966
9995
|
icon: string;
|
|
9967
9996
|
/**
|
|
9968
|
-
* @defaultValue true
|
|
9969
|
-
*
|
|
9970
9997
|
* Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
|
9971
9998
|
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
|
9999
|
+
*
|
|
10000
|
+
* @default true
|
|
9972
10001
|
*/
|
|
9973
10002
|
includeInSnapshots: boolean;
|
|
9974
10003
|
/**
|
|
9975
|
-
* @defaultValue -1
|
|
9976
|
-
*
|
|
9977
10004
|
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
|
10005
|
+
*
|
|
10006
|
+
* @default -1
|
|
9978
10007
|
*/
|
|
9979
10008
|
maxHeight: number;
|
|
9980
10009
|
/**
|
|
9981
|
-
* @defaultValue true
|
|
9982
|
-
*
|
|
9983
10010
|
* Allows the window to be maximized.
|
|
10011
|
+
*
|
|
10012
|
+
* @default true
|
|
9984
10013
|
*/
|
|
9985
10014
|
maximizable: boolean;
|
|
9986
10015
|
/**
|
|
9987
|
-
* @defaultValue -1
|
|
9988
|
-
*
|
|
9989
10016
|
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
|
10017
|
+
*
|
|
10018
|
+
* @default -1
|
|
9990
10019
|
*/
|
|
9991
10020
|
maxWidth: number;
|
|
9992
10021
|
/**
|
|
9993
|
-
* @defaultValue 0
|
|
9994
|
-
*
|
|
9995
10022
|
* The minimum height of the window.
|
|
10023
|
+
*
|
|
10024
|
+
* @default 0
|
|
9996
10025
|
*/
|
|
9997
10026
|
minHeight: number;
|
|
9998
10027
|
/**
|
|
9999
|
-
* @defaultValue true
|
|
10000
|
-
*
|
|
10001
10028
|
* Allows the window to be minimized.
|
|
10029
|
+
*
|
|
10030
|
+
* @default true
|
|
10002
10031
|
*/
|
|
10003
10032
|
minimizable: boolean;
|
|
10004
10033
|
/**
|
|
10005
|
-
* @defaultValue true
|
|
10006
|
-
*
|
|
10007
10034
|
* The minimum width of the window.
|
|
10035
|
+
*
|
|
10036
|
+
* @default true
|
|
10008
10037
|
*/
|
|
10009
10038
|
minWidth: number;
|
|
10010
10039
|
/**
|
|
10011
|
-
* @defaultValue 1
|
|
10012
|
-
*
|
|
10013
10040
|
* A flag that specifies how transparent the window will be.
|
|
10014
10041
|
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
|
10015
10042
|
* This value is clamped between `0.0` and `1.0`.
|
|
10043
|
+
* In software composition mode, the runtime flag --allow-unsafe-compositing is required.
|
|
10044
|
+
*
|
|
10045
|
+
* @default 1
|
|
10016
10046
|
*/
|
|
10017
10047
|
opacity: number;
|
|
10018
10048
|
/**
|
|
10019
|
-
* @defaultValue true
|
|
10020
|
-
*
|
|
10021
10049
|
* A flag to allow the user to resize the window.
|
|
10050
|
+
*
|
|
10051
|
+
* @default true
|
|
10022
10052
|
*/
|
|
10023
10053
|
resizable: boolean;
|
|
10024
10054
|
/**
|
|
@@ -10026,16 +10056,16 @@ declare type MutableWindowOptions = {
|
|
|
10026
10056
|
*/
|
|
10027
10057
|
resizeRegion: ResizeRegion;
|
|
10028
10058
|
/**
|
|
10029
|
-
* @defaultValue false
|
|
10030
|
-
*
|
|
10031
10059
|
* **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
|
|
10032
10060
|
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
|
10061
|
+
*
|
|
10062
|
+
* @default false
|
|
10033
10063
|
*/
|
|
10034
10064
|
showBackgroundImages: boolean;
|
|
10035
10065
|
/**
|
|
10036
|
-
* @defaultValue true
|
|
10037
|
-
*
|
|
10038
10066
|
* Shows the window's icon in the taskbar.
|
|
10067
|
+
*
|
|
10068
|
+
* @default true
|
|
10039
10069
|
*/
|
|
10040
10070
|
showTaskbarIcon: boolean;
|
|
10041
10071
|
/**
|
|
@@ -10062,7 +10092,7 @@ declare type MutableWindowOptions = {
|
|
|
10062
10092
|
/**
|
|
10063
10093
|
* {@inheritDoc WindowThrottling}
|
|
10064
10094
|
*
|
|
10065
|
-
* @
|
|
10095
|
+
* @default 'enabled'
|
|
10066
10096
|
*
|
|
10067
10097
|
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
|
10068
10098
|
*/
|
|
@@ -10716,12 +10746,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
|
|
|
10716
10746
|
*/
|
|
10717
10747
|
declare type PastePermissions = {
|
|
10718
10748
|
/**
|
|
10719
|
-
* @defaultValue 'non-protected-content'
|
|
10720
|
-
*
|
|
10721
10749
|
* Controls the behavior for paste operations for a matched URL.
|
|
10722
10750
|
*
|
|
10723
10751
|
* non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
|
|
10724
10752
|
* 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.
|
|
10753
|
+
*
|
|
10754
|
+
* @default 'non-protected-content'
|
|
10725
10755
|
*/
|
|
10726
10756
|
behavior: 'non-protected-content' | 'all-content';
|
|
10727
10757
|
};
|
|
@@ -11791,11 +11821,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
11791
11821
|
*/
|
|
11792
11822
|
providerUrl?: string;
|
|
11793
11823
|
/**
|
|
11794
|
-
* @defaultValue true
|
|
11795
|
-
*
|
|
11796
11824
|
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
|
11797
11825
|
*
|
|
11798
11826
|
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
|
11827
|
+
*
|
|
11828
|
+
* @default true
|
|
11799
11829
|
*/
|
|
11800
11830
|
allowLaunchIntoPlatform?: boolean;
|
|
11801
11831
|
};
|
|
@@ -12488,22 +12518,22 @@ declare type PopupOptions = {
|
|
|
12488
12518
|
url?: string;
|
|
12489
12519
|
/**
|
|
12490
12520
|
* Height of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12491
|
-
* @
|
|
12521
|
+
* @default 300
|
|
12492
12522
|
*/
|
|
12493
12523
|
height?: number;
|
|
12494
12524
|
/**
|
|
12495
12525
|
* Width of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12496
|
-
* @
|
|
12526
|
+
* @default 300
|
|
12497
12527
|
*/
|
|
12498
12528
|
width?: number;
|
|
12499
12529
|
/**
|
|
12500
12530
|
* Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12501
|
-
* @
|
|
12531
|
+
* @default 0
|
|
12502
12532
|
*/
|
|
12503
12533
|
x?: number;
|
|
12504
12534
|
/**
|
|
12505
12535
|
* Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12506
|
-
* @
|
|
12536
|
+
* @default 0
|
|
12507
12537
|
*/
|
|
12508
12538
|
y?: number;
|
|
12509
12539
|
/**
|
|
@@ -12511,7 +12541,7 @@ declare type PopupOptions = {
|
|
|
12511
12541
|
* * 'modal' restricts resizing and positioning in the caller.
|
|
12512
12542
|
* * 'hide' hides the popup window on blur.
|
|
12513
12543
|
* * 'close' closes the popup window on blur.
|
|
12514
|
-
* @
|
|
12544
|
+
* @default 'close'
|
|
12515
12545
|
*/
|
|
12516
12546
|
blurBehavior?: PopupBlurBehavior;
|
|
12517
12547
|
/**
|
|
@@ -12519,19 +12549,19 @@ declare type PopupOptions = {
|
|
|
12519
12549
|
* * 'none' will do nothing.
|
|
12520
12550
|
* * 'hide' hides the popup window on `dispatchPopupResult`.
|
|
12521
12551
|
* * 'close' closes the popup window on `dispatchPopupResult`.
|
|
12522
|
-
* @
|
|
12552
|
+
* @default 'close'
|
|
12523
12553
|
*/
|
|
12524
12554
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
12525
12555
|
/**
|
|
12526
12556
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
12527
12557
|
*
|
|
12528
12558
|
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
12529
|
-
* @
|
|
12559
|
+
* @default false
|
|
12530
12560
|
*/
|
|
12531
12561
|
hideOnClose?: boolean;
|
|
12532
12562
|
/**
|
|
12533
12563
|
* Determines if the popup window should or should not be focused when it is shown.
|
|
12534
|
-
* @
|
|
12564
|
+
* @default true
|
|
12535
12565
|
*/
|
|
12536
12566
|
focus?: boolean;
|
|
12537
12567
|
/**
|
|
@@ -12625,9 +12655,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
|
|
|
12625
12655
|
*/
|
|
12626
12656
|
declare type PreloadScript = {
|
|
12627
12657
|
/**
|
|
12628
|
-
* @defaultValue false
|
|
12629
|
-
*
|
|
12630
12658
|
* Fail to load the window if this preload script fails
|
|
12659
|
+
*
|
|
12660
|
+
* @default false
|
|
12631
12661
|
*/
|
|
12632
12662
|
mandatory?: boolean;
|
|
12633
12663
|
/**
|
|
@@ -12719,15 +12749,15 @@ declare type PrinterInfo = {
|
|
|
12719
12749
|
declare type PrintOptions = {
|
|
12720
12750
|
content?: 'self';
|
|
12721
12751
|
/**
|
|
12722
|
-
* @defaultValue false
|
|
12723
|
-
*
|
|
12724
12752
|
* Disables prompting the user for print settings.
|
|
12753
|
+
*
|
|
12754
|
+
* @default false
|
|
12725
12755
|
*/
|
|
12726
12756
|
silent?: boolean;
|
|
12727
12757
|
/**
|
|
12728
|
-
* @defaultValue false
|
|
12729
|
-
*
|
|
12730
12758
|
* Includes the webpage background color and image when printing.
|
|
12759
|
+
*
|
|
12760
|
+
* @default false
|
|
12731
12761
|
*/
|
|
12732
12762
|
printBackground?: boolean;
|
|
12733
12763
|
/**
|
|
@@ -12735,9 +12765,9 @@ declare type PrintOptions = {
|
|
|
12735
12765
|
*/
|
|
12736
12766
|
deviceName?: string;
|
|
12737
12767
|
/**
|
|
12738
|
-
* @defaultValue true
|
|
12739
|
-
*
|
|
12740
12768
|
* Prints in full color (greyscale otherwise).
|
|
12769
|
+
*
|
|
12770
|
+
* @default true
|
|
12741
12771
|
*/
|
|
12742
12772
|
color?: boolean;
|
|
12743
12773
|
/**
|
|
@@ -12745,9 +12775,9 @@ declare type PrintOptions = {
|
|
|
12745
12775
|
*/
|
|
12746
12776
|
margins?: Margins;
|
|
12747
12777
|
/**
|
|
12748
|
-
* @defaultValue true
|
|
12749
|
-
*
|
|
12750
12778
|
* Prints in landscape mode (portrait otherwise).
|
|
12779
|
+
*
|
|
12780
|
+
* @default true
|
|
12751
12781
|
*/
|
|
12752
12782
|
landscape?: boolean;
|
|
12753
12783
|
/**
|
|
@@ -14123,15 +14153,15 @@ declare type ReplaceViewPayload = {
|
|
|
14123
14153
|
*/
|
|
14124
14154
|
declare type ResizeRegion = {
|
|
14125
14155
|
/**
|
|
14126
|
-
* @defaultValue 7
|
|
14127
|
-
*
|
|
14128
14156
|
* The size of the resize region in pixels.
|
|
14157
|
+
*
|
|
14158
|
+
* @default 7
|
|
14129
14159
|
*/
|
|
14130
14160
|
size?: number;
|
|
14131
14161
|
/**
|
|
14132
|
-
* @defaultValue 9
|
|
14133
|
-
*
|
|
14134
14162
|
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
|
14163
|
+
*
|
|
14164
|
+
* @default 9
|
|
14135
14165
|
*/
|
|
14136
14166
|
bottomRightCorner?: number;
|
|
14137
14167
|
/**
|
|
@@ -14139,27 +14169,27 @@ declare type ResizeRegion = {
|
|
|
14139
14169
|
*/
|
|
14140
14170
|
sides?: {
|
|
14141
14171
|
/**
|
|
14142
|
-
* @defaultValue true
|
|
14143
|
-
*
|
|
14144
14172
|
* Enables resizing from the top of the window.
|
|
14173
|
+
*
|
|
14174
|
+
* @default true
|
|
14145
14175
|
*/
|
|
14146
14176
|
top?: boolean;
|
|
14147
14177
|
/**
|
|
14148
|
-
* @defaultValue true
|
|
14149
|
-
*
|
|
14150
14178
|
* Enables resizing from the bottom of the window.
|
|
14179
|
+
*
|
|
14180
|
+
* @default true
|
|
14151
14181
|
*/
|
|
14152
14182
|
bottom?: boolean;
|
|
14153
14183
|
/**
|
|
14154
|
-
* @defaultValue true
|
|
14155
|
-
*
|
|
14156
14184
|
* Enables resizing from the left side of the window.
|
|
14185
|
+
*
|
|
14186
|
+
* @default true
|
|
14157
14187
|
*/
|
|
14158
14188
|
left?: boolean;
|
|
14159
14189
|
/**
|
|
14160
|
-
* @defaultValue true
|
|
14161
|
-
*
|
|
14162
14190
|
* Enables resizing from the right side of the window.
|
|
14191
|
+
*
|
|
14192
|
+
* @default true
|
|
14163
14193
|
*/
|
|
14164
14194
|
right?: boolean;
|
|
14165
14195
|
};
|
|
@@ -14713,9 +14743,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
|
|
|
14713
14743
|
*/
|
|
14714
14744
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
14715
14745
|
/**
|
|
14716
|
-
* @defaultValue 0
|
|
14717
|
-
*
|
|
14718
14746
|
* Number of milliseconds to wait between view repaints.
|
|
14747
|
+
*
|
|
14748
|
+
* @default 0
|
|
14719
14749
|
*/
|
|
14720
14750
|
paintIntervalMs?: number;
|
|
14721
14751
|
};
|
|
@@ -16780,9 +16810,9 @@ declare type TransitionBase = {
|
|
|
16780
16810
|
*/
|
|
16781
16811
|
duration: number;
|
|
16782
16812
|
/**
|
|
16783
|
-
* @defaultValue false
|
|
16784
|
-
*
|
|
16785
16813
|
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16814
|
+
*
|
|
16815
|
+
* @default false
|
|
16786
16816
|
*/
|
|
16787
16817
|
relative?: boolean;
|
|
16788
16818
|
};
|
|
@@ -16798,9 +16828,9 @@ declare type TransitionOptions = {
|
|
|
16798
16828
|
*/
|
|
16799
16829
|
interrupt: boolean;
|
|
16800
16830
|
/**
|
|
16801
|
-
* @defaultValue false
|
|
16802
|
-
*
|
|
16803
16831
|
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16832
|
+
*
|
|
16833
|
+
* @default false
|
|
16804
16834
|
*/
|
|
16805
16835
|
relative?: boolean;
|
|
16806
16836
|
tween?: tween;
|
|
@@ -17871,9 +17901,9 @@ declare type ViewTitlePriority = 'document' | 'options';
|
|
|
17871
17901
|
*/
|
|
17872
17902
|
declare type ViewVisibilityOption = {
|
|
17873
17903
|
/**
|
|
17874
|
-
* @defaultValue false
|
|
17875
|
-
*
|
|
17876
17904
|
* Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
|
|
17905
|
+
*
|
|
17906
|
+
* @default false
|
|
17877
17907
|
*/
|
|
17878
17908
|
enabled?: boolean;
|
|
17879
17909
|
};
|