@openfin/fdc3-api 40.105.7 → 40.200.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/fdc3-api-alpha.d.ts +438 -992
- package/out/fdc3-api-beta.d.ts +438 -992
- package/out/fdc3-api-public.d.ts +438 -992
- package/out/fdc3-api.d.ts +475 -1037
- 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
|
};
|
|
@@ -2352,6 +2301,8 @@ declare class Channel extends EmitterBase<ChannelEvent> {
|
|
|
2352
2301
|
|
|
2353
2302
|
declare type Channel_2 = OpenFin.Fin['InterApplicationBus']['Channel'];
|
|
2354
2303
|
|
|
2304
|
+
declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
|
|
2305
|
+
|
|
2355
2306
|
declare type ChannelAction = OpenFin.ChannelAction;
|
|
2356
2307
|
|
|
2357
2308
|
declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_4 | ClientIdentity) => unknown;
|
|
@@ -2753,9 +2704,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
|
|
|
2753
2704
|
*/
|
|
2754
2705
|
declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2755
2706
|
/**
|
|
2756
|
-
*
|
|
2707
|
+
* @defaultValue true
|
|
2757
2708
|
*
|
|
2758
|
-
*
|
|
2709
|
+
* If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
|
|
2759
2710
|
*/
|
|
2760
2711
|
wait?: boolean;
|
|
2761
2712
|
/**
|
|
@@ -3042,22 +2993,6 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
3042
2993
|
childOptions: OpenFin.WindowOptions;
|
|
3043
2994
|
};
|
|
3044
2995
|
|
|
3045
|
-
/**
|
|
3046
|
-
* Control behavior for Chromium policies
|
|
3047
|
-
*
|
|
3048
|
-
* @interface
|
|
3049
|
-
*/
|
|
3050
|
-
declare type ChromiumPolicies = {
|
|
3051
|
-
/**
|
|
3052
|
-
* Disable AutofillAddressEnabled policy for a Window or View.
|
|
3053
|
-
*/
|
|
3054
|
-
AutofillAddressEnabled?: PolicyOptions;
|
|
3055
|
-
/**
|
|
3056
|
-
* Disable AutofillCreditCardEnabled policy for a Window or View.
|
|
3057
|
-
*/
|
|
3058
|
-
AutofillCreditCardEnabled?: PolicyOptions;
|
|
3059
|
-
};
|
|
3060
|
-
|
|
3061
2996
|
declare interface ClassicProtocolOffer extends ProtocolPacketBase {
|
|
3062
2997
|
type: 'classic';
|
|
3063
2998
|
}
|
|
@@ -3141,7 +3076,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
|
3141
3076
|
*
|
|
3142
3077
|
*/
|
|
3143
3078
|
declare class Clipboard_2 extends Base {
|
|
3144
|
-
#private;
|
|
3145
3079
|
/**
|
|
3146
3080
|
* Writes data into the clipboard as plain text
|
|
3147
3081
|
* @param writeObj The object for writing data into the clipboard
|
|
@@ -3294,56 +3228,6 @@ declare class Clipboard_2 extends Base {
|
|
|
3294
3228
|
getAvailableFormats(type?: OpenFin.ClipboardSelectionType): Promise<Array<string>>;
|
|
3295
3229
|
}
|
|
3296
3230
|
|
|
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
3231
|
/**
|
|
3348
3232
|
* The type of clipboard to write to, can be 'clipboard' or 'selection'.
|
|
3349
3233
|
* Defaults to 'clipboard'. Use 'selection' for linux only.
|
|
@@ -3421,9 +3305,9 @@ declare interface CloseWindowPayload {
|
|
|
3421
3305
|
windowId: Identity_4;
|
|
3422
3306
|
options: {
|
|
3423
3307
|
/**
|
|
3424
|
-
*
|
|
3308
|
+
* @defaultValue false
|
|
3425
3309
|
*
|
|
3426
|
-
*
|
|
3310
|
+
* When set to true skips any before handler set on views that are part of the window
|
|
3427
3311
|
*/
|
|
3428
3312
|
skipBeforeUnload?: boolean;
|
|
3429
3313
|
};
|
|
@@ -3531,22 +3415,15 @@ declare type ConstViewOptions = {
|
|
|
3531
3415
|
*/
|
|
3532
3416
|
name: string;
|
|
3533
3417
|
/**
|
|
3534
|
-
*
|
|
3418
|
+
* @defaultValue "about:blank"
|
|
3535
3419
|
*
|
|
3536
|
-
*
|
|
3420
|
+
* The URL of the window
|
|
3537
3421
|
*/
|
|
3538
3422
|
url: string;
|
|
3539
3423
|
/**
|
|
3540
3424
|
* The identity of the window this view should be attached to.
|
|
3541
3425
|
*/
|
|
3542
3426
|
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
3427
|
/**
|
|
3551
3428
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3552
3429
|
*/
|
|
@@ -3587,13 +3464,17 @@ declare type ConstViewOptions = {
|
|
|
3587
3464
|
* but the properties in the manifest will take precedence if there is any collision.
|
|
3588
3465
|
*/
|
|
3589
3466
|
manifestUrl: string;
|
|
3467
|
+
/**
|
|
3468
|
+
* If true, the view's call to the Web Notifications API will be intercepted by the platform. The event `notification-intercepted` will be emitted with the notification object as the payload.
|
|
3469
|
+
*/
|
|
3470
|
+
interceptNotifications: boolean;
|
|
3590
3471
|
zoomLevel: number;
|
|
3591
3472
|
experimental: any;
|
|
3592
3473
|
fdc3InteropApi?: string;
|
|
3593
3474
|
/**
|
|
3594
|
-
*
|
|
3475
|
+
* @defaultValue false
|
|
3595
3476
|
*
|
|
3596
|
-
*
|
|
3477
|
+
* When set to `true`, any `beforeunload` handler set on Views will fire.
|
|
3597
3478
|
*/
|
|
3598
3479
|
enableBeforeUnload: boolean;
|
|
3599
3480
|
/**
|
|
@@ -3630,10 +3511,6 @@ declare type ConstViewOptions = {
|
|
|
3630
3511
|
*/
|
|
3631
3512
|
enabled: boolean;
|
|
3632
3513
|
};
|
|
3633
|
-
/**
|
|
3634
|
-
* Control which options to ignore when creating a Platform View.
|
|
3635
|
-
*/
|
|
3636
|
-
excludeOptions: ExcludeOptions;
|
|
3637
3514
|
};
|
|
3638
3515
|
|
|
3639
3516
|
/**
|
|
@@ -3674,12 +3551,13 @@ declare type ConstWindowOptions = {
|
|
|
3674
3551
|
*/
|
|
3675
3552
|
backgroundColor: string;
|
|
3676
3553
|
/**
|
|
3554
|
+
* @defaultValue false
|
|
3555
|
+
*
|
|
3677
3556
|
* Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
|
|
3678
3557
|
* This also affects the Page Visibility API.
|
|
3679
3558
|
*
|
|
3680
3559
|
* When `true`, the page is throttled whether it is hidden or not.
|
|
3681
3560
|
*
|
|
3682
|
-
* @default false
|
|
3683
3561
|
*/
|
|
3684
3562
|
backgroundThrottling: boolean;
|
|
3685
3563
|
/**
|
|
@@ -3703,21 +3581,21 @@ declare type ConstWindowOptions = {
|
|
|
3703
3581
|
*/
|
|
3704
3582
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3705
3583
|
/**
|
|
3584
|
+
* @defaultValue true
|
|
3585
|
+
*
|
|
3706
3586
|
* Setting this to false would keep the Window alive even if all its Views were closed.
|
|
3707
3587
|
* This is meant for advanced users and should be used with caution.
|
|
3708
3588
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
3709
3589
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
3710
3590
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3711
|
-
*
|
|
3712
|
-
* @default true
|
|
3713
3591
|
*/
|
|
3714
3592
|
closeOnLastViewRemoved: boolean;
|
|
3715
3593
|
/**
|
|
3594
|
+
* @defaultValue 'all'
|
|
3595
|
+
*
|
|
3716
3596
|
* 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'.
|
|
3597
|
+
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3718
3598
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3719
|
-
*
|
|
3720
|
-
* @default 'all'
|
|
3721
3599
|
*/
|
|
3722
3600
|
viewsPreventingClose: 'all' | 'layout';
|
|
3723
3601
|
/**
|
|
@@ -3728,31 +3606,31 @@ declare type ConstWindowOptions = {
|
|
|
3728
3606
|
*/
|
|
3729
3607
|
defaultCentered: boolean;
|
|
3730
3608
|
/**
|
|
3609
|
+
* @defaultValue 500
|
|
3610
|
+
*
|
|
3731
3611
|
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
|
3732
3612
|
* in favor of the cached value.
|
|
3733
|
-
*
|
|
3734
|
-
* @default 500
|
|
3735
3613
|
*/
|
|
3736
3614
|
defaultHeight: number;
|
|
3737
3615
|
/**
|
|
3616
|
+
* @defaultValue 100
|
|
3617
|
+
*
|
|
3738
3618
|
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3739
3619
|
* launches in favor of the cached value.
|
|
3740
|
-
*
|
|
3741
|
-
* @default 100
|
|
3742
3620
|
*/
|
|
3743
3621
|
defaultLeft: number;
|
|
3744
3622
|
/**
|
|
3623
|
+
* @defaultValue 100
|
|
3624
|
+
*
|
|
3745
3625
|
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3746
3626
|
* launches in favor of the cached value.
|
|
3747
|
-
*
|
|
3748
|
-
* @default 100
|
|
3749
3627
|
*/
|
|
3750
3628
|
defaultTop: number;
|
|
3751
3629
|
/**
|
|
3630
|
+
* @defaultValue 800
|
|
3631
|
+
*
|
|
3752
3632
|
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3753
3633
|
* launches in favor of the cached value.
|
|
3754
|
-
*
|
|
3755
|
-
* @default 800
|
|
3756
3634
|
*/
|
|
3757
3635
|
defaultWidth: number;
|
|
3758
3636
|
/**
|
|
@@ -3763,6 +3641,12 @@ declare type ConstWindowOptions = {
|
|
|
3763
3641
|
*/
|
|
3764
3642
|
downloadShelf: DownloadShelfOptions;
|
|
3765
3643
|
height: number;
|
|
3644
|
+
/**
|
|
3645
|
+
* @defaultValue false
|
|
3646
|
+
* @remarks
|
|
3647
|
+
* When set to `true` the platform will intercept all web notifications and instead raise `notification-intercepted` events.
|
|
3648
|
+
*/
|
|
3649
|
+
interceptNotifications: boolean;
|
|
3766
3650
|
layout: any;
|
|
3767
3651
|
/**
|
|
3768
3652
|
* @experimental
|
|
@@ -3798,19 +3682,19 @@ declare type ConstWindowOptions = {
|
|
|
3798
3682
|
*/
|
|
3799
3683
|
processAffinity: string;
|
|
3800
3684
|
/**
|
|
3685
|
+
* @defaultValue false
|
|
3686
|
+
*
|
|
3801
3687
|
* Displays a shadow on frameless windows.
|
|
3802
3688
|
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
3803
3689
|
* On Windows 7, Aero theme is required.
|
|
3804
|
-
*
|
|
3805
|
-
* @default false
|
|
3806
3690
|
*/
|
|
3807
3691
|
shadow: boolean;
|
|
3808
3692
|
/**
|
|
3693
|
+
* @defaultValue true
|
|
3694
|
+
*
|
|
3809
3695
|
* Caches the location of the window.
|
|
3810
3696
|
*
|
|
3811
3697
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3812
|
-
*
|
|
3813
|
-
* @default true
|
|
3814
3698
|
*/
|
|
3815
3699
|
saveWindowState: boolean;
|
|
3816
3700
|
/**
|
|
@@ -3819,28 +3703,33 @@ declare type ConstWindowOptions = {
|
|
|
3819
3703
|
*/
|
|
3820
3704
|
ignoreSavedWindowState: boolean;
|
|
3821
3705
|
/**
|
|
3706
|
+
* @defaultValue false
|
|
3707
|
+
*
|
|
3822
3708
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3823
3709
|
*
|
|
3824
3710
|
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3825
3711
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3826
|
-
*
|
|
3827
|
-
* @default false
|
|
3828
3712
|
*/
|
|
3829
3713
|
smallWindow: boolean;
|
|
3830
3714
|
/**
|
|
3715
|
+
* @defaultValue "normal"
|
|
3716
|
+
*
|
|
3831
3717
|
* The visible state of the window on creation.
|
|
3832
3718
|
* One of:
|
|
3833
3719
|
* * `"maximized"`
|
|
3834
3720
|
* * `"minimized"`
|
|
3835
3721
|
* * `"normal"`
|
|
3836
|
-
*
|
|
3837
|
-
* @default "normal"
|
|
3838
3722
|
*/
|
|
3839
3723
|
state: WindowState;
|
|
3840
3724
|
/**
|
|
3841
3725
|
* @deprecated - use `icon` instead.
|
|
3842
3726
|
*/
|
|
3843
3727
|
taskbarIcon: string;
|
|
3728
|
+
/**
|
|
3729
|
+
* Specify a taskbar group for the window.
|
|
3730
|
+
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
3731
|
+
*/
|
|
3732
|
+
taskbarIconGroup: string;
|
|
3844
3733
|
/**
|
|
3845
3734
|
* @defaultValue "about:blank"
|
|
3846
3735
|
*
|
|
@@ -3848,20 +3737,20 @@ declare type ConstWindowOptions = {
|
|
|
3848
3737
|
*/
|
|
3849
3738
|
url: string;
|
|
3850
3739
|
/**
|
|
3740
|
+
* @defaultValue <application UUID>
|
|
3741
|
+
*
|
|
3851
3742
|
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
3852
3743
|
* If omitted, defaults to the `uuid` of the application spawning the window.
|
|
3853
3744
|
* If given, must match the `uuid` of the application spawning the window.
|
|
3854
3745
|
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
3855
3746
|
* really no need to provide it.
|
|
3856
|
-
*
|
|
3857
|
-
* @default <application UUID>
|
|
3858
3747
|
*/
|
|
3859
3748
|
uuid: string;
|
|
3860
3749
|
/**
|
|
3750
|
+
* @defaultValue false
|
|
3751
|
+
*
|
|
3861
3752
|
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
|
3862
3753
|
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
|
3863
|
-
*
|
|
3864
|
-
* @default false
|
|
3865
3754
|
*/
|
|
3866
3755
|
waitForPageLoad: boolean;
|
|
3867
3756
|
width: number;
|
|
@@ -3877,10 +3766,6 @@ declare type ConstWindowOptions = {
|
|
|
3877
3766
|
* Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
|
|
3878
3767
|
*/
|
|
3879
3768
|
inheritance?: Partial<InheritableOptions>;
|
|
3880
|
-
/**
|
|
3881
|
-
* Control which options to ignore when creating a Platform Window.
|
|
3882
|
-
*/
|
|
3883
|
-
excludeOptions: ExcludeOptions;
|
|
3884
3769
|
};
|
|
3885
3770
|
|
|
3886
3771
|
/**
|
|
@@ -3891,15 +3776,6 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
|
3891
3776
|
type: 'container-created';
|
|
3892
3777
|
};
|
|
3893
3778
|
|
|
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
3779
|
/**
|
|
3904
3780
|
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
|
3905
3781
|
* @interface
|
|
@@ -3987,9 +3863,12 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3987
3863
|
declare type ContentNavigation = NavigationRules;
|
|
3988
3864
|
|
|
3989
3865
|
/**
|
|
3990
|
-
*
|
|
3866
|
+
* Whether a content url is allowed or blocked for navigation or redirection.
|
|
3867
|
+
*
|
|
3868
|
+
* * 'allow': The content url is allowed.
|
|
3869
|
+
* * 'block': The content url is blocked.
|
|
3991
3870
|
*/
|
|
3992
|
-
declare type ContentPermission =
|
|
3871
|
+
declare type ContentPermission = 'allow' | 'block';
|
|
3993
3872
|
|
|
3994
3873
|
/**
|
|
3995
3874
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
@@ -4120,41 +3999,6 @@ declare type CookieOption = {
|
|
|
4120
3999
|
name: string;
|
|
4121
4000
|
};
|
|
4122
4001
|
|
|
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
4002
|
/**
|
|
4159
4003
|
* Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
|
|
4160
4004
|
* average of _height_ and _width_.
|
|
@@ -4163,15 +4007,15 @@ declare type CopyPermissions = {
|
|
|
4163
4007
|
*/
|
|
4164
4008
|
declare type CornerRounding = {
|
|
4165
4009
|
/**
|
|
4166
|
-
*
|
|
4010
|
+
* @defaultValue 0
|
|
4167
4011
|
*
|
|
4168
|
-
*
|
|
4012
|
+
* The height in pixels.
|
|
4169
4013
|
*/
|
|
4170
4014
|
height: number;
|
|
4171
4015
|
/**
|
|
4172
|
-
*
|
|
4016
|
+
* @defaultValue 0
|
|
4173
4017
|
*
|
|
4174
|
-
*
|
|
4018
|
+
* The width in pixels.
|
|
4175
4019
|
*/
|
|
4176
4020
|
width: number;
|
|
4177
4021
|
};
|
|
@@ -4261,6 +4105,8 @@ declare type CreateLayoutOptions = {
|
|
|
4261
4105
|
layoutName: string;
|
|
4262
4106
|
layout: LayoutOptions;
|
|
4263
4107
|
/**
|
|
4108
|
+
* @defaultValue 'default'
|
|
4109
|
+
*
|
|
4264
4110
|
* Controls the View behavior for the given `layout` property. Note
|
|
4265
4111
|
* that the selected behavior only applies to unnamed Views or
|
|
4266
4112
|
* Views with the prefix `internal-generated-`. In all cases, if any
|
|
@@ -4282,8 +4128,6 @@ declare type CreateLayoutOptions = {
|
|
|
4282
4128
|
* override. Note that during applyLayoutSnapshot, Views are created and
|
|
4283
4129
|
* attached to the Provider while the Window is being created, so it's
|
|
4284
4130
|
* important to not 'duplicate' Views in this workflow.
|
|
4285
|
-
*
|
|
4286
|
-
* @default 'default'
|
|
4287
4131
|
*/
|
|
4288
4132
|
multiInstanceViewBehavior?: MultiInstanceViewBehavior;
|
|
4289
4133
|
};
|
|
@@ -4382,7 +4226,6 @@ declare type DefaultDomainSettings = DomainSettings;
|
|
|
4382
4226
|
|
|
4383
4227
|
/**
|
|
4384
4228
|
* @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
|
|
4385
|
-
* @interface
|
|
4386
4229
|
*/
|
|
4387
4230
|
declare type DefaultDomainSettingsRule = DomainSettingsRule;
|
|
4388
4231
|
|
|
@@ -4543,7 +4386,7 @@ declare type DomainApiSettings = {
|
|
|
4543
4386
|
* * 'none': The `fin` API will be not available.
|
|
4544
4387
|
* * 'global': The entire `fin` API will be available.
|
|
4545
4388
|
*
|
|
4546
|
-
* @
|
|
4389
|
+
* @defaultValue 'global'
|
|
4547
4390
|
*/
|
|
4548
4391
|
fin?: InjectionType;
|
|
4549
4392
|
/**
|
|
@@ -4559,9 +4402,8 @@ declare type DomainApiSettings = {
|
|
|
4559
4402
|
* @interface
|
|
4560
4403
|
* Defines application settings that vary by the domain of the current context.
|
|
4561
4404
|
*
|
|
4562
|
-
* @remarks
|
|
4563
|
-
*
|
|
4564
|
-
* exists.
|
|
4405
|
+
* @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
|
|
4406
|
+
* domain should be represented with a single rule.
|
|
4565
4407
|
*/
|
|
4566
4408
|
declare type DomainSettings = {
|
|
4567
4409
|
/**
|
|
@@ -4576,22 +4418,19 @@ declare type DomainSettings = {
|
|
|
4576
4418
|
* more information, see the documentation for the individual properties.
|
|
4577
4419
|
*/
|
|
4578
4420
|
default?: PerDomainSettings;
|
|
4579
|
-
/**
|
|
4580
|
-
* {@inheritDoc MultipleDomainMatchBehavior}
|
|
4581
|
-
*/
|
|
4582
|
-
multipleMatchBehavior?: MultipleDomainMatchBehavior;
|
|
4583
4421
|
};
|
|
4584
4422
|
|
|
4585
4423
|
/**
|
|
4586
|
-
* Defines domain-conditional settings for an OpenFin application.
|
|
4587
4424
|
* @interface
|
|
4425
|
+
*
|
|
4426
|
+
* Defines domain-conditional settings for an OpenFin application.
|
|
4588
4427
|
*/
|
|
4589
4428
|
declare type DomainSettingsRule = {
|
|
4590
4429
|
/**
|
|
4591
4430
|
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4592
4431
|
* the domain(s) for which the rule applies.
|
|
4593
4432
|
*/
|
|
4594
|
-
match
|
|
4433
|
+
match?: string[];
|
|
4595
4434
|
/**
|
|
4596
4435
|
* Settings applied when a webcontents has been navigated to a matched domain.
|
|
4597
4436
|
*/
|
|
@@ -4767,15 +4606,6 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4767
4606
|
type: EventType;
|
|
4768
4607
|
}>, ...args: any[]) => boolean;
|
|
4769
4608
|
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
4609
|
private getOrCreateEmitter;
|
|
4780
4610
|
listeners: (type: string | symbol) => Function[];
|
|
4781
4611
|
listenerCount: (type: string | symbol) => number;
|
|
@@ -4942,7 +4772,6 @@ declare interface Environment {
|
|
|
4942
4772
|
getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
|
|
4943
4773
|
fdc3Version?: Version;
|
|
4944
4774
|
}>;
|
|
4945
|
-
getViewWindowIdentity(fin: OpenFin.Fin<OpenFin.EntityType>, identity: OpenFin.Identity): Promise<OpenFin.Identity>;
|
|
4946
4775
|
readonly type: EnvironmentType;
|
|
4947
4776
|
}
|
|
4948
4777
|
|
|
@@ -4976,7 +4805,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
|
|
|
4976
4805
|
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
4977
4806
|
* from which they propagate).
|
|
4978
4807
|
*/
|
|
4979
|
-
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent |
|
|
4808
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | NotificationCloseRequested;
|
|
4980
4809
|
|
|
4981
4810
|
/**
|
|
4982
4811
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
|
|
@@ -5016,7 +4845,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
|
5016
4845
|
*/
|
|
5017
4846
|
declare type Event_5<Topic extends string> = {
|
|
5018
4847
|
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 |
|
|
4848
|
+
} & (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 | NotificationInterceptedEvent);
|
|
5020
4849
|
|
|
5021
4850
|
/**
|
|
5022
4851
|
* [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
|
|
@@ -5130,18 +4959,6 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
|
|
|
5130
4959
|
appVersionId: string;
|
|
5131
4960
|
} : never;
|
|
5132
4961
|
|
|
5133
|
-
/**
|
|
5134
|
-
* @interface
|
|
5135
|
-
*/
|
|
5136
|
-
declare type ExcludeOptions = {
|
|
5137
|
-
/**
|
|
5138
|
-
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
|
5139
|
-
*
|
|
5140
|
-
* @default false
|
|
5141
|
-
*/
|
|
5142
|
-
preloadScripts: boolean;
|
|
5143
|
-
};
|
|
5144
|
-
|
|
5145
4962
|
/**
|
|
5146
4963
|
* @internal
|
|
5147
4964
|
*
|
|
@@ -5166,140 +4983,41 @@ declare type ExitCode = {
|
|
|
5166
4983
|
exitCode: number;
|
|
5167
4984
|
};
|
|
5168
4985
|
|
|
5169
|
-
|
|
4986
|
+
/**
|
|
4987
|
+
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
|
4988
|
+
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
|
4989
|
+
* Discovery of connections is provided by {@link System.System.getAllExternalApplications getAllExternalApplications}.</a>
|
|
4990
|
+
*
|
|
4991
|
+
* Processes that can be wrapped as `ExternalApplication`s include the following:
|
|
4992
|
+
* - Processes which have connected to an OpenFin runtime via an adapter
|
|
4993
|
+
* - Processes started via `System.launchExternalApplication`
|
|
4994
|
+
* - Processes monitored via `System.monitorExternalProcess`
|
|
4995
|
+
*/
|
|
4996
|
+
declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicationEvent> {
|
|
4997
|
+
identity: OpenFin.ApplicationIdentity;
|
|
5170
4998
|
/**
|
|
5171
|
-
*
|
|
4999
|
+
* @internal
|
|
5172
5000
|
*/
|
|
5173
|
-
|
|
5174
|
-
|
|
5001
|
+
constructor(wire: Transport, identity: OpenFin.ApplicationIdentity);
|
|
5002
|
+
/**
|
|
5003
|
+
* Retrieves information about the external application.
|
|
5004
|
+
*
|
|
5005
|
+
* @example
|
|
5006
|
+
* ```js
|
|
5007
|
+
* async function getInfo() {
|
|
5008
|
+
* const extApp = await fin.ExternalApplication.wrap('javaApp-uuid');
|
|
5009
|
+
* return await extApp.getInfo();
|
|
5010
|
+
* }
|
|
5011
|
+
* getInfo().then(info => console.log(info)).catch(err => console.log(err));
|
|
5012
|
+
* ```
|
|
5013
|
+
*/
|
|
5014
|
+
getInfo(): Promise<OpenFin.ExternalApplicationInfo>;
|
|
5015
|
+
}
|
|
5175
5016
|
|
|
5176
5017
|
/**
|
|
5177
|
-
* @
|
|
5018
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
|
5178
5019
|
*/
|
|
5179
|
-
declare type
|
|
5180
|
-
extensionId: string;
|
|
5181
|
-
name: string;
|
|
5182
|
-
enabled: boolean;
|
|
5183
|
-
};
|
|
5184
|
-
|
|
5185
|
-
/**
|
|
5186
|
-
* An event that fires when an extension is installed in the security realm.
|
|
5187
|
-
*
|
|
5188
|
-
* @interface
|
|
5189
|
-
*/
|
|
5190
|
-
declare type ExtensionInstalledEvent = ExtensionEvent & {
|
|
5191
|
-
type: 'extension-installed';
|
|
5192
|
-
};
|
|
5193
|
-
|
|
5194
|
-
/**
|
|
5195
|
-
* An event that fires when an extension fails to install in the security realm.
|
|
5196
|
-
*
|
|
5197
|
-
* @interface
|
|
5198
|
-
*/
|
|
5199
|
-
declare type ExtensionInstallFailedEvent = ExtensionEvent & {
|
|
5200
|
-
type: 'extension-install-failed';
|
|
5201
|
-
};
|
|
5202
|
-
|
|
5203
|
-
/**
|
|
5204
|
-
* An event that fires when extensions are disabled in the security realm.
|
|
5205
|
-
*
|
|
5206
|
-
* @interface
|
|
5207
|
-
*/
|
|
5208
|
-
declare type ExtensionsDisabledEvent = ExtensionsEvent & {
|
|
5209
|
-
type: 'extensions-disabled';
|
|
5210
|
-
};
|
|
5211
|
-
|
|
5212
|
-
/**
|
|
5213
|
-
* An event that fires when extensions are enabled in the security realm.
|
|
5214
|
-
*
|
|
5215
|
-
* @interface
|
|
5216
|
-
*/
|
|
5217
|
-
declare type ExtensionsEnabledEvent = ExtensionsEvent & {
|
|
5218
|
-
type: 'extensions-enabled';
|
|
5219
|
-
};
|
|
5220
|
-
|
|
5221
|
-
declare type ExtensionsEvent = SecurityRealmEvent & {
|
|
5222
|
-
/**
|
|
5223
|
-
* Runtime extensions whose status has been (possibly) modified
|
|
5224
|
-
*/
|
|
5225
|
-
extensions: string[];
|
|
5226
|
-
};
|
|
5227
|
-
|
|
5228
|
-
/**
|
|
5229
|
-
* An event that fires when requested extensions are not allowed to be installed in the security realm.
|
|
5230
|
-
*
|
|
5231
|
-
* @interface
|
|
5232
|
-
*/
|
|
5233
|
-
declare type ExtensionsExcludedEvent = ExtensionsEvent & {
|
|
5234
|
-
type: 'extensions-excluded';
|
|
5235
|
-
};
|
|
5236
|
-
|
|
5237
|
-
/**
|
|
5238
|
-
* An event that fires when extension initialization fails on initial app launch. Users may attempt to
|
|
5239
|
-
* re-initialize extensions by calling {@link System.refreshExtensions}. This event will not fire in response
|
|
5240
|
-
* to manual extension refreshes (users should catch the error normally).
|
|
5241
|
-
*/
|
|
5242
|
-
declare type ExtensionsInitializationFailedEvent = Omit<ExtensionsEvent, 'extensions'> & {
|
|
5243
|
-
type: 'extensions-initialization-failed';
|
|
5244
|
-
/**
|
|
5245
|
-
* The error that caused the extension initialization failure
|
|
5246
|
-
*/
|
|
5247
|
-
error: Error;
|
|
5248
|
-
};
|
|
5249
|
-
|
|
5250
|
-
/**
|
|
5251
|
-
* An event that fires when extensions are installed in the security realm.
|
|
5252
|
-
*
|
|
5253
|
-
* @interface
|
|
5254
|
-
*/
|
|
5255
|
-
declare type ExtensionsInstalledEvent = ExtensionsEvent & {
|
|
5256
|
-
type: 'extensions-installed';
|
|
5257
|
-
};
|
|
5258
|
-
|
|
5259
|
-
/**
|
|
5260
|
-
* An event that fires when extensions fail to install in the security realm.
|
|
5261
|
-
*
|
|
5262
|
-
* @interface
|
|
5263
|
-
*/
|
|
5264
|
-
declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
|
|
5265
|
-
type: 'extensions-install-failed';
|
|
5266
|
-
};
|
|
5267
|
-
|
|
5268
|
-
/**
|
|
5269
|
-
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
|
5270
|
-
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
|
5271
|
-
* Discovery of connections is provided by {@link System.System.getAllExternalApplications getAllExternalApplications}.</a>
|
|
5272
|
-
*
|
|
5273
|
-
* Processes that can be wrapped as `ExternalApplication`s include the following:
|
|
5274
|
-
* - Processes which have connected to an OpenFin runtime via an adapter
|
|
5275
|
-
* - Processes started via `System.launchExternalApplication`
|
|
5276
|
-
* - Processes monitored via `System.monitorExternalProcess`
|
|
5277
|
-
*/
|
|
5278
|
-
declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicationEvent> {
|
|
5279
|
-
identity: OpenFin.ApplicationIdentity;
|
|
5280
|
-
/**
|
|
5281
|
-
* @internal
|
|
5282
|
-
*/
|
|
5283
|
-
constructor(wire: Transport, identity: OpenFin.ApplicationIdentity);
|
|
5284
|
-
/**
|
|
5285
|
-
* Retrieves information about the external application.
|
|
5286
|
-
*
|
|
5287
|
-
* @example
|
|
5288
|
-
* ```js
|
|
5289
|
-
* async function getInfo() {
|
|
5290
|
-
* const extApp = await fin.ExternalApplication.wrap('javaApp-uuid');
|
|
5291
|
-
* return await extApp.getInfo();
|
|
5292
|
-
* }
|
|
5293
|
-
* getInfo().then(info => console.log(info)).catch(err => console.log(err));
|
|
5294
|
-
* ```
|
|
5295
|
-
*/
|
|
5296
|
-
getInfo(): Promise<OpenFin.ExternalApplicationInfo>;
|
|
5297
|
-
}
|
|
5298
|
-
|
|
5299
|
-
/**
|
|
5300
|
-
* @deprecated Renamed to {@link ConnectedEvent}.
|
|
5301
|
-
*/
|
|
5302
|
-
declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
|
|
5020
|
+
declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
|
|
5303
5021
|
|
|
5304
5022
|
/**
|
|
5305
5023
|
* @deprecated Renamed to {@link DisconnectedEvent}.
|
|
@@ -5457,10 +5175,6 @@ declare namespace FDC3 {
|
|
|
5457
5175
|
}
|
|
5458
5176
|
}
|
|
5459
5177
|
|
|
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
5178
|
export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
|
|
5465
5179
|
fdc3Version?: Fdc3Version;
|
|
5466
5180
|
}): Promise<Fdc3Module | Fdc3Module2>;
|
|
@@ -5915,7 +5629,6 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
|
5915
5629
|
* Domain-conditional rules for file downloads.
|
|
5916
5630
|
*
|
|
5917
5631
|
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
|
5918
|
-
* @interface
|
|
5919
5632
|
*/
|
|
5920
5633
|
declare type FileDownloadSettings = {
|
|
5921
5634
|
/**
|
|
@@ -5968,34 +5681,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
5968
5681
|
*/
|
|
5969
5682
|
declare type FindInPageOptions = {
|
|
5970
5683
|
/**
|
|
5971
|
-
*
|
|
5684
|
+
* @defaultValue true
|
|
5972
5685
|
*
|
|
5973
|
-
*
|
|
5686
|
+
* Searches in the forward direction (backward otherwise)
|
|
5974
5687
|
*/
|
|
5975
5688
|
forward?: boolean;
|
|
5976
5689
|
/**
|
|
5977
|
-
*
|
|
5690
|
+
* @defaultValue false
|
|
5978
5691
|
*
|
|
5979
|
-
*
|
|
5692
|
+
* Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
|
|
5980
5693
|
*/
|
|
5981
5694
|
findNext?: boolean;
|
|
5982
5695
|
/**
|
|
5983
|
-
*
|
|
5696
|
+
* @defaultValue false
|
|
5984
5697
|
*
|
|
5985
|
-
*
|
|
5698
|
+
* Enables case-sensitive searching.
|
|
5986
5699
|
*/
|
|
5987
5700
|
matchCase?: boolean;
|
|
5988
5701
|
/**
|
|
5989
|
-
*
|
|
5702
|
+
* @defaultValue false
|
|
5990
5703
|
*
|
|
5991
|
-
*
|
|
5704
|
+
* Only searches from the start of words.
|
|
5992
5705
|
*/
|
|
5993
5706
|
wordStart?: boolean;
|
|
5994
5707
|
/**
|
|
5708
|
+
* @defaultValue false
|
|
5709
|
+
*
|
|
5995
5710
|
* 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
5711
|
* lowercase or non-letter. Accepts several other intra-word matches.
|
|
5997
|
-
*
|
|
5998
|
-
* @default false
|
|
5999
5712
|
*/
|
|
6000
5713
|
medialCapitalAsWordStart?: boolean;
|
|
6001
5714
|
};
|
|
@@ -6147,8 +5860,11 @@ declare type FrameEventType = EventType_5;
|
|
|
6147
5860
|
/**
|
|
6148
5861
|
* @interface
|
|
6149
5862
|
*/
|
|
6150
|
-
declare type FrameInfo =
|
|
5863
|
+
declare type FrameInfo = {
|
|
5864
|
+
name: string;
|
|
5865
|
+
uuid: string;
|
|
6151
5866
|
url: string;
|
|
5867
|
+
entityType: EntityType_4;
|
|
6152
5868
|
parent: Identity_4;
|
|
6153
5869
|
};
|
|
6154
5870
|
|
|
@@ -6224,30 +5940,6 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
|
6224
5940
|
entityType: string;
|
|
6225
5941
|
};
|
|
6226
5942
|
|
|
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
5943
|
/**
|
|
6252
5944
|
* @interface
|
|
6253
5945
|
*/
|
|
@@ -6509,9 +6201,9 @@ declare type Hotkey = {
|
|
|
6509
6201
|
*/
|
|
6510
6202
|
keys: string;
|
|
6511
6203
|
/**
|
|
6512
|
-
*
|
|
6204
|
+
* @defaultValue false
|
|
6513
6205
|
*
|
|
6514
|
-
*
|
|
6206
|
+
* Prevent default key handling before emitting the event.
|
|
6515
6207
|
*/
|
|
6516
6208
|
preventDefault?: boolean;
|
|
6517
6209
|
};
|
|
@@ -7482,7 +7174,7 @@ declare class InteropBroker extends Base {
|
|
|
7482
7174
|
};
|
|
7483
7175
|
private getClientState;
|
|
7484
7176
|
private static toObject;
|
|
7485
|
-
static checkContextIntegrity
|
|
7177
|
+
static checkContextIntegrity(context: OpenFin.Context): {
|
|
7486
7178
|
isValid: true;
|
|
7487
7179
|
} | {
|
|
7488
7180
|
isValid: false;
|
|
@@ -7581,7 +7273,7 @@ declare class InteropClient extends Base {
|
|
|
7581
7273
|
/**
|
|
7582
7274
|
* @internal
|
|
7583
7275
|
*/
|
|
7584
|
-
constructor(wire: Transport, clientPromise: Promise<OpenFin.ChannelClient
|
|
7276
|
+
constructor(wire: Transport, clientPromise: Promise<OpenFin.ChannelClient>);
|
|
7585
7277
|
/**
|
|
7586
7278
|
* Sets a context for the context group of the current entity.
|
|
7587
7279
|
*
|
|
@@ -8184,7 +7876,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
8184
7876
|
*
|
|
8185
7877
|
* @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
|
|
8186
7878
|
*
|
|
8187
|
-
* ####
|
|
7879
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
|
|
8188
7880
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
8189
7881
|
* @example
|
|
8190
7882
|
* ```js
|
|
@@ -8201,7 +7893,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
8201
7893
|
* });
|
|
8202
7894
|
* ```
|
|
8203
7895
|
*
|
|
8204
|
-
* ####
|
|
7896
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
|
|
8205
7897
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
8206
7898
|
* @example
|
|
8207
7899
|
* ```js
|
|
@@ -8300,10 +7992,6 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
8300
7992
|
*/
|
|
8301
7993
|
declare class Layout extends Base {
|
|
8302
7994
|
#private;
|
|
8303
|
-
/**
|
|
8304
|
-
* @internal
|
|
8305
|
-
*/
|
|
8306
|
-
static getClient(layout: Layout): Promise<LayoutEntitiesClient>;
|
|
8307
7995
|
/**
|
|
8308
7996
|
* @internal
|
|
8309
7997
|
*/
|
|
@@ -8409,17 +8097,6 @@ declare class Layout extends Base {
|
|
|
8409
8097
|
* ```
|
|
8410
8098
|
*/
|
|
8411
8099
|
getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
|
|
8412
|
-
/**
|
|
8413
|
-
* Retrieves the OpenFin.TabStack instance which the View belongs to.
|
|
8414
|
-
*
|
|
8415
|
-
* @example
|
|
8416
|
-
* ```js
|
|
8417
|
-
* const viewIdentity = { uuid: 'uuid', name: 'view-name' };
|
|
8418
|
-
* const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
|
|
8419
|
-
* console.log(await stack.getViews());
|
|
8420
|
-
* ```
|
|
8421
|
-
*/
|
|
8422
|
-
getStackByViewIdentity(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
|
|
8423
8100
|
/**
|
|
8424
8101
|
* Replaces the specified view with a view with the provided configuration.
|
|
8425
8102
|
*
|
|
@@ -8473,29 +8150,6 @@ declare class Layout extends Base {
|
|
|
8473
8150
|
* ```
|
|
8474
8151
|
*/
|
|
8475
8152
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
|
8476
|
-
/**
|
|
8477
|
-
* Adds a view to the platform layout. Behaves like {@link Platform#createView Platform.createView} with the current layout as the target.
|
|
8478
|
-
*
|
|
8479
|
-
* @param viewOptions - The options for creating the view.
|
|
8480
|
-
* @param options - Optional parameters for adding the view.
|
|
8481
|
-
* @param options.location - The location where the view should be added.
|
|
8482
|
-
* @param options.targetView - The target view to which the new view should be added.
|
|
8483
|
-
* @returns A promise that resolves to an object containing the identity of the added view.
|
|
8484
|
-
*/
|
|
8485
|
-
addView(viewOptions: OpenFin.PlatformViewCreationOptions, { location, targetView }?: {
|
|
8486
|
-
location?: OpenFin.CreateViewTarget['location'];
|
|
8487
|
-
targetView?: OpenFin.Identity;
|
|
8488
|
-
}): Promise<{
|
|
8489
|
-
identity: OpenFin.Identity;
|
|
8490
|
-
}>;
|
|
8491
|
-
/**
|
|
8492
|
-
* Closes a view by its identity. Throws an error if the view does not belong to the current layout.
|
|
8493
|
-
* Behaves like {@link Platform#closeView Platform.closeView} but only closes the view if it belongs the current layout.
|
|
8494
|
-
*
|
|
8495
|
-
* @param viewIdentity - The identity of the view to close.
|
|
8496
|
-
* @returns A promise that resolves when the view is closed.
|
|
8497
|
-
*/
|
|
8498
|
-
closeView(viewIdentity: OpenFin.Identity): Promise<void>;
|
|
8499
8153
|
}
|
|
8500
8154
|
|
|
8501
8155
|
/**
|
|
@@ -8508,7 +8162,7 @@ declare type LayoutColumn = LayoutItemConfig & {
|
|
|
8508
8162
|
/**
|
|
8509
8163
|
* @interface
|
|
8510
8164
|
*/
|
|
8511
|
-
declare type LayoutComponent =
|
|
8165
|
+
declare type LayoutComponent = LayoutItemConfig & {
|
|
8512
8166
|
/**
|
|
8513
8167
|
* Only a component type will have this property and it should be set to view.
|
|
8514
8168
|
*/
|
|
@@ -8517,7 +8171,6 @@ declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
|
|
|
8517
8171
|
* Only a component type will have this property and it represents the view options of a given component.
|
|
8518
8172
|
*/
|
|
8519
8173
|
componentState?: Partial<ViewCreationOptions>;
|
|
8520
|
-
type: 'component';
|
|
8521
8174
|
};
|
|
8522
8175
|
|
|
8523
8176
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
|
@@ -8601,7 +8254,10 @@ declare type LayoutIdentity = Identity_4 & {
|
|
|
8601
8254
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
|
8602
8255
|
type: 'layout-initialized';
|
|
8603
8256
|
layoutIdentity: OpenFin.LayoutIdentity;
|
|
8604
|
-
ofViews:
|
|
8257
|
+
ofViews: {
|
|
8258
|
+
identity: OpenFin.Identity;
|
|
8259
|
+
entityType: 'view';
|
|
8260
|
+
}[];
|
|
8605
8261
|
};
|
|
8606
8262
|
|
|
8607
8263
|
/**
|
|
@@ -8709,7 +8365,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8709
8365
|
/**
|
|
8710
8366
|
* @experimental
|
|
8711
8367
|
*/
|
|
8712
|
-
getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity
|
|
8368
|
+
getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
|
|
8713
8369
|
/**
|
|
8714
8370
|
* @experimental
|
|
8715
8371
|
*/
|
|
@@ -8810,17 +8466,6 @@ declare class LayoutModule extends Base {
|
|
|
8810
8466
|
* ```
|
|
8811
8467
|
*/
|
|
8812
8468
|
getCurrentSync(): OpenFin.Layout;
|
|
8813
|
-
/**
|
|
8814
|
-
* Retrieves the OpenFin.Layout instance for the Window the View is attached to.
|
|
8815
|
-
*
|
|
8816
|
-
* @example
|
|
8817
|
-
* ```js
|
|
8818
|
-
* const viewIdentity = { uuid: 'uuid', name: 'view-name' };
|
|
8819
|
-
* const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
|
|
8820
|
-
* console.log(await layout.getCurrentViews());
|
|
8821
|
-
* ```
|
|
8822
|
-
*/
|
|
8823
|
-
getLayoutByViewIdentity(viewIdentity: OpenFin.Identity): Promise<OpenFin.Layout>;
|
|
8824
8469
|
/**
|
|
8825
8470
|
* Initialize the window's Layout.
|
|
8826
8471
|
*
|
|
@@ -9052,79 +8697,77 @@ declare type LayoutOptions = {
|
|
|
9052
8697
|
*/
|
|
9053
8698
|
settings?: {
|
|
9054
8699
|
/**
|
|
9055
|
-
*
|
|
8700
|
+
* @defaultValue false
|
|
9056
8701
|
*
|
|
9057
|
-
*
|
|
8702
|
+
* When true the splitters will not be draggable and the layout will not resize.
|
|
9058
8703
|
*/
|
|
9059
8704
|
preventSplitterResize?: boolean;
|
|
9060
8705
|
/**
|
|
8706
|
+
* @defaultValue false
|
|
8707
|
+
*
|
|
9061
8708
|
* Whether the popout button will only act on the entire stack,
|
|
9062
8709
|
* as opposed to only the active tab.
|
|
9063
|
-
*
|
|
9064
|
-
* @default false
|
|
9065
8710
|
*/
|
|
9066
8711
|
popoutWholeStack?: boolean;
|
|
9067
8712
|
/**
|
|
8713
|
+
* @defaultValue false
|
|
8714
|
+
*
|
|
9068
8715
|
* Limits the area to which tabs can be dragged.
|
|
9069
8716
|
* If true, the layout container is the only area where tabs can be dropped.
|
|
9070
|
-
*
|
|
9071
|
-
* @default false
|
|
9072
8717
|
*/
|
|
9073
8718
|
constrainDragToContainer?: boolean;
|
|
9074
8719
|
/**
|
|
8720
|
+
* @defaultValue false
|
|
8721
|
+
*
|
|
9075
8722
|
* Whether to show the popout button on stack header.
|
|
9076
8723
|
* The button will create a new window with current tab as its content.
|
|
9077
8724
|
* In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
|
|
9078
|
-
*
|
|
9079
|
-
* @default false
|
|
9080
8725
|
*/
|
|
9081
8726
|
showPopoutIcon?: boolean;
|
|
9082
8727
|
/**
|
|
8728
|
+
* @defaultValue false
|
|
8729
|
+
*
|
|
9083
8730
|
* Whether to show the maximize button on stack header.
|
|
9084
8731
|
* The button will maximize the current tab to fill the entire window.
|
|
9085
|
-
*
|
|
9086
|
-
* @default false
|
|
9087
8732
|
*/
|
|
9088
8733
|
showMaximiseIcon?: boolean;
|
|
9089
8734
|
/**
|
|
8735
|
+
* @defaultValue false
|
|
8736
|
+
*
|
|
9090
8737
|
* Whether to show the close button on stack header
|
|
9091
8738
|
* (not to be confused with close button on every tab).
|
|
9092
|
-
*
|
|
9093
|
-
* @default false
|
|
9094
8739
|
*/
|
|
9095
8740
|
showCloseIcon?: boolean;
|
|
9096
8741
|
/**
|
|
9097
|
-
*
|
|
8742
|
+
* @defaultValue false
|
|
9098
8743
|
*
|
|
9099
|
-
*
|
|
8744
|
+
* Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
|
|
9100
8745
|
*/
|
|
9101
8746
|
constrainDragToHeaders?: boolean;
|
|
9102
8747
|
/**
|
|
8748
|
+
* @defaultValue true
|
|
8749
|
+
*
|
|
9103
8750
|
* Turns tab headers on or off.
|
|
9104
8751
|
* If false, the layout will be displayed with splitters only.
|
|
9105
|
-
*
|
|
9106
|
-
* @default true
|
|
9107
8752
|
*/
|
|
9108
8753
|
hasHeaders?: boolean;
|
|
9109
8754
|
/**
|
|
8755
|
+
* @defaultValue true
|
|
8756
|
+
*
|
|
9110
8757
|
* If true, the user can re-arrange the layout by
|
|
9111
8758
|
* dragging items by their tabs to the desired location.
|
|
9112
|
-
*
|
|
9113
|
-
* @default true
|
|
9114
8759
|
*/
|
|
9115
8760
|
reorderEnabled?: boolean;
|
|
9116
8761
|
/**
|
|
9117
|
-
*
|
|
8762
|
+
* @defaultValue false
|
|
9118
8763
|
*
|
|
9119
|
-
*
|
|
8764
|
+
* If true, tabs can't be dragged out of the window.
|
|
9120
8765
|
*/
|
|
9121
8766
|
preventDragOut?: boolean;
|
|
9122
8767
|
/**
|
|
9123
8768
|
* @defaultValue=false
|
|
9124
8769
|
*
|
|
9125
8770
|
* If true, tabs can't be dragged into the window.
|
|
9126
|
-
*
|
|
9127
|
-
* @default false
|
|
9128
8771
|
*/
|
|
9129
8772
|
preventDragIn?: boolean;
|
|
9130
8773
|
};
|
|
@@ -9546,19 +9189,6 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
|
|
|
9546
9189
|
*/
|
|
9547
9190
|
declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
|
|
9548
9191
|
|
|
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
9192
|
/**
|
|
9563
9193
|
* @interface
|
|
9564
9194
|
*/
|
|
@@ -9567,10 +9197,10 @@ declare type MutableViewOptions = {
|
|
|
9567
9197
|
/**
|
|
9568
9198
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9569
9199
|
*
|
|
9200
|
+
* @defaultValue true
|
|
9201
|
+
*
|
|
9570
9202
|
* Show the context menu when right-clicking on the view.
|
|
9571
9203
|
* Gives access to the devtools for the view.
|
|
9572
|
-
*
|
|
9573
|
-
* @default true
|
|
9574
9204
|
*/
|
|
9575
9205
|
contextMenu: boolean;
|
|
9576
9206
|
/**
|
|
@@ -9617,25 +9247,24 @@ declare type MutableViewOptions = {
|
|
|
9617
9247
|
contentNavigation: ContentNavigation;
|
|
9618
9248
|
contentRedirect: ContentRedirect;
|
|
9619
9249
|
/**
|
|
9250
|
+
* @defaultValue false
|
|
9620
9251
|
* @deprecated
|
|
9621
9252
|
* **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
|
|
9622
9253
|
* 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
9254
|
*/
|
|
9626
9255
|
detachOnClose: boolean;
|
|
9627
9256
|
/**
|
|
9257
|
+
* @defaultValue true
|
|
9258
|
+
*
|
|
9628
9259
|
* **Platforms Only.** If false, the view will be persistent and can't be closed through
|
|
9629
9260
|
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
|
9630
9261
|
* if the view isn't part of the new layout when running `Layout.replace`.
|
|
9631
|
-
*
|
|
9632
|
-
* @default true
|
|
9633
9262
|
*/
|
|
9634
9263
|
isClosable: boolean;
|
|
9635
9264
|
/**
|
|
9636
|
-
*
|
|
9265
|
+
* @defaultValue false
|
|
9637
9266
|
*
|
|
9638
|
-
*
|
|
9267
|
+
* **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
|
9639
9268
|
*/
|
|
9640
9269
|
preventDragOut: boolean;
|
|
9641
9270
|
interop?: InteropConfig;
|
|
@@ -9647,13 +9276,9 @@ declare type MutableViewOptions = {
|
|
|
9647
9276
|
/**
|
|
9648
9277
|
* {@inheritDoc ViewThrottling}
|
|
9649
9278
|
*
|
|
9650
|
-
* @
|
|
9279
|
+
* @defaultValue 'enabled'
|
|
9651
9280
|
*/
|
|
9652
9281
|
throttling: ViewThrottling;
|
|
9653
|
-
/**
|
|
9654
|
-
* {@inheritDoc ChromiumPolicies}
|
|
9655
|
-
*/
|
|
9656
|
-
chromiumPolicies: ChromiumPolicies;
|
|
9657
9282
|
};
|
|
9658
9283
|
|
|
9659
9284
|
/**
|
|
@@ -9666,7 +9291,7 @@ declare type MutableWindowOptions = {
|
|
|
9666
9291
|
* Turns anything of matching RGB value transparent.
|
|
9667
9292
|
*
|
|
9668
9293
|
* Caveats:
|
|
9669
|
-
* *
|
|
9294
|
+
* * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
|
|
9670
9295
|
* * User cannot click-through transparent regions
|
|
9671
9296
|
* * Not supported on Mac
|
|
9672
9297
|
* * Windows Aero must be enabled
|
|
@@ -9675,25 +9300,25 @@ declare type MutableWindowOptions = {
|
|
|
9675
9300
|
*/
|
|
9676
9301
|
alphaMask: RGB;
|
|
9677
9302
|
/**
|
|
9678
|
-
*
|
|
9303
|
+
* @defaultValue false
|
|
9679
9304
|
*
|
|
9680
|
-
*
|
|
9305
|
+
* Always position the window at the top of the window stack.
|
|
9681
9306
|
*/
|
|
9682
9307
|
alwaysOnTop: boolean;
|
|
9683
9308
|
/**
|
|
9309
|
+
* @defaultValue 0
|
|
9310
|
+
*
|
|
9684
9311
|
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
|
9685
9312
|
* an aspect ratio will not be enforced.
|
|
9686
|
-
*
|
|
9687
|
-
* @default 0
|
|
9688
9313
|
*/
|
|
9689
9314
|
aspectRatio: number;
|
|
9690
9315
|
/**
|
|
9691
9316
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9692
9317
|
*
|
|
9318
|
+
* @defaultValue true
|
|
9319
|
+
*
|
|
9693
9320
|
* Show the context menu when right-clicking on the window.
|
|
9694
9321
|
* Gives access to the devtools for the window.
|
|
9695
|
-
*
|
|
9696
|
-
* @default true
|
|
9697
9322
|
*/
|
|
9698
9323
|
contextMenu: boolean;
|
|
9699
9324
|
/**
|
|
@@ -9763,14 +9388,12 @@ declare type MutableWindowOptions = {
|
|
|
9763
9388
|
* @defaultValue true
|
|
9764
9389
|
*
|
|
9765
9390
|
* Show the window's frame.
|
|
9766
|
-
*
|
|
9767
|
-
* @default true
|
|
9768
9391
|
*/
|
|
9769
9392
|
frame: boolean;
|
|
9770
9393
|
/**
|
|
9771
|
-
*
|
|
9394
|
+
* @defaultValue false
|
|
9772
9395
|
*
|
|
9773
|
-
*
|
|
9396
|
+
* Hides the window instead of closing it when the close button is pressed.
|
|
9774
9397
|
*/
|
|
9775
9398
|
hideOnClose: boolean;
|
|
9776
9399
|
/**
|
|
@@ -9823,61 +9446,60 @@ declare type MutableWindowOptions = {
|
|
|
9823
9446
|
*/
|
|
9824
9447
|
icon: string;
|
|
9825
9448
|
/**
|
|
9449
|
+
* @defaultValue true
|
|
9450
|
+
*
|
|
9826
9451
|
* Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
|
9827
9452
|
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
|
9828
|
-
*
|
|
9829
|
-
* @default true
|
|
9830
9453
|
*/
|
|
9831
9454
|
includeInSnapshots: boolean;
|
|
9832
9455
|
/**
|
|
9833
|
-
*
|
|
9456
|
+
* @defaultValue -1
|
|
9834
9457
|
*
|
|
9835
|
-
*
|
|
9458
|
+
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
|
9836
9459
|
*/
|
|
9837
9460
|
maxHeight: number;
|
|
9838
9461
|
/**
|
|
9839
|
-
*
|
|
9462
|
+
* @defaultValue true
|
|
9840
9463
|
*
|
|
9841
|
-
*
|
|
9464
|
+
* Allows the window to be maximized.
|
|
9842
9465
|
*/
|
|
9843
9466
|
maximizable: boolean;
|
|
9844
9467
|
/**
|
|
9845
|
-
*
|
|
9468
|
+
* @defaultValue -1
|
|
9846
9469
|
*
|
|
9847
|
-
*
|
|
9470
|
+
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
|
9848
9471
|
*/
|
|
9849
9472
|
maxWidth: number;
|
|
9850
9473
|
/**
|
|
9851
|
-
*
|
|
9474
|
+
* @defaultValue 0
|
|
9852
9475
|
*
|
|
9853
|
-
*
|
|
9476
|
+
* The minimum height of the window.
|
|
9854
9477
|
*/
|
|
9855
9478
|
minHeight: number;
|
|
9856
9479
|
/**
|
|
9857
|
-
*
|
|
9480
|
+
* @defaultValue true
|
|
9858
9481
|
*
|
|
9859
|
-
*
|
|
9482
|
+
* Allows the window to be minimized.
|
|
9860
9483
|
*/
|
|
9861
9484
|
minimizable: boolean;
|
|
9862
9485
|
/**
|
|
9863
|
-
*
|
|
9486
|
+
* @defaultValue true
|
|
9864
9487
|
*
|
|
9865
|
-
*
|
|
9488
|
+
* The minimum width of the window.
|
|
9866
9489
|
*/
|
|
9867
9490
|
minWidth: number;
|
|
9868
9491
|
/**
|
|
9492
|
+
* @defaultValue 1
|
|
9493
|
+
*
|
|
9869
9494
|
* A flag that specifies how transparent the window will be.
|
|
9870
9495
|
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
|
9871
9496
|
* 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
9497
|
*/
|
|
9876
9498
|
opacity: number;
|
|
9877
9499
|
/**
|
|
9878
|
-
*
|
|
9500
|
+
* @defaultValue true
|
|
9879
9501
|
*
|
|
9880
|
-
*
|
|
9502
|
+
* A flag to allow the user to resize the window.
|
|
9881
9503
|
*/
|
|
9882
9504
|
resizable: boolean;
|
|
9883
9505
|
/**
|
|
@@ -9885,24 +9507,18 @@ declare type MutableWindowOptions = {
|
|
|
9885
9507
|
*/
|
|
9886
9508
|
resizeRegion: ResizeRegion;
|
|
9887
9509
|
/**
|
|
9510
|
+
* @defaultValue false
|
|
9511
|
+
*
|
|
9888
9512
|
* **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
|
|
9889
9513
|
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
|
9890
|
-
*
|
|
9891
|
-
* @default false
|
|
9892
9514
|
*/
|
|
9893
9515
|
showBackgroundImages: boolean;
|
|
9894
9516
|
/**
|
|
9895
|
-
*
|
|
9517
|
+
* @defaultValue true
|
|
9896
9518
|
*
|
|
9897
|
-
*
|
|
9519
|
+
* Shows the window's icon in the taskbar.
|
|
9898
9520
|
*/
|
|
9899
9521
|
showTaskbarIcon: boolean;
|
|
9900
|
-
/**
|
|
9901
|
-
* Specify a taskbar group for the window.
|
|
9902
|
-
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
9903
|
-
* @remarks It's only updatable when `enableJumpList` is set to false.
|
|
9904
|
-
*/
|
|
9905
|
-
taskbarIconGroup: string;
|
|
9906
9522
|
interop: InteropConfig;
|
|
9907
9523
|
/**
|
|
9908
9524
|
* @internal
|
|
@@ -9917,15 +9533,11 @@ declare type MutableWindowOptions = {
|
|
|
9917
9533
|
/**
|
|
9918
9534
|
* {@inheritDoc WindowThrottling}
|
|
9919
9535
|
*
|
|
9920
|
-
* @
|
|
9536
|
+
* @defaultValue 'enabled'
|
|
9921
9537
|
*
|
|
9922
9538
|
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
|
9923
9539
|
*/
|
|
9924
9540
|
throttling: WindowThrottling;
|
|
9925
|
-
/**
|
|
9926
|
-
* {@inheritDoc ChromiumPolicies}
|
|
9927
|
-
*/
|
|
9928
|
-
chromiumPolicies: ChromiumPolicies;
|
|
9929
9541
|
};
|
|
9930
9542
|
|
|
9931
9543
|
declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
|
|
@@ -9946,14 +9558,13 @@ declare type NativeWindowIntegrationProviderAuthorization = {
|
|
|
9946
9558
|
};
|
|
9947
9559
|
|
|
9948
9560
|
/**
|
|
9949
|
-
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules
|
|
9561
|
+
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
|
|
9950
9562
|
* @interface
|
|
9951
9563
|
*/
|
|
9952
9564
|
declare type NavigationRejectedEvent = NamedEvent & {
|
|
9953
9565
|
type: 'navigation-rejected';
|
|
9954
9566
|
sourceName?: string;
|
|
9955
9567
|
url: string;
|
|
9956
|
-
contentRule?: OpenFin.ContentPermission | undefined;
|
|
9957
9568
|
};
|
|
9958
9569
|
|
|
9959
9570
|
/**
|
|
@@ -10011,33 +9622,181 @@ declare type NonAppProcessDetails = ProcessDetails & {
|
|
|
10011
9622
|
name: string;
|
|
10012
9623
|
};
|
|
10013
9624
|
|
|
10014
|
-
/**
|
|
10015
|
-
* @DEPRECATED All view events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
|
|
10016
|
-
*
|
|
10017
|
-
* A view event that does not propagate to (republish on) parent topics.
|
|
10018
|
-
*/
|
|
10019
|
-
declare type NonPropagatedViewEvent = never;
|
|
10020
|
-
|
|
10021
|
-
/**
|
|
10022
|
-
* @DEPRECATED all webcontents events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
|
|
10023
|
-
*
|
|
10024
|
-
* A WebContents event that does not propagate to (republish on) parent topics.
|
|
10025
|
-
*/
|
|
10026
|
-
declare type NonPropagatedWebContentsEvent = never;
|
|
10027
|
-
|
|
10028
|
-
/**
|
|
10029
|
-
* @DEPRECATED All window events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
|
|
10030
|
-
*
|
|
10031
|
-
* A window event that does not propagate to (republish on) parent topics.
|
|
10032
|
-
*/
|
|
10033
|
-
declare type NonPropagatedWindowEvent = never;
|
|
10034
|
-
|
|
10035
|
-
/**
|
|
10036
|
-
* @internal
|
|
10037
|
-
*
|
|
10038
|
-
* Ensures that an event type key does not include any `close-requested` events. Distributes over unions.
|
|
10039
|
-
*/
|
|
10040
|
-
declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'close-requested'>;
|
|
9625
|
+
/**
|
|
9626
|
+
* @DEPRECATED All view events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
|
|
9627
|
+
*
|
|
9628
|
+
* A view event that does not propagate to (republish on) parent topics.
|
|
9629
|
+
*/
|
|
9630
|
+
declare type NonPropagatedViewEvent = never;
|
|
9631
|
+
|
|
9632
|
+
/**
|
|
9633
|
+
* @DEPRECATED all webcontents events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
|
|
9634
|
+
*
|
|
9635
|
+
* A WebContents event that does not propagate to (republish on) parent topics.
|
|
9636
|
+
*/
|
|
9637
|
+
declare type NonPropagatedWebContentsEvent = never;
|
|
9638
|
+
|
|
9639
|
+
/**
|
|
9640
|
+
* @DEPRECATED All window events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
|
|
9641
|
+
*
|
|
9642
|
+
* A window event that does not propagate to (republish on) parent topics.
|
|
9643
|
+
*/
|
|
9644
|
+
declare type NonPropagatedWindowEvent = never;
|
|
9645
|
+
|
|
9646
|
+
/**
|
|
9647
|
+
* @internal
|
|
9648
|
+
*
|
|
9649
|
+
* Ensures that an event type key does not include any `close-requested` events. Distributes over unions.
|
|
9650
|
+
*/
|
|
9651
|
+
declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'close-requested'>;
|
|
9652
|
+
|
|
9653
|
+
declare type NotificationAction_2 = {
|
|
9654
|
+
/**
|
|
9655
|
+
* Type of action this structure represents (BUTTON, TEXT)
|
|
9656
|
+
*/
|
|
9657
|
+
type: number;
|
|
9658
|
+
/**
|
|
9659
|
+
* Action name that the author can use to distinguish them.
|
|
9660
|
+
*/
|
|
9661
|
+
action: string;
|
|
9662
|
+
/**
|
|
9663
|
+
* Title of the action button.
|
|
9664
|
+
*/
|
|
9665
|
+
title: string;
|
|
9666
|
+
/**
|
|
9667
|
+
* URL of the icon for the button. May be empty if no url was specified.
|
|
9668
|
+
*/
|
|
9669
|
+
icon: string;
|
|
9670
|
+
/**
|
|
9671
|
+
* Placeholder to display for text-based actions in absence of user input.
|
|
9672
|
+
*/
|
|
9673
|
+
placeholder: string;
|
|
9674
|
+
};
|
|
9675
|
+
|
|
9676
|
+
/**
|
|
9677
|
+
* Emitted when a developer has called .close on a notification which has been interecepted.
|
|
9678
|
+
*/
|
|
9679
|
+
declare type NotificationCloseRequested = BaseEvent_9 & {
|
|
9680
|
+
type: 'notification-close-requested';
|
|
9681
|
+
notificationId: string;
|
|
9682
|
+
};
|
|
9683
|
+
|
|
9684
|
+
declare type NotificationData = {
|
|
9685
|
+
/**
|
|
9686
|
+
* Title to be displayed with the Web Notification.
|
|
9687
|
+
*/
|
|
9688
|
+
title: string;
|
|
9689
|
+
/**
|
|
9690
|
+
* Hint to determine the directionality of the displayed notification.
|
|
9691
|
+
* (LEFT_TO_RIGHT, RIGHT_TO_LEFT, AUTO)
|
|
9692
|
+
*/
|
|
9693
|
+
direction: number;
|
|
9694
|
+
/**
|
|
9695
|
+
* BCP 47 language tag describing the notification's contents. Optional.
|
|
9696
|
+
*/
|
|
9697
|
+
lang: string;
|
|
9698
|
+
/**
|
|
9699
|
+
* Contents of the notification.
|
|
9700
|
+
*/
|
|
9701
|
+
body: string;
|
|
9702
|
+
/**
|
|
9703
|
+
* Tag of the notification. Notifications sharing both their origin and their, tag
|
|
9704
|
+
* will replace the first displayed notification.
|
|
9705
|
+
*/
|
|
9706
|
+
tag: string;
|
|
9707
|
+
/**
|
|
9708
|
+
* URL of the image contents of the notification. May be empty if no url was
|
|
9709
|
+
* specified.
|
|
9710
|
+
*/
|
|
9711
|
+
image: string;
|
|
9712
|
+
/**
|
|
9713
|
+
* URL of the icon which is to be displayed with the notification.
|
|
9714
|
+
*/
|
|
9715
|
+
icon: string;
|
|
9716
|
+
/**
|
|
9717
|
+
* URL of the badge for representing the notification. May be empty if no url was
|
|
9718
|
+
* specified.
|
|
9719
|
+
*/
|
|
9720
|
+
badge: string;
|
|
9721
|
+
/**
|
|
9722
|
+
* Vibration pattern for the notification, following the syntax of the Vibration
|
|
9723
|
+
* API. https://www.w3.org/TR/vibration/
|
|
9724
|
+
*/
|
|
9725
|
+
vibration_pattern: number[];
|
|
9726
|
+
/**
|
|
9727
|
+
* The time at which the event the notification represents took place.
|
|
9728
|
+
*/
|
|
9729
|
+
timestamp: string;
|
|
9730
|
+
/**
|
|
9731
|
+
* Whether default notification indicators (sound, vibration, light) should be
|
|
9732
|
+
* played again if the notification is replacing an older notification.
|
|
9733
|
+
*/
|
|
9734
|
+
renotify: boolean;
|
|
9735
|
+
/**
|
|
9736
|
+
* Whether default notification indicators (sound, vibration, light) should be
|
|
9737
|
+
* played again if the notification is replacing an older notification.
|
|
9738
|
+
*/
|
|
9739
|
+
silent: boolean;
|
|
9740
|
+
/**
|
|
9741
|
+
* Whether the notification should remain onscreen indefinitely, rather than being
|
|
9742
|
+
* auto-minimized to the notification center (if allowed by platform).
|
|
9743
|
+
*/
|
|
9744
|
+
requireInteraction: boolean;
|
|
9745
|
+
/**
|
|
9746
|
+
* Base64 encoded Developer-provided data associated with the notification, in the
|
|
9747
|
+
* form of a serialized string. Must not exceed |kMaximumDeveloperDataSize| bytes.
|
|
9748
|
+
*/
|
|
9749
|
+
data: string;
|
|
9750
|
+
/**
|
|
9751
|
+
* Actions that should be shown as buttons on the notification.
|
|
9752
|
+
*/
|
|
9753
|
+
actions: NotificationAction_2[];
|
|
9754
|
+
/**
|
|
9755
|
+
* The time at which the notification should be shown.
|
|
9756
|
+
*/
|
|
9757
|
+
showTriggerTimestamp?: string | null;
|
|
9758
|
+
/**
|
|
9759
|
+
* Scenarios that define the notification behavior. (DEFAULT, INCOMING_CALL)
|
|
9760
|
+
*/
|
|
9761
|
+
scenario: number;
|
|
9762
|
+
};
|
|
9763
|
+
|
|
9764
|
+
declare type NotificationInterceptedEvent = NamedEvent & {
|
|
9765
|
+
type: 'notification-intercepted';
|
|
9766
|
+
/**
|
|
9767
|
+
* id of the notification
|
|
9768
|
+
*/
|
|
9769
|
+
notificationId: string;
|
|
9770
|
+
/**
|
|
9771
|
+
* origin of the notification
|
|
9772
|
+
*/
|
|
9773
|
+
origin: string;
|
|
9774
|
+
/**
|
|
9775
|
+
* empty if notification comes from worker
|
|
9776
|
+
*/
|
|
9777
|
+
documentUrl: string;
|
|
9778
|
+
notificationData: NotificationData;
|
|
9779
|
+
/**
|
|
9780
|
+
* Image for the notification. The bitmap may be empty if the developer did not
|
|
9781
|
+
* provide an image, or fetching of the image failed.
|
|
9782
|
+
*/
|
|
9783
|
+
image: SerializedImage;
|
|
9784
|
+
/**
|
|
9785
|
+
* Main icon for the notification. The bitmap may be empty if the developer did not
|
|
9786
|
+
* provide an icon, or fetching of the icon failed.
|
|
9787
|
+
*/
|
|
9788
|
+
notificationIcon: SerializedImage;
|
|
9789
|
+
/**
|
|
9790
|
+
* Badge for the notification. The bitmap may be empty if the developer did not
|
|
9791
|
+
* provide a badge, or fetching of the badge failed.
|
|
9792
|
+
*/
|
|
9793
|
+
badge: SerializedImage;
|
|
9794
|
+
/**
|
|
9795
|
+
* Icons for the actions. A bitmap may be empty if the developer did not provide an
|
|
9796
|
+
* icon, or fetching of the icon failed.
|
|
9797
|
+
*/
|
|
9798
|
+
actionIcons: SerializedImage[];
|
|
9799
|
+
};
|
|
10041
9800
|
|
|
10042
9801
|
/**
|
|
10043
9802
|
* @internal
|
|
@@ -10113,11 +9872,8 @@ declare namespace OpenFin {
|
|
|
10113
9872
|
ClientConnectionPayload,
|
|
10114
9873
|
EntityInfo,
|
|
10115
9874
|
EntityType_4 as EntityType,
|
|
10116
|
-
ScreenCaptureState,
|
|
10117
|
-
ScreenCapturePermission,
|
|
10118
9875
|
Bounds,
|
|
10119
9876
|
WindowBounds,
|
|
10120
|
-
GetBoundsOptions,
|
|
10121
9877
|
Rectangle,
|
|
10122
9878
|
ApplicationCreationOptions,
|
|
10123
9879
|
TimeZones,
|
|
@@ -10150,11 +9906,8 @@ declare namespace OpenFin {
|
|
|
10150
9906
|
ViewVisibilityOptions,
|
|
10151
9907
|
WindowState,
|
|
10152
9908
|
AutoplayPolicyOptions,
|
|
10153
|
-
ExcludeOptions,
|
|
10154
9909
|
ConstWindowOptions,
|
|
10155
9910
|
InheritableOptions,
|
|
10156
|
-
PolicyOptions,
|
|
10157
|
-
ChromiumPolicies,
|
|
10158
9911
|
MutableWindowOptions,
|
|
10159
9912
|
WorkspacePlatformOptions,
|
|
10160
9913
|
WebRequestHeader,
|
|
@@ -10188,9 +9941,6 @@ declare namespace OpenFin {
|
|
|
10188
9941
|
ViewOptions,
|
|
10189
9942
|
ConstViewOptions,
|
|
10190
9943
|
ViewState,
|
|
10191
|
-
ViewCreationSuccess,
|
|
10192
|
-
ViewCreationFailure,
|
|
10193
|
-
ViewCreationResult,
|
|
10194
9944
|
Certificate,
|
|
10195
9945
|
HostContextChangedPayload,
|
|
10196
9946
|
ApplySnapshotOptions,
|
|
@@ -10220,7 +9970,6 @@ declare namespace OpenFin {
|
|
|
10220
9970
|
OpenExternalPermission,
|
|
10221
9971
|
DeviceInfo,
|
|
10222
9972
|
Permissions_2 as Permissions,
|
|
10223
|
-
ClipboardApiPermissions,
|
|
10224
9973
|
PlatformWindowCreationOptions,
|
|
10225
9974
|
PlatformWindowOptions,
|
|
10226
9975
|
PlatformViewCreationOptions,
|
|
@@ -10326,21 +10075,11 @@ declare namespace OpenFin {
|
|
|
10326
10075
|
RuntimeInfo,
|
|
10327
10076
|
DefaultDomainSettings,
|
|
10328
10077
|
DefaultDomainSettingsRule,
|
|
10329
|
-
MultipleDomainMatchBehavior,
|
|
10330
10078
|
DomainSettings,
|
|
10331
10079
|
ApiInjection,
|
|
10332
10080
|
DomainApiSettings,
|
|
10333
|
-
BaseContentBehavior,
|
|
10334
|
-
ContentBehavior,
|
|
10335
|
-
BrowserContentBehavior,
|
|
10336
|
-
StructuredContentBehavior,
|
|
10337
|
-
StructuredContentPermissions,
|
|
10338
10081
|
ContentPermission,
|
|
10339
|
-
ScreenCaptureBehavior,
|
|
10340
10082
|
PerDomainSettings,
|
|
10341
|
-
CopyPermissions,
|
|
10342
|
-
PastePermissions,
|
|
10343
|
-
ClipboardPermissions,
|
|
10344
10083
|
DomainSettingsRule,
|
|
10345
10084
|
FileDownloadBehavior,
|
|
10346
10085
|
FileDownloadBehaviorNames,
|
|
@@ -10440,7 +10179,6 @@ declare namespace OpenFin {
|
|
|
10440
10179
|
Me,
|
|
10441
10180
|
CapturePageOptions,
|
|
10442
10181
|
ProcessLoggingOptions,
|
|
10443
|
-
BoundsType,
|
|
10444
10182
|
PositioningOptions,
|
|
10445
10183
|
ChannelClientConnectionListener,
|
|
10446
10184
|
ChannelClientDisconnectionListener,
|
|
@@ -10448,12 +10186,6 @@ declare namespace OpenFin {
|
|
|
10448
10186
|
RoutingInfo,
|
|
10449
10187
|
DownloadShelfOptions,
|
|
10450
10188
|
ViewShowAtOptions,
|
|
10451
|
-
ExtensionInfo,
|
|
10452
|
-
ServeRequest,
|
|
10453
|
-
AppAssetServeRequest,
|
|
10454
|
-
PathServeRequest,
|
|
10455
|
-
ServeAssetOptions,
|
|
10456
|
-
ServedAssetInfo,
|
|
10457
10189
|
ApplicationEvents,
|
|
10458
10190
|
BaseEvents,
|
|
10459
10191
|
ExternalApplicationEvents,
|
|
@@ -10520,34 +10252,6 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
|
|
|
10520
10252
|
title: string;
|
|
10521
10253
|
};
|
|
10522
10254
|
|
|
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
10255
|
declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10552
10256
|
success: Success;
|
|
10553
10257
|
data: Success extends true ? Data : never;
|
|
@@ -10683,33 +10387,6 @@ declare type PerDomainSettings = {
|
|
|
10683
10387
|
* {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
|
|
10684
10388
|
*/
|
|
10685
10389
|
content?: ContentPermission;
|
|
10686
|
-
/**
|
|
10687
|
-
* {@inheritdoc ChromiumPolicies}
|
|
10688
|
-
*/
|
|
10689
|
-
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
10390
|
};
|
|
10714
10391
|
|
|
10715
10392
|
/**
|
|
@@ -10734,7 +10411,6 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
|
|
10734
10411
|
declare type Permissions_2 = {
|
|
10735
10412
|
Application?: Partial<ApplicationPermissions>;
|
|
10736
10413
|
System?: Partial<SystemPermissions>;
|
|
10737
|
-
Clipboard?: Partial<ClipboardApiPermissions>;
|
|
10738
10414
|
webAPIs?: WebPermission[];
|
|
10739
10415
|
devices?: DeviceInfo[];
|
|
10740
10416
|
};
|
|
@@ -10756,16 +10432,10 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
|
|
|
10756
10432
|
private _channel;
|
|
10757
10433
|
Application: OpenFin.Application;
|
|
10758
10434
|
identity: OpenFin.ApplicationIdentity;
|
|
10759
|
-
/**
|
|
10760
|
-
* @internal
|
|
10761
|
-
* Reuse clients to avoid overwriting already-registered client in provider
|
|
10762
|
-
* This ensures that only channel client is created per channel name per `fin` instance
|
|
10763
|
-
*/
|
|
10764
|
-
private static clientMap;
|
|
10765
10435
|
/**
|
|
10766
10436
|
* @internal
|
|
10767
10437
|
*/
|
|
10768
|
-
constructor(
|
|
10438
|
+
constructor(identity: OpenFin.ApplicationIdentity, channel: Channel_3);
|
|
10769
10439
|
getClient: (identity?: OpenFin.ApplicationIdentity) => Promise<ChannelClient_2>;
|
|
10770
10440
|
/**
|
|
10771
10441
|
* Creates a new view and attaches it to a specified target window.
|
|
@@ -11604,11 +11274,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
11604
11274
|
*/
|
|
11605
11275
|
providerUrl?: string;
|
|
11606
11276
|
/**
|
|
11277
|
+
* @defaultValue true
|
|
11278
|
+
*
|
|
11607
11279
|
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
|
11608
11280
|
*
|
|
11609
11281
|
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
|
11610
|
-
*
|
|
11611
|
-
* @default true
|
|
11612
11282
|
*/
|
|
11613
11283
|
allowLaunchIntoPlatform?: boolean;
|
|
11614
11284
|
};
|
|
@@ -12149,53 +11819,6 @@ declare interface PlatformProvider {
|
|
|
12149
11819
|
* @returns {Promise<void>}
|
|
12150
11820
|
*/
|
|
12151
11821
|
handleRunRequested({ manifest, userAppConfigArgs }: RunRequestedEvent): Promise<void>;
|
|
12152
|
-
/**
|
|
12153
|
-
* @experimental
|
|
12154
|
-
*
|
|
12155
|
-
* This method is called to handle errors with view creation and initial navigation during layout creation.
|
|
12156
|
-
* Overriding this method enables catching the error and correcting behavior (ie navigating to an error page).
|
|
12157
|
-
* * To indicate that the error has been handled, view creation should be treated as successful return {identity: viewIdentity, success: true}.
|
|
12158
|
-
* * Not returning anything will cause the layout-initialized event to include the view as failed with the original error.
|
|
12159
|
-
* * Throwing an error will update the error on the event payload of layout-initialized to the thrown error.
|
|
12160
|
-
*
|
|
12161
|
-
* @param viewIdentity Identity of the view
|
|
12162
|
-
* @param error error thrown during a view creation
|
|
12163
|
-
* @returns {Promise<OpenFin.ViewCreationSuccess | void>}
|
|
12164
|
-
*
|
|
12165
|
-
* @example
|
|
12166
|
-
*
|
|
12167
|
-
* ```js
|
|
12168
|
-
* const overrideCallback = (PlatformProvider) => {
|
|
12169
|
-
* class Override extends PlatformProvider {
|
|
12170
|
-
* async handleFailedViewCreation(viewIdentity, error) {
|
|
12171
|
-
* const view = fin.View.wrapSync(viewId);
|
|
12172
|
-
* try {
|
|
12173
|
-
* // navigate to an error page
|
|
12174
|
-
* await view.navigate('http://localhost:3000/errorPage.html');
|
|
12175
|
-
* // resolve a success result after redirecting to a error page
|
|
12176
|
-
* return {identity: viewIdentity, success: true};
|
|
12177
|
-
* } catch(e) {
|
|
12178
|
-
* // layout-initialized event will include this view with the error
|
|
12179
|
-
* throw error;
|
|
12180
|
-
* }
|
|
12181
|
-
* }
|
|
12182
|
-
* }
|
|
12183
|
-
* return new Override();
|
|
12184
|
-
* }
|
|
12185
|
-
*
|
|
12186
|
-
* fin.Platform.init({ overrideCallback });
|
|
12187
|
-
*
|
|
12188
|
-
* ```
|
|
12189
|
-
*/
|
|
12190
|
-
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
11822
|
}
|
|
12200
11823
|
|
|
12201
11824
|
/**
|
|
@@ -12260,12 +11883,6 @@ declare type PointTopLeft = {
|
|
|
12260
11883
|
left: number;
|
|
12261
11884
|
};
|
|
12262
11885
|
|
|
12263
|
-
/**
|
|
12264
|
-
* When set to `disable`, disables the policy
|
|
12265
|
-
* When set to `defer-to-group-policy`, respects Group Policy settings
|
|
12266
|
-
*/
|
|
12267
|
-
declare type PolicyOptions = 'disable' | 'defer-to-group-policy';
|
|
12268
|
-
|
|
12269
11886
|
declare type PopupBaseBehavior = 'close' | 'hide';
|
|
12270
11887
|
|
|
12271
11888
|
declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
|
|
@@ -12297,22 +11914,22 @@ declare type PopupOptions = {
|
|
|
12297
11914
|
url?: string;
|
|
12298
11915
|
/**
|
|
12299
11916
|
* Height of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12300
|
-
* @
|
|
11917
|
+
* @defaultValue 300
|
|
12301
11918
|
*/
|
|
12302
11919
|
height?: number;
|
|
12303
11920
|
/**
|
|
12304
11921
|
* Width of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12305
|
-
* @
|
|
11922
|
+
* @defaultValue 300
|
|
12306
11923
|
*/
|
|
12307
11924
|
width?: number;
|
|
12308
11925
|
/**
|
|
12309
11926
|
* Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12310
|
-
* @
|
|
11927
|
+
* @defaultValue 0
|
|
12311
11928
|
*/
|
|
12312
11929
|
x?: number;
|
|
12313
11930
|
/**
|
|
12314
11931
|
* Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12315
|
-
* @
|
|
11932
|
+
* @defaultValue 0
|
|
12316
11933
|
*/
|
|
12317
11934
|
y?: number;
|
|
12318
11935
|
/**
|
|
@@ -12320,7 +11937,7 @@ declare type PopupOptions = {
|
|
|
12320
11937
|
* * 'modal' restricts resizing and positioning in the caller.
|
|
12321
11938
|
* * 'hide' hides the popup window on blur.
|
|
12322
11939
|
* * 'close' closes the popup window on blur.
|
|
12323
|
-
* @
|
|
11940
|
+
* @defaultValue 'close'
|
|
12324
11941
|
*/
|
|
12325
11942
|
blurBehavior?: PopupBlurBehavior;
|
|
12326
11943
|
/**
|
|
@@ -12328,19 +11945,19 @@ declare type PopupOptions = {
|
|
|
12328
11945
|
* * 'none' will do nothing.
|
|
12329
11946
|
* * 'hide' hides the popup window on `dispatchPopupResult`.
|
|
12330
11947
|
* * 'close' closes the popup window on `dispatchPopupResult`.
|
|
12331
|
-
* @
|
|
11948
|
+
* @defaultValue 'close'
|
|
12332
11949
|
*/
|
|
12333
11950
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
12334
11951
|
/**
|
|
12335
11952
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
12336
11953
|
*
|
|
12337
11954
|
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
12338
|
-
* @
|
|
11955
|
+
* @defaultValue false
|
|
12339
11956
|
*/
|
|
12340
11957
|
hideOnClose?: boolean;
|
|
12341
11958
|
/**
|
|
12342
11959
|
* Determines if the popup window should or should not be focused when it is shown.
|
|
12343
|
-
* @
|
|
11960
|
+
* @defaultValue true
|
|
12344
11961
|
*/
|
|
12345
11962
|
focus?: boolean;
|
|
12346
11963
|
/**
|
|
@@ -12419,7 +12036,6 @@ declare type PositioningOptions = {
|
|
|
12419
12036
|
* This will have the effect of the maximized window staying maximized and not immediately taking this new position.
|
|
12420
12037
|
*/
|
|
12421
12038
|
skipRestore?: boolean;
|
|
12422
|
-
boundsType?: BoundsType;
|
|
12423
12039
|
};
|
|
12424
12040
|
|
|
12425
12041
|
/**
|
|
@@ -12434,9 +12050,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
|
|
|
12434
12050
|
*/
|
|
12435
12051
|
declare type PreloadScript = {
|
|
12436
12052
|
/**
|
|
12437
|
-
*
|
|
12053
|
+
* @defaultValue false
|
|
12438
12054
|
*
|
|
12439
|
-
*
|
|
12055
|
+
* Fail to load the window if this preload script fails
|
|
12440
12056
|
*/
|
|
12441
12057
|
mandatory?: boolean;
|
|
12442
12058
|
/**
|
|
@@ -12532,15 +12148,15 @@ declare type PrinterInfo = {
|
|
|
12532
12148
|
declare type PrintOptions = {
|
|
12533
12149
|
content?: 'self';
|
|
12534
12150
|
/**
|
|
12535
|
-
*
|
|
12151
|
+
* @defaultValue false
|
|
12536
12152
|
*
|
|
12537
|
-
*
|
|
12153
|
+
* Disables prompting the user for print settings.
|
|
12538
12154
|
*/
|
|
12539
12155
|
silent?: boolean;
|
|
12540
12156
|
/**
|
|
12541
|
-
*
|
|
12157
|
+
* @defaultValue false
|
|
12542
12158
|
*
|
|
12543
|
-
*
|
|
12159
|
+
* Includes the webpage background color and image when printing.
|
|
12544
12160
|
*/
|
|
12545
12161
|
printBackground?: boolean;
|
|
12546
12162
|
/**
|
|
@@ -12548,9 +12164,9 @@ declare type PrintOptions = {
|
|
|
12548
12164
|
*/
|
|
12549
12165
|
deviceName?: string;
|
|
12550
12166
|
/**
|
|
12551
|
-
*
|
|
12167
|
+
* @defaultValue true
|
|
12552
12168
|
*
|
|
12553
|
-
*
|
|
12169
|
+
* Prints in full color (greyscale otherwise).
|
|
12554
12170
|
*/
|
|
12555
12171
|
color?: boolean;
|
|
12556
12172
|
/**
|
|
@@ -12558,9 +12174,9 @@ declare type PrintOptions = {
|
|
|
12558
12174
|
*/
|
|
12559
12175
|
margins?: Margins;
|
|
12560
12176
|
/**
|
|
12561
|
-
*
|
|
12177
|
+
* @defaultValue true
|
|
12562
12178
|
*
|
|
12563
|
-
*
|
|
12179
|
+
* Prints in landscape mode (portrait otherwise).
|
|
12564
12180
|
*/
|
|
12565
12181
|
landscape?: boolean;
|
|
12566
12182
|
/**
|
|
@@ -12807,9 +12423,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12807
12423
|
'set-tray-icon': ApplicationIdentityCall<{
|
|
12808
12424
|
enabledIcon: string;
|
|
12809
12425
|
}, void>;
|
|
12810
|
-
'set-tray-icon-tooltip': ApplicationIdentityCall<{
|
|
12811
|
-
toolTip: string;
|
|
12812
|
-
}>;
|
|
12813
12426
|
'set-shortcuts': ApplicationIdentityCall<{
|
|
12814
12427
|
data: OpenFin.ShortCutConfig;
|
|
12815
12428
|
}, void>;
|
|
@@ -12947,9 +12560,7 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12947
12560
|
options: OpenFin.TransitionOptions;
|
|
12948
12561
|
}>;
|
|
12949
12562
|
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12950
|
-
'get-window-bounds': IdentityCall<{
|
|
12951
|
-
options?: OpenFin.GetBoundsOptions;
|
|
12952
|
-
}, OpenFin.WindowBounds>;
|
|
12563
|
+
'get-window-bounds': IdentityCall<{}, OpenFin.WindowBounds>;
|
|
12953
12564
|
'center-window': IdentityCall;
|
|
12954
12565
|
'blur-window': IdentityCall;
|
|
12955
12566
|
'bring-window-to-front': IdentityCall;
|
|
@@ -13129,6 +12740,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13129
12740
|
'get-version': GetterCall<string>;
|
|
13130
12741
|
'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
|
|
13131
12742
|
'delete-cache-request': VoidCall;
|
|
12743
|
+
'dispatch-notification-action': {
|
|
12744
|
+
request: {
|
|
12745
|
+
notificationId: string;
|
|
12746
|
+
action: 'click' | 'close' | 'show';
|
|
12747
|
+
};
|
|
12748
|
+
response: void;
|
|
12749
|
+
};
|
|
13132
12750
|
'exit-desktop': VoidCall;
|
|
13133
12751
|
'fetch-manifest': ApiCall<{
|
|
13134
12752
|
manifestUrl: string;
|
|
@@ -13159,9 +12777,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13159
12777
|
response: string;
|
|
13160
12778
|
};
|
|
13161
12779
|
'get-focused-window': GetterCall<OpenFin.Identity | null>;
|
|
13162
|
-
'get-focused-content': GetterCall<(OpenFin.Identity & {
|
|
13163
|
-
entityType: 'window' | 'view';
|
|
13164
|
-
}) | null>;
|
|
13165
12780
|
'is-app-certified': {
|
|
13166
12781
|
request: {
|
|
13167
12782
|
manifestUrl: string;
|
|
@@ -13285,22 +12900,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13285
12900
|
options: OpenFin.ProcessLoggingOptions;
|
|
13286
12901
|
}, void>;
|
|
13287
12902
|
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
13288
|
-
'serve-asset': ApiCall<{
|
|
13289
|
-
options: OpenFin.ServeAssetOptions;
|
|
13290
|
-
}, OpenFin.ServedAssetInfo>;
|
|
13291
12903
|
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
13292
12904
|
domainSettings: OpenFin.DefaultDomainSettings;
|
|
13293
12905
|
}, void>;
|
|
13294
12906
|
'system-register-shutdown-handler': VoidCall;
|
|
13295
12907
|
'get-permissions': GetterCall<any>;
|
|
13296
|
-
'refresh-extensions': {
|
|
13297
|
-
request: void;
|
|
13298
|
-
response: string[] | undefined;
|
|
13299
|
-
};
|
|
13300
|
-
'get-installed-extensions': {
|
|
13301
|
-
request: void;
|
|
13302
|
-
response: OpenFin.ExtensionInfo[];
|
|
13303
|
-
};
|
|
13304
12908
|
'fdc3-add-context-listener': VoidCall;
|
|
13305
12909
|
'fdc3-add-intent-listener': VoidCall;
|
|
13306
12910
|
'fdc3-raise-intent': VoidCall;
|
|
@@ -13453,10 +13057,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13453
13057
|
};
|
|
13454
13058
|
response: OpenFin.PopupResult;
|
|
13455
13059
|
};
|
|
13456
|
-
'get-screen-capture-permissions': {
|
|
13457
|
-
request: OpenFin.Identity;
|
|
13458
|
-
response: OpenFin.ScreenCapturePermission;
|
|
13459
|
-
};
|
|
13460
13060
|
'render-overlay': {
|
|
13461
13061
|
request: {
|
|
13462
13062
|
bounds: OpenFin.Bounds;
|
|
@@ -13731,15 +13331,15 @@ declare type ReplaceViewPayload = {
|
|
|
13731
13331
|
*/
|
|
13732
13332
|
declare type ResizeRegion = {
|
|
13733
13333
|
/**
|
|
13734
|
-
*
|
|
13334
|
+
* @defaultValue 7
|
|
13735
13335
|
*
|
|
13736
|
-
*
|
|
13336
|
+
* The size of the resize region in pixels.
|
|
13737
13337
|
*/
|
|
13738
13338
|
size?: number;
|
|
13739
13339
|
/**
|
|
13740
|
-
*
|
|
13340
|
+
* @defaultValue 9
|
|
13741
13341
|
*
|
|
13742
|
-
*
|
|
13342
|
+
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
|
13743
13343
|
*/
|
|
13744
13344
|
bottomRightCorner?: number;
|
|
13745
13345
|
/**
|
|
@@ -13747,27 +13347,27 @@ declare type ResizeRegion = {
|
|
|
13747
13347
|
*/
|
|
13748
13348
|
sides?: {
|
|
13749
13349
|
/**
|
|
13750
|
-
*
|
|
13350
|
+
* @defaultValue true
|
|
13751
13351
|
*
|
|
13752
|
-
*
|
|
13352
|
+
* Enables resizing from the top of the window.
|
|
13753
13353
|
*/
|
|
13754
13354
|
top?: boolean;
|
|
13755
13355
|
/**
|
|
13756
|
-
*
|
|
13356
|
+
* @defaultValue true
|
|
13757
13357
|
*
|
|
13758
|
-
*
|
|
13358
|
+
* Enables resizing from the bottom of the window.
|
|
13759
13359
|
*/
|
|
13760
13360
|
bottom?: boolean;
|
|
13761
13361
|
/**
|
|
13762
|
-
*
|
|
13362
|
+
* @defaultValue true
|
|
13763
13363
|
*
|
|
13764
|
-
*
|
|
13364
|
+
* Enables resizing from the left side of the window.
|
|
13765
13365
|
*/
|
|
13766
13366
|
left?: boolean;
|
|
13767
13367
|
/**
|
|
13768
|
-
*
|
|
13368
|
+
* @defaultValue true
|
|
13769
13369
|
*
|
|
13770
|
-
*
|
|
13370
|
+
* Enables resizing from the right side of the window.
|
|
13771
13371
|
*/
|
|
13772
13372
|
right?: boolean;
|
|
13773
13373
|
};
|
|
@@ -13949,20 +13549,12 @@ declare type RVMInfo = {
|
|
|
13949
13549
|
* The app log directory.
|
|
13950
13550
|
*/
|
|
13951
13551
|
'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
13552
|
/**
|
|
13957
13553
|
* The path of OpenfinRVM.exe.
|
|
13958
13554
|
*/
|
|
13959
13555
|
'path': string;
|
|
13960
13556
|
/**
|
|
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.
|
|
13557
|
+
* The start time of RVM.
|
|
13966
13558
|
*/
|
|
13967
13559
|
'start-time': string;
|
|
13968
13560
|
/**
|
|
@@ -13994,30 +13586,6 @@ declare type RvmLaunchOptions = {
|
|
|
13994
13586
|
subscribe?: (launch: LaunchEmitter) => void;
|
|
13995
13587
|
};
|
|
13996
13588
|
|
|
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
13589
|
/**
|
|
14022
13590
|
* @interface
|
|
14023
13591
|
*/
|
|
@@ -14025,21 +13593,6 @@ declare type ScreenshotPrintOptions = {
|
|
|
14025
13593
|
content: 'screenshot';
|
|
14026
13594
|
};
|
|
14027
13595
|
|
|
14028
|
-
/**
|
|
14029
|
-
* An event generated when an application modifies the runtime in a way that affects all other applications in the
|
|
14030
|
-
* application runtime/security realm.
|
|
14031
|
-
*/
|
|
14032
|
-
declare type SecurityRealmEvent = BaseEvent_9 & {
|
|
14033
|
-
/**
|
|
14034
|
-
* Config URL of the application that modified the security realm's extensions
|
|
14035
|
-
*/
|
|
14036
|
-
configUrl: string;
|
|
14037
|
-
/**
|
|
14038
|
-
* Identity of the application that modified the security realm's extensions
|
|
14039
|
-
*/
|
|
14040
|
-
applicationIdentity: OpenFin.ApplicationIdentity;
|
|
14041
|
-
};
|
|
14042
|
-
|
|
14043
13596
|
declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
|
|
14044
13597
|
data: ProtocolMap[T]['response'];
|
|
14045
13598
|
} & ProtocolMap[T]['specialResponse']>;
|
|
@@ -14056,15 +13609,10 @@ declare type SentMessage<Value> = Promise<Value> & {
|
|
|
14056
13609
|
messageId: ReturnType<Environment['getNextMessageId']>;
|
|
14057
13610
|
};
|
|
14058
13611
|
|
|
14059
|
-
|
|
14060
|
-
|
|
14061
|
-
|
|
14062
|
-
|
|
14063
|
-
};
|
|
14064
|
-
|
|
14065
|
-
declare type ServeRequest = {
|
|
14066
|
-
hostName: string;
|
|
14067
|
-
};
|
|
13612
|
+
/**
|
|
13613
|
+
* Utility type to mark an image serialized as a base64 data URL.
|
|
13614
|
+
*/
|
|
13615
|
+
declare type SerializedImage = string;
|
|
14068
13616
|
|
|
14069
13617
|
/**
|
|
14070
13618
|
* @interface
|
|
@@ -14311,9 +13859,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
|
|
|
14311
13859
|
*/
|
|
14312
13860
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
14313
13861
|
/**
|
|
14314
|
-
*
|
|
13862
|
+
* @defaultValue 0
|
|
14315
13863
|
*
|
|
14316
|
-
*
|
|
13864
|
+
* Number of milliseconds to wait between view repaints.
|
|
14317
13865
|
*/
|
|
14318
13866
|
paintIntervalMs?: number;
|
|
14319
13867
|
};
|
|
@@ -14363,7 +13911,6 @@ declare type Snapshot = {
|
|
|
14363
13911
|
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
|
14364
13912
|
topic: 'application';
|
|
14365
13913
|
type: 'platform-snapshot-applied';
|
|
14366
|
-
snapshot: Snapshot;
|
|
14367
13914
|
};
|
|
14368
13915
|
|
|
14369
13916
|
/**
|
|
@@ -14488,32 +14035,6 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
|
14488
14035
|
type: 'started';
|
|
14489
14036
|
};
|
|
14490
14037
|
|
|
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
14038
|
/**
|
|
14518
14039
|
* @interface
|
|
14519
14040
|
*/
|
|
@@ -14535,6 +14056,13 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14535
14056
|
* @internal
|
|
14536
14057
|
*/
|
|
14537
14058
|
constructor(wire: Transport);
|
|
14059
|
+
/**
|
|
14060
|
+
* Dispatch an event to the webcontents that created the notification.
|
|
14061
|
+
* Only works for notifications that have been intercepted in the same runtime.
|
|
14062
|
+
*/
|
|
14063
|
+
dispatchNotificationAction(notificationId: string, { action }: {
|
|
14064
|
+
action: 'click' | 'close' | 'show';
|
|
14065
|
+
}): Promise<void>;
|
|
14538
14066
|
private sendExternalProcessRequest;
|
|
14539
14067
|
/**
|
|
14540
14068
|
* Returns the version of the runtime. The version contains the major, minor,
|
|
@@ -14713,9 +14241,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14713
14241
|
*/
|
|
14714
14242
|
getEnvironmentVariable(envName: string): Promise<string>;
|
|
14715
14243
|
/**
|
|
14716
|
-
* Get
|
|
14717
|
-
* If a View currently has focus, returns the identity of View's parent Window.
|
|
14718
|
-
* Use {@link Window._Window#getFocusedContent Window.getFocusedContent} to directly access currently focused Window or View.
|
|
14244
|
+
* Get current focused window.
|
|
14719
14245
|
*
|
|
14720
14246
|
* @example
|
|
14721
14247
|
* ```js
|
|
@@ -14723,17 +14249,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14723
14249
|
* ```
|
|
14724
14250
|
*/
|
|
14725
14251
|
getFocusedWindow(): Promise<OpenFin.Identity | null>;
|
|
14726
|
-
/**
|
|
14727
|
-
* Get currently focused content. Returns identity of entity with `entityType`.
|
|
14728
|
-
*
|
|
14729
|
-
* @example
|
|
14730
|
-
* ```js
|
|
14731
|
-
* fin.System.getFocusedContent().then(contentIdentity => console.log(contentIdentity)).catch(err => console.log(err));
|
|
14732
|
-
* ```
|
|
14733
|
-
*/
|
|
14734
|
-
getFocusedContent(): Promise<(OpenFin.Identity & {
|
|
14735
|
-
entityType: 'window' | 'view';
|
|
14736
|
-
}) | null>;
|
|
14737
14252
|
/**
|
|
14738
14253
|
* Returns information about the given app's certification status
|
|
14739
14254
|
*
|
|
@@ -15987,21 +15502,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15987
15502
|
* ```
|
|
15988
15503
|
*/
|
|
15989
15504
|
setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
|
|
15990
|
-
/**
|
|
15991
|
-
* Attempts to install and enable extensions for the security realm. Users may want to call this function in response
|
|
15992
|
-
* to an `extensions-install-failed` event. Only extensions allowed by every application on the current security realm
|
|
15993
|
-
* will be installed/enabled.
|
|
15994
|
-
*/
|
|
15995
|
-
refreshExtensions(): Promise<string[] | undefined>;
|
|
15996
|
-
/**
|
|
15997
|
-
* Gets the currently-installed
|
|
15998
|
-
*/
|
|
15999
|
-
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
15505
|
}
|
|
16006
15506
|
|
|
16007
15507
|
/**
|
|
@@ -16019,6 +15519,7 @@ declare namespace SystemEvents {
|
|
|
16019
15519
|
IdleStateChangedEvent,
|
|
16020
15520
|
IdleEvent,
|
|
16021
15521
|
MonitorInfoChangedEvent,
|
|
15522
|
+
NotificationCloseRequested,
|
|
16022
15523
|
MonitorEvent,
|
|
16023
15524
|
SessionChangedEvent,
|
|
16024
15525
|
AppVersionEvent,
|
|
@@ -16032,14 +15533,6 @@ declare namespace SystemEvents {
|
|
|
16032
15533
|
ApplicationCreatedEvent,
|
|
16033
15534
|
DesktopIconClickedEvent,
|
|
16034
15535
|
SystemShutdownEvent,
|
|
16035
|
-
ExtensionsEnabledEvent,
|
|
16036
|
-
ExtensionsDisabledEvent,
|
|
16037
|
-
ExtensionsExcludedEvent,
|
|
16038
|
-
ExtensionsInstalledEvent,
|
|
16039
|
-
ExtensionInstalledEvent,
|
|
16040
|
-
ExtensionsInstallFailedEvent,
|
|
16041
|
-
ExtensionInstallFailedEvent,
|
|
16042
|
-
ExtensionsInitializationFailedEvent,
|
|
16043
15536
|
Event_11 as Event,
|
|
16044
15537
|
SystemEvent,
|
|
16045
15538
|
EventType_8 as EventType,
|
|
@@ -16364,9 +15857,9 @@ declare type TransitionBase = {
|
|
|
16364
15857
|
*/
|
|
16365
15858
|
duration: number;
|
|
16366
15859
|
/**
|
|
16367
|
-
*
|
|
15860
|
+
* @defaultValue false
|
|
16368
15861
|
*
|
|
16369
|
-
*
|
|
15862
|
+
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16370
15863
|
*/
|
|
16371
15864
|
relative?: boolean;
|
|
16372
15865
|
};
|
|
@@ -16382,9 +15875,9 @@ declare type TransitionOptions = {
|
|
|
16382
15875
|
*/
|
|
16383
15876
|
interrupt: boolean;
|
|
16384
15877
|
/**
|
|
16385
|
-
*
|
|
15878
|
+
* @defaultValue false
|
|
16386
15879
|
*
|
|
16387
|
-
*
|
|
15880
|
+
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16388
15881
|
*/
|
|
16389
15882
|
relative?: boolean;
|
|
16390
15883
|
tween?: tween;
|
|
@@ -16960,7 +16453,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
|
16960
16453
|
*/
|
|
16961
16454
|
getInfo: () => Promise<OpenFin.ViewInfo>;
|
|
16962
16455
|
/**
|
|
16963
|
-
* Retrieves the
|
|
16456
|
+
* Retrieves the layout for the window the view is attached to.
|
|
16964
16457
|
*
|
|
16965
16458
|
* @example
|
|
16966
16459
|
* ```js
|
|
@@ -17158,24 +16651,6 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
|
|
|
17158
16651
|
options?: Partial<ViewOptions>;
|
|
17159
16652
|
};
|
|
17160
16653
|
|
|
17161
|
-
/**
|
|
17162
|
-
* @interface
|
|
17163
|
-
*/
|
|
17164
|
-
declare type ViewCreationFailure = {
|
|
17165
|
-
/**
|
|
17166
|
-
* The identity of the created view
|
|
17167
|
-
*/
|
|
17168
|
-
identity: Identity_4;
|
|
17169
|
-
/**
|
|
17170
|
-
* Whether the view was created with errors
|
|
17171
|
-
*/
|
|
17172
|
-
success: false;
|
|
17173
|
-
/**
|
|
17174
|
-
* Error thrown during view creation
|
|
17175
|
-
*/
|
|
17176
|
-
error: Error;
|
|
17177
|
-
};
|
|
17178
|
-
|
|
17179
16654
|
/**
|
|
17180
16655
|
* The options object required by {@link View.ViewModule.create View.create}.
|
|
17181
16656
|
*
|
|
@@ -17191,25 +16666,6 @@ declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
|
17191
16666
|
|
|
17192
16667
|
declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
|
|
17193
16668
|
|
|
17194
|
-
/**
|
|
17195
|
-
* A view creation state
|
|
17196
|
-
*/
|
|
17197
|
-
declare type ViewCreationResult = ViewCreationSuccess | ViewCreationFailure;
|
|
17198
|
-
|
|
17199
|
-
/**
|
|
17200
|
-
* @interface
|
|
17201
|
-
*/
|
|
17202
|
-
declare type ViewCreationSuccess = {
|
|
17203
|
-
/**
|
|
17204
|
-
* The identity of the created view
|
|
17205
|
-
*/
|
|
17206
|
-
identity: Identity_4;
|
|
17207
|
-
/**
|
|
17208
|
-
* Whether the view was created without errors
|
|
17209
|
-
*/
|
|
17210
|
-
success: true;
|
|
17211
|
-
};
|
|
17212
|
-
|
|
17213
16669
|
/**
|
|
17214
16670
|
* Generated when a window has a view detached from it.
|
|
17215
16671
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
|
@@ -17371,9 +16827,6 @@ declare class ViewModule extends Base {
|
|
|
17371
16827
|
*/
|
|
17372
16828
|
declare type ViewOptions = ConstViewOptions & MutableViewOptions;
|
|
17373
16829
|
|
|
17374
|
-
/**
|
|
17375
|
-
* @interface
|
|
17376
|
-
*/
|
|
17377
16830
|
declare type ViewShowAtOptions = {
|
|
17378
16831
|
/**
|
|
17379
16832
|
* Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
|
|
@@ -17449,9 +16902,9 @@ declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
|
|
|
17449
16902
|
*/
|
|
17450
16903
|
declare type ViewVisibilityOption = {
|
|
17451
16904
|
/**
|
|
17452
|
-
*
|
|
16905
|
+
* @defaultValue false
|
|
17453
16906
|
*
|
|
17454
|
-
*
|
|
16907
|
+
* Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
|
|
17455
16908
|
*/
|
|
17456
16909
|
enabled?: boolean;
|
|
17457
16910
|
};
|
|
@@ -18075,7 +17528,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18075
17528
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
18076
17529
|
* });
|
|
18077
17530
|
*
|
|
18078
|
-
* await view.navigate('
|
|
17531
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
18079
17532
|
*
|
|
18080
17533
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
18081
17534
|
* ```
|
|
@@ -18086,7 +17539,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18086
17539
|
* name:'child',
|
|
18087
17540
|
* defaultWidth: 300,
|
|
18088
17541
|
* defaultHeight: 300,
|
|
18089
|
-
* url: '
|
|
17542
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
18090
17543
|
* frame: true,
|
|
18091
17544
|
* autoShow: true
|
|
18092
17545
|
* };
|
|
@@ -18111,7 +17564,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18111
17564
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
18112
17565
|
* });
|
|
18113
17566
|
*
|
|
18114
|
-
* await view.navigate('
|
|
17567
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
18115
17568
|
*
|
|
18116
17569
|
* await view.inspectSharedWorker();
|
|
18117
17570
|
* ```
|
|
@@ -18122,7 +17575,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18122
17575
|
* name:'child',
|
|
18123
17576
|
* defaultWidth: 300,
|
|
18124
17577
|
* defaultHeight: 300,
|
|
18125
|
-
* url: '
|
|
17578
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
18126
17579
|
* frame: true,
|
|
18127
17580
|
* autoShow: true
|
|
18128
17581
|
* };
|
|
@@ -18148,7 +17601,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18148
17601
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
18149
17602
|
* });
|
|
18150
17603
|
*
|
|
18151
|
-
* await view.navigate('
|
|
17604
|
+
* await view.navigate('http://mdn.github.io/simple-shared-worker/index2.html');
|
|
18152
17605
|
*
|
|
18153
17606
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
18154
17607
|
* await view.inspectSharedWorkerById(sharedWorkers[0].id);
|
|
@@ -18160,7 +17613,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18160
17613
|
* name:'child',
|
|
18161
17614
|
* defaultWidth: 300,
|
|
18162
17615
|
* defaultHeight: 300,
|
|
18163
|
-
* url: '
|
|
17616
|
+
* url: 'http://mdn.github.io/simple-shared-worker/index2.html',
|
|
18164
17617
|
* frame: true,
|
|
18165
17618
|
* autoShow: true
|
|
18166
17619
|
* };
|
|
@@ -18422,19 +17875,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
18422
17875
|
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
18423
17876
|
*/
|
|
18424
17877
|
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
17878
|
}
|
|
18439
17879
|
|
|
18440
17880
|
/**
|
|
@@ -18473,8 +17913,10 @@ declare namespace WebContentsEvents {
|
|
|
18473
17913
|
FileDownloadProgressEvent,
|
|
18474
17914
|
FileDownloadCompletedEvent,
|
|
18475
17915
|
ContentBlockedEvent,
|
|
18476
|
-
|
|
18477
|
-
|
|
17916
|
+
SerializedImage,
|
|
17917
|
+
NotificationAction_2 as NotificationAction,
|
|
17918
|
+
NotificationData,
|
|
17919
|
+
NotificationInterceptedEvent,
|
|
18478
17920
|
Event_5 as Event,
|
|
18479
17921
|
WebContentsEvent,
|
|
18480
17922
|
WillPropagateWebContentsEvent,
|
|
@@ -18647,7 +18089,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
|
18647
18089
|
* getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
|
|
18648
18090
|
* ```
|
|
18649
18091
|
*/
|
|
18650
|
-
getBounds(
|
|
18092
|
+
getBounds(): Promise<OpenFin.WindowBounds>;
|
|
18651
18093
|
/**
|
|
18652
18094
|
* Centers the window on its current screen.
|
|
18653
18095
|
*
|
|
@@ -19614,10 +19056,6 @@ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
|
|
|
19614
19056
|
declare type WindowBounds = Bounds & {
|
|
19615
19057
|
bottom: number;
|
|
19616
19058
|
right: number;
|
|
19617
|
-
/**
|
|
19618
|
-
* The bounds for the window's web content, excluding any OS border
|
|
19619
|
-
*/
|
|
19620
|
-
content: Bounds;
|
|
19621
19059
|
};
|
|
19622
19060
|
|
|
19623
19061
|
/**
|