@openfin/node-adapter 35.78.1 → 35.78.4

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 true `fin` won't be available in this context.
101
+ */
102
+ preventInjection?: boolean;
97
103
  };
98
104
 
99
105
  declare type ApiCall<Request, Response> = {
@@ -105,6 +111,15 @@ 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
+ * Generated when a new Platform's API becomes responsive.
116
+ * @interface
117
+ */
118
+ declare type ApiReadyEvent = BaseEvent & {
119
+ topic: 'application';
120
+ type: 'platform-api-ready';
121
+ };
122
+
108
123
  /**
109
124
  * @interface
110
125
  */
@@ -178,100 +193,6 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
178
193
  private window;
179
194
  /* Excluded from this release type: __constructor */
180
195
  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
196
  /**
276
197
  * Determines if the application is currently running.
277
198
  *
@@ -856,19 +777,15 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
856
777
  }
857
778
 
858
779
  /**
859
- * Generated when an application has authenticated and is connected.
860
- * @interface
780
+ * @deprecated Renamed to {@link ConnectedEvent}.
861
781
  */
862
- declare type ApplicationConnectedEvent = IdentityEvent & {
863
- topic: 'application';
864
- type: 'connected';
865
- };
782
+ declare type ApplicationConnectedEvent = ConnectedEvent_2;
866
783
 
867
784
  /**
868
785
  * Generated when an application is created.
869
786
  * @interface
870
787
  */
871
- declare type ApplicationCreatedEvent = BaseSystemEvent & IdentityEvent & {
788
+ declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
872
789
  type: 'application-created';
873
790
  };
874
791
 
@@ -892,17 +809,15 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
892
809
  };
893
810
 
894
811
  /**
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).
812
+ * @deprecated Renamed to {@link Event}.
899
813
  */
900
- declare type ApplicationEvent = PropagatedViewEvent<'application'> | PropagatedWindowEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
814
+ declare type ApplicationEvent = Event_3;
901
815
 
902
816
  declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
903
817
 
