@openfin/node-adapter 35.78.1 → 35.78.3

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.
@@ -43,6 +43,8 @@ declare type Accelerator = {
43
43
  };
44
44
 
45
45
  /**
46
+ * Options to use when adding a view to a {@link TabStack}.
47
+ *
46
48
  * @interface
47
49
  */
48
50
  declare type AddViewOptions = CreateViewTarget & {
@@ -64,7 +66,7 @@ declare type AddViewToStackOptions = {
64
66
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
65
67
  * @interface
66
68
  */
67
- declare type AlertRequestedEvent = BaseWindowEvent & {
69
+ declare type AlertRequestedEvent = BaseEvent_5 & {
68
70
  type: 'alert-requested';
69
71
  message: string;
70
72
  url: string;
@@ -94,6 +96,10 @@ declare type Api = {
94
96
  sameOriginInjection?: boolean;
95
97
  enableDeprecatedSharedName?: boolean;
96
98
  };
99
+ /**
100
+ * Prevent fin API injection. If 'none', `fin` won't be available in this context.
101
+ */
102
+ fin?: InjectionType;
97
103
  };
98
104
 
99
105
  declare type ApiCall<Request, Response> = {
@@ -105,6 +111,22 @@ declare type ApiClient<T extends Record<any, any>> = {
105
111
  [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
106
112
  };
107
113
 
114
+ /**
115
+ * @interface
116
+ */
117
+ declare type ApiInjection = {
118
+ fin: InjectionType;
119
+ };
120
+
121
+ /**
122
+ * Generated when a new Platform's API becomes responsive.
123
+ * @interface
124
+ */
125
+ declare type ApiReadyEvent = BaseEvent & {
126
+ topic: 'application';
127
+ type: 'platform-api-ready';
128
+ };
129
+
108
130
  /**
109
131
  * @interface
110
132
  */
@@ -178,100 +200,6 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
178
200
  private window;
179
201
  /* Excluded from this release type: __constructor */
180
202
  private windowListFromIdentityList;
181
- /**
182
- * Adds a listener to the end of the listeners array for the specified event.
183
- * @param eventType - The type of the event.
184
- * @param listener - Called whenever an event of the specified type occurs.
185
- * @param options - Option to support event timestamps.
186
- *
187
- * @function addListener
188
- * @memberof Application
189
- * @instance
190
- * @tutorial Application.EventEmitter
191
- */
192
- /**
193
- * Adds a listener to the end of the listeners array for the specified event.
194
- * @param eventType - The type of the event.
195
- * @param listener - Called whenever an event of the specified type occurs.
196
- * @param options - Option to support event timestamps.
197
- *
198
- * @function on
199
- * @memberof Application
200
- * @instance
201
- * @tutorial Application.EventEmitter
202
- */
203
- /**
204
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
205
- * @param eventType - The type of the event.
206
- * @param listener - The callback function.
207
- * @param options - Option to support event timestamps.
208
- *
209
- * @function once
210
- * @memberof Application
211
- * @instance
212
- * @tutorial Application.EventEmitter
213
- */
214
- /**
215
- * Adds a listener to the beginning of the listeners array for the specified event.
216
- * @param eventType - The type of the event.
217
- * @param listener - The callback function.
218
- * @param options - Option to support event timestamps.
219
- *
220
- * @function prependListener
221
- * @memberof Application
222
- * @instance
223
- * @tutorial Application.EventEmitter
224
- */
225
- /**
226
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
227
- * The listener is added to the beginning of the listeners array.
228
- * @param eventType - The type of the event.
229
- * @param listener - The callback function.
230
- * @param options - Option to support event timestamps.
231
- *
232
- * @function prependOnceListener
233
- * @memberof Application
234
- * @instance
235
- * @tutorial Application.EventEmitter
236
- */
237
- /**
238
- * Remove a listener from the listener array for the specified event.
239
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
240
- * @param eventType - The type of the event.
241
- * @param listener - The callback function.
242
- * @param options - Option to support event timestamps.
243
- *
244
- * @function removeListener
245
- * @memberof Application
246
- * @instance
247
- * @tutorial Application.EventEmitter
248
- */
249
- /**
250
- * Removes all listeners, or those of the specified event.
251
- * @param eventType - The type of the event.
252
- *
253
- * @function removeAllListeners
254
- * @memberof Application
255
- * @instance
256
- * @tutorial Application.EventEmitter
257
- */
258
- /**
259
- * JumpListCategory interface
260
- * @typedef { object } JumpListCategory@typedef { object } JumpListCategory
261
- * @property { string } name The display title for the category. If omitted, items in this category will be placed into the standard 'Tasks' category. There can be only one such category, and it will always be displayed at the bottom of the JumpList.
262
- * @property { JumpListItem[] } items Array of JumpListItem objects
263
- */
264
- /**
265
- * @PORTED
266
- * JumpListItem interface
267
- * @typedef { object } JumpListItem@typedef { object } JumpListItem
268
- * @property { string } type One of the following: "task" or "separator". Defaults to task.
269
- * @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
270
- * @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
271
- * @property { string } deepLink Deep link to a manifest, i.e: fins://path.to/manifest.json?$$param1=value1. See {@link https://developers.openfin.co/docs/deep-linking deep-linking} for more information.
272
- * @property { string } iconPath The absolute path to an icon to be displayed for the item, which can be an arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll).
273
- * @property { number } iconIndex The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero.
274
- */
275
203
  /**
276
204
  * Determines if the application is currently running.
277
205
  *
@@ -856,19 +784,15 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
856
784
  }
857
785
 
858
786
  /**
859
- * Generated when an application has authenticated and is connected.
860
- * @interface
787
+ * @deprecated Renamed to {@link ConnectedEvent}.
861
788
  */
862
- declare type ApplicationConnectedEvent = IdentityEvent & {
863
- topic: 'application';
864
- type: 'connected';
865
- };
789
+ declare type ApplicationConnectedEvent = ConnectedEvent_2;
866
790
 
867
791
  /**
868
792
  * Generated when an application is created.
869
793
  * @interface
870
794
  */
871
- declare type ApplicationCreatedEvent = BaseSystemEvent & IdentityEvent & {
795
+ declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
872
796
  type: 'application-created';
873
797
  };
874
798
 
@@ -892,17 +816,15 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
892
816
  };
893
817
 
894
818
  /**
895
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
896
- * discriminated by {@link ApplicationEvent.type | their type}. Event payloads unique to `Application` can be found
897
- * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
898
- * from which they propagate).
819
+ * @deprecated Renamed to {@link Event}.
899
820
  */
900
- declare type ApplicationEvent = PropagatedViewEvent<'application'> | PropagatedWindowEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
821
+ declare type ApplicationEvent = Event_3;
901
822
 
902
823
  declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
903
824
 
904
825
  declare namespace ApplicationEvents {
905
826
  export {
827
+ BaseEvent_3 as BaseEvent,
906
828
  BaseApplicationEvent,
907
829
  CrashedEvent,
908
830
  FileDownloadLocationChangedEvent,
@@ -916,6 +838,7 @@ declare namespace ApplicationEvents {
916
838
  WindowStartLoadEvent,
917
839
  ApplicationWindowEvent,
918
840
  ClosedEvent,
841
+ ConnectedEvent_2 as ConnectedEvent,
919
842
  ApplicationConnectedEvent,
920
843
  InitializedEvent,
921
844
  ManifestChangedEvent,
@@ -923,19 +846,24 @@ declare namespace ApplicationEvents {
923
846
  RespondingEvent,
924
847
  StartedEvent,
925
848
  ApplicationSourcedEvent,
849
+ ApplicationSourcedEventType,
850
+ Event_3 as Event,
926
851
  ApplicationEvent,
852
+ EventType_3 as EventType,
927
853
  ApplicationEventType,
854
+ PropagatedEvent_4 as PropagatedEvent,
928
855
  PropagatedApplicationEvent,
856
+ PropagatedEventType_3 as PropagatedEventType,
929
857
  PropagatedApplicationEventType,
930
- Payload_2 as Payload,
931
- ByType
858
+ Payload_4 as Payload,
859
+ ByType_3 as ByType
932
860
  }
933
861
  }
934
862
 
935
863
  /**
936
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
864
+ * @deprecated Renamed to {@link EventType}.
937
865
  */
938
- declare type ApplicationEventType = ApplicationEvent['type'];
866
+ declare type ApplicationEventType = EventType_3;
939
867
 
940
868
  declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
941
869
 
@@ -1257,10 +1185,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1257
1185
  */
1258
1186
  apiDiagnostics: boolean;
1259
1187
  /**
1260
- * Define the file download rules.
1261
- * See [here](https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads) for more details.
1188
+ * @deprecated Please use {@link domainSettings} instead
1262
1189
  */
1263
1190
  defaultDomainSettings: DefaultDomainSettings;
1191
+ /**
1192
+ * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
1193
+ */
1194
+ domainSettings: DomainSettings;
1264
1195
  /**
1265
1196
  * @defaultValue false
1266
1197
  *
@@ -1288,9 +1219,13 @@ declare type ApplicationPermissions = {
1288
1219
  * A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
1289
1220
  * from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
1290
1221
  * does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
1291
- *
1292
1222
  */
1293
- declare type ApplicationSourcedEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1223
+ declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1224
+
1225
+ /**
1226
+ * Union of possible type values for an {@link ApplicationSourcedEvent}.
1227
+ */
1228
+ declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
1294
1229
 
1295
1230
  declare type ApplicationState = OpenFin.ApplicationState;
1296
1231
 
@@ -1598,7 +1533,7 @@ declare interface AuthorizationPayload {
1598
1533
  * ```
1599
1534
  * @interface
1600
1535
  */
1601
- declare type AuthRequestedEvent = BaseWindowEvent & {
1536
+ declare type AuthRequestedEvent = BaseEvent_5 & {
1602
1537
  type: 'auth-requested';
1603
1538
  authInfo: {
1604
1539
  host: string;
@@ -1660,21 +1595,9 @@ declare class Base {
1660
1595
  }
1661
1596
 
1662
1597
  /**
1663
- * Base type for events emitting on the `application` topic
1664
- * @interface
1665
- */
1666
- declare type BaseApplicationEvent = NamedEvent & {
1667
- topic: `application`;
1668
- };
1669
-
1670
- /**
1671
- * A base Channel event.
1672
- * @interface
1598
+ * @deprecated Renamed to {@link BaseEvent}.
1673
1599
  */
1674
- declare type BaseChannelEvent = NamedEvent & {
1675
- channelName: string;
1676
- channelId: string;
1677
- };
1600
+ declare type BaseApplicationEvent = BaseEvent_3;
1678
1601
 
1679
1602
  /**
1680
1603
  * @interface
@@ -1743,10 +1666,70 @@ declare type BaseEvent = {
1743
1666
  type: string;
1744
1667
  };
1745
1668
 
1746
- declare type BaseEvent_2 = Events.BaseEvents.BaseEvent;
1669
+ /**
1670
+ * A base Channel event.
1671
+ * @interface
1672
+ */
1673
+ declare type BaseEvent_2 = NamedEvent & {
1674
+ channelName: string;
1675
+ channelId: string;
1676
+ };
1677
+
1678
+ /**
1679
+ * Base type for events emitting on the `application` topic
1680
+ * @interface
1681
+ */
1682
+ declare type BaseEvent_3 = BaseEvents.NamedEvent & {
1683
+ topic: `application`;
1684
+ };
1685
+
1686
+ /**
1687
+ * Base type for events emitting on the `view` topic
1688
+ * @interface
1689
+ */
1690
+ declare type BaseEvent_4 = BaseEvents.NamedEvent & {
1691
+ topic: 'view';
1692
+ target: OpenFin.Identity;
1693
+ };
1694
+
1695
+ /**
1696
+ * Base type for events emitting on the `window` topic
1697
+ * @interface
1698
+ */
1699
+ declare type BaseEvent_5 = BaseEvents.NamedEvent & {
1700
+ topic: 'window';
1701
+ };
1702
+
1703
+ /**
1704
+ * Base type for events emitting on the `externalapplication` topic
1705
+ * @interface
1706
+ */
1707
+ declare type BaseEvent_6 = BaseEvents.BaseEvent & {
1708
+ topic: 'externalapplication';
1709
+ };
1710
+
1711
+ /**
1712
+ * The base frame event.
1713
+ * @interface
1714
+ */
1715
+ declare type BaseEvent_7 = NamedEvent & {
1716
+ entityType: 'iframe';
1717
+ frameName: string;
1718
+ };
1719
+
1720
+ /**
1721
+ * Base type for events emitting on the `system` topic
1722
+ * @interface
1723
+ */
1724
+ declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1725
+ topic: 'system';
1726
+ };
1727
+
1728
+ declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
1747
1729
 
1748
1730
  declare namespace BaseEvents {
1749
1731
  export {
1732
+ NotCloseRequested,
1750
1733
  PropagatedEventType,
1751
1734
  PropagatedEvent,
1752
1735
  EventHandler,
@@ -1757,21 +1740,14 @@ declare namespace BaseEvents {
1757
1740
  }
1758
1741
 
1759
1742
  /**
1760
- * Base type for events emitting on the `externalapplication` topic
1761
- * @interface
1743
+ * @deprecated Renamed to {@link BaseEvent}.
1762
1744
  */
1763
- declare type BaseExternalApplicationEvent = BaseEvent & {
1764
- topic: 'externalapplication';
1765
- };
1745
+ declare type BaseExternalApplicationEvent = BaseEvent_6;
1766
1746
 
1767
1747
  /**
1768
- * The base frame event.
1769
- * @interface
1748
+ * @deprecated Renamed to {@link BaseEvent}.
1770
1749
  */
1771
- declare type BaseFrameEvent = NamedEvent & {
1772
- entityType: 'iframe';
1773
- frameName: string;
1774
- };
1750
+ declare type BaseFrameEvent = BaseEvent_7;
1775
1751
 
1776
1752
  declare type BaseLoadFailedEvent = NamedEvent & {
1777
1753
  errorCode: number;
@@ -1780,35 +1756,20 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1780
1756
  isMainFrame: boolean;
1781
1757
  };
1782
1758
 
1783
- /**
1784
- * Base type for events emitting on the `system` topic
1785
- * @interface
1786
- */
1787
- declare type BaseSystemEvent = BaseEvent & {
1788
- topic: 'system';
1789
- };
1790
-
1791
1759
  declare type BaseUrlEvent = NamedEvent & {
1792
1760
  type: 'url-changed';
1793
1761
  url: string;
1794
1762
  };
1795
1763
 
1796
1764
  /**
1797
- * Base type for events emitting on the `view` topic
1798
- * @interface
1765
+ * @deprecated Renamed to {@link BaseEvent}.
1799
1766
  */
1800
- declare type BaseViewEvent = NamedEvent & {
1801
- topic: 'view';
1802
- target: OpenFin.Identity;
1803
- };
1767
+ declare type BaseViewEvent = BaseEvent_4;
1804
1768
 
1805
1769
  /**
1806
- * Base type for events emitting on the `window` topic
1807
- * @interface
1770
+ * @deprecated Renamed to {@link BaseEvent}.
1808
1771
  */
1809
- declare type BaseWindowEvent = NamedEvent & {
1810
- topic: 'window';
1811
- };
1772
+ declare type BaseWindowEvent = BaseEvent_5;
1812
1773
 
1813
1774
  /**
1814
1775
  * User decision of whether a Window or specific View should close when trying to prevent an unload.
@@ -1875,7 +1836,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
1875
1836
  * A general bounds change event without event type.
1876
1837
  * @interface
1877
1838
  */
1878
- declare type BoundsChangeEvent = BaseWindowEvent & {
1839
+ declare type BoundsChangeEvent = BaseEvent_5 & {
1879
1840
  changeType: 0 | 1 | 2;
1880
1841
  deferred: boolean;
1881
1842
  height: number;
@@ -1947,76 +1908,76 @@ declare interface BrowserWindow {
1947
1908
  }
1948
1909
 
1949
1910
  /**
1950
- * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
1911
+ * Extracts a single event type matching the given key from the View {@link Event} union.
1951
1912
  *
1952
1913
  * Alias for {@link Payload}, which may read better in source.
1953
1914
  *
1954
1915
  * @typeParam Type String key specifying the event to extract
1955
1916
  */
1956
- declare type ByType<Type extends ApplicationEventType> = Payload_2<Type>;
1917
+ declare type ByType<Type extends EventType> = Payload_2<Type>;
1957
1918
 
1958
1919
  /**
1959
- * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
1920
+ * Extracts a single event type matching the given key from the Window {@link Event} union.
1960
1921
  *
1961
1922
  * Alias for {@link Payload}, which may read better in source.
1962
1923
  *
1963
1924
  * @typeParam Type String key specifying the event to extract
1964
1925
  */
1965
- declare type ByType_2<Type extends ExternalApplicationEventType> = Payload_3<Type>;
1926
+ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1966
1927
 
1967
1928
  /**
1968
- * Extracts a single event type matching the given key from the {@link FrameEvent} union.
1929
+ * Extracts a single event type matching the given key from the Application {@link Event} union.
1969
1930
  *
1970
1931
  * Alias for {@link Payload}, which may read better in source.
1971
1932
  *
1972
1933
  * @typeParam Type String key specifying the event to extract
1973
1934
  */
1974
- declare type ByType_3<Type extends FrameEventType> = Payload_4<Type>;
1935
+ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1975
1936
 
1976
1937
  /**
1977
- * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
1938
+ * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
1978
1939
  *
1979
1940
  * Alias for {@link Payload}, which may read better in source.
1980
1941
  *
1981
1942
  * @typeParam Type String key specifying the event to extract
1982
1943
  */
1983
- declare type ByType_4<Type extends GlobalHotkeyEventType> = Payload_5<Type>;
1944
+ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
1984
1945
 
1985
1946
  /**
1986
- * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
1947
+ * Extracts a single event type matching the given key from the Frame {@link Event} union.
1987
1948
  *
1988
1949
  * Alias for {@link Payload}, which may read better in source.
1989
1950
  *
1990
1951
  * @typeParam Type String key specifying the event to extract
1991
1952
  */
1992
- declare type ByType_5<Type extends PlatformEventType> = Payload_6<Type>;
1953
+ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
1993
1954
 
1994
1955
  /**
1995
- * Extracts a single event type matching the given key from the {@link SystemEvent} union.
1956
+ * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
1996
1957
  *
1997
1958
  * Alias for {@link Payload}, which may read better in source.
1998
1959
  *
1999
1960
  * @typeParam Type String key specifying the event to extract
2000
1961
  */
2001
- declare type ByType_6<Type extends SystemEventType> = Payload_7<Type>;
1962
+ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
2002
1963
 
2003
1964
  /**
2004
- * Extracts a single event type matching the given key from the {@link ViewEvent} union.
1965
+ * Extracts a single event type matching the given key from the Platform {@link Event} union.
2005
1966
  *
2006
1967
  * Alias for {@link Payload}, which may read better in source.
2007
1968
  *
2008
1969
  * @typeParam Type String key specifying the event to extract
2009
1970
  */
2010
- declare type ByType_7<Type extends ViewEventType> = Payload_8<Type>;
1971
+ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
2011
1972
 
2012
1973
  /**
2013
- * Extracts a single event type matching the given key from the {@link WindowEvent} union.
1974
+ * Extracts a single event type matching the given key from the System {@link Event} union.
2014
1975
  *
2015
1976
  * Alias for {@link Payload}, which may read better in source.
2016
1977
  *
2017
1978
  * @typeParam Type String key specifying the event to extract
2018
1979
  */
2019
- declare type ByType_8<Type extends WindowEventType> = Payload_9<Type>;
1980
+ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
2020
1981
 
2021
1982
  /**
2022
1983
  * Configuration for page capture.
@@ -2682,14 +2643,6 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
2682
2643
 
2683
2644
  declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
2684
2645
 
2685
- /**
2686
- * Generated when a Channel client is connected.
2687
- * @interface
2688
- */
2689
- declare type ChannelConnectedEvent = BaseChannelEvent & {
2690
- type: 'connected';
2691
- };
2692
-
2693
2646
  /**
2694
2647
  * Options provided on a client connection to a channel.
2695
2648
  *
@@ -2721,21 +2674,9 @@ declare type ChannelCreateOptions = {
2721
2674
  };
2722
2675
 
2723
2676
  /**
2724
- * Generated when a Channel client has disconnected.
2725
- * @interface
2726
- */
2727
- declare type ChannelDisconnectedEvent = BaseChannelEvent & {
2728
- type: 'disconnected';
2729
- };
2730
-
2731
- /**
2732
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
2733
- * discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
2734
- * under the {@link OpenFin.ChannelEvents} namespace.
2677
+ * @deprecated Renamed to {@link Event}.
2735
2678
  */
2736
- declare type ChannelEvent = {
2737
- topic: 'channel';
2738
- } & (ChannelConnectedEvent | ChannelDisconnectedEvent);
2679
+ declare type ChannelEvent = Event_2;
2739
2680
 
2740
2681
  declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
2741
2682
 
@@ -3089,20 +3030,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
3089
3030
  connectionUrl: string;
3090
3031
  };
3091
3032
 
3092
- /**
3093
- * @PORTED
3094
- * WriteRequestType interface
3095
- * @typedef { object } WriteRequestType@typedef { object } WriteRequestType
3096
- * @property { string } data Data to be written
3097
- * @property { string } [type] Clipboard Type
3098
- */
3099
- /**
3100
- * @PORTED
3101
- * OpenFin.WriteAnyClipboardRequest interface
3102
- * @typedef { object } OpenFin.WriteAnyClipboardRequest@typedef { object } OpenFin.WriteAnyClipboardRequest
3103
- * @property { string } data Data to be written
3104
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
3105
- */
3106
3033
  /**
3107
3034
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
3108
3035
  *
@@ -3270,11 +3197,19 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
3270
3197
  * Generated when an application is closed.
3271
3198
  * @interface
3272
3199
  */
3273
- declare type ClosedEvent = IdentityEvent & {
3200
+ declare type ClosedEvent = BaseEvents.IdentityEvent & {
3274
3201
  topic: 'application';
3275
3202
  type: 'closed';
3276
3203
  };
3277
3204
 
3205
+ /**
3206
+ * Generated when a window has closed.
3207
+ * @interface
3208
+ */
3209
+ declare type ClosedEvent_2 = BaseEvent_5 & {
3210
+ type: 'closed';
3211
+ };
3212
+
3278
3213
  /**
3279
3214
  * @interface
3280
3215
  */
@@ -3282,6 +3217,15 @@ declare type ClosedMenuResult = {
3282
3217
  result: 'closed';
3283
3218
  };
3284
3219
 
3220
+ /**
3221
+ * Generated when a window has been prevented from closing.
3222
+ * @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.
3223
+ * @interface
3224
+ */
3225
+ declare type CloseRequestedEvent = BaseEvent_5 & {
3226
+ type: 'close-requested';
3227
+ };
3228
+
3285
3229
  /**
3286
3230
  * @interface
3287
3231
  */
@@ -3328,6 +3272,14 @@ declare interface CloseWindowPayload {
3328
3272
  };
3329
3273
  }
3330
3274
 
3275
+ /**
3276
+ * Generated when a window has initiated the closing routine.
3277
+ * @interface
3278
+ */
3279
+ declare type ClosingEvent = BaseEvent_5 & {
3280
+ type: 'closing';
3281
+ };
3282
+
3331
3283
  /**
3332
3284
  * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
3333
3285
  */
@@ -3411,6 +3363,39 @@ export declare function connect(config: ConnectConfig): Promise<Fin<'external co
3411
3363
 
3412
3364
  declare type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
3413
3365
 
3366
+ /**
3367
+ * Generated when a Channel client is connected.
3368
+ * @interface
3369
+ */
3370
+ declare type ConnectedEvent = BaseEvent_2 & {
3371
+ type: 'connected';
3372
+ };
3373
+
3374
+ /**
3375
+ * Generated when an application has authenticated and is connected.
3376
+ * @interface
3377
+ */
3378
+ declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
3379
+ topic: 'application';
3380
+ type: 'connected';
3381
+ };
3382
+
3383
+ /**
3384
+ * Generated when an external application has authenticated and is connected.
3385
+ * @interface
3386
+ */
3387
+ declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
3388
+ type: 'connected';
3389
+ };
3390
+
3391
+ /**
3392
+ * Generated when a frame is connected.
3393
+ * @interface
3394
+ */
3395
+ declare type ConnectedEvent_4 = BaseFrameEvent & {
3396
+ type: 'connected';
3397
+ };
3398
+
3414
3399
  declare type Constructor<T = {}> = new () => T;
3415
3400
 
3416
3401
  declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
@@ -3421,6 +3406,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
3421
3406
  * @interface
3422
3407
  */
3423
3408
  declare type ConstViewOptions = {
3409
+ /**
3410
+ * Configurations for API injection.
3411
+ */
3412
+ api: Api;
3424
3413
  /**
3425
3414
  * The name of the view.
3426
3415
  */
@@ -3501,9 +3490,13 @@ declare type ConstViewOptions = {
3501
3490
  /**
3502
3491
  * Controls interaction of the view with its parent window's download shelf.
3503
3492
  */
3504
- downloadShelf?: {
3493
+ downloadShelf: {
3505
3494
  /**
3506
- * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
3495
+ * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow.
3496
+ *
3497
+ * @remarks If `enabled: true`, downloads from this view will cause the download shelf to display
3498
+ * on the parent window even if that parent window's {@link DownloadShelfOptions} specify
3499
+ * `enabled: false`.
3507
3500
  */
3508
3501
  enabled: boolean;
3509
3502
  };
@@ -3569,7 +3562,7 @@ declare type ConstWindowOptions = {
3569
3562
  /**
3570
3563
  * @defaultValue true
3571
3564
  *
3572
- * Toggling off would keep the Window alive even if all its Views were closed.
3565
+ * Setting this to false would keep the Window alive even if all its Views were closed.
3573
3566
  * This is meant for advanced users and should be used with caution.
3574
3567
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3575
3568
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
@@ -3579,7 +3572,8 @@ declare type ConstWindowOptions = {
3579
3572
  /**
3580
3573
  * @defaultValue 'all'
3581
3574
  *
3582
- * Determines which views prevent close if `closeOnLastViewRemoved` is set to true. Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3575
+ * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3576
+ + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3583
3577
  * **NOTE:** - This option is ignored in non-Platforms apps.
3584
3578
  */
3585
3579
  viewsPreventingClose: 'all' | 'layout';
@@ -3618,6 +3612,12 @@ declare type ConstWindowOptions = {
3618
3612
  * launches in favor of the cached value.
3619
3613
  */
3620
3614
  defaultWidth: number;
3615
+ /**
3616
+ * Controls the styling and behavior of the window download shelf.
3617
+ *
3618
+ * @remarks This will control the styling for the download shelf regardless of whether its display was
3619
+ * triggered by the window itself, or a view targeting the window.
3620
+ */
3621
3621
  downloadShelf: DownloadShelfOptions;
3622
3622
  height: number;
3623
3623
  layout: any;
@@ -4152,7 +4152,7 @@ declare type Context_3 = {
4152
4152
  * Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
4153
4153
  * @interface
4154
4154
  */
4155
- declare type ContextChangedEvent = BaseWindowEvent & {
4155
+ declare type ContextChangedEvent = BaseEvent_5 & {
4156
4156
  type: 'context-changed';
4157
4157
  context: any;
4158
4158
  };
@@ -4304,7 +4304,7 @@ declare type CpuInfo = {
4304
4304
  * Generated when an application has crashed.
4305
4305
  * @interface
4306
4306
  */
4307
- declare type CrashedEvent = IdentityEvent & {
4307
+ declare type CrashedEvent = BaseEvents.IdentityEvent & {
4308
4308
  topic: 'application';
4309
4309
  type: 'crashed';
4310
4310
  reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
@@ -4355,7 +4355,7 @@ declare type CrashReporterState = CrashReporterOptions & {
4355
4355
  * Generated when a View is created.
4356
4356
  * @interface
4357
4357
  */
4358
- declare type CreatedEvent = BaseViewEvent & {
4358
+ declare type CreatedEvent = BaseEvent_4 & {
4359
4359
  type: 'created';
4360
4360
  };
4361
4361
 
@@ -4386,7 +4386,7 @@ declare type CreateViewPayload = {
4386
4386
  /**
4387
4387
  * @interface
4388
4388
  */
4389
- declare type CreateViewTarget = LayoutIdentity & {
4389
+ declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
4390
4390
  /**
4391
4391
  * If specified, view creation will not attach to a window and caller must
4392
4392
  * insert the view into the layout explicitly
@@ -4455,21 +4455,15 @@ declare type CustomRequestHeaders = {
4455
4455
  declare type DataChannelReadyState = RTCDataChannel['readyState'];
4456
4456
 
4457
4457
  /**
4458
+ * @deprecated Use {@link OpenFin.DomainSettings} instead.
4458
4459
  * @interface
4459
4460
  */
4460
- declare type DefaultDomainSettings = {
4461
- rules: DefaultDomainSettingsRule[];
4462
- };
4461
+ declare type DefaultDomainSettings = DomainSettings;
4463
4462
 
4464
4463
  /**
4465
- * @interface
4464
+ * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4466
4465
  */
4467
- declare type DefaultDomainSettingsRule = {
4468
- match: string[];
4469
- options: {
4470
- downloadSettings: FileDownloadSettings;
4471
- };
4472
- };
4466
+ declare type DefaultDomainSettingsRule = DomainSettingsRule;
4473
4467
 
4474
4468
  declare interface DesktopAgent {
4475
4469
  open(app: TargetApp, context?: Context): Promise<void>;
@@ -4514,7 +4508,7 @@ declare interface DesktopAgent_2 {
4514
4508
  * Generated when the desktop icon is clicked while it's already running.
4515
4509
  * @interface
4516
4510
  */
4517
- declare type DesktopIconClickedEvent = BaseSystemEvent & {
4511
+ declare type DesktopIconClickedEvent = BaseEvent_8 & {
4518
4512
  type: 'desktop-icon-clicked';
4519
4513
  };
4520
4514
 
@@ -4522,10 +4516,18 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
4522
4516
  * Generated when a View is destroyed.
4523
4517
  * @interface
4524
4518
  */
4525
- declare type DestroyedEvent = BaseViewEvent & {
4519
+ declare type DestroyedEvent = BaseEvent_4 & {
4526
4520
  type: 'destroyed';
4527
4521
  };
4528
4522
 
4523
+ /**
4524
+ * @interface
4525
+ */
4526
+ declare type DeviceInfo = {
4527
+ vendorId: string | number;
4528
+ productId: string | number;
4529
+ };
4530
+
4529
4531
  /**
4530
4532
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
4531
4533
  * @interface
@@ -4623,21 +4625,45 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
4623
4625
  };
4624
4626
 
4625
4627
  /**
4626
- * A system channel will be global enough to have a presence across many apps. This gives us some hints
4627
- * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
4628
- * this is their meaning.
4628
+ * Generated when a Channel client has disconnected.
4629
+ * @interface
4629
4630
  */
4630
- declare interface DisplayMetadata {
4631
- /**
4632
- * A user-readable name for this channel, e.g: `"Red"`
4633
- */
4634
- readonly name?: string;
4635
- /**
4636
- * The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
4637
- */
4638
- readonly color?: string;
4639
- /**
4640
- * A URL of an image that can be used to display this channel
4631
+ declare type DisconnectedEvent = BaseEvent_2 & {
4632
+ type: 'disconnected';
4633
+ };
4634
+
4635
+ /**
4636
+ * Generated when an external application has disconnected.
4637
+ * @interface
4638
+ */
4639
+ declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
4640
+ type: 'disconnected';
4641
+ };
4642
+
4643
+ /**
4644
+ * Generated when a frame has disconnected.
4645
+ * @interface
4646
+ */
4647
+ declare type DisconnectedEvent_3 = BaseFrameEvent & {
4648
+ type: 'disconnected';
4649
+ };
4650
+
4651
+ /**
4652
+ * A system channel will be global enough to have a presence across many apps. This gives us some hints
4653
+ * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
4654
+ * this is their meaning.
4655
+ */
4656
+ declare interface DisplayMetadata {
4657
+ /**
4658
+ * A user-readable name for this channel, e.g: `"Red"`
4659
+ */
4660
+ readonly name?: string;
4661
+ /**
4662
+ * The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
4663
+ */
4664
+ readonly color?: string;
4665
+ /**
4666
+ * A URL of an image that can be used to display this channel
4641
4667
  */
4642
4668
  readonly glyph?: string;
4643
4669
  }
@@ -4682,6 +4708,25 @@ declare type DisplayMetadata_3 = {
4682
4708
  readonly glyph?: string;
4683
4709
  };
4684
4710
 
4711
+ /**
4712
+ * @interface
4713
+ * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
4714
+ */
4715
+ declare type DomainSettings = {
4716
+ rules: DomainSettingsRule[];
4717
+ };
4718
+
4719
+ /**
4720
+ * @interface
4721
+ */
4722
+ declare type DomainSettingsRule = {
4723
+ match: string[];
4724
+ options: {
4725
+ downloadSettings?: FileDownloadSettings;
4726
+ api?: ApiInjection;
4727
+ };
4728
+ };
4729
+
4685
4730
  /**
4686
4731
  * Metadata returned from a preload script download request.
4687
4732
  *
@@ -4726,14 +4771,24 @@ declare type DownloadRule = {
4726
4771
  * @interface
4727
4772
  *
4728
4773
  * Controls the styling and behavior of the window download shelf.
4774
+ *
4775
+ * @remarks This will control the styling for the download shelf regardless of whether its display was
4776
+ * triggered by the window itself, or a view targeting the window.
4729
4777
  */
4730
4778
  declare type DownloadShelfOptions = {
4731
4779
  /**
4732
- * Whether downloads in this window trigger opening the download shelf.
4780
+ * Whether downloads in this window trigger display of the download shelf.
4781
+ *
4782
+ * @remarks Setting this to false will *not* prevent the download shelf from opening if a child view
4783
+ * with `downloadShelf: { enabled: true }` initiates a download.
4733
4784
  */
4734
4785
  enabled: boolean;
4735
4786
  /**
4736
4787
  * Styling options for the download shelf border.
4788
+ *
4789
+ * @remarks These apply regardless of whether download shelf display was
4790
+ * triggered by this window itself, or a view targeting the window. Individual views
4791
+ * cannot control the rendering of their parent window's download shelf.
4737
4792
  */
4738
4793
  border?: {
4739
4794
  /**
@@ -4743,7 +4798,7 @@ declare type DownloadShelfOptions = {
4743
4798
  */
4744
4799
  size?: number;
4745
4800
  /**
4746
- * Color of the border, either a string name or a hex code. Defaults to chromium theme
4801
+ * Color of the border. Must be a 6-character hex code prefixed by #. Defaults to chromium theme
4747
4802
  * if absent.
4748
4803
  */
4749
4804
  color?: string;
@@ -4755,7 +4810,7 @@ declare type DownloadShelfOptions = {
4755
4810
  *
4756
4811
  * @interface
4757
4812
  */
4758
- declare type DownloadShelfVisibilityChangedEvent = BaseWindowEvent & {
4813
+ declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
4759
4814
  type: 'download-shelf-visibility-changed';
4760
4815
  /**
4761
4816
  * True if the download shelf was just opened; false if it was just closed.
@@ -4785,7 +4840,7 @@ declare interface DragSource {}
4785
4840
  * Generated when a window has been embedded.
4786
4841
  * @interface
4787
4842
  */
4788
- declare type EmbeddedEvent = BaseWindowEvent & {
4843
+ declare type EmbeddedEvent = BaseEvent_5 & {
4789
4844
  type: 'embedded';
4790
4845
  };
4791
4846
 
@@ -4884,7 +4939,7 @@ declare class EmitterMap {
4884
4939
  * Generated when a window ends loading.
4885
4940
  * @interface
4886
4941
  */
4887
- declare type EndLoadEvent = BaseWindowEvent & {
4942
+ declare type EndLoadEvent = BaseEvent_5 & {
4888
4943
  type: 'end-load';
4889
4944
  documentName: string;
4890
4945
  isMain: boolean;
@@ -4962,9 +5017,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
4962
5017
  } : never;
4963
5018
 
4964
5019
  declare interface Environment {
4965
- initLayout(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5020
+ initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
4966
5021
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
4967
5022
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5023
+ resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
4968
5024
  initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
4969
5025
  observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
4970
5026
  writeToken(path: string, token: string): Promise<string>;
@@ -5001,6 +5057,88 @@ declare type ErrorPlainObject = {
5001
5057
  toString(): string;
5002
5058
  };
5003
5059
 
5060
+ /**
5061
+ * [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
5062
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5063
+ * under the {@link OpenFin.PlatformEvents} namespace.
5064
+ */
5065
+ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5066
+
5067
+ /**
5068
+ * [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
5069
+ * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5070
+ * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5071
+ * from which they propagate).
5072
+ */
5073
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
5074
+
5075
+ /**
5076
+ * [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
5077
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5078
+ * under the {@link OpenFin.ChannelEvents} namespace.
5079
+ */
5080
+ declare type Event_2 = {
5081
+ topic: 'channel';
5082
+ } & (ConnectedEvent | DisconnectedEvent);
5083
+
5084
+ /**
5085
+ * [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
5086
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5087
+ * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5088
+ * from which they propagate).
5089
+ */
5090
+ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
5091
+
5092
+ /**
5093
+ * [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
5094
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5095
+ * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5096
+ */
5097
+ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5098
+ target: OpenFin.Identity;
5099
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
5100
+
5101
+ /**
5102
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
5103
+ * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
5104
+ */
5105
+ declare type Event_5<Topic extends string> = {
5106
+ topic: Topic;
5107
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
5108
+
5109
+ /**
5110
+ * [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
5111
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5112
+ * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5113
+ */
5114
+ declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5115
+
5116
+ /**
5117
+ * [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
5118
+ * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5119
+ * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5120
+ */
5121
+ declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5122
+
5123
+ /**
5124
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
5125
+ * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5126
+ * under the {@link OpenFin.FrameEvents} namespace.
5127
+ */
5128
+ declare type Event_8 = {
5129
+ topic: 'frame';
5130
+ } & (ConnectedEvent_4 | DisconnectedEvent_3);
5131
+
5132
+ /**
5133
+ * [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
5134
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5135
+ * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5136
+ */
5137
+ declare type Event_9 = {
5138
+ topic: 'global-hotkey';
5139
+ hotkey: 'string';
5140
+ } & (RegisteredEvent | UnregisteredEvent);
5141
+
5004
5142
  declare class EventAggregator extends EmitterMap {
5005
5143
  dispatchEvent: (message: Message<any>) => boolean;
5006
5144
  }
@@ -5066,6 +5204,46 @@ declare namespace Events {
5066
5204
  }
5067
5205
  }
5068
5206
 
5207
+ /**
5208
+ * Union of possible `type` values for a view {@link Event}.
5209
+ */
5210
+ declare type EventType = Event_4['type'];
5211
+
5212
+ /**
5213
+ * Union of possible `type` values for a Window {@link Event}.
5214
+ */
5215
+ declare type EventType_2 = Event_6['type'];
5216
+
5217
+ /**
5218
+ * Union of possible `type` values for an Application {@link Event}.
5219
+ */
5220
+ declare type EventType_3 = Event_3['type'];
5221
+
5222
+ /**
5223
+ * Union of possible `type` values for an ExternalApplication {@link Event}.
5224
+ */
5225
+ declare type EventType_4 = Event_7['type'];
5226
+
5227
+ /**
5228
+ * Union of possible `type` values for a {@link FrameEvent}.
5229
+ */
5230
+ declare type EventType_5 = Event_8['type'];
5231
+
5232
+ /**
5233
+ * Union of possible `type` values for a {@link GlobalHotkeyEvent}
5234
+ */
5235
+ declare type EventType_6 = Event_9['type'];
5236
+
5237
+ /**
5238
+ * Union of possible `type` values for a {@link PlatformEvent}.
5239
+ */
5240
+ declare type EventType_7 = Event_10['type'];
5241
+
5242
+ /**
5243
+ * Union of possible `type` values for a {@link SystemEvent}.
5244
+ */
5245
+ declare type EventType_8 = Event_11['type'];
5246
+
5069
5247
  /* Excluded from this release type: EventWithId */
5070
5248
 
5071
5249
  /* Excluded from this release type: ExcludeRequested */
@@ -5096,83 +5274,6 @@ declare type ExitCode = {
5096
5274
  declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicationEvent> {
5097
5275
  identity: OpenFin.ApplicationIdentity;
5098
5276
  /* Excluded from this release type: __constructor */
5099
- /**
5100
- * Adds a listener to the end of the listeners array for the specified event.
5101
- * @param eventType - The type of the event.
5102
- * @param listener - Called whenever an event of the specified type occurs.
5103
- * @param options - Option to support event timestamps.
5104
- *
5105
- * @function addListener
5106
- * @memberof ExternalApplication
5107
- * @instance
5108
- * @tutorial ExternalApplication.EventEmitter
5109
- */
5110
- /**
5111
- * Adds a listener to the end of the listeners array for the specified event.
5112
- * @param eventType - The type of the event.
5113
- * @param listener - Called whenever an event of the specified type occurs.
5114
- * @param options - Option to support event timestamps.
5115
- *
5116
- * @function on
5117
- * @memberof ExternalApplication
5118
- * @instance
5119
- * @tutorial ExternalApplication.EventEmitter
5120
- */
5121
- /**
5122
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
5123
- * @param eventType - The type of the event.
5124
- * @param listener - The callback function.
5125
- * @param options - Option to support event timestamps.
5126
- *
5127
- * @function once
5128
- * @memberof ExternalApplication
5129
- * @instance
5130
- * @tutorial ExternalApplication.EventEmitter
5131
- */
5132
- /**
5133
- * Adds a listener to the beginning of the listeners array for the specified event.
5134
- * @param eventType - The type of the event.
5135
- * @param listener - The callback function.
5136
- * @param options - Option to support event timestamps.
5137
- *
5138
- * @function prependListener
5139
- * @memberof ExternalApplication
5140
- * @instance
5141
- * @tutorial ExternalApplication.EventEmitter
5142
- */
5143
- /**
5144
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
5145
- * The listener is added to the beginning of the listeners array.
5146
- * @param eventType - The type of the event.
5147
- * @param listener - The callback function.
5148
- * @param options - Option to support event timestamps.
5149
- *
5150
- * @function prependOnceListener
5151
- * @memberof ExternalApplication
5152
- * @instance
5153
- * @tutorial ExternalApplication.EventEmitter
5154
- */
5155
- /**
5156
- * Remove a listener from the listener array for the specified event.
5157
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5158
- * @param eventType - The type of the event.
5159
- * @param listener - The callback function.
5160
- * @param options - Option to support event timestamps.
5161
- *
5162
- * @function removeListener
5163
- * @memberof ExternalApplication
5164
- * @instance
5165
- * @tutorial ExternalApplication.EventEmitter
5166
- */
5167
- /**
5168
- * Removes all listeners, or those of the specified event.
5169
- * @param eventType - The type of the event.
5170
- *
5171
- * @function removeAllListeners
5172
- * @memberof ExternalApplication
5173
- * @instance
5174
- * @tutorial ExternalApplication.EventEmitter
5175
- */
5176
5277
  /**
5177
5278
  * Retrieves information about the external application.
5178
5279
  *
@@ -5189,46 +5290,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
5189
5290
  }
5190
5291
 
5191
5292
  /**
5192
- * Generated when an external application has authenticated and is connected.
5193
- * @interface
5293
+ * @deprecated Renamed to {@link ConnectedEvent}.
5194
5294
  */
5195
- declare type ExternalApplicationConnectedEvent = BaseExternalApplicationEvent & {
5196
- type: 'connected';
5197
- };
5295
+ declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
5198
5296
 
5199
5297
  /**
5200
- * Generated when an external application has disconnected.
5201
- * @interface
5298
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5202
5299
  */
5203
- declare type ExternalApplicationDisconnectedEvent = BaseExternalApplicationEvent & {
5204
- type: 'disconnected';
5205
- };
5300
+ declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
5206
5301
 
5207
5302
  /**
5208
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}. Events are
5209
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5210
- * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5303
+ * @deprecated Renamed to {@link Event}.
5211
5304
  */
5212
- declare type ExternalApplicationEvent = ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent;
5305
+ declare type ExternalApplicationEvent = Event_7;
5213
5306
 
5214
5307
  declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
5215
5308
 
5216
5309
  declare namespace ExternalApplicationEvents {
5217
5310
  export {
5311
+ BaseEvent_6 as BaseEvent,
5218
5312
  BaseExternalApplicationEvent,
5313
+ ConnectedEvent_3 as ConnectedEvent,
5219
5314
  ExternalApplicationConnectedEvent,
5315
+ DisconnectedEvent_2 as DisconnectedEvent,
5220
5316
  ExternalApplicationDisconnectedEvent,
5317
+ Event_7 as Event,
5221
5318
  ExternalApplicationEvent,
5319
+ EventType_4 as EventType,
5222
5320
  ExternalApplicationEventType,
5223
- Payload_3 as Payload,
5224
- ByType_2 as ByType
5321
+ Payload_5 as Payload,
5322
+ ByType_4 as ByType
5225
5323
  }
5226
5324
  }
5227
5325
 
5228
5326
  /**
5229
- * Union of possible `type` values for a {@link ApplicationEvent}.
5327
+ * @deprecated Renamed to {@link Event}.
5230
5328
  */
5231
- declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
5329
+ declare type ExternalApplicationEventType = EventType_4;
5232
5330
 
5233
5331
  /**
5234
5332
  * @interface
@@ -5293,7 +5391,7 @@ declare type ExternalConnection = {
5293
5391
  * Generated when an external process has exited.
5294
5392
  * @interface
5295
5393
  */
5296
- declare type ExternalProcessExitedEvent = BaseWindowEvent & {
5394
+ declare type ExternalProcessExitedEvent = BaseEvent_5 & {
5297
5395
  type: 'external-process-exited';
5298
5396
  processUuid: string;
5299
5397
  exitCode: number;
@@ -5338,19 +5436,15 @@ declare type ExternalProcessRequestType = {
5338
5436
  * Generated when an external process has started.
5339
5437
  * @interface
5340
5438
  */
5341
- declare type ExternalProcessStartedEvent = BaseWindowEvent & {
5439
+ declare type ExternalProcessStartedEvent = BaseEvent_5 & {
5342
5440
  type: 'external-process-started';
5343
5441
  processUuid: string;
5344
5442
  };
5345
5443
 
5346
5444
  /**
5347
- * Generated when page receives favicon urls.
5348
- * @interface
5445
+ * @deprecated, use {@link PageFaviconUpdatedEvent}.
5349
5446
  */
5350
- declare type FaviconUpdatedEvent = NamedEvent & {
5351
- type: 'page-favicon-updated';
5352
- favicons: string[];
5353
- };
5447
+ declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
5354
5448
 
5355
5449
  declare namespace FDC3 {
5356
5450
  export {
@@ -5437,7 +5531,7 @@ declare type FileDownloadEvent = {
5437
5531
  *
5438
5532
  * @interface
5439
5533
  */
5440
- declare type FileDownloadLocationChangedEvent = BaseApplicationEvent & {
5534
+ declare type FileDownloadLocationChangedEvent = BaseEvent_3 & {
5441
5535
  type: 'file-download-location-changed';
5442
5536
  };
5443
5537
 
@@ -5599,83 +5693,6 @@ declare type FoundInPageEvent = NamedEvent & {
5599
5693
  declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5600
5694
  identity: OpenFin.Identity;
5601
5695
  /* Excluded from this release type: __constructor */
5602
- /**
5603
- * Adds the listener function to the end of the listeners array for the specified event type.
5604
- * @param eventType - The type of the event.
5605
- * @param listener - Called whenever an event of the specified type occurs.
5606
- * @param options - Option to support event timestamps.
5607
- *
5608
- * @function addListener
5609
- * @memberof Frame
5610
- * @instance
5611
- * @tutorial Frame.EventEmitter
5612
- */
5613
- /**
5614
- * Adds a listener to the end of the listeners array for the specified event.
5615
- * @param eventType - The type of the event.
5616
- * @param listener - Called whenever an event of the specified type occurs.
5617
- * @param options - Option to support event timestamps.
5618
- *
5619
- * @function on
5620
- * @memberof Frame
5621
- * @instance
5622
- * @tutorial Frame.EventEmitter
5623
- */
5624
- /**
5625
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
5626
- * @param eventType - The type of the event.
5627
- * @param listener - The callback function.
5628
- * @param options - Option to support event timestamps.
5629
- *
5630
- * @function once
5631
- * @memberof Frame
5632
- * @instance
5633
- * @tutorial Frame.EventEmitter
5634
- */
5635
- /**
5636
- * Adds a listener to the beginning of the listeners array for the specified event.
5637
- * @param eventType - The type of the event.
5638
- * @param listener - The callback function.
5639
- * @param options - Option to support event timestamps.
5640
- *
5641
- * @function prependListener
5642
- * @memberof Frame
5643
- * @instance
5644
- * @tutorial Frame.EventEmitter
5645
- */
5646
- /**
5647
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
5648
- * The listener is added to the beginning of the listeners array.
5649
- * @param eventType - The type of the event.
5650
- * @param listener - The callback function.
5651
- * @param options - Option to support event timestamps.
5652
- *
5653
- * @function prependOnceListener
5654
- * @memberof Frame
5655
- * @instance
5656
- * @tutorial Frame.EventEmitter
5657
- */
5658
- /**
5659
- * Remove a listener from the listener array for the specified event.
5660
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5661
- * @param eventType - The type of the event.
5662
- * @param listener - The callback function.
5663
- * @param options - Option to support event timestamps.
5664
- *
5665
- * @function removeListener
5666
- * @memberof Frame
5667
- * @instance
5668
- * @tutorial Frame.EventEmitter
5669
- */
5670
- /**
5671
- * Removes all listeners, or those of the specified event.
5672
- * @param eventType - The type of the event.
5673
- *
5674
- * @function removeAllListeners
5675
- * @memberof Frame
5676
- * @instance
5677
- * @tutorial Frame.EventEmitter
5678
- */
5679
5696
  /**
5680
5697
  * Returns a frame info object for the represented frame.
5681
5698
  *
@@ -5706,48 +5723,43 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5706
5723
  }
5707
5724
 
5708
5725
  /**
5709
- * Generated when a frame is connected.
5710
- * @interface
5726
+ * @deprecated Renamed to {@link ConnectedEvent}.
5711
5727
  */
5712
- declare type FrameConnectedEvent = BaseFrameEvent & {
5713
- type: 'connected';
5714
- };
5728
+ declare type FrameConnectedEvent = ConnectedEvent_4;
5715
5729
 
5716
5730
  /**
5717
- * Generated when a frame has disconnected.
5718
- * @interface
5731
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5719
5732
  */
5720
- declare type FrameDisconnectedEvent = BaseFrameEvent & {
5721
- type: 'disconnected';
5722
- };
5733
+ declare type FrameDisconnectedEvent = DisconnectedEvent_3;
5723
5734
 
5724
5735
  /**
5725
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
5726
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5727
- * under the {@link OpenFin.FrameEvents} namespace.
5736
+ * @deprecated Renamed to {@link Event}.
5728
5737
  */
5729
- declare type FrameEvent = {
5730
- topic: 'frame';
5731
- } & (FrameConnectedEvent | FrameDisconnectedEvent);
5738
+ declare type FrameEvent = Event_8;
5732
5739
 
5733
5740
  declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
5734
5741
 
5735
5742
  declare namespace FrameEvents {
5736
5743
  export {
5744
+ BaseEvent_7 as BaseEvent,
5737
5745
  BaseFrameEvent,
5746
+ ConnectedEvent_4 as ConnectedEvent,
5738
5747
  FrameConnectedEvent,
5748
+ DisconnectedEvent_3 as DisconnectedEvent,
5739
5749
  FrameDisconnectedEvent,
5750
+ Event_8 as Event,
5740
5751
  FrameEvent,
5752
+ EventType_5 as EventType,
5741
5753
  FrameEventType,
5742
- Payload_4 as Payload,
5743
- ByType_3 as ByType
5754
+ Payload_6 as Payload,
5755
+ ByType_5 as ByType
5744
5756
  }
5745
5757
  }
5746
5758
 
5747
5759
  /**
5748
- * Union of possible `type` values for a {@link FrameEvent}.
5760
+ * @deprecated Renamed to {@link EventType}.
5749
5761
  */
5750
- declare type FrameEventType = FrameEvent['type'];
5762
+ declare type FrameEventType = EventType_5;
5751
5763
 
5752
5764
  /**
5753
5765
  * @interface
@@ -5966,14 +5978,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
5966
5978
  }
5967
5979
 
5968
5980
  /**
5969
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}. Events are
5970
- * discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5971
- * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5981
+ * @deprecated Renamed to {@link Event}.
5972
5982
  */
5973
- declare type GlobalHotkeyEvent = {
5974
- topic: 'global-hotkey';
5975
- hotkey: 'string';
5976
- } & (RegisteredEvent | UnregisteredEvent);
5983
+ declare type GlobalHotkeyEvent = Event_9;
5977
5984
 
5978
5985
  declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
5979
5986
 
@@ -5981,17 +5988,19 @@ declare namespace GlobalHotkeyEvents {
5981
5988
  export {
5982
5989
  RegisteredEvent,
5983
5990
  UnregisteredEvent,
5991
+ Event_9 as Event,
5984
5992
  GlobalHotkeyEvent,
5993
+ EventType_6 as EventType,
5985
5994
  GlobalHotkeyEventType,
5986
- Payload_5 as Payload,
5987
- ByType_4 as ByType
5995
+ Payload_7 as Payload,
5996
+ ByType_6 as ByType
5988
5997
  }
5989
5998
  }
5990
5999
 
5991
6000
  /**
5992
- * Union of possible `type` values for a {@link GlobalHotkeyEvent}
6001
+ * @deprecated Renamed to {@link EventType}.
5993
6002
  */
5994
- declare type GlobalHotkeyEventType = GlobalHotkeyEvent['type'];
6003
+ declare type GlobalHotkeyEventType = EventType_6;
5995
6004
 
5996
6005
  declare namespace GoldenLayout {
5997
6006
  export {
@@ -6293,16 +6302,25 @@ declare interface Header {
6293
6302
  * Generated when a View is hidden.
6294
6303
  * @interface
6295
6304
  */
6296
- declare type HiddenEvent = BaseViewEvent & {
6305
+ declare type HiddenEvent = BaseEvent_4 & {
6297
6306
  type: 'hidden';
6298
6307
  };
6299
6308
 
6309
+ /**
6310
+ * Generated when a window has been hidden.
6311
+ * @interface
6312
+ */
6313
+ declare type HiddenEvent_2 = BaseEvent_5 & {
6314
+ type: 'hidden';
6315
+ reason: 'closing' | 'hide' | 'hide-on-close';
6316
+ };
6317
+
6300
6318
  /**
6301
6319
  * Generated when the context of a View's host window changes, either due to a call to {@link Platform#setWindowContext Platform.setWindowContext},
6302
6320
  * or because the View has moved to a new window. Only available on Views in a Platform.
6303
6321
  * @interface
6304
6322
  */
6305
- declare type HostContextChangedEvent = BaseViewEvent & {
6323
+ declare type HostContextChangedEvent = BaseEvent_4 & {
6306
6324
  type: 'host-context-changed';
6307
6325
  context: any;
6308
6326
  reason: 'reparented' | 'updated';
@@ -6381,7 +6399,16 @@ declare type Hotkey = {
6381
6399
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6382
6400
  * @interface
6383
6401
  */
6384
- declare type HotkeyEvent = BaseViewEvent & {
6402
+ declare type HotkeyEvent = BaseEvent_4 & {
6403
+ type: 'hotkey';
6404
+ };
6405
+
6406
+ /**
6407
+ * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
6408
+ * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6409
+ * @interface
6410
+ */
6411
+ declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
6385
6412
  type: 'hotkey';
6386
6413
  };
6387
6414
 
@@ -6434,6 +6461,11 @@ declare type IdentityEvent = BaseEvent & {
6434
6461
 
6435
6462
  /* Excluded from this release type: IdEventType */
6436
6463
 
6464
+ /**
6465
+ * @deprecated Renamed to {@link IdleStateChangedEvent}.
6466
+ */
6467
+ declare type IdleEvent = IdleStateChangedEvent;
6468
+
6437
6469
  /**
6438
6470
  * Generated when a user enters or returns from idle state.
6439
6471
  * @remarks This method is continuously generated every minute while the user is in idle.
@@ -6441,7 +6473,7 @@ declare type IdentityEvent = BaseEvent & {
6441
6473
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6442
6474
  * @interface
6443
6475
  */
6444
- declare type IdleEvent = BaseSystemEvent & {
6476
+ declare type IdleStateChangedEvent = BaseEvent_8 & {
6445
6477
  type: 'idle-state-changed';
6446
6478
  elapsedTime: number;
6447
6479
  isIdle: boolean;
@@ -6526,11 +6558,19 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6526
6558
  * Generated when an application has initialized.
6527
6559
  * @interface
6528
6560
  */
6529
- declare type InitializedEvent = IdentityEvent & {
6561
+ declare type InitializedEvent = BaseEvents.IdentityEvent & {
6530
6562
  topic: 'application';
6531
6563
  type: 'initialized';
6532
6564
  };
6533
6565
 
6566
+ /**
6567
+ * Generated when a window is initialized.
6568
+ * @interface
6569
+ */
6570
+ declare type InitializedEvent_2 = BaseEvent_5 & {
6571
+ type: 'initialized';
6572
+ };
6573
+
6534
6574
  /**
6535
6575
  * @interface
6536
6576
  */
@@ -6571,6 +6611,13 @@ declare type InitPlatformOptions = {
6571
6611
  interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
6572
6612
  };
6573
6613
 
6614
+ /**
6615
+ * * 'none': The `fin` API will be not available from within this context.
6616
+ * * 'global': The entire `fin` API will be available from within this context.
6617
+ * @defaultValue 'global'
6618
+ */
6619
+ declare type InjectionType = 'none' | 'global';
6620
+
6574
6621
  /**
6575
6622
  * Generated when the value of the element changes.
6576
6623
  * @interface
@@ -6915,56 +6962,6 @@ declare class InteropBroker extends Base {
6915
6962
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
6916
6963
  new (): InteropBroker;
6917
6964
  };
6918
- /**
6919
- * @REMOVED
6920
- * SetContextOptions interface
6921
- * @typedef { object } SetContextOptions@typedef { object } SetContextOptions
6922
- * @property { Context } {context} - New context to set.
6923
- */
6924
- /**
6925
- * @REMOVED
6926
- * GetContextOptions interface
6927
- * @typedef { object } GetContextOptions@typedef { object } GetContextOptions
6928
- * @property { string } [contextType] - Context Type
6929
- */
6930
- /**
6931
- * @REMOVED
6932
- * JoinContextGroupOptions interface
6933
- * @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
6934
- * @property { string } contextGroupId - Id of the context group.
6935
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
6936
- */
6937
- /**
6938
- * @REMOVED
6939
- * AddClientToContextGroupOptions interface
6940
- * @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
6941
- * @property { string } contextGroupId - Name of the context group.
6942
- */
6943
- /**
6944
- * @REMOVED
6945
- * RemoveFromContextGroupOptions interface
6946
- * @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
6947
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
6948
- */
6949
- /**
6950
- * @REMOVED
6951
- * GetInfoForContextGroupOptions interface
6952
- * @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
6953
- * @property { string } contextGroupId - Name of the context group to get info for.
6954
- */
6955
- /**
6956
- * @REMOVED
6957
- * GetAllClientsInContextGroupOptions interface
6958
- * @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
6959
- * @property { string } contextGroupId - Name of the context group to get info for.
6960
- */
6961
- /**
6962
- * @PORTED
6963
- * InfoForIntentOptions interface
6964
- * @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
6965
- * @property { string } name Name of the intent to get info for.
6966
- * @property { Context } [context] Optional context.
6967
- */
6968
6965
  /**
6969
6966
  * Sets a context for the context group of the incoming current entity.
6970
6967
  * @param setContextOptions - New context to set.
@@ -7208,7 +7205,7 @@ declare class InteropBroker extends Base {
7208
7205
  * // }
7209
7206
  * ```
7210
7207
  *
7211
- * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
7208
+ * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
7212
7209
  *
7213
7210
  * @param contextForIntent Data passed between entities and applications.
7214
7211
  * @param clientIdentity Identity of the Client making the request.
@@ -7465,97 +7462,6 @@ declare type InteropBrokerOptions = {
7465
7462
  };
7466
7463
 
7467
7464
  /**
7468
- * @PORTED
7469
- * @typedef { object } Intent
7470
- * @summary The combination of an action and a context that is passed to an application for resolution.
7471
- * @property { string } name Name of the intent.
7472
- * @property { Context } context Data associated with the intent
7473
- */
7474
- /**
7475
- * @REMOVED
7476
- * @typedef { object } Subscription
7477
- * @summary Object returned when subscribing a handler.
7478
- * @property { function } unsubscribe Function to unsubscribe the handler.
7479
- */
7480
- /**
7481
- * @typedef { function } ContextHandler
7482
- * @summary Subscription function for addContextHandler.
7483
- */
7484
- /**
7485
- * @typedef { function } IntentHandler
7486
- * @summary Subscription function for registerIntentHandler
7487
- */
7488
- /**
7489
- * @PORTED
7490
- * @typedef { object } ClientIdentity
7491
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
7492
- * @property {string} uuid GUID of an application.
7493
- * @property {string} name Name of an entity in an application.
7494
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
7495
- */
7496
- /**
7497
- * @PORTED
7498
- * @typedef { object } ContextGroupInfo
7499
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
7500
- * @property {string} id Name of the context group
7501
- * @property {DisplayMetadata} displayMetadata Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
7502
- */
7503
- /**
7504
- * @PORTED
7505
- * @typedef { object } DisplayMetadata
7506
- * @summary The display data for a Context Group.
7507
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
7508
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
7509
- * @property {string} [glyph] A URL of an image that can be used to display this context group
7510
- */
7511
- /**
7512
- * @PORTED
7513
- * @typedef { object } Context
7514
- * @summary Data passed between entities and applications.
7515
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7516
- * @property {string} [name] User-readable name for the incoming context.
7517
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7518
- */
7519
- /**
7520
- * @REMOVED
7521
- * @typedef { object } ContextForIntent
7522
- * @summary Data passed between entities and applications, including an optional metadata.
7523
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7524
- * @property {string} [name] User-readable name for the incoming context.
7525
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7526
- * @property {any} [metadata]
7527
- */
7528
- /**
7529
- * @REMOVED
7530
- * @typedef { object } SessionContextGroup
7531
- * @summary An instance of a SessionContextGroup
7532
- * @property {string} id The SessionContextGroup's id.
7533
- * @property {setContext} setContext Sets a context of a certain type
7534
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
7535
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
7536
- */
7537
- /**
7538
- * @typedef {function} setContext
7539
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
7540
- * @param context The Context to be set.
7541
- *
7542
- */
7543
- /**
7544
- * @typedef {function} getCurrentContext
7545
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
7546
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
7547
- *
7548
- */
7549
- /**
7550
- * @typedef {function} addContextHandler
7551
- * @summary A SessionContextGroup instance method for adding a handler for context change.
7552
- * @param contextHandler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
7553
- * @param contextType The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
7554
- *
7555
- */
7556
- /**
7557
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
7558
- *
7559
7465
  * The Interop Client API is broken up into two groups:
7560
7466
  *
7561
7467
  * **Content Facing APIs** - For Application Developers putting Views into a Platform Window, who care about Context. These are APIs that send out and receive the Context data that flows between applications. Think of this as the Water in the Interop Pipes.
@@ -7958,7 +7864,7 @@ declare class InteropClient extends Base {
7958
7864
  * ```
7959
7865
  */
7960
7866
  onDisconnection(listener: OpenFin.InteropClientOnDisconnectionListener): Promise<void>;
7961
- static ferryFdc3Call(interopClient: OpenFin.InteropClient, action: string, payload?: any): Promise<any>;
7867
+ /* Excluded from this release type: ferryFdc3Call */
7962
7868
  }
7963
7869
 
7964
7870
  /**
@@ -7988,13 +7894,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
7988
7894
  */
7989
7895
  declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
7990
7896
 
7991
- /**
7992
- * @PORTED
7993
- * @typedef { object } InteropConfig
7994
- * @summary Information relevant to the Interop Broker.
7995
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
7996
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
7997
- */
7998
7897
  /**
7999
7898
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
8000
7899
  *
@@ -8384,7 +8283,7 @@ declare type LaunchIntoPlatformPayload = {
8384
8283
  declare class Layout extends Base {
8385
8284
  #private;
8386
8285
  /* Excluded from this release type: init */
8387
- identity: OpenFin.LayoutIdentity;
8286
+ identity: OpenFin.Identity | OpenFin.LayoutIdentity;
8388
8287
  private platform;
8389
8288
  wire: Transport;
8390
8289
  /* Excluded from this release type: __constructor */
@@ -8600,25 +8499,24 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
8600
8499
  */
8601
8500
  declare type LayoutIdentity = Identity_5 & {
8602
8501
  /**
8603
- * The name of the layout an action should be targeted to. When not provided,
8604
- * OpenFin attempts to resolve the instance via visibility checks.
8502
+ * The name of the layout in a given window.
8605
8503
  */
8606
- layoutName?: string;
8504
+ layoutName: string;
8607
8505
  };
8608
8506
 
8609
8507
  /**
8610
- * Generated when a window and all of its layout's views have either finished or failed navigation.
8508
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8509
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8611
8510
  * @interface
8612
8511
  */
8613
- declare type LayoutInitializedEvent = BaseWindowEvent & {
8512
+ declare type LayoutInitializedEvent = BaseEvent_5 & {
8614
8513
  type: 'layout-initialized';
8514
+ layoutIdentity: OpenFin.LayoutIdentity;
8615
8515
  ofViews: (OpenFin.Identity & {
8616
8516
  entityType: 'view';
8617
8517
  })[];
8618
8518
  };
8619
8519
 
8620
- /* Excluded from this release type: LayoutInstance */
8621
-
8622
8520
  /**
8623
8521
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
8624
8522
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
@@ -8646,7 +8544,7 @@ declare type LayoutItemConfig = {
8646
8544
  *
8647
8545
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
8648
8546
  *
8649
- * Responsible for aggergating all layout snapshots and storing LayoutInstances
8547
+ * Responsible for aggregating all layout snapshots and storing layout instances
8650
8548
  */
8651
8549
  declare interface LayoutManager<T extends LayoutSnapshot> {
8652
8550
  /**
@@ -8670,16 +8568,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
8670
8568
  * @throws if Object.keys(snapshot).length > 1
8671
8569
  */
8672
8570
  applyLayoutSnapshot(snapshot: T): Promise<void>;
8673
- /**
8674
- * Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
8675
- * contains a single layout.
8676
- *
8677
- * Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
8678
- * fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
8679
- *
8680
- * @param snapshot
8681
- * @throws if Object.keys(snapshot).length > 1
8682
- */
8683
8571
  /**
8684
8572
  * @experimental
8685
8573
  *
@@ -8700,31 +8588,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
8700
8588
  /**
8701
8589
  * @experimental
8702
8590
  *
8703
- * @param layoutIdentity
8704
- * @returns
8591
+ * A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
8592
+ * this method to control the target layout for Layout API calls.
8593
+ *
8594
+ * Example use case: You have hidden all the layouts and are showing a dialog that will
8595
+ * execute an API call (ex: Layout.replace()) - override this method and save the
8596
+ * "last visible" layout identity and return it.
8597
+ *
8598
+ * By default, OpenFin will use a series of checks to determine which Layout the API
8599
+ * call must route to in this order of precedence:
8600
+ * - try to resolve the layout from the layoutIdentity, throws if missing
8601
+ * - if there is only 1 layout, resolves that one
8602
+ * - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
8603
+ * - returns undefined
8604
+ *
8605
+ * @param identity
8606
+ * @returns LayoutIdentity | undefined
8705
8607
  */
8706
- resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
8608
+ resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
8707
8609
  /**
8708
8610
  * @experimental
8709
8611
  *
8710
- * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
8711
- * Throws if it does not exist.
8712
- * @param layoutName
8713
- * @returns
8612
+ * A hook provided to the consumer when it's time to remove a layout. Use this hook to
8613
+ * update your local state and remove the layout for the given LayoutIdentity. Note that
8614
+ * this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
8615
+ * signify to your application it's time to destroy this layout.
8616
+ *
8617
+ * Note that if the Window Option {@link WindowOptions.closeOnLastViewRemoved} is true, and the last View in this layout is closed, this hook will be called before the window closes.
8618
+ *
8619
+ * @param LayoutIdentity
8714
8620
  */
8715
- getLayoutByName(layoutName: string): LayoutInstance;
8621
+ removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
8716
8622
  /**
8717
8623
  * @experimental
8718
8624
  */
8719
- getLayouts(): Record<string, LayoutInstance>;
8625
+ getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
8720
8626
  /**
8721
8627
  * @experimental
8722
8628
  */
8723
- getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
8629
+ isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8724
8630
  /**
8725
8631
  * @experimental
8726
8632
  */
8727
- isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8633
+ size(): number;
8728
8634
  }
8729
8635
 
8730
8636
  /**
@@ -8771,7 +8677,7 @@ declare class LayoutModule extends Base {
8771
8677
  * const layoutConfig = await layout.getConfig();
8772
8678
  * ```
8773
8679
  */
8774
- wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
8680
+ wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
8775
8681
  /**
8776
8682
  * Synchronously returns a Layout object that represents a Window's layout.
8777
8683
  *
@@ -8791,7 +8697,7 @@ declare class LayoutModule extends Base {
8791
8697
  * const layoutConfig = await layout.getConfig();
8792
8698
  * ```
8793
8699
  */
8794
- wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
8700
+ wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
8795
8701
  /**
8796
8702
  * Asynchronously returns a Layout object that represents a Window's layout.
8797
8703
  *
@@ -8888,7 +8794,7 @@ declare type LayoutOptions = {
8888
8794
  * @defaultValue false
8889
8795
  *
8890
8796
  * Limits the area to which tabs can be dragged.
8891
- * If true, stack headers are the only areas where tabs can be dropped.
8797
+ * If true, the layout container is the only area where tabs can be dropped.
8892
8798
  */
8893
8799
  constrainDragToContainer?: boolean;
8894
8800
  /**
@@ -8959,19 +8865,23 @@ declare type LayoutOptions = {
8959
8865
  };
8960
8866
  };
8961
8867
 
8868
+ /**
8869
+ * Represents the position of an item in a layout relative to another.
8870
+ */
8962
8871
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
8963
8872
 
8964
8873
  /**
8965
- * @interface
8874
+ * Layout preset type.
8966
8875
  */
8967
8876
  declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
8968
8877
 
8969
8878
  /**
8970
- * Generated when a window and all of its layout's views have been created and can receive API calls.
8879
+ * Generated when the layout and all of the its views have been created and can receive API calls.
8971
8880
  * @interface
8972
8881
  */
8973
- declare type LayoutReadyEvent = BaseWindowEvent & {
8882
+ declare type LayoutReadyEvent = BaseEvent_5 & {
8974
8883
  type: 'layout-ready';
8884
+ layoutIdentity: OpenFin.LayoutIdentity;
8975
8885
  views: (OpenFin.Identity & {
8976
8886
  success: boolean;
8977
8887
  })[];
@@ -9111,7 +9021,7 @@ declare type Manifest = {
9111
9021
  * Generated when the RVM notifies an application that the manifest has changed.
9112
9022
  * @interface
9113
9023
  */
9114
- declare type ManifestChangedEvent = IdentityEvent & {
9024
+ declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
9115
9025
  topic: 'application';
9116
9026
  type: 'manifest-changed';
9117
9027
  };
@@ -9164,7 +9074,7 @@ declare type MatchPattern = string;
9164
9074
  * Generated when a window is maximized.
9165
9075
  * @interface
9166
9076
  */
9167
- declare type MaximizedEvent = BaseWindowEvent & {
9077
+ declare type MaximizedEvent = BaseEvent_5 & {
9168
9078
  type: 'maximized';
9169
9079
  };
9170
9080
 
@@ -9274,7 +9184,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
9274
9184
  * Generated when a window is minimized.
9275
9185
  * @interface
9276
9186
  */
9277
- declare type MinimizedEvent = BaseWindowEvent & {
9187
+ declare type MinimizedEvent = BaseEvent_5 & {
9278
9188
  type: 'minimized';
9279
9189
  };
9280
9190
 
@@ -9318,14 +9228,9 @@ declare type MonitorDetails = {
9318
9228
  };
9319
9229
 
9320
9230
  /**
9321
- * Generated on changes of a monitor's size/location.
9322
- * @remarks A monitor's size changes when the taskbar is resized or relocated.
9323
- * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9324
- * @interface
9231
+ * @deprecated Renamed to {@link MonitorInfoChangedEvent}.
9325
9232
  */
9326
- declare type MonitorEvent = BaseSystemEvent & OpenFin.MonitorInfo & {
9327
- type: 'monitor-info-changed';
9328
- };
9233
+ declare type MonitorEvent = MonitorInfoChangedEvent;
9329
9234
 
9330
9235
  /**
9331
9236
  * @interface
@@ -9349,6 +9254,16 @@ declare type MonitorInfo = {
9349
9254
  virtualScreen: DipRect;
9350
9255
  };
9351
9256
 
9257
+ /**
9258
+ * Generated on changes of a monitor's size/location.
9259
+ * @remarks A monitor's size changes when the taskbar is resized or relocated.
9260
+ * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9261
+ * @interface
9262
+ */
9263
+ declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9264
+ type: 'monitor-info-changed';
9265
+ };
9266
+
9352
9267
  /**
9353
9268
  * @interface
9354
9269
  */
@@ -9671,7 +9586,7 @@ declare type MutableWindowOptions = {
9671
9586
  showTaskbarIcon: boolean;
9672
9587
  interop: InteropConfig;
9673
9588
  /* Excluded from this release type: _internalWorkspaceData */
9674
- workspacePlatform: WorkspacePlatformOptions;
9589
+ /* Excluded from this release type: workspacePlatform */
9675
9590
  };
9676
9591
 
9677
9592
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -9745,13 +9660,15 @@ declare type NonPropagatedWebContentsEvent = never;
9745
9660
  */
9746
9661
  declare type NonPropagatedWindowEvent = never;
9747
9662
 
9663
+ /* Excluded from this release type: NotCloseRequested */
9664
+
9748
9665
  /* Excluded from this release type: NotRequested */
9749
9666
 
9750
9667
  /**
9751
9668
  * Generated when an application is not responding.
9752
9669
  * @interface
9753
9670
  */
9754
- declare type NotRespondingEvent = IdentityEvent & {
9671
+ declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
9755
9672
  topic: 'application';
9756
9673
  type: 'not-responding';
9757
9674
  };
@@ -9857,6 +9774,7 @@ declare namespace OpenFin {
9857
9774
  ResizeRegion,
9858
9775
  Accelerator,
9859
9776
  Api,
9777
+ InjectionType,
9860
9778
  NavigationRules,
9861
9779
  ContentNavigation,
9862
9780
  ContentRedirect,
@@ -9902,6 +9820,7 @@ declare namespace OpenFin {
9902
9820
  WebPermission,
9903
9821
  VerboseWebPermission,
9904
9822
  OpenExternalPermission,
9823
+ DeviceInfo,
9905
9824
  Permissions_2 as Permissions,
9906
9825
  PlatformWindowCreationOptions,
9907
9826
  PlatformWindowOptions,
@@ -10003,6 +9922,9 @@ declare namespace OpenFin {
10003
9922
  RuntimeInfo,
10004
9923
  DefaultDomainSettings,
10005
9924
  DefaultDomainSettingsRule,
9925
+ DomainSettings,
9926
+ ApiInjection,
9927
+ DomainSettingsRule,
10006
9928
  FileDownloadBehaviorNames,
10007
9929
  FileDownloadSettings,
10008
9930
  DownloadRule,
@@ -10059,7 +9981,6 @@ declare namespace OpenFin {
10059
9981
  InitLayoutOptions,
10060
9982
  LayoutManagerConstructor,
10061
9983
  LayoutManagerOverride,
10062
- LayoutInstance,
10063
9984
  LayoutManager,
10064
9985
  CreateLayoutOptions,
10065
9986
  PresetLayoutOptions_2 as PresetLayoutOptions,
@@ -10077,7 +9998,7 @@ declare namespace OpenFin {
10077
9998
  AppVersionCompleteEvent,
10078
9999
  AppVersionRuntimeStatusEvent,
10079
10000
  Events,
10080
- BaseEvent_2 as BaseEvent,
10001
+ BaseEvent_9 as BaseEvent,
10081
10002
  WebContentsEvent_2 as WebContentsEvent,
10082
10003
  SystemEvent_2 as SystemEvent,
10083
10004
  ApplicationEvent_2 as ApplicationEvent,
@@ -10119,12 +10040,32 @@ export default OpenFin;
10119
10040
 
10120
10041
  declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
10121
10042
 
10043
+ /**
10044
+ * Generated after window options are changed using the window.updateOptions method.
10045
+ * @remarks Will not fire if the diff object is empty.
10046
+ * @interface
10047
+ */
10048
+ declare type OptionsChangedEvent = BaseEvent_5 & {
10049
+ type: 'options-changed';
10050
+ options: OpenFin.WindowOptions;
10051
+ diff: OpenFin.WindowOptionDiff;
10052
+ };
10053
+
10122
10054
  declare type OverlapsOnlyIfMatching<T, U> = {
10123
10055
  [K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
10124
10056
  };
10125
10057
 
10126
10058
  declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
10127
10059
 
10060
+ /**
10061
+ * Generated when page receives favicon urls.
10062
+ * @interface
10063
+ */
10064
+ declare type PageFaviconUpdatedEvent = NamedEvent & {
10065
+ type: 'page-favicon-updated';
10066
+ favicons: string[];
10067
+ };
10068
+
10128
10069
  /**
10129
10070
  * Generated when page title is set during navigation.
10130
10071
  * @remarks explicitSet is false when title is synthesized from file url.
@@ -10143,74 +10084,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10143
10084
  };
10144
10085
 
10145
10086
  /**
10146
- * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
10087
+ * Extracts a single event type matching the given key from the View {@link Event} union.
10147
10088
  *
10148
10089
  * @typeParam Type String key specifying the event to extract
10149
10090
  */
10150
- declare type Payload_2<Type extends ApplicationEventType> = Extract<ApplicationEvent, {
10091
+ declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10151
10092
  type: Type;
10152
10093
  }>;
10153
10094
 
10154
10095
  /**
10155
- * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
10096
+ * Extracts a single event type matching the given key from the Window {@link Event} union.
10156
10097
  *
10157
10098
  * @typeParam Type String key specifying the event to extract
10158
10099
  */
10159
- declare type Payload_3<Type extends ExternalApplicationEventType> = Extract<ExternalApplicationEvent, {
10100
+ declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10160
10101
  type: Type;
10161
10102
  }>;
10162
10103
 
10163
10104
  /**
10164
- * Extracts a single event type matching the given key from the {@link FrameEvent} union.
10105
+ * Extracts a single event type matching the given key from the Application {@link Event} union.
10165
10106
  *
10166
10107
  * @typeParam Type String key specifying the event to extract
10167
10108
  */
10168
- declare type Payload_4<Type extends FrameEventType> = Extract<FrameEvent, {
10109
+ declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10169
10110
  type: Type;
10170
10111
  }>;
10171
10112
 
10172
10113
  /**
10173
- * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
10114
+ * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
10174
10115
  *
10175
10116
  * @typeParam Type String key specifying the event to extract
10176
10117
  */
10177
- declare type Payload_5<Type extends GlobalHotkeyEventType> = Extract<GlobalHotkeyEvent, {
10118
+ declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10178
10119
  type: Type;
10179
10120
  }>;
10180
10121
 
10181
10122
  /**
10182
- * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
10123
+ * Extracts a single event type matching the given key from the Frame {@link Event} union.
10183
10124
  *
10184
10125
  * @typeParam Type String key specifying the event to extract
10185
10126
  */
10186
- declare type Payload_6<Type extends PlatformEventType> = Extract<PlatformEvent, {
10127
+ declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10187
10128
  type: Type;
10188
10129
  }>;
10189
10130
 
10190
10131
  /**
10191
- * Extracts a single event type matching the given key from the {@link SystemEvent} union.
10132
+ * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
10192
10133
  *
10193
10134
  * @typeParam Type String key specifying the event to extract
10194
10135
  */
10195
- declare type Payload_7<Type extends SystemEventType> = Extract<SystemEvent, {
10136
+ declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10196
10137
  type: Type;
10197
10138
  }>;
10198
10139
 
10199
10140
  /**
10200
- * Extracts a single event type matching the given key from the {@link ViewEvent} union.
10141
+ * Extracts a single event type matching the given key from the Platform {@link Event} union.
10201
10142
  *
10202
10143
  * @typeParam Type String key specifying the event to extract
10203
10144
  */
10204
- declare type Payload_8<Type extends ViewEventType> = Extract<ViewEvent, {
10145
+ declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10205
10146
  type: Type;
10206
10147
  }>;
10207
10148
 
10208
10149
  /**
10209
- * Extracts a single event type matching the given key from the {@link WindowEvent} union.
10150
+ * Extracts a single event type matching the given key from the System {@link Event} union.
10210
10151
  *
10211
10152
  * @typeParam Type String key specifying the event to extract
10212
10153
  */
10213
- declare type Payload_9<Type extends WindowEventType> = Extract<WindowEvent, {
10154
+ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10214
10155
  type: Type;
10215
10156
  }>;
10216
10157
 
@@ -10220,7 +10161,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
10220
10161
  * Generated when window finishes loading. Provides performance and navigation data.
10221
10162
  * @interface
10222
10163
  */
10223
- declare type PerformanceReportEvent = Performance & BaseWindowEvent & {
10164
+ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
10224
10165
  type: 'performance-report';
10225
10166
  };
10226
10167
 
@@ -10231,6 +10172,7 @@ declare type Permissions_2 = {
10231
10172
  Application?: Partial<ApplicationPermissions>;
10232
10173
  System?: Partial<SystemPermissions>;
10233
10174
  webAPIs?: WebPermission[];
10175
+ devices?: DeviceInfo[];
10234
10176
  };
10235
10177
 
10236
10178
  declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -10854,38 +10796,36 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
10854
10796
  }
10855
10797
 
10856
10798
  /**
10857
- * Generated when a new Platform's API becomes responsive.
10858
- * @interface
10799
+ * @deprecated Renamed to {@link ApiReadyEvent}.
10859
10800
  */
10860
- declare type PlatformApiReadyEvent = BaseEvent & {
10861
- topic: 'application';
10862
- type: 'platform-api-ready';
10863
- };
10801
+ declare type PlatformApiReadyEvent = ApiReadyEvent;
10864
10802
 
10865
10803
  /**
10866
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}. Events are
10867
- * discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
10868
- * under the {@link OpenFin.PlatformEvents} namespace.
10804
+ * @deprecated Renamed to {@link Event}.
10869
10805
  */
10870
- declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
10806
+ declare type PlatformEvent = Event_10;
10871
10807
 
10872
10808
  declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
10873
10809
 
10874
10810
  declare namespace PlatformEvents {
10875
10811
  export {
10812
+ ApiReadyEvent,
10876
10813
  PlatformApiReadyEvent,
10814
+ SnapshotAppliedEvent,
10877
10815
  PlatformSnapshotAppliedEvent,
10816
+ Event_10 as Event,
10878
10817
  PlatformEvent,
10818
+ EventType_7 as EventType,
10879
10819
  PlatformEventType,
10880
- Payload_6 as Payload,
10881
- ByType_5 as ByType
10820
+ Payload_8 as Payload,
10821
+ ByType_7 as ByType
10882
10822
  }
10883
10823
  }
10884
10824
 
10885
10825
  /**
10886
- * Union of possible `type` values for a {@link PlatformEvent}.
10826
+ * @deprecated Renamed to {@link }.
10887
10827
  */
10888
- declare type PlatformEventType = PlatformEvent['type'];
10828
+ declare type PlatformEventType = EventType_7;
10889
10829
 
10890
10830
  /**
10891
10831
  * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
@@ -11145,7 +11085,17 @@ declare interface PlatformProvider {
11145
11085
  */
11146
11086
  getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
11147
11087
  /* Excluded from this release type: getInitialLayoutSnapshot */
11148
- /* Excluded from this release type: createViewsForLayout */
11088
+ /**
11089
+ * @experimental
11090
+ *
11091
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11092
+ * Gets the current state of a particular window and its views and returns an object that
11093
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11094
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11095
+ * @param identity
11096
+ * @param callerIdentity
11097
+ */
11098
+ getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
11149
11099
  /* Excluded from this release type: getViewSnapshot */
11150
11100
  /**
11151
11101
  * Called when a snapshot is being applied and some windows in that snapshot would be fully or partially off-screen.
@@ -11550,19 +11500,9 @@ declare interface PlatformProvider {
11550
11500
  }
11551
11501
 
11552
11502
  /**
11553
- * Generated when a platform.ApplySnapshot call is resolved.
11554
- * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
11555
- * 1. The window has been created
11556
- * 2. The window has a responsive API
11557
- * 3. If a window has a layout property, the 'layout-ready' event has fired
11558
- *
11559
- * _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
11560
- * @interface
11503
+ * @deprecated Renamed to {@link SnapshotAppliedEvent}.
11561
11504
  */
11562
- declare type PlatformSnapshotAppliedEvent = BaseEvent & {
11563
- topic: 'application';
11564
- type: 'platform-snapshot-applied';
11565
- };
11505
+ declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
11566
11506
 
11567
11507
  /**
11568
11508
  * @interface
@@ -11830,7 +11770,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
11830
11770
  * A general preload scripts state change event without event type.
11831
11771
  * @interface
11832
11772
  */
11833
- declare type PreloadScriptsStateChangeEvent = BaseWindowEvent & {
11773
+ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11834
11774
  preloadScripts: (PreloadScriptInfoRunning & any)[];
11835
11775
  };
11836
11776
 
@@ -12039,51 +11979,43 @@ declare type ProcessLoggingOptions = {
12039
11979
  };
12040
11980
 
12041
11981
  /**
12042
- * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
12043
- * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
12044
- * are propagated to `System` without any type string prefixing.
12045
- *
12046
- * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
11982
+ * @deprecated Renamed to {@link PropagatedEvent}.
12047
11983
  */
12048
- declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
11984
+ declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
12049
11985
 
12050
11986
  /**
12051
- * Union of possible 'type' values for a {@link OpenFin.ApplicationEvents.PropagatedApplicationEvent}.
11987
+ * @deprecated Renamed to {@link PropagatedEventType}.
12052
11988
  */
12053
- declare type PropagatedApplicationEventType = PropagatedApplicationEvent<string>['type'];
11989
+ declare type PropagatedApplicationEventType = PropagatedEventType_3;
12054
11990
 
12055
11991
  /**
12056
- * Modifies an event shape to reflect propagation to a parent topic.
11992
+ * Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
11993
+ * these do not propagate.
11994
+ *
12057
11995
  * @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
11996
+ *
11997
+ * @typeParam SourceTopic The topic the event shape is propagating from.
11998
+ * @typeParam TargetTopic The topic the event shape is propagating to.
11999
+ * @typeParam Event The shape of the event being propagated.
12058
12000
  */
12059
12001
  declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
12060
12002
  type: string;
12061
12003
  }> = Event extends infer E extends {
12062
12004
  type: string;
12063
- } ? Omit<E, 'type' | 'topic'> & {
12005
+ } ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
12064
12006
  type: PropagatedEventType<SourceTopic, E['type']>;
12065
12007
  topic: TargetTopic;
12066
12008
  } : never;
12067
12009
 
12068
- /**
12069
- * Modifies an event key to reflect propagation by prefixing with the topic.
12070
- */
12071
- declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
12072
-
12073
12010
  /**
12074
12011
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
12075
12012
  * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
12076
12013
  * event type key with `'view-'`.
12077
12014
  */
12078
- declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12015
+ declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12079
12016
  viewIdentity: OpenFin.Identity;
12080
12017
  };
12081
12018
 
12082
- /**
12083
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
12084
- */
12085
- declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
12086
-
12087
12019
  /**
12088
12020
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
12089
12021
  * prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
@@ -12092,12 +12024,51 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
12092
12024
  *
12093
12025
  * "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
12094
12026
  */
12095
- declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent<'window', TargetTopic, Exclude<WindowSourcedEvent, WindowCloseRequestedEvent>>;
12027
+ declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
12028
+
12029
+ /**
12030
+ * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
12031
+ * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
12032
+ * are propagated to `System` without any type string prefixing.
12033
+ *
12034
+ * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
12035
+ */
12036
+ declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
12096
12037
 
12097
12038
  /**
12098
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.PropagatedWindowEvent}.
12039
+ * Modifies an event type key to reflect propagation by prefixing with the topic.
12099
12040
  */
12100
- declare type PropagatedWindowEventType = PropagatedWindowEvent<string>['type'];
12041
+ declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
12042
+
12043
+ /**
12044
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
12045
+ */
12046
+ declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
12047
+
12048
+ /**
12049
+ * Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
12050
+ */
12051
+ declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
12052
+
12053
+ /**
12054
+ * @deprecated Renamed to {@link PropagatedEvent}.
12055
+ */
12056
+ declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
12057
+
12058
+ /**
12059
+ * @deprecated Renamed to {@link PropagatedEventType}.
12060
+ */
12061
+ declare type PropagatedViewEventType = PropagatedEventType_2;
12062
+
12063
+ /**
12064
+ * @deprecated Renamed to {@link PropagatedEvent}.
12065
+ */
12066
+ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
12067
+
12068
+ /**
12069
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
12070
+ */
12071
+ declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
12101
12072
 
12102
12073
  declare interface ProtocolMap extends ProtocolMapBase {
12103
12074
  'request-external-authorization': {
@@ -12515,7 +12486,7 @@ declare type RegistryInfo_2 = {
12515
12486
  * Generated when a window has been reloaded.
12516
12487
  * @interface
12517
12488
  */
12518
- declare type ReloadedEvent = BaseWindowEvent & {
12489
+ declare type ReloadedEvent = BaseEvent_5 & {
12519
12490
  type: 'reloaded';
12520
12491
  url: string;
12521
12492
  };
@@ -12552,7 +12523,7 @@ declare type ReplaceLayoutPayload = {
12552
12523
  /**
12553
12524
  * Identity of the window whose layout will be replaced.
12554
12525
  */
12555
- target: LayoutIdentity;
12526
+ target: Identity_5 | LayoutIdentity;
12556
12527
  };
12557
12528
 
12558
12529
  /**
@@ -12651,11 +12622,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
12651
12622
  * Generated when an application is responding.
12652
12623
  * @interface
12653
12624
  */
12654
- declare type RespondingEvent = IdentityEvent & {
12625
+ declare type RespondingEvent = BaseEvents.IdentityEvent & {
12655
12626
  topic: 'application';
12656
12627
  type: 'responding';
12657
12628
  };
12658
12629
 
12630
+ /**
12631
+ * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
12632
+ * @interface
12633
+ */
12634
+ declare type RestoredEvent = BaseEvent_5 & {
12635
+ type: 'restored';
12636
+ };
12637
+
12659
12638
  declare type ResultBehavior = 'close' | 'hide' | 'none';
12660
12639
 
12661
12640
  /**
@@ -12718,7 +12697,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12718
12697
  * Generated when Application.run() is called for an already running application.
12719
12698
  * @interface
12720
12699
  */
12721
- declare type RunRequestedEvent_2 = IdentityEvent & {
12700
+ declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12722
12701
  topic: 'application';
12723
12702
  type: 'run-requested';
12724
12703
  userAppConfigArgs: Record<string, any>;
@@ -12900,7 +12879,7 @@ declare type ServiceIdentifier = {
12900
12879
  * Generated on changes to a user’s local computer session.
12901
12880
  * @interface
12902
12881
  */
12903
- declare type SessionChangedEvent = BaseSystemEvent & {
12882
+ declare type SessionChangedEvent = BaseEvent_8 & {
12904
12883
  type: 'session-changed';
12905
12884
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
12906
12885
  };
@@ -13122,7 +13101,7 @@ declare type ShortcutOverride = Hotkey & {
13122
13101
  *
13123
13102
  * @interface
13124
13103
  */
13125
- declare type ShowAllDownloadsEvent = BaseWindowEvent & {
13104
+ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
13126
13105
  type: 'show-all-downloads';
13127
13106
  };
13128
13107
 
@@ -13130,7 +13109,15 @@ declare type ShowAllDownloadsEvent = BaseWindowEvent & {
13130
13109
  * Generated when a View is shown. This event will fire during creation of a View.
13131
13110
  * @interface
13132
13111
  */
13133
- declare type ShownEvent = BaseViewEvent & {
13112
+ declare type ShownEvent = BaseEvent_4 & {
13113
+ type: 'shown';
13114
+ };
13115
+
13116
+ /**
13117
+ * Generated when a hidden window has been shown.
13118
+ * @interface
13119
+ */
13120
+ declare type ShownEvent_2 = BaseEvent_5 & {
13134
13121
  type: 'shown';
13135
13122
  };
13136
13123
 
@@ -13159,6 +13146,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
13159
13146
  y?: number;
13160
13147
  };
13161
13148
 
13149
+ /**
13150
+ * Generated when a window has been prevented from showing.
13151
+ * @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.
13152
+ * @interface
13153
+ */
13154
+ declare type ShowRequestedEvent = BaseEvent_5 & {
13155
+ type: 'show-requested';
13156
+ };
13157
+
13162
13158
  /**
13163
13159
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
13164
13160
  *
@@ -13205,6 +13201,21 @@ declare type Snapshot = {
13205
13201
  };
13206
13202
  };
13207
13203
 
13204
+ /**
13205
+ * Generated when a platform.ApplySnapshot call is resolved.
13206
+ * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
13207
+ * 1. The window has been created
13208
+ * 2. The window has a responsive API
13209
+ * 3. If a window has a layout property, the 'layout-ready' event has fired
13210
+ *
13211
+ * _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.
13212
+ * @interface
13213
+ */
13214
+ declare type SnapshotAppliedEvent = BaseEvent & {
13215
+ topic: 'application';
13216
+ type: 'platform-snapshot-applied';
13217
+ };
13218
+
13208
13219
  /**
13209
13220
  * @interface
13210
13221
  */
@@ -13319,7 +13330,7 @@ declare class SnapshotSourceModule extends Base {
13319
13330
  * Generated when an application has started.
13320
13331
  * @interface
13321
13332
  */
13322
- declare type StartedEvent = IdentityEvent & {
13333
+ declare type StartedEvent = BaseEvents.IdentityEvent & {
13323
13334
  topic: 'application';
13324
13335
  type: 'started';
13325
13336
  };
@@ -13343,83 +13354,6 @@ declare type SubscriptionOptions = {
13343
13354
  declare class System extends EmitterBase<OpenFin.SystemEvent> {
13344
13355
  /* Excluded from this release type: __constructor */
13345
13356
  private sendExternalProcessRequest;
13346
- /**
13347
- * Adds a listener to the end of the listeners array for the specified event.
13348
- * @param eventType - The type of the event.
13349
- * @param listener - Called whenever an event of the specified type occurs.
13350
- * @param options - Option to support event timestamps.
13351
- *
13352
- * @function addListener
13353
- * @memberof System
13354
- * @instance
13355
- * @tutorial System.EventEmitter
13356
- */
13357
- /**
13358
- * Adds a listener to the end of the listeners array for the specified event.
13359
- * @param eventType - The type of the event.
13360
- * @param listener - Called whenever an event of the specified type occurs.
13361
- * @param options - Option to support event timestamps.
13362
- *
13363
- * @function on
13364
- * @memberof System
13365
- * @instance
13366
- * @tutorial System.EventEmitter
13367
- */
13368
- /**
13369
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
13370
- * @param eventType - The type of the event.
13371
- * @param listener - The callback function.
13372
- * @param options - Option to support event timestamps.
13373
- *
13374
- * @function once
13375
- * @memberof System
13376
- * @instance
13377
- * @tutorial System.EventEmitter
13378
- */
13379
- /**
13380
- * Adds a listener to the beginning of the listeners array for the specified event.
13381
- * @param eventType - The type of the event.
13382
- * @param listener - The callback function.
13383
- * @param options - Option to support event timestamps.
13384
- *
13385
- * @function prependListener
13386
- * @memberof System
13387
- * @instance
13388
- * @tutorial System.EventEmitter
13389
- */
13390
- /**
13391
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
13392
- * The listener is added to the beginning of the listeners array.
13393
- * @param eventType - The type of the event.
13394
- * @param listener - The callback function.
13395
- * @param options - Option to support event timestamps.
13396
- *
13397
- * @function prependOnceListener
13398
- * @memberof System
13399
- * @instance
13400
- * @tutorial System.EventEmitter
13401
- */
13402
- /**
13403
- * Remove a listener from the listener array for the specified event.
13404
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
13405
- * @param eventType - The type of the event.
13406
- * @param listener - The callback function.
13407
- * @param options - Option to support event timestamps.
13408
- *
13409
- * @function removeListener
13410
- * @memberof System
13411
- * @instance
13412
- * @tutorial System.EventEmitter
13413
- */
13414
- /**
13415
- * Removes all listeners, or those of the specified event.
13416
- * @param eventType - The type of the event.
13417
- *
13418
- * @function removeAllListeners
13419
- * @memberof System
13420
- * @instance
13421
- * @tutorial System.EventEmitter
13422
- */
13423
13357
  /**
13424
13358
  * Returns the version of the runtime. The version contains the major, minor,
13425
13359
  * build and revision numbers.
@@ -14852,12 +14786,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
14852
14786
  };
14853
14787
 
14854
14788
  /**
14855
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
14856
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
14857
- * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
14858
- * from which they propagate).
14789
+ * @deprecated Renamed to {@link Event}.
14859
14790
  */
14860
- declare type SystemEvent = ExcludeRequested<PropagatedWindowEvent<'system'>> | PropagatedViewEvent<'system'> | PropagatedApplicationEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
14791
+ declare type SystemEvent = Event_11;
14861
14792
 
14862
14793
  declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
14863
14794
 
@@ -14865,8 +14796,10 @@ declare namespace SystemEvents {
14865
14796
  export {
14866
14797
  NotRequested,
14867
14798
  ExcludeRequested,
14868
- BaseSystemEvent,
14799
+ BaseEvent_8 as BaseEvent,
14800
+ IdleStateChangedEvent,
14869
14801
  IdleEvent,
14802
+ MonitorInfoChangedEvent,
14870
14803
  MonitorEvent,
14871
14804
  SessionChangedEvent,
14872
14805
  AppVersionEvent,
@@ -14880,17 +14813,19 @@ declare namespace SystemEvents {
14880
14813
  ApplicationCreatedEvent,
14881
14814
  DesktopIconClickedEvent,
14882
14815
  SystemShutdownEvent,
14816
+ Event_11 as Event,
14883
14817
  SystemEvent,
14818
+ EventType_8 as EventType,
14884
14819
  SystemEventType,
14885
- Payload_7 as Payload,
14886
- ByType_6 as ByType
14820
+ Payload_9 as Payload,
14821
+ ByType_8 as ByType
14887
14822
  }
14888
14823
  }
14889
14824
 
14890
14825
  /**
14891
- * Union of possible `type` values for a {@link SystemEvent}.
14826
+ * @deprecated Renamed to {@link EventType}.
14892
14827
  */
14893
- declare type SystemEventType = SystemEvent['type'];
14828
+ declare type SystemEventType = EventType_8;
14894
14829
 
14895
14830
  /**
14896
14831
  * @interface
@@ -15002,20 +14937,6 @@ declare interface TabDragListener extends EventEmitter_2 {
15002
14937
  contentItem: ContentItem;
15003
14938
  }
15004
14939
 
15005
- /**
15006
- * @typedef {string} LayoutPosition
15007
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
15008
- */
15009
- /**
15010
- * @typedef {object} StackCreationOptions
15011
- * @summary Stack creation options.
15012
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
15013
- */
15014
- /**
15015
- * @typedef {object} TabStack~AddViewOptions
15016
- * @summary Options to use when adding a view to a {@link TabStack}
15017
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
15018
- */
15019
14940
  /**
15020
14941
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15021
14942
  */
@@ -15143,7 +15064,7 @@ declare type TargetApp = string | AppMetadata;
15143
15064
  * In that case, previousTarget identity will be the same as target identity.
15144
15065
  * @interface
15145
15066
  */
15146
- declare type TargetChangedEvent = BaseViewEvent & {
15067
+ declare type TargetChangedEvent = BaseEvent_4 & {
15147
15068
  type: 'target-changed';
15148
15069
  previousTarget: OpenFin.Identity;
15149
15070
  };
@@ -15297,7 +15218,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15297
15218
  * Generated when the tray icon is clicked.
15298
15219
  * @interface
15299
15220
  */
15300
- declare type TrayIconClickedEvent = IdentityEvent & {
15221
+ declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
15301
15222
  topic: 'application';
15302
15223
  type: 'tray-icon-clicked';
15303
15224
  button: 0 | 1 | 2;
@@ -15387,7 +15308,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15387
15308
  * A general user bounds change event without event type.
15388
15309
  * @interface
15389
15310
  */
15390
- declare type UserBoundsChangeEvent = BaseWindowEvent & {
15311
+ declare type UserBoundsChangeEvent = BaseEvent_5 & {
15391
15312
  height: number;
15392
15313
  left: number;
15393
15314
  top: number;
@@ -15399,7 +15320,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
15399
15320
  * Generated when a window's user movement becomes disabled.
15400
15321
  * @interface
15401
15322
  */
15402
- declare type UserMovementDisabledEvent = BaseWindowEvent & {
15323
+ declare type UserMovementDisabledEvent = BaseEvent_5 & {
15403
15324
  type: 'user-movement-disabled';
15404
15325
  };
15405
15326
 
@@ -15407,7 +15328,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
15407
15328
  * Generated when a window's user movement becomes enabled.
15408
15329
  * @interface
15409
15330
  */
15410
- declare type UserMovementEnabledEvent = BaseWindowEvent & {
15331
+ declare type UserMovementEnabledEvent = BaseEvent_5 & {
15411
15332
  type: 'user-movement-enabled';
15412
15333
  };
15413
15334
 
@@ -15461,172 +15382,9 @@ declare type VerboseWebPermission = {
15461
15382
  declare type View = OpenFin.View;
15462
15383
 
15463
15384
  /**
15464
- * @PORTED
15465
- * @typedef {object} View~options
15466
- * @summary View creation options.
15467
- * @desc This is the options object required by {@link View.create View.create}.
15468
- *
15469
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
15470
- * (defaults to `"about:blank"` when omitted).
15471
- *
15472
- * @property {object} [experimental]
15473
- * Configurations for API injection.
15474
- *
15475
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
15476
- *
15477
- * @property {object} [accelerator]
15478
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
15479
- *
15480
- * @property {boolean} [accelerator.devtools=false]
15481
- * If `true`, enables the devtools keyboard shortcut:<br>
15482
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
15483
- *
15484
- * @property {boolean} [accelerator.reload=false]
15485
- * If `true`, enables the reload keyboard shortcuts:<br>
15486
- * `Ctrl` + `R` _(Windows)_<br>
15487
- * `F5` _(Windows)_<br>
15488
- * `Command` + `R` _(Mac)_
15489
- *
15490
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
15491
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
15492
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
15493
- * `Shift` + `F5` _(Windows)_<br>
15494
- * `Command` + `Shift` + `R` _(Mac)_
15495
- *
15496
- * @property {boolean} [accelerator.zoom=false]
15497
- * If `true`, enables the zoom keyboard shortcuts:<br>
15498
- * `Ctrl` + `+` _(Zoom In)_<br>
15499
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
15500
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
15501
- * `Ctrl` + `-` _(Zoom Out)_<br>
15502
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
15503
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
15504
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
15505
- * `Ctrl` + `0` _(Restore to 100%)_
15506
- *
15507
- * @property {object} [api]
15508
- * Configurations for API injection.
15509
- *
15510
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
15511
- *
15512
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
15513
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
15514
- *
15515
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
15516
- * Autoplay policy to apply to content in the window, can be
15517
- * `no-user-gesture-required`, `user-gesture-required`,
15518
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
15519
- *
15520
- * @property {object} [autoResize] AutoResize options
15521
- *
15522
- * @property {object} [bounds] initial bounds given relative to the window.
15523
- *
15524
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
15525
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
15526
- * (`document.body.style.backgroundColor`),
15527
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
15528
- * areas when growing a window. Setting
15529
- * this value to the anticipated content background color can help improve user experience.
15530
- * Default is white.
15531
- *
15532
- * @property {object} [contentNavigation]
15533
- * Restrict navigation to URLs that match an allowed pattern.
15534
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
15535
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15536
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
15537
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
15538
- *
15539
- * @property {object} [contentRedirect]
15540
- * Restrict redirects to URLs that match an allowed pattern.
15541
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
15542
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15543
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
15544
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
15545
- *
15546
- * @property {object} [contextMenuSettings] - _Updatable._
15547
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
15548
- * Configure the context menu when right-clicking on a view.
15549
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
15550
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
15551
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
15552
- *
15553
- * @property {object} [contextMenuOptions] - _Updatable._
15554
- * Configure the context menu when right-clicking on a view. Supported menu items:
15555
- * 'separator'
15556
- * 'cut'
15557
- * 'copy'
15558
- * 'copyImage',
15559
- * 'paste'
15560
- * 'spellCheck'
15561
- * 'inspect'
15562
- * 'reload'
15563
- * 'navigateForward'
15564
- * 'navigateBack'
15565
- * 'print'
15566
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
15567
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
15568
- *
15569
- * @property {any} [customData=""] - _Updatable._
15570
- * A field that the user can attach serializable data to be ferried around with the view options.
15571
- * _When omitted, the default value of this property is the empty string (`""`)._
15572
- *
15573
- * @property {any} [customContext=""] - _Updatable._
15574
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
15575
- * is called.
15576
- * When omitted, the default value of this property is the empty string (`""`).
15577
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
15578
- *
15579
- * @property {object[]} [hotkeys=[]] - _Updatable._
15580
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
15581
- * Within Platform, OpenFin also implements a set of pre-defined actions called
15582
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
15583
- * that can be assigned to a specific hotkey in the platform manifest.
15584
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
15585
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
15586
- *
15587
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
15588
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
15589
- * if the view isn't part of the new layout when running `Layout.replace`.
15590
- *
15591
- * @property {string} name
15592
- * The name of the view.
15593
- *
15594
- * @property {boolean} [detachOnClose=false] - _Updatable._
15595
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
15596
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
15597
- *
15598
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
15599
- * but the properties in the manifest will take precedence if there is any collision.
15600
- *
15601
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
15602
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
15603
- * from the parent application.
15604
- *
15605
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
15606
- *
15607
- * @property {string} [processAffinity=<application uuid>]
15608
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
15609
- *
15610
- * @property {boolean} [spellCheck=false]
15611
- * Enable spell check in input text fields for the view.
15612
- *
15613
- * @property {Identity} [target]
15614
- * The identity of the window this view should be attached to.
15615
- *
15616
- * @property {string} [url="about:blank"]
15617
- * The URL of the view.
15618
- *
15619
- * @property {string} [uuid=<application uuid>]
15620
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
15621
- * If omitted, defaults to the `uuid` of the application spawning the view.
15622
- * If given, must match the `uuid` of the application spawning the view.
15623
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
15624
- * really no need to provide it.
15625
- */
15626
- /**
15627
- * A View can be used to embed additional web content into a Window.
15628
- * It is like a child window, except it is positioned relative to its owning window.
15629
- * It has the ability to listen for {@link OpenFin.ViewEvents View-specific events}.
15385
+ * A View can be used to embed additional web content into a Window.
15386
+ * It is like a child window, except it is positioned relative to its owning window.
15387
+ * It has the ability to listen for {@link OpenFin.ViewEvents View-specific events}.
15630
15388
  *
15631
15389
  * By default, a View will try to share the same renderer process as other Views owned by its parent Application.
15632
15390
  * To change that behavior, see the processAffinity {@link OpenFin.ViewOptions view option}.
@@ -16057,7 +15815,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
16057
15815
  * Generated when a View is attached to a window.
16058
15816
  * @interface
16059
15817
  */
16060
- declare type ViewAttachedEvent = BaseWindowEvent & {
15818
+ declare type ViewAttachedEvent = BaseEvent_5 & {
16061
15819
  type: 'view-attached';
16062
15820
  target: OpenFin.Identity;
16063
15821
  viewIdentity: OpenFin.Identity;
@@ -16099,26 +15857,23 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
16099
15857
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
16100
15858
  * @interface
16101
15859
  */
16102
- declare type ViewDetachedEvent = BaseWindowEvent & {
15860
+ declare type ViewDetachedEvent = BaseEvent_5 & {
16103
15861
  type: 'view-detached';
16104
- target: OpenFin.Identity;
15862
+ target: OpenFin.Identity | null;
16105
15863
  previousTarget: OpenFin.Identity;
16106
15864
  viewIdentity: OpenFin.Identity;
16107
15865
  };
16108
15866
 
16109
15867
  /**
16110
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
16111
- * discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
16112
- * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
15868
+ * @deprecated Renamed to {@link Event}.
16113
15869
  */
16114
- declare type ViewEvent = (WebContentsEvent<'view'> & {
16115
- target: OpenFin.Identity;
16116
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
15870
+ declare type ViewEvent = Event_4;
16117
15871
 
16118
15872
  declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
16119
15873
 
16120
15874
  declare namespace ViewEvents {
16121
15875
  export {
15876
+ BaseEvent_4 as BaseEvent,
16122
15877
  BaseViewEvent,
16123
15878
  TargetChangedEvent,
16124
15879
  NonPropagatedViewEvent,
@@ -16128,20 +15883,24 @@ declare namespace ViewEvents {
16128
15883
  HotkeyEvent,
16129
15884
  ShownEvent,
16130
15885
  HostContextChangedEvent,
15886
+ Event_4 as Event,
16131
15887
  ViewEvent,
16132
15888
  WillPropagateViewEvent,
15889
+ EventType,
16133
15890
  ViewEventType,
15891
+ PropagatedEvent_2 as PropagatedEvent,
16134
15892
  PropagatedViewEvent,
15893
+ PropagatedEventType_2 as PropagatedEventType,
16135
15894
  PropagatedViewEventType,
16136
- Payload_8 as Payload,
16137
- ByType_7 as ByType
15895
+ Payload_2 as Payload,
15896
+ ByType
16138
15897
  }
16139
15898
  }
16140
15899
 
16141
15900
  /**
16142
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.ViewEvent}.
15901
+ * @deprecated Renamed to {@link EventType}.
16143
15902
  */
16144
- declare type ViewEventType = ViewEvent['type'];
15903
+ declare type ViewEventType = EventType;
16145
15904
 
16146
15905
  /**
16147
15906
  * @interface
@@ -17280,12 +17039,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17280
17039
  }
17281
17040
 
17282
17041
  /**
17283
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
17284
- * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
17042
+ * @deprecated Renamed to {@link Event}.
17285
17043
  */
17286
- declare type WebContentsEvent<Topic extends string> = {
17287
- topic: Topic;
17288
- } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
17044
+ declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
17289
17045
 
17290
17046
  declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
17291
17047
 
@@ -17297,6 +17053,7 @@ declare namespace WebContentsEvents {
17297
17053
  CrashedEvent_2 as CrashedEvent,
17298
17054
  CertificateErrorEvent,
17299
17055
  CertificateSelectionShownEvent,
17056
+ PageFaviconUpdatedEvent,
17300
17057
  FaviconUpdatedEvent,
17301
17058
  NavigationRejectedEvent,
17302
17059
  UrlChangedEvent,
@@ -17315,6 +17072,7 @@ declare namespace WebContentsEvents {
17315
17072
  FileDownloadStartedEvent,
17316
17073
  FileDownloadProgressEvent,
17317
17074
  FileDownloadCompletedEvent,
17075
+ Event_5 as Event,
17318
17076
  WebContentsEvent,
17319
17077
  WillPropagateWebContentsEvent,
17320
17078
  NonPropagatedWebContentsEvent
@@ -17337,7 +17095,7 @@ declare namespace WebContentsEvents {
17337
17095
  * `clipboard-read`: Request access to read from the clipboard.<br>
17338
17096
  * `clipboard-sanitized-write`: Request access to write to the clipboard.
17339
17097
  */
17340
- declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
17098
+ declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
17341
17099
 
17342
17100
  /**
17343
17101
  * Object representing headers and their values, where the
@@ -17362,7 +17120,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
17362
17120
  * A general will-move or will-resize event without event type.
17363
17121
  * @interface
17364
17122
  */
17365
- declare type WillMoveOrResizeEvent = BaseWindowEvent & {
17123
+ declare type WillMoveOrResizeEvent = BaseEvent_5 & {
17366
17124
  height: number;
17367
17125
  left: number;
17368
17126
  top: number;
@@ -17384,7 +17142,7 @@ declare type WillPropagateViewEvent = ViewEvent;
17384
17142
  *
17385
17143
  * A WebContents event that does propagate to (republish on) parent topics.
17386
17144
  */
17387
- declare type WillPropagateWebContentsEvent = WebContentsEvent<string>;
17145
+ declare type WillPropagateWebContentsEvent = Event_5<string>;
17388
17146
 
17389
17147
  /**
17390
17148
  * @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
@@ -17398,7 +17156,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
17398
17156
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
17399
17157
  * @interface
17400
17158
  */
17401
- declare type WillRedirectEvent = BaseWindowEvent & {
17159
+ declare type WillRedirectEvent = BaseEvent_5 & {
17402
17160
  type: 'will-redirect';
17403
17161
  blocked: boolean;
17404
17162
  isInPlace: boolean;
@@ -17415,476 +17173,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
17415
17173
  type: 'will-resize';
17416
17174
  };
17417
17175
 
17418
- /**
17419
- * @PORTED
17420
- * @typedef { object } Margins@typedef { object } Margins
17421
- * @property { string } [marginType]
17422
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
17423
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
17424
- *
17425
- * @property { number } [top] The top margin of the printed web page, in pixels.
17426
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
17427
- * @property { number } [left] The left margin of the printed web page, in pixels.
17428
- * @property { number } [right] The right margin of the printed web page, in pixels.
17429
- */
17430
- /**
17431
- * @PORTED
17432
- * @typedef { object } Dpi@typedef { object } Dpi
17433
- * @property { number } [horizontal] The horizontal dpi
17434
- * @property { number } [vertical] The vertical dpi
17435
- */
17436
- /**
17437
- * @PORTED
17438
- * @typedef { object } PrintOptions@typedef { object } PrintOptions
17439
- * @property { boolean } [silent=false] Don't ask user for print settings.
17440
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
17441
- * @property { string } [deviceName=''] Set the printer device name to use.
17442
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
17443
- * @property { Margins } [margins] Set margins for the printed web page
17444
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
17445
- * @property { number } [scaleFactor] The scale factor of the web page.
17446
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
17447
- * @property { boolean } [collate] Whether the web page should be collated.
17448
- * @property { number } [copies] The number of copies of the web page to print.
17449
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
17450
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
17451
- * @property { Dpi } [dpi] Set dpi for the printed web page
17452
- */
17453
- /**
17454
- * @REMOVED
17455
- * PrinterInfo interface
17456
- * @typedef { object } PrinterInfo@typedef { object } PrinterInfo
17457
- * @property { string } name Printer Name
17458
- * @property { string } description Printer Description
17459
- * @property { number } status Printer Status
17460
- * @property { boolean } isDefault Indicates that system's default printer
17461
- */
17462
- /**
17463
- * @REMOVED
17464
- * SharedWorkerInfo interface
17465
- * @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
17466
- * @property { string } id The unique id of the shared worker.
17467
- * @property { string } url The url of the shared worker.
17468
- */
17469
- /**
17470
- * @PORTED
17471
- * ContentCreationRule interface
17472
- * @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
17473
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
17474
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
17475
- * @property { object } options Window creation options or View creation options.
17476
- */
17477
- /**
17478
- * @PORTED
17479
- * @typedef {object} Window~options
17480
- * @summary Window creation options.
17481
- * @desc This is the options object required by {@link Window.create Window.create}.
17482
- *
17483
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
17484
- * (defaults to `"about:blank"` when omitted).
17485
- *
17486
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
17487
- *
17488
- * @property {object} [accelerator]
17489
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
17490
- *
17491
- * @property {boolean} [accelerator.devtools=false]
17492
- * If `true`, enables the devtools keyboard shortcut:<br>
17493
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
17494
- *
17495
- * @property {boolean} [accelerator.reload=false]
17496
- * If `true`, enables the reload keyboard shortcuts:<br>
17497
- * `Ctrl` + `R` _(Windows)_<br>
17498
- * `F5` _(Windows)_<br>
17499
- * `Command` + `R` _(Mac)_
17500
- *
17501
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
17502
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
17503
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
17504
- * `Shift` + `F5` _(Windows)_<br>
17505
- * `Command` + `Shift` + `R` _(Mac)_
17506
- *
17507
- * @property {boolean} [accelerator.zoom=false]
17508
- * NOTE: It is not recommended to set this value to true for Windows in Platforms as that may lead to unexpected visual shifts in layout.
17509
- * If `true`, enables the zoom keyboard shortcuts:<br>
17510
- * `Ctrl` + `+` _(Zoom In)_<br>
17511
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
17512
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
17513
- * `Ctrl` + `-` _(Zoom Out)_<br>
17514
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
17515
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
17516
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
17517
- * `Ctrl` + `0` _(Restore to 100%)_
17518
- *
17519
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
17520
- * <br>
17521
- * alphaMask turns anything of matching RGB value transparent.
17522
- * <br>
17523
- * Caveats:
17524
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
17525
- * * User cannot click-through transparent regions
17526
- * * Not supported on Mac
17527
- * * Windows Aero must be enabled
17528
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
17529
- * * Not supported on rounded corner windows
17530
- * @property {number} [alphaMask.red=-1] 0-255
17531
- * @property {number} [alphaMask.green=-1] 0-255
17532
- * @property {number} [alphaMask.blue=-1] 0-255
17533
- *
17534
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
17535
- * A flag to always position the window at the top of the window stack.
17536
- *
17537
- * @property {object} [api]
17538
- * Configurations for API injection.
17539
- *
17540
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
17541
- *
17542
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
17543
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
17544
- *
17545
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
17546
- *
17547
- * @property {number} [aspectRatio=0] - _Updatable._
17548
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
17549
- * an aspect ratio will not be enforced.
17550
- *
17551
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
17552
- * Autoplay policy to apply to content in the window, can be
17553
- * `no-user-gesture-required`, `user-gesture-required`,
17554
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
17555
- *
17556
- * @property {boolean} [autoShow=true]
17557
- * A flag to automatically show the window when it is created.
17558
- *
17559
- * @property {string} [backgroundColor="#FFF"]
17560
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
17561
- * (`document.body.style.backgroundColor`),
17562
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
17563
- * areas when growing a window. Setting
17564
- * this value to the anticipated content background color can help improve user experience.
17565
- * Default is white.
17566
- *
17567
- * @property {object} [contentCreation]
17568
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
17569
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
17570
- *
17571
- * @property {object} [contentNavigation]
17572
- * Restrict navigation to URLs that match an allowed pattern.
17573
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
17574
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17575
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
17576
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
17577
- *
17578
- * @property {object} [contentRedirect]
17579
- * Restrict redirects to URLs that match an allowed pattern.
17580
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
17581
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17582
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
17583
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
17584
- *
17585
- * @property {boolean} [contextMenu=true] - _Updatable._
17586
- * A flag to show the context menu when right-clicking on a window.
17587
- * Gives access to the devtools for the window.
17588
- *
17589
- * @property {object} [contextMenuSettings] - _Updatable._
17590
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
17591
- * Configure the context menu when right-clicking on a window.
17592
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
17593
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
17594
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
17595
- *
17596
- * @property {object} [contextMenuOptions] - _Updatable._
17597
- * Configure the context menu when right-clicking on a window. Supported menu items:
17598
- * 'separator'
17599
- * 'cut'
17600
- * 'copy'
17601
- * 'paste'
17602
- * 'spellCheck'
17603
- * 'inspect'
17604
- * 'reload'
17605
- * 'navigateForward'
17606
- * 'navigateBack'
17607
- * 'print'
17608
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
17609
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
17610
- *
17611
- * @property {object} [cornerRounding] - _Updatable._
17612
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
17613
- * average of _height_ and _width_.
17614
- * @property {number} [cornerRounding.height=0] The height in pixels.
17615
- * @property {number} [cornerRounding.width=0] The width in pixels.
17616
- *
17617
- * @property {any} [customContext=""] - _Updatable. Inheritable._
17618
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
17619
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
17620
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
17621
- * _When omitted, _inherits_ from the parent application._
17622
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
17623
- *
17624
- * @property {any} [customData=""] - _Updatable. Inheritable._
17625
- * A field that the user can attach serializable data to be ferried around with the window options.
17626
- * _When omitted, _inherits_ from the parent application._
17627
- *
17628
- * @property {object[]} [customRequestHeaders]
17629
- * Defines list of custom headers for requests sent by the window.
17630
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
17631
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
17632
- * where the object key is the name of header and value at key is the value of the header
17633
- *
17634
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
17635
- * Toggling off would keep the Window alive even if all its Views were closed.
17636
- * This is meant for advanced users and should be used with caution.
17637
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
17638
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
17639
- * ** note ** - This option is ignored in non-Platforms apps.
17640
- *
17641
- * @property {boolean} [defaultCentered=false]
17642
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
17643
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
17644
- * somewhat above center vertically.
17645
- *
17646
- * @property {number} [defaultHeight=500]
17647
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
17648
- * in favor of the cached value.
17649
- *
17650
- * @property {number} [defaultLeft=100]
17651
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17652
- * launches in favor of the cached value.
17653
- *
17654
- * @property {number} [defaultTop=100]
17655
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17656
- * launches in favor of the cached value.
17657
- *
17658
- * @property {number} [defaultWidth=800]
17659
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17660
- * launches in favor of the cached value.
17661
- *
17662
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
17663
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
17664
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
17665
- *
17666
- * @property {boolean} [frame=true] - _Updatable._
17667
- * A flag to show the frame.
17668
- *
17669
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
17670
- *
17671
- * @property {object[]} [hotkeys=[]] - _Updatable._
17672
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
17673
- * Within Platform, OpenFin also implements a set of pre-defined actions called
17674
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
17675
- * that can be assigned to a specific hotkey in the platform manifest.
17676
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
17677
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
17678
- *
17679
- * @property {string} [icon] - _Updatable. Inheritable._
17680
- * A URL for the icon to be shown in the window title bar and the taskbar.
17681
- * When omitted, inherits from the parent application._
17682
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
17683
- *
17684
- * @property {number} [maxHeight=-1] - _Updatable._
17685
- * The maximum height of a window. Will default to the OS defined value if set to -1.
17686
- *
17687
- * @property {boolean} [maximizable=true] - _Updatable._
17688
- * A flag that lets the window be maximized.
17689
- *
17690
- * @property {number} [maxWidth=-1] - _Updatable._
17691
- * The maximum width of a window. Will default to the OS defined value if set to -1.
17692
- *
17693
- * @property {number} [minHeight=0] - _Updatable._
17694
- * The minimum height of a window.
17695
- *
17696
- * @property {boolean} [minimizable=true] - _Updatable._
17697
- * A flag that lets the window be minimized.
17698
- *
17699
- * @property {number} [minWidth=0] - _Updatable._
17700
- * The minimum width of a window.
17701
- *
17702
- * @property {Identity} [modalParentIdentity]
17703
- * Parent identity of a modal window. It will create a modal child window when this option is set.
17704
- *
17705
- * @property {string} name
17706
- * The name of the window.
17707
- *
17708
- * @property {number} [opacity=1.0] - _Updatable._
17709
- * A flag that specifies how transparent the window will be.
17710
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
17711
- * This value is clamped between `0.0` and `1.0`.
17712
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
17713
- *
17714
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
17715
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
17716
- * from the parent application.
17717
- *
17718
- * @property {string} [processAffinity]
17719
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
17720
- *
17721
- * @property {boolean} [resizable=true] - _Updatable._
17722
- * A flag to allow the user to resize the window.
17723
- *
17724
- * @property {object} [resizeRegion] - _Updatable._
17725
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
17726
- * @property {number} [resizeRegion.bottomRightCorner=9]
17727
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
17728
- * @property {number} [resizeRegion.size=7]
17729
- * The size in pixels.
17730
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
17731
- * Sides that a window can be resized from.
17732
- *
17733
- * @property {boolean} [saveWindowState=true]
17734
- * A flag to cache the location of the window.
17735
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
17736
- *
17737
- * @property {boolean} [ignoreSavedWindowState]
17738
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
17739
- *
17740
- * @property {boolean} [shadow=false]
17741
- * A flag to display a shadow on frameless windows.
17742
- * `shadow` and `cornerRounding` are mutually exclusive.
17743
- * On Windows 7, Aero theme is required.
17744
- *
17745
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
17746
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
17747
- * This occurs when the window is resizing or a tab is being dragged within the layout.
17748
- *
17749
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
17750
- * A flag to show the window's icon in the taskbar.
17751
- *
17752
- * @property {boolean} [smallWindow=false]
17753
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
17754
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
17755
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
17756
- *
17757
- * @property {boolean} [spellCheck=false]
17758
- * Enable spell check in input text fields for the window.
17759
- *
17760
- * @property {string} [state="normal"]
17761
- * The visible state of the window on creation.
17762
- * One of:
17763
- * * `"maximized"`
17764
- * * `"minimized"`
17765
- * * `"normal"`
17766
- *
17767
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
17768
- *
17769
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
17770
- * Specify a taskbar group for the window.
17771
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
17772
- *
17773
- * @property {string} [url="about:blank"]
17774
- * The URL of the window.
17775
- *
17776
- * @property {string} [uuid=<application uuid>]
17777
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
17778
- * If omitted, defaults to the `uuid` of the application spawning the window.
17779
- * If given, must match the `uuid` of the application spawning the window.
17780
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
17781
- * really no need to provide it.
17782
- *
17783
- * @property {boolean} [waitForPageLoad=false]
17784
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
17785
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
17786
- *
17787
- * @property {ViewVisibility} [viewVisibility]
17788
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
17789
- */
17790
- /**
17791
- * @PORTED
17792
- * @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
17793
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
17794
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
17795
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
17796
- */
17797
- /**
17798
- * @PORTED
17799
- * @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
17800
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
17801
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
17802
- */
17803
- /**
17804
- * @REMOVED
17805
- * @typedef {Object} ShowViewsOnSplitterDrag@typedef {Object} ShowViewsOnSplitterDrag _Platform Windows Only_. Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
17806
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
17807
- */
17808
- /**
17809
- * @REMOVED
17810
- * @typedef {Object} ShowViewsOnTabDrag@typedef {Object} ShowViewsOnTabDrag _Platform Windows Only_. Allows views to be shown when the user is manipulating the layout by repositioning a tab.
17811
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
17812
- */
17813
- /**
17814
- * @PORTED
17815
- * @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
17816
- * @property { Area } [area] The area of the window to be captured.
17817
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
17818
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
17819
- */
17820
- /**
17821
- * @PORTED
17822
- * @typedef { object } Area@typedef { object } Area
17823
- * @property { number } height Area's height
17824
- * @property { number } width Area's width
17825
- * @property { number } x X coordinate of area's starting point
17826
- * @property { number } y Y coordinate of area's starting point
17827
- */
17828
- /**
17829
- * @PORTED
17830
- * @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
17831
- * @property {boolean} [forward=true] Whether to search forward or backward.
17832
- * @property {boolean} [findNext=false] Whether to begin a new text finding session. Should be true for first requests, and false for subsequent requests. Defaults to false.
17833
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
17834
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
17835
- * @property {boolean} [medialCapitalAsWordStart=false]
17836
- * When combined with wordStart, accepts a match in the middle of a word if the match begins with an uppercase letter followed by a<br>
17837
- * lowercase or non-letter. Accepts several other intra-word matches.
17838
- */
17839
- /**
17840
- * @REMOVED
17841
- * @typedef {object} Transition@typedef {object} Transition
17842
- * @property {Opacity} opacity - The Opacity transition
17843
- * @property {Position} position - The Position transition
17844
- * @property {Size} size - The Size transition
17845
- */
17846
- /**
17847
- * @PORTED
17848
- * @typedef {object} TransitionOptions@typedef {object} TransitionOptions
17849
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
17850
- this animation onto the end of the animation queue.
17851
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
17852
- */
17853
- /**
17854
- * @PORTED
17855
- * @typedef {object} Size@typedef {object} Size
17856
- * @property {number} duration - The total time in milliseconds this transition should take.
17857
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
17858
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
17859
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
17860
- */
17861
- /**
17862
- * @PORTED
17863
- * @typedef {object} Position@typedef {object} Position
17864
- * @property {number} duration - The total time in milliseconds this transition should take.
17865
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
17866
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
17867
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
17868
- */
17869
- /**
17870
- * @PORTED
17871
- * @typedef {object} Opacity@typedef {object} Opacity
17872
- * @property {number} duration - The total time in milliseconds this transition should take.
17873
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
17874
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
17875
- */
17876
- /**
17877
- * @REMOVED
17878
- * Bounds is a interface that has the properties of height,
17879
- * width, left, top which are all numbers
17880
- * @typedef { object } Bounds@typedef { object } Bounds
17881
- * @property { number } height Get the application height bound
17882
- * @property { number } width Get the application width bound
17883
- * @property { number } top Get the application top bound
17884
- * @property { number } left Get the application left bound
17885
- * @property { number } right Get the application right bound
17886
- * @property { number } bottom Get the application bottom bound
17887
- */
17888
17176
  /**
17889
17177
  * A basic window that wraps a native HTML window. Provides more fine-grained
17890
17178
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -18670,10 +17958,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18670
17958
  show(force?: boolean): Promise<void>;
18671
17959
  /**
18672
17960
  * Shows the window if it is hidden at the specified location.
18673
- * If the toggle parameter is set to true, the window will
18674
- * alternate between showing and hiding.
18675
- * @param left The left position of the window
18676
- * @param top The right position of the window
17961
+ *
17962
+ * @param left The left position of the window in pixels
17963
+ * @param top The top position of the window in pixels
18677
17964
  * @param force Show will be prevented from closing when force is false and
18678
17965
  * ‘show-requested’ has been subscribed to for application’s main window
18679
17966
  *
@@ -18735,28 +18022,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18735
18022
  * ```
18736
18023
  */
18737
18024
  authenticate(userName: string, password: string): Promise<void>;
18738
- /**
18739
- * @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
18740
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
18741
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
18742
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
18743
- */
18744
- /**
18745
- * @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
18746
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
18747
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
18748
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
18749
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
18750
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
18751
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
18752
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
18753
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
18754
- */
18755
- /**
18756
- * @typedef {object} MenuResult@typedef {object} MenuResult
18757
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
18758
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
18759
- */
18760
18025
  /**
18761
18026
  * Shows a menu on the window.
18762
18027
  *
@@ -18853,602 +18118,552 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18853
18118
  */
18854
18119
  closePopupMenu(): Promise<void>;
18855
18120
  /**
18856
- * @PORTED
18857
- * @typedef {object} PopupOptions@typedef {object} PopupOptions
18858
- * @property {string} [name] - If a window with this `name` exists, it will be shown as a popup. Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
18859
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
18860
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
18861
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
18862
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
18863
- * @property {function} [onPopupReady] - Executed when the popup window is shown. Provides the popup window to the provided function, and allows for easy access the popup window for additional behavior customization.
18864
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
18865
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
18866
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
18867
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
18868
- * @property {'modal' | 'hide' | 'close'} [blurBehavior] - Determines what happens if the popup window is blurred. 'modal' restricts resizing and positioning in the caller, 'hide' hides the popup window on blur and 'close' closes the popup window on blur.
18869
- * @property {'none' | 'hide' | 'close'} [resultDispatchBehavior] - Determines what happens when the popup window calls `dispatchPopupResult`. 'none' will do nothing, 'hide' hides the popup window on `dispatchPopupResult` and 'close' closes the popup window on `dispatchPopupResult`.
18870
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
18871
- * @property {boolean} [hideOnClose] - Hide the popup window instead of closing whenever `close` is called on it. Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
18872
- */
18873
- /**
18874
- * @PORTED
18875
- * @typedef {object} PopupResult@typedef {object} PopupResult
18876
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
18877
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
18878
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
18879
- */
18880
- /**
18881
- * Dispatch a result to the caller of `showPopupWindow`.
18882
- *
18883
- * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18884
- * @param data Serializable data to send to the caller window.
18885
- *
18886
- * @example
18887
- * ```js
18888
- * await fin.me.dispatchPopupResult({
18889
- * foo: 'bar'
18890
- * });
18891
- * ```
18892
- */
18893
- dispatchPopupResult(data: any): Promise<void>;
18894
- /**
18895
- * Prints the contents of the window.
18896
- *
18897
- * @param options Configuration for the print task.
18898
- * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18899
- * and the default settings for printing.
18900
- *
18901
- * Use the CSS style `page-break-before: always;` to force print to a new page.
18902
- *
18903
- * @example
18904
- * ```js
18905
- * const win = fin.Window.getCurrentSync();
18906
- *
18907
- * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18908
- * console.log('print call has been sent to the system');
18909
- * });
18910
- * ```
18911
- *
18912
- * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18913
- * use the `content` option:
18914
- *
18915
- * ```js
18916
- * const win = fin.Window.getCurrentSync();
18917
- *
18918
- * // Print embedded views
18919
- * win.print({ content: 'views' });
18920
- *
18921
- * // Print screenshot of current window
18922
- * win.print({ content: 'screenshot' })
18923
- * ```
18924
- *
18925
- * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18926
- * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18927
- * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18928
- * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18929
- *
18930
- * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18931
- * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18932
- *
18933
- * To print the views embedded in their page context, set `content` to `screenshot`.
18934
- */
18935
- print(options?: OpenFin.WindowPrintOptions): Promise<void>;
18936
- }
18937
-
18938
- /**
18939
- * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18940
- * @interface
18941
- */
18942
- declare type WindowAlertRequestedEvent = BaseApplicationEvent & {
18943
- type: 'window-alert-requested';
18944
- };
18945
-
18946
- /**
18947
- * Returned from getBounds call. bottom and right are never used for setting.
18948
- * @interface
18949
- */
18950
- declare type WindowBounds = Bounds & {
18951
- bottom: number;
18952
- right: number;
18953
- };
18954
-
18955
- /**
18956
- * Generated when a window has closed.
18957
- * @interface
18958
- */
18959
- declare type WindowClosedEvent = BaseWindowEvent & {
18960
- type: 'closed';
18961
- };
18962
-
18963
- /**
18964
- * Generated when a window has been prevented from closing.
18965
- * @remarks A window will be prevented from closing by default, either through the API or by a user when ‘close-requested’ has been subscribed to and the Window.close(force) flag is false.
18966
- * @interface
18967
- */
18968
- declare type WindowCloseRequestedEvent = BaseWindowEvent & {
18969
- type: 'close-requested';
18970
- };
18971
-
18972
- /**
18973
- * Generated when a window has initiated the closing routine.
18974
- * @interface
18975
- */
18976
- declare type WindowClosingEvent = BaseWindowEvent & {
18977
- type: 'closing';
18978
- };
18979
-
18980
- /**
18981
- * A rule prescribing content creation in a {@link OpenFin.Window}.
18982
- *
18983
- * @interface
18984
- */
18985
- declare type WindowContentCreationRule = BaseContentCreationRule & {
18986
- /**
18987
- * Behavior to use when opening matched content.
18988
- */
18989
- behavior: 'window';
18990
- /**
18991
- * Options for newly-created window.
18992
- */
18993
- options?: Partial<WindowOptions>;
18994
- };
18995
-
18996
- /**
18997
- * Generated when a child window is created.
18998
- * @interface
18999
- */
19000
- declare type WindowCreatedEvent = BaseApplicationEvent & {
19001
- type: 'window-created';
19002
- };
19003
-
19004
- /**
19005
- * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
19006
- *
19007
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
19008
- * (defaults to `"about:blank"` when omitted).
19009
- * @interface
19010
- */
19011
- declare type WindowCreationOptions = Partial<WindowOptions> & {
19012
- name: string;
19013
- };
19014
-
19015
- declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
19016
-
19017
- /**
19018
- * @interface
19019
- */
19020
- declare type WindowDetail = {
19021
- /**
19022
- * The bottom-most coordinate of the window.
19023
- */
19024
- bottom: number;
19025
- /**
19026
- * The height of the window.
19027
- */
19028
- height: number;
19029
- isShowing: boolean;
19030
- /**
19031
- * The left-most coordinate of the window.
19032
- */
19033
- left: number;
19034
- /**
19035
- * The name of the window.
19036
- */
19037
- name: string;
19038
- /**
19039
- * The right-most coordinate of the window.
19040
- */
19041
- right: number;
19042
- state: string;
19043
- /**
19044
- * The top-most coordinate of the window.
19045
- */
19046
- top: number;
19047
- /**
19048
- * The width of the window.
19049
- */
19050
- width: number;
19051
- };
19052
-
19053
- /**
19054
- * Generated when a child window ends loading.
19055
- * @interface
19056
- */
19057
- declare type WindowEndLoadEvent = BaseApplicationEvent & {
19058
- type: 'window-end-load';
19059
- };
19060
-
19061
- /**
19062
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
19063
- * discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
19064
- * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
19065
- */
19066
- declare type WindowEvent = WindowSourcedEvent | PropagatedViewEvent<'window'>;
19067
-
19068
- declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19069
-
19070
- declare namespace WindowEvents {
19071
- export {
19072
- BaseWindowEvent,
19073
- ViewAttachedEvent,
19074
- ViewDetachedEvent,
19075
- WindowViewEvent,
19076
- AlertRequestedEvent,
19077
- AuthRequestedEvent,
19078
- EndLoadEvent,
19079
- WillRedirectEvent,
19080
- ReloadedEvent,
19081
- WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19082
- ExternalProcessExitedEvent,
19083
- ExternalProcessStartedEvent,
19084
- WindowHiddenEvent,
19085
- PreloadScriptInfoRunning,
19086
- PreloadScriptInfo,
19087
- PreloadScriptsStateChangeEvent,
19088
- UserBoundsChangeEvent,
19089
- BoundsChangeEvent,
19090
- WillMoveOrResizeEvent,
19091
- PerformanceReportEvent,
19092
- InputEvent_2 as InputEvent,
19093
- LayoutInitializedEvent,
19094
- LayoutReadyEvent,
19095
- BeginUserBoundsChangingEvent,
19096
- BoundsChangedEvent,
19097
- BoundsChangingEvent,
19098
- WindowCloseRequestedEvent,
19099
- ContextChangedEvent,
19100
- WindowClosedEvent,
19101
- WindowClosingEvent,
19102
- DisabledMovementBoundsChangedEvent,
19103
- DisabledMovementBoundsChangingEvent,
19104
- EmbeddedEvent,
19105
- EndUserBoundsChangingEvent,
19106
- WindowHotkeyEvent,
19107
- WindowInitializedEvent,
19108
- MaximizedEvent,
19109
- MinimizedEvent,
19110
- PreloadScriptsStateChangedEvent,
19111
- PreloadScriptsStateChangingEvent,
19112
- WindowRestoredEvent,
19113
- WindowShowRequestedEvent,
19114
- WindowShownEvent,
19115
- UserMovementEnabledEvent,
19116
- UserMovementDisabledEvent,
19117
- WillMoveEvent,
19118
- WillResizeEvent,
19119
- NonPropagatedWindowEvent,
19120
- ShowAllDownloadsEvent,
19121
- DownloadShelfVisibilityChangedEvent,
19122
- WindowSourcedEvent,
19123
- WillPropagateWindowEvent,
19124
- WindowEvent,
19125
- WindowEventType,
19126
- PropagatedWindowEvent,
19127
- PropagatedWindowEventType,
19128
- Payload_9 as Payload,
19129
- ByType_8 as ByType
19130
- }
19131
- }
19132
-
19133
- /**
19134
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.WindowEvent}.
19135
- */
19136
- declare type WindowEventType = WindowEvent['type'];
19137
-
19138
- /**
19139
- * Generated when a window has been hidden.
19140
- * @interface
19141
- */
19142
- declare type WindowHiddenEvent = BaseWindowEvent & {
19143
- type: 'hidden';
19144
- reason: 'closing' | 'hide' | 'hide-on-close';
19145
- };
19146
-
19147
- /**
19148
- * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
19149
- * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
19150
- * @interface
19151
- */
19152
- declare type WindowHotkeyEvent = InputEvent_2 & BaseWindowEvent & {
19153
- type: 'hotkey';
19154
- };
19155
-
19156
- /**
19157
- * @interface
19158
- */
19159
- declare type WindowInfo = {
19160
- canNavigateBack: boolean;
19161
- canNavigateForward: boolean;
19162
- preloadScripts: Array<any>;
19163
- title: string;
19164
- url: string;
19165
- };
19166
-
19167
- /**
19168
- * Generated when a window is initialized.
19169
- * @interface
19170
- */
19171
- declare type WindowInitializedEvent = BaseWindowEvent & {
19172
- type: 'initialized';
19173
- };
19174
-
19175
- /**
19176
- * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
19177
- */
19178
- declare class _WindowModule extends Base {
19179
- /**
19180
- * Asynchronously returns a Window object that represents an existing window.
19181
- *
19182
- * @example
19183
- * ```js
19184
- * async function createWin() {
19185
- * const app = await fin.Application.start({
19186
- * name: 'myApp',
19187
- * uuid: 'app-1',
19188
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
19189
- * autoShow: true
19190
- * });
19191
- * return await app.getWindow();
19192
- * }
19193
- * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
19194
- * .then(win => console.log('wrapped window'))
19195
- * .catch(err => console.log(err));
19196
- * ```
19197
- */
19198
- wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
19199
- /**
19200
- * Synchronously returns a Window object that represents an existing window.
19201
- *
19202
- * @example
19203
- * ```js
19204
- * async function createWin() {
19205
- * const app = await fin.Application.start({
19206
- * name: 'myApp',
19207
- * uuid: 'app-1',
19208
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
19209
- * autoShow: true
19210
- * });
19211
- * return await app.getWindow();
19212
- * }
19213
- * await createWin();
19214
- * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
19215
- * ```
19216
- */
19217
- wrapSync(identity: OpenFin.Identity): OpenFin.Window;
19218
- /**
19219
- * Creates a new Window.
19220
- * @param options - Window creation options
19221
- *
19222
- * @example
19223
- * ```js
19224
- * async function createWindow() {
19225
- * const winOption = {
19226
- * name:'child',
19227
- * defaultWidth: 300,
19228
- * defaultHeight: 300,
19229
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
19230
- * frame: true,
19231
- * autoShow: true
19232
- * };
19233
- * return await fin.Window.create(winOption);
19234
- * }
19235
- *
19236
- * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
19237
- * ```
19238
- */
19239
- create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
19240
- /**
19241
- * Asynchronously returns a Window object that represents the current window
19242
- *
19243
- * @example
19244
- * ```js
19245
- * fin.Window.getCurrent()
19246
- * .then(wnd => console.log('current window'))
19247
- * .catch(err => console.log(err));
19248
- *
19249
- * ```
19250
- */
19251
- getCurrent(): Promise<OpenFin.Window>;
19252
- /**
19253
- * Synchronously returns a Window object that represents the current window
19254
- *
19255
- * @example
19256
- * ```js
19257
- * const wnd = fin.Window.getCurrentSync();
19258
- * const info = await wnd.getInfo();
19259
- * console.log(info);
19260
- *
19261
- * ```
19262
- */
19263
- getCurrentSync(): OpenFin.Window;
19264
- }
19265
-
19266
- /**
19267
- * Generated when a child window is not responding.
19268
- * @interface
19269
- */
19270
- declare type WindowNotRespondingEvent = BaseApplicationEvent & {
19271
- type: 'window-not-responding';
19272
- };
19273
-
19274
- /**
19275
- * @interface
19276
- */
19277
- declare type WindowOptionDiff = {
19278
- [key in keyof WindowOptions]: {
19279
- oldVal: WindowOptions[key];
19280
- newVal: WindowOptions[key];
19281
- };
19282
- };
19283
-
19284
- /**
19285
- * @interface
19286
- */
19287
- declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
19288
-
19289
- declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
19290
-
19291
- /**
19292
- * Generated after window options are changed using the window.updateOptions method.
19293
- * @remarks Will not fire if the diff object is empty.
19294
- * @interface
19295
- */
19296
- declare type WindowOptionsChangedEvent_2 = BaseWindowEvent & {
19297
- type: 'options-changed';
19298
- options: OpenFin.WindowOptions;
19299
- diff: OpenFin.WindowOptionDiff;
19300
- };
19301
-
19302
- declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
19303
-
19304
- /**
19305
- * Generated when a child window is responding.
19306
- * @interface
19307
- */
19308
- declare type WindowRespondingEvent = BaseApplicationEvent & {
19309
- type: 'window-responding';
19310
- };
19311
-
19312
- /**
19313
- * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
19314
- * @interface
19315
- */
19316
- declare type WindowRestoredEvent = BaseWindowEvent & {
19317
- type: 'restored';
19318
- };
19319
-
19320
- /**
19321
- * Generated when a hidden window has been shown.
19322
- * @interface
19323
- */
19324
- declare type WindowShownEvent = BaseWindowEvent & {
19325
- type: 'shown';
19326
- };
19327
-
19328
- /**
19329
- * Generated when a window has been prevented from showing.
19330
- * @remarks A window will be prevented from showing by default, either through the API or by a user when ‘show-requested’ has been subscribed to on the window or 'window-show-requested' on the parent application and the Window.show(force) flag is false.
19331
- * @interface
19332
- */
19333
- declare type WindowShowRequestedEvent = BaseWindowEvent & {
19334
- type: 'show-requested';
19335
- };
19336
-
19337
- /**
19338
- * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19339
- * from {@link OpenFin.ViewEvents}.
19340
- */
19341
- declare type WindowSourcedEvent = WebContentsEvent<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | WindowCloseRequestedEvent | WindowClosedEvent | WindowClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | WindowHiddenEvent | WindowHotkeyEvent | WindowInitializedEvent | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | WindowOptionsChangedEvent_2 | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | WindowRestoredEvent | WindowShowRequestedEvent | WindowShownEvent | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
19342
-
19343
- /**
19344
- * Generated when a child window starts loading.
19345
- * @interface
19346
- */
19347
- declare type WindowStartLoadEvent = BaseApplicationEvent & {
19348
- type: 'window-start-load';
19349
- };
19350
-
19351
- /**
19352
- * Visibility state of a window.
19353
- */
19354
- declare type WindowState = 'maximized' | 'minimized' | 'normal';
19355
-
19356
- /**
19357
- * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
19358
- * to the `Application` level, with the name pattern `window-view-eventname`.
19359
- */
19360
- declare type WindowViewEvent = {
19361
- viewIdentity: OpenFin.Identity;
19362
- } & (ViewAttachedEvent | ViewDetachedEvent);
19363
-
19364
- /**
19365
- * @interface
19366
- */
19367
- declare type WindowViewsPrintOptions = {
19368
- content: 'views';
19369
- includeSelf?: boolean;
19370
- };
19371
-
19372
- declare type Wire = EventEmitter & {
19373
- connect(messageReciever: MessageReceiver): Promise<any>;
19374
- connectSync(): any;
19375
- send(data: any): Promise<any>;
19376
- shutdown(): Promise<void>;
19377
- getPort(): string;
19378
- };
19379
-
19380
- declare type WireConstructor = {
19381
- new (onmessage: (data: any) => void): Wire;
19382
- };
19383
-
19384
- /* Excluded from this release type: WithId */
19385
-
19386
- declare interface WithInterop {
19387
- interop: InteropClient;
19388
- }
19389
-
19390
- /* Excluded from this release type: WithoutId */
19391
-
19392
- declare type WithPositioningOptions<T extends {} = {}> = T & {
19393
- positioningOptions?: OpenFin.PositioningOptions;
19394
- };
19395
-
19396
- /* Excluded from this release type: WorkspacePlatformOptions */
19397
-
19398
- /**
19399
- * A generic request to write any supported data to the clipboard.
19400
- * @interface
19401
- */
19402
- declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
19403
- /**
19404
- * Data to be written
19405
- */
19406
- data: {
19407
- text?: string;
19408
- html?: string;
19409
- rtf?: string;
19410
- } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
19411
- };
19412
-
19413
- /**
19414
- * @deprecated - instead use WriteAnyClipboardRequest
19415
- *
19416
- * A generic request to write any supported data to the clipboard.
19417
- *
19418
- * @interface
19419
- */
19420
- declare type WriteAnyRequestType = WriteAnyClipboardRequest;
19421
-
19422
- /**
19423
- * A request to write data to the clipboard.
19424
- * @interface
19425
- */
19426
- declare type WriteClipboardRequest = BaseClipboardRequest & {
19427
- /**
19428
- * Data to write to the clipboard.
19429
- */
19430
- data: string;
19431
- };
19432
-
19433
- /**
19434
- * @interface
19435
- */
19436
- declare type WriteImageClipboardRequest = BaseClipboardRequest & {
19437
- /**
19438
- * Can be either a base64 string, or a DataURL string. If using DataURL, the
19439
- * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
19440
- * Using other image/<format> DataURLs will throw an Error.
19441
- */
19442
- image: string;
19443
- };
19444
-
19445
- /**
19446
- * @deprecated - instead use OpenFin.WriteClipboardRequest
19447
- *
19448
- * A request to write data to the clipboard.
19449
- *
19450
- * @interface
19451
- */
19452
- declare type WriteRequestType = WriteClipboardRequest;
19453
-
19454
- export { }
18121
+ * Dispatch a result to the caller of `showPopupWindow`.
18122
+ *
18123
+ * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18124
+ * @param data Serializable data to send to the caller window.
18125
+ *
18126
+ * @example
18127
+ * ```js
18128
+ * await fin.me.dispatchPopupResult({
18129
+ * foo: 'bar'
18130
+ * });
18131
+ * ```
18132
+ */
18133
+ dispatchPopupResult(data: any): Promise<void>;
18134
+ /**
18135
+ * Prints the contents of the window.
18136
+ *
18137
+ * @param options Configuration for the print task.
18138
+ * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18139
+ * and the default settings for printing.
18140
+ *
18141
+ * Use the CSS style `page-break-before: always;` to force print to a new page.
18142
+ *
18143
+ * @example
18144
+ * ```js
18145
+ * const win = fin.Window.getCurrentSync();
18146
+ *
18147
+ * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18148
+ * console.log('print call has been sent to the system');
18149
+ * });
18150
+ * ```
18151
+ *
18152
+ * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18153
+ * use the `content` option:
18154
+ *
18155
+ * ```js
18156
+ * const win = fin.Window.getCurrentSync();
18157
+ *
18158
+ * // Print embedded views
18159
+ * win.print({ content: 'views' });
18160
+ *
18161
+ * // Print screenshot of current window
18162
+ * win.print({ content: 'screenshot' })
18163
+ * ```
18164
+ *
18165
+ * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18166
+ * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18167
+ * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18168
+ * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18169
+ *
18170
+ * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18171
+ * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18172
+ *
18173
+ * To print the views embedded in their page context, set `content` to `screenshot`.
18174
+ */
18175
+ print(options?: OpenFin.WindowPrintOptions): Promise<void>;
18176
+ }
18177
+
18178
+ /**
18179
+ * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18180
+ * @interface
18181
+ */
18182
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
18183
+ type: 'window-alert-requested';
18184
+ };
18185
+
18186
+ /**
18187
+ * Returned from getBounds call. bottom and right are never used for setting.
18188
+ * @interface
18189
+ */
18190
+ declare type WindowBounds = Bounds & {
18191
+ bottom: number;
18192
+ right: number;
18193
+ };
18194
+
18195
+ /**
18196
+ * @deprecated Renamed to {@link ClosedEvent}.
18197
+ */
18198
+ declare type WindowClosedEvent = ClosedEvent_2;
18199
+
18200
+ /**
18201
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
18202
+ */
18203
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
18204
+
18205
+ /**
18206
+ * @deprecated Renamed to {@link ClosingEvent}.
18207
+ */
18208
+ declare type WindowClosingEvent = ClosingEvent;
18209
+
18210
+ /**
18211
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
18212
+ *
18213
+ * @interface
18214
+ */
18215
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
18216
+ /**
18217
+ * Behavior to use when opening matched content.
18218
+ */
18219
+ behavior: 'window';
18220
+ /**
18221
+ * Options for newly-created window.
18222
+ */
18223
+ options?: Partial<WindowOptions>;
18224
+ };
18225
+
18226
+ /**
18227
+ * Generated when a child window is created.
18228
+ * @interface
18229
+ */
18230
+ declare type WindowCreatedEvent = BaseEvent_3 & {
18231
+ type: 'window-created';
18232
+ };
18233
+
18234
+ /**
18235
+ * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
18236
+ *
18237
+ * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18238
+ * (defaults to `"about:blank"` when omitted).
18239
+ * @interface
18240
+ */
18241
+ declare type WindowCreationOptions = Partial<WindowOptions> & {
18242
+ name: string;
18243
+ };
18244
+
18245
+ declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
18246
+
18247
+ /**
18248
+ * @interface
18249
+ */
18250
+ declare type WindowDetail = {
18251
+ /**
18252
+ * The bottom-most coordinate of the window.
18253
+ */
18254
+ bottom: number;
18255
+ /**
18256
+ * The height of the window.
18257
+ */
18258
+ height: number;
18259
+ isShowing: boolean;
18260
+ /**
18261
+ * The left-most coordinate of the window.
18262
+ */
18263
+ left: number;
18264
+ /**
18265
+ * The name of the window.
18266
+ */
18267
+ name: string;
18268
+ /**
18269
+ * The right-most coordinate of the window.
18270
+ */
18271
+ right: number;
18272
+ state: string;
18273
+ /**
18274
+ * The top-most coordinate of the window.
18275
+ */
18276
+ top: number;
18277
+ /**
18278
+ * The width of the window.
18279
+ */
18280
+ width: number;
18281
+ };
18282
+
18283
+ /**
18284
+ * Generated when a child window ends loading.
18285
+ * @interface
18286
+ */
18287
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
18288
+ type: 'window-end-load';
18289
+ };
18290
+
18291
+ /**
18292
+ * @deprecated, Renamed to {@link Event}.
18293
+ */
18294
+ declare type WindowEvent = Event_6;
18295
+
18296
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18297
+
18298
+ declare namespace WindowEvents {
18299
+ export {
18300
+ BaseEvent_5 as BaseEvent,
18301
+ BaseWindowEvent,
18302
+ ViewAttachedEvent,
18303
+ ViewDetachedEvent,
18304
+ WindowViewEvent,
18305
+ AlertRequestedEvent,
18306
+ AuthRequestedEvent,
18307
+ EndLoadEvent,
18308
+ WillRedirectEvent,
18309
+ ReloadedEvent,
18310
+ OptionsChangedEvent,
18311
+ WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
18312
+ ExternalProcessExitedEvent,
18313
+ ExternalProcessStartedEvent,
18314
+ HiddenEvent_2 as HiddenEvent,
18315
+ WindowHiddenEvent,
18316
+ PreloadScriptInfoRunning,
18317
+ PreloadScriptInfo,
18318
+ PreloadScriptsStateChangeEvent,
18319
+ UserBoundsChangeEvent,
18320
+ BoundsChangeEvent,
18321
+ WillMoveOrResizeEvent,
18322
+ PerformanceReportEvent,
18323
+ InputEvent_2 as InputEvent,
18324
+ LayoutInitializedEvent,
18325
+ LayoutReadyEvent,
18326
+ BeginUserBoundsChangingEvent,
18327
+ BoundsChangedEvent,
18328
+ BoundsChangingEvent,
18329
+ CloseRequestedEvent,
18330
+ WindowCloseRequestedEvent,
18331
+ ContextChangedEvent,
18332
+ ClosedEvent_2 as ClosedEvent,
18333
+ WindowClosedEvent,
18334
+ ClosingEvent,
18335
+ WindowClosingEvent,
18336
+ DisabledMovementBoundsChangedEvent,
18337
+ DisabledMovementBoundsChangingEvent,
18338
+ EmbeddedEvent,
18339
+ EndUserBoundsChangingEvent,
18340
+ HotkeyEvent_2 as HotkeyEvent,
18341
+ WindowHotkeyEvent,
18342
+ InitializedEvent_2 as InitializedEvent,
18343
+ WindowInitializedEvent,
18344
+ MaximizedEvent,
18345
+ MinimizedEvent,
18346
+ PreloadScriptsStateChangedEvent,
18347
+ PreloadScriptsStateChangingEvent,
18348
+ RestoredEvent,
18349
+ WindowRestoredEvent,
18350
+ ShowRequestedEvent,
18351
+ WindowShowRequestedEvent,
18352
+ ShownEvent_2 as ShownEvent,
18353
+ WindowShownEvent,
18354
+ UserMovementEnabledEvent,
18355
+ UserMovementDisabledEvent,
18356
+ WillMoveEvent,
18357
+ WillResizeEvent,
18358
+ NonPropagatedWindowEvent,
18359
+ ShowAllDownloadsEvent,
18360
+ DownloadShelfVisibilityChangedEvent,
18361
+ WindowSourcedEvent,
18362
+ WillPropagateWindowEvent,
18363
+ Event_6 as Event,
18364
+ WindowEvent,
18365
+ EventType_2 as EventType,
18366
+ WindowEventType,
18367
+ PropagatedEvent_3 as PropagatedEvent,
18368
+ PropagatedWindowEvent,
18369
+ PropagatedWindowEventType,
18370
+ Payload_3 as Payload,
18371
+ ByType_2 as ByType
18372
+ }
18373
+ }
18374
+
18375
+ /**
18376
+ * @deprecated Renamed to {@link EventType}.
18377
+ */
18378
+ declare type WindowEventType = WindowEvent['type'];
18379
+
18380
+ /**
18381
+ * @deprecated Renamed to {@link HiddenEvent}.
18382
+ */
18383
+ declare type WindowHiddenEvent = HiddenEvent_2;
18384
+
18385
+ /**
18386
+ * @deprecated Renamed to {@link HotkeyEvent}.
18387
+ */
18388
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
18389
+
18390
+ /**
18391
+ * @interface
18392
+ */
18393
+ declare type WindowInfo = {
18394
+ canNavigateBack: boolean;
18395
+ canNavigateForward: boolean;
18396
+ preloadScripts: Array<any>;
18397
+ title: string;
18398
+ url: string;
18399
+ };
18400
+
18401
+ /**
18402
+ * @deprecated Renamed to {@link InitializedEvent}.
18403
+ */
18404
+ declare type WindowInitializedEvent = InitializedEvent_2;
18405
+
18406
+ /**
18407
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
18408
+ */
18409
+ declare class _WindowModule extends Base {
18410
+ /**
18411
+ * Asynchronously returns a Window object that represents an existing window.
18412
+ *
18413
+ * @example
18414
+ * ```js
18415
+ * async function createWin() {
18416
+ * const app = await fin.Application.start({
18417
+ * name: 'myApp',
18418
+ * uuid: 'app-1',
18419
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
18420
+ * autoShow: true
18421
+ * });
18422
+ * return await app.getWindow();
18423
+ * }
18424
+ * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
18425
+ * .then(win => console.log('wrapped window'))
18426
+ * .catch(err => console.log(err));
18427
+ * ```
18428
+ */
18429
+ wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18430
+ /**
18431
+ * Synchronously returns a Window object that represents an existing window.
18432
+ *
18433
+ * @example
18434
+ * ```js
18435
+ * async function createWin() {
18436
+ * const app = await fin.Application.start({
18437
+ * name: 'myApp',
18438
+ * uuid: 'app-1',
18439
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
18440
+ * autoShow: true
18441
+ * });
18442
+ * return await app.getWindow();
18443
+ * }
18444
+ * await createWin();
18445
+ * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
18446
+ * ```
18447
+ */
18448
+ wrapSync(identity: OpenFin.Identity): OpenFin.Window;
18449
+ /**
18450
+ * Creates a new Window.
18451
+ * @param options - Window creation options
18452
+ *
18453
+ * @example
18454
+ * ```js
18455
+ * async function createWindow() {
18456
+ * const winOption = {
18457
+ * name:'child',
18458
+ * defaultWidth: 300,
18459
+ * defaultHeight: 300,
18460
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
18461
+ * frame: true,
18462
+ * autoShow: true
18463
+ * };
18464
+ * return await fin.Window.create(winOption);
18465
+ * }
18466
+ *
18467
+ * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
18468
+ * ```
18469
+ */
18470
+ create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
18471
+ /**
18472
+ * Asynchronously returns a Window object that represents the current window
18473
+ *
18474
+ * @example
18475
+ * ```js
18476
+ * fin.Window.getCurrent()
18477
+ * .then(wnd => console.log('current window'))
18478
+ * .catch(err => console.log(err));
18479
+ *
18480
+ * ```
18481
+ */
18482
+ getCurrent(): Promise<OpenFin.Window>;
18483
+ /**
18484
+ * Synchronously returns a Window object that represents the current window
18485
+ *
18486
+ * @example
18487
+ * ```js
18488
+ * const wnd = fin.Window.getCurrentSync();
18489
+ * const info = await wnd.getInfo();
18490
+ * console.log(info);
18491
+ *
18492
+ * ```
18493
+ */
18494
+ getCurrentSync(): OpenFin.Window;
18495
+ }
18496
+
18497
+ /**
18498
+ * Generated when a child window is not responding.
18499
+ * @interface
18500
+ */
18501
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
18502
+ type: 'window-not-responding';
18503
+ };
18504
+
18505
+ /**
18506
+ * @interface
18507
+ */
18508
+ declare type WindowOptionDiff = {
18509
+ [key in keyof WindowOptions]: {
18510
+ oldVal: WindowOptions[key];
18511
+ newVal: WindowOptions[key];
18512
+ };
18513
+ };
18514
+
18515
+ /**
18516
+ * @interface
18517
+ */
18518
+ declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
18519
+
18520
+ declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
18521
+
18522
+ /**
18523
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
18524
+ */
18525
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
18526
+
18527
+ declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
18528
+
18529
+ /**
18530
+ * Generated when a child window is responding.
18531
+ * @interface
18532
+ */
18533
+ declare type WindowRespondingEvent = BaseEvent_3 & {
18534
+ type: 'window-responding';
18535
+ };
18536
+
18537
+ /**
18538
+ * @deprecated Renamed to {@link RestoredEvent}.
18539
+ */
18540
+ declare type WindowRestoredEvent = RestoredEvent;
18541
+
18542
+ /**
18543
+ * @deprecated Renamed to {@link ShownEvent}.
18544
+ */
18545
+ declare type WindowShownEvent = ShownEvent_2;
18546
+
18547
+ /**
18548
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
18549
+ */
18550
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18551
+
18552
+ /**
18553
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18554
+ * from {@link OpenFin.ViewEvents}.
18555
+ */
18556
+ 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;
18557
+
18558
+ /**
18559
+ * Generated when a child window starts loading.
18560
+ * @interface
18561
+ */
18562
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
18563
+ type: 'window-start-load';
18564
+ };
18565
+
18566
+ /**
18567
+ * Visibility state of a window.
18568
+ */
18569
+ declare type WindowState = 'maximized' | 'minimized' | 'normal';
18570
+
18571
+ /**
18572
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
18573
+ * to the `Application` level, with the name pattern `window-view-eventname`.
18574
+ */
18575
+ declare type WindowViewEvent = {
18576
+ viewIdentity: OpenFin.Identity;
18577
+ } & (ViewAttachedEvent | ViewDetachedEvent);
18578
+
18579
+ /**
18580
+ * @interface
18581
+ */
18582
+ declare type WindowViewsPrintOptions = {
18583
+ content: 'views';
18584
+ includeSelf?: boolean;
18585
+ };
18586
+
18587
+ declare type Wire = EventEmitter & {
18588
+ connect(messageReciever: MessageReceiver): Promise<any>;
18589
+ connectSync(): any;
18590
+ send(data: any): Promise<any>;
18591
+ shutdown(): Promise<void>;
18592
+ getPort(): string;
18593
+ };
18594
+
18595
+ declare type WireConstructor = {
18596
+ new (onmessage: (data: any) => void): Wire;
18597
+ };
18598
+
18599
+ /* Excluded from this release type: WithId */
18600
+
18601
+ declare interface WithInterop {
18602
+ interop: InteropClient;
18603
+ }
18604
+
18605
+ /* Excluded from this release type: WithoutId */
18606
+
18607
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
18608
+ positioningOptions?: OpenFin.PositioningOptions;
18609
+ };
18610
+
18611
+ /* Excluded from this release type: WorkspacePlatformOptions */
18612
+
18613
+ /**
18614
+ * A generic request to write any supported data to the clipboard.
18615
+ * @interface
18616
+ */
18617
+ declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
18618
+ /**
18619
+ * Data to be written
18620
+ */
18621
+ data: {
18622
+ text?: string;
18623
+ html?: string;
18624
+ rtf?: string;
18625
+ } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
18626
+ };
18627
+
18628
+ /**
18629
+ * @deprecated - instead use WriteAnyClipboardRequest
18630
+ *
18631
+ * A generic request to write any supported data to the clipboard.
18632
+ *
18633
+ * @interface
18634
+ */
18635
+ declare type WriteAnyRequestType = WriteAnyClipboardRequest;
18636
+
18637
+ /**
18638
+ * A request to write data to the clipboard.
18639
+ * @interface
18640
+ */
18641
+ declare type WriteClipboardRequest = BaseClipboardRequest & {
18642
+ /**
18643
+ * Data to write to the clipboard.
18644
+ */
18645
+ data: string;
18646
+ };
18647
+
18648
+ /**
18649
+ * @interface
18650
+ */
18651
+ declare type WriteImageClipboardRequest = BaseClipboardRequest & {
18652
+ /**
18653
+ * Can be either a base64 string, or a DataURL string. If using DataURL, the
18654
+ * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
18655
+ * Using other image/<format> DataURLs will throw an Error.
18656
+ */
18657
+ image: string;
18658
+ };
18659
+
18660
+ /**
18661
+ * @deprecated - instead use OpenFin.WriteClipboardRequest
18662
+ *
18663
+ * A request to write data to the clipboard.
18664
+ *
18665
+ * @interface
18666
+ */
18667
+ declare type WriteRequestType = WriteClipboardRequest;
18668
+
18669
+ export { }