@openfin/node-adapter 34.78.52 → 35.78.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/node-adapter-alpha.d.ts +358 -647
- package/out/node-adapter-beta.d.ts +358 -647
- package/out/node-adapter-public.d.ts +358 -647
- package/out/node-adapter.d.ts +363 -664
- package/out/node-adapter.js +0 -12
- package/package.json +1 -1
package/out/node-adapter.d.ts
CHANGED
@@ -64,7 +64,7 @@ declare type AddViewToStackOptions = {
|
|
64
64
|
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
65
65
|
* @interface
|
66
66
|
*/
|
67
|
-
declare type AlertRequestedEvent =
|
67
|
+
declare type AlertRequestedEvent = BaseWindowEvent & {
|
68
68
|
type: 'alert-requested';
|
69
69
|
message: string;
|
70
70
|
url: string;
|
@@ -105,15 +105,6 @@ declare type ApiClient<T extends Record<any, any>> = {
|
|
105
105
|
[key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
|
106
106
|
};
|
107
107
|
|
108
|
-
/**
|
109
|
-
* Generated when a new Platform's API becomes responsive.
|
110
|
-
* @interface
|
111
|
-
*/
|
112
|
-
declare type ApiReadyEvent = BaseEvent & {
|
113
|
-
topic: 'application';
|
114
|
-
type: 'platform-api-ready';
|
115
|
-
};
|
116
|
-
|
117
108
|
/**
|
118
109
|
* @interface
|
119
110
|
*/
|
@@ -871,15 +862,19 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
|
|
871
862
|
}
|
872
863
|
|
873
864
|
/**
|
874
|
-
*
|
865
|
+
* Generated when an application has authenticated and is connected.
|
866
|
+
* @interface
|
875
867
|
*/
|
876
|
-
declare type ApplicationConnectedEvent =
|
868
|
+
declare type ApplicationConnectedEvent = IdentityEvent & {
|
869
|
+
topic: 'application';
|
870
|
+
type: 'connected';
|
871
|
+
};
|
877
872
|
|
878
873
|
/**
|
879
874
|
* Generated when an application is created.
|
880
875
|
* @interface
|
881
876
|
*/
|
882
|
-
declare type ApplicationCreatedEvent =
|
877
|
+
declare type ApplicationCreatedEvent = BaseSystemEvent & IdentityEvent & {
|
883
878
|
type: 'application-created';
|
884
879
|
};
|
885
880
|
|
@@ -903,15 +898,17 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
|
|
903
898
|
};
|
904
899
|
|
905
900
|
/**
|
906
|
-
*
|
901
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
|
902
|
+
* discriminated by {@link ApplicationEvent.type | their type}. Event payloads unique to `Application` can be found
|
903
|
+
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
904
|
+
* from which they propagate).
|
907
905
|
*/
|
908
|
-
declare type ApplicationEvent =
|
906
|
+
declare type ApplicationEvent = PropagatedViewEvent<'application'> | PropagatedWindowEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
|
909
907
|
|
910
908
|
declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
|
911
909
|
|
912
910
|
declare namespace ApplicationEvents {
|
913
911
|
export {
|
914
|
-
BaseEvent_3 as BaseEvent,
|
915
912
|
BaseApplicationEvent,
|
916
913
|
CrashedEvent,
|
917
914
|
FileDownloadLocationChangedEvent,
|
@@ -924,9 +921,7 @@ declare namespace ApplicationEvents {
|
|
924
921
|
WindowRespondingEvent,
|
925
922
|
WindowStartLoadEvent,
|
926
923
|
ApplicationWindowEvent,
|
927
|
-
ApplicationWindowEventTypes,
|
928
924
|
ClosedEvent,
|
929
|
-
ConnectedEvent_2 as ConnectedEvent,
|
930
925
|
ApplicationConnectedEvent,
|
931
926
|
InitializedEvent,
|
932
927
|
ManifestChangedEvent,
|
@@ -934,23 +929,19 @@ declare namespace ApplicationEvents {
|
|
934
929
|
RespondingEvent,
|
935
930
|
StartedEvent,
|
936
931
|
ApplicationSourcedEvent,
|
937
|
-
Event_3 as Event,
|
938
932
|
ApplicationEvent,
|
939
|
-
EventType_3 as EventType,
|
940
933
|
ApplicationEventType,
|
941
|
-
PropagatedEvent_4 as PropagatedEvent,
|
942
934
|
PropagatedApplicationEvent,
|
943
|
-
PropagatedEventType_3 as PropagatedEventType,
|
944
935
|
PropagatedApplicationEventType,
|
945
|
-
|
946
|
-
|
936
|
+
Payload_2 as Payload,
|
937
|
+
ByType
|
947
938
|
}
|
948
939
|
}
|
949
940
|
|
950
941
|
/**
|
951
|
-
*
|
942
|
+
* Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
|
952
943
|
*/
|
953
|
-
declare type ApplicationEventType =
|
944
|
+
declare type ApplicationEventType = ApplicationEvent['type'];
|
954
945
|
|
955
946
|
declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
|
956
947
|
|
@@ -1303,8 +1294,9 @@ declare type ApplicationPermissions = {
|
|
1303
1294
|
* A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
|
1304
1295
|
* from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
|
1305
1296
|
* does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
|
1297
|
+
*
|
1306
1298
|
*/
|
1307
|
-
declare type ApplicationSourcedEvent = ClosedEvent |
|
1299
|
+
declare type ApplicationSourcedEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
1308
1300
|
|
1309
1301
|
declare type ApplicationState = OpenFin.ApplicationState;
|
1310
1302
|
|
@@ -1343,11 +1335,6 @@ declare type ApplicationType = {
|
|
1343
1335
|
*/
|
1344
1336
|
declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
|
1345
1337
|
|
1346
|
-
/**
|
1347
|
-
* Array of valid `type` values for an {@link ApplicationWindowEvent}.
|
1348
|
-
*/
|
1349
|
-
declare const ApplicationWindowEventTypes: readonly ["window-alert-requested", "window-created", "window-end-load", "window-not-responding", "window-responding", "window-start-load"];
|
1350
|
-
|
1351
1338
|
declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
|
1352
1339
|
|
1353
1340
|
/**
|
@@ -1625,7 +1612,7 @@ declare interface AuthorizationPayload {
|
|
1625
1612
|
* ```
|
1626
1613
|
* @interface
|
1627
1614
|
*/
|
1628
|
-
declare type AuthRequestedEvent =
|
1615
|
+
declare type AuthRequestedEvent = BaseWindowEvent & {
|
1629
1616
|
type: 'auth-requested';
|
1630
1617
|
authInfo: {
|
1631
1618
|
host: string;
|
@@ -1693,9 +1680,21 @@ declare class Base {
|
|
1693
1680
|
}
|
1694
1681
|
|
1695
1682
|
/**
|
1696
|
-
*
|
1683
|
+
* Base type for events emitting on the `application` topic
|
1684
|
+
* @interface
|
1697
1685
|
*/
|
1698
|
-
declare type BaseApplicationEvent =
|
1686
|
+
declare type BaseApplicationEvent = NamedEvent & {
|
1687
|
+
topic: `application`;
|
1688
|
+
};
|
1689
|
+
|
1690
|
+
/**
|
1691
|
+
* A base Channel event.
|
1692
|
+
* @interface
|
1693
|
+
*/
|
1694
|
+
declare type BaseChannelEvent = NamedEvent & {
|
1695
|
+
channelName: string;
|
1696
|
+
channelId: string;
|
1697
|
+
};
|
1699
1698
|
|
1700
1699
|
/**
|
1701
1700
|
* @interface
|
@@ -1764,70 +1763,10 @@ declare type BaseEvent = {
|
|
1764
1763
|
type: string;
|
1765
1764
|
};
|
1766
1765
|
|
1767
|
-
|
1768
|
-
* A base Channel event.
|
1769
|
-
* @interface
|
1770
|
-
*/
|
1771
|
-
declare type BaseEvent_2 = NamedEvent & {
|
1772
|
-
channelName: string;
|
1773
|
-
channelId: string;
|
1774
|
-
};
|
1775
|
-
|
1776
|
-
/**
|
1777
|
-
* Base type for events emitting on the `application` topic
|
1778
|
-
* @interface
|
1779
|
-
*/
|
1780
|
-
declare type BaseEvent_3 = BaseEvents.NamedEvent & {
|
1781
|
-
topic: `application`;
|
1782
|
-
};
|
1783
|
-
|
1784
|
-
/**
|
1785
|
-
* Base type for events emitting on the `view` topic
|
1786
|
-
* @interface
|
1787
|
-
*/
|
1788
|
-
declare type BaseEvent_4 = BaseEvents.NamedEvent & {
|
1789
|
-
topic: 'view';
|
1790
|
-
target: OpenFin.Identity;
|
1791
|
-
};
|
1792
|
-
|
1793
|
-
/**
|
1794
|
-
* Base type for events emitting on the `window` topic
|
1795
|
-
* @interface
|
1796
|
-
*/
|
1797
|
-
declare type BaseEvent_5 = BaseEvents.NamedEvent & {
|
1798
|
-
topic: 'window';
|
1799
|
-
};
|
1800
|
-
|
1801
|
-
/**
|
1802
|
-
* Base type for events emitting on the `externalapplication` topic
|
1803
|
-
* @interface
|
1804
|
-
*/
|
1805
|
-
declare type BaseEvent_6 = BaseEvents.BaseEvent & {
|
1806
|
-
topic: 'externalapplication';
|
1807
|
-
};
|
1808
|
-
|
1809
|
-
/**
|
1810
|
-
* The base frame event.
|
1811
|
-
* @interface
|
1812
|
-
*/
|
1813
|
-
declare type BaseEvent_7 = NamedEvent & {
|
1814
|
-
entityType: 'iframe';
|
1815
|
-
frameName: string;
|
1816
|
-
};
|
1817
|
-
|
1818
|
-
/**
|
1819
|
-
* Base type for events emitting on the `system` topic
|
1820
|
-
* @interface
|
1821
|
-
*/
|
1822
|
-
declare type BaseEvent_8 = BaseEvents.BaseEvent & {
|
1823
|
-
topic: 'system';
|
1824
|
-
};
|
1825
|
-
|
1826
|
-
declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
|
1766
|
+
declare type BaseEvent_2 = Events.BaseEvents.BaseEvent;
|
1827
1767
|
|
1828
1768
|
declare namespace BaseEvents {
|
1829
1769
|
export {
|
1830
|
-
NotCloseRequested,
|
1831
1770
|
PropagatedEventType,
|
1832
1771
|
PropagatedEvent,
|
1833
1772
|
EventHandler,
|
@@ -1838,14 +1777,21 @@ declare namespace BaseEvents {
|
|
1838
1777
|
}
|
1839
1778
|
|
1840
1779
|
/**
|
1841
|
-
*
|
1780
|
+
* Base type for events emitting on the `externalapplication` topic
|
1781
|
+
* @interface
|
1842
1782
|
*/
|
1843
|
-
declare type BaseExternalApplicationEvent =
|
1783
|
+
declare type BaseExternalApplicationEvent = BaseEvent & {
|
1784
|
+
topic: 'externalapplication';
|
1785
|
+
};
|
1844
1786
|
|
1845
1787
|
/**
|
1846
|
-
*
|
1788
|
+
* The base frame event.
|
1789
|
+
* @interface
|
1847
1790
|
*/
|
1848
|
-
declare type BaseFrameEvent =
|
1791
|
+
declare type BaseFrameEvent = NamedEvent & {
|
1792
|
+
entityType: 'iframe';
|
1793
|
+
frameName: string;
|
1794
|
+
};
|
1849
1795
|
|
1850
1796
|
declare type BaseLoadFailedEvent = NamedEvent & {
|
1851
1797
|
errorCode: number;
|
@@ -1854,20 +1800,35 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
1854
1800
|
isMainFrame: boolean;
|
1855
1801
|
};
|
1856
1802
|
|
1803
|
+
/**
|
1804
|
+
* Base type for events emitting on the `system` topic
|
1805
|
+
* @interface
|
1806
|
+
*/
|
1807
|
+
declare type BaseSystemEvent = BaseEvent & {
|
1808
|
+
topic: 'system';
|
1809
|
+
};
|
1810
|
+
|
1857
1811
|
declare type BaseUrlEvent = NamedEvent & {
|
1858
1812
|
type: 'url-changed';
|
1859
1813
|
url: string;
|
1860
1814
|
};
|
1861
1815
|
|
1862
1816
|
/**
|
1863
|
-
*
|
1817
|
+
* Base type for events emitting on the `view` topic
|
1818
|
+
* @interface
|
1864
1819
|
*/
|
1865
|
-
declare type BaseViewEvent =
|
1820
|
+
declare type BaseViewEvent = NamedEvent & {
|
1821
|
+
topic: 'view';
|
1822
|
+
target: OpenFin.Identity;
|
1823
|
+
};
|
1866
1824
|
|
1867
1825
|
/**
|
1868
|
-
*
|
1826
|
+
* Base type for events emitting on the `window` topic
|
1827
|
+
* @interface
|
1869
1828
|
*/
|
1870
|
-
declare type BaseWindowEvent =
|
1829
|
+
declare type BaseWindowEvent = NamedEvent & {
|
1830
|
+
topic: 'window';
|
1831
|
+
};
|
1871
1832
|
|
1872
1833
|
/**
|
1873
1834
|
* User decision of whether a Window or specific View should close when trying to prevent an unload.
|
@@ -1934,7 +1895,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
1934
1895
|
* A general bounds change event without event type.
|
1935
1896
|
* @interface
|
1936
1897
|
*/
|
1937
|
-
declare type BoundsChangeEvent =
|
1898
|
+
declare type BoundsChangeEvent = BaseWindowEvent & {
|
1938
1899
|
changeType: 0 | 1 | 2;
|
1939
1900
|
deferred: boolean;
|
1940
1901
|
height: number;
|
@@ -2006,76 +1967,76 @@ declare interface BrowserWindow {
|
|
2006
1967
|
}
|
2007
1968
|
|
2008
1969
|
/**
|
2009
|
-
* Extracts a single event type matching the given key from the
|
1970
|
+
* Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
|
2010
1971
|
*
|
2011
1972
|
* Alias for {@link Payload}, which may read better in source.
|
2012
1973
|
*
|
2013
1974
|
* @typeParam Type String key specifying the event to extract
|
2014
1975
|
*/
|
2015
|
-
declare type ByType<Type extends
|
1976
|
+
declare type ByType<Type extends ApplicationEventType> = Payload_2<Type>;
|
2016
1977
|
|
2017
1978
|
/**
|
2018
|
-
* Extracts a single event type matching the given key from the
|
1979
|
+
* Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
|
2019
1980
|
*
|
2020
1981
|
* Alias for {@link Payload}, which may read better in source.
|
2021
1982
|
*
|
2022
1983
|
* @typeParam Type String key specifying the event to extract
|
2023
1984
|
*/
|
2024
|
-
declare type ByType_2<Type extends
|
1985
|
+
declare type ByType_2<Type extends ExternalApplicationEventType> = Payload_3<Type>;
|
2025
1986
|
|
2026
1987
|
/**
|
2027
|
-
* Extracts a single event type matching the given key from the
|
1988
|
+
* Extracts a single event type matching the given key from the {@link FrameEvent} union.
|
2028
1989
|
*
|
2029
1990
|
* Alias for {@link Payload}, which may read better in source.
|
2030
1991
|
*
|
2031
1992
|
* @typeParam Type String key specifying the event to extract
|
2032
1993
|
*/
|
2033
|
-
declare type ByType_3<Type extends
|
1994
|
+
declare type ByType_3<Type extends FrameEventType> = Payload_4<Type>;
|
2034
1995
|
|
2035
1996
|
/**
|
2036
|
-
* Extracts a single event type matching the given key from the
|
1997
|
+
* Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
|
2037
1998
|
*
|
2038
1999
|
* Alias for {@link Payload}, which may read better in source.
|
2039
2000
|
*
|
2040
2001
|
* @typeParam Type String key specifying the event to extract
|
2041
2002
|
*/
|
2042
|
-
declare type ByType_4<Type extends
|
2003
|
+
declare type ByType_4<Type extends GlobalHotkeyEventType> = Payload_5<Type>;
|
2043
2004
|
|
2044
2005
|
/**
|
2045
|
-
* Extracts a single event type matching the given key from the
|
2006
|
+
* Extracts a single event type matching the given key from the {@link PlatformEvent} union.
|
2046
2007
|
*
|
2047
2008
|
* Alias for {@link Payload}, which may read better in source.
|
2048
2009
|
*
|
2049
2010
|
* @typeParam Type String key specifying the event to extract
|
2050
2011
|
*/
|
2051
|
-
declare type ByType_5<Type extends
|
2012
|
+
declare type ByType_5<Type extends PlatformEventType> = Payload_6<Type>;
|
2052
2013
|
|
2053
2014
|
/**
|
2054
|
-
* Extracts a single event type matching the given key from the
|
2015
|
+
* Extracts a single event type matching the given key from the {@link SystemEvent} union.
|
2055
2016
|
*
|
2056
2017
|
* Alias for {@link Payload}, which may read better in source.
|
2057
2018
|
*
|
2058
2019
|
* @typeParam Type String key specifying the event to extract
|
2059
2020
|
*/
|
2060
|
-
declare type ByType_6<Type extends
|
2021
|
+
declare type ByType_6<Type extends SystemEventType> = Payload_7<Type>;
|
2061
2022
|
|
2062
2023
|
/**
|
2063
|
-
* Extracts a single event type matching the given key from the
|
2024
|
+
* Extracts a single event type matching the given key from the {@link ViewEvent} union.
|
2064
2025
|
*
|
2065
2026
|
* Alias for {@link Payload}, which may read better in source.
|
2066
2027
|
*
|
2067
2028
|
* @typeParam Type String key specifying the event to extract
|
2068
2029
|
*/
|
2069
|
-
declare type ByType_7<Type extends
|
2030
|
+
declare type ByType_7<Type extends ViewEventType> = Payload_8<Type>;
|
2070
2031
|
|
2071
2032
|
/**
|
2072
|
-
* Extracts a single event type matching the given key from the
|
2033
|
+
* Extracts a single event type matching the given key from the {@link WindowEvent} union.
|
2073
2034
|
*
|
2074
2035
|
* Alias for {@link Payload}, which may read better in source.
|
2075
2036
|
*
|
2076
2037
|
* @typeParam Type String key specifying the event to extract
|
2077
2038
|
*/
|
2078
|
-
declare type ByType_8<Type extends
|
2039
|
+
declare type ByType_8<Type extends WindowEventType> = Payload_9<Type>;
|
2079
2040
|
|
2080
2041
|
/**
|
2081
2042
|
* Configuration for page capture.
|
@@ -2758,6 +2719,14 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
|
|
2758
2719
|
|
2759
2720
|
declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
|
2760
2721
|
|
2722
|
+
/**
|
2723
|
+
* Generated when a Channel client is connected.
|
2724
|
+
* @interface
|
2725
|
+
*/
|
2726
|
+
declare type ChannelConnectedEvent = BaseChannelEvent & {
|
2727
|
+
type: 'connected';
|
2728
|
+
};
|
2729
|
+
|
2761
2730
|
/**
|
2762
2731
|
* Options provided on a client connection to a channel.
|
2763
2732
|
*
|
@@ -2789,9 +2758,21 @@ declare type ChannelCreateOptions = {
|
|
2789
2758
|
};
|
2790
2759
|
|
2791
2760
|
/**
|
2792
|
-
*
|
2761
|
+
* Generated when a Channel client has disconnected.
|
2762
|
+
* @interface
|
2793
2763
|
*/
|
2794
|
-
declare type
|
2764
|
+
declare type ChannelDisconnectedEvent = BaseChannelEvent & {
|
2765
|
+
type: 'disconnected';
|
2766
|
+
};
|
2767
|
+
|
2768
|
+
/**
|
2769
|
+
* [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
|
2770
|
+
* discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
|
2771
|
+
* under the {@link OpenFin.ChannelEvents} namespace.
|
2772
|
+
*/
|
2773
|
+
declare type ChannelEvent = {
|
2774
|
+
topic: 'channel';
|
2775
|
+
} & (ChannelConnectedEvent | ChannelDisconnectedEvent);
|
2795
2776
|
|
2796
2777
|
declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
|
2797
2778
|
|
@@ -3329,19 +3310,11 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
|
|
3329
3310
|
* Generated when an application is closed.
|
3330
3311
|
* @interface
|
3331
3312
|
*/
|
3332
|
-
declare type ClosedEvent =
|
3313
|
+
declare type ClosedEvent = IdentityEvent & {
|
3333
3314
|
topic: 'application';
|
3334
3315
|
type: 'closed';
|
3335
3316
|
};
|
3336
3317
|
|
3337
|
-
/**
|
3338
|
-
* Generated when a window has closed.
|
3339
|
-
* @interface
|
3340
|
-
*/
|
3341
|
-
declare type ClosedEvent_2 = BaseEvent_5 & {
|
3342
|
-
type: 'closed';
|
3343
|
-
};
|
3344
|
-
|
3345
3318
|
/**
|
3346
3319
|
* @interface
|
3347
3320
|
*/
|
@@ -3349,15 +3322,6 @@ declare type ClosedMenuResult = {
|
|
3349
3322
|
result: 'closed';
|
3350
3323
|
};
|
3351
3324
|
|
3352
|
-
/**
|
3353
|
-
* Generated when a window has been prevented from closing.
|
3354
|
-
* @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.
|
3355
|
-
* @interface
|
3356
|
-
*/
|
3357
|
-
declare type CloseRequestedEvent = BaseEvent_5 & {
|
3358
|
-
type: 'close-requested';
|
3359
|
-
};
|
3360
|
-
|
3361
3325
|
/**
|
3362
3326
|
* @interface
|
3363
3327
|
*/
|
@@ -3404,14 +3368,6 @@ declare interface CloseWindowPayload {
|
|
3404
3368
|
};
|
3405
3369
|
}
|
3406
3370
|
|
3407
|
-
/**
|
3408
|
-
* Generated when a window has initiated the closing routine.
|
3409
|
-
* @interface
|
3410
|
-
*/
|
3411
|
-
declare type ClosingEvent = BaseEvent_5 & {
|
3412
|
-
type: 'closing';
|
3413
|
-
};
|
3414
|
-
|
3415
3371
|
/**
|
3416
3372
|
* A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
|
3417
3373
|
*/
|
@@ -3549,39 +3505,6 @@ export declare function connect(config: ConnectConfig): Promise<Fin<'external co
|
|
3549
3505
|
|
3550
3506
|
declare type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
|
3551
3507
|
|
3552
|
-
/**
|
3553
|
-
* Generated when a Channel client is connected.
|
3554
|
-
* @interface
|
3555
|
-
*/
|
3556
|
-
declare type ConnectedEvent = BaseEvent_2 & {
|
3557
|
-
type: 'connected';
|
3558
|
-
};
|
3559
|
-
|
3560
|
-
/**
|
3561
|
-
* Generated when an application has authenticated and is connected.
|
3562
|
-
* @interface
|
3563
|
-
*/
|
3564
|
-
declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
|
3565
|
-
topic: 'application';
|
3566
|
-
type: 'connected';
|
3567
|
-
};
|
3568
|
-
|
3569
|
-
/**
|
3570
|
-
* Generated when an external application has authenticated and is connected.
|
3571
|
-
* @interface
|
3572
|
-
*/
|
3573
|
-
declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
|
3574
|
-
type: 'connected';
|
3575
|
-
};
|
3576
|
-
|
3577
|
-
/**
|
3578
|
-
* Generated when a frame is connected.
|
3579
|
-
* @interface
|
3580
|
-
*/
|
3581
|
-
declare type ConnectedEvent_4 = BaseFrameEvent & {
|
3582
|
-
type: 'connected';
|
3583
|
-
};
|
3584
|
-
|
3585
3508
|
declare type Constructor<T = {}> = new () => T;
|
3586
3509
|
|
3587
3510
|
declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
@@ -4323,7 +4246,7 @@ declare type Context_3 = {
|
|
4323
4246
|
* Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
|
4324
4247
|
* @interface
|
4325
4248
|
*/
|
4326
|
-
declare type ContextChangedEvent =
|
4249
|
+
declare type ContextChangedEvent = BaseWindowEvent & {
|
4327
4250
|
type: 'context-changed';
|
4328
4251
|
context: any;
|
4329
4252
|
};
|
@@ -4475,7 +4398,7 @@ declare type CpuInfo = {
|
|
4475
4398
|
* Generated when an application has crashed.
|
4476
4399
|
* @interface
|
4477
4400
|
*/
|
4478
|
-
declare type CrashedEvent =
|
4401
|
+
declare type CrashedEvent = IdentityEvent & {
|
4479
4402
|
topic: 'application';
|
4480
4403
|
type: 'crashed';
|
4481
4404
|
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
@@ -4526,7 +4449,7 @@ declare type CrashReporterState = CrashReporterOptions & {
|
|
4526
4449
|
* Generated when a View is created.
|
4527
4450
|
* @interface
|
4528
4451
|
*/
|
4529
|
-
declare type CreatedEvent =
|
4452
|
+
declare type CreatedEvent = BaseViewEvent & {
|
4530
4453
|
type: 'created';
|
4531
4454
|
};
|
4532
4455
|
|
@@ -4685,7 +4608,7 @@ declare interface DesktopAgent_2 {
|
|
4685
4608
|
* Generated when the desktop icon is clicked while it's already running.
|
4686
4609
|
* @interface
|
4687
4610
|
*/
|
4688
|
-
declare type DesktopIconClickedEvent =
|
4611
|
+
declare type DesktopIconClickedEvent = BaseSystemEvent & {
|
4689
4612
|
type: 'desktop-icon-clicked';
|
4690
4613
|
};
|
4691
4614
|
|
@@ -4693,7 +4616,7 @@ declare type DesktopIconClickedEvent = BaseEvent_8 & {
|
|
4693
4616
|
* Generated when a View is destroyed.
|
4694
4617
|
* @interface
|
4695
4618
|
*/
|
4696
|
-
declare type DestroyedEvent =
|
4619
|
+
declare type DestroyedEvent = BaseViewEvent & {
|
4697
4620
|
type: 'destroyed';
|
4698
4621
|
};
|
4699
4622
|
|
@@ -4793,30 +4716,6 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
4793
4716
|
type: 'disabled-movement-bounds-changing';
|
4794
4717
|
};
|
4795
4718
|
|
4796
|
-
/**
|
4797
|
-
* Generated when a Channel client has disconnected.
|
4798
|
-
* @interface
|
4799
|
-
*/
|
4800
|
-
declare type DisconnectedEvent = BaseEvent_2 & {
|
4801
|
-
type: 'disconnected';
|
4802
|
-
};
|
4803
|
-
|
4804
|
-
/**
|
4805
|
-
* Generated when an external application has disconnected.
|
4806
|
-
* @interface
|
4807
|
-
*/
|
4808
|
-
declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
|
4809
|
-
type: 'disconnected';
|
4810
|
-
};
|
4811
|
-
|
4812
|
-
/**
|
4813
|
-
* Generated when a frame has disconnected.
|
4814
|
-
* @interface
|
4815
|
-
*/
|
4816
|
-
declare type DisconnectedEvent_3 = BaseFrameEvent & {
|
4817
|
-
type: 'disconnected';
|
4818
|
-
};
|
4819
|
-
|
4820
4719
|
/**
|
4821
4720
|
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
4822
4721
|
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
@@ -4950,7 +4849,7 @@ declare type DownloadShelfOptions = {
|
|
4950
4849
|
*
|
4951
4850
|
* @interface
|
4952
4851
|
*/
|
4953
|
-
declare type DownloadShelfVisibilityChangedEvent =
|
4852
|
+
declare type DownloadShelfVisibilityChangedEvent = BaseWindowEvent & {
|
4954
4853
|
type: 'download-shelf-visibility-changed';
|
4955
4854
|
/**
|
4956
4855
|
* True if the download shelf was just opened; false if it was just closed.
|
@@ -4980,7 +4879,7 @@ declare interface DragSource {}
|
|
4980
4879
|
* Generated when a window has been embedded.
|
4981
4880
|
* @interface
|
4982
4881
|
*/
|
4983
|
-
declare type EmbeddedEvent =
|
4882
|
+
declare type EmbeddedEvent = BaseWindowEvent & {
|
4984
4883
|
type: 'embedded';
|
4985
4884
|
};
|
4986
4885
|
|
@@ -5084,7 +4983,7 @@ declare class EmitterMap {
|
|
5084
4983
|
* Generated when a window ends loading.
|
5085
4984
|
* @interface
|
5086
4985
|
*/
|
5087
|
-
declare type EndLoadEvent =
|
4986
|
+
declare type EndLoadEvent = BaseWindowEvent & {
|
5088
4987
|
type: 'end-load';
|
5089
4988
|
documentName: string;
|
5090
4989
|
isMain: boolean;
|
@@ -5201,88 +5100,6 @@ declare type ErrorPlainObject = {
|
|
5201
5100
|
toString(): string;
|
5202
5101
|
};
|
5203
5102
|
|
5204
|
-
/**
|
5205
|
-
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}. Events are
|
5206
|
-
* discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
|
5207
|
-
* under the {@link OpenFin.PlatformEvents} namespace.
|
5208
|
-
*/
|
5209
|
-
declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
|
5210
|
-
|
5211
|
-
/**
|
5212
|
-
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
|
5213
|
-
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
5214
|
-
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5215
|
-
* from which they propagate).
|
5216
|
-
*/
|
5217
|
-
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ViewEvents.PropagatedEvent<'system'> | ApplicationEvents.PropagatedEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
5218
|
-
|
5219
|
-
/**
|
5220
|
-
* [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
|
5221
|
-
* discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
|
5222
|
-
* under the {@link OpenFin.ChannelEvents} namespace.
|
5223
|
-
*/
|
5224
|
-
declare type Event_2 = {
|
5225
|
-
topic: 'channel';
|
5226
|
-
} & (ConnectedEvent | DisconnectedEvent);
|
5227
|
-
|
5228
|
-
/**
|
5229
|
-
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
|
5230
|
-
* discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
|
5231
|
-
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5232
|
-
* from which they propagate).
|
5233
|
-
*/
|
5234
|
-
declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
|
5235
|
-
|
5236
|
-
/**
|
5237
|
-
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
|
5238
|
-
* discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
|
5239
|
-
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5240
|
-
*/
|
5241
|
-
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
5242
|
-
target: OpenFin.Identity;
|
5243
|
-
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
5244
|
-
|
5245
|
-
/**
|
5246
|
-
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
5247
|
-
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
5248
|
-
*/
|
5249
|
-
declare type Event_5<Topic extends string> = {
|
5250
|
-
topic: Topic;
|
5251
|
-
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
5252
|
-
|
5253
|
-
/**
|
5254
|
-
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
|
5255
|
-
* discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
|
5256
|
-
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5257
|
-
*/
|
5258
|
-
declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
|
5259
|
-
|
5260
|
-
/**
|
5261
|
-
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}. Events are
|
5262
|
-
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5263
|
-
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5264
|
-
*/
|
5265
|
-
declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
|
5266
|
-
|
5267
|
-
/**
|
5268
|
-
* [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
|
5269
|
-
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
5270
|
-
* under the {@link OpenFin.FrameEvents} namespace.
|
5271
|
-
*/
|
5272
|
-
declare type Event_8 = {
|
5273
|
-
topic: 'frame';
|
5274
|
-
} & (ConnectedEvent_4 | DisconnectedEvent_3);
|
5275
|
-
|
5276
|
-
/**
|
5277
|
-
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}. Events are
|
5278
|
-
* discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
5279
|
-
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
5280
|
-
*/
|
5281
|
-
declare type Event_9 = {
|
5282
|
-
topic: 'global-hotkey';
|
5283
|
-
hotkey: 'string';
|
5284
|
-
} & (RegisteredEvent | UnregisteredEvent);
|
5285
|
-
|
5286
5103
|
declare class EventAggregator extends EmitterMap {
|
5287
5104
|
dispatchEvent: (message: Message<any>) => boolean;
|
5288
5105
|
}
|
@@ -5348,46 +5165,6 @@ declare namespace Events {
|
|
5348
5165
|
}
|
5349
5166
|
}
|
5350
5167
|
|
5351
|
-
/**
|
5352
|
-
* Union of possible `type` values for a view {@link Event}.
|
5353
|
-
*/
|
5354
|
-
declare type EventType = Event_4['type'];
|
5355
|
-
|
5356
|
-
/**
|
5357
|
-
* Union of possible `type` values for a Window {@link Event}.
|
5358
|
-
*/
|
5359
|
-
declare type EventType_2 = Event_6['type'];
|
5360
|
-
|
5361
|
-
/**
|
5362
|
-
* Union of possible `type` values for an Application {@link Event}.
|
5363
|
-
*/
|
5364
|
-
declare type EventType_3 = Event_3['type'];
|
5365
|
-
|
5366
|
-
/**
|
5367
|
-
* Union of possible `type` values for an ExternalApplication {@link Event}.
|
5368
|
-
*/
|
5369
|
-
declare type EventType_4 = Event_7['type'];
|
5370
|
-
|
5371
|
-
/**
|
5372
|
-
* Union of possible `type` values for a {@link FrameEvent}.
|
5373
|
-
*/
|
5374
|
-
declare type EventType_5 = Event_8['type'];
|
5375
|
-
|
5376
|
-
/**
|
5377
|
-
* Union of possible `type` values for a {@link GlobalHotkeyEvent}
|
5378
|
-
*/
|
5379
|
-
declare type EventType_6 = Event_9['type'];
|
5380
|
-
|
5381
|
-
/**
|
5382
|
-
* Union of possible `type` values for a {@link PlatformEvent}.
|
5383
|
-
*/
|
5384
|
-
declare type EventType_7 = Event_10['type'];
|
5385
|
-
|
5386
|
-
/**
|
5387
|
-
* Union of possible `type` values for a {@link SystemEvent}.
|
5388
|
-
*/
|
5389
|
-
declare type EventType_8 = SystemEvent['type'];
|
5390
|
-
|
5391
5168
|
/**
|
5392
5169
|
* @internal
|
5393
5170
|
*/
|
@@ -5401,8 +5178,6 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
|
|
5401
5178
|
|
5402
5179
|
/**
|
5403
5180
|
* @internal
|
5404
|
-
*
|
5405
|
-
* Ensures that an event payload type does not include any `-requested` events. Distributes over unions.
|
5406
5181
|
*/
|
5407
5182
|
declare type ExcludeRequested<Event extends {
|
5408
5183
|
type: string;
|
@@ -5532,43 +5307,46 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
|
|
5532
5307
|
}
|
5533
5308
|
|
5534
5309
|
/**
|
5535
|
-
*
|
5310
|
+
* Generated when an external application has authenticated and is connected.
|
5311
|
+
* @interface
|
5536
5312
|
*/
|
5537
|
-
declare type ExternalApplicationConnectedEvent =
|
5313
|
+
declare type ExternalApplicationConnectedEvent = BaseExternalApplicationEvent & {
|
5314
|
+
type: 'connected';
|
5315
|
+
};
|
5538
5316
|
|
5539
5317
|
/**
|
5540
|
-
*
|
5318
|
+
* Generated when an external application has disconnected.
|
5319
|
+
* @interface
|
5541
5320
|
*/
|
5542
|
-
declare type ExternalApplicationDisconnectedEvent =
|
5321
|
+
declare type ExternalApplicationDisconnectedEvent = BaseExternalApplicationEvent & {
|
5322
|
+
type: 'disconnected';
|
5323
|
+
};
|
5543
5324
|
|
5544
5325
|
/**
|
5545
|
-
*
|
5326
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}. Events are
|
5327
|
+
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5328
|
+
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5546
5329
|
*/
|
5547
|
-
declare type ExternalApplicationEvent =
|
5330
|
+
declare type ExternalApplicationEvent = ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent;
|
5548
5331
|
|
5549
5332
|
declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
|
5550
5333
|
|
5551
5334
|
declare namespace ExternalApplicationEvents {
|
5552
5335
|
export {
|
5553
|
-
BaseEvent_6 as BaseEvent,
|
5554
5336
|
BaseExternalApplicationEvent,
|
5555
|
-
ConnectedEvent_3 as ConnectedEvent,
|
5556
5337
|
ExternalApplicationConnectedEvent,
|
5557
|
-
DisconnectedEvent_2 as DisconnectedEvent,
|
5558
5338
|
ExternalApplicationDisconnectedEvent,
|
5559
|
-
Event_7 as Event,
|
5560
5339
|
ExternalApplicationEvent,
|
5561
|
-
EventType_4 as EventType,
|
5562
5340
|
ExternalApplicationEventType,
|
5563
|
-
|
5564
|
-
|
5341
|
+
Payload_3 as Payload,
|
5342
|
+
ByType_2 as ByType
|
5565
5343
|
}
|
5566
5344
|
}
|
5567
5345
|
|
5568
5346
|
/**
|
5569
|
-
*
|
5347
|
+
* Union of possible `type` values for a {@link ApplicationEvent}.
|
5570
5348
|
*/
|
5571
|
-
declare type ExternalApplicationEventType =
|
5349
|
+
declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
|
5572
5350
|
|
5573
5351
|
/**
|
5574
5352
|
* @interface
|
@@ -5633,7 +5411,7 @@ declare type ExternalConnection = {
|
|
5633
5411
|
* Generated when an external process has exited.
|
5634
5412
|
* @interface
|
5635
5413
|
*/
|
5636
|
-
declare type ExternalProcessExitedEvent =
|
5414
|
+
declare type ExternalProcessExitedEvent = BaseWindowEvent & {
|
5637
5415
|
type: 'external-process-exited';
|
5638
5416
|
processUuid: string;
|
5639
5417
|
exitCode: number;
|
@@ -5678,15 +5456,19 @@ declare type ExternalProcessRequestType = {
|
|
5678
5456
|
* Generated when an external process has started.
|
5679
5457
|
* @interface
|
5680
5458
|
*/
|
5681
|
-
declare type ExternalProcessStartedEvent =
|
5459
|
+
declare type ExternalProcessStartedEvent = BaseWindowEvent & {
|
5682
5460
|
type: 'external-process-started';
|
5683
5461
|
processUuid: string;
|
5684
5462
|
};
|
5685
5463
|
|
5686
5464
|
/**
|
5687
|
-
*
|
5465
|
+
* Generated when page receives favicon urls.
|
5466
|
+
* @interface
|
5688
5467
|
*/
|
5689
|
-
declare type FaviconUpdatedEvent =
|
5468
|
+
declare type FaviconUpdatedEvent = NamedEvent & {
|
5469
|
+
type: 'page-favicon-updated';
|
5470
|
+
favicons: string[];
|
5471
|
+
};
|
5690
5472
|
|
5691
5473
|
declare namespace FDC3 {
|
5692
5474
|
export {
|
@@ -6067,43 +5849,48 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
6067
5849
|
}
|
6068
5850
|
|
6069
5851
|
/**
|
6070
|
-
*
|
5852
|
+
* Generated when a frame is connected.
|
5853
|
+
* @interface
|
6071
5854
|
*/
|
6072
|
-
declare type FrameConnectedEvent =
|
5855
|
+
declare type FrameConnectedEvent = BaseFrameEvent & {
|
5856
|
+
type: 'connected';
|
5857
|
+
};
|
6073
5858
|
|
6074
5859
|
/**
|
6075
|
-
*
|
5860
|
+
* Generated when a frame has disconnected.
|
5861
|
+
* @interface
|
6076
5862
|
*/
|
6077
|
-
declare type FrameDisconnectedEvent =
|
5863
|
+
declare type FrameDisconnectedEvent = BaseFrameEvent & {
|
5864
|
+
type: 'disconnected';
|
5865
|
+
};
|
6078
5866
|
|
6079
5867
|
/**
|
6080
|
-
*
|
5868
|
+
* [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
|
5869
|
+
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
5870
|
+
* under the {@link OpenFin.FrameEvents} namespace.
|
6081
5871
|
*/
|
6082
|
-
declare type FrameEvent =
|
5872
|
+
declare type FrameEvent = {
|
5873
|
+
topic: 'frame';
|
5874
|
+
} & (FrameConnectedEvent | FrameDisconnectedEvent);
|
6083
5875
|
|
6084
5876
|
declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
|
6085
5877
|
|
6086
5878
|
declare namespace FrameEvents {
|
6087
5879
|
export {
|
6088
|
-
BaseEvent_7 as BaseEvent,
|
6089
5880
|
BaseFrameEvent,
|
6090
|
-
ConnectedEvent_4 as ConnectedEvent,
|
6091
5881
|
FrameConnectedEvent,
|
6092
|
-
DisconnectedEvent_3 as DisconnectedEvent,
|
6093
5882
|
FrameDisconnectedEvent,
|
6094
|
-
Event_8 as Event,
|
6095
5883
|
FrameEvent,
|
6096
|
-
EventType_5 as EventType,
|
6097
5884
|
FrameEventType,
|
6098
|
-
|
6099
|
-
|
5885
|
+
Payload_4 as Payload,
|
5886
|
+
ByType_3 as ByType
|
6100
5887
|
}
|
6101
5888
|
}
|
6102
5889
|
|
6103
5890
|
/**
|
6104
|
-
*
|
5891
|
+
* Union of possible `type` values for a {@link FrameEvent}.
|
6105
5892
|
*/
|
6106
|
-
declare type FrameEventType =
|
5893
|
+
declare type FrameEventType = FrameEvent['type'];
|
6107
5894
|
|
6108
5895
|
/**
|
6109
5896
|
* @interface
|
@@ -6325,9 +6112,14 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
|
|
6325
6112
|
}
|
6326
6113
|
|
6327
6114
|
/**
|
6328
|
-
*
|
6115
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}. Events are
|
6116
|
+
* discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
6117
|
+
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
6329
6118
|
*/
|
6330
|
-
declare type GlobalHotkeyEvent =
|
6119
|
+
declare type GlobalHotkeyEvent = {
|
6120
|
+
topic: 'global-hotkey';
|
6121
|
+
hotkey: 'string';
|
6122
|
+
} & (RegisteredEvent | UnregisteredEvent);
|
6331
6123
|
|
6332
6124
|
declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
6333
6125
|
|
@@ -6335,19 +6127,17 @@ declare namespace GlobalHotkeyEvents {
|
|
6335
6127
|
export {
|
6336
6128
|
RegisteredEvent,
|
6337
6129
|
UnregisteredEvent,
|
6338
|
-
Event_9 as Event,
|
6339
6130
|
GlobalHotkeyEvent,
|
6340
|
-
EventType_6 as EventType,
|
6341
6131
|
GlobalHotkeyEventType,
|
6342
|
-
|
6343
|
-
|
6132
|
+
Payload_5 as Payload,
|
6133
|
+
ByType_4 as ByType
|
6344
6134
|
}
|
6345
6135
|
}
|
6346
6136
|
|
6347
6137
|
/**
|
6348
|
-
*
|
6138
|
+
* Union of possible `type` values for a {@link GlobalHotkeyEvent}
|
6349
6139
|
*/
|
6350
|
-
declare type GlobalHotkeyEventType =
|
6140
|
+
declare type GlobalHotkeyEventType = GlobalHotkeyEvent['type'];
|
6351
6141
|
|
6352
6142
|
declare namespace GoldenLayout {
|
6353
6143
|
export {
|
@@ -6649,17 +6439,8 @@ declare interface Header {
|
|
6649
6439
|
* Generated when a View is hidden.
|
6650
6440
|
* @interface
|
6651
6441
|
*/
|
6652
|
-
declare type HiddenEvent =
|
6653
|
-
type: 'hidden';
|
6654
|
-
};
|
6655
|
-
|
6656
|
-
/**
|
6657
|
-
* Generated when a window has been hidden.
|
6658
|
-
* @interface
|
6659
|
-
*/
|
6660
|
-
declare type HiddenEvent_2 = BaseEvent_5 & {
|
6442
|
+
declare type HiddenEvent = BaseViewEvent & {
|
6661
6443
|
type: 'hidden';
|
6662
|
-
reason: 'closing' | 'hide' | 'hide-on-close';
|
6663
6444
|
};
|
6664
6445
|
|
6665
6446
|
/**
|
@@ -6667,7 +6448,7 @@ declare type HiddenEvent_2 = BaseEvent_5 & {
|
|
6667
6448
|
* or because the View has moved to a new window. Only available on Views in a Platform.
|
6668
6449
|
* @interface
|
6669
6450
|
*/
|
6670
|
-
declare type HostContextChangedEvent =
|
6451
|
+
declare type HostContextChangedEvent = BaseViewEvent & {
|
6671
6452
|
type: 'host-context-changed';
|
6672
6453
|
context: any;
|
6673
6454
|
reason: 'reparented' | 'updated';
|
@@ -6746,16 +6527,7 @@ declare type Hotkey = {
|
|
6746
6527
|
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
6747
6528
|
* @interface
|
6748
6529
|
*/
|
6749
|
-
declare type HotkeyEvent =
|
6750
|
-
type: 'hotkey';
|
6751
|
-
};
|
6752
|
-
|
6753
|
-
/**
|
6754
|
-
* Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
|
6755
|
-
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
6756
|
-
* @interface
|
6757
|
-
*/
|
6758
|
-
declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
|
6530
|
+
declare type HotkeyEvent = BaseViewEvent & {
|
6759
6531
|
type: 'hotkey';
|
6760
6532
|
};
|
6761
6533
|
|
@@ -6818,7 +6590,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
|
|
6818
6590
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
6819
6591
|
* @interface
|
6820
6592
|
*/
|
6821
|
-
declare type IdleEvent =
|
6593
|
+
declare type IdleEvent = BaseSystemEvent & {
|
6822
6594
|
type: 'idle-state-changed';
|
6823
6595
|
elapsedTime: number;
|
6824
6596
|
isIdle: boolean;
|
@@ -6903,19 +6675,11 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
6903
6675
|
* Generated when an application has initialized.
|
6904
6676
|
* @interface
|
6905
6677
|
*/
|
6906
|
-
declare type InitializedEvent =
|
6678
|
+
declare type InitializedEvent = IdentityEvent & {
|
6907
6679
|
topic: 'application';
|
6908
6680
|
type: 'initialized';
|
6909
6681
|
};
|
6910
6682
|
|
6911
|
-
/**
|
6912
|
-
* Generated when a window is initialized.
|
6913
|
-
* @interface
|
6914
|
-
*/
|
6915
|
-
declare type InitializedEvent_2 = BaseEvent_5 & {
|
6916
|
-
type: 'initialized';
|
6917
|
-
};
|
6918
|
-
|
6919
6683
|
/**
|
6920
6684
|
* @interface
|
6921
6685
|
*/
|
@@ -9019,7 +8783,7 @@ declare type LayoutIdentity = Identity_5 & {
|
|
9019
8783
|
* Generated when a window and all of its layout's views have either finished or failed navigation.
|
9020
8784
|
* @interface
|
9021
8785
|
*/
|
9022
|
-
declare type LayoutInitializedEvent =
|
8786
|
+
declare type LayoutInitializedEvent = BaseWindowEvent & {
|
9023
8787
|
type: 'layout-initialized';
|
9024
8788
|
ofViews: (OpenFin.Identity & {
|
9025
8789
|
entityType: 'view';
|
@@ -9556,7 +9320,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
9556
9320
|
* Generated when a window and all of its layout's views have been created and can receive API calls.
|
9557
9321
|
* @interface
|
9558
9322
|
*/
|
9559
|
-
declare type LayoutReadyEvent =
|
9323
|
+
declare type LayoutReadyEvent = BaseWindowEvent & {
|
9560
9324
|
type: 'layout-ready';
|
9561
9325
|
views: (OpenFin.Identity & {
|
9562
9326
|
success: boolean;
|
@@ -9697,7 +9461,7 @@ declare type Manifest = {
|
|
9697
9461
|
* Generated when the RVM notifies an application that the manifest has changed.
|
9698
9462
|
* @interface
|
9699
9463
|
*/
|
9700
|
-
declare type ManifestChangedEvent =
|
9464
|
+
declare type ManifestChangedEvent = IdentityEvent & {
|
9701
9465
|
topic: 'application';
|
9702
9466
|
type: 'manifest-changed';
|
9703
9467
|
};
|
@@ -9750,7 +9514,7 @@ declare type MatchPattern = string;
|
|
9750
9514
|
* Generated when a window is maximized.
|
9751
9515
|
* @interface
|
9752
9516
|
*/
|
9753
|
-
declare type MaximizedEvent =
|
9517
|
+
declare type MaximizedEvent = BaseWindowEvent & {
|
9754
9518
|
type: 'maximized';
|
9755
9519
|
};
|
9756
9520
|
|
@@ -9860,7 +9624,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
|
|
9860
9624
|
* Generated when a window is minimized.
|
9861
9625
|
* @interface
|
9862
9626
|
*/
|
9863
|
-
declare type MinimizedEvent =
|
9627
|
+
declare type MinimizedEvent = BaseWindowEvent & {
|
9864
9628
|
type: 'minimized';
|
9865
9629
|
};
|
9866
9630
|
|
@@ -9909,7 +9673,7 @@ declare type MonitorDetails = {
|
|
9909
9673
|
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
9910
9674
|
* @interface
|
9911
9675
|
*/
|
9912
|
-
declare type MonitorEvent =
|
9676
|
+
declare type MonitorEvent = BaseSystemEvent & OpenFin.MonitorInfo & {
|
9913
9677
|
type: 'monitor-info-changed';
|
9914
9678
|
};
|
9915
9679
|
|
@@ -10341,23 +10105,14 @@ declare type NonPropagatedWindowEvent = never;
|
|
10341
10105
|
|
10342
10106
|
/**
|
10343
10107
|
* @internal
|
10344
|
-
*
|
10345
|
-
* Ensures that an event type key does not include any `close-requested` events. Distributes over unions.
|
10346
|
-
*/
|
10347
|
-
declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'close-requested'>;
|
10348
|
-
|
10349
|
-
/**
|
10350
|
-
* @internal
|
10351
|
-
*
|
10352
|
-
* Ensures that an event type key doesn't include any `-requested` events. Distributes over unions.
|
10353
10108
|
*/
|
10354
|
-
declare type NotRequested<EventType
|
10109
|
+
declare type NotRequested<EventType> = EventType extends `${infer U}-requested` ? never : EventType;
|
10355
10110
|
|
10356
10111
|
/**
|
10357
10112
|
* Generated when an application is not responding.
|
10358
10113
|
* @interface
|
10359
10114
|
*/
|
10360
|
-
declare type NotRespondingEvent =
|
10115
|
+
declare type NotRespondingEvent = IdentityEvent & {
|
10361
10116
|
topic: 'application';
|
10362
10117
|
type: 'not-responding';
|
10363
10118
|
};
|
@@ -10683,7 +10438,7 @@ declare namespace OpenFin {
|
|
10683
10438
|
AppVersionCompleteEvent,
|
10684
10439
|
AppVersionRuntimeStatusEvent,
|
10685
10440
|
Events,
|
10686
|
-
|
10441
|
+
BaseEvent_2 as BaseEvent,
|
10687
10442
|
WebContentsEvent_2 as WebContentsEvent,
|
10688
10443
|
SystemEvent_2 as SystemEvent,
|
10689
10444
|
ApplicationEvent_2 as ApplicationEvent,
|
@@ -10725,32 +10480,12 @@ export default OpenFin;
|
|
10725
10480
|
|
10726
10481
|
declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
|
10727
10482
|
|
10728
|
-
/**
|
10729
|
-
* Generated after window options are changed using the window.updateOptions method.
|
10730
|
-
* @remarks Will not fire if the diff object is empty.
|
10731
|
-
* @interface
|
10732
|
-
*/
|
10733
|
-
declare type OptionsChangedEvent = BaseEvent_5 & {
|
10734
|
-
type: 'options-changed';
|
10735
|
-
options: OpenFin.WindowOptions;
|
10736
|
-
diff: OpenFin.WindowOptionDiff;
|
10737
|
-
};
|
10738
|
-
|
10739
10483
|
declare type OverlapsOnlyIfMatching<T, U> = {
|
10740
10484
|
[K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
|
10741
10485
|
};
|
10742
10486
|
|
10743
10487
|
declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
10744
10488
|
|
10745
|
-
/**
|
10746
|
-
* Generated when page receives favicon urls.
|
10747
|
-
* @interface
|
10748
|
-
*/
|
10749
|
-
declare type PageFaviconUpdatedEvent = NamedEvent & {
|
10750
|
-
type: 'page-favicon-updated';
|
10751
|
-
favicons: string[];
|
10752
|
-
};
|
10753
|
-
|
10754
10489
|
/**
|
10755
10490
|
* Generated when page title is set during navigation.
|
10756
10491
|
* @remarks explicitSet is false when title is synthesized from file url.
|
@@ -10769,74 +10504,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10769
10504
|
};
|
10770
10505
|
|
10771
10506
|
/**
|
10772
|
-
* Extracts a single event type matching the given key from the
|
10507
|
+
* Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
|
10773
10508
|
*
|
10774
10509
|
* @typeParam Type String key specifying the event to extract
|
10775
10510
|
*/
|
10776
|
-
declare type Payload_2<Type extends
|
10511
|
+
declare type Payload_2<Type extends ApplicationEventType> = Extract<ApplicationEvent, {
|
10777
10512
|
type: Type;
|
10778
10513
|
}>;
|
10779
10514
|
|
10780
10515
|
/**
|
10781
|
-
* Extracts a single event type matching the given key from the
|
10516
|
+
* Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
|
10782
10517
|
*
|
10783
10518
|
* @typeParam Type String key specifying the event to extract
|
10784
10519
|
*/
|
10785
|
-
declare type Payload_3<Type extends
|
10520
|
+
declare type Payload_3<Type extends ExternalApplicationEventType> = Extract<ExternalApplicationEvent, {
|
10786
10521
|
type: Type;
|
10787
10522
|
}>;
|
10788
10523
|
|
10789
10524
|
/**
|
10790
|
-
* Extracts a single event type matching the given key from the
|
10525
|
+
* Extracts a single event type matching the given key from the {@link FrameEvent} union.
|
10791
10526
|
*
|
10792
10527
|
* @typeParam Type String key specifying the event to extract
|
10793
10528
|
*/
|
10794
|
-
declare type Payload_4<Type extends
|
10529
|
+
declare type Payload_4<Type extends FrameEventType> = Extract<FrameEvent, {
|
10795
10530
|
type: Type;
|
10796
10531
|
}>;
|
10797
10532
|
|
10798
10533
|
/**
|
10799
|
-
* Extracts a single event type matching the given key from the
|
10534
|
+
* Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
|
10800
10535
|
*
|
10801
10536
|
* @typeParam Type String key specifying the event to extract
|
10802
10537
|
*/
|
10803
|
-
declare type Payload_5<Type extends
|
10538
|
+
declare type Payload_5<Type extends GlobalHotkeyEventType> = Extract<GlobalHotkeyEvent, {
|
10804
10539
|
type: Type;
|
10805
10540
|
}>;
|
10806
10541
|
|
10807
10542
|
/**
|
10808
|
-
* Extracts a single event type matching the given key from the
|
10543
|
+
* Extracts a single event type matching the given key from the {@link PlatformEvent} union.
|
10809
10544
|
*
|
10810
10545
|
* @typeParam Type String key specifying the event to extract
|
10811
10546
|
*/
|
10812
|
-
declare type Payload_6<Type extends
|
10547
|
+
declare type Payload_6<Type extends PlatformEventType> = Extract<PlatformEvent, {
|
10813
10548
|
type: Type;
|
10814
10549
|
}>;
|
10815
10550
|
|
10816
10551
|
/**
|
10817
|
-
* Extracts a single event type matching the given key from the
|
10552
|
+
* Extracts a single event type matching the given key from the {@link SystemEvent} union.
|
10818
10553
|
*
|
10819
10554
|
* @typeParam Type String key specifying the event to extract
|
10820
10555
|
*/
|
10821
|
-
declare type Payload_7<Type extends
|
10556
|
+
declare type Payload_7<Type extends SystemEventType> = Extract<SystemEvent, {
|
10822
10557
|
type: Type;
|
10823
10558
|
}>;
|
10824
10559
|
|
10825
10560
|
/**
|
10826
|
-
* Extracts a single event type matching the given key from the
|
10561
|
+
* Extracts a single event type matching the given key from the {@link ViewEvent} union.
|
10827
10562
|
*
|
10828
10563
|
* @typeParam Type String key specifying the event to extract
|
10829
10564
|
*/
|
10830
|
-
declare type Payload_8<Type extends
|
10565
|
+
declare type Payload_8<Type extends ViewEventType> = Extract<ViewEvent, {
|
10831
10566
|
type: Type;
|
10832
10567
|
}>;
|
10833
10568
|
|
10834
10569
|
/**
|
10835
|
-
* Extracts a single event type matching the given key from the
|
10570
|
+
* Extracts a single event type matching the given key from the {@link WindowEvent} union.
|
10836
10571
|
*
|
10837
10572
|
* @typeParam Type String key specifying the event to extract
|
10838
10573
|
*/
|
10839
|
-
declare type Payload_9<Type extends
|
10574
|
+
declare type Payload_9<Type extends WindowEventType> = Extract<WindowEvent, {
|
10840
10575
|
type: Type;
|
10841
10576
|
}>;
|
10842
10577
|
|
@@ -10846,7 +10581,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
|
|
10846
10581
|
* Generated when window finishes loading. Provides performance and navigation data.
|
10847
10582
|
* @interface
|
10848
10583
|
*/
|
10849
|
-
declare type PerformanceReportEvent = Performance &
|
10584
|
+
declare type PerformanceReportEvent = Performance & BaseWindowEvent & {
|
10850
10585
|
type: 'performance-report';
|
10851
10586
|
};
|
10852
10587
|
|
@@ -11510,36 +11245,38 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
|
|
11510
11245
|
}
|
11511
11246
|
|
11512
11247
|
/**
|
11513
|
-
*
|
11248
|
+
* Generated when a new Platform's API becomes responsive.
|
11249
|
+
* @interface
|
11514
11250
|
*/
|
11515
|
-
declare type PlatformApiReadyEvent =
|
11251
|
+
declare type PlatformApiReadyEvent = BaseEvent & {
|
11252
|
+
topic: 'application';
|
11253
|
+
type: 'platform-api-ready';
|
11254
|
+
};
|
11516
11255
|
|
11517
11256
|
/**
|
11518
|
-
*
|
11257
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}. Events are
|
11258
|
+
* discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
|
11259
|
+
* under the {@link OpenFin.PlatformEvents} namespace.
|
11519
11260
|
*/
|
11520
|
-
declare type PlatformEvent =
|
11261
|
+
declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
|
11521
11262
|
|
11522
11263
|
declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
|
11523
11264
|
|
11524
11265
|
declare namespace PlatformEvents {
|
11525
11266
|
export {
|
11526
|
-
ApiReadyEvent,
|
11527
11267
|
PlatformApiReadyEvent,
|
11528
|
-
SnapshotAppliedEvent,
|
11529
11268
|
PlatformSnapshotAppliedEvent,
|
11530
|
-
Event_10 as Event,
|
11531
11269
|
PlatformEvent,
|
11532
|
-
EventType_7 as EventType,
|
11533
11270
|
PlatformEventType,
|
11534
|
-
|
11535
|
-
|
11271
|
+
Payload_6 as Payload,
|
11272
|
+
ByType_5 as ByType
|
11536
11273
|
}
|
11537
11274
|
}
|
11538
11275
|
|
11539
11276
|
/**
|
11540
|
-
*
|
11277
|
+
* Union of possible `type` values for a {@link PlatformEvent}.
|
11541
11278
|
*/
|
11542
|
-
declare type PlatformEventType =
|
11279
|
+
declare type PlatformEventType = PlatformEvent['type'];
|
11543
11280
|
|
11544
11281
|
/**
|
11545
11282
|
* Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
|
@@ -11819,14 +11556,11 @@ declare interface PlatformProvider {
|
|
11819
11556
|
* Calls platform.createView for every view in the given layout. Returns an array of promises
|
11820
11557
|
* one promise for each view create call
|
11821
11558
|
*
|
11822
|
-
* @param
|
11823
|
-
* @param
|
11559
|
+
* @param layout
|
11560
|
+
* @param target
|
11824
11561
|
* @returns an array of promises
|
11825
11562
|
*/
|
11826
|
-
createViewsForLayout(
|
11827
|
-
layout: GoldenLayout.Config;
|
11828
|
-
target?: OpenFin.Identity;
|
11829
|
-
}, callerIdentity: OpenFin.Identity): Promise<OpenFin.View>[];
|
11563
|
+
createViewsForLayout(layout: GoldenLayout.Config, target: OpenFin.Identity): Promise<OpenFin.View>[];
|
11830
11564
|
/**
|
11831
11565
|
* **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
|
11832
11566
|
* Gets the current state of a single view and returns an object with the options needed to restore that view as part of a snapshot.
|
@@ -12267,9 +12001,19 @@ declare interface PlatformProvider {
|
|
12267
12001
|
}
|
12268
12002
|
|
12269
12003
|
/**
|
12270
|
-
*
|
12004
|
+
* Generated when a platform.ApplySnapshot call is resolved.
|
12005
|
+
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
12006
|
+
* 1. The window has been created
|
12007
|
+
* 2. The window has a responsive API
|
12008
|
+
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
12009
|
+
*
|
12010
|
+
* _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.
|
12011
|
+
* @interface
|
12271
12012
|
*/
|
12272
|
-
declare type PlatformSnapshotAppliedEvent =
|
12013
|
+
declare type PlatformSnapshotAppliedEvent = BaseEvent & {
|
12014
|
+
topic: 'application';
|
12015
|
+
type: 'platform-snapshot-applied';
|
12016
|
+
};
|
12273
12017
|
|
12274
12018
|
/**
|
12275
12019
|
* @interface
|
@@ -12537,7 +12281,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
|
|
12537
12281
|
* A general preload scripts state change event without event type.
|
12538
12282
|
* @interface
|
12539
12283
|
*/
|
12540
|
-
declare type PreloadScriptsStateChangeEvent =
|
12284
|
+
declare type PreloadScriptsStateChangeEvent = BaseWindowEvent & {
|
12541
12285
|
preloadScripts: (PreloadScriptInfoRunning & any)[];
|
12542
12286
|
};
|
12543
12287
|
|
@@ -12746,43 +12490,51 @@ declare type ProcessLoggingOptions = {
|
|
12746
12490
|
};
|
12747
12491
|
|
12748
12492
|
/**
|
12749
|
-
*
|
12493
|
+
* An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
|
12494
|
+
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
12495
|
+
* are propagated to `System` without any type string prefixing.
|
12496
|
+
*
|
12497
|
+
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
12750
12498
|
*/
|
12751
|
-
declare type PropagatedApplicationEvent<TargetTopic extends string> =
|
12499
|
+
declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
|
12752
12500
|
|
12753
12501
|
/**
|
12754
|
-
*
|
12502
|
+
* Union of possible 'type' values for a {@link OpenFin.ApplicationEvents.PropagatedApplicationEvent}.
|
12755
12503
|
*/
|
12756
|
-
declare type PropagatedApplicationEventType =
|
12504
|
+
declare type PropagatedApplicationEventType = PropagatedApplicationEvent<string>['type'];
|
12757
12505
|
|
12758
12506
|
/**
|
12759
|
-
* Modifies an event shape to reflect propagation to a parent topic.
|
12760
|
-
* these do not propagate.
|
12761
|
-
*
|
12507
|
+
* Modifies an event shape to reflect propagation to a parent topic.
|
12762
12508
|
* @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
|
12763
|
-
*
|
12764
|
-
* @typeParam SourceTopic The topic the event shape is propagating from.
|
12765
|
-
* @typeParam TargetTopic The topic the event shape is propagating to.
|
12766
|
-
* @typeParam Event The shape of the event being propagated.
|
12767
12509
|
*/
|
12768
12510
|
declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
|
12769
12511
|
type: string;
|
12770
12512
|
}> = Event extends infer E extends {
|
12771
12513
|
type: string;
|
12772
|
-
} ?
|
12514
|
+
} ? Omit<E, 'type' | 'topic'> & {
|
12773
12515
|
type: PropagatedEventType<SourceTopic, E['type']>;
|
12774
12516
|
topic: TargetTopic;
|
12775
12517
|
} : never;
|
12776
12518
|
|
12519
|
+
/**
|
12520
|
+
* Modifies an event key to reflect propagation by prefixing with the topic.
|
12521
|
+
*/
|
12522
|
+
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
|
12523
|
+
|
12777
12524
|
/**
|
12778
12525
|
* A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
|
12779
12526
|
* or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
|
12780
12527
|
* event type key with `'view-'`.
|
12781
12528
|
*/
|
12782
|
-
declare type
|
12529
|
+
declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
|
12783
12530
|
viewIdentity: OpenFin.Identity;
|
12784
12531
|
};
|
12785
12532
|
|
12533
|
+
/**
|
12534
|
+
* Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
|
12535
|
+
*/
|
12536
|
+
declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
12537
|
+
|
12786
12538
|
/**
|
12787
12539
|
* A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
|
12788
12540
|
* prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
|
@@ -12791,51 +12543,12 @@ declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.Propagat
|
|
12791
12543
|
*
|
12792
12544
|
* "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
|
12793
12545
|
*/
|
12794
|
-
declare type
|
12546
|
+
declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent<'window', TargetTopic, Exclude<WindowSourcedEvent, WindowCloseRequestedEvent>>;
|
12795
12547
|
|
12796
12548
|
/**
|
12797
|
-
*
|
12798
|
-
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
12799
|
-
* are propagated to `System` without any type string prefixing.
|
12800
|
-
*
|
12801
|
-
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
12802
|
-
*/
|
12803
|
-
declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
|
12804
|
-
|
12805
|
-
/**
|
12806
|
-
* Modifies an event type key to reflect propagation by prefixing with the topic.
|
12807
|
-
*/
|
12808
|
-
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
|
12809
|
-
|
12810
|
-
/**
|
12811
|
-
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
|
12812
|
-
*/
|
12813
|
-
declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
|
12814
|
-
|
12815
|
-
/**
|
12816
|
-
* Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
|
12817
|
-
*/
|
12818
|
-
declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
|
12819
|
-
|
12820
|
-
/**
|
12821
|
-
* @deprecated Renamed to {@link PropagatedEvent}.
|
12549
|
+
* Union of possible `type` values for a {@link OpenFin.WindowEvents.PropagatedWindowEvent}.
|
12822
12550
|
*/
|
12823
|
-
declare type
|
12824
|
-
|
12825
|
-
/**
|
12826
|
-
* @deprecated Renamed to {@link PropagatedEventType}.
|
12827
|
-
*/
|
12828
|
-
declare type PropagatedViewEventType = PropagatedEventType_2;
|
12829
|
-
|
12830
|
-
/**
|
12831
|
-
* @deprecated Renamed to {@link PropagatedEvent}.
|
12832
|
-
*/
|
12833
|
-
declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
|
12834
|
-
|
12835
|
-
/**
|
12836
|
-
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
|
12837
|
-
*/
|
12838
|
-
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
12551
|
+
declare type PropagatedWindowEventType = PropagatedWindowEvent<string>['type'];
|
12839
12552
|
|
12840
12553
|
declare interface ProtocolMap extends ProtocolMapBase {
|
12841
12554
|
'request-external-authorization': {
|
@@ -13253,7 +12966,7 @@ declare type RegistryInfo_2 = {
|
|
13253
12966
|
* Generated when a window has been reloaded.
|
13254
12967
|
* @interface
|
13255
12968
|
*/
|
13256
|
-
declare type ReloadedEvent =
|
12969
|
+
declare type ReloadedEvent = BaseWindowEvent & {
|
13257
12970
|
type: 'reloaded';
|
13258
12971
|
url: string;
|
13259
12972
|
};
|
@@ -13389,19 +13102,11 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
|
|
13389
13102
|
* Generated when an application is responding.
|
13390
13103
|
* @interface
|
13391
13104
|
*/
|
13392
|
-
declare type RespondingEvent =
|
13105
|
+
declare type RespondingEvent = IdentityEvent & {
|
13393
13106
|
topic: 'application';
|
13394
13107
|
type: 'responding';
|
13395
13108
|
};
|
13396
13109
|
|
13397
|
-
/**
|
13398
|
-
* Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
13399
|
-
* @interface
|
13400
|
-
*/
|
13401
|
-
declare type RestoredEvent = BaseEvent_5 & {
|
13402
|
-
type: 'restored';
|
13403
|
-
};
|
13404
|
-
|
13405
13110
|
declare type ResultBehavior = 'close' | 'hide' | 'none';
|
13406
13111
|
|
13407
13112
|
/**
|
@@ -13464,7 +13169,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
|
|
13464
13169
|
* Generated when Application.run() is called for an already running application.
|
13465
13170
|
* @interface
|
13466
13171
|
*/
|
13467
|
-
declare type RunRequestedEvent_2 =
|
13172
|
+
declare type RunRequestedEvent_2 = IdentityEvent & {
|
13468
13173
|
topic: 'application';
|
13469
13174
|
type: 'run-requested';
|
13470
13175
|
userAppConfigArgs: Record<string, any>;
|
@@ -13646,7 +13351,7 @@ declare type ServiceIdentifier = {
|
|
13646
13351
|
* Generated on changes to a user’s local computer session.
|
13647
13352
|
* @interface
|
13648
13353
|
*/
|
13649
|
-
declare type SessionChangedEvent =
|
13354
|
+
declare type SessionChangedEvent = BaseSystemEvent & {
|
13650
13355
|
type: 'session-changed';
|
13651
13356
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
13652
13357
|
};
|
@@ -13868,7 +13573,7 @@ declare type ShortcutOverride = Hotkey & {
|
|
13868
13573
|
*
|
13869
13574
|
* @interface
|
13870
13575
|
*/
|
13871
|
-
declare type ShowAllDownloadsEvent =
|
13576
|
+
declare type ShowAllDownloadsEvent = BaseWindowEvent & {
|
13872
13577
|
type: 'show-all-downloads';
|
13873
13578
|
};
|
13874
13579
|
|
@@ -13876,15 +13581,7 @@ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
|
|
13876
13581
|
* Generated when a View is shown. This event will fire during creation of a View.
|
13877
13582
|
* @interface
|
13878
13583
|
*/
|
13879
|
-
declare type ShownEvent =
|
13880
|
-
type: 'shown';
|
13881
|
-
};
|
13882
|
-
|
13883
|
-
/**
|
13884
|
-
* Generated when a hidden window has been shown.
|
13885
|
-
* @interface
|
13886
|
-
*/
|
13887
|
-
declare type ShownEvent_2 = BaseEvent_5 & {
|
13584
|
+
declare type ShownEvent = BaseViewEvent & {
|
13888
13585
|
type: 'shown';
|
13889
13586
|
};
|
13890
13587
|
|
@@ -13913,15 +13610,6 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
|
|
13913
13610
|
y?: number;
|
13914
13611
|
};
|
13915
13612
|
|
13916
|
-
/**
|
13917
|
-
* Generated when a window has been prevented from showing.
|
13918
|
-
* @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.
|
13919
|
-
* @interface
|
13920
|
-
*/
|
13921
|
-
declare type ShowRequestedEvent = BaseEvent_5 & {
|
13922
|
-
type: 'show-requested';
|
13923
|
-
};
|
13924
|
-
|
13925
13613
|
/**
|
13926
13614
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
13927
13615
|
*
|
@@ -13968,21 +13656,6 @@ declare type Snapshot = {
|
|
13968
13656
|
};
|
13969
13657
|
};
|
13970
13658
|
|
13971
|
-
/**
|
13972
|
-
* Generated when a platform.ApplySnapshot call is resolved.
|
13973
|
-
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
13974
|
-
* 1. The window has been created
|
13975
|
-
* 2. The window has a responsive API
|
13976
|
-
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
13977
|
-
*
|
13978
|
-
* _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.
|
13979
|
-
* @interface
|
13980
|
-
*/
|
13981
|
-
declare type SnapshotAppliedEvent = BaseEvent & {
|
13982
|
-
topic: 'application';
|
13983
|
-
type: 'platform-snapshot-applied';
|
13984
|
-
};
|
13985
|
-
|
13986
13659
|
/**
|
13987
13660
|
* @interface
|
13988
13661
|
*/
|
@@ -14100,7 +13773,7 @@ declare class SnapshotSourceModule extends Base {
|
|
14100
13773
|
* Generated when an application has started.
|
14101
13774
|
* @interface
|
14102
13775
|
*/
|
14103
|
-
declare type StartedEvent =
|
13776
|
+
declare type StartedEvent = IdentityEvent & {
|
14104
13777
|
topic: 'application';
|
14105
13778
|
type: 'started';
|
14106
13779
|
};
|
@@ -15636,9 +15309,12 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
|
|
15636
15309
|
};
|
15637
15310
|
|
15638
15311
|
/**
|
15639
|
-
*
|
15312
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
|
15313
|
+
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
15314
|
+
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
15315
|
+
* from which they propagate).
|
15640
15316
|
*/
|
15641
|
-
declare type SystemEvent =
|
15317
|
+
declare type SystemEvent = ExcludeRequested<PropagatedWindowEvent<'system'>> | PropagatedViewEvent<'system'> | PropagatedApplicationEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
15642
15318
|
|
15643
15319
|
declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
|
15644
15320
|
|
@@ -15646,7 +15322,7 @@ declare namespace SystemEvents {
|
|
15646
15322
|
export {
|
15647
15323
|
NotRequested,
|
15648
15324
|
ExcludeRequested,
|
15649
|
-
|
15325
|
+
BaseSystemEvent,
|
15650
15326
|
IdleEvent,
|
15651
15327
|
MonitorEvent,
|
15652
15328
|
SessionChangedEvent,
|
@@ -15661,19 +15337,17 @@ declare namespace SystemEvents {
|
|
15661
15337
|
ApplicationCreatedEvent,
|
15662
15338
|
DesktopIconClickedEvent,
|
15663
15339
|
SystemShutdownEvent,
|
15664
|
-
Event_11 as Event,
|
15665
15340
|
SystemEvent,
|
15666
|
-
EventType_8 as EventType,
|
15667
15341
|
SystemEventType,
|
15668
|
-
|
15669
|
-
|
15342
|
+
Payload_7 as Payload,
|
15343
|
+
ByType_6 as ByType
|
15670
15344
|
}
|
15671
15345
|
}
|
15672
15346
|
|
15673
15347
|
/**
|
15674
|
-
*
|
15348
|
+
* Union of possible `type` values for a {@link SystemEvent}.
|
15675
15349
|
*/
|
15676
|
-
declare type SystemEventType =
|
15350
|
+
declare type SystemEventType = SystemEvent['type'];
|
15677
15351
|
|
15678
15352
|
/**
|
15679
15353
|
* @interface
|
@@ -15730,7 +15404,7 @@ declare type SystemProcessInfo = {
|
|
15730
15404
|
* Generated when system shutdown or log off.
|
15731
15405
|
* @internal
|
15732
15406
|
*/
|
15733
|
-
declare type SystemShutdownEvent =
|
15407
|
+
declare type SystemShutdownEvent = BaseSystemEvent & {
|
15734
15408
|
type: 'system-shutdown';
|
15735
15409
|
};
|
15736
15410
|
|
@@ -15983,7 +15657,7 @@ declare type TargetApp = string | AppMetadata;
|
|
15983
15657
|
* In that case, previousTarget identity will be the same as target identity.
|
15984
15658
|
* @interface
|
15985
15659
|
*/
|
15986
|
-
declare type TargetChangedEvent =
|
15660
|
+
declare type TargetChangedEvent = BaseViewEvent & {
|
15987
15661
|
type: 'target-changed';
|
15988
15662
|
previousTarget: OpenFin.Identity;
|
15989
15663
|
};
|
@@ -16137,7 +15811,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
16137
15811
|
* Generated when the tray icon is clicked.
|
16138
15812
|
* @interface
|
16139
15813
|
*/
|
16140
|
-
declare type TrayIconClickedEvent =
|
15814
|
+
declare type TrayIconClickedEvent = IdentityEvent & {
|
16141
15815
|
topic: 'application';
|
16142
15816
|
type: 'tray-icon-clicked';
|
16143
15817
|
button: 0 | 1 | 2;
|
@@ -16227,7 +15901,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
16227
15901
|
* A general user bounds change event without event type.
|
16228
15902
|
* @interface
|
16229
15903
|
*/
|
16230
|
-
declare type UserBoundsChangeEvent =
|
15904
|
+
declare type UserBoundsChangeEvent = BaseWindowEvent & {
|
16231
15905
|
height: number;
|
16232
15906
|
left: number;
|
16233
15907
|
top: number;
|
@@ -16239,7 +15913,7 @@ declare type UserBoundsChangeEvent = BaseEvent_5 & {
|
|
16239
15913
|
* Generated when a window's user movement becomes disabled.
|
16240
15914
|
* @interface
|
16241
15915
|
*/
|
16242
|
-
declare type UserMovementDisabledEvent =
|
15916
|
+
declare type UserMovementDisabledEvent = BaseWindowEvent & {
|
16243
15917
|
type: 'user-movement-disabled';
|
16244
15918
|
};
|
16245
15919
|
|
@@ -16247,7 +15921,7 @@ declare type UserMovementDisabledEvent = BaseEvent_5 & {
|
|
16247
15921
|
* Generated when a window's user movement becomes enabled.
|
16248
15922
|
* @interface
|
16249
15923
|
*/
|
16250
|
-
declare type UserMovementEnabledEvent =
|
15924
|
+
declare type UserMovementEnabledEvent = BaseWindowEvent & {
|
16251
15925
|
type: 'user-movement-enabled';
|
16252
15926
|
};
|
16253
15927
|
|
@@ -16934,7 +16608,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
16934
16608
|
* Generated when a View is attached to a window.
|
16935
16609
|
* @interface
|
16936
16610
|
*/
|
16937
|
-
declare type ViewAttachedEvent =
|
16611
|
+
declare type ViewAttachedEvent = BaseWindowEvent & {
|
16938
16612
|
type: 'view-attached';
|
16939
16613
|
target: OpenFin.Identity;
|
16940
16614
|
viewIdentity: OpenFin.Identity;
|
@@ -16976,7 +16650,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
|
|
16976
16650
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
16977
16651
|
* @interface
|
16978
16652
|
*/
|
16979
|
-
declare type ViewDetachedEvent =
|
16653
|
+
declare type ViewDetachedEvent = BaseWindowEvent & {
|
16980
16654
|
type: 'view-detached';
|
16981
16655
|
target: OpenFin.Identity;
|
16982
16656
|
previousTarget: OpenFin.Identity;
|
@@ -16984,15 +16658,18 @@ declare type ViewDetachedEvent = BaseEvent_5 & {
|
|
16984
16658
|
};
|
16985
16659
|
|
16986
16660
|
/**
|
16987
|
-
*
|
16661
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
|
16662
|
+
* discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
|
16663
|
+
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
16988
16664
|
*/
|
16989
|
-
declare type ViewEvent =
|
16665
|
+
declare type ViewEvent = (WebContentsEvent<'view'> & {
|
16666
|
+
target: OpenFin.Identity;
|
16667
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
16990
16668
|
|
16991
16669
|
declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
|
16992
16670
|
|
16993
16671
|
declare namespace ViewEvents {
|
16994
16672
|
export {
|
16995
|
-
BaseEvent_4 as BaseEvent,
|
16996
16673
|
BaseViewEvent,
|
16997
16674
|
TargetChangedEvent,
|
16998
16675
|
NonPropagatedViewEvent,
|
@@ -17002,24 +16679,20 @@ declare namespace ViewEvents {
|
|
17002
16679
|
HotkeyEvent,
|
17003
16680
|
ShownEvent,
|
17004
16681
|
HostContextChangedEvent,
|
17005
|
-
Event_4 as Event,
|
17006
16682
|
ViewEvent,
|
17007
16683
|
WillPropagateViewEvent,
|
17008
|
-
EventType,
|
17009
16684
|
ViewEventType,
|
17010
|
-
PropagatedEvent_2 as PropagatedEvent,
|
17011
16685
|
PropagatedViewEvent,
|
17012
|
-
PropagatedEventType_2 as PropagatedEventType,
|
17013
16686
|
PropagatedViewEventType,
|
17014
|
-
|
17015
|
-
ByType
|
16687
|
+
Payload_8 as Payload,
|
16688
|
+
ByType_7 as ByType
|
17016
16689
|
}
|
17017
16690
|
}
|
17018
16691
|
|
17019
16692
|
/**
|
17020
|
-
*
|
16693
|
+
* Union of possible `type` values for a {@link OpenFin.ViewEvents.ViewEvent}.
|
17021
16694
|
*/
|
17022
|
-
declare type ViewEventType =
|
16695
|
+
declare type ViewEventType = ViewEvent['type'];
|
17023
16696
|
|
17024
16697
|
/**
|
17025
16698
|
* @interface
|
@@ -18158,9 +17831,12 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
18158
17831
|
}
|
18159
17832
|
|
18160
17833
|
/**
|
18161
|
-
*
|
17834
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
17835
|
+
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
18162
17836
|
*/
|
18163
|
-
declare type WebContentsEvent<Topic extends string> =
|
17837
|
+
declare type WebContentsEvent<Topic extends string> = {
|
17838
|
+
topic: Topic;
|
17839
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
18164
17840
|
|
18165
17841
|
declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
|
18166
17842
|
|
@@ -18172,7 +17848,6 @@ declare namespace WebContentsEvents {
|
|
18172
17848
|
CrashedEvent_2 as CrashedEvent,
|
18173
17849
|
CertificateErrorEvent,
|
18174
17850
|
CertificateSelectionShownEvent,
|
18175
|
-
PageFaviconUpdatedEvent,
|
18176
17851
|
FaviconUpdatedEvent,
|
18177
17852
|
NavigationRejectedEvent,
|
18178
17853
|
UrlChangedEvent,
|
@@ -18191,7 +17866,6 @@ declare namespace WebContentsEvents {
|
|
18191
17866
|
FileDownloadStartedEvent,
|
18192
17867
|
FileDownloadProgressEvent,
|
18193
17868
|
FileDownloadCompletedEvent,
|
18194
|
-
Event_5 as Event,
|
18195
17869
|
WebContentsEvent,
|
18196
17870
|
WillPropagateWebContentsEvent,
|
18197
17871
|
NonPropagatedWebContentsEvent
|
@@ -18239,7 +17913,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
18239
17913
|
* A general will-move or will-resize event without event type.
|
18240
17914
|
* @interface
|
18241
17915
|
*/
|
18242
|
-
declare type WillMoveOrResizeEvent =
|
17916
|
+
declare type WillMoveOrResizeEvent = BaseWindowEvent & {
|
18243
17917
|
height: number;
|
18244
17918
|
left: number;
|
18245
17919
|
top: number;
|
@@ -18261,7 +17935,7 @@ declare type WillPropagateViewEvent = ViewEvent;
|
|
18261
17935
|
*
|
18262
17936
|
* A WebContents event that does propagate to (republish on) parent topics.
|
18263
17937
|
*/
|
18264
|
-
declare type WillPropagateWebContentsEvent =
|
17938
|
+
declare type WillPropagateWebContentsEvent = WebContentsEvent<string>;
|
18265
17939
|
|
18266
17940
|
/**
|
18267
17941
|
* @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
|
@@ -18275,7 +17949,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
|
|
18275
17949
|
* Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
|
18276
17950
|
* @interface
|
18277
17951
|
*/
|
18278
|
-
declare type WillRedirectEvent =
|
17952
|
+
declare type WillRedirectEvent = BaseWindowEvent & {
|
18279
17953
|
type: 'will-redirect';
|
18280
17954
|
blocked: boolean;
|
18281
17955
|
isInPlace: boolean;
|
@@ -19914,19 +19588,29 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19914
19588
|
};
|
19915
19589
|
|
19916
19590
|
/**
|
19917
|
-
*
|
19591
|
+
* Generated when a window has closed.
|
19592
|
+
* @interface
|
19918
19593
|
*/
|
19919
|
-
declare type WindowClosedEvent =
|
19594
|
+
declare type WindowClosedEvent = BaseWindowEvent & {
|
19595
|
+
type: 'closed';
|
19596
|
+
};
|
19920
19597
|
|
19921
19598
|
/**
|
19922
|
-
*
|
19599
|
+
* Generated when a window has been prevented from closing.
|
19600
|
+
* @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.
|
19601
|
+
* @interface
|
19923
19602
|
*/
|
19924
|
-
declare type WindowCloseRequestedEvent =
|
19603
|
+
declare type WindowCloseRequestedEvent = BaseWindowEvent & {
|
19604
|
+
type: 'close-requested';
|
19605
|
+
};
|
19925
19606
|
|
19926
19607
|
/**
|
19927
|
-
*
|
19608
|
+
* Generated when a window has initiated the closing routine.
|
19609
|
+
* @interface
|
19928
19610
|
*/
|
19929
|
-
declare type WindowClosingEvent =
|
19611
|
+
declare type WindowClosingEvent = BaseWindowEvent & {
|
19612
|
+
type: 'closing';
|
19613
|
+
};
|
19930
19614
|
|
19931
19615
|
/**
|
19932
19616
|
* A rule prescribing content creation in a {@link OpenFin.Window}.
|
@@ -20010,15 +19694,16 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
20010
19694
|
};
|
20011
19695
|
|
20012
19696
|
/**
|
20013
|
-
*
|
19697
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
|
19698
|
+
* discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
|
19699
|
+
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
20014
19700
|
*/
|
20015
|
-
declare type WindowEvent =
|
19701
|
+
declare type WindowEvent = WindowSourcedEvent | PropagatedViewEvent<'window'>;
|
20016
19702
|
|
20017
19703
|
declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
|
20018
19704
|
|
20019
19705
|
declare namespace WindowEvents {
|
20020
19706
|
export {
|
20021
|
-
BaseEvent_5 as BaseEvent,
|
20022
19707
|
BaseWindowEvent,
|
20023
19708
|
ViewAttachedEvent,
|
20024
19709
|
ViewDetachedEvent,
|
@@ -20028,11 +19713,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
20028
19713
|
EndLoadEvent,
|
20029
19714
|
WillRedirectEvent,
|
20030
19715
|
ReloadedEvent,
|
20031
|
-
OptionsChangedEvent,
|
20032
19716
|
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
20033
19717
|
ExternalProcessExitedEvent,
|
20034
19718
|
ExternalProcessStartedEvent,
|
20035
|
-
HiddenEvent_2 as HiddenEvent,
|
20036
19719
|
WindowHiddenEvent,
|
20037
19720
|
PreloadScriptInfoRunning,
|
20038
19721
|
PreloadScriptInfo,
|
@@ -20047,30 +19730,22 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
20047
19730
|
BeginUserBoundsChangingEvent,
|
20048
19731
|
BoundsChangedEvent,
|
20049
19732
|
BoundsChangingEvent,
|
20050
|
-
CloseRequestedEvent,
|
20051
19733
|
WindowCloseRequestedEvent,
|
20052
19734
|
ContextChangedEvent,
|
20053
|
-
ClosedEvent_2 as ClosedEvent,
|
20054
19735
|
WindowClosedEvent,
|
20055
|
-
ClosingEvent,
|
20056
19736
|
WindowClosingEvent,
|
20057
19737
|
DisabledMovementBoundsChangedEvent,
|
20058
19738
|
DisabledMovementBoundsChangingEvent,
|
20059
19739
|
EmbeddedEvent,
|
20060
19740
|
EndUserBoundsChangingEvent,
|
20061
|
-
HotkeyEvent_2 as HotkeyEvent,
|
20062
19741
|
WindowHotkeyEvent,
|
20063
|
-
InitializedEvent_2 as InitializedEvent,
|
20064
19742
|
WindowInitializedEvent,
|
20065
19743
|
MaximizedEvent,
|
20066
19744
|
MinimizedEvent,
|
20067
19745
|
PreloadScriptsStateChangedEvent,
|
20068
19746
|
PreloadScriptsStateChangingEvent,
|
20069
|
-
RestoredEvent,
|
20070
19747
|
WindowRestoredEvent,
|
20071
|
-
ShowRequestedEvent,
|
20072
19748
|
WindowShowRequestedEvent,
|
20073
|
-
ShownEvent_2 as ShownEvent,
|
20074
19749
|
WindowShownEvent,
|
20075
19750
|
UserMovementEnabledEvent,
|
20076
19751
|
UserMovementDisabledEvent,
|
@@ -20081,32 +19756,37 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
20081
19756
|
DownloadShelfVisibilityChangedEvent,
|
20082
19757
|
WindowSourcedEvent,
|
20083
19758
|
WillPropagateWindowEvent,
|
20084
|
-
Event_6 as Event,
|
20085
19759
|
WindowEvent,
|
20086
|
-
EventType_2 as EventType,
|
20087
19760
|
WindowEventType,
|
20088
|
-
PropagatedEvent_3 as PropagatedEvent,
|
20089
19761
|
PropagatedWindowEvent,
|
20090
19762
|
PropagatedWindowEventType,
|
20091
|
-
|
20092
|
-
|
19763
|
+
Payload_9 as Payload,
|
19764
|
+
ByType_8 as ByType
|
20093
19765
|
}
|
20094
19766
|
}
|
20095
19767
|
|
20096
19768
|
/**
|
20097
|
-
*
|
19769
|
+
* Union of possible `type` values for a {@link OpenFin.WindowEvents.WindowEvent}.
|
20098
19770
|
*/
|
20099
19771
|
declare type WindowEventType = WindowEvent['type'];
|
20100
19772
|
|
20101
19773
|
/**
|
20102
|
-
*
|
19774
|
+
* Generated when a window has been hidden.
|
19775
|
+
* @interface
|
20103
19776
|
*/
|
20104
|
-
declare type WindowHiddenEvent =
|
19777
|
+
declare type WindowHiddenEvent = BaseWindowEvent & {
|
19778
|
+
type: 'hidden';
|
19779
|
+
reason: 'closing' | 'hide' | 'hide-on-close';
|
19780
|
+
};
|
20105
19781
|
|
20106
19782
|
/**
|
20107
|
-
*
|
19783
|
+
* Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
|
19784
|
+
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
19785
|
+
* @interface
|
20108
19786
|
*/
|
20109
|
-
declare type WindowHotkeyEvent =
|
19787
|
+
declare type WindowHotkeyEvent = InputEvent_2 & BaseWindowEvent & {
|
19788
|
+
type: 'hotkey';
|
19789
|
+
};
|
20110
19790
|
|
20111
19791
|
/**
|
20112
19792
|
* @interface
|
@@ -20120,9 +19800,12 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
20120
19800
|
};
|
20121
19801
|
|
20122
19802
|
/**
|
20123
|
-
*
|
19803
|
+
* Generated when a window is initialized.
|
19804
|
+
* @interface
|
20124
19805
|
*/
|
20125
|
-
declare type WindowInitializedEvent =
|
19806
|
+
declare type WindowInitializedEvent = BaseWindowEvent & {
|
19807
|
+
type: 'initialized';
|
19808
|
+
};
|
20126
19809
|
|
20127
19810
|
/**
|
20128
19811
|
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
@@ -20241,9 +19924,15 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
20241
19924
|
declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
|
20242
19925
|
|
20243
19926
|
/**
|
20244
|
-
*
|
19927
|
+
* Generated after window options are changed using the window.updateOptions method.
|
19928
|
+
* @remarks Will not fire if the diff object is empty.
|
19929
|
+
* @interface
|
20245
19930
|
*/
|
20246
|
-
declare type WindowOptionsChangedEvent_2 =
|
19931
|
+
declare type WindowOptionsChangedEvent_2 = BaseWindowEvent & {
|
19932
|
+
type: 'options-changed';
|
19933
|
+
options: OpenFin.WindowOptions;
|
19934
|
+
diff: OpenFin.WindowOptionDiff;
|
19935
|
+
};
|
20247
19936
|
|
20248
19937
|
declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
|
20249
19938
|
|
@@ -20256,25 +19945,35 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
20256
19945
|
};
|
20257
19946
|
|
20258
19947
|
/**
|
20259
|
-
*
|
19948
|
+
* Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
19949
|
+
* @interface
|
20260
19950
|
*/
|
20261
|
-
declare type WindowRestoredEvent =
|
19951
|
+
declare type WindowRestoredEvent = BaseWindowEvent & {
|
19952
|
+
type: 'restored';
|
19953
|
+
};
|
20262
19954
|
|
20263
19955
|
/**
|
20264
|
-
*
|
19956
|
+
* Generated when a hidden window has been shown.
|
19957
|
+
* @interface
|
20265
19958
|
*/
|
20266
|
-
declare type WindowShownEvent =
|
19959
|
+
declare type WindowShownEvent = BaseWindowEvent & {
|
19960
|
+
type: 'shown';
|
19961
|
+
};
|
20267
19962
|
|
20268
19963
|
/**
|
20269
|
-
*
|
19964
|
+
* Generated when a window has been prevented from showing.
|
19965
|
+
* @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.
|
19966
|
+
* @interface
|
20270
19967
|
*/
|
20271
|
-
declare type WindowShowRequestedEvent =
|
19968
|
+
declare type WindowShowRequestedEvent = BaseWindowEvent & {
|
19969
|
+
type: 'show-requested';
|
19970
|
+
};
|
20272
19971
|
|
20273
19972
|
/**
|
20274
19973
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
20275
19974
|
* from {@link OpenFin.ViewEvents}.
|
20276
19975
|
*/
|
20277
|
-
declare type WindowSourcedEvent =
|
19976
|
+
declare type WindowSourcedEvent = WebContentsEvent<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | 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 | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
|
20278
19977
|
|
20279
19978
|
/**
|
20280
19979
|
* Generated when a child window starts loading.
|