904
818
  declare namespace ApplicationEvents {
905
819
  export {
820
+ BaseEvent_3 as BaseEvent,
906
821
  BaseApplicationEvent,
907
822
  CrashedEvent,
908
823
  FileDownloadLocationChangedEvent,
@@ -916,6 +831,7 @@ declare namespace ApplicationEvents {
916
831
  WindowStartLoadEvent,
917
832
  ApplicationWindowEvent,
918
833
  ClosedEvent,
834
+ ConnectedEvent_2 as ConnectedEvent,
919
835
  ApplicationConnectedEvent,
920
836
  InitializedEvent,
921
837
  ManifestChangedEvent,
@@ -923,19 +839,24 @@ declare namespace ApplicationEvents {
923
839
  RespondingEvent,
924
840
  StartedEvent,
925
841
  ApplicationSourcedEvent,
842
+ ApplicationSourcedEventType,
843
+ Event_3 as Event,
926
844
  ApplicationEvent,
845
+ EventType_3 as EventType,
927
846
  ApplicationEventType,
847
+ PropagatedEvent_4 as PropagatedEvent,
928
848
  PropagatedApplicationEvent,
849
+ PropagatedEventType_3 as PropagatedEventType,
929
850
  PropagatedApplicationEventType,
930
- Payload_2 as Payload,
931
- ByType
851
+ Payload_4 as Payload,
852
+ ByType_3 as ByType
932
853
  }
933
854
  }
934
855
 
935
856
  /**
936
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
857
+ * @deprecated Renamed to {@link EventType}.
937
858
  */
938
- declare type ApplicationEventType = ApplicationEvent['type'];
859
+ declare type ApplicationEventType = EventType_3;
939
860
 
940
861
  declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
941
862
 
@@ -1288,9 +1209,13 @@ declare type ApplicationPermissions = {
1288
1209
  * A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
1289
1210
  * from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
1290
1211
  * does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
1291
- *
1292
1212
  */
1293
- declare type ApplicationSourcedEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1213
+ declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1214
+
1215
+ /**
1216
+ * Union of possible type values for an {@link ApplicationSourcedEvent}.
1217
+ */
1218
+ declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
1294
1219
 
1295
1220
  declare type ApplicationState = OpenFin.ApplicationState;
1296
1221
 
@@ -1598,7 +1523,7 @@ declare interface AuthorizationPayload {
1598
1523
  * ```
1599
1524
  * @interface
1600
1525
  */
1601
- declare type AuthRequestedEvent = BaseWindowEvent & {
1526
+ declare type AuthRequestedEvent = BaseEvent_5 & {
1602
1527
  type: 'auth-requested';
1603
1528
  authInfo: {
1604
1529
  host: string;
@@ -1660,21 +1585,9 @@ declare class Base {
1660
1585
  }
1661
1586
 
1662
1587
  /**
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
1588
+ * @deprecated Renamed to {@link BaseEvent}.
1673
1589
  */
1674
- declare type BaseChannelEvent = NamedEvent & {
1675
- channelName: string;
1676
- channelId: string;
1677
- };
1590
+ declare type BaseApplicationEvent = BaseEvent_3;
1678
1591
 
1679
1592
  /**
1680
1593
  * @interface
@@ -1743,10 +1656,70 @@ declare type BaseEvent = {
1743
1656
  type: string;
1744
1657
  };
1745
1658
 
1746
- declare type BaseEvent_2 = Events.BaseEvents.BaseEvent;
1659
+ /**
1660
+ * A base Channel event.
1661
+ * @interface
1662
+ */
1663
+ declare type BaseEvent_2 = NamedEvent & {
1664
+ channelName: string;
1665
+ channelId: string;
1666
+ };
1667
+
1668
+ /**
1669
+ * Base type for events emitting on the `application` topic
1670
+ * @interface
1671
+ */
1672
+ declare type BaseEvent_3 = BaseEvents.NamedEvent & {
1673
+ topic: `application`;
1674
+ };
1675
+
1676
+ /**
1677
+ * Base type for events emitting on the `view` topic
1678
+ * @interface
1679
+ */
1680
+ declare type BaseEvent_4 = BaseEvents.NamedEvent & {
1681
+ topic: 'view';
1682
+ target: OpenFin.Identity;
1683
+ };
1684
+
1685
+ /**
1686
+ * Base type for events emitting on the `window` topic
1687
+ * @interface
1688
+ */
1689
+ declare type BaseEvent_5 = BaseEvents.NamedEvent & {
1690
+ topic: 'window';
1691
+ };
1692
+
1693
+ /**
1694
+ * Base type for events emitting on the `externalapplication` topic
1695
+ * @interface
1696
+ */
1697
+ declare type BaseEvent_6 = BaseEvents.BaseEvent & {
1698
+ topic: 'externalapplication';
1699
+ };
1700
+
1701
+ /**
1702
+ * The base frame event.
1703
+ * @interface
1704
+ */
1705
+ declare type BaseEvent_7 = NamedEvent & {
1706
+ entityType: 'iframe';
1707
+ frameName: string;
1708
+ };
1709
+
1710
+ /**
1711
+ * Base type for events emitting on the `system` topic
1712
+ * @interface
1713
+ */
1714
+ declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1715
+ topic: 'system';
1716
+ };
1717
+
1718
+ declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
1747
1719
 
1748
1720
  declare namespace BaseEvents {
1749
1721
  export {
1722
+ NotCloseRequested,
1750
1723
  PropagatedEventType,
1751
1724
  PropagatedEvent,
1752
1725
  EventHandler,
@@ -1757,21 +1730,14 @@ declare namespace BaseEvents {
1757
1730
  }
1758
1731
 
1759
1732
  /**
1760
- * Base type for events emitting on the `externalapplication` topic
1761
- * @interface
1733
+ * @deprecated Renamed to {@link BaseEvent}.
1762
1734
  */
1763
- declare type BaseExternalApplicationEvent = BaseEvent & {
1764
- topic: 'externalapplication';
1765
- };
1735
+ declare type BaseExternalApplicationEvent = BaseEvent_6;
1766
1736
 
1767
1737
  /**
1768
- * The base frame event.
1769
- * @interface
1738
+ * @deprecated Renamed to {@link BaseEvent}.
1770
1739
  */
1771
- declare type BaseFrameEvent = NamedEvent & {
1772
- entityType: 'iframe';
1773
- frameName: string;
1774
- };
1740
+ declare type BaseFrameEvent = BaseEvent_7;
1775
1741
 
1776
1742
  declare type BaseLoadFailedEvent = NamedEvent & {
1777
1743
  errorCode: number;
@@ -1780,35 +1746,20 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1780
1746
  isMainFrame: boolean;
1781
1747
  };
1782
1748
 
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
1749
  declare type BaseUrlEvent = NamedEvent & {
1792
1750
  type: 'url-changed';
1793
1751
  url: string;
1794
1752
  };
1795
1753
 
1796
1754
  /**
1797
- * Base type for events emitting on the `view` topic
1798
- * @interface
1755
+ * @deprecated Renamed to {@link BaseEvent}.
1799
1756
  */
1800
- declare type BaseViewEvent = NamedEvent & {
1801
- topic: 'view';
1802
- target: OpenFin.Identity;
1803
- };
1757
+ declare type BaseViewEvent = BaseEvent_4;
1804
1758
 
1805
1759
  /**
1806
- * Base type for events emitting on the `window` topic
1807
- * @interface
1760
+ * @deprecated Renamed to {@link BaseEvent}.
1808
1761
  */
1809
- declare type BaseWindowEvent = NamedEvent & {
1810
- topic: 'window';
1811
- };
1762
+ declare type BaseWindowEvent = BaseEvent_5;
1812
1763
 
1813
1764
  /**
1814
1765
  * User decision of whether a Window or specific View should close when trying to prevent an unload.
@@ -1875,7 +1826,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
1875
1826
  * A general bounds change event without event type.
1876
1827
  * @interface
1877
1828
  */
1878
- declare type BoundsChangeEvent = BaseWindowEvent & {
1829
+ declare type BoundsChangeEvent = BaseEvent_5 & {
1879
1830
  changeType: 0 | 1 | 2;
1880
1831
  deferred: boolean;
1881
1832
  height: number;
@@ -1947,76 +1898,76 @@ declare interface BrowserWindow {
1947
1898
  }
1948
1899
 
1949
1900
  /**
1950
- * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
1901
+ * Extracts a single event type matching the given key from the View {@link Event} union.
1951
1902
  *
1952
1903
  * Alias for {@link Payload}, which may read better in source.
1953
1904
  *
1954
1905
  * @typeParam Type String key specifying the event to extract
1955
1906
  */
1956
- declare type ByType<Type extends ApplicationEventType> = Payload_2<Type>;
1907
+ declare type ByType<Type extends EventType> = Payload_2<Type>;
1957
1908
 
1958
1909
  /**
1959
- * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
1910
+ * Extracts a single event type matching the given key from the Window {@link Event} union.
1960
1911
  *
1961
1912
  * Alias for {@link Payload}, which may read better in source.
1962
1913
  *
1963
1914
  * @typeParam Type String key specifying the event to extract
1964
1915
  */
1965
- declare type ByType_2<Type extends ExternalApplicationEventType> = Payload_3<Type>;
1916
+ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1966
1917
 
1967
1918
  /**
1968
- * Extracts a single event type matching the given key from the {@link FrameEvent} union.
1919
+ * Extracts a single event type matching the given key from the Application {@link Event} union.
1969
1920
  *
1970
1921
  * Alias for {@link Payload}, which may read better in source.
1971
1922
  *
1972
1923
  * @typeParam Type String key specifying the event to extract
1973
1924
  */
1974
- declare type ByType_3<Type extends FrameEventType> = Payload_4<Type>;
1925
+ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1975
1926
 
1976
1927
  /**
1977
- * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
1928
+ * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
1978
1929
  *
1979
1930
  * Alias for {@link Payload}, which may read better in source.
1980
1931
  *
1981
1932
  * @typeParam Type String key specifying the event to extract
1982
1933
  */
1983
- declare type ByType_4<Type extends GlobalHotkeyEventType> = Payload_5<Type>;
1934
+ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
1984
1935
 
1985
1936
  /**
1986
- * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
1937
+ * Extracts a single event type matching the given key from the Frame {@link Event} union.
1987
1938
  *
1988
1939
  * Alias for {@link Payload}, which may read better in source.
1989
1940
  *
1990
1941
  * @typeParam Type String key specifying the event to extract
1991
1942
  */
1992
- declare type ByType_5<Type extends PlatformEventType> = Payload_6<Type>;
1943
+ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
1993
1944
 
1994
1945
  /**
1995
- * Extracts a single event type matching the given key from the {@link SystemEvent} union.
1946
+ * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
1996
1947
  *
1997
1948
  * Alias for {@link Payload}, which may read better in source.
1998
1949
  *
1999
1950
  * @typeParam Type String key specifying the event to extract
2000
1951
  */
2001
- declare type ByType_6<Type extends SystemEventType> = Payload_7<Type>;
1952
+ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
2002
1953
 
2003
1954
  /**
2004
- * Extracts a single event type matching the given key from the {@link ViewEvent} union.
1955
+ * Extracts a single event type matching the given key from the Platform {@link Event} union.
2005
1956
  *
2006
1957
  * Alias for {@link Payload}, which may read better in source.
2007
1958
  *
2008
1959
  * @typeParam Type String key specifying the event to extract
2009
1960
  */
2010
- declare type ByType_7<Type extends ViewEventType> = Payload_8<Type>;
1961
+ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
2011
1962
 
2012
1963
  /**
2013
- * Extracts a single event type matching the given key from the {@link WindowEvent} union.
1964
+ * Extracts a single event type matching the given key from the System {@link Event} union.
2014
1965
  *
2015
1966
  * Alias for {@link Payload}, which may read better in source.
2016
1967
  *
2017
1968
  * @typeParam Type String key specifying the event to extract
2018
1969
  */
2019
- declare type ByType_8<Type extends WindowEventType> = Payload_9<Type>;
1970
+ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
2020
1971
 
2021
1972
  /**
2022
1973
  * Configuration for page capture.
@@ -2682,14 +2633,6 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
2682
2633
 
2683
2634
  declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
2684
2635
 
2685
- /**
2686
- * Generated when a Channel client is connected.
2687
- * @interface
2688
- */
2689
- declare type ChannelConnectedEvent = BaseChannelEvent & {
2690
- type: 'connected';
2691
- };
2692
-
2693
2636
  /**
2694
2637
  * Options provided on a client connection to a channel.
2695
2638
  *
@@ -2721,21 +2664,9 @@ declare type ChannelCreateOptions = {
2721
2664
  };
2722
2665
 
2723
2666
  /**
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.
2667
+ * @deprecated Renamed to {@link Event}.
2735
2668
  */
2736
- declare type ChannelEvent = {
2737
- topic: 'channel';
2738
- } & (ChannelConnectedEvent | ChannelDisconnectedEvent);
2669
+ declare type ChannelEvent = Event_2;
2739
2670
 
2740
2671
  declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
2741
2672
 
@@ -3089,20 +3020,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
3089
3020
  connectionUrl: string;
3090
3021
  };
3091
3022
 
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
3023
  /**
3107
3024
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
3108
3025
  *
@@ -3270,11 +3187,19 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
3270
3187
  * Generated when an application is closed.
3271
3188
  * @interface
3272
3189
  */
3273
- declare type ClosedEvent = IdentityEvent & {
3190
+ declare type ClosedEvent = BaseEvents.IdentityEvent & {
3274
3191
  topic: 'application';
3275
3192
  type: 'closed';
3276
3193
  };
3277
3194
 
3195
+ /**
3196
+ * Generated when a window has closed.
3197
+ * @interface
3198
+ */
3199
+ declare type ClosedEvent_2 = BaseEvent_5 & {
3200
+ type: 'closed';
3201
+ };
3202
+
3278
3203
  /**
3279
3204
  * @interface
3280
3205
  */
@@ -3282,6 +3207,15 @@ declare type ClosedMenuResult = {
3282
3207
  result: 'closed';
3283
3208
  };
3284
3209
 
3210
+ /**
3211
+ * Generated when a window has been prevented from closing.
3212
+ * @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.
3213
+ * @interface
3214
+ */
3215
+ declare type CloseRequestedEvent = BaseEvent_5 & {
3216
+ type: 'close-requested';
3217
+ };
3218
+
3285
3219
  /**
3286
3220
  * @interface
3287
3221
  */
@@ -3328,6 +3262,14 @@ declare interface CloseWindowPayload {
3328
3262
  };
3329
3263
  }
3330
3264
 
3265
+ /**
3266
+ * Generated when a window has initiated the closing routine.
3267
+ * @interface
3268
+ */
3269
+ declare type ClosingEvent = BaseEvent_5 & {
3270
+ type: 'closing';
3271
+ };
3272
+
3331
3273
  /**
3332
3274
  * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
3333
3275
  */
@@ -3411,6 +3353,39 @@ export declare function connect(config: ConnectConfig): Promise<Fin<'external co
3411
3353
 
3412
3354
  declare type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
3413
3355
 
3356
+ /**
3357
+ * Generated when a Channel client is connected.
3358
+ * @interface
3359
+ */
3360
+ declare type ConnectedEvent = BaseEvent_2 & {
3361
+ type: 'connected';
3362
+ };
3363
+
3364
+ /**
3365
+ * Generated when an application has authenticated and is connected.
3366
+ * @interface
3367
+ */
3368
+ declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
3369
+ topic: 'application';
3370
+ type: 'connected';
3371
+ };
3372
+
3373
+ /**
3374
+ * Generated when an external application has authenticated and is connected.
3375
+ * @interface
3376
+ */
3377
+ declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
3378
+ type: 'connected';
3379
+ };
3380
+
3381
+ /**
3382
+ * Generated when a frame is connected.
3383
+ * @interface
3384
+ */
3385
+ declare type ConnectedEvent_4 = BaseFrameEvent & {
3386
+ type: 'connected';
3387
+ };
3388
+
3414
3389
  declare type Constructor<T = {}> = new () => T;
3415
3390
 
3416
3391
  declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
@@ -3421,6 +3396,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
3421
3396
  * @interface
3422
3397
  */
3423
3398
  declare type ConstViewOptions = {
3399
+ /**
3400
+ * Configurations for API injection.
3401
+ */
3402
+ api: Api;
3424
3403
  /**
3425
3404
  * The name of the view.
3426
3405
  */
@@ -3569,7 +3548,7 @@ declare type ConstWindowOptions = {
3569
3548
  /**
3570
3549
  * @defaultValue true
3571
3550
  *
3572
- * Toggling off would keep the Window alive even if all its Views were closed.
3551
+ * Setting this to false would keep the Window alive even if all its Views were closed.
3573
3552
  * This is meant for advanced users and should be used with caution.
3574
3553
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3575
3554
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
@@ -3579,7 +3558,8 @@ declare type ConstWindowOptions = {
3579
3558
  /**
3580
3559
  * @defaultValue 'all'
3581
3560
  *
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'.
3561
+ * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3562
+ + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3583
3563
  * **NOTE:** - This option is ignored in non-Platforms apps.
3584
3564
  */
3585
3565
  viewsPreventingClose: 'all' | 'layout';
@@ -4152,7 +4132,7 @@ declare type Context_3 = {
4152
4132
  * Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
4153
4133
  * @interface
4154
4134
  */
4155
- declare type ContextChangedEvent = BaseWindowEvent & {
4135
+ declare type ContextChangedEvent = BaseEvent_5 & {
4156
4136
  type: 'context-changed';
4157
4137
  context: any;
4158
4138
  };
@@ -4304,7 +4284,7 @@ declare type CpuInfo = {
4304
4284
  * Generated when an application has crashed.
4305
4285
  * @interface
4306
4286
  */
4307
- declare type CrashedEvent = IdentityEvent & {
4287
+ declare type CrashedEvent = BaseEvents.IdentityEvent & {
4308
4288
  topic: 'application';
4309
4289
  type: 'crashed';
4310
4290
  reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
@@ -4355,7 +4335,7 @@ declare type CrashReporterState = CrashReporterOptions & {
4355
4335
  * Generated when a View is created.
4356
4336
  * @interface
4357
4337
  */
4358
- declare type CreatedEvent = BaseViewEvent & {
4338
+ declare type CreatedEvent = BaseEvent_4 & {
4359
4339
  type: 'created';
4360
4340
  };
4361
4341
 
@@ -4386,7 +4366,7 @@ declare type CreateViewPayload = {
4386
4366
  /**
4387
4367
  * @interface
4388
4368
  */
4389
- declare type CreateViewTarget = LayoutIdentity & {
4369
+ declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
4390
4370
  /**
4391
4371
  * If specified, view creation will not attach to a window and caller must
4392
4372
  * insert the view into the layout explicitly
@@ -4514,7 +4494,7 @@ declare interface DesktopAgent_2 {
4514
4494
  * Generated when the desktop icon is clicked while it's already running.
4515
4495
  * @interface
4516
4496
  */
4517
- declare type DesktopIconClickedEvent = BaseSystemEvent & {
4497
+ declare type DesktopIconClickedEvent = BaseEvent_8 & {
4518
4498
  type: 'desktop-icon-clicked';
4519
4499
  };
4520
4500
 
@@ -4522,10 +4502,18 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
4522
4502
  * Generated when a View is destroyed.
4523
4503
  * @interface
4524
4504
  */
4525
- declare type DestroyedEvent = BaseViewEvent & {
4505
+ declare type DestroyedEvent = BaseEvent_4 & {
4526
4506
  type: 'destroyed';
4527
4507
  };
4528
4508
 
4509
+ /**
4510
+ * @interface
4511
+ */
4512
+ declare type DeviceInfo = {
4513
+ vendorId: string | number;
4514
+ productId: string | number;
4515
+ };
4516
+
4529
4517
  /**
4530
4518
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
4531
4519
  * @interface
@@ -4622,6 +4610,30 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
4622
4610
  type: 'disabled-movement-bounds-changing';
4623
4611
  };
4624
4612
 
4613
+ /**
4614
+ * Generated when a Channel client has disconnected.
4615
+ * @interface
4616
+ */
4617
+ declare type DisconnectedEvent = BaseEvent_2 & {
4618
+ type: 'disconnected';
4619
+ };
4620
+
4621
+ /**
4622
+ * Generated when an external application has disconnected.
4623
+ * @interface
4624
+ */
4625
+ declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
4626
+ type: 'disconnected';
4627
+ };
4628
+
4629
+ /**
4630
+ * Generated when a frame has disconnected.
4631
+ * @interface
4632
+ */
4633
+ declare type DisconnectedEvent_3 = BaseFrameEvent & {
4634
+ type: 'disconnected';
4635
+ };
4636
+
4625
4637
  /**
4626
4638
  * A system channel will be global enough to have a presence across many apps. This gives us some hints
4627
4639
  * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
@@ -4743,7 +4755,7 @@ declare type DownloadShelfOptions = {
4743
4755
  */
4744
4756
  size?: number;
4745
4757
  /**
4746
- * Color of the border, either a string name or a hex code. Defaults to chromium theme
4758
+ * Color of the border. Must be a 6-character hex code prefixed by #. Defaults to chromium theme
4747
4759
  * if absent.
4748
4760
  */
4749
4761
  color?: string;
@@ -4755,7 +4767,7 @@ declare type DownloadShelfOptions = {
4755
4767
  *
4756
4768
  * @interface
4757
4769
  */
4758
- declare type DownloadShelfVisibilityChangedEvent = BaseWindowEvent & {
4770
+ declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
4759
4771
  type: 'download-shelf-visibility-changed';
4760
4772
  /**
4761
4773
  * True if the download shelf was just opened; false if it was just closed.
@@ -4785,7 +4797,7 @@ declare interface DragSource {}
4785
4797
  * Generated when a window has been embedded.
4786
4798
  * @interface
4787
4799
  */
4788
- declare type EmbeddedEvent = BaseWindowEvent & {
4800
+ declare type EmbeddedEvent = BaseEvent_5 & {
4789
4801
  type: 'embedded';
4790
4802
  };
4791
4803
 
@@ -4884,7 +4896,7 @@ declare class EmitterMap {
4884
4896
  * Generated when a window ends loading.
4885
4897
  * @interface
4886
4898
  */
4887
- declare type EndLoadEvent = BaseWindowEvent & {
4899
+ declare type EndLoadEvent = BaseEvent_5 & {
4888
4900
  type: 'end-load';
4889
4901
  documentName: string;
4890
4902
  isMain: boolean;
@@ -4962,9 +4974,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
4962
4974
  } : never;
4963
4975
 
4964
4976
  declare interface Environment {
4965
- initLayout(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
4977
+ initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
4966
4978
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
4967
4979
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
4980
+ resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
4968
4981
  initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
4969
4982
  observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
4970
4983
  writeToken(path: string, token: string): Promise<string>;
@@ -5001,15 +5014,97 @@ declare type ErrorPlainObject = {
5001
5014
  toString(): string;
5002
5015
  };
5003
5016
 
5004
- declare class EventAggregator extends EmitterMap {
5005
- dispatchEvent: (message: Message<any>) => boolean;
5006
- }
5017
+ /**
5018
+ * [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
5019
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5020
+ * under the {@link OpenFin.PlatformEvents} namespace.
5021
+ */
5022
+ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5007
5023
 
5008
- declare interface EventEmitter_2 {
5009
- [x: string]: any;
5010
- /**
5011
- * Subscribe to an event
5012
- * @param eventName The name of the event to describe to
5024
+ /**
5025
+ * [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
5026
+ * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5027
+ * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5028
+ * from which they propagate).
5029
+ */
5030
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
5031
+
5032
+ /**
5033
+ * [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
5034
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5035
+ * under the {@link OpenFin.ChannelEvents} namespace.
5036
+ */
5037
+ declare type Event_2 = {
5038
+ topic: 'channel';
5039
+ } & (ConnectedEvent | DisconnectedEvent);
5040
+
5041
+ /**
5042
+ * [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
5043
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5044
+ * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5045
+ * from which they propagate).
5046
+ */
5047
+ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
5048
+
5049
+ /**
5050
+ * [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
5051
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5052
+ * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5053
+ */
5054
+ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5055
+ target: OpenFin.Identity;
5056
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
5057
+
5058
+ /**
5059
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
5060
+ * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
5061
+ */
5062
+ declare type Event_5<Topic extends string> = {
5063
+ topic: Topic;
5064
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
5065
+
5066
+ /**
5067
+ * [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
5068
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5069
+ * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5070
+ */
5071
+ declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5072
+
5073
+ /**
5074
+ * [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
5075
+ * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5076
+ * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5077
+ */
5078
+ declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5079
+
5080
+ /**
5081
+ * [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
5082
+ * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5083
+ * under the {@link OpenFin.FrameEvents} namespace.
5084
+ */
5085
+ declare type Event_8 = {
5086
+ topic: 'frame';
5087
+ } & (ConnectedEvent_4 | DisconnectedEvent_3);
5088
+
5089
+ /**
5090
+ * [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
5091
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5092
+ * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5093
+ */
5094
+ declare type Event_9 = {
5095
+ topic: 'global-hotkey';
5096
+ hotkey: 'string';
5097
+ } & (RegisteredEvent | UnregisteredEvent);
5098
+
5099
+ declare class EventAggregator extends EmitterMap {
5100
+ dispatchEvent: (message: Message<any>) => boolean;
5101
+ }
5102
+
5103
+ declare interface EventEmitter_2 {
5104
+ [x: string]: any;
5105
+ /**
5106
+ * Subscribe to an event
5107
+ * @param eventName The name of the event to describe to
5013
5108
  * @param callback The function that should be invoked when the event occurs
5014
5109
  * @param context The value of the this pointer in the callback function
5015
5110
  */
@@ -5066,6 +5161,46 @@ declare namespace Events {
5066
5161
  }
5067
5162
  }
5068
5163
 
5164
+ /**
5165
+ * Union of possible `type` values for a view {@link Event}.
5166
+ */
5167
+ declare type EventType = Event_4['type'];
5168
+
5169
+ /**
5170
+ * Union of possible `type` values for a Window {@link Event}.
5171
+ */
5172
+ declare type EventType_2 = Event_6['type'];
5173
+
5174
+ /**
5175
+ * Union of possible `type` values for an Application {@link Event}.
5176
+ */
5177
+ declare type EventType_3 = Event_3['type'];
5178
+
5179
+ /**
5180
+ * Union of possible `type` values for an ExternalApplication {@link Event}.
5181
+ */
5182
+ declare type EventType_4 = Event_7['type'];
5183
+
5184
+ /**
5185
+ * Union of possible `type` values for a {@link FrameEvent}.
5186
+ */
5187
+ declare type EventType_5 = Event_8['type'];
5188
+
5189
+ /**
5190
+ * Union of possible `type` values for a {@link GlobalHotkeyEvent}
5191
+ */
5192
+ declare type EventType_6 = Event_9['type'];
5193
+
5194
+ /**
5195
+ * Union of possible `type` values for a {@link PlatformEvent}.
5196
+ */
5197
+ declare type EventType_7 = Event_10['type'];
5198
+
5199
+ /**
5200
+ * Union of possible `type` values for a {@link SystemEvent}.
5201
+ */
5202
+ declare type EventType_8 = Event_11['type'];
5203
+
5069
5204
  /* Excluded from this release type: EventWithId */
5070
5205
 
5071
5206
  /* Excluded from this release type: ExcludeRequested */
@@ -5096,83 +5231,6 @@ declare type ExitCode = {
5096
5231
  declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicationEvent> {
5097
5232
  identity: OpenFin.ApplicationIdentity;
5098
5233
  /* 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
5234
  /**
5177
5235
  * Retrieves information about the external application.
5178
5236
  *
@@ -5189,46 +5247,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
5189
5247
  }
5190
5248
 
5191
5249
  /**
5192
- * Generated when an external application has authenticated and is connected.
5193
- * @interface
5250
+ * @deprecated Renamed to {@link ConnectedEvent}.
5194
5251
  */
5195
- declare type ExternalApplicationConnectedEvent = BaseExternalApplicationEvent & {
5196
- type: 'connected';
5197
- };
5252
+ declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
5198
5253
 
5199
5254
  /**
5200
- * Generated when an external application has disconnected.
5201
- * @interface
5255
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5202
5256
  */
5203
- declare type ExternalApplicationDisconnectedEvent = BaseExternalApplicationEvent & {
5204
- type: 'disconnected';
5205
- };
5257
+ declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
5206
5258
 
5207
5259
  /**
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.
5260
+ * @deprecated Renamed to {@link Event}.
5211
5261
  */
5212
- declare type ExternalApplicationEvent = ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent;
5262
+ declare type ExternalApplicationEvent = Event_7;
5213
5263
 
5214
5264
  declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
5215
5265
 
5216
5266
  declare namespace ExternalApplicationEvents {
5217
5267
  export {
5268
+ BaseEvent_6 as BaseEvent,
5218
5269
  BaseExternalApplicationEvent,
5270
+ ConnectedEvent_3 as ConnectedEvent,
5219
5271
  ExternalApplicationConnectedEvent,
5272
+ DisconnectedEvent_2 as DisconnectedEvent,
5220
5273
  ExternalApplicationDisconnectedEvent,
5274
+ Event_7 as Event,
5221
5275
  ExternalApplicationEvent,
5276
+ EventType_4 as EventType,
5222
5277
  ExternalApplicationEventType,
5223
- Payload_3 as Payload,
5224
- ByType_2 as ByType
5278
+ Payload_5 as Payload,
5279
+ ByType_4 as ByType
5225
5280
  }
5226
5281
  }
5227
5282
 
5228
5283
  /**
5229
- * Union of possible `type` values for a {@link ApplicationEvent}.
5284
+ * @deprecated Renamed to {@link Event}.
5230
5285
  */
5231
- declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
5286
+ declare type ExternalApplicationEventType = EventType_4;
5232
5287
 
5233
5288
  /**
5234
5289
  * @interface
@@ -5293,7 +5348,7 @@ declare type ExternalConnection = {
5293
5348
  * Generated when an external process has exited.
5294
5349
  * @interface
5295
5350
  */
5296
- declare type ExternalProcessExitedEvent = BaseWindowEvent & {
5351
+ declare type ExternalProcessExitedEvent = BaseEvent_5 & {
5297
5352
  type: 'external-process-exited';
5298
5353
  processUuid: string;
5299
5354
  exitCode: number;
@@ -5338,19 +5393,15 @@ declare type ExternalProcessRequestType = {
5338
5393
  * Generated when an external process has started.
5339
5394
  * @interface
5340
5395
  */
5341
- declare type ExternalProcessStartedEvent = BaseWindowEvent & {
5396
+ declare type ExternalProcessStartedEvent = BaseEvent_5 & {
5342
5397
  type: 'external-process-started';
5343
5398
  processUuid: string;
5344
5399
  };
5345
5400
 
5346
5401
  /**
5347
- * Generated when page receives favicon urls.
5348
- * @interface
5402
+ * @deprecated, use {@link PageFaviconUpdatedEvent}.
5349
5403
  */
5350
- declare type FaviconUpdatedEvent = NamedEvent & {
5351
- type: 'page-favicon-updated';
5352
- favicons: string[];
5353
- };
5404
+ declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
5354
5405
 
5355
5406
  declare namespace FDC3 {
5356
5407
  export {
@@ -5437,7 +5488,7 @@ declare type FileDownloadEvent = {
5437
5488
  *
5438
5489
  * @interface
5439
5490
  */
5440
- declare type FileDownloadLocationChangedEvent = BaseApplicationEvent & {
5491
+ declare type FileDownloadLocationChangedEvent = BaseEvent_3 & {
5441
5492
  type: 'file-download-location-changed';
5442
5493
  };
5443
5494
 
@@ -5599,83 +5650,6 @@ declare type FoundInPageEvent = NamedEvent & {
5599
5650
  declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5600
5651
  identity: OpenFin.Identity;
5601
5652
  /* 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
5653
  /**
5680
5654
  * Returns a frame info object for the represented frame.
5681
5655
  *
@@ -5706,48 +5680,43 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5706
5680
  }
5707
5681
 
5708
5682
  /**
5709
- * Generated when a frame is connected.
5710
- * @interface
5683
+ * @deprecated Renamed to {@link ConnectedEvent}.
5711
5684
  */
5712
- declare type FrameConnectedEvent = BaseFrameEvent & {
5713
- type: 'connected';
5714
- };
5685
+ declare type FrameConnectedEvent = ConnectedEvent_4;
5715
5686
 
5716
5687
  /**
5717
- * Generated when a frame has disconnected.
5718
- * @interface
5688
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5719
5689
  */
5720
- declare type FrameDisconnectedEvent = BaseFrameEvent & {
5721
- type: 'disconnected';
5722
- };
5690
+ declare type FrameDisconnectedEvent = DisconnectedEvent_3;
5723
5691
 
5724
5692
  /**
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.
5693
+ * @deprecated Renamed to {@link Event}.
5728
5694
  */
5729
- declare type FrameEvent = {
5730
- topic: 'frame';
5731
- } & (FrameConnectedEvent | FrameDisconnectedEvent);
5695
+ declare type FrameEvent = Event_8;
5732
5696
 
5733
5697
  declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
5734
5698
 
5735
5699
  declare namespace FrameEvents {
5736
5700
  export {
5701
+ BaseEvent_7 as BaseEvent,
5737
5702
  BaseFrameEvent,
5703
+ ConnectedEvent_4 as ConnectedEvent,
5738
5704
  FrameConnectedEvent,
5705
+ DisconnectedEvent_3 as DisconnectedEvent,
5739
5706
  FrameDisconnectedEvent,
5707
+ Event_8 as Event,
5740
5708
  FrameEvent,
5709
+ EventType_5 as EventType,
5741
5710
  FrameEventType,
5742
- Payload_4 as Payload,
5743
- ByType_3 as ByType
5711
+ Payload_6 as Payload,
5712
+ ByType_5 as ByType
5744
5713
  }
5745
5714
  }
5746
5715
 
5747
5716
  /**
5748
- * Union of possible `type` values for a {@link FrameEvent}.
5717
+ * @deprecated Renamed to {@link EventType}.
5749
5718
  */
5750
- declare type FrameEventType = FrameEvent['type'];
5719
+ declare type FrameEventType = EventType_5;
5751
5720
 
5752
5721
  /**
5753
5722
  * @interface
@@ -5966,14 +5935,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
5966
5935
  }
5967
5936
 
5968
5937
  /**
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.
5938
+ * @deprecated Renamed to {@link Event}.
5972
5939
  */
5973
- declare type GlobalHotkeyEvent = {
5974
- topic: 'global-hotkey';
5975
- hotkey: 'string';
5976
- } & (RegisteredEvent | UnregisteredEvent);
5940
+ declare type GlobalHotkeyEvent = Event_9;
5977
5941
 
5978
5942
  declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
5979
5943
 
@@ -5981,17 +5945,19 @@ declare namespace GlobalHotkeyEvents {
5981
5945
  export {
5982
5946
  RegisteredEvent,
5983
5947
  UnregisteredEvent,
5948
+ Event_9 as Event,
5984
5949
  GlobalHotkeyEvent,
5950
+ EventType_6 as EventType,
5985
5951
  GlobalHotkeyEventType,
5986
- Payload_5 as Payload,
5987
- ByType_4 as ByType
5952
+ Payload_7 as Payload,
5953
+ ByType_6 as ByType
5988
5954
  }
5989
5955
  }
5990
5956
 
5991
5957
  /**
5992
- * Union of possible `type` values for a {@link GlobalHotkeyEvent}
5958
+ * @deprecated Renamed to {@link EventType}.
5993
5959
  */
5994
- declare type GlobalHotkeyEventType = GlobalHotkeyEvent['type'];
5960
+ declare type GlobalHotkeyEventType = EventType_6;
5995
5961
 
5996
5962
  declare namespace GoldenLayout {
5997
5963
  export {
@@ -6293,8 +6259,17 @@ declare interface Header {
6293
6259
  * Generated when a View is hidden.
6294
6260
  * @interface
6295
6261
  */
6296
- declare type HiddenEvent = BaseViewEvent & {
6262
+ declare type HiddenEvent = BaseEvent_4 & {
6263
+ type: 'hidden';
6264
+ };
6265
+
6266
+ /**
6267
+ * Generated when a window has been hidden.
6268
+ * @interface
6269
+ */
6270
+ declare type HiddenEvent_2 = BaseEvent_5 & {
6297
6271
  type: 'hidden';
6272
+ reason: 'closing' | 'hide' | 'hide-on-close';
6298
6273
  };
6299
6274
 
6300
6275
  /**
@@ -6302,7 +6277,7 @@ declare type HiddenEvent = BaseViewEvent & {
6302
6277
  * or because the View has moved to a new window. Only available on Views in a Platform.
6303
6278
  * @interface
6304
6279
  */
6305
- declare type HostContextChangedEvent = BaseViewEvent & {
6280
+ declare type HostContextChangedEvent = BaseEvent_4 & {
6306
6281
  type: 'host-context-changed';
6307
6282
  context: any;
6308
6283
  reason: 'reparented' | 'updated';
@@ -6381,7 +6356,16 @@ declare type Hotkey = {
6381
6356
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6382
6357
  * @interface
6383
6358
  */
6384
- declare type HotkeyEvent = BaseViewEvent & {
6359
+ declare type HotkeyEvent = BaseEvent_4 & {
6360
+ type: 'hotkey';
6361
+ };
6362
+
6363
+ /**
6364
+ * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
6365
+ * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6366
+ * @interface
6367
+ */
6368
+ declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
6385
6369
  type: 'hotkey';
6386
6370
  };
6387
6371
 
@@ -6434,6 +6418,11 @@ declare type IdentityEvent = BaseEvent & {
6434
6418
 
6435
6419
  /* Excluded from this release type: IdEventType */
6436
6420
 
6421
+ /**
6422
+ * @deprecated Renamed to {@link IdleStateChangedEvent}.
6423
+ */
6424
+ declare type IdleEvent = IdleStateChangedEvent;
6425
+
6437
6426
  /**
6438
6427
  * Generated when a user enters or returns from idle state.
6439
6428
  * @remarks This method is continuously generated every minute while the user is in idle.
@@ -6441,7 +6430,7 @@ declare type IdentityEvent = BaseEvent & {
6441
6430
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6442
6431
  * @interface
6443
6432
  */
6444
- declare type IdleEvent = BaseSystemEvent & {
6433
+ declare type IdleStateChangedEvent = BaseEvent_8 & {
6445
6434
  type: 'idle-state-changed';
6446
6435
  elapsedTime: number;
6447
6436
  isIdle: boolean;
@@ -6526,11 +6515,19 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6526
6515
  * Generated when an application has initialized.
6527
6516
  * @interface
6528
6517
  */
6529
- declare type InitializedEvent = IdentityEvent & {
6518
+ declare type InitializedEvent = BaseEvents.IdentityEvent & {
6530
6519
  topic: 'application';
6531
6520
  type: 'initialized';
6532
6521
  };
6533
6522
 
6523
+ /**
6524
+ * Generated when a window is initialized.
6525
+ * @interface
6526
+ */
6527
+ declare type InitializedEvent_2 = BaseEvent_5 & {
6528
+ type: 'initialized';
6529
+ };
6530
+
6534
6531
  /**
6535
6532
  * @interface
6536
6533
  */
@@ -6915,56 +6912,6 @@ declare class InteropBroker extends Base {
6915
6912
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
6916
6913
  new (): InteropBroker;
6917
6914
  };
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
6915
  /**
6969
6916
  * Sets a context for the context group of the incoming current entity.
6970
6917
  * @param setContextOptions - New context to set.
@@ -7208,7 +7155,7 @@ declare class InteropBroker extends Base {
7208
7155
  * // }
7209
7156
  * ```
7210
7157
  *
7211
- * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
7158
+ * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
7212
7159
  *
7213
7160
  * @param contextForIntent Data passed between entities and applications.
7214
7161
  * @param clientIdentity Identity of the Client making the request.
@@ -7465,96 +7412,7 @@ declare type InteropBrokerOptions = {
7465
7412
  };
7466
7413
 
7467
7414
  /**
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}
7415
+ * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
7558
7416
  *
7559
7417
  * The Interop Client API is broken up into two groups:
7560
7418
  *
@@ -7988,13 +7846,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
7988
7846
  */
7989
7847
  declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
7990
7848
 
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
7849
  /**
7999
7850
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
8000
7851
  *
@@ -8384,7 +8235,7 @@ declare type LaunchIntoPlatformPayload = {
8384
8235
  declare class Layout extends Base {
8385
8236
  #private;
8386
8237
  /* Excluded from this release type: init */
8387
- identity: OpenFin.LayoutIdentity;
8238
+ identity: OpenFin.Identity | OpenFin.LayoutIdentity;
8388
8239
  private platform;
8389
8240
  wire: Transport;
8390
8241
  /* Excluded from this release type: __constructor */
@@ -8600,25 +8451,24 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
8600
8451
  */
8601
8452
  declare type LayoutIdentity = Identity_5 & {
8602
8453
  /**
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.
8454
+ * The name of the layout in a given window.
8605
8455
  */
8606
- layoutName?: string;
8456
+ layoutName: string;
8607
8457
  };
8608
8458
 
8609
8459
  /**
8610
- * Generated when a window and all of its layout's views have either finished or failed navigation.
8460
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8461
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8611
8462
  * @interface
8612
8463
  */
8613
- declare type LayoutInitializedEvent = BaseWindowEvent & {
8464
+ declare type LayoutInitializedEvent = BaseEvent_5 & {
8614
8465
  type: 'layout-initialized';
8466
+ layoutIdentity: OpenFin.LayoutIdentity;
8615
8467
  ofViews: (OpenFin.Identity & {
8616
8468
  entityType: 'view';
8617
8469
  })[];
8618
8470
  };
8619
8471
 
8620
- /* Excluded from this release type: LayoutInstance */
8621
-
8622
8472
  /**
8623
8473
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
8624
8474
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
@@ -8646,7 +8496,7 @@ declare type LayoutItemConfig = {
8646
8496
  *
8647
8497
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
8648
8498
  *
8649
- * Responsible for aggergating all layout snapshots and storing LayoutInstances
8499
+ * Responsible for aggregating all layout snapshots and storing layout instances
8650
8500
  */
8651
8501
  declare interface LayoutManager<T extends LayoutSnapshot> {
8652
8502
  /**
@@ -8670,16 +8520,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
8670
8520
  * @throws if Object.keys(snapshot).length > 1
8671
8521
  */
8672
8522
  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
8523
  /**
8684
8524
  * @experimental
8685
8525
  *
@@ -8700,31 +8540,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
8700
8540
  /**
8701
8541
  * @experimental
8702
8542
  *
8703
- * @param layoutIdentity
8704
- * @returns
8543
+ * A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
8544
+ * this method to control the target layout for Layout API calls.
8545
+ *
8546
+ * Example use case: You have hidden all the layouts and are showing a dialog that will
8547
+ * execute an API call (ex: Layout.replace()) - override this method and save the
8548
+ * "last visible" layout identity and return it.
8549
+ *
8550
+ * By default, OpenFin will use a series of checks to determine which Layout the API
8551
+ * call must route to in this order of precedence:
8552
+ * - try to resolve the layout from the layoutIdentity, throws if missing
8553
+ * - if there is only 1 layout, resolves that one
8554
+ * - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
8555
+ * - returns undefined
8556
+ *
8557
+ * @param identity
8558
+ * @returns LayoutIdentity | undefined
8705
8559
  */
8706
- resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
8560
+ resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
8707
8561
  /**
8708
8562
  * @experimental
8709
8563
  *
8710
- * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
8711
- * Throws if it does not exist.
8712
- * @param layoutName
8713
- * @returns
8564
+ * A hook provided to the consumer when it's time to remove a layout. Use this hook to
8565
+ * update your local state and remove the layout for the given LayoutIdentity. Note that
8566
+ * this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
8567
+ * signify to your application it's time to destroy this layout.
8568
+ *
8569
+ * 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.
8570
+ *
8571
+ * @param LayoutIdentity
8714
8572
  */
8715
- getLayoutByName(layoutName: string): LayoutInstance;
8573
+ removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
8716
8574
  /**
8717
8575
  * @experimental
8718
8576
  */
8719
- getLayouts(): Record<string, LayoutInstance>;
8577
+ getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
8720
8578
  /**
8721
8579
  * @experimental
8722
8580
  */
8723
- getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
8581
+ isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8724
8582
  /**
8725
8583
  * @experimental
8726
8584
  */
8727
- isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8585
+ size(): number;
8728
8586
  }
8729
8587
 
8730
8588
  /**
@@ -8771,7 +8629,7 @@ declare class LayoutModule extends Base {
8771
8629
  * const layoutConfig = await layout.getConfig();
8772
8630
  * ```
8773
8631
  */
8774
- wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
8632
+ wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
8775
8633
  /**
8776
8634
  * Synchronously returns a Layout object that represents a Window's layout.
8777
8635
  *
@@ -8791,7 +8649,7 @@ declare class LayoutModule extends Base {
8791
8649
  * const layoutConfig = await layout.getConfig();
8792
8650
  * ```
8793
8651
  */
8794
- wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
8652
+ wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
8795
8653
  /**
8796
8654
  * Asynchronously returns a Layout object that represents a Window's layout.
8797
8655
  *
@@ -8888,7 +8746,7 @@ declare type LayoutOptions = {
8888
8746
  * @defaultValue false
8889
8747
  *
8890
8748
  * Limits the area to which tabs can be dragged.
8891
- * If true, stack headers are the only areas where tabs can be dropped.
8749
+ * If true, the layout container is the only area where tabs can be dropped.
8892
8750
  */
8893
8751
  constrainDragToContainer?: boolean;
8894
8752
  /**
@@ -8959,6 +8817,9 @@ declare type LayoutOptions = {
8959
8817
  };
8960
8818
  };
8961
8819
 
8820
+ /**
8821
+ * Represents the position of an item in a layout relative to another.
8822
+ */
8962
8823
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
8963
8824
 
8964
8825
  /**
@@ -8967,11 +8828,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
8967
8828
  declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
8968
8829
 
8969
8830
  /**
8970
- * Generated when a window and all of its layout's views have been created and can receive API calls.
8831
+ * Generated when the layout and all of the its views have been created and can receive API calls.
8971
8832
  * @interface
8972
8833
  */
8973
- declare type LayoutReadyEvent = BaseWindowEvent & {
8834
+ declare type LayoutReadyEvent = BaseEvent_5 & {
8974
8835
  type: 'layout-ready';
8836
+ layoutIdentity: OpenFin.LayoutIdentity;
8975
8837
  views: (OpenFin.Identity & {
8976
8838
  success: boolean;
8977
8839
  })[];
@@ -9111,7 +8973,7 @@ declare type Manifest = {
9111
8973
  * Generated when the RVM notifies an application that the manifest has changed.
9112
8974
  * @interface
9113
8975
  */
9114
- declare type ManifestChangedEvent = IdentityEvent & {
8976
+ declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
9115
8977
  topic: 'application';
9116
8978
  type: 'manifest-changed';
9117
8979
  };
@@ -9164,7 +9026,7 @@ declare type MatchPattern = string;
9164
9026
  * Generated when a window is maximized.
9165
9027
  * @interface
9166
9028
  */
9167
- declare type MaximizedEvent = BaseWindowEvent & {
9029
+ declare type MaximizedEvent = BaseEvent_5 & {
9168
9030
  type: 'maximized';
9169
9031
  };
9170
9032
 
@@ -9274,7 +9136,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
9274
9136
  * Generated when a window is minimized.
9275
9137
  * @interface
9276
9138
  */
9277
- declare type MinimizedEvent = BaseWindowEvent & {
9139
+ declare type MinimizedEvent = BaseEvent_5 & {
9278
9140
  type: 'minimized';
9279
9141
  };
9280
9142
 
@@ -9318,14 +9180,9 @@ declare type MonitorDetails = {
9318
9180
  };
9319
9181
 
9320
9182
  /**
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
9183
+ * @deprecated Renamed to {@link MonitorInfoChangedEvent}.
9325
9184
  */
9326
- declare type MonitorEvent = BaseSystemEvent & OpenFin.MonitorInfo & {
9327
- type: 'monitor-info-changed';
9328
- };
9185
+ declare type MonitorEvent = MonitorInfoChangedEvent;
9329
9186
 
9330
9187
  /**
9331
9188
  * @interface
@@ -9349,6 +9206,16 @@ declare type MonitorInfo = {
9349
9206
  virtualScreen: DipRect;
9350
9207
  };
9351
9208
 
9209
+ /**
9210
+ * Generated on changes of a monitor's size/location.
9211
+ * @remarks A monitor's size changes when the taskbar is resized or relocated.
9212
+ * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9213
+ * @interface
9214
+ */
9215
+ declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9216
+ type: 'monitor-info-changed';
9217
+ };
9218
+
9352
9219
  /**
9353
9220
  * @interface
9354
9221
  */
@@ -9671,7 +9538,7 @@ declare type MutableWindowOptions = {
9671
9538
  showTaskbarIcon: boolean;
9672
9539
  interop: InteropConfig;
9673
9540
  /* Excluded from this release type: _internalWorkspaceData */
9674
- workspacePlatform: WorkspacePlatformOptions;
9541
+ workspacePlatform: unknown;
9675
9542
  };
9676
9543
 
9677
9544
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -9745,13 +9612,15 @@ declare type NonPropagatedWebContentsEvent = never;
9745
9612
  */
9746
9613
  declare type NonPropagatedWindowEvent = never;
9747
9614
 
9615
+ /* Excluded from this release type: NotCloseRequested */
9616
+
9748
9617
  /* Excluded from this release type: NotRequested */
9749
9618
 
9750
9619
  /**
9751
9620
  * Generated when an application is not responding.
9752
9621
  * @interface
9753
9622
  */
9754
- declare type NotRespondingEvent = IdentityEvent & {
9623
+ declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
9755
9624
  topic: 'application';
9756
9625
  type: 'not-responding';
9757
9626
  };
@@ -9902,6 +9771,7 @@ declare namespace OpenFin {
9902
9771
  WebPermission,
9903
9772
  VerboseWebPermission,
9904
9773
  OpenExternalPermission,
9774
+ DeviceInfo,
9905
9775
  Permissions_2 as Permissions,
9906
9776
  PlatformWindowCreationOptions,
9907
9777
  PlatformWindowOptions,
@@ -10059,7 +9929,6 @@ declare namespace OpenFin {
10059
9929
  InitLayoutOptions,
10060
9930
  LayoutManagerConstructor,
10061
9931
  LayoutManagerOverride,
10062
- LayoutInstance,
10063
9932
  LayoutManager,
10064
9933
  CreateLayoutOptions,
10065
9934
  PresetLayoutOptions_2 as PresetLayoutOptions,
@@ -10077,7 +9946,7 @@ declare namespace OpenFin {
10077
9946
  AppVersionCompleteEvent,
10078
9947
  AppVersionRuntimeStatusEvent,
10079
9948
  Events,
10080
- BaseEvent_2 as BaseEvent,
9949
+ BaseEvent_9 as BaseEvent,
10081
9950
  WebContentsEvent_2 as WebContentsEvent,
10082
9951
  SystemEvent_2 as SystemEvent,
10083
9952
  ApplicationEvent_2 as ApplicationEvent,
@@ -10119,12 +9988,32 @@ export default OpenFin;
10119
9988
 
10120
9989
  declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
10121
9990
 
9991
+ /**
9992
+ * Generated after window options are changed using the window.updateOptions method.
9993
+ * @remarks Will not fire if the diff object is empty.
9994
+ * @interface
9995
+ */
9996
+ declare type OptionsChangedEvent = BaseEvent_5 & {
9997
+ type: 'options-changed';
9998
+ options: OpenFin.WindowOptions;
9999
+ diff: OpenFin.WindowOptionDiff;
10000
+ };
10001
+
10122
10002
  declare type OverlapsOnlyIfMatching<T, U> = {
10123
10003
  [K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
10124
10004
  };
10125
10005
 
10126
10006
  declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
10127
10007
 
10008
+ /**
10009
+ * Generated when page receives favicon urls.
10010
+ * @interface
10011
+ */
10012
+ declare type PageFaviconUpdatedEvent = NamedEvent & {
10013
+ type: 'page-favicon-updated';
10014
+ favicons: string[];
10015
+ };
10016
+
10128
10017
  /**
10129
10018
  * Generated when page title is set during navigation.
10130
10019
  * @remarks explicitSet is false when title is synthesized from file url.
@@ -10143,74 +10032,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10143
10032
  };
10144
10033
 
10145
10034
  /**
10146
- * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
10035
+ * Extracts a single event type matching the given key from the View {@link Event} union.
10147
10036
  *
10148
10037
  * @typeParam Type String key specifying the event to extract
10149
10038
  */
10150
- declare type Payload_2<Type extends ApplicationEventType> = Extract<ApplicationEvent, {
10039
+ declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10151
10040
  type: Type;
10152
10041
  }>;
10153
10042
 
10154
10043
  /**
10155
- * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
10044
+ * Extracts a single event type matching the given key from the Window {@link Event} union.
10156
10045
  *
10157
10046
  * @typeParam Type String key specifying the event to extract
10158
10047
  */
10159
- declare type Payload_3<Type extends ExternalApplicationEventType> = Extract<ExternalApplicationEvent, {
10048
+ declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10160
10049
  type: Type;
10161
10050
  }>;
10162
10051
 
10163
10052
  /**
10164
- * Extracts a single event type matching the given key from the {@link FrameEvent} union.
10053
+ * Extracts a single event type matching the given key from the Application {@link Event} union.
10165
10054
  *
10166
10055
  * @typeParam Type String key specifying the event to extract
10167
10056
  */
10168
- declare type Payload_4<Type extends FrameEventType> = Extract<FrameEvent, {
10057
+ declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10169
10058
  type: Type;
10170
10059
  }>;
10171
10060
 
10172
10061
  /**
10173
- * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
10062
+ * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
10174
10063
  *
10175
10064
  * @typeParam Type String key specifying the event to extract
10176
10065
  */
10177
- declare type Payload_5<Type extends GlobalHotkeyEventType> = Extract<GlobalHotkeyEvent, {
10066
+ declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10178
10067
  type: Type;
10179
10068
  }>;
10180
10069
 
10181
10070
  /**
10182
- * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
10071
+ * Extracts a single event type matching the given key from the Frame {@link Event} union.
10183
10072
  *
10184
10073
  * @typeParam Type String key specifying the event to extract
10185
10074
  */
10186
- declare type Payload_6<Type extends PlatformEventType> = Extract<PlatformEvent, {
10075
+ declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10187
10076
  type: Type;
10188
10077
  }>;
10189
10078
 
10190
10079
  /**
10191
- * Extracts a single event type matching the given key from the {@link SystemEvent} union.
10080
+ * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
10192
10081
  *
10193
10082
  * @typeParam Type String key specifying the event to extract
10194
10083
  */
10195
- declare type Payload_7<Type extends SystemEventType> = Extract<SystemEvent, {
10084
+ declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10196
10085
  type: Type;
10197
10086
  }>;
10198
10087
 
10199
10088
  /**
10200
- * Extracts a single event type matching the given key from the {@link ViewEvent} union.
10089
+ * Extracts a single event type matching the given key from the Platform {@link Event} union.
10201
10090
  *
10202
10091
  * @typeParam Type String key specifying the event to extract
10203
10092
  */
10204
- declare type Payload_8<Type extends ViewEventType> = Extract<ViewEvent, {
10093
+ declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10205
10094
  type: Type;
10206
10095
  }>;
10207
10096
 
10208
10097
  /**
10209
- * Extracts a single event type matching the given key from the {@link WindowEvent} union.
10098
+ * Extracts a single event type matching the given key from the System {@link Event} union.
10210
10099
  *
10211
10100
  * @typeParam Type String key specifying the event to extract
10212
10101
  */
10213
- declare type Payload_9<Type extends WindowEventType> = Extract<WindowEvent, {
10102
+ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10214
10103
  type: Type;
10215
10104
  }>;
10216
10105
 
@@ -10220,7 +10109,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
10220
10109
  * Generated when window finishes loading. Provides performance and navigation data.
10221
10110
  * @interface
10222
10111
  */
10223
- declare type PerformanceReportEvent = Performance & BaseWindowEvent & {
10112
+ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
10224
10113
  type: 'performance-report';
10225
10114
  };
10226
10115
 
@@ -10231,6 +10120,7 @@ declare type Permissions_2 = {
10231
10120
  Application?: Partial<ApplicationPermissions>;
10232
10121
  System?: Partial<SystemPermissions>;
10233
10122
  webAPIs?: WebPermission[];
10123
+ devices?: DeviceInfo[];
10234
10124
  };
10235
10125
 
10236
10126
  declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -10854,38 +10744,36 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
10854
10744
  }
10855
10745
 
10856
10746
  /**
10857
- * Generated when a new Platform's API becomes responsive.
10858
- * @interface
10747
+ * @deprecated Renamed to {@link ApiReadyEvent}.
10859
10748
  */
10860
- declare type PlatformApiReadyEvent = BaseEvent & {
10861
- topic: 'application';
10862
- type: 'platform-api-ready';
10863
- };
10749
+ declare type PlatformApiReadyEvent = ApiReadyEvent;
10864
10750
 
10865
10751
  /**
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.
10752
+ * @deprecated Renamed to {@link Event}.
10869
10753
  */
10870
- declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
10754
+ declare type PlatformEvent = Event_10;
10871
10755
 
10872
10756
  declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
10873
10757
 
10874
10758
  declare namespace PlatformEvents {
10875
10759
  export {
10760
+ ApiReadyEvent,
10876
10761
  PlatformApiReadyEvent,
10762
+ SnapshotAppliedEvent,
10877
10763
  PlatformSnapshotAppliedEvent,
10764
+ Event_10 as Event,
10878
10765
  PlatformEvent,
10766
+ EventType_7 as EventType,
10879
10767
  PlatformEventType,
10880
- Payload_6 as Payload,
10881
- ByType_5 as ByType
10768
+ Payload_8 as Payload,
10769
+ ByType_7 as ByType
10882
10770
  }
10883
10771
  }
10884
10772
 
10885
10773
  /**
10886
- * Union of possible `type` values for a {@link PlatformEvent}.
10774
+ * @deprecated Renamed to {@link }.
10887
10775
  */
10888
- declare type PlatformEventType = PlatformEvent['type'];
10776
+ declare type PlatformEventType = EventType_7;
10889
10777
 
10890
10778
  /**
10891
10779
  * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
@@ -11145,7 +11033,17 @@ declare interface PlatformProvider {
11145
11033
  */
11146
11034
  getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
11147
11035
  /* Excluded from this release type: getInitialLayoutSnapshot */
11148
- /* Excluded from this release type: createViewsForLayout */
11036
+ /**
11037
+ * @experimental
11038
+ *
11039
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11040
+ * Gets the current state of a particular window and its views and returns an object that
11041
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11042
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11043
+ * @param identity
11044
+ * @param callerIdentity
11045
+ */
11046
+ getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
11149
11047
  /* Excluded from this release type: getViewSnapshot */
11150
11048
  /**
11151
11049
  * Called when a snapshot is being applied and some windows in that snapshot would be fully or partially off-screen.
@@ -11550,19 +11448,9 @@ declare interface PlatformProvider {
11550
11448
  }
11551
11449
 
11552
11450
  /**
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
11451
+ * @deprecated Renamed to {@link SnapshotAppliedEvent}.
11561
11452
  */
11562
- declare type PlatformSnapshotAppliedEvent = BaseEvent & {
11563
- topic: 'application';
11564
- type: 'platform-snapshot-applied';
11565
- };
11453
+ declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
11566
11454
 
11567
11455
  /**
11568
11456
  * @interface
@@ -11830,7 +11718,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
11830
11718
  * A general preload scripts state change event without event type.
11831
11719
  * @interface
11832
11720
  */
11833
- declare type PreloadScriptsStateChangeEvent = BaseWindowEvent & {
11721
+ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11834
11722
  preloadScripts: (PreloadScriptInfoRunning & any)[];
11835
11723
  };
11836
11724
 
@@ -12039,51 +11927,43 @@ declare type ProcessLoggingOptions = {
12039
11927
  };
12040
11928
 
12041
11929
  /**
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.
11930
+ * @deprecated Renamed to {@link PropagatedEvent}.
12047
11931
  */
12048
- declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
11932
+ declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
12049
11933
 
12050
11934
  /**
12051
- * Union of possible 'type' values for a {@link OpenFin.ApplicationEvents.PropagatedApplicationEvent}.
11935
+ * @deprecated Renamed to {@link PropagatedEventType}.
12052
11936
  */
12053
- declare type PropagatedApplicationEventType = PropagatedApplicationEvent<string>['type'];
11937
+ declare type PropagatedApplicationEventType = PropagatedEventType_3;
12054
11938
 
12055
11939
  /**
12056
- * Modifies an event shape to reflect propagation to a parent topic.
11940
+ * Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
11941
+ * these do not propagate.
11942
+ *
12057
11943
  * @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
11944
+ *
11945
+ * @typeParam SourceTopic The topic the event shape is propagating from.
11946
+ * @typeParam TargetTopic The topic the event shape is propagating to.
11947
+ * @typeParam Event The shape of the event being propagated.
12058
11948
  */
12059
11949
  declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
12060
11950
  type: string;
12061
11951
  }> = Event extends infer E extends {
12062
11952
  type: string;
12063
- } ? Omit<E, 'type' | 'topic'> & {
11953
+ } ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
12064
11954
  type: PropagatedEventType<SourceTopic, E['type']>;
12065
11955
  topic: TargetTopic;
12066
11956
  } : never;
12067
11957
 
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
11958
  /**
12074
11959
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
12075
11960
  * 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
11961
  * event type key with `'view-'`.
12077
11962
  */
12078
- declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
11963
+ declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12079
11964
  viewIdentity: OpenFin.Identity;
12080
11965
  };
12081
11966
 
12082
- /**
12083
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
12084
- */
12085
- declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
12086
-
12087
11967
  /**
12088
11968
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
12089
11969
  * prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
@@ -12092,12 +11972,51 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
12092
11972
  *
12093
11973
  * "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
12094
11974
  */
12095
- declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent<'window', TargetTopic, Exclude<WindowSourcedEvent, WindowCloseRequestedEvent>>;
11975
+ declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
11976
+
11977
+ /**
11978
+ * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
11979
+ * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
11980
+ * are propagated to `System` without any type string prefixing.
11981
+ *
11982
+ * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
11983
+ */
11984
+ declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
11985
+
11986
+ /**
11987
+ * Modifies an event type key to reflect propagation by prefixing with the topic.
11988
+ */
11989
+ declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
11990
+
11991
+ /**
11992
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
11993
+ */
11994
+ declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
11995
+
11996
+ /**
11997
+ * Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
11998
+ */
11999
+ declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
12000
+
12001
+ /**
12002
+ * @deprecated Renamed to {@link PropagatedEvent}.
12003
+ */
12004
+ declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
12005
+
12006
+ /**
12007
+ * @deprecated Renamed to {@link PropagatedEventType}.
12008
+ */
12009
+ declare type PropagatedViewEventType = PropagatedEventType_2;
12010
+
12011
+ /**
12012
+ * @deprecated Renamed to {@link PropagatedEvent}.
12013
+ */
12014
+ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
12096
12015
 
12097
12016
  /**
12098
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.PropagatedWindowEvent}.
12017
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
12099
12018
  */
12100
- declare type PropagatedWindowEventType = PropagatedWindowEvent<string>['type'];
12019
+ declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
12101
12020
 
12102
12021
  declare interface ProtocolMap extends ProtocolMapBase {
12103
12022
  'request-external-authorization': {
@@ -12515,7 +12434,7 @@ declare type RegistryInfo_2 = {
12515
12434
  * Generated when a window has been reloaded.
12516
12435
  * @interface
12517
12436
  */
12518
- declare type ReloadedEvent = BaseWindowEvent & {
12437
+ declare type ReloadedEvent = BaseEvent_5 & {
12519
12438
  type: 'reloaded';
12520
12439
  url: string;
12521
12440
  };
@@ -12552,7 +12471,7 @@ declare type ReplaceLayoutPayload = {
12552
12471
  /**
12553
12472
  * Identity of the window whose layout will be replaced.
12554
12473
  */
12555
- target: LayoutIdentity;
12474
+ target: Identity_5 | LayoutIdentity;
12556
12475
  };
12557
12476
 
12558
12477
  /**
@@ -12651,11 +12570,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
12651
12570
  * Generated when an application is responding.
12652
12571
  * @interface
12653
12572
  */
12654
- declare type RespondingEvent = IdentityEvent & {
12573
+ declare type RespondingEvent = BaseEvents.IdentityEvent & {
12655
12574
  topic: 'application';
12656
12575
  type: 'responding';
12657
12576
  };
12658
12577
 
12578
+ /**
12579
+ * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
12580
+ * @interface
12581
+ */
12582
+ declare type RestoredEvent = BaseEvent_5 & {
12583
+ type: 'restored';
12584
+ };
12585
+
12659
12586
  declare type ResultBehavior = 'close' | 'hide' | 'none';
12660
12587
 
12661
12588
  /**
@@ -12718,7 +12645,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12718
12645
  * Generated when Application.run() is called for an already running application.
12719
12646
  * @interface
12720
12647
  */
12721
- declare type RunRequestedEvent_2 = IdentityEvent & {
12648
+ declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12722
12649
  topic: 'application';
12723
12650
  type: 'run-requested';
12724
12651
  userAppConfigArgs: Record<string, any>;
@@ -12900,7 +12827,7 @@ declare type ServiceIdentifier = {
12900
12827
  * Generated on changes to a user’s local computer session.
12901
12828
  * @interface
12902
12829
  */
12903
- declare type SessionChangedEvent = BaseSystemEvent & {
12830
+ declare type SessionChangedEvent = BaseEvent_8 & {
12904
12831
  type: 'session-changed';
12905
12832
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
12906
12833
  };
@@ -13122,7 +13049,7 @@ declare type ShortcutOverride = Hotkey & {
13122
13049
  *
13123
13050
  * @interface
13124
13051
  */
13125
- declare type ShowAllDownloadsEvent = BaseWindowEvent & {
13052
+ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
13126
13053
  type: 'show-all-downloads';
13127
13054
  };
13128
13055
 
@@ -13130,7 +13057,15 @@ declare type ShowAllDownloadsEvent = BaseWindowEvent & {
13130
13057
  * Generated when a View is shown. This event will fire during creation of a View.
13131
13058
  * @interface
13132
13059
  */
13133
- declare type ShownEvent = BaseViewEvent & {
13060
+ declare type ShownEvent = BaseEvent_4 & {
13061
+ type: 'shown';
13062
+ };
13063
+
13064
+ /**
13065
+ * Generated when a hidden window has been shown.
13066
+ * @interface
13067
+ */
13068
+ declare type ShownEvent_2 = BaseEvent_5 & {
13134
13069
  type: 'shown';
13135
13070
  };
13136
13071
 
@@ -13159,6 +13094,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
13159
13094
  y?: number;
13160
13095
  };
13161
13096
 
13097
+ /**
13098
+ * Generated when a window has been prevented from showing.
13099
+ * @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.
13100
+ * @interface
13101
+ */
13102
+ declare type ShowRequestedEvent = BaseEvent_5 & {
13103
+ type: 'show-requested';
13104
+ };
13105
+
13162
13106
  /**
13163
13107
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
13164
13108
  *
@@ -13205,6 +13149,21 @@ declare type Snapshot = {
13205
13149
  };
13206
13150
  };
13207
13151
 
13152
+ /**
13153
+ * Generated when a platform.ApplySnapshot call is resolved.
13154
+ * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
13155
+ * 1. The window has been created
13156
+ * 2. The window has a responsive API
13157
+ * 3. If a window has a layout property, the 'layout-ready' event has fired
13158
+ *
13159
+ * _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.
13160
+ * @interface
13161
+ */
13162
+ declare type SnapshotAppliedEvent = BaseEvent & {
13163
+ topic: 'application';
13164
+ type: 'platform-snapshot-applied';
13165
+ };
13166
+
13208
13167
  /**
13209
13168
  * @interface
13210
13169
  */
@@ -13319,7 +13278,7 @@ declare class SnapshotSourceModule extends Base {
13319
13278
  * Generated when an application has started.
13320
13279
  * @interface
13321
13280
  */
13322
- declare type StartedEvent = IdentityEvent & {
13281
+ declare type StartedEvent = BaseEvents.IdentityEvent & {
13323
13282
  topic: 'application';
13324
13283
  type: 'started';
13325
13284
  };
@@ -13343,83 +13302,6 @@ declare type SubscriptionOptions = {
13343
13302
  declare class System extends EmitterBase<OpenFin.SystemEvent> {
13344
13303
  /* Excluded from this release type: __constructor */
13345
13304
  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
13305
  /**
13424
13306
  * Returns the version of the runtime. The version contains the major, minor,
13425
13307
  * build and revision numbers.
@@ -14852,12 +14734,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
14852
14734
  };
14853
14735
 
14854
14736
  /**
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).
14737
+ * @deprecated Renamed to {@link Event}.
14859
14738
  */
14860
- declare type SystemEvent = ExcludeRequested<PropagatedWindowEvent<'system'>> | PropagatedViewEvent<'system'> | PropagatedApplicationEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
14739
+ declare type SystemEvent = Event_11;
14861
14740
 
14862
14741
  declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
14863
14742
 
@@ -14865,8 +14744,10 @@ declare namespace SystemEvents {
14865
14744
  export {
14866
14745
  NotRequested,
14867
14746
  ExcludeRequested,
14868
- BaseSystemEvent,
14747
+ BaseEvent_8 as BaseEvent,
14748
+ IdleStateChangedEvent,
14869
14749
  IdleEvent,
14750
+ MonitorInfoChangedEvent,
14870
14751
  MonitorEvent,
14871
14752
  SessionChangedEvent,
14872
14753
  AppVersionEvent,
@@ -14880,17 +14761,19 @@ declare namespace SystemEvents {
14880
14761
  ApplicationCreatedEvent,
14881
14762
  DesktopIconClickedEvent,
14882
14763
  SystemShutdownEvent,
14764
+ Event_11 as Event,
14883
14765
  SystemEvent,
14766
+ EventType_8 as EventType,
14884
14767
  SystemEventType,
14885
- Payload_7 as Payload,
14886
- ByType_6 as ByType
14768
+ Payload_9 as Payload,
14769
+ ByType_8 as ByType
14887
14770
  }
14888
14771
  }
14889
14772
 
14890
14773
  /**
14891
- * Union of possible `type` values for a {@link SystemEvent}.
14774
+ * @deprecated Renamed to {@link EventType}.
14892
14775
  */
14893
- declare type SystemEventType = SystemEvent['type'];
14776
+ declare type SystemEventType = EventType_8;
14894
14777
 
14895
14778
  /**
14896
14779
  * @interface
@@ -15002,20 +14885,6 @@ declare interface TabDragListener extends EventEmitter_2 {
15002
14885
  contentItem: ContentItem;
15003
14886
  }
15004
14887
 
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
14888
  /**
15020
14889
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15021
14890
  */
@@ -15143,7 +15012,7 @@ declare type TargetApp = string | AppMetadata;
15143
15012
  * In that case, previousTarget identity will be the same as target identity.
15144
15013
  * @interface
15145
15014
  */
15146
- declare type TargetChangedEvent = BaseViewEvent & {
15015
+ declare type TargetChangedEvent = BaseEvent_4 & {
15147
15016
  type: 'target-changed';
15148
15017
  previousTarget: OpenFin.Identity;
15149
15018
  };
@@ -15297,7 +15166,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15297
15166
  * Generated when the tray icon is clicked.
15298
15167
  * @interface
15299
15168
  */
15300
- declare type TrayIconClickedEvent = IdentityEvent & {
15169
+ declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
15301
15170
  topic: 'application';
15302
15171
  type: 'tray-icon-clicked';
15303
15172
  button: 0 | 1 | 2;
@@ -15387,7 +15256,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15387
15256
  * A general user bounds change event without event type.
15388
15257
  * @interface
15389
15258
  */
15390
- declare type UserBoundsChangeEvent = BaseWindowEvent & {
15259
+ declare type UserBoundsChangeEvent = BaseEvent_5 & {
15391
15260
  height: number;
15392
15261
  left: number;
15393
15262
  top: number;
@@ -15399,7 +15268,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
15399
15268
  * Generated when a window's user movement becomes disabled.
15400
15269
  * @interface
15401
15270
  */
15402
- declare type UserMovementDisabledEvent = BaseWindowEvent & {
15271
+ declare type UserMovementDisabledEvent = BaseEvent_5 & {
15403
15272
  type: 'user-movement-disabled';
15404
15273
  };
15405
15274
 
@@ -15407,7 +15276,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
15407
15276
  * Generated when a window's user movement becomes enabled.
15408
15277
  * @interface
15409
15278
  */
15410
- declare type UserMovementEnabledEvent = BaseWindowEvent & {
15279
+ declare type UserMovementEnabledEvent = BaseEvent_5 & {
15411
15280
  type: 'user-movement-enabled';
15412
15281
  };
15413
15282
 
@@ -15460,169 +15329,6 @@ declare type VerboseWebPermission = {
15460
15329
 
15461
15330
  declare type View = OpenFin.View;
15462
15331
 
15463
- /**
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
15332
  /**
15627
15333
  * A View can be used to embed additional web content into a Window.
15628
15334
  * It is like a child window, except it is positioned relative to its owning window.
@@ -16057,7 +15763,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
16057
15763
  * Generated when a View is attached to a window.
16058
15764
  * @interface
16059
15765
  */
16060
- declare type ViewAttachedEvent = BaseWindowEvent & {
15766
+ declare type ViewAttachedEvent = BaseEvent_5 & {
16061
15767
  type: 'view-attached';
16062
15768
  target: OpenFin.Identity;
16063
15769
  viewIdentity: OpenFin.Identity;
@@ -16099,26 +15805,23 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
16099
15805
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
16100
15806
  * @interface
16101
15807
  */
16102
- declare type ViewDetachedEvent = BaseWindowEvent & {
15808
+ declare type ViewDetachedEvent = BaseEvent_5 & {
16103
15809
  type: 'view-detached';
16104
- target: OpenFin.Identity;
15810
+ target: OpenFin.Identity | null;
16105
15811
  previousTarget: OpenFin.Identity;
16106
15812
  viewIdentity: OpenFin.Identity;
16107
15813
  };
16108
15814
 
16109
15815
  /**
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}).
15816
+ * @deprecated Renamed to {@link Event}.
16113
15817
  */
16114
- declare type ViewEvent = (WebContentsEvent<'view'> & {
16115
- target: OpenFin.Identity;
16116
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
15818
+ declare type ViewEvent = Event_4;
16117
15819
 
16118
15820
  declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
16119
15821
 
16120
15822
  declare namespace ViewEvents {
16121
15823
  export {
15824
+ BaseEvent_4 as BaseEvent,
16122
15825
  BaseViewEvent,
16123
15826
  TargetChangedEvent,
16124
15827
  NonPropagatedViewEvent,
@@ -16128,20 +15831,24 @@ declare namespace ViewEvents {
16128
15831
  HotkeyEvent,
16129
15832
  ShownEvent,
16130
15833
  HostContextChangedEvent,
15834
+ Event_4 as Event,
16131
15835
  ViewEvent,
16132
15836
  WillPropagateViewEvent,
15837
+ EventType,
16133
15838
  ViewEventType,
15839
+ PropagatedEvent_2 as PropagatedEvent,
16134
15840
  PropagatedViewEvent,
15841
+ PropagatedEventType_2 as PropagatedEventType,
16135
15842
  PropagatedViewEventType,
16136
- Payload_8 as Payload,
16137
- ByType_7 as ByType
15843
+ Payload_2 as Payload,
15844
+ ByType
16138
15845
  }
16139
15846
  }
16140
15847
 
16141
15848
  /**
16142
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.ViewEvent}.
15849
+ * @deprecated Renamed to {@link EventType}.
16143
15850
  */
16144
- declare type ViewEventType = ViewEvent['type'];
15851
+ declare type ViewEventType = EventType;
16145
15852
 
16146
15853
  /**
16147
15854
  * @interface
@@ -17280,12 +16987,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17280
16987
  }
17281
16988
 
17282
16989
  /**
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}).
16990
+ * @deprecated Renamed to {@link Event}.
17285
16991
  */
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);
16992
+ declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
17289
16993
 
17290
16994
  declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
17291
16995
 
@@ -17297,6 +17001,7 @@ declare namespace WebContentsEvents {
17297
17001
  CrashedEvent_2 as CrashedEvent,
17298
17002
  CertificateErrorEvent,
17299
17003
  CertificateSelectionShownEvent,
17004
+ PageFaviconUpdatedEvent,
17300
17005
  FaviconUpdatedEvent,
17301
17006
  NavigationRejectedEvent,
17302
17007
  UrlChangedEvent,
@@ -17315,6 +17020,7 @@ declare namespace WebContentsEvents {
17315
17020
  FileDownloadStartedEvent,
17316
17021
  FileDownloadProgressEvent,
17317
17022
  FileDownloadCompletedEvent,
17023
+ Event_5 as Event,
17318
17024
  WebContentsEvent,
17319
17025
  WillPropagateWebContentsEvent,
17320
17026
  NonPropagatedWebContentsEvent
@@ -17337,7 +17043,7 @@ declare namespace WebContentsEvents {
17337
17043
  * `clipboard-read`: Request access to read from the clipboard.<br>
17338
17044
  * `clipboard-sanitized-write`: Request access to write to the clipboard.
17339
17045
  */
17340
- declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
17046
+ declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
17341
17047
 
17342
17048
  /**
17343
17049
  * Object representing headers and their values, where the
@@ -17362,7 +17068,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
17362
17068
  * A general will-move or will-resize event without event type.
17363
17069
  * @interface
17364
17070
  */
17365
- declare type WillMoveOrResizeEvent = BaseWindowEvent & {
17071
+ declare type WillMoveOrResizeEvent = BaseEvent_5 & {
17366
17072
  height: number;
17367
17073
  left: number;
17368
17074
  top: number;
@@ -17384,7 +17090,7 @@ declare type WillPropagateViewEvent = ViewEvent;
17384
17090
  *
17385
17091
  * A WebContents event that does propagate to (republish on) parent topics.
17386
17092
  */
17387
- declare type WillPropagateWebContentsEvent = WebContentsEvent<string>;
17093
+ declare type WillPropagateWebContentsEvent = Event_5<string>;
17388
17094
 
17389
17095
  /**
17390
17096
  * @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
@@ -17398,7 +17104,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
17398
17104
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
17399
17105
  * @interface
17400
17106
  */
17401
- declare type WillRedirectEvent = BaseWindowEvent & {
17107
+ declare type WillRedirectEvent = BaseEvent_5 & {
17402
17108
  type: 'will-redirect';
17403
17109
  blocked: boolean;
17404
17110
  isInPlace: boolean;
@@ -17415,476 +17121,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
17415
17121
  type: 'will-resize';
17416
17122
  };
17417
17123
 
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
17124
  /**
17889
17125
  * A basic window that wraps a native HTML window. Provides more fine-grained
17890
17126
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -18670,10 +17906,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18670
17906
  show(force?: boolean): Promise<void>;
18671
17907
  /**
18672
17908
  * 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
17909
+ *
17910
+ * @param left The left position of the window in pixels
17911
+ * @param top The top position of the window in pixels
18677
17912
  * @param force Show will be prevented from closing when force is false and
18678
17913
  * ‘show-requested’ has been subscribed to for application’s main window
18679
17914
  *
@@ -18735,28 +17970,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18735
17970
  * ```
18736
17971
  */
18737
17972
  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
17973
  /**
18761
17974
  * Shows a menu on the window.
18762
17975
  *
@@ -18853,602 +18066,552 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18853
18066
  */
18854
18067
  closePopupMenu(): Promise<void>;
18855
18068
  /**
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 { }
18069
+ * Dispatch a result to the caller of `showPopupWindow`.
18070
+ *
18071
+ * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18072
+ * @param data Serializable data to send to the caller window.
18073
+ *
18074
+ * @example
18075
+ * ```js
18076
+ * await fin.me.dispatchPopupResult({
18077
+ * foo: 'bar'
18078
+ * });
18079
+ * ```
18080
+ */
18081
+ dispatchPopupResult(data: any): Promise<void>;
18082
+ /**
18083
+ * Prints the contents of the window.
18084
+ *
18085
+ * @param options Configuration for the print task.
18086
+ * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18087
+ * and the default settings for printing.
18088
+ *
18089
+ * Use the CSS style `page-break-before: always;` to force print to a new page.
18090
+ *
18091
+ * @example
18092
+ * ```js
18093
+ * const win = fin.Window.getCurrentSync();
18094
+ *
18095
+ * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18096
+ * console.log('print call has been sent to the system');
18097
+ * });
18098
+ * ```
18099
+ *
18100
+ * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18101
+ * use the `content` option:
18102
+ *
18103
+ * ```js
18104
+ * const win = fin.Window.getCurrentSync();
18105
+ *
18106
+ * // Print embedded views
18107
+ * win.print({ content: 'views' });
18108
+ *
18109
+ * // Print screenshot of current window
18110
+ * win.print({ content: 'screenshot' })
18111
+ * ```
18112
+ *
18113
+ * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18114
+ * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18115
+ * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18116
+ * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18117
+ *
18118
+ * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18119
+ * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18120
+ *
18121
+ * To print the views embedded in their page context, set `content` to `screenshot`.
18122
+ */
18123
+ print(options?: OpenFin.WindowPrintOptions): Promise<void>;
18124
+ }
18125
+
18126
+ /**
18127
+ * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18128
+ * @interface
18129
+ */
18130
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
18131
+ type: 'window-alert-requested';
18132
+ };
18133
+
18134
+ /**
18135
+ * Returned from getBounds call. bottom and right are never used for setting.
18136
+ * @interface
18137
+ */
18138
+ declare type WindowBounds = Bounds & {
18139
+ bottom: number;
18140
+ right: number;
18141
+ };
18142
+
18143
+ /**
18144
+ * @deprecated Renamed to {@link ClosedEvent}.
18145
+ */
18146
+ declare type WindowClosedEvent = ClosedEvent_2;
18147
+
18148
+ /**
18149
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
18150
+ */
18151
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
18152
+
18153
+ /**
18154
+ * @deprecated Renamed to {@link ClosingEvent}.
18155
+ */
18156
+ declare type WindowClosingEvent = ClosingEvent;
18157
+
18158
+ /**
18159
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
18160
+ *
18161
+ * @interface
18162
+ */
18163
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
18164
+ /**
18165
+ * Behavior to use when opening matched content.
18166
+ */
18167
+ behavior: 'window';
18168
+ /**
18169
+ * Options for newly-created window.
18170
+ */
18171
+ options?: Partial<WindowOptions>;
18172
+ };
18173
+
18174
+ /**
18175
+ * Generated when a child window is created.
18176
+ * @interface
18177
+ */
18178
+ declare type WindowCreatedEvent = BaseEvent_3 & {
18179
+ type: 'window-created';
18180
+ };
18181
+
18182
+ /**
18183
+ * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
18184
+ *
18185
+ * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18186
+ * (defaults to `"about:blank"` when omitted).
18187
+ * @interface
18188
+ */
18189
+ declare type WindowCreationOptions = Partial<WindowOptions> & {
18190
+ name: string;
18191
+ };
18192
+
18193
+ declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
18194
+
18195
+ /**
18196
+ * @interface
18197
+ */
18198
+ declare type WindowDetail = {
18199
+ /**
18200
+ * The bottom-most coordinate of the window.
18201
+ */
18202
+ bottom: number;
18203
+ /**
18204
+ * The height of the window.
18205
+ */
18206
+ height: number;
18207
+ isShowing: boolean;
18208
+ /**
18209
+ * The left-most coordinate of the window.
18210
+ */
18211
+ left: number;
18212
+ /**
18213
+ * The name of the window.
18214
+ */
18215
+ name: string;
18216
+ /**
18217
+ * The right-most coordinate of the window.
18218
+ */
18219
+ right: number;
18220
+ state: string;
18221
+ /**
18222
+ * The top-most coordinate of the window.
18223
+ */
18224
+ top: number;
18225
+ /**
18226
+ * The width of the window.
18227
+ */
18228
+ width: number;
18229
+ };
18230
+
18231
+ /**
18232
+ * Generated when a child window ends loading.
18233
+ * @interface
18234
+ */
18235
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
18236
+ type: 'window-end-load';
18237
+ };
18238
+
18239
+ /**
18240
+ * @deprecated, Renamed to {@link Event}.
18241
+ */
18242
+ declare type WindowEvent = Event_6;
18243
+
18244
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18245
+
18246
+ declare namespace WindowEvents {
18247
+ export {
18248
+ BaseEvent_5 as BaseEvent,
18249
+ BaseWindowEvent,
18250
+ ViewAttachedEvent,
18251
+ ViewDetachedEvent,
18252
+ WindowViewEvent,
18253
+ AlertRequestedEvent,
18254
+ AuthRequestedEvent,
18255
+ EndLoadEvent,
18256
+ WillRedirectEvent,
18257
+ ReloadedEvent,
18258
+ OptionsChangedEvent,
18259
+ WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
18260
+ ExternalProcessExitedEvent,
18261
+ ExternalProcessStartedEvent,
18262
+ HiddenEvent_2 as HiddenEvent,
18263
+ WindowHiddenEvent,
18264
+ PreloadScriptInfoRunning,
18265
+ PreloadScriptInfo,
18266
+ PreloadScriptsStateChangeEvent,
18267
+ UserBoundsChangeEvent,
18268
+ BoundsChangeEvent,
18269
+ WillMoveOrResizeEvent,
18270
+ PerformanceReportEvent,
18271
+ InputEvent_2 as InputEvent,
18272
+ LayoutInitializedEvent,
18273
+ LayoutReadyEvent,
18274
+ BeginUserBoundsChangingEvent,
18275
+ BoundsChangedEvent,
18276
+ BoundsChangingEvent,
18277
+ CloseRequestedEvent,
18278
+ WindowCloseRequestedEvent,
18279
+ ContextChangedEvent,
18280
+ ClosedEvent_2 as ClosedEvent,
18281
+ WindowClosedEvent,
18282
+ ClosingEvent,
18283
+ WindowClosingEvent,
18284
+ DisabledMovementBoundsChangedEvent,
18285
+ DisabledMovementBoundsChangingEvent,
18286
+ EmbeddedEvent,
18287
+ EndUserBoundsChangingEvent,
18288
+ HotkeyEvent_2 as HotkeyEvent,
18289
+ WindowHotkeyEvent,
18290
+ InitializedEvent_2 as InitializedEvent,
18291
+ WindowInitializedEvent,
18292
+ MaximizedEvent,
18293
+ MinimizedEvent,
18294
+ PreloadScriptsStateChangedEvent,
18295
+ PreloadScriptsStateChangingEvent,
18296
+ RestoredEvent,
18297
+ WindowRestoredEvent,
18298
+ ShowRequestedEvent,
18299
+ WindowShowRequestedEvent,
18300
+ ShownEvent_2 as ShownEvent,
18301
+ WindowShownEvent,
18302
+ UserMovementEnabledEvent,
18303
+ UserMovementDisabledEvent,
18304
+ WillMoveEvent,
18305
+ WillResizeEvent,
18306
+ NonPropagatedWindowEvent,
18307
+ ShowAllDownloadsEvent,
18308
+ DownloadShelfVisibilityChangedEvent,
18309
+ WindowSourcedEvent,
18310
+ WillPropagateWindowEvent,
18311
+ Event_6 as Event,
18312
+ WindowEvent,
18313
+ EventType_2 as EventType,
18314
+ WindowEventType,
18315
+ PropagatedEvent_3 as PropagatedEvent,
18316
+ PropagatedWindowEvent,
18317
+ PropagatedWindowEventType,
18318
+ Payload_3 as Payload,
18319
+ ByType_2 as ByType
18320
+ }
18321
+ }
18322
+
18323
+ /**
18324
+ * @deprecated Renamed to {@link EventType}.
18325
+ */
18326
+ declare type WindowEventType = WindowEvent['type'];
18327
+
18328
+ /**
18329
+ * @deprecated Renamed to {@link HiddenEvent}.
18330
+ */
18331
+ declare type WindowHiddenEvent = HiddenEvent_2;
18332
+
18333
+ /**
18334
+ * @deprecated Renamed to {@link HotkeyEvent}.
18335
+ */
18336
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
18337
+
18338
+ /**
18339
+ * @interface
18340
+ */
18341
+ declare type WindowInfo = {
18342
+ canNavigateBack: boolean;
18343
+ canNavigateForward: boolean;
18344
+ preloadScripts: Array<any>;
18345
+ title: string;
18346
+ url: string;
18347
+ };
18348
+
18349
+ /**
18350
+ * @deprecated Renamed to {@link InitializedEvent}.
18351
+ */
18352
+ declare type WindowInitializedEvent = InitializedEvent_2;
18353
+
18354
+ /**
18355
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
18356
+ */
18357
+ declare class _WindowModule extends Base {
18358
+ /**
18359
+ * Asynchronously returns a Window object that represents an existing window.
18360
+ *
18361
+ * @example
18362
+ * ```js
18363
+ * async function createWin() {
18364
+ * const app = await fin.Application.start({
18365
+ * name: 'myApp',
18366
+ * uuid: 'app-1',
18367
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
18368
+ * autoShow: true
18369
+ * });
18370
+ * return await app.getWindow();
18371
+ * }
18372
+ * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
18373
+ * .then(win => console.log('wrapped window'))
18374
+ * .catch(err => console.log(err));
18375
+ * ```
18376
+ */
18377
+ wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18378
+ /**
18379
+ * Synchronously returns a Window object that represents an existing window.
18380
+ *
18381
+ * @example
18382
+ * ```js
18383
+ * async function createWin() {
18384
+ * const app = await fin.Application.start({
18385
+ * name: 'myApp',
18386
+ * uuid: 'app-1',
18387
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
18388
+ * autoShow: true
18389
+ * });
18390
+ * return await app.getWindow();
18391
+ * }
18392
+ * await createWin();
18393
+ * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
18394
+ * ```
18395
+ */
18396
+ wrapSync(identity: OpenFin.Identity): OpenFin.Window;
18397
+ /**
18398
+ * Creates a new Window.
18399
+ * @param options - Window creation options
18400
+ *
18401
+ * @example
18402
+ * ```js
18403
+ * async function createWindow() {
18404
+ * const winOption = {
18405
+ * name:'child',
18406
+ * defaultWidth: 300,
18407
+ * defaultHeight: 300,
18408
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
18409
+ * frame: true,
18410
+ * autoShow: true
18411
+ * };
18412
+ * return await fin.Window.create(winOption);
18413
+ * }
18414
+ *
18415
+ * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
18416
+ * ```
18417
+ */
18418
+ create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
18419
+ /**
18420
+ * Asynchronously returns a Window object that represents the current window
18421
+ *
18422
+ * @example
18423
+ * ```js
18424
+ * fin.Window.getCurrent()
18425
+ * .then(wnd => console.log('current window'))
18426
+ * .catch(err => console.log(err));
18427
+ *
18428
+ * ```
18429
+ */
18430
+ getCurrent(): Promise<OpenFin.Window>;
18431
+ /**
18432
+ * Synchronously returns a Window object that represents the current window
18433
+ *
18434
+ * @example
18435
+ * ```js
18436
+ * const wnd = fin.Window.getCurrentSync();
18437
+ * const info = await wnd.getInfo();
18438
+ * console.log(info);
18439
+ *
18440
+ * ```
18441
+ */
18442
+ getCurrentSync(): OpenFin.Window;
18443
+ }
18444
+
18445
+ /**
18446
+ * Generated when a child window is not responding.
18447
+ * @interface
18448
+ */
18449
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
18450
+ type: 'window-not-responding';
18451
+ };
18452
+
18453
+ /**
18454
+ * @interface
18455
+ */
18456
+ declare type WindowOptionDiff = {
18457
+ [key in keyof WindowOptions]: {
18458
+ oldVal: WindowOptions[key];
18459
+ newVal: WindowOptions[key];
18460
+ };
18461
+ };
18462
+
18463
+ /**
18464
+ * @interface
18465
+ */
18466
+ declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
18467
+
18468
+ declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
18469
+
18470
+ /**
18471
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
18472
+ */
18473
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
18474
+
18475
+ declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
18476
+
18477
+ /**
18478
+ * Generated when a child window is responding.
18479
+ * @interface
18480
+ */
18481
+ declare type WindowRespondingEvent = BaseEvent_3 & {
18482
+ type: 'window-responding';
18483
+ };
18484
+
18485
+ /**
18486
+ * @deprecated Renamed to {@link RestoredEvent}.
18487
+ */
18488
+ declare type WindowRestoredEvent = RestoredEvent;
18489
+
18490
+ /**
18491
+ * @deprecated Renamed to {@link ShownEvent}.
18492
+ */
18493
+ declare type WindowShownEvent = ShownEvent_2;
18494
+
18495
+ /**
18496
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
18497
+ */
18498
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18499
+
18500
+ /**
18501
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18502
+ * from {@link OpenFin.ViewEvents}.
18503
+ */
18504
+ 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;
18505
+
18506
+ /**
18507
+ * Generated when a child window starts loading.
18508
+ * @interface
18509
+ */
18510
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
18511
+ type: 'window-start-load';
18512
+ };
18513
+
18514
+ /**
18515
+ * Visibility state of a window.
18516
+ */
18517
+ declare type WindowState = 'maximized' | 'minimized' | 'normal';
18518
+
18519
+ /**
18520
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
18521
+ * to the `Application` level, with the name pattern `window-view-eventname`.
18522
+ */
18523
+ declare type WindowViewEvent = {
18524
+ viewIdentity: OpenFin.Identity;
18525
+ } & (ViewAttachedEvent | ViewDetachedEvent);
18526
+
18527
+ /**
18528
+ * @interface
18529
+ */
18530
+ declare type WindowViewsPrintOptions = {
18531
+ content: 'views';
18532
+ includeSelf?: boolean;
18533
+ };
18534
+
18535
+ declare type Wire = EventEmitter & {
18536
+ connect(messageReciever: MessageReceiver): Promise<any>;
18537
+ connectSync(): any;
18538
+ send(data: any): Promise<any>;
18539
+ shutdown(): Promise<void>;
18540
+ getPort(): string;
18541
+ };
18542
+
18543
+ declare type WireConstructor = {
18544
+ new (onmessage: (data: any) => void): Wire;
18545
+ };
18546
+
18547
+ /* Excluded from this release type: WithId */
18548
+
18549
+ declare interface WithInterop {
18550
+ interop: InteropClient;
18551
+ }
18552
+
18553
+ /* Excluded from this release type: WithoutId */
18554
+
18555
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
18556
+ positioningOptions?: OpenFin.PositioningOptions;
18557
+ };
18558
+
18559
+ /* Excluded from this release type: WorkspacePlatformOptions */
18560
+
18561
+ /**
18562
+ * A generic request to write any supported data to the clipboard.
18563
+ * @interface
18564
+ */
18565
+ declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
18566
+ /**
18567
+ * Data to be written
18568
+ */
18569
+ data: {
18570
+ text?: string;
18571
+ html?: string;
18572
+ rtf?: string;
18573
+ } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
18574
+ };
18575
+
18576
+ /**
18577
+ * @deprecated - instead use WriteAnyClipboardRequest
18578
+ *
18579
+ * A generic request to write any supported data to the clipboard.
18580
+ *
18581
+ * @interface
18582
+ */
18583
+ declare type WriteAnyRequestType = WriteAnyClipboardRequest;
18584
+
18585
+ /**
18586
+ * A request to write data to the clipboard.
18587
+ * @interface
18588
+ */
18589
+ declare type WriteClipboardRequest = BaseClipboardRequest & {
18590
+ /**
18591
+ * Data to write to the clipboard.
18592
+ */
18593
+ data: string;
18594
+ };
18595
+
18596
+ /**
18597
+ * @interface
18598
+ */
18599
+ declare type WriteImageClipboardRequest = BaseClipboardRequest & {
18600
+ /**
18601
+ * Can be either a base64 string, or a DataURL string. If using DataURL, the
18602
+ * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
18603
+ * Using other image/<format> DataURLs will throw an Error.
18604
+ */
18605
+ image: string;
18606
+ };
18607
+
18608
+ /**
18609
+ * @deprecated - instead use OpenFin.WriteClipboardRequest
18610
+ *
18611
+ * A request to write data to the clipboard.
18612
+ *
18613
+ * @interface
18614
+ */
18615
+ declare type WriteRequestType = WriteClipboardRequest;
18616
+
18617
+ export { }