@openfin/node-adapter 35.78.1 → 35.78.6
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
package/out/node-adapter.d.ts
CHANGED
@@ -64,7 +64,7 @@ declare type AddViewToStackOptions = {
|
|
64
64
|
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
65
65
|
* @interface
|
66
66
|
*/
|
67
|
-
declare type AlertRequestedEvent =
|
67
|
+
declare type AlertRequestedEvent = BaseEvent_5 & {
|
68
68
|
type: 'alert-requested';
|
69
69
|
message: string;
|
70
70
|
url: string;
|
@@ -105,6 +105,15 @@ declare type ApiClient<T extends Record<any, any>> = {
|
|
105
105
|
[key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
|
106
106
|
};
|
107
107
|
|
108
|
+
/**
|
109
|
+
* Generated when a new Platform's API becomes responsive.
|
110
|
+
* @interface
|
111
|
+
*/
|
112
|
+
declare type ApiReadyEvent = BaseEvent & {
|
113
|
+
topic: 'application';
|
114
|
+
type: 'platform-api-ready';
|
115
|
+
};
|
116
|
+
|
108
117
|
/**
|
109
118
|
* @interface
|
110
119
|
*/
|
@@ -862,19 +871,15 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
|
|
862
871
|
}
|
863
872
|
|
864
873
|
/**
|
865
|
-
*
|
866
|
-
* @interface
|
874
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
867
875
|
*/
|
868
|
-
declare type ApplicationConnectedEvent =
|
869
|
-
topic: 'application';
|
870
|
-
type: 'connected';
|
871
|
-
};
|
876
|
+
declare type ApplicationConnectedEvent = ConnectedEvent_2;
|
872
877
|
|
873
878
|
/**
|
874
879
|
* Generated when an application is created.
|
875
880
|
* @interface
|
876
881
|
*/
|
877
|
-
declare type ApplicationCreatedEvent =
|
882
|
+
declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
|
878
883
|
type: 'application-created';
|
879
884
|
};
|
880
885
|
|
@@ -898,17 +903,15 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
|
|
898
903
|
};
|
899
904
|
|
900
905
|
/**
|
901
|
-
*
|
902
|
-
* discriminated by {@link ApplicationEvent.type | their type}. Event payloads unique to `Application` can be found
|
903
|
-
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
904
|
-
* from which they propagate).
|
906
|
+
* @deprecated Renamed to {@link Event}.
|
905
907
|
*/
|
906
|
-
declare type ApplicationEvent =
|
908
|
+
declare type ApplicationEvent = Event_3;
|
907
909
|
|
908
910
|
declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
|
909
911
|
|
910
912
|
declare namespace ApplicationEvents {
|
911
913
|
export {
|
914
|
+
BaseEvent_3 as BaseEvent,
|
912
915
|
BaseApplicationEvent,
|
913
916
|
CrashedEvent,
|
914
917
|
FileDownloadLocationChangedEvent,
|
@@ -922,6 +925,7 @@ declare namespace ApplicationEvents {
|
|
922
925
|
WindowStartLoadEvent,
|
923
926
|
ApplicationWindowEvent,
|
924
927
|
ClosedEvent,
|
928
|
+
ConnectedEvent_2 as ConnectedEvent,
|
925
929
|
ApplicationConnectedEvent,
|
926
930
|
InitializedEvent,
|
927
931
|
ManifestChangedEvent,
|
@@ -929,19 +933,23 @@ declare namespace ApplicationEvents {
|
|
929
933
|
RespondingEvent,
|
930
934
|
StartedEvent,
|
931
935
|
ApplicationSourcedEvent,
|
936
|
+
Event_3 as Event,
|
932
937
|
ApplicationEvent,
|
938
|
+
EventType_3 as EventType,
|
933
939
|
ApplicationEventType,
|
940
|
+
PropagatedEvent_4 as PropagatedEvent,
|
934
941
|
PropagatedApplicationEvent,
|
942
|
+
PropagatedEventType_3 as PropagatedEventType,
|
935
943
|
PropagatedApplicationEventType,
|
936
|
-
|
937
|
-
ByType
|
944
|
+
Payload_4 as Payload,
|
945
|
+
ByType_3 as ByType
|
938
946
|
}
|
939
947
|
}
|
940
948
|
|
941
949
|
/**
|
942
|
-
*
|
950
|
+
* @deprecated Renamed to {@link EventType}.
|
943
951
|
*/
|
944
|
-
declare type ApplicationEventType =
|
952
|
+
declare type ApplicationEventType = EventType_3;
|
945
953
|
|
946
954
|
declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
|
947
955
|
|
@@ -1294,9 +1302,8 @@ declare type ApplicationPermissions = {
|
|
1294
1302
|
* A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
|
1295
1303
|
* from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
|
1296
1304
|
* does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
|
1297
|
-
*
|
1298
1305
|
*/
|
1299
|
-
declare type ApplicationSourcedEvent = ClosedEvent |
|
1306
|
+
declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
1300
1307
|
|
1301
1308
|
declare type ApplicationState = OpenFin.ApplicationState;
|
1302
1309
|
|
@@ -1612,7 +1619,7 @@ declare interface AuthorizationPayload {
|
|
1612
1619
|
* ```
|
1613
1620
|
* @interface
|
1614
1621
|
*/
|
1615
|
-
declare type AuthRequestedEvent =
|
1622
|
+
declare type AuthRequestedEvent = BaseEvent_5 & {
|
1616
1623
|
type: 'auth-requested';
|
1617
1624
|
authInfo: {
|
1618
1625
|
host: string;
|
@@ -1680,21 +1687,9 @@ declare class Base {
|
|
1680
1687
|
}
|
1681
1688
|
|
1682
1689
|
/**
|
1683
|
-
*
|
1684
|
-
* @interface
|
1690
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1685
1691
|
*/
|
1686
|
-
declare type BaseApplicationEvent =
|
1687
|
-
topic: `application`;
|
1688
|
-
};
|
1689
|
-
|
1690
|
-
/**
|
1691
|
-
* A base Channel event.
|
1692
|
-
* @interface
|
1693
|
-
*/
|
1694
|
-
declare type BaseChannelEvent = NamedEvent & {
|
1695
|
-
channelName: string;
|
1696
|
-
channelId: string;
|
1697
|
-
};
|
1692
|
+
declare type BaseApplicationEvent = BaseEvent_3;
|
1698
1693
|
|
1699
1694
|
/**
|
1700
1695
|
* @interface
|
@@ -1763,10 +1758,70 @@ declare type BaseEvent = {
|
|
1763
1758
|
type: string;
|
1764
1759
|
};
|
1765
1760
|
|
1766
|
-
|
1761
|
+
/**
|
1762
|
+
* A base Channel event.
|
1763
|
+
* @interface
|
1764
|
+
*/
|
1765
|
+
declare type BaseEvent_2 = NamedEvent & {
|
1766
|
+
channelName: string;
|
1767
|
+
channelId: string;
|
1768
|
+
};
|
1769
|
+
|
1770
|
+
/**
|
1771
|
+
* Base type for events emitting on the `application` topic
|
1772
|
+
* @interface
|
1773
|
+
*/
|
1774
|
+
declare type BaseEvent_3 = BaseEvents.NamedEvent & {
|
1775
|
+
topic: `application`;
|
1776
|
+
};
|
1777
|
+
|
1778
|
+
/**
|
1779
|
+
* Base type for events emitting on the `view` topic
|
1780
|
+
* @interface
|
1781
|
+
*/
|
1782
|
+
declare type BaseEvent_4 = BaseEvents.NamedEvent & {
|
1783
|
+
topic: 'view';
|
1784
|
+
target: OpenFin.Identity;
|
1785
|
+
};
|
1786
|
+
|
1787
|
+
/**
|
1788
|
+
* Base type for events emitting on the `window` topic
|
1789
|
+
* @interface
|
1790
|
+
*/
|
1791
|
+
declare type BaseEvent_5 = BaseEvents.NamedEvent & {
|
1792
|
+
topic: 'window';
|
1793
|
+
};
|
1794
|
+
|
1795
|
+
/**
|
1796
|
+
* Base type for events emitting on the `externalapplication` topic
|
1797
|
+
* @interface
|
1798
|
+
*/
|
1799
|
+
declare type BaseEvent_6 = BaseEvents.BaseEvent & {
|
1800
|
+
topic: 'externalapplication';
|
1801
|
+
};
|
1802
|
+
|
1803
|
+
/**
|
1804
|
+
* The base frame event.
|
1805
|
+
* @interface
|
1806
|
+
*/
|
1807
|
+
declare type BaseEvent_7 = NamedEvent & {
|
1808
|
+
entityType: 'iframe';
|
1809
|
+
frameName: string;
|
1810
|
+
};
|
1811
|
+
|
1812
|
+
/**
|
1813
|
+
* Base type for events emitting on the `system` topic
|
1814
|
+
* @interface
|
1815
|
+
*/
|
1816
|
+
declare type BaseEvent_8 = BaseEvents.BaseEvent & {
|
1817
|
+
topic: 'system';
|
1818
|
+
};
|
1819
|
+
|
1820
|
+
declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
|
1767
1821
|
|
1768
1822
|
declare namespace BaseEvents {
|
1769
1823
|
export {
|
1824
|
+
NotCloseRequested,
|
1770
1825
|
PropagatedEventType,
|
1771
1826
|
PropagatedEvent,
|
1772
1827
|
EventHandler,
|
@@ -1777,21 +1832,14 @@ declare namespace BaseEvents {
|
|
1777
1832
|
}
|
1778
1833
|
|
1779
1834
|
/**
|
1780
|
-
*
|
1781
|
-
* @interface
|
1835
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1782
1836
|
*/
|
1783
|
-
declare type BaseExternalApplicationEvent =
|
1784
|
-
topic: 'externalapplication';
|
1785
|
-
};
|
1837
|
+
declare type BaseExternalApplicationEvent = BaseEvent_6;
|
1786
1838
|
|
1787
1839
|
/**
|
1788
|
-
*
|
1789
|
-
* @interface
|
1840
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1790
1841
|
*/
|
1791
|
-
declare type BaseFrameEvent =
|
1792
|
-
entityType: 'iframe';
|
1793
|
-
frameName: string;
|
1794
|
-
};
|
1842
|
+
declare type BaseFrameEvent = BaseEvent_7;
|
1795
1843
|
|
1796
1844
|
declare type BaseLoadFailedEvent = NamedEvent & {
|
1797
1845
|
errorCode: number;
|
@@ -1800,35 +1848,20 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
1800
1848
|
isMainFrame: boolean;
|
1801
1849
|
};
|
1802
1850
|
|
1803
|
-
/**
|
1804
|
-
* Base type for events emitting on the `system` topic
|
1805
|
-
* @interface
|
1806
|
-
*/
|
1807
|
-
declare type BaseSystemEvent = BaseEvent & {
|
1808
|
-
topic: 'system';
|
1809
|
-
};
|
1810
|
-
|
1811
1851
|
declare type BaseUrlEvent = NamedEvent & {
|
1812
1852
|
type: 'url-changed';
|
1813
1853
|
url: string;
|
1814
1854
|
};
|
1815
1855
|
|
1816
1856
|
/**
|
1817
|
-
*
|
1818
|
-
* @interface
|
1857
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1819
1858
|
*/
|
1820
|
-
declare type BaseViewEvent =
|
1821
|
-
topic: 'view';
|
1822
|
-
target: OpenFin.Identity;
|
1823
|
-
};
|
1859
|
+
declare type BaseViewEvent = BaseEvent_4;
|
1824
1860
|
|
1825
1861
|
/**
|
1826
|
-
*
|
1827
|
-
* @interface
|
1862
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1828
1863
|
*/
|
1829
|
-
declare type BaseWindowEvent =
|
1830
|
-
topic: 'window';
|
1831
|
-
};
|
1864
|
+
declare type BaseWindowEvent = BaseEvent_5;
|
1832
1865
|
|
1833
1866
|
/**
|
1834
1867
|
* User decision of whether a Window or specific View should close when trying to prevent an unload.
|
@@ -1895,7 +1928,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
1895
1928
|
* A general bounds change event without event type.
|
1896
1929
|
* @interface
|
1897
1930
|
*/
|
1898
|
-
declare type BoundsChangeEvent =
|
1931
|
+
declare type BoundsChangeEvent = BaseEvent_5 & {
|
1899
1932
|
changeType: 0 | 1 | 2;
|
1900
1933
|
deferred: boolean;
|
1901
1934
|
height: number;
|
@@ -1967,76 +2000,76 @@ declare interface BrowserWindow {
|
|
1967
2000
|
}
|
1968
2001
|
|
1969
2002
|
/**
|
1970
|
-
* Extracts a single event type matching the given key from the {@link
|
2003
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
1971
2004
|
*
|
1972
2005
|
* Alias for {@link Payload}, which may read better in source.
|
1973
2006
|
*
|
1974
2007
|
* @typeParam Type String key specifying the event to extract
|
1975
2008
|
*/
|
1976
|
-
declare type ByType<Type extends
|
2009
|
+
declare type ByType<Type extends EventType> = Payload_2<Type>;
|
1977
2010
|
|
1978
2011
|
/**
|
1979
|
-
* Extracts a single event type matching the given key from the {@link
|
2012
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
1980
2013
|
*
|
1981
2014
|
* Alias for {@link Payload}, which may read better in source.
|
1982
2015
|
*
|
1983
2016
|
* @typeParam Type String key specifying the event to extract
|
1984
2017
|
*/
|
1985
|
-
declare type ByType_2<Type extends
|
2018
|
+
declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
1986
2019
|
|
1987
2020
|
/**
|
1988
|
-
* Extracts a single event type matching the given key from the {@link
|
2021
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
1989
2022
|
*
|
1990
2023
|
* Alias for {@link Payload}, which may read better in source.
|
1991
2024
|
*
|
1992
2025
|
* @typeParam Type String key specifying the event to extract
|
1993
2026
|
*/
|
1994
|
-
declare type ByType_3<Type extends
|
2027
|
+
declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
1995
2028
|
|
1996
2029
|
/**
|
1997
|
-
* Extracts a single event type matching the given key from the {@link
|
2030
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
1998
2031
|
*
|
1999
2032
|
* Alias for {@link Payload}, which may read better in source.
|
2000
2033
|
*
|
2001
2034
|
* @typeParam Type String key specifying the event to extract
|
2002
2035
|
*/
|
2003
|
-
declare type ByType_4<Type extends
|
2036
|
+
declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
2004
2037
|
|
2005
2038
|
/**
|
2006
|
-
* Extracts a single event type matching the given key from the {@link
|
2039
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
2007
2040
|
*
|
2008
2041
|
* Alias for {@link Payload}, which may read better in source.
|
2009
2042
|
*
|
2010
2043
|
* @typeParam Type String key specifying the event to extract
|
2011
2044
|
*/
|
2012
|
-
declare type ByType_5<Type extends
|
2045
|
+
declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
2013
2046
|
|
2014
2047
|
/**
|
2015
|
-
* Extracts a single event type matching the given key from the {@link
|
2048
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
2016
2049
|
*
|
2017
2050
|
* Alias for {@link Payload}, which may read better in source.
|
2018
2051
|
*
|
2019
2052
|
* @typeParam Type String key specifying the event to extract
|
2020
2053
|
*/
|
2021
|
-
declare type ByType_6<Type extends
|
2054
|
+
declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
2022
2055
|
|
2023
2056
|
/**
|
2024
|
-
* Extracts a single event type matching the given key from the {@link
|
2057
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
2025
2058
|
*
|
2026
2059
|
* Alias for {@link Payload}, which may read better in source.
|
2027
2060
|
*
|
2028
2061
|
* @typeParam Type String key specifying the event to extract
|
2029
2062
|
*/
|
2030
|
-
declare type ByType_7<Type extends
|
2063
|
+
declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
2031
2064
|
|
2032
2065
|
/**
|
2033
|
-
* Extracts a single event type matching the given key from the {@link
|
2066
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
2034
2067
|
*
|
2035
2068
|
* Alias for {@link Payload}, which may read better in source.
|
2036
2069
|
*
|
2037
2070
|
* @typeParam Type String key specifying the event to extract
|
2038
2071
|
*/
|
2039
|
-
declare type ByType_8<Type extends
|
2072
|
+
declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
2040
2073
|
|
2041
2074
|
/**
|
2042
2075
|
* Configuration for page capture.
|
@@ -2719,14 +2752,6 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
|
|
2719
2752
|
|
2720
2753
|
declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
|
2721
2754
|
|
2722
|
-
/**
|
2723
|
-
* Generated when a Channel client is connected.
|
2724
|
-
* @interface
|
2725
|
-
*/
|
2726
|
-
declare type ChannelConnectedEvent = BaseChannelEvent & {
|
2727
|
-
type: 'connected';
|
2728
|
-
};
|
2729
|
-
|
2730
2755
|
/**
|
2731
2756
|
* Options provided on a client connection to a channel.
|
2732
2757
|
*
|
@@ -2758,21 +2783,9 @@ declare type ChannelCreateOptions = {
|
|
2758
2783
|
};
|
2759
2784
|
|
2760
2785
|
/**
|
2761
|
-
*
|
2762
|
-
* @interface
|
2786
|
+
* @deprecated Renamed to {@link Event}.
|
2763
2787
|
*/
|
2764
|
-
declare type
|
2765
|
-
type: 'disconnected';
|
2766
|
-
};
|
2767
|
-
|
2768
|
-
/**
|
2769
|
-
* [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
|
2770
|
-
* discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
|
2771
|
-
* under the {@link OpenFin.ChannelEvents} namespace.
|
2772
|
-
*/
|
2773
|
-
declare type ChannelEvent = {
|
2774
|
-
topic: 'channel';
|
2775
|
-
} & (ChannelConnectedEvent | ChannelDisconnectedEvent);
|
2788
|
+
declare type ChannelEvent = Event_2;
|
2776
2789
|
|
2777
2790
|
declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
|
2778
2791
|
|
@@ -3310,11 +3323,19 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
|
|
3310
3323
|
* Generated when an application is closed.
|
3311
3324
|
* @interface
|
3312
3325
|
*/
|
3313
|
-
declare type ClosedEvent = IdentityEvent & {
|
3326
|
+
declare type ClosedEvent = BaseEvents.IdentityEvent & {
|
3314
3327
|
topic: 'application';
|
3315
3328
|
type: 'closed';
|
3316
3329
|
};
|
3317
3330
|
|
3331
|
+
/**
|
3332
|
+
* Generated when a window has closed.
|
3333
|
+
* @interface
|
3334
|
+
*/
|
3335
|
+
declare type ClosedEvent_2 = BaseEvent_5 & {
|
3336
|
+
type: 'closed';
|
3337
|
+
};
|
3338
|
+
|
3318
3339
|
/**
|
3319
3340
|
* @interface
|
3320
3341
|
*/
|
@@ -3322,6 +3343,15 @@ declare type ClosedMenuResult = {
|
|
3322
3343
|
result: 'closed';
|
3323
3344
|
};
|
3324
3345
|
|
3346
|
+
/**
|
3347
|
+
* Generated when a window has been prevented from closing.
|
3348
|
+
* @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.
|
3349
|
+
* @interface
|
3350
|
+
*/
|
3351
|
+
declare type CloseRequestedEvent = BaseEvent_5 & {
|
3352
|
+
type: 'close-requested';
|
3353
|
+
};
|
3354
|
+
|
3325
3355
|
/**
|
3326
3356
|
* @interface
|
3327
3357
|
*/
|
@@ -3368,6 +3398,14 @@ declare interface CloseWindowPayload {
|
|
3368
3398
|
};
|
3369
3399
|
}
|
3370
3400
|
|
3401
|
+
/**
|
3402
|
+
* Generated when a window has initiated the closing routine.
|
3403
|
+
* @interface
|
3404
|
+
*/
|
3405
|
+
declare type ClosingEvent = BaseEvent_5 & {
|
3406
|
+
type: 'closing';
|
3407
|
+
};
|
3408
|
+
|
3371
3409
|
/**
|
3372
3410
|
* A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
|
3373
3411
|
*/
|
@@ -3505,6 +3543,39 @@ export declare function connect(config: ConnectConfig): Promise<Fin<'external co
|
|
3505
3543
|
|
3506
3544
|
declare type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
|
3507
3545
|
|
3546
|
+
/**
|
3547
|
+
* Generated when a Channel client is connected.
|
3548
|
+
* @interface
|
3549
|
+
*/
|
3550
|
+
declare type ConnectedEvent = BaseEvent_2 & {
|
3551
|
+
type: 'connected';
|
3552
|
+
};
|
3553
|
+
|
3554
|
+
/**
|
3555
|
+
* Generated when an application has authenticated and is connected.
|
3556
|
+
* @interface
|
3557
|
+
*/
|
3558
|
+
declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
|
3559
|
+
topic: 'application';
|
3560
|
+
type: 'connected';
|
3561
|
+
};
|
3562
|
+
|
3563
|
+
/**
|
3564
|
+
* Generated when an external application has authenticated and is connected.
|
3565
|
+
* @interface
|
3566
|
+
*/
|
3567
|
+
declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
|
3568
|
+
type: 'connected';
|
3569
|
+
};
|
3570
|
+
|
3571
|
+
/**
|
3572
|
+
* Generated when a frame is connected.
|
3573
|
+
* @interface
|
3574
|
+
*/
|
3575
|
+
declare type ConnectedEvent_4 = BaseFrameEvent & {
|
3576
|
+
type: 'connected';
|
3577
|
+
};
|
3578
|
+
|
3508
3579
|
declare type Constructor<T = {}> = new () => T;
|
3509
3580
|
|
3510
3581
|
declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
@@ -4246,7 +4317,7 @@ declare type Context_3 = {
|
|
4246
4317
|
* Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
|
4247
4318
|
* @interface
|
4248
4319
|
*/
|
4249
|
-
declare type ContextChangedEvent =
|
4320
|
+
declare type ContextChangedEvent = BaseEvent_5 & {
|
4250
4321
|
type: 'context-changed';
|
4251
4322
|
context: any;
|
4252
4323
|
};
|
@@ -4398,7 +4469,7 @@ declare type CpuInfo = {
|
|
4398
4469
|
* Generated when an application has crashed.
|
4399
4470
|
* @interface
|
4400
4471
|
*/
|
4401
|
-
declare type CrashedEvent = IdentityEvent & {
|
4472
|
+
declare type CrashedEvent = BaseEvents.IdentityEvent & {
|
4402
4473
|
topic: 'application';
|
4403
4474
|
type: 'crashed';
|
4404
4475
|
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
@@ -4449,7 +4520,7 @@ declare type CrashReporterState = CrashReporterOptions & {
|
|
4449
4520
|
* Generated when a View is created.
|
4450
4521
|
* @interface
|
4451
4522
|
*/
|
4452
|
-
declare type CreatedEvent =
|
4523
|
+
declare type CreatedEvent = BaseEvent_4 & {
|
4453
4524
|
type: 'created';
|
4454
4525
|
};
|
4455
4526
|
|
@@ -4608,7 +4679,7 @@ declare interface DesktopAgent_2 {
|
|
4608
4679
|
* Generated when the desktop icon is clicked while it's already running.
|
4609
4680
|
* @interface
|
4610
4681
|
*/
|
4611
|
-
declare type DesktopIconClickedEvent =
|
4682
|
+
declare type DesktopIconClickedEvent = BaseEvent_8 & {
|
4612
4683
|
type: 'desktop-icon-clicked';
|
4613
4684
|
};
|
4614
4685
|
|
@@ -4616,7 +4687,7 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
|
|
4616
4687
|
* Generated when a View is destroyed.
|
4617
4688
|
* @interface
|
4618
4689
|
*/
|
4619
|
-
declare type DestroyedEvent =
|
4690
|
+
declare type DestroyedEvent = BaseEvent_4 & {
|
4620
4691
|
type: 'destroyed';
|
4621
4692
|
};
|
4622
4693
|
|
@@ -4716,6 +4787,30 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
4716
4787
|
type: 'disabled-movement-bounds-changing';
|
4717
4788
|
};
|
4718
4789
|
|
4790
|
+
/**
|
4791
|
+
* Generated when a Channel client has disconnected.
|
4792
|
+
* @interface
|
4793
|
+
*/
|
4794
|
+
declare type DisconnectedEvent = BaseEvent_2 & {
|
4795
|
+
type: 'disconnected';
|
4796
|
+
};
|
4797
|
+
|
4798
|
+
/**
|
4799
|
+
* Generated when an external application has disconnected.
|
4800
|
+
* @interface
|
4801
|
+
*/
|
4802
|
+
declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
|
4803
|
+
type: 'disconnected';
|
4804
|
+
};
|
4805
|
+
|
4806
|
+
/**
|
4807
|
+
* Generated when a frame has disconnected.
|
4808
|
+
* @interface
|
4809
|
+
*/
|
4810
|
+
declare type DisconnectedEvent_3 = BaseFrameEvent & {
|
4811
|
+
type: 'disconnected';
|
4812
|
+
};
|
4813
|
+
|
4719
4814
|
/**
|
4720
4815
|
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
4721
4816
|
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
@@ -4849,7 +4944,7 @@ declare type DownloadShelfOptions = {
|
|
4849
4944
|
*
|
4850
4945
|
* @interface
|
4851
4946
|
*/
|
4852
|
-
declare type DownloadShelfVisibilityChangedEvent =
|
4947
|
+
declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
|
4853
4948
|
type: 'download-shelf-visibility-changed';
|
4854
4949
|
/**
|
4855
4950
|
* True if the download shelf was just opened; false if it was just closed.
|
@@ -4879,7 +4974,7 @@ declare interface DragSource {}
|
|
4879
4974
|
* Generated when a window has been embedded.
|
4880
4975
|
* @interface
|
4881
4976
|
*/
|
4882
|
-
declare type EmbeddedEvent =
|
4977
|
+
declare type EmbeddedEvent = BaseEvent_5 & {
|
4883
4978
|
type: 'embedded';
|
4884
4979
|
};
|
4885
4980
|
|
@@ -4983,7 +5078,7 @@ declare class EmitterMap {
|
|
4983
5078
|
* Generated when a window ends loading.
|
4984
5079
|
* @interface
|
4985
5080
|
*/
|
4986
|
-
declare type EndLoadEvent =
|
5081
|
+
declare type EndLoadEvent = BaseEvent_5 & {
|
4987
5082
|
type: 'end-load';
|
4988
5083
|
documentName: string;
|
4989
5084
|
isMain: boolean;
|
@@ -5100,6 +5195,88 @@ declare type ErrorPlainObject = {
|
|
5100
5195
|
toString(): string;
|
5101
5196
|
};
|
5102
5197
|
|
5198
|
+
/**
|
5199
|
+
* [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
|
5200
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
|
5201
|
+
* under the {@link OpenFin.PlatformEvents} namespace.
|
5202
|
+
*/
|
5203
|
+
declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
|
5204
|
+
|
5205
|
+
/**
|
5206
|
+
* [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
|
5207
|
+
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
5208
|
+
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5209
|
+
* from which they propagate).
|
5210
|
+
*/
|
5211
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
5212
|
+
|
5213
|
+
/**
|
5214
|
+
* [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
|
5215
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
|
5216
|
+
* under the {@link OpenFin.ChannelEvents} namespace.
|
5217
|
+
*/
|
5218
|
+
declare type Event_2 = {
|
5219
|
+
topic: 'channel';
|
5220
|
+
} & (ConnectedEvent | DisconnectedEvent);
|
5221
|
+
|
5222
|
+
/**
|
5223
|
+
* [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
|
5224
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
|
5225
|
+
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5226
|
+
* from which they propagate).
|
5227
|
+
*/
|
5228
|
+
declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
|
5229
|
+
|
5230
|
+
/**
|
5231
|
+
* [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
|
5232
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
|
5233
|
+
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5234
|
+
*/
|
5235
|
+
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
5236
|
+
target: OpenFin.Identity;
|
5237
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
5238
|
+
|
5239
|
+
/**
|
5240
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
5241
|
+
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
5242
|
+
*/
|
5243
|
+
declare type Event_5<Topic extends string> = {
|
5244
|
+
topic: Topic;
|
5245
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
5246
|
+
|
5247
|
+
/**
|
5248
|
+
* [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
|
5249
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
|
5250
|
+
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5251
|
+
*/
|
5252
|
+
declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
|
5253
|
+
|
5254
|
+
/**
|
5255
|
+
* [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
|
5256
|
+
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5257
|
+
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5258
|
+
*/
|
5259
|
+
declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
|
5260
|
+
|
5261
|
+
/**
|
5262
|
+
* [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
|
5263
|
+
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
5264
|
+
* under the {@link OpenFin.FrameEvents} namespace.
|
5265
|
+
*/
|
5266
|
+
declare type Event_8 = {
|
5267
|
+
topic: 'frame';
|
5268
|
+
} & (ConnectedEvent_4 | DisconnectedEvent_3);
|
5269
|
+
|
5270
|
+
/**
|
5271
|
+
* [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
|
5272
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
5273
|
+
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
5274
|
+
*/
|
5275
|
+
declare type Event_9 = {
|
5276
|
+
topic: 'global-hotkey';
|
5277
|
+
hotkey: 'string';
|
5278
|
+
} & (RegisteredEvent | UnregisteredEvent);
|
5279
|
+
|
5103
5280
|
declare class EventAggregator extends EmitterMap {
|
5104
5281
|
dispatchEvent: (message: Message<any>) => boolean;
|
5105
5282
|
}
|
@@ -5142,28 +5319,68 @@ declare interface EventEmitter_2 {
|
|
5142
5319
|
}
|
5143
5320
|
|
5144
5321
|
/**
|
5145
|
-
* Handler for an event on an EventEmitter.
|
5146
|
-
* @remarks Selects the correct type for the event
|
5147
|
-
* payload from the provided union based on the provided string literal type.
|
5322
|
+
* Handler for an event on an EventEmitter.
|
5323
|
+
* @remarks Selects the correct type for the event
|
5324
|
+
* payload from the provided union based on the provided string literal type.
|
5325
|
+
*/
|
5326
|
+
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
|
5327
|
+
type: EventType;
|
5328
|
+
}>, ...args: any[]) => void;
|
5329
|
+
|
5330
|
+
declare namespace Events {
|
5331
|
+
export {
|
5332
|
+
ApplicationEvents,
|
5333
|
+
BaseEvents,
|
5334
|
+
ExternalApplicationEvents,
|
5335
|
+
FrameEvents,
|
5336
|
+
GlobalHotkeyEvents,
|
5337
|
+
PlatformEvents,
|
5338
|
+
SystemEvents,
|
5339
|
+
ViewEvents,
|
5340
|
+
WebContentsEvents,
|
5341
|
+
WindowEvents
|
5342
|
+
}
|
5343
|
+
}
|
5344
|
+
|
5345
|
+
/**
|
5346
|
+
* Union of possible `type` values for a view {@link Event}.
|
5347
|
+
*/
|
5348
|
+
declare type EventType = Event_4['type'];
|
5349
|
+
|
5350
|
+
/**
|
5351
|
+
* Union of possible `type` values for a Window {@link Event}.
|
5352
|
+
*/
|
5353
|
+
declare type EventType_2 = Event_6['type'];
|
5354
|
+
|
5355
|
+
/**
|
5356
|
+
* Union of possible `type` values for an Application {@link Event}.
|
5357
|
+
*/
|
5358
|
+
declare type EventType_3 = Event_3['type'];
|
5359
|
+
|
5360
|
+
/**
|
5361
|
+
* Union of possible `type` values for an ExternalApplication {@link Event}.
|
5362
|
+
*/
|
5363
|
+
declare type EventType_4 = Event_7['type'];
|
5364
|
+
|
5365
|
+
/**
|
5366
|
+
* Union of possible `type` values for a {@link FrameEvent}.
|
5367
|
+
*/
|
5368
|
+
declare type EventType_5 = Event_8['type'];
|
5369
|
+
|
5370
|
+
/**
|
5371
|
+
* Union of possible `type` values for a {@link GlobalHotkeyEvent}
|
5372
|
+
*/
|
5373
|
+
declare type EventType_6 = Event_9['type'];
|
5374
|
+
|
5375
|
+
/**
|
5376
|
+
* Union of possible `type` values for a {@link PlatformEvent}.
|
5377
|
+
*/
|
5378
|
+
declare type EventType_7 = Event_10['type'];
|
5379
|
+
|
5380
|
+
/**
|
5381
|
+
* Union of possible `type` values for a {@link SystemEvent}.
|
5148
5382
|
*/
|
5149
|
-
declare type
|
5150
|
-
type: EventType;
|
5151
|
-
}>, ...args: any[]) => void;
|
5152
|
-
|
5153
|
-
declare namespace Events {
|
5154
|
-
export {
|
5155
|
-
ApplicationEvents,
|
5156
|
-
BaseEvents,
|
5157
|
-
ExternalApplicationEvents,
|
5158
|
-
FrameEvents,
|
5159
|
-
GlobalHotkeyEvents,
|
5160
|
-
PlatformEvents,
|
5161
|
-
SystemEvents,
|
5162
|
-
ViewEvents,
|
5163
|
-
WebContentsEvents,
|
5164
|
-
WindowEvents
|
5165
|
-
}
|
5166
|
-
}
|
5383
|
+
declare type EventType_8 = SystemEvent['type'];
|
5167
5384
|
|
5168
5385
|
/**
|
5169
5386
|
* @internal
|
@@ -5178,6 +5395,8 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
|
|
5178
5395
|
|
5179
5396
|
/**
|
5180
5397
|
* @internal
|
5398
|
+
*
|
5399
|
+
* Ensures that an event payload type does not include any `-requested` events. Distributes over unions.
|
5181
5400
|
*/
|
5182
5401
|
declare type ExcludeRequested<Event extends {
|
5183
5402
|
type: string;
|
@@ -5307,46 +5526,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
|
|
5307
5526
|
}
|
5308
5527
|
|
5309
5528
|
/**
|
5310
|
-
*
|
5311
|
-
* @interface
|
5529
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
5312
5530
|
*/
|
5313
|
-
declare type ExternalApplicationConnectedEvent =
|
5314
|
-
type: 'connected';
|
5315
|
-
};
|
5531
|
+
declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
|
5316
5532
|
|
5317
5533
|
/**
|
5318
|
-
*
|
5319
|
-
* @interface
|
5534
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
5320
5535
|
*/
|
5321
|
-
declare type ExternalApplicationDisconnectedEvent =
|
5322
|
-
type: 'disconnected';
|
5323
|
-
};
|
5536
|
+
declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
|
5324
5537
|
|
5325
5538
|
/**
|
5326
|
-
*
|
5327
|
-
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5328
|
-
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5539
|
+
* @deprecated Renamed to {@link Event}.
|
5329
5540
|
*/
|
5330
|
-
declare type ExternalApplicationEvent =
|
5541
|
+
declare type ExternalApplicationEvent = Event_7;
|
5331
5542
|
|
5332
5543
|
declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
|
5333
5544
|
|
5334
5545
|
declare namespace ExternalApplicationEvents {
|
5335
5546
|
export {
|
5547
|
+
BaseEvent_6 as BaseEvent,
|
5336
5548
|
BaseExternalApplicationEvent,
|
5549
|
+
ConnectedEvent_3 as ConnectedEvent,
|
5337
5550
|
ExternalApplicationConnectedEvent,
|
5551
|
+
DisconnectedEvent_2 as DisconnectedEvent,
|
5338
5552
|
ExternalApplicationDisconnectedEvent,
|
5553
|
+
Event_7 as Event,
|
5339
5554
|
ExternalApplicationEvent,
|
5555
|
+
EventType_4 as EventType,
|
5340
5556
|
ExternalApplicationEventType,
|
5341
|
-
|
5342
|
-
|
5557
|
+
Payload_5 as Payload,
|
5558
|
+
ByType_4 as ByType
|
5343
5559
|
}
|
5344
5560
|
}
|
5345
5561
|
|
5346
5562
|
/**
|
5347
|
-
*
|
5563
|
+
* @deprecated Renamed to {@link Event}.
|
5348
5564
|
*/
|
5349
|
-
declare type ExternalApplicationEventType =
|
5565
|
+
declare type ExternalApplicationEventType = EventType_4;
|
5350
5566
|
|
5351
5567
|
/**
|
5352
5568
|
* @interface
|
@@ -5411,7 +5627,7 @@ declare type ExternalConnection = {
|
|
5411
5627
|
* Generated when an external process has exited.
|
5412
5628
|
* @interface
|
5413
5629
|
*/
|
5414
|
-
declare type ExternalProcessExitedEvent =
|
5630
|
+
declare type ExternalProcessExitedEvent = BaseEvent_5 & {
|
5415
5631
|
type: 'external-process-exited';
|
5416
5632
|
processUuid: string;
|
5417
5633
|
exitCode: number;
|
@@ -5456,19 +5672,15 @@ declare type ExternalProcessRequestType = {
|
|
5456
5672
|
* Generated when an external process has started.
|
5457
5673
|
* @interface
|
5458
5674
|
*/
|
5459
|
-
declare type ExternalProcessStartedEvent =
|
5675
|
+
declare type ExternalProcessStartedEvent = BaseEvent_5 & {
|
5460
5676
|
type: 'external-process-started';
|
5461
5677
|
processUuid: string;
|
5462
5678
|
};
|
5463
5679
|
|
5464
5680
|
/**
|
5465
|
-
*
|
5466
|
-
* @interface
|
5681
|
+
* @deprecated, use {@link PageFaviconUpdatedEvent}.
|
5467
5682
|
*/
|
5468
|
-
declare type FaviconUpdatedEvent =
|
5469
|
-
type: 'page-favicon-updated';
|
5470
|
-
favicons: string[];
|
5471
|
-
};
|
5683
|
+
declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
|
5472
5684
|
|
5473
5685
|
declare namespace FDC3 {
|
5474
5686
|
export {
|
@@ -5555,7 +5767,7 @@ declare type FileDownloadEvent = {
|
|
5555
5767
|
*
|
5556
5768
|
* @interface
|
5557
5769
|
*/
|
5558
|
-
declare type FileDownloadLocationChangedEvent =
|
5770
|
+
declare type FileDownloadLocationChangedEvent = BaseEvent_3 & {
|
5559
5771
|
type: 'file-download-location-changed';
|
5560
5772
|
};
|
5561
5773
|
|
@@ -5849,48 +6061,43 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
5849
6061
|
}
|
5850
6062
|
|
5851
6063
|
/**
|
5852
|
-
*
|
5853
|
-
* @interface
|
6064
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
5854
6065
|
*/
|
5855
|
-
declare type FrameConnectedEvent =
|
5856
|
-
type: 'connected';
|
5857
|
-
};
|
6066
|
+
declare type FrameConnectedEvent = ConnectedEvent_4;
|
5858
6067
|
|
5859
6068
|
/**
|
5860
|
-
*
|
5861
|
-
* @interface
|
6069
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
5862
6070
|
*/
|
5863
|
-
declare type FrameDisconnectedEvent =
|
5864
|
-
type: 'disconnected';
|
5865
|
-
};
|
6071
|
+
declare type FrameDisconnectedEvent = DisconnectedEvent_3;
|
5866
6072
|
|
5867
6073
|
/**
|
5868
|
-
*
|
5869
|
-
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
5870
|
-
* under the {@link OpenFin.FrameEvents} namespace.
|
6074
|
+
* @deprecated Renamed to {@link Event}.
|
5871
6075
|
*/
|
5872
|
-
declare type FrameEvent =
|
5873
|
-
topic: 'frame';
|
5874
|
-
} & (FrameConnectedEvent | FrameDisconnectedEvent);
|
6076
|
+
declare type FrameEvent = Event_8;
|
5875
6077
|
|
5876
6078
|
declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
|
5877
6079
|
|
5878
6080
|
declare namespace FrameEvents {
|
5879
6081
|
export {
|
6082
|
+
BaseEvent_7 as BaseEvent,
|
5880
6083
|
BaseFrameEvent,
|
6084
|
+
ConnectedEvent_4 as ConnectedEvent,
|
5881
6085
|
FrameConnectedEvent,
|
6086
|
+
DisconnectedEvent_3 as DisconnectedEvent,
|
5882
6087
|
FrameDisconnectedEvent,
|
6088
|
+
Event_8 as Event,
|
5883
6089
|
FrameEvent,
|
6090
|
+
EventType_5 as EventType,
|
5884
6091
|
FrameEventType,
|
5885
|
-
|
5886
|
-
|
6092
|
+
Payload_6 as Payload,
|
6093
|
+
ByType_5 as ByType
|
5887
6094
|
}
|
5888
6095
|
}
|
5889
6096
|
|
5890
6097
|
/**
|
5891
|
-
*
|
6098
|
+
* @deprecated Renamed to {@link EventType}.
|
5892
6099
|
*/
|
5893
|
-
declare type FrameEventType =
|
6100
|
+
declare type FrameEventType = EventType_5;
|
5894
6101
|
|
5895
6102
|
/**
|
5896
6103
|
* @interface
|
@@ -6112,14 +6319,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
|
|
6112
6319
|
}
|
6113
6320
|
|
6114
6321
|
/**
|
6115
|
-
*
|
6116
|
-
* discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
6117
|
-
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
6322
|
+
* @deprecated Renamed to {@link Event}.
|
6118
6323
|
*/
|
6119
|
-
declare type GlobalHotkeyEvent =
|
6120
|
-
topic: 'global-hotkey';
|
6121
|
-
hotkey: 'string';
|
6122
|
-
} & (RegisteredEvent | UnregisteredEvent);
|
6324
|
+
declare type GlobalHotkeyEvent = Event_9;
|
6123
6325
|
|
6124
6326
|
declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
6125
6327
|
|
@@ -6127,17 +6329,19 @@ declare namespace GlobalHotkeyEvents {
|
|
6127
6329
|
export {
|
6128
6330
|
RegisteredEvent,
|
6129
6331
|
UnregisteredEvent,
|
6332
|
+
Event_9 as Event,
|
6130
6333
|
GlobalHotkeyEvent,
|
6334
|
+
EventType_6 as EventType,
|
6131
6335
|
GlobalHotkeyEventType,
|
6132
|
-
|
6133
|
-
|
6336
|
+
Payload_7 as Payload,
|
6337
|
+
ByType_6 as ByType
|
6134
6338
|
}
|
6135
6339
|
}
|
6136
6340
|
|
6137
6341
|
/**
|
6138
|
-
*
|
6342
|
+
* @deprecated Renamed to {@link EventType}.
|
6139
6343
|
*/
|
6140
|
-
declare type GlobalHotkeyEventType =
|
6344
|
+
declare type GlobalHotkeyEventType = EventType_6;
|
6141
6345
|
|
6142
6346
|
declare namespace GoldenLayout {
|
6143
6347
|
export {
|
@@ -6439,8 +6643,17 @@ declare interface Header {
|
|
6439
6643
|
* Generated when a View is hidden.
|
6440
6644
|
* @interface
|
6441
6645
|
*/
|
6442
|
-
declare type HiddenEvent =
|
6646
|
+
declare type HiddenEvent = BaseEvent_4 & {
|
6647
|
+
type: 'hidden';
|
6648
|
+
};
|
6649
|
+
|
6650
|
+
/**
|
6651
|
+
* Generated when a window has been hidden.
|
6652
|
+
* @interface
|
6653
|
+
*/
|
6654
|
+
declare type HiddenEvent_2 = BaseEvent_5 & {
|
6443
6655
|
type: 'hidden';
|
6656
|
+
reason: 'closing' | 'hide' | 'hide-on-close';
|
6444
6657
|
};
|
6445
6658
|
|
6446
6659
|
/**
|
@@ -6448,7 +6661,7 @@ declare type HiddenEvent = BaseViewEvent & {
|
|
6448
6661
|
* or because the View has moved to a new window. Only available on Views in a Platform.
|
6449
6662
|
* @interface
|
6450
6663
|
*/
|
6451
|
-
declare type HostContextChangedEvent =
|
6664
|
+
declare type HostContextChangedEvent = BaseEvent_4 & {
|
6452
6665
|
type: 'host-context-changed';
|
6453
6666
|
context: any;
|
6454
6667
|
reason: 'reparented' | 'updated';
|
@@ -6527,7 +6740,16 @@ declare type Hotkey = {
|
|
6527
6740
|
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
6528
6741
|
* @interface
|
6529
6742
|
*/
|
6530
|
-
declare type HotkeyEvent =
|
6743
|
+
declare type HotkeyEvent = BaseEvent_4 & {
|
6744
|
+
type: 'hotkey';
|
6745
|
+
};
|
6746
|
+
|
6747
|
+
/**
|
6748
|
+
* Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
|
6749
|
+
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
6750
|
+
* @interface
|
6751
|
+
*/
|
6752
|
+
declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
|
6531
6753
|
type: 'hotkey';
|
6532
6754
|
};
|
6533
6755
|
|
@@ -6583,6 +6805,11 @@ declare type IdentityEvent = BaseEvent & {
|
|
6583
6805
|
*/
|
6584
6806
|
declare type IdEventType = WithId<AppVersionEventType>;
|
6585
6807
|
|
6808
|
+
/**
|
6809
|
+
* @deprecated Renamed to {@link IdleStateChangedEvent}.
|
6810
|
+
*/
|
6811
|
+
declare type IdleEvent = IdleStateChangedEvent;
|
6812
|
+
|
6586
6813
|
/**
|
6587
6814
|
* Generated when a user enters or returns from idle state.
|
6588
6815
|
* @remarks This method is continuously generated every minute while the user is in idle.
|
@@ -6590,7 +6817,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
|
|
6590
6817
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
6591
6818
|
* @interface
|
6592
6819
|
*/
|
6593
|
-
declare type
|
6820
|
+
declare type IdleStateChangedEvent = BaseEvent_8 & {
|
6594
6821
|
type: 'idle-state-changed';
|
6595
6822
|
elapsedTime: number;
|
6596
6823
|
isIdle: boolean;
|
@@ -6675,11 +6902,19 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
6675
6902
|
* Generated when an application has initialized.
|
6676
6903
|
* @interface
|
6677
6904
|
*/
|
6678
|
-
declare type InitializedEvent = IdentityEvent & {
|
6905
|
+
declare type InitializedEvent = BaseEvents.IdentityEvent & {
|
6679
6906
|
topic: 'application';
|
6680
6907
|
type: 'initialized';
|
6681
6908
|
};
|
6682
6909
|
|
6910
|
+
/**
|
6911
|
+
* Generated when a window is initialized.
|
6912
|
+
* @interface
|
6913
|
+
*/
|
6914
|
+
declare type InitializedEvent_2 = BaseEvent_5 & {
|
6915
|
+
type: 'initialized';
|
6916
|
+
};
|
6917
|
+
|
6683
6918
|
/**
|
6684
6919
|
* @interface
|
6685
6920
|
*/
|
@@ -8783,7 +9018,7 @@ declare type LayoutIdentity = Identity_5 & {
|
|
8783
9018
|
* Generated when a window and all of its layout's views have either finished or failed navigation.
|
8784
9019
|
* @interface
|
8785
9020
|
*/
|
8786
|
-
declare type LayoutInitializedEvent =
|
9021
|
+
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
8787
9022
|
type: 'layout-initialized';
|
8788
9023
|
ofViews: (OpenFin.Identity & {
|
8789
9024
|
entityType: 'view';
|
@@ -9320,7 +9555,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
9320
9555
|
* Generated when a window and all of its layout's views have been created and can receive API calls.
|
9321
9556
|
* @interface
|
9322
9557
|
*/
|
9323
|
-
declare type LayoutReadyEvent =
|
9558
|
+
declare type LayoutReadyEvent = BaseEvent_5 & {
|
9324
9559
|
type: 'layout-ready';
|
9325
9560
|
views: (OpenFin.Identity & {
|
9326
9561
|
success: boolean;
|
@@ -9461,7 +9696,7 @@ declare type Manifest = {
|
|
9461
9696
|
* Generated when the RVM notifies an application that the manifest has changed.
|
9462
9697
|
* @interface
|
9463
9698
|
*/
|
9464
|
-
declare type ManifestChangedEvent = IdentityEvent & {
|
9699
|
+
declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
|
9465
9700
|
topic: 'application';
|
9466
9701
|
type: 'manifest-changed';
|
9467
9702
|
};
|
@@ -9514,7 +9749,7 @@ declare type MatchPattern = string;
|
|
9514
9749
|
* Generated when a window is maximized.
|
9515
9750
|
* @interface
|
9516
9751
|
*/
|
9517
|
-
declare type MaximizedEvent =
|
9752
|
+
declare type MaximizedEvent = BaseEvent_5 & {
|
9518
9753
|
type: 'maximized';
|
9519
9754
|
};
|
9520
9755
|
|
@@ -9624,7 +9859,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
|
|
9624
9859
|
* Generated when a window is minimized.
|
9625
9860
|
* @interface
|
9626
9861
|
*/
|
9627
|
-
declare type MinimizedEvent =
|
9862
|
+
declare type MinimizedEvent = BaseEvent_5 & {
|
9628
9863
|
type: 'minimized';
|
9629
9864
|
};
|
9630
9865
|
|
@@ -9668,14 +9903,9 @@ declare type MonitorDetails = {
|
|
9668
9903
|
};
|
9669
9904
|
|
9670
9905
|
/**
|
9671
|
-
*
|
9672
|
-
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
9673
|
-
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
9674
|
-
* @interface
|
9906
|
+
* @deprecated Renamed to {@link MonitorInfoChangedEvent}.
|
9675
9907
|
*/
|
9676
|
-
declare type MonitorEvent =
|
9677
|
-
type: 'monitor-info-changed';
|
9678
|
-
};
|
9908
|
+
declare type MonitorEvent = MonitorInfoChangedEvent;
|
9679
9909
|
|
9680
9910
|
/**
|
9681
9911
|
* @interface
|
@@ -9699,6 +9929,16 @@ declare type MonitorInfo = {
|
|
9699
9929
|
virtualScreen: DipRect;
|
9700
9930
|
};
|
9701
9931
|
|
9932
|
+
/**
|
9933
|
+
* Generated on changes of a monitor's size/location.
|
9934
|
+
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
9935
|
+
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
9936
|
+
* @interface
|
9937
|
+
*/
|
9938
|
+
declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
|
9939
|
+
type: 'monitor-info-changed';
|
9940
|
+
};
|
9941
|
+
|
9702
9942
|
/**
|
9703
9943
|
* @interface
|
9704
9944
|
*/
|
@@ -10105,14 +10345,23 @@ declare type NonPropagatedWindowEvent = never;
|
|
10105
10345
|
|
10106
10346
|
/**
|
10107
10347
|
* @internal
|
10348
|
+
*
|
10349
|
+
* Ensures that an event type key does not include any `close-requested` events. Distributes over unions.
|
10350
|
+
*/
|
10351
|
+
declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'close-requested'>;
|
10352
|
+
|
10353
|
+
/**
|
10354
|
+
* @internal
|
10355
|
+
*
|
10356
|
+
* Ensures that an event type key doesn't include any `-requested` events. Distributes over unions.
|
10108
10357
|
*/
|
10109
|
-
declare type NotRequested<EventType> = EventType extends `${infer U}-requested` ? never : EventType;
|
10358
|
+
declare type NotRequested<EventType extends String> = EventType extends `${infer U}-requested` ? never : EventType;
|
10110
10359
|
|
10111
10360
|
/**
|
10112
10361
|
* Generated when an application is not responding.
|
10113
10362
|
* @interface
|
10114
10363
|
*/
|
10115
|
-
declare type NotRespondingEvent = IdentityEvent & {
|
10364
|
+
declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
|
10116
10365
|
topic: 'application';
|
10117
10366
|
type: 'not-responding';
|
10118
10367
|
};
|
@@ -10438,7 +10687,7 @@ declare namespace OpenFin {
|
|
10438
10687
|
AppVersionCompleteEvent,
|
10439
10688
|
AppVersionRuntimeStatusEvent,
|
10440
10689
|
Events,
|
10441
|
-
|
10690
|
+
BaseEvent_9 as BaseEvent,
|
10442
10691
|
WebContentsEvent_2 as WebContentsEvent,
|
10443
10692
|
SystemEvent_2 as SystemEvent,
|
10444
10693
|
ApplicationEvent_2 as ApplicationEvent,
|
@@ -10480,12 +10729,32 @@ export default OpenFin;
|
|
10480
10729
|
|
10481
10730
|
declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
|
10482
10731
|
|
10732
|
+
/**
|
10733
|
+
* Generated after window options are changed using the window.updateOptions method.
|
10734
|
+
* @remarks Will not fire if the diff object is empty.
|
10735
|
+
* @interface
|
10736
|
+
*/
|
10737
|
+
declare type OptionsChangedEvent = BaseEvent_5 & {
|
10738
|
+
type: 'options-changed';
|
10739
|
+
options: OpenFin.WindowOptions;
|
10740
|
+
diff: OpenFin.WindowOptionDiff;
|
10741
|
+
};
|
10742
|
+
|
10483
10743
|
declare type OverlapsOnlyIfMatching<T, U> = {
|
10484
10744
|
[K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
|
10485
10745
|
};
|
10486
10746
|
|
10487
10747
|
declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
10488
10748
|
|
10749
|
+
/**
|
10750
|
+
* Generated when page receives favicon urls.
|
10751
|
+
* @interface
|
10752
|
+
*/
|
10753
|
+
declare type PageFaviconUpdatedEvent = NamedEvent & {
|
10754
|
+
type: 'page-favicon-updated';
|
10755
|
+
favicons: string[];
|
10756
|
+
};
|
10757
|
+
|
10489
10758
|
/**
|
10490
10759
|
* Generated when page title is set during navigation.
|
10491
10760
|
* @remarks explicitSet is false when title is synthesized from file url.
|
@@ -10504,74 +10773,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10504
10773
|
};
|
10505
10774
|
|
10506
10775
|
/**
|
10507
|
-
* Extracts a single event type matching the given key from the {@link
|
10776
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
10508
10777
|
*
|
10509
10778
|
* @typeParam Type String key specifying the event to extract
|
10510
10779
|
*/
|
10511
|
-
declare type Payload_2<Type extends
|
10780
|
+
declare type Payload_2<Type extends EventType> = Extract<Event_4, {
|
10512
10781
|
type: Type;
|
10513
10782
|
}>;
|
10514
10783
|
|
10515
10784
|
/**
|
10516
|
-
* Extracts a single event type matching the given key from the {@link
|
10785
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
10517
10786
|
*
|
10518
10787
|
* @typeParam Type String key specifying the event to extract
|
10519
10788
|
*/
|
10520
|
-
declare type Payload_3<Type extends
|
10789
|
+
declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
|
10521
10790
|
type: Type;
|
10522
10791
|
}>;
|
10523
10792
|
|
10524
10793
|
/**
|
10525
|
-
* Extracts a single event type matching the given key from the {@link
|
10794
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
10526
10795
|
*
|
10527
10796
|
* @typeParam Type String key specifying the event to extract
|
10528
10797
|
*/
|
10529
|
-
declare type Payload_4<Type extends
|
10798
|
+
declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
|
10530
10799
|
type: Type;
|
10531
10800
|
}>;
|
10532
10801
|
|
10533
10802
|
/**
|
10534
|
-
* Extracts a single event type matching the given key from the {@link
|
10803
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
10535
10804
|
*
|
10536
10805
|
* @typeParam Type String key specifying the event to extract
|
10537
10806
|
*/
|
10538
|
-
declare type Payload_5<Type extends
|
10807
|
+
declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
|
10539
10808
|
type: Type;
|
10540
10809
|
}>;
|
10541
10810
|
|
10542
10811
|
/**
|
10543
|
-
* Extracts a single event type matching the given key from the {@link
|
10812
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
10544
10813
|
*
|
10545
10814
|
* @typeParam Type String key specifying the event to extract
|
10546
10815
|
*/
|
10547
|
-
declare type Payload_6<Type extends
|
10816
|
+
declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
|
10548
10817
|
type: Type;
|
10549
10818
|
}>;
|
10550
10819
|
|
10551
10820
|
/**
|
10552
|
-
* Extracts a single event type matching the given key from the {@link
|
10821
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
10553
10822
|
*
|
10554
10823
|
* @typeParam Type String key specifying the event to extract
|
10555
10824
|
*/
|
10556
|
-
declare type Payload_7<Type extends
|
10825
|
+
declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
|
10557
10826
|
type: Type;
|
10558
10827
|
}>;
|
10559
10828
|
|
10560
10829
|
/**
|
10561
|
-
* Extracts a single event type matching the given key from the {@link
|
10830
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
10562
10831
|
*
|
10563
10832
|
* @typeParam Type String key specifying the event to extract
|
10564
10833
|
*/
|
10565
|
-
declare type Payload_8<Type extends
|
10834
|
+
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
10566
10835
|
type: Type;
|
10567
10836
|
}>;
|
10568
10837
|
|
10569
10838
|
/**
|
10570
|
-
* Extracts a single event type matching the given key from the {@link
|
10839
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
10571
10840
|
*
|
10572
10841
|
* @typeParam Type String key specifying the event to extract
|
10573
10842
|
*/
|
10574
|
-
declare type Payload_9<Type extends
|
10843
|
+
declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
|
10575
10844
|
type: Type;
|
10576
10845
|
}>;
|
10577
10846
|
|
@@ -10581,7 +10850,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
|
|
10581
10850
|
* Generated when window finishes loading. Provides performance and navigation data.
|
10582
10851
|
* @interface
|
10583
10852
|
*/
|
10584
|
-
declare type PerformanceReportEvent = Performance &
|
10853
|
+
declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
10585
10854
|
type: 'performance-report';
|
10586
10855
|
};
|
10587
10856
|
|
@@ -11245,38 +11514,36 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
|
|
11245
11514
|
}
|
11246
11515
|
|
11247
11516
|
/**
|
11248
|
-
*
|
11249
|
-
* @interface
|
11517
|
+
* @deprecated Renamed to {@link ApiReadyEvent}.
|
11250
11518
|
*/
|
11251
|
-
declare type PlatformApiReadyEvent =
|
11252
|
-
topic: 'application';
|
11253
|
-
type: 'platform-api-ready';
|
11254
|
-
};
|
11519
|
+
declare type PlatformApiReadyEvent = ApiReadyEvent;
|
11255
11520
|
|
11256
11521
|
/**
|
11257
|
-
*
|
11258
|
-
* discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
|
11259
|
-
* under the {@link OpenFin.PlatformEvents} namespace.
|
11522
|
+
* @deprecated Renamed to {@link Event}.
|
11260
11523
|
*/
|
11261
|
-
declare type PlatformEvent =
|
11524
|
+
declare type PlatformEvent = Event_10;
|
11262
11525
|
|
11263
11526
|
declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
|
11264
11527
|
|
11265
11528
|
declare namespace PlatformEvents {
|
11266
11529
|
export {
|
11530
|
+
ApiReadyEvent,
|
11267
11531
|
PlatformApiReadyEvent,
|
11532
|
+
SnapshotAppliedEvent,
|
11268
11533
|
PlatformSnapshotAppliedEvent,
|
11534
|
+
Event_10 as Event,
|
11269
11535
|
PlatformEvent,
|
11536
|
+
EventType_7 as EventType,
|
11270
11537
|
PlatformEventType,
|
11271
|
-
|
11272
|
-
|
11538
|
+
Payload_8 as Payload,
|
11539
|
+
ByType_7 as ByType
|
11273
11540
|
}
|
11274
11541
|
}
|
11275
11542
|
|
11276
11543
|
/**
|
11277
|
-
*
|
11544
|
+
* @deprecated Renamed to {@link }.
|
11278
11545
|
*/
|
11279
|
-
declare type PlatformEventType =
|
11546
|
+
declare type PlatformEventType = EventType_7;
|
11280
11547
|
|
11281
11548
|
/**
|
11282
11549
|
* Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
|
@@ -11556,11 +11823,14 @@ declare interface PlatformProvider {
|
|
11556
11823
|
* Calls platform.createView for every view in the given layout. Returns an array of promises
|
11557
11824
|
* one promise for each view create call
|
11558
11825
|
*
|
11559
|
-
* @param
|
11560
|
-
* @param
|
11826
|
+
* @param payload
|
11827
|
+
* @param callerIdentity
|
11561
11828
|
* @returns an array of promises
|
11562
11829
|
*/
|
11563
|
-
createViewsForLayout(
|
11830
|
+
createViewsForLayout(payload: {
|
11831
|
+
layout: GoldenLayout.Config;
|
11832
|
+
target?: OpenFin.Identity;
|
11833
|
+
}, callerIdentity: OpenFin.Identity): Promise<OpenFin.View>[];
|
11564
11834
|
/**
|
11565
11835
|
* **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
|
11566
11836
|
* Gets the current state of a single view and returns an object with the options needed to restore that view as part of a snapshot.
|
@@ -12001,19 +12271,9 @@ declare interface PlatformProvider {
|
|
12001
12271
|
}
|
12002
12272
|
|
12003
12273
|
/**
|
12004
|
-
*
|
12005
|
-
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
12006
|
-
* 1. The window has been created
|
12007
|
-
* 2. The window has a responsive API
|
12008
|
-
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
12009
|
-
*
|
12010
|
-
* _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.
|
12011
|
-
* @interface
|
12274
|
+
* @deprecated Renamed to {@link SnapshotAppliedEvent}.
|
12012
12275
|
*/
|
12013
|
-
declare type PlatformSnapshotAppliedEvent =
|
12014
|
-
topic: 'application';
|
12015
|
-
type: 'platform-snapshot-applied';
|
12016
|
-
};
|
12276
|
+
declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
|
12017
12277
|
|
12018
12278
|
/**
|
12019
12279
|
* @interface
|
@@ -12281,7 +12541,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
|
|
12281
12541
|
* A general preload scripts state change event without event type.
|
12282
12542
|
* @interface
|
12283
12543
|
*/
|
12284
|
-
declare type PreloadScriptsStateChangeEvent =
|
12544
|
+
declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
|
12285
12545
|
preloadScripts: (PreloadScriptInfoRunning & any)[];
|
12286
12546
|
};
|
12287
12547
|
|
@@ -12490,51 +12750,43 @@ declare type ProcessLoggingOptions = {
|
|
12490
12750
|
};
|
12491
12751
|
|
12492
12752
|
/**
|
12493
|
-
*
|
12494
|
-
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
12495
|
-
* are propagated to `System` without any type string prefixing.
|
12496
|
-
*
|
12497
|
-
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
12753
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
12498
12754
|
*/
|
12499
|
-
declare type PropagatedApplicationEvent<TargetTopic extends string> =
|
12755
|
+
declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
|
12500
12756
|
|
12501
12757
|
/**
|
12502
|
-
*
|
12758
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
12503
12759
|
*/
|
12504
|
-
declare type PropagatedApplicationEventType =
|
12760
|
+
declare type PropagatedApplicationEventType = PropagatedEventType_3;
|
12505
12761
|
|
12506
12762
|
/**
|
12507
|
-
* Modifies an event shape to reflect propagation to a parent topic.
|
12763
|
+
* Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
|
12764
|
+
* these do not propagate.
|
12765
|
+
*
|
12508
12766
|
* @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
|
12767
|
+
*
|
12768
|
+
* @typeParam SourceTopic The topic the event shape is propagating from.
|
12769
|
+
* @typeParam TargetTopic The topic the event shape is propagating to.
|
12770
|
+
* @typeParam Event The shape of the event being propagated.
|
12509
12771
|
*/
|
12510
12772
|
declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
|
12511
12773
|
type: string;
|
12512
12774
|
}> = Event extends infer E extends {
|
12513
12775
|
type: string;
|
12514
|
-
} ? Omit<E, 'type' | 'topic'> & {
|
12776
|
+
} ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
|
12515
12777
|
type: PropagatedEventType<SourceTopic, E['type']>;
|
12516
12778
|
topic: TargetTopic;
|
12517
12779
|
} : never;
|
12518
12780
|
|
12519
|
-
/**
|
12520
|
-
* Modifies an event key to reflect propagation by prefixing with the topic.
|
12521
|
-
*/
|
12522
|
-
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
|
12523
|
-
|
12524
12781
|
/**
|
12525
12782
|
* A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
|
12526
12783
|
* or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
|
12527
12784
|
* event type key with `'view-'`.
|
12528
12785
|
*/
|
12529
|
-
declare type
|
12786
|
+
declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
|
12530
12787
|
viewIdentity: OpenFin.Identity;
|
12531
12788
|
};
|
12532
12789
|
|
12533
|
-
/**
|
12534
|
-
* Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
|
12535
|
-
*/
|
12536
|
-
declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
12537
|
-
|
12538
12790
|
/**
|
12539
12791
|
* A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
|
12540
12792
|
* prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
|
@@ -12543,12 +12795,51 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
|
12543
12795
|
*
|
12544
12796
|
* "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
|
12545
12797
|
*/
|
12546
|
-
declare type
|
12798
|
+
declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
|
12799
|
+
|
12800
|
+
/**
|
12801
|
+
* An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
|
12802
|
+
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
12803
|
+
* are propagated to `System` without any type string prefixing.
|
12804
|
+
*
|
12805
|
+
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
12806
|
+
*/
|
12807
|
+
declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
|
12808
|
+
|
12809
|
+
/**
|
12810
|
+
* Modifies an event type key to reflect propagation by prefixing with the topic.
|
12811
|
+
*/
|
12812
|
+
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
|
12813
|
+
|
12814
|
+
/**
|
12815
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
|
12816
|
+
*/
|
12817
|
+
declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
|
12547
12818
|
|
12548
12819
|
/**
|
12549
|
-
* Union of possible
|
12820
|
+
* Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
|
12550
12821
|
*/
|
12551
|
-
declare type
|
12822
|
+
declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
|
12823
|
+
|
12824
|
+
/**
|
12825
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
12826
|
+
*/
|
12827
|
+
declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
|
12828
|
+
|
12829
|
+
/**
|
12830
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
12831
|
+
*/
|
12832
|
+
declare type PropagatedViewEventType = PropagatedEventType_2;
|
12833
|
+
|
12834
|
+
/**
|
12835
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
12836
|
+
*/
|
12837
|
+
declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
|
12838
|
+
|
12839
|
+
/**
|
12840
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
|
12841
|
+
*/
|
12842
|
+
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
12552
12843
|
|
12553
12844
|
declare interface ProtocolMap extends ProtocolMapBase {
|
12554
12845
|
'request-external-authorization': {
|
@@ -12966,7 +13257,7 @@ declare type RegistryInfo_2 = {
|
|
12966
13257
|
* Generated when a window has been reloaded.
|
12967
13258
|
* @interface
|
12968
13259
|
*/
|
12969
|
-
declare type ReloadedEvent =
|
13260
|
+
declare type ReloadedEvent = BaseEvent_5 & {
|
12970
13261
|
type: 'reloaded';
|
12971
13262
|
url: string;
|
12972
13263
|
};
|
@@ -13102,11 +13393,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
|
|
13102
13393
|
* Generated when an application is responding.
|
13103
13394
|
* @interface
|
13104
13395
|
*/
|
13105
|
-
declare type RespondingEvent = IdentityEvent & {
|
13396
|
+
declare type RespondingEvent = BaseEvents.IdentityEvent & {
|
13106
13397
|
topic: 'application';
|
13107
13398
|
type: 'responding';
|
13108
13399
|
};
|
13109
13400
|
|
13401
|
+
/**
|
13402
|
+
* Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
13403
|
+
* @interface
|
13404
|
+
*/
|
13405
|
+
declare type RestoredEvent = BaseEvent_5 & {
|
13406
|
+
type: 'restored';
|
13407
|
+
};
|
13408
|
+
|
13110
13409
|
declare type ResultBehavior = 'close' | 'hide' | 'none';
|
13111
13410
|
|
13112
13411
|
/**
|
@@ -13169,7 +13468,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
|
|
13169
13468
|
* Generated when Application.run() is called for an already running application.
|
13170
13469
|
* @interface
|
13171
13470
|
*/
|
13172
|
-
declare type RunRequestedEvent_2 = IdentityEvent & {
|
13471
|
+
declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
|
13173
13472
|
topic: 'application';
|
13174
13473
|
type: 'run-requested';
|
13175
13474
|
userAppConfigArgs: Record<string, any>;
|
@@ -13351,7 +13650,7 @@ declare type ServiceIdentifier = {
|
|
13351
13650
|
* Generated on changes to a user’s local computer session.
|
13352
13651
|
* @interface
|
13353
13652
|
*/
|
13354
|
-
declare type SessionChangedEvent =
|
13653
|
+
declare type SessionChangedEvent = BaseEvent_8 & {
|
13355
13654
|
type: 'session-changed';
|
13356
13655
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
13357
13656
|
};
|
@@ -13573,7 +13872,7 @@ declare type ShortcutOverride = Hotkey & {
|
|
13573
13872
|
*
|
13574
13873
|
* @interface
|
13575
13874
|
*/
|
13576
|
-
declare type ShowAllDownloadsEvent =
|
13875
|
+
declare type ShowAllDownloadsEvent = BaseEvent_5 & {
|
13577
13876
|
type: 'show-all-downloads';
|
13578
13877
|
};
|
13579
13878
|
|
@@ -13581,7 +13880,15 @@ declare type ShowAllDownloadsEvent = BaseWindowEvent & {
|
|
13581
13880
|
* Generated when a View is shown. This event will fire during creation of a View.
|
13582
13881
|
* @interface
|
13583
13882
|
*/
|
13584
|
-
declare type ShownEvent =
|
13883
|
+
declare type ShownEvent = BaseEvent_4 & {
|
13884
|
+
type: 'shown';
|
13885
|
+
};
|
13886
|
+
|
13887
|
+
/**
|
13888
|
+
* Generated when a hidden window has been shown.
|
13889
|
+
* @interface
|
13890
|
+
*/
|
13891
|
+
declare type ShownEvent_2 = BaseEvent_5 & {
|
13585
13892
|
type: 'shown';
|
13586
13893
|
};
|
13587
13894
|
|
@@ -13610,6 +13917,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
|
|
13610
13917
|
y?: number;
|
13611
13918
|
};
|
13612
13919
|
|
13920
|
+
/**
|
13921
|
+
* Generated when a window has been prevented from showing.
|
13922
|
+
* @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.
|
13923
|
+
* @interface
|
13924
|
+
*/
|
13925
|
+
declare type ShowRequestedEvent = BaseEvent_5 & {
|
13926
|
+
type: 'show-requested';
|
13927
|
+
};
|
13928
|
+
|
13613
13929
|
/**
|
13614
13930
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
13615
13931
|
*
|
@@ -13656,6 +13972,21 @@ declare type Snapshot = {
|
|
13656
13972
|
};
|
13657
13973
|
};
|
13658
13974
|
|
13975
|
+
/**
|
13976
|
+
* Generated when a platform.ApplySnapshot call is resolved.
|
13977
|
+
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
13978
|
+
* 1. The window has been created
|
13979
|
+
* 2. The window has a responsive API
|
13980
|
+
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
13981
|
+
*
|
13982
|
+
* _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.
|
13983
|
+
* @interface
|
13984
|
+
*/
|
13985
|
+
declare type SnapshotAppliedEvent = BaseEvent & {
|
13986
|
+
topic: 'application';
|
13987
|
+
type: 'platform-snapshot-applied';
|
13988
|
+
};
|
13989
|
+
|
13659
13990
|
/**
|
13660
13991
|
* @interface
|
13661
13992
|
*/
|
@@ -13773,7 +14104,7 @@ declare class SnapshotSourceModule extends Base {
|
|
13773
14104
|
* Generated when an application has started.
|
13774
14105
|
* @interface
|
13775
14106
|
*/
|
13776
|
-
declare type StartedEvent = IdentityEvent & {
|
14107
|
+
declare type StartedEvent = BaseEvents.IdentityEvent & {
|
13777
14108
|
topic: 'application';
|
13778
14109
|
type: 'started';
|
13779
14110
|
};
|
@@ -15309,12 +15640,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
|
|
15309
15640
|
};
|
15310
15641
|
|
15311
15642
|
/**
|
15312
|
-
*
|
15313
|
-
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
15314
|
-
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
15315
|
-
* from which they propagate).
|
15643
|
+
* @deprecated Renamed to {@link Event}.
|
15316
15644
|
*/
|
15317
|
-
declare type SystemEvent =
|
15645
|
+
declare type SystemEvent = Event_11;
|
15318
15646
|
|
15319
15647
|
declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
|
15320
15648
|
|
@@ -15322,8 +15650,10 @@ declare namespace SystemEvents {
|
|
15322
15650
|
export {
|
15323
15651
|
NotRequested,
|
15324
15652
|
ExcludeRequested,
|
15325
|
-
|
15653
|
+
BaseEvent_8 as BaseEvent,
|
15654
|
+
IdleStateChangedEvent,
|
15326
15655
|
IdleEvent,
|
15656
|
+
MonitorInfoChangedEvent,
|
15327
15657
|
MonitorEvent,
|
15328
15658
|
SessionChangedEvent,
|
15329
15659
|
AppVersionEvent,
|
@@ -15337,17 +15667,19 @@ declare namespace SystemEvents {
|
|
15337
15667
|
ApplicationCreatedEvent,
|
15338
15668
|
DesktopIconClickedEvent,
|
15339
15669
|
SystemShutdownEvent,
|
15670
|
+
Event_11 as Event,
|
15340
15671
|
SystemEvent,
|
15672
|
+
EventType_8 as EventType,
|
15341
15673
|
SystemEventType,
|
15342
|
-
|
15343
|
-
|
15674
|
+
Payload_9 as Payload,
|
15675
|
+
ByType_8 as ByType
|
15344
15676
|
}
|
15345
15677
|
}
|
15346
15678
|
|
15347
15679
|
/**
|
15348
|
-
*
|
15680
|
+
* @deprecated Renamed to {@link EventType}.
|
15349
15681
|
*/
|
15350
|
-
declare type SystemEventType =
|
15682
|
+
declare type SystemEventType = EventType_8;
|
15351
15683
|
|
15352
15684
|
/**
|
15353
15685
|
* @interface
|
@@ -15404,7 +15736,7 @@ declare type SystemProcessInfo = {
|
|
15404
15736
|
* Generated when system shutdown or log off.
|
15405
15737
|
* @internal
|
15406
15738
|
*/
|
15407
|
-
declare type SystemShutdownEvent =
|
15739
|
+
declare type SystemShutdownEvent = BaseEvent_8 & {
|
15408
15740
|
type: 'system-shutdown';
|
15409
15741
|
};
|
15410
15742
|
|
@@ -15657,7 +15989,7 @@ declare type TargetApp = string | AppMetadata;
|
|
15657
15989
|
* In that case, previousTarget identity will be the same as target identity.
|
15658
15990
|
* @interface
|
15659
15991
|
*/
|
15660
|
-
declare type TargetChangedEvent =
|
15992
|
+
declare type TargetChangedEvent = BaseEvent_4 & {
|
15661
15993
|
type: 'target-changed';
|
15662
15994
|
previousTarget: OpenFin.Identity;
|
15663
15995
|
};
|
@@ -15811,7 +16143,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
15811
16143
|
* Generated when the tray icon is clicked.
|
15812
16144
|
* @interface
|
15813
16145
|
*/
|
15814
|
-
declare type TrayIconClickedEvent = IdentityEvent & {
|
16146
|
+
declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
|
15815
16147
|
topic: 'application';
|
15816
16148
|
type: 'tray-icon-clicked';
|
15817
16149
|
button: 0 | 1 | 2;
|
@@ -15901,7 +16233,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
15901
16233
|
* A general user bounds change event without event type.
|
15902
16234
|
* @interface
|
15903
16235
|
*/
|
15904
|
-
declare type UserBoundsChangeEvent =
|
16236
|
+
declare type UserBoundsChangeEvent = BaseEvent_5 & {
|
15905
16237
|
height: number;
|
15906
16238
|
left: number;
|
15907
16239
|
top: number;
|
@@ -15913,7 +16245,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
|
|
15913
16245
|
* Generated when a window's user movement becomes disabled.
|
15914
16246
|
* @interface
|
15915
16247
|
*/
|
15916
|
-
declare type UserMovementDisabledEvent =
|
16248
|
+
declare type UserMovementDisabledEvent = BaseEvent_5 & {
|
15917
16249
|
type: 'user-movement-disabled';
|
15918
16250
|
};
|
15919
16251
|
|
@@ -15921,7 +16253,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
|
|
15921
16253
|
* Generated when a window's user movement becomes enabled.
|
15922
16254
|
* @interface
|
15923
16255
|
*/
|
15924
|
-
declare type UserMovementEnabledEvent =
|
16256
|
+
declare type UserMovementEnabledEvent = BaseEvent_5 & {
|
15925
16257
|
type: 'user-movement-enabled';
|
15926
16258
|
};
|
15927
16259
|
|
@@ -16608,7 +16940,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
16608
16940
|
* Generated when a View is attached to a window.
|
16609
16941
|
* @interface
|
16610
16942
|
*/
|
16611
|
-
declare type ViewAttachedEvent =
|
16943
|
+
declare type ViewAttachedEvent = BaseEvent_5 & {
|
16612
16944
|
type: 'view-attached';
|
16613
16945
|
target: OpenFin.Identity;
|
16614
16946
|
viewIdentity: OpenFin.Identity;
|
@@ -16650,7 +16982,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
|
|
16650
16982
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
16651
16983
|
* @interface
|
16652
16984
|
*/
|
16653
|
-
declare type ViewDetachedEvent =
|
16985
|
+
declare type ViewDetachedEvent = BaseEvent_5 & {
|
16654
16986
|
type: 'view-detached';
|
16655
16987
|
target: OpenFin.Identity;
|
16656
16988
|
previousTarget: OpenFin.Identity;
|
@@ -16658,18 +16990,15 @@ declare type ViewDetachedEvent = BaseWindowEvent & {
|
|
16658
16990
|
};
|
16659
16991
|
|
16660
16992
|
/**
|
16661
|
-
*
|
16662
|
-
* discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
|
16663
|
-
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
16993
|
+
* @deprecated Renamed to {@link Event}.
|
16664
16994
|
*/
|
16665
|
-
declare type ViewEvent =
|
16666
|
-
target: OpenFin.Identity;
|
16667
|
-
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
16995
|
+
declare type ViewEvent = Event_4;
|
16668
16996
|
|
16669
16997
|
declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
|
16670
16998
|
|
16671
16999
|
declare namespace ViewEvents {
|
16672
17000
|
export {
|
17001
|
+
BaseEvent_4 as BaseEvent,
|
16673
17002
|
BaseViewEvent,
|
16674
17003
|
TargetChangedEvent,
|
16675
17004
|
NonPropagatedViewEvent,
|
@@ -16679,20 +17008,24 @@ declare namespace ViewEvents {
|
|
16679
17008
|
HotkeyEvent,
|
16680
17009
|
ShownEvent,
|
16681
17010
|
HostContextChangedEvent,
|
17011
|
+
Event_4 as Event,
|
16682
17012
|
ViewEvent,
|
16683
17013
|
WillPropagateViewEvent,
|
17014
|
+
EventType,
|
16684
17015
|
ViewEventType,
|
17016
|
+
PropagatedEvent_2 as PropagatedEvent,
|
16685
17017
|
PropagatedViewEvent,
|
17018
|
+
PropagatedEventType_2 as PropagatedEventType,
|
16686
17019
|
PropagatedViewEventType,
|
16687
|
-
|
16688
|
-
|
17020
|
+
Payload_2 as Payload,
|
17021
|
+
ByType
|
16689
17022
|
}
|
16690
17023
|
}
|
16691
17024
|
|
16692
17025
|
/**
|
16693
|
-
*
|
17026
|
+
* @deprecated Renamed to {@link EventType}.
|
16694
17027
|
*/
|
16695
|
-
declare type ViewEventType =
|
17028
|
+
declare type ViewEventType = EventType;
|
16696
17029
|
|
16697
17030
|
/**
|
16698
17031
|
* @interface
|
@@ -17831,12 +18164,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
17831
18164
|
}
|
17832
18165
|
|
17833
18166
|
/**
|
17834
|
-
*
|
17835
|
-
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
18167
|
+
* @deprecated Renamed to {@link Event}.
|
17836
18168
|
*/
|
17837
|
-
declare type WebContentsEvent<Topic extends string> =
|
17838
|
-
topic: Topic;
|
17839
|
-
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
18169
|
+
declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
|
17840
18170
|
|
17841
18171
|
declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
|
17842
18172
|
|
@@ -17848,6 +18178,7 @@ declare namespace WebContentsEvents {
|
|
17848
18178
|
CrashedEvent_2 as CrashedEvent,
|
17849
18179
|
CertificateErrorEvent,
|
17850
18180
|
CertificateSelectionShownEvent,
|
18181
|
+
PageFaviconUpdatedEvent,
|
17851
18182
|
FaviconUpdatedEvent,
|
17852
18183
|
NavigationRejectedEvent,
|
17853
18184
|
UrlChangedEvent,
|
@@ -17866,6 +18197,7 @@ declare namespace WebContentsEvents {
|
|
17866
18197
|
FileDownloadStartedEvent,
|
17867
18198
|
FileDownloadProgressEvent,
|
17868
18199
|
FileDownloadCompletedEvent,
|
18200
|
+
Event_5 as Event,
|
17869
18201
|
WebContentsEvent,
|
17870
18202
|
WillPropagateWebContentsEvent,
|
17871
18203
|
NonPropagatedWebContentsEvent
|
@@ -17913,7 +18245,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
17913
18245
|
* A general will-move or will-resize event without event type.
|
17914
18246
|
* @interface
|
17915
18247
|
*/
|
17916
|
-
declare type WillMoveOrResizeEvent =
|
18248
|
+
declare type WillMoveOrResizeEvent = BaseEvent_5 & {
|
17917
18249
|
height: number;
|
17918
18250
|
left: number;
|
17919
18251
|
top: number;
|
@@ -17935,7 +18267,7 @@ declare type WillPropagateViewEvent = ViewEvent;
|
|
17935
18267
|
*
|
17936
18268
|
* A WebContents event that does propagate to (republish on) parent topics.
|
17937
18269
|
*/
|
17938
|
-
declare type WillPropagateWebContentsEvent =
|
18270
|
+
declare type WillPropagateWebContentsEvent = Event_5<string>;
|
17939
18271
|
|
17940
18272
|
/**
|
17941
18273
|
* @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
|
@@ -17949,7 +18281,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
|
|
17949
18281
|
* Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
|
17950
18282
|
* @interface
|
17951
18283
|
*/
|
17952
|
-
declare type WillRedirectEvent =
|
18284
|
+
declare type WillRedirectEvent = BaseEvent_5 & {
|
17953
18285
|
type: 'will-redirect';
|
17954
18286
|
blocked: boolean;
|
17955
18287
|
isInPlace: boolean;
|
@@ -19574,7 +19906,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19574
19906
|
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
19575
19907
|
* @interface
|
19576
19908
|
*/
|
19577
|
-
declare type WindowAlertRequestedEvent =
|
19909
|
+
declare type WindowAlertRequestedEvent = BaseEvent_3 & {
|
19578
19910
|
type: 'window-alert-requested';
|
19579
19911
|
};
|
19580
19912
|
|
@@ -19588,29 +19920,19 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19588
19920
|
};
|
19589
19921
|
|
19590
19922
|
/**
|
19591
|
-
*
|
19592
|
-
* @interface
|
19923
|
+
* @deprecated Renamed to {@link ClosedEvent}.
|
19593
19924
|
*/
|
19594
|
-
declare type WindowClosedEvent =
|
19595
|
-
type: 'closed';
|
19596
|
-
};
|
19925
|
+
declare type WindowClosedEvent = ClosedEvent_2;
|
19597
19926
|
|
19598
19927
|
/**
|
19599
|
-
*
|
19600
|
-
* @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.
|
19601
|
-
* @interface
|
19928
|
+
* @deprecated Renamed to {@link CloseRequestedEvent}.
|
19602
19929
|
*/
|
19603
|
-
declare type WindowCloseRequestedEvent =
|
19604
|
-
type: 'close-requested';
|
19605
|
-
};
|
19930
|
+
declare type WindowCloseRequestedEvent = CloseRequestedEvent;
|
19606
19931
|
|
19607
19932
|
/**
|
19608
|
-
*
|
19609
|
-
* @interface
|
19933
|
+
* @deprecated Renamed to {@link ClosingEvent}.
|
19610
19934
|
*/
|
19611
|
-
declare type WindowClosingEvent =
|
19612
|
-
type: 'closing';
|
19613
|
-
};
|
19935
|
+
declare type WindowClosingEvent = ClosingEvent;
|
19614
19936
|
|
19615
19937
|
/**
|
19616
19938
|
* A rule prescribing content creation in a {@link OpenFin.Window}.
|
@@ -19632,7 +19954,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19632
19954
|
* Generated when a child window is created.
|
19633
19955
|
* @interface
|
19634
19956
|
*/
|
19635
|
-
declare type WindowCreatedEvent =
|
19957
|
+
declare type WindowCreatedEvent = BaseEvent_3 & {
|
19636
19958
|
type: 'window-created';
|
19637
19959
|
};
|
19638
19960
|
|
@@ -19689,21 +20011,20 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19689
20011
|
* Generated when a child window ends loading.
|
19690
20012
|
* @interface
|
19691
20013
|
*/
|
19692
|
-
declare type WindowEndLoadEvent =
|
20014
|
+
declare type WindowEndLoadEvent = BaseEvent_3 & {
|
19693
20015
|
type: 'window-end-load';
|
19694
20016
|
};
|
19695
20017
|
|
19696
20018
|
/**
|
19697
|
-
*
|
19698
|
-
* discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
|
19699
|
-
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
20019
|
+
* @deprecated, Renamed to {@link Event}.
|
19700
20020
|
*/
|
19701
|
-
declare type WindowEvent =
|
20021
|
+
declare type WindowEvent = Event_6;
|
19702
20022
|
|
19703
20023
|
declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
|
19704
20024
|
|
19705
20025
|
declare namespace WindowEvents {
|
19706
20026
|
export {
|
20027
|
+
BaseEvent_5 as BaseEvent,
|
19707
20028
|
BaseWindowEvent,
|
19708
20029
|
ViewAttachedEvent,
|
19709
20030
|
ViewDetachedEvent,
|
@@ -19713,9 +20034,11 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19713
20034
|
EndLoadEvent,
|
19714
20035
|
WillRedirectEvent,
|
19715
20036
|
ReloadedEvent,
|
20037
|
+
OptionsChangedEvent,
|
19716
20038
|
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
19717
20039
|
ExternalProcessExitedEvent,
|
19718
20040
|
ExternalProcessStartedEvent,
|
20041
|
+
HiddenEvent_2 as HiddenEvent,
|
19719
20042
|
WindowHiddenEvent,
|
19720
20043
|
PreloadScriptInfoRunning,
|
19721
20044
|
PreloadScriptInfo,
|
@@ -19730,22 +20053,30 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19730
20053
|
BeginUserBoundsChangingEvent,
|
19731
20054
|
BoundsChangedEvent,
|
19732
20055
|
BoundsChangingEvent,
|
20056
|
+
CloseRequestedEvent,
|
19733
20057
|
WindowCloseRequestedEvent,
|
19734
20058
|
ContextChangedEvent,
|
20059
|
+
ClosedEvent_2 as ClosedEvent,
|
19735
20060
|
WindowClosedEvent,
|
20061
|
+
ClosingEvent,
|
19736
20062
|
WindowClosingEvent,
|
19737
20063
|
DisabledMovementBoundsChangedEvent,
|
19738
20064
|
DisabledMovementBoundsChangingEvent,
|
19739
20065
|
EmbeddedEvent,
|
19740
20066
|
EndUserBoundsChangingEvent,
|
20067
|
+
HotkeyEvent_2 as HotkeyEvent,
|
19741
20068
|
WindowHotkeyEvent,
|
20069
|
+
InitializedEvent_2 as InitializedEvent,
|
19742
20070
|
WindowInitializedEvent,
|
19743
20071
|
MaximizedEvent,
|
19744
20072
|
MinimizedEvent,
|
19745
20073
|
PreloadScriptsStateChangedEvent,
|
19746
20074
|
PreloadScriptsStateChangingEvent,
|
20075
|
+
RestoredEvent,
|
19747
20076
|
WindowRestoredEvent,
|
20077
|
+
ShowRequestedEvent,
|
19748
20078
|
WindowShowRequestedEvent,
|
20079
|
+
ShownEvent_2 as ShownEvent,
|
19749
20080
|
WindowShownEvent,
|
19750
20081
|
UserMovementEnabledEvent,
|
19751
20082
|
UserMovementDisabledEvent,
|
@@ -19756,37 +20087,32 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19756
20087
|
DownloadShelfVisibilityChangedEvent,
|
19757
20088
|
WindowSourcedEvent,
|
19758
20089
|
WillPropagateWindowEvent,
|
20090
|
+
Event_6 as Event,
|
19759
20091
|
WindowEvent,
|
20092
|
+
EventType_2 as EventType,
|
19760
20093
|
WindowEventType,
|
20094
|
+
PropagatedEvent_3 as PropagatedEvent,
|
19761
20095
|
PropagatedWindowEvent,
|
19762
20096
|
PropagatedWindowEventType,
|
19763
|
-
|
19764
|
-
|
20097
|
+
Payload_3 as Payload,
|
20098
|
+
ByType_2 as ByType
|
19765
20099
|
}
|
19766
20100
|
}
|
19767
20101
|
|
19768
20102
|
/**
|
19769
|
-
*
|
20103
|
+
* @deprecated Renamed to {@link EventType}.
|
19770
20104
|
*/
|
19771
20105
|
declare type WindowEventType = WindowEvent['type'];
|
19772
20106
|
|
19773
20107
|
/**
|
19774
|
-
*
|
19775
|
-
* @interface
|
20108
|
+
* @deprecated Renamed to {@link HiddenEvent}.
|
19776
20109
|
*/
|
19777
|
-
declare type WindowHiddenEvent =
|
19778
|
-
type: 'hidden';
|
19779
|
-
reason: 'closing' | 'hide' | 'hide-on-close';
|
19780
|
-
};
|
20110
|
+
declare type WindowHiddenEvent = HiddenEvent_2;
|
19781
20111
|
|
19782
20112
|
/**
|
19783
|
-
*
|
19784
|
-
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
19785
|
-
* @interface
|
20113
|
+
* @deprecated Renamed to {@link HotkeyEvent}.
|
19786
20114
|
*/
|
19787
|
-
declare type WindowHotkeyEvent =
|
19788
|
-
type: 'hotkey';
|
19789
|
-
};
|
20115
|
+
declare type WindowHotkeyEvent = HotkeyEvent_2;
|
19790
20116
|
|
19791
20117
|
/**
|
19792
20118
|
* @interface
|
@@ -19800,12 +20126,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19800
20126
|
};
|
19801
20127
|
|
19802
20128
|
/**
|
19803
|
-
*
|
19804
|
-
* @interface
|
20129
|
+
* @deprecated Renamed to {@link InitializedEvent}.
|
19805
20130
|
*/
|
19806
|
-
declare type WindowInitializedEvent =
|
19807
|
-
type: 'initialized';
|
19808
|
-
};
|
20131
|
+
declare type WindowInitializedEvent = InitializedEvent_2;
|
19809
20132
|
|
19810
20133
|
/**
|
19811
20134
|
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
@@ -19902,7 +20225,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19902
20225
|
* Generated when a child window is not responding.
|
19903
20226
|
* @interface
|
19904
20227
|
*/
|
19905
|
-
declare type WindowNotRespondingEvent =
|
20228
|
+
declare type WindowNotRespondingEvent = BaseEvent_3 & {
|
19906
20229
|
type: 'window-not-responding';
|
19907
20230
|
};
|
19908
20231
|
|
@@ -19924,15 +20247,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19924
20247
|
declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
|
19925
20248
|
|
19926
20249
|
/**
|
19927
|
-
*
|
19928
|
-
* @remarks Will not fire if the diff object is empty.
|
19929
|
-
* @interface
|
20250
|
+
* @deprecated Renamed to {@link OptionsChangedEvent}.
|
19930
20251
|
*/
|
19931
|
-
declare type WindowOptionsChangedEvent_2 =
|
19932
|
-
type: 'options-changed';
|
19933
|
-
options: OpenFin.WindowOptions;
|
19934
|
-
diff: OpenFin.WindowOptionDiff;
|
19935
|
-
};
|
20252
|
+
declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
|
19936
20253
|
|
19937
20254
|
declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
|
19938
20255
|
|
@@ -19940,46 +20257,36 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19940
20257
|
* Generated when a child window is responding.
|
19941
20258
|
* @interface
|
19942
20259
|
*/
|
19943
|
-
declare type WindowRespondingEvent =
|
20260
|
+
declare type WindowRespondingEvent = BaseEvent_3 & {
|
19944
20261
|
type: 'window-responding';
|
19945
20262
|
};
|
19946
20263
|
|
19947
20264
|
/**
|
19948
|
-
*
|
19949
|
-
* @interface
|
20265
|
+
* @deprecated Renamed to {@link RestoredEvent}.
|
19950
20266
|
*/
|
19951
|
-
declare type WindowRestoredEvent =
|
19952
|
-
type: 'restored';
|
19953
|
-
};
|
20267
|
+
declare type WindowRestoredEvent = RestoredEvent;
|
19954
20268
|
|
19955
20269
|
/**
|
19956
|
-
*
|
19957
|
-
* @interface
|
20270
|
+
* @deprecated Renamed to {@link ShownEvent}.
|
19958
20271
|
*/
|
19959
|
-
declare type WindowShownEvent =
|
19960
|
-
type: 'shown';
|
19961
|
-
};
|
20272
|
+
declare type WindowShownEvent = ShownEvent_2;
|
19962
20273
|
|
19963
20274
|
/**
|
19964
|
-
*
|
19965
|
-
* @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.
|
19966
|
-
* @interface
|
20275
|
+
* @deprecated Renamed to {@link ShowRequestedEvent}.
|
19967
20276
|
*/
|
19968
|
-
declare type WindowShowRequestedEvent =
|
19969
|
-
type: 'show-requested';
|
19970
|
-
};
|
20277
|
+
declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
19971
20278
|
|
19972
20279
|
/**
|
19973
20280
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
19974
20281
|
* from {@link OpenFin.ViewEvents}.
|
19975
20282
|
*/
|
19976
|
-
declare type WindowSourcedEvent =
|
20283
|
+
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;
|
19977
20284
|
|
19978
20285
|
/**
|
19979
20286
|
* Generated when a child window starts loading.
|
19980
20287
|
* @interface
|
19981
20288
|
*/
|
19982
|
-
declare type WindowStartLoadEvent =
|
20289
|
+
declare type WindowStartLoadEvent = BaseEvent_3 & {
|
19983
20290
|
type: 'window-start-load';
|
19984
20291
|
};
|
19985
20292
|
|