@openfin/core 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_2.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_2.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_2.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_2.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_2.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_2.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_2.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
  */
@@ -3407,6 +3349,39 @@ declare type ConfigWithUuid = BaseConfig & {
3407
3349
  uuid: string;
3408
3350
  };
3409
3351
 
3352
+ /**
3353
+ * Generated when a Channel client is connected.
3354
+ * @interface
3355
+ */
3356
+ declare type ConnectedEvent = BaseEvent_2 & {
3357
+ type: 'connected';
3358
+ };
3359
+
3360
+ /**
3361
+ * Generated when an application has authenticated and is connected.
3362
+ * @interface
3363
+ */
3364
+ declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
3365
+ topic: 'application';
3366
+ type: 'connected';
3367
+ };
3368
+
3369
+ /**
3370
+ * Generated when an external application has authenticated and is connected.
3371
+ * @interface
3372
+ */
3373
+ declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
3374
+ type: 'connected';
3375
+ };
3376
+
3377
+ /**
3378
+ * Generated when a frame is connected.
3379
+ * @interface
3380
+ */
3381
+ declare type ConnectedEvent_4 = BaseFrameEvent & {
3382
+ type: 'connected';
3383
+ };
3384
+
3410
3385
  declare type Constructor<T = {}> = new () => T;
3411
3386
 
3412
3387
  declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
@@ -3417,6 +3392,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
3417
3392
  * @interface
3418
3393
  */
