@openfin/node-adapter 34.78.7 → 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/node-adapter-alpha.d.ts +444 -47
- package/out/node-adapter-beta.d.ts +444 -47
- package/out/node-adapter-public.d.ts +444 -47
- package/out/node-adapter.d.ts +446 -49
- package/out/node-adapter.js +179 -143
- package/package.json +1 -1
package/out/node-adapter.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';
|
@@ -816,6 +817,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
|
|
816
817
|
|
817
818
|
/**
|
818
819
|
* Generated when an application has authenticated and is connected.
|
820
|
+
* @interface
|
819
821
|
*/
|
820
822
|
declare type ApplicationConnectedEvent = IdentityEvent & {
|
821
823
|
type: 'connected';
|
@@ -823,6 +825,7 @@ declare type ApplicationConnectedEvent = IdentityEvent & {
|
|
823
825
|
|
824
826
|
/**
|
825
827
|
* Generated when an application is created.
|
828
|
+
* @interface
|
826
829
|
*/
|
827
830
|
declare type ApplicationCreatedEvent = IdentityEvent & {
|
828
831
|
type: 'application-created';
|
@@ -837,11 +840,10 @@ declare type ApplicationCreatedEvent = IdentityEvent & {
|
|
837
840
|
* * `url` is optional in both the app manifest {@link Application.ApplicationModule.start Application.start} and but is usually given
|
838
841
|
* (defaults to `"about:blank"` when omitted).
|
839
842
|
*
|
840
|
-
* _This jsdoc typedef mirrors the `ApplicationOption` TypeScript interface in `@types/openfin`._
|
841
|
-
*
|
842
843
|
* **IMPORTANT NOTE:**
|
843
844
|
* This object inherits all the properties of the window creation {@link OpenFin.WindowCreationOptions options} object,
|
844
845
|
* which will take priority over those of the same name that may be provided in `mainWindowOptions`.
|
846
|
+
* @interface
|
845
847
|
*/
|
846
848
|
declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
|
847
849
|
name: string;
|
@@ -909,6 +911,9 @@ declare type ApplicationInfo = {
|
|
909
911
|
};
|
910
912
|
};
|
911
913
|
|
914
|
+
/**
|
915
|
+
* Static namespace for OpenFin API methods that interact with the {@link Application} class, available under `fin.Application`.
|
916
|
+
*/
|
912
917
|
declare class ApplicationModule extends Base {
|
913
918
|
/**
|
914
919
|
* Asynchronously returns an Application object that represents an existing application.
|
@@ -1089,6 +1094,7 @@ declare class ApplicationModule extends Base {
|
|
1089
1094
|
|
1090
1095
|
/**
|
1091
1096
|
* The complete set of options for an application.
|
1097
|
+
* @interface
|
1092
1098
|
*/
|
1093
1099
|
declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
1094
1100
|
/**
|
@@ -1282,6 +1288,10 @@ declare type AppProcessInfo = {
|
|
1282
1288
|
entities: EntityProcessDetails[];
|
1283
1289
|
};
|
1284
1290
|
|
1291
|
+
/**
|
1292
|
+
* Generated when system app versioning is successfully completed.
|
1293
|
+
* @interface
|
1294
|
+
*/
|
1285
1295
|
declare type AppVersionCompleteEvent = {
|
1286
1296
|
type: 'app-version-complete';
|
1287
1297
|
} & AppVersionProgress;
|
@@ -1291,6 +1301,10 @@ declare type AppVersionError = {
|
|
1291
1301
|
srcManifest: string;
|
1292
1302
|
};
|
1293
1303
|
|
1304
|
+
/**
|
1305
|
+
* Generated when none of fallback manifests is compatible to the system.
|
1306
|
+
* @interface
|
1307
|
+
*/
|
1294
1308
|
declare type AppVersionErrorEvent = {
|
1295
1309
|
type: 'app-version-error';
|
1296
1310
|
} & AppVersionError;
|
@@ -1315,6 +1329,10 @@ declare type AppVersionProgress = {
|
|
1315
1329
|
srcManifest: string;
|
1316
1330
|
};
|
1317
1331
|
|
1332
|
+
/**
|
1333
|
+
* Generated during the progress of system app versioning.
|
1334
|
+
* @interface
|
1335
|
+
*/
|
1318
1336
|
declare type AppVersionProgressEvent = {
|
1319
1337
|
type: 'app-version-progress';
|
1320
1338
|
} & AppVersionProgress;
|
@@ -1328,6 +1346,10 @@ declare type AppVersionRuntimeInfo = {
|
|
1328
1346
|
error: string | null;
|
1329
1347
|
};
|
1330
1348
|
|
1349
|
+
/**
|
1350
|
+
* Generated when checking a runtime availability.
|
1351
|
+
* @interface
|
1352
|
+
*/
|
1331
1353
|
declare type AppVersionRuntimeStatusEvent = {
|
1332
1354
|
type: 'runtime-status';
|
1333
1355
|
} & AppVersionRuntimeInfo;
|
@@ -1341,6 +1363,7 @@ declare type AppVersionTypeFromIdEvent<T extends IdEventType> = Extract<AppVersi
|
|
1341
1363
|
|
1342
1364
|
/**
|
1343
1365
|
* Generated when a View is attached to a window.
|
1366
|
+
* @interface
|
1344
1367
|
*/
|
1345
1368
|
declare type AttachedEvent = BaseViewEvent & {
|
1346
1369
|
type: 'attached';
|
@@ -1413,6 +1436,7 @@ declare interface AuthorizationPayload {
|
|
1413
1436
|
* }
|
1414
1437
|
* });
|
1415
1438
|
* ```
|
1439
|
+
* @interface
|
1416
1440
|
*/
|
1417
1441
|
declare type AuthRequestedEvent = NamedEvent & {
|
1418
1442
|
type: 'auth-requested';
|
@@ -1470,6 +1494,7 @@ declare class Base {
|
|
1470
1494
|
|
1471
1495
|
/**
|
1472
1496
|
* A base Channel event.
|
1497
|
+
* @interface
|
1473
1498
|
*/
|
1474
1499
|
declare type BaseChannelEvent = NamedEvent & {
|
1475
1500
|
channelName: string;
|
@@ -1536,6 +1561,7 @@ declare namespace BaseEvents {
|
|
1536
1561
|
|
1537
1562
|
/**
|
1538
1563
|
* The base frame event.
|
1564
|
+
* @interface
|
1539
1565
|
*/
|
1540
1566
|
declare type BaseFrameEvent = NamedEvent & {
|
1541
1567
|
entityType: 'iframe';
|
@@ -1556,6 +1582,7 @@ declare type BaseUrlEvent = NamedEvent & {
|
|
1556
1582
|
|
1557
1583
|
/**
|
1558
1584
|
* A base View event.
|
1585
|
+
* @interface
|
1559
1586
|
*/
|
1560
1587
|
declare type BaseViewEvent = NamedEvent & {
|
1561
1588
|
target: OpenFin.Identity;
|
@@ -1575,6 +1602,7 @@ declare interface BeforeUnloadUserDecision {
|
|
1575
1602
|
|
1576
1603
|
/**
|
1577
1604
|
* Generated at the beginning of a user-driven change to a window's size or position.
|
1605
|
+
* @interface
|
1578
1606
|
*/
|
1579
1607
|
declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
1580
1608
|
type: 'begin-user-bounds-changing';
|
@@ -1582,6 +1610,7 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
1582
1610
|
|
1583
1611
|
/**
|
1584
1612
|
* Generated when a WebContents loses focus.
|
1613
|
+
* @interface
|
1585
1614
|
*/
|
1586
1615
|
declare type BlurredEvent = NamedEvent & {
|
1587
1616
|
type: 'blurred';
|
@@ -1596,6 +1625,7 @@ declare type Bounds = {
|
|
1596
1625
|
|
1597
1626
|
/**
|
1598
1627
|
* Generated after changes in a window's size and/or position.
|
1628
|
+
* @interface
|
1599
1629
|
*/
|
1600
1630
|
declare type BoundsChangedEvent = BoundsChangeEvent & {
|
1601
1631
|
type: 'bounds-changed';
|
@@ -1603,6 +1633,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
1603
1633
|
|
1604
1634
|
/**
|
1605
1635
|
* A general bounds change event without event type.
|
1636
|
+
* @interface
|
1606
1637
|
*/
|
1607
1638
|
declare type BoundsChangeEvent = NamedEvent & {
|
1608
1639
|
changeType: 0 | 1 | 2;
|
@@ -1615,6 +1646,7 @@ declare type BoundsChangeEvent = NamedEvent & {
|
|
1615
1646
|
|
1616
1647
|
/**
|
1617
1648
|
* Generated during changes to a window's size and/or position.
|
1649
|
+
* @interface
|
1618
1650
|
*/
|
1619
1651
|
declare type BoundsChangingEvent = BoundsChangeEvent & {
|
1620
1652
|
type: 'bounds-changing';
|
@@ -1657,6 +1689,7 @@ declare type Certificate = {
|
|
1657
1689
|
|
1658
1690
|
/**
|
1659
1691
|
* Generated when navigating to a URL that fails certificate validation.
|
1692
|
+
* @interface
|
1660
1693
|
*/
|
1661
1694
|
declare type CertificateErrorEvent = NamedEvent & {
|
1662
1695
|
type: 'certificate-error';
|
@@ -1676,6 +1709,7 @@ declare type CertificatePrincipal = {
|
|
1676
1709
|
|
1677
1710
|
/**
|
1678
1711
|
* Generated when the certificate selection dialog is shown.
|
1712
|
+
* @interface
|
1679
1713
|
*/
|
1680
1714
|
declare type CertificateSelectionShownEvent = NamedEvent & {
|
1681
1715
|
type: 'certificate-selection-shown';
|
@@ -1880,7 +1914,7 @@ declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
|
|
1880
1914
|
|
1881
1915
|
declare type ChannelAction = OpenFin.ChannelAction;
|
1882
1916
|
|
1883
|
-
declare type ChannelAction_2 = (payload: unknown, id:
|
1917
|
+
declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
|
1884
1918
|
|
1885
1919
|
declare class ChannelBase {
|
1886
1920
|
protected subscriptions: Map<string, ChannelAction>;
|
@@ -2159,17 +2193,17 @@ declare class ChannelBase {
|
|
2159
2193
|
* provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
|
2160
2194
|
* from the provider by registering an action via {@link ChannelClient#register register}.
|
2161
2195
|
*
|
2162
|
-
* Synchronous Methods:
|
2196
|
+
* ### Synchronous Methods:
|
2163
2197
|
* * {@link ChannelClient#onDisconnection onDisconnection(listener)}
|
2164
2198
|
* * {@link ChannelClient#register register(action, listener)}
|
2165
2199
|
* * {@link ChannelClient#remove remove(action)}
|
2166
2200
|
*
|
2167
|
-
* Asynchronous Methods:
|
2201
|
+
* ### Asynchronous Methods:
|
2168
2202
|
* * {@link ChannelClient#disconnect disconnect()}
|
2169
2203
|
* * {@link ChannelClient#dispatch dispatch(action, payload)}
|
2170
2204
|
*
|
2171
|
-
* Middleware:
|
2172
|
-
*
|
2205
|
+
* ### Middleware:
|
2206
|
+
* Middleware functions receive the following arguments: (action, payload, senderId).
|
2173
2207
|
* The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
|
2174
2208
|
* unless it is undefined, in which case the original payload is used. Middleware can be used for side effects.
|
2175
2209
|
* * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
|
@@ -2189,16 +2223,16 @@ declare class ChannelClient extends ChannelBase {
|
|
2189
2223
|
* @internal
|
2190
2224
|
* closes the corresponding channel and invokes the disconnect listener if an event payload is passed.
|
2191
2225
|
*/
|
2192
|
-
static handleProviderDisconnect(eventPayload:
|
2226
|
+
static handleProviderDisconnect(eventPayload: OpenFin.ProviderIdentity): void;
|
2193
2227
|
/**
|
2194
2228
|
* @internal
|
2195
2229
|
*/
|
2196
2230
|
constructor(routingInfo: RoutingInfo, wire: Transport, strategy: AnyStrategy);
|
2197
|
-
protected processAction: (action: string, payload: any, senderIdentity:
|
2231
|
+
protected processAction: (action: string, payload: any, senderIdentity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<any>;
|
2198
2232
|
/**
|
2199
2233
|
* a read-only provider identity
|
2200
2234
|
*/
|
2201
|
-
get providerIdentity():
|
2235
|
+
get providerIdentity(): OpenFin.ProviderIdentity;
|
2202
2236
|
/**
|
2203
2237
|
* Dispatch the given action to the channel provider. Returns a promise that resolves with the response from
|
2204
2238
|
* the provider for that action.
|
@@ -2265,6 +2299,7 @@ declare type ChannelClient_2 = OpenFin.ChannelClient;
|
|
2265
2299
|
|
2266
2300
|
/**
|
2267
2301
|
* Generated when a Channel client is connected.
|
2302
|
+
* @interface
|
2268
2303
|
*/
|
2269
2304
|
declare type ChannelConnectedEvent = BaseChannelEvent & {
|
2270
2305
|
type: 'connected';
|
@@ -2273,6 +2308,7 @@ declare type ChannelConnectedEvent = BaseChannelEvent & {
|
|
2273
2308
|
/**
|
2274
2309
|
* Options provided on a client connection to a channel.
|
2275
2310
|
*
|
2311
|
+
* @interface
|
2276
2312
|
*/
|
2277
2313
|
declare type ChannelConnectOptions = ChannelCreateOptions & {
|
2278
2314
|
/**
|
@@ -2299,6 +2335,7 @@ declare type ChannelCreateOptions = {
|
|
2299
2335
|
|
2300
2336
|
/**
|
2301
2337
|
* Generated when a Channel client has disconnected.
|
2338
|
+
* @interface
|
2302
2339
|
*/
|
2303
2340
|
declare type ChannelDisconnectedEvent = BaseChannelEvent & {
|
2304
2341
|
type: 'disconnected';
|
@@ -2330,27 +2367,27 @@ declare type ChannelEventType = ChannelEvent['type'];
|
|
2330
2367
|
|
2331
2368
|
declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
|
2332
2369
|
|
2333
|
-
declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity:
|
2370
|
+
declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_7 | ClientIdentity_2) => Promise<unknown> | unknown;
|
2334
2371
|
|
2335
2372
|
/**
|
2336
2373
|
* Instance created to enable use of a channel as a provider. Allows for communication with the {@link ChannelClient ChannelClients} by invoking an action on
|
2337
2374
|
* a single client via {@link ChannelProvider#dispatch dispatch} or all clients via {@link ChannelProvider#publish publish}
|
2338
2375
|
* and to listen for communication from clients by registering an action via {@link ChannelProvider#register register}.
|
2339
2376
|
*
|
2340
|
-
* Synchronous Methods:
|
2377
|
+
* ### Synchronous Methods:
|
2341
2378
|
* * {@link ChannelProvider#onConnection onConnection(listener)}
|
2342
2379
|
* * {@link ChannelProvider#onDisconnection onDisconnection(listener)}
|
2343
2380
|
* * {@link ChannelProvider#publish publish(action, payload)}
|
2344
2381
|
* * {@link ChannelProvider#register register(action, listener)}
|
2345
2382
|
* * {@link ChannelProvider#remove remove(action)}
|
2346
2383
|
*
|
2347
|
-
* Asynchronous Methods:
|
2384
|
+
* ### Asynchronous Methods:
|
2348
2385
|
* * {@link ChannelProvider#destroy destroy()}
|
2349
2386
|
* * {@link ChannelProvider#dispatch dispatch(to, action, payload)}
|
2350
2387
|
* * {@link ChannelProvider#getAllClientInfo getAllClientInfo()}
|
2351
2388
|
*
|
2352
|
-
* Middleware:
|
2353
|
-
*
|
2389
|
+
* ### Middleware:
|
2390
|
+
* Middleware functions receive the following arguments: (action, payload, senderId).
|
2354
2391
|
* The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
|
2355
2392
|
* unless it is undefined, in which case the most recently defined payload is used. Middleware can be used for side effects.
|
2356
2393
|
* * {@link ChannelProvider#setDefaultAction setDefaultAction(middleware)}
|
@@ -2372,7 +2409,7 @@ declare class ChannelProvider extends ChannelBase {
|
|
2372
2409
|
/**
|
2373
2410
|
* @internal
|
2374
2411
|
*/
|
2375
|
-
constructor(providerIdentity:
|
2412
|
+
constructor(providerIdentity: ProviderIdentity_6, wire: Transport, strategy: AnyStrategy);
|
2376
2413
|
/**
|
2377
2414
|
* Dispatch an action to a specified client. Returns a promise for the result of executing that action on the client side.
|
2378
2415
|
*
|
@@ -2543,6 +2580,7 @@ declare interface ChannelStrategy<T extends unknown> {
|
|
2543
2580
|
|
2544
2581
|
/**
|
2545
2582
|
* Generated when a child content is blocked to load.
|
2583
|
+
* @interface
|
2546
2584
|
*/
|
2547
2585
|
declare type ChildContentBlockedEvent = ContentCreationRulesEvent & {
|
2548
2586
|
type: 'child-content-blocked';
|
@@ -2550,6 +2588,7 @@ declare type ChildContentBlockedEvent = ContentCreationRulesEvent & {
|
|
2550
2588
|
|
2551
2589
|
/**
|
2552
2590
|
* Generated when a child content is loaded into a browser.
|
2591
|
+
* @interface
|
2553
2592
|
*/
|
2554
2593
|
declare type ChildContentOpenedInBrowserEvent = ContentCreationRulesEvent & {
|
2555
2594
|
type: 'child-content-opened-in-browser';
|
@@ -2562,6 +2601,7 @@ declare interface ChildContentOptions {
|
|
2562
2601
|
|
2563
2602
|
/**
|
2564
2603
|
* Generated when a child View is created.
|
2604
|
+
* @interface
|
2565
2605
|
*/
|
2566
2606
|
declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
|
2567
2607
|
type: 'child-view-created';
|
@@ -2573,6 +2613,7 @@ declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
|
|
2573
2613
|
|
2574
2614
|
/**
|
2575
2615
|
* Generated when a child Window is created.
|
2616
|
+
* @interface
|
2576
2617
|
*/
|
2577
2618
|
declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
2578
2619
|
type: 'child-window-created';
|
@@ -2597,9 +2638,9 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
|
|
2597
2638
|
private endpointId;
|
2598
2639
|
private providerIdentity;
|
2599
2640
|
constructor(wire: Transport, messageReceiver: MessageReceiver, endpointId: string, // Provider endpointId is channelId
|
2600
|
-
providerIdentity:
|
2641
|
+
providerIdentity: ProviderIdentity_4);
|
2601
2642
|
onEndpointDisconnect(endpointId: string, listener: () => void): void;
|
2602
|
-
receive(listener: (action: string, payload: any, identity: OpenFin.ClientIdentity | OpenFin.ClientIdentityMultiRuntime |
|
2643
|
+
receive(listener: (action: string, payload: any, identity: OpenFin.ClientIdentity | OpenFin.ClientIdentityMultiRuntime | ProviderIdentity_4) => Promise<any>): void;
|
2603
2644
|
send: (endpointId: string, action: string, payload: any) => Promise<any>;
|
2604
2645
|
close: () => Promise<void>;
|
2605
2646
|
closeEndpoint(endpointId: string): Promise<void>;
|
@@ -2632,12 +2673,16 @@ declare type ClickedMenuResult<T extends unknown = unknown> = {
|
|
2632
2673
|
data: T;
|
2633
2674
|
};
|
2634
2675
|
|
2676
|
+
/**
|
2677
|
+
* @interface
|
2678
|
+
*/
|
2635
2679
|
declare type ClientConnectionPayload = ClientIdentity_2 & ClientInfo;
|
2636
2680
|
|
2637
2681
|
declare type ClientIdentity = OpenFin.ClientIdentity;
|
2638
2682
|
|
2639
2683
|
/**
|
2640
2684
|
* Identity of a channel client
|
2685
|
+
* @interface
|
2641
2686
|
*/
|
2642
2687
|
declare type ClientIdentity_2 = Identity_5 & {
|
2643
2688
|
/**
|
@@ -2647,12 +2692,16 @@ declare type ClientIdentity_2 = Identity_5 & {
|
|
2647
2692
|
isLocalEndpointId: boolean;
|
2648
2693
|
};
|
2649
2694
|
|
2695
|
+
/**
|
2696
|
+
* @interface
|
2697
|
+
*/
|
2650
2698
|
declare type ClientIdentityMultiRuntime = ClientIdentity_2 & {
|
2651
2699
|
runtimeUuid: string;
|
2652
2700
|
};
|
2653
2701
|
|
2654
2702
|
/**
|
2655
2703
|
* Extended channel client information
|
2704
|
+
* @interface
|
2656
2705
|
*/
|
2657
2706
|
declare type ClientInfo = Omit<ClientIdentity_2, 'isLocalEndpointId'> & {
|
2658
2707
|
/**
|
@@ -2844,6 +2893,7 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
|
|
2844
2893
|
|
2845
2894
|
/**
|
2846
2895
|
* Generated when an application is closed.
|
2896
|
+
* @interface
|
2847
2897
|
*/
|
2848
2898
|
declare type ClosedEvent = IdentityEvent & {
|
2849
2899
|
type: 'closed';
|
@@ -3300,6 +3350,9 @@ declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
|
|
3300
3350
|
data?: unknown;
|
3301
3351
|
};
|
3302
3352
|
|
3353
|
+
/**
|
3354
|
+
* @interface
|
3355
|
+
*/
|
3303
3356
|
declare type ContentCreationRulesEvent = NamedEvent & {
|
3304
3357
|
/**
|
3305
3358
|
* The absolute url which triggered this event.
|
@@ -3358,6 +3411,9 @@ declare type Context = {
|
|
3358
3411
|
type: string;
|
3359
3412
|
};
|
3360
3413
|
|
3414
|
+
/**
|
3415
|
+
* @interface
|
3416
|
+
*/
|
3361
3417
|
declare type ContextForIntent<MetadataType = any> = Context & {
|
3362
3418
|
metadata?: MetadataType;
|
3363
3419
|
};
|
@@ -3460,6 +3516,7 @@ declare type CpuInfo = {
|
|
3460
3516
|
|
3461
3517
|
/**
|
3462
3518
|
* Generated when an application has crashed.
|
3519
|
+
* @interface
|
3463
3520
|
*/
|
3464
3521
|
declare type CrashedEvent = NamedEvent & {
|
3465
3522
|
type: 'crashed';
|
@@ -3479,6 +3536,9 @@ declare type CrashReporterOptions = {
|
|
3479
3536
|
diagnosticsMode: boolean;
|
3480
3537
|
};
|
3481
3538
|
|
3539
|
+
/**
|
3540
|
+
* @interface
|
3541
|
+
*/
|
3482
3542
|
declare type CrashReporterState = CrashReporterOptions & {
|
3483
3543
|
/**
|
3484
3544
|
* Whether the crash reporter is running
|
@@ -3489,6 +3549,7 @@ declare type CrashReporterState = CrashReporterOptions & {
|
|
3489
3549
|
|
3490
3550
|
/**
|
3491
3551
|
* Generated when a View is created.
|
3552
|
+
* @interface
|
3492
3553
|
*/
|
3493
3554
|
declare type CreatedEvent = BaseViewEvent & {
|
3494
3555
|
type: 'created';
|
@@ -3506,6 +3567,9 @@ declare type CreateViewPayload = {
|
|
3506
3567
|
targetView?: Identity_5;
|
3507
3568
|
};
|
3508
3569
|
|
3570
|
+
/**
|
3571
|
+
* @interface
|
3572
|
+
*/
|
3509
3573
|
declare type CreateViewTarget = Identity_5 & {
|
3510
3574
|
/**
|
3511
3575
|
* If specified, view creation will not attach to a window and caller must
|
@@ -3545,6 +3609,7 @@ declare type DefaultDomainSettingsRule = {
|
|
3545
3609
|
|
3546
3610
|
/**
|
3547
3611
|
* Generated when the desktop icon is clicked while it's already running.
|
3612
|
+
* @interface
|
3548
3613
|
*/
|
3549
3614
|
declare type DesktopIconClickedEvent = BaseEvent & {
|
3550
3615
|
type: 'desktop-icon-clicked';
|
@@ -3552,6 +3617,7 @@ declare type DesktopIconClickedEvent = BaseEvent & {
|
|
3552
3617
|
|
3553
3618
|
/**
|
3554
3619
|
* Generated when a View is destroyed.
|
3620
|
+
* @interface
|
3555
3621
|
*/
|
3556
3622
|
declare type DestroyedEvent = BaseViewEvent & {
|
3557
3623
|
type: 'destroyed';
|
@@ -3559,6 +3625,7 @@ declare type DestroyedEvent = BaseViewEvent & {
|
|
3559
3625
|
|
3560
3626
|
/**
|
3561
3627
|
* Generated when a page's theme color changes. This is usually due to encountering a meta tag.
|
3628
|
+
* @interface
|
3562
3629
|
*/
|
3563
3630
|
declare type DidChangeThemeColorEvent = NamedEvent & {
|
3564
3631
|
type: 'did-change-theme-color';
|
@@ -3566,6 +3633,7 @@ declare type DidChangeThemeColorEvent = NamedEvent & {
|
|
3566
3633
|
|
3567
3634
|
/**
|
3568
3635
|
* Generated when load failed.
|
3636
|
+
* @interface
|
3569
3637
|
*/
|
3570
3638
|
declare type DidFailLoadEvent = BaseLoadFailedEvent & {
|
3571
3639
|
type: 'did-fail-load';
|
@@ -3573,11 +3641,15 @@ declare type DidFailLoadEvent = BaseLoadFailedEvent & {
|
|
3573
3641
|
|
3574
3642
|
/**
|
3575
3643
|
* Generated when the navigation is done, i.e. the spinner of the tab will stop spinning, and the onload event is dispatched.
|
3644
|
+
* @interface
|
3576
3645
|
*/
|
3577
3646
|
declare type DidFinishLoadEvent = NamedEvent & {
|
3578
3647
|
type: 'did-finish-load';
|
3579
3648
|
};
|
3580
3649
|
|
3650
|
+
/**
|
3651
|
+
* @interface
|
3652
|
+
*/
|
3581
3653
|
declare type DipRect = RectangleByEdgePositions & {
|
3582
3654
|
dipRect: RectangleByEdgePositions;
|
3583
3655
|
scaledRect: RectangleByEdgePositions;
|
@@ -3590,6 +3662,7 @@ declare type DipScaleRects = {
|
|
3590
3662
|
|
3591
3663
|
/**
|
3592
3664
|
* Generated after a change to a window's size and/or position is attempted while window movement is disabled.
|
3665
|
+
* @interface
|
3593
3666
|
*/
|
3594
3667
|
declare type DisabledMovementBoundsChangedEvent = BoundsChangeEvent & {
|
3595
3668
|
type: 'disabled-movement-bounds-changed';
|
@@ -3597,12 +3670,13 @@ declare type DisabledMovementBoundsChangedEvent = BoundsChangeEvent & {
|
|
3597
3670
|
|
3598
3671
|
/**
|
3599
3672
|
* Generated while a change to a window's size and/or position is attempted while window movement is disabled.
|
3673
|
+
* @interface
|
3600
3674
|
*/
|
3601
3675
|
declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
3602
3676
|
type: 'disabled-movement-bounds-changing';
|
3603
3677
|
};
|
3604
3678
|
|
3605
|
-
declare type DisconnectionListener = (providerIdentity:
|
3679
|
+
declare type DisconnectionListener = (providerIdentity: OpenFin.ProviderIdentity) => any;
|
3606
3680
|
|
3607
3681
|
declare type DisconnectionListener_2 = (identity: ClientIdentity) => any;
|
3608
3682
|
|
@@ -3673,6 +3747,7 @@ declare type Dpi = {
|
|
3673
3747
|
|
3674
3748
|
/**
|
3675
3749
|
* Generated when a window has been embedded.
|
3750
|
+
* @interface
|
3676
3751
|
*/
|
3677
3752
|
declare type EmbeddedEvent = NamedEvent & {
|
3678
3753
|
type: 'embedded';
|
@@ -3783,6 +3858,7 @@ declare class EmitterMap {
|
|
3783
3858
|
|
3784
3859
|
/**
|
3785
3860
|
* Generated when a window ends loading.
|
3861
|
+
* @interface
|
3786
3862
|
*/
|
3787
3863
|
declare type EndLoadEvent = NamedEvent & {
|
3788
3864
|
type: 'end-load';
|
@@ -3790,7 +3866,7 @@ declare type EndLoadEvent = NamedEvent & {
|
|
3790
3866
|
isMain: boolean;
|
3791
3867
|
};
|
3792
3868
|
|
3793
|
-
declare type EndpointIdentity = OpenFin.ClientIdentity |
|
3869
|
+
declare type EndpointIdentity = OpenFin.ClientIdentity | ProviderIdentity_3;
|
3794
3870
|
|
3795
3871
|
declare type EndpointPayload = {
|
3796
3872
|
endpointIdentity: EndpointIdentity;
|
@@ -3798,6 +3874,7 @@ declare type EndpointPayload = {
|
|
3798
3874
|
|
3799
3875
|
/**
|
3800
3876
|
* Generated at the end of a user-driven change to a window's size or position.
|
3877
|
+
* @interface
|
3801
3878
|
*/
|
3802
3879
|
declare type EndUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
3803
3880
|
type: 'end-user-bounds-changing';
|
@@ -3813,6 +3890,9 @@ declare type EntityInfo_2 = {
|
|
3813
3890
|
entityType: EntityType_2;
|
3814
3891
|
};
|
3815
3892
|
|
3893
|
+
/**
|
3894
|
+
* @interface
|
3895
|
+
*/
|
3816
3896
|
declare type EntityProcessDetails = FrameProcessDetails & {
|
3817
3897
|
name: string;
|
3818
3898
|
uuid: string;
|
@@ -3882,7 +3962,7 @@ declare interface Environment {
|
|
3882
3962
|
|
3883
3963
|
declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
|
3884
3964
|
|
3885
|
-
declare type ErrorMiddleware_2 = (topic: string, error: Error, id:
|
3965
|
+
declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
|
3886
3966
|
|
3887
3967
|
/**
|
3888
3968
|
* This function converts JS errors into plain objects
|
@@ -3940,7 +4020,7 @@ declare type ExitCode = {
|
|
3940
4020
|
/**
|
3941
4021
|
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
3942
4022
|
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
3943
|
-
* Discovery of connections is provided by
|
4023
|
+
* Discovery of connections is provided by {@link System.System.getAllExternalApplications getAllExternalApplications}.</a>
|
3944
4024
|
*
|
3945
4025
|
* Processes that can be wrapped as `ExternalApplication`s include the following:
|
3946
4026
|
* - Processes which have connected to an OpenFin runtime via an adapter
|
@@ -4047,6 +4127,7 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
|
|
4047
4127
|
|
4048
4128
|
/**
|
4049
4129
|
* Generated when an external application has authenticated and is connected.
|
4130
|
+
* @interface
|
4050
4131
|
*/
|
4051
4132
|
declare type ExternalApplicationConnectedEvent = BaseEvent & {
|
4052
4133
|
type: 'connected';
|
@@ -4054,6 +4135,7 @@ declare type ExternalApplicationConnectedEvent = BaseEvent & {
|
|
4054
4135
|
|
4055
4136
|
/**
|
4056
4137
|
* Generated when an external application has disconnected.
|
4138
|
+
* @interface
|
4057
4139
|
*/
|
4058
4140
|
declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
|
4059
4141
|
type: 'disconnected';
|
@@ -4080,6 +4162,9 @@ declare type ExternalApplicationInfo = {
|
|
4080
4162
|
parent: Identity_5;
|
4081
4163
|
};
|
4082
4164
|
|
4165
|
+
/**
|
4166
|
+
* Static namespace for OpenFin API methods that interact with the {@link ExternalApplication} class, available under `fin.ExternalApplication`.
|
4167
|
+
*/
|
4083
4168
|
declare class ExternalApplicationModule extends Base {
|
4084
4169
|
/**
|
4085
4170
|
* Asynchronously returns an External Application object that represents an external application.
|
@@ -4128,6 +4213,7 @@ declare type ExternalConnection = {
|
|
4128
4213
|
|
4129
4214
|
/**
|
4130
4215
|
* Generated when an external process has exited.
|
4216
|
+
* @interface
|
4131
4217
|
*/
|
4132
4218
|
declare type ExternalProcessExitedEvent = NamedEvent & {
|
4133
4219
|
type: 'external-process-exited';
|
@@ -4166,6 +4252,7 @@ declare type ExternalProcessRequestType = {
|
|
4166
4252
|
|
4167
4253
|
/**
|
4168
4254
|
* Generated when an external process has started.
|
4255
|
+
* @interface
|
4169
4256
|
*/
|
4170
4257
|
declare type ExternalProcessStartedEvent = NamedEvent & {
|
4171
4258
|
type: 'external-process-started';
|
@@ -4174,6 +4261,7 @@ declare type ExternalProcessStartedEvent = NamedEvent & {
|
|
4174
4261
|
|
4175
4262
|
/**
|
4176
4263
|
* Generated when page receives favicon urls.
|
4264
|
+
* @interface
|
4177
4265
|
*/
|
4178
4266
|
declare type FaviconUpdatedEvent = NamedEvent & {
|
4179
4267
|
type: 'page-favicon-updated';
|
@@ -4191,6 +4279,7 @@ declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
|
|
4191
4279
|
|
4192
4280
|
/**
|
4193
4281
|
* Generated when a file download has completed.
|
4282
|
+
* @interface
|
4194
4283
|
*/
|
4195
4284
|
declare type FileDownloadCompletedEvent = FileDownloadEvent & {
|
4196
4285
|
type: 'file-download-completed';
|
@@ -4199,6 +4288,7 @@ declare type FileDownloadCompletedEvent = FileDownloadEvent & {
|
|
4199
4288
|
|
4200
4289
|
/**
|
4201
4290
|
* A general file download event without event type.
|
4291
|
+
* @interface
|
4202
4292
|
*/
|
4203
4293
|
declare type FileDownloadEvent = {
|
4204
4294
|
/**
|
@@ -4250,6 +4340,8 @@ declare type FileDownloadEvent = {
|
|
4250
4340
|
/**
|
4251
4341
|
* Generated when setFileDownloadLocation api is called.
|
4252
4342
|
* @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'.
|
4343
|
+
*
|
4344
|
+
* @interface
|
4253
4345
|
*/
|
4254
4346
|
declare type FileDownloadLocationChangedEvent = NamedEvent & {
|
4255
4347
|
type: 'file-download-location-changed';
|
@@ -4257,6 +4349,7 @@ declare type FileDownloadLocationChangedEvent = NamedEvent & {
|
|
4257
4349
|
|
4258
4350
|
/**
|
4259
4351
|
* Generated during file download progress.
|
4352
|
+
* @interface
|
4260
4353
|
*/
|
4261
4354
|
declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
4262
4355
|
type: 'file-download-progress';
|
@@ -4269,6 +4362,7 @@ declare type FileDownloadSettings = {
|
|
4269
4362
|
|
4270
4363
|
/**
|
4271
4364
|
* Generated when a file download has started.
|
4365
|
+
* @interface
|
4272
4366
|
*/
|
4273
4367
|
declare type FileDownloadStartedEvent = FileDownloadEvent & {
|
4274
4368
|
type: 'file-download-started';
|
@@ -4375,6 +4469,7 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
|
|
4375
4469
|
|
4376
4470
|
/**
|
4377
4471
|
* Generated when a WebContents gains focus.
|
4472
|
+
* @interface
|
4378
4473
|
*/
|
4379
4474
|
declare type FocusedEvent = NamedEvent & {
|
4380
4475
|
type: 'focused';
|
@@ -4382,6 +4477,7 @@ declare type FocusedEvent = NamedEvent & {
|
|
4382
4477
|
|
4383
4478
|
/**
|
4384
4479
|
* Generated when a result is available when calling findInPage.
|
4480
|
+
* @interface
|
4385
4481
|
*/
|
4386
4482
|
declare type FoundInPageEvent = NamedEvent & {
|
4387
4483
|
type: 'found-in-page';
|
@@ -4523,6 +4619,7 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
4523
4619
|
|
4524
4620
|
/**
|
4525
4621
|
* Generated when a frame is connected.
|
4622
|
+
* @interface
|
4526
4623
|
*/
|
4527
4624
|
declare type FrameConnectedEvent = BaseFrameEvent & {
|
4528
4625
|
type: 'connected';
|
@@ -4530,6 +4627,7 @@ declare type FrameConnectedEvent = BaseFrameEvent & {
|
|
4530
4627
|
|
4531
4628
|
/**
|
4532
4629
|
* Generated when a frame has disconnected.
|
4630
|
+
* @interface
|
4533
4631
|
*/
|
4534
4632
|
declare type FrameDisconnectedEvent = BaseFrameEvent & {
|
4535
4633
|
type: 'disconnected';
|
@@ -4567,6 +4665,9 @@ declare type FrameInfo = {
|
|
4567
4665
|
parent: Identity_5;
|
4568
4666
|
};
|
4569
4667
|
|
4668
|
+
/**
|
4669
|
+
* Static namespace for OpenFin API methods that interact with the {@link _Frame} class, available under `fin.Frame`.
|
4670
|
+
*/
|
4570
4671
|
declare class _FrameModule extends Base {
|
4571
4672
|
/**
|
4572
4673
|
* Asynchronously returns a reference to the specified frame. The frame does not have to exist
|
@@ -4616,6 +4717,9 @@ declare class _FrameModule extends Base {
|
|
4616
4717
|
getCurrentSync(): OpenFin.Frame;
|
4617
4718
|
}
|
4618
4719
|
|
4720
|
+
/**
|
4721
|
+
* @interface
|
4722
|
+
*/
|
4619
4723
|
declare type FrameProcessDetails = ProcessDetails & {
|
4620
4724
|
/**
|
4621
4725
|
* Current URL associated with the process.
|
@@ -4783,18 +4887,11 @@ declare type GpuInfo = {
|
|
4783
4887
|
name: string;
|
4784
4888
|
};
|
4785
4889
|
|
4786
|
-
/**
|
4787
|
-
* Generated when a window has been hidden.
|
4788
|
-
*/
|
4789
|
-
declare type HiddenEvent = NamedEvent & {
|
4790
|
-
type: 'hidden';
|
4791
|
-
reason: 'closing' | 'hide' | 'hide-on-close';
|
4792
|
-
};
|
4793
|
-
|
4794
4890
|
/**
|
4795
4891
|
* Generated when a View is hidden.
|
4892
|
+
* @interface
|
4796
4893
|
*/
|
4797
|
-
declare type
|
4894
|
+
declare type HiddenEvent = BaseViewEvent & {
|
4798
4895
|
type: 'hidden';
|
4799
4896
|
};
|
4800
4897
|
|
@@ -4861,6 +4958,7 @@ declare type Hotkey = {
|
|
4861
4958
|
/**
|
4862
4959
|
* Generated when a keyboard shortcut defined in the `hotkeys` array in [View options](OpenFin.ViewOptions.html) is pressed inside the view.
|
4863
4960
|
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
4961
|
+
* @interface
|
4864
4962
|
*/
|
4865
4963
|
declare type HotkeyEvent = BaseViewEvent & {
|
4866
4964
|
type: 'hotkey';
|
@@ -4895,6 +4993,7 @@ declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<Add
|
|
4895
4993
|
|
4896
4994
|
/**
|
4897
4995
|
* An Identity event.
|
4996
|
+
* @interface
|
4898
4997
|
*/
|
4899
4998
|
declare type IdentityEvent = BaseEvent & {
|
4900
4999
|
uuid: string;
|
@@ -4910,6 +5009,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
|
|
4910
5009
|
* @remarks This method is continuously generated every minute while the user is in idle.
|
4911
5010
|
* A user enters idle state when the computer is locked or when there has been no keyboard/mouse activity for 1 minute.
|
4912
5011
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
5012
|
+
* @interface
|
4913
5013
|
*/
|
4914
5014
|
declare type IdleEvent = {
|
4915
5015
|
type: 'idle-state-changed';
|
@@ -4938,6 +5038,7 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
|
|
4938
5038
|
|
4939
5039
|
/**
|
4940
5040
|
* Generated when an application has initialized.
|
5041
|
+
* @interface
|
4941
5042
|
*/
|
4942
5043
|
declare type InitializedEvent = IdentityEvent & {
|
4943
5044
|
type: 'initialized';
|
@@ -4968,6 +5069,7 @@ declare type InitPlatformOptions = {
|
|
4968
5069
|
|
4969
5070
|
/**
|
4970
5071
|
* Generated when the value of the element changes.
|
5072
|
+
* @interface
|
4971
5073
|
*/
|
4972
5074
|
declare type InputEvent_2 = {
|
4973
5075
|
inputType: 'keyUp' | 'keyDown';
|
@@ -6510,6 +6612,138 @@ declare type LaunchIntoPlatformPayload = {
|
|
6510
6612
|
manifest: any;
|
6511
6613
|
};
|
6512
6614
|
|
6615
|
+
/**
|
6616
|
+
*
|
6617
|
+
* Layouts give app providers the ability to embed multiple views in a single window. The Layout namespace
|
6618
|
+
* enables the initialization and manipulation of a window's Layout. A Layout will
|
6619
|
+
* emit events locally on the DOM element representing the layout-container.
|
6620
|
+
*
|
6621
|
+
*
|
6622
|
+
* ### Layout.DOMEvents
|
6623
|
+
*
|
6624
|
+
* When a Layout is created, it emits events onto the DOM element representing the Layout container.
|
6625
|
+
* This Layout container is the DOM element referenced by containerId in {@link Layout.LayoutModule#init Layout.init}.
|
6626
|
+
* 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).
|
6627
|
+
* The events are emitted synchronously and only in the process where the Layout exists.
|
6628
|
+
* Any values returned by the called listeners are ignored and will be discarded.
|
6629
|
+
* If the target DOM element is destroyed, any events that have been set up on that element will be destroyed.
|
6630
|
+
*
|
6631
|
+
* @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
|
6632
|
+
*
|
6633
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
|
6634
|
+
* Adds a listener to the end of the listeners array for the specified event.
|
6635
|
+
* @example
|
6636
|
+
* ```js
|
6637
|
+
* const myLayoutContainer = document.getElementById('layout-container');
|
6638
|
+
*
|
6639
|
+
* myLayoutContainer.addEventListener('tab-created', function(event) {
|
6640
|
+
* const { tabSelector } = event.detail;
|
6641
|
+
* const tabElement = document.getElementById(tabSelector);
|
6642
|
+
* const existingColor = tabElement.style.backgroundColor;
|
6643
|
+
* tabElement.style.backgroundColor = "red";
|
6644
|
+
* setTimeout(() => {
|
6645
|
+
* tabElement.style.backgroundColor = existingColor;
|
6646
|
+
* }, 2000);
|
6647
|
+
* });
|
6648
|
+
* ```
|
6649
|
+
*
|
6650
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
|
6651
|
+
* Adds a listener to the end of the listeners array for the specified event.
|
6652
|
+
* @example
|
6653
|
+
* ```js
|
6654
|
+
* const myLayoutContainer = document.getElementById('layout-container');
|
6655
|
+
*
|
6656
|
+
* const listener = function(event) {
|
6657
|
+
* console.log(event.detail);
|
6658
|
+
* console.log('container-created event fired once, removing listener');
|
6659
|
+
* myLayoutContainer.removeEventListener('container-created', listener);
|
6660
|
+
* };
|
6661
|
+
*
|
6662
|
+
* myLayoutContainer.addEventListener('container-created', listener);
|
6663
|
+
* ```
|
6664
|
+
*
|
6665
|
+
* ### Supported event types are:
|
6666
|
+
*
|
6667
|
+
* * tab-created
|
6668
|
+
* * container-created
|
6669
|
+
* * layout-state-changed
|
6670
|
+
* * tab-closed
|
6671
|
+
* * tab-dropped
|
6672
|
+
*
|
6673
|
+
* ### Layout DOM Node Events
|
6674
|
+
*
|
6675
|
+
* #### tab-created
|
6676
|
+
* 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.
|
6677
|
+
* ```js
|
6678
|
+
* // The response has the following shape in event.detail:
|
6679
|
+
* {
|
6680
|
+
* containerSelector: "container-component_A",
|
6681
|
+
* name: "component_A",
|
6682
|
+
* tabSelector: "tab-component_A",
|
6683
|
+
* topic: "openfin-DOM-event",
|
6684
|
+
* type: "tab-created",
|
6685
|
+
* uuid: "OpenFin POC"
|
6686
|
+
* }
|
6687
|
+
* ```
|
6688
|
+
*
|
6689
|
+
* #### container-created
|
6690
|
+
* 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.
|
6691
|
+
* ```js
|
6692
|
+
* // The response has the following shape in event.detail:
|
6693
|
+
* {
|
6694
|
+
* containerSelector: "container-component_A",
|
6695
|
+
* name: "component_A",
|
6696
|
+
* tabSelector: "tab-component_A",
|
6697
|
+
* topic: "openfin-DOM-event",
|
6698
|
+
* type: "container-created",
|
6699
|
+
* uuid: "OpenFin POC"
|
6700
|
+
* }
|
6701
|
+
* ```
|
6702
|
+
*
|
6703
|
+
* ### layout-state-changed
|
6704
|
+
* 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.
|
6705
|
+
* ```js
|
6706
|
+
* // The response has the following shape in event.detail
|
6707
|
+
* {
|
6708
|
+
* containerSelector: "container-component_A",
|
6709
|
+
* name: "component_A",
|
6710
|
+
* tabSelector: "tab-component_A",
|
6711
|
+
* topic: "openfin-DOM-event",
|
6712
|
+
* type: "layout-state-changed",
|
6713
|
+
* uuid: "OpenFin POC"
|
6714
|
+
* }
|
6715
|
+
* ```
|
6716
|
+
*
|
6717
|
+
* #### tab-closed
|
6718
|
+
* Generated when a tab is closed.
|
6719
|
+
* ```js
|
6720
|
+
* // The response has the following shape in event.detail:
|
6721
|
+
* {
|
6722
|
+
* containerSelector: "container-component_A",
|
6723
|
+
* name: "component_A",
|
6724
|
+
* tabSelector: "tab-component_A",
|
6725
|
+
* topic: "openfin-DOM-event",
|
6726
|
+
* type: "tab-closed",
|
6727
|
+
* uuid: "OpenFin POC",
|
6728
|
+
* url: "http://openfin.co" // The url of the view that was closed.
|
6729
|
+
* }
|
6730
|
+
* ```
|
6731
|
+
*
|
6732
|
+
* #### tab-dropped
|
6733
|
+
* Generated when a tab is dropped.
|
6734
|
+
* ```js
|
6735
|
+
* // The response has the following shape in event.detail:
|
6736
|
+
* {
|
6737
|
+
* containerSelector: "container-component_A",
|
6738
|
+
* name: "component_A",
|
6739
|
+
* tabSelector: "tab-component_A",
|
6740
|
+
* topic: "openfin-DOM-event",
|
6741
|
+
* type: "tab-dropped",
|
6742
|
+
* uuid: "OpenFin POC",
|
6743
|
+
* url: "http://openfin.co" // The url of the view linked to the dropped tab.
|
6744
|
+
* }
|
6745
|
+
* ```
|
6746
|
+
*/
|
6513
6747
|
declare class Layout extends Base {
|
6514
6748
|
#private;
|
6515
6749
|
/**
|
@@ -6810,6 +7044,7 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
|
|
6810
7044
|
|
6811
7045
|
/**
|
6812
7046
|
* Generated when a window and all of its layout's views have either finished or failed navigation.
|
7047
|
+
* @interface
|
6813
7048
|
*/
|
6814
7049
|
declare type LayoutInitializedEvent = NamedEvent & {
|
6815
7050
|
type: 'layout-initialized';
|
@@ -6931,6 +7166,9 @@ declare class LayoutManager {
|
|
6931
7166
|
private setComponentState;
|
6932
7167
|
}
|
6933
7168
|
|
7169
|
+
/**
|
7170
|
+
* Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
|
7171
|
+
*/
|
6934
7172
|
declare class LayoutModule extends Base {
|
6935
7173
|
#private;
|
6936
7174
|
/**
|
@@ -7284,6 +7522,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
7284
7522
|
|
7285
7523
|
/**
|
7286
7524
|
* Generated when a window and all of its layout's views have been created and can receive API calls.
|
7525
|
+
* @interface
|
7287
7526
|
*/
|
7288
7527
|
declare type LayoutReadyEvent = NamedEvent & {
|
7289
7528
|
type: 'layout-ready';
|
@@ -7391,6 +7630,7 @@ declare type Manifest = {
|
|
7391
7630
|
|
7392
7631
|
/**
|
7393
7632
|
* Generated when the RVM notifies an application that the manifest has changed.
|
7633
|
+
* @interface
|
7394
7634
|
*/
|
7395
7635
|
declare type ManifestChangedEvent = IdentityEvent & {
|
7396
7636
|
type: 'manifest-changed';
|
@@ -7434,6 +7674,7 @@ declare type MatchPattern = string;
|
|
7434
7674
|
|
7435
7675
|
/**
|
7436
7676
|
* Generated when a window is maximized.
|
7677
|
+
* @interface
|
7437
7678
|
*/
|
7438
7679
|
declare type MaximizedEvent = NamedEvent & {
|
7439
7680
|
type: 'maximized';
|
@@ -7506,6 +7747,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
|
|
7506
7747
|
|
7507
7748
|
/**
|
7508
7749
|
* Generated when a window is minimized.
|
7750
|
+
* @interface
|
7509
7751
|
*/
|
7510
7752
|
declare type MinimizedEvent = NamedEvent & {
|
7511
7753
|
type: 'minimized';
|
@@ -7551,6 +7793,7 @@ declare type MonitorDetails = {
|
|
7551
7793
|
* Generated on changes of a monitor's size/location.
|
7552
7794
|
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
7553
7795
|
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
7796
|
+
* @interface
|
7554
7797
|
*/
|
7555
7798
|
declare type MonitorEvent = OpenFin.MonitorInfo & {
|
7556
7799
|
type: 'monitor-info-changed';
|
@@ -7906,6 +8149,7 @@ declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => v
|
|
7906
8149
|
|
7907
8150
|
/**
|
7908
8151
|
* A Name event.
|
8152
|
+
* @interface
|
7909
8153
|
*/
|
7910
8154
|
declare type NamedEvent = IdentityEvent & {
|
7911
8155
|
name: string;
|
@@ -7917,6 +8161,7 @@ declare type NativeWindowIntegrationProviderAuthorization = {
|
|
7917
8161
|
|
7918
8162
|
/**
|
7919
8163
|
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
|
8164
|
+
* @interface
|
7920
8165
|
*/
|
7921
8166
|
declare type NavigationRejectedEvent = NamedEvent & {
|
7922
8167
|
type: 'navigation-rejected';
|
@@ -7937,6 +8182,9 @@ declare type NavigationRules = {
|
|
7937
8182
|
|
7938
8183
|
declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
|
7939
8184
|
|
8185
|
+
/**
|
8186
|
+
* @interface
|
8187
|
+
*/
|
7940
8188
|
declare type NonAppProcessDetails = ProcessDetails & {
|
7941
8189
|
name: string;
|
7942
8190
|
};
|
@@ -7963,6 +8211,7 @@ declare type NotRequested<EventType> = EventType extends `${infer U}-requested`
|
|
7963
8211
|
|
7964
8212
|
/**
|
7965
8213
|
* Generated when an application is not responding.
|
8214
|
+
* @interface
|
7966
8215
|
*/
|
7967
8216
|
declare type NotRespondingEvent = IdentityEvent & {
|
7968
8217
|
type: 'not-responding';
|
@@ -7970,6 +8219,9 @@ declare type NotRespondingEvent = IdentityEvent & {
|
|
7970
8219
|
|
7971
8220
|
declare type OnlyIfCompatible<A, B, D = OverlapsOnlyIfMatching<A, B>> = D extends Record<any, never> ? keyof D extends never ? A | B : never : A | B;
|
7972
8221
|
|
8222
|
+
/**
|
8223
|
+
* @interface
|
8224
|
+
*/
|
7973
8225
|
declare type Opacity = TransitionBase & {
|
7974
8226
|
/**
|
7975
8227
|
* The opacity from 0.0 (transparent) to 1.0 (normal).
|
@@ -8204,7 +8456,7 @@ declare namespace OpenFin {
|
|
8204
8456
|
ContextForIntent,
|
8205
8457
|
InfoForIntentOptions,
|
8206
8458
|
FindIntentsByContextOptions,
|
8207
|
-
|
8459
|
+
ProviderIdentity_7 as ProviderIdentity,
|
8208
8460
|
RegisterUsageData,
|
8209
8461
|
ViewsPreventingUnloadPayload,
|
8210
8462
|
BeforeUnloadUserDecision,
|
@@ -8276,7 +8528,8 @@ declare namespace OpenFin {
|
|
8276
8528
|
InteropLoggingOptions,
|
8277
8529
|
Me,
|
8278
8530
|
CapturePageOptions,
|
8279
|
-
ProcessLoggingOptions
|
8531
|
+
ProcessLoggingOptions,
|
8532
|
+
PositioningOptions
|
8280
8533
|
}
|
8281
8534
|
}
|
8282
8535
|
export default OpenFin;
|
@@ -8292,6 +8545,7 @@ declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T>
|
|
8292
8545
|
/**
|
8293
8546
|
* Generated when page title is set during navigation.
|
8294
8547
|
* @remarks explicitSet is false when title is synthesized from file url.
|
8548
|
+
* @interface
|
8295
8549
|
*/
|
8296
8550
|
declare type PageTitleUpdatedEvent = NamedEvent & {
|
8297
8551
|
type: 'page-title-updated';
|
@@ -8309,6 +8563,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
|
|
8309
8563
|
|
8310
8564
|
/**
|
8311
8565
|
* Generated when window finishes loading. Provides performance and navigation data.
|
8566
|
+
* @interface
|
8312
8567
|
*/
|
8313
8568
|
declare type PerformanceReportEvent = Performance & NamedEvent & {
|
8314
8569
|
type: 'performance-report';
|
@@ -8977,6 +9232,7 @@ declare type Platform_2 = OpenFin.Platform;
|
|
8977
9232
|
|
8978
9233
|
/**
|
8979
9234
|
* Generated when a new Platform's API becomes responsive.
|
9235
|
+
* @interface
|
8980
9236
|
*/
|
8981
9237
|
declare type PlatformApiReadyEvent = BaseEvent & {
|
8982
9238
|
topic: 'application';
|
@@ -8998,6 +9254,9 @@ declare namespace PlatformEvents {
|
|
8998
9254
|
}
|
8999
9255
|
}
|
9000
9256
|
|
9257
|
+
/**
|
9258
|
+
* Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
|
9259
|
+
*/
|
9001
9260
|
declare class PlatformModule extends Base {
|
9002
9261
|
private _channel;
|
9003
9262
|
Layout: LayoutModule;
|
@@ -9157,6 +9416,7 @@ declare class PlatformModule extends Base {
|
|
9157
9416
|
/**
|
9158
9417
|
* The options object required by {@link Platform.PlatformModule#start Platform.start}
|
9159
9418
|
* Any {@link ApplicationOptions Application option} is also a valid platform option
|
9419
|
+
* @interface
|
9160
9420
|
*/
|
9161
9421
|
declare type PlatformOptions = ApplicationCreationOptions & {
|
9162
9422
|
/**
|
@@ -9701,6 +9961,7 @@ declare interface PlatformProvider {
|
|
9701
9961
|
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
9702
9962
|
*
|
9703
9963
|
* _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.
|
9964
|
+
* @interface
|
9704
9965
|
*/
|
9705
9966
|
declare type PlatformSnapshotAppliedEvent = BaseEvent & {
|
9706
9967
|
topic: 'application';
|
@@ -9709,6 +9970,9 @@ declare type PlatformSnapshotAppliedEvent = BaseEvent & {
|
|
9709
9970
|
|
9710
9971
|
declare type PlatformViewCreationOptions = Partial<ViewOptions>;
|
9711
9972
|
|
9973
|
+
/**
|
9974
|
+
* @interface
|
9975
|
+
*/
|
9712
9976
|
declare type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
|
9713
9977
|
updateStateIfExists?: boolean;
|
9714
9978
|
reason?: WindowCreationReason;
|
@@ -9719,6 +9983,7 @@ declare type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
|
|
9719
9983
|
* Any {@link OpenFin.WindowCreationOptions Window option} is also a valid Default Window option
|
9720
9984
|
* used by default in any window that is created in the current platform's scope.
|
9721
9985
|
* Individual window options will override these defaults.
|
9986
|
+
* @interface
|
9722
9987
|
*/
|
9723
9988
|
declare type PlatformWindowOptions = WindowCreationOptions & {
|
9724
9989
|
/**
|
@@ -9786,6 +10051,9 @@ declare interface PopupResult<T = any> {
|
|
9786
10051
|
|
9787
10052
|
declare type PopupResultBehavior = 'none' | PopupBaseBehavior;
|
9788
10053
|
|
10054
|
+
/**
|
10055
|
+
* @interface
|
10056
|
+
*/
|
9789
10057
|
declare type Position = TransitionBase & {
|
9790
10058
|
/**
|
9791
10059
|
* Defaults to the window's current left position in virtual screen coordinates.
|
@@ -9797,6 +10065,26 @@ declare type Position = TransitionBase & {
|
|
9797
10065
|
top: number;
|
9798
10066
|
};
|
9799
10067
|
|
10068
|
+
/**
|
10069
|
+
* Leveraged by the following windowing apis to influence side effects of the positioning.
|
10070
|
+
* - {@link OpenFin.Window.moveBy}
|
10071
|
+
* - {@link OpenFin.Window.moveTo}
|
10072
|
+
* - {@link OpenFin.Window.setBounds}
|
10073
|
+
* - {@link OpenFin.Window.resizeBy}
|
10074
|
+
* - {@link OpenFin.Window.resizeTo}
|
10075
|
+
* @example ```js
|
10076
|
+
fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
|
10077
|
+
```
|
10078
|
+
*/
|
10079
|
+
declare interface PositioningOptions {
|
10080
|
+
/**
|
10081
|
+
* Windows Only.
|
10082
|
+
* If set to true, will not restore a maximized window before setting the bounds.
|
10083
|
+
* This will have the effect of the maximized window staying maximized and not immediately taking this new position.
|
10084
|
+
*/
|
10085
|
+
skipRestore?: boolean;
|
10086
|
+
}
|
10087
|
+
|
9800
10088
|
/**
|
9801
10089
|
* Context menu item with an implementation provided by OpenFin.
|
9802
10090
|
*/
|
@@ -9839,6 +10127,7 @@ declare type PreloadScriptInfoRunning = {
|
|
9839
10127
|
/**
|
9840
10128
|
* Generated after the execution of all of a window's preload scripts.
|
9841
10129
|
* @remarks Contains information about all window's preload scripts' final states.
|
10130
|
+
* @interface
|
9842
10131
|
*/
|
9843
10132
|
declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
|
9844
10133
|
type: 'preload-script-state-changed';
|
@@ -9846,6 +10135,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
|
|
9846
10135
|
|
9847
10136
|
/**
|
9848
10137
|
* A general preload scripts state change event without event type.
|
10138
|
+
* @interface
|
9849
10139
|
*/
|
9850
10140
|
declare type PreloadScriptsStateChangeEvent = NamedEvent & {
|
9851
10141
|
preloadScripts: (PreloadScriptInfoRunning & any)[];
|
@@ -9854,6 +10144,7 @@ declare type PreloadScriptsStateChangeEvent = NamedEvent & {
|
|
9854
10144
|
/**
|
9855
10145
|
* Generated during the execution of a window's preload script.
|
9856
10146
|
* @remarks Contains information about a single window's preload script's state, for which the event has been raised.
|
10147
|
+
* @interface
|
9857
10148
|
*/
|
9858
10149
|
declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
|
9859
10150
|
type: 'preload-script-state-changing';
|
@@ -10236,6 +10527,25 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
10236
10527
|
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
10237
10528
|
domainSettings: OpenFin.DefaultDomainSettings;
|
10238
10529
|
}, void>;
|
10530
|
+
'move-window-by': IdentityCall<WithPositioningOptions<{
|
10531
|
+
deltaLeft: number;
|
10532
|
+
deltaTop: number;
|
10533
|
+
}>>;
|
10534
|
+
'move-window': IdentityCall<WithPositioningOptions<{
|
10535
|
+
left: number;
|
10536
|
+
top: number;
|
10537
|
+
}>>;
|
10538
|
+
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
10539
|
+
deltaWidth: number;
|
10540
|
+
deltaHeight: number;
|
10541
|
+
anchor: OpenFin.AnchorType;
|
10542
|
+
}>>;
|
10543
|
+
'resize-window': IdentityCall<WithPositioningOptions<{
|
10544
|
+
width: number;
|
10545
|
+
height: number;
|
10546
|
+
anchor: OpenFin.AnchorType;
|
10547
|
+
}>>;
|
10548
|
+
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
|
10239
10549
|
}
|
10240
10550
|
|
10241
10551
|
declare interface ProtocolMapBase {
|
@@ -10267,12 +10577,11 @@ declare type ProviderIdentity_5 = OpenFin.ProviderIdentity;
|
|
10267
10577
|
|
10268
10578
|
declare type ProviderIdentity_6 = OpenFin.ProviderIdentity;
|
10269
10579
|
|
10270
|
-
declare type ProviderIdentity_7 = OpenFin.ProviderIdentity;
|
10271
|
-
|
10272
10580
|
/**
|
10273
10581
|
* Identity of a channel provider.
|
10582
|
+
* @interface
|
10274
10583
|
*/
|
10275
|
-
declare type
|
10584
|
+
declare type ProviderIdentity_7 = Identity_5 & {
|
10276
10585
|
/**
|
10277
10586
|
* Identifier of the channel.
|
10278
10587
|
*/
|
@@ -10339,6 +10648,9 @@ declare type QueryPermissionResult = {
|
|
10339
10648
|
rawValue?: unknown;
|
10340
10649
|
};
|
10341
10650
|
|
10651
|
+
/**
|
10652
|
+
* @interface
|
10653
|
+
*/
|
10342
10654
|
declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
|
10343
10655
|
|
10344
10656
|
/**
|
@@ -10374,6 +10686,7 @@ declare type RectangleByEdgePositions = {
|
|
10374
10686
|
|
10375
10687
|
/**
|
10376
10688
|
* Generated when a hotkey has been registered with the operating system.
|
10689
|
+
* @interface
|
10377
10690
|
*/
|
10378
10691
|
declare type RegisteredEvent = BaseEvent & {
|
10379
10692
|
type: 'registered';
|
@@ -10396,6 +10709,7 @@ declare type RegistryInfo_2 = {
|
|
10396
10709
|
|
10397
10710
|
/**
|
10398
10711
|
* Generated when a window has been reloaded.
|
10712
|
+
* @interface
|
10399
10713
|
*/
|
10400
10714
|
declare type ReloadedEvent = NamedEvent & {
|
10401
10715
|
type: 'reloaded';
|
@@ -10481,6 +10795,7 @@ declare type ResizeRegion = {
|
|
10481
10795
|
|
10482
10796
|
/**
|
10483
10797
|
* Generated when an HTTP load was cancelled or failed.
|
10798
|
+
* @interface
|
10484
10799
|
*/
|
10485
10800
|
declare type ResourceLoadFailedEvent = BaseLoadFailedEvent & {
|
10486
10801
|
type: 'resource-load-failed';
|
@@ -10488,6 +10803,7 @@ declare type ResourceLoadFailedEvent = BaseLoadFailedEvent & {
|
|
10488
10803
|
|
10489
10804
|
/**
|
10490
10805
|
* Generated when an HTTP resource request has received response details.
|
10806
|
+
* @interface
|
10491
10807
|
*/
|
10492
10808
|
declare type ResourceResponseReceivedEvent = NamedEvent & {
|
10493
10809
|
type: 'resource-response-received';
|
@@ -10503,6 +10819,7 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
|
|
10503
10819
|
|
10504
10820
|
/**
|
10505
10821
|
* Generated when an application is responding.
|
10822
|
+
* @interface
|
10506
10823
|
*/
|
10507
10824
|
declare type RespondingEvent = IdentityEvent & {
|
10508
10825
|
type: 'responding';
|
@@ -10516,7 +10833,10 @@ declare type RGB = {
|
|
10516
10833
|
green: number;
|
10517
10834
|
};
|
10518
10835
|
|
10519
|
-
|
10836
|
+
/**
|
10837
|
+
* @interface
|
10838
|
+
*/
|
10839
|
+
declare type RoutingInfo = OpenFin.ProviderIdentity & {
|
10520
10840
|
endpointId: string;
|
10521
10841
|
};
|
10522
10842
|
|
@@ -10542,7 +10862,7 @@ declare interface RTCProtocolOffer extends ProtocolPacketBase {
|
|
10542
10862
|
declare class RTCStrategy implements ChannelStrategy<RTCStrategyEndpointPayload> {
|
10543
10863
|
#private;
|
10544
10864
|
onEndpointDisconnect(endpointId: string, listener: () => void): void;
|
10545
|
-
receive(listener: (action: string, payload: any, identity: OpenFin.ClientIdentity | OpenFin.ClientIdentityMultiRuntime |
|
10865
|
+
receive(listener: (action: string, payload: any, identity: OpenFin.ClientIdentity | OpenFin.ClientIdentityMultiRuntime | ProviderIdentity_5) => Promise<any>): void;
|
10546
10866
|
send: (endpointId: string, action: string, payload: any) => Promise<any>;
|
10547
10867
|
close: () => Promise<void>;
|
10548
10868
|
private getEndpointById;
|
@@ -10554,7 +10874,7 @@ declare class RTCStrategy implements ChannelStrategy<RTCStrategyEndpointPayload>
|
|
10554
10874
|
}
|
10555
10875
|
|
10556
10876
|
declare interface RTCStrategyEndpointPayload {
|
10557
|
-
endpointIdentity: OpenFin.ClientIdentity |
|
10877
|
+
endpointIdentity: OpenFin.ClientIdentity | ProviderIdentity_5;
|
10558
10878
|
rtc: RTCPacket;
|
10559
10879
|
}
|
10560
10880
|
|
@@ -10562,6 +10882,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
|
|
10562
10882
|
|
10563
10883
|
/**
|
10564
10884
|
* Generated when Application.run() is called for an already running application.
|
10885
|
+
* @interface
|
10565
10886
|
*/
|
10566
10887
|
declare type RunRequestedEvent_2 = IdentityEvent & {
|
10567
10888
|
type: 'run-requested';
|
@@ -10713,6 +11034,7 @@ declare type ServiceIdentifier = {
|
|
10713
11034
|
|
10714
11035
|
/**
|
10715
11036
|
* Generated on changes to a user’s local computer session.
|
11037
|
+
* @interface
|
10716
11038
|
*/
|
10717
11039
|
declare type SessionChangedEvent = {
|
10718
11040
|
type: 'session-changed';
|
@@ -10763,12 +11085,16 @@ declare type ShortCutConfig = {
|
|
10763
11085
|
systemStartup?: boolean;
|
10764
11086
|
};
|
10765
11087
|
|
11088
|
+
/**
|
11089
|
+
* @interface
|
11090
|
+
*/
|
10766
11091
|
declare type ShortcutOverride = Hotkey & {
|
10767
11092
|
command: string;
|
10768
11093
|
};
|
10769
11094
|
|
10770
11095
|
/**
|
10771
11096
|
* Generated when a View is shown. This event will fire during creation of a View.
|
11097
|
+
* @interface
|
10772
11098
|
*/
|
10773
11099
|
declare type ShownEvent = BaseViewEvent & {
|
10774
11100
|
type: 'shown';
|
@@ -10782,6 +11108,7 @@ declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
|
|
10782
11108
|
|
10783
11109
|
/**
|
10784
11110
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
11111
|
+
* @interface
|
10785
11112
|
*/
|
10786
11113
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
10787
11114
|
/**
|
@@ -10798,6 +11125,9 @@ declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
10798
11125
|
paintIntervalMs?: number;
|
10799
11126
|
};
|
10800
11127
|
|
11128
|
+
/**
|
11129
|
+
* @interface
|
11130
|
+
*/
|
10801
11131
|
declare type Size = TransitionBase & {
|
10802
11132
|
/**
|
10803
11133
|
* Optional if height is present. Defaults to the window's current width.
|
@@ -10877,6 +11207,9 @@ declare class SnapshotSource<T = any> extends Base {
|
|
10877
11207
|
applySnapshot(snapshot: T): Promise<void>;
|
10878
11208
|
}
|
10879
11209
|
|
11210
|
+
/**
|
11211
|
+
* Static namespace for OpenFin API methods that interact with the {@link SnapshotSource} class, available under `fin.SnapshotSource`.
|
11212
|
+
*/
|
10880
11213
|
declare class SnapshotSourceModule extends Base {
|
10881
11214
|
/**
|
10882
11215
|
* Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
|
@@ -10955,6 +11288,7 @@ declare type SplitterItem = GoldenLayout.ContentItem & {
|
|
10955
11288
|
|
10956
11289
|
/**
|
10957
11290
|
* Generated when an application has started.
|
11291
|
+
* @interface
|
10958
11292
|
*/
|
10959
11293
|
declare type StartedEvent = IdentityEvent & {
|
10960
11294
|
type: 'started';
|
@@ -12743,12 +13077,16 @@ declare type TargetApp = string | AppMetadata;
|
|
12743
13077
|
* Generated when a View changes its window target.
|
12744
13078
|
* @remarks This event will fire during creation of a View.
|
12745
13079
|
* In that case, previousTarget identity will be the same as target identity.
|
13080
|
+
* @interface
|
12746
13081
|
*/
|
12747
13082
|
declare type TargetChangedEvent = BaseViewEvent & {
|
12748
13083
|
type: 'target-changed';
|
12749
13084
|
previousTarget: OpenFin.Identity;
|
12750
13085
|
};
|
12751
13086
|
|
13087
|
+
/**
|
13088
|
+
* @interface
|
13089
|
+
*/
|
12752
13090
|
declare type TaskBar = DipScaleRects & {
|
12753
13091
|
/**
|
12754
13092
|
* Which edge of a monitor the taskbar is on
|
@@ -12871,6 +13209,7 @@ declare class Transport<MeType extends EntityType_3 = EntityType_3> extends Even
|
|
12871
13209
|
|
12872
13210
|
/**
|
12873
13211
|
* Generated when the tray icon is clicked.
|
13212
|
+
* @interface
|
12874
13213
|
*/
|
12875
13214
|
declare type TrayIconClickedEvent = IdentityEvent & {
|
12876
13215
|
type: 'tray-icon-clicked';
|
@@ -12922,6 +13261,7 @@ declare interface TypedEventEmitter<Event extends {
|
|
12922
13261
|
|
12923
13262
|
/**
|
12924
13263
|
* Generated when a hotkey has been unregistered with the operating system.
|
13264
|
+
* @interface
|
12925
13265
|
*/
|
12926
13266
|
declare type UnregisteredEvent = BaseEvent & {
|
12927
13267
|
type: 'unregistered';
|
@@ -12938,6 +13278,7 @@ declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
|
|
12938
13278
|
* Generated when navigation or redirect is completed.
|
12939
13279
|
* @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.
|
12940
13280
|
* 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).
|
13281
|
+
* @interface
|
12941
13282
|
*/
|
12942
13283
|
declare type UrlChangedEvent = BaseUrlEvent & ({
|
12943
13284
|
isInPage: true;
|
@@ -12949,6 +13290,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
12949
13290
|
|
12950
13291
|
/**
|
12951
13292
|
* A general user bounds change event without event type.
|
13293
|
+
* @interface
|
12952
13294
|
*/
|
12953
13295
|
declare type UserBoundsChangeEvent = NamedEvent & {
|
12954
13296
|
height: number;
|
@@ -12960,6 +13302,7 @@ declare type UserBoundsChangeEvent = NamedEvent & {
|
|
12960
13302
|
|
12961
13303
|
/**
|
12962
13304
|
* Generated when a window's user movement becomes disabled.
|
13305
|
+
* @interface
|
12963
13306
|
*/
|
12964
13307
|
declare type UserMovementDisabledEvent = NamedEvent & {
|
12965
13308
|
type: 'user-movement-disabled';
|
@@ -12967,6 +13310,7 @@ declare type UserMovementDisabledEvent = NamedEvent & {
|
|
12967
13310
|
|
12968
13311
|
/**
|
12969
13312
|
* Generated when a window's user movement becomes enabled.
|
13313
|
+
* @interface
|
12970
13314
|
*/
|
12971
13315
|
declare type UserMovementEnabledEvent = NamedEvent & {
|
12972
13316
|
type: 'user-movement-enabled';
|
@@ -13576,6 +13920,7 @@ declare interface ViewComponent extends GoldenLayout.ContentItem {
|
|
13576
13920
|
*
|
13577
13921
|
* Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
|
13578
13922
|
* (defaults to `"about:blank"` when omitted).
|
13923
|
+
* @interface
|
13579
13924
|
*/
|
13580
13925
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
13581
13926
|
name: string;
|
@@ -13588,6 +13933,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
|
|
13588
13933
|
/**
|
13589
13934
|
* Generated when a window has a view detached from it.
|
13590
13935
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
13936
|
+
* @interface
|
13591
13937
|
*/
|
13592
13938
|
declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
|
13593
13939
|
type: 'view-detached';
|
@@ -13611,7 +13957,7 @@ declare namespace ViewEvents {
|
|
13611
13957
|
AttachedEvent,
|
13612
13958
|
CreatedEvent,
|
13613
13959
|
DestroyedEvent,
|
13614
|
-
|
13960
|
+
HiddenEvent,
|
13615
13961
|
HotkeyEvent,
|
13616
13962
|
ShownEvent,
|
13617
13963
|
WillPropagateViewEvent,
|
@@ -13636,6 +13982,9 @@ declare type ViewInfo = {
|
|
13636
13982
|
favicons: string[];
|
13637
13983
|
};
|
13638
13984
|
|
13985
|
+
/**
|
13986
|
+
* Static namespace for OpenFin API methods that interact with the {@link View} class, available under `fin.View`.
|
13987
|
+
*/
|
13639
13988
|
declare class ViewModule extends Base {
|
13640
13989
|
/**
|
13641
13990
|
* Creates a new View.
|
@@ -13718,6 +14067,7 @@ declare class ViewModule extends Base {
|
|
13718
14067
|
|
13719
14068
|
/**
|
13720
14069
|
* User-facing options for a view.
|
14070
|
+
* @interface
|
13721
14071
|
*/
|
13722
14072
|
declare type ViewOptions = ConstViewOptions & MutableViewOptions;
|
13723
14073
|
|
@@ -13778,6 +14128,9 @@ declare interface ViewsPreventingUnloadPayload {
|
|
13778
14128
|
closeType: 'view' | 'window';
|
13779
14129
|
}
|
13780
14130
|
|
14131
|
+
/**
|
14132
|
+
* @interface
|
14133
|
+
*/
|
13781
14134
|
declare type ViewState = ViewCreationOptions & {
|
13782
14135
|
backgroundThrottling: boolean;
|
13783
14136
|
componentName: 'view';
|
@@ -14747,6 +15100,7 @@ declare type WebRequestHeader = {
|
|
14747
15100
|
/**
|
14748
15101
|
* Generated when a window is being moved by the user.
|
14749
15102
|
* @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
|
15103
|
+
* @interface
|
14750
15104
|
*/
|
14751
15105
|
declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
14752
15106
|
type: 'will-move';
|
@@ -14754,6 +15108,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
14754
15108
|
|
14755
15109
|
/**
|
14756
15110
|
* A general will-move or will-resize event without event type.
|
15111
|
+
* @interface
|
14757
15112
|
*/
|
14758
15113
|
declare type WillMoveOrResizeEvent = NamedEvent & {
|
14759
15114
|
height: number;
|
@@ -14771,7 +15126,7 @@ declare type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedE
|
|
14771
15126
|
/**
|
14772
15127
|
* A View event that does propagate to (republish on) parent topics.
|
14773
15128
|
*/
|
14774
|
-
declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent |
|
15129
|
+
declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
|
14775
15130
|
|
14776
15131
|
/**
|
14777
15132
|
* A WebContents event that does propagate to (republish on) parent topics.
|
@@ -14781,10 +15136,11 @@ declare type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelection
|
|
14781
15136
|
/**
|
14782
15137
|
* A Window event that does propagate to (republish on) parent topics.
|
14783
15138
|
*/
|
14784
|
-
declare type WillPropagateWindowEvent = WillPropagateWebContentsEvent | PropagatedViewAttachedEvent | ViewDetachedEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | WindowCloseRequestedEvent | WindowClosedEvent | WindowClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent |
|
15139
|
+
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;
|
14785
15140
|
|
14786
15141
|
/**
|
14787
15142
|
* Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
|
15143
|
+
* @interface
|
14788
15144
|
*/
|
14789
15145
|
declare type WillRedirectEvent = NamedEvent & {
|
14790
15146
|
type: 'will-redirect';
|
@@ -14797,6 +15153,7 @@ declare type WillRedirectEvent = NamedEvent & {
|
|
14797
15153
|
* Generated when a window is being resized by the user.
|
14798
15154
|
* @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
|
14799
15155
|
* 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.
|
15156
|
+
* @interface
|
14800
15157
|
*/
|
14801
15158
|
declare type WillResizeEvent = WillMoveOrResizeEvent & {
|
14802
15159
|
type: 'will-resize';
|
@@ -15952,7 +16309,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
15952
16309
|
* moveBy(580, 300).then(() => console.log('Moved')).catch(err => console.log(err));
|
15953
16310
|
* ```
|
15954
16311
|
*/
|
15955
|
-
moveBy(deltaLeft: number, deltaTop: number): Promise<void>;
|
16312
|
+
moveBy(deltaLeft: number, deltaTop: number, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
|
15956
16313
|
/**
|
15957
16314
|
* Moves the window to a specified location.
|
15958
16315
|
* @param left The left position of the window
|
@@ -15978,7 +16335,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
15978
16335
|
* moveTo(580, 300).then(() => console.log('Moved')).catch(err => console.log(err))
|
15979
16336
|
* ```
|
15980
16337
|
*/
|
15981
|
-
moveTo(left: number, top: number): Promise<void>;
|
16338
|
+
moveTo(left: number, top: number, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
|
15982
16339
|
/**
|
15983
16340
|
* Resizes the window by a specified amount.
|
15984
16341
|
* @param deltaWidth The change in the width of the window
|
@@ -16007,7 +16364,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16007
16364
|
* resizeBy(580, 300, 'top-right').then(() => console.log('Resized')).catch(err => console.log(err));
|
16008
16365
|
* ```
|
16009
16366
|
*/
|
16010
|
-
resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin.AnchorType): Promise<void>;
|
16367
|
+
resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin.AnchorType, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
|
16011
16368
|
/**
|
16012
16369
|
* Resizes the window to the specified dimensions.
|
16013
16370
|
* @param width The change in the width of the window
|
@@ -16036,7 +16393,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16036
16393
|
* resizeTo(580, 300, 'top-left').then(() => console.log('Resized')).catch(err => console.log(err));
|
16037
16394
|
* ```
|
16038
16395
|
*/
|
16039
|
-
resizeTo(width: number, height: number, anchor: OpenFin.AnchorType): Promise<void>;
|
16396
|
+
resizeTo(width: number, height: number, anchor: OpenFin.AnchorType, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
|
16040
16397
|
/**
|
16041
16398
|
* Restores the window to its normal state (i.e., unminimized, unmaximized).
|
16042
16399
|
*
|
@@ -16087,7 +16444,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16087
16444
|
setAsForeground(): Promise<void>;
|
16088
16445
|
/**
|
16089
16446
|
* Sets the window's size and position.
|
16090
|
-
* @property { Bounds } bounds This is a * @type {string} name - name of the window.object that holds the propertys of
|
16091
16447
|
*
|
16092
16448
|
* @example
|
16093
16449
|
* ```js
|
@@ -16114,7 +16470,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16114
16470
|
* }).then(() => console.log('Bounds set to window')).catch(err => console.log(err));
|
16115
16471
|
* ```
|
16116
16472
|
*/
|
16117
|
-
setBounds(bounds: Partial<OpenFin.Bounds
|
16473
|
+
setBounds(bounds: Partial<OpenFin.Bounds>, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
|
16118
16474
|
/**
|
16119
16475
|
* Shows the window if it is hidden.
|
16120
16476
|
* @param force Show will be prevented from showing when force is false and
|
@@ -16405,6 +16761,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16405
16761
|
|
16406
16762
|
/**
|
16407
16763
|
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
16764
|
+
* @interface
|
16408
16765
|
*/
|
16409
16766
|
declare type WindowAlertRequestedEvent = NamedEvent & {
|
16410
16767
|
type: 'window-alert-requested';
|
@@ -16412,6 +16769,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16412
16769
|
|
16413
16770
|
/**
|
16414
16771
|
* Returned from getBounds call. bottom and right are never used for setting.
|
16772
|
+
* @interface
|
16415
16773
|
*/
|
16416
16774
|
declare type WindowBounds = Bounds & {
|
16417
16775
|
bottom: number;
|
@@ -16420,6 +16778,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16420
16778
|
|
16421
16779
|
/**
|
16422
16780
|
* Generated when a window has closed.
|
16781
|
+
* @interface
|
16423
16782
|
*/
|
16424
16783
|
declare type WindowClosedEvent = NamedEvent & {
|
16425
16784
|
type: 'closed';
|
@@ -16428,6 +16787,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16428
16787
|
/**
|
16429
16788
|
* Generated when a window has been prevented from closing.
|
16430
16789
|
* @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.
|
16790
|
+
* @interface
|
16431
16791
|
*/
|
16432
16792
|
declare type WindowCloseRequestedEvent = NamedEvent & {
|
16433
16793
|
type: 'close-requested';
|
@@ -16435,6 +16795,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16435
16795
|
|
16436
16796
|
/**
|
16437
16797
|
* Generated when a window has initiated the closing routine.
|
16798
|
+
* @interface
|
16438
16799
|
*/
|
16439
16800
|
declare type WindowClosingEvent = NamedEvent & {
|
16440
16801
|
type: 'closing';
|
@@ -16442,6 +16803,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16442
16803
|
|
16443
16804
|
/**
|
16444
16805
|
* Generated when a child window is created.
|
16806
|
+
* @interface
|
16445
16807
|
*/
|
16446
16808
|
declare type WindowCreatedEvent = NamedEvent & {
|
16447
16809
|
type: 'window-created';
|
@@ -16452,6 +16814,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16452
16814
|
*
|
16453
16815
|
* Note that `name` is the only required property — albeit the `url` property is usually provided as well
|
16454
16816
|
* (defaults to `"about:blank"` when omitted).
|
16817
|
+
* @interface
|
16455
16818
|
*/
|
16456
16819
|
declare type WindowCreationOptions = Partial<WindowOptions> & {
|
16457
16820
|
name: string;
|
@@ -16494,6 +16857,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16494
16857
|
|
16495
16858
|
/**
|
16496
16859
|
* Generated when a child window ends loading.
|
16860
|
+
* @interface
|
16497
16861
|
*/
|
16498
16862
|
declare type WindowEndLoadEvent = NamedEvent & {
|
16499
16863
|
type: 'window-end-load';
|
@@ -16518,7 +16882,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16518
16882
|
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
16519
16883
|
ExternalProcessExitedEvent,
|
16520
16884
|
ExternalProcessStartedEvent,
|
16521
|
-
|
16885
|
+
WindowHiddenEvent,
|
16522
16886
|
PreloadScriptInfoRunning,
|
16523
16887
|
PreloadScriptInfo,
|
16524
16888
|
PreloadScriptsStateChangeEvent,
|
@@ -16568,9 +16932,19 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16568
16932
|
*/
|
16569
16933
|
declare type WindowEventType = WindowEvent['type'];
|
16570
16934
|
|
16935
|
+
/**
|
16936
|
+
* Generated when a window has been hidden.
|
16937
|
+
* @interface
|
16938
|
+
*/
|
16939
|
+
declare type WindowHiddenEvent = NamedEvent & {
|
16940
|
+
type: 'hidden';
|
16941
|
+
reason: 'closing' | 'hide' | 'hide-on-close';
|
16942
|
+
};
|
16943
|
+
|
16571
16944
|
/**
|
16572
16945
|
* Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
|
16573
16946
|
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
16947
|
+
* @interface
|
16574
16948
|
*/
|
16575
16949
|
declare type WindowHotkeyEvent = InputEvent_2 & NamedEvent & {
|
16576
16950
|
type: 'hotkey';
|
@@ -16586,11 +16960,15 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16586
16960
|
|
16587
16961
|
/**
|
16588
16962
|
* Generated when a window is initialized.
|
16963
|
+
* @interface
|
16589
16964
|
*/
|
16590
16965
|
declare type WindowInitializedEvent = NamedEvent & {
|
16591
16966
|
type: 'initialized';
|
16592
16967
|
};
|
16593
16968
|
|
16969
|
+
/**
|
16970
|
+
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
16971
|
+
*/
|
16594
16972
|
declare class _WindowModule extends Base {
|
16595
16973
|
/**
|
16596
16974
|
* Asynchronously returns a Window object that represents an existing window.
|
@@ -16681,6 +17059,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16681
17059
|
|
16682
17060
|
/**
|
16683
17061
|
* Generated when a child window is not responding.
|
17062
|
+
* @interface
|
16684
17063
|
*/
|
16685
17064
|
declare type WindowNotRespondingEvent = NamedEvent & {
|
16686
17065
|
type: 'window-not-responding';
|
@@ -16693,6 +17072,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16693
17072
|
};
|
16694
17073
|
};
|
16695
17074
|
|
17075
|
+
/**
|
17076
|
+
* @interface
|
17077
|
+
*/
|
16696
17078
|
declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
|
16697
17079
|
|
16698
17080
|
declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
|
@@ -16700,6 +17082,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16700
17082
|
/**
|
16701
17083
|
* Generated after window options are changed using the window.updateOptions method.
|
16702
17084
|
* @remarks Will not fire if the diff object is empty.
|
17085
|
+
* @interface
|
16703
17086
|
*/
|
16704
17087
|
declare type WindowOptionsChangedEvent_2 = NamedEvent & {
|
16705
17088
|
type: 'options-changed';
|
@@ -16711,6 +17094,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16711
17094
|
|
16712
17095
|
/**
|
16713
17096
|
* Generated when a child window is responding.
|
17097
|
+
* @interface
|
16714
17098
|
*/
|
16715
17099
|
declare type WindowRespondingEvent = NamedEvent & {
|
16716
17100
|
type: 'window-responding';
|
@@ -16718,6 +17102,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16718
17102
|
|
16719
17103
|
/**
|
16720
17104
|
* Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
17105
|
+
* @interface
|
16721
17106
|
*/
|
16722
17107
|
declare type WindowRestoredEvent = NamedEvent & {
|
16723
17108
|
type: 'restored';
|
@@ -16725,6 +17110,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16725
17110
|
|
16726
17111
|
/**
|
16727
17112
|
* Generated when a hidden window has been shown.
|
17113
|
+
* @interface
|
16728
17114
|
*/
|
16729
17115
|
declare type WindowShownEvent = NamedEvent & {
|
16730
17116
|
type: 'shown';
|
@@ -16733,6 +17119,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16733
17119
|
/**
|
16734
17120
|
* Generated when a window has been prevented from showing.
|
16735
17121
|
* @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.
|
17122
|
+
* @interface
|
16736
17123
|
*/
|
16737
17124
|
declare type WindowShowRequestedEvent = NamedEvent & {
|
16738
17125
|
type: 'show-requested';
|
@@ -16740,6 +17127,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16740
17127
|
|
16741
17128
|
/**
|
16742
17129
|
* Generated when a child window starts loading.
|
17130
|
+
* @interface
|
16743
17131
|
*/
|
16744
17132
|
declare type WindowStartLoadEvent = NamedEvent & {
|
16745
17133
|
type: 'window-start-load';
|
@@ -16781,6 +17169,10 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16781
17169
|
*/
|
16782
17170
|
declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
|
16783
17171
|
|
17172
|
+
declare type WithPositioningOptions<T extends {} = {}> = T & {
|
17173
|
+
positioningOptions?: OpenFin.PositioningOptions;
|
17174
|
+
};
|
17175
|
+
|
16784
17176
|
declare type WorkspacePlatformOptions = {
|
16785
17177
|
/** Leaving this as any for now until we figure out what the shape should look like in Workspace */
|
16786
17178
|
[key: string]: any;
|
@@ -16788,6 +17180,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16788
17180
|
|
16789
17181
|
/**
|
16790
17182
|
* A generic request to write any supported data to the clipboard.
|
17183
|
+
* @interface
|
16791
17184
|
*/
|
16792
17185
|
declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
|
16793
17186
|
data: {
|
@@ -16806,6 +17199,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16806
17199
|
|
16807
17200
|
/**
|
16808
17201
|
* A request to write data to the clipboard.
|
17202
|
+
* @interface
|
16809
17203
|
*/
|
16810
17204
|
declare type WriteClipboardRequest = BaseClipboardRequest & {
|
16811
17205
|
/**
|
@@ -16814,6 +17208,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
16814
17208
|
data: string;
|
16815
17209
|
};
|
16816
17210
|
|
17211
|
+
/**
|
17212
|
+
* @interface
|
17213
|
+
*/
|
16817
17214
|
declare type WriteImageClipboardRequest = BaseClipboardRequest & {
|
16818
17215
|
/**
|
16819
17216
|
* Can be either a base64 string, or a DataURL string. If using DataURL, the
|