@openfin/fdc3-api 41.103.3 → 42.100.1
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 +60 -108
- package/package.json +1 -1
package/out/fdc3-api.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
|
/**
|
|
@@ -1181,19 +1177,19 @@ declare class ApplicationModule extends Base {
|
|
|
1181
1177
|
*/
|
|
1182
1178
|
declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
1183
1179
|
/**
|
|
1184
|
-
*
|
|
1180
|
+
* @defaultValue false
|
|
1185
1181
|
*
|
|
1186
|
-
*
|
|
1182
|
+
* Disables IAB secure logging for the app.
|
|
1187
1183
|
*/
|
|
1188
1184
|
disableIabSecureLogging: boolean;
|
|
1189
1185
|
/**
|
|
1186
|
+
* @defaultValue 'There was an error loading the application.'
|
|
1187
|
+
*
|
|
1190
1188
|
* An error message to display when the application (launched via manifest) fails to load.
|
|
1191
1189
|
* A dialog box will be launched with the error message just before the runtime exits.
|
|
1192
1190
|
* Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
|
|
1193
1191
|
* will trigger this dialog.
|
|
1194
1192
|
* Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
|
|
1195
|
-
*
|
|
1196
|
-
* @default 'There was an error loading the application.'
|
|
1197
1193
|
*/
|
|
1198
1194
|
loadErrorMessage: string;
|
|
1199
1195
|
/**
|
|
@@ -1212,28 +1208,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1212
1208
|
*/
|
|
1213
1209
|
name: string;
|
|
1214
1210
|
/**
|
|
1211
|
+
* @defaultValue false
|
|
1212
|
+
*
|
|
1215
1213
|
* A flag to configure the application as non-persistent.
|
|
1216
1214
|
* Runtime exits when there are no persistent apps running.
|
|
1217
|
-
*
|
|
1218
|
-
* @default false
|
|
1219
1215
|
*/
|
|
1220
1216
|
nonPersistent: boolean;
|
|
1221
1217
|
/**
|
|
1222
|
-
*
|
|
1218
|
+
* @defaultValue false
|
|
1223
1219
|
*
|
|
1224
|
-
*
|
|
1220
|
+
* Enable Flash at the application level.
|
|
1225
1221
|
*/
|
|
1226
1222
|
plugins: boolean;
|
|
1227
1223
|
/**
|
|
1228
|
-
*
|
|
1224
|
+
* @defaultValue false
|
|
1229
1225
|
*
|
|
1230
|
-
*
|
|
1226
|
+
* Enable spell check at the application level.
|
|
1231
1227
|
*/
|
|
1232
1228
|
spellCheck: boolean;
|
|
1233
1229
|
/**
|
|
1234
|
-
*
|
|
1230
|
+
* @defaultValue 'about:blank'
|
|
1235
1231
|
*
|
|
1236
|
-
*
|
|
1232
|
+
* The url to the application (specifically the application's main window).
|
|
1237
1233
|
*/
|
|
1238
1234
|
url: string;
|
|
1239
1235
|
/**
|
|
@@ -1242,9 +1238,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1242
1238
|
*/
|
|
1243
1239
|
uuid: string;
|
|
1244
1240
|
/**
|
|
1245
|
-
*
|
|
1241
|
+
* @defaultValue true
|
|
1246
1242
|
*
|
|
1247
|
-
*
|
|
1243
|
+
* When set to `false` it will disable the same-origin policy for the app.
|
|
1248
1244
|
*/
|
|
1249
1245
|
webSecurity: boolean;
|
|
1250
1246
|
/**
|
|
@@ -1254,10 +1250,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1254
1250
|
commands: ShortcutOverride[];
|
|
1255
1251
|
isPlatformController: boolean;
|
|
1256
1252
|
/**
|
|
1253
|
+
* @defaultValue 1000
|
|
1254
|
+
*
|
|
1257
1255
|
* **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
|
|
1258
1256
|
* If you do not wish for views to be pooled on your platform, set this property to zero.
|
|
1259
|
-
*
|
|
1260
|
-
* @default 1000
|
|
1261
1257
|
*/
|
|
1262
1258
|
maxViewPoolSize: number;
|
|
1263
1259
|
/**
|
|
@@ -1273,12 +1269,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1273
1269
|
*/
|
|
1274
1270
|
snapshot: Snapshot;
|
|
1275
1271
|
/**
|
|
1272
|
+
* @defaultValue false
|
|
1273
|
+
*
|
|
1276
1274
|
* **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
|
|
1277
1275
|
*
|
|
1278
1276
|
* Note: if the Platform Provider is showing, it won't close automatically.
|
|
1279
1277
|
* If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
|
|
1280
|
-
*
|
|
1281
|
-
* @default false
|
|
1282
1278
|
*/
|
|
1283
1279
|
preventQuitOnLastWindowClosed: boolean;
|
|
1284
1280
|
/**
|
|
@@ -1286,9 +1282,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1286
1282
|
*/
|
|
1287
1283
|
interopBrokerConfiguration: InteropBrokerOptions;
|
|
1288
1284
|
/**
|
|
1289
|
-
*
|
|
1285
|
+
* @defaultValue true
|
|
1290
1286
|
*
|
|
1291
|
-
*
|
|
1287
|
+
* When set to `false` it will disable OpenFin Diagnostics for the app.
|
|
1292
1288
|
*/
|
|
1293
1289
|
apiDiagnostics: boolean;
|
|
1294
1290
|
/**
|
|
@@ -1304,16 +1300,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1304
1300
|
*/
|
|
1305
1301
|
permissions?: Partial<Permissions_2>;
|
|
1306
1302
|
/**
|
|
1303
|
+
* @defaultValue false
|
|
1304
|
+
*
|
|
1307
1305
|
* Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
|
|
1308
1306
|
* Only relevant in Windows.
|
|
1309
|
-
*
|
|
1310
|
-
* @default false
|
|
1311
1307
|
*/
|
|
1312
1308
|
enableJumpList: boolean;
|
|
1313
1309
|
/**
|
|
1314
|
-
*
|
|
1310
|
+
* @defaultValue false
|
|
1315
1311
|
*
|
|
1316
|
-
*
|
|
1312
|
+
* When set to `true`, any `beforeunload` handler set on the app will fire.
|
|
1317
1313
|
*/
|
|
1318
1314
|
enableBeforeUnload: boolean;
|
|
1319
1315
|
/**
|
|
@@ -1394,25 +1390,25 @@ declare type ApplicationWindowInfo = {
|
|
|
1394
1390
|
*/
|
|
1395
1391
|
declare type ApplySnapshotOptions = {
|
|
1396
1392
|
/**
|
|
1393
|
+
* @defaultValue false
|
|
1394
|
+
*
|
|
1397
1395
|
* When true, applySnapshot will close existing windows,
|
|
1398
1396
|
* replacing current Platform state with the given snapshot.
|
|
1399
|
-
*
|
|
1400
|
-
* @default false
|
|
1401
1397
|
*/
|
|
1402
1398
|
closeExistingWindows?: boolean;
|
|
1403
1399
|
/**
|
|
1400
|
+
* @defaultValue false
|
|
1401
|
+
*
|
|
1404
1402
|
* When true, applySnapshot will close existing includeInSnapshots: true windows,
|
|
1405
1403
|
* replacing current Platform state with the given snapshot.
|
|
1406
|
-
*
|
|
1407
|
-
* @default false
|
|
1408
1404
|
*/
|
|
1409
1405
|
closeSnapshotWindows?: boolean;
|
|
1410
1406
|
/**
|
|
1407
|
+
* @defaultValue false
|
|
1408
|
+
*
|
|
1411
1409
|
* When true, applySnapshot will not check whether any windows in a
|
|
1412
1410
|
* snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
|
|
1413
1411
|
* as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
|
|
1414
|
-
*
|
|
1415
|
-
* @default false
|
|
1416
1412
|
*/
|
|
1417
1413
|
skipOutOfBoundsCheck?: boolean;
|
|
1418
1414
|
};
|
|
@@ -1863,6 +1859,10 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
|
1863
1859
|
isMainFrame: boolean;
|
|
1864
1860
|
};
|
|
1865
1861
|
|
|
1862
|
+
declare type BaseStructuredContentBehavior = {
|
|
1863
|
+
behavior: BaseContentBehavior;
|
|
1864
|
+
};
|
|
1865
|
+
|
|
1866
1866
|
declare type BaseUrlEvent = NamedEvent & {
|
|
1867
1867
|
type: 'url-changed';
|
|
1868
1868
|
url: string;
|
|
@@ -1961,32 +1961,13 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
|
1961
1961
|
reason: 'self' | 'animation';
|
|
1962
1962
|
};
|
|
1963
1963
|
|
|
1964
|
-
declare type BoundsEvent = BaseEvent_5 & OpenFin.
|
|
1964
|
+
declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
|
|
1965
1965
|
|
|
1966
|
-
declare type BoundsType =
|
|
1967
|
-
/**
|
|
1968
|
-
* Bounds specify the size and location of the entire window, including OS border styling.
|
|
1969
|
-
*/
|
|
1970
|
-
'window'
|
|
1971
|
-
/**
|
|
1972
|
-
* Bounds specify the size and location of the window's DOM content, excluding OS border styling.
|
|
1973
|
-
*/
|
|
1974
|
-
| 'content'
|
|
1975
|
-
/**
|
|
1976
|
-
* Origin parameters (top, left) specify the location of the window origin, including OS border styling.
|
|
1977
|
-
* Size parameters bounds (width, height) specify the size of the window's DOM content, excluding OS border styling.
|
|
1978
|
-
*/
|
|
1979
|
-
| 'window-origin-content-size';
|
|
1980
|
-
|
|
1981
|
-
/**
|
|
1982
|
-
* Opens matched URLs in the browser.
|
|
1983
|
-
*
|
|
1984
|
-
* @interface
|
|
1985
|
-
*/
|
|
1986
1966
|
declare type BrowserContentBehavior = {
|
|
1987
1967
|
behavior: 'browser';
|
|
1988
1968
|
/**
|
|
1989
|
-
*
|
|
1969
|
+
* Additional property that can be specified when setting the behavior to browser.
|
|
1970
|
+
* When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
|
|
1990
1971
|
*/
|
|
1991
1972
|
closeExisting?: boolean;
|
|
1992
1973
|
};
|
|
@@ -2095,15 +2076,15 @@ declare type CapturePageOptions = {
|
|
|
2095
2076
|
*/
|
|
2096
2077
|
area?: Rectangle;
|
|
2097
2078
|
/**
|
|
2098
|
-
*
|
|
2079
|
+
* @defaultValue 'png'
|
|
2099
2080
|
*
|
|
2100
|
-
*
|
|
2081
|
+
* The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
|
2101
2082
|
*/
|
|
2102
2083
|
format?: 'bmp' | 'jpg' | 'png';
|
|
2103
2084
|
/**
|
|
2104
|
-
*
|
|
2085
|
+
* @defaultValue 100
|
|
2105
2086
|
*
|
|
2106
|
-
*
|
|
2087
|
+
* Quality of JPEG image. Between 0 - 100.
|
|
2107
2088
|
*/
|
|
2108
2089
|
quality?: number;
|
|
2109
2090
|
};
|
|
@@ -2757,9 +2738,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
|
|
|
2757
2738
|
*/
|
|
2758
2739
|
declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2759
2740
|
/**
|
|
2760
|
-
*
|
|
2741
|
+
* @defaultValue true
|
|
2761
2742
|
*
|
|
2762
|
-
*
|
|
2743
|
+
* If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
|
|
2763
2744
|
*/
|
|
2764
2745
|
wait?: boolean;
|
|
2765
2746
|
/**
|
|
@@ -3056,10 +3037,6 @@ declare type ChromiumPolicies = {
|
|
|
3056
3037
|
* Disable AutofillAddressEnabled policy for a Window or View.
|
|
3057
3038
|
*/
|
|
3058
3039
|
AutofillAddressEnabled?: PolicyOptions;
|
|
3059
|
-
/**
|
|
3060
|
-
* Disable AutofillCreditCardEnabled policy for a Window or View.
|
|
3061
|
-
*/
|
|
3062
|
-
AutofillCreditCardEnabled?: PolicyOptions;
|
|
3063
3040
|
};
|
|
3064
3041
|
|
|
3065
3042
|
declare interface ClassicProtocolOffer extends ProtocolPacketBase {
|
|
@@ -3145,7 +3122,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
|
3145
3122
|
*
|
|
3146
3123
|
*/
|
|
3147
3124
|
declare class Clipboard_2 extends Base {
|
|
3148
|
-
#private;
|
|
3149
3125
|
/**
|
|
3150
3126
|
* Writes data into the clipboard as plain text
|
|
3151
3127
|
* @param writeObj The object for writing data into the clipboard
|
|
@@ -3298,21 +3274,6 @@ declare class Clipboard_2 extends Base {
|
|
|
3298
3274
|
getAvailableFormats(type?: OpenFin.ClipboardSelectionType): Promise<Array<string>>;
|
|
3299
3275
|
}
|
|
3300
3276
|
|
|
3301
|
-
/**
|
|
3302
|
-
* Permissions for {@link Clipboard} APIs.
|
|
3303
|
-
*/
|
|
3304
|
-
declare type ClipboardApiPermissions = {
|
|
3305
|
-
writeText: boolean;
|
|
3306
|
-
readText: boolean;
|
|
3307
|
-
writeImage: boolean;
|
|
3308
|
-
readImage: boolean;
|
|
3309
|
-
writeHtml: boolean;
|
|
3310
|
-
readHtml: boolean;
|
|
3311
|
-
writeRtf: boolean;
|
|
3312
|
-
readRtf: boolean;
|
|
3313
|
-
write: boolean;
|
|
3314
|
-
};
|
|
3315
|
-
|
|
3316
3277
|
/**
|
|
3317
3278
|
* Generated when a copy operation is blocked through {@link OpenFin.DomainSettings}.
|
|
3318
3279
|
* @interface
|
|
@@ -3341,7 +3302,6 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
|
|
|
3341
3302
|
|
|
3342
3303
|
/**
|
|
3343
3304
|
* Clipboard Permissions
|
|
3344
|
-
* @interface
|
|
3345
3305
|
*/
|
|
3346
3306
|
declare type ClipboardPermissions = {
|
|
3347
3307
|
copy?: CopyPermissions;
|
|
@@ -3425,9 +3385,9 @@ declare interface CloseWindowPayload {
|
|
|
3425
3385
|
windowId: Identity_4;
|
|
3426
3386
|
options: {
|
|
3427
3387
|
/**
|
|
3428
|
-
*
|
|
3388
|
+
* @defaultValue false
|
|
3429
3389
|
*
|
|
3430
|
-
*
|
|
3390
|
+
* When set to true skips any before handler set on views that are part of the window
|
|
3431
3391
|
*/
|
|
3432
3392
|
skipBeforeUnload?: boolean;
|
|
3433
3393
|
};
|
|
@@ -3535,23 +3495,20 @@ declare type ConstViewOptions = {
|
|
|
3535
3495
|
*/
|
|
3536
3496
|
name: string;
|
|
3537
3497
|
/**
|
|
3538
|
-
*
|
|
3498
|
+
* @defaultValue "about:blank"
|
|
3539
3499
|
*
|
|
3540
|
-
*
|
|
3500
|
+
* The URL of the window
|
|
3541
3501
|
*/
|
|
3542
3502
|
url: string;
|
|
3543
3503
|
/**
|
|
3544
3504
|
* The identity of the window this view should be attached to.
|
|
3545
3505
|
*/
|
|
3546
3506
|
target: Identity_4;
|
|
3547
|
-
/**
|
|
3548
|
-
* Controls order of title precedence:
|
|
3549
|
-
* 'options': viewOptions.title (componentState), document.title, viewOptions.url
|
|
3550
|
-
* 'document': document.title, viewOptions.title(componentState), viewOptions.url (default behavior)
|
|
3551
|
-
*/
|
|
3552
|
-
titlePriority?: ViewTitlePriority;
|
|
3553
3507
|
/**
|
|
3554
3508
|
* Defaults to `name`.
|
|
3509
|
+
* Ignored in container, but used in @openfin/core-web to set tab titles.
|
|
3510
|
+
* Order of precedence for title in container is: document.title, viewOptions.url.
|
|
3511
|
+
* Order of precedence for title in @openfin/core-web is ComponentConfig.title, viewOptions.title, viewOptions.url.
|
|
3555
3512
|
*/
|
|
3556
3513
|
title: string;
|
|
3557
3514
|
/**
|
|
@@ -3562,15 +3519,6 @@ declare type ConstViewOptions = {
|
|
|
3562
3519
|
* Custom headers for requests sent by the view.
|
|
3563
3520
|
*/
|
|
3564
3521
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3565
|
-
/**
|
|
3566
|
-
* @experimental
|
|
3567
|
-
*
|
|
3568
|
-
* When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
|
|
3569
|
-
* These css properties are used to enable dragging of a frameless window.
|
|
3570
|
-
*
|
|
3571
|
-
* @default false
|
|
3572
|
-
*/
|
|
3573
|
-
disableAppRegion: boolean;
|
|
3574
3522
|
/**
|
|
3575
3523
|
* Initial bounds given relative to the window.
|
|
3576
3524
|
*/
|
|
@@ -3607,9 +3555,9 @@ declare type ConstViewOptions = {
|
|
|
3607
3555
|
experimental: any;
|
|
3608
3556
|
fdc3InteropApi?: string;
|
|
3609
3557
|
/**
|
|
3610
|
-
*
|
|
3558
|
+
* @defaultValue false
|
|
3611
3559
|
*
|
|
3612
|
-
*
|
|
3560
|
+
* When set to `true`, any `beforeunload` handler set on Views will fire.
|
|
3613
3561
|
*/
|
|
3614
3562
|
enableBeforeUnload: boolean;
|
|
3615
3563
|
/**
|
|
@@ -3690,12 +3638,13 @@ declare type ConstWindowOptions = {
|
|
|
3690
3638
|
*/
|
|
3691
3639
|
backgroundColor: string;
|
|
3692
3640
|
/**
|
|
3641
|
+
* @defaultValue false
|
|
3642
|
+
*
|
|
3693
3643
|
* Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
|
|
3694
3644
|
* This also affects the Page Visibility API.
|
|
3695
3645
|
*
|
|
3696
3646
|
* When `true`, the page is throttled whether it is hidden or not.
|
|
3697
3647
|
*
|
|
3698
|
-
* @default false
|
|
3699
3648
|
*/
|
|
3700
3649
|
backgroundThrottling: boolean;
|
|
3701
3650
|
/**
|
|
@@ -3719,30 +3668,21 @@ declare type ConstWindowOptions = {
|
|
|
3719
3668
|
*/
|
|
3720
3669
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3721
3670
|
/**
|
|
3671
|
+
* @defaultValue true
|
|
3672
|
+
*
|
|
3722
3673
|
* Setting this to false would keep the Window alive even if all its Views were closed.
|
|
3723
3674
|
* This is meant for advanced users and should be used with caution.
|
|
3724
3675
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
3725
3676
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
3726
3677
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3727
|
-
*
|
|
3728
|
-
* @default true
|
|
3729
3678
|
*/
|
|
3730
3679
|
closeOnLastViewRemoved: boolean;
|
|
3731
3680
|
/**
|
|
3732
|
-
* @
|
|
3733
|
-
*
|
|
3734
|
-
* When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
|
|
3735
|
-
* These css properties are used to enable dragging of a frameless window.
|
|
3681
|
+
* @defaultValue 'all'
|
|
3736
3682
|
*
|
|
3737
|
-
* @default false
|
|
3738
|
-
*/
|
|
3739
|
-
disableAppRegion: boolean;
|
|
3740
|
-
/**
|
|
3741
3683
|
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
|
3742
|
-
* Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3684
|
+
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3743
3685
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3744
|
-
*
|
|
3745
|
-
* @default 'all'
|
|
3746
3686
|
*/
|
|
3747
3687
|
viewsPreventingClose: 'all' | 'layout';
|
|
3748
3688
|
/**
|
|
@@ -3753,31 +3693,31 @@ declare type ConstWindowOptions = {
|
|
|
3753
3693
|
*/
|
|
3754
3694
|
defaultCentered: boolean;
|
|
3755
3695
|
/**
|
|
3696
|
+
* @defaultValue 500
|
|
3697
|
+
*
|
|
3756
3698
|
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
|
3757
3699
|
* in favor of the cached value.
|
|
3758
|
-
*
|
|
3759
|
-
* @default 500
|
|
3760
3700
|
*/
|
|
3761
3701
|
defaultHeight: number;
|
|
3762
3702
|
/**
|
|
3703
|
+
* @defaultValue 100
|
|
3704
|
+
*
|
|
3763
3705
|
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3764
3706
|
* launches in favor of the cached value.
|
|
3765
|
-
*
|
|
3766
|
-
* @default 100
|
|
3767
3707
|
*/
|
|
3768
3708
|
defaultLeft: number;
|
|
3769
3709
|
/**
|
|
3710
|
+
* @defaultValue 100
|
|
3711
|
+
*
|
|
3770
3712
|
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3771
3713
|
* launches in favor of the cached value.
|
|
3772
|
-
*
|
|
3773
|
-
* @default 100
|
|
3774
3714
|
*/
|
|
3775
3715
|
defaultTop: number;
|
|
3776
3716
|
/**
|
|
3717
|
+
* @defaultValue 800
|
|
3718
|
+
*
|
|
3777
3719
|
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3778
3720
|
* launches in favor of the cached value.
|
|
3779
|
-
*
|
|
3780
|
-
* @default 800
|
|
3781
3721
|
*/
|
|
3782
3722
|
defaultWidth: number;
|
|
3783
3723
|
/**
|
|
@@ -3823,19 +3763,19 @@ declare type ConstWindowOptions = {
|
|
|
3823
3763
|
*/
|
|
3824
3764
|
processAffinity: string;
|
|
3825
3765
|
/**
|
|
3766
|
+
* @defaultValue false
|
|
3767
|
+
*
|
|
3826
3768
|
* Displays a shadow on frameless windows.
|
|
3827
3769
|
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
3828
3770
|
* On Windows 7, Aero theme is required.
|
|
3829
|
-
*
|
|
3830
|
-
* @default false
|
|
3831
3771
|
*/
|
|
3832
3772
|
shadow: boolean;
|
|
3833
3773
|
/**
|
|
3774
|
+
* @defaultValue true
|
|
3775
|
+
*
|
|
3834
3776
|
* Caches the location of the window.
|
|
3835
3777
|
*
|
|
3836
3778
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3837
|
-
*
|
|
3838
|
-
* @default true
|
|
3839
3779
|
*/
|
|
3840
3780
|
saveWindowState: boolean;
|
|
3841
3781
|
/**
|
|
@@ -3844,22 +3784,22 @@ declare type ConstWindowOptions = {
|
|
|
3844
3784
|
*/
|
|
3845
3785
|
ignoreSavedWindowState: boolean;
|
|
3846
3786
|
/**
|
|
3787
|
+
* @defaultValue false
|
|
3788
|
+
*
|
|
3847
3789
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3848
3790
|
*
|
|
3849
3791
|
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3850
3792
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3851
|
-
*
|
|
3852
|
-
* @default false
|
|
3853
3793
|
*/
|
|
3854
3794
|
smallWindow: boolean;
|
|
3855
3795
|
/**
|
|
3796
|
+
* @defaultValue "normal"
|
|
3797
|
+
*
|
|
3856
3798
|
* The visible state of the window on creation.
|
|
3857
3799
|
* One of:
|
|
3858
3800
|
* * `"maximized"`
|
|
3859
3801
|
* * `"minimized"`
|
|
3860
3802
|
* * `"normal"`
|
|
3861
|
-
*
|
|
3862
|
-
* @default "normal"
|
|
3863
3803
|
*/
|
|
3864
3804
|
state: WindowState;
|
|
3865
3805
|
/**
|
|
@@ -3874,26 +3814,26 @@ declare type ConstWindowOptions = {
|
|
|
3874
3814
|
*/
|
|
3875
3815
|
taskbarIconGroup: string;
|
|
3876
3816
|
/**
|
|
3877
|
-
*
|
|
3817
|
+
* @defaultValue "about:blank"
|
|
3878
3818
|
*
|
|
3879
|
-
*
|
|
3819
|
+
* The URL of the window
|
|
3880
3820
|
*/
|
|
3881
3821
|
url: string;
|
|
3882
3822
|
/**
|
|
3823
|
+
* @defaultValue <application UUID>
|
|
3824
|
+
*
|
|
3883
3825
|
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
3884
3826
|
* If omitted, defaults to the `uuid` of the application spawning the window.
|
|
3885
3827
|
* If given, must match the `uuid` of the application spawning the window.
|
|
3886
3828
|
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
3887
3829
|
* really no need to provide it.
|
|
3888
|
-
*
|
|
3889
|
-
* @default <application UUID>
|
|
3890
3830
|
*/
|
|
3891
3831
|
uuid: string;
|
|
3892
3832
|
/**
|
|
3833
|
+
* @defaultValue false
|
|
3834
|
+
*
|
|
3893
3835
|
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
|
3894
3836
|
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
|
3895
|
-
*
|
|
3896
|
-
* @default false
|
|
3897
3837
|
*/
|
|
3898
3838
|
waitForPageLoad: boolean;
|
|
3899
3839
|
width: number;
|
|
@@ -3913,10 +3853,6 @@ declare type ConstWindowOptions = {
|
|
|
3913
3853
|
* Control which options to ignore when creating a Platform Window.
|
|
3914
3854
|
*/
|
|
3915
3855
|
excludeOptions: ExcludeOptions;
|
|
3916
|
-
/**
|
|
3917
|
-
* 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.
|
|
3918
|
-
*/
|
|
3919
|
-
roundedCorners: boolean;
|
|
3920
3856
|
};
|
|
3921
3857
|
|
|
3922
3858
|
/**
|
|
@@ -3928,7 +3864,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
|
3928
3864
|
};
|
|
3929
3865
|
|
|
3930
3866
|
/**
|
|
3931
|
-
*
|
|
3867
|
+
* Sets the behavior for when a Window or View navigates or redirects to a matching URL
|
|
3932
3868
|
*
|
|
3933
3869
|
* 'allow': The content url is allowed.
|
|
3934
3870
|
* 'block': The content url is blocked.
|
|
@@ -4007,17 +3943,7 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
4007
3943
|
* The features string passed to `window.open()` converted to OpenFin window options
|
|
4008
3944
|
*/
|
|
4009
3945
|
parsedFeatures: Partial<OpenFin.WindowOptions>;
|
|
4010
|
-
|
|
4011
|
-
* The reported disposition of the content creation request.
|
|
4012
|
-
* @remarks
|
|
4013
|
-
* - `default` - The default behavior of the browser.
|
|
4014
|
-
* - `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.
|
|
4015
|
-
* - `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.
|
|
4016
|
-
* - `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.
|
|
4017
|
-
* - `popup` - The content is loaded in a popup window. This is the result of passing popup features to `window.open()`.
|
|
4018
|
-
* - `other` - The content is loaded in some other way.
|
|
4019
|
-
*/
|
|
4020
|
-
disposition: 'default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'popup' | 'other';
|
|
3946
|
+
disposition: string;
|
|
4021
3947
|
};
|
|
4022
3948
|
|
|
4023
3949
|
/**
|
|
@@ -4175,17 +4101,16 @@ declare type CopyBlockedEventReason = 'disabled';
|
|
|
4175
4101
|
|
|
4176
4102
|
/**
|
|
4177
4103
|
* Control copy operations for a matched URL.
|
|
4178
|
-
* @interface
|
|
4179
4104
|
*/
|
|
4180
4105
|
declare type CopyPermissions = {
|
|
4181
4106
|
/**
|
|
4107
|
+
* @defaultValue 'allowed'
|
|
4108
|
+
*
|
|
4182
4109
|
* Controls the behavior for copy operations for a matched URL.
|
|
4183
4110
|
*
|
|
4184
4111
|
* allow: Enables all copy operations.
|
|
4185
4112
|
* block: Disables all copy operations.
|
|
4186
4113
|
* protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
|
|
4187
|
-
*
|
|
4188
|
-
* @default 'allowed'
|
|
4189
4114
|
*/
|
|
4190
4115
|
behavior: 'allow' | 'block' | 'protect';
|
|
4191
4116
|
/**
|
|
@@ -4193,9 +4118,9 @@ declare type CopyPermissions = {
|
|
|
4193
4118
|
*/
|
|
4194
4119
|
options?: {
|
|
4195
4120
|
/**
|
|
4196
|
-
*
|
|
4121
|
+
* @defaultValue ''
|
|
4197
4122
|
*
|
|
4198
|
-
*
|
|
4123
|
+
* When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
|
|
4199
4124
|
*/
|
|
4200
4125
|
replacementText: string;
|
|
4201
4126
|
};
|
|
@@ -4209,15 +4134,15 @@ declare type CopyPermissions = {
|
|
|
4209
4134
|
*/
|
|
4210
4135
|
declare type CornerRounding = {
|
|
4211
4136
|
/**
|
|
4212
|
-
*
|
|
4137
|
+
* @defaultValue 0
|
|
4213
4138
|
*
|
|
4214
|
-
*
|
|
4139
|
+
* The height in pixels.
|
|
4215
4140
|
*/
|
|
4216
4141
|
height: number;
|
|
4217
4142
|
/**
|
|
4218
|
-
*
|
|
4143
|
+
* @defaultValue 0
|
|
4219
4144
|
*
|
|
4220
|
-
*
|
|
4145
|
+
* The width in pixels.
|
|
4221
4146
|
*/
|
|
4222
4147
|
width: number;
|
|
4223
4148
|
};
|
|
@@ -4307,6 +4232,8 @@ declare type CreateLayoutOptions = {
|
|
|
4307
4232
|
layoutName: string;
|
|
4308
4233
|
layout: LayoutOptions;
|
|
4309
4234
|
/**
|
|
4235
|
+
* @defaultValue 'default'
|
|
4236
|
+
*
|
|
4310
4237
|
* Controls the View behavior for the given `layout` property. Note
|
|
4311
4238
|
* that the selected behavior only applies to unnamed Views or
|
|
4312
4239
|
* Views with the prefix `internal-generated-`. In all cases, if any
|
|
@@ -4328,8 +4255,6 @@ declare type CreateLayoutOptions = {
|
|
|
4328
4255
|
* override. Note that during applyLayoutSnapshot, Views are created and
|
|
4329
4256
|
* attached to the Provider while the Window is being created, so it's
|
|
4330
4257
|
* important to not 'duplicate' Views in this workflow.
|
|
4331
|
-
*
|
|
4332
|
-
* @default 'default'
|
|
4333
4258
|
*/
|
|
4334
4259
|
multiInstanceViewBehavior?: MultiInstanceViewBehavior;
|
|
4335
4260
|
};
|
|
@@ -4359,7 +4284,8 @@ declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
|
|
|
4359
4284
|
*/
|
|
4360
4285
|
location?: {
|
|
4361
4286
|
id: string;
|
|
4362
|
-
|
|
4287
|
+
index?: number;
|
|
4288
|
+
};
|
|
4363
4289
|
};
|
|
4364
4290
|
|
|
4365
4291
|
/**
|
|
@@ -4427,7 +4353,6 @@ declare type DefaultDomainSettings = DomainSettings;
|
|
|
4427
4353
|
|
|
4428
4354
|
/**
|
|
4429
4355
|
* @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
|
|
4430
|
-
* @interface
|
|
4431
4356
|
*/
|
|
4432
4357
|
declare type DefaultDomainSettingsRule = DomainSettingsRule;
|
|
4433
4358
|
|
|
@@ -4588,7 +4513,7 @@ declare type DomainApiSettings = {
|
|
|
4588
4513
|
* * 'none': The `fin` API will be not available.
|
|
4589
4514
|
* * 'global': The entire `fin` API will be available.
|
|
4590
4515
|
*
|
|
4591
|
-
* @
|
|
4516
|
+
* @defaultValue 'global'
|
|
4592
4517
|
*/
|
|
4593
4518
|
fin?: InjectionType;
|
|
4594
4519
|
/**
|
|
@@ -4604,7 +4529,10 @@ declare type DomainApiSettings = {
|
|
|
4604
4529
|
* @interface
|
|
4605
4530
|
* Defines application settings that vary by the domain of the current context.
|
|
4606
4531
|
*
|
|
4607
|
-
* @remarks
|
|
4532
|
+
* @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
|
|
4533
|
+
* domain should be represented with a single rule.
|
|
4534
|
+
*
|
|
4535
|
+
* Renderers opened on `about:blank` are considered to belong to the domain of their opener (or, in the case of iframes,
|
|
4608
4536
|
* their parent), effective recursively. Domain rules matched to `about:blank` will only apply in cases where no opener
|
|
4609
4537
|
* exists.
|
|
4610
4538
|
*/
|
|
@@ -4621,44 +4549,19 @@ declare type DomainSettings = {
|
|
|
4621
4549
|
* more information, see the documentation for the individual properties.
|
|
4622
4550
|
*/
|
|
4623
4551
|
default?: PerDomainSettings;
|
|
4624
|
-
/**
|
|
4625
|
-
* {@inheritDoc MultipleDomainMatchBehavior}
|
|
4626
|
-
*/
|
|
4627
|
-
multipleMatchBehavior?: MultipleDomainMatchBehavior;
|
|
4628
4552
|
};
|
|
4629
4553
|
|
|
4630
4554
|
/**
|
|
4631
|
-
*
|
|
4555
|
+
* @interface
|
|
4632
4556
|
*
|
|
4633
|
-
* Uses the script's full URL as the key and an object
|
|
4634
|
-
* with an `enabled` boolean property as the value.
|
|
4635
|
-
* @example
|
|
4636
|
-
* ```js
|
|
4637
|
-
* {
|
|
4638
|
-
"match": ["<all_urls>"],
|
|
4639
|
-
"options": {
|
|
4640
|
-
"preloadScripts": {
|
|
4641
|
-
"http://localhost:53000/block-preload.js": { "enabled": false }
|
|
4642
|
-
"http://localhost:53000/allow-preload.js": { "enabled": true }
|
|
4643
|
-
}
|
|
4644
|
-
}
|
|
4645
|
-
}
|
|
4646
|
-
* ```
|
|
4647
|
-
*/
|
|
4648
|
-
declare type DomainSettingsPreloadScripts = Record<string, {
|
|
4649
|
-
enabled: boolean;
|
|
4650
|
-
}>;
|
|
4651
|
-
|
|
4652
|
-
/**
|
|
4653
4557
|
* Defines domain-conditional settings for an OpenFin application.
|
|
4654
|
-
* @interface
|
|
4655
4558
|
*/
|
|
4656
4559
|
declare type DomainSettingsRule = {
|
|
4657
4560
|
/**
|
|
4658
4561
|
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4659
4562
|
* the domain(s) for which the rule applies.
|
|
4660
4563
|
*/
|
|
4661
|
-
match
|
|
4564
|
+
match?: string[];
|
|
4662
4565
|
/**
|
|
4663
4566
|
* Settings applied when a webcontents has been navigated to a matched domain.
|
|
4664
4567
|
*/
|
|
@@ -5202,9 +5105,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
|
|
|
5202
5105
|
*/
|
|
5203
5106
|
declare type ExcludeOptions = {
|
|
5204
5107
|
/**
|
|
5205
|
-
*
|
|
5108
|
+
* @defaultValue false
|
|
5206
5109
|
*
|
|
5207
|
-
*
|
|
5110
|
+
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
|
5208
5111
|
*/
|
|
5209
5112
|
preloadScripts: boolean;
|
|
5210
5113
|
};
|
|
@@ -5835,7 +5738,7 @@ declare class FDC3ModuleBase<ChannelType extends v1_2.Channel | v2_0.Channel> {
|
|
|
5835
5738
|
*
|
|
5836
5739
|
* @tutorial fdc3.getOrCreateChannel
|
|
5837
5740
|
*/
|
|
5838
|
-
|
|
5741
|
+
getOrCreateChannel(channelId: string): Promise<ChannelType>;
|
|
5839
5742
|
/**
|
|
5840
5743
|
* Returns the Interop-Broker-defined context groups available for an entity to join.
|
|
5841
5744
|
*
|
|
@@ -5982,7 +5885,6 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
|
5982
5885
|
* Domain-conditional rules for file downloads.
|
|
5983
5886
|
*
|
|
5984
5887
|
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
|
5985
|
-
* @interface
|
|
5986
5888
|
*/
|
|
5987
5889
|
declare type FileDownloadSettings = {
|
|
5988
5890
|
/**
|
|
@@ -6035,34 +5937,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
6035
5937
|
*/
|
|
6036
5938
|
declare type FindInPageOptions = {
|
|
6037
5939
|
/**
|
|
6038
|
-
*
|
|
5940
|
+
* @defaultValue true
|
|
6039
5941
|
*
|
|
6040
|
-
*
|
|
5942
|
+
* Searches in the forward direction (backward otherwise)
|
|
6041
5943
|
*/
|
|
6042
5944
|
forward?: boolean;
|
|
6043
5945
|
/**
|
|
6044
|
-
*
|
|
5946
|
+
* @defaultValue false
|
|
6045
5947
|
*
|
|
6046
|
-
*
|
|
5948
|
+
* Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
|
|
6047
5949
|
*/
|
|
6048
5950
|
findNext?: boolean;
|
|
6049
5951
|
/**
|
|
6050
|
-
*
|
|
5952
|
+
* @defaultValue false
|
|
6051
5953
|
*
|
|
6052
|
-
*
|
|
5954
|
+
* Enables case-sensitive searching.
|
|
6053
5955
|
*/
|
|
6054
5956
|
matchCase?: boolean;
|
|
6055
5957
|
/**
|
|
6056
|
-
*
|
|
5958
|
+
* @defaultValue false
|
|
6057
5959
|
*
|
|
6058
|
-
*
|
|
5960
|
+
* Only searches from the start of words.
|
|
6059
5961
|
*/
|
|
6060
5962
|
wordStart?: boolean;
|
|
6061
5963
|
/**
|
|
5964
|
+
* @defaultValue false
|
|
5965
|
+
*
|
|
6062
5966
|
* 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>
|
|
6063
5967
|
* lowercase or non-letter. Accepts several other intra-word matches.
|
|
6064
|
-
*
|
|
6065
|
-
* @default false
|
|
6066
5968
|
*/
|
|
6067
5969
|
medialCapitalAsWordStart?: boolean;
|
|
6068
5970
|
};
|
|
@@ -6576,9 +6478,9 @@ declare type Hotkey = {
|
|
|
6576
6478
|
*/
|
|
6577
6479
|
keys: string;
|
|
6578
6480
|
/**
|
|
6579
|
-
*
|
|
6481
|
+
* @defaultValue false
|
|
6580
6482
|
*
|
|
6581
|
-
*
|
|
6483
|
+
* Prevent default key handling before emitting the event.
|
|
6582
6484
|
*/
|
|
6583
6485
|
preventDefault?: boolean;
|
|
6584
6486
|
};
|
|
@@ -6750,10 +6652,9 @@ declare type InitPlatformOptions = {
|
|
|
6750
6652
|
* Injection setting for the `fin` API.
|
|
6751
6653
|
*
|
|
6752
6654
|
* * 'none': The `fin` API will be not available.
|
|
6753
|
-
* * 'preloads': The `fin` API will be available in a synchronous context in the preload script only.
|
|
6754
6655
|
* * 'global': The entire `fin` API will be available.
|
|
6755
6656
|
*/
|
|
6756
|
-
declare type InjectionType = 'none' | '
|
|
6657
|
+
declare type InjectionType = 'none' | 'global';
|
|
6757
6658
|
|
|
6758
6659
|
/**
|
|
6759
6660
|
* Generated when the value of the element changes.
|
|
@@ -7079,7 +6980,6 @@ declare class InteropBroker extends Base {
|
|
|
7079
6980
|
private sessionContextGroupMap;
|
|
7080
6981
|
private channel;
|
|
7081
6982
|
private logging;
|
|
7082
|
-
private privateChannelProviderMap;
|
|
7083
6983
|
/**
|
|
7084
6984
|
* @internal
|
|
7085
6985
|
*/
|
|
@@ -8646,7 +8546,9 @@ declare type LayoutEntitiesController = {
|
|
|
8646
8546
|
getParent: (id: string) => OpenFin.LayoutEntityDefinition | undefined;
|
|
8647
8547
|
isRoot: (id: string) => boolean;
|
|
8648
8548
|
exists: (entityId: string) => boolean;
|
|
8649
|
-
addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?:
|
|
8549
|
+
addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
|
|
8550
|
+
index?: number;
|
|
8551
|
+
}) => Promise<OpenFin.Identity>;
|
|
8650
8552
|
removeViewFromStack: (stackEntityId: string, view: OpenFin.Identity) => Promise<void>;
|
|
8651
8553
|
createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
|
|
8652
8554
|
position?: OpenFin.LayoutPosition;
|
|
@@ -9137,83 +9039,77 @@ declare type LayoutOptions = {
|
|
|
9137
9039
|
*/
|
|
9138
9040
|
settings?: {
|
|
9139
9041
|
/**
|
|
9140
|
-
*
|
|
9141
|
-
*/
|
|
9142
|
-
newTabButtonUrl?: string;
|
|
9143
|
-
/**
|
|
9144
|
-
* When true the splitters will not be draggable and the layout will not resize.
|
|
9042
|
+
* @defaultValue false
|
|
9145
9043
|
*
|
|
9146
|
-
*
|
|
9044
|
+
* When true the splitters will not be draggable and the layout will not resize.
|
|
9147
9045
|
*/
|
|
9148
9046
|
preventSplitterResize?: boolean;
|
|
9149
9047
|
/**
|
|
9048
|
+
* @defaultValue false
|
|
9049
|
+
*
|
|
9150
9050
|
* Whether the popout button will only act on the entire stack,
|
|
9151
9051
|
* as opposed to only the active tab.
|
|
9152
|
-
*
|
|
9153
|
-
* @default false
|
|
9154
9052
|
*/
|
|
9155
9053
|
popoutWholeStack?: boolean;
|
|
9156
9054
|
/**
|
|
9055
|
+
* @defaultValue false
|
|
9056
|
+
*
|
|
9157
9057
|
* Limits the area to which tabs can be dragged.
|
|
9158
9058
|
* If true, the layout container is the only area where tabs can be dropped.
|
|
9159
|
-
*
|
|
9160
|
-
* @default false
|
|
9161
9059
|
*/
|
|
9162
9060
|
constrainDragToContainer?: boolean;
|
|
9163
9061
|
/**
|
|
9062
|
+
* @defaultValue false
|
|
9063
|
+
*
|
|
9164
9064
|
* Whether to show the popout button on stack header.
|
|
9165
9065
|
* The button will create a new window with current tab as its content.
|
|
9166
9066
|
* In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
|
|
9167
|
-
*
|
|
9168
|
-
* @default false
|
|
9169
9067
|
*/
|
|
9170
9068
|
showPopoutIcon?: boolean;
|
|
9171
9069
|
/**
|
|
9070
|
+
* @defaultValue false
|
|
9071
|
+
*
|
|
9172
9072
|
* Whether to show the maximize button on stack header.
|
|
9173
9073
|
* The button will maximize the current tab to fill the entire window.
|
|
9174
|
-
*
|
|
9175
|
-
* @default false
|
|
9176
9074
|
*/
|
|
9177
9075
|
showMaximiseIcon?: boolean;
|
|
9178
9076
|
/**
|
|
9077
|
+
* @defaultValue false
|
|
9078
|
+
*
|
|
9179
9079
|
* Whether to show the close button on stack header
|
|
9180
9080
|
* (not to be confused with close button on every tab).
|
|
9181
|
-
*
|
|
9182
|
-
* @default false
|
|
9183
9081
|
*/
|
|
9184
9082
|
showCloseIcon?: boolean;
|
|
9185
9083
|
/**
|
|
9186
|
-
*
|
|
9084
|
+
* @defaultValue false
|
|
9187
9085
|
*
|
|
9188
|
-
*
|
|
9086
|
+
* Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
|
|
9189
9087
|
*/
|
|
9190
9088
|
constrainDragToHeaders?: boolean;
|
|
9191
9089
|
/**
|
|
9090
|
+
* @defaultValue true
|
|
9091
|
+
*
|
|
9192
9092
|
* Turns tab headers on or off.
|
|
9193
9093
|
* If false, the layout will be displayed with splitters only.
|
|
9194
|
-
*
|
|
9195
|
-
* @default true
|
|
9196
9094
|
*/
|
|
9197
9095
|
hasHeaders?: boolean;
|
|
9198
9096
|
/**
|
|
9097
|
+
* @defaultValue true
|
|
9098
|
+
*
|
|
9199
9099
|
* If true, the user can re-arrange the layout by
|
|
9200
9100
|
* dragging items by their tabs to the desired location.
|
|
9201
|
-
*
|
|
9202
|
-
* @default true
|
|
9203
9101
|
*/
|
|
9204
9102
|
reorderEnabled?: boolean;
|
|
9205
9103
|
/**
|
|
9206
|
-
*
|
|
9104
|
+
* @defaultValue false
|
|
9207
9105
|
*
|
|
9208
|
-
*
|
|
9106
|
+
* If true, tabs can't be dragged out of the window.
|
|
9209
9107
|
*/
|
|
9210
9108
|
preventDragOut?: boolean;
|
|
9211
9109
|
/**
|
|
9212
9110
|
* @defaultValue=false
|
|
9213
9111
|
*
|
|
9214
9112
|
* If true, tabs can't be dragged into the window.
|
|
9215
|
-
*
|
|
9216
|
-
* @default false
|
|
9217
9113
|
*/
|
|
9218
9114
|
preventDragIn?: boolean;
|
|
9219
9115
|
};
|
|
@@ -9644,19 +9540,6 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
|
|
|
9644
9540
|
*/
|
|
9645
9541
|
declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
|
|
9646
9542
|
|
|
9647
|
-
/**
|
|
9648
|
-
* Behavior for handling multiple {@link DomainSettingsRule} matches.
|
|
9649
|
-
*/
|
|
9650
|
-
declare type MultipleDomainMatchBehavior =
|
|
9651
|
-
/**
|
|
9652
|
-
* Apply only the first matching rule in the list.
|
|
9653
|
-
*/
|
|
9654
|
-
'pick-first'
|
|
9655
|
-
/**
|
|
9656
|
-
* Deep-merge all matching rules in the list, prioritizing earlier matches. Treats arrays as primitives.
|
|
9657
|
-
*/
|
|
9658
|
-
| 'deep-merge';
|
|
9659
|
-
|
|
9660
9543
|
/**
|
|
9661
9544
|
* @interface
|
|
9662
9545
|
*/
|
|
@@ -9665,10 +9548,10 @@ declare type MutableViewOptions = {
|
|
|
9665
9548
|
/**
|
|
9666
9549
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9667
9550
|
*
|
|
9551
|
+
* @defaultValue true
|
|
9552
|
+
*
|
|
9668
9553
|
* Show the context menu when right-clicking on the view.
|
|
9669
9554
|
* Gives access to the devtools for the view.
|
|
9670
|
-
*
|
|
9671
|
-
* @default true
|
|
9672
9555
|
*/
|
|
9673
9556
|
contextMenu: boolean;
|
|
9674
9557
|
/**
|
|
@@ -9715,25 +9598,24 @@ declare type MutableViewOptions = {
|
|
|
9715
9598
|
contentNavigation: ContentNavigation;
|
|
9716
9599
|
contentRedirect: ContentRedirect;
|
|
9717
9600
|
/**
|
|
9601
|
+
* @defaultValue false
|
|
9718
9602
|
* @deprecated
|
|
9719
9603
|
* **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
|
|
9720
9604
|
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
|
9721
|
-
*
|
|
9722
|
-
* @default false
|
|
9723
9605
|
*/
|
|
9724
9606
|
detachOnClose: boolean;
|
|
9725
9607
|
/**
|
|
9608
|
+
* @defaultValue true
|
|
9609
|
+
*
|
|
9726
9610
|
* **Platforms Only.** If false, the view will be persistent and can't be closed through
|
|
9727
9611
|
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
|
9728
9612
|
* if the view isn't part of the new layout when running `Layout.replace`.
|
|
9729
|
-
*
|
|
9730
|
-
* @default true
|
|
9731
9613
|
*/
|
|
9732
9614
|
isClosable: boolean;
|
|
9733
9615
|
/**
|
|
9734
|
-
*
|
|
9616
|
+
* @defaultValue false
|
|
9735
9617
|
*
|
|
9736
|
-
*
|
|
9618
|
+
* **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
|
9737
9619
|
*/
|
|
9738
9620
|
preventDragOut: boolean;
|
|
9739
9621
|
interop?: InteropConfig;
|
|
@@ -9745,7 +9627,7 @@ declare type MutableViewOptions = {
|
|
|
9745
9627
|
/**
|
|
9746
9628
|
* {@inheritDoc ViewThrottling}
|
|
9747
9629
|
*
|
|
9748
|
-
* @
|
|
9630
|
+
* @defaultValue 'enabled'
|
|
9749
9631
|
*/
|
|
9750
9632
|
throttling: ViewThrottling;
|
|
9751
9633
|
/**
|
|
@@ -9764,7 +9646,7 @@ declare type MutableWindowOptions = {
|
|
|
9764
9646
|
* Turns anything of matching RGB value transparent.
|
|
9765
9647
|
*
|
|
9766
9648
|
* Caveats:
|
|
9767
|
-
* *
|
|
9649
|
+
* * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
|
|
9768
9650
|
* * User cannot click-through transparent regions
|
|
9769
9651
|
* * Not supported on Mac
|
|
9770
9652
|
* * Windows Aero must be enabled
|
|
@@ -9773,25 +9655,25 @@ declare type MutableWindowOptions = {
|
|
|
9773
9655
|
*/
|
|
9774
9656
|
alphaMask: RGB;
|
|
9775
9657
|
/**
|
|
9776
|
-
*
|
|
9658
|
+
* @defaultValue false
|
|
9777
9659
|
*
|
|
9778
|
-
*
|
|
9660
|
+
* Always position the window at the top of the window stack.
|
|
9779
9661
|
*/
|
|
9780
9662
|
alwaysOnTop: boolean;
|
|
9781
9663
|
/**
|
|
9664
|
+
* @defaultValue 0
|
|
9665
|
+
*
|
|
9782
9666
|
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
|
9783
9667
|
* an aspect ratio will not be enforced.
|
|
9784
|
-
*
|
|
9785
|
-
* @default 0
|
|
9786
9668
|
*/
|
|
9787
9669
|
aspectRatio: number;
|
|
9788
9670
|
/**
|
|
9789
9671
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9790
9672
|
*
|
|
9673
|
+
* @defaultValue true
|
|
9674
|
+
*
|
|
9791
9675
|
* Show the context menu when right-clicking on the window.
|
|
9792
9676
|
* Gives access to the devtools for the window.
|
|
9793
|
-
*
|
|
9794
|
-
* @default true
|
|
9795
9677
|
*/
|
|
9796
9678
|
contextMenu: boolean;
|
|
9797
9679
|
/**
|
|
@@ -9858,18 +9740,15 @@ declare type MutableWindowOptions = {
|
|
|
9858
9740
|
*/
|
|
9859
9741
|
customData: any;
|
|
9860
9742
|
/**
|
|
9861
|
-
* @deprecated Will be removed in runtime version 45
|
|
9862
9743
|
* @defaultValue true
|
|
9863
9744
|
*
|
|
9864
9745
|
* Show the window's frame.
|
|
9865
|
-
*
|
|
9866
|
-
* @default true
|
|
9867
9746
|
*/
|
|
9868
9747
|
frame: boolean;
|
|
9869
9748
|
/**
|
|
9870
|
-
*
|
|
9749
|
+
* @defaultValue false
|
|
9871
9750
|
*
|
|
9872
|
-
*
|
|
9751
|
+
* Hides the window instead of closing it when the close button is pressed.
|
|
9873
9752
|
*/
|
|
9874
9753
|
hideOnClose: boolean;
|
|
9875
9754
|
/**
|
|
@@ -9922,61 +9801,60 @@ declare type MutableWindowOptions = {
|
|
|
9922
9801
|
*/
|
|
9923
9802
|
icon: string;
|
|
9924
9803
|
/**
|
|
9804
|
+
* @defaultValue true
|
|
9805
|
+
*
|
|
9925
9806
|
* Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
|
9926
9807
|
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
|
9927
|
-
*
|
|
9928
|
-
* @default true
|
|
9929
9808
|
*/
|
|
9930
9809
|
includeInSnapshots: boolean;
|
|
9931
9810
|
/**
|
|
9932
|
-
*
|
|
9811
|
+
* @defaultValue -1
|
|
9933
9812
|
*
|
|
9934
|
-
*
|
|
9813
|
+
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
|
9935
9814
|
*/
|
|
9936
9815
|
maxHeight: number;
|
|
9937
9816
|
/**
|
|
9938
|
-
*
|
|
9817
|
+
* @defaultValue true
|
|
9939
9818
|
*
|
|
9940
|
-
*
|
|
9819
|
+
* Allows the window to be maximized.
|
|
9941
9820
|
*/
|
|
9942
9821
|
maximizable: boolean;
|
|
9943
9822
|
/**
|
|
9944
|
-
*
|
|
9823
|
+
* @defaultValue -1
|
|
9945
9824
|
*
|
|
9946
|
-
*
|
|
9825
|
+
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
|
9947
9826
|
*/
|
|
9948
9827
|
maxWidth: number;
|
|
9949
9828
|
/**
|
|
9950
|
-
*
|
|
9829
|
+
* @defaultValue 0
|
|
9951
9830
|
*
|
|
9952
|
-
*
|
|
9831
|
+
* The minimum height of the window.
|
|
9953
9832
|
*/
|
|
9954
9833
|
minHeight: number;
|
|
9955
9834
|
/**
|
|
9956
|
-
*
|
|
9835
|
+
* @defaultValue true
|
|
9957
9836
|
*
|
|
9958
|
-
*
|
|
9837
|
+
* Allows the window to be minimized.
|
|
9959
9838
|
*/
|
|
9960
9839
|
minimizable: boolean;
|
|
9961
9840
|
/**
|
|
9962
|
-
*
|
|
9841
|
+
* @defaultValue true
|
|
9963
9842
|
*
|
|
9964
|
-
*
|
|
9843
|
+
* The minimum width of the window.
|
|
9965
9844
|
*/
|
|
9966
9845
|
minWidth: number;
|
|
9967
9846
|
/**
|
|
9847
|
+
* @defaultValue 1
|
|
9848
|
+
*
|
|
9968
9849
|
* A flag that specifies how transparent the window will be.
|
|
9969
9850
|
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
|
9970
9851
|
* This value is clamped between `0.0` and `1.0`.
|
|
9971
|
-
* In software composition mode, the runtime flag --allow-unsafe-compositing is required.
|
|
9972
|
-
*
|
|
9973
|
-
* @default 1
|
|
9974
9852
|
*/
|
|
9975
9853
|
opacity: number;
|
|
9976
9854
|
/**
|
|
9977
|
-
*
|
|
9855
|
+
* @defaultValue true
|
|
9978
9856
|
*
|
|
9979
|
-
*
|
|
9857
|
+
* A flag to allow the user to resize the window.
|
|
9980
9858
|
*/
|
|
9981
9859
|
resizable: boolean;
|
|
9982
9860
|
/**
|
|
@@ -9984,22 +9862,16 @@ declare type MutableWindowOptions = {
|
|
|
9984
9862
|
*/
|
|
9985
9863
|
resizeRegion: ResizeRegion;
|
|
9986
9864
|
/**
|
|
9865
|
+
* @defaultValue false
|
|
9866
|
+
*
|
|
9987
9867
|
* **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
|
|
9988
9868
|
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
|
9989
|
-
*
|
|
9990
|
-
* @default false
|
|
9991
9869
|
*/
|
|
9992
9870
|
showBackgroundImages: boolean;
|
|
9993
9871
|
/**
|
|
9994
|
-
*
|
|
9995
|
-
*
|
|
9996
|
-
* @remarks
|
|
9997
|
-
* In Windows, setting `showTaskbarIcon` to false will cause the window to display on all virtual desktops.
|
|
9998
|
-
* In order to prevent this while keeping `showTaskbarIcon` false, pass the identity of the parent via the
|
|
9999
|
-
* `modalParentIdentity` (see {@link WindowCreationOptions}). This is useful for popups managed by
|
|
10000
|
-
* {@link Window._Window.showPopupWindow}.
|
|
9872
|
+
* @defaultValue true
|
|
10001
9873
|
*
|
|
10002
|
-
*
|
|
9874
|
+
* Shows the window's icon in the taskbar.
|
|
10003
9875
|
*/
|
|
10004
9876
|
showTaskbarIcon: boolean;
|
|
10005
9877
|
/**
|
|
@@ -10026,7 +9898,7 @@ declare type MutableWindowOptions = {
|
|
|
10026
9898
|
/**
|
|
10027
9899
|
* {@inheritDoc WindowThrottling}
|
|
10028
9900
|
*
|
|
10029
|
-
* @
|
|
9901
|
+
* @defaultValue 'enabled'
|
|
10030
9902
|
*
|
|
10031
9903
|
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
|
10032
9904
|
*/
|
|
@@ -10295,7 +10167,6 @@ declare namespace OpenFin {
|
|
|
10295
10167
|
ViewCreationOptions,
|
|
10296
10168
|
MutableViewOptions,
|
|
10297
10169
|
ViewOptions,
|
|
10298
|
-
ViewTitlePriority,
|
|
10299
10170
|
ConstViewOptions,
|
|
10300
10171
|
ViewState,
|
|
10301
10172
|
ViewCreationSuccess,
|
|
@@ -10330,7 +10201,6 @@ declare namespace OpenFin {
|
|
|
10330
10201
|
OpenExternalPermission,
|
|
10331
10202
|
DeviceInfo,
|
|
10332
10203
|
Permissions_2 as Permissions,
|
|
10333
|
-
ClipboardApiPermissions,
|
|
10334
10204
|
PlatformWindowCreationOptions,
|
|
10335
10205
|
PlatformWindowOptions,
|
|
10336
10206
|
PlatformViewCreationOptions,
|
|
@@ -10436,18 +10306,17 @@ declare namespace OpenFin {
|
|
|
10436
10306
|
RuntimeInfo,
|
|
10437
10307
|
DefaultDomainSettings,
|
|
10438
10308
|
DefaultDomainSettingsRule,
|
|
10439
|
-
MultipleDomainMatchBehavior,
|
|
10440
10309
|
DomainSettings,
|
|
10441
10310
|
ApiInjection,
|
|
10442
10311
|
DomainApiSettings,
|
|
10443
10312
|
BaseContentBehavior,
|
|
10444
10313
|
ContentBehavior,
|
|
10314
|
+
BaseStructuredContentBehavior,
|
|
10445
10315
|
BrowserContentBehavior,
|
|
10446
10316
|
StructuredContentBehavior,
|
|
10447
10317
|
StructuredContentPermissions,
|
|
10448
10318
|
ContentPermission,
|
|
10449
10319
|
ScreenCaptureBehavior,
|
|
10450
|
-
DomainSettingsPreloadScripts,
|
|
10451
10320
|
PerDomainSettings,
|
|
10452
10321
|
CopyPermissions,
|
|
10453
10322
|
PastePermissions,
|
|
@@ -10551,7 +10420,6 @@ declare namespace OpenFin {
|
|
|
10551
10420
|
Me,
|
|
10552
10421
|
CapturePageOptions,
|
|
10553
10422
|
ProcessLoggingOptions,
|
|
10554
|
-
BoundsType,
|
|
10555
10423
|
PositioningOptions,
|
|
10556
10424
|
ChannelClientConnectionListener,
|
|
10557
10425
|
ChannelClientDisconnectionListener,
|
|
@@ -10565,7 +10433,6 @@ declare namespace OpenFin {
|
|
|
10565
10433
|
PathServeRequest,
|
|
10566
10434
|
ServeAssetOptions,
|
|
10567
10435
|
ServedAssetInfo,
|
|
10568
|
-
ResolvedDomainSettings,
|
|
10569
10436
|
ApplicationEvents,
|
|
10570
10437
|
BaseEvents,
|
|
10571
10438
|
ExternalApplicationEvents,
|
|
@@ -10642,16 +10509,15 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
|
|
|
10642
10509
|
|
|
10643
10510
|
/**
|
|
10644
10511
|
* Control copy operations for a matched URL.
|
|
10645
|
-
* @interface
|
|
10646
10512
|
*/
|
|
10647
10513
|
declare type PastePermissions = {
|
|
10648
10514
|
/**
|
|
10515
|
+
* @defaultValue 'non-protected-content'
|
|
10516
|
+
*
|
|
10649
10517
|
* Controls the behavior for paste operations for a matched URL.
|
|
10650
10518
|
*
|
|
10651
10519
|
* non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
|
|
10652
10520
|
* 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.
|
|
10653
|
-
*
|
|
10654
|
-
* @default 'non-protected-content'
|
|
10655
10521
|
*/
|
|
10656
10522
|
behavior: 'non-protected-content' | 'all-content';
|
|
10657
10523
|
};
|
|
@@ -10799,13 +10665,6 @@ declare type PerDomainSettings = {
|
|
|
10799
10665
|
* {@inheritdoc ChromiumPolicies}
|
|
10800
10666
|
*/
|
|
10801
10667
|
chromiumPolicies?: ChromiumPolicies;
|
|
10802
|
-
/**
|
|
10803
|
-
* {@inheritdoc DomainSettingsPreloadScripts}
|
|
10804
|
-
*/
|
|
10805
|
-
preloadScripts?: DomainSettingsPreloadScripts;
|
|
10806
|
-
/**
|
|
10807
|
-
* @experimental These features are still under development and may change.
|
|
10808
|
-
*/
|
|
10809
10668
|
contentProtection?: {
|
|
10810
10669
|
/**
|
|
10811
10670
|
* {@inheritdoc ScreenCaptureBehavior}
|
|
@@ -10815,16 +10674,6 @@ declare type PerDomainSettings = {
|
|
|
10815
10674
|
* {@inheritdoc ClipboardPermissions}
|
|
10816
10675
|
*/
|
|
10817
10676
|
clipboard?: ClipboardPermissions;
|
|
10818
|
-
/**
|
|
10819
|
-
* Whether the content can be printed.
|
|
10820
|
-
* Defaults to 'allow'.
|
|
10821
|
-
* Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
|
|
10822
|
-
*/
|
|
10823
|
-
print?: 'allow' | 'block';
|
|
10824
|
-
/**
|
|
10825
|
-
* * Controls whether HTML5 dragging for this content is allowed or blocked.
|
|
10826
|
-
*/
|
|
10827
|
-
drag?: 'allow' | 'block';
|
|
10828
10677
|
};
|
|
10829
10678
|
};
|
|
10830
10679
|
|
|
@@ -10850,7 +10699,6 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
|
|
10850
10699
|
declare type Permissions_2 = {
|
|
10851
10700
|
Application?: Partial<ApplicationPermissions>;
|
|
10852
10701
|
System?: Partial<SystemPermissions>;
|
|
10853
|
-
Clipboard?: Partial<ClipboardApiPermissions>;
|
|
10854
10702
|
webAPIs?: WebPermission[];
|
|
10855
10703
|
devices?: DeviceInfo[];
|
|
10856
10704
|
};
|
|
@@ -11720,11 +11568,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
11720
11568
|
*/
|
|
11721
11569
|
providerUrl?: string;
|
|
11722
11570
|
/**
|
|
11571
|
+
* @defaultValue true
|
|
11572
|
+
*
|
|
11723
11573
|
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
|
11724
11574
|
*
|
|
11725
11575
|
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
|
11726
|
-
*
|
|
11727
|
-
* @default true
|
|
11728
11576
|
*/
|
|
11729
11577
|
allowLaunchIntoPlatform?: boolean;
|
|
11730
11578
|
};
|
|
@@ -12304,14 +12152,6 @@ declare interface PlatformProvider {
|
|
|
12304
12152
|
* ```
|
|
12305
12153
|
*/
|
|
12306
12154
|
handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
|
|
12307
|
-
/**
|
|
12308
|
-
* Determines whether a given window should prevent the application from quitting when it is closed.
|
|
12309
|
-
* This method is called when checking if closing a window should trigger application termination.
|
|
12310
|
-
*
|
|
12311
|
-
* @param windowIdentity - The identity of the window being checked.
|
|
12312
|
-
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
12313
|
-
*/
|
|
12314
|
-
shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
|
|
12315
12155
|
}
|
|
12316
12156
|
|
|
12317
12157
|
/**
|
|
@@ -12413,22 +12253,22 @@ declare type PopupOptions = {
|
|
|
12413
12253
|
url?: string;
|
|
12414
12254
|
/**
|
|
12415
12255
|
* Height of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12416
|
-
* @
|
|
12256
|
+
* @defaultValue 300
|
|
12417
12257
|
*/
|
|
12418
12258
|
height?: number;
|
|
12419
12259
|
/**
|
|
12420
12260
|
* Width of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12421
|
-
* @
|
|
12261
|
+
* @defaultValue 300
|
|
12422
12262
|
*/
|
|
12423
12263
|
width?: number;
|
|
12424
12264
|
/**
|
|
12425
12265
|
* Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12426
|
-
* @
|
|
12266
|
+
* @defaultValue 0
|
|
12427
12267
|
*/
|
|
12428
12268
|
x?: number;
|
|
12429
12269
|
/**
|
|
12430
12270
|
* Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12431
|
-
* @
|
|
12271
|
+
* @defaultValue 0
|
|
12432
12272
|
*/
|
|
12433
12273
|
y?: number;
|
|
12434
12274
|
/**
|
|
@@ -12436,7 +12276,7 @@ declare type PopupOptions = {
|
|
|
12436
12276
|
* * 'modal' restricts resizing and positioning in the caller.
|
|
12437
12277
|
* * 'hide' hides the popup window on blur.
|
|
12438
12278
|
* * 'close' closes the popup window on blur.
|
|
12439
|
-
* @
|
|
12279
|
+
* @defaultValue 'close'
|
|
12440
12280
|
*/
|
|
12441
12281
|
blurBehavior?: PopupBlurBehavior;
|
|
12442
12282
|
/**
|
|
@@ -12444,19 +12284,19 @@ declare type PopupOptions = {
|
|
|
12444
12284
|
* * 'none' will do nothing.
|
|
12445
12285
|
* * 'hide' hides the popup window on `dispatchPopupResult`.
|
|
12446
12286
|
* * 'close' closes the popup window on `dispatchPopupResult`.
|
|
12447
|
-
* @
|
|
12287
|
+
* @defaultValue 'close'
|
|
12448
12288
|
*/
|
|
12449
12289
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
12450
12290
|
/**
|
|
12451
12291
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
12452
12292
|
*
|
|
12453
12293
|
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
12454
|
-
* @
|
|
12294
|
+
* @defaultValue false
|
|
12455
12295
|
*/
|
|
12456
12296
|
hideOnClose?: boolean;
|
|
12457
12297
|
/**
|
|
12458
12298
|
* Determines if the popup window should or should not be focused when it is shown.
|
|
12459
|
-
* @
|
|
12299
|
+
* @defaultValue true
|
|
12460
12300
|
*/
|
|
12461
12301
|
focus?: boolean;
|
|
12462
12302
|
/**
|
|
@@ -12535,7 +12375,6 @@ declare type PositioningOptions = {
|
|
|
12535
12375
|
* This will have the effect of the maximized window staying maximized and not immediately taking this new position.
|
|
12536
12376
|
*/
|
|
12537
12377
|
skipRestore?: boolean;
|
|
12538
|
-
boundsType?: BoundsType;
|
|
12539
12378
|
};
|
|
12540
12379
|
|
|
12541
12380
|
/**
|
|
@@ -12550,9 +12389,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
|
|
|
12550
12389
|
*/
|
|
12551
12390
|
declare type PreloadScript = {
|
|
12552
12391
|
/**
|
|
12553
|
-
*
|
|
12392
|
+
* @defaultValue false
|
|
12554
12393
|
*
|
|
12555
|
-
*
|
|
12394
|
+
* Fail to load the window if this preload script fails
|
|
12556
12395
|
*/
|
|
12557
12396
|
mandatory?: boolean;
|
|
12558
12397
|
/**
|
|
@@ -12648,15 +12487,15 @@ declare type PrinterInfo = {
|
|
|
12648
12487
|
declare type PrintOptions = {
|
|
12649
12488
|
content?: 'self';
|
|
12650
12489
|
/**
|
|
12651
|
-
*
|
|
12490
|
+
* @defaultValue false
|
|
12652
12491
|
*
|
|
12653
|
-
*
|
|
12492
|
+
* Disables prompting the user for print settings.
|
|
12654
12493
|
*/
|
|
12655
12494
|
silent?: boolean;
|
|
12656
12495
|
/**
|
|
12657
|
-
*
|
|
12496
|
+
* @defaultValue false
|
|
12658
12497
|
*
|
|
12659
|
-
*
|
|
12498
|
+
* Includes the webpage background color and image when printing.
|
|
12660
12499
|
*/
|
|
12661
12500
|
printBackground?: boolean;
|
|
12662
12501
|
/**
|
|
@@ -12664,9 +12503,9 @@ declare type PrintOptions = {
|
|
|
12664
12503
|
*/
|
|
12665
12504
|
deviceName?: string;
|
|
12666
12505
|
/**
|
|
12667
|
-
*
|
|
12506
|
+
* @defaultValue true
|
|
12668
12507
|
*
|
|
12669
|
-
*
|
|
12508
|
+
* Prints in full color (greyscale otherwise).
|
|
12670
12509
|
*/
|
|
12671
12510
|
color?: boolean;
|
|
12672
12511
|
/**
|
|
@@ -12674,9 +12513,9 @@ declare type PrintOptions = {
|
|
|
12674
12513
|
*/
|
|
12675
12514
|
margins?: Margins;
|
|
12676
12515
|
/**
|
|
12677
|
-
*
|
|
12516
|
+
* @defaultValue true
|
|
12678
12517
|
*
|
|
12679
|
-
*
|
|
12518
|
+
* Prints in landscape mode (portrait otherwise).
|
|
12680
12519
|
*/
|
|
12681
12520
|
landscape?: boolean;
|
|
12682
12521
|
/**
|
|
@@ -13062,10 +12901,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13062
12901
|
transitions: OpenFin.Transition;
|
|
13063
12902
|
options: OpenFin.TransitionOptions;
|
|
13064
12903
|
}>;
|
|
13065
|
-
'activate-window-and-focus': ApiCall<{
|
|
13066
|
-
winIdentity: OpenFin.Identity;
|
|
13067
|
-
focusIdentity: OpenFin.Identity;
|
|
13068
|
-
}, boolean>;
|
|
13069
12904
|
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
13070
12905
|
'get-window-bounds': IdentityCall<{
|
|
13071
12906
|
options?: OpenFin.GetBoundsOptions;
|
|
@@ -13404,19 +13239,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13404
13239
|
'system-update-process-logging-options': ApiCall<{
|
|
13405
13240
|
options: OpenFin.ProcessLoggingOptions;
|
|
13406
13241
|
}, void>;
|
|
13407
|
-
'get-domain-settings': ApiCall<
|
|
13242
|
+
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
13408
13243
|
'serve-asset': ApiCall<{
|
|
13409
13244
|
options: OpenFin.ServeAssetOptions;
|
|
13410
13245
|
}, OpenFin.ServedAssetInfo>;
|
|
13411
|
-
'set-domain-settings': ApiCall<{
|
|
13412
|
-
domainSettings: OpenFin.
|
|
13246
|
+
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
13247
|
+
domainSettings: OpenFin.DefaultDomainSettings;
|
|
13413
13248
|
}, void>;
|
|
13414
|
-
'get-current-domain-settings': ApiCall<{
|
|
13415
|
-
identity: OpenFin.Identity;
|
|
13416
|
-
}, OpenFin.ResolvedDomainSettings>;
|
|
13417
|
-
'resolve-domain-settings': ApiCall<{
|
|
13418
|
-
url: string;
|
|
13419
|
-
}, OpenFin.ResolvedDomainSettings>;
|
|
13420
13249
|
'system-register-shutdown-handler': VoidCall;
|
|
13421
13250
|
'get-permissions': GetterCall<any>;
|
|
13422
13251
|
'refresh-extensions': {
|
|
@@ -13857,15 +13686,15 @@ declare type ReplaceViewPayload = {
|
|
|
13857
13686
|
*/
|
|
13858
13687
|
declare type ResizeRegion = {
|
|
13859
13688
|
/**
|
|
13860
|
-
*
|
|
13689
|
+
* @defaultValue 7
|
|
13861
13690
|
*
|
|
13862
|
-
*
|
|
13691
|
+
* The size of the resize region in pixels.
|
|
13863
13692
|
*/
|
|
13864
13693
|
size?: number;
|
|
13865
13694
|
/**
|
|
13866
|
-
*
|
|
13695
|
+
* @defaultValue 9
|
|
13867
13696
|
*
|
|
13868
|
-
*
|
|
13697
|
+
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
|
13869
13698
|
*/
|
|
13870
13699
|
bottomRightCorner?: number;
|
|
13871
13700
|
/**
|
|
@@ -13873,40 +13702,32 @@ declare type ResizeRegion = {
|
|
|
13873
13702
|
*/
|
|
13874
13703
|
sides?: {
|
|
13875
13704
|
/**
|
|
13876
|
-
*
|
|
13705
|
+
* @defaultValue true
|
|
13877
13706
|
*
|
|
13878
|
-
*
|
|
13707
|
+
* Enables resizing from the top of the window.
|
|
13879
13708
|
*/
|
|
13880
13709
|
top?: boolean;
|
|
13881
13710
|
/**
|
|
13882
|
-
*
|
|
13711
|
+
* @defaultValue true
|
|
13883
13712
|
*
|
|
13884
|
-
*
|
|
13713
|
+
* Enables resizing from the bottom of the window.
|
|
13885
13714
|
*/
|
|
13886
13715
|
bottom?: boolean;
|
|
13887
13716
|
/**
|
|
13888
|
-
*
|
|
13717
|
+
* @defaultValue true
|
|
13889
13718
|
*
|
|
13890
|
-
*
|
|
13719
|
+
* Enables resizing from the left side of the window.
|
|
13891
13720
|
*/
|
|
13892
13721
|
left?: boolean;
|
|
13893
13722
|
/**
|
|
13894
|
-
*
|
|
13723
|
+
* @defaultValue true
|
|
13895
13724
|
*
|
|
13896
|
-
*
|
|
13725
|
+
* Enables resizing from the right side of the window.
|
|
13897
13726
|
*/
|
|
13898
13727
|
right?: boolean;
|
|
13899
13728
|
};
|
|
13900
13729
|
};
|
|
13901
13730
|
|
|
13902
|
-
declare type ResolvedDomainSettings = {
|
|
13903
|
-
url: string;
|
|
13904
|
-
settings: PerDomainSettings;
|
|
13905
|
-
matches: DomainSettingsRule[];
|
|
13906
|
-
multipleDomainMatchBehavior: MultipleDomainMatchBehavior;
|
|
13907
|
-
default?: PerDomainSettings;
|
|
13908
|
-
};
|
|
13909
|
-
|
|
13910
13731
|
/**
|
|
13911
13732
|
* Generated when an HTTP load was cancelled or failed.
|
|
13912
13733
|
* @interface
|
|
@@ -14083,20 +13904,12 @@ declare type RVMInfo = {
|
|
|
14083
13904
|
* The app log directory.
|
|
14084
13905
|
*/
|
|
14085
13906
|
'appLogDirectory': string;
|
|
14086
|
-
/**
|
|
14087
|
-
* Architecture of the OS that the RVM is running on. One of `arm64`, `x86`, `x64`. Available since RVM 16.
|
|
14088
|
-
*/
|
|
14089
|
-
'osArch': string;
|
|
14090
13907
|
/**
|
|
14091
13908
|
* The path of OpenfinRVM.exe.
|
|
14092
13909
|
*/
|
|
14093
13910
|
'path': string;
|
|
14094
13911
|
/**
|
|
14095
|
-
*
|
|
14096
|
-
*/
|
|
14097
|
-
'rvmArch': string;
|
|
14098
|
-
/**
|
|
14099
|
-
* The start time of RVM. Format is `YYYY-MM-DD HH:MM:SS` in local time or `NA` on error.
|
|
13912
|
+
* The start time of RVM.
|
|
14100
13913
|
*/
|
|
14101
13914
|
'start-time': string;
|
|
14102
13915
|
/**
|
|
@@ -14129,6 +13942,7 @@ declare type RvmLaunchOptions = {
|
|
|
14129
13942
|
};
|
|
14130
13943
|
|
|
14131
13944
|
/**
|
|
13945
|
+
* @interface
|
|
14132
13946
|
* Controls whether this content should be allowed or blocked when capturing the screen.
|
|
14133
13947
|
*/
|
|
14134
13948
|
declare type ScreenCaptureBehavior = 'allow' | 'block';
|
|
@@ -14445,9 +14259,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
|
|
|
14445
14259
|
*/
|
|
14446
14260
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
14447
14261
|
/**
|
|
14448
|
-
*
|
|
14262
|
+
* @defaultValue 0
|
|
14449
14263
|
*
|
|
14450
|
-
*
|
|
14264
|
+
* Number of milliseconds to wait between view repaints.
|
|
14451
14265
|
*/
|
|
14452
14266
|
paintIntervalMs?: number;
|
|
14453
14267
|
};
|
|
@@ -14623,15 +14437,12 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
|
14623
14437
|
};
|
|
14624
14438
|
|
|
14625
14439
|
/**
|
|
14626
|
-
*
|
|
14440
|
+
* Allows more control over content behaviors
|
|
14627
14441
|
*/
|
|
14628
|
-
declare type StructuredContentBehavior =
|
|
14629
|
-
behavior: BaseContentBehavior;
|
|
14630
|
-
} | BrowserContentBehavior;
|
|
14442
|
+
declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
|
|
14631
14443
|
|
|
14632
14444
|
/**
|
|
14633
|
-
*
|
|
14634
|
-
* @interface
|
|
14445
|
+
* Specify rules for specific actions.
|
|
14635
14446
|
*/
|
|
14636
14447
|
declare type StructuredContentPermissions = {
|
|
14637
14448
|
/**
|
|
@@ -16120,9 +15931,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
16120
15931
|
* // }
|
|
16121
15932
|
* ```
|
|
16122
15933
|
*/
|
|
16123
|
-
setDomainSettings(domainSettings: OpenFin.
|
|
16124
|
-
getCurrentDomainSettings(identity: OpenFin.Identity): Promise<OpenFin.ResolvedDomainSettings>;
|
|
16125
|
-
resolveDomainSettings(url: string): Promise<OpenFin.ResolvedDomainSettings>;
|
|
15934
|
+
setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
|
|
16126
15935
|
/**
|
|
16127
15936
|
* Attempts to install and enable extensions for the security realm. Users may want to call this function in response
|
|
16128
15937
|
* to an `extensions-install-failed` event. Only extensions allowed by every application on the current security realm
|
|
@@ -16196,10 +16005,6 @@ declare type SystemEventType = EventType_8;
|
|
|
16196
16005
|
declare type SystemPermissions = {
|
|
16197
16006
|
getOSInfo: boolean;
|
|
16198
16007
|
getAllExternalWindows: boolean;
|
|
16199
|
-
setDomainSettings: boolean;
|
|
16200
|
-
getDomainSettings: boolean;
|
|
16201
|
-
getCurrentDomainSettings: boolean;
|
|
16202
|
-
resolveDomainSettings: boolean;
|
|
16203
16008
|
launchExternalProcess: boolean | {
|
|
16204
16009
|
enabled: boolean;
|
|
16205
16010
|
assets?: {
|
|
@@ -16504,9 +16309,9 @@ declare type TransitionBase = {
|
|
|
16504
16309
|
*/
|
|
16505
16310
|
duration: number;
|
|
16506
16311
|
/**
|
|
16507
|
-
*
|
|
16312
|
+
* @defaultValue false
|
|
16508
16313
|
*
|
|
16509
|
-
*
|
|
16314
|
+
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16510
16315
|
*/
|
|
16511
16316
|
relative?: boolean;
|
|
16512
16317
|
};
|
|
@@ -16522,9 +16327,9 @@ declare type TransitionOptions = {
|
|
|
16522
16327
|
*/
|
|
16523
16328
|
interrupt: boolean;
|
|
16524
16329
|
/**
|
|
16525
|
-
*
|
|
16330
|
+
* @defaultValue false
|
|
16526
16331
|
*
|
|
16527
|
-
*
|
|
16332
|
+
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16528
16333
|
*/
|
|
16529
16334
|
relative?: boolean;
|
|
16530
16335
|
tween?: tween;
|
|
@@ -16543,7 +16348,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
16543
16348
|
sendRaw: Wire['send'];
|
|
16544
16349
|
eventAggregator: EventAggregator;
|
|
16545
16350
|
protected messageHandlers: MessageHandler[];
|
|
16546
|
-
constructor(
|
|
16351
|
+
constructor(WireType: WireConstructor, environment: Environment, config: OpenFin.Identity);
|
|
16547
16352
|
getFin(): OpenFin.Fin<MeType>;
|
|
16548
16353
|
registerFin(_fin: OpenFin.Fin<MeType>): void;
|
|
16549
16354
|
connectSync: () => void;
|
|
@@ -17582,12 +17387,6 @@ declare interface ViewStatuses {
|
|
|
17582
17387
|
*/
|
|
17583
17388
|
declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
|
|
17584
17389
|
|
|
17585
|
-
/**
|
|
17586
|
-
* Precedence for view tab title
|
|
17587
|
-
* @interface
|
|
17588
|
-
*/
|
|
17589
|
-
declare type ViewTitlePriority = 'document' | 'options';
|
|
17590
|
-
|
|
17591
17390
|
/**
|
|
17592
17391
|
* Configuration for view visibility settings
|
|
17593
17392
|
*
|
|
@@ -17595,9 +17394,9 @@ declare type ViewTitlePriority = 'document' | 'options';
|
|
|
17595
17394
|
*/
|
|
17596
17395
|
declare type ViewVisibilityOption = {
|
|
17597
17396
|
/**
|
|
17598
|
-
*
|
|
17397
|
+
* @defaultValue false
|
|
17599
17398
|
*
|
|
17600
|
-
*
|
|
17399
|
+
* Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
|
|
17601
17400
|
*/
|
|
17602
17401
|
enabled?: boolean;
|
|
17603
17402
|
};
|
|
@@ -18774,30 +18573,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
|
18774
18573
|
* ```
|
|
18775
18574
|
*/
|
|
18776
18575
|
getAllFrames(): Promise<Array<OpenFin.FrameInfo>>;
|
|
18777
|
-
/**
|
|
18778
|
-
* Activates the current window and focuses the child entity if it exists. If this does
|
|
18779
|
-
* not succeed - say the child does not belong to this window, or the identity does not exist -
|
|
18780
|
-
* it will return false.
|
|
18781
|
-
*
|
|
18782
|
-
* @example
|
|
18783
|
-
* ```js
|
|
18784
|
-
* const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
|
|
18785
|
-
*
|
|
18786
|
-
* win.getCurrentViews()
|
|
18787
|
-
* .then(([view1]) => {
|
|
18788
|
-
* return win.activateAndFocus(view1.identity);
|
|
18789
|
-
* })
|
|
18790
|
-
* .then(success => {
|
|
18791
|
-
* if (success) {
|
|
18792
|
-
* console.log('Window activated and child focused');
|
|
18793
|
-
* } else {
|
|
18794
|
-
* console.log('Window activation failed, focus state unchanged');
|
|
18795
|
-
* }
|
|
18796
|
-
* })
|
|
18797
|
-
* .catch(console.error);
|
|
18798
|
-
* ```
|
|
18799
|
-
*/
|
|
18800
|
-
activateAndFocus(childIdentityToFocus: OpenFin.Identity): Promise<boolean>;
|
|
18801
18576
|
/**
|
|
18802
18577
|
* Gets the current bounds (top, bottom, right, left, width, height) of the window.
|
|
18803
18578
|
*
|
|
@@ -19784,10 +19559,6 @@ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
|
|
|
19784
19559
|
declare type WindowBounds = Bounds & {
|
|
19785
19560
|
bottom: number;
|
|
19786
19561
|
right: number;
|
|
19787
|
-
/**
|
|
19788
|
-
* The bounds for the window's web content, excluding any OS border
|
|
19789
|
-
*/
|
|
19790
|
-
content: Bounds;
|
|
19791
19562
|
};
|
|
19792
19563
|
|
|
19793
19564
|
/**
|
|
@@ -20212,7 +19983,9 @@ declare type Wire = EventEmitter & {
|
|
|
20212
19983
|
getPort(): string;
|
|
20213
19984
|
};
|
|
20214
19985
|
|
|
20215
|
-
declare type
|
|
19986
|
+
declare type WireConstructor = {
|
|
19987
|
+
new (onmessage: (data: any) => void): Wire;
|
|
19988
|
+
};
|
|
20216
19989
|
|
|
20217
19990
|
/**
|
|
20218
19991
|
* @internal
|