@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-alpha.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}.
|
|
@@ -594,23 +590,6 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
|
|
|
594
590
|
* ```
|
|
595
591
|
*/
|
|
596
592
|
setTrayIcon(icon: string): Promise<void>;
|
|
597
|
-
/**
|
|
598
|
-
* Set hover text for this application's system tray icon.
|
|
599
|
-
* Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
|
|
600
|
-
* @param toolTip
|
|
601
|
-
*
|
|
602
|
-
* @example
|
|
603
|
-
*
|
|
604
|
-
* ```js
|
|
605
|
-
* const app = fin.Application.getCurrentSync();
|
|
606
|
-
* const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
|
|
607
|
-
*
|
|
608
|
-
* await app.setTrayIcon(iconUrl);
|
|
609
|
-
*
|
|
610
|
-
* await app.setTrayIconToolTip('My Application');
|
|
611
|
-
* ```
|
|
612
|
-
*/
|
|
613
|
-
setTrayIconToolTip(toolTip: string): Promise<void>;
|
|
614
593
|
/**
|
|
615
594
|
* Sets new application's shortcut configuration. Windows only.
|
|
616
595
|
* @param config New application's shortcut configuration.
|
|
@@ -1171,19 +1150,19 @@ declare class ApplicationModule extends Base {
|
|
|
1171
1150
|
*/
|
|
1172
1151
|
declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
1173
1152
|
/**
|
|
1174
|
-
*
|
|
1153
|
+
* @defaultValue false
|
|
1175
1154
|
*
|
|
1176
|
-
*
|
|
1155
|
+
* Disables IAB secure logging for the app.
|
|
1177
1156
|
*/
|
|
1178
1157
|
disableIabSecureLogging: boolean;
|
|
1179
1158
|
/**
|
|
1159
|
+
* @defaultValue 'There was an error loading the application.'
|
|
1160
|
+
*
|
|
1180
1161
|
* An error message to display when the application (launched via manifest) fails to load.
|
|
1181
1162
|
* A dialog box will be launched with the error message just before the runtime exits.
|
|
1182
1163
|
* Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
|
|
1183
1164
|
* will trigger this dialog.
|
|
1184
1165
|
* Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
|
|
1185
|
-
*
|
|
1186
|
-
* @default 'There was an error loading the application.'
|
|
1187
1166
|
*/
|
|
1188
1167
|
loadErrorMessage: string;
|
|
1189
1168
|
/**
|
|
@@ -1202,28 +1181,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1202
1181
|
*/
|
|
1203
1182
|
name: string;
|
|
1204
1183
|
/**
|
|
1184
|
+
* @defaultValue false
|
|
1185
|
+
*
|
|
1205
1186
|
* A flag to configure the application as non-persistent.
|
|
1206
1187
|
* Runtime exits when there are no persistent apps running.
|
|
1207
|
-
*
|
|
1208
|
-
* @default false
|
|
1209
1188
|
*/
|
|
1210
1189
|
nonPersistent: boolean;
|
|
1211
1190
|
/**
|
|
1212
|
-
*
|
|
1191
|
+
* @defaultValue false
|
|
1213
1192
|
*
|
|
1214
|
-
*
|
|
1193
|
+
* Enable Flash at the application level.
|
|
1215
1194
|
*/
|
|
1216
1195
|
plugins: boolean;
|
|
1217
1196
|
/**
|
|
1218
|
-
*
|
|
1197
|
+
* @defaultValue false
|
|
1219
1198
|
*
|
|
1220
|
-
*
|
|
1199
|
+
* Enable spell check at the application level.
|
|
1221
1200
|
*/
|
|
1222
1201
|
spellCheck: boolean;
|
|
1223
1202
|
/**
|
|
1224
|
-
*
|
|
1203
|
+
* @defaultValue 'about:blank'
|
|
1225
1204
|
*
|
|
1226
|
-
*
|
|
1205
|
+
* The url to the application (specifically the application's main window).
|
|
1227
1206
|
*/
|
|
1228
1207
|
url: string;
|
|
1229
1208
|
/**
|
|
@@ -1232,9 +1211,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1232
1211
|
*/
|
|
1233
1212
|
uuid: string;
|
|
1234
1213
|
/**
|
|
1235
|
-
*
|
|
1214
|
+
* @defaultValue true
|
|
1236
1215
|
*
|
|
1237
|
-
*
|
|
1216
|
+
* When set to `false` it will disable the same-origin policy for the app.
|
|
1238
1217
|
*/
|
|
1239
1218
|
webSecurity: boolean;
|
|
1240
1219
|
/**
|
|
@@ -1244,10 +1223,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1244
1223
|
commands: ShortcutOverride[];
|
|
1245
1224
|
isPlatformController: boolean;
|
|
1246
1225
|
/**
|
|
1226
|
+
* @defaultValue 1000
|
|
1227
|
+
*
|
|
1247
1228
|
* **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
|
|
1248
1229
|
* If you do not wish for views to be pooled on your platform, set this property to zero.
|
|
1249
|
-
*
|
|
1250
|
-
* @default 1000
|
|
1251
1230
|
*/
|
|
1252
1231
|
maxViewPoolSize: number;
|
|
1253
1232
|
/**
|
|
@@ -1263,12 +1242,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1263
1242
|
*/
|
|
1264
1243
|
snapshot: Snapshot;
|
|
1265
1244
|
/**
|
|
1245
|
+
* @defaultValue false
|
|
1246
|
+
*
|
|
1266
1247
|
* **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
|
|
1267
1248
|
*
|
|
1268
1249
|
* Note: if the Platform Provider is showing, it won't close automatically.
|
|
1269
1250
|
* If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
|
|
1270
|
-
*
|
|
1271
|
-
* @default false
|
|
1272
1251
|
*/
|
|
1273
1252
|
preventQuitOnLastWindowClosed: boolean;
|
|
1274
1253
|
/**
|
|
@@ -1276,9 +1255,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1276
1255
|
*/
|
|
1277
1256
|
interopBrokerConfiguration: InteropBrokerOptions;
|
|
1278
1257
|
/**
|
|
1279
|
-
*
|
|
1258
|
+
* @defaultValue true
|
|
1280
1259
|
*
|
|
1281
|
-
*
|
|
1260
|
+
* When set to `false` it will disable OpenFin Diagnostics for the app.
|
|
1282
1261
|
*/
|
|
1283
1262
|
apiDiagnostics: boolean;
|
|
1284
1263
|
/**
|
|
@@ -1294,16 +1273,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1294
1273
|
*/
|
|
1295
1274
|
permissions?: Partial<Permissions_2>;
|
|
1296
1275
|
/**
|
|
1276
|
+
* @defaultValue false
|
|
1277
|
+
*
|
|
1297
1278
|
* Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
|
|
1298
1279
|
* Only relevant in Windows.
|
|
1299
|
-
*
|
|
1300
|
-
* @default false
|
|
1301
1280
|
*/
|
|
1302
1281
|
enableJumpList: boolean;
|
|
1303
1282
|
/**
|
|
1304
|
-
*
|
|
1283
|
+
* @defaultValue false
|
|
1305
1284
|
*
|
|
1306
|
-
*
|
|
1285
|
+
* When set to `true`, any `beforeunload` handler set on the app will fire.
|
|
1307
1286
|
*/
|
|
1308
1287
|
enableBeforeUnload: boolean;
|
|
1309
1288
|
/**
|
|
@@ -1384,25 +1363,25 @@ declare type ApplicationWindowInfo = {
|
|
|
1384
1363
|
*/
|
|
1385
1364
|
declare type ApplySnapshotOptions = {
|
|
1386
1365
|
/**
|
|
1366
|
+
* @defaultValue false
|
|
1367
|
+
*
|
|
1387
1368
|
* When true, applySnapshot will close existing windows,
|
|
1388
1369
|
* replacing current Platform state with the given snapshot.
|
|
1389
|
-
*
|
|
1390
|
-
* @default false
|
|
1391
1370
|
*/
|
|
1392
1371
|
closeExistingWindows?: boolean;
|
|
1393
1372
|
/**
|
|
1373
|
+
* @defaultValue false
|
|
1374
|
+
*
|
|
1394
1375
|
* When true, applySnapshot will close existing includeInSnapshots: true windows,
|
|
1395
1376
|
* replacing current Platform state with the given snapshot.
|
|
1396
|
-
*
|
|
1397
|
-
* @default false
|
|
1398
1377
|
*/
|
|
1399
1378
|
closeSnapshotWindows?: boolean;
|
|
1400
1379
|
/**
|
|
1380
|
+
* @defaultValue false
|
|
1381
|
+
*
|
|
1401
1382
|
* When true, applySnapshot will not check whether any windows in a
|
|
1402
1383
|
* snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
|
|
1403
1384
|
* as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
|
|
1404
|
-
*
|
|
1405
|
-
* @default false
|
|
1406
1385
|
*/
|
|
1407
1386
|
skipOutOfBoundsCheck?: boolean;
|
|
1408
1387
|
};
|
|
@@ -1682,8 +1661,6 @@ declare type BaseConfig = {
|
|
|
1682
1661
|
timeout?: number;
|
|
1683
1662
|
};
|
|
1684
1663
|
|
|
1685
|
-
declare type BaseContentBehavior = 'allow' | 'block';
|
|
1686
|
-
|
|
1687
1664
|
/**
|
|
1688
1665
|
* Properties shared by all content creation rules, regardless of context.
|
|
1689
1666
|
*
|
|
@@ -1925,35 +1902,7 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
|
1925
1902
|
reason: 'self' | 'animation';
|
|
1926
1903
|
};
|
|
1927
1904
|
|
|
1928
|
-
declare type BoundsEvent = BaseEvent_5 & OpenFin.
|
|
1929
|
-
|
|
1930
|
-
declare type BoundsType =
|
|
1931
|
-
/**
|
|
1932
|
-
* Bounds specify the size and location of the entire window, including OS border styling.
|
|
1933
|
-
*/
|
|
1934
|
-
'window'
|
|
1935
|
-
/**
|
|
1936
|
-
* Bounds specify the size and location of the window's DOM content, excluding OS border styling.
|
|
1937
|
-
*/
|
|
1938
|
-
| 'content'
|
|
1939
|
-
/**
|
|
1940
|
-
* Origin parameters (top, left) specify the location of the window origin, including OS border styling.
|
|
1941
|
-
* Size parameters bounds (width, height) specify the size of the window's DOM content, excluding OS border styling.
|
|
1942
|
-
*/
|
|
1943
|
-
| 'window-origin-content-size';
|
|
1944
|
-
|
|
1945
|
-
/**
|
|
1946
|
-
* Opens matched URLs in the browser.
|
|
1947
|
-
*
|
|
1948
|
-
* @interface
|
|
1949
|
-
*/
|
|
1950
|
-
declare type BrowserContentBehavior = {
|
|
1951
|
-
behavior: 'browser';
|
|
1952
|
-
/**
|
|
1953
|
-
* When true, closes the window or view that initiated the navigation.
|
|
1954
|
-
*/
|
|
1955
|
-
closeExisting?: boolean;
|
|
1956
|
-
};
|
|
1905
|
+
declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
|
|
1957
1906
|
|
|
1958
1907
|
/**
|
|
1959
1908
|
* A rule prescribing content creation in the browser.
|
|
@@ -2059,15 +2008,15 @@ declare type CapturePageOptions = {
|
|
|
2059
2008
|
*/
|
|
2060
2009
|
area?: Rectangle;
|
|
2061
2010
|
/**
|
|
2062
|
-
*
|
|
2011
|
+
* @defaultValue 'png'
|
|
2063
2012
|
*
|
|
2064
|
-
*
|
|
2013
|
+
* The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
|
2065
2014
|
*/
|
|
2066
2015
|
format?: 'bmp' | 'jpg' | 'png';
|
|
2067
2016
|
/**
|
|
2068
|
-
*
|
|
2017
|
+
* @defaultValue 100
|
|
2069
2018
|
*
|
|
2070
|
-
*
|
|
2019
|
+
* Quality of JPEG image. Between 0 - 100.
|
|
2071
2020
|
*/
|
|
2072
2021
|
quality?: number;
|
|
2073
2022
|
};
|
|
@@ -2700,9 +2649,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
|
|
|
2700
2649
|
*/
|
|
2701
2650
|
declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2702
2651
|
/**
|
|
2703
|
-
*
|
|
2652
|
+
* @defaultValue true
|
|
2704
2653
|
*
|
|
2705
|
-
*
|
|
2654
|
+
* If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
|
|
2706
2655
|
*/
|
|
2707
2656
|
wait?: boolean;
|
|
2708
2657
|
/**
|
|
@@ -2996,10 +2945,6 @@ declare type ChromiumPolicies = {
|
|
|
2996
2945
|
* Disable AutofillAddressEnabled policy for a Window or View.
|
|
2997
2946
|
*/
|
|
2998
2947
|
AutofillAddressEnabled?: PolicyOptions;
|
|
2999
|
-
/**
|
|
3000
|
-
* Disable AutofillCreditCardEnabled policy for a Window or View.
|
|
3001
|
-
*/
|
|
3002
|
-
AutofillCreditCardEnabled?: PolicyOptions;
|
|
3003
2948
|
};
|
|
3004
2949
|
|
|
3005
2950
|
declare interface ClassicProtocolOffer extends ProtocolPacketBase {
|
|
@@ -3085,7 +3030,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
|
3085
3030
|
*
|
|
3086
3031
|
*/
|
|
3087
3032
|
declare class Clipboard_2 extends Base {
|
|
3088
|
-
#private;
|
|
3089
3033
|
/**
|
|
3090
3034
|
* Writes data into the clipboard as plain text
|
|
3091
3035
|
* @param writeObj The object for writing data into the clipboard
|
|
@@ -3238,56 +3182,6 @@ declare class Clipboard_2 extends Base {
|
|
|
3238
3182
|
getAvailableFormats(type?: OpenFin.ClipboardSelectionType): Promise<Array<string>>;
|
|
3239
3183
|
}
|
|
3240
3184
|
|
|
3241
|
-
/**
|
|
3242
|
-
* Permissions for {@link Clipboard} APIs.
|
|
3243
|
-
*/
|
|
3244
|
-
declare type ClipboardApiPermissions = {
|
|
3245
|
-
writeText: boolean;
|
|
3246
|
-
readText: boolean;
|
|
3247
|
-
writeImage: boolean;
|
|
3248
|
-
readImage: boolean;
|
|
3249
|
-
writeHtml: boolean;
|
|
3250
|
-
readHtml: boolean;
|
|
3251
|
-
writeRtf: boolean;
|
|
3252
|
-
readRtf: boolean;
|
|
3253
|
-
write: boolean;
|
|
3254
|
-
};
|
|
3255
|
-
|
|
3256
|
-
/**
|
|
3257
|
-
* Generated when a copy operation is blocked through {@link OpenFin.DomainSettings}.
|
|
3258
|
-
* @interface
|
|
3259
|
-
*/
|
|
3260
|
-
declare type ClipboardCopyBlockedEvent = NamedEvent & {
|
|
3261
|
-
type: 'clipboard-copy-blocked';
|
|
3262
|
-
/**
|
|
3263
|
-
* URL of the Window or View that generated the event.
|
|
3264
|
-
*/
|
|
3265
|
-
url: string;
|
|
3266
|
-
reason: CopyBlockedEventReason;
|
|
3267
|
-
};
|
|
3268
|
-
|
|
3269
|
-
/**
|
|
3270
|
-
* Generated when a paste operation is blocked through {@link OpenFin.DomainSettings}.
|
|
3271
|
-
* @interface
|
|
3272
|
-
*/
|
|
3273
|
-
declare type ClipboardPasteBlockedEvent = NamedEvent & {
|
|
3274
|
-
type: 'clipboard-paste-blocked';
|
|
3275
|
-
/**
|
|
3276
|
-
* URL of the Window or View that generated the event.
|
|
3277
|
-
*/
|
|
3278
|
-
url: string;
|
|
3279
|
-
reason: PasteBlockedEventReason;
|
|
3280
|
-
};
|
|
3281
|
-
|
|
3282
|
-
/**
|
|
3283
|
-
* Clipboard Permissions
|
|
3284
|
-
* @interface
|
|
3285
|
-
*/
|
|
3286
|
-
declare type ClipboardPermissions = {
|
|
3287
|
-
copy?: CopyPermissions;
|
|
3288
|
-
paste?: PastePermissions;
|
|
3289
|
-
};
|
|
3290
|
-
|
|
3291
3185
|
/**
|
|
3292
3186
|
* The type of clipboard to write to, can be 'clipboard' or 'selection'.
|
|
3293
3187
|
* Defaults to 'clipboard'. Use 'selection' for linux only.
|
|
@@ -3365,9 +3259,9 @@ declare interface CloseWindowPayload {
|
|
|
3365
3259
|
windowId: Identity_4;
|
|
3366
3260
|
options: {
|
|
3367
3261
|
/**
|
|
3368
|
-
*
|
|
3262
|
+
* @defaultValue false
|
|
3369
3263
|
*
|
|
3370
|
-
*
|
|
3264
|
+
* When set to true skips any before handler set on views that are part of the window
|
|
3371
3265
|
*/
|
|
3372
3266
|
skipBeforeUnload?: boolean;
|
|
3373
3267
|
};
|
|
@@ -3472,22 +3366,15 @@ declare type ConstViewOptions = {
|
|
|
3472
3366
|
*/
|
|
3473
3367
|
name: string;
|
|
3474
3368
|
/**
|
|
3475
|
-
*
|
|
3369
|
+
* @defaultValue "about:blank"
|
|
3476
3370
|
*
|
|
3477
|
-
*
|
|
3371
|
+
* The URL of the window
|
|
3478
3372
|
*/
|
|
3479
3373
|
url: string;
|
|
3480
3374
|
/**
|
|
3481
3375
|
* The identity of the window this view should be attached to.
|
|
3482
3376
|
*/
|
|
3483
3377
|
target: Identity_4;
|
|
3484
|
-
/**
|
|
3485
|
-
* Defaults to `name`.
|
|
3486
|
-
* Ignored in container, but used in @openfin/core-web to set tab titles.
|
|
3487
|
-
* Order of precedence for title in container is: document.title, viewOptions.url.
|
|
3488
|
-
* Order of precedence for title in @openfin/core-web is ComponentConfig.title, viewOptions.title, viewOptions.url.
|
|
3489
|
-
*/
|
|
3490
|
-
title: string;
|
|
3491
3378
|
/**
|
|
3492
3379
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3493
3380
|
*/
|
|
@@ -3532,9 +3419,9 @@ declare type ConstViewOptions = {
|
|
|
3532
3419
|
experimental: any;
|
|
3533
3420
|
fdc3InteropApi?: string;
|
|
3534
3421
|
/**
|
|
3535
|
-
*
|
|
3422
|
+
* @defaultValue false
|
|
3536
3423
|
*
|
|
3537
|
-
*
|
|
3424
|
+
* When set to `true`, any `beforeunload` handler set on Views will fire.
|
|
3538
3425
|
*/
|
|
3539
3426
|
enableBeforeUnload: boolean;
|
|
3540
3427
|
/**
|
|
@@ -3615,12 +3502,13 @@ declare type ConstWindowOptions = {
|
|
|
3615
3502
|
*/
|
|
3616
3503
|
backgroundColor: string;
|
|
3617
3504
|
/**
|
|
3505
|
+
* @defaultValue false
|
|
3506
|
+
*
|
|
3618
3507
|
* Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
|
|
3619
3508
|
* This also affects the Page Visibility API.
|
|
3620
3509
|
*
|
|
3621
3510
|
* When `true`, the page is throttled whether it is hidden or not.
|
|
3622
3511
|
*
|
|
3623
|
-
* @default false
|
|
3624
3512
|
*/
|
|
3625
3513
|
backgroundThrottling: boolean;
|
|
3626
3514
|
/**
|
|
@@ -3644,21 +3532,21 @@ declare type ConstWindowOptions = {
|
|
|
3644
3532
|
*/
|
|
3645
3533
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3646
3534
|
/**
|
|
3535
|
+
* @defaultValue true
|
|
3536
|
+
*
|
|
3647
3537
|
* Setting this to false would keep the Window alive even if all its Views were closed.
|
|
3648
3538
|
* This is meant for advanced users and should be used with caution.
|
|
3649
3539
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
3650
3540
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
3651
3541
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3652
|
-
*
|
|
3653
|
-
* @default true
|
|
3654
3542
|
*/
|
|
3655
3543
|
closeOnLastViewRemoved: boolean;
|
|
3656
3544
|
/**
|
|
3545
|
+
* @defaultValue 'all'
|
|
3546
|
+
*
|
|
3657
3547
|
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
|
3658
|
-
* Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3548
|
+
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3659
3549
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3660
|
-
*
|
|
3661
|
-
* @default 'all'
|
|
3662
3550
|
*/
|
|
3663
3551
|
viewsPreventingClose: 'all' | 'layout';
|
|
3664
3552
|
/**
|
|
@@ -3669,31 +3557,31 @@ declare type ConstWindowOptions = {
|
|
|
3669
3557
|
*/
|
|
3670
3558
|
defaultCentered: boolean;
|
|
3671
3559
|
/**
|
|
3560
|
+
* @defaultValue 500
|
|
3561
|
+
*
|
|
3672
3562
|
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
|
3673
3563
|
* in favor of the cached value.
|
|
3674
|
-
*
|
|
3675
|
-
* @default 500
|
|
3676
3564
|
*/
|
|
3677
3565
|
defaultHeight: number;
|
|
3678
3566
|
/**
|
|
3567
|
+
* @defaultValue 100
|
|
3568
|
+
*
|
|
3679
3569
|
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3680
3570
|
* launches in favor of the cached value.
|
|
3681
|
-
*
|
|
3682
|
-
* @default 100
|
|
3683
3571
|
*/
|
|
3684
3572
|
defaultLeft: number;
|
|
3685
3573
|
/**
|
|
3574
|
+
* @defaultValue 100
|
|
3575
|
+
*
|
|
3686
3576
|
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3687
3577
|
* launches in favor of the cached value.
|
|
3688
|
-
*
|
|
3689
|
-
* @default 100
|
|
3690
3578
|
*/
|
|
3691
3579
|
defaultTop: number;
|
|
3692
3580
|
/**
|
|
3581
|
+
* @defaultValue 800
|
|
3582
|
+
*
|
|
3693
3583
|
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3694
3584
|
* launches in favor of the cached value.
|
|
3695
|
-
*
|
|
3696
|
-
* @default 800
|
|
3697
3585
|
*/
|
|
3698
3586
|
defaultWidth: number;
|
|
3699
3587
|
/**
|
|
@@ -3739,19 +3627,19 @@ declare type ConstWindowOptions = {
|
|
|
3739
3627
|
*/
|
|
3740
3628
|
processAffinity: string;
|
|
3741
3629
|
/**
|
|
3630
|
+
* @defaultValue false
|
|
3631
|
+
*
|
|
3742
3632
|
* Displays a shadow on frameless windows.
|
|
3743
3633
|
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
3744
3634
|
* On Windows 7, Aero theme is required.
|
|
3745
|
-
*
|
|
3746
|
-
* @default false
|
|
3747
3635
|
*/
|
|
3748
3636
|
shadow: boolean;
|
|
3749
3637
|
/**
|
|
3638
|
+
* @defaultValue true
|
|
3639
|
+
*
|
|
3750
3640
|
* Caches the location of the window.
|
|
3751
3641
|
*
|
|
3752
3642
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3753
|
-
*
|
|
3754
|
-
* @default true
|
|
3755
3643
|
*/
|
|
3756
3644
|
saveWindowState: boolean;
|
|
3757
3645
|
/**
|
|
@@ -3760,22 +3648,22 @@ declare type ConstWindowOptions = {
|
|
|
3760
3648
|
*/
|
|
3761
3649
|
ignoreSavedWindowState: boolean;
|
|
3762
3650
|
/**
|
|
3651
|
+
* @defaultValue false
|
|
3652
|
+
*
|
|
3763
3653
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3764
3654
|
*
|
|
3765
3655
|
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3766
3656
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3767
|
-
*
|
|
3768
|
-
* @default false
|
|
3769
3657
|
*/
|
|
3770
3658
|
smallWindow: boolean;
|
|
3771
3659
|
/**
|
|
3660
|
+
* @defaultValue "normal"
|
|
3661
|
+
*
|
|
3772
3662
|
* The visible state of the window on creation.
|
|
3773
3663
|
* One of:
|
|
3774
3664
|
* * `"maximized"`
|
|
3775
3665
|
* * `"minimized"`
|
|
3776
3666
|
* * `"normal"`
|
|
3777
|
-
*
|
|
3778
|
-
* @default "normal"
|
|
3779
3667
|
*/
|
|
3780
3668
|
state: WindowState;
|
|
3781
3669
|
/**
|
|
@@ -3789,20 +3677,20 @@ declare type ConstWindowOptions = {
|
|
|
3789
3677
|
*/
|
|
3790
3678
|
url: string;
|
|
3791
3679
|
/**
|
|
3680
|
+
* @defaultValue <application UUID>
|
|
3681
|
+
*
|
|
3792
3682
|
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
3793
3683
|
* If omitted, defaults to the `uuid` of the application spawning the window.
|
|
3794
3684
|
* If given, must match the `uuid` of the application spawning the window.
|
|
3795
3685
|
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
3796
3686
|
* really no need to provide it.
|
|
3797
|
-
*
|
|
3798
|
-
* @default <application UUID>
|
|
3799
3687
|
*/
|
|
3800
3688
|
uuid: string;
|
|
3801
3689
|
/**
|
|
3690
|
+
* @defaultValue false
|
|
3691
|
+
*
|
|
3802
3692
|
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
|
3803
3693
|
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
|
3804
|
-
*
|
|
3805
|
-
* @default false
|
|
3806
3694
|
*/
|
|
3807
3695
|
waitForPageLoad: boolean;
|
|
3808
3696
|
width: number;
|
|
@@ -3832,15 +3720,6 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
|
3832
3720
|
type: 'container-created';
|
|
3833
3721
|
};
|
|
3834
3722
|
|
|
3835
|
-
/**
|
|
3836
|
-
* Behavior when displaying content from matched URLs.
|
|
3837
|
-
*
|
|
3838
|
-
* 'allow': The content url is allowed.
|
|
3839
|
-
* 'block': The content url is blocked.
|
|
3840
|
-
* 'browser': The content url is blocked and it is opened in the system's default web browser.
|
|
3841
|
-
*/
|
|
3842
|
-
declare type ContentBehavior = BaseContentBehavior | 'browser';
|
|
3843
|
-
|
|
3844
3723
|
/**
|
|
3845
3724
|
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
|
3846
3725
|
* @interface
|
|
@@ -3928,9 +3807,12 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3928
3807
|
declare type ContentNavigation = NavigationRules;
|
|
3929
3808
|
|
|
3930
3809
|
/**
|
|
3931
|
-
*
|
|
3810
|
+
* Whether a content url is allowed or blocked for navigation or redirection.
|
|
3811
|
+
*
|
|
3812
|
+
* * 'allow': The content url is allowed.
|
|
3813
|
+
* * 'block': The content url is blocked.
|
|
3932
3814
|
*/
|
|
3933
|
-
declare type ContentPermission =
|
|
3815
|
+
declare type ContentPermission = 'allow' | 'block';
|
|
3934
3816
|
|
|
3935
3817
|
/**
|
|
3936
3818
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
@@ -4061,41 +3943,6 @@ declare type CookieOption = {
|
|
|
4061
3943
|
name: string;
|
|
4062
3944
|
};
|
|
4063
3945
|
|
|
4064
|
-
/**
|
|
4065
|
-
* Reasons for a copy operation being blocked
|
|
4066
|
-
*
|
|
4067
|
-
* 'disabled': Copy operation is disabled through domain-based permissions.
|
|
4068
|
-
*/
|
|
4069
|
-
declare type CopyBlockedEventReason = 'disabled';
|
|
4070
|
-
|
|
4071
|
-
/**
|
|
4072
|
-
* Control copy operations for a matched URL.
|
|
4073
|
-
* @interface
|
|
4074
|
-
*/
|
|
4075
|
-
declare type CopyPermissions = {
|
|
4076
|
-
/**
|
|
4077
|
-
* Controls the behavior for copy operations for a matched URL.
|
|
4078
|
-
*
|
|
4079
|
-
* allow: Enables all copy operations.
|
|
4080
|
-
* block: Disables all copy operations.
|
|
4081
|
-
* protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
|
|
4082
|
-
*
|
|
4083
|
-
* @default 'allowed'
|
|
4084
|
-
*/
|
|
4085
|
-
behavior: 'allow' | 'block' | 'protect';
|
|
4086
|
-
/**
|
|
4087
|
-
* Additional copy operation options
|
|
4088
|
-
*/
|
|
4089
|
-
options?: {
|
|
4090
|
-
/**
|
|
4091
|
-
* When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
|
|
4092
|
-
*
|
|
4093
|
-
* @default ''
|
|
4094
|
-
*/
|
|
4095
|
-
replacementText: string;
|
|
4096
|
-
};
|
|
4097
|
-
};
|
|
4098
|
-
|
|
4099
3946
|
/**
|
|
4100
3947
|
* Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
|
|
4101
3948
|
* average of _height_ and _width_.
|
|
@@ -4104,15 +3951,15 @@ declare type CopyPermissions = {
|
|
|
4104
3951
|
*/
|
|
4105
3952
|
declare type CornerRounding = {
|
|
4106
3953
|
/**
|
|
4107
|
-
*
|
|
3954
|
+
* @defaultValue 0
|
|
4108
3955
|
*
|
|
4109
|
-
*
|
|
3956
|
+
* The height in pixels.
|
|
4110
3957
|
*/
|
|
4111
3958
|
height: number;
|
|
4112
3959
|
/**
|
|
4113
|
-
*
|
|
3960
|
+
* @defaultValue 0
|
|
4114
3961
|
*
|
|
4115
|
-
*
|
|
3962
|
+
* The width in pixels.
|
|
4116
3963
|
*/
|
|
4117
3964
|
width: number;
|
|
4118
3965
|
};
|
|
@@ -4202,6 +4049,8 @@ declare type CreateLayoutOptions = {
|
|
|
4202
4049
|
layoutName: string;
|
|
4203
4050
|
layout: LayoutOptions;
|
|
4204
4051
|
/**
|
|
4052
|
+
* @defaultValue 'default'
|
|
4053
|
+
*
|
|
4205
4054
|
* Controls the View behavior for the given `layout` property. Note
|
|
4206
4055
|
* that the selected behavior only applies to unnamed Views or
|
|
4207
4056
|
* Views with the prefix `internal-generated-`. In all cases, if any
|
|
@@ -4223,8 +4072,6 @@ declare type CreateLayoutOptions = {
|
|
|
4223
4072
|
* override. Note that during applyLayoutSnapshot, Views are created and
|
|
4224
4073
|
* attached to the Provider while the Window is being created, so it's
|
|
4225
4074
|
* important to not 'duplicate' Views in this workflow.
|
|
4226
|
-
*
|
|
4227
|
-
* @default 'default'
|
|
4228
4075
|
*/
|
|
4229
4076
|
multiInstanceViewBehavior?: MultiInstanceViewBehavior;
|
|
4230
4077
|
};
|
|
@@ -4323,7 +4170,6 @@ declare type DefaultDomainSettings = DomainSettings;
|
|
|
4323
4170
|
|
|
4324
4171
|
/**
|
|
4325
4172
|
* @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
|
|
4326
|
-
* @interface
|
|
4327
4173
|
*/
|
|
4328
4174
|
declare type DefaultDomainSettingsRule = DomainSettingsRule;
|
|
4329
4175
|
|
|
@@ -4484,7 +4330,7 @@ declare type DomainApiSettings = {
|
|
|
4484
4330
|
* * 'none': The `fin` API will be not available.
|
|
4485
4331
|
* * 'global': The entire `fin` API will be available.
|
|
4486
4332
|
*
|
|
4487
|
-
* @
|
|
4333
|
+
* @defaultValue 'global'
|
|
4488
4334
|
*/
|
|
4489
4335
|
fin?: InjectionType;
|
|
4490
4336
|
/**
|
|
@@ -4500,9 +4346,8 @@ declare type DomainApiSettings = {
|
|
|
4500
4346
|
* @interface
|
|
4501
4347
|
* Defines application settings that vary by the domain of the current context.
|
|
4502
4348
|
*
|
|
4503
|
-
* @remarks
|
|
4504
|
-
*
|
|
4505
|
-
* exists.
|
|
4349
|
+
* @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
|
|
4350
|
+
* domain should be represented with a single rule.
|
|
4506
4351
|
*/
|
|
4507
4352
|
declare type DomainSettings = {
|
|
4508
4353
|
/**
|
|
@@ -4517,22 +4362,19 @@ declare type DomainSettings = {
|
|
|
4517
4362
|
* more information, see the documentation for the individual properties.
|
|
4518
4363
|
*/
|
|
4519
4364
|
default?: PerDomainSettings;
|
|
4520
|
-
/**
|
|
4521
|
-
* {@inheritDoc MultipleDomainMatchBehavior}
|
|
4522
|
-
*/
|
|
4523
|
-
multipleMatchBehavior?: MultipleDomainMatchBehavior;
|
|
4524
4365
|
};
|
|
4525
4366
|
|
|
4526
4367
|
/**
|
|
4527
|
-
* Defines domain-conditional settings for an OpenFin application.
|
|
4528
4368
|
* @interface
|
|
4369
|
+
*
|
|
4370
|
+
* Defines domain-conditional settings for an OpenFin application.
|
|
4529
4371
|
*/
|
|
4530
4372
|
declare type DomainSettingsRule = {
|
|
4531
4373
|
/**
|
|
4532
4374
|
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4533
4375
|
* the domain(s) for which the rule applies.
|
|
4534
4376
|
*/
|
|
4535
|
-
match
|
|
4377
|
+
match?: string[];
|
|
4536
4378
|
/**
|
|
4537
4379
|
* Settings applied when a webcontents has been navigated to a matched domain.
|
|
4538
4380
|
*/
|
|
@@ -4703,15 +4545,6 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4703
4545
|
eventNames: () => (string | symbol)[];
|
|
4704
4546
|
/* Excluded from this release type: emit */
|
|
4705
4547
|
private hasEmitter;
|
|
4706
|
-
/**
|
|
4707
|
-
* Cleans up after removal of a listener, e.g. deleting any lingering deregistration handlers for a
|
|
4708
|
-
* `once` subscription.
|
|
4709
|
-
*
|
|
4710
|
-
* @remarks Implementing this as a `removeListener` handler ensures that direct removal of a listener
|
|
4711
|
-
* on the base emitter will not leak additional core handlers. We could do this in the forwarding method,
|
|
4712
|
-
* which would involve less "magic," but would be more-vulnerable to accidental re-introduction of a leak.
|
|
4713
|
-
*/
|
|
4714
|
-
private cleanUpRemovedListener;
|
|
4715
4548
|
private getOrCreateEmitter;
|
|
4716
4549
|
listeners: (type: string | symbol) => Function[];
|
|
4717
4550
|
listenerCount: (type: string | symbol) => number;
|
|
@@ -4952,7 +4785,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
|
4952
4785
|
*/
|
|
4953
4786
|
declare type Event_5<Topic extends string> = {
|
|
4954
4787
|
topic: Topic;
|
|
4955
|
-
} & (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
|
|
4788
|
+
} & (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);
|
|
4956
4789
|
|
|
4957
4790
|
/**
|
|
4958
4791
|
* [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
|
|
@@ -5062,9 +4895,9 @@ declare type EventType_9 = Event_12['type'];
|
|
|
5062
4895
|
*/
|
|
5063
4896
|
declare type ExcludeOptions = {
|
|
5064
4897
|
/**
|
|
5065
|
-
*
|
|
4898
|
+
* @defaultValue false
|
|
5066
4899
|
*
|
|
5067
|
-
*
|
|
4900
|
+
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
|
5068
4901
|
*/
|
|
5069
4902
|
preloadScripts: boolean;
|
|
5070
4903
|
};
|
|
@@ -5372,10 +5205,6 @@ declare namespace FDC3 {
|
|
|
5372
5205
|
}
|
|
5373
5206
|
}
|
|
5374
5207
|
|
|
5375
|
-
declare type FDC3Factory = typeof fdc3Factory;
|
|
5376
|
-
|
|
5377
|
-
declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin.InteropClient, wire: Transport<'unknown'>) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
|
|
5378
|
-
|
|
5379
5208
|
export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
|
|
5380
5209
|
fdc3Version?: Fdc3Version;
|
|
5381
5210
|
}): Promise<Fdc3Module | Fdc3Module2>;
|
|
@@ -5830,7 +5659,6 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
|
5830
5659
|
* Domain-conditional rules for file downloads.
|
|
5831
5660
|
*
|
|
5832
5661
|
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
|
5833
|
-
* @interface
|
|
5834
5662
|
*/
|
|
5835
5663
|
declare type FileDownloadSettings = {
|
|
5836
5664
|
/**
|
|
@@ -5883,34 +5711,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
5883
5711
|
*/
|
|
5884
5712
|
declare type FindInPageOptions = {
|
|
5885
5713
|
/**
|
|
5886
|
-
*
|
|
5714
|
+
* @defaultValue true
|
|
5887
5715
|
*
|
|
5888
|
-
*
|
|
5716
|
+
* Searches in the forward direction (backward otherwise)
|
|
5889
5717
|
*/
|
|
5890
5718
|
forward?: boolean;
|
|
5891
5719
|
/**
|
|
5892
|
-
*
|
|
5720
|
+
* @defaultValue false
|
|
5893
5721
|
*
|
|
5894
|
-
*
|
|
5722
|
+
* Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
|
|
5895
5723
|
*/
|
|
5896
5724
|
findNext?: boolean;
|
|
5897
5725
|
/**
|
|
5898
|
-
*
|
|
5726
|
+
* @defaultValue false
|
|
5899
5727
|
*
|
|
5900
|
-
*
|
|
5728
|
+
* Enables case-sensitive searching.
|
|
5901
5729
|
*/
|
|
5902
5730
|
matchCase?: boolean;
|
|
5903
5731
|
/**
|
|
5904
|
-
*
|
|
5732
|
+
* @defaultValue false
|
|
5905
5733
|
*
|
|
5906
|
-
*
|
|
5734
|
+
* Only searches from the start of words.
|
|
5907
5735
|
*/
|
|
5908
5736
|
wordStart?: boolean;
|
|
5909
5737
|
/**
|
|
5738
|
+
* @defaultValue false
|
|
5739
|
+
*
|
|
5910
5740
|
* 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>
|
|
5911
5741
|
* lowercase or non-letter. Accepts several other intra-word matches.
|
|
5912
|
-
*
|
|
5913
|
-
* @default false
|
|
5914
5742
|
*/
|
|
5915
5743
|
medialCapitalAsWordStart?: boolean;
|
|
5916
5744
|
};
|
|
@@ -6059,8 +5887,11 @@ declare type FrameEventType = EventType_5;
|
|
|
6059
5887
|
/**
|
|
6060
5888
|
* @interface
|
|
6061
5889
|
*/
|
|
6062
|
-
declare type FrameInfo =
|
|
5890
|
+
declare type FrameInfo = {
|
|
5891
|
+
name: string;
|
|
5892
|
+
uuid: string;
|
|
6063
5893
|
url: string;
|
|
5894
|
+
entityType: EntityType_4;
|
|
6064
5895
|
parent: Identity_4;
|
|
6065
5896
|
};
|
|
6066
5897
|
|
|
@@ -6136,30 +5967,6 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
|
6136
5967
|
entityType: string;
|
|
6137
5968
|
};
|
|
6138
5969
|
|
|
6139
|
-
/**
|
|
6140
|
-
* @interface
|
|
6141
|
-
* Options for the {@link Window._Window.getBounds} method.
|
|
6142
|
-
*/
|
|
6143
|
-
declare interface GetBoundsOptions {
|
|
6144
|
-
/**
|
|
6145
|
-
* Specifies the state of the window for which to retrieve the bounds.
|
|
6146
|
-
*
|
|
6147
|
-
* - `'normal'`: Returns the bounds of the window in its 'normal' state (not maximized or minimized).
|
|
6148
|
-
* - `'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.
|
|
6149
|
-
*
|
|
6150
|
-
* If a window is in `normal` state, `current` and `normal` will return the same bounds.
|
|
6151
|
-
*
|
|
6152
|
-
* 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.
|
|
6153
|
-
*
|
|
6154
|
-
* If a window is `minimized`, both `current` and `normal` will return the bounds of the window prior to it being minimized.
|
|
6155
|
-
*
|
|
6156
|
-
* **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.
|
|
6157
|
-
*
|
|
6158
|
-
* @default 'normal'
|
|
6159
|
-
*/
|
|
6160
|
-
boundsType?: 'normal' | 'current';
|
|
6161
|
-
}
|
|
6162
|
-
|
|
6163
5970
|
/**
|
|
6164
5971
|
* @interface
|
|
6165
5972
|
*/
|
|
@@ -6418,9 +6225,9 @@ declare type Hotkey = {
|
|
|
6418
6225
|
*/
|
|
6419
6226
|
keys: string;
|
|
6420
6227
|
/**
|
|
6421
|
-
*
|
|
6228
|
+
* @defaultValue false
|
|
6422
6229
|
*
|
|
6423
|
-
*
|
|
6230
|
+
* Prevent default key handling before emitting the event.
|
|
6424
6231
|
*/
|
|
6425
6232
|
preventDefault?: boolean;
|
|
6426
6233
|
};
|
|
@@ -7373,7 +7180,7 @@ declare class InteropBroker extends Base {
|
|
|
7373
7180
|
};
|
|
7374
7181
|
private getClientState;
|
|
7375
7182
|
private static toObject;
|
|
7376
|
-
static checkContextIntegrity
|
|
7183
|
+
static checkContextIntegrity(context: OpenFin.Context): {
|
|
7377
7184
|
isValid: true;
|
|
7378
7185
|
} | {
|
|
7379
7186
|
isValid: false;
|
|
@@ -8067,7 +7874,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
8067
7874
|
*
|
|
8068
7875
|
* @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
|
|
8069
7876
|
*
|
|
8070
|
-
* ####
|
|
7877
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
|
|
8071
7878
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
8072
7879
|
* @example
|
|
8073
7880
|
* ```js
|
|
@@ -8084,7 +7891,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
8084
7891
|
* });
|
|
8085
7892
|
* ```
|
|
8086
7893
|
*
|
|
8087
|
-
* ####
|
|
7894
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
|
|
8088
7895
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
8089
7896
|
* @example
|
|
8090
7897
|
* ```js
|
|
@@ -8348,7 +8155,7 @@ declare class Layout extends Base {
|
|
|
8348
8155
|
*/
|
|
8349
8156
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
|
8350
8157
|
/**
|
|
8351
|
-
* Adds a view to the platform layout. Behaves like
|
|
8158
|
+
* Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
|
|
8352
8159
|
*
|
|
8353
8160
|
* @param viewOptions - The options for creating the view.
|
|
8354
8161
|
* @param options - Optional parameters for adding the view.
|
|
@@ -8364,7 +8171,7 @@ declare class Layout extends Base {
|
|
|
8364
8171
|
}>;
|
|
8365
8172
|
/**
|
|
8366
8173
|
* Closes a view by its identity. Throws an error if the view does not belong to the current layout.
|
|
8367
|
-
* Behaves like
|
|
8174
|
+
* Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
|
|
8368
8175
|
*
|
|
8369
8176
|
* @param viewIdentity - The identity of the view to close.
|
|
8370
8177
|
* @returns A promise that resolves when the view is closed.
|
|
@@ -8756,79 +8563,77 @@ declare type LayoutOptions = {
|
|
|
8756
8563
|
*/
|
|
8757
8564
|
settings?: {
|
|
8758
8565
|
/**
|
|
8759
|
-
*
|
|
8566
|
+
* @defaultValue false
|
|
8760
8567
|
*
|
|
8761
|
-
*
|
|
8568
|
+
* When true the splitters will not be draggable and the layout will not resize.
|
|
8762
8569
|
*/
|
|
8763
8570
|
preventSplitterResize?: boolean;
|
|
8764
8571
|
/**
|
|
8572
|
+
* @defaultValue false
|
|
8573
|
+
*
|
|
8765
8574
|
* Whether the popout button will only act on the entire stack,
|
|
8766
8575
|
* as opposed to only the active tab.
|
|
8767
|
-
*
|
|
8768
|
-
* @default false
|
|
8769
8576
|
*/
|
|
8770
8577
|
popoutWholeStack?: boolean;
|
|
8771
8578
|
/**
|
|
8579
|
+
* @defaultValue false
|
|
8580
|
+
*
|
|
8772
8581
|
* Limits the area to which tabs can be dragged.
|
|
8773
8582
|
* If true, the layout container is the only area where tabs can be dropped.
|
|
8774
|
-
*
|
|
8775
|
-
* @default false
|
|
8776
8583
|
*/
|
|
8777
8584
|
constrainDragToContainer?: boolean;
|
|
8778
8585
|
/**
|
|
8586
|
+
* @defaultValue false
|
|
8587
|
+
*
|
|
8779
8588
|
* Whether to show the popout button on stack header.
|
|
8780
8589
|
* The button will create a new window with current tab as its content.
|
|
8781
8590
|
* In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
|
|
8782
|
-
*
|
|
8783
|
-
* @default false
|
|
8784
8591
|
*/
|
|
8785
8592
|
showPopoutIcon?: boolean;
|
|
8786
8593
|
/**
|
|
8594
|
+
* @defaultValue false
|
|
8595
|
+
*
|
|
8787
8596
|
* Whether to show the maximize button on stack header.
|
|
8788
8597
|
* The button will maximize the current tab to fill the entire window.
|
|
8789
|
-
*
|
|
8790
|
-
* @default false
|
|
8791
8598
|
*/
|
|
8792
8599
|
showMaximiseIcon?: boolean;
|
|
8793
8600
|
/**
|
|
8601
|
+
* @defaultValue false
|
|
8602
|
+
*
|
|
8794
8603
|
* Whether to show the close button on stack header
|
|
8795
8604
|
* (not to be confused with close button on every tab).
|
|
8796
|
-
*
|
|
8797
|
-
* @default false
|
|
8798
8605
|
*/
|
|
8799
8606
|
showCloseIcon?: boolean;
|
|
8800
8607
|
/**
|
|
8801
|
-
*
|
|
8608
|
+
* @defaultValue false
|
|
8802
8609
|
*
|
|
8803
|
-
*
|
|
8610
|
+
* Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
|
|
8804
8611
|
*/
|
|
8805
8612
|
constrainDragToHeaders?: boolean;
|
|
8806
8613
|
/**
|
|
8614
|
+
* @defaultValue true
|
|
8615
|
+
*
|
|
8807
8616
|
* Turns tab headers on or off.
|
|
8808
8617
|
* If false, the layout will be displayed with splitters only.
|
|
8809
|
-
*
|
|
8810
|
-
* @default true
|
|
8811
8618
|
*/
|
|
8812
8619
|
hasHeaders?: boolean;
|
|
8813
8620
|
/**
|
|
8621
|
+
* @defaultValue true
|
|
8622
|
+
*
|
|
8814
8623
|
* If true, the user can re-arrange the layout by
|
|
8815
8624
|
* dragging items by their tabs to the desired location.
|
|
8816
|
-
*
|
|
8817
|
-
* @default true
|
|
8818
8625
|
*/
|
|
8819
8626
|
reorderEnabled?: boolean;
|
|
8820
8627
|
/**
|
|
8821
|
-
*
|
|
8628
|
+
* @defaultValue false
|
|
8822
8629
|
*
|
|
8823
|
-
*
|
|
8630
|
+
* If true, tabs can't be dragged out of the window.
|
|
8824
8631
|
*/
|
|
8825
8632
|
preventDragOut?: boolean;
|
|
8826
8633
|
/**
|
|
8827
8634
|
* @defaultValue=false
|
|
8828
8635
|
*
|
|
8829
8636
|
* If true, tabs can't be dragged into the window.
|
|
8830
|
-
*
|
|
8831
|
-
* @default false
|
|
8832
8637
|
*/
|
|
8833
8638
|
preventDragIn?: boolean;
|
|
8834
8639
|
};
|
|
@@ -9250,19 +9055,6 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
|
|
|
9250
9055
|
*/
|
|
9251
9056
|
declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
|
|
9252
9057
|
|
|
9253
|
-
/**
|
|
9254
|
-
* Behavior for handling multiple {@link DomainSettingsRule} matches.
|
|
9255
|
-
*/
|
|
9256
|
-
declare type MultipleDomainMatchBehavior =
|
|
9257
|
-
/**
|
|
9258
|
-
* Apply only the first matching rule in the list.
|
|
9259
|
-
*/
|
|
9260
|
-
'pick-first'
|
|
9261
|
-
/**
|
|
9262
|
-
* Deep-merge all matching rules in the list, prioritizing earlier matches. Treats arrays as primitives.
|
|
9263
|
-
*/
|
|
9264
|
-
| 'deep-merge';
|
|
9265
|
-
|
|
9266
9058
|
/**
|
|
9267
9059
|
* @interface
|
|
9268
9060
|
*/
|
|
@@ -9271,10 +9063,10 @@ declare type MutableViewOptions = {
|
|
|
9271
9063
|
/**
|
|
9272
9064
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9273
9065
|
*
|
|
9066
|
+
* @defaultValue true
|
|
9067
|
+
*
|
|
9274
9068
|
* Show the context menu when right-clicking on the view.
|
|
9275
9069
|
* Gives access to the devtools for the view.
|
|
9276
|
-
*
|
|
9277
|
-
* @default true
|
|
9278
9070
|
*/
|
|
9279
9071
|
contextMenu: boolean;
|
|
9280
9072
|
/**
|
|
@@ -9321,25 +9113,24 @@ declare type MutableViewOptions = {
|
|
|
9321
9113
|
contentNavigation: ContentNavigation;
|
|
9322
9114
|
contentRedirect: ContentRedirect;
|
|
9323
9115
|
/**
|
|
9116
|
+
* @defaultValue false
|
|
9324
9117
|
* @deprecated
|
|
9325
9118
|
* **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
|
|
9326
9119
|
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
|
9327
|
-
*
|
|
9328
|
-
* @default false
|
|
9329
9120
|
*/
|
|
9330
9121
|
detachOnClose: boolean;
|
|
9331
9122
|
/**
|
|
9123
|
+
* @defaultValue true
|
|
9124
|
+
*
|
|
9332
9125
|
* **Platforms Only.** If false, the view will be persistent and can't be closed through
|
|
9333
9126
|
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
|
9334
9127
|
* if the view isn't part of the new layout when running `Layout.replace`.
|
|
9335
|
-
*
|
|
9336
|
-
* @default true
|
|
9337
9128
|
*/
|
|
9338
9129
|
isClosable: boolean;
|
|
9339
9130
|
/**
|
|
9340
|
-
*
|
|
9131
|
+
* @defaultValue false
|
|
9341
9132
|
*
|
|
9342
|
-
*
|
|
9133
|
+
* **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
|
9343
9134
|
*/
|
|
9344
9135
|
preventDragOut: boolean;
|
|
9345
9136
|
interop?: InteropConfig;
|
|
@@ -9347,7 +9138,7 @@ declare type MutableViewOptions = {
|
|
|
9347
9138
|
/**
|
|
9348
9139
|
* {@inheritDoc ViewThrottling}
|
|
9349
9140
|
*
|
|
9350
|
-
* @
|
|
9141
|
+
* @defaultValue 'enabled'
|
|
9351
9142
|
*/
|
|
9352
9143
|
throttling: ViewThrottling;
|
|
9353
9144
|
/**
|
|
@@ -9366,7 +9157,7 @@ declare type MutableWindowOptions = {
|
|
|
9366
9157
|
* Turns anything of matching RGB value transparent.
|
|
9367
9158
|
*
|
|
9368
9159
|
* Caveats:
|
|
9369
|
-
* *
|
|
9160
|
+
* * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
|
|
9370
9161
|
* * User cannot click-through transparent regions
|
|
9371
9162
|
* * Not supported on Mac
|
|
9372
9163
|
* * Windows Aero must be enabled
|
|
@@ -9375,25 +9166,25 @@ declare type MutableWindowOptions = {
|
|
|
9375
9166
|
*/
|
|
9376
9167
|
alphaMask: RGB;
|
|
9377
9168
|
/**
|
|
9378
|
-
*
|
|
9169
|
+
* @defaultValue false
|
|
9379
9170
|
*
|
|
9380
|
-
*
|
|
9171
|
+
* Always position the window at the top of the window stack.
|
|
9381
9172
|
*/
|
|
9382
9173
|
alwaysOnTop: boolean;
|
|
9383
9174
|
/**
|
|
9175
|
+
* @defaultValue 0
|
|
9176
|
+
*
|
|
9384
9177
|
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
|
9385
9178
|
* an aspect ratio will not be enforced.
|
|
9386
|
-
*
|
|
9387
|
-
* @default 0
|
|
9388
9179
|
*/
|
|
9389
9180
|
aspectRatio: number;
|
|
9390
9181
|
/**
|
|
9391
9182
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9392
9183
|
*
|
|
9184
|
+
* @defaultValue true
|
|
9185
|
+
*
|
|
9393
9186
|
* Show the context menu when right-clicking on the window.
|
|
9394
9187
|
* Gives access to the devtools for the window.
|
|
9395
|
-
*
|
|
9396
|
-
* @default true
|
|
9397
9188
|
*/
|
|
9398
9189
|
contextMenu: boolean;
|
|
9399
9190
|
/**
|
|
@@ -9463,14 +9254,12 @@ declare type MutableWindowOptions = {
|
|
|
9463
9254
|
* @defaultValue true
|
|
9464
9255
|
*
|
|
9465
9256
|
* Show the window's frame.
|
|
9466
|
-
*
|
|
9467
|
-
* @default true
|
|
9468
9257
|
*/
|
|
9469
9258
|
frame: boolean;
|
|
9470
9259
|
/**
|
|
9471
|
-
*
|
|
9260
|
+
* @defaultValue false
|
|
9472
9261
|
*
|
|
9473
|
-
*
|
|
9262
|
+
* Hides the window instead of closing it when the close button is pressed.
|
|
9474
9263
|
*/
|
|
9475
9264
|
hideOnClose: boolean;
|
|
9476
9265
|
/**
|
|
@@ -9523,61 +9312,60 @@ declare type MutableWindowOptions = {
|
|
|
9523
9312
|
*/
|
|
9524
9313
|
icon: string;
|
|
9525
9314
|
/**
|
|
9315
|
+
* @defaultValue true
|
|
9316
|
+
*
|
|
9526
9317
|
* Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
|
9527
9318
|
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
|
9528
|
-
*
|
|
9529
|
-
* @default true
|
|
9530
9319
|
*/
|
|
9531
9320
|
includeInSnapshots: boolean;
|
|
9532
9321
|
/**
|
|
9533
|
-
*
|
|
9322
|
+
* @defaultValue -1
|
|
9534
9323
|
*
|
|
9535
|
-
*
|
|
9324
|
+
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
|
9536
9325
|
*/
|
|
9537
9326
|
maxHeight: number;
|
|
9538
9327
|
/**
|
|
9539
|
-
*
|
|
9328
|
+
* @defaultValue true
|
|
9540
9329
|
*
|
|
9541
|
-
*
|
|
9330
|
+
* Allows the window to be maximized.
|
|
9542
9331
|
*/
|
|
9543
9332
|
maximizable: boolean;
|
|
9544
9333
|
/**
|
|
9545
|
-
*
|
|
9334
|
+
* @defaultValue -1
|
|
9546
9335
|
*
|
|
9547
|
-
*
|
|
9336
|
+
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
|
9548
9337
|
*/
|
|
9549
9338
|
maxWidth: number;
|
|
9550
9339
|
/**
|
|
9551
|
-
*
|
|
9340
|
+
* @defaultValue 0
|
|
9552
9341
|
*
|
|
9553
|
-
*
|
|
9342
|
+
* The minimum height of the window.
|
|
9554
9343
|
*/
|
|
9555
9344
|
minHeight: number;
|
|
9556
9345
|
/**
|
|
9557
|
-
*
|
|
9346
|
+
* @defaultValue true
|
|
9558
9347
|
*
|
|
9559
|
-
*
|
|
9348
|
+
* Allows the window to be minimized.
|
|
9560
9349
|
*/
|
|
9561
9350
|
minimizable: boolean;
|
|
9562
9351
|
/**
|
|
9563
|
-
*
|
|
9352
|
+
* @defaultValue true
|
|
9564
9353
|
*
|
|
9565
|
-
*
|
|
9354
|
+
* The minimum width of the window.
|
|
9566
9355
|
*/
|
|
9567
9356
|
minWidth: number;
|
|
9568
9357
|
/**
|
|
9358
|
+
* @defaultValue 1
|
|
9359
|
+
*
|
|
9569
9360
|
* A flag that specifies how transparent the window will be.
|
|
9570
9361
|
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
|
9571
9362
|
* This value is clamped between `0.0` and `1.0`.
|
|
9572
|
-
* In software composition mode, the runtime flag --allow-unsafe-compositing is required.
|
|
9573
|
-
*
|
|
9574
|
-
* @default 1
|
|
9575
9363
|
*/
|
|
9576
9364
|
opacity: number;
|
|
9577
9365
|
/**
|
|
9578
|
-
*
|
|
9366
|
+
* @defaultValue true
|
|
9579
9367
|
*
|
|
9580
|
-
*
|
|
9368
|
+
* A flag to allow the user to resize the window.
|
|
9581
9369
|
*/
|
|
9582
9370
|
resizable: boolean;
|
|
9583
9371
|
/**
|
|
@@ -9585,16 +9373,16 @@ declare type MutableWindowOptions = {
|
|
|
9585
9373
|
*/
|
|
9586
9374
|
resizeRegion: ResizeRegion;
|
|
9587
9375
|
/**
|
|
9376
|
+
* @defaultValue false
|
|
9377
|
+
*
|
|
9588
9378
|
* **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
|
|
9589
9379
|
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
|
9590
|
-
*
|
|
9591
|
-
* @default false
|
|
9592
9380
|
*/
|
|
9593
9381
|
showBackgroundImages: boolean;
|
|
9594
9382
|
/**
|
|
9595
|
-
*
|
|
9383
|
+
* @defaultValue true
|
|
9596
9384
|
*
|
|
9597
|
-
*
|
|
9385
|
+
* Shows the window's icon in the taskbar.
|
|
9598
9386
|
*/
|
|
9599
9387
|
showTaskbarIcon: boolean;
|
|
9600
9388
|
/**
|
|
@@ -9609,7 +9397,7 @@ declare type MutableWindowOptions = {
|
|
|
9609
9397
|
/**
|
|
9610
9398
|
* {@inheritDoc WindowThrottling}
|
|
9611
9399
|
*
|
|
9612
|
-
* @
|
|
9400
|
+
* @defaultValue 'enabled'
|
|
9613
9401
|
*
|
|
9614
9402
|
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
|
9615
9403
|
*/
|
|
@@ -9638,14 +9426,13 @@ declare type NativeWindowIntegrationProviderAuthorization = {
|
|
|
9638
9426
|
};
|
|
9639
9427
|
|
|
9640
9428
|
/**
|
|
9641
|
-
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules
|
|
9429
|
+
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
|
|
9642
9430
|
* @interface
|
|
9643
9431
|
*/
|
|
9644
9432
|
declare type NavigationRejectedEvent = NamedEvent & {
|
|
9645
9433
|
type: 'navigation-rejected';
|
|
9646
9434
|
sourceName?: string;
|
|
9647
9435
|
url: string;
|
|
9648
|
-
contentRule?: OpenFin.ContentPermission | undefined;
|
|
9649
9436
|
};
|
|
9650
9437
|
|
|
9651
9438
|
/**
|
|
@@ -9795,11 +9582,8 @@ declare namespace OpenFin {
|
|
|
9795
9582
|
ClientConnectionPayload,
|
|
9796
9583
|
EntityInfo,
|
|
9797
9584
|
EntityType_4 as EntityType,
|
|
9798
|
-
ScreenCaptureState,
|
|
9799
|
-
ScreenCapturePermission,
|
|
9800
9585
|
Bounds,
|
|
9801
9586
|
WindowBounds,
|
|
9802
|
-
GetBoundsOptions,
|
|
9803
9587
|
Rectangle,
|
|
9804
9588
|
ApplicationCreationOptions,
|
|
9805
9589
|
TimeZones,
|
|
@@ -9902,7 +9686,6 @@ declare namespace OpenFin {
|
|
|
9902
9686
|
OpenExternalPermission,
|
|
9903
9687
|
DeviceInfo,
|
|
9904
9688
|
Permissions_2 as Permissions,
|
|
9905
|
-
ClipboardApiPermissions,
|
|
9906
9689
|
PlatformWindowCreationOptions,
|
|
9907
9690
|
PlatformWindowOptions,
|
|
9908
9691
|
PlatformViewCreationOptions,
|
|
@@ -10008,21 +9791,11 @@ declare namespace OpenFin {
|
|
|
10008
9791
|
RuntimeInfo,
|
|
10009
9792
|
DefaultDomainSettings,
|
|
10010
9793
|
DefaultDomainSettingsRule,
|
|
10011
|
-
MultipleDomainMatchBehavior,
|
|
10012
9794
|
DomainSettings,
|
|
10013
9795
|
ApiInjection,
|
|
10014
9796
|
DomainApiSettings,
|
|
10015
|
-
BaseContentBehavior,
|
|
10016
|
-
ContentBehavior,
|
|
10017
|
-
BrowserContentBehavior,
|
|
10018
|
-
StructuredContentBehavior,
|
|
10019
|
-
StructuredContentPermissions,
|
|
10020
9797
|
ContentPermission,
|
|
10021
|
-
ScreenCaptureBehavior,
|
|
10022
9798
|
PerDomainSettings,
|
|
10023
|
-
CopyPermissions,
|
|
10024
|
-
PastePermissions,
|
|
10025
|
-
ClipboardPermissions,
|
|
10026
9799
|
DomainSettingsRule,
|
|
10027
9800
|
FileDownloadBehavior,
|
|
10028
9801
|
FileDownloadBehaviorNames,
|
|
@@ -10122,7 +9895,6 @@ declare namespace OpenFin {
|
|
|
10122
9895
|
Me,
|
|
10123
9896
|
CapturePageOptions,
|
|
10124
9897
|
ProcessLoggingOptions,
|
|
10125
|
-
BoundsType,
|
|
10126
9898
|
PositioningOptions,
|
|
10127
9899
|
ChannelClientConnectionListener,
|
|
10128
9900
|
ChannelClientDisconnectionListener,
|
|
@@ -10131,11 +9903,6 @@ declare namespace OpenFin {
|
|
|
10131
9903
|
DownloadShelfOptions,
|
|
10132
9904
|
ViewShowAtOptions,
|
|
10133
9905
|
ExtensionInfo,
|
|
10134
|
-
ServeRequest,
|
|
10135
|
-
AppAssetServeRequest,
|
|
10136
|
-
PathServeRequest,
|
|
10137
|
-
ServeAssetOptions,
|
|
10138
|
-
ServedAssetInfo,
|
|
10139
9906
|
ApplicationEvents,
|
|
10140
9907
|
BaseEvents,
|
|
10141
9908
|
ExternalApplicationEvents,
|
|
@@ -10202,34 +9969,6 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
|
|
|
10202
9969
|
title: string;
|
|
10203
9970
|
};
|
|
10204
9971
|
|
|
10205
|
-
/**
|
|
10206
|
-
* Reasons for a paste operation being blocked
|
|
10207
|
-
*
|
|
10208
|
-
* 'invalid-data': Copy protection is enabled and the pasted data is invalid.
|
|
10209
|
-
* '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.
|
|
10210
|
-
*/
|
|
10211
|
-
declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
|
|
10212
|
-
|
|
10213
|
-
/**
|
|
10214
|
-
* Control copy operations for a matched URL.
|
|
10215
|
-
* @interface
|
|
10216
|
-
*/
|
|
10217
|
-
declare type PastePermissions = {
|
|
10218
|
-
/**
|
|
10219
|
-
* Controls the behavior for paste operations for a matched URL.
|
|
10220
|
-
*
|
|
10221
|
-
* non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
|
|
10222
|
-
* 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.
|
|
10223
|
-
*
|
|
10224
|
-
* @default 'non-protected-content'
|
|
10225
|
-
*/
|
|
10226
|
-
behavior: 'non-protected-content' | 'all-content';
|
|
10227
|
-
};
|
|
10228
|
-
|
|
10229
|
-
declare type PathServeRequest = ServeRequest & {
|
|
10230
|
-
path: string;
|
|
10231
|
-
};
|
|
10232
|
-
|
|
10233
9972
|
declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10234
9973
|
success: Success;
|
|
10235
9974
|
data: Success extends true ? Data : never;
|
|
@@ -10369,29 +10108,6 @@ declare type PerDomainSettings = {
|
|
|
10369
10108
|
* {@inheritdoc ChromiumPolicies}
|
|
10370
10109
|
*/
|
|
10371
10110
|
chromiumPolicies?: ChromiumPolicies;
|
|
10372
|
-
/**
|
|
10373
|
-
* @experimental These features are still under development and may change.
|
|
10374
|
-
*/
|
|
10375
|
-
contentProtection?: {
|
|
10376
|
-
/**
|
|
10377
|
-
* {@inheritdoc ScreenCaptureBehavior}
|
|
10378
|
-
*/
|
|
10379
|
-
screenCapture?: ScreenCaptureBehavior;
|
|
10380
|
-
/**
|
|
10381
|
-
* {@inheritdoc ClipboardPermissions}
|
|
10382
|
-
*/
|
|
10383
|
-
clipboard?: ClipboardPermissions;
|
|
10384
|
-
/**
|
|
10385
|
-
* Whether the content can be printed.
|
|
10386
|
-
* Defaults to 'allow'.
|
|
10387
|
-
* Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
|
|
10388
|
-
*/
|
|
10389
|
-
print?: 'allow' | 'block';
|
|
10390
|
-
/**
|
|
10391
|
-
* * Controls whether HTML5 dragging for this content is allowed or blocked.
|
|
10392
|
-
*/
|
|
10393
|
-
drag?: 'allow' | 'block';
|
|
10394
|
-
};
|
|
10395
10111
|
};
|
|
10396
10112
|
|
|
10397
10113
|
/**
|
|
@@ -10416,7 +10132,6 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
|
|
10416
10132
|
declare type Permissions_2 = {
|
|
10417
10133
|
Application?: Partial<ApplicationPermissions>;
|
|
10418
10134
|
System?: Partial<SystemPermissions>;
|
|
10419
|
-
Clipboard?: Partial<ClipboardApiPermissions>;
|
|
10420
10135
|
webAPIs?: WebPermission[];
|
|
10421
10136
|
devices?: DeviceInfo[];
|
|
10422
10137
|
};
|
|
@@ -11248,11 +10963,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
11248
10963
|
*/
|
|
11249
10964
|
providerUrl?: string;
|
|
11250
10965
|
/**
|
|
10966
|
+
* @defaultValue true
|
|
10967
|
+
*
|
|
11251
10968
|
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
|
11252
10969
|
*
|
|
11253
10970
|
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
|
11254
|
-
*
|
|
11255
|
-
* @default true
|
|
11256
10971
|
*/
|
|
11257
10972
|
allowLaunchIntoPlatform?: boolean;
|
|
11258
10973
|
};
|
|
@@ -11787,14 +11502,6 @@ declare interface PlatformProvider {
|
|
|
11787
11502
|
* ```
|
|
11788
11503
|
*/
|
|
11789
11504
|
handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
|
|
11790
|
-
/**
|
|
11791
|
-
* Determines whether a given window should prevent the application from quitting when it is closed.
|
|
11792
|
-
* This method is called when checking if closing a window should trigger application termination.
|
|
11793
|
-
*
|
|
11794
|
-
* @param windowIdentity - The identity of the window being checked.
|
|
11795
|
-
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
|
11796
|
-
*/
|
|
11797
|
-
shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
|
|
11798
11505
|
}
|
|
11799
11506
|
|
|
11800
11507
|
/**
|
|
@@ -11896,22 +11603,22 @@ declare type PopupOptions = {
|
|
|
11896
11603
|
url?: string;
|
|
11897
11604
|
/**
|
|
11898
11605
|
* Height of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
11899
|
-
* @
|
|
11606
|
+
* @defaultValue 300
|
|
11900
11607
|
*/
|
|
11901
11608
|
height?: number;
|
|
11902
11609
|
/**
|
|
11903
11610
|
* Width of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
11904
|
-
* @
|
|
11611
|
+
* @defaultValue 300
|
|
11905
11612
|
*/
|
|
11906
11613
|
width?: number;
|
|
11907
11614
|
/**
|
|
11908
11615
|
* Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
11909
|
-
* @
|
|
11616
|
+
* @defaultValue 0
|
|
11910
11617
|
*/
|
|
11911
11618
|
x?: number;
|
|
11912
11619
|
/**
|
|
11913
11620
|
* Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
11914
|
-
* @
|
|
11621
|
+
* @defaultValue 0
|
|
11915
11622
|
*/
|
|
11916
11623
|
y?: number;
|
|
11917
11624
|
/**
|
|
@@ -11919,7 +11626,7 @@ declare type PopupOptions = {
|
|
|
11919
11626
|
* * 'modal' restricts resizing and positioning in the caller.
|
|
11920
11627
|
* * 'hide' hides the popup window on blur.
|
|
11921
11628
|
* * 'close' closes the popup window on blur.
|
|
11922
|
-
* @
|
|
11629
|
+
* @defaultValue 'close'
|
|
11923
11630
|
*/
|
|
11924
11631
|
blurBehavior?: PopupBlurBehavior;
|
|
11925
11632
|
/**
|
|
@@ -11927,19 +11634,19 @@ declare type PopupOptions = {
|
|
|
11927
11634
|
* * 'none' will do nothing.
|
|
11928
11635
|
* * 'hide' hides the popup window on `dispatchPopupResult`.
|
|
11929
11636
|
* * 'close' closes the popup window on `dispatchPopupResult`.
|
|
11930
|
-
* @
|
|
11637
|
+
* @defaultValue 'close'
|
|
11931
11638
|
*/
|
|
11932
11639
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
11933
11640
|
/**
|
|
11934
11641
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
11935
11642
|
*
|
|
11936
11643
|
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
11937
|
-
* @
|
|
11644
|
+
* @defaultValue false
|
|
11938
11645
|
*/
|
|
11939
11646
|
hideOnClose?: boolean;
|
|
11940
11647
|
/**
|
|
11941
11648
|
* Determines if the popup window should or should not be focused when it is shown.
|
|
11942
|
-
* @
|
|
11649
|
+
* @defaultValue true
|
|
11943
11650
|
*/
|
|
11944
11651
|
focus?: boolean;
|
|
11945
11652
|
/**
|
|
@@ -12018,7 +11725,6 @@ declare type PositioningOptions = {
|
|
|
12018
11725
|
* This will have the effect of the maximized window staying maximized and not immediately taking this new position.
|
|
12019
11726
|
*/
|
|
12020
11727
|
skipRestore?: boolean;
|
|
12021
|
-
boundsType?: BoundsType;
|
|
12022
11728
|
};
|
|
12023
11729
|
|
|
12024
11730
|
/**
|
|
@@ -12033,9 +11739,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
|
|
|
12033
11739
|
*/
|
|
12034
11740
|
declare type PreloadScript = {
|
|
12035
11741
|
/**
|
|
12036
|
-
*
|
|
11742
|
+
* @defaultValue false
|
|
12037
11743
|
*
|
|
12038
|
-
*
|
|
11744
|
+
* Fail to load the window if this preload script fails
|
|
12039
11745
|
*/
|
|
12040
11746
|
mandatory?: boolean;
|
|
12041
11747
|
/**
|
|
@@ -12131,15 +11837,15 @@ declare type PrinterInfo = {
|
|
|
12131
11837
|
declare type PrintOptions = {
|
|
12132
11838
|
content?: 'self';
|
|
12133
11839
|
/**
|
|
12134
|
-
*
|
|
11840
|
+
* @defaultValue false
|
|
12135
11841
|
*
|
|
12136
|
-
*
|
|
11842
|
+
* Disables prompting the user for print settings.
|
|
12137
11843
|
*/
|
|
12138
11844
|
silent?: boolean;
|
|
12139
11845
|
/**
|
|
12140
|
-
*
|
|
11846
|
+
* @defaultValue false
|
|
12141
11847
|
*
|
|
12142
|
-
*
|
|
11848
|
+
* Includes the webpage background color and image when printing.
|
|
12143
11849
|
*/
|
|
12144
11850
|
printBackground?: boolean;
|
|
12145
11851
|
/**
|
|
@@ -12147,9 +11853,9 @@ declare type PrintOptions = {
|
|
|
12147
11853
|
*/
|
|
12148
11854
|
deviceName?: string;
|
|
12149
11855
|
/**
|
|
12150
|
-
*
|
|
11856
|
+
* @defaultValue true
|
|
12151
11857
|
*
|
|
12152
|
-
*
|
|
11858
|
+
* Prints in full color (greyscale otherwise).
|
|
12153
11859
|
*/
|
|
12154
11860
|
color?: boolean;
|
|
12155
11861
|
/**
|
|
@@ -12157,9 +11863,9 @@ declare type PrintOptions = {
|
|
|
12157
11863
|
*/
|
|
12158
11864
|
margins?: Margins;
|
|
12159
11865
|
/**
|
|
12160
|
-
*
|
|
11866
|
+
* @defaultValue true
|
|
12161
11867
|
*
|
|
12162
|
-
*
|
|
11868
|
+
* Prints in landscape mode (portrait otherwise).
|
|
12163
11869
|
*/
|
|
12164
11870
|
landscape?: boolean;
|
|
12165
11871
|
/**
|
|
@@ -12406,9 +12112,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12406
12112
|
'set-tray-icon': ApplicationIdentityCall<{
|
|
12407
12113
|
enabledIcon: string;
|
|
12408
12114
|
}, void>;
|
|
12409
|
-
'set-tray-icon-tooltip': ApplicationIdentityCall<{
|
|
12410
|
-
toolTip: string;
|
|
12411
|
-
}>;
|
|
12412
12115
|
'set-shortcuts': ApplicationIdentityCall<{
|
|
12413
12116
|
data: OpenFin.ShortCutConfig;
|
|
12414
12117
|
}, void>;
|
|
@@ -12546,9 +12249,7 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12546
12249
|
options: OpenFin.TransitionOptions;
|
|
12547
12250
|
}>;
|
|
12548
12251
|
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12549
|
-
'get-window-bounds': IdentityCall<{
|
|
12550
|
-
options?: OpenFin.GetBoundsOptions;
|
|
12551
|
-
}, OpenFin.WindowBounds>;
|
|
12252
|
+
'get-window-bounds': IdentityCall<{}, OpenFin.WindowBounds>;
|
|
12552
12253
|
'center-window': IdentityCall;
|
|
12553
12254
|
'blur-window': IdentityCall;
|
|
12554
12255
|
'bring-window-to-front': IdentityCall;
|
|
@@ -12884,9 +12585,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12884
12585
|
options: OpenFin.ProcessLoggingOptions;
|
|
12885
12586
|
}, void>;
|
|
12886
12587
|
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
12887
|
-
'serve-asset': ApiCall<{
|
|
12888
|
-
options: OpenFin.ServeAssetOptions;
|
|
12889
|
-
}, OpenFin.ServedAssetInfo>;
|
|
12890
12588
|
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12891
12589
|
domainSettings: OpenFin.DefaultDomainSettings;
|
|
12892
12590
|
}, void>;
|
|
@@ -13052,10 +12750,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13052
12750
|
};
|
|
13053
12751
|
response: OpenFin.PopupResult;
|
|
13054
12752
|
};
|
|
13055
|
-
'get-screen-capture-permissions': {
|
|
13056
|
-
request: OpenFin.Identity;
|
|
13057
|
-
response: OpenFin.ScreenCapturePermission;
|
|
13058
|
-
};
|
|
13059
12753
|
'render-overlay': {
|
|
13060
12754
|
request: {
|
|
13061
12755
|
bounds: OpenFin.Bounds;
|
|
@@ -13330,15 +13024,15 @@ declare type ReplaceViewPayload = {
|
|
|
13330
13024
|
*/
|
|
13331
13025
|
declare type ResizeRegion = {
|
|
13332
13026
|
/**
|
|
13333
|
-
*
|
|
13027
|
+
* @defaultValue 7
|
|
13334
13028
|
*
|
|
13335
|
-
*
|
|
13029
|
+
* The size of the resize region in pixels.
|
|
13336
13030
|
*/
|
|
13337
13031
|
size?: number;
|
|
13338
13032
|
/**
|
|
13339
|
-
*
|
|
13033
|
+
* @defaultValue 9
|
|
13340
13034
|
*
|
|
13341
|
-
*
|
|
13035
|
+
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
|
13342
13036
|
*/
|
|
13343
13037
|
bottomRightCorner?: number;
|
|
13344
13038
|
/**
|
|
@@ -13346,27 +13040,27 @@ declare type ResizeRegion = {
|
|
|
13346
13040
|
*/
|
|
13347
13041
|
sides?: {
|
|
13348
13042
|
/**
|
|
13349
|
-
*
|
|
13043
|
+
* @defaultValue true
|
|
13350
13044
|
*
|
|
13351
|
-
*
|
|
13045
|
+
* Enables resizing from the top of the window.
|
|
13352
13046
|
*/
|
|
13353
13047
|
top?: boolean;
|
|
13354
13048
|
/**
|
|
13355
|
-
*
|
|
13049
|
+
* @defaultValue true
|
|
13356
13050
|
*
|
|
13357
|
-
*
|
|
13051
|
+
* Enables resizing from the bottom of the window.
|
|
13358
13052
|
*/
|
|
13359
13053
|
bottom?: boolean;
|
|
13360
13054
|
/**
|
|
13361
|
-
*
|
|
13055
|
+
* @defaultValue true
|
|
13362
13056
|
*
|
|
13363
|
-
*
|
|
13057
|
+
* Enables resizing from the left side of the window.
|
|
13364
13058
|
*/
|
|
13365
13059
|
left?: boolean;
|
|
13366
13060
|
/**
|
|
13367
|
-
*
|
|
13061
|
+
* @defaultValue true
|
|
13368
13062
|
*
|
|
13369
|
-
*
|
|
13063
|
+
* Enables resizing from the right side of the window.
|
|
13370
13064
|
*/
|
|
13371
13065
|
right?: boolean;
|
|
13372
13066
|
};
|
|
@@ -13548,20 +13242,12 @@ declare type RVMInfo = {
|
|
|
13548
13242
|
* The app log directory.
|
|
13549
13243
|
*/
|
|
13550
13244
|
'appLogDirectory': string;
|
|
13551
|
-
/**
|
|
13552
|
-
* Architecture of the OS that the RVM is running on. One of `arm64`, `x86`, `x64`. Available since RVM 16.
|
|
13553
|
-
*/
|
|
13554
|
-
'osArch': string;
|
|
13555
13245
|
/**
|
|
13556
13246
|
* The path of OpenfinRVM.exe.
|
|
13557
13247
|
*/
|
|
13558
13248
|
'path': string;
|
|
13559
13249
|
/**
|
|
13560
|
-
*
|
|
13561
|
-
*/
|
|
13562
|
-
'rvmArch': string;
|
|
13563
|
-
/**
|
|
13564
|
-
* The start time of RVM. Format is `YYYY-MM-DD HH:MM:SS` in local time or `NA` on error.
|
|
13250
|
+
* The start time of RVM.
|
|
13565
13251
|
*/
|
|
13566
13252
|
'start-time': string;
|
|
13567
13253
|
/**
|
|
@@ -13593,30 +13279,6 @@ declare type RvmLaunchOptions = {
|
|
|
13593
13279
|
subscribe?: (launch: LaunchEmitter) => void;
|
|
13594
13280
|
};
|
|
13595
13281
|
|
|
13596
|
-
/**
|
|
13597
|
-
* Controls whether this content should be allowed or blocked when capturing the screen.
|
|
13598
|
-
*/
|
|
13599
|
-
declare type ScreenCaptureBehavior = 'allow' | 'block';
|
|
13600
|
-
|
|
13601
|
-
/**
|
|
13602
|
-
* Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
|
|
13603
|
-
* @interface
|
|
13604
|
-
*/
|
|
13605
|
-
declare type ScreenCapturePermission = {
|
|
13606
|
-
permission: ScreenCaptureBehavior;
|
|
13607
|
-
permissions: ScreenCaptureState[];
|
|
13608
|
-
};
|
|
13609
|
-
|
|
13610
|
-
/**
|
|
13611
|
-
* screenCapture state for a given entity as defined in domain settings.
|
|
13612
|
-
* @interface
|
|
13613
|
-
*/
|
|
13614
|
-
declare type ScreenCaptureState = {
|
|
13615
|
-
info: EntityInfo;
|
|
13616
|
-
behavior: ScreenCaptureBehavior;
|
|
13617
|
-
url: string;
|
|
13618
|
-
};
|
|
13619
|
-
|
|
13620
13282
|
/**
|
|
13621
13283
|
* @interface
|
|
13622
13284
|
*/
|
|
@@ -13655,16 +13317,6 @@ declare type SentMessage<Value> = Promise<Value> & {
|
|
|
13655
13317
|
messageId: ReturnType<Environment['getNextMessageId']>;
|
|
13656
13318
|
};
|
|
13657
13319
|
|
|
13658
|
-
declare type ServeAssetOptions = AppAssetServeRequest | PathServeRequest;
|
|
13659
|
-
|
|
13660
|
-
declare type ServedAssetInfo = {
|
|
13661
|
-
baseUrl: string;
|
|
13662
|
-
};
|
|
13663
|
-
|
|
13664
|
-
declare type ServeRequest = {
|
|
13665
|
-
hostName: string;
|
|
13666
|
-
};
|
|
13667
|
-
|
|
13668
13320
|
/**
|
|
13669
13321
|
* @interface
|
|
13670
13322
|
*/
|
|
@@ -13910,9 +13562,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
|
|
|
13910
13562
|
*/
|
|
13911
13563
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
13912
13564
|
/**
|
|
13913
|
-
*
|
|
13565
|
+
* @defaultValue 0
|
|
13914
13566
|
*
|
|
13915
|
-
*
|
|
13567
|
+
* Number of milliseconds to wait between view repaints.
|
|
13916
13568
|
*/
|
|
13917
13569
|
paintIntervalMs?: number;
|
|
13918
13570
|
};
|
|
@@ -13962,7 +13614,6 @@ declare type Snapshot = {
|
|
|
13962
13614
|
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
|
13963
13615
|
topic: 'application';
|
|
13964
13616
|
type: 'platform-snapshot-applied';
|
|
13965
|
-
snapshot: Snapshot;
|
|
13966
13617
|
};
|
|
13967
13618
|
|
|
13968
13619
|
/**
|
|
@@ -14084,32 +13735,6 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
|
14084
13735
|
type: 'started';
|
|
14085
13736
|
};
|
|
14086
13737
|
|
|
14087
|
-
/**
|
|
14088
|
-
* Behavior when displaying content from matched URLs.
|
|
14089
|
-
*/
|
|
14090
|
-
declare type StructuredContentBehavior = {
|
|
14091
|
-
behavior: BaseContentBehavior;
|
|
14092
|
-
} | BrowserContentBehavior;
|
|
14093
|
-
|
|
14094
|
-
/**
|
|
14095
|
-
* Behavior when displaying content from matched URLs. Varies depending on type of navigation.
|
|
14096
|
-
* @interface
|
|
14097
|
-
*/
|
|
14098
|
-
declare type StructuredContentPermissions = {
|
|
14099
|
-
/**
|
|
14100
|
-
* Controls the behavior for navigations
|
|
14101
|
-
*/
|
|
14102
|
-
navigate?: ContentBehavior | StructuredContentBehavior;
|
|
14103
|
-
/**
|
|
14104
|
-
* Controls the behavior for redirects
|
|
14105
|
-
*/
|
|
14106
|
-
redirect?: ContentBehavior | StructuredContentBehavior;
|
|
14107
|
-
/**
|
|
14108
|
-
* Controls the behavior for when iframes try to redirect
|
|
14109
|
-
*/
|
|
14110
|
-
iframe?: BaseContentBehavior;
|
|
14111
|
-
};
|
|
14112
|
-
|
|
14113
13738
|
/**
|
|
14114
13739
|
* @interface
|
|
14115
13740
|
*/
|
|
@@ -15590,11 +15215,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15590
15215
|
* Gets the currently-installed
|
|
15591
15216
|
*/
|
|
15592
15217
|
getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
|
|
15593
|
-
/**
|
|
15594
|
-
* Used to serve an asset signed by OpenFin within the given runtime.
|
|
15595
|
-
* Not indended for general use, will be used by the `@openfin/workspace-platform` package.
|
|
15596
|
-
*/
|
|
15597
|
-
serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
|
|
15598
15218
|
}
|
|
15599
15219
|
|
|
15600
15220
|
/**
|
|
@@ -15950,9 +15570,9 @@ declare type TransitionBase = {
|
|
|
15950
15570
|
*/
|
|
15951
15571
|
duration: number;
|
|
15952
15572
|
/**
|
|
15953
|
-
*
|
|
15573
|
+
* @defaultValue false
|
|
15954
15574
|
*
|
|
15955
|
-
*
|
|
15575
|
+
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
15956
15576
|
*/
|
|
15957
15577
|
relative?: boolean;
|
|
15958
15578
|
};
|
|
@@ -15968,9 +15588,9 @@ declare type TransitionOptions = {
|
|
|
15968
15588
|
*/
|
|
15969
15589
|
interrupt: boolean;
|
|
15970
15590
|
/**
|
|
15971
|
-
*
|
|
15591
|
+
* @defaultValue false
|
|
15972
15592
|
*
|
|
15973
|
-
*
|
|
15593
|
+
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
15974
15594
|
*/
|
|
15975
15595
|
relative?: boolean;
|
|
15976
15596
|
tween?: tween;
|
|
@@ -16998,9 +16618,9 @@ declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
|
|
|
16998
16618
|
*/
|
|
16999
16619
|
declare type ViewVisibilityOption = {
|
|
17000
16620
|
/**
|
|
17001
|
-
*
|
|
16621
|
+
* @defaultValue false
|
|
17002
16622
|
*
|
|
17003
|
-
*
|
|
16623
|
+
* Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
|
|
17004
16624
|
*/
|
|
17005
16625
|
enabled?: boolean;
|
|
17006
16626
|
};
|
|
@@ -17624,7 +17244,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17624
17244
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17625
17245
|
* });
|
|
17626
17246
|
*
|
|
17627
|
-
* await view.navigate('
|
|
17247
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
17628
17248
|
*
|
|
17629
17249
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17630
17250
|
* ```
|
|
@@ -17635,7 +17255,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17635
17255
|
* name:'child',
|
|
17636
17256
|
* defaultWidth: 300,
|
|
17637
17257
|
* defaultHeight: 300,
|
|
17638
|
-
* url: '
|
|
17258
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
17639
17259
|
* frame: true,
|
|
17640
17260
|
* autoShow: true
|
|
17641
17261
|
* };
|
|
@@ -17660,7 +17280,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17660
17280
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17661
17281
|
* });
|
|
17662
17282
|
*
|
|
17663
|
-
* await view.navigate('
|
|
17283
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
17664
17284
|
*
|
|
17665
17285
|
* await view.inspectSharedWorker();
|
|
17666
17286
|
* ```
|
|
@@ -17671,7 +17291,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17671
17291
|
* name:'child',
|
|
17672
17292
|
* defaultWidth: 300,
|
|
17673
17293
|
* defaultHeight: 300,
|
|
17674
|
-
* url: '
|
|
17294
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
17675
17295
|
* frame: true,
|
|
17676
17296
|
* autoShow: true
|
|
17677
17297
|
* };
|
|
@@ -17697,7 +17317,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17697
17317
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17698
17318
|
* });
|
|
17699
17319
|
*
|
|
17700
|
-
* await view.navigate('
|
|
17320
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
17701
17321
|
*
|
|
17702
17322
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17703
17323
|
* await view.inspectSharedWorkerById(sharedWorkers[0].id);
|
|
@@ -17709,7 +17329,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17709
17329
|
* name:'child',
|
|
17710
17330
|
* defaultWidth: 300,
|
|
17711
17331
|
* defaultHeight: 300,
|
|
17712
|
-
* url: '
|
|
17332
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
17713
17333
|
* frame: true,
|
|
17714
17334
|
* autoShow: true
|
|
17715
17335
|
* };
|
|
@@ -17971,19 +17591,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17971
17591
|
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
17972
17592
|
*/
|
|
17973
17593
|
showPopupWindow(options: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
|
|
17974
|
-
/**
|
|
17975
|
-
*
|
|
17976
|
-
* Get the screen capture permission for this content.
|
|
17977
|
-
*
|
|
17978
|
-
* @example
|
|
17979
|
-
* ```js
|
|
17980
|
-
* const { permission } = await fin.me.getScreenCapturePermission();
|
|
17981
|
-
*
|
|
17982
|
-
* console.log(`This content is currently ${permission}ed in screen captures.`);
|
|
17983
|
-
*
|
|
17984
|
-
* ```
|
|
17985
|
-
*/
|
|
17986
|
-
getScreenCapturePermission(): Promise<OpenFin.ScreenCapturePermission>;
|
|
17987
17594
|
}
|
|
17988
17595
|
|
|
17989
17596
|
/**
|
|
@@ -18022,8 +17629,6 @@ declare namespace WebContentsEvents {
|
|
|
18022
17629
|
FileDownloadProgressEvent,
|
|
18023
17630
|
FileDownloadCompletedEvent,
|
|
18024
17631
|
ContentBlockedEvent,
|
|
18025
|
-
ClipboardCopyBlockedEvent,
|
|
18026
|
-
ClipboardPasteBlockedEvent,
|
|
18027
17632
|
Event_5 as Event,
|
|
18028
17633
|
WebContentsEvent,
|
|
18029
17634
|
WillPropagateWebContentsEvent,
|
|
@@ -18193,7 +17798,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
|
18193
17798
|
* getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
|
|
18194
17799
|
* ```
|
|
18195
17800
|
*/
|
|
18196
|
-
getBounds(
|
|
17801
|
+
getBounds(): Promise<OpenFin.WindowBounds>;
|
|
18197
17802
|
/**
|
|
18198
17803
|
* Centers the window on its current screen.
|
|
18199
17804
|
*
|
|
@@ -19160,10 +18765,6 @@ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
|
|
|
19160
18765
|
declare type WindowBounds = Bounds & {
|
|
19161
18766
|
bottom: number;
|
|
19162
18767
|
right: number;
|
|
19163
|
-
/**
|
|
19164
|
-
* The bounds for the window's web content, excluding any OS border
|
|
19165
|
-
*/
|
|
19166
|
-
content: Bounds;
|
|
19167
18768
|
};
|
|
19168
18769
|
|
|
19169
18770
|
/**
|