@openfin/core 34.78.5 → 34.78.9
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/mock-alpha.d.ts +461 -56
- package/out/mock-beta.d.ts +461 -56
- package/out/mock-public.d.ts +461 -56
- package/out/mock.d.ts +463 -58
- package/out/mock.js +257 -208
- package/package.json +1 -1
package/out/mock-public.d.ts
CHANGED
|
@@ -52,6 +52,7 @@ declare type AddViewToStackOptions = {
|
|
|
52
52
|
|
|
53
53
|
/**
|
|
54
54
|
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
|
55
|
+
* @interface
|
|
55
56
|
*/
|
|
56
57
|
declare type AlertRequestedEvent = NamedEvent & {
|
|
57
58
|
type: 'alert-requested';
|
|
@@ -810,6 +811,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
810
811
|
|
|
811
812
|
/**
|
|
812
813
|
* Generated when an application has authenticated and is connected.
|
|
814
|
+
* @interface
|
|
813
815
|
*/
|
|
814
816
|
declare type ApplicationConnectedEvent = IdentityEvent & {
|
|
815
817
|
type: 'connected';
|
|
@@ -817,6 +819,7 @@ declare type ApplicationConnectedEvent = IdentityEvent & {
|
|
|
817
819
|
|
|
818
820
|
/**
|
|
819
821
|
* Generated when an application is created.
|
|
822
|
+
* @interface
|
|
820
823
|
*/
|
|
821
824
|
declare type ApplicationCreatedEvent = IdentityEvent & {
|
|
822
825
|
type: 'application-created';
|
|
@@ -831,11 +834,10 @@ declare type ApplicationCreatedEvent = IdentityEvent & {
|
|
|
831
834
|
* * `url` is optional in both the app manifest {@link Application.ApplicationModule.start Application.start} and but is usually given
|
|
832
835
|
* (defaults to `"about:blank"` when omitted).
|
|
833
836
|
*
|
|
834
|
-
* _This jsdoc typedef mirrors the `ApplicationOption` TypeScript interface in `@types/openfin`._
|
|
835
|
-
*
|
|
836
837
|
* **IMPORTANT NOTE:**
|
|
837
838
|
* This object inherits all the properties of the window creation {@link OpenFin.WindowCreationOptions options} object,
|
|
838
839
|
* which will take priority over those of the same name that may be provided in `mainWindowOptions`.
|
|
840
|
+
* @interface
|
|
839
841
|
*/
|
|
840
842
|
declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
|
|
841
843
|
name: string;
|
|
@@ -903,6 +905,9 @@ declare type ApplicationInfo = {
|
|
|
903
905
|
};
|
|
904
906
|
};
|
|
905
907
|
|
|
908
|
+
/**
|
|
909
|
+
* Static namespace for OpenFin API methods that interact with the {@link Application} class, available under `fin.Application`.
|
|
910
|
+
*/
|
|
906
911
|
declare class ApplicationModule extends Base {
|
|
907
912
|
/**
|
|
908
913
|
* Asynchronously returns an Application object that represents an existing application.
|
|
@@ -1083,6 +1088,7 @@ declare class ApplicationModule extends Base {
|
|
|
1083
1088
|
|
|
1084
1089
|
/**
|
|
1085
1090
|
* The complete set of options for an application.
|
|
1091
|
+
* @interface
|
|
1086
1092
|
*/
|
|
1087
1093
|
declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
1088
1094
|
/**
|
|
@@ -1276,6 +1282,10 @@ declare type AppProcessInfo = {
|
|
|
1276
1282
|
entities: EntityProcessDetails[];
|
|
1277
1283
|
};
|
|
1278
1284
|
|
|
1285
|
+
/**
|
|
1286
|
+
* Generated when system app versioning is successfully completed.
|
|
1287
|
+
* @interface
|
|
1288
|
+
*/
|
|
1279
1289
|
declare type AppVersionCompleteEvent = {
|
|
1280
1290
|
type: 'app-version-complete';
|
|
1281
1291
|
} & AppVersionProgress;
|
|
@@ -1285,6 +1295,10 @@ declare type AppVersionError = {
|
|
|
1285
1295
|
srcManifest: string;
|
|
1286
1296
|
};
|
|
1287
1297
|
|
|
1298
|
+
/**
|
|
1299
|
+
* Generated when none of fallback manifests is compatible to the system.
|
|
1300
|
+
* @interface
|
|
1301
|
+
*/
|
|
1288
1302
|
declare type AppVersionErrorEvent = {
|
|
1289
1303
|
type: 'app-version-error';
|
|
1290
1304
|
} & AppVersionError;
|
|
@@ -1306,6 +1320,10 @@ declare type AppVersionProgress = {
|
|
|
1306
1320
|
srcManifest: string;
|
|
1307
1321
|
};
|
|
1308
1322
|
|
|
1323
|
+
/**
|
|
1324
|
+
* Generated during the progress of system app versioning.
|
|
1325
|
+
* @interface
|
|
1326
|
+
*/
|
|
1309
1327
|
declare type AppVersionProgressEvent = {
|
|
1310
1328
|
type: 'app-version-progress';
|
|
1311
1329
|
} & AppVersionProgress;
|
|
@@ -1319,6 +1337,10 @@ declare type AppVersionRuntimeInfo = {
|
|
|
1319
1337
|
error: string | null;
|
|
1320
1338
|
};
|
|
1321
1339
|
|
|
1340
|
+
/**
|
|
1341
|
+
* Generated when checking a runtime availability.
|
|
1342
|
+
* @interface
|
|
1343
|
+
*/
|
|
1322
1344
|
declare type AppVersionRuntimeStatusEvent = {
|
|
1323
1345
|
type: 'runtime-status';
|
|
1324
1346
|
} & AppVersionRuntimeInfo;
|
|
@@ -1327,6 +1349,7 @@ declare type AppVersionRuntimeStatusEvent = {
|
|
|
1327
1349
|
|
|
1328
1350
|
/**
|
|
1329
1351
|
* Generated when a View is attached to a window.
|
|
1352
|
+
* @interface
|
|
1330
1353
|
*/
|
|
1331
1354
|
declare type AttachedEvent = BaseViewEvent & {
|
|
1332
1355
|
type: 'attached';
|
|
@@ -1399,6 +1422,7 @@ declare interface AuthorizationPayload {
|
|
|
1399
1422
|
* }
|
|
1400
1423
|
* });
|
|
1401
1424
|
* ```
|
|
1425
|
+
* @interface
|
|
1402
1426
|
*/
|
|
1403
1427
|
declare type AuthRequestedEvent = NamedEvent & {
|
|
1404
1428
|
type: 'auth-requested';
|
|
@@ -1453,6 +1477,7 @@ declare class Base {
|
|
|
1453
1477
|
|
|
1454
1478
|
/**
|
|
1455
1479
|
* A base Channel event.
|
|
1480
|
+
* @interface
|
|
1456
1481
|
*/
|
|
1457
1482
|
declare type BaseChannelEvent = NamedEvent & {
|
|
1458
1483
|
channelName: string;
|
|
@@ -1519,6 +1544,7 @@ declare namespace BaseEvents {
|
|
|
1519
1544
|
|
|
1520
1545
|
/**
|
|
1521
1546
|
* The base frame event.
|
|
1547
|
+
* @interface
|
|
1522
1548
|
*/
|
|
1523
1549
|
declare type BaseFrameEvent = NamedEvent & {
|
|
1524
1550
|
entityType: 'iframe';
|
|
@@ -1539,6 +1565,7 @@ declare type BaseUrlEvent = NamedEvent & {
|
|
|
1539
1565
|
|
|
1540
1566
|
/**
|
|
1541
1567
|
* A base View event.
|
|
1568
|
+
* @interface
|
|
1542
1569
|
*/
|
|
1543
1570
|
declare type BaseViewEvent = NamedEvent & {
|
|
1544
1571
|
target: OpenFin_2.Identity;
|
|
@@ -1558,6 +1585,7 @@ declare interface BeforeUnloadUserDecision {
|
|
|
1558
1585
|
|
|
1559
1586
|
/**
|
|
1560
1587
|
* Generated at the beginning of a user-driven change to a window's size or position.
|
|
1588
|
+
* @interface
|
|
1561
1589
|
*/
|
|
1562
1590
|
declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
1563
1591
|
type: 'begin-user-bounds-changing';
|
|
@@ -1565,6 +1593,7 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
|
1565
1593
|
|
|
1566
1594
|
/**
|
|
1567
1595
|
* Generated when a WebContents loses focus.
|
|
1596
|
+
* @interface
|
|
1568
1597
|
*/
|
|
1569
1598
|
declare type BlurredEvent = NamedEvent & {
|
|
1570
1599
|
type: 'blurred';
|
|
@@ -1579,6 +1608,7 @@ declare type Bounds = {
|
|
|
1579
1608
|
|
|
1580
1609
|
/**
|
|
1581
1610
|
* Generated after changes in a window's size and/or position.
|
|
1611
|
+
* @interface
|
|
1582
1612
|
*/
|
|
1583
1613
|
declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
1584
1614
|
type: 'bounds-changed';
|
|
@@ -1586,6 +1616,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
|
1586
1616
|
|
|
1587
1617
|
/**
|
|
1588
1618
|
* A general bounds change event without event type.
|
|
1619
|
+
* @interface
|
|
1589
1620
|
*/
|
|
1590
1621
|
declare type BoundsChangeEvent = NamedEvent & {
|
|
1591
1622
|
changeType: 0 | 1 | 2;
|
|
@@ -1598,6 +1629,7 @@ declare type BoundsChangeEvent = NamedEvent & {
|
|
|
1598
1629
|
|
|
1599
1630
|
/**
|
|
1600
1631
|
* Generated during changes to a window's size and/or position.
|
|
1632
|
+
* @interface
|
|
1601
1633
|
*/
|
|
1602
1634
|
declare type BoundsChangingEvent = BoundsChangeEvent & {
|
|
1603
1635
|
type: 'bounds-changing';
|
|
@@ -1640,6 +1672,7 @@ declare type Certificate = {
|
|
|
1640
1672
|
|
|
1641
1673
|
/**
|
|
1642
1674
|
* Generated when navigating to a URL that fails certificate validation.
|
|
1675
|
+
* @interface
|
|
1643
1676
|
*/
|
|
1644
1677
|
declare type CertificateErrorEvent = NamedEvent & {
|
|
1645
1678
|
type: 'certificate-error';
|
|
@@ -1659,6 +1692,7 @@ declare type CertificatePrincipal = {
|
|
|
1659
1692
|
|
|
1660
1693
|
/**
|
|
1661
1694
|
* Generated when the certificate selection dialog is shown.
|
|
1695
|
+
* @interface
|
|
1662
1696
|
*/
|
|
1663
1697
|
declare type CertificateSelectionShownEvent = NamedEvent & {
|
|
1664
1698
|
type: 'certificate-selection-shown';
|
|
@@ -1856,7 +1890,7 @@ declare type Channel_3 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
|
|
|
1856
1890
|
|
|
1857
1891
|
declare type ChannelAction = OpenFin_2.ChannelAction;
|
|
1858
1892
|
|
|
1859
|
-
declare type ChannelAction_2 = (payload: unknown, id:
|
|
1893
|
+
declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
|
|
1860
1894
|
|
|
1861
1895
|
declare class ChannelBase {
|
|
1862
1896
|
protected subscriptions: Map<string, ChannelAction>;
|
|
@@ -2135,17 +2169,17 @@ declare class ChannelBase {
|
|
|
2135
2169
|
* provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
|
|
2136
2170
|
* from the provider by registering an action via {@link ChannelClient#register register}.
|
|
2137
2171
|
*
|
|
2138
|
-
* Synchronous Methods:
|
|
2172
|
+
* ### Synchronous Methods:
|
|
2139
2173
|
* * {@link ChannelClient#onDisconnection onDisconnection(listener)}
|
|
2140
2174
|
* * {@link ChannelClient#register register(action, listener)}
|
|
2141
2175
|
* * {@link ChannelClient#remove remove(action)}
|
|
2142
2176
|
*
|
|
2143
|
-
* Asynchronous Methods:
|
|
2177
|
+
* ### Asynchronous Methods:
|
|
2144
2178
|
* * {@link ChannelClient#disconnect disconnect()}
|
|
2145
2179
|
* * {@link ChannelClient#dispatch dispatch(action, payload)}
|
|
2146
2180
|
*
|
|
2147
|
-
* Middleware:
|
|
2148
|
-
*
|
|
2181
|
+
* ### Middleware:
|
|
2182
|
+
* Middleware functions receive the following arguments: (action, payload, senderId).
|
|
2149
2183
|
* The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
|
|
2150
2184
|
* unless it is undefined, in which case the original payload is used. Middleware can be used for side effects.
|
|
2151
2185
|
* * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
|
|
@@ -2160,11 +2194,11 @@ declare class ChannelClient extends ChannelBase {
|
|
|
2160
2194
|
/* Excluded from this release type: closeChannelByEndpointId */
|
|
2161
2195
|
/* Excluded from this release type: handleProviderDisconnect */
|
|
2162
2196
|
/* Excluded from this release type: __constructor */
|
|
2163
|
-
protected processAction: (action: string, payload: any, senderIdentity:
|
|
2197
|
+
protected processAction: (action: string, payload: any, senderIdentity: OpenFin_2.ProviderIdentity | OpenFin_2.ClientIdentity) => Promise<any>;
|
|
2164
2198
|
/**
|
|
2165
2199
|
* a read-only provider identity
|
|
2166
2200
|
*/
|
|
2167
|
-
get providerIdentity():
|
|
2201
|
+
get providerIdentity(): OpenFin_2.ProviderIdentity;
|
|
2168
2202
|
/**
|
|
2169
2203
|
* Dispatch the given action to the channel provider. Returns a promise that resolves with the response from
|
|
2170
2204
|
* the provider for that action.
|
|
@@ -2231,6 +2265,7 @@ declare type ChannelClient_2 = OpenFin_2.ChannelClient;
|
|
|
2231
2265
|
|
|
2232
2266
|
/**
|
|
2233
2267
|
* Generated when a Channel client is connected.
|
|
2268
|
+
* @interface
|
|
2234
2269
|
*/
|
|
2235
2270
|
declare type ChannelConnectedEvent = BaseChannelEvent & {
|
|
2236
2271
|
type: 'connected';
|
|
@@ -2239,6 +2274,7 @@ declare type ChannelConnectedEvent = BaseChannelEvent & {
|
|
|
2239
2274
|
/**
|
|
2240
2275
|
* Options provided on a client connection to a channel.
|
|
2241
2276
|
*
|
|
2277
|
+
* @interface
|
|
2242
2278
|
*/
|
|
2243
2279
|
declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2244
2280
|
/**
|
|
@@ -2265,6 +2301,7 @@ declare type ChannelCreateOptions = {
|
|
|
2265
2301
|
|
|
2266
2302
|
/**
|
|
2267
2303
|
* Generated when a Channel client has disconnected.
|
|
2304
|
+
* @interface
|
|
2268
2305
|
*/
|
|
2269
2306
|
declare type ChannelDisconnectedEvent = BaseChannelEvent & {
|
|
2270
2307
|
type: 'disconnected';
|
|
@@ -2296,27 +2333,27 @@ declare type ChannelEventType = ChannelEvent['type'];
|
|
|
2296
2333
|
|
|
2297
2334
|
declare type ChannelMiddleware = OpenFin_2.ChannelMiddleware;
|
|
2298
2335
|
|
|
2299
|
-
declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity:
|
|
2336
|
+
declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_7 | ClientIdentity_2) => Promise<unknown> | unknown;
|
|
2300
2337
|
|
|
2301
2338
|
/**
|
|
2302
2339
|
* Instance created to enable use of a channel as a provider. Allows for communication with the {@link ChannelClient ChannelClients} by invoking an action on
|
|
2303
2340
|
* a single client via {@link ChannelProvider#dispatch dispatch} or all clients via {@link ChannelProvider#publish publish}
|
|
2304
2341
|
* and to listen for communication from clients by registering an action via {@link ChannelProvider#register register}.
|
|
2305
2342
|
*
|
|
2306
|
-
* Synchronous Methods:
|
|
2343
|
+
* ### Synchronous Methods:
|
|
2307
2344
|
* * {@link ChannelProvider#onConnection onConnection(listener)}
|
|
2308
2345
|
* * {@link ChannelProvider#onDisconnection onDisconnection(listener)}
|
|
2309
2346
|
* * {@link ChannelProvider#publish publish(action, payload)}
|
|
2310
2347
|
* * {@link ChannelProvider#register register(action, listener)}
|
|
2311
2348
|
* * {@link ChannelProvider#remove remove(action)}
|
|
2312
2349
|
*
|
|
2313
|
-
* Asynchronous Methods:
|
|
2350
|
+
* ### Asynchronous Methods:
|
|
2314
2351
|
* * {@link ChannelProvider#destroy destroy()}
|
|
2315
2352
|
* * {@link ChannelProvider#dispatch dispatch(to, action, payload)}
|
|
2316
2353
|
* * {@link ChannelProvider#getAllClientInfo getAllClientInfo()}
|
|
2317
2354
|
*
|
|
2318
|
-
* Middleware:
|
|
2319
|
-
*
|
|
2355
|
+
* ### Middleware:
|
|
2356
|
+
* Middleware functions receive the following arguments: (action, payload, senderId).
|
|
2320
2357
|
* The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
|
|
2321
2358
|
* unless it is undefined, in which case the most recently defined payload is used. Middleware can be used for side effects.
|
|
2322
2359
|
* * {@link ChannelProvider#setDefaultAction setDefaultAction(middleware)}
|
|
@@ -2506,6 +2543,7 @@ declare interface ChannelStrategy<T extends unknown> {
|
|
|
2506
2543
|
|
|
2507
2544
|
/**
|
|
2508
2545
|
* Generated when a child content is blocked to load.
|
|
2546
|
+
* @interface
|
|
2509
2547
|
*/
|
|
2510
2548
|
declare type ChildContentBlockedEvent = ContentCreationRulesEvent & {
|
|
2511
2549
|
type: 'child-content-blocked';
|
|
@@ -2513,6 +2551,7 @@ declare type ChildContentBlockedEvent = ContentCreationRulesEvent & {
|
|
|
2513
2551
|
|
|
2514
2552
|
/**
|
|
2515
2553
|
* Generated when a child content is loaded into a browser.
|
|
2554
|
+
* @interface
|
|
2516
2555
|
*/
|
|
2517
2556
|
declare type ChildContentOpenedInBrowserEvent = ContentCreationRulesEvent & {
|
|
2518
2557
|
type: 'child-content-opened-in-browser';
|
|
@@ -2525,6 +2564,7 @@ declare interface ChildContentOptions {
|
|
|
2525
2564
|
|
|
2526
2565
|
/**
|
|
2527
2566
|
* Generated when a child View is created.
|
|
2567
|
+
* @interface
|
|
2528
2568
|
*/
|
|
2529
2569
|
declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
|
|
2530
2570
|
type: 'child-view-created';
|
|
@@ -2536,6 +2576,7 @@ declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
|
|
|
2536
2576
|
|
|
2537
2577
|
/**
|
|
2538
2578
|
* Generated when a child Window is created.
|
|
2579
|
+
* @interface
|
|
2539
2580
|
*/
|
|
2540
2581
|
declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
2541
2582
|
type: 'child-window-created';
|
|
@@ -2560,9 +2601,9 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
|
|
|
2560
2601
|
private endpointId;
|
|
2561
2602
|
private providerIdentity;
|
|
2562
2603
|
constructor(wire: Transport, messageReceiver: MessageReceiver, endpointId: string, // Provider endpointId is channelId
|
|
2563
|
-
providerIdentity:
|
|
2604
|
+
providerIdentity: ProviderIdentity_4);
|
|
2564
2605
|
onEndpointDisconnect(endpointId: string, listener: () => void): void;
|
|
2565
|
-
receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime |
|
|
2606
|
+
receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_4) => Promise<any>): void;
|
|
2566
2607
|
send: (endpointId: string, action: string, payload: any) => Promise<any>;
|
|
2567
2608
|
close: () => Promise<void>;
|
|
2568
2609
|
closeEndpoint(endpointId: string): Promise<void>;
|
|
@@ -2595,12 +2636,16 @@ declare type ClickedMenuResult<T extends unknown = unknown> = {
|
|
|
2595
2636
|
data: T;
|
|
2596
2637
|
};
|
|
2597
2638
|
|
|
2639
|
+
/**
|
|
2640
|
+
* @interface
|
|
2641
|
+
*/
|
|
2598
2642
|
declare type ClientConnectionPayload = ClientIdentity_2 & ClientInfo;
|
|
2599
2643
|
|
|
2600
2644
|
declare type ClientIdentity = OpenFin_2.ClientIdentity;
|
|
2601
2645
|
|
|
2602
2646
|
/**
|
|
2603
2647
|
* Identity of a channel client
|
|
2648
|
+
* @interface
|
|
2604
2649
|
*/
|
|
2605
2650
|
declare type ClientIdentity_2 = Identity_5 & {
|
|
2606
2651
|
/**
|
|
@@ -2610,12 +2655,16 @@ declare type ClientIdentity_2 = Identity_5 & {
|
|
|
2610
2655
|
isLocalEndpointId: boolean;
|
|
2611
2656
|
};
|
|
2612
2657
|
|
|
2658
|
+
/**
|
|
2659
|
+
* @interface
|
|
2660
|
+
*/
|
|
2613
2661
|
declare type ClientIdentityMultiRuntime = ClientIdentity_2 & {
|
|
2614
2662
|
runtimeUuid: string;
|
|
2615
2663
|
};
|
|
2616
2664
|
|
|
2617
2665
|
/**
|
|
2618
2666
|
* Extended channel client information
|
|
2667
|
+
* @interface
|
|
2619
2668
|
*/
|
|
2620
2669
|
declare type ClientInfo = Omit<ClientIdentity_2, 'isLocalEndpointId'> & {
|
|
2621
2670
|
/**
|
|
@@ -2807,6 +2856,7 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
|
|
|
2807
2856
|
|
|
2808
2857
|
/**
|
|
2809
2858
|
* Generated when an application is closed.
|
|
2859
|
+
* @interface
|
|
2810
2860
|
*/
|
|
2811
2861
|
declare type ClosedEvent = IdentityEvent & {
|
|
2812
2862
|
type: 'closed';
|
|
@@ -3205,6 +3255,9 @@ declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
|
|
|
3205
3255
|
data?: unknown;
|
|
3206
3256
|
};
|
|
3207
3257
|
|
|
3258
|
+
/**
|
|
3259
|
+
* @interface
|
|
3260
|
+
*/
|
|
3208
3261
|
declare type ContentCreationRulesEvent = NamedEvent & {
|
|
3209
3262
|
/**
|
|
3210
3263
|
* The absolute url which triggered this event.
|
|
@@ -3263,6 +3316,9 @@ declare type Context = {
|
|
|
3263
3316
|
type: string;
|
|
3264
3317
|
};
|
|
3265
3318
|
|
|
3319
|
+
/**
|
|
3320
|
+
* @interface
|
|
3321
|
+
*/
|
|
3266
3322
|
declare type ContextForIntent<MetadataType = any> = Context & {
|
|
3267
3323
|
metadata?: MetadataType;
|
|
3268
3324
|
};
|
|
@@ -3365,6 +3421,7 @@ declare type CpuInfo = {
|
|
|
3365
3421
|
|
|
3366
3422
|
/**
|
|
3367
3423
|
* Generated when an application has crashed.
|
|
3424
|
+
* @interface
|
|
3368
3425
|
*/
|
|
3369
3426
|
declare type CrashedEvent = NamedEvent & {
|
|
3370
3427
|
type: 'crashed';
|
|
@@ -3384,6 +3441,9 @@ declare type CrashReporterOptions = {
|
|
|
3384
3441
|
diagnosticsMode: boolean;
|
|
3385
3442
|
};
|
|
3386
3443
|
|
|
3444
|
+
/**
|
|
3445
|
+
* @interface
|
|
3446
|
+
*/
|
|
3387
3447
|
declare type CrashReporterState = CrashReporterOptions & {
|
|
3388
3448
|
/**
|
|
3389
3449
|
* Whether the crash reporter is running
|
|
@@ -3394,6 +3454,7 @@ declare type CrashReporterState = CrashReporterOptions & {
|
|
|
3394
3454
|
|
|
3395
3455
|
/**
|
|
3396
3456
|
* Generated when a View is created.
|
|
3457
|
+
* @interface
|
|
3397
3458
|
*/
|
|
3398
3459
|
declare type CreatedEvent = BaseViewEvent & {
|
|
3399
3460
|
type: 'created';
|
|
@@ -3411,6 +3472,9 @@ declare type CreateViewPayload = {
|
|
|
3411
3472
|
targetView?: Identity_5;
|
|
3412
3473
|
};
|
|
3413
3474
|
|
|
3475
|
+
/**
|
|
3476
|
+
* @interface
|
|
3477
|
+
*/
|
|
3414
3478
|
declare type CreateViewTarget = Identity_5 & {
|
|
3415
3479
|
/**
|
|
3416
3480
|
* If specified, view creation will not attach to a window and caller must
|
|
@@ -3450,6 +3514,7 @@ declare type DefaultDomainSettingsRule = {
|
|
|
3450
3514
|
|
|
3451
3515
|
/**
|
|
3452
3516
|
* Generated when the desktop icon is clicked while it's already running.
|
|
3517
|
+
* @interface
|
|
3453
3518
|
*/
|
|
3454
3519
|
declare type DesktopIconClickedEvent = BaseEvent & {
|
|
3455
3520
|
type: 'desktop-icon-clicked';
|
|
@@ -3457,6 +3522,7 @@ declare type DesktopIconClickedEvent = BaseEvent & {
|
|
|
3457
3522
|
|
|
3458
3523
|
/**
|
|
3459
3524
|
* Generated when a View is destroyed.
|
|
3525
|
+
* @interface
|
|
3460
3526
|
*/
|
|
3461
3527
|
declare type DestroyedEvent = BaseViewEvent & {
|
|
3462
3528
|
type: 'destroyed';
|
|
@@ -3464,6 +3530,7 @@ declare type DestroyedEvent = BaseViewEvent & {
|
|
|
3464
3530
|
|
|
3465
3531
|
/**
|
|
3466
3532
|
* Generated when a page's theme color changes. This is usually due to encountering a meta tag.
|
|
3533
|
+
* @interface
|
|
3467
3534
|
*/
|
|
3468
3535
|
declare type DidChangeThemeColorEvent = NamedEvent & {
|
|
3469
3536
|
type: 'did-change-theme-color';
|
|
@@ -3471,6 +3538,7 @@ declare type DidChangeThemeColorEvent = NamedEvent & {
|
|
|
3471
3538
|
|
|
3472
3539
|
/**
|
|
3473
3540
|
* Generated when load failed.
|
|
3541
|
+
* @interface
|
|
3474
3542
|
*/
|
|
3475
3543
|
declare type DidFailLoadEvent = BaseLoadFailedEvent & {
|
|
3476
3544
|
type: 'did-fail-load';
|
|
@@ -3478,11 +3546,15 @@ declare type DidFailLoadEvent = BaseLoadFailedEvent & {
|
|
|
3478
3546
|
|
|
3479
3547
|
/**
|
|
3480
3548
|
* Generated when the navigation is done, i.e. the spinner of the tab will stop spinning, and the onload event is dispatched.
|
|
3549
|
+
* @interface
|
|
3481
3550
|
*/
|
|
3482
3551
|
declare type DidFinishLoadEvent = NamedEvent & {
|
|
3483
3552
|
type: 'did-finish-load';
|
|
3484
3553
|
};
|
|
3485
3554
|
|
|
3555
|
+
/**
|
|
3556
|
+
* @interface
|
|
3557
|
+
*/
|
|
3486
3558
|
declare type DipRect = RectangleByEdgePositions & {
|
|
3487
3559
|
dipRect: RectangleByEdgePositions;
|
|
3488
3560
|
scaledRect: RectangleByEdgePositions;
|
|
@@ -3495,6 +3567,7 @@ declare type DipScaleRects = {
|
|
|
3495
3567
|
|
|
3496
3568
|
/**
|
|
3497
3569
|
* Generated after a change to a window's size and/or position is attempted while window movement is disabled.
|
|
3570
|
+
* @interface
|
|
3498
3571
|
*/
|
|
3499
3572
|
declare type DisabledMovementBoundsChangedEvent = BoundsChangeEvent & {
|
|
3500
3573
|
type: 'disabled-movement-bounds-changed';
|
|
@@ -3502,12 +3575,13 @@ declare type DisabledMovementBoundsChangedEvent = BoundsChangeEvent & {
|
|
|
3502
3575
|
|
|
3503
3576
|
/**
|
|
3504
3577
|
* Generated while a change to a window's size and/or position is attempted while window movement is disabled.
|
|
3578
|
+
* @interface
|
|
3505
3579
|
*/
|
|
3506
3580
|
declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
3507
3581
|
type: 'disabled-movement-bounds-changing';
|
|
3508
3582
|
};
|
|
3509
3583
|
|
|
3510
|
-
declare type DisconnectionListener = (providerIdentity:
|
|
3584
|
+
declare type DisconnectionListener = (providerIdentity: OpenFin_2.ProviderIdentity) => any;
|
|
3511
3585
|
|
|
3512
3586
|
declare type DisconnectionListener_2 = (identity: ClientIdentity) => any;
|
|
3513
3587
|
|
|
@@ -3578,6 +3652,7 @@ declare type Dpi = {
|
|
|
3578
3652
|
|
|
3579
3653
|
/**
|
|
3580
3654
|
* Generated when a window has been embedded.
|
|
3655
|
+
* @interface
|
|
3581
3656
|
*/
|
|
3582
3657
|
declare type EmbeddedEvent = NamedEvent & {
|
|
3583
3658
|
type: 'embedded';
|
|
@@ -3688,6 +3763,7 @@ declare class EmitterMap {
|
|
|
3688
3763
|
|
|
3689
3764
|
/**
|
|
3690
3765
|
* Generated when a window ends loading.
|
|
3766
|
+
* @interface
|
|
3691
3767
|
*/
|
|
3692
3768
|
declare type EndLoadEvent = NamedEvent & {
|
|
3693
3769
|
type: 'end-load';
|
|
@@ -3695,7 +3771,7 @@ declare type EndLoadEvent = NamedEvent & {
|
|
|
3695
3771
|
isMain: boolean;
|
|
3696
3772
|
};
|
|
3697
3773
|
|
|
3698
|
-
declare type EndpointIdentity = OpenFin_2.ClientIdentity |
|
|
3774
|
+
declare type EndpointIdentity = OpenFin_2.ClientIdentity | ProviderIdentity_3;
|
|
3699
3775
|
|
|
3700
3776
|
declare type EndpointPayload = {
|
|
3701
3777
|
endpointIdentity: EndpointIdentity;
|
|
@@ -3703,6 +3779,7 @@ declare type EndpointPayload = {
|
|
|
3703
3779
|
|
|
3704
3780
|
/**
|
|
3705
3781
|
* Generated at the end of a user-driven change to a window's size or position.
|
|
3782
|
+
* @interface
|
|
3706
3783
|
*/
|
|
3707
3784
|
declare type EndUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
3708
3785
|
type: 'end-user-bounds-changing';
|
|
@@ -3718,6 +3795,9 @@ declare type EntityInfo_2 = {
|
|
|
3718
3795
|
entityType: EntityType;
|
|
3719
3796
|
};
|
|
3720
3797
|
|
|
3798
|
+
/**
|
|
3799
|
+
* @interface
|
|
3800
|
+
*/
|
|
3721
3801
|
declare type EntityProcessDetails = FrameProcessDetails & {
|
|
3722
3802
|
name: string;
|
|
3723
3803
|
uuid: string;
|
|
@@ -3787,7 +3867,7 @@ declare interface Environment {
|
|
|
3787
3867
|
|
|
3788
3868
|
declare type ErrorMiddleware = OpenFin_2.ErrorMiddleware;
|
|
3789
3869
|
|
|
3790
|
-
declare type ErrorMiddleware_2 = (topic: string, error: Error, id:
|
|
3870
|
+
declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
|
|
3791
3871
|
|
|
3792
3872
|
/**
|
|
3793
3873
|
* This function converts JS errors into plain objects
|
|
@@ -3829,7 +3909,7 @@ declare type ExitCode = {
|
|
|
3829
3909
|
/**
|
|
3830
3910
|
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
|
3831
3911
|
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
|
3832
|
-
* Discovery of connections is provided by
|
|
3912
|
+
* Discovery of connections is provided by {@link System.System.getAllExternalApplications getAllExternalApplications}.</a>
|
|
3833
3913
|
*
|
|
3834
3914
|
* Processes that can be wrapped as `ExternalApplication`s include the following:
|
|
3835
3915
|
* - Processes which have connected to an OpenFin runtime via an adapter
|
|
@@ -3933,6 +4013,7 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
|
|
|
3933
4013
|
|
|
3934
4014
|
/**
|
|
3935
4015
|
* Generated when an external application has authenticated and is connected.
|
|
4016
|
+
* @interface
|
|
3936
4017
|
*/
|
|
3937
4018
|
declare type ExternalApplicationConnectedEvent = BaseEvent & {
|
|
3938
4019
|
type: 'connected';
|
|
@@ -3940,6 +4021,7 @@ declare type ExternalApplicationConnectedEvent = BaseEvent & {
|
|
|
3940
4021
|
|
|
3941
4022
|
/**
|
|
3942
4023
|
* Generated when an external application has disconnected.
|
|
4024
|
+
* @interface
|
|
3943
4025
|
*/
|
|
3944
4026
|
declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
|
|
3945
4027
|
type: 'disconnected';
|
|
@@ -3966,6 +4048,9 @@ declare type ExternalApplicationInfo = {
|
|
|
3966
4048
|
parent: Identity_5;
|
|
3967
4049
|
};
|
|
3968
4050
|
|
|
4051
|
+
/**
|
|
4052
|
+
* Static namespace for OpenFin API methods that interact with the {@link ExternalApplication} class, available under `fin.ExternalApplication`.
|
|
4053
|
+
*/
|
|
3969
4054
|
declare class ExternalApplicationModule extends Base {
|
|
3970
4055
|
/**
|
|
3971
4056
|
* Asynchronously returns an External Application object that represents an external application.
|
|
@@ -4010,6 +4095,7 @@ declare type ExternalConnection = {
|
|
|
4010
4095
|
|
|
4011
4096
|
/**
|
|
4012
4097
|
* Generated when an external process has exited.
|
|
4098
|
+
* @interface
|
|
4013
4099
|
*/
|
|
4014
4100
|
declare type ExternalProcessExitedEvent = NamedEvent & {
|
|
4015
4101
|
type: 'external-process-exited';
|
|
@@ -4048,6 +4134,7 @@ declare type ExternalProcessRequestType = {
|
|
|
4048
4134
|
|
|
4049
4135
|
/**
|
|
4050
4136
|
* Generated when an external process has started.
|
|
4137
|
+
* @interface
|
|
4051
4138
|
*/
|
|
4052
4139
|
declare type ExternalProcessStartedEvent = NamedEvent & {
|
|
4053
4140
|
type: 'external-process-started';
|
|
@@ -4056,6 +4143,7 @@ declare type ExternalProcessStartedEvent = NamedEvent & {
|
|
|
4056
4143
|
|
|
4057
4144
|
/**
|
|
4058
4145
|
* Generated when page receives favicon urls.
|
|
4146
|
+
* @interface
|
|
4059
4147
|
*/
|
|
4060
4148
|
declare type FaviconUpdatedEvent = NamedEvent & {
|
|
4061
4149
|
type: 'page-favicon-updated';
|
|
@@ -4073,6 +4161,7 @@ declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
|
|
|
4073
4161
|
|
|
4074
4162
|
/**
|
|
4075
4163
|
* Generated when a file download has completed.
|
|
4164
|
+
* @interface
|
|
4076
4165
|
*/
|
|
4077
4166
|
declare type FileDownloadCompletedEvent = FileDownloadEvent & {
|
|
4078
4167
|
type: 'file-download-completed';
|
|
@@ -4081,6 +4170,7 @@ declare type FileDownloadCompletedEvent = FileDownloadEvent & {
|
|
|
4081
4170
|
|
|
4082
4171
|
/**
|
|
4083
4172
|
* A general file download event without event type.
|
|
4173
|
+
* @interface
|
|
4084
4174
|
*/
|
|
4085
4175
|
declare type FileDownloadEvent = {
|
|
4086
4176
|
/**
|
|
@@ -4132,6 +4222,8 @@ declare type FileDownloadEvent = {
|
|
|
4132
4222
|
/**
|
|
4133
4223
|
* Generated when setFileDownloadLocation api is called.
|
|
4134
4224
|
* @remarks This event will not include the file download location itself. In order to get the new file download location, the user will have to access the secured query API 'getFileDownloadLocation'.
|
|
4225
|
+
*
|
|
4226
|
+
* @interface
|
|
4135
4227
|
*/
|
|
4136
4228
|
declare type FileDownloadLocationChangedEvent = NamedEvent & {
|
|
4137
4229
|
type: 'file-download-location-changed';
|
|
@@ -4139,6 +4231,7 @@ declare type FileDownloadLocationChangedEvent = NamedEvent & {
|
|
|
4139
4231
|
|
|
4140
4232
|
/**
|
|
4141
4233
|
* Generated during file download progress.
|
|
4234
|
+
* @interface
|
|
4142
4235
|
*/
|
|
4143
4236
|
declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
4144
4237
|
type: 'file-download-progress';
|
|
@@ -4151,6 +4244,7 @@ declare type FileDownloadSettings = {
|
|
|
4151
4244
|
|
|
4152
4245
|
/**
|
|
4153
4246
|
* Generated when a file download has started.
|
|
4247
|
+
* @interface
|
|
4154
4248
|
*/
|
|
4155
4249
|
declare type FileDownloadStartedEvent = FileDownloadEvent & {
|
|
4156
4250
|
type: 'file-download-started';
|
|
@@ -4238,6 +4332,7 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
|
|
|
4238
4332
|
|
|
4239
4333
|
/**
|
|
4240
4334
|
* Generated when a WebContents gains focus.
|
|
4335
|
+
* @interface
|
|
4241
4336
|
*/
|
|
4242
4337
|
declare type FocusedEvent = NamedEvent & {
|
|
4243
4338
|
type: 'focused';
|
|
@@ -4245,6 +4340,7 @@ declare type FocusedEvent = NamedEvent & {
|
|
|
4245
4340
|
|
|
4246
4341
|
/**
|
|
4247
4342
|
* Generated when a result is available when calling findInPage.
|
|
4343
|
+
* @interface
|
|
4248
4344
|
*/
|
|
4249
4345
|
declare type FoundInPageEvent = NamedEvent & {
|
|
4250
4346
|
type: 'found-in-page';
|
|
@@ -4383,6 +4479,7 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
|
|
|
4383
4479
|
|
|
4384
4480
|
/**
|
|
4385
4481
|
* Generated when a frame is connected.
|
|
4482
|
+
* @interface
|
|
4386
4483
|
*/
|
|
4387
4484
|
declare type FrameConnectedEvent = BaseFrameEvent & {
|
|
4388
4485
|
type: 'connected';
|
|
@@ -4390,6 +4487,7 @@ declare type FrameConnectedEvent = BaseFrameEvent & {
|
|
|
4390
4487
|
|
|
4391
4488
|
/**
|
|
4392
4489
|
* Generated when a frame has disconnected.
|
|
4490
|
+
* @interface
|
|
4393
4491
|
*/
|
|
4394
4492
|
declare type FrameDisconnectedEvent = BaseFrameEvent & {
|
|
4395
4493
|
type: 'disconnected';
|
|
@@ -4427,6 +4525,9 @@ declare type FrameInfo = {
|
|
|
4427
4525
|
parent: Identity_5;
|
|
4428
4526
|
};
|
|
4429
4527
|
|
|
4528
|
+
/**
|
|
4529
|
+
* Static namespace for OpenFin API methods that interact with the {@link _Frame} class, available under `fin.Frame`.
|
|
4530
|
+
*/
|
|
4430
4531
|
declare class _FrameModule extends Base {
|
|
4431
4532
|
/**
|
|
4432
4533
|
* Asynchronously returns a reference to the specified frame. The frame does not have to exist
|
|
@@ -4476,6 +4577,9 @@ declare class _FrameModule extends Base {
|
|
|
4476
4577
|
getCurrentSync(): OpenFin_2.Frame;
|
|
4477
4578
|
}
|
|
4478
4579
|
|
|
4580
|
+
/**
|
|
4581
|
+
* @interface
|
|
4582
|
+
*/
|
|
4479
4583
|
declare type FrameProcessDetails = ProcessDetails & {
|
|
4480
4584
|
/**
|
|
4481
4585
|
* Current URL associated with the process.
|
|
@@ -4640,18 +4744,11 @@ declare type GpuInfo = {
|
|
|
4640
4744
|
name: string;
|
|
4641
4745
|
};
|
|
4642
4746
|
|
|
4643
|
-
/**
|
|
4644
|
-
* Generated when a window has been hidden.
|
|
4645
|
-
*/
|
|
4646
|
-
declare type HiddenEvent = NamedEvent & {
|
|
4647
|
-
type: 'hidden';
|
|
4648
|
-
reason: 'closing' | 'hide' | 'hide-on-close';
|
|
4649
|
-
};
|
|
4650
|
-
|
|
4651
4747
|
/**
|
|
4652
4748
|
* Generated when a View is hidden.
|
|
4749
|
+
* @interface
|
|
4653
4750
|
*/
|
|
4654
|
-
declare type
|
|
4751
|
+
declare type HiddenEvent = BaseViewEvent & {
|
|
4655
4752
|
type: 'hidden';
|
|
4656
4753
|
};
|
|
4657
4754
|
|
|
@@ -4718,6 +4815,7 @@ declare type Hotkey = {
|
|
|
4718
4815
|
/**
|
|
4719
4816
|
* Generated when a keyboard shortcut defined in the `hotkeys` array in [View options](OpenFin.ViewOptions.html) is pressed inside the view.
|
|
4720
4817
|
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
|
4818
|
+
* @interface
|
|
4721
4819
|
*/
|
|
4722
4820
|
declare type HotkeyEvent = BaseViewEvent & {
|
|
4723
4821
|
type: 'hotkey';
|
|
@@ -4752,6 +4850,7 @@ declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<Add
|
|
|
4752
4850
|
|
|
4753
4851
|
/**
|
|
4754
4852
|
* An Identity event.
|
|
4853
|
+
* @interface
|
|
4755
4854
|
*/
|
|
4756
4855
|
declare type IdentityEvent = BaseEvent & {
|
|
4757
4856
|
uuid: string;
|
|
@@ -4764,6 +4863,7 @@ declare type IdentityEvent = BaseEvent & {
|
|
|
4764
4863
|
* @remarks This method is continuously generated every minute while the user is in idle.
|
|
4765
4864
|
* A user enters idle state when the computer is locked or when there has been no keyboard/mouse activity for 1 minute.
|
|
4766
4865
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
|
4866
|
+
* @interface
|
|
4767
4867
|
*/
|
|
4768
4868
|
declare type IdleEvent = {
|
|
4769
4869
|
type: 'idle-state-changed';
|
|
@@ -4792,6 +4892,7 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
|
|
|
4792
4892
|
|
|
4793
4893
|
/**
|
|
4794
4894
|
* Generated when an application has initialized.
|
|
4895
|
+
* @interface
|
|
4795
4896
|
*/
|
|
4796
4897
|
declare type InitializedEvent = IdentityEvent & {
|
|
4797
4898
|
type: 'initialized';
|
|
@@ -4822,6 +4923,7 @@ declare type InitPlatformOptions = {
|
|
|
4822
4923
|
|
|
4823
4924
|
/**
|
|
4824
4925
|
* Generated when the value of the element changes.
|
|
4926
|
+
* @interface
|
|
4825
4927
|
*/
|
|
4826
4928
|
declare type InputEvent_2 = {
|
|
4827
4929
|
inputType: 'keyUp' | 'keyDown';
|
|
@@ -5293,7 +5395,9 @@ declare class InteropBroker extends Base {
|
|
|
5293
5395
|
* });
|
|
5294
5396
|
* ```
|
|
5295
5397
|
*/
|
|
5296
|
-
handleFiredIntent(intent: OpenFin_2.Intent, clientIdentity: OpenFin_2.ClientIdentity
|
|
5398
|
+
handleFiredIntent(intent: OpenFin_2.Intent, clientIdentity: OpenFin_2.ClientIdentity & {
|
|
5399
|
+
entityType: OpenFin_2.EntityType;
|
|
5400
|
+
}): Promise<unknown>;
|
|
5297
5401
|
/**
|
|
5298
5402
|
* Should be called in {@link InteropBroker#handleFiredIntent InteropBroker.handleFiredIntent}.
|
|
5299
5403
|
* While handleFiredIntent is responsible for launching applications, setIntentTarget is used to tell the InteropBroker which application should receive the intent when it is ready.
|
|
@@ -5322,7 +5426,7 @@ declare class InteropBroker extends Base {
|
|
|
5322
5426
|
* More information on the AppIntent type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/AppIntent).
|
|
5323
5427
|
*
|
|
5324
5428
|
* @param options
|
|
5325
|
-
* @param
|
|
5429
|
+
* @param clientIdentity Identity of the Client making the request.
|
|
5326
5430
|
*
|
|
5327
5431
|
* @example
|
|
5328
5432
|
* ```js
|
|
@@ -5338,7 +5442,9 @@ declare class InteropBroker extends Base {
|
|
|
5338
5442
|
* });
|
|
5339
5443
|
* ```
|
|
5340
5444
|
*/
|
|
5341
|
-
handleInfoForIntent(options: OpenFin_2.InfoForIntentOptions, clientIdentity: OpenFin_2.ClientIdentity
|
|
5445
|
+
handleInfoForIntent(options: OpenFin_2.InfoForIntentOptions, clientIdentity: OpenFin_2.ClientIdentity & {
|
|
5446
|
+
entityType: OpenFin_2.EntityType;
|
|
5447
|
+
}): Promise<unknown>;
|
|
5342
5448
|
/**
|
|
5343
5449
|
* Responsible for returning information on which Intents are meant to handle a specific Context.
|
|
5344
5450
|
* Must be overridden.
|
|
@@ -5379,7 +5485,9 @@ declare class InteropBroker extends Base {
|
|
|
5379
5485
|
* });
|
|
5380
5486
|
* ```
|
|
5381
5487
|
*/
|
|
5382
|
-
handleInfoForIntentsByContext(context: OpenFin_2.Context | OpenFin_2.FindIntentsByContextOptions, clientIdentity: OpenFin_2.ClientIdentity
|
|
5488
|
+
handleInfoForIntentsByContext(context: OpenFin_2.Context | OpenFin_2.FindIntentsByContextOptions, clientIdentity: OpenFin_2.ClientIdentity & {
|
|
5489
|
+
entityType: OpenFin_2.EntityType;
|
|
5490
|
+
}): Promise<unknown>;
|
|
5383
5491
|
/**
|
|
5384
5492
|
* Responsible for resolving an Intent based on a specific Context.
|
|
5385
5493
|
* Must be overridden.
|
|
@@ -5401,7 +5509,7 @@ declare class InteropBroker extends Base {
|
|
|
5401
5509
|
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
|
|
5402
5510
|
*
|
|
5403
5511
|
* @param contextForIntent Data passed between entities and applications.
|
|
5404
|
-
* @param
|
|
5512
|
+
* @param clientIdentity Identity of the Client making the request.
|
|
5405
5513
|
*
|
|
5406
5514
|
* @example
|
|
5407
5515
|
* ```js
|
|
@@ -5417,7 +5525,9 @@ declare class InteropBroker extends Base {
|
|
|
5417
5525
|
* });
|
|
5418
5526
|
* ```
|
|
5419
5527
|
*/
|
|
5420
|
-
handleFiredIntentForContext(contextForIntent: OpenFin_2.ContextForIntent, clientIdentity: OpenFin_2.ClientIdentity
|
|
5528
|
+
handleFiredIntentForContext(contextForIntent: OpenFin_2.ContextForIntent, clientIdentity: OpenFin_2.ClientIdentity & {
|
|
5529
|
+
entityType: OpenFin_2.EntityType;
|
|
5530
|
+
}): Promise<unknown>;
|
|
5421
5531
|
/**
|
|
5422
5532
|
* Provides the identity of any Interop Client that disconnects from the Interop Broker. It is meant to be overriden.
|
|
5423
5533
|
* @param clientIdentity
|
|
@@ -5451,7 +5561,7 @@ declare class InteropBroker extends Base {
|
|
|
5451
5561
|
/**
|
|
5452
5562
|
* Responsible for resolving the fdc3.findInstances call.
|
|
5453
5563
|
* Must be overridden
|
|
5454
|
-
* @param
|
|
5564
|
+
* @param app AppIdentifier that was passed to fdc3.findInstances
|
|
5455
5565
|
* @param clientIdentity Identity of the Client making the request.
|
|
5456
5566
|
*/
|
|
5457
5567
|
fdc3HandleFindInstances(app: AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
|
|
@@ -5476,7 +5586,7 @@ declare class InteropBroker extends Base {
|
|
|
5476
5586
|
* fin.Platform.init({
|
|
5477
5587
|
* interopOverride: async (InteropBroker) => {
|
|
5478
5588
|
* class Override extends InteropBroker {
|
|
5479
|
-
* async invokeContextHandler(
|
|
5589
|
+
* async invokeContextHandler(clientIdentity, handlerId, context) {
|
|
5480
5590
|
* return super.invokeContextHandler(clientIdentity, handlerId, {
|
|
5481
5591
|
* ...context,
|
|
5482
5592
|
* contextMetadata: {
|
|
@@ -5508,7 +5618,7 @@ declare class InteropBroker extends Base {
|
|
|
5508
5618
|
* fin.Platform.init({
|
|
5509
5619
|
* interopOverride: async (InteropBroker) => {
|
|
5510
5620
|
* class Override extends InteropBroker {
|
|
5511
|
-
* async invokeIntentHandler(
|
|
5621
|
+
* async invokeIntentHandler(clientIdentity, handlerId, context) {
|
|
5512
5622
|
* const { context } = intent;
|
|
5513
5623
|
* return super.invokeIntentHandler(clientIdentity, handlerId, {
|
|
5514
5624
|
* ...intent,
|
|
@@ -6336,6 +6446,138 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
6336
6446
|
manifest: any;
|
|
6337
6447
|
};
|
|
6338
6448
|
|
|
6449
|
+
/**
|
|
6450
|
+
*
|
|
6451
|
+
* Layouts give app providers the ability to embed multiple views in a single window. The Layout namespace
|
|
6452
|
+
* enables the initialization and manipulation of a window's Layout. A Layout will
|
|
6453
|
+
* emit events locally on the DOM element representing the layout-container.
|
|
6454
|
+
*
|
|
6455
|
+
*
|
|
6456
|
+
* ### Layout.DOMEvents
|
|
6457
|
+
*
|
|
6458
|
+
* When a Layout is created, it emits events onto the DOM element representing the Layout container.
|
|
6459
|
+
* This Layout container is the DOM element referenced by containerId in {@link Layout.LayoutModule#init Layout.init}.
|
|
6460
|
+
* You can use the built-in event emitter to listen to these events using [addEventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener).
|
|
6461
|
+
* The events are emitted synchronously and only in the process where the Layout exists.
|
|
6462
|
+
* Any values returned by the called listeners are ignored and will be discarded.
|
|
6463
|
+
* If the target DOM element is destroyed, any events that have been set up on that element will be destroyed.
|
|
6464
|
+
*
|
|
6465
|
+
* @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
|
|
6466
|
+
*
|
|
6467
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
|
|
6468
|
+
* Adds a listener to the end of the listeners array for the specified event.
|
|
6469
|
+
* @example
|
|
6470
|
+
* ```js
|
|
6471
|
+
* const myLayoutContainer = document.getElementById('layout-container');
|
|
6472
|
+
*
|
|
6473
|
+
* myLayoutContainer.addEventListener('tab-created', function(event) {
|
|
6474
|
+
* const { tabSelector } = event.detail;
|
|
6475
|
+
* const tabElement = document.getElementById(tabSelector);
|
|
6476
|
+
* const existingColor = tabElement.style.backgroundColor;
|
|
6477
|
+
* tabElement.style.backgroundColor = "red";
|
|
6478
|
+
* setTimeout(() => {
|
|
6479
|
+
* tabElement.style.backgroundColor = existingColor;
|
|
6480
|
+
* }, 2000);
|
|
6481
|
+
* });
|
|
6482
|
+
* ```
|
|
6483
|
+
*
|
|
6484
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
|
|
6485
|
+
* Adds a listener to the end of the listeners array for the specified event.
|
|
6486
|
+
* @example
|
|
6487
|
+
* ```js
|
|
6488
|
+
* const myLayoutContainer = document.getElementById('layout-container');
|
|
6489
|
+
*
|
|
6490
|
+
* const listener = function(event) {
|
|
6491
|
+
* console.log(event.detail);
|
|
6492
|
+
* console.log('container-created event fired once, removing listener');
|
|
6493
|
+
* myLayoutContainer.removeEventListener('container-created', listener);
|
|
6494
|
+
* };
|
|
6495
|
+
*
|
|
6496
|
+
* myLayoutContainer.addEventListener('container-created', listener);
|
|
6497
|
+
* ```
|
|
6498
|
+
*
|
|
6499
|
+
* ### Supported event types are:
|
|
6500
|
+
*
|
|
6501
|
+
* * tab-created
|
|
6502
|
+
* * container-created
|
|
6503
|
+
* * layout-state-changed
|
|
6504
|
+
* * tab-closed
|
|
6505
|
+
* * tab-dropped
|
|
6506
|
+
*
|
|
6507
|
+
* ### Layout DOM Node Events
|
|
6508
|
+
*
|
|
6509
|
+
* #### tab-created
|
|
6510
|
+
* Generated when a tab is created. As a user drags and drops tabs within window, new tabs are created. A single view may have multiple tabs created and destroyed during its lifetime attached to a single window.
|
|
6511
|
+
* ```js
|
|
6512
|
+
* // The response has the following shape in event.detail:
|
|
6513
|
+
* {
|
|
6514
|
+
* containerSelector: "container-component_A",
|
|
6515
|
+
* name: "component_A",
|
|
6516
|
+
* tabSelector: "tab-component_A",
|
|
6517
|
+
* topic: "openfin-DOM-event",
|
|
6518
|
+
* type: "tab-created",
|
|
6519
|
+
* uuid: "OpenFin POC"
|
|
6520
|
+
* }
|
|
6521
|
+
* ```
|
|
6522
|
+
*
|
|
6523
|
+
* #### container-created
|
|
6524
|
+
* Generated when a container is created. A single view will have only one container during its lifetime attached to a single window and the container's lifecycle is tied to the view. To discover when the container is destroyed, please listen to view-detached event.
|
|
6525
|
+
* ```js
|
|
6526
|
+
* // The response has the following shape in event.detail:
|
|
6527
|
+
* {
|
|
6528
|
+
* containerSelector: "container-component_A",
|
|
6529
|
+
* name: "component_A",
|
|
6530
|
+
* tabSelector: "tab-component_A",
|
|
6531
|
+
* topic: "openfin-DOM-event",
|
|
6532
|
+
* type: "container-created",
|
|
6533
|
+
* uuid: "OpenFin POC"
|
|
6534
|
+
* }
|
|
6535
|
+
* ```
|
|
6536
|
+
*
|
|
6537
|
+
* ### layout-state-changed
|
|
6538
|
+
* Generated when the state of the layout changes in any way, such as a view added/removed/replaced. Note that this event can fire frequently as the underlying layout can change multiple components from all kinds of changes (resizing for example). Given this, it is recommended to debounce this event and then you can use the {@link Layout#getConfig Layout.getConfig} API to retrieve the most up-to-date state.
|
|
6539
|
+
* ```js
|
|
6540
|
+
* // The response has the following shape in event.detail
|
|
6541
|
+
* {
|
|
6542
|
+
* containerSelector: "container-component_A",
|
|
6543
|
+
* name: "component_A",
|
|
6544
|
+
* tabSelector: "tab-component_A",
|
|
6545
|
+
* topic: "openfin-DOM-event",
|
|
6546
|
+
* type: "layout-state-changed",
|
|
6547
|
+
* uuid: "OpenFin POC"
|
|
6548
|
+
* }
|
|
6549
|
+
* ```
|
|
6550
|
+
*
|
|
6551
|
+
* #### tab-closed
|
|
6552
|
+
* Generated when a tab is closed.
|
|
6553
|
+
* ```js
|
|
6554
|
+
* // The response has the following shape in event.detail:
|
|
6555
|
+
* {
|
|
6556
|
+
* containerSelector: "container-component_A",
|
|
6557
|
+
* name: "component_A",
|
|
6558
|
+
* tabSelector: "tab-component_A",
|
|
6559
|
+
* topic: "openfin-DOM-event",
|
|
6560
|
+
* type: "tab-closed",
|
|
6561
|
+
* uuid: "OpenFin POC",
|
|
6562
|
+
* url: "http://openfin.co" // The url of the view that was closed.
|
|
6563
|
+
* }
|
|
6564
|
+
* ```
|
|
6565
|
+
*
|
|
6566
|
+
* #### tab-dropped
|
|
6567
|
+
* Generated when a tab is dropped.
|
|
6568
|
+
* ```js
|
|
6569
|
+
* // The response has the following shape in event.detail:
|
|
6570
|
+
* {
|
|
6571
|
+
* containerSelector: "container-component_A",
|
|
6572
|
+
* name: "component_A",
|
|
6573
|
+
* tabSelector: "tab-component_A",
|
|
6574
|
+
* topic: "openfin-DOM-event",
|
|
6575
|
+
* type: "tab-dropped",
|
|
6576
|
+
* uuid: "OpenFin POC",
|
|
6577
|
+
* url: "http://openfin.co" // The url of the view linked to the dropped tab.
|
|
6578
|
+
* }
|
|
6579
|
+
* ```
|
|
6580
|
+
*/
|
|
6339
6581
|
declare class Layout extends Base {
|
|
6340
6582
|
#private;
|
|
6341
6583
|
/* Excluded from this release type: init */
|
|
@@ -6516,6 +6758,7 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
|
|
|
6516
6758
|
|
|
6517
6759
|
/**
|
|
6518
6760
|
* Generated when a window and all of its layout's views have either finished or failed navigation.
|
|
6761
|
+
* @interface
|
|
6519
6762
|
*/
|
|
6520
6763
|
declare type LayoutInitializedEvent = NamedEvent & {
|
|
6521
6764
|
type: 'layout-initialized';
|
|
@@ -6633,6 +6876,9 @@ declare class LayoutManager {
|
|
|
6633
6876
|
private setComponentState;
|
|
6634
6877
|
}
|
|
6635
6878
|
|
|
6879
|
+
/**
|
|
6880
|
+
* Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
|
|
6881
|
+
*/
|
|
6636
6882
|
declare class LayoutModule extends Base {
|
|
6637
6883
|
#private;
|
|
6638
6884
|
/**
|
|
@@ -6829,6 +7075,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
|
6829
7075
|
|
|
6830
7076
|
/**
|
|
6831
7077
|
* Generated when a window and all of its layout's views have been created and can receive API calls.
|
|
7078
|
+
* @interface
|
|
6832
7079
|
*/
|
|
6833
7080
|
declare type LayoutReadyEvent = NamedEvent & {
|
|
6834
7081
|
type: 'layout-ready';
|
|
@@ -6936,6 +7183,7 @@ declare type Manifest = {
|
|
|
6936
7183
|
|
|
6937
7184
|
/**
|
|
6938
7185
|
* Generated when the RVM notifies an application that the manifest has changed.
|
|
7186
|
+
* @interface
|
|
6939
7187
|
*/
|
|
6940
7188
|
declare type ManifestChangedEvent = IdentityEvent & {
|
|
6941
7189
|
type: 'manifest-changed';
|
|
@@ -6979,6 +7227,7 @@ declare type MatchPattern = string;
|
|
|
6979
7227
|
|
|
6980
7228
|
/**
|
|
6981
7229
|
* Generated when a window is maximized.
|
|
7230
|
+
* @interface
|
|
6982
7231
|
*/
|
|
6983
7232
|
declare type MaximizedEvent = NamedEvent & {
|
|
6984
7233
|
type: 'maximized';
|
|
@@ -7051,6 +7300,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
|
|
|
7051
7300
|
|
|
7052
7301
|
/**
|
|
7053
7302
|
* Generated when a window is minimized.
|
|
7303
|
+
* @interface
|
|
7054
7304
|
*/
|
|
7055
7305
|
declare type MinimizedEvent = NamedEvent & {
|
|
7056
7306
|
type: 'minimized';
|
|
@@ -7096,6 +7346,7 @@ declare type MonitorDetails = {
|
|
|
7096
7346
|
* Generated on changes of a monitor's size/location.
|
|
7097
7347
|
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
|
7098
7348
|
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
|
7349
|
+
* @interface
|
|
7099
7350
|
*/
|
|
7100
7351
|
declare type MonitorEvent = OpenFin_2.MonitorInfo & {
|
|
7101
7352
|
type: 'monitor-info-changed';
|
|
@@ -7443,6 +7694,7 @@ declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => v
|
|
|
7443
7694
|
|
|
7444
7695
|
/**
|
|
7445
7696
|
* A Name event.
|
|
7697
|
+
* @interface
|
|
7446
7698
|
*/
|
|
7447
7699
|
declare type NamedEvent = IdentityEvent & {
|
|
7448
7700
|
name: string;
|
|
@@ -7454,6 +7706,7 @@ declare type NativeWindowIntegrationProviderAuthorization = {
|
|
|
7454
7706
|
|
|
7455
7707
|
/**
|
|
7456
7708
|
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
|
|
7709
|
+
* @interface
|
|
7457
7710
|
*/
|
|
7458
7711
|
declare type NavigationRejectedEvent = NamedEvent & {
|
|
7459
7712
|
type: 'navigation-rejected';
|
|
@@ -7474,6 +7727,9 @@ declare type NavigationRules = {
|
|
|
7474
7727
|
|
|
7475
7728
|
declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
|
|
7476
7729
|
|
|
7730
|
+
/**
|
|
7731
|
+
* @interface
|
|
7732
|
+
*/
|
|
7477
7733
|
declare type NonAppProcessDetails = ProcessDetails & {
|
|
7478
7734
|
name: string;
|
|
7479
7735
|
};
|
|
@@ -7497,6 +7753,7 @@ declare type NonPropagatedWindowEvent = NonPropagatedWebContentsEvent;
|
|
|
7497
7753
|
|
|
7498
7754
|
/**
|
|
7499
7755
|
* Generated when an application is not responding.
|
|
7756
|
+
* @interface
|
|
7500
7757
|
*/
|
|
7501
7758
|
declare type NotRespondingEvent = IdentityEvent & {
|
|
7502
7759
|
type: 'not-responding';
|
|
@@ -7504,6 +7761,9 @@ declare type NotRespondingEvent = IdentityEvent & {
|
|
|
7504
7761
|
|
|
7505
7762
|
declare type OnlyIfCompatible<A, B, D = OverlapsOnlyIfMatching<A, B>> = D extends Record<any, never> ? keyof D extends never ? A | B : never : A | B;
|
|
7506
7763
|
|
|
7764
|
+
/**
|
|
7765
|
+
* @interface
|
|
7766
|
+
*/
|
|
7507
7767
|
declare type Opacity = TransitionBase & {
|
|
7508
7768
|
/**
|
|
7509
7769
|
* The opacity from 0.0 (transparent) to 1.0 (normal).
|
|
@@ -7738,7 +7998,7 @@ declare namespace OpenFin_2 {
|
|
|
7738
7998
|
ContextForIntent,
|
|
7739
7999
|
InfoForIntentOptions,
|
|
7740
8000
|
FindIntentsByContextOptions,
|
|
7741
|
-
|
|
8001
|
+
ProviderIdentity_7 as ProviderIdentity,
|
|
7742
8002
|
RegisterUsageData,
|
|
7743
8003
|
ViewsPreventingUnloadPayload,
|
|
7744
8004
|
BeforeUnloadUserDecision,
|
|
@@ -7810,7 +8070,8 @@ declare namespace OpenFin_2 {
|
|
|
7810
8070
|
InteropLoggingOptions,
|
|
7811
8071
|
Me,
|
|
7812
8072
|
CapturePageOptions,
|
|
7813
|
-
ProcessLoggingOptions
|
|
8073
|
+
ProcessLoggingOptions,
|
|
8074
|
+
PositioningOptions
|
|
7814
8075
|
}
|
|
7815
8076
|
}
|
|
7816
8077
|
export default OpenFin_2;
|
|
@@ -7826,6 +8087,7 @@ declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T>
|
|
|
7826
8087
|
/**
|
|
7827
8088
|
* Generated when page title is set during navigation.
|
|
7828
8089
|
* @remarks explicitSet is false when title is synthesized from file url.
|
|
8090
|
+
* @interface
|
|
7829
8091
|
*/
|
|
7830
8092
|
declare type PageTitleUpdatedEvent = NamedEvent & {
|
|
7831
8093
|
type: 'page-title-updated';
|
|
@@ -7843,6 +8105,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
|
|
|
7843
8105
|
|
|
7844
8106
|
/**
|
|
7845
8107
|
* Generated when window finishes loading. Provides performance and navigation data.
|
|
8108
|
+
* @interface
|
|
7846
8109
|
*/
|
|
7847
8110
|
declare type PerformanceReportEvent = Performance & NamedEvent & {
|
|
7848
8111
|
type: 'performance-report';
|
|
@@ -8481,6 +8744,7 @@ declare type Platform_2 = OpenFin_2.Platform;
|
|
|
8481
8744
|
|
|
8482
8745
|
/**
|
|
8483
8746
|
* Generated when a new Platform's API becomes responsive.
|
|
8747
|
+
* @interface
|
|
8484
8748
|
*/
|
|
8485
8749
|
declare type PlatformApiReadyEvent = BaseEvent & {
|
|
8486
8750
|
topic: 'application';
|
|
@@ -8502,6 +8766,9 @@ declare namespace PlatformEvents {
|
|
|
8502
8766
|
}
|
|
8503
8767
|
}
|
|
8504
8768
|
|
|
8769
|
+
/**
|
|
8770
|
+
* Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
|
|
8771
|
+
*/
|
|
8505
8772
|
declare class PlatformModule extends Base {
|
|
8506
8773
|
private _channel;
|
|
8507
8774
|
Layout: LayoutModule;
|
|
@@ -8658,6 +8925,7 @@ declare class PlatformModule extends Base {
|
|
|
8658
8925
|
/**
|
|
8659
8926
|
* The options object required by {@link Platform.PlatformModule#start Platform.start}
|
|
8660
8927
|
* Any {@link ApplicationOptions Application option} is also a valid platform option
|
|
8928
|
+
* @interface
|
|
8661
8929
|
*/
|
|
8662
8930
|
declare type PlatformOptions = ApplicationCreationOptions & {
|
|
8663
8931
|
/**
|
|
@@ -9166,6 +9434,7 @@ declare interface PlatformProvider {
|
|
|
9166
9434
|
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
|
9167
9435
|
*
|
|
9168
9436
|
* _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
|
|
9437
|
+
* @interface
|
|
9169
9438
|
*/
|
|
9170
9439
|
declare type PlatformSnapshotAppliedEvent = BaseEvent & {
|
|
9171
9440
|
topic: 'application';
|
|
@@ -9174,6 +9443,9 @@ declare type PlatformSnapshotAppliedEvent = BaseEvent & {
|
|
|
9174
9443
|
|
|
9175
9444
|
declare type PlatformViewCreationOptions = Partial<ViewOptions>;
|
|
9176
9445
|
|
|
9446
|
+
/**
|
|
9447
|
+
* @interface
|
|
9448
|
+
*/
|
|
9177
9449
|
declare type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
|
|
9178
9450
|
updateStateIfExists?: boolean;
|
|
9179
9451
|
reason?: WindowCreationReason;
|
|
@@ -9184,6 +9456,7 @@ declare type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
|
|
|
9184
9456
|
* Any {@link OpenFin.WindowCreationOptions Window option} is also a valid Default Window option
|
|
9185
9457
|
* used by default in any window that is created in the current platform's scope.
|
|
9186
9458
|
* Individual window options will override these defaults.
|
|
9459
|
+
* @interface
|
|
9187
9460
|
*/
|
|
9188
9461
|
declare type PlatformWindowOptions = WindowCreationOptions & {
|
|
9189
9462
|
/**
|
|
@@ -9251,6 +9524,9 @@ declare interface PopupResult<T = any> {
|
|
|
9251
9524
|
|
|
9252
9525
|
declare type PopupResultBehavior = 'none' | PopupBaseBehavior;
|
|
9253
9526
|
|
|
9527
|
+
/**
|
|
9528
|
+
* @interface
|
|
9529
|
+
*/
|
|
9254
9530
|
declare type Position = TransitionBase & {
|
|
9255
9531
|
/**
|
|
9256
9532
|
* Defaults to the window's current left position in virtual screen coordinates.
|
|
@@ -9262,6 +9538,26 @@ declare type Position = TransitionBase & {
|
|
|
9262
9538
|
top: number;
|
|
9263
9539
|
};
|
|
9264
9540
|
|
|
9541
|
+
/**
|
|
9542
|
+
* Leveraged by the following windowing apis to influence side effects of the positioning.
|
|
9543
|
+
* - {@link OpenFin.Window.moveBy}
|
|
9544
|
+
* - {@link OpenFin.Window.moveTo}
|
|
9545
|
+
* - {@link OpenFin.Window.setBounds}
|
|
9546
|
+
* - {@link OpenFin.Window.resizeBy}
|
|
9547
|
+
* - {@link OpenFin.Window.resizeTo}
|
|
9548
|
+
* @example ```js
|
|
9549
|
+
fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
|
|
9550
|
+
```
|
|
9551
|
+
*/
|
|
9552
|
+
declare interface PositioningOptions {
|
|
9553
|
+
/**
|
|
9554
|
+
* Windows Only.
|
|
9555
|
+
* If set to true, will not restore a maximized window before setting the bounds.
|
|
9556
|
+
* This will have the effect of the maximized window staying maximized and not immediately taking this new position.
|
|
9557
|
+
*/
|
|
9558
|
+
skipRestore?: boolean;
|
|
9559
|
+
}
|
|
9560
|
+
|
|
9265
9561
|
/**
|
|
9266
9562
|
* Context menu item with an implementation provided by OpenFin.
|
|
9267
9563
|
*/
|
|
@@ -9304,6 +9600,7 @@ declare type PreloadScriptInfoRunning = {
|
|
|
9304
9600
|
/**
|
|
9305
9601
|
* Generated after the execution of all of a window's preload scripts.
|
|
9306
9602
|
* @remarks Contains information about all window's preload scripts' final states.
|
|
9603
|
+
* @interface
|
|
9307
9604
|
*/
|
|
9308
9605
|
declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
|
|
9309
9606
|
type: 'preload-script-state-changed';
|
|
@@ -9311,6 +9608,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
|
|
|
9311
9608
|
|
|
9312
9609
|
/**
|
|
9313
9610
|
* A general preload scripts state change event without event type.
|
|
9611
|
+
* @interface
|
|
9314
9612
|
*/
|
|
9315
9613
|
declare type PreloadScriptsStateChangeEvent = NamedEvent & {
|
|
9316
9614
|
preloadScripts: (PreloadScriptInfoRunning & any)[];
|
|
@@ -9319,6 +9617,7 @@ declare type PreloadScriptsStateChangeEvent = NamedEvent & {
|
|
|
9319
9617
|
/**
|
|
9320
9618
|
* Generated during the execution of a window's preload script.
|
|
9321
9619
|
* @remarks Contains information about a single window's preload script's state, for which the event has been raised.
|
|
9620
|
+
* @interface
|
|
9322
9621
|
*/
|
|
9323
9622
|
declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
|
|
9324
9623
|
type: 'preload-script-state-changing';
|
|
@@ -9701,6 +10000,25 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
9701
10000
|
'set-domain-settings': ApiCall<OpenFin_2.ApplicationIdentity & {
|
|
9702
10001
|
domainSettings: OpenFin_2.DefaultDomainSettings;
|
|
9703
10002
|
}, void>;
|
|
10003
|
+
'move-window-by': IdentityCall<WithPositioningOptions<{
|
|
10004
|
+
deltaLeft: number;
|
|
10005
|
+
deltaTop: number;
|
|
10006
|
+
}>>;
|
|
10007
|
+
'move-window': IdentityCall<WithPositioningOptions<{
|
|
10008
|
+
left: number;
|
|
10009
|
+
top: number;
|
|
10010
|
+
}>>;
|
|
10011
|
+
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
|
10012
|
+
deltaWidth: number;
|
|
10013
|
+
deltaHeight: number;
|
|
10014
|
+
anchor: OpenFin_2.AnchorType;
|
|
10015
|
+
}>>;
|
|
10016
|
+
'resize-window': IdentityCall<WithPositioningOptions<{
|
|
10017
|
+
width: number;
|
|
10018
|
+
height: number;
|
|
10019
|
+
anchor: OpenFin_2.AnchorType;
|
|
10020
|
+
}>>;
|
|
10021
|
+
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin_2.Bounds>>>;
|
|
9704
10022
|
}
|
|
9705
10023
|
|
|
9706
10024
|
declare interface ProtocolMapBase {
|
|
@@ -9732,12 +10050,11 @@ declare type ProviderIdentity_5 = OpenFin_2.ProviderIdentity;
|
|
|
9732
10050
|
|
|
9733
10051
|
declare type ProviderIdentity_6 = OpenFin_2.ProviderIdentity;
|
|
9734
10052
|
|
|
9735
|
-
declare type ProviderIdentity_7 = OpenFin_2.ProviderIdentity;
|
|
9736
|
-
|
|
9737
10053
|
/**
|
|
9738
10054
|
* Identity of a channel provider.
|
|
10055
|
+
* @interface
|
|
9739
10056
|
*/
|
|
9740
|
-
declare type
|
|
10057
|
+
declare type ProviderIdentity_7 = Identity_5 & {
|
|
9741
10058
|
/**
|
|
9742
10059
|
* Identifier of the channel.
|
|
9743
10060
|
*/
|
|
@@ -9804,6 +10121,9 @@ declare type QueryPermissionResult = {
|
|
|
9804
10121
|
rawValue?: unknown;
|
|
9805
10122
|
};
|
|
9806
10123
|
|
|
10124
|
+
/**
|
|
10125
|
+
* @interface
|
|
10126
|
+
*/
|
|
9807
10127
|
declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
|
|
9808
10128
|
|
|
9809
10129
|
/**
|
|
@@ -9839,6 +10159,7 @@ declare type RectangleByEdgePositions = {
|
|
|
9839
10159
|
|
|
9840
10160
|
/**
|
|
9841
10161
|
* Generated when a hotkey has been registered with the operating system.
|
|
10162
|
+
* @interface
|
|
9842
10163
|
*/
|
|
9843
10164
|
declare type RegisteredEvent = BaseEvent & {
|
|
9844
10165
|
type: 'registered';
|
|
@@ -9861,6 +10182,7 @@ declare type RegistryInfo_2 = {
|
|
|
9861
10182
|
|
|
9862
10183
|
/**
|
|
9863
10184
|
* Generated when a window has been reloaded.
|
|
10185
|
+
* @interface
|
|
9864
10186
|
*/
|
|
9865
10187
|
declare type ReloadedEvent = NamedEvent & {
|
|
9866
10188
|
type: 'reloaded';
|
|
@@ -9946,6 +10268,7 @@ declare type ResizeRegion = {
|
|
|
9946
10268
|
|
|
9947
10269
|
/**
|
|
9948
10270
|
* Generated when an HTTP load was cancelled or failed.
|
|
10271
|
+
* @interface
|
|
9949
10272
|
*/
|
|
9950
10273
|
declare type ResourceLoadFailedEvent = BaseLoadFailedEvent & {
|
|
9951
10274
|
type: 'resource-load-failed';
|
|
@@ -9953,6 +10276,7 @@ declare type ResourceLoadFailedEvent = BaseLoadFailedEvent & {
|
|
|
9953
10276
|
|
|
9954
10277
|
/**
|
|
9955
10278
|
* Generated when an HTTP resource request has received response details.
|
|
10279
|
+
* @interface
|
|
9956
10280
|
*/
|
|
9957
10281
|
declare type ResourceResponseReceivedEvent = NamedEvent & {
|
|
9958
10282
|
type: 'resource-response-received';
|
|
@@ -9968,6 +10292,7 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
|
|
|
9968
10292
|
|
|
9969
10293
|
/**
|
|
9970
10294
|
* Generated when an application is responding.
|
|
10295
|
+
* @interface
|
|
9971
10296
|
*/
|
|
9972
10297
|
declare type RespondingEvent = IdentityEvent & {
|
|
9973
10298
|
type: 'responding';
|
|
@@ -9981,7 +10306,10 @@ declare type RGB = {
|
|
|
9981
10306
|
green: number;
|
|
9982
10307
|
};
|
|
9983
10308
|
|
|
9984
|
-
|
|
10309
|
+
/**
|
|
10310
|
+
* @interface
|
|
10311
|
+
*/
|
|
10312
|
+
declare type RoutingInfo = OpenFin_2.ProviderIdentity & {
|
|
9985
10313
|
endpointId: string;
|
|
9986
10314
|
};
|
|
9987
10315
|
|
|
@@ -10007,7 +10335,7 @@ declare interface RTCProtocolOffer extends ProtocolPacketBase {
|
|
|
10007
10335
|
declare class RTCStrategy implements ChannelStrategy<RTCStrategyEndpointPayload> {
|
|
10008
10336
|
#private;
|
|
10009
10337
|
onEndpointDisconnect(endpointId: string, listener: () => void): void;
|
|
10010
|
-
receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime |
|
|
10338
|
+
receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_5) => Promise<any>): void;
|
|
10011
10339
|
send: (endpointId: string, action: string, payload: any) => Promise<any>;
|
|
10012
10340
|
close: () => Promise<void>;
|
|
10013
10341
|
private getEndpointById;
|
|
@@ -10019,7 +10347,7 @@ declare class RTCStrategy implements ChannelStrategy<RTCStrategyEndpointPayload>
|
|
|
10019
10347
|
}
|
|
10020
10348
|
|
|
10021
10349
|
declare interface RTCStrategyEndpointPayload {
|
|
10022
|
-
endpointIdentity: OpenFin_2.ClientIdentity |
|
|
10350
|
+
endpointIdentity: OpenFin_2.ClientIdentity | ProviderIdentity_5;
|
|
10023
10351
|
rtc: RTCPacket;
|
|
10024
10352
|
}
|
|
10025
10353
|
|
|
@@ -10027,6 +10355,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
|
|
|
10027
10355
|
|
|
10028
10356
|
/**
|
|
10029
10357
|
* Generated when Application.run() is called for an already running application.
|
|
10358
|
+
* @interface
|
|
10030
10359
|
*/
|
|
10031
10360
|
declare type RunRequestedEvent_2 = IdentityEvent & {
|
|
10032
10361
|
type: 'run-requested';
|
|
@@ -10178,6 +10507,7 @@ declare type ServiceIdentifier = {
|
|
|
10178
10507
|
|
|
10179
10508
|
/**
|
|
10180
10509
|
* Generated on changes to a user’s local computer session.
|
|
10510
|
+
* @interface
|
|
10181
10511
|
*/
|
|
10182
10512
|
declare type SessionChangedEvent = {
|
|
10183
10513
|
type: 'session-changed';
|
|
@@ -10228,12 +10558,16 @@ declare type ShortCutConfig = {
|
|
|
10228
10558
|
systemStartup?: boolean;
|
|
10229
10559
|
};
|
|
10230
10560
|
|
|
10561
|
+
/**
|
|
10562
|
+
* @interface
|
|
10563
|
+
*/
|
|
10231
10564
|
declare type ShortcutOverride = Hotkey & {
|
|
10232
10565
|
command: string;
|
|
10233
10566
|
};
|
|
10234
10567
|
|
|
10235
10568
|
/**
|
|
10236
10569
|
* Generated when a View is shown. This event will fire during creation of a View.
|
|
10570
|
+
* @interface
|
|
10237
10571
|
*/
|
|
10238
10572
|
declare type ShownEvent = BaseViewEvent & {
|
|
10239
10573
|
type: 'shown';
|
|
@@ -10247,6 +10581,7 @@ declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
|
|
|
10247
10581
|
|
|
10248
10582
|
/**
|
|
10249
10583
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
|
10584
|
+
* @interface
|
|
10250
10585
|
*/
|
|
10251
10586
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
10252
10587
|
/**
|
|
@@ -10263,6 +10598,9 @@ declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
|
10263
10598
|
paintIntervalMs?: number;
|
|
10264
10599
|
};
|
|
10265
10600
|
|
|
10601
|
+
/**
|
|
10602
|
+
* @interface
|
|
10603
|
+
*/
|
|
10266
10604
|
declare type Size = TransitionBase & {
|
|
10267
10605
|
/**
|
|
10268
10606
|
* Optional if height is present. Defaults to the window's current width.
|
|
@@ -10339,6 +10677,9 @@ declare class SnapshotSource<T = any> extends Base {
|
|
|
10339
10677
|
applySnapshot(snapshot: T): Promise<void>;
|
|
10340
10678
|
}
|
|
10341
10679
|
|
|
10680
|
+
/**
|
|
10681
|
+
* Static namespace for OpenFin API methods that interact with the {@link SnapshotSource} class, available under `fin.SnapshotSource`.
|
|
10682
|
+
*/
|
|
10342
10683
|
declare class SnapshotSourceModule extends Base {
|
|
10343
10684
|
/**
|
|
10344
10685
|
* Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
|
|
@@ -10417,6 +10758,7 @@ declare type SplitterItem = GoldenLayout.ContentItem & {
|
|
|
10417
10758
|
|
|
10418
10759
|
/**
|
|
10419
10760
|
* Generated when an application has started.
|
|
10761
|
+
* @interface
|
|
10420
10762
|
*/
|
|
10421
10763
|
declare type StartedEvent = IdentityEvent & {
|
|
10422
10764
|
type: 'started';
|
|
@@ -12145,12 +12487,16 @@ declare type TargetApp = string | AppMetadata;
|
|
|
12145
12487
|
* Generated when a View changes its window target.
|
|
12146
12488
|
* @remarks This event will fire during creation of a View.
|
|
12147
12489
|
* In that case, previousTarget identity will be the same as target identity.
|
|
12490
|
+
* @interface
|
|
12148
12491
|
*/
|
|
12149
12492
|
declare type TargetChangedEvent = BaseViewEvent & {
|
|
12150
12493
|
type: 'target-changed';
|
|
12151
12494
|
previousTarget: OpenFin_2.Identity;
|
|
12152
12495
|
};
|
|
12153
12496
|
|
|
12497
|
+
/**
|
|
12498
|
+
* @interface
|
|
12499
|
+
*/
|
|
12154
12500
|
declare type TaskBar = DipScaleRects & {
|
|
12155
12501
|
/**
|
|
12156
12502
|
* Which edge of a monitor the taskbar is on
|
|
@@ -12273,6 +12619,7 @@ declare class Transport<MeType extends EntityType_3 = EntityType_3> extends Even
|
|
|
12273
12619
|
|
|
12274
12620
|
/**
|
|
12275
12621
|
* Generated when the tray icon is clicked.
|
|
12622
|
+
* @interface
|
|
12276
12623
|
*/
|
|
12277
12624
|
declare type TrayIconClickedEvent = IdentityEvent & {
|
|
12278
12625
|
type: 'tray-icon-clicked';
|
|
@@ -12324,6 +12671,7 @@ declare interface TypedEventEmitter<Event extends {
|
|
|
12324
12671
|
|
|
12325
12672
|
/**
|
|
12326
12673
|
* Generated when a hotkey has been unregistered with the operating system.
|
|
12674
|
+
* @interface
|
|
12327
12675
|
*/
|
|
12328
12676
|
declare type UnregisteredEvent = BaseEvent & {
|
|
12329
12677
|
type: 'unregistered';
|
|
@@ -12340,6 +12688,7 @@ declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
|
|
|
12340
12688
|
* Generated when navigation or redirect is completed.
|
|
12341
12689
|
* @remarks Also emitted for in-page navigations, examples of this occurring are when anchor links are clicked or when the DOM hashchange event is triggered, indicated by isInPage=true.
|
|
12342
12690
|
* Note that navigating to a url with an anchor in it like http://openfin.co/#my-inpage-anchor will fire 2 events indicating the original navigation (isInPage=false) and then the in-page navigation event (isInPage=true).
|
|
12691
|
+
* @interface
|
|
12343
12692
|
*/
|
|
12344
12693
|
declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
12345
12694
|
isInPage: true;
|
|
@@ -12351,6 +12700,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
|
12351
12700
|
|
|
12352
12701
|
/**
|
|
12353
12702
|
* A general user bounds change event without event type.
|
|
12703
|
+
* @interface
|
|
12354
12704
|
*/
|
|
12355
12705
|
declare type UserBoundsChangeEvent = NamedEvent & {
|
|
12356
12706
|
height: number;
|
|
@@ -12362,6 +12712,7 @@ declare type UserBoundsChangeEvent = NamedEvent & {
|
|
|
12362
12712
|
|
|
12363
12713
|
/**
|
|
12364
12714
|
* Generated when a window's user movement becomes disabled.
|
|
12715
|
+
* @interface
|
|
12365
12716
|
*/
|
|
12366
12717
|
declare type UserMovementDisabledEvent = NamedEvent & {
|
|
12367
12718
|
type: 'user-movement-disabled';
|
|
@@ -12369,6 +12720,7 @@ declare type UserMovementDisabledEvent = NamedEvent & {
|
|
|
12369
12720
|
|
|
12370
12721
|
/**
|
|
12371
12722
|
* Generated when a window's user movement becomes enabled.
|
|
12723
|
+
* @interface
|
|
12372
12724
|
*/
|
|
12373
12725
|
declare type UserMovementEnabledEvent = NamedEvent & {
|
|
12374
12726
|
type: 'user-movement-enabled';
|
|
@@ -12941,6 +13293,7 @@ declare interface ViewComponent extends GoldenLayout.ContentItem {
|
|
|
12941
13293
|
*
|
|
12942
13294
|
* Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
|
|
12943
13295
|
* (defaults to `"about:blank"` when omitted).
|
|
13296
|
+
* @interface
|
|
12944
13297
|
*/
|
|
12945
13298
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
12946
13299
|
name: string;
|
|
@@ -12953,6 +13306,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
|
|
|
12953
13306
|
/**
|
|
12954
13307
|
* Generated when a window has a view detached from it.
|
|
12955
13308
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
|
13309
|
+
* @interface
|
|
12956
13310
|
*/
|
|
12957
13311
|
declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
|
|
12958
13312
|
type: 'view-detached';
|
|
@@ -12976,7 +13330,7 @@ declare namespace ViewEvents {
|
|
|
12976
13330
|
AttachedEvent,
|
|
12977
13331
|
CreatedEvent,
|
|
12978
13332
|
DestroyedEvent,
|
|
12979
|
-
|
|
13333
|
+
HiddenEvent,
|
|
12980
13334
|
HotkeyEvent,
|
|
12981
13335
|
ShownEvent,
|
|
12982
13336
|
WillPropagateViewEvent,
|
|
@@ -13001,6 +13355,9 @@ declare type ViewInfo = {
|
|
|
13001
13355
|
favicons: string[];
|
|
13002
13356
|
};
|
|
13003
13357
|
|
|
13358
|
+
/**
|
|
13359
|
+
* Static namespace for OpenFin API methods that interact with the {@link View} class, available under `fin.View`.
|
|
13360
|
+
*/
|
|
13004
13361
|
declare class ViewModule extends Base {
|
|
13005
13362
|
/**
|
|
13006
13363
|
* Creates a new View.
|
|
@@ -13083,6 +13440,7 @@ declare class ViewModule extends Base {
|
|
|
13083
13440
|
|
|
13084
13441
|
/**
|
|
13085
13442
|
* User-facing options for a view.
|
|
13443
|
+
* @interface
|
|
13086
13444
|
*/
|
|
13087
13445
|
declare type ViewOptions = ConstViewOptions & MutableViewOptions;
|
|
13088
13446
|
|
|
@@ -13143,6 +13501,9 @@ declare interface ViewsPreventingUnloadPayload {
|
|
|
13143
13501
|
closeType: 'view' | 'window';
|
|
13144
13502
|
}
|
|
13145
13503
|
|
|
13504
|
+
/**
|
|
13505
|
+
* @interface
|
|
13506
|
+
*/
|
|
13146
13507
|
declare type ViewState = ViewCreationOptions & {
|
|
13147
13508
|
backgroundThrottling: boolean;
|
|
13148
13509
|
componentName: 'view';
|
|
@@ -14112,6 +14473,7 @@ declare type WebRequestHeader = {
|
|
|
14112
14473
|
/**
|
|
14113
14474
|
* Generated when a window is being moved by the user.
|
|
14114
14475
|
* @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
|
|
14476
|
+
* @interface
|
|
14115
14477
|
*/
|
|
14116
14478
|
declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
14117
14479
|
type: 'will-move';
|
|
@@ -14119,6 +14481,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
|
14119
14481
|
|
|
14120
14482
|
/**
|
|
14121
14483
|
* A general will-move or will-resize event without event type.
|
|
14484
|
+
* @interface
|
|
14122
14485
|
*/
|
|
14123
14486
|
declare type WillMoveOrResizeEvent = NamedEvent & {
|
|
14124
14487
|
height: number;
|
|
@@ -14136,7 +14499,7 @@ declare type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedE
|
|
|
14136
14499
|
/**
|
|
14137
14500
|
* A View event that does propagate to (republish on) parent topics.
|
|
14138
14501
|
*/
|
|
14139
|
-
declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent |
|
|
14502
|
+
declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
|
|
14140
14503
|
|
|
14141
14504
|
/**
|
|
14142
14505
|
* A WebContents event that does propagate to (republish on) parent topics.
|
|
@@ -14146,10 +14509,11 @@ declare type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelection
|
|
|
14146
14509
|
/**
|
|
14147
14510
|
* A Window event that does propagate to (republish on) parent topics.
|
|
14148
14511
|
*/
|
|
14149
|
-
declare type WillPropagateWindowEvent = WillPropagateWebContentsEvent | PropagatedViewAttachedEvent | ViewDetachedEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | WindowCloseRequestedEvent | WindowClosedEvent | WindowClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent |
|
|
14512
|
+
declare type WillPropagateWindowEvent = WillPropagateWebContentsEvent | PropagatedViewAttachedEvent | ViewDetachedEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | WindowCloseRequestedEvent | WindowClosedEvent | WindowClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | WindowHiddenEvent | WindowHotkeyEvent | WindowInitializedEvent | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | WindowOptionsChangedEvent_2 | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | WindowRestoredEvent | WindowShowRequestedEvent | WindowShownEvent | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent;
|
|
14150
14513
|
|
|
14151
14514
|
/**
|
|
14152
14515
|
* Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
|
|
14516
|
+
* @interface
|
|
14153
14517
|
*/
|
|
14154
14518
|
declare type WillRedirectEvent = NamedEvent & {
|
|
14155
14519
|
type: 'will-redirect';
|
|
@@ -14162,6 +14526,7 @@ declare type WillRedirectEvent = NamedEvent & {
|
|
|
14162
14526
|
* Generated when a window is being resized by the user.
|
|
14163
14527
|
* @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
|
|
14164
14528
|
* The event will fire when a user resize is blocked by window options such as maxWidth or minHeight but not if the window is not resizable.
|
|
14529
|
+
* @interface
|
|
14165
14530
|
*/
|
|
14166
14531
|
declare type WillResizeEvent = WillMoveOrResizeEvent & {
|
|
14167
14532
|
type: 'will-resize';
|
|
@@ -15233,7 +15598,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15233
15598
|
* moveBy(580, 300).then(() => console.log('Moved')).catch(err => console.log(err));
|
|
15234
15599
|
* ```
|
|
15235
15600
|
*/
|
|
15236
|
-
moveBy(deltaLeft: number, deltaTop: number): Promise<void>;
|
|
15601
|
+
moveBy(deltaLeft: number, deltaTop: number, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
|
|
15237
15602
|
/**
|
|
15238
15603
|
* Moves the window to a specified location.
|
|
15239
15604
|
* @param left The left position of the window
|
|
@@ -15259,7 +15624,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15259
15624
|
* moveTo(580, 300).then(() => console.log('Moved')).catch(err => console.log(err))
|
|
15260
15625
|
* ```
|
|
15261
15626
|
*/
|
|
15262
|
-
moveTo(left: number, top: number): Promise<void>;
|
|
15627
|
+
moveTo(left: number, top: number, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
|
|
15263
15628
|
/**
|
|
15264
15629
|
* Resizes the window by a specified amount.
|
|
15265
15630
|
* @param deltaWidth The change in the width of the window
|
|
@@ -15288,7 +15653,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15288
15653
|
* resizeBy(580, 300, 'top-right').then(() => console.log('Resized')).catch(err => console.log(err));
|
|
15289
15654
|
* ```
|
|
15290
15655
|
*/
|
|
15291
|
-
resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin_2.AnchorType): Promise<void>;
|
|
15656
|
+
resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin_2.AnchorType, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
|
|
15292
15657
|
/**
|
|
15293
15658
|
* Resizes the window to the specified dimensions.
|
|
15294
15659
|
* @param width The change in the width of the window
|
|
@@ -15317,7 +15682,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15317
15682
|
* resizeTo(580, 300, 'top-left').then(() => console.log('Resized')).catch(err => console.log(err));
|
|
15318
15683
|
* ```
|
|
15319
15684
|
*/
|
|
15320
|
-
resizeTo(width: number, height: number, anchor: OpenFin_2.AnchorType): Promise<void>;
|
|
15685
|
+
resizeTo(width: number, height: number, anchor: OpenFin_2.AnchorType, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
|
|
15321
15686
|
/**
|
|
15322
15687
|
* Restores the window to its normal state (i.e., unminimized, unmaximized).
|
|
15323
15688
|
*
|
|
@@ -15368,7 +15733,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15368
15733
|
setAsForeground(): Promise<void>;
|
|
15369
15734
|
/**
|
|
15370
15735
|
* Sets the window's size and position.
|
|
15371
|
-
* @property { Bounds } bounds This is a * @type {string} name - name of the window.object that holds the propertys of
|
|
15372
15736
|
*
|
|
15373
15737
|
* @example
|
|
15374
15738
|
* ```js
|
|
@@ -15395,7 +15759,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15395
15759
|
* }).then(() => console.log('Bounds set to window')).catch(err => console.log(err));
|
|
15396
15760
|
* ```
|
|
15397
15761
|
*/
|
|
15398
|
-
setBounds(bounds: Partial<OpenFin_2.Bounds
|
|
15762
|
+
setBounds(bounds: Partial<OpenFin_2.Bounds>, positioningOptions?: OpenFin_2.PositioningOptions): Promise<void>;
|
|
15399
15763
|
/**
|
|
15400
15764
|
* Shows the window if it is hidden.
|
|
15401
15765
|
* @param force Show will be prevented from showing when force is false and
|
|
@@ -15686,6 +16050,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15686
16050
|
|
|
15687
16051
|
/**
|
|
15688
16052
|
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
|
16053
|
+
* @interface
|
|
15689
16054
|
*/
|
|
15690
16055
|
declare type WindowAlertRequestedEvent = NamedEvent & {
|
|
15691
16056
|
type: 'window-alert-requested';
|
|
@@ -15693,6 +16058,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15693
16058
|
|
|
15694
16059
|
/**
|
|
15695
16060
|
* Returned from getBounds call. bottom and right are never used for setting.
|
|
16061
|
+
* @interface
|
|
15696
16062
|
*/
|
|
15697
16063
|
declare type WindowBounds = Bounds & {
|
|
15698
16064
|
bottom: number;
|
|
@@ -15701,6 +16067,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15701
16067
|
|
|
15702
16068
|
/**
|
|
15703
16069
|
* Generated when a window has closed.
|
|
16070
|
+
* @interface
|
|
15704
16071
|
*/
|
|
15705
16072
|
declare type WindowClosedEvent = NamedEvent & {
|
|
15706
16073
|
type: 'closed';
|
|
@@ -15709,6 +16076,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15709
16076
|
/**
|
|
15710
16077
|
* Generated when a window has been prevented from closing.
|
|
15711
16078
|
* @remarks A window will be prevented from closing by default, either through the API or by a user when ‘close-requested’ has been subscribed to and the Window.close(force) flag is false.
|
|
16079
|
+
* @interface
|
|
15712
16080
|
*/
|
|
15713
16081
|
declare type WindowCloseRequestedEvent = NamedEvent & {
|
|
15714
16082
|
type: 'close-requested';
|
|
@@ -15716,6 +16084,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15716
16084
|
|
|
15717
16085
|
/**
|
|
15718
16086
|
* Generated when a window has initiated the closing routine.
|
|
16087
|
+
* @interface
|
|
15719
16088
|
*/
|
|
15720
16089
|
declare type WindowClosingEvent = NamedEvent & {
|
|
15721
16090
|
type: 'closing';
|
|
@@ -15723,6 +16092,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15723
16092
|
|
|
15724
16093
|
/**
|
|
15725
16094
|
* Generated when a child window is created.
|
|
16095
|
+
* @interface
|
|
15726
16096
|
*/
|
|
15727
16097
|
declare type WindowCreatedEvent = NamedEvent & {
|
|
15728
16098
|
type: 'window-created';
|
|
@@ -15733,6 +16103,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15733
16103
|
*
|
|
15734
16104
|
* Note that `name` is the only required property — albeit the `url` property is usually provided as well
|
|
15735
16105
|
* (defaults to `"about:blank"` when omitted).
|
|
16106
|
+
* @interface
|
|
15736
16107
|
*/
|
|
15737
16108
|
declare type WindowCreationOptions = Partial<WindowOptions> & {
|
|
15738
16109
|
name: string;
|
|
@@ -15775,6 +16146,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15775
16146
|
|
|
15776
16147
|
/**
|
|
15777
16148
|
* Generated when a child window ends loading.
|
|
16149
|
+
* @interface
|
|
15778
16150
|
*/
|
|
15779
16151
|
declare type WindowEndLoadEvent = NamedEvent & {
|
|
15780
16152
|
type: 'window-end-load';
|
|
@@ -15799,7 +16171,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15799
16171
|
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
|
15800
16172
|
ExternalProcessExitedEvent,
|
|
15801
16173
|
ExternalProcessStartedEvent,
|
|
15802
|
-
|
|
16174
|
+
WindowHiddenEvent,
|
|
15803
16175
|
PreloadScriptInfoRunning,
|
|
15804
16176
|
PreloadScriptInfo,
|
|
15805
16177
|
PreloadScriptsStateChangeEvent,
|
|
@@ -15849,9 +16221,19 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15849
16221
|
*/
|
|
15850
16222
|
declare type WindowEventType = WindowEvent['type'];
|
|
15851
16223
|
|
|
16224
|
+
/**
|
|
16225
|
+
* Generated when a window has been hidden.
|
|
16226
|
+
* @interface
|
|
16227
|
+
*/
|
|
16228
|
+
declare type WindowHiddenEvent = NamedEvent & {
|
|
16229
|
+
type: 'hidden';
|
|
16230
|
+
reason: 'closing' | 'hide' | 'hide-on-close';
|
|
16231
|
+
};
|
|
16232
|
+
|
|
15852
16233
|
/**
|
|
15853
16234
|
* Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
|
|
15854
16235
|
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
|
16236
|
+
* @interface
|
|
15855
16237
|
*/
|
|
15856
16238
|
declare type WindowHotkeyEvent = InputEvent_2 & NamedEvent & {
|
|
15857
16239
|
type: 'hotkey';
|
|
@@ -15867,11 +16249,15 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15867
16249
|
|
|
15868
16250
|
/**
|
|
15869
16251
|
* Generated when a window is initialized.
|
|
16252
|
+
* @interface
|
|
15870
16253
|
*/
|
|
15871
16254
|
declare type WindowInitializedEvent = NamedEvent & {
|
|
15872
16255
|
type: 'initialized';
|
|
15873
16256
|
};
|
|
15874
16257
|
|
|
16258
|
+
/**
|
|
16259
|
+
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
|
16260
|
+
*/
|
|
15875
16261
|
declare class _WindowModule extends Base {
|
|
15876
16262
|
/**
|
|
15877
16263
|
* Asynchronously returns a Window object that represents an existing window.
|
|
@@ -15962,6 +16348,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15962
16348
|
|
|
15963
16349
|
/**
|
|
15964
16350
|
* Generated when a child window is not responding.
|
|
16351
|
+
* @interface
|
|
15965
16352
|
*/
|
|
15966
16353
|
declare type WindowNotRespondingEvent = NamedEvent & {
|
|
15967
16354
|
type: 'window-not-responding';
|
|
@@ -15974,6 +16361,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15974
16361
|
};
|
|
15975
16362
|
};
|
|
15976
16363
|
|
|
16364
|
+
/**
|
|
16365
|
+
* @interface
|
|
16366
|
+
*/
|
|
15977
16367
|
declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
|
|
15978
16368
|
|
|
15979
16369
|
declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
|
|
@@ -15981,6 +16371,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15981
16371
|
/**
|
|
15982
16372
|
* Generated after window options are changed using the window.updateOptions method.
|
|
15983
16373
|
* @remarks Will not fire if the diff object is empty.
|
|
16374
|
+
* @interface
|
|
15984
16375
|
*/
|
|
15985
16376
|
declare type WindowOptionsChangedEvent_2 = NamedEvent & {
|
|
15986
16377
|
type: 'options-changed';
|
|
@@ -15992,6 +16383,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15992
16383
|
|
|
15993
16384
|
/**
|
|
15994
16385
|
* Generated when a child window is responding.
|
|
16386
|
+
* @interface
|
|
15995
16387
|
*/
|
|
15996
16388
|
declare type WindowRespondingEvent = NamedEvent & {
|
|
15997
16389
|
type: 'window-responding';
|
|
@@ -15999,6 +16391,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
15999
16391
|
|
|
16000
16392
|
/**
|
|
16001
16393
|
* Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
|
16394
|
+
* @interface
|
|
16002
16395
|
*/
|
|
16003
16396
|
declare type WindowRestoredEvent = NamedEvent & {
|
|
16004
16397
|
type: 'restored';
|
|
@@ -16006,6 +16399,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
16006
16399
|
|
|
16007
16400
|
/**
|
|
16008
16401
|
* Generated when a hidden window has been shown.
|
|
16402
|
+
* @interface
|
|
16009
16403
|
*/
|
|
16010
16404
|
declare type WindowShownEvent = NamedEvent & {
|
|
16011
16405
|
type: 'shown';
|
|
@@ -16014,6 +16408,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
16014
16408
|
/**
|
|
16015
16409
|
* Generated when a window has been prevented from showing.
|
|
16016
16410
|
* @remarks A window will be prevented from showing by default, either through the API or by a user when ‘show-requested’ has been subscribed to on the window or 'window-show-requested' on the parent application and the Window.show(force) flag is false.
|
|
16411
|
+
* @interface
|
|
16017
16412
|
*/
|
|
16018
16413
|
declare type WindowShowRequestedEvent = NamedEvent & {
|
|
16019
16414
|
type: 'show-requested';
|
|
@@ -16021,6 +16416,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
16021
16416
|
|
|
16022
16417
|
/**
|
|
16023
16418
|
* Generated when a child window starts loading.
|
|
16419
|
+
* @interface
|
|
16024
16420
|
*/
|
|
16025
16421
|
declare type WindowStartLoadEvent = NamedEvent & {
|
|
16026
16422
|
type: 'window-start-load';
|
|
@@ -16056,6 +16452,10 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
16056
16452
|
|
|
16057
16453
|
/* Excluded from this release type: WithoutId */
|
|
16058
16454
|
|
|
16455
|
+
declare type WithPositioningOptions<T extends {} = {}> = T & {
|
|
16456
|
+
positioningOptions?: OpenFin_2.PositioningOptions;
|
|
16457
|
+
};
|
|
16458
|
+
|
|
16059
16459
|
declare type WorkspacePlatformOptions = {
|
|
16060
16460
|
/** Leaving this as any for now until we figure out what the shape should look like in Workspace */
|
|
16061
16461
|
[key: string]: any;
|
|
@@ -16063,6 +16463,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
16063
16463
|
|
|
16064
16464
|
/**
|
|
16065
16465
|
* A generic request to write any supported data to the clipboard.
|
|
16466
|
+
* @interface
|
|
16066
16467
|
*/
|
|
16067
16468
|
declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
|
|
16068
16469
|
data: {
|
|
@@ -16081,6 +16482,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
16081
16482
|
|
|
16082
16483
|
/**
|
|
16083
16484
|
* A request to write data to the clipboard.
|
|
16485
|
+
* @interface
|
|
16084
16486
|
*/
|
|
16085
16487
|
declare type WriteClipboardRequest = BaseClipboardRequest & {
|
|
16086
16488
|
/**
|
|
@@ -16089,6 +16491,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
16089
16491
|
data: string;
|
|
16090
16492
|
};
|
|
16091
16493
|
|
|
16494
|
+
/**
|
|
16495
|
+
* @interface
|
|
16496
|
+
*/
|
|
16092
16497
|
declare type WriteImageClipboardRequest = BaseClipboardRequest & {
|
|
16093
16498
|
/**
|
|
16094
16499
|
* Can be either a base64 string, or a DataURL string. If using DataURL, the
|