@openfin/core 35.78.1 → 35.78.5
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 +666 -371
- package/out/mock-beta.d.ts +666 -371
- package/out/mock-public.d.ts +666 -371
- package/out/mock.d.ts +704 -397
- package/out/mock.js +0 -1
- package/package.json +2 -2
package/out/mock-beta.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,
|
|
@@ -916,6 +919,7 @@ declare namespace ApplicationEvents {
|
|
|
916
919
|
WindowStartLoadEvent,
|
|
917
920
|
ApplicationWindowEvent,
|
|
918
921
|
ClosedEvent,
|
|
922
|
+
ConnectedEvent_2 as ConnectedEvent,
|
|
919
923
|
ApplicationConnectedEvent,
|
|
920
924
|
InitializedEvent,
|
|
921
925
|
ManifestChangedEvent,
|
|
@@ -923,19 +927,23 @@ declare namespace ApplicationEvents {
|
|
|
923
927
|
RespondingEvent,
|
|
924
928
|
StartedEvent,
|
|
925
929
|
ApplicationSourcedEvent,
|
|
930
|
+
Event_3 as Event,
|
|
926
931
|
ApplicationEvent,
|
|
932
|
+
EventType_3 as EventType,
|
|
927
933
|
ApplicationEventType,
|
|
934
|
+
PropagatedEvent_4 as PropagatedEvent,
|
|
928
935
|
PropagatedApplicationEvent,
|
|
936
|
+
PropagatedEventType_3 as PropagatedEventType,
|
|
929
937
|
PropagatedApplicationEventType,
|
|
930
|
-
|
|
931
|
-
ByType
|
|
938
|
+
Payload_4 as Payload,
|
|
939
|
+
ByType_3 as ByType
|
|
932
940
|
}
|
|
933
941
|
}
|
|
934
942
|
|
|
935
943
|
/**
|
|
936
|
-
*
|
|
944
|
+
* @deprecated Renamed to {@link EventType}.
|
|
937
945
|
*/
|
|
938
|
-
declare type ApplicationEventType =
|
|
946
|
+
declare type ApplicationEventType = EventType_3;
|
|
939
947
|
|
|
940
948
|
declare type ApplicationIdentity = OpenFin_2.ApplicationIdentity;
|
|
941
949
|
|
|
@@ -1288,9 +1296,8 @@ declare type ApplicationPermissions = {
|
|
|
1288
1296
|
* A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
|
|
1289
1297
|
* from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
|
|
1290
1298
|
* does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
|
|
1291
|
-
*
|
|
1292
1299
|
*/
|
|
1293
|
-
declare type ApplicationSourcedEvent = ClosedEvent |
|
|
1300
|
+
declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
|
1294
1301
|
|
|
1295
1302
|
declare type ApplicationState = OpenFin_2.ApplicationState;
|
|
1296
1303
|
|
|
@@ -1598,7 +1605,7 @@ declare interface AuthorizationPayload {
|
|
|
1598
1605
|
* ```
|
|
1599
1606
|
* @interface
|
|
1600
1607
|
*/
|
|
1601
|
-
declare type AuthRequestedEvent =
|
|
1608
|
+
declare type AuthRequestedEvent = BaseEvent_5 & {
|
|
1602
1609
|
type: 'auth-requested';
|
|
1603
1610
|
authInfo: {
|
|
1604
1611
|
host: string;
|
|
@@ -1660,21 +1667,9 @@ declare class Base {
|
|
|
1660
1667
|
}
|
|
1661
1668
|
|
|
1662
1669
|
/**
|
|
1663
|
-
*
|
|
1664
|
-
* @interface
|
|
1665
|
-
*/
|
|
1666
|
-
declare type BaseApplicationEvent = NamedEvent & {
|
|
1667
|
-
topic: `application`;
|
|
1668
|
-
};
|
|
1669
|
-
|
|
1670
|
-
/**
|
|
1671
|
-
* A base Channel event.
|
|
1672
|
-
* @interface
|
|
1670
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1673
1671
|
*/
|
|
1674
|
-
declare type
|
|
1675
|
-
channelName: string;
|
|
1676
|
-
channelId: string;
|
|
1677
|
-
};
|
|
1672
|
+
declare type BaseApplicationEvent = BaseEvent_3;
|
|
1678
1673
|
|
|
1679
1674
|
/**
|
|
1680
1675
|
* @interface
|
|
@@ -1743,10 +1738,70 @@ declare type BaseEvent = {
|
|
|
1743
1738
|
type: string;
|
|
1744
1739
|
};
|
|
1745
1740
|
|
|
1746
|
-
|
|
1741
|
+
/**
|
|
1742
|
+
* A base Channel event.
|
|
1743
|
+
* @interface
|
|
1744
|
+
*/
|
|
1745
|
+
declare type BaseEvent_2 = NamedEvent & {
|
|
1746
|
+
channelName: string;
|
|
1747
|
+
channelId: string;
|
|
1748
|
+
};
|
|
1749
|
+
|
|
1750
|
+
/**
|
|
1751
|
+
* Base type for events emitting on the `application` topic
|
|
1752
|
+
* @interface
|
|
1753
|
+
*/
|
|
1754
|
+
declare type BaseEvent_3 = BaseEvents.NamedEvent & {
|
|
1755
|
+
topic: `application`;
|
|
1756
|
+
};
|
|
1757
|
+
|
|
1758
|
+
/**
|
|
1759
|
+
* Base type for events emitting on the `view` topic
|
|
1760
|
+
* @interface
|
|
1761
|
+
*/
|
|
1762
|
+
declare type BaseEvent_4 = BaseEvents.NamedEvent & {
|
|
1763
|
+
topic: 'view';
|
|
1764
|
+
target: OpenFin_2.Identity;
|
|
1765
|
+
};
|
|
1766
|
+
|
|
1767
|
+
/**
|
|
1768
|
+
* Base type for events emitting on the `window` topic
|
|
1769
|
+
* @interface
|
|
1770
|
+
*/
|
|
1771
|
+
declare type BaseEvent_5 = BaseEvents.NamedEvent & {
|
|
1772
|
+
topic: 'window';
|
|
1773
|
+
};
|
|
1774
|
+
|
|
1775
|
+
/**
|
|
1776
|
+
* Base type for events emitting on the `externalapplication` topic
|
|
1777
|
+
* @interface
|
|
1778
|
+
*/
|
|
1779
|
+
declare type BaseEvent_6 = BaseEvents.BaseEvent & {
|
|
1780
|
+
topic: 'externalapplication';
|
|
1781
|
+
};
|
|
1782
|
+
|
|
1783
|
+
/**
|
|
1784
|
+
* The base frame event.
|
|
1785
|
+
* @interface
|
|
1786
|
+
*/
|
|
1787
|
+
declare type BaseEvent_7 = NamedEvent & {
|
|
1788
|
+
entityType: 'iframe';
|
|
1789
|
+
frameName: string;
|
|
1790
|
+
};
|
|
1791
|
+
|
|
1792
|
+
/**
|
|
1793
|
+
* Base type for events emitting on the `system` topic
|
|
1794
|
+
* @interface
|
|
1795
|
+
*/
|
|
1796
|
+
declare type BaseEvent_8 = BaseEvents.BaseEvent & {
|
|
1797
|
+
topic: 'system';
|
|
1798
|
+
};
|
|
1799
|
+
|
|
1800
|
+
declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
|
|
1747
1801
|
|
|
1748
1802
|
declare namespace BaseEvents {
|
|
1749
1803
|
export {
|
|
1804
|
+
NotCloseRequested,
|
|
1750
1805
|
PropagatedEventType,
|
|
1751
1806
|
PropagatedEvent,
|
|
1752
1807
|
EventHandler,
|
|
@@ -1757,21 +1812,14 @@ declare namespace BaseEvents {
|
|
|
1757
1812
|
}
|
|
1758
1813
|
|
|
1759
1814
|
/**
|
|
1760
|
-
*
|
|
1761
|
-
* @interface
|
|
1815
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1762
1816
|
*/
|
|
1763
|
-
declare type BaseExternalApplicationEvent =
|
|
1764
|
-
topic: 'externalapplication';
|
|
1765
|
-
};
|
|
1817
|
+
declare type BaseExternalApplicationEvent = BaseEvent_6;
|
|
1766
1818
|
|
|
1767
1819
|
/**
|
|
1768
|
-
*
|
|
1769
|
-
* @interface
|
|
1820
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1770
1821
|
*/
|
|
1771
|
-
declare type BaseFrameEvent =
|
|
1772
|
-
entityType: 'iframe';
|
|
1773
|
-
frameName: string;
|
|
1774
|
-
};
|
|
1822
|
+
declare type BaseFrameEvent = BaseEvent_7;
|
|
1775
1823
|
|
|
1776
1824
|
declare type BaseLoadFailedEvent = NamedEvent & {
|
|
1777
1825
|
errorCode: number;
|
|
@@ -1780,35 +1828,20 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
|
1780
1828
|
isMainFrame: boolean;
|
|
1781
1829
|
};
|
|
1782
1830
|
|
|
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
1831
|
declare type BaseUrlEvent = NamedEvent & {
|
|
1792
1832
|
type: 'url-changed';
|
|
1793
1833
|
url: string;
|
|
1794
1834
|
};
|
|
1795
1835
|
|
|
1796
1836
|
/**
|
|
1797
|
-
*
|
|
1798
|
-
* @interface
|
|
1837
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1799
1838
|
*/
|
|
1800
|
-
declare type BaseViewEvent =
|
|
1801
|
-
topic: 'view';
|
|
1802
|
-
target: OpenFin_2.Identity;
|
|
1803
|
-
};
|
|
1839
|
+
declare type BaseViewEvent = BaseEvent_4;
|
|
1804
1840
|
|
|
1805
1841
|
/**
|
|
1806
|
-
*
|
|
1807
|
-
* @interface
|
|
1842
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1808
1843
|
*/
|
|
1809
|
-
declare type BaseWindowEvent =
|
|
1810
|
-
topic: 'window';
|
|
1811
|
-
};
|
|
1844
|
+
declare type BaseWindowEvent = BaseEvent_5;
|
|
1812
1845
|
|
|
1813
1846
|
/**
|
|
1814
1847
|
* User decision of whether a Window or specific View should close when trying to prevent an unload.
|
|
@@ -1875,7 +1908,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
|
1875
1908
|
* A general bounds change event without event type.
|
|
1876
1909
|
* @interface
|
|
1877
1910
|
*/
|
|
1878
|
-
declare type BoundsChangeEvent =
|
|
1911
|
+
declare type BoundsChangeEvent = BaseEvent_5 & {
|
|
1879
1912
|
changeType: 0 | 1 | 2;
|
|
1880
1913
|
deferred: boolean;
|
|
1881
1914
|
height: number;
|
|
@@ -1947,76 +1980,76 @@ declare interface BrowserWindow {
|
|
|
1947
1980
|
}
|
|
1948
1981
|
|
|
1949
1982
|
/**
|
|
1950
|
-
* Extracts a single event type matching the given key from the {@link
|
|
1983
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
1951
1984
|
*
|
|
1952
1985
|
* Alias for {@link Payload}, which may read better in source.
|
|
1953
1986
|
*
|
|
1954
1987
|
* @typeParam Type String key specifying the event to extract
|
|
1955
1988
|
*/
|
|
1956
|
-
declare type ByType<Type extends
|
|
1989
|
+
declare type ByType<Type extends EventType> = Payload_2<Type>;
|
|
1957
1990
|
|
|
1958
1991
|
/**
|
|
1959
|
-
* Extracts a single event type matching the given key from the {@link
|
|
1992
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
1960
1993
|
*
|
|
1961
1994
|
* Alias for {@link Payload}, which may read better in source.
|
|
1962
1995
|
*
|
|
1963
1996
|
* @typeParam Type String key specifying the event to extract
|
|
1964
1997
|
*/
|
|
1965
|
-
declare type ByType_2<Type extends
|
|
1998
|
+
declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
|
1966
1999
|
|
|
1967
2000
|
/**
|
|
1968
|
-
* Extracts a single event type matching the given key from the {@link
|
|
2001
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
1969
2002
|
*
|
|
1970
2003
|
* Alias for {@link Payload}, which may read better in source.
|
|
1971
2004
|
*
|
|
1972
2005
|
* @typeParam Type String key specifying the event to extract
|
|
1973
2006
|
*/
|
|
1974
|
-
declare type ByType_3<Type extends
|
|
2007
|
+
declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
|
1975
2008
|
|
|
1976
2009
|
/**
|
|
1977
|
-
* Extracts a single event type matching the given key from the {@link
|
|
2010
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
1978
2011
|
*
|
|
1979
2012
|
* Alias for {@link Payload}, which may read better in source.
|
|
1980
2013
|
*
|
|
1981
2014
|
* @typeParam Type String key specifying the event to extract
|
|
1982
2015
|
*/
|
|
1983
|
-
declare type ByType_4<Type extends
|
|
2016
|
+
declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
|
1984
2017
|
|
|
1985
2018
|
/**
|
|
1986
|
-
* Extracts a single event type matching the given key from the {@link
|
|
2019
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
1987
2020
|
*
|
|
1988
2021
|
* Alias for {@link Payload}, which may read better in source.
|
|
1989
2022
|
*
|
|
1990
2023
|
* @typeParam Type String key specifying the event to extract
|
|
1991
2024
|
*/
|
|
1992
|
-
declare type ByType_5<Type extends
|
|
2025
|
+
declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
|
1993
2026
|
|
|
1994
2027
|
/**
|
|
1995
|
-
* Extracts a single event type matching the given key from the {@link
|
|
2028
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
1996
2029
|
*
|
|
1997
2030
|
* Alias for {@link Payload}, which may read better in source.
|
|
1998
2031
|
*
|
|
1999
2032
|
* @typeParam Type String key specifying the event to extract
|
|
2000
2033
|
*/
|
|
2001
|
-
declare type ByType_6<Type extends
|
|
2034
|
+
declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
|
2002
2035
|
|
|
2003
2036
|
/**
|
|
2004
|
-
* Extracts a single event type matching the given key from the {@link
|
|
2037
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
2005
2038
|
*
|
|
2006
2039
|
* Alias for {@link Payload}, which may read better in source.
|
|
2007
2040
|
*
|
|
2008
2041
|
* @typeParam Type String key specifying the event to extract
|
|
2009
2042
|
*/
|
|
2010
|
-
declare type ByType_7<Type extends
|
|
2043
|
+
declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
|
2011
2044
|
|
|
2012
2045
|
/**
|
|
2013
|
-
* Extracts a single event type matching the given key from the {@link
|
|
2046
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
2014
2047
|
*
|
|
2015
2048
|
* Alias for {@link Payload}, which may read better in source.
|
|
2016
2049
|
*
|
|
2017
2050
|
* @typeParam Type String key specifying the event to extract
|
|
2018
2051
|
*/
|
|
2019
|
-
declare type ByType_8<Type extends
|
|
2052
|
+
declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
|
2020
2053
|
|
|
2021
2054
|
/**
|
|
2022
2055
|
* Configuration for page capture.
|
|
@@ -2682,14 +2715,6 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
|
|
|
2682
2715
|
|
|
2683
2716
|
declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
|
|
2684
2717
|
|
|
2685
|
-
/**
|
|
2686
|
-
* Generated when a Channel client is connected.
|
|
2687
|
-
* @interface
|
|
2688
|
-
*/
|
|
2689
|
-
declare type ChannelConnectedEvent = BaseChannelEvent & {
|
|
2690
|
-
type: 'connected';
|
|
2691
|
-
};
|
|
2692
|
-
|
|
2693
2718
|
/**
|
|
2694
2719
|
* Options provided on a client connection to a channel.
|
|
2695
2720
|
*
|
|
@@ -2721,21 +2746,9 @@ declare type ChannelCreateOptions = {
|
|
|
2721
2746
|
};
|
|
2722
2747
|
|
|
2723
2748
|
/**
|
|
2724
|
-
*
|
|
2725
|
-
* @interface
|
|
2749
|
+
* @deprecated Renamed to {@link Event}.
|
|
2726
2750
|
*/
|
|
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);
|
|
2751
|
+
declare type ChannelEvent = Event_2;
|
|
2739
2752
|
|
|
2740
2753
|
declare type ChannelMiddleware = OpenFin_2.ChannelMiddleware;
|
|
2741
2754
|
|
|
@@ -3270,11 +3283,19 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
|
|
|
3270
3283
|
* Generated when an application is closed.
|
|
3271
3284
|
* @interface
|
|
3272
3285
|
*/
|
|
3273
|
-
declare type ClosedEvent = IdentityEvent & {
|
|
3286
|
+
declare type ClosedEvent = BaseEvents.IdentityEvent & {
|
|
3274
3287
|
topic: 'application';
|
|
3275
3288
|
type: 'closed';
|
|
3276
3289
|
};
|
|
3277
3290
|
|
|
3291
|
+
/**
|
|
3292
|
+
* Generated when a window has closed.
|
|
3293
|
+
* @interface
|
|
3294
|
+
*/
|
|
3295
|
+
declare type ClosedEvent_2 = BaseEvent_5 & {
|
|
3296
|
+
type: 'closed';
|
|
3297
|
+
};
|
|
3298
|
+
|
|
3278
3299
|
/**
|
|
3279
3300
|
* @interface
|
|
3280
3301
|
*/
|
|
@@ -3282,6 +3303,15 @@ declare type ClosedMenuResult = {
|
|
|
3282
3303
|
result: 'closed';
|
|
3283
3304
|
};
|
|
3284
3305
|
|
|
3306
|
+
/**
|
|
3307
|
+
* Generated when a window has been prevented from closing.
|
|
3308
|
+
* @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.
|
|
3309
|
+
* @interface
|
|
3310
|
+
*/
|
|
3311
|
+
declare type CloseRequestedEvent = BaseEvent_5 & {
|
|
3312
|
+
type: 'close-requested';
|
|
3313
|
+
};
|
|
3314
|
+
|
|
3285
3315
|
/**
|
|
3286
3316
|
* @interface
|
|
3287
3317
|
*/
|
|
@@ -3328,6 +3358,14 @@ declare interface CloseWindowPayload {
|
|
|
3328
3358
|
};
|
|
3329
3359
|
}
|
|
3330
3360
|
|
|
3361
|
+
/**
|
|
3362
|
+
* Generated when a window has initiated the closing routine.
|
|
3363
|
+
* @interface
|
|
3364
|
+
*/
|
|
3365
|
+
declare type ClosingEvent = BaseEvent_5 & {
|
|
3366
|
+
type: 'closing';
|
|
3367
|
+
};
|
|
3368
|
+
|
|
3331
3369
|
/**
|
|
3332
3370
|
* A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
|
|
3333
3371
|
*/
|
|
@@ -3407,6 +3445,39 @@ declare type ConfigWithUuid = BaseConfig & {
|
|
|
3407
3445
|
uuid: string;
|
|
3408
3446
|
};
|
|
3409
3447
|
|
|
3448
|
+
/**
|
|
3449
|
+
* Generated when a Channel client is connected.
|
|
3450
|
+
* @interface
|
|
3451
|
+
*/
|
|
3452
|
+
declare type ConnectedEvent = BaseEvent_2 & {
|
|
3453
|
+
type: 'connected';
|
|
3454
|
+
};
|
|
3455
|
+
|
|
3456
|
+
/**
|
|
3457
|
+
* Generated when an application has authenticated and is connected.
|
|
3458
|
+
* @interface
|
|
3459
|
+
*/
|
|
3460
|
+
declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
|
|
3461
|
+
topic: 'application';
|
|
3462
|
+
type: 'connected';
|
|
3463
|
+
};
|
|
3464
|
+
|
|
3465
|
+
/**
|
|
3466
|
+
* Generated when an external application has authenticated and is connected.
|
|
3467
|
+
* @interface
|
|
3468
|
+
*/
|
|
3469
|
+
declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
|
|
3470
|
+
type: 'connected';
|
|
3471
|
+
};
|
|
3472
|
+
|
|
3473
|
+
/**
|
|
3474
|
+
* Generated when a frame is connected.
|
|
3475
|
+
* @interface
|
|
3476
|
+
*/
|
|
3477
|
+
declare type ConnectedEvent_4 = BaseFrameEvent & {
|
|
3478
|
+
type: 'connected';
|
|
3479
|
+
};
|
|
3480
|
+
|
|
3410
3481
|
declare type Constructor<T = {}> = new () => T;
|
|
3411
3482
|
|
|
3412
3483
|
declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
|
@@ -4148,7 +4219,7 @@ declare type Context_3 = {
|
|
|
4148
4219
|
* Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
|
|
4149
4220
|
* @interface
|
|
4150
4221
|
*/
|
|
4151
|
-
declare type ContextChangedEvent =
|
|
4222
|
+
declare type ContextChangedEvent = BaseEvent_5 & {
|
|
4152
4223
|
type: 'context-changed';
|
|
4153
4224
|
context: any;
|
|
4154
4225
|
};
|
|
@@ -4300,7 +4371,7 @@ declare type CpuInfo = {
|
|
|
4300
4371
|
* Generated when an application has crashed.
|
|
4301
4372
|
* @interface
|
|
4302
4373
|
*/
|
|
4303
|
-
declare type CrashedEvent = IdentityEvent & {
|
|
4374
|
+
declare type CrashedEvent = BaseEvents.IdentityEvent & {
|
|
4304
4375
|
topic: 'application';
|
|
4305
4376
|
type: 'crashed';
|
|
4306
4377
|
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
|
@@ -4351,7 +4422,7 @@ declare type CrashReporterState = CrashReporterOptions & {
|
|
|
4351
4422
|
* Generated when a View is created.
|
|
4352
4423
|
* @interface
|
|
4353
4424
|
*/
|
|
4354
|
-
declare type CreatedEvent =
|
|
4425
|
+
declare type CreatedEvent = BaseEvent_4 & {
|
|
4355
4426
|
type: 'created';
|
|
4356
4427
|
};
|
|
4357
4428
|
|
|
@@ -4510,7 +4581,7 @@ declare interface DesktopAgent_2 {
|
|
|
4510
4581
|
* Generated when the desktop icon is clicked while it's already running.
|
|
4511
4582
|
* @interface
|
|
4512
4583
|
*/
|
|
4513
|
-
declare type DesktopIconClickedEvent =
|
|
4584
|
+
declare type DesktopIconClickedEvent = BaseEvent_8 & {
|
|
4514
4585
|
type: 'desktop-icon-clicked';
|
|
4515
4586
|
};
|
|
4516
4587
|
|
|
@@ -4518,7 +4589,7 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
|
|
|
4518
4589
|
* Generated when a View is destroyed.
|
|
4519
4590
|
* @interface
|
|
4520
4591
|
*/
|
|
4521
|
-
declare type DestroyedEvent =
|
|
4592
|
+
declare type DestroyedEvent = BaseEvent_4 & {
|
|
4522
4593
|
type: 'destroyed';
|
|
4523
4594
|
};
|
|
4524
4595
|
|
|
@@ -4618,6 +4689,30 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
|
4618
4689
|
type: 'disabled-movement-bounds-changing';
|
|
4619
4690
|
};
|
|
4620
4691
|
|
|
4692
|
+
/**
|
|
4693
|
+
* Generated when a Channel client has disconnected.
|
|
4694
|
+
* @interface
|
|
4695
|
+
*/
|
|
4696
|
+
declare type DisconnectedEvent = BaseEvent_2 & {
|
|
4697
|
+
type: 'disconnected';
|
|
4698
|
+
};
|
|
4699
|
+
|
|
4700
|
+
/**
|
|
4701
|
+
* Generated when an external application has disconnected.
|
|
4702
|
+
* @interface
|
|
4703
|
+
*/
|
|
4704
|
+
declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
|
|
4705
|
+
type: 'disconnected';
|
|
4706
|
+
};
|
|
4707
|
+
|
|
4708
|
+
/**
|
|
4709
|
+
* Generated when a frame has disconnected.
|
|
4710
|
+
* @interface
|
|
4711
|
+
*/
|
|
4712
|
+
declare type DisconnectedEvent_3 = BaseFrameEvent & {
|
|
4713
|
+
type: 'disconnected';
|
|
4714
|
+
};
|
|
4715
|
+
|
|
4621
4716
|
/**
|
|
4622
4717
|
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
|
4623
4718
|
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
|
@@ -4751,7 +4846,7 @@ declare type DownloadShelfOptions = {
|
|
|
4751
4846
|
*
|
|
4752
4847
|
* @interface
|
|
4753
4848
|
*/
|
|
4754
|
-
declare type DownloadShelfVisibilityChangedEvent =
|
|
4849
|
+
declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
|
|
4755
4850
|
type: 'download-shelf-visibility-changed';
|
|
4756
4851
|
/**
|
|
4757
4852
|
* True if the download shelf was just opened; false if it was just closed.
|
|
@@ -4781,7 +4876,7 @@ declare interface DragSource {}
|
|
|
4781
4876
|
* Generated when a window has been embedded.
|
|
4782
4877
|
* @interface
|
|
4783
4878
|
*/
|
|
4784
|
-
declare type EmbeddedEvent =
|
|
4879
|
+
declare type EmbeddedEvent = BaseEvent_5 & {
|
|
4785
4880
|
type: 'embedded';
|
|
4786
4881
|
};
|
|
4787
4882
|
|
|
@@ -4880,7 +4975,7 @@ declare class EmitterMap {
|
|
|
4880
4975
|
* Generated when a window ends loading.
|
|
4881
4976
|
* @interface
|
|
4882
4977
|
*/
|
|
4883
|
-
declare type EndLoadEvent =
|
|
4978
|
+
declare type EndLoadEvent = BaseEvent_5 & {
|
|
4884
4979
|
type: 'end-load';
|
|
4885
4980
|
documentName: string;
|
|
4886
4981
|
isMain: boolean;
|
|
@@ -4997,6 +5092,88 @@ declare type ErrorPlainObject = {
|
|
|
4997
5092
|
toString(): string;
|
|
4998
5093
|
};
|
|
4999
5094
|
|
|
5095
|
+
/**
|
|
5096
|
+
* [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
|
|
5097
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
|
|
5098
|
+
* under the {@link OpenFin.PlatformEvents} namespace.
|
|
5099
|
+
*/
|
|
5100
|
+
declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
|
|
5101
|
+
|
|
5102
|
+
/**
|
|
5103
|
+
* [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
|
|
5104
|
+
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
|
5105
|
+
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
5106
|
+
* from which they propagate).
|
|
5107
|
+
*/
|
|
5108
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
|
5109
|
+
|
|
5110
|
+
/**
|
|
5111
|
+
* [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
|
|
5112
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
|
|
5113
|
+
* under the {@link OpenFin.ChannelEvents} namespace.
|
|
5114
|
+
*/
|
|
5115
|
+
declare type Event_2 = {
|
|
5116
|
+
topic: 'channel';
|
|
5117
|
+
} & (ConnectedEvent | DisconnectedEvent);
|
|
5118
|
+
|
|
5119
|
+
/**
|
|
5120
|
+
* [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
|
|
5121
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
|
|
5122
|
+
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
5123
|
+
* from which they propagate).
|
|
5124
|
+
*/
|
|
5125
|
+
declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
|
|
5126
|
+
|
|
5127
|
+
/**
|
|
5128
|
+
* [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
|
|
5129
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
|
|
5130
|
+
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
|
5131
|
+
*/
|
|
5132
|
+
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
5133
|
+
target: OpenFin_2.Identity;
|
|
5134
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
|
5135
|
+
|
|
5136
|
+
/**
|
|
5137
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
|
5138
|
+
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
|
5139
|
+
*/
|
|
5140
|
+
declare type Event_5<Topic extends string> = {
|
|
5141
|
+
topic: Topic;
|
|
5142
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
|
5143
|
+
|
|
5144
|
+
/**
|
|
5145
|
+
* [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
|
|
5146
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
|
|
5147
|
+
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
|
5148
|
+
*/
|
|
5149
|
+
declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
|
|
5150
|
+
|
|
5151
|
+
/**
|
|
5152
|
+
* [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
|
|
5153
|
+
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
|
5154
|
+
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
|
5155
|
+
*/
|
|
5156
|
+
declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
|
|
5157
|
+
|
|
5158
|
+
/**
|
|
5159
|
+
* [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
|
|
5160
|
+
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
|
5161
|
+
* under the {@link OpenFin.FrameEvents} namespace.
|
|
5162
|
+
*/
|
|
5163
|
+
declare type Event_8 = {
|
|
5164
|
+
topic: 'frame';
|
|
5165
|
+
} & (ConnectedEvent_4 | DisconnectedEvent_3);
|
|
5166
|
+
|
|
5167
|
+
/**
|
|
5168
|
+
* [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
|
|
5169
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
|
5170
|
+
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
|
5171
|
+
*/
|
|
5172
|
+
declare type Event_9 = {
|
|
5173
|
+
topic: 'global-hotkey';
|
|
5174
|
+
hotkey: 'string';
|
|
5175
|
+
} & (RegisteredEvent | UnregisteredEvent);
|
|
5176
|
+
|
|
5000
5177
|
declare class EventAggregator extends EmitterMap {
|
|
5001
5178
|
dispatchEvent: (message: Message<any>) => boolean;
|
|
5002
5179
|
}
|
|
@@ -5062,6 +5239,46 @@ declare namespace Events {
|
|
|
5062
5239
|
}
|
|
5063
5240
|
}
|
|
5064
5241
|
|
|
5242
|
+
/**
|
|
5243
|
+
* Union of possible `type` values for a view {@link Event}.
|
|
5244
|
+
*/
|
|
5245
|
+
declare type EventType = Event_4['type'];
|
|
5246
|
+
|
|
5247
|
+
/**
|
|
5248
|
+
* Union of possible `type` values for a Window {@link Event}.
|
|
5249
|
+
*/
|
|
5250
|
+
declare type EventType_2 = Event_6['type'];
|
|
5251
|
+
|
|
5252
|
+
/**
|
|
5253
|
+
* Union of possible `type` values for an Application {@link Event}.
|
|
5254
|
+
*/
|
|
5255
|
+
declare type EventType_3 = Event_3['type'];
|
|
5256
|
+
|
|
5257
|
+
/**
|
|
5258
|
+
* Union of possible `type` values for an ExternalApplication {@link Event}.
|
|
5259
|
+
*/
|
|
5260
|
+
declare type EventType_4 = Event_7['type'];
|
|
5261
|
+
|
|
5262
|
+
/**
|
|
5263
|
+
* Union of possible `type` values for a {@link FrameEvent}.
|
|
5264
|
+
*/
|
|
5265
|
+
declare type EventType_5 = Event_8['type'];
|
|
5266
|
+
|
|
5267
|
+
/**
|
|
5268
|
+
* Union of possible `type` values for a {@link GlobalHotkeyEvent}
|
|
5269
|
+
*/
|
|
5270
|
+
declare type EventType_6 = Event_9['type'];
|
|
5271
|
+
|
|
5272
|
+
/**
|
|
5273
|
+
* Union of possible `type` values for a {@link PlatformEvent}.
|
|
5274
|
+
*/
|
|
5275
|
+
declare type EventType_7 = Event_10['type'];
|
|
5276
|
+
|
|
5277
|
+
/**
|
|
5278
|
+
* Union of possible `type` values for a {@link SystemEvent}.
|
|
5279
|
+
*/
|
|
5280
|
+
declare type EventType_8 = SystemEvent['type'];
|
|
5281
|
+
|
|
5065
5282
|
/* Excluded from this release type: EventWithId */
|
|
5066
5283
|
|
|
5067
5284
|
/* Excluded from this release type: ExcludeRequested */
|
|
@@ -5185,46 +5402,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
|
|
|
5185
5402
|
}
|
|
5186
5403
|
|
|
5187
5404
|
/**
|
|
5188
|
-
*
|
|
5189
|
-
* @interface
|
|
5405
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
|
5190
5406
|
*/
|
|
5191
|
-
declare type ExternalApplicationConnectedEvent =
|
|
5192
|
-
type: 'connected';
|
|
5193
|
-
};
|
|
5407
|
+
declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
|
|
5194
5408
|
|
|
5195
5409
|
/**
|
|
5196
|
-
*
|
|
5197
|
-
* @interface
|
|
5410
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
|
5198
5411
|
*/
|
|
5199
|
-
declare type ExternalApplicationDisconnectedEvent =
|
|
5200
|
-
type: 'disconnected';
|
|
5201
|
-
};
|
|
5412
|
+
declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
|
|
5202
5413
|
|
|
5203
5414
|
/**
|
|
5204
|
-
*
|
|
5205
|
-
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
|
5206
|
-
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
|
5415
|
+
* @deprecated Renamed to {@link Event}.
|
|
5207
5416
|
*/
|
|
5208
|
-
declare type ExternalApplicationEvent =
|
|
5417
|
+
declare type ExternalApplicationEvent = Event_7;
|
|
5209
5418
|
|
|
5210
5419
|
declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
|
|
5211
5420
|
|
|
5212
5421
|
declare namespace ExternalApplicationEvents {
|
|
5213
5422
|
export {
|
|
5423
|
+
BaseEvent_6 as BaseEvent,
|
|
5214
5424
|
BaseExternalApplicationEvent,
|
|
5425
|
+
ConnectedEvent_3 as ConnectedEvent,
|
|
5215
5426
|
ExternalApplicationConnectedEvent,
|
|
5427
|
+
DisconnectedEvent_2 as DisconnectedEvent,
|
|
5216
5428
|
ExternalApplicationDisconnectedEvent,
|
|
5429
|
+
Event_7 as Event,
|
|
5217
5430
|
ExternalApplicationEvent,
|
|
5431
|
+
EventType_4 as EventType,
|
|
5218
5432
|
ExternalApplicationEventType,
|
|
5219
|
-
|
|
5220
|
-
|
|
5433
|
+
Payload_5 as Payload,
|
|
5434
|
+
ByType_4 as ByType
|
|
5221
5435
|
}
|
|
5222
5436
|
}
|
|
5223
5437
|
|
|
5224
5438
|
/**
|
|
5225
|
-
*
|
|
5439
|
+
* @deprecated Renamed to {@link Event}.
|
|
5226
5440
|
*/
|
|
5227
|
-
declare type ExternalApplicationEventType =
|
|
5441
|
+
declare type ExternalApplicationEventType = EventType_4;
|
|
5228
5442
|
|
|
5229
5443
|
/**
|
|
5230
5444
|
* @interface
|
|
@@ -5285,7 +5499,7 @@ declare type ExternalConnection = {
|
|
|
5285
5499
|
* Generated when an external process has exited.
|
|
5286
5500
|
* @interface
|
|
5287
5501
|
*/
|
|
5288
|
-
declare type ExternalProcessExitedEvent =
|
|
5502
|
+
declare type ExternalProcessExitedEvent = BaseEvent_5 & {
|
|
5289
5503
|
type: 'external-process-exited';
|
|
5290
5504
|
processUuid: string;
|
|
5291
5505
|
exitCode: number;
|
|
@@ -5330,19 +5544,15 @@ declare type ExternalProcessRequestType = {
|
|
|
5330
5544
|
* Generated when an external process has started.
|
|
5331
5545
|
* @interface
|
|
5332
5546
|
*/
|
|
5333
|
-
declare type ExternalProcessStartedEvent =
|
|
5547
|
+
declare type ExternalProcessStartedEvent = BaseEvent_5 & {
|
|
5334
5548
|
type: 'external-process-started';
|
|
5335
5549
|
processUuid: string;
|
|
5336
5550
|
};
|
|
5337
5551
|
|
|
5338
5552
|
/**
|
|
5339
|
-
*
|
|
5340
|
-
* @interface
|
|
5553
|
+
* @deprecated, use {@link PageFaviconUpdatedEvent}.
|
|
5341
5554
|
*/
|
|
5342
|
-
declare type FaviconUpdatedEvent =
|
|
5343
|
-
type: 'page-favicon-updated';
|
|
5344
|
-
favicons: string[];
|
|
5345
|
-
};
|
|
5555
|
+
declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
|
|
5346
5556
|
|
|
5347
5557
|
declare namespace FDC3 {
|
|
5348
5558
|
export {
|
|
@@ -5429,7 +5639,7 @@ declare type FileDownloadEvent = {
|
|
|
5429
5639
|
*
|
|
5430
5640
|
* @interface
|
|
5431
5641
|
*/
|
|
5432
|
-
declare type FileDownloadLocationChangedEvent =
|
|
5642
|
+
declare type FileDownloadLocationChangedEvent = BaseEvent_3 & {
|
|
5433
5643
|
type: 'file-download-location-changed';
|
|
5434
5644
|
};
|
|
5435
5645
|
|
|
@@ -5698,48 +5908,43 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
|
|
|
5698
5908
|
}
|
|
5699
5909
|
|
|
5700
5910
|
/**
|
|
5701
|
-
*
|
|
5702
|
-
* @interface
|
|
5911
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
|
5703
5912
|
*/
|
|
5704
|
-
declare type FrameConnectedEvent =
|
|
5705
|
-
type: 'connected';
|
|
5706
|
-
};
|
|
5913
|
+
declare type FrameConnectedEvent = ConnectedEvent_4;
|
|
5707
5914
|
|
|
5708
5915
|
/**
|
|
5709
|
-
*
|
|
5710
|
-
* @interface
|
|
5916
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
|
5711
5917
|
*/
|
|
5712
|
-
declare type FrameDisconnectedEvent =
|
|
5713
|
-
type: 'disconnected';
|
|
5714
|
-
};
|
|
5918
|
+
declare type FrameDisconnectedEvent = DisconnectedEvent_3;
|
|
5715
5919
|
|
|
5716
5920
|
/**
|
|
5717
|
-
*
|
|
5718
|
-
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
|
5719
|
-
* under the {@link OpenFin.FrameEvents} namespace.
|
|
5921
|
+
* @deprecated Renamed to {@link Event}.
|
|
5720
5922
|
*/
|
|
5721
|
-
declare type FrameEvent =
|
|
5722
|
-
topic: 'frame';
|
|
5723
|
-
} & (FrameConnectedEvent | FrameDisconnectedEvent);
|
|
5923
|
+
declare type FrameEvent = Event_8;
|
|
5724
5924
|
|
|
5725
5925
|
declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
|
|
5726
5926
|
|
|
5727
5927
|
declare namespace FrameEvents {
|
|
5728
5928
|
export {
|
|
5929
|
+
BaseEvent_7 as BaseEvent,
|
|
5729
5930
|
BaseFrameEvent,
|
|
5931
|
+
ConnectedEvent_4 as ConnectedEvent,
|
|
5730
5932
|
FrameConnectedEvent,
|
|
5933
|
+
DisconnectedEvent_3 as DisconnectedEvent,
|
|
5731
5934
|
FrameDisconnectedEvent,
|
|
5935
|
+
Event_8 as Event,
|
|
5732
5936
|
FrameEvent,
|
|
5937
|
+
EventType_5 as EventType,
|
|
5733
5938
|
FrameEventType,
|
|
5734
|
-
|
|
5735
|
-
|
|
5939
|
+
Payload_6 as Payload,
|
|
5940
|
+
ByType_5 as ByType
|
|
5736
5941
|
}
|
|
5737
5942
|
}
|
|
5738
5943
|
|
|
5739
5944
|
/**
|
|
5740
|
-
*
|
|
5945
|
+
* @deprecated Renamed to {@link EventType}.
|
|
5741
5946
|
*/
|
|
5742
|
-
declare type FrameEventType =
|
|
5947
|
+
declare type FrameEventType = EventType_5;
|
|
5743
5948
|
|
|
5744
5949
|
/**
|
|
5745
5950
|
* @interface
|
|
@@ -5958,14 +6163,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
|
|
|
5958
6163
|
}
|
|
5959
6164
|
|
|
5960
6165
|
/**
|
|
5961
|
-
*
|
|
5962
|
-
* discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
|
5963
|
-
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
|
6166
|
+
* @deprecated Renamed to {@link Event}.
|
|
5964
6167
|
*/
|
|
5965
|
-
declare type GlobalHotkeyEvent =
|
|
5966
|
-
topic: 'global-hotkey';
|
|
5967
|
-
hotkey: 'string';
|
|
5968
|
-
} & (RegisteredEvent | UnregisteredEvent);
|
|
6168
|
+
declare type GlobalHotkeyEvent = Event_9;
|
|
5969
6169
|
|
|
5970
6170
|
declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
|
5971
6171
|
|
|
@@ -5973,17 +6173,19 @@ declare namespace GlobalHotkeyEvents {
|
|
|
5973
6173
|
export {
|
|
5974
6174
|
RegisteredEvent,
|
|
5975
6175
|
UnregisteredEvent,
|
|
6176
|
+
Event_9 as Event,
|
|
5976
6177
|
GlobalHotkeyEvent,
|
|
6178
|
+
EventType_6 as EventType,
|
|
5977
6179
|
GlobalHotkeyEventType,
|
|
5978
|
-
|
|
5979
|
-
|
|
6180
|
+
Payload_7 as Payload,
|
|
6181
|
+
ByType_6 as ByType
|
|
5980
6182
|
}
|
|
5981
6183
|
}
|
|
5982
6184
|
|
|
5983
6185
|
/**
|
|
5984
|
-
*
|
|
6186
|
+
* @deprecated Renamed to {@link EventType}.
|
|
5985
6187
|
*/
|
|
5986
|
-
declare type GlobalHotkeyEventType =
|
|
6188
|
+
declare type GlobalHotkeyEventType = EventType_6;
|
|
5987
6189
|
|
|
5988
6190
|
declare namespace GoldenLayout {
|
|
5989
6191
|
export {
|
|
@@ -6285,8 +6487,17 @@ declare interface Header {
|
|
|
6285
6487
|
* Generated when a View is hidden.
|
|
6286
6488
|
* @interface
|
|
6287
6489
|
*/
|
|
6288
|
-
declare type HiddenEvent =
|
|
6490
|
+
declare type HiddenEvent = BaseEvent_4 & {
|
|
6491
|
+
type: 'hidden';
|
|
6492
|
+
};
|
|
6493
|
+
|
|
6494
|
+
/**
|
|
6495
|
+
* Generated when a window has been hidden.
|
|
6496
|
+
* @interface
|
|
6497
|
+
*/
|
|
6498
|
+
declare type HiddenEvent_2 = BaseEvent_5 & {
|
|
6289
6499
|
type: 'hidden';
|
|
6500
|
+
reason: 'closing' | 'hide' | 'hide-on-close';
|
|
6290
6501
|
};
|
|
6291
6502
|
|
|
6292
6503
|
/**
|
|
@@ -6294,7 +6505,7 @@ declare type HiddenEvent = BaseViewEvent & {
|
|
|
6294
6505
|
* or because the View has moved to a new window. Only available on Views in a Platform.
|
|
6295
6506
|
* @interface
|
|
6296
6507
|
*/
|
|
6297
|
-
declare type HostContextChangedEvent =
|
|
6508
|
+
declare type HostContextChangedEvent = BaseEvent_4 & {
|
|
6298
6509
|
type: 'host-context-changed';
|
|
6299
6510
|
context: any;
|
|
6300
6511
|
reason: 'reparented' | 'updated';
|
|
@@ -6373,7 +6584,16 @@ declare type Hotkey = {
|
|
|
6373
6584
|
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
|
6374
6585
|
* @interface
|
|
6375
6586
|
*/
|
|
6376
|
-
declare type HotkeyEvent =
|
|
6587
|
+
declare type HotkeyEvent = BaseEvent_4 & {
|
|
6588
|
+
type: 'hotkey';
|
|
6589
|
+
};
|
|
6590
|
+
|
|
6591
|
+
/**
|
|
6592
|
+
* Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
|
|
6593
|
+
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
|
6594
|
+
* @interface
|
|
6595
|
+
*/
|
|
6596
|
+
declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
|
|
6377
6597
|
type: 'hotkey';
|
|
6378
6598
|
};
|
|
6379
6599
|
|
|
@@ -6426,6 +6646,11 @@ declare type IdentityEvent = BaseEvent & {
|
|
|
6426
6646
|
|
|
6427
6647
|
/* Excluded from this release type: IdEventType */
|
|
6428
6648
|
|
|
6649
|
+
/**
|
|
6650
|
+
* @deprecated Renamed to {@link IdleStateChangedEvent}.
|
|
6651
|
+
*/
|
|
6652
|
+
declare type IdleEvent = IdleStateChangedEvent;
|
|
6653
|
+
|
|
6429
6654
|
/**
|
|
6430
6655
|
* Generated when a user enters or returns from idle state.
|
|
6431
6656
|
* @remarks This method is continuously generated every minute while the user is in idle.
|
|
@@ -6433,7 +6658,7 @@ declare type IdentityEvent = BaseEvent & {
|
|
|
6433
6658
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
|
6434
6659
|
* @interface
|
|
6435
6660
|
*/
|
|
6436
|
-
declare type
|
|
6661
|
+
declare type IdleStateChangedEvent = BaseEvent_8 & {
|
|
6437
6662
|
type: 'idle-state-changed';
|
|
6438
6663
|
elapsedTime: number;
|
|
6439
6664
|
isIdle: boolean;
|
|
@@ -6518,11 +6743,19 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
|
6518
6743
|
* Generated when an application has initialized.
|
|
6519
6744
|
* @interface
|
|
6520
6745
|
*/
|
|
6521
|
-
declare type InitializedEvent = IdentityEvent & {
|
|
6746
|
+
declare type InitializedEvent = BaseEvents.IdentityEvent & {
|
|
6522
6747
|
topic: 'application';
|
|
6523
6748
|
type: 'initialized';
|
|
6524
6749
|
};
|
|
6525
6750
|
|
|
6751
|
+
/**
|
|
6752
|
+
* Generated when a window is initialized.
|
|
6753
|
+
* @interface
|
|
6754
|
+
*/
|
|
6755
|
+
declare type InitializedEvent_2 = BaseEvent_5 & {
|
|
6756
|
+
type: 'initialized';
|
|
6757
|
+
};
|
|
6758
|
+
|
|
6526
6759
|
/**
|
|
6527
6760
|
* @interface
|
|
6528
6761
|
*/
|
|
@@ -8600,7 +8833,7 @@ declare type LayoutIdentity = Identity_5 & {
|
|
|
8600
8833
|
* Generated when a window and all of its layout's views have either finished or failed navigation.
|
|
8601
8834
|
* @interface
|
|
8602
8835
|
*/
|
|
8603
|
-
declare type LayoutInitializedEvent =
|
|
8836
|
+
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
|
8604
8837
|
type: 'layout-initialized';
|
|
8605
8838
|
ofViews: (OpenFin_2.Identity & {
|
|
8606
8839
|
entityType: 'view';
|
|
@@ -8960,7 +9193,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
|
8960
9193
|
* Generated when a window and all of its layout's views have been created and can receive API calls.
|
|
8961
9194
|
* @interface
|
|
8962
9195
|
*/
|
|
8963
|
-
declare type LayoutReadyEvent =
|
|
9196
|
+
declare type LayoutReadyEvent = BaseEvent_5 & {
|
|
8964
9197
|
type: 'layout-ready';
|
|
8965
9198
|
views: (OpenFin_2.Identity & {
|
|
8966
9199
|
success: boolean;
|
|
@@ -9101,7 +9334,7 @@ declare type Manifest = {
|
|
|
9101
9334
|
* Generated when the RVM notifies an application that the manifest has changed.
|
|
9102
9335
|
* @interface
|
|
9103
9336
|
*/
|
|
9104
|
-
declare type ManifestChangedEvent = IdentityEvent & {
|
|
9337
|
+
declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
|
|
9105
9338
|
topic: 'application';
|
|
9106
9339
|
type: 'manifest-changed';
|
|
9107
9340
|
};
|
|
@@ -9154,7 +9387,7 @@ declare type MatchPattern = string;
|
|
|
9154
9387
|
* Generated when a window is maximized.
|
|
9155
9388
|
* @interface
|
|
9156
9389
|
*/
|
|
9157
|
-
declare type MaximizedEvent =
|
|
9390
|
+
declare type MaximizedEvent = BaseEvent_5 & {
|
|
9158
9391
|
type: 'maximized';
|
|
9159
9392
|
};
|
|
9160
9393
|
|
|
@@ -9264,7 +9497,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
|
|
|
9264
9497
|
* Generated when a window is minimized.
|
|
9265
9498
|
* @interface
|
|
9266
9499
|
*/
|
|
9267
|
-
declare type MinimizedEvent =
|
|
9500
|
+
declare type MinimizedEvent = BaseEvent_5 & {
|
|
9268
9501
|
type: 'minimized';
|
|
9269
9502
|
};
|
|
9270
9503
|
|
|
@@ -9308,14 +9541,9 @@ declare type MonitorDetails = {
|
|
|
9308
9541
|
};
|
|
9309
9542
|
|
|
9310
9543
|
/**
|
|
9311
|
-
*
|
|
9312
|
-
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
|
9313
|
-
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
|
9314
|
-
* @interface
|
|
9544
|
+
* @deprecated Renamed to {@link MonitorInfoChangedEvent}.
|
|
9315
9545
|
*/
|
|
9316
|
-
declare type MonitorEvent =
|
|
9317
|
-
type: 'monitor-info-changed';
|
|
9318
|
-
};
|
|
9546
|
+
declare type MonitorEvent = MonitorInfoChangedEvent;
|
|
9319
9547
|
|
|
9320
9548
|
/**
|
|
9321
9549
|
* @interface
|
|
@@ -9339,6 +9567,16 @@ declare type MonitorInfo = {
|
|
|
9339
9567
|
virtualScreen: DipRect;
|
|
9340
9568
|
};
|
|
9341
9569
|
|
|
9570
|
+
/**
|
|
9571
|
+
* Generated on changes of a monitor's size/location.
|
|
9572
|
+
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
|
9573
|
+
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
|
9574
|
+
* @interface
|
|
9575
|
+
*/
|
|
9576
|
+
declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
|
|
9577
|
+
type: 'monitor-info-changed';
|
|
9578
|
+
};
|
|
9579
|
+
|
|
9342
9580
|
/**
|
|
9343
9581
|
* @interface
|
|
9344
9582
|
*/
|
|
@@ -9735,13 +9973,15 @@ declare type NonPropagatedWebContentsEvent = never;
|
|
|
9735
9973
|
*/
|
|
9736
9974
|
declare type NonPropagatedWindowEvent = never;
|
|
9737
9975
|
|
|
9976
|
+
/* Excluded from this release type: NotCloseRequested */
|
|
9977
|
+
|
|
9738
9978
|
/* Excluded from this release type: NotRequested */
|
|
9739
9979
|
|
|
9740
9980
|
/**
|
|
9741
9981
|
* Generated when an application is not responding.
|
|
9742
9982
|
* @interface
|
|
9743
9983
|
*/
|
|
9744
|
-
declare type NotRespondingEvent = IdentityEvent & {
|
|
9984
|
+
declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
|
|
9745
9985
|
topic: 'application';
|
|
9746
9986
|
type: 'not-responding';
|
|
9747
9987
|
};
|
|
@@ -10067,7 +10307,7 @@ declare namespace OpenFin_2 {
|
|
|
10067
10307
|
AppVersionCompleteEvent,
|
|
10068
10308
|
AppVersionRuntimeStatusEvent,
|
|
10069
10309
|
Events,
|
|
10070
|
-
|
|
10310
|
+
BaseEvent_9 as BaseEvent,
|
|
10071
10311
|
WebContentsEvent_2 as WebContentsEvent,
|
|
10072
10312
|
SystemEvent_2 as SystemEvent,
|
|
10073
10313
|
ApplicationEvent_2 as ApplicationEvent,
|
|
@@ -10109,12 +10349,32 @@ export default OpenFin_2;
|
|
|
10109
10349
|
|
|
10110
10350
|
declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
|
|
10111
10351
|
|
|
10352
|
+
/**
|
|
10353
|
+
* Generated after window options are changed using the window.updateOptions method.
|
|
10354
|
+
* @remarks Will not fire if the diff object is empty.
|
|
10355
|
+
* @interface
|
|
10356
|
+
*/
|
|
10357
|
+
declare type OptionsChangedEvent = BaseEvent_5 & {
|
|
10358
|
+
type: 'options-changed';
|
|
10359
|
+
options: OpenFin_2.WindowOptions;
|
|
10360
|
+
diff: OpenFin_2.WindowOptionDiff;
|
|
10361
|
+
};
|
|
10362
|
+
|
|
10112
10363
|
declare type OverlapsOnlyIfMatching<T, U> = {
|
|
10113
10364
|
[K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
|
|
10114
10365
|
};
|
|
10115
10366
|
|
|
10116
10367
|
declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
|
10117
10368
|
|
|
10369
|
+
/**
|
|
10370
|
+
* Generated when page receives favicon urls.
|
|
10371
|
+
* @interface
|
|
10372
|
+
*/
|
|
10373
|
+
declare type PageFaviconUpdatedEvent = NamedEvent & {
|
|
10374
|
+
type: 'page-favicon-updated';
|
|
10375
|
+
favicons: string[];
|
|
10376
|
+
};
|
|
10377
|
+
|
|
10118
10378
|
/**
|
|
10119
10379
|
* Generated when page title is set during navigation.
|
|
10120
10380
|
* @remarks explicitSet is false when title is synthesized from file url.
|
|
@@ -10133,74 +10393,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
|
10133
10393
|
};
|
|
10134
10394
|
|
|
10135
10395
|
/**
|
|
10136
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10396
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
10137
10397
|
*
|
|
10138
10398
|
* @typeParam Type String key specifying the event to extract
|
|
10139
10399
|
*/
|
|
10140
|
-
declare type Payload_2<Type extends
|
|
10400
|
+
declare type Payload_2<Type extends EventType> = Extract<Event_4, {
|
|
10141
10401
|
type: Type;
|
|
10142
10402
|
}>;
|
|
10143
10403
|
|
|
10144
10404
|
/**
|
|
10145
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10405
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
10146
10406
|
*
|
|
10147
10407
|
* @typeParam Type String key specifying the event to extract
|
|
10148
10408
|
*/
|
|
10149
|
-
declare type Payload_3<Type extends
|
|
10409
|
+
declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
|
|
10150
10410
|
type: Type;
|
|
10151
10411
|
}>;
|
|
10152
10412
|
|
|
10153
10413
|
/**
|
|
10154
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10414
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
10155
10415
|
*
|
|
10156
10416
|
* @typeParam Type String key specifying the event to extract
|
|
10157
10417
|
*/
|
|
10158
|
-
declare type Payload_4<Type extends
|
|
10418
|
+
declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
|
|
10159
10419
|
type: Type;
|
|
10160
10420
|
}>;
|
|
10161
10421
|
|
|
10162
10422
|
/**
|
|
10163
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10423
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
10164
10424
|
*
|
|
10165
10425
|
* @typeParam Type String key specifying the event to extract
|
|
10166
10426
|
*/
|
|
10167
|
-
declare type Payload_5<Type extends
|
|
10427
|
+
declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
|
|
10168
10428
|
type: Type;
|
|
10169
10429
|
}>;
|
|
10170
10430
|
|
|
10171
10431
|
/**
|
|
10172
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10432
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
10173
10433
|
*
|
|
10174
10434
|
* @typeParam Type String key specifying the event to extract
|
|
10175
10435
|
*/
|
|
10176
|
-
declare type Payload_6<Type extends
|
|
10436
|
+
declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
|
|
10177
10437
|
type: Type;
|
|
10178
10438
|
}>;
|
|
10179
10439
|
|
|
10180
10440
|
/**
|
|
10181
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10441
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
10182
10442
|
*
|
|
10183
10443
|
* @typeParam Type String key specifying the event to extract
|
|
10184
10444
|
*/
|
|
10185
|
-
declare type Payload_7<Type extends
|
|
10445
|
+
declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
|
|
10186
10446
|
type: Type;
|
|
10187
10447
|
}>;
|
|
10188
10448
|
|
|
10189
10449
|
/**
|
|
10190
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10450
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
10191
10451
|
*
|
|
10192
10452
|
* @typeParam Type String key specifying the event to extract
|
|
10193
10453
|
*/
|
|
10194
|
-
declare type Payload_8<Type extends
|
|
10454
|
+
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
|
10195
10455
|
type: Type;
|
|
10196
10456
|
}>;
|
|
10197
10457
|
|
|
10198
10458
|
/**
|
|
10199
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10459
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
10200
10460
|
*
|
|
10201
10461
|
* @typeParam Type String key specifying the event to extract
|
|
10202
10462
|
*/
|
|
10203
|
-
declare type Payload_9<Type extends
|
|
10463
|
+
declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
|
|
10204
10464
|
type: Type;
|
|
10205
10465
|
}>;
|
|
10206
10466
|
|
|
@@ -10210,7 +10470,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
|
|
|
10210
10470
|
* Generated when window finishes loading. Provides performance and navigation data.
|
|
10211
10471
|
* @interface
|
|
10212
10472
|
*/
|
|
10213
|
-
declare type PerformanceReportEvent = Performance &
|
|
10473
|
+
declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
|
10214
10474
|
type: 'performance-report';
|
|
10215
10475
|
};
|
|
10216
10476
|
|
|
@@ -10844,38 +11104,36 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
|
|
|
10844
11104
|
}
|
|
10845
11105
|
|
|
10846
11106
|
/**
|
|
10847
|
-
*
|
|
10848
|
-
* @interface
|
|
11107
|
+
* @deprecated Renamed to {@link ApiReadyEvent}.
|
|
10849
11108
|
*/
|
|
10850
|
-
declare type PlatformApiReadyEvent =
|
|
10851
|
-
topic: 'application';
|
|
10852
|
-
type: 'platform-api-ready';
|
|
10853
|
-
};
|
|
11109
|
+
declare type PlatformApiReadyEvent = ApiReadyEvent;
|
|
10854
11110
|
|
|
10855
11111
|
/**
|
|
10856
|
-
*
|
|
10857
|
-
* discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
|
|
10858
|
-
* under the {@link OpenFin.PlatformEvents} namespace.
|
|
11112
|
+
* @deprecated Renamed to {@link Event}.
|
|
10859
11113
|
*/
|
|
10860
|
-
declare type PlatformEvent =
|
|
11114
|
+
declare type PlatformEvent = Event_10;
|
|
10861
11115
|
|
|
10862
11116
|
declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
|
|
10863
11117
|
|
|
10864
11118
|
declare namespace PlatformEvents {
|
|
10865
11119
|
export {
|
|
11120
|
+
ApiReadyEvent,
|
|
10866
11121
|
PlatformApiReadyEvent,
|
|
11122
|
+
SnapshotAppliedEvent,
|
|
10867
11123
|
PlatformSnapshotAppliedEvent,
|
|
11124
|
+
Event_10 as Event,
|
|
10868
11125
|
PlatformEvent,
|
|
11126
|
+
EventType_7 as EventType,
|
|
10869
11127
|
PlatformEventType,
|
|
10870
|
-
|
|
10871
|
-
|
|
11128
|
+
Payload_8 as Payload,
|
|
11129
|
+
ByType_7 as ByType
|
|
10872
11130
|
}
|
|
10873
11131
|
}
|
|
10874
11132
|
|
|
10875
11133
|
/**
|
|
10876
|
-
*
|
|
11134
|
+
* @deprecated Renamed to {@link }.
|
|
10877
11135
|
*/
|
|
10878
|
-
declare type PlatformEventType =
|
|
11136
|
+
declare type PlatformEventType = EventType_7;
|
|
10879
11137
|
|
|
10880
11138
|
/**
|
|
10881
11139
|
* Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
|
|
@@ -11540,19 +11798,9 @@ declare interface PlatformProvider {
|
|
|
11540
11798
|
}
|
|
11541
11799
|
|
|
11542
11800
|
/**
|
|
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
|
|
11801
|
+
* @deprecated Renamed to {@link SnapshotAppliedEvent}.
|
|
11551
11802
|
*/
|
|
11552
|
-
declare type PlatformSnapshotAppliedEvent =
|
|
11553
|
-
topic: 'application';
|
|
11554
|
-
type: 'platform-snapshot-applied';
|
|
11555
|
-
};
|
|
11803
|
+
declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
|
|
11556
11804
|
|
|
11557
11805
|
/**
|
|
11558
11806
|
* @interface
|
|
@@ -11820,7 +12068,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
|
|
|
11820
12068
|
* A general preload scripts state change event without event type.
|
|
11821
12069
|
* @interface
|
|
11822
12070
|
*/
|
|
11823
|
-
declare type PreloadScriptsStateChangeEvent =
|
|
12071
|
+
declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
|
|
11824
12072
|
preloadScripts: (PreloadScriptInfoRunning & any)[];
|
|
11825
12073
|
};
|
|
11826
12074
|
|
|
@@ -12029,51 +12277,43 @@ declare type ProcessLoggingOptions = {
|
|
|
12029
12277
|
};
|
|
12030
12278
|
|
|
12031
12279
|
/**
|
|
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.
|
|
12280
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
|
12037
12281
|
*/
|
|
12038
|
-
declare type PropagatedApplicationEvent<TargetTopic extends string> =
|
|
12282
|
+
declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
|
|
12039
12283
|
|
|
12040
12284
|
/**
|
|
12041
|
-
*
|
|
12285
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
|
12042
12286
|
*/
|
|
12043
|
-
declare type PropagatedApplicationEventType =
|
|
12287
|
+
declare type PropagatedApplicationEventType = PropagatedEventType_3;
|
|
12044
12288
|
|
|
12045
12289
|
/**
|
|
12046
|
-
* Modifies an event shape to reflect propagation to a parent topic.
|
|
12290
|
+
* Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
|
|
12291
|
+
* these do not propagate.
|
|
12292
|
+
*
|
|
12047
12293
|
* @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
|
|
12294
|
+
*
|
|
12295
|
+
* @typeParam SourceTopic The topic the event shape is propagating from.
|
|
12296
|
+
* @typeParam TargetTopic The topic the event shape is propagating to.
|
|
12297
|
+
* @typeParam Event The shape of the event being propagated.
|
|
12048
12298
|
*/
|
|
12049
12299
|
declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
|
|
12050
12300
|
type: string;
|
|
12051
12301
|
}> = Event extends infer E extends {
|
|
12052
12302
|
type: string;
|
|
12053
|
-
} ? Omit<E, 'type' | 'topic'> & {
|
|
12303
|
+
} ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
|
|
12054
12304
|
type: PropagatedEventType<SourceTopic, E['type']>;
|
|
12055
12305
|
topic: TargetTopic;
|
|
12056
12306
|
} : never;
|
|
12057
12307
|
|
|
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
12308
|
/**
|
|
12064
12309
|
* A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
|
|
12065
12310
|
* 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
12311
|
* event type key with `'view-'`.
|
|
12067
12312
|
*/
|
|
12068
|
-
declare type
|
|
12313
|
+
declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
|
|
12069
12314
|
viewIdentity: OpenFin_2.Identity;
|
|
12070
12315
|
};
|
|
12071
12316
|
|
|
12072
|
-
/**
|
|
12073
|
-
* Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
|
|
12074
|
-
*/
|
|
12075
|
-
declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
|
12076
|
-
|
|
12077
12317
|
/**
|
|
12078
12318
|
* A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
|
|
12079
12319
|
* prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
|
|
@@ -12082,12 +12322,51 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
|
|
12082
12322
|
*
|
|
12083
12323
|
* "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
|
|
12084
12324
|
*/
|
|
12085
|
-
declare type
|
|
12325
|
+
declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
|
|
12326
|
+
|
|
12327
|
+
/**
|
|
12328
|
+
* An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
|
|
12329
|
+
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
|
12330
|
+
* are propagated to `System` without any type string prefixing.
|
|
12331
|
+
*
|
|
12332
|
+
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
|
12333
|
+
*/
|
|
12334
|
+
declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
|
|
12335
|
+
|
|
12336
|
+
/**
|
|
12337
|
+
* Modifies an event type key to reflect propagation by prefixing with the topic.
|
|
12338
|
+
*/
|
|
12339
|
+
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
|
|
12340
|
+
|
|
12341
|
+
/**
|
|
12342
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
|
|
12343
|
+
*/
|
|
12344
|
+
declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
|
|
12345
|
+
|
|
12346
|
+
/**
|
|
12347
|
+
* Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
|
|
12348
|
+
*/
|
|
12349
|
+
declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
|
|
12350
|
+
|
|
12351
|
+
/**
|
|
12352
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
|
12353
|
+
*/
|
|
12354
|
+
declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
|
|
12355
|
+
|
|
12356
|
+
/**
|
|
12357
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
|
12358
|
+
*/
|
|
12359
|
+
declare type PropagatedViewEventType = PropagatedEventType_2;
|
|
12086
12360
|
|
|
12087
12361
|
/**
|
|
12088
|
-
*
|
|
12362
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
|
12089
12363
|
*/
|
|
12090
|
-
declare type
|
|
12364
|
+
declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
|
|
12365
|
+
|
|
12366
|
+
/**
|
|
12367
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
|
|
12368
|
+
*/
|
|
12369
|
+
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
12091
12370
|
|
|
12092
12371
|
declare interface ProtocolMap extends ProtocolMapBase {
|
|
12093
12372
|
'request-external-authorization': {
|
|
@@ -12505,7 +12784,7 @@ declare type RegistryInfo_2 = {
|
|
|
12505
12784
|
* Generated when a window has been reloaded.
|
|
12506
12785
|
* @interface
|
|
12507
12786
|
*/
|
|
12508
|
-
declare type ReloadedEvent =
|
|
12787
|
+
declare type ReloadedEvent = BaseEvent_5 & {
|
|
12509
12788
|
type: 'reloaded';
|
|
12510
12789
|
url: string;
|
|
12511
12790
|
};
|
|
@@ -12641,11 +12920,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
|
|
|
12641
12920
|
* Generated when an application is responding.
|
|
12642
12921
|
* @interface
|
|
12643
12922
|
*/
|
|
12644
|
-
declare type RespondingEvent = IdentityEvent & {
|
|
12923
|
+
declare type RespondingEvent = BaseEvents.IdentityEvent & {
|
|
12645
12924
|
topic: 'application';
|
|
12646
12925
|
type: 'responding';
|
|
12647
12926
|
};
|
|
12648
12927
|
|
|
12928
|
+
/**
|
|
12929
|
+
* Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
|
12930
|
+
* @interface
|
|
12931
|
+
*/
|
|
12932
|
+
declare type RestoredEvent = BaseEvent_5 & {
|
|
12933
|
+
type: 'restored';
|
|
12934
|
+
};
|
|
12935
|
+
|
|
12649
12936
|
declare type ResultBehavior = 'close' | 'hide' | 'none';
|
|
12650
12937
|
|
|
12651
12938
|
/**
|
|
@@ -12708,7 +12995,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
|
|
|
12708
12995
|
* Generated when Application.run() is called for an already running application.
|
|
12709
12996
|
* @interface
|
|
12710
12997
|
*/
|
|
12711
|
-
declare type RunRequestedEvent_2 = IdentityEvent & {
|
|
12998
|
+
declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
|
|
12712
12999
|
topic: 'application';
|
|
12713
13000
|
type: 'run-requested';
|
|
12714
13001
|
userAppConfigArgs: Record<string, any>;
|
|
@@ -12890,7 +13177,7 @@ declare type ServiceIdentifier = {
|
|
|
12890
13177
|
* Generated on changes to a user’s local computer session.
|
|
12891
13178
|
* @interface
|
|
12892
13179
|
*/
|
|
12893
|
-
declare type SessionChangedEvent =
|
|
13180
|
+
declare type SessionChangedEvent = BaseEvent_8 & {
|
|
12894
13181
|
type: 'session-changed';
|
|
12895
13182
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
|
12896
13183
|
};
|
|
@@ -13112,7 +13399,7 @@ declare type ShortcutOverride = Hotkey & {
|
|
|
13112
13399
|
*
|
|
13113
13400
|
* @interface
|
|
13114
13401
|
*/
|
|
13115
|
-
declare type ShowAllDownloadsEvent =
|
|
13402
|
+
declare type ShowAllDownloadsEvent = BaseEvent_5 & {
|
|
13116
13403
|
type: 'show-all-downloads';
|
|
13117
13404
|
};
|
|
13118
13405
|
|
|
@@ -13120,7 +13407,15 @@ declare type ShowAllDownloadsEvent = BaseWindowEvent & {
|
|
|
13120
13407
|
* Generated when a View is shown. This event will fire during creation of a View.
|
|
13121
13408
|
* @interface
|
|
13122
13409
|
*/
|
|
13123
|
-
declare type ShownEvent =
|
|
13410
|
+
declare type ShownEvent = BaseEvent_4 & {
|
|
13411
|
+
type: 'shown';
|
|
13412
|
+
};
|
|
13413
|
+
|
|
13414
|
+
/**
|
|
13415
|
+
* Generated when a hidden window has been shown.
|
|
13416
|
+
* @interface
|
|
13417
|
+
*/
|
|
13418
|
+
declare type ShownEvent_2 = BaseEvent_5 & {
|
|
13124
13419
|
type: 'shown';
|
|
13125
13420
|
};
|
|
13126
13421
|
|
|
@@ -13149,6 +13444,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
|
|
|
13149
13444
|
y?: number;
|
|
13150
13445
|
};
|
|
13151
13446
|
|
|
13447
|
+
/**
|
|
13448
|
+
* Generated when a window has been prevented from showing.
|
|
13449
|
+
* @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.
|
|
13450
|
+
* @interface
|
|
13451
|
+
*/
|
|
13452
|
+
declare type ShowRequestedEvent = BaseEvent_5 & {
|
|
13453
|
+
type: 'show-requested';
|
|
13454
|
+
};
|
|
13455
|
+
|
|
13152
13456
|
/**
|
|
13153
13457
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
|
13154
13458
|
*
|
|
@@ -13195,6 +13499,21 @@ declare type Snapshot = {
|
|
|
13195
13499
|
};
|
|
13196
13500
|
};
|
|
13197
13501
|
|
|
13502
|
+
/**
|
|
13503
|
+
* Generated when a platform.ApplySnapshot call is resolved.
|
|
13504
|
+
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
|
13505
|
+
* 1. The window has been created
|
|
13506
|
+
* 2. The window has a responsive API
|
|
13507
|
+
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
|
13508
|
+
*
|
|
13509
|
+
* _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.
|
|
13510
|
+
* @interface
|
|
13511
|
+
*/
|
|
13512
|
+
declare type SnapshotAppliedEvent = BaseEvent & {
|
|
13513
|
+
topic: 'application';
|
|
13514
|
+
type: 'platform-snapshot-applied';
|
|
13515
|
+
};
|
|
13516
|
+
|
|
13198
13517
|
/**
|
|
13199
13518
|
* @interface
|
|
13200
13519
|
*/
|
|
@@ -13309,7 +13628,7 @@ declare class SnapshotSourceModule extends Base {
|
|
|
13309
13628
|
* Generated when an application has started.
|
|
13310
13629
|
* @interface
|
|
13311
13630
|
*/
|
|
13312
|
-
declare type StartedEvent = IdentityEvent & {
|
|
13631
|
+
declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
13313
13632
|
topic: 'application';
|
|
13314
13633
|
type: 'started';
|
|
13315
13634
|
};
|
|
@@ -14842,12 +15161,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
|
|
|
14842
15161
|
};
|
|
14843
15162
|
|
|
14844
15163
|
/**
|
|
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).
|
|
15164
|
+
* @deprecated Renamed to {@link Event}.
|
|
14849
15165
|
*/
|
|
14850
|
-
declare type SystemEvent =
|
|
15166
|
+
declare type SystemEvent = Event_11;
|
|
14851
15167
|
|
|
14852
15168
|
declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
|
|
14853
15169
|
|
|
@@ -14855,8 +15171,10 @@ declare namespace SystemEvents {
|
|
|
14855
15171
|
export {
|
|
14856
15172
|
NotRequested,
|
|
14857
15173
|
ExcludeRequested,
|
|
14858
|
-
|
|
15174
|
+
BaseEvent_8 as BaseEvent,
|
|
15175
|
+
IdleStateChangedEvent,
|
|
14859
15176
|
IdleEvent,
|
|
15177
|
+
MonitorInfoChangedEvent,
|
|
14860
15178
|
MonitorEvent,
|
|
14861
15179
|
SessionChangedEvent,
|
|
14862
15180
|
AppVersionEvent,
|
|
@@ -14870,17 +15188,19 @@ declare namespace SystemEvents {
|
|
|
14870
15188
|
ApplicationCreatedEvent,
|
|
14871
15189
|
DesktopIconClickedEvent,
|
|
14872
15190
|
SystemShutdownEvent,
|
|
15191
|
+
Event_11 as Event,
|
|
14873
15192
|
SystemEvent,
|
|
15193
|
+
EventType_8 as EventType,
|
|
14874
15194
|
SystemEventType,
|
|
14875
|
-
|
|
14876
|
-
|
|
15195
|
+
Payload_9 as Payload,
|
|
15196
|
+
ByType_8 as ByType
|
|
14877
15197
|
}
|
|
14878
15198
|
}
|
|
14879
15199
|
|
|
14880
15200
|
/**
|
|
14881
|
-
*
|
|
15201
|
+
* @deprecated Renamed to {@link EventType}.
|
|
14882
15202
|
*/
|
|
14883
|
-
declare type SystemEventType =
|
|
15203
|
+
declare type SystemEventType = EventType_8;
|
|
14884
15204
|
|
|
14885
15205
|
/**
|
|
14886
15206
|
* @interface
|
|
@@ -15133,7 +15453,7 @@ declare type TargetApp = string | AppMetadata;
|
|
|
15133
15453
|
* In that case, previousTarget identity will be the same as target identity.
|
|
15134
15454
|
* @interface
|
|
15135
15455
|
*/
|
|
15136
|
-
declare type TargetChangedEvent =
|
|
15456
|
+
declare type TargetChangedEvent = BaseEvent_4 & {
|
|
15137
15457
|
type: 'target-changed';
|
|
15138
15458
|
previousTarget: OpenFin_2.Identity;
|
|
15139
15459
|
};
|
|
@@ -15287,7 +15607,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
15287
15607
|
* Generated when the tray icon is clicked.
|
|
15288
15608
|
* @interface
|
|
15289
15609
|
*/
|
|
15290
|
-
declare type TrayIconClickedEvent = IdentityEvent & {
|
|
15610
|
+
declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
|
|
15291
15611
|
topic: 'application';
|
|
15292
15612
|
type: 'tray-icon-clicked';
|
|
15293
15613
|
button: 0 | 1 | 2;
|
|
@@ -15377,7 +15697,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
|
15377
15697
|
* A general user bounds change event without event type.
|
|
15378
15698
|
* @interface
|
|
15379
15699
|
*/
|
|
15380
|
-
declare type UserBoundsChangeEvent =
|
|
15700
|
+
declare type UserBoundsChangeEvent = BaseEvent_5 & {
|
|
15381
15701
|
height: number;
|
|
15382
15702
|
left: number;
|
|
15383
15703
|
top: number;
|
|
@@ -15389,7 +15709,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
|
|
|
15389
15709
|
* Generated when a window's user movement becomes disabled.
|
|
15390
15710
|
* @interface
|
|
15391
15711
|
*/
|
|
15392
|
-
declare type UserMovementDisabledEvent =
|
|
15712
|
+
declare type UserMovementDisabledEvent = BaseEvent_5 & {
|
|
15393
15713
|
type: 'user-movement-disabled';
|
|
15394
15714
|
};
|
|
15395
15715
|
|
|
@@ -15397,7 +15717,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
|
|
|
15397
15717
|
* Generated when a window's user movement becomes enabled.
|
|
15398
15718
|
* @interface
|
|
15399
15719
|
*/
|
|
15400
|
-
declare type UserMovementEnabledEvent =
|
|
15720
|
+
declare type UserMovementEnabledEvent = BaseEvent_5 & {
|
|
15401
15721
|
type: 'user-movement-enabled';
|
|
15402
15722
|
};
|
|
15403
15723
|
|
|
@@ -16047,7 +16367,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
|
|
|
16047
16367
|
* Generated when a View is attached to a window.
|
|
16048
16368
|
* @interface
|
|
16049
16369
|
*/
|
|
16050
|
-
declare type ViewAttachedEvent =
|
|
16370
|
+
declare type ViewAttachedEvent = BaseEvent_5 & {
|
|
16051
16371
|
type: 'view-attached';
|
|
16052
16372
|
target: OpenFin_2.Identity;
|
|
16053
16373
|
viewIdentity: OpenFin_2.Identity;
|
|
@@ -16089,7 +16409,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
|
|
|
16089
16409
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
|
16090
16410
|
* @interface
|
|
16091
16411
|
*/
|
|
16092
|
-
declare type ViewDetachedEvent =
|
|
16412
|
+
declare type ViewDetachedEvent = BaseEvent_5 & {
|
|
16093
16413
|
type: 'view-detached';
|
|
16094
16414
|
target: OpenFin_2.Identity;
|
|
16095
16415
|
previousTarget: OpenFin_2.Identity;
|
|
@@ -16097,18 +16417,15 @@ declare type ViewDetachedEvent = BaseWindowEvent & {
|
|
|
16097
16417
|
};
|
|
16098
16418
|
|
|
16099
16419
|
/**
|
|
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}).
|
|
16420
|
+
* @deprecated Renamed to {@link Event}.
|
|
16103
16421
|
*/
|
|
16104
|
-
declare type ViewEvent =
|
|
16105
|
-
target: OpenFin_2.Identity;
|
|
16106
|
-
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
|
16422
|
+
declare type ViewEvent = Event_4;
|
|
16107
16423
|
|
|
16108
16424
|
declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
|
|
16109
16425
|
|
|
16110
16426
|
declare namespace ViewEvents {
|
|
16111
16427
|
export {
|
|
16428
|
+
BaseEvent_4 as BaseEvent,
|
|
16112
16429
|
BaseViewEvent,
|
|
16113
16430
|
TargetChangedEvent,
|
|
16114
16431
|
NonPropagatedViewEvent,
|
|
@@ -16118,20 +16435,24 @@ declare namespace ViewEvents {
|
|
|
16118
16435
|
HotkeyEvent,
|
|
16119
16436
|
ShownEvent,
|
|
16120
16437
|
HostContextChangedEvent,
|
|
16438
|
+
Event_4 as Event,
|
|
16121
16439
|
ViewEvent,
|
|
16122
16440
|
WillPropagateViewEvent,
|
|
16441
|
+
EventType,
|
|
16123
16442
|
ViewEventType,
|
|
16443
|
+
PropagatedEvent_2 as PropagatedEvent,
|
|
16124
16444
|
PropagatedViewEvent,
|
|
16445
|
+
PropagatedEventType_2 as PropagatedEventType,
|
|
16125
16446
|
PropagatedViewEventType,
|
|
16126
|
-
|
|
16127
|
-
|
|
16447
|
+
Payload_2 as Payload,
|
|
16448
|
+
ByType
|
|
16128
16449
|
}
|
|
16129
16450
|
}
|
|
16130
16451
|
|
|
16131
16452
|
/**
|
|
16132
|
-
*
|
|
16453
|
+
* @deprecated Renamed to {@link EventType}.
|
|
16133
16454
|
*/
|
|
16134
|
-
declare type ViewEventType =
|
|
16455
|
+
declare type ViewEventType = EventType;
|
|
16135
16456
|
|
|
16136
16457
|
/**
|
|
16137
16458
|
* @interface
|
|
@@ -17270,12 +17591,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17270
17591
|
}
|
|
17271
17592
|
|
|
17272
17593
|
/**
|
|
17273
|
-
*
|
|
17274
|
-
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
|
17594
|
+
* @deprecated Renamed to {@link Event}.
|
|
17275
17595
|
*/
|
|
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);
|
|
17596
|
+
declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
|
|
17279
17597
|
|
|
17280
17598
|
declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
|
|
17281
17599
|
|
|
@@ -17287,6 +17605,7 @@ declare namespace WebContentsEvents {
|
|
|
17287
17605
|
CrashedEvent_2 as CrashedEvent,
|
|
17288
17606
|
CertificateErrorEvent,
|
|
17289
17607
|
CertificateSelectionShownEvent,
|
|
17608
|
+
PageFaviconUpdatedEvent,
|
|
17290
17609
|
FaviconUpdatedEvent,
|
|
17291
17610
|
NavigationRejectedEvent,
|
|
17292
17611
|
UrlChangedEvent,
|
|
@@ -17305,6 +17624,7 @@ declare namespace WebContentsEvents {
|
|
|
17305
17624
|
FileDownloadStartedEvent,
|
|
17306
17625
|
FileDownloadProgressEvent,
|
|
17307
17626
|
FileDownloadCompletedEvent,
|
|
17627
|
+
Event_5 as Event,
|
|
17308
17628
|
WebContentsEvent,
|
|
17309
17629
|
WillPropagateWebContentsEvent,
|
|
17310
17630
|
NonPropagatedWebContentsEvent
|
|
@@ -17352,7 +17672,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
|
17352
17672
|
* A general will-move or will-resize event without event type.
|
|
17353
17673
|
* @interface
|
|
17354
17674
|
*/
|
|
17355
|
-
declare type WillMoveOrResizeEvent =
|
|
17675
|
+
declare type WillMoveOrResizeEvent = BaseEvent_5 & {
|
|
17356
17676
|
height: number;
|
|
17357
17677
|
left: number;
|
|
17358
17678
|
top: number;
|
|
@@ -17374,7 +17694,7 @@ declare type WillPropagateViewEvent = ViewEvent;
|
|
|
17374
17694
|
*
|
|
17375
17695
|
* A WebContents event that does propagate to (republish on) parent topics.
|
|
17376
17696
|
*/
|
|
17377
|
-
declare type WillPropagateWebContentsEvent =
|
|
17697
|
+
declare type WillPropagateWebContentsEvent = Event_5<string>;
|
|
17378
17698
|
|
|
17379
17699
|
/**
|
|
17380
17700
|
* @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
|
|
@@ -17388,7 +17708,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
|
|
|
17388
17708
|
* Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
|
|
17389
17709
|
* @interface
|
|
17390
17710
|
*/
|
|
17391
|
-
declare type WillRedirectEvent =
|
|
17711
|
+
declare type WillRedirectEvent = BaseEvent_5 & {
|
|
17392
17712
|
type: 'will-redirect';
|
|
17393
17713
|
blocked: boolean;
|
|
17394
17714
|
isInPlace: boolean;
|
|
@@ -18929,7 +19249,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
18929
19249
|
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
|
18930
19250
|
* @interface
|
|
18931
19251
|
*/
|
|
18932
|
-
declare type WindowAlertRequestedEvent =
|
|
19252
|
+
declare type WindowAlertRequestedEvent = BaseEvent_3 & {
|
|
18933
19253
|
type: 'window-alert-requested';
|
|
18934
19254
|
};
|
|
18935
19255
|
|
|
@@ -18943,29 +19263,19 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
18943
19263
|
};
|
|
18944
19264
|
|
|
18945
19265
|
/**
|
|
18946
|
-
*
|
|
18947
|
-
* @interface
|
|
19266
|
+
* @deprecated Renamed to {@link ClosedEvent}.
|
|
18948
19267
|
*/
|
|
18949
|
-
declare type WindowClosedEvent =
|
|
18950
|
-
type: 'closed';
|
|
18951
|
-
};
|
|
19268
|
+
declare type WindowClosedEvent = ClosedEvent_2;
|
|
18952
19269
|
|
|
18953
19270
|
/**
|
|
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
|
|
19271
|
+
* @deprecated Renamed to {@link CloseRequestedEvent}.
|
|
18957
19272
|
*/
|
|
18958
|
-
declare type WindowCloseRequestedEvent =
|
|
18959
|
-
type: 'close-requested';
|
|
18960
|
-
};
|
|
19273
|
+
declare type WindowCloseRequestedEvent = CloseRequestedEvent;
|
|
18961
19274
|
|
|
18962
19275
|
/**
|
|
18963
|
-
*
|
|
18964
|
-
* @interface
|
|
19276
|
+
* @deprecated Renamed to {@link ClosingEvent}.
|
|
18965
19277
|
*/
|
|
18966
|
-
declare type WindowClosingEvent =
|
|
18967
|
-
type: 'closing';
|
|
18968
|
-
};
|
|
19278
|
+
declare type WindowClosingEvent = ClosingEvent;
|
|
18969
19279
|
|
|
18970
19280
|
/**
|
|
18971
19281
|
* A rule prescribing content creation in a {@link OpenFin.Window}.
|
|
@@ -18987,7 +19297,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
18987
19297
|
* Generated when a child window is created.
|
|
18988
19298
|
* @interface
|
|
18989
19299
|
*/
|
|
18990
|
-
declare type WindowCreatedEvent =
|
|
19300
|
+
declare type WindowCreatedEvent = BaseEvent_3 & {
|
|
18991
19301
|
type: 'window-created';
|
|
18992
19302
|
};
|
|
18993
19303
|
|
|
@@ -19044,21 +19354,20 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19044
19354
|
* Generated when a child window ends loading.
|
|
19045
19355
|
* @interface
|
|
19046
19356
|
*/
|
|
19047
|
-
declare type WindowEndLoadEvent =
|
|
19357
|
+
declare type WindowEndLoadEvent = BaseEvent_3 & {
|
|
19048
19358
|
type: 'window-end-load';
|
|
19049
19359
|
};
|
|
19050
19360
|
|
|
19051
19361
|
/**
|
|
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}).
|
|
19362
|
+
* @deprecated, Renamed to {@link Event}.
|
|
19055
19363
|
*/
|
|
19056
|
-
declare type WindowEvent =
|
|
19364
|
+
declare type WindowEvent = Event_6;
|
|
19057
19365
|
|
|
19058
19366
|
declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
|
|
19059
19367
|
|
|
19060
19368
|
declare namespace WindowEvents {
|
|
19061
19369
|
export {
|
|
19370
|
+
BaseEvent_5 as BaseEvent,
|
|
19062
19371
|
BaseWindowEvent,
|
|
19063
19372
|
ViewAttachedEvent,
|
|
19064
19373
|
ViewDetachedEvent,
|
|
@@ -19068,9 +19377,11 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19068
19377
|
EndLoadEvent,
|
|
19069
19378
|
WillRedirectEvent,
|
|
19070
19379
|
ReloadedEvent,
|
|
19380
|
+
OptionsChangedEvent,
|
|
19071
19381
|
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
|
19072
19382
|
ExternalProcessExitedEvent,
|
|
19073
19383
|
ExternalProcessStartedEvent,
|
|
19384
|
+
HiddenEvent_2 as HiddenEvent,
|
|
19074
19385
|
WindowHiddenEvent,
|
|
19075
19386
|
PreloadScriptInfoRunning,
|
|
19076
19387
|
PreloadScriptInfo,
|
|
@@ -19085,22 +19396,30 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19085
19396
|
BeginUserBoundsChangingEvent,
|
|
19086
19397
|
BoundsChangedEvent,
|
|
19087
19398
|
BoundsChangingEvent,
|
|
19399
|
+
CloseRequestedEvent,
|
|
19088
19400
|
WindowCloseRequestedEvent,
|
|
19089
19401
|
ContextChangedEvent,
|
|
19402
|
+
ClosedEvent_2 as ClosedEvent,
|
|
19090
19403
|
WindowClosedEvent,
|
|
19404
|
+
ClosingEvent,
|
|
19091
19405
|
WindowClosingEvent,
|
|
19092
19406
|
DisabledMovementBoundsChangedEvent,
|
|
19093
19407
|
DisabledMovementBoundsChangingEvent,
|
|
19094
19408
|
EmbeddedEvent,
|
|
19095
19409
|
EndUserBoundsChangingEvent,
|
|
19410
|
+
HotkeyEvent_2 as HotkeyEvent,
|
|
19096
19411
|
WindowHotkeyEvent,
|
|
19412
|
+
InitializedEvent_2 as InitializedEvent,
|
|
19097
19413
|
WindowInitializedEvent,
|
|
19098
19414
|
MaximizedEvent,
|
|
19099
19415
|
MinimizedEvent,
|
|
19100
19416
|
PreloadScriptsStateChangedEvent,
|
|
19101
19417
|
PreloadScriptsStateChangingEvent,
|
|
19418
|
+
RestoredEvent,
|
|
19102
19419
|
WindowRestoredEvent,
|
|
19420
|
+
ShowRequestedEvent,
|
|
19103
19421
|
WindowShowRequestedEvent,
|
|
19422
|
+
ShownEvent_2 as ShownEvent,
|
|
19104
19423
|
WindowShownEvent,
|
|
19105
19424
|
UserMovementEnabledEvent,
|
|
19106
19425
|
UserMovementDisabledEvent,
|
|
@@ -19111,37 +19430,32 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19111
19430
|
DownloadShelfVisibilityChangedEvent,
|
|
19112
19431
|
WindowSourcedEvent,
|
|
19113
19432
|
WillPropagateWindowEvent,
|
|
19433
|
+
Event_6 as Event,
|
|
19114
19434
|
WindowEvent,
|
|
19435
|
+
EventType_2 as EventType,
|
|
19115
19436
|
WindowEventType,
|
|
19437
|
+
PropagatedEvent_3 as PropagatedEvent,
|
|
19116
19438
|
PropagatedWindowEvent,
|
|
19117
19439
|
PropagatedWindowEventType,
|
|
19118
|
-
|
|
19119
|
-
|
|
19440
|
+
Payload_3 as Payload,
|
|
19441
|
+
ByType_2 as ByType
|
|
19120
19442
|
}
|
|
19121
19443
|
}
|
|
19122
19444
|
|
|
19123
19445
|
/**
|
|
19124
|
-
*
|
|
19446
|
+
* @deprecated Renamed to {@link EventType}.
|
|
19125
19447
|
*/
|
|
19126
19448
|
declare type WindowEventType = WindowEvent['type'];
|
|
19127
19449
|
|
|
19128
19450
|
/**
|
|
19129
|
-
*
|
|
19130
|
-
* @interface
|
|
19451
|
+
* @deprecated Renamed to {@link HiddenEvent}.
|
|
19131
19452
|
*/
|
|
19132
|
-
declare type WindowHiddenEvent =
|
|
19133
|
-
type: 'hidden';
|
|
19134
|
-
reason: 'closing' | 'hide' | 'hide-on-close';
|
|
19135
|
-
};
|
|
19453
|
+
declare type WindowHiddenEvent = HiddenEvent_2;
|
|
19136
19454
|
|
|
19137
19455
|
/**
|
|
19138
|
-
*
|
|
19139
|
-
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
|
19140
|
-
* @interface
|
|
19456
|
+
* @deprecated Renamed to {@link HotkeyEvent}.
|
|
19141
19457
|
*/
|
|
19142
|
-
declare type WindowHotkeyEvent =
|
|
19143
|
-
type: 'hotkey';
|
|
19144
|
-
};
|
|
19458
|
+
declare type WindowHotkeyEvent = HotkeyEvent_2;
|
|
19145
19459
|
|
|
19146
19460
|
/**
|
|
19147
19461
|
* @interface
|
|
@@ -19155,12 +19469,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19155
19469
|
};
|
|
19156
19470
|
|
|
19157
19471
|
/**
|
|
19158
|
-
*
|
|
19159
|
-
* @interface
|
|
19472
|
+
* @deprecated Renamed to {@link InitializedEvent}.
|
|
19160
19473
|
*/
|
|
19161
|
-
declare type WindowInitializedEvent =
|
|
19162
|
-
type: 'initialized';
|
|
19163
|
-
};
|
|
19474
|
+
declare type WindowInitializedEvent = InitializedEvent_2;
|
|
19164
19475
|
|
|
19165
19476
|
/**
|
|
19166
19477
|
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
|
@@ -19257,7 +19568,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19257
19568
|
* Generated when a child window is not responding.
|
|
19258
19569
|
* @interface
|
|
19259
19570
|
*/
|
|
19260
|
-
declare type WindowNotRespondingEvent =
|
|
19571
|
+
declare type WindowNotRespondingEvent = BaseEvent_3 & {
|
|
19261
19572
|
type: 'window-not-responding';
|
|
19262
19573
|
};
|
|
19263
19574
|
|
|
@@ -19279,15 +19590,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19279
19590
|
declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
|
|
19280
19591
|
|
|
19281
19592
|
/**
|
|
19282
|
-
*
|
|
19283
|
-
* @remarks Will not fire if the diff object is empty.
|
|
19284
|
-
* @interface
|
|
19593
|
+
* @deprecated Renamed to {@link OptionsChangedEvent}.
|
|
19285
19594
|
*/
|
|
19286
|
-
declare type WindowOptionsChangedEvent_2 =
|
|
19287
|
-
type: 'options-changed';
|
|
19288
|
-
options: OpenFin_2.WindowOptions;
|
|
19289
|
-
diff: OpenFin_2.WindowOptionDiff;
|
|
19290
|
-
};
|
|
19595
|
+
declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
|
|
19291
19596
|
|
|
19292
19597
|
declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
|
|
19293
19598
|
|
|
@@ -19295,46 +19600,36 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19295
19600
|
* Generated when a child window is responding.
|
|
19296
19601
|
* @interface
|
|
19297
19602
|
*/
|
|
19298
|
-
declare type WindowRespondingEvent =
|
|
19603
|
+
declare type WindowRespondingEvent = BaseEvent_3 & {
|
|
19299
19604
|
type: 'window-responding';
|
|
19300
19605
|
};
|
|
19301
19606
|
|
|
19302
19607
|
/**
|
|
19303
|
-
*
|
|
19304
|
-
* @interface
|
|
19608
|
+
* @deprecated Renamed to {@link RestoredEvent}.
|
|
19305
19609
|
*/
|
|
19306
|
-
declare type WindowRestoredEvent =
|
|
19307
|
-
type: 'restored';
|
|
19308
|
-
};
|
|
19610
|
+
declare type WindowRestoredEvent = RestoredEvent;
|
|
19309
19611
|
|
|
19310
19612
|
/**
|
|
19311
|
-
*
|
|
19312
|
-
* @interface
|
|
19613
|
+
* @deprecated Renamed to {@link ShownEvent}.
|
|
19313
19614
|
*/
|
|
19314
|
-
declare type WindowShownEvent =
|
|
19315
|
-
type: 'shown';
|
|
19316
|
-
};
|
|
19615
|
+
declare type WindowShownEvent = ShownEvent_2;
|
|
19317
19616
|
|
|
19318
19617
|
/**
|
|
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
|
|
19618
|
+
* @deprecated Renamed to {@link ShowRequestedEvent}.
|
|
19322
19619
|
*/
|
|
19323
|
-
declare type WindowShowRequestedEvent =
|
|
19324
|
-
type: 'show-requested';
|
|
19325
|
-
};
|
|
19620
|
+
declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
19326
19621
|
|
|
19327
19622
|
/**
|
|
19328
19623
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
19329
19624
|
* from {@link OpenFin.ViewEvents}.
|
|
19330
19625
|
*/
|
|
19331
|
-
declare type WindowSourcedEvent =
|
|
19626
|
+
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
19627
|
|
|
19333
19628
|
/**
|
|
19334
19629
|
* Generated when a child window starts loading.
|
|
19335
19630
|
* @interface
|
|
19336
19631
|
*/
|
|
19337
|
-
declare type WindowStartLoadEvent =
|
|
19632
|
+
declare type WindowStartLoadEvent = BaseEvent_3 & {
|
|
19338
19633
|
type: 'window-start-load';
|
|
19339
19634
|
};
|
|
19340
19635
|
|