@openfin/fdc3-api 40.105.8 → 41.83.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 +223 -622
- package/out/fdc3-api-beta.d.ts +223 -622
- package/out/fdc3-api-public.d.ts +223 -622
- package/out/fdc3-api.d.ts +224 -623
- package/out/fdc3-api.js +1456 -1483
- package/package.json +2 -3
package/out/fdc3-api.d.ts
CHANGED
|
@@ -126,13 +126,13 @@ declare type ApiSettings = {
|
|
|
126
126
|
/**
|
|
127
127
|
* Inject OpenFin API into cross-origin iframes
|
|
128
128
|
*
|
|
129
|
-
* @
|
|
129
|
+
* @defaultValue false
|
|
130
130
|
*/
|
|
131
131
|
crossOriginInjection?: boolean;
|
|
132
132
|
/**
|
|
133
133
|
* Inject OpenFin API into same-origin iframes
|
|
134
134
|
*
|
|
135
|
-
* @
|
|
135
|
+
* @defaultValue true
|
|
136
136
|
*/
|
|
137
137
|
sameOriginInjection?: boolean;
|
|
138
138
|
/**
|
|
@@ -189,10 +189,6 @@ declare type AppAssetRequest = {
|
|
|
189
189
|
alias: string;
|
|
190
190
|
};
|
|
191
191
|
|
|
192
|
-
declare type AppAssetServeRequest = ServeRequest & {
|
|
193
|
-
alias: string;
|
|
194
|
-
};
|
|
195
|
-
|
|
196
192
|
/**
|
|
197
193
|
* An object representing an application. Allows the developer to create,
|
|
198
194
|
* execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
|
|
@@ -600,23 +596,6 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
|
|
|
600
596
|
* ```
|
|
601
597
|
*/
|
|
602
598
|
setTrayIcon(icon: string): Promise<void>;
|
|
603
|
-
/**
|
|
604
|
-
* Set hover text for this application's system tray icon.
|
|
605
|
-
* Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
|
|
606
|
-
* @param toolTip
|
|
607
|
-
*
|
|
608
|
-
* @example
|
|
609
|
-
*
|
|
610
|
-
* ```js
|
|
611
|
-
* const app = fin.Application.getCurrentSync();
|
|
612
|
-
* const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
|
|
613
|
-
*
|
|
614
|
-
* await app.setTrayIcon(iconUrl);
|
|
615
|
-
*
|
|
616
|
-
* await app.setTrayIconToolTip('My Application');
|
|
617
|
-
* ```
|
|
618
|
-
*/
|
|
619
|
-
setTrayIconToolTip(toolTip: string): Promise<void>;
|
|
620
599
|
/**
|
|
621
600
|
* Sets new application's shortcut configuration. Windows only.
|
|
622
601
|
* @param config New application's shortcut configuration.
|
|
@@ -1177,19 +1156,19 @@ declare class ApplicationModule extends Base {
|
|
|
1177
1156
|
*/
|
|
1178
1157
|
declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
1179
1158
|
/**
|
|
1180
|
-
*
|
|
1159
|
+
* @defaultValue false
|
|
1181
1160
|
*
|
|
1182
|
-
*
|
|
1161
|
+
* Disables IAB secure logging for the app.
|
|
1183
1162
|
*/
|
|
1184
1163
|
disableIabSecureLogging: boolean;
|
|
1185
1164
|
/**
|
|
1165
|
+
* @defaultValue 'There was an error loading the application.'
|
|
1166
|
+
*
|
|
1186
1167
|
* An error message to display when the application (launched via manifest) fails to load.
|
|
1187
1168
|
* A dialog box will be launched with the error message just before the runtime exits.
|
|
1188
1169
|
* Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
|
|
1189
1170
|
* will trigger this dialog.
|
|
1190
1171
|
* Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
|
|
1191
|
-
*
|
|
1192
|
-
* @default 'There was an error loading the application.'
|
|
1193
1172
|
*/
|
|
1194
1173
|
loadErrorMessage: string;
|
|
1195
1174
|
/**
|
|
@@ -1208,28 +1187,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1208
1187
|
*/
|
|
1209
1188
|
name: string;
|
|
1210
1189
|
/**
|
|
1190
|
+
* @defaultValue false
|
|
1191
|
+
*
|
|
1211
1192
|
* A flag to configure the application as non-persistent.
|
|
1212
1193
|
* Runtime exits when there are no persistent apps running.
|
|
1213
|
-
*
|
|
1214
|
-
* @default false
|
|
1215
1194
|
*/
|
|
1216
1195
|
nonPersistent: boolean;
|
|
1217
1196
|
/**
|
|
1218
|
-
*
|
|
1197
|
+
* @defaultValue false
|
|
1219
1198
|
*
|
|
1220
|
-
*
|
|
1199
|
+
* Enable Flash at the application level.
|
|
1221
1200
|
*/
|
|
1222
1201
|
plugins: boolean;
|
|
1223
1202
|
/**
|
|
1224
|
-
*
|
|
1203
|
+
* @defaultValue false
|
|
1225
1204
|
*
|
|
1226
|
-
*
|
|
1205
|
+
* Enable spell check at the application level.
|
|
1227
1206
|
*/
|
|
1228
1207
|
spellCheck: boolean;
|
|
1229
1208
|
/**
|
|
1230
|
-
*
|
|
1209
|
+
* @defaultValue 'about:blank'
|
|
1231
1210
|
*
|
|
1232
|
-
*
|
|
1211
|
+
* The url to the application (specifically the application's main window).
|
|
1233
1212
|
*/
|
|
1234
1213
|
url: string;
|
|
1235
1214
|
/**
|
|
@@ -1238,9 +1217,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1238
1217
|
*/
|
|
1239
1218
|
uuid: string;
|
|
1240
1219
|
/**
|
|
1241
|
-
*
|
|
1220
|
+
* @defaultValue true
|
|
1242
1221
|
*
|
|
1243
|
-
*
|
|
1222
|
+
* When set to `false` it will disable the same-origin policy for the app.
|
|
1244
1223
|
*/
|
|
1245
1224
|
webSecurity: boolean;
|
|
1246
1225
|
/**
|
|
@@ -1250,10 +1229,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1250
1229
|
commands: ShortcutOverride[];
|
|
1251
1230
|
isPlatformController: boolean;
|
|
1252
1231
|
/**
|
|
1232
|
+
* @defaultValue 1000
|
|
1233
|
+
*
|
|
1253
1234
|
* **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
|
|
1254
1235
|
* If you do not wish for views to be pooled on your platform, set this property to zero.
|
|
1255
|
-
*
|
|
1256
|
-
* @default 1000
|
|
1257
1236
|
*/
|
|
1258
1237
|
maxViewPoolSize: number;
|
|
1259
1238
|
/**
|
|
@@ -1269,12 +1248,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1269
1248
|
*/
|
|
1270
1249
|
snapshot: Snapshot;
|
|
1271
1250
|
/**
|
|
1251
|
+
* @defaultValue false
|
|
1252
|
+
*
|
|
1272
1253
|
* **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
|
|
1273
1254
|
*
|
|
1274
1255
|
* Note: if the Platform Provider is showing, it won't close automatically.
|
|
1275
1256
|
* If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
|
|
1276
|
-
*
|
|
1277
|
-
* @default false
|
|
1278
1257
|
*/
|
|
1279
1258
|
preventQuitOnLastWindowClosed: boolean;
|
|
1280
1259
|
/**
|
|
@@ -1282,9 +1261,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1282
1261
|
*/
|
|
1283
1262
|
interopBrokerConfiguration: InteropBrokerOptions;
|
|
1284
1263
|
/**
|
|
1285
|
-
*
|
|
1264
|
+
* @defaultValue true
|
|
1286
1265
|
*
|
|
1287
|
-
*
|
|
1266
|
+
* When set to `false` it will disable OpenFin Diagnostics for the app.
|
|
1288
1267
|
*/
|
|
1289
1268
|
apiDiagnostics: boolean;
|
|
1290
1269
|
/**
|
|
@@ -1300,16 +1279,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1300
1279
|
*/
|
|
1301
1280
|
permissions?: Partial<Permissions_2>;
|
|
1302
1281
|
/**
|
|
1282
|
+
* @defaultValue false
|
|
1283
|
+
*
|
|
1303
1284
|
* Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
|
|
1304
1285
|
* Only relevant in Windows.
|
|
1305
|
-
*
|
|
1306
|
-
* @default false
|
|
1307
1286
|
*/
|
|
1308
1287
|
enableJumpList: boolean;
|
|
1309
1288
|
/**
|
|
1310
|
-
*
|
|
1289
|
+
* @defaultValue false
|
|
1311
1290
|
*
|
|
1312
|
-
*
|
|
1291
|
+
* When set to `true`, any `beforeunload` handler set on the app will fire.
|
|
1313
1292
|
*/
|
|
1314
1293
|
enableBeforeUnload: boolean;
|
|
1315
1294
|
/**
|
|
@@ -1390,25 +1369,25 @@ declare type ApplicationWindowInfo = {
|
|
|
1390
1369
|
*/
|
|
1391
1370
|
declare type ApplySnapshotOptions = {
|
|
1392
1371
|
/**
|
|
1372
|
+
* @defaultValue false
|
|
1373
|
+
*
|
|
1393
1374
|
* When true, applySnapshot will close existing windows,
|
|
1394
1375
|
* replacing current Platform state with the given snapshot.
|
|
1395
|
-
*
|
|
1396
|
-
* @default false
|
|
1397
1376
|
*/
|
|
1398
1377
|
closeExistingWindows?: boolean;
|
|
1399
1378
|
/**
|
|
1379
|
+
* @defaultValue false
|
|
1380
|
+
*
|
|
1400
1381
|
* When true, applySnapshot will close existing includeInSnapshots: true windows,
|
|
1401
1382
|
* replacing current Platform state with the given snapshot.
|
|
1402
|
-
*
|
|
1403
|
-
* @default false
|
|
1404
1383
|
*/
|
|
1405
1384
|
closeSnapshotWindows?: boolean;
|
|
1406
1385
|
/**
|
|
1386
|
+
* @defaultValue false
|
|
1387
|
+
*
|
|
1407
1388
|
* When true, applySnapshot will not check whether any windows in a
|
|
1408
1389
|
* snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
|
|
1409
1390
|
* as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
|
|
1410
|
-
*
|
|
1411
|
-
* @default false
|
|
1412
1391
|
*/
|
|
1413
1392
|
skipOutOfBoundsCheck?: boolean;
|
|
1414
1393
|
};
|
|
@@ -1714,8 +1693,6 @@ declare type BaseConfig = {
|
|
|
1714
1693
|
timeout?: number;
|
|
1715
1694
|
};
|
|
1716
1695
|
|
|
1717
|
-
declare type BaseContentBehavior = 'allow' | 'block';
|
|
1718
|
-
|
|
1719
1696
|
/**
|
|
1720
1697
|
* Properties shared by all content creation rules, regardless of context.
|
|
1721
1698
|
*
|
|
@@ -1957,35 +1934,7 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
|
1957
1934
|
reason: 'self' | 'animation';
|
|
1958
1935
|
};
|
|
1959
1936
|
|
|
1960
|
-
declare type BoundsEvent = BaseEvent_5 & OpenFin.
|
|
1961
|
-
|
|
1962
|
-
declare type BoundsType =
|
|
1963
|
-
/**
|
|
1964
|
-
* Bounds specify the size and location of the entire window, including OS border styling.
|
|
1965
|
-
*/
|
|
1966
|
-
'window'
|
|
1967
|
-
/**
|
|
1968
|
-
* Bounds specify the size and location of the window's DOM content, excluding OS border styling.
|
|
1969
|
-
*/
|
|
1970
|
-
| 'content'
|
|
1971
|
-
/**
|
|
1972
|
-
* Origin parameters (top, left) specify the location of the window origin, including OS border styling.
|
|
1973
|
-
* Size parameters bounds (width, height) specify the size of the window's DOM content, excluding OS border styling.
|
|
1974
|
-
*/
|
|
1975
|
-
| 'window-origin-content-size';
|
|
1976
|
-
|
|
1977
|
-
/**
|
|
1978
|
-
* Opens matched URLs in the browser.
|
|
1979
|
-
*
|
|
1980
|
-
* @interface
|
|
1981
|
-
*/
|
|
1982
|
-
declare type BrowserContentBehavior = {
|
|
1983
|
-
behavior: 'browser';
|
|
1984
|
-
/**
|
|
1985
|
-
* When true, closes the window or view that initiated the navigation.
|
|
1986
|
-
*/
|
|
1987
|
-
closeExisting?: boolean;
|
|
1988
|
-
};
|
|
1937
|
+
declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
|
|
1989
1938
|
|
|
1990
1939
|
/**
|
|
1991
1940
|
* A rule prescribing content creation in the browser.
|
|
@@ -2091,15 +2040,15 @@ declare type CapturePageOptions = {
|
|
|
2091
2040
|
*/
|
|
2092
2041
|
area?: Rectangle;
|
|
2093
2042
|
/**
|
|
2094
|
-
*
|
|
2043
|
+
* @defaultValue 'png'
|
|
2095
2044
|
*
|
|
2096
|
-
*
|
|
2045
|
+
* The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
|
2097
2046
|
*/
|
|
2098
2047
|
format?: 'bmp' | 'jpg' | 'png';
|
|
2099
2048
|
/**
|
|
2100
|
-
*
|
|
2049
|
+
* @defaultValue 100
|
|
2101
2050
|
*
|
|
2102
|
-
*
|
|
2051
|
+
* Quality of JPEG image. Between 0 - 100.
|
|
2103
2052
|
*/
|
|
2104
2053
|
quality?: number;
|
|
2105
2054
|
};
|
|
@@ -2753,9 +2702,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
|
|
|
2753
2702
|
*/
|
|
2754
2703
|
declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2755
2704
|
/**
|
|
2756
|
-
*
|
|
2705
|
+
* @defaultValue true
|
|
2757
2706
|
*
|
|
2758
|
-
*
|
|
2707
|
+
* If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
|
|
2759
2708
|
*/
|
|
2760
2709
|
wait?: boolean;
|
|
2761
2710
|
/**
|
|
@@ -3052,10 +3001,6 @@ declare type ChromiumPolicies = {
|
|
|
3052
3001
|
* Disable AutofillAddressEnabled policy for a Window or View.
|
|
3053
3002
|
*/
|
|
3054
3003
|
AutofillAddressEnabled?: PolicyOptions;
|
|
3055
|
-
/**
|
|
3056
|
-
* Disable AutofillCreditCardEnabled policy for a Window or View.
|
|
3057
|
-
*/
|
|
3058
|
-
AutofillCreditCardEnabled?: PolicyOptions;
|
|
3059
3004
|
};
|
|
3060
3005
|
|
|
3061
3006
|
declare interface ClassicProtocolOffer extends ProtocolPacketBase {
|
|
@@ -3141,7 +3086,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
|
3141
3086
|
*
|
|
3142
3087
|
*/
|
|
3143
3088
|
declare class Clipboard_2 extends Base {
|
|
3144
|
-
#private;
|
|
3145
3089
|
/**
|
|
3146
3090
|
* Writes data into the clipboard as plain text
|
|
3147
3091
|
* @param writeObj The object for writing data into the clipboard
|
|
@@ -3294,56 +3238,6 @@ declare class Clipboard_2 extends Base {
|
|
|
3294
3238
|
getAvailableFormats(type?: OpenFin.ClipboardSelectionType): Promise<Array<string>>;
|
|
3295
3239
|
}
|
|
3296
3240
|
|
|
3297
|
-
/**
|
|
3298
|
-
* Permissions for {@link Clipboard} APIs.
|
|
3299
|
-
*/
|
|
3300
|
-
declare type ClipboardApiPermissions = {
|
|
3301
|
-
writeText: boolean;
|
|
3302
|
-
readText: boolean;
|
|
3303
|
-
writeImage: boolean;
|
|
3304
|
-
readImage: boolean;
|
|
3305
|
-
writeHtml: boolean;
|
|
3306
|
-
readHtml: boolean;
|
|
3307
|
-
writeRtf: boolean;
|
|
3308
|
-
readRtf: boolean;
|
|
3309
|
-
write: boolean;
|
|
3310
|
-
};
|
|
3311
|
-
|
|
3312
|
-
/**
|
|
3313
|
-
* Generated when a copy operation is blocked through {@link OpenFin.DomainSettings}.
|
|
3314
|
-
* @interface
|
|
3315
|
-
*/
|
|
3316
|
-
declare type ClipboardCopyBlockedEvent = NamedEvent & {
|
|
3317
|
-
type: 'clipboard-copy-blocked';
|
|
3318
|
-
/**
|
|
3319
|
-
* URL of the Window or View that generated the event.
|
|
3320
|
-
*/
|
|
3321
|
-
url: string;
|
|
3322
|
-
reason: CopyBlockedEventReason;
|
|
3323
|
-
};
|
|
3324
|
-
|
|
3325
|
-
/**
|
|
3326
|
-
* Generated when a paste operation is blocked through {@link OpenFin.DomainSettings}.
|
|
3327
|
-
* @interface
|
|
3328
|
-
*/
|
|
3329
|
-
declare type ClipboardPasteBlockedEvent = NamedEvent & {
|
|
3330
|
-
type: 'clipboard-paste-blocked';
|
|
3331
|
-
/**
|
|
3332
|
-
* URL of the Window or View that generated the event.
|
|
3333
|
-
*/
|
|
3334
|
-
url: string;
|
|
3335
|
-
reason: PasteBlockedEventReason;
|
|
3336
|
-
};
|
|
3337
|
-
|
|
3338
|
-
/**
|
|
3339
|
-
* Clipboard Permissions
|
|
3340
|
-
* @interface
|
|
3341
|
-
*/
|
|
3342
|
-
declare type ClipboardPermissions = {
|
|
3343
|
-
copy?: CopyPermissions;
|
|
3344
|
-
paste?: PastePermissions;
|
|
3345
|
-
};
|
|
3346
|
-
|
|
3347
3241
|
/**
|
|
3348
3242
|
* The type of clipboard to write to, can be 'clipboard' or 'selection'.
|
|
3349
3243
|
* Defaults to 'clipboard'. Use 'selection' for linux only.
|
|
@@ -3421,9 +3315,9 @@ declare interface CloseWindowPayload {
|
|
|
3421
3315
|
windowId: Identity_4;
|
|
3422
3316
|
options: {
|
|
3423
3317
|
/**
|
|
3424
|
-
*
|
|
3318
|
+
* @defaultValue false
|
|
3425
3319
|
*
|
|
3426
|
-
*
|
|
3320
|
+
* When set to true skips any before handler set on views that are part of the window
|
|
3427
3321
|
*/
|
|
3428
3322
|
skipBeforeUnload?: boolean;
|
|
3429
3323
|
};
|
|
@@ -3531,22 +3425,15 @@ declare type ConstViewOptions = {
|
|
|
3531
3425
|
*/
|
|
3532
3426
|
name: string;
|
|
3533
3427
|
/**
|
|
3534
|
-
*
|
|
3428
|
+
* @defaultValue "about:blank"
|
|
3535
3429
|
*
|
|
3536
|
-
*
|
|
3430
|
+
* The URL of the window
|
|
3537
3431
|
*/
|
|
3538
3432
|
url: string;
|
|
3539
3433
|
/**
|
|
3540
3434
|
* The identity of the window this view should be attached to.
|
|
3541
3435
|
*/
|
|
3542
3436
|
target: Identity_4;
|
|
3543
|
-
/**
|
|
3544
|
-
* Defaults to `name`.
|
|
3545
|
-
* Ignored in container, but used in @openfin/core-web to set tab titles.
|
|
3546
|
-
* Order of precedence for title in container is: document.title, viewOptions.url.
|
|
3547
|
-
* Order of precedence for title in @openfin/core-web is ComponentConfig.title, viewOptions.title, viewOptions.url.
|
|
3548
|
-
*/
|
|
3549
|
-
title: string;
|
|
3550
3437
|
/**
|
|
3551
3438
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3552
3439
|
*/
|
|
@@ -3591,9 +3478,9 @@ declare type ConstViewOptions = {
|
|
|
3591
3478
|
experimental: any;
|
|
3592
3479
|
fdc3InteropApi?: string;
|
|
3593
3480
|
/**
|
|
3594
|
-
*
|
|
3481
|
+
* @defaultValue false
|
|
3595
3482
|
*
|
|
3596
|
-
*
|
|
3483
|
+
* When set to `true`, any `beforeunload` handler set on Views will fire.
|
|
3597
3484
|
*/
|
|
3598
3485
|
enableBeforeUnload: boolean;
|
|
3599
3486
|
/**
|
|
@@ -3674,12 +3561,13 @@ declare type ConstWindowOptions = {
|
|
|
3674
3561
|
*/
|
|
3675
3562
|
backgroundColor: string;
|
|
3676
3563
|
/**
|
|
3564
|
+
* @defaultValue false
|
|
3565
|
+
*
|
|
3677
3566
|
* Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
|
|
3678
3567
|
* This also affects the Page Visibility API.
|
|
3679
3568
|
*
|
|
3680
3569
|
* When `true`, the page is throttled whether it is hidden or not.
|
|
3681
3570
|
*
|
|
3682
|
-
* @default false
|
|
3683
3571
|
*/
|
|
3684
3572
|
backgroundThrottling: boolean;
|
|
3685
3573
|
/**
|
|
@@ -3703,21 +3591,21 @@ declare type ConstWindowOptions = {
|
|
|
3703
3591
|
*/
|
|
3704
3592
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3705
3593
|
/**
|
|
3594
|
+
* @defaultValue true
|
|
3595
|
+
*
|
|
3706
3596
|
* Setting this to false would keep the Window alive even if all its Views were closed.
|
|
3707
3597
|
* This is meant for advanced users and should be used with caution.
|
|
3708
3598
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
3709
3599
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
3710
3600
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3711
|
-
*
|
|
3712
|
-
* @default true
|
|
3713
3601
|
*/
|
|
3714
3602
|
closeOnLastViewRemoved: boolean;
|
|
3715
3603
|
/**
|
|
3604
|
+
* @defaultValue 'all'
|
|
3605
|
+
*
|
|
3716
3606
|
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
|
3717
|
-
* Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3607
|
+
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3718
3608
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3719
|
-
*
|
|
3720
|
-
* @default 'all'
|
|
3721
3609
|
*/
|
|
3722
3610
|
viewsPreventingClose: 'all' | 'layout';
|
|
3723
3611
|
/**
|
|
@@ -3728,31 +3616,31 @@ declare type ConstWindowOptions = {
|
|
|
3728
3616
|
*/
|
|
3729
3617
|
defaultCentered: boolean;
|
|
3730
3618
|
/**
|
|
3619
|
+
* @defaultValue 500
|
|
3620
|
+
*
|
|
3731
3621
|
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
|
3732
3622
|
* in favor of the cached value.
|
|
3733
|
-
*
|
|
3734
|
-
* @default 500
|
|
3735
3623
|
*/
|
|
3736
3624
|
defaultHeight: number;
|
|
3737
3625
|
/**
|
|
3626
|
+
* @defaultValue 100
|
|
3627
|
+
*
|
|
3738
3628
|
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3739
3629
|
* launches in favor of the cached value.
|
|
3740
|
-
*
|
|
3741
|
-
* @default 100
|
|
3742
3630
|
*/
|
|
3743
3631
|
defaultLeft: number;
|
|
3744
3632
|
/**
|
|
3633
|
+
* @defaultValue 100
|
|
3634
|
+
*
|
|
3745
3635
|
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3746
3636
|
* launches in favor of the cached value.
|
|
3747
|
-
*
|
|
3748
|
-
* @default 100
|
|
3749
3637
|
*/
|
|
3750
3638
|
defaultTop: number;
|
|
3751
3639
|
/**
|
|
3640
|
+
* @defaultValue 800
|
|
3641
|
+
*
|
|
3752
3642
|
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3753
3643
|
* launches in favor of the cached value.
|
|
3754
|
-
*
|
|
3755
|
-
* @default 800
|
|
3756
3644
|
*/
|
|
3757
3645
|
defaultWidth: number;
|
|
3758
3646
|
/**
|
|
@@ -3798,19 +3686,19 @@ declare type ConstWindowOptions = {
|
|
|
3798
3686
|
*/
|
|
3799
3687
|
processAffinity: string;
|
|
3800
3688
|
/**
|
|
3689
|
+
* @defaultValue false
|
|
3690
|
+
*
|
|
3801
3691
|
* Displays a shadow on frameless windows.
|
|
3802
3692
|
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
3803
3693
|
* On Windows 7, Aero theme is required.
|
|
3804
|
-
*
|
|
3805
|
-
* @default false
|
|
3806
3694
|
*/
|
|
3807
3695
|
shadow: boolean;
|
|
3808
3696
|
/**
|
|
3697
|
+
* @defaultValue true
|
|
3698
|
+
*
|
|
3809
3699
|
* Caches the location of the window.
|
|
3810
3700
|
*
|
|
3811
3701
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3812
|
-
*
|
|
3813
|
-
* @default true
|
|
3814
3702
|
*/
|
|
3815
3703
|
saveWindowState: boolean;
|
|
3816
3704
|
/**
|
|
@@ -3819,22 +3707,22 @@ declare type ConstWindowOptions = {
|
|
|
3819
3707
|
*/
|
|
3820
3708
|
ignoreSavedWindowState: boolean;
|
|
3821
3709
|
/**
|
|
3710
|
+
* @defaultValue false
|
|
3711
|
+
*
|
|
3822
3712
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3823
3713
|
*
|
|
3824
3714
|
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3825
3715
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3826
|
-
*
|
|
3827
|
-
* @default false
|
|
3828
3716
|
*/
|
|
3829
3717
|
smallWindow: boolean;
|
|
3830
3718
|
/**
|
|
3719
|
+
* @defaultValue "normal"
|
|
3720
|
+
*
|
|
3831
3721
|
* The visible state of the window on creation.
|
|
3832
3722
|
* One of:
|
|
3833
3723
|
* * `"maximized"`
|
|
3834
3724
|
* * `"minimized"`
|
|
3835
3725
|
* * `"normal"`
|
|
3836
|
-
*
|
|
3837
|
-
* @default "normal"
|
|
3838
3726
|
*/
|
|
3839
3727
|
state: WindowState;
|
|
3840
3728
|
/**
|
|
@@ -3848,20 +3736,20 @@ declare type ConstWindowOptions = {
|
|
|
3848
3736
|
*/
|
|
3849
3737
|
url: string;
|
|
3850
3738
|
/**
|
|
3739
|
+
* @defaultValue <application UUID>
|
|
3740
|
+
*
|
|
3851
3741
|
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
3852
3742
|
* If omitted, defaults to the `uuid` of the application spawning the window.
|
|
3853
3743
|
* If given, must match the `uuid` of the application spawning the window.
|
|
3854
3744
|
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
3855
3745
|
* really no need to provide it.
|
|
3856
|
-
*
|
|
3857
|
-
* @default <application UUID>
|
|
3858
3746
|
*/
|
|
3859
3747
|
uuid: string;
|
|
3860
3748
|
/**
|
|
3749
|
+
* @defaultValue false
|
|
3750
|
+
*
|
|
3861
3751
|
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
|
3862
3752
|
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
|
3863
|
-
*
|
|
3864
|
-
* @default false
|
|
3865
3753
|
*/
|
|
3866
3754
|
waitForPageLoad: boolean;
|
|
3867
3755
|
width: number;
|
|
@@ -3891,15 +3779,6 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
|
3891
3779
|
type: 'container-created';
|
|
3892
3780
|
};
|
|
3893
3781
|
|
|
3894
|
-
/**
|
|
3895
|
-
* Behavior when displaying content from matched URLs.
|
|
3896
|
-
*
|
|
3897
|
-
* 'allow': The content url is allowed.
|
|
3898
|
-
* 'block': The content url is blocked.
|
|
3899
|
-
* 'browser': The content url is blocked and it is opened in the system's default web browser.
|
|
3900
|
-
*/
|
|
3901
|
-
declare type ContentBehavior = BaseContentBehavior | 'browser';
|
|
3902
|
-
|
|
3903
3782
|
/**
|
|
3904
3783
|
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
|
3905
3784
|
* @interface
|
|
@@ -3987,9 +3866,12 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3987
3866
|
declare type ContentNavigation = NavigationRules;
|
|
3988
3867
|
|
|
3989
3868
|
/**
|
|
3990
|
-
*
|
|
3869
|
+
* Whether a content url is allowed or blocked for navigation or redirection.
|
|
3870
|
+
*
|
|
3871
|
+
* * 'allow': The content url is allowed.
|
|
3872
|
+
* * 'block': The content url is blocked.
|
|
3991
3873
|
*/
|
|
3992
|
-
declare type ContentPermission =
|
|
3874
|
+
declare type ContentPermission = 'allow' | 'block';
|
|
3993
3875
|
|
|
3994
3876
|
/**
|
|
3995
3877
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
@@ -4120,41 +4002,6 @@ declare type CookieOption = {
|
|
|
4120
4002
|
name: string;
|
|
4121
4003
|
};
|
|
4122
4004
|
|
|
4123
|
-
/**
|
|
4124
|
-
* Reasons for a copy operation being blocked
|
|
4125
|
-
*
|
|
4126
|
-
* 'disabled': Copy operation is disabled through domain-based permissions.
|
|
4127
|
-
*/
|
|
4128
|
-
declare type CopyBlockedEventReason = 'disabled';
|
|
4129
|
-
|
|
4130
|
-
/**
|
|
4131
|
-
* Control copy operations for a matched URL.
|
|
4132
|
-
* @interface
|
|
4133
|
-
*/
|
|
4134
|
-
declare type CopyPermissions = {
|
|
4135
|
-
/**
|
|
4136
|
-
* Controls the behavior for copy operations for a matched URL.
|
|
4137
|
-
*
|
|
4138
|
-
* allow: Enables all copy operations.
|
|
4139
|
-
* block: Disables all copy operations.
|
|
4140
|
-
* protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
|
|
4141
|
-
*
|
|
4142
|
-
* @default 'allowed'
|
|
4143
|
-
*/
|
|
4144
|
-
behavior: 'allow' | 'block' | 'protect';
|
|
4145
|
-
/**
|
|
4146
|
-
* Additional copy operation options
|
|
4147
|
-
*/
|
|
4148
|
-
options?: {
|
|
4149
|
-
/**
|
|
4150
|
-
* When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
|
|
4151
|
-
*
|
|
4152
|
-
* @default ''
|
|
4153
|
-
*/
|
|
4154
|
-
replacementText: string;
|
|
4155
|
-
};
|
|
4156
|
-
};
|
|
4157
|
-
|
|
4158
4005
|
/**
|
|
4159
4006
|
* Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
|
|
4160
4007
|
* average of _height_ and _width_.
|
|
@@ -4163,15 +4010,15 @@ declare type CopyPermissions = {
|
|
|
4163
4010
|
*/
|
|
4164
4011
|
declare type CornerRounding = {
|
|
4165
4012
|
/**
|
|
4166
|
-
*
|
|
4013
|
+
* @defaultValue 0
|
|
4167
4014
|
*
|
|
4168
|
-
*
|
|
4015
|
+
* The height in pixels.
|
|
4169
4016
|
*/
|
|
4170
4017
|
height: number;
|
|
4171
4018
|
/**
|
|
4172
|
-
*
|
|
4019
|
+
* @defaultValue 0
|
|
4173
4020
|
*
|
|
4174
|
-
*
|
|
4021
|
+
* The width in pixels.
|
|
4175
4022
|
*/
|
|
4176
4023
|
width: number;
|
|
4177
4024
|
};
|
|
@@ -4261,6 +4108,8 @@ declare type CreateLayoutOptions = {
|
|
|
4261
4108
|
layoutName: string;
|
|
4262
4109
|
layout: LayoutOptions;
|
|
4263
4110
|
/**
|
|
4111
|
+
* @defaultValue 'default'
|
|
4112
|
+
*
|
|
4264
4113
|
* Controls the View behavior for the given `layout` property. Note
|
|
4265
4114
|
* that the selected behavior only applies to unnamed Views or
|
|
4266
4115
|
* Views with the prefix `internal-generated-`. In all cases, if any
|
|
@@ -4282,8 +4131,6 @@ declare type CreateLayoutOptions = {
|
|
|
4282
4131
|
* override. Note that during applyLayoutSnapshot, Views are created and
|
|
4283
4132
|
* attached to the Provider while the Window is being created, so it's
|
|
4284
4133
|
* important to not 'duplicate' Views in this workflow.
|
|
4285
|
-
*
|
|
4286
|
-
* @default 'default'
|
|
4287
4134
|
*/
|
|
4288
4135
|
multiInstanceViewBehavior?: MultiInstanceViewBehavior;
|
|
4289
4136
|
};
|
|
@@ -4382,7 +4229,6 @@ declare type DefaultDomainSettings = DomainSettings;
|
|
|
4382
4229
|
|
|
4383
4230
|
/**
|
|
4384
4231
|
* @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
|
|
4385
|
-
* @interface
|
|
4386
4232
|
*/
|
|
4387
4233
|
declare type DefaultDomainSettingsRule = DomainSettingsRule;
|
|
4388
4234
|
|
|
@@ -4543,7 +4389,7 @@ declare type DomainApiSettings = {
|
|
|
4543
4389
|
* * 'none': The `fin` API will be not available.
|
|
4544
4390
|
* * 'global': The entire `fin` API will be available.
|
|
4545
4391
|
*
|
|
4546
|
-
* @
|
|
4392
|
+
* @defaultValue 'global'
|
|
4547
4393
|
*/
|
|
4548
4394
|
fin?: InjectionType;
|
|
4549
4395
|
/**
|
|
@@ -4559,9 +4405,8 @@ declare type DomainApiSettings = {
|
|
|
4559
4405
|
* @interface
|
|
4560
4406
|
* Defines application settings that vary by the domain of the current context.
|
|
4561
4407
|
*
|
|
4562
|
-
* @remarks
|
|
4563
|
-
*
|
|
4564
|
-
* exists.
|
|
4408
|
+
* @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
|
|
4409
|
+
* domain should be represented with a single rule.
|
|
4565
4410
|
*/
|
|
4566
4411
|
declare type DomainSettings = {
|
|
4567
4412
|
/**
|
|
@@ -4576,22 +4421,19 @@ declare type DomainSettings = {
|
|
|
4576
4421
|
* more information, see the documentation for the individual properties.
|
|
4577
4422
|
*/
|
|
4578
4423
|
default?: PerDomainSettings;
|
|
4579
|
-
/**
|
|
4580
|
-
* {@inheritDoc MultipleDomainMatchBehavior}
|
|
4581
|
-
*/
|
|
4582
|
-
multipleMatchBehavior?: MultipleDomainMatchBehavior;
|
|
4583
4424
|
};
|
|
4584
4425
|
|
|
4585
4426
|
/**
|
|
4586
|
-
* Defines domain-conditional settings for an OpenFin application.
|
|
4587
4427
|
* @interface
|
|
4428
|
+
*
|
|
4429
|
+
* Defines domain-conditional settings for an OpenFin application.
|
|
4588
4430
|
*/
|
|
4589
4431
|
declare type DomainSettingsRule = {
|
|
4590
4432
|
/**
|
|
4591
4433
|
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4592
4434
|
* the domain(s) for which the rule applies.
|
|
4593
4435
|
*/
|
|
4594
|
-
match
|
|
4436
|
+
match?: string[];
|
|
4595
4437
|
/**
|
|
4596
4438
|
* Settings applied when a webcontents has been navigated to a matched domain.
|
|
4597
4439
|
*/
|
|
@@ -4767,15 +4609,6 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4767
4609
|
type: EventType;
|
|
4768
4610
|
}>, ...args: any[]) => boolean;
|
|
4769
4611
|
private hasEmitter;
|
|
4770
|
-
/**
|
|
4771
|
-
* Cleans up after removal of a listener, e.g. deleting any lingering deregistration handlers for a
|
|
4772
|
-
* `once` subscription.
|
|
4773
|
-
*
|
|
4774
|
-
* @remarks Implementing this as a `removeListener` handler ensures that direct removal of a listener
|
|
4775
|
-
* on the base emitter will not leak additional core handlers. We could do this in the forwarding method,
|
|
4776
|
-
* which would involve less "magic," but would be more-vulnerable to accidental re-introduction of a leak.
|
|
4777
|
-
*/
|
|
4778
|
-
private cleanUpRemovedListener;
|
|
4779
4612
|
private getOrCreateEmitter;
|
|
4780
4613
|
listeners: (type: string | symbol) => Function[];
|
|
4781
4614
|
listenerCount: (type: string | symbol) => number;
|
|
@@ -5016,7 +4849,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
|
5016
4849
|
*/
|
|
5017
4850
|
declare type Event_5<Topic extends string> = {
|
|
5018
4851
|
topic: Topic;
|
|
5019
|
-
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | DidStartLoadingEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent | WillRedirectEvent
|
|
4852
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | DidStartLoadingEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent | WillRedirectEvent);
|
|
5020
4853
|
|
|
5021
4854
|
/**
|
|
5022
4855
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
|
|
@@ -5135,9 +4968,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
|
|
|
5135
4968
|
*/
|
|
5136
4969
|
declare type ExcludeOptions = {
|
|
5137
4970
|
/**
|
|
5138
|
-
*
|
|
4971
|
+
* @defaultValue false
|
|
5139
4972
|
*
|
|
5140
|
-
*
|
|
4973
|
+
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
|
5141
4974
|
*/
|
|
5142
4975
|
preloadScripts: boolean;
|
|
5143
4976
|
};
|
|
@@ -5457,10 +5290,6 @@ declare namespace FDC3 {
|
|
|
5457
5290
|
}
|
|
5458
5291
|
}
|
|
5459
5292
|
|
|
5460
|
-
declare type FDC3Factory = typeof fdc3Factory;
|
|
5461
|
-
|
|
5462
|
-
declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin.InteropClient, wire: Transport<'unknown'>) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
|
|
5463
|
-
|
|
5464
5293
|
export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
|
|
5465
5294
|
fdc3Version?: Fdc3Version;
|
|
5466
5295
|
}): Promise<Fdc3Module | Fdc3Module2>;
|
|
@@ -5915,7 +5744,6 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
|
5915
5744
|
* Domain-conditional rules for file downloads.
|
|
5916
5745
|
*
|
|
5917
5746
|
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
|
5918
|
-
* @interface
|
|
5919
5747
|
*/
|
|
5920
5748
|
declare type FileDownloadSettings = {
|
|
5921
5749
|
/**
|
|
@@ -5968,34 +5796,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
5968
5796
|
*/
|
|
5969
5797
|
declare type FindInPageOptions = {
|
|
5970
5798
|
/**
|
|
5971
|
-
*
|
|
5799
|
+
* @defaultValue true
|
|
5972
5800
|
*
|
|
5973
|
-
*
|
|
5801
|
+
* Searches in the forward direction (backward otherwise)
|
|
5974
5802
|
*/
|
|
5975
5803
|
forward?: boolean;
|
|
5976
5804
|
/**
|
|
5977
|
-
*
|
|
5805
|
+
* @defaultValue false
|
|
5978
5806
|
*
|
|
5979
|
-
*
|
|
5807
|
+
* Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
|
|
5980
5808
|
*/
|
|
5981
5809
|
findNext?: boolean;
|
|
5982
5810
|
/**
|
|
5983
|
-
*
|
|
5811
|
+
* @defaultValue false
|
|
5984
5812
|
*
|
|
5985
|
-
*
|
|
5813
|
+
* Enables case-sensitive searching.
|
|
5986
5814
|
*/
|
|
5987
5815
|
matchCase?: boolean;
|
|
5988
5816
|
/**
|
|
5989
|
-
*
|
|
5817
|
+
* @defaultValue false
|
|
5990
5818
|
*
|
|
5991
|
-
*
|
|
5819
|
+
* Only searches from the start of words.
|
|
5992
5820
|
*/
|
|
5993
5821
|
wordStart?: boolean;
|
|
5994
5822
|
/**
|
|
5823
|
+
* @defaultValue false
|
|
5824
|
+
*
|
|
5995
5825
|
* 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>
|
|
5996
5826
|
* lowercase or non-letter. Accepts several other intra-word matches.
|
|
5997
|
-
*
|
|
5998
|
-
* @default false
|
|
5999
5827
|
*/
|
|
6000
5828
|
medialCapitalAsWordStart?: boolean;
|
|
6001
5829
|
};
|
|
@@ -6147,8 +5975,11 @@ declare type FrameEventType = EventType_5;
|
|
|
6147
5975
|
/**
|
|
6148
5976
|
* @interface
|
|
6149
5977
|
*/
|
|
6150
|
-
declare type FrameInfo =
|
|
5978
|
+
declare type FrameInfo = {
|
|
5979
|
+
name: string;
|
|
5980
|
+
uuid: string;
|
|
6151
5981
|
url: string;
|
|
5982
|
+
entityType: EntityType_4;
|
|
6152
5983
|
parent: Identity_4;
|
|
6153
5984
|
};
|
|
6154
5985
|
|
|
@@ -6224,30 +6055,6 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
|
6224
6055
|
entityType: string;
|
|
6225
6056
|
};
|
|
6226
6057
|
|
|
6227
|
-
/**
|
|
6228
|
-
* @interface
|
|
6229
|
-
* Options for the {@link Window._Window.getBounds} method.
|
|
6230
|
-
*/
|
|
6231
|
-
declare interface GetBoundsOptions {
|
|
6232
|
-
/**
|
|
6233
|
-
* Specifies the state of the window for which to retrieve the bounds.
|
|
6234
|
-
*
|
|
6235
|
-
* - `'normal'`: Returns the bounds of the window in its 'normal' state (not maximized or minimized).
|
|
6236
|
-
* - `'current'`: Returns the bounds of the window in its current state. For a minimized window, this returns the bounds from its previous state before being minimized.
|
|
6237
|
-
*
|
|
6238
|
-
* If a window is in `normal` state, `current` and `normal` will return the same bounds.
|
|
6239
|
-
*
|
|
6240
|
-
* If a window is `maximized`, `current` will return the dimensions of the screen while `normal` will return the bounds the window will be restored to.
|
|
6241
|
-
*
|
|
6242
|
-
* If a window is `minimized`, both `current` and `normal` will return the bounds of the window prior to it being minimized.
|
|
6243
|
-
*
|
|
6244
|
-
* **Edge case:** On MacOS, if a window is maximized, then minimized, calling `getBounds` with `boundsType: 'current'` will return the bounds of the window when it was maximized while `normal` will return the normal bounds.
|
|
6245
|
-
*
|
|
6246
|
-
* @default 'normal'
|
|
6247
|
-
*/
|
|
6248
|
-
boundsType?: 'normal' | 'current';
|
|
6249
|
-
}
|
|
6250
|
-
|
|
6251
6058
|
/**
|
|
6252
6059
|
* @interface
|
|
6253
6060
|
*/
|
|
@@ -6509,9 +6316,9 @@ declare type Hotkey = {
|
|
|
6509
6316
|
*/
|
|
6510
6317
|
keys: string;
|
|
6511
6318
|
/**
|
|
6512
|
-
*
|
|
6319
|
+
* @defaultValue false
|
|
6513
6320
|
*
|
|
6514
|
-
*
|
|
6321
|
+
* Prevent default key handling before emitting the event.
|
|
6515
6322
|
*/
|
|
6516
6323
|
preventDefault?: boolean;
|
|
6517
6324
|
};
|
|
@@ -7482,7 +7289,7 @@ declare class InteropBroker extends Base {
|
|
|
7482
7289
|
};
|
|
7483
7290
|
private getClientState;
|
|
7484
7291
|
private static toObject;
|
|
7485
|
-
static checkContextIntegrity
|
|
7292
|
+
static checkContextIntegrity(context: OpenFin.Context): {
|
|
7486
7293
|
isValid: true;
|
|
7487
7294
|
} | {
|
|
7488
7295
|
isValid: false;
|
|
@@ -7581,7 +7388,7 @@ declare class InteropClient extends Base {
|
|
|
7581
7388
|
/**
|
|
7582
7389
|
* @internal
|
|
7583
7390
|
*/
|
|
7584
|
-
constructor(wire: Transport, clientPromise: Promise<OpenFin.ChannelClient
|
|
7391
|
+
constructor(wire: Transport, clientPromise: Promise<OpenFin.ChannelClient>);
|
|
7585
7392
|
/**
|
|
7586
7393
|
* Sets a context for the context group of the current entity.
|
|
7587
7394
|
*
|
|
@@ -8184,7 +7991,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
8184
7991
|
*
|
|
8185
7992
|
* @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
|
|
8186
7993
|
*
|
|
8187
|
-
* ####
|
|
7994
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
|
|
8188
7995
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
8189
7996
|
* @example
|
|
8190
7997
|
* ```js
|
|
@@ -8201,7 +8008,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
8201
8008
|
* });
|
|
8202
8009
|
* ```
|
|
8203
8010
|
*
|
|
8204
|
-
* ####
|
|
8011
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
|
|
8205
8012
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
8206
8013
|
* @example
|
|
8207
8014
|
* ```js
|
|
@@ -8474,7 +8281,7 @@ declare class Layout extends Base {
|
|
|
8474
8281
|
*/
|
|
8475
8282
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
|
8476
8283
|
/**
|
|
8477
|
-
* Adds a view to the platform layout. Behaves like
|
|
8284
|
+
* Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
|
|
8478
8285
|
*
|
|
8479
8286
|
* @param viewOptions - The options for creating the view.
|
|
8480
8287
|
* @param options - Optional parameters for adding the view.
|
|
@@ -8490,7 +8297,7 @@ declare class Layout extends Base {
|
|
|
8490
8297
|
}>;
|
|
8491
8298
|
/**
|
|
8492
8299
|
* Closes a view by its identity. Throws an error if the view does not belong to the current layout.
|
|
8493
|
-
* Behaves like
|
|
8300
|
+
* Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
|
|
8494
8301
|
*
|
|
8495
8302
|
* @param viewIdentity - The identity of the view to close.
|
|
8496
8303
|
* @returns A promise that resolves when the view is closed.
|
|
@@ -9052,79 +8859,77 @@ declare type LayoutOptions = {
|
|
|
9052
8859
|
*/
|
|
9053
8860
|
settings?: {
|
|
9054
8861
|
/**
|
|
9055
|
-
*
|
|
8862
|
+
* @defaultValue false
|
|
9056
8863
|
*
|
|
9057
|
-
*
|
|
8864
|
+
* When true the splitters will not be draggable and the layout will not resize.
|
|
9058
8865
|
*/
|
|
9059
8866
|
preventSplitterResize?: boolean;
|
|
9060
8867
|
/**
|
|
8868
|
+
* @defaultValue false
|
|
8869
|
+
*
|
|
9061
8870
|
* Whether the popout button will only act on the entire stack,
|
|
9062
8871
|
* as opposed to only the active tab.
|
|
9063
|
-
*
|
|
9064
|
-
* @default false
|
|
9065
8872
|
*/
|
|
9066
8873
|
popoutWholeStack?: boolean;
|
|
9067
8874
|
/**
|
|
8875
|
+
* @defaultValue false
|
|
8876
|
+
*
|
|
9068
8877
|
* Limits the area to which tabs can be dragged.
|
|
9069
8878
|
* If true, the layout container is the only area where tabs can be dropped.
|
|
9070
|
-
*
|
|
9071
|
-
* @default false
|
|
9072
8879
|
*/
|
|
9073
8880
|
constrainDragToContainer?: boolean;
|
|
9074
8881
|
/**
|
|
8882
|
+
* @defaultValue false
|
|
8883
|
+
*
|
|
9075
8884
|
* Whether to show the popout button on stack header.
|
|
9076
8885
|
* The button will create a new window with current tab as its content.
|
|
9077
8886
|
* In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
|
|
9078
|
-
*
|
|
9079
|
-
* @default false
|
|
9080
8887
|
*/
|
|
9081
8888
|
showPopoutIcon?: boolean;
|
|
9082
8889
|
/**
|
|
8890
|
+
* @defaultValue false
|
|
8891
|
+
*
|
|
9083
8892
|
* Whether to show the maximize button on stack header.
|
|
9084
8893
|
* The button will maximize the current tab to fill the entire window.
|
|
9085
|
-
*
|
|
9086
|
-
* @default false
|
|
9087
8894
|
*/
|
|
9088
8895
|
showMaximiseIcon?: boolean;
|
|
9089
8896
|
/**
|
|
8897
|
+
* @defaultValue false
|
|
8898
|
+
*
|
|
9090
8899
|
* Whether to show the close button on stack header
|
|
9091
8900
|
* (not to be confused with close button on every tab).
|
|
9092
|
-
*
|
|
9093
|
-
* @default false
|
|
9094
8901
|
*/
|
|
9095
8902
|
showCloseIcon?: boolean;
|
|
9096
8903
|
/**
|
|
9097
|
-
*
|
|
8904
|
+
* @defaultValue false
|
|
9098
8905
|
*
|
|
9099
|
-
*
|
|
8906
|
+
* Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
|
|
9100
8907
|
*/
|
|
9101
8908
|
constrainDragToHeaders?: boolean;
|
|
9102
8909
|
/**
|
|
8910
|
+
* @defaultValue true
|
|
8911
|
+
*
|
|
9103
8912
|
* Turns tab headers on or off.
|
|
9104
8913
|
* If false, the layout will be displayed with splitters only.
|
|
9105
|
-
*
|
|
9106
|
-
* @default true
|
|
9107
8914
|
*/
|
|
9108
8915
|
hasHeaders?: boolean;
|
|
9109
8916
|
/**
|
|
8917
|
+
* @defaultValue true
|
|
8918
|
+
*
|
|
9110
8919
|
* If true, the user can re-arrange the layout by
|
|
9111
8920
|
* dragging items by their tabs to the desired location.
|
|
9112
|
-
*
|
|
9113
|
-
* @default true
|
|
9114
8921
|
*/
|
|
9115
8922
|
reorderEnabled?: boolean;
|
|
9116
8923
|
/**
|
|
9117
|
-
*
|
|
8924
|
+
* @defaultValue false
|
|
9118
8925
|
*
|
|
9119
|
-
*
|
|
8926
|
+
* If true, tabs can't be dragged out of the window.
|
|
9120
8927
|
*/
|
|
9121
8928
|
preventDragOut?: boolean;
|
|
9122
8929
|
/**
|
|
9123
8930
|
* @defaultValue=false
|
|
9124
8931
|
*
|
|
9125
8932
|
* If true, tabs can't be dragged into the window.
|
|
9126
|
-
*
|
|
9127
|
-
* @default false
|
|
9128
8933
|
*/
|
|
9129
8934
|
preventDragIn?: boolean;
|
|
9130
8935
|
};
|
|
@@ -9546,19 +9351,6 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
|
|
|
9546
9351
|
*/
|
|
9547
9352
|
declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
|
|
9548
9353
|
|
|
9549
|
-
/**
|
|
9550
|
-
* Behavior for handling multiple {@link DomainSettingsRule} matches.
|
|
9551
|
-
*/
|
|
9552
|
-
declare type MultipleDomainMatchBehavior =
|
|
9553
|
-
/**
|
|
9554
|
-
* Apply only the first matching rule in the list.
|
|
9555
|
-
*/
|
|
9556
|
-
'pick-first'
|
|
9557
|
-
/**
|
|
9558
|
-
* Deep-merge all matching rules in the list, prioritizing earlier matches. Treats arrays as primitives.
|
|
9559
|
-
*/
|
|
9560
|
-
| 'deep-merge';
|
|
9561
|
-
|
|
9562
9354
|
/**
|
|
9563
9355
|
* @interface
|
|
9564
9356
|
*/
|
|
@@ -9567,10 +9359,10 @@ declare type MutableViewOptions = {
|
|
|
9567
9359
|
/**
|
|
9568
9360
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9569
9361
|
*
|
|
9362
|
+
* @defaultValue true
|
|
9363
|
+
*
|
|
9570
9364
|
* Show the context menu when right-clicking on the view.
|
|
9571
9365
|
* Gives access to the devtools for the view.
|
|
9572
|
-
*
|
|
9573
|
-
* @default true
|
|
9574
9366
|
*/
|
|
9575
9367
|
contextMenu: boolean;
|
|
9576
9368
|
/**
|
|
@@ -9617,25 +9409,24 @@ declare type MutableViewOptions = {
|
|
|
9617
9409
|
contentNavigation: ContentNavigation;
|
|
9618
9410
|
contentRedirect: ContentRedirect;
|
|
9619
9411
|
/**
|
|
9412
|
+
* @defaultValue false
|
|
9620
9413
|
* @deprecated
|
|
9621
9414
|
* **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
|
|
9622
9415
|
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
|
9623
|
-
*
|
|
9624
|
-
* @default false
|
|
9625
9416
|
*/
|
|
9626
9417
|
detachOnClose: boolean;
|
|
9627
9418
|
/**
|
|
9419
|
+
* @defaultValue true
|
|
9420
|
+
*
|
|
9628
9421
|
* **Platforms Only.** If false, the view will be persistent and can't be closed through
|
|
9629
9422
|
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
|
9630
9423
|
* if the view isn't part of the new layout when running `Layout.replace`.
|
|
9631
|
-
*
|
|
9632
|
-
* @default true
|
|
9633
9424
|
*/
|
|
9634
9425
|
isClosable: boolean;
|
|
9635
9426
|
/**
|
|
9636
|
-
*
|
|
9427
|
+
* @defaultValue false
|
|
9637
9428
|
*
|
|
9638
|
-
*
|
|
9429
|
+
* **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
|
9639
9430
|
*/
|
|
9640
9431
|
preventDragOut: boolean;
|
|
9641
9432
|
interop?: InteropConfig;
|
|
@@ -9647,7 +9438,7 @@ declare type MutableViewOptions = {
|
|
|
9647
9438
|
/**
|
|
9648
9439
|
* {@inheritDoc ViewThrottling}
|
|
9649
9440
|
*
|
|
9650
|
-
* @
|
|
9441
|
+
* @defaultValue 'enabled'
|
|
9651
9442
|
*/
|
|
9652
9443
|
throttling: ViewThrottling;
|
|
9653
9444
|
/**
|
|
@@ -9666,7 +9457,7 @@ declare type MutableWindowOptions = {
|
|
|
9666
9457
|
* Turns anything of matching RGB value transparent.
|
|
9667
9458
|
*
|
|
9668
9459
|
* Caveats:
|
|
9669
|
-
* *
|
|
9460
|
+
* * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
|
|
9670
9461
|
* * User cannot click-through transparent regions
|
|
9671
9462
|
* * Not supported on Mac
|
|
9672
9463
|
* * Windows Aero must be enabled
|
|
@@ -9675,25 +9466,25 @@ declare type MutableWindowOptions = {
|
|
|
9675
9466
|
*/
|
|
9676
9467
|
alphaMask: RGB;
|
|
9677
9468
|
/**
|
|
9678
|
-
*
|
|
9469
|
+
* @defaultValue false
|
|
9679
9470
|
*
|
|
9680
|
-
*
|
|
9471
|
+
* Always position the window at the top of the window stack.
|
|
9681
9472
|
*/
|
|
9682
9473
|
alwaysOnTop: boolean;
|
|
9683
9474
|
/**
|
|
9475
|
+
* @defaultValue 0
|
|
9476
|
+
*
|
|
9684
9477
|
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
|
9685
9478
|
* an aspect ratio will not be enforced.
|
|
9686
|
-
*
|
|
9687
|
-
* @default 0
|
|
9688
9479
|
*/
|
|
9689
9480
|
aspectRatio: number;
|
|
9690
9481
|
/**
|
|
9691
9482
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9692
9483
|
*
|
|
9484
|
+
* @defaultValue true
|
|
9485
|
+
*
|
|
9693
9486
|
* Show the context menu when right-clicking on the window.
|
|
9694
9487
|
* Gives access to the devtools for the window.
|
|
9695
|
-
*
|
|
9696
|
-
* @default true
|
|
9697
9488
|
*/
|
|
9698
9489
|
contextMenu: boolean;
|
|
9699
9490
|
/**
|
|
@@ -9763,14 +9554,12 @@ declare type MutableWindowOptions = {
|
|
|
9763
9554
|
* @defaultValue true
|
|
9764
9555
|
*
|
|
9765
9556
|
* Show the window's frame.
|
|
9766
|
-
*
|
|
9767
|
-
* @default true
|
|
9768
9557
|
*/
|
|
9769
9558
|
frame: boolean;
|
|
9770
9559
|
/**
|
|
9771
|
-
*
|
|
9560
|
+
* @defaultValue false
|
|
9772
9561
|
*
|
|
9773
|
-
*
|
|
9562
|
+
* Hides the window instead of closing it when the close button is pressed.
|
|
9774
9563
|
*/
|
|
9775
9564
|
hideOnClose: boolean;
|
|
9776
9565
|
/**
|
|
@@ -9823,61 +9612,60 @@ declare type MutableWindowOptions = {
|
|
|
9823
9612
|
*/
|
|
9824
9613
|
icon: string;
|
|
9825
9614
|
/**
|
|
9615
|
+
* @defaultValue true
|
|
9616
|
+
*
|
|
9826
9617
|
* Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
|
9827
9618
|
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
|
9828
|
-
*
|
|
9829
|
-
* @default true
|
|
9830
9619
|
*/
|
|
9831
9620
|
includeInSnapshots: boolean;
|
|
9832
9621
|
/**
|
|
9833
|
-
*
|
|
9622
|
+
* @defaultValue -1
|
|
9834
9623
|
*
|
|
9835
|
-
*
|
|
9624
|
+
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
|
9836
9625
|
*/
|
|
9837
9626
|
maxHeight: number;
|
|
9838
9627
|
/**
|
|
9839
|
-
*
|
|
9628
|
+
* @defaultValue true
|
|
9840
9629
|
*
|
|
9841
|
-
*
|
|
9630
|
+
* Allows the window to be maximized.
|
|
9842
9631
|
*/
|
|
9843
9632
|
maximizable: boolean;
|
|
9844
9633
|
/**
|
|
9845
|
-
*
|
|
9634
|
+
* @defaultValue -1
|
|
9846
9635
|
*
|
|
9847
|
-
*
|
|
9636
|
+
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
|
9848
9637
|
*/
|
|
9849
9638
|
maxWidth: number;
|
|
9850
9639
|
/**
|
|
9851
|
-
*
|
|
9640
|
+
* @defaultValue 0
|
|
9852
9641
|
*
|
|
9853
|
-
*
|
|
9642
|
+
* The minimum height of the window.
|
|
9854
9643
|
*/
|
|
9855
9644
|
minHeight: number;
|
|
9856
9645
|
/**
|
|
9857
|
-
*
|
|
9646
|
+
* @defaultValue true
|
|
9858
9647
|
*
|
|
9859
|
-
*
|
|
9648
|
+
* Allows the window to be minimized.
|
|
9860
9649
|
*/
|
|
9861
9650
|
minimizable: boolean;
|
|
9862
9651
|
/**
|
|
9863
|
-
*
|
|
9652
|
+
* @defaultValue true
|
|
9864
9653
|
*
|
|
9865
|
-
*
|
|
9654
|
+
* The minimum width of the window.
|
|
9866
9655
|
*/
|
|
9867
9656
|
minWidth: number;
|
|
9868
9657
|
/**
|
|
9658
|
+
* @defaultValue 1
|
|
9659
|
+
*
|
|
9869
9660
|
* A flag that specifies how transparent the window will be.
|
|
9870
9661
|
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
|
9871
9662
|
* This value is clamped between `0.0` and `1.0`.
|
|
9872
|
-
* In software composition mode, the runtime flag --allow-unsafe-compositing is required.
|
|
9873
|
-
*
|
|
9874
|
-
* @default 1
|
|
9875
9663
|
*/
|
|
9876
9664
|
opacity: number;
|
|
9877
9665
|
/**
|
|
9878
|
-
*
|
|
9666
|
+
* @defaultValue true
|
|
9879
9667
|
*
|
|
9880
|
-
*
|
|
9668
|
+
* A flag to allow the user to resize the window.
|
|
9881
9669
|
*/
|
|
9882
9670
|
resizable: boolean;
|
|
9883
9671
|
/**
|
|
@@ -9885,16 +9673,16 @@ declare type MutableWindowOptions = {
|
|
|
9885
9673
|
*/
|
|
9886
9674
|
resizeRegion: ResizeRegion;
|
|
9887
9675
|
/**
|
|
9676
|
+
* @defaultValue false
|
|
9677
|
+
*
|
|
9888
9678
|
* **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
|
|
9889
9679
|
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
|
9890
|
-
*
|
|
9891
|
-
* @default false
|
|
9892
9680
|
*/
|
|
9893
9681
|
showBackgroundImages: boolean;
|
|
9894
9682
|
/**
|
|
9895
|
-
*
|
|
9683
|
+
* @defaultValue true
|
|
9896
9684
|
*
|
|
9897
|
-
*
|
|
9685
|
+
* Shows the window's icon in the taskbar.
|
|
9898
9686
|
*/
|
|
9899
9687
|
showTaskbarIcon: boolean;
|
|
9900
9688
|
/**
|
|
@@ -9917,7 +9705,7 @@ declare type MutableWindowOptions = {
|
|
|
9917
9705
|
/**
|
|
9918
9706
|
* {@inheritDoc WindowThrottling}
|
|
9919
9707
|
*
|
|
9920
|
-
* @
|
|
9708
|
+
* @defaultValue 'enabled'
|
|
9921
9709
|
*
|
|
9922
9710
|
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
|
9923
9711
|
*/
|
|
@@ -9946,14 +9734,13 @@ declare type NativeWindowIntegrationProviderAuthorization = {
|
|
|
9946
9734
|
};
|
|
9947
9735
|
|
|
9948
9736
|
/**
|
|
9949
|
-
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules
|
|
9737
|
+
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
|
|
9950
9738
|
* @interface
|
|
9951
9739
|
*/
|
|
9952
9740
|
declare type NavigationRejectedEvent = NamedEvent & {
|
|
9953
9741
|
type: 'navigation-rejected';
|
|
9954
9742
|
sourceName?: string;
|
|
9955
9743
|
url: string;
|
|
9956
|
-
contentRule?: OpenFin.ContentPermission | undefined;
|
|
9957
9744
|
};
|
|
9958
9745
|
|
|
9959
9746
|
/**
|
|
@@ -10113,11 +9900,8 @@ declare namespace OpenFin {
|
|
|
10113
9900
|
ClientConnectionPayload,
|
|
10114
9901
|
EntityInfo,
|
|
10115
9902
|
EntityType_4 as EntityType,
|
|
10116
|
-
ScreenCaptureState,
|
|
10117
|
-
ScreenCapturePermission,
|
|
10118
9903
|
Bounds,
|
|
10119
9904
|
WindowBounds,
|
|
10120
|
-
GetBoundsOptions,
|
|
10121
9905
|
Rectangle,
|
|
10122
9906
|
ApplicationCreationOptions,
|
|
10123
9907
|
TimeZones,
|
|
@@ -10220,7 +10004,6 @@ declare namespace OpenFin {
|
|
|
10220
10004
|
OpenExternalPermission,
|
|
10221
10005
|
DeviceInfo,
|
|
10222
10006
|
Permissions_2 as Permissions,
|
|
10223
|
-
ClipboardApiPermissions,
|
|
10224
10007
|
PlatformWindowCreationOptions,
|
|
10225
10008
|
PlatformWindowOptions,
|
|
10226
10009
|
PlatformViewCreationOptions,
|
|
@@ -10326,21 +10109,11 @@ declare namespace OpenFin {
|
|
|
10326
10109
|
RuntimeInfo,
|
|
10327
10110
|
DefaultDomainSettings,
|
|
10328
10111
|
DefaultDomainSettingsRule,
|
|
10329
|
-
MultipleDomainMatchBehavior,
|
|
10330
10112
|
DomainSettings,
|
|
10331
10113
|
ApiInjection,
|
|
10332
10114
|
DomainApiSettings,
|
|
10333
|
-
BaseContentBehavior,
|
|
10334
|
-
ContentBehavior,
|
|
10335
|
-
BrowserContentBehavior,
|
|
10336
|
-
StructuredContentBehavior,
|
|
10337
|
-
StructuredContentPermissions,
|
|
10338
10115
|
ContentPermission,
|
|
10339
|
-
ScreenCaptureBehavior,
|
|
10340
10116
|
PerDomainSettings,
|
|
10341
|
-
CopyPermissions,
|
|
10342
|
-
PastePermissions,
|
|
10343
|
-
ClipboardPermissions,
|
|
10344
10117
|
DomainSettingsRule,
|
|
10345
10118
|
FileDownloadBehavior,
|
|
10346
10119
|
FileDownloadBehaviorNames,
|
|
@@ -10440,7 +10213,6 @@ declare namespace OpenFin {
|
|
|
10440
10213
|
Me,
|
|
10441
10214
|
CapturePageOptions,
|
|
10442
10215
|
ProcessLoggingOptions,
|
|
10443
|
-
BoundsType,
|
|
10444
10216
|
PositioningOptions,
|
|
10445
10217
|
ChannelClientConnectionListener,
|
|
10446
10218
|
ChannelClientDisconnectionListener,
|
|
@@ -10449,11 +10221,6 @@ declare namespace OpenFin {
|
|
|
10449
10221
|
DownloadShelfOptions,
|
|
10450
10222
|
ViewShowAtOptions,
|
|
10451
10223
|
ExtensionInfo,
|
|
10452
|
-
ServeRequest,
|
|
10453
|
-
AppAssetServeRequest,
|
|
10454
|
-
PathServeRequest,
|
|
10455
|
-
ServeAssetOptions,
|
|
10456
|
-
ServedAssetInfo,
|
|
10457
10224
|
ApplicationEvents,
|
|
10458
10225
|
BaseEvents,
|
|
10459
10226
|
ExternalApplicationEvents,
|
|
@@ -10520,34 +10287,6 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
|
|
|
10520
10287
|
title: string;
|
|
10521
10288
|
};
|
|
10522
10289
|
|
|
10523
|
-
/**
|
|
10524
|
-
* Reasons for a paste operation being blocked
|
|
10525
|
-
*
|
|
10526
|
-
* 'invalid-data': Copy protection is enabled and the pasted data is invalid.
|
|
10527
|
-
* 'disabled': Copy protection is turned on and the current URL for this WebContent has been disabled through domain-based settings from accessing the copied data.
|
|
10528
|
-
*/
|
|
10529
|
-
declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
|
|
10530
|
-
|
|
10531
|
-
/**
|
|
10532
|
-
* Control copy operations for a matched URL.
|
|
10533
|
-
* @interface
|
|
10534
|
-
*/
|
|
10535
|
-
declare type PastePermissions = {
|
|
10536
|
-
/**
|
|
10537
|
-
* Controls the behavior for paste operations for a matched URL.
|
|
10538
|
-
*
|
|
10539
|
-
* non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
|
|
10540
|
-
* 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.
|
|
10541
|
-
*
|
|
10542
|
-
* @default 'non-protected-content'
|
|
10543
|
-
*/
|
|
10544
|
-
behavior: 'non-protected-content' | 'all-content';
|
|
10545
|
-
};
|
|
10546
|
-
|
|
10547
|
-
declare type PathServeRequest = ServeRequest & {
|
|
10548
|
-
path: string;
|
|
10549
|
-
};
|
|
10550
|
-
|
|
10551
10290
|
declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10552
10291
|
success: Success;
|
|
10553
10292
|
data: Success extends true ? Data : never;
|
|
@@ -10687,29 +10426,6 @@ declare type PerDomainSettings = {
|
|
|
10687
10426
|
* {@inheritdoc ChromiumPolicies}
|
|
10688
10427
|
*/
|
|
10689
10428
|
chromiumPolicies?: ChromiumPolicies;
|
|
10690
|
-
/**
|
|
10691
|
-
* @experimental These features are still under development and may change.
|
|
10692
|
-
*/
|
|
10693
|
-
contentProtection?: {
|
|
10694
|
-
/**
|
|
10695
|
-
* {@inheritdoc ScreenCaptureBehavior}
|
|
10696
|
-
*/
|
|
10697
|
-
screenCapture?: ScreenCaptureBehavior;
|
|
10698
|
-
/**
|
|
10699
|
-
* {@inheritdoc ClipboardPermissions}
|
|
10700
|
-
*/
|
|
10701
|
-
clipboard?: ClipboardPermissions;
|
|
10702
|
-
/**
|
|
10703
|
-
* Whether the content can be printed.
|
|
10704
|
-
* Defaults to 'allow'.
|
|
10705
|
-
* Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
|
|
10706
|
-
*/
|
|
10707
|
-
print?: 'allow' | 'block';
|
|
10708
|
-
/**
|
|
10709
|
-
* * Controls whether HTML5 dragging for this content is allowed or blocked.
|
|
10710
|
-
*/
|
|
10711
|
-
drag?: 'allow' | 'block';
|
|
10712
|
-
};
|
|
10713
10429
|
};
|
|
10714
10430
|
|
|
10715
10431
|
/**
|
|
@@ -10734,7 +10450,6 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
|
|
10734
10450
|
declare type Permissions_2 = {
|
|
10735
10451
|
Application?: Partial<ApplicationPermissions>;
|
|
10736
10452
|
System?: Partial<SystemPermissions>;
|
|
10737
|
-
Clipboard?: Partial<ClipboardApiPermissions>;
|
|
10738
10453
|
webAPIs?: WebPermission[];
|
|
10739
10454
|
devices?: DeviceInfo[];
|
|
10740
10455
|
};
|
|
@@ -11604,11 +11319,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
11604
11319
|
*/
|
|
11605
11320
|
providerUrl?: string;
|
|
11606
11321
|
/**
|
|
11322
|
+
* @defaultValue true
|
|
11323
|
+
*
|
|
11607
11324
|
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
|
11608
11325
|
*
|
|
11609
11326
|
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
|
11610
|
-
*
|
|
11611
|
-
* @default true
|
|
11612
11327
|
*/
|
|
11613
11328
|
allowLaunchIntoPlatform?: boolean;
|
|
11614
11329
|
};
|
|
@@ -12188,14 +11903,6 @@ declare interface PlatformProvider {
|
|
|
12188
11903
|
* ```
|
|
12189
11904
|
*/
|
|
12190
11905
|
handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
|
|
12191
|
-
/**
|
|
12192
|
-
* Determines whether a given window should prevent the application from quitting when it is closed.
|
|
12193
|
-
* This method is called when checking if closing a window should trigger application termination.
|
|
12194
|
-
*
|
|
12195
|
-
* @param windowIdentity - The identity of the window being checked.
|
|
12196
|
-
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
12197
|
-
*/
|
|
12198
|
-
shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
|
|
12199
11906
|
}
|
|
12200
11907
|
|
|
12201
11908
|
/**
|
|
@@ -12297,22 +12004,22 @@ declare type PopupOptions = {
|
|
|
12297
12004
|
url?: string;
|
|
12298
12005
|
/**
|
|
12299
12006
|
* Height of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12300
|
-
* @
|
|
12007
|
+
* @defaultValue 300
|
|
12301
12008
|
*/
|
|
12302
12009
|
height?: number;
|
|
12303
12010
|
/**
|
|
12304
12011
|
* Width of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12305
|
-
* @
|
|
12012
|
+
* @defaultValue 300
|
|
12306
12013
|
*/
|
|
12307
12014
|
width?: number;
|
|
12308
12015
|
/**
|
|
12309
12016
|
* Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12310
|
-
* @
|
|
12017
|
+
* @defaultValue 0
|
|
12311
12018
|
*/
|
|
12312
12019
|
x?: number;
|
|
12313
12020
|
/**
|
|
12314
12021
|
* Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12315
|
-
* @
|
|
12022
|
+
* @defaultValue 0
|
|
12316
12023
|
*/
|
|
12317
12024
|
y?: number;
|
|
12318
12025
|
/**
|
|
@@ -12320,7 +12027,7 @@ declare type PopupOptions = {
|
|
|
12320
12027
|
* * 'modal' restricts resizing and positioning in the caller.
|
|
12321
12028
|
* * 'hide' hides the popup window on blur.
|
|
12322
12029
|
* * 'close' closes the popup window on blur.
|
|
12323
|
-
* @
|
|
12030
|
+
* @defaultValue 'close'
|
|
12324
12031
|
*/
|
|
12325
12032
|
blurBehavior?: PopupBlurBehavior;
|
|
12326
12033
|
/**
|
|
@@ -12328,19 +12035,19 @@ declare type PopupOptions = {
|
|
|
12328
12035
|
* * 'none' will do nothing.
|
|
12329
12036
|
* * 'hide' hides the popup window on `dispatchPopupResult`.
|
|
12330
12037
|
* * 'close' closes the popup window on `dispatchPopupResult`.
|
|
12331
|
-
* @
|
|
12038
|
+
* @defaultValue 'close'
|
|
12332
12039
|
*/
|
|
12333
12040
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
12334
12041
|
/**
|
|
12335
12042
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
12336
12043
|
*
|
|
12337
12044
|
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
12338
|
-
* @
|
|
12045
|
+
* @defaultValue false
|
|
12339
12046
|
*/
|
|
12340
12047
|
hideOnClose?: boolean;
|
|
12341
12048
|
/**
|
|
12342
12049
|
* Determines if the popup window should or should not be focused when it is shown.
|
|
12343
|
-
* @
|
|
12050
|
+
* @defaultValue true
|
|
12344
12051
|
*/
|
|
12345
12052
|
focus?: boolean;
|
|
12346
12053
|
/**
|
|
@@ -12419,7 +12126,6 @@ declare type PositioningOptions = {
|
|
|
12419
12126
|
* This will have the effect of the maximized window staying maximized and not immediately taking this new position.
|
|
12420
12127
|
*/
|
|
12421
12128
|
skipRestore?: boolean;
|
|
12422
|
-
boundsType?: BoundsType;
|
|
12423
12129
|
};
|
|
12424
12130
|
|
|
12425
12131
|
/**
|
|
@@ -12434,9 +12140,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
|
|
|
12434
12140
|
*/
|
|
12435
12141
|
declare type PreloadScript = {
|
|
12436
12142
|
/**
|
|
12437
|
-
*
|
|
12143
|
+
* @defaultValue false
|
|
12438
12144
|
*
|
|
12439
|
-
*
|
|
12145
|
+
* Fail to load the window if this preload script fails
|
|
12440
12146
|
*/
|
|
12441
12147
|
mandatory?: boolean;
|
|
12442
12148
|
/**
|
|
@@ -12532,15 +12238,15 @@ declare type PrinterInfo = {
|
|
|
12532
12238
|
declare type PrintOptions = {
|
|
12533
12239
|
content?: 'self';
|
|
12534
12240
|
/**
|
|
12535
|
-
*
|
|
12241
|
+
* @defaultValue false
|
|
12536
12242
|
*
|
|
12537
|
-
*
|
|
12243
|
+
* Disables prompting the user for print settings.
|
|
12538
12244
|
*/
|
|
12539
12245
|
silent?: boolean;
|
|
12540
12246
|
/**
|
|
12541
|
-
*
|
|
12247
|
+
* @defaultValue false
|
|
12542
12248
|
*
|
|
12543
|
-
*
|
|
12249
|
+
* Includes the webpage background color and image when printing.
|
|
12544
12250
|
*/
|
|
12545
12251
|
printBackground?: boolean;
|
|
12546
12252
|
/**
|
|
@@ -12548,9 +12254,9 @@ declare type PrintOptions = {
|
|
|
12548
12254
|
*/
|
|
12549
12255
|
deviceName?: string;
|
|
12550
12256
|
/**
|
|
12551
|
-
*
|
|
12257
|
+
* @defaultValue true
|
|
12552
12258
|
*
|
|
12553
|
-
*
|
|
12259
|
+
* Prints in full color (greyscale otherwise).
|
|
12554
12260
|
*/
|
|
12555
12261
|
color?: boolean;
|
|
12556
12262
|
/**
|
|
@@ -12558,9 +12264,9 @@ declare type PrintOptions = {
|
|
|
12558
12264
|
*/
|
|
12559
12265
|
margins?: Margins;
|
|
12560
12266
|
/**
|
|
12561
|
-
*
|
|
12267
|
+
* @defaultValue true
|
|
12562
12268
|
*
|
|
12563
|
-
*
|
|
12269
|
+
* Prints in landscape mode (portrait otherwise).
|
|
12564
12270
|
*/
|
|
12565
12271
|
landscape?: boolean;
|
|
12566
12272
|
/**
|
|
@@ -12807,9 +12513,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12807
12513
|
'set-tray-icon': ApplicationIdentityCall<{
|
|
12808
12514
|
enabledIcon: string;
|
|
12809
12515
|
}, void>;
|
|
12810
|
-
'set-tray-icon-tooltip': ApplicationIdentityCall<{
|
|
12811
|
-
toolTip: string;
|
|
12812
|
-
}>;
|
|
12813
12516
|
'set-shortcuts': ApplicationIdentityCall<{
|
|
12814
12517
|
data: OpenFin.ShortCutConfig;
|
|
12815
12518
|
}, void>;
|
|
@@ -12947,9 +12650,7 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12947
12650
|
options: OpenFin.TransitionOptions;
|
|
12948
12651
|
}>;
|
|
12949
12652
|
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12950
|
-
'get-window-bounds': IdentityCall<{
|
|
12951
|
-
options?: OpenFin.GetBoundsOptions;
|
|
12952
|
-
}, OpenFin.WindowBounds>;
|
|
12653
|
+
'get-window-bounds': IdentityCall<{}, OpenFin.WindowBounds>;
|
|
12953
12654
|
'center-window': IdentityCall;
|
|
12954
12655
|
'blur-window': IdentityCall;
|
|
12955
12656
|
'bring-window-to-front': IdentityCall;
|
|
@@ -13285,9 +12986,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13285
12986
|
options: OpenFin.ProcessLoggingOptions;
|
|
13286
12987
|
}, void>;
|
|
13287
12988
|
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
13288
|
-
'serve-asset': ApiCall<{
|
|
13289
|
-
options: OpenFin.ServeAssetOptions;
|
|
13290
|
-
}, OpenFin.ServedAssetInfo>;
|
|
13291
12989
|
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
13292
12990
|
domainSettings: OpenFin.DefaultDomainSettings;
|
|
13293
12991
|
}, void>;
|
|
@@ -13453,10 +13151,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13453
13151
|
};
|
|
13454
13152
|
response: OpenFin.PopupResult;
|
|
13455
13153
|
};
|
|
13456
|
-
'get-screen-capture-permissions': {
|
|
13457
|
-
request: OpenFin.Identity;
|
|
13458
|
-
response: OpenFin.ScreenCapturePermission;
|
|
13459
|
-
};
|
|
13460
13154
|
'render-overlay': {
|
|
13461
13155
|
request: {
|
|
13462
13156
|
bounds: OpenFin.Bounds;
|
|
@@ -13731,15 +13425,15 @@ declare type ReplaceViewPayload = {
|
|
|
13731
13425
|
*/
|
|
13732
13426
|
declare type ResizeRegion = {
|
|
13733
13427
|
/**
|
|
13734
|
-
*
|
|
13428
|
+
* @defaultValue 7
|
|
13735
13429
|
*
|
|
13736
|
-
*
|
|
13430
|
+
* The size of the resize region in pixels.
|
|
13737
13431
|
*/
|
|
13738
13432
|
size?: number;
|
|
13739
13433
|
/**
|
|
13740
|
-
*
|
|
13434
|
+
* @defaultValue 9
|
|
13741
13435
|
*
|
|
13742
|
-
*
|
|
13436
|
+
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
|
13743
13437
|
*/
|
|
13744
13438
|
bottomRightCorner?: number;
|
|
13745
13439
|
/**
|
|
@@ -13747,27 +13441,27 @@ declare type ResizeRegion = {
|
|
|
13747
13441
|
*/
|
|
13748
13442
|
sides?: {
|
|
13749
13443
|
/**
|
|
13750
|
-
*
|
|
13444
|
+
* @defaultValue true
|
|
13751
13445
|
*
|
|
13752
|
-
*
|
|
13446
|
+
* Enables resizing from the top of the window.
|
|
13753
13447
|
*/
|
|
13754
13448
|
top?: boolean;
|
|
13755
13449
|
/**
|
|
13756
|
-
*
|
|
13450
|
+
* @defaultValue true
|
|
13757
13451
|
*
|
|
13758
|
-
*
|
|
13452
|
+
* Enables resizing from the bottom of the window.
|
|
13759
13453
|
*/
|
|
13760
13454
|
bottom?: boolean;
|
|
13761
13455
|
/**
|
|
13762
|
-
*
|
|
13456
|
+
* @defaultValue true
|
|
13763
13457
|
*
|
|
13764
|
-
*
|
|
13458
|
+
* Enables resizing from the left side of the window.
|
|
13765
13459
|
*/
|
|
13766
13460
|
left?: boolean;
|
|
13767
13461
|
/**
|
|
13768
|
-
*
|
|
13462
|
+
* @defaultValue true
|
|
13769
13463
|
*
|
|
13770
|
-
*
|
|
13464
|
+
* Enables resizing from the right side of the window.
|
|
13771
13465
|
*/
|
|
13772
13466
|
right?: boolean;
|
|
13773
13467
|
};
|
|
@@ -13949,20 +13643,12 @@ declare type RVMInfo = {
|
|
|
13949
13643
|
* The app log directory.
|
|
13950
13644
|
*/
|
|
13951
13645
|
'appLogDirectory': string;
|
|
13952
|
-
/**
|
|
13953
|
-
* Architecture of the OS that the RVM is running on. One of `arm64`, `x86`, `x64`. Available since RVM 16.
|
|
13954
|
-
*/
|
|
13955
|
-
'osArch': string;
|
|
13956
13646
|
/**
|
|
13957
13647
|
* The path of OpenfinRVM.exe.
|
|
13958
13648
|
*/
|
|
13959
13649
|
'path': string;
|
|
13960
13650
|
/**
|
|
13961
|
-
*
|
|
13962
|
-
*/
|
|
13963
|
-
'rvmArch': string;
|
|
13964
|
-
/**
|
|
13965
|
-
* The start time of RVM. Format is `YYYY-MM-DD HH:MM:SS` in local time or `NA` on error.
|
|
13651
|
+
* The start time of RVM.
|
|
13966
13652
|
*/
|
|
13967
13653
|
'start-time': string;
|
|
13968
13654
|
/**
|
|
@@ -13994,30 +13680,6 @@ declare type RvmLaunchOptions = {
|
|
|
13994
13680
|
subscribe?: (launch: LaunchEmitter) => void;
|
|
13995
13681
|
};
|
|
13996
13682
|
|
|
13997
|
-
/**
|
|
13998
|
-
* Controls whether this content should be allowed or blocked when capturing the screen.
|
|
13999
|
-
*/
|
|
14000
|
-
declare type ScreenCaptureBehavior = 'allow' | 'block';
|
|
14001
|
-
|
|
14002
|
-
/**
|
|
14003
|
-
* Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
|
|
14004
|
-
* @interface
|
|
14005
|
-
*/
|
|
14006
|
-
declare type ScreenCapturePermission = {
|
|
14007
|
-
permission: ScreenCaptureBehavior;
|
|
14008
|
-
permissions: ScreenCaptureState[];
|
|
14009
|
-
};
|
|
14010
|
-
|
|
14011
|
-
/**
|
|
14012
|
-
* screenCapture state for a given entity as defined in domain settings.
|
|
14013
|
-
* @interface
|
|
14014
|
-
*/
|
|
14015
|
-
declare type ScreenCaptureState = {
|
|
14016
|
-
info: EntityInfo;
|
|
14017
|
-
behavior: ScreenCaptureBehavior;
|
|
14018
|
-
url: string;
|
|
14019
|
-
};
|
|
14020
|
-
|
|
14021
13683
|
/**
|
|
14022
13684
|
* @interface
|
|
14023
13685
|
*/
|
|
@@ -14056,16 +13718,6 @@ declare type SentMessage<Value> = Promise<Value> & {
|
|
|
14056
13718
|
messageId: ReturnType<Environment['getNextMessageId']>;
|
|
14057
13719
|
};
|
|
14058
13720
|
|
|
14059
|
-
declare type ServeAssetOptions = AppAssetServeRequest | PathServeRequest;
|
|
14060
|
-
|
|
14061
|
-
declare type ServedAssetInfo = {
|
|
14062
|
-
baseUrl: string;
|
|
14063
|
-
};
|
|
14064
|
-
|
|
14065
|
-
declare type ServeRequest = {
|
|
14066
|
-
hostName: string;
|
|
14067
|
-
};
|
|
14068
|
-
|
|
14069
13721
|
/**
|
|
14070
13722
|
* @interface
|
|
14071
13723
|
*/
|
|
@@ -14311,9 +13963,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
|
|
|
14311
13963
|
*/
|
|
14312
13964
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
14313
13965
|
/**
|
|
14314
|
-
*
|
|
13966
|
+
* @defaultValue 0
|
|
14315
13967
|
*
|
|
14316
|
-
*
|
|
13968
|
+
* Number of milliseconds to wait between view repaints.
|
|
14317
13969
|
*/
|
|
14318
13970
|
paintIntervalMs?: number;
|
|
14319
13971
|
};
|
|
@@ -14363,7 +14015,6 @@ declare type Snapshot = {
|
|
|
14363
14015
|
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
|
14364
14016
|
topic: 'application';
|
|
14365
14017
|
type: 'platform-snapshot-applied';
|
|
14366
|
-
snapshot: Snapshot;
|
|
14367
14018
|
};
|
|
14368
14019
|
|
|
14369
14020
|
/**
|
|
@@ -14488,32 +14139,6 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
|
14488
14139
|
type: 'started';
|
|
14489
14140
|
};
|
|
14490
14141
|
|
|
14491
|
-
/**
|
|
14492
|
-
* Behavior when displaying content from matched URLs.
|
|
14493
|
-
*/
|
|
14494
|
-
declare type StructuredContentBehavior = {
|
|
14495
|
-
behavior: BaseContentBehavior;
|
|
14496
|
-
} | BrowserContentBehavior;
|
|
14497
|
-
|
|
14498
|
-
/**
|
|
14499
|
-
* Behavior when displaying content from matched URLs. Varies depending on type of navigation.
|
|
14500
|
-
* @interface
|
|
14501
|
-
*/
|
|
14502
|
-
declare type StructuredContentPermissions = {
|
|
14503
|
-
/**
|
|
14504
|
-
* Controls the behavior for navigations
|
|
14505
|
-
*/
|
|
14506
|
-
navigate?: ContentBehavior | StructuredContentBehavior;
|
|
14507
|
-
/**
|
|
14508
|
-
* Controls the behavior for redirects
|
|
14509
|
-
*/
|
|
14510
|
-
redirect?: ContentBehavior | StructuredContentBehavior;
|
|
14511
|
-
/**
|
|
14512
|
-
* Controls the behavior for when iframes try to redirect
|
|
14513
|
-
*/
|
|
14514
|
-
iframe?: BaseContentBehavior;
|
|
14515
|
-
};
|
|
14516
|
-
|
|
14517
14142
|
/**
|
|
14518
14143
|
* @interface
|
|
14519
14144
|
*/
|
|
@@ -15997,11 +15622,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15997
15622
|
* Gets the currently-installed
|
|
15998
15623
|
*/
|
|
15999
15624
|
getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
|
|
16000
|
-
/**
|
|
16001
|
-
* Used to serve an asset signed by OpenFin within the given runtime.
|
|
16002
|
-
* Not indended for general use, will be used by the `@openfin/workspace-platform` package.
|
|
16003
|
-
*/
|
|
16004
|
-
serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
|
|
16005
15625
|
}
|
|
16006
15626
|
|
|
16007
15627
|
/**
|
|
@@ -16364,9 +15984,9 @@ declare type TransitionBase = {
|
|
|
16364
15984
|
*/
|
|
16365
15985
|
duration: number;
|
|
16366
15986
|
/**
|
|
16367
|
-
*
|
|
15987
|
+
* @defaultValue false
|
|
16368
15988
|
*
|
|
16369
|
-
*
|
|
15989
|
+
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16370
15990
|
*/
|
|
16371
15991
|
relative?: boolean;
|
|
16372
15992
|
};
|
|
@@ -16382,9 +16002,9 @@ declare type TransitionOptions = {
|
|
|
16382
16002
|
*/
|
|
16383
16003
|
interrupt: boolean;
|
|
16384
16004
|
/**
|
|
16385
|
-
*
|
|
16005
|
+
* @defaultValue false
|
|
16386
16006
|
*
|
|
16387
|
-
*
|
|
16007
|
+
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16388
16008
|
*/
|
|
16389
16009
|
relative?: boolean;
|
|
16390
16010
|
tween?: tween;
|
|
@@ -17449,9 +17069,9 @@ declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
|
|
|
17449
17069
|
*/
|
|
17450
17070
|
declare type ViewVisibilityOption = {
|
|
17451
17071
|
/**
|
|
17452
|
-
*
|
|
17072
|
+
* @defaultValue false
|
|
17453
17073
|
*
|
|
17454
|
-
*
|
|
17074
|
+
* Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
|
|
17455
17075
|
*/
|
|
17456
17076
|
enabled?: boolean;
|
|
17457
17077
|
};
|
|
@@ -18075,7 +17695,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18075
17695
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
18076
17696
|
* });
|
|
18077
17697
|
*
|
|
18078
|
-
* await view.navigate('
|
|
17698
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
18079
17699
|
*
|
|
18080
17700
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
18081
17701
|
* ```
|
|
@@ -18086,7 +17706,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18086
17706
|
* name:'child',
|
|
18087
17707
|
* defaultWidth: 300,
|
|
18088
17708
|
* defaultHeight: 300,
|
|
18089
|
-
* url: '
|
|
17709
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
18090
17710
|
* frame: true,
|
|
18091
17711
|
* autoShow: true
|
|
18092
17712
|
* };
|
|
@@ -18111,7 +17731,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18111
17731
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
18112
17732
|
* });
|
|
18113
17733
|
*
|
|
18114
|
-
* await view.navigate('
|
|
17734
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
18115
17735
|
*
|
|
18116
17736
|
* await view.inspectSharedWorker();
|
|
18117
17737
|
* ```
|
|
@@ -18122,7 +17742,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18122
17742
|
* name:'child',
|
|
18123
17743
|
* defaultWidth: 300,
|
|
18124
17744
|
* defaultHeight: 300,
|
|
18125
|
-
* url: '
|
|
17745
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
18126
17746
|
* frame: true,
|
|
18127
17747
|
* autoShow: true
|
|
18128
17748
|
* };
|
|
@@ -18148,7 +17768,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18148
17768
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
18149
17769
|
* });
|
|
18150
17770
|
*
|
|
18151
|
-
* await view.navigate('
|
|
17771
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
18152
17772
|
*
|
|
18153
17773
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
18154
17774
|
* await view.inspectSharedWorkerById(sharedWorkers[0].id);
|
|
@@ -18160,7 +17780,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18160
17780
|
* name:'child',
|
|
18161
17781
|
* defaultWidth: 300,
|
|
18162
17782
|
* defaultHeight: 300,
|
|
18163
|
-
* url: '
|
|
17783
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
18164
17784
|
* frame: true,
|
|
18165
17785
|
* autoShow: true
|
|
18166
17786
|
* };
|
|
@@ -18422,19 +18042,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18422
18042
|
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
18423
18043
|
*/
|
|
18424
18044
|
showPopupWindow(options: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
|
|
18425
|
-
/**
|
|
18426
|
-
*
|
|
18427
|
-
* Get the screen capture permission for this content.
|
|
18428
|
-
*
|
|
18429
|
-
* @example
|
|
18430
|
-
* ```js
|
|
18431
|
-
* const { permission } = await fin.me.getScreenCapturePermission();
|
|
18432
|
-
*
|
|
18433
|
-
* console.log(`This content is currently ${permission}ed in screen captures.`);
|
|
18434
|
-
*
|
|
18435
|
-
* ```
|
|
18436
|
-
*/
|
|
18437
|
-
getScreenCapturePermission(): Promise<OpenFin.ScreenCapturePermission>;
|
|
18438
18045
|
}
|
|
18439
18046
|
|
|
18440
18047
|
/**
|
|
@@ -18473,8 +18080,6 @@ declare namespace WebContentsEvents {
|
|
|
18473
18080
|
FileDownloadProgressEvent,
|
|
18474
18081
|
FileDownloadCompletedEvent,
|
|
18475
18082
|
ContentBlockedEvent,
|
|
18476
|
-
ClipboardCopyBlockedEvent,
|
|
18477
|
-
ClipboardPasteBlockedEvent,
|
|
18478
18083
|
Event_5 as Event,
|
|
18479
18084
|
WebContentsEvent,
|
|
18480
18085
|
WillPropagateWebContentsEvent,
|
|
@@ -18647,7 +18252,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
|
18647
18252
|
* getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
|
|
18648
18253
|
* ```
|
|
18649
18254
|
*/
|
|
18650
|
-
getBounds(
|
|
18255
|
+
getBounds(): Promise<OpenFin.WindowBounds>;
|
|
18651
18256
|
/**
|
|
18652
18257
|
* Centers the window on its current screen.
|
|
18653
18258
|
*
|
|
@@ -19614,10 +19219,6 @@ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
|
|
|
19614
19219
|
declare type WindowBounds = Bounds & {
|
|
19615
19220
|
bottom: number;
|
|
19616
19221
|
right: number;
|
|
19617
|
-
/**
|
|
19618
|
-
* The bounds for the window's web content, excluding any OS border
|
|
19619
|
-
*/
|
|
19620
|
-
content: Bounds;
|
|
19621
19222
|
};
|
|
19622
19223
|
|
|
19623
19224
|
/**
|