@openfin/node-adapter 34.78.34 → 34.78.37
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 +413 -131
- package/out/node-adapter-beta.d.ts +413 -131
- package/out/node-adapter-public.d.ts +413 -131
- package/out/node-adapter.d.ts +414 -132
- package/out/node-adapter.js +19 -13
- package/package.json +1 -1
package/out/node-adapter.d.ts
CHANGED
@@ -57,7 +57,7 @@ declare type AddViewToStackOptions = {
|
|
57
57
|
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
58
58
|
* @interface
|
59
59
|
*/
|
60
|
-
declare type AlertRequestedEvent =
|
60
|
+
declare type AlertRequestedEvent = BaseWindowEvent & {
|
61
61
|
type: 'alert-requested';
|
62
62
|
message: string;
|
63
63
|
url: string;
|
@@ -859,6 +859,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
|
|
859
859
|
* @interface
|
860
860
|
*/
|
861
861
|
declare type ApplicationConnectedEvent = IdentityEvent & {
|
862
|
+
topic: 'application';
|
862
863
|
type: 'connected';
|
863
864
|
};
|
864
865
|
|
@@ -866,7 +867,7 @@ declare type ApplicationConnectedEvent = IdentityEvent & {
|
|
866
867
|
* Generated when an application is created.
|
867
868
|
* @interface
|
868
869
|
*/
|
869
|
-
declare type ApplicationCreatedEvent = IdentityEvent & {
|
870
|
+
declare type ApplicationCreatedEvent = BaseSystemEvent & IdentityEvent & {
|
870
871
|
type: 'application-created';
|
871
872
|
};
|
872
873
|
|
@@ -895,14 +896,13 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
|
|
895
896
|
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
896
897
|
* from which they propagate).
|
897
898
|
*/
|
898
|
-
declare type ApplicationEvent =
|
899
|
-
topic: 'application';
|
900
|
-
} & (PropagatedViewEvent | PropagatedWindowEvent | ApplicationWindowEvent | WillPropagateApplicationEvent);
|
899
|
+
declare type ApplicationEvent = PropagatedViewEvent<'application'> | PropagatedWindowEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
|
901
900
|
|
902
901
|
declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
|
903
902
|
|
904
903
|
declare namespace ApplicationEvents {
|
905
904
|
export {
|
905
|
+
BaseApplicationEvent,
|
906
906
|
CrashedEvent,
|
907
907
|
FileDownloadLocationChangedEvent,
|
908
908
|
RunRequestedEvent_2 as RunRequestedEvent,
|
@@ -921,16 +921,18 @@ declare namespace ApplicationEvents {
|
|
921
921
|
NotRespondingEvent,
|
922
922
|
RespondingEvent,
|
923
923
|
StartedEvent,
|
924
|
-
|
924
|
+
ApplicationSourcedEvent,
|
925
925
|
ApplicationEvent,
|
926
926
|
ApplicationEventType,
|
927
927
|
PropagatedApplicationEvent,
|
928
|
-
PropagatedApplicationEventType
|
928
|
+
PropagatedApplicationEventType,
|
929
|
+
Payload_2 as Payload,
|
930
|
+
ByType
|
929
931
|
}
|
930
932
|
}
|
931
933
|
|
932
934
|
/**
|
933
|
-
*
|
935
|
+
* Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
|
934
936
|
*/
|
935
937
|
declare type ApplicationEventType = ApplicationEvent['type'];
|
936
938
|
|
@@ -1281,6 +1283,14 @@ declare type ApplicationPermissions = {
|
|
1281
1283
|
getFileDownloadLocation: boolean;
|
1282
1284
|
};
|
1283
1285
|
|
1286
|
+
/**
|
1287
|
+
* A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
|
1288
|
+
* from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
|
1289
|
+
* does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
|
1290
|
+
*
|
1291
|
+
*/
|
1292
|
+
declare type ApplicationSourcedEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
1293
|
+
|
1284
1294
|
declare type ApplicationState = OpenFin.ApplicationState;
|
1285
1295
|
|
1286
1296
|
/**
|
@@ -1526,14 +1536,6 @@ declare type AppVersionTypeFromIdEvent<T extends IdEventType> = Extract<AppVersi
|
|
1526
1536
|
type: WithoutId<T>;
|
1527
1537
|
}>;
|
1528
1538
|
|
1529
|
-
/**
|
1530
|
-
* Generated when a View is attached to a window.
|
1531
|
-
* @interface
|
1532
|
-
*/
|
1533
|
-
declare type AttachedEvent = BaseViewEvent & {
|
1534
|
-
type: 'attached';
|
1535
|
-
};
|
1536
|
-
|
1537
1539
|
declare interface AuthorizationPayload {
|
1538
1540
|
token: string;
|
1539
1541
|
file: string;
|
@@ -1603,7 +1605,7 @@ declare interface AuthorizationPayload {
|
|
1603
1605
|
* ```
|
1604
1606
|
* @interface
|
1605
1607
|
*/
|
1606
|
-
declare type AuthRequestedEvent =
|
1608
|
+
declare type AuthRequestedEvent = BaseWindowEvent & {
|
1607
1609
|
type: 'auth-requested';
|
1608
1610
|
authInfo: {
|
1609
1611
|
host: string;
|
@@ -1670,6 +1672,14 @@ declare class Base {
|
|
1670
1672
|
protected isBrowserEnvironment: () => boolean;
|
1671
1673
|
}
|
1672
1674
|
|
1675
|
+
/**
|
1676
|
+
* Base type for events emitting on the `application` topic
|
1677
|
+
* @interface
|
1678
|
+
*/
|
1679
|
+
declare type BaseApplicationEvent = NamedEvent & {
|
1680
|
+
topic: `application`;
|
1681
|
+
};
|
1682
|
+
|
1673
1683
|
/**
|
1674
1684
|
* A base Channel event.
|
1675
1685
|
* @interface
|
@@ -1742,6 +1752,14 @@ declare namespace BaseEvents {
|
|
1742
1752
|
}
|
1743
1753
|
}
|
1744
1754
|
|
1755
|
+
/**
|
1756
|
+
* Base type for events emitting on the `externalapplication` topic
|
1757
|
+
* @interface
|
1758
|
+
*/
|
1759
|
+
declare type BaseExternalApplicationEvent = BaseEvent & {
|
1760
|
+
topic: 'externalapplication';
|
1761
|
+
};
|
1762
|
+
|
1745
1763
|
/**
|
1746
1764
|
* The base frame event.
|
1747
1765
|
* @interface
|
@@ -1758,18 +1776,34 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
1758
1776
|
isMainFrame: boolean;
|
1759
1777
|
};
|
1760
1778
|
|
1779
|
+
/**
|
1780
|
+
* Base type for events emitting on the `system` topic
|
1781
|
+
* @interface
|
1782
|
+
*/
|
1783
|
+
declare type BaseSystemEvent = BaseEvent & {
|
1784
|
+
topic: 'system';
|
1785
|
+
};
|
1786
|
+
|
1761
1787
|
declare type BaseUrlEvent = NamedEvent & {
|
1762
1788
|
type: 'url-changed';
|
1763
1789
|
url: string;
|
1764
1790
|
};
|
1765
1791
|
|
1766
1792
|
/**
|
1767
|
-
*
|
1793
|
+
* Base type for events emitting on the `view` topic
|
1768
1794
|
* @interface
|
1769
1795
|
*/
|
1770
1796
|
declare type BaseViewEvent = NamedEvent & {
|
1797
|
+
topic: 'view';
|
1771
1798
|
target: OpenFin.Identity;
|
1772
|
-
|
1799
|
+
};
|
1800
|
+
|
1801
|
+
/**
|
1802
|
+
* Base type for events emitting on the `window` topic
|
1803
|
+
* @interface
|
1804
|
+
*/
|
1805
|
+
declare type BaseWindowEvent = NamedEvent & {
|
1806
|
+
topic: 'window';
|
1773
1807
|
};
|
1774
1808
|
|
1775
1809
|
/**
|
@@ -1825,7 +1859,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
1825
1859
|
* A general bounds change event without event type.
|
1826
1860
|
* @interface
|
1827
1861
|
*/
|
1828
|
-
declare type BoundsChangeEvent =
|
1862
|
+
declare type BoundsChangeEvent = BaseWindowEvent & {
|
1829
1863
|
changeType: 0 | 1 | 2;
|
1830
1864
|
deferred: boolean;
|
1831
1865
|
height: number;
|
@@ -1884,6 +1918,78 @@ declare interface BrowserWindow {
|
|
1884
1918
|
popIn(): void;
|
1885
1919
|
}
|
1886
1920
|
|
1921
|
+
/**
|
1922
|
+
* Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
|
1923
|
+
*
|
1924
|
+
* Alias for {@link Payload}, which may read better in source.
|
1925
|
+
*
|
1926
|
+
* @typeParam Type String key specifying the event to extract
|
1927
|
+
*/
|
1928
|
+
declare type ByType<Type extends ApplicationEventType> = Payload_2<Type>;
|
1929
|
+
|
1930
|
+
/**
|
1931
|
+
* Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
|
1932
|
+
*
|
1933
|
+
* Alias for {@link Payload}, which may read better in source.
|
1934
|
+
*
|
1935
|
+
* @typeParam Type String key specifying the event to extract
|
1936
|
+
*/
|
1937
|
+
declare type ByType_2<Type extends ExternalApplicationEventType> = Payload_3<Type>;
|
1938
|
+
|
1939
|
+
/**
|
1940
|
+
* Extracts a single event type matching the given key from the {@link FrameEvent} union.
|
1941
|
+
*
|
1942
|
+
* Alias for {@link Payload}, which may read better in source.
|
1943
|
+
*
|
1944
|
+
* @typeParam Type String key specifying the event to extract
|
1945
|
+
*/
|
1946
|
+
declare type ByType_3<Type extends FrameEventType> = Payload_4<Type>;
|
1947
|
+
|
1948
|
+
/**
|
1949
|
+
* Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
|
1950
|
+
*
|
1951
|
+
* Alias for {@link Payload}, which may read better in source.
|
1952
|
+
*
|
1953
|
+
* @typeParam Type String key specifying the event to extract
|
1954
|
+
*/
|
1955
|
+
declare type ByType_4<Type extends GlobalHotkeyEventType> = Payload_5<Type>;
|
1956
|
+
|
1957
|
+
/**
|
1958
|
+
* Extracts a single event type matching the given key from the {@link PlatformEvent} union.
|
1959
|
+
*
|
1960
|
+
* Alias for {@link Payload}, which may read better in source.
|
1961
|
+
*
|
1962
|
+
* @typeParam Type String key specifying the event to extract
|
1963
|
+
*/
|
1964
|
+
declare type ByType_5<Type extends PlatformEventType> = Payload_6<Type>;
|
1965
|
+
|
1966
|
+
/**
|
1967
|
+
* Extracts a single event type matching the given key from the {@link SystemEvent} union.
|
1968
|
+
*
|
1969
|
+
* Alias for {@link Payload}, which may read better in source.
|
1970
|
+
*
|
1971
|
+
* @typeParam Type String key specifying the event to extract
|
1972
|
+
*/
|
1973
|
+
declare type ByType_6<Type extends SystemEventType> = Payload_7<Type>;
|
1974
|
+
|
1975
|
+
/**
|
1976
|
+
* Extracts a single event type matching the given key from the {@link ViewEvent} union.
|
1977
|
+
*
|
1978
|
+
* Alias for {@link Payload}, which may read better in source.
|
1979
|
+
*
|
1980
|
+
* @typeParam Type String key specifying the event to extract
|
1981
|
+
*/
|
1982
|
+
declare type ByType_7<Type extends ViewEventType> = Payload_8<Type>;
|
1983
|
+
|
1984
|
+
/**
|
1985
|
+
* Extracts a single event type matching the given key from the {@link WindowEvent} union.
|
1986
|
+
*
|
1987
|
+
* Alias for {@link Payload}, which may read better in source.
|
1988
|
+
*
|
1989
|
+
* @typeParam Type String key specifying the event to extract
|
1990
|
+
*/
|
1991
|
+
declare type ByType_8<Type extends WindowEventType> = Payload_9<Type>;
|
1992
|
+
|
1887
1993
|
/**
|
1888
1994
|
* Configuration for page capture.
|
1889
1995
|
*
|
@@ -2612,7 +2718,9 @@ declare type ChannelDisconnectedEvent = BaseChannelEvent & {
|
|
2612
2718
|
};
|
2613
2719
|
|
2614
2720
|
/**
|
2615
|
-
*
|
2721
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
|
2722
|
+
* discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
|
2723
|
+
* under the {@link OpenFin.ChannelEvents} namespace.
|
2616
2724
|
*/
|
2617
2725
|
declare type ChannelEvent = {
|
2618
2726
|
topic: 'channel';
|
@@ -3155,6 +3263,7 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
|
|
3155
3263
|
* @interface
|
3156
3264
|
*/
|
3157
3265
|
declare type ClosedEvent = IdentityEvent & {
|
3266
|
+
topic: 'application';
|
3158
3267
|
type: 'closed';
|
3159
3268
|
};
|
3160
3269
|
|
@@ -4211,7 +4320,22 @@ declare type CpuInfo = {
|
|
4211
4320
|
* Generated when an application has crashed.
|
4212
4321
|
* @interface
|
4213
4322
|
*/
|
4214
|
-
declare type CrashedEvent =
|
4323
|
+
declare type CrashedEvent = IdentityEvent & {
|
4324
|
+
topic: 'application';
|
4325
|
+
type: 'crashed';
|
4326
|
+
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
4327
|
+
exitCode: number;
|
4328
|
+
details: {
|
4329
|
+
reason: string;
|
4330
|
+
exitCode: number;
|
4331
|
+
};
|
4332
|
+
};
|
4333
|
+
|
4334
|
+
/**
|
4335
|
+
* Generated when a WebContents has crashed.
|
4336
|
+
* @interface
|
4337
|
+
*/
|
4338
|
+
declare type CrashedEvent_2 = NamedEvent & {
|
4215
4339
|
type: 'crashed';
|
4216
4340
|
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
4217
4341
|
exitCode: number;
|
@@ -4357,7 +4481,7 @@ declare interface DesktopAgent_2 {
|
|
4357
4481
|
* Generated when the desktop icon is clicked while it's already running.
|
4358
4482
|
* @interface
|
4359
4483
|
*/
|
4360
|
-
declare type DesktopIconClickedEvent =
|
4484
|
+
declare type DesktopIconClickedEvent = BaseSystemEvent & {
|
4361
4485
|
type: 'desktop-icon-clicked';
|
4362
4486
|
};
|
4363
4487
|
|
@@ -4587,7 +4711,7 @@ declare interface DragSource {}
|
|
4587
4711
|
* Generated when a window has been embedded.
|
4588
4712
|
* @interface
|
4589
4713
|
*/
|
4590
|
-
declare type EmbeddedEvent =
|
4714
|
+
declare type EmbeddedEvent = BaseWindowEvent & {
|
4591
4715
|
type: 'embedded';
|
4592
4716
|
};
|
4593
4717
|
|
@@ -4691,7 +4815,7 @@ declare class EmitterMap {
|
|
4691
4815
|
* Generated when a window ends loading.
|
4692
4816
|
* @interface
|
4693
4817
|
*/
|
4694
|
-
declare type EndLoadEvent =
|
4818
|
+
declare type EndLoadEvent = BaseWindowEvent & {
|
4695
4819
|
type: 'end-load';
|
4696
4820
|
documentName: string;
|
4697
4821
|
isMain: boolean;
|
@@ -5016,7 +5140,7 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
|
|
5016
5140
|
* Generated when an external application has authenticated and is connected.
|
5017
5141
|
* @interface
|
5018
5142
|
*/
|
5019
|
-
declare type ExternalApplicationConnectedEvent =
|
5143
|
+
declare type ExternalApplicationConnectedEvent = BaseExternalApplicationEvent & {
|
5020
5144
|
type: 'connected';
|
5021
5145
|
};
|
5022
5146
|
|
@@ -5024,7 +5148,7 @@ declare type ExternalApplicationConnectedEvent = BaseEvent & {
|
|
5024
5148
|
* Generated when an external application has disconnected.
|
5025
5149
|
* @interface
|
5026
5150
|
*/
|
5027
|
-
declare type ExternalApplicationDisconnectedEvent =
|
5151
|
+
declare type ExternalApplicationDisconnectedEvent = BaseExternalApplicationEvent & {
|
5028
5152
|
type: 'disconnected';
|
5029
5153
|
};
|
5030
5154
|
|
@@ -5033,20 +5157,27 @@ declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
|
|
5033
5157
|
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5034
5158
|
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5035
5159
|
*/
|
5036
|
-
declare type ExternalApplicationEvent =
|
5037
|
-
topic: 'externalapplication';
|
5038
|
-
} & (ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent);
|
5160
|
+
declare type ExternalApplicationEvent = ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent;
|
5039
5161
|
|
5040
5162
|
declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
|
5041
5163
|
|
5042
5164
|
declare namespace ExternalApplicationEvents {
|
5043
5165
|
export {
|
5166
|
+
BaseExternalApplicationEvent,
|
5044
5167
|
ExternalApplicationConnectedEvent,
|
5045
5168
|
ExternalApplicationDisconnectedEvent,
|
5046
|
-
ExternalApplicationEvent
|
5169
|
+
ExternalApplicationEvent,
|
5170
|
+
ExternalApplicationEventType,
|
5171
|
+
Payload_3 as Payload,
|
5172
|
+
ByType_2 as ByType
|
5047
5173
|
}
|
5048
5174
|
}
|
5049
5175
|
|
5176
|
+
/**
|
5177
|
+
* Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
|
5178
|
+
*/
|
5179
|
+
declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
|
5180
|
+
|
5050
5181
|
/**
|
5051
5182
|
* @interface
|
5052
5183
|
*/
|
@@ -5110,7 +5241,7 @@ declare type ExternalConnection = {
|
|
5110
5241
|
* Generated when an external process has exited.
|
5111
5242
|
* @interface
|
5112
5243
|
*/
|
5113
|
-
declare type ExternalProcessExitedEvent =
|
5244
|
+
declare type ExternalProcessExitedEvent = BaseWindowEvent & {
|
5114
5245
|
type: 'external-process-exited';
|
5115
5246
|
processUuid: string;
|
5116
5247
|
exitCode: number;
|
@@ -5155,7 +5286,7 @@ declare type ExternalProcessRequestType = {
|
|
5155
5286
|
* Generated when an external process has started.
|
5156
5287
|
* @interface
|
5157
5288
|
*/
|
5158
|
-
declare type ExternalProcessStartedEvent =
|
5289
|
+
declare type ExternalProcessStartedEvent = BaseWindowEvent & {
|
5159
5290
|
type: 'external-process-started';
|
5160
5291
|
processUuid: string;
|
5161
5292
|
};
|
@@ -5254,7 +5385,7 @@ declare type FileDownloadEvent = {
|
|
5254
5385
|
*
|
5255
5386
|
* @interface
|
5256
5387
|
*/
|
5257
|
-
declare type FileDownloadLocationChangedEvent =
|
5388
|
+
declare type FileDownloadLocationChangedEvent = BaseApplicationEvent & {
|
5258
5389
|
type: 'file-download-location-changed';
|
5259
5390
|
};
|
5260
5391
|
|
@@ -5562,7 +5693,9 @@ declare type FrameDisconnectedEvent = BaseFrameEvent & {
|
|
5562
5693
|
};
|
5563
5694
|
|
5564
5695
|
/**
|
5565
|
-
*
|
5696
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
|
5697
|
+
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
5698
|
+
* under the {@link OpenFin.FrameEvents} namespace.
|
5566
5699
|
*/
|
5567
5700
|
declare type FrameEvent = {
|
5568
5701
|
topic: 'frame';
|
@@ -5576,14 +5709,14 @@ declare namespace FrameEvents {
|
|
5576
5709
|
FrameConnectedEvent,
|
5577
5710
|
FrameDisconnectedEvent,
|
5578
5711
|
FrameEvent,
|
5579
|
-
FrameEventType
|
5712
|
+
FrameEventType,
|
5713
|
+
Payload_4 as Payload,
|
5714
|
+
ByType_3 as ByType
|
5580
5715
|
}
|
5581
5716
|
}
|
5582
5717
|
|
5583
5718
|
/**
|
5584
|
-
*
|
5585
|
-
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
5586
|
-
* under the {@link OpenFin.FrameEvents} namespace.
|
5719
|
+
* Union of possible `type` values for a {@link FrameEvent}.
|
5587
5720
|
*/
|
5588
5721
|
declare type FrameEventType = FrameEvent['type'];
|
5589
5722
|
|
@@ -5820,10 +5953,18 @@ declare namespace GlobalHotkeyEvents {
|
|
5820
5953
|
export {
|
5821
5954
|
RegisteredEvent,
|
5822
5955
|
UnregisteredEvent,
|
5823
|
-
GlobalHotkeyEvent
|
5956
|
+
GlobalHotkeyEvent,
|
5957
|
+
GlobalHotkeyEventType,
|
5958
|
+
Payload_5 as Payload,
|
5959
|
+
ByType_4 as ByType
|
5824
5960
|
}
|
5825
5961
|
}
|
5826
5962
|
|
5963
|
+
/**
|
5964
|
+
* Union of possible `type` values for a {@link GlobalHotkeyEvent}
|
5965
|
+
*/
|
5966
|
+
declare type GlobalHotkeyEventType = GlobalHotkeyEvent['type'];
|
5967
|
+
|
5827
5968
|
declare namespace GoldenLayout {
|
5828
5969
|
export {
|
5829
5970
|
GoldenLayout_2 as GoldenLayout,
|
@@ -6269,7 +6410,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
|
|
6269
6410
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
6270
6411
|
* @interface
|
6271
6412
|
*/
|
6272
|
-
declare type IdleEvent = {
|
6413
|
+
declare type IdleEvent = BaseSystemEvent & {
|
6273
6414
|
type: 'idle-state-changed';
|
6274
6415
|
elapsedTime: number;
|
6275
6416
|
isIdle: boolean;
|
@@ -6355,6 +6496,7 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
6355
6496
|
* @interface
|
6356
6497
|
*/
|
6357
6498
|
declare type InitializedEvent = IdentityEvent & {
|
6499
|
+
topic: 'application';
|
6358
6500
|
type: 'initialized';
|
6359
6501
|
};
|
6360
6502
|
|
@@ -8542,7 +8684,7 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
|
|
8542
8684
|
* Generated when a window and all of its layout's views have either finished or failed navigation.
|
8543
8685
|
* @interface
|
8544
8686
|
*/
|
8545
|
-
declare type LayoutInitializedEvent =
|
8687
|
+
declare type LayoutInitializedEvent = BaseWindowEvent & {
|
8546
8688
|
type: 'layout-initialized';
|
8547
8689
|
ofViews: (OpenFin.Identity & {
|
8548
8690
|
entityType: 'view';
|
@@ -9041,7 +9183,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
9041
9183
|
* Generated when a window and all of its layout's views have been created and can receive API calls.
|
9042
9184
|
* @interface
|
9043
9185
|
*/
|
9044
|
-
declare type LayoutReadyEvent =
|
9186
|
+
declare type LayoutReadyEvent = BaseWindowEvent & {
|
9045
9187
|
type: 'layout-ready';
|
9046
9188
|
views: (OpenFin.Identity & {
|
9047
9189
|
success: boolean;
|
@@ -9176,6 +9318,7 @@ declare type Manifest = {
|
|
9176
9318
|
* @interface
|
9177
9319
|
*/
|
9178
9320
|
declare type ManifestChangedEvent = IdentityEvent & {
|
9321
|
+
topic: 'application';
|
9179
9322
|
type: 'manifest-changed';
|
9180
9323
|
};
|
9181
9324
|
|
@@ -9227,7 +9370,7 @@ declare type MatchPattern = string;
|
|
9227
9370
|
* Generated when a window is maximized.
|
9228
9371
|
* @interface
|
9229
9372
|
*/
|
9230
|
-
declare type MaximizedEvent =
|
9373
|
+
declare type MaximizedEvent = BaseWindowEvent & {
|
9231
9374
|
type: 'maximized';
|
9232
9375
|
};
|
9233
9376
|
|
@@ -9327,7 +9470,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
|
|
9327
9470
|
* Generated when a window is minimized.
|
9328
9471
|
* @interface
|
9329
9472
|
*/
|
9330
|
-
declare type MinimizedEvent =
|
9473
|
+
declare type MinimizedEvent = BaseWindowEvent & {
|
9331
9474
|
type: 'minimized';
|
9332
9475
|
};
|
9333
9476
|
|
@@ -9376,7 +9519,7 @@ declare type MonitorDetails = {
|
|
9376
9519
|
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
9377
9520
|
* @interface
|
9378
9521
|
*/
|
9379
|
-
declare type MonitorEvent = OpenFin.MonitorInfo & {
|
9522
|
+
declare type MonitorEvent = BaseSystemEvent & OpenFin.MonitorInfo & {
|
9380
9523
|
type: 'monitor-info-changed';
|
9381
9524
|
};
|
9382
9525
|
|
@@ -9786,19 +9929,25 @@ declare type NonAppProcessDetails = ProcessDetails & {
|
|
9786
9929
|
};
|
9787
9930
|
|
9788
9931
|
/**
|
9789
|
-
*
|
9932
|
+
* @DEPRECATED All view events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
|
9933
|
+
*
|
9934
|
+
* A view event that does not propagate to (republish on) parent topics.
|
9790
9935
|
*/
|
9791
|
-
declare type NonPropagatedViewEvent =
|
9936
|
+
declare type NonPropagatedViewEvent = never;
|
9792
9937
|
|
9793
9938
|
/**
|
9939
|
+
* @DEPRECATED all webcontents events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
|
9940
|
+
*
|
9794
9941
|
* A WebContents event that does not propagate to (republish on) parent topics.
|
9795
9942
|
*/
|
9796
|
-
declare type NonPropagatedWebContentsEvent =
|
9943
|
+
declare type NonPropagatedWebContentsEvent = never;
|
9797
9944
|
|
9798
9945
|
/**
|
9799
|
-
*
|
9946
|
+
* @DEPRECATED All window events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
|
9947
|
+
*
|
9948
|
+
* A window event that does not propagate to (republish on) parent topics.
|
9800
9949
|
*/
|
9801
|
-
declare type NonPropagatedWindowEvent =
|
9950
|
+
declare type NonPropagatedWindowEvent = never;
|
9802
9951
|
|
9803
9952
|
/**
|
9804
9953
|
* @internal
|
@@ -9810,6 +9959,7 @@ declare type NotRequested<EventType> = EventType extends `${infer U}-requested`
|
|
9810
9959
|
* @interface
|
9811
9960
|
*/
|
9812
9961
|
declare type NotRespondingEvent = IdentityEvent & {
|
9962
|
+
topic: 'application';
|
9813
9963
|
type: 'not-responding';
|
9814
9964
|
};
|
9815
9965
|
|
@@ -10177,13 +10327,85 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10177
10327
|
error?: Success extends false ? ErrorPlainObject | undefined : never;
|
10178
10328
|
};
|
10179
10329
|
|
10330
|
+
/**
|
10331
|
+
* Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
|
10332
|
+
*
|
10333
|
+
* @typeParam Type String key specifying the event to extract
|
10334
|
+
*/
|
10335
|
+
declare type Payload_2<Type extends ApplicationEventType> = Extract<ApplicationEvent, {
|
10336
|
+
type: Type;
|
10337
|
+
}>;
|
10338
|
+
|
10339
|
+
/**
|
10340
|
+
* Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
|
10341
|
+
*
|
10342
|
+
* @typeParam Type String key specifying the event to extract
|
10343
|
+
*/
|
10344
|
+
declare type Payload_3<Type extends ExternalApplicationEventType> = Extract<ExternalApplicationEvent, {
|
10345
|
+
type: Type;
|
10346
|
+
}>;
|
10347
|
+
|
10348
|
+
/**
|
10349
|
+
* Extracts a single event type matching the given key from the {@link FrameEvent} union.
|
10350
|
+
*
|
10351
|
+
* @typeParam Type String key specifying the event to extract
|
10352
|
+
*/
|
10353
|
+
declare type Payload_4<Type extends FrameEventType> = Extract<FrameEvent, {
|
10354
|
+
type: Type;
|
10355
|
+
}>;
|
10356
|
+
|
10357
|
+
/**
|
10358
|
+
* Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
|
10359
|
+
*
|
10360
|
+
* @typeParam Type String key specifying the event to extract
|
10361
|
+
*/
|
10362
|
+
declare type Payload_5<Type extends GlobalHotkeyEventType> = Extract<GlobalHotkeyEvent, {
|
10363
|
+
type: Type;
|
10364
|
+
}>;
|
10365
|
+
|
10366
|
+
/**
|
10367
|
+
* Extracts a single event type matching the given key from the {@link PlatformEvent} union.
|
10368
|
+
*
|
10369
|
+
* @typeParam Type String key specifying the event to extract
|
10370
|
+
*/
|
10371
|
+
declare type Payload_6<Type extends PlatformEventType> = Extract<PlatformEvent, {
|
10372
|
+
type: Type;
|
10373
|
+
}>;
|
10374
|
+
|
10375
|
+
/**
|
10376
|
+
* Extracts a single event type matching the given key from the {@link SystemEvent} union.
|
10377
|
+
*
|
10378
|
+
* @typeParam Type String key specifying the event to extract
|
10379
|
+
*/
|
10380
|
+
declare type Payload_7<Type extends SystemEventType> = Extract<SystemEvent, {
|
10381
|
+
type: Type;
|
10382
|
+
}>;
|
10383
|
+
|
10384
|
+
/**
|
10385
|
+
* Extracts a single event type matching the given key from the {@link ViewEvent} union.
|
10386
|
+
*
|
10387
|
+
* @typeParam Type String key specifying the event to extract
|
10388
|
+
*/
|
10389
|
+
declare type Payload_8<Type extends ViewEventType> = Extract<ViewEvent, {
|
10390
|
+
type: Type;
|
10391
|
+
}>;
|
10392
|
+
|
10393
|
+
/**
|
10394
|
+
* Extracts a single event type matching the given key from the {@link WindowEvent} union.
|
10395
|
+
*
|
10396
|
+
* @typeParam Type String key specifying the event to extract
|
10397
|
+
*/
|
10398
|
+
declare type Payload_9<Type extends WindowEventType> = Extract<WindowEvent, {
|
10399
|
+
type: Type;
|
10400
|
+
}>;
|
10401
|
+
|
10180
10402
|
declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
|
10181
10403
|
|
10182
10404
|
/**
|
10183
10405
|
* Generated when window finishes loading. Provides performance and navigation data.
|
10184
10406
|
* @interface
|
10185
10407
|
*/
|
10186
|
-
declare type PerformanceReportEvent = Performance &
|
10408
|
+
declare type PerformanceReportEvent = Performance & BaseWindowEvent & {
|
10187
10409
|
type: 'performance-report';
|
10188
10410
|
};
|
10189
10411
|
|
@@ -10870,10 +11092,18 @@ declare namespace PlatformEvents {
|
|
10870
11092
|
export {
|
10871
11093
|
PlatformApiReadyEvent,
|
10872
11094
|
PlatformSnapshotAppliedEvent,
|
10873
|
-
PlatformEvent
|
11095
|
+
PlatformEvent,
|
11096
|
+
PlatformEventType,
|
11097
|
+
Payload_6 as Payload,
|
11098
|
+
ByType_5 as ByType
|
10874
11099
|
}
|
10875
11100
|
}
|
10876
11101
|
|
11102
|
+
/**
|
11103
|
+
* Union of possible `type` values for a {@link PlatformEvent}.
|
11104
|
+
*/
|
11105
|
+
declare type PlatformEventType = PlatformEvent['type'];
|
11106
|
+
|
10877
11107
|
/**
|
10878
11108
|
* Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
|
10879
11109
|
*/
|
@@ -11854,7 +12084,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
|
|
11854
12084
|
* A general preload scripts state change event without event type.
|
11855
12085
|
* @interface
|
11856
12086
|
*/
|
11857
|
-
declare type PreloadScriptsStateChangeEvent =
|
12087
|
+
declare type PreloadScriptsStateChangeEvent = BaseWindowEvent & {
|
11858
12088
|
preloadScripts: (PreloadScriptInfoRunning & any)[];
|
11859
12089
|
};
|
11860
12090
|
|
@@ -12063,25 +12293,30 @@ declare type ProcessLoggingOptions = {
|
|
12063
12293
|
};
|
12064
12294
|
|
12065
12295
|
/**
|
12066
|
-
*
|
12296
|
+
* An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
|
12297
|
+
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
12298
|
+
* are propagated to `System` without any type string prefixing.
|
12299
|
+
*
|
12300
|
+
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
12067
12301
|
*/
|
12068
|
-
declare type PropagatedApplicationEvent = PropagatedEvent<'application',
|
12302
|
+
declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
|
12069
12303
|
|
12070
12304
|
/**
|
12071
|
-
*
|
12305
|
+
* Union of possible 'type' values for a {@link OpenFin.ApplicationEvents.PropagatedApplicationEvent}.
|
12072
12306
|
*/
|
12073
|
-
declare type PropagatedApplicationEventType = PropagatedApplicationEvent['type'];
|
12307
|
+
declare type PropagatedApplicationEventType = PropagatedApplicationEvent<string>['type'];
|
12074
12308
|
|
12075
12309
|
/**
|
12076
12310
|
* Modifies an event shape to reflect propagation to a parent topic.
|
12077
12311
|
* @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
|
12078
12312
|
*/
|
12079
|
-
declare type PropagatedEvent<
|
12313
|
+
declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
|
12080
12314
|
type: string;
|
12081
12315
|
}> = Event extends infer E extends {
|
12082
12316
|
type: string;
|
12083
|
-
} ? Omit<E, 'type'> & {
|
12084
|
-
type: PropagatedEventType<
|
12317
|
+
} ? Omit<E, 'type' | 'topic'> & {
|
12318
|
+
type: PropagatedEventType<SourceTopic, E['type']>;
|
12319
|
+
topic: TargetTopic;
|
12085
12320
|
} : never;
|
12086
12321
|
|
12087
12322
|
/**
|
@@ -12090,29 +12325,33 @@ declare type PropagatedEvent<Topic extends string, Event extends {
|
|
12090
12325
|
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
|
12091
12326
|
|
12092
12327
|
/**
|
12093
|
-
* A
|
12094
|
-
|
12095
|
-
|
12096
|
-
|
12097
|
-
/**
|
12098
|
-
* A propagated View event.
|
12328
|
+
* A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
|
12329
|
+
* or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
|
12330
|
+
* event type key with `'view-'`.
|
12099
12331
|
*/
|
12100
|
-
declare type PropagatedViewEvent = PropagatedEvent<'view',
|
12332
|
+
declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
|
12333
|
+
viewIdentity: OpenFin.Identity;
|
12334
|
+
};
|
12101
12335
|
|
12102
12336
|
/**
|
12103
|
-
*
|
12337
|
+
* Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
|
12104
12338
|
*/
|
12105
|
-
declare type PropagatedViewEventType = PropagatedViewEvent['type'];
|
12339
|
+
declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
12106
12340
|
|
12107
12341
|
/**
|
12108
|
-
* A propagated
|
12342
|
+
* A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
|
12343
|
+
* prefixing the type string with `'window-'`. Only {@link NativeWindowEvent native window events} will propagate
|
12344
|
+
* this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
|
12345
|
+
* will *not* re-propagate.
|
12346
|
+
*
|
12347
|
+
* "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
|
12109
12348
|
*/
|
12110
|
-
declare type PropagatedWindowEvent = PropagatedEvent<'window', Exclude<
|
12349
|
+
declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent<'window', TargetTopic, Exclude<WindowSourcedEvent, WindowCloseRequestedEvent>>;
|
12111
12350
|
|
12112
12351
|
/**
|
12113
|
-
*
|
12352
|
+
* Union of possible `type` values for a {@link OpenFin.WindowEvents.PropagatedWindowEvent}.
|
12114
12353
|
*/
|
12115
|
-
declare type PropagatedWindowEventType = PropagatedWindowEvent['type'];
|
12354
|
+
declare type PropagatedWindowEventType = PropagatedWindowEvent<string>['type'];
|
12116
12355
|
|
12117
12356
|
declare interface ProtocolMap extends ProtocolMapBase {
|
12118
12357
|
'request-external-authorization': {
|
@@ -12519,7 +12758,7 @@ declare type RegistryInfo_2 = {
|
|
12519
12758
|
* Generated when a window has been reloaded.
|
12520
12759
|
* @interface
|
12521
12760
|
*/
|
12522
|
-
declare type ReloadedEvent =
|
12761
|
+
declare type ReloadedEvent = BaseWindowEvent & {
|
12523
12762
|
type: 'reloaded';
|
12524
12763
|
url: string;
|
12525
12764
|
};
|
@@ -12641,6 +12880,7 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
|
|
12641
12880
|
* @interface
|
12642
12881
|
*/
|
12643
12882
|
declare type RespondingEvent = IdentityEvent & {
|
12883
|
+
topic: 'application';
|
12644
12884
|
type: 'responding';
|
12645
12885
|
};
|
12646
12886
|
|
@@ -12707,6 +12947,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
|
|
12707
12947
|
* @interface
|
12708
12948
|
*/
|
12709
12949
|
declare type RunRequestedEvent_2 = IdentityEvent & {
|
12950
|
+
topic: 'application';
|
12710
12951
|
type: 'run-requested';
|
12711
12952
|
userAppConfigArgs: Record<string, any>;
|
12712
12953
|
manifest: OpenFin.Manifest;
|
@@ -12887,7 +13128,7 @@ declare type ServiceIdentifier = {
|
|
12887
13128
|
* Generated on changes to a user’s local computer session.
|
12888
13129
|
* @interface
|
12889
13130
|
*/
|
12890
|
-
declare type SessionChangedEvent = {
|
13131
|
+
declare type SessionChangedEvent = BaseSystemEvent & {
|
12891
13132
|
type: 'session-changed';
|
12892
13133
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
12893
13134
|
};
|
@@ -13298,6 +13539,7 @@ declare type SplitterItem = GoldenLayout.ContentItem & {
|
|
13298
13539
|
* @interface
|
13299
13540
|
*/
|
13300
13541
|
declare type StartedEvent = IdentityEvent & {
|
13542
|
+
topic: 'application';
|
13301
13543
|
type: 'started';
|
13302
13544
|
};
|
13303
13545
|
|
@@ -14773,9 +15015,7 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
|
|
14773
15015
|
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
14774
15016
|
* from which they propagate).
|
14775
15017
|
*/
|
14776
|
-
declare type SystemEvent =
|
14777
|
-
topic: 'system';
|
14778
|
-
} & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent);
|
15018
|
+
declare type SystemEvent = ExcludeRequested<PropagatedWindowEvent<'system'>> | PropagatedViewEvent<'system'> | PropagatedApplicationEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
14779
15019
|
|
14780
15020
|
declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
|
14781
15021
|
|
@@ -14783,6 +15023,7 @@ declare namespace SystemEvents {
|
|
14783
15023
|
export {
|
14784
15024
|
NotRequested,
|
14785
15025
|
ExcludeRequested,
|
15026
|
+
BaseSystemEvent,
|
14786
15027
|
IdleEvent,
|
14787
15028
|
MonitorEvent,
|
14788
15029
|
SessionChangedEvent,
|
@@ -14798,12 +15039,14 @@ declare namespace SystemEvents {
|
|
14798
15039
|
DesktopIconClickedEvent,
|
14799
15040
|
SystemShutdownEvent,
|
14800
15041
|
SystemEvent,
|
14801
|
-
SystemEventType
|
15042
|
+
SystemEventType,
|
15043
|
+
Payload_7 as Payload,
|
15044
|
+
ByType_6 as ByType
|
14802
15045
|
}
|
14803
15046
|
}
|
14804
15047
|
|
14805
15048
|
/**
|
14806
|
-
*
|
15049
|
+
* Union of possible `type` values for a {@link SystemEvent}.
|
14807
15050
|
*/
|
14808
15051
|
declare type SystemEventType = SystemEvent['type'];
|
14809
15052
|
|
@@ -14850,7 +15093,7 @@ declare type SystemProcessInfo = {
|
|
14850
15093
|
* Generated when system shutdown or log off.
|
14851
15094
|
* @internal
|
14852
15095
|
*/
|
14853
|
-
declare type SystemShutdownEvent =
|
15096
|
+
declare type SystemShutdownEvent = BaseSystemEvent & {
|
14854
15097
|
type: 'system-shutdown';
|
14855
15098
|
};
|
14856
15099
|
|
@@ -15307,6 +15550,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
15307
15550
|
* @interface
|
15308
15551
|
*/
|
15309
15552
|
declare type TrayIconClickedEvent = IdentityEvent & {
|
15553
|
+
topic: 'application';
|
15310
15554
|
type: 'tray-icon-clicked';
|
15311
15555
|
button: 0 | 1 | 2;
|
15312
15556
|
bounds: OpenFin.Rectangle;
|
@@ -15395,7 +15639,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
15395
15639
|
* A general user bounds change event without event type.
|
15396
15640
|
* @interface
|
15397
15641
|
*/
|
15398
|
-
declare type UserBoundsChangeEvent =
|
15642
|
+
declare type UserBoundsChangeEvent = BaseWindowEvent & {
|
15399
15643
|
height: number;
|
15400
15644
|
left: number;
|
15401
15645
|
top: number;
|
@@ -15407,7 +15651,7 @@ declare type UserBoundsChangeEvent = NamedEvent & {
|
|
15407
15651
|
* Generated when a window's user movement becomes disabled.
|
15408
15652
|
* @interface
|
15409
15653
|
*/
|
15410
|
-
declare type UserMovementDisabledEvent =
|
15654
|
+
declare type UserMovementDisabledEvent = BaseWindowEvent & {
|
15411
15655
|
type: 'user-movement-disabled';
|
15412
15656
|
};
|
15413
15657
|
|
@@ -15415,7 +15659,7 @@ declare type UserMovementDisabledEvent = NamedEvent & {
|
|
15415
15659
|
* Generated when a window's user movement becomes enabled.
|
15416
15660
|
* @interface
|
15417
15661
|
*/
|
15418
|
-
declare type UserMovementEnabledEvent =
|
15662
|
+
declare type UserMovementEnabledEvent = BaseWindowEvent & {
|
15419
15663
|
type: 'user-movement-enabled';
|
15420
15664
|
};
|
15421
15665
|
|
@@ -16102,6 +16346,16 @@ declare type View_3 = OpenFin.View;
|
|
16102
16346
|
|
16103
16347
|
declare type View_4 = OpenFin.View;
|
16104
16348
|
|
16349
|
+
/**
|
16350
|
+
* Generated when a View is attached to a window.
|
16351
|
+
* @interface
|
16352
|
+
*/
|
16353
|
+
declare type ViewAttachedEvent = BaseWindowEvent & {
|
16354
|
+
type: 'view-attached';
|
16355
|
+
target: OpenFin.Identity;
|
16356
|
+
viewIdentity: OpenFin.Identity;
|
16357
|
+
};
|
16358
|
+
|
16105
16359
|
declare interface ViewComponent extends GoldenLayout.ContentItem {
|
16106
16360
|
componentState: OpenFin.ViewState;
|
16107
16361
|
}
|
@@ -16126,9 +16380,11 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
|
|
16126
16380
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
16127
16381
|
* @interface
|
16128
16382
|
*/
|
16129
|
-
declare type ViewDetachedEvent =
|
16383
|
+
declare type ViewDetachedEvent = BaseWindowEvent & {
|
16130
16384
|
type: 'view-detached';
|
16385
|
+
target: OpenFin.Identity;
|
16131
16386
|
previousTarget: OpenFin.Identity;
|
16387
|
+
viewIdentity: OpenFin.Identity;
|
16132
16388
|
};
|
16133
16389
|
|
16134
16390
|
/**
|
@@ -16136,9 +16392,9 @@ declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
|
|
16136
16392
|
* discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
|
16137
16393
|
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
16138
16394
|
*/
|
16139
|
-
declare type ViewEvent = {
|
16140
|
-
|
16141
|
-
}
|
16395
|
+
declare type ViewEvent = (WebContentsEvent<'view'> & {
|
16396
|
+
target: OpenFin.Identity;
|
16397
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
|
16142
16398
|
|
16143
16399
|
declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
|
16144
16400
|
|
@@ -16147,22 +16403,23 @@ declare namespace ViewEvents {
|
|
16147
16403
|
BaseViewEvent,
|
16148
16404
|
TargetChangedEvent,
|
16149
16405
|
NonPropagatedViewEvent,
|
16150
|
-
AttachedEvent,
|
16151
16406
|
CreatedEvent,
|
16152
16407
|
DestroyedEvent,
|
16153
16408
|
HiddenEvent,
|
16154
16409
|
HotkeyEvent,
|
16155
16410
|
ShownEvent,
|
16156
|
-
WillPropagateViewEvent,
|
16157
16411
|
ViewEvent,
|
16412
|
+
WillPropagateViewEvent,
|
16158
16413
|
ViewEventType,
|
16159
16414
|
PropagatedViewEvent,
|
16160
|
-
PropagatedViewEventType
|
16415
|
+
PropagatedViewEventType,
|
16416
|
+
Payload_8 as Payload,
|
16417
|
+
ByType_7 as ByType
|
16161
16418
|
}
|
16162
16419
|
}
|
16163
16420
|
|
16164
16421
|
/**
|
16165
|
-
*
|
16422
|
+
* Union of possible `type` values for a {@link OpenFin.ViewEvents.ViewEvent}.
|
16166
16423
|
*/
|
16167
16424
|
declare type ViewEventType = ViewEvent['type'];
|
16168
16425
|
|
@@ -17337,17 +17594,21 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
17337
17594
|
}
|
17338
17595
|
|
17339
17596
|
/**
|
17340
|
-
*
|
17597
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
17598
|
+
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
17341
17599
|
*/
|
17342
|
-
declare type WebContentsEvent
|
17600
|
+
declare type WebContentsEvent<Topic extends string> = {
|
17601
|
+
topic: Topic;
|
17602
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
17343
17603
|
|
17344
|
-
declare type WebContentsEvent_2 = Events.WebContentsEvents.WebContentsEvent
|
17604
|
+
declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
|
17345
17605
|
|
17346
17606
|
declare namespace WebContentsEvents {
|
17347
17607
|
export {
|
17348
17608
|
ResourceLoadFailedEvent,
|
17349
17609
|
ResourceResponseReceivedEvent,
|
17350
17610
|
PageTitleUpdatedEvent,
|
17611
|
+
CrashedEvent_2 as CrashedEvent,
|
17351
17612
|
CertificateErrorEvent,
|
17352
17613
|
CertificateSelectionShownEvent,
|
17353
17614
|
FaviconUpdatedEvent,
|
@@ -17368,9 +17629,9 @@ declare namespace WebContentsEvents {
|
|
17368
17629
|
FileDownloadStartedEvent,
|
17369
17630
|
FileDownloadProgressEvent,
|
17370
17631
|
FileDownloadCompletedEvent,
|
17632
|
+
WebContentsEvent,
|
17371
17633
|
WillPropagateWebContentsEvent,
|
17372
|
-
NonPropagatedWebContentsEvent
|
17373
|
-
WebContentsEvent
|
17634
|
+
NonPropagatedWebContentsEvent
|
17374
17635
|
}
|
17375
17636
|
}
|
17376
17637
|
|
@@ -17413,7 +17674,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
17413
17674
|
* A general will-move or will-resize event without event type.
|
17414
17675
|
* @interface
|
17415
17676
|
*/
|
17416
|
-
declare type WillMoveOrResizeEvent =
|
17677
|
+
declare type WillMoveOrResizeEvent = BaseWindowEvent & {
|
17417
17678
|
height: number;
|
17418
17679
|
left: number;
|
17419
17680
|
top: number;
|
@@ -17422,30 +17683,34 @@ declare type WillMoveOrResizeEvent = NamedEvent & {
|
|
17422
17683
|
};
|
17423
17684
|
|
17424
17685
|
/**
|
17425
|
-
*
|
17426
|
-
|
17427
|
-
|
17428
|
-
|
17429
|
-
/**
|
17686
|
+
* @DEPRECATED all View events propagate, so this is redundant - left as a convenience shim to avoid breaking
|
17687
|
+
* user code
|
17688
|
+
*
|
17430
17689
|
* A View event that does propagate to (republish on) parent topics.
|
17431
17690
|
*/
|
17432
|
-
declare type WillPropagateViewEvent =
|
17691
|
+
declare type WillPropagateViewEvent = ViewEvent;
|
17433
17692
|
|
17434
17693
|
/**
|
17694
|
+
* @DEPRECATED all webcontents events propagate, so this is redundant - left as a convenience shim to avoid breaking
|
17695
|
+
* user code
|
17696
|
+
*
|
17435
17697
|
* A WebContents event that does propagate to (republish on) parent topics.
|
17436
17698
|
*/
|
17437
|
-
declare type WillPropagateWebContentsEvent =
|
17699
|
+
declare type WillPropagateWebContentsEvent = WebContentsEvent<string>;
|
17438
17700
|
|
17439
17701
|
/**
|
17702
|
+
* @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
|
17703
|
+
* user code
|
17704
|
+
*
|
17440
17705
|
* A Window event that does propagate to (republish on) parent topics.
|
17441
17706
|
*/
|
17442
|
-
declare type WillPropagateWindowEvent =
|
17707
|
+
declare type WillPropagateWindowEvent = WindowSourcedEvent;
|
17443
17708
|
|
17444
17709
|
/**
|
17445
17710
|
* Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
|
17446
17711
|
* @interface
|
17447
17712
|
*/
|
17448
|
-
declare type WillRedirectEvent =
|
17713
|
+
declare type WillRedirectEvent = BaseWindowEvent & {
|
17449
17714
|
type: 'will-redirect';
|
17450
17715
|
blocked: boolean;
|
17451
17716
|
isInPlace: boolean;
|
@@ -19070,7 +19335,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19070
19335
|
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
19071
19336
|
* @interface
|
19072
19337
|
*/
|
19073
|
-
declare type WindowAlertRequestedEvent =
|
19338
|
+
declare type WindowAlertRequestedEvent = BaseApplicationEvent & {
|
19074
19339
|
type: 'window-alert-requested';
|
19075
19340
|
};
|
19076
19341
|
|
@@ -19087,7 +19352,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19087
19352
|
* Generated when a window has closed.
|
19088
19353
|
* @interface
|
19089
19354
|
*/
|
19090
|
-
declare type WindowClosedEvent =
|
19355
|
+
declare type WindowClosedEvent = BaseWindowEvent & {
|
19091
19356
|
type: 'closed';
|
19092
19357
|
};
|
19093
19358
|
|
@@ -19096,7 +19361,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19096
19361
|
* @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.
|
19097
19362
|
* @interface
|
19098
19363
|
*/
|
19099
|
-
declare type WindowCloseRequestedEvent =
|
19364
|
+
declare type WindowCloseRequestedEvent = BaseWindowEvent & {
|
19100
19365
|
type: 'close-requested';
|
19101
19366
|
};
|
19102
19367
|
|
@@ -19104,7 +19369,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19104
19369
|
* Generated when a window has initiated the closing routine.
|
19105
19370
|
* @interface
|
19106
19371
|
*/
|
19107
|
-
declare type WindowClosingEvent =
|
19372
|
+
declare type WindowClosingEvent = BaseWindowEvent & {
|
19108
19373
|
type: 'closing';
|
19109
19374
|
};
|
19110
19375
|
|
@@ -19112,7 +19377,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19112
19377
|
* Generated when a child window is created.
|
19113
19378
|
* @interface
|
19114
19379
|
*/
|
19115
|
-
declare type WindowCreatedEvent =
|
19380
|
+
declare type WindowCreatedEvent = BaseApplicationEvent & {
|
19116
19381
|
type: 'window-created';
|
19117
19382
|
};
|
19118
19383
|
|
@@ -19169,7 +19434,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19169
19434
|
* Generated when a child window ends loading.
|
19170
19435
|
* @interface
|
19171
19436
|
*/
|
19172
|
-
declare type WindowEndLoadEvent =
|
19437
|
+
declare type WindowEndLoadEvent = BaseApplicationEvent & {
|
19173
19438
|
type: 'window-end-load';
|
19174
19439
|
};
|
19175
19440
|
|
@@ -19178,14 +19443,16 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19178
19443
|
* discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
|
19179
19444
|
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
19180
19445
|
*/
|
19181
|
-
declare type WindowEvent =
|
19182
|
-
topic: 'window';
|
19183
|
-
} & (WillPropagateWindowEvent | NonPropagatedWindowEvent | PropagatedViewEvent);
|
19446
|
+
declare type WindowEvent = WindowSourcedEvent | PropagatedViewEvent<'window'>;
|
19184
19447
|
|
19185
19448
|
declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
|
19186
19449
|
|
19187
19450
|
declare namespace WindowEvents {
|
19188
19451
|
export {
|
19452
|
+
BaseWindowEvent,
|
19453
|
+
ViewAttachedEvent,
|
19454
|
+
ViewDetachedEvent,
|
19455
|
+
WindowViewEvent,
|
19189
19456
|
AlertRequestedEvent,
|
19190
19457
|
AuthRequestedEvent,
|
19191
19458
|
EndLoadEvent,
|
@@ -19202,11 +19469,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19202
19469
|
BoundsChangeEvent,
|
19203
19470
|
WillMoveOrResizeEvent,
|
19204
19471
|
PerformanceReportEvent,
|
19205
|
-
ViewDetachedEvent,
|
19206
19472
|
InputEvent_2 as InputEvent,
|
19207
19473
|
LayoutInitializedEvent,
|
19208
19474
|
LayoutReadyEvent,
|
19209
|
-
NonPropagatedWindowEvent,
|
19210
19475
|
BeginUserBoundsChangingEvent,
|
19211
19476
|
BoundsChangedEvent,
|
19212
19477
|
BoundsChangingEvent,
|
@@ -19230,17 +19495,20 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19230
19495
|
UserMovementDisabledEvent,
|
19231
19496
|
WillMoveEvent,
|
19232
19497
|
WillResizeEvent,
|
19233
|
-
|
19498
|
+
NonPropagatedWindowEvent,
|
19499
|
+
WindowSourcedEvent,
|
19234
19500
|
WillPropagateWindowEvent,
|
19235
19501
|
WindowEvent,
|
19236
19502
|
WindowEventType,
|
19237
19503
|
PropagatedWindowEvent,
|
19238
|
-
PropagatedWindowEventType
|
19504
|
+
PropagatedWindowEventType,
|
19505
|
+
Payload_9 as Payload,
|
19506
|
+
ByType_8 as ByType
|
19239
19507
|
}
|
19240
19508
|
}
|
19241
19509
|
|
19242
19510
|
/**
|
19243
|
-
*
|
19511
|
+
* Union of possible `type` values for a {@link OpenFin.WindowEvents.WindowEvent}.
|
19244
19512
|
*/
|
19245
19513
|
declare type WindowEventType = WindowEvent['type'];
|
19246
19514
|
|
@@ -19248,7 +19516,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19248
19516
|
* Generated when a window has been hidden.
|
19249
19517
|
* @interface
|
19250
19518
|
*/
|
19251
|
-
declare type WindowHiddenEvent =
|
19519
|
+
declare type WindowHiddenEvent = BaseWindowEvent & {
|
19252
19520
|
type: 'hidden';
|
19253
19521
|
reason: 'closing' | 'hide' | 'hide-on-close';
|
19254
19522
|
};
|
@@ -19258,7 +19526,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19258
19526
|
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
19259
19527
|
* @interface
|
19260
19528
|
*/
|
19261
|
-
declare type WindowHotkeyEvent = InputEvent_2 &
|
19529
|
+
declare type WindowHotkeyEvent = InputEvent_2 & BaseWindowEvent & {
|
19262
19530
|
type: 'hotkey';
|
19263
19531
|
};
|
19264
19532
|
|
@@ -19277,7 +19545,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19277
19545
|
* Generated when a window is initialized.
|
19278
19546
|
* @interface
|
19279
19547
|
*/
|
19280
|
-
declare type WindowInitializedEvent =
|
19548
|
+
declare type WindowInitializedEvent = BaseWindowEvent & {
|
19281
19549
|
type: 'initialized';
|
19282
19550
|
};
|
19283
19551
|
|
@@ -19376,7 +19644,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19376
19644
|
* Generated when a child window is not responding.
|
19377
19645
|
* @interface
|
19378
19646
|
*/
|
19379
|
-
declare type WindowNotRespondingEvent =
|
19647
|
+
declare type WindowNotRespondingEvent = BaseApplicationEvent & {
|
19380
19648
|
type: 'window-not-responding';
|
19381
19649
|
};
|
19382
19650
|
|
@@ -19402,7 +19670,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19402
19670
|
* @remarks Will not fire if the diff object is empty.
|
19403
19671
|
* @interface
|
19404
19672
|
*/
|
19405
|
-
declare type WindowOptionsChangedEvent_2 =
|
19673
|
+
declare type WindowOptionsChangedEvent_2 = BaseWindowEvent & {
|
19406
19674
|
type: 'options-changed';
|
19407
19675
|
options: OpenFin.WindowOptions;
|
19408
19676
|
diff: OpenFin.WindowOptionDiff;
|
@@ -19414,7 +19682,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19414
19682
|
* Generated when a child window is responding.
|
19415
19683
|
* @interface
|
19416
19684
|
*/
|
19417
|
-
declare type WindowRespondingEvent =
|
19685
|
+
declare type WindowRespondingEvent = BaseApplicationEvent & {
|
19418
19686
|
type: 'window-responding';
|
19419
19687
|
};
|
19420
19688
|
|
@@ -19422,7 +19690,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19422
19690
|
* Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
19423
19691
|
* @interface
|
19424
19692
|
*/
|
19425
|
-
declare type WindowRestoredEvent =
|
19693
|
+
declare type WindowRestoredEvent = BaseWindowEvent & {
|
19426
19694
|
type: 'restored';
|
19427
19695
|
};
|
19428
19696
|
|
@@ -19430,7 +19698,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19430
19698
|
* Generated when a hidden window has been shown.
|
19431
19699
|
* @interface
|
19432
19700
|
*/
|
19433
|
-
declare type WindowShownEvent =
|
19701
|
+
declare type WindowShownEvent = BaseWindowEvent & {
|
19434
19702
|
type: 'shown';
|
19435
19703
|
};
|
19436
19704
|
|
@@ -19439,15 +19707,21 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19439
19707
|
* @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.
|
19440
19708
|
* @interface
|
19441
19709
|
*/
|
19442
|
-
declare type WindowShowRequestedEvent =
|
19710
|
+
declare type WindowShowRequestedEvent = BaseWindowEvent & {
|
19443
19711
|
type: 'show-requested';
|
19444
19712
|
};
|
19445
19713
|
|
19714
|
+
/**
|
19715
|
+
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
19716
|
+
* from {@link OpenFin.ViewEvents}.
|
19717
|
+
*/
|
19718
|
+
declare type WindowSourcedEvent = WebContentsEvent<'window'> | WindowViewEvent | 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;
|
19719
|
+
|
19446
19720
|
/**
|
19447
19721
|
* Generated when a child window starts loading.
|
19448
19722
|
* @interface
|
19449
19723
|
*/
|
19450
|
-
declare type WindowStartLoadEvent =
|
19724
|
+
declare type WindowStartLoadEvent = BaseApplicationEvent & {
|
19451
19725
|
type: 'window-start-load';
|
19452
19726
|
};
|
19453
19727
|
|
@@ -19456,6 +19730,14 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19456
19730
|
*/
|
19457
19731
|
declare type WindowState = 'maximized' | 'minimized' | 'normal';
|
19458
19732
|
|
19733
|
+
/**
|
19734
|
+
* A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
|
19735
|
+
* to the `Application` level, with the name pattern `window-view-eventname`.
|
19736
|
+
*/
|
19737
|
+
declare type WindowViewEvent = {
|
19738
|
+
viewIdentity: OpenFin.Identity;
|
19739
|
+
} & (ViewAttachedEvent | ViewDetachedEvent);
|
19740
|
+
|
19459
19741
|
/**
|
19460
19742
|
* @interface
|
19461
19743
|
*/
|