@openfin/node-adapter 34.78.51 → 34.78.52
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/node-adapter-alpha.d.ts +647 -358
- package/out/node-adapter-beta.d.ts +647 -358
- package/out/node-adapter-public.d.ts +647 -358
- package/out/node-adapter.d.ts +664 -363
- package/out/node-adapter.js +12 -0
- package/package.json +1 -1
@@ -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.ApplicationEvent> {
|
|
856
865
|
}
|
857
866
|
|
858
867
|
/**
|
859
|
-
*
|
860
|
-
* @interface
|
868
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
861
869
|
*/
|
862
|
-
declare type ApplicationConnectedEvent =
|
863
|
-
topic: 'application';
|
864
|
-
type: 'connected';
|
865
|
-
};
|
870
|
+
declare type ApplicationConnectedEvent = ConnectedEvent_2;
|
866
871
|
|
867
872
|
/**
|
868
873
|
* Generated when an application is created.
|
869
874
|
* @interface
|
870
875
|
*/
|
871
|
-
declare type ApplicationCreatedEvent =
|
876
|
+
declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
|
872
877
|
type: 'application-created';
|
873
878
|
};
|
874
879
|
|
@@ -892,17 +897,15 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
|
|
892
897
|
};
|
893
898
|
|
894
899
|
/**
|
895
|
-
*
|
896
|
-
* discriminated by {@link ApplicationEvent.type | their type}. Event payloads unique to `Application` can be found
|
897
|
-
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
898
|
-
* from which they propagate).
|
900
|
+
* @deprecated Renamed to {@link Event}.
|
899
901
|
*/
|
900
|
-
declare type ApplicationEvent =
|
902
|
+
declare type ApplicationEvent = Event_3;
|
901
903
|
|
902
904
|
declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
|
903
905
|
|
904
906
|
declare namespace ApplicationEvents {
|
905
907
|
export {
|
908
|
+
BaseEvent_3 as BaseEvent,
|
906
909
|
BaseApplicationEvent,
|
907
910
|
CrashedEvent,
|
908
911
|
FileDownloadLocationChangedEvent,
|
@@ -915,7 +918,9 @@ declare namespace ApplicationEvents {
|
|
915
918
|
WindowRespondingEvent,
|
916
919
|
WindowStartLoadEvent,
|
917
920
|
ApplicationWindowEvent,
|
921
|
+
ApplicationWindowEventTypes,
|
918
922
|
ClosedEvent,
|
923
|
+
ConnectedEvent_2 as ConnectedEvent,
|
919
924
|
ApplicationConnectedEvent,
|
920
925
|
InitializedEvent,
|
921
926
|
ManifestChangedEvent,
|
@@ -923,19 +928,23 @@ declare namespace ApplicationEvents {
|
|
923
928
|
RespondingEvent,
|
924
929
|
StartedEvent,
|
925
930
|
ApplicationSourcedEvent,
|
931
|
+
Event_3 as Event,
|
926
932
|
ApplicationEvent,
|
933
|
+
EventType_3 as EventType,
|
927
934
|
ApplicationEventType,
|
935
|
+
PropagatedEvent_4 as PropagatedEvent,
|
928
936
|
PropagatedApplicationEvent,
|
937
|
+
PropagatedEventType_3 as PropagatedEventType,
|
929
938
|
PropagatedApplicationEventType,
|
930
|
-
|
931
|
-
ByType
|
939
|
+
Payload_4 as Payload,
|
940
|
+
ByType_3 as ByType
|
932
941
|
}
|
933
942
|
}
|
934
943
|
|
935
944
|
/**
|
936
|
-
*
|
945
|
+
* @deprecated Renamed to {@link EventType}.
|
937
946
|
*/
|
938
|
-
declare type ApplicationEventType =
|
947
|
+
declare type ApplicationEventType = EventType_3;
|
939
948
|
|
940
949
|
declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
|
941
950
|
|
@@ -1288,9 +1297,8 @@ declare type ApplicationPermissions = {
|
|
1288
1297
|
* A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
|
1289
1298
|
* from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
|
1290
1299
|
* does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
|
1291
|
-
*
|
1292
1300
|
*/
|
1293
|
-
declare type ApplicationSourcedEvent = ClosedEvent |
|
1301
|
+
declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
1294
1302
|
|
1295
1303
|
declare type ApplicationState = OpenFin.ApplicationState;
|
1296
1304
|
|
@@ -1329,6 +1337,11 @@ declare type ApplicationType = {
|
|
1329
1337
|
*/
|
1330
1338
|
declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
|
1331
1339
|
|
1340
|
+
/**
|
1341
|
+
* Array of valid `type` values for an {@link ApplicationWindowEvent}.
|
1342
|
+
*/
|
1343
|
+
declare const ApplicationWindowEventTypes: readonly ["window-alert-requested", "window-created", "window-end-load", "window-not-responding", "window-responding", "window-start-load"];
|
1344
|
+
|
1332
1345
|
declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
|
1333
1346
|
|
1334
1347
|
/**
|
@@ -1598,7 +1611,7 @@ declare interface AuthorizationPayload {
|
|
1598
1611
|
* ```
|
1599
1612
|
* @interface
|
1600
1613
|
*/
|
1601
|
-
declare type AuthRequestedEvent =
|
1614
|
+
declare type AuthRequestedEvent = BaseEvent_5 & {
|
1602
1615
|
type: 'auth-requested';
|
1603
1616
|
authInfo: {
|
1604
1617
|
host: string;
|
@@ -1660,21 +1673,9 @@ declare class Base {
|
|
1660
1673
|
}
|
1661
1674
|
|
1662
1675
|
/**
|
1663
|
-
*
|
1664
|
-
* @interface
|
1665
|
-
*/
|
1666
|
-
declare type BaseApplicationEvent = NamedEvent & {
|
1667
|
-
topic: `application`;
|
1668
|
-
};
|
1669
|
-
|
1670
|
-
/**
|
1671
|
-
* A base Channel event.
|
1672
|
-
* @interface
|
1676
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1673
1677
|
*/
|
1674
|
-
declare type
|
1675
|
-
channelName: string;
|
1676
|
-
channelId: string;
|
1677
|
-
};
|
1678
|
+
declare type BaseApplicationEvent = BaseEvent_3;
|
1678
1679
|
|
1679
1680
|
/**
|
1680
1681
|
* @interface
|
@@ -1743,10 +1744,70 @@ declare type BaseEvent = {
|
|
1743
1744
|
type: string;
|
1744
1745
|
};
|
1745
1746
|
|
1746
|
-
|
1747
|
+
/**
|
1748
|
+
* A base Channel event.
|
1749
|
+
* @interface
|
1750
|
+
*/
|
1751
|
+
declare type BaseEvent_2 = NamedEvent & {
|
1752
|
+
channelName: string;
|
1753
|
+
channelId: string;
|
1754
|
+
};
|
1755
|
+
|
1756
|
+
/**
|
1757
|
+
* Base type for events emitting on the `application` topic
|
1758
|
+
* @interface
|
1759
|
+
*/
|
1760
|
+
declare type BaseEvent_3 = BaseEvents.NamedEvent & {
|
1761
|
+
topic: `application`;
|
1762
|
+
};
|
1763
|
+
|
1764
|
+
/**
|
1765
|
+
* Base type for events emitting on the `view` topic
|
1766
|
+
* @interface
|
1767
|
+
*/
|
1768
|
+
declare type BaseEvent_4 = BaseEvents.NamedEvent & {
|
1769
|
+
topic: 'view';
|
1770
|
+
target: OpenFin.Identity;
|
1771
|
+
};
|
1772
|
+
|
1773
|
+
/**
|
1774
|
+
* Base type for events emitting on the `window` topic
|
1775
|
+
* @interface
|
1776
|
+
*/
|
1777
|
+
declare type BaseEvent_5 = BaseEvents.NamedEvent & {
|
1778
|
+
topic: 'window';
|
1779
|
+
};
|
1780
|
+
|
1781
|
+
/**
|
1782
|
+
* Base type for events emitting on the `externalapplication` topic
|
1783
|
+
* @interface
|
1784
|
+
*/
|
1785
|
+
declare type BaseEvent_6 = BaseEvents.BaseEvent & {
|
1786
|
+
topic: 'externalapplication';
|
1787
|
+
};
|
1788
|
+
|
1789
|
+
/**
|
1790
|
+
* The base frame event.
|
1791
|
+
* @interface
|
1792
|
+
*/
|
1793
|
+
declare type BaseEvent_7 = NamedEvent & {
|
1794
|
+
entityType: 'iframe';
|
1795
|
+
frameName: string;
|
1796
|
+
};
|
1797
|
+
|
1798
|
+
/**
|
1799
|
+
* Base type for events emitting on the `system` topic
|
1800
|
+
* @interface
|
1801
|
+
*/
|
1802
|
+
declare type BaseEvent_8 = BaseEvents.BaseEvent & {
|
1803
|
+
topic: 'system';
|
1804
|
+
};
|
1805
|
+
|
1806
|
+
declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
|
1747
1807
|
|
1748
1808
|
declare namespace BaseEvents {
|
1749
1809
|
export {
|
1810
|
+
NotCloseRequested,
|
1750
1811
|
PropagatedEventType,
|
1751
1812
|
PropagatedEvent,
|
1752
1813
|
EventHandler,
|
@@ -1757,21 +1818,14 @@ declare namespace BaseEvents {
|
|
1757
1818
|
}
|
1758
1819
|
|
1759
1820
|
/**
|
1760
|
-
*
|
1761
|
-
* @interface
|
1821
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1762
1822
|
*/
|
1763
|
-
declare type BaseExternalApplicationEvent =
|
1764
|
-
topic: 'externalapplication';
|
1765
|
-
};
|
1823
|
+
declare type BaseExternalApplicationEvent = BaseEvent_6;
|
1766
1824
|
|
1767
1825
|
/**
|
1768
|
-
*
|
1769
|
-
* @interface
|
1826
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1770
1827
|
*/
|
1771
|
-
declare type BaseFrameEvent =
|
1772
|
-
entityType: 'iframe';
|
1773
|
-
frameName: string;
|
1774
|
-
};
|
1828
|
+
declare type BaseFrameEvent = BaseEvent_7;
|
1775
1829
|
|
1776
1830
|
declare type BaseLoadFailedEvent = NamedEvent & {
|
1777
1831
|
errorCode: number;
|
@@ -1780,35 +1834,20 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
1780
1834
|
isMainFrame: boolean;
|
1781
1835
|
};
|
1782
1836
|
|
1783
|
-
/**
|
1784
|
-
* Base type for events emitting on the `system` topic
|
1785
|
-
* @interface
|
1786
|
-
*/
|
1787
|
-
declare type BaseSystemEvent = BaseEvent & {
|
1788
|
-
topic: 'system';
|
1789
|
-
};
|
1790
|
-
|
1791
1837
|
declare type BaseUrlEvent = NamedEvent & {
|
1792
1838
|
type: 'url-changed';
|
1793
1839
|
url: string;
|
1794
1840
|
};
|
1795
1841
|
|
1796
1842
|
/**
|
1797
|
-
*
|
1798
|
-
* @interface
|
1843
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1799
1844
|
*/
|
1800
|
-
declare type BaseViewEvent =
|
1801
|
-
topic: 'view';
|
1802
|
-
target: OpenFin.Identity;
|
1803
|
-
};
|
1845
|
+
declare type BaseViewEvent = BaseEvent_4;
|
1804
1846
|
|
1805
1847
|
/**
|
1806
|
-
*
|
1807
|
-
* @interface
|
1848
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1808
1849
|
*/
|
1809
|
-
declare type BaseWindowEvent =
|
1810
|
-
topic: 'window';
|
1811
|
-
};
|
1850
|
+
declare type BaseWindowEvent = BaseEvent_5;
|
1812
1851
|
|
1813
1852
|
/**
|
1814
1853
|
* User decision of whether a Window or specific View should close when trying to prevent an unload.
|
@@ -1875,7 +1914,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
1875
1914
|
* A general bounds change event without event type.
|
1876
1915
|
* @interface
|
1877
1916
|
*/
|
1878
|
-
declare type BoundsChangeEvent =
|
1917
|
+
declare type BoundsChangeEvent = BaseEvent_5 & {
|
1879
1918
|
changeType: 0 | 1 | 2;
|
1880
1919
|
deferred: boolean;
|
1881
1920
|
height: number;
|
@@ -1947,76 +1986,76 @@ declare interface BrowserWindow {
|
|
1947
1986
|
}
|
1948
1987
|
|
1949
1988
|
/**
|
1950
|
-
* Extracts a single event type matching the given key from the {@link
|
1989
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
1951
1990
|
*
|
1952
1991
|
* Alias for {@link Payload}, which may read better in source.
|
1953
1992
|
*
|
1954
1993
|
* @typeParam Type String key specifying the event to extract
|
1955
1994
|
*/
|
1956
|
-
declare type ByType<Type extends
|
1995
|
+
declare type ByType<Type extends EventType> = Payload_2<Type>;
|
1957
1996
|
|
1958
1997
|
/**
|
1959
|
-
* Extracts a single event type matching the given key from the {@link
|
1998
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
1960
1999
|
*
|
1961
2000
|
* Alias for {@link Payload}, which may read better in source.
|
1962
2001
|
*
|
1963
2002
|
* @typeParam Type String key specifying the event to extract
|
1964
2003
|
*/
|
1965
|
-
declare type ByType_2<Type extends
|
2004
|
+
declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
1966
2005
|
|
1967
2006
|
/**
|
1968
|
-
* Extracts a single event type matching the given key from the {@link
|
2007
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
1969
2008
|
*
|
1970
2009
|
* Alias for {@link Payload}, which may read better in source.
|
1971
2010
|
*
|
1972
2011
|
* @typeParam Type String key specifying the event to extract
|
1973
2012
|
*/
|
1974
|
-
declare type ByType_3<Type extends
|
2013
|
+
declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
1975
2014
|
|
1976
2015
|
/**
|
1977
|
-
* Extracts a single event type matching the given key from the {@link
|
2016
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
1978
2017
|
*
|
1979
2018
|
* Alias for {@link Payload}, which may read better in source.
|
1980
2019
|
*
|
1981
2020
|
* @typeParam Type String key specifying the event to extract
|
1982
2021
|
*/
|
1983
|
-
declare type ByType_4<Type extends
|
2022
|
+
declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
1984
2023
|
|
1985
2024
|
/**
|
1986
|
-
* Extracts a single event type matching the given key from the {@link
|
2025
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
1987
2026
|
*
|
1988
2027
|
* Alias for {@link Payload}, which may read better in source.
|
1989
2028
|
*
|
1990
2029
|
* @typeParam Type String key specifying the event to extract
|
1991
2030
|
*/
|
1992
|
-
declare type ByType_5<Type extends
|
2031
|
+
declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
1993
2032
|
|
1994
2033
|
/**
|
1995
|
-
* Extracts a single event type matching the given key from the {@link
|
2034
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
1996
2035
|
*
|
1997
2036
|
* Alias for {@link Payload}, which may read better in source.
|
1998
2037
|
*
|
1999
2038
|
* @typeParam Type String key specifying the event to extract
|
2000
2039
|
*/
|
2001
|
-
declare type ByType_6<Type extends
|
2040
|
+
declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
2002
2041
|
|
2003
2042
|
/**
|
2004
|
-
* Extracts a single event type matching the given key from the {@link
|
2043
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
2005
2044
|
*
|
2006
2045
|
* Alias for {@link Payload}, which may read better in source.
|
2007
2046
|
*
|
2008
2047
|
* @typeParam Type String key specifying the event to extract
|
2009
2048
|
*/
|
2010
|
-
declare type ByType_7<Type extends
|
2049
|
+
declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
2011
2050
|
|
2012
2051
|
/**
|
2013
|
-
* Extracts a single event type matching the given key from the {@link
|
2052
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
2014
2053
|
*
|
2015
2054
|
* Alias for {@link Payload}, which may read better in source.
|
2016
2055
|
*
|
2017
2056
|
* @typeParam Type String key specifying the event to extract
|
2018
2057
|
*/
|
2019
|
-
declare type ByType_8<Type extends
|
2058
|
+
declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
2020
2059
|
|
2021
2060
|
/**
|
2022
2061
|
* Configuration for page capture.
|
@@ -2682,14 +2721,6 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
|
|
2682
2721
|
|
2683
2722
|
declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
|
2684
2723
|
|
2685
|
-
/**
|
2686
|
-
* Generated when a Channel client is connected.
|
2687
|
-
* @interface
|
2688
|
-
*/
|
2689
|
-
declare type ChannelConnectedEvent = BaseChannelEvent & {
|
2690
|
-
type: 'connected';
|
2691
|
-
};
|
2692
|
-
|
2693
2724
|
/**
|
2694
2725
|
* Options provided on a client connection to a channel.
|
2695
2726
|
*
|
@@ -2721,21 +2752,9 @@ declare type ChannelCreateOptions = {
|
|
2721
2752
|
};
|
2722
2753
|
|
2723
2754
|
/**
|
2724
|
-
*
|
2725
|
-
* @interface
|
2755
|
+
* @deprecated Renamed to {@link Event}.
|
2726
2756
|
*/
|
2727
|
-
declare type
|
2728
|
-
type: 'disconnected';
|
2729
|
-
};
|
2730
|
-
|
2731
|
-
/**
|
2732
|
-
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
|
2733
|
-
* discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
|
2734
|
-
* under the {@link OpenFin.ChannelEvents} namespace.
|
2735
|
-
*/
|
2736
|
-
declare type ChannelEvent = {
|
2737
|
-
topic: 'channel';
|
2738
|
-
} & (ChannelConnectedEvent | ChannelDisconnectedEvent);
|
2757
|
+
declare type ChannelEvent = Event_2;
|
2739
2758
|
|
2740
2759
|
declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
|
2741
2760
|
|
@@ -3270,11 +3289,19 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
|
|
3270
3289
|
* Generated when an application is closed.
|
3271
3290
|
* @interface
|
3272
3291
|
*/
|
3273
|
-
declare type ClosedEvent = IdentityEvent & {
|
3292
|
+
declare type ClosedEvent = BaseEvents.IdentityEvent & {
|
3274
3293
|
topic: 'application';
|
3275
3294
|
type: 'closed';
|
3276
3295
|
};
|
3277
3296
|
|
3297
|
+
/**
|
3298
|
+
* Generated when a window has closed.
|
3299
|
+
* @interface
|
3300
|
+
*/
|
3301
|
+
declare type ClosedEvent_2 = BaseEvent_5 & {
|
3302
|
+
type: 'closed';
|
3303
|
+
};
|
3304
|
+
|
3278
3305
|
/**
|
3279
3306
|
* @interface
|
3280
3307
|
*/
|
@@ -3282,6 +3309,15 @@ declare type ClosedMenuResult = {
|
|
3282
3309
|
result: 'closed';
|
3283
3310
|
};
|
3284
3311
|
|
3312
|
+
/**
|
3313
|
+
* Generated when a window has been prevented from closing.
|
3314
|
+
* @remarks A window will be prevented from closing by default, either through the API or by a user when ‘close-requested’ has been subscribed to and the Window.close(force) flag is false.
|
3315
|
+
* @interface
|
3316
|
+
*/
|
3317
|
+
declare type CloseRequestedEvent = BaseEvent_5 & {
|
3318
|
+
type: 'close-requested';
|
3319
|
+
};
|
3320
|
+
|
3285
3321
|
/**
|
3286
3322
|
* @interface
|
3287
3323
|
*/
|
@@ -3328,6 +3364,14 @@ declare interface CloseWindowPayload {
|
|
3328
3364
|
};
|
3329
3365
|
}
|
3330
3366
|
|
3367
|
+
/**
|
3368
|
+
* Generated when a window has initiated the closing routine.
|
3369
|
+
* @interface
|
3370
|
+
*/
|
3371
|
+
declare type ClosingEvent = BaseEvent_5 & {
|
3372
|
+
type: 'closing';
|
3373
|
+
};
|
3374
|
+
|
3331
3375
|
/**
|
3332
3376
|
* A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
|
3333
3377
|
*/
|
@@ -3411,6 +3455,39 @@ export declare function connect(config: ConnectConfig): Promise<Fin<'external co
|
|
3411
3455
|
|
3412
3456
|
declare type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
|
3413
3457
|
|
3458
|
+
/**
|
3459
|
+
* Generated when a Channel client is connected.
|
3460
|
+
* @interface
|
3461
|
+
*/
|
3462
|
+
declare type ConnectedEvent = BaseEvent_2 & {
|
3463
|
+
type: 'connected';
|
3464
|
+
};
|
3465
|
+
|
3466
|
+
/**
|
3467
|
+
* Generated when an application has authenticated and is connected.
|
3468
|
+
* @interface
|
3469
|
+
*/
|
3470
|
+
declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
|
3471
|
+
topic: 'application';
|
3472
|
+
type: 'connected';
|
3473
|
+
};
|
3474
|
+
|
3475
|
+
/**
|
3476
|
+
* Generated when an external application has authenticated and is connected.
|
3477
|
+
* @interface
|
3478
|
+
*/
|
3479
|
+
declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
|
3480
|
+
type: 'connected';
|
3481
|
+
};
|
3482
|
+
|
3483
|
+
/**
|
3484
|
+
* Generated when a frame is connected.
|
3485
|
+
* @interface
|
3486
|
+
*/
|
3487
|
+
declare type ConnectedEvent_4 = BaseFrameEvent & {
|
3488
|
+
type: 'connected';
|
3489
|
+
};
|
3490
|
+
|
3414
3491
|
declare type Constructor<T = {}> = new () => T;
|
3415
3492
|
|
3416
3493
|
declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
@@ -4152,7 +4229,7 @@ declare type Context_3 = {
|
|
4152
4229
|
* Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
|
4153
4230
|
* @interface
|
4154
4231
|
*/
|
4155
|
-
declare type ContextChangedEvent =
|
4232
|
+
declare type ContextChangedEvent = BaseEvent_5 & {
|
4156
4233
|
type: 'context-changed';
|
4157
4234
|
context: any;
|
4158
4235
|
};
|
@@ -4304,7 +4381,7 @@ declare type CpuInfo = {
|
|
4304
4381
|
* Generated when an application has crashed.
|
4305
4382
|
* @interface
|
4306
4383
|
*/
|
4307
|
-
declare type CrashedEvent = IdentityEvent & {
|
4384
|
+
declare type CrashedEvent = BaseEvents.IdentityEvent & {
|
4308
4385
|
topic: 'application';
|
4309
4386
|
type: 'crashed';
|
4310
4387
|
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
@@ -4355,7 +4432,7 @@ declare type CrashReporterState = CrashReporterOptions & {
|
|
4355
4432
|
* Generated when a View is created.
|
4356
4433
|
* @interface
|
4357
4434
|
*/
|
4358
|
-
declare type CreatedEvent =
|
4435
|
+
declare type CreatedEvent = BaseEvent_4 & {
|
4359
4436
|
type: 'created';
|
4360
4437
|
};
|
4361
4438
|
|
@@ -4514,7 +4591,7 @@ declare interface DesktopAgent_2 {
|
|
4514
4591
|
* Generated when the desktop icon is clicked while it's already running.
|
4515
4592
|
* @interface
|
4516
4593
|
*/
|
4517
|
-
declare type DesktopIconClickedEvent =
|
4594
|
+
declare type DesktopIconClickedEvent = BaseEvent_8 & {
|
4518
4595
|
type: 'desktop-icon-clicked';
|
4519
4596
|
};
|
4520
4597
|
|
@@ -4522,7 +4599,7 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
|
|
4522
4599
|
* Generated when a View is destroyed.
|
4523
4600
|
* @interface
|
4524
4601
|
*/
|
4525
|
-
declare type DestroyedEvent =
|
4602
|
+
declare type DestroyedEvent = BaseEvent_4 & {
|
4526
4603
|
type: 'destroyed';
|
4527
4604
|
};
|
4528
4605
|
|
@@ -4622,6 +4699,30 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
4622
4699
|
type: 'disabled-movement-bounds-changing';
|
4623
4700
|
};
|
4624
4701
|
|
4702
|
+
/**
|
4703
|
+
* Generated when a Channel client has disconnected.
|
4704
|
+
* @interface
|
4705
|
+
*/
|
4706
|
+
declare type DisconnectedEvent = BaseEvent_2 & {
|
4707
|
+
type: 'disconnected';
|
4708
|
+
};
|
4709
|
+
|
4710
|
+
/**
|
4711
|
+
* Generated when an external application has disconnected.
|
4712
|
+
* @interface
|
4713
|
+
*/
|
4714
|
+
declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
|
4715
|
+
type: 'disconnected';
|
4716
|
+
};
|
4717
|
+
|
4718
|
+
/**
|
4719
|
+
* Generated when a frame has disconnected.
|
4720
|
+
* @interface
|
4721
|
+
*/
|
4722
|
+
declare type DisconnectedEvent_3 = BaseFrameEvent & {
|
4723
|
+
type: 'disconnected';
|
4724
|
+
};
|
4725
|
+
|
4625
4726
|
/**
|
4626
4727
|
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
4627
4728
|
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
@@ -4755,7 +4856,7 @@ declare type DownloadShelfOptions = {
|
|
4755
4856
|
*
|
4756
4857
|
* @interface
|
4757
4858
|
*/
|
4758
|
-
declare type DownloadShelfVisibilityChangedEvent =
|
4859
|
+
declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
|
4759
4860
|
type: 'download-shelf-visibility-changed';
|
4760
4861
|
/**
|
4761
4862
|
* True if the download shelf was just opened; false if it was just closed.
|
@@ -4785,7 +4886,7 @@ declare interface DragSource {}
|
|
4785
4886
|
* Generated when a window has been embedded.
|
4786
4887
|
* @interface
|
4787
4888
|
*/
|
4788
|
-
declare type EmbeddedEvent =
|
4889
|
+
declare type EmbeddedEvent = BaseEvent_5 & {
|
4789
4890
|
type: 'embedded';
|
4790
4891
|
};
|
4791
4892
|
|
@@ -4884,7 +4985,7 @@ declare class EmitterMap {
|
|
4884
4985
|
* Generated when a window ends loading.
|
4885
4986
|
* @interface
|
4886
4987
|
*/
|
4887
|
-
declare type EndLoadEvent =
|
4988
|
+
declare type EndLoadEvent = BaseEvent_5 & {
|
4888
4989
|
type: 'end-load';
|
4889
4990
|
documentName: string;
|
4890
4991
|
isMain: boolean;
|
@@ -5001,6 +5102,88 @@ declare type ErrorPlainObject = {
|
|
5001
5102
|
toString(): string;
|
5002
5103
|
};
|
5003
5104
|
|
5105
|
+
/**
|
5106
|
+
* [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
|
5107
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
|
5108
|
+
* under the {@link OpenFin.PlatformEvents} namespace.
|
5109
|
+
*/
|
5110
|
+
declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
|
5111
|
+
|
5112
|
+
/**
|
5113
|
+
* [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
|
5114
|
+
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
5115
|
+
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5116
|
+
* from which they propagate).
|
5117
|
+
*/
|
5118
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ViewEvents.PropagatedEvent<'system'> | ApplicationEvents.PropagatedEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
5119
|
+
|
5120
|
+
/**
|
5121
|
+
* [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
|
5122
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
|
5123
|
+
* under the {@link OpenFin.ChannelEvents} namespace.
|
5124
|
+
*/
|
5125
|
+
declare type Event_2 = {
|
5126
|
+
topic: 'channel';
|
5127
|
+
} & (ConnectedEvent | DisconnectedEvent);
|
5128
|
+
|
5129
|
+
/**
|
5130
|
+
* [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
|
5131
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
|
5132
|
+
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5133
|
+
* from which they propagate).
|
5134
|
+
*/
|
5135
|
+
declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
|
5136
|
+
|
5137
|
+
/**
|
5138
|
+
* [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
|
5139
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
|
5140
|
+
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5141
|
+
*/
|
5142
|
+
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
5143
|
+
target: OpenFin.Identity;
|
5144
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
5145
|
+
|
5146
|
+
/**
|
5147
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
5148
|
+
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
5149
|
+
*/
|
5150
|
+
declare type Event_5<Topic extends string> = {
|
5151
|
+
topic: Topic;
|
5152
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
5153
|
+
|
5154
|
+
/**
|
5155
|
+
* [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
|
5156
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
|
5157
|
+
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5158
|
+
*/
|
5159
|
+
declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
|
5160
|
+
|
5161
|
+
/**
|
5162
|
+
* [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
|
5163
|
+
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5164
|
+
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5165
|
+
*/
|
5166
|
+
declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
|
5167
|
+
|
5168
|
+
/**
|
5169
|
+
* [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
|
5170
|
+
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
5171
|
+
* under the {@link OpenFin.FrameEvents} namespace.
|
5172
|
+
*/
|
5173
|
+
declare type Event_8 = {
|
5174
|
+
topic: 'frame';
|
5175
|
+
} & (ConnectedEvent_4 | DisconnectedEvent_3);
|
5176
|
+
|
5177
|
+
/**
|
5178
|
+
* [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
|
5179
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
5180
|
+
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
5181
|
+
*/
|
5182
|
+
declare type Event_9 = {
|
5183
|
+
topic: 'global-hotkey';
|
5184
|
+
hotkey: 'string';
|
5185
|
+
} & (RegisteredEvent | UnregisteredEvent);
|
5186
|
+
|
5004
5187
|
declare class EventAggregator extends EmitterMap {
|
5005
5188
|
dispatchEvent: (message: Message<any>) => boolean;
|
5006
5189
|
}
|
@@ -5066,6 +5249,46 @@ declare namespace Events {
|
|
5066
5249
|
}
|
5067
5250
|
}
|
5068
5251
|
|
5252
|
+
/**
|
5253
|
+
* Union of possible `type` values for a view {@link Event}.
|
5254
|
+
*/
|
5255
|
+
declare type EventType = Event_4['type'];
|
5256
|
+
|
5257
|
+
/**
|
5258
|
+
* Union of possible `type` values for a Window {@link Event}.
|
5259
|
+
*/
|
5260
|
+
declare type EventType_2 = Event_6['type'];
|
5261
|
+
|
5262
|
+
/**
|
5263
|
+
* Union of possible `type` values for an Application {@link Event}.
|
5264
|
+
*/
|
5265
|
+
declare type EventType_3 = Event_3['type'];
|
5266
|
+
|
5267
|
+
/**
|
5268
|
+
* Union of possible `type` values for an ExternalApplication {@link Event}.
|
5269
|
+
*/
|
5270
|
+
declare type EventType_4 = Event_7['type'];
|
5271
|
+
|
5272
|
+
/**
|
5273
|
+
* Union of possible `type` values for a {@link FrameEvent}.
|
5274
|
+
*/
|
5275
|
+
declare type EventType_5 = Event_8['type'];
|
5276
|
+
|
5277
|
+
/**
|
5278
|
+
* Union of possible `type` values for a {@link GlobalHotkeyEvent}
|
5279
|
+
*/
|
5280
|
+
declare type EventType_6 = Event_9['type'];
|
5281
|
+
|
5282
|
+
/**
|
5283
|
+
* Union of possible `type` values for a {@link PlatformEvent}.
|
5284
|
+
*/
|
5285
|
+
declare type EventType_7 = Event_10['type'];
|
5286
|
+
|
5287
|
+
/**
|
5288
|
+
* Union of possible `type` values for a {@link SystemEvent}.
|
5289
|
+
*/
|
5290
|
+
declare type EventType_8 = SystemEvent['type'];
|
5291
|
+
|
5069
5292
|
/* Excluded from this release type: EventWithId */
|
5070
5293
|
|
5071
5294
|
/* Excluded from this release type: ExcludeRequested */
|
@@ -5189,46 +5412,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
|
|
5189
5412
|
}
|
5190
5413
|
|
5191
5414
|
/**
|
5192
|
-
*
|
5193
|
-
* @interface
|
5415
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
5194
5416
|
*/
|
5195
|
-
declare type ExternalApplicationConnectedEvent =
|
5196
|
-
type: 'connected';
|
5197
|
-
};
|
5417
|
+
declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
|
5198
5418
|
|
5199
5419
|
/**
|
5200
|
-
*
|
5201
|
-
* @interface
|
5420
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
5202
5421
|
*/
|
5203
|
-
declare type ExternalApplicationDisconnectedEvent =
|
5204
|
-
type: 'disconnected';
|
5205
|
-
};
|
5422
|
+
declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
|
5206
5423
|
|
5207
5424
|
/**
|
5208
|
-
*
|
5209
|
-
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5210
|
-
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5425
|
+
* @deprecated Renamed to {@link Event}.
|
5211
5426
|
*/
|
5212
|
-
declare type ExternalApplicationEvent =
|
5427
|
+
declare type ExternalApplicationEvent = Event_7;
|
5213
5428
|
|
5214
5429
|
declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
|
5215
5430
|
|
5216
5431
|
declare namespace ExternalApplicationEvents {
|
5217
5432
|
export {
|
5433
|
+
BaseEvent_6 as BaseEvent,
|
5218
5434
|
BaseExternalApplicationEvent,
|
5435
|
+
ConnectedEvent_3 as ConnectedEvent,
|
5219
5436
|
ExternalApplicationConnectedEvent,
|
5437
|
+
DisconnectedEvent_2 as DisconnectedEvent,
|
5220
5438
|
ExternalApplicationDisconnectedEvent,
|
5439
|
+
Event_7 as Event,
|
5221
5440
|
ExternalApplicationEvent,
|
5441
|
+
EventType_4 as EventType,
|
5222
5442
|
ExternalApplicationEventType,
|
5223
|
-
|
5224
|
-
|
5443
|
+
Payload_5 as Payload,
|
5444
|
+
ByType_4 as ByType
|
5225
5445
|
}
|
5226
5446
|
}
|
5227
5447
|
|
5228
5448
|
/**
|
5229
|
-
*
|
5449
|
+
* @deprecated Renamed to {@link Event}.
|
5230
5450
|
*/
|
5231
|
-
declare type ExternalApplicationEventType =
|
5451
|
+
declare type ExternalApplicationEventType = EventType_4;
|
5232
5452
|
|
5233
5453
|
/**
|
5234
5454
|
* @interface
|
@@ -5293,7 +5513,7 @@ declare type ExternalConnection = {
|
|
5293
5513
|
* Generated when an external process has exited.
|
5294
5514
|
* @interface
|
5295
5515
|
*/
|
5296
|
-
declare type ExternalProcessExitedEvent =
|
5516
|
+
declare type ExternalProcessExitedEvent = BaseEvent_5 & {
|
5297
5517
|
type: 'external-process-exited';
|
5298
5518
|
processUuid: string;
|
5299
5519
|
exitCode: number;
|
@@ -5338,19 +5558,15 @@ declare type ExternalProcessRequestType = {
|
|
5338
5558
|
* Generated when an external process has started.
|
5339
5559
|
* @interface
|
5340
5560
|
*/
|
5341
|
-
declare type ExternalProcessStartedEvent =
|
5561
|
+
declare type ExternalProcessStartedEvent = BaseEvent_5 & {
|
5342
5562
|
type: 'external-process-started';
|
5343
5563
|
processUuid: string;
|
5344
5564
|
};
|
5345
5565
|
|
5346
5566
|
/**
|
5347
|
-
*
|
5348
|
-
* @interface
|
5567
|
+
* @deprecated, use {@link PageFaviconUpdatedEvent}.
|
5349
5568
|
*/
|
5350
|
-
declare type FaviconUpdatedEvent =
|
5351
|
-
type: 'page-favicon-updated';
|
5352
|
-
favicons: string[];
|
5353
|
-
};
|
5569
|
+
declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
|
5354
5570
|
|
5355
5571
|
declare namespace FDC3 {
|
5356
5572
|
export {
|
@@ -5706,48 +5922,43 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
5706
5922
|
}
|
5707
5923
|
|
5708
5924
|
/**
|
5709
|
-
*
|
5710
|
-
* @interface
|
5925
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
5711
5926
|
*/
|
5712
|
-
declare type FrameConnectedEvent =
|
5713
|
-
type: 'connected';
|
5714
|
-
};
|
5927
|
+
declare type FrameConnectedEvent = ConnectedEvent_4;
|
5715
5928
|
|
5716
5929
|
/**
|
5717
|
-
*
|
5718
|
-
* @interface
|
5930
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
5719
5931
|
*/
|
5720
|
-
declare type FrameDisconnectedEvent =
|
5721
|
-
type: 'disconnected';
|
5722
|
-
};
|
5932
|
+
declare type FrameDisconnectedEvent = DisconnectedEvent_3;
|
5723
5933
|
|
5724
5934
|
/**
|
5725
|
-
*
|
5726
|
-
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
5727
|
-
* under the {@link OpenFin.FrameEvents} namespace.
|
5935
|
+
* @deprecated Renamed to {@link Event}.
|
5728
5936
|
*/
|
5729
|
-
declare type FrameEvent =
|
5730
|
-
topic: 'frame';
|
5731
|
-
} & (FrameConnectedEvent | FrameDisconnectedEvent);
|
5937
|
+
declare type FrameEvent = Event_8;
|
5732
5938
|
|
5733
5939
|
declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
|
5734
5940
|
|
5735
5941
|
declare namespace FrameEvents {
|
5736
5942
|
export {
|
5943
|
+
BaseEvent_7 as BaseEvent,
|
5737
5944
|
BaseFrameEvent,
|
5945
|
+
ConnectedEvent_4 as ConnectedEvent,
|
5738
5946
|
FrameConnectedEvent,
|
5947
|
+
DisconnectedEvent_3 as DisconnectedEvent,
|
5739
5948
|
FrameDisconnectedEvent,
|
5949
|
+
Event_8 as Event,
|
5740
5950
|
FrameEvent,
|
5951
|
+
EventType_5 as EventType,
|
5741
5952
|
FrameEventType,
|
5742
|
-
|
5743
|
-
|
5953
|
+
Payload_6 as Payload,
|
5954
|
+
ByType_5 as ByType
|
5744
5955
|
}
|
5745
5956
|
}
|
5746
5957
|
|
5747
5958
|
/**
|
5748
|
-
*
|
5959
|
+
* @deprecated Renamed to {@link EventType}.
|
5749
5960
|
*/
|
5750
|
-
declare type FrameEventType =
|
5961
|
+
declare type FrameEventType = EventType_5;
|
5751
5962
|
|
5752
5963
|
/**
|
5753
5964
|
* @interface
|
@@ -5966,14 +6177,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
|
|
5966
6177
|
}
|
5967
6178
|
|
5968
6179
|
/**
|
5969
|
-
*
|
5970
|
-
* discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
5971
|
-
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
6180
|
+
* @deprecated Renamed to {@link Event}.
|
5972
6181
|
*/
|
5973
|
-
declare type GlobalHotkeyEvent =
|
5974
|
-
topic: 'global-hotkey';
|
5975
|
-
hotkey: 'string';
|
5976
|
-
} & (RegisteredEvent | UnregisteredEvent);
|
6182
|
+
declare type GlobalHotkeyEvent = Event_9;
|
5977
6183
|
|
5978
6184
|
declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
5979
6185
|
|
@@ -5981,17 +6187,19 @@ declare namespace GlobalHotkeyEvents {
|
|
5981
6187
|
export {
|
5982
6188
|
RegisteredEvent,
|
5983
6189
|
UnregisteredEvent,
|
6190
|
+
Event_9 as Event,
|
5984
6191
|
GlobalHotkeyEvent,
|
6192
|
+
EventType_6 as EventType,
|
5985
6193
|
GlobalHotkeyEventType,
|
5986
|
-
|
5987
|
-
|
6194
|
+
Payload_7 as Payload,
|
6195
|
+
ByType_6 as ByType
|
5988
6196
|
}
|
5989
6197
|
}
|
5990
6198
|
|
5991
6199
|
/**
|
5992
|
-
*
|
6200
|
+
* @deprecated Renamed to {@link EventType}.
|
5993
6201
|
*/
|
5994
|
-
declare type GlobalHotkeyEventType =
|
6202
|
+
declare type GlobalHotkeyEventType = EventType_6;
|
5995
6203
|
|
5996
6204
|
declare namespace GoldenLayout {
|
5997
6205
|
export {
|
@@ -6293,16 +6501,25 @@ declare interface Header {
|
|
6293
6501
|
* Generated when a View is hidden.
|
6294
6502
|
* @interface
|
6295
6503
|
*/
|
6296
|
-
declare type HiddenEvent =
|
6504
|
+
declare type HiddenEvent = BaseEvent_4 & {
|
6297
6505
|
type: 'hidden';
|
6298
6506
|
};
|
6299
6507
|
|
6508
|
+
/**
|
6509
|
+
* Generated when a window has been hidden.
|
6510
|
+
* @interface
|
6511
|
+
*/
|
6512
|
+
declare type HiddenEvent_2 = BaseEvent_5 & {
|
6513
|
+
type: 'hidden';
|
6514
|
+
reason: 'closing' | 'hide' | 'hide-on-close';
|
6515
|
+
};
|
6516
|
+
|
6300
6517
|
/**
|
6301
6518
|
* Generated when the context of a View's host window changes, either due to a call to {@link Platform#setWindowContext Platform.setWindowContext},
|
6302
6519
|
* or because the View has moved to a new window. Only available on Views in a Platform.
|
6303
6520
|
* @interface
|
6304
6521
|
*/
|
6305
|
-
declare type HostContextChangedEvent =
|
6522
|
+
declare type HostContextChangedEvent = BaseEvent_4 & {
|
6306
6523
|
type: 'host-context-changed';
|
6307
6524
|
context: any;
|
6308
6525
|
reason: 'reparented' | 'updated';
|
@@ -6381,7 +6598,16 @@ declare type Hotkey = {
|
|
6381
6598
|
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
6382
6599
|
* @interface
|
6383
6600
|
*/
|
6384
|
-
declare type HotkeyEvent =
|
6601
|
+
declare type HotkeyEvent = BaseEvent_4 & {
|
6602
|
+
type: 'hotkey';
|
6603
|
+
};
|
6604
|
+
|
6605
|
+
/**
|
6606
|
+
* Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
|
6607
|
+
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
6608
|
+
* @interface
|
6609
|
+
*/
|
6610
|
+
declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
|
6385
6611
|
type: 'hotkey';
|
6386
6612
|
};
|
6387
6613
|
|
@@ -6441,7 +6667,7 @@ declare type IdentityEvent = BaseEvent & {
|
|
6441
6667
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
6442
6668
|
* @interface
|
6443
6669
|
*/
|
6444
|
-
declare type IdleEvent =
|
6670
|
+
declare type IdleEvent = BaseEvent_8 & {
|
6445
6671
|
type: 'idle-state-changed';
|
6446
6672
|
elapsedTime: number;
|
6447
6673
|
isIdle: boolean;
|
@@ -6526,11 +6752,19 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
6526
6752
|
* Generated when an application has initialized.
|
6527
6753
|
* @interface
|
6528
6754
|
*/
|
6529
|
-
declare type InitializedEvent = IdentityEvent & {
|
6755
|
+
declare type InitializedEvent = BaseEvents.IdentityEvent & {
|
6530
6756
|
topic: 'application';
|
6531
6757
|
type: 'initialized';
|
6532
6758
|
};
|
6533
6759
|
|
6760
|
+
/**
|
6761
|
+
* Generated when a window is initialized.
|
6762
|
+
* @interface
|
6763
|
+
*/
|
6764
|
+
declare type InitializedEvent_2 = BaseEvent_5 & {
|
6765
|
+
type: 'initialized';
|
6766
|
+
};
|
6767
|
+
|
6534
6768
|
/**
|
6535
6769
|
* @interface
|
6536
6770
|
*/
|
@@ -8610,7 +8844,7 @@ declare type LayoutIdentity = Identity_5 & {
|
|
8610
8844
|
* Generated when a window and all of its layout's views have either finished or failed navigation.
|
8611
8845
|
* @interface
|
8612
8846
|
*/
|
8613
|
-
declare type LayoutInitializedEvent =
|
8847
|
+
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
8614
8848
|
type: 'layout-initialized';
|
8615
8849
|
ofViews: (OpenFin.Identity & {
|
8616
8850
|
entityType: 'view';
|
@@ -8970,7 +9204,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
8970
9204
|
* Generated when a window and all of its layout's views have been created and can receive API calls.
|
8971
9205
|
* @interface
|
8972
9206
|
*/
|
8973
|
-
declare type LayoutReadyEvent =
|
9207
|
+
declare type LayoutReadyEvent = BaseEvent_5 & {
|
8974
9208
|
type: 'layout-ready';
|
8975
9209
|
views: (OpenFin.Identity & {
|
8976
9210
|
success: boolean;
|
@@ -9111,7 +9345,7 @@ declare type Manifest = {
|
|
9111
9345
|
* Generated when the RVM notifies an application that the manifest has changed.
|
9112
9346
|
* @interface
|
9113
9347
|
*/
|
9114
|
-
declare type ManifestChangedEvent = IdentityEvent & {
|
9348
|
+
declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
|
9115
9349
|
topic: 'application';
|
9116
9350
|
type: 'manifest-changed';
|
9117
9351
|
};
|
@@ -9164,7 +9398,7 @@ declare type MatchPattern = string;
|
|
9164
9398
|
* Generated when a window is maximized.
|
9165
9399
|
* @interface
|
9166
9400
|
*/
|
9167
|
-
declare type MaximizedEvent =
|
9401
|
+
declare type MaximizedEvent = BaseEvent_5 & {
|
9168
9402
|
type: 'maximized';
|
9169
9403
|
};
|
9170
9404
|
|
@@ -9274,7 +9508,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
|
|
9274
9508
|
* Generated when a window is minimized.
|
9275
9509
|
* @interface
|
9276
9510
|
*/
|
9277
|
-
declare type MinimizedEvent =
|
9511
|
+
declare type MinimizedEvent = BaseEvent_5 & {
|
9278
9512
|
type: 'minimized';
|
9279
9513
|
};
|
9280
9514
|
|
@@ -9323,7 +9557,7 @@ declare type MonitorDetails = {
|
|
9323
9557
|
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
9324
9558
|
* @interface
|
9325
9559
|
*/
|
9326
|
-
declare type MonitorEvent =
|
9560
|
+
declare type MonitorEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
|
9327
9561
|
type: 'monitor-info-changed';
|
9328
9562
|
};
|
9329
9563
|
|
@@ -9745,13 +9979,15 @@ declare type NonPropagatedWebContentsEvent = never;
|
|
9745
9979
|
*/
|
9746
9980
|
declare type NonPropagatedWindowEvent = never;
|
9747
9981
|
|
9982
|
+
/* Excluded from this release type: NotCloseRequested */
|
9983
|
+
|
9748
9984
|
/* Excluded from this release type: NotRequested */
|
9749
9985
|
|
9750
9986
|
/**
|
9751
9987
|
* Generated when an application is not responding.
|
9752
9988
|
* @interface
|
9753
9989
|
*/
|
9754
|
-
declare type NotRespondingEvent = IdentityEvent & {
|
9990
|
+
declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
|
9755
9991
|
topic: 'application';
|
9756
9992
|
type: 'not-responding';
|
9757
9993
|
};
|
@@ -10077,7 +10313,7 @@ declare namespace OpenFin {
|
|
10077
10313
|
AppVersionCompleteEvent,
|
10078
10314
|
AppVersionRuntimeStatusEvent,
|
10079
10315
|
Events,
|
10080
|
-
|
10316
|
+
BaseEvent_9 as BaseEvent,
|
10081
10317
|
WebContentsEvent_2 as WebContentsEvent,
|
10082
10318
|
SystemEvent_2 as SystemEvent,
|
10083
10319
|
ApplicationEvent_2 as ApplicationEvent,
|
@@ -10119,12 +10355,32 @@ export default OpenFin;
|
|
10119
10355
|
|
10120
10356
|
declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
|
10121
10357
|
|
10358
|
+
/**
|
10359
|
+
* Generated after window options are changed using the window.updateOptions method.
|
10360
|
+
* @remarks Will not fire if the diff object is empty.
|
10361
|
+
* @interface
|
10362
|
+
*/
|
10363
|
+
declare type OptionsChangedEvent = BaseEvent_5 & {
|
10364
|
+
type: 'options-changed';
|
10365
|
+
options: OpenFin.WindowOptions;
|
10366
|
+
diff: OpenFin.WindowOptionDiff;
|
10367
|
+
};
|
10368
|
+
|
10122
10369
|
declare type OverlapsOnlyIfMatching<T, U> = {
|
10123
10370
|
[K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
|
10124
10371
|
};
|
10125
10372
|
|
10126
10373
|
declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
10127
10374
|
|
10375
|
+
/**
|
10376
|
+
* Generated when page receives favicon urls.
|
10377
|
+
* @interface
|
10378
|
+
*/
|
10379
|
+
declare type PageFaviconUpdatedEvent = NamedEvent & {
|
10380
|
+
type: 'page-favicon-updated';
|
10381
|
+
favicons: string[];
|
10382
|
+
};
|
10383
|
+
|
10128
10384
|
/**
|
10129
10385
|
* Generated when page title is set during navigation.
|
10130
10386
|
* @remarks explicitSet is false when title is synthesized from file url.
|
@@ -10143,74 +10399,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10143
10399
|
};
|
10144
10400
|
|
10145
10401
|
/**
|
10146
|
-
* Extracts a single event type matching the given key from the {@link
|
10402
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
10147
10403
|
*
|
10148
10404
|
* @typeParam Type String key specifying the event to extract
|
10149
10405
|
*/
|
10150
|
-
declare type Payload_2<Type extends
|
10406
|
+
declare type Payload_2<Type extends EventType> = Extract<Event_4, {
|
10151
10407
|
type: Type;
|
10152
10408
|
}>;
|
10153
10409
|
|
10154
10410
|
/**
|
10155
|
-
* Extracts a single event type matching the given key from the {@link
|
10411
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
10156
10412
|
*
|
10157
10413
|
* @typeParam Type String key specifying the event to extract
|
10158
10414
|
*/
|
10159
|
-
declare type Payload_3<Type extends
|
10415
|
+
declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
|
10160
10416
|
type: Type;
|
10161
10417
|
}>;
|
10162
10418
|
|
10163
10419
|
/**
|
10164
|
-
* Extracts a single event type matching the given key from the {@link
|
10420
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
10165
10421
|
*
|
10166
10422
|
* @typeParam Type String key specifying the event to extract
|
10167
10423
|
*/
|
10168
|
-
declare type Payload_4<Type extends
|
10424
|
+
declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
|
10169
10425
|
type: Type;
|
10170
10426
|
}>;
|
10171
10427
|
|
10172
10428
|
/**
|
10173
|
-
* Extracts a single event type matching the given key from the {@link
|
10429
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
10174
10430
|
*
|
10175
10431
|
* @typeParam Type String key specifying the event to extract
|
10176
10432
|
*/
|
10177
|
-
declare type Payload_5<Type extends
|
10433
|
+
declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
|
10178
10434
|
type: Type;
|
10179
10435
|
}>;
|
10180
10436
|
|
10181
10437
|
/**
|
10182
|
-
* Extracts a single event type matching the given key from the {@link
|
10438
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
10183
10439
|
*
|
10184
10440
|
* @typeParam Type String key specifying the event to extract
|
10185
10441
|
*/
|
10186
|
-
declare type Payload_6<Type extends
|
10442
|
+
declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
|
10187
10443
|
type: Type;
|
10188
10444
|
}>;
|
10189
10445
|
|
10190
10446
|
/**
|
10191
|
-
* Extracts a single event type matching the given key from the {@link
|
10447
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
10192
10448
|
*
|
10193
10449
|
* @typeParam Type String key specifying the event to extract
|
10194
10450
|
*/
|
10195
|
-
declare type Payload_7<Type extends
|
10451
|
+
declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
|
10196
10452
|
type: Type;
|
10197
10453
|
}>;
|
10198
10454
|
|
10199
10455
|
/**
|
10200
|
-
* Extracts a single event type matching the given key from the {@link
|
10456
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
10201
10457
|
*
|
10202
10458
|
* @typeParam Type String key specifying the event to extract
|
10203
10459
|
*/
|
10204
|
-
declare type Payload_8<Type extends
|
10460
|
+
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
10205
10461
|
type: Type;
|
10206
10462
|
}>;
|
10207
10463
|
|
10208
10464
|
/**
|
10209
|
-
* Extracts a single event type matching the given key from the {@link
|
10465
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
10210
10466
|
*
|
10211
10467
|
* @typeParam Type String key specifying the event to extract
|
10212
10468
|
*/
|
10213
|
-
declare type Payload_9<Type extends
|
10469
|
+
declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
|
10214
10470
|
type: Type;
|
10215
10471
|
}>;
|
10216
10472
|
|
@@ -10220,7 +10476,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
|
|
10220
10476
|
* Generated when window finishes loading. Provides performance and navigation data.
|
10221
10477
|
* @interface
|
10222
10478
|
*/
|
10223
|
-
declare type PerformanceReportEvent = Performance &
|
10479
|
+
declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
10224
10480
|
type: 'performance-report';
|
10225
10481
|
};
|
10226
10482
|
|
@@ -10854,38 +11110,36 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
|
|
10854
11110
|
}
|
10855
11111
|
|
10856
11112
|
/**
|
10857
|
-
*
|
10858
|
-
* @interface
|
11113
|
+
* @deprecated Renamed to {@link ApiReadyEvent}.
|
10859
11114
|
*/
|
10860
|
-
declare type PlatformApiReadyEvent =
|
10861
|
-
topic: 'application';
|
10862
|
-
type: 'platform-api-ready';
|
10863
|
-
};
|
11115
|
+
declare type PlatformApiReadyEvent = ApiReadyEvent;
|
10864
11116
|
|
10865
11117
|
/**
|
10866
|
-
*
|
10867
|
-
* discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
|
10868
|
-
* under the {@link OpenFin.PlatformEvents} namespace.
|
11118
|
+
* @deprecated Renamed to {@link Event}.
|
10869
11119
|
*/
|
10870
|
-
declare type PlatformEvent =
|
11120
|
+
declare type PlatformEvent = Event_10;
|
10871
11121
|
|
10872
11122
|
declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
|
10873
11123
|
|
10874
11124
|
declare namespace PlatformEvents {
|
10875
11125
|
export {
|
11126
|
+
ApiReadyEvent,
|
10876
11127
|
PlatformApiReadyEvent,
|
11128
|
+
SnapshotAppliedEvent,
|
10877
11129
|
PlatformSnapshotAppliedEvent,
|
11130
|
+
Event_10 as Event,
|
10878
11131
|
PlatformEvent,
|
11132
|
+
EventType_7 as EventType,
|
10879
11133
|
PlatformEventType,
|
10880
|
-
|
10881
|
-
|
11134
|
+
Payload_8 as Payload,
|
11135
|
+
ByType_7 as ByType
|
10882
11136
|
}
|
10883
11137
|
}
|
10884
11138
|
|
10885
11139
|
/**
|
10886
|
-
*
|
11140
|
+
* @deprecated Renamed to {@link }.
|
10887
11141
|
*/
|
10888
|
-
declare type PlatformEventType =
|
11142
|
+
declare type PlatformEventType = EventType_7;
|
10889
11143
|
|
10890
11144
|
/**
|
10891
11145
|
* Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
|
@@ -11550,19 +11804,9 @@ declare interface PlatformProvider {
|
|
11550
11804
|
}
|
11551
11805
|
|
11552
11806
|
/**
|
11553
|
-
*
|
11554
|
-
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
11555
|
-
* 1. The window has been created
|
11556
|
-
* 2. The window has a responsive API
|
11557
|
-
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
11558
|
-
*
|
11559
|
-
* _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.
|
11560
|
-
* @interface
|
11807
|
+
* @deprecated Renamed to {@link SnapshotAppliedEvent}.
|
11561
11808
|
*/
|
11562
|
-
declare type PlatformSnapshotAppliedEvent =
|
11563
|
-
topic: 'application';
|
11564
|
-
type: 'platform-snapshot-applied';
|
11565
|
-
};
|
11809
|
+
declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
|
11566
11810
|
|
11567
11811
|
/**
|
11568
11812
|
* @interface
|
@@ -11830,7 +12074,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
|
|
11830
12074
|
* A general preload scripts state change event without event type.
|
11831
12075
|
* @interface
|
11832
12076
|
*/
|
11833
|
-
declare type PreloadScriptsStateChangeEvent =
|
12077
|
+
declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
|
11834
12078
|
preloadScripts: (PreloadScriptInfoRunning & any)[];
|
11835
12079
|
};
|
11836
12080
|
|
@@ -12039,51 +12283,43 @@ declare type ProcessLoggingOptions = {
|
|
12039
12283
|
};
|
12040
12284
|
|
12041
12285
|
/**
|
12042
|
-
*
|
12043
|
-
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
12044
|
-
* are propagated to `System` without any type string prefixing.
|
12045
|
-
*
|
12046
|
-
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
12286
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
12047
12287
|
*/
|
12048
|
-
declare type PropagatedApplicationEvent<TargetTopic extends string> =
|
12288
|
+
declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
|
12049
12289
|
|
12050
12290
|
/**
|
12051
|
-
*
|
12291
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
12052
12292
|
*/
|
12053
|
-
declare type PropagatedApplicationEventType =
|
12293
|
+
declare type PropagatedApplicationEventType = PropagatedEventType_3;
|
12054
12294
|
|
12055
12295
|
/**
|
12056
|
-
* Modifies an event shape to reflect propagation to a parent topic.
|
12296
|
+
* Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
|
12297
|
+
* these do not propagate.
|
12298
|
+
*
|
12057
12299
|
* @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
|
12300
|
+
*
|
12301
|
+
* @typeParam SourceTopic The topic the event shape is propagating from.
|
12302
|
+
* @typeParam TargetTopic The topic the event shape is propagating to.
|
12303
|
+
* @typeParam Event The shape of the event being propagated.
|
12058
12304
|
*/
|
12059
12305
|
declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
|
12060
12306
|
type: string;
|
12061
12307
|
}> = Event extends infer E extends {
|
12062
12308
|
type: string;
|
12063
|
-
} ? Omit<E, 'type' | 'topic'> & {
|
12309
|
+
} ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
|
12064
12310
|
type: PropagatedEventType<SourceTopic, E['type']>;
|
12065
12311
|
topic: TargetTopic;
|
12066
12312
|
} : never;
|
12067
12313
|
|
12068
|
-
/**
|
12069
|
-
* Modifies an event key to reflect propagation by prefixing with the topic.
|
12070
|
-
*/
|
12071
|
-
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
|
12072
|
-
|
12073
12314
|
/**
|
12074
12315
|
* A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
|
12075
12316
|
* or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
|
12076
12317
|
* event type key with `'view-'`.
|
12077
12318
|
*/
|
12078
|
-
declare type
|
12319
|
+
declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
|
12079
12320
|
viewIdentity: OpenFin.Identity;
|
12080
12321
|
};
|
12081
12322
|
|
12082
|
-
/**
|
12083
|
-
* Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
|
12084
|
-
*/
|
12085
|
-
declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
12086
|
-
|
12087
12323
|
/**
|
12088
12324
|
* A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
|
12089
12325
|
* prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
|
@@ -12092,12 +12328,51 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
|
12092
12328
|
*
|
12093
12329
|
* "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
|
12094
12330
|
*/
|
12095
|
-
declare type
|
12331
|
+
declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
|
12332
|
+
|
12333
|
+
/**
|
12334
|
+
* An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
|
12335
|
+
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
12336
|
+
* are propagated to `System` without any type string prefixing.
|
12337
|
+
*
|
12338
|
+
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
12339
|
+
*/
|
12340
|
+
declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
|
12341
|
+
|
12342
|
+
/**
|
12343
|
+
* Modifies an event type key to reflect propagation by prefixing with the topic.
|
12344
|
+
*/
|
12345
|
+
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
|
12346
|
+
|
12347
|
+
/**
|
12348
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
|
12349
|
+
*/
|
12350
|
+
declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
|
12096
12351
|
|
12097
12352
|
/**
|
12098
|
-
* Union of possible
|
12353
|
+
* Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
|
12099
12354
|
*/
|
12100
|
-
declare type
|
12355
|
+
declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
|
12356
|
+
|
12357
|
+
/**
|
12358
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
12359
|
+
*/
|
12360
|
+
declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
|
12361
|
+
|
12362
|
+
/**
|
12363
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
12364
|
+
*/
|
12365
|
+
declare type PropagatedViewEventType = PropagatedEventType_2;
|
12366
|
+
|
12367
|
+
/**
|
12368
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
12369
|
+
*/
|
12370
|
+
declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
|
12371
|
+
|
12372
|
+
/**
|
12373
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
|
12374
|
+
*/
|
12375
|
+
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
12101
12376
|
|
12102
12377
|
declare interface ProtocolMap extends ProtocolMapBase {
|
12103
12378
|
'request-external-authorization': {
|
@@ -12515,7 +12790,7 @@ declare type RegistryInfo_2 = {
|
|
12515
12790
|
* Generated when a window has been reloaded.
|
12516
12791
|
* @interface
|
12517
12792
|
*/
|
12518
|
-
declare type ReloadedEvent =
|
12793
|
+
declare type ReloadedEvent = BaseEvent_5 & {
|
12519
12794
|
type: 'reloaded';
|
12520
12795
|
url: string;
|
12521
12796
|
};
|
@@ -12651,11 +12926,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
|
|
12651
12926
|
* Generated when an application is responding.
|
12652
12927
|
* @interface
|
12653
12928
|
*/
|
12654
|
-
declare type RespondingEvent = IdentityEvent & {
|
12929
|
+
declare type RespondingEvent = BaseEvents.IdentityEvent & {
|
12655
12930
|
topic: 'application';
|
12656
12931
|
type: 'responding';
|
12657
12932
|
};
|
12658
12933
|
|
12934
|
+
/**
|
12935
|
+
* Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
12936
|
+
* @interface
|
12937
|
+
*/
|
12938
|
+
declare type RestoredEvent = BaseEvent_5 & {
|
12939
|
+
type: 'restored';
|
12940
|
+
};
|
12941
|
+
|
12659
12942
|
declare type ResultBehavior = 'close' | 'hide' | 'none';
|
12660
12943
|
|
12661
12944
|
/**
|
@@ -12718,7 +13001,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
|
|
12718
13001
|
* Generated when Application.run() is called for an already running application.
|
12719
13002
|
* @interface
|
12720
13003
|
*/
|
12721
|
-
declare type RunRequestedEvent_2 = IdentityEvent & {
|
13004
|
+
declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
|
12722
13005
|
topic: 'application';
|
12723
13006
|
type: 'run-requested';
|
12724
13007
|
userAppConfigArgs: Record<string, any>;
|
@@ -12900,7 +13183,7 @@ declare type ServiceIdentifier = {
|
|
12900
13183
|
* Generated on changes to a user’s local computer session.
|
12901
13184
|
* @interface
|
12902
13185
|
*/
|
12903
|
-
declare type SessionChangedEvent =
|
13186
|
+
declare type SessionChangedEvent = BaseEvent_8 & {
|
12904
13187
|
type: 'session-changed';
|
12905
13188
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
12906
13189
|
};
|
@@ -13122,7 +13405,7 @@ declare type ShortcutOverride = Hotkey & {
|
|
13122
13405
|
*
|
13123
13406
|
* @interface
|
13124
13407
|
*/
|
13125
|
-
declare type ShowAllDownloadsEvent =
|
13408
|
+
declare type ShowAllDownloadsEvent = BaseEvent_5 & {
|
13126
13409
|
type: 'show-all-downloads';
|
13127
13410
|
};
|
13128
13411
|
|
@@ -13130,7 +13413,15 @@ declare type ShowAllDownloadsEvent = BaseWindowEvent & {
|
|
13130
13413
|
* Generated when a View is shown. This event will fire during creation of a View.
|
13131
13414
|
* @interface
|
13132
13415
|
*/
|
13133
|
-
declare type ShownEvent =
|
13416
|
+
declare type ShownEvent = BaseEvent_4 & {
|
13417
|
+
type: 'shown';
|
13418
|
+
};
|
13419
|
+
|
13420
|
+
/**
|
13421
|
+
* Generated when a hidden window has been shown.
|
13422
|
+
* @interface
|
13423
|
+
*/
|
13424
|
+
declare type ShownEvent_2 = BaseEvent_5 & {
|
13134
13425
|
type: 'shown';
|
13135
13426
|
};
|
13136
13427
|
|
@@ -13159,6 +13450,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
|
|
13159
13450
|
y?: number;
|
13160
13451
|
};
|
13161
13452
|
|
13453
|
+
/**
|
13454
|
+
* Generated when a window has been prevented from showing.
|
13455
|
+
* @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.
|
13456
|
+
* @interface
|
13457
|
+
*/
|
13458
|
+
declare type ShowRequestedEvent = BaseEvent_5 & {
|
13459
|
+
type: 'show-requested';
|
13460
|
+
};
|
13461
|
+
|
13162
13462
|
/**
|
13163
13463
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
13164
13464
|
*
|
@@ -13205,6 +13505,21 @@ declare type Snapshot = {
|
|
13205
13505
|
};
|
13206
13506
|
};
|
13207
13507
|
|
13508
|
+
/**
|
13509
|
+
* Generated when a platform.ApplySnapshot call is resolved.
|
13510
|
+
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
13511
|
+
* 1. The window has been created
|
13512
|
+
* 2. The window has a responsive API
|
13513
|
+
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
13514
|
+
*
|
13515
|
+
* _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.
|
13516
|
+
* @interface
|
13517
|
+
*/
|
13518
|
+
declare type SnapshotAppliedEvent = BaseEvent & {
|
13519
|
+
topic: 'application';
|
13520
|
+
type: 'platform-snapshot-applied';
|
13521
|
+
};
|
13522
|
+
|
13208
13523
|
/**
|
13209
13524
|
* @interface
|
13210
13525
|
*/
|
@@ -13319,7 +13634,7 @@ declare class SnapshotSourceModule extends Base {
|
|
13319
13634
|
* Generated when an application has started.
|
13320
13635
|
* @interface
|
13321
13636
|
*/
|
13322
|
-
declare type StartedEvent = IdentityEvent & {
|
13637
|
+
declare type StartedEvent = BaseEvents.IdentityEvent & {
|
13323
13638
|
topic: 'application';
|
13324
13639
|
type: 'started';
|
13325
13640
|
};
|
@@ -14852,12 +15167,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
|
|
14852
15167
|
};
|
14853
15168
|
|
14854
15169
|
/**
|
14855
|
-
*
|
14856
|
-
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
14857
|
-
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
14858
|
-
* from which they propagate).
|
15170
|
+
* @deprecated Renamed to {@link Event}.
|
14859
15171
|
*/
|
14860
|
-
declare type SystemEvent =
|
15172
|
+
declare type SystemEvent = Event_11;
|
14861
15173
|
|
14862
15174
|
declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
|
14863
15175
|
|
@@ -14865,7 +15177,7 @@ declare namespace SystemEvents {
|
|
14865
15177
|
export {
|
14866
15178
|
NotRequested,
|
14867
15179
|
ExcludeRequested,
|
14868
|
-
|
15180
|
+
BaseEvent_8 as BaseEvent,
|
14869
15181
|
IdleEvent,
|
14870
15182
|
MonitorEvent,
|
14871
15183
|
SessionChangedEvent,
|
@@ -14880,17 +15192,19 @@ declare namespace SystemEvents {
|
|
14880
15192
|
ApplicationCreatedEvent,
|
14881
15193
|
DesktopIconClickedEvent,
|
14882
15194
|
SystemShutdownEvent,
|
15195
|
+
Event_11 as Event,
|
14883
15196
|
SystemEvent,
|
15197
|
+
EventType_8 as EventType,
|
14884
15198
|
SystemEventType,
|
14885
|
-
|
14886
|
-
|
15199
|
+
Payload_9 as Payload,
|
15200
|
+
ByType_8 as ByType
|
14887
15201
|
}
|
14888
15202
|
}
|
14889
15203
|
|
14890
15204
|
/**
|
14891
|
-
*
|
15205
|
+
* @deprecated Renamed to {@link EventType}.
|
14892
15206
|
*/
|
14893
|
-
declare type SystemEventType =
|
15207
|
+
declare type SystemEventType = EventType_8;
|
14894
15208
|
|
14895
15209
|
/**
|
14896
15210
|
* @interface
|
@@ -15143,7 +15457,7 @@ declare type TargetApp = string | AppMetadata;
|
|
15143
15457
|
* In that case, previousTarget identity will be the same as target identity.
|
15144
15458
|
* @interface
|
15145
15459
|
*/
|
15146
|
-
declare type TargetChangedEvent =
|
15460
|
+
declare type TargetChangedEvent = BaseEvent_4 & {
|
15147
15461
|
type: 'target-changed';
|
15148
15462
|
previousTarget: OpenFin.Identity;
|
15149
15463
|
};
|
@@ -15297,7 +15611,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
15297
15611
|
* Generated when the tray icon is clicked.
|
15298
15612
|
* @interface
|
15299
15613
|
*/
|
15300
|
-
declare type TrayIconClickedEvent = IdentityEvent & {
|
15614
|
+
declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
|
15301
15615
|
topic: 'application';
|
15302
15616
|
type: 'tray-icon-clicked';
|
15303
15617
|
button: 0 | 1 | 2;
|
@@ -15387,7 +15701,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
15387
15701
|
* A general user bounds change event without event type.
|
15388
15702
|
* @interface
|
15389
15703
|
*/
|
15390
|
-
declare type UserBoundsChangeEvent =
|
15704
|
+
declare type UserBoundsChangeEvent = BaseEvent_5 & {
|
15391
15705
|
height: number;
|
15392
15706
|
left: number;
|
15393
15707
|
top: number;
|
@@ -15399,7 +15713,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
|
|
15399
15713
|
* Generated when a window's user movement becomes disabled.
|
15400
15714
|
* @interface
|
15401
15715
|
*/
|
15402
|
-
declare type UserMovementDisabledEvent =
|
15716
|
+
declare type UserMovementDisabledEvent = BaseEvent_5 & {
|
15403
15717
|
type: 'user-movement-disabled';
|
15404
15718
|
};
|
15405
15719
|
|
@@ -15407,7 +15721,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
|
|
15407
15721
|
* Generated when a window's user movement becomes enabled.
|
15408
15722
|
* @interface
|
15409
15723
|
*/
|
15410
|
-
declare type UserMovementEnabledEvent =
|
15724
|
+
declare type UserMovementEnabledEvent = BaseEvent_5 & {
|
15411
15725
|
type: 'user-movement-enabled';
|
15412
15726
|
};
|
15413
15727
|
|
@@ -16057,7 +16371,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
16057
16371
|
* Generated when a View is attached to a window.
|
16058
16372
|
* @interface
|
16059
16373
|
*/
|
16060
|
-
declare type ViewAttachedEvent =
|
16374
|
+
declare type ViewAttachedEvent = BaseEvent_5 & {
|
16061
16375
|
type: 'view-attached';
|
16062
16376
|
target: OpenFin.Identity;
|
16063
16377
|
viewIdentity: OpenFin.Identity;
|
@@ -16099,7 +16413,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
|
|
16099
16413
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
16100
16414
|
* @interface
|
16101
16415
|
*/
|
16102
|
-
declare type ViewDetachedEvent =
|
16416
|
+
declare type ViewDetachedEvent = BaseEvent_5 & {
|
16103
16417
|
type: 'view-detached';
|
16104
16418
|
target: OpenFin.Identity;
|
16105
16419
|
previousTarget: OpenFin.Identity;
|
@@ -16107,18 +16421,15 @@ declare type ViewDetachedEvent = BaseWindowEvent & {
|
|
16107
16421
|
};
|
16108
16422
|
|
16109
16423
|
/**
|
16110
|
-
*
|
16111
|
-
* discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
|
16112
|
-
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
16424
|
+
* @deprecated Renamed to {@link Event}.
|
16113
16425
|
*/
|
16114
|
-
declare type ViewEvent =
|
16115
|
-
target: OpenFin.Identity;
|
16116
|
-
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
16426
|
+
declare type ViewEvent = Event_4;
|
16117
16427
|
|
16118
16428
|
declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
|
16119
16429
|
|
16120
16430
|
declare namespace ViewEvents {
|
16121
16431
|
export {
|
16432
|
+
BaseEvent_4 as BaseEvent,
|
16122
16433
|
BaseViewEvent,
|
16123
16434
|
TargetChangedEvent,
|
16124
16435
|
NonPropagatedViewEvent,
|
@@ -16128,20 +16439,24 @@ declare namespace ViewEvents {
|
|
16128
16439
|
HotkeyEvent,
|
16129
16440
|
ShownEvent,
|
16130
16441
|
HostContextChangedEvent,
|
16442
|
+
Event_4 as Event,
|
16131
16443
|
ViewEvent,
|
16132
16444
|
WillPropagateViewEvent,
|
16445
|
+
EventType,
|
16133
16446
|
ViewEventType,
|
16447
|
+
PropagatedEvent_2 as PropagatedEvent,
|
16134
16448
|
PropagatedViewEvent,
|
16449
|
+
PropagatedEventType_2 as PropagatedEventType,
|
16135
16450
|
PropagatedViewEventType,
|
16136
|
-
|
16137
|
-
|
16451
|
+
Payload_2 as Payload,
|
16452
|
+
ByType
|
16138
16453
|
}
|
16139
16454
|
}
|
16140
16455
|
|
16141
16456
|
/**
|
16142
|
-
*
|
16457
|
+
* @deprecated Renamed to {@link EventType}.
|
16143
16458
|
*/
|
16144
|
-
declare type ViewEventType =
|
16459
|
+
declare type ViewEventType = EventType;
|
16145
16460
|
|
16146
16461
|
/**
|
16147
16462
|
* @interface
|
@@ -17280,12 +17595,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
17280
17595
|
}
|
17281
17596
|
|
17282
17597
|
/**
|
17283
|
-
*
|
17284
|
-
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
17598
|
+
* @deprecated Renamed to {@link Event}.
|
17285
17599
|
*/
|
17286
|
-
declare type WebContentsEvent<Topic extends string> =
|
17287
|
-
topic: Topic;
|
17288
|
-
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
17600
|
+
declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
|
17289
17601
|
|
17290
17602
|
declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
|
17291
17603
|
|
@@ -17297,6 +17609,7 @@ declare namespace WebContentsEvents {
|
|
17297
17609
|
CrashedEvent_2 as CrashedEvent,
|
17298
17610
|
CertificateErrorEvent,
|
17299
17611
|
CertificateSelectionShownEvent,
|
17612
|
+
PageFaviconUpdatedEvent,
|
17300
17613
|
FaviconUpdatedEvent,
|
17301
17614
|
NavigationRejectedEvent,
|
17302
17615
|
UrlChangedEvent,
|
@@ -17315,6 +17628,7 @@ declare namespace WebContentsEvents {
|
|
17315
17628
|
FileDownloadStartedEvent,
|
17316
17629
|
FileDownloadProgressEvent,
|
17317
17630
|
FileDownloadCompletedEvent,
|
17631
|
+
Event_5 as Event,
|
17318
17632
|
WebContentsEvent,
|
17319
17633
|
WillPropagateWebContentsEvent,
|
17320
17634
|
NonPropagatedWebContentsEvent
|
@@ -17362,7 +17676,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
17362
17676
|
* A general will-move or will-resize event without event type.
|
17363
17677
|
* @interface
|
17364
17678
|
*/
|
17365
|
-
declare type WillMoveOrResizeEvent =
|
17679
|
+
declare type WillMoveOrResizeEvent = BaseEvent_5 & {
|
17366
17680
|
height: number;
|
17367
17681
|
left: number;
|
17368
17682
|
top: number;
|
@@ -17384,7 +17698,7 @@ declare type WillPropagateViewEvent = ViewEvent;
|
|
17384
17698
|
*
|
17385
17699
|
* A WebContents event that does propagate to (republish on) parent topics.
|
17386
17700
|
*/
|
17387
|
-
declare type WillPropagateWebContentsEvent =
|
17701
|
+
declare type WillPropagateWebContentsEvent = Event_5<string>;
|
17388
17702
|
|
17389
17703
|
/**
|
17390
17704
|
* @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
|
@@ -17398,7 +17712,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
|
|
17398
17712
|
* Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
|
17399
17713
|
* @interface
|
17400
17714
|
*/
|
17401
|
-
declare type WillRedirectEvent =
|
17715
|
+
declare type WillRedirectEvent = BaseEvent_5 & {
|
17402
17716
|
type: 'will-redirect';
|
17403
17717
|
blocked: boolean;
|
17404
17718
|
isInPlace: boolean;
|
@@ -18953,29 +19267,19 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
18953
19267
|
};
|
18954
19268
|
|
18955
19269
|
/**
|
18956
|
-
*
|
18957
|
-
* @interface
|
19270
|
+
* @deprecated Renamed to {@link ClosedEvent}.
|
18958
19271
|
*/
|
18959
|
-
declare type WindowClosedEvent =
|
18960
|
-
type: 'closed';
|
18961
|
-
};
|
19272
|
+
declare type WindowClosedEvent = ClosedEvent_2;
|
18962
19273
|
|
18963
19274
|
/**
|
18964
|
-
*
|
18965
|
-
* @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.
|
18966
|
-
* @interface
|
19275
|
+
* @deprecated Renamed to {@link CloseRequestedEvent}.
|
18967
19276
|
*/
|
18968
|
-
declare type WindowCloseRequestedEvent =
|
18969
|
-
type: 'close-requested';
|
18970
|
-
};
|
19277
|
+
declare type WindowCloseRequestedEvent = CloseRequestedEvent;
|
18971
19278
|
|
18972
19279
|
/**
|
18973
|
-
*
|
18974
|
-
* @interface
|
19280
|
+
* @deprecated Renamed to {@link ClosingEvent}.
|
18975
19281
|
*/
|
18976
|
-
declare type WindowClosingEvent =
|
18977
|
-
type: 'closing';
|
18978
|
-
};
|
19282
|
+
declare type WindowClosingEvent = ClosingEvent;
|
18979
19283
|
|
18980
19284
|
/**
|
18981
19285
|
* A rule prescribing content creation in a {@link OpenFin.Window}.
|
@@ -19059,16 +19363,15 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19059
19363
|
};
|
19060
19364
|
|
19061
19365
|
/**
|
19062
|
-
*
|
19063
|
-
* discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
|
19064
|
-
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
19366
|
+
* @deprecated, Renamed to {@link Event}.
|
19065
19367
|
*/
|
19066
|
-
declare type WindowEvent =
|
19368
|
+
declare type WindowEvent = Event_6;
|
19067
19369
|
|
19068
19370
|
declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
|
19069
19371
|
|
19070
19372
|
declare namespace WindowEvents {
|
19071
19373
|
export {
|
19374
|
+
BaseEvent_5 as BaseEvent,
|
19072
19375
|
BaseWindowEvent,
|
19073
19376
|
ViewAttachedEvent,
|
19074
19377
|
ViewDetachedEvent,
|
@@ -19078,9 +19381,11 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19078
19381
|
EndLoadEvent,
|
19079
19382
|
WillRedirectEvent,
|
19080
19383
|
ReloadedEvent,
|
19384
|
+
OptionsChangedEvent,
|
19081
19385
|
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
19082
19386
|
ExternalProcessExitedEvent,
|
19083
19387
|
ExternalProcessStartedEvent,
|
19388
|
+
HiddenEvent_2 as HiddenEvent,
|
19084
19389
|
WindowHiddenEvent,
|
19085
19390
|
PreloadScriptInfoRunning,
|
19086
19391
|
PreloadScriptInfo,
|
@@ -19095,22 +19400,30 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19095
19400
|
BeginUserBoundsChangingEvent,
|
19096
19401
|
BoundsChangedEvent,
|
19097
19402
|
BoundsChangingEvent,
|
19403
|
+
CloseRequestedEvent,
|
19098
19404
|
WindowCloseRequestedEvent,
|
19099
19405
|
ContextChangedEvent,
|
19406
|
+
ClosedEvent_2 as ClosedEvent,
|
19100
19407
|
WindowClosedEvent,
|
19408
|
+
ClosingEvent,
|
19101
19409
|
WindowClosingEvent,
|
19102
19410
|
DisabledMovementBoundsChangedEvent,
|
19103
19411
|
DisabledMovementBoundsChangingEvent,
|
19104
19412
|
EmbeddedEvent,
|
19105
19413
|
EndUserBoundsChangingEvent,
|
19414
|
+
HotkeyEvent_2 as HotkeyEvent,
|
19106
19415
|
WindowHotkeyEvent,
|
19416
|
+
InitializedEvent_2 as InitializedEvent,
|
19107
19417
|
WindowInitializedEvent,
|
19108
19418
|
MaximizedEvent,
|
19109
19419
|
MinimizedEvent,
|
19110
19420
|
PreloadScriptsStateChangedEvent,
|
19111
19421
|
PreloadScriptsStateChangingEvent,
|
19422
|
+
RestoredEvent,
|
19112
19423
|
WindowRestoredEvent,
|
19424
|
+
ShowRequestedEvent,
|
19113
19425
|
WindowShowRequestedEvent,
|
19426
|
+
ShownEvent_2 as ShownEvent,
|
19114
19427
|
WindowShownEvent,
|
19115
19428
|
UserMovementEnabledEvent,
|
19116
19429
|
UserMovementDisabledEvent,
|
@@ -19121,37 +19434,32 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19121
19434
|
DownloadShelfVisibilityChangedEvent,
|
19122
19435
|
WindowSourcedEvent,
|
19123
19436
|
WillPropagateWindowEvent,
|
19437
|
+
Event_6 as Event,
|
19124
19438
|
WindowEvent,
|
19439
|
+
EventType_2 as EventType,
|
19125
19440
|
WindowEventType,
|
19441
|
+
PropagatedEvent_3 as PropagatedEvent,
|
19126
19442
|
PropagatedWindowEvent,
|
19127
19443
|
PropagatedWindowEventType,
|
19128
|
-
|
19129
|
-
|
19444
|
+
Payload_3 as Payload,
|
19445
|
+
ByType_2 as ByType
|
19130
19446
|
}
|
19131
19447
|
}
|
19132
19448
|
|
19133
19449
|
/**
|
19134
|
-
*
|
19450
|
+
* @deprecated Renamed to {@link EventType}.
|
19135
19451
|
*/
|
19136
19452
|
declare type WindowEventType = WindowEvent['type'];
|
19137
19453
|
|
19138
19454
|
/**
|
19139
|
-
*
|
19140
|
-
* @interface
|
19455
|
+
* @deprecated Renamed to {@link HiddenEvent}.
|
19141
19456
|
*/
|
19142
|
-
declare type WindowHiddenEvent =
|
19143
|
-
type: 'hidden';
|
19144
|
-
reason: 'closing' | 'hide' | 'hide-on-close';
|
19145
|
-
};
|
19457
|
+
declare type WindowHiddenEvent = HiddenEvent_2;
|
19146
19458
|
|
19147
19459
|
/**
|
19148
|
-
*
|
19149
|
-
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
19150
|
-
* @interface
|
19460
|
+
* @deprecated Renamed to {@link HotkeyEvent}.
|
19151
19461
|
*/
|
19152
|
-
declare type WindowHotkeyEvent =
|
19153
|
-
type: 'hotkey';
|
19154
|
-
};
|
19462
|
+
declare type WindowHotkeyEvent = HotkeyEvent_2;
|
19155
19463
|
|
19156
19464
|
/**
|
19157
19465
|
* @interface
|
@@ -19165,12 +19473,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19165
19473
|
};
|
19166
19474
|
|
19167
19475
|
/**
|
19168
|
-
*
|
19169
|
-
* @interface
|
19476
|
+
* @deprecated Renamed to {@link InitializedEvent}.
|
19170
19477
|
*/
|
19171
|
-
declare type WindowInitializedEvent =
|
19172
|
-
type: 'initialized';
|
19173
|
-
};
|
19478
|
+
declare type WindowInitializedEvent = InitializedEvent_2;
|
19174
19479
|
|
19175
19480
|
/**
|
19176
19481
|
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
@@ -19289,15 +19594,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19289
19594
|
declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
|
19290
19595
|
|
19291
19596
|
/**
|
19292
|
-
*
|
19293
|
-
* @remarks Will not fire if the diff object is empty.
|
19294
|
-
* @interface
|
19597
|
+
* @deprecated Renamed to {@link OptionsChangedEvent}.
|
19295
19598
|
*/
|
19296
|
-
declare type WindowOptionsChangedEvent_2 =
|
19297
|
-
type: 'options-changed';
|
19298
|
-
options: OpenFin.WindowOptions;
|
19299
|
-
diff: OpenFin.WindowOptionDiff;
|
19300
|
-
};
|
19599
|
+
declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
|
19301
19600
|
|
19302
19601
|
declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
|
19303
19602
|
|
@@ -19310,35 +19609,25 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19310
19609
|
};
|
19311
19610
|
|
19312
19611
|
/**
|
19313
|
-
*
|
19314
|
-
* @interface
|
19612
|
+
* @deprecated Renamed to {@link RestoredEvent}.
|
19315
19613
|
*/
|
19316
|
-
declare type WindowRestoredEvent =
|
19317
|
-
type: 'restored';
|
19318
|
-
};
|
19614
|
+
declare type WindowRestoredEvent = RestoredEvent;
|
19319
19615
|
|
19320
19616
|
/**
|
19321
|
-
*
|
19322
|
-
* @interface
|
19617
|
+
* @deprecated Renamed to {@link ShownEvent}.
|
19323
19618
|
*/
|
19324
|
-
declare type WindowShownEvent =
|
19325
|
-
type: 'shown';
|
19326
|
-
};
|
19619
|
+
declare type WindowShownEvent = ShownEvent_2;
|
19327
19620
|
|
19328
19621
|
/**
|
19329
|
-
*
|
19330
|
-
* @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.
|
19331
|
-
* @interface
|
19622
|
+
* @deprecated Renamed to {@link ShowRequestedEvent}.
|
19332
19623
|
*/
|
19333
|
-
declare type WindowShowRequestedEvent =
|
19334
|
-
type: 'show-requested';
|
19335
|
-
};
|
19624
|
+
declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
19336
19625
|
|
19337
19626
|
/**
|
19338
19627
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
19339
19628
|
* from {@link OpenFin.ViewEvents}.
|
19340
19629
|
*/
|
19341
|
-
declare type WindowSourcedEvent =
|
19630
|
+
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;
|
19342
19631
|
|
19343
19632
|
/**
|
19344
19633
|
* Generated when a child window starts loading.
|