@openfin/fdc3-api 41.103.3 → 42.100.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/fdc3-api-alpha.d.ts +238 -465
- package/out/fdc3-api-beta.d.ts +238 -465
- package/out/fdc3-api-public.d.ts +238 -465
- package/out/fdc3-api.d.ts +238 -465
- package/out/fdc3-api.js +59 -107
- package/package.json +1 -1
package/out/fdc3-api-beta.d.ts
CHANGED
|
@@ -69,10 +69,6 @@ declare type AddViewToStackOptions = {
|
|
|
69
69
|
* Optional index within the stack to insert the view. Defaults to 0
|
|
70
70
|
*/
|
|
71
71
|
index?: number;
|
|
72
|
-
/**
|
|
73
|
-
* How the view should be displayed in the stack. Defaults to 'focused'
|
|
74
|
-
*/
|
|
75
|
-
displayState?: 'focused' | 'background';
|
|
76
72
|
};
|
|
77
73
|
|
|
78
74
|
/**
|
|
@@ -130,13 +126,13 @@ declare type ApiSettings = {
|
|
|
130
126
|
/**
|
|
131
127
|
* Inject OpenFin API into cross-origin iframes
|
|
132
128
|
*
|
|
133
|
-
* @
|
|
129
|
+
* @defaultValue false
|
|
134
130
|
*/
|
|
135
131
|
crossOriginInjection?: boolean;
|
|
136
132
|
/**
|
|
137
133
|
* Inject OpenFin API into same-origin iframes
|
|
138
134
|
*
|
|
139
|
-
* @
|
|
135
|
+
* @defaultValue true
|
|
140
136
|
*/
|
|
141
137
|
sameOriginInjection?: boolean;
|
|
142
138
|
/**
|
|
@@ -1175,19 +1171,19 @@ declare class ApplicationModule extends Base {
|
|
|
1175
1171
|
*/
|
|
1176
1172
|
declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
1177
1173
|
/**
|
|
1178
|
-
*
|
|
1174
|
+
* @defaultValue false
|
|
1179
1175
|
*
|
|
1180
|
-
*
|
|
1176
|
+
* Disables IAB secure logging for the app.
|
|
1181
1177
|
*/
|
|
1182
1178
|
disableIabSecureLogging: boolean;
|
|
1183
1179
|
/**
|
|
1180
|
+
* @defaultValue 'There was an error loading the application.'
|
|
1181
|
+
*
|
|
1184
1182
|
* An error message to display when the application (launched via manifest) fails to load.
|
|
1185
1183
|
* A dialog box will be launched with the error message just before the runtime exits.
|
|
1186
1184
|
* Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
|
|
1187
1185
|
* will trigger this dialog.
|
|
1188
1186
|
* Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
|
|
1189
|
-
*
|
|
1190
|
-
* @default 'There was an error loading the application.'
|
|
1191
1187
|
*/
|
|
1192
1188
|
loadErrorMessage: string;
|
|
1193
1189
|
/**
|
|
@@ -1206,28 +1202,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1206
1202
|
*/
|
|
1207
1203
|
name: string;
|
|
1208
1204
|
/**
|
|
1205
|
+
* @defaultValue false
|
|
1206
|
+
*
|
|
1209
1207
|
* A flag to configure the application as non-persistent.
|
|
1210
1208
|
* Runtime exits when there are no persistent apps running.
|
|
1211
|
-
*
|
|
1212
|
-
* @default false
|
|
1213
1209
|
*/
|
|
1214
1210
|
nonPersistent: boolean;
|
|
1215
1211
|
/**
|
|
1216
|
-
*
|
|
1212
|
+
* @defaultValue false
|
|
1217
1213
|
*
|
|
1218
|
-
*
|
|
1214
|
+
* Enable Flash at the application level.
|
|
1219
1215
|
*/
|
|
1220
1216
|
plugins: boolean;
|
|
1221
1217
|
/**
|
|
1222
|
-
*
|
|
1218
|
+
* @defaultValue false
|
|
1223
1219
|
*
|
|
1224
|
-
*
|
|
1220
|
+
* Enable spell check at the application level.
|
|
1225
1221
|
*/
|
|
1226
1222
|
spellCheck: boolean;
|
|
1227
1223
|
/**
|
|
1228
|
-
*
|
|
1224
|
+
* @defaultValue 'about:blank'
|
|
1229
1225
|
*
|
|
1230
|
-
*
|
|
1226
|
+
* The url to the application (specifically the application's main window).
|
|
1231
1227
|
*/
|
|
1232
1228
|
url: string;
|
|
1233
1229
|
/**
|
|
@@ -1236,9 +1232,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1236
1232
|
*/
|
|
1237
1233
|
uuid: string;
|
|
1238
1234
|
/**
|
|
1239
|
-
*
|
|
1235
|
+
* @defaultValue true
|
|
1240
1236
|
*
|
|
1241
|
-
*
|
|
1237
|
+
* When set to `false` it will disable the same-origin policy for the app.
|
|
1242
1238
|
*/
|
|
1243
1239
|
webSecurity: boolean;
|
|
1244
1240
|
/**
|
|
@@ -1248,10 +1244,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1248
1244
|
commands: ShortcutOverride[];
|
|
1249
1245
|
isPlatformController: boolean;
|
|
1250
1246
|
/**
|
|
1247
|
+
* @defaultValue 1000
|
|
1248
|
+
*
|
|
1251
1249
|
* **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
|
|
1252
1250
|
* If you do not wish for views to be pooled on your platform, set this property to zero.
|
|
1253
|
-
*
|
|
1254
|
-
* @default 1000
|
|
1255
1251
|
*/
|
|
1256
1252
|
maxViewPoolSize: number;
|
|
1257
1253
|
/**
|
|
@@ -1267,12 +1263,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1267
1263
|
*/
|
|
1268
1264
|
snapshot: Snapshot;
|
|
1269
1265
|
/**
|
|
1266
|
+
* @defaultValue false
|
|
1267
|
+
*
|
|
1270
1268
|
* **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
|
|
1271
1269
|
*
|
|
1272
1270
|
* Note: if the Platform Provider is showing, it won't close automatically.
|
|
1273
1271
|
* If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
|
|
1274
|
-
*
|
|
1275
|
-
* @default false
|
|
1276
1272
|
*/
|
|
1277
1273
|
preventQuitOnLastWindowClosed: boolean;
|
|
1278
1274
|
/**
|
|
@@ -1280,9 +1276,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1280
1276
|
*/
|
|
1281
1277
|
interopBrokerConfiguration: InteropBrokerOptions;
|
|
1282
1278
|
/**
|
|
1283
|
-
*
|
|
1279
|
+
* @defaultValue true
|
|
1284
1280
|
*
|
|
1285
|
-
*
|
|
1281
|
+
* When set to `false` it will disable OpenFin Diagnostics for the app.
|
|
1286
1282
|
*/
|
|
1287
1283
|
apiDiagnostics: boolean;
|
|
1288
1284
|
/**
|
|
@@ -1298,16 +1294,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1298
1294
|
*/
|
|
1299
1295
|
permissions?: Partial<Permissions_2>;
|
|
1300
1296
|
/**
|
|
1297
|
+
* @defaultValue false
|
|
1298
|
+
*
|
|
1301
1299
|
* Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
|
|
1302
1300
|
* Only relevant in Windows.
|
|
1303
|
-
*
|
|
1304
|
-
* @default false
|
|
1305
1301
|
*/
|
|
1306
1302
|
enableJumpList: boolean;
|
|
1307
1303
|
/**
|
|
1308
|
-
*
|
|
1304
|
+
* @defaultValue false
|
|
1309
1305
|
*
|
|
1310
|
-
*
|
|
1306
|
+
* When set to `true`, any `beforeunload` handler set on the app will fire.
|
|
1311
1307
|
*/
|
|
1312
1308
|
enableBeforeUnload: boolean;
|
|
1313
1309
|
/**
|
|
@@ -1388,25 +1384,25 @@ declare type ApplicationWindowInfo = {
|
|
|
1388
1384
|
*/
|
|
1389
1385
|
declare type ApplySnapshotOptions = {
|
|
1390
1386
|
/**
|
|
1387
|
+
* @defaultValue false
|
|
1388
|
+
*
|
|
1391
1389
|
* When true, applySnapshot will close existing windows,
|
|
1392
1390
|
* replacing current Platform state with the given snapshot.
|
|
1393
|
-
*
|
|
1394
|
-
* @default false
|
|
1395
1391
|
*/
|
|
1396
1392
|
closeExistingWindows?: boolean;
|
|
1397
1393
|
/**
|
|
1394
|
+
* @defaultValue false
|
|
1395
|
+
*
|
|
1398
1396
|
* When true, applySnapshot will close existing includeInSnapshots: true windows,
|
|
1399
1397
|
* replacing current Platform state with the given snapshot.
|
|
1400
|
-
*
|
|
1401
|
-
* @default false
|
|
1402
1398
|
*/
|
|
1403
1399
|
closeSnapshotWindows?: boolean;
|
|
1404
1400
|
/**
|
|
1401
|
+
* @defaultValue false
|
|
1402
|
+
*
|
|
1405
1403
|
* When true, applySnapshot will not check whether any windows in a
|
|
1406
1404
|
* snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
|
|
1407
1405
|
* as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
|
|
1408
|
-
*
|
|
1409
|
-
* @default false
|
|
1410
1406
|
*/
|
|
1411
1407
|
skipOutOfBoundsCheck?: boolean;
|
|
1412
1408
|
};
|
|
@@ -1831,6 +1827,10 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
|
1831
1827
|
isMainFrame: boolean;
|
|
1832
1828
|
};
|
|
1833
1829
|
|
|
1830
|
+
declare type BaseStructuredContentBehavior = {
|
|
1831
|
+
behavior: BaseContentBehavior;
|
|
1832
|
+
};
|
|
1833
|
+
|
|
1834
1834
|
declare type BaseUrlEvent = NamedEvent & {
|
|
1835
1835
|
type: 'url-changed';
|
|
1836
1836
|
url: string;
|
|
@@ -1929,32 +1929,13 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
|
1929
1929
|
reason: 'self' | 'animation';
|
|
1930
1930
|
};
|
|
1931
1931
|
|
|
1932
|
-
declare type BoundsEvent = BaseEvent_5 & OpenFin.
|
|
1932
|
+
declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
|
|
1933
1933
|
|
|
1934
|
-
declare type BoundsType =
|
|
1935
|
-
/**
|
|
1936
|
-
* Bounds specify the size and location of the entire window, including OS border styling.
|
|
1937
|
-
*/
|
|
1938
|
-
'window'
|
|
1939
|
-
/**
|
|
1940
|
-
* Bounds specify the size and location of the window's DOM content, excluding OS border styling.
|
|
1941
|
-
*/
|
|
1942
|
-
| 'content'
|
|
1943
|
-
/**
|
|
1944
|
-
* Origin parameters (top, left) specify the location of the window origin, including OS border styling.
|
|
1945
|
-
* Size parameters bounds (width, height) specify the size of the window's DOM content, excluding OS border styling.
|
|
1946
|
-
*/
|
|
1947
|
-
| 'window-origin-content-size';
|
|
1948
|
-
|
|
1949
|
-
/**
|
|
1950
|
-
* Opens matched URLs in the browser.
|
|
1951
|
-
*
|
|
1952
|
-
* @interface
|
|
1953
|
-
*/
|
|
1954
1934
|
declare type BrowserContentBehavior = {
|
|
1955
1935
|
behavior: 'browser';
|
|
1956
1936
|
/**
|
|
1957
|
-
*
|
|
1937
|
+
* Additional property that can be specified when setting the behavior to browser.
|
|
1938
|
+
* When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
|
|
1958
1939
|
*/
|
|
1959
1940
|
closeExisting?: boolean;
|
|
1960
1941
|
};
|
|
@@ -2063,15 +2044,15 @@ declare type CapturePageOptions = {
|
|
|
2063
2044
|
*/
|
|
2064
2045
|
area?: Rectangle;
|
|
2065
2046
|
/**
|
|
2066
|
-
*
|
|
2047
|
+
* @defaultValue 'png'
|
|
2067
2048
|
*
|
|
2068
|
-
*
|
|
2049
|
+
* The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
|
2069
2050
|
*/
|
|
2070
2051
|
format?: 'bmp' | 'jpg' | 'png';
|
|
2071
2052
|
/**
|
|
2072
|
-
*
|
|
2053
|
+
* @defaultValue 100
|
|
2073
2054
|
*
|
|
2074
|
-
*
|
|
2055
|
+
* Quality of JPEG image. Between 0 - 100.
|
|
2075
2056
|
*/
|
|
2076
2057
|
quality?: number;
|
|
2077
2058
|
};
|
|
@@ -2704,9 +2685,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
|
|
|
2704
2685
|
*/
|
|
2705
2686
|
declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2706
2687
|
/**
|
|
2707
|
-
*
|
|
2688
|
+
* @defaultValue true
|
|
2708
2689
|
*
|
|
2709
|
-
*
|
|
2690
|
+
* If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
|
|
2710
2691
|
*/
|
|
2711
2692
|
wait?: boolean;
|
|
2712
2693
|
/**
|
|
@@ -3000,10 +2981,6 @@ declare type ChromiumPolicies = {
|
|
|
3000
2981
|
* Disable AutofillAddressEnabled policy for a Window or View.
|
|
3001
2982
|
*/
|
|
3002
2983
|
AutofillAddressEnabled?: PolicyOptions;
|
|
3003
|
-
/**
|
|
3004
|
-
* Disable AutofillCreditCardEnabled policy for a Window or View.
|
|
3005
|
-
*/
|
|
3006
|
-
AutofillCreditCardEnabled?: PolicyOptions;
|
|
3007
2984
|
};
|
|
3008
2985
|
|
|
3009
2986
|
declare interface ClassicProtocolOffer extends ProtocolPacketBase {
|
|
@@ -3089,7 +3066,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
|
3089
3066
|
*
|
|
3090
3067
|
*/
|
|
3091
3068
|
declare class Clipboard_2 extends Base {
|
|
3092
|
-
#private;
|
|
3093
3069
|
/**
|
|
3094
3070
|
* Writes data into the clipboard as plain text
|
|
3095
3071
|
* @param writeObj The object for writing data into the clipboard
|
|
@@ -3242,21 +3218,6 @@ declare class Clipboard_2 extends Base {
|
|
|
3242
3218
|
getAvailableFormats(type?: OpenFin.ClipboardSelectionType): Promise<Array<string>>;
|
|
3243
3219
|
}
|
|
3244
3220
|
|
|
3245
|
-
/**
|
|
3246
|
-
* Permissions for {@link Clipboard} APIs.
|
|
3247
|
-
*/
|
|
3248
|
-
declare type ClipboardApiPermissions = {
|
|
3249
|
-
writeText: boolean;
|
|
3250
|
-
readText: boolean;
|
|
3251
|
-
writeImage: boolean;
|
|
3252
|
-
readImage: boolean;
|
|
3253
|
-
writeHtml: boolean;
|
|
3254
|
-
readHtml: boolean;
|
|
3255
|
-
writeRtf: boolean;
|
|
3256
|
-
readRtf: boolean;
|
|
3257
|
-
write: boolean;
|
|
3258
|
-
};
|
|
3259
|
-
|
|
3260
3221
|
/**
|
|
3261
3222
|
* Generated when a copy operation is blocked through {@link OpenFin.DomainSettings}.
|
|
3262
3223
|
* @interface
|
|
@@ -3285,7 +3246,6 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
|
|
|
3285
3246
|
|
|
3286
3247
|
/**
|
|
3287
3248
|
* Clipboard Permissions
|
|
3288
|
-
* @interface
|
|
3289
3249
|
*/
|
|
3290
3250
|
declare type ClipboardPermissions = {
|
|
3291
3251
|
copy?: CopyPermissions;
|
|
@@ -3369,9 +3329,9 @@ declare interface CloseWindowPayload {
|
|
|
3369
3329
|
windowId: Identity_4;
|
|
3370
3330
|
options: {
|
|
3371
3331
|
/**
|
|
3372
|
-
*
|
|
3332
|
+
* @defaultValue false
|
|
3373
3333
|
*
|
|
3374
|
-
*
|
|
3334
|
+
* When set to true skips any before handler set on views that are part of the window
|
|
3375
3335
|
*/
|
|
3376
3336
|
skipBeforeUnload?: boolean;
|
|
3377
3337
|
};
|
|
@@ -3476,23 +3436,20 @@ declare type ConstViewOptions = {
|
|
|
3476
3436
|
*/
|
|
3477
3437
|
name: string;
|
|
3478
3438
|
/**
|
|
3479
|
-
*
|
|
3439
|
+
* @defaultValue "about:blank"
|
|
3480
3440
|
*
|
|
3481
|
-
*
|
|
3441
|
+
* The URL of the window
|
|
3482
3442
|
*/
|
|
3483
3443
|
url: string;
|
|
3484
3444
|
/**
|
|
3485
3445
|
* The identity of the window this view should be attached to.
|
|
3486
3446
|
*/
|
|
3487
3447
|
target: Identity_4;
|
|
3488
|
-
/**
|
|
3489
|
-
* Controls order of title precedence:
|
|
3490
|
-
* 'options': viewOptions.title (componentState), document.title, viewOptions.url
|
|
3491
|
-
* 'document': document.title, viewOptions.title(componentState), viewOptions.url (default behavior)
|
|
3492
|
-
*/
|
|
3493
|
-
titlePriority?: ViewTitlePriority;
|
|
3494
3448
|
/**
|
|
3495
3449
|
* Defaults to `name`.
|
|
3450
|
+
* Ignored in container, but used in @openfin/core-web to set tab titles.
|
|
3451
|
+
* Order of precedence for title in container is: document.title, viewOptions.url.
|
|
3452
|
+
* Order of precedence for title in @openfin/core-web is ComponentConfig.title, viewOptions.title, viewOptions.url.
|
|
3496
3453
|
*/
|
|
3497
3454
|
title: string;
|
|
3498
3455
|
/**
|
|
@@ -3503,15 +3460,6 @@ declare type ConstViewOptions = {
|
|
|
3503
3460
|
* Custom headers for requests sent by the view.
|
|
3504
3461
|
*/
|
|
3505
3462
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3506
|
-
/**
|
|
3507
|
-
* @experimental
|
|
3508
|
-
*
|
|
3509
|
-
* When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
|
|
3510
|
-
* These css properties are used to enable dragging of a frameless window.
|
|
3511
|
-
*
|
|
3512
|
-
* @default false
|
|
3513
|
-
*/
|
|
3514
|
-
disableAppRegion: boolean;
|
|
3515
3463
|
/**
|
|
3516
3464
|
* Initial bounds given relative to the window.
|
|
3517
3465
|
*/
|
|
@@ -3548,9 +3496,9 @@ declare type ConstViewOptions = {
|
|
|
3548
3496
|
experimental: any;
|
|
3549
3497
|
fdc3InteropApi?: string;
|
|
3550
3498
|
/**
|
|
3551
|
-
*
|
|
3499
|
+
* @defaultValue false
|
|
3552
3500
|
*
|
|
3553
|
-
*
|
|
3501
|
+
* When set to `true`, any `beforeunload` handler set on Views will fire.
|
|
3554
3502
|
*/
|
|
3555
3503
|
enableBeforeUnload: boolean;
|
|
3556
3504
|
/**
|
|
@@ -3631,12 +3579,13 @@ declare type ConstWindowOptions = {
|
|
|
3631
3579
|
*/
|
|
3632
3580
|
backgroundColor: string;
|
|
3633
3581
|
/**
|
|
3582
|
+
* @defaultValue false
|
|
3583
|
+
*
|
|
3634
3584
|
* Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
|
|
3635
3585
|
* This also affects the Page Visibility API.
|
|
3636
3586
|
*
|
|
3637
3587
|
* When `true`, the page is throttled whether it is hidden or not.
|
|
3638
3588
|
*
|
|
3639
|
-
* @default false
|
|
3640
3589
|
*/
|
|
3641
3590
|
backgroundThrottling: boolean;
|
|
3642
3591
|
/**
|
|
@@ -3660,30 +3609,21 @@ declare type ConstWindowOptions = {
|
|
|
3660
3609
|
*/
|
|
3661
3610
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3662
3611
|
/**
|
|
3612
|
+
* @defaultValue true
|
|
3613
|
+
*
|
|
3663
3614
|
* Setting this to false would keep the Window alive even if all its Views were closed.
|
|
3664
3615
|
* This is meant for advanced users and should be used with caution.
|
|
3665
3616
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
3666
3617
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
3667
3618
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3668
|
-
*
|
|
3669
|
-
* @default true
|
|
3670
3619
|
*/
|
|
3671
3620
|
closeOnLastViewRemoved: boolean;
|
|
3672
3621
|
/**
|
|
3673
|
-
* @
|
|
3674
|
-
*
|
|
3675
|
-
* When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
|
|
3676
|
-
* These css properties are used to enable dragging of a frameless window.
|
|
3622
|
+
* @defaultValue 'all'
|
|
3677
3623
|
*
|
|
3678
|
-
* @default false
|
|
3679
|
-
*/
|
|
3680
|
-
disableAppRegion: boolean;
|
|
3681
|
-
/**
|
|
3682
3624
|
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
|
3683
|
-
* Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3625
|
+
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3684
3626
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3685
|
-
*
|
|
3686
|
-
* @default 'all'
|
|
3687
3627
|
*/
|
|
3688
3628
|
viewsPreventingClose: 'all' | 'layout';
|
|
3689
3629
|
/**
|
|
@@ -3694,31 +3634,31 @@ declare type ConstWindowOptions = {
|
|
|
3694
3634
|
*/
|
|
3695
3635
|
defaultCentered: boolean;
|
|
3696
3636
|
/**
|
|
3637
|
+
* @defaultValue 500
|
|
3638
|
+
*
|
|
3697
3639
|
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
|
3698
3640
|
* in favor of the cached value.
|
|
3699
|
-
*
|
|
3700
|
-
* @default 500
|
|
3701
3641
|
*/
|
|
3702
3642
|
defaultHeight: number;
|
|
3703
3643
|
/**
|
|
3644
|
+
* @defaultValue 100
|
|
3645
|
+
*
|
|
3704
3646
|
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3705
3647
|
* launches in favor of the cached value.
|
|
3706
|
-
*
|
|
3707
|
-
* @default 100
|
|
3708
3648
|
*/
|
|
3709
3649
|
defaultLeft: number;
|
|
3710
3650
|
/**
|
|
3651
|
+
* @defaultValue 100
|
|
3652
|
+
*
|
|
3711
3653
|
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3712
3654
|
* launches in favor of the cached value.
|
|
3713
|
-
*
|
|
3714
|
-
* @default 100
|
|
3715
3655
|
*/
|
|
3716
3656
|
defaultTop: number;
|
|
3717
3657
|
/**
|
|
3658
|
+
* @defaultValue 800
|
|
3659
|
+
*
|
|
3718
3660
|
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3719
3661
|
* launches in favor of the cached value.
|
|
3720
|
-
*
|
|
3721
|
-
* @default 800
|
|
3722
3662
|
*/
|
|
3723
3663
|
defaultWidth: number;
|
|
3724
3664
|
/**
|
|
@@ -3764,19 +3704,19 @@ declare type ConstWindowOptions = {
|
|
|
3764
3704
|
*/
|
|
3765
3705
|
processAffinity: string;
|
|
3766
3706
|
/**
|
|
3707
|
+
* @defaultValue false
|
|
3708
|
+
*
|
|
3767
3709
|
* Displays a shadow on frameless windows.
|
|
3768
3710
|
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
3769
3711
|
* On Windows 7, Aero theme is required.
|
|
3770
|
-
*
|
|
3771
|
-
* @default false
|
|
3772
3712
|
*/
|
|
3773
3713
|
shadow: boolean;
|
|
3774
3714
|
/**
|
|
3715
|
+
* @defaultValue true
|
|
3716
|
+
*
|
|
3775
3717
|
* Caches the location of the window.
|
|
3776
3718
|
*
|
|
3777
3719
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3778
|
-
*
|
|
3779
|
-
* @default true
|
|
3780
3720
|
*/
|
|
3781
3721
|
saveWindowState: boolean;
|
|
3782
3722
|
/**
|
|
@@ -3785,22 +3725,22 @@ declare type ConstWindowOptions = {
|
|
|
3785
3725
|
*/
|
|
3786
3726
|
ignoreSavedWindowState: boolean;
|
|
3787
3727
|
/**
|
|
3728
|
+
* @defaultValue false
|
|
3729
|
+
*
|
|
3788
3730
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3789
3731
|
*
|
|
3790
3732
|
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3791
3733
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3792
|
-
*
|
|
3793
|
-
* @default false
|
|
3794
3734
|
*/
|
|
3795
3735
|
smallWindow: boolean;
|
|
3796
3736
|
/**
|
|
3737
|
+
* @defaultValue "normal"
|
|
3738
|
+
*
|
|
3797
3739
|
* The visible state of the window on creation.
|
|
3798
3740
|
* One of:
|
|
3799
3741
|
* * `"maximized"`
|
|
3800
3742
|
* * `"minimized"`
|
|
3801
3743
|
* * `"normal"`
|
|
3802
|
-
*
|
|
3803
|
-
* @default "normal"
|
|
3804
3744
|
*/
|
|
3805
3745
|
state: WindowState;
|
|
3806
3746
|
/**
|
|
@@ -3815,26 +3755,26 @@ declare type ConstWindowOptions = {
|
|
|
3815
3755
|
*/
|
|
3816
3756
|
taskbarIconGroup: string;
|
|
3817
3757
|
/**
|
|
3818
|
-
*
|
|
3758
|
+
* @defaultValue "about:blank"
|
|
3819
3759
|
*
|
|
3820
|
-
*
|
|
3760
|
+
* The URL of the window
|
|
3821
3761
|
*/
|
|
3822
3762
|
url: string;
|
|
3823
3763
|
/**
|
|
3764
|
+
* @defaultValue <application UUID>
|
|
3765
|
+
*
|
|
3824
3766
|
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
3825
3767
|
* If omitted, defaults to the `uuid` of the application spawning the window.
|
|
3826
3768
|
* If given, must match the `uuid` of the application spawning the window.
|
|
3827
3769
|
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
3828
3770
|
* really no need to provide it.
|
|
3829
|
-
*
|
|
3830
|
-
* @default <application UUID>
|
|
3831
3771
|
*/
|
|
3832
3772
|
uuid: string;
|
|
3833
3773
|
/**
|
|
3774
|
+
* @defaultValue false
|
|
3775
|
+
*
|
|
3834
3776
|
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
|
3835
3777
|
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
|
3836
|
-
*
|
|
3837
|
-
* @default false
|
|
3838
3778
|
*/
|
|
3839
3779
|
waitForPageLoad: boolean;
|
|
3840
3780
|
width: number;
|
|
@@ -3854,10 +3794,6 @@ declare type ConstWindowOptions = {
|
|
|
3854
3794
|
* Control which options to ignore when creating a Platform Window.
|
|
3855
3795
|
*/
|
|
3856
3796
|
excludeOptions: ExcludeOptions;
|
|
3857
|
-
/**
|
|
3858
|
-
* 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.
|
|
3859
|
-
*/
|
|
3860
|
-
roundedCorners: boolean;
|
|
3861
3797
|
};
|
|
3862
3798
|
|
|
3863
3799
|
/**
|
|
@@ -3869,7 +3805,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
|
3869
3805
|
};
|
|
3870
3806
|
|
|
3871
3807
|
/**
|
|
3872
|
-
*
|
|
3808
|
+
* Sets the behavior for when a Window or View navigates or redirects to a matching URL
|
|
3873
3809
|
*
|
|
3874
3810
|
* 'allow': The content url is allowed.
|
|
3875
3811
|
* 'block': The content url is blocked.
|
|
@@ -3948,17 +3884,7 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3948
3884
|
* The features string passed to `window.open()` converted to OpenFin window options
|
|
3949
3885
|
*/
|
|
3950
3886
|
parsedFeatures: Partial<OpenFin.WindowOptions>;
|
|
3951
|
-
|
|
3952
|
-
* The reported disposition of the content creation request.
|
|
3953
|
-
* @remarks
|
|
3954
|
-
* - `default` - The default behavior of the browser.
|
|
3955
|
-
* - `foreground-tab` - The content is loaded in a new tab in the foreground. This is the default behavior for `window.open()` or a link with target=_blank.
|
|
3956
|
-
* - `background-tab` - The content is loaded in a new tab in the background. This is the default behavior when clicking on a link with the `ctrl` or `cmd` key pressed.
|
|
3957
|
-
* - `new-window` - The content is loaded in a new window. This is the default behavior when clicking on a link with the `shift` key pressed.
|
|
3958
|
-
* - `popup` - The content is loaded in a popup window. This is the result of passing popup features to `window.open()`.
|
|
3959
|
-
* - `other` - The content is loaded in some other way.
|
|
3960
|
-
*/
|
|
3961
|
-
disposition: 'default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'popup' | 'other';
|
|
3887
|
+
disposition: string;
|
|
3962
3888
|
};
|
|
3963
3889
|
|
|
3964
3890
|
/**
|
|
@@ -4116,17 +4042,16 @@ declare type CopyBlockedEventReason = 'disabled';
|
|
|
4116
4042
|
|
|
4117
4043
|
/**
|
|
4118
4044
|
* Control copy operations for a matched URL.
|
|
4119
|
-
* @interface
|
|
4120
4045
|
*/
|
|
4121
4046
|
declare type CopyPermissions = {
|
|
4122
4047
|
/**
|
|
4048
|
+
* @defaultValue 'allowed'
|
|
4049
|
+
*
|
|
4123
4050
|
* Controls the behavior for copy operations for a matched URL.
|
|
4124
4051
|
*
|
|
4125
4052
|
* allow: Enables all copy operations.
|
|
4126
4053
|
* block: Disables all copy operations.
|
|
4127
4054
|
* protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
|
|
4128
|
-
*
|
|
4129
|
-
* @default 'allowed'
|
|
4130
4055
|
*/
|
|
4131
4056
|
behavior: 'allow' | 'block' | 'protect';
|
|
4132
4057
|
/**
|
|
@@ -4134,9 +4059,9 @@ declare type CopyPermissions = {
|
|
|
4134
4059
|
*/
|
|
4135
4060
|
options?: {
|
|
4136
4061
|
/**
|
|
4137
|
-
*
|
|
4062
|
+
* @defaultValue ''
|
|
4138
4063
|
*
|
|
4139
|
-
*
|
|
4064
|
+
* When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
|
|
4140
4065
|
*/
|
|
4141
4066
|
replacementText: string;
|
|
4142
4067
|
};
|
|
@@ -4150,15 +4075,15 @@ declare type CopyPermissions = {
|
|
|
4150
4075
|
*/
|
|
4151
4076
|
declare type CornerRounding = {
|
|
4152
4077
|
/**
|
|
4153
|
-
*
|
|
4078
|
+
* @defaultValue 0
|
|
4154
4079
|
*
|
|
4155
|
-
*
|
|
4080
|
+
* The height in pixels.
|
|
4156
4081
|
*/
|
|
4157
4082
|
height: number;
|
|
4158
4083
|
/**
|
|
4159
|
-
*
|
|
4084
|
+
* @defaultValue 0
|
|
4160
4085
|
*
|
|
4161
|
-
*
|
|
4086
|
+
* The width in pixels.
|
|
4162
4087
|
*/
|
|
4163
4088
|
width: number;
|
|
4164
4089
|
};
|
|
@@ -4248,6 +4173,8 @@ declare type CreateLayoutOptions = {
|
|
|
4248
4173
|
layoutName: string;
|
|
4249
4174
|
layout: LayoutOptions;
|
|
4250
4175
|
/**
|
|
4176
|
+
* @defaultValue 'default'
|
|
4177
|
+
*
|
|
4251
4178
|
* Controls the View behavior for the given `layout` property. Note
|
|
4252
4179
|
* that the selected behavior only applies to unnamed Views or
|
|
4253
4180
|
* Views with the prefix `internal-generated-`. In all cases, if any
|
|
@@ -4269,8 +4196,6 @@ declare type CreateLayoutOptions = {
|
|
|
4269
4196
|
* override. Note that during applyLayoutSnapshot, Views are created and
|
|
4270
4197
|
* attached to the Provider while the Window is being created, so it's
|
|
4271
4198
|
* important to not 'duplicate' Views in this workflow.
|
|
4272
|
-
*
|
|
4273
|
-
* @default 'default'
|
|
4274
4199
|
*/
|
|
4275
4200
|
multiInstanceViewBehavior?: MultiInstanceViewBehavior;
|
|
4276
4201
|
};
|
|
@@ -4300,7 +4225,8 @@ declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
|
|
|
4300
4225
|
*/
|
|
4301
4226
|
location?: {
|
|
4302
4227
|
id: string;
|
|
4303
|
-
|
|
4228
|
+
index?: number;
|
|
4229
|
+
};
|
|
4304
4230
|
};
|
|
4305
4231
|
|
|
4306
4232
|
/**
|
|
@@ -4368,7 +4294,6 @@ declare type DefaultDomainSettings = DomainSettings;
|
|
|
4368
4294
|
|
|
4369
4295
|
/**
|
|
4370
4296
|
* @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
|
|
4371
|
-
* @interface
|
|
4372
4297
|
*/
|
|
4373
4298
|
declare type DefaultDomainSettingsRule = DomainSettingsRule;
|
|
4374
4299
|
|
|
@@ -4529,7 +4454,7 @@ declare type DomainApiSettings = {
|
|
|
4529
4454
|
* * 'none': The `fin` API will be not available.
|
|
4530
4455
|
* * 'global': The entire `fin` API will be available.
|
|
4531
4456
|
*
|
|
4532
|
-
* @
|
|
4457
|
+
* @defaultValue 'global'
|
|
4533
4458
|
*/
|
|
4534
4459
|
fin?: InjectionType;
|
|
4535
4460
|
/**
|
|
@@ -4545,7 +4470,10 @@ declare type DomainApiSettings = {
|
|
|
4545
4470
|
* @interface
|
|
4546
4471
|
* Defines application settings that vary by the domain of the current context.
|
|
4547
4472
|
*
|
|
4548
|
-
* @remarks
|
|
4473
|
+
* @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
|
|
4474
|
+
* domain should be represented with a single rule.
|
|
4475
|
+
*
|
|
4476
|
+
* Renderers opened on `about:blank` are considered to belong to the domain of their opener (or, in the case of iframes,
|
|
4549
4477
|
* their parent), effective recursively. Domain rules matched to `about:blank` will only apply in cases where no opener
|
|
4550
4478
|
* exists.
|
|
4551
4479
|
*/
|
|
@@ -4562,44 +4490,19 @@ declare type DomainSettings = {
|
|
|
4562
4490
|
* more information, see the documentation for the individual properties.
|
|
4563
4491
|
*/
|
|
4564
4492
|
default?: PerDomainSettings;
|
|
4565
|
-
/**
|
|
4566
|
-
* {@inheritDoc MultipleDomainMatchBehavior}
|
|
4567
|
-
*/
|
|
4568
|
-
multipleMatchBehavior?: MultipleDomainMatchBehavior;
|
|
4569
4493
|
};
|
|
4570
4494
|
|
|
4571
4495
|
/**
|
|
4572
|
-
*
|
|
4496
|
+
* @interface
|
|
4573
4497
|
*
|
|
4574
|
-
* Uses the script's full URL as the key and an object
|
|
4575
|
-
* with an `enabled` boolean property as the value.
|
|
4576
|
-
* @example
|
|
4577
|
-
* ```js
|
|
4578
|
-
* {
|
|
4579
|
-
"match": ["<all_urls>"],
|
|
4580
|
-
"options": {
|
|
4581
|
-
"preloadScripts": {
|
|
4582
|
-
"http://localhost:53000/block-preload.js": { "enabled": false }
|
|
4583
|
-
"http://localhost:53000/allow-preload.js": { "enabled": true }
|
|
4584
|
-
}
|
|
4585
|
-
}
|
|
4586
|
-
}
|
|
4587
|
-
* ```
|
|
4588
|
-
*/
|
|
4589
|
-
declare type DomainSettingsPreloadScripts = Record<string, {
|
|
4590
|
-
enabled: boolean;
|
|
4591
|
-
}>;
|
|
4592
|
-
|
|
4593
|
-
/**
|
|
4594
4498
|
* Defines domain-conditional settings for an OpenFin application.
|
|
4595
|
-
* @interface
|
|
4596
4499
|
*/
|
|
4597
4500
|
declare type DomainSettingsRule = {
|
|
4598
4501
|
/**
|
|
4599
4502
|
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4600
4503
|
* the domain(s) for which the rule applies.
|
|
4601
4504
|
*/
|
|
4602
|
-
match
|
|
4505
|
+
match?: string[];
|
|
4603
4506
|
/**
|
|
4604
4507
|
* Settings applied when a webcontents has been navigated to a matched domain.
|
|
4605
4508
|
*/
|
|
@@ -5129,9 +5032,9 @@ declare type EventType_9 = Event_12['type'];
|
|
|
5129
5032
|
*/
|
|
5130
5033
|
declare type ExcludeOptions = {
|
|
5131
5034
|
/**
|
|
5132
|
-
*
|
|
5035
|
+
* @defaultValue false
|
|
5133
5036
|
*
|
|
5134
|
-
*
|
|
5037
|
+
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
|
5135
5038
|
*/
|
|
5136
5039
|
preloadScripts: boolean;
|
|
5137
5040
|
};
|
|
@@ -5750,7 +5653,7 @@ declare class FDC3ModuleBase<ChannelType extends v1_2.Channel | v2_0.Channel> {
|
|
|
5750
5653
|
*
|
|
5751
5654
|
* @tutorial fdc3.getOrCreateChannel
|
|
5752
5655
|
*/
|
|
5753
|
-
|
|
5656
|
+
getOrCreateChannel(channelId: string): Promise<ChannelType>;
|
|
5754
5657
|
/**
|
|
5755
5658
|
* Returns the Interop-Broker-defined context groups available for an entity to join.
|
|
5756
5659
|
*
|
|
@@ -5897,7 +5800,6 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
|
5897
5800
|
* Domain-conditional rules for file downloads.
|
|
5898
5801
|
*
|
|
5899
5802
|
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
|
5900
|
-
* @interface
|
|
5901
5803
|
*/
|
|
5902
5804
|
declare type FileDownloadSettings = {
|
|
5903
5805
|
/**
|
|
@@ -5950,34 +5852,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
5950
5852
|
*/
|
|
5951
5853
|
declare type FindInPageOptions = {
|
|
5952
5854
|
/**
|
|
5953
|
-
*
|
|
5855
|
+
* @defaultValue true
|
|
5954
5856
|
*
|
|
5955
|
-
*
|
|
5857
|
+
* Searches in the forward direction (backward otherwise)
|
|
5956
5858
|
*/
|
|
5957
5859
|
forward?: boolean;
|
|
5958
5860
|
/**
|
|
5959
|
-
*
|
|
5861
|
+
* @defaultValue false
|
|
5960
5862
|
*
|
|
5961
|
-
*
|
|
5863
|
+
* Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
|
|
5962
5864
|
*/
|
|
5963
5865
|
findNext?: boolean;
|
|
5964
5866
|
/**
|
|
5965
|
-
*
|
|
5867
|
+
* @defaultValue false
|
|
5966
5868
|
*
|
|
5967
|
-
*
|
|
5869
|
+
* Enables case-sensitive searching.
|
|
5968
5870
|
*/
|
|
5969
5871
|
matchCase?: boolean;
|
|
5970
5872
|
/**
|
|
5971
|
-
*
|
|
5873
|
+
* @defaultValue false
|
|
5972
5874
|
*
|
|
5973
|
-
*
|
|
5875
|
+
* Only searches from the start of words.
|
|
5974
5876
|
*/
|
|
5975
5877
|
wordStart?: boolean;
|
|
5976
5878
|
/**
|
|
5879
|
+
* @defaultValue false
|
|
5880
|
+
*
|
|
5977
5881
|
* 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>
|
|
5978
5882
|
* lowercase or non-letter. Accepts several other intra-word matches.
|
|
5979
|
-
*
|
|
5980
|
-
* @default false
|
|
5981
5883
|
*/
|
|
5982
5884
|
medialCapitalAsWordStart?: boolean;
|
|
5983
5885
|
};
|
|
@@ -6485,9 +6387,9 @@ declare type Hotkey = {
|
|
|
6485
6387
|
*/
|
|
6486
6388
|
keys: string;
|
|
6487
6389
|
/**
|
|
6488
|
-
*
|
|
6390
|
+
* @defaultValue false
|
|
6489
6391
|
*
|
|
6490
|
-
*
|
|
6392
|
+
* Prevent default key handling before emitting the event.
|
|
6491
6393
|
*/
|
|
6492
6394
|
preventDefault?: boolean;
|
|
6493
6395
|
};
|
|
@@ -6656,10 +6558,9 @@ declare type InitPlatformOptions = {
|
|
|
6656
6558
|
* Injection setting for the `fin` API.
|
|
6657
6559
|
*
|
|
6658
6560
|
* * 'none': The `fin` API will be not available.
|
|
6659
|
-
* * 'preloads': The `fin` API will be available in a synchronous context in the preload script only.
|
|
6660
6561
|
* * 'global': The entire `fin` API will be available.
|
|
6661
6562
|
*/
|
|
6662
|
-
declare type InjectionType = 'none' | '
|
|
6563
|
+
declare type InjectionType = 'none' | 'global';
|
|
6663
6564
|
|
|
6664
6565
|
/**
|
|
6665
6566
|
* Generated when the value of the element changes.
|
|
@@ -6973,7 +6874,6 @@ declare class InteropBroker extends Base {
|
|
|
6973
6874
|
private sessionContextGroupMap;
|
|
6974
6875
|
private channel;
|
|
6975
6876
|
private logging;
|
|
6976
|
-
private privateChannelProviderMap;
|
|
6977
6877
|
/* Excluded from this release type: __constructor */
|
|
6978
6878
|
private getProvider;
|
|
6979
6879
|
static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
|
|
@@ -8520,7 +8420,9 @@ declare type LayoutEntitiesController = {
|
|
|
8520
8420
|
getParent: (id: string) => OpenFin.LayoutEntityDefinition | undefined;
|
|
8521
8421
|
isRoot: (id: string) => boolean;
|
|
8522
8422
|
exists: (entityId: string) => boolean;
|
|
8523
|
-
addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?:
|
|
8423
|
+
addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
|
|
8424
|
+
index?: number;
|
|
8425
|
+
}) => Promise<OpenFin.Identity>;
|
|
8524
8426
|
removeViewFromStack: (stackEntityId: string, view: OpenFin.Identity) => Promise<void>;
|
|
8525
8427
|
createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
|
|
8526
8428
|
position?: OpenFin.LayoutPosition;
|
|
@@ -8841,83 +8743,77 @@ declare type LayoutOptions = {
|
|
|
8841
8743
|
*/
|
|
8842
8744
|
settings?: {
|
|
8843
8745
|
/**
|
|
8844
|
-
*
|
|
8845
|
-
*/
|
|
8846
|
-
newTabButtonUrl?: string;
|
|
8847
|
-
/**
|
|
8848
|
-
* When true the splitters will not be draggable and the layout will not resize.
|
|
8746
|
+
* @defaultValue false
|
|
8849
8747
|
*
|
|
8850
|
-
*
|
|
8748
|
+
* When true the splitters will not be draggable and the layout will not resize.
|
|
8851
8749
|
*/
|
|
8852
8750
|
preventSplitterResize?: boolean;
|
|
8853
8751
|
/**
|
|
8752
|
+
* @defaultValue false
|
|
8753
|
+
*
|
|
8854
8754
|
* Whether the popout button will only act on the entire stack,
|
|
8855
8755
|
* as opposed to only the active tab.
|
|
8856
|
-
*
|
|
8857
|
-
* @default false
|
|
8858
8756
|
*/
|
|
8859
8757
|
popoutWholeStack?: boolean;
|
|
8860
8758
|
/**
|
|
8759
|
+
* @defaultValue false
|
|
8760
|
+
*
|
|
8861
8761
|
* Limits the area to which tabs can be dragged.
|
|
8862
8762
|
* If true, the layout container is the only area where tabs can be dropped.
|
|
8863
|
-
*
|
|
8864
|
-
* @default false
|
|
8865
8763
|
*/
|
|
8866
8764
|
constrainDragToContainer?: boolean;
|
|
8867
8765
|
/**
|
|
8766
|
+
* @defaultValue false
|
|
8767
|
+
*
|
|
8868
8768
|
* Whether to show the popout button on stack header.
|
|
8869
8769
|
* The button will create a new window with current tab as its content.
|
|
8870
8770
|
* In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
|
|
8871
|
-
*
|
|
8872
|
-
* @default false
|
|
8873
8771
|
*/
|
|
8874
8772
|
showPopoutIcon?: boolean;
|
|
8875
8773
|
/**
|
|
8774
|
+
* @defaultValue false
|
|
8775
|
+
*
|
|
8876
8776
|
* Whether to show the maximize button on stack header.
|
|
8877
8777
|
* The button will maximize the current tab to fill the entire window.
|
|
8878
|
-
*
|
|
8879
|
-
* @default false
|
|
8880
8778
|
*/
|
|
8881
8779
|
showMaximiseIcon?: boolean;
|
|
8882
8780
|
/**
|
|
8781
|
+
* @defaultValue false
|
|
8782
|
+
*
|
|
8883
8783
|
* Whether to show the close button on stack header
|
|
8884
8784
|
* (not to be confused with close button on every tab).
|
|
8885
|
-
*
|
|
8886
|
-
* @default false
|
|
8887
8785
|
*/
|
|
8888
8786
|
showCloseIcon?: boolean;
|
|
8889
8787
|
/**
|
|
8890
|
-
*
|
|
8788
|
+
* @defaultValue false
|
|
8891
8789
|
*
|
|
8892
|
-
*
|
|
8790
|
+
* Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
|
|
8893
8791
|
*/
|
|
8894
8792
|
constrainDragToHeaders?: boolean;
|
|
8895
8793
|
/**
|
|
8794
|
+
* @defaultValue true
|
|
8795
|
+
*
|
|
8896
8796
|
* Turns tab headers on or off.
|
|
8897
8797
|
* If false, the layout will be displayed with splitters only.
|
|
8898
|
-
*
|
|
8899
|
-
* @default true
|
|
8900
8798
|
*/
|
|
8901
8799
|
hasHeaders?: boolean;
|
|
8902
8800
|
/**
|
|
8801
|
+
* @defaultValue true
|
|
8802
|
+
*
|
|
8903
8803
|
* If true, the user can re-arrange the layout by
|
|
8904
8804
|
* dragging items by their tabs to the desired location.
|
|
8905
|
-
*
|
|
8906
|
-
* @default true
|
|
8907
8805
|
*/
|
|
8908
8806
|
reorderEnabled?: boolean;
|
|
8909
8807
|
/**
|
|
8910
|
-
*
|
|
8808
|
+
* @defaultValue false
|
|
8911
8809
|
*
|
|
8912
|
-
*
|
|
8810
|
+
* If true, tabs can't be dragged out of the window.
|
|
8913
8811
|
*/
|
|
8914
8812
|
preventDragOut?: boolean;
|
|
8915
8813
|
/**
|
|
8916
8814
|
* @defaultValue=false
|
|
8917
8815
|
*
|
|
8918
8816
|
* If true, tabs can't be dragged into the window.
|
|
8919
|
-
*
|
|
8920
|
-
* @default false
|
|
8921
8817
|
*/
|
|
8922
8818
|
preventDragIn?: boolean;
|
|
8923
8819
|
};
|
|
@@ -9348,19 +9244,6 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
|
|
|
9348
9244
|
*/
|
|
9349
9245
|
declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
|
|
9350
9246
|
|
|
9351
|
-
/**
|
|
9352
|
-
* Behavior for handling multiple {@link DomainSettingsRule} matches.
|
|
9353
|
-
*/
|
|
9354
|
-
declare type MultipleDomainMatchBehavior =
|
|
9355
|
-
/**
|
|
9356
|
-
* Apply only the first matching rule in the list.
|
|
9357
|
-
*/
|
|
9358
|
-
'pick-first'
|
|
9359
|
-
/**
|
|
9360
|
-
* Deep-merge all matching rules in the list, prioritizing earlier matches. Treats arrays as primitives.
|
|
9361
|
-
*/
|
|
9362
|
-
| 'deep-merge';
|
|
9363
|
-
|
|
9364
9247
|
/**
|
|
9365
9248
|
* @interface
|
|
9366
9249
|
*/
|
|
@@ -9369,10 +9252,10 @@ declare type MutableViewOptions = {
|
|
|
9369
9252
|
/**
|
|
9370
9253
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9371
9254
|
*
|
|
9255
|
+
* @defaultValue true
|
|
9256
|
+
*
|
|
9372
9257
|
* Show the context menu when right-clicking on the view.
|
|
9373
9258
|
* Gives access to the devtools for the view.
|
|
9374
|
-
*
|
|
9375
|
-
* @default true
|
|
9376
9259
|
*/
|
|
9377
9260
|
contextMenu: boolean;
|
|
9378
9261
|
/**
|
|
@@ -9419,25 +9302,24 @@ declare type MutableViewOptions = {
|
|
|
9419
9302
|
contentNavigation: ContentNavigation;
|
|
9420
9303
|
contentRedirect: ContentRedirect;
|
|
9421
9304
|
/**
|
|
9305
|
+
* @defaultValue false
|
|
9422
9306
|
* @deprecated
|
|
9423
9307
|
* **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
|
|
9424
9308
|
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
|
9425
|
-
*
|
|
9426
|
-
* @default false
|
|
9427
9309
|
*/
|
|
9428
9310
|
detachOnClose: boolean;
|
|
9429
9311
|
/**
|
|
9312
|
+
* @defaultValue true
|
|
9313
|
+
*
|
|
9430
9314
|
* **Platforms Only.** If false, the view will be persistent and can't be closed through
|
|
9431
9315
|
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
|
9432
9316
|
* if the view isn't part of the new layout when running `Layout.replace`.
|
|
9433
|
-
*
|
|
9434
|
-
* @default true
|
|
9435
9317
|
*/
|
|
9436
9318
|
isClosable: boolean;
|
|
9437
9319
|
/**
|
|
9438
|
-
*
|
|
9320
|
+
* @defaultValue false
|
|
9439
9321
|
*
|
|
9440
|
-
*
|
|
9322
|
+
* **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
|
9441
9323
|
*/
|
|
9442
9324
|
preventDragOut: boolean;
|
|
9443
9325
|
interop?: InteropConfig;
|
|
@@ -9445,7 +9327,7 @@ declare type MutableViewOptions = {
|
|
|
9445
9327
|
/**
|
|
9446
9328
|
* {@inheritDoc ViewThrottling}
|
|
9447
9329
|
*
|
|
9448
|
-
* @
|
|
9330
|
+
* @defaultValue 'enabled'
|
|
9449
9331
|
*/
|
|
9450
9332
|
throttling: ViewThrottling;
|
|
9451
9333
|
/**
|
|
@@ -9464,7 +9346,7 @@ declare type MutableWindowOptions = {
|
|
|
9464
9346
|
* Turns anything of matching RGB value transparent.
|
|
9465
9347
|
*
|
|
9466
9348
|
* Caveats:
|
|
9467
|
-
* *
|
|
9349
|
+
* * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
|
|
9468
9350
|
* * User cannot click-through transparent regions
|
|
9469
9351
|
* * Not supported on Mac
|
|
9470
9352
|
* * Windows Aero must be enabled
|
|
@@ -9473,25 +9355,25 @@ declare type MutableWindowOptions = {
|
|
|
9473
9355
|
*/
|
|
9474
9356
|
alphaMask: RGB;
|
|
9475
9357
|
/**
|
|
9476
|
-
*
|
|
9358
|
+
* @defaultValue false
|
|
9477
9359
|
*
|
|
9478
|
-
*
|
|
9360
|
+
* Always position the window at the top of the window stack.
|
|
9479
9361
|
*/
|
|
9480
9362
|
alwaysOnTop: boolean;
|
|
9481
9363
|
/**
|
|
9364
|
+
* @defaultValue 0
|
|
9365
|
+
*
|
|
9482
9366
|
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
|
9483
9367
|
* an aspect ratio will not be enforced.
|
|
9484
|
-
*
|
|
9485
|
-
* @default 0
|
|
9486
9368
|
*/
|
|
9487
9369
|
aspectRatio: number;
|
|
9488
9370
|
/**
|
|
9489
9371
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9490
9372
|
*
|
|
9373
|
+
* @defaultValue true
|
|
9374
|
+
*
|
|
9491
9375
|
* Show the context menu when right-clicking on the window.
|
|
9492
9376
|
* Gives access to the devtools for the window.
|
|
9493
|
-
*
|
|
9494
|
-
* @default true
|
|
9495
9377
|
*/
|
|
9496
9378
|
contextMenu: boolean;
|
|
9497
9379
|
/**
|
|
@@ -9558,18 +9440,15 @@ declare type MutableWindowOptions = {
|
|
|
9558
9440
|
*/
|
|
9559
9441
|
customData: any;
|
|
9560
9442
|
/**
|
|
9561
|
-
* @deprecated Will be removed in runtime version 45
|
|
9562
9443
|
* @defaultValue true
|
|
9563
9444
|
*
|
|
9564
9445
|
* Show the window's frame.
|
|
9565
|
-
*
|
|
9566
|
-
* @default true
|
|
9567
9446
|
*/
|
|
9568
9447
|
frame: boolean;
|
|
9569
9448
|
/**
|
|
9570
|
-
*
|
|
9449
|
+
* @defaultValue false
|
|
9571
9450
|
*
|
|
9572
|
-
*
|
|
9451
|
+
* Hides the window instead of closing it when the close button is pressed.
|
|
9573
9452
|
*/
|
|
9574
9453
|
hideOnClose: boolean;
|
|
9575
9454
|
/**
|
|
@@ -9622,61 +9501,60 @@ declare type MutableWindowOptions = {
|
|
|
9622
9501
|
*/
|
|
9623
9502
|
icon: string;
|
|
9624
9503
|
/**
|
|
9504
|
+
* @defaultValue true
|
|
9505
|
+
*
|
|
9625
9506
|
* Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
|
9626
9507
|
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
|
9627
|
-
*
|
|
9628
|
-
* @default true
|
|
9629
9508
|
*/
|
|
9630
9509
|
includeInSnapshots: boolean;
|
|
9631
9510
|
/**
|
|
9632
|
-
*
|
|
9511
|
+
* @defaultValue -1
|
|
9633
9512
|
*
|
|
9634
|
-
*
|
|
9513
|
+
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
|
9635
9514
|
*/
|
|
9636
9515
|
maxHeight: number;
|
|
9637
9516
|
/**
|
|
9638
|
-
*
|
|
9517
|
+
* @defaultValue true
|
|
9639
9518
|
*
|
|
9640
|
-
*
|
|
9519
|
+
* Allows the window to be maximized.
|
|
9641
9520
|
*/
|
|
9642
9521
|
maximizable: boolean;
|
|
9643
9522
|
/**
|
|
9644
|
-
*
|
|
9523
|
+
* @defaultValue -1
|
|
9645
9524
|
*
|
|
9646
|
-
*
|
|
9525
|
+
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
|
9647
9526
|
*/
|
|
9648
9527
|
maxWidth: number;
|
|
9649
9528
|
/**
|
|
9650
|
-
*
|
|
9529
|
+
* @defaultValue 0
|
|
9651
9530
|
*
|
|
9652
|
-
*
|
|
9531
|
+
* The minimum height of the window.
|
|
9653
9532
|
*/
|
|
9654
9533
|
minHeight: number;
|
|
9655
9534
|
/**
|
|
9656
|
-
*
|
|
9535
|
+
* @defaultValue true
|
|
9657
9536
|
*
|
|
9658
|
-
*
|
|
9537
|
+
* Allows the window to be minimized.
|
|
9659
9538
|
*/
|
|
9660
9539
|
minimizable: boolean;
|
|
9661
9540
|
/**
|
|
9662
|
-
*
|
|
9541
|
+
* @defaultValue true
|
|
9663
9542
|
*
|
|
9664
|
-
*
|
|
9543
|
+
* The minimum width of the window.
|
|
9665
9544
|
*/
|
|
9666
9545
|
minWidth: number;
|
|
9667
9546
|
/**
|
|
9547
|
+
* @defaultValue 1
|
|
9548
|
+
*
|
|
9668
9549
|
* A flag that specifies how transparent the window will be.
|
|
9669
9550
|
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
|
9670
9551
|
* This value is clamped between `0.0` and `1.0`.
|
|
9671
|
-
* In software composition mode, the runtime flag --allow-unsafe-compositing is required.
|
|
9672
|
-
*
|
|
9673
|
-
* @default 1
|
|
9674
9552
|
*/
|
|
9675
9553
|
opacity: number;
|
|
9676
9554
|
/**
|
|
9677
|
-
*
|
|
9555
|
+
* @defaultValue true
|
|
9678
9556
|
*
|
|
9679
|
-
*
|
|
9557
|
+
* A flag to allow the user to resize the window.
|
|
9680
9558
|
*/
|
|
9681
9559
|
resizable: boolean;
|
|
9682
9560
|
/**
|
|
@@ -9684,22 +9562,16 @@ declare type MutableWindowOptions = {
|
|
|
9684
9562
|
*/
|
|
9685
9563
|
resizeRegion: ResizeRegion;
|
|
9686
9564
|
/**
|
|
9565
|
+
* @defaultValue false
|
|
9566
|
+
*
|
|
9687
9567
|
* **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
|
|
9688
9568
|
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
|
9689
|
-
*
|
|
9690
|
-
* @default false
|
|
9691
9569
|
*/
|
|
9692
9570
|
showBackgroundImages: boolean;
|
|
9693
9571
|
/**
|
|
9694
|
-
*
|
|
9695
|
-
*
|
|
9696
|
-
* @remarks
|
|
9697
|
-
* In Windows, setting `showTaskbarIcon` to false will cause the window to display on all virtual desktops.
|
|
9698
|
-
* In order to prevent this while keeping `showTaskbarIcon` false, pass the identity of the parent via the
|
|
9699
|
-
* `modalParentIdentity` (see {@link WindowCreationOptions}). This is useful for popups managed by
|
|
9700
|
-
* {@link Window._Window.showPopupWindow}.
|
|
9572
|
+
* @defaultValue true
|
|
9701
9573
|
*
|
|
9702
|
-
*
|
|
9574
|
+
* Shows the window's icon in the taskbar.
|
|
9703
9575
|
*/
|
|
9704
9576
|
showTaskbarIcon: boolean;
|
|
9705
9577
|
/**
|
|
@@ -9718,7 +9590,7 @@ declare type MutableWindowOptions = {
|
|
|
9718
9590
|
/**
|
|
9719
9591
|
* {@inheritDoc WindowThrottling}
|
|
9720
9592
|
*
|
|
9721
|
-
* @
|
|
9593
|
+
* @defaultValue 'enabled'
|
|
9722
9594
|
*
|
|
9723
9595
|
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
|
9724
9596
|
*/
|
|
@@ -9977,7 +9849,6 @@ declare namespace OpenFin {
|
|
|
9977
9849
|
ViewCreationOptions,
|
|
9978
9850
|
MutableViewOptions,
|
|
9979
9851
|
ViewOptions,
|
|
9980
|
-
ViewTitlePriority,
|
|
9981
9852
|
ConstViewOptions,
|
|
9982
9853
|
ViewState,
|
|
9983
9854
|
ViewCreationSuccess,
|
|
@@ -10012,7 +9883,6 @@ declare namespace OpenFin {
|
|
|
10012
9883
|
OpenExternalPermission,
|
|
10013
9884
|
DeviceInfo,
|
|
10014
9885
|
Permissions_2 as Permissions,
|
|
10015
|
-
ClipboardApiPermissions,
|
|
10016
9886
|
PlatformWindowCreationOptions,
|
|
10017
9887
|
PlatformWindowOptions,
|
|
10018
9888
|
PlatformViewCreationOptions,
|
|
@@ -10118,18 +9988,17 @@ declare namespace OpenFin {
|
|
|
10118
9988
|
RuntimeInfo,
|
|
10119
9989
|
DefaultDomainSettings,
|
|
10120
9990
|
DefaultDomainSettingsRule,
|
|
10121
|
-
MultipleDomainMatchBehavior,
|
|
10122
9991
|
DomainSettings,
|
|
10123
9992
|
ApiInjection,
|
|
10124
9993
|
DomainApiSettings,
|
|
10125
9994
|
BaseContentBehavior,
|
|
10126
9995
|
ContentBehavior,
|
|
9996
|
+
BaseStructuredContentBehavior,
|
|
10127
9997
|
BrowserContentBehavior,
|
|
10128
9998
|
StructuredContentBehavior,
|
|
10129
9999
|
StructuredContentPermissions,
|
|
10130
10000
|
ContentPermission,
|
|
10131
10001
|
ScreenCaptureBehavior,
|
|
10132
|
-
DomainSettingsPreloadScripts,
|
|
10133
10002
|
PerDomainSettings,
|
|
10134
10003
|
CopyPermissions,
|
|
10135
10004
|
PastePermissions,
|
|
@@ -10233,7 +10102,6 @@ declare namespace OpenFin {
|
|
|
10233
10102
|
Me,
|
|
10234
10103
|
CapturePageOptions,
|
|
10235
10104
|
ProcessLoggingOptions,
|
|
10236
|
-
BoundsType,
|
|
10237
10105
|
PositioningOptions,
|
|
10238
10106
|
ChannelClientConnectionListener,
|
|
10239
10107
|
ChannelClientDisconnectionListener,
|
|
@@ -10247,7 +10115,6 @@ declare namespace OpenFin {
|
|
|
10247
10115
|
PathServeRequest,
|
|
10248
10116
|
ServeAssetOptions,
|
|
10249
10117
|
ServedAssetInfo,
|
|
10250
|
-
ResolvedDomainSettings,
|
|
10251
10118
|
ApplicationEvents,
|
|
10252
10119
|
BaseEvents,
|
|
10253
10120
|
ExternalApplicationEvents,
|
|
@@ -10324,16 +10191,15 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
|
|
|
10324
10191
|
|
|
10325
10192
|
/**
|
|
10326
10193
|
* Control copy operations for a matched URL.
|
|
10327
|
-
* @interface
|
|
10328
10194
|
*/
|
|
10329
10195
|
declare type PastePermissions = {
|
|
10330
10196
|
/**
|
|
10197
|
+
* @defaultValue 'non-protected-content'
|
|
10198
|
+
*
|
|
10331
10199
|
* Controls the behavior for paste operations for a matched URL.
|
|
10332
10200
|
*
|
|
10333
10201
|
* non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
|
|
10334
10202
|
* 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.
|
|
10335
|
-
*
|
|
10336
|
-
* @default 'non-protected-content'
|
|
10337
10203
|
*/
|
|
10338
10204
|
behavior: 'non-protected-content' | 'all-content';
|
|
10339
10205
|
};
|
|
@@ -10481,13 +10347,6 @@ declare type PerDomainSettings = {
|
|
|
10481
10347
|
* {@inheritdoc ChromiumPolicies}
|
|
10482
10348
|
*/
|
|
10483
10349
|
chromiumPolicies?: ChromiumPolicies;
|
|
10484
|
-
/**
|
|
10485
|
-
* {@inheritdoc DomainSettingsPreloadScripts}
|
|
10486
|
-
*/
|
|
10487
|
-
preloadScripts?: DomainSettingsPreloadScripts;
|
|
10488
|
-
/**
|
|
10489
|
-
* @experimental These features are still under development and may change.
|
|
10490
|
-
*/
|
|
10491
10350
|
contentProtection?: {
|
|
10492
10351
|
/**
|
|
10493
10352
|
* {@inheritdoc ScreenCaptureBehavior}
|
|
@@ -10497,16 +10356,6 @@ declare type PerDomainSettings = {
|
|
|
10497
10356
|
* {@inheritdoc ClipboardPermissions}
|
|
10498
10357
|
*/
|
|
10499
10358
|
clipboard?: ClipboardPermissions;
|
|
10500
|
-
/**
|
|
10501
|
-
* Whether the content can be printed.
|
|
10502
|
-
* Defaults to 'allow'.
|
|
10503
|
-
* Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
|
|
10504
|
-
*/
|
|
10505
|
-
print?: 'allow' | 'block';
|
|
10506
|
-
/**
|
|
10507
|
-
* * Controls whether HTML5 dragging for this content is allowed or blocked.
|
|
10508
|
-
*/
|
|
10509
|
-
drag?: 'allow' | 'block';
|
|
10510
10359
|
};
|
|
10511
10360
|
};
|
|
10512
10361
|
|
|
@@ -10532,7 +10381,6 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
|
|
10532
10381
|
declare type Permissions_2 = {
|
|
10533
10382
|
Application?: Partial<ApplicationPermissions>;
|
|
10534
10383
|
System?: Partial<SystemPermissions>;
|
|
10535
|
-
Clipboard?: Partial<ClipboardApiPermissions>;
|
|
10536
10384
|
webAPIs?: WebPermission[];
|
|
10537
10385
|
devices?: DeviceInfo[];
|
|
10538
10386
|
};
|
|
@@ -11364,11 +11212,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
11364
11212
|
*/
|
|
11365
11213
|
providerUrl?: string;
|
|
11366
11214
|
/**
|
|
11215
|
+
* @defaultValue true
|
|
11216
|
+
*
|
|
11367
11217
|
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
|
11368
11218
|
*
|
|
11369
11219
|
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
|
11370
|
-
*
|
|
11371
|
-
* @default true
|
|
11372
11220
|
*/
|
|
11373
11221
|
allowLaunchIntoPlatform?: boolean;
|
|
11374
11222
|
};
|
|
@@ -11903,14 +11751,6 @@ declare interface PlatformProvider {
|
|
|
11903
11751
|
* ```
|
|
11904
11752
|
*/
|
|
11905
11753
|
handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
|
|
11906
|
-
/**
|
|
11907
|
-
* Determines whether a given window should prevent the application from quitting when it is closed.
|
|
11908
|
-
* This method is called when checking if closing a window should trigger application termination.
|
|
11909
|
-
*
|
|
11910
|
-
* @param windowIdentity - The identity of the window being checked.
|
|
11911
|
-
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
11912
|
-
*/
|
|
11913
|
-
shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
|
|
11914
11754
|
}
|
|
11915
11755
|
|
|
11916
11756
|
/**
|
|
@@ -12012,22 +11852,22 @@ declare type PopupOptions = {
|
|
|
12012
11852
|
url?: string;
|
|
12013
11853
|
/**
|
|
12014
11854
|
* Height of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12015
|
-
* @
|
|
11855
|
+
* @defaultValue 300
|
|
12016
11856
|
*/
|
|
12017
11857
|
height?: number;
|
|
12018
11858
|
/**
|
|
12019
11859
|
* Width of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12020
|
-
* @
|
|
11860
|
+
* @defaultValue 300
|
|
12021
11861
|
*/
|
|
12022
11862
|
width?: number;
|
|
12023
11863
|
/**
|
|
12024
11864
|
* Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12025
|
-
* @
|
|
11865
|
+
* @defaultValue 0
|
|
12026
11866
|
*/
|
|
12027
11867
|
x?: number;
|
|
12028
11868
|
/**
|
|
12029
11869
|
* Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12030
|
-
* @
|
|
11870
|
+
* @defaultValue 0
|
|
12031
11871
|
*/
|
|
12032
11872
|
y?: number;
|
|
12033
11873
|
/**
|
|
@@ -12035,7 +11875,7 @@ declare type PopupOptions = {
|
|
|
12035
11875
|
* * 'modal' restricts resizing and positioning in the caller.
|
|
12036
11876
|
* * 'hide' hides the popup window on blur.
|
|
12037
11877
|
* * 'close' closes the popup window on blur.
|
|
12038
|
-
* @
|
|
11878
|
+
* @defaultValue 'close'
|
|
12039
11879
|
*/
|
|
12040
11880
|
blurBehavior?: PopupBlurBehavior;
|
|
12041
11881
|
/**
|
|
@@ -12043,19 +11883,19 @@ declare type PopupOptions = {
|
|
|
12043
11883
|
* * 'none' will do nothing.
|
|
12044
11884
|
* * 'hide' hides the popup window on `dispatchPopupResult`.
|
|
12045
11885
|
* * 'close' closes the popup window on `dispatchPopupResult`.
|
|
12046
|
-
* @
|
|
11886
|
+
* @defaultValue 'close'
|
|
12047
11887
|
*/
|
|
12048
11888
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
12049
11889
|
/**
|
|
12050
11890
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
12051
11891
|
*
|
|
12052
11892
|
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
12053
|
-
* @
|
|
11893
|
+
* @defaultValue false
|
|
12054
11894
|
*/
|
|
12055
11895
|
hideOnClose?: boolean;
|
|
12056
11896
|
/**
|
|
12057
11897
|
* Determines if the popup window should or should not be focused when it is shown.
|
|
12058
|
-
* @
|
|
11898
|
+
* @defaultValue true
|
|
12059
11899
|
*/
|
|
12060
11900
|
focus?: boolean;
|
|
12061
11901
|
/**
|
|
@@ -12134,7 +11974,6 @@ declare type PositioningOptions = {
|
|
|
12134
11974
|
* This will have the effect of the maximized window staying maximized and not immediately taking this new position.
|
|
12135
11975
|
*/
|
|
12136
11976
|
skipRestore?: boolean;
|
|
12137
|
-
boundsType?: BoundsType;
|
|
12138
11977
|
};
|
|
12139
11978
|
|
|
12140
11979
|
/**
|
|
@@ -12149,9 +11988,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
|
|
|
12149
11988
|
*/
|
|
12150
11989
|
declare type PreloadScript = {
|
|
12151
11990
|
/**
|
|
12152
|
-
*
|
|
11991
|
+
* @defaultValue false
|
|
12153
11992
|
*
|
|
12154
|
-
*
|
|
11993
|
+
* Fail to load the window if this preload script fails
|
|
12155
11994
|
*/
|
|
12156
11995
|
mandatory?: boolean;
|
|
12157
11996
|
/**
|
|
@@ -12247,15 +12086,15 @@ declare type PrinterInfo = {
|
|
|
12247
12086
|
declare type PrintOptions = {
|
|
12248
12087
|
content?: 'self';
|
|
12249
12088
|
/**
|
|
12250
|
-
*
|
|
12089
|
+
* @defaultValue false
|
|
12251
12090
|
*
|
|
12252
|
-
*
|
|
12091
|
+
* Disables prompting the user for print settings.
|
|
12253
12092
|
*/
|
|
12254
12093
|
silent?: boolean;
|
|
12255
12094
|
/**
|
|
12256
|
-
*
|
|
12095
|
+
* @defaultValue false
|
|
12257
12096
|
*
|
|
12258
|
-
*
|
|
12097
|
+
* Includes the webpage background color and image when printing.
|
|
12259
12098
|
*/
|
|
12260
12099
|
printBackground?: boolean;
|
|
12261
12100
|
/**
|
|
@@ -12263,9 +12102,9 @@ declare type PrintOptions = {
|
|
|
12263
12102
|
*/
|
|
12264
12103
|
deviceName?: string;
|
|
12265
12104
|
/**
|
|
12266
|
-
*
|
|
12105
|
+
* @defaultValue true
|
|
12267
12106
|
*
|
|
12268
|
-
*
|
|
12107
|
+
* Prints in full color (greyscale otherwise).
|
|
12269
12108
|
*/
|
|
12270
12109
|
color?: boolean;
|
|
12271
12110
|
/**
|
|
@@ -12273,9 +12112,9 @@ declare type PrintOptions = {
|
|
|
12273
12112
|
*/
|
|
12274
12113
|
margins?: Margins;
|
|
12275
12114
|
/**
|
|
12276
|
-
*
|
|
12115
|
+
* @defaultValue true
|
|
12277
12116
|
*
|
|
12278
|
-
*
|
|
12117
|
+
* Prints in landscape mode (portrait otherwise).
|
|
12279
12118
|
*/
|
|
12280
12119
|
landscape?: boolean;
|
|
12281
12120
|
/**
|
|
@@ -12661,10 +12500,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12661
12500
|
transitions: OpenFin.Transition;
|
|
12662
12501
|
options: OpenFin.TransitionOptions;
|
|
12663
12502
|
}>;
|
|
12664
|
-
'activate-window-and-focus': ApiCall<{
|
|
12665
|
-
winIdentity: OpenFin.Identity;
|
|
12666
|
-
focusIdentity: OpenFin.Identity;
|
|
12667
|
-
}, boolean>;
|
|
12668
12503
|
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12669
12504
|
'get-window-bounds': IdentityCall<{
|
|
12670
12505
|
options?: OpenFin.GetBoundsOptions;
|
|
@@ -13003,19 +12838,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13003
12838
|
'system-update-process-logging-options': ApiCall<{
|
|
13004
12839
|
options: OpenFin.ProcessLoggingOptions;
|
|
13005
12840
|
}, void>;
|
|
13006
|
-
'get-domain-settings': ApiCall<
|
|
12841
|
+
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
13007
12842
|
'serve-asset': ApiCall<{
|
|
13008
12843
|
options: OpenFin.ServeAssetOptions;
|
|
13009
12844
|
}, OpenFin.ServedAssetInfo>;
|
|
13010
|
-
'set-domain-settings': ApiCall<{
|
|
13011
|
-
domainSettings: OpenFin.
|
|
12845
|
+
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12846
|
+
domainSettings: OpenFin.DefaultDomainSettings;
|
|
13012
12847
|
}, void>;
|
|
13013
|
-
'get-current-domain-settings': ApiCall<{
|
|
13014
|
-
identity: OpenFin.Identity;
|
|
13015
|
-
}, OpenFin.ResolvedDomainSettings>;
|
|
13016
|
-
'resolve-domain-settings': ApiCall<{
|
|
13017
|
-
url: string;
|
|
13018
|
-
}, OpenFin.ResolvedDomainSettings>;
|
|
13019
12848
|
'system-register-shutdown-handler': VoidCall;
|
|
13020
12849
|
'get-permissions': GetterCall<any>;
|
|
13021
12850
|
'refresh-extensions': {
|
|
@@ -13456,15 +13285,15 @@ declare type ReplaceViewPayload = {
|
|
|
13456
13285
|
*/
|
|
13457
13286
|
declare type ResizeRegion = {
|
|
13458
13287
|
/**
|
|
13459
|
-
*
|
|
13288
|
+
* @defaultValue 7
|
|
13460
13289
|
*
|
|
13461
|
-
*
|
|
13290
|
+
* The size of the resize region in pixels.
|
|
13462
13291
|
*/
|
|
13463
13292
|
size?: number;
|
|
13464
13293
|
/**
|
|
13465
|
-
*
|
|
13294
|
+
* @defaultValue 9
|
|
13466
13295
|
*
|
|
13467
|
-
*
|
|
13296
|
+
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
|
13468
13297
|
*/
|
|
13469
13298
|
bottomRightCorner?: number;
|
|
13470
13299
|
/**
|
|
@@ -13472,40 +13301,32 @@ declare type ResizeRegion = {
|
|
|
13472
13301
|
*/
|
|
13473
13302
|
sides?: {
|
|
13474
13303
|
/**
|
|
13475
|
-
*
|
|
13304
|
+
* @defaultValue true
|
|
13476
13305
|
*
|
|
13477
|
-
*
|
|
13306
|
+
* Enables resizing from the top of the window.
|
|
13478
13307
|
*/
|
|
13479
13308
|
top?: boolean;
|
|
13480
13309
|
/**
|
|
13481
|
-
*
|
|
13310
|
+
* @defaultValue true
|
|
13482
13311
|
*
|
|
13483
|
-
*
|
|
13312
|
+
* Enables resizing from the bottom of the window.
|
|
13484
13313
|
*/
|
|
13485
13314
|
bottom?: boolean;
|
|
13486
13315
|
/**
|
|
13487
|
-
*
|
|
13316
|
+
* @defaultValue true
|
|
13488
13317
|
*
|
|
13489
|
-
*
|
|
13318
|
+
* Enables resizing from the left side of the window.
|
|
13490
13319
|
*/
|
|
13491
13320
|
left?: boolean;
|
|
13492
13321
|
/**
|
|
13493
|
-
*
|
|
13322
|
+
* @defaultValue true
|
|
13494
13323
|
*
|
|
13495
|
-
*
|
|
13324
|
+
* Enables resizing from the right side of the window.
|
|
13496
13325
|
*/
|
|
13497
13326
|
right?: boolean;
|
|
13498
13327
|
};
|
|
13499
13328
|
};
|
|
13500
13329
|
|
|
13501
|
-
declare type ResolvedDomainSettings = {
|
|
13502
|
-
url: string;
|
|
13503
|
-
settings: PerDomainSettings;
|
|
13504
|
-
matches: DomainSettingsRule[];
|
|
13505
|
-
multipleDomainMatchBehavior: MultipleDomainMatchBehavior;
|
|
13506
|
-
default?: PerDomainSettings;
|
|
13507
|
-
};
|
|
13508
|
-
|
|
13509
13330
|
/**
|
|
13510
13331
|
* Generated when an HTTP load was cancelled or failed.
|
|
13511
13332
|
* @interface
|
|
@@ -13682,20 +13503,12 @@ declare type RVMInfo = {
|
|
|
13682
13503
|
* The app log directory.
|
|
13683
13504
|
*/
|
|
13684
13505
|
'appLogDirectory': string;
|
|
13685
|
-
/**
|
|
13686
|
-
* Architecture of the OS that the RVM is running on. One of `arm64`, `x86`, `x64`. Available since RVM 16.
|
|
13687
|
-
*/
|
|
13688
|
-
'osArch': string;
|
|
13689
13506
|
/**
|
|
13690
13507
|
* The path of OpenfinRVM.exe.
|
|
13691
13508
|
*/
|
|
13692
13509
|
'path': string;
|
|
13693
13510
|
/**
|
|
13694
|
-
*
|
|
13695
|
-
*/
|
|
13696
|
-
'rvmArch': string;
|
|
13697
|
-
/**
|
|
13698
|
-
* The start time of RVM. Format is `YYYY-MM-DD HH:MM:SS` in local time or `NA` on error.
|
|
13511
|
+
* The start time of RVM.
|
|
13699
13512
|
*/
|
|
13700
13513
|
'start-time': string;
|
|
13701
13514
|
/**
|
|
@@ -13728,6 +13541,7 @@ declare type RvmLaunchOptions = {
|
|
|
13728
13541
|
};
|
|
13729
13542
|
|
|
13730
13543
|
/**
|
|
13544
|
+
* @interface
|
|
13731
13545
|
* Controls whether this content should be allowed or blocked when capturing the screen.
|
|
13732
13546
|
*/
|
|
13733
13547
|
declare type ScreenCaptureBehavior = 'allow' | 'block';
|
|
@@ -14044,9 +13858,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
|
|
|
14044
13858
|
*/
|
|
14045
13859
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
14046
13860
|
/**
|
|
14047
|
-
*
|
|
13861
|
+
* @defaultValue 0
|
|
14048
13862
|
*
|
|
14049
|
-
*
|
|
13863
|
+
* Number of milliseconds to wait between view repaints.
|
|
14050
13864
|
*/
|
|
14051
13865
|
paintIntervalMs?: number;
|
|
14052
13866
|
};
|
|
@@ -14219,15 +14033,12 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
|
14219
14033
|
};
|
|
14220
14034
|
|
|
14221
14035
|
/**
|
|
14222
|
-
*
|
|
14036
|
+
* Allows more control over content behaviors
|
|
14223
14037
|
*/
|
|
14224
|
-
declare type StructuredContentBehavior =
|
|
14225
|
-
behavior: BaseContentBehavior;
|
|
14226
|
-
} | BrowserContentBehavior;
|
|
14038
|
+
declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
|
|
14227
14039
|
|
|
14228
14040
|
/**
|
|
14229
|
-
*
|
|
14230
|
-
* @interface
|
|
14041
|
+
* Specify rules for specific actions.
|
|
14231
14042
|
*/
|
|
14232
14043
|
declare type StructuredContentPermissions = {
|
|
14233
14044
|
/**
|
|
@@ -15713,9 +15524,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15713
15524
|
* // }
|
|
15714
15525
|
* ```
|
|
15715
15526
|
*/
|
|
15716
|
-
setDomainSettings(domainSettings: OpenFin.
|
|
15717
|
-
getCurrentDomainSettings(identity: OpenFin.Identity): Promise<OpenFin.ResolvedDomainSettings>;
|
|
15718
|
-
resolveDomainSettings(url: string): Promise<OpenFin.ResolvedDomainSettings>;
|
|
15527
|
+
setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
|
|
15719
15528
|
/**
|
|
15720
15529
|
* Attempts to install and enable extensions for the security realm. Users may want to call this function in response
|
|
15721
15530
|
* to an `extensions-install-failed` event. Only extensions allowed by every application on the current security realm
|
|
@@ -15789,10 +15598,6 @@ declare type SystemEventType = EventType_8;
|
|
|
15789
15598
|
declare type SystemPermissions = {
|
|
15790
15599
|
getOSInfo: boolean;
|
|
15791
15600
|
getAllExternalWindows: boolean;
|
|
15792
|
-
setDomainSettings: boolean;
|
|
15793
|
-
getDomainSettings: boolean;
|
|
15794
|
-
getCurrentDomainSettings: boolean;
|
|
15795
|
-
resolveDomainSettings: boolean;
|
|
15796
15601
|
launchExternalProcess: boolean | {
|
|
15797
15602
|
enabled: boolean;
|
|
15798
15603
|
assets?: {
|
|
@@ -16090,9 +15895,9 @@ declare type TransitionBase = {
|
|
|
16090
15895
|
*/
|
|
16091
15896
|
duration: number;
|
|
16092
15897
|
/**
|
|
16093
|
-
*
|
|
15898
|
+
* @defaultValue false
|
|
16094
15899
|
*
|
|
16095
|
-
*
|
|
15900
|
+
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16096
15901
|
*/
|
|
16097
15902
|
relative?: boolean;
|
|
16098
15903
|
};
|
|
@@ -16108,9 +15913,9 @@ declare type TransitionOptions = {
|
|
|
16108
15913
|
*/
|
|
16109
15914
|
interrupt: boolean;
|
|
16110
15915
|
/**
|
|
16111
|
-
*
|
|
15916
|
+
* @defaultValue false
|
|
16112
15917
|
*
|
|
16113
|
-
*
|
|
15918
|
+
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16114
15919
|
*/
|
|
16115
15920
|
relative?: boolean;
|
|
16116
15921
|
tween?: tween;
|
|
@@ -16129,7 +15934,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
16129
15934
|
sendRaw: Wire['send'];
|
|
16130
15935
|
eventAggregator: EventAggregator;
|
|
16131
15936
|
protected messageHandlers: MessageHandler[];
|
|
16132
|
-
constructor(
|
|
15937
|
+
constructor(WireType: WireConstructor, environment: Environment, config: OpenFin.Identity);
|
|
16133
15938
|
getFin(): OpenFin.Fin<MeType>;
|
|
16134
15939
|
registerFin(_fin: OpenFin.Fin<MeType>): void;
|
|
16135
15940
|
connectSync: () => void;
|
|
@@ -17131,12 +16936,6 @@ declare interface ViewStatuses {
|
|
|
17131
16936
|
*/
|
|
17132
16937
|
declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
|
|
17133
16938
|
|
|
17134
|
-
/**
|
|
17135
|
-
* Precedence for view tab title
|
|
17136
|
-
* @interface
|
|
17137
|
-
*/
|
|
17138
|
-
declare type ViewTitlePriority = 'document' | 'options';
|
|
17139
|
-
|
|
17140
16939
|
/**
|
|
17141
16940
|
* Configuration for view visibility settings
|
|
17142
16941
|
*
|
|
@@ -17144,9 +16943,9 @@ declare type ViewTitlePriority = 'document' | 'options';
|
|
|
17144
16943
|
*/
|
|
17145
16944
|
declare type ViewVisibilityOption = {
|
|
17146
16945
|
/**
|
|
17147
|
-
*
|
|
16946
|
+
* @defaultValue false
|
|
17148
16947
|
*
|
|
17149
|
-
*
|
|
16948
|
+
* Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
|
|
17150
16949
|
*/
|
|
17151
16950
|
enabled?: boolean;
|
|
17152
16951
|
};
|
|
@@ -18320,30 +18119,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
|
18320
18119
|
* ```
|
|
18321
18120
|
*/
|
|
18322
18121
|
getAllFrames(): Promise<Array<OpenFin.FrameInfo>>;
|
|
18323
|
-
/**
|
|
18324
|
-
* Activates the current window and focuses the child entity if it exists. If this does
|
|
18325
|
-
* not succeed - say the child does not belong to this window, or the identity does not exist -
|
|
18326
|
-
* it will return false.
|
|
18327
|
-
*
|
|
18328
|
-
* @example
|
|
18329
|
-
* ```js
|
|
18330
|
-
* const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
|
|
18331
|
-
*
|
|
18332
|
-
* win.getCurrentViews()
|
|
18333
|
-
* .then(([view1]) => {
|
|
18334
|
-
* return win.activateAndFocus(view1.identity);
|
|
18335
|
-
* })
|
|
18336
|
-
* .then(success => {
|
|
18337
|
-
* if (success) {
|
|
18338
|
-
* console.log('Window activated and child focused');
|
|
18339
|
-
* } else {
|
|
18340
|
-
* console.log('Window activation failed, focus state unchanged');
|
|
18341
|
-
* }
|
|
18342
|
-
* })
|
|
18343
|
-
* .catch(console.error);
|
|
18344
|
-
* ```
|
|
18345
|
-
*/
|
|
18346
|
-
activateAndFocus(childIdentityToFocus: OpenFin.Identity): Promise<boolean>;
|
|
18347
18122
|
/**
|
|
18348
18123
|
* Gets the current bounds (top, bottom, right, left, width, height) of the window.
|
|
18349
18124
|
*
|
|
@@ -19330,10 +19105,6 @@ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
|
|
|
19330
19105
|
declare type WindowBounds = Bounds & {
|
|
19331
19106
|
bottom: number;
|
|
19332
19107
|
right: number;
|
|
19333
|
-
/**
|
|
19334
|
-
* The bounds for the window's web content, excluding any OS border
|
|
19335
|
-
*/
|
|
19336
|
-
content: Bounds;
|
|
19337
19108
|
};
|
|
19338
19109
|
|
|
19339
19110
|
/**
|
|
@@ -19758,7 +19529,9 @@ declare type Wire = EventEmitter & {
|
|
|
19758
19529
|
getPort(): string;
|
|
19759
19530
|
};
|
|
19760
19531
|
|
|
19761
|
-
declare type
|
|
19532
|
+
declare type WireConstructor = {
|
|
19533
|
+
new (onmessage: (data: any) => void): Wire;
|
|
19534
|
+
};
|
|
19762
19535
|
|
|
19763
19536
|
/* Excluded from this release type: WithId */
|
|
19764
19537
|
|