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