@openfin/core 35.78.1 → 35.78.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/mock-alpha.d.ts +647 -358
- package/out/mock-beta.d.ts +647 -358
- package/out/mock-public.d.ts +647 -358
- package/out/mock.d.ts +664 -363
- package/out/mock.js +12 -0
- package/package.json +1 -1
package/out/mock-alpha.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
|
*/
|
|
@@ -856,19 +865,15 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
856
865
|
}
|
|
857
866
|
|
|
858
867
|
/**
|
|
859
|
-
*
|
|
860
|
-
* @interface
|
|
868
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
|
861
869
|
*/
|
|
862
|
-
declare type ApplicationConnectedEvent =
|
|
863
|
-
topic: 'application';
|
|
864
|
-
type: 'connected';
|
|
865
|
-
};
|
|
870
|
+
declare type ApplicationConnectedEvent = ConnectedEvent_2;
|
|
866
871
|
|
|
867
872
|
/**
|
|
868
873
|
* Generated when an application is created.
|
|
869
874
|
* @interface
|
|
870
875
|
*/
|
|
871
|
-
declare type ApplicationCreatedEvent =
|
|
876
|
+
declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
|
|
872
877
|
type: 'application-created';
|
|
873
878
|
};
|
|
874
879
|
|
|
@@ -892,17 +897,15 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
|
|
|
892
897
|
};
|
|
893
898
|
|
|
894
899
|
/**
|
|
895
|
-
*
|
|
896
|
-
* discriminated by {@link ApplicationEvent.type | their type}. Event payloads unique to `Application` can be found
|
|
897
|
-
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
898
|
-
* from which they propagate).
|
|
900
|
+
* @deprecated Renamed to {@link Event}.
|
|
899
901
|
*/
|
|
900
|
-
declare type ApplicationEvent =
|
|
902
|
+
declare type ApplicationEvent = Event_3;
|
|
901
903
|
|
|
902
904
|
declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
|
|
903
905
|
|
|
904
906
|
declare namespace ApplicationEvents {
|
|
905
907
|
export {
|
|
908
|
+
BaseEvent_3 as BaseEvent,
|
|
906
909
|
BaseApplicationEvent,
|
|
907
910
|
CrashedEvent,
|
|
908
911
|
FileDownloadLocationChangedEvent,
|
|
@@ -915,7 +918,9 @@ declare namespace ApplicationEvents {
|
|
|
915
918
|
WindowRespondingEvent,
|
|
916
919
|
WindowStartLoadEvent,
|
|
917
920
|
ApplicationWindowEvent,
|
|
921
|
+
ApplicationWindowEventTypes,
|
|
918
922
|
ClosedEvent,
|
|
923
|
+
ConnectedEvent_2 as ConnectedEvent,
|
|
919
924
|
ApplicationConnectedEvent,
|
|
920
925
|
InitializedEvent,
|
|
921
926
|
ManifestChangedEvent,
|
|
@@ -923,19 +928,23 @@ declare namespace ApplicationEvents {
|
|
|
923
928
|
RespondingEvent,
|
|
924
929
|
StartedEvent,
|
|
925
930
|
ApplicationSourcedEvent,
|
|
931
|
+
Event_3 as Event,
|
|
926
932
|
ApplicationEvent,
|
|
933
|
+
EventType_3 as EventType,
|
|
927
934
|
ApplicationEventType,
|
|
935
|
+
PropagatedEvent_4 as PropagatedEvent,
|
|
928
936
|
PropagatedApplicationEvent,
|
|
937
|
+
PropagatedEventType_3 as PropagatedEventType,
|
|
929
938
|
PropagatedApplicationEventType,
|
|
930
|
-
|
|
931
|
-
ByType
|
|
939
|
+
Payload_4 as Payload,
|
|
940
|
+
ByType_3 as ByType
|
|
932
941
|
}
|
|
933
942
|
}
|
|
934
943
|
|
|
935
944
|
/**
|
|
936
|
-
*
|
|
945
|
+
* @deprecated Renamed to {@link EventType}.
|
|
937
946
|
*/
|
|
938
|
-
declare type ApplicationEventType =
|
|
947
|
+
declare type ApplicationEventType = EventType_3;
|
|
939
948
|
|
|
940
949
|
declare type ApplicationIdentity = OpenFin_2.ApplicationIdentity;
|
|
941
950
|
|
|
@@ -1288,9 +1297,8 @@ declare type ApplicationPermissions = {
|
|
|
1288
1297
|
* A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
|
|
1289
1298
|
* from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
|
|
1290
1299
|
* does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
|
|
1291
|
-
*
|
|
1292
1300
|
*/
|
|
1293
|
-
declare type ApplicationSourcedEvent = ClosedEvent |
|
|
1301
|
+
declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
|
1294
1302
|
|
|
1295
1303
|
declare type ApplicationState = OpenFin_2.ApplicationState;
|
|
1296
1304
|
|
|
@@ -1329,6 +1337,11 @@ declare type ApplicationType = {
|
|
|
1329
1337
|
*/
|
|
1330
1338
|
declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
|
|
1331
1339
|
|
|
1340
|
+
/**
|
|
1341
|
+
* Array of valid `type` values for an {@link ApplicationWindowEvent}.
|
|
1342
|
+
*/
|
|
1343
|
+
declare const ApplicationWindowEventTypes: readonly ["window-alert-requested", "window-created", "window-end-load", "window-not-responding", "window-responding", "window-start-load"];
|
|
1344
|
+
|
|
1332
1345
|
declare type ApplicationWindowInfo = OpenFin_2.ApplicationWindowInfo;
|
|
1333
1346
|
|
|
1334
1347
|
/**
|
|
@@ -1598,7 +1611,7 @@ declare interface AuthorizationPayload {
|
|
|
1598
1611
|
* ```
|
|
1599
1612
|
* @interface
|
|
1600
1613
|
*/
|
|
1601
|
-
declare type AuthRequestedEvent =
|
|
1614
|
+
declare type AuthRequestedEvent = BaseEvent_5 & {
|
|
1602
1615
|
type: 'auth-requested';
|
|
1603
1616
|
authInfo: {
|
|
1604
1617
|
host: string;
|
|
@@ -1660,21 +1673,9 @@ declare class Base {
|
|
|
1660
1673
|
}
|
|
1661
1674
|
|
|
1662
1675
|
/**
|
|
1663
|
-
*
|
|
1664
|
-
* @interface
|
|
1665
|
-
*/
|
|
1666
|
-
declare type BaseApplicationEvent = NamedEvent & {
|
|
1667
|
-
topic: `application`;
|
|
1668
|
-
};
|
|
1669
|
-
|
|
1670
|
-
/**
|
|
1671
|
-
* A base Channel event.
|
|
1672
|
-
* @interface
|
|
1676
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1673
1677
|
*/
|
|
1674
|
-
declare type
|
|
1675
|
-
channelName: string;
|
|
1676
|
-
channelId: string;
|
|
1677
|
-
};
|
|
1678
|
+
declare type BaseApplicationEvent = BaseEvent_3;
|
|
1678
1679
|
|
|
1679
1680
|
/**
|
|
1680
1681
|
* @interface
|
|
@@ -1743,10 +1744,70 @@ declare type BaseEvent = {
|
|
|
1743
1744
|
type: string;
|
|
1744
1745
|
};
|
|
1745
1746
|
|
|
1746
|
-
|
|
1747
|
+
/**
|
|
1748
|
+
* A base Channel event.
|
|
1749
|
+
* @interface
|
|
1750
|
+
*/
|
|
1751
|
+
declare type BaseEvent_2 = NamedEvent & {
|
|
1752
|
+
channelName: string;
|
|
1753
|
+
channelId: string;
|
|
1754
|
+
};
|
|
1755
|
+
|
|
1756
|
+
/**
|
|
1757
|
+
* Base type for events emitting on the `application` topic
|
|
1758
|
+
* @interface
|
|
1759
|
+
*/
|
|
1760
|
+
declare type BaseEvent_3 = BaseEvents.NamedEvent & {
|
|
1761
|
+
topic: `application`;
|
|
1762
|
+
};
|
|
1763
|
+
|
|
1764
|
+
/**
|
|
1765
|
+
* Base type for events emitting on the `view` topic
|
|
1766
|
+
* @interface
|
|
1767
|
+
*/
|
|
1768
|
+
declare type BaseEvent_4 = BaseEvents.NamedEvent & {
|
|
1769
|
+
topic: 'view';
|
|
1770
|
+
target: OpenFin_2.Identity;
|
|
1771
|
+
};
|
|
1772
|
+
|
|
1773
|
+
/**
|
|
1774
|
+
* Base type for events emitting on the `window` topic
|
|
1775
|
+
* @interface
|
|
1776
|
+
*/
|
|
1777
|
+
declare type BaseEvent_5 = BaseEvents.NamedEvent & {
|
|
1778
|
+
topic: 'window';
|
|
1779
|
+
};
|
|
1780
|
+
|
|
1781
|
+
/**
|
|
1782
|
+
* Base type for events emitting on the `externalapplication` topic
|
|
1783
|
+
* @interface
|
|
1784
|
+
*/
|
|
1785
|
+
declare type BaseEvent_6 = BaseEvents.BaseEvent & {
|
|
1786
|
+
topic: 'externalapplication';
|
|
1787
|
+
};
|
|
1788
|
+
|
|
1789
|
+
/**
|
|
1790
|
+
* The base frame event.
|
|
1791
|
+
* @interface
|
|
1792
|
+
*/
|
|
1793
|
+
declare type BaseEvent_7 = NamedEvent & {
|
|
1794
|
+
entityType: 'iframe';
|
|
1795
|
+
frameName: string;
|
|
1796
|
+
};
|
|
1797
|
+
|
|
1798
|
+
/**
|
|
1799
|
+
* Base type for events emitting on the `system` topic
|
|
1800
|
+
* @interface
|
|
1801
|
+
*/
|
|
1802
|
+
declare type BaseEvent_8 = BaseEvents.BaseEvent & {
|
|
1803
|
+
topic: 'system';
|
|
1804
|
+
};
|
|
1805
|
+
|
|
1806
|
+
declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
|
|
1747
1807
|
|
|
1748
1808
|
declare namespace BaseEvents {
|
|
1749
1809
|
export {
|
|
1810
|
+
NotCloseRequested,
|
|
1750
1811
|
PropagatedEventType,
|
|
1751
1812
|
PropagatedEvent,
|
|
1752
1813
|
EventHandler,
|
|
@@ -1757,21 +1818,14 @@ declare namespace BaseEvents {
|
|
|
1757
1818
|
}
|
|
1758
1819
|
|
|
1759
1820
|
/**
|
|
1760
|
-
*
|
|
1761
|
-
* @interface
|
|
1821
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1762
1822
|
*/
|
|
1763
|
-
declare type BaseExternalApplicationEvent =
|
|
1764
|
-
topic: 'externalapplication';
|
|
1765
|
-
};
|
|
1823
|
+
declare type BaseExternalApplicationEvent = BaseEvent_6;
|
|
1766
1824
|
|
|
1767
1825
|
/**
|
|
1768
|
-
*
|
|
1769
|
-
* @interface
|
|
1826
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1770
1827
|
*/
|
|
1771
|
-
declare type BaseFrameEvent =
|
|
1772
|
-
entityType: 'iframe';
|
|
1773
|
-
frameName: string;
|
|
1774
|
-
};
|
|
1828
|
+
declare type BaseFrameEvent = BaseEvent_7;
|
|
1775
1829
|
|
|
1776
1830
|
declare type BaseLoadFailedEvent = NamedEvent & {
|
|
1777
1831
|
errorCode: number;
|
|
@@ -1780,35 +1834,20 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
|
1780
1834
|
isMainFrame: boolean;
|
|
1781
1835
|
};
|
|
1782
1836
|
|
|
1783
|
-
/**
|
|
1784
|
-
* Base type for events emitting on the `system` topic
|
|
1785
|
-
* @interface
|
|
1786
|
-
*/
|
|
1787
|
-
declare type BaseSystemEvent = BaseEvent & {
|
|
1788
|
-
topic: 'system';
|
|
1789
|
-
};
|
|
1790
|
-
|
|
1791
1837
|
declare type BaseUrlEvent = NamedEvent & {
|
|
1792
1838
|
type: 'url-changed';
|
|
1793
1839
|
url: string;
|
|
1794
1840
|
};
|
|
1795
1841
|
|
|
1796
1842
|
/**
|
|
1797
|
-
*
|
|
1798
|
-
* @interface
|
|
1843
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1799
1844
|
*/
|
|
1800
|
-
declare type BaseViewEvent =
|
|
1801
|
-
topic: 'view';
|
|
1802
|
-
target: OpenFin_2.Identity;
|
|
1803
|
-
};
|
|
1845
|
+
declare type BaseViewEvent = BaseEvent_4;
|
|
1804
1846
|
|
|
1805
1847
|
/**
|
|
1806
|
-
*
|
|
1807
|
-
* @interface
|
|
1848
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1808
1849
|
*/
|
|
1809
|
-
declare type BaseWindowEvent =
|
|
1810
|
-
topic: 'window';
|
|
1811
|
-
};
|
|
1850
|
+
declare type BaseWindowEvent = BaseEvent_5;
|
|
1812
1851
|
|
|
1813
1852
|
/**
|
|
1814
1853
|
* User decision of whether a Window or specific View should close when trying to prevent an unload.
|
|
@@ -1875,7 +1914,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
|
1875
1914
|
* A general bounds change event without event type.
|
|
1876
1915
|
* @interface
|
|
1877
1916
|
*/
|
|
1878
|
-
declare type BoundsChangeEvent =
|
|
1917
|
+
declare type BoundsChangeEvent = BaseEvent_5 & {
|
|
1879
1918
|
changeType: 0 | 1 | 2;
|
|
1880
1919
|
deferred: boolean;
|
|
1881
1920
|
height: number;
|
|
@@ -1947,76 +1986,76 @@ declare interface BrowserWindow {
|
|
|
1947
1986
|
}
|
|
1948
1987
|
|
|
1949
1988
|
/**
|
|
1950
|
-
* Extracts a single event type matching the given key from the {@link
|
|
1989
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
1951
1990
|
*
|
|
1952
1991
|
* Alias for {@link Payload}, which may read better in source.
|
|
1953
1992
|
*
|
|
1954
1993
|
* @typeParam Type String key specifying the event to extract
|
|
1955
1994
|
*/
|
|
1956
|
-
declare type ByType<Type extends
|
|
1995
|
+
declare type ByType<Type extends EventType> = Payload_2<Type>;
|
|
1957
1996
|
|
|
1958
1997
|
/**
|
|
1959
|
-
* Extracts a single event type matching the given key from the {@link
|
|
1998
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
1960
1999
|
*
|
|
1961
2000
|
* Alias for {@link Payload}, which may read better in source.
|
|
1962
2001
|
*
|
|
1963
2002
|
* @typeParam Type String key specifying the event to extract
|
|
1964
2003
|
*/
|
|
1965
|
-
declare type ByType_2<Type extends
|
|
2004
|
+
declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
|
1966
2005
|
|
|
1967
2006
|
/**
|
|
1968
|
-
* Extracts a single event type matching the given key from the {@link
|
|
2007
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
1969
2008
|
*
|
|
1970
2009
|
* Alias for {@link Payload}, which may read better in source.
|
|
1971
2010
|
*
|
|
1972
2011
|
* @typeParam Type String key specifying the event to extract
|
|
1973
2012
|
*/
|
|
1974
|
-
declare type ByType_3<Type extends
|
|
2013
|
+
declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
|
1975
2014
|
|
|
1976
2015
|
/**
|
|
1977
|
-
* Extracts a single event type matching the given key from the {@link
|
|
2016
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
1978
2017
|
*
|
|
1979
2018
|
* Alias for {@link Payload}, which may read better in source.
|
|
1980
2019
|
*
|
|
1981
2020
|
* @typeParam Type String key specifying the event to extract
|
|
1982
2021
|
*/
|
|
1983
|
-
declare type ByType_4<Type extends
|
|
2022
|
+
declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
|
1984
2023
|
|
|
1985
2024
|
/**
|
|
1986
|
-
* Extracts a single event type matching the given key from the {@link
|
|
2025
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
1987
2026
|
*
|
|
1988
2027
|
* Alias for {@link Payload}, which may read better in source.
|
|
1989
2028
|
*
|
|
1990
2029
|
* @typeParam Type String key specifying the event to extract
|
|
1991
2030
|
*/
|
|
1992
|
-
declare type ByType_5<Type extends
|
|
2031
|
+
declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
|
1993
2032
|
|
|
1994
2033
|
/**
|
|
1995
|
-
* Extracts a single event type matching the given key from the {@link
|
|
2034
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
1996
2035
|
*
|
|
1997
2036
|
* Alias for {@link Payload}, which may read better in source.
|
|
1998
2037
|
*
|
|
1999
2038
|
* @typeParam Type String key specifying the event to extract
|
|
2000
2039
|
*/
|
|
2001
|
-
declare type ByType_6<Type extends
|
|
2040
|
+
declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
|
2002
2041
|
|
|
2003
2042
|
/**
|
|
2004
|
-
* Extracts a single event type matching the given key from the {@link
|
|
2043
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
2005
2044
|
*
|
|
2006
2045
|
* Alias for {@link Payload}, which may read better in source.
|
|
2007
2046
|
*
|
|
2008
2047
|
* @typeParam Type String key specifying the event to extract
|
|
2009
2048
|
*/
|
|
2010
|
-
declare type ByType_7<Type extends
|
|
2049
|
+
declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
|
2011
2050
|
|
|
2012
2051
|
/**
|
|
2013
|
-
* Extracts a single event type matching the given key from the {@link
|
|
2052
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
2014
2053
|
*
|
|
2015
2054
|
* Alias for {@link Payload}, which may read better in source.
|
|
2016
2055
|
*
|
|
2017
2056
|
* @typeParam Type String key specifying the event to extract
|
|
2018
2057
|
*/
|
|
2019
|
-
declare type ByType_8<Type extends
|
|
2058
|
+
declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
|
2020
2059
|
|
|
2021
2060
|
/**
|
|
2022
2061
|
* Configuration for page capture.
|
|
@@ -2682,14 +2721,6 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
|
|
|
2682
2721
|
|
|
2683
2722
|
declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
|
|
2684
2723
|
|
|
2685
|
-
/**
|
|
2686
|
-
* Generated when a Channel client is connected.
|
|
2687
|
-
* @interface
|
|
2688
|
-
*/
|
|
2689
|
-
declare type ChannelConnectedEvent = BaseChannelEvent & {
|
|
2690
|
-
type: 'connected';
|
|
2691
|
-
};
|
|
2692
|
-
|
|
2693
2724
|
/**
|
|
2694
2725
|
* Options provided on a client connection to a channel.
|
|
2695
2726
|
*
|
|
@@ -2721,21 +2752,9 @@ declare type ChannelCreateOptions = {
|
|
|
2721
2752
|
};
|
|
2722
2753
|
|
|
2723
2754
|
/**
|
|
2724
|
-
*
|
|
2725
|
-
* @interface
|
|
2755
|
+
* @deprecated Renamed to {@link Event}.
|
|
2726
2756
|
*/
|
|
2727
|
-
declare type
|
|
2728
|
-
type: 'disconnected';
|
|
2729
|
-
};
|
|
2730
|
-
|
|
2731
|
-
/**
|
|
2732
|
-
* [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
|
|
2733
|
-
* discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
|
|
2734
|
-
* under the {@link OpenFin.ChannelEvents} namespace.
|
|
2735
|
-
*/
|
|
2736
|
-
declare type ChannelEvent = {
|
|
2737
|
-
topic: 'channel';
|
|
2738
|
-
} & (ChannelConnectedEvent | ChannelDisconnectedEvent);
|
|
2757
|
+
declare type ChannelEvent = Event_2;
|
|
2739
2758
|
|
|
2740
2759
|
declare type ChannelMiddleware = OpenFin_2.ChannelMiddleware;
|
|
2741
2760
|
|
|
@@ -3270,11 +3289,19 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
|
|
|
3270
3289
|
* Generated when an application is closed.
|
|
3271
3290
|
* @interface
|
|
3272
3291
|
*/
|
|
3273
|
-
declare type ClosedEvent = IdentityEvent & {
|
|
3292
|
+
declare type ClosedEvent = BaseEvents.IdentityEvent & {
|
|
3274
3293
|
topic: 'application';
|
|
3275
3294
|
type: 'closed';
|
|
3276
3295
|
};
|
|
3277
3296
|
|
|
3297
|
+
/**
|
|
3298
|
+
* Generated when a window has closed.
|
|
3299
|
+
* @interface
|
|
3300
|
+
*/
|
|
3301
|
+
declare type ClosedEvent_2 = BaseEvent_5 & {
|
|
3302
|
+
type: 'closed';
|
|
3303
|
+
};
|
|
3304
|
+
|
|
3278
3305
|
/**
|
|
3279
3306
|
* @interface
|
|
3280
3307
|
*/
|
|
@@ -3282,6 +3309,15 @@ declare type ClosedMenuResult = {
|
|
|
3282
3309
|
result: 'closed';
|
|
3283
3310
|
};
|
|
3284
3311
|
|
|
3312
|
+
/**
|
|
3313
|
+
* Generated when a window has been prevented from closing.
|
|
3314
|
+
* @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.
|
|
3315
|
+
* @interface
|
|
3316
|
+
*/
|
|
3317
|
+
declare type CloseRequestedEvent = BaseEvent_5 & {
|
|
3318
|
+
type: 'close-requested';
|
|
3319
|
+
};
|
|
3320
|
+
|
|
3285
3321
|
/**
|
|
3286
3322
|
* @interface
|
|
3287
3323
|
*/
|
|
@@ -3328,6 +3364,14 @@ declare interface CloseWindowPayload {
|
|
|
3328
3364
|
};
|
|
3329
3365
|
}
|
|
3330
3366
|
|
|
3367
|
+
/**
|
|
3368
|
+
* Generated when a window has initiated the closing routine.
|
|
3369
|
+
* @interface
|
|
3370
|
+
*/
|
|
3371
|
+
declare type ClosingEvent = BaseEvent_5 & {
|
|
3372
|
+
type: 'closing';
|
|
3373
|
+
};
|
|
3374
|
+
|
|
3331
3375
|
/**
|
|
3332
3376
|
* A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
|
|
3333
3377
|
*/
|
|
@@ -3407,6 +3451,39 @@ declare type ConfigWithUuid = BaseConfig & {
|
|
|
3407
3451
|
uuid: string;
|
|
3408
3452
|
};
|
|
3409
3453
|
|
|
3454
|
+
/**
|
|
3455
|
+
* Generated when a Channel client is connected.
|
|
3456
|
+
* @interface
|
|
3457
|
+
*/
|
|
3458
|
+
declare type ConnectedEvent = BaseEvent_2 & {
|
|
3459
|
+
type: 'connected';
|
|
3460
|
+
};
|
|
3461
|
+
|
|
3462
|
+
/**
|
|
3463
|
+
* Generated when an application has authenticated and is connected.
|
|
3464
|
+
* @interface
|
|
3465
|
+
*/
|
|
3466
|
+
declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
|
|
3467
|
+
topic: 'application';
|
|
3468
|
+
type: 'connected';
|
|
3469
|
+
};
|
|
3470
|
+
|
|
3471
|
+
/**
|
|
3472
|
+
* Generated when an external application has authenticated and is connected.
|
|
3473
|
+
* @interface
|
|
3474
|
+
*/
|
|
3475
|
+
declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
|
|
3476
|
+
type: 'connected';
|
|
3477
|
+
};
|
|
3478
|
+
|
|
3479
|
+
/**
|
|
3480
|
+
* Generated when a frame is connected.
|
|
3481
|
+
* @interface
|
|
3482
|
+
*/
|
|
3483
|
+
declare type ConnectedEvent_4 = BaseFrameEvent & {
|
|
3484
|
+
type: 'connected';
|
|
3485
|
+
};
|
|
3486
|
+
|
|
3410
3487
|
declare type Constructor<T = {}> = new () => T;
|
|
3411
3488
|
|
|
3412
3489
|
declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
|
@@ -4148,7 +4225,7 @@ declare type Context_3 = {
|
|
|
4148
4225
|
* Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
|
|
4149
4226
|
* @interface
|
|
4150
4227
|
*/
|
|
4151
|
-
declare type ContextChangedEvent =
|
|
4228
|
+
declare type ContextChangedEvent = BaseEvent_5 & {
|
|
4152
4229
|
type: 'context-changed';
|
|
4153
4230
|
context: any;
|
|
4154
4231
|
};
|
|
@@ -4300,7 +4377,7 @@ declare type CpuInfo = {
|
|
|
4300
4377
|
* Generated when an application has crashed.
|
|
4301
4378
|
* @interface
|
|
4302
4379
|
*/
|
|
4303
|
-
declare type CrashedEvent = IdentityEvent & {
|
|
4380
|
+
declare type CrashedEvent = BaseEvents.IdentityEvent & {
|
|
4304
4381
|
topic: 'application';
|
|
4305
4382
|
type: 'crashed';
|
|
4306
4383
|
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
|
@@ -4351,7 +4428,7 @@ declare type CrashReporterState = CrashReporterOptions & {
|
|
|
4351
4428
|
* Generated when a View is created.
|
|
4352
4429
|
* @interface
|
|
4353
4430
|
*/
|
|
4354
|
-
declare type CreatedEvent =
|
|
4431
|
+
declare type CreatedEvent = BaseEvent_4 & {
|
|
4355
4432
|
type: 'created';
|
|
4356
4433
|
};
|
|
4357
4434
|
|
|
@@ -4510,7 +4587,7 @@ declare interface DesktopAgent_2 {
|
|
|
4510
4587
|
* Generated when the desktop icon is clicked while it's already running.
|
|
4511
4588
|
* @interface
|
|
4512
4589
|
*/
|
|
4513
|
-
declare type DesktopIconClickedEvent =
|
|
4590
|
+
declare type DesktopIconClickedEvent = BaseEvent_8 & {
|
|
4514
4591
|
type: 'desktop-icon-clicked';
|
|
4515
4592
|
};
|
|
4516
4593
|
|
|
@@ -4518,7 +4595,7 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
|
|
|
4518
4595
|
* Generated when a View is destroyed.
|
|
4519
4596
|
* @interface
|
|
4520
4597
|
*/
|
|
4521
|
-
declare type DestroyedEvent =
|
|
4598
|
+
declare type DestroyedEvent = BaseEvent_4 & {
|
|
4522
4599
|
type: 'destroyed';
|
|
4523
4600
|
};
|
|
4524
4601
|
|
|
@@ -4618,6 +4695,30 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
|
4618
4695
|
type: 'disabled-movement-bounds-changing';
|
|
4619
4696
|
};
|
|
4620
4697
|
|
|
4698
|
+
/**
|
|
4699
|
+
* Generated when a Channel client has disconnected.
|
|
4700
|
+
* @interface
|
|
4701
|
+
*/
|
|
4702
|
+
declare type DisconnectedEvent = BaseEvent_2 & {
|
|
4703
|
+
type: 'disconnected';
|
|
4704
|
+
};
|
|
4705
|
+
|
|
4706
|
+
/**
|
|
4707
|
+
* Generated when an external application has disconnected.
|
|
4708
|
+
* @interface
|
|
4709
|
+
*/
|
|
4710
|
+
declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
|
|
4711
|
+
type: 'disconnected';
|
|
4712
|
+
};
|
|
4713
|
+
|
|
4714
|
+
/**
|
|
4715
|
+
* Generated when a frame has disconnected.
|
|
4716
|
+
* @interface
|
|
4717
|
+
*/
|
|
4718
|
+
declare type DisconnectedEvent_3 = BaseFrameEvent & {
|
|
4719
|
+
type: 'disconnected';
|
|
4720
|
+
};
|
|
4721
|
+
|
|
4621
4722
|
/**
|
|
4622
4723
|
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
|
4623
4724
|
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
|
@@ -4751,7 +4852,7 @@ declare type DownloadShelfOptions = {
|
|
|
4751
4852
|
*
|
|
4752
4853
|
* @interface
|
|
4753
4854
|
*/
|
|
4754
|
-
declare type DownloadShelfVisibilityChangedEvent =
|
|
4855
|
+
declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
|
|
4755
4856
|
type: 'download-shelf-visibility-changed';
|
|
4756
4857
|
/**
|
|
4757
4858
|
* True if the download shelf was just opened; false if it was just closed.
|
|
@@ -4781,7 +4882,7 @@ declare interface DragSource {}
|
|
|
4781
4882
|
* Generated when a window has been embedded.
|
|
4782
4883
|
* @interface
|
|
4783
4884
|
*/
|
|
4784
|
-
declare type EmbeddedEvent =
|
|
4885
|
+
declare type EmbeddedEvent = BaseEvent_5 & {
|
|
4785
4886
|
type: 'embedded';
|
|
4786
4887
|
};
|
|
4787
4888
|
|
|
@@ -4880,7 +4981,7 @@ declare class EmitterMap {
|
|
|
4880
4981
|
* Generated when a window ends loading.
|
|
4881
4982
|
* @interface
|
|
4882
4983
|
*/
|
|
4883
|
-
declare type EndLoadEvent =
|
|
4984
|
+
declare type EndLoadEvent = BaseEvent_5 & {
|
|
4884
4985
|
type: 'end-load';
|
|
4885
4986
|
documentName: string;
|
|
4886
4987
|
isMain: boolean;
|
|
@@ -4997,6 +5098,88 @@ declare type ErrorPlainObject = {
|
|
|
4997
5098
|
toString(): string;
|
|
4998
5099
|
};
|
|
4999
5100
|
|
|
5101
|
+
/**
|
|
5102
|
+
* [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
|
|
5103
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
|
|
5104
|
+
* under the {@link OpenFin.PlatformEvents} namespace.
|
|
5105
|
+
*/
|
|
5106
|
+
declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
|
|
5107
|
+
|
|
5108
|
+
/**
|
|
5109
|
+
* [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
|
|
5110
|
+
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
|
5111
|
+
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
5112
|
+
* from which they propagate).
|
|
5113
|
+
*/
|
|
5114
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ViewEvents.PropagatedEvent<'system'> | ApplicationEvents.PropagatedEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
|
5115
|
+
|
|
5116
|
+
/**
|
|
5117
|
+
* [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
|
|
5118
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
|
|
5119
|
+
* under the {@link OpenFin.ChannelEvents} namespace.
|
|
5120
|
+
*/
|
|
5121
|
+
declare type Event_2 = {
|
|
5122
|
+
topic: 'channel';
|
|
5123
|
+
} & (ConnectedEvent | DisconnectedEvent);
|
|
5124
|
+
|
|
5125
|
+
/**
|
|
5126
|
+
* [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
|
|
5127
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
|
|
5128
|
+
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
5129
|
+
* from which they propagate).
|
|
5130
|
+
*/
|
|
5131
|
+
declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
|
|
5132
|
+
|
|
5133
|
+
/**
|
|
5134
|
+
* [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
|
|
5135
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
|
|
5136
|
+
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
|
5137
|
+
*/
|
|
5138
|
+
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
5139
|
+
target: OpenFin_2.Identity;
|
|
5140
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
|
5141
|
+
|
|
5142
|
+
/**
|
|
5143
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
|
5144
|
+
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
|
5145
|
+
*/
|
|
5146
|
+
declare type Event_5<Topic extends string> = {
|
|
5147
|
+
topic: Topic;
|
|
5148
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
|
5149
|
+
|
|
5150
|
+
/**
|
|
5151
|
+
* [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
|
|
5152
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
|
|
5153
|
+
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
|
5154
|
+
*/
|
|
5155
|
+
declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
|
|
5156
|
+
|
|
5157
|
+
/**
|
|
5158
|
+
* [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
|
|
5159
|
+
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
|
5160
|
+
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
|
5161
|
+
*/
|
|
5162
|
+
declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
|
|
5163
|
+
|
|
5164
|
+
/**
|
|
5165
|
+
* [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
|
|
5166
|
+
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
|
5167
|
+
* under the {@link OpenFin.FrameEvents} namespace.
|
|
5168
|
+
*/
|
|
5169
|
+
declare type Event_8 = {
|
|
5170
|
+
topic: 'frame';
|
|
5171
|
+
} & (ConnectedEvent_4 | DisconnectedEvent_3);
|
|
5172
|
+
|
|
5173
|
+
/**
|
|
5174
|
+
* [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
|
|
5175
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
|
5176
|
+
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
|
5177
|
+
*/
|
|
5178
|
+
declare type Event_9 = {
|
|
5179
|
+
topic: 'global-hotkey';
|
|
5180
|
+
hotkey: 'string';
|
|
5181
|
+
} & (RegisteredEvent | UnregisteredEvent);
|
|
5182
|
+
|
|
5000
5183
|
declare class EventAggregator extends EmitterMap {
|
|
5001
5184
|
dispatchEvent: (message: Message<any>) => boolean;
|
|
5002
5185
|
}
|
|
@@ -5062,6 +5245,46 @@ declare namespace Events {
|
|
|
5062
5245
|
}
|
|
5063
5246
|
}
|
|
5064
5247
|
|
|
5248
|
+
/**
|
|
5249
|
+
* Union of possible `type` values for a view {@link Event}.
|
|
5250
|
+
*/
|
|
5251
|
+
declare type EventType = Event_4['type'];
|
|
5252
|
+
|
|
5253
|
+
/**
|
|
5254
|
+
* Union of possible `type` values for a Window {@link Event}.
|
|
5255
|
+
*/
|
|
5256
|
+
declare type EventType_2 = Event_6['type'];
|
|
5257
|
+
|
|
5258
|
+
/**
|
|
5259
|
+
* Union of possible `type` values for an Application {@link Event}.
|
|
5260
|
+
*/
|
|
5261
|
+
declare type EventType_3 = Event_3['type'];
|
|
5262
|
+
|
|
5263
|
+
/**
|
|
5264
|
+
* Union of possible `type` values for an ExternalApplication {@link Event}.
|
|
5265
|
+
*/
|
|
5266
|
+
declare type EventType_4 = Event_7['type'];
|
|
5267
|
+
|
|
5268
|
+
/**
|
|
5269
|
+
* Union of possible `type` values for a {@link FrameEvent}.
|
|
5270
|
+
*/
|
|
5271
|
+
declare type EventType_5 = Event_8['type'];
|
|
5272
|
+
|
|
5273
|
+
/**
|
|
5274
|
+
* Union of possible `type` values for a {@link GlobalHotkeyEvent}
|
|
5275
|
+
*/
|
|
5276
|
+
declare type EventType_6 = Event_9['type'];
|
|
5277
|
+
|
|
5278
|
+
/**
|
|
5279
|
+
* Union of possible `type` values for a {@link PlatformEvent}.
|
|
5280
|
+
*/
|
|
5281
|
+
declare type EventType_7 = Event_10['type'];
|
|
5282
|
+
|
|
5283
|
+
/**
|
|
5284
|
+
* Union of possible `type` values for a {@link SystemEvent}.
|
|
5285
|
+
*/
|
|
5286
|
+
declare type EventType_8 = SystemEvent['type'];
|
|
5287
|
+
|
|
5065
5288
|
/* Excluded from this release type: EventWithId */
|
|
5066
5289
|
|
|
5067
5290
|
/* Excluded from this release type: ExcludeRequested */
|
|
@@ -5185,46 +5408,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
|
|
|
5185
5408
|
}
|
|
5186
5409
|
|
|
5187
5410
|
/**
|
|
5188
|
-
*
|
|
5189
|
-
* @interface
|
|
5411
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
|
5190
5412
|
*/
|
|
5191
|
-
declare type ExternalApplicationConnectedEvent =
|
|
5192
|
-
type: 'connected';
|
|
5193
|
-
};
|
|
5413
|
+
declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
|
|
5194
5414
|
|
|
5195
5415
|
/**
|
|
5196
|
-
*
|
|
5197
|
-
* @interface
|
|
5416
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
|
5198
5417
|
*/
|
|
5199
|
-
declare type ExternalApplicationDisconnectedEvent =
|
|
5200
|
-
type: 'disconnected';
|
|
5201
|
-
};
|
|
5418
|
+
declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
|
|
5202
5419
|
|
|
5203
5420
|
/**
|
|
5204
|
-
*
|
|
5205
|
-
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
|
5206
|
-
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
|
5421
|
+
* @deprecated Renamed to {@link Event}.
|
|
5207
5422
|
*/
|
|
5208
|
-
declare type ExternalApplicationEvent =
|
|
5423
|
+
declare type ExternalApplicationEvent = Event_7;
|
|
5209
5424
|
|
|
5210
5425
|
declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
|
|
5211
5426
|
|
|
5212
5427
|
declare namespace ExternalApplicationEvents {
|
|
5213
5428
|
export {
|
|
5429
|
+
BaseEvent_6 as BaseEvent,
|
|
5214
5430
|
BaseExternalApplicationEvent,
|
|
5431
|
+
ConnectedEvent_3 as ConnectedEvent,
|
|
5215
5432
|
ExternalApplicationConnectedEvent,
|
|
5433
|
+
DisconnectedEvent_2 as DisconnectedEvent,
|
|
5216
5434
|
ExternalApplicationDisconnectedEvent,
|
|
5435
|
+
Event_7 as Event,
|
|
5217
5436
|
ExternalApplicationEvent,
|
|
5437
|
+
EventType_4 as EventType,
|
|
5218
5438
|
ExternalApplicationEventType,
|
|
5219
|
-
|
|
5220
|
-
|
|
5439
|
+
Payload_5 as Payload,
|
|
5440
|
+
ByType_4 as ByType
|
|
5221
5441
|
}
|
|
5222
5442
|
}
|
|
5223
5443
|
|
|
5224
5444
|
/**
|
|
5225
|
-
*
|
|
5445
|
+
* @deprecated Renamed to {@link Event}.
|
|
5226
5446
|
*/
|
|
5227
|
-
declare type ExternalApplicationEventType =
|
|
5447
|
+
declare type ExternalApplicationEventType = EventType_4;
|
|
5228
5448
|
|
|
5229
5449
|
/**
|
|
5230
5450
|
* @interface
|
|
@@ -5285,7 +5505,7 @@ declare type ExternalConnection = {
|
|
|
5285
5505
|
* Generated when an external process has exited.
|
|
5286
5506
|
* @interface
|
|
5287
5507
|
*/
|
|
5288
|
-
declare type ExternalProcessExitedEvent =
|
|
5508
|
+
declare type ExternalProcessExitedEvent = BaseEvent_5 & {
|
|
5289
5509
|
type: 'external-process-exited';
|
|
5290
5510
|
processUuid: string;
|
|
5291
5511
|
exitCode: number;
|
|
@@ -5330,19 +5550,15 @@ declare type ExternalProcessRequestType = {
|
|
|
5330
5550
|
* Generated when an external process has started.
|
|
5331
5551
|
* @interface
|
|
5332
5552
|
*/
|
|
5333
|
-
declare type ExternalProcessStartedEvent =
|
|
5553
|
+
declare type ExternalProcessStartedEvent = BaseEvent_5 & {
|
|
5334
5554
|
type: 'external-process-started';
|
|
5335
5555
|
processUuid: string;
|
|
5336
5556
|
};
|
|
5337
5557
|
|
|
5338
5558
|
/**
|
|
5339
|
-
*
|
|
5340
|
-
* @interface
|
|
5559
|
+
* @deprecated, use {@link PageFaviconUpdatedEvent}.
|
|
5341
5560
|
*/
|
|
5342
|
-
declare type FaviconUpdatedEvent =
|
|
5343
|
-
type: 'page-favicon-updated';
|
|
5344
|
-
favicons: string[];
|
|
5345
|
-
};
|
|
5561
|
+
declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
|
|
5346
5562
|
|
|
5347
5563
|
declare namespace FDC3 {
|
|
5348
5564
|
export {
|
|
@@ -5698,48 +5914,43 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
|
|
|
5698
5914
|
}
|
|
5699
5915
|
|
|
5700
5916
|
/**
|
|
5701
|
-
*
|
|
5702
|
-
* @interface
|
|
5917
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
|
5703
5918
|
*/
|
|
5704
|
-
declare type FrameConnectedEvent =
|
|
5705
|
-
type: 'connected';
|
|
5706
|
-
};
|
|
5919
|
+
declare type FrameConnectedEvent = ConnectedEvent_4;
|
|
5707
5920
|
|
|
5708
5921
|
/**
|
|
5709
|
-
*
|
|
5710
|
-
* @interface
|
|
5922
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
|
5711
5923
|
*/
|
|
5712
|
-
declare type FrameDisconnectedEvent =
|
|
5713
|
-
type: 'disconnected';
|
|
5714
|
-
};
|
|
5924
|
+
declare type FrameDisconnectedEvent = DisconnectedEvent_3;
|
|
5715
5925
|
|
|
5716
5926
|
/**
|
|
5717
|
-
*
|
|
5718
|
-
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
|
5719
|
-
* under the {@link OpenFin.FrameEvents} namespace.
|
|
5927
|
+
* @deprecated Renamed to {@link Event}.
|
|
5720
5928
|
*/
|
|
5721
|
-
declare type FrameEvent =
|
|
5722
|
-
topic: 'frame';
|
|
5723
|
-
} & (FrameConnectedEvent | FrameDisconnectedEvent);
|
|
5929
|
+
declare type FrameEvent = Event_8;
|
|
5724
5930
|
|
|
5725
5931
|
declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
|
|
5726
5932
|
|
|
5727
5933
|
declare namespace FrameEvents {
|
|
5728
5934
|
export {
|
|
5935
|
+
BaseEvent_7 as BaseEvent,
|
|
5729
5936
|
BaseFrameEvent,
|
|
5937
|
+
ConnectedEvent_4 as ConnectedEvent,
|
|
5730
5938
|
FrameConnectedEvent,
|
|
5939
|
+
DisconnectedEvent_3 as DisconnectedEvent,
|
|
5731
5940
|
FrameDisconnectedEvent,
|
|
5941
|
+
Event_8 as Event,
|
|
5732
5942
|
FrameEvent,
|
|
5943
|
+
EventType_5 as EventType,
|
|
5733
5944
|
FrameEventType,
|
|
5734
|
-
|
|
5735
|
-
|
|
5945
|
+
Payload_6 as Payload,
|
|
5946
|
+
ByType_5 as ByType
|
|
5736
5947
|
}
|
|
5737
5948
|
}
|
|
5738
5949
|
|
|
5739
5950
|
/**
|
|
5740
|
-
*
|
|
5951
|
+
* @deprecated Renamed to {@link EventType}.
|
|
5741
5952
|
*/
|
|
5742
|
-
declare type FrameEventType =
|
|
5953
|
+
declare type FrameEventType = EventType_5;
|
|
5743
5954
|
|
|
5744
5955
|
/**
|
|
5745
5956
|
* @interface
|
|
@@ -5958,14 +6169,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
|
|
|
5958
6169
|
}
|
|
5959
6170
|
|
|
5960
6171
|
/**
|
|
5961
|
-
*
|
|
5962
|
-
* discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
|
5963
|
-
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
|
6172
|
+
* @deprecated Renamed to {@link Event}.
|
|
5964
6173
|
*/
|
|
5965
|
-
declare type GlobalHotkeyEvent =
|
|
5966
|
-
topic: 'global-hotkey';
|
|
5967
|
-
hotkey: 'string';
|
|
5968
|
-
} & (RegisteredEvent | UnregisteredEvent);
|
|
6174
|
+
declare type GlobalHotkeyEvent = Event_9;
|
|
5969
6175
|
|
|
5970
6176
|
declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
|
5971
6177
|
|
|
@@ -5973,17 +6179,19 @@ declare namespace GlobalHotkeyEvents {
|
|
|
5973
6179
|
export {
|
|
5974
6180
|
RegisteredEvent,
|
|
5975
6181
|
UnregisteredEvent,
|
|
6182
|
+
Event_9 as Event,
|
|
5976
6183
|
GlobalHotkeyEvent,
|
|
6184
|
+
EventType_6 as EventType,
|
|
5977
6185
|
GlobalHotkeyEventType,
|
|
5978
|
-
|
|
5979
|
-
|
|
6186
|
+
Payload_7 as Payload,
|
|
6187
|
+
ByType_6 as ByType
|
|
5980
6188
|
}
|
|
5981
6189
|
}
|
|
5982
6190
|
|
|
5983
6191
|
/**
|
|
5984
|
-
*
|
|
6192
|
+
* @deprecated Renamed to {@link EventType}.
|
|
5985
6193
|
*/
|
|
5986
|
-
declare type GlobalHotkeyEventType =
|
|
6194
|
+
declare type GlobalHotkeyEventType = EventType_6;
|
|
5987
6195
|
|
|
5988
6196
|
declare namespace GoldenLayout {
|
|
5989
6197
|
export {
|
|
@@ -6285,16 +6493,25 @@ declare interface Header {
|
|
|
6285
6493
|
* Generated when a View is hidden.
|
|
6286
6494
|
* @interface
|
|
6287
6495
|
*/
|
|
6288
|
-
declare type HiddenEvent =
|
|
6496
|
+
declare type HiddenEvent = BaseEvent_4 & {
|
|
6289
6497
|
type: 'hidden';
|
|
6290
6498
|
};
|
|
6291
6499
|
|
|
6500
|
+
/**
|
|
6501
|
+
* Generated when a window has been hidden.
|
|
6502
|
+
* @interface
|
|
6503
|
+
*/
|
|
6504
|
+
declare type HiddenEvent_2 = BaseEvent_5 & {
|
|
6505
|
+
type: 'hidden';
|
|
6506
|
+
reason: 'closing' | 'hide' | 'hide-on-close';
|
|
6507
|
+
};
|
|
6508
|
+
|
|
6292
6509
|
/**
|
|
6293
6510
|
* Generated when the context of a View's host window changes, either due to a call to {@link Platform#setWindowContext Platform.setWindowContext},
|
|
6294
6511
|
* or because the View has moved to a new window. Only available on Views in a Platform.
|
|
6295
6512
|
* @interface
|
|
6296
6513
|
*/
|
|
6297
|
-
declare type HostContextChangedEvent =
|
|
6514
|
+
declare type HostContextChangedEvent = BaseEvent_4 & {
|
|
6298
6515
|
type: 'host-context-changed';
|
|
6299
6516
|
context: any;
|
|
6300
6517
|
reason: 'reparented' | 'updated';
|
|
@@ -6373,7 +6590,16 @@ declare type Hotkey = {
|
|
|
6373
6590
|
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
|
6374
6591
|
* @interface
|
|
6375
6592
|
*/
|
|
6376
|
-
declare type HotkeyEvent =
|
|
6593
|
+
declare type HotkeyEvent = BaseEvent_4 & {
|
|
6594
|
+
type: 'hotkey';
|
|
6595
|
+
};
|
|
6596
|
+
|
|
6597
|
+
/**
|
|
6598
|
+
* Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
|
|
6599
|
+
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
|
6600
|
+
* @interface
|
|
6601
|
+
*/
|
|
6602
|
+
declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
|
|
6377
6603
|
type: 'hotkey';
|
|
6378
6604
|
};
|
|
6379
6605
|
|
|
@@ -6433,7 +6659,7 @@ declare type IdentityEvent = BaseEvent & {
|
|
|
6433
6659
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
|
6434
6660
|
* @interface
|
|
6435
6661
|
*/
|
|
6436
|
-
declare type IdleEvent =
|
|
6662
|
+
declare type IdleEvent = BaseEvent_8 & {
|
|
6437
6663
|
type: 'idle-state-changed';
|
|
6438
6664
|
elapsedTime: number;
|
|
6439
6665
|
isIdle: boolean;
|
|
@@ -6518,11 +6744,19 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
|
6518
6744
|
* Generated when an application has initialized.
|
|
6519
6745
|
* @interface
|
|
6520
6746
|
*/
|
|
6521
|
-
declare type InitializedEvent = IdentityEvent & {
|
|
6747
|
+
declare type InitializedEvent = BaseEvents.IdentityEvent & {
|
|
6522
6748
|
topic: 'application';
|
|
6523
6749
|
type: 'initialized';
|
|
6524
6750
|
};
|
|
6525
6751
|
|
|
6752
|
+
/**
|
|
6753
|
+
* Generated when a window is initialized.
|
|
6754
|
+
* @interface
|
|
6755
|
+
*/
|
|
6756
|
+
declare type InitializedEvent_2 = BaseEvent_5 & {
|
|
6757
|
+
type: 'initialized';
|
|
6758
|
+
};
|
|
6759
|
+
|
|
6526
6760
|
/**
|
|
6527
6761
|
* @interface
|
|
6528
6762
|
*/
|
|
@@ -8600,7 +8834,7 @@ declare type LayoutIdentity = Identity_5 & {
|
|
|
8600
8834
|
* Generated when a window and all of its layout's views have either finished or failed navigation.
|
|
8601
8835
|
* @interface
|
|
8602
8836
|
*/
|
|
8603
|
-
declare type LayoutInitializedEvent =
|
|
8837
|
+
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
|
8604
8838
|
type: 'layout-initialized';
|
|
8605
8839
|
ofViews: (OpenFin_2.Identity & {
|
|
8606
8840
|
entityType: 'view';
|
|
@@ -8960,7 +9194,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
|
8960
9194
|
* Generated when a window and all of its layout's views have been created and can receive API calls.
|
|
8961
9195
|
* @interface
|
|
8962
9196
|
*/
|
|
8963
|
-
declare type LayoutReadyEvent =
|
|
9197
|
+
declare type LayoutReadyEvent = BaseEvent_5 & {
|
|
8964
9198
|
type: 'layout-ready';
|
|
8965
9199
|
views: (OpenFin_2.Identity & {
|
|
8966
9200
|
success: boolean;
|
|
@@ -9101,7 +9335,7 @@ declare type Manifest = {
|
|
|
9101
9335
|
* Generated when the RVM notifies an application that the manifest has changed.
|
|
9102
9336
|
* @interface
|
|
9103
9337
|
*/
|
|
9104
|
-
declare type ManifestChangedEvent = IdentityEvent & {
|
|
9338
|
+
declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
|
|
9105
9339
|
topic: 'application';
|
|
9106
9340
|
type: 'manifest-changed';
|
|
9107
9341
|
};
|
|
@@ -9154,7 +9388,7 @@ declare type MatchPattern = string;
|
|
|
9154
9388
|
* Generated when a window is maximized.
|
|
9155
9389
|
* @interface
|
|
9156
9390
|
*/
|
|
9157
|
-
declare type MaximizedEvent =
|
|
9391
|
+
declare type MaximizedEvent = BaseEvent_5 & {
|
|
9158
9392
|
type: 'maximized';
|
|
9159
9393
|
};
|
|
9160
9394
|
|
|
@@ -9264,7 +9498,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
|
|
|
9264
9498
|
* Generated when a window is minimized.
|
|
9265
9499
|
* @interface
|
|
9266
9500
|
*/
|
|
9267
|
-
declare type MinimizedEvent =
|
|
9501
|
+
declare type MinimizedEvent = BaseEvent_5 & {
|
|
9268
9502
|
type: 'minimized';
|
|
9269
9503
|
};
|
|
9270
9504
|
|
|
@@ -9313,7 +9547,7 @@ declare type MonitorDetails = {
|
|
|
9313
9547
|
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
|
9314
9548
|
* @interface
|
|
9315
9549
|
*/
|
|
9316
|
-
declare type MonitorEvent =
|
|
9550
|
+
declare type MonitorEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
|
|
9317
9551
|
type: 'monitor-info-changed';
|
|
9318
9552
|
};
|
|
9319
9553
|
|
|
@@ -9735,13 +9969,15 @@ declare type NonPropagatedWebContentsEvent = never;
|
|
|
9735
9969
|
*/
|
|
9736
9970
|
declare type NonPropagatedWindowEvent = never;
|
|
9737
9971
|
|
|
9972
|
+
/* Excluded from this release type: NotCloseRequested */
|
|
9973
|
+
|
|
9738
9974
|
/* Excluded from this release type: NotRequested */
|
|
9739
9975
|
|
|
9740
9976
|
/**
|
|
9741
9977
|
* Generated when an application is not responding.
|
|
9742
9978
|
* @interface
|
|
9743
9979
|
*/
|
|
9744
|
-
declare type NotRespondingEvent = IdentityEvent & {
|
|
9980
|
+
declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
|
|
9745
9981
|
topic: 'application';
|
|
9746
9982
|
type: 'not-responding';
|
|
9747
9983
|
};
|
|
@@ -10067,7 +10303,7 @@ declare namespace OpenFin_2 {
|
|
|
10067
10303
|
AppVersionCompleteEvent,
|
|
10068
10304
|
AppVersionRuntimeStatusEvent,
|
|
10069
10305
|
Events,
|
|
10070
|
-
|
|
10306
|
+
BaseEvent_9 as BaseEvent,
|
|
10071
10307
|
WebContentsEvent_2 as WebContentsEvent,
|
|
10072
10308
|
SystemEvent_2 as SystemEvent,
|
|
10073
10309
|
ApplicationEvent_2 as ApplicationEvent,
|
|
@@ -10109,12 +10345,32 @@ export default OpenFin_2;
|
|
|
10109
10345
|
|
|
10110
10346
|
declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
|
|
10111
10347
|
|
|
10348
|
+
/**
|
|
10349
|
+
* Generated after window options are changed using the window.updateOptions method.
|
|
10350
|
+
* @remarks Will not fire if the diff object is empty.
|
|
10351
|
+
* @interface
|
|
10352
|
+
*/
|
|
10353
|
+
declare type OptionsChangedEvent = BaseEvent_5 & {
|
|
10354
|
+
type: 'options-changed';
|
|
10355
|
+
options: OpenFin_2.WindowOptions;
|
|
10356
|
+
diff: OpenFin_2.WindowOptionDiff;
|
|
10357
|
+
};
|
|
10358
|
+
|
|
10112
10359
|
declare type OverlapsOnlyIfMatching<T, U> = {
|
|
10113
10360
|
[K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
|
|
10114
10361
|
};
|
|
10115
10362
|
|
|
10116
10363
|
declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
|
10117
10364
|
|
|
10365
|
+
/**
|
|
10366
|
+
* Generated when page receives favicon urls.
|
|
10367
|
+
* @interface
|
|
10368
|
+
*/
|
|
10369
|
+
declare type PageFaviconUpdatedEvent = NamedEvent & {
|
|
10370
|
+
type: 'page-favicon-updated';
|
|
10371
|
+
favicons: string[];
|
|
10372
|
+
};
|
|
10373
|
+
|
|
10118
10374
|
/**
|
|
10119
10375
|
* Generated when page title is set during navigation.
|
|
10120
10376
|
* @remarks explicitSet is false when title is synthesized from file url.
|
|
@@ -10133,74 +10389,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
|
10133
10389
|
};
|
|
10134
10390
|
|
|
10135
10391
|
/**
|
|
10136
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10392
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
10137
10393
|
*
|
|
10138
10394
|
* @typeParam Type String key specifying the event to extract
|
|
10139
10395
|
*/
|
|
10140
|
-
declare type Payload_2<Type extends
|
|
10396
|
+
declare type Payload_2<Type extends EventType> = Extract<Event_4, {
|
|
10141
10397
|
type: Type;
|
|
10142
10398
|
}>;
|
|
10143
10399
|
|
|
10144
10400
|
/**
|
|
10145
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10401
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
10146
10402
|
*
|
|
10147
10403
|
* @typeParam Type String key specifying the event to extract
|
|
10148
10404
|
*/
|
|
10149
|
-
declare type Payload_3<Type extends
|
|
10405
|
+
declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
|
|
10150
10406
|
type: Type;
|
|
10151
10407
|
}>;
|
|
10152
10408
|
|
|
10153
10409
|
/**
|
|
10154
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10410
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
10155
10411
|
*
|
|
10156
10412
|
* @typeParam Type String key specifying the event to extract
|
|
10157
10413
|
*/
|
|
10158
|
-
declare type Payload_4<Type extends
|
|
10414
|
+
declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
|
|
10159
10415
|
type: Type;
|
|
10160
10416
|
}>;
|
|
10161
10417
|
|
|
10162
10418
|
/**
|
|
10163
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10419
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
10164
10420
|
*
|
|
10165
10421
|
* @typeParam Type String key specifying the event to extract
|
|
10166
10422
|
*/
|
|
10167
|
-
declare type Payload_5<Type extends
|
|
10423
|
+
declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
|
|
10168
10424
|
type: Type;
|
|
10169
10425
|
}>;
|
|
10170
10426
|
|
|
10171
10427
|
/**
|
|
10172
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10428
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
10173
10429
|
*
|
|
10174
10430
|
* @typeParam Type String key specifying the event to extract
|
|
10175
10431
|
*/
|
|
10176
|
-
declare type Payload_6<Type extends
|
|
10432
|
+
declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
|
|
10177
10433
|
type: Type;
|
|
10178
10434
|
}>;
|
|
10179
10435
|
|
|
10180
10436
|
/**
|
|
10181
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10437
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
10182
10438
|
*
|
|
10183
10439
|
* @typeParam Type String key specifying the event to extract
|
|
10184
10440
|
*/
|
|
10185
|
-
declare type Payload_7<Type extends
|
|
10441
|
+
declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
|
|
10186
10442
|
type: Type;
|
|
10187
10443
|
}>;
|
|
10188
10444
|
|
|
10189
10445
|
/**
|
|
10190
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10446
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
10191
10447
|
*
|
|
10192
10448
|
* @typeParam Type String key specifying the event to extract
|
|
10193
10449
|
*/
|
|
10194
|
-
declare type Payload_8<Type extends
|
|
10450
|
+
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
|
10195
10451
|
type: Type;
|
|
10196
10452
|
}>;
|
|
10197
10453
|
|
|
10198
10454
|
/**
|
|
10199
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10455
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
10200
10456
|
*
|
|
10201
10457
|
* @typeParam Type String key specifying the event to extract
|
|
10202
10458
|
*/
|
|
10203
|
-
declare type Payload_9<Type extends
|
|
10459
|
+
declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
|
|
10204
10460
|
type: Type;
|
|
10205
10461
|
}>;
|
|
10206
10462
|
|
|
@@ -10210,7 +10466,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
|
|
|
10210
10466
|
* Generated when window finishes loading. Provides performance and navigation data.
|
|
10211
10467
|
* @interface
|
|
10212
10468
|
*/
|
|
10213
|
-
declare type PerformanceReportEvent = Performance &
|
|
10469
|
+
declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
|
10214
10470
|
type: 'performance-report';
|
|
10215
10471
|
};
|
|
10216
10472
|
|
|
@@ -10844,38 +11100,36 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
|
|
|
10844
11100
|
}
|
|
10845
11101
|
|
|
10846
11102
|
/**
|
|
10847
|
-
*
|
|
10848
|
-
* @interface
|
|
11103
|
+
* @deprecated Renamed to {@link ApiReadyEvent}.
|
|
10849
11104
|
*/
|
|
10850
|
-
declare type PlatformApiReadyEvent =
|
|
10851
|
-
topic: 'application';
|
|
10852
|
-
type: 'platform-api-ready';
|
|
10853
|
-
};
|
|
11105
|
+
declare type PlatformApiReadyEvent = ApiReadyEvent;
|
|
10854
11106
|
|
|
10855
11107
|
/**
|
|
10856
|
-
*
|
|
10857
|
-
* discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
|
|
10858
|
-
* under the {@link OpenFin.PlatformEvents} namespace.
|
|
11108
|
+
* @deprecated Renamed to {@link Event}.
|
|
10859
11109
|
*/
|
|
10860
|
-
declare type PlatformEvent =
|
|
11110
|
+
declare type PlatformEvent = Event_10;
|
|
10861
11111
|
|
|
10862
11112
|
declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
|
|
10863
11113
|
|
|
10864
11114
|
declare namespace PlatformEvents {
|
|
10865
11115
|
export {
|
|
11116
|
+
ApiReadyEvent,
|
|
10866
11117
|
PlatformApiReadyEvent,
|
|
11118
|
+
SnapshotAppliedEvent,
|
|
10867
11119
|
PlatformSnapshotAppliedEvent,
|
|
11120
|
+
Event_10 as Event,
|
|
10868
11121
|
PlatformEvent,
|
|
11122
|
+
EventType_7 as EventType,
|
|
10869
11123
|
PlatformEventType,
|
|
10870
|
-
|
|
10871
|
-
|
|
11124
|
+
Payload_8 as Payload,
|
|
11125
|
+
ByType_7 as ByType
|
|
10872
11126
|
}
|
|
10873
11127
|
}
|
|
10874
11128
|
|
|
10875
11129
|
/**
|
|
10876
|
-
*
|
|
11130
|
+
* @deprecated Renamed to {@link }.
|
|
10877
11131
|
*/
|
|
10878
|
-
declare type PlatformEventType =
|
|
11132
|
+
declare type PlatformEventType = EventType_7;
|
|
10879
11133
|
|
|
10880
11134
|
/**
|
|
10881
11135
|
* Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
|
|
@@ -11540,19 +11794,9 @@ declare interface PlatformProvider {
|
|
|
11540
11794
|
}
|
|
11541
11795
|
|
|
11542
11796
|
/**
|
|
11543
|
-
*
|
|
11544
|
-
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
|
11545
|
-
* 1. The window has been created
|
|
11546
|
-
* 2. The window has a responsive API
|
|
11547
|
-
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
|
11548
|
-
*
|
|
11549
|
-
* _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.
|
|
11550
|
-
* @interface
|
|
11797
|
+
* @deprecated Renamed to {@link SnapshotAppliedEvent}.
|
|
11551
11798
|
*/
|
|
11552
|
-
declare type PlatformSnapshotAppliedEvent =
|
|
11553
|
-
topic: 'application';
|
|
11554
|
-
type: 'platform-snapshot-applied';
|
|
11555
|
-
};
|
|
11799
|
+
declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
|
|
11556
11800
|
|
|
11557
11801
|
/**
|
|
11558
11802
|
* @interface
|
|
@@ -11820,7 +12064,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
|
|
|
11820
12064
|
* A general preload scripts state change event without event type.
|
|
11821
12065
|
* @interface
|
|
11822
12066
|
*/
|
|
11823
|
-
declare type PreloadScriptsStateChangeEvent =
|
|
12067
|
+
declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
|
|
11824
12068
|
preloadScripts: (PreloadScriptInfoRunning & any)[];
|
|
11825
12069
|
};
|
|
11826
12070
|
|
|
@@ -12029,51 +12273,43 @@ declare type ProcessLoggingOptions = {
|
|
|
12029
12273
|
};
|
|
12030
12274
|
|
|
12031
12275
|
/**
|
|
12032
|
-
*
|
|
12033
|
-
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
|
12034
|
-
* are propagated to `System` without any type string prefixing.
|
|
12035
|
-
*
|
|
12036
|
-
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
|
12276
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
|
12037
12277
|
*/
|
|
12038
|
-
declare type PropagatedApplicationEvent<TargetTopic extends string> =
|
|
12278
|
+
declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
|
|
12039
12279
|
|
|
12040
12280
|
/**
|
|
12041
|
-
*
|
|
12281
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
|
12042
12282
|
*/
|
|
12043
|
-
declare type PropagatedApplicationEventType =
|
|
12283
|
+
declare type PropagatedApplicationEventType = PropagatedEventType_3;
|
|
12044
12284
|
|
|
12045
12285
|
/**
|
|
12046
|
-
* Modifies an event shape to reflect propagation to a parent topic.
|
|
12286
|
+
* Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
|
|
12287
|
+
* these do not propagate.
|
|
12288
|
+
*
|
|
12047
12289
|
* @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
|
|
12290
|
+
*
|
|
12291
|
+
* @typeParam SourceTopic The topic the event shape is propagating from.
|
|
12292
|
+
* @typeParam TargetTopic The topic the event shape is propagating to.
|
|
12293
|
+
* @typeParam Event The shape of the event being propagated.
|
|
12048
12294
|
*/
|
|
12049
12295
|
declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
|
|
12050
12296
|
type: string;
|
|
12051
12297
|
}> = Event extends infer E extends {
|
|
12052
12298
|
type: string;
|
|
12053
|
-
} ? Omit<E, 'type' | 'topic'> & {
|
|
12299
|
+
} ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
|
|
12054
12300
|
type: PropagatedEventType<SourceTopic, E['type']>;
|
|
12055
12301
|
topic: TargetTopic;
|
|
12056
12302
|
} : never;
|
|
12057
12303
|
|
|
12058
|
-
/**
|
|
12059
|
-
* Modifies an event key to reflect propagation by prefixing with the topic.
|
|
12060
|
-
*/
|
|
12061
|
-
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
|
|
12062
|
-
|
|
12063
12304
|
/**
|
|
12064
12305
|
* A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
|
|
12065
12306
|
* or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
|
|
12066
12307
|
* event type key with `'view-'`.
|
|
12067
12308
|
*/
|
|
12068
|
-
declare type
|
|
12309
|
+
declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
|
|
12069
12310
|
viewIdentity: OpenFin_2.Identity;
|
|
12070
12311
|
};
|
|
12071
12312
|
|
|
12072
|
-
/**
|
|
12073
|
-
* Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
|
|
12074
|
-
*/
|
|
12075
|
-
declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
|
12076
|
-
|
|
12077
12313
|
/**
|
|
12078
12314
|
* A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
|
|
12079
12315
|
* prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
|
|
@@ -12082,12 +12318,51 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
|
|
12082
12318
|
*
|
|
12083
12319
|
* "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
|
|
12084
12320
|
*/
|
|
12085
|
-
declare type
|
|
12321
|
+
declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
|
|
12322
|
+
|
|
12323
|
+
/**
|
|
12324
|
+
* An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
|
|
12325
|
+
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
|
12326
|
+
* are propagated to `System` without any type string prefixing.
|
|
12327
|
+
*
|
|
12328
|
+
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
|
12329
|
+
*/
|
|
12330
|
+
declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
|
|
12331
|
+
|
|
12332
|
+
/**
|
|
12333
|
+
* Modifies an event type key to reflect propagation by prefixing with the topic.
|
|
12334
|
+
*/
|
|
12335
|
+
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
|
|
12336
|
+
|
|
12337
|
+
/**
|
|
12338
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
|
|
12339
|
+
*/
|
|
12340
|
+
declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
|
|
12086
12341
|
|
|
12087
12342
|
/**
|
|
12088
|
-
* Union of possible
|
|
12343
|
+
* Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
|
|
12089
12344
|
*/
|
|
12090
|
-
declare type
|
|
12345
|
+
declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
|
|
12346
|
+
|
|
12347
|
+
/**
|
|
12348
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
|
12349
|
+
*/
|
|
12350
|
+
declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
|
|
12351
|
+
|
|
12352
|
+
/**
|
|
12353
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
|
12354
|
+
*/
|
|
12355
|
+
declare type PropagatedViewEventType = PropagatedEventType_2;
|
|
12356
|
+
|
|
12357
|
+
/**
|
|
12358
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
|
12359
|
+
*/
|
|
12360
|
+
declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
|
|
12361
|
+
|
|
12362
|
+
/**
|
|
12363
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
|
|
12364
|
+
*/
|
|
12365
|
+
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
12091
12366
|
|
|
12092
12367
|
declare interface ProtocolMap extends ProtocolMapBase {
|
|
12093
12368
|
'request-external-authorization': {
|
|
@@ -12505,7 +12780,7 @@ declare type RegistryInfo_2 = {
|
|
|
12505
12780
|
* Generated when a window has been reloaded.
|
|
12506
12781
|
* @interface
|
|
12507
12782
|
*/
|
|
12508
|
-
declare type ReloadedEvent =
|
|
12783
|
+
declare type ReloadedEvent = BaseEvent_5 & {
|
|
12509
12784
|
type: 'reloaded';
|
|
12510
12785
|
url: string;
|
|
12511
12786
|
};
|
|
@@ -12641,11 +12916,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
|
|
|
12641
12916
|
* Generated when an application is responding.
|
|
12642
12917
|
* @interface
|
|
12643
12918
|
*/
|
|
12644
|
-
declare type RespondingEvent = IdentityEvent & {
|
|
12919
|
+
declare type RespondingEvent = BaseEvents.IdentityEvent & {
|
|
12645
12920
|
topic: 'application';
|
|
12646
12921
|
type: 'responding';
|
|
12647
12922
|
};
|
|
12648
12923
|
|
|
12924
|
+
/**
|
|
12925
|
+
* Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
|
12926
|
+
* @interface
|
|
12927
|
+
*/
|
|
12928
|
+
declare type RestoredEvent = BaseEvent_5 & {
|
|
12929
|
+
type: 'restored';
|
|
12930
|
+
};
|
|
12931
|
+
|
|
12649
12932
|
declare type ResultBehavior = 'close' | 'hide' | 'none';
|
|
12650
12933
|
|
|
12651
12934
|
/**
|
|
@@ -12708,7 +12991,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
|
|
|
12708
12991
|
* Generated when Application.run() is called for an already running application.
|
|
12709
12992
|
* @interface
|
|
12710
12993
|
*/
|
|
12711
|
-
declare type RunRequestedEvent_2 = IdentityEvent & {
|
|
12994
|
+
declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
|
|
12712
12995
|
topic: 'application';
|
|
12713
12996
|
type: 'run-requested';
|
|
12714
12997
|
userAppConfigArgs: Record<string, any>;
|
|
@@ -12890,7 +13173,7 @@ declare type ServiceIdentifier = {
|
|
|
12890
13173
|
* Generated on changes to a user’s local computer session.
|
|
12891
13174
|
* @interface
|
|
12892
13175
|
*/
|
|
12893
|
-
declare type SessionChangedEvent =
|
|
13176
|
+
declare type SessionChangedEvent = BaseEvent_8 & {
|
|
12894
13177
|
type: 'session-changed';
|
|
12895
13178
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
|
12896
13179
|
};
|
|
@@ -13112,7 +13395,7 @@ declare type ShortcutOverride = Hotkey & {
|
|
|
13112
13395
|
*
|
|
13113
13396
|
* @interface
|
|
13114
13397
|
*/
|
|
13115
|
-
declare type ShowAllDownloadsEvent =
|
|
13398
|
+
declare type ShowAllDownloadsEvent = BaseEvent_5 & {
|
|
13116
13399
|
type: 'show-all-downloads';
|
|
13117
13400
|
};
|
|
13118
13401
|
|
|
@@ -13120,7 +13403,15 @@ declare type ShowAllDownloadsEvent = BaseWindowEvent & {
|
|
|
13120
13403
|
* Generated when a View is shown. This event will fire during creation of a View.
|
|
13121
13404
|
* @interface
|
|
13122
13405
|
*/
|
|
13123
|
-
declare type ShownEvent =
|
|
13406
|
+
declare type ShownEvent = BaseEvent_4 & {
|
|
13407
|
+
type: 'shown';
|
|
13408
|
+
};
|
|
13409
|
+
|
|
13410
|
+
/**
|
|
13411
|
+
* Generated when a hidden window has been shown.
|
|
13412
|
+
* @interface
|
|
13413
|
+
*/
|
|
13414
|
+
declare type ShownEvent_2 = BaseEvent_5 & {
|
|
13124
13415
|
type: 'shown';
|
|
13125
13416
|
};
|
|
13126
13417
|
|
|
@@ -13149,6 +13440,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
|
|
|
13149
13440
|
y?: number;
|
|
13150
13441
|
};
|
|
13151
13442
|
|
|
13443
|
+
/**
|
|
13444
|
+
* Generated when a window has been prevented from showing.
|
|
13445
|
+
* @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.
|
|
13446
|
+
* @interface
|
|
13447
|
+
*/
|
|
13448
|
+
declare type ShowRequestedEvent = BaseEvent_5 & {
|
|
13449
|
+
type: 'show-requested';
|
|
13450
|
+
};
|
|
13451
|
+
|
|
13152
13452
|
/**
|
|
13153
13453
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
|
13154
13454
|
*
|
|
@@ -13195,6 +13495,21 @@ declare type Snapshot = {
|
|
|
13195
13495
|
};
|
|
13196
13496
|
};
|
|
13197
13497
|
|
|
13498
|
+
/**
|
|
13499
|
+
* Generated when a platform.ApplySnapshot call is resolved.
|
|
13500
|
+
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
|
13501
|
+
* 1. The window has been created
|
|
13502
|
+
* 2. The window has a responsive API
|
|
13503
|
+
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
|
13504
|
+
*
|
|
13505
|
+
* _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.
|
|
13506
|
+
* @interface
|
|
13507
|
+
*/
|
|
13508
|
+
declare type SnapshotAppliedEvent = BaseEvent & {
|
|
13509
|
+
topic: 'application';
|
|
13510
|
+
type: 'platform-snapshot-applied';
|
|
13511
|
+
};
|
|
13512
|
+
|
|
13198
13513
|
/**
|
|
13199
13514
|
* @interface
|
|
13200
13515
|
*/
|
|
@@ -13309,7 +13624,7 @@ declare class SnapshotSourceModule extends Base {
|
|
|
13309
13624
|
* Generated when an application has started.
|
|
13310
13625
|
* @interface
|
|
13311
13626
|
*/
|
|
13312
|
-
declare type StartedEvent = IdentityEvent & {
|
|
13627
|
+
declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
13313
13628
|
topic: 'application';
|
|
13314
13629
|
type: 'started';
|
|
13315
13630
|
};
|
|
@@ -14842,12 +15157,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
|
|
|
14842
15157
|
};
|
|
14843
15158
|
|
|
14844
15159
|
/**
|
|
14845
|
-
*
|
|
14846
|
-
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
|
14847
|
-
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
14848
|
-
* from which they propagate).
|
|
15160
|
+
* @deprecated Renamed to {@link Event}.
|
|
14849
15161
|
*/
|
|
14850
|
-
declare type SystemEvent =
|
|
15162
|
+
declare type SystemEvent = Event_11;
|
|
14851
15163
|
|
|
14852
15164
|
declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
|
|
14853
15165
|
|
|
@@ -14855,7 +15167,7 @@ declare namespace SystemEvents {
|
|
|
14855
15167
|
export {
|
|
14856
15168
|
NotRequested,
|
|
14857
15169
|
ExcludeRequested,
|
|
14858
|
-
|
|
15170
|
+
BaseEvent_8 as BaseEvent,
|
|
14859
15171
|
IdleEvent,
|
|
14860
15172
|
MonitorEvent,
|
|
14861
15173
|
SessionChangedEvent,
|
|
@@ -14870,17 +15182,19 @@ declare namespace SystemEvents {
|
|
|
14870
15182
|
ApplicationCreatedEvent,
|
|
14871
15183
|
DesktopIconClickedEvent,
|
|
14872
15184
|
SystemShutdownEvent,
|
|
15185
|
+
Event_11 as Event,
|
|
14873
15186
|
SystemEvent,
|
|
15187
|
+
EventType_8 as EventType,
|
|
14874
15188
|
SystemEventType,
|
|
14875
|
-
|
|
14876
|
-
|
|
15189
|
+
Payload_9 as Payload,
|
|
15190
|
+
ByType_8 as ByType
|
|
14877
15191
|
}
|
|
14878
15192
|
}
|
|
14879
15193
|
|
|
14880
15194
|
/**
|
|
14881
|
-
*
|
|
15195
|
+
* @deprecated Renamed to {@link EventType}.
|
|
14882
15196
|
*/
|
|
14883
|
-
declare type SystemEventType =
|
|
15197
|
+
declare type SystemEventType = EventType_8;
|
|
14884
15198
|
|
|
14885
15199
|
/**
|
|
14886
15200
|
* @interface
|
|
@@ -15133,7 +15447,7 @@ declare type TargetApp = string | AppMetadata;
|
|
|
15133
15447
|
* In that case, previousTarget identity will be the same as target identity.
|
|
15134
15448
|
* @interface
|
|
15135
15449
|
*/
|
|
15136
|
-
declare type TargetChangedEvent =
|
|
15450
|
+
declare type TargetChangedEvent = BaseEvent_4 & {
|
|
15137
15451
|
type: 'target-changed';
|
|
15138
15452
|
previousTarget: OpenFin_2.Identity;
|
|
15139
15453
|
};
|
|
@@ -15287,7 +15601,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
15287
15601
|
* Generated when the tray icon is clicked.
|
|
15288
15602
|
* @interface
|
|
15289
15603
|
*/
|
|
15290
|
-
declare type TrayIconClickedEvent = IdentityEvent & {
|
|
15604
|
+
declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
|
|
15291
15605
|
topic: 'application';
|
|
15292
15606
|
type: 'tray-icon-clicked';
|
|
15293
15607
|
button: 0 | 1 | 2;
|
|
@@ -15377,7 +15691,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
|
15377
15691
|
* A general user bounds change event without event type.
|
|
15378
15692
|
* @interface
|
|
15379
15693
|
*/
|
|
15380
|
-
declare type UserBoundsChangeEvent =
|
|
15694
|
+
declare type UserBoundsChangeEvent = BaseEvent_5 & {
|
|
15381
15695
|
height: number;
|
|
15382
15696
|
left: number;
|
|
15383
15697
|
top: number;
|
|
@@ -15389,7 +15703,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
|
|
|
15389
15703
|
* Generated when a window's user movement becomes disabled.
|
|
15390
15704
|
* @interface
|
|
15391
15705
|
*/
|
|
15392
|
-
declare type UserMovementDisabledEvent =
|
|
15706
|
+
declare type UserMovementDisabledEvent = BaseEvent_5 & {
|
|
15393
15707
|
type: 'user-movement-disabled';
|
|
15394
15708
|
};
|
|
15395
15709
|
|
|
@@ -15397,7 +15711,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
|
|
|
15397
15711
|
* Generated when a window's user movement becomes enabled.
|
|
15398
15712
|
* @interface
|
|
15399
15713
|
*/
|
|
15400
|
-
declare type UserMovementEnabledEvent =
|
|
15714
|
+
declare type UserMovementEnabledEvent = BaseEvent_5 & {
|
|
15401
15715
|
type: 'user-movement-enabled';
|
|
15402
15716
|
};
|
|
15403
15717
|
|
|
@@ -16047,7 +16361,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
|
|
|
16047
16361
|
* Generated when a View is attached to a window.
|
|
16048
16362
|
* @interface
|
|
16049
16363
|
*/
|
|
16050
|
-
declare type ViewAttachedEvent =
|
|
16364
|
+
declare type ViewAttachedEvent = BaseEvent_5 & {
|
|
16051
16365
|
type: 'view-attached';
|
|
16052
16366
|
target: OpenFin_2.Identity;
|
|
16053
16367
|
viewIdentity: OpenFin_2.Identity;
|
|
@@ -16089,7 +16403,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
|
|
|
16089
16403
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
|
16090
16404
|
* @interface
|
|
16091
16405
|
*/
|
|
16092
|
-
declare type ViewDetachedEvent =
|
|
16406
|
+
declare type ViewDetachedEvent = BaseEvent_5 & {
|
|
16093
16407
|
type: 'view-detached';
|
|
16094
16408
|
target: OpenFin_2.Identity;
|
|
16095
16409
|
previousTarget: OpenFin_2.Identity;
|
|
@@ -16097,18 +16411,15 @@ declare type ViewDetachedEvent = BaseWindowEvent & {
|
|
|
16097
16411
|
};
|
|
16098
16412
|
|
|
16099
16413
|
/**
|
|
16100
|
-
*
|
|
16101
|
-
* discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
|
|
16102
|
-
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
|
16414
|
+
* @deprecated Renamed to {@link Event}.
|
|
16103
16415
|
*/
|
|
16104
|
-
declare type ViewEvent =
|
|
16105
|
-
target: OpenFin_2.Identity;
|
|
16106
|
-
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
|
16416
|
+
declare type ViewEvent = Event_4;
|
|
16107
16417
|
|
|
16108
16418
|
declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
|
|
16109
16419
|
|
|
16110
16420
|
declare namespace ViewEvents {
|
|
16111
16421
|
export {
|
|
16422
|
+
BaseEvent_4 as BaseEvent,
|
|
16112
16423
|
BaseViewEvent,
|
|
16113
16424
|
TargetChangedEvent,
|
|
16114
16425
|
NonPropagatedViewEvent,
|
|
@@ -16118,20 +16429,24 @@ declare namespace ViewEvents {
|
|
|
16118
16429
|
HotkeyEvent,
|
|
16119
16430
|
ShownEvent,
|
|
16120
16431
|
HostContextChangedEvent,
|
|
16432
|
+
Event_4 as Event,
|
|
16121
16433
|
ViewEvent,
|
|
16122
16434
|
WillPropagateViewEvent,
|
|
16435
|
+
EventType,
|
|
16123
16436
|
ViewEventType,
|
|
16437
|
+
PropagatedEvent_2 as PropagatedEvent,
|
|
16124
16438
|
PropagatedViewEvent,
|
|
16439
|
+
PropagatedEventType_2 as PropagatedEventType,
|
|
16125
16440
|
PropagatedViewEventType,
|
|
16126
|
-
|
|
16127
|
-
|
|
16441
|
+
Payload_2 as Payload,
|
|
16442
|
+
ByType
|
|
16128
16443
|
}
|
|
16129
16444
|
}
|
|
16130
16445
|
|
|
16131
16446
|
/**
|
|
16132
|
-
*
|
|
16447
|
+
* @deprecated Renamed to {@link EventType}.
|
|
16133
16448
|
*/
|
|
16134
|
-
declare type ViewEventType =
|
|
16449
|
+
declare type ViewEventType = EventType;
|
|
16135
16450
|
|
|
16136
16451
|
/**
|
|
16137
16452
|
* @interface
|
|
@@ -17270,12 +17585,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17270
17585
|
}
|
|
17271
17586
|
|
|
17272
17587
|
/**
|
|
17273
|
-
*
|
|
17274
|
-
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
|
17588
|
+
* @deprecated Renamed to {@link Event}.
|
|
17275
17589
|
*/
|
|
17276
|
-
declare type WebContentsEvent<Topic extends string> =
|
|
17277
|
-
topic: Topic;
|
|
17278
|
-
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
|
17590
|
+
declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
|
|
17279
17591
|
|
|
17280
17592
|
declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
|
|
17281
17593
|
|
|
@@ -17287,6 +17599,7 @@ declare namespace WebContentsEvents {
|
|
|
17287
17599
|
CrashedEvent_2 as CrashedEvent,
|
|
17288
17600
|
CertificateErrorEvent,
|
|
17289
17601
|
CertificateSelectionShownEvent,
|
|
17602
|
+
PageFaviconUpdatedEvent,
|
|
17290
17603
|
FaviconUpdatedEvent,
|
|
17291
17604
|
NavigationRejectedEvent,
|
|
17292
17605
|
UrlChangedEvent,
|
|
@@ -17305,6 +17618,7 @@ declare namespace WebContentsEvents {
|
|
|
17305
17618
|
FileDownloadStartedEvent,
|
|
17306
17619
|
FileDownloadProgressEvent,
|
|
17307
17620
|
FileDownloadCompletedEvent,
|
|
17621
|
+
Event_5 as Event,
|
|
17308
17622
|
WebContentsEvent,
|
|
17309
17623
|
WillPropagateWebContentsEvent,
|
|
17310
17624
|
NonPropagatedWebContentsEvent
|
|
@@ -17352,7 +17666,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
|
17352
17666
|
* A general will-move or will-resize event without event type.
|
|
17353
17667
|
* @interface
|
|
17354
17668
|
*/
|
|
17355
|
-
declare type WillMoveOrResizeEvent =
|
|
17669
|
+
declare type WillMoveOrResizeEvent = BaseEvent_5 & {
|
|
17356
17670
|
height: number;
|
|
17357
17671
|
left: number;
|
|
17358
17672
|
top: number;
|
|
@@ -17374,7 +17688,7 @@ declare type WillPropagateViewEvent = ViewEvent;
|
|
|
17374
17688
|
*
|
|
17375
17689
|
* A WebContents event that does propagate to (republish on) parent topics.
|
|
17376
17690
|
*/
|
|
17377
|
-
declare type WillPropagateWebContentsEvent =
|
|
17691
|
+
declare type WillPropagateWebContentsEvent = Event_5<string>;
|
|
17378
17692
|
|
|
17379
17693
|
/**
|
|
17380
17694
|
* @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
|
|
@@ -17388,7 +17702,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
|
|
|
17388
17702
|
* Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
|
|
17389
17703
|
* @interface
|
|
17390
17704
|
*/
|
|
17391
|
-
declare type WillRedirectEvent =
|
|
17705
|
+
declare type WillRedirectEvent = BaseEvent_5 & {
|
|
17392
17706
|
type: 'will-redirect';
|
|
17393
17707
|
blocked: boolean;
|
|
17394
17708
|
isInPlace: boolean;
|
|
@@ -18943,29 +19257,19 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
18943
19257
|
};
|
|
18944
19258
|
|
|
18945
19259
|
/**
|
|
18946
|
-
*
|
|
18947
|
-
* @interface
|
|
19260
|
+
* @deprecated Renamed to {@link ClosedEvent}.
|
|
18948
19261
|
*/
|
|
18949
|
-
declare type WindowClosedEvent =
|
|
18950
|
-
type: 'closed';
|
|
18951
|
-
};
|
|
19262
|
+
declare type WindowClosedEvent = ClosedEvent_2;
|
|
18952
19263
|
|
|
18953
19264
|
/**
|
|
18954
|
-
*
|
|
18955
|
-
* @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.
|
|
18956
|
-
* @interface
|
|
19265
|
+
* @deprecated Renamed to {@link CloseRequestedEvent}.
|
|
18957
19266
|
*/
|
|
18958
|
-
declare type WindowCloseRequestedEvent =
|
|
18959
|
-
type: 'close-requested';
|
|
18960
|
-
};
|
|
19267
|
+
declare type WindowCloseRequestedEvent = CloseRequestedEvent;
|
|
18961
19268
|
|
|
18962
19269
|
/**
|
|
18963
|
-
*
|
|
18964
|
-
* @interface
|
|
19270
|
+
* @deprecated Renamed to {@link ClosingEvent}.
|
|
18965
19271
|
*/
|
|
18966
|
-
declare type WindowClosingEvent =
|
|
18967
|
-
type: 'closing';
|
|
18968
|
-
};
|
|
19272
|
+
declare type WindowClosingEvent = ClosingEvent;
|
|
18969
19273
|
|
|
18970
19274
|
/**
|
|
18971
19275
|
* A rule prescribing content creation in a {@link OpenFin.Window}.
|
|
@@ -19049,16 +19353,15 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19049
19353
|
};
|
|
19050
19354
|
|
|
19051
19355
|
/**
|
|
19052
|
-
*
|
|
19053
|
-
* discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
|
|
19054
|
-
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
|
19356
|
+
* @deprecated, Renamed to {@link Event}.
|
|
19055
19357
|
*/
|
|
19056
|
-
declare type WindowEvent =
|
|
19358
|
+
declare type WindowEvent = Event_6;
|
|
19057
19359
|
|
|
19058
19360
|
declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
|
|
19059
19361
|
|
|
19060
19362
|
declare namespace WindowEvents {
|
|
19061
19363
|
export {
|
|
19364
|
+
BaseEvent_5 as BaseEvent,
|
|
19062
19365
|
BaseWindowEvent,
|
|
19063
19366
|
ViewAttachedEvent,
|
|
19064
19367
|
ViewDetachedEvent,
|
|
@@ -19068,9 +19371,11 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19068
19371
|
EndLoadEvent,
|
|
19069
19372
|
WillRedirectEvent,
|
|
19070
19373
|
ReloadedEvent,
|
|
19374
|
+
OptionsChangedEvent,
|
|
19071
19375
|
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
|
19072
19376
|
ExternalProcessExitedEvent,
|
|
19073
19377
|
ExternalProcessStartedEvent,
|
|
19378
|
+
HiddenEvent_2 as HiddenEvent,
|
|
19074
19379
|
WindowHiddenEvent,
|
|
19075
19380
|
PreloadScriptInfoRunning,
|
|
19076
19381
|
PreloadScriptInfo,
|
|
@@ -19085,22 +19390,30 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19085
19390
|
BeginUserBoundsChangingEvent,
|
|
19086
19391
|
BoundsChangedEvent,
|
|
19087
19392
|
BoundsChangingEvent,
|
|
19393
|
+
CloseRequestedEvent,
|
|
19088
19394
|
WindowCloseRequestedEvent,
|
|
19089
19395
|
ContextChangedEvent,
|
|
19396
|
+
ClosedEvent_2 as ClosedEvent,
|
|
19090
19397
|
WindowClosedEvent,
|
|
19398
|
+
ClosingEvent,
|
|
19091
19399
|
WindowClosingEvent,
|
|
19092
19400
|
DisabledMovementBoundsChangedEvent,
|
|
19093
19401
|
DisabledMovementBoundsChangingEvent,
|
|
19094
19402
|
EmbeddedEvent,
|
|
19095
19403
|
EndUserBoundsChangingEvent,
|
|
19404
|
+
HotkeyEvent_2 as HotkeyEvent,
|
|
19096
19405
|
WindowHotkeyEvent,
|
|
19406
|
+
InitializedEvent_2 as InitializedEvent,
|
|
19097
19407
|
WindowInitializedEvent,
|
|
19098
19408
|
MaximizedEvent,
|
|
19099
19409
|
MinimizedEvent,
|
|
19100
19410
|
PreloadScriptsStateChangedEvent,
|
|
19101
19411
|
PreloadScriptsStateChangingEvent,
|
|
19412
|
+
RestoredEvent,
|
|
19102
19413
|
WindowRestoredEvent,
|
|
19414
|
+
ShowRequestedEvent,
|
|
19103
19415
|
WindowShowRequestedEvent,
|
|
19416
|
+
ShownEvent_2 as ShownEvent,
|
|
19104
19417
|
WindowShownEvent,
|
|
19105
19418
|
UserMovementEnabledEvent,
|
|
19106
19419
|
UserMovementDisabledEvent,
|
|
@@ -19111,37 +19424,32 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19111
19424
|
DownloadShelfVisibilityChangedEvent,
|
|
19112
19425
|
WindowSourcedEvent,
|
|
19113
19426
|
WillPropagateWindowEvent,
|
|
19427
|
+
Event_6 as Event,
|
|
19114
19428
|
WindowEvent,
|
|
19429
|
+
EventType_2 as EventType,
|
|
19115
19430
|
WindowEventType,
|
|
19431
|
+
PropagatedEvent_3 as PropagatedEvent,
|
|
19116
19432
|
PropagatedWindowEvent,
|
|
19117
19433
|
PropagatedWindowEventType,
|
|
19118
|
-
|
|
19119
|
-
|
|
19434
|
+
Payload_3 as Payload,
|
|
19435
|
+
ByType_2 as ByType
|
|
19120
19436
|
}
|
|
19121
19437
|
}
|
|
19122
19438
|
|
|
19123
19439
|
/**
|
|
19124
|
-
*
|
|
19440
|
+
* @deprecated Renamed to {@link EventType}.
|
|
19125
19441
|
*/
|
|
19126
19442
|
declare type WindowEventType = WindowEvent['type'];
|
|
19127
19443
|
|
|
19128
19444
|
/**
|
|
19129
|
-
*
|
|
19130
|
-
* @interface
|
|
19445
|
+
* @deprecated Renamed to {@link HiddenEvent}.
|
|
19131
19446
|
*/
|
|
19132
|
-
declare type WindowHiddenEvent =
|
|
19133
|
-
type: 'hidden';
|
|
19134
|
-
reason: 'closing' | 'hide' | 'hide-on-close';
|
|
19135
|
-
};
|
|
19447
|
+
declare type WindowHiddenEvent = HiddenEvent_2;
|
|
19136
19448
|
|
|
19137
19449
|
/**
|
|
19138
|
-
*
|
|
19139
|
-
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
|
19140
|
-
* @interface
|
|
19450
|
+
* @deprecated Renamed to {@link HotkeyEvent}.
|
|
19141
19451
|
*/
|
|
19142
|
-
declare type WindowHotkeyEvent =
|
|
19143
|
-
type: 'hotkey';
|
|
19144
|
-
};
|
|
19452
|
+
declare type WindowHotkeyEvent = HotkeyEvent_2;
|
|
19145
19453
|
|
|
19146
19454
|
/**
|
|
19147
19455
|
* @interface
|
|
@@ -19155,12 +19463,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19155
19463
|
};
|
|
19156
19464
|
|
|
19157
19465
|
/**
|
|
19158
|
-
*
|
|
19159
|
-
* @interface
|
|
19466
|
+
* @deprecated Renamed to {@link InitializedEvent}.
|
|
19160
19467
|
*/
|
|
19161
|
-
declare type WindowInitializedEvent =
|
|
19162
|
-
type: 'initialized';
|
|
19163
|
-
};
|
|
19468
|
+
declare type WindowInitializedEvent = InitializedEvent_2;
|
|
19164
19469
|
|
|
19165
19470
|
/**
|
|
19166
19471
|
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
|
@@ -19279,15 +19584,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19279
19584
|
declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
|
|
19280
19585
|
|
|
19281
19586
|
/**
|
|
19282
|
-
*
|
|
19283
|
-
* @remarks Will not fire if the diff object is empty.
|
|
19284
|
-
* @interface
|
|
19587
|
+
* @deprecated Renamed to {@link OptionsChangedEvent}.
|
|
19285
19588
|
*/
|
|
19286
|
-
declare type WindowOptionsChangedEvent_2 =
|
|
19287
|
-
type: 'options-changed';
|
|
19288
|
-
options: OpenFin_2.WindowOptions;
|
|
19289
|
-
diff: OpenFin_2.WindowOptionDiff;
|
|
19290
|
-
};
|
|
19589
|
+
declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
|
|
19291
19590
|
|
|
19292
19591
|
declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
|
|
19293
19592
|
|
|
@@ -19300,35 +19599,25 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19300
19599
|
};
|
|
19301
19600
|
|
|
19302
19601
|
/**
|
|
19303
|
-
*
|
|
19304
|
-
* @interface
|
|
19602
|
+
* @deprecated Renamed to {@link RestoredEvent}.
|
|
19305
19603
|
*/
|
|
19306
|
-
declare type WindowRestoredEvent =
|
|
19307
|
-
type: 'restored';
|
|
19308
|
-
};
|
|
19604
|
+
declare type WindowRestoredEvent = RestoredEvent;
|
|
19309
19605
|
|
|
19310
19606
|
/**
|
|
19311
|
-
*
|
|
19312
|
-
* @interface
|
|
19607
|
+
* @deprecated Renamed to {@link ShownEvent}.
|
|
19313
19608
|
*/
|
|
19314
|
-
declare type WindowShownEvent =
|
|
19315
|
-
type: 'shown';
|
|
19316
|
-
};
|
|
19609
|
+
declare type WindowShownEvent = ShownEvent_2;
|
|
19317
19610
|
|
|
19318
19611
|
/**
|
|
19319
|
-
*
|
|
19320
|
-
* @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.
|
|
19321
|
-
* @interface
|
|
19612
|
+
* @deprecated Renamed to {@link ShowRequestedEvent}.
|
|
19322
19613
|
*/
|
|
19323
|
-
declare type WindowShowRequestedEvent =
|
|
19324
|
-
type: 'show-requested';
|
|
19325
|
-
};
|
|
19614
|
+
declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
19326
19615
|
|
|
19327
19616
|
/**
|
|
19328
19617
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
19329
19618
|
* from {@link OpenFin.ViewEvents}.
|
|
19330
19619
|
*/
|
|
19331
|
-
declare type WindowSourcedEvent =
|
|
19620
|
+
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;
|
|
19332
19621
|
|
|
19333
19622
|
/**
|
|
19334
19623
|
* Generated when a child window starts loading.
|