@openfin/node-adapter 35.78.1 → 35.78.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/node-adapter-alpha.d.ts +666 -371
- package/out/node-adapter-beta.d.ts +666 -371
- package/out/node-adapter-public.d.ts +666 -371
- package/out/node-adapter.d.ts +704 -397
- package/out/node-adapter.js +0 -1
- package/package.json +3 -2
@@ -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,
|
@@ -916,6 +919,7 @@ declare namespace ApplicationEvents {
|
|
916
919
|
WindowStartLoadEvent,
|
917
920
|
ApplicationWindowEvent,
|
918
921
|
ClosedEvent,
|
922
|
+
ConnectedEvent_2 as ConnectedEvent,
|
919
923
|
ApplicationConnectedEvent,
|
920
924
|
InitializedEvent,
|
921
925
|
ManifestChangedEvent,
|
@@ -923,19 +927,23 @@ declare namespace ApplicationEvents {
|
|
923
927
|
RespondingEvent,
|
924
928
|
StartedEvent,
|
925
929
|
ApplicationSourcedEvent,
|
930
|
+
Event_3 as Event,
|
926
931
|
ApplicationEvent,
|
932
|
+
EventType_3 as EventType,
|
927
933
|
ApplicationEventType,
|
934
|
+
PropagatedEvent_4 as PropagatedEvent,
|
928
935
|
PropagatedApplicationEvent,
|
936
|
+
PropagatedEventType_3 as PropagatedEventType,
|
929
937
|
PropagatedApplicationEventType,
|
930
|
-
|
931
|
-
ByType
|
938
|
+
Payload_4 as Payload,
|
939
|
+
ByType_3 as ByType
|
932
940
|
}
|
933
941
|
}
|
934
942
|
|
935
943
|
/**
|
936
|
-
*
|
944
|
+
* @deprecated Renamed to {@link EventType}.
|
937
945
|
*/
|
938
|
-
declare type ApplicationEventType =
|
946
|
+
declare type ApplicationEventType = EventType_3;
|
939
947
|
|
940
948
|
declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
|
941
949
|
|
@@ -1288,9 +1296,8 @@ declare type ApplicationPermissions = {
|
|
1288
1296
|
* A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
|
1289
1297
|
* from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
|
1290
1298
|
* does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
|
1291
|
-
*
|
1292
1299
|
*/
|
1293
|
-
declare type ApplicationSourcedEvent = ClosedEvent |
|
1300
|
+
declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
1294
1301
|
|
1295
1302
|
declare type ApplicationState = OpenFin.ApplicationState;
|
1296
1303
|
|
@@ -1598,7 +1605,7 @@ declare interface AuthorizationPayload {
|
|
1598
1605
|
* ```
|
1599
1606
|
* @interface
|
1600
1607
|
*/
|
1601
|
-
declare type AuthRequestedEvent =
|
1608
|
+
declare type AuthRequestedEvent = BaseEvent_5 & {
|
1602
1609
|
type: 'auth-requested';
|
1603
1610
|
authInfo: {
|
1604
1611
|
host: string;
|
@@ -1660,21 +1667,9 @@ declare class Base {
|
|
1660
1667
|
}
|
1661
1668
|
|
1662
1669
|
/**
|
1663
|
-
*
|
1664
|
-
* @interface
|
1665
|
-
*/
|
1666
|
-
declare type BaseApplicationEvent = NamedEvent & {
|
1667
|
-
topic: `application`;
|
1668
|
-
};
|
1669
|
-
|
1670
|
-
/**
|
1671
|
-
* A base Channel event.
|
1672
|
-
* @interface
|
1670
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1673
1671
|
*/
|
1674
|
-
declare type
|
1675
|
-
channelName: string;
|
1676
|
-
channelId: string;
|
1677
|
-
};
|
1672
|
+
declare type BaseApplicationEvent = BaseEvent_3;
|
1678
1673
|
|
1679
1674
|
/**
|
1680
1675
|
* @interface
|
@@ -1743,10 +1738,70 @@ declare type BaseEvent = {
|
|
1743
1738
|
type: string;
|
1744
1739
|
};
|
1745
1740
|
|
1746
|
-
|
1741
|
+
/**
|
1742
|
+
* A base Channel event.
|
1743
|
+
* @interface
|
1744
|
+
*/
|
1745
|
+
declare type BaseEvent_2 = NamedEvent & {
|
1746
|
+
channelName: string;
|
1747
|
+
channelId: string;
|
1748
|
+
};
|
1749
|
+
|
1750
|
+
/**
|
1751
|
+
* Base type for events emitting on the `application` topic
|
1752
|
+
* @interface
|
1753
|
+
*/
|
1754
|
+
declare type BaseEvent_3 = BaseEvents.NamedEvent & {
|
1755
|
+
topic: `application`;
|
1756
|
+
};
|
1757
|
+
|
1758
|
+
/**
|
1759
|
+
* Base type for events emitting on the `view` topic
|
1760
|
+
* @interface
|
1761
|
+
*/
|
1762
|
+
declare type BaseEvent_4 = BaseEvents.NamedEvent & {
|
1763
|
+
topic: 'view';
|
1764
|
+
target: OpenFin.Identity;
|
1765
|
+
};
|
1766
|
+
|
1767
|
+
/**
|
1768
|
+
* Base type for events emitting on the `window` topic
|
1769
|
+
* @interface
|
1770
|
+
*/
|
1771
|
+
declare type BaseEvent_5 = BaseEvents.NamedEvent & {
|
1772
|
+
topic: 'window';
|
1773
|
+
};
|
1774
|
+
|
1775
|
+
/**
|
1776
|
+
* Base type for events emitting on the `externalapplication` topic
|
1777
|
+
* @interface
|
1778
|
+
*/
|
1779
|
+
declare type BaseEvent_6 = BaseEvents.BaseEvent & {
|
1780
|
+
topic: 'externalapplication';
|
1781
|
+
};
|
1782
|
+
|
1783
|
+
/**
|
1784
|
+
* The base frame event.
|
1785
|
+
* @interface
|
1786
|
+
*/
|
1787
|
+
declare type BaseEvent_7 = NamedEvent & {
|
1788
|
+
entityType: 'iframe';
|
1789
|
+
frameName: string;
|
1790
|
+
};
|
1791
|
+
|
1792
|
+
/**
|
1793
|
+
* Base type for events emitting on the `system` topic
|
1794
|
+
* @interface
|
1795
|
+
*/
|
1796
|
+
declare type BaseEvent_8 = BaseEvents.BaseEvent & {
|
1797
|
+
topic: 'system';
|
1798
|
+
};
|
1799
|
+
|
1800
|
+
declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
|
1747
1801
|
|
1748
1802
|
declare namespace BaseEvents {
|
1749
1803
|
export {
|
1804
|
+
NotCloseRequested,
|
1750
1805
|
PropagatedEventType,
|
1751
1806
|
PropagatedEvent,
|
1752
1807
|
EventHandler,
|
@@ -1757,21 +1812,14 @@ declare namespace BaseEvents {
|
|
1757
1812
|
}
|
1758
1813
|
|
1759
1814
|
/**
|
1760
|
-
*
|
1761
|
-
* @interface
|
1815
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1762
1816
|
*/
|
1763
|
-
declare type BaseExternalApplicationEvent =
|
1764
|
-
topic: 'externalapplication';
|
1765
|
-
};
|
1817
|
+
declare type BaseExternalApplicationEvent = BaseEvent_6;
|
1766
1818
|
|
1767
1819
|
/**
|
1768
|
-
*
|
1769
|
-
* @interface
|
1820
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1770
1821
|
*/
|
1771
|
-
declare type BaseFrameEvent =
|
1772
|
-
entityType: 'iframe';
|
1773
|
-
frameName: string;
|
1774
|
-
};
|
1822
|
+
declare type BaseFrameEvent = BaseEvent_7;
|
1775
1823
|
|
1776
1824
|
declare type BaseLoadFailedEvent = NamedEvent & {
|
1777
1825
|
errorCode: number;
|
@@ -1780,35 +1828,20 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
1780
1828
|
isMainFrame: boolean;
|
1781
1829
|
};
|
1782
1830
|
|
1783
|
-
/**
|
1784
|
-
* Base type for events emitting on the `system` topic
|
1785
|
-
* @interface
|
1786
|
-
*/
|
1787
|
-
declare type BaseSystemEvent = BaseEvent & {
|
1788
|
-
topic: 'system';
|
1789
|
-
};
|
1790
|
-
|
1791
1831
|
declare type BaseUrlEvent = NamedEvent & {
|
1792
1832
|
type: 'url-changed';
|
1793
1833
|
url: string;
|
1794
1834
|
};
|
1795
1835
|
|
1796
1836
|
/**
|
1797
|
-
*
|
1798
|
-
* @interface
|
1837
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1799
1838
|
*/
|
1800
|
-
declare type BaseViewEvent =
|
1801
|
-
topic: 'view';
|
1802
|
-
target: OpenFin.Identity;
|
1803
|
-
};
|
1839
|
+
declare type BaseViewEvent = BaseEvent_4;
|
1804
1840
|
|
1805
1841
|
/**
|
1806
|
-
*
|
1807
|
-
* @interface
|
1842
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1808
1843
|
*/
|
1809
|
-
declare type BaseWindowEvent =
|
1810
|
-
topic: 'window';
|
1811
|
-
};
|
1844
|
+
declare type BaseWindowEvent = BaseEvent_5;
|
1812
1845
|
|
1813
1846
|
/**
|
1814
1847
|
* User decision of whether a Window or specific View should close when trying to prevent an unload.
|
@@ -1875,7 +1908,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
1875
1908
|
* A general bounds change event without event type.
|
1876
1909
|
* @interface
|
1877
1910
|
*/
|
1878
|
-
declare type BoundsChangeEvent =
|
1911
|
+
declare type BoundsChangeEvent = BaseEvent_5 & {
|
1879
1912
|
changeType: 0 | 1 | 2;
|
1880
1913
|
deferred: boolean;
|
1881
1914
|
height: number;
|
@@ -1947,76 +1980,76 @@ declare interface BrowserWindow {
|
|
1947
1980
|
}
|
1948
1981
|
|
1949
1982
|
/**
|
1950
|
-
* Extracts a single event type matching the given key from the {@link
|
1983
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
1951
1984
|
*
|
1952
1985
|
* Alias for {@link Payload}, which may read better in source.
|
1953
1986
|
*
|
1954
1987
|
* @typeParam Type String key specifying the event to extract
|
1955
1988
|
*/
|
1956
|
-
declare type ByType<Type extends
|
1989
|
+
declare type ByType<Type extends EventType> = Payload_2<Type>;
|
1957
1990
|
|
1958
1991
|
/**
|
1959
|
-
* Extracts a single event type matching the given key from the {@link
|
1992
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
1960
1993
|
*
|
1961
1994
|
* Alias for {@link Payload}, which may read better in source.
|
1962
1995
|
*
|
1963
1996
|
* @typeParam Type String key specifying the event to extract
|
1964
1997
|
*/
|
1965
|
-
declare type ByType_2<Type extends
|
1998
|
+
declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
1966
1999
|
|
1967
2000
|
/**
|
1968
|
-
* Extracts a single event type matching the given key from the {@link
|
2001
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
1969
2002
|
*
|
1970
2003
|
* Alias for {@link Payload}, which may read better in source.
|
1971
2004
|
*
|
1972
2005
|
* @typeParam Type String key specifying the event to extract
|
1973
2006
|
*/
|
1974
|
-
declare type ByType_3<Type extends
|
2007
|
+
declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
1975
2008
|
|
1976
2009
|
/**
|
1977
|
-
* Extracts a single event type matching the given key from the {@link
|
2010
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
1978
2011
|
*
|
1979
2012
|
* Alias for {@link Payload}, which may read better in source.
|
1980
2013
|
*
|
1981
2014
|
* @typeParam Type String key specifying the event to extract
|
1982
2015
|
*/
|
1983
|
-
declare type ByType_4<Type extends
|
2016
|
+
declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
1984
2017
|
|
1985
2018
|
/**
|
1986
|
-
* Extracts a single event type matching the given key from the {@link
|
2019
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
1987
2020
|
*
|
1988
2021
|
* Alias for {@link Payload}, which may read better in source.
|
1989
2022
|
*
|
1990
2023
|
* @typeParam Type String key specifying the event to extract
|
1991
2024
|
*/
|
1992
|
-
declare type ByType_5<Type extends
|
2025
|
+
declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
1993
2026
|
|
1994
2027
|
/**
|
1995
|
-
* Extracts a single event type matching the given key from the {@link
|
2028
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
1996
2029
|
*
|
1997
2030
|
* Alias for {@link Payload}, which may read better in source.
|
1998
2031
|
*
|
1999
2032
|
* @typeParam Type String key specifying the event to extract
|
2000
2033
|
*/
|
2001
|
-
declare type ByType_6<Type extends
|
2034
|
+
declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
2002
2035
|
|
2003
2036
|
/**
|
2004
|
-
* Extracts a single event type matching the given key from the {@link
|
2037
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
2005
2038
|
*
|
2006
2039
|
* Alias for {@link Payload}, which may read better in source.
|
2007
2040
|
*
|
2008
2041
|
* @typeParam Type String key specifying the event to extract
|
2009
2042
|
*/
|
2010
|
-
declare type ByType_7<Type extends
|
2043
|
+
declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
2011
2044
|
|
2012
2045
|
/**
|
2013
|
-
* Extracts a single event type matching the given key from the {@link
|
2046
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
2014
2047
|
*
|
2015
2048
|
* Alias for {@link Payload}, which may read better in source.
|
2016
2049
|
*
|
2017
2050
|
* @typeParam Type String key specifying the event to extract
|
2018
2051
|
*/
|
2019
|
-
declare type ByType_8<Type extends
|
2052
|
+
declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
2020
2053
|
|
2021
2054
|
/**
|
2022
2055
|
* Configuration for page capture.
|
@@ -2682,14 +2715,6 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
|
|
2682
2715
|
|
2683
2716
|
declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
|
2684
2717
|
|
2685
|
-
/**
|
2686
|
-
* Generated when a Channel client is connected.
|
2687
|
-
* @interface
|
2688
|
-
*/
|
2689
|
-
declare type ChannelConnectedEvent = BaseChannelEvent & {
|
2690
|
-
type: 'connected';
|
2691
|
-
};
|
2692
|
-
|
2693
2718
|
/**
|
2694
2719
|
* Options provided on a client connection to a channel.
|
2695
2720
|
*
|
@@ -2721,21 +2746,9 @@ declare type ChannelCreateOptions = {
|
|
2721
2746
|
};
|
2722
2747
|
|
2723
2748
|
/**
|
2724
|
-
*
|
2725
|
-
* @interface
|
2749
|
+
* @deprecated Renamed to {@link Event}.
|
2726
2750
|
*/
|
2727
|
-
declare type
|
2728
|
-
type: 'disconnected';
|
2729
|
-
};
|
2730
|
-
|
2731
|
-
/**
|
2732
|
-
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
|
2733
|
-
* discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
|
2734
|
-
* under the {@link OpenFin.ChannelEvents} namespace.
|
2735
|
-
*/
|
2736
|
-
declare type ChannelEvent = {
|
2737
|
-
topic: 'channel';
|
2738
|
-
} & (ChannelConnectedEvent | ChannelDisconnectedEvent);
|
2751
|
+
declare type ChannelEvent = Event_2;
|
2739
2752
|
|
2740
2753
|
declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
|
2741
2754
|
|
@@ -3270,11 +3283,19 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
|
|
3270
3283
|
* Generated when an application is closed.
|
3271
3284
|
* @interface
|
3272
3285
|
*/
|
3273
|
-
declare type ClosedEvent = IdentityEvent & {
|
3286
|
+
declare type ClosedEvent = BaseEvents.IdentityEvent & {
|
3274
3287
|
topic: 'application';
|
3275
3288
|
type: 'closed';
|
3276
3289
|
};
|
3277
3290
|
|
3291
|
+
/**
|
3292
|
+
* Generated when a window has closed.
|
3293
|
+
* @interface
|
3294
|
+
*/
|
3295
|
+
declare type ClosedEvent_2 = BaseEvent_5 & {
|
3296
|
+
type: 'closed';
|
3297
|
+
};
|
3298
|
+
|
3278
3299
|
/**
|
3279
3300
|
* @interface
|
3280
3301
|
*/
|
@@ -3282,6 +3303,15 @@ declare type ClosedMenuResult = {
|
|
3282
3303
|
result: 'closed';
|
3283
3304
|
};
|
3284
3305
|
|
3306
|
+
/**
|
3307
|
+
* Generated when a window has been prevented from closing.
|
3308
|
+
* @remarks A window will be prevented from closing by default, either through the API or by a user when ‘close-requested’ has been subscribed to and the Window.close(force) flag is false.
|
3309
|
+
* @interface
|
3310
|
+
*/
|
3311
|
+
declare type CloseRequestedEvent = BaseEvent_5 & {
|
3312
|
+
type: 'close-requested';
|
3313
|
+
};
|
3314
|
+
|
3285
3315
|
/**
|
3286
3316
|
* @interface
|
3287
3317
|
*/
|
@@ -3328,6 +3358,14 @@ declare interface CloseWindowPayload {
|
|
3328
3358
|
};
|
3329
3359
|
}
|
3330
3360
|
|
3361
|
+
/**
|
3362
|
+
* Generated when a window has initiated the closing routine.
|
3363
|
+
* @interface
|
3364
|
+
*/
|
3365
|
+
declare type ClosingEvent = BaseEvent_5 & {
|
3366
|
+
type: 'closing';
|
3367
|
+
};
|
3368
|
+
|
3331
3369
|
/**
|
3332
3370
|
* A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
|
3333
3371
|
*/
|
@@ -3411,6 +3449,39 @@ export declare function connect(config: ConnectConfig): Promise<Fin<'external co
|
|
3411
3449
|
|
3412
3450
|
declare type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
|
3413
3451
|
|
3452
|
+
/**
|
3453
|
+
* Generated when a Channel client is connected.
|
3454
|
+
* @interface
|
3455
|
+
*/
|
3456
|
+
declare type ConnectedEvent = BaseEvent_2 & {
|
3457
|
+
type: 'connected';
|
3458
|
+
};
|
3459
|
+
|
3460
|
+
/**
|
3461
|
+
* Generated when an application has authenticated and is connected.
|
3462
|
+
* @interface
|
3463
|
+
*/
|
3464
|
+
declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
|
3465
|
+
topic: 'application';
|
3466
|
+
type: 'connected';
|
3467
|
+
};
|
3468
|
+
|
3469
|
+
/**
|
3470
|
+
* Generated when an external application has authenticated and is connected.
|
3471
|
+
* @interface
|
3472
|
+
*/
|
3473
|
+
declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
|
3474
|
+
type: 'connected';
|
3475
|
+
};
|
3476
|
+
|
3477
|
+
/**
|
3478
|
+
* Generated when a frame is connected.
|
3479
|
+
* @interface
|
3480
|
+
*/
|
3481
|
+
declare type ConnectedEvent_4 = BaseFrameEvent & {
|
3482
|
+
type: 'connected';
|
3483
|
+
};
|
3484
|
+
|
3414
3485
|
declare type Constructor<T = {}> = new () => T;
|
3415
3486
|
|
3416
3487
|
declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
@@ -4152,7 +4223,7 @@ declare type Context_3 = {
|
|
4152
4223
|
* Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
|
4153
4224
|
* @interface
|
4154
4225
|
*/
|
4155
|
-
declare type ContextChangedEvent =
|
4226
|
+
declare type ContextChangedEvent = BaseEvent_5 & {
|
4156
4227
|
type: 'context-changed';
|
4157
4228
|
context: any;
|
4158
4229
|
};
|
@@ -4304,7 +4375,7 @@ declare type CpuInfo = {
|
|
4304
4375
|
* Generated when an application has crashed.
|
4305
4376
|
* @interface
|
4306
4377
|
*/
|
4307
|
-
declare type CrashedEvent = IdentityEvent & {
|
4378
|
+
declare type CrashedEvent = BaseEvents.IdentityEvent & {
|
4308
4379
|
topic: 'application';
|
4309
4380
|
type: 'crashed';
|
4310
4381
|
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
@@ -4355,7 +4426,7 @@ declare type CrashReporterState = CrashReporterOptions & {
|
|
4355
4426
|
* Generated when a View is created.
|
4356
4427
|
* @interface
|
4357
4428
|
*/
|
4358
|
-
declare type CreatedEvent =
|
4429
|
+
declare type CreatedEvent = BaseEvent_4 & {
|
4359
4430
|
type: 'created';
|
4360
4431
|
};
|
4361
4432
|
|
@@ -4514,7 +4585,7 @@ declare interface DesktopAgent_2 {
|
|
4514
4585
|
* Generated when the desktop icon is clicked while it's already running.
|
4515
4586
|
* @interface
|
4516
4587
|
*/
|
4517
|
-
declare type DesktopIconClickedEvent =
|
4588
|
+
declare type DesktopIconClickedEvent = BaseEvent_8 & {
|
4518
4589
|
type: 'desktop-icon-clicked';
|
4519
4590
|
};
|
4520
4591
|
|
@@ -4522,7 +4593,7 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
|
|
4522
4593
|
* Generated when a View is destroyed.
|
4523
4594
|
* @interface
|
4524
4595
|
*/
|
4525
|
-
declare type DestroyedEvent =
|
4596
|
+
declare type DestroyedEvent = BaseEvent_4 & {
|
4526
4597
|
type: 'destroyed';
|
4527
4598
|
};
|
4528
4599
|
|
@@ -4622,6 +4693,30 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
4622
4693
|
type: 'disabled-movement-bounds-changing';
|
4623
4694
|
};
|
4624
4695
|
|
4696
|
+
/**
|
4697
|
+
* Generated when a Channel client has disconnected.
|
4698
|
+
* @interface
|
4699
|
+
*/
|
4700
|
+
declare type DisconnectedEvent = BaseEvent_2 & {
|
4701
|
+
type: 'disconnected';
|
4702
|
+
};
|
4703
|
+
|
4704
|
+
/**
|
4705
|
+
* Generated when an external application has disconnected.
|
4706
|
+
* @interface
|
4707
|
+
*/
|
4708
|
+
declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
|
4709
|
+
type: 'disconnected';
|
4710
|
+
};
|
4711
|
+
|
4712
|
+
/**
|
4713
|
+
* Generated when a frame has disconnected.
|
4714
|
+
* @interface
|
4715
|
+
*/
|
4716
|
+
declare type DisconnectedEvent_3 = BaseFrameEvent & {
|
4717
|
+
type: 'disconnected';
|
4718
|
+
};
|
4719
|
+
|
4625
4720
|
/**
|
4626
4721
|
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
4627
4722
|
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
@@ -4755,7 +4850,7 @@ declare type DownloadShelfOptions = {
|
|
4755
4850
|
*
|
4756
4851
|
* @interface
|
4757
4852
|
*/
|
4758
|
-
declare type DownloadShelfVisibilityChangedEvent =
|
4853
|
+
declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
|
4759
4854
|
type: 'download-shelf-visibility-changed';
|
4760
4855
|
/**
|
4761
4856
|
* True if the download shelf was just opened; false if it was just closed.
|
@@ -4785,7 +4880,7 @@ declare interface DragSource {}
|
|
4785
4880
|
* Generated when a window has been embedded.
|
4786
4881
|
* @interface
|
4787
4882
|
*/
|
4788
|
-
declare type EmbeddedEvent =
|
4883
|
+
declare type EmbeddedEvent = BaseEvent_5 & {
|
4789
4884
|
type: 'embedded';
|
4790
4885
|
};
|
4791
4886
|
|
@@ -4884,7 +4979,7 @@ declare class EmitterMap {
|
|
4884
4979
|
* Generated when a window ends loading.
|
4885
4980
|
* @interface
|
4886
4981
|
*/
|
4887
|
-
declare type EndLoadEvent =
|
4982
|
+
declare type EndLoadEvent = BaseEvent_5 & {
|
4888
4983
|
type: 'end-load';
|
4889
4984
|
documentName: string;
|
4890
4985
|
isMain: boolean;
|
@@ -5001,6 +5096,88 @@ declare type ErrorPlainObject = {
|
|
5001
5096
|
toString(): string;
|
5002
5097
|
};
|
5003
5098
|
|
5099
|
+
/**
|
5100
|
+
* [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
|
5101
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
|
5102
|
+
* under the {@link OpenFin.PlatformEvents} namespace.
|
5103
|
+
*/
|
5104
|
+
declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
|
5105
|
+
|
5106
|
+
/**
|
5107
|
+
* [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
|
5108
|
+
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
5109
|
+
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5110
|
+
* from which they propagate).
|
5111
|
+
*/
|
5112
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
5113
|
+
|
5114
|
+
/**
|
5115
|
+
* [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
|
5116
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
|
5117
|
+
* under the {@link OpenFin.ChannelEvents} namespace.
|
5118
|
+
*/
|
5119
|
+
declare type Event_2 = {
|
5120
|
+
topic: 'channel';
|
5121
|
+
} & (ConnectedEvent | DisconnectedEvent);
|
5122
|
+
|
5123
|
+
/**
|
5124
|
+
* [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
|
5125
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
|
5126
|
+
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5127
|
+
* from which they propagate).
|
5128
|
+
*/
|
5129
|
+
declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
|
5130
|
+
|
5131
|
+
/**
|
5132
|
+
* [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
|
5133
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
|
5134
|
+
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5135
|
+
*/
|
5136
|
+
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
5137
|
+
target: OpenFin.Identity;
|
5138
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
5139
|
+
|
5140
|
+
/**
|
5141
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
5142
|
+
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
5143
|
+
*/
|
5144
|
+
declare type Event_5<Topic extends string> = {
|
5145
|
+
topic: Topic;
|
5146
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
5147
|
+
|
5148
|
+
/**
|
5149
|
+
* [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
|
5150
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
|
5151
|
+
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5152
|
+
*/
|
5153
|
+
declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
|
5154
|
+
|
5155
|
+
/**
|
5156
|
+
* [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
|
5157
|
+
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5158
|
+
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5159
|
+
*/
|
5160
|
+
declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
|
5161
|
+
|
5162
|
+
/**
|
5163
|
+
* [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
|
5164
|
+
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
5165
|
+
* under the {@link OpenFin.FrameEvents} namespace.
|
5166
|
+
*/
|
5167
|
+
declare type Event_8 = {
|
5168
|
+
topic: 'frame';
|
5169
|
+
} & (ConnectedEvent_4 | DisconnectedEvent_3);
|
5170
|
+
|
5171
|
+
/**
|
5172
|
+
* [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
|
5173
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
5174
|
+
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
5175
|
+
*/
|
5176
|
+
declare type Event_9 = {
|
5177
|
+
topic: 'global-hotkey';
|
5178
|
+
hotkey: 'string';
|
5179
|
+
} & (RegisteredEvent | UnregisteredEvent);
|
5180
|
+
|
5004
5181
|
declare class EventAggregator extends EmitterMap {
|
5005
5182
|
dispatchEvent: (message: Message<any>) => boolean;
|
5006
5183
|
}
|
@@ -5066,6 +5243,46 @@ declare namespace Events {
|
|
5066
5243
|
}
|
5067
5244
|
}
|
5068
5245
|
|
5246
|
+
/**
|
5247
|
+
* Union of possible `type` values for a view {@link Event}.
|
5248
|
+
*/
|
5249
|
+
declare type EventType = Event_4['type'];
|
5250
|
+
|
5251
|
+
/**
|
5252
|
+
* Union of possible `type` values for a Window {@link Event}.
|
5253
|
+
*/
|
5254
|
+
declare type EventType_2 = Event_6['type'];
|
5255
|
+
|
5256
|
+
/**
|
5257
|
+
* Union of possible `type` values for an Application {@link Event}.
|
5258
|
+
*/
|
5259
|
+
declare type EventType_3 = Event_3['type'];
|
5260
|
+
|
5261
|
+
/**
|
5262
|
+
* Union of possible `type` values for an ExternalApplication {@link Event}.
|
5263
|
+
*/
|
5264
|
+
declare type EventType_4 = Event_7['type'];
|
5265
|
+
|
5266
|
+
/**
|
5267
|
+
* Union of possible `type` values for a {@link FrameEvent}.
|
5268
|
+
*/
|
5269
|
+
declare type EventType_5 = Event_8['type'];
|
5270
|
+
|
5271
|
+
/**
|
5272
|
+
* Union of possible `type` values for a {@link GlobalHotkeyEvent}
|
5273
|
+
*/
|
5274
|
+
declare type EventType_6 = Event_9['type'];
|
5275
|
+
|
5276
|
+
/**
|
5277
|
+
* Union of possible `type` values for a {@link PlatformEvent}.
|
5278
|
+
*/
|
5279
|
+
declare type EventType_7 = Event_10['type'];
|
5280
|
+
|
5281
|
+
/**
|
5282
|
+
* Union of possible `type` values for a {@link SystemEvent}.
|
5283
|
+
*/
|
5284
|
+
declare type EventType_8 = SystemEvent['type'];
|
5285
|
+
|
5069
5286
|
/* Excluded from this release type: EventWithId */
|
5070
5287
|
|
5071
5288
|
/* Excluded from this release type: ExcludeRequested */
|
@@ -5189,46 +5406,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
|
|
5189
5406
|
}
|
5190
5407
|
|
5191
5408
|
/**
|
5192
|
-
*
|
5193
|
-
* @interface
|
5409
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
5194
5410
|
*/
|
5195
|
-
declare type ExternalApplicationConnectedEvent =
|
5196
|
-
type: 'connected';
|
5197
|
-
};
|
5411
|
+
declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
|
5198
5412
|
|
5199
5413
|
/**
|
5200
|
-
*
|
5201
|
-
* @interface
|
5414
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
5202
5415
|
*/
|
5203
|
-
declare type ExternalApplicationDisconnectedEvent =
|
5204
|
-
type: 'disconnected';
|
5205
|
-
};
|
5416
|
+
declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
|
5206
5417
|
|
5207
5418
|
/**
|
5208
|
-
*
|
5209
|
-
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5210
|
-
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5419
|
+
* @deprecated Renamed to {@link Event}.
|
5211
5420
|
*/
|
5212
|
-
declare type ExternalApplicationEvent =
|
5421
|
+
declare type ExternalApplicationEvent = Event_7;
|
5213
5422
|
|
5214
5423
|
declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
|
5215
5424
|
|
5216
5425
|
declare namespace ExternalApplicationEvents {
|
5217
5426
|
export {
|
5427
|
+
BaseEvent_6 as BaseEvent,
|
5218
5428
|
BaseExternalApplicationEvent,
|
5429
|
+
ConnectedEvent_3 as ConnectedEvent,
|
5219
5430
|
ExternalApplicationConnectedEvent,
|
5431
|
+
DisconnectedEvent_2 as DisconnectedEvent,
|
5220
5432
|
ExternalApplicationDisconnectedEvent,
|
5433
|
+
Event_7 as Event,
|
5221
5434
|
ExternalApplicationEvent,
|
5435
|
+
EventType_4 as EventType,
|
5222
5436
|
ExternalApplicationEventType,
|
5223
|
-
|
5224
|
-
|
5437
|
+
Payload_5 as Payload,
|
5438
|
+
ByType_4 as ByType
|
5225
5439
|
}
|
5226
5440
|
}
|
5227
5441
|
|
5228
5442
|
/**
|
5229
|
-
*
|
5443
|
+
* @deprecated Renamed to {@link Event}.
|
5230
5444
|
*/
|
5231
|
-
declare type ExternalApplicationEventType =
|
5445
|
+
declare type ExternalApplicationEventType = EventType_4;
|
5232
5446
|
|
5233
5447
|
/**
|
5234
5448
|
* @interface
|
@@ -5293,7 +5507,7 @@ declare type ExternalConnection = {
|
|
5293
5507
|
* Generated when an external process has exited.
|
5294
5508
|
* @interface
|
5295
5509
|
*/
|
5296
|
-
declare type ExternalProcessExitedEvent =
|
5510
|
+
declare type ExternalProcessExitedEvent = BaseEvent_5 & {
|
5297
5511
|
type: 'external-process-exited';
|
5298
5512
|
processUuid: string;
|
5299
5513
|
exitCode: number;
|
@@ -5338,19 +5552,15 @@ declare type ExternalProcessRequestType = {
|
|
5338
5552
|
* Generated when an external process has started.
|
5339
5553
|
* @interface
|
5340
5554
|
*/
|
5341
|
-
declare type ExternalProcessStartedEvent =
|
5555
|
+
declare type ExternalProcessStartedEvent = BaseEvent_5 & {
|
5342
5556
|
type: 'external-process-started';
|
5343
5557
|
processUuid: string;
|
5344
5558
|
};
|
5345
5559
|
|
5346
5560
|
/**
|
5347
|
-
*
|
5348
|
-
* @interface
|
5561
|
+
* @deprecated, use {@link PageFaviconUpdatedEvent}.
|
5349
5562
|
*/
|
5350
|
-
declare type FaviconUpdatedEvent =
|
5351
|
-
type: 'page-favicon-updated';
|
5352
|
-
favicons: string[];
|
5353
|
-
};
|
5563
|
+
declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
|
5354
5564
|
|
5355
5565
|
declare namespace FDC3 {
|
5356
5566
|
export {
|
@@ -5437,7 +5647,7 @@ declare type FileDownloadEvent = {
|
|
5437
5647
|
*
|
5438
5648
|
* @interface
|
5439
5649
|
*/
|
5440
|
-
declare type FileDownloadLocationChangedEvent =
|
5650
|
+
declare type FileDownloadLocationChangedEvent = BaseEvent_3 & {
|
5441
5651
|
type: 'file-download-location-changed';
|
5442
5652
|
};
|
5443
5653
|
|
@@ -5706,48 +5916,43 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
5706
5916
|
}
|
5707
5917
|
|
5708
5918
|
/**
|
5709
|
-
*
|
5710
|
-
* @interface
|
5919
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
5711
5920
|
*/
|
5712
|
-
declare type FrameConnectedEvent =
|
5713
|
-
type: 'connected';
|
5714
|
-
};
|
5921
|
+
declare type FrameConnectedEvent = ConnectedEvent_4;
|
5715
5922
|
|
5716
5923
|
/**
|
5717
|
-
*
|
5718
|
-
* @interface
|
5924
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
5719
5925
|
*/
|
5720
|
-
declare type FrameDisconnectedEvent =
|
5721
|
-
type: 'disconnected';
|
5722
|
-
};
|
5926
|
+
declare type FrameDisconnectedEvent = DisconnectedEvent_3;
|
5723
5927
|
|
5724
5928
|
/**
|
5725
|
-
*
|
5726
|
-
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
5727
|
-
* under the {@link OpenFin.FrameEvents} namespace.
|
5929
|
+
* @deprecated Renamed to {@link Event}.
|
5728
5930
|
*/
|
5729
|
-
declare type FrameEvent =
|
5730
|
-
topic: 'frame';
|
5731
|
-
} & (FrameConnectedEvent | FrameDisconnectedEvent);
|
5931
|
+
declare type FrameEvent = Event_8;
|
5732
5932
|
|
5733
5933
|
declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
|
5734
5934
|
|
5735
5935
|
declare namespace FrameEvents {
|
5736
5936
|
export {
|
5937
|
+
BaseEvent_7 as BaseEvent,
|
5737
5938
|
BaseFrameEvent,
|
5939
|
+
ConnectedEvent_4 as ConnectedEvent,
|
5738
5940
|
FrameConnectedEvent,
|
5941
|
+
DisconnectedEvent_3 as DisconnectedEvent,
|
5739
5942
|
FrameDisconnectedEvent,
|
5943
|
+
Event_8 as Event,
|
5740
5944
|
FrameEvent,
|
5945
|
+
EventType_5 as EventType,
|
5741
5946
|
FrameEventType,
|
5742
|
-
|
5743
|
-
|
5947
|
+
Payload_6 as Payload,
|
5948
|
+
ByType_5 as ByType
|
5744
5949
|
}
|
5745
5950
|
}
|
5746
5951
|
|
5747
5952
|
/**
|
5748
|
-
*
|
5953
|
+
* @deprecated Renamed to {@link EventType}.
|
5749
5954
|
*/
|
5750
|
-
declare type FrameEventType =
|
5955
|
+
declare type FrameEventType = EventType_5;
|
5751
5956
|
|
5752
5957
|
/**
|
5753
5958
|
* @interface
|
@@ -5966,14 +6171,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
|
|
5966
6171
|
}
|
5967
6172
|
|
5968
6173
|
/**
|
5969
|
-
*
|
5970
|
-
* discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
5971
|
-
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
6174
|
+
* @deprecated Renamed to {@link Event}.
|
5972
6175
|
*/
|
5973
|
-
declare type GlobalHotkeyEvent =
|
5974
|
-
topic: 'global-hotkey';
|
5975
|
-
hotkey: 'string';
|
5976
|
-
} & (RegisteredEvent | UnregisteredEvent);
|
6176
|
+
declare type GlobalHotkeyEvent = Event_9;
|
5977
6177
|
|
5978
6178
|
declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
5979
6179
|
|
@@ -5981,17 +6181,19 @@ declare namespace GlobalHotkeyEvents {
|
|
5981
6181
|
export {
|
5982
6182
|
RegisteredEvent,
|
5983
6183
|
UnregisteredEvent,
|
6184
|
+
Event_9 as Event,
|
5984
6185
|
GlobalHotkeyEvent,
|
6186
|
+
EventType_6 as EventType,
|
5985
6187
|
GlobalHotkeyEventType,
|
5986
|
-
|
5987
|
-
|
6188
|
+
Payload_7 as Payload,
|
6189
|
+
ByType_6 as ByType
|
5988
6190
|
}
|
5989
6191
|
}
|
5990
6192
|
|
5991
6193
|
/**
|
5992
|
-
*
|
6194
|
+
* @deprecated Renamed to {@link EventType}.
|
5993
6195
|
*/
|
5994
|
-
declare type GlobalHotkeyEventType =
|
6196
|
+
declare type GlobalHotkeyEventType = EventType_6;
|
5995
6197
|
|
5996
6198
|
declare namespace GoldenLayout {
|
5997
6199
|
export {
|
@@ -6293,8 +6495,17 @@ declare interface Header {
|
|
6293
6495
|
* Generated when a View is hidden.
|
6294
6496
|
* @interface
|
6295
6497
|
*/
|
6296
|
-
declare type HiddenEvent =
|
6498
|
+
declare type HiddenEvent = BaseEvent_4 & {
|
6499
|
+
type: 'hidden';
|
6500
|
+
};
|
6501
|
+
|
6502
|
+
/**
|
6503
|
+
* Generated when a window has been hidden.
|
6504
|
+
* @interface
|
6505
|
+
*/
|
6506
|
+
declare type HiddenEvent_2 = BaseEvent_5 & {
|
6297
6507
|
type: 'hidden';
|
6508
|
+
reason: 'closing' | 'hide' | 'hide-on-close';
|
6298
6509
|
};
|
6299
6510
|
|
6300
6511
|
/**
|
@@ -6302,7 +6513,7 @@ declare type HiddenEvent = BaseViewEvent & {
|
|
6302
6513
|
* or because the View has moved to a new window. Only available on Views in a Platform.
|
6303
6514
|
* @interface
|
6304
6515
|
*/
|
6305
|
-
declare type HostContextChangedEvent =
|
6516
|
+
declare type HostContextChangedEvent = BaseEvent_4 & {
|
6306
6517
|
type: 'host-context-changed';
|
6307
6518
|
context: any;
|
6308
6519
|
reason: 'reparented' | 'updated';
|
@@ -6381,7 +6592,16 @@ declare type Hotkey = {
|
|
6381
6592
|
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
6382
6593
|
* @interface
|
6383
6594
|
*/
|
6384
|
-
declare type HotkeyEvent =
|
6595
|
+
declare type HotkeyEvent = BaseEvent_4 & {
|
6596
|
+
type: 'hotkey';
|
6597
|
+
};
|
6598
|
+
|
6599
|
+
/**
|
6600
|
+
* Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
|
6601
|
+
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
6602
|
+
* @interface
|
6603
|
+
*/
|
6604
|
+
declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
|
6385
6605
|
type: 'hotkey';
|
6386
6606
|
};
|
6387
6607
|
|
@@ -6434,6 +6654,11 @@ declare type IdentityEvent = BaseEvent & {
|
|
6434
6654
|
|
6435
6655
|
/* Excluded from this release type: IdEventType */
|
6436
6656
|
|
6657
|
+
/**
|
6658
|
+
* @deprecated Renamed to {@link IdleStateChangedEvent}.
|
6659
|
+
*/
|
6660
|
+
declare type IdleEvent = IdleStateChangedEvent;
|
6661
|
+
|
6437
6662
|
/**
|
6438
6663
|
* Generated when a user enters or returns from idle state.
|
6439
6664
|
* @remarks This method is continuously generated every minute while the user is in idle.
|
@@ -6441,7 +6666,7 @@ declare type IdentityEvent = BaseEvent & {
|
|
6441
6666
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
6442
6667
|
* @interface
|
6443
6668
|
*/
|
6444
|
-
declare type
|
6669
|
+
declare type IdleStateChangedEvent = BaseEvent_8 & {
|
6445
6670
|
type: 'idle-state-changed';
|
6446
6671
|
elapsedTime: number;
|
6447
6672
|
isIdle: boolean;
|
@@ -6526,11 +6751,19 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
6526
6751
|
* Generated when an application has initialized.
|
6527
6752
|
* @interface
|
6528
6753
|
*/
|
6529
|
-
declare type InitializedEvent = IdentityEvent & {
|
6754
|
+
declare type InitializedEvent = BaseEvents.IdentityEvent & {
|
6530
6755
|
topic: 'application';
|
6531
6756
|
type: 'initialized';
|
6532
6757
|
};
|
6533
6758
|
|
6759
|
+
/**
|
6760
|
+
* Generated when a window is initialized.
|
6761
|
+
* @interface
|
6762
|
+
*/
|
6763
|
+
declare type InitializedEvent_2 = BaseEvent_5 & {
|
6764
|
+
type: 'initialized';
|
6765
|
+
};
|
6766
|
+
|
6534
6767
|
/**
|
6535
6768
|
* @interface
|
6536
6769
|
*/
|
@@ -8610,7 +8843,7 @@ declare type LayoutIdentity = Identity_5 & {
|
|
8610
8843
|
* Generated when a window and all of its layout's views have either finished or failed navigation.
|
8611
8844
|
* @interface
|
8612
8845
|
*/
|
8613
|
-
declare type LayoutInitializedEvent =
|
8846
|
+
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
8614
8847
|
type: 'layout-initialized';
|
8615
8848
|
ofViews: (OpenFin.Identity & {
|
8616
8849
|
entityType: 'view';
|
@@ -8970,7 +9203,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
8970
9203
|
* Generated when a window and all of its layout's views have been created and can receive API calls.
|
8971
9204
|
* @interface
|
8972
9205
|
*/
|
8973
|
-
declare type LayoutReadyEvent =
|
9206
|
+
declare type LayoutReadyEvent = BaseEvent_5 & {
|
8974
9207
|
type: 'layout-ready';
|
8975
9208
|
views: (OpenFin.Identity & {
|
8976
9209
|
success: boolean;
|
@@ -9111,7 +9344,7 @@ declare type Manifest = {
|
|
9111
9344
|
* Generated when the RVM notifies an application that the manifest has changed.
|
9112
9345
|
* @interface
|
9113
9346
|
*/
|
9114
|
-
declare type ManifestChangedEvent = IdentityEvent & {
|
9347
|
+
declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
|
9115
9348
|
topic: 'application';
|
9116
9349
|
type: 'manifest-changed';
|
9117
9350
|
};
|
@@ -9164,7 +9397,7 @@ declare type MatchPattern = string;
|
|
9164
9397
|
* Generated when a window is maximized.
|
9165
9398
|
* @interface
|
9166
9399
|
*/
|
9167
|
-
declare type MaximizedEvent =
|
9400
|
+
declare type MaximizedEvent = BaseEvent_5 & {
|
9168
9401
|
type: 'maximized';
|
9169
9402
|
};
|
9170
9403
|
|
@@ -9274,7 +9507,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
|
|
9274
9507
|
* Generated when a window is minimized.
|
9275
9508
|
* @interface
|
9276
9509
|
*/
|
9277
|
-
declare type MinimizedEvent =
|
9510
|
+
declare type MinimizedEvent = BaseEvent_5 & {
|
9278
9511
|
type: 'minimized';
|
9279
9512
|
};
|
9280
9513
|
|
@@ -9318,14 +9551,9 @@ declare type MonitorDetails = {
|
|
9318
9551
|
};
|
9319
9552
|
|
9320
9553
|
/**
|
9321
|
-
*
|
9322
|
-
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
9323
|
-
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
9324
|
-
* @interface
|
9554
|
+
* @deprecated Renamed to {@link MonitorInfoChangedEvent}.
|
9325
9555
|
*/
|
9326
|
-
declare type MonitorEvent =
|
9327
|
-
type: 'monitor-info-changed';
|
9328
|
-
};
|
9556
|
+
declare type MonitorEvent = MonitorInfoChangedEvent;
|
9329
9557
|
|
9330
9558
|
/**
|
9331
9559
|
* @interface
|
@@ -9349,6 +9577,16 @@ declare type MonitorInfo = {
|
|
9349
9577
|
virtualScreen: DipRect;
|
9350
9578
|
};
|
9351
9579
|
|
9580
|
+
/**
|
9581
|
+
* Generated on changes of a monitor's size/location.
|
9582
|
+
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
9583
|
+
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
9584
|
+
* @interface
|
9585
|
+
*/
|
9586
|
+
declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
|
9587
|
+
type: 'monitor-info-changed';
|
9588
|
+
};
|
9589
|
+
|
9352
9590
|
/**
|
9353
9591
|
* @interface
|
9354
9592
|
*/
|
@@ -9745,13 +9983,15 @@ declare type NonPropagatedWebContentsEvent = never;
|
|
9745
9983
|
*/
|
9746
9984
|
declare type NonPropagatedWindowEvent = never;
|
9747
9985
|
|
9986
|
+
/* Excluded from this release type: NotCloseRequested */
|
9987
|
+
|
9748
9988
|
/* Excluded from this release type: NotRequested */
|
9749
9989
|
|
9750
9990
|
/**
|
9751
9991
|
* Generated when an application is not responding.
|
9752
9992
|
* @interface
|
9753
9993
|
*/
|
9754
|
-
declare type NotRespondingEvent = IdentityEvent & {
|
9994
|
+
declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
|
9755
9995
|
topic: 'application';
|
9756
9996
|
type: 'not-responding';
|
9757
9997
|
};
|
@@ -10077,7 +10317,7 @@ declare namespace OpenFin {
|
|
10077
10317
|
AppVersionCompleteEvent,
|
10078
10318
|
AppVersionRuntimeStatusEvent,
|
10079
10319
|
Events,
|
10080
|
-
|
10320
|
+
BaseEvent_9 as BaseEvent,
|
10081
10321
|
WebContentsEvent_2 as WebContentsEvent,
|
10082
10322
|
SystemEvent_2 as SystemEvent,
|
10083
10323
|
ApplicationEvent_2 as ApplicationEvent,
|
@@ -10119,12 +10359,32 @@ export default OpenFin;
|
|
10119
10359
|
|
10120
10360
|
declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
|
10121
10361
|
|
10362
|
+
/**
|
10363
|
+
* Generated after window options are changed using the window.updateOptions method.
|
10364
|
+
* @remarks Will not fire if the diff object is empty.
|
10365
|
+
* @interface
|
10366
|
+
*/
|
10367
|
+
declare type OptionsChangedEvent = BaseEvent_5 & {
|
10368
|
+
type: 'options-changed';
|
10369
|
+
options: OpenFin.WindowOptions;
|
10370
|
+
diff: OpenFin.WindowOptionDiff;
|
10371
|
+
};
|
10372
|
+
|
10122
10373
|
declare type OverlapsOnlyIfMatching<T, U> = {
|
10123
10374
|
[K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
|
10124
10375
|
};
|
10125
10376
|
|
10126
10377
|
declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
10127
10378
|
|
10379
|
+
/**
|
10380
|
+
* Generated when page receives favicon urls.
|
10381
|
+
* @interface
|
10382
|
+
*/
|
10383
|
+
declare type PageFaviconUpdatedEvent = NamedEvent & {
|
10384
|
+
type: 'page-favicon-updated';
|
10385
|
+
favicons: string[];
|
10386
|
+
};
|
10387
|
+
|
10128
10388
|
/**
|
10129
10389
|
* Generated when page title is set during navigation.
|
10130
10390
|
* @remarks explicitSet is false when title is synthesized from file url.
|
@@ -10143,74 +10403,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10143
10403
|
};
|
10144
10404
|
|
10145
10405
|
/**
|
10146
|
-
* Extracts a single event type matching the given key from the {@link
|
10406
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
10147
10407
|
*
|
10148
10408
|
* @typeParam Type String key specifying the event to extract
|
10149
10409
|
*/
|
10150
|
-
declare type Payload_2<Type extends
|
10410
|
+
declare type Payload_2<Type extends EventType> = Extract<Event_4, {
|
10151
10411
|
type: Type;
|
10152
10412
|
}>;
|
10153
10413
|
|
10154
10414
|
/**
|
10155
|
-
* Extracts a single event type matching the given key from the {@link
|
10415
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
10156
10416
|
*
|
10157
10417
|
* @typeParam Type String key specifying the event to extract
|
10158
10418
|
*/
|
10159
|
-
declare type Payload_3<Type extends
|
10419
|
+
declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
|
10160
10420
|
type: Type;
|
10161
10421
|
}>;
|
10162
10422
|
|
10163
10423
|
/**
|
10164
|
-
* Extracts a single event type matching the given key from the {@link
|
10424
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
10165
10425
|
*
|
10166
10426
|
* @typeParam Type String key specifying the event to extract
|
10167
10427
|
*/
|
10168
|
-
declare type Payload_4<Type extends
|
10428
|
+
declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
|
10169
10429
|
type: Type;
|
10170
10430
|
}>;
|
10171
10431
|
|
10172
10432
|
/**
|
10173
|
-
* Extracts a single event type matching the given key from the {@link
|
10433
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
10174
10434
|
*
|
10175
10435
|
* @typeParam Type String key specifying the event to extract
|
10176
10436
|
*/
|
10177
|
-
declare type Payload_5<Type extends
|
10437
|
+
declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
|
10178
10438
|
type: Type;
|
10179
10439
|
}>;
|
10180
10440
|
|
10181
10441
|
/**
|
10182
|
-
* Extracts a single event type matching the given key from the {@link
|
10442
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
10183
10443
|
*
|
10184
10444
|
* @typeParam Type String key specifying the event to extract
|
10185
10445
|
*/
|
10186
|
-
declare type Payload_6<Type extends
|
10446
|
+
declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
|
10187
10447
|
type: Type;
|
10188
10448
|
}>;
|
10189
10449
|
|
10190
10450
|
/**
|
10191
|
-
* Extracts a single event type matching the given key from the {@link
|
10451
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
10192
10452
|
*
|
10193
10453
|
* @typeParam Type String key specifying the event to extract
|
10194
10454
|
*/
|
10195
|
-
declare type Payload_7<Type extends
|
10455
|
+
declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
|
10196
10456
|
type: Type;
|
10197
10457
|
}>;
|
10198
10458
|
|
10199
10459
|
/**
|
10200
|
-
* Extracts a single event type matching the given key from the {@link
|
10460
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
10201
10461
|
*
|
10202
10462
|
* @typeParam Type String key specifying the event to extract
|
10203
10463
|
*/
|
10204
|
-
declare type Payload_8<Type extends
|
10464
|
+
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
10205
10465
|
type: Type;
|
10206
10466
|
}>;
|
10207
10467
|
|
10208
10468
|
/**
|
10209
|
-
* Extracts a single event type matching the given key from the {@link
|
10469
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
10210
10470
|
*
|
10211
10471
|
* @typeParam Type String key specifying the event to extract
|
10212
10472
|
*/
|
10213
|
-
declare type Payload_9<Type extends
|
10473
|
+
declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
|
10214
10474
|
type: Type;
|
10215
10475
|
}>;
|
10216
10476
|
|
@@ -10220,7 +10480,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
|
|
10220
10480
|
* Generated when window finishes loading. Provides performance and navigation data.
|
10221
10481
|
* @interface
|
10222
10482
|
*/
|
10223
|
-
declare type PerformanceReportEvent = Performance &
|
10483
|
+
declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
10224
10484
|
type: 'performance-report';
|
10225
10485
|
};
|
10226
10486
|
|
@@ -10854,38 +11114,36 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
|
|
10854
11114
|
}
|
10855
11115
|
|
10856
11116
|
/**
|
10857
|
-
*
|
10858
|
-
* @interface
|
11117
|
+
* @deprecated Renamed to {@link ApiReadyEvent}.
|
10859
11118
|
*/
|
10860
|
-
declare type PlatformApiReadyEvent =
|
10861
|
-
topic: 'application';
|
10862
|
-
type: 'platform-api-ready';
|
10863
|
-
};
|
11119
|
+
declare type PlatformApiReadyEvent = ApiReadyEvent;
|
10864
11120
|
|
10865
11121
|
/**
|
10866
|
-
*
|
10867
|
-
* discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
|
10868
|
-
* under the {@link OpenFin.PlatformEvents} namespace.
|
11122
|
+
* @deprecated Renamed to {@link Event}.
|
10869
11123
|
*/
|
10870
|
-
declare type PlatformEvent =
|
11124
|
+
declare type PlatformEvent = Event_10;
|
10871
11125
|
|
10872
11126
|
declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
|
10873
11127
|
|
10874
11128
|
declare namespace PlatformEvents {
|
10875
11129
|
export {
|
11130
|
+
ApiReadyEvent,
|
10876
11131
|
PlatformApiReadyEvent,
|
11132
|
+
SnapshotAppliedEvent,
|
10877
11133
|
PlatformSnapshotAppliedEvent,
|
11134
|
+
Event_10 as Event,
|
10878
11135
|
PlatformEvent,
|
11136
|
+
EventType_7 as EventType,
|
10879
11137
|
PlatformEventType,
|
10880
|
-
|
10881
|
-
|
11138
|
+
Payload_8 as Payload,
|
11139
|
+
ByType_7 as ByType
|
10882
11140
|
}
|
10883
11141
|
}
|
10884
11142
|
|
10885
11143
|
/**
|
10886
|
-
*
|
11144
|
+
* @deprecated Renamed to {@link }.
|
10887
11145
|
*/
|
10888
|
-
declare type PlatformEventType =
|
11146
|
+
declare type PlatformEventType = EventType_7;
|
10889
11147
|
|
10890
11148
|
/**
|
10891
11149
|
* Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
|
@@ -11550,19 +11808,9 @@ declare interface PlatformProvider {
|
|
11550
11808
|
}
|
11551
11809
|
|
11552
11810
|
/**
|
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
|
11811
|
+
* @deprecated Renamed to {@link SnapshotAppliedEvent}.
|
11561
11812
|
*/
|
11562
|
-
declare type PlatformSnapshotAppliedEvent =
|
11563
|
-
topic: 'application';
|
11564
|
-
type: 'platform-snapshot-applied';
|
11565
|
-
};
|
11813
|
+
declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
|
11566
11814
|
|
11567
11815
|
/**
|
11568
11816
|
* @interface
|
@@ -11830,7 +12078,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
|
|
11830
12078
|
* A general preload scripts state change event without event type.
|
11831
12079
|
* @interface
|
11832
12080
|
*/
|
11833
|
-
declare type PreloadScriptsStateChangeEvent =
|
12081
|
+
declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
|
11834
12082
|
preloadScripts: (PreloadScriptInfoRunning & any)[];
|
11835
12083
|
};
|
11836
12084
|
|
@@ -12039,51 +12287,43 @@ declare type ProcessLoggingOptions = {
|
|
12039
12287
|
};
|
12040
12288
|
|
12041
12289
|
/**
|
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.
|
12290
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
12047
12291
|
*/
|
12048
|
-
declare type PropagatedApplicationEvent<TargetTopic extends string> =
|
12292
|
+
declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
|
12049
12293
|
|
12050
12294
|
/**
|
12051
|
-
*
|
12295
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
12052
12296
|
*/
|
12053
|
-
declare type PropagatedApplicationEventType =
|
12297
|
+
declare type PropagatedApplicationEventType = PropagatedEventType_3;
|
12054
12298
|
|
12055
12299
|
/**
|
12056
|
-
* Modifies an event shape to reflect propagation to a parent topic.
|
12300
|
+
* Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
|
12301
|
+
* these do not propagate.
|
12302
|
+
*
|
12057
12303
|
* @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
|
12304
|
+
*
|
12305
|
+
* @typeParam SourceTopic The topic the event shape is propagating from.
|
12306
|
+
* @typeParam TargetTopic The topic the event shape is propagating to.
|
12307
|
+
* @typeParam Event The shape of the event being propagated.
|
12058
12308
|
*/
|
12059
12309
|
declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
|
12060
12310
|
type: string;
|
12061
12311
|
}> = Event extends infer E extends {
|
12062
12312
|
type: string;
|
12063
|
-
} ? Omit<E, 'type' | 'topic'> & {
|
12313
|
+
} ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
|
12064
12314
|
type: PropagatedEventType<SourceTopic, E['type']>;
|
12065
12315
|
topic: TargetTopic;
|
12066
12316
|
} : never;
|
12067
12317
|
|
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
12318
|
/**
|
12074
12319
|
* A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
|
12075
12320
|
* 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
12321
|
* event type key with `'view-'`.
|
12077
12322
|
*/
|
12078
|
-
declare type
|
12323
|
+
declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
|
12079
12324
|
viewIdentity: OpenFin.Identity;
|
12080
12325
|
};
|
12081
12326
|
|
12082
|
-
/**
|
12083
|
-
* Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
|
12084
|
-
*/
|
12085
|
-
declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
12086
|
-
|
12087
12327
|
/**
|
12088
12328
|
* A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
|
12089
12329
|
* prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
|
@@ -12092,12 +12332,51 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
|
12092
12332
|
*
|
12093
12333
|
* "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
|
12094
12334
|
*/
|
12095
|
-
declare type
|
12335
|
+
declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
|
12336
|
+
|
12337
|
+
/**
|
12338
|
+
* An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
|
12339
|
+
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
12340
|
+
* are propagated to `System` without any type string prefixing.
|
12341
|
+
*
|
12342
|
+
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
12343
|
+
*/
|
12344
|
+
declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
|
12345
|
+
|
12346
|
+
/**
|
12347
|
+
* Modifies an event type key to reflect propagation by prefixing with the topic.
|
12348
|
+
*/
|
12349
|
+
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
|
12350
|
+
|
12351
|
+
/**
|
12352
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
|
12353
|
+
*/
|
12354
|
+
declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
|
12355
|
+
|
12356
|
+
/**
|
12357
|
+
* Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
|
12358
|
+
*/
|
12359
|
+
declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
|
12360
|
+
|
12361
|
+
/**
|
12362
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
12363
|
+
*/
|
12364
|
+
declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
|
12365
|
+
|
12366
|
+
/**
|
12367
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
12368
|
+
*/
|
12369
|
+
declare type PropagatedViewEventType = PropagatedEventType_2;
|
12096
12370
|
|
12097
12371
|
/**
|
12098
|
-
*
|
12372
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
12099
12373
|
*/
|
12100
|
-
declare type
|
12374
|
+
declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
|
12375
|
+
|
12376
|
+
/**
|
12377
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
|
12378
|
+
*/
|
12379
|
+
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
12101
12380
|
|
12102
12381
|
declare interface ProtocolMap extends ProtocolMapBase {
|
12103
12382
|
'request-external-authorization': {
|
@@ -12515,7 +12794,7 @@ declare type RegistryInfo_2 = {
|
|
12515
12794
|
* Generated when a window has been reloaded.
|
12516
12795
|
* @interface
|
12517
12796
|
*/
|
12518
|
-
declare type ReloadedEvent =
|
12797
|
+
declare type ReloadedEvent = BaseEvent_5 & {
|
12519
12798
|
type: 'reloaded';
|
12520
12799
|
url: string;
|
12521
12800
|
};
|
@@ -12651,11 +12930,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
|
|
12651
12930
|
* Generated when an application is responding.
|
12652
12931
|
* @interface
|
12653
12932
|
*/
|
12654
|
-
declare type RespondingEvent = IdentityEvent & {
|
12933
|
+
declare type RespondingEvent = BaseEvents.IdentityEvent & {
|
12655
12934
|
topic: 'application';
|
12656
12935
|
type: 'responding';
|
12657
12936
|
};
|
12658
12937
|
|
12938
|
+
/**
|
12939
|
+
* Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
12940
|
+
* @interface
|
12941
|
+
*/
|
12942
|
+
declare type RestoredEvent = BaseEvent_5 & {
|
12943
|
+
type: 'restored';
|
12944
|
+
};
|
12945
|
+
|
12659
12946
|
declare type ResultBehavior = 'close' | 'hide' | 'none';
|
12660
12947
|
|
12661
12948
|
/**
|
@@ -12718,7 +13005,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
|
|
12718
13005
|
* Generated when Application.run() is called for an already running application.
|
12719
13006
|
* @interface
|
12720
13007
|
*/
|
12721
|
-
declare type RunRequestedEvent_2 = IdentityEvent & {
|
13008
|
+
declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
|
12722
13009
|
topic: 'application';
|
12723
13010
|
type: 'run-requested';
|
12724
13011
|
userAppConfigArgs: Record<string, any>;
|
@@ -12900,7 +13187,7 @@ declare type ServiceIdentifier = {
|
|
12900
13187
|
* Generated on changes to a user’s local computer session.
|
12901
13188
|
* @interface
|
12902
13189
|
*/
|
12903
|
-
declare type SessionChangedEvent =
|
13190
|
+
declare type SessionChangedEvent = BaseEvent_8 & {
|
12904
13191
|
type: 'session-changed';
|
12905
13192
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
12906
13193
|
};
|
@@ -13122,7 +13409,7 @@ declare type ShortcutOverride = Hotkey & {
|
|
13122
13409
|
*
|
13123
13410
|
* @interface
|
13124
13411
|
*/
|
13125
|
-
declare type ShowAllDownloadsEvent =
|
13412
|
+
declare type ShowAllDownloadsEvent = BaseEvent_5 & {
|
13126
13413
|
type: 'show-all-downloads';
|
13127
13414
|
};
|
13128
13415
|
|
@@ -13130,7 +13417,15 @@ declare type ShowAllDownloadsEvent = BaseWindowEvent & {
|
|
13130
13417
|
* Generated when a View is shown. This event will fire during creation of a View.
|
13131
13418
|
* @interface
|
13132
13419
|
*/
|
13133
|
-
declare type ShownEvent =
|
13420
|
+
declare type ShownEvent = BaseEvent_4 & {
|
13421
|
+
type: 'shown';
|
13422
|
+
};
|
13423
|
+
|
13424
|
+
/**
|
13425
|
+
* Generated when a hidden window has been shown.
|
13426
|
+
* @interface
|
13427
|
+
*/
|
13428
|
+
declare type ShownEvent_2 = BaseEvent_5 & {
|
13134
13429
|
type: 'shown';
|
13135
13430
|
};
|
13136
13431
|
|
@@ -13159,6 +13454,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
|
|
13159
13454
|
y?: number;
|
13160
13455
|
};
|
13161
13456
|
|
13457
|
+
/**
|
13458
|
+
* Generated when a window has been prevented from showing.
|
13459
|
+
* @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.
|
13460
|
+
* @interface
|
13461
|
+
*/
|
13462
|
+
declare type ShowRequestedEvent = BaseEvent_5 & {
|
13463
|
+
type: 'show-requested';
|
13464
|
+
};
|
13465
|
+
|
13162
13466
|
/**
|
13163
13467
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
13164
13468
|
*
|
@@ -13205,6 +13509,21 @@ declare type Snapshot = {
|
|
13205
13509
|
};
|
13206
13510
|
};
|
13207
13511
|
|
13512
|
+
/**
|
13513
|
+
* Generated when a platform.ApplySnapshot call is resolved.
|
13514
|
+
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
13515
|
+
* 1. The window has been created
|
13516
|
+
* 2. The window has a responsive API
|
13517
|
+
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
13518
|
+
*
|
13519
|
+
* _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.
|
13520
|
+
* @interface
|
13521
|
+
*/
|
13522
|
+
declare type SnapshotAppliedEvent = BaseEvent & {
|
13523
|
+
topic: 'application';
|
13524
|
+
type: 'platform-snapshot-applied';
|
13525
|
+
};
|
13526
|
+
|
13208
13527
|
/**
|
13209
13528
|
* @interface
|
13210
13529
|
*/
|
@@ -13319,7 +13638,7 @@ declare class SnapshotSourceModule extends Base {
|
|
13319
13638
|
* Generated when an application has started.
|
13320
13639
|
* @interface
|
13321
13640
|
*/
|
13322
|
-
declare type StartedEvent = IdentityEvent & {
|
13641
|
+
declare type StartedEvent = BaseEvents.IdentityEvent & {
|
13323
13642
|
topic: 'application';
|
13324
13643
|
type: 'started';
|
13325
13644
|
};
|
@@ -14852,12 +15171,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
|
|
14852
15171
|
};
|
14853
15172
|
|
14854
15173
|
/**
|
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).
|
15174
|
+
* @deprecated Renamed to {@link Event}.
|
14859
15175
|
*/
|
14860
|
-
declare type SystemEvent =
|
15176
|
+
declare type SystemEvent = Event_11;
|
14861
15177
|
|
14862
15178
|
declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
|
14863
15179
|
|
@@ -14865,8 +15181,10 @@ declare namespace SystemEvents {
|
|
14865
15181
|
export {
|
14866
15182
|
NotRequested,
|
14867
15183
|
ExcludeRequested,
|
14868
|
-
|
15184
|
+
BaseEvent_8 as BaseEvent,
|
15185
|
+
IdleStateChangedEvent,
|
14869
15186
|
IdleEvent,
|
15187
|
+
MonitorInfoChangedEvent,
|
14870
15188
|
MonitorEvent,
|
14871
15189
|
SessionChangedEvent,
|
14872
15190
|
AppVersionEvent,
|
@@ -14880,17 +15198,19 @@ declare namespace SystemEvents {
|
|
14880
15198
|
ApplicationCreatedEvent,
|
14881
15199
|
DesktopIconClickedEvent,
|
14882
15200
|
SystemShutdownEvent,
|
15201
|
+
Event_11 as Event,
|
14883
15202
|
SystemEvent,
|
15203
|
+
EventType_8 as EventType,
|
14884
15204
|
SystemEventType,
|
14885
|
-
|
14886
|
-
|
15205
|
+
Payload_9 as Payload,
|
15206
|
+
ByType_8 as ByType
|
14887
15207
|
}
|
14888
15208
|
}
|
14889
15209
|
|
14890
15210
|
/**
|
14891
|
-
*
|
15211
|
+
* @deprecated Renamed to {@link EventType}.
|
14892
15212
|
*/
|
14893
|
-
declare type SystemEventType =
|
15213
|
+
declare type SystemEventType = EventType_8;
|
14894
15214
|
|
14895
15215
|
/**
|
14896
15216
|
* @interface
|
@@ -15143,7 +15463,7 @@ declare type TargetApp = string | AppMetadata;
|
|
15143
15463
|
* In that case, previousTarget identity will be the same as target identity.
|
15144
15464
|
* @interface
|
15145
15465
|
*/
|
15146
|
-
declare type TargetChangedEvent =
|
15466
|
+
declare type TargetChangedEvent = BaseEvent_4 & {
|
15147
15467
|
type: 'target-changed';
|
15148
15468
|
previousTarget: OpenFin.Identity;
|
15149
15469
|
};
|
@@ -15297,7 +15617,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
15297
15617
|
* Generated when the tray icon is clicked.
|
15298
15618
|
* @interface
|
15299
15619
|
*/
|
15300
|
-
declare type TrayIconClickedEvent = IdentityEvent & {
|
15620
|
+
declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
|
15301
15621
|
topic: 'application';
|
15302
15622
|
type: 'tray-icon-clicked';
|
15303
15623
|
button: 0 | 1 | 2;
|
@@ -15387,7 +15707,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
15387
15707
|
* A general user bounds change event without event type.
|
15388
15708
|
* @interface
|
15389
15709
|
*/
|
15390
|
-
declare type UserBoundsChangeEvent =
|
15710
|
+
declare type UserBoundsChangeEvent = BaseEvent_5 & {
|
15391
15711
|
height: number;
|
15392
15712
|
left: number;
|
15393
15713
|
top: number;
|
@@ -15399,7 +15719,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
|
|
15399
15719
|
* Generated when a window's user movement becomes disabled.
|
15400
15720
|
* @interface
|
15401
15721
|
*/
|
15402
|
-
declare type UserMovementDisabledEvent =
|
15722
|
+
declare type UserMovementDisabledEvent = BaseEvent_5 & {
|
15403
15723
|
type: 'user-movement-disabled';
|
15404
15724
|
};
|
15405
15725
|
|
@@ -15407,7 +15727,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
|
|
15407
15727
|
* Generated when a window's user movement becomes enabled.
|
15408
15728
|
* @interface
|
15409
15729
|
*/
|
15410
|
-
declare type UserMovementEnabledEvent =
|
15730
|
+
declare type UserMovementEnabledEvent = BaseEvent_5 & {
|
15411
15731
|
type: 'user-movement-enabled';
|
15412
15732
|
};
|
15413
15733
|
|
@@ -16057,7 +16377,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
16057
16377
|
* Generated when a View is attached to a window.
|
16058
16378
|
* @interface
|
16059
16379
|
*/
|
16060
|
-
declare type ViewAttachedEvent =
|
16380
|
+
declare type ViewAttachedEvent = BaseEvent_5 & {
|
16061
16381
|
type: 'view-attached';
|
16062
16382
|
target: OpenFin.Identity;
|
16063
16383
|
viewIdentity: OpenFin.Identity;
|
@@ -16099,7 +16419,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
|
|
16099
16419
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
16100
16420
|
* @interface
|
16101
16421
|
*/
|
16102
|
-
declare type ViewDetachedEvent =
|
16422
|
+
declare type ViewDetachedEvent = BaseEvent_5 & {
|
16103
16423
|
type: 'view-detached';
|
16104
16424
|
target: OpenFin.Identity;
|
16105
16425
|
previousTarget: OpenFin.Identity;
|
@@ -16107,18 +16427,15 @@ declare type ViewDetachedEvent = BaseWindowEvent & {
|
|
16107
16427
|
};
|
16108
16428
|
|
16109
16429
|
/**
|
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}).
|
16430
|
+
* @deprecated Renamed to {@link Event}.
|
16113
16431
|
*/
|
16114
|
-
declare type ViewEvent =
|
16115
|
-
target: OpenFin.Identity;
|
16116
|
-
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
16432
|
+
declare type ViewEvent = Event_4;
|
16117
16433
|
|
16118
16434
|
declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
|
16119
16435
|
|
16120
16436
|
declare namespace ViewEvents {
|
16121
16437
|
export {
|
16438
|
+
BaseEvent_4 as BaseEvent,
|
16122
16439
|
BaseViewEvent,
|
16123
16440
|
TargetChangedEvent,
|
16124
16441
|
NonPropagatedViewEvent,
|
@@ -16128,20 +16445,24 @@ declare namespace ViewEvents {
|
|
16128
16445
|
HotkeyEvent,
|
16129
16446
|
ShownEvent,
|
16130
16447
|
HostContextChangedEvent,
|
16448
|
+
Event_4 as Event,
|
16131
16449
|
ViewEvent,
|
16132
16450
|
WillPropagateViewEvent,
|
16451
|
+
EventType,
|
16133
16452
|
ViewEventType,
|
16453
|
+
PropagatedEvent_2 as PropagatedEvent,
|
16134
16454
|
PropagatedViewEvent,
|
16455
|
+
PropagatedEventType_2 as PropagatedEventType,
|
16135
16456
|
PropagatedViewEventType,
|
16136
|
-
|
16137
|
-
|
16457
|
+
Payload_2 as Payload,
|
16458
|
+
ByType
|
16138
16459
|
}
|
16139
16460
|
}
|
16140
16461
|
|
16141
16462
|
/**
|
16142
|
-
*
|
16463
|
+
* @deprecated Renamed to {@link EventType}.
|
16143
16464
|
*/
|
16144
|
-
declare type ViewEventType =
|
16465
|
+
declare type ViewEventType = EventType;
|
16145
16466
|
|
16146
16467
|
/**
|
16147
16468
|
* @interface
|
@@ -17280,12 +17601,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
17280
17601
|
}
|
17281
17602
|
|
17282
17603
|
/**
|
17283
|
-
*
|
17284
|
-
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
17604
|
+
* @deprecated Renamed to {@link Event}.
|
17285
17605
|
*/
|
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);
|
17606
|
+
declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
|
17289
17607
|
|
17290
17608
|
declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
|
17291
17609
|
|
@@ -17297,6 +17615,7 @@ declare namespace WebContentsEvents {
|
|
17297
17615
|
CrashedEvent_2 as CrashedEvent,
|
17298
17616
|
CertificateErrorEvent,
|
17299
17617
|
CertificateSelectionShownEvent,
|
17618
|
+
PageFaviconUpdatedEvent,
|
17300
17619
|
FaviconUpdatedEvent,
|
17301
17620
|
NavigationRejectedEvent,
|
17302
17621
|
UrlChangedEvent,
|
@@ -17315,6 +17634,7 @@ declare namespace WebContentsEvents {
|
|
17315
17634
|
FileDownloadStartedEvent,
|
17316
17635
|
FileDownloadProgressEvent,
|
17317
17636
|
FileDownloadCompletedEvent,
|
17637
|
+
Event_5 as Event,
|
17318
17638
|
WebContentsEvent,
|
17319
17639
|
WillPropagateWebContentsEvent,
|
17320
17640
|
NonPropagatedWebContentsEvent
|
@@ -17362,7 +17682,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
17362
17682
|
* A general will-move or will-resize event without event type.
|
17363
17683
|
* @interface
|
17364
17684
|
*/
|
17365
|
-
declare type WillMoveOrResizeEvent =
|
17685
|
+
declare type WillMoveOrResizeEvent = BaseEvent_5 & {
|
17366
17686
|
height: number;
|
17367
17687
|
left: number;
|
17368
17688
|
top: number;
|
@@ -17384,7 +17704,7 @@ declare type WillPropagateViewEvent = ViewEvent;
|
|
17384
17704
|
*
|
17385
17705
|
* A WebContents event that does propagate to (republish on) parent topics.
|
17386
17706
|
*/
|
17387
|
-
declare type WillPropagateWebContentsEvent =
|
17707
|
+
declare type WillPropagateWebContentsEvent = Event_5<string>;
|
17388
17708
|
|
17389
17709
|
/**
|
17390
17710
|
* @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
|
@@ -17398,7 +17718,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
|
|
17398
17718
|
* Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
|
17399
17719
|
* @interface
|
17400
17720
|
*/
|
17401
|
-
declare type WillRedirectEvent =
|
17721
|
+
declare type WillRedirectEvent = BaseEvent_5 & {
|
17402
17722
|
type: 'will-redirect';
|
17403
17723
|
blocked: boolean;
|
17404
17724
|
isInPlace: boolean;
|
@@ -18939,7 +19259,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
18939
19259
|
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
18940
19260
|
* @interface
|
18941
19261
|
*/
|
18942
|
-
declare type WindowAlertRequestedEvent =
|
19262
|
+
declare type WindowAlertRequestedEvent = BaseEvent_3 & {
|
18943
19263
|
type: 'window-alert-requested';
|
18944
19264
|
};
|
18945
19265
|
|
@@ -18953,29 +19273,19 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
18953
19273
|
};
|
18954
19274
|
|
18955
19275
|
/**
|
18956
|
-
*
|
18957
|
-
* @interface
|
19276
|
+
* @deprecated Renamed to {@link ClosedEvent}.
|
18958
19277
|
*/
|
18959
|
-
declare type WindowClosedEvent =
|
18960
|
-
type: 'closed';
|
18961
|
-
};
|
19278
|
+
declare type WindowClosedEvent = ClosedEvent_2;
|
18962
19279
|
|
18963
19280
|
/**
|
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
|
19281
|
+
* @deprecated Renamed to {@link CloseRequestedEvent}.
|
18967
19282
|
*/
|
18968
|
-
declare type WindowCloseRequestedEvent =
|
18969
|
-
type: 'close-requested';
|
18970
|
-
};
|
19283
|
+
declare type WindowCloseRequestedEvent = CloseRequestedEvent;
|
18971
19284
|
|
18972
19285
|
/**
|
18973
|
-
*
|
18974
|
-
* @interface
|
19286
|
+
* @deprecated Renamed to {@link ClosingEvent}.
|
18975
19287
|
*/
|
18976
|
-
declare type WindowClosingEvent =
|
18977
|
-
type: 'closing';
|
18978
|
-
};
|
19288
|
+
declare type WindowClosingEvent = ClosingEvent;
|
18979
19289
|
|
18980
19290
|
/**
|
18981
19291
|
* A rule prescribing content creation in a {@link OpenFin.Window}.
|
@@ -18997,7 +19307,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
18997
19307
|
* Generated when a child window is created.
|
18998
19308
|
* @interface
|
18999
19309
|
*/
|
19000
|
-
declare type WindowCreatedEvent =
|
19310
|
+
declare type WindowCreatedEvent = BaseEvent_3 & {
|
19001
19311
|
type: 'window-created';
|
19002
19312
|
};
|
19003
19313
|
|
@@ -19054,21 +19364,20 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19054
19364
|
* Generated when a child window ends loading.
|
19055
19365
|
* @interface
|
19056
19366
|
*/
|
19057
|
-
declare type WindowEndLoadEvent =
|
19367
|
+
declare type WindowEndLoadEvent = BaseEvent_3 & {
|
19058
19368
|
type: 'window-end-load';
|
19059
19369
|
};
|
19060
19370
|
|
19061
19371
|
/**
|
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}).
|
19372
|
+
* @deprecated, Renamed to {@link Event}.
|
19065
19373
|
*/
|
19066
|
-
declare type WindowEvent =
|
19374
|
+
declare type WindowEvent = Event_6;
|
19067
19375
|
|
19068
19376
|
declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
|
19069
19377
|
|
19070
19378
|
declare namespace WindowEvents {
|
19071
19379
|
export {
|
19380
|
+
BaseEvent_5 as BaseEvent,
|
19072
19381
|
BaseWindowEvent,
|
19073
19382
|
ViewAttachedEvent,
|
19074
19383
|
ViewDetachedEvent,
|
@@ -19078,9 +19387,11 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19078
19387
|
EndLoadEvent,
|
19079
19388
|
WillRedirectEvent,
|
19080
19389
|
ReloadedEvent,
|
19390
|
+
OptionsChangedEvent,
|
19081
19391
|
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
19082
19392
|
ExternalProcessExitedEvent,
|
19083
19393
|
ExternalProcessStartedEvent,
|
19394
|
+
HiddenEvent_2 as HiddenEvent,
|
19084
19395
|
WindowHiddenEvent,
|
19085
19396
|
PreloadScriptInfoRunning,
|
19086
19397
|
PreloadScriptInfo,
|
@@ -19095,22 +19406,30 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19095
19406
|
BeginUserBoundsChangingEvent,
|
19096
19407
|
BoundsChangedEvent,
|
19097
19408
|
BoundsChangingEvent,
|
19409
|
+
CloseRequestedEvent,
|
19098
19410
|
WindowCloseRequestedEvent,
|
19099
19411
|
ContextChangedEvent,
|
19412
|
+
ClosedEvent_2 as ClosedEvent,
|
19100
19413
|
WindowClosedEvent,
|
19414
|
+
ClosingEvent,
|
19101
19415
|
WindowClosingEvent,
|
19102
19416
|
DisabledMovementBoundsChangedEvent,
|
19103
19417
|
DisabledMovementBoundsChangingEvent,
|
19104
19418
|
EmbeddedEvent,
|
19105
19419
|
EndUserBoundsChangingEvent,
|
19420
|
+
HotkeyEvent_2 as HotkeyEvent,
|
19106
19421
|
WindowHotkeyEvent,
|
19422
|
+
InitializedEvent_2 as InitializedEvent,
|
19107
19423
|
WindowInitializedEvent,
|
19108
19424
|
MaximizedEvent,
|
19109
19425
|
MinimizedEvent,
|
19110
19426
|
PreloadScriptsStateChangedEvent,
|
19111
19427
|
PreloadScriptsStateChangingEvent,
|
19428
|
+
RestoredEvent,
|
19112
19429
|
WindowRestoredEvent,
|
19430
|
+
ShowRequestedEvent,
|
19113
19431
|
WindowShowRequestedEvent,
|
19432
|
+
ShownEvent_2 as ShownEvent,
|
19114
19433
|
WindowShownEvent,
|
19115
19434
|
UserMovementEnabledEvent,
|
19116
19435
|
UserMovementDisabledEvent,
|
@@ -19121,37 +19440,32 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19121
19440
|
DownloadShelfVisibilityChangedEvent,
|
19122
19441
|
WindowSourcedEvent,
|
19123
19442
|
WillPropagateWindowEvent,
|
19443
|
+
Event_6 as Event,
|
19124
19444
|
WindowEvent,
|
19445
|
+
EventType_2 as EventType,
|
19125
19446
|
WindowEventType,
|
19447
|
+
PropagatedEvent_3 as PropagatedEvent,
|
19126
19448
|
PropagatedWindowEvent,
|
19127
19449
|
PropagatedWindowEventType,
|
19128
|
-
|
19129
|
-
|
19450
|
+
Payload_3 as Payload,
|
19451
|
+
ByType_2 as ByType
|
19130
19452
|
}
|
19131
19453
|
}
|
19132
19454
|
|
19133
19455
|
/**
|
19134
|
-
*
|
19456
|
+
* @deprecated Renamed to {@link EventType}.
|
19135
19457
|
*/
|
19136
19458
|
declare type WindowEventType = WindowEvent['type'];
|
19137
19459
|
|
19138
19460
|
/**
|
19139
|
-
*
|
19140
|
-
* @interface
|
19461
|
+
* @deprecated Renamed to {@link HiddenEvent}.
|
19141
19462
|
*/
|
19142
|
-
declare type WindowHiddenEvent =
|
19143
|
-
type: 'hidden';
|
19144
|
-
reason: 'closing' | 'hide' | 'hide-on-close';
|
19145
|
-
};
|
19463
|
+
declare type WindowHiddenEvent = HiddenEvent_2;
|
19146
19464
|
|
19147
19465
|
/**
|
19148
|
-
*
|
19149
|
-
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
19150
|
-
* @interface
|
19466
|
+
* @deprecated Renamed to {@link HotkeyEvent}.
|
19151
19467
|
*/
|
19152
|
-
declare type WindowHotkeyEvent =
|
19153
|
-
type: 'hotkey';
|
19154
|
-
};
|
19468
|
+
declare type WindowHotkeyEvent = HotkeyEvent_2;
|
19155
19469
|
|
19156
19470
|
/**
|
19157
19471
|
* @interface
|
@@ -19165,12 +19479,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19165
19479
|
};
|
19166
19480
|
|
19167
19481
|
/**
|
19168
|
-
*
|
19169
|
-
* @interface
|
19482
|
+
* @deprecated Renamed to {@link InitializedEvent}.
|
19170
19483
|
*/
|
19171
|
-
declare type WindowInitializedEvent =
|
19172
|
-
type: 'initialized';
|
19173
|
-
};
|
19484
|
+
declare type WindowInitializedEvent = InitializedEvent_2;
|
19174
19485
|
|
19175
19486
|
/**
|
19176
19487
|
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
@@ -19267,7 +19578,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19267
19578
|
* Generated when a child window is not responding.
|
19268
19579
|
* @interface
|
19269
19580
|
*/
|
19270
|
-
declare type WindowNotRespondingEvent =
|
19581
|
+
declare type WindowNotRespondingEvent = BaseEvent_3 & {
|
19271
19582
|
type: 'window-not-responding';
|
19272
19583
|
};
|
19273
19584
|
|
@@ -19289,15 +19600,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19289
19600
|
declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
|
19290
19601
|
|
19291
19602
|
/**
|
19292
|
-
*
|
19293
|
-
* @remarks Will not fire if the diff object is empty.
|
19294
|
-
* @interface
|
19603
|
+
* @deprecated Renamed to {@link OptionsChangedEvent}.
|
19295
19604
|
*/
|
19296
|
-
declare type WindowOptionsChangedEvent_2 =
|
19297
|
-
type: 'options-changed';
|
19298
|
-
options: OpenFin.WindowOptions;
|
19299
|
-
diff: OpenFin.WindowOptionDiff;
|
19300
|
-
};
|
19605
|
+
declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
|
19301
19606
|
|
19302
19607
|
declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
|
19303
19608
|
|
@@ -19305,46 +19610,36 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19305
19610
|
* Generated when a child window is responding.
|
19306
19611
|
* @interface
|
19307
19612
|
*/
|
19308
|
-
declare type WindowRespondingEvent =
|
19613
|
+
declare type WindowRespondingEvent = BaseEvent_3 & {
|
19309
19614
|
type: 'window-responding';
|
19310
19615
|
};
|
19311
19616
|
|
19312
19617
|
/**
|
19313
|
-
*
|
19314
|
-
* @interface
|
19618
|
+
* @deprecated Renamed to {@link RestoredEvent}.
|
19315
19619
|
*/
|
19316
|
-
declare type WindowRestoredEvent =
|
19317
|
-
type: 'restored';
|
19318
|
-
};
|
19620
|
+
declare type WindowRestoredEvent = RestoredEvent;
|
19319
19621
|
|
19320
19622
|
/**
|
19321
|
-
*
|
19322
|
-
* @interface
|
19623
|
+
* @deprecated Renamed to {@link ShownEvent}.
|
19323
19624
|
*/
|
19324
|
-
declare type WindowShownEvent =
|
19325
|
-
type: 'shown';
|
19326
|
-
};
|
19625
|
+
declare type WindowShownEvent = ShownEvent_2;
|
19327
19626
|
|
19328
19627
|
/**
|
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
|
19628
|
+
* @deprecated Renamed to {@link ShowRequestedEvent}.
|
19332
19629
|
*/
|
19333
|
-
declare type WindowShowRequestedEvent =
|
19334
|
-
type: 'show-requested';
|
19335
|
-
};
|
19630
|
+
declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
19336
19631
|
|
19337
19632
|
/**
|
19338
19633
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
19339
19634
|
* from {@link OpenFin.ViewEvents}.
|
19340
19635
|
*/
|
19341
|
-
declare type WindowSourcedEvent =
|
19636
|
+
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
19637
|
|
19343
19638
|
/**
|
19344
19639
|
* Generated when a child window starts loading.
|
19345
19640
|
* @interface
|
19346
19641
|
*/
|
19347
|
-
declare type WindowStartLoadEvent =
|
19642
|
+
declare type WindowStartLoadEvent = BaseEvent_3 & {
|
19348
19643
|
type: 'window-start-load';
|
19349
19644
|
};
|
19350
19645
|
|