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