3419
3394
  declare type ConstViewOptions = {
3395
+ /**
3396
+ * Configurations for API injection.
3397
+ */
3398
+ api: Api;
3420
3399
  /**
3421
3400
  * The name of the view.
3422
3401
  */
@@ -3565,7 +3544,7 @@ declare type ConstWindowOptions = {
3565
3544
  /**
3566
3545
  * @defaultValue true
3567
3546
  *
3568
- * Toggling off would keep the Window alive even if all its Views were closed.
3547
+ * Setting this to false would keep the Window alive even if all its Views were closed.
3569
3548
  * This is meant for advanced users and should be used with caution.
3570
3549
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3571
3550
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
@@ -3575,7 +3554,8 @@ declare type ConstWindowOptions = {
3575
3554
  /**
3576
3555
  * @defaultValue 'all'
3577
3556
  *
3578
- * 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'.
3557
+ * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3558
+ + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3579
3559
  * **NOTE:** - This option is ignored in non-Platforms apps.
3580
3560
  */
3581
3561
  viewsPreventingClose: 'all' | 'layout';
@@ -4148,7 +4128,7 @@ declare type Context_3 = {
4148
4128
  * Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
4149
4129
  * @interface
4150
4130
  */
4151
- declare type ContextChangedEvent = BaseWindowEvent & {
4131
+ declare type ContextChangedEvent = BaseEvent_5 & {
4152
4132
  type: 'context-changed';
4153
4133
  context: any;
4154
4134
  };
@@ -4300,7 +4280,7 @@ declare type CpuInfo = {
4300
4280
  * Generated when an application has crashed.
4301
4281
  * @interface
4302
4282
  */
4303
- declare type CrashedEvent = IdentityEvent & {
4283
+ declare type CrashedEvent = BaseEvents.IdentityEvent & {
4304
4284
  topic: 'application';
4305
4285
  type: 'crashed';
4306
4286
  reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
@@ -4351,7 +4331,7 @@ declare type CrashReporterState = CrashReporterOptions & {
4351
4331
  * Generated when a View is created.
4352
4332
  * @interface
4353
4333
  */
4354
- declare type CreatedEvent = BaseViewEvent & {
4334
+ declare type CreatedEvent = BaseEvent_4 & {
4355
4335
  type: 'created';
4356
4336
  };
4357
4337
 
@@ -4382,7 +4362,7 @@ declare type CreateViewPayload = {
4382
4362
  /**
4383
4363
  * @interface
4384
4364
  */
4385
- declare type CreateViewTarget = LayoutIdentity & {
4365
+ declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
4386
4366
  /**
4387
4367
  * If specified, view creation will not attach to a window and caller must
4388
4368
  * insert the view into the layout explicitly
@@ -4510,7 +4490,7 @@ declare interface DesktopAgent_2 {
4510
4490
  * Generated when the desktop icon is clicked while it's already running.
4511
4491
  * @interface
4512
4492
  */
4513
- declare type DesktopIconClickedEvent = BaseSystemEvent & {
4493
+ declare type DesktopIconClickedEvent = BaseEvent_8 & {
4514
4494
  type: 'desktop-icon-clicked';
4515
4495
  };
4516
4496
 
@@ -4518,10 +4498,18 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
4518
4498
  * Generated when a View is destroyed.
4519
4499
  * @interface
4520
4500
  */
4521
- declare type DestroyedEvent = BaseViewEvent & {
4501
+ declare type DestroyedEvent = BaseEvent_4 & {
4522
4502
  type: 'destroyed';
4523
4503
  };
4524
4504
 
4505
+ /**
4506
+ * @interface
4507
+ */
4508
+ declare type DeviceInfo = {
4509
+ vendorId: string | number;
4510
+ productId: string | number;
4511
+ };
4512
+
4525
4513
  /**
4526
4514
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
4527
4515
  * @interface
@@ -4618,6 +4606,30 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
4618
4606
  type: 'disabled-movement-bounds-changing';
4619
4607
  };
4620
4608
 
4609
+ /**
4610
+ * Generated when a Channel client has disconnected.
4611
+ * @interface
4612
+ */
4613
+ declare type DisconnectedEvent = BaseEvent_2 & {
4614
+ type: 'disconnected';
4615
+ };
4616
+
4617
+ /**
4618
+ * Generated when an external application has disconnected.
4619
+ * @interface
4620
+ */
4621
+ declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
4622
+ type: 'disconnected';
4623
+ };
4624
+
4625
+ /**
4626
+ * Generated when a frame has disconnected.
4627
+ * @interface
4628
+ */
4629
+ declare type DisconnectedEvent_3 = BaseFrameEvent & {
4630
+ type: 'disconnected';
4631
+ };
4632
+
4621
4633
  /**
4622
4634
  * A system channel will be global enough to have a presence across many apps. This gives us some hints
4623
4635
  * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
@@ -4739,7 +4751,7 @@ declare type DownloadShelfOptions = {
4739
4751
  */
4740
4752
  size?: number;
4741
4753
  /**
4742
- * Color of the border, either a string name or a hex code. Defaults to chromium theme
4754
+ * Color of the border. Must be a 6-character hex code prefixed by #. Defaults to chromium theme
4743
4755
  * if absent.
4744
4756
  */
4745
4757
  color?: string;
@@ -4751,7 +4763,7 @@ declare type DownloadShelfOptions = {
4751
4763
  *
4752
4764
  * @interface
4753
4765
  */
4754
- declare type DownloadShelfVisibilityChangedEvent = BaseWindowEvent & {
4766
+ declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
4755
4767
  type: 'download-shelf-visibility-changed';
4756
4768
  /**
4757
4769
  * True if the download shelf was just opened; false if it was just closed.
@@ -4781,7 +4793,7 @@ declare interface DragSource {}
4781
4793
  * Generated when a window has been embedded.
4782
4794
  * @interface
4783
4795
  */
4784
- declare type EmbeddedEvent = BaseWindowEvent & {
4796
+ declare type EmbeddedEvent = BaseEvent_5 & {
4785
4797
  type: 'embedded';
4786
4798
  };
4787
4799
 
@@ -4880,7 +4892,7 @@ declare class EmitterMap {
4880
4892
  * Generated when a window ends loading.
4881
4893
  * @interface
4882
4894
  */
4883
- declare type EndLoadEvent = BaseWindowEvent & {
4895
+ declare type EndLoadEvent = BaseEvent_5 & {
4884
4896
  type: 'end-load';
4885
4897
  documentName: string;
4886
4898
  isMain: boolean;
@@ -4958,9 +4970,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
4958
4970
  } : never;
4959
4971
 
4960
4972
  declare interface Environment {
4961
- initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
4973
+ initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
4962
4974
  createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
4963
4975
  destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
4976
+ resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
4964
4977
  initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
4965
4978
  observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
4966
4979
  writeToken(path: string, token: string): Promise<string>;
@@ -4997,15 +5010,97 @@ declare type ErrorPlainObject = {
4997
5010
  toString(): string;
4998
5011
  };
4999
5012
 
5000
- declare class EventAggregator extends EmitterMap {
5001
- dispatchEvent: (message: Message<any>) => boolean;
5002
- }
5013
+ /**
5014
+ * [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
5015
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5016
+ * under the {@link OpenFin.PlatformEvents} namespace.
5017
+ */
5018
+ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5003
5019
 
5004
- declare interface EventEmitter_2 {
5005
- [x: string]: any;
5006
- /**
5007
- * Subscribe to an event
5008
- * @param eventName The name of the event to describe to
5020
+ /**
5021
+ * [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
5022
+ * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5023
+ * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5024
+ * from which they propagate).
5025
+ */
5026
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
5027
+
5028
+ /**
5029
+ * [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
5030
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5031
+ * under the {@link OpenFin.ChannelEvents} namespace.
5032
+ */
5033
+ declare type Event_2 = {
5034
+ topic: 'channel';
5035
+ } & (ConnectedEvent | DisconnectedEvent);
5036
+
5037
+ /**
5038
+ * [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
5039
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5040
+ * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5041
+ * from which they propagate).
5042
+ */
5043
+ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
5044
+
5045
+ /**
5046
+ * [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
5047
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5048
+ * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5049
+ */
5050
+ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5051
+ target: OpenFin_2.Identity;
5052
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
5053
+
5054
+ /**
5055
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
5056
+ * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
5057
+ */
5058
+ declare type Event_5<Topic extends string> = {
5059
+ topic: Topic;
5060
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
5061
+
5062
+ /**
5063
+ * [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
5064
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5065
+ * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5066
+ */
5067
+ declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5068
+
5069
+ /**
5070
+ * [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
5071
+ * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5072
+ * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5073
+ */
5074
+ declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5075
+
5076
+ /**
5077
+ * [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
5078
+ * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5079
+ * under the {@link OpenFin.FrameEvents} namespace.
5080
+ */
5081
+ declare type Event_8 = {
5082
+ topic: 'frame';
5083
+ } & (ConnectedEvent_4 | DisconnectedEvent_3);
5084
+
5085
+ /**
5086
+ * [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
5087
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5088
+ * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5089
+ */
5090
+ declare type Event_9 = {
5091
+ topic: 'global-hotkey';
5092
+ hotkey: 'string';
5093
+ } & (RegisteredEvent | UnregisteredEvent);
5094
+
5095
+ declare class EventAggregator extends EmitterMap {
5096
+ dispatchEvent: (message: Message<any>) => boolean;
5097
+ }
5098
+
5099
+ declare interface EventEmitter_2 {
5100
+ [x: string]: any;
5101
+ /**
5102
+ * Subscribe to an event
5103
+ * @param eventName The name of the event to describe to
5009
5104
  * @param callback The function that should be invoked when the event occurs
5010
5105
  * @param context The value of the this pointer in the callback function
5011
5106
  */
@@ -5062,6 +5157,46 @@ declare namespace Events {
5062
5157
  }
5063
5158
  }
5064
5159
 
5160
+ /**
5161
+ * Union of possible `type` values for a view {@link Event}.
5162
+ */
5163
+ declare type EventType = Event_4['type'];
5164
+
5165
+ /**
5166
+ * Union of possible `type` values for a Window {@link Event}.
5167
+ */
5168
+ declare type EventType_2 = Event_6['type'];
5169
+
5170
+ /**
5171
+ * Union of possible `type` values for an Application {@link Event}.
5172
+ */
5173
+ declare type EventType_3 = Event_3['type'];
5174
+
5175
+ /**
5176
+ * Union of possible `type` values for an ExternalApplication {@link Event}.
5177
+ */
5178
+ declare type EventType_4 = Event_7['type'];
5179
+
5180
+ /**
5181
+ * Union of possible `type` values for a {@link FrameEvent}.
5182
+ */
5183
+ declare type EventType_5 = Event_8['type'];
5184
+
5185
+ /**
5186
+ * Union of possible `type` values for a {@link GlobalHotkeyEvent}
5187
+ */
5188
+ declare type EventType_6 = Event_9['type'];
5189
+
5190
+ /**
5191
+ * Union of possible `type` values for a {@link PlatformEvent}.
5192
+ */
5193
+ declare type EventType_7 = Event_10['type'];
5194
+
5195
+ /**
5196
+ * Union of possible `type` values for a {@link SystemEvent}.
5197
+ */
5198
+ declare type EventType_8 = Event_11['type'];
5199
+
5065
5200
  /* Excluded from this release type: EventWithId */
5066
5201
 
5067
5202
  /* Excluded from this release type: ExcludeRequested */
@@ -5092,83 +5227,6 @@ declare type ExitCode = {
5092
5227
  declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicationEvent> {
5093
5228
  identity: OpenFin_2.ApplicationIdentity;
5094
5229
  /* Excluded from this release type: __constructor */
5095
- /**
5096
- * Adds a listener to the end of the listeners array for the specified event.
5097
- * @param eventType - The type of the event.
5098
- * @param listener - Called whenever an event of the specified type occurs.
5099
- * @param options - Option to support event timestamps.
5100
- *
5101
- * @function addListener
5102
- * @memberof ExternalApplication
5103
- * @instance
5104
- * @tutorial ExternalApplication.EventEmitter
5105
- */
5106
- /**
5107
- * Adds a listener to the end of the listeners array for the specified event.
5108
- * @param eventType - The type of the event.
5109
- * @param listener - Called whenever an event of the specified type occurs.
5110
- * @param options - Option to support event timestamps.
5111
- *
5112
- * @function on
5113
- * @memberof ExternalApplication
5114
- * @instance
5115
- * @tutorial ExternalApplication.EventEmitter
5116
- */
5117
- /**
5118
- * 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.
5119
- * @param eventType - The type of the event.
5120
- * @param listener - The callback function.
5121
- * @param options - Option to support event timestamps.
5122
- *
5123
- * @function once
5124
- * @memberof ExternalApplication
5125
- * @instance
5126
- * @tutorial ExternalApplication.EventEmitter
5127
- */
5128
- /**
5129
- * Adds a listener to the beginning of the listeners array for the specified event.
5130
- * @param eventType - The type of the event.
5131
- * @param listener - The callback function.
5132
- * @param options - Option to support event timestamps.
5133
- *
5134
- * @function prependListener
5135
- * @memberof ExternalApplication
5136
- * @instance
5137
- * @tutorial ExternalApplication.EventEmitter
5138
- */
5139
- /**
5140
- * 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.
5141
- * The listener is added to the beginning of the listeners array.
5142
- * @param eventType - The type of the event.
5143
- * @param listener - The callback function.
5144
- * @param options - Option to support event timestamps.
5145
- *
5146
- * @function prependOnceListener
5147
- * @memberof ExternalApplication
5148
- * @instance
5149
- * @tutorial ExternalApplication.EventEmitter
5150
- */
5151
- /**
5152
- * Remove a listener from the listener array for the specified event.
5153
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5154
- * @param eventType - The type of the event.
5155
- * @param listener - The callback function.
5156
- * @param options - Option to support event timestamps.
5157
- *
5158
- * @function removeListener
5159
- * @memberof ExternalApplication
5160
- * @instance
5161
- * @tutorial ExternalApplication.EventEmitter
5162
- */
5163
- /**
5164
- * Removes all listeners, or those of the specified event.
5165
- * @param eventType - The type of the event.
5166
- *
5167
- * @function removeAllListeners
5168
- * @memberof ExternalApplication
5169
- * @instance
5170
- * @tutorial ExternalApplication.EventEmitter
5171
- */
5172
5230
  /**
5173
5231
  * Retrieves information about the external application.
5174
5232
  *
@@ -5185,46 +5243,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
5185
5243
  }
5186
5244
 
5187
5245
  /**
5188
- * Generated when an external application has authenticated and is connected.
5189
- * @interface
5246
+ * @deprecated Renamed to {@link ConnectedEvent}.
5190
5247
  */
5191
- declare type ExternalApplicationConnectedEvent = BaseExternalApplicationEvent & {
5192
- type: 'connected';
5193
- };
5248
+ declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
5194
5249
 
5195
5250
  /**
5196
- * Generated when an external application has disconnected.
5197
- * @interface
5251
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5198
5252
  */
5199
- declare type ExternalApplicationDisconnectedEvent = BaseExternalApplicationEvent & {
5200
- type: 'disconnected';
5201
- };
5253
+ declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
5202
5254
 
5203
5255
  /**
5204
- * [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
5205
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5206
- * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5256
+ * @deprecated Renamed to {@link Event}.
5207
5257
  */
5208
- declare type ExternalApplicationEvent = ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent;
5258
+ declare type ExternalApplicationEvent = Event_7;
5209
5259
 
5210
5260
  declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
5211
5261
 
5212
5262
  declare namespace ExternalApplicationEvents {
5213
5263
  export {
5264
+ BaseEvent_6 as BaseEvent,
5214
5265
  BaseExternalApplicationEvent,
5266
+ ConnectedEvent_3 as ConnectedEvent,
5215
5267
  ExternalApplicationConnectedEvent,
5268
+ DisconnectedEvent_2 as DisconnectedEvent,
5216
5269
  ExternalApplicationDisconnectedEvent,
5270
+ Event_7 as Event,
5217
5271
  ExternalApplicationEvent,
5272
+ EventType_4 as EventType,
5218
5273
  ExternalApplicationEventType,
5219
- Payload_3 as Payload,
5220
- ByType_2 as ByType
5274
+ Payload_5 as Payload,
5275
+ ByType_4 as ByType
5221
5276
  }
5222
5277
  }
5223
5278
 
5224
5279
  /**
5225
- * Union of possible `type` values for a {@link ApplicationEvent}.
5280
+ * @deprecated Renamed to {@link Event}.
5226
5281
  */
5227
- declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
5282
+ declare type ExternalApplicationEventType = EventType_4;
5228
5283
 
5229
5284
  /**
5230
5285
  * @interface
@@ -5285,7 +5340,7 @@ declare type ExternalConnection = {
5285
5340
  * Generated when an external process has exited.
5286
5341
  * @interface
5287
5342
  */
5288
- declare type ExternalProcessExitedEvent = BaseWindowEvent & {
5343
+ declare type ExternalProcessExitedEvent = BaseEvent_5 & {
5289
5344
  type: 'external-process-exited';
5290
5345
  processUuid: string;
5291
5346
  exitCode: number;
@@ -5330,19 +5385,15 @@ declare type ExternalProcessRequestType = {
5330
5385
  * Generated when an external process has started.
5331
5386
  * @interface
5332
5387
  */
5333
- declare type ExternalProcessStartedEvent = BaseWindowEvent & {
5388
+ declare type ExternalProcessStartedEvent = BaseEvent_5 & {
5334
5389
  type: 'external-process-started';
5335
5390
  processUuid: string;
5336
5391
  };
5337
5392
 
5338
5393
  /**
5339
- * Generated when page receives favicon urls.
5340
- * @interface
5394
+ * @deprecated, use {@link PageFaviconUpdatedEvent}.
5341
5395
  */
5342
- declare type FaviconUpdatedEvent = NamedEvent & {
5343
- type: 'page-favicon-updated';
5344
- favicons: string[];
5345
- };
5396
+ declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
5346
5397
 
5347
5398
  declare namespace FDC3 {
5348
5399
  export {
@@ -5429,7 +5480,7 @@ declare type FileDownloadEvent = {
5429
5480
  *
5430
5481
  * @interface
5431
5482
  */
5432
- declare type FileDownloadLocationChangedEvent = BaseApplicationEvent & {
5483
+ declare type FileDownloadLocationChangedEvent = BaseEvent_3 & {
5433
5484
  type: 'file-download-location-changed';
5434
5485
  };
5435
5486
 
@@ -5591,83 +5642,6 @@ declare type FoundInPageEvent = NamedEvent & {
5591
5642
  declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5592
5643
  identity: OpenFin_2.Identity;
5593
5644
  /* Excluded from this release type: __constructor */
5594
- /**
5595
- * Adds the listener function to the end of the listeners array for the specified event type.
5596
- * @param eventType - The type of the event.
5597
- * @param listener - Called whenever an event of the specified type occurs.
5598
- * @param options - Option to support event timestamps.
5599
- *
5600
- * @function addListener
5601
- * @memberof Frame
5602
- * @instance
5603
- * @tutorial Frame.EventEmitter
5604
- */
5605
- /**
5606
- * Adds a listener to the end of the listeners array for the specified event.
5607
- * @param eventType - The type of the event.
5608
- * @param listener - Called whenever an event of the specified type occurs.
5609
- * @param options - Option to support event timestamps.
5610
- *
5611
- * @function on
5612
- * @memberof Frame
5613
- * @instance
5614
- * @tutorial Frame.EventEmitter
5615
- */
5616
- /**
5617
- * 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.
5618
- * @param eventType - The type of the event.
5619
- * @param listener - The callback function.
5620
- * @param options - Option to support event timestamps.
5621
- *
5622
- * @function once
5623
- * @memberof Frame
5624
- * @instance
5625
- * @tutorial Frame.EventEmitter
5626
- */
5627
- /**
5628
- * Adds a listener to the beginning of the listeners array for the specified event.
5629
- * @param eventType - The type of the event.
5630
- * @param listener - The callback function.
5631
- * @param options - Option to support event timestamps.
5632
- *
5633
- * @function prependListener
5634
- * @memberof Frame
5635
- * @instance
5636
- * @tutorial Frame.EventEmitter
5637
- */
5638
- /**
5639
- * 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.
5640
- * The listener is added to the beginning of the listeners array.
5641
- * @param eventType - The type of the event.
5642
- * @param listener - The callback function.
5643
- * @param options - Option to support event timestamps.
5644
- *
5645
- * @function prependOnceListener
5646
- * @memberof Frame
5647
- * @instance
5648
- * @tutorial Frame.EventEmitter
5649
- */
5650
- /**
5651
- * Remove a listener from the listener array for the specified event.
5652
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5653
- * @param eventType - The type of the event.
5654
- * @param listener - The callback function.
5655
- * @param options - Option to support event timestamps.
5656
- *
5657
- * @function removeListener
5658
- * @memberof Frame
5659
- * @instance
5660
- * @tutorial Frame.EventEmitter
5661
- */
5662
- /**
5663
- * Removes all listeners, or those of the specified event.
5664
- * @param eventType - The type of the event.
5665
- *
5666
- * @function removeAllListeners
5667
- * @memberof Frame
5668
- * @instance
5669
- * @tutorial Frame.EventEmitter
5670
- */
5671
5645
  /**
5672
5646
  * Returns a frame info object for the represented frame.
5673
5647
  *
@@ -5698,48 +5672,43 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5698
5672
  }
5699
5673
 
5700
5674
  /**
5701
- * Generated when a frame is connected.
5702
- * @interface
5675
+ * @deprecated Renamed to {@link ConnectedEvent}.
5703
5676
  */
5704
- declare type FrameConnectedEvent = BaseFrameEvent & {
5705
- type: 'connected';
5706
- };
5677
+ declare type FrameConnectedEvent = ConnectedEvent_4;
5707
5678
 
5708
5679
  /**
5709
- * Generated when a frame has disconnected.
5710
- * @interface
5680
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5711
5681
  */
5712
- declare type FrameDisconnectedEvent = BaseFrameEvent & {
5713
- type: 'disconnected';
5714
- };
5682
+ declare type FrameDisconnectedEvent = DisconnectedEvent_3;
5715
5683
 
5716
5684
  /**
5717
- * [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
5718
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5719
- * under the {@link OpenFin.FrameEvents} namespace.
5685
+ * @deprecated Renamed to {@link Event}.
5720
5686
  */
5721
- declare type FrameEvent = {
5722
- topic: 'frame';
5723
- } & (FrameConnectedEvent | FrameDisconnectedEvent);
5687
+ declare type FrameEvent = Event_8;
5724
5688
 
5725
5689
  declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
5726
5690
 
5727
5691
  declare namespace FrameEvents {
5728
5692
  export {
5693
+ BaseEvent_7 as BaseEvent,
5729
5694
  BaseFrameEvent,
5695
+ ConnectedEvent_4 as ConnectedEvent,
5730
5696
  FrameConnectedEvent,
5697
+ DisconnectedEvent_3 as DisconnectedEvent,
5731
5698
  FrameDisconnectedEvent,
5699
+ Event_8 as Event,
5732
5700
  FrameEvent,
5701
+ EventType_5 as EventType,
5733
5702
  FrameEventType,
5734
- Payload_4 as Payload,
5735
- ByType_3 as ByType
5703
+ Payload_6 as Payload,
5704
+ ByType_5 as ByType
5736
5705
  }
5737
5706
  }
5738
5707
 
5739
5708
  /**
5740
- * Union of possible `type` values for a {@link FrameEvent}.
5709
+ * @deprecated Renamed to {@link EventType}.
5741
5710
  */
5742
- declare type FrameEventType = FrameEvent['type'];
5711
+ declare type FrameEventType = EventType_5;
5743
5712
 
5744
5713
  /**
5745
5714
  * @interface
@@ -5958,14 +5927,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
5958
5927
  }
5959
5928
 
5960
5929
  /**
5961
- * [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
5962
- * discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5963
- * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5930
+ * @deprecated Renamed to {@link Event}.
5964
5931
  */
5965
- declare type GlobalHotkeyEvent = {
5966
- topic: 'global-hotkey';
5967
- hotkey: 'string';
5968
- } & (RegisteredEvent | UnregisteredEvent);
5932
+ declare type GlobalHotkeyEvent = Event_9;
5969
5933
 
5970
5934
  declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
5971
5935
 
@@ -5973,17 +5937,19 @@ declare namespace GlobalHotkeyEvents {
5973
5937
  export {
5974
5938
  RegisteredEvent,
5975
5939
  UnregisteredEvent,
5940
+ Event_9 as Event,
5976
5941
  GlobalHotkeyEvent,
5942
+ EventType_6 as EventType,
5977
5943
  GlobalHotkeyEventType,
5978
- Payload_5 as Payload,
5979
- ByType_4 as ByType
5944
+ Payload_7 as Payload,
5945
+ ByType_6 as ByType
5980
5946
  }
5981
5947
  }
5982
5948
 
5983
5949
  /**
5984
- * Union of possible `type` values for a {@link GlobalHotkeyEvent}
5950
+ * @deprecated Renamed to {@link EventType}.
5985
5951
  */
5986
- declare type GlobalHotkeyEventType = GlobalHotkeyEvent['type'];
5952
+ declare type GlobalHotkeyEventType = EventType_6;
5987
5953
 
5988
5954
  declare namespace GoldenLayout {
5989
5955
  export {
@@ -6285,8 +6251,17 @@ declare interface Header {
6285
6251
  * Generated when a View is hidden.
6286
6252
  * @interface
6287
6253
  */
6288
- declare type HiddenEvent = BaseViewEvent & {
6254
+ declare type HiddenEvent = BaseEvent_4 & {
6255
+ type: 'hidden';
6256
+ };
6257
+
6258
+ /**
6259
+ * Generated when a window has been hidden.
6260
+ * @interface
6261
+ */
6262
+ declare type HiddenEvent_2 = BaseEvent_5 & {
6289
6263
  type: 'hidden';
6264
+ reason: 'closing' | 'hide' | 'hide-on-close';
6290
6265
  };
6291
6266
 
6292
6267
  /**
@@ -6294,7 +6269,7 @@ declare type HiddenEvent = BaseViewEvent & {
6294
6269
  * or because the View has moved to a new window. Only available on Views in a Platform.
6295
6270
  * @interface
6296
6271
  */
6297
- declare type HostContextChangedEvent = BaseViewEvent & {
6272
+ declare type HostContextChangedEvent = BaseEvent_4 & {
6298
6273
  type: 'host-context-changed';
6299
6274
  context: any;
6300
6275
  reason: 'reparented' | 'updated';
@@ -6373,7 +6348,16 @@ declare type Hotkey = {
6373
6348
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6374
6349
  * @interface
6375
6350
  */
6376
- declare type HotkeyEvent = BaseViewEvent & {
6351
+ declare type HotkeyEvent = BaseEvent_4 & {
6352
+ type: 'hotkey';
6353
+ };
6354
+
6355
+ /**
6356
+ * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
6357
+ * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6358
+ * @interface
6359
+ */
6360
+ declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
6377
6361
  type: 'hotkey';
6378
6362
  };
6379
6363
 
@@ -6426,6 +6410,11 @@ declare type IdentityEvent = BaseEvent & {
6426
6410
 
6427
6411
  /* Excluded from this release type: IdEventType */
6428
6412
 
6413
+ /**
6414
+ * @deprecated Renamed to {@link IdleStateChangedEvent}.
6415
+ */
6416
+ declare type IdleEvent = IdleStateChangedEvent;
6417
+
6429
6418
  /**
6430
6419
  * Generated when a user enters or returns from idle state.
6431
6420
  * @remarks This method is continuously generated every minute while the user is in idle.
@@ -6433,7 +6422,7 @@ declare type IdentityEvent = BaseEvent & {
6433
6422
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6434
6423
  * @interface
6435
6424
  */
6436
- declare type IdleEvent = BaseSystemEvent & {
6425
+ declare type IdleStateChangedEvent = BaseEvent_8 & {
6437
6426
  type: 'idle-state-changed';
6438
6427
  elapsedTime: number;
6439
6428
  isIdle: boolean;
@@ -6518,11 +6507,19 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6518
6507
  * Generated when an application has initialized.
6519
6508
  * @interface
6520
6509
  */
6521
- declare type InitializedEvent = IdentityEvent & {
6510
+ declare type InitializedEvent = BaseEvents.IdentityEvent & {
6522
6511
  topic: 'application';
6523
6512
  type: 'initialized';
6524
6513
  };
6525
6514
 
6515
+ /**
6516
+ * Generated when a window is initialized.
6517
+ * @interface
6518
+ */
6519
+ declare type InitializedEvent_2 = BaseEvent_5 & {
6520
+ type: 'initialized';
6521
+ };
6522
+
6526
6523
  /**
6527
6524
  * @interface
6528
6525
  */
@@ -6907,56 +6904,6 @@ declare class InteropBroker extends Base {
6907
6904
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
6908
6905
  new (): InteropBroker;
6909
6906
  };
6910
- /**
6911
- * @REMOVED
6912
- * SetContextOptions interface
6913
- * @typedef { object } SetContextOptions@typedef { object } SetContextOptions
6914
- * @property { Context } {context} - New context to set.
6915
- */
6916
- /**
6917
- * @REMOVED
6918
- * GetContextOptions interface
6919
- * @typedef { object } GetContextOptions@typedef { object } GetContextOptions
6920
- * @property { string } [contextType] - Context Type
6921
- */
6922
- /**
6923
- * @REMOVED
6924
- * JoinContextGroupOptions interface
6925
- * @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
6926
- * @property { string } contextGroupId - Id of the context group.
6927
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
6928
- */
6929
- /**
6930
- * @REMOVED
6931
- * AddClientToContextGroupOptions interface
6932
- * @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
6933
- * @property { string } contextGroupId - Name of the context group.
6934
- */
6935
- /**
6936
- * @REMOVED
6937
- * RemoveFromContextGroupOptions interface
6938
- * @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
6939
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
6940
- */
6941
- /**
6942
- * @REMOVED
6943
- * GetInfoForContextGroupOptions interface
6944
- * @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
6945
- * @property { string } contextGroupId - Name of the context group to get info for.
6946
- */
6947
- /**
6948
- * @REMOVED
6949
- * GetAllClientsInContextGroupOptions interface
6950
- * @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
6951
- * @property { string } contextGroupId - Name of the context group to get info for.
6952
- */
6953
- /**
6954
- * @PORTED
6955
- * InfoForIntentOptions interface
6956
- * @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
6957
- * @property { string } name Name of the intent to get info for.
6958
- * @property { Context } [context] Optional context.
6959
- */
6960
6907
  /**
6961
6908
  * Sets a context for the context group of the incoming current entity.
6962
6909
  * @param setContextOptions - New context to set.
@@ -7200,7 +7147,7 @@ declare class InteropBroker extends Base {
7200
7147
  * // }
7201
7148
  * ```
7202
7149
  *
7203
- * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
7150
+ * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
7204
7151
  *
7205
7152
  * @param contextForIntent Data passed between entities and applications.
7206
7153
  * @param clientIdentity Identity of the Client making the request.
@@ -7457,96 +7404,7 @@ declare type InteropBrokerOptions = {
7457
7404
  };
7458
7405
 
7459
7406
  /**
7460
- * @PORTED
7461
- * @typedef { object } Intent
7462
- * @summary The combination of an action and a context that is passed to an application for resolution.
7463
- * @property { string } name Name of the intent.
7464
- * @property { Context } context Data associated with the intent
7465
- */
7466
- /**
7467
- * @REMOVED
7468
- * @typedef { object } Subscription
7469
- * @summary Object returned when subscribing a handler.
7470
- * @property { function } unsubscribe Function to unsubscribe the handler.
7471
- */
7472
- /**
7473
- * @typedef { function } ContextHandler
7474
- * @summary Subscription function for addContextHandler.
7475
- */
7476
- /**
7477
- * @typedef { function } IntentHandler
7478
- * @summary Subscription function for registerIntentHandler
7479
- */
7480
- /**
7481
- * @PORTED
7482
- * @typedef { object } ClientIdentity
7483
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
7484
- * @property {string} uuid GUID of an application.
7485
- * @property {string} name Name of an entity in an application.
7486
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
7487
- */
7488
- /**
7489
- * @PORTED
7490
- * @typedef { object } ContextGroupInfo
7491
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
7492
- * @property {string} id Name of the context group
7493
- * @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.
7494
- */
7495
- /**
7496
- * @PORTED
7497
- * @typedef { object } DisplayMetadata
7498
- * @summary The display data for a Context Group.
7499
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
7500
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
7501
- * @property {string} [glyph] A URL of an image that can be used to display this context group
7502
- */
7503
- /**
7504
- * @PORTED
7505
- * @typedef { object } Context
7506
- * @summary Data passed between entities and applications.
7507
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7508
- * @property {string} [name] User-readable name for the incoming context.
7509
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7510
- */
7511
- /**
7512
- * @REMOVED
7513
- * @typedef { object } ContextForIntent
7514
- * @summary Data passed between entities and applications, including an optional metadata.
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
- * @property {any} [metadata]
7519
- */
7520
- /**
7521
- * @REMOVED
7522
- * @typedef { object } SessionContextGroup
7523
- * @summary An instance of a SessionContextGroup
7524
- * @property {string} id The SessionContextGroup's id.
7525
- * @property {setContext} setContext Sets a context of a certain type
7526
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
7527
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
7528
- */
7529
- /**
7530
- * @typedef {function} setContext
7531
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
7532
- * @param context The Context to be set.
7533
- *
7534
- */
7535
- /**
7536
- * @typedef {function} getCurrentContext
7537
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
7538
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
7539
- *
7540
- */
7541
- /**
7542
- * @typedef {function} addContextHandler
7543
- * @summary A SessionContextGroup instance method for adding a handler for context change.
7544
- * @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.
7545
- * @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.
7546
- *
7547
- */
7548
- /**
7549
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
7407
+ * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
7550
7408
  *
7551
7409
  * The Interop Client API is broken up into two groups:
7552
7410
  *
@@ -7980,13 +7838,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
7980
7838
  */
7981
7839
  declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
7982
7840
 
7983
- /**
7984
- * @PORTED
7985
- * @typedef { object } InteropConfig
7986
- * @summary Information relevant to the Interop Broker.
7987
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
7988
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
7989
- */
7990
7841
  /**
7991
7842
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
7992
7843
  *
@@ -8374,7 +8225,7 @@ declare type LaunchIntoPlatformPayload = {
8374
8225
  declare class Layout extends Base {
8375
8226
  #private;
8376
8227
  /* Excluded from this release type: init */
8377
- identity: OpenFin_2.LayoutIdentity;
8228
+ identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
8378
8229
  private platform;
8379
8230
  wire: Transport;
8380
8231
  /* Excluded from this release type: __constructor */
@@ -8590,25 +8441,24 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
8590
8441
  */
8591
8442
  declare type LayoutIdentity = Identity_5 & {
8592
8443
  /**
8593
- * The name of the layout an action should be targeted to. When not provided,
8594
- * OpenFin attempts to resolve the instance via visibility checks.
8444
+ * The name of the layout in a given window.
8595
8445
  */
8596
- layoutName?: string;
8446
+ layoutName: string;
8597
8447
  };
8598
8448
 
8599
8449
  /**
8600
- * Generated when a window and all of its layout's views have either finished or failed navigation.
8450
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8451
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8601
8452
  * @interface
8602
8453
  */
8603
- declare type LayoutInitializedEvent = BaseWindowEvent & {
8454
+ declare type LayoutInitializedEvent = BaseEvent_5 & {
8604
8455
  type: 'layout-initialized';
8456
+ layoutIdentity: OpenFin_2.LayoutIdentity;
8605
8457
  ofViews: (OpenFin_2.Identity & {
8606
8458
  entityType: 'view';
8607
8459
  })[];
8608
8460
  };
8609
8461
 
8610
- /* Excluded from this release type: LayoutInstance */
8611
-
8612
8462
  /**
8613
8463
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
8614
8464
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
@@ -8636,7 +8486,7 @@ declare type LayoutItemConfig = {
8636
8486
  *
8637
8487
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
8638
8488
  *
8639
- * Responsible for aggergating all layout snapshots and storing LayoutInstances
8489
+ * Responsible for aggregating all layout snapshots and storing layout instances
8640
8490
  */
8641
8491
  declare interface LayoutManager<T extends LayoutSnapshot> {
8642
8492
  /**
@@ -8660,16 +8510,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
8660
8510
  * @throws if Object.keys(snapshot).length > 1
8661
8511
  */
8662
8512
  applyLayoutSnapshot(snapshot: T): Promise<void>;
8663
- /**
8664
- * Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
8665
- * contains a single layout.
8666
- *
8667
- * Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
8668
- * fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
8669
- *
8670
- * @param snapshot
8671
- * @throws if Object.keys(snapshot).length > 1
8672
- */
8673
8513
  /**
8674
8514
  * @experimental
8675
8515
  *
@@ -8690,31 +8530,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
8690
8530
  /**
8691
8531
  * @experimental
8692
8532
  *
8693
- * @param layoutIdentity
8694
- * @returns
8533
+ * A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
8534
+ * this method to control the target layout for Layout API calls.
8535
+ *
8536
+ * Example use case: You have hidden all the layouts and are showing a dialog that will
8537
+ * execute an API call (ex: Layout.replace()) - override this method and save the
8538
+ * "last visible" layout identity and return it.
8539
+ *
8540
+ * By default, OpenFin will use a series of checks to determine which Layout the API
8541
+ * call must route to in this order of precedence:
8542
+ * - try to resolve the layout from the layoutIdentity, throws if missing
8543
+ * - if there is only 1 layout, resolves that one
8544
+ * - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
8545
+ * - returns undefined
8546
+ *
8547
+ * @param identity
8548
+ * @returns LayoutIdentity | undefined
8695
8549
  */
8696
- resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
8550
+ resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
8697
8551
  /**
8698
8552
  * @experimental
8699
8553
  *
8700
- * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
8701
- * Throws if it does not exist.
8702
- * @param layoutName
8703
- * @returns
8554
+ * A hook provided to the consumer when it's time to remove a layout. Use this hook to
8555
+ * update your local state and remove the layout for the given LayoutIdentity. Note that
8556
+ * this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
8557
+ * signify to your application it's time to destroy this layout.
8558
+ *
8559
+ * 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.
8560
+ *
8561
+ * @param LayoutIdentity
8704
8562
  */
8705
- getLayoutByName(layoutName: string): LayoutInstance;
8563
+ removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
8706
8564
  /**
8707
8565
  * @experimental
8708
8566
  */
8709
- getLayouts(): Record<string, LayoutInstance>;
8567
+ getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
8710
8568
  /**
8711
8569
  * @experimental
8712
8570
  */
8713
- getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
8571
+ isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8714
8572
  /**
8715
8573
  * @experimental
8716
8574
  */
8717
- isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8575
+ size(): number;
8718
8576
  }
8719
8577
 
8720
8578
  /**
@@ -8761,7 +8619,7 @@ declare class LayoutModule extends Base {
8761
8619
  * const layoutConfig = await layout.getConfig();
8762
8620
  * ```
8763
8621
  */
8764
- wrap(identity: OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
8622
+ wrap(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
8765
8623
  /**
8766
8624
  * Synchronously returns a Layout object that represents a Window's layout.
8767
8625
  *
@@ -8781,7 +8639,7 @@ declare class LayoutModule extends Base {
8781
8639
  * const layoutConfig = await layout.getConfig();
8782
8640
  * ```
8783
8641
  */
8784
- wrapSync(identity: OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
8642
+ wrapSync(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
8785
8643
  /**
8786
8644
  * Asynchronously returns a Layout object that represents a Window's layout.
8787
8645
  *
@@ -8878,7 +8736,7 @@ declare type LayoutOptions = {
8878
8736
  * @defaultValue false
8879
8737
  *
8880
8738
  * Limits the area to which tabs can be dragged.
8881
- * If true, stack headers are the only areas where tabs can be dropped.
8739
+ * If true, the layout container is the only area where tabs can be dropped.
8882
8740
  */
8883
8741
  constrainDragToContainer?: boolean;
8884
8742
  /**
@@ -8949,6 +8807,9 @@ declare type LayoutOptions = {
8949
8807
  };
8950
8808
  };
8951
8809
 
8810
+ /**
8811
+ * Represents the position of an item in a layout relative to another.
8812
+ */
8952
8813
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
8953
8814
 
8954
8815
  /**
@@ -8957,11 +8818,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
8957
8818
  declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
8958
8819
 
8959
8820
  /**
8960
- * Generated when a window and all of its layout's views have been created and can receive API calls.
8821
+ * Generated when the layout and all of the its views have been created and can receive API calls.
8961
8822
  * @interface
8962
8823
  */
8963
- declare type LayoutReadyEvent = BaseWindowEvent & {
8824
+ declare type LayoutReadyEvent = BaseEvent_5 & {
8964
8825
  type: 'layout-ready';
8826
+ layoutIdentity: OpenFin_2.LayoutIdentity;
8965
8827
  views: (OpenFin_2.Identity & {
8966
8828
  success: boolean;
8967
8829
  })[];
@@ -9101,7 +8963,7 @@ declare type Manifest = {
9101
8963
  * Generated when the RVM notifies an application that the manifest has changed.
9102
8964
  * @interface
9103
8965
  */
9104
- declare type ManifestChangedEvent = IdentityEvent & {
8966
+ declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
9105
8967
  topic: 'application';
9106
8968
  type: 'manifest-changed';
9107
8969
  };
@@ -9154,7 +9016,7 @@ declare type MatchPattern = string;
9154
9016
  * Generated when a window is maximized.
9155
9017
  * @interface
9156
9018
  */
9157
- declare type MaximizedEvent = BaseWindowEvent & {
9019
+ declare type MaximizedEvent = BaseEvent_5 & {
9158
9020
  type: 'maximized';
9159
9021
  };
9160
9022
 
@@ -9264,7 +9126,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
9264
9126
  * Generated when a window is minimized.
9265
9127
  * @interface
9266
9128
  */
9267
- declare type MinimizedEvent = BaseWindowEvent & {
9129
+ declare type MinimizedEvent = BaseEvent_5 & {
9268
9130
  type: 'minimized';
9269
9131
  };
9270
9132
 
@@ -9308,14 +9170,9 @@ declare type MonitorDetails = {
9308
9170
  };
9309
9171
 
9310
9172
  /**
9311
- * Generated on changes of a monitor's size/location.
9312
- * @remarks A monitor's size changes when the taskbar is resized or relocated.
9313
- * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9314
- * @interface
9173
+ * @deprecated Renamed to {@link MonitorInfoChangedEvent}.
9315
9174
  */
9316
- declare type MonitorEvent = BaseSystemEvent & OpenFin_2.MonitorInfo & {
9317
- type: 'monitor-info-changed';
9318
- };
9175
+ declare type MonitorEvent = MonitorInfoChangedEvent;
9319
9176
 
9320
9177
  /**
9321
9178
  * @interface
@@ -9339,6 +9196,16 @@ declare type MonitorInfo = {
9339
9196
  virtualScreen: DipRect;
9340
9197
  };
9341
9198
 
9199
+ /**
9200
+ * Generated on changes of a monitor's size/location.
9201
+ * @remarks A monitor's size changes when the taskbar is resized or relocated.
9202
+ * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9203
+ * @interface
9204
+ */
9205
+ declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
9206
+ type: 'monitor-info-changed';
9207
+ };
9208
+
9342
9209
  /**
9343
9210
  * @interface
9344
9211
  */
@@ -9661,7 +9528,7 @@ declare type MutableWindowOptions = {
9661
9528
  showTaskbarIcon: boolean;
9662
9529
  interop: InteropConfig;
9663
9530
  /* Excluded from this release type: _internalWorkspaceData */
9664
- workspacePlatform: WorkspacePlatformOptions;
9531
+ workspacePlatform: unknown;
9665
9532
  };
9666
9533
 
9667
9534
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -9735,13 +9602,15 @@ declare type NonPropagatedWebContentsEvent = never;
9735
9602
  */
9736
9603
  declare type NonPropagatedWindowEvent = never;
9737
9604
 
9605
+ /* Excluded from this release type: NotCloseRequested */
9606
+
9738
9607
  /* Excluded from this release type: NotRequested */
9739
9608
 
9740
9609
  /**
9741
9610
  * Generated when an application is not responding.
9742
9611
  * @interface
9743
9612
  */
9744
- declare type NotRespondingEvent = IdentityEvent & {
9613
+ declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
9745
9614
  topic: 'application';
9746
9615
  type: 'not-responding';
9747
9616
  };
@@ -9892,6 +9761,7 @@ declare namespace OpenFin_2 {
9892
9761
  WebPermission,
9893
9762
  VerboseWebPermission,
9894
9763
  OpenExternalPermission,
9764
+ DeviceInfo,
9895
9765
  Permissions_2 as Permissions,
9896
9766
  PlatformWindowCreationOptions,
9897
9767
  PlatformWindowOptions,
@@ -10049,7 +9919,6 @@ declare namespace OpenFin_2 {
10049
9919
  InitLayoutOptions,
10050
9920
  LayoutManagerConstructor,
10051
9921
  LayoutManagerOverride,
10052
- LayoutInstance,
10053
9922
  LayoutManager,
10054
9923
  CreateLayoutOptions,
10055
9924
  PresetLayoutOptions_2 as PresetLayoutOptions,
@@ -10067,7 +9936,7 @@ declare namespace OpenFin_2 {
10067
9936
  AppVersionCompleteEvent,
10068
9937
  AppVersionRuntimeStatusEvent,
10069
9938
  Events,
10070
- BaseEvent_2 as BaseEvent,
9939
+ BaseEvent_9 as BaseEvent,
10071
9940
  WebContentsEvent_2 as WebContentsEvent,
10072
9941
  SystemEvent_2 as SystemEvent,
10073
9942
  ApplicationEvent_2 as ApplicationEvent,
@@ -10109,12 +9978,32 @@ export default OpenFin_2;
10109
9978
 
10110
9979
  declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
10111
9980
 
9981
+ /**
9982
+ * Generated after window options are changed using the window.updateOptions method.
9983
+ * @remarks Will not fire if the diff object is empty.
9984
+ * @interface
9985
+ */
9986
+ declare type OptionsChangedEvent = BaseEvent_5 & {
9987
+ type: 'options-changed';
9988
+ options: OpenFin_2.WindowOptions;
9989
+ diff: OpenFin_2.WindowOptionDiff;
9990
+ };
9991
+
10112
9992
  declare type OverlapsOnlyIfMatching<T, U> = {
10113
9993
  [K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
10114
9994
  };
10115
9995
 
10116
9996
  declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
10117
9997
 
9998
+ /**
9999
+ * Generated when page receives favicon urls.
10000
+ * @interface
10001
+ */
10002
+ declare type PageFaviconUpdatedEvent = NamedEvent & {
10003
+ type: 'page-favicon-updated';
10004
+ favicons: string[];
10005
+ };
10006
+
10118
10007
  /**
10119
10008
  * Generated when page title is set during navigation.
10120
10009
  * @remarks explicitSet is false when title is synthesized from file url.
@@ -10133,74 +10022,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10133
10022
  };
10134
10023
 
10135
10024
  /**
10136
- * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
10025
+ * Extracts a single event type matching the given key from the View {@link Event} union.
10137
10026
  *
10138
10027
  * @typeParam Type String key specifying the event to extract
10139
10028
  */
10140
- declare type Payload_2<Type extends ApplicationEventType> = Extract<ApplicationEvent, {
10029
+ declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10141
10030
  type: Type;
10142
10031
  }>;
10143
10032
 
10144
10033
  /**
10145
- * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
10034
+ * Extracts a single event type matching the given key from the Window {@link Event} union.
10146
10035
  *
10147
10036
  * @typeParam Type String key specifying the event to extract
10148
10037
  */
10149
- declare type Payload_3<Type extends ExternalApplicationEventType> = Extract<ExternalApplicationEvent, {
10038
+ declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10150
10039
  type: Type;
10151
10040
  }>;
10152
10041
 
10153
10042
  /**
10154
- * Extracts a single event type matching the given key from the {@link FrameEvent} union.
10043
+ * Extracts a single event type matching the given key from the Application {@link Event} union.
10155
10044
  *
10156
10045
  * @typeParam Type String key specifying the event to extract
10157
10046
  */
10158
- declare type Payload_4<Type extends FrameEventType> = Extract<FrameEvent, {
10047
+ declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10159
10048
  type: Type;
10160
10049
  }>;
10161
10050
 
10162
10051
  /**
10163
- * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
10052
+ * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
10164
10053
  *
10165
10054
  * @typeParam Type String key specifying the event to extract
10166
10055
  */
10167
- declare type Payload_5<Type extends GlobalHotkeyEventType> = Extract<GlobalHotkeyEvent, {
10056
+ declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10168
10057
  type: Type;
10169
10058
  }>;
10170
10059
 
10171
10060
  /**
10172
- * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
10061
+ * Extracts a single event type matching the given key from the Frame {@link Event} union.
10173
10062
  *
10174
10063
  * @typeParam Type String key specifying the event to extract
10175
10064
  */
10176
- declare type Payload_6<Type extends PlatformEventType> = Extract<PlatformEvent, {
10065
+ declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10177
10066
  type: Type;
10178
10067
  }>;
10179
10068
 
10180
10069
  /**
10181
- * Extracts a single event type matching the given key from the {@link SystemEvent} union.
10070
+ * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
10182
10071
  *
10183
10072
  * @typeParam Type String key specifying the event to extract
10184
10073
  */
10185
- declare type Payload_7<Type extends SystemEventType> = Extract<SystemEvent, {
10074
+ declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10186
10075
  type: Type;
10187
10076
  }>;
10188
10077
 
10189
10078
  /**
10190
- * Extracts a single event type matching the given key from the {@link ViewEvent} union.
10079
+ * Extracts a single event type matching the given key from the Platform {@link Event} union.
10191
10080
  *
10192
10081
  * @typeParam Type String key specifying the event to extract
10193
10082
  */
10194
- declare type Payload_8<Type extends ViewEventType> = Extract<ViewEvent, {
10083
+ declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10195
10084
  type: Type;
10196
10085
  }>;
10197
10086
 
10198
10087
  /**
10199
- * Extracts a single event type matching the given key from the {@link WindowEvent} union.
10088
+ * Extracts a single event type matching the given key from the System {@link Event} union.
10200
10089
  *
10201
10090
  * @typeParam Type String key specifying the event to extract
10202
10091
  */
10203
- declare type Payload_9<Type extends WindowEventType> = Extract<WindowEvent, {
10092
+ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10204
10093
  type: Type;
10205
10094
  }>;
10206
10095
 
@@ -10210,7 +10099,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
10210
10099
  * Generated when window finishes loading. Provides performance and navigation data.
10211
10100
  * @interface
10212
10101
  */
10213
- declare type PerformanceReportEvent = Performance & BaseWindowEvent & {
10102
+ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
10214
10103
  type: 'performance-report';
10215
10104
  };
10216
10105
 
@@ -10221,6 +10110,7 @@ declare type Permissions_2 = {
10221
10110
  Application?: Partial<ApplicationPermissions>;
10222
10111
  System?: Partial<SystemPermissions>;
10223
10112
  webAPIs?: WebPermission[];
10113
+ devices?: DeviceInfo[];
10224
10114
  };
10225
10115
 
10226
10116
  declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -10844,38 +10734,36 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
10844
10734
  }
10845
10735
 
10846
10736
  /**
10847
- * Generated when a new Platform's API becomes responsive.
10848
- * @interface
10737
+ * @deprecated Renamed to {@link ApiReadyEvent}.
10849
10738
  */
10850
- declare type PlatformApiReadyEvent = BaseEvent & {
10851
- topic: 'application';
10852
- type: 'platform-api-ready';
10853
- };
10739
+ declare type PlatformApiReadyEvent = ApiReadyEvent;
10854
10740
 
10855
10741
  /**
10856
- * [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
10857
- * discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
10858
- * under the {@link OpenFin.PlatformEvents} namespace.
10742
+ * @deprecated Renamed to {@link Event}.
10859
10743
  */
10860
- declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
10744
+ declare type PlatformEvent = Event_10;
10861
10745
 
10862
10746
  declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
10863
10747
 
10864
10748
  declare namespace PlatformEvents {
10865
10749
  export {
10750
+ ApiReadyEvent,
10866
10751
  PlatformApiReadyEvent,
10752
+ SnapshotAppliedEvent,
10867
10753
  PlatformSnapshotAppliedEvent,
10754
+ Event_10 as Event,
10868
10755
  PlatformEvent,
10756
+ EventType_7 as EventType,
10869
10757
  PlatformEventType,
10870
- Payload_6 as Payload,
10871
- ByType_5 as ByType
10758
+ Payload_8 as Payload,
10759
+ ByType_7 as ByType
10872
10760
  }
10873
10761
  }
10874
10762
 
10875
10763
  /**
10876
- * Union of possible `type` values for a {@link PlatformEvent}.
10764
+ * @deprecated Renamed to {@link }.
10877
10765
  */
10878
- declare type PlatformEventType = PlatformEvent['type'];
10766
+ declare type PlatformEventType = EventType_7;
10879
10767
 
10880
10768
  /**
10881
10769
  * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
@@ -11135,7 +11023,17 @@ declare interface PlatformProvider {
11135
11023
  */
11136
11024
  getSnapshot(payload: undefined, identity: OpenFin_2.Identity): Promise<OpenFin_2.Snapshot>;
11137
11025
  /* Excluded from this release type: getInitialLayoutSnapshot */
11138
- /* Excluded from this release type: createViewsForLayout */
11026
+ /**
11027
+ * @experimental
11028
+ *
11029
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11030
+ * Gets the current state of a particular window and its views and returns an object that
11031
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11032
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11033
+ * @param identity
11034
+ * @param callerIdentity
11035
+ */
11036
+ getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
11139
11037
  /* Excluded from this release type: getViewSnapshot */
11140
11038
  /**
11141
11039
  * Called when a snapshot is being applied and some windows in that snapshot would be fully or partially off-screen.
@@ -11540,19 +11438,9 @@ declare interface PlatformProvider {
11540
11438
  }
11541
11439
 
11542
11440
  /**
11543
- * Generated when a platform.ApplySnapshot call is resolved.
11544
- * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
11545
- * 1. The window has been created
11546
- * 2. The window has a responsive API
11547
- * 3. If a window has a layout property, the 'layout-ready' event has fired
11548
- *
11549
- * _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.
11550
- * @interface
11441
+ * @deprecated Renamed to {@link SnapshotAppliedEvent}.
11551
11442
  */
11552
- declare type PlatformSnapshotAppliedEvent = BaseEvent & {
11553
- topic: 'application';
11554
- type: 'platform-snapshot-applied';
11555
- };
11443
+ declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
11556
11444
 
11557
11445
  /**
11558
11446
  * @interface
@@ -11820,7 +11708,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
11820
11708
  * A general preload scripts state change event without event type.
11821
11709
  * @interface
11822
11710
  */
11823
- declare type PreloadScriptsStateChangeEvent = BaseWindowEvent & {
11711
+ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11824
11712
  preloadScripts: (PreloadScriptInfoRunning & any)[];
11825
11713
  };
11826
11714
 
@@ -12029,51 +11917,43 @@ declare type ProcessLoggingOptions = {
12029
11917
  };
12030
11918
 
12031
11919
  /**
12032
- * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
12033
- * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
12034
- * are propagated to `System` without any type string prefixing.
12035
- *
12036
- * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
11920
+ * @deprecated Renamed to {@link PropagatedEvent}.
12037
11921
  */
12038
- declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
11922
+ declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
12039
11923
 
12040
11924
  /**
12041
- * Union of possible 'type' values for a {@link OpenFin.ApplicationEvents.PropagatedApplicationEvent}.
11925
+ * @deprecated Renamed to {@link PropagatedEventType}.
12042
11926
  */
12043
- declare type PropagatedApplicationEventType = PropagatedApplicationEvent<string>['type'];
11927
+ declare type PropagatedApplicationEventType = PropagatedEventType_3;
12044
11928
 
12045
11929
  /**
12046
- * Modifies an event shape to reflect propagation to a parent topic.
11930
+ * Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
11931
+ * these do not propagate.
11932
+ *
12047
11933
  * @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
11934
+ *
11935
+ * @typeParam SourceTopic The topic the event shape is propagating from.
11936
+ * @typeParam TargetTopic The topic the event shape is propagating to.
11937
+ * @typeParam Event The shape of the event being propagated.
12048
11938
  */
12049
11939
  declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
12050
11940
  type: string;
12051
11941
  }> = Event extends infer E extends {
12052
11942
  type: string;
12053
- } ? Omit<E, 'type' | 'topic'> & {
11943
+ } ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
12054
11944
  type: PropagatedEventType<SourceTopic, E['type']>;
12055
11945
  topic: TargetTopic;
12056
11946
  } : never;
12057
11947
 
12058
- /**
12059
- * Modifies an event key to reflect propagation by prefixing with the topic.
12060
- */
12061
- declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
12062
-
12063
11948
  /**
12064
11949
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
12065
11950
  * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
12066
11951
  * event type key with `'view-'`.
12067
11952
  */
12068
- declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
11953
+ declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12069
11954
  viewIdentity: OpenFin_2.Identity;
12070
11955
  };
12071
11956
 
12072
- /**
12073
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
12074
- */
12075
- declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
12076
-
12077
11957
  /**
12078
11958
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
12079
11959
  * prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
@@ -12082,12 +11962,51 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
12082
11962
  *
12083
11963
  * "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
12084
11964
  */
12085
- declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent<'window', TargetTopic, Exclude<WindowSourcedEvent, WindowCloseRequestedEvent>>;
11965
+ declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
11966
+
11967
+ /**
11968
+ * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
11969
+ * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
11970
+ * are propagated to `System` without any type string prefixing.
11971
+ *
11972
+ * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
11973
+ */
11974
+ declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
11975
+
11976
+ /**
11977
+ * Modifies an event type key to reflect propagation by prefixing with the topic.
11978
+ */
11979
+ declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
11980
+
11981
+ /**
11982
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
11983
+ */
11984
+ declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
11985
+
11986
+ /**
11987
+ * Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
11988
+ */
11989
+ declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
11990
+
11991
+ /**
11992
+ * @deprecated Renamed to {@link PropagatedEvent}.
11993
+ */
11994
+ declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
11995
+
11996
+ /**
11997
+ * @deprecated Renamed to {@link PropagatedEventType}.
11998
+ */
11999
+ declare type PropagatedViewEventType = PropagatedEventType_2;
12000
+
12001
+ /**
12002
+ * @deprecated Renamed to {@link PropagatedEvent}.
12003
+ */
12004
+ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
12086
12005
 
12087
12006
  /**
12088
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.PropagatedWindowEvent}.
12007
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
12089
12008
  */
12090
- declare type PropagatedWindowEventType = PropagatedWindowEvent<string>['type'];
12009
+ declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
12091
12010
 
12092
12011
  declare interface ProtocolMap extends ProtocolMapBase {
12093
12012
  'request-external-authorization': {
@@ -12505,7 +12424,7 @@ declare type RegistryInfo_2 = {
12505
12424
  * Generated when a window has been reloaded.
12506
12425
  * @interface
12507
12426
  */
12508
- declare type ReloadedEvent = BaseWindowEvent & {
12427
+ declare type ReloadedEvent = BaseEvent_5 & {
12509
12428
  type: 'reloaded';
12510
12429
  url: string;
12511
12430
  };
@@ -12542,7 +12461,7 @@ declare type ReplaceLayoutPayload = {
12542
12461
  /**
12543
12462
  * Identity of the window whose layout will be replaced.
12544
12463
  */
12545
- target: LayoutIdentity;
12464
+ target: Identity_5 | LayoutIdentity;
12546
12465
  };
12547
12466
 
12548
12467
  /**
@@ -12641,11 +12560,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
12641
12560
  * Generated when an application is responding.
12642
12561
  * @interface
12643
12562
  */
12644
- declare type RespondingEvent = IdentityEvent & {
12563
+ declare type RespondingEvent = BaseEvents.IdentityEvent & {
12645
12564
  topic: 'application';
12646
12565
  type: 'responding';
12647
12566
  };
12648
12567
 
12568
+ /**
12569
+ * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
12570
+ * @interface
12571
+ */
12572
+ declare type RestoredEvent = BaseEvent_5 & {
12573
+ type: 'restored';
12574
+ };
12575
+
12649
12576
  declare type ResultBehavior = 'close' | 'hide' | 'none';
12650
12577
 
12651
12578
  /**
@@ -12708,7 +12635,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
12708
12635
  * Generated when Application.run() is called for an already running application.
12709
12636
  * @interface
12710
12637
  */
12711
- declare type RunRequestedEvent_2 = IdentityEvent & {
12638
+ declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12712
12639
  topic: 'application';
12713
12640
  type: 'run-requested';
12714
12641
  userAppConfigArgs: Record<string, any>;
@@ -12890,7 +12817,7 @@ declare type ServiceIdentifier = {
12890
12817
  * Generated on changes to a user’s local computer session.
12891
12818
  * @interface
12892
12819
  */
12893
- declare type SessionChangedEvent = BaseSystemEvent & {
12820
+ declare type SessionChangedEvent = BaseEvent_8 & {
12894
12821
  type: 'session-changed';
12895
12822
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
12896
12823
  };
@@ -13112,7 +13039,7 @@ declare type ShortcutOverride = Hotkey & {
13112
13039
  *
13113
13040
  * @interface
13114
13041
  */
13115
- declare type ShowAllDownloadsEvent = BaseWindowEvent & {
13042
+ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
13116
13043
  type: 'show-all-downloads';
13117
13044
  };
13118
13045
 
@@ -13120,7 +13047,15 @@ declare type ShowAllDownloadsEvent = BaseWindowEvent & {
13120
13047
  * Generated when a View is shown. This event will fire during creation of a View.
13121
13048
  * @interface
13122
13049
  */
13123
- declare type ShownEvent = BaseViewEvent & {
13050
+ declare type ShownEvent = BaseEvent_4 & {
13051
+ type: 'shown';
13052
+ };
13053
+
13054
+ /**
13055
+ * Generated when a hidden window has been shown.
13056
+ * @interface
13057
+ */
13058
+ declare type ShownEvent_2 = BaseEvent_5 & {
13124
13059
  type: 'shown';
13125
13060
  };
13126
13061
 
@@ -13149,6 +13084,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
13149
13084
  y?: number;
13150
13085
  };
13151
13086
 
13087
+ /**
13088
+ * Generated when a window has been prevented from showing.
13089
+ * @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.
13090
+ * @interface
13091
+ */
13092
+ declare type ShowRequestedEvent = BaseEvent_5 & {
13093
+ type: 'show-requested';
13094
+ };
13095
+
13152
13096
  /**
13153
13097
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
13154
13098
  *
@@ -13195,6 +13139,21 @@ declare type Snapshot = {
13195
13139
  };
13196
13140
  };
13197
13141
 
13142
+ /**
13143
+ * Generated when a platform.ApplySnapshot call is resolved.
13144
+ * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
13145
+ * 1. The window has been created
13146
+ * 2. The window has a responsive API
13147
+ * 3. If a window has a layout property, the 'layout-ready' event has fired
13148
+ *
13149
+ * _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.
13150
+ * @interface
13151
+ */
13152
+ declare type SnapshotAppliedEvent = BaseEvent & {
13153
+ topic: 'application';
13154
+ type: 'platform-snapshot-applied';
13155
+ };
13156
+
13198
13157
  /**
13199
13158
  * @interface
13200
13159
  */
@@ -13309,7 +13268,7 @@ declare class SnapshotSourceModule extends Base {
13309
13268
  * Generated when an application has started.
13310
13269
  * @interface
13311
13270
  */
13312
- declare type StartedEvent = IdentityEvent & {
13271
+ declare type StartedEvent = BaseEvents.IdentityEvent & {
13313
13272
  topic: 'application';
13314
13273
  type: 'started';
13315
13274
  };
@@ -13333,83 +13292,6 @@ declare type SubscriptionOptions = {
13333
13292
  declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
13334
13293
  /* Excluded from this release type: __constructor */
13335
13294
  private sendExternalProcessRequest;
13336
- /**
13337
- * Adds a listener to the end of the listeners array for the specified event.
13338
- * @param eventType - The type of the event.
13339
- * @param listener - Called whenever an event of the specified type occurs.
13340
- * @param options - Option to support event timestamps.
13341
- *
13342
- * @function addListener
13343
- * @memberof System
13344
- * @instance
13345
- * @tutorial System.EventEmitter
13346
- */
13347
- /**
13348
- * Adds a listener to the end of the listeners array for the specified event.
13349
- * @param eventType - The type of the event.
13350
- * @param listener - Called whenever an event of the specified type occurs.
13351
- * @param options - Option to support event timestamps.
13352
- *
13353
- * @function on
13354
- * @memberof System
13355
- * @instance
13356
- * @tutorial System.EventEmitter
13357
- */
13358
- /**
13359
- * 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.
13360
- * @param eventType - The type of the event.
13361
- * @param listener - The callback function.
13362
- * @param options - Option to support event timestamps.
13363
- *
13364
- * @function once
13365
- * @memberof System
13366
- * @instance
13367
- * @tutorial System.EventEmitter
13368
- */
13369
- /**
13370
- * Adds a listener to the beginning of the listeners array for the specified event.
13371
- * @param eventType - The type of the event.
13372
- * @param listener - The callback function.
13373
- * @param options - Option to support event timestamps.
13374
- *
13375
- * @function prependListener
13376
- * @memberof System
13377
- * @instance
13378
- * @tutorial System.EventEmitter
13379
- */
13380
- /**
13381
- * 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.
13382
- * The listener is added to the beginning of the listeners array.
13383
- * @param eventType - The type of the event.
13384
- * @param listener - The callback function.
13385
- * @param options - Option to support event timestamps.
13386
- *
13387
- * @function prependOnceListener
13388
- * @memberof System
13389
- * @instance
13390
- * @tutorial System.EventEmitter
13391
- */
13392
- /**
13393
- * Remove a listener from the listener array for the specified event.
13394
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
13395
- * @param eventType - The type of the event.
13396
- * @param listener - The callback function.
13397
- * @param options - Option to support event timestamps.
13398
- *
13399
- * @function removeListener
13400
- * @memberof System
13401
- * @instance
13402
- * @tutorial System.EventEmitter
13403
- */
13404
- /**
13405
- * Removes all listeners, or those of the specified event.
13406
- * @param eventType - The type of the event.
13407
- *
13408
- * @function removeAllListeners
13409
- * @memberof System
13410
- * @instance
13411
- * @tutorial System.EventEmitter
13412
- */
13413
13295
  /**
13414
13296
  * Returns the version of the runtime. The version contains the major, minor,
13415
13297
  * build and revision numbers.
@@ -14842,12 +14724,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
14842
14724
  };
14843
14725
 
14844
14726
  /**
14845
- * [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
14846
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
14847
- * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
14848
- * from which they propagate).
14727
+ * @deprecated Renamed to {@link Event}.
14849
14728
  */
14850
- declare type SystemEvent = ExcludeRequested<PropagatedWindowEvent<'system'>> | PropagatedViewEvent<'system'> | PropagatedApplicationEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
14729
+ declare type SystemEvent = Event_11;
14851
14730
 
14852
14731
  declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
14853
14732
 
@@ -14855,8 +14734,10 @@ declare namespace SystemEvents {
14855
14734
  export {
14856
14735
  NotRequested,
14857
14736
  ExcludeRequested,
14858
- BaseSystemEvent,
14737
+ BaseEvent_8 as BaseEvent,
14738
+ IdleStateChangedEvent,
14859
14739
  IdleEvent,
14740
+ MonitorInfoChangedEvent,
14860
14741
  MonitorEvent,
14861
14742
  SessionChangedEvent,
14862
14743
  AppVersionEvent,
@@ -14870,17 +14751,19 @@ declare namespace SystemEvents {
14870
14751
  ApplicationCreatedEvent,
14871
14752
  DesktopIconClickedEvent,
14872
14753
  SystemShutdownEvent,
14754
+ Event_11 as Event,
14873
14755
  SystemEvent,
14756
+ EventType_8 as EventType,
14874
14757
  SystemEventType,
14875
- Payload_7 as Payload,
14876
- ByType_6 as ByType
14758
+ Payload_9 as Payload,
14759
+ ByType_8 as ByType
14877
14760
  }
14878
14761
  }
14879
14762
 
14880
14763
  /**
14881
- * Union of possible `type` values for a {@link SystemEvent}.
14764
+ * @deprecated Renamed to {@link EventType}.
14882
14765
  */
14883
- declare type SystemEventType = SystemEvent['type'];
14766
+ declare type SystemEventType = EventType_8;
14884
14767
 
14885
14768
  /**
14886
14769
  * @interface
@@ -14992,20 +14875,6 @@ declare interface TabDragListener extends EventEmitter_2 {
14992
14875
  contentItem: ContentItem;
14993
14876
  }
14994
14877
 
14995
- /**
14996
- * @typedef {string} LayoutPosition
14997
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
14998
- */
14999
- /**
15000
- * @typedef {object} StackCreationOptions
15001
- * @summary Stack creation options.
15002
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
15003
- */
15004
- /**
15005
- * @typedef {object} TabStack~AddViewOptions
15006
- * @summary Options to use when adding a view to a {@link TabStack}
15007
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
15008
- */
15009
14878
  /**
15010
14879
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15011
14880
  */
@@ -15133,7 +15002,7 @@ declare type TargetApp = string | AppMetadata;
15133
15002
  * In that case, previousTarget identity will be the same as target identity.
15134
15003
  * @interface
15135
15004
  */
15136
- declare type TargetChangedEvent = BaseViewEvent & {
15005
+ declare type TargetChangedEvent = BaseEvent_4 & {
15137
15006
  type: 'target-changed';
15138
15007
  previousTarget: OpenFin_2.Identity;
15139
15008
  };
@@ -15287,7 +15156,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15287
15156
  * Generated when the tray icon is clicked.
15288
15157
  * @interface
15289
15158
  */
15290
- declare type TrayIconClickedEvent = IdentityEvent & {
15159
+ declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
15291
15160
  topic: 'application';
15292
15161
  type: 'tray-icon-clicked';
15293
15162
  button: 0 | 1 | 2;
@@ -15377,7 +15246,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15377
15246
  * A general user bounds change event without event type.
15378
15247
  * @interface
15379
15248
  */
15380
- declare type UserBoundsChangeEvent = BaseWindowEvent & {
15249
+ declare type UserBoundsChangeEvent = BaseEvent_5 & {
15381
15250
  height: number;
15382
15251
  left: number;
15383
15252
  top: number;
@@ -15389,7 +15258,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
15389
15258
  * Generated when a window's user movement becomes disabled.
15390
15259
  * @interface
15391
15260
  */
15392
- declare type UserMovementDisabledEvent = BaseWindowEvent & {
15261
+ declare type UserMovementDisabledEvent = BaseEvent_5 & {
15393
15262
  type: 'user-movement-disabled';
15394
15263
  };
15395
15264
 
@@ -15397,7 +15266,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
15397
15266
  * Generated when a window's user movement becomes enabled.
15398
15267
  * @interface
15399
15268
  */
15400
- declare type UserMovementEnabledEvent = BaseWindowEvent & {
15269
+ declare type UserMovementEnabledEvent = BaseEvent_5 & {
15401
15270
  type: 'user-movement-enabled';
15402
15271
  };
15403
15272
 
@@ -15450,169 +15319,6 @@ declare type VerboseWebPermission = {
15450
15319
 
15451
15320
  declare type View = OpenFin_2.View;
15452
15321
 
15453
- /**
15454
- * @PORTED
15455
- * @typedef {object} View~options
15456
- * @summary View creation options.
15457
- * @desc This is the options object required by {@link View.create View.create}.
15458
- *
15459
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
15460
- * (defaults to `"about:blank"` when omitted).
15461
- *
15462
- * @property {object} [experimental]
15463
- * Configurations for API injection.
15464
- *
15465
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
15466
- *
15467
- * @property {object} [accelerator]
15468
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
15469
- *
15470
- * @property {boolean} [accelerator.devtools=false]
15471
- * If `true`, enables the devtools keyboard shortcut:<br>
15472
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
15473
- *
15474
- * @property {boolean} [accelerator.reload=false]
15475
- * If `true`, enables the reload keyboard shortcuts:<br>
15476
- * `Ctrl` + `R` _(Windows)_<br>
15477
- * `F5` _(Windows)_<br>
15478
- * `Command` + `R` _(Mac)_
15479
- *
15480
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
15481
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
15482
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
15483
- * `Shift` + `F5` _(Windows)_<br>
15484
- * `Command` + `Shift` + `R` _(Mac)_
15485
- *
15486
- * @property {boolean} [accelerator.zoom=false]
15487
- * If `true`, enables the zoom keyboard shortcuts:<br>
15488
- * `Ctrl` + `+` _(Zoom In)_<br>
15489
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
15490
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
15491
- * `Ctrl` + `-` _(Zoom Out)_<br>
15492
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
15493
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
15494
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
15495
- * `Ctrl` + `0` _(Restore to 100%)_
15496
- *
15497
- * @property {object} [api]
15498
- * Configurations for API injection.
15499
- *
15500
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
15501
- *
15502
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
15503
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
15504
- *
15505
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
15506
- * Autoplay policy to apply to content in the window, can be
15507
- * `no-user-gesture-required`, `user-gesture-required`,
15508
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
15509
- *
15510
- * @property {object} [autoResize] AutoResize options
15511
- *
15512
- * @property {object} [bounds] initial bounds given relative to the window.
15513
- *
15514
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
15515
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
15516
- * (`document.body.style.backgroundColor`),
15517
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
15518
- * areas when growing a window. Setting
15519
- * this value to the anticipated content background color can help improve user experience.
15520
- * Default is white.
15521
- *
15522
- * @property {object} [contentNavigation]
15523
- * Restrict navigation to URLs that match an allowed pattern.
15524
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
15525
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15526
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
15527
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
15528
- *
15529
- * @property {object} [contentRedirect]
15530
- * Restrict redirects to URLs that match an allowed pattern.
15531
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
15532
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15533
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
15534
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
15535
- *
15536
- * @property {object} [contextMenuSettings] - _Updatable._
15537
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
15538
- * Configure the context menu when right-clicking on a view.
15539
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
15540
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
15541
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
15542
- *
15543
- * @property {object} [contextMenuOptions] - _Updatable._
15544
- * Configure the context menu when right-clicking on a view. Supported menu items:
15545
- * 'separator'
15546
- * 'cut'
15547
- * 'copy'
15548
- * 'copyImage',
15549
- * 'paste'
15550
- * 'spellCheck'
15551
- * 'inspect'
15552
- * 'reload'
15553
- * 'navigateForward'
15554
- * 'navigateBack'
15555
- * 'print'
15556
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
15557
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
15558
- *
15559
- * @property {any} [customData=""] - _Updatable._
15560
- * A field that the user can attach serializable data to be ferried around with the view options.
15561
- * _When omitted, the default value of this property is the empty string (`""`)._
15562
- *
15563
- * @property {any} [customContext=""] - _Updatable._
15564
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
15565
- * is called.
15566
- * When omitted, the default value of this property is the empty string (`""`).
15567
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
15568
- *
15569
- * @property {object[]} [hotkeys=[]] - _Updatable._
15570
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
15571
- * Within Platform, OpenFin also implements a set of pre-defined actions called
15572
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
15573
- * that can be assigned to a specific hotkey in the platform manifest.
15574
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
15575
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
15576
- *
15577
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
15578
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
15579
- * if the view isn't part of the new layout when running `Layout.replace`.
15580
- *
15581
- * @property {string} name
15582
- * The name of the view.
15583
- *
15584
- * @property {boolean} [detachOnClose=false] - _Updatable._
15585
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
15586
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
15587
- *
15588
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
15589
- * but the properties in the manifest will take precedence if there is any collision.
15590
- *
15591
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
15592
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
15593
- * from the parent application.
15594
- *
15595
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
15596
- *
15597
- * @property {string} [processAffinity=<application uuid>]
15598
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
15599
- *
15600
- * @property {boolean} [spellCheck=false]
15601
- * Enable spell check in input text fields for the view.
15602
- *
15603
- * @property {Identity} [target]
15604
- * The identity of the window this view should be attached to.
15605
- *
15606
- * @property {string} [url="about:blank"]
15607
- * The URL of the view.
15608
- *
15609
- * @property {string} [uuid=<application uuid>]
15610
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
15611
- * If omitted, defaults to the `uuid` of the application spawning the view.
15612
- * If given, must match the `uuid` of the application spawning the view.
15613
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
15614
- * really no need to provide it.
15615
- */
15616
15322
  /**
15617
15323
  * A View can be used to embed additional web content into a Window.
15618
15324
  * It is like a child window, except it is positioned relative to its owning window.
@@ -16047,7 +15753,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
16047
15753
  * Generated when a View is attached to a window.
16048
15754
  * @interface
16049
15755
  */
16050
- declare type ViewAttachedEvent = BaseWindowEvent & {
15756
+ declare type ViewAttachedEvent = BaseEvent_5 & {
16051
15757
  type: 'view-attached';
16052
15758
  target: OpenFin_2.Identity;
16053
15759
  viewIdentity: OpenFin_2.Identity;
@@ -16089,26 +15795,23 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
16089
15795
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
16090
15796
  * @interface
16091
15797
  */
16092
- declare type ViewDetachedEvent = BaseWindowEvent & {
15798
+ declare type ViewDetachedEvent = BaseEvent_5 & {
16093
15799
  type: 'view-detached';
16094
- target: OpenFin_2.Identity;
15800
+ target: OpenFin_2.Identity | null;
16095
15801
  previousTarget: OpenFin_2.Identity;
16096
15802
  viewIdentity: OpenFin_2.Identity;
16097
15803
  };
16098
15804
 
16099
15805
  /**
16100
- * [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
16101
- * discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
16102
- * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
15806
+ * @deprecated Renamed to {@link Event}.
16103
15807
  */
16104
- declare type ViewEvent = (WebContentsEvent<'view'> & {
16105
- target: OpenFin_2.Identity;
16106
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
15808
+ declare type ViewEvent = Event_4;
16107
15809
 
16108
15810
  declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
16109
15811
 
16110
15812
  declare namespace ViewEvents {
16111
15813
  export {
15814
+ BaseEvent_4 as BaseEvent,
16112
15815
  BaseViewEvent,
16113
15816
  TargetChangedEvent,
16114
15817
  NonPropagatedViewEvent,
@@ -16118,20 +15821,24 @@ declare namespace ViewEvents {
16118
15821
  HotkeyEvent,
16119
15822
  ShownEvent,
16120
15823
  HostContextChangedEvent,
15824
+ Event_4 as Event,
16121
15825
  ViewEvent,
16122
15826
  WillPropagateViewEvent,
15827
+ EventType,
16123
15828
  ViewEventType,
15829
+ PropagatedEvent_2 as PropagatedEvent,
16124
15830
  PropagatedViewEvent,
15831
+ PropagatedEventType_2 as PropagatedEventType,
16125
15832
  PropagatedViewEventType,
16126
- Payload_8 as Payload,
16127
- ByType_7 as ByType
15833
+ Payload_2 as Payload,
15834
+ ByType
16128
15835
  }
16129
15836
  }
16130
15837
 
16131
15838
  /**
16132
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.ViewEvent}.
15839
+ * @deprecated Renamed to {@link EventType}.
16133
15840
  */
16134
- declare type ViewEventType = ViewEvent['type'];
15841
+ declare type ViewEventType = EventType;
16135
15842
 
16136
15843
  /**
16137
15844
  * @interface
@@ -17270,12 +16977,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17270
16977
  }
17271
16978
 
17272
16979
  /**
17273
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
17274
- * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
16980
+ * @deprecated Renamed to {@link Event}.
17275
16981
  */
17276
- declare type WebContentsEvent<Topic extends string> = {
17277
- topic: Topic;
17278
- } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
16982
+ declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
17279
16983
 
17280
16984
  declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
17281
16985
 
@@ -17287,6 +16991,7 @@ declare namespace WebContentsEvents {
17287
16991
  CrashedEvent_2 as CrashedEvent,
17288
16992
  CertificateErrorEvent,
17289
16993
  CertificateSelectionShownEvent,
16994
+ PageFaviconUpdatedEvent,
17290
16995
  FaviconUpdatedEvent,
17291
16996
  NavigationRejectedEvent,
17292
16997
  UrlChangedEvent,
@@ -17305,6 +17010,7 @@ declare namespace WebContentsEvents {
17305
17010
  FileDownloadStartedEvent,
17306
17011
  FileDownloadProgressEvent,
17307
17012
  FileDownloadCompletedEvent,
17013
+ Event_5 as Event,
17308
17014
  WebContentsEvent,
17309
17015
  WillPropagateWebContentsEvent,
17310
17016
  NonPropagatedWebContentsEvent
@@ -17327,7 +17033,7 @@ declare namespace WebContentsEvents {
17327
17033
  * `clipboard-read`: Request access to read from the clipboard.<br>
17328
17034
  * `clipboard-sanitized-write`: Request access to write to the clipboard.
17329
17035
  */
17330
- declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
17036
+ declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
17331
17037
 
17332
17038
  /**
17333
17039
  * Object representing headers and their values, where the
@@ -17352,7 +17058,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
17352
17058
  * A general will-move or will-resize event without event type.
17353
17059
  * @interface
17354
17060
  */
17355
- declare type WillMoveOrResizeEvent = BaseWindowEvent & {
17061
+ declare type WillMoveOrResizeEvent = BaseEvent_5 & {
17356
17062
  height: number;
17357
17063
  left: number;
17358
17064
  top: number;
@@ -17374,7 +17080,7 @@ declare type WillPropagateViewEvent = ViewEvent;
17374
17080
  *
17375
17081
  * A WebContents event that does propagate to (republish on) parent topics.
17376
17082
  */
17377
- declare type WillPropagateWebContentsEvent = WebContentsEvent<string>;
17083
+ declare type WillPropagateWebContentsEvent = Event_5<string>;
17378
17084
 
17379
17085
  /**
17380
17086
  * @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
@@ -17388,7 +17094,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
17388
17094
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
17389
17095
  * @interface
17390
17096
  */
17391
- declare type WillRedirectEvent = BaseWindowEvent & {
17097
+ declare type WillRedirectEvent = BaseEvent_5 & {
17392
17098
  type: 'will-redirect';
17393
17099
  blocked: boolean;
17394
17100
  isInPlace: boolean;
@@ -17405,476 +17111,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
17405
17111
  type: 'will-resize';
17406
17112
  };
17407
17113
 
17408
- /**
17409
- * @PORTED
17410
- * @typedef { object } Margins@typedef { object } Margins
17411
- * @property { string } [marginType]
17412
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
17413
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
17414
- *
17415
- * @property { number } [top] The top margin of the printed web page, in pixels.
17416
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
17417
- * @property { number } [left] The left margin of the printed web page, in pixels.
17418
- * @property { number } [right] The right margin of the printed web page, in pixels.
17419
- */
17420
- /**
17421
- * @PORTED
17422
- * @typedef { object } Dpi@typedef { object } Dpi
17423
- * @property { number } [horizontal] The horizontal dpi
17424
- * @property { number } [vertical] The vertical dpi
17425
- */
17426
- /**
17427
- * @PORTED
17428
- * @typedef { object } PrintOptions@typedef { object } PrintOptions
17429
- * @property { boolean } [silent=false] Don't ask user for print settings.
17430
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
17431
- * @property { string } [deviceName=''] Set the printer device name to use.
17432
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
17433
- * @property { Margins } [margins] Set margins for the printed web page
17434
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
17435
- * @property { number } [scaleFactor] The scale factor of the web page.
17436
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
17437
- * @property { boolean } [collate] Whether the web page should be collated.
17438
- * @property { number } [copies] The number of copies of the web page to print.
17439
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
17440
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
17441
- * @property { Dpi } [dpi] Set dpi for the printed web page
17442
- */
17443
- /**
17444
- * @REMOVED
17445
- * PrinterInfo interface
17446
- * @typedef { object } PrinterInfo@typedef { object } PrinterInfo
17447
- * @property { string } name Printer Name
17448
- * @property { string } description Printer Description
17449
- * @property { number } status Printer Status
17450
- * @property { boolean } isDefault Indicates that system's default printer
17451
- */
17452
- /**
17453
- * @REMOVED
17454
- * SharedWorkerInfo interface
17455
- * @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
17456
- * @property { string } id The unique id of the shared worker.
17457
- * @property { string } url The url of the shared worker.
17458
- */
17459
- /**
17460
- * @PORTED
17461
- * ContentCreationRule interface
17462
- * @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
17463
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
17464
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
17465
- * @property { object } options Window creation options or View creation options.
17466
- */
17467
- /**
17468
- * @PORTED
17469
- * @typedef {object} Window~options
17470
- * @summary Window creation options.
17471
- * @desc This is the options object required by {@link Window.create Window.create}.
17472
- *
17473
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
17474
- * (defaults to `"about:blank"` when omitted).
17475
- *
17476
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
17477
- *
17478
- * @property {object} [accelerator]
17479
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
17480
- *
17481
- * @property {boolean} [accelerator.devtools=false]
17482
- * If `true`, enables the devtools keyboard shortcut:<br>
17483
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
17484
- *
17485
- * @property {boolean} [accelerator.reload=false]
17486
- * If `true`, enables the reload keyboard shortcuts:<br>
17487
- * `Ctrl` + `R` _(Windows)_<br>
17488
- * `F5` _(Windows)_<br>
17489
- * `Command` + `R` _(Mac)_
17490
- *
17491
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
17492
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
17493
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
17494
- * `Shift` + `F5` _(Windows)_<br>
17495
- * `Command` + `Shift` + `R` _(Mac)_
17496
- *
17497
- * @property {boolean} [accelerator.zoom=false]
17498
- * 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.
17499
- * If `true`, enables the zoom keyboard shortcuts:<br>
17500
- * `Ctrl` + `+` _(Zoom In)_<br>
17501
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
17502
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
17503
- * `Ctrl` + `-` _(Zoom Out)_<br>
17504
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
17505
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
17506
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
17507
- * `Ctrl` + `0` _(Restore to 100%)_
17508
- *
17509
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
17510
- * <br>
17511
- * alphaMask turns anything of matching RGB value transparent.
17512
- * <br>
17513
- * Caveats:
17514
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
17515
- * * User cannot click-through transparent regions
17516
- * * Not supported on Mac
17517
- * * Windows Aero must be enabled
17518
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
17519
- * * Not supported on rounded corner windows
17520
- * @property {number} [alphaMask.red=-1] 0-255
17521
- * @property {number} [alphaMask.green=-1] 0-255
17522
- * @property {number} [alphaMask.blue=-1] 0-255
17523
- *
17524
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
17525
- * A flag to always position the window at the top of the window stack.
17526
- *
17527
- * @property {object} [api]
17528
- * Configurations for API injection.
17529
- *
17530
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
17531
- *
17532
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
17533
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
17534
- *
17535
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
17536
- *
17537
- * @property {number} [aspectRatio=0] - _Updatable._
17538
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
17539
- * an aspect ratio will not be enforced.
17540
- *
17541
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
17542
- * Autoplay policy to apply to content in the window, can be
17543
- * `no-user-gesture-required`, `user-gesture-required`,
17544
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
17545
- *
17546
- * @property {boolean} [autoShow=true]
17547
- * A flag to automatically show the window when it is created.
17548
- *
17549
- * @property {string} [backgroundColor="#FFF"]
17550
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
17551
- * (`document.body.style.backgroundColor`),
17552
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
17553
- * areas when growing a window. Setting
17554
- * this value to the anticipated content background color can help improve user experience.
17555
- * Default is white.
17556
- *
17557
- * @property {object} [contentCreation]
17558
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
17559
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
17560
- *
17561
- * @property {object} [contentNavigation]
17562
- * Restrict navigation to URLs that match an allowed pattern.
17563
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
17564
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17565
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
17566
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
17567
- *
17568
- * @property {object} [contentRedirect]
17569
- * Restrict redirects to URLs that match an allowed pattern.
17570
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
17571
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17572
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
17573
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
17574
- *
17575
- * @property {boolean} [contextMenu=true] - _Updatable._
17576
- * A flag to show the context menu when right-clicking on a window.
17577
- * Gives access to the devtools for the window.
17578
- *
17579
- * @property {object} [contextMenuSettings] - _Updatable._
17580
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
17581
- * Configure the context menu when right-clicking on a window.
17582
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
17583
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
17584
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
17585
- *
17586
- * @property {object} [contextMenuOptions] - _Updatable._
17587
- * Configure the context menu when right-clicking on a window. Supported menu items:
17588
- * 'separator'
17589
- * 'cut'
17590
- * 'copy'
17591
- * 'paste'
17592
- * 'spellCheck'
17593
- * 'inspect'
17594
- * 'reload'
17595
- * 'navigateForward'
17596
- * 'navigateBack'
17597
- * 'print'
17598
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
17599
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
17600
- *
17601
- * @property {object} [cornerRounding] - _Updatable._
17602
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
17603
- * average of _height_ and _width_.
17604
- * @property {number} [cornerRounding.height=0] The height in pixels.
17605
- * @property {number} [cornerRounding.width=0] The width in pixels.
17606
- *
17607
- * @property {any} [customContext=""] - _Updatable. Inheritable._
17608
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
17609
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
17610
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
17611
- * _When omitted, _inherits_ from the parent application._
17612
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
17613
- *
17614
- * @property {any} [customData=""] - _Updatable. Inheritable._
17615
- * A field that the user can attach serializable data to be ferried around with the window options.
17616
- * _When omitted, _inherits_ from the parent application._
17617
- *
17618
- * @property {object[]} [customRequestHeaders]
17619
- * Defines list of custom headers for requests sent by the window.
17620
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
17621
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
17622
- * where the object key is the name of header and value at key is the value of the header
17623
- *
17624
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
17625
- * Toggling off would keep the Window alive even if all its Views were closed.
17626
- * This is meant for advanced users and should be used with caution.
17627
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
17628
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
17629
- * ** note ** - This option is ignored in non-Platforms apps.
17630
- *
17631
- * @property {boolean} [defaultCentered=false]
17632
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
17633
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
17634
- * somewhat above center vertically.
17635
- *
17636
- * @property {number} [defaultHeight=500]
17637
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
17638
- * in favor of the cached value.
17639
- *
17640
- * @property {number} [defaultLeft=100]
17641
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17642
- * launches in favor of the cached value.
17643
- *
17644
- * @property {number} [defaultTop=100]
17645
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17646
- * launches in favor of the cached value.
17647
- *
17648
- * @property {number} [defaultWidth=800]
17649
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17650
- * launches in favor of the cached value.
17651
- *
17652
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
17653
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
17654
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
17655
- *
17656
- * @property {boolean} [frame=true] - _Updatable._
17657
- * A flag to show the frame.
17658
- *
17659
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
17660
- *
17661
- * @property {object[]} [hotkeys=[]] - _Updatable._
17662
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
17663
- * Within Platform, OpenFin also implements a set of pre-defined actions called
17664
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
17665
- * that can be assigned to a specific hotkey in the platform manifest.
17666
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
17667
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
17668
- *
17669
- * @property {string} [icon] - _Updatable. Inheritable._
17670
- * A URL for the icon to be shown in the window title bar and the taskbar.
17671
- * When omitted, inherits from the parent application._
17672
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
17673
- *
17674
- * @property {number} [maxHeight=-1] - _Updatable._
17675
- * The maximum height of a window. Will default to the OS defined value if set to -1.
17676
- *
17677
- * @property {boolean} [maximizable=true] - _Updatable._
17678
- * A flag that lets the window be maximized.
17679
- *
17680
- * @property {number} [maxWidth=-1] - _Updatable._
17681
- * The maximum width of a window. Will default to the OS defined value if set to -1.
17682
- *
17683
- * @property {number} [minHeight=0] - _Updatable._
17684
- * The minimum height of a window.
17685
- *
17686
- * @property {boolean} [minimizable=true] - _Updatable._
17687
- * A flag that lets the window be minimized.
17688
- *
17689
- * @property {number} [minWidth=0] - _Updatable._
17690
- * The minimum width of a window.
17691
- *
17692
- * @property {Identity} [modalParentIdentity]
17693
- * Parent identity of a modal window. It will create a modal child window when this option is set.
17694
- *
17695
- * @property {string} name
17696
- * The name of the window.
17697
- *
17698
- * @property {number} [opacity=1.0] - _Updatable._
17699
- * A flag that specifies how transparent the window will be.
17700
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
17701
- * This value is clamped between `0.0` and `1.0`.
17702
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
17703
- *
17704
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
17705
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
17706
- * from the parent application.
17707
- *
17708
- * @property {string} [processAffinity]
17709
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
17710
- *
17711
- * @property {boolean} [resizable=true] - _Updatable._
17712
- * A flag to allow the user to resize the window.
17713
- *
17714
- * @property {object} [resizeRegion] - _Updatable._
17715
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
17716
- * @property {number} [resizeRegion.bottomRightCorner=9]
17717
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
17718
- * @property {number} [resizeRegion.size=7]
17719
- * The size in pixels.
17720
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
17721
- * Sides that a window can be resized from.
17722
- *
17723
- * @property {boolean} [saveWindowState=true]
17724
- * A flag to cache the location of the window.
17725
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
17726
- *
17727
- * @property {boolean} [ignoreSavedWindowState]
17728
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
17729
- *
17730
- * @property {boolean} [shadow=false]
17731
- * A flag to display a shadow on frameless windows.
17732
- * `shadow` and `cornerRounding` are mutually exclusive.
17733
- * On Windows 7, Aero theme is required.
17734
- *
17735
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
17736
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
17737
- * This occurs when the window is resizing or a tab is being dragged within the layout.
17738
- *
17739
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
17740
- * A flag to show the window's icon in the taskbar.
17741
- *
17742
- * @property {boolean} [smallWindow=false]
17743
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
17744
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
17745
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
17746
- *
17747
- * @property {boolean} [spellCheck=false]
17748
- * Enable spell check in input text fields for the window.
17749
- *
17750
- * @property {string} [state="normal"]
17751
- * The visible state of the window on creation.
17752
- * One of:
17753
- * * `"maximized"`
17754
- * * `"minimized"`
17755
- * * `"normal"`
17756
- *
17757
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
17758
- *
17759
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
17760
- * Specify a taskbar group for the window.
17761
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
17762
- *
17763
- * @property {string} [url="about:blank"]
17764
- * The URL of the window.
17765
- *
17766
- * @property {string} [uuid=<application uuid>]
17767
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
17768
- * If omitted, defaults to the `uuid` of the application spawning the window.
17769
- * If given, must match the `uuid` of the application spawning the window.
17770
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
17771
- * really no need to provide it.
17772
- *
17773
- * @property {boolean} [waitForPageLoad=false]
17774
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
17775
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
17776
- *
17777
- * @property {ViewVisibility} [viewVisibility]
17778
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
17779
- */
17780
- /**
17781
- * @PORTED
17782
- * @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
17783
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
17784
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
17785
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
17786
- */
17787
- /**
17788
- * @PORTED
17789
- * @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
17790
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
17791
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
17792
- */
17793
- /**
17794
- * @REMOVED
17795
- * @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.
17796
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
17797
- */
17798
- /**
17799
- * @REMOVED
17800
- * @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.
17801
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
17802
- */
17803
- /**
17804
- * @PORTED
17805
- * @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
17806
- * @property { Area } [area] The area of the window to be captured.
17807
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
17808
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
17809
- */
17810
- /**
17811
- * @PORTED
17812
- * @typedef { object } Area@typedef { object } Area
17813
- * @property { number } height Area's height
17814
- * @property { number } width Area's width
17815
- * @property { number } x X coordinate of area's starting point
17816
- * @property { number } y Y coordinate of area's starting point
17817
- */
17818
- /**
17819
- * @PORTED
17820
- * @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
17821
- * @property {boolean} [forward=true] Whether to search forward or backward.
17822
- * @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.
17823
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
17824
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
17825
- * @property {boolean} [medialCapitalAsWordStart=false]
17826
- * 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>
17827
- * lowercase or non-letter. Accepts several other intra-word matches.
17828
- */
17829
- /**
17830
- * @REMOVED
17831
- * @typedef {object} Transition@typedef {object} Transition
17832
- * @property {Opacity} opacity - The Opacity transition
17833
- * @property {Position} position - The Position transition
17834
- * @property {Size} size - The Size transition
17835
- */
17836
- /**
17837
- * @PORTED
17838
- * @typedef {object} TransitionOptions@typedef {object} TransitionOptions
17839
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
17840
- this animation onto the end of the animation queue.
17841
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
17842
- */
17843
- /**
17844
- * @PORTED
17845
- * @typedef {object} Size@typedef {object} Size
17846
- * @property {number} duration - The total time in milliseconds this transition should take.
17847
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
17848
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
17849
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
17850
- */
17851
- /**
17852
- * @PORTED
17853
- * @typedef {object} Position@typedef {object} Position
17854
- * @property {number} duration - The total time in milliseconds this transition should take.
17855
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
17856
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
17857
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
17858
- */
17859
- /**
17860
- * @PORTED
17861
- * @typedef {object} Opacity@typedef {object} Opacity
17862
- * @property {number} duration - The total time in milliseconds this transition should take.
17863
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
17864
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
17865
- */
17866
- /**
17867
- * @REMOVED
17868
- * Bounds is a interface that has the properties of height,
17869
- * width, left, top which are all numbers
17870
- * @typedef { object } Bounds@typedef { object } Bounds
17871
- * @property { number } height Get the application height bound
17872
- * @property { number } width Get the application width bound
17873
- * @property { number } top Get the application top bound
17874
- * @property { number } left Get the application left bound
17875
- * @property { number } right Get the application right bound
17876
- * @property { number } bottom Get the application bottom bound
17877
- */
17878
17114
  /**
17879
17115
  * A basic window that wraps a native HTML window. Provides more fine-grained
17880
17116
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -18660,10 +17896,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18660
17896
  show(force?: boolean): Promise<void>;
18661
17897
  /**
18662
17898
  * Shows the window if it is hidden at the specified location.
18663
- * If the toggle parameter is set to true, the window will
18664
- * alternate between showing and hiding.
18665
- * @param left The left position of the window
18666
- * @param top The right position of the window
17899
+ *
17900
+ * @param left The left position of the window in pixels
17901
+ * @param top The top position of the window in pixels
18667
17902
  * @param force Show will be prevented from closing when force is false and
18668
17903
  * ‘show-requested’ has been subscribed to for application’s main window
18669
17904
  *
@@ -18725,28 +17960,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18725
17960
  * ```
18726
17961
  */
18727
17962
  authenticate(userName: string, password: string): Promise<void>;
18728
- /**
18729
- * @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
18730
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
18731
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
18732
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
18733
- */
18734
- /**
18735
- * @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
18736
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
18737
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
18738
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
18739
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
18740
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
18741
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
18742
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
18743
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
18744
- */
18745
- /**
18746
- * @typedef {object} MenuResult@typedef {object} MenuResult
18747
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
18748
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
18749
- */
18750
17963
  /**
18751
17964
  * Shows a menu on the window.
18752
17965
  *
@@ -18843,602 +18056,552 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18843
18056
  */
18844
18057
  closePopupMenu(): Promise<void>;
18845
18058
  /**
18846
- * @PORTED
18847
- * @typedef {object} PopupOptions@typedef {object} PopupOptions
18848
- * @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.
18849
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
18850
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
18851
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
18852
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
18853
- * @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.
18854
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
18855
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
18856
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
18857
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
18858
- * @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.
18859
- * @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`.
18860
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
18861
- * @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.
18862
- */
18863
- /**
18864
- * @PORTED
18865
- * @typedef {object} PopupResult@typedef {object} PopupResult
18866
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
18867
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
18868
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
18869
- */
18870
- /**
18871
- * Dispatch a result to the caller of `showPopupWindow`.
18872
- *
18873
- * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18874
- * @param data Serializable data to send to the caller window.
18875
- *
18876
- * @example
18877
- * ```js
18878
- * await fin.me.dispatchPopupResult({
18879
- * foo: 'bar'
18880
- * });
18881
- * ```
18882
- */
18883
- dispatchPopupResult(data: any): Promise<void>;
18884
- /**
18885
- * Prints the contents of the window.
18886
- *
18887
- * @param options Configuration for the print task.
18888
- * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18889
- * and the default settings for printing.
18890
- *
18891
- * Use the CSS style `page-break-before: always;` to force print to a new page.
18892
- *
18893
- * @example
18894
- * ```js
18895
- * const win = fin.Window.getCurrentSync();
18896
- *
18897
- * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18898
- * console.log('print call has been sent to the system');
18899
- * });
18900
- * ```
18901
- *
18902
- * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18903
- * use the `content` option:
18904
- *
18905
- * ```js
18906
- * const win = fin.Window.getCurrentSync();
18907
- *
18908
- * // Print embedded views
18909
- * win.print({ content: 'views' });
18910
- *
18911
- * // Print screenshot of current window
18912
- * win.print({ content: 'screenshot' })
18913
- * ```
18914
- *
18915
- * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18916
- * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18917
- * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18918
- * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18919
- *
18920
- * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18921
- * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18922
- *
18923
- * To print the views embedded in their page context, set `content` to `screenshot`.
18924
- */
18925
- print(options?: OpenFin_2.WindowPrintOptions): Promise<void>;
18926
- }
18927
-
18928
- /**
18929
- * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18930
- * @interface
18931
- */
18932
- declare type WindowAlertRequestedEvent = BaseApplicationEvent & {
18933
- type: 'window-alert-requested';
18934
- };
18935
-
18936
- /**
18937
- * Returned from getBounds call. bottom and right are never used for setting.
18938
- * @interface
18939
- */
18940
- declare type WindowBounds = Bounds & {
18941
- bottom: number;
18942
- right: number;
18943
- };
18944
-
18945
- /**
18946
- * Generated when a window has closed.
18947
- * @interface
18948
- */
18949
- declare type WindowClosedEvent = BaseWindowEvent & {
18950
- type: 'closed';
18951
- };
18952
-
18953
- /**
18954
- * Generated when a window has been prevented from closing.
18955
- * @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.
18956
- * @interface
18957
- */
18958
- declare type WindowCloseRequestedEvent = BaseWindowEvent & {
18959
- type: 'close-requested';
18960
- };
18961
-
18962
- /**
18963
- * Generated when a window has initiated the closing routine.
18964
- * @interface
18965
- */
18966
- declare type WindowClosingEvent = BaseWindowEvent & {
18967
- type: 'closing';
18968
- };
18969
-
18970
- /**
18971
- * A rule prescribing content creation in a {@link OpenFin.Window}.
18972
- *
18973
- * @interface
18974
- */
18975
- declare type WindowContentCreationRule = BaseContentCreationRule & {
18976
- /**
18977
- * Behavior to use when opening matched content.
18978
- */
18979
- behavior: 'window';
18980
- /**
18981
- * Options for newly-created window.
18982
- */
18983
- options?: Partial<WindowOptions>;
18984
- };
18985
-
18986
- /**
18987
- * Generated when a child window is created.
18988
- * @interface
18989
- */
18990
- declare type WindowCreatedEvent = BaseApplicationEvent & {
18991
- type: 'window-created';
18992
- };
18993
-
18994
- /**
18995
- * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
18996
- *
18997
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18998
- * (defaults to `"about:blank"` when omitted).
18999
- * @interface
19000
- */
19001
- declare type WindowCreationOptions = Partial<WindowOptions> & {
19002
- name: string;
19003
- };
19004
-
19005
- declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
19006
-
19007
- /**
19008
- * @interface
19009
- */
19010
- declare type WindowDetail = {
19011
- /**
19012
- * The bottom-most coordinate of the window.
19013
- */
19014
- bottom: number;
19015
- /**
19016
- * The height of the window.
19017
- */
19018
- height: number;
19019
- isShowing: boolean;
19020
- /**
19021
- * The left-most coordinate of the window.
19022
- */
19023
- left: number;
19024
- /**
19025
- * The name of the window.
19026
- */
19027
- name: string;
19028
- /**
19029
- * The right-most coordinate of the window.
19030
- */
19031
- right: number;
19032
- state: string;
19033
- /**
19034
- * The top-most coordinate of the window.
19035
- */
19036
- top: number;
19037
- /**
19038
- * The width of the window.
19039
- */
19040
- width: number;
19041
- };
19042
-
19043
- /**
19044
- * Generated when a child window ends loading.
19045
- * @interface
19046
- */
19047
- declare type WindowEndLoadEvent = BaseApplicationEvent & {
19048
- type: 'window-end-load';
19049
- };
19050
-
19051
- /**
19052
- * [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
19053
- * discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
19054
- * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
19055
- */
19056
- declare type WindowEvent = WindowSourcedEvent | PropagatedViewEvent<'window'>;
19057
-
19058
- declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19059
-
19060
- declare namespace WindowEvents {
19061
- export {
19062
- BaseWindowEvent,
19063
- ViewAttachedEvent,
19064
- ViewDetachedEvent,
19065
- WindowViewEvent,
19066
- AlertRequestedEvent,
19067
- AuthRequestedEvent,
19068
- EndLoadEvent,
19069
- WillRedirectEvent,
19070
- ReloadedEvent,
19071
- WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19072
- ExternalProcessExitedEvent,
19073
- ExternalProcessStartedEvent,
19074
- WindowHiddenEvent,
19075
- PreloadScriptInfoRunning,
19076
- PreloadScriptInfo,
19077
- PreloadScriptsStateChangeEvent,
19078
- UserBoundsChangeEvent,
19079
- BoundsChangeEvent,
19080
- WillMoveOrResizeEvent,
19081
- PerformanceReportEvent,
19082
- InputEvent_2 as InputEvent,
19083
- LayoutInitializedEvent,
19084
- LayoutReadyEvent,
19085
- BeginUserBoundsChangingEvent,
19086
- BoundsChangedEvent,
19087
- BoundsChangingEvent,
19088
- WindowCloseRequestedEvent,
19089
- ContextChangedEvent,
19090
- WindowClosedEvent,
19091
- WindowClosingEvent,
19092
- DisabledMovementBoundsChangedEvent,
19093
- DisabledMovementBoundsChangingEvent,
19094
- EmbeddedEvent,
19095
- EndUserBoundsChangingEvent,
19096
- WindowHotkeyEvent,
19097
- WindowInitializedEvent,
19098
- MaximizedEvent,
19099
- MinimizedEvent,
19100
- PreloadScriptsStateChangedEvent,
19101
- PreloadScriptsStateChangingEvent,
19102
- WindowRestoredEvent,
19103
- WindowShowRequestedEvent,
19104
- WindowShownEvent,
19105
- UserMovementEnabledEvent,
19106
- UserMovementDisabledEvent,
19107
- WillMoveEvent,
19108
- WillResizeEvent,
19109
- NonPropagatedWindowEvent,
19110
- ShowAllDownloadsEvent,
19111
- DownloadShelfVisibilityChangedEvent,
19112
- WindowSourcedEvent,
19113
- WillPropagateWindowEvent,
19114
- WindowEvent,
19115
- WindowEventType,
19116
- PropagatedWindowEvent,
19117
- PropagatedWindowEventType,
19118
- Payload_9 as Payload,
19119
- ByType_8 as ByType
19120
- }
19121
- }
19122
-
19123
- /**
19124
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.WindowEvent}.
19125
- */
19126
- declare type WindowEventType = WindowEvent['type'];
19127
-
19128
- /**
19129
- * Generated when a window has been hidden.
19130
- * @interface
19131
- */
19132
- declare type WindowHiddenEvent = BaseWindowEvent & {
19133
- type: 'hidden';
19134
- reason: 'closing' | 'hide' | 'hide-on-close';
19135
- };
19136
-
19137
- /**
19138
- * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
19139
- * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
19140
- * @interface
19141
- */
19142
- declare type WindowHotkeyEvent = InputEvent_2 & BaseWindowEvent & {
19143
- type: 'hotkey';
19144
- };
19145
-
19146
- /**
19147
- * @interface
19148
- */
19149
- declare type WindowInfo = {
19150
- canNavigateBack: boolean;
19151
- canNavigateForward: boolean;
19152
- preloadScripts: Array<any>;
19153
- title: string;
19154
- url: string;
19155
- };
19156
-
19157
- /**
19158
- * Generated when a window is initialized.
19159
- * @interface
19160
- */
19161
- declare type WindowInitializedEvent = BaseWindowEvent & {
19162
- type: 'initialized';
19163
- };
19164
-
19165
- /**
19166
- * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
19167
- */
19168
- declare class _WindowModule extends Base {
19169
- /**
19170
- * Asynchronously returns a Window object that represents an existing window.
19171
- *
19172
- * @example
19173
- * ```js
19174
- * async function createWin() {
19175
- * const app = await fin.Application.start({
19176
- * name: 'myApp',
19177
- * uuid: 'app-1',
19178
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
19179
- * autoShow: true
19180
- * });
19181
- * return await app.getWindow();
19182
- * }
19183
- * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
19184
- * .then(win => console.log('wrapped window'))
19185
- * .catch(err => console.log(err));
19186
- * ```
19187
- */
19188
- wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
19189
- /**
19190
- * Synchronously returns a Window object that represents an existing window.
19191
- *
19192
- * @example
19193
- * ```js
19194
- * async function createWin() {
19195
- * const app = await fin.Application.start({
19196
- * name: 'myApp',
19197
- * uuid: 'app-1',
19198
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
19199
- * autoShow: true
19200
- * });
19201
- * return await app.getWindow();
19202
- * }
19203
- * await createWin();
19204
- * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
19205
- * ```
19206
- */
19207
- wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
19208
- /**
19209
- * Creates a new Window.
19210
- * @param options - Window creation options
19211
- *
19212
- * @example
19213
- * ```js
19214
- * async function createWindow() {
19215
- * const winOption = {
19216
- * name:'child',
19217
- * defaultWidth: 300,
19218
- * defaultHeight: 300,
19219
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
19220
- * frame: true,
19221
- * autoShow: true
19222
- * };
19223
- * return await fin.Window.create(winOption);
19224
- * }
19225
- *
19226
- * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
19227
- * ```
19228
- */
19229
- create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
19230
- /**
19231
- * Asynchronously returns a Window object that represents the current window
19232
- *
19233
- * @example
19234
- * ```js
19235
- * fin.Window.getCurrent()
19236
- * .then(wnd => console.log('current window'))
19237
- * .catch(err => console.log(err));
19238
- *
19239
- * ```
19240
- */
19241
- getCurrent(): Promise<OpenFin_2.Window>;
19242
- /**
19243
- * Synchronously returns a Window object that represents the current window
19244
- *
19245
- * @example
19246
- * ```js
19247
- * const wnd = fin.Window.getCurrentSync();
19248
- * const info = await wnd.getInfo();
19249
- * console.log(info);
19250
- *
19251
- * ```
19252
- */
19253
- getCurrentSync(): OpenFin_2.Window;
19254
- }
19255
-
19256
- /**
19257
- * Generated when a child window is not responding.
19258
- * @interface
19259
- */
19260
- declare type WindowNotRespondingEvent = BaseApplicationEvent & {
19261
- type: 'window-not-responding';
19262
- };
19263
-
19264
- /**
19265
- * @interface
19266
- */
19267
- declare type WindowOptionDiff = {
19268
- [key in keyof WindowOptions]: {
19269
- oldVal: WindowOptions[key];
19270
- newVal: WindowOptions[key];
19271
- };
19272
- };
19273
-
19274
- /**
19275
- * @interface
19276
- */
19277
- declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
19278
-
19279
- declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
19280
-
19281
- /**
19282
- * Generated after window options are changed using the window.updateOptions method.
19283
- * @remarks Will not fire if the diff object is empty.
19284
- * @interface
19285
- */
19286
- declare type WindowOptionsChangedEvent_2 = BaseWindowEvent & {
19287
- type: 'options-changed';
19288
- options: OpenFin_2.WindowOptions;
19289
- diff: OpenFin_2.WindowOptionDiff;
19290
- };
19291
-
19292
- declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
19293
-
19294
- /**
19295
- * Generated when a child window is responding.
19296
- * @interface
19297
- */
19298
- declare type WindowRespondingEvent = BaseApplicationEvent & {
19299
- type: 'window-responding';
19300
- };
19301
-
19302
- /**
19303
- * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
19304
- * @interface
19305
- */
19306
- declare type WindowRestoredEvent = BaseWindowEvent & {
19307
- type: 'restored';
19308
- };
19309
-
19310
- /**
19311
- * Generated when a hidden window has been shown.
19312
- * @interface
19313
- */
19314
- declare type WindowShownEvent = BaseWindowEvent & {
19315
- type: 'shown';
19316
- };
19317
-
19318
- /**
19319
- * Generated when a window has been prevented from showing.
19320
- * @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.
19321
- * @interface
19322
- */
19323
- declare type WindowShowRequestedEvent = BaseWindowEvent & {
19324
- type: 'show-requested';
19325
- };
19326
-
19327
- /**
19328
- * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19329
- * from {@link OpenFin.ViewEvents}.
19330
- */
19331
- 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;
19332
-
19333
- /**
19334
- * Generated when a child window starts loading.
19335
- * @interface
19336
- */
19337
- declare type WindowStartLoadEvent = BaseApplicationEvent & {
19338
- type: 'window-start-load';
19339
- };
19340
-
19341
- /**
19342
- * Visibility state of a window.
19343
- */
19344
- declare type WindowState = 'maximized' | 'minimized' | 'normal';
19345
-
19346
- /**
19347
- * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
19348
- * to the `Application` level, with the name pattern `window-view-eventname`.
19349
- */
19350
- declare type WindowViewEvent = {
19351
- viewIdentity: OpenFin_2.Identity;
19352
- } & (ViewAttachedEvent | ViewDetachedEvent);
19353
-
19354
- /**
19355
- * @interface
19356
- */
19357
- declare type WindowViewsPrintOptions = {
19358
- content: 'views';
19359
- includeSelf?: boolean;
19360
- };
19361
-
19362
- declare type Wire = EventEmitter & {
19363
- connect(messageReciever: MessageReceiver): Promise<any>;
19364
- connectSync(): any;
19365
- send(data: any): Promise<any>;
19366
- shutdown(): Promise<void>;
19367
- getPort(): string;
19368
- };
19369
-
19370
- declare type WireConstructor = {
19371
- new (onmessage: (data: any) => void): Wire;
19372
- };
19373
-
19374
- /* Excluded from this release type: WithId */
19375
-
19376
- declare interface WithInterop {
19377
- interop: InteropClient;
19378
- }
19379
-
19380
- /* Excluded from this release type: WithoutId */
19381
-
19382
- declare type WithPositioningOptions<T extends {} = {}> = T & {
19383
- positioningOptions?: OpenFin_2.PositioningOptions;
19384
- };
19385
-
19386
- /* Excluded from this release type: WorkspacePlatformOptions */
19387
-
19388
- /**
19389
- * A generic request to write any supported data to the clipboard.
19390
- * @interface
19391
- */
19392
- declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
19393
- /**
19394
- * Data to be written
19395
- */
19396
- data: {
19397
- text?: string;
19398
- html?: string;
19399
- rtf?: string;
19400
- } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
19401
- };
19402
-
19403
- /**
19404
- * @deprecated - instead use WriteAnyClipboardRequest
19405
- *
19406
- * A generic request to write any supported data to the clipboard.
19407
- *
19408
- * @interface
19409
- */
19410
- declare type WriteAnyRequestType = WriteAnyClipboardRequest;
19411
-
19412
- /**
19413
- * A request to write data to the clipboard.
19414
- * @interface
19415
- */
19416
- declare type WriteClipboardRequest = BaseClipboardRequest & {
19417
- /**
19418
- * Data to write to the clipboard.
19419
- */
19420
- data: string;
19421
- };
19422
-
19423
- /**
19424
- * @interface
19425
- */
19426
- declare type WriteImageClipboardRequest = BaseClipboardRequest & {
19427
- /**
19428
- * Can be either a base64 string, or a DataURL string. If using DataURL, the
19429
- * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
19430
- * Using other image/<format> DataURLs will throw an Error.
19431
- */
19432
- image: string;
19433
- };
19434
-
19435
- /**
19436
- * @deprecated - instead use OpenFin.WriteClipboardRequest
19437
- *
19438
- * A request to write data to the clipboard.
19439
- *
19440
- * @interface
19441
- */
19442
- declare type WriteRequestType = WriteClipboardRequest;
19443
-
19444
- export { }
18059
+ * Dispatch a result to the caller of `showPopupWindow`.
18060
+ *
18061
+ * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18062
+ * @param data Serializable data to send to the caller window.
18063
+ *
18064
+ * @example
18065
+ * ```js
18066
+ * await fin.me.dispatchPopupResult({
18067
+ * foo: 'bar'
18068
+ * });
18069
+ * ```
18070
+ */
18071
+ dispatchPopupResult(data: any): Promise<void>;
18072
+ /**
18073
+ * Prints the contents of the window.
18074
+ *
18075
+ * @param options Configuration for the print task.
18076
+ * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18077
+ * and the default settings for printing.
18078
+ *
18079
+ * Use the CSS style `page-break-before: always;` to force print to a new page.
18080
+ *
18081
+ * @example
18082
+ * ```js
18083
+ * const win = fin.Window.getCurrentSync();
18084
+ *
18085
+ * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18086
+ * console.log('print call has been sent to the system');
18087
+ * });
18088
+ * ```
18089
+ *
18090
+ * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18091
+ * use the `content` option:
18092
+ *
18093
+ * ```js
18094
+ * const win = fin.Window.getCurrentSync();
18095
+ *
18096
+ * // Print embedded views
18097
+ * win.print({ content: 'views' });
18098
+ *
18099
+ * // Print screenshot of current window
18100
+ * win.print({ content: 'screenshot' })
18101
+ * ```
18102
+ *
18103
+ * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18104
+ * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18105
+ * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18106
+ * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18107
+ *
18108
+ * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18109
+ * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18110
+ *
18111
+ * To print the views embedded in their page context, set `content` to `screenshot`.
18112
+ */
18113
+ print(options?: OpenFin_2.WindowPrintOptions): Promise<void>;
18114
+ }
18115
+
18116
+ /**
18117
+ * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18118
+ * @interface
18119
+ */
18120
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
18121
+ type: 'window-alert-requested';
18122
+ };
18123
+
18124
+ /**
18125
+ * Returned from getBounds call. bottom and right are never used for setting.
18126
+ * @interface
18127
+ */
18128
+ declare type WindowBounds = Bounds & {
18129
+ bottom: number;
18130
+ right: number;
18131
+ };
18132
+
18133
+ /**
18134
+ * @deprecated Renamed to {@link ClosedEvent}.
18135
+ */
18136
+ declare type WindowClosedEvent = ClosedEvent_2;
18137
+
18138
+ /**
18139
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
18140
+ */
18141
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
18142
+
18143
+ /**
18144
+ * @deprecated Renamed to {@link ClosingEvent}.
18145
+ */
18146
+ declare type WindowClosingEvent = ClosingEvent;
18147
+
18148
+ /**
18149
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
18150
+ *
18151
+ * @interface
18152
+ */
18153
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
18154
+ /**
18155
+ * Behavior to use when opening matched content.
18156
+ */
18157
+ behavior: 'window';
18158
+ /**
18159
+ * Options for newly-created window.
18160
+ */
18161
+ options?: Partial<WindowOptions>;
18162
+ };
18163
+
18164
+ /**
18165
+ * Generated when a child window is created.
18166
+ * @interface
18167
+ */
18168
+ declare type WindowCreatedEvent = BaseEvent_3 & {
18169
+ type: 'window-created';
18170
+ };
18171
+
18172
+ /**
18173
+ * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
18174
+ *
18175
+ * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18176
+ * (defaults to `"about:blank"` when omitted).
18177
+ * @interface
18178
+ */
18179
+ declare type WindowCreationOptions = Partial<WindowOptions> & {
18180
+ name: string;
18181
+ };
18182
+
18183
+ declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
18184
+
18185
+ /**
18186
+ * @interface
18187
+ */
18188
+ declare type WindowDetail = {
18189
+ /**
18190
+ * The bottom-most coordinate of the window.
18191
+ */
18192
+ bottom: number;
18193
+ /**
18194
+ * The height of the window.
18195
+ */
18196
+ height: number;
18197
+ isShowing: boolean;
18198
+ /**
18199
+ * The left-most coordinate of the window.
18200
+ */
18201
+ left: number;
18202
+ /**
18203
+ * The name of the window.
18204
+ */
18205
+ name: string;
18206
+ /**
18207
+ * The right-most coordinate of the window.
18208
+ */
18209
+ right: number;
18210
+ state: string;
18211
+ /**
18212
+ * The top-most coordinate of the window.
18213
+ */
18214
+ top: number;
18215
+ /**
18216
+ * The width of the window.
18217
+ */
18218
+ width: number;
18219
+ };
18220
+
18221
+ /**
18222
+ * Generated when a child window ends loading.
18223
+ * @interface
18224
+ */
18225
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
18226
+ type: 'window-end-load';
18227
+ };
18228
+
18229
+ /**
18230
+ * @deprecated, Renamed to {@link Event}.
18231
+ */
18232
+ declare type WindowEvent = Event_6;
18233
+
18234
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18235
+
18236
+ declare namespace WindowEvents {
18237
+ export {
18238
+ BaseEvent_5 as BaseEvent,
18239
+ BaseWindowEvent,
18240
+ ViewAttachedEvent,
18241
+ ViewDetachedEvent,
18242
+ WindowViewEvent,
18243
+ AlertRequestedEvent,
18244
+ AuthRequestedEvent,
18245
+ EndLoadEvent,
18246
+ WillRedirectEvent,
18247
+ ReloadedEvent,
18248
+ OptionsChangedEvent,
18249
+ WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
18250
+ ExternalProcessExitedEvent,
18251
+ ExternalProcessStartedEvent,
18252
+ HiddenEvent_2 as HiddenEvent,
18253
+ WindowHiddenEvent,
18254
+ PreloadScriptInfoRunning,
18255
+ PreloadScriptInfo,
18256
+ PreloadScriptsStateChangeEvent,
18257
+ UserBoundsChangeEvent,
18258
+ BoundsChangeEvent,
18259
+ WillMoveOrResizeEvent,
18260
+ PerformanceReportEvent,
18261
+ InputEvent_2 as InputEvent,
18262
+ LayoutInitializedEvent,
18263
+ LayoutReadyEvent,
18264
+ BeginUserBoundsChangingEvent,
18265
+ BoundsChangedEvent,
18266
+ BoundsChangingEvent,
18267
+ CloseRequestedEvent,
18268
+ WindowCloseRequestedEvent,
18269
+ ContextChangedEvent,
18270
+ ClosedEvent_2 as ClosedEvent,
18271
+ WindowClosedEvent,
18272
+ ClosingEvent,
18273
+ WindowClosingEvent,
18274
+ DisabledMovementBoundsChangedEvent,
18275
+ DisabledMovementBoundsChangingEvent,
18276
+ EmbeddedEvent,
18277
+ EndUserBoundsChangingEvent,
18278
+ HotkeyEvent_2 as HotkeyEvent,
18279
+ WindowHotkeyEvent,
18280
+ InitializedEvent_2 as InitializedEvent,
18281
+ WindowInitializedEvent,
18282
+ MaximizedEvent,
18283
+ MinimizedEvent,
18284
+ PreloadScriptsStateChangedEvent,
18285
+ PreloadScriptsStateChangingEvent,
18286
+ RestoredEvent,
18287
+ WindowRestoredEvent,
18288
+ ShowRequestedEvent,
18289
+ WindowShowRequestedEvent,
18290
+ ShownEvent_2 as ShownEvent,
18291
+ WindowShownEvent,
18292
+ UserMovementEnabledEvent,
18293
+ UserMovementDisabledEvent,
18294
+ WillMoveEvent,
18295
+ WillResizeEvent,
18296
+ NonPropagatedWindowEvent,
18297
+ ShowAllDownloadsEvent,
18298
+ DownloadShelfVisibilityChangedEvent,
18299
+ WindowSourcedEvent,
18300
+ WillPropagateWindowEvent,
18301
+ Event_6 as Event,
18302
+ WindowEvent,
18303
+ EventType_2 as EventType,
18304
+ WindowEventType,
18305
+ PropagatedEvent_3 as PropagatedEvent,
18306
+ PropagatedWindowEvent,
18307
+ PropagatedWindowEventType,
18308
+ Payload_3 as Payload,
18309
+ ByType_2 as ByType
18310
+ }
18311
+ }
18312
+
18313
+ /**
18314
+ * @deprecated Renamed to {@link EventType}.
18315
+ */
18316
+ declare type WindowEventType = WindowEvent['type'];
18317
+
18318
+ /**
18319
+ * @deprecated Renamed to {@link HiddenEvent}.
18320
+ */
18321
+ declare type WindowHiddenEvent = HiddenEvent_2;
18322
+
18323
+ /**
18324
+ * @deprecated Renamed to {@link HotkeyEvent}.
18325
+ */
18326
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
18327
+
18328
+ /**
18329
+ * @interface
18330
+ */
18331
+ declare type WindowInfo = {
18332
+ canNavigateBack: boolean;
18333
+ canNavigateForward: boolean;
18334
+ preloadScripts: Array<any>;
18335
+ title: string;
18336
+ url: string;
18337
+ };
18338
+
18339
+ /**
18340
+ * @deprecated Renamed to {@link InitializedEvent}.
18341
+ */
18342
+ declare type WindowInitializedEvent = InitializedEvent_2;
18343
+
18344
+ /**
18345
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
18346
+ */
18347
+ declare class _WindowModule extends Base {
18348
+ /**
18349
+ * Asynchronously returns a Window object that represents an existing window.
18350
+ *
18351
+ * @example
18352
+ * ```js
18353
+ * async function createWin() {
18354
+ * const app = await fin.Application.start({
18355
+ * name: 'myApp',
18356
+ * uuid: 'app-1',
18357
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
18358
+ * autoShow: true
18359
+ * });
18360
+ * return await app.getWindow();
18361
+ * }
18362
+ * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
18363
+ * .then(win => console.log('wrapped window'))
18364
+ * .catch(err => console.log(err));
18365
+ * ```
18366
+ */
18367
+ wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
18368
+ /**
18369
+ * Synchronously returns a Window object that represents an existing window.
18370
+ *
18371
+ * @example
18372
+ * ```js
18373
+ * async function createWin() {
18374
+ * const app = await fin.Application.start({
18375
+ * name: 'myApp',
18376
+ * uuid: 'app-1',
18377
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
18378
+ * autoShow: true
18379
+ * });
18380
+ * return await app.getWindow();
18381
+ * }
18382
+ * await createWin();
18383
+ * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
18384
+ * ```
18385
+ */
18386
+ wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
18387
+ /**
18388
+ * Creates a new Window.
18389
+ * @param options - Window creation options
18390
+ *
18391
+ * @example
18392
+ * ```js
18393
+ * async function createWindow() {
18394
+ * const winOption = {
18395
+ * name:'child',
18396
+ * defaultWidth: 300,
18397
+ * defaultHeight: 300,
18398
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
18399
+ * frame: true,
18400
+ * autoShow: true
18401
+ * };
18402
+ * return await fin.Window.create(winOption);
18403
+ * }
18404
+ *
18405
+ * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
18406
+ * ```
18407
+ */
18408
+ create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
18409
+ /**
18410
+ * Asynchronously returns a Window object that represents the current window
18411
+ *
18412
+ * @example
18413
+ * ```js
18414
+ * fin.Window.getCurrent()
18415
+ * .then(wnd => console.log('current window'))
18416
+ * .catch(err => console.log(err));
18417
+ *
18418
+ * ```
18419
+ */
18420
+ getCurrent(): Promise<OpenFin_2.Window>;
18421
+ /**
18422
+ * Synchronously returns a Window object that represents the current window
18423
+ *
18424
+ * @example
18425
+ * ```js
18426
+ * const wnd = fin.Window.getCurrentSync();
18427
+ * const info = await wnd.getInfo();
18428
+ * console.log(info);
18429
+ *
18430
+ * ```
18431
+ */
18432
+ getCurrentSync(): OpenFin_2.Window;
18433
+ }
18434
+
18435
+ /**
18436
+ * Generated when a child window is not responding.
18437
+ * @interface
18438
+ */
18439
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
18440
+ type: 'window-not-responding';
18441
+ };
18442
+
18443
+ /**
18444
+ * @interface
18445
+ */
18446
+ declare type WindowOptionDiff = {
18447
+ [key in keyof WindowOptions]: {
18448
+ oldVal: WindowOptions[key];
18449
+ newVal: WindowOptions[key];
18450
+ };
18451
+ };
18452
+
18453
+ /**
18454
+ * @interface
18455
+ */
18456
+ declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
18457
+
18458
+ declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
18459
+
18460
+ /**
18461
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
18462
+ */
18463
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
18464
+
18465
+ declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
18466
+
18467
+ /**
18468
+ * Generated when a child window is responding.
18469
+ * @interface
18470
+ */
18471
+ declare type WindowRespondingEvent = BaseEvent_3 & {
18472
+ type: 'window-responding';
18473
+ };
18474
+
18475
+ /**
18476
+ * @deprecated Renamed to {@link RestoredEvent}.
18477
+ */
18478
+ declare type WindowRestoredEvent = RestoredEvent;
18479
+
18480
+ /**
18481
+ * @deprecated Renamed to {@link ShownEvent}.
18482
+ */
18483
+ declare type WindowShownEvent = ShownEvent_2;
18484
+
18485
+ /**
18486
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
18487
+ */
18488
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18489
+
18490
+ /**
18491
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18492
+ * from {@link OpenFin.ViewEvents}.
18493
+ */
18494
+ 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;
18495
+
18496
+ /**
18497
+ * Generated when a child window starts loading.
18498
+ * @interface
18499
+ */
18500
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
18501
+ type: 'window-start-load';
18502
+ };
18503
+
18504
+ /**
18505
+ * Visibility state of a window.
18506
+ */
18507
+ declare type WindowState = 'maximized' | 'minimized' | 'normal';
18508
+
18509
+ /**
18510
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
18511
+ * to the `Application` level, with the name pattern `window-view-eventname`.
18512
+ */
18513
+ declare type WindowViewEvent = {
18514
+ viewIdentity: OpenFin_2.Identity;
18515
+ } & (ViewAttachedEvent | ViewDetachedEvent);
18516
+
18517
+ /**
18518
+ * @interface
18519
+ */
18520
+ declare type WindowViewsPrintOptions = {
18521
+ content: 'views';
18522
+ includeSelf?: boolean;
18523
+ };
18524
+
18525
+ declare type Wire = EventEmitter & {
18526
+ connect(messageReciever: MessageReceiver): Promise<any>;
18527
+ connectSync(): any;
18528
+ send(data: any): Promise<any>;
18529
+ shutdown(): Promise<void>;
18530
+ getPort(): string;
18531
+ };
18532
+
18533
+ declare type WireConstructor = {
18534
+ new (onmessage: (data: any) => void): Wire;
18535
+ };
18536
+
18537
+ /* Excluded from this release type: WithId */
18538
+
18539
+ declare interface WithInterop {
18540
+ interop: InteropClient;
18541
+ }
18542
+
18543
+ /* Excluded from this release type: WithoutId */
18544
+
18545
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
18546
+ positioningOptions?: OpenFin_2.PositioningOptions;
18547
+ };
18548
+
18549
+ /* Excluded from this release type: WorkspacePlatformOptions */
18550
+
18551
+ /**
18552
+ * A generic request to write any supported data to the clipboard.
18553
+ * @interface
18554
+ */
18555
+ declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
18556
+ /**
18557
+ * Data to be written
18558
+ */
18559
+ data: {
18560
+ text?: string;
18561
+ html?: string;
18562
+ rtf?: string;
18563
+ } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
18564
+ };
18565
+
18566
+ /**
18567
+ * @deprecated - instead use WriteAnyClipboardRequest
18568
+ *
18569
+ * A generic request to write any supported data to the clipboard.
18570
+ *
18571
+ * @interface
18572
+ */
18573
+ declare type WriteAnyRequestType = WriteAnyClipboardRequest;
18574
+
18575
+ /**
18576
+ * A request to write data to the clipboard.
18577
+ * @interface
18578
+ */
18579
+ declare type WriteClipboardRequest = BaseClipboardRequest & {
18580
+ /**
18581
+ * Data to write to the clipboard.
18582
+ */
18583
+ data: string;
18584
+ };
18585
+
18586
+ /**
18587
+ * @interface
18588
+ */
18589
+ declare type WriteImageClipboardRequest = BaseClipboardRequest & {
18590
+ /**
18591
+ * Can be either a base64 string, or a DataURL string. If using DataURL, the
18592
+ * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
18593
+ * Using other image/<format> DataURLs will throw an Error.
18594
+ */
18595
+ image: string;
18596
+ };
18597
+
18598
+ /**
18599
+ * @deprecated - instead use OpenFin.WriteClipboardRequest
18600
+ *
18601
+ * A request to write data to the clipboard.
18602
+ *
18603
+ * @interface
18604
+ */
18605
+ declare type WriteRequestType = WriteClipboardRequest;
18606
+
18607
+ export